aboutsummaryrefslogtreecommitdiffstats
path: root/eo_js/README
blob: 3a783e0e8eda046f0cb1ced3e5b0a2b993369791 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
############################################################################

EO Introspection - JavaScript Bindings

############################################################################

It analyzes XML files generated by EO introspection scanner and generates
module, which can be used with V8-based js-engine - elev8.

############################################################################

1. Generating js module for classes defined in XMLs:
    a. > python eo_js_gen.py --dir=XML_FOLDER --outdir=OUTDIR
         --module=MODULE_NAME --include=INCLUDE_DIR

      In case if some class is needed
      (usually parent class, which is not in the tree being analyzed),
      include XMLs are searched in python system paths.
      If include file wasn't found, explicit --include=INCLUDE_DIR dir is needed

      Files to be generated:
      - *.cc, *.h will be created for each *.xml
   b. Compiling module:
      > not yet.
      following files are needed to compile
      elm.h
      CElmObject.cc
      CElmObject.h

      *.so module will be compiled

############################################################################
############################################################################
############################################################################