diff -r 7685cec9fd3c -r f2ddfa555b0f doc/api/python/buildtools-module.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/api/python/buildtools-module.html Fri Sep 11 11:54:49 2009 +0100 @@ -0,0 +1,404 @@ + + + + + buildtools + + + + + + + + + + + + + + + + + + + + +
   Trees      Indices      Help   
+ + + + + +
+ + Module buildtools + + + + + + +
[hide private]
[frames] | no frames]
+
+ +

Module buildtools

source code

+

Enables creation of build command list in several formats.

+

This module implements class that represent shell commands. +It supports build stage and command parallelization (depends of the output format). +CommandList can be generated in different format: ant, make, ebs, batch.

+

Example: +from mc.buildtools import CommandList, Convert +list = CommandList() +list.addCommand("epoc32rombuild", "make_fpsx.bat..yy...", "build_xx_rom") +list.addCommand("epoc32rombuild", "make_fpsx.bat..xx...", "build_yy_rom") +list.addCommand("epoc32rombuild", "copy foo bar", "simple copy", False)

+

convert(list, "outputfile.mk", "make") +convert(list, "outputfile.ant.xml", "ant") +convert(list, "outputfile.ebs.xml", "ebs") +convert(list, "outputfile.bat", "bat")



+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Classes[hide private]
+
+   + + PreBuilder
+ This class implements an abstract prebuilder. +
+   + + Task
+ Abstract Task object. +
+   + + Command
+ This class implements a command definition. +
+   + + AntTask
+ Interface that defines supports for an Ant task rendering. +
+   + + Delete
+ Implements file/directory deleletion mechanism. +
+   + + Copy
+ Implement copy command. +
+   + + CommandList
+ This class allows to safely handle Command object into lists +
+   + + AbstractOutputWriter
+ Base class which contains define an AbstractOutputWriter. +
+   + + StringWriter
+ Implements a Writer which is able to directly write to the output stream. +
+   + + EBSWriter
+ Implements EBS XML output format. +
+   + + AntWriter
+ Implements Ant XML output format. +
+   + + MakeWriter
+ Implements Makefile writer. +
+ + + + + + + + + + + + + + + +
+ + + + + +
Functions[hide private]
+
+   + + + + + + +
convert(cmdList, + filename, + outputtype="ant")
+ Helper to directly convert a command list into a specific runnable command format.		 + source code + +
+ +
+   + + + + + + +
get_writer(buildTool, + fileOut)
+ Get a Writer for a specific format.		 + source code + +
+ +
+   + + + + + + +
supported_writers()
+ Return the list of supported Writer.		 + source code + +
+ +
+ + + + + + + + + +
+ + + + + +
Variables[hide private]
+
+   + + __writerConstructors = {'ant': AntWriter, 'make': MakeWriter, ... +
+ + + + + + +
+ + + + + +
Function Details[hide private]
+
+ +
+ +
+ + +
+

convert(cmdList, + filename, + outputtype="ant") +

+ 		source code  +
+ + Helper to directly convert a command list into a specific runnable command format. +e.g: +cmdList = CommandList() +cmdList.addCommand(...) +convert(cmdList, "echo Hello world", "ant") +
+
+
+
+
+ + + + + + +
+ + + + + +
Variables Details[hide private]
+
+ +
+ +
+

__writerConstructors

+ +
+
+
+
Value:
+ 
+{'ant': AntWriter, 'make': MakeWriter, 'ebs': EBSWriter}
+
+
+
+
+
+
+ + + + + + + + + + + + + + + +
   Trees      Indices      Help   
+ + + + + +
+ Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:15 2009 + + http://epydoc.sourceforge.net +
+ + + + +