← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to languages/engine/src/org/netbeans/api/languages/ParserManager.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
languages/engine/src/org/netbeans/api/languages/ParserManager.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
package org.netbeans.api.languages;
 
42
 
 
43
import java.lang.ref.WeakReference;
 
44
import java.util.Iterator;
 
45
import java.util.Map;
 
46
import java.util.WeakHashMap;
 
47
import javax.swing.text.Document;
 
48
import org.netbeans.modules.languages.ParserManagerImpl;
 
49
 
 
50
 
 
51
/**
 
52
 * Represents parser implementation.
 
53
 * 
 
54
 * @author Jan Jancura
 
55
 */
 
56
public abstract class ParserManager {
 
57
    
 
58
    /**
 
59
     * State of parser.
 
60
     */
 
61
    public static enum State {
 
62
        /** Parser is running. */
 
63
        PARSING, 
 
64
        /** Parsed without errors. */
 
65
        OK, 
 
66
        /** Parser with errors. */
 
67
        ERROR, 
 
68
        /** Parser has not been started yet. */
 
69
        NOT_PARSED
 
70
    }
 
71
    
 
72
    
 
73
    private static Map<Document,WeakReference<ParserManager>> managers = 
 
74
        new WeakHashMap<Document,WeakReference<ParserManager>> ();
 
75
    
 
76
    /**
 
77
     * Returns parser for given {@link javax.swing.text.Document}.
 
78
     * 
 
79
     * @return parser for given {@link javax.swing.text.Document}
 
80
     */
 
81
    public static synchronized ParserManager get (Document doc) {
 
82
        WeakReference<ParserManager> wr = managers.get (doc);
 
83
        ParserManager pm = wr != null ? wr.get () : null;
 
84
        if (pm == null) {
 
85
            pm = new ParserManagerImpl (doc);
 
86
            managers.put (doc, new WeakReference<ParserManager> (pm));
 
87
            //Utils.startTest ("ParserManager.managers", managers);
 
88
//            printManagers ();
 
89
        }
 
90
        return pm;
 
91
    }
 
92
 
 
93
    /**
 
94
     * Returns state of parser.
 
95
     * 
 
96
     * @retrun a state of parser
 
97
     */
 
98
    public abstract State getState ();
 
99
    
 
100
    /**
 
101
     * Returns AST tree root node.
 
102
     * 
 
103
     * @throws in the case of errors in document
 
104
     * @retrun AST tree root node
 
105
     */
 
106
    public abstract ASTNode getAST () throws ParseException;
 
107
    
 
108
    /**
 
109
     * Registers ParserManagerListener.
 
110
     * 
 
111
     * @param l ParserManagerListener to be registerred
 
112
     */
 
113
    public abstract void addListener (ParserManagerListener l);
 
114
    
 
115
    /**
 
116
     * Unregisters ParserManagerListener.
 
117
     * 
 
118
     * @param l ParserManagerListener to be unregisterred
 
119
     */
 
120
    public abstract void removeListener (ParserManagerListener l);
 
121
    
 
122
    /**
 
123
     * Registers ASTEvaluator.
 
124
     * 
 
125
     * @param l ASTEvaluator to be unregisterred
 
126
     */
 
127
    public abstract void addASTEvaluator (ASTEvaluator e);
 
128
    
 
129
    /**
 
130
     * Unregisters ASTEvaluator.
 
131
     * 
 
132
     * @param l ASTEvaluator to be unregisterred
 
133
     */
 
134
    public abstract void removeASTEvaluator (ASTEvaluator e);
 
135
    
 
136
    
 
137
    private static void printManagers () {
 
138
        System.out.println("\nParserManagers:");
 
139
        Iterator<Document> it = managers.keySet ().iterator ();
 
140
        while (it.hasNext ()) {
 
141
            Document document =  it.next ();
 
142
            String title = (String) document.getProperty("title");
 
143
            if (title == null)
 
144
                title = document.toString();
 
145
            WeakReference wr = managers.get (document);
 
146
            if (wr.get () != null)
 
147
                System.out.println("  " + title);
 
148
        }
 
149
    }
 
150
}
 
151
 
 
152
 
 
153