core/plugins/org.eclipse.dltk.ui/src/org/eclipse/dltk/ui/viewsupport/BasicElementLabels.java

/*******************************************************************************
 * Copyright (c) 2009 xored software, Inc.
 *
 * 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:
 *     xored software, Inc. - initial API and Implementation (Alex Panchenko)
 *******************************************************************************/
package org.eclipse.dltk.ui.viewsupport;

import java.io.File;

import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.IPath;
import org.eclipse.dltk.core.ISourceModule;
import org.eclipse.ui.IWorkingSet;

/**
 * A label provider for basic elements like paths. The label provider will make
 * sure that the labels are correctly shown in RTL environments.
 */
public class BasicElementLabels {

	/**
	 * Returns the label of a path.
	 * 
	 * @param path
	 *            the path
	 * @param isOSPath
	 *            if <code>true</code>, the path represents an OS path, if
	 *            <code>false</code> it is a workspace path.
	 * @return the label of the path to be used in the UI.
	 */
	public static String getPathLabel(IPath path, boolean isOSPath) {
		String label;
		if (isOSPath) {
			label = path.toOSString();
		} else {
			label = path.makeRelative().toString();
		}
		return markLTR(label);
	}

	/**
	 * Returns the label of the path of a file.
	 * 
	 * @param file
	 *            the file
	 * @return the label of the file path to be used in the UI.
	 */
	public static String getPathLabel(File file) {
		return markLTR(file.getAbsolutePath(), ""); //$NON-NLS-1$
	}

	/**
	 * Returns the label for a file pattern like '*.java'
	 * 
	 * @param name
	 *            the pattern
	 * @return the label of the pattern.
	 */
	public static String getFilePattern(String name) {
		return markLTR(name, "*.?"); //$NON-NLS-1$
	}

	/**
	 * Returns the label for a URL, URI or URL part. Example is
	 * 'http://www.x.xom/s.html#1'
	 * 
	 * @param name
	 *            the URL string
	 * @return the label of the URL.
	 */
	public static String getURLPart(String name) {
		return markLTR(name, ":@?-"); //$NON-NLS-1$
	}

	/**
	 * Returns a label for a resource name.
	 * 
	 * @param resource
	 *            the resource
	 * @return the label of the resource name.
	 */
	public static String getResourceName(IResource resource) {
		return markLTR(resource.getName());
	}

	/**
	 * Returns a label for a resource name.
	 * 
	 * @param resourceName
	 *            the resource name
	 * @return the label of the resource name.
	 */
	public static String getResourceName(String resourceName) {
		return markLTR(resourceName);
	}

	/**
	 * Returns a label for a type root name which is a file name.
	 * 
	 * @param typeRoot
	 *            the typeRoot
	 * @return the label of the resource name.
	 */
	public static String getFileName(ISourceModule typeRoot) {
		return markLTR(typeRoot.getElementName());
	}

	/**
	 * Returns a label for Java element name. Example is 'new Test<? extends
	 * List>() { ...}'. This method should only be used for simple element
	 * names. Use {@link JavaElementLabels} to create a label from a Java
	 * element or {@link BindingLabelProvider} for labels of bindings.
	 * 
	 * @param name
	 *            the Java element name.
	 * @return the label for the Java element
	 */
	public static String getJavaElementName(String name) {
		return markLTR(name, "<>()?,{}"); //$NON-NLS-1$
	}

	/**
	 * Returns a label for Java code snippet used in a label. Example is 'Test
	 * test= new Test<? extends List>() { ...}'.
	 * 
	 * @param string
	 *            the Java code snippet
	 * @return the label for the Java code snippet
	 */
	public static String getJavaCodeString(String string) {
		return markLTR(string, "<>()?,{}+-*!%="); //$NON-NLS-1$
	}

	/**
	 * Returns a label for a version name. Example is '1.4.1'
	 * 
	 * @param name
	 *            the version string
	 * @return the version label
	 */
	public static String getVersionName(String name) {
		return markLTR(name);
	}

	/**
	 * Returns a label for a working set
	 * 
	 * @param set
	 *            the working set
	 * @return the label of the working set
	 */
	public static String getWorkingSetLabel(IWorkingSet set) {
		return markLTR(set.getLabel(), ""); //$NON-NLS-1$
	}

	/**
	 * Adds special marks so that that the given string is readable in a BIDI
	 * environment.
	 * 
	 * @param string
	 *            the string
	 * @return the processed styled string
	 */
	private static String markLTR(String string) {
		return string;
	}

	/**
	 * Adds special marks so that that the given string is readable in a BIDI
	 * environment.
	 * 
	 * @param string
	 *            the string
	 * @param additionalDelimiters
	 *            the additional delimiters
	 * @return the processed styled string
	 */
	private static String markLTR(String string, String additionalDelimiters) {
		return string;
	}

}