AMBuild API (2.0) - Revision history

BAILOPAN: BAILOPAN moved page AMBuild API to AMBuild API (2.0)

2015-11-23T07:45:27Z

BAILOPAN moved page AMBuild API to AMBuild API (2.0)

BAILOPAN at 21:16, 8 March 2015

2015-03-08T21:16:00Z

BAILOPAN at 02:57, 16 November 2014

2014-11-16T02:57:38Z

BAILOPAN at 02:56, 16 November 2014

2014-11-16T02:56:46Z

BAILOPAN: /* Methods */

2014-10-02T01:22:33Z

‎Methods

BAILOPAN at 02:27, 1 June 2014

2014-06-01T02:27:08Z

BAILOPAN at 01:58, 1 June 2014

2014-06-01T01:58:39Z

BAILOPAN at 01:51, 1 June 2014

2014-06-01T01:51:50Z

BAILOPAN at 01:47, 1 June 2014

2014-06-01T01:47:29Z

BAILOPAN at 01:35, 1 June 2014

2014-06-01T01:35:02Z

@@ Line 47: / Line 47: @@
 ** ''vars'' - An optional dictionary of global variables to set in each child build script. The dictionary is merged with the global variables passed into our current script. Variables with the same name are overridden by the new dictionary.
 ** Returns <tt>None</tt>.
 * ''Add(taskbuilder)'' - Some jobs are too complex to use a single API call, and instead provide objects to assist in creation. These objects are finalized into the dependency graph with this function. Currently, the only complex jobs built-in are C/C++ compilation jobs.
 ** ''taskbuilder'' - The job builder instance.

@@ Line 78: / Line 78: @@
 * ''AddConfigureFile(path)'' - Adds a source path that will trigger automatic reconfiguring if the file changes. This is useful for files that are conceptually part of a build script, but are not actually loaded as a build script.
 ** ''path'' - A source path.
-* ''Import(path, vars?)'' - Runs another script, similar to RunScript, except that it returns an object with a property corresponding to each global variable in the evaluated script. Initial variables can be supplied through <tt>vars</tt>.
+* ''ImportScript(path, vars?)'' - Runs another script, similar to RunScript, except that it returns an object with a property corresponding to each global variable in the evaluated script. Initial variables can be supplied through <tt>vars</tt>.
 ==Platforms==

@@ Line 78: / Line 78: @@
 * ''AddConfigureFile(path)'' - Adds a source path that will trigger automatic reconfiguring if the file changes. This is useful for files that are conceptually part of a build script, but are not actually loaded as a build script.
 ** ''path'' - A source path.
 ==Platforms==

@@ Line 160: / Line 160: @@
 ** GCC is "like" 'gcc'.
 ** Clang is "like" 'gcc'.
 ** Note that GCC is not "like" Clang.
 =BinaryBuilder=

@@ Line 169: / Line 169: @@
 * ''sources'' - An (initially empty) list of C/C++ source file paths. They can be absolute paths, or paths relative to <tt>currentSourcePath</tt>.
 * ''localFolder'' - The name of the folder this binary will be generated in, relative to the <tt>buildFolder</tt> of the context that adds the tasks.
 ==Methods==

← Older revision	Revision as of 07:45, 23 November 2015
(No difference)

@@ Line 49: / Line 49: @@
 * ''Add(taskbuilder)'' - Some jobs are too complex to use a single API call, and instead provide objects to assist in creation. These objects are finalized into the dependency graph with this function. Currently, the only complex jobs built-in are C/C++ compilation jobs.
 ** ''taskbuilder'' - The job builder instance.
-** Returns a value based on the taskbuilder. For example, C++ objects return a 'CppNode' described under the Compiler section.
+** Returns a value based on the taskbuilder. For example, BinaryBuilders return a 'CppNode' described under the Compiler section, and ProjectBuilders return a list of CppNodes.
 * ''AddFolder(folder)'' - Ensures that a folder is created when performing a build. The folder is created relative to the context's local build folder.
 ** ''folder'' - A relative path specifying the folder. Folder chains can be created all at once; i.e. 'a/b/c' is a valid target even if 'a' or 'a/b' do not exist.
@@ Line 175: / Line 175: @@
 =ProjectBuilder=
 <tt>ProjectBuilder</tt> assists in creating multiple configurations of a C++ compilation task. Set the source list via <tt>sources</tt>, then use <tt>Configure()</tt> to add a new configuration. After all configurations have been added, use <tt>builder.Add()</tt> to add the project to the dependency graph.
 ==Attributes==

@@ Line 152: / Line 152: @@
 * <tt>Library(name)</tt> - Creates a new <tt>BinaryBuilder</tt> instance, with a copy of the compiler settings. The builder is configured to generate a shared library. <tt>.so</tt>, <tt>.dylib</tt>, or <tt>.dll</tt> is automatically appended depending on the platform. Nothing is ever prepended to the name.
 * <tt>StaticLibrary(name)</tt> - Creates a new <tt>BinaryBuilder</tt> instance, with a copy of the compiler settings. The builder is configured to generate a static library. <tt>.a</tt> or <tt>.lib</tt> is automatically appended depending on the platform. Nothing is ever prepended to the name.
-* <tt>ProgramBuilder(name)</tt> - Creates a new <tt>Builder</tt> instance, with a copy of the compiler settings. The builder is configured to generate an executable (<tt>.exe</tt> is automatically appended on Windows).
+* <tt>ProgramProject(name)</tt> - Creates a new <tt>ProjectBuilder</tt> instance, with a copy of the compiler settings. The builder is configured to generate an executable (<tt>.exe</tt> is automatically appended on Windows).
-* <tt>LibraryBuilder(name)</tt> - Creates a new <tt>Builder</tt> instance, with a copy of the compiler settings. The builder is configured to generate a shared library. <tt>.so</tt>, <tt>.dylib</tt>, or <tt>.dll</tt> is automatically appended depending on the platform. Nothing is ever prepended to the name.
+* <tt>LibraryProject(name)</tt> - Creates a new <tt>ProjectBuilder</tt> instance, with a copy of the compiler settings. The builder is configured to generate a shared library. <tt>.so</tt>, <tt>.dylib</tt>, or <tt>.dll</tt> is automatically appended depending on the platform. Nothing is ever prepended to the name.
-* <tt>StaticLibraryBuilder(name)</tt> - Creates a new <tt>Builder</tt> instance, with a copy of the compiler settings. The builder is configured to generate a static library. <tt>.a</tt> or <tt>.lib</tt> is automatically appended depending on the platform. Nothing is ever prepended to the name.
+* <tt>StaticLibraryProject(name)</tt> - Creates a new <tt>ProjectBuilder</tt> instance, with a copy of the compiler settings. The builder is configured to generate a static library. <tt>.a</tt> or <tt>.lib</tt> is automatically appended depending on the platform. Nothing is ever prepended to the name.
 * <tt>Dep(text, node)</tt> - Creates a <tt>Dep</tt> object instance (see above for more details).
 * <tt>like(name)</tt> - Returns whether the compiler is "like" another compiler. This is intended to represent the compatibility hierarchy of modern compilers. For example:

@@ Line 3: / Line 3: @@
 * '''Entry''': Represents a node in the dependency graph.
 * '''Compiler''': An abstraction representing a C++ compiler environment.
-* '''Builder''' and '''BinaryBuilder''': Abstractions for building C++ compilation jobs.
+* '''ProjectBuilder''' and '''BinaryBuilder''': Abstractions for building C++ compilation jobs.
 As a general rule, AMBuild uses the following conventions:
@@ Line 145: / Line 145: @@
 ==Methods==
-There are two APIs for creating C++ binaries - <tt>Builder</tt> and <tt>BinaryBuilder</tt>. <tt>Builder</tt> makes it possible to group related tasks together. For example, if one binary has multiple build configurations, a <tt>Builder</tt> will allow you to group them together with a common set of source files. For building, the results are exactly the same as creating individual <tt>BinaryBuilder</tt>s.
+There are two APIs for creating C++ binaries - <tt>ProjectBuilder</tt> and <tt>BinaryBuilder</tt>. <tt>ProjectBuilder</tt> makes it possible to group related tasks together. For example, if one binary has multiple build configurations, a <tt>Builder</tt> will allow you to group them together with a common set of source files. For building, the results are exactly the same as creating individual <tt>BinaryBuilder</tt>s.
-For generating IDE project files, the distinction can be important. When the same binary is built across multiple configurations, AMBuild generates a new project file for each configuration. Using <tt>Builder</tt> over <tt>BinaryBuilder</tt> allows AMBuild to store each of the configurations in a single project file.
+For generating IDE project files, the distinction can be important. When the same binary is built across multiple configurations, AMBuild generates a new project file for each configuration. Using <tt>ProjectBuilder</tt> over <tt>BinaryBuilder</tt> allows AMBuild to store each of the configurations in a single project file.
 * <tt>Program(name)</tt> - Creates a new <tt>BinaryBuilder</tt> instance, with a copy of the compiler settings. The builder is configured to generate an executable (<tt>.exe</tt> is automatically appended on Windows).
@@ Line 171: / Line 171: @@
 ==Methods==
 * ''Dep(text, node)'' - A wrapper for <tt>compiler.Dep</tt>.