/*
 * Util.DeviceInfo.cs
 * Authors: Adam Nabinger
 * Copyright (c) 2007-2008 Cornell University

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

using System;

namespace Util
{
	/// <summary>
	/// Try to get the specified Hardware param. If the value is unavailable, it will probably return 0 or -1.
	/// These values are not necessarily correct, only what is reported.
	/// </summary>
	public sealed class DeviceInfo
	{
		#region Enums

		/// <summary>
		/// Defines the information obtainable from the hardware 
		/// </summary>
		private enum DeviceCap
		{
			/// <summary>
			/// Device driver version
			/// </summary>
			DriverVersion = 0,
			/// <summary>
			/// Device classification
			/// </summary>
			Technology = 2,
			/// <summary>
			/// Horizontal size in millimeters
			/// </summary>
			HorizontalSize = 4,
			/// <summary>
			/// Vertical size in millimeters
			/// </summary>
			VerticalSize = 6,
			/// <summary>
			/// Horizontal width in pixels
			/// </summary>
			HorizontalRes = 8,
			/// <summary>
			/// Vertical height in pixels
			/// </summary>
			VerticalRes = 10,
			/// <summary>
			/// Number of bits per pixel
			/// </summary>
			BitsPerPixel = 12,
			/// <summary>
			/// Number of planes
			/// </summary>
			Planes = 14,
			/// <summary>
			/// Number of brushes the device has
			/// </summary>
			NumberBrushes = 16,
			/// <summary>
			/// Number of pens the device has
			/// </summary>
			NumberPens = 18,
			/// <summary>
			/// Number of markers the device has
			/// </summary>
			NumberMarkers = 20,
			/// <summary>
			/// Number of fonts the device has
			/// </summary>
			NumberFonts = 22,
			/// <summary>
			/// Number of colors the device supports
			/// </summary>
			NumberColors = 24,
			/// <summary>
			/// Size required for device descriptor
			/// </summary>
			PDeviceSize = 26,
			/// <summary>
			/// Curve capabilities
			/// </summary>
			CurveCaps = 28,
			/// <summary>
			/// Line capabilities
			/// </summary>
			LineCaps = 30,
			/// <summary>
			/// Polygonal capabilities
			/// </summary>
			PolygonalCaps = 32,
			/// <summary>
			/// Text capabilities
			/// </summary>
			TextCaps = 34,
			/// <summary>
			/// Clipping capabilities
			/// </summary>
			ClipCaps = 36,
			/// <summary>
			/// Bitblt capabilities
			/// </summary>
			RasterCaps = 38,
			/// <summary>
			/// Length of the X leg
			/// </summary>
			AspectX = 40,
			/// <summary>
			/// Length of the Y leg
			/// </summary>
			AspectY = 42,
			/// <summary>
			/// Length of the hypotenuse
			/// </summary>
			AspectXY = 44,
			/// <summary>
			/// Shading and Blending caps
			/// </summary>
			ShadeBlendCaps = 45,

			/// <summary>
			/// Logical pixels inch in X
			/// </summary>
			LogPixelsX = 88,
			/// <summary>
			/// Logical pixels inch in Y
			/// </summary>
			LogPixelsY = 90,

			/// <summary>
			/// Number of entries in physical palette
			/// </summary>
			SizePalette = 104,
			/// <summary>
			/// Number of reserved entries in palette
			/// </summary>
			NumberReserveEntries = 106,
			/// <summary>
			/// Actual color resolution
			/// </summary>
			ColorResolution = 108,

			// Printing related DeviceCaps. These replace the appropriate Escapes
			/// <summary>
			/// Physical Width in device units
			/// </summary>
			PhysicalWidth = 110,
			/// <summary>
			/// Physical Height in device units
			/// </summary>
			PhysicalHeight = 111,
			/// <summary>
			/// Physical Printable Area x margin
			/// </summary>
			PhysicalOffsetX = 112,
			/// <summary>
			/// Physical Printable Area y margin
			/// </summary>
			PhysicalOffsetY = 113,
			/// <summary>
			/// Scaling factor x
			/// </summary>
			ScalingFactorX = 114,
			/// <summary>
			/// Scaling factor y
			/// </summary>
			ScalingFactorY = 115,

			/// <summary>
			/// Current vertical refresh rate of the display device (for displays only) in Hz
			/// </summary>
			VRefresh = 116,
			/// <summary>
			/// Vertical height of entire desktop in pixels
			/// </summary>
			DesktopVerticalRes = 117,
			/// <summary>
			/// Horizontal width of entire desktop in pixels
			/// </summary>
			DesktopHorizontalRes = 118,
			/// <summary>
			/// Preferred blt alignment
			/// </summary>
			BltAlignment = 119
		}

		#endregion

		#region Fields

		// Pointer to start of the device memory
		private static readonly IntPtr hSDC = NativeMethods.GetDC(IntPtr.Zero);

		#endregion

		#region Properties

		/// <summary>
		/// Horizontal size in millimeters
		/// </summary>
		public static int PhysicalHorizontalSize
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.HorizontalSize); } }

		/// <summary>
		/// Vertical size in millimeters
		/// </summary>
		public static int PhysicalVerticalSize
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.VerticalSize); } }

		/// <summary>
		/// Device driver version
		/// </summary>
		public static int DriverVersion
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.DriverVersion); } }

		/// <summary>
		/// Device classification
		/// </summary>
		public static int Technology
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.Technology); } }

		/// <summary>
		/// Horizontal width in pixels
		/// </summary>
		public static int HorizontalRes
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.HorizontalRes); } }

		/// <summary>
		/// Vertical height in pixels
		/// </summary>
		public static int VerticalRes
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.VerticalRes); } }

		/// <summary>
		/// Number of bits per pixel
		/// </summary>
		public static int BitsPerPixel
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.BitsPerPixel); } }

		/// <summary>
		/// Number of planes
		/// </summary>
		public static int Planes
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.Planes); } }

		/// <summary>
		/// Number of brushes the device has
		/// </summary>
		public static int NumberBrushes
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.NumberBrushes); } }

		/// <summary>
		/// Number of pens the device has
		/// </summary>
		public static int NumberPens
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.NumberPens); } }

		/// <summary>
		/// Number of markers the device has
		/// </summary>
		public static int NumberMarkers
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.NumberMarkers); } }

		/// <summary>
		/// Number of fonts the device has
		/// </summary>
		public static int NumberFonts
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.NumberFonts); } }

		/// <summary>
		/// Number of colors the device supports
		/// </summary>
		public static int NumberColors
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.NumberColors); } }

		/// <summary>
		/// Size required for device descriptor
		/// </summary>
		public static int PDeviceSize
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.PDeviceSize); } }

		/// <summary>
		/// Curve capabilities
		/// </summary>
		public static int CurveCaps
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.CurveCaps); } }

		/// <summary>
		/// Line capabilities
		/// </summary>
		public static int LineCaps
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.LineCaps); } }

		/// <summary>
		/// Polygonal capabilities
		/// </summary>
		public static int PolygonalCaps
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.PolygonalCaps); } }

		/// <summary>
		/// Text capabilities
		/// </summary>
		public static int TextCaps
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.TextCaps); } }

		/// <summary>
		/// Clipping capabilities
		/// </summary>
		public static int ClipCaps
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.ClipCaps); } }

		/// <summary>
		/// Bitblt capabilities
		/// </summary>
		public static int RasterCaps
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.RasterCaps); } }

		/// <summary>
		/// Length of the X leg
		/// </summary>
		public static int AspectX
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.AspectX); } }

		/// <summary>
		/// Length of the Y leg
		/// </summary>
		public static int AspectY
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.AspectY); } }

		/// <summary>
		/// Length of the hypotenuse
		/// </summary>
		public static int AspectXY
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.AspectXY); } }

		/// <summary>
		/// Shading and Blending caps
		/// </summary>
		public static int ShadeBlendCaps
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.ShadeBlendCaps); } }

		/// <summary>
		/// Logical pixels inch in X
		/// </summary>
		public static int LogPixelsX
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.LogPixelsX); } }

		/// <summary>
		/// Logical pixels inch in Y
		/// </summary>
		public static int LogPixelsY
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.LogPixelsY); } }

		/// <summary>
		/// Number of entries in physical palette
		/// </summary>
		public static int SizePalette
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.SizePalette); } }

		/// <summary>
		/// Number of reserved entries in palette
		/// </summary>
		public static int NumberReserveEntries
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.NumberReserveEntries); } }

		/// <summary>
		/// Actual color resolution
		/// </summary>
		public static int ColorResolution
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.ColorResolution); } }

		/// <summary>
		/// Physical Width in device units
		/// </summary>
		public static int PhysicalWidth
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.PhysicalWidth); } }

		/// <summary>
		/// Physical Height in device units
		/// </summary>
		public static int PhysicalHeight
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.PhysicalHeight); } }

		/// <summary>
		/// Physical Printable Area x margin
		/// </summary>
		public static int PhysicalOffsetX
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.PhysicalOffsetX); } }

		/// <summary>
		/// Physical Printable Area y margin
		/// </summary>
		public static int PhysicalOffsetY
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.PhysicalOffsetY); } }

		/// <summary>
		/// Scaling factor x
		/// </summary>
		public static int ScalingFactorX
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.ScalingFactorX); } }

		/// <summary>
		/// Scaling factor y
		/// </summary>
		public static int ScalingFactorY
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.ScalingFactorY); } }

		/// <summary>
		/// Current vertical refresh rate of the display device (for displays only) in Hz
		/// </summary>
		public static int VRefresh
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.VRefresh); } }

		/// <summary>
		/// Vertical height of entire desktop in pixels
		/// </summary>
		public static int DesktopVerticalRes
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.DesktopVerticalRes); } }

		/// <summary>
		/// Horizontal width of entire desktop in pixels
		/// </summary>
		public static int DesktopHorizontalRes
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.DesktopHorizontalRes); } }

		/// <summary>
		/// Preferred blt alignment
		/// </summary>
		public static int BltAlignment
		{ get { return NativeMethods.GetDeviceCaps(hSDC, (int)DeviceCap.BltAlignment); } }

		#endregion

		#region Deconstructor

		/// <summary>
		/// Release when no longer needed.
		/// </summary>
		~DeviceInfo()
		{
			NativeMethods.ReleaseDC(IntPtr.Zero, hSDC);
		}

		#endregion
	}
}