core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CElementImageDescriptor.java - cdt/org.eclipse.cdt - Git at Google

 /*******************************************************************************
  * Copyright (c) 2000, 2013 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
  *     QNX Software System
  *     Markus Schorn (Wind River Systems)
  *     Anton Leherbauer (Wind River Systems)
  *******************************************************************************/
 package org.eclipse.cdt.ui;

 import org.eclipse.cdt.internal.ui.CPluginImages;
 import org.eclipse.cdt.internal.ui.viewsupport.CustomBuildSettingsDecorator;
 import org.eclipse.core.runtime.Assert;
 import org.eclipse.jface.resource.CompositeImageDescriptor;
 import org.eclipse.jface.resource.ImageDescriptor;
 import org.eclipse.swt.graphics.ImageData;
 import org.eclipse.swt.graphics.Point;

 /**
  * A CImageDescriptor consists of a base image and several adornments. The adornments
  * are computed according to the flags either passed during creation or set via the method
  * <code>setAdornments</code>.
  * </p>
  * It is guaranteed that objects that conform to this interface are also instances of type
  * <code>ImageDescriptor</code>
  * </p>
  * <b>Note:</b> This class/interface is part of an interim API that is still under development
  * and expected to change before reaching stability.
  * </p>
  *
  * @since 2.0
  */
 public class CElementImageDescriptor extends CompositeImageDescriptor {

 	/** Flag to render the abstract adornment */
 	public final static int TEMPLATE = 0x001;

 	/** Flag to render the const adornment */
 	public final static int CONSTANT = 0x002;

 	/** Flag to render the volatile adornment */
 	public final static int VOLATILE = 0x004;

 	/** Flag to render the static adornment */
 	public final static int STATIC = 0x008;

 	/**
 	 * @deprecated flag never had an effect
 	 */
 	@Deprecated
 	public final static int RUNNABLE = 0x010;

 	/** Flag to render the warning adornment */
 	public final static int WARNING = 0x020;

 	/** Flag to render the error adornment */
 	public final static int ERROR = 0x040;

 	/**
 	 * @deprecated flag never had an effect
 	 */
 	@Deprecated
 	public final static int OVERRIDES = 0x080;

 	/**
 	 * @deprecated flag never had an effect
 	 */
 	@Deprecated
 	public final static int IMPLEMENTS = 0x100;

 	/** Flag to render the 'relates to' adornment (for trees, an arrow down) */
 	public final static int RELATES_TO = 0x200;

 	/** Flag to render the 'relates to' adornment (for trees, two arrows down) */
 	public final static int RELATES_TO_MULTIPLE = 0x400;

 	/** Flag to render the 'referenced by' adornment (for trees, an arrow up) */
 	public final static int REFERENCED_BY = 0x800;

 	/** Flag to render the 'recursive relation' adornment (for trees, an arrow pointing back) */
 	public final static int RECURSIVE_RELATION = 0x1000;

 	/** Flag to render the 'system include' adornment */
 	public final static int SYSTEM_INCLUDE = 0x2000;

 	/** Flag to render the 'defines' adornment in the type hierarchy*/
 	public final static int DEFINES = 0x4000;

 	/** Flag to render the 'inactive' adornment for include directives */
 	public final static int INACTIVE = 0x8000;

 	/** Flag to render the 'read access' adornment for references to variables or fields */
 	public static final int READ_ACCESS = 0x10000;

 	/** Flag to render the 'read access' adornment for references to variables or fields */
 	public static final int WRITE_ACCESS = 0x20000;

 	/** Flag to render the 'external file' adornment for translation units */
 	public static final int EXTERNAL_FILE = 0x40000;

 	/** Flag to render the 'custom settings' adornment. Do not use, this flag has been discontinued.
 	 * @since 5.2
 	 * @deprecated The constant has been discontinued since CDT 8.1. The adornment moved to separate class
 	 *    {@link CustomBuildSettingsDecorator}.
 	 */
 	@Deprecated
 	public final static int SETTINGS = 0x80000;

 	private ImageDescriptor fBaseImage;
 	private int fFlags;
 	private Point fSize;

 	/**
 	 * Create a new CElementImageDescriptor.
 	 *
 	 * @param baseImage an image descriptor used as the base image
 	 * @param flags flags indicating which adornments are to be rendered. See <code>setAdornments</code>
 	 * 	for valid values.
 	 * @param size the size of the resulting image
 	 * @see #setAdornments(int)
 	 */
 	public CElementImageDescriptor(ImageDescriptor baseImage, int flags, Point size) {
 		fBaseImage = baseImage;
 		Assert.isNotNull(fBaseImage);
 		fFlags = flags;
 		Assert.isTrue(fFlags >= 0);
 		fSize = size;
 		Assert.isNotNull(fSize);
 	}

 	/**
 	 * Sets the descriptors adornments. Valid values are: <code>ABSTRACT</code>, <code>FINAL</code>,
 	 * </code>STATIC<code>, </code>WARNING<code>,
 	 * </code>ERROR<code>, or any combination of those.
 	 *
 	 * @param adornments the image descritpors adornments
 	 */
 	public void setAdornments(int adornments) {
 		Assert.isTrue(adornments >= 0);
 		fFlags = adornments;
 	}

 	/**
 	 * Returns the current adornments.
 	 *
 	 * @return the current adornments
 	 */
 	public int getAdronments() {
 		return fFlags;
 	}

 	/**
 	 * Sets the size of the image created by calling <code>createImage()</code>.
 	 *
 	 * @param size the size of the image returned from calling <code>createImage()</code>
 	 */
 	public void setImageSize(Point size) {
 		Assert.isNotNull(size);
 		Assert.isTrue(size.x >= 0 && size.y >= 0);
 		fSize = size;
 	}

 	/**
 	 * Returns the size of the image created by calling <code>createImage()</code>.
 	 *
 	 * @return the size of the image created by calling <code>createImage</code>
 	 */
 	public Point getImageSize() {
 		return new Point(fSize.x, fSize.y);
 	}

 	/* (non-Javadoc)
 	 * Method declared in CompositeImageDescriptor
 	 */
 	@Override
 	protected Point getSize() {
 		return fSize;
 	}

 	/* (non-Javadoc)
 	 * Method declared on Object.
 	 */
 	@Override
 	public boolean equals(Object object) {
 		if (!CElementImageDescriptor.class.equals(object.getClass()))
 			return false;

 		CElementImageDescriptor other = (CElementImageDescriptor) object;
 		return (fBaseImage.equals(other.fBaseImage) && fFlags == other.fFlags && fSize.equals(other.fSize));
 	}

 	/* (non-Javadoc)
 	 * Method declared on Object.
 	 */
 	@Override
 	public int hashCode() {
 		return fBaseImage.hashCode() | fFlags | fSize.hashCode();
 	}

 	/* (non-Javadoc)
 	 * Method declared in CompositeImageDescriptor
 	 */
 	@Override
 	protected void drawCompositeImage(int width, int height) {
 		ImageData bg;
 		if ((bg = fBaseImage.getImageData()) == null)
 			bg = DEFAULT_IMAGE_DATA;

 		drawImage(bg, 0, 0);
 		drawTopRight();
 		drawBottomRight();
 		drawBottomLeft();
 		drawTopLeft();
 	}

 	private void drawTopRight() {
 		int x = getSize().x;
 		ImageData data = null;
 		if ((fFlags & VOLATILE) != 0) {
 			data = CPluginImages.DESC_OVR_VOLATILE.getImageData();
 			x -= data.width;
 			drawImage(data, x, 0);
 		}
 		if ((fFlags & CONSTANT) != 0) {
 			data = CPluginImages.DESC_OVR_CONSTANT.getImageData();
 			x -= data.width;
 			drawImage(data, x, 0);
 		}
 		if ((fFlags & STATIC) != 0) {
 			data = CPluginImages.DESC_OVR_STATIC.getImageData();
 			x -= data.width;
 			drawImage(data, x, 0);
 		}
 		if ((fFlags & TEMPLATE) != 0) {
 			data = CPluginImages.DESC_OVR_TEMPLATE.getImageData();
 			x -= data.width;
 			drawImage(data, x, 0);
 		}
 		if ((fFlags & SYSTEM_INCLUDE) != 0) {
 			data = CPluginImages.DESC_OVR_SYSTEM_INCLUDE.getImageData();
 			x -= data.width;
 			drawImage(data, x, 0);
 		}
 	}

 	private void drawBottomRight() {
 		Point size = getSize();
 		int x = size.x;
 		ImageData data = null;
 		if ((fFlags & RECURSIVE_RELATION) != 0) {
 			data = CPluginImages.DESC_OVR_REC_RELATESTO.getImageData();
 			x -= data.width;
 			drawImage(data, x, size.y - data.height);
 		} else if ((fFlags & RELATES_TO) != 0) {
 			data = CPluginImages.DESC_OVR_RELATESTO.getImageData();
 			x -= data.width;
 			drawImage(data, x, size.y - data.height);
 		} else if ((fFlags & RELATES_TO_MULTIPLE) != 0) {
 			data = CPluginImages.DESC_OVR_RELATESTOMULTIPLE.getImageData();
 			x -= data.width;
 			drawImage(data, x, size.y - data.height);
 		} else if ((fFlags & REFERENCED_BY) != 0) {
 			data = CPluginImages.DESC_OVR_REFERENCEDBY.getImageData();
 			x -= data.width;
 			drawImage(data, x, size.y - data.height);
 		}
 		//		if ((fFlags & OVERRIDES) != 0) {
 		//			data= CPluginImages.DESC_OVR_OVERRIDES.getImageData();
 		//			x-= data.width;
 		//			drawImage(data, x, size.y - data.height);
 		//		}
 		//		if ((fFlags & IMPLEMENTS) != 0) {
 		//			data= CPluginImages.DESC_OVR_IMPLEMENTS.getImageData();
 		//			x-= data.width;
 		//			drawImage(data, x, size.y - data.height);
 		//		}
 	}

 	private void drawTopLeft() {
 		ImageData data = null;
 		if ((fFlags & DEFINES) != 0) {
 			data = CPluginImages.DESC_OVR_DEFINES.getImageData();
 			drawImage(data, 0, 0);
 		}
 		if ((fFlags & INACTIVE) != 0) {
 			data = CPluginImages.DESC_OVR_INACTIVE.getImageData();
 			drawImage(data, 0, 0);
 		}

 		final boolean isReadAccess = (fFlags & READ_ACCESS) != 0;
 		final boolean isWriteAccess = (fFlags & WRITE_ACCESS) != 0;
 		if (isReadAccess) {
 			if (isWriteAccess) {
 				data = CPluginImages.DESC_OVR_READ_WRITE_ACCESS.getImageData();
 			} else {
 				data = CPluginImages.DESC_OVR_READ_ACCESS.getImageData();
 			}
 			drawImage(data, 0, 0);
 		} else if (isWriteAccess) {
 			data = CPluginImages.DESC_OVR_WRITE_ACCESS.getImageData();
 			drawImage(data, 0, 0);
 		}

 		if ((fFlags & EXTERNAL_FILE) != 0) {
 			data = CPluginImages.DESC_OVR_EXTERNAL_FILE.getImageData();
 			drawImage(data, 0, 0);
 		}
 	}

 	private void drawBottomLeft() {
 		Point size = getSize();
 		int x = 0;
 		ImageData data = null;
 		if ((fFlags & ERROR) != 0) {
 			data = CPluginImages.DESC_OVR_ERROR.getImageData();
 			drawImage(data, x, size.y - data.height);
 			x += data.width;
 		}
 		if ((fFlags & WARNING) != 0) {
 			data = CPluginImages.DESC_OVR_WARNING.getImageData();
 			drawImage(data, x, size.y - data.height);
 			x += data.width;
 		}
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2000, 2013 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
	* QNX Software System
	* Markus Schorn (Wind River Systems)
	* Anton Leherbauer (Wind River Systems)
	*******************************************************************************/
	package org.eclipse.cdt.ui;

	import org.eclipse.cdt.internal.ui.CPluginImages;
	import org.eclipse.cdt.internal.ui.viewsupport.CustomBuildSettingsDecorator;
	import org.eclipse.core.runtime.Assert;
	import org.eclipse.jface.resource.CompositeImageDescriptor;
	import org.eclipse.jface.resource.ImageDescriptor;
	import org.eclipse.swt.graphics.ImageData;
	import org.eclipse.swt.graphics.Point;

	/**
	* A CImageDescriptor consists of a base image and several adornments. The adornments
	* are computed according to the flags either passed during creation or set via the method
	* <code>setAdornments</code>.
	* </p>
	* It is guaranteed that objects that conform to this interface are also instances of type
	* <code>ImageDescriptor</code>
	* </p>
	* <b>Note:</b> This class/interface is part of an interim API that is still under development
	* and expected to change before reaching stability.
	* </p>
	*
	* @since 2.0
	*/
	public class CElementImageDescriptor extends CompositeImageDescriptor {

	/** Flag to render the abstract adornment */
	public final static int TEMPLATE = 0x001;

	/** Flag to render the const adornment */
	public final static int CONSTANT = 0x002;

	/** Flag to render the volatile adornment */
	public final static int VOLATILE = 0x004;

	/** Flag to render the static adornment */
	public final static int STATIC = 0x008;

	/**
	* @deprecated flag never had an effect
	*/
	@Deprecated
	public final static int RUNNABLE = 0x010;

	/** Flag to render the warning adornment */
	public final static int WARNING = 0x020;

	/** Flag to render the error adornment */
	public final static int ERROR = 0x040;

	/**
	* @deprecated flag never had an effect
	*/
	@Deprecated
	public final static int OVERRIDES = 0x080;

	/**
	* @deprecated flag never had an effect
	*/
	@Deprecated
	public final static int IMPLEMENTS = 0x100;

	/** Flag to render the 'relates to' adornment (for trees, an arrow down) */
	public final static int RELATES_TO = 0x200;

	/** Flag to render the 'relates to' adornment (for trees, two arrows down) */
	public final static int RELATES_TO_MULTIPLE = 0x400;

	/** Flag to render the 'referenced by' adornment (for trees, an arrow up) */
	public final static int REFERENCED_BY = 0x800;

	/** Flag to render the 'recursive relation' adornment (for trees, an arrow pointing back) */
	public final static int RECURSIVE_RELATION = 0x1000;

	/** Flag to render the 'system include' adornment */
	public final static int SYSTEM_INCLUDE = 0x2000;

	/** Flag to render the 'defines' adornment in the type hierarchy*/
	public final static int DEFINES = 0x4000;

	/** Flag to render the 'inactive' adornment for include directives */
	public final static int INACTIVE = 0x8000;

	/** Flag to render the 'read access' adornment for references to variables or fields */
	public static final int READ_ACCESS = 0x10000;

	/** Flag to render the 'read access' adornment for references to variables or fields */
	public static final int WRITE_ACCESS = 0x20000;

	/** Flag to render the 'external file' adornment for translation units */
	public static final int EXTERNAL_FILE = 0x40000;

	/** Flag to render the 'custom settings' adornment. Do not use, this flag has been discontinued.
	* @since 5.2
	* @deprecated The constant has been discontinued since CDT 8.1. The adornment moved to separate class
	* {@link CustomBuildSettingsDecorator}.
	*/
	@Deprecated
	public final static int SETTINGS = 0x80000;

	private ImageDescriptor fBaseImage;
	private int fFlags;
	private Point fSize;

	/**
	* Create a new CElementImageDescriptor.
	*
	* @param baseImage an image descriptor used as the base image
	* @param flags flags indicating which adornments are to be rendered. See <code>setAdornments</code>
	* for valid values.
	* @param size the size of the resulting image
	* @see #setAdornments(int)
	*/
	public CElementImageDescriptor(ImageDescriptor baseImage, int flags, Point size) {
	fBaseImage = baseImage;
	Assert.isNotNull(fBaseImage);
	fFlags = flags;
	Assert.isTrue(fFlags >= 0);
	fSize = size;
	Assert.isNotNull(fSize);
	}

	/**
	* Sets the descriptors adornments. Valid values are: <code>ABSTRACT</code>, <code>FINAL</code>,
	* </code>STATIC<code>, </code>WARNING<code>,
	* </code>ERROR<code>, or any combination of those.
	*
	* @param adornments the image descritpors adornments
	*/
	public void setAdornments(int adornments) {
	Assert.isTrue(adornments >= 0);
	fFlags = adornments;
	}

	/**
	* Returns the current adornments.
	*
	* @return the current adornments
	*/
	public int getAdronments() {
	return fFlags;
	}

	/**
	* Sets the size of the image created by calling <code>createImage()</code>.
	*
	* @param size the size of the image returned from calling <code>createImage()</code>
	*/
	public void setImageSize(Point size) {
	Assert.isNotNull(size);
	Assert.isTrue(size.x >= 0 && size.y >= 0);
	fSize = size;
	}

	/**
	* Returns the size of the image created by calling <code>createImage()</code>.
	*
	* @return the size of the image created by calling <code>createImage</code>
	*/
	public Point getImageSize() {
	return new Point(fSize.x, fSize.y);
	}

	/* (non-Javadoc)
	* Method declared in CompositeImageDescriptor
	*/
	@Override
	protected Point getSize() {
	return fSize;
	}

	/* (non-Javadoc)
	* Method declared on Object.
	*/
	@Override
	public boolean equals(Object object) {
	if (!CElementImageDescriptor.class.equals(object.getClass()))
	return false;

	CElementImageDescriptor other = (CElementImageDescriptor) object;
	return (fBaseImage.equals(other.fBaseImage) && fFlags == other.fFlags && fSize.equals(other.fSize));
	}

	/* (non-Javadoc)
	* Method declared on Object.
	*/
	@Override
	public int hashCode() {
	return fBaseImage.hashCode() \| fFlags \| fSize.hashCode();
	}

	/* (non-Javadoc)
	* Method declared in CompositeImageDescriptor
	*/
	@Override
	protected void drawCompositeImage(int width, int height) {
	ImageData bg;
	if ((bg = fBaseImage.getImageData()) == null)
	bg = DEFAULT_IMAGE_DATA;

	drawImage(bg, 0, 0);
	drawTopRight();
	drawBottomRight();
	drawBottomLeft();
	drawTopLeft();
	}

	private void drawTopRight() {
	int x = getSize().x;
	ImageData data = null;
	if ((fFlags & VOLATILE) != 0) {
	data = CPluginImages.DESC_OVR_VOLATILE.getImageData();
	x -= data.width;
	drawImage(data, x, 0);
	}
	if ((fFlags & CONSTANT) != 0) {
	data = CPluginImages.DESC_OVR_CONSTANT.getImageData();
	x -= data.width;
	drawImage(data, x, 0);
	}
	if ((fFlags & STATIC) != 0) {
	data = CPluginImages.DESC_OVR_STATIC.getImageData();
	x -= data.width;
	drawImage(data, x, 0);
	}
	if ((fFlags & TEMPLATE) != 0) {
	data = CPluginImages.DESC_OVR_TEMPLATE.getImageData();
	x -= data.width;
	drawImage(data, x, 0);
	}
	if ((fFlags & SYSTEM_INCLUDE) != 0) {
	data = CPluginImages.DESC_OVR_SYSTEM_INCLUDE.getImageData();
	x -= data.width;
	drawImage(data, x, 0);
	}
	}

	private void drawBottomRight() {
	Point size = getSize();
	int x = size.x;
	ImageData data = null;
	if ((fFlags & RECURSIVE_RELATION) != 0) {
	data = CPluginImages.DESC_OVR_REC_RELATESTO.getImageData();
	x -= data.width;
	drawImage(data, x, size.y - data.height);
	} else if ((fFlags & RELATES_TO) != 0) {
	data = CPluginImages.DESC_OVR_RELATESTO.getImageData();
	x -= data.width;
	drawImage(data, x, size.y - data.height);
	} else if ((fFlags & RELATES_TO_MULTIPLE) != 0) {
	data = CPluginImages.DESC_OVR_RELATESTOMULTIPLE.getImageData();
	x -= data.width;
	drawImage(data, x, size.y - data.height);
	} else if ((fFlags & REFERENCED_BY) != 0) {
	data = CPluginImages.DESC_OVR_REFERENCEDBY.getImageData();
	x -= data.width;
	drawImage(data, x, size.y - data.height);
	}
	// if ((fFlags & OVERRIDES) != 0) {
	// data= CPluginImages.DESC_OVR_OVERRIDES.getImageData();
	// x-= data.width;
	// drawImage(data, x, size.y - data.height);
	// }
	// if ((fFlags & IMPLEMENTS) != 0) {
	// data= CPluginImages.DESC_OVR_IMPLEMENTS.getImageData();
	// x-= data.width;
	// drawImage(data, x, size.y - data.height);
	// }
	}

	private void drawTopLeft() {
	ImageData data = null;
	if ((fFlags & DEFINES) != 0) {
	data = CPluginImages.DESC_OVR_DEFINES.getImageData();
	drawImage(data, 0, 0);
	}
	if ((fFlags & INACTIVE) != 0) {
	data = CPluginImages.DESC_OVR_INACTIVE.getImageData();
	drawImage(data, 0, 0);
	}

	final boolean isReadAccess = (fFlags & READ_ACCESS) != 0;
	final boolean isWriteAccess = (fFlags & WRITE_ACCESS) != 0;
	if (isReadAccess) {
	if (isWriteAccess) {
	data = CPluginImages.DESC_OVR_READ_WRITE_ACCESS.getImageData();
	} else {
	data = CPluginImages.DESC_OVR_READ_ACCESS.getImageData();
	}
	drawImage(data, 0, 0);
	} else if (isWriteAccess) {
	data = CPluginImages.DESC_OVR_WRITE_ACCESS.getImageData();
	drawImage(data, 0, 0);
	}

	if ((fFlags & EXTERNAL_FILE) != 0) {
	data = CPluginImages.DESC_OVR_EXTERNAL_FILE.getImageData();
	drawImage(data, 0, 0);
	}
	}

	private void drawBottomLeft() {
	Point size = getSize();
	int x = 0;
	ImageData data = null;
	if ((fFlags & ERROR) != 0) {
	data = CPluginImages.DESC_OVR_ERROR.getImageData();
	drawImage(data, x, size.y - data.height);
	x += data.width;
	}
	if ((fFlags & WARNING) != 0) {
	data = CPluginImages.DESC_OVR_WARNING.getImageData();
	drawImage(data, x, size.y - data.height);
	x += data.width;
	}
	}
	}