note

	description:
		"General information about a profiled run."
	legal: "See notice at end of class."
	status: "See notice at end of class.";
	date: "$Date$";
	revision: "$Revision$"

class PROFILE_INFORMATION

create
	make

feature -- Creation

	make
		do
			create profile_data.make
			create cyclic_functions.make
		end

feature -- Adding information

	add_function_to_cycle (function: LANGUAGE_FUNCTION; number: INTEGER)
			-- Add `function' to cycle with `number'.
		require
			valid_cycle: has_cycle (number)
		do
			cyclic_functions.extend (function);
			profile_data.add_function_to_cycle (function, number)
		end

	has_cycle (number: INTEGER): BOOLEAN
			-- Is cycle `number' already been profiled?
		do
			Result := profile_data.has_cycle (number)
		end

	set_total_execution_time (new_time: REAL_64)
			-- Set total execution time to `new_time').
		require
			long_enough: new_time >= 0;
		do
			total_exec_time := new_time;
			available := True;
		end;

	insert_eiffel_profiling_data (data: EIFFEL_PROFILE_DATA)
			-- Insert `data'
		require
			valid_data: data /= Void;
		do
			profile_data.insert_eiffel_profiling_data (data);
		end;

	insert_c_profiling_data (data: C_PROFILE_DATA)
			-- Insert `data'
		require
			valid_data: data /= Void;
		do
			profile_data.insert_c_profiling_data (data);
		end;

	insert_cycle_profiling_data (data: CYCLE_PROFILE_DATA)
			-- Insert `data'
		require
			valid_cycle: data /= Void;
		do
			profile_data.insert_cycle_profiling_data (data);
		end;

	stop_computation
			-- Stops computation of the average-attributes.
		do
			profile_data.stop_computation;
		end;

feature -- Status report

	is_total_time_available: BOOLEAN
			-- May `total_execution_time' be querried?
		do
			Result := available;
		end;

	total_execution_time: REAL_64
			-- Time spent during the last run.
		require
			availble: is_total_time_available;
		do
			Result := total_exec_time;
		end;

	number_of_eiffel_features: INTEGER
			-- Number of Eiffel features called
			-- during the last run.
		do
			Result := profile_data.number_of_eiffel_features;
		end;

	number_of_c_functions: INTEGER
			-- Number of C functions called during the
			-- last run.
		do
			Result := profile_data.number_of_c_functions;
		end;

	number_of_cycles: INTEGER
			-- Number of cycles detected during the last run.
		do
			Result := profile_data.number_of_cycles;
		end;

	number_of_cyclic_functions: INTEGER
			-- Number of C functions that are part of
			-- of a cycle.
		do
			-- BAGGER
		end;

	number_of_cyclic_features: INTEGER
			-- Number of Eiffel features that are part
			-- of a call cycle
		do
			-- MEER BAGGER
		end;

	number_of_feature_calls: INTEGER
			-- Number of calls to Eiffel features
		do
			Result := profile_data.number_of_feature_calls;
		end;

	number_of_function_calls: INTEGER
			-- Number of calls to C functions
		do
			Result := profile_data.number_of_function_calls;
		end;

feature -- All information

	profile_data: PROFILE_SET
		-- Set with all profile information

	set_profile_data (new_data: PROFILE_SET)
			-- Keep `new_data' as `profile_data'.
		require
			no_ghosts: new_data /= Void;
		do
			profile_data := new_data;
		ensure
			no_wrong_assignment: profile_data = new_data;
		end;

feature {NONE} -- Attributes

	cyclic_functions: LINKED_LIST [LANGUAGE_FUNCTION]
		-- All functions that are part of a cycle.
		-- Containing Eiffel features and C functions.

	total_exec_time: REAL_64
		-- Time spent during execution of application in seconds.

	available: BOOLEAN
		-- Is total execution time available

invariant

note
	copyright:	"Copyright (c) 1984-2013, 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
			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 PROFILE_INFORMATION