/*******************************************************************************
 * Copyright (c) 2000, 2014 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.swt.graphics;


import org.eclipse.swt.*;
import org.eclipse.swt.internal.*;
import org.eclipse.swt.internal.win32.*;

/**
 * Instances of this class manage operating system resources that
 * define how text looks when it is displayed. Fonts may be constructed
 * by providing a device and either name, size and style information
 * or a <code>FontData</code> object which encapsulates this data.
 * <p>
 * Application code must explicitly invoke the <code>Font.dispose()</code>
 * method to release the operating system resources managed by each instance
 * when those instances are no longer required.
 * </p>
 *
 * @see FontData
 * @see <a href="https://eclipse.dev/eclipse/swt/snippets/#font">Font snippets</a>
 * @see <a href="https://eclipse.dev/eclipse/swt/examples.html">SWT Examples: GraphicsExample, PaintExample</a>
 * @see <a href="https://eclipse.dev/eclipse/swt/">Sample code and further information</a>
 */
public final class Font extends Resource {

	/**
	 * the handle to the OS font resource
	 * (Warning: This field is platform dependent)
	 * <p>
	 * <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
	 * public API. It is marked public only so that it can be shared
	 * within the packages provided by SWT. It is not available on all
	 * platforms and should never be accessed from application code.
	 * </p>
	 *
	 */
	private long handle;

	/**
	 * The zoom in % of the standard resolution used for conversion of point height to pixel height
	 * (Warning: This field is platform dependent)
	 */
	int zoom;

	/**
	 * this field is used to mark destroyed fonts
	 */
	private boolean isDestroyed;

	/**
	 * this field is used to store fontData provided during initialization
	 */
	private final FontData fontData;

	/**
	 * Font height in points. As the conversion to pixel height involves rounding the fontHeight must
	 * be cached.
	 */
	private final float fontHeight;

private Font(Device device, long handle, int zoom) {
	super(device);
	this.fontData = null;
	this.handle = handle;
	this.zoom = zoom;
	this.fontHeight = device.computePoints(fetchLogFontData(), handle, zoom);
}

/**
 * Constructs a new font given a device and font data
 * which describes the desired font's appearance.
 * <p>
 * You must dispose the font when it is no longer required.
 * </p>
 *
 * @param device the device to create the font on
 * @param fd the FontData that describes the desired font (must not be null)
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
 *    <li>ERROR_NULL_ARGUMENT - if the fd argument is null</li>
 * </ul>
 * @exception SWTError <ul>
 *    <li>ERROR_NO_HANDLES - if a font could not be created from the given font data</li>
 * </ul>
 *
 * @see #dispose()
 */
public Font(Device device, FontData fd) {
	super(device);
	if (fd == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
	this.zoom = DPIUtil.getNativeDeviceZoom();
	this.fontData = new FontData(fd);
	this.fontHeight = fd.height;
	init();
}

private Font(Device device, FontData fd, int zoom) {
	super(device);
	if (fd == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
	this.zoom = zoom;
	this.fontData = new FontData(fd);
	this.fontHeight = fd.height;
	init();
}

/**
 * Constructs a new font given a device and an array
 * of font data which describes the desired font's
 * appearance.
 * <p>
 * You must dispose the font when it is no longer required.
 * </p>
 *
 * @param device the device to create the font on
 * @param fds the array of FontData that describes the desired font (must not be null)
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
 *    <li>ERROR_NULL_ARGUMENT - if the fds argument is null</li>
 *    <li>ERROR_INVALID_ARGUMENT - if the length of fds is zero</li>
 *    <li>ERROR_NULL_ARGUMENT - if any fd in the array is null</li>
 * </ul>
 * @exception SWTError <ul>
 *    <li>ERROR_NO_HANDLES - if a font could not be created from the given font data</li>
 * </ul>
 *
 * @see #dispose()
 *
 * @since 2.1
 */
public Font(Device device, FontData[] fds) {
	super(device);
	if (fds == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
	if (fds.length == 0) SWT.error(SWT.ERROR_INVALID_ARGUMENT);
	for (FontData fd : fds) {
		if (fd == null) SWT.error(SWT.ERROR_INVALID_ARGUMENT);
	}
	this.zoom = DPIUtil.getNativeDeviceZoom();
	FontData fd = fds[0];
	this.fontData = new FontData(fd);
	this.fontHeight = fd.height;
	init();
}

/**
 * Constructs a new font given a device, a font name,
 * the height of the desired font in points, and a font
 * style.
 * <p>
 * You must dispose the font when it is no longer required.
 * </p>
 *
 * @param device the device to create the font on
 * @param name the name of the font (must not be null)
 * @param height the font height in points
 * @param style a bit or combination of NORMAL, BOLD, ITALIC
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
 *    <li>ERROR_NULL_ARGUMENT - if the name argument is null</li>
 *    <li>ERROR_INVALID_ARGUMENT - if the height is negative</li>
 * </ul>
 * @exception SWTError <ul>
 *    <li>ERROR_NO_HANDLES - if a font could not be created from the given arguments</li>
 * </ul>
 *
 * @see #dispose()
 */
public Font(Device device, String name, int height, int style) {
	super(device);
	if (name == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
	this.zoom = DPIUtil.getNativeDeviceZoom();
	this.fontData = new FontData (name, height, style);
	this.fontHeight = height;
	init();
}

@Override
void destroy() {
	OS.DeleteObject(handle);
	handle = 0;
	isDestroyed = true;
}

/**
 * Compares the argument to the receiver, and returns true
 * if they represent the <em>same</em> object using a class
 * specific comparison.
 *
 * @param object the object to compare with this object
 * @return <code>true</code> if the object is the same as this object and <code>false</code> otherwise
 *
 * @see #hashCode
 */
@Override
public boolean equals(Object object) {
	if (object == this) return true;
	if (!(object instanceof Font)) return false;
	Font font = (Font) object;
	return device == font.device && win32_getHandle(this) == win32_getHandle(font);
}

/**
 * Returns an array of <code>FontData</code>s representing the receiver.
 * On Windows, only one FontData will be returned per font. On X however,
 * a <code>Font</code> object <em>may</em> be composed of multiple X
 * fonts. To support this case, we return an array of font data objects.
 *
 * @return an array of font data objects describing the receiver
 *
 * @exception SWTException <ul>
 *    <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
 * </ul>
 */
public FontData[] getFontData() {
	if (isDisposed()) SWT.error(SWT.ERROR_GRAPHIC_DISPOSED);
	LOGFONT logFont = fetchLogFontData();
	return new FontData[] {FontData.win32_new(logFont, fontHeight)};
}

private LOGFONT fetchLogFontData() {
	LOGFONT logFont = new LOGFONT ();
	OS.GetObject(win32_getHandle(this), LOGFONT.sizeof, logFont);
	return logFont;
}

/**
 * Returns an integer hash code for the receiver. Any two
 * objects that return <code>true</code> when passed to
 * <code>equals</code> must return the same value for this
 * method.
 *
 * @return the receiver's hash
 *
 * @see #equals
 */
@Override
public int hashCode () {
	return (int) win32_getHandle(this);
}

void init (FontData fd) {
	if (fd == null) SWT.error(SWT.ERROR_NULL_ARGUMENT);
	LOGFONT logFont = fd.data;
	int lfHeight = logFont.lfHeight;
	logFont.lfHeight = device.computePixels(fd.height, zoom);
	handle = OS.CreateFontIndirect(logFont);
	logFont.lfHeight = lfHeight;
	if (handle == 0) SWT.error(SWT.ERROR_NO_HANDLES);
}

/**
 * Returns <code>true</code> if the font has been disposed,
 * and <code>false</code> otherwise.
 * <p>
 * This method gets the dispose state for the font.
 * When a font has been disposed, it is an error to
 * invoke any other method (except {@link #dispose()}) using the font.
 *
 * @return <code>true</code> when the font is disposed and <code>false</code> otherwise
 */
@Override
public boolean isDisposed() {
	return isDestroyed;
}

/**
 * Returns a string containing a concise, human-readable
 * description of the receiver.
 *
 * @return a string representation of the receiver
 */
@Override
public String toString () {
	if (isDisposed()) return "Font {*DISPOSED*}";
	return "Font {" + handle + "}";
}

/**
 * Creates or returns a handle for the requested font.
 * <p>
 * <b>IMPORTANT:</b> This method is not part of the public API for
 * <code>Font</code>. It is marked public only so that it can be shared within
 * the packages provided by SWT. It is not available on all platforms, and
 * should never be called from application code.
 *
 * @param font the font to get the handle of
 * @return handle of the font
 *
 * @noreference This method is not intended to be referenced by clients.
 */
public static long win32_getHandle(Font font) {
	if (font.handle == 0 && font.fontData != null && !font.isDestroyed) {
		font.init(font.fontData);
	}
	return font.handle;
}

/**
 * Invokes platform specific functionality to allocate a new font.
 * <p>
 * <b>IMPORTANT:</b> This method is <em>not</em> part of the public
 * API for <code>Font</code>. It is marked public only so that it
 * can be shared within the packages provided by SWT. It is not
 * available on all platforms, and should never be called from
 * application code.
 * </p>
 *
 * @param device the device on which to allocate the color
 * @param handle the handle for the font
 * @return a new font object containing the specified device and handle
 *
 * @noreference This method is not intended to be referenced by clients.
 */
public static Font win32_new(Device device, long handle) {
	int zoom = DPIUtil.getNativeDeviceZoom();
	return win32_new(device, handle, zoom);
}

/**
 * Invokes platform specific functionality to allocate a new font.
 * <p>
 * <b>IMPORTANT:</b> This method is <em>not</em> part of the public
 * API for <code>Font</code>. It is marked public only so that it
 * can be shared within the packages provided by SWT. It is not
 * available on all platforms, and should never be called from
 * application code.
 * </p>
 *
 * @param device the device on which to allocate the font
 * @param handle the handle for the font
 * @param zoom zoom in % of the standard resolution
 * @return a new font object containing the specified device and handle
 *
 * @noreference This method is not intended to be referenced by clients.
 * @since 3.126
 */
public static Font win32_new(Device device, long handle, int zoom) {
	Font font = new Font(device, handle, zoom);
	/*
	 * When created this way, Font doesn't own its .handle, and
	 * for this reason it can't be disposed. Tell leak detector
	 * to just ignore it.
	 */
	font.ignoreNonDisposed();
	return font;
}

/**
 * Invokes platform specific private constructor to allocate a new font.
 * <p>
 * <b>IMPORTANT:</b> This method is <em>not</em> part of the public
 * API for <code>Font</code>. It is marked public only so that it
 * can be shared within the packages provided by SWT. It is not
 * available on all platforms, and should never be called from
 * application code.
 * </p>
 *
 * @param device the device on which to allocate the font
 * @param fontData font data to create the font for
 * @param zoom zoom in % of the standard resolution
 * @return a new font object using the specified font data with the
 * specified zoom as factor for the font data
 *
 * @noreference This method is not intended to be referenced by clients.
 * @since 3.126
 */
public static Font win32_new(Device device, FontData fontData, int zoom) {
	return new Font(device, fontData, zoom);
}

/**
 * Used to receive a font for the given zoom in the context
 * of the current configuration of SWT at runtime.
 * <p>
 * <b>IMPORTANT:</b> This method is <em>not</em> part of the public
 * API for <code>Font</code>. It is marked public only so that it
 * can be shared within the packages provided by SWT. It is not
 * available on all platforms, and should never be called from
 * application code.
 * </p>
 *
 * @param font font to create a font for the given target zoom
 * @param targetZoom zoom in % of the standard resolution
 * @return a font matching the specified font and zoom in %
 *
 * @noreference This method is not intended to be referenced by clients.
 * @since 3.126
 */
public static Font win32_new(Font font, int targetZoom) {
	if (targetZoom == font.zoom) {
		return font;
	}
	return SWTFontProvider.getFont(font.getDevice(), font.getFontData()[0], targetZoom);
}
}
