bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/registry/EditorRegistryReader.java

package org.eclipse.ui.internal.registry;

/*
 * (c) Copyright IBM Corp. 2000, 2001.
 * All Rights Reserved.
 */
import org.eclipse.core.runtime.*;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.internal.IWorkbenchConstants;
import org.eclipse.ui.internal.WorkbenchImages;
import org.eclipse.ui.internal.misc.*;
import org.eclipse.jface.resource.ImageDescriptor;

import java.util.*;

/**
 * This class is used to read resource editor registry descriptors from
 * the platform registry.
 */
public class EditorRegistryReader extends RegistryReader {
	
	private static final    String      PARAMETER_SEPARATOR = ",";//$NON-NLS-1$
	private static final    String      ATT_CLASS = "class";//$NON-NLS-1$
	private static final    String      ATT_NAME = "name";//$NON-NLS-1$
	private static final    String      TAG_EDITOR = "editor";//$NON-NLS-1$
	private static final    String      P_EXTERNAL = "external";//$NON-NLS-1$
	private static final    String      P_TRUE = "true";//$NON-NLS-1$
	private static final    String      ATT_COMMAND = "command";//$NON-NLS-1$
	private static final    String      ATT_LAUNCHER = "launcher";//$NON-NLS-1$
	private static final    String      ATT_DEFAULT = "default";//$NON-NLS-1$
	public  static final    String      ATT_ID = "id";//$NON-NLS-1$
	private static final    String      ATT_ICON = "icon";//$NON-NLS-1$
	private static final   String       ATT_EXTENSIONS = "extensions";//$NON-NLS-1$
	private static final   String       ATT_FILENAMES = "filenames";//$NON-NLS-1$
	private EditorRegistry editorRegistry;
/**
 * Get the editors that are defined in the registry
 * and add them to the ResourceEditorRegistry
 * The readAll flag indicates if we should read non modified plugins
 *
 * Warning:
 * The registry must be passed in because this method is called during the
 * process of setting up the registry and at this time it has not been
 * safely setup with the plugin.
 */
protected void addEditors(boolean readAll, EditorRegistry registry) {
	IPluginRegistry pluginRegistry = Platform.getPluginRegistry();
	this.editorRegistry = registry;
	readRegistry(pluginRegistry, PlatformUI.PLUGIN_ID, IWorkbenchConstants.PL_EDITOR);
}
/**
 * Implementation of the abstract method that
 * processes one configuration element.
 */
protected boolean readElement(IConfigurationElement element) {
	if (!element.getName().equals(TAG_EDITOR)) 
		return false;

	EditorDescriptor editor = new EditorDescriptor();
	editor.setConfigurationElement(element);
	String id = element.getAttribute(ATT_ID);
	if (id == null) {
		logMissingAttribute(element, ATT_ID);
		return true;
	}
	editor.setID(id);
	IExtension extension = element.getDeclaringExtension();
	editor.setPluginIdentifier(extension.getDeclaringPluginDescriptor().getUniqueIdentifier());

	List extensionsVector = new ArrayList();
	List filenamesVector = new ArrayList();
	boolean defaultEditor = false;

	// Get editor name (required field).
	String name = element.getAttribute(ATT_NAME);
	if (name == null) {
		logMissingAttribute(element, ATT_NAME);
		return true;
	}
	editor.setName(name);

	// Get editor icon (required field for internal editors)
	String icon = element.getAttribute(ATT_ICON);
	if (icon == null) {
		if (element.getAttribute(ATT_CLASS) != null) {
			logMissingAttribute(element, ATT_ICON);
			return true;
		}
	}
	if (icon != null) {
		editor.setImageDescriptor(WorkbenchImages.getImageDescriptorFromExtension(extension, icon));
		editor.setImageFilename(icon);
	}
	
	// Get target extensions (optional field)
	String extensionsString = element.getAttribute(ATT_EXTENSIONS);
	if (extensionsString != null) {
		StringTokenizer tokenizer = new StringTokenizer(extensionsString, ",");//$NON-NLS-1$
		while (tokenizer.hasMoreTokens()) {
			extensionsVector.add(tokenizer.nextToken().trim());
		}
	}
	String filenamesString = element.getAttribute(ATT_FILENAMES);
	if (filenamesString != null) {
		StringTokenizer tokenizer = new StringTokenizer(filenamesString, ",");//$NON-NLS-1$
		while (tokenizer.hasMoreTokens()) {
			filenamesVector.add(tokenizer.nextToken().trim());
		}
	}

	// Get launcher class or command.	
	String launcher = element.getAttribute(ATT_LAUNCHER);
	String command = element.getAttribute(ATT_COMMAND);
	if (launcher != null) {
		// open using a launcer
		editor.setLauncher(launcher);
		editor.setInternal(false);
		
	} else if (command != null) {
	   	// open using an external editor 	
	   	editor.setFileName(command);
   		if (icon == null) 
		   editor.setImageDescriptor(WorkbenchImages.getImageDescriptorFromProgram(command, 0));
	   	editor.setInternal(false);
	} else {
		// open using an internal editor
		String className = element.getAttribute(ATT_CLASS);
		editor.setClassName(className);
		editor.setInternal(true);
	}

	// Is this the default editor?
	String def = element.getAttribute(ATT_DEFAULT);
	if (def != null) 
		defaultEditor = def.equalsIgnoreCase(P_TRUE);
				
	// Add the editor to the manager.	
	editorRegistry.addEditorFromPlugin(editor, extensionsVector, filenamesVector, defaultEditor);
	return true;
}
}