src/jdk.compiler/share/classes/com/sun/tools/javac/parser/ParserFactory.java
author vromero
Fri, 02 Feb 2018 07:43:54 -0500
changeset 48721 ef3557eb4306
parent 47216 71c04702a3d5
child 49580 62b908c9f0e6
permissions -rw-r--r--
8196403: remove the remaining use of string keys for errors and warnings in the compiler Reviewed-by: mcimadamore, jlahoda
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
     1
/*
48721
ef3557eb4306 8196403: remove the remaining use of string keys for errors and warnings in the compiler
vromero
parents: 47216
diff changeset
     2
 * Copyright (c) 1999, 2018, Oracle and/or its affiliates. All rights reserved.
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
     4
 *
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 3380
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 3380
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    10
 *
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    15
 * accompanied this code).
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    16
 *
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 3380
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 3380
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 3380
diff changeset
    23
 * questions.
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    24
 */
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    25
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    26
package com.sun.tools.javac.parser;
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    27
14541
36f9d11fc9aa 7021614: extend com.sun.source API to support parsing javadoc comments
jjg
parents: 11055
diff changeset
    28
import java.util.Locale;
36f9d11fc9aa 7021614: extend com.sun.source API to support parsing javadoc comments
jjg
parents: 11055
diff changeset
    29
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    30
import com.sun.tools.javac.code.Source;
14541
36f9d11fc9aa 7021614: extend com.sun.source API to support parsing javadoc comments
jjg
parents: 11055
diff changeset
    31
import com.sun.tools.javac.tree.DocTreeMaker;
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    32
import com.sun.tools.javac.tree.TreeMaker;
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    33
import com.sun.tools.javac.util.Context;
48721
ef3557eb4306 8196403: remove the remaining use of string keys for errors and warnings in the compiler
vromero
parents: 47216
diff changeset
    34
import com.sun.tools.javac.util.JCDiagnostic;
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    35
import com.sun.tools.javac.util.Log;
1260
a772ba9ba43d 6574134: Allow for alternative implementation of Name Table with garbage collection of name bytes
jjg
parents: 1258
diff changeset
    36
import com.sun.tools.javac.util.Names;
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    37
import com.sun.tools.javac.util.Options;
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    38
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    39
/**
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    40
 * A factory for creating parsers.
3380
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1260
diff changeset
    41
 *
5847
1908176fd6e3 6944312: Potential rebranding issues in openjdk/langtools repository sources
jjg
parents: 5520
diff changeset
    42
 * <p><b>This is NOT part of any supported API.
3380
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1260
diff changeset
    43
 * If you write code that depends on this, you do so at your own risk.
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1260
diff changeset
    44
 * This code and its internal interfaces are subject to change or
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1260
diff changeset
    45
 * deletion without notice.</b>
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    46
 */
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    47
public class ParserFactory {
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    48
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    49
    /** The context key for the parser factory. */
22163
3651128c74eb 8030244: Update langtools to use Diamond
briangoetz
parents: 14541
diff changeset
    50
    protected static final Context.Key<ParserFactory> parserFactoryKey = new Context.Key<>();
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    51
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    52
    public static ParserFactory instance(Context context) {
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    53
        ParserFactory instance = context.get(parserFactoryKey);
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    54
        if (instance == null) {
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    55
            instance = new ParserFactory(context);
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    56
        }
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    57
        return instance;
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    58
    }
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    59
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    60
    final TreeMaker F;
14541
36f9d11fc9aa 7021614: extend com.sun.source API to support parsing javadoc comments
jjg
parents: 11055
diff changeset
    61
    final DocTreeMaker docTreeMaker;
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    62
    final Log log;
10815
a719aa5f1631 7096014: Javac tokens should retain state
mcimadamore
parents: 6716
diff changeset
    63
    final Tokens tokens;
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    64
    final Source source;
1260
a772ba9ba43d 6574134: Allow for alternative implementation of Name Table with garbage collection of name bytes
jjg
parents: 1258
diff changeset
    65
    final Names names;
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    66
    final Options options;
6716
71df48777dd1 6877202: Elements.getDocComment() is not getting JavaDocComments
jjg
parents: 5847
diff changeset
    67
    final ScannerFactory scannerFactory;
14541
36f9d11fc9aa 7021614: extend com.sun.source API to support parsing javadoc comments
jjg
parents: 11055
diff changeset
    68
    final Locale locale;
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    69
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    70
    protected ParserFactory(Context context) {
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    71
        super();
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    72
        context.put(parserFactoryKey, this);
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    73
        this.F = TreeMaker.instance(context);
14541
36f9d11fc9aa 7021614: extend com.sun.source API to support parsing javadoc comments
jjg
parents: 11055
diff changeset
    74
        this.docTreeMaker = DocTreeMaker.instance(context);
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    75
        this.log = Log.instance(context);
1260
a772ba9ba43d 6574134: Allow for alternative implementation of Name Table with garbage collection of name bytes
jjg
parents: 1258
diff changeset
    76
        this.names = Names.instance(context);
10815
a719aa5f1631 7096014: Javac tokens should retain state
mcimadamore
parents: 6716
diff changeset
    77
        this.tokens = Tokens.instance(context);
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    78
        this.source = Source.instance(context);
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    79
        this.options = Options.instance(context);
6716
71df48777dd1 6877202: Elements.getDocComment() is not getting JavaDocComments
jjg
parents: 5847
diff changeset
    80
        this.scannerFactory = ScannerFactory.instance(context);
14541
36f9d11fc9aa 7021614: extend com.sun.source API to support parsing javadoc comments
jjg
parents: 11055
diff changeset
    81
        this.locale = context.get(Locale.class);
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    82
    }
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    83
14541
36f9d11fc9aa 7021614: extend com.sun.source API to support parsing javadoc comments
jjg
parents: 11055
diff changeset
    84
    public JavacParser newParser(CharSequence input, boolean keepDocComments, boolean keepEndPos, boolean keepLineMap) {
43584
63e67712246b 8166420: Confusing error message when reading bad module declaration
sadayapalam
parents: 25874
diff changeset
    85
        return newParser(input, keepDocComments, keepEndPos, keepLineMap, false);
63e67712246b 8166420: Confusing error message when reading bad module declaration
sadayapalam
parents: 25874
diff changeset
    86
    }
63e67712246b 8166420: Confusing error message when reading bad module declaration
sadayapalam
parents: 25874
diff changeset
    87
63e67712246b 8166420: Confusing error message when reading bad module declaration
sadayapalam
parents: 25874
diff changeset
    88
    public JavacParser newParser(CharSequence input, boolean keepDocComments, boolean keepEndPos, boolean keepLineMap, boolean parseModuleInfo) {
6716
71df48777dd1 6877202: Elements.getDocComment() is not getting JavaDocComments
jjg
parents: 5847
diff changeset
    89
        Lexer lexer = scannerFactory.newScanner(input, keepDocComments);
43584
63e67712246b 8166420: Confusing error message when reading bad module declaration
sadayapalam
parents: 25874
diff changeset
    90
        return new JavacParser(this, lexer, keepDocComments, keepLineMap, keepEndPos, parseModuleInfo);
1258
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    91
    }
1cf37d8837d1 6724118: change JavaCompiler to not use Scanner directly
jjg
parents:
diff changeset
    92
}