wx.Build.Release.ReplaceVersionInRCFile Class Reference

Inheritance diagram for wx.Build.Release.ReplaceVersionInRCFile:

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)
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)
bool	Execute (BuildToolFamilyEnv env, DateTime validityOfBuildSystem)
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 ()
void	ReadXml (System.Xml.XmlReader reader)
	ReplaceVersionInRCFile (ReplaceVersionInRCFile 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]

---

Detailed Description

This action receives an RC file ContentType.RCFile and produces one. The file version and project version descriptor will be replaced according to variable BUILD_VERSION.

---

Constructor & Destructor Documentation

wx.Build.Release.ReplaceVersionInRCFile.ReplaceVersionInRCFile

(

ReplaceVersionInRCFile

src

)

---

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.Release.ReplaceVersionInRCFile.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.

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

int wx.Build.Release.ReplaceVersionInRCFile.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.

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

Searches the input file for a version information and stores a copy with replaces version info at the target. This will report an error if either the source does not exist or environment variable BUILD_VERSION is undefined or unknown.

Parameters:

	env	The execution environment shared by all tools of the same family.
	validityOfBuildSystem	The time stamp when the implementation of the build system changed.

Returns:

true on success, false on failure (that will also be reported to the error handler)

Implements wx.Build.IBuildAction.

override ICollection<IBuildProduct> wx.Build.Release.ReplaceVersionInRCFile.GetPrerequisites

(

)

[virtual]

The only prerequisite of actions of this kind as a ContentType.RCFile.

Returns:

Contains an array of exactly one entry.

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.ReplaceVersionInRCFile.GetSchema

(

)

override ICollection<IBuildProduct> wx.Build.Release.ReplaceVersionInRCFile.GetTargets

(

)

[virtual]

The target is a single file of ContentType.RCFile where the release version declared in the source has been replaced.

Returns:

An array contining a single ContentFile of type ContentType.RCFile

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.

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.ReplaceVersionInRCFile.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.ReplaceVersionInRCFile.WriteXml

(

System.Xml.XmlWriter

writer

)

---

Property Documentation

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

This is currently used directly by the MakeReleaseProject without using a factory.

Implements wx.Build.IBuildAction.

EnvironmentVarInfo wx.Build.Release.ReplaceVersionInRCFile.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.ReplaceVersionInRCFile.Name [get]

The name of the action. This is for messages and print outs. Usually, this is the name of the action provider. However, projects do not have a provider but a name as member.

Implementors must make sur that names only contain letters, digits and the dot '.'. This is to ease serialization of build plans as batch files.

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.ReplaceVersionInRCFile.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.

override IDictionary<string, EnvironmentVarInfo> wx.Build.Release.ReplaceVersionInRCFile.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.

---