diff options
| author | Dimitri van Heesch <dimitri@stack.nl> | 2015-05-17 09:58:27 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <dimitri@stack.nl> | 2015-05-17 09:58:27 (GMT) |
| commit | 7bcf8e9a379ec0599160e5562f07b93f8fb9557a (patch) | |
| tree | 6b8eea084053c1d891b3c9a5c1e993203902718a /tmake/doc | |
| parent | 2e39e5c7c1427ac6b24c64b7ef01be8d5a20092b (diff) | |
| download | Doxygen-7bcf8e9a379ec0599160e5562f07b93f8fb9557a.zip Doxygen-7bcf8e9a379ec0599160e5562f07b93f8fb9557a.tar.gz Doxygen-7bcf8e9a379ec0599160e5562f07b93f8fb9557a.tar.bz2 | |
Removed old build files, added install targets and other options
Diffstat (limited to 'tmake/doc')
| -rw-r--r-- | tmake/doc/m-linux-gcc.html | 85 | ||||
| -rw-r--r-- | tmake/doc/m-win32-msvc.html | 89 | ||||
| -rw-r--r-- | tmake/doc/tmake.html | 727 | ||||
| -rw-r--r-- | tmake/doc/tmake_ref.html | 463 |
4 files changed, 0 insertions, 1364 deletions
diff --git a/tmake/doc/m-linux-gcc.html b/tmake/doc/m-linux-gcc.html deleted file mode 100644 index 300ef35..0000000 --- a/tmake/doc/m-linux-gcc.html +++ /dev/null @@ -1,85 +0,0 @@ -<!doctype HTML public "-//W3C//DTD HTML 3.2//EN"> -<html><head><title> -Generated Makefile for Linux / GNU g++ -</title></head><body bgcolor="#ffffff"> -<h2 align=center>Generated Makefile for Linux / GNU gcc</h2> - -<pre> -############################################################################# -# Makefile for building hello -# Generated by tmake at 10:11, 1998/07/07 -# Project: hello -# Template: app -############################################################################# - -####### Compiler, tools and options - -CC = g++ -CFLAGS = -Wall -W -O2 -fno-strength-reduce -INCPATH = -I$(QTDIR)/include -LINK = g++ -LFLAGS = -LIBS = -L$(QTDIR)/lib -lqt -L/usr/X11R6/lib -lX11 -MOC = moc - -####### Files - -HEADERS = hello.h -SOURCES = hello.cpp \ - main.cpp -OBJECTS = hello.o \ - main.o -SRCMOC = moc_hello.cpp -OBJMOC = moc_hello.o -TARGET = hello - -####### Implicit rules - -.SUFFIXES: .cpp .cxx .cc .C .c - -.cpp.o: - $(CC) -c $(CFLAGS) $(INCPATH) -o $@ $< - -.cxx.o: - $(CC) -c $(CFLAGS) $(INCPATH) -o $@ $< - -.cc.o: - $(CC) -c $(CFLAGS) $(INCPATH) -o $@ $< - -.C.o: - $(CC) -c $(CFLAGS) $(INCPATH) -o $@ $< - -.c.o: - $(CC) -c $(CFLAGS) $(INCPATH) -o $@ $< - -####### Build rules - -all: $(TARGET) - -$(TARGET): $(OBJECTS) $(OBJMOC) - $(LINK) $(LFLAGS) -o $(TARGET) $(OBJECTS) $(OBJMOC) $(LIBS) - -moc: $(SRCMOC) - -tmake: - tmake hello.pro - -clean: - -rm -f $(OBJECTS) $(OBJMOC) $(SRCMOC) $(TARGET) - -rm -f *~ core - -####### Compile - -hello.o: hello.cpp \ - hello.h - -main.o: main.cpp \ - hello.h - -moc_hello.o: moc_hello.cpp \ - hello.h - -moc_hello.cpp: hello.h - $(MOC) hello.h -o moc_hello.cpp -</pre> -</body></html> diff --git a/tmake/doc/m-win32-msvc.html b/tmake/doc/m-win32-msvc.html deleted file mode 100644 index 24097cc..0000000 --- a/tmake/doc/m-win32-msvc.html +++ /dev/null @@ -1,89 +0,0 @@ -<!doctype HTML public "-//W3C//DTD HTML 3.2//EN"> -<html><head><title> -Generated Makefile for Win32 / Microsoft Visual C++ -</title></head><body bgcolor="#ffffff"> -<h2 align=center>Generated Makefile for Win32 / Microsoft Visual C++</h2> - -<pre> -############################################################################# -# Makefile for building hello -# Generated by tmake at 20:40, 1998/02/27 -# Project: hello -# Template: app -############################################################################# - -####### Compiler, tools and options - -CC = cl -CFLAGS = -nologo -W3 -O2 -INCPATH = -I"$(QTDIR)\include" -LINK = link -LFLAGS = /NOLOGO /SUBSYSTEM:windows -LIBS = $(QTDIR)\lib\qt.lib user32.lib gdi32.lib comdlg32.lib wsock32.lib -MOC = moc - -####### Files - -HEADERS = hello.h -SOURCES = hello.cpp \ - main.cpp -OBJECTS = hello.obj \ - main.obj -SRCMOC = moc_hello.cpp -OBJMOC = moc_hello.obj -TARGET = hello.exe - -####### Implicit rules - -.SUFFIXES: .cpp .cxx .cc .c - -.cpp.obj: - $(CC) -c $(CFLAGS) $(INCPATH) -Fo$@ $< - -.cxx.obj: - $(CC) -c $(CFLAGS) $(INCPATH) -Fo$@ $< - -.cc.obj: - $(CC) -c $(CFLAGS) $(INCPATH) -Fo$@ $< - -.c.obj: - $(CC) -c $(CFLAGS) $(INCPATH) -Fo$@ $< - -####### Build rules - -all: $(TARGET) - -$(TARGET): $(OBJECTS) $(OBJMOC) - $(LINK) $(LFLAGS) /OUT:$(TARGET) @<< - $(OBJECTS) $(OBJMOC) $(LIBS) -<< - -moc: $(SRCMOC) - -tmake: Makefile - -Makefile: hello.pro - tmake hello.pro -o Makefile - -clean: - -del hello.obj - -del main.obj - -del moc_hello.cpp - -del moc_hello.obj - -del $(TARGET) - -####### Compile - -hello.obj: hello.cpp \ - hello.h - -main.obj: main.cpp \ - hello.h - -moc_hello.obj: moc_hello.cpp \ - hello.h - -moc_hello.cpp: hello.h - $(MOC) hello.h -o moc_hello.cpp -</pre> -</body></html> diff --git a/tmake/doc/tmake.html b/tmake/doc/tmake.html deleted file mode 100644 index 1b14809..0000000 --- a/tmake/doc/tmake.html +++ /dev/null @@ -1,727 +0,0 @@ -<!doctype HTML public "-//W3C//DTD HTML 3.2//EN"> -<html><head><title> -User's Guide - tmake -</title></head><body bgcolor="#ffffff"> -<p><h1 align=center>User's Guide - tmake</h1> - - -<hr> -<h2>Introduction</h2> - -tmake is an easy-to-use tool from Troll Tech to create and maintain -makefiles for software projects. It can be a painful task to manage -makefiles manually, especially if you develop for more than one platform -or use more than one compiler. tmake automates and streamlines this -process and lets you spend your valuable time on writing code, not -makefiles. - -<p> -Our main motivation for developing tmake was that we spent far too much -time maintaining makefiles for <a href="http://www.troll.no/qt">Qt</a>, -our cross-platform GUI toolkit. Qt supports around 15 flavors of Unix, -Microsoft Windows, and around 15 different C++ compilers. We looked at -GNU autoconf, but it was Unix-specific and not flexible enough in our -opinion. Our makefile system also had to deal with Qt <a -href="http://www.troll.no/qt/metaobjects.html">meta object compiler</a> -(moc) issues. The moc program extracts meta information from C++ files and -generates a C++ file with data tables etc. It takes extra work to add -makefile rules for the moc and wanted to automate this task. - -<p> -tmake is written in Perl and requires that you have installed perl version -5 or newer. Basic use of tmake requires no perl knowledge, but if you know -perl you can extend tmake and write your own makefile templates. - -<p> -<b>Windows users:</b> The tmake distribution for Win32 includes tmake.exe -(built by the perl2exe utility) and you do not need to download and -install perl unless you want to modify the tmake source code or run other -perl scripts. You can download perl for Win32 (Windows NT and 95) from <a -href="http://www.activestate.com">www.activestate.com</a> - -<p> -tmake is free software and you may use, copy, modify and distribute tmake -and its documentation for any purpose and without any fee. See the -LICENSE file for details. - -<p> -Feedback is highly appreciated. Contact the author, Haavard Nord <a -href="mailto:hanord@troll.no">(hanord@troll.no)</a>, if you have ideas, -patches etc. for tmake. - -<hr> -<h2>Installation</h2> - -<ol> -<li>Make sure you have perl version 5 or later installed (optional -for Windows users). -<li>Unpack the tmake tar.gz archive for Unix or the tmake .zip file for Windows. -<li>Set the TMAKEPATH environment variable to the directories -containing the template files (see below). -<li>Add the tmake/bin directory to your PATH. -</ol> - -Here are some examples:<p> -<strong>Unix Bourne shell:</strong><pre> - TMAKEPATH=/local/tmake/lib/linux-g++ - PATH=$PATH:/local/tmake/bin - export TMAKEPATH PATH -</pre> - -<strong>Unix C shell:</strong><pre> - setenv TMAKEPATH /local/tmake/lib/linux-g++ - setenv PATH $PATH:/local/tmake/bin -</pre> - -<strong>Microsoft Windows:</strong><pre> - set TMAKEPATH=c:\tmake\lib\win32-msvc - set PATH=%PATH%;c:\tmake\bin -</pre> - -<p> -The template directory name has the form <em>platform</em>-<em>compiler</em> -and contains a platform configuration file (tmake.conf) and tmake template -files. - -<p> -Supported platforms: AIX, Data General, FreeBSD, HPUX, SGI Irix, Linux, -NetBSD, OpenBSD, OSF1/DEC, SCO, Solaris, SunOS, Ultrix, Unixware and -Win32. - -<p> -You can find your platform-compiler combination in the <tt>tmake/lib</tt>. - -<p> -<b>Unix users:</b> tmake requires that perl is in /usr/bin. If your -version of perl is elsewehere, either change the first line of tmake or -make a small shell script which invokes tmake with the correct perl. - - -<hr> -<h2>Getting Started</h2> - -Let's assume you have a small Qt application consisting of one C++ header -file and two source files. - -First you need to create a tmake project file, e.g. hello.pro:<pre> - HEADERS = hello.h - SOURCES = hello.cpp main.cpp - TARGET = hello -</pre> - -Then run tmake to create a Makefile:<pre> - tmake hello.pro -o Makefile -</pre> -And finally:<pre> - make -</pre> -This builds the hello program. Remember to set the <code>TMAKEPATH</code> -environment variable before you run tmake. -<p> -See <a href="m-linux-gcc.html">Makefile for Linux/g++</a>.<br> -See <a href="m-win32-msvc.html">Makefile for Win32/msvc</a> -(Microsoft Visual C++).<br> - - -<hr> -<h2>Makefile Templates</h2> - -The tmake distribution includes three makefile templates and one -configuration file for each platform/compiler combination. The -<code>TMAKEPATH</code> environment variable tells tmake where to find -these files: -<p> -<table border="0"> - <tr> - <td> </td> - <td>app.t</td> - <td> </td> - <td>Creates a makefile for building applications.</td> - </tr> - <tr> - <td> </td> - <td>lib.t</td> - <td> </td> - <td>Creates a makefile for building libraries.</td> - </tr> - <tr> - <td> </td> - <td>subdirs.t</td> - <td> </td> - <td>Creates a makefile for building targets in subdirectories.</td> - </tr> - <tr> - <td> </td> - <td>tmake.conf</td> - <td> </td> - <td>This configuration file contains compiler options and lists - tools and libraries. - </tr> -</table> - - -<p> -The hello.pro project file above does not have a <code>TEMPLATE</code> or -a <code>CONFIG</code> variable. The default template is <tt>app</tt> (the .t -extension is optional) and the default configuration is <tt>qt warn_on -release</tt>. - -This project file produces exactly the same result as the hello.pro -above:<pre> - TEMPLATE = app - CONFIG = qt warn_on release - HEADERS = hello.h - SOURCES = hello.cpp main.cpp - TARGET = hello -</pre> - - - -<h4>Makefile Configuration</h4> - -<p> -The <code>CONFIG</code> variable is recognized by both the app.t and lib.t -templates and specifies what compiler options to use and which extra -libraries to link in. - -These options control the compilation flags: -<p> -<table border="0"> - <tr> - <td> </td> - <td>release</td> - <td> </td> - <td>Compile with optimization enabled, ignored if - "debug" is specified.</td> - </tr> - <tr> - <td> </td> - <td>debug</td> - <td> </td> - <td>Compile with debug options enabled.</td> - </tr> - <tr> - <td> </td> - <td>warn_on</td> - <td> </td> - <td>The compiler should emit more warnings than normally, ignored if - "warn_off" is specified.</td> - </tr> - <tr> - <td> </td> - <td>warn_off</td> - <td> </td> - <td>The compiler should emit no warnings or as few as possible.</td> - </tr> -</table> - -<p> -These options defines the application/library type: -<p> -<table border="0"> - <tr> - <td> </td> - <td>qt</td> - <td> </td> - <td>The target is a Qt application/library and requires Qt header - files/library.</td> - </tr> - <tr> - <td> </td> - <td>opengl</td> - <td> </td> - <td>The target requires the OpenGL (or Mesa) headers/libraries.</td> - </tr> - <tr> - <td> </td> - <td>x11</td> - <td> </td> - <td>The target is a X11 application or library.</td> - </tr> - <tr> - <td> </td> - <td>windows</td> - <td> </td> - <td>The target is a Win32 window application (app.t only).</td> - </tr> - <tr> - <td> </td> - <td>console</td> - <td> </td> - <td>The target is a Win32 console application (app.t only).</td> - </tr> - <tr> - <td> </td> - <td>dll</td> - <td> </td> - <td>The target is a shared object/DLL.</td> - </tr> - <tr> - <td> </td> - <td>staticlib</td> - <td> </td> - <td>The target is a static library (lib.t only).</td> - </tr> -</table> - -<p> -As an example, if the hello application uses both Qt and OpenGL and you -want to compile it for debugging, your <code>CONFIG</code> line should -read:<pre> - CONFIG = qt opengl debug -</pre> - -<p> -The most common tmake options and project variables are described here. -See the tmake <a href="tmake_ref.html">reference manual</a> for -details.<p> - - - -<h4>The Application Template</h4> - -The application template, app.t, lets you compile and link executable -programs or shared objects (DLLs). - -This template recognizes several variabless. -<p> -<table border="0"> - <tr> - <td> </td> - <td>HEADERS</td> - <td> </td> - <td>Header files.</td> - </tr> - <tr> - <td> </td> - <td>SOURCES</td> - <td> </td> - <td>Source files.</td> - </tr> - <tr> - <td> </td> - <td>TARGET</td> - <td> </td> - <td>Name of executable (adds .exe if on Windows).</td> - </tr> - <tr> - <td> </td> - <td>DESTDIR</td> - <td> </td> - <td>Where to put the target.</td> - </tr> - <tr> - <td> </td> - <td>DEFINES</td> - <td> </td> - <td>Tell compiler to define C preprocessor macros (-D option).</td> - </tr> - <tr> - <td> </td> - <td>INCLUDEPATH</td> - <td> </td> - <td>Sets the include file search path for the compiler (-I - option). - </td> - </tr> - <tr> - <td> </td> - <td>DEPENDPATH</td> - <td> </td> - <td>Sets the dependency search path for tmake.</td> - </tr> - <tr> - <td> </td> - <td>DEF_FILE</td> - <td> </td> - <td>Win32 only: Link with a .def file.</td> - </tr> - <tr> - <td> </td> - <td>RC_FILE</td> - <td> </td> - <td>Win32 only: Use a .rc file (compile to temporary .res). - </td> - </tr> - <tr> - <td> </td> - <td>RES_FILE</td> - <td> </td> - <td>Win32 only: Link with a .res file. - </td> - </tr> -</table> - -<p> - - -<h4>The Library Template</h4> - -The library template, lib.t, lets you compile and create static or shared -libraries. - -<p> -The lib.t template supports the same project variables as app.t, but also -<code>VERSION</code>. <code>VERSION</code> is the version number of the -target library, e.g. 1.40. The version is important for shared libraries. - - - -<h4>The Subdirs Template</h4> - -The subdirs template, subdirs.t, lets you invoke make in subdirectories. - -<p>The <code>SUBDIRS</code> variable contains the name of all subdirectories to -be processed. - - -<h4>Special Templates for Microsoft Visual C++</h4> - -If you have Microsoft Visual C++ 5.0, you can use two special templates to -generate a MSVC++ IDE project (.dsp file). After you have generated -e.g. hello.dsp, choose "File"->"Open Workspace" and select the hello.dsp -file. Visual C++ will then create a workspace (.dsw file) for you.<p> -<table border="0"> - <tr> - <td> </td> - <td>vcapp.t</td> - <td> </td> - <td>Creates an application project file (Microsoft Visual C++ 5.0 - only).</td> - </tr> - <tr> - <td> </td> - <td>vclib.t</td> - <td> </td> - <td>Creates a library project file (Microsoft Visual C++ 5.0 - only).</td> - </tr> -</table> - -<p> -Run tmake to create a hello.dsp file (use -t to override the default -template):<pre> - tmake -t vcapp -o hello.dsp hello.pro -</pre> - - -<hr> -<h2>Project File Syntax</h2> - -The tmake project file has a very simple syntax. You may set -project variables, append to project variables, remove from -project variable and substitute project variables. - -To set a project variable:<pre> - HEADERS = gui.h xml.h url.h -</pre> - -If you cannot fit everything on one line, use '\' to split it up:<pre> - HEADERS = gui.h \ - xml.h \ - url.h -</pre> - -<p> -Project variables contains lists of items (such as header files, -compiler options etc.) and use whitespace to separate the items. -This means that tmake cannot deal with items containing whitespace. -The INCLUDEPATH variable is an exception. If INCLUDEPATH contains -one or more semicolons (;), tmake uses the semicolon to separate -the include directories, hence you can have include directories -containing whitespace (this is quite common on Windows). - -<p> -Here is an example:<pre> - INCLUDEPATH = C:\Program Files\DBLib\Include;C:\qt\include -</pre> - -<p> -tmake supports <em>project variable expension</em>. Use $$ to expand -any project variable:<pre> - ALLFILES = $$HEADERS $$SOURCES -</pre> - -<p> -Most often you assign some value to a project variable, but you can -also add to, remove from or replace parts of a project variable.<pre> - A = abc - X = xyz - A += def # A = abc def - X *= xyz # X = xyz - B = $$A # B = abc def - B -= abc # B = def - X /= s/y/Y/ # X = xYz -</pre> -The *= operation adds the value if the variable does not already contain it. -The /= operation performs regular expression substitution. - -<p> -You can also set variables from the command line when running the tmake -program. For instance, if you want to generate a makefile with debug -information:<pre> - tmake "CONFIG+=debug" hello.pro -</pre> - -<p> -Use the <tt>unix:</tt> or <tt>win32:</tt> (conditional) qualifier if you want a -platform-specific variable:<pre> - SOURCES = common.cpp # common for all platforms - unix:SOURCES += unix.cpp # additional sources for Unix - win32:SOURCES += win32.cpp # additional sources for Windows - unix:LIBS += -lm # on Unix we need the math lib -</pre> -If none of the platforms match, tmake looks for the variable in CONFIG -variable:<pre> - debug:SOURCES += dbgstuff.cpp # additional source for debugging -</pre> - -Finally, you can set platform and compiler-dependent variables:<pre> - linux-g++:TMAKE_CFLAGS = -fno-rtti -</pre> - -<p> -You may define your own project variables to be used by custom templates. A -project variable is stored in <code>%project</code>, which is an associative -Perl array. Access it like this: <code>$project{"var"}</code> or via the -function <code>Project("var")</code>. For example, after reading -"hello.pro", <code>$project{"SOURCES"}</code> contains "hello.cpp -main.cpp".<p> - - -<hr> -<h2><a name="usage"></a>Running tmake</h2> - -Usage:<pre> - tmake [options] <em>project files or project settings</em> -</pre> -Options:<pre> - -e expr Evaluate the Perl expression. Ignores the template file. - -nodepend Don't generate dependency information. - -o <em>file</em> Write output to <em>file</em> instead of stdout. - -t <em>file</em> Specify a template <em>file</em>. - -unix Force tmake into Unix mode. - -v Verbose/debugging on. - -win32 Force tmake into Win32 mode. -</pre> - -The -t option overrides any <code>TEMPLATE</code> variable in the project file. -<p> -The default project file extension is ".pro". The default template file -extension is ".t". If you do not specify these extension tmake will -automatically add them for you. - -<p> -Example of basic use:<pre> - tmake hello -o Makefile -</pre> - -<p> -Example of how to create a makefile with debugging information:<pre> - tmake "CONFIG+=debug" hello -o Makefile -</pre> - -<p> -Exmaple of how to specify a TMAKEPATH:<pre> - tmake "TMAKEPATH=/local/tmake/lib/hpux-g++" hello.pro -o Makefile -</pre> - -Example of how to evaluate a perl expression (print names of headers -and source files):<pre> - tmake hello -e 'Expand("HEADERS","SOURCES")' -</pre> - -<hr> -<h2><a name="progen"></a>The progen Utility</h2> - -The progen utility creates project files for you. It can be used like -this:<pre> - progen -n hello -o hello.pro -</pre> -If no .cpp or .h files are specified on the command line, progen -searches for .cpp and .h (except moc_*.cpp) in the current directory -and below. -<p> -Usage:<pre> - progen [options] [<em>C/C++ header files and source files</em>] -</pre> -Options:<pre> - -lower Lower-case letters in filenames (useful on Windows). - -n <em>name</em> Specify a project name (<code>TARGET</code>). - -o <em>file</em> Write output to <em>file</em> instead of stdout. - -t <em>file</em> Specify a template <em>file</em>. -</pre> - - -<hr> -<h2>Advanced Topics</h2> - -In most cases you will be happy with using tmake as described above, but -sometimes you need to add special compiler options or even add new -makefile rules. This chapter describes how to customize your makefiles. - -<h4>Conditional Project Settings</h4> - -If you need a special compiler option etc., you can add platform-dependent -settings in your project file:<pre> - solaris-cc:TMAKE_CC = /opt/bin/CC_5.0 - solaris-cc:TMAKE_CFLAGS = -pts - unix:TMAKE_LIBS = -lXext - win32:INCLUDEPATH = c:\myinclude - win32-borland:DEFINES = NO_BOOL -</pre> - -You can prefix a project variable with unix: or win32: to make it specific for -either Unix or Windows. You can also prefix a variable with -<em>platform-compiler</em> - -<h4>Your Own Templates</h4> - -If you know Perl programming, there is virtually no limitation to what you -can do with tmake. First you need to know how tmake works. - -<h4>Template Processing</h4> - -When you run tmake, it first reads the <tt>tmake.conf</tt> file. -This configuration file has the same syntax as the project file. - -tmake then reads the project file and sets the project variables it -finds, e.g. <code>HEADERS</code>, <code>SOURCES</code> etc. - -All variables and values are stored in a global associative Perl hash -array called <code>project</code>. For example, -<code>$project{"SOURCES"}</code> contains "hello.cpp main.cpp" -after processing hello.pro. - -When both the <tt>tmake.conf</tt> and the project files have been -read, tmake starts reading the template file line by line and -executes any Perl code it finds in the template. - -<ul> -<li>Anything after <code>#$</code> until newline is - evaluated as perl code. The perl code is substituted - with the contents of the <code>$text</code> - variable. -<li>Block of perl code: <code>#${</code> until - <code>#$}</code>. -<li>Comments; <code>#!</code> until newline is stripped. -<li>Anything else is copied directly from the template to - the output. -</ul> - -<p> -Example:<pre> - #! This is a comment which will be removed. - This text will appear in the output. - #$ $text = "The header file(s) are: " . $project{"HEADERS"}; - # This text also appears in the output. - #${ - $a = 12; - $b = 13; - $text = $a * $b; - #$} - That's all. -</pre> -Output:<pre> - This text will appear in the output. - The header file(s) are: hello.h - # This text also appears in the output. - 156 - That's all. -</pre> - - -<h3>Using tmake With Lex and Yacc</h3> - -The standard tmake templates knows how to process C and C++ files, but -sometimes you need to process additional files and link them into your -project. A typical example is to process lex and yacc files when you're -building a parser. - -<p> -Parser template:<pre> - #! - #! parser.t: This is a custom template for building a parser - #! - #$ IncludeTemplate("app.t"); - - ####### Lex/yacc programs and options - - LEX = flex - YACC = #$ $text = ($is_unix ? "yacc -d" : "byacc -d"); - - ####### Lex/yacc files - - LEXIN = #$ Expand("LEXINPUT"); - LEXOUT = lex.yy.c - YACCIN = #$ Expand("YACCINPUT"); - YACCOUT = y.tab.c - YACCHDR = y.tab.h - PARSER = #$ Expand("PARSER"); - - ####### Process lex/yacc files - - $(LEXOUT): $(LEXIN) - $(LEX) $(LEXIN) - - $(PARSER): $(YACCIN) $(LEXOUT) - $(YACC) $(YACCIN) - #$ $text = ($is_unix ? "-rm -f " : "-del ") . '$(PARSER)'; - #$ $text = ($is_unix ? "-mv " : "-ren ") . '$(YACCOUT) $(PARSER)'; -</pre> - -The parser template adds some extra rules to the application template -in order to build the lex and yacc portions of the project. This -template is portable across Unix and Windows since it generates different -commands depending on the <code>$is_unix</code> variable. - -<p> -To learn more about the Expand() function and other Perl functions which -tmake provides, consult the <a href="tmake_ref.html">reference manual</a>. - -<p> -Example project file:<pre> - TEMPLATE = parser.t - CONFIG = console release - LEXINPUT = lexer.l - YACCINPUT = grammar.y - PARSER = parser.cpp - SOURCES = $$PARSER \ - node.cpp \ - asmgen.cpp - TARGET = parser -</pre> - -Here we use macro expansion <code>$$PARSER</code> to avoid writing parser.cpp -two places. - - -<h3>Counting the Number of Code Lines</h3> - -tmake is generic since it is based on Perl. You can create your own -templates for other purposes than producing makefiles. Here is an example -template that counts the number of code lines in our project. - -<p> -Template wc.t:<pre> - #! Template that count number of C++ lines. - The number of C++ code lines for #$ $text=$project_name; - #${ - $files = $project{"HEADERS"} . " " . $project{"SOURCES"}; - $text = `wc -l $files`; - #$} -</pre> -Run it:<pre> - tmake -t wc hello -</pre> -Output:<pre> - The number of C++ code lines for hello.pro - 25 hello.h - 98 hello.cpp - 38 main.cpp - 161 total -</pre> -This will only work if the wc program is installed on your system. - - -</body></html> diff --git a/tmake/doc/tmake_ref.html b/tmake/doc/tmake_ref.html deleted file mode 100644 index c9124c4..0000000 --- a/tmake/doc/tmake_ref.html +++ /dev/null @@ -1,463 +0,0 @@ -<!doctype HTML public "-//W3C//DTD HTML 3.2//EN"> -<html><head><title> -Reference Manual - tmake -</title></head><body bgcolor="#ffffff"> -<p><h1 align=center>Reference Manual - tmake</h1> - -<hr> -<h2>Project Variable Reference</h2> - -<h4><a name="ALL_DEPS"></a>ALL_DEPS</h4> -Specifies additional dependencies for the makefile target "all:".<p> - - -<h4><a name="CLEAN_FILES"></a>CLEAN_FILES</h4> -Specifies additional files to be removed for "make clean".<p> -Example:<pre> - CLEAN_FILES = core *~ -</pre> - - -<h4><a name="CONFIG"></a>CONFIG</h4> -Sets the make configuration. It tells the tmake templates what compiler -options to use and which extra libraries to link in.<p> -These options control the compilation flags: -<p> -<table border="0"> - <tr> - <td> </td> - <td>release</td> - <td> </td> - <td>Compile with optimization enabled, ignored if - "debug" is specified.</td> - </tr> - <tr> - <td> </td> - <td>debug</td> - <td> </td> - <td>Compile with debug options enabled.</td> - </tr> - <tr> - <td> </td> - <td>warn_on</td> - <td> </td> - <td>The compiler should emit more warnings than normally, ignored if - "warn_off" is specified.</td> - </tr> - <tr> - <td> </td> - <td>warn_off</td> - <td> </td> - <td>The compiler should emit no warnings or as few as possible.</td> - </tr> -</table> - -<p> -These options defines the application/library type: -<p> -<table border="0"> - <tr> - <td> </td> - <td>qt</td> - <td> </td> - <td>The target is a Qt application/library and requires Qt header - files/library.</td> - </tr> - <tr> - <td> </td> - <td>opengl</td> - <td> </td> - <td>The target requires the OpenGL (or Mesa) headers/libraries.</td> - </tr> - <tr> - <td> </td> - <td>x11</td> - <td> </td> - <td>The target is a X11 application (app.t only).</td> - </tr> - <tr> - <td> </td> - <td>windows</td> - <td> </td> - <td>The target is a Win32 window application (app.t only).</td> - </tr> - <tr> - <td> </td> - <td>console</td> - <td> </td> - <td>The target is a Win32 console application (app.t only).</td> - </tr> - <tr> - <td> </td> - <td>dll</td> - <td> </td> - <td>The target is a shared object/DLL (app.t only).</td> - </tr> - <tr> - <td> </td> - <td>staticlib</td> - <td> </td> - <td>The target is a static library (lib.t only).</td> - </tr> -</table> - - -<h4><a name="DEFINES"></a>DEFINES</h4> -Specifies C/C++ macros (-D compiler option). On Windows you need -to let DEFINES contain "QT_DLL" if you are building a Qt program -which should link with the Qt DLL. - - -<h4><a name="DEF_FILE"></a>DEF_FILE</h4> -Win32/app.t only: Specifies a .def file. - - -<h4><a name="DESTDIR"></a>DESTDIR</h4> -Specifies where to put the target file. -Example:<pre> - DESTDIR = ../../lib -</pre> -You must create this directory before running make. - - -<h4><a name="HEADERS"></a>HEADERS</h4> -Defines the header files of the project. - - -<h4><a name="INCPATH"></a>INCPATH</h4> -This variable is generated from <code>INCLUDEPATH</code>. The ';' or ':' -separators have been replaced by ' ' (single space). This makes it -easier to split. qtapp.t and other templates expand -<code>INCPATH</code> to set -I options for the C++ compiler. - - -<h4><a name="INCLUDEPATH"></a>INCLUDEPATH</h4> -This variable specifies the #include directories. It can be set in the -project file, or by the <a href="#AddIncludePath">AddIncludePath()</a> -function.<p> -Example:<pre> - INCLUDEPATH = c:\msdev\include d:\stl\include -</pre> -Use ';' or space as the directory separator. - - -<h4><a name="LIBS"></a>LIBS</h4> -Defines additional libraries to be linked in when creating an application -or a shared library. You probably want to use a platform qualifier since -libraries are specified differently on Unix and Win32.<p> -Example:<pre> - unix:LIBS = -lXext -lm - win32:LIBS = ole32.lib -</pre> - - -<h4><a name="MOC_DIR"></a>MOC_DIR</h4> -Specifies where to put the temporary moc output files. By default they -are stored in the directory where the moc input files are. -<p> -Example:<pre> - MOC_DIR = tmp -</pre> -You must create this directory before running make. -<p> -See also: <a href="#OBJECTS_DIR">OBJECTS_DIR</a>. - - -<h4><a name="OBJECTS"></a>OBJECTS</h4> -This varialble is generated from <code>SOURCES</code> by the StdInit() function. -The extension of each source file has been replaced by .o (Unix) or .obj -(Win32).<p> -Example:<pre> - SOURCES = a.x b.y -</pre> -Then <code>OBJECTS</code> become "a.o b.o" on Unix and "a.obj b.obj" on -Win32. - - -<h4><a name="OBJECTS_DIR"></a>OBJECTS_DIR</h4> -Specifies where to put object files. By default they are stored in -the directory where the source files are.<p> -Example:<pre> - OBJECTS_DIR = tmp -</pre> -You must create this directory before running make. -<p> -See also: <a href="#MOC_DIR">MOC_DIR</a>. - - -<h4><a name="OBJMOC"></a>OBJMOC</h4> -This variable is generated by the <a href="#StdInit">StdInit()</a> function if -<code>$moc_aware</code> is true. <code>OBJMOC</code> contains the name of -all intermediate moc object files.<p> -Example:<pre> - HEADERS = demo.h - SOURCES = demo.cpp main.cpp -</pre> -If <tt>demo.h</tt> and <tt>main.cpp</tt> define classes that use signals -and slots (i.e. the <code>Q_OBJECT</code> "keyword" is found in these two -files), <code>OBJMOC</code> becomes:<pre> - OBJMOC = moc_demo.obj -</pre> -See also: <a href="#SRCMOC">SRCMOC</a>. - - -<h4><a name="PROJECT"></a>PROJECT</h4> -This is the name of the project. It defaults to the name of the project -file, excluding the .pro extension. - - -<h4><a name="RC_FILE"></a>RC_FILE</h4> -Win32/app.t only: Specifies a .rc file. Cannot be used with the RES_FILE -variable. - - -<h4><a name="RES_FILE"></a>RES_FILE</h4> -Win32/app.t only: Specifies a .res file. You can either specify a -.rc file or one or more .res files. - - -<h4><a name="SOURCES"></a>SOURCES</h4> -Defines the source files of the project. - - -<h4><a name="SRCMOC"></a>SRCMOC</h4> -This variable is generated by the <a href="#StdInit">StdInit()</a> function if -<code>CONFIG</code> contains "qt". <code>SRCMOC</code> contains the name of -all intermediate moc files.<p> -Example:<pre> - HEADERS = demo.h - SOURCES = demo.cpp main.cpp -</pre> -If <tt>demo.h</tt> and <tt>main.cpp</tt> define classes that use signals -and slots (i.e. the <code>Q_OBJECT</code> "keyword" is found in these two -files), <code>SRCMOC</code> becomes:<pre> - SRCMOC = moc_demo.cpp main.moc -</pre> -See also: <a href="#OBJMOC">OBJMOC</a>. - - -<h4><a name="TARGET"></a>TARGET</h4> -Sets the makefile target, i.e. what program to build. - - -<h4><a name="TEMPLATE"></a>TEMPLATE</h4> -Sets the default template. This can be overridden by the tmake -t -<a href="tmake.html#usage">option</a>. - - -<h4><a name="TMAKE_CC"></a>TMAKE_CC</h4> -Contains the name of the compiler. - - -<h4><a name="TMAKE_CFLAGS"></a>TMAKE_CFLAGS</h4> -Contains the default compiler flags. - - -<h4><a name="TMAKE_FILEVARS"></a>TMAKE_FILEVARS</h4> -Tells tmake which variables contain file names. This is because tmake -on Windows replace the directory separator / with \. - - -<hr> -<h2>Function Reference</h2> -This section contains a brief description of some important -tmake functions used by the templates. - - -<h3><a name="AddIncludePath"></a>AddIncludePath(path)</h3> -Adds <em>path</em> to the include path variable, -<a href="#INCLUDEPATH">INCLUDEPATH</a>. The include path is used -for two purposes:<ol> -<li>Searching files when generating include dependencies. -<li>Setting -I options for the C/C++ compiler. -</ol> -<p> -Example:<pre> - #$ AddIncludePath('$QTDIR/include;/local/include'); -</pre> - - -<h3>BuildMocObj(objects,sources)</h3> -Creates build rules for moc source files. Generates -include dependencies.<p> -Example:<pre> - #$ BuildMocObj($project{"OBJMOC"},$project{"SRCMOC"}); -</pre>Output:<pre> - moc_hello.o: moc_hello.cpp \ - hello.h \ - ... -</pre> - -<h3>BuildMocSrc(files)</h3> -Creates moc source files from C++ files containing classes that -define signals and slots. For a header file <tt>x.h</tt>, the -generated moc file is called <tt>moc_x.h</tt>. For a source file -<tt>y.cpp</tt>, the generates moc file is called <tt>y.moc</tt> and -should be #include'd by <tt>y.cpp</tt>.<p> -Example:<pre> - #$ BuildMocSrc($project{"HEADERS"}); - #$ BuildMocSrc($project{"SOURCES"}); -</pre>Output:<pre> - moc_hello.cpp: hello.h - $(MOC) hello.h -o moc_hello.cpp -</pre> - - -<h3>BuildObj(objects,sources)</h3> -Creates build rules for source files. Generates -include dependencies.<p> -Example:<pre> - #$ BuildObj($project{"OBJECTS"},$project{"SOURCES"}); -</pre>Output:<pre> - hello.o: hello.cpp \ - hello.h \ - ... - - main.o: main.cpp \ - hello.h \ - ... -</pre> - - -<h3>Config(string)</h3> -Returns true if the <code>CONFIG</code> variable contains the given string. -<p>Example:<pre> - #$ if ( Config("release") { } -</pre> - - -<h3>DisableOutput()</h3> -Call this function to force tmake to generate no output until -EnableOutput() is called. -<p>Example:<pre> - #$ Config("debug") && DisableOutput(); - Anything here is skipped if CONFIG contains "debug". - #$ Config("debug") && EnableOutput(); -</pre> - - -<h3>EnableOutput()</h3> -Enables tmake output after DisableOutput() was called. - - -<h3>Expand(var)</h3> -Expands a project variable. Equivalent to <code>$text = $project{$var}</code>. -<p>Example:<pre> - VERSION = #$ Expand("VERSION"); -</pre>Output:<pre> - VERSION = 1.1 -</pre> - -<h3>ExpandGlue(var,prepend,glue,append)</h3> -Expands a $project{} variable, splits on whitespace -and joins with $glue. $prepend is put at the start -of the string and $append is put at the end of the -string. The resulting string ($text) becomes "" if -the project variable is empty or not defined.<p> -Example:<pre> - clear: - #$ ExpandGlue("OBJECTS","-del","\n\t-del ",""); -</pre>Output (Windows NT):<pre> - clear: - -del hello.obj - -del main.obj -</pre> - - -<h3>ExpandList(var)</h3> -This function is suitable for expanding lists of files. -Equivalent with <code>ExpandGlue($var,""," \\\n\t\t","")</code>.<p> -Example:<pre> - OBJECTS = #$ ExpandList("OBJECTS"); -</pre>Output:<pre> - OBJECTS = hello.o \ - main.o -</pre> - - -<h3>ExpandPath(var,prepend,glue,append)</h3> -Similar to ExpandGlue, except that it splits the items on a semicolon -instead of space (if the variable contains at least one semicolon). - - -<h3>IncludeTemplate(file)</h3> -Includes a template file. The ".t" extension is optional.<p> -Example:<pre> - #$ IncludeTemplate("mytemplate"); -</pre> - - -<h3>Now()</h3> -Sets $text to the current date and time.<p> -Example:<pre> - # Generated at #$ Now() -</pre>Output:<pre> - # Generated at 12:58, 1996/11/19 -</pre> - - -<h3>Project(strings)</h3> -This is a powerful function for setting and reading project -variables. Returns the resulting project variables (joined with space -between). -<p>Examples:<pre> -# Get a project variable: - $s = Project("TEMPLATE"); -> $s = "TEMPLATE" - -# Set a project variable: - Project("TEMPLATE = lib"); -> TEMPLATE = lib - Project("CONFIG =";) -> CONFIG empty - -# Append to a project variable: - Project("CONFIG = qt"); -> CONFIG = qt - Project("CONFIG += debug"); -> CONFIG = qt debug - -# Append to a project variable if it does not contain the value already: - Project("CONFIG = qt release"); -> CONFIG = qt release - Project("CONFIG *= qt"); -> CONFIG = qt release - Project("CONFIG *= opengl"); -> CONFIG = qt release opengl - -# Subtract from a project variable: - Project("THINGS = abc xyz"); -> THINGS = abc xyz - Project("THINGS -= abc"); -> THINGS = xyz - -# Search/replace on a project variable: - Project("CONFIG = tq opengl"); -> CONFIG = tq opengl - Project("CONFIG /= s/tq/qt/"); -> CONFIG = qt opengl - -# The operations can be performed on several project variables at a time. - - Project("TEMPLATE = app", "CONFIG *= opengl", "THINGS += klm"); -</pre> - - -<h3><a name="ScanProject"></a>ScanProject(file)</h3> -Scans a project file and stores the project variables and values in the -global associative <code>%project</code> array. - - -<h3><a name="StdInit"></a>StdInit()</h3> -Standard initialization of tmake. StdInit() should be -called from one of the first lines in the template.<p> - -This function creates some new project variables:<ul> -<li><code><a href="#OBJECTS">OBJECTS</a></code> - - Object files corresponding to - <code><a href="#SOURCES">SOURCES</a></code>. -<li><code><a href="#SRCMOC">SRCMOC</a></code> - moc source files. -<li><code><a href="#OBJMOC">OBJMOC</a></code> - moc object files. -</ul> - -The moc-related variables are created only if <code>CONFIG</code> contains "qt" - - -<h3>Substitute(string)</h3> -This function takes a string and substitutes any occurrence of $$var -with the actual content of the variable. Returns the substituted string. -Also sets $text. -<p> -Important: Use single quotes around the string, otherwise perl will expand -any $vars it finds. -<p>Example:<pre> - Substitute('Project name: $$PROJECT, uses template $$TEMPLATE'); -</pre> |