/*

 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.tools.javadoc;

import com.sun.tools.javac.code.Flags;

import com.sun.tools.javac.util.ListBuffer;

import com.sun.tools.javac.util.Options;

import java.util.StringTokenizer;

/**

 * javadoc tool options.

 *

 *  <p><b>This is NOT part of any supported API.

 *  If you write code that depends on this, you do so at your own risk.

 *  This code and its internal interfaces are subject to change or

 *  deletion without notice.</b>

 */

public enum ToolOption {

    // ----- options for underlying compiler -----

    BOOTCLASSPATH("-bootclasspath", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.setCompilerOpt(opt, arg);

        }

    },

    CLASSPATH("-classpath", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.setCompilerOpt(opt, arg);

        }

    },

    CP("-cp", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.setCompilerOpt(opt, arg);

        }

    },

    EXTDIRS("-extdirs", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.setCompilerOpt(opt, arg);

        }

    },

    SOURCEPATH("-sourcepath", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.setCompilerOpt(opt, arg);

        }

    },

    SYSCLASSPATH("-sysclasspath", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.setCompilerOpt("-bootclasspath", arg);

        }

    },

    ENCODING("-encoding", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.encoding = arg;

            helper.setCompilerOpt(opt, arg);

        }

    },

    SOURCE("-source", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.setCompilerOpt(opt, arg);

        }

    },

    XMAXERRS("-Xmaxerrs", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.setCompilerOpt(opt, arg);

        }

    },

    XMAXWARNS("-Xmaxwarns", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.setCompilerOpt(opt, arg);

        }

    },

    // ----- doclet options -----

    DOCLET("-doclet", true), // handled in setDocletInvoker

    DOCLETPATH("-docletpath", true), // handled in setDocletInvoker

    // ----- selection options -----

    SUBPACKAGES("-subpackages", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.addToList(helper.subPackages, arg);

        }

    },

    EXCLUDE("-exclude", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.addToList(helper.excludedPackages, arg);

        }

    },

    // ----- filtering options -----

    PACKAGE("-package") {

        @Override

        public void process(Helper helper) {

            helper.setFilter(

                    Flags.PUBLIC | Flags.PROTECTED | ModifierFilter.PACKAGE);

        }

    },

    PRIVATE("-private") {

        @Override

        public void process(Helper helper) {

            helper.setFilter(ModifierFilter.ALL_ACCESS);

        }

    },

    PROTECTED("-protected") {

        @Override

        public void process(Helper helper) {

            helper.setFilter(Flags.PUBLIC | Flags.PROTECTED);

        }

    },

    PUBLIC("-public") {

        @Override

        public void process(Helper helper) {

            helper.setFilter(Flags.PUBLIC);

        }

    },

    // ----- output control options -----

    PROMPT("-prompt") {

        @Override

        public void process(Helper helper) {

            helper.compOpts.put("-prompt", "-prompt");

            helper.promptOnError = true;

        }

    },

    QUIET("-quiet") {

        @Override

        public void process(Helper helper) {

            helper.quiet = true;

        }

    },

    VERBOSE("-verbose") {

        @Override

        public void process(Helper helper) {

            helper.compOpts.put("-verbose", "");

        }

    },

    XWERROR("-Xwerror") {

        @Override

        public void process(Helper helper) {

            helper.rejectWarnings = true;

        }

    },

    // ----- other options -----

    BREAKITERATOR("-breakiterator") {

        @Override

        public void process(Helper helper) {

            helper.breakiterator = true;

        }

    },

    LOCALE("-locale", true) {

        @Override

        public void process(Helper helper, String arg) {

            helper.docLocale = arg;

        }

    },

    OVERVIEW("-overview", true),

    XCLASSES("-Xclasses") {

        @Override

        public void process(Helper helper) {

            helper.docClasses = true;

        }

    },

    // ----- help options -----

    HELP("-help") {

        @Override

        public void process(Helper helper) {

            helper.usage();

        }

    },

    X("-X") {

        @Override

        public void process(Helper helper) {

            helper.Xusage();

        }

    };

    public final String opt;

    public final boolean hasArg;

    ToolOption(String opt) {

        this(opt, false);

    }

    ToolOption(String opt, boolean hasArg) {

        this.opt = opt;

        this.hasArg = hasArg;

    }

    void process(Helper helper, String arg) { }

    void process(Helper helper) { }

    static ToolOption get(String name) {

        for (ToolOption o: values()) {

            if (name.equals(o.opt))

                return o;

        }

        return null;

    }

    static abstract class Helper {

        /** List of decoded options. */

        /** Selected packages, from -subpackages. */

        /** Excluded packages, from -exclude. */

        /** javac options, set by various options. */

        Options compOpts; // = Options.instance(context)

        /* Encoding for javac, and files written? set by -encoding. */

        String encoding = null;

        /** Set by -breakiterator. */

        boolean breakiterator = false;

        /** Set by -quiet. */

        boolean quiet = false;

        /** Set by -Xclasses. */

        boolean docClasses = false;

        /** Set by -Xwerror. */

        boolean rejectWarnings = false;

        /** Set by -prompt. */

        boolean promptOnError;

        /** Set by -locale. */

        String docLocale = "";

        /** Set by -public, private, -protected, -package. */

        ModifierFilter showAccess = null;

        abstract void usage();

        abstract void Xusage();

        abstract void usageError(String msg, Object... args);

        protected void addToList(ListBuffer<String> list, String str){

            StringTokenizer st = new StringTokenizer(str, ":");

            String current;

            while(st.hasMoreTokens()){

                current = st.nextToken();

                list.append(current);

            }

        }

        protected void setFilter(long filterBits) {

            if (showAccess != null) {

                usageError("main.incompatible.access.flags");

            }

            showAccess = new ModifierFilter(filterBits);

        }

        private void setCompilerOpt(String opt, String arg) {

            if (compOpts.get(opt) != null) {

                usageError("main.option.already.seen", opt);

            }

            compOpts.put(opt, arg);

        }

    }

}