PackageDescription

Describes the build settings and meta data of a single package.

This structure contains the effective build settings and dependencies for the selected build platform. This structure is most useful for displaying information about a package in an IDE. Use TargetDescription instead when writing a build-tool.

@safe pure

struct PackageDescription {

@JSON!(jGetString, stringToJ)("")

@SDL!(sGetString, stringToSName)("")

@JSON!(jGetString, stringToJ)("")

@SDL!(sGetString, stringToS)("")

string description;

@JSON!(jGetString, stringToJ)("")

@SDL!(sGetString, stringToS)("")

string homepage;

@JSON!(jGetStrings, stringsToJ)("")

@SDL!(sGetStrings, stringsToS)("")

string[] authors;

@JSON!(jGetString, stringToJ)("")

@SDL!(sGetString, stringToS)("")

string copyright;

@JSON!(jGetString, stringToJ)("")

@SDL!(sGetString, stringToS)("")

string license;

@JSON!(jGetString, stringToJ)("")

@SDL!(sGetString, stringToS)("")

string systemDependencies;

@JSON!(jGetDependencies, dependenciesToJ)("")

@SDL!(sGetDependencies, dependenciesToS)("dependency")

Dependency[] dependencies;

@JSON!(jGetTargetType, targetTypeToJ)("")

@SDL!(sGetTargetType, targetTypeToS)("")

TargetType targetType;

@JSON!(jGetUnprocessedPath, unprocessedPathToJ)("")

@SDL!(sGetUnprocessedPath, unprocessedPathToS)("")

UnprocessedPath targetPath;

@JSON!(jGetString, stringToJ)("")

@SDL!(sGetString, stringToS)("")

string targetName;

@JSON!(jGetUnprocessedPath, unprocessedPathToJ)("")

@SDL!(sGetUnprocessedPath, unprocessedPathToS)("")

UnprocessedPath workingDirectory;

@JSON!(jGetUnprocessedPath, unprocessedPathToJ)("")

@SDL!(sGetUnprocessedPath, unprocessedPathToS)("")

UnprocessedPath mainSourceFile;

@JSON!(jGetStringsPlatform, stringsPlatformToJ)("")

@SDL!(sGetStringsPlatform, stringsPlatformToS)("")

Strings dflags;

@JSON!(jGetStringsPlatform, stringsPlatformToJ)("")

@SDL!(sGetStringsPlatform, stringsPlatformToS)("")

Strings lflags;

@JSON!(jGetStringsPlatform, stringsPlatformToJ)("")

@SDL!(sGetStringsPlatform, stringsPlatformToS)("")

Strings libs;

@JSON!(jGetPaths, pathsToJ)("")

@SDL!(sGetPaths, pathsToS)("")

Paths copyFiles;

@JSON!(jGetStringsPlatform, stringsPlatformToJ)("")

@SDL!(sGetStringsPlatform, stringsPlatformToS)("")

Strings versions;

@JSON!(jGetStringsPlatform, stringsPlatformToJ)("")

@SDL!(sGetStringsPlatform, stringsPlatformToS)("")

Strings debugVersions;

@JSON!(jGetPaths, pathsToJ)("")

@SDL!(sGetPaths, pathsToS)("")

Paths importPaths;

@JSON!(jGetPaths, pathsToJ)("")

@SDL!(sGetPaths, pathsToS)("")

Paths sourcePaths;

@JSON!(jGetPaths, pathsToJ)("")

@SDL!(sGetPaths, pathsToS)("")

Paths sourceFiles;

@JSON!(jGetPaths, pathsToJ)("")

@SDL!(sGetPaths, pathsToS)("")

Paths excludedSourceFiles;

@JSON!(jGetPaths, pathsToJ)("")

@SDL!(sGetPaths, pathsToS)("")

Paths stringImportPaths;

@JSON!(jGetStringsPlatform, stringsPlatformToJ)("")

@SDL!(sGetStringsPlatform, stringsPlatformToS)("")

Strings preGenerateCommands;

@JSON!(jGetStringsPlatform, stringsPlatformToJ)("")

@SDL!(sGetStringsPlatform, stringsPlatformToS)("")

Strings postGenerateCommands;

@JSON!(jGetStringsPlatform, stringsPlatformToJ)("")

@SDL!(sGetStringsPlatform, stringsPlatformToS)("")

Strings preBuildCommands;

@JSON!(jGetStringsPlatform, stringsPlatformToJ)("")

@SDL!(sGetStringsPlatform, stringsPlatformToS)("")

Strings postBuildCommands;

@JSON!(jGetStringsPlatform, stringsPlatformToJ)("")

@SDL!(sGetStringsPlatform, stringsPlatformToS)("")

Strings preRunCommands;

@JSON!(jGetStringsPlatform, stringsPlatformToJ)("")

@SDL!(sGetStringsPlatform, stringsPlatformToS)("")

Strings postRunCommands;

@JSON!(jGetPackageDescriptions, packageDescriptionsToJ)("")

@SDL!(sGetPackageDescriptions, configurationsToS)("configuration")

PackageDescription[string] configurations;

@JSON!(jGetStrings, stringsToJ)("-ddoxFilterArgs")

@SDL!(sGetStrings, stringsToS)("x:ddoxFilterArgs")

string[] ddoxFilterArgs;

@JSON!(jGetStrings, stringsToJ)("")

@SDL!(sGetStrings, stringsToS)("x:debugVersionFilters")

string[] debugVersionFilters;

@JSON!(jGetStringPlatform, stringPlatformToJ)("-ddoxTool")

@SDL!(sGetStringPlatform, stringPlatformToS)("x:ddoxTool")

String ddoxTool;

@JSON!(jGetSubPackages, subPackagesToJ)("")

@SDL!(sGetSubPackage, subPackagesToS)("subPackage")

SubPackage[] subPackages;

@JSON!(jGetBuildRequirements, buildRequirementsToJ)("")

@SDL!(sGetBuildRequirements, buildRequirementsToS)("")

BuildRequirements buildRequirements;

@JSON!(jGetStringAA, stringAAToJ)("")

@SDL!(sGetSubConfig, subConfigsToS)("subConfiguration")

SubConfigs subConfigurations;

@JSON!(jGetStrings, stringsToJ)("")

@SDL!(sGetStrings, stringsToS)("x:versionFilters")

string[] versionFilters;

@JSON!(jGetBuildTypes, buildTypesToJ)("")

@SDL!(sGetBuildTypes, buildTypesToS)("buildType")

BuildType[string] buildTypes;

@JSON!(jGetBuildOptions, buildOptionsToJ)("")

@SDL!(sGetBuildOptions, buildOptionsToS)("")

BuildOptions buildOptions;

@JSON!(jGetPlatforms, platformsToJ)("")

@SDL!(sGetPlatforms, platformsToS)("")

Platform[][] platforms;

@JSON!(jGetToolchainRequirement, toolchainRequirementToJ)("")

@SDL!(sGetToolchainRequirement, toolchainRequirementToS)("")

ToolchainRequirement[Toolchain] toolchainRequirements;

bool opEquals(PackageDescription other);

}

Members

Functions

opEquals bool opEquals(PackageDescription other): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

authors string[] authors;: Undocumented in source.
buildOptions BuildOptions buildOptions;: Undocumented in source.
buildRequirements BuildRequirements buildRequirements;: Undocumented in source.
buildTypes BuildType[string] buildTypes;: Undocumented in source.
configurations PackageDescription[string] configurations;: Undocumented in source.
copyFiles Paths copyFiles;: Files to copy to the target directory
copyright string copyright;: Undocumented in source.
ddoxFilterArgs string[] ddoxFilterArgs;: Undocumented in source.
ddoxTool String ddoxTool;: Undocumented in source.
debugVersionFilters string[] debugVersionFilters;: Undocumented in source.
debugVersions Strings debugVersions;: D debug version identifiers to set
dependencies Dependency[] dependencies;: Undocumented in source.
description string description;: Undocumented in source.
dflags Strings dflags;: Flags passed to the D compiler
excludedSourceFiles Paths excludedSourceFiles;: Undocumented in source.
homepage string homepage;: Undocumented in source.
importPaths Paths importPaths;: Undocumented in source.
lflags Strings lflags;: Flags passed to the linker
libs Strings libs;: Librariy names to link against (typically using "-l<name>")
license string license;: Undocumented in source.
mainSourceFile UnprocessedPath mainSourceFile;: Undocumented in source.
name string name;: Qualified name of the package
platforms Platform[][] platforms;: Undocumented in source.
postBuildCommands Strings postBuildCommands;: Commands to execute after every build
postGenerateCommands Strings postGenerateCommands;: commands executed after creating the description
postRunCommands Strings postRunCommands;: Commands to execute after every run
preBuildCommands Strings preBuildCommands;: Commands to execute prior to every build
preGenerateCommands Strings preGenerateCommands;: commands executed before creating the description
preRunCommands Strings preRunCommands;: Commands to execute prior to every run
sourceFiles Paths sourceFiles;: Undocumented in source.
sourcePaths Paths sourcePaths;: Undocumented in source.
stringImportPaths Paths stringImportPaths;: Undocumented in source.
subConfigurations SubConfigs subConfigurations;: Undocumented in source.
subPackages SubPackage[] subPackages;: Undocumented in source.
systemDependencies string systemDependencies;: Undocumented in source.
targetName string targetName;: Undocumented in source.
targetPath UnprocessedPath targetPath;: Undocumented in source.
targetType TargetType targetType;: Undocumented in source.
toolchainRequirements ToolchainRequirement[Toolchain] toolchainRequirements;: Undocumented in source.
versionFilters string[] versionFilters;: Undocumented in source.
versions Strings versions;: D version identifiers to set
workingDirectory UnprocessedPath workingDirectory;: Undocumented in source.

Meta

Source

See Implementation