wx.Net.Build: wx.Build.MS.Link Class Reference

wx.Build.MS.Link.Link ( )

This creates an instance that serves as a build action provider.

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.

override void wx.Build.MS.Link.AppendBooCode	(	List< string >	booCodeLines,
		string	indention,
		BuildToolFamilyEnv	env
	)			`[virtual]`

This method will create BOO source code and append this code to the provided text writer.

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.
	booCode	The code that will actually build something. Each list entry will be a line of code in the resulting BOO program.
	indention	A string that shall preceed all created lines.

Refer to IBuildActionProvider.AppendToBooPreamble() for an example.

Exceptions:

NotSupportedException

Will be thrown if this feature is not supported.

Reimplemented from wx.Build.BaseAction.

override void wx.Build.MS.Link.AppendToBooPreamble	(	BuildToolFamilyEnv	env,
		List< string >	importModules,
		List< string >	booDeclarations,
		List< string >	booDefinitions
	)			`[virtual]`

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:

	env	Environment containing status that can be shared among tools of the same family.
	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).
	booDeclarations	Lines of code that will be added to the preamble of the BOO code. Please note, that each line may only appear once. All subsequent additions of this line of code will be ignored. These lines shall contain declarations of variables etc.
	booDefinitions	Lines of code that that will be added before the code provided by the actions to build the system. Typically, this will contain the definition of functions that are used on building. Lines starting with "import" will only be added once to the final code.

This will define a function RunMsLink receiving all objects that shall be linked.

Reimplemented from wx.Build.BaseAction.

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

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

void wx.Build.IBuildAction.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");

Implemented in wx.Build.AlternativeBuildActions, wx.Build.SequenceOfBuildActions, and wx.Build.NamedAction.

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");

override bool wx.Build.MS.Link.ContainsPrerequisite ( IBuildProduct prereq ) [virtual]

True iff prereq is among the GetPrerequisites().

Reimplemented from wx.Build.BaseAction.

IBuildAction wx.Build.MS.Link.Create	(	BuildToolFamilyEnv	env,
		IBuildProduct	target,
		ICollection< IBuildProduct >	prerequisites
	)

Creates a particular build action achieving the provided targets provided that the specified prerequisites are known. This shall throw an System.ArgumentException if either targets or prerequisites do are not compatible with the declarations of this class or this class does not implement an actions providing the specified targets for some other reason. However, callers shall not rely on this.

If this action provider is only able to create specific instances of the fiel types as declared in ContentFileTargets , this method will return a null . In that case, this provider will be ignored silently.

The build environment will pass an occasionally empty instance of class BuildToolFamilyEnv where this may retrieve or store information that other tools of the same family have created before or other tools of the same family may use later. Actions MUST ALSO WORK when started with an empty environment.

Implements wx.Build.IBuildActionProvider.

bool wx.Build.MS.Link.Execute	(	BuildToolFamilyEnv	env,
		DateTime	validityOfBuildSystem
	)

Implements wx.Build.IBuildAction.

override ICollection<IBuildProduct> wx.Build.MS.Link.GetPrerequisites ( ) [virtual]

Collection of the prerequisites of this action.

Implements wx.Build.BaseAction.

override System.Diagnostics.ProcessStartInfo wx.Build.MS.Link.GetProgramStartInfo ( BuildToolFamilyEnv env ) [virtual]

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

Reimplemented from wx.Build.BaseAction.

override ICollection<IBuildProduct> wx.Build.MS.Link.GetTargets ( ) [virtual]

Collection of the targets or products of this action.

Implements wx.Build.BaseAction.

DateTime wx.Build.IBuildObject.GetValidity ( ) [inherited]

Returns validity timstamp of this object. Whenever this is equal or later than all prerequisites, this is considered consistent with the prerequisites on rebuilding.

Implemented in wx.Build.FeatureList, wx.Build.AlternativeBuildActions, wx.Build.SequenceOfBuildActions, wx.Build.NamedAction, wx.Build.RefToProject, wx.Build.ContentFile, wx.Build.ContentFiles, wx.Build.FileSelector, wx.Build.FileProducts, and wx.Build.ResourceDesignator.

virtual DateTime wx.Build.BaseAction.GetValidity ( ) [virtual, inherited]

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

Reimplemented in wx.Build.BuildProject, and wx.Build.Cxx.wxWidgets.

DateTime wx.Build.IBuildObject.GetValidityDemand ( ) [inherited]

This is the counterpart of the Validity . If this occurs as a prerequisite, this shall be compared with the Validity of the target in order to assess whether rebuild is necessary or not.

Implemented in wx.Build.FeatureList, wx.Build.AlternativeBuildActions, wx.Build.SequenceOfBuildActions, wx.Build.NamedAction, wx.Build.RefToProject, wx.Build.ContentFile, wx.Build.ContentFiles, wx.Build.FileSelector, wx.Build.FileProducts, and wx.Build.ResourceDesignator.

virtual DateTime wx.Build.BaseAction.GetValidityDemand ( ) [virtual, inherited]

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

Reimplemented in wx.Build.BuildProject, and wx.Build.Cxx.wxWidgets.

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

This is the earliest validiy of a target.

bool wx.Build.MS.Link.MayContentFilePrerequisitesSuffice	(	ContentType	target,
		ICollection< ContentType >	prerequisites
	)

This returns true iff the described action is likely to produce the specified target provided that the specified prerequisites are available.

Implements wx.Build.IBuildActionProvider.

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

bool wx.Build.IBuildAction.TargetsAreConsistent ( DateTime validityOfBuildSystem ) [inherited]

True, if this action is not required to run because all targets are up to date.

Parameters:

validityOfBuildSystem

indicates the last change of either this DLL or the assembly defining the project. So, all action will be repeated (even if rebuild is specified) if the project definition changes or the implementation of the build system has been enhanced since the final build. This argument will be computed and propagated by the project.

Implemented in wx.Build.AlternativeBuildActions, wx.Build.SequenceOfBuildActions, and wx.Build.NamedAction.

virtual bool wx.Build.BaseAction.TargetsAreConsistent ( DateTime validityOfBuildSystem ) [virtual, inherited]

This simply tests whether the oldest validity of the targets is equal to or more current than the validity of the prerequisites.

Parameters:

validityOfBuildSystem

indicates the last change of either this DLL or the assembly defining the project. changes to the build system or the project definition affect of course the validity of the produced targets. Use System.DateTime.MinValue if you do not know or want this to be neglected.

Reimplemented in wx.Build.Cxx.wxWidgets.

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.

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.

IBuildActionProvider wx.Build.MS.Link.ActionProvider [get]

This is its own action provider.

Implements wx.Build.IBuildAction.

ICollection<OperatingSystem> wx.Build.MS.Link.ApplicableOSs [get]

Implements wx.Build.IBuildActionProvider.

ICollection<ContentType> wx.Build.MS.Link.ContentFileTargets [get]

This currently supports only Windows DLLs.

Implements wx.Build.IBuildActionProvider.

string wx.Build.MS.Link.Description [get]

A textual description of this class.

Implements wx.Build.IBuildActionProvider.

FeatureList wx.Build.IBuildAction.Features [get, inherited]

Provides access to the features of this action. Features usually are defined by the project. The project will set this at the actions that it creates to build the task.

Implemented in wx.Build.AlternativeBuildActions, wx.Build.SequenceOfBuildActions, and wx.Build.NamedAction.

virtual FeatureList wx.Build.BaseAction.Features [get, inherited]

Returns the features that are associated with this action. This feature list usually comes from the BuildProject that created this action. Overload this for projects!!!

Reimplemented in wx.Build.BuildProject.

string wx.Build.MS.Link.FileName [get]

The filename of the compiler.

bool wx.Build.MS.Link.IsAvailable [get]

This may be false if actions of this class are note available (for some reasons that are not related to targets).

Implements wx.Build.IBuildActionProvider.

string wx.Build.MS.Link.Name [get]

link .exe

Implements wx.Build.IBuildAction.

ICollection<Type> wx.Build.IBuildAction.ParameterTypes [get, inherited]

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.

Implemented in wx.Build.AlternativeBuildActions, wx.Build.SequenceOfBuildActions, wx.Build.NamedAction, wx.Build.Mono.Gmcs, wx.Build.MS.Cl, and wx.Build.MS.Csc.

virtual ICollection<Type> wx.Build.BaseAction.ParameterTypes [get, inherited]

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 in wx.Build.Mono.Gmcs, wx.Build.MS.Cl, wx.Build.MS.Csc, and wx.Build.Cxx.wxWidgets.

ActionPriority wx.Build.MS.Link.Priority [get]

Priority of this action. May be everything but user-defined.

Implements wx.Build.IBuildAction.

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

The project that requested this action. the result may be null if this instance also implements IBuildActionProvider and this instance is meant to be a action provider and not an action. Note, that projects may be set only once. This will be done by the infrastructure. Thus, do not use the setter.

Implemented in wx.Build.AlternativeBuildActions, wx.Build.SequenceOfBuildActions, and wx.Build.NamedAction.

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

The project that requested this action.

string wx.Build.MS.Link.ToolFamily [get]

"MS VC"

Implements wx.Build.IBuildActionProvider.

override IDictionary<string, EnvironmentVarInfo> wx.Build.MS.Link.UsedVars [get]

This returns null since useually shell variables are not used by actions.

Reimplemented from wx.Build.BaseAction.

wx.Build.MS.Link Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation


Public Member Functions
delegate void	AdderSerializable (System.Xml.Serialization.IXmlSerializable arg)
override void	AppendBooCode (List< string > booCodeLines, string indention, BuildToolFamilyEnv env)
override void	AppendToBooPreamble (BuildToolFamilyEnv env, List< string > importModules, List< string > booDeclarations, List< string > booDefinitions)
bool	AreAllMandatoryVarsDefined ()
void	CollectChoicePoints (IDictionary< string, ICollection< string >> collectionOfChoicePoints)
void	CollectChoicePoints (IDictionary< string, ICollection< string >> collectionOfChoicePoints)
override bool	ContainsPrerequisite (IBuildProduct prereq)
IBuildAction	Create (BuildToolFamilyEnv env, IBuildProduct target, ICollection< IBuildProduct > prerequisites)
bool	Execute (BuildToolFamilyEnv env, DateTime validityOfBuildSystem)
override ICollection < IBuildProduct >	GetPrerequisites ()
override System.Diagnostics.ProcessStartInfo	GetProgramStartInfo (BuildToolFamilyEnv env)
override ICollection < IBuildProduct >	GetTargets ()
DateTime	GetValidity ()
virtual DateTime	GetValidity ()
DateTime	GetValidityDemand ()
virtual DateTime	GetValidityDemand ()
DateTime	GetValidityTargets ()
	Link ()
bool	MayContentFilePrerequisitesSuffice (ContentType target, ICollection< ContentType > prerequisites)
bool	TargetsAreConsistent (DateTime validityOfBuildSystem)
virtual bool	TargetsAreConsistent (DateTime validityOfBuildSystem)
Static Public Member Functions
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 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	WriteProject (System.Xml.XmlWriter writer)
Properties
IBuildActionProvider	ActionProvider `[get]`
ICollection < OperatingSystem >	ApplicableOSs `[get]`
ICollection < ContentType >	ContentFileTargets `[get]`
string	Description `[get]`
FeatureList	Features `[get]`
virtual FeatureList	Features `[get]`
string	FileName `[get]`
bool	IsAvailable `[get]`
string	Name `[get]`
ICollection< Type >	ParameterTypes `[get]`
virtual ICollection < Type >	ParameterTypes `[get]`
ActionPriority	Priority `[get]`
BuildProject	Project `[get, set]`
BuildProject	Project `[get, set]`
string	ToolFamily `[get]`
override IDictionary < string, EnvironmentVarInfo >	UsedVars `[get]`