Package

Representing a downloded / cached package, usually constructed from a json object. Documentation of the package.json can be found at http://registry.vibed.org/package-format

class Package {

struct LocalPackageDef;

this(Path root, Package parent);

this(Json packageInfo, Path root, Package parent);

string name [@property getter];

string vers [@property getter];

Version ver [@property getter];

inout(PackageInfo) info [@property getter];

Path path [@property getter];

Path packageInfoFile [@property getter];

const(Dependency[string]) dependencies [@property getter];

inout(Package) basePackage [@property getter];

inout(Package) parentPackage [@property getter];

inout(Package)[] subPackages [@property getter];

string[] configurations [@property getter];

inout(Package) getSubPackage(string name);

void warnOnSpecialCompilerFlags();

BuildSettings getBuildSettings(BuildPlatform platform, string config);

void addBuildTypeSettings(BuildSettings settings, BuildPlatform platform, string build_type);

string getSubConfiguration(string config, Package dependency, BuildPlatform platform);

string getDefaultConfiguration(BuildPlatform platform, bool allow_non_library);

string[] getPlatformConfigurations(BuildPlatform platform, bool is_main_package);

string generateInfoString();

void writeJson(Path path);

bool hasDependency(string depname, string config);

void describe(Json dst, BuildPlatform platform, string config);

}

Constructors

this this(Path root, Package parent): Undocumented in source.
this this(Json packageInfo, Path root, Package parent): Undocumented in source.

Members

Functions

addBuildTypeSettings void addBuildTypeSettings(BuildSettings settings, BuildPlatform platform, string build_type): Undocumented in source. Be warned that the author may not have intended to support it.
describe void describe(Json dst, BuildPlatform platform, string config): Undocumented in source. Be warned that the author may not have intended to support it.
generateInfoString string generateInfoString(): Human readable information of this package and its dependencies.
getBuildSettings BuildSettings getBuildSettings(BuildPlatform platform, string config): Returns all BuildSettings for the given platform and config.
getDefaultConfiguration string getDefaultConfiguration(BuildPlatform platform, bool allow_non_library): Returns the default configuration to build for the given platform
getPlatformConfigurations string[] getPlatformConfigurations(BuildPlatform platform, bool is_main_package): Returns a list of configurations suitable for the given platform
getSubConfiguration string getSubConfiguration(string config, Package dependency, BuildPlatform platform): Undocumented in source. Be warned that the author may not have intended to support it.
getSubPackage inout(Package) getSubPackage(string name): Undocumented in source. Be warned that the author may not have intended to support it.
hasDependency bool hasDependency(string depname, string config): Undocumented in source. Be warned that the author may not have intended to support it.
warnOnSpecialCompilerFlags void warnOnSpecialCompilerFlags(): Undocumented in source. Be warned that the author may not have intended to support it.
writeJson void writeJson(Path path): Writes the json file back to the filesystem

Properties

basePackage inout(Package) basePackage [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
configurations string[] configurations [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
dependencies const(Dependency[string]) dependencies [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
info inout(PackageInfo) info [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
name string name [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
packageInfoFile Path packageInfoFile [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
parentPackage inout(Package) parentPackage [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
path Path path [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
subPackages inout(Package)[] subPackages [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
ver Version ver [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
vers string vers [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.

Structs

LocalPackageDef struct LocalPackageDef: Undocumented in source.

Package

Constructors

Members

Functions

Properties

Structs

Meta

Source