Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 583ffa4ba069126c3ba0bc565dc0485a > files > 4

cvc3-doc-2.4.1-1.fc15.noarch.rpm

<!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>CVC3: INSTALL Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<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">CVC3&#160;<span id="projectnumber">2.4.1</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<div class="title">INSTALL</div>  </div>
</div>
<div class="contents">
<a href="INSTALL.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*!</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment">\page INSTALL INSTALL</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">&lt;strong&gt;Contents:&lt;/strong&gt;</span>
<a name="l00006"></a>00006 <span class="comment"></span>
<a name="l00007"></a>00007 <span class="comment">&lt;ul&gt;</span>
<a name="l00008"></a>00008 <span class="comment">&lt;li&gt;\ref quickstart&lt;/li&gt;</span>
<a name="l00009"></a>00009 <span class="comment">&lt;li&gt;\ref requirements&lt;/li&gt;</span>
<a name="l00010"></a>00010 <span class="comment">&lt;li&gt;\ref advanced&lt;/li&gt;</span>
<a name="l00011"></a>00011 <span class="comment">&lt;li&gt;\ref installing&lt;/li&gt;</span>
<a name="l00012"></a>00012 <span class="comment">&lt;li&gt;\ref documentation&lt;/li&gt;</span>
<a name="l00013"></a>00013 <span class="comment">&lt;li&gt;\ref faq&lt;/li&gt;</span>
<a name="l00014"></a>00014 <span class="comment">&lt;li&gt;\ref help&lt;/li&gt;</span>
<a name="l00015"></a>00015 <span class="comment">&lt;/ul&gt;</span>
<a name="l00016"></a>00016 <span class="comment"></span>
<a name="l00017"></a>00017 <span class="comment">\section quickstart Quick Start</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment">You can download a source distribution of %CVC3 from the</span>
<a name="l00020"></a>00020 <span class="comment">&lt;a href=&quot;http://www.cs.nyu.edu/acsys/cvc3/download.html&quot;&gt;CVC3 downloads</span>
<a name="l00021"></a>00021 <span class="comment">page&lt;/a&gt;. Save the source archive as &lt;code&gt;cvc3.tar.gz&lt;/code&gt; in the</span>
<a name="l00022"></a>00022 <span class="comment">directory of your choice and extract the contents using your favorite</span>
<a name="l00023"></a>00023 <span class="comment">archive program (you can use &lt;code&gt;tar xzvf cvc3.tar.gz&lt;/code&gt; from a</span>
<a name="l00024"></a>00024 <span class="comment">terminal). This will create a directory containing the source of</span>
<a name="l00025"></a>00025 <span class="comment">%CVC3, normally called &lt;code&gt;cvc3-XXX&lt;/code&gt;. In the following we will</span>
<a name="l00026"></a>00026 <span class="comment">denote the this directory as &lt;code&gt;$CVC3_SRC&lt;/code&gt;. To build %CVC3,</span>
<a name="l00027"></a>00027 <span class="comment">open your favorite terminal program and run the following sequence of</span>
<a name="l00028"></a>00028 <span class="comment">commands</span>
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">&lt;pre&gt;</span>
<a name="l00031"></a>00031 <span class="comment">   cd $CVC3_SRC</span>
<a name="l00032"></a>00032 <span class="comment">   ./configure</span>
<a name="l00033"></a>00033 <span class="comment">   make</span>
<a name="l00034"></a>00034 <span class="comment">&lt;/pre&gt;</span>
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">If any part of the build process fails, please read the following section for more information.</span>
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">A successful build will create a library &lt;code&gt;libcvc3&lt;/code&gt; in the</span>
<a name="l00039"></a>00039 <span class="comment">&lt;code&gt;$CVC3_SRC/lib&lt;/code&gt; directory, and an executable</span>
<a name="l00040"></a>00040 <span class="comment">&lt;code&gt;cvc3&lt;/code&gt; in the &lt;code&gt;$CVC3_SRC/bin&lt;/code&gt; directory (these</span>
<a name="l00041"></a>00041 <span class="comment">are symbolic links to the actual files which are stored in</span>
<a name="l00042"></a>00042 <span class="comment">architecture- and configuration-dependent subdirectories). The</span>
<a name="l00043"></a>00043 <span class="comment">directory &lt;code&gt;$CVC3_SRC/test&lt;/code&gt; contains an example program</span>
<a name="l00044"></a>00044 <span class="comment">using the %CVC3 library &lt;code&gt;libcvc3&lt;/code&gt;. To try it out, run the</span>
<a name="l00045"></a>00045 <span class="comment">following commands in the terminal:</span>
<a name="l00046"></a>00046 <span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment">&lt;pre&gt;</span>
<a name="l00048"></a>00048 <span class="comment">   cd test</span>
<a name="l00049"></a>00049 <span class="comment">   make</span>
<a name="l00050"></a>00050 <span class="comment">   bin/test</span>
<a name="l00051"></a>00051 <span class="comment">&lt;/pre&gt;</span>
<a name="l00052"></a>00052 <span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment">By default, &lt;code&gt;make&lt;/code&gt; will build optimized code, static</span>
<a name="l00054"></a>00054 <span class="comment">libraries, and a static executable. To build the &quot;debug&quot; version (much</span>
<a name="l00055"></a>00055 <span class="comment">slower but with more error checking) use the following configuration</span>
<a name="l00056"></a>00056 <span class="comment">command instead:</span>
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment">&lt;pre&gt;</span>
<a name="l00059"></a>00059 <span class="comment">   ./configure --with-build=debug</span>
<a name="l00060"></a>00060 <span class="comment">&lt;/pre&gt;</span>
<a name="l00061"></a>00061 <span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment">In case you prefer to build shared libraries (and thus a much smaller</span>
<a name="l00063"></a>00063 <span class="comment">executable), use the following configuration command:</span>
<a name="l00064"></a>00064 <span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment">&lt;pre&gt;</span>
<a name="l00066"></a>00066 <span class="comment">  ./configure --enable-dynamic</span>
<a name="l00067"></a>00067 <span class="comment">&lt;/pre&gt;</span>
<a name="l00068"></a>00068 <span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment">If you do choose to buld the shared libraries, you must set your</span>
<a name="l00070"></a>00070 <span class="comment">&lt;code&gt;LD_LIBRARY_PATH&lt;/code&gt; environment variable to</span>
<a name="l00071"></a>00071 <span class="comment">&lt;code&gt;$CVC3_SRC/lib&lt;/code&gt; before running %CVC3 or using the shared</span>
<a name="l00072"></a>00072 <span class="comment">libraries.</span>
<a name="l00073"></a>00073 <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment">Alternatively, these and other options can be changed by editing the</span>
<a name="l00075"></a>00075 <span class="comment">&lt;code&gt;Makefile.local&lt;/code&gt; file after running</span>
<a name="l00076"></a>00076 <span class="comment">&lt;code&gt;configure&lt;/code&gt;.  However, be aware that re-running</span>
<a name="l00077"></a>00077 <span class="comment">&lt;code&gt;configure&lt;/code&gt; will overwrite any changes you have made to</span>
<a name="l00078"></a>00078 <span class="comment">&lt;code&gt;Makefile.local&lt;/code&gt;.</span>
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment">\section requirements Requirements</span>
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment">%CVC3 has the following build dependencies:</span>
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment">&lt;ul&gt;</span>
<a name="l00085"></a>00085 <span class="comment">&lt;li&gt;&lt;a href=&quot;http://www.gnu.org/software/gcc/&quot;&gt;GCC&lt;/a&gt; version 3.0 or later&lt;/li&gt;</span>
<a name="l00086"></a>00086 <span class="comment">&lt;li&gt;&lt;a href=&quot;http://www.gnu.org/software/bash/&quot;&gt;Bash&lt;/a&gt;&lt;/li&gt;</span>
<a name="l00087"></a>00087 <span class="comment">&lt;li&gt;&lt;a href=&quot;http://flex.sourceforge.net/&quot;&gt;Flex&lt;/a&gt;&lt;/li&gt;</span>
<a name="l00088"></a>00088 <span class="comment">&lt;li&gt;&lt;a href=&quot;http://www.gnu.org/software/bison/&quot;&gt;Bison&lt;/a&gt;&lt;/li&gt;</span>
<a name="l00089"></a>00089 <span class="comment">&lt;li&gt;&lt;a href=&quot;http://gmplib.org/&quot;&gt;GMP&lt;/a&gt; &lt;em&gt;(recommended)&lt;/em&gt;&lt;/li&gt;</span>
<a name="l00090"></a>00090 <span class="comment">&lt;li&gt;A &lt;a href=&quot;http://python.org/&quot;&gt;Python&lt;/a&gt; interpreter </span>
<a name="l00091"></a>00091 <span class="comment">&lt;em&gt;(optional, for Java support)&lt;/em&gt;&lt;/li&gt;</span>
<a name="l00092"></a>00092 <span class="comment">&lt;li&gt;A &lt;a href=&quot;http://java.sun.com/&quot;&gt;Java&lt;/a&gt; compiler </span>
<a name="l00093"></a>00093 <span class="comment">&lt;em&gt;(optional, for Java support)&lt;/em&gt;&lt;/li&gt;</span>
<a name="l00094"></a>00094 <span class="comment">&lt;/ul&gt;</span>
<a name="l00095"></a>00095 <span class="comment"></span>
<a name="l00096"></a>00096 <span class="comment">All of these tools are available from common package repositories</span>
<a name="l00097"></a>00097 <span class="comment">(e.g., Debian, Ubuntu, Red Hat, Cygwin).</span>
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment">\section advanced Advanced Configuration</span>
<a name="l00100"></a>00100 <span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment">The configure script checks for the components needed to build %CVC3.</span>
<a name="l00102"></a>00102 <span class="comment">If for some reason, the configure script is missing or doesn&#39;t run on</span>
<a name="l00103"></a>00103 <span class="comment">your platform, you can recreate it from &lt;code&gt;configure.ac&lt;/code&gt; by</span>
<a name="l00104"></a>00104 <span class="comment">running &lt;code&gt;autoconf&lt;/code&gt;.</span>
<a name="l00105"></a>00105 <span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment">As the configure script runs, if something is not found, it</span>
<a name="l00107"></a>00107 <span class="comment">complains. configure looks for components in standard locations and</span>
<a name="l00108"></a>00108 <span class="comment">also uses several environment variables that you can set to help it</span>
<a name="l00109"></a>00109 <span class="comment">find things. In particular, you can set &lt;code&gt;CPPFLAGS&lt;/code&gt; to</span>
<a name="l00110"></a>00110 <span class="comment">&amp;quot;&lt;code&gt;-I $includeDir&lt;/code&gt;&amp;quot; if you have headers in a nonstandard</span>
<a name="l00111"></a>00111 <span class="comment">directory &lt;code&gt;$includeDir&lt;/code&gt;, and &lt;code&gt;LDFLAGS&lt;/code&gt; to</span>
<a name="l00112"></a>00112 <span class="comment">&amp;quot;&lt;code&gt;-L $libDir&lt;/code&gt;&amp;quot; if you have libraries in a nonstandard</span>
<a name="l00113"></a>00113 <span class="comment">directory &lt;code&gt;$libDir&lt;/code&gt;. Alternatively you can pass these</span>
<a name="l00114"></a>00114 <span class="comment">directories to the &lt;code&gt;configure&lt;/code&gt; script using the following</span>
<a name="l00115"></a>00115 <span class="comment">command</span>
<a name="l00116"></a>00116 <span class="comment"></span>
<a name="l00117"></a>00117 <span class="comment">&lt;pre&gt;</span>
<a name="l00118"></a>00118 <span class="comment">    ./configure --with-extra-includes=$includeDir --with-extra-libs=$libDir</span>
<a name="l00119"></a>00119 <span class="comment">&lt;/pre&gt;</span>
<a name="l00120"></a>00120 <span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment">Run &lt;code&gt;./configure --help&lt;/code&gt; for a list of all such environment</span>
<a name="l00122"></a>00122 <span class="comment">variables and options.</span>
<a name="l00123"></a>00123 <span class="comment"></span>
<a name="l00124"></a>00124 <span class="comment">&lt;h3&gt;</span>
<a name="l00125"></a>00125 <span class="comment">GMP</span>
<a name="l00126"></a>00126 <span class="comment">&lt;/h3&gt;</span>
<a name="l00127"></a>00127 <span class="comment"></span>
<a name="l00128"></a>00128 <span class="comment">One of the components %CVC3 depends on is the GNU Multiple Precision (GMP)</span>
<a name="l00129"></a>00129 <span class="comment">library.  Many Unix-like distributions include gmp packages.</span>
<a name="l00130"></a>00130 <span class="comment"></span>
<a name="l00131"></a>00131 <span class="comment">If you do not have GMP installed or your installation does not work, we</span>
<a name="l00132"></a>00132 <span class="comment">recommend that you install it manually:</span>
<a name="l00133"></a>00133 <span class="comment"></span>
<a name="l00134"></a>00134 <span class="comment">1. Download the GMP source code from http://gmplib.org/</span>
<a name="l00135"></a>00135 <span class="comment"></span>
<a name="l00136"></a>00136 <span class="comment">2. Unpack the sources, and from the root-directory of the GMP source code, run</span>
<a name="l00137"></a>00137 <span class="comment"></span>
<a name="l00138"></a>00138 <span class="comment">&lt;pre&gt;</span>
<a name="l00139"></a>00139 <span class="comment">   ./configure </span>
<a name="l00140"></a>00140 <span class="comment">   make</span>
<a name="l00141"></a>00141 <span class="comment">&lt;/pre&gt;</span>
<a name="l00142"></a>00142 <span class="comment"></span>
<a name="l00143"></a>00143 <span class="comment">   On some Solaris machines, you may need to configure GMP with</span>
<a name="l00144"></a>00144 <span class="comment">  </span>
<a name="l00145"></a>00145 <span class="comment">&lt;pre&gt;</span>
<a name="l00146"></a>00146 <span class="comment">   ./configure ABI=32</span>
<a name="l00147"></a>00147 <span class="comment">&lt;/pre&gt;</span>
<a name="l00148"></a>00148 <span class="comment"></span>
<a name="l00149"></a>00149 <span class="comment">   to make the resulting GMP library compatible with the %CVC3</span>
<a name="l00150"></a>00150 <span class="comment">   libraries.  The reason for this is that the default ABI that gcc</span>
<a name="l00151"></a>00151 <span class="comment">   chooses in %CVC3 compilation is not necessarily the default ABI</span>
<a name="l00152"></a>00152 <span class="comment">   that the GMP configure script selects, and one of them may need to be</span>
<a name="l00153"></a>00153 <span class="comment">   adjusted.</span>
<a name="l00154"></a>00154 <span class="comment"></span>
<a name="l00155"></a>00155 <span class="comment">3. Now, either install GMP system-wide (make install), or supply the</span>
<a name="l00156"></a>00156 <span class="comment">   appropriate values for CPPFLAGS and LDFLAGS to the %CVC3 configure script.</span>
<a name="l00157"></a>00157 <span class="comment"></span>
<a name="l00158"></a>00158 <span class="comment">If for some reason, you do not want to use GMP, you can configure %CVC3 to use</span>
<a name="l00159"></a>00159 <span class="comment">native arithmetic by running:</span>
<a name="l00160"></a>00160 <span class="comment"></span>
<a name="l00161"></a>00161 <span class="comment">&lt;pre&gt;</span>
<a name="l00162"></a>00162 <span class="comment">   ./configure --with-arith=native</span>
<a name="l00163"></a>00163 <span class="comment">&lt;/pre&gt;</span>
<a name="l00164"></a>00164 <span class="comment"></span>
<a name="l00165"></a>00165 <span class="comment">If you compile %CVC3 with native arithmetic, it is possible that %CVC3 may fail</span>
<a name="l00166"></a>00166 <span class="comment">as the result of arithmetic overflow.  If an overflow occurs, you will get</span>
<a name="l00167"></a>00167 <span class="comment">an error message and %CVC3 will abort.</span>
<a name="l00168"></a>00168 <span class="comment"></span>
<a name="l00169"></a>00169 <span class="comment">&lt;h3&gt;</span>
<a name="l00170"></a>00170 <span class="comment">Java interface</span>
<a name="l00171"></a>00171 <span class="comment">&lt;/h3&gt;</span>
<a name="l00172"></a>00172 <span class="comment"></span>
<a name="l00173"></a>00173 <span class="comment">&lt;em&gt;&lt;strong&gt;Note: The Java interface is experimental. The API may</span>
<a name="l00174"></a>00174 <span class="comment">change in future releases.&lt;/strong&gt;&lt;/em&gt;</span>
<a name="l00175"></a>00175 <span class="comment"></span>
<a name="l00176"></a>00176 <span class="comment">To build the Java interface to %CVC3, use the</span>
<a name="l00177"></a>00177 <span class="comment">&lt;code&gt;--enable-java&lt;/code&gt; configuration option.  The configuration</span>
<a name="l00178"></a>00178 <span class="comment">script refers to the environment variables &lt;code&gt;JAVAC&lt;/code&gt;,</span>
<a name="l00179"></a>00179 <span class="comment">&lt;code&gt;JAVAH&lt;/code&gt;, &lt;code&gt;JAR&lt;/code&gt;, and &lt;code&gt;CXX&lt;/code&gt; to set up</span>
<a name="l00180"></a>00180 <span class="comment">the standard Java and C++ compiler commands. It refers to the</span>
<a name="l00181"></a>00181 <span class="comment">environment variable &lt;code&gt;JFLAGS&lt;/code&gt; for default Java compiler</span>
<a name="l00182"></a>00182 <span class="comment">flags. It refers to the variable &lt;code&gt;javadir&lt;/code&gt; for the</span>
<a name="l00183"></a>00183 <span class="comment">installation directory of the CVC3 Java library.</span>
<a name="l00184"></a>00184 <span class="comment"></span>
<a name="l00185"></a>00185 <span class="comment">The configuration options &lt;code&gt;--with-java-home&lt;/code&gt; and</span>
<a name="l00186"></a>00186 <span class="comment">&lt;code&gt;--with-java-includes&lt;/code&gt; can be used to specify the path to</span>
<a name="l00187"></a>00187 <span class="comment">the directories containing the JDK installation and JNI header files,</span>
<a name="l00188"></a>00188 <span class="comment">respectively.</span>
<a name="l00189"></a>00189 <span class="comment"></span>
<a name="l00190"></a>00190 <span class="comment">You must build %CVC3 as a dynamic library to use the Java</span>
<a name="l00191"></a>00191 <span class="comment">interface. For example, you might configure the build by running the</span>
<a name="l00192"></a>00192 <span class="comment">following in the top-level %CVC3 directory:</span>
<a name="l00193"></a>00193 <span class="comment"></span>
<a name="l00194"></a>00194 <span class="comment">&lt;pre&gt;</span>
<a name="l00195"></a>00195 <span class="comment">    ./configure --enable-dynamic --enable-java</span>
<a name="l00196"></a>00196 <span class="comment">&lt;/pre&gt;</span>
<a name="l00197"></a>00197 <span class="comment"></span>
<a name="l00198"></a>00198 <span class="comment">&lt;b&gt;Note:&lt;/b&gt; The Java interface depends on the &quot;build type&quot; (e.g.,</span>
<a name="l00199"></a>00199 <span class="comment">&quot;optimized&quot;, &quot;debug&quot;) of %CVC3. If you choose to re-configure and</span>
<a name="l00200"></a>00200 <span class="comment">re-build %CVC3 with a different build type, you must run &quot;make clean&quot;</span>
<a name="l00201"></a>00201 <span class="comment">in the current directory and re-build the interface (cleaning and </span>
<a name="l00202"></a>00202 <span class="comment">rebuilding the entire %CVC3 package will suffice).</span>
<a name="l00203"></a>00203 <span class="comment"></span>
<a name="l00204"></a>00204 <span class="comment">&lt;h4&gt;</span>
<a name="l00205"></a>00205 <span class="comment">Using the Java interface</span>
<a name="l00206"></a>00206 <span class="comment">&lt;/h4&gt;</span>
<a name="l00207"></a>00207 <span class="comment"></span>
<a name="l00208"></a>00208 <span class="comment">To access the library, you must add the file</span>
<a name="l00209"></a>00209 <span class="comment">&lt;code&gt;libcvc3-X.Y.Z.jar&lt;/code&gt; (where &quot;X.Y.Z&quot; is the CVC3 version) to</span>
<a name="l00210"></a>00210 <span class="comment">the classpath (e.g., by setting the &lt;code&gt;CLASSPATH&lt;/code&gt; environment</span>
<a name="l00211"></a>00211 <span class="comment">variable) and both &lt;code&gt;libcvc3.so&lt;/code&gt; and</span>
<a name="l00212"></a>00212 <span class="comment">&lt;code&gt;libcvc3jni.so&lt;/code&gt; to the runtime library path (e.g., by</span>
<a name="l00213"></a>00213 <span class="comment">setting the &lt;code&gt;LD_LIBRARY_PATH&lt;/code&gt; environment variable</span>
<a name="l00214"></a>00214 <span class="comment">java.library.path JVM variable).</span>
<a name="l00215"></a>00215 <span class="comment"></span>
<a name="l00216"></a>00216 <span class="comment">For example, to compile the class Client.java:</span>
<a name="l00217"></a>00217 <span class="comment"></span>
<a name="l00218"></a>00218 <span class="comment">&lt;pre&gt;</span>
<a name="l00219"></a>00219 <span class="comment">    javac -cp lib/libcvc3-X.Y.Z.jar Client.java</span>
<a name="l00220"></a>00220 <span class="comment">&lt;/pre&gt;</span>
<a name="l00221"></a>00221 <span class="comment"></span>
<a name="l00222"></a>00222 <span class="comment">To run:</span>
<a name="l00223"></a>00223 <span class="comment"></span>
<a name="l00224"></a>00224 <span class="comment">&lt;pre&gt;</span>
<a name="l00225"></a>00225 <span class="comment">  export LD_LIBRARY_PATH=/path/to/cvc3/libs</span>
<a name="l00226"></a>00226 <span class="comment">  java -Djava.library.path=/path/to/cvc3/libs -cp lib/libcvc3-X.Y.Z.jar Client</span>
<a name="l00227"></a>00227 <span class="comment">&lt;/pre&gt;</span>
<a name="l00228"></a>00228 <span class="comment"></span>
<a name="l00229"></a>00229 <span class="comment">&lt;!-- !!! THE .NET INTERFACE IS NO LONGER SUPPORTED !!!</span>
<a name="l00230"></a>00230 <span class="comment">&lt;h3&gt;</span>
<a name="l00231"></a>00231 <span class="comment">.NET interface</span>
<a name="l00232"></a>00232 <span class="comment">&lt;/h3&gt;</span>
<a name="l00233"></a>00233 <span class="comment"></span>
<a name="l00234"></a>00234 <span class="comment">&lt;em&gt;&lt;strong&gt;Note: The .NET interface is experimental. The API may</span>
<a name="l00235"></a>00235 <span class="comment">change in future releases.&lt;/strong&gt;&lt;/em&gt;</span>
<a name="l00236"></a>00236 <span class="comment"></span>
<a name="l00237"></a>00237 <span class="comment">A .NET interface to the %CVC3 library can be built using Visual Studio</span>
<a name="l00238"></a>00238 <span class="comment">2005 or later. To build the interface:</span>
<a name="l00239"></a>00239 <span class="comment"></span>
<a name="l00240"></a>00240 <span class="comment">&lt;ol&gt;</span>
<a name="l00241"></a>00241 <span class="comment">&lt;li&gt;The lexers and parsers for the supported input languages need to be generated outside of Visual Studio. This can be done in two ways:</span>
<a name="l00242"></a>00242 <span class="comment">  &lt;ul&gt;</span>
<a name="l00243"></a>00243 <span class="comment">  &lt;li&gt;Use the lexer/parser files created by a Cygwin build. It suffices to run Make in &lt;code&gt;src/parser&lt;/code&gt;: </span>
<a name="l00244"></a>00244 <span class="comment">&lt;pre&gt;</span>
<a name="l00245"></a>00245 <span class="comment">./configure</span>
<a name="l00246"></a>00246 <span class="comment">cd src/parser</span>
<a name="l00247"></a>00247 <span class="comment">make</span>
<a name="l00248"></a>00248 <span class="comment">&lt;/pre&gt;</span>
<a name="l00249"></a>00249 <span class="comment">&lt;/li&gt;</span>
<a name="l00250"></a>00250 <span class="comment"></span>
<a name="l00251"></a>00251 <span class="comment">  &lt;li&gt;Run the script &lt;code&gt;make_parser.bat&lt;/code&gt; in directory &lt;code&gt;src/parser&lt;/code&gt; with the native Windows versions of &lt;a href=&quot;http://gnuwin32.sourceforge.net/packages/flex.htm&quot;&gt;Flex&lt;/a&gt; and &lt;a href=&quot;http://gnuwin32.sourceforge.net/packages/bison.htm&quot;&gt;Bison&lt;/a&gt;.&lt;/li&gt;</span>
<a name="l00252"></a>00252 <span class="comment">  &lt;/ul&gt;</span>
<a name="l00253"></a>00253 <span class="comment">&lt;/li&gt;</span>
<a name="l00254"></a>00254 <span class="comment">&lt;li&gt;Open the solution file &lt;code&gt;windows/cvc3.sln&lt;/code&gt; in Visual Studio. The solution file contains the following projects (each with Debug/Release versions):</span>
<a name="l00255"></a>00255 <span class="comment">  &lt;ul&gt;</span>
<a name="l00256"></a>00256 <span class="comment">&lt;li&gt;cvc3lib: the C++ %CVC3 library&lt;/li&gt;</span>
<a name="l00257"></a>00257 <span class="comment">&lt;li&gt;cvc3: the %CVC3 command-line program&lt;/li&gt;</span>
<a name="l00258"></a>00258 <span class="comment">&lt;li&gt;cvc3test: tests for cvc3lib&lt;/li&gt;</span>
<a name="l00259"></a>00259 <span class="comment">&lt;li&gt;cvc3libcli: the .NET %CVC3 library&lt;/li&gt;</span>
<a name="l00260"></a>00260 <span class="comment">&lt;li&gt;cvc3cli: a C# clone of the %CVC3 command-line program&lt;/li&gt;</span>
<a name="l00261"></a>00261 <span class="comment">&lt;li&gt;cvc3testcli: tests for cvc3libcli&lt;/li&gt;</span>
<a name="l00262"></a>00262 <span class="comment">  &lt;/ul&gt;</span>
<a name="l00263"></a>00263 <span class="comment">&lt;/li&gt;</span>
<a name="l00264"></a>00264 <span class="comment">&lt;/ol&gt;</span>
<a name="l00265"></a>00265 <span class="comment"></span>
<a name="l00266"></a>00266 <span class="comment">Each project can be built as usual with Visual Studio. Binaries will</span>
<a name="l00267"></a>00267 <span class="comment">be put in the folders &lt;code&gt;windows/release&lt;/code&gt; (for Release</span>
<a name="l00268"></a>00268 <span class="comment">builds) and &lt;code&gt;windows/debug&lt;/code&gt; (for Debug builds).</span>
<a name="l00269"></a>00269 <span class="comment"></span>
<a name="l00270"></a>00270 <span class="comment">For more information, see the file &lt;code&gt;windows/INSTALL&lt;/code&gt;.</span>
<a name="l00271"></a>00271 <span class="comment"></span>
<a name="l00272"></a>00272 <span class="comment">&lt;b&gt;Note:&lt;/b&gt; the .NET interface can only be used on Microsoft&#39;s CLR,</span>
<a name="l00273"></a>00273 <span class="comment">because Visual Studio produces &lt;a</span>
<a name="l00274"></a>00274 <span class="comment">href=&quot;http://mono-project.com/CPlusPlus&quot;&gt;mixed-mode assemblies&lt;/a&gt;.</span>
<a name="l00275"></a>00275 <span class="comment">--&gt;</span>
<a name="l00276"></a>00276 <span class="comment"></span>
<a name="l00277"></a>00277 <span class="comment">&lt;h3&gt;</span>
<a name="l00278"></a>00278 <span class="comment">Mac OS X</span>
<a name="l00279"></a>00279 <span class="comment">&lt;/h3&gt;</span>
<a name="l00280"></a>00280 <span class="comment"></span>
<a name="l00281"></a>00281 <span class="comment">Mac OS X uses &lt;code&gt;DYLD_LIBRARY_PATH&lt;/code&gt; in place of</span>
<a name="l00282"></a>00282 <span class="comment">&lt;code&gt;LD_LIBRARY_PATH&lt;/code&gt;.</span>
<a name="l00283"></a>00283 <span class="comment"></span>
<a name="l00284"></a>00284 <span class="comment">On Intel Macs, by default, %CVC3 compiles in 32-bit or 64-bit mode</span>
<a name="l00285"></a>00285 <span class="comment">based on the compiler&#39;s default.  If you want to build as one or</span>
<a name="l00286"></a>00286 <span class="comment">the other in particular (for example, to match your libgmp</span>
<a name="l00287"></a>00287 <span class="comment">installation), put CXXFLAGS=-m32 (and JREFLAGS=-d32, if you are</span>
<a name="l00288"></a>00288 <span class="comment">compiling the Java bindings) in the environment when you run </span>
<a name="l00289"></a>00289 <span class="comment">configure.</span>
<a name="l00290"></a>00290 <span class="comment"></span>
<a name="l00291"></a>00291 <span class="comment">To run regression testing (make regress), you&#39;ll need GNU time.</span>
<a name="l00292"></a>00292 <span class="comment">We suggest you install MacPorts (from macports.org) and then the</span>
<a name="l00293"></a>00293 <span class="comment">&quot;gtime&quot; package.</span>
<a name="l00294"></a>00294 <span class="comment"></span>
<a name="l00295"></a>00295 <span class="comment">You&#39;ll need also a libgmp installation.  libgmp can be downloaded from</span>
<a name="l00296"></a>00296 <span class="comment">gmplib.org.  If you install it in a nonstandard location (with</span>
<a name="l00297"></a>00297 <span class="comment">./configure --prefix=...) you&#39;ll need to give this location to CVC3</span>
<a name="l00298"></a>00298 <span class="comment">when you configure it:</span>
<a name="l00299"></a>00299 <span class="comment"></span>
<a name="l00300"></a>00300 <span class="comment">  ./configure --with-extra-includes=...--with-extra-libs=...</span>
<a name="l00301"></a>00301 <span class="comment"></span>
<a name="l00302"></a>00302 <span class="comment">or it may not find your installation of libgmp.</span>
<a name="l00303"></a>00303 <span class="comment"></span>
<a name="l00304"></a>00304 <span class="comment">&lt;h3&gt;</span>
<a name="l00305"></a>00305 <span class="comment"> Cygwin </span>
<a name="l00306"></a>00306 <span class="comment">&lt;/h3&gt;</span>
<a name="l00307"></a>00307 <span class="comment"></span>
<a name="l00308"></a>00308 <span class="comment">In order to use GMP on Cygwin, make sure the following packages are</span>
<a name="l00309"></a>00309 <span class="comment">installed: gmp, libgmp-devel, libgmp3, bison, flex, and make, as well</span>
<a name="l00310"></a>00310 <span class="comment">as standard UNIX tools.</span>
<a name="l00311"></a>00311 <span class="comment"></span>
<a name="l00312"></a>00312 <span class="comment">On Windows, it&#39;s common to have directory names with embedded spaces.</span>
<a name="l00313"></a>00313 <span class="comment">This can be problematic for the CVC3 build system.  Therefore on</span>
<a name="l00314"></a>00314 <span class="comment">Cygwin we recommend symbolically linking to names without embedded</span>
<a name="l00315"></a>00315 <span class="comment">spaces, something like the following:</span>
<a name="l00316"></a>00316 <span class="comment"></span>
<a name="l00317"></a>00317 <span class="comment">&lt;pre&gt;</span>
<a name="l00318"></a>00318 <span class="comment">  $ pwd</span>
<a name="l00319"></a>00319 <span class="comment">  /home/ACSys Group</span>
<a name="l00320"></a>00320 <span class="comment">  $ ln -s &#39;ACSys Group&#39; /home/acsys</span>
<a name="l00321"></a>00321 <span class="comment">  $ export HOME=/home/acsys</span>
<a name="l00322"></a>00322 <span class="comment">  $ cd</span>
<a name="l00323"></a>00323 <span class="comment">  $ pwd</span>
<a name="l00324"></a>00324 <span class="comment">  /home/acsys</span>
<a name="l00325"></a>00325 <span class="comment">  $ cd cvc3</span>
<a name="l00326"></a>00326 <span class="comment">  $ ./configure --prefix=/home/acsys/cvc3.installation ...etc...</span>
<a name="l00327"></a>00327 <span class="comment">&lt;/pre&gt;</span>
<a name="l00328"></a>00328 <span class="comment"></span>
<a name="l00329"></a>00329 <span class="comment">On Windows, Sun&#39;s JDK doesn&#39;t install the Java compiler &quot;javac&quot; into the</span>
<a name="l00330"></a>00330 <span class="comment">standard path for executables.  If you want to build Java bindings,</span>
<a name="l00331"></a>00331 <span class="comment">you&#39;ll need to point CVC3 to it.  Again using symbolic linking as above:</span>
<a name="l00332"></a>00332 <span class="comment"></span>
<a name="l00333"></a>00333 <span class="comment">&lt;pre&gt;</span>
<a name="l00334"></a>00334 <span class="comment">  $ pwd</span>
<a name="l00335"></a>00335 <span class="comment">  /home/acsys/cvc3</span>
<a name="l00336"></a>00336 <span class="comment">  $ ln -s &#39;/cygdrive/c/Program Files&#39; /programs</span>
<a name="l00337"></a>00337 <span class="comment">  $ ./configure --enable-java --with-java-home=/programs/Java/jdk1.6.0_16 ...</span>
<a name="l00338"></a>00338 <span class="comment">&lt;/pre&gt;</span>
<a name="l00339"></a>00339 <span class="comment"></span>
<a name="l00340"></a>00340 <span class="comment">Such symbolic linking (and in general using cygwin full paths) may cause</span>
<a name="l00341"></a>00341 <span class="comment">problems with non-cygwin programs.  In particular, if you have Windows</span>
<a name="l00342"></a>00342 <span class="comment">emacs installed (instead of cygwin&#39;s emacs), you have a version of etags</span>
<a name="l00343"></a>00343 <span class="comment">that may give errors at the end of the install.  These errors (about source</span>
<a name="l00344"></a>00344 <span class="comment">files not existing when in fact they do) shouldn&#39;t break the build (make</span>
<a name="l00345"></a>00345 <span class="comment">won&#39;t complain and bomb out; it&#39;s just that these are at the very end of</span>
<a name="l00346"></a>00346 <span class="comment">the build, so it looks like they are causing problems) and can be safely</span>
<a name="l00347"></a>00347 <span class="comment">ignored.</span>
<a name="l00348"></a>00348 <span class="comment"></span>
<a name="l00349"></a>00349 <span class="comment">&lt;h3&gt;</span>
<a name="l00350"></a>00350 <span class="comment"> &lt;a name=&quot;64-bit Platforms&quot;&gt;64-bit Platforms&lt;/a&gt;</span>
<a name="l00351"></a>00351 <span class="comment">&lt;/h3&gt;</span>
<a name="l00352"></a>00352 <span class="comment"></span>
<a name="l00353"></a>00353 <span class="comment">When building %CVC3 on 64-bit platforms, you must compile %CVC3 in the</span>
<a name="l00354"></a>00354 <span class="comment">same mode as any libraries it uses. For example, if GMP is compiled in</span>
<a name="l00355"></a>00355 <span class="comment">64-bit mode, then %CVC3 must compiled in 64-bit mode as well. The</span>
<a name="l00356"></a>00356 <span class="comment">configuration script will try to infer the correct compilation</span>
<a name="l00357"></a>00357 <span class="comment">settings. You can run &lt;code&gt;./config.guess&lt;/code&gt; to see the default</span>
<a name="l00358"></a>00358 <span class="comment">platform type:</span>
<a name="l00359"></a>00359 <span class="comment"></span>
<a name="l00360"></a>00360 <span class="comment">    $ ./config.guess</span>
<a name="l00361"></a>00361 <span class="comment">    i686-pc-linux-gnu</span>
<a name="l00362"></a>00362 <span class="comment"></span>
<a name="l00363"></a>00363 <span class="comment">You can use the &lt;code&gt;--build&lt;/code&gt; argument to</span>
<a name="l00364"></a>00364 <span class="comment">&lt;code&gt;configure&lt;/code&gt; to override the default. For example, to</span>
<a name="l00365"></a>00365 <span class="comment">compile in 64-bit mode on a x86-64 CPU, you can use &lt;code&gt;./configure</span>
<a name="l00366"></a>00366 <span class="comment">--build=x86_64-pc-linux-gnu&lt;/code&gt;.</span>
<a name="l00367"></a>00367 <span class="comment"></span>
<a name="l00368"></a>00368 <span class="comment">&lt;h3&gt;</span>
<a name="l00369"></a>00369 <span class="comment">  LLVM</span>
<a name="l00370"></a>00370 <span class="comment">&lt;/h3&gt;</span>
<a name="l00371"></a>00371 <span class="comment"></span>
<a name="l00372"></a>00372 <span class="comment">&lt;em&gt;&lt;strong&gt;Note: Compiling %CVC3 with LLVM is not supported and </span>
<a name="l00373"></a>00373 <span class="comment">may cause runtime errors.&lt;/strong&gt;&lt;/em&gt;</span>
<a name="l00374"></a>00374 <span class="comment"></span>
<a name="l00375"></a>00375 <span class="comment">To compile with LLVM, run configure with the options:</span>
<a name="l00376"></a>00376 <span class="comment"></span>
<a name="l00377"></a>00377 <span class="comment">&lt;pre&gt;</span>
<a name="l00378"></a>00378 <span class="comment">./configure CXX=llvm-gcc LIBS=&#39;-lstdc++&#39;</span>
<a name="l00379"></a>00379 <span class="comment">&lt;/pre&gt;</span>
<a name="l00380"></a>00380 <span class="comment"></span>
<a name="l00381"></a>00381 <span class="comment">&lt;h3&gt;</span>
<a name="l00382"></a>00382 <span class="comment">Other Configuration Options</span>
<a name="l00383"></a>00383 <span class="comment">&lt;/h3&gt;</span>
<a name="l00384"></a>00384 <span class="comment"></span>
<a name="l00385"></a>00385 <span class="comment">Other configuration options include where to install the results of</span>
<a name="l00386"></a>00386 <span class="comment">&quot;make install&quot; (see below), what type of build to use (optimized,</span>
<a name="l00387"></a>00387 <span class="comment">debug, gprof, or gcov), and whether to use static or dynamic</span>
<a name="l00388"></a>00388 <span class="comment">libraries.  For help on these options, type</span>
<a name="l00389"></a>00389 <span class="comment"></span>
<a name="l00390"></a>00390 <span class="comment">&lt;pre&gt; </span>
<a name="l00391"></a>00391 <span class="comment">./configure --help </span>
<a name="l00392"></a>00392 <span class="comment">&lt;/pre&gt;</span>
<a name="l00393"></a>00393 <span class="comment"></span>
<a name="l00394"></a>00394 <span class="comment">configure creates the file Makefile.local which stores all of the</span>
<a name="l00395"></a>00395 <span class="comment">configuration information.  If you want to customize your build</span>
<a name="l00396"></a>00396 <span class="comment">without re-running configure, or if you want to customize it in a way</span>
<a name="l00397"></a>00397 <span class="comment">that configure does not allow, you can do it by editing</span>
<a name="l00398"></a>00398 <span class="comment">Makefile.local.  For example, you can build a debug, gprof version by</span>
<a name="l00399"></a>00399 <span class="comment">editing Makefile.local and setting OPTIMIZED to 0 and GPROF to 1 (by</span>
<a name="l00400"></a>00400 <span class="comment">default, gprof runs with an optimized executable).  Note that for most</span>
<a name="l00401"></a>00401 <span class="comment">configuration options, the objects, libraries, and executables are</span>
<a name="l00402"></a>00402 <span class="comment">stored in a configuration-dependent directory, with only symbolic</span>
<a name="l00403"></a>00403 <span class="comment">links being stored in the main bin and lib directories.  This allows</span>
<a name="l00404"></a>00404 <span class="comment">you to easily maintain multiple configurations and multiple platforms</span>
<a name="l00405"></a>00405 <span class="comment">using the same source tree.</span>
<a name="l00406"></a>00406 <span class="comment"></span>
<a name="l00407"></a>00407 <span class="comment">&lt;h4&gt;</span>
<a name="l00408"></a>00408 <span class="comment"> Additional make options</span>
<a name="l00409"></a>00409 <span class="comment">&lt;/h4&gt;</span>
<a name="l00410"></a>00410 <span class="comment"></span>
<a name="l00411"></a>00411 <span class="comment">To rebuild dependencies, type:</span>
<a name="l00412"></a>00412 <span class="comment"></span>
<a name="l00413"></a>00413 <span class="comment">&lt;pre&gt; </span>
<a name="l00414"></a>00414 <span class="comment">    make depend </span>
<a name="l00415"></a>00415 <span class="comment">&lt;/pre&gt;</span>
<a name="l00416"></a>00416 <span class="comment"></span>
<a name="l00417"></a>00417 <span class="comment">To remove just the executable or libraries in the current</span>
<a name="l00418"></a>00418 <span class="comment">configuration, type:</span>
<a name="l00419"></a>00419 <span class="comment"></span>
<a name="l00420"></a>00420 <span class="comment">&lt;pre&gt; </span>
<a name="l00421"></a>00421 <span class="comment">    make spotty </span>
<a name="l00422"></a>00422 <span class="comment">&lt;/pre&gt;</span>
<a name="l00423"></a>00423 <span class="comment"></span>
<a name="l00424"></a>00424 <span class="comment">To remove in addition all object files and makefile dependencies for</span>
<a name="l00425"></a>00425 <span class="comment">the current configuration, type:</span>
<a name="l00426"></a>00426 <span class="comment"></span>
<a name="l00427"></a>00427 <span class="comment">&lt;pre&gt; </span>
<a name="l00428"></a>00428 <span class="comment">    make clean </span>
<a name="l00429"></a>00429 <span class="comment">&lt;/pre&gt;</span>
<a name="l00430"></a>00430 <span class="comment"></span>
<a name="l00431"></a>00431 <span class="comment">To remove all files that are not part of the distribution (including</span>
<a name="l00432"></a>00432 <span class="comment">all object, library, and executables built for any configuration or</span>
<a name="l00433"></a>00433 <span class="comment">platform), type:</span>
<a name="l00434"></a>00434 <span class="comment"></span>
<a name="l00435"></a>00435 <span class="comment">&lt;pre&gt; </span>
<a name="l00436"></a>00436 <span class="comment">    make distclean </span>
<a name="l00437"></a>00437 <span class="comment">&lt;/pre&gt;</span>
<a name="l00438"></a>00438 <span class="comment"></span>
<a name="l00439"></a>00439 <span class="comment">To build a tarball distribution of the current source tree, type:</span>
<a name="l00440"></a>00440 <span class="comment"></span>
<a name="l00441"></a>00441 <span class="comment">&lt;pre&gt; </span>
<a name="l00442"></a>00442 <span class="comment">    make dist </span>
<a name="l00443"></a>00443 <span class="comment">&lt;/pre&gt;</span>
<a name="l00444"></a>00444 <span class="comment"></span>
<a name="l00445"></a>00445 <span class="comment">\section installing Installing CVC3</span>
<a name="l00446"></a>00446 <span class="comment"></span>
<a name="l00447"></a>00447 <span class="comment">To install %CVC3 system-wide, (assuming you have already run configure)</span>
<a name="l00448"></a>00448 <span class="comment">run:</span>
<a name="l00449"></a>00449 <span class="comment"></span>
<a name="l00450"></a>00450 <span class="comment">&lt;pre&gt;</span>
<a name="l00451"></a>00451 <span class="comment">    make install</span>
<a name="l00452"></a>00452 <span class="comment">&lt;/pre&gt;</span>
<a name="l00453"></a>00453 <span class="comment"></span>
<a name="l00454"></a>00454 <span class="comment">Installation depends on two configuration options: &lt;code&gt;prefix&lt;/code&gt;</span>
<a name="l00455"></a>00455 <span class="comment">and &lt;code&gt;exec_prefix&lt;/code&gt;.  By default, both are set to</span>
<a name="l00456"></a>00456 <span class="comment">&lt;code&gt;/usr/local&lt;/code&gt;, but these can be overridden by specifying the</span>
<a name="l00457"></a>00457 <span class="comment">correct arguments to configure or by editing</span>
<a name="l00458"></a>00458 <span class="comment">&lt;code&gt;Makefile.local&lt;/code&gt;.</span>
<a name="l00459"></a>00459 <span class="comment"></span>
<a name="l00460"></a>00460 <span class="comment">Installation copies all necessary header files to</span>
<a name="l00461"></a>00461 <span class="comment">&lt;code&gt;$prefix/include/cvc3&lt;/code&gt;. It installs the library</span>
<a name="l00462"></a>00462 <span class="comment">&lt;code&gt;libcvc3&lt;/code&gt; in &lt;code&gt;$exec_prefix/lib&lt;/code&gt; and the</span>
<a name="l00463"></a>00463 <span class="comment">executable &lt;code&gt;cvc3&lt;/code&gt; in &lt;code&gt;$exec_prefix/bin&lt;/code&gt;. By</span>
<a name="l00464"></a>00464 <span class="comment">default, a static library and executable are installed.  If you want</span>
<a name="l00465"></a>00465 <span class="comment">to install shared library versions, configure for shared libraries as</span>
<a name="l00466"></a>00466 <span class="comment">described above.</span>
<a name="l00467"></a>00467 <span class="comment"></span>
<a name="l00468"></a>00468 <span class="comment"></span>
<a name="l00469"></a>00469 <span class="comment">\section documentation Documentation</span>
<a name="l00470"></a>00470 <span class="comment"></span>
<a name="l00471"></a>00471 <span class="comment">To build HTML documentation, run</span>
<a name="l00472"></a>00472 <span class="comment"></span>
<a name="l00473"></a>00473 <span class="comment">&lt;pre&gt;</span>
<a name="l00474"></a>00474 <span class="comment"></span>
<a name="l00475"></a>00475 <span class="comment">   make doc</span>
<a name="l00476"></a>00476 <span class="comment"></span>
<a name="l00477"></a>00477 <span class="comment">&lt;/pre&gt;</span>
<a name="l00478"></a>00478 <span class="comment"></span>
<a name="l00479"></a>00479 <span class="comment">Then open &lt;code&gt;doc/html/index.html&lt;/code&gt; in your favorite browser.</span>
<a name="l00480"></a>00480 <span class="comment"></span>
<a name="l00481"></a>00481 <span class="comment">\section faq Frequently Asked Questions</span>
<a name="l00482"></a>00482 <span class="comment"></span>
<a name="l00483"></a>00483 <span class="comment">&lt;h3&gt;</span>
<a name="l00484"></a>00484 <span class="comment">Configuration Errors</span>
<a name="l00485"></a>00485 <span class="comment">&lt;/h3&gt;</span>
<a name="l00486"></a>00486 <span class="comment"></span>
<a name="l00487"></a>00487 <span class="comment">&lt;h4&gt;</span>
<a name="l00488"></a>00488 <span class="comment">&lt;code&gt;libgmp.a is not found&lt;/code&gt;</span>
<a name="l00489"></a>00489 <span class="comment">&lt;/h4&gt;</span>
<a name="l00490"></a>00490 <span class="comment"></span>
<a name="l00491"></a>00491 <span class="comment">Make sure the GMP library is in your &lt;code&gt;LD_LIBRARY_PATH&lt;/code&gt; and</span>
<a name="l00492"></a>00492 <span class="comment">&lt;code&gt;gmp.h&lt;/code&gt; is in your &lt;code&gt;CPATH&lt;/code&gt; (or use the</span>
<a name="l00493"></a>00493 <span class="comment">&lt;code&gt;--with-extra-lib&lt;/code&gt; and &lt;code&gt;--with-extra-include&lt;/code&gt;</span>
<a name="l00494"></a>00494 <span class="comment">arguments to &lt;code&gt;./configure&lt;/code&gt;).</span>
<a name="l00495"></a>00495 <span class="comment"></span>
<a name="l00496"></a>00496 <span class="comment">If your paths are properly configured and you are compiling for a</span>
<a name="l00497"></a>00497 <span class="comment">64-bit architecture, you may have a 32/64-bit mismatch. Check the</span>
<a name="l00498"></a>00498 <span class="comment">binary type of the GMP library using the &lt;code&gt;file&lt;/code&gt;</span>
<a name="l00499"></a>00499 <span class="comment">utility. For example, running &lt;code&gt;file&lt;/code&gt; on a 32-bit Linux GMP</span>
<a name="l00500"></a>00500 <span class="comment">shared library will return:</span>
<a name="l00501"></a>00501 <span class="comment"></span>
<a name="l00502"></a>00502 <span class="comment">&lt;pre&gt;</span>
<a name="l00503"></a>00503 <span class="comment">    $ file /usr/lib/libgmp.so.3.4.2</span>
<a name="l00504"></a>00504 <span class="comment">    /usr/lib/libgmp.so.3.4.2: ELF 32-bit LSB shared object, Intel 80386, version 1 (SYSV), dynamically linked, stripped</span>
<a name="l00505"></a>00505 <span class="comment">&lt;/pre&gt;</span>
<a name="l00506"></a>00506 <span class="comment"></span>
<a name="l00507"></a>00507 <span class="comment">You can use the &lt;code&gt;--build&lt;/code&gt; arguments to</span>
<a name="l00508"></a>00508 <span class="comment">&lt;code&gt;./configure&lt;/code&gt; to set the target binary type for %CVC3. For</span>
<a name="l00509"></a>00509 <span class="comment">example, &lt;code&gt;./configure --build=i686-linux-gnu&lt;/code&gt; or</span>
<a name="l00510"></a>00510 <span class="comment">&lt;code&gt;./configure --build=x86_64-linux-gnu&lt;/code&gt;.</span>
<a name="l00511"></a>00511 <span class="comment"></span>
<a name="l00512"></a>00512 <span class="comment">&lt;h4&gt;</span>
<a name="l00513"></a>00513 <span class="comment">&lt;code&gt;Unable to locate Java directories&lt;/code&gt;</span>
<a name="l00514"></a>00514 <span class="comment">&lt;/h4&gt;</span>
<a name="l00515"></a>00515 <span class="comment"></span>
<a name="l00516"></a>00516 <span class="comment">Set the &lt;code&gt;JAVA_HOME&lt;/code&gt; environment variable or use the</span>
<a name="l00517"></a>00517 <span class="comment">&lt;code&gt;--with-java-home&lt;/code&gt; argument to</span>
<a name="l00518"></a>00518 <span class="comment">&lt;code&gt;./configure&lt;/code&gt;. Some typical &lt;code&gt;JAVA_HOME&lt;/code&gt; settings</span>
<a name="l00519"></a>00519 <span class="comment">are as follows (where &lt;em&gt;X.Y.Z&lt;/em&gt; is the version number of the installed</span>
<a name="l00520"></a>00520 <span class="comment">Java runtime).</span>
<a name="l00521"></a>00521 <span class="comment"></span>
<a name="l00522"></a>00522 <span class="comment">&lt;table&gt;</span>
<a name="l00523"></a>00523 <span class="comment">&lt;tr&gt;</span>
<a name="l00524"></a>00524 <span class="comment">&lt;th&gt; Platform    &lt;/th&gt;&lt;th&gt; &lt;code&gt;JAVA_HOME&lt;/code&gt; &lt;/th&gt;&lt;th&gt; Notes</span>
<a name="l00525"></a>00525 <span class="comment">&lt;/th&gt;&lt;/tr&gt;</span>
<a name="l00526"></a>00526 <span class="comment">&lt;tr&gt;</span>
<a name="l00527"></a>00527 <span class="comment">&lt;td&gt; Debian/Ubuntu Linux &lt;/td&gt;</span>
<a name="l00528"></a>00528 <span class="comment">&lt;td&gt; &lt;code&gt;/usr/lib/jvm/default-java&lt;/code&gt; &lt;/td&gt;</span>
<a name="l00529"></a>00529 <span class="comment">&lt;td&gt; Install the &lt;code&gt;default-jre&lt;/code&gt; or </span>
<a name="l00530"></a>00530 <span class="comment">&lt;code&gt;default-jre-headless&lt;/code&gt; package &lt;/td&gt;&lt;/tr&gt;</span>
<a name="l00531"></a>00531 <span class="comment">&lt;tr&gt;</span>
<a name="l00532"></a>00532 <span class="comment">&lt;td&gt;    Fedora Linux     &lt;/td&gt;</span>
<a name="l00533"></a>00533 <span class="comment">&lt;td&gt; &lt;code&gt;/usr/java/jre&lt;em&gt;X.Y.Z&lt;/em&gt;&lt;/code&gt; &lt;/td&gt;</span>
<a name="l00534"></a>00534 <span class="comment">&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;</span>
<a name="l00535"></a>00535 <span class="comment">&lt;tr&gt;</span>
<a name="l00536"></a>00536 <span class="comment">&lt;td&gt;    Mac OS X         &lt;/td&gt;</span>
<a name="l00537"></a>00537 <span class="comment">&lt;td&gt; &lt;code&gt;/System/Library/Frameworks/JavaVM.framework/Home&lt;/code&gt; &lt;/td&gt;</span>
<a name="l00538"></a>00538 <span class="comment">&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;</span>
<a name="l00539"></a>00539 <span class="comment">&lt;tr&gt;</span>
<a name="l00540"></a>00540 <span class="comment">&lt;td&gt;    Windows          &lt;/td&gt;</span>
<a name="l00541"></a>00541 <span class="comment">&lt;td&gt; &lt;code&gt;C:\\Program Files\\Java\\jdk&lt;em&gt;X.Y.Z&lt;/em&gt;&lt;/code&gt; &lt;/td&gt;</span>
<a name="l00542"></a>00542 <span class="comment">&lt;td&gt; &lt;/td&gt;&lt;/tr&gt;</span>
<a name="l00543"></a>00543 <span class="comment">&lt;/table&gt;</span>
<a name="l00544"></a>00544 <span class="comment"></span>
<a name="l00545"></a>00545 <span class="comment">&lt;h3&gt;</span>
<a name="l00546"></a>00546 <span class="comment">Runtime Errors (CVC3 library)</span>
<a name="l00547"></a>00547 <span class="comment">&lt;/h3&gt;</span>
<a name="l00548"></a>00548 <span class="comment"></span>
<a name="l00549"></a>00549 <span class="comment">&lt;h4&gt;Segmentation fault when running a dynamically-linked executable.&lt;/h4&gt;</span>
<a name="l00550"></a>00550 <span class="comment"></span>
<a name="l00551"></a>00551 <span class="comment">This can be caused by a mismatched &quot;build type&quot;.  The debug and</span>
<a name="l00552"></a>00552 <span class="comment">optimized version of the %CVC3 shared library are not binary</span>
<a name="l00553"></a>00553 <span class="comment">compatible.  If you are linking against a debug version of the shared</span>
<a name="l00554"></a>00554 <span class="comment">library, you must define the symbol _CVC3_DEBUG_MODE during</span>
<a name="l00555"></a>00555 <span class="comment">compilation. E.g., add &lt;code&gt;-D_CVC3_DEBUG_MODE&lt;/code&gt; to</span>
<a name="l00556"></a>00556 <span class="comment">&lt;code&gt;CXXARGS&lt;/code&gt;.</span>
<a name="l00557"></a>00557 <span class="comment"></span>
<a name="l00558"></a>00558 <span class="comment">&lt;h4&gt;Fatal error: &lt;code&gt;Mis-handled the ref. counting&lt;/code&gt;&lt;/h4&gt;</span>
<a name="l00559"></a>00559 <span class="comment"></span>
<a name="l00560"></a>00560 <span class="comment">This can be cause by a number of problems. Make sure that all &lt;code&gt;Expr&lt;/code&gt;</span>
<a name="l00561"></a>00561 <span class="comment">objects are out of scope or have been manually deleted before deleting</span>
<a name="l00562"></a>00562 <span class="comment">the &lt;code&gt;ValidityChecker&lt;/code&gt;.</span>
<a name="l00563"></a>00563 <span class="comment"></span>
<a name="l00564"></a>00564 <span class="comment">&lt;h4&gt;</span>
<a name="l00565"></a>00565 <span class="comment">&lt;code&gt;Exception in thread &quot;main&quot; java.lang.UnsatisfiedLinkError: no cvc3jni in java.library.path&lt;/code&gt;</span>
<a name="l00566"></a>00566 <span class="comment">&lt;/h4&gt;</span>
<a name="l00567"></a>00567 <span class="comment"></span>
<a name="l00568"></a>00568 <span class="comment">The Java runtime was not able to find the %CVC3 JNI library. Use</span>
<a name="l00569"></a>00569 <span class="comment">&lt;code&gt;java -Djava.library.path=PATH_TO_CVC3JNI&lt;/code&gt;, where</span>
<a name="l00570"></a>00570 <span class="comment">&lt;code&gt;PATH_TO_CVC3JNI&lt;/code&gt; is the directory containing the file</span>
<a name="l00571"></a>00571 <span class="comment">&lt;code&gt;libcvc3jni.so&lt;/code&gt;.</span>
<a name="l00572"></a>00572 <span class="comment"></span>
<a name="l00573"></a>00573 <span class="comment">&lt;h4&gt;</span>
<a name="l00574"></a>00574 <span class="comment">&lt;code&gt;Exception in thread &quot;main&quot; java.lang.UnsatisfiedLinkError: libcvc3jni.so.&lt;em&gt;x.y.z&lt;/em&gt;&lt;/code&gt;</span>
<a name="l00575"></a>00575 <span class="comment">&lt;/h4&gt;</span>
<a name="l00576"></a>00576 <span class="comment"></span>
<a name="l00577"></a>00577 <span class="comment">The Java runtime was not able to satisfy the link dependencies of the</span>
<a name="l00578"></a>00578 <span class="comment">%CVC3 JNI library. Make sure that the %CVC3 and GMP libraries are in</span>
<a name="l00579"></a>00579 <span class="comment">your &lt;code&gt;LD_LIBRARY_PATH&lt;/code&gt;.</span>
<a name="l00580"></a>00580 <span class="comment"></span>
<a name="l00581"></a>00581 <span class="comment">If your paths are properly configured and you are compiling for a</span>
<a name="l00582"></a>00582 <span class="comment">64-bit architecture, you may have a 32/64-bit mismatch. Make sure the</span>
<a name="l00583"></a>00583 <span class="comment">JVM is running in the same mode as the %CVC3 library using the</span>
<a name="l00584"></a>00584 <span class="comment">&lt;code&gt;-d32&lt;/code&gt; or &lt;code&gt;-d64&lt;/code&gt; argument to &lt;code&gt;java&lt;/code&gt;.</span>
<a name="l00585"></a>00585 <span class="comment"></span>
<a name="l00586"></a>00586 <span class="comment">&lt;h4&gt;</span>
<a name="l00587"></a>00587 <span class="comment">On Mac: </span>
<a name="l00588"></a>00588 <span class="comment">&lt;code&gt;terminate called after throwing an instance of &#39;CVC3::TypecheckException&#39;&lt;/code&gt;</span>
<a name="l00589"></a>00589 <span class="comment">&lt;/h4&gt;</span>
<a name="l00590"></a>00590 <span class="comment"></span>
<a name="l00591"></a>00591 <span class="comment">This appears to be a bug in certain versions of GCC distributed by</span>
<a name="l00592"></a>00592 <span class="comment">Apple. Upgrade to XCode 3.1.2 or later (GCC version &quot;4.0.1 (Apple</span>
<a name="l00593"></a>00593 <span class="comment">Inc. build 5490)&quot;) or configure with &lt;code&gt;CXXFLAGS=-01&lt;/code&gt;.</span>
<a name="l00594"></a>00594 <span class="comment"></span>
<a name="l00595"></a>00595 <span class="comment">\section help Getting help</span>
<a name="l00596"></a>00596 <span class="comment"></span>
<a name="l00597"></a>00597 <span class="comment">If you find a problem with the instructions in this installation guide, please</span>
<a name="l00598"></a>00598 <span class="comment">send email to &lt;a href=&quot;mailto:cvc-bugs@cs.nyu.edu&quot;&gt;cvc-bugs@cs.nyu.edu&lt;/a&gt;.</span>
<a name="l00599"></a>00599 <span class="comment"></span>
<a name="l00600"></a>00600 <span class="comment">*/</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Sep 7 2011 for CVC3 by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>