diff options
Diffstat (limited to 'bundles/org.eclipse.wst.html.ui/src-html-validation/org')
8 files changed, 0 insertions, 1135 deletions
diff --git a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationHelper.java b/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationHelper.java deleted file mode 100644 index 37e76a287a..0000000000 --- a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationHelper.java +++ /dev/null @@ -1,52 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2001, 2005 IBM Corporation 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: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.wst.html.internal.validation; - -import org.eclipse.core.resources.IFile; - -/** - * A version of IHelper not dependent on IWorkbenchHelper. - * - * @author pavery - */ -public class HTMLValidationHelper { - /** - */ - public HTMLValidationHelper() { - super(); - } - - /** - * When an IValidator associates a target object with an IMessage, the - * WorkbenchReporter eventually resolves that target object with an - * IResource. Sometimes more than one target object resolves to the same - * IResource (usually the IProject, which is the default IResource when an - * IFile cannot be found). This method is called, by the - * WorkbenchReporter, so that the WorkbenchReporter can distinguish - * between the IMessages which are on the same IResource, but refer to - * different target objects. This is needed for the - * removeAllMessages(IValidator, Object) method, so that when one target - * object removes all of its messages, that it doesn't remove another - * target object's messages. - * - * This method may return null only if object is null. Otherwise, an id - * which can uniquely identify a particular object must be returned. The - * id needs to be unique only within one particular IValidator. - */ - public String getTargetObjectName(Object object) { - if (object == null) - return null; - if (object instanceof IFile) - ((IFile) object).getFullPath().toString(); - return object.toString(); - } - -}
\ No newline at end of file diff --git a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationReporter.java b/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationReporter.java deleted file mode 100644 index 624e7c13fd..0000000000 --- a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationReporter.java +++ /dev/null @@ -1,134 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2001, 2005 IBM Corporation 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: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.wst.html.internal.validation; - -import org.eclipse.core.resources.IFile; -import org.eclipse.core.runtime.CoreException; -import org.eclipse.wst.sse.core.IStructuredModel; -import org.eclipse.wst.sse.core.internal.validate.ValidationMessage; -import org.eclipse.wst.sse.core.internal.validate.ValidationReporter; -import org.eclipse.wst.sse.core.text.IStructuredDocument; -import org.eclipse.wst.validation.internal.provisional.core.IMessage; -import org.eclipse.wst.validation.internal.provisional.core.IReporter; -import org.eclipse.wst.validation.internal.provisional.core.IValidator; - -public class HTMLValidationReporter implements ValidationReporter { - - private IValidator owner = null; - private IReporter reporter = null; - private IFile file = null; - private IStructuredModel model = null; - private HTMLValidationResult result = null; - - /** - */ - public HTMLValidationReporter(IValidator owner, IReporter reporter, IFile file, IStructuredModel model) { - super(); - this.owner = owner; - this.reporter = reporter; - this.file = file; - this.model = model; - } - - /** - */ - public void clear() { - if (this.file == null) - return; - - this.result = null; - - if (this.reporter != null) { - this.reporter.removeAllMessages(this.owner, this.file); - } - else { - // remove by myself? - String id = HTMLValidator.class.getName(); - try { - // TaskListHelper API changed - // TaskListHelper.getTaskList().removeAllTasks(id, this.file, - // null); - TaskListHelper.getTaskList().removeAllTasks(this.file, id, null); - } - catch (CoreException ex) { - } - } - } - - - /** - */ - public HTMLValidationResult getResult() { - if (this.result == null) - this.result = new HTMLValidationResult(); - return this.result; - } - - /** - */ - public void report(ValidationMessage message) { - if (message == null) - return; - if (this.file == null) - return; - - IMessage mes = translateMessage(message); - - if (this.reporter != null) { - this.reporter.addMessage(this.owner, mes); - } - else { - // add by myself? - String id = HTMLValidator.class.getName(); - String location = Integer.toString(mes.getLineNumber()); - String name = this.file.getFullPath().toString(); - try { - TaskListHelper.getTaskList().addTask(id, this.file, location, mes.getId(), mes.getText(), mes.getSeverity(), name, mes.getGroupName(), mes.getOffset(), mes.getLength()); - } - catch (CoreException ex) { - } - } - } - - /** - * Translate ValidationMessage to IMessage and generate result log - */ - private IMessage translateMessage(ValidationMessage message) { - int severity = IMessage.LOW_SEVERITY; - HTMLValidationResult result = getResult(); - switch (message.getSeverity()) { - case ValidationMessage.ERROR : - severity = IMessage.HIGH_SEVERITY; - result.addError(); - break; - case ValidationMessage.WARNING : - severity = IMessage.NORMAL_SEVERITY; - result.addWarning(); - break; - default : - result.addInformation(); - break; - } - - IMessage mes = new LocalizedMessage(severity, message.getMessage(), this.file); - mes.setOffset(message.getOffset()); - mes.setLength(message.getLength()); - if (this.model != null) { - IStructuredDocument flatModel = this.model.getStructuredDocument(); - if (flatModel != null) { - int line = flatModel.getLineOfOffset(message.getOffset()); - mes.setLineNo(line + 1); - } - } - - return mes; - } -}
\ No newline at end of file diff --git a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationResult.java b/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationResult.java deleted file mode 100644 index 90c9f771cf..0000000000 --- a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationResult.java +++ /dev/null @@ -1,64 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2001, 2004 IBM Corporation 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: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.wst.html.internal.validation; - -public class HTMLValidationResult { - private int errors = 0; - private int warnings = 0; - private int informations = 0; - - /** - */ - public HTMLValidationResult() { - } - - /** - */ - public void addError() { - this.errors++; - } - - /** - */ - public void addInformation() { - this.informations++; - } - - /** - */ - public void addWarning() { - this.warnings++; - } - - /** - */ - public int getErrors() { - return this.errors; - } - - /** - */ - public int getInformations() { - return this.informations; - } - - /** - */ - public int getWarnings() { - return this.warnings; - } - - /** - */ - public boolean isValid() { - return (this.errors == 0 && this.warnings == 0 && this.informations == 0); - } -}
\ No newline at end of file diff --git a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationWorkbenchHelper.java b/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationWorkbenchHelper.java deleted file mode 100644 index 90bfde5134..0000000000 --- a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidationWorkbenchHelper.java +++ /dev/null @@ -1,47 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2001, 2005 IBM Corporation 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: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.wst.html.internal.validation; - -import org.eclipse.core.resources.IFile; -import org.eclipse.wst.validation.internal.operations.WorkbenchContext; - -public class HTMLValidationWorkbenchHelper extends WorkbenchContext { - /** - */ - public HTMLValidationWorkbenchHelper() { - super(); - } - - /** - * When an IValidator associates a target object with an IMessage, the - * WorkbenchReporter eventually resolves that target object with an - * IResource. Sometimes more than one target object resolves to the same - * IResource (usually the IProject, which is the default IResource when an - * IFile cannot be found). This method is called, by the - * WorkbenchReporter, so that the WorkbenchReporter can distinguish - * between the IMessages which are on the same IResource, but refer to - * different target objects. This is needed for the - * removeAllMessages(IValidator, Object) method, so that when one target - * object removes all of its messages, that it doesn't remove another - * target object's messages. - * - * This method may return null only if object is null. Otherwise, an id - * which can uniquely identify a particular object must be returned. The - * id needs to be unique only within one particular IValidator. - */ - public String getTargetObjectName(Object object) { - if (object == null) - return null; - if (object instanceof IFile) - return getPortableName((IFile) object); - return object.toString(); - } -}
\ No newline at end of file diff --git a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidator.java b/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidator.java deleted file mode 100644 index dd19bfec64..0000000000 --- a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/HTMLValidator.java +++ /dev/null @@ -1,292 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2001, 2004 IBM Corporation 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: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.wst.html.internal.validation; - -import java.io.IOException; -import java.io.UnsupportedEncodingException; - -import org.eclipse.core.resources.IContainer; -import org.eclipse.core.resources.IFile; -import org.eclipse.core.resources.IProject; -import org.eclipse.core.resources.IResource; -import org.eclipse.core.resources.ResourcesPlugin; -import org.eclipse.core.runtime.CoreException; -import org.eclipse.core.runtime.NullProgressMonitor; -import org.eclipse.core.runtime.OperationCanceledException; -import org.eclipse.core.runtime.Path; -import org.eclipse.wst.html.core.internal.validate.HTMLValidationAdapterFactory; -import org.eclipse.wst.html.ui.internal.HTMLUIMessages; -import org.eclipse.wst.sse.core.IModelManager; -import org.eclipse.wst.sse.core.INodeAdapterFactory; -import org.eclipse.wst.sse.core.IStructuredModel; -import org.eclipse.wst.sse.core.StructuredModelManager; -import org.eclipse.wst.sse.core.internal.util.URIResolver; -import org.eclipse.wst.sse.core.internal.validate.ValidationAdapter; -import org.eclipse.wst.validation.internal.operations.IWorkbenchContext; -import org.eclipse.wst.validation.internal.operations.WorkbenchReporter; -import org.eclipse.wst.validation.internal.provisional.core.IMessage; -import org.eclipse.wst.validation.internal.provisional.core.IReporter; -import org.eclipse.wst.validation.internal.provisional.core.IValidationContext; -import org.eclipse.wst.validation.internal.provisional.core.IValidator; -import org.eclipse.wst.xml.core.document.IDOMDocument; -import org.eclipse.wst.xml.core.document.IDOMModel; -import org.eclipse.wst.xml.core.internal.document.DocumentTypeAdapter; -import org.eclispe.wst.validation.internal.core.Message; - -public class HTMLValidator implements IValidator { - /** - */ - public HTMLValidator() { - super(); - } - - /** - */ - public void cleanup(IReporter reporter) { - // nothing to do - } - - /** - */ - protected IDOMModel getModel(IProject project, IFile file) { - if (project == null || file == null) - return null; - if (!file.exists()) - return null; - if (!canHandle(file)) - return null; - - IStructuredModel model = null; - IModelManager manager = StructuredModelManager.getModelManager(); - - try { - try { - model = manager.getModelForRead(file); - } - catch (UnsupportedEncodingException ex) { - // retry ignoring META charset for invalid META charset - // specification - // recreate input stream, because it is already partially read - model = manager.getModelForRead(file, new String(), null); - } - } - catch (UnsupportedEncodingException ex) { - } - catch (IOException ex) { - } - catch (CoreException ex) { - } - - if (model == null) - return null; - if (!(model instanceof IDOMModel)) { - releaseModel(model); - return null; - } - return (IDOMModel) model; - } - - /** - */ - protected HTMLValidationReporter getReporter(IReporter reporter, IFile file, IDOMModel model) { - return new HTMLValidationReporter(this, reporter, file, model); - } - - /** - * Check file extension to validate - */ - private boolean canHandle(IFile file) { - if (file == null) - return false; - String name = file.getFullPath().toString(); - if (name == null) - return false; - int index = name.lastIndexOf('.'); - if (index < 0) - return false; - String ext = name.substring(index + 1); - if (ext == null || ext.length() == 0) - return false; - ext = ext.toLowerCase(); - return (ext.startsWith("htm") || //$NON-NLS-1$ - ext.startsWith("jsp") || //$NON-NLS-1$ - ext.equals("jsf") || //$NON-NLS-1$ - ext.startsWith("xht") || //$NON-NLS-1$ - ext.startsWith("shtm") || //$NON-NLS-1$ - ext.startsWith("wml") || //$NON-NLS-1$ - ext.equals("jhtml"));//$NON-NLS-1$ - } - - /** - */ - private boolean hasHTMLFeature(IDOMDocument document) { - DocumentTypeAdapter adapter = (DocumentTypeAdapter) document.getAdapterFor(DocumentTypeAdapter.class); - if (adapter == null) - return false; - return adapter.hasFeature("HTML");//$NON-NLS-1$ - } - - /** - */ - protected void releaseModel(IStructuredModel model) { - if (model != null) - model.releaseFromRead(); - } - - /** - */ - public void validate(IValidationContext helper, IReporter reporter) { - if (helper == null) - return; - if ((reporter != null) && (reporter.isCancelled() == true)) { - throw new OperationCanceledException(); - } - String[] deltaArray = helper.getURIs(); - if (deltaArray != null && deltaArray.length > 0) { - validateDelta(helper, reporter); - } - else { - validateFull(helper, reporter); - } - } - - /** - */ - protected HTMLValidationResult validate(IDOMModel model, IFile file) { - IProject prj = null; - if (file != null) { - prj = file.getProject(); - } - if ((prj == null) && (model != null)) { - URIResolver res = model.getResolver(); - if (res != null) { - prj = res.getProject(); - } - } - final WorkbenchReporter reporter = new WorkbenchReporter(prj, new NullProgressMonitor()); - return validate(reporter, file, model); - } - - /** - */ - private HTMLValidationResult validate(IReporter reporter, IFile file, IDOMModel model) { - if (file == null || model == null) - return null; // error - IDOMDocument document = model.getDocument(); - if (document == null) - return null; // error - if (!hasHTMLFeature(document)) - return null; // ignore - - INodeAdapterFactory factory = HTMLValidationAdapterFactory.getInstance(); - ValidationAdapter adapter = (ValidationAdapter) factory.adapt(document); - if (adapter == null) - return null; // error - - HTMLValidationReporter rep = getReporter(reporter, file, model); - rep.clear(); - adapter.setReporter(rep); - if (reporter != null) { - String args[] = new String[]{file.getFullPath().toString()}; - - // Message mess = new Message("HTMLValidation", //$NON-NLS-1$ - // SeverityEnum.LOW_SEVERITY, - // "MESSAGE_HTML_VALIDATION_MESSAGE_UI_", //$NON-NLS-1$ - // args); - Message mess = new LocalizedMessage(IMessage.LOW_SEVERITY, HTMLUIMessages.MESSAGE_HTML_VALIDATION_MESSAGE_UI_); - mess.setParams(args); - reporter.displaySubtask(this, mess); - } - adapter.validate(document); - return rep.getResult(); - } - - /** - */ - private void validateContainer(IValidationContext helper, IReporter reporter, IContainer container) { - try { - IResource[] resourceArray = container.members(false); - for (int i = 0; i < resourceArray.length; i++) { - IResource resource = resourceArray[i]; - if (resource == null) - continue; - if (resource instanceof IFile) { - validateFile(helper, reporter, (IFile) resource); - } - else if (resource instanceof IContainer) { - validateContainer(helper, reporter, (IContainer) resource); - } - } - } - catch (CoreException ex) { - } - } - - /** - */ - private void validateDelta(IValidationContext helper, IReporter reporter) { - String[] deltaArray = helper.getURIs(); - for (int i = 0; i < deltaArray.length; i++) { - String delta = deltaArray[i]; - if (delta == null) - continue; - IResource resource = getResource(delta); - if (resource == null || !(resource instanceof IFile)) - continue; - validateFile(helper, reporter, (IFile) resource); - } - } - - /** - */ - private void validateFile(IValidationContext helper, IReporter reporter, IFile file) { - if ((reporter != null) && (reporter.isCancelled() == true)) { - throw new OperationCanceledException(); - } - IDOMModel model = getModel(file.getProject(), file); - if (model == null) - return; - - try { - validate(reporter, file, model); - } - finally { - releaseModel(model); - } - } - - /** - */ - private void validateFull(IValidationContext helper, IReporter reporter) { - IProject project = null; - String[] fileDelta = helper.getURIs(); - if (helper instanceof IWorkbenchContext) { - IWorkbenchContext wbHelper = (IWorkbenchContext) helper; - project = wbHelper.getProject(); - } - else { - // won't work for project validation (b/c nothing in file delta) - project = getResource(fileDelta[0]).getProject(); - } - if (project == null) - return; - validateContainer(helper, reporter, project); - } - - /* - * added to get rid or dependency on IWorkbenchHelper - * - * @see com.ibm.sse.editor.extensions.validator.IWorkbenchHelper#getResource(com.ibm.sse.editor.extensions.validator.IFileDelta) - */ - public IResource getResource(String delta) { - return ResourcesPlugin.getWorkspace().getRoot().getFile(new Path(delta)); - } -}
\ No newline at end of file diff --git a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/LocalizedMessage.java b/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/LocalizedMessage.java deleted file mode 100644 index b637b177dd..0000000000 --- a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/LocalizedMessage.java +++ /dev/null @@ -1,65 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2001, 2004 IBM Corporation 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: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.wst.html.internal.validation; - -import java.util.Locale; - -import org.eclipse.core.resources.IResource; -import org.eclispe.wst.validation.internal.core.Message; - -/** - * copied from org.eclipse.wst.validation.internal.operations.LocalizedMessage - * - * This class is provided for validators which run only in Eclipse and whose messages, because they - * come from another tool, are already localized. LocalizedMessage cannot be used by any validator - * which needs to run in both WebSphere and Eclipse. - */ -public class LocalizedMessage extends Message { - private String _message = null; - - public LocalizedMessage(int severity, String messageText) { - this(severity, messageText, null); - } - - public LocalizedMessage(int severity, String messageText, IResource targetObject) { - this(severity, messageText, (Object) targetObject); - } - - public LocalizedMessage(int severity, String messageText, Object targetObject) { - super(null, severity, null); - setLocalizedMessage(messageText); - setTargetObject(targetObject); - } - - public void setLocalizedMessage(String message) { - _message = message; - } - - public String getLocalizedMessage() { - return _message; - } - - public String getText() { - return getLocalizedMessage(); - } - - public String getText(ClassLoader cl) { - return getLocalizedMessage(); - } - - public String getText(Locale l) { - return getLocalizedMessage(); - } - - public String getText(Locale l, ClassLoader cl) { - return getLocalizedMessage(); - } -}
\ No newline at end of file diff --git a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/TaskListHelper.java b/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/TaskListHelper.java deleted file mode 100644 index 17ecaf67d3..0000000000 --- a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/TaskListHelper.java +++ /dev/null @@ -1,46 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2001, 2005 IBM Corporation 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: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.wst.html.internal.validation; - -import org.eclipse.core.resources.IResource; -import org.eclipse.core.runtime.CoreException; - -/** - * pa_TODO moved this class here for now to remove dependency on - * com.ibm.etools.validation. - * - * This class is intended to be used only by the validation framework. The - * TaskListHelper class will be removed in Milestone 4. - */ -public class TaskListHelper { - private static TaskListHelper _taskListHelper = null; - - public static TaskListHelper getTaskList() { - if (_taskListHelper == null) { - _taskListHelper = new TaskListHelper(); - } - return _taskListHelper; - } - - /** - * This method adds a message to a resource in the task list. - */ - public void addTask(String pluginId, IResource resource, String location, String messageId, String message, int markerType, String targetObjectName, String groupName, int offset, int length) throws CoreException { - TaskListUtility.addTask(pluginId, resource, location, messageId, message, markerType, targetObjectName, groupName, offset, length); - } - - /** - * This method removes all messages from a resource in the task list. - */ - public void removeAllTasks(IResource resource, String owner, String objectName) throws CoreException { - TaskListUtility.removeAllTasks(resource, owner, objectName); - } -}
\ No newline at end of file diff --git a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/TaskListUtility.java b/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/TaskListUtility.java deleted file mode 100644 index d23011610f..0000000000 --- a/bundles/org.eclipse.wst.html.ui/src-html-validation/org/eclipse/wst/html/internal/validation/TaskListUtility.java +++ /dev/null @@ -1,435 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2001, 2005 IBM Corporation 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: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.wst.html.internal.validation; - -import org.eclipse.core.resources.IMarker; -import org.eclipse.core.resources.IProject; -import org.eclipse.core.resources.IResource; -import org.eclipse.core.resources.IWorkspaceRoot; -import org.eclipse.core.resources.ResourcesPlugin; -import org.eclipse.core.runtime.CoreException; -import org.eclipse.wst.validation.internal.provisional.core.IMessage; - -/** - * This class must be called only by the validation framework. - * - * This singleton interacts with the eclipse workbench's Task list. - * TaskListUtility adds and removes tasks from the list. - * - * This class must not be called outside of an IWorkspaceRunnable or - * IRunnableWithProgress. Many resource deltas can be generated by the methods - * in this class. - * - * This came from com.ibm.etools.validate.internal.util.TaskListUtility - */ -public class TaskListUtility { - // private static final String PLUGIN_ID = ValidationPlugin.PLUGIN_ID; - private static final String PLUGIN_ID = "com.ibm.etools.validation";//$NON-NLS-1$ - private static final String VALIDATION_MARKER = PLUGIN_ID + ".problemmarker"; //$NON-NLS-1$ // The extension which is used to add validation markers to the task list - private static final String VALIDATION_MARKER_OWNER = "owner"; //$NON-NLS-1$ // The IValidator who owns the IMarker on the task list - private static final String VALIDATION_MARKER_SEVERITY = "validationSeverity"; //$NON-NLS-1$ // one of the IMessage values - private static final String VALIDATION_MARKER_TARGETOBJECT = "targetObject"; //$NON-NLS-1$ // When more than one target object resolves to the same IResource, this field identifies which targetObject owns a particular message. - private static final String VALIDATION_MARKER_GROUP = "groupName"; //$NON-NLS-1$ // For incremental validation, this field associates a message with a group, so that a subset of messages may be removed from a file. - private static final String VALIDATION_MARKER_MESSAGEID = "messageId"; //$NON-NLS-1$ // Persist the message id of the message, not just the translated text. - private static final int DEPTH_INFINITE = IResource.DEPTH_INFINITE; - private static final int DEPTH_ZERO = IResource.DEPTH_ZERO; - private final static IMarker[] NO_MARKERS = new IMarker[0]; - - /** - * This method adds a message to a resource in the task list. - */ - public static IMarker addTask(String pluginId, IResource resource, String location, String messageId, String message, int markerType, String targetObjectName, String groupName, int offset, int length) throws CoreException { - if ((message == null) || (resource == null)) { - return null; - } - - int severity = getSeverity(markerType); - - // Allow duplicate entries in the task list. - // Prior to a full validation, the validation framework will remove - // all messages owned - // by a validator before it is executed. - // Prior to an incremental validation, the validation framework will - // remove all messages, - // on each of the changed resources, owned by a validator before it is - // invoked. - // - // It is up to the validator to make sure that it is not adding the - // same message - // in more than one place, and also to clear out any old messages - // which are not cleared - // by the validation framework. - IMarker item = resource.createMarker(VALIDATION_MARKER); // add a - // validation - // marker - - // For performance reasons, replace the multiple setAttribute - // calls above with a single setAttributes call. - boolean offsetSet = ((offset != IMessage.OFFSET_UNSET) && (length != IMessage.OFFSET_UNSET)); - int size = (offsetSet) ? 10 : 8; // add CHAR_START, CHAR_END only - // if the offset is set. If the - // offset is set, it takes - // precendence over the line - // number. (eclipse's rule, not - // mine.) - String[] attribNames = new String[size]; - Object[] attribValues = new Object[size]; - - // Very first thing, add the owner. That way, if the code dies - // before things are persisted, hopefully this marker will be - // persisted. - // Hopefully, eclipse WILL persist this field, as requested. - attribNames[0] = VALIDATION_MARKER_OWNER; - attribValues[0] = pluginId; - attribNames[1] = VALIDATION_MARKER_SEVERITY; // this validation - // severity is stored, - // in addition to the - // marker severity, to - // enable more than - // one severity of - // message to be - // displayed. e.g. - // ERROR | WARNING - // (using binary OR). - // The IMarker - // constants are - // regular decimal - // constants. - attribValues[1] = new Integer(markerType); - attribNames[2] = VALIDATION_MARKER_TARGETOBJECT; // to distinguish - // between - // messages which - // are registered - // on an - // IResource, but - // against - // different - // target objects - attribValues[2] = ((targetObjectName == null) ? "" : targetObjectName); //$NON-NLS-1$ - attribNames[3] = VALIDATION_MARKER_GROUP; - attribValues[3] = ((groupName == null) ? "" : groupName); //$NON-NLS-1$ - attribNames[4] = IMarker.MESSAGE; - attribValues[4] = message; - attribNames[5] = VALIDATION_MARKER_MESSAGEID; - attribValues[5] = messageId; - - attribNames[6] = IMarker.SEVERITY; // IMarker.SEVERITY_ERROR, - // IMarker.SEVERITY_WARNING, - // IMarker.SEVERITY_INFO - attribValues[6] = new Integer(severity); - try { - // If the location is a line number, store it as a line number - Integer lineNumber = Integer.valueOf(location); - attribNames[7] = IMarker.LINE_NUMBER; - attribValues[7] = lineNumber; - } - catch (NumberFormatException exc) { - // Otherwise, store it as a text location - attribNames[7] = IMarker.LOCATION; - attribValues[7] = location; - } - - if (offsetSet) { - attribNames[8] = IMarker.CHAR_START; - attribValues[8] = new Integer(offset); - attribNames[9] = IMarker.CHAR_END; - attribValues[9] = new Integer(offset + length); - } - - item.setAttributes(attribNames, attribValues); - - return item; - } - - /** - * Given one of the SeverityEnum severities, return the IMarker severity - * int that is its equivalent. - */ - private static int getSeverity(int severityEnumValue) { - switch (severityEnumValue) { - case (IMessage.HIGH_SEVERITY) : { - return IMarker.SEVERITY_ERROR; - } - - case (IMessage.LOW_SEVERITY) : { - return IMarker.SEVERITY_INFO; - } - - case (IMessage.NORMAL_SEVERITY) : { - return IMarker.SEVERITY_WARNING; - } - - case (IMessage.ALL_MESSAGES) : - case (IMessage.ERROR_AND_WARNING) : - default : { - // assume it's a warning. - return IMarker.SEVERITY_WARNING; - } - } - } - - private static int getDepth(IResource resource) { - if (resource instanceof IProject) { - return DEPTH_INFINITE; // DEPTH_INFINITE means get this project's - // markers, and the markers belonging to - // the project's children. - } - else if (resource instanceof IWorkspaceRoot) { - // Needed for the ValidationMigrator when it checks for orphan - // tasks. - return DEPTH_INFINITE; // DEPTH_INFINITE means get all of the - // markers in the workspace - } - - return DEPTH_ZERO; // DEPTH_ZERO means just this resource, not its - // children - } - - private static IMarker[] getValidationTasks(IResource resource, int severity, int depth) { - IMarker[] tempMarkers = null; - int validCount = 0; - try { - IMarker[] allMarkers = null; - try { - allMarkers = resource.findMarkers(VALIDATION_MARKER, false, depth); // false - // means - // only - // consider - // PROBLEM_MARKER, - // not - // variants - // of - // PROBLEM_MARKER. - // Since - // addTask - // only - // adds - // PROBLEM_MARKER, - // we - // don't - // need - // to - // consider - // its - // subtypes. - } - catch (CoreException exc) { - // Logger logger = - // ValidationPlugin.getPlugin().getMsgLogger(); - // if (logger.isLoggingLevel(Level.SEVERE)) { - // LogEntry entry = ValidationPlugin.getLogEntry(); - // entry.setSourceID("TaskListUtility.getValidationTasks(IResource, - // int)"); //$NON-NLS-1$ - // entry.setTargetException(exc); - // logger.write(Level.SEVERE, entry); - // } - return NO_MARKERS; - } - - // Now filter in the markers, based on severity type. - if (allMarkers.length != 0) { - tempMarkers = new IMarker[allMarkers.length]; - for (int i = 0; i < allMarkers.length; i++) { - IMarker marker = allMarkers[i]; - Integer filterSeverity = (Integer) marker.getAttribute(VALIDATION_MARKER_SEVERITY); - if (filterSeverity == null) { - // odd...marker wasn't created correctly. How could - // this happen? - // Default to the current severity and add it to the - // list. - try { - marker.setAttribute(IMarker.SEVERITY, getSeverity(severity)); - } - catch (CoreException exc) { - // Logger logger = - // ValidationPlugin.getPlugin().getMsgLogger(); - // if (logger.isLoggingLevel(Level.SEVERE)) { - // LogEntry entry = - // ValidationPlugin.getLogEntry(); - // entry.setSourceID("TaskListUtility.getValidationTasks(int, - // IResource, int)"); //$NON-NLS-1$ - // entry.setTargetException(exc); - // logger.write(Level.SEVERE, entry); - // } - continue; - } - catch (Throwable exc) { - // Logger logger = - // ValidationPlugin.getPlugin().getMsgLogger(); - // if (logger.isLoggingLevel(Level.SEVERE)) { - // LogEntry entry = - // ValidationPlugin.getLogEntry(); - // entry.setSourceID("TaskListUtility.getValidationTasks(int, - // IResource, int)"); //$NON-NLS-1$ - // entry.setTargetException(exc); - // logger.write(Level.SEVERE, entry); - // } - continue; - } - } - else if ((severity & filterSeverity.intValue()) == 0) { - continue; - } - tempMarkers[validCount++] = marker; - } - } - } - catch (CoreException exc) { - // Logger logger = ValidationPlugin.getPlugin().getMsgLogger(); - // if (logger.isLoggingLevel(Level.SEVERE)) { - // LogEntry entry = ValidationPlugin.getLogEntry(); - // entry.setSourceID("TaskListUtility.getValidationTasks(int, - // IResource, int)"); //$NON-NLS-1$ - // entry.setTargetException(exc); - // logger.write(Level.SEVERE, entry); - // } - } - - if (validCount == 0) { - return NO_MARKERS; - } - - IMarker[] validMarkers = new IMarker[validCount]; - System.arraycopy(tempMarkers, 0, validMarkers, 0, validCount); - return validMarkers; - } - - private static IMarker[] getValidationTasks(IResource resource, String[] messageOwners, int depth) { - IMarker[] markers = getValidationTasks(resource, IMessage.ALL_MESSAGES, depth); - if (markers.length == 0) { - return NO_MARKERS; - } - - IMarker[] temp = new IMarker[markers.length]; - int validCount = 0; - for (int i = 0; i < markers.length; i++) { - IMarker marker = markers[i]; - - try { - Object owner = marker.getAttribute(VALIDATION_MARKER_OWNER); - if ((owner == null) || !(owner instanceof String)) { - // The ValidationMigrator will remove any "unowned" - // validation markers. - continue; - } - - for (int j = 0; j < messageOwners.length; j++) { - String messageOwner = messageOwners[j]; - if (((String) owner).equals(messageOwner)) { - temp[validCount++] = marker; - break; - } - } - } - catch (CoreException exc) { - // Logger logger = - // ValidationPlugin.getPlugin().getMsgLogger(); - // if (logger.isLoggingLevel(Level.SEVERE)) { - // LogEntry entry = ValidationPlugin.getLogEntry(); - // entry.setSourceID("TaskListUtility.getValidationTasks(project, - // String[])"); //$NON-NLS-1$ - // entry.setTargetException(exc); - // logger.write(Level.SEVERE, entry); - // } - return NO_MARKERS; - } - } - - IMarker[] result = new IMarker[validCount]; - System.arraycopy(temp, 0, result, 0, validCount); - return result; - } - - /** - * This method retrieves all validation tasks from the resource. If depth - * is INFINITE, child tasks are returned as well. Only the tasks which are - * owned by the specified messageOwner, and apply to the named IMessage's - * target object (objectName) will be returned. - */ - private static IMarker[] getValidationTasks(IResource resource, String[] messageOwner, String objectName, String groupName, int depth) throws CoreException { - if ((messageOwner == null) || (resource == null)) { - return NO_MARKERS; - } - - int validCount = 0; - IMarker[] validList = null; - IMarker[] markers = getValidationTasks(resource, messageOwner, depth); - if (markers != null) { - validList = new IMarker[markers.length]; - for (int i = 0; i < markers.length; i++) { - IMarker marker = markers[i]; - - // If more than one target object resolves to the same - // resource, removing one target's - // messages should not remove the other target object's - // messages. - if (objectName != null) { - Object targetObject = marker.getAttribute(VALIDATION_MARKER_TARGETOBJECT); - if ((targetObject == null) || !(targetObject instanceof String) || !(((String) targetObject).equals(objectName))) { - continue; - } - } - - if (groupName != null) { - Object group = marker.getAttribute(VALIDATION_MARKER_GROUP); - if ((group == null) || !(group instanceof String) || !(((String) group).equals(groupName))) { - continue; - } - } - - validList[validCount++] = marker; - } - } - - if (validCount == 0) { - return NO_MARKERS; - } - - IMarker[] result = new IMarker[validCount]; - System.arraycopy(validList, 0, result, 0, validCount); - return result; - } - - /** - * This method removes all messages from a resource in the task list. - */ - public static void removeAllTasks(IResource resource, String owner, String objectName) throws CoreException { - removeAllTasks(resource, new String[]{owner}, objectName); - } - - public static void removeAllTasks(IResource resource, String[] owners, String objectName) throws CoreException { - removeAllTasks(resource, owners, objectName, getDepth(resource)); - } - - protected static void removeAllTasks(IResource resource, String[] owners, String objectName, int depth) throws CoreException { - removeTaskSubset(resource, owners, objectName, null, depth); // null - // means - // no - // group - // name - } - - /** - * This method removes a subset of tasks from the project, including child - * tasks. Every task which belongs to the group, identified by groupName, - * will be removed. - */ - protected static void removeTaskSubset(IResource resource, String[] owners, String objectName, String groupName, int depth) throws CoreException { - if ((owners == null) || (resource == null)) { - return; - } - - IMarker[] allTasks = getValidationTasks(resource, owners, objectName, groupName, depth); - if (allTasks.length > 0) { - ResourcesPlugin.getWorkspace().deleteMarkers(allTasks); - } - } -}
\ No newline at end of file |