1 /*
   2  * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 package com.sun.tools.jextract;
  24 
  25 import jdk.internal.joptsimple.OptionException;
  26 import jdk.internal.joptsimple.OptionParser;
  27 import jdk.internal.joptsimple.OptionSet;
  28 import jdk.internal.joptsimple.util.KeyValuePair;
  29 
  30 import java.io.File;
  31 import java.io.IOException;
  32 import java.io.PrintWriter;
  33 import java.nio.file.Files;
  34 import java.nio.file.Path;
  35 import java.nio.file.Paths;
  36 import java.text.MessageFormat;
  37 import java.util.List;
  38 import java.util.Locale;
  39 import java.util.ResourceBundle;
  40 import java.util.logging.ConsoleHandler;
  41 import java.util.logging.Level;
  42 import java.util.logging.Logger;
  43 import java.util.logging.SimpleFormatter;
  44 import java.util.regex.PatternSyntaxException;
  45 import java.util.spi.ToolProvider;
  46 
  47 public final class Main {
  48     public static final boolean DEBUG = Boolean.getBoolean("jextract.debug");
  49 
  50     // FIXME: Remove this if/when the macros support is deemed stable
  51     public static boolean INCLUDE_MACROS = Boolean.parseBoolean(System.getProperty("jextract.INCLUDE_MACROS", "true"));
  52 
  53     private static final String MESSAGES_RESOURCE = "com.sun.tools.jextract.resources.Messages";
  54 
  55     private static final ResourceBundle MESSAGES_BUNDLE;
  56     static {
  57         MESSAGES_BUNDLE = ResourceBundle.getBundle(MESSAGES_RESOURCE, Locale.getDefault());
  58     }
  59 
  60     public static String format(String msgId, Object... args) {
  61         return new MessageFormat(MESSAGES_BUNDLE.getString(msgId)).format(args);
  62     }
  63 
  64     private final Context ctx;
  65     private String targetPackage;
  66 
  67     public Main(Context ctx) {
  68         this.ctx = ctx;
  69     }
  70 
  71     private void processPackageMapping(Object arg) {
  72         String str = (String) arg;
  73         Path p = null;
  74         String pkgName;
  75         if (str.indexOf('=') == -1) {
  76             pkgName = str;
  77         } else {
  78             KeyValuePair kv = KeyValuePair.valueOf(str);
  79             p = Paths.get(kv.key);
  80             pkgName = kv.value;
  81 
  82             if (!Files.isDirectory(p)) {
  83                 throw new IllegalArgumentException(format("not.a.directory", kv.key));
  84             }
  85         }
  86 
  87         Utils.validPackageName(pkgName);
  88         ctx.usePackageForFolder(p, pkgName);
  89     }
  90 
  91     private void processHeader(Object header) {
  92         Path p = Paths.get((String) header);
  93         if (!Files.isReadable(p)) {
  94             throw new IllegalArgumentException(format("cannot.read.header.file", header));
  95         }
  96         p = p.toAbsolutePath();
  97         ctx.usePackageForFolder(p.getParent(), targetPackage);
  98         ctx.addSource(p);
  99     }
 100 
 101     private void setupLogging(Level level) {
 102         Logger logger = ctx.logger;
 103         logger.setUseParentHandlers(false);
 104         ConsoleHandler log = new ConsoleHandler();
 105         System.setProperty("java.util.logging.SimpleFormatter.format", "%4$s: %5$s%n");
 106         log.setFormatter(new SimpleFormatter());
 107         logger.setLevel(level);
 108         log.setLevel(level);
 109         logger.addHandler(log);
 110     }
 111 
 112     private void printHelp(OptionParser parser) {
 113         try {
 114             parser.printHelpOn(ctx.err);
 115         } catch (IOException ex) {
 116             if (Main.DEBUG) {
 117                 ex.printStackTrace(ctx.err);
 118             }
 119         }
 120     }
 121 
 122     public int run(String[] args) {
 123         OptionParser parser = new OptionParser();
 124         parser.accepts("dry-run", format("help.dry_run"));
 125         parser.accepts("I", format("help.I")).withRequiredArg();
 126         // option is expected to specify paths to load shared libraries
 127         // to check & warn missing symbols during jextract session.
 128         parser.accepts("L", format("help.L")).withRequiredArg();
 129         parser.accepts("l", format("help.l")).withRequiredArg();
 130         parser.accepts("d", format("help.d")).withRequiredArg();
 131         parser.acceptsAll(List.of("o", "jar"), format("help.o")).withRequiredArg();
 132         parser.acceptsAll(List.of("t", "target-package"), format("help.t")).withRequiredArg();
 133         parser.acceptsAll(List.of("m", "package-map"), format("help.m")).withRequiredArg();
 134         parser.acceptsAll(List.of("?", "h", "help"), format("help.h")).forHelp();
 135         parser.accepts("C", format("help.C")).withRequiredArg();
 136         parser.accepts("log", format("help.log")).withRequiredArg();
 137         parser.accepts("exclude-symbols", format("help.exclude_symbols")).withRequiredArg();
 138         parser.accepts("rpath", format("help.rpath")).withRequiredArg();
 139         parser.accepts("infer-rpath", format("help.infer.rpath"));
 140         parser.accepts("static-forwarder", format("help.static.forwarder")).
 141             withRequiredArg().ofType(boolean.class);
 142         parser.nonOptions(format("help.non.option"));
 143 
 144         OptionSet options = null;
 145         try {
 146              options = parser.parse(args);
 147         } catch (OptionException oe) {
 148              ctx.err.println(oe.getMessage());
 149              if (Main.DEBUG) {
 150                  oe.printStackTrace(ctx.err);
 151              }
 152              printHelp(parser);
 153              return 1;
 154         }
 155 
 156         if (args.length == 0 || options.has("h")) {
 157              printHelp(parser);
 158              return args.length == 0? 1 : 0;
 159         }
 160 
 161         if (options.nonOptionArguments().isEmpty()) {
 162             ctx.err.println(format("err.no.input.files"));
 163             return 2;
 164         }
 165 
 166         if (options.has("log")) {
 167             setupLogging(Level.parse((String) options.valueOf("log")));
 168         } else {
 169             setupLogging(Level.WARNING);
 170         }
 171 
 172         if (options.has("I")) {
 173             options.valuesOf("I").forEach(p -> ctx.addClangArg("-I" + p));
 174         }
 175 
 176         // append the built-in headers directory
 177         ctx.addClangArg("-I" + getBuiltinHeadersDir());
 178 
 179         if (options.has("C")) {
 180             options.valuesOf("C").forEach(p -> ctx.addClangArg((String) p));
 181         }
 182 
 183         if (options.has("l")) {
 184             for (Object arg : options.valuesOf("l")) {
 185                 String lib = (String)arg;
 186                 if (lib.indexOf(File.separatorChar) != -1) {
 187                     ctx.err.println(format("l.name.should.not.be.path", lib));
 188                     return 1;
 189                 }
 190                 ctx.addLibraryName(lib);
 191             }
 192         }
 193 
 194         boolean infer_rpath = options.has("infer-rpath");
 195         if (options.has("rpath")) {
 196             if (infer_rpath) {
 197                 //conflicting rpaths options
 198                 ctx.err.println(format("warn.rpath.auto.conflict"));
 199                 infer_rpath = false;
 200             }
 201 
 202             // "rpath" with no "l" option!
 203             if (options.has("l")) {
 204                 options.valuesOf("rpath").forEach(p -> ctx.addLibraryPath((String) p));
 205             } else {
 206                 ctx.err.println(format("warn.rpath.without.l"));
 207             }
 208         }
 209 
 210         // generate static forwarder class if user specified -l option
 211         boolean staticForwarder = true;
 212         if (options.has("static-forwarder")) {
 213             staticForwarder = (boolean)options.valueOf("static-forwarder");
 214         }
 215         ctx.setGenStaticForwarder(staticForwarder && options.has("l"));
 216 
 217         if (options.has("exclude-symbols")) {
 218             try {
 219                 options.valuesOf("exclude-symbols").forEach(sym -> ctx.addExcludeSymbols((String) sym));
 220             } catch (PatternSyntaxException pse) {
 221                 ctx.err.println(format("exclude.symbols.pattern.error", pse.getMessage()));
 222             }
 223         }
 224 
 225         if (options.has("L")) {
 226             List<?> libpaths = options.valuesOf("L");
 227             // "L" with no "l" option!
 228             if (options.has("l")) {
 229                 libpaths.forEach(p -> ctx.addLinkCheckPath((String) p));
 230                 if (infer_rpath) {
 231                     libpaths.forEach(p -> ctx.addLibraryPath((String) p));
 232                 }
 233             } else {
 234                 ctx.err.println(format("warn.L.without.l"));
 235             }
 236         } else if (infer_rpath) {
 237             ctx.err.println(format("warn.rpath.auto.without.L"));
 238         }
 239 
 240         targetPackage = options.has("t") ? (String) options.valueOf("t") : "";
 241         if (!targetPackage.isEmpty()) {
 242             Utils.validPackageName(targetPackage);
 243         }
 244 
 245         if (options.has("m")) {
 246             options.valuesOf("m").forEach(this::processPackageMapping);
 247         }
 248 
 249         try {
 250             options.nonOptionArguments().stream().forEach(this::processHeader);
 251             ctx.parse();
 252         } catch (RuntimeException re) {
 253             ctx.err.println(re.getMessage());
 254             if (Main.DEBUG) {
 255                 re.printStackTrace(ctx.err);
 256             }
 257             return 2;
 258         }
 259 
 260         if (options.has("dry-run")) {
 261             return 0;
 262         }
 263 
 264         boolean hasOutput = false;
 265 
 266         if (options.has("d")) {
 267             hasOutput = true;
 268             Path dest = Paths.get((String) options.valueOf("d"));
 269             dest = dest.toAbsolutePath();
 270             try {
 271                 if (!Files.exists(dest)) {
 272                     Files.createDirectories(dest);
 273                 } else if (!Files.isDirectory(dest)) {
 274                     ctx.err.println(format("not.a.directory", dest));
 275                     return 4;
 276                 }
 277                 ctx.collectClassFiles(dest, args, targetPackage);
 278             } catch (IOException ex) {
 279                 ctx.err.println(format("cannot.write.class.file", dest, ex));
 280                 if (Main.DEBUG) {
 281                     ex.printStackTrace(ctx.err);
 282                 }
 283                 return 5;
 284             }
 285         }
 286 
 287         String outputName;
 288         if (options.has("o")) {
 289             outputName = (String) options.valueOf("o");
 290         } else if (hasOutput) {
 291             return 0;
 292         } else {
 293             outputName =  Paths.get((String)options.nonOptionArguments().get(0)).getFileName() + ".jar";
 294         }
 295 
 296         try {
 297             ctx.collectJarFile(Paths.get(outputName), args, targetPackage);
 298         } catch (IOException ex) {
 299             ctx.err.println(format("cannot.write.jar.file", outputName, ex));
 300             if (Main.DEBUG) {
 301                 ex.printStackTrace(ctx.err);
 302             }
 303             return 3;
 304         }
 305 
 306         return 0;
 307     }
 308 
 309     private static Path getBuiltinHeadersDir() {
 310         return Paths.get(System.getProperty("java.home"), "conf", "jextract");
 311     }
 312 
 313     public static void main(String... args) {
 314         Main instance = new Main(new Context());
 315 
 316         System.exit(instance.run(args));
 317     }
 318 
 319     public static class JextractToolProvider implements ToolProvider {
 320         @Override
 321         public String name() {
 322             return "jextract";
 323         }
 324 
 325         @Override
 326         public int run(PrintWriter out, PrintWriter err, String... args) {
 327             // defensive check to throw security exception early.
 328             // Note that the successful run of jextract under security
 329             // manager would require far more permissions like loading
 330             // library (clang), file system access etc.
 331             if (System.getSecurityManager() != null) {
 332                 System.getSecurityManager().
 333                     checkPermission(new RuntimePermission("jextract"));
 334             }
 335 
 336             Main instance = new Main(new Context(out, err));
 337             return instance.run(args);
 338         }
 339     }
 340 }