Automatic generation produced by ISE Eiffel
note description: "[ An interface of the dynamic API loader for accessing libraries and loaded library API functions and variables. Note: This class is not indented for direct use as {DYNAMIC_API} providers a safer model. However direct access to loading or querying for an API feature may be necessary, hence the interface is available. ]" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2019-08-16 05:08:28 -0800 (Fri, 16 Aug 2019) $" revision: "$Revision: 103408 $" deferred class interface DYNAMIC_API_LOADER_I feature -- Access generating_type: TYPE [detachable DYNAMIC_API_LOADER_I] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: DYNAMIC_API_LOADER_I): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: DYNAMIC_API_LOADER_I): 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 ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b 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 instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: DYNAMIC_API_LOADER_I): 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 is_dynamic_library_supported: BOOLEAN -- Inidcates if dynamic libraries are supported by the OS. 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: DYNAMIC_API_LOADER_I) -- 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: Current ~ other frozen deep_copy (other: DYNAMIC_API_LOADER_I) -- 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: DYNAMIC_API_LOADER_I -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: DYNAMIC_API_LOADER_I) -- 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: DYNAMIC_API_LOADER_I -- 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: DYNAMIC_API_LOADER_I -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable DYNAMIC_API_LOADER_I -- 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) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class load_library (a_name: READABLE_STRING_GENERAL; a_version: detachable READABLE_STRING_GENERAL): POINTER -- Attempts to loads a dynamic library using a library name. -- -- a_name: The name of a dynamic library, without an extension. -- a_version: An optional version string of the library to load. -- Result: A pointer to the loaded library module, or `default_pointer` if the library could not be loaded. require is_dynamic_library_supported: is_dynamic_library_supported a_name_attached: attached a_name not_a_name_is_empty: not a_name.is_empty not_a_version_is_empty: attached a_version implies not a_version.is_empty load_library_from_path (a_path: READABLE_STRING_GENERAL): POINTER -- Attempts to loads a dynamic library from a path on disk. -- -- a_path: The path to a dynamic library. -- Result: A pointer to the loaded library module, or `default_pointer` if the library could not be loaded. require is_dynamic_library_supported: is_dynamic_library_supported a_path_attached: attached a_path not_a_path_is_empty: not a_path.is_empty unload_library (a_hnd: POINTER) -- Attempts to unloads a dynamic library using a library name. -- -- a_hnd: The module handle pointer returned from `load_library` or `load_library_from_path`. require is_dynamic_library_supported: is_dynamic_library_supported not_a_hnd_is_null: a_hnd /= default_pointer feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void feature -- Query api_pointer (a_hnd: POINTER; a_api_name: READABLE_STRING_8): POINTER -- Retrieves a pointer to a library's API. -- -- a_hnd: A valid handle pointer to a loaded dynamic library. -- a_api_name: The API feature name to fetch a pointer to. -- Result: A pointer to an API feature or `default_pointer` if the API routine could not be -- found. require is_dynamic_library_supported: is_dynamic_library_supported not_a_hnd_is_null: a_hnd /= default_pointer a_api_name_attached: attached a_api_name not_a_api_name_is_empty: not a_api_name.is_empty api_pointer_with_raise (a_hnd: POINTER; a_api_name: READABLE_STRING_8): POINTER -- Retrieves a pointer to a library's API, and raises an exception if the API feature was not -- found. -- -- a_hnd: A valid handle pointer to a loaded dynamic library. -- a_api_name: The API feature name to fetch a pointer to. -- Result: A pointer to an API feature. require is_dynamic_library_supported: is_dynamic_library_supported not_a_hnd_is_null: a_hnd /= default_pointer a_api_name_attached: attached a_api_name not_a_api_name_is_empty: not a_api_name.is_empty ensure not_result_is_null: Result /= default_pointer invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2019, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" licensing_options: "http://www.eiffel.com/licensing" copying: "[ This file is part of Eiffel Software's Eiffel Development Environment. Eiffel Software's Eiffel Development Environment 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, version 2 of the License (available at the URL listed under "license" above). Eiffel Software's Eiffel Development Environment 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 Eiffel Software's Eiffel Development Environment; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA ]" source: "[ Eiffel Software 5949 Hollister Ave., 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 DYNAMIC_API_LOADER_I -- Generated by Eiffel Studio --
For more details: eiffel.org