KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > checks > usage > transmogrify > ScopeIndex


1
2 // Transmogrify License
3 //
4 // Copyright (c) 2001, ThoughtWorks, Inc.
5 // All rights reserved.
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions
8 // are met:
9 // - Redistributions of source code must retain the above copyright notice,
10 // this list of conditions and the following disclaimer.
11 // - Redistributions in binary form must reproduce the above copyright
12 // notice, this list of conditions and the following disclaimer in the
13 // documentation and/or other materials provided with the distribution.
14 // Neither the name of the ThoughtWorks, Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from this
16 // software without specific prior written permission.
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
27 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
30
31 import java.util.Hashtable JavaDoc;
32 import java.util.Vector JavaDoc;
33
34
35
36
37 /**
38  * <code>ScopeIndex</code> provides methods for finding <code>Scope</code>s
39  * related to a known <code>Occurrence</code>
40  */
41 public class ScopeIndex {
42
43     //This is a Hashtable full of Vectors. The keys to this hashtable are filenames.
44 //Each vector contains all of the scope objects from the specific file.
45 private Hashtable JavaDoc indexOfFiles = new Hashtable JavaDoc();
46
47     public Hashtable JavaDoc getIndex() {
48         return indexOfFiles;
49     }
50
51     /**
52      * returns the most specific <code>Scope</code> to which the specified
53      * <code>Occurence</code> belongs.
54      *
55      * @param occ the <code>Occurrence</code> whose <code>Scope</code> we're interested in.
56      * @return Scope
57      */
58     public Scope lookup(Occurrence occ) {
59         String JavaDoc key = occ.getFile().getAbsolutePath();
60         Vector JavaDoc scopeList = getFileVector(key);
61
62         Scope result = findScope(scopeList, occ);
63
64         return result;
65     }
66
67     /**
68      * returns the most specific <code>Scope</code> to which the specified
69      * <code>Occurence</code> belongs from the specified <code>Vector</code>
70      * of <code>Scope</code>s.
71      *
72      * @param occ the <code>Occurrence</code> whose <code>Scope</code> we're interested in.
73      * @param scopeList the <code>Vector</code> of <code>Scope</code>s to chose from.
74      * @return Scope
75      */
76     public Scope findScope(Vector JavaDoc scopeList, Occurrence occ) {
77         int i = 0;
78
79         Scope bestSoFar = (Scope) scopeList.elementAt(i);
80
81         while (!bestSoFar
82             .getTreeNode()
83             .getSpan()
84             .contains(occ.getLine(), occ.getColumn())) {
85             i++;
86             bestSoFar = (Scope) scopeList.elementAt(i);
87         }
88
89         for (; i < scopeList.size(); i++) {
90             Scope currentScope = (Scope) scopeList.elementAt(i);
91
92             if (currentScope
93                 .getTreeNode()
94                 .getSpan()
95                 .contains(occ.getLine(), occ.getColumn())) {
96                 if (bestSoFar
97                     .getTreeNode()
98                     .getSpan()
99                     .contains(currentScope.getTreeNode().getSpan())) {
100                     bestSoFar = currentScope;
101                 }
102             }
103         }
104
105         return bestSoFar;
106     }
107
108     /**
109      * adds a <code>Scope</code> to the <code>ScopeIndex</code> for searching.
110      *
111      * @param scope the <code>Scope</code> to add.
112      */
113     public void addScope(Scope scope) {
114
115         final SymTabAST SymTabAST = scope.getTreeNode();
116         SymTabAST.getFile();
117         Vector JavaDoc fileVector =
118             getFileVector(scope.getTreeNode().getFile().getAbsolutePath());
119
120         fileVector.addElement(scope);
121     }
122
123     /**
124      * returns the <code>Vector</code> containing the <code>Scope</code>s related
125      * to the specified filename.
126      *
127      * @param fileName the fileName to find scopes for.
128      * @return Vector
129      */
130     private Vector JavaDoc getFileVector(String JavaDoc fileName) {
131         Vector JavaDoc result = (Vector JavaDoc) indexOfFiles.get(fileName);
132
133         if (result == null) {
134             result = new Vector JavaDoc();
135             indexOfFiles.put(fileName, result);
136         }
137
138         return result;
139     }
140 }
Popular Tags