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 net.sourceforge.jrefactory.ast.ASTConstructorDeclaration;
056: import net.sourceforge.jrefactory.ast.ASTFormalParameter;
057: import net.sourceforge.jrefactory.ast.ASTFormalParameters;
058: import net.sourceforge.jrefactory.ast.ASTMethodDeclaration;
059: import net.sourceforge.jrefactory.ast.ASTMethodDeclarator;
060: import net.sourceforge.jrefactory.ast.ASTVariableDeclaratorId;
061: import org.acm.seguin.summary.MethodSummary;
062: import org.acm.seguin.summary.ParameterSummary;
063: import org.acm.seguin.summary.TypeSummary;
064: import net.sourceforge.jrefactory.ast.ASTTypeParameters;
065: import net.sourceforge.jrefactory.ast.ASTAnnotation;
066: import net.sourceforge.jrefactory.ast.Node;
067:
068: /**
069: * Looks up a method in a type
070: *
071: *@author Chris Seguin
072: *@author Mike Atkinson
073: *@created April 5, 2000
074: */
075: public class GetMethodSummary {
076: /**
077: * Looks up the method given a type and a name
078: *
079: *@param type the type
080: *@param name the name
081: *@return the method summary
082: */
083: public static MethodSummary query(TypeSummary type, String name) {
084: Iterator iter = type.getMethods();
085: if (iter != null) {
086: while (iter.hasNext()) {
087: MethodSummary next = (MethodSummary) iter.next();
088: if (next.getName().equals(name)) {
089: return next;
090: }
091: }
092: }
093: return null;
094: }
095:
096: /**
097: * Looks up the method given a type and a name
098: *
099: *@param type the type
100: *@param node Description of Parameter
101: *@return the method summary
102: */
103: public static MethodSummary query(TypeSummary type,
104: ASTMethodDeclaration node) {
105: Iterator iter = type.getMethods();
106: if (iter == null) {
107: return null;
108: }
109:
110: while (iter.hasNext()) {
111: MethodSummary next = (MethodSummary) iter.next();
112: if (isMatch(next, node)) {
113: return next;
114: }
115: }
116:
117: return null;
118: }
119:
120: /**
121: * Looks up the method given a type and a name
122: *
123: *@param type the type
124: *@param node Description of Parameter
125: *@return the method summary
126: */
127: public static MethodSummary query(TypeSummary type,
128: ASTConstructorDeclaration node) {
129: Iterator iter = type.getMethods();
130: if (iter == null) {
131: return null;
132: }
133:
134: int childNo = node.skipAnnotationsAndTypeParameters();
135: ASTFormalParameters formalParams = (ASTFormalParameters) node
136: .jjtGetChild(childNo);
137: while (iter.hasNext()) {
138: MethodSummary next = (MethodSummary) iter.next();
139: if (next.isConstructor()
140: && isParameterMatch(formalParams, next)) {
141: return next;
142: }
143: }
144:
145: return null;
146: }
147:
148: /**
149: * Gets the Match attribute of the GetMethodSummary class
150: *
151: *@param current the current method
152: *@param decl the declaration
153: *@return true if we have found the method summary
154: */
155: private static boolean isMatch(MethodSummary current,
156: ASTMethodDeclaration decl) {
157: ASTMethodDeclarator declarator;
158: int childNo = decl.skipAnnotationsAndTypeParameters();
159: declarator = (ASTMethodDeclarator) decl
160: .jjtGetChild(childNo + 1);
161:
162: if (!current.getName().equals(declarator.getName())) {
163: return false;
164: }
165:
166: ASTFormalParameters params = (ASTFormalParameters) declarator
167: .jjtGetFirstChild();
168: return isParameterMatch(params, current);
169: }
170:
171: /**
172: * Gets the ParameterMatch attribute of the GetMethodSummary class
173: *
174: *@param params Description of Parameter
175: *@param current Description of Parameter
176: *@return The parameterMatch value
177: */
178: private static boolean isParameterMatch(ASTFormalParameters params,
179: MethodSummary current) {
180: int childrenCount = params.jjtGetNumChildren();
181: if (childrenCount != current.getParameterCount()) {
182: return false;
183: }
184:
185: if (childrenCount == 0) {
186: return true;
187: }
188:
189: Iterator iter = current.getParameters();
190: for (int ndx = 0; ndx < childrenCount; ndx++) {
191: ParameterSummary next = (ParameterSummary) iter.next();
192: ASTFormalParameter nextParam = (ASTFormalParameter) params
193: .jjtGetChild(ndx);
194: int childNo = nextParam.skipAnnotations();
195: ASTVariableDeclaratorId id = (ASTVariableDeclaratorId) nextParam
196: .jjtGetChild(childNo + 1);
197: if (!next.getName().equals(id.getName())) {
198: return false;
199: }
200: }
201:
202: return true;
203: }
204: }
|