src/share/classes/com/sun/tools/javadoc/ToolOption.java

Wed, 27 Apr 2016 01:34:52 +0800

author
aoqi
date
Wed, 27 Apr 2016 01:34:52 +0800
changeset 0
959103a6100f
child 2525
2eb010b6cb22
permissions
-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.tools.javadoc;
aoqi@0 27
aoqi@0 28 import com.sun.tools.javac.code.Flags;
aoqi@0 29 import com.sun.tools.javac.util.ListBuffer;
aoqi@0 30 import com.sun.tools.javac.util.Options;
aoqi@0 31 import java.util.StringTokenizer;
aoqi@0 32
aoqi@0 33
aoqi@0 34 /**
aoqi@0 35 * javadoc tool options.
aoqi@0 36 *
aoqi@0 37 * <p><b>This is NOT part of any supported API.
aoqi@0 38 * If you write code that depends on this, you do so at your own risk.
aoqi@0 39 * This code and its internal interfaces are subject to change or
aoqi@0 40 * deletion without notice.</b>
aoqi@0 41 */
aoqi@0 42 public enum ToolOption {
aoqi@0 43 // ----- options for underlying compiler -----
aoqi@0 44
aoqi@0 45 BOOTCLASSPATH("-bootclasspath", true) {
aoqi@0 46 @Override
aoqi@0 47 public void process(Helper helper, String arg) {
aoqi@0 48 helper.setCompilerOpt(opt, arg);
aoqi@0 49 }
aoqi@0 50 },
aoqi@0 51
aoqi@0 52 CLASSPATH("-classpath", true) {
aoqi@0 53 @Override
aoqi@0 54 public void process(Helper helper, String arg) {
aoqi@0 55 helper.setCompilerOpt(opt, arg);
aoqi@0 56 }
aoqi@0 57 },
aoqi@0 58
aoqi@0 59 CP("-cp", true) {
aoqi@0 60 @Override
aoqi@0 61 public void process(Helper helper, String arg) {
aoqi@0 62 helper.setCompilerOpt(opt, arg);
aoqi@0 63 }
aoqi@0 64 },
aoqi@0 65
aoqi@0 66 EXTDIRS("-extdirs", true) {
aoqi@0 67 @Override
aoqi@0 68 public void process(Helper helper, String arg) {
aoqi@0 69 helper.setCompilerOpt(opt, arg);
aoqi@0 70 }
aoqi@0 71 },
aoqi@0 72
aoqi@0 73 SOURCEPATH("-sourcepath", true) {
aoqi@0 74 @Override
aoqi@0 75 public void process(Helper helper, String arg) {
aoqi@0 76 helper.setCompilerOpt(opt, arg);
aoqi@0 77 }
aoqi@0 78 },
aoqi@0 79
aoqi@0 80 SYSCLASSPATH("-sysclasspath", true) {
aoqi@0 81 @Override
aoqi@0 82 public void process(Helper helper, String arg) {
aoqi@0 83 helper.setCompilerOpt("-bootclasspath", arg);
aoqi@0 84 }
aoqi@0 85 },
aoqi@0 86
aoqi@0 87 ENCODING("-encoding", true) {
aoqi@0 88 @Override
aoqi@0 89 public void process(Helper helper, String arg) {
aoqi@0 90 helper.encoding = arg;
aoqi@0 91 helper.setCompilerOpt(opt, arg);
aoqi@0 92 }
aoqi@0 93 },
aoqi@0 94
aoqi@0 95 SOURCE("-source", true) {
aoqi@0 96 @Override
aoqi@0 97 public void process(Helper helper, String arg) {
aoqi@0 98 helper.setCompilerOpt(opt, arg);
aoqi@0 99 }
aoqi@0 100 },
aoqi@0 101
aoqi@0 102 XMAXERRS("-Xmaxerrs", true) {
aoqi@0 103 @Override
aoqi@0 104 public void process(Helper helper, String arg) {
aoqi@0 105 helper.setCompilerOpt(opt, arg);
aoqi@0 106 }
aoqi@0 107 },
aoqi@0 108
aoqi@0 109 XMAXWARNS("-Xmaxwarns", true) {
aoqi@0 110 @Override
aoqi@0 111 public void process(Helper helper, String arg) {
aoqi@0 112 helper.setCompilerOpt(opt, arg);
aoqi@0 113 }
aoqi@0 114 },
aoqi@0 115
aoqi@0 116 // ----- doclet options -----
aoqi@0 117
aoqi@0 118 DOCLET("-doclet", true), // handled in setDocletInvoker
aoqi@0 119
aoqi@0 120 DOCLETPATH("-docletpath", true), // handled in setDocletInvoker
aoqi@0 121
aoqi@0 122 // ----- selection options -----
aoqi@0 123
aoqi@0 124 SUBPACKAGES("-subpackages", true) {
aoqi@0 125 @Override
aoqi@0 126 public void process(Helper helper, String arg) {
aoqi@0 127 helper.addToList(helper.subPackages, arg);
aoqi@0 128 }
aoqi@0 129 },
aoqi@0 130
aoqi@0 131 EXCLUDE("-exclude", true) {
aoqi@0 132 @Override
aoqi@0 133 public void process(Helper helper, String arg) {
aoqi@0 134 helper.addToList(helper.excludedPackages, arg);
aoqi@0 135 }
aoqi@0 136 },
aoqi@0 137
aoqi@0 138 // ----- filtering options -----
aoqi@0 139
aoqi@0 140 PACKAGE("-package") {
aoqi@0 141 @Override
aoqi@0 142 public void process(Helper helper) {
aoqi@0 143 helper.setFilter(
aoqi@0 144 Flags.PUBLIC | Flags.PROTECTED | ModifierFilter.PACKAGE);
aoqi@0 145 }
aoqi@0 146 },
aoqi@0 147
aoqi@0 148 PRIVATE("-private") {
aoqi@0 149 @Override
aoqi@0 150 public void process(Helper helper) {
aoqi@0 151 helper.setFilter(ModifierFilter.ALL_ACCESS);
aoqi@0 152 }
aoqi@0 153 },
aoqi@0 154
aoqi@0 155 PROTECTED("-protected") {
aoqi@0 156 @Override
aoqi@0 157 public void process(Helper helper) {
aoqi@0 158 helper.setFilter(Flags.PUBLIC | Flags.PROTECTED);
aoqi@0 159 }
aoqi@0 160 },
aoqi@0 161
aoqi@0 162 PUBLIC("-public") {
aoqi@0 163 @Override
aoqi@0 164 public void process(Helper helper) {
aoqi@0 165 helper.setFilter(Flags.PUBLIC);
aoqi@0 166 }
aoqi@0 167 },
aoqi@0 168
aoqi@0 169 // ----- output control options -----
aoqi@0 170
aoqi@0 171 PROMPT("-prompt") {
aoqi@0 172 @Override
aoqi@0 173 public void process(Helper helper) {
aoqi@0 174 helper.compOpts.put("-prompt", "-prompt");
aoqi@0 175 helper.promptOnError = true;
aoqi@0 176 }
aoqi@0 177 },
aoqi@0 178
aoqi@0 179 QUIET("-quiet") {
aoqi@0 180 @Override
aoqi@0 181 public void process(Helper helper) {
aoqi@0 182 helper.quiet = true;
aoqi@0 183 }
aoqi@0 184 },
aoqi@0 185
aoqi@0 186 VERBOSE("-verbose") {
aoqi@0 187 @Override
aoqi@0 188 public void process(Helper helper) {
aoqi@0 189 helper.compOpts.put("-verbose", "");
aoqi@0 190 }
aoqi@0 191 },
aoqi@0 192
aoqi@0 193 XWERROR("-Xwerror") {
aoqi@0 194 @Override
aoqi@0 195 public void process(Helper helper) {
aoqi@0 196 helper.rejectWarnings = true;
aoqi@0 197
aoqi@0 198 }
aoqi@0 199 },
aoqi@0 200
aoqi@0 201 // ----- other options -----
aoqi@0 202
aoqi@0 203 BREAKITERATOR("-breakiterator") {
aoqi@0 204 @Override
aoqi@0 205 public void process(Helper helper) {
aoqi@0 206 helper.breakiterator = true;
aoqi@0 207 }
aoqi@0 208 },
aoqi@0 209
aoqi@0 210 LOCALE("-locale", true) {
aoqi@0 211 @Override
aoqi@0 212 public void process(Helper helper, String arg) {
aoqi@0 213 helper.docLocale = arg;
aoqi@0 214 }
aoqi@0 215 },
aoqi@0 216
aoqi@0 217 OVERVIEW("-overview", true),
aoqi@0 218
aoqi@0 219 XCLASSES("-Xclasses") {
aoqi@0 220 @Override
aoqi@0 221 public void process(Helper helper) {
aoqi@0 222 helper.docClasses = true;
aoqi@0 223
aoqi@0 224 }
aoqi@0 225 },
aoqi@0 226
aoqi@0 227 // ----- help options -----
aoqi@0 228
aoqi@0 229 HELP("-help") {
aoqi@0 230 @Override
aoqi@0 231 public void process(Helper helper) {
aoqi@0 232 helper.usage();
aoqi@0 233 }
aoqi@0 234 },
aoqi@0 235
aoqi@0 236 X("-X") {
aoqi@0 237 @Override
aoqi@0 238 public void process(Helper helper) {
aoqi@0 239 helper.Xusage();
aoqi@0 240 }
aoqi@0 241 };
aoqi@0 242
aoqi@0 243 public final String opt;
aoqi@0 244 public final boolean hasArg;
aoqi@0 245
aoqi@0 246 ToolOption(String opt) {
aoqi@0 247 this(opt, false);
aoqi@0 248 }
aoqi@0 249
aoqi@0 250 ToolOption(String opt, boolean hasArg) {
aoqi@0 251 this.opt = opt;
aoqi@0 252 this.hasArg = hasArg;
aoqi@0 253 }
aoqi@0 254
aoqi@0 255 void process(Helper helper, String arg) { }
aoqi@0 256
aoqi@0 257 void process(Helper helper) { }
aoqi@0 258
aoqi@0 259 static ToolOption get(String name) {
aoqi@0 260 for (ToolOption o: values()) {
aoqi@0 261 if (name.equals(o.opt))
aoqi@0 262 return o;
aoqi@0 263 }
aoqi@0 264 return null;
aoqi@0 265 }
aoqi@0 266
aoqi@0 267 static abstract class Helper {
aoqi@0 268 /** List of decoded options. */
aoqi@0 269 final ListBuffer<String[]> options = new ListBuffer<String[]>();
aoqi@0 270
aoqi@0 271 /** Selected packages, from -subpackages. */
aoqi@0 272 final ListBuffer<String> subPackages = new ListBuffer<String>();
aoqi@0 273
aoqi@0 274 /** Excluded packages, from -exclude. */
aoqi@0 275 final ListBuffer<String> excludedPackages = new ListBuffer<String>();
aoqi@0 276
aoqi@0 277 /** javac options, set by various options. */
aoqi@0 278 Options compOpts; // = Options.instance(context)
aoqi@0 279
aoqi@0 280 /* Encoding for javac, and files written? set by -encoding. */
aoqi@0 281 String encoding = null;
aoqi@0 282
aoqi@0 283 /** Set by -breakiterator. */
aoqi@0 284 boolean breakiterator = false;
aoqi@0 285
aoqi@0 286 /** Set by -quiet. */
aoqi@0 287 boolean quiet = false;
aoqi@0 288
aoqi@0 289 /** Set by -Xclasses. */
aoqi@0 290 boolean docClasses = false;
aoqi@0 291
aoqi@0 292 /** Set by -Xwerror. */
aoqi@0 293 boolean rejectWarnings = false;
aoqi@0 294
aoqi@0 295 /** Set by -prompt. */
aoqi@0 296 boolean promptOnError;
aoqi@0 297
aoqi@0 298 /** Set by -locale. */
aoqi@0 299 String docLocale = "";
aoqi@0 300
aoqi@0 301 /** Set by -public, private, -protected, -package. */
aoqi@0 302 ModifierFilter showAccess = null;
aoqi@0 303
aoqi@0 304 abstract void usage();
aoqi@0 305 abstract void Xusage();
aoqi@0 306
aoqi@0 307 abstract void usageError(String msg, Object... args);
aoqi@0 308
aoqi@0 309 protected void addToList(ListBuffer<String> list, String str){
aoqi@0 310 StringTokenizer st = new StringTokenizer(str, ":");
aoqi@0 311 String current;
aoqi@0 312 while(st.hasMoreTokens()){
aoqi@0 313 current = st.nextToken();
aoqi@0 314 list.append(current);
aoqi@0 315 }
aoqi@0 316 }
aoqi@0 317
aoqi@0 318 protected void setFilter(long filterBits) {
aoqi@0 319 if (showAccess != null) {
aoqi@0 320 usageError("main.incompatible.access.flags");
aoqi@0 321 }
aoqi@0 322 showAccess = new ModifierFilter(filterBits);
aoqi@0 323 }
aoqi@0 324
aoqi@0 325 private void setCompilerOpt(String opt, String arg) {
aoqi@0 326 if (compOpts.get(opt) != null) {
aoqi@0 327 usageError("main.option.already.seen", opt);
aoqi@0 328 }
aoqi@0 329 compOpts.put(opt, arg);
aoqi@0 330 }
aoqi@0 331 }
aoqi@0 332 }

mercurial