wx.Net.Build: wx.Build.Release.ReplaceVersionInCSharpFile Class Reference

enum wx::Build::Release::ReplaceVersionInCSharpFile::ActionDescr

Bit-Vektor for the specification of those actions that instances of this class may execute.

Enumerator:

None	No action. If this equals a bit vector with AND mask AllActions, you can be sure, that this is a no operation.
ChangeVersionInfo	Occurs if this changes the assembly version or assembly file version.
ChangeDllImport	Occurs, if this changes a DllImportAttribute.
FoundAssemblyTitle	Occurs if an assembly title attribute has been found.
FoundAssemblyDescription	Occurs, if an assembly description attribute has been found.
AllActions	Mask containing all actions.
AllFlags	Mask containing all flags, actions and flags indicating a proven property of the analysed source file.

wx.Build.Release.ReplaceVersionInCSharpFile.ReplaceVersionInCSharpFile ( ReplaceVersionInCSharpFile src )

Copy CTor

Parameters:

src

Source

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.

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

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.

Implemented in wx.Build.AlternativeBuildActions, wx.Build.SequenceOfBuildActions, wx.Build.NamedAction, 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.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.

object wx.Build.Release.ReplaceVersionInCSharpFile.Clone ( )

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

int wx.Build.Release.ReplaceVersionInCSharpFile.CompareTo ( object obj )

bool wx.Build.IBuildAction.ContainsPrerequisite ( IBuildProduct prereq ) [inherited]

True iff prereq is among the GetPrerequisites().

Implemented in wx.Build.AlternativeBuildActions, wx.Build.SequenceOfBuildActions, wx.Build.NamedAction, wx.Build.Net.CSharpCodeProvider, 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.

virtual bool wx.Build.BaseAction.ContainsPrerequisite ( IBuildProduct prereq ) [virtual, inherited]

True iff prereq is among the GetPrerequisites().

Reimplemented in wx.Build.Net.CSharpAssemblyProject, wx.Build.Net.CSharpCodeProvider, 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, and wx.Build.Cxx.wxWidgets.

override bool wx.Build.Release.ReplaceVersionInCSharpFile.Equals ( object obj )

bool wx.Build.Release.ReplaceVersionInCSharpFile.Execute	(	BuildToolFamilyEnv	env,
		DateTime	validityOfBuildSystem
	)

This will do the transformation: Replace references to the DLLs and replace version in AssemblyFileVersion and AssemblyVersion.

Implements wx.Build.IBuildAction.

override int wx.Build.Release.ReplaceVersionInCSharpFile.GetHashCode ( )

override ICollection<IBuildProduct> wx.Build.Release.ReplaceVersionInCSharpFile.GetPrerequisites ( ) [virtual]

This returns the C# source as content file.

Implements wx.Build.BaseAction.

System.Diagnostics.ProcessStartInfo wx.Build.IBuildAction.GetProgramStartInfo ( BuildToolFamilyEnv env ) [inherited]

If this action starts an external program via System.Diagnostics.Process, this will be the start info of the program to start. The result is null if this does not start a program as process. However, even actions that use process info may return null . This information is not mandatory.

Implemented in wx.Build.AlternativeBuildActions, wx.Build.SequenceOfBuildActions, wx.Build.NamedAction, 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.

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.Release.ReplaceVersionInCSharpFile.GetSchema ( )

override ICollection<IBuildProduct> wx.Build.Release.ReplaceVersionInCSharpFile.GetTargets ( ) [virtual]

This returns the C# source as content file.

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.

ActionDescr wx.Build.Release.ReplaceVersionInCSharpFile.ProbableActions ( )

This resutns a specification of the actions that will presumably executed when executing this instance. Return value ActionDescr.None ensures that this is a no operation. This method may for reasons of efficiency in rare cases return actions that will in fact not be executed. However, if this mehtod does not return an action, it will definitely not be executed running this instance.

This will simply search the lines of the source file for version information and filenames of DLLs.

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.Release.ReplaceVersionInCSharpFile.ReadXml ( System.Xml.XmlReader reader )

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.

void wx.Build.Release.ReplaceVersionInCSharpFile.WriteXml ( System.Xml.XmlWriter writer )

IBuildActionProvider wx.Build.Release.ReplaceVersionInCSharpFile.ActionProvider [get]

This does not have a provide. Thus, this is null always.

Implements wx.Build.IBuildAction.

EnvironmentVarInfo wx.Build.Release.ReplaceVersionInCSharpFile.BuildVersionVariable [get]

The variable info for variable BUILD_VERSION.

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.Release.ReplaceVersionInCSharpFile.Name [get]

This is "CSharpFileVersion".

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.Release.ReplaceVersionInCSharpFile.Priority [get]

This property will not be used since this action cannot be replaced by an alternative action. This is always ActionPriority.Default.

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.

override IDictionary<string, EnvironmentVarInfo> wx.Build.Release.ReplaceVersionInCSharpFile.UsedVars [get]

This tool requires variable BUILD_VERSION to be set. Variable BUILD_VERSION must have a System.Version string as value.

Reimplemented from wx.Build.BaseAction.


Public Types
enum	ActionDescr
Public Member Functions
delegate void	AdderSerializable (System.Xml.Serialization.IXmlSerializable arg)
void	AppendBooCode (List< string > booCodeLines, string indention, BuildToolFamilyEnv env)
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 ()
object	Clone ()
void	CollectChoicePoints (IDictionary< string, ICollection< string >> collectionOfChoicePoints)
void	CollectChoicePoints (IDictionary< string, ICollection< string >> collectionOfChoicePoints)
int	CompareTo (object obj)
bool	ContainsPrerequisite (IBuildProduct prereq)
virtual bool	ContainsPrerequisite (IBuildProduct prereq)
override bool	Equals (object obj)
bool	Execute (BuildToolFamilyEnv env, DateTime validityOfBuildSystem)
override int	GetHashCode ()
override ICollection < IBuildProduct >	GetPrerequisites ()
System.Diagnostics.ProcessStartInfo	GetProgramStartInfo (BuildToolFamilyEnv env)
virtual System.Diagnostics.ProcessStartInfo	GetProgramStartInfo (BuildToolFamilyEnv env)
System.Xml.Schema.XmlSchema	GetSchema ()
override ICollection < IBuildProduct >	GetTargets ()
DateTime	GetValidity ()
virtual DateTime	GetValidity ()
DateTime	GetValidityDemand ()
virtual DateTime	GetValidityDemand ()
DateTime	GetValidityTargets ()
ActionDescr	ProbableActions ()
void	ReadXml (System.Xml.XmlReader reader)
	ReplaceVersionInCSharpFile (ReplaceVersionInCSharpFile src)
bool	TargetsAreConsistent (DateTime validityOfBuildSystem)
virtual bool	TargetsAreConsistent (DateTime validityOfBuildSystem)
void	WriteXml (System.Xml.XmlWriter writer)
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]`
EnvironmentVarInfo	BuildVersionVariable `[get]`
FeatureList	Features `[get]`
virtual FeatureList	Features `[get]`
string	Name `[get]`
ICollection< Type >	ParameterTypes `[get]`
virtual ICollection < Type >	ParameterTypes `[get]`
ActionPriority	Priority `[get]`
BuildProject	Project `[get, set]`
BuildProject	Project `[get, set]`
override IDictionary < string, EnvironmentVarInfo >	UsedVars `[get]`

wx.Build.Release.ReplaceVersionInCSharpFile Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation