| blob | 74d223a6f3c306decc5ab0da0b9072afca150e64 |
3 <html>
4 <head>
13 </head>
16 <div>
18 </div>
20 <div>
23 <div>
25 <hr>
28 Maintaining multiple build tool files for a
29 multi-platform project can be quite a challenge, especially when the
30 project structure and platforms are constantly changing and evolving.
31 A project may support Makefiles, Visual C++ project files, Borland
32 Makefiles, and many others. Adding files, deleting files, changing
33 project options or even changing the name of the target within your
34 project will require you to expend time updating each build tool
35 file. What you need instead is a single location to store project
36 specific information to avoid repetitious, tedious modifications to
37 multiple build tool files. This is where Makefile Project Creator
38 (MPC) comes into the picture.
39 </p>
42 MPC can be used to generate build tool specific
43 project files from a generic mpc file. The MPC project file is a
44 collection of source files that make up a single build target. MPC
45 uses platform specific input along with mpc files and generates build
46 tool specific files like makefiles, Visual C++ workspace and project
47 files, Visual Studio solution and project files, etc.
48 </p>
51 MPC provides many advantages over the build tool
52 files it replaces. It provides mechanisms for minimizing maintenance
53 of project build files. It does this through support for project
54 inheritance and defaults for all aspects of a project, and the syntax
55 is simple and easy to use and maintain. These and other features will
56 be discussed in detail in the following sections. The structure and
57 syntax of the MPC files are described in the
59 In addition, a complete example of the use of MPC is shown in the <a href=
61 Example MPC
62 File
63 </a> section.
64 </p>
65 </div>
67 <div>
69 <hr>
72 An MPC project is a set of parameters that describe
73 an individual build target (such as a library or executable). These
74 parameters include the target name, include paths, source files,
75 header files, etc. One or more projects can be defined within a
76 single mpc file. An MPC workspace is just an arbitrary collection of
77 projects.
78 </p>
81 Projects can be generated (without workspaces) by
82 using the mpc.pl script. Multiple mpc files can be passed to this
83 script. If no mpc files are passed to the script, it will search for
84 project-related files (such as source files, header files, etc.) and
85 incorporate them into a default project.
86 </p>
90 high-level view of project file generation using mpc.pl.
91 </p>
97 <tr>
101 <div>
104 </div>
105 </td>
106 </tr>
107 </table>
108 </p>
111 To generate workspaces, you must run <em class=
113 and create a workspace based on those mpc files. If no mwc files are
114 passed to the script, it will search in the current directory and its
115 subdirectories for all mpc files and incorporate them into a single
116 workspace.
117 </p>
120 For make based project types (make, gnuace, bmake,
121 nmake), a workspace is just a top-level makefile. But, for graphical
122 interfaces such as Visual Studio, a workspace is the top-level file
123 that groups all of the project files together.
124 </p>
127 The following diagram shows a high-level view of
128 workspace file generation using mwc.pl.
129 </p>
135 <tr>
139 <div>
142 </div>
143 </td>
144 </tr>
145 </table>
146 </p>
150 <div>
155 MPC generates workspaces and projects for use with
156 many build tools. This table lists the MPC types (used with
158 associated build tools.
159 </p>
166 <tr>
169 </th>
173 </th>
174 </tr>
176 <tr>
180 </p>
181 </td>
185 </td>
186 </tr>
188 <tr>
192 </p>
193 </td>
197 </td>
198 </tr>
200 <tr>
204 </p>
205 </td>
209 </td>
210 </tr>
212 <tr>
216 </p>
217 </td>
221 Support for Borland Developer Studio 4
222 is incomplete.
223 </p>
224 </td>
225 </tr>
227 <tr>
231 </p>
232 </td>
236 </td>
237 </tr>
239 <tr>
243 </p>
244 </td>
248 </td>
249 </tr>
251 <tr>
256 </em>
257 </p>
258 </td>
263 </p>
264 </td>
265 </tr>
267 <tr>
272 <!--CDT6.html describes cdt7 as well
273 -->cdt7
274 </a>
275 </em>
276 </p>
277 </td>
282 </p>
283 </td>
284 </tr>
286 <tr>
290 </p>
291 </td>
295 </td>
296 </tr>
298 <tr>
302 </p>
303 </td>
307 </td>
308 </tr>
310 <tr>
314 </p>
315 </td>
319 </td>
320 </tr>
322 <tr>
326 </p>
327 </td>
331 GNU Make for ACE/TAO/CIAO only
332 (ACE/TAO/CIAO extension).
333 </p>
334 </td>
335 </tr>
337 <tr>
341 </p>
342 </td>
346 html pages are generated for
347 visualization of project information.
348 </p>
349 </td>
350 </tr>
352 <tr>
356 </p>
357 </td>
361 Generic make. The makefiles generated
362 by this project type can be used with any version of make.
363 However, due to configuration issues, it should not be used
364 with ACE or TAO.
365 </p>
366 </td>
367 </tr>
369 <tr>
373 </p>
374 </td>
378 </td>
379 </tr>
381 <tr>
386 </em>
387 </p>
388 </td>
392 </td>
393 </tr>
395 <tr>
399 </p>
400 </td>
404 Support for Visual SlickEdit is
405 incomplete.
406 </p>
407 </td>
408 </tr>
410 <tr>
414 </p>
415 </td>
419 </td>
420 </tr>
422 <tr>
426 </p>
427 </td>
431 </td>
432 </tr>
434 <tr>
438 </p>
439 </td>
443 </td>
444 </tr>
446 <tr>
450 </p>
451 </td>
455 </td>
456 </tr>
458 <tr>
462 </p>
463 </td>
467 </td>
468 </tr>
470 <tr>
474 </p>
475 </td>
479 </td>
480 </tr>
482 <tr>
486 </p>
487 </td>
491 </td>
492 </tr>
494 <tr>
498 </p>
499 </td>
503 </td>
504 </tr>
506 <tr>
510 </p>
511 </td>
515 </td>
516 </tr>
518 <tr>
522 </p>
523 </td>
527 </td>
528 </tr>
530 <tr>
534 </p>
535 </td>
539 </td>
540 </tr>
542 <tr>
546 </p>
547 </td>
551 </td>
552 </tr>
554 <tr>
559 wb26
560 </a>
561 </em>
562 </p>
563 </td>
567 </td>
568 </tr>
570 <tr>
575 wb30
576 </a>
577 </em>
578 </p>
579 </td>
583 </td>
584 </tr>
586 <tr>
590 </p>
591 </td>
595 </td>
596 </tr>
597 </table>
598 </p>
601 </div>
603 <div>
607 The command line options for the workspace
610 creator is used to generate one or more separate projects by
611 passing mpc files to it on the command line. The workspace creator
612 is used to generate one or more workspaces and the projects related
613 to those workspaces.
614 </p>
617 The table below describes each option with the
618 more commonly used options in bold and project specific options in
619 italics.
620 </p>
624 <a name=
626 </h6>
627 </p>
630 <tr>
633 </th>
637 </th>
638 </tr>
640 <tr>
644 </p>
645 </td>
649 This option allows the user to force
651 option can be used multiple times to force multiple
652 inheritance upon a project.
653 </p>
654 </td>
655 </tr>
657 <tr>
660 <em class=
662 </p>
663 </td>
667 This hidden option can be used to
669 that allows a user of the tcsh shell to complete on options
670 as well as file names.
671 </p>
672 </td>
673 </tr>
675 <tr>
679 </p>
680 </td>
684 If this option is used with <em class=
686 in a comma separated list will be excluded when searching
687 for mpc files. Each element provided for exclusion should
688 be relative to the starting directory. This option has no
690 </p>
691 </td>
692 </tr>
694 <tr>
697 <em class=
699 </p>
700 </td>
704 This option instructs MPC to perform
705 direct replacement of $() variables with the values from
707 option is used) or the values specified by the <em class=
709 </p>
710 </td>
711 </tr>
713 <tr>
716 <em class=
718 </p>
719 </td>
723 This option allows the user to override
727 ) which may or may not exist. This file can be used to
728 override feature values specified in the <em class=
733 </p>
734 </td>
735 </tr>
737 <tr>
740 <em class=
742 </p>
743 </td>
747 Specifies the feature list to set
748 before processing. This is a comma separated list and
749 should contain no spaces. The -features option can be
750 used multiple times on the same command line, the
751 effect is the same as if the parameters had been
752 specified with a single -features options, with the
753 parameters joined by commas.
754 </p>
755 </td>
756 </tr>
758 <tr>
761 <em class=
763 </p>
764 </td>
768 Allows generated makefiles to be used
769 with Eclipse.
770 </p>
771 </td>
772 </tr>
774 <tr>
778 </p>
779 </td>
783 A .dot file, for use with Graphviz,
784 will be created for each workspace processed.
785 </p>
786 </td>
787 </tr>
789 <tr>
793 </p>
794 </td>
798 This option instructs MPC to generate
801 the prj_install.pl script which will copy portions of the
802 project related files into a user specified location.
803 </p>
804 </td>
805 </tr>
807 <tr>
810 <em class=
812 </p>
813 </td>
817 Specifies the global feature file. The
818 default global feature file is <em class=
821 </p>
822 </td>
823 </tr>
825 <tr>
829 </p>
830 </td>
834 This option specifies the global input
836 all generated projects. The default value is <em class=
838 ACE_wrappers/bin/MakeProjectCreator/global.mpb or
839 MPC/config/global.mpb
840 </em>.
841 </p>
842 </td>
843 </tr>
845 <tr>
848 <em class=
850 </p>
851 </td>
855 If this option is used with <em class=
857 directory between the directory in which it is run and the
858 location of a processed mpc file. This option has no effect
861 </p>
862 </td>
863 </tr>
865 <tr>
869 <em class=
871 </em>
872 </p>
873 </td>
877 Include search directories are added
878 with this option. These search directories are used when
879 locating base projects, template input files and templates.
880 It can be used multiple times on the same command line.
881 </p>
882 </td>
883 </tr>
885 <tr>
889 </p>
890 </td>
894 This option specifies that all
895 generated project files will be placed in a mirrored
896 directory structure. If any project within the
897 workspace is referenced via a full path, use of this
898 option is likely to cause problems.
899 </p>
900 </td>
901 </tr>
903 <tr>
906 <em class=
908 </p>
909 </td>
913 This option is used to specify which
914 language to assume when generating projects. The default
918 </p>
919 </td>
920 </tr>
922 <tr>
925 <em class=
927 </p>
928 </td>
932 Make based project types that normally
935 ) will name the generated output files such that they can
936 coexist within the same directory. In essence, the
939 but the name of the workspace followed by the project type
942 </p>
943 </td>
944 </tr>
946 <tr>
949 <em class=
951 </p>
952 </td>
956 This option allows the user to modify
957 the output names of projects and workspaces. These are
958 usually determined by either the mpc or mwc file, but can
959 be modified using a pattern replacement. The parameter
960 passed to this option will be used as the pattern and any
961 asterisks (*) found in the pattern will be replaced with
962 the project or workspace name depending on which type of
963 file is being created.
964 </p>
965 </td>
966 </tr>
968 <tr>
971 <em class=
973 </p>
974 </td>
978 This option is only useful with the
981 pattern will be applied to the project name in addition to
982 the project or workspace name.
983 </p>
984 </td>
985 </tr>
987 <tr>
990 <em class=
992 </p>
993 </td>
997 Comments will not be placed in the
998 generated workspace files.
999 </p>
1000 </td>
1001 </tr>
1003 <tr>
1006 <em class=
1008 </p>
1009 </td>
1013 This option specifies that the default
1014 relative definitions should not be generated. See the
1016 </p>
1017 </td>
1018 </tr>
1020 <tr>
1023 <em class=
1025 </p>
1026 </td>
1030 This option tells <em class=
1032 project files, but do not generate the associated
1033 workspace. This option tells <em class=
1035 but it will not generate any project files.
1036 </p>
1037 </td>
1038 </tr>
1040 <tr>
1044 </p>
1045 </td>
1049 Search from the current directory for
1050 any input files and process them from the directory in
1051 which they are located.
1052 </p>
1053 </td>
1054 </tr>
1056 <tr>
1060 <em class=
1062 </em>
1063 </p>
1064 </td>
1068 Relative paths are used to replace
1070 default, any environment variable that ends in <em class=
1072 relative path replacement. For more information see
1075 </p>
1076 </td>
1077 </tr>
1079 <tr>
1082 <em class=
1084 </p>
1085 </td>
1089 This option allows you to override the
1090 default relative definitions file, which is default.rel
1091 under the MPC config directory.
1092 </p>
1093 </td>
1094 </tr>
1096 <tr>
1100 </p>
1101 </td>
1105 Specifies that static project files
1106 will be generated from the MPC projects. The default is to
1107 generate dynamic project files.
1108 </p>
1109 </td>
1110 </tr>
1112 <tr>
1115 <em class=
1117 </p>
1118 </td>
1122 This option allows a user to specify an
1123 alternate template. Each project type has its own template
1124 and this option allows a user to override the default
1125 template.
1126 </p>
1127 </td>
1128 </tr>
1130 <tr>
1134 </p>
1135 </td>
1139 Each project type has a set of template
1140 input files. With this option the default template input
1141 file can be overridden for a particular project type. For
1142 more information see <a href=
1143 "MakeProjectCreator.html#Additional-ti_information"
1145 </p>
1146 </td>
1147 </tr>
1149 <tr>
1153 <em class=
1155 </em>
1156 </p>
1157 </td>
1161 This option specifies the type of
1162 project or workspace to be generated. It can be specified
1163 multiple times to generate different project types for a
1164 single set of input files.
1165 </p>
1166 </td>
1167 </tr>
1169 <tr>
1173 </p>
1174 </td>
1178 This option instructs MPC to replace
1180 corresponding environment variable value instead of using
1181 values provided by the -relative option.
1182 </p>
1183 </td>
1184 </tr>
1186 <tr>
1189 <em class=
1191 </p>
1192 </td>
1196 Use this option to override an mpc
1197 project assignment from the command line. This can be used
1198 to introduce new name value pairs to a project. However, it
1199 must be a valid project assignment. For more information
1200 see <a href=
1201 "MakeProjectCreator.html#Additional-value_project_information"
1203 </p>
1204 </td>
1205 </tr>
1207 <tr>
1210 <em class=
1212 </p>
1213 </td>
1217 This option can be used to override
1218 existing template input variable values from the command
1219 line. It can not be used to introduce new template input
1220 name value pairs. For more information see <a href=
1221 "MakeProjectCreator.html#Additional-value_template_information"
1223 </p>
1224 </td>
1225 </tr>
1227 <tr>
1231 </p>
1232 </td>
1236 Specifies number of child processes to
1237 use to generate projects. For more information see <a href=
1238 "MakeProjectCreator.html#Additional-workers_information"
1240 </p>
1241 </td>
1242 </tr>
1244 <tr>
1248 </p>
1249 </td>
1253 The directory for storing temporary
1254 output files from the child processes. The default is
1255 '/tmp/mpc' on Unix systems and %TEMP% on Windows. If
1256 neither -workers_dir nor -workers_port is used,
1257 -workers_dir is assumed. For more information see <a href=
1258 "MakeProjectCreator.html#Additional-workers_dir_information"
1260 </p>
1261 </td>
1262 </tr>
1264 <tr>
1268 </p>
1269 </td>
1273 The port number for the parent listener.
1274 If neither -workers_dir nor -workers_port is used,
1275 -workers_dir is assumed. For more information see <a href=
1276 "MakeProjectCreator.html#Additional-workers_port_information"
1278 </p>
1279 </td>
1280 </tr>
1282 <tr>
1286 </p>
1287 </td>
1291 The MPC version is printed and no files
1292 are processed.
1293 </p>
1294 </td>
1295 </tr>
1296 </table>
1297 </p>
1300 <div>
1305 Some of the options in <a href=
1306 "MakeProjectCreator.html#Command%20Line%20Options" class=
1308 You will find more information on the <em class=
1315 </p>
1318 <div>
1320 <a name=
1322 </h6>
1326 Some project types do not (completely)
1327 support the idea of accessing environment variables through the
1329 that generated projects are usable in these cases. In order to
1331 within the generated project files, relative paths are put in
1332 place of those (where possible).
1333 </p>
1337 takes a single parameter of a name value pair, for
1338 example:
1339 </p>
1341 <blockquote>
1345 mwc.pl -relative
1346 PROJ_TOP=/usr/projects/top
1347 </p>
1350 </blockquote>
1353 In above example, if the text <em class=
1355 mpc, mpd, or mpt variable then it is replaced by a path that is
1357 example, if an mpc file located under <em class=
1359 </p>
1361 <blockquote>
1372 </blockquote>
1375 The generated project file would contain text
1376 similar to:
1377 </p>
1379 <blockquote>
1381 </blockquote>
1385 was replaced with a directory value that is relative to the
1386 directory in which the mpc file is located.</li>
1388 </div>
1390 <div>
1398 allows you to identify different template input files based on
1399 the type of target being built. Template input files correspond
1403 distinguish between the different categories, but the templates
1404 for various project types will be combined with different
1405 template input files, depending on the build target type, to
1406 generate different output.
1407 </p>
1410 To override the default template input file
1416 located somewhere in the include search paths.
1417 </p>
1420 The following example shows a usage of the -ti
1421 option. It says that when generating a static project (lib),
1423 when generating a dynamic project (dll), use the <em class=
1425 </p>
1427 <blockquote>
1429 mpc.pl -type vc71 -ti lib:vc7dsplib -ti
1430 dll:vc7dspdll
1431 </p>
1433 </blockquote>
1436 These happen to be the default values for the
1438 different template input can be specified for each
1439 category.
1440 </p>
1442 </div>
1444 <div>
1451 option can be useful when the need arises to modify the value
1452 of an MPC variable across one or more mpc files. For example,
1453 if you wanted to generate all of your projects with an
1454 additional include search path you would run the following
1455 command:
1456 </p>
1458 <blockquote>
1461 mwc.pl -value_project
1462 includes+=/include/path
1463 </p>
1465 </blockquote>
1468 In the above example, an additional include
1470 placed in all generated projects.
1471 </p>
1473 </div>
1475 <div>
1481 This option modifies existing or adds
1482 new template input name/value pairs. For example, if you wanted
1485 following command:
1486 </p>
1488 <blockquote>
1491 mwc.pl -type vc71 -value_template
1492 configurations=Release
1493 </p>
1495 </blockquote>
1498 To find out what template input variables are
1499 defined, see the individual mpd file of interest (<em class=
1506 Template Variable
1507 Documentation
1508 </a> section. Names that are not listed as project
1511 </p>
1513 </div>
1515 <div>
1521 This option specifies the number of
1522 child process to use to generate projects. Using multiple
1523 workers can decrease project generation time significantly
1524 on multiprocessor systems. For example, if you wanted to
1525 distribute projects among four worker processes, you
1526 would run the following command:
1527 </p>
1529 <blockquote>
1533 </blockquote>
1536 In multi-process MPC, each child has
1537 to pass intermediate project info back to the parent. This
1538 is done using temporary files or using a socket. The temp
1539 file implementation, <a href=
1540 "MakeProjectCreator.html#Additional-workers_dir_information"
1542 forks a new child for each project and ensures there are
1543 never more children running than requested. The socket
1544 listener implementation, <a href=
1545 "MakeProjectCreator.html#Additional-workers_port_information"
1547 pre-forks N children and distributes jobs to them.
1548 </p>
1550 </div>
1552 <div>
1559 This option specifies the directory for
1560 storing temporary output files from the child processes.
1561 The default is '/tmp/mpc' on Unix-like systems and %TEMP%
1565 example, if you wanted to use 4 workers and '/tmp/mydir' for
1566 temporary filess, you would run the following command:
1567 </p>
1569 <blockquote>
1575 </blockquote>
1577 </div>
1579 <div>
1586 This option specifies the port number
1587 where the parent listens for project information from the
1588 children. If you wanted to receive information from 2 workers
1589 on port 9876, you would run the following command:
1590 </p>
1592 <blockquote>
1597 </blockquote>
1600 </div>
1601 </div>
1602 </div>
1604 <div>
1613 This configuration file can be used to
1614 specify alternate locations for the MPC Configuration File
1617 root directory, it will be read to determine the location of
1618 MPC.cfg based on the directory in which MPC was started.
1619 </p>
1625 For a base.cfg file containing the following:
1626 </p>
1628 <blockquote>
1632 </blockquote>
1635 Meaning that when $MPC_ROOT/mwc.pl is run in a directory below <em class="Code">/foo/bar_root</em>, it will
1636 search for <em class="Code">MPC.cfg</em> in the directory <em class="Code">/foo/bar_root/MPC/config</em>.
1637 </p>
1639 For example, if <em class=
1646 </em> as the MPC
1647 Configuration File. If the base configuration file is not present,
1649 as the MPC Configuration File.
1650 </p>
1653 You may reference environment variables, accessed
1655 side of the equals sign. In either this file or the MPC
1656 Configuration File (see below), an alternate form of environment
1657 variable reference may be used for variables which are not expected
1658 to be defined in all scenarios. These variables use the syntax
1660 With this syntax, if the environment variable
1662 printed by MPC, and the substring starting with
1664 to the empty string.
1665 </p>
1674 In an effort to move away from the use of
1675 environment variables, a configuration file has been introduced.
1677 settings to provide command line options, control logging and
1678 direct MPC to dynamic project types.
1679 </p>
1682 The following keywords are allowed in the
1683 configuration file.
1684 </p>
1688 <tr>
1691 </th>
1695 </th>
1696 </tr>
1698 <tr>
1701 <em class=
1703 </p>
1704 </td>
1708 Provide additional command line options
1709 to MPC. The value of this setting will be prepended to the
1712 </p>
1713 </td>
1714 </tr>
1716 <tr>
1719 <em class=
1721 </p>
1722 </td>
1726 Provide a single project type (as
1728 default project type.
1729 </p>
1730 </td>
1731 </tr>
1733 <tr>
1736 <em class=
1738 </p>
1739 </td>
1743 This comma separated list points to
1744 directories in which MPC will search for Perl modules to
1745 implement additional MPC project types, base projects or
1746 template files. This setting can be used to augment or
1747 replace functionality in MPC. For each suitable directory
1749 path for Perl to find modules, add a <em class=
1752 templates.
1753 </p>
1754 </td>
1755 </tr>
1757 <tr>
1761 </p>
1762 </td>
1766 Similar to the <em class=
1768 of comma separated paths to the MPC include search
1769 paths.
1770 </p>
1771 </td>
1772 </tr>
1774 <tr>
1778 </p>
1779 </td>
1783 If this setting contains <em class=
1786 messages will be printed. If it contains <em class=
1789 will be printed. And lastly, if it contains <em class=
1791 it contains none of these, MPC will not print out any
1792 information or warnings when processing projects or
1793 workspaces. Errors are always printed if any are
1795 warn=1,
1797 </em>.
1798 </p>
1799 </td>
1800 </tr>
1802 <tr>
1805 <em class=
1807 </p>
1808 </td>
1812 Provide additional main functions to be
1813 recognized in conjunction with automatic executable project
1814 recognition. The value assigned should be of the form
1818 </em>. A function can
1819 be specified for all languages by only providing the
1820 function name.
1821 </p>
1822 </td>
1823 </tr>
1825 <tr>
1828 <em class=
1830 </p>
1831 </td>
1835 If this is set, mwc.pl will warn the
1836 user about references to projects in the <em class=
1838 </p>
1839 </td>
1840 </tr>
1841 </table>
1842 </p>
1844 </div>
1846 <div>
1851 MPC recognizes a few environment variables
1852 that alter the way it performs certain tasks. The sections below
1853 describe each one and the effect it has on MPC.
1854 </p>
1857 The <em class=
1859 variable only affects the way workspace dependencies are created
1866 variable is set, MPC will generate inter-project dependencies for
1867 libraries within a single workspace. This is usually not desired
1868 since adding these dependencies in a static workspace has the side
1869 effect of including dependent libraries into the dependent
1870 library.
1871 </p>
1875 variable is only meaningful when generating the ghs project files.
1876 By default, the ghs type assumes that it is for Windows. Set this
1877 environment variable prior to running MPC if this is not the
1878 case.
1879 </p>
1883 environment variable causes the Windows related pseudo template
1884 variables to be used regardless of the type of project being
1885 generated.
1886 </p>
1888 </div>
1889 </div>
1891 <div>
1894 <hr>
1898 You may want to familiarize yourself with the
1899 various input files for MPC. The input file types and the syntax of
1900 each are discussed in the sections below.
1901 </p>
1904 <div>
1908 There are four different input files
1909 associated with MPC. For most users of MPC, the main files of
1910 concern are mpc and mwc files.
1911 </p>
1914 <div>
1918 Project files, those with the <em class=
1920 library paths, source files and inter-project dependencies. An
1922 which needs to be uniquely named to avoid project generation
1923 errors. Projects represent build targets such as libraries and
1924 executables.
1925 </p>
1927 </div>
1929 <div>
1934 Workspaces are defined by providing a list
1935 of mpc files, directories or other mwc files in a single mwc
1936 file. For each mpc file, the Workspace Creator calls upon the
1937 Project Creator to generate the project. After all of the
1938 projects are successfully generated, the tool-specific workspace
1939 is generated containing the projects and any defined
1940 inter-project dependency information (if supported by the build
1941 tool). An mwc file can contain one or more
1943 named. If no workspace files are provided to the workspace
1944 creator, the current directory is traversed and any mpc files
1945 located will be part of the workspace that is generated.
1946 </p>
1948 </div>
1950 <div>
1956 One of the many unique and useful features
1957 of MPC is that the project definition files can use inheritance.
1958 Project inheritance allows a user to set up a base project (mpb
1959 file) that can contain information that is applicable to all
1960 derived projects. Common project attributes, such as include
1961 paths, library paths, and inter-project dependencies, could be
1962 described in this base project and any project that inherits from
1963 it would contain this information as well.
1964 </p>
1966 </div>
1968 <div>
1973 As with projects, workspaces can also
1974 inherit from other workspaces. A base workspace can provide
1975 workspace information that may be common to other
1976 workspaces.
1977 </p>
1979 </div>
1980 </div>
1982 <div>
1987 In this section we discuss the syntax of the
1988 various files. We also describe some of the default values that go
1989 along with these files.
1990 </p>
1993 <div>
1998 Workspaces can contain individual mpc
1999 files or directories. There can be one or more workspaces defined
2000 within a single mwc file.
2001 </p>
2003 <blockquote>
2007 workspace(optional name):
2008 optional_base_workspace {
2009 </p>
2020 exclude(vc6, vc7, vc71, vc8, vc9,
2021 vc10, vc11, vc12, vc14, vs2017, vs2019, vs2022, nmake) {
2022 </p>
2047 </blockquote>
2050 A workspace can be given a name. This is
2051 the value given in the parentheses after the keyword <em class=
2053 workspace name is taken from the name of the mwc file without the
2054 extension.
2055 </p>
2058 Workspaces can also inherit from other
2059 workspaces. In the above example, <em class=
2061 mwb file with no extension that contains workspace information.
2062 This information would then be included in each workspace that
2063 inherits from it.
2064 </p>
2067 The lines between the curly braces
2068 contain assignments, mpc files, directories, other
2069 workspace files or exclusion sections. For each listed item,
2070 <ul>
2073 <li>
2074 a directory recursively traversed and any mpc files
2075 found will be included,
2076 </li>
2077 <li>
2079 </li>
2080 </ul>
2083 A workspace can have assignments interspersed
2084 within the directories and mpc files. These assignments modify
2085 the way projects are generated.
2086 </p>
2090 used to provide command line options that would normally be
2092 "MakeProjectCreator.html#Command%20Line%20Options" class=
2099 are ignored. Environment variables may be accessed through
2102 assignment may be useful for workspaces that require specific
2104 correctly.
2105 </p>
2108 The only other setting supported by mwc.pl is
2111 generated in each directory where no mpc file exists. The
2113 name of a base project. In this case, the implicitly generated
2114 project will inherit from the base project specified in the
2115 assignment. Either way, if the directory does not contain files
2116 that can be used within a project, no project is created. Setting
2118 define specific workspaces, but the MPC defaults are sufficient
2119 for the directories involved within the workspace.
2120 </p>
2125 conceptually and syntactically similar to <a
2127 the project <em
2129 </a> Any variables
2130 assigned within the clause are only available to
2131 workspaces, not to projects. Two sorts of assignments are
2132 possible: first are assignments to the keywords
2134 and the second are type-specific variables. Consult the
2135 documentation for the type for details on type-specific variables.
2136 Keyword assignments impact the entire workspace, not just the
2138 </p>
2141 Scoped assignments are assignments that are
2142 associated with specific mpc files or directories listed with the
2143 scope of the assignment. The following example shows a scoped
2146 one of the mpc files listed in the
2147 workspace
2151 command line whereas other directories and mpc files would
2152 not.
2153 </p>
2155 <blockquote>
2182 dir3
2183 </p>
2193 </blockquote>
2196 Exclusion sections are used to prevent
2197 directories and mpc files from being processed. These excluded
2198 directories and mpc files will be skipped when generating project
2200 accepts project types as well as properties (see <a href=
2202 within the parentheses (as above), which will cause the workspace
2203 creator to only exclude the listing for particular types. If no
2204 types are provided, exclusion will take place for all project
2205 types.
2206 </p>
2210 associates a name with one or more directories. This does not add
2211 directories to a workspace, it only makes an association. This
2212 may or may not have an effect on the generated workspace; it
2213 depends solely upon whether the project type supports
2215 only project type that supports associations. Each directory
2216 listed under an association is grouped together and built
2217 conditionally based on the association name.
2218 </p>
2221 Comments are similar to the C++ style comments.
2223 considered a comment.
2224 </p>
2226 </div>
2228 <div>
2231 <div>
2237 Project declarations are similar to
2238 workspace declarations, but are a bit more complex. An mpc file
2240 can inherit from base projects.
2241 </p>
2243 <blockquote>
2247 project(optional name): base_project,
2248 another_base_project {
2249 </p>
2254 includes += directory_name
2255 other_directory
2256 </p>
2286 </blockquote>
2289 If the optional project name is not
2290 given, then the project name is taken from the name of the mpc
2291 file without the extension. Therefore, if your mpc file is
2292 going to contain multiple projects, it is important to provide
2293 project names to prevent each generated project from
2294 overwriting the other. MPC will issue an error and stop if
2295 duplicate project names are detected.
2296 </p>
2298 </div>
2300 <div>
2305 Base projects can be of the extension
2307 file with the name of the base project with an <em class=
2309 be found within the mpc include search path, a fatal error is
2310 issued and processing halts.
2311 </p>
2312 </div>
2314 <div>
2319 This table shows the keywords that can
2322 an mpc file. The most commonly used keywords are shown in bold
2323 face.
2324 </p>
2329 Keywords
2330 </h6>
2334 <tr>
2337 </th>
2341 </th>
2342 </tr>
2344 <tr>
2348 <em class=
2350 </em>
2351 </p>
2352 </td>
2356 Specifies that this project must be
2357 built after 1 or more project names listed.
2358 </p>
2360 An extended syntax is available
2361 in order to associate name-value pairs with a
2363 <project
2364 name[:name=value]>
2365 </em><br>
2366 These name-value pairs may be used in the creation
2367 of the dependencies of the project.
2370 </p>
2371 </td>
2372 </tr>
2374 <tr>
2377 <em class=
2379 </p>
2380 </td>
2384 Specifies which features should be
2385 disabled in order to generate the project file. Under
2386 the GNUACE type, it also specifies which make macros
2387 should not be set to build the target.
2388 </p>
2389 </td>
2390 </tr>
2392 <tr>
2395 <em class=
2397 </p>
2398 </td>
2402 This keyword can only be used as a source component
2403 scoped setting (ie. inside the scope of
2404 Source_Files). It specifies additional build flags
2405 that will be passed to the compiler as the source
2406 files are being compiled.
2407 </p>
2408 </td>
2409 </tr>
2411 <tr>
2414 <em class=
2416 </p>
2417 </td>
2421 This setting instructs MPC to
2422 create projects that only contain custom generation
2423 targets. Any files included in the projects will be
2424 provided by custom component lists defined through the
2426 </p>
2427 </td>
2428 </tr>
2430 <tr>
2433 <em class=
2435 </p>
2436 </td>
2440 This keyword can only be used
2441 as a header component scoped setting (ie. inside
2442 the scope of Header_Files). It determines which
2443 file the header file is dependent upon for vc8,
2444 and vc9 only.
2445 </p>
2446 </td>
2447 </tr>
2449 <tr>
2452 <em class=
2454 </p>
2455 </td>
2459 If defined, specifies where the
2460 dynamic libraries will be placed. This overrides libout
2461 in the dynamic case.
2462 </p>
2463 </td>
2464 </tr>
2466 <tr>
2470 <em class=
2472 </em>
2473 </p>
2474 </td>
2478 Specifies preprocessor flags passed
2479 to the compiler when building a dynamic library.
2480 </p>
2481 </td>
2482 </tr>
2484 <tr>
2488 <em class=
2490 </em>
2491 </p>
2492 </td>
2496 Determines that the project will be
2497 an executable and the name of the executable
2498 target.
2499 </p>
2500 </td>
2501 </tr>
2503 <tr>
2507 <em class=
2509 </em>
2510 </p>
2511 </td>
2515 Specifies where executables will be
2516 placed.
2517 </p>
2518 </td>
2519 </tr>
2521 <tr>
2525 <em class=
2527 </em>
2528 </p>
2529 </td>
2533 Specifies one or more directories
2534 to supply to the compiler for use as include search
2535 paths.
2536 </p>
2537 </td>
2538 </tr>
2540 <tr>
2544 <em class=
2546 </em>
2547 </p>
2548 </td>
2552 Specifies where the dynamic and
2553 static libraries will be placed.
2554 </p>
2555 </td>
2556 </tr>
2558 <tr>
2562 <em class=
2564 </em>
2565 </p>
2566 </td>
2570 Specifies one or more directories
2571 to supply to the compiler for use as library search
2572 paths.
2573 </p>
2574 </td>
2575 </tr>
2577 <tr>
2581 <em class=
2583 </em>
2584 </p>
2585 </td>
2589 Specifies one or more libraries to
2590 link into the target. Library modifiers may be added
2591 when being processed in the template file. For example,
2592 library modifiers are added when using the vc6 project
2593 type.
2594 </p>
2595 </td>
2596 </tr>
2598 <tr>
2601 <em class=
2603 </p>
2604 </td>
2608 This is the same as libs except
2609 that a library modifier will not be added.
2610 </p>
2611 </td>
2612 </tr>
2614 <tr>
2617 <em class=
2619 </p>
2620 </td>
2624 Values supplied here will be passed
2625 directly to the compiler as command line defined
2626 macros.
2627 </p>
2628 </td>
2629 </tr>
2631 <tr>
2634 <em class=
2636 </p>
2637 </td>
2641 Specifies that the source files
2642 should be compiled as managed C++. This is only
2650 </p>
2651 </td>
2652 </tr>
2654 <tr>
2657 <em class=
2659 </p>
2660 </td>
2664 It specifies that precompiled
2665 headers should not be used for the source files listed
2666 within the scope of it’s setting. This keyword
2667 can only be used as a source component scoped setting
2668 (i.e., inside the scope of Source_Files).
2669 </p>
2670 </td>
2671 </tr>
2673 <tr>
2676 <em class=
2678 </p>
2679 </td>
2683 The name of the precompiled header
2684 file. See the discussion below this table for more
2685 information.
2686 </p>
2687 </td>
2688 </tr>
2690 <tr>
2693 <em class=
2695 </p>
2696 </td>
2700 The name of the precompiled source
2701 file. See the discussion below this table for more
2702 information.
2703 </p>
2704 </td>
2705 </tr>
2707 <tr>
2710 <em class=
2712 </p>
2713 </td>
2717 If this is defined in the project,
2718 the value will be interpreted as commands to run after
2719 the project has been successfully built. The <em class=
2721 "MakeProjectCreator.html#MPD_Syntax" class=
2723 value to access template variables and functions of the
2724 template parser. See <a href=
2726 Common
2727 Pseudo Variables
2728 </a> for a list of pseudo variables
2729 that are also available.
2730 </p>
2731 </td>
2732 </tr>
2734 <tr>
2737 <em class=
2739 </p>
2740 </td>
2744 If this is defined in the project,
2745 the value will be interpreted as commands to run after
2746 the project has been cleaned. It should be noted that
2747 this setting is not supported by all project types. As
2750 "MakeProjectCreator.html#MPD_Syntax" class=
2752 value to access template variables and functions of the
2753 template parser. See <a href=
2755 Common
2756 Pseudo Variables
2757 </a> for a list of pseudo variables
2758 that are also available.
2759 </p>
2760 </td>
2761 </tr>
2763 <tr>
2766 <em class=
2768 </p>
2769 </td>
2773 If this is defined in the project,
2774 the value will be interpreted as commands to run before
2775 the project has been built. As with <em class=
2777 <%
2778 %>
2780 "MakeProjectCreator.html#MPD_Syntax" class=
2782 value to access template variables and functions of the
2783 template parser. See <a href=
2785 Common
2786 Pseudo Variables
2787 </a> for a list of pseudo variables
2788 that are also available.
2789 </p>
2790 </td>
2791 </tr>
2793 <tr>
2796 <em class=
2798 </p>
2799 </td>
2803 This is similar to <em class=
2805 is added to the names specified.
2806 </p>
2807 </td>
2808 </tr>
2810 <tr>
2813 <em class=
2815 </p>
2816 </td>
2820 If set to 1, MPC will recurse into
2821 directories listed under component listings (such as
2822 Source_Files, Header_Files, etc.) and add any component
2823 corresponding files to the list. This keyword can be
2824 used as a global project setting or a component scoped
2825 setting.
2826 </p>
2827 </td>
2828 </tr>
2830 <tr>
2833 <em class=
2835 </p>
2836 </td>
2840 This is similar to <em class=
2842 to the compiler. However, each path supplied will be
2843 recursively searched for sub-directories which will
2844 also be provided as include paths to the compiler.
2845 </p>
2846 </td>
2847 </tr>
2849 <tr>
2852 <em class=
2854 </p>
2855 </td>
2859 This is similar to <em class=
2861 paths to the linker. However, each path supplied will
2862 be recursively searched for sub-directories which will
2863 also be provided as library search paths to the
2864 linker.
2865 </p>
2866 </td>
2867 </tr>
2869 <tr>
2872 <em class=
2874 </p>
2875 </td>
2879 Specifies which features should be
2880 enabled in order to generate the project file. Under
2881 the GNUACE type, it also specifies which make macros
2882 should be set to build the target.
2883 </p>
2884 </td>
2885 </tr>
2887 <tr>
2891 <em class=
2893 </em>
2894 </p>
2895 </td>
2899 Determines that the project will be
2900 a library and the name of the dynamic library target.
2901 See the discussion below this table for more
2902 information.
2903 </p>
2904 </td>
2905 </tr>
2907 <tr>
2911 <em class=
2913 </em>
2914 </p>
2915 </td>
2919 Specifies preprocessor flags passed
2920 to the compiler when building a static library.
2921 </p>
2922 </td>
2923 </tr>
2925 <tr>
2929 <em class=
2931 </em>
2932 </p>
2933 </td>
2937 Determines that the project will be
2938 a library and the name of the static library
2939 target.
2940 </p>
2941 </td>
2942 </tr>
2944 <tr>
2947 <em class=
2949 </p>
2950 </td>
2954 For GNUACE Make only, specifies one
2955 or more names to search for in the macros specified by
2956 tagname.
2957 </p>
2958 </td>
2959 </tr>
2961 <tr>
2964 <em class=
2966 </p>
2967 </td>
2971 Specifies the GNUACE Make macro to
2972 check before building the target.
2973 </p>
2974 </td>
2975 </tr>
2977 <tr>
2980 <em class=
2982 </p>
2983 </td>
2987 Specifies the version number for
2988 the library or executable.
2989 </p>
2990 </td>
2991 </tr>
2993 <tr>
2996 <em class=
2998 </p>
2999 </td>
3003 Determines whether the project is a
3004 Web Application. A web application project will have no
3005 project file written but the information will be
3006 included in the workspace if web applications are
3007 supported by the project type.
3008 </p>
3009 </td>
3010 </tr>
3011 </table>
3013 </p>
3016 Assignments can also use the <em class=
3018 and subtract values from keyword values.
3019 </p>
3022 Assignments can be bracketed by curly braces
3023 so they can span multiple lines. The opening curly brace must
3024 be the last thing on the same line as the operator and the closing
3025 brace must be on its own line (but can have leading white space).
3026 Optionally, \n, \s, or \ns can be included after the operator. These
3027 indicate that new lines should be retained (\n) and leading white space
3028 should be retained (\s).
3029 </p>
3031 <blockquote>
3040 </blockquote>
3047 applies in the opposite direction.
3048 </p>
3051 If neither exename, sharedname nor staticname
3052 is specified, MPC will search the source files for a <em class=
3054 found, the exename will be set to the name of the file, minus
3056 function. Otherwise, sharedname and staticname will be set to
3057 the project name.
3058 </p>
3061 If the project name, exename, sharedname or
3062 staticname contain an asterisk it instructs MPC to dynamically
3063 determine a portion of the name based on certain defaults. If
3064 the project name contains an asterisk, then the asterisk will
3065 be replaced with the default project name. If exename,
3066 sharedname or staticname contains an asterisk, then the
3067 asterisk will be replaced with the project name.
3068 </p>
3072 keyword is not used and a file exists, in the directory in
3073 which the mpc file is located, that matches <em class=
3075 for that directory. If there are multiple pch files in the
3076 directory, then the precompiled header that closely matches the
3077 project name will be chosen. Similar logic applies for the
3079 </p>
3081 </div>
3083 <div>
3090 An mpc file can also specify the files
3092 These files are specified using the component names shown in
3093 the following table. However, most of the time users will want
3094 to allow MPC to provide the default values for project
3095 files.
3096 </p>
3100 Component Names and Default
3101 Values
3102 </h6>
3106 <tr>
3109 </th>
3113 </th>
3114 </tr>
3116 <tr>
3119 <em class=
3121 </p>
3122 </td>
3126 Defaults to all files in the
3127 directory that have the following extensions:
3131 </p>
3132 </td>
3133 </tr>
3135 <tr>
3138 <em class=
3140 </p>
3141 </td>
3145 Defaults to all files in the
3146 directory that have the following extensions:
3149 </p>
3150 </td>
3151 </tr>
3153 <tr>
3156 <em class=
3158 </p>
3159 </td>
3163 Defaults to all files in the
3164 directory that have the following extensions:
3167 </p>
3168 </td>
3169 </tr>
3171 <tr>
3174 <em class=
3176 </p>
3177 </td>
3181 Defaults to all files in the
3182 directory that end in the following: <em class=
3186 </p>
3187 </td>
3188 </tr>
3190 <tr>
3193 <em class=
3195 </p>
3196 </td>
3200 Defaults to all files in the
3201 directory that match the following: <em class=
3205 </p>
3206 </td>
3207 </tr>
3209 <tr>
3212 <em class=
3214 </p>
3215 </td>
3219 Defaults to all files in the
3220 directory that match the project name and have an
3222 </p>
3223 </td>
3224 </tr>
3225 </table>
3226 </p>
3229 If a component is not specified in the mpc
3230 file, the default value will be used. To disallow a particular
3231 set of files that may exist in the directory, you must declare
3232 an empty set of the particular component type.
3233 </p>
3236 Each component name accepts two forms. The
3237 first form is a simple list of files within the construct.
3238 </p>
3240 <blockquote>
3252 </blockquote>
3255 The second form is a complex list of files
3256 within named blocks.
3257 </p>
3259 <blockquote>
3285 </blockquote>
3288 The second form allows the user to logically
3289 group the files to make future maintenance easier. Using this
3290 form has the effect of visually grouping files in the generated
3297 </p>
3300 If a file is listed in the <em class=
3302 header or inline file exists in the directory, it is added to
3303 the corresponding component list unless it is already
3304 listed.
3305 </p>
3307 </div>
3309 <div>
3315 construct can be used to place text into a generated project
3317 follows:
3318 </p>
3320 <blockquote>
3325 </p>
3332 </blockquote>
3335 When MPC is generating a project of type
3339 Template File
3340 Keywords
3343 inside the construct directly into the generated project. If
3344 the text inside the construct requires that white space be
3345 preserved, each line must be enclosed in double quotes. The
3348 rule at the bottom of the GNUmakefile where the <em class=
3351 </p>
3353 <blockquote>
3360 </blockquote>
3362 </div>
3364 <div>
3370 can be used to provide values for variable names enclosed
3374 attempt to replace it with values from the expansion list. MPC
3375 will first try to replace it with the value of the environment
3377 environment variable has a value, it will be used. Otherwise,
3378 it will continue down the list until a suitable value is found.
3379 In this example, the text <em class=
3382 value is found.
3383 </p>
3385 <blockquote>
3394 </blockquote>
3396 </div>
3398 <div>
3401 </h6>
3406 keyword can be used to define assignments that are specific to
3407 a particular project type or property specified in the
3408 parenthesis. This will allow platform or OS-specific values to
3409 be placed into a project. For example, on one platform you may
3411 but on another you need to link in <em class=
3413 </p>
3415 <blockquote>
3429 </blockquote>
3432 If an else clause is provided, it is required
3433 to be on the same line as the closing curly brace. You may also
3435 which will cause the specific to be evaluated for all types
3436 except the type specified.
3437 </p>
3440 If a keyword used within a <em class=
3442 keyword, it is interpreted to be template value modifier. In
3443 this situation, this construct works exactly the same way as
3447 </p>
3451 The following table shows which properties
3453 property (not represented in the table) is set if the -static
3454 option is supplied when processing the project files.
3455 Additionally, a property that corresponds to the language
3456 will be set (e.g., cplusplus, csharp, java, vb).
3457 </p>
3461 <a name=
3463 </h6>
3467 <tr>
3470 </th>
3474 </th>
3478 </th>
3482 </th>
3486 </th>
3487 </tr>
3489 <tr>
3492 <em class=
3494 </p>
3495 </td>
3499 </td>
3503 </td>
3507 </td>
3511 </td>
3512 </tr>
3514 <tr>
3517 <em class=
3519 </p>
3520 </td>
3524 </td>
3528 </td>
3532 </td>
3536 </td>
3537 </tr>
3539 <tr>
3542 <em class=
3544 </p>
3545 </td>
3549 </td>
3553 </td>
3557 </td>
3561 </td>
3562 </tr>
3564 <tr>
3568 </p>
3569 </td>
3573 </td>
3577 </td>
3581 </td>
3585 </td>
3586 </tr>
3588 <tr>
3591 <em class=
3593 </p>
3594 </td>
3598 </td>
3602 </td>
3606 </td>
3610 </td>
3611 </tr>
3613 <tr>
3617 </p>
3618 </td>
3622 </td>
3626 </td>
3630 </td>
3634 </td>
3635 </tr>
3637 <tr>
3641 </p>
3642 </td>
3646 </td>
3650 </td>
3654 </td>
3658 </td>
3659 </tr>
3661 <tr>
3665 </p>
3666 </td>
3670 </td>
3674 </td>
3678 </td>
3682 </td>
3683 </tr>
3685 <tr>
3689 </p>
3690 </td>
3694 </td>
3698 </td>
3702 </td>
3706 </td>
3707 </tr>
3709 <tr>
3712 <em class=
3714 </p>
3715 </td>
3719 </td>
3723 </td>
3727 </td>
3731 </td>
3732 </tr>
3734 <tr>
3738 </p>
3739 </td>
3743 </td>
3747 </td>
3751 </td>
3755 </td>
3756 </tr>
3758 <tr>
3762 </p>
3763 </td>
3767 </td>
3771 </td>
3775 </td>
3779 </td>
3780 </tr>
3782 <tr>
3786 </p>
3787 </td>
3791 </td>
3795 </td>
3799 </td>
3803 </td>
3804 </tr>
3806 <tr>
3810 </p>
3811 </td>
3815 </td>
3819 </td>
3823 </td>
3827 </td>
3828 </tr>
3830 <tr>
3834 </p>
3835 </td>
3839 </td>
3843 </td>
3847 </td>
3851 </td>
3852 </tr>
3854 <tr>
3858 </p>
3859 </td>
3863 </td>
3867 </td>
3871 </td>
3875 </td>
3876 </tr>
3878 <tr>
3882 </p>
3883 </td>
3887 </td>
3891 </td>
3895 </td>
3899 </td>
3900 </tr>
3902 <tr>
3906 </p>
3907 </td>
3911 </td>
3915 </td>
3919 </td>
3923 </td>
3924 </tr>
3926 <tr>
3930 </p>
3931 </td>
3935 </td>
3939 </td>
3943 </td>
3947 </td>
3948 </tr>
3950 <tr>
3954 </p>
3955 </td>
3959 </td>
3963 </td>
3967 </td>
3971 </td>
3972 </tr>
3974 <tr>
3978 </p>
3979 </td>
3983 </td>
3987 </td>
3991 </td>
3995 </td>
3996 </tr>
3998 <tr>
4002 </p>
4003 </td>
4007 </td>
4011 </td>
4015 </td>
4019 </td>
4020 </tr>
4022 <tr>
4026 </p>
4027 </td>
4031 </td>
4035 </td>
4039 </td>
4043 </td>
4044 </tr>
4045 </table>
4046 </p>
4047 </p>
4050 The ghs project type can be used on both
4051 Windows and UNIX. The windows property will be active if the
4053 set during project generation.
4054 </p>
4056 </div>
4058 <div>
4063 This scope allows addition of source files
4064 conditionally based on a particular project type or property
4066 property
4067 table
4068 </a>). The syntax is as follows:
4069 </p>
4071 <blockquote>
4077 </p>
4090 </p>
4105 </blockquote>
4108 If the else is provided, it is required to be
4109 on the same line as the closing curly brace. You may also
4111 cause the conditional to be evaluated for all types except the
4112 type specified.
4113 </p>
4115 </div>
4117 <div>
4124 MPC allows you to define your own custom
4125 file types to support a variety of custom build rules. Below is
4126 an example of a custom definition.
4127 </p>
4129 <blockquote>
4140 command =
4141 $(QTDIR)/bin/moc
4142 </p>
4145 output_option =
4146 -o
4147 </p>
4152 pre_extension =
4153 _moc
4154 </p>
4157 source_outputext =
4158 .cpp
4159 </p>
4162 keyword mocflags =
4163 commandflags
4164 </p>
4189 </blockquote>
4192 The above example defines a custom file type,
4194 information about how to process the input files and what
4195 output files are created. Once the custom file type is defined,
4197 input files for this new file type.
4198 </p>
4201 Define_Custom definitions may use single
4202 inheritance. This is useful for creating aliased names:
4203 </p>
4204 <blockquote>
4207 </blockquote>
4210 The following table contains the keywords that
4211 can be used within the scope of <em class=
4213 </p>
4222 <tr>
4225 </th>
4229 </th>
4230 </tr>
4232 <tr>
4235 <em class=
4237 </p>
4238 </td>
4242 If set to 1, then attempt to
4243 automatically determine which files belong to the set
4244 of input files for the custom type. If set to 0, then
4245 no files are automatically added to the input
4246 files.
4247 </p>
4248 </td>
4249 </tr>
4251 <tr>
4254 <em class=
4256 </p>
4257 </td>
4261 If set to 1, then attempt to
4262 automatically determine which generated files belong to
4263 the set of components (<em class=
4270 that the command generates. If omitted, then
4271 automatic_out is assumed to be 1.
4272 </p>
4273 </td>
4274 </tr>
4276 <tr>
4279 <em class=
4281 </p>
4282 </td>
4286 The name of the command that should
4287 be used to process the input files for the custom
4288 type.
4289 </p>
4290 </td>
4291 </tr>
4293 <tr>
4296 <em class=
4298 </p>
4299 </td>
4303 Any options that should be passed
4304 to the command.
4305 </p>
4306 </td>
4307 </tr>
4309 <tr>
4312 <em class=
4314 </p>
4315 </td>
4319 If this is given a value, then a
4320 dependency upon that value will be given to all of the
4321 generated files. The default for this is unset and no
4322 dependency will be generated.
4323 </p>
4324 </td>
4325 </tr>
4327 <tr>
4330 <em class=
4332 </p>
4333 </td>
4337 If this is given a value, then a dependency upon that
4338 library value will be given to all of the generated files.
4339 The format for this entry should be the basename for the
4340 library (no library prefix, postfix, or extension)
4341 preceded by any relative or absolute path to the library.
4342 The typical use for this would be so that a project is
4343 rebuilt when a library needs to be rebuilt for its
4344 dependent executable. The default for this is unset and no
4345 dependency will be generated.
4346 </p>
4347 </td>
4348 </tr>
4350 <tr>
4353 <em class=
4355 </p>
4356 </td>
4360 This is a comma separated list of
4361 input file extensions that belong to the command.
4362 </p>
4363 </td>
4364 </tr>
4366 <tr>
4370 keyword
4372 </em>
4373 </p>
4374 </td>
4378 This is a special assignment that
4380 level namespace. The value (if any) that is assigned to
4381 this construct must be one of the keywords that can be
4382 used within a Define_Custom clause. The result of this
4383 assignment is the ability modify the value of keywords
4384 that are normally only accessible within the scope of a
4387 </p>
4388 </td>
4389 </tr>
4391 <tr>
4394 <em class=
4396 </p>
4397 </td>
4401 If the command requires a library
4402 that is not in the normal library search path, this
4403 keyword can be used to ensure that the command is able
4404 to find the library that it needs to run.
4405 </p>
4406 </td>
4407 </tr>
4409 <tr>
4412 <em class=
4414 </p>
4415 </td>
4419 If the command takes an option to
4420 specify a single file output name, then set it here.
4421 Otherwise, this should be omitted.
4422 </p>
4423 </td>
4424 </tr>
4426 <tr>
4429 <em class=
4431 </p>
4432 </td>
4436 This setting defaults to 1 and
4437 indicates that output files from the custom command
4438 will end up in the same directory as the input files.
4439 If this is set to 0, it is assumed that the output
4440 files will go into the same directory as the .mpc
4441 file.
4442 </p>
4443 </td>
4444 </tr>
4446 <tr>
4449 <em class=
4451 </p>
4452 </td>
4456 If this is set to 1, then a rule
4457 will be added to the custom rule that will modify the
4458 source output files to include the precompiled header
4459 file.
4460 </p>
4461 </td>
4462 </tr>
4464 <tr>
4467 <em class=
4469 </p>
4470 </td>
4474 This allows users to create
4475 arbitrary commands that will be run after the main
4476 command is run to process the custom input files.
4477 </p>
4478 </td>
4479 </tr>
4481 <tr>
4484 <em class=
4486 </p>
4487 </td>
4491 If the command produces multiple
4492 files of the same extension, this comma separated list
4493 can be used to specify them. For example, <em class=
4498 extension types.
4499 </p>
4500 </td>
4501 </tr>
4503 <tr>
4506 <em class=
4508 </p>
4509 </td>
4513 This is the same as pre_extension
4514 except that it only applies to source files.
4515 </p>
4516 </td>
4517 </tr>
4519 <tr>
4522 <em class=
4524 </p>
4525 </td>
4529 This is the same as pre_extension
4530 except that it only applies to inline files.
4531 </p>
4532 </td>
4533 </tr>
4535 <tr>
4538 <em class=
4540 </p>
4541 </td>
4545 This is the same as pre_extension
4546 except that it only applies to header files.
4547 </p>
4548 </td>
4549 </tr>
4551 <tr>
4554 <em class=
4556 </p>
4557 </td>
4561 This is the same as pre_extension
4562 except that it only applies to template files.
4563 </p>
4564 </td>
4565 </tr>
4567 <tr>
4570 <em class=
4572 </p>
4573 </td>
4577 This is the same as pre_extension
4578 except that it only applies to resource files.
4579 </p>
4580 </td>
4581 </tr>
4583 <tr>
4586 <em class=
4588 </p>
4589 </td>
4593 This is the same as pre_extension
4594 except that it only applies to documentation files.
4595 </p>
4596 </td>
4597 </tr>
4599 <tr>
4602 <em class=
4604 </p>
4605 </td>
4609 This is the same as pre_extension
4610 except that it only applies to generic files.
4611 </p>
4612 </td>
4613 </tr>
4615 <tr>
4618 <em class=
4620 </p>
4621 </td>
4625 The syntax for this is the same as
4627 specified are prepended to the file name instead of the
4628 extension. This applies to all extension types.
4629 </p>
4630 </td>
4631 </tr>
4633 <tr>
4636 <em class=
4638 </p>
4639 </td>
4643 This is the same as pre_filename
4644 except that it only applies to source files.
4645 </p>
4646 </td>
4647 </tr>
4649 <tr>
4652 <em class=
4654 </p>
4655 </td>
4659 This is the same as pre_filename
4660 except that it only applies to inline files.
4661 </p>
4662 </td>
4663 </tr>
4665 <tr>
4668 <em class=
4670 </p>
4671 </td>
4675 This is the same as pre_filename
4676 except that it only applies to header files.
4677 </p>
4678 </td>
4679 </tr>
4681 <tr>
4684 <em class=
4686 </p>
4687 </td>
4691 This is the same as pre_filename
4692 except that it only applies to template files.
4693 </p>
4694 </td>
4695 </tr>
4697 <tr>
4700 <em class=
4702 </p>
4703 </td>
4707 This is the same as pre_filename
4708 except that it only applies to resource files.
4709 </p>
4710 </td>
4711 </tr>
4713 <tr>
4716 <em class=
4718 </p>
4719 </td>
4723 This is the same as pre_filename
4724 except that it only applies to documentation files.
4725 </p>
4726 </td>
4727 </tr>
4729 <tr>
4732 <em class=
4734 </p>
4735 </td>
4739 This is the same as pre_filename
4740 except that it only applies to generic files.
4741 </p>
4742 </td>
4743 </tr>
4745 <tr>
4748 <em class=
4750 </p>
4751 </td>
4755 The syntax for this is the same as
4757 specified is prepended to the directory portion of the
4758 file name instead of the file name itself. If a
4759 separate directory is desired, the <em class=
4761 slash.
4762 </p>
4763 </td>
4764 </tr>
4766 <tr>
4769 <em class=
4771 </p>
4772 </td>
4776 This is the same as pre_dirname
4777 except that it only applies to source files.
4778 </p>
4779 </td>
4780 </tr>
4782 <tr>
4785 <em class=
4787 </p>
4788 </td>
4792 This is the same as pre_dirname
4793 except that it only applies to inline files.
4794 </p>
4795 </td>
4796 </tr>
4798 <tr>
4801 <em class=
4803 </p>
4804 </td>
4808 This is the same as pre_dirname
4809 except that it only applies to header files.
4810 </p>
4811 </td>
4812 </tr>
4814 <tr>
4817 <em class=
4819 </p>
4820 </td>
4824 This is the same as pre_dirname
4825 except that it only applies to template files.
4826 </p>
4827 </td>
4828 </tr>
4830 <tr>
4833 <em class=
4835 </p>
4836 </td>
4840 This is the same as pre_dirname
4841 except that it only applies to resource files.
4842 </p>
4843 </td>
4844 </tr>
4846 <tr>
4849 <em class=
4851 </p>
4852 </td>
4856 This is the same as pre_dirname
4857 except that it only applies to documentation files.
4858 </p>
4859 </td>
4860 </tr>
4862 <tr>
4865 <em class=
4867 </p>
4868 </td>
4872 This is the same as pre_dirname
4873 except that it only applies to generic files.
4874 </p>
4875 </td>
4876 </tr>
4878 <tr>
4881 <em class=
4883 </p>
4884 </td>
4888 This is a comma separated list of
4889 possible source file output extensions. If the command
4890 does not produce source files, then this can be
4891 omitted.
4892 </p>
4893 </td>
4894 </tr>
4896 <tr>
4899 <em class=
4901 </p>
4902 </td>
4906 This is a comma separated list of
4907 possible inline file output extensions. If the command
4908 does not produce inline files, then this can be
4909 omitted.
4910 </p>
4911 </td>
4912 </tr>
4914 <tr>
4917 <em class=
4919 </p>
4920 </td>
4924 This is a comma separated list of
4925 possible header file output extensions. If the command
4926 does not produce header files, then this can be
4927 omitted.
4928 </p>
4929 </td>
4930 </tr>
4932 <tr>
4935 <em class=
4937 </p>
4938 </td>
4942 This is a comma separated list of
4943 possible template file output extensions. If the
4944 command does not produce template files, then this can
4945 be omitted.
4946 </p>
4947 </td>
4948 </tr>
4950 <tr>
4953 <em class=
4955 </p>
4956 </td>
4960 This is a comma separated list of
4961 possible resource file output extensions. If the
4962 command does not produce resource files, then this can
4963 be omitted.
4964 </p>
4965 </td>
4966 </tr>
4968 <tr>
4971 <em class=
4973 </p>
4974 </td>
4978 This is a comma separated list of
4979 possible documentation file output extensions. If the
4980 command does not produce documentation files, then this
4981 can be omitted.
4982 </p>
4983 </td>
4984 </tr>
4986 <tr>
4989 <em class=
4991 </p>
4992 </td>
4996 If the command does not generate
4997 any of the other output types listed above, then the
4998 extensions should be listed under this.
4999 </p>
5000 </td>
5001 </tr>
5002 </table>
5003 </p>
5004 </p>
5007 There is a special interaction between custom
5008 components and the source, header and inline components. If a
5011 but not specified, the default custom generated names are added
5012 to the source, header and inline component lists unless those
5013 names are already listed (or partially listed) in those
5014 component lists. See <a href=
5015 "MakeProjectCreator.html#Custom_Types_and_Build_Rules"
5017 information about defining your own custom type.
5018 </p>
5021 Particular output extensions for custom build
5022 types are not required. However, at least one output extension
5023 type is required for MPC to generate a target. Your command
5024 does not necessarily have to generate output, but an extension
5025 type is required if you want the input file to be processed
5026 during the project compilation.
5027 </p>
5030 If the custom output can not be represented
5031 with the above output extension keywords (*_outputext) and you
5033 a
5034 priori
5037 </p>
5040 Below is an example that demonstrates the use
5042 file name of foo.prp and produces two files that have
5045 </p>
5047 <blockquote>
5061 --language=c++ \
5062 </p>
5065 --kernel_language=c++
5066 </p>
5071 keyword quogenflags =
5072 commandflags
5073 </p>
5083 hello.h hello.cpp
5084 </p>
5099 </blockquote>
5103 construct to represent dependencies for specific custom input
5104 file. For instance, in the above example, assume that foo.prp
5105 depends upon foo.in, we would represent this by adding
5107 </p>
5109 <blockquote>
5115 hello.cpp << foo.in
5116 </p>
5121 </blockquote>
5124 An additional construct can be used within the
5127 represent optional custom command output that is dependent upon
5128 particular command line parameters passed to the custom
5129 command.
5130 </p>
5132 <blockquote>
5139 optional(keyword)
5140 {
5141 </p>
5144 flag_keyword(option) +=
5145 value [, value]
5146 </p>
5153 </blockquote>
5156 In the above fragment, <em class=
5159 keywords or any of the keywords that end in <em class=
5161 can be any of the custom definition keywords, however only
5169 exclamation point (!).
5170 </p>
5173 The example below shows how the <em class=
5179 (based on the idl file name) with an <em class=
5183 </p>
5185 <blockquote>
5200 source_outputext = .cpp, .cxx,
5201 .cc, .C
5202 </p>
5205 header_outputext = .h, .hpp,
5206 .hxx, .hh
5207 </p>
5212 keyword idlflags =
5213 commandflags
5214 </p>
5219 optional(source_pre_extension)
5220 {
5221 </p>
5224 commandflags(-GA) +=
5225 A
5226 </p>
5231 optional(template_outputext)
5232 {
5233 </p>
5236 commandflags(!-Sc) +=
5237 S_T.cpp, S_T.cxx, S_T.cc, S_T.C
5238 </p>
5243 optional(header_pre_extension)
5244 {
5245 </p>
5248 commandflags(!-Sc) +=
5249 S_T
5250 </p>
5255 optional(inline_pre_extension)
5256 {
5257 </p>
5260 commandflags(!-Sc) +=
5261 S_T
5262 </p>
5269 </blockquote>
5272 For custom file types, there are a few
5273 keywords that can be used within the custom file type component
5279 </p>
5285 </p>
5292 augment or override the value defined in the <em class=
5294 </p>
5300 in which the generated output will go. Here is an example:
5301 </p>
5303 <blockquote>
5320 moc_generated/QtReactor_moc.cpp
5321 </p>
5326 </blockquote>
5329 In the above example, the <em class=
5338 the output actually went into the <em class=
5340 </p>
5343 <div>
5348 An existing <em class=
5351 is identical to that of a <em class=
5353 modification to the TAO IDL defaults found in <em class=
5355 Everything provided by the <em class=
5357 the values set within the <em class=
5359 </p>
5361 <blockquote>
5368 tao_idlflags += -Sc
5369 -hs _s.h -si _s.i -ss _s.cpp -hc .h -ci .i -cs .cpp
5370 </p>
5378 to work
5379 </p>
5384 IDL_CLIENT_HDR_EXT
5385 ?= .h
5386 </p>
5389 IDL_CLIENT_INL_EXT
5390 ?= .i
5391 </p>
5394 IDL_CLIENT_SRC_EXT
5395 ?= .cpp
5396 </p>
5399 IDL_SERVER_HDR_EXT
5400 ?= _s.h
5401 </p>
5404 IDL_SERVER_INL_EXT
5405 ?= _s.i
5406 </p>
5409 IDL_SERVER_SRC_EXT
5410 ?= _s.cpp
5411 </p>
5420 source_pre_extension = , _s
5421 </p>
5424 header_pre_extension = , _s
5425 </p>
5428 inline_pre_extension = , _s
5429 </p>
5432 inline_outputext
5433 = .i
5434 </p>
5439 <blockquote>
5440 </ul>
5441 </div>
5443 <div>
5448 When defining a <em class=
5451 are available to provide some flexibility. The following
5452 table shows the pseudo template variables that can be
5456 </p>
5460 Post Command Pseudo
5461 Variables
5462 </h6>
5465 <tr>
5468 </th>
5472 </th>
5473 </tr>
5475 <tr>
5478 <em class=
5480 </p>
5481 </td>
5485 The input file to the
5486 command.
5487 </p>
5488 </td>
5489 </tr>
5491 <tr>
5494 <em class=
5496 </p>
5497 </td>
5501 The basename of the input file to
5502 the command.
5503 </p>
5504 </td>
5505 </tr>
5507 <tr>
5510 <em class=
5512 </p>
5513 </td>
5517 The directory name of the input
5518 file to the command.
5519 </p>
5520 </td>
5521 </tr>
5523 <tr>
5526 <em class=
5528 </p>
5529 </td>
5533 The input file to the command
5534 with the extension stripped off.
5535 </p>
5536 </td>
5537 </tr>
5539 <tr>
5542 <em class=
5544 </p>
5545 </td>
5549 This gives the file extension of
5550 the input file (if there is one).
5551 </p>
5552 </td>
5553 </tr>
5555 <tr>
5558 <em class=
5560 </p>
5561 </td>
5565 The output file created by the
5566 original command.
5567 </p>
5568 </td>
5569 </tr>
5571 <tr>
5574 <em class=
5576 </p>
5577 </td>
5581 The basename of the output file
5582 to the command.
5583 </p>
5584 </td>
5585 </tr>
5587 <tr>
5590 <em class=
5592 </p>
5593 </td>
5597 The directory name of the output
5598 file to the command.
5599 </p>
5600 </td>
5601 </tr>
5603 <tr>
5606 <em class=
5608 </p>
5609 </td>
5613 The output file created by the
5614 original command with the extension stripped off.
5615 </p>
5616 </td>
5617 </tr>
5619 <tr>
5622 <em class=
5624 </p>
5625 </td>
5629 This gives the file extension of
5630 the output file (if there is one).
5631 </p>
5632 </td>
5633 </tr>
5635 <tr>
5638 The output file can be referenced
5639 as a generic output file, or it can be referenced as
5640 a component file using one of the following
5641 variables. If it does not match the specific type the
5642 value will be empty.
5643 </p>
5644 </td>
5645 </tr>
5647 <tr>
5650 <em class=
5652 </p>
5653 </td>
5657 The output file if it is a
5658 documentation file.
5659 </p>
5660 </td>
5661 </tr>
5663 <tr>
5666 <em class=
5668 </p>
5669 </td>
5673 The output file if it has a
5674 header file extension.
5675 </p>
5676 </td>
5677 </tr>
5679 <tr>
5682 <em class=
5684 </p>
5685 </td>
5689 The output file if it has an
5690 inline file extension.
5691 </p>
5692 </td>
5693 </tr>
5695 <tr>
5698 <em class=
5701 VB)
5702 </p>
5703 </td>
5707 The output file if it has a
5708 resource file extension.
5709 </p>
5710 </td>
5711 </tr>
5713 <tr>
5716 <em class=
5718 </p>
5719 </td>
5723 The output file if it has a
5724 source file extension.
5725 </p>
5726 </td>
5727 </tr>
5729 <tr>
5732 <em class=
5734 </p>
5735 </td>
5739 The output file if it is a
5740 template file.
5741 </p>
5742 </td>
5743 </tr>
5745 <tr>
5748 <em class=
5750 </p>
5751 </td>
5755 The output file without an
5756 extension if it is a documentation file.
5757 </p>
5758 </td>
5759 </tr>
5761 <tr>
5764 <em class=
5766 </p>
5767 </td>
5771 The output file without an
5772 extension if it has a header file extension.
5773 </p>
5774 </td>
5775 </tr>
5777 <tr>
5780 <em class=
5782 </p>
5783 </td>
5787 The output file without an
5788 extension if it has an inline file extension.
5789 </p>
5790 </td>
5791 </tr>
5793 <tr>
5796 <em class=
5799 for C# and VB)
5800 </p>
5801 </td>
5805 The output file without an
5806 extension if it has a resource file extension.
5807 </p>
5808 </td>
5809 </tr>
5811 <tr>
5814 <em class=
5816 </p>
5817 </td>
5821 The output file without an
5822 extension if it has a source file extension.
5823 </p>
5824 </td>
5825 </tr>
5827 <tr>
5830 <em class=
5832 </p>
5833 </td>
5837 The output file without an
5838 extension if it is a template file.
5839 </p>
5840 </td>
5841 </tr>
5843 <tr>
5846 The extensions of the input and
5847 output files are also available as pseudo
5848 variables.
5849 </p>
5850 </td>
5851 </tr>
5853 <tr>
5856 <em class=
5858 </p>
5859 </td>
5863 The extension of the input file
5864 (if it has one).
5865 </p>
5866 </td>
5867 </tr>
5869 <tr>
5872 <em class=
5874 </p>
5875 </td>
5879 The extension of the output file
5880 (if it has one).
5881 </p>
5882 </td>
5883 </tr>
5884 </table>
5885 </p>
5890 The following table describes the pseudo
5891 template variables that can be used in the <em class=
5896 </p>
5900 <a name=
5902 </h6>
5905 <tr>
5908 </th>
5912 </th>
5913 </tr>
5915 <tr>
5918 <em class=
5920 </p>
5921 </td>
5925 A platform and project
5926 non-specific representation of a command conditional
5927 and.
5928 </p>
5929 </td>
5930 </tr>
5932 <tr>
5935 <em class=
5937 </p>
5938 </td>
5942 A platform non-specific command
5943 to print a file to the terminal.
5944 </p>
5945 </td>
5946 </tr>
5948 <tr>
5951 <em class=
5953 </p>
5954 </td>
5958 A project and platform
5959 non-specific command separator which always runs
5960 right-hand side of the command. For example, in the
5961 following pseudo command string, both the <em class=
5967 other_dir
5968 </em>
5969 </p>
5970 </td>
5971 </tr>
5973 <tr>
5976 <em class=
5978 </p>
5979 </td>
5983 A platform non-specific command
5984 to compare two files.
5985 </p>
5986 </td>
5987 </tr>
5989 <tr>
5992 <em class=
5994 </p>
5995 </td>
5999 A platform non-specific command
6000 to copy a file.
6001 </p>
6002 </td>
6003 </tr>
6005 <tr>
6008 <em class=
6010 </p>
6011 </td>
6015 A platform non-specific line
6016 ending.
6017 </p>
6018 </td>
6019 </tr>
6021 <tr>
6024 <em class=
6026 </p>
6027 </td>
6031 A project non-specific escaped
6032 double quote.
6033 </p>
6034 </td>
6035 </tr>
6037 <tr>
6040 <em class=
6042 </p>
6043 </td>
6047 The output directory specified by
6049 variable is not available to <em class=
6053 </p>
6054 </td>
6055 </tr>
6057 <tr>
6060 <em class=
6062 </p>
6063 </td>
6067 A platform and project
6068 non-specific representation of a greater than
6069 sign.
6070 </p>
6071 </td>
6072 </tr>
6074 <tr>
6077 <em class=
6079 </p>
6080 </td>
6084 A platform and project
6085 non-specific representation of a less than sign.
6086 </p>
6087 </td>
6088 </tr>
6090 <tr>
6093 <em class=
6095 </p>
6096 </td>
6100 A platform non-specific command
6101 to make a directory.
6102 </p>
6103 </td>
6104 </tr>
6106 <tr>
6109 <em class=
6111 </p>
6112 </td>
6116 A platform non-specific command
6117 to move a file.
6118 </p>
6119 </td>
6120 </tr>
6122 <tr>
6125 <em class=
6127 </p>
6128 </td>
6132 A platform non-specific null
6133 device.
6134 </p>
6135 </td>
6136 </tr>
6138 <tr>
6141 <em class=
6143 </p>
6144 </td>
6148 A platform non-specific path
6149 separator (; or :).
6150 </p>
6151 </td>
6152 </tr>
6154 <tr>
6157 <em class=
6159 </p>
6160 </td>
6164 A platform and project
6165 non-specific representation of a command conditional
6166 or.
6167 </p>
6168 </td>
6169 </tr>
6171 <tr>
6174 <em class=
6176 </p>
6177 </td>
6181 </td>
6182 </tr>
6184 <tr>
6187 <em class=
6189 </p>
6190 </td>
6194 The project type as supplied
6195 by the -type command line option.
6196 </p>
6197 </td>
6198 </tr>
6200 <tr>
6203 <em class=
6205 </p>
6206 </td>
6210 A project non-specific
6211 representation of a double quote.
6212 </p>
6213 </td>
6214 </tr>
6216 <tr>
6219 <em class=
6221 </p>
6222 </td>
6226 A platform non-specific command
6227 to delete a file.
6228 </p>
6229 </td>
6230 </tr>
6232 <tr>
6235 <em class=
6237 </p>
6238 </td>
6242 A platform non-specific recursive
6243 directory delete command.
6244 </p>
6245 </td>
6246 </tr>
6248 <tr>
6251 <em class=
6253 </p>
6254 </td>
6258 A platform non-specific directory
6259 separator.
6260 </p>
6261 </td>
6262 </tr>
6264 <tr>
6267 <em class=
6269 </p>
6270 </td>
6274 A temporary file name. The
6275 generated temporary file name contains no directory
6276 portion and is the same for each use within the same
6277 variable setting.
6278 </p>
6279 </td>
6280 </tr>
6282 <tr>
6285 The following variables will
6286 be set to the known extension for Windows based
6287 project types and empty on non-Windows based
6288 project types.
6289 </p>
6290 </td>
6291 </tr>
6293 <tr>
6296 <em class=
6298 </p>
6299 </td>
6303 The extension for batch
6304 files.
6305 </p>
6306 </td>
6307 </tr>
6309 <tr>
6312 <em class=
6314 </p>
6315 </td>
6319 The extension for command
6320 files.
6321 </p>
6322 </td>
6323 </tr>
6325 <tr>
6328 <em class=
6330 </p>
6331 </td>
6335 The extension for executable
6336 files.
6337 </p>
6338 </td>
6339 </tr>
6340 </table>
6341 </p>
6343 </div>
6344 </div>
6345 </div>
6347 <div>
6354 The term feature, as used by MPC,
6355 describes different concepts or external software that a project
6356 may require in order to build properly. The feature file
6357 determines which features are enabled or disabled which has a
6358 direct effect on whether or not MPC generates a project.
6359 </p>
6362 It supports the standard comment (<em class=
6364 These feature names will correspond to values given to the
6366 keywords in mpc files.
6367 </p>
6370 If a feature is not listed in the feature file
6371 or is listed with a boolean value of true (1), that feature is
6372 enabled. If a feature is listed and has a boolean value of false
6373 (0), that feature is disabled.
6374 </p>
6377 If a feature name is listed in the <em class=
6379 feature is enabled, that project will be generated. If the
6380 feature is not enabled, the project will not be generated.
6381 </p>
6384 The opposite holds true for the <em class=
6387 is disabled, that project will be generated. If the feature is
6388 enabled, the project will not be generated.
6389 </p>
6392 The global feature file for MPC contains the
6393 following values.
6394 </p>
6396 <blockquote>
6457 </blockquote>
6460 In the above contents, all of these features are
6461 disabled for each project generated. If these values do not suit
6462 your needs, then you must do one of the following:
6463 </p>
6466 <ul>
6467 <li>
6468 Create a project specific feature file in the <em class=
6471 project type) to set features for a particular project
6472 type.
6473 </li>
6475 <li>
6478 feature set you need. These will be applied to all project
6479 types.
6480 </li>
6482 <li>
6483 Create a feature file anywhere you like with the features
6485 option to specify the location.
6486 </li>
6488 <li>
6490 dynamically modify the feature settings.
6491 </li>
6492 </ul>
6493 </p>
6496 Generated projects will have a combination of
6498 file as well as in your feature file. Therefore, if a feature is
6499 disabled in the global file and you want to enable it, you must
6500 explicitly enable it in your feature file.
6501 </p>
6503 </div>
6505 <div>
6510 A feature project contains information as
6511 a project would, but can only be a base project and will only be
6512 added to a sub project if the features that it requires are
6513 enabled or the features that it avoids are disabled.
6514 </p>
6517 A feature definition requires at least one
6518 feature name. A name by itself specifies that the feature must be
6520 that the feature must be disabled. There may be more than one
6521 comma separated feature listed between the parenthesis.
6522 </p>
6525 The following example show how to declare a
6526 feature project.
6527 </p>
6529 <blockquote>
6538 libpaths +=
6539 $(ZIPARCHIVEROOT)/lib
6540 </p>
6544 ziparch
6545 </p>
6550 </blockquote>
6553 With this example, any project that inherits
6555 will contain the project information only if the <em class=
6557 </p>
6559 </div>
6560 </div>
6562 <div>
6567 MPC has been designed to minimize the amount
6568 of maintenance that goes into keeping build tool files up-to-date
6569 with the project. If your source code is organized <em class=
6571 be minimal.
6572 </p>
6575 With the use of inheritance and proper code
6576 arrangement, an mpc file for a TAO related project may be as simple
6577 as:
6578 </li>
6580 <blockquote>
6587 </blockquote>
6590 This project definition could be used to generate
6591 a project for a TAO server with multiple idl, header and source
6592 files.
6593 </p>
6598 one
6599 directory per binary target.
6600 </em> If only the files that pertain to
6601 a single target are located in the directory with the mpc file,
6602 then the MPC defaults will satisfy most project needs.
6603 </p>
6606 Of course, it will not always be possible or
6607 desirable to organize your project code in this fashion, so all
6608 defaulting behavior can be overridden. The next sections describe
6609 the default behaviors of MPC and how to override them.
6610 </p>
6613 <div>
6617 New source files are added and others are
6618 removed quite often in a developing project. If the <em class=
6620 then MPC will assume that any file matching one of the <em class=
6622 project. For most project types, the source extensions are:
6629 types as eMbedded Visual C++ and Visual C++ 6.0 do not understand
6632 </p>
6634 </div>
6636 <div>
6641 MPC assumes that any file matching one of
6643 included in the project if the <em class=
6645 For most project types, the template extensions are: <em class=
6652 </p>
6656 component is defaulted, and a file is explicitly listed in the
6657 Template_Files section that happens to appear to MPC as a source
6658 file (i.e., has a source file extension, but does not have
6660 automatically exclude it from the <em class=
6662 </p>
6664 </div>
6666 <div>
6670 As with source files, the <em class=
6672 to allow it to generate defaults. Files that match the <em class=
6674 considered inline files.
6675 </p>
6679 has a special interaction with the <em class=
6684 inline file. If the matching inline file is found or would be
6685 generated from a custom command, it is added to the <em class=
6687 </p>
6689 </div>
6691 <div>
6695 As with source files, the <em class=
6697 to allow it to generate defaults. Files that match the <em class=
6700 considered header files.
6701 </p>
6705 has a special interaction with the <em class=
6710 file. If the matching header file is found or would be generated
6711 from a custom command, then it is added to the <em class=
6713 </p>
6715 </div>
6717 <div>
6721 The <em class=
6723 default to all files that end in the following: <em class=
6727 </p>
6729 </div>
6731 <div>
6737 component, if omitted, will default to only the files that end in
6739 project. For example, if a directory contains three <em class=
6744 list.
6745 </p>
6747 </div>
6749 <div>
6755 Custom Defined
6756 Files
6757 </em> components have a special interaction with the
6759 command generates source files and has the <em class=
6762 component list. If any of the files listed in the <em class=
6764 generated source file names, then none of the generated source
6765 file names will be automatically added to the <em class=
6767 </p>
6769 </div>
6771 <div>
6777 The example below uses the directory
6778 contents of <em class=
6780 illustrate the simplicity of mpc files:
6781 </p>
6783 <blockquote>
6786 Auto_Disconnect.cpp Loopback_Supplier.h
6787 RTEC_Initializer.cpp
6788 </p>
6791 Auto_Disconnect.h Low_Priority_Setup.cpp
6792 RTEC_Initializer.h
6793 </p>
6796 Auto_Disconnect.inl Low_Priority_Setup.h
6797 rtec_perf_export.h
6798 </p>
6801 Auto_Functor.cpp Low_Priority_Setup.inl
6802 RTEC_Perf.mpc
6803 </p>
6808 Auto_Functor.inl ORB_Holder.cpp
6809 RTPOA_Setup.h
6810 </p>
6813 Client_Group.cpp ORB_Holder.h
6814 RTPOA_Setup.inl
6815 </p>
6818 Client_Group.h ORB_Holder.inl
6819 RTServer_Setup.cpp
6820 </p>
6823 Client_Group.inl ORB_Shutdown.cpp
6824 RTServer_Setup.h
6825 </p>
6828 Client_Options.cpp ORB_Shutdown.h
6829 RTServer_Setup.inl
6830 </p>
6833 Client_Options.h ORB_Shutdown.inl
6834 Send_Task.cpp
6835 </p>
6838 Client_Pair.cpp ORB_Task_Activator.cpp
6839 Send_Task.h
6840 </p>
6843 Client_Pair.h ORB_Task_Activator.h
6844 Send_Task_Stopper.cpp
6845 </p>
6848 Client_Pair.inl ORB_Task_Activator.inl
6849 Send_Task_Stopper.h
6850 </p>
6853 Consumer.cpp ORB_Task.cpp
6854 Send_Task_Stopper.inl
6855 </p>
6866 EC_Destroyer.h PriorityBand_Setup.cpp
6867 Shutdown.h
6868 </p>
6871 EC_Destroyer.inl PriorityBand_Setup.h
6872 Shutdown.inl
6873 </p>
6876 Federated_Test.idl PriorityBand_Setup.inl
6877 Supplier.cpp
6878 </p>
6881 Implicit_Deactivator.cpp RIR_Narrow.cpp
6882 Supplier.h
6883 </p>
6886 Implicit_Deactivator.h RIR_Narrow.h
6887 SyncScope_Setup.cpp
6888 </p>
6891 Implicit_Deactivator.inl RT_Class.cpp
6892 SyncScope_Setup.h
6893 </p>
6896 Loopback_Consumer.cpp RT_Class.h
6897 SyncScope_Setup.inl
6898 </p>
6901 Loopback_Consumer.h RT_Class.inl
6902 TAO_RTEC_Perf.dsp
6903 </p>
6906 Loopback.cpp RTClient_Setup.cpp
6907 TAO_RTEC_Perf.dsw
6908 </p>
6911 Loopback.h RTClient_Setup.h
6912 Task_Activator.cpp
6913 </p>
6916 Loopback_Pair.cpp RTClient_Setup.inl
6917 Task_Activator.h
6918 </p>
6921 Loopback_Pair.h RTCORBA_Setup.cpp
6922 Task_Activator.inl
6923 </p>
6929 </blockquote>
6932 The following .mpc file (<em class=
6934 lines required to generate usable build tool project files.
6935 </p>
6937 <blockquote>
6940 project(RTEC_Perf): strategies, rtcorbaevent,
6941 minimum_corba {
6942 </p>
6947 idlflags +=
6948 -Wb,export_macro=TAO_RTEC_Perf_Export \
6949 </p>
6952 -Wb,export_include=rtec_perf_export.h
6953 </p>
6956 dllflags +=
6957 TAO_RTEC_PERF_BUILD_DLL
6958 </p>
6969 Low_Priority_Setup.cpp
6970 </p>
6985 </blockquote>
6988 A line-by-line explanation of the example mpc
6989 file is listed below.
6990 </p>
6992 <blockquote>
6995 project(RTEC_Perf): strategies, rtcorbaevent,
6996 minimum_corba {
6997 </p>
7000 </blockquote>
7003 The first line declares a project named
7005 projects listed after the colon.
7006 </p>
7008 <blockquote>
7013 </blockquote>
7016 Line two determines that the project is a
7017 library and the library name is <em class=
7019 </p>
7021 <blockquote>
7024 idlflags +=
7025 -Wb,export_macro=TAO_RTEC_Perf_Export \
7026 </p>
7031 </blockquote>
7034 Lines three and four add to the flags passed to
7035 the IDL compiler when processing the idl files.
7036 </p>
7038 <blockquote>
7043 </blockquote>
7046 Line five adds <em class=
7050 building shared libraries on platforms that support symbol
7051 visibility.
7052 </p>
7054 <blockquote>
7075 </blockquote>
7080 This usage of Template_Files refers to files containing C++ template declaration and
7081 definition source code and should not be confused with MPC <a href ="#MPD_Syntax">template files</a>
7082 which are used to define the structure of generated project files.
7083 </p>
7086 You may have noticed that there isn’t much
7087 to the file above. With the default behaviors that are built into
7088 MPC, there does not need to be. We rely on the defaults to
7093 do not follow the naming convention assumed by the MPC built-in defaults
7094 (_T.cpp, _T.cxx, _T.cc, _T.C),
7095 we must explicitly list them. We also
7096 rely on inheritance to get many of the TAO-related options.
7097 </p>
7100 </div>
7101 </div>
7102 </div>
7104 <div>
7106 <hr>
7109 If MPC does not support a particular build tool, you
7110 may want to consider adding a new project type. For instance, support
7111 could be added to MPC for Boost Jam, Xcode and many others. To do so
7112 will require knowledge of the MPC input files, as well as Object
7113 Oriented Perl.
7114 </p>
7117 <div>
7121 This section describes the syntax of the
7122 files that are used during project generation.
7123 </p>
7126 <div>
7129 (mpd)
7130 </h5>
7133 Template files make up the bulk of what
7134 MPC puts into each generated project file. They provide the plain
7135 text and the layout of the data provided by the mpc files, using
7136 various template directives.
7137 </p>
7140 Template directives are declared using a
7142 used to create if statements, for loops and to access variables.
7143 One thing to note is that any text, including white space, that
7145 untouched and is passed directly into the generated project
7146 file.
7147 </p>
7151 on a single line or it can span multiple lines. For example, the
7152 following line:
7153 </p>
7155 <blockquote>
7161 </p>
7164 </blockquote>
7167 is equivalent to:</li>
7169 <blockquote>
7182 </blockquote>
7187 can span multiple lines. As described below in the keywords
7189 the variable in a space-separated list context.
7190 </p>
7193 There are a couple of ways to write a <em class=
7195 the loop variable and then list each variable to be
7196 evaluated.
7197 </p>
7199 <blockquote>
7202 FILES=<%foreach(fvar, idl_files source_files
7204 </p>
7207 </blockquote>
7210 The second way is to let the <em class=
7212 this style, each value can be accessed via the first variable
7215 </p>
7217 <blockquote>
7220 FILES=<%foreach(idl_files source_files
7222 </p>
7225 </blockquote>
7228 Note that the <em class=
7236 e.g.,
7237 </p>
7239 <blockquote>
7244 </p>
7247 </blockquote>
7250 The following table lists keywords that can
7251 appear in template files.
7252 </p>
7260 <tr>
7263 </th>
7267 </th>
7268 </tr>
7270 <tr>
7273 <em class=
7275 </p>
7276 </td>
7280 Evaluates the variable name and
7281 removes the directory portion from that value.
7282 </p>
7283 </td>
7284 </tr>
7286 <tr>
7289 <em class=
7291 </p>
7292 </td>
7296 This is similar to <em class=
7298 removed from the variable name value.
7299 </p>
7300 </td>
7301 </tr>
7303 <tr>
7306 <em class=
7308 </p>
7309 </td>
7313 The value passed to comment is
7314 ignored and can be any set of characters, except a new
7315 line or a closing parenthesis.
7316 </p>
7317 </td>
7318 </tr>
7320 <tr>
7323 <em class=
7325 </p>
7326 </td>
7330 This function returns true if the
7331 variable value (first parameter) is equal to the string
7332 value (second parameter).
7333 </p>
7334 </td>
7335 </tr>
7337 <tr>
7340 <em class=
7342 </p>
7343 </td>
7347 This function returns true if the
7348 variable value (first parameter) contains the regular
7349 expression (second parameter).
7350 </p>
7351 </td>
7352 </tr>
7354 <tr>
7357 <em class=
7359 </p>
7360 </td>
7364 Dereference the variable passed as
7365 a parameter, treating its value as another variable
7366 name and returning that variable's value.
7367 </p>
7368 </td>
7369 </tr>
7371 <tr>
7374 <em class=
7376 </p>
7377 </td>
7381 Evaluates the variable name and
7383 value.
7384 </p>
7385 </td>
7386 </tr>
7388 <tr>
7391 <em class=
7393 </p>
7394 </td>
7398 This function returns a number based
7399 on the number of times a file with the same name (but
7400 different directory) is seen within a project. The
7401 function returns false upon the first occurrence of a
7402 file.
7403 </p>
7404 </td>
7405 </tr>
7407 <tr>
7411 </p>
7412 </td>
7416 Used with the <em class=
7418 block will be evaluated if the statement does not
7419 evaluate to true.
7420 </p>
7421 </td>
7422 </tr>
7424 <tr>
7428 </p>
7429 </td>
7433 Used with <em class=
7436 </p>
7437 </td>
7438 </tr>
7440 <tr>
7444 </p>
7445 </td>
7449 Used with the <em class=
7452 block.
7453 </p>
7454 </td>
7455 </tr>
7457 <tr>
7460 <em class=
7462 </p>
7463 </td>
7467 This function returns true if the
7468 variable value (first parameter) ends with the regular
7469 expression (second parameter).
7470 </p>
7471 </td>
7472 </tr>
7474 <tr>
7478 </p>
7479 </td>
7483 This is similar to eval in perl. The
7484 template variable passed to this function will be
7485 evaluated within the context of the current template.
7486 </p>
7487 </td>
7488 </tr>
7490 <tr>
7493 <em class=
7495 </p>
7496 </td>
7500 Returns a list of extensions based on
7501 the component name parameter (e.g., source_files,
7502 header_files, etc.)
7503 </p>
7504 </td>
7505 </tr>
7507 <tr>
7510 <em class=
7512 </p>
7513 </td>
7517 This is directly related to
7518 overriding the project-wide settings in an mpc file. It
7519 takes two variable names that are comma separated. The
7520 first corresponds to a file name and the second is any
7521 variable name.
7522 </p>
7523 </td>
7524 </tr>
7526 <tr>
7529 <em class=
7531 </p>
7532 </td>
7536 The given variable names are
7537 evaluated in a list context which is space separated.
7538 </p>
7539 </td>
7540 </tr>
7542 <tr>
7545 <em class=
7547 </p>
7548 </td>
7552 Used with <em class=
7556 </p>
7557 </td>
7558 </tr>
7560 <tr>
7563 <em class=
7565 </p>
7566 </td>
7570 Used with <em class=
7574 </p>
7575 </td>
7576 </tr>
7578 <tr>
7581 <em class=
7583 </p>
7584 </td>
7588 Used with <em class=
7592 first.
7593 </p>
7594 </td>
7595 </tr>
7597 <tr>
7600 <em class=
7602 </p>
7603 </td>
7607 Used with <em class=
7611 last.
7612 </p>
7613 </td>
7614 </tr>
7616 <tr>
7619 <em class=
7621 </p>
7622 </td>
7626 Returns full path of the value of the
7627 variable name passed a the parameter.
7628 </p>
7629 </td>
7630 </tr>
7632 <tr>
7635 <em class=
7637 </p>
7638 </td>
7642 Returns true is the variable value
7643 has a file extension.
7644 </p>
7645 </td>
7646 </tr>
7648 <tr>
7652 </p>
7653 </td>
7657 Used to determine if a variable is
7659 be used to invert the if check. This construct will only
7660 check for values defined within an mpc or mpt file.
7661 Default values (even those implemented by the project
7662 creators) are not considered in the <em class=
7664 </p>
7665 </td>
7666 </tr>
7668 <tr>
7671 <em class=
7673 </p>
7674 </td>
7678 This function is used to associate a
7679 key with a variable value. If the key has been associated
7680 with a variable value more than once, either through
7681 physical repetition of the key in the template or through
7682 evaluation of a foreach context, the count of association
7683 will be appended to the output.
7684 </p>
7685 </td>
7686 </tr>
7688 <tr>
7692 </p>
7693 </td>
7697 Return the given variable value in
7698 all lower case characters.
7699 </p>
7700 </td>
7701 </tr>
7703 <tr>
7707 </p>
7708 </td>
7712 This is directly related to the
7714 syntax. This can be used to designate markers within a
7715 template. Ex. <em class=
7717 </p>
7718 </td>
7719 </tr>
7721 <tr>
7724 <em class=
7726 </p>
7727 </td>
7731 This function returns true if the
7732 array parameter contains multiple values.
7733 </p>
7734 </td>
7735 </tr>
7737 <tr>
7740 <em class=
7742 </p>
7743 </td>
7747 Evaluates the variable name value as
7748 a file name and removes the extension from that value
7749 including the period.
7750 </p>
7751 </td>
7752 </tr>
7754 <tr>
7757 <em class=
7759 </p>
7760 </td>
7764 Convert spaces, dashes, slashes,
7765 dollar signs, parenthesis and dots in the given variable
7766 value to underscores.
7767 </p>
7768 </td>
7769 </tr>
7771 <tr>
7774 <em class=
7776 </p>
7777 </td>
7781 This function will remove a file in a
7782 component list. It requires three parameters. The first
7783 parameter is a component name (e.g., Source_Files), the
7784 second parameter is a regular expression pattern and
7785 the third parameter is a project or template variable
7786 name. The fourth and optional parameter allows you to
7787 alter the project or template variable value by
7788 removing the end matching portion. If the value of
7789 the project or template variable (i.e., parameter
7790 three) after being modified by parameter four and
7791 having the regular expression pattern (i.e.,
7792 parameter two) appended to it matches any value
7793 within the component list (named by parameter one), it
7794 will be removed from that component list and passed
7795 back.
7796 any
7797 </p>
7798 </td>
7799 </tr>
7801 <tr>
7804 <em class=
7806 </p>
7807 </td>
7811 This function reverses the order of
7812 the array parameter values.
7813 </p>
7814 </td>
7815 </tr>
7817 <tr>
7821 </p>
7822 </td>
7826 This is used to set the scope of
7827 execution of a function that will operate on the template
7828 output. A scope is begun by passing "enter" as the first
7829 parameter and a function name as the second parameter.
7830 Currently, the only function name supported is "escape".
7831 The third parameter specifies a string on which the
7832 function will operate. Any template text that matches the
7833 string parameter while within this scope will be
7834 transformed by the function parameter. A scope is then
7835 ended by passing "leave".
7836 </p>
7837 </td>
7838 </tr>
7840 <tr>
7844 </p>
7845 </td>
7849 This function is used to set or
7850 create a template variable. This function takes two
7851 parameters; the first is the template variable name
7852 and the second is the variable value.
7853 </p>
7854 </td>
7855 </tr>
7857 <tr>
7861 </p>
7862 </td>
7866 This function sorts the array
7867 parameter values.
7868 </p>
7869 </td>
7870 </tr>
7872 <tr>
7875 <em class=
7877 </p>
7878 </td>
7882 This function returns true if the
7883 variable value (first parameter) starts with the regular
7884 expression (second parameter).
7885 </p>
7886 </td>
7887 </tr>
7889 <tr>
7892 <em class=
7894 </p>
7895 </td>
7899 Replaces values within the directory
7900 portion of a variable value with something that can be
7901 used as a relative path. The current working directory is
7903 </p>
7904 </td>
7905 </tr>
7907 <tr>
7911 </p>
7912 </td>
7916 The first parameter to this function
7917 is the name of a variable. The second, optional,
7918 parameter is the operating system for which the
7919 project is being generated (e.g., linux, solaris,
7920 win32, etc.) It replaces $(...) found within the
7921 value of the variable with the equivalent environment
7922 variable reference based on the operating system.
7923 </p>
7924 </td>
7925 </tr>
7927 <tr>
7931 </p>
7932 </td>
7936 Return the given variable value in
7937 all upper case characters.
7938 </p>
7939 </td>
7940 </tr>
7942 <tr>
7946 </p>
7947 </td>
7951 Return the given variable value with
7952 the first letter of each word in upper case. Words are
7953 separated by spaces or underscores.
7954 </p>
7955 </td>
7956 </tr>
7958 <tr>
7962 </p>
7963 </td>
7967 This function returns the unique set
7968 of the array parameter values.
7969 </p>
7970 </td>
7971 </tr>
7972 </table>
7973 </p>
7976 The following table lists special names that can
7977 be used as variables in some template files. The variables listed
7978 in the <a href=
7979 "MakeProjectCreator.html#Common_Pseudo_Variables" class=
7982 </p>
7986 Special Values used in Template
7987 Files
7988 </h6>
7992 <tr>
7995 </th>
7999 </th>
8000 </tr>
8002 <tr>
8005 <em class=
8007 </p>
8008 </td>
8012 Implemented by the Automake project
8013 creator module, converts the <em class=
8015 automake.
8016 </p>
8017 </td>
8018 </tr>
8020 <tr>
8024 </p>
8025 </td>
8029 Implemented by the GNUACE project
8030 creator module, specifies that the project uses CIAO.
8031 </p>
8032 </td>
8033 </tr>
8035 <tr>
8038 <em class=
8040 </p>
8041 </td>
8045 Implemented by the Make project
8046 creator module, provides the compiler name based on the
8047 current project language.
8048 </p>
8049 </td>
8050 </tr>
8052 <tr>
8056 </p>
8057 </td>
8061 This value is implemented by the
8062 BMake project creator module. It returns a semicolon
8063 separated list of directories taken from each value in
8065 </p>
8066 </td>
8067 </tr>
8069 <tr>
8072 <em class=
8074 </p>
8075 </td>
8079 Contains a list of the custom build
8080 types. See <a href=
8081 "MakeProjectCreator.html#Custom_Types" class=
8083 </p>
8084 </td>
8085 </tr>
8087 <tr>
8091 </p>
8092 </td>
8096 The full current working
8097 directory.
8098 </p>
8099 </td>
8100 </tr>
8102 <tr>
8105 <em class=
8107 </p>
8108 </td>
8112 This only has a value within the
8114 1 based count, by default, of the index of the elements
8116 </p>
8117 </td>
8118 </tr>
8120 <tr>
8124 </p>
8125 </td>
8129 This value is implemented by the VC7
8130 and WIX project creator modules. It returns a <em class=
8132 usable within VC7, VC71, VC8, VC9, VC10, VC11, VC12, and WIX project
8133 files.
8134 </p>
8135 </td>
8136 </tr>
8138 <tr>
8141 <em class=
8143 </p>
8144 </td>
8148 This value is implemented by the VC7
8149 and Make project creator modules. It returns the current
8150 language setting for the project.
8151 </p>
8152 </td>
8153 </tr>
8155 <tr>
8158 <em class=
8160 </p>
8161 </td>
8165 This value is implemented by the VC6
8166 and EM3 project creator modules. It returns the project
8167 name with the make file extension that corresponds to the
8168 particular project type.
8169 </p>
8170 </td>
8171 </tr>
8173 <tr>
8176 <em class=
8178 </p>
8179 </td>
8183 This variable contains the name of
8184 the output file for the current project being
8185 generated.
8186 </p>
8187 </td>
8188 </tr>
8190 <tr>
8193 <em class=
8195 </p>
8196 </td>
8200 This variable contains the name of
8201 the current project being generated.
8202 </p>
8203 </td>
8204 </tr>
8206 <tr>
8210 </p>
8211 </td>
8215 This value is implemented by the
8216 BMake project creator module. It returns a semicolon
8217 separated list of directories taken from each value in
8219 </p>
8220 </td>
8221 </tr>
8223 <tr>
8226 <em class=
8228 </p>
8229 </td>
8233 This value is implemented by the WIX
8234 project creator module. It converts the variable portion
8235 of the binary output directory (either <em class=
8238 WIX.
8239 </p>
8240 </td>
8241 </tr>
8243 <tr>
8247 </p>
8248 </td>
8252 Implemented by the GNUACE project
8253 creator module, specifies that the project uses TAO.
8254 </p>
8255 </td>
8256 </tr>
8258 <tr>
8261 <em class=
8263 </p>
8264 </td>
8268 This value is implemented by the
8269 VC7ProjectCreator. It returns the version number of the
8270 type of project being generated. 7.00 is return for vc7,
8274 14.0 is returned for vc14, 14.1 is returned for vs2017, 14.2 is returned for vs2019, 14.3 is returned for vs2022.
8275 </p>
8276 </td>
8277 </tr>
8279 <tr>
8283 </p>
8284 </td>
8288 This value is implemented by the
8289 GNUACEProjectCreator. It returns a value, based on the
8290 location of the source files, that specifies the
8292 </p>
8293 </td>
8294 </tr>
8295 </table>
8296 </p>
8303 Template Variable Documentation
8304 </h6>
8305 </p>
8308 Template variables used within the MPC templates
8309 are numerous and vary from template to template; there are far
8310 too many to include in this document. However, you can generate
8311 an HTML document containing all of the template variables used
8312 within a template using the <em class=
8315 may find that some templates and individual template variables
8316 are well documented and, unfortunately, some are not.
8317 </p>
8320 The script will generate documentation for an
8321 individual template file. The usage is as follows:
8322 </p>
8324 <blockquote>
8331 </p>
8336 template - .mpd file to document. Certain MPC types don't
8337 use a template,
8338 </p>
8341
8342 in that case this argument can be the Perl module.
8343 </p>
8346 outputfile - This defaults to the name of the
8347 template file with the .mpd
8348 </p>
8351
8352 extension replaced with
8354 </p>
8357
8358 the output is in text
8359 format similar to what is found in
8360 </p>
8363
8364 .../docs/templates.
8365 </p>
8368 language - This defaults to
8369 the language for which the template is designed.
8370 </p>
8373
8374 It can be any of the valid
8375 language settings for MPC:
8376 </p>
8379
8380 cplusplus csharp java
8381 vb
8382 </p>
8383 </blockquote>
8386 <div>
8392 To support multiple custom build types,
8393 a special keyword was introduced. The <em class=
8395 custom types defined by the user. In a <em class=
8398 </p>
8401 A variety of information is available from
8404 command, command output option, command flags, and output file
8405 directory are all accessible through the field names that
8406 correspond to the particular type.
8407 </p>
8410 The input files associated with the custom
8411 type are accessed through <em class=
8413 set of output files associated with it which can be accessed in
8416 custom type fields are those listed in the <a href=
8418 Define_Custom
8419 Keywords
8420 </a> table as well as those listed in the following
8421 table.
8422 </p>
8428 <tr>
8431 </th>
8435 </th>
8436 </tr>
8438 <tr>
8441 <em class=
8443 </p>
8444 </td>
8448 The files on which the processing
8449 of the custom input file depends.
8450 </p>
8451 </td>
8452 </tr>
8454 <tr>
8457 <em class=
8459 </p>
8460 </td>
8464 The output directory associated
8465 with a particular input file. This field has no meaning
8466 when accessed directly through the <em class=
8468 within the context of a <em class=
8471 Template
8472 File Keywords
8473 </a>).
8474 </p>
8475 </td>
8476 </tr>
8478 <tr>
8481 <em class=
8483 </p>
8484 </td>
8488 The input files associated with the
8489 custom type.
8490 </p>
8491 </td>
8492 </tr>
8494 <tr>
8497 <em class=
8499 </p>
8500 </td>
8504 The input file extensions
8505 associated with the custom type.
8506 </p>
8507 </td>
8508 </tr>
8510 <tr>
8513 <em class=
8515 </p>
8516 </td>
8520 All output files generated from the
8521 custom input file that are not considered source code
8522 files by MPC.
8523 </p>
8524 </td>
8525 </tr>
8527 <tr>
8530 <em class=
8532 </p>
8533 </td>
8537 All output files generated from the
8538 custom input file.
8539 </p>
8540 </td>
8541 </tr>
8543 <tr>
8546 <em class=
8548 </p>
8549 </td>
8553 All output files generated from the
8554 custom input file that are considered source code files
8555 by MPC.
8556 </p>
8557 </td>
8558 </tr>
8559 </table>
8560 </p>
8563 The example below, which creates generic
8564 makefile rules for building custom input files, shows basic use
8565 of the custom type and the various fields that can be accessed.
8567 keyword, as can be seen below, is that the <em class=
8569 "MakeProjectCreator.html#foreach_syntax" class=
8571 </lpi>
8573 <blockquote>
8581 </p>
8585 </p>
8590 </p>
8595 </p>
8608 </blockquote>
8611 Certain project types don't support the same
8612 input file used by multiple custom types (current examples of
8613 this are vc10, vc11, vc12, vc14, vs*, cdt6, and cdt7). To accommodate these types, MPC
8614 has a capability called "combined custom". With this capability
8615 enabled in the specific ProjectCreator, MPC will "fold together"
8616 the multiple custom steps so that the target tool (Visual Studio
8617 or Eclipse CDT) sees it as a single custom step that happens to
8618 run two or more commands. When "combined custom" is enabled,
8619 the template needs to be written for it by checking if
8621 non-empty. If it isn't empty, the values in it can be iterated
8623 iteration, the following values can be obtained by the template.
8624 Each one would appear in the template preceded by
8626 </p>
8630 Custom Type Fields for Combined
8631 Custom
8632 </h6>
8635 <tr>
8638 </th>
8642 </th>
8643 </tr>
8645 <tr>
8648 <em class=
8650 </p>
8651 </td>
8655 The effective command, taking into
8657 </p>
8658 </td>
8659 </tr>
8661 <tr>
8664 <em class=
8666 </p>
8667 </td>
8671 The <em class=
8673 command, taking into account the
8675 </p>
8676 </td>
8677 </tr>
8679 <tr>
8682 <em class=
8684 </p>
8685 </td>
8689 The first output file for this
8690 particular command (for use with
8692 </p>
8693 </td>
8694 </tr>
8696 <tr>
8699 <em class=
8701 </p>
8702 </td>
8706 The <em class=
8708 command, taking into account the
8710 </p>
8711 </td>
8712 </tr>
8714 <tr>
8717 <em class=
8719 </p>
8720 </td>
8724 The <em class=
8726 command.
8727 </p>
8728 </td>
8729 </tr>
8731 <tr>
8734 <em class=
8736 </p>
8737 </td>
8741 The original type of file for this command.
8742 </p>
8743 </td>
8744 </tr>
8746 </table>
8747 </p>
8750 </div>
8752 <div>
8756 File grouping is part of the syntax of
8757 mpc files. If a set of files are grouped within the mpc file,
8758 they can be accessed as a group within the mpd file.
8759 </p>
8762 Files (such as <em class=
8764 can be grouped together as shown <a href=
8765 "MakeProjectCreator.html#MPC%20grouping%20example" class=
8770 </p>
8776 <tr>
8779 </th>
8783 </th>
8784 </tr>
8786 <tr>
8789 <em class=
8791 </p>
8792 </td>
8796 The input files associated with the
8797 group.
8798 </p>
8799 </td>
8800 </tr>
8802 <tr>
8805 <em class=
8807 </p>
8808 </td>
8812 The name of the set of multiple
8813 groups of files.
8814 </p>
8815 </td>
8816 </tr>
8817 </table>
8818 </p>
8821 The example below, which creates make macros
8822 for each file group, shows basic use of grouping and the fields
8823 that can be accessed. The main limitation with file grouping,
8825 variable cannot be named as stated <a href=
8826 "MakeProjectCreator.html#foreach_syntax" class=
8830 can be used.
8831 </li>
8833 <blockquote>
8838 <%comment(Get back each set of grouped
8839 files)%>
8840 </p>
8845 <%comment(This will provide the name of
8846 the group)%>
8847 </p>
8852 <%comment(Get all the source files in a
8853 single group)%>
8854 </p>
8858 </p>
8861 <%grouped_source_file->file)%><%fornotlast("
8863 </p>
8872 ifndef
8874 </p>
8878 </p>
8885 </p>
8894 </blockquote>
8896 </div>
8897 </div>
8899 <div>
8903 Template input files provide build tool
8904 specific information that is common to all projects, such as
8905 compiler switches, intermediate directories, compiler macros,
8906 etc. Each project type can provide template input files for
8907 dynamic libraries, static libraries, dynamic executables and
8908 static executables. However, none of these are actually required
8909 by MPC.
8910 </p>
8913 The template input files are more free-form than
8914 the other MPC file types. It is similar to the mpc syntax except
8915 that there is no project definition and there is only one
8917 is used to include other mpt files if they can be found in the
8918 MPC include search path. If the name listed in double quotes
8920 is ignored and no warning is produced. The <em class=
8922 provided.
8923 </p>
8926 The template input files contain variable
8927 assignments and collections of variable assignments. A variable
8928 assignment is of the form:
8929 </p>
8931 <blockquote>
8938 </blockquote>
8941 This variable can then be used within the
8942 corresponding mpd file.
8943 </p>
8946 Variable assignments can be grouped together and
8947 named within the mpt file and used as scoped variables within the
8948 mpd file. The following example shows the use of collections of
8949 variable assignments.
8950 </p>
8952 <blockquote>
8965 compile_flags = /W3 /GX /O2 /MD
8966 /GR
8967 </p>
8978 compile_flags = /W3 /Gm /GX /Zi /Od
8979 /MDd /GR /Gy
8980 </p>
8991 </blockquote>
8994 Below is the portion of the mpd file that would
8995 use the information provided in the mpt file above.
8996 </p>
8998 <blockquote>
9007 </p>
9014 </blockquote>
9017 The following output is generated from the above
9018 example:
9019 </p>
9021 <blockquote>
9027 _CONSOLE=1
9028 </p>
9035 /W3 /Gm /GX /Zi /Od /MDd /GR /Gy /D _DEBUG=1 /D
9037 </p>
9040 </blockquote>
9044 value corresponds to a variable group name, that variable group
9045 is available within the scope of that <em class=
9047 </p>
9052 </div>
9053 </div>
9055 <div>
9059 We will discuss what it would take to add
9060 support for a fictional build tool throughout this section. The
9063 relationship between the template and project creator discussed
9064 below.
9065 </p>
9068 <div>
9072 The best thing to do is to start with the
9073 template. The template is the most important piece when adding a
9074 new project type. It basically tells MPC how to lay out all of
9075 the information it gathers while processing an mpc file. The
9076 template file will have a mixture of plain text and the mpd
9077 syntax described in the <a href=
9079 Template
9080 Files
9083 </p>
9085 <blockquote>
9087 //=======================================================================
9088 </p>
9093 // CAUTION! Hand edit only if you know what you
9094 are doing!
9095 </p>
9098 //=======================================================================
9099 </p>
9237 </p>
9242 // User targets section. Following lines will
9243 be
9244 </p>
9247 // inserted into Makefile right after the
9248 generated cleanall target.
9249 </p>
9252 // The Project File editor does not edit these
9253 lines - edit the .vpj
9254 </p>
9257 // directly. You should know what you are
9258 doing.
9259 </p>
9286 </blockquote>
9289 Note that output is generated differently
9293 statements that were used with relation these variable names.
9294 Also, certain portions of the project file are only generated if
9295 particular variables are set.
9296 </p>
9298 </div>
9300 <div>
9304 Next, you would write the <em class=
9307 and edit it. Change the package name to <em class=
9311 needed for this particular type.
9312 </p>
9314 <blockquote>
9320 #
9321 ************************************************************
9322 </p>
9331 #
9332 ************************************************************
9333 </p>
9338 #
9339 ************************************************************
9340 </p>
9345 #
9346 ************************************************************
9347 </p>
9368 #
9369 ************************************************************
9370 </p>
9375 #
9376 ************************************************************
9377 </p>
9442 </blockquote>
9445 In our example, we inherit from the
9446 MakeProjectBase which provides some methods that are common to
9448 </p>
9451 We override the <em class=
9453 value tells MPC not to convert slashes to back slashes
9454 (converting slashes is useful for Windows related build
9455 tools).
9456 </p>
9459 We then override the <em class=
9461 file extension which is used by a method defined in the
9462 MakeProjectBase module.
9463 </p>
9466 Next, we override the <em class=
9469 return the specific template input file names for a dynamic
9470 executable and dynamic library, respectively.
9471 </p>
9474 Lastly, we override the <em class=
9476 for our new project type. In our case, the method returns
9478 the template file we created earlier.
9479 </p>
9482 There are many other methods that can be
9483 overridden to change the way MPC generates output. For a complete
9487 </p>
9489 </div>
9491 <div>
9495 The last part that you would need to write
9497 module is usually more code-intensive than its Project Creator
9498 counterpart.
9499 </p>
9501 <blockquote>
9507 #
9508 ************************************************************
9509 </p>
9512 # Description : A Fictional Workspace
9513 Creator
9514 </p>
9521 #
9522 ************************************************************
9523 </p>
9528 #
9529 ************************************************************
9530 </p>
9535 #
9536 ************************************************************
9537 </p>
9558 #
9559 ************************************************************
9560 </p>
9565 #
9566 ************************************************************
9567 </p>
9576 return
9578 '.fws');
9579 </p>
9598 </p>
9602 MPC Command -->', $crlf,
9603 </p>
9607 $0 @ARGV -->", $crlf;
9608 </p>
9621 my $projects =
9622 $self->get_projects();
9623 </p>
9626 my @list =
9627 $self->sort_dependencies($projects);
9628 </p>
9636 $crlf;
9637 </p>
9644 </p>
9649 print $fh
9650 "</projects>$crlf";
9651 </p>
9664 </blockquote>
9667 The first method we override from
9668 WorkspaceCreator.pm is the <em class=
9670 the output file for the generated workspace.
9671 </p>
9674 Second, we override the <em class=
9676 generic unchanging section of our generated workspace.
9677 </p>
9680 Lastly, we override the <em class=
9682 the work is done in our workspace creator. A workspace creator
9683 has many sets of data available. A reference to the list of
9684 project file names can be obtained through the <em class=
9687 method which returns an array reference where each array element
9688 is an array containing the project name, project dependencies and
9689 a project guid (if applicable).
9690 </p>
9692 </div>
9693 </div>
9694 </div>
9695 </div>
9696 </body>
9697 </html>