3
******************************************************************************
5
FOR ANY ISSUES PLEASE EMAIL:
6
enlightenment-devel@lists.sourceforge.net
8
******************************************************************************
17
WARNING: gcc compatibility!!!
18
There seems to be some bug (or disagreement) between embryo and gcc 3.2.x
19
where IEEE floating point format encoding does not "agree" with embryo's own
20
hand-made tests. embryo_cc may not work if you compile using gcc 3.2.x. gcc
21
3.3.x is known to work fine. we are not 100% sure whose fault this is yet, so
22
we won't be jumping up and down, but be warned - gcc 3.2.x does not agree
25
To view the API docs, run ./gendoc and view doc/html/index.html.
27
OK a lot of people ask this. What is Embryo?
29
Embryo is primarily a shared library that gives you an API to load and control
30
interpreted programs compiled into an abstract machine bytecode that it
31
understands. This abstract (or virtual) machine is similar to a real machine
32
with a CPU, but it is emulated in software. The architecture is simple and is
33
the same as the abstract machine (AMX) in the
34
<a href=http://www.compuphase.com/pawn>PAWN</a> language (formerly called
35
SMALL) as it is based on exactly the same code. Embryo has modified the code
36
for the AMX extensively and has made it smaller and more portable. It is VERY
37
small. The total size of the virtual machine code AND header files is less
38
than 2500 lines of code. It includes the floating point library support by
39
default as well. This makes it one of the smallest interpreters around, and
40
thus makes is very efficient to use in code.
42
Embryo also uses the PAWN compiler from the same code base. This code has
43
barely been touched and so suffers from lots of portability issues. It has
44
been partially fixed and now works on both big and little endian but the code
45
still need to be gone over and really cleaned up . It does work, but it's only
46
just working. It has been called embryo_cc and compiled a subset of PAWN
47
binary outputs. It does not support packed strings, variable alignment, or
48
debugging output. It does not support many features of the full PAWN
49
compiler because the Embryo AMX does not support these either. You will find
50
the Embryo codebase to work much better on Linux (and BSD and MacOS X) and
51
other UNIX operating systems as it has been developed and tested on them. IT
57
And will likely work on more combinations. IT currently has problems on 64bit
58
SPARC CPUs. Other 64bit systems are untested. It is the aim to fix the code
59
so it works on all commonly used architectures (32, 64bit, big and little
60
endian, alignment forgiving/unforgiving). So far 64bit support is the major
63
For more documentation please see the Language guide here:
65
<a href=http://www.compuphase.com/pawn>Pawn Language Booklet</a>
67
This documents the PAWN language and is 100% relevant for Embryo and the
68
syntax of files it can compile (.sma files).
70
Any help is appreciated in helping clean and port this code, so feel free to
71
send patches to the Enlightenment development lists.
73
The main aim of Embryo is to provide an easy to use library for running
74
compiled PAWN programs and giving them access to the calling program and
75
any API it exports to the PAWN script. PAWN programs/scripts are completely
76
sand-boxed. They cannot access any system or function calls other than the
77
ones provided by the calling application to the Embryo API. This means a
78
PAWN script cannot open or write to, delete or load files. It is fairly
79
harmless and this also keeps Embryo small.
81
This is a work in progress, so please be patient if things don't work for you
82
- and patches and help in fixing it is very much appreciated.
84
------------------------------------------------------------------------------
85
COMPILING AND INSTALLING:
89
(as root unless you are installing in your users directories):