src/engine/SCons/Tool/javah.xml

   1 <!-- __COPYRIGHT__ -->
   2 <tool name="javah">
   3 <summary>
   4 XXX
   5 </summary>
   6 </tool>
   7
   8 <builder name="JavaH">
   9 <summary>
  10 Builds C header and source files for
  11 implementing Java native methods.
  12 The target can be either a directory
  13 in which the header files will be written,
  14 or a header file name which
  15 will contain all of the definitions.
  16 The source can be either the names of <filename>.class</filename> files,
  17 or the objects returned from the
  18 &b-Java;
  19 builder method.
  20
  21 If the construction variable
  22 &cv-JAVACLASSDIR;
  23 is set, either in the environment
  24 or in the call to the
  25 &b-JavaH;
  26 builder method itself,
  27 then the value of the variable
  28 will be stripped from the
  29 beginning of any <filename>.class</filename> file names.
  30
  31 Examples:
  32
  33 <example>
  34 # builds java_native.h
  35 classes = env.Java(target = 'classdir', source = 'src')
  36 env.JavaH(target = 'java_native.h', source = classes)
  37
  38 # builds include/package_foo.h and include/package_bar.h
  39 env.JavaH(target = 'include',
  40           source = ['package/foo.class', 'package/bar.class'])
  41
  42 # builds export/foo.h and export/bar.h
  43 env.JavaH(target = 'export',
  44           source = ['classes/foo.class', 'classes/bar.class'],
  45           JAVACLASSDIR = 'classes')
  46 </example>
  47 </summary>
  48 </builder>
  49
  50 <cvar name="JAVAH">
  51 <summary>
  52 The Java generator for C header and stub files.
  53 </summary>
  54 </cvar>
  55
  56 <cvar name="JAVAHCOM">
  57 <summary>
  58 The command line used to generate C header and stub files
  59 from Java classes.
  60 Any options specified in the &cv-JAVAHFLAGS; construction variable
  61 are included on this command line.
  62 </summary>
  63 </cvar>
  64
  65 <cvar name="JAVAHCOMSTR">
  66 <summary>
  67 The string displayed when C header and stub files
  68 are generated from Java classes.
  69 If this is not set, then &cv-JAVAHCOM; (the command line) is displayed.
  70
  71 <example>
  72 env = Environment(JAVAHCOMSTR = "Generating header/stub file(s) $TARGETS from $SOURCES")
  73 </example>
  74 </summary>
  75 </cvar>
  76
  77 <cvar name="JAVAHFLAGS">
  78 <summary>
  79 General options passed to the C header and stub file generator
  80 for Java classes.
  81 </summary>
  82 </cvar>