diff --git a/README.md b/README.md index d66f01b..734ec26 100644 --- a/README.md +++ b/README.md @@ -23,19 +23,21 @@ Note that the descriptor files generated from source annotations are overwritten ----- * By default the plug-in makes DS Annotation types available to all PDE Plug-in projects in the workspace. However, you must make sure they are also added to your project's "permanent" build path used by external builders outside of the workbench. There are several ways to accomplish that. E.g., -*A. Additional bundle*: Add bundle _ca.ecliptical.pde.ds.lib_ under _Automated Management of Dependencies_ in your Plug-in Manifest Editor's _Dependencies_ tab. +*A. Additional bundle*: Add bundle _ca.ecliptical.pde.ds.classpath_ under _Automated Management of Dependencies_ in your Plug-in Manifest Editor's _Dependencies_ tab. *B. Extra library*: Add the following line to your Plug-in project's build.properties file: - extra.. = platform:/plugin/ca.ecliptical.pde.ds.lib/annotations.jar + extra.. = platform:/plugin/ca.ecliptical.pde.ds.classpath/org.osgi.service.component.annotations-1.3.0.jar > Or: - jars.extra.classpath = platform:/plugin/ca.ecliptical.pde.ds.lib/annotations.jar + jars.extra.classpath = platform:/plugin/ca.ecliptical.pde.ds.classpath/org.osgi.service.component.annotations-1.3.0.jar + +or any other platform:/ URL pointing to the annotations jar file. See [PDE documentation](http://help.eclipse.org/luna/index.jsp?topic=%2Forg.eclipse.pde.doc.user%2Freference%2Fpde_feature_generating_build.htm "Feature and Plug-in Build Configuration Properties") for more details. -*C. Import package*: In your Plug-in Manifest Editor's _Dependencies_ tab import package _org.osgi.service.component.annotations_ and mark it as optional. This is the least preferred option as it unnecessarily modifies your bundle's runtime classpath (in META-INF/MANIFEST.MF). +*C. Import package*: In your Plug-in Manifest Editor's _Dependencies_ tab import package _org.osgi.service.component.annotations_ and mark it as optional. This is the least preferred option as it unnecessarily modifies your bundle's runtime classpath (in META-INF/MANIFEST.MF). Note that in this case, you need to add the correct SCR version annotation package to your target environment. ## License diff --git a/ca.ecliptical.pde.ds-feature/feature.xml b/ca.ecliptical.pde.ds-feature/feature.xml index 70eb6bd..81959ca 100644 --- a/ca.ecliptical.pde.ds-feature/feature.xml +++ b/ca.ecliptical.pde.ds-feature/feature.xml @@ -1,4 +1,4 @@ - + - - - - %description - - - - %copyright - - - - - - - - - - - - - - + --> + + + + %description + + + + %copyright + + + + + + + + + + + + diff --git a/ca.ecliptical.pde.ds.classpath/.classpath b/ca.ecliptical.pde.ds.classpath/.classpath index 64c5e31..c3a4501 100644 --- a/ca.ecliptical.pde.ds.classpath/.classpath +++ b/ca.ecliptical.pde.ds.classpath/.classpath @@ -1,5 +1,6 @@ + diff --git a/ca.ecliptical.pde.ds.classpath/META-INF/MANIFEST.MF b/ca.ecliptical.pde.ds.classpath/META-INF/MANIFEST.MF index 3058650..5dab17f 100644 --- a/ca.ecliptical.pde.ds.classpath/META-INF/MANIFEST.MF +++ b/ca.ecliptical.pde.ds.classpath/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %Bundle-Name Bundle-SymbolicName: ca.ecliptical.pde.ds.classpath;singleton:=true -Bundle-Version: 1.0.0.qualifier +Bundle-Version: 1.3.0.qualifier Bundle-Activator: ca.ecliptical.pde.ds.internal.classpath.Activator Bundle-Vendor: %Bundle-Vendor Require-Bundle: org.eclipse.core.runtime;bundle-version="[3.9.100,4.0.0)", @@ -11,4 +11,7 @@ Require-Bundle: org.eclipse.core.runtime;bundle-version="[3.9.100,4.0.0)", org.eclipse.pde.core;bundle-version="[3.9.1,3.11.0)" Bundle-RequiredExecutionEnvironment: J2SE-1.5 Bundle-ActivationPolicy: lazy -Export-Package: ca.ecliptical.pde.ds.classpath;version="1.0.0" +Export-Package: ca.ecliptical.pde.ds.classpath;version="1.0.0", + org.osgi.service.component.annotations;version="1.3.0" +Bundle-ClassPath: org.osgi.service.component.annotations-1.3.0.jar, + . diff --git a/ca.ecliptical.pde.ds.classpath/annotations.jar b/ca.ecliptical.pde.ds.classpath/annotations.jar deleted file mode 100644 index 6630de3..0000000 Binary files a/ca.ecliptical.pde.ds.classpath/annotations.jar and /dev/null differ diff --git a/ca.ecliptical.pde.ds.classpath/annotationssrc.zip b/ca.ecliptical.pde.ds.classpath/annotationssrc.zip index bde5c24..df492b4 100644 Binary files a/ca.ecliptical.pde.ds.classpath/annotationssrc.zip and b/ca.ecliptical.pde.ds.classpath/annotationssrc.zip differ diff --git a/ca.ecliptical.pde.ds.classpath/build.properties b/ca.ecliptical.pde.ds.classpath/build.properties index 91520f3..a3b05fa 100644 --- a/ca.ecliptical.pde.ds.classpath/build.properties +++ b/ca.ecliptical.pde.ds.classpath/build.properties @@ -7,4 +7,5 @@ bin.includes = META-INF/,\ annotations.jar,\ about.html,\ about_files/,\ - OSGI-INF/ + OSGI-INF/,\ + org.osgi.service.component.annotations-1.3.0.jar diff --git a/ca.ecliptical.pde.ds.classpath/org.osgi.service.component.annotations-1.3.0.jar b/ca.ecliptical.pde.ds.classpath/org.osgi.service.component.annotations-1.3.0.jar new file mode 100644 index 0000000..1461e7b Binary files /dev/null and b/ca.ecliptical.pde.ds.classpath/org.osgi.service.component.annotations-1.3.0.jar differ diff --git a/ca.ecliptical.pde.ds.classpath/src/ca/ecliptical/pde/ds/internal/classpath/DSAnnotationClasspathContributor.java b/ca.ecliptical.pde.ds.classpath/src/ca/ecliptical/pde/ds/internal/classpath/DSAnnotationClasspathContributor.java index d312758..fa1c421 100644 --- a/ca.ecliptical.pde.ds.classpath/src/ca/ecliptical/pde/ds/internal/classpath/DSAnnotationClasspathContributor.java +++ b/ca.ecliptical.pde.ds.classpath/src/ca/ecliptical/pde/ds/internal/classpath/DSAnnotationClasspathContributor.java @@ -56,7 +56,7 @@ public List getInitialEntries(BundleDescription project) { if (autoClasspath) { Bundle bundle = ctx.getBundle(); try { - URL fileURL = FileLocator.toFileURL(bundle.getEntry("annotations.jar")); //$NON-NLS-1$ + URL fileURL = FileLocator.toFileURL(bundle.getEntry("org.osgi.service.component.annotations-1.3.0.jar")); //$NON-NLS-1$ if ("file".equals(fileURL.getProtocol())) { //$NON-NLS-1$ URL srcFileURL = FileLocator.toFileURL(bundle.getEntry("annotationssrc.zip")); //$NON-NLS-1$ IPath srcPath = "file".equals(srcFileURL.getProtocol()) ? new Path(srcFileURL.getPath()) : null; //$NON-NLS-1$ diff --git a/ca.ecliptical.pde.ds.lib/META-INF/MANIFEST.MF b/ca.ecliptical.pde.ds.lib/META-INF/MANIFEST.MF index 397d3f3..b4b9457 100644 --- a/ca.ecliptical.pde.ds.lib/META-INF/MANIFEST.MF +++ b/ca.ecliptical.pde.ds.lib/META-INF/MANIFEST.MF @@ -1,10 +1,10 @@ -Manifest-Version: 1.0 -Bundle-ManifestVersion: 2 -Bundle-Name: %Bundle-Name -Bundle-SymbolicName: ca.ecliptical.pde.ds.lib -Bundle-Version: 1.0.0.v20141223-1920 -Bundle-ClassPath: annotations.jar -Bundle-Vendor: %Bundle-Vendor -Export-Package: org.osgi.service.component.annotations;version="1.2.0" -Bundle-RequiredExecutionEnvironment: J2SE-1.5 -Import-Package: org.osgi.service.component.annotations;version="[1.2.0,1.3.0)" +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %Bundle-Name +Bundle-SymbolicName: ca.ecliptical.pde.ds.lib +Bundle-Version: 1.3.1.qualifier +Bundle-ClassPath: annotations.jar +Bundle-Vendor: %Bundle-Vendor +Export-Package: org.osgi.service.component.annotations;version="1.3.0" +Bundle-RequiredExecutionEnvironment: J2SE-1.5 +Import-Package: org.osgi.service.component.annotations;version="[1.3.0,1.4.0)" diff --git a/ca.ecliptical.pde.ds.lib/annotationssrc.zip b/ca.ecliptical.pde.ds.lib/annotationssrc.zip index bde5c24..df492b4 100644 Binary files a/ca.ecliptical.pde.ds.lib/annotationssrc.zip and b/ca.ecliptical.pde.ds.lib/annotationssrc.zip differ diff --git a/ca.ecliptical.pde.ds.lib/org.osgi.service.component.annotations-1.3.0.jar b/ca.ecliptical.pde.ds.lib/org.osgi.service.component.annotations-1.3.0.jar new file mode 100644 index 0000000..1461e7b Binary files /dev/null and b/ca.ecliptical.pde.ds.lib/org.osgi.service.component.annotations-1.3.0.jar differ diff --git a/ca.ecliptical.pde.ds/META-INF/MANIFEST.MF b/ca.ecliptical.pde.ds/META-INF/MANIFEST.MF index cedfa36..1051d99 100644 --- a/ca.ecliptical.pde.ds/META-INF/MANIFEST.MF +++ b/ca.ecliptical.pde.ds/META-INF/MANIFEST.MF @@ -1,25 +1,25 @@ -Manifest-Version: 1.0 -Bundle-ManifestVersion: 2 -Bundle-Name: %Bundle-Name -Bundle-SymbolicName: ca.ecliptical.pde.ds;singleton:=true -Bundle-Version: 1.2.8.qualifier -Bundle-Activator: ca.ecliptical.pde.internal.ds.Activator -Bundle-Vendor: %Bundle-Vendor -Require-Bundle: org.eclipse.ui;bundle-version="[3.105.0,4.0.0)", - org.eclipse.core.runtime;bundle-version="[3.9.0,4.0.0)", - org.eclipse.pde.ui;bundle-version="[3.8.0,3.9.0)", - org.eclipse.jdt.core;bundle-version="[3.9.0,4.0.0)", - org.eclipse.pde.ds.core;bundle-version="[1.0.300,1.1.0)", - org.eclipse.core.resources;bundle-version="[3.8.100,4.0.0)", - org.eclipse.jface.text;bundle-version="[3.8.100,4.0.0)", - org.eclipse.ltk.core.refactoring;bundle-version="[3.6.100,4.0.0)", - org.eclipse.core.expressions;bundle-version="[3.4.501,4.0.0)", - org.eclipse.core.filebuffers;bundle-version="[3.5.300,4.0.0)", - org.eclipse.ui.ide;bundle-version="[3.9.2,4.0.0)", - org.eclipse.jdt.ui;bundle-version="[3.9.2,4.0.0)" -Bundle-RequiredExecutionEnvironment: J2SE-1.5 -Bundle-ActivationPolicy: lazy -Export-Package: ca.ecliptical.pde.internal.ds;x-internal:=true -Import-Package: ca.ecliptical.pde.ds.classpath;version="[1.0.0,2.0.0)", - org.osgi.service.component;version="[1.2.0,2.0.0)", - org.osgi.service.component.annotations;version="[1.2.0,2.0.0)" +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %Bundle-Name +Bundle-SymbolicName: ca.ecliptical.pde.ds;singleton:=true +Bundle-Version: 1.3.2.qualifier +Bundle-Activator: ca.ecliptical.pde.internal.ds.Activator +Bundle-Vendor: %Bundle-Vendor +Require-Bundle: org.eclipse.ui;bundle-version="[3.105.0,4.0.0)", + org.eclipse.core.runtime;bundle-version="[3.9.0,4.0.0)", + org.eclipse.pde.ui;bundle-version="[3.8.0,3.9.0)", + org.eclipse.jdt.core;bundle-version="[3.9.0,4.0.0)", + org.eclipse.pde.ds.core;bundle-version="[1.0.300,1.1.0)", + org.eclipse.core.resources;bundle-version="[3.8.100,4.0.0)", + org.eclipse.jface.text;bundle-version="[3.8.100,4.0.0)", + org.eclipse.ltk.core.refactoring;bundle-version="[3.6.100,4.0.0)", + org.eclipse.core.expressions;bundle-version="[3.4.501,4.0.0)", + org.eclipse.core.filebuffers;bundle-version="[3.5.300,4.0.0)", + org.eclipse.ui.ide;bundle-version="[3.9.2,4.0.0)", + org.eclipse.jdt.ui;bundle-version="[3.9.2,4.0.0)" +Bundle-RequiredExecutionEnvironment: J2SE-1.5 +Bundle-ActivationPolicy: lazy +Export-Package: ca.ecliptical.pde.internal.ds;x-internal:=true +Import-Package: ca.ecliptical.pde.ds.classpath;version="[1.0.0,2.0.0)", + org.osgi.service.component;version="[1.2.0,2.0.0)", + org.osgi.service.component.annotations;version="[1.3.0,2.0.0)" diff --git a/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/AnnotationProcessor.java b/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/AnnotationProcessor.java index 7595f54..778baba 100644 --- a/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/AnnotationProcessor.java +++ b/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/AnnotationProcessor.java @@ -1,1818 +1,2284 @@ -/******************************************************************************* - * Copyright (c) 2012, 2015 Ecliptical Software Inc. and others. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * Ecliptical Software Inc. - initial API and implementation - *******************************************************************************/ -package ca.ecliptical.pde.internal.ds; - -import java.io.BufferedReader; -import java.io.ByteArrayInputStream; -import java.io.ByteArrayOutputStream; -import java.io.IOException; -import java.io.ObjectInputStream; -import java.io.ObjectOutputStream; -import java.io.StringReader; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collection; -import java.util.Collections; -import java.util.Comparator; -import java.util.HashMap; -import java.util.HashSet; -import java.util.LinkedHashMap; -import java.util.LinkedHashSet; -import java.util.List; -import java.util.ListIterator; -import java.util.Map; -import java.util.Set; -import java.util.concurrent.CountDownLatch; -import java.util.regex.Pattern; - -import org.eclipse.core.filebuffers.FileBuffers; -import org.eclipse.core.filebuffers.ITextFileBuffer; -import org.eclipse.core.filebuffers.ITextFileBufferManager; -import org.eclipse.core.filebuffers.LocationKind; -import org.eclipse.core.resources.ICommand; -import org.eclipse.core.resources.IContainer; -import org.eclipse.core.resources.IFile; -import org.eclipse.core.resources.IFolder; -import org.eclipse.core.resources.IProject; -import org.eclipse.core.resources.IProjectDescription; -import org.eclipse.core.resources.IResource; -import org.eclipse.core.runtime.CoreException; -import org.eclipse.core.runtime.IPath; -import org.eclipse.core.runtime.IStatus; -import org.eclipse.core.runtime.Path; -import org.eclipse.core.runtime.Status; -import org.eclipse.jdt.core.ICompilationUnit; -import org.eclipse.jdt.core.IJavaElement; -import org.eclipse.jdt.core.IType; -import org.eclipse.jdt.core.compiler.BuildContext; -import org.eclipse.jdt.core.compiler.CategorizedProblem; -import org.eclipse.jdt.core.dom.AST; -import org.eclipse.jdt.core.dom.ASTNode; -import org.eclipse.jdt.core.dom.ASTRequestor; -import org.eclipse.jdt.core.dom.ASTVisitor; -import org.eclipse.jdt.core.dom.AbstractTypeDeclaration; -import org.eclipse.jdt.core.dom.Annotation; -import org.eclipse.jdt.core.dom.AnnotationTypeDeclaration; -import org.eclipse.jdt.core.dom.ArrayInitializer; -import org.eclipse.jdt.core.dom.CompilationUnit; -import org.eclipse.jdt.core.dom.EnumDeclaration; -import org.eclipse.jdt.core.dom.Expression; -import org.eclipse.jdt.core.dom.IAnnotationBinding; -import org.eclipse.jdt.core.dom.IMemberValuePairBinding; -import org.eclipse.jdt.core.dom.IMethodBinding; -import org.eclipse.jdt.core.dom.ITypeBinding; -import org.eclipse.jdt.core.dom.IVariableBinding; -import org.eclipse.jdt.core.dom.MemberValuePair; -import org.eclipse.jdt.core.dom.MethodDeclaration; -import org.eclipse.jdt.core.dom.Modifier; -import org.eclipse.jdt.core.dom.NormalAnnotation; -import org.eclipse.jdt.core.dom.SingleMemberAnnotation; -import org.eclipse.jdt.core.dom.TypeDeclaration; -import org.eclipse.jface.text.BadLocationException; -import org.eclipse.jface.text.DocumentRewriteSession; -import org.eclipse.jface.text.DocumentRewriteSessionType; -import org.eclipse.jface.text.IDocument; -import org.eclipse.jface.text.IDocumentExtension4; -import org.eclipse.jface.text.link.LinkedModeModel; -import org.eclipse.osgi.util.NLS; -import org.eclipse.pde.core.IModelChangedEvent; -import org.eclipse.pde.core.ModelChangedEvent; -import org.eclipse.pde.internal.core.project.PDEProject; -import org.eclipse.pde.internal.core.text.IDocumentAttributeNode; -import org.eclipse.pde.internal.core.text.IDocumentElementNode; -import org.eclipse.pde.internal.core.text.IDocumentObject; -import org.eclipse.pde.internal.core.text.IDocumentTextNode; -import org.eclipse.pde.internal.core.text.IModelTextChangeListener; -import org.eclipse.pde.internal.ds.core.IDSComponent; -import org.eclipse.pde.internal.ds.core.IDSConstants; -import org.eclipse.pde.internal.ds.core.IDSDocumentFactory; -import org.eclipse.pde.internal.ds.core.IDSImplementation; -import org.eclipse.pde.internal.ds.core.IDSModel; -import org.eclipse.pde.internal.ds.core.IDSObject; -import org.eclipse.pde.internal.ds.core.IDSProperties; -import org.eclipse.pde.internal.ds.core.IDSProperty; -import org.eclipse.pde.internal.ds.core.IDSProvide; -import org.eclipse.pde.internal.ds.core.IDSReference; -import org.eclipse.pde.internal.ds.core.IDSService; -import org.eclipse.pde.internal.ds.core.text.DSModel; -import org.eclipse.text.edits.MalformedTreeException; -import org.eclipse.text.edits.MultiTextEdit; -import org.eclipse.text.edits.ReplaceEdit; -import org.eclipse.text.edits.TextEdit; -import org.osgi.framework.BundleContext; -import org.osgi.framework.FrameworkUtil; -import org.osgi.framework.InvalidSyntaxException; -import org.osgi.framework.ServiceReference; -import org.osgi.service.component.ComponentContext; -import org.osgi.service.component.annotations.Activate; -import org.osgi.service.component.annotations.ConfigurationPolicy; -import org.osgi.service.component.annotations.Deactivate; -import org.osgi.service.component.annotations.Modified; -import org.osgi.service.component.annotations.Reference; -import org.osgi.service.component.annotations.ReferenceCardinality; -import org.osgi.service.component.annotations.ReferencePolicy; -import org.osgi.service.component.annotations.ReferencePolicyOption; - -@SuppressWarnings("restriction") -public class AnnotationProcessor extends ASTRequestor { - - private static final String DS_BUILDER = "org.eclipse.pde.ds.core.builder"; //$NON-NLS-1$ - - static final Debug debug = Debug.getDebug("ds-annotation-builder/processor"); //$NON-NLS-1$ - - private final ProjectContext context; - - private final Map fileMap; - - private boolean hasBuilder; - - public AnnotationProcessor(ProjectContext context, Map fileMap) { - this.context = context; - this.fileMap = fileMap; - } - - @Override - public void acceptAST(ICompilationUnit source, CompilationUnit ast) { - // determine CU key - String cuKey; - IJavaElement parent = source.getParent(); - if (parent == null) - cuKey = source.getElementName(); - else - cuKey = String.format("%s/%s", parent.getElementName().replace('.', '/'), source.getElementName()); //$NON-NLS-1$ - - context.getUnprocessed().remove(cuKey); - - ProjectState state = context.getState(); - HashMap dsKeys = new HashMap(); - HashSet problems = new HashSet(); - - ast.accept(new AnnotationVisitor(this, state, dsKeys, problems)); - - // track abandoned files (may be garbage) - Collection oldDSKeys = state.updateMappings(cuKey, dsKeys); - if (oldDSKeys != null) { - oldDSKeys.removeAll(dsKeys.values()); - context.getAbandoned().addAll(oldDSKeys); - } - - if (!problems.isEmpty()) { - char[] filename = source.getResource().getFullPath().toString().toCharArray(); - for (DSAnnotationProblem problem : problems) { - problem.setOriginatingFileName(filename); - if (problem.getSourceStart() >= 0) - problem.setSourceLineNumber(ast.getLineNumber(problem.getSourceStart())); - } - - BuildContext buildContext = fileMap.get(source); - if (buildContext != null) - buildContext.recordNewProblems(problems.toArray(new CategorizedProblem[problems.size()])); - } - } - - private void ensureDSProject(IProject project) throws CoreException { - IProjectDescription description = project.getDescription(); - ICommand[] commands = description.getBuildSpec(); - - for (ICommand command : commands) { - if (DS_BUILDER.equals(command.getBuilderName())) - return; - } - - ICommand[] newCommands = new ICommand[commands.length + 1]; - System.arraycopy(commands, 0, newCommands, 0, commands.length); - ICommand command = description.newCommand(); - command.setBuilderName(DS_BUILDER); - newCommands[newCommands.length - 1] = command; - description.setBuildSpec(newCommands); - project.setDescription(description, null); - } - - private void ensureExists(IFolder folder) throws CoreException { - if (folder.exists()) - return; - - IContainer parent = folder.getParent(); - if (parent != null && parent.getType() == IResource.FOLDER) - ensureExists((IFolder) parent); - - folder.create(true, true, null); - } - - void verifyOutputLocation(IFile file) throws CoreException { - if (hasBuilder) - return; - - hasBuilder = true; - IProject project = file.getProject(); - - IPath parentPath = file.getParent().getProjectRelativePath(); - if (!parentPath.isEmpty()) { - IFolder folder = project.getFolder(parentPath); - ensureExists(folder); - } - - try { - ensureDSProject(project); - } catch (CoreException e) { - Activator.getDefault().getLog().log(e.getStatus()); - } - } -} - -@SuppressWarnings("restriction") -class AnnotationVisitor extends ASTVisitor { - - private static final String COMPONENT_ANNOTATION = DSAnnotationCompilationParticipant.COMPONENT_ANNOTATION; - - private static final String ACTIVATE_ANNOTATION = Activate.class.getName(); - - private static final String MODIFIED_ANNOTATION = Modified.class.getName(); - - private static final String DEACTIVATE_ANNOTATION = Deactivate.class.getName(); - - private static final String REFERENCE_ANNOTATION = Reference.class.getName(); - - private static final Pattern PID_PATTERN = Pattern.compile("[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)*"); //$NON-NLS-1$ - - private static final String NAMESPACE_1_1 = IDSConstants.NAMESPACE; - - private static final String NAMESPACE_1_2 = "http://www.osgi.org/xmlns/scr/v1.2.0"; //$NON-NLS-1$ - - private static final String ATTRIBUTE_COMPONENT_CONFIGURATION_PID = "configuration-pid"; //$NON-NLS-1$ - - private static final String ATTRIBUTE_REFERENCE_POLICY_OPTION = "policy-option"; //$NON-NLS-1$ - - private static final String ATTRIBUTE_REFERENCE_UPDATED = "updated"; //$NON-NLS-1$ - - private static final String VALUE_REFERENCE_POLICY_OPTION_RELUCTANT = "reluctant"; //$NON-NLS-1$ - - private static final Set PROPERTY_TYPES = Collections.unmodifiableSet( - new HashSet( - Arrays.asList( - null, - IDSConstants.VALUE_PROPERTY_TYPE_STRING, - IDSConstants.VALUE_PROPERTY_TYPE_LONG, - IDSConstants.VALUE_PROPERTY_TYPE_DOUBLE, - IDSConstants.VALUE_PROPERTY_TYPE_FLOAT, - IDSConstants.VALUE_PROPERTY_TYPE_INTEGER, - IDSConstants.VALUE_PROPERTY_TYPE_BYTE, - IDSConstants.VALUE_PROPERTY_TYPE_CHAR, - IDSConstants.VALUE_PROPERTY_TYPE_BOOLEAN, - IDSConstants.VALUE_PROPERTY_TYPE_SHORT))); - - private static final Comparator REF_NAME_COMPARATOR = new Comparator() { - - public int compare(IDSReference o1, IDSReference o2) { - return o1.getReferenceName().compareTo(o2.getReferenceName()); - } - }; - - private static final Debug debug = AnnotationProcessor.debug; - - private final AnnotationProcessor processor; - - private final ProjectState state; - - private final ValidationErrorLevel errorLevel; - - private final ValidationErrorLevel missingUnbindMethodLevel; - - private final Map dsKeys; - - private final Set problems; - - public AnnotationVisitor(AnnotationProcessor processor, ProjectState state, Map dsKeys, Set problems) { - this.processor = processor; - this.state = state; - this.errorLevel = state.getErrorLevel(); - this.missingUnbindMethodLevel = state.getMissingUnbindMethodLevel(); - this.dsKeys = dsKeys; - this.problems = problems; - } - - @Override - public boolean visit(TypeDeclaration type) { - if (!Modifier.isPublic(type.getModifiers())) { - // non-public types cannot be (or have nested) components - if (errorLevel.isNone()) - return false; - - Annotation annotation = findComponentAnnotation(type); - if (annotation != null) - reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_notPublic, type.getName().getIdentifier()), type.getName().getIdentifier()); - - return true; - } - - Annotation annotation = findComponentAnnotation(type); - if (annotation != null) { - boolean isInterface = false; - boolean isAbstract = false; - boolean isNested = false; - boolean noDefaultConstructor = false; - if ((isInterface = type.isInterface()) - || (isAbstract = Modifier.isAbstract(type.getModifiers())) - || (isNested = (!type.isPackageMemberTypeDeclaration() && !isNestedPublicStatic(type))) - || (noDefaultConstructor = !hasDefaultConstructor(type))) { - // interfaces, abstract types, non-static/non-public nested types, or types with no default constructor cannot be components - if (errorLevel != ValidationErrorLevel.none) { - if (isInterface) - reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_interface, type.getName().getIdentifier()), type.getName().getIdentifier()); - else if (isAbstract) - reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_abstract, type.getName().getIdentifier()), type.getName().getIdentifier()); - else if (isNested) - reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_notTopLevel, type.getName().getIdentifier()), type.getName().getIdentifier()); - else if (noDefaultConstructor) - reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_noDefaultConstructor, type.getName().getIdentifier()), type.getName().getIdentifier()); - else - reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentImplementationClass, type.getName().getIdentifier()), type.getName().getIdentifier()); - } - } else { - ITypeBinding typeBinding = type.resolveBinding(); - if (typeBinding == null) { - if (debug.isDebugging()) - debug.trace(String.format("Unable to resolve binding for type: %s", type)); //$NON-NLS-1$ - } else { - IAnnotationBinding annotationBinding = annotation.resolveAnnotationBinding(); - if (annotationBinding == null) { - if (debug.isDebugging()) - debug.trace(String.format("Unable to resolve binding for annotation: %s", annotation)); //$NON-NLS-1$ - } else { - try { - processComponent(type, typeBinding, annotation, annotationBinding, problems); - } catch (CoreException e) { - Activator.getDefault().getLog().log(e.getStatus()); - } - } - } - } - } - - return true; - } - - @Override - public boolean visit(EnumDeclaration node) { - Annotation annotation = findComponentAnnotation(node); - if (annotation != null) - reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_enumeration, node.getName().getIdentifier()), node.getName().getIdentifier()); - - return false; - } - - @Override - public boolean visit(AnnotationTypeDeclaration node) { - Annotation annotation = findComponentAnnotation(node); - if (annotation != null) - reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_annotation, node.getName().getIdentifier()), node.getName().getIdentifier()); - - return true; - } - - private Annotation findComponentAnnotation(AbstractTypeDeclaration type) { - for (Object item : type.modifiers()) { - if (!(item instanceof Annotation)) - continue; - - Annotation annotation = (Annotation) item; - IAnnotationBinding annotationBinding = annotation.resolveAnnotationBinding(); - if (annotationBinding == null) { - if (debug.isDebugging()) - debug.trace(String.format("Unable to resolve binding for annotation: %s", annotation)); //$NON-NLS-1$ - - continue; - } - - if (COMPONENT_ANNOTATION.equals(annotationBinding.getAnnotationType().getQualifiedName())) - return annotation; - } - - return null; - } - - private boolean isNestedPublicStatic(AbstractTypeDeclaration type) { - if (Modifier.isStatic(type.getModifiers())) { - ASTNode parent = type.getParent(); - if (parent != null && (parent.getNodeType() == ASTNode.TYPE_DECLARATION || parent.getNodeType() == ASTNode.ANNOTATION_TYPE_DECLARATION)) { - AbstractTypeDeclaration parentType = (AbstractTypeDeclaration) parent; - if (Modifier.isPublic(parentType.getModifiers())) - return parentType.isPackageMemberTypeDeclaration() || isNestedPublicStatic(parentType); - } - } - - return false; - } - - private boolean hasDefaultConstructor(TypeDeclaration type) { - boolean hasConstructor = false; - for (MethodDeclaration method : type.getMethods()) { - if (method.isConstructor()) { - hasConstructor = true; - if (Modifier.isPublic(method.getModifiers()) && method.parameters().isEmpty()) - return true; - } - } - - return !hasConstructor; - } - - private void processComponent(TypeDeclaration type, ITypeBinding typeBinding, Annotation annotation, IAnnotationBinding annotationBinding, Collection problems) throws CoreException { - // determine component name - HashMap params = new HashMap(); - for (IMemberValuePairBinding pair : annotationBinding.getDeclaredMemberValuePairs()) { - params.put(pair.getName(), pair.getValue()); - } - - String implClass = typeBinding.getBinaryName(); - - String name = implClass; - Object value; - if ((value = params.get("name")) instanceof String) { //$NON-NLS-1$ - name = (String) value; - validateComponentName(annotation, name, problems); - } - - // set up document to edit - IPath path = new Path(state.getPath()).append(name).addFileExtension("xml"); //$NON-NLS-1$ - - String dsKey = path.toPortableString(); - dsKeys.put(implClass, dsKey); - - IProject project = typeBinding.getJavaElement().getJavaProject().getProject(); - IFile file = PDEProject.getBundleRelativeFile(project, path); - IPath filePath = file.getFullPath(); - - processor.verifyOutputLocation(file); - - // handle file move/rename - String oldPath = state.getModelFile(implClass); - if (oldPath != null && !oldPath.equals(dsKey) && !file.exists()) { - IFile oldFile = PDEProject.getBundleRelativeFile(project, Path.fromPortableString(oldPath)); - if (oldFile.exists()) { - try { - oldFile.move(file.getFullPath(), true, true, null); - } catch (CoreException e) { - Activator.getDefault().getLog().log(new Status(IStatus.WARNING, Activator.PLUGIN_ID, String.format("Unable to move model file from '%s' to '%s'.", oldPath, file.getFullPath()), e)); //$NON-NLS-1$ - } - } - } - - ITextFileBufferManager bufferManager = FileBuffers.getTextFileBufferManager(); - bufferManager.connect(filePath, LocationKind.IFILE, null); - ITextFileBuffer buffer = bufferManager.getTextFileBuffer(filePath, LocationKind.IFILE); - if (buffer.isDirty()) - buffer.commit(null, true); - - IDocument document = buffer.getDocument(); - - final DSModel dsModel = new DSModel(document, true); - dsModel.setUnderlyingResource(file); - dsModel.setCharset("UTF-8"); //$NON-NLS-1$ - dsModel.load(); - - // note: we can't use XMLTextChangeListener because it generates overlapping edits! - // thus we replace the entire content with one edit (if changed) - final IDocument fDoc = document; - dsModel.addModelChangedListener(new IModelTextChangeListener() { - - private final IDocument document = fDoc; - - private boolean changed; - - public void modelChanged(IModelChangedEvent event) { - changed = true; - } - - public TextEdit[] getTextOperations() { - if (!changed) - return new TextEdit[0]; - - String text = dsModel.getContents(); - ReplaceEdit edit = new ReplaceEdit(0, document.getLength(), text); - return new TextEdit[] { edit }; - } - - public String getReadableName(TextEdit edit) { - return null; - } - }); - - try { - processComponent(dsModel, type, typeBinding, annotation, annotationBinding, params, name, implClass, problems); - - TextEdit[] edits = dsModel.getLastTextChangeListener().getTextOperations(); - if (edits.length > 0) { - if (debug.isDebugging()) - debug.trace(String.format("Saving model: %s", file.getFullPath())); //$NON-NLS-1$ - - final MultiTextEdit edit = new MultiTextEdit(); - edit.addChildren(edits); - - if (buffer.isSynchronizationContextRequested()) { - final IDocument doc = document; - final CoreException[] ex = new CoreException[1]; - final CountDownLatch latch = new CountDownLatch(1); - bufferManager.execute(new Runnable() { - public void run() { - try { - performEdit(doc, edit); - } catch (CoreException e) { - ex[0] = e; - } - - latch.countDown(); - } - }); - - try { - latch.await(); - } catch (InterruptedException e) { - if (debug.isDebugging()) - debug.trace("Interrupted while waiting for edits to complete on display thread.", e); //$NON-NLS-1$ - } - - if (ex[0] != null) - throw ex[0]; - } else { - performEdit(document, edit); - } - - buffer.commit(null, true); - } - } finally { - dsModel.dispose(); - bufferManager.disconnect(buffer.getLocation(), LocationKind.IFILE, null); - } - } - - private void performEdit(IDocument document, TextEdit edit) throws CoreException { - DocumentRewriteSession session = null; - try { - if (document instanceof IDocumentExtension4) { - session = ((IDocumentExtension4) document).startRewriteSession(DocumentRewriteSessionType.UNRESTRICTED); - } - - LinkedModeModel.closeAllModels(document); - edit.apply(document); - } catch (MalformedTreeException e) { - throw new CoreException(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Error applying changes to component model.", e)); //$NON-NLS-1$ - } catch (BadLocationException e) { - throw new CoreException(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Error applying changes to component model.", e)); //$NON-NLS-1$ - } finally { - if (session != null) { - ((IDocumentExtension4) document).stopRewriteSession(session); - } - } - } - - private void processComponent(IDSModel model, TypeDeclaration type, ITypeBinding typeBinding, Annotation annotation, IAnnotationBinding annotationBinding, Map params, String name, String implClass, Collection problems) { - Object value; - Collection services; - if ((value = params.get("service")) instanceof Object[]) { //$NON-NLS-1$ - Object[] elements = (Object[]) value; - services = new LinkedHashSet(elements.length); - Map serviceDuplicates = errorLevel.isNone() ? null : new HashMap(); - for (int i = 0; i < elements.length; ++i) { - ITypeBinding serviceType = (ITypeBinding) elements[i]; - String serviceName = serviceType.getBinaryName(); - if (!errorLevel.isNone()) { - if (serviceDuplicates.containsKey(serviceName)) { - reportProblem(annotation, "service", i, problems, Messages.AnnotationProcessor_duplicateServiceDeclaration, serviceName); //$NON-NLS-1$ - Integer pos = serviceDuplicates.put(serviceName, null); - if (pos != null) - reportProblem(annotation, "service", pos.intValue(), problems, Messages.AnnotationProcessor_duplicateServiceDeclaration, serviceName); //$NON-NLS-1$ - } else { - serviceDuplicates.put(serviceName, i); - } - } - - services.add(serviceName); - validateComponentService(annotation, typeBinding, serviceType, i, problems); - } - } else { - ITypeBinding[] serviceTypes = typeBinding.getInterfaces(); - services = new ArrayList(serviceTypes.length); - for (int i = 0; i < serviceTypes.length; ++i) { - services.add(serviceTypes[i].getBinaryName()); - } - } - - String factory = null; - if ((value = params.get("factory")) instanceof String) { //$NON-NLS-1$ - factory = (String) value; - validateComponentFactory(annotation, factory, problems); - } - - Boolean serviceFactory = null; - if ((value = params.get("servicefactory")) instanceof Boolean) { //$NON-NLS-1$ - serviceFactory = (Boolean) value; - } - - Boolean enabled = null; - if ((value = params.get("enabled")) instanceof Boolean) { //$NON-NLS-1$ - enabled = (Boolean) value; - } - - Boolean immediate = null; - if ((value = params.get("immediate")) instanceof Boolean) { //$NON-NLS-1$ - immediate = (Boolean) value; - } - - String[] properties; - if ((value = params.get("property")) instanceof Object[]) { //$NON-NLS-1$ - Object[] elements = (Object[]) value; - ArrayList list = new ArrayList(elements.length); - for (int i = 0; i < elements.length; ++i) { - if (elements[i] instanceof String) - list.add((String) elements[i]); - } - - properties = list.toArray(new String[list.size()]); - } else { - properties = new String[0]; - } - - String[] propertyFiles; - if ((value = params.get("properties")) instanceof Object[]) { //$NON-NLS-1$ - Object[] elements = (Object[]) value; - ArrayList list = new ArrayList(elements.length); - for (int i = 0; i < elements.length; ++i) { - if (elements[i] instanceof String) - list.add((String) elements[i]); - } - - propertyFiles = list.toArray(new String[list.size()]); - validateComponentPropertyFiles(annotation, ((IType) typeBinding.getJavaElement()).getJavaProject().getProject(), propertyFiles, problems); - } else { - propertyFiles = new String[0]; - } - - String configPolicy = null; - if ((value = params.get("configurationPolicy")) instanceof IVariableBinding) { //$NON-NLS-1$ - IVariableBinding configPolicyBinding = (IVariableBinding) value; - ConfigurationPolicy configPolicyLiteral = ConfigurationPolicy.valueOf(configPolicyBinding.getName()); - if (configPolicyLiteral != null) - configPolicy = configPolicyLiteral.toString(); - } - - String configPid = null; - if ((value = params.get("configurationPid")) instanceof String) { //$NON-NLS-1$ - configPid = (String) value; - validateComponentConfigPID(annotation, configPid, problems); - } - - IDSComponent component = model.getDSComponent(); - - if (enabled == null) { - removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_ENABLED, IDSConstants.VALUE_TRUE); - } else { - component.setEnabled(enabled.booleanValue()); - } - - if (name == null) { - removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_NAME, null); - } else { - component.setAttributeName(name); - } - - if (factory == null) { - removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_FACTORY, null); - } else { - component.setFactory(factory); - } - - if (immediate == null) { - removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_IMMEDIATE, null); - } else { - component.setImmediate(immediate.booleanValue()); - } - - if (configPolicy == null) { - removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_CONFIGURATION_POLICY, IDSConstants.VALUE_CONFIGURATION_POLICY_OPTIONAL); - } else { - component.setConfigurationPolicy(configPolicy); - } - - IDSDocumentFactory dsFactory = model.getFactory(); - - IDSProperty[] propElements = component.getPropertyElements(); - if (properties.length == 0) { - removeChildren(component, Arrays.asList(propElements)); - } else { - // build up new property elements - LinkedHashMap map = new LinkedHashMap(properties.length); - for (int i = 0; i < properties.length; ++i) { - String propertyStr = properties[i]; - String[] pair = propertyStr.split("=", 2); //$NON-NLS-1$ - int colon = pair[0].indexOf(':'); - String propertyName, propertyType; - if (colon == -1) { - propertyName = pair[0]; - propertyType = null; - } else { - propertyName = pair[0].substring(0, colon); - propertyType = pair[0].substring(colon + 1); - } - - String propertyValue = pair.length > 1 ? pair[1].trim() : null; - - IDSProperty property = map.get(propertyName); - if (property == null) { - // create a new property - property = dsFactory.createProperty(); - map.put(propertyName, property); - property.setPropertyName(propertyName); - if (propertyType == null) - removeAttribute(property, IDSConstants.ATTRIBUTE_PROPERTY_TYPE, null); // just remove the attribute completely so we can detect changes when reconciling - else - property.setPropertyType(propertyType); - - property.setPropertyValue(propertyValue); - validateComponentProperty(annotation, propertyName, propertyType, propertyValue, i, problems); - } else { - // property is multi-valued - String content = property.getPropertyElemBody(); - if (content == null) { - content = property.getPropertyValue(); - property.setPropertyElemBody(content); - property.setPropertyValue(null); - } - - if (!errorLevel.isNone()) { - String expected = property.getPropertyType() == null || property.getPropertyType().length() == 0 || IDSConstants.VALUE_PROPERTY_TYPE_STRING.equals(property.getPropertyType()) ? Messages.AnnotationProcessor_stringOrEmpty : property.getPropertyType(); - String actual = propertyType == null || IDSConstants.VALUE_PROPERTY_TYPE_STRING.equals(propertyType) ? Messages.AnnotationProcessor_stringOrEmpty : propertyType; - if (!actual.equals(expected)) - reportProblem(annotation, "property", i, problems, NLS.bind(Messages.AnnotationProcessor_inconsistentComponentPropertyType, actual, expected), actual); //$NON-NLS-1$ - else - validateComponentProperty(annotation, propertyName, propertyType, propertyValue, i, problems); - } - - if (propertyValue != null) - property.setPropertyElemBody(content + "\n" + pair[1]); //$NON-NLS-1$ - } - } - - // reconcile against existing property elements - HashMap propMap = new HashMap(propElements.length); - for (IDSProperty propElement : propElements) { - propMap.put(propElement.getPropertyName(), propElement); - } - - ArrayList propList = new ArrayList(map.values()); - for (ListIterator i = propList.listIterator(); i.hasNext();) { - IDSProperty newProperty = i.next(); - IDSProperty property = propMap.remove(newProperty.getPropertyName()); - if (property == null) - continue; - - i.set(property); - - String newPropertyType = newProperty.getPropertyType(); - if (newPropertyType != null || !IDSConstants.VALUE_PROPERTY_TYPE_STRING.equals(property.getPropertyType())) - property.setPropertyType(newPropertyType); - - String newContent = newProperty.getPropertyElemBody(); - if (newContent == null) { - property.setPropertyValue(newProperty.getPropertyValue()); - IDocumentTextNode textNode = property.getTextNode(); - if (textNode != null) { - property.removeTextNode(); - if (property.isInTheModel() && property.isEditable()) { - model.fireModelChanged(new ModelChangedEvent(model, IModelChangedEvent.REMOVE, new Object[] { textNode }, null)); - } - } - } else { - removeAttribute(property, IDSConstants.ATTRIBUTE_PROPERTY_VALUE, null); - String content = property.getPropertyElemBody(); - if (content == null || !newContent.equals(normalizePropertyElemBody(content))) { - property.setPropertyElemBody(newContent); - } - } - } - - int firstPos = propElements.length == 0 - ? 0 // insert first property element as first child of component - : component.indexOf(propElements[0]); - removeChildren(component, propMap.values()); - - addOrMoveChildren(component, propList, firstPos); - } - - IDSProperties[] propFileElements = component.getPropertiesElements(); - if (propertyFiles.length == 0) { - removeChildren(component, Arrays.asList(propFileElements)); - } else { - HashMap propFileMap = new HashMap(propFileElements.length); - for (IDSProperties propFileElement : propFileElements) { - propFileMap.put(propFileElement.getEntry(), propFileElement); - } - - ArrayList propFileList = new ArrayList(propertyFiles.length); - for (String propertyFile : propertyFiles) { - IDSProperties propertiesElement = propFileMap.remove(propertyFile); - if (propertiesElement == null) { - propertiesElement = dsFactory.createProperties(); - propertiesElement.setInTheModel(false); // note: workaround for PDE bug - propertiesElement.setEntry(propertyFile); - } - - propFileList.add(propertiesElement); - } - - int firstPos; - if (propFileElements.length == 0) { - // insert first properties element after last property or (if none) first child of component - propElements = component.getPropertyElements(); - firstPos = propElements.length == 0 ? 0 : component.indexOf(propElements[propElements.length - 1]) + 1; - } else { - firstPos = component.indexOf(propFileElements[0]); - } - - removeChildren(component, propFileMap.values()); - - addOrMoveChildren(component, propFileList, firstPos); - } - - IDSService service = component.getService(); - if (services.isEmpty()) { - if (service != null) - component.removeService(service); - } else { - if (service == null) { - service = dsFactory.createService(); - - // insert service element after last property or properties element - int firstPos = Math.max(0, indexOfLastPropertyOrProperties(component)); - component.addChildNode(service, firstPos, true); - } - - IDSProvide[] provides = service.getProvidedServices(); - HashMap provideMap = new HashMap(provides.length); - for (IDSProvide provide : provides) { - provideMap.put(provide.getInterface(), provide); - } - - ArrayList provideList = new ArrayList(services.size()); - for (String serviceName : services) { - IDSProvide provide = provideMap.remove(serviceName); - if (provide == null) { - provide = dsFactory.createProvide(); - provide.setInterface(serviceName); - } - - provideList.add(provide); - } - - int firstPos = provides.length == 0 ? -1 : service.indexOf(provides[0]); - removeChildren(service, (provideMap.values())); - - addOrMoveChildren(service, provideList, firstPos); - - if (serviceFactory == null) { - removeAttribute(service, IDSConstants.ATTRIBUTE_SERVICE_FACTORY, IDSConstants.VALUE_FALSE); - } else { - service.setServiceFactory(serviceFactory.booleanValue()); - } - } - - boolean requiresV12 = false; - String activate = null; - Annotation activateAnnotation = null; - String deactivate = null; - Annotation deactivateAnnotation = null; - String modified = null; - Annotation modifiedAnnotation = null; - - ArrayList references = new ArrayList(); - HashMap referenceNames = new HashMap(); - IDSReference[] refElements = component.getReferences(); - - HashMap refMap = new HashMap(refElements.length); - for (IDSReference refElement : refElements) { - refMap.put(refElement.getReferenceBind(), refElement); - } - - for (MethodDeclaration method : type.getMethods()) { - for (Object modifier : method.modifiers()) { - if (!(modifier instanceof Annotation)) - continue; - - Annotation methodAnnotation = (Annotation) modifier; - IAnnotationBinding methodAnnotationBinding = methodAnnotation.resolveAnnotationBinding(); - if (methodAnnotationBinding == null) { - if (debug.isDebugging()) - debug.trace(String.format("Unable to resolve binding for annotation: %s", methodAnnotation)); //$NON-NLS-1$ - - continue; - } - - String annotationName = methodAnnotationBinding.getAnnotationType().getQualifiedName(); - - if (ACTIVATE_ANNOTATION.equals(annotationName)) { - if (activate == null) { - activate = method.getName().getIdentifier(); - activateAnnotation = methodAnnotation; - validateLifeCycleMethod(methodAnnotation, "activate", method, problems); //$NON-NLS-1$ - } else if (!errorLevel.isNone()) { - reportProblem(methodAnnotation, null, problems, Messages.AnnotationProcessor_duplicateActivateMethod, method.getName().getIdentifier()); - if (activateAnnotation != null) { - reportProblem(activateAnnotation, null, problems, Messages.AnnotationProcessor_duplicateActivateMethod, activate); - activateAnnotation = null; - } - } - - continue; - } - - if (DEACTIVATE_ANNOTATION.equals(annotationName)) { - if (deactivate == null) { - deactivate = method.getName().getIdentifier(); - deactivateAnnotation = methodAnnotation; - validateLifeCycleMethod(methodAnnotation, "deactivate", method, problems); //$NON-NLS-1$ - } else if (!errorLevel.isNone()) { - reportProblem(methodAnnotation, null, problems, Messages.AnnotationProcessor_duplicateDeactivateMethod, method.getName().getIdentifier()); - if (deactivateAnnotation != null) { - reportProblem(deactivateAnnotation, null, problems, Messages.AnnotationProcessor_duplicateDeactivateMethod, deactivate); - deactivateAnnotation = null; - } - } - - continue; - } - - if (MODIFIED_ANNOTATION.equals(annotationName)) { - if (modified == null) { - modified = method.getName().getIdentifier(); - modifiedAnnotation = methodAnnotation; - validateLifeCycleMethod(methodAnnotation, "modified", method, problems); //$NON-NLS-1$ - } else if (!errorLevel.isNone()) { - reportProblem(methodAnnotation, null, problems, Messages.AnnotationProcessor_duplicateModifiedMethod, method.getName().getIdentifier()); - if (modifiedAnnotation != null) { - reportProblem(modifiedAnnotation, null, problems, Messages.AnnotationProcessor_duplicateModifiedMethod, modified); - modifiedAnnotation = null; - } - } - - continue; - } - - if (REFERENCE_ANNOTATION.equals(annotationName)) { - IMethodBinding methodBinding = method.resolveBinding(); - if (methodBinding == null) { - if (debug.isDebugging()) - debug.trace(String.format("Unable to resolve binding for method: %s", method)); //$NON-NLS-1$ - } else { - requiresV12 |= processReference(method, methodBinding, methodAnnotation, methodAnnotationBinding, refMap, dsFactory, references, referenceNames, problems); - } - - continue; - } - } - } - - if (activate == null) { - // only remove activate="activate" if method not found - if (!"activate".equals(component.getActivateMethod()) //$NON-NLS-1$ - || !hasLifeCycleMethod(typeBinding, "activate")) //$NON-NLS-1$ - removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_ACTIVATE, null); //$NON-NLS-1$ - } else { - component.setActivateMethod(activate); - } - - if (deactivate == null) { - // only remove deactivate="deactivate" if method not found - if (!"deactivate".equals(component.getDeactivateMethod()) //$NON-NLS-1$ - || !hasLifeCycleMethod(typeBinding, "deactivate")) //$NON-NLS-1$ - removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_DEACTIVATE, null); //$NON-NLS-1$ - } else { - component.setDeactivateMethod(deactivate); - } - - if (modified == null) { - removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_MODIFIED, null); - } else { - component.setModifiedeMethod(modified); - } - - if (configPid == null) { - removeAttribute(component, ATTRIBUTE_COMPONENT_CONFIGURATION_PID, null); - } else { - component.setXMLAttribute(ATTRIBUTE_COMPONENT_CONFIGURATION_PID, configPid); - requiresV12 = true; - } - - if (references.isEmpty()) { - removeChildren(component, Arrays.asList(refElements)); - } else { - // references must be declared in ascending lexicographical order of their names - Collections.sort(references, REF_NAME_COMPARATOR); - - int firstPos; - if (refElements.length == 0) { - // insert first reference element after service element, or (if not present) last property or properties - service = component.getService(); - if (service == null) { - firstPos = Math.max(0, indexOfLastPropertyOrProperties(component)); - } else { - firstPos = component.indexOf(service) + 1; - } - } else { - firstPos = component.indexOf(refElements[0]); - } - - removeChildren(component, refMap.values()); - - addOrMoveChildren(component, references, firstPos); - } - - IDSImplementation impl = component.getImplementation(); - if (impl == null) { - impl = dsFactory.createImplementation(); - component.setImplementation(impl); - } - - impl.setClassName(implClass); - - String xmlns = NAMESPACE_1_1; - if ((value = params.get("xmlns")) instanceof String) { //$NON-NLS-1$ - xmlns = (String) value; - validateComponentXMLNS(annotation, xmlns, requiresV12, problems); - } else if (requiresV12) { - xmlns = NAMESPACE_1_2; - } - - component.setNamespace(xmlns); - } - - private void removeChildren(IDSObject parent, Collection children) { - for (IDocumentElementNode child : children) { - parent.removeChildNode(child, true); - } - } - - private void removeAttribute(IDSObject obj, String name, String defaultValue) { - IDocumentAttributeNode attrNode = obj.getDocumentAttribute(name); - if (attrNode != null) { - // only remove if value is not default - String value = attrNode.getAttributeValue(); - if (value != null && value.equals(defaultValue)) - return; - - obj.removeDocumentAttribute(attrNode); - if (obj.isInTheModel() && obj.isEditable()) { - obj.getModel().fireModelChanged(new ModelChangedEvent(obj.getModel(), ModelChangedEvent.REMOVE, new Object[] { attrNode }, null)); - } - } - } - - private void addOrMoveChildren(IDSObject parent, List children, int firstPos) { - for (int i = 0, n = children.size(); i < n; ++i) { - IDSObject child = children.get(i); - if (child.isInTheModel()) { - int pos = parent.indexOf(child); - if (i == 0) { - if (firstPos < pos) { - // move to first place - moveChildNode(parent, child, firstPos - pos, true); - } - } else { - int prevPos = parent.indexOf(children.get(i - 1)); - if (prevPos > pos) { - // move to previous sibling's position - moveChildNode(parent, child, prevPos - pos, true); - } - } - } else { - if (i == 0) { - if (firstPos == -1) { - parent.addChildNode(child, true); - } else { - // insert into first place - parent.addChildNode(child, firstPos, true); - } - } else { - // insert after preceding sibling - parent.addChildNode(child, parent.indexOf(children.get(i - 1)) + 1, true); - } - } - } - } - - private void moveChildNode(IDocumentObject obj, IDocumentElementNode node, int newRelativeIndex, boolean fireEvent) { - if (newRelativeIndex == 1 || newRelativeIndex == -1) { - obj.moveChildNode(node, newRelativeIndex, fireEvent); - return; - } - - // workaround for PDE's busted DocumentObject.clone() method - int currentIndex = obj.indexOf(node); - if (currentIndex == -1) - return; - - int newIndex = newRelativeIndex + currentIndex; - if (newIndex < 0 || newIndex >= obj.getChildCount()) - return; - - obj.removeChildNode(node, fireEvent); - IDocumentElementNode clone = clone(obj, node); - obj.addChildNode(clone, newIndex, fireEvent); - } - - private IDocumentElementNode clone(IDocumentObject obj, IDocumentElementNode node) { - // note: same exact impl as DocumentObject.clone() - // but here the deserialized object will actually resolve successfully - // because our classloader (with DSPropery visible) will be on top of the stack - // yay for Java serialization, *sigh* - IDocumentElementNode clone = null; - try { - // Serialize - ByteArrayOutputStream bout = new ByteArrayOutputStream(); - ObjectOutputStream out = new ObjectOutputStream(bout); - out.writeObject(node); - out.flush(); - out.close(); - byte[] bytes = bout.toByteArray(); - // Deserialize - ByteArrayInputStream bin = new ByteArrayInputStream(bytes); - ObjectInputStream in = new ObjectInputStream(bin); - clone = (IDocumentElementNode) in.readObject(); - in.close(); - // Reconnect - clone.reconnect(obj, obj.getSharedModel()); - } catch (IOException e) { - if (debug.isDebugging()) - debug.trace("Error cloning element.", e); //$NON-NLS-1$ - } catch (ClassNotFoundException e) { - if (debug.isDebugging()) - debug.trace("Error cloning element.", e); //$NON-NLS-1$ - } - - return clone; - } - - private int indexOfLastPropertyOrProperties(IDSComponent component) { - int pos = -1; - IDSProperty[] propElements = component.getPropertyElements(); - IDSProperties[] propFileElements = component.getPropertiesElements(); - if (propElements.length > 0) - pos = component.indexOf(propElements[propElements.length - 1]) + 1; - - if (propFileElements.length > 0) { - int lastPos = component.indexOf(propFileElements[propFileElements.length - 1]) + 1; - if (lastPos > pos) - pos = lastPos; - } - - return pos; - } - - private String normalizePropertyElemBody(String content) { - StringBuilder buf = new StringBuilder(content.length()); - BufferedReader reader = new BufferedReader(new StringReader(content)); - try { - String line; - while ((line = reader.readLine()) != null) { - String trimmed = line.trim(); - if (trimmed.length() == 0) - continue; - - if (buf.length() > 0) - buf.append('\n'); - - buf.append(trimmed); - } - } catch (IOException e) { - if (debug.isDebugging()) - debug.trace("Error reading property element body.", e); //$NON-NLS-1$ - } finally { - try { - reader.close(); - } catch (IOException e) { - // ignore - } - } - - return buf.toString(); - } - - private void validateComponentName(Annotation annotation, String name, Collection problems) { - if (!errorLevel.isNone() && !PID_PATTERN.matcher(name).matches()) - reportProblem(annotation, "name", problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentName, name), name); //$NON-NLS-1$ - } - - private void validateComponentService(Annotation annotation, ITypeBinding componentType, ITypeBinding serviceType, int index, Collection problems) { - if (!errorLevel.isNone() && !componentType.isAssignmentCompatible(serviceType)) - reportProblem(annotation, "service", problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentService, serviceType.getName()), serviceType.getName()); //$NON-NLS-1$ - } - - private void validateComponentFactory(Annotation annotation, String factory, Collection problems) { - if (!errorLevel.isNone() && !PID_PATTERN.matcher(factory).matches()) - reportProblem(annotation, "factory", problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentFactoryName, factory), factory); //$NON-NLS-1$ - } - - private void validateComponentProperty(Annotation annotation, String name, String type, String value, int index, Collection problems) { - if (errorLevel.isNone()) - return; - - if (PROPERTY_TYPES.contains(type)) { - if (name == null || name.trim().length() == 0) - reportProblem(annotation, "property", index, problems, Messages.AnnotationProcessor_invalidComponentProperty_nameRequired, name); //$NON-NLS-1$ - - if (value == null) { - reportProblem(annotation, "property", index, problems, Messages.AnnotationProcessor_invalidComponentProperty_valueRequired, name); //$NON-NLS-1$ - } else { - try { - if (IDSConstants.VALUE_PROPERTY_TYPE_LONG.equals(type)) - Long.valueOf(value); - else if (IDSConstants.VALUE_PROPERTY_TYPE_DOUBLE.equals(type)) - Double.valueOf(value); - else if (IDSConstants.VALUE_PROPERTY_TYPE_FLOAT.equals(type)) - Float.valueOf(value); - else if (IDSConstants.VALUE_PROPERTY_TYPE_INTEGER.equals(type) || IDSConstants.VALUE_PROPERTY_TYPE_CHAR.equals(type)) - Integer.valueOf(value); - else if (IDSConstants.VALUE_PROPERTY_TYPE_BYTE.equals(type)) - Byte.valueOf(value); - else if (IDSConstants.VALUE_PROPERTY_TYPE_SHORT.equals(type)) - Short.valueOf(value); - } catch (NumberFormatException e) { - reportProblem(annotation, "property", index, problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentPropertyValue, type, value), String.valueOf(value)); //$NON-NLS-1$ - } - } - } else { - reportProblem(annotation, "property", index, problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentPropertyType, type), String.valueOf(type)); //$NON-NLS-1$ - } - } - - private void validateComponentPropertyFiles(Annotation annotation, IProject project, String[] files, Collection problems) { - if (errorLevel.isNone()) - return; - - for (int i = 0; i < files.length; ++i) { - String file = files[i]; - IFile wsFile = PDEProject.getBundleRelativeFile(project, new Path(file)); - if (!wsFile.exists()) - reportProblem(annotation, "properties", i, problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentPropertyFile, file), file); //$NON-NLS-1$ - } - } - - private void validateComponentXMLNS(Annotation annotation, String xmlns, boolean requiresV12, Collection problems) { - if (!errorLevel.isNone() && (requiresV12 || !NAMESPACE_1_1.equals(xmlns)) && !NAMESPACE_1_2.equals(xmlns)) - reportProblem(annotation, "xmlns", problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentDescriptorNamespace, xmlns), xmlns); //$NON-NLS-1$ - } - - private void validateComponentConfigPID(Annotation annotation, String configPid, Collection problems) { - if (!errorLevel.isNone() && !PID_PATTERN.matcher(configPid).matches()) - reportProblem(annotation, "configurationPid", problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentConfigurationPid, configPid), configPid); //$NON-NLS-1$ - } - - private void validateLifeCycleMethod(Annotation annotation, String methodName, MethodDeclaration method, Collection problems) { - if (errorLevel.isNone()) - return; - - IMethodBinding methodBinding = method.resolveBinding(); - if (methodBinding == null) { - if (debug.isDebugging()) - debug.trace(String.format("Unable to resolve binding for method: %s", method)); //$NON-NLS-1$ - - return; - } - - String returnTypeName = methodBinding.getReturnType().getName(); - if (!Void.TYPE.getName().equals(returnTypeName)) - reportProblem(annotation, methodName, problems, NLS.bind(Messages.AnnotationProcessor_invalidLifeCycleMethodReturnType, methodName, returnTypeName), returnTypeName); - - ITypeBinding[] paramTypeBindings = methodBinding.getParameterTypes(); - - if (paramTypeBindings.length == 0) - // no-arg method - return; - - // every argument must be either Map, ComponentContext, or BundleContext - boolean hasMap = false; - boolean hasCompCtx = false; - boolean hasBundleCtx = false; - boolean hasInt = false; - for (ITypeBinding paramTypeBinding : paramTypeBindings) { - String paramTypeName = paramTypeBinding.getErasure().getQualifiedName(); - boolean isDuplicate = false; - - if (Map.class.getName().equals(paramTypeName)) { - if (hasMap) - isDuplicate = true; - else - hasMap = true; - } else if (ComponentContext.class.getName().equals(paramTypeName)) { - if (hasCompCtx) - isDuplicate = true; - else - hasCompCtx = true; - } else if (BundleContext.class.getName().equals(paramTypeName)) { - if (hasBundleCtx) - isDuplicate = true; - else - hasBundleCtx = true; - } else if ("deactivate".equals(methodName) //$NON-NLS-1$ - && (Integer.class.getName().equals(paramTypeName) || Integer.TYPE.getName().equals(paramTypeName))) { - if (hasInt) - isDuplicate = true; - else - hasInt = true; - } else { - reportProblem(annotation, methodName, problems, NLS.bind(Messages.AnnotationProcessor_invalidLifeCycleMethodParameterType, methodName, paramTypeName), paramTypeName); - } - - if (isDuplicate) - reportProblem(annotation, methodName, problems, NLS.bind(Messages.AnnotationProcessor_duplicateLifeCycleMethodParameterType, methodName, paramTypeName), paramTypeName); - } - } - - private boolean hasLifeCycleMethod(ITypeBinding componentClass, String methodName) { - for (IMethodBinding methodBinding : componentClass.getDeclaredMethods()) { - if (methodName.equals(methodBinding.getName()) - && Void.TYPE.getName().equals(methodBinding.getReturnType().getName())) { - ITypeBinding[] paramTypeBindings = methodBinding.getParameterTypes(); - - // every argument must be either Map, ComponentContext, or BundleContext - boolean hasMap = false; - boolean hasCompCtx = false; - boolean hasBundleCtx = false; - boolean hasInt = false; - boolean isInvalid = false; - for (ITypeBinding paramTypeBinding : paramTypeBindings) { - String paramTypeName = paramTypeBinding.getErasure().getQualifiedName(); - - if (Map.class.getName().equals(paramTypeName)) { - if (hasMap) - isInvalid = true; - else - hasMap = true; - } else if (ComponentContext.class.getName().equals(paramTypeName)) { - if (hasCompCtx) - isInvalid = true; - else - hasCompCtx = true; - } else if (BundleContext.class.getName().equals(paramTypeName)) { - if (hasBundleCtx) - isInvalid = true; - else - hasBundleCtx = true; - } else if ("deactivate".equals(methodName) //$NON-NLS-1$ - && (Integer.class.getName().equals(paramTypeName) || Integer.TYPE.getName().equals(paramTypeName))) { - if (hasInt) - isInvalid = true; - else - hasInt = true; - } else { - isInvalid = true; - } - - if (isInvalid) - break; - } - - if (!isInvalid) - return true; - } - } - - return false; - } - - private boolean processReference(MethodDeclaration method, IMethodBinding methodBinding, Annotation annotation, IAnnotationBinding annotationBinding, Map refMap, IDSDocumentFactory factory, Collection collector, Map names, Collection problems) { - HashMap params = new HashMap(); - for (IMemberValuePairBinding pair : annotationBinding.getDeclaredMemberValuePairs()) { - params.put(pair.getName(), pair.getValue()); - } - - ITypeBinding[] argTypes = methodBinding.getParameterTypes(); - - ITypeBinding serviceType; - Object value; - if ((value = params.get("service")) instanceof ITypeBinding) { //$NON-NLS-1$ - serviceType = (ITypeBinding) value; - if (!errorLevel.isNone() && argTypes.length > 0) { - ITypeBinding[] typeArgs; - if (!(ServiceReference.class.getName().equals(argTypes[0].getErasure().getQualifiedName()) - && ((typeArgs = argTypes[0].getTypeArguments()).length == 0 || serviceType.isAssignmentCompatible(typeArgs[0]))) - && !serviceType.isAssignmentCompatible(argTypes[0])) - reportProblem(annotation, "service", problems, NLS.bind(Messages.AnnotationProcessor_invalidReferenceService, argTypes[0].getName(), serviceType.getName()), serviceType.getName()); //$NON-NLS-1$ - } - } else if (argTypes.length > 0) { - if (ServiceReference.class.getName().equals(argTypes[0].getErasure().getQualifiedName())) { - ITypeBinding[] typeArgs = argTypes[0].getTypeArguments(); - if (typeArgs.length > 0) - serviceType = typeArgs[0]; - else - serviceType = null; - } else { - serviceType = argTypes[0].isPrimitive() ? getObjectType(method.getAST(), argTypes[0]) : argTypes[0]; - } - } else { - serviceType = null; - } - - if (serviceType == null) { - reportProblem(annotation, null, problems, Messages.AnnotationProcessor_invalidReferenceServiceUnknown); - - serviceType = method.getAST().resolveWellKnownType(Object.class.getName()); - } - - validateReferenceBindMethod(annotation, serviceType, methodBinding, problems); - - String service = serviceType == null ? null : serviceType.getBinaryName(); - - String methodName = methodBinding.getName(); - String name; - if ((value = params.get("name")) instanceof String) { //$NON-NLS-1$ - name = (String) value; - } else if (methodName.startsWith("bind")) { //$NON-NLS-1$ - name = methodName.substring("bind".length()); //$NON-NLS-1$ - } else if (methodName.startsWith("set")) { //$NON-NLS-1$ - name = methodName.substring("set".length()); //$NON-NLS-1$ - } else if (methodName.startsWith("add")) { //$NON-NLS-1$ - name = methodName.substring("add".length()); //$NON-NLS-1$ - } else { - name = methodName; - } - - if (!errorLevel.isNone()) { - if (names.containsKey(name)) { - reportProblem(annotation, "name", problems, NLS.bind(Messages.AnnotationProcessor_duplicateReferenceName, name), name); //$NON-NLS-1$ - Annotation duplicate = names.put(name, null); - if (duplicate != null) - reportProblem(duplicate, "name", problems, NLS.bind(Messages.AnnotationProcessor_duplicateReferenceName, name), name); //$NON-NLS-1$ - } else { - names.put(name, annotation); - } - } - - String cardinality = null; - if ((value = params.get("cardinality")) instanceof IVariableBinding) { //$NON-NLS-1$ - IVariableBinding cardinalityBinding = (IVariableBinding) value; - ReferenceCardinality cardinalityLiteral = ReferenceCardinality.valueOf(cardinalityBinding.getName()); - if (cardinalityLiteral != null) - cardinality = cardinalityLiteral.toString(); - } - - String policy = null; - if ((value = params.get("policy")) instanceof IVariableBinding) { //$NON-NLS-1$ - IVariableBinding policyBinding = (IVariableBinding) value; - ReferencePolicy policyLiteral = ReferencePolicy.valueOf(policyBinding.getName()); - if (policyLiteral != null) - policy = policyLiteral.toString(); - } - - String target = null; - if ((value = params.get("target")) instanceof String) { //$NON-NLS-1$ - target = (String) value; - validateReferenceTarget(annotation, target, problems); - } - - String unbind; - if ((value = params.get("unbind")) instanceof String) { //$NON-NLS-1$ - String unbindValue = (String) value; - if ("-".equals(unbindValue)) { //$NON-NLS-1$ - unbind = null; - } else { - unbind = unbindValue; - if (!errorLevel.isNone()) { - IMethodBinding unbindMethod = findUnbindMethod(methodBinding.getDeclaringClass(), serviceType, unbind, true); - if (unbindMethod == null) - reportProblem(annotation, "unbind", problems, NLS.bind(Messages.AnnotationProcessor_invalidReferenceUnbind, unbind), unbind); //$NON-NLS-1$ - } - } - } else { - String unbindCandidate; - if (methodName.startsWith("add")) { //$NON-NLS-1$ - unbindCandidate = "remove" + methodName.substring("add".length()); //$NON-NLS-1$ //$NON-NLS-2$ - } else { - unbindCandidate = "un" + methodName; //$NON-NLS-1$ - } - - IMethodBinding unbindMethod = findUnbindMethod(methodBinding.getDeclaringClass(), serviceType, unbindCandidate, false); - if (unbindMethod == null) { - unbind = null; - reportProblem(annotation, null, missingUnbindMethodLevel, problems, NLS.bind(Messages.AnnotationProcessor_noImplicitReferenceUnbind, unbindCandidate), unbindCandidate); - } else { - unbind = unbindMethod.getName(); - } - } - - String policyOption = null; - if ((value = params.get("policyOption")) instanceof IVariableBinding) { //$NON-NLS-1$ - IVariableBinding policyOptionBinding = (IVariableBinding) value; - ReferencePolicyOption policyOptionLiteral = ReferencePolicyOption.valueOf(policyOptionBinding.getName()); - if (policyOptionLiteral != null) { - policyOption = policyOptionLiteral.toString(); - } - } - - String updated; - if ((value = params.get(ATTRIBUTE_REFERENCE_UPDATED)) instanceof String) { //$NON-NLS-1$ - String updatedValue = (String) value; - if ("-".equals(updatedValue)) { //$NON-NLS-1$ - updated = null; - } else { - updated = updatedValue; - if (!errorLevel.isNone()) { - IMethodBinding updatedMethod = findUpdatedMethod(methodBinding.getDeclaringClass(), updated, true); - if (updatedMethod == null) - reportProblem(annotation, ATTRIBUTE_REFERENCE_UPDATED, problems, NLS.bind(Messages.AnnotationProcessor_invalidReferenceUpdated, updated), updated); //$NON-NLS-1$ - } - } - } else { - String updatedCandidate; - if (methodName.startsWith("bind")) { //$NON-NLS-1$ - updatedCandidate = ATTRIBUTE_REFERENCE_UPDATED + methodName.substring("bind".length()); //$NON-NLS-1$ //$NON-NLS-2$ - } else if (methodName.startsWith("set")) { //$NON-NLS-1$ - updatedCandidate = ATTRIBUTE_REFERENCE_UPDATED + methodName.substring("set".length()); //$NON-NLS-1$ //$NON-NLS-2$ - } else if (methodName.startsWith("add")) { //$NON-NLS-1$ - updatedCandidate = ATTRIBUTE_REFERENCE_UPDATED + methodName.substring("add".length()); //$NON-NLS-1$ //$NON-NLS-2$ - } else { - updatedCandidate = ATTRIBUTE_REFERENCE_UPDATED + methodName; //$NON-NLS-1$ - } - - IMethodBinding updatedMethod = findUpdatedMethod(methodBinding.getDeclaringClass(), updatedCandidate, false); - if (updatedMethod == null) - updated = null; - else - updated = updatedMethod.getName(); - } - - IDSReference reference = refMap.remove(methodName); - if (reference == null) { - reference = factory.createReference(); - } - - collector.add(reference); - - reference.setReferenceBind(methodName); - - if (name == null) { - removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_NAME, null); - } else { - reference.setReferenceName(name); - } - - if (service == null) { - removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_INTERFACE, null); - } else { - reference.setReferenceInterface(service); - } - - if (cardinality == null) { - removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_CARDINALITY, IDSConstants.VALUE_REFERENCE_CARDINALITY_ONE_ONE); - } else { - reference.setReferenceCardinality(cardinality); - } - - if (policy == null) { - removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_POLICY, IDSConstants.VALUE_REFERENCE_POLICY_STATIC); - } else { - reference.setReferencePolicy(policy); - } - - if (target == null) { - removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_TARGET, null); - } else { - reference.setReferenceTarget(target); - } - - if (unbind == null) { - removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_UNBIND, null); - } else { - reference.setReferenceUnbind(unbind); - } - - if (policyOption == null) { - removeAttribute(reference, ATTRIBUTE_REFERENCE_POLICY_OPTION, VALUE_REFERENCE_POLICY_OPTION_RELUCTANT); - } else { - reference.setXMLAttribute(ATTRIBUTE_REFERENCE_POLICY_OPTION, policyOption); - } - - if (updated == null) { - removeAttribute(reference, ATTRIBUTE_REFERENCE_UPDATED, null); - } else { - reference.setXMLAttribute(ATTRIBUTE_REFERENCE_UPDATED, updated); - } - - return reference.getDocumentAttribute(ATTRIBUTE_REFERENCE_POLICY_OPTION) != null - || reference.getDocumentAttribute(ATTRIBUTE_REFERENCE_UPDATED) != null; - } - - private ITypeBinding getObjectType(AST ast, ITypeBinding primitive) { - if (Boolean.TYPE.getName().equals(primitive.getName())) - return ast.resolveWellKnownType(Boolean.class.getName()); - - if (Byte.TYPE.getName().equals(primitive.getName())) - return ast.resolveWellKnownType(Byte.class.getName()); - - if (Character.TYPE.getName().equals(primitive.getName())) - return ast.resolveWellKnownType(Character.class.getName()); - - if (Double.TYPE.getName().equals(primitive.getName())) - return ast.resolveWellKnownType(Double.class.getName()); - - if (Float.TYPE.getName().equals(primitive.getName())) - return ast.resolveWellKnownType(Float.class.getName()); - - if (Integer.TYPE.getName().equals(primitive.getName())) - return ast.resolveWellKnownType(Integer.class.getName()); - - if (Long.TYPE.getName().equals(primitive.getName())) - return ast.resolveWellKnownType(Long.class.getName()); - - if (Short.TYPE.getName().equals(primitive.getName())) - return ast.resolveWellKnownType(Short.class.getName()); - - return null; - } - - private void validateReferenceBindMethod(Annotation annotation, ITypeBinding serviceType, IMethodBinding methodBinding, Collection problems) { - if (errorLevel.isNone()) - return; - - String returnTypeName = methodBinding.getReturnType().getName(); - if (!Void.TYPE.getName().equals(returnTypeName)) - reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidBindMethodReturnType, returnTypeName), returnTypeName); - - ITypeBinding[] paramTypeBindings = methodBinding.getParameterTypes(); - if (!(paramTypeBindings.length == 1 && (ServiceReference.class.getName().equals(paramTypeBindings[0].getErasure().getQualifiedName()) || serviceType == null || serviceType.isAssignmentCompatible(paramTypeBindings[0]))) - && !(paramTypeBindings.length == 2 && (serviceType == null || serviceType.isAssignmentCompatible(paramTypeBindings[0])) && Map.class.getName().equals(paramTypeBindings[1].getErasure().getQualifiedName()))) { - String[] params = new String[paramTypeBindings.length]; - StringBuilder buf = new StringBuilder(64); - buf.append('('); - for (int i = 0; i < params.length; ++i) { - params[i] = paramTypeBindings[i].getName(); - if (buf.length() > 1) - buf.append(", "); //$NON-NLS-1$ - - buf.append(params[i]); - } - - buf.append(')'); - reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidBindMethodParameters, buf, serviceType == null ? Messages.AnnotationProcessor_unknownServiceTypeLabel : serviceType.getName()), params); - } - } - - private void validateReferenceTarget(Annotation annotation, String target, Collection problems) { - if (errorLevel.isNone()) - return; - - try { - FrameworkUtil.createFilter(target); - } catch (InvalidSyntaxException e) { - String msg = e.getMessage(); - String suffix = ": " + e.getFilter(); //$NON-NLS-1$ - if (msg.endsWith(suffix)) - msg = msg.substring(0, msg.length() - suffix.length()); - - reportProblem(annotation, "target", problems, msg, target); //$NON-NLS-1$ - } - } - - private IMethodBinding findUnbindMethod(ITypeBinding componentClass, ITypeBinding serviceType, String name, boolean recurse) { - ITypeBinding testedClass = componentClass; - - IMethodBinding candidate = null; - int priority = 0; - // priority: - // 0: , Map - // 1: , Map - // 2: - // 3: - do { - for (IMethodBinding declaredMethod : testedClass.getDeclaredMethods()) { - if (name.equals(declaredMethod.getName()) - && Void.TYPE.getName().equals(declaredMethod.getReturnType().getName()) - && (testedClass == componentClass - || Modifier.isPublic(declaredMethod.getModifiers()) - || Modifier.isProtected(declaredMethod.getModifiers()) - || (!Modifier.isPrivate(declaredMethod.getModifiers()) - && testedClass.getPackage().isEqualTo(componentClass.getPackage())))) { - ITypeBinding[] paramTypes = declaredMethod.getParameterTypes(); - if (paramTypes.length == 1) { - if (ServiceReference.class.getName().equals(paramTypes[0].getErasure().getQualifiedName())) - // we have the winner - return declaredMethod; - - if (priority < 3 && serviceType != null && serviceType.isEqualTo(paramTypes[0])) - priority = 3; - else if (priority < 2 && serviceType != null && serviceType.isAssignmentCompatible(paramTypes[0])) - priority = 2; - else - continue; - - // we have a (better) candidate - candidate = declaredMethod; - } else if (paramTypes.length == 2) { - if (priority < 1 - && serviceType != null && serviceType.isEqualTo(paramTypes[0]) - && Map.class.getName().equals(paramTypes[1].getErasure().getQualifiedName())) - priority = 1; - else if (candidate != null - || !(serviceType != null && serviceType.isAssignmentCompatible(paramTypes[0])) - || !Map.class.getName().equals(paramTypes[1].getErasure().getQualifiedName())) - continue; - - // we have a candidate - candidate = declaredMethod; - } - } - } - } while (recurse && (testedClass = testedClass.getSuperclass()) != null); - - return candidate; - } - - private IMethodBinding findUpdatedMethod(ITypeBinding componentClass, String name, boolean recurse) { - ITypeBinding testedClass = componentClass; - - IMethodBinding candidate = null; - do { - for (IMethodBinding declaredMethod : testedClass.getDeclaredMethods()) { - if (name.equals(declaredMethod.getName()) - && Void.TYPE.getName().equals(declaredMethod.getReturnType().getName()) - && (testedClass == componentClass - || Modifier.isPublic(declaredMethod.getModifiers()) - || Modifier.isProtected(declaredMethod.getModifiers()) - || (!Modifier.isPrivate(declaredMethod.getModifiers()) - && testedClass.getPackage().isEqualTo(componentClass.getPackage())))) { - ITypeBinding[] paramTypes = declaredMethod.getParameterTypes(); - if (paramTypes.length == 1) { - if (ServiceReference.class.getName().equals(paramTypes[0].getErasure().getQualifiedName())) - // we have the winner - return declaredMethod; - - if (candidate == null && Map.class.getName().equals(paramTypes[0].getErasure().getQualifiedName())) { - // we have a candidate - candidate = declaredMethod; - } - } - } - } - } while (recurse && (testedClass = testedClass.getSuperclass()) != null); - - return candidate; - } - - private void reportProblem(Annotation annotation, String member, Collection problems, String message, String... args) { - reportProblem(annotation, member, -1, problems, message, args); - } - - private void reportProblem(Annotation annotation, String member, ValidationErrorLevel errorLevel, Collection problems, String message, String... args) { - reportProblem(annotation, member, -1, errorLevel, problems, message, args); - } - - private void reportProblem(Annotation annotation, String member, int valueIndex, Collection problems, String message, String... args) { - reportProblem(annotation, member, valueIndex, errorLevel, problems, message, args); - } - - private void reportProblem(Annotation annotation, String member, int valueIndex, ValidationErrorLevel errorLevel, Collection problems, String message, String... args) { - if (errorLevel.isNone()) - return; - - Expression memberValue = annotation; - if (annotation.isNormalAnnotation() && member != null) { - NormalAnnotation na = (NormalAnnotation) annotation; - for (Object value : na.values()) { - MemberValuePair pair = (MemberValuePair) value; - if (member.equals(pair.getName().getIdentifier())) { - memberValue = pair.getValue(); - break; - } - } - } else if (annotation.isSingleMemberAnnotation()) { - SingleMemberAnnotation sma = (SingleMemberAnnotation) annotation; - memberValue = sma.getValue(); - } - - int start = memberValue.getStartPosition(); - int length = memberValue.getLength(); - - if (valueIndex >= 0 && memberValue instanceof ArrayInitializer) { - ArrayInitializer ai = (ArrayInitializer) memberValue; - if (valueIndex < ai.expressions().size()) { - Expression element = (Expression) ai.expressions().get(valueIndex); - start = element.getStartPosition(); - length = element.getLength(); - } - } - - if (start >= 0) { - DSAnnotationProblem problem = new DSAnnotationProblem(errorLevel.isError(), message, args); - problem.setSourceStart(start); - problem.setSourceEnd(start + length - 1); - problems.add(problem); - } - } +/******************************************************************************* + * Copyright (c) 2012, 2015 Ecliptical Software Inc. and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Ecliptical Software Inc. - initial API and implementation + *******************************************************************************/ +package ca.ecliptical.pde.internal.ds; + +import java.io.BufferedReader; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.ObjectInputStream; +import java.io.ObjectOutputStream; +import java.io.StringReader; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.Comparator; +import java.util.EnumSet; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.ListIterator; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CountDownLatch; +import java.util.regex.Pattern; + +import org.eclipse.core.filebuffers.FileBuffers; +import org.eclipse.core.filebuffers.ITextFileBuffer; +import org.eclipse.core.filebuffers.ITextFileBufferManager; +import org.eclipse.core.filebuffers.LocationKind; +import org.eclipse.core.resources.ICommand; +import org.eclipse.core.resources.IContainer; +import org.eclipse.core.resources.IFile; +import org.eclipse.core.resources.IFolder; +import org.eclipse.core.resources.IProject; +import org.eclipse.core.resources.IProjectDescription; +import org.eclipse.core.resources.IResource; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IPath; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.NullProgressMonitor; +import org.eclipse.core.runtime.Path; +import org.eclipse.core.runtime.Status; +import org.eclipse.jdt.core.ICompilationUnit; +import org.eclipse.jdt.core.IJavaElement; +import org.eclipse.jdt.core.IType; +import org.eclipse.jdt.core.ITypeHierarchy; +import org.eclipse.jdt.core.compiler.BuildContext; +import org.eclipse.jdt.core.compiler.CategorizedProblem; +import org.eclipse.jdt.core.dom.AST; +import org.eclipse.jdt.core.dom.ASTNode; +import org.eclipse.jdt.core.dom.ASTRequestor; +import org.eclipse.jdt.core.dom.ASTVisitor; +import org.eclipse.jdt.core.dom.AbstractTypeDeclaration; +import org.eclipse.jdt.core.dom.Annotation; +import org.eclipse.jdt.core.dom.AnnotationTypeDeclaration; +import org.eclipse.jdt.core.dom.ArrayInitializer; +import org.eclipse.jdt.core.dom.CompilationUnit; +import org.eclipse.jdt.core.dom.EnumDeclaration; +import org.eclipse.jdt.core.dom.Expression; +import org.eclipse.jdt.core.dom.FieldDeclaration; +import org.eclipse.jdt.core.dom.IAnnotationBinding; +import org.eclipse.jdt.core.dom.IMemberValuePairBinding; +import org.eclipse.jdt.core.dom.IMethodBinding; +import org.eclipse.jdt.core.dom.ITypeBinding; +import org.eclipse.jdt.core.dom.IVariableBinding; +import org.eclipse.jdt.core.dom.MemberValuePair; +import org.eclipse.jdt.core.dom.MethodDeclaration; +import org.eclipse.jdt.core.dom.Modifier; +import org.eclipse.jdt.core.dom.NormalAnnotation; +import org.eclipse.jdt.core.dom.ParameterizedType; +import org.eclipse.jdt.core.dom.SingleMemberAnnotation; +import org.eclipse.jdt.core.dom.Type; +import org.eclipse.jdt.core.dom.TypeDeclaration; +import org.eclipse.jdt.core.dom.VariableDeclarationFragment; +import org.eclipse.jface.text.BadLocationException; +import org.eclipse.jface.text.DocumentRewriteSession; +import org.eclipse.jface.text.DocumentRewriteSessionType; +import org.eclipse.jface.text.IDocument; +import org.eclipse.jface.text.IDocumentExtension4; +import org.eclipse.jface.text.link.LinkedModeModel; +import org.eclipse.osgi.util.NLS; +import org.eclipse.pde.core.IModelChangedEvent; +import org.eclipse.pde.core.ModelChangedEvent; +import org.eclipse.pde.internal.core.project.PDEProject; +import org.eclipse.pde.internal.core.text.IDocumentAttributeNode; +import org.eclipse.pde.internal.core.text.IDocumentElementNode; +import org.eclipse.pde.internal.core.text.IDocumentObject; +import org.eclipse.pde.internal.core.text.IDocumentTextNode; +import org.eclipse.pde.internal.core.text.IModelTextChangeListener; +import org.eclipse.pde.internal.ds.core.IDSComponent; +import org.eclipse.pde.internal.ds.core.IDSConstants; +import org.eclipse.pde.internal.ds.core.IDSDocumentFactory; +import org.eclipse.pde.internal.ds.core.IDSImplementation; +import org.eclipse.pde.internal.ds.core.IDSModel; +import org.eclipse.pde.internal.ds.core.IDSObject; +import org.eclipse.pde.internal.ds.core.IDSProperties; +import org.eclipse.pde.internal.ds.core.IDSProperty; +import org.eclipse.pde.internal.ds.core.IDSProvide; +import org.eclipse.pde.internal.ds.core.IDSReference; +import org.eclipse.pde.internal.ds.core.IDSService; +import org.eclipse.pde.internal.ds.core.text.DSModel; +import org.eclipse.text.edits.MalformedTreeException; +import org.eclipse.text.edits.MultiTextEdit; +import org.eclipse.text.edits.ReplaceEdit; +import org.eclipse.text.edits.TextEdit; +import org.osgi.framework.BundleContext; +import org.osgi.framework.FrameworkUtil; +import org.osgi.framework.InvalidSyntaxException; +import org.osgi.framework.ServiceReference; +import org.osgi.service.component.ComponentContext; +import org.osgi.service.component.annotations.Activate; +import org.osgi.service.component.annotations.ConfigurationPolicy; +import org.osgi.service.component.annotations.Deactivate; +import org.osgi.service.component.annotations.FieldOption; +import org.osgi.service.component.annotations.Modified; +import org.osgi.service.component.annotations.Reference; +import org.osgi.service.component.annotations.ReferenceCardinality; +import org.osgi.service.component.annotations.ReferencePolicy; +import org.osgi.service.component.annotations.ReferencePolicyOption; +import org.osgi.service.component.annotations.ReferenceScope; +import org.osgi.service.component.annotations.ServiceScope; + +@SuppressWarnings("restriction") +public class AnnotationProcessor extends ASTRequestor { + + private static final String DS_BUILDER = "org.eclipse.pde.ds.core.builder"; //$NON-NLS-1$ + + static final Debug debug = Debug.getDebug("ds-annotation-builder/processor"); //$NON-NLS-1$ + + private final ProjectContext context; + + private final Map fileMap; + + private boolean hasBuilder; + + public AnnotationProcessor(ProjectContext context, Map fileMap) { + this.context = context; + this.fileMap = fileMap; + } + + @Override + public void acceptAST(ICompilationUnit source, CompilationUnit ast) { + // determine CU key + String cuKey; + IJavaElement parent = source.getParent(); + if (parent == null) + cuKey = source.getElementName(); + else + cuKey = String.format("%s/%s", parent.getElementName().replace('.', '/'), source.getElementName()); //$NON-NLS-1$ + + context.getUnprocessed().remove(cuKey); + + ProjectState state = context.getState(); + HashMap dsKeys = new HashMap(); + HashSet problems = new HashSet(); + + ast.accept(new AnnotationVisitor(this, state, dsKeys, problems)); + + // track abandoned files (may be garbage) + Collection oldDSKeys = state.updateMappings(cuKey, dsKeys); + if (oldDSKeys != null) { + oldDSKeys.removeAll(dsKeys.values()); + context.getAbandoned().addAll(oldDSKeys); + } + + if (!problems.isEmpty()) { + // Remap the problems by compilation unit. We may have gotten problems from various + // sources and the problems should be shown with the correct file. + Map> remapped = new HashMap>(); + for (DSAnnotationProblem p : problems) { + List thisUnit = remapped.get(p.getUnit()); + if (thisUnit == null) { + thisUnit = new ArrayList(); + remapped.put(p.getUnit(), thisUnit); + } + thisUnit.add(p); + } + // Process the problems per file/compilation unit. + for (Map.Entry> entry : remapped.entrySet()) { + ICompilationUnit iu = (ICompilationUnit) entry.getKey().getJavaElement(); + char[] filename = iu.getResource().getFullPath().toString().toCharArray(); + List thisProblems = entry.getValue(); + for (DSAnnotationProblem problem : thisProblems) { + problem.setOriginatingFileName(filename); + if (problem.getSourceStart() >= 0) + problem.setSourceLineNumber(entry.getKey().getLineNumber(problem.getSourceStart())); + } + BuildContext buildContext = fileMap.get(iu); + // And show the errors/warnings. + if (buildContext != null) + buildContext.recordNewProblems(thisProblems.toArray(new CategorizedProblem[thisProblems.size()])); + } + } + } + + private void ensureDSProject(IProject project) throws CoreException { + IProjectDescription description = project.getDescription(); + ICommand[] commands = description.getBuildSpec(); + + for (ICommand command : commands) { + if (DS_BUILDER.equals(command.getBuilderName())) + return; + } + + ICommand[] newCommands = new ICommand[commands.length + 1]; + System.arraycopy(commands, 0, newCommands, 0, commands.length); + ICommand command = description.newCommand(); + command.setBuilderName(DS_BUILDER); + newCommands[newCommands.length - 1] = command; + description.setBuildSpec(newCommands); + project.setDescription(description, null); + } + + private void ensureExists(IFolder folder) throws CoreException { + if (folder.exists()) + return; + + IContainer parent = folder.getParent(); + if (parent != null && parent.getType() == IResource.FOLDER) + ensureExists((IFolder) parent); + + folder.create(true, true, null); + } + + void verifyOutputLocation(IFile file) throws CoreException { + if (hasBuilder) + return; + + hasBuilder = true; + IProject project = file.getProject(); + + IPath parentPath = file.getParent().getProjectRelativePath(); + if (!parentPath.isEmpty()) { + IFolder folder = project.getFolder(parentPath); + ensureExists(folder); + } + + try { + ensureDSProject(project); + } catch (CoreException e) { + Activator.getDefault().getLog().log(e.getStatus()); + } + } +} + +@SuppressWarnings("restriction") +class AnnotationVisitor extends ASTVisitor { + + private static final String COMPONENT_ANNOTATION = DSAnnotationCompilationParticipant.COMPONENT_ANNOTATION; + + private static final String ACTIVATE_ANNOTATION = Activate.class.getName(); + + private static final String MODIFIED_ANNOTATION = Modified.class.getName(); + + private static final String DEACTIVATE_ANNOTATION = Deactivate.class.getName(); + + private static final String REFERENCE_ANNOTATION = Reference.class.getName(); + + private static final Pattern PID_PATTERN = Pattern.compile("[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)*"); //$NON-NLS-1$ + + private static final String NAMESPACE_1_1 = IDSConstants.NAMESPACE; + + private static final String NAMESPACE_1_2 = "http://www.osgi.org/xmlns/scr/v1.2.0"; //$NON-NLS-1$ + + private static final String NAMESPACE_1_3 = "http://www.osgi.org/xmlns/scr/v1.3.0"; //$NON_NLS-1$ + + private static final String ATTRIBUTE_COMPONENT_CONFIGURATION_PID = "configuration-pid"; //$NON-NLS-1$ + + private static final String ATTRIBUTE_REFERENCE_POLICY_OPTION = "policy-option"; //$NON-NLS-1$ + + private static final String ATTRIBUTE_REFERENCE_UPDATED = "updated"; //$NON-NLS-1$ + + private static final String VALUE_REFERENCE_POLICY_OPTION_RELUCTANT = "reluctant"; //$NON-NLS-1$ + + private static final Set PROPERTY_TYPES = Collections.unmodifiableSet( + new HashSet( + Arrays.asList( + null, + IDSConstants.VALUE_PROPERTY_TYPE_STRING, + IDSConstants.VALUE_PROPERTY_TYPE_LONG, + IDSConstants.VALUE_PROPERTY_TYPE_DOUBLE, + IDSConstants.VALUE_PROPERTY_TYPE_FLOAT, + IDSConstants.VALUE_PROPERTY_TYPE_INTEGER, + IDSConstants.VALUE_PROPERTY_TYPE_BYTE, + IDSConstants.VALUE_PROPERTY_TYPE_CHAR, + IDSConstants.VALUE_PROPERTY_TYPE_BOOLEAN, + IDSConstants.VALUE_PROPERTY_TYPE_SHORT))); + + private static final Comparator REF_NAME_COMPARATOR = new Comparator() { + + public int compare(IDSReference o1, IDSReference o2) { + return o1.getReferenceName().compareTo(o2.getReferenceName()); + } + }; + + private static final Debug debug = AnnotationProcessor.debug; + + private final AnnotationProcessor processor; + + private final ProjectState state; + + private final ValidationErrorLevel errorLevel; + + private final ValidationErrorLevel missingUnbindMethodLevel; + + private final Map dsKeys; + + private final Set problems; + + public AnnotationVisitor(AnnotationProcessor processor, ProjectState state, Map dsKeys, Set problems) { + this.processor = processor; + this.state = state; + this.errorLevel = state.getErrorLevel(); + this.missingUnbindMethodLevel = state.getMissingUnbindMethodLevel(); + this.dsKeys = dsKeys; + this.problems = problems; + } + + @Override + public boolean visit(TypeDeclaration type) { + if (!Modifier.isPublic(type.getModifiers())) { + // non-public types cannot be (or have nested) components + if (errorLevel.isNone()) + return false; + + Annotation annotation = findComponentAnnotation(type); + if (annotation != null) + reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_notPublic, type.getName().getIdentifier()), type.getName().getIdentifier()); + + return true; + } + + Annotation annotation = findComponentAnnotation(type); + if (annotation != null) { + boolean isInterface = false; + boolean isAbstract = false; + boolean isNested = false; + boolean noDefaultConstructor = false; + if ((isInterface = type.isInterface()) + || (isAbstract = Modifier.isAbstract(type.getModifiers())) + || (isNested = (!type.isPackageMemberTypeDeclaration() && !isNestedPublicStatic(type))) + || (noDefaultConstructor = !hasDefaultConstructor(type))) { + // interfaces, abstract types, non-static/non-public nested types, or types with no default constructor cannot be components + if (errorLevel != ValidationErrorLevel.none) { + if (isInterface) + reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_interface, type.getName().getIdentifier()), type.getName().getIdentifier()); + else if (isAbstract) + reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_abstract, type.getName().getIdentifier()), type.getName().getIdentifier()); + else if (isNested) + reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_notTopLevel, type.getName().getIdentifier()), type.getName().getIdentifier()); + else if (noDefaultConstructor) + reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_noDefaultConstructor, type.getName().getIdentifier()), type.getName().getIdentifier()); + else + reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentImplementationClass, type.getName().getIdentifier()), type.getName().getIdentifier()); + } + } else { + ITypeBinding typeBinding = type.resolveBinding(); + if (typeBinding == null) { + if (debug.isDebugging()) + debug.trace(String.format("Unable to resolve binding for type: %s", type)); //$NON-NLS-1$ + } else { + IAnnotationBinding annotationBinding = annotation.resolveAnnotationBinding(); + if (annotationBinding == null) { + if (debug.isDebugging()) + debug.trace(String.format("Unable to resolve binding for annotation: %s", annotation)); //$NON-NLS-1$ + } else { + try { + processComponent(type, typeBinding, annotation, annotationBinding, problems); + } catch (CoreException e) { + Activator.getDefault().getLog().log(e.getStatus()); + } + } + } + } + } + + return true; + } + + @Override + public boolean visit(EnumDeclaration node) { + Annotation annotation = findComponentAnnotation(node); + if (annotation != null) + reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_enumeration, node.getName().getIdentifier()), node.getName().getIdentifier()); + + return false; + } + + @Override + public boolean visit(AnnotationTypeDeclaration node) { + Annotation annotation = findComponentAnnotation(node); + if (annotation != null) + reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidCompImplClass_annotation, node.getName().getIdentifier()), node.getName().getIdentifier()); + + return true; + } + + private Annotation findComponentAnnotation(AbstractTypeDeclaration type) { + for (Object item : type.modifiers()) { + if (!(item instanceof Annotation)) + continue; + + Annotation annotation = (Annotation) item; + IAnnotationBinding annotationBinding = annotation.resolveAnnotationBinding(); + if (annotationBinding == null) { + if (debug.isDebugging()) + debug.trace(String.format("Unable to resolve binding for annotation: %s", annotation)); //$NON-NLS-1$ + + continue; + } + + if (COMPONENT_ANNOTATION.equals(annotationBinding.getAnnotationType().getQualifiedName())) + return annotation; + } + + return null; + } + + private boolean isNestedPublicStatic(AbstractTypeDeclaration type) { + if (Modifier.isStatic(type.getModifiers())) { + ASTNode parent = type.getParent(); + if (parent != null && (parent.getNodeType() == ASTNode.TYPE_DECLARATION || parent.getNodeType() == ASTNode.ANNOTATION_TYPE_DECLARATION)) { + AbstractTypeDeclaration parentType = (AbstractTypeDeclaration) parent; + if (Modifier.isPublic(parentType.getModifiers())) + return parentType.isPackageMemberTypeDeclaration() || isNestedPublicStatic(parentType); + } + } + + return false; + } + + private boolean hasDefaultConstructor(TypeDeclaration type) { + boolean hasConstructor = false; + for (MethodDeclaration method : type.getMethods()) { + if (method.isConstructor()) { + hasConstructor = true; + if (Modifier.isPublic(method.getModifiers()) && method.parameters().isEmpty()) + return true; + } + } + + return !hasConstructor; + } + + private void processComponent(TypeDeclaration type, ITypeBinding typeBinding, Annotation annotation, IAnnotationBinding annotationBinding, Collection problems) throws CoreException { + // determine component name + HashMap params = new HashMap(); + for (IMemberValuePairBinding pair : annotationBinding.getDeclaredMemberValuePairs()) { + params.put(pair.getName(), pair.getValue()); + } + + String implClass = typeBinding.getBinaryName(); + + String name = implClass; + Object value; + if ((value = params.get("name")) instanceof String) { //$NON-NLS-1$ + name = (String) value; + validateComponentName(annotation, name, problems); + } + + // set up document to edit + IPath path = new Path(state.getPath()).append(name).addFileExtension("xml"); //$NON-NLS-1$ + + String dsKey = path.toPortableString(); + dsKeys.put(implClass, dsKey); + + IProject project = typeBinding.getJavaElement().getJavaProject().getProject(); + IFile file = PDEProject.getBundleRelativeFile(project, path); + IPath filePath = file.getFullPath(); + + processor.verifyOutputLocation(file); + + // handle file move/rename + String oldPath = state.getModelFile(implClass); + if (oldPath != null && !oldPath.equals(dsKey) && !file.exists()) { + IFile oldFile = PDEProject.getBundleRelativeFile(project, Path.fromPortableString(oldPath)); + if (oldFile.exists()) { + try { + oldFile.move(file.getFullPath(), true, true, null); + } catch (CoreException e) { + Activator.getDefault().getLog().log(new Status(IStatus.WARNING, Activator.PLUGIN_ID, String.format("Unable to move model file from '%s' to '%s'.", oldPath, file.getFullPath()), e)); //$NON-NLS-1$ + } + } + } + + ITextFileBufferManager bufferManager = FileBuffers.getTextFileBufferManager(); + bufferManager.connect(filePath, LocationKind.IFILE, null); + ITextFileBuffer buffer = bufferManager.getTextFileBuffer(filePath, LocationKind.IFILE); + if (buffer.isDirty()) + buffer.commit(null, true); + + IDocument document = buffer.getDocument(); + final DSModel dsModel = new DSModel(document, true); + dsModel.setUnderlyingResource(file); + dsModel.setCharset("UTF-8"); //$NON-NLS-1$ + dsModel.load(); + + // note: we can't use XMLTextChangeListener because it generates overlapping edits! + // thus we replace the entire content with one edit (if changed) + final IDocument fDoc = document; + dsModel.addModelChangedListener(new IModelTextChangeListener() { + + private final IDocument document = fDoc; + + private boolean changed; + + public void modelChanged(IModelChangedEvent event) { + changed = true; + } + + public TextEdit[] getTextOperations() { + if (!changed) + return new TextEdit[0]; + + String text = dsModel.getContents(); + ReplaceEdit edit = new ReplaceEdit(0, document.getLength(), text); + return new TextEdit[] { edit }; + } + + public String getReadableName(TextEdit edit) { + return null; + } + }); + + try { + processComponent(dsModel, type, typeBinding, annotation, annotationBinding, params, name, implClass, problems); + + TextEdit[] edits = dsModel.getLastTextChangeListener().getTextOperations(); + if (edits.length > 0) { + if (debug.isDebugging()) + debug.trace(String.format("Saving model: %s", file.getFullPath())); //$NON-NLS-1$ + + final MultiTextEdit edit = new MultiTextEdit(); + edit.addChildren(edits); + + if (buffer.isSynchronizationContextRequested()) { + final IDocument doc = document; + final CoreException[] ex = new CoreException[1]; + final CountDownLatch latch = new CountDownLatch(1); + bufferManager.execute(new Runnable() { + public void run() { + try { + performEdit(doc, edit); + } catch (CoreException e) { + ex[0] = e; + } + + latch.countDown(); + } + }); + + try { + latch.await(); + } catch (InterruptedException e) { + if (debug.isDebugging()) + debug.trace("Interrupted while waiting for edits to complete on display thread.", e); //$NON-NLS-1$ + } + + if (ex[0] != null) + throw ex[0]; + } else { + performEdit(document, edit); + } + + buffer.commit(null, true); + } + } finally { + dsModel.dispose(); + bufferManager.disconnect(buffer.getLocation(), LocationKind.IFILE, null); + } + } + + private void performEdit(IDocument document, TextEdit edit) throws CoreException { + DocumentRewriteSession session = null; + try { + if (document instanceof IDocumentExtension4) { + session = ((IDocumentExtension4) document).startRewriteSession(DocumentRewriteSessionType.UNRESTRICTED); + } + + LinkedModeModel.closeAllModels(document); + edit.apply(document); + } catch (MalformedTreeException e) { + throw new CoreException(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Error applying changes to component model.", e)); //$NON-NLS-1$ + } catch (BadLocationException e) { + throw new CoreException(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Error applying changes to component model.", e)); //$NON-NLS-1$ + } finally { + if (session != null) { + ((IDocumentExtension4) document).stopRewriteSession(session); + } + } + } + + private void processComponent(IDSModel model, TypeDeclaration type, ITypeBinding typeBinding, Annotation annotation, IAnnotationBinding annotationBinding, Map params, String name, String implClass, Collection problems) { + // The required version of the DS specification. Defaults to 1, meaning: v1.1.0 + // The value will be updated in case necessary. + int requiredVersion = 1; + + Object value; + Collection services; + if ((value = params.get("service")) instanceof Object[]) { //$NON-NLS-1$ + Object[] elements = (Object[]) value; + services = new LinkedHashSet(elements.length); + Map serviceDuplicates = errorLevel.isNone() ? null : new HashMap(); + for (int i = 0; i < elements.length; ++i) { + ITypeBinding serviceType = (ITypeBinding) elements[i]; + String serviceName = serviceType.getBinaryName(); + if (!errorLevel.isNone()) { + if (serviceDuplicates.containsKey(serviceName)) { + reportProblem(annotation, "service", i, problems, Messages.AnnotationProcessor_duplicateServiceDeclaration, serviceName); //$NON-NLS-1$ + Integer pos = serviceDuplicates.put(serviceName, null); + if (pos != null) + reportProblem(annotation, "service", pos.intValue(), problems, Messages.AnnotationProcessor_duplicateServiceDeclaration, serviceName); //$NON-NLS-1$ + } else { + serviceDuplicates.put(serviceName, i); + } + } + + services.add(serviceName); + validateComponentService(annotation, typeBinding, serviceType, i, problems); + } + } else { + ITypeBinding[] serviceTypes = typeBinding.getInterfaces(); + services = new ArrayList(serviceTypes.length); + for (int i = 0; i < serviceTypes.length; ++i) { + services.add(serviceTypes[i].getBinaryName()); + } + } + + String factory = null; + if ((value = params.get("factory")) instanceof String) { //$NON-NLS-1$ + factory = (String) value; + validateComponentFactory(annotation, factory, problems); + } + + Boolean serviceFactory = null; + if ((value = params.get("servicefactory")) instanceof Boolean) { //$NON-NLS-1$ + serviceFactory = (Boolean) value; + } + + Boolean enabled = null; + if ((value = params.get("enabled")) instanceof Boolean) { //$NON-NLS-1$ + enabled = (Boolean) value; + } + + Boolean immediate = null; + if ((value = params.get("immediate")) instanceof Boolean) { //$NON-NLS-1$ + immediate = (Boolean) value; + } + + String[] properties; + if ((value = params.get("property")) instanceof Object[]) { //$NON-NLS-1$ + Object[] elements = (Object[]) value; + ArrayList list = new ArrayList(elements.length); + for (int i = 0; i < elements.length; ++i) { + if (elements[i] instanceof String) + list.add((String) elements[i]); + } + + properties = list.toArray(new String[list.size()]); + } else { + properties = new String[0]; + } + + String[] propertyFiles; + if ((value = params.get("properties")) instanceof Object[]) { //$NON-NLS-1$ + Object[] elements = (Object[]) value; + ArrayList list = new ArrayList(elements.length); + for (int i = 0; i < elements.length; ++i) { + if (elements[i] instanceof String) + list.add((String) elements[i]); + } + + propertyFiles = list.toArray(new String[list.size()]); + validateComponentPropertyFiles(annotation, ((IType) typeBinding.getJavaElement()).getJavaProject().getProject(), propertyFiles, problems); + } else { + propertyFiles = new String[0]; + } + + String configPolicy = null; + if ((value = params.get("configurationPolicy")) instanceof IVariableBinding) { //$NON-NLS-1$ + IVariableBinding configPolicyBinding = (IVariableBinding) value; + ConfigurationPolicy configPolicyLiteral = ConfigurationPolicy.valueOf(configPolicyBinding.getName()); + if (configPolicyLiteral != null) + configPolicy = configPolicyLiteral.toString(); + } + + String configPid = null; + if ((value = params.get("configurationPid")) instanceof String || value instanceof Object[]) { //$NON-NLS-1$ + Object[] pids; + if (value instanceof String) { + pids = new Object[]{value}; + } + else { + pids = (Object[]) value; + } + StringBuffer configurations = new StringBuffer(); + for (Object pid : pids) { + validateComponentConfigPID(annotation, pid.toString(), problems); + configurations.append(pid.toString()).append(" "); + } + configPid = configurations.toString().trim(); + if (pids.length > 1) { + requiredVersion = Math.max(requiredVersion, 3); + } + } + + ServiceScope scope = null; + if ((value = params.get("scope")) instanceof IVariableBinding) { + IVariableBinding scopeBinding = (IVariableBinding) value; + scope = ServiceScope.valueOf(scopeBinding.getName()); + } + + IDSComponent component = model.getDSComponent(); + + if (enabled == null) { + removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_ENABLED, IDSConstants.VALUE_TRUE); + } else { + component.setEnabled(enabled.booleanValue()); + } + + if (name == null) { + removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_NAME, null); + } else { + component.setAttributeName(name); + } + + if (factory == null) { + removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_FACTORY, null); + } else { + component.setFactory(factory); + } + + if (immediate == null) { + removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_IMMEDIATE, null); + } else { + component.setImmediate(immediate.booleanValue()); + } + + if (configPolicy == null) { + removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_CONFIGURATION_POLICY, IDSConstants.VALUE_CONFIGURATION_POLICY_OPTIONAL); + } else { + component.setConfigurationPolicy(configPolicy); + } + + IDSDocumentFactory dsFactory = model.getFactory(); + + String activate = null; + Annotation activateAnnotation = null; + String deactivate = null; + Annotation deactivateAnnotation = null; + String modified = null; + Annotation modifiedAnnotation = null; + + ArrayList references = new ArrayList(); + HashMap referenceNames = new HashMap(); + IDSReference[] refElements = component.getReferences(); + + HashMap refMap = new HashMap(refElements.length); + for (IDSReference refElement : refElements) { + refMap.put(refElement.getName(), refElement); + } + + // Process the field declarations to get the field injection points. + if (processFieldReferences(type, false, refMap, dsFactory, references, referenceNames, problems).size() > 0) { + requiredVersion = Math.max(requiredVersion, 3); + } + + Map defaultValues = new HashMap(); + for (MethodDeclaration method : type.getMethods()) { + for (Object modifier : method.modifiers()) { + if (!(modifier instanceof Annotation)) + continue; + + Annotation methodAnnotation = (Annotation) modifier; + IAnnotationBinding methodAnnotationBinding = methodAnnotation.resolveAnnotationBinding(); + if (methodAnnotationBinding == null) { + if (debug.isDebugging()) + debug.trace(String.format("Unable to resolve binding for annotation: %s", methodAnnotation)); //$NON-NLS-1$ + + continue; + } + + String annotationName = methodAnnotationBinding.getAnnotationType().getQualifiedName(); + + if (ACTIVATE_ANNOTATION.equals(annotationName)) { + if (activate == null) { + activate = method.getName().getIdentifier(); + activateAnnotation = methodAnnotation; + requiredVersion = Math.max(requiredVersion, validateLifeCycleMethod(methodAnnotation, "activate", method, + dsFactory, defaultValues, problems)); //$NON-NLS-1$ + } else if (!errorLevel.isNone()) { + reportProblem(methodAnnotation, null, problems, Messages.AnnotationProcessor_duplicateActivateMethod, method.getName().getIdentifier()); + if (activateAnnotation != null) { + reportProblem(activateAnnotation, null, problems, Messages.AnnotationProcessor_duplicateActivateMethod, activate); + activateAnnotation = null; + } + } + + continue; + } + + if (DEACTIVATE_ANNOTATION.equals(annotationName)) { + if (deactivate == null) { + deactivate = method.getName().getIdentifier(); + deactivateAnnotation = methodAnnotation; + requiredVersion = Math.max(requiredVersion, validateLifeCycleMethod(methodAnnotation, "deactivate", method, + dsFactory, defaultValues, problems)); //$NON-NLS-1$ + } else if (!errorLevel.isNone()) { + reportProblem(methodAnnotation, null, problems, Messages.AnnotationProcessor_duplicateDeactivateMethod, method.getName().getIdentifier()); + if (deactivateAnnotation != null) { + reportProblem(deactivateAnnotation, null, problems, Messages.AnnotationProcessor_duplicateDeactivateMethod, deactivate); + deactivateAnnotation = null; + } + } + + continue; + } + + if (MODIFIED_ANNOTATION.equals(annotationName)) { + if (modified == null) { + modified = method.getName().getIdentifier(); + modifiedAnnotation = methodAnnotation; + requiredVersion = Math.max(requiredVersion, validateLifeCycleMethod(methodAnnotation, "modified", method, + dsFactory, defaultValues, problems)); //$NON-NLS-1$ + } else if (!errorLevel.isNone()) { + reportProblem(methodAnnotation, null, problems, Messages.AnnotationProcessor_duplicateModifiedMethod, method.getName().getIdentifier()); + if (modifiedAnnotation != null) { + reportProblem(modifiedAnnotation, null, problems, Messages.AnnotationProcessor_duplicateModifiedMethod, modified); + modifiedAnnotation = null; + } + } + + continue; + } + + if (REFERENCE_ANNOTATION.equals(annotationName)) { + IMethodBinding methodBinding = method.resolveBinding(); + if (methodBinding == null) { + if (debug.isDebugging()) + debug.trace(String.format("Unable to resolve binding for method: %s", method)); //$NON-NLS-1$ + } else { + requiredVersion = Math.max(requiredVersion, processReference(method, methodBinding, methodAnnotation, methodAnnotationBinding, refMap, dsFactory, references, referenceNames, problems)); + } + + continue; + } + } + } + + if (activate == null) { + // only remove activate="activate" if method not found + if (!"activate".equals(component.getActivateMethod()) //$NON-NLS-1$ + || !hasLifeCycleMethod(typeBinding, "activate")) //$NON-NLS-1$ + removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_ACTIVATE, null); //$NON-NLS-1$ + } else { + component.setActivateMethod(activate); + } + + if (deactivate == null) { + // only remove deactivate="deactivate" if method not found + if (!"deactivate".equals(component.getDeactivateMethod()) //$NON-NLS-1$ + || !hasLifeCycleMethod(typeBinding, "deactivate")) //$NON-NLS-1$ + removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_DEACTIVATE, null); //$NON-NLS-1$ + } else { + component.setDeactivateMethod(deactivate); + } + + if (modified == null) { + removeAttribute(component, IDSConstants.ATTRIBUTE_COMPONENT_MODIFIED, null); + } else { + component.setModifiedeMethod(modified); + } + + IDSProperty[] propElements = component.getPropertyElements(); + // If we don't have any properties, just remove them from the XML. + if (properties.length == 0 && defaultValues.size() == 0) { + removeChildren(component, Arrays.asList(propElements)); + } else { + // build up new property elements. This are the property + // elements present in the @Component annotation. + LinkedHashMap map = new LinkedHashMap(properties.length); + for (int i = 0; i < properties.length; ++i) { + String propertyStr = properties[i]; + String[] pair = propertyStr.split("=", 2); //$NON-NLS-1$ + int colon = pair[0].indexOf(':'); + String propertyName, propertyType; + if (colon == -1) { + propertyName = pair[0]; + propertyType = null; + } else { + propertyName = pair[0].substring(0, colon); + propertyType = pair[0].substring(colon + 1); + } + + String propertyValue = pair.length > 1 ? pair[1].trim() : null; + + IDSProperty property = map.get(propertyName); + if (property == null) { + // create a new property + property = dsFactory.createProperty(); + map.put(propertyName, property); + property.setPropertyName(propertyName); + if (propertyType == null) + removeAttribute(property, IDSConstants.ATTRIBUTE_PROPERTY_TYPE, null); // just remove the attribute completely so we can detect changes when reconciling + else + property.setPropertyType(propertyType); + + property.setPropertyValue(propertyValue); + validateComponentProperty(annotation, propertyName, propertyType, propertyValue, i, problems); + } else { + // property is multi-valued + String content = property.getPropertyElemBody(); + if (content == null) { + content = property.getPropertyValue(); + property.setPropertyElemBody(content); + property.setPropertyValue(null); + } + + if (!errorLevel.isNone()) { + String expected = property.getPropertyType() == null || property.getPropertyType().length() == 0 || IDSConstants.VALUE_PROPERTY_TYPE_STRING.equals(property.getPropertyType()) ? Messages.AnnotationProcessor_stringOrEmpty : property.getPropertyType(); + String actual = propertyType == null || IDSConstants.VALUE_PROPERTY_TYPE_STRING.equals(propertyType) ? Messages.AnnotationProcessor_stringOrEmpty : propertyType; + if (!actual.equals(expected)) + reportProblem(annotation, "property", i, problems, NLS.bind(Messages.AnnotationProcessor_inconsistentComponentPropertyType, actual, expected), actual); //$NON-NLS-1$ + else + validateComponentProperty(annotation, propertyName, propertyType, propertyValue, i, problems); + } + + if (propertyValue != null) + property.setPropertyElemBody(content + "\n" + pair[1]); //$NON-NLS-1$ + } + } + + // reconcile against existing property elements + HashMap propMap = new HashMap(); + for (IDSProperty propElement : propElements) { + propMap.put(propElement.getPropertyName(), propElement); + } + + // We now merge the default values from the configuration type properties with + // the values found in the component annotations. The latter overwrite the first. + Map actualProperties = new HashMap(); + // Load the defaults. + actualProperties.putAll(defaultValues); + // Overwrite/add the properties from the annotation. + actualProperties.putAll(map); + ArrayList propList = new ArrayList(actualProperties.values()); + for (ListIterator i = propList.listIterator(); i.hasNext();) { + IDSProperty newProperty = i.next(); + IDSProperty property = propMap.remove(newProperty.getPropertyName()); + if (property == null) + continue; + + i.set(property); + + String newPropertyType = newProperty.getPropertyType(); + if (newPropertyType != null || !IDSConstants.VALUE_PROPERTY_TYPE_STRING.equals(property.getPropertyType())) + property.setPropertyType(newPropertyType); + + String newContent = newProperty.getPropertyElemBody(); + // Somehow, even if we set null to the body, it still can contain an empty string. Therefore, check + // on an empty string as well. + if (newContent == null || newContent.length() == 0) { + property.setPropertyValue(newProperty.getPropertyValue()); + IDocumentTextNode textNode = property.getTextNode(); + if (textNode != null) { + property.removeTextNode(); + if (property.isInTheModel() && property.isEditable()) { + model.fireModelChanged(new ModelChangedEvent(model, IModelChangedEvent.REMOVE, new Object[] { textNode }, null)); + } + } + } else { + removeAttribute(property, IDSConstants.ATTRIBUTE_PROPERTY_VALUE, null); + String content = property.getPropertyElemBody(); + if (content == null || !newContent.equals(normalizePropertyElemBody(content))) { + property.setPropertyElemBody(newContent); + } + } + } + + int firstPos = propElements.length == 0 + ? 0 // insert first property element as first child of component + : component.indexOf(propElements[0]); + removeChildren(component, propMap.values()); + + addOrMoveChildren(component, propList, firstPos); + } + + IDSProperties[] propFileElements = component.getPropertiesElements(); + if (propertyFiles.length == 0) { + removeChildren(component, Arrays.asList(propFileElements)); + } else { + HashMap propFileMap = new HashMap(propFileElements.length); + for (IDSProperties propFileElement : propFileElements) { + propFileMap.put(propFileElement.getEntry(), propFileElement); + } + + ArrayList propFileList = new ArrayList(propertyFiles.length); + for (String propertyFile : propertyFiles) { + IDSProperties propertiesElement = propFileMap.remove(propertyFile); + if (propertiesElement == null) { + propertiesElement = dsFactory.createProperties(); + propertiesElement.setInTheModel(false); // note: workaround for PDE bug + propertiesElement.setEntry(propertyFile); + } + + propFileList.add(propertiesElement); + } + + int firstPos; + if (propFileElements.length == 0) { + // insert first properties element after last property or (if none) first child of component + propElements = component.getPropertyElements(); + firstPos = propElements.length == 0 ? 0 : component.indexOf(propElements[propElements.length - 1]) + 1; + } else { + firstPos = component.indexOf(propFileElements[0]); + } + + removeChildren(component, propFileMap.values()); + + addOrMoveChildren(component, propFileList, firstPos); + } + + IDSService service = component.getService(); + if (services.isEmpty()) { + if (service != null) + component.removeService(service); + } else { + if (service == null) { + service = dsFactory.createService(); + + // insert service element after last property or properties element + int firstPos = Math.max(0, indexOfLastPropertyOrProperties(component)); + component.addChildNode(service, firstPos, true); + } + + IDSProvide[] provides = service.getProvidedServices(); + HashMap provideMap = new HashMap(provides.length); + for (IDSProvide provide : provides) { + provideMap.put(provide.getInterface(), provide); + } + + ArrayList provideList = new ArrayList(services.size()); + for (String serviceName : services) { + IDSProvide provide = provideMap.remove(serviceName); + if (provide == null) { + provide = dsFactory.createProvide(); + provide.setInterface(serviceName); + } + + provideList.add(provide); + } + + int firstPos = provides.length == 0 ? -1 : service.indexOf(provides[0]); + removeChildren(service, (provideMap.values())); + + addOrMoveChildren(service, provideList, firstPos); + + if (serviceFactory == null) { + removeAttribute(service, IDSConstants.ATTRIBUTE_SERVICE_FACTORY, IDSConstants.VALUE_FALSE); + } else { + service.setServiceFactory(serviceFactory.booleanValue()); + } + if (scope == null) { + removeAttribute(service, "scope", null); + } + else { + service.setXMLAttribute("scope", scope.toString()); + } + } + + + if (configPid == null) { + removeAttribute(component, ATTRIBUTE_COMPONENT_CONFIGURATION_PID, null); + } else { + component.setXMLAttribute(ATTRIBUTE_COMPONENT_CONFIGURATION_PID, configPid); + requiredVersion = Math.max(2, requiredVersion); + } + + if (references.isEmpty()) { + removeChildren(component, Arrays.asList(refElements)); + } else { + // references must be declared in ascending lexicographical order of their names + Collections.sort(references, REF_NAME_COMPARATOR); + + int firstPos; + if (refElements.length == 0) { + // insert first reference element after service element, or (if not present) last property or properties + service = component.getService(); + if (service == null) { + firstPos = Math.max(0, indexOfLastPropertyOrProperties(component)); + } else { + firstPos = component.indexOf(service) + 1; + } + } else { + firstPos = component.indexOf(refElements[0]); + } + + removeChildren(component, refMap.values()); + + addOrMoveChildren(component, references, firstPos); + } + + IDSImplementation impl = component.getImplementation(); + if (impl == null) { + impl = dsFactory.createImplementation(); + component.setImplementation(impl); + } + + impl.setClassName(implClass); + + + String neededXmlns = NAMESPACE_1_1; + if (requiredVersion > 2) { + neededXmlns = NAMESPACE_1_3; + } + else if (requiredVersion > 1) { + neededXmlns = NAMESPACE_1_2; + } + String xmlns = neededXmlns; + if ((value = params.get("xmlns")) instanceof String) { //$NON-NLS-1$ + xmlns = (String) value; + validateComponentXMLNS(annotation, xmlns, neededXmlns, problems); + } else { + xmlns = neededXmlns; + } + + component.setNamespace(xmlns); // Note: updates to the namespace do not work if no other changes! + } + + private void removeChildren(IDSObject parent, Collection children) { + for (IDocumentElementNode child : children) { + parent.removeChildNode(child, true); + } + } + + private void removeAttribute(IDSObject obj, String name, String defaultValue) { + IDocumentAttributeNode attrNode = obj.getDocumentAttribute(name); + if (attrNode != null) { + // only remove if value is not default + String value = attrNode.getAttributeValue(); + if (value != null && value.equals(defaultValue)) + return; + + obj.removeDocumentAttribute(attrNode); + if (obj.isInTheModel() && obj.isEditable()) { + obj.getModel().fireModelChanged(new ModelChangedEvent(obj.getModel(), ModelChangedEvent.REMOVE, new Object[] { attrNode }, null)); + } + } + } + + private void addOrMoveChildren(IDSObject parent, List children, int firstPos) { + for (int i = 0, n = children.size(); i < n; ++i) { + IDSObject child = children.get(i); + if (child.isInTheModel()) { + int pos = parent.indexOf(child); + if (i == 0) { + if (firstPos < pos) { + // move to first place + moveChildNode(parent, child, firstPos - pos, true); + } + } else { + int prevPos = parent.indexOf(children.get(i - 1)); + if (prevPos > pos) { + // move to previous sibling's position + moveChildNode(parent, child, prevPos - pos, true); + } + } + } else { + if (i == 0) { + if (firstPos == -1) { + parent.addChildNode(child, true); + } else { + // insert into first place + parent.addChildNode(child, firstPos, true); + } + } else { + // insert after preceding sibling + parent.addChildNode(child, parent.indexOf(children.get(i - 1)) + 1, true); + } + } + } + } + + private void moveChildNode(IDocumentObject obj, IDocumentElementNode node, int newRelativeIndex, boolean fireEvent) { + if (newRelativeIndex == 1 || newRelativeIndex == -1) { + obj.moveChildNode(node, newRelativeIndex, fireEvent); + return; + } + + // workaround for PDE's busted DocumentObject.clone() method + int currentIndex = obj.indexOf(node); + if (currentIndex == -1) + return; + + int newIndex = newRelativeIndex + currentIndex; + if (newIndex < 0 || newIndex >= obj.getChildCount()) + return; + + obj.removeChildNode(node, fireEvent); + IDocumentElementNode clone = clone(obj, node); + obj.addChildNode(clone, newIndex, fireEvent); + } + + private IDocumentElementNode clone(IDocumentObject obj, IDocumentElementNode node) { + // note: same exact impl as DocumentObject.clone() + // but here the deserialized object will actually resolve successfully + // because our classloader (with DSPropery visible) will be on top of the stack + // yay for Java serialization, *sigh* + IDocumentElementNode clone = null; + try { + // Serialize + ByteArrayOutputStream bout = new ByteArrayOutputStream(); + ObjectOutputStream out = new ObjectOutputStream(bout); + out.writeObject(node); + out.flush(); + out.close(); + byte[] bytes = bout.toByteArray(); + // Deserialize + ByteArrayInputStream bin = new ByteArrayInputStream(bytes); + ObjectInputStream in = new ObjectInputStream(bin); + clone = (IDocumentElementNode) in.readObject(); + in.close(); + // Reconnect + clone.reconnect(obj, obj.getSharedModel()); + } catch (IOException e) { + if (debug.isDebugging()) + debug.trace("Error cloning element.", e); //$NON-NLS-1$ + } catch (ClassNotFoundException e) { + if (debug.isDebugging()) + debug.trace("Error cloning element.", e); //$NON-NLS-1$ + } + + return clone; + } + + private int indexOfLastPropertyOrProperties(IDSComponent component) { + int pos = -1; + IDSProperty[] propElements = component.getPropertyElements(); + IDSProperties[] propFileElements = component.getPropertiesElements(); + if (propElements.length > 0) + pos = component.indexOf(propElements[propElements.length - 1]) + 1; + + if (propFileElements.length > 0) { + int lastPos = component.indexOf(propFileElements[propFileElements.length - 1]) + 1; + if (lastPos > pos) + pos = lastPos; + } + + return pos; + } + + private String normalizePropertyElemBody(String content) { + StringBuilder buf = new StringBuilder(content.length()); + BufferedReader reader = new BufferedReader(new StringReader(content)); + try { + String line; + while ((line = reader.readLine()) != null) { + String trimmed = line.trim(); + if (trimmed.length() == 0) + continue; + + if (buf.length() > 0) + buf.append('\n'); + + buf.append(trimmed); + } + } catch (IOException e) { + if (debug.isDebugging()) + debug.trace("Error reading property element body.", e); //$NON-NLS-1$ + } finally { + try { + reader.close(); + } catch (IOException e) { + // ignore + } + } + + return buf.toString(); + } + + private void validateComponentName(Annotation annotation, String name, Collection problems) { + if (!errorLevel.isNone() && !PID_PATTERN.matcher(name).matches()) + reportProblem(annotation, "name", problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentName, name), name); //$NON-NLS-1$ + } + + private void validateComponentService(Annotation annotation, ITypeBinding componentType, ITypeBinding serviceType, int index, Collection problems) { + if (!errorLevel.isNone() && !componentType.isAssignmentCompatible(serviceType)) + reportProblem(annotation, "service", problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentService, serviceType.getName()), serviceType.getName()); //$NON-NLS-1$ + } + + private void validateComponentFactory(Annotation annotation, String factory, Collection problems) { + if (!errorLevel.isNone() && !PID_PATTERN.matcher(factory).matches()) + reportProblem(annotation, "factory", problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentFactoryName, factory), factory); //$NON-NLS-1$ + } + + private void validateComponentProperty(Annotation annotation, String name, String type, String value, int index, Collection problems) { + if (errorLevel.isNone()) + return; + + if (PROPERTY_TYPES.contains(type)) { + if (name == null || name.trim().length() == 0) + reportProblem(annotation, "property", index, problems, Messages.AnnotationProcessor_invalidComponentProperty_nameRequired, name); //$NON-NLS-1$ + + if (value == null) { + reportProblem(annotation, "property", index, problems, Messages.AnnotationProcessor_invalidComponentProperty_valueRequired, name); //$NON-NLS-1$ + } else { + try { + if (IDSConstants.VALUE_PROPERTY_TYPE_LONG.equals(type)) + Long.valueOf(value); + else if (IDSConstants.VALUE_PROPERTY_TYPE_DOUBLE.equals(type)) + Double.valueOf(value); + else if (IDSConstants.VALUE_PROPERTY_TYPE_FLOAT.equals(type)) + Float.valueOf(value); + else if (IDSConstants.VALUE_PROPERTY_TYPE_INTEGER.equals(type) || IDSConstants.VALUE_PROPERTY_TYPE_CHAR.equals(type)) + Integer.valueOf(value); + else if (IDSConstants.VALUE_PROPERTY_TYPE_BYTE.equals(type)) + Byte.valueOf(value); + else if (IDSConstants.VALUE_PROPERTY_TYPE_SHORT.equals(type)) + Short.valueOf(value); + } catch (NumberFormatException e) { + reportProblem(annotation, "property", index, problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentPropertyValue, type, value), String.valueOf(value)); //$NON-NLS-1$ + } + } + } else { + reportProblem(annotation, "property", index, problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentPropertyType, type), String.valueOf(type)); //$NON-NLS-1$ + } + } + + private void validateComponentPropertyFiles(Annotation annotation, IProject project, String[] files, Collection problems) { + if (errorLevel.isNone()) + return; + + for (int i = 0; i < files.length; ++i) { + String file = files[i]; + IFile wsFile = PDEProject.getBundleRelativeFile(project, new Path(file)); + if (!wsFile.exists()) + reportProblem(annotation, "properties", i, problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentPropertyFile, file), file); //$NON-NLS-1$ + } + } + + private void validateComponentXMLNS(Annotation annotation, String xmlns, String requiredNs, Collection problems) { + + if (!errorLevel.isNone() && requiredNs.compareTo(xmlns) > 0) + reportProblem(annotation, "xmlns", problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentDescriptorNamespace, xmlns), xmlns); //$NON-NLS-1$ + } + + private void validateComponentConfigPID(Annotation annotation, String configPid, Collection problems) { + if (!errorLevel.isNone() && !PID_PATTERN.matcher(configPid).matches()) + reportProblem(annotation, "configurationPid", problems, NLS.bind(Messages.AnnotationProcessor_invalidComponentConfigurationPid, configPid), configPid); //$NON-NLS-1$ + } + + private static String getValueOfDefault(Object object) { + if (object instanceof IVariableBinding) { + IVariableBinding binding = (IVariableBinding) object; + if (binding.isEnumConstant()) { + return binding.getName(); + } + } + return object.toString(); + } + + private int validateLifeCycleMethod(Annotation annotation, String methodName, MethodDeclaration method, + IDSDocumentFactory factory, Map defaultValues, + Collection problems) { + IMethodBinding methodBinding = method.resolveBinding(); + if (methodBinding == null) { + if (debug.isDebugging()) + debug.trace(String.format("Unable to resolve binding for method: %s", method)); //$NON-NLS-1$ + + return 0; + } + String returnTypeName = methodBinding.getReturnType().getName(); + if (!Void.TYPE.getName().equals(returnTypeName)) + reportProblem(annotation, methodName, problems, NLS.bind(Messages.AnnotationProcessor_invalidLifeCycleMethodReturnType, methodName, returnTypeName), returnTypeName); + + ITypeBinding[] paramTypeBindings = methodBinding.getParameterTypes(); + + if (paramTypeBindings.length == 0) + // no-arg method + return 1; + + int requiredSpecVersion = 1; + // every argument must be either Map, ComponentContext, BundleContext or component property type + boolean hasMap = false; + boolean hasCompCtx = false; + boolean hasBundleCtx = false; + boolean hasInt = false; + boolean hasComponentPropertyType = false; + for (ITypeBinding paramTypeBinding : paramTypeBindings) { + String paramTypeName = paramTypeBinding.getErasure().getQualifiedName(); + boolean isDuplicate = false; + + if (Map.class.getName().equals(paramTypeName)) { + if (hasMap) + isDuplicate = true; + else + hasMap = true; + } else if (ComponentContext.class.getName().equals(paramTypeName)) { + if (hasCompCtx) + isDuplicate = true; + else + hasCompCtx = true; + } else if (BundleContext.class.getName().equals(paramTypeName)) { + if (hasBundleCtx) + isDuplicate = true; + else + hasBundleCtx = true; + } else if (paramTypeBinding.isAnnotation()) { + if (hasComponentPropertyType) { + isDuplicate = true; + } + else { + hasComponentPropertyType = true; + // Check the default values in the property. + for (IMethodBinding m : paramTypeBinding.getDeclaredMethods()) { + // Does this property have a default value? + Object defaultValue = m.getDefaultValue(); + if (defaultValue != null) { + IDSProperty property = factory.createProperty(); + Class type = null; + property.setPropertyName(m.getName()); + // Is it an array? If so, fill the body. + if (defaultValue.getClass().isArray()) { + Object[] values = (Object[]) defaultValue; + StringBuffer v = new StringBuffer(); + for (int i = 0; i < values.length; i++) { + Object thisValue = values[i]; + if (thisValue != null) { + type = thisValue.getClass(); + if (v.length() > 0) { + v.append("\n"); + } + v.append(getValueOfDefault(thisValue)); + } + } + property.setPropertyElemBody(v.toString()); + property.setPropertyValue(null); + } + else { + // Normal, single value + type = defaultValue.getClass(); + property.setPropertyValue(getValueOfDefault(defaultValue)); + property.setPropertyElemBody(null); + } + if (type != null) { + property.setPropertyType(type.getSimpleName()); + if (!PROPERTY_TYPES.contains(property.getPropertyType())) { + property.setPropertyType(null); + } + } + defaultValues.put(property.getPropertyName(), property); + } + } + requiredSpecVersion = 3; + } + } else if ("deactivate".equals(methodName) //$NON-NLS-1$ + && (Integer.class.getName().equals(paramTypeName) || Integer.TYPE.getName().equals(paramTypeName))) { + if (hasInt) + isDuplicate = true; + else + hasInt = true; + } else { + reportProblem(annotation, methodName, problems, NLS.bind(Messages.AnnotationProcessor_invalidLifeCycleMethodParameterType, methodName, paramTypeName), paramTypeName); + } + + if (isDuplicate) + reportProblem(annotation, methodName, problems, NLS.bind(Messages.AnnotationProcessor_duplicateLifeCycleMethodParameterType, methodName, paramTypeName), paramTypeName); + } + return requiredSpecVersion; + } + + private boolean hasLifeCycleMethod(ITypeBinding componentClass, String methodName) { + for (IMethodBinding methodBinding : componentClass.getDeclaredMethods()) { + if (methodName.equals(methodBinding.getName()) + && Void.TYPE.getName().equals(methodBinding.getReturnType().getName())) { + ITypeBinding[] paramTypeBindings = methodBinding.getParameterTypes(); + + // every argument must be either Map, ComponentContext, or BundleContext + boolean hasMap = false; + boolean hasCompCtx = false; + boolean hasBundleCtx = false; + boolean hasInt = false; + boolean isInvalid = false; + for (ITypeBinding paramTypeBinding : paramTypeBindings) { + String paramTypeName = paramTypeBinding.getErasure().getQualifiedName(); + + if (Map.class.getName().equals(paramTypeName)) { + if (hasMap) + isInvalid = true; + else + hasMap = true; + } else if (ComponentContext.class.getName().equals(paramTypeName)) { + if (hasCompCtx) + isInvalid = true; + else + hasCompCtx = true; + } else if (paramTypeBinding.isAnnotation()) { + if (hasCompCtx) { + isInvalid = true; + } + else { + hasCompCtx = true; + } + } else if (BundleContext.class.getName().equals(paramTypeName)) { + if (hasBundleCtx) + isInvalid = true; + else + hasBundleCtx = true; + } else if ("deactivate".equals(methodName) //$NON-NLS-1$ + && (Integer.class.getName().equals(paramTypeName) || Integer.TYPE.getName().equals(paramTypeName))) { + if (hasInt) + isInvalid = true; + else + hasInt = true; + } else { + isInvalid = true; + } + + if (isInvalid) + break; + } + + if (!isInvalid) + return true; + } + } + + return false; + } + + private static Map mapAnnotationBinding(IAnnotationBinding annotationBinding) { + HashMap params = new HashMap(); + for (IMemberValuePairBinding pair : annotationBinding.getDeclaredMemberValuePairs()) { + params.put(pair.getName(), pair.getValue()); + } + return params; + } + + /* + * Process the field references present for a type declaration. The fields are checked and if + * a reference annotation is found, it is passed down the reference annotation processing. + */ + Collection processFieldReferences(TypeDeclaration type, boolean checkAccessible, final Map refMap, + final IDSDocumentFactory factory, final Collection references, + final Map names, final Collection problems) { + // List we are going to return to our parent to show that we actually found references. + final List found = new ArrayList(); + // Loop through the fields. + for (FieldDeclaration field : type.getFields()) { + // If we need to check the protect/public modifiers, do it. This is enabled for superclass parsing. + if (checkAccessible && (field.getModifiers() & (Modifier.PROTECTED | Modifier.PUBLIC)) == 0) continue; + for (Object modifier : field.modifiers()) { + if (!(modifier instanceof Annotation)) + continue; + Annotation fieldAnnotation = (Annotation) modifier; + IAnnotationBinding fieldAnnotationBinding = fieldAnnotation.resolveAnnotationBinding(); + if (fieldAnnotationBinding == null) continue; + // Check if it is reference annotation. + String annotationName = fieldAnnotationBinding.getAnnotationType().getQualifiedName(); + if (REFERENCE_ANNOTATION.equals(annotationName)) { + // Process it. + VariableDeclarationFragment fragment = (VariableDeclarationFragment) field.fragments().get(0); + IDSReference goodOne = processReference(field, fragment.getName().getIdentifier(), + fieldAnnotation, fieldAnnotationBinding, refMap, factory, references, names, problems); + // If we found a valid reference, add it to the list to return. + if (goodOne != null) { + found.add(goodOne); + } + } + } + } + return found; + } + + private static ReferenceCardinality _cardinality(Map params) { + ReferenceCardinality cardinalityLiteral = null; + Object value = params.get("cardinality"); + if (value instanceof IVariableBinding) { + IVariableBinding cardinalityBinding = (IVariableBinding) value; + cardinalityLiteral = ReferenceCardinality.valueOf(cardinalityBinding.getName()); + } + else if (value instanceof ReferenceCardinality) { + cardinalityLiteral = (ReferenceCardinality) value; + } + return cardinalityLiteral; + } + + private static String cardinality(Map params) { + ReferenceCardinality cardinalityLiteral = _cardinality(params); + if (cardinalityLiteral != null) + return cardinalityLiteral.toString(); + return null; + } + + private static ReferencePolicy _policy(Map params) { + Object value; + ReferencePolicy policyLiteral = null; + if ((value = params.get("policy")) instanceof IVariableBinding) { //$NON-NLS-1$ + IVariableBinding policyBinding = (IVariableBinding) value; + policyLiteral = ReferencePolicy.valueOf(policyBinding.getName()); + } + return policyLiteral; + } + + private static String policy(Map params) { + ReferencePolicy policyLiteral = _policy(params); + if (policyLiteral == null) return null; + return policyLiteral.toString(); + } + + private static ReferencePolicyOption _referencePolicyOption(Map params) { + Object value; + ReferencePolicyOption policyOptionLiteral = null; + if ((value = params.get("policyOption")) instanceof IVariableBinding) { //$NON-NLS-1$ + IVariableBinding policyOptionBinding = (IVariableBinding) value; + policyOptionLiteral = ReferencePolicyOption.valueOf(policyOptionBinding.getName()); + } + return policyOptionLiteral; + } + + private static String referencePolicyOption(Map params) { + ReferencePolicyOption policyOptionLiteral = _referencePolicyOption(params); + if (policyOptionLiteral != null) { + return policyOptionLiteral.toString(); + } + return null; + } + + private String target(Map params, Annotation annotation, Collection problems) { + String target = null; + Object value; + if ((value = params.get("target")) instanceof String) { //$NON-NLS-1$ + target = (String) value; + validateReferenceTarget(annotation, target, problems); + } + return target; + } + + private static String scope(Map params) { + String scope = null; + Object value; + if ((value = params.get("scope")) instanceof IVariableBinding) { //$NON-NLS-1$ + IVariableBinding scopeBinding = (IVariableBinding) value; + ReferenceScope referenceScope = ReferenceScope.valueOf(scopeBinding.getName()); + if (referenceScope != null && !ReferenceScope.BUNDLE.equals(referenceScope)) { + scope = referenceScope.toString(); + } + } + return scope; + } + + /* + * Common handling of the reference processing. Does the parts that are common to both field and + * method based references and constructs a reference for it. + */ + private IDSReference reference(String defaultName, String service, + Annotation annotation, Map params, Map refMap, IDSDocumentFactory factory, Collection collector, + Map names, Collection problems) { + String name = null; + Object value; + if ((value = params.get("name")) instanceof String) { //$NON-NLS-1$ + name = (String) value; + } + else { + name = defaultName; + } + IDSReference reference = refMap.remove(name); + if (reference == null) { + reference = factory.createReference(); + } + collector.add(reference); + if (!errorLevel.isNone()) { + if (names.containsKey(name)) { + reportProblem(annotation, "name", problems, NLS.bind(Messages.AnnotationProcessor_duplicateReferenceName, name), name); //$NON-NLS-1$ + Annotation duplicate = names.put(name, null); + if (duplicate != null) + reportProblem(duplicate, "name", problems, NLS.bind(Messages.AnnotationProcessor_duplicateReferenceName, name), name); //$NON-NLS-1$ + } else { + names.put(name, annotation); + } + } + + if (name == null) { + removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_NAME, null); + } else { + reference.setReferenceName(name); + } + + if (service == null) { + removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_INTERFACE, null); + } else { + reference.setReferenceInterface(service); + } + String cardinality = cardinality(params); + String policy = policy(params); + String target = target(params, annotation, problems); + String policyOption = referencePolicyOption(params); + String scope = scope(params); + if (cardinality == null) { + removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_CARDINALITY, IDSConstants.VALUE_REFERENCE_CARDINALITY_ONE_ONE); + } else { + reference.setReferenceCardinality(cardinality); + } + + if (policy == null) { + removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_POLICY, IDSConstants.VALUE_REFERENCE_POLICY_STATIC); + } else { + reference.setReferencePolicy(policy); + } + + if (target == null) { + removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_TARGET, null); + } else { + reference.setReferenceTarget(target); + } + + if (policyOption == null) { + removeAttribute(reference, ATTRIBUTE_REFERENCE_POLICY_OPTION, VALUE_REFERENCE_POLICY_OPTION_RELUCTANT); + } else { + reference.setXMLAttribute(ATTRIBUTE_REFERENCE_POLICY_OPTION, policyOption); + } + + if (scope != null) { + reference.setXMLAttribute("scope", scope); + } + else { + removeAttribute(reference, "scope", null); + } + return reference; + } + + private static ITypeBinding bindingExcludingObject(Type type) { + ITypeBinding b = type.resolveBinding(); + if (b == null || b.getBinaryName().equals("java.lang.Object")) { + b = null; + } + return b; + } + + /* + * Get the contained type for a parameterized type. This to determine the service type from the parameterized + * indications. + */ + private Type containedType(Type type, int index) { + Type contained = null; + if (type.isParameterizedType()) { + ParameterizedType thisType = (ParameterizedType) type; + if (thisType.typeArguments().size() > index) { + contained = (Type) thisType.typeArguments().get(index); + if (bindingExcludingObject(contained) == null) { + contained = null; + } + } + } + return contained; + } + + /* + * Parse the field collection type for a specific field type. All according to SCR 1.3, section 112.3.3 + * Returns both the service type (as return value) and the field collection type in the passed string buffer. + */ + private ITypeBinding getFieldCollectionType(Type type, StringBuffer fct) { + if (type == null) return null; + ITypeBinding binding = bindingExcludingObject(type); + if (binding == null) return null; + String containedName = binding.getBinaryName(); + Type serviceType = null; + String fieldCollectionType = null; + if (Map.class.getName().equals(containedName)) { + fieldCollectionType = "properties"; + } + else if (ServiceReference.class.getName().equals(containedName)) { + fieldCollectionType = "reference"; + serviceType = containedType(type, 0); + } + else if (Map.Entry.class.getName().equals(containedName)) { + fieldCollectionType = "tuple"; + serviceType = containedType(type, 1); + } + else if ("org.osgi.service.component.ComponentServiceObjects".equals(containedName)) { + fieldCollectionType = "serviceobjects"; + serviceType = containedType(type, 0); + } + else { + serviceType = type; + } + if (fieldCollectionType != null && fct != null) { + fct.append(fieldCollectionType); + } + return (serviceType == null) ? null : bindingExcludingObject(serviceType); + } + + /* + * Process a field declaration with a reference annotation. As indicated in the SCR specification v1.3, + * fields can be either collection types (for multiple references) or single object types. Both types + * are handled here, generating warnings and errors on the way. + */ + private IDSReference processReference(FieldDeclaration field, String fieldName, + Annotation annotation, IAnnotationBinding annotationBinding, Map refMap, + IDSDocumentFactory factory, Collection collector, Map names, + Collection problems) { + // Map the annotation properties. + Map params = mapAnnotationBinding(annotationBinding); + // Check the service type of the field. Can be either a map, collection, entry or any other object type. + Type type = field.getType(); + ITypeBinding binding = type.resolveBinding(); + if (binding == null) return null; + // Now the processing of the type of the field. There are a couple of options, but + // the first discrimination is made between collections and "normal" objects. + ITypeBinding defaultService = null; + IType itype = (IType) binding.getJavaElement(); + // Try to determine whether the field is a collection. + boolean isCollection = false; + try { + ITypeHierarchy typeHierarchy = itype.newTypeHierarchy(new NullProgressMonitor()); + for (IType t : typeHierarchy.getAllInterfaces()) { + if (t.getFullyQualifiedName().equals(Collection.class.getName())) { + isCollection = true; + } + } + } catch (Exception exc) { + exc.printStackTrace(); + return null; + } + StringBuffer fieldCollectionType = new StringBuffer(); + ReferenceCardinality cardinality = _cardinality(params); + if (isCollection) { + // If the cardinality specifies a 1..1 relation, we should generate a warning (the SCR handler + // probably will fail anyway). If no cardinality is specified, we assume at least one (1..n) since + // we are processing a collection. AFAIK not in the specifications, but seems logical. + if (ReferenceCardinality.MANDATORY.equals(cardinality)) { + reportProblem(annotation, "cardinality", ValidationErrorLevel.warning, problems, + NLS.bind(Messages.AnnotationProcessor_cardinalityMismatch, cardinality.toString())); + } + else if (cardinality == null) { + params.put("cardinality", ReferenceCardinality.AT_LEAST_ONE); + } + // Since it is a collection, we can check the type of the collection from the parameterized value (if present). + // This determines the collection type. + defaultService = getFieldCollectionType(containedType(type, 0), fieldCollectionType); + } + else { + // No collection. If it is not one of the known types, like service reference, etc., + // just get the type of the field itself. + defaultService = getFieldCollectionType(type, null); + // We cannot have a multiple relation here. + if (EnumSet.of(ReferenceCardinality.AT_LEAST_ONE, ReferenceCardinality.MULTIPLE).contains(cardinality)) { + reportProblem(annotation, "cardinality", ValidationErrorLevel.error, problems, + NLS.bind(Messages.AnnotationProcessor_cardinalityMismatch, cardinality.toString())); + } + } + // Dynamic fields should be marked volatile. + if (ReferencePolicy.DYNAMIC.equals(_policy(params)) && (field.getModifiers() & Modifier.VOLATILE) == 0) { + reportProblem(annotation, "policy", ValidationErrorLevel.error, problems, + Messages.AnnotationProcessor_dynamicShouldBeVolatile); + } + // Impossible to have a final modifier since it cannot be replaced then. + if ((field.getModifiers() & Modifier.FINAL) != 0) { + reportProblem(annotation, "policy", ValidationErrorLevel.error, problems, + Messages.AnnotationProcessor_referenceAndFinal); + } + // Check the service specification. If the service is specified, this is the easiest solution, since the programmer + // specifies what the service is. If this one is unavailable and we could not determine the service + // type above, report and issue. + Object s = params.get("service"); + IDSReference reference = null; + if (s == null && defaultService == null) { + reportProblem(annotation, "service", problems, Messages.AnnotationProcessor_unknownServiceType); + } + else { + // OK, valid. Check whether the default service type we determined matches the service + // specification. + String serviceName; + if (s == null || !(s instanceof ITypeBinding)) { + serviceName = defaultService.getBinaryName(); + } + else { + ITypeBinding serviceType = (ITypeBinding) s; + // Check the type compatibility and report a problem if not. + if (defaultService != null && !defaultService.isAssignmentCompatible(serviceType)) { + reportProblem(annotation, "service", problems, + NLS.bind(Messages.AnnotationProcessor_invalidReferenceService, + defaultService.getName(), serviceType.getName())); + } + serviceName = serviceType.getBinaryName(); + } + // Create the service reference. + reference = reference(fieldName, serviceName, + annotation, params, refMap, factory, collector, names, problems); + // Add some attributes because of field injection. Note that these attributes + // are not known by the IDS stuff in the current version, and are therefore created by hand + // in stead of convenience methods. + reference.setXMLAttribute("field", fieldName); + if (fieldCollectionType.length() > 0) { + reference.setXMLAttribute("field-collection-type", fieldCollectionType.toString()); + } + else { + removeAttribute(reference, "field-collection-type", null); + } + // Field option: do we want the field replaced or updated? Only works for collections. + FieldOption fieldOption = null; + Object value = params.get("fieldOption"); + if (value instanceof IVariableBinding) { + IVariableBinding scopeBinding = (IVariableBinding) value; + fieldOption = FieldOption.valueOf(scopeBinding.getName()); + } + if (fieldOption != null && FieldOption.UPDATE.equals(fieldOption)) { + if (!isCollection) { + reportProblem(annotation, "fieldOption", ValidationErrorLevel.error, problems, + Messages.AnnotationProcessor_updateOnlyForCollections); + } + ReferencePolicy policy = _policy(params); + if (!ReferencePolicy.DYNAMIC.equals(policy)) { + reportProblem(annotation, "fieldOption", ValidationErrorLevel.error, problems, + Messages.AnnotationProcessor_updateOnlyForDynamic); + } + reference.setXMLAttribute("field-option", fieldOption.toString()); + } + else { + removeAttribute(reference, "field-option", null); + } + } + return reference; + } + + private int processReference(MethodDeclaration method, IMethodBinding methodBinding, Annotation annotation, IAnnotationBinding annotationBinding, Map refMap, IDSDocumentFactory factory, Collection collector, Map names, Collection problems) { + Map params = mapAnnotationBinding(annotationBinding); + + ITypeBinding[] argTypes = methodBinding.getParameterTypes(); + + ITypeBinding serviceType; + Object value; + if ((value = params.get("service")) instanceof ITypeBinding) { //$NON-NLS-1$ + serviceType = (ITypeBinding) value; + if (!errorLevel.isNone() && argTypes.length > 0) { + ITypeBinding[] typeArgs; + if (!(ServiceReference.class.getName().equals(argTypes[0].getErasure().getQualifiedName()) + && ((typeArgs = argTypes[0].getTypeArguments()).length == 0 || serviceType.isAssignmentCompatible(typeArgs[0]))) + && !serviceType.isAssignmentCompatible(argTypes[0])) + reportProblem(annotation, "service", problems, NLS.bind(Messages.AnnotationProcessor_invalidReferenceService, argTypes[0].getName(), serviceType.getName()), serviceType.getName()); //$NON-NLS-1$ + } + } else if (argTypes.length > 0) { + if (ServiceReference.class.getName().equals(argTypes[0].getErasure().getQualifiedName())) { + ITypeBinding[] typeArgs = argTypes[0].getTypeArguments(); + if (typeArgs.length > 0) + serviceType = typeArgs[0]; + else + serviceType = null; + } else { + serviceType = argTypes[0].isPrimitive() ? getObjectType(method.getAST(), argTypes[0]) : argTypes[0]; + } + } else { + serviceType = null; + } + + if (serviceType == null) { + reportProblem(annotation, null, problems, Messages.AnnotationProcessor_invalidReferenceServiceUnknown); + + serviceType = method.getAST().resolveWellKnownType(Object.class.getName()); + } + + validateReferenceBindMethod(annotation, serviceType, methodBinding, problems); + + String service = serviceType == null ? null : serviceType.getBinaryName(); + + String methodName = methodBinding.getName(); + String name; + if (methodName.startsWith("bind")) { //$NON-NLS-1$ + name = methodName.substring("bind".length()); //$NON-NLS-1$ + } else if (methodName.startsWith("set")) { //$NON-NLS-1$ + name = methodName.substring("set".length()); //$NON-NLS-1$ + } else if (methodName.startsWith("add")) { //$NON-NLS-1$ + name = methodName.substring("add".length()); //$NON-NLS-1$ + } else { + name = methodName; + } + + String unbind; + if ((value = params.get("unbind")) instanceof String) { //$NON-NLS-1$ + String unbindValue = (String) value; + if ("-".equals(unbindValue)) { //$NON-NLS-1$ + unbind = null; + } else { + unbind = unbindValue; + if (!errorLevel.isNone()) { + IMethodBinding unbindMethod = findUnbindMethod(methodBinding.getDeclaringClass(), serviceType, unbind, true); + if (unbindMethod == null) + reportProblem(annotation, "unbind", problems, NLS.bind(Messages.AnnotationProcessor_invalidReferenceUnbind, unbind), unbind); //$NON-NLS-1$ + } + } + } else { + String unbindCandidate; + if (methodName.startsWith("add")) { //$NON-NLS-1$ + unbindCandidate = "remove" + methodName.substring("add".length()); //$NON-NLS-1$ //$NON-NLS-2$ + } else { + unbindCandidate = "un" + methodName; //$NON-NLS-1$ + } + + IMethodBinding unbindMethod = findUnbindMethod(methodBinding.getDeclaringClass(), serviceType, unbindCandidate, false); + if (unbindMethod == null) { + unbind = null; + reportProblem(annotation, null, missingUnbindMethodLevel, problems, NLS.bind(Messages.AnnotationProcessor_noImplicitReferenceUnbind, unbindCandidate), unbindCandidate); + } else { + unbind = unbindMethod.getName(); + } + } + + String updated; + if ((value = params.get(ATTRIBUTE_REFERENCE_UPDATED)) instanceof String) { //$NON-NLS-1$ + String updatedValue = (String) value; + if ("-".equals(updatedValue)) { //$NON-NLS-1$ + updated = null; + } else { + updated = updatedValue; + if (!errorLevel.isNone()) { + IMethodBinding updatedMethod = findUpdatedMethod(methodBinding.getDeclaringClass(), updated, true); + if (updatedMethod == null) + reportProblem(annotation, ATTRIBUTE_REFERENCE_UPDATED, problems, NLS.bind(Messages.AnnotationProcessor_invalidReferenceUpdated, updated), updated); //$NON-NLS-1$ + } + } + } else { + String updatedCandidate; + if (methodName.startsWith("bind")) { //$NON-NLS-1$ + updatedCandidate = ATTRIBUTE_REFERENCE_UPDATED + methodName.substring("bind".length()); //$NON-NLS-1$ //$NON-NLS-2$ + } else if (methodName.startsWith("set")) { //$NON-NLS-1$ + updatedCandidate = ATTRIBUTE_REFERENCE_UPDATED + methodName.substring("set".length()); //$NON-NLS-1$ //$NON-NLS-2$ + } else if (methodName.startsWith("add")) { //$NON-NLS-1$ + updatedCandidate = ATTRIBUTE_REFERENCE_UPDATED + methodName.substring("add".length()); //$NON-NLS-1$ //$NON-NLS-2$ + } else { + updatedCandidate = ATTRIBUTE_REFERENCE_UPDATED + methodName; //$NON-NLS-1$ + } + + IMethodBinding updatedMethod = findUpdatedMethod(methodBinding.getDeclaringClass(), updatedCandidate, false); + if (updatedMethod == null) + updated = null; + else + updated = updatedMethod.getName(); + } + + IDSReference reference = this.reference(name, service, annotation, params, refMap, + factory, collector, names, problems); + + reference.setReferenceBind(methodName); + + if (unbind == null) { + removeAttribute(reference, IDSConstants.ATTRIBUTE_REFERENCE_UNBIND, null); + } else { + reference.setReferenceUnbind(unbind); + } + + if (updated == null) { + removeAttribute(reference, ATTRIBUTE_REFERENCE_UPDATED, null); + } else { + reference.setXMLAttribute(ATTRIBUTE_REFERENCE_UPDATED, updated); + } + + if (scope(params) != null) { + return 3; + } + return (reference.getDocumentAttribute(ATTRIBUTE_REFERENCE_POLICY_OPTION) != null + || reference.getDocumentAttribute(ATTRIBUTE_REFERENCE_UPDATED) != null) ? 2 : 1; + } + + private ITypeBinding getObjectType(AST ast, ITypeBinding primitive) { + if (Boolean.TYPE.getName().equals(primitive.getName())) + return ast.resolveWellKnownType(Boolean.class.getName()); + + if (Byte.TYPE.getName().equals(primitive.getName())) + return ast.resolveWellKnownType(Byte.class.getName()); + + if (Character.TYPE.getName().equals(primitive.getName())) + return ast.resolveWellKnownType(Character.class.getName()); + + if (Double.TYPE.getName().equals(primitive.getName())) + return ast.resolveWellKnownType(Double.class.getName()); + + if (Float.TYPE.getName().equals(primitive.getName())) + return ast.resolveWellKnownType(Float.class.getName()); + + if (Integer.TYPE.getName().equals(primitive.getName())) + return ast.resolveWellKnownType(Integer.class.getName()); + + if (Long.TYPE.getName().equals(primitive.getName())) + return ast.resolveWellKnownType(Long.class.getName()); + + if (Short.TYPE.getName().equals(primitive.getName())) + return ast.resolveWellKnownType(Short.class.getName()); + + return null; + } + + private void validateReferenceBindMethod(Annotation annotation, ITypeBinding serviceType, IMethodBinding methodBinding, Collection problems) { + if (errorLevel.isNone()) + return; + + String returnTypeName = methodBinding.getReturnType().getName(); + if (!Void.TYPE.getName().equals(returnTypeName)) + reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidBindMethodReturnType, returnTypeName), returnTypeName); + + ITypeBinding[] paramTypeBindings = methodBinding.getParameterTypes(); + if (!(paramTypeBindings.length == 1 && (ServiceReference.class.getName().equals(paramTypeBindings[0].getErasure().getQualifiedName()) || serviceType == null || serviceType.isAssignmentCompatible(paramTypeBindings[0]))) + && !(paramTypeBindings.length == 2 && (serviceType == null || serviceType.isAssignmentCompatible(paramTypeBindings[0])) && Map.class.getName().equals(paramTypeBindings[1].getErasure().getQualifiedName()))) { + String[] params = new String[paramTypeBindings.length]; + StringBuilder buf = new StringBuilder(64); + buf.append('('); + for (int i = 0; i < params.length; ++i) { + params[i] = paramTypeBindings[i].getName(); + if (buf.length() > 1) + buf.append(", "); //$NON-NLS-1$ + + buf.append(params[i]); + } + + buf.append(')'); + reportProblem(annotation, null, problems, NLS.bind(Messages.AnnotationProcessor_invalidBindMethodParameters, buf, serviceType == null ? Messages.AnnotationProcessor_unknownServiceTypeLabel : serviceType.getName()), params); + } + } + + private void validateReferenceTarget(Annotation annotation, String target, Collection problems) { + if (errorLevel.isNone()) + return; + + try { + FrameworkUtil.createFilter(target); + } catch (InvalidSyntaxException e) { + String msg = e.getMessage(); + String suffix = ": " + e.getFilter(); //$NON-NLS-1$ + if (msg.endsWith(suffix)) + msg = msg.substring(0, msg.length() - suffix.length()); + + reportProblem(annotation, "target", problems, msg, target); //$NON-NLS-1$ + } + } + + private IMethodBinding findUnbindMethod(ITypeBinding componentClass, ITypeBinding serviceType, String name, boolean recurse) { + ITypeBinding testedClass = componentClass; + + IMethodBinding candidate = null; + int priority = 0; + // priority: + // 0: , Map + // 1: , Map + // 2: + // 3: + do { + for (IMethodBinding declaredMethod : testedClass.getDeclaredMethods()) { + if (name.equals(declaredMethod.getName()) + && Void.TYPE.getName().equals(declaredMethod.getReturnType().getName()) + && (testedClass == componentClass + || Modifier.isPublic(declaredMethod.getModifiers()) + || Modifier.isProtected(declaredMethod.getModifiers()) + || (!Modifier.isPrivate(declaredMethod.getModifiers()) + && testedClass.getPackage().isEqualTo(componentClass.getPackage())))) { + ITypeBinding[] paramTypes = declaredMethod.getParameterTypes(); + if (paramTypes.length == 1) { + if (ServiceReference.class.getName().equals(paramTypes[0].getErasure().getQualifiedName())) + // we have the winner + return declaredMethod; + + if (priority < 3 && serviceType != null && serviceType.isEqualTo(paramTypes[0])) + priority = 3; + else if (priority < 2 && serviceType != null && serviceType.isAssignmentCompatible(paramTypes[0])) + priority = 2; + else + continue; + + // we have a (better) candidate + candidate = declaredMethod; + } else if (paramTypes.length == 2) { + if (priority < 1 + && serviceType != null && serviceType.isEqualTo(paramTypes[0]) + && Map.class.getName().equals(paramTypes[1].getErasure().getQualifiedName())) + priority = 1; + else if (candidate != null + || !(serviceType != null && serviceType.isAssignmentCompatible(paramTypes[0])) + || !Map.class.getName().equals(paramTypes[1].getErasure().getQualifiedName())) + continue; + + // we have a candidate + candidate = declaredMethod; + } + } + } + } while (recurse && (testedClass = testedClass.getSuperclass()) != null); + + return candidate; + } + + private IMethodBinding findUpdatedMethod(ITypeBinding componentClass, String name, boolean recurse) { + ITypeBinding testedClass = componentClass; + + IMethodBinding candidate = null; + do { + for (IMethodBinding declaredMethod : testedClass.getDeclaredMethods()) { + if (name.equals(declaredMethod.getName()) + && Void.TYPE.getName().equals(declaredMethod.getReturnType().getName()) + && (testedClass == componentClass + || Modifier.isPublic(declaredMethod.getModifiers()) + || Modifier.isProtected(declaredMethod.getModifiers()) + || (!Modifier.isPrivate(declaredMethod.getModifiers()) + && testedClass.getPackage().isEqualTo(componentClass.getPackage())))) { + ITypeBinding[] paramTypes = declaredMethod.getParameterTypes(); + if (paramTypes.length == 1) { + if (ServiceReference.class.getName().equals(paramTypes[0].getErasure().getQualifiedName())) + // we have the winner + return declaredMethod; + + if (candidate == null && Map.class.getName().equals(paramTypes[0].getErasure().getQualifiedName())) { + // we have a candidate + candidate = declaredMethod; + } + } + } + } + } while (recurse && (testedClass = testedClass.getSuperclass()) != null); + + return candidate; + } + + private void reportProblem(Annotation annotation, String member, Collection problems, String message, String... args) { + reportProblem(annotation, member, -1, problems, message, args); + } + + private void reportProblem(Annotation annotation, String member, ValidationErrorLevel errorLevel, Collection problems, String message, String... args) { + reportProblem(annotation, member, -1, errorLevel, problems, message, args); + } + + private void reportProblem(Annotation annotation, String member, int valueIndex, Collection problems, String message, String... args) { + reportProblem(annotation, member, valueIndex, errorLevel, problems, message, args); + } + + private void reportProblem(Annotation annotation, String member, int valueIndex, ValidationErrorLevel errorLevel, Collection problems, String message, String... args) { + if (errorLevel.isNone()) + return; + + Expression memberValue = annotation; + if (annotation.isNormalAnnotation() && member != null) { + NormalAnnotation na = (NormalAnnotation) annotation; + for (Object value : na.values()) { + MemberValuePair pair = (MemberValuePair) value; + if (member.equals(pair.getName().getIdentifier())) { + memberValue = pair.getValue(); + break; + } + } + } else if (annotation.isSingleMemberAnnotation()) { + SingleMemberAnnotation sma = (SingleMemberAnnotation) annotation; + memberValue = sma.getValue(); + } + + int start = memberValue.getStartPosition(); + int length = memberValue.getLength(); + + if (valueIndex >= 0 && memberValue instanceof ArrayInitializer) { + ArrayInitializer ai = (ArrayInitializer) memberValue; + if (valueIndex < ai.expressions().size()) { + Expression element = (Expression) ai.expressions().get(valueIndex); + start = element.getStartPosition(); + length = element.getLength(); + } + } + + if (start >= 0) { + DSAnnotationProblem problem = new DSAnnotationProblem((CompilationUnit) annotation.getRoot(), + errorLevel.isError(), message, args); + problem.setSourceStart(start); + problem.setSourceEnd(start + length - 1); + problems.add(problem); + } + + } } \ No newline at end of file diff --git a/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/DSAnnotationProblem.java b/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/DSAnnotationProblem.java index fad8968..4eb9a2d 100644 --- a/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/DSAnnotationProblem.java +++ b/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/DSAnnotationProblem.java @@ -11,6 +11,7 @@ package ca.ecliptical.pde.internal.ds; import org.eclipse.jdt.core.compiler.CategorizedProblem; +import org.eclipse.jdt.core.dom.CompilationUnit; public class DSAnnotationProblem extends CategorizedProblem { @@ -28,10 +29,13 @@ public class DSAnnotationProblem extends CategorizedProblem { private int sourceLineNumber; - public DSAnnotationProblem(boolean error, String message, String... args) { + private CompilationUnit unit; + + public DSAnnotationProblem(CompilationUnit unit, boolean error, String message, String... args) { this.error = error; this.message = message; this.args = args; + this.unit = unit; } public boolean isError() { @@ -95,4 +99,8 @@ public int getSourceLineNumber() { public void setSourceLineNumber(int sourceLineNumber) { this.sourceLineNumber = sourceLineNumber; } + + public CompilationUnit getUnit() { + return unit; + } } diff --git a/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/Messages.java b/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/Messages.java index 1a31648..e2de891 100644 --- a/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/Messages.java +++ b/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/Messages.java @@ -84,10 +84,22 @@ public class Messages extends NLS { public static String AnnotationProcessor_noImplicitReferenceUnbind; + public static String AnnotationProcessor_unknownServiceType; + public static String AnnotationProcessor_stringOrEmpty; public static String AnnotationProcessor_unknownServiceTypeLabel; + + public static String AnnotationProcessor_cardinalityMismatch; + public static String AnnotationProcessor_dynamicShouldBeVolatile; + + public static String AnnotationProcessor_referenceAndFinal; + + public static String AnnotationProcessor_updateOnlyForCollections; + + public static String AnnotationProcessor_updateOnlyForDynamic; + public static String BuildPathMarkerResolutionGenerator_additionalBundleResolution_description; public static String BuildPathMarkerResolutionGenerator_additionalBundleResolution_label; diff --git a/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/messages.properties b/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/messages.properties index de67797..cd03f83 100644 --- a/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/messages.properties +++ b/ca.ecliptical.pde.ds/src/ca/ecliptical/pde/internal/ds/messages.properties @@ -35,13 +35,19 @@ AnnotationProcessor_invalidComponentPropertyFile=Component property file ''{0}'' AnnotationProcessor_invalidComponentPropertyType=Invalid component property type: {0}. Supported types are String (or empty), Long, Double, Float, Integer, Byte, Character, Boolean and Short. AnnotationProcessor_invalidComponentPropertyValue=Invalid {0} value: {1} AnnotationProcessor_invalidComponentService=Component does not extend or implement type: {0} -AnnotationProcessor_invalidLifeCycleMethodParameterType=Invalid {0} method parameter type: {1}; must be org.osgi.service.component.ComponentContext, org.osgi.framework.BundleContext, or java.util.Map. +AnnotationProcessor_invalidLifeCycleMethodParameterType=Invalid {0} method parameter type: {1}; must be org.osgi.service.component.ComponentContext, org.osgi.framework.BundleContext, java.util.Map or a component property type. AnnotationProcessor_invalidLifeCycleMethodReturnType=Invalid {0} method return type: {1}; must be void. AnnotationProcessor_invalidReferenceService=Parameter type {0} not assignable from {1}. AnnotationProcessor_invalidReferenceServiceUnknown=Unable to determine service type from method signature. Please specify service explicitly. AnnotationProcessor_invalidReferenceUnbind=No suitable unbind method named ''{0}'' found in implementation class hierarchy. AnnotationProcessor_invalidReferenceUpdated=No suitable updated method named ''{0}'' found in implementation class hierarchy. AnnotationProcessor_noImplicitReferenceUnbind=No implicit unbind method named ''{0}'' found in implementation class. +AnnotationProcessor_unknownServiceType=Cannot determine the implicit service type. 'service' is therefore required. +AnnotationProcessor_cardinalityMismatch=Cardinality ''{0}'' does not match the field type +AnnotationProcessor_dynamicShouldBeVolatile=Dynamic fields must be marked 'volatile' +AnnotationProcessor_referenceAndFinal=Reference annotated fields cannot be final +AnnotationProcessor_updateOnlyForCollections='update' field option only possible for collection types +AnnotationProcessor_updateOnlyForDynamic='update' field option only possible for dynamic references AnnotationProcessor_stringOrEmpty=String (or empty) AnnotationProcessor_unknownServiceTypeLabel= BuildPathMarkerResolutionGenerator_additionalBundleResolution_description=Add bundle {0}, which exports DS Annotations, as an Additional Bundle dependency visible at build time but not at runtime. @@ -59,7 +65,7 @@ DSAnnotationCompilationParticipant_buildpathProblemMarker_location=Build Path DSAnnotationCompilationParticipant_buildpathProblemMarker_message=DS Annotations missing from permanent build path DSAnnotationPreferenceListener_jobName=Build DSAnnotationPreferenceListener_taskName=Build -DSAnnotationPropertyPage_classpathCheckbox_text=Add DS Annotations to classpath +DSAnnotationPropertyPage_classpathCheckbox_text=Add DS Annotations (v1.3) to classpath DSAnnotationPropertyPage_enableCheckbox_text=Generate descriptors from annotated sources DSAnnotationPropertyPage_errorLevelError=Error DSAnnotationPropertyPage_errorLevelLabel_text=Annotation problem level: