add basic structure

add first draft/docu

git-svn-id: https://silmor.de/svn/softmagic/elam/trunk@615 6e3c4bff-ac9f-4ac1-96c5-d2ea494d3e33

diff --git a/COPYING b/COPYING
new file mode 100644 (file)
index 0000000..fc8a5de
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,165 @@
+                  GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..f23fd5e
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+README for ElAM
+================
+
+ElAM = Elementary Algebra Machine
+
+(c) Konrad Rosenbaum, 2010
+protected under the GNU LGPL version 3 or at your option any newer
+see COPYING for details
+
+This engine can be fed simple algebraic formulas and will calculate their
+result similar to those used in languages like C or Pascal. It is not able
+to solve algebraic systems or use fancy expressions.
+
+ElAM is based on and made for Qt 4.x.
+
+Building
+=========
+
+see doc/build.html
+
+Syntactic Rules
+================
+
+see doc/syntax.html
+
+Using the Library
+==================
+
+see doc/library.html
\ No newline at end of file

diff --git a/doc/build.html b/doc/build.html
new file mode 100644 (file)
index 0000000..87840e1
--- /dev/null
+++ b/doc/build.html
@@ -0,0 +1,25 @@
+<html>
+<title>ElAM</title>
+<body>
+<h1>Building The ElAM Libray</h1>
+
+ElAM contains the following directories:
+
+<ul>
+<li>src - contains the sources for the static ElAM library.
+<li>demo - contains the demo program with a simple GUI, it understands only integer logic
+<li>tests - contains test cases
+<li>doc - documentation as HTML pages
+</ul>
+
+<h2>Building</h2>
+
+You need a C++ compiler and Qt 4.x.
+
+In each directory simply call qmake and make (or mingw32-make, or nmake, ...). Start with <tt>src</tt> and continue with <tt>demo</tt> if you want to use the demo program. You will normally not need <tt>tests</tt>, since these are only used for engine internal tests.<p>
+
+To create source documentation call <a href="http://www.doxygen.org">doxygen</a> in the src directory. The documentation will be built in <tt>doc/source/</tt> - open <a href="source/index.html">index.html</a> to browse it.
+
+<h2>Using the library</h2>
+
+Read on <a href="library.html">here</a>.
\ No newline at end of file

diff --git a/doc/index.html b/doc/index.html
new file mode 100644 (file)
index 0000000..a195b97
--- /dev/null
+++ b/doc/index.html
@@ -0,0 +1,13 @@
+<html>
+<title>ElAM</title>
+<body>
+<h1>The ElAM Libray</h1>
+
+<ul>
+<li><a href="build.html">Building ElAM</a>
+<li><a href="syntax.html">Syntactic Rules</a>
+<li><a href="library.html">Using and Extending the Library</a>
+<li><a href="source/index.html">Source Documentation</a>
+</ul>
+
+</html>
\ No newline at end of file

diff --git a/doc/library.html b/doc/library.html
new file mode 100644 (file)
index 0000000..d0512f1
--- /dev/null
+++ b/doc/library.html
@@ -0,0 +1,22 @@
+<html>
+<title>ElAM</title>
+<body>
+<h1>Using The ElAM Libray</h1>
+
+<h2>Project File and Includes</h2>
+
+<h2>Calling It</h2>
+
+<h2>Basic Types, Operators, Functions and Variables</h2>
+
+<h1>Extending The ElAM Libray</h1>
+
+<h2>Redirecting Variables and Constants</h2>
+
+<h2>Creating new Operators</h2>
+
+<h2>Creating new Functions</h2>
+
+<h2>Creating new Types</h2>
+
+</html>
\ No newline at end of file

diff --git a/doc/syntax.html b/doc/syntax.html
new file mode 100644 (file)
index 0000000..6b95116
--- /dev/null
+++ b/doc/syntax.html
@@ -0,0 +1,40 @@
+<html>
+<title>ElAM</title>
+<body>
+<h1>The ElAM Syntax</h1>
+
+ElAM has the following syntactic elements:
+<ul>
+<li>Expressions
+<li>Types
+<li>Variables
+<li>Constants
+<li>Parentheses
+<li>Unary and Binary Operators
+<li>Functions
+<li>Assignments
+</ul>
+
+<h2>Precedence Rules</h2>
+
+<h3>Default Operator Precedence</h3>
+
+<table frame="1" border="1">
+<tr><td><b>Operator Class</b><td><b>Operators</b><td><b>Precedence Value</b></tr>
+<tr><td>Parentheses<td>(parentheses), functions(...)<td>100</tr>
+<tr><td>Maximum usable Precedence<td>&nbsp<td>99</tr>
+<tr><td>Unary Operators<td> ++, --, ~, !, -, +<td>95</tr>
+<tr><td>Multiplicative<td> *, /, %<td>90</tr>
+<tr><td>Additive<td> +, -<td>80</tr>
+<tr><td>Shift<td> &lt;&lt;, &gt;&gt;<td>70</tr>
+<tr><td>compare<td> &lt;, &gt;, ==, !=, &lt;=, &gt;=<td>60</tr>
+<tr><td>bitwise AND<td> &amp;<td>50</tr>
+<tr><td>bitwise XOR<td> ^<td>45</tr>
+<tr><td>bitwise OR<td> |<td>40</tr>
+<tr><td>logical AND<td> &amp;&amp;<td>30</tr>
+<tr><td>logical OR<td>||<td>25</tr>
+<tr><td>Lowest usable Precedence<td>&nbsp<td>1</tr>
+<tr><td>assignments<td>=, +=, -=, ...<td>0</tr>
+</table>
+
+</html>
\ No newline at end of file