Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.
TMAKE was written specifically for creating makefiles for Qt applications. We faced this situation:
TMAKE is written in Perl and requires perl version 5 or newer. You do not need to be familiar with Perl programming to use TMAKE, but you should learn Perl if you want to write your own templates.
You'll find more information about Perl on www.perl.com. You can download perl for Win32 (Windows NT and 95) from www.activeware.com
UNIX Bourne shell:
TMAKEPATH=/local/tmake/lib/linux-gcc PATH=$PATH:/local/tmake/bin export TMAKEPATH PATHUNIX C shell:
setenv TMAKEPATH /local/tmake/lib/linux-gcc setenv PATH $PATH:/local/tmake/binWindows NT and Windows 95:
set TMAKEPATH=c:\tmake\lib\win32-msvc set PATH=%PATH%;c:\tmake\binThe template directory name has the form platform-compiler. Each template directory contains template files and a configuration file.
Supported platforms and compilers:
freebsd-gcc | FreeBSD and GNU gcc | ||
hpux-cc | HPUX and HP CC | ||
hpux-gcc | HPUX and GNU gcc | ||
irix-dcc | SGI IRIX and DCC | ||
irix-gcc | IRIX and GNU gcc | ||
linux-gcc | Linux and GNU gcc | ||
netbsd-gcc | NetBSD and GNU gcc | ||
sco-gcc | SCO UNIX and GNU gcc | ||
solaris-cc | Sun Solaris and Sun CC | ||
solaris-gcc | Sun Solaris and GNU gcc | ||
sunos-gcc | SunOS and GNU gcc | ||
win32-borland | Windows 95/NT and Borland C++ | ||
win32-gcc | Windows 95/NT and Cygnus GNU Win32 gcc | ||
win32-msvc | Windows 95/NT and Microsoft Visual C++ | ||
win32-symantec | Windows 95/NT and Symantec C++ | ||
win32-watcom | Windows 95/NT and Watcom C++ |
HEADERS = hello.h SOURCES = hello.cpp main.cpp TARGET = helloThen run tmake to create a Makefile:
tmake hello.pro -o MakefileAnd finally:
makeThis builds the hello program. Remember to set the
TMAKEPATH
environment variable before you run tmake.
See Makefile for Linux/gcc.
See Makefile for Win32/msvc
(Microsoft Visual C++).
app.t | Creates a makefile for building applications. | ||
lib.t | Creates a makefile for building libraries. | ||
tmake.conf | This configuration file contains compiler options and lists tools and libraries. |
If you have Microsoft Visual C++ 5.0, you can use two special templates to generate project (.dsp) files. 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 for you.
vcapp.t | Creates an application project file (Microsoft Visual C++ 5.0 only). | ||
vclib.t | Creates a library project file (Microsoft Visual C++ 5.0 only). |
The hello.pro project file above does not have a TEMPLATE or a CONFIG tag. The default template is app (the .t extension is optional) and the default configuration is qt warn_on release:
TEMPLATE = app CONFIG = qt warn_on release HEADERS = hello.h SOURCES = hello.cpp main.cpp TARGET = helloThis project file produces exactly the same result as the original project file. If you're building a library instead of an application you can use the library template instead of the application template:
TEMPLATE = lib VERSION = 1.9
The VERSION tag is recognized by the lib.t template and defines the library version. This is important for UNIX shared libraries, but ignored on Windows.
The CONFIG tag is recognized by both the app.t and lib.t templates and tells the TMAKE templates what compiler options to use and which extra libraries to link in.
qt | This is a Qt application. Tells tmake to add rules for moc files and link with the Qt library. | ||
opengl | This is an application which requires the OpenGL library. | ||
warn_on | The compiler should emit more warnings than normally. This option is ignored if "warn_off" is specified. | ||
warn_off | The compiler should emit no warnings or as few as possible. | ||
release | Compile with optimization enabled. This option is ignored if "debug" is specified. | ||
debug | Compile with debug options enabled. |
As an example, if the hello application uses both Qt and OpenGL and you want to compile it for debugging, your CONFIG line must read:
CONFIG = qt opengl debug
This is all you need to know to start using TMAKE.
tmake [options] project-fileOptions:
-e expr Evaluate the Perl expression. Ignores the template file. -nodepend Don't generate dependency information. -o file Write output to file instead of stdout. -p file Load an additional project file. -t file Specify a template file. -v Verbose/debugging on.The -t option overrides any TEMPLATE tag in the project file.
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.
progen -n hello -o hello.proIf 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.
Usage:
progen [options] [C/C++ header files and source files]Options:
-lower Lower-case letters in filenames (useful on Windows). -n name Specify a project name (TARGET). -o file Write output to file instead of stdout. -t file Specify a template file.
HEADERS
, SOURCES
etc.
All tags and values are stored in a global associative Perl hash
array called project
. For example,
$project{"SOURCES"}
contains "hello.cpp main.cpp"
after processing hello.pro.
When both the tmake.conf 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.
#$
until newline is
evaluated as perl code. The perl code is substituted
with the contents of the $text
variable.
#${
until
#$}
.
#!
until newline is stripped.
Example:
#! 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.Output:
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.
Parser template:
#! #! 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): $(YACCINPUT) $(LEXOUT) $(YACC) $(YACCINPUT) #$ $text = ($is_unix ? "-rm -f " : "-del ") . '$(PARSER)'; #$ $text = ($is_unix ? "-mv " : "-ren ") . '$(YACCOUT) $(PARSER)';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
$is_unix
variable.
To learn more about the Expand() function and other Perl functions which TMAKE provides, please consult the reference manual.
Example project file:
TEMPLATE = parser.t CONFIG = release LEXINPUT = lexer.l YACCINPUT = grammar.y PARSER = parser.cpp SOURCES = $$PARSER \ node.cpp \ asmgen.cpp TARGET = parserHere we use macro expansion
$$PARSER
to avoid writing parser.cpp
two places.
Template wc.t:
#! 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`; #$}Run it:
tmake -t wc helloOutput:
The number of C++ code lines for hello.pro 25 hello.h 98 hello.cpp 38 main.cpp 161 totalThis will only work if the wc program is installed on your system.