wx.Build.Cxx.wxWidgets Class Reference

Inheritance diagram for wx.Build.Cxx.wxWidgets:

Inheritance graph

List of all members.

Public Member Functions

delegate void AdderSerializable (System.Xml.Serialization.IXmlSerializable arg)
override bool AdoptConfig (BuildConfig buildConfig)
virtual void AppendBooCode (List< string > booCodeLines, string indention, BuildToolFamilyEnv env)
virtual void AppendToBooPreamble (BuildToolFamilyEnv env, List< string > importModules, List< string > booDeclarations, List< string > booDefinitions)
bool AreAllMandatoryVarsDefined ()
override object Clone ()
void CollectChoicePoints (IDictionary< string, ICollection< string >> collectionOfChoicePoints)
virtual int CompareTo (object obj)
override bool ContainsPrerequisite (IBuildProduct prereq)
override ICollection
< IBuildAction
CreateActionPlan (BuildToolFamilyEnv env)
override RefToProject CreateRef ()
virtual RefToFileProject CreateRefToFileProject ()
override bool Equals (object obj)
Guid GetGuid ()
override int GetHashCode ()
override ICollection
< IBuildProduct
GetPrerequisites ()
virtual
System.Diagnostics.ProcessStartInfo 
GetProgramStartInfo (BuildToolFamilyEnv env)
System.Xml.Schema.XmlSchema GetSchema ()
BuildProject GetSingleton ()
override ICollection
< IBuildProduct
GetTargets ()
override DateTime GetValidity ()
override DateTime GetValidityDemand ()
DateTime GetValidityTargets ()
virtual void NormalizeOriginalFileName (string nameOfAValidDirOrFile)
override void ReadXml (System.Xml.XmlReader reader)
override bool TargetsAreConsistent (DateTime validityOfBuildSystem)
override string ToString ()
void WriteRefXml (System.Xml.XmlWriter writer)
override void WriteXml (System.Xml.XmlWriter writer)
 wxWidgets (wxStyles styles)
 wxWidgets ()

Static Public Member Functions

static ICollection
< BuildProject
AddIncludedProjects (IDictionary< BuildProject, BuildProject > result, ICollection< IBuildProduct > listOfBuildProducts)
static void AddKnownProject (BuildProject p)
static int Build (ErrorHandler handler, System.Reflection.Assembly projectSrc, string[] programOpts)
static int Build (ErrorHandler handler, string[] programOpts)
static int Build (string[] programOpts)
static void ClearKnownProjects ()
static ICollection
< BuildProject
GetAllProjectsDeclaredInAssembly (System.Reflection.Assembly assembly, ICollection< ErrorObject > errors)
static BuildProject GetKnownProject (Guid id)
static ICollection
< BuildProject
GetKnownProjects ()
static ICollection
< EnvironmentVarInfo
GetUsedVariables (System.Reflection.Assembly projectSrc)
static BuildProject LoadRefFrom (System.Xml.XmlReader reader)
static implicit operator FileProject (RefToFileProject refToProject)
static bool ReadCollection (System.Xml.XmlReader reader, AdderSerializable collectorForResults, string outerElementName, string innerElementName)
static
System.Xml.Serialization.IXmlSerializable 
ReadSerializable (System.Xml.XmlReader reader, string elementName)
static IList
< BuildProject
ScheduleProjects (ICollection< BuildProject > projects)
static string StringAsSymbol (string aName)
static void WriteCollectionOfSerializables (System.Xml.XmlWriter writer, System.Collections.IEnumerable serializables, string outerElementName, string innerElementName)
static void WriteSerializable (System.Xml.XmlWriter writer, System.Xml.Serialization.IXmlSerializable obj, string elementName)

Protected Member Functions

void ReadProject (System.Xml.XmlReader reader)
void ReadStdAttributes (System.Xml.XmlReader reader)
void SetAsKnownProject (Guid oldGuid)
void WriteProject (System.Xml.XmlWriter writer)
void WriteStdAttributes (System.Xml.XmlWriter writer)

Static Protected Member Functions

static Guid RegisterProjectTargets (BuildProject p)

Properties

ICollection
< OperatingSystem
ApplicableOSs [get]
static string BaseDir [get]
ICollection
< ContentType
ContentFileTargets [get]
override string Description [get]
override FeatureList Features [get]
Guid Id [get]
bool IsSingleton [get]
string Name [get]
string NameAsSymbol [get]
override ICollection
< Type > 
ParameterTypes [get]
ProjectPreference Preference [get]
ActionPriority Priority [get]
BuildProject Project [get, set]
string ToolFamily [get]
override IDictionary
< string,
EnvironmentVarInfo
UsedVars [get]
DateTime ValidityOfDefiningAssemblies [get]
static DateTime ValidityOfExecutingAssembly [get]


Detailed Description

Use this tool to refer to a prebuilt instance of the wxWidgets libraries. This tool is intended to build the wxWidgets system is necessary. However, this is currently not supported. This action will raise an exception if wxWidgets cannot be found.

However, this tool also provides means to adopt parameters for C++ compilation and linking, and its target shall be used as input to any native code project that uses wxWidgets. This build action uses environment variable WXWIN to point at the currently relevant instance of the library. If this variable is not defined, this will search for an appropriate installation at the commonly used directories "C:\wxWidgets-2.8.9", "C:\wxWidgets-2.8.8", etc.


Constructor & Destructor Documentation

wx.Build.Cxx.wxWidgets.wxWidgets (  ) 

Creates a project with unspecific style.

wx.Build.Cxx.wxWidgets.wxWidgets ( wxStyles  styles  ) 

Creates the project presupposing the properties as specified by the provided style flags. The current implementation will not check whether the current wxWidgets installation provides all the specified features. Nevertheless, the styles will be used to refer to the correct library and setup files.

Please note, that MS VC platform will be removed from the specification if the build process runs Unix/Linux.

Since this project does not need modifiers, this will be made ready automatically on instance creation (cf. BuildProject.GetSingleton()).

 wx.Build.Cxx.wxWidgets wxProject = new wx.Build.Cxx.wxWidgets(wx.Build.Cxx.wxStyles.Use_StyledtextControl
   // The Unicode style below is recommended but not required. You may remove it.
   | wx.Build.Cxx.wxStyles.Use_Unicode);
 Cxx.DynamicLibraryProject wxcProject = new wx.Build.Cxx.DynamicLibraryProject(ProjectPreference.Default,
   "wx-c",
   ".", "wx-c",
   "The native code of the wx.NET project.");
 wxcProject.AddStaticLibrary(wxProject.CreateRefToFileProject());
 wxcProject.AddCPlusPlusSources(new FileSelector(ContentType.CPlusPlusCode, "..\\Src\\wx-c", "*.cxx", "wx.NET C++ sources."));
 wxcProject.AddHeaderFiles(new FileSelector(ContentType.CCPlusPlusInclude, "..\\Src\\wx-c", "*.h", "wx.NET C++ includes."));
 wxcProject.AddRCFile(new ContentFile(ContentType.RCFile, "..\\Src\\wx-c\\windows.rc"));
 return wxcProject.GetSingleton();


Member Function Documentation

delegate void wx.Build.BaseAction.AdderSerializable ( System.Xml.Serialization.IXmlSerializable  arg  )  [inherited]

Will be called in ReadCollection() if a new object has been found.

Parameters:
arg The object that has been found.

static ICollection<BuildProject> wx.Build.BuildProject.AddIncludedProjects ( IDictionary< BuildProject, BuildProject result,
ICollection< IBuildProduct listOfBuildProducts 
) [static, inherited]

Adds all build projects from listOfBuildProjects and their prerequisites to the result (a set: value equals key).

static void wx.Build.BuildProject.AddKnownProject ( BuildProject  p  )  [static, inherited]

This will add the provided project to the collection of known projects. This method will create a GUID for the added project if not yet known.

Parameters:
p The project that shall be added.

override bool wx.Build.Cxx.wxWidgets.AdoptConfig ( BuildConfig  buildConfig  )  [virtual]

This will modify the argument in such a way that users of wxWidgets can be compiled.

Reimplemented from wx.Build.BuildProject.

virtual void wx.Build.BaseAction.AppendBooCode ( List< string >  booCodeLines,
string  indention,
BuildToolFamilyEnv  env 
) [virtual, inherited]

This implementation will look for a program start info that implements this actions. If program start info is null, this implementation will raise an exception. Overload this if you have to create another implementation providing this feature.

Parameters:
env This is an environment that different tools of the same family may use to exchange information. This store is typically used to save information on configuration files or thinsgs of that kind that will be shared among all tools of the same family.
booCodeLines The code that will actually build something will be appended to this writer.
indention A string that shall preceed all created lines.
Exceptions:
NotSupportedException Will be thrown if this feature is not supported.
See also:
GetProgrammStartInfo

Reimplemented in wx.Build.FileTestAction, wx.Build.Cxx.GCC.GccAsCompiler, wx.Build.Cxx.GCC.GccAsLinker, wx.Build.Cxx.GCC.WindRes, wx.Build.Mono.Gmcs, wx.Build.MS.Cl, wx.Build.MS.Link, wx.Build.MS.RC, wx.Build.MS.Csc, wx.Build.Release.ReplaceVersionInRCFile, and wx.Build.Release.CopyFileAction.

virtual void wx.Build.BaseAction.AppendToBooPreamble ( BuildToolFamilyEnv  env,
List< string >  importModules,
List< string >  booDeclarations,
List< string >  booDefinitions 
) [virtual, inherited]

This will be called for any action provider before IBuildAction.AppendBooCode() is called. This provides action providers with the opportunity to import modules and create variables for global options.

Parameters:
importModules List of modules that shall be imported. Add required modules here. Each module will be imported exactly once (even if it occurs more than once in the list).
env This is an environment that different tools of the same family may use to exchange information. This store is typically used to save information on configuration files or thinsgs of that kind that will be shared among all tools of the same family.
A typical use is the import of modules that will be used in the later BOO code that builds the project.
            void AppendToBooPreamble(System.IO.TextWriter booCodeLines)
            {
                booCodeLines.Add("import System.Diagnostics");
                booCodeLines.Add("Process=System.Diagnostics.Process");
            }

Reimplemented in wx.Build.Cxx.GCC.GccAsCompiler, wx.Build.Cxx.GCC.GccAsLinker, wx.Build.Cxx.GCC.WindRes, wx.Build.Mono.Gmcs, wx.Build.MS.Cl, wx.Build.MS.Link, wx.Build.MS.RC, and wx.Build.MS.Csc.

bool wx.Build.BaseAction.AreAllMandatoryVarsDefined (  )  [inherited]

True iff all mandatory environment variables are defined. The project cannot be made if this is false.

static int wx.Build.BuildProject.Build ( ErrorHandler  handler,
System.Reflection.Assembly  projectSrc,
string[]  programOpts 
) [static, inherited]

Builds projects regarding the provided options.

Parameters:
handler will be set as configured error handler in the BuildConfig. Output of errors and warnings via handler .
programOpts programOpts may be the name of tools/build actions or projects, or you may use one or more of the options "/help", "/vars", "/projects", "/actions", "/clean", "/disable:ACTION", "/disable:PROJECT", /set:VARNAME=VALUE, or /append:VARNAME=VALUE. Refer to class CommandLineOptions.
projectSrc The assembly containing the project definitions. This may be null.
Returns:
0 on success and 1 on failure, that should however also be reported to the error handler.

static int wx.Build.BuildProject.Build ( ErrorHandler  handler,
string[]  programOpts 
) [static, inherited]

Builds projects regarding the provided options. Projects will be read from the Assembly.GetCallingAssembly.

Parameters:
handler Output of errors and warnings using this handler.
programOpts programOpts may be the name of tools/build actions or projects, or you may use one or more of the options "/help", "/vars", "/targets", "/projects", "/clean", "/disable:ACTION", "/disable:PROJECT", /set:VARNAME=VALUE, or /append:VARNAME=VALUE. Refer to class CommandLineOptions.
Returns:
0 on success and 1 on failure, that should however also be reported to the error handler.

Refer to the remarks on class BuildProject for an example of a project definition.

static int wx.Build.BuildProject.Build ( string[]  programOpts  )  [static, inherited]

Builds projects regarding the provided options. Projects will be read from the Assembly.GetCallingAssembly. Output of errors and warnings on System.Console.

Parameters:
programOpts programOpts may be the name of tools/build actions or projects, or you may use one or more of the options "/help", "/vars", "/targets", "/projects", "/clean", "/disable:ACTION", "/disable:PROJECT", /set:VARNAME=VALUE, or /append:VARNAME=VALUE. Refer to class CommandLineOptions.
Returns:
0 on success and 1 on failure, that should however also be reported to the error handler.
See also:
CommandLineOptions

static void wx.Build.BuildProject.ClearKnownProjects (  )  [static, inherited]

Clear the loaded projects.

override object wx.Build.Cxx.wxWidgets.Clone (  )  [virtual]

Deep copy of this instance.

Implements wx.Build.BuildProject.

void wx.Build.BaseAction.CollectChoicePoints ( IDictionary< string, ICollection< string >>  collectionOfChoicePoints  )  [inherited]

This method collects all choice points within this action. Choice points are represented by a name and a collection of alternatives.

Parameters:
collectionOfChoicePoints The collection that will be extended by the choice points of this action.
The current implementation provides a choice point for the compilation and linking of C/C++ programs, "CppDevelopmentSystem" of the alternatives "GCC" and "MS VC". Thus, actions on C/C++ compilation will add the following choice point:
            if (!collectionOfChoicePoints.ContainsKey("CppDevelopmentSystem"))
                collectionOfChoicePoints.Add("CppDevelopmentSystem", new List&lt;string&gt;());
            collectionOfChoicePoints["CppDevelopmentSystem"].Add("GCC");
            collectionOfChoicePoints["CppDevelopmentSystem"].Add("MS VC");

virtual int wx.Build.BuildProject.CompareTo ( object  obj  )  [virtual, inherited]

Compares all properties, targets, and dependencies of this and the obj if the argument is a project of the same class. If the argument is of another class, this compares the full class names.

This is virtual since inheritors may overload this. However, inheritors MUST take care, that their implementation is symmetric to this one, i.e. must be of the form

            if (obj.GetType().Equals(this.GetType())
            {
                ...
            }
            else return this.GetType().FullName.CompareTo(obj.GetType().FullName);

Parameters:
obj Object that will be compared with this.
Returns:
-1, 0, or 1 like in all the other implementations of this method.

Reimplemented in wx.Build.Release.MakeReleaseProject.

override bool wx.Build.Cxx.wxWidgets.ContainsPrerequisite ( IBuildProduct  prereq  )  [virtual]

This does not contain prerequisites.

Reimplemented from wx.Build.BaseAction.

override ICollection<IBuildAction> wx.Build.Cxx.wxWidgets.CreateActionPlan ( BuildToolFamilyEnv  env  )  [virtual]

This will create a collection of instances of FileTestAction. This creates separated actions for either ContentType.CoffLib targets and ContentType.GccLib targets. Thus, later steps of linking may either refer to different actions.

To increase efficiency, this will only create actions for those files that really exist.

Implements wx.Build.BuildProject.

override RefToProject wx.Build.FileProject.CreateRef (  )  [virtual, inherited]

Returns an instance of RefToFileProject.

Returns:

Reimplemented from wx.Build.BuildProject.

Reimplemented in wx.Build.SingleFileProject.

virtual RefToFileProject wx.Build.FileProject.CreateRefToFileProject (  )  [virtual, inherited]

Reimplemented in wx.Build.SingleFileProject.

override bool wx.Build.BuildProject.Equals ( object  obj  )  [inherited]

Comparison refers to the implementation of IComparable.CompareTo().

static ICollection<BuildProject> wx.Build.BuildProject.GetAllProjectsDeclaredInAssembly ( System.Reflection.Assembly  assembly,
ICollection< ErrorObject errors 
) [static, inherited]

Returns a collection of all projects declared in the provided assembly. Projects are declared using the attributes BuildProjectAttribute.

Parameters:
assembly The assembly that contains the project definitions. This method will also accept null. In that case, this will return the GetLoadedProjects()
errors This method will add encountered errors to this argument if it is not null.

Guid wx.Build.BuildProject.GetGuid (  )  [inherited]

This will return the Id but create one if not yet known.

Id

override int wx.Build.BuildProject.GetHashCode (  )  [inherited]

Reimplemented in wx.Build.Release.MakeReleaseProject.

static BuildProject wx.Build.BuildProject.GetKnownProject ( Guid  id  )  [static, inherited]

Returns the project of the provided ID.

Parameters:
id The ID of the desired project
Returns:
The project of the desired name or null if this project is unknown.

static ICollection<BuildProject> wx.Build.BuildProject.GetKnownProjects (  )  [static, inherited]

Returns the collection of projects that have been loaded from file.

override ICollection<IBuildProduct> wx.Build.Cxx.wxWidgets.GetPrerequisites (  )  [virtual]

This does not contain prerequisites.

Implements wx.Build.BaseAction.

virtual System.Diagnostics.ProcessStartInfo wx.Build.BaseAction.GetProgramStartInfo ( BuildToolFamilyEnv  env  )  [virtual, inherited]

This simply returns null and may serve as standard implementation of those actions that do not use System.Diagnostics.Process.

Reimplemented in wx.Build.Cxx.GCC.GccAsCompiler, wx.Build.Cxx.GCC.GccAsLinker, wx.Build.Cxx.GCC.WindRes, wx.Build.Mono.Gmcs, wx.Build.MS.Cl, wx.Build.MS.Link, wx.Build.MS.RC, and wx.Build.MS.Csc.

System.Xml.Schema.XmlSchema wx.Build.BuildProject.GetSchema (  )  [inherited]

Returns null as suggested by the .NET framework documentation.

BuildProject wx.Build.BuildProject.GetSingleton (  )  [inherited]

This will make the project instance ready to be solved. The build system will only use one project instance per target. Thus, projects will be registered. This will try to register this instance. If the database of registered project already contains a project instance for the targets of this instance, this will return this instance.

Returns:

Reimplemented in wx.Build.Net.CSharpAssemblyProject, wx.Build.Cxx.DynamicLibraryProject, and wx.Build.Release.MakeReleaseProject.

override ICollection<IBuildProduct> wx.Build.Cxx.wxWidgets.GetTargets (  )  [virtual]

The library files of wxWidgets either applicable to GCC linker or MS VC linker.

Implements wx.Build.BaseAction.

static ICollection<EnvironmentVarInfo> wx.Build.BuildProject.GetUsedVariables ( System.Reflection.Assembly  projectSrc  )  [static, inherited]

Creates a collection of all environment variables that are used either by project or actions.

Parameters:
projectSrc An assembly that contains project definitions. This may be null. In that case, this will use all loaded problems.
Returns:

override DateTime wx.Build.Cxx.wxWidgets.GetValidity (  )  [virtual]

This is the timestamp representing how current the prerequisites are. The standard implementation will use be the latest validity of a prerequisite.

Reimplemented from wx.Build.BuildProject.

override DateTime wx.Build.Cxx.wxWidgets.GetValidityDemand (  )  [virtual]

This is the timestamp representing the latest change of a prerequisite. The standard implementation will use be the latest validity of a prerequisite.

Reimplemented from wx.Build.BuildProject.

DateTime wx.Build.BaseAction.GetValidityTargets (  )  [inherited]

This is the earliest validiy of a target.

static BuildProject wx.Build.BuildProject.LoadRefFrom ( System.Xml.XmlReader  reader  )  [static, inherited]

Reads a project whose properties are available by GetLoadedProject().

Parameters:
reader The source.
Exceptions:
KeyNotFoundException Raised if the read project cannot be found in the GetLoadedProject().

virtual void wx.Build.BuildProject.NormalizeOriginalFileName ( string  nameOfAValidDirOrFile  )  [virtual, inherited]

You may use this method to control the form of the file name that will be used to serialize this (the original filename). The argument is a path to an existing file or directory. This will strip a directory information from this path. After that, the original file name will change to something equivalent to the absolute filename (referring to the same file) but now relative to the directory as specified by the argument.

Use this method to prepare content file instance for serialization in such a way that all file names become relative to the same directory.

Parameters:
nameOfAValidDirOrFile The name of an existing file or directory. This name will - if relative - be expanded using the BuildConfig. If this is null, this method will return without any effect. This may also be the name of a not yet existing file. In that case, however, the directory name shall exist.
See also:
OriginalFileName

Exceptions:
System.ArgumentException Will be raised if the argument is neither the path to an existing file nor directory.

Reimplemented in wx.Build.Release.MakeReleaseProject.

static implicit wx.Build.FileProject.operator FileProject ( RefToFileProject  refToProject  )  [static, inherited]

static bool wx.Build.BaseAction.ReadCollection ( System.Xml.XmlReader  reader,
AdderSerializable  collectorForResults,
string  outerElementName,
string  innerElementName 
) [static, inherited]

Reads a collection of serializable objects from the provided XML source.

Parameters:
reader XML source
collectorForResults This will add the created results to this collection.
outerElementName name of the XML element that will embrace all elements.
innerElementName Name of the XML element that contains the information of a single serialized object.
Returns:
True if the outer element name has been found. False if this has not been able to parse a term complying with the expected content.

void wx.Build.BaseAction.ReadProject ( System.Xml.XmlReader  reader  )  [protected, inherited]

Reads the features as serialized by WriteFeatures().

Parameters:
reader The source of serialized data

static System.Xml.Serialization.IXmlSerializable wx.Build.BaseAction.ReadSerializable ( System.Xml.XmlReader  reader,
string  elementName 
) [static, inherited]

This reads a serilization that has been created by WriteSerializable(). This only works if an instance of the serialized obejct can be created without arguments.

Parameters:
reader The serialization will be read from this source.
elementName Name of the XML element that encapsulates the serialization.
Returns:
The object instance that has been created from the serialized information.
WriteSerializable

void wx.Build.BuildProject.ReadStdAttributes ( System.Xml.XmlReader  reader  )  [protected, inherited]

Helper for XML serialization of projects. Call this immediately after reading the root element of a serialized project to read the attributes stored by WriteStdAttributes().

Parameters:
reader The source where to read the serialization from.

override void wx.Build.Cxx.wxWidgets.ReadXml ( System.Xml.XmlReader  reader  )  [virtual]

Serialization of full data. This mus be written by each subclass of a project whereas the standard serialization is generic.

All Implementations of this project shall not forget to read the ReadStdAttributes() and add this instance to the loaded projects using

            System.Guid oldGuid=this.Id;
            wx.Build.BuildProject.ReadStdAttributes();
            this.SetAsLoadedProject(oldGuid);

Parameters:
reader The source

Implements wx.Build.BuildProject.

static Guid wx.Build.BuildProject.RegisterProjectTargets ( BuildProject  p  )  [static, protected, inherited]

Static factory methods creating projects will use this method to decide whether a new instance of the project is justified or probably a doublette.

Parameters:
p The project instance that shall be tested.
Returns:
The Guid of a preexisting project producing at least on of p's targets and that is of the same type. The result will be the GUID of p if p can be used.

static IList<BuildProject> wx.Build.BuildProject.ScheduleProjects ( ICollection< BuildProject projects  )  [static, inherited]

Put projects in such an order that they occur before all their prerequisites that are also projects. This will put the project into a certain order that allows later steps of processing to concatenate actions plans.

Parameters:
projects projects to schedule.
Returns:
a list containig all projects and their prerequisites or null in case that no appropriate order exists.

void wx.Build.BuildProject.SetAsKnownProject ( Guid  oldGuid  )  [protected, inherited]

Register this as a loaded project. The argument is the old Id of this project that it might have had before reading from a stream or System.Guid.Empty if the project instance did not have an Id before.

Parameters:
oldGuid The old Id of this instance or System.Guid.Empty if this did not have an Id before.

This will remove this project from the collection of loaded projects if it has been registered before with Id oldGuid.

static string wx.Build.BuildProject.StringAsSymbol ( string  aName  )  [static, inherited]

Returns a version of the argument that may serve as a C/C++ or C# symbol.

Parameters:
aName 
Returns:

override bool wx.Build.Cxx.wxWidgets.TargetsAreConsistent ( DateTime  validityOfBuildSystem  )  [virtual]

Since this currently can not build any wxWidgets library, this is true iff all targets already exist.

Reimplemented from wx.Build.BaseAction.

override string wx.Build.BuildProject.ToString (  )  [inherited]

static void wx.Build.BaseAction.WriteCollectionOfSerializables ( System.Xml.XmlWriter  writer,
System.Collections.IEnumerable  serializables,
string  outerElementName,
string  innerElementName 
) [static, inherited]

Serializes a collection of serializable objects.

Parameters:
writer This method will write the serialization to this destination.
serializables The collection of object to serialize. All objects must implement System.Xml.Serialization.IXmlSerializable.
outerElementName name of the XML element that will embrace all elements.
innerElementName Name of the XML element that contains the information of a single serialized object.

void wx.Build.BaseAction.WriteProject ( System.Xml.XmlWriter  writer  )  [protected, inherited]

This will serialize the feature list in an XML element "feature-list".

Parameters:
writer Destination of serialized data.

void wx.Build.BuildProject.WriteRefXml ( System.Xml.XmlWriter  writer  )  [inherited]

Serializing only the name of the project. Read this using LoadRefFrom().

Parameters:
writer The destinaton

static void wx.Build.BaseAction.WriteSerializable ( System.Xml.XmlWriter  writer,
System.Xml.Serialization.IXmlSerializable  obj,
string  elementName 
) [static, inherited]

Helper to serialize objects of unknown class. This will create an element of the provided element name and attach attributes "assembly" and "type" to this element. These elements will describe the type of the object to serialize. Then, embedded into this new element, the object will be asked to place its serialization.

Parameters:
obj The object that shall be serialized. May be null
elementName Name of the XML element that will be created.
writer The information will be written to this destination.

Use this method to serialize member variables of unknown type like e.g. wx.Build.IFileProducts. Often, projects refer to members where the only known information is: This implements wx.Build.IFileProducts. The project does not need to know more facts with one exception: When deserializing a XML serialization, the project needs to know the exact class because an object instance has to be created. This method will serialize the corresponding information in such a form, that ReadSerializable() can be used to read the written instance.

void wx.Build.BuildProject.WriteStdAttributes ( System.Xml.XmlWriter  writer  )  [protected, inherited]

Helper for XML serialization of projects. This will use System.Xml.XmlWriter.WriteAttributeString to write the attributes "name" and "preference". Call this immediately after starting the root element of the serialized project.

Parameters:
writer Destination

override void wx.Build.Cxx.wxWidgets.WriteXml ( System.Xml.XmlWriter  writer  )  [virtual]

Serialization of full data. This mus be written by each subclass of a project whereas the standard serialization is generic.

Do not forget to use WriteStdAttributes().

Parameters:
writer The destination

Implements wx.Build.BuildProject.


Property Documentation

ICollection<OperatingSystem> wx.Build.Cxx.wxWidgets.ApplicableOSs [get]

Currently only implemented for OperatingSystem.Linux and OperatingSystem.WinXP

string wx.Build.Cxx.wxWidgets.BaseDir [static, get]

The base directory of the recognized wxWidgets installation. If this is null, then this is not able to find a wxWidgets installation.

ICollection<ContentType> wx.Build.Cxx.wxWidgets.ContentFileTargets [get]

ContentType.CoffLib and ContentType.GccLib

override string wx.Build.Cxx.wxWidgets.Description [get]

Projects always have a descriptive text. This description will be used in dialogs or menus to explain available targets.

Reimplemented from wx.Build.BuildProject.

override FeatureList wx.Build.BuildProject.Features [get, inherited]

The features of the project.

Reimplemented from wx.Build.BaseAction.

Guid wx.Build.BuildProject.Id [get, inherited]

A unique identifier of the project. This will be used on serialization/deserialization to identify the project. This ID will be set on serialization. Not yet serialized projects will return an empty Guid.

See also:
GetGuild

bool wx.Build.BuildProject.IsSingleton [get, inherited]

This is true iff the project can be built. Run GetSingleton() to make this true.

string wx.Build.BuildProject.Name [get, inherited]

Projects always have a name. This name will be used in dialogs or menus to explain available targets.

string wx.Build.BuildProject.NameAsSymbol [get, inherited]

This is the Name but only consisting of letters, digits, and the underscore. Blancs will be replaced by underscores.

override ICollection<Type> wx.Build.Cxx.wxWidgets.ParameterTypes [get]

Returns a collection (typically an array) of relevant parameter types in the BuildConfig. This may be empty or null if instances of this class do not refer to parameter types. The return value of this implementation is null .

Reimplemented from wx.Build.BaseAction.

ProjectPreference wx.Build.BuildProject.Preference [get, inherited]

Returns the preference of this project. This controls whether the targets of this project will be achieved or not. Some projects will be accomplished only on user input. Some project may be hidden to the end user since they will be achieved only during the build process if reuiqred by other projects or actions.

ActionPriority wx.Build.Cxx.wxWidgets.Priority [get]

BuildProject wx.Build.BaseAction.Project [get, set, inherited]

The project that requested this action.

string wx.Build.Cxx.wxWidgets.ToolFamily [get]

override IDictionary<string, EnvironmentVarInfo> wx.Build.Cxx.wxWidgets.UsedVars [get]

Variable WXWIN enables users on platforms (not Unix/Linux) to configure where the wxWidgets main directory is. The Boolean variable WXUNICODE may be used to turn use of Unicode build on or off.

Reimplemented from wx.Build.BaseAction.

DateTime wx.Build.BuildProject.ValidityOfDefiningAssemblies [get, inherited]

Validity of the assemblies defining the project and implementing execution. The assemblies defining the project and implementing tools and projects are standard prerequisites of the target. Whenever we change one of these assemblies, we want all targets to be rebuilt. This property returns a timestamp representing the validity of these prerequisites.

DateTime wx.Build.BuildProject.ValidityOfExecutingAssembly [static, get, inherited]

The validity (timestamp) of the assembly file containing this code (if this exists).


The wx.NET Build System.   (c) 2009-2010 Harald Meyer auf'm Hofe