indexing
	description: "VARTYPE constants"
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
	revision: "$Revision: 56675 $"

class interface
	ECOM_VAR_TYPE

create 
	default_create
			-- Process instances of classes with no creation clause.
			-- (Default: do nothing.)
			-- (from ANY)

feature -- Access

	generating_type: STRING_8
			-- Name of current object's generating type
			-- (type of which it is a direct instance)
			-- (from ANY)

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)

	vt_array: INTEGER_32
			-- A Safe array of data is passed

	vt_bool: INTEGER_32
			-- Boolean: True = -1 False = 0

	vt_bstr: INTEGER_32
			-- Binary string

	vt_byref: INTEGER_32
			-- Pointer to data is passed

	vt_carray: INTEGER_32
			-- array
			-- may appear in TYPEDESC only

	vt_cy: INTEGER_32
			-- Currency

	vt_date: INTEGER_32
			-- Date

	vt_decimal: INTEGER_32
			-- 16 byte fixed point

	vt_dispatch: INTEGER_32
			-- IDispatch*

	vt_empty: INTEGER_32
			-- Not specified

	vt_error: INTEGER_32
			-- SCODE

	vt_hresult: INTEGER_32
			-- HRESULT
			-- may appear in TYPEDESC only

	vt_i1: INTEGER_32
			-- Character

	vt_i2: INTEGER_32
			-- 2-byte signed integer

	vt_i4: INTEGER_32
			-- 4-byte signed integer

	vt_i8: INTEGER_32
			-- 8-byte signed integer
			-- may appear in TYPEDESC only

	vt_int: INTEGER_32
			-- integer
			-- may appear in TYPEDESC only

	vt_lpstr: INTEGER_32
			-- LPSTR
			-- may appear in TYPEDESC only

	vt_lpwstr: INTEGER_32
			-- LPWSTR
			-- may appear in TYPEDESC only

	vt_null: INTEGER_32
			-- SQL style Null

	vt_ptr: INTEGER_32
			-- pointer
			-- may appear in TYPEDESC only

	vt_r4: INTEGER_32
			-- 4-byte real

	vt_r8: INTEGER_32
			-- 8-byte real

	vt_record: INTEGER_32
			-- Record
			-- may appear in TYPEDESC only

	vt_reserved: INTEGER_32
			-- Reserverd for Microsoft use

	vt_safearray: INTEGER_32
			-- Safearray
			-- may appear in TYPEDESC only

	vt_typemask: INTEGER_32
			-- Typemask.

	vt_ui1: INTEGER_32
			-- Unsigned character

	vt_ui2: INTEGER_32
			-- 2-bytes unsigned integer
			-- may appear in TYPEDESC only

	vt_ui4: INTEGER_32
			-- 4-bytes unsigned integer
			-- may appear in TYPEDESC only

	vt_ui8: INTEGER_32
			-- 8-bytes unsigned integer
			-- may appear in TYPEDESC only

	vt_uint: INTEGER_32
			-- unsigned integer
			-- may appear in TYPEDESC only

	vt_unknown: INTEGER_32
			-- IUnknown*

	vt_userdefined: INTEGER_32
			-- User defined
			-- may appear in TYPEDESC only

	vt_variant: INTEGER_32
			-- VARIANT*

	vt_void: INTEGER_32
			-- NULL
			-- may appear in TYPEDESC only
	
feature -- Comparison

	frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		ensure -- from ANY
			shallow_implies_deep: standard_equal (some, other) implies Result
			both_or_none_void: (some = Void) implies (Result = (other = Void))
			same_type: (Result and (some /= Void)) implies some.same_type (other)
			symmetric: Result implies deep_equal (other, some)

	frozen equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

	is_equal (other: like Current): BOOLEAN
			-- Is `other' attached to an object considered
			-- equal to current object?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			symmetric: Result implies other.is_equal (Current)
			consistent: standard_is_equal (other) implies Result

	frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

	frozen standard_is_equal (other: like Current): BOOLEAN
			-- Is `other' attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
feature -- Status report

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of `other' (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void

	has_boolean (variable_type: INTEGER_32): BOOLEAN
			-- Is variable boolean or boolen array or boolean pointer?

	has_bstr (variable_type: INTEGER_32): BOOLEAN
			-- Is variable bstr or bstr array or bstr pointer?

	has_character (variable_type: INTEGER_32): BOOLEAN
			-- Is variable character or character array or character pointer?

	has_currency (variable_type: INTEGER_32): BOOLEAN
			-- Is variable currency or currency array or currency pointer?

	has_date (variable_type: INTEGER_32): BOOLEAN
			-- Is variable date or date array or date pointer?

	has_decimal (variable_type: INTEGER_32): BOOLEAN
			-- Is variable decimal or decimal array or decimal pointer?

	has_double (variable_type: INTEGER_32): BOOLEAN
			-- Is variable double or double array or double pointer?

	has_error (variable_type: INTEGER_32): BOOLEAN
			-- Is variable error or error array or error pointer?

	has_hresult (variable_type: INTEGER_32): BOOLEAN
			-- Is variable HRESULT or HRESULT array or HRESULT pointer?

	has_idispatch (variable_type: INTEGER_32): BOOLEAN
			-- Is variable IDispatch interface pointer or IDispatch interface pointer array or IDispatch interface pointer pointer?

	has_int (variable_type: INTEGER_32): BOOLEAN
			-- Is variable int or int array or int pointer?

	has_integer2 (variable_type: INTEGER_32): BOOLEAN
			-- Is variable short integer or short integer array or short integer pointer?

	has_integer4 (variable_type: INTEGER_32): BOOLEAN
			-- Is variable long integer or long integer array or long integer pointer?

	has_iunknown (variable_type: INTEGER_32): BOOLEAN
			-- Is variable IUnknown interface pointer or IUnknown interface pointer array or IUnknown interface pointer pointer?

	has_long_long (variable_type: INTEGER_32): BOOLEAN
			-- Is variable long long or long long array or long long pointer?

	has_ptr (variable_type: INTEGER_32): BOOLEAN
			-- Is variable ptr or ptr array or ptr pointer?

	has_real (variable_type: INTEGER_32): BOOLEAN
			-- Is variable real or real array or real pointer?

	has_unsigned_char (variable_type: INTEGER_32): BOOLEAN
			-- Is variable unsigned char or unsigned char array or unsigned char pointer?

	has_unsigned_int (variable_type: INTEGER_32): BOOLEAN
			-- Is variable unsigned int or unsigned int array or unsigned int pointer?

	has_unsigned_long (variable_type: INTEGER_32): BOOLEAN
			-- Is variable unsigned long or unsigned long array or unsigned long pointer?

	has_unsigned_long_long (variable_type: INTEGER_32): BOOLEAN
			-- Is variable unsigned long long or unsigned long long array or unsigned long long pointer?

	has_unsigned_short (variable_type: INTEGER_32): BOOLEAN
			-- Is variable unsigned short or unsigned short array or unsigned short pointer?

	has_variant (variable_type: INTEGER_32): BOOLEAN
			-- Is variable variant or variant array or variant pointer?

	has_void (variable_type: INTEGER_32): BOOLEAN
			-- Is variable void or void array or void pointer?

	is_array (variable_type: INTEGER_32): BOOLEAN
			-- Is variable array?

	is_basic (a_type: INTEGER_32): BOOLEAN
			-- Is `a_type' basic type?

	is_boolean (variable_type: INTEGER_32): BOOLEAN
			-- Is variable boolean?

	is_bstr (variable_type: INTEGER_32): BOOLEAN
			-- Is variable BSTR?

	is_byref (variable_type: INTEGER_32): BOOLEAN
			-- Is variable passed by reference?

	is_carray (variable_type: INTEGER_32): BOOLEAN
			-- Is variable C ARRAY?

	is_character (variable_type: INTEGER_32): BOOLEAN
			-- Is variable character?

	is_currency (variable_type: INTEGER_32): BOOLEAN
			-- Is variable currency?

	is_date (variable_type: INTEGER_32): BOOLEAN
			-- Is variable date?

	is_decimal (variable_type: INTEGER_32): BOOLEAN
			-- Is decimal variable?

	is_double (variable_type: INTEGER_32): BOOLEAN
			-- Is variable double?

	is_error (variable_type: INTEGER_32): BOOLEAN
			-- Is variable error?

	is_hresult (variable_type: INTEGER_32): BOOLEAN
			-- Is variable HRESULT?

	is_idispatch (variable_type: INTEGER_32): BOOLEAN
			-- Is IDispatch interface pointer?

	is_int (variable_type: INTEGER_32): BOOLEAN
			-- Is variable int?

	is_integer2 (variable_type: INTEGER_32): BOOLEAN
			-- Is variable short integer?

	is_integer4 (variable_type: INTEGER_32): BOOLEAN
			-- Is variable long integer?

	is_iunknown (variable_type: INTEGER_32): BOOLEAN
			-- Is IUnknown interface pointer?

	is_long_long (variable_type: INTEGER_32): BOOLEAN
			-- Is variable long long?

	is_lpstr (variable_type: INTEGER_32): BOOLEAN
			-- Is variable LPSTR?

	is_lpwstr (variable_type: INTEGER_32): BOOLEAN
			-- Is variable LPWSTR?

	is_ptr (variable_type: INTEGER_32): BOOLEAN
			-- Is variable ptr?

	is_real (variable_type: INTEGER_32): BOOLEAN
			-- Is variable real?

	is_record (variable_type: INTEGER_32): BOOLEAN
			-- Is variable a Record? (i.e. a C struct)

	is_safearray (variable_type: INTEGER_32): BOOLEAN
			-- Is variable SAFEARRAY?

	is_unsigned_char (variable_type: INTEGER_32): BOOLEAN
			-- Is variable unsigned char?

	is_unsigned_int (variable_type: INTEGER_32): BOOLEAN
			-- Is variable unsigned int?

	is_unsigned_long (variable_type: INTEGER_32): BOOLEAN
			-- Is variable unsigned long?

	is_unsigned_long_long (variable_type: INTEGER_32): BOOLEAN
			-- Is variable unsigned long long?

	is_unsigned_short (variable_type: INTEGER_32): BOOLEAN
			-- Is Ivariable unsigned short?

	is_user_defined (variable_type: INTEGER_32): BOOLEAN
			-- Is variable user defined?

	is_variant (variable_type: INTEGER_32): BOOLEAN
			-- Is variable variant?

	is_void (variable_type: INTEGER_32): BOOLEAN
			-- Is variable void?

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of `other'?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))

	valid_var_type (a_var_type: INTEGER_32): BOOLEAN
			-- Is `a_var_type' a valid variant type?
	
feature -- Duplication

	copy (other: like Current)
			-- Update current object using fields of object attached
			-- to `other', so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: is_equal (other)

	frozen deep_copy (other: like Current)
			-- Effect equivalent to that of:
			--		copy (`other' . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)

	frozen deep_twin: like Current
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		ensure -- from ANY
			deep_equal: deep_equal (Current, Result)

	frozen standard_copy (other: like Current)
			-- Copy every field of `other' onto corresponding field
			-- of current object.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)

	frozen standard_twin: like Current
			-- New object field-by-field identical to `other'.
			-- Always uses default copying semantics.
			-- (from ANY)
		ensure -- from ANY
			standard_twin_not_void: Result /= Void
			equal: standard_equal (Result, Current)

	frozen twin: like Current
			-- New object equal to `Current'
			-- twin calls copy; to change copying/twining semantics, redefine copy.
			-- (from ANY)
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result.is_equal (Current)
	
feature -- Basic operations

	frozen default: like Current
			-- Default value of object's type
			-- (from ANY)

	frozen default_pointer: POINTER
			-- Default value of type `POINTER'
			-- (Avoid the need to write `p'.default for
			-- some `p' of type `POINTER'.)
			-- (from ANY)

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
	
feature -- Output

	io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- Was declared in ANY as synonym of tagged_out.
			-- (from ANY)

	print (some: ANY)
			-- Write terse external representation of `some'
			-- on standard output.
			-- (from ANY)

	frozen tagged_out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- Was declared in ANY as synonym of out.
			-- (from ANY)
	
feature -- Platform

	operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

indexing
	copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
	source: "[
		Eiffel Software
		356 Storke Road, Goleta, CA 93117 USA
		Telephone 805-685-1006, Fax 805-685-6869
		Website http://www.eiffel.com
		Customer support http://support.eiffel.com
	]"

end -- class ECOM_VAR_TYPE