langtools/src/share/classes/com/sun/tools/javac/api/BasicJavacTask.java
author jjg
Mon, 19 Nov 2012 11:38:49 -0800
changeset 14548 aa687b312c97
parent 14258 8d2148961366
child 14952 d0022ae20516
permissions -rw-r--r--
8001098: Provide a simple light-weight "plug-in" mechanism for javac Reviewed-by: mcimadamore
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
12016
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     1
/*
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     2
 * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     4
 *
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    10
 *
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    15
 * accompanied this code).
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    16
 *
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    20
 *
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    23
 * questions.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    24
 */
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    25
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    26
package com.sun.tools.javac.api;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    27
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    28
import java.io.IOException;
14258
8d2148961366 8000663: clean up langtools imports
jjg
parents: 14044
diff changeset
    29
import java.util.Collection;
12016
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    30
import java.util.Locale;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    31
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    32
import javax.annotation.processing.Processor;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    33
import javax.lang.model.element.Element;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    34
import javax.lang.model.type.TypeMirror;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    35
import javax.lang.model.util.Elements;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    36
import javax.lang.model.util.Types;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    37
import javax.tools.JavaFileObject;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    38
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    39
import com.sun.source.tree.CompilationUnitTree;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    40
import com.sun.source.tree.Tree;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    41
import com.sun.source.util.JavacTask;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    42
import com.sun.source.util.TaskListener;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    43
import com.sun.tools.javac.model.JavacElements;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    44
import com.sun.tools.javac.model.JavacTypes;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    45
import com.sun.tools.javac.tree.JCTree;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    46
import com.sun.tools.javac.util.Context;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    47
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    48
/**
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    49
 * Provides basic functionality for implementations of JavacTask.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    50
 *
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    51
 * <p><b>This is NOT part of any supported API.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    52
 * If you write code that depends on this, you do so at your own
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    53
 * risk.  This code and its internal interfaces are subject to change
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    54
 * or deletion without notice.</b></p>
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    55
 */
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    56
public class BasicJavacTask extends JavacTask {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    57
    protected Context context;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    58
    private TaskListener taskListener;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    59
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    60
    public BasicJavacTask(Context c, boolean register) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    61
        context = c;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    62
        if (register)
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    63
            context.put(JavacTask.class, this);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    64
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    65
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    66
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    67
    public Iterable<? extends CompilationUnitTree> parse() throws IOException {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    68
        throw new IllegalStateException();
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    69
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    70
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    71
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    72
    public Iterable<? extends Element> analyze() throws IOException {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    73
        throw new IllegalStateException();
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    74
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    75
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    76
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    77
    public Iterable<? extends JavaFileObject> generate() throws IOException {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    78
        throw new IllegalStateException();
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    79
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    80
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    81
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    82
    public void setTaskListener(TaskListener tl) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    83
        MultiTaskListener mtl = MultiTaskListener.instance(context);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    84
        if (taskListener != null)
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    85
            mtl.remove(taskListener);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    86
        if (tl != null)
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    87
            mtl.add(tl);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    88
        taskListener = tl;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    89
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    90
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    91
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    92
    public void addTaskListener(TaskListener taskListener) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    93
        MultiTaskListener mtl = MultiTaskListener.instance(context);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    94
        mtl.add(taskListener);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    95
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    96
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    97
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    98
    public void removeTaskListener(TaskListener taskListener) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    99
        MultiTaskListener mtl = MultiTaskListener.instance(context);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   100
        mtl.remove(taskListener);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   101
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   102
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   103
    public Collection<TaskListener> getTaskListeners() {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   104
        MultiTaskListener mtl = MultiTaskListener.instance(context);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   105
        return mtl.getTaskListeners();
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   106
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   107
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   108
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   109
    public TypeMirror getTypeMirror(Iterable<? extends Tree> path) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   110
        // TODO: Should complete attribution if necessary
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   111
        Tree last = null;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   112
        for (Tree node : path)
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   113
            last = node;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   114
        return ((JCTree)last).type;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   115
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   116
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   117
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   118
    public Elements getElements() {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   119
        return JavacElements.instance(context);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   120
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   121
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   122
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   123
    public Types getTypes() {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   124
        return JavacTypes.instance(context);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   125
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   126
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   127
    public void setProcessors(Iterable<? extends Processor> processors) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   128
        throw new IllegalStateException();
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   129
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   130
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   131
    public void setLocale(Locale locale) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   132
        throw new IllegalStateException();
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   133
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   134
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   135
    public Boolean call() {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   136
        throw new IllegalStateException();
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   137
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   138
14044
0070e9c44020 7196462: JavacProcessingEnvironment should tolerate BasicJavacTask
jjg
parents: 12016
diff changeset
   139
    /**
0070e9c44020 7196462: JavacProcessingEnvironment should tolerate BasicJavacTask
jjg
parents: 12016
diff changeset
   140
     * For internal use only.  This method will be
0070e9c44020 7196462: JavacProcessingEnvironment should tolerate BasicJavacTask
jjg
parents: 12016
diff changeset
   141
     * removed without warning.
0070e9c44020 7196462: JavacProcessingEnvironment should tolerate BasicJavacTask
jjg
parents: 12016
diff changeset
   142
     */
14548
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents: 14258
diff changeset
   143
    public Context getContext() {
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents: 14258
diff changeset
   144
        return context;
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents: 14258
diff changeset
   145
    }
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents: 14258
diff changeset
   146
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents: 14258
diff changeset
   147
    /**
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents: 14258
diff changeset
   148
     * For internal use only.  This method will be
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents: 14258
diff changeset
   149
     * removed without warning.
aa687b312c97 8001098: Provide a simple light-weight "plug-in" mechanism for javac
jjg
parents: 14258
diff changeset
   150
     */
14044
0070e9c44020 7196462: JavacProcessingEnvironment should tolerate BasicJavacTask
jjg
parents: 12016
diff changeset
   151
    public void updateContext(Context newContext) {
0070e9c44020 7196462: JavacProcessingEnvironment should tolerate BasicJavacTask
jjg
parents: 12016
diff changeset
   152
        context = newContext;
0070e9c44020 7196462: JavacProcessingEnvironment should tolerate BasicJavacTask
jjg
parents: 12016
diff changeset
   153
    }
12016
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   154
}