1 <!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en">
4 <meta content="text/html; charset=iso-8859-1" http-equiv="content-type">
5 <meta content="Fred T. Hamster" name="Author">
6 <meta name="generator" content="Mozilla/5.0 (X11; U; Linux i686; en-US) [Mozilla]">
7 <title>CLAM Reference Manual</title>
9 <body link="#33ff33" text="#ffff99" vlink="#009900" bgcolor="#400080" alink="#ff9900">
12 <h1><big>CLAM: Coordinated Librarian &</big></h1>
13 <h1><big>Automatic Maker</big></h1>
14 <small></small></center>
15 <center><big><img src="../../infobase/pictures/clams_tran.gif" height="347" width="392"></big></center>
18 <h2><big>Tutorial and Reference Manual</big></h2>
19 <small></small></center>
22 <address><big><a name="lib_manager"></a>By Chris Koeritz (<a href="mailto:koeritz@gruntose.com">koeritz@gruntose.com</a>)</big></address>
23 <small></small></center>
27 <hr noshade="noshade" size="8" width="100%"></h2>
28 <small></small></center>
31 <h2><big>Table of Contents</big></h2>
32 <small></small></center>
34 <small> </small><big> </big><small> </small>
35 <li><big> <a href="#EXECUTIVE_SUMMARY">Executive Summary</a></big></li>
36 <small> </small><big> </big><small> </small>
37 <li><big> <a href="#PREPARATION">Preparing Your Computer to Use
39 <small> </small><big> </big><small> </small>
41 <small> </small><big> </big><small> </small>
42 <li><big> <a href="#STEPS_NEEDED">Necessary Steps</a></big></li>
43 <small> </small><big> </big><small> </small>
45 <small> </small><big> </big><small> </small>
46 <li><big> <a href="#TUTORIAL">CLAM Tutorial</a></big></li>
47 <small> </small><big> </big><small> </small>
49 <small> </small><big> </big><small> </small>
50 <li><big> <a href="#CAVEATS">Caveats</a></big></li>
51 <small> </small><big> </big><small> </small>
52 <li><big> <a href="#TUT_BASICS">Basics</a></big></li>
53 <small> </small><big> </big><small> </small>
54 <li><big> <a href="#TUT_COMMON">Common Files</a></big></li>
55 <small> </small><big> </big><small> </small>
56 <li><big> <a href="#TUT_IMPORTANT_VARS">Important Variables</a></big></li>
57 <small> </small><big> </big><small> </small>
58 <li><big> <a href="#TUT_VAR_ASSIGN">Variable Assignment</a></big></li>
59 <small> </small><big> </big><small> </small>
60 <li><big> <a href="#TUT_OPTIONAL_VARS">Optional Variables</a></big></li>
61 <small> </small><big> </big><small> </small>
62 <li><big> <a href="#WRITING_RULES">Writing Your Own Rules</a></big></li>
63 <small> </small><big> </big><small> </small>
64 <li><big> <a href="#TUT_CONCLUSION">Conclusion</a></big></li>
65 <small> </small><big> </big><small> </small>
67 <small> </small><big> </big><small> </small>
68 <li><big> <a href="#REFERENCE">CLAM Reference</a></big></li>
69 <small> </small><big> </big><small> </small>
71 <small> </small><big> </big><small> </small>
72 <li><big> <a href="#LANG_INDEP_VARS">Language Independent
73 Variables</a></big></li>
74 <small> </small><big> </big><small> </small>
75 <li><big> <a href="#LANG_INDEP_RULES">Language Independent
77 <small> </small><big> </big><small> </small>
78 <li><big> <a href="#LANG_INDEP_TARGETS">Language Independent
79 Targets</a></big></li>
80 <small> </small><big> </big><small> </small>
81 <li><big> <a href="#LANG_INDEP_SCRIPTS">Language Independent
83 <small> </small><big> </big><small> </small>
84 <li><big> <a href="#CPP_VARS">C++ Specific Variables</a></big></li>
85 <small> </small><big> </big><small> </small>
87 <small> </small><big> </big><small> </small>
88 <li><big> <a href="#DIRECTORY_VARS">Directory Structure
89 Variables</a></big></li>
90 <small> </small><big> </big><small> </small>
91 <li><big> <a href="#CPP_FLAGS">Compiler Dependent Flags</a></big></li>
92 <small> </small><big> </big><small> </small>
93 <li><big><a href="#vcpp_only">Microsoft Visual C++ Only</a><br>
95 <small> </small><big> </big><small> </small>
96 <li><big> <a href="#SUPPORT_EXTENSIONS">Support for
98 Extensions</a></big></li>
99 <small> </small><big> </big><small> </small>
101 <small> </small><big> </big><small> </small>
102 <li><big> <a href="#CPP_RULES">C++ Specific Rules</a></big></li>
103 <small> </small><big> </big><small> </small>
104 <li><big> <a href="#CPP_TARGETS">C++ Specific Targets</a></big></li>
105 <small> </small><big> </big><small> </small>
106 <li><big> <a href="#CPP_SCRIPTS">C++ Specific Files</a></big></li>
107 <small> </small><big> </big><small> </small>
109 <small> </small><big> </big><small> </small>
110 <li><big> <a href="#EXAMPLES">Example CLAM Makefiles</a></big></li>
111 <small> </small><big> </big><small> </small>
112 <li><big> <a href="#CLAM_HINTS">CLAM Hints and Troubleshooting</a></big></li>
113 <small> </small><big> </big><small> </small>
114 <li><big> <a href="#ACKS">Acknowledgements</a></big></li>
115 <small> </small><small></small>
118 </big><small></small>
120 <hr noshade="noshade" size="8" width="100%"></h2>
121 <small></small></center>
123 </big><small></small>
124 <h2><big><a name="EXECUTIVE_SUMMARY"></a>Executive Summary</big></h2>
125 <small></small></center>
126 <big> The CLAM system is a set of macros and rules
127 for the GNU make program
129 simplifies the creation of executable programs and code
131 Most makefiles that use the CLAM system are ten lines long or
133 Makefiles are stated in terms of a set of special variable names that
135 interprets in order to issue the correct sequence of compilation
137 This document presents a tutorial on the variable names and simple
139 that need to be used with CLAM. Several example makefiles and the
141 reference manual for CLAM are also included.<br>
142 CLAM is part of the Feisty Meow® codebase (<a href="http://feistymeow.org/">http://feistymeow.org/</a>)
144 downloaded from there or through a sourceforge mirror site.<br>
145 In the remainder of the document, we will often
146 refer to CLAM as just "clam".<br>
149 <center><small></small>
151 <hr noshade="noshade" size="8" width="100%"></h2>
152 <small></small></center>
154 </big><small></small>
155 <h2><big><a name="PREPARATION"></a>Preparing Your Computer to Use
157 <small></small></center>
158 <h3><big><a name="STEPS_NEEDED"></a>Necessary Steps:</big></h3>
160 <small> </small><big> </big><small> </small>
161 <li><big>Setting environment variables for clam:</big></li>
162 <small> </small><big> </big><small> </small>
164 <li><big>FEISTY_MEOW_APEX:</big></li>
165 <small> </small><big> </big><small> </small>
167 <small> </small><big> </big><small> </small>
168 <li><big> **REVISE** out of date... This variable has been needed
170 part of the YETIcode project (at <a href="http://yeticode.org/">http://yeticode.org</a>).</big></li>
172 <li><big>The default location for clam is under the FEISTY_MEOW_SCRIPTS directory in a
173 folder named clam.<br>
175 <small> </small><big> </big><small> </small>
176 <li><big>If the yeti root directory is in $HOME/yeti
178 default for FEISTY_MEOW_APEX will work and it doesn't need to be
180 <li><big>Setting the variable:<br>
182 <small> </small><big> </big><small> </small>
184 <small> </small><big> </big><small> </small>
185 <li><big>On Unix (with the bash shell): <span style="font-weight: bold;">export
186 MAKEFLAGS="-I $HOME/yeti/clam"</span></big></li>
187 <small> </small><big> </big><small> </small>
188 <li><big>On win32: <span style="font-weight: bold;">set
189 MAKEFLAGS="-I c:/yeti/clam"</span> (or set this in the
191 control panel, under the advanced tab, in environment variables)<span
192 style="font-weight: bold;"><br>
194 <small> </small><big> </big><small> </small>
195 <li><big>Note that the use of
196 forward slashes is mandatory in the clam directory in MAKEFLAGS.<br>
198 <small> </small><big> </big><small> </small>
200 <small> </small><big> </big><small> </small>
202 <small> </small><big> </big><small> </small>
203 <li><big>MAKEFLAGS:</big></li>
204 <small> </small><big> </big><small> </small>
206 <small> </small><big> </big><small> </small>
207 <li><big> This variable is required to be set in the
208 environment before using clam with gnu-make. It tells make
210 to find the clam definitions and scripts.</big></li>
212 <li><big>Setting the variable:<br>
214 <small> </small><big> </big><small> </small>
216 <small> </small><big> </big><small> </small>
217 <li><big>On Unix (assuming bash as shell): <span style="font-weight: bold;">export
218 MAKEFLAGS="-I $FEISTY_MEOW_APEX/clam"</span></big></li>
219 <small> </small><big> </big><small> </small>
220 <li><big>On win32: <span style="font-weight: bold;">set
221 MAKEFLAGS="-I %FEISTY_MEOW_APEX%/clam"</span></big></li>
222 <small> </small><big> </big><small> </small>
223 <li><big>This variable also requires forward slashes
225 backslashes.</big></li>
226 <small> </small><big> </big><small> </small>
228 <small> </small><big> </big><small> </small>
233 <li><big>Required Tools:</big></li>
234 <small> </small><big> </big><small> </small>
236 <small> </small><big> </big><small> </small>
237 <li><big>The compiler itself:<br>
239 <small> </small><big> </big><small> </small>
241 <small> </small><big> </big><small> </small>
242 <li><big>If you are running GNU/Linux (or almost any other
243 Posix-compliant operating system), then the GNU C/C++ compiler
244 suite is pretty much all that's needed.</big></li>
245 <small> </small><big> </big><small> </small>
247 GNU C/C++ compiler (included in the <a href="http://www.mingw.org/">MinGW</a>
248 toolkit) should be all that's needed for
250 but the Microsoft Visual Studio 6.0-8.0 compilers can be used if
251 available. Compatibility is only guaranteed for vc8
254 <small> </small><big> </big><small> </small>
256 <small> </small><big> </big><small> </small>
257 <li><big>Win32 Unix Tools:</big></li>
258 <small> </small><big> </big><small> </small>
260 <small> </small><big> </big><small> </small>
261 <li><big> If you are running a win32-based product
265 windows xp, etc) then a few additional tools are required...<br>
267 <small> </small><big> </big><small> </small><small></small>
268 <li><big>The recommended GNU utilities are available for
271 package (http://www.mingw.org/).</big></li>
272 <li><big>Note that you will need to add the binaries directory from
274 your path. The PATH variable can be accessed under MS-NT
275 type OSes through the
276 "control panel | system | advanced | environment variables" menu
278 plan to use msys outside of clam, then ensure that
279 the MSYS bin directory is prior to the
280 windows system directory in your path; this causes the Unix "find"
281 command to be used instead of the Windows version.</big></li>
282 <li><big>Alternatively, a similar set of GNU utilities is
284 in the <a href="http://cygwin.com/">Cygwin package</a>, although
285 these tools are no longer recommended and are, in
286 fact, actively deprecated.</big></li>
287 <small> </small><big> </big><small> </small>
289 <small> </small><big> </big><small> </small>
291 <small> </small><big> </big><small> </small>
293 <small> </small><big> </big><small> </small>
294 <li><big>makedep and version_stamper tools:</big></li>
295 <small> </small><big> </big><small> </small>
297 <small> </small><big> </big><small> </small>
298 <li><big>The hoople/bin directory in the archive has
300 versions of tools used by clam during a build.<br>
302 <small> </small><big> </big><small> </small>
303 <li><big>If you would rather rebuild them from source, then
305 the script "scripts/generator/produce_feisty_meow.sh" will
306 recreate all of these internal tools.<br>
308 <small> </small><big> </big><small> </small>
310 <small> </small><big> </big><small> </small>
312 <small> </small><big> </big><small> </small>
313 <li><big>Third Party Tools Used By or Supported Within clam:</big></li>
314 <small> </small><big> </big><small> </small>
316 <small> </small><big> </big><small> </small>
317 <li><big>wx widgets:</big></li>
318 <small> </small><big> </big><small> </small>
320 <small> </small><big> </big><small> </small>
321 <li><big>home page: http://www.wxwidgets.org/</big></li>
322 <small> </small><big> </big><small> </small>
323 <li><big>As far as the clam team is concerned, this is the
325 portable (and open source) library for graphical user interfaces.<br>
327 <small> </small><big> </big><small> </small>
329 <small> </small><big> </big><small> </small>
330 <li><big>OpenSSL:</big></li>
331 <small> </small><big> </big><small> </small>
333 <small> </small><big> </big><small> </small>
334 <li><big>home page: http://www.openssl.org/</big></li>
335 <small> </small><big> </big><small> </small>
336 <li><big>This is the team's most favorite library for SSL
338 Sockets Layer) and general encryption needs.<br>
340 <small> </small><big> </big><small> </small>
342 <small> </small><big> </big><small> </small>
343 <li><big>cURL:</big></li>
344 <small> </small><big> </big><small> </small>
346 <small> </small><big> </big><small> </small>
347 <li><big>home page: http://curl.haxx.se/</big></li>
348 <small> </small><big> </big><small> </small>
349 <li><big>The curl library rocks(!) and provides a very
351 tools for programmatically interacting with live web pages.<br>
353 <small> </small><big> </big><small> </small>
355 <small> </small><big> </big><small> </small>
357 <small> </small><big> </big><small> </small>
358 <li><big>Other clam Preconditions:</big></li>
359 <small> </small><big> </big><small> </small>
361 <small> </small><big> </big><small> </small>
362 <li><big>Linux platforms:</big></li>
363 <small> </small><big> </big><small> </small>
365 <small> </small><big> </big><small> </small>
366 <li><big>The standard source code repository is a directory
369 in the user's home directory. If you decompress the hoople
370 library archive in your home directory, you should be all set to
371 perform a build.</big></li>
372 <small> </small><big> </big><small> </small>
373 <li><big>See the HOOPLE website for more details about
374 downloading that codebase (<a href="http://feistymeow.org">http://feistymeow.org</a>).<br>
376 <small> </small><big> </big><small> </small>
378 <small></small><small></small>
380 <small> </small><big> </big><small> </small>
382 <small> </small><big> </big><small> </small>
383 <li><big>Win32 platforms:</big></li>
384 <small> </small><big> </big><small> </small>
386 <small> </small><big> </big><small> </small>
387 <li><big>The standard repository for source code is a substituted
388 drive l:, which is where all the other hierarchies start.
390 drive can be mapped to any folder desired using the "subst"
392 (for example, "subst l: c:\build_dir").
394 objects and final products will be generated to the l: drive.</big></li>
395 <small> </small><big> </big><small> </small>
396 <li value="2"><big>Using MS Visual Studio as the Compiler:</big></li>
397 <small> </small><big> </big><small> </small>
399 <small> </small><big> </big><small> </small>
400 <li><big>VS80COMNTOOLS/VS90COMNTOOLS/VS100COMNTOOLS variable:</big></li>
401 <small> </small><big> </big><small> </small>
403 <small> </small><big> </big><small> </small>
404 <li><big>This variable should be automatically created by
405 Visual Studio upon installation. If it isn't, then
407 a bug or you need to restart your current prompt or your
410 <li><big>The paths that clam uses to find compiler binaries
411 is calculated based on this variable.</big></li>
412 <li><big>Older versions of visual studio are currently
413 unsupported because Microsoft constantly rearranges their
415 tools in a non-maintainable way.<br>
418 <li><big>Several other environment variables are required
420 Studio. They can be set up for your current command prompt
422 running "vcvars32.bat" or "vsvars32.bat" (found under
424 compiler's common directory, which varies depending on the
428 <small> </small><big> </big><small> </small>
430 <small> </small><big> </big><small> </small>
432 <small> </small><big> </big><small> </small>
434 <small> </small><small></small>
437 </big><small></small>
439 <hr noshade="noshade" size="8" width="100%"></h2>
440 <small></small></center>
442 </big><small></small>
443 <h2><big><a name="TUTORIAL"></a>CLAM Tutorial</big></h2>
444 <small></small></center>
445 <big> This section provides an overview of
447 works and how you can make it work for you. It is quite brief,
449 should suffice for most common cases of makefiles. For more
451 usage, consult the CLAM Reference section of this document.
453 <h3><big><a name="CAVEATS"></a>Caveats</big></h3>
455 <small> </small><big> </big><small> </small>
456 <li><big>Most of the Unix tools employed in the make process are
457 case-sensitive.
458 This means that they will probably not find any of the clam support if
459 the files have been changed to upper-case names. It also means
461 all code files must match their descriptions in makefiles, letter for
463 And any batch files or executables invoked also need to be in
465 as clam expects them to be.</big></li>
466 <small> </small><big> </big><small> </small>
467 <li><big>A corollary case requirement is that the makefile must
470 "makefile" or "Makefile". These are the Unix standard names and
472 looks for these by default. If you are willing to type "make -f
473 <i>makefile_name</i>",
474 then you can run any makefile. However, the build-ready
476 should be named according to the standard, since the build process
478 look for these automatically.</big></li>
479 <small> </small><small></small>
482 <a name="TUT_BASICS"></a>Basics</big></h3>
483 <big> The C++ Library
484 Automatic Maker system (or CLAM) is defined as a set of
486 (or macro) definitions. These variable definitions are
488 order to compile and link programs. By setting the variables'
490 appropriately, specific products can be generated from the target rules
492 in clam. Both variables and rules are extensible. The
494 procedure for building a clam-based Makefile has four user-defined
498 <small> </small><big> </big><small> </small>
499 <li><big>loading the default variables for clam,</big></li>
500 <small> </small><big> </big><small> </small>
501 <li><big>redefining the default variables where necessary,</big></li>
502 <small> </small><big> </big><small> </small>
503 <li><big>loading the default rule set for clam,</big></li>
504 <small> </small><big> </big><small> </small>
505 <li><big>defining rules that are local to the user's Makefile.</big></li>
506 <small> </small><small></small>
508 <big>Step 4 can usually be omitted unless the project creates
510 whose types are not supported by clam.<br>
511 clam is structured as a directory hierarchy
512 where the root of clam
514 the most general makefile activities. Activities such as
516 into subdirectories and providing support for cleaning up after a make
518 provided at this level. In the remainder of the document, we
520 designate this location with a "$" character to clarify what part of
521 the clam hierarchy we are describing.<br>
522 The root clam
523 support files are mostly language independent, since they are used by
525 varieties of language dependent derived versions of clam. These
527 are generally not of concern unless one is designing a new derived
529 of clam for a language not yet supported.<br>
530 The subdirectories off of the clam root
532 "derived" makefile services, such as C++ or Ada compilation. Each
533 derived clam service implements at least two files to link into the
535 clam system: a variables file and a rules file. The variables
537 the options for the derived make process; by changing the values of
539 different types of targets can be created. The rules file
541 creation of the targets relevant to the programming language being
543 It may be worth noting that clam can be used to
545 any kind of programmatic process--not just compilation. Currently
547 program compilation is the primary goal.
549 <h3><big><a name="TUT_COMMON"></a>Common Files</big></h3>
550 <big> The top-level file called
553 definitions and descriptions of the variables used throughout the clam
554 system. For a non-derived type of make (using only base clam
556 this file should be included near the start of the user's
558 The rules file (stored in "$/rules.def") should be included after the
560 has modified the appropriate variables that will dictate how the make
564 This scheme of including variables at the
565 top and then rules at the bottom of the user's makefile is employed in
566 all clam makefiles. For example, makefiles for C++ compilation
568 same way. The user's C++ makefile includes the C++ variables
570 in a subdirectory called "$/cpp" under the clam root) at the top of the
571 makefile and then includes the C++ rules at the bottom.<br>
572 An example
573 of a C++ makefile is shown below:
576 <small> </small><big> <tt>include cpp/variables.def <br>
580 SOURCE = chaos.cpp checkup.cpp earth_time.cpp guards.cpp istring.cpp \<br>
581 log_base.cpp mutex.cpp occurrence.cpp outcome.cpp
582 outcome_table.cpp \<br>
583 packable.cpp portable.cpp runtime_history.cpp
584 system_outcomes.cpp \<br>
585 utility.cpp version_checker.cpp version_record.cpp<br>
586 TARGETS = basis.lib<br>
588 include cpp/rules.def</tt><br>
589 </big><small></small>
591 <big>The interior of the makefile overrides the TYPE, SOURCE
592 and TARGETS variables for C++ compilation to specify what is to be
594 (basis.lib) and what it consists of (the CPP files mentioned in
596 The PROJECT variable being overridden is actually defined in the
598 a project name is a required feature of all clam makefiles.
600 <h3><big><a name="TUT_IMPORTANT_VARS"></a>Important Variables</big></h3>
601 <big>
602 The clam root directory is pointed to by an internal variable called
604 defined in $/variables.def. This variable is used by the clam
606 to find extra files that might be needed by derived makefile
608 It is important to change this to the appropriate value when you are
609 using the system in a different location. The CLAM_DIR variable
611 be directly edited in $/variables.def, or it can be overridden in the
613 of the shell running the make, or it can be passed on the command line
616 For C++ compilation, the above example
618 (for basis.lib) contains examples for most of the required
619 elements. Additional elements
620 will be discussed in the examples section or can be found in the
622 The absolutely required variables for C++ are PROJECT, TYPE, SOURCE and
625 <p><big> PROJECT is a variable that
628 of the project being compiled. This should be a word that can
630 be used as a directory name and partial component of filenames.
632 spaces and other unusual punctuation characters are discouraged.
633 All of the project's temporary directories will be created based on
635 variable. This project name should be unique across a full build;
636 otherwise files generated by compiling identical project names will be
639 <p><big> TYPE is a variable that describes
641 of project that is being compiled. This is necessary because it
643 some aspects of the compilation, such as where the compilation products
645 generated. All files generated by compilation are stored in the
647 directory (by default, either "~/hoople" in Linux or "l:\" in
648 win32). There are three TYPEs supported so far: </big></p>
650 <small> </small><big> </big><small> </small>
651 <li><big>library: indicates that the project will primarily be
655 dynamic libraries.</big></li>
656 <small> </small><big> </big><small> </small>
657 <li><big>application: indicates that the project will create
658 executables.</big></li>
659 <small> </small><big> </big><small> </small>
660 <li><big>test: indicates that the project constructs test
662 <small> </small><small></small>
664 <big> Projects of the "library" type will
666 an include directory named after the project, such as
667 "~/hoople/include/basis".
668 The include directory is created as a copy of the headers in the
670 directory . Library projects will also have their final products
672 to the lib or dll subdirectories of the build directory being created.<br>
673 Projects that are of type "application" will
674 have their executables
675 copied to the executable directory in the repository (such as
677 The "test" type of project
678 will be promoted to a subdirectory named after the PROJECT that resides
679 under the test hierarchy in the repository (such as
680 "~/hoople/tests/turbodog").
682 <p><big> SOURCE is a list of files that
685 in order to create the final products of the project. These can
687 C++ source files (*.cpp), MS-Win32 resource files (*.rc) and other
689 of source files. The list of objects to create will be determined
690 by transforming the list of SOURCE files (such as by turning a file
692 "fud.cpp" into an object called "fud.obj").
694 <p><big> TARGETS is a list of the products
696 to be created by compilation and linking. The suffix of a target
697 is a well established extension, such as ".lib", ".exe"
698 or ".dll" for MS-Win32 compilation products.
700 <h3><big><a name="TUT_VAR_ASSIGN"></a>Variable Assignment Policies</big></h3>
701 <big>
702 The assignment of variable values is mostly straightforward, but it
704 be valuable to provide a refresher. In GNU make, a variable
706 macro) can be assigned using the following syntax:
709 <small> </small><big>FRED = a b c </big><small> </small>
711 <big>This sets the variable named FRED to the value of "a
712 b c". The variable is referred to as $(FRED) when it is being
714 although its name is just FRED.<br>
715 This syntax is fine when the variable is to be
716 defined only once.
717 In many cases though, a variable is already defined and needs to be
719 to instead of redefined. Using the standard equals (=) operator
721 wipe out the previous definition, so a special assignment
725 <small> </small><big>FRED += d e f </big><small> </small>
727 <big>This is quite similar to the C syntax on integers. It
729 FRED will be given a value equal to its old value plus the new
731 In our example, FRED would be equal to "a b c d e f". Note that
734 FRED = $(FRED) d e f
735 (BAD!)<br>
737 This is not allowed in GNU make because it includes a macro's own value
738 in its definition. This causes a badly formed recursive
740 of the variable; a variable dereferencing operation (such
741 as $(FRED)) causes the variable's current value to
742 be resolved, which in turn dereferences any other variables in the
744 Thus, the reference to $(FRED) causes infinite recursion when
746 in the definition of FRED.<br>
748 In the case of variables that <u>must</u>
749 be defined by the user's makefile, the standard assignment operator
750 (via the = character) can
751 be used. This includes the PROJECT, TYPE, SOURCE, and TARGETS
753 Also, any other variables that are set only by the user's makefile can
754 use simple assignment. This category includes LOCAL_LIBS_USED,
755 LIBS_USED and others of similar nature.<br>
756 But several variables are defined partially
757 by clam, then added to within the user's makefile, and then possibly
759 after the user's makefile is processed (by the clam rules file).
760 These variables cannot use
761 standard assignment and must instead use the incremental assignment
763 operator. Variables included in this category are DEFINITIONS,
765 CLEANUPS, and many others.
767 If you are unsure about the type of variable
768 you are defining, then the incremental assignment (+=) operator is
770 to avoid trashing the variable's previous values.<br>
771
772 Note that when variables are "exported", then any make in a subshell
774 inherit the parent shell's value. This can induce some weird
776 for variables that are incrementally constructed with the +=
778 If this seems to be happening, try using the simple assignment operator
780 that variable in the sub-makefile, if this is allowed. In general
782 variables are not exported unless they MUST be seen by shell scripts
784 this does not occur overly frequently.
786 <h3><big><a name="TUT_OPTIONAL_VARS"></a>Optional Variables</big></h3>
787 <big> There are several miscellaneous
789 are useful, either within one's makefiles or when passed to GNU make on
791 line. These are described below.
793 <p><big> LOCAL_LIBS_USED is a list of
795 that are to be linked in with the library or executable being
797 These are specially formatted names; they are just the prefix part of
799 full library name. For example, if you're building a release
801 and want to link in a data structures library "i_adt.lib" (win32) or
802 "libi_adt.a" (Linux), you can specify:
804 LOCAL_LIBS_USED = i_adt
806 The appropriate prefix and suffix will be attached.
808 <p><big> EXTRA_COPIES is a list of files
809 that should be copied to a project's output folder when it is done
810 being compiled. These should be files that are not already
811 copied as the main products, such as extra data or configuration files
812 that belong with an application.
814 <p><big> EXTRA_VERSIONS is a list of
817 also need to be updated to the main build version during a
819 These are usually needed if a project compiles several executable
821 and each one performs version checking. (By default, any project
822 containing a file called "version.ini" will get a version stamp from
826 <h3><big><a name="WRITING_RULES"></a>Writing Your Own Rules</big></h3>
827 <big> One might need to write new rules
830 file types that are not directly supported by clam. There are a
832 of features provided for writing rules, but there are also some
836 All rules in makefiles need to be prefaced
837 with one of the provided "launcher" macros. These are used to
839 that the rules can be properly executed on different platforms;
841 was especially hard to implement for until these macros were developed
842 (due to what appear to be basic defects in the command line
844 All preaching aside, here are the macros:
847 <small> </small><big> </big><small> </small>
848 <li><big>HIDER: Executes a command but hides the
849 invocation. Any
851 still sent to standard out. If a verbose
852 build is being done, then all of the invocations become visible again.</big></li>
853 <small> </small><big> </big><small> </small>
854 <li><big>HIDESH: Executes a shell script but hides the
856 Similar to HIDER but supports scripts specifically.<br>
858 <small> </small><small></small>
860 <big>Here are some examples of using the macros properly.
863 command itself must be contained in single quotes:<br>
865 $(HIDER) $(MIDL) crumpet_server.idl<br>
867 <blockquote><big>MIDL is also a provided macro; it executes the
869 IDL compiler. </big></blockquote>
870 <big>$(HIDESH) $(CLAM_DIR)/postconditions.sh<br>
872 <blockquote><big>This runs a shell script that handles the end
874 make.</big></blockquote>
876 <a name="TUT_CONCLUSION"></a>Conclusion</big></h3>
877 <big> This tutorial is intended to raise
880 basic usage. Hopefully the reader will now be able to
882 simple makefiles that use . For more aggressive compilation
884 the reference section may be needed; it describes every variable and
886 used in the system. However, it is most likely the case
888 your unsupported compilation needs will also be required by others in
890 future, and it is hoped that you will contribute them to the
891 main-line support. Currently, the appropriate way to do
894 send the makefile code to the <a href="#lib_manager">library
895 administrator</a>, who will include them
896 in the next version of .
898 <center><small></small>
900 <hr noshade="noshade" size="8" width="100%"></h2>
901 <small></small></center>
903 </big><small></small>
904 <h2><big><a name="REFERENCE"></a>CLAM Reference</big></h2>
905 <small></small></center>
907 <a name="LANG_INDEP_VARS"></a><u>Language Independent Variables</u></big></h2>
908 <big> The language independent variables
910 in the file "$/variables.def". They define the overall structure
911 of a make and can usually be overridden to customize how the make is
914 <h4><big>BUILD_BEFORE</big></h4>
915 <big> This is a list of projects that need
918 before this project can be created. The items in the list are
920 as directories that contain a makefile to be run. For example, if
921 an item in BUILD_BEFORE is listed as ?fred?, then the target
923 will be executed. That target changes to the directory 'fred'
925 running the makefile there. The project in the specified
927 is created using make if needed (as determined by that directory's
929 The projects in BUILD_BEFORE are made immediately after the
933 <h4><big>ACTUAL_TARGETS, ACTUAL_FIRST_TARGETS, ACTUAL_LAST_TARGETS</big></h4>
934 <big> See below for TARGETS, FIRST_TARGETS and
937 <h4><big>BUILD_AFTER</big></h4>
938 <big> A list of directory names that
941 into after this project finishes. Each listed directory will have
943 started on any makefile found.<br>
945 <h4><big>BUILD_BEFORE<br>
947 <big> A list of directory names that
949 recursed into before this project
950 starts. Each directory listed will have make started on any
953 <h4><big>MAKEFILE_NAME</big></h4>
954 <big> A variable that specifies the name
957 for all sub-makes. It works with BUILD_BEFORE and
958 BUILD_AFTER and allows the name of the makefile in a
959 subdirectory to be changed to something other than 'makefile'.
961 supports different types of builds which are controlled by different
965 <h4><big>PARAMETER_FILE</big></h4>
966 <big> A file name that is
967 usually found at the root of the repository. The name is
968 often "build.ini", but any name can be used as the parameter file.
969 This file is an extension of the variable set included in
971 and can be used to provide compilation paramters without resorting to
973 command line. This file is associated with a particular build
975 than the support, so different releases will have different build
977 files. On systems supporting version information, the build's
979 number is stored here also.<br>
981 <h4><big>CATCHER</big></h4>
982 <big> A sub-program launcher like HIDESH
983 but this will trap errors it sees and play the build error
984 CLAM_ERROR_SOUND.<br>
986 <h4><big>CLAM_BINARY_DIR</big></h4>
987 <big> This is a folder where the helper
988 binaries for the CLAM makefile system are located. <br>
990 <h4><big>CLAM_DIR</big></h4>
991 <big> This variable points at the location
992 where the definitions and helper scripts are located. The
995 but this can be overridden for local installations of .<br>
997 <h4><big>CLAM_ERROR_SOUND</big></h4>
998 <big> This is a list of sound files
999 that should be played when a make stops with an error. It serves
1001 an audible warning that something bad happened.<br>
1003 <h4><big>CLAM_FINISH_SOUND</big></h4>
1004 <big> This is a list of sound files
1005 that should be played when the make has concluded
1006 successfully. It should play when the outer-most make
1007 has seen all targets created as intended.<br>
1009 <h4><big>CLAM_TMP</big></h4>
1010 <big> Specifies the location for temporary
1011 files generated during a make. The default value usually works
1013 This directory will be created if it does not already exist.<br>
1015 <h4><big>CLEANUPS</big></h4>
1016 <big> This is a list of files to be
1019 clean command. They are possibly acquired from the TARGETS
1021 in the user's Makefile, or by language dependent rules for
1023 Additional files can be added to this list by the user's makefile also.
1025 <h4><big>DIRTY_FILE</big></h4>
1026 <big> This variable points at a file that
1028 that some targets have been remade. It is not used at the base
1030 of clam, but language-specific versions might do something special if
1032 were remade (such as put them in a build repository).
1034 <h4><big>FAILURE_FILE</big></h4>
1035 <big> This file is used as a flag that
1038 a make has failed. The particular file used depends on the
1040 name for this makefile. It is cleared at both the beginning and
1044 <h4><big>FIRST_TARGETS</big></h4>
1045 <big> The FIRST_TARGETS are made before
1048 are created and before any executables are compiled. There must
1050 a rule for making every entry in this list, either through implicit
1052 or explicit ones provided by the user's makefile.
1054 <h4><big>FLAG_FILES</big></h4>
1055 <big> This is a list of all the files
1056 that are used for compilation flags. They are whacked at the
1058 and end of a make.<br>
1060 <h4><big>HIDER</big></h4>
1061 <big> This macro is used throughout
1063 commands that are being sent to the operating system. It can be
1064 disabled to allow a verbose make (see the NOISY macro).
1066 <h4><big>HIDESH</big></h4>
1067 <big> Just like HIDER, but this macro is
1069 for launching shell scripts. Some versions of GNU make (like
1071 have problems running scripts which don't arise when running executable
1073 Those problems led to the creation of the HIDESH macro for those
1075 cases. This is not an issue for Unix systems.
1077 <h4><big> LAST_TARGETS</big></h4>
1078 <big> The LAST_TARGETS are made after all
1081 standard targets are made. Their must be a rule for making every
1082 entry in this list, either through implicit rules or explicit ones
1084 by the user's makefile.
1086 <h4><big>NOISY</big></h4>
1087 <big> This variable can be used to cause a
1090 If the variable is non-empty, then all commands will be echoed to
1092 output. Otherwise, the default is to hide the commands that are
1094 and just show the output of running those commands.
1096 <h4><big>OP_SYSTEM</big></h4>
1097 <big> This is a flag that defines the
1100 name. This flag is sometimes used to choose the appropriate tools
1101 per platform or to conditionally compile code for system
1102 dependent interfaces. The available possibilities so far are
1104 OS2, SYSV (System V Unix), DOS, and WIN32. Only UNIX and WIN32
1106 currently very functional.
1108 <h4><big> OTHER_CLEANS</big></h4>
1109 <big> These are targets to execute before
1111 the main clean up during "make clean". These might be targets
1113 contain shell commands to execute as part of clean up or they could
1115 the "clean_subdirs" command (defined below).
1117 <h4><big>PROJECT</big></h4>
1118 <big> This is a variable that provides the
1121 project being compiled. This should be a word that can also be
1123 as a directory name and as a partial component of filenames.
1125 and other unusual punctuation characters are discouraged. All of
1126 the project's temporary directories will be created based on this
1129 <h4><big>FEISTY_MEOW_APEX</big></h4>
1130 <big> Specifies the root directory
1131 for compilation or other building activities. The
1133 is also where source code and final products of compilation reside,
1135 the default is over-ridden (see TARGETS_DIR).<br>
1137 <h4><big>SH & SHELL</big></h4>
1138 <big> These variables both point at a
1141 used for starting commands. SHELL is defined by GNU make, whereas
1144 <h4><big>SUB_FLAG_FILES</big></h4>
1145 <big> This is a list of the compilation
1148 should be destroyed only at the end of a make. They are used for
1150 with submakefiles--makefiles that were invoked by "this" makefile.<br>
1152 <h4><big>SUBMAKE_FLAG</big></h4>
1153 <big> This points to a file whose presence
1156 a "submake" performed some actions. The flag can be interpreted
1158 some language-specific versions of as a reason to set a flag
1163 <h4><big>TARGETS</big></h4>
1164 <big> These are the products to be created
1166 Each item listed in TARGETS should have a rule that knows how to create
1167 that type of file. The language independent system provides very
1168 few suffix based rules. TARGETS is filled in by the user in
1169 their file, but it is not used directly by the
1172 a generated variable called ACTUAL_TARGETS is used.<br>
1174 <h4><big>TARGETS_DIR</big></h4>
1175 <big> This folder is where all generated
1178 be stored. It is usually identical to FEISTY_MEOW_APEX but can be
1180 when the targets should be stored elsewhere.<br>
1182 <h4><big>Version components: major, minor, revision, build<br>
1184 <big> These four variables specify the
1187 particular build. They are usually stored in the
1189 The major and minor versions are the traditional 2.3, 4.0, etc
1191 of release numbers. The revision number is often used to sequence
1193 builds of that particular release, such that build 3.5.127 is the 127th
1195 of the 3.5 release.<br>
1196 A version-tagged file (such as an executable or
1198 library) with any one of the major, minor or revision numbers differing
1200 an installed build is incompatible with the installed build. An
1202 file or dynamic library will not be allowed to load other dynamic
1204 where these numbers differ.<br>
1205 The last version component is misleadingly called
1207 this number specifies the service pack level for a file. Files
1209 versions only differ in the last "build" component are intended to be
1211 with each other. The understanding is that if only that number
1213 then the external interface to the file has not changed, although the
1215 implementation may have.<br>
1217 <h2><big><a name="LANG_INDEP_RULES"></a><u>Language Independent
1218 Rules</u></big></h2>
1219 <big> The file "$/rules.def" uses the
1222 defined in "$/variables.def" together with a set of make rules to
1224 actions during compilation. The rules file should be included in
1225 the user's Makefile after the compilation variables have been
1227 for the project being compiled. The user's own targets should be
1228 placed after the directive that includes "$/rules.def".
1230 <h4><big>%.halt</big></h4>
1231 <big> These targets cause to exit,
1234 something that it considers catastrophic. An example of this
1236 be when finds an inappropriate entry in the list of objects to
1238 allowing a "make clean" on this makefile will delete files that are
1240 not intended. Hence, when finds this kind of usage, it will
1241 stop the make and issue a complaint.
1243 <h4><big>%.make</big></h4>
1244 <big> Used to compile a makefile in a
1247 "%". This rule is employed by the BUILD_BEFORE macro, but can be
1248 used in the user's makefile targets also.
1250 <h2><big><a name="LANG_INDEP_TARGETS"></a><u>Language Independent
1251 Targets</u></big></h2>
1252 <big> The following targets are defined by
1255 <h4><big>all</big></h4>
1256 <big> This is a standard target that is
1259 no particular target is specified at the make command line. It is
1260 an umbrella target that invokes all of the other targets required to
1262 a make. The order in which the major targets are created is:
1265 <small> </small><big> </big><small> </small>
1266 <li><big>FIRST_TARGETS</big></li>
1267 <small> </small><big> </big><small> </small>
1268 <li><big>TARGETS</big></li>
1269 <small> </small><big> </big><small> </small>
1270 <li><big>LAST_TARGETS</big></li>
1271 <small> </small><small></small>
1275 <big> This causes all of the files in
1277 removed and also executes all of the targets in OTHER_CLEANS. The
1278 language dependent system can override some of this behavior or it can
1279 just add more files to the list of CLEANUPS.
1281 <h4><big>clean_subdirs</big></h4>
1282 <big> This is similar to "make_subdirs" in
1285 into the subdirectories in no particular order, but it runs "make
1287 in each of them. This allows a directory hierarchy of projects to
1288 be cleaned with one command.
1290 <h4><big>finish</big></h4>
1291 <big> The "finish" target represents the
1293 of a make, whether successful or not. It reports the time and
1297 <h4><big>rm_links</big></h4>
1298 <big> This target causes all link files in
1301 directory to be deleted. This is only applicable on a Unix
1305 <h4><big>make_subdirs</big></h4>
1306 <big> This target allows a makefile to
1308 all of the subdirectories under the current directory should be scanned
1309 for makefiles and that those makefiles should be executed. If a
1311 does not exist, it is skipped. Note that the subdirectories are
1313 into in no particular order; the order depends on how the operating
1315 decides to list the directories. If the order of make is
1317 use BUILD_BEFORE instead.
1319 <h4><big>start</big></h4>
1320 <big> The "start" target represents the
1322 the make. It reports the time and date (and logs them).
1324 <h2><big><a name="LANG_INDEP_SCRIPTS"></a><u>Language Independent
1325 Files</u></big></h2>
1326 <h4><big>$(PARAMETER_FILE)</big></h4>
1327 <big> This is a special
1328 file that has at least two purposes in . It is the source of
1330 version number that will be stamped on all the appropriate DLLs and
1332 created during a build. It is also a place where build-wide
1334 directives can be included so that they do not have to be passed on the
1336 line. For C++ compilation, this is usually an INI file
1338 FEISTY_MEOW_APEX under the build folder.
1339 Here is a sample parameter file:
1341 <blockquote><big><tt><font size="-1"><big>#\</big></font></tt> <br>
1342 <tt><font size="-1"><big>[version]</big></font></tt> <br>
1343 <tt><font size="-1"><big>major=14</big></font></tt> <br>
1344 <tt><font size="-1"><big>minor=3</big></font></tt> <br>
1345 <tt><font size="-1"><big>revision=140</big></font></tt> <br>
1346 <tt><font size="-1"><big>build=0</big></font></tt> </big><small> </small>
1347 <p><big><tt><font size="-1"><big>DEBUG=t</big></font></tt> <br>
1348 <tt><font size="-1"><big>OPTIMIZE=t</big></font></tt> <br>
1350 <small> </small></blockquote>
1351 <big>Note the bizarre comment at the top of the makefile; this is
1354 the "[version]" section marker. The comment is required because
1356 build parameter file is pulled directly into the makefile code to set
1358 variables after the version stamp. Without a comment in front of
1359 the section, a syntax error would result. The "[version]" section
1360 marker is required because this file is also sometimes treated as a
1362 in order to read the version stamp.<br>
1363 The build version is stored in the first four
1364 entries. Our interpretation of the stamp is standard for "major"
1365 and "minor". We treat the "revision" as a build revision number;
1366 within a release, there will be numerous revisions--one for each new
1368 that is performed. We then treat the "build" entry as a patch
1370 within that particular build. When we perform our version
1372 only the first three entries are compared; the patch level in "build"
1374 considered irrelevant.
1376 This example also specifies that the build
1377 should be a debug style (rather than release) build and that it should
1378 be optimizer. We can also see that
1379 the flags for bounds checker instrumentation and true time
1380 analysis support are commented out.<br>
1382 <h4><big>badness_catcher.sh</big></h4>
1383 <big> Runs the command line passed
1384 in as a sub-shell and looks for error conditions. If an error
1386 the build is stopped and the CLAM_ERROR_SOUND is played.<br>
1388 <h4><big>datestamp.sh</big></h4>
1389 <big> Echoes the time and date. This
1392 file to make the cross-platform difference less annoying.<br>
1394 <h4><big>exit_make.sh</big></h4>
1395 <big> Causes the make to stop dead in its
1398 <h4><big>postconditions.sh</big></h4>
1399 <big> Invoked at the end of the
1401 portion of a make.<br>
1403 <h4><big>preconditions.sh</big></h4>
1404 <big> Invoked at the beginning of the
1405 language-invariant portion of a make.<br>
1407 <h4><big>starter.sh</big></h4>
1408 <big> This shell script executes a command
1411 to it as its parameters and logs error conditions to standard
1413 It's used by the CATCHER macro.
1416 <hr noshade="noshade" size="8" width="100%"></h2>
1418 <a name="CPP_VARS"></a><u>C++ Specific Variables</u></big></h2>
1419 <big> These variables are used throughout
1422 support. They are defined in "$/cpp/variables.def".
1424 <h4><big>BASE_CPU</big></h4>
1425 <big> Allows specification of the
1427 build is targeted for. This is needed when special actions must
1429 taken for different processor types. Valid values currently
1431 m68k (for Motorola 68000 series), m68340 (specifically the 68340),
1432 x86 (intel 386 and upwards), and ppc860 (the PowerPC 860).
1434 <h4><big>BUILD_LIST_FILE</big></h4>
1435 <big> The list of files that must
1436 be rebuilt. This is only used with compilers that support
1438 of multiple source files with one invocation of the compiler (currently
1442 <h4><big>BUILD_WHACK_FILE</big></h4>
1443 <big> A list of object files that must be
1446 the make fails. This is only relevant in the same situations as
1447 BUILD_LIST_FILE.<br>
1449 <h4><big>COMPILER</big></h4>
1450 <big> This variable chooses the specific
1453 for the compiler. Not all operating system choices above are
1455 with the COMPILER choices, but generally it is fairly obvious which are
1456 supported. The current possibilities include BORLAND_DOS,
1458 UNIX (default cc), GNU_OS2, GNU_LINUX, OBJECT_CENTER (Saber compiler),
1460 VISUAL_CPP, and DIAB3.
1462 <h4><big>COMPILER_FLAGS</big></h4>
1463 <big> This is the list of flags passed to
1466 and compiler. It is composed of the SYSTEM, the DEFINITIONS, the
1468 and any user-included options. If flags that don't fit one of the
1470 are needed, they can be added here.
1472 <h4><big>CONSOLE_MODE</big></h4>
1473 <big> This causes the program
1474 to be generated as a console application. This is relevant in
1476 (such as win32) where programs have a split personality depending on
1478 they are to have graphical user interfaces or just console interfaces.
1480 <h4><big>DEBUG_FLAGS</big></h4>
1481 <big> These are flags used for generating
1483 versions of object files, such as ones that include debugging code
1485 for gdb) or ones that add code for profiling (e.g., gprof). Possible
1487 in the Sun CenterLine Compiler environment are -g for debugging code
1491 <h4><big>DEFINITIONS</big></h4>
1492 <big> This is a list of compiler flags
1495 value of C or C++ macros. These usually have the format of
1497 but in this particular variable only the <flag> itself should be
1499 (because the compiler option characters ?-D? are added automatically).
1501 <h4><big>DEPENDENCY_ADDITIONS</big></h4>
1502 <big> This is a list of extra flags that
1504 to the auto-dependency tool. The list can vary for each compiler.
1506 <h4><big>DEPS_FILE</big></h4>
1507 <big> This file is where the
1510 is stored. The "makedep" program is used to generate
1512 information for the files listed in SOURCE. During a build, the
1514 is pulled into the actual code of the makefile; this causes the
1516 to be automatically included so that they can dictate the files that
1520 <h4><big>EXTRA_VERSIONS</big></h4>
1521 <big> This is a list of version files that
1523 to be updated to the main build version during a compilation.
1525 are usually needed if a project compiles several executable files, and
1526 each one performs version checking. By default, any project
1528 a file called "version.ini" will get a version stamp from the main
1532 <h4><big>LIBRARIAN_FLAGS</big></h4>
1533 <big> This is a list of flags that are
1535 library creation tool. Sometimes this must be overridden for a
1539 <h4><big>LIBS_USED</big></h4>
1540 <big> These are code libraries that the
1542 depend upon. They are searched for in any of the directories
1544 in the LIBRARY_SEARCH_PATH.
1546 <h4><big>LOAD_FLAG_PREFIX & LOAD_FLAG_SUFFIX</big></h4>
1547 <big> These tell the linker and loader how
1550 the files and where to locate library components. The prefix is listed
1551 on the compilation command line before the object files are listed, and
1552 the suffix after. The prefix should contain information such as the
1554 to be searched for code libraries (although they should be added to
1555 LIBRARY_SEARCH_PATH).
1556 In the suffix definition, actual library loading statements (like
1558 can be included (although they should be listed in a different form in
1559 LIBS_USED or LOCAL_LIBS_USED).
1561 <h4><big>LOCAL_LIBS_USED</big></h4>
1562 <big> The names in this list actually
1565 to be recompiled when the libraries listed have changed. To
1567 this, these libraries MUST be located in the STATIC_LIBRARY_DIR rather
1569 at some arbitrary place on the LIBRARY_SEARCH_PATH. These
1571 also must follow the special naming convention followed by ; if
1573 is an entry in this list, then a library called "basis.lib" will be
1577 <h4><big>NO_COMPILE</big></h4>
1578 <big> Specifies that no compilation
1579 should be performed. Nothing in the SOURCE or TARGETS macros will
1583 <h4><big>NO_DEPS</big></h4>
1584 <big> This is an exclusion flag. If
1587 then no auto-dependency files will be generated. This is useful
1589 you're missing the makedep tool and trying to compile it.<br>
1591 <h4><big>OBJECTS</big></h4>
1592 <big> The OBJECTS are all those files that
1595 created during compilation. Usually this list is filled based on
1596 the files in SOURCE.
1598 <h4><big>OPTIMIZE</big></h4>
1599 <big> Causes the make to create optimized
1601 The default optimization is for speed.
1603 <h4><big>REBUILD</big></h4>
1604 <big> If the REBUILD variable is
1606 files listed in the SOURCE variable are touched. This should
1608 all of those files to be rebuilt during the compilation.
1610 GNU make will complain that a file is newer than the current time, but
1611 this does not usually cause any problems.
1613 <h4><big>SOURCE</big></h4>
1614 <big> The SOURCE variable is a list of
1617 to be compiled in order to create the final products of the
1619 These can be C++ source files (*.cpp), Win32 resource files (*.rc)
1621 other types of source files. The list of objects to create will
1623 determined by transforming the list of SOURCE files (such as by turning
1624 a file called "fud.cpp" into an object called "fud.obj"). More
1626 types will be added as they are needed.
1628 <h4><big>STATIC</big></h4>
1629 <big> Causes the make to create statically
1632 Executables or dynamic libraries will not link in any compiler supplied
1633 dynamic libraries, nor will they require them during run-time.
1635 <h4><big>TYPE</big></h4>
1636 <big> This is a variable that describes
1638 project that is being compiled. Knowing the type of project is
1640 because it controls some elements of the compilation and also of the
1642 promotion of the compiled products. There are three TYPEs
1647 <small> </small><big> </big><small> </small>
1648 <li><big>library: indicates that the project will be primarily
1652 dynamic libraries.</big></li>
1653 <small> </small><big> </big><small> </small>
1654 <li><big>application: indicates that the project will create
1655 executables.</big></li>
1656 <small> </small><big> </big><small> </small>
1657 <li><big>test: indicates that the project constructs test
1658 programs.</big></li>
1659 <small> </small><small></small>
1661 <big>Projects of the "library" type will follow the special
1663 their include directory (which is created as a copy of headers in the
1665 directory). Library projects will also have their final products
1666 copied to the lib or dll subdirectories of the build directory being
1668 Projects that are "application"s will have their executables copied to
1669 the executable directory in the build. And "test" projects will
1671 promoted to a subdirectory named after the PROJECT that resides under
1673 test hierarchy in the build.
1675 <h2><big><a name="DIRECTORY_VARS"></a><u>C++ Directory Structure
1676 Variables</u></big></h2>
1677 <h4><big>BASE_OUTPUT_PATH</big></h4>
1678 <big> This is the parent directory
1679 for object files generated for the specified type of CPU and the style
1681 build (e.g. debug or release builds).<br>
1683 <h4><big>CPU_BUILD_DIR</big></h4>
1684 <big> This variable can be used to
1687 names used for output. It includes the cpu name and the type of
1690 <h4><big>DYNAMIC_LIBRARY_DIR</big></h4>
1691 <big> The directory where dynamic
1693 stored after creation.<br>
1695 <h4><big>EXECUTABLE_DIR</big></h4>
1696 <big> The directory where executable files
1698 stored after creation.<br>
1700 <h4><big>FINAL_DIR</big></h4>
1701 <big> This is the name of the directory
1704 compilation products are stored, currently only import libraries for
1705 dynamic libraries.
1706 It is usually a directory under the OUTPUT_PATH named "final".
1708 <h4><big>HEADER_SEARCH_PATH</big></h4>
1709 <big> This is a list of directories that
1712 for C++ header files (files ending in ?.h?).
1714 <h4><big>HOOPLE_HEADERS</big></h4>
1715 <big> The two standard places to look for
1717 (the repository and the third party directory) are listed in this
1720 <h4><big>HOOPLE_LIBRARIES</big></h4>
1721 <big> This is where our libraries are
1722 located. It is usually a subdirectory called "lib" under the
1726 <h4><big>LIBRARY_SEARCH_PATH</big></h4>
1727 <big> This is a list of directories that
1730 for C++ library archives (files ending in ".a" or ".lib").
1732 <h4><big>LOCAL_HEADERS</big></h4>
1733 <big> This variable provides a way to
1736 prior to the default locations in the search path. For example,
1738 you are compiling locally and have some headers that are not present in
1739 the build you are using, then you can specify where they are in this
1742 <h4><big>LOCAL_LIBRARIES</big></h4>
1743 <big> This variable allows other library
1745 to be added prior to the default search locations. This enables
1747 static or import libraries to be used instead of the standard ones
1751 <h4><big>STATIC_LIBRARY_DIR</big></h4>
1752 <big> This is the location where code
1754 to be copied during promotion and where they are to be searched for
1756 listed in LOCAL_LIBS_USED. Under Unix, these libraries have a
1758 suffix and are created with the "ar" program. Under Win32,
1760 libraries have a ?.lib? suffix and are created with "link".
1762 <h4><big>OBJECT_DIR</big></h4>
1763 <big> This is where object files will be
1766 compilation for the target type being produced.
1768 <h4><big>OUTPUT_DIRECTORY_LIST</big></h4>
1769 <big> This is a list of directories that
1771 created under the OUTPUT_PATH. It contains the "final" directory
1772 where all finished products are stored, as well as all the intermediate
1773 directories for objects.
1775 <h4><big>OUTPUT_PATH</big></h4>
1776 <big> This is the temporary file storage
1778 Any files that are created during the compilation process will be
1780 under here in a subdirectory named after the PROJECT.
1782 <h4><big>OUTPUT_ROOT</big></h4>
1783 <big> This specifies the root portion of
1786 It lets a PC build use drive letters for the root, while a Unix build
1788 specify a directory hierarchy.
1790 <h4><big>SEARCH_DIRS</big></h4>
1791 <big> This is a list of directories that
1794 for both C++ header files and for C++ code libraries. The items
1796 on SEARCH_DIRS will be added to both the LIBRARY_SEARCH_PATH and the
1797 HEADER_SEARCH_PATH.
1798 The reasoning behind this variable is lost in antiquity.
1800 <h4><big>TESTS_DIR <br>
1802 <big> The directory where test programs
1804 stored after creation.<br>
1806 <h4><big>THIRD_PARTY_DIR</big></h4>
1807 <big> Third party components are sometimes
1810 creation of products. The directory is expected to have a
1812 containing "include" and "lib" subdirectories where headers and
1816 <h2><big><a name="CPP_FLAGS"></a><u>Compiler Dependent Flags</u></big></h2>
1819 <big> This is the name of the C++ compiler
1822 <h4><big>COMPILER_HEADER_DIR</big></h4>
1823 <big> This is where the compiler's header
1826 root directory is located. It is usually based on the root
1829 <h4><big>COMPILER_LIBRARY_DIR</big></h4>
1830 <big> This is where the code libraries for
1833 are located. It is usually based on the root directory.
1835 <h4><big>COMPILER_ROOT_DIR</big></h4>
1836 <big> This should automatically be set to
1839 local directory where the C++ compiler is located.
1841 <h4><big>CREATE_LIBRARY_FLAG</big></h4>
1842 <big> This flag, if required, specifies
1845 must precede the name of a library to create. It is passed to the
1846 library creation tool.
1848 <h4><big>DEF_FILE</big></h4>
1849 <big> This flag only applies to Win32
1851 It specifies the name of a DEF file for all of the products created in
1854 <h4><big>LIB_PREFIX & LIB_SUFFIX</big></h4>
1855 <big> The portions of a library's name
1856 dictated by the operating system. For example, on Unix the prefix
1858 and the suffix is ".a", leading to library names like "libbasis.a" for
1860 basis library. On win32, the prefix is "" and the suffix is
1862 to library names like "basis.lib".<br>
1864 <h4><big>LIBRARY_NAME_FLAG</big></h4>
1865 <big> This flag contains the text that
1868 that will be included in a link. It is often "-l".
1870 <h4><big>LIBRARY_PATH_FLAG</big></h4>
1871 <big> This flag provides the text needed
1874 library search path. Multiple occurrences of this flag followed
1876 a directory name are allowed by most compilers.
1878 <h4><big>LIBRARY_TOOL</big></h4>
1879 <big> This is the name of the program
1884 <h4><big>LINK_TOOL</big></h4>
1885 <big> This is the name of the program that
1887 This is sometimes the same as the compiler (CC) and sometimes the same
1888 as the librarian (LIBRARY_TOOL).
1890 <h4><big>LINKER_OPTION_SEPARATOR</big></h4>
1891 <big> In some compilers, linker options
1894 from compiler options that occur on the same command line. This
1896 serves that purpose.
1898 <h4><big>LINKER_OUTPUT_FLAG</big></h4>
1899 <big> This flag is sometimes required by a
1902 specifying the name of the library or executable that it is creating.
1904 <h4><big>OBJECT_NAME_FLAG</big></h4>
1905 <big> This flag is used to specify the
1908 file being created. It is passed to the compiler to override
1910 default name would be used.
1912 <h2><big><u><a name="vcpp_only"></a>Microsoft-Visual C++ Only</u><br>
1914 <h4><big>USE_MFC</big></h4>
1915 <big> This flag only applies to Visual C++
1918 that MFC is to be used in creating this project. This is usually
1919 the case for GUI applications.
1921 <h4><big>VC_ROOT</big></h4>
1922 <big> This is an override that allows the
1925 directory to be customized without changing the code. If
1927 is set (either in a makefile or as an external variable), then it will
1928 be used in place of the COMPILER_ROOT_DIR. The best way to use
1930 override is as an external environment variable; this allows makefiles
1931 to remain the same despite your local configuration of the compiler.
1933 Note that this variable should use
1935 where DOS/Win32 would use backslashes. Also, if you have
1937 Visual C++ in a directory path containing space characters, then please
1938 use the 8.3 notation for the directories containing the spaces; this
1940 the name to be passed around successfully. For example...
1942 <center><small></small><big> </big><big> </big><big> </big><big> </big><big></big><big></big><big>
1943 </big><big> </big><big> </big><big> </big><big>
1944 </big><big> </big><big> </big><big> </big><small> </small><small></small><small>
1945 </small><small> </small><small> </small><small> </small><small>
1946 </small><small> </small><small> </small><small> </small><small> </small><small></small><small>
1947 </small><small> </small><small> </small><small> </small>
1948 <table cellpadding="8" cellspacing="4">
1951 <td><big> </big><small> </small>
1952 <center><big><u>If Visual C++ Is Installed In</u></big></center>
1953 <small> </small><big> </big></td>
1954 <td><big> </big><small> </small>
1955 <center><big><u>Then VC_ROOT Should Be</u></big></center>
1956 <small> </small><big> </big></td>
1959 <td><big> </big><small> </small>
1960 <center><big>c:\devstudio\vc</big></center>
1961 <small> </small><big> </big></td>
1962 <td><big> </big><small> </small>
1963 <center><big>c:/devstudio/vc</big></center>
1964 <small> </small><big> </big></td>
1967 <td><big> </big><small> </small>
1968 <center><big>c:\program files\devstudio\vc</big></center>
1969 <small> </small><big> </big></td>
1970 <td><big> </big><small> </small>
1971 <center><big>c:/progra~1/devstudio/vc</big></center>
1972 <small> </small><big> </big></td>
1976 <small></small></center>
1977 <h4><big>VCS_ROOT</big></h4>
1978 <big> Similarly to the VC_ROOT, this
1980 at the root of the C# support for Visual Studio.Net.<br>
1982 <h4><big>FRAMEWORK_DIR</big></h4>
1983 <big> This variable specifies the location
1985 .Net framework directory. On MS-Windows XP, the default should be
1986 fine. For MS-Windows 2000 or other Win32 OSes, the windows
1988 should be "winnt" instead. If the operating system is configured
1989 in a non-default way, the framework directory can be specified in an
1990 environment variable.<br>
1992 <h4><big>VCPP_USE_BASE</big></h4>
1993 <big> Specifies that standard Win32
1997 <h4><big>VCPP_USE_GUI</big></h4>
1998 <big> Specifies that the MFC libraries
2002 <h4><big>VCPP_USE_OLE</big></h4>
2003 <big> Specifies that the COM / OLE
2007 <h4><big>VCPP_USE_RPC</big></h4>
2008 <big> Specifies that the MS-RPC libraries
2012 <h4><big>VCPP_USE_SOCK</big></h4>
2013 <big> Specifies that the MS-WinSock
2017 <h2><big><a name="CPP_RULES"></a><u>C++ Specific Rules</u></big></h2>
2018 <big> These types of targets have one
2021 if any of the items that a target depends on in SOURCE or
2023 or included files or whatever have changed since the last time the
2025 was created, then it is recompiled.
2027 <h4><big>%.bad</big></h4>
2028 <big> Causes the make to die. This
2029 is added when an incorrect file type is spotted in a list of targets.<br>
2031 <h4><big>%.dll</big></h4>
2032 <big> These create dynamically linked
2036 <h4><big>%.elf</big></h4>
2037 <big> Creates elf-formatted binaries for
2039 firmware build (a specialized RTOS is the only one currently supported).<br>
2041 <h4><big>%.exe</big></h4>
2042 <big> This creates an executable program
2045 the objects and libraries specified. It is therefore important in
2046 a makefile to only have executables that depend on the same group
2047 of object files. The hidden agenda in the "exe" type of target is
2048 that a file ending in ".cpp" must exist; this is taken as the root of
2050 executable. It should usually contain the main() function (or its
2053 <h4><big>%.lib</big></h4>
2054 <big> This creates static libraries from
2059 <h4><big>%.nil</big></h4>
2060 <big> A blank target for test compiles.<br>
2062 <h4><big>%.obj</big></h4>
2063 <big> These create object files from C++
2066 (files ending in .c or .cpp).
2068 <h4><big>%.res</big></h4>
2069 <big> These create compiled resource files
2074 <h2><big><a name="CPP_TARGETS"></a><u>C++ Specific Targets</u></big></h2>
2076 check_requirements</big></h4>
2077 <big> This target ensures that certain
2079 of the makefile are present. It complains and aborts the make if
2082 <h4><big>post_compilation</big></h4>
2083 <big> This target finalizes the
2086 the postconditions script. If PROMOTE is true, then the final
2088 are copied into the repository.
2090 <h4><big>pre_compilation</big></h4>
2091 <big> This target executes the
2092 preconditions script
2093 to set up the compilation's output directories.
2095 <h4><big>rebuild</big></h4>
2096 <big> This target performs the actions of
2098 This mainly involves touching all of the files in SOURCE before the
2102 <h2><big><a name="CPP_SCRIPTS"></a><u>C++ Specific Files</u></big></h2>
2103 <h4><big>postconditions.sh</big></h4>
2104 <big> After a compilation has succeeded,
2107 script performs the final actions required. The nature of these
2109 depends on the type of project being made. For a library project,
2110 the script copies the headers to the project's include directory and
2112 libraries to the appropriate locations. For application and test
2113 program targets, the script copies the final products to the
2115 repository directory.
2117 <h4><big>preconditions.sh</big></h4>
2118 <big> Before any targets are compiled, the
2120 script ensures that the appropriate output directories exist for the
2122 The script also calls the version utilities to update the project's
2124 file and to create any required resource files.<br>
2126 <h4><big>rebuild_oldies.sh</big></h4>
2127 <big> Used for compilers that support
2130 in one invocation. This is launched to compile a batch of sources
2132 catch any errors.<br>
2134 <hr noshade="noshade" size="8" width="100%">
2135 <center><small></small>
2136 <h2><big><a name="EXAMPLES"></a>CLAM Example Makefiles</big></h2>
2137 <small></small></center>
2138 <big> These examples show some common
2140 how is used. The makefiles below are actually used in real
2144 <h3><big>Library-Only Makefile</big></h3>
2145 <big>This example creates a dynamic library.
2148 <small> </small><big> <tt>include cpp/variables.def</tt> </big><small>
2150 <p><big><tt>PROJECT = mechanisms</tt><br>
2151 <tt>TYPE = library</tt> <br>
2152 <tt>SOURCE = delayer.cpp eventmgr.cpp event_po.cpp heartbea.cpp
2155 <tt> libmain.cpp monitor.cpp semaphor.cpp state_ma.cpp
2157 time_sta.cpp</tt> <br>
2158 <tt>TARGETS = mechanisms.dll</tt> <br>
2159 <tt>LOCAL_LIBS_USED = basis</tt> <br>
2160 <tt>DEFINITIONS += BUILD_MECHANISMS USE_HOOPLE_DLLS</tt> </big></p>
2161 <small> </small><big> </big><small> </small>
2162 <p><big><tt>include cpp/rules.def</tt></big></p>
2163 <small> </small><small></small>
2165 <big>The dynamic library created here is mechanisms.dll. The
2168 in also. The file "roller.cpp" will also be copied to the build
2170 include path, presumably since it is a template code file.
2172 <h3><big>Library Plus Executable Makefile</big></h3>
2173 <big>This example shows the basis makefile with a couple of test
2179 <small> </small><big> <tt>include cpp/variables.def</tt> </big><small>
2181 <p><big><tt>PROJECT = basis</tt> <br>
2182 <tt>TYPE = library</tt> <br>
2183 <tt>SOURCE = chaos.cpp checkup.cpp guards.cpp \</tt> <br>
2184 <tt> istring.cpp itime.cpp logger.cpp matrix.cpp
2185 portable.cpp \</tt> <br>
2186 <tt> realtime.cpp textdump.cpp timezone.cpp utility.cpp \</tt> <br>
2187 <tt> version_checker.cpp version_record.cpp</tt> <br>
2188 <tt>TARGETS = basis.lib t_string.exe t_alloc.exe</tt> </big></p>
2189 <small> </small><big> </big><small> </small>
2190 <p><big><tt>include cpp/rules.def</tt></big></p>
2191 <small> </small><small></small>
2193 <big>Note that the executables
2194 "t_string.exe" and "t_alloc.exe" require files called "t_string.cpp"
2196 "t_alloc.cpp" to exist. These files are expected to contain the
2198 or "WinMain()" functions (or the MFC application object). All of
2200 files in the SOURCE variable will be included in each final executable.
2202 <h3><big>Executable-Only Makefile</big></h3>
2203 <big>This example is produces several test programs that exercise
2209 <small> </small><big> <tt>include cpp/variables.def</tt> </big><small>
2211 <p><big><tt>PROJECT = t_basis</tt> <br>
2212 <tt>TYPE = test</tt> <br>
2213 <tt>SOURCE = instance.cpp t_basis.rc</tt> <br>
2214 <tt>TARGETS = t_alloc.exe t_chaos.exe t_checku.exe t_dattim.exe \</tt>
2216 <tt> t_matrix.exe t_sequen.exe t_sorts.exe t_string.exe \</tt> <br>
2217 <tt> t_texdmp.exe</tt> <br>
2218 <tt>LOCAL_LIBS_USED = basis</tt> </big></p>
2219 <small> </small><big> </big><small> </small>
2220 <p><big><tt>include cpp/rules.def</tt></big></p>
2221 <small> </small><small></small>
2223 <big>The programs "t_alloc.exe" and so on will require C++ files
2226 prefix (t_alloc.cpp) to contain the main program (as in the previous
2228 The items in the SOURCE list will be included in each executable, and
2230 basis library will be linked in.
2232 <h2><big><a name="CLAM_HINTS"></a>CLAM Hints</big></h2>
2233 <big> This section
2234 is devoted to untangling snags that have been encountered in the
2236 Hopefully problems you encounter will be discussed here. Please
2238 any new problems found to the <a href="#lib_manager">library
2241 <h3><big>Problem:</big></h3>
2242 <big> A message like:
2245 <small> </small><big> </big><small> </small>
2247 <small> </small><big>make: *** No rule to make target
2248 `o:/x86_w32_rel/project/final/myproj.dll',
2249 needed by `all'. Stop. </big><small> </small>
2251 <small> </small><small></small>
2253 <big>is displayed during a make.
2255 <h3><big>Solution:</big></h3>
2256 <big> The most frequent reason for
2259 similar to the above is that there is a file listed in SOURCE that
2261 does not exist or that is capitalized differently from how it is
2263 Check that all the files in SOURCE are in the makefile's directory and
2264 that the exact spelling of those files (including their case) is
2267 Another potential cause of this problem is
2268 if a file is included in the SOURCE that does not
2270 The standard compilable files are supported (*.cpp, *.c, *.rc), but it
2271 is possible that a makefile must handle a non-standard extension (such
2272 as *.idl). Either the user's makefile must supply a rule for
2274 this type of file or the user must negotiate with the
2276 to get that type of target added to the support.
2278 <h3><big>Problem:</big></h3>
2279 <big> Clam is complaining about programs
2284 <h3><big>Solution:</big></h3>
2285 <big> The most frequent cause of this
2288 not being on your path. The compilation tools bin (~/hoople/bin)
2289 directory must be in
2292 Problems are occasionally seen when the PATH
2293 contains directory names that have spaces in them. Try using the
2294 shorter 8.3 form of the directory name.
2296 An even more obscure situation sometimes
2297 occurs: paths with networked drives seem to somehow hide paths with
2299 are listed later in the PATH variable. The cause of this is
2301 although it was thought to be caused by NetWare at one point. To
2303 the situation, move the local paths before the networked ones.<br>
2306 <hr noshade="noshade" size="8" width="100%">
2307 <center><small></small>
2308 <h2><big><a name="ACKS"></a>Acknowledgements</big></h2>
2309 <small></small></center>
2310 <center><big>Thanks to April Bly Monnen for the wonderful cover
2312 </big><small></small>
2313 <p><big>Thanks to Kevin Wika for some early help with makefiles.
2315 <small></small><big><big>
2316 </big></big><small></small>
2317 <hr noshade="noshade" size="8" width="100%"></center>