indexing
	description	: "Manager for all output tools. Can be instanciated on the fly."
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date		: "$Date$"
	revision	: "$Revision$"
	author		: "$Author$"

class
	EB_GRAPHICAL_OUTPUT_MANAGER

inherit
	EB_OUTPUT_MANAGER
		redefine
			process_basic_text,
			process_quoted_text,
			process_comment_text,
			process_class_name_text,
			process_cluster_name_text,
			process_target_name_text,
			process_feature_name_text,
			process_feature_text,
			process_breakpoint_index,
			process_breakpoint,
			process_padded,
			process_new_line,
			process_indentation,
			process_after_class,
			process_before_class,
			process_filter_item,
			process_symbol_text,
			process_keyword_text,
			process_operator_text,
			process_address_text,
			process_error_text,
			process_cl_syntax,
			start_processing,
			end_processing,
			add,
			add_string,
			add_new_line,
			set_context_group,
			clear_general
		end

	EB_SHARED_DEBUGGER_MANAGER
		export
			{NONE} all
		end

	SHARED_EIFFEL_PROJECT
		export
			{NONE} all
		end

	SHARED_WORKBENCH
		export
			{NONE} all
		end

	OUTPUT_ROUTINES
		export
			{NONE} all
		end

	EB_CONSTANTS
		export
			{NONE} all
		end

	EB_TEXT_OUTPUT_FACTORY
		export
			{NONE} all
		end

feature -- Basic Operations / Generic purpose

	force_display is
			-- Make the output tools visible (to ensure the user sees what we print).
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.force_display
				end
				managed_output_tools.forth
			end
		end

	scroll_to_end is
			-- Make all output tools scroll to the bottom.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				managed_output_tools.item.scroll_to_end
				managed_output_tools.forth
			end
		end

	clear is
			-- Clear the window.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				managed_output_tools.item.clear
				managed_output_tools.forth
			end
		end

	clear_general is
			-- Clear the window.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.clear
				end
				managed_output_tools.forth
			end
		end

	process_errors (errors: LINKED_LIST [ERROR]) is
			-- Print `errors' on all output tools.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				managed_output_tools.item.process_errors (errors)
				managed_output_tools.forth
			end
		end

	process_warnings (warnings: LINKED_LIST [ERROR]) is
			-- Print `warnings' on all output tools.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				managed_output_tools.item.process_warnings (warnings)
				managed_output_tools.forth
			end
		end

feature -- Basic Operations / Information message

	display_system_info is
			-- Print information about the current project.
		local
			l_error: BOOLEAN
		do
			force_display
			clear_general
			start_processing (true)
			if Workbench.is_already_compiled then
				l_error := structured_system_info (Current)
			else
				add ("No compiled project")
				add_new_line
			end
			end_processing

			if l_error then
				clear_general
			end
		end

	display_application_status is
			-- Display the status of the application, or "Not running" if
			-- the application is not running.
		local
			l_error: BOOLEAN
		do
				-- Build the text
			start_processing (true)
			if Debugger_manager.application_is_executing then
				Eb_debugger_manager.text_formatter_visitor.append_status (Debugger_manager.application_status, Current)
			else
				add ("System not launched")
				add_new_line
				l_error := structured_system_info (Current)
				if l_error then
					clear_general
					add ("System not launched")
					add_new_line
				end
			end
			end_processing
		end

	display_breakpoints is
			-- Print information about the current project.
		local
			enabled_bps: BOOLEAN
			disabled_bps: BOOLEAN
			bpm: BREAKPOINTS_MANAGER
		do
				-- Build text.
			clear_general
			start_processing (true)
			bpm := Debugger_manager
			if  not bpm.has_breakpoints then
				add ("No breakpoints.")
				add_new_line
			else
				enabled_bps := bpm.has_enabled_breakpoints
				disabled_bps := bpm.has_disabled_breakpoints

				if enabled_bps then
					add ("Enabled breakpoints:")
					add_new_line
					add_new_line
					display_filtered_breakpoints (Current, bpm.features_with_breakpoint_set, True)
					if disabled_bps then
						add_new_line
						add ("-------------")
						add_new_line
						add_new_line
					end
				end
				if disabled_bps then
					add ("Disabled breakpoints:")
					add_new_line
					add_new_line
					display_filtered_breakpoints (Current, bpm.features_with_breakpoint_set, False)
				end
			end
			add_new_line
			end_processing
		end

feature -- Basic Operations / Compiler messages

	start_processing (append: BOOLEAN) is
			-- Start processing.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				managed_output_tools.item.text_area.handle_before_processing (append)
				managed_output_tools.forth
			end
		end

	end_processing is
			-- End processing.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				managed_output_tools.item.text_area.handle_after_processing
				managed_output_tools.forth
			end
		end

	trace_warnings (handler: ERROR_HANDLER) is
			-- Display warnings messages from `handler'.
		do
			process_warnings (handler.warning_list)
		end

	trace_errors (handler: ERROR_HANDLER) is
			-- Display error messages from `handler'.
		do
			process_errors (handler.error_list)
		end

feature -- Element change

	extend (an_output_tool: EB_OUTPUT_TOOL) is
			-- Add this output tool to the list of managed output tools.
		do
			managed_output_tools.extend (an_output_tool)
		end

	prune (an_output_tool: EB_OUTPUT_TOOL) is
			-- Remove this output tool from the list of managed output tools.
		do
			managed_output_tools.start
			managed_output_tools.prune_all (an_output_tool)
		end

	set_context_group (a_group: like context_group) is
			-- Set context_group with `a_group'.
		do
			Precursor {EB_OUTPUT_MANAGER}(a_group)
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.set_context_group (a_group)
				end
				managed_output_tools.forth
			end
		end

feature {NONE} -- Text formatter

	add (s: STRING_GENERAL) is
			-- Add basic text.
		do
			process_basic_text (s)
		end

	add_string (s: STRING_GENERAL) is
			-- Add string text.
		do
			process_string_text (s, Void)
		end

	add_new_line is
			-- Add new line.
		do
			process_new_line
		end

	process_basic_text (text: STRING_GENERAL) is
			-- Process default basic text `t'.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_basic_text (text)
				end
				managed_output_tools.forth
			end
		end

	process_quoted_text (text: STRING_GENERAL) is
			-- Process the quoted `text' within a comment.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_quoted_text (text)
				end
				managed_output_tools.forth
			end
		end

	process_comment_text (text: STRING_GENERAL; url: STRING_GENERAL) is
			-- Process comment text.
			-- `url' is possible url, which can be void if none.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_comment_text (text, url)
				end
				managed_output_tools.forth
			end
		end

	process_class_name_text (text: STRING_GENERAL; a_class: CLASS_I; a_quote: BOOLEAN) is
			-- Process class name of `a_class'.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_class_name_text (text, a_class, a_quote)
				end
				managed_output_tools.forth
			end
		end

	process_cluster_name_text (text: STRING_GENERAL; a_cluster: CLUSTER_I; a_quote: BOOLEAN) is
			-- Process cluster name of `a_cluster'.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_cluster_name_text (text, a_cluster, a_quote)
				end
				managed_output_tools.forth
			end
		end

	process_target_name_text (text: STRING_GENERAL; a_target: CONF_TARGET) is
			-- Process target name text `text'.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_target_name_text (text, a_target)
				end
				managed_output_tools.forth
			end
		end

	process_feature_name_text (text: STRING_GENERAL; a_class: CLASS_C) is
			-- Process feature name text `text'.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_feature_name_text (text, a_class)
				end
				managed_output_tools.forth
			end
		end

	process_feature_text (text: STRING_GENERAL; a_feature: E_FEATURE; a_quote: BOOLEAN) is
			-- Process feature text `text'.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_feature_text (text, a_feature, a_quote)
				end
				managed_output_tools.forth
			end
		end

	process_breakpoint_index (a_feature: E_FEATURE; a_index: INTEGER; a_cond: BOOLEAN) is
			-- Process breakpoint index `a_index'.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_breakpoint_index (a_feature, a_index, a_cond)
				end
				managed_output_tools.forth
			end
		end

	process_breakpoint (a_feature: E_FEATURE; a_index: INTEGER) is
			-- Process breakpoint.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_breakpoint (a_feature, a_index)
				end
				managed_output_tools.forth
			end
		end

	process_padded is
			-- Process padded item at start of non breakpoint line.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_padded
				end
				managed_output_tools.forth
			end
		end

	process_new_line is
			-- Process new line.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_new_line
				end
				managed_output_tools.forth
			end
		end

	process_indentation (a_indent_depth: INTEGER) is
			-- Process indentation `t'.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_indentation (a_indent_depth)
				end
				managed_output_tools.forth
			end
		end

	process_after_class (a_class: CLASS_C) is
			-- Process after class `a_class'.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_after_class (a_class)
				end
				managed_output_tools.forth
			end
		end

	process_before_class (a_class: CLASS_C) is
			-- Process before class `a_class'.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_before_class (a_class)
				end
				managed_output_tools.forth
			end
		end

	process_filter_item (text: STRING_GENERAL; is_before: BOOLEAN) is
			-- Process filter text `t'.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_filter_item (text, is_before)
				end
				managed_output_tools.forth
			end
		end

	process_symbol_text (text: STRING_GENERAL) is
			-- Process symbol text.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_symbol_text (text)
				end
				managed_output_tools.forth
			end
		end

	process_keyword_text (text: STRING_GENERAL; a_feature: E_FEATURE) is
			-- Process keyword text.
			-- `a_feature' is possible feature.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_keyword_text (text, a_feature)
				end
				managed_output_tools.forth
			end
		end

	process_operator_text (text: STRING_GENERAL; a_feature: E_FEATURE) is
			-- Process operator text.
			-- `a_feature' can be void.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_operator_text (text, a_feature)
				end
				managed_output_tools.forth
			end
		end

	process_address_text (a_address, a_name: STRING_GENERAL; a_class: CLASS_C) is
			-- Process address text.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_address_text (a_address, a_name, a_class)
				end
				managed_output_tools.forth
			end
		end

	process_error_text (text: STRING_GENERAL; a_error: ERROR) is
			-- Process error text.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_error_text (text, a_error)
				end
				managed_output_tools.forth
			end
		end

	process_cl_syntax (text: STRING_GENERAL; a_syntax_message: SYNTAX_MESSAGE; a_class: CLASS_C) is
			-- Process class syntax text.
		do
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					managed_output_tools.item.text_area.text_displayed.process_cl_syntax (text, a_syntax_message, a_class)
				end
				managed_output_tools.forth
			end
		end

feature {NONE} -- Implementation

	display_filtered_breakpoints (a_text_formatter: TEXT_FORMATTER; routine_list: LIST [E_FEATURE]; display_enabled:BOOLEAN) is
			-- Display either the list of routines whose stop points are
			-- activated, or the list of routines whose stop points have been
			-- deactivated.
		local
			table: HASH_TABLE [PART_SORTED_TWO_WAY_LIST[E_FEATURE], INTEGER]
			stwl: PART_SORTED_TWO_WAY_LIST [E_FEATURE]
			f: E_FEATURE
			c: CLASS_C
			i: INTEGER
			bp_list: LIST [INTEGER]
			first_bp, has_bp: BOOLEAN
			bpm: BREAKPOINTS_MANAGER
		do
			from
				create table.make (5)
				routine_list.start
			until
				routine_list.after
			loop
				f := routine_list.item
				c := f.written_class
				stwl := table.item (c.class_id)
				if stwl = Void then
					create stwl.make
					table.put (stwl, c.class_id)
				end
				stwl.extend (f)
				routine_list.forth
			end
			bpm := Debugger_manager
			from
				table.start
			until
				table.after
			loop
				stwl := table.item_for_iteration
				c := Eiffel_system.class_of_id (table.key_for_iteration)
				has_bp := False
				from
					stwl.start
				until
					stwl.after or has_bp
				loop
					f := stwl.item
					if display_enabled then
						bp_list := bpm.breakpoints_enabled_for (f)
					else
						bp_list := bpm.breakpoints_disabled_for (f)
					end
					has_bp := not bp_list.is_empty
					stwl.forth
				end
				if has_bp then
					from
						stwl.start
						a_text_formatter.add_classi (c.lace_class, c.name_in_upper)
						a_text_formatter.add (": ")
						a_text_formatter.add_new_line
					until
						stwl.after
					loop
						f := stwl.item
						if display_enabled then
							bp_list := bpm.breakpoints_enabled_for (f)
						else
							bp_list := bpm.breakpoints_disabled_for (f)
						end
						if not bp_list.is_empty then
							a_text_formatter.add_indent
							a_text_formatter.add_feature (f, f.name)
							from
								a_text_formatter.add (" [")
								first_bp := True
								bp_list.start
							until
								bp_list.after
							loop
								i := bp_list.item
								if not first_bp then
									a_text_formatter.add (", ")
								else
									first_bp := False
								end
								if bpm.is_breakpoint_set (f, i) then
									a_text_formatter.add_breakpoint_index (f, i, bpm.has_conditional_stop (f, i))
								end
								bp_list.forth
							end
							a_text_formatter.add ("]")
							a_text_formatter.add_new_line
						end
						stwl.forth
					end
				end
				table.forth
			end
		end

feature {NONE} -- Implementation / Private attributes

	managed_output_tools: ARRAYED_LIST [EB_OUTPUT_TOOL] is
			-- Managed output tools
		indexing
			once_status: global
		once
			create Result.make (10)
		end

	general_output_tools: ARRAYED_LIST [EB_OUTPUT_TOOL] is
			-- General output tool
		do
			create Result.make (3)
			from
				managed_output_tools.start
			until
				managed_output_tools.after
			loop
				if managed_output_tools.item.is_general then
					Result.extend (managed_output_tools.item)
				end
			end
		end

indexing
	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 EB_OUTPUT_MANAGER