001: /* ====================================================================
002: * The JRefactory License, Version 1.0
003: *
004: * Copyright (c) 2001 JRefactory. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by the
021: * JRefactory (http://www.sourceforge.org/projects/jrefactory)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. The names "JRefactory" must not be used to endorse or promote
026: * products derived from this software without prior written
027: * permission. For written permission, please contact seguin@acm.org.
028: *
029: * 5. Products derived from this software may not be called "JRefactory",
030: * nor may "JRefactory" appear in their name, without prior written
031: * permission of Chris Seguin.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE CHRIS SEGUIN OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of JRefactory. For more information on
049: * JRefactory, please see
050: * <http://www.sourceforge.org/projects/jrefactory>.
051: */
052: package org.acm.seguin.summary.query;
053:
054: import java.util.Iterator;
055: import org.acm.seguin.summary.FieldSummary;
056: import org.acm.seguin.summary.LocalVariableSummary;
057: import org.acm.seguin.summary.MethodSummary;
058: import org.acm.seguin.summary.ParameterSummary;
059: import org.acm.seguin.summary.Summary;
060: import org.acm.seguin.summary.TypeDeclSummary;
061: import org.acm.seguin.summary.TypeSummary;
062: import org.acm.seguin.summary.VariableSummary;
063:
064: /**
065: * Performs a local variable lookup
066: *
067: *@author Chris Seguin
068: *@created September 12, 2001
069: */
070: public class LookupVariable {
071: /**
072: * Looks up the variable
073: *
074: *@param method the method summary
075: *@param name the name of the variable to find
076: *@return the variable summary if found or null otherwise
077: */
078: public static VariableSummary query(MethodSummary method,
079: String name) {
080: VariableSummary result = getLocal(method, name);
081: if (result != null) {
082: return result;
083: }
084:
085: TypeSummary currentType = (TypeSummary) method.getParent();
086: return queryFieldSummary(currentType, name);
087: }
088:
089: /**
090: * Get a field summary
091: *
092: *@param currentType the type to search in
093: *@param name the name of the field
094: *@return the field summary found or null if none was found
095: */
096: public static VariableSummary queryFieldSummary(
097: TypeSummary currentType, String name) {
098: VariableSummary result = getField(currentType, name, true);
099: if (result != null) {
100: return result;
101: }
102:
103: TypeDeclSummary parentType = currentType.getParentClass();
104: currentType = GetTypeSummary.query(parentType);
105: while (currentType != null) {
106: result = getField(currentType, name, false);
107: if (result != null) {
108: return result;
109: }
110:
111: parentType = currentType.getParentClass();
112: currentType = GetTypeSummary.query(parentType);
113: }
114:
115: return null;
116: }
117:
118: /**
119: * Finds a field in a type summary
120: *
121: *@param type the type to search
122: *@param name the name of the variable
123: *@param isPrivateAllowed is the field allowed to be private
124: *@return The FieldSummary if found, null otherwise
125: */
126: private static VariableSummary getField(TypeSummary type,
127: String name, boolean isPrivateAllowed) {
128: Iterator iter = type.getFields();
129: if (iter == null) {
130: return null;
131: }
132:
133: while (iter.hasNext()) {
134: FieldSummary next = (FieldSummary) iter.next();
135: if (!isPrivateAllowed || next.isPrivate()) {
136: if (next.getName().equals(name)) {
137: return next;
138: }
139: }
140: }
141:
142: return null;
143: }
144:
145: /**
146: * Looks up the variable inside the method
147: *
148: *@param method the method summary
149: *@param name the name of the variable to find
150: *@return the variable summary if found or null otherwise
151: */
152: public static VariableSummary getLocal(MethodSummary method,
153: String name) {
154: Iterator iter = method.getParameters();
155: if (iter != null) {
156: while (iter.hasNext()) {
157: ParameterSummary param = (ParameterSummary) iter.next();
158: if (param.getName().equals(name)) {
159: return param;
160: }
161: }
162: }
163:
164: iter = method.getDependencies();
165: if (iter != null) {
166: while (iter.hasNext()) {
167: Summary next = (Summary) iter.next();
168: if ((next instanceof LocalVariableSummary)
169: && (next.getName().equals(name))) {
170: return (VariableSummary) next;
171: }
172: }
173: }
174:
175: return null;
176: }
177: }
|