indexing
	description: "Constants used in conjonction with File/Pipe handle creation/update."
	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
	WEL_FILE_CONSTANTS

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)

	generic_all: INTEGER_32 is 268435456
			-- Read/write/execute access

	generic_execute: INTEGER_32 is 536870912
			-- Execute access

	generic_read: INTEGER_32 is 2147483648
			-- Read access

	generic_write: INTEGER_32 is 1073741824
			-- Write access			
	
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

	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))
	
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 -- Attributes

	file_attribute_normal: INTEGER_32 is 128
			-- The file has no other attributes set. This attribute is valid only if used alone.

	file_attribute_temporary: INTEGER_32 is 256
			-- The file is being used for temporary storage. File systems avoid writing
			-- data back to mass storage if sufficient cache memory is available, because
			-- often the application deletes the temporary file shortly after the handle
			-- is closed. In that case, the system can entirely avoid writing the data.
			-- Otherwise, the data will be written after the handle is closed.
	
feature -- CreateFile

	create_always: INTEGER_32 is 2
			-- Creates a new file. If the file exists, the function overwrites the file,
			-- clears the existing attributes, combines the specified file attributes
			-- and flags with FILE_ATTRIBUTE_ARCHIVE, but does not set the security 
			-- descriptor specified by the SECURITY_ATTRIBUTES structure

	create_new: INTEGER_32 is 1
			-- Creates a new file. The function fails if the specified file already exists

	open_always: INTEGER_32 is 4
			-- Opens the file, if it exists. If the file does not exist, the function
			-- creates the file as if dwCreationDisposition were CREATE_NEW

	open_existing: INTEGER_32 is 3
			-- Opens the file. The function fails if the file does not exist. 
			-- For a discussion of why you should use OPEN_EXISTING for devices, see Remarks.

	truncate_existing: INTEGER_32 is 5
			-- Opens the file and truncates it so that its size is zero bytes.
			-- The calling process must open the file with the GENERIC_WRITE access right.
			-- The function fails if the file does not exist. 
	
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)
	
feature -- Position

	file_begin: INTEGER_32 is 0

	file_current: INTEGER_32 is 1

	file_end: INTEGER_32 is 2
			-- Position in file where to set pointer
	
feature -- Share mode

	file_flag_no_buffering: INTEGER_32 is 536870912

	file_flag_write_through: INTEGER_32 is 2147483648

	file_share_read: INTEGER_32 is 1
			-- Enables subsequent open operations on the object to request read access.
			-- Otherwise, other processes cannot open the object if they request read access.
			--
			-- If the object has already been opened with read access, the sharing mode must
			-- include this flag.

	file_share_write: INTEGER_32 is 2
			-- Enables subsequent open operations on the object to request write access.
			-- Otherwise, other processes cannot open the object if they request write access.
			--
			-- If the object has already been opened with write access, the sharing mode
			-- must include this flag.
	
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 WEL_FILE_CONSTANTS