langtools/test/lib/combo/tools/javac/combo/Template.java
author emc
Wed, 11 Sep 2013 08:30:58 -0400
changeset 19936 41f7c3013d9b
parent 19931 f82b95ab8015
child 34752 9c262a013456
permissions -rw-r--r--
8024510: lib/combo/tools/javac/combo/TemplateTest.java fails Summary: Edit regex in Template to allow "MAJOR." pattern. Reviewed-by: briangoetz
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
19931
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
     1
/*
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
     2
 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
     4
 *
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
     7
 * published by the Free Software Foundation.
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
     8
 *
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    13
 * accompanied this code).
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    14
 *
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    18
 *
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    21
 * questions.
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    22
 */
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    23
package tools.javac.combo;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    24
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    25
import java.util.Map;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    26
import java.util.regex.Matcher;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    27
import java.util.regex.Pattern;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    28
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    29
/**
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    30
 * A template into which tags of the form {@code #\{KEY\}} or
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    31
 * {@code #\{KEY.SUBKEY\}} can be expanded.
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    32
 */
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    33
public interface Template {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    34
    String expand(String selector);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    35
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    36
    interface Resolver {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    37
        public Template lookup(String key);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    38
    }
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    39
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    40
    public static class Behavior {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    41
        /* Looks for expandable keys.  An expandable key can take the form:
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    42
         *   #{MAJOR}
19936
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    43
         *   #{MAJOR.}
19931
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    44
         *   #{MAJOR.MINOR}
19936
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    45
         * where MAJOR can be IDENTIFIER or IDENTIFIER[NUMERIC_INDEX]
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    46
         * and MINOR can be an identifier.
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    47
         *
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    48
         * The ability to have an empty minor is provided on the
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    49
         * assumption that some tests that can be written with this
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    50
         * will find it useful to make a distinction akin to
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    51
         * distinguishing F from F(), where F is a function pointer,
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    52
         * and also cases of #{FOO.#{BAR}}, where BAR expands to an
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    53
         * empty string.
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    54
         *
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    55
         * However, this being a general-purpose framework, the exact
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    56
         * use is left up to the test writers.
19931
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    57
         */
19936
41f7c3013d9b 8024510: lib/combo/tools/javac/combo/TemplateTest.java fails
emc
parents: 19931
diff changeset
    58
        private static final Pattern pattern = Pattern.compile("#\\{([A-Z_][A-Z0-9_]*(?:\\[\\d+\\])?)(?:\\.([A-Z0-9_]*))?\\}");
19931
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    59
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    60
        public static String expandTemplate(String template, final Map<String, Template> vars) {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    61
            return expandTemplate(template, new MapResolver(vars));
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    62
        }
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    63
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    64
        public static String expandTemplate(String template, Resolver res) {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    65
            CharSequence in = template;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    66
            StringBuffer out = new StringBuffer();
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    67
            while (true) {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    68
                boolean more = false;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    69
                Matcher m = pattern.matcher(in);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    70
                while (m.find()) {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    71
                    String major = m.group(1);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    72
                    String minor = m.group(2);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    73
                    Template key = res.lookup(major);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    74
                    if (key == null)
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    75
                        throw new IllegalStateException("Unknown major key " + major);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    76
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    77
                    String replacement = key.expand(minor == null ? "" : minor);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    78
                    more |= pattern.matcher(replacement).find();
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    79
                    m.appendReplacement(out, replacement);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    80
                }
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    81
                m.appendTail(out);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    82
                if (!more)
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    83
                    return out.toString();
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    84
                else {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    85
                    in = out;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    86
                    out = new StringBuffer();
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    87
                }
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    88
            }
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    89
        }
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    90
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    91
    }
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    92
}
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    93
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    94
class MapResolver implements Template.Resolver {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    95
    private final Map<String, Template> vars;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    96
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    97
    public MapResolver(Map<String, Template> vars) {this.vars = vars;}
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    98
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
    99
    public Template lookup(String key) {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   100
        return vars.get(key);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   101
    }
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   102
}
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   103
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   104
class ChainedResolver implements Template.Resolver {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   105
    private final Template.Resolver upstreamResolver, thisResolver;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   106
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   107
    public ChainedResolver(Template.Resolver upstreamResolver, Template.Resolver thisResolver) {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   108
        this.upstreamResolver = upstreamResolver;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   109
        this.thisResolver = thisResolver;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   110
    }
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   111
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   112
    public Template.Resolver getUpstreamResolver() {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   113
        return upstreamResolver;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   114
    }
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   115
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   116
    @Override
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   117
    public Template lookup(String key) {
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   118
        Template result = thisResolver.lookup(key);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   119
        if (result == null)
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   120
            result = upstreamResolver.lookup(key);
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   121
        return result;
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   122
    }
f82b95ab8015 8015322: Javac template test framework
emc
parents:
diff changeset
   123
}