note
	description: "Error messages for EiffelCOM wizard."
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date$"
	revision: "$Revision$"

class
	WIZARD_ERRORS

feature -- Error Codes

	User_stop: INTEGER = 1
			-- User stopped generation

	Exception_raised: INTEGER = 2
			-- An exception was raised

	Eiffel_compilation_error: INTEGER = 3
			-- Eiffel compilation error

	Idl_generation_error: INTEGER = 4
			-- IDL generation error

	External_program_failed: INTEGER = 5
			-- External program (C compiler) failed

	Makefile_write_error: INTEGER = 6
			-- Makefile could not be written to disk

	File_write_error: INTEGER = 7
			-- File could not be written to disk

	No_type_library: INTEGER = 8
			-- No type library

	No_c_compiler: INTEGER = 9
			-- C compiler not found

	Class_not_in_project: INTEGER = 10
			-- Facade class not in Eiffel project

	C_compilation_failed: INTEGER = 11
			-- C compilation failed

	Idl_compilation_failed: INTEGER = 12
			-- IDL compilation failed

	Link_failed: INTEGER = 13
			-- C link failed

	Destination_folder_cleanup_error: INTEGER = 14
			-- Destination folder cleanup error

	No_midl_compiler: INTEGER = 15
			-- No MIDL compiler but using IDL

	Initialization_error: INTEGER = 16
			-- Could not create destination folder

feature -- Access

	error_title (a_error: INTEGER): STRING
			-- Error title associated with `a_error'
		require
			valid_error_code: is_valid_error_code (a_error)
		do
			Result := Error_table.item (a_error)
		ensure
			non_void_message: Result /= Void
		end

feature -- Status Report

	is_valid_error_code (a_error: INTEGER): BOOLEAN
			-- Is `a_error' a valid error code?
		do
			Result := a_error >= 0 and a_error <= Error_table.count
		end

feature {NONE} -- Implementation

	Error_table: ARRAY [STRING]
			-- Error table
		once
			create Result.make (1, 16)
			Result.put ("Generation stopped by user", User_stop)
			Result.put ("An exception was raised", Exception_raised)
			Result.put ("Eiffel compilation failed", Eiffel_compilation_error)
			Result.put ("IDL generation failed", Idl_generation_error)
			Result.put ("Execution of external utility failed", External_program_failed)
			Result.put ("Makefile could not be written to disk", Makefile_write_error)
			Result.put ("File could not be written to disk", File_write_error)
			Result.put ("Type library was not found (IDL compilation failed?)", No_type_library)
			Result.put ("Could not find C compiler installation", No_c_compiler)
			Result.put ("Eiffel Facade class not found in project", Class_not_in_project)
			Result.put ("C compilation failed", C_compilation_failed)
			Result.put ("IDL compilation failed", IDL_compilation_failed)
			Result.put ("C link failed", Link_failed)
			Result.put ("Could not cleanup destination folder, check for locked files", Destination_folder_cleanup_error)
			Result.put ("Could not find MIDL compiler, do not use IDL file for COM definition", No_midl_compiler)
			Result.put ("Could not create destination folder", Initialization_error)
		end

note
	copyright:	"Copyright (c) 1984-2006, Eiffel Software"
	license:	"GPL version 2 (see http://www.eiffel.com/licensing/gpl.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
			 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 WIZARD_ERRORS