class EL_LOGGED_APPLICATION
Client examples: BEXT_CLIENT_TEST_APP ; EDIT_HISTORY_TEST_APP ; FOURIER_MATH_CLIENT_TEST_APP ; PANGO_CAIRO_TEST_APP ; POST_CARD_VIEWER_APP ; QUANTUM_BALL_ANIMATION_APP
EL_APPLICATION with logging facility
test.ecf
EL_LOGGED_APPLICATION* BEXT_CLIENT_TEST_APP FOURIER_MATH_CLIENT_TEST_APP EL_AUTOTEST_APPLICATION* [EQA_TYPES -> TUPLE create default_create end] MULTIMEDIA_AUTOTEST_APP EL_CRC_32_AUTOTEST_APPLICATION* [EQA_TYPES -> TUPLE create default_create end] TAGLIB_AUTOTEST_APP PYXIS_SCAN_AUTOTEST_APP TEXT_FORMATS_AUTOTEST_APP VTD_XML_AUTOTEST_APP XML_SCAN_AUTOTEST_APP NETWORK_AUTOTEST_APP ECO_DB_AUTOTEST_APP EVOLICITY_AUTOTEST_APP I18N_AUTOTEST_APP IMAGE_UTILS_AUTOTEST_APP OPEN_OFFICE_AUTOTEST_APP THUNDERBIRD_AUTOTEST_APP PAYPAL_STANDARD_BUTTON_MANAGER_AUTOTEST_APP PUBLIC_KEY_ENCRYPTION_AUTOTEST_APP SEARCH_ENGINE_AUTOTEST_APP TEXT_PROCESS_AUTOTEST_APP EROS_AUTOTEST_APP HTTP_CLIENT_AUTOTEST_APP AMAZON_INSTANT_ACCESS_AUTOTEST_APP C_LANGUAGE_INTERFACE_AUTOTEST_APP COMPRESSION_AUTOTEST_APP CURRENCY_AUTOTEST_APP EIFFEL_AUTOTEST_APP ENCRYPTION_AUTOTEST_APP FILE_PROCESSING_AUTOTEST_APP OS_COMMAND_AUTOTEST_APP BASE_AUTOTEST_APP EL_LOGGED_COMMAND_LINE_APPLICATION* [C -> EL_APPLICATION_COMMAND] EROS_SERVER_APPLICATION* [C -> EROS_SERVER_COMMAND create make end] BEXT_SERVER_TEST_APP FOURIER_MATH_SERVER_TEST_APP
note
description: "${EL_APPLICATION} with logging facility"
descendants: "See end of class"
author: "Finnian Reilly"
copyright: "Copyright (c) 2001-2022 Finnian Reilly"
contact: "finnian at eiffel hyphen loop dot com"
license: "MIT license (See: en.wikipedia.org/wiki/MIT_License)"
date: "2024-08-16 9:07:55 GMT (Friday 16th August 2024)"
revision: "28"
deferred class
EL_LOGGED_APPLICATION
inherit
EL_APPLICATION
rename
init_console as init_console_and_logging
undefine
new_lio
redefine
do_application, help_requested, init_console_and_logging, io_put_header, print_help,
standard_options
end
EL_MODULE_LOG
EL_MODULE_LOG_MANAGER
EL_SHARED_LOG_OPTION
feature -- Status query
help_requested: BOOLEAN
-- `True' if user requested help or other information
do
Result := App_option.help or Log_option.log_filters
end
is_logging_active: BOOLEAN
do
Result := Log_option.logging and then not is_another_launched
end
is_logging_initialized: BOOLEAN
feature -- Constants
logs_dir_name: ZSTRING
once
Result := "logs"
end
feature -- Basic operations
print_help
do
if Log_option.log_filters then
lio.put_labeled_string ("LOGGED ROUTINES", "(All threads)")
lio.put_new_line
lio.tab_right
across Log_filter_list_table.item (Current) as list loop
list.item.print_to (lio)
if not list.is_last then
lio.put_new_line
end
end
lio.tab_left; lio.put_new_line
else
Precursor
end
end
feature {NONE} -- Implementation
do_application
local
log_stack_pos: INTEGER; ctrl_c_pressed, other_exception: BOOLEAN
do
if ctrl_c_pressed then
on_operating_system_signal
elseif other_exception then
on_exception
else
log.enter ("make")
log_stack_pos := log.call_stack_count
Precursor
end
log.exit
Log_manager.close_logs
if not other_exception then
try_deleting_logs
end
rescue
if Exception.is_termination_signal then
ctrl_c_pressed := True
else
other_exception := True
end
log.restore (log_stack_pos)
retry -- for normal exit
end
empty_log_filter_set: EL_LOG_FILTER_SET [TUPLE]
--
do
create Result.make_empty
end
init_console_and_logging
--
local
manager: like new_log_manager; global_logging: EL_GLOBAL_LOGGING
do
Precursor
manager := new_log_manager
try_deleting_logs
manager.initialize
create global_logging.make (is_logging_active)
if global_logging.is_active then
global_logging.set_loggable_routines (Log_filter_list_table.item (Current))
else
if manager.is_console_manager_active then
lio.put_string ("Thread logging disabled")
end
end
manager.add_thread (new_identified_main_thread)
is_logging_initialized := true
end
io_put_header
do
log.enter_no_header ("io_put_header")
Precursor
log.exit_no_trailer
if not Logging.is_active then
lio.put_new_line
end
end
log_filter_set: EL_LOG_FILTER_SET [TUPLE]
-- set of loggable classes
deferred
end
on_exception
do
Exception.put_last_trace (log)
end
standard_options: EL_ARRAYED_LIST [EL_COMMAND_LINE_OPTIONS]
do
Result := Precursor + Log_option
end
try_deleting_logs
do
if not Log_option.keep_logs and then not is_another_launched then
Log_manager.delete_logs
end
end
feature {EL_LOGGED_APPLICATION} -- Factory
new_identified_main_thread: EL_IDENTIFIED_MAIN_THREAD
do
create Result.make ("Main")
end
new_log_filter_list: LIST [EL_LOG_FILTER]
do
Result := new_log_filter_set.linear_representation
end
new_log_filter_set: EL_LOG_FILTER_SET [TUPLE]
--
do
Result := log_filter_set
end
new_log_manager: EL_LOG_MANAGER
do
create Result.make (is_logging_active, Log_output_directory)
end
feature {NONE} -- Constants
Log_filter_list_table: EL_FUNCTION_RESULT_TABLE [EL_LOGGED_APPLICATION, LIST [EL_LOG_FILTER]]
-- table of filter lists by sub-application type
once
create Result.make (11, agent {EL_LOGGED_APPLICATION}.new_log_filter_list)
end
Log_output_directory: DIR_PATH
once
Result := Directory.Sub_app_data #+ logs_dir_name
end
note
descendants: "[
**test.ecf**
EL_LOGGED_APPLICATION*
${BEXT_CLIENT_TEST_APP}
${FOURIER_MATH_CLIENT_TEST_APP}
${EL_AUTOTEST_APPLICATION* [EQA_TYPES -> TUPLE create default_create end]}
${MULTIMEDIA_AUTOTEST_APP}
${EL_CRC_32_AUTOTEST_APPLICATION* [EQA_TYPES -> TUPLE create default_create end]}
${TAGLIB_AUTOTEST_APP}
${PYXIS_SCAN_AUTOTEST_APP}
${TEXT_FORMATS_AUTOTEST_APP}
${VTD_XML_AUTOTEST_APP}
${XML_SCAN_AUTOTEST_APP}
${NETWORK_AUTOTEST_APP}
${ECO_DB_AUTOTEST_APP}
${EVOLICITY_AUTOTEST_APP}
${I18N_AUTOTEST_APP}
${IMAGE_UTILS_AUTOTEST_APP}
${OPEN_OFFICE_AUTOTEST_APP}
${THUNDERBIRD_AUTOTEST_APP}
${PAYPAL_STANDARD_BUTTON_MANAGER_AUTOTEST_APP}
${PUBLIC_KEY_ENCRYPTION_AUTOTEST_APP}
${SEARCH_ENGINE_AUTOTEST_APP}
${TEXT_PROCESS_AUTOTEST_APP}
${EROS_AUTOTEST_APP}
${HTTP_CLIENT_AUTOTEST_APP}
${AMAZON_INSTANT_ACCESS_AUTOTEST_APP}
${C_LANGUAGE_INTERFACE_AUTOTEST_APP}
${COMPRESSION_AUTOTEST_APP}
${CURRENCY_AUTOTEST_APP}
${EIFFEL_AUTOTEST_APP}
${ENCRYPTION_AUTOTEST_APP}
${FILE_PROCESSING_AUTOTEST_APP}
${OS_COMMAND_AUTOTEST_APP}
${BASE_AUTOTEST_APP}
${EL_LOGGED_COMMAND_LINE_APPLICATION* [C -> EL_APPLICATION_COMMAND]}
${EROS_SERVER_APPLICATION* [C -> EROS_SERVER_COMMAND create make end]}
${BEXT_SERVER_TEST_APP}
${FOURIER_MATH_SERVER_TEST_APP}
]"
end