Automatic generation produced by ISE Eiffel
indexing description: "32 bit DLL routine for Windows" status: "See notice at end of class" date: "$Date: 2001-11-16 20:32:23 +0000 (Fri, 16 Nov 2001) $" revision: "$Revision: 51435 $" class DLL_32_ROUTINE create make_by_name, make_by_index feature -- Access argument_types: ARRAY [INTEGER] -- Expected types of the actual arguments -- (from SHARED_LIBRARY_ROUTINE) function_name: STRING -- Name of the routine in the library -- (from SHARED_LIBRARY_ROUTINE) library_index: INTEGER -- Index of the routine in shared_library library_name: STRING is -- Name of the associated library for the routine -- (from SHARED_LIBRARY_ROUTINE) do Result := shared_library.library_name end return_type: INTEGER -- Expected return type -- (from SHARED_LIBRARY_ROUTINE) shared_library: DLL_32 -- Associated library for the routine T_array: INTEGER is 0 -- (from SHARED_LIBRARY_CONSTANTS) T_boolean: INTEGER is 1 -- (from SHARED_LIBRARY_CONSTANTS) T_character: INTEGER is 2 -- (from SHARED_LIBRARY_CONSTANTS) T_double: INTEGER is 3 -- (from SHARED_LIBRARY_CONSTANTS) T_integer: INTEGER is 4 -- (from SHARED_LIBRARY_CONSTANTS) T_no_type: INTEGER is 10 -- (from SHARED_LIBRARY_CONSTANTS) T_pointer: INTEGER is 5 -- (from SHARED_LIBRARY_CONSTANTS) T_real: INTEGER is 6 -- (from SHARED_LIBRARY_CONSTANTS) T_reference: INTEGER is 7 -- (from SHARED_LIBRARY_CONSTANTS) T_short_integer: INTEGER is 8 -- (from SHARED_LIBRARY_CONSTANTS) T_string: INTEGER is 9 -- (from SHARED_LIBRARY_CONSTANTS) feature -- Status report argument_count: INTEGER is -- Number of arguments required -- (from SHARED_LIBRARY_ROUTINE) do Result := argument_types.count end boolean_result: BOOLEAN is -- Value when the routine returns a boolean require -- from SHARED_LIBRARY_ROUTINE routine_called: routine_called valid_return_type: return_type = t_boolean do Result := imp_boolean_result end character_result: CHARACTER is -- Value when the routine returns a character require -- from SHARED_LIBRARY_ROUTINE routine_called: routine_called valid_return_type: return_type = t_character do Result := imp_character_result end conforms_to_signature (arguments: ARRAY [ANY]): BOOLEAN is -- Do the actual arguments arguments conform to the signature? -- (from SHARED_LIBRARY_ROUTINE) require -- from SHARED_LIBRARY_ROUTINE valid_array: arguments /= void local i, j, nb: INTEGER arg: ANY boolean_ref: BOOLEAN_REF character_ref: CHARACTER_REF double_ref: DOUBLE_REF integer_ref: INTEGER_REF real_ref: REAL_REF pointer_ref: POINTER_REF s: STRING s1: ARRAY [INTEGER] s2: ARRAY [REAL] s3: ARRAY [DOUBLE] s4: ARRAY [BOOLEAN] s5: ARRAY [CHARACTER] s6: ARRAY [POINTER] s7: ARRAY [ANY] do from Result := arguments.count = argument_count i := arguments.lower j := argument_types.lower nb := arguments.count until i > nb or not Result loop arg := arguments @ i inspect argument_types @ j when t_array then Result := True; s1 ?= arg; if s1 = void then s2 ?= arg; if s2 = void then s3 ?= arg; if s3 = void then s4 ?= arg; if s4 = void then s5 ?= arg; if s5 = void then s6 ?= arg; if s6 = void then s7 ?= arg; if s7 = void then Result := False end end end end end end end when t_boolean then boolean_ref ?= arg; Result := boolean_ref /= void when t_character then character_ref ?= arg; Result := character_ref /= void when t_double then double_ref ?= arg; Result := double_ref /= void when t_integer,t_short_integer then integer_ref ?= arg; Result := integer_ref /= void when t_real then real_ref ?= arg; Result := real_ref /= void when t_pointer then pointer_ref ?= arg; Result := pointer_ref /= void when t_no_type then Result := False when t_reference then when t_string then create s.make (0); Result := arg.conforms_to (s) end i := i + 1 j := j + 1 end end double_result: DOUBLE is -- Value when the routine returns a double require -- from SHARED_LIBRARY_ROUTINE routine_called: routine_called valid_return_type: return_type = t_double do Result := imp_double_result end error_code: INTEGER -- Current status of the routine -- (from SHARED_LIBRARY_ROUTINE) integer_result: INTEGER is -- Value when the routine returns an integer require -- from SHARED_LIBRARY_ROUTINE routine_called: routine_called valid_return_type: return_type = t_integer or return_type = t_short_integer do Result := imp_integer_result end Library_freed: INTEGER is 3 -- (from SHARED_LIBRARY_CONSTANTS) meaningful: BOOLEAN is -- Is the routine currently callable? -- (from SHARED_LIBRARY_ROUTINE) do Result := shared_library.meaningful and (error_code = no_error) end No_error: INTEGER is 0 -- (from SHARED_LIBRARY_CONSTANTS) No_library: INTEGER is 1 -- (from SHARED_LIBRARY_CONSTANTS) No_routine: INTEGER is 2 -- (from SHARED_LIBRARY_CONSTANTS) pointer_result: POINTER is -- Value when the routine returns a pointer require -- from SHARED_LIBRARY_ROUTINE routine_called: routine_called valid_return_type: return_type = t_pointer do Result := imp_pointer_result end real_result: REAL is -- Value when the routine returns a real require -- from SHARED_LIBRARY_ROUTINE routine_called: routine_called valid_return_type: return_type = t_real do Result := imp_real_result end reference_result: ANY is -- Value when the routine returns a reference require -- from SHARED_LIBRARY_ROUTINE routine_called: routine_called valid_return_type: return_type = t_reference do Result := imp_reference_result end routine_called: BOOLEAN -- Has the routine already been called? -- (from SHARED_LIBRARY_ROUTINE) string_result: STRING is -- Value when the routine returns a string require -- from SHARED_LIBRARY_ROUTINE routine_called: routine_called valid_return_type: return_type = t_string do Result := imp_string_result end valid_argument_types (args: ARRAY [INTEGER]): BOOLEAN is -- Are all the argument types in args valid? -- (from SHARED_LIBRARY_ROUTINE) local i, nb: INTEGER arg_type: INTEGER do from Result := True i := args.lower nb := args.count until i > nb or else not Result loop arg_type := args @ i Result := arg_type >= 0 and arg_type < t_no_type i := i + 1 end end valid_return_type (ret_type: INTEGER): BOOLEAN is -- Is ret_type valid as a return type? -- (from SHARED_LIBRARY_ROUTINE) do Result := (ret_type > t_array) and then (ret_type <= t_no_type) end feature -- Basic operations call (args: ARRAY [ANY]) is -- Call the routine with actual arguments args require -- from SHARED_LIBRARY_ROUTINE meaningful: meaningful valid_array: args /= void conformant: conforms_to_signature (args) local formal_args: ANY actual_args: ANY do fill_argument_array (args) actual_args := argument_array.area formal_args := argument_types.area inspect return_type when t_boolean then imp_boolean_result := desc_call_dll32_boolean (function_handle, arguments_size, $actual_args) when t_character then imp_character_result := desc_call_dll32_character (function_handle, arguments_size, $actual_args) when t_double then imp_double_result := desc_call_dll32_double (function_handle, arguments_size, $actual_args) when t_integer then imp_integer_result := desc_call_dll32_integer (function_handle, arguments_size, $actual_args) when t_real then imp_real_result := desc_call_dll32_real (function_handle, arguments_size, $actual_args) when t_pointer then imp_pointer_result := desc_call_dll32_pointer (function_handle, arguments_size, $actual_args) when t_reference then imp_reference_result := desc_call_dll32_reference (function_handle, arguments_size, $actual_args) when t_short_integer then imp_integer_result := desc_call_dll32_short_integer (function_handle, arguments_size, $actual_args) when t_string then imp_string_result := desc_rtms (desc_call_dll32_string (function_handle, arguments_size, $actual_args)) when t_no_type then desc_call_dll32_procedure (function_handle, arguments_size, $actual_args) end routine_called := True ensure -- from SHARED_LIBRARY_ROUTINE routine_called: routine_called end feature {NONE} -- Implementation argument_array: ARRAY [INTEGER] -- Values to be pushed on the C stack arguments_size: INTEGER fill_argument_array (args: ARRAY [ANY]) is -- Fill area for stack pushing operation local i, j, nb: INTEGER area: ANY position: INTEGER arg_type, arg_size: INTEGER b_ref: BOOLEAN_REF c_ref: CHARACTER_REF d_ref: DOUBLE_REF i_ref: INTEGER_REF r_ref: REAL_REF p_ref: POINTER_REF b: BOOLEAN c: CHARACTER d: DOUBLE int: INTEGER r: REAL p: POINTER a: ANY s: STRING s1: ARRAY [INTEGER] s2: ARRAY [REAL] s3: ARRAY [DOUBLE] s4: ARRAY [BOOLEAN] s5: ARRAY [CHARACTER] s6: ARRAY [POINTER] s7: ARRAY [ANY] array_area: ANY do from i := args.lower j := argument_types.lower nb := argument_count area := argument_array.area until i > nb loop arg_type := argument_types @ j arg_size := desc_get_size (arg_type) inspect arg_type when t_array then s1 ?= args @ i; if s1 = void then s2 ?= args @ i; if s2 = void then s3 ?= args @ i; if s3 = void then s4 ?= args @ i; if s4 = void then s5 ?= args @ i; if s5 = void then s6 ?= args @ i; if s6 = void then s7 ?= args @ i; array_area := s7.area else array_area := s6.area end else array_area := s5.area end else array_area := s4.area end else array_area := s3.area end else array_area := s2.area end else array_area := s1.area end; desc_copy_arg ($area, $array_area, position * 4, arg_size) when t_boolean then b_ref ?= args @ i; b := b_ref.item; if b then argument_array.put (1, position + 1) else argument_array.put (0, position + 1) end when t_character then c_ref ?= args @ i; c := c_ref.item; argument_array.put (c_ref.code, position + 1) when t_double then d_ref ?= args @ i; d := d_ref.item; desc_copy_arg ($area, $d, position * 4, arg_size); position := position + 1 when t_integer,t_short_integer then i_ref ?= args @ i; int := i_ref.item; argument_array.put (int, position + 1) when t_real then r_ref ?= args @ i; r := r_ref.item; desc_copy_arg ($area, $r, position * 4, arg_size) when t_pointer then p_ref ?= args @ i; p := p_ref.item; desc_copy_arg ($area, p, position * 4, arg_size) when t_reference then a := args @ i; desc_copy_arg ($area, $a, position * 4, arg_size) when t_string then s ?= args @ i; a := s.to_c; desc_copy_arg ($area, $a, position * 4, arg_size) end i := i + 1 j := j + 1 position := position + 1 end end function_handle: POINTER -- Pointer to the external routine imp_boolean_result: BOOLEAN -- Value when the routine returns a boolean imp_character_result: CHARACTER -- Value when the routine returns a character imp_double_result: DOUBLE -- Value when the routine returns a double imp_integer_result: INTEGER -- Value when the routine returns an integer imp_pointer_result: POINTER -- Value when the routine returns a pointer imp_real_result: REAL -- Value when the routine returns a real imp_reference_result: ANY -- Value when the routine returns a reference imp_string_result: STRING -- Value when the routine returns a string make_argument_array is -- Allocates area for stack pushing operation local i, nb: INTEGER size: INTEGER do from i := argument_types.lower nb := argument_types.upper until i > nb loop size := size + desc_get_size (argument_types @ i) i := i + 1 end create argument_array.make (1, size // 4) arguments_size := size // 4 end feature make_by_index (lib: DLL_32; r_index: INTEGER; arg_types: ARRAY [INTEGER]; ret_type: INTEGER) is -- Connect to the routine of index r_index in library lib require library_exists: lib /= void meaningful: lib.meaningful valid_index: r_index > 0 valid_argument_array: arg_types /= void valid_argument_types: valid_argument_types (arg_types) valid_return_type: valid_return_type (ret_type) do shared_library := lib library_index := r_index function_handle := desc_get_function_index_pointer (lib.module_handle, r_index) if function_handle /= default_pointer then error_code := no_error else error_code := no_routine end argument_types := arg_types return_type := ret_type make_argument_array routine_called := False ensure consistent_index: library_index = r_index consistent_lib: lib = shared_library routine_not_called: not routine_called end make_by_name (lib: DLL_32; f_name: STRING; arg_types: ARRAY [INTEGER]; ret_type: INTEGER) is -- Connect to the routine f_name in library lib require -- from SHARED_LIBRARY_ROUTINE library_exists: lib /= void meaningful: lib.meaningful function_name_non_void: f_name /= void function_name_non_empty: not f_name.is_empty valid_argument_array: arg_types /= void valid_argument_types: valid_argument_types (arg_types) valid_return_type: valid_return_type (ret_type) local c_func_name: ANY do shared_library := lib function_name := f_name c_func_name := f_name.to_c function_handle := win_get_proc_address (lib.module_handle, $c_func_name) if function_handle /= default_pointer then error_code := no_error else error_code := no_routine end argument_types := arg_types return_type := ret_type make_argument_array routine_called := False ensure -- from SHARED_LIBRARY_ROUTINE consistent_f_name: f_name.is_equal (function_name) consistent_lib: lib = shared_library routine_not_called: not routine_called end feature {NONE} -- Externals desc_call_dll32_boolean (f_ptr: POINTER; arg_count: INTEGER; actual_args: POINTER): BOOLEAN is -- Call to function returning a boolean external "C [dll32 %"ise_desc.dll%"] (DWORD, DWORD, char *): EIF_BOOLEAN" end desc_call_dll32_character (f_ptr: POINTER; arg_count: INTEGER; actual_args: POINTER): CHARACTER is -- Call to function returning a character external "C [dll32 %"ise_desc.dll%"] (DWORD, DWORD, char *): EIF_CHARACTER" end desc_call_dll32_double (f_ptr: POINTER; arg_count: INTEGER; actual_args: POINTER): DOUBLE is -- Call to function returning a double external "C [dll32 %"ise_desc.dll%"] (DWORD, DWORD, char *): EIF_DOUBLE" end desc_call_dll32_integer (f_ptr: POINTER; arg_count: INTEGER; actual_args: POINTER): INTEGER is -- Call to function returning an integer external "C [dll32 %"ise_desc.dll%"] (DWORD, DWORD, char *): EIF_INTEGER" end desc_call_dll32_pointer (f_ptr: POINTER; arg_count: INTEGER; actual_args: POINTER): POINTER is -- Call to function returning a pointer external "C [dll32 %"ise_desc.dll%"] (DWORD, DWORD, char *): EIF_POINTER" end desc_call_dll32_procedure (f_ptr: POINTER; arg_count: INTEGER; actual_args: POINTER) is -- Call to procedure external "C [dll32 %"ise_desc.dll%"] (DWORD, DWORD, char *)" end desc_call_dll32_real (f_ptr: POINTER; arg_count: INTEGER; actual_args: POINTER): REAL is -- Call to function returning a real external "C [dll32 %"ise_desc.dll%"] (DWORD, DWORD, char *): EIF_REAL" end desc_call_dll32_reference (f_ptr: POINTER; arg_count: INTEGER; actual_args: POINTER): ANY is -- Call to function returning a reference external "C [dll32 %"ise_desc.dll%"] (DWORD, DWORD, char *): EIF_REFERENCE" end desc_call_dll32_short_integer (f_ptr: POINTER; arg_count: INTEGER; actual_args: POINTER): INTEGER is -- Call to function returning a short integer external "C [dll32 %"ise_desc.dll%"] (DWORD, DWORD, char *): short int" end desc_call_dll32_string (f_ptr: POINTER; arg_count: INTEGER; actual_args: POINTER): POINTER is -- Call to function returning a string external "C [dll32 %"ise_desc.dll%"] (DWORD, DWORD, char *): EIF_POINTER" end desc_copy_arg (target, source: POINTER; offset, size: INTEGER) is -- Copy size characters from source -- to target + offset external "C [macro %"eif_desc.h%"]" alias "DESC_BCOPY" end desc_get_function_index_pointer (m_p: POINTER; r_index: INTEGER): POINTER is -- Get function handle (by index) external "C [dll32 %"ise_desc.dll%"] (DWORD, DWORD): EIF_POINTER" end desc_get_size (type: INTEGER): INTEGER is -- Get size of type type external "C [dll32 %"ise_desc.dll%"] (DWORD): short int" end desc_rtms (str: POINTER): STRING is -- Creates an Eiffel string from a -- C manifest string str external "C [macro %"eif_macros.h%"] (char *): EIF_REFERENCE" alias "RTMS" end win_get_proc_address (m_p, fn: POINTER): POINTER is -- Get function handle external "C [macro <windows.h>] (HINSTANCE, LPCSTR): EIF_POINTER" alias "GetProcAddress" end invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from SHARED_LIBRARY_ROUTINE library_exists: shared_library /= void meaningful_only_if_no_error: meaningful implies (error_code = no_error) meaningful_library: meaningful implies shared_library.meaningful indexing library: "[ EiffelBase: Library of reusable components for Eiffel. ]" status: "[ Copyright 1986-2001 Interactive Software Engineering (ISE). For ISE customers the original versions are an ISE product covered by the ISE Eiffel license and support agreements. ]" license: "[ EiffelBase may now be used by anyone as FREE SOFTWARE to develop any product, public-domain or commercial, without payment to ISE, under the terms of the ISE Free Eiffel Library License (IFELL) at http://eiffel.com/products/base/license.html. ]" source: "[ Interactive Software Engineering Inc. ISE Building 360 Storke Road, Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Electronic mail <info@eiffel.com> Customer support http://support.eiffel.com ]" info: "[ For latest info see award-winning pages: http://eiffel.com ]" end -- class DLL_32_ROUTINE -- Generated by ISE Eiffel --
For more details: www.eiffel.com