lib/javacomp.h

   1 /* Compile a Java program.
   2    Copyright (C) 2001-2002, 2006, 2009-2024 Free Software Foundation, Inc.
   3    Written by Bruno Haible <haible@clisp.cons.org>, 2001.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation, either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  17
  18 #ifndef _JAVACOMP_H
  19 #define _JAVACOMP_H
  20
  21 #ifdef __cplusplus
  22 extern "C" {
  23 #endif
  24
  25
  26 /* Compile a Java source file to bytecode.
  27    java_sources is an array of source file names.
  28    classpaths is a list of pathnames to be prepended to the CLASSPATH.
  29
  30    source_version can be:    support for
  31              1.6             assert keyword (1.4), generic classes and methods (1.5)
  32              1.7             switch(string)
  33              1.8             lambdas
  34              9               private interface methods
  35             10               type inference for local variables
  36             11               'var' in parameters of lambda expressions
  37             ...
  38    If source-version 1.3 or 1.4 or 1.5 is requested, it gets mapped to 1.6, for
  39    backward compatibility. (Currently the minimum Java and javac version we need
  40    to support is Java 1.6, since that's the default Java version on Solaris 10.)
  41
  42    target_version can be:  classfile version:
  43              1.6                 50.0
  44              1.7                 51.0
  45              1.8                 52.0
  46              9                   53.0
  47             10                   54.0
  48             11                   55.0
  49             ...                  ...
  50    If a target-version below 1.6 is requested, it gets mapped to 1.6, for
  51    backward compatibility. (Currently the minimum Java and javac version we need
  52    to support is Java 1.6, since that's the default Java version on Solaris 10.)
  53    target_version can also be given as NULL. In this case, the required
  54    target_version is determined from the found JVM (see javaversion.h).
  55    Specifying target_version is useful when building a library (.jar) that is
  56    useful outside the given package. Passing target_version = NULL is useful
  57    when building an application.
  58    It is unreasonable to ask for a target-version < source-version, such as
  59      - target_version < 1.4 with source_version >= 1.4, or
  60      - target_version < 1.5 with source_version >= 1.5, or
  61      - target_version < 1.6 with source_version >= 1.6, or
  62      - target_version < 1.7 with source_version >= 1.7, or
  63      - target_version < 1.8 with source_version >= 1.8, or
  64      - target_version < 9 with source_version >= 9, or
  65      - target_version < 10 with source_version >= 10, or
  66      - target_version < 11 with source_version >= 11, or
  67      - ...
  68    because even Sun's/Oracle's javac doesn't support these combinations.
  69    It is redundant to ask for a target_version > source_version, since the
  70    smaller target_version = source_version will also always work and newer JVMs
  71    support the older target_versions too.
  72
  73    directory is the target directory. The .class file for class X.Y.Z is
  74    written at directory/X/Y/Z.class. If directory is NULL, the .class
  75    file is written in the source's directory.
  76    use_minimal_classpath = true means to ignore the user's CLASSPATH and
  77    use a minimal one. This is likely to reduce possible problems if the
  78    user's CLASSPATH contains garbage or a classes.zip file of the wrong
  79    Java version.
  80    If verbose, the command to be executed will be printed.
  81    Return false if OK, true on error.  */
  82 extern bool compile_java_class (const char * const *java_sources,
  83                                 unsigned int java_sources_count,
  84                                 const char * const *classpaths,
  85                                 unsigned int classpaths_count,
  86                                 const char *source_version,
  87                                 const char *target_version,
  88                                 const char *directory,
  89                                 bool optimize, bool debug,
  90                                 bool use_minimal_classpath,
  91                                 bool verbose);
  92
  93
  94 #ifdef __cplusplus
  95 }
  96 #endif
  97
  98 #endif /* _JAVACOMP_H */