wx.Build.Mono.Gmcs Class Reference

Inheritance diagram for wx.Build.Mono.Gmcs:

List of all members.

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 ProcessStartInfo	GetProgramStartInfo (BuildToolFamilyEnv env)
override ICollection < IBuildProduct >	GetTargets ()
DateTime	GetValidity ()
virtual DateTime	GetValidity ()
DateTime	GetValidityDemand ()
virtual DateTime	GetValidityDemand ()
DateTime	GetValidityTargets ()
	Gmcs ()
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)
Protected Attributes
FileProducts	_icons = new FileProducts(ContentType.ICO)
string	_mainClass = null
FileProducts	_references = new FileProducts(ContentType.DotNetDll)
FileProducts	_signatureFile = new FileProducts(ContentType.SnKeys)
FileProducts	_sources = new FileProducts(ContentType.CSharpCode)
ContentFile	_target
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]
	Returns: "gmcs"
override ICollection < Type >	ParameterTypes [get]
ActionPriority	Priority [get]
BuildProject	Project [get, set]
BuildProject	Project [get, set]
string	ToolFamily [get]
IDictionary< string, EnvironmentVarInfo >	UsedVars [get]
IDictionary< string, EnvironmentVarInfo >	UsedVars [get]
virtual IDictionary < string, EnvironmentVarInfo >	UsedVars [get]

---

Detailed Description

Wrapper around the gmcs compiler shipped with the Mono.NET framework. This tool will be the default on platforms others than Windows if available. There is another more generic tool using the System.CodeDom.Compiler namespace: wx.Build.Net.NetCodeProvider.

This tool will add __MONO_GMCS__ to the defined symbols for conditional compilation.

---

Constructor & Destructor Documentation

wx.Build.Mono.Gmcs.Gmcs

(

)

This creates an instance without data to be used as IBuildActionClass .

---

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.

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

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 from wx.Build.BaseAction.

override void wx.Build.Mono.Gmcs.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:

	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 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<string>());
            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<string>());
            collectionOfChoicePoints["CppDevelopmentSystem"].Add("GCC");
            collectionOfChoicePoints["CppDevelopmentSystem"].Add("MS VC");

override bool wx.Build.Mono.Gmcs.ContainsPrerequisite

(

IBuildProduct

prereq

)

[virtual]

True iff prereq is among the GetPrerequisites().

Reimplemented from wx.Build.BaseAction.

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

This will create an action from the provided file objects. This will deal with IFileProducts of the

Implements wx.Build.IBuildActionProvider.

bool wx.Build.Mono.Gmcs.Execute	(	BuildToolFamilyEnv	env,
		DateTime	validityOfBuildSystem
	)

This will start the gscs of the newest installed framework.

Implements wx.Build.IBuildAction.

override ICollection<IBuildProduct> wx.Build.Mono.Gmcs.GetPrerequisites

(

)

[virtual]

Collection of the prerequisites of this action.

Implements wx.Build.BaseAction.

override ProcessStartInfo wx.Build.Mono.Gmcs.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.Mono.Gmcs.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.Mono.Gmcs.MayContentFilePrerequisitesSuffice	(	ContentType	target,
		ICollection< ContentType >	prerequisites
	)

This requires a signature key file to produce strong named assemblies.

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.

---

Member Data Documentation

FileProducts wx.Build.Mono.Gmcs._icons = new FileProducts(ContentType.ICO) [protected]

string wx.Build.Mono.Gmcs._mainClass = null [protected]

FileProducts wx.Build.Mono.Gmcs._references = new FileProducts(ContentType.DotNetDll) [protected]

FileProducts wx.Build.Mono.Gmcs._signatureFile = new FileProducts(ContentType.SnKeys) [protected]

FileProducts wx.Build.Mono.Gmcs._sources = new FileProducts(ContentType.CSharpCode) [protected]

ContentFile wx.Build.Mono.Gmcs._target [protected]

---

Property Documentation

IBuildActionProvider wx.Build.Mono.Gmcs.ActionProvider [get]

this is its own action provider.

Implements wx.Build.IBuildAction.

ICollection<OperatingSystem> wx.Build.Mono.Gmcs.ApplicableOSs [get]

Only available on Windows Systems.

Implements wx.Build.IBuildActionProvider.

ICollection<ContentType> wx.Build.Mono.Gmcs.ContentFileTargets [get]

Content files that may be created by an action of this kind. This may be null or empty.

Implements wx.Build.IBuildActionProvider.

string wx.Build.Mono.Gmcs.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.Mono.Gmcs.FileName [get]

The filename of the tool.

bool wx.Build.Mono.Gmcs.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.Mono.Gmcs.Name [get]

Returns:

"gmcs"

Implements wx.Build.IBuildAction.

override ICollection<Type> wx.Build.Mono.Gmcs.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.

ActionPriority wx.Build.Mono.Gmcs.Priority [get]

This is default. On windows, we will prefer the MS .NET framework if present.

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.Mono.Gmcs.ToolFamily [get]

Group is "MONO".

Implements wx.Build.IBuildActionProvider.

IDictionary<string, EnvironmentVarInfo> wx.Build.IBuildAction.UsedVars [get, inherited]

This returns null since useually shell variables are not used by actions. summary> Execute the action and report errors, warnings, and other messages. This will start a build procedure either reusing results of previous builds (rebuild) or making everything from scratch. So, if the desired mode (refer to BuildConfig) is rebuild, this simply does nothing if this action already has been executed with the same prerequisites.

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.

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.
	env	Thsi 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.

Returns:

true on success and false on failure, that should however also be reported to the error handler.

Implemented in wx.Build.AlternativeBuildActions, wx.Build.SequenceOfBuildActions, wx.Build.NamedAction, wx.Build.Cxx.GCC.GccAsCompiler, wx.Build.Cxx.GCC.WindRes, wx.Build.MS.Cl, wx.Build.MS.Link, wx.Build.MS.RC, wx.Build.Release.ReplaceVersionInRCFile, and wx.Build.Release.ReplaceVersionInCSharpFile.

IDictionary<string, EnvironmentVarInfo> wx.Build.IBuildActionProvider.UsedVars [get, inherited]

This returns a description of the used shell variables or a null. The key is the variable name. The value is a remark. So, the following sample provides the declaration of using shell variable path.

            { "path" :
              "This is a list of the directories containing executables that will be found without "
             +"using the absolute path name. This tool will search these directories for ..."

Implemented in wx.Build.Cxx.GCC.GccAsCompiler, wx.Build.Cxx.GCC.WindRes, wx.Build.MS.Cl, wx.Build.MS.Link, and wx.Build.MS.RC.

virtual IDictionary<string, EnvironmentVarInfo> wx.Build.BaseAction.UsedVars [get, inherited]

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

Reimplemented in wx.Build.Cxx.GCC.GccAsCompiler, wx.Build.Cxx.GCC.WindRes, wx.Build.MS.Cl, wx.Build.MS.Link, wx.Build.MS.RC, wx.Build.Release.MakeReleaseProject, wx.Build.Release.ReplaceVersionInRCFile, wx.Build.Release.ReplaceVersionInCSharpFile, and wx.Build.Cxx.wxWidgets.

---