Copyright (c) 2016 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation
/*******************************************************************************
 * Copyright (c) 2016 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jdt.internal.core.manipulation.util;

import java.io.File;

import org.eclipse.osgi.util.TextProcessor;

import org.eclipse.core.runtime.IPath;

import org.eclipse.core.resources.IResource;

import org.eclipse.jdt.core.ITypeRoot;

A label provider for basic elements like paths. The label provider will make sure that the labels are correctly
shown in RTL environments.
/**
 * A label provider for basic elements like paths. The label provider will make sure that the labels are correctly
 * shown in RTL environments.
 */
// @see JDTUIHelperClasses
// @see org.eclipse.jdt.internal.ui.viewsupport.BasicElementLabels (subclass of this one)
public class BasicElementLabels {


	// TextProcessor delimiters
	private static final String CODE_DELIMITERS= TextProcessor.getDefaultDelimiters() + "<>()?,{}+-*!%=^|&;[]~"; //$NON-NLS-1$
	private static final String FILE_PATTERN_DELIMITERS= TextProcessor.getDefaultDelimiters() + "*.?"; //$NON-NLS-1$
	private static final String URL_DELIMITERS= TextProcessor.getDefaultDelimiters() + ":@?-"; //$NON-NLS-1$

	
	
Returns the label of a path.
Params:
path – the path
isOSPath – if true, the path represents an OS path, if false it is a workspace path.
Returns:
the label of the path to be used in the UI./**
	 * 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 Strings.markLTR(label);
	}

	
Returns the label of the path of a file.
Params:
file – the file
Returns:
the label of the file path to be used in the UI./**
	 * 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 Strings.markLTR(file.getAbsolutePath());
	}

	
Returns the label for a file pattern like '*.java'
Params:
name – the pattern
Returns:
the label of the pattern./**
	 * 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 Strings.markLTR(name, FILE_PATTERN_DELIMITERS);
	}

	
Returns the label for a URL, URI or URL part. Example is 'http://www.x.xom/s.html#1'
Params:
name – the URL string
Returns:
the label of the URL./**
	 * 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 Strings.markLTR(name, URL_DELIMITERS);
	}

	
Returns a label for a resource name.
Params:
resource – the resource
Returns:
the label of the resource name./**
	 * 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 Strings.markLTR(resource.getName());
	}

	
Returns a label for a resource name.
Params:
resourceName – the resource name
Returns:
the label of the resource name./**
	 * 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 Strings.markLTR(resourceName);
	}

	
Returns a label for a type root name which is a file name.
Params:
typeRoot – the typeRoot
Returns:
the label of the resource name./**
	 * 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(ITypeRoot typeRoot) {
		return Strings.markLTR(typeRoot.getElementName());
	}

	
Returns a label for Java element name. Example is 'new Test() { ...}'.
This method should only be used for simple element names. Use
org.eclipse.jdt.ui.JavaElementLabels to create a label from a Java element or
org.eclipse.jdt.internal.ui.viewsupport.BindingLabelProvider for labels of bindings.
Params:
name – the Java element name.
Returns:
the label for the Java element/**
	 * Returns a label for Java element name. Example is 'new Test<? extends List>() { ...}'.
	 * This method should only be used for simple element names. Use
	 * org.eclipse.jdt.ui.JavaElementLabels to create a label from a Java element or
	 * org.eclipse.jdt.internal.ui.viewsupport.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 Strings.markJavaElementLabelLTR(name);
	}

	
Returns a label for Java code snippet used in a label. Example is 'Test test= new Test() { ...}'.
Params:
string – the Java code snippet
Returns:
the label for the Java code snippet/**
	 * 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 Strings.markLTR(string, CODE_DELIMITERS);
	}

	
Returns a label for a version name. Example is '1.4.1'
Params:
name – the version string
Returns:
the version label/**
	 * 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 Strings.markLTR(name);
	}
}