WebSVN – gelsvn – Diff – /trunk/MPC/README

+.:: 3/13/2002 ::.
 The Makefile, Project and Workspace Creator.
 Designed by Justin Michel (michel_j@ociweb.com) and Chad Elliott.
 Implemented by Chad Elliott (elliott_c@ociweb.com).
 A single tool (MPC) can be used to generate tool specific input (i.e.
     fileN.h
+  }
+}
+MPC expects all files to be listed with forward slashes (/) if a file name
+contains a directory.  Providing files with back slashes (\) can cause
+unexpected results during generation.
 When listing files within components (Source_Files, Header_Files, etc.), you
 can use wild cards (*?[]) to include groups of files as can be done in shells.
 You can exclude files by preceding the name (or wild card) with the '!', but
 this sort of exclusion only pertains to files that exist in the directory at
 the time of project generation.  There is an additional syntax similar to
 Project Keywords
 ----------------
 exename         Specifies the name of the executable that will be created
 sharedname      Specifies the name of the shared library that will be created
 staticname      Specifies the name of the static library that will be created
+buildflags      This keyword can only be used as a source component scoped
+                setting (ie. inside the scope of Source_Files).  It
+                specifies additional build flags that will be passed to the
+                compiler as the source files are being compiled.
 dllout          If defined, specifies where the dynamic libraries will be
                 placed.  This overrides libout in the dynamic case.
 libout          Specifies where the dynamic and static libraries will be placed
 install         Specifies where executables will be installed
 pch_header      Specifies the precompiled header file name
                 this value to access template variables and functions of the
                 template parser. In addition, the following pseudo variables
                 can be used.
                   <%cat%>   - Platform non-specific command to cat a file.
+                  <%cmp%>   - Platform non-specific compare command.
                   <%cp%>    - Platform non-specific copy command.
                   <%mkdir%> - Platform non-specific mkdir command.
                   <%mv%>    - Platform non-specific move command.
+                  <%os%>    - Returns either win32 or unix.
                   <%rm%>    - Platform non-specific delete command.
                   <%nul%>   - Platform non-specific null device.
                   <%gt%>    - Project non-specific greater than sign.
                   <%lt%>    - Project non-specific less than sign.
                   <%and%>   - Project non-specific and sign.
                   <%or%>    - Project non-specific or sign.
                   <%quote%> - Project non-specific double quote.
+prebuild        This is similar to postbuild except that it will be
+                performed before the build instead of after.
 recurse         If set to 1, MPC will recurse into directories listed under
                 component listings and add any component corresponding files
                 to the list.  This keyword can be used as a global project
                 setting or a component scoped setting.
 version         Specifies the version number for the library or executable
                 interpreted as a template value modifier.  In this
                 situation, this construct has the exact same restrictions as
                 the -value_template command line option.  See the USAGE file
                 for more information.
+expand          This scope allows the specification for a variable that is
+                found within $() to be expanded from the list of possible
+                values.  These possible values can contain environment
+                variables (specified by $VAR_NAME) and plain text.  If a
+                possible value contains an environment variable and that
+                variable is defined then this value is used to expand the
+                $() variable.  If the environment variable is not defined
+                then this possible value is not used.  The syntax is as
+                follows:
+                expand(<variable name>) {
+                  <possible value 1>
+                  .
+                  .
+                  <possible value n>
+                }
 conditional     This scope allows addition of source files conditionally
                 based on a particular project type.  The syntax is as
                 follows:
                 conditional(<project type> [, <project type> ...]) {
                             only applies to template_outputext.
 resource_pre_extension      This is the same as pre_extension except that it
                             only applies to resource_outputext.
 documentation_pre_extension This is the same as pre_extension except that it
                             only applies to documentation_outputext.
+generic_pre_extension       This is the same as pre_extension except that it
+                            only applies to generic_outputext.
 pre_filename        This is similar to pre_extension except that the values
                     are prepended to the file name instead of the extension.
 source_pre_filename         This is the same as pre_filename except that it
-                            only applies to source_outputext.
+                            only applies to source files.
 inline_pre_filename         This is the same as pre_filename except that it
-                            only applies to inline_outputext.
+                            only applies to inline files.
 header_pre_filename         This is the same as pre_filename except that it
-                            only applies to header_outputext.
+                            only applies to header files.
 template_pre_filename       This is the same as pre_filename except that it
-                            only applies to template_outputext.
+                            only applies to template files.
 resource_pre_filename       This is the same as pre_filename except that it
-                            only applies to resource_outputext.
+                            only applies to resource files.
 documentation_pre_filename  This is the same as pre_filename except that it
-                            only applies to documentation_outputext.
+                            only applies to documentation files.
+generic_pre_filename        This is the same as pre_filename except that it
+                            only applies to generic files.
 source_outputext    This is a comma separated list of possible source file
                     output extensions.  If the command does not produce
                     source files, then this can be omitted.
 inline_outputext    This is a comma separated list of possible inline file
                     output extensions.  If the command does not produce
                 in the mpc file or a base project.
 fornotlast      Insert the text on every foreach iteration except the last.
 forlast         Insert the text only on the last foreach iteration.
 fornotfirst     Insert the text on every foreach iteration except the first.
 forfirst        Insert the text only on the first foreach iteration.
-forcount        A one based index number of the foreach iterations.
+forcount        By default, a one based index number of the foreach
+                iterations.  The base can be modified by providing a base
+                number in the foreach as in the following examples:
+<%foreach(4, includes)%>
+  ...
+<%endfor%>
+<%foreach(include, 4, includes)%>
+  ...
+<%endfor%>
 Project Variable and Template Input Variable Interaction
 --------------------------------------------------------
 Project variables and template input variables are separate entities and in
 the context of the TemplateParser, template input variables have precedence
 currently only two assignments allowed.
 The first is 'cmdline'.  The values given to the cmdline assignment will be
 processed as command line options, but only to the projects that are
 contained within the workspace (or the scope of the assignment).  The only
-valid command line options for cmdline are -base, -global, -include, -ti,
+valid command line options for cmdline are -base, -genins, -global, -include,
--template, -static, -relative, -notoplevel, -value_template
+-language, -ti, -template, -static, -relative, -notoplevel, -value_template
 and -value_project.
 The second assignment is 'implicit'.  This assignment takes two different
 types of values.  It takes a boolean value (0 or 1) to indicate that an
 implicit project should be created in directories that contain no mpc file,

Subversion Repositories gelsvn

(root)/trunk/MPC/README – Rev 107 → 217