nsz Git - libfirm/blob - firmjni/README

   1
   2 This directory contains tools to generate a Java Native Interface for
   3 libfirm.
   4
   5 The tools generate for each libfirm header file a Java class
   6 containing native method calls and static fields.  The native methods
   7 are derived from the methods in the corresponding libfirm header.  The
   8 method names are generated by replacing all occurences of '_x' by 'X'.
   9 (The libfirm headers may not contain method names that only differ by
  10 capitalizing the letter after an underscore.)  The static fields are
  11 derived from the enumerators in libfirm.
  12
  13 The generator copies the comments from the header files to the Java
  14 files.  Sometimes it places the comments slightly wrong, i.e. a bit
  15 too high or too low.  As the comments are directly copied they refer
  16 to the C names.
  17
  18 Generating the JNI requires various syntactic properties of the header
  19 files that restrict legal C.  These restrictions will be relaxed at
  20 some point.
  21
  22 Do not use methods that accept or return function pointers.
  23
  24 Some other methods generated might not work yet.  Please report this
  25 to goetz@ipd.info.uni-karlsruhe.de.
  26
  27 WARNING:
  28
  29 For now _all_ enumerators are generated into _all_ classes.  This
  30 results from deficiencies in the crecoder and will be removed at some
  31 place.
  32 Use only the enumerators defined in the corresponding c headers.
  33 E.g., irm_X is defined in irmode.h, so use Irmode.irm_X, but not
  34 Type.irm_X or any other definition in the java files.
  35
  36 ========================================================================
  37
  38 Call "make" in the build directory to generate the Java native
  39 interface for firm.  Call "make test" to test the interface.
  40
  41 ========================================================================