<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ANTLR3C: Building From Source</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ANTLR3C <span id="projectnumber">3.1.2</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('build.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>Building From Source </h1> </div>
</div>
<div class="contents">
<div class="textblock"><p>The C runtime is provided in source code form only as there are too many binary versions to sensibly maintain binaries on www.antlr.org.</p>
<p>The runtime code is provided with .sln and .vcproj files for Visual Studio 2005 and 2008, and <b>configure</b> files for building and installation on UNIX or other systems that support this tool. If your system is neither Windows nor <b>configure</b> compatible, then you should find it reasonable to build the code manually (see section "Building Manually".)</p>
<h2><a class="anchor" id="src"></a>
Source Code Organization</h2>
<p>The source code expands from a tar/zip file to give you the following directories:</p>
<ul>
<li><b>./</b> The location of the configure script and the antlr3config.h file generated by the running the configure script.This directory also contains the solution and project files for visual studio 2005 and 2008.</li>
<li><b>./src</b> The location of all the C files in the project.</li>
<li><b>./include</b> The location of all the header files for the project</li>
<li><b>./doxygen</b> The location of documentation files such as the one that generates this page</li>
<li>Other ancillary directories used by the build or documentation process.</li>
</ul>
<h2><a class="anchor" id="winbuild"></a>
Building for Windows</h2>
<p>If you are building for Cygwin, or a similar UNIX on Windows System, follow the "Building With Configure" instructions below.</p>
<p>Note that the runtime is no longer compatible with the VC6 Microsoft compiler. If you absolutely need to build with this compiler, you can probably hack the source code to deall with the pieces that VC6 cannot handle such as the ULL suffix for constants.</p>
<p>If you wish to build the binaries for Windows using Visual Studio 2005, or 2008 you may build using the IDE:</p>
<ol type="1">
<li>Open the C.sln file</li>
<li>Select batch Build from the Build menu</li>
<li>Select all configurations and press the build button.</li>
</ol>
<p>If you wish or need to build the libraries from the command line, then you must use a Windows command shell configured for access to VS2005/VS2008 compilers, such as the one that is started from:</p>
<p><em>Start->Microsoft Visual Studio 2005->Visual Studio Tools->Visual Studio 2005 Command Prompt</em></p>
<p>There appears to be no way to build all targets at once in a batch mode from the command line, so you may build one or all of the following: </p>
<div class="fragment"><pre class="fragment">
C:\antlrsrc\code\antlr\main\runtime\C> DEVENV C.sln /Build ReleaseDLL
C:\antlrsrc\code\antlr\main\runtime\C> DEVENV C.sln /Build Release
C:\antlrsrc\code\antlr\main\runtime\C> DEVENV C.sln /Build DebugDLL
C:\antlrsrc\code\antlr\main\runtime\C> DEVENV C.sln /Build Debug
</pre></div><p>After the build is complete you will find the <code></code>. and <code></code>. files under the directory containing C.sln, in a subdirectory named after the /Build target. In the Release and Debug targets, you will find that there is only a <code></code>. archive file, which you can link directly into your own projects if you wish to avoid the DLL. In <code>ReleaseDLL</code> and <code>DebugDLL</code> you will find both a <code></code>.LIB file which you should link your projects with and a DLL. The library and names on Windows are as follows:</p>
<div class="fragment"><pre class="fragment">
- ReleaseDLL : ANTLR3C.DLL and ANTLR3C_DLL.LIB
- DebugDLL : ANTLR3CD.DLL and ANTLR3CD_DLL.LIB
- Release : ANTLR3C.LIB
- Debug : ANTLR3CD.LIB
</pre></div><p>There currently no .msi modules or other installs built for Windows, so you must place the DLLs in a directory referenced by the PATH environment variable and make the include directory available to your project configurations.</p>
<h2><a class="anchor" id="configure"></a>
Building with configure</h2>
<p>Before starting, make sure that you are using a source code distribution and not the source code directly from the Perforce repository. If you use the source from the perforce tree directly, you will find that there is no configure script as this is generated as part of the distribution build by the maintainers. If you feel the need to build from the distribution tree then you must have all the autobuild packages available on your system and can generate the configure script using autoreconf. If you are not familiar with these tools, then please use the tgz files in the dist subdirectory (or downloaded from the ANTLR web site).</p>
<p>The source code file should be expanded in a directory of your choice (probably your working directory) using the command:</p>
<div class="fragment"><pre class="fragment">
gzip -dc antlrtgzname.tar.gz | tar xvf -
</pre></div><p>Where: <b>antlrtgzname.tar.gz</b> is of course the name of the tar when you downloaded it. You should find a <b>configure</b> script in the sub directory thus created.</p>
<p>The configure script accepts the usual options, such as --prefix= but the default is to build in the source directory and to place libraries in <b>/usr/local/lib</b> and include files (for building your recognizers) in <b>/usr/local/include</b>. There are also a number of antlr specific options, which you may wish to utilize. The command: </p>
<div class="fragment"><pre class="fragment">
./configure --help
</pre></div><p>Will document the latest incarnations of these options in case this documentation is ever out of date. At this time the options are:</p>
<div class="fragment"><pre class="fragment">
--enable-debuginfo Compiles debug info into the library (default no)
--enable-64bit Turns on flags that produce 64 bit object code if
any are required (default no)
</pre></div><p>Unless you need 64 bit builds, or a change in library types, you will generally use the configure command without options:</p>
<p>Here is a sample configure output:</p>
<div class="fragment"><pre class="fragment">
[jimi@localhost dist]$ tar zvxf libantlr3c-3.0.0-rc8.tar.gz
libantlr3c-3.0.0-rc8/
libantlr3c-3.0.0-rc8/antlr3config.h
libantlr3c-3.0.0-rc8/src/
libantlr3c-3.0.0-rc8/src/antlr3stringstream.c
...
libantlr3c-3.0.0-rc8/antlr3config.h.in
</pre></div> <div class="fragment"><pre class="fragment">
[jimi@localhost dist]$ cd libantlr3c-3.0.0-rc
</pre></div> <div class="fragment"><pre class="fragment">
[jimi@localhost libantlr3c-3.0.0-rc8]$ ./configure
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
checking for xlc... no
checking for aCC... no
checking for gcc... gcc
...
checking for strdup... yes
configure: creating ./config.status
config.status: creating Makefile
config.status: creating antlr3config.h
config.status: antlr3config.h is unchanged
config.status: executing depfiles commands
</pre></div><p>Having configured the library successfully, you need only make it, and install it:</p>
<div class="fragment"><pre class="fragment">
[jimi@localhost libantlr3c-3.0.0-rc8]$ make
</pre></div> <div class="fragment"><pre class="fragment">
make all-am
make[1]: Entering directory `/home/jimi/antlrsrc/code/antlr/main/runtime/C/dist/libantlr3c-3.0.0-rc8'
/bin/sh ./libtool --tag=CC --mode=compile gcc -DHAVE_CONFIG_H -I. -Iinclude -Iinclude -O2 -MT antlr3baserecognizer.lo -MD -MP -MF .deps/antlr3baserecognizer.Tpo -c -o antlr3baserecognizer.lo `test -f 'src/antlr3baserecognizer.c' || echo './'`src/antlr3baserecognizer.c
...
gcc -shared .libs/antlr3baserecognizer.o .libs/antlr3basetree.o .libs/antlr3basetreeadaptor.o .libs/antlr3bitset.o .libs/antlr3collections.o .libs/antlr3commontoken.o .libs/antlr3commontree.o .libs/antlr3commontreeadaptor.o .libs/antlr3commontreenodestream.o .libs/antlr3cyclicdfa.o .libs/antlr3encodings.o .libs/antlr3exception.o .libs/antlr3filestream.o .libs/antlr3inputstream.o .libs/antlr3intstream.o .libs/antlr3lexer.o .libs/antlr3parser.o .libs/antlr3string.o .libs/antlr3stringstream.o .libs/antlr3tokenstream.o .libs/antlr3treeparser.o .libs/antlr3rewritestreams.o .libs/antlr3ucs2inputstream.o -Wl,-soname -Wl,libantlr3c.so -o .libs/libantlr3c.so
ar cru .libs/libantlr3c.a antlr3baserecognizer.o antlr3basetree.o antlr3basetreeadaptor.o antlr3bitset.o antlr3collections.o antlr3commontoken.o antlr3commontree.o antlr3commontreeadaptor.o antlr3commontreenodestream.o antlr3cyclicdfa.o antlr3encodings.o antlr3exception.o antlr3filestream.o antlr3inputstream.o antlr3intstream.o antlr3lexer.o antlr3parser.o antlr3string.o antlr3stringstream.o antlr3tokenstream.o antlr3treeparser.o antlr3rewritestreams.o antlr3ucs2inputstream.o
ranlib .libs/libantlr3c.a
creating libantlr3c.la
(cd .libs && rm -f libantlr3c.la && ln -s ../libantlr3c.la libantlr3c.la)
make[1]: Leaving directory `/home/jimi/antlrsrc/code/antlr/main/runtime/C/dist/libantlr3c-3.0.0-rc8'
</pre></div> <div class="fragment"><pre class="fragment">
[jimi@localhost libantlr3c-3.0.0-rc8]$ sudo make install
</pre></div> <div class="fragment"><pre class="fragment">
make[1]: Entering directory `/home/jimi/antlrsrc/code/antlr/main/runtime/C/dist/libantlr3c-3.0.0-rc8'
test -z "/usr/local/lib" || /bin/mkdir -p "/usr/local/lib"
/bin/sh ./libtool --mode=install /usr/bin/install -c 'libantlr3c.la' '/usr/local/lib/libantlr3c.la'
/usr/bin/install -c .libs/libantlr3c.so /usr/local/lib/libantlr3c.so
/usr/bin/install -c .libs/libantlr3c.lai /usr/local/lib/libantlr3c.la
/usr/bin/install -c .libs/libantlr3c.a /usr/local/lib/libantlr3c.a
...
/usr/bin/install -c -m 644 'include/antlr3stringstream.h' '/usr/local/include/antlr3stringstream.h'
...
/usr/bin/install -c -m 644 'antlr3config.h' '/usr/local/include/antlr3config.h'
make[1]: Leaving directory `/home/jimi/antlrsrc/code/antlr/main/runtime/C/dist/libantlr3c-3.0.0-rc8'
[jimi@localhost libantlr3c-3.0.0-rc8]$
</pre></div><p>You are now ready to generate C recognizers and compile and link them with the ANTLR 3 C Runtime.</p>
<h2><a class="anchor" id="buildman"></a>
Building Manually</h2>
<p>The only step that configure performs that cannot be done manually (without effort) is to produce the header file <code>antlr3config.h</code>, which contains typedefs of the fundamental types that your local C compiler supports. The easiest way to produce this file for your system, if you cannot port <b>automake</b> and <b>configure</b> to the system is:</p>
<ol type="1">
<li>Run configure on a system that does support configure</li>
<li>Copy the generated <code>antlr3config.h</code> file to the target system</li>
<li>Edit the file locally and change any types that differ on this system to the target systems. There are only a few types and you should find this relatively easy.</li>
</ol>
<p>Having produced a compatible antlr3config.h file, then you should be able to compile the source files in the <code></code>./src subdirectory, providing an include path to the location of <code>antlr3config.h</code> and the <code></code>./include subdirectory. Something akin to: </p>
<div class="fragment"><pre class="fragment">
~/C/src: cc -c -O -I.. -I../include *.c
</pre></div><p>Having produced the .o (or equivalent) files for the local system you can then build an archive or shared library for the C runtime.</p>
<p>When you wish to build and link with the C runtime, specify the path to the supplied header files, and the path to the library that you built. </p>
</div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="main.html">ANTLR3 C Runtime API and Usage Guide.</a> </li>
<li class="footer">Generated on Tue Feb 8 2011 for ANTLR3C by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
