src/extension/script/README.txt

   1 SWIG Scripting Notes
   2 ====================
   3 by Ishmal
   4
   5 The code in this directory is an initial start
   6 at providing application-level scripting to Inkscape
   7 via SWIG and interpreter embedding.  Please do not
   8 modify these files until you have become well
   9 acquainted with SWIG and the various methods of
  10 embedding scripting languages in a C/C++ program.
  11
  12
  13 The classes defined in InkscapeBinding.h and
  14 implemented in InkscapeBinding.cpp are destined to
  15 be a thin shell for scripting Inkscape.  Since
  16 Inkscape currently is not organized in a heirarchical
  17 tree, nor is it threadsafe,  this binding tree will merely
  18 mimic such an arrangement.
  19
  20 Note that this -NOT- the same as ECMAScript binding on an
  21 SVG page.  That is another task, coupled with XPath.
  22
  23 Currently, the way to update InkscapeBinding is to:
  24
  25 1.  Modify InkscapeBinding.h and InkscapeBinding.cpp
  26 2.  Run 'make -f Makefile.tmp wraps'
  27 3.  cd to the src or toplevel directory, and build
  28 4.  when this works well, commit the files in this directory
  29
  30 #### SWIG is available here:
  31
  32 http://www.swig.org
  33
  34 #### Information on embedding Python is here
  35
  36 http://docs.python.org/ext/ext.html
  37
  38
  39 #### Information on embedding PERL is available here:
  40
  41 http://perldoc.com/perl5.8.4/pod/perlembed.html