/*
* Copyright 2004-2005 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*/
package com.sun.mirror.util;
import com.sun.mirror.declaration.*;
import java.util.SortedSet;
import java.util.TreeSet;
/**
* A visitor for declarations that scans declarations contained within
* the given declaration in source code order. For example, when
* visiting a class, the methods, fields, constructors, and nested
* types of the class are also visited.
*
* To control the processing done on a declaration, users of this
* class pass in their own visitors for pre and post processing. The
* preprocessing visitor is called before the contained declarations
* are scanned; the postprocessing visitor is called after the
* contained declarations are scanned.
*
* @deprecated All components of this API have been superseded by the
* standardized annotation processing API. The replacement for the
* functionality of this class is {@link
* javax.lang.model.util.SimpleElementVisitor6}.
*
* @author Joseph D. Darcy
* @author Scott Seligman
* @since 1.5
*/
@Deprecated
@SuppressWarnings("deprecation")
class SourceOrderDeclScanner extends DeclarationScanner {
static class SourceOrderComparator implements java.util.Comparator<Declaration> {
SourceOrderComparator(){}
static boolean equals(Declaration d1, Declaration d2) {
return d1 == d2 || (d1 != null && d1.equals(d2));
}
private static class DeclPartialOrder extends com.sun.mirror.util.SimpleDeclarationVisitor {
private int value = 1000;
private static int staticAdjust(Declaration d) {
return d.getModifiers().contains(Modifier.STATIC)?0:1;
}
DeclPartialOrder() {}
public int getValue() { return value; }
@Override
public void visitTypeParameterDeclaration(TypeParameterDeclaration d) {value = 0;}
@Override
public void visitEnumConstantDeclaration(EnumConstantDeclaration d) {value = 1;}
@Override
public void visitClassDeclaration(ClassDeclaration d) {value = 2 + staticAdjust(d);}
@Override
public void visitInterfaceDeclaration(InterfaceDeclaration d) {value = 4;}
@Override
public void visitEnumDeclaration(EnumDeclaration d) {value = 6;}
@Override
public void visitAnnotationTypeDeclaration(AnnotationTypeDeclaration d) {value = 8;}
@Override
public void visitFieldDeclaration(FieldDeclaration d) {value = 10 + staticAdjust(d);}
@Override
public void visitConstructorDeclaration(ConstructorDeclaration d) {value = 12;}
@Override
public void visitMethodDeclaration(MethodDeclaration d) {value = 14 + staticAdjust(d);}
}
@SuppressWarnings("cast")
private int compareEqualPosition(Declaration d1, Declaration d2) {
assert
(d1.getPosition() == d2.getPosition()) || // Handles two null positions.
(d1.getPosition().file().compareTo(d2.getPosition().file()) == 0 &&
d1.getPosition().line() == d2.getPosition().line() &&
d1.getPosition().column() == d2.getPosition().column());
DeclPartialOrder dpo1 = new DeclPartialOrder();
DeclPartialOrder dpo2 = new DeclPartialOrder();
d1.accept(dpo1);
d2.accept(dpo2);
int difference = dpo1.getValue() - dpo2.getValue();
if (difference != 0)
return difference;
else {
int result = d1.getSimpleName().compareTo(d2.getSimpleName());
if (result != 0)
return result;
return (int)( Long.signum((long)System.identityHashCode(d1) -
(long)System.identityHashCode(d2)));
}
}
public int compare(Declaration d1, Declaration d2) {
if (equals(d1, d2))
return 0;
SourcePosition p1 = d1.getPosition();
SourcePosition p2 = d2.getPosition();
if (p1 == null && p2 != null)
return 1;
else if (p1 != null && p2 == null)
return -1;
else if(p1 == null && p2 == null)
return compareEqualPosition(d1, d2);
else {
assert p1 != null && p2 != null;
int fileComp = p1.file().compareTo(p2.file()) ;
if (fileComp == 0) {
long diff = (long)p1.line() - (long)p2.line();
if (diff == 0) {
diff = Long.signum((long)p1.column() - (long)p2.column());
if (diff != 0)
return (int)diff;
else {
// declarations may be two
// compiler-generated members with the
// same source position
return compareEqualPosition(d1, d2);
}
} else
return (diff<0)? -1:1;
} else
return fileComp;
}
}
}
final static java.util.Comparator<Declaration> comparator = new SourceOrderComparator();
SourceOrderDeclScanner(DeclarationVisitor pre, DeclarationVisitor post) {
super(pre, post);
}
/**
* Visits a type declaration.
*
* @param d the declaration to visit
*/
public void visitTypeDeclaration(TypeDeclaration d) {
d.accept(pre);
SortedSet<Declaration> decls = new
TreeSet<Declaration>(SourceOrderDeclScanner.comparator) ;
for(TypeParameterDeclaration tpDecl: d.getFormalTypeParameters()) {
decls.add(tpDecl);
}
for(FieldDeclaration fieldDecl: d.getFields()) {
decls.add(fieldDecl);
}
for(MethodDeclaration methodDecl: d.getMethods()) {
decls.add(methodDecl);
}
for(TypeDeclaration typeDecl: d.getNestedTypes()) {
decls.add(typeDecl);
}
for(Declaration decl: decls )
decl.accept(this);
d.accept(post);
}
/**
* Visits a class declaration.
*
* @param d the declaration to visit
*/
public void visitClassDeclaration(ClassDeclaration d) {
d.accept(pre);
SortedSet<Declaration> decls = new
TreeSet<Declaration>(SourceOrderDeclScanner.comparator) ;
for(TypeParameterDeclaration tpDecl: d.getFormalTypeParameters()) {
decls.add(tpDecl);
}
for(FieldDeclaration fieldDecl: d.getFields()) {
decls.add(fieldDecl);
}
for(MethodDeclaration methodDecl: d.getMethods()) {
decls.add(methodDecl);
}
for(TypeDeclaration typeDecl: d.getNestedTypes()) {
decls.add(typeDecl);
}
for(ConstructorDeclaration ctorDecl: d.getConstructors()) {
decls.add(ctorDecl);
}
for(Declaration decl: decls )
decl.accept(this);
d.accept(post);
}
public void visitExecutableDeclaration(ExecutableDeclaration d) {
d.accept(pre);
SortedSet<Declaration> decls = new
TreeSet<Declaration>(SourceOrderDeclScanner.comparator) ;
for(TypeParameterDeclaration tpDecl: d.getFormalTypeParameters())
decls.add(tpDecl);
for(ParameterDeclaration pDecl: d.getParameters())
decls.add(pDecl);
for(Declaration decl: decls )
decl.accept(this);
d.accept(post);
}
}