1 /* 2 * Copyright (c) 2012, 2014, 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. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.tools.sjavac; 27 28 import java.io.PrintStream; 29 import java.net.URI; 30 import java.util.Map; 31 import java.util.Set; 32 33 import com.sun.tools.sjavac.options.Options; 34 import com.sun.tools.sjavac.pubapi.PubApi; 35 import com.sun.tools.sjavac.server.Sjavac; 36 37 /** 38 * The transform interface is used to transform content inside a package, from one form to another. 39 * Usually the output form is an unpredictable number of output files. (eg class files) 40 * but can also be an unpredictable number of generated source files (eg idl2java) 41 * or a single predictable output file (eg when copying,cleaning or compiling a properties file). 42 * 43 * <p><b>This is NOT part of any supported API. 44 * If you write code that depends on this, you do so at your own risk. 45 * This code and its internal interfaces are subject to change or 46 * deletion without notice.</b> 47 */ 48 public interface Transformer { 49 /** 50 * The transform method takes a set of package names, mapped to their source files and to the 51 * pubapis of the packages. 52 * 53 * The transform implementation must: 54 * store the names of the generated artifacts for each package into package_artifacts 55 * store found dependencies to other packages into the supplied set package_dependencies 56 * store the public api for a package into the supplied set package_pubapis 57 * 58 * Any benign messages as a result of running the transform 59 * are written into stdout, and errors are written to stderr. 60 * 61 * The debug_level can be 0=silent (only warnings and errors) 1=normal 2=verbose 3 or greater=debug 62 * setExtra is used to set the extra information information that can be passed on 63 * the command line to the smart javac wrapper. 64 * 65 * If sjavac is building incrementally from an existing javac_state, the var incremental is true. 66 * 67 * The transformer will only be called if some source in the package (or dependency) has 68 * a modified timestamp. Thus the transformer might get called with many sources, of which 69 * only one has changed. The transformer is allowed to regenerate all artifacts but 70 * a better transformer will only write those artifacts that need updating. 71 * 72 * However the transformer must verify that the existing artifacts really are there! 73 * and it must always update package_artifacts, package_dependencies, and package_pubapis correctly. 74 * This means that at least for Java source, it will always have to recompile the sources. 75 * 76 * The transformer is allowed to put files anywhere in the dest_root. 77 * An example of this is, can be the META-INF transformer that copy files 78 * below META-INF directories to the single META-INF directory below dest_root. 79 * 80 * False is returned if there was an error that prevented the transform. 81 * I.e. something was printed on stderr. 82 * 83 * If num_cores is set to a non-zero value. The transform should attempt to use no more than these 84 * number of threads for heavy work. 85 */ 86 boolean transform(Sjavac sjavac, 87 Map<String,Set<URI>> pkgSrcs, 88 Set<URI> visibleSources, 89 Map<URI,Set<String>> visibleClasses, 90 Map<String,Set<String>> oldPackageDependencies, 91 URI destRoot, 92 Map<String,Set<URI>> packageArtifacts, 93 Map<String, Map<String, Set<String>>> packageDependencies, // Package name -> Fully Qualified Type [from] -> Set of fully qualified type [to] 94 Map<String, Map<String, Set<String>>> packageCpDependencies, // Package name -> Fully Qualified Type [from] -> Set of fully qualified type [to] 95 Map<String, PubApi> packagePublicApis, 96 Map<String, PubApi> dependencyApis, 97 int debugLevel, 98 boolean incremental, 99 int numCores, 100 PrintStream out, 101 PrintStream err); 102 103 void setExtra(String e); 104 void setExtra(Options args); 105 }