Helix SwarmHelix Swarm
Loading...

install.html

  • //
  • guest/
  • julian_hyde/
  • saffron/
  • doc/
  • install.html #3
  • View
  • Commits
  • Open Download .zip Download (8 KB) 
  1. <html>
  2.  
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  5. <meta name="GENERATOR" content="Microsoft FrontPage 5.0">
  6. <meta name="ProgId" content="FrontPage.Editor.Document">
  7. <title>Saffron installation guide</title>
  8. <link rel="stylesheet" type="text/css" href="stylesheet.css" />
  9. </head>
  10.  
  11. <body bgcolor="#ffffff">
  12.  
  13. <table border="1" class="clsStd" width="795" height="136">
  14.   <tr>
  15.     <td colspan="2"><a href="index.html">Top</a> | <a href="http://public.perforce.com/guest/julian_hyde/saffron/doc/index.html">Web home</a> |
  16.       <a href="http://sourceforge.net/projects/saffron/">SourceForge home</a>
  17.     <div align="right">
  18.        <a href="http://sourceforge.net">
  19. 	       <img src="http://sourceforge.net/sflogo.php?group_id=46646&type=1" border="0" alt="SourceForge.net Logo">
  20. 	    </a>
  21.     </div>
  22. 	 </td>
  23.   </tr>
  24.   <tr>
  25.     <td colspan="2"><em>$Id: //guest/julian_hyde/saffron/doc/install.html#3 $</em></td>
  26.   </tr>
  27.   <tr>
  28.     <td colspan="2"><em>(C) Copyright 2002, Julian Hyde</em></td>
  29.   </tr>
  30.   <tr>
  31.     <th align="right">Author</th>
  32.     <td>Julian Hyde (<a href="mailto:julian.hyde@mail.com">julian.hyde@mail.com</a>)</td>
  33.   </tr>
  34.   <tr>
  35.     <th align="right">Created</th>
  36.     <td>February 15<sup>th</sup>, 2002</td>
  37.   </tr>
  38. </table>
  39.  
  40. <h1>How to build and install Saffron</h1>
  41.  
  42. <h2><a name="1_Contents">1. Contents</a></h2>
  43. <ol>
  44.   <li><a href="#1_Contents">Contents</a>
  45.   <li><a href="#2_Modification_history">Modification history</a>
  46.   <li><a href="#3_Setup_build_environment">Setup build environment</a>
  47.   <li><a href="#4_Build">Build</a><li><a href="#5_Run_the_demo">Run the demo</a>
  48.   <li><a href="#Appendix_A_Product_installation_instructions">Appendix A: Product installation instructions</a>
  49.   <li><a href="#Appendix_B_Coding_guidelines">Appendix B: Coding guidelines</a>
  50. </ol>
  51.  
  52. <h2><a name="2_Modification_history">2. Modification history</a></h2>
  53. <table border="1" class="clsStd" width="100%">
  54.   <tr>
  55.     <th>Date</th>
  56.     <th>Revision</th>
  57.     <th>Author</th>
  58.     <th>Comment</th>
  59.   </tr>
  60.   <tr>
  61.     <td><I>February 15<SUP>th</SUP>, 2002</I></td>
  62.     <td><em>1</em></td>
  63.     <td><i>Julian Hyde</i></td>
  64.     <td><em>Created</em></td>
  65.   </tr>
  66.   </table>
  67.  
  68. <h2><a name="3_Setup_build_environment">3. Setup build environment</a></h2>
  69.  
  70. <p>Here are the steps to setup a build environment.</p>
  71.  
  72. <ol>
  73.   <li>Install <a href="#JDK">JDK 1.3.1</a>.</li>
  74.   <li>Install <a href="#Ant">Ant</a>.</li>
  75.   <li>Install <a href="#JUnit">JUnit</a>.</li>
  76.   <li>Install <a href="#JavaCC">JavaCC</a>.</li>
  77.   <li>Modify <code>build.bat</code>, setting <code>JAVACC_HOME</code>, <code>ANT_HOME</code>, <code>
  78.   JUNIT_HOME</code>. (It may be sufficient to just change <code>HOME_DRIVE</code>.)</li>
  79. </ol>
  80.  
  81. <p>Optional:</p>
  82. <ol>
  83.   <li>Install <a href="#Jikes">Jikes</a>.</li>
  84. </ol>
  85.  
  86. <h2><a name="4_Build">4. Build</a></h2>
  87. <p>As follows:</p>
  88. <blockquote>
  89. <pre>cd <i>${project.location}</i>
  90. build</pre>
  91. </blockquote>
  92.  
  93. <h2><a name="5_Run_the_demo">5. Run it</a></h2>
  94. <p>To run the JUnit regression test:</p>
  95. <blockquote>
  96. <pre>build test</pre>
  97. </blockquote>
  98. <p>Or you can run <a href="api/saffron/test/Main.html">class <code>
  99. saffron.test.Main</code></a> using any JUnit test harness. You can control the 
  100. behavior of the test by creating a file called <code>saffron.properties</code>. 
  101. Here is an example:</p>
  102. <blockquote>
  103.   <pre>saffron.Statement.printBeforeCompile=false
  104. saffron.debug.level=0
  105. saffron.package.name=saffron.runtime
  106. saffron.java.dir=D:/saffron/src/examples
  107. saffron.class.dir=D:/saffron/classes
  108. saffron.java.compiler.args=-classpath D:/saffron/classes -d D:/saffron/classes -verbose
  109. saffron.test.Class=sales.InMemorySalesTestCase
  110. saffron.test.Name=testIteratorJoin
  111. #saffron.test.Suite=saffron.runtime.ThreadIterator$Test</pre>
  112. </blockquote>
  113. <p>You'll need an ODBC datasource called <code>empdept</code> in order to run 
  114. the JDBC flavor of the tests.</p>
  115. <p>To generate <code>Sales2.java</code> from <code>Sales2.oj</code> and compile 
  116. it to <code>Sales2.class</code>; and to compile <code>Test.java</code> to <code>
  117. Test.class</code>:</p>
  118. <blockquote>
  119. <pre>cd <i>${project.location}</i>
  120. build compile.examples</pre>
  121. </blockquote>
  122. <p>(There is a bug in the <code>ojavac</code> Ant task. If you get an 
  123. IOException, remove <code>Sales2.java</code> and try again.)</p>
  124. <p>To run <code>Sales2</code>:</p>
  125. <blockquote>
  126. <pre>build run.sales.Sales2</pre>
  127. </blockquote>
  128.  
  129. <h2><a name="Appendix_A_Product_installation_instructions">Appendix A. Product 
  130. installation instructions</a></h2>
  131.  
  132. <p>These are the products I used to build saffron. Install all of the products
  133. marked 'required'. (I use <code>/</code>-es in paths because I am run MKS on
  134. Windows 2000, and it makes things simpler.)</p>
  135.  
  136. <p>In the following, the symbol <code><i>${project.location}</i></code> means the root of your
  137. source tree.</p>
  138.  
  139. <p>Where the instructions suggest setting an environment variable, it is often 
  140. sufficient to edit the corresponding line in <code><i>${project.location}</i>/build.bat</code>.</p>
  141.  
  142. <table border="1" class="clsStd" width="100%">
  143.   <tr>
  144.     <th>Product</th>
  145.     <th>Required?</th>
  146.     <th>Version</th>
  147.     <th>Comment</th>
  148.   </tr>
  149.   <tr>
  150.     <td><a name="JDK">JDK</a></td>
  151.     <td>Yes</td>
  152.     <td>1.1 or later (I use version 1.3.1.)</td>
  153.     <td>Available from <a href="http://developer.java.sun.com/" target="_blank">http://developer.java.sun.com/</a>.
  154.       I downloaded <code>j2sdk-1_3_1_02-win.exe</code>, and extracted to <code>E:/jdk1.3.1_02</code>. Set
  155.       <code> JAVA_HOME</code> to same, and <code> CLASS_PATH</code> to <code>%JAVA_HOME%/lib/dt.jar</code>.</td>
  156.   </tr>
  157.   <tr>
  158.     <td><a name="Ant">Ant</a></td>
  159.     <td>Yes</td>
  160.     <td>1.4.1 or later&nbsp;</td>
  161.     <td>I downloaded
  162. <a href="http://jakarta.apache.org/builds/jakarta-ant/release/v1.4.1/bin/jakarta-ant-1.4.1-bin.zip">
  163. jakarta-ant-1.4.1-bin.zip</a>,  extracted to <code>E:/jakarta-ant-1.4.1</code>, 
  164.     and set <code>ANT_HOME</code> to the same.</td>
  165.   </tr>
  166.   <tr>
  167.     <td><a name="Jikes">Jikes</a></td>
  168.     <td>No</td>
  169.     <td>&nbsp;</td>
  170.     <td>Available from <a href="http://oss.software.ibm.com/developerworks/opensource/jikes/" target="_blank">http://oss.software.ibm.com/developerworks/opensource/jikes/</a>.
  171.       I <code>downloaded jikes-1.15-windows.zip</code>, and extracted <code>jikes.exe</code>
  172.       to <code>C:/winnt/system32</code>. Then uncomment the relevant lines of <code><i>${project.location}</i>/build.properties</code>.</td>
  173.   </tr>
  174.   <tr>
  175.     <td><a name="JUnit">JUnit</a></td>
  176.     <td>Yes</td>
  177.     <td>3.7 or later</td>
  178.     <td>Available from <a href="http://www.junit.org/">http://www.junit.org/</a>. I downloaded <code>
  179.     junit3.7.zip</code>, 
  180.     extracted to <code>E:/junit3.7</code>, and set <code>JUNIT_HOME</code> 
  181.     to the same.</td>
  182.   </tr>
  183.   <tr>
  184.     <td><a name="JavaCC">JavaCC</a> (parser generator)</td>
  185.     <td>Yes</td>
  186.     <td>JavaCC2.1</td>
  187.     <td>Available from <a href="http://www.webgain.com/products/java_cc/">http://www.webgain.com/products/java_cc/</a>.
  188.       Install in <code>E:/JavaCC2.1</code> or similar. Edit <code>${project.home}/build.bat</code>.
  189.       Edit <code>${project.home}/build.properties</code>.</td>
  190.   </tr>
  191.   <tr>
  192.     <td>Intellij IDEA (a Java IDE)</td>
  193.     <td>No</td>
  194.     <td>2.5.1</td>
  195.     <td>You can download a 30-day evaluation copy from <a href="http://www.intellij.com/idea/" target="_blank">http://www.intellij.com/idea/</a>.
  196.       Follow the instructions in <code>Install.txt</code> in <code>idea-2_5_1.zip</code>
  197.       to there.</td>
  198.   </tr>
  199.   </table>
  200.  
  201. <p>&nbsp;</p>
  202.  
  203. <h2><a name="Appendix_B_Coding_guidelines">Appendix B: Coding guidelines</a></h2>
  204. <ul>
  205.   <li>Indentation 4.</li>
  206.   <li>Tab stop 4 (except openjava source code, whose tab stop is 8).</li>
  207.   <li>Use tabs, not space.</li>
  208.   <li>K&R bracing
  209. convention (that is, open braces on the same line as the preceding 'if', 'else', 'while' statement or 'class' declaration).</li>
  210.   <li>Use braces even for single-line blocks.</li>
  211.   <li>Declare variables as near to
  212. their first use as possible.</li>
  213.   <li>Don't initialize variables with 'dummy' values just
  214. to shut up the compiler.</li>
  215.   <li>Try to keep lines shorter than 80 characters.</li>
  216.   <li>Javadoc comments on
  217. methods are written in the active ('Collects garbage.') not imperative ('Collect
  218. garbage.')</li>
  219.   <li>When editing HTML documents, don't use an editor which reformats the
  220. HTML source (such as Word).</li>
  221. </ul>
  222.  
  223. <b>
  224.   <table border="1" width="100%" class="clsStd">
  225.     <tr>
  226.       <td>End <i>$Id: //guest/julian_hyde/saffron/doc/install.html#3 $</i></td>
  227.     </tr>
  228.   </table>
  229.   <p>&nbsp;&nbsp;&nbsp; </p>
  230. </b>
  231.  
  232. </body>
  233.  
  234. </html>
# Change User Description Committed
#3 1748 Julian Hyde saffron:
convert unit tests to JUnit;
add CallingConvention.ITERABLE;
lots of other stuf...f;
release 0.1. «		 23 years ago
#2 1485 Julian Hyde Saffron/Mondrian: John Sichi's feedback. 23 years ago
#1 1461 Julian Hyde saffron: First check in.
Just documents, and the unmodified OpenJava  20001010 source... files. «		 23 years ago