diagnostics: add logical_location_manager; reimplement logical_location

Previously we used an abstract base class logical_location with
concrete subclasses to separate the diagnostics subsystem from
implementation details of "tree" and of libgdiagnostics.

This approach required allocating implementation objects on the heap
whenever working with logical locations, and made comparing logical
locations awkward.

This patch reworks things so that the type "logical_location" becomes a
boxed pointer (const void *), and client code provides a single object
implementing a new logical_location_manager abstract base class.  The
manager class has responsibility for providing meaning to the boxed
pointers.  Within the compiler we use a manager in which they are "tree"
pointers, whereas within libgdiagnostics we use a manager in which they
are pointers to instances of libgdiagnostics'
"struct diagnostic_logical_location".  Other kinds of manager could be
implemented.

gcc/analyzer/ChangeLog:
	* checker-event.cc (checker_event::checker_event): Update
	initialization of m_logical_loc.
	(checker_event::maybe_add_sarif_properties): Add "builder" param.
	Replace call to make_sarif_logical_location_object with call to
	sarif_property_bag::set_logical_location.
	(superedge_event::maybe_add_sarif_properties): Add "builder"
	param.
	* checker-event.h (checker_event::get_logical_location):
	Reimplement.
	(checker_event::maybe_add_sarif_properties): Add "builder" param.
	(checker_event::maybe_add_sarif_properties): Add "builder" param.
	(checker_event::m_logical_loc): Convert from tree_logical_location
	to logical_location.
	(superedge_event::maybe_add_sarif_properties): Add sarif_builder
	param.
	* checker-path.h (checker_path::checker_path): Add logical_loc_mgr
	param.
	* diagnostic-manager.cc
	(diagnostic_manager::emit_saved_diagnostic): Pass logical location
	manager to emission_path ctor.
	(diagnostic_manager::get_logical_location_manager): New.
	* diagnostic-manager.h
	(diagnostic_manager::get_logical_location_manager): New decl.

gcc/ChangeLog:
	* diagnostic-client-data-hooks.h: Include "logical-location.h".
	(diagnostic_client_data_hooks::get_logical_location_manager): New.
	(diagnostic_client_data_hooks::get_current_logical_location):
	Convert return type from const logical_location * to
	logical_location.
	* diagnostic-format-json.cc: Include
	"diagnostic-client-data-hooks.h".
	(make_json_for_path): Update to use logical_location_manager from
	the context.
	* diagnostic-format-sarif.cc
	(sarif_builder::get_logical_location_manager): New.
	(sarif_builder::make_location_object): Update type of logical_loc
	from "const logical_location *" to "logical_location".
	(sarif_builder::set_any_logical_locs_arr): Likewise.
	(sarif_builder::m_logical_loc_mgr): New field.
	(sarif_result::on_nested_diagnostic): Use logical_location default
	ctor rather than nullptr.
	(sarif_builder::sarif_builder): Initialize m_logical_loc_mgr from
	context's client data hooks.
	(sarif_builder::make_locations_arr): Convert type of logical_loc
	from from "const logical_location *" to "logical_location".
	(sarif_builder::set_any_logical_locs_arr): Likewise.  Pass manager
	to make_sarif_logical_location_object.
	(sarif_builder::make_location_object): Likewise.
	(sarif_property_bag::set_logical_location): New.
	(make_sarif_logical_location_object): Update for introduction of
	logical_location_manager.
	(populate_thread_flow_location_object): Pass builder to
	ev.maybe_add_sarif_properties.
	(selftest::test_make_location_object): Use logical_location
	default ctor rather than nullptr.
	* diagnostic-format-sarif.h (class logical_location): Replace
	forward decl with include of "logical-location.h".
	(class sarif_builder): New forward decl.
	(sarif_property_bag::set_logical_location): New.
	(make_sarif_logical_location_object): Add "mgr" param.
	* diagnostic-path.cc
	(diagnostic_path::get_first_event_in_a_function): Update for
	change of logical_location type.
	(per_thread_summary::per_thread_summary): Pass in
	"logical_loc_mgr".
	(per_thread_summary::m_logical_loc_mgr): New field.
	(event_range::m_logical_loc): Update for change of
	logical_location type.
	(path_summary::get_logical_location_manager): New accessor.
	(path_summary::m_logical_loc_mgr): New field.
	(path_summary::get_or_create_events_for_thread_id): Pass
	m_logical_loc_mgr to per_thread_summary ctor.
	(path_summary::path_summary): Initialize m_logical_loc_mgr.
	(thread_event_printer::print_swimlane_for_event_range): Add param
	"logical_loc_mgr".  Update for change in logical_loc type.
	(print_path_summary_as_text): Pass manager to
	thread_event_printer::print_swimlane_for_event_range.
	(diagnostic_text_output_format::print_path): Update for
	introduction of logical_location_manager.
	* diagnostic-path.h: Include "logical-location.h".
	(class sarif_builder): New forward decl.
	(diagnostic_event::get_logical_location): Convert return type from
	"const logical_location *" to "logical_location".
	(diagnostic_event::maybe_add_sarif_properties): Add sarif_builder
	param.
	(diagnostic_path::get_logical_location_manager): New accessor.
	(diagnostic_path::diagnostic_path): New ctor, taking manager.
	(diagnostic_path::m_logical_loc_mgr): New field.
	* diagnostic.cc
	(diagnostic_context::get_logical_location_manager): New.
	(logical_location::function_p): Convert to...
	(logical_location_manager::function_p): ...this.
	* diagnostic.h (class logical_location): Replace forward decl
	with...
	(class logical_location_manager): ...this.
	(diagnostic_context::get_logical_location_manager): New decl.
	* lazy-diagnostic-path.cc
	(selftest::test_lazy_path::test_lazy_path): Pass m_logical_loc_mgr
	to path ctor.
	(selftest::test_lazy_path::make_inner_path): Likewise.
	(selftest::test_lazy_path::m_logical_loc_mgr): New field.
	* lazy-diagnostic-path.h
	(lazy_diagnostic_path::lazy_diagnostic_path): New ctor.
	* libgdiagnostics.cc (struct diagnostic_logical_location): Convert
	from subclass of logical_location to a plain struct, dropping
	accessors.
	(class impl_logical_location_manager): New.
	(impl_diagnostic_client_data_hooks::get_logical_location_manager):
	New
	(impl_diagnostic_client_data_hooks::m_logical_location_manager):
	New field.
	(diagnostic_manager::get_logical_location_manager): New.
	(libgdiagnostics_path_event::get_logical_location): Reimplement.
	(diagnostic_execution_path::diagnostic_execution_path): Add
	logical_loc_mgr and pass to base class.
	(diagnostic_execution_path::same_function_p): Update for change to
	logical_location type.
	(diagnostic::add_execution_path): Pass logical_loc_mgr to path
	ctor.
	(impl_diagnostic_client_data_hooks::get_current_logical_location):
	Reimplement.
	(diagnostic_text_sink::text_starter): Reimplement printing of
	logical location.
	(diagnostic_manager::new_execution_path): Pass mgr to path ctor.
	(diagnostic_manager_debug_dump_logical_location): Update for
	changes to diagnostic_logical_location.
	(diagnostic_logical_location_get_kind): Likewise.
	(diagnostic_logical_location_get_parent): Likewise.
	(diagnostic_logical_location_get_short_name): Likewise.
	(diagnostic_logical_location_get_fully_qualified_name): Likewise.
	(diagnostic_logical_location_get_decorated_name): Likewise.
	* logical-location.h (class logical_location_manager): New.
	(class logical_location): Convert to typedef of
	logical_location_manager::key.
	* selftest-diagnostic-path.cc
	(selftest::test_diagnostic_path::test_diagnostic_path): Pass
	m_test_logical_loc_mgr to base ctor.
	(selftest::test_diagnostic_path::same_function_p): Use pointer
	comparison.
	(selftest::test_diagnostic_path::add_event): Use
	logical_location_from_funcname.
	(selftest::test_diagnostic_path::add_thread_event): Likewise.
	(selftest::test_diagnostic_path::logical_location_from_funcname):
	New.
	(selftest::test_diagnostic_event::test_diagnostic_event): Fix
	indentation.  Pass logical_location rather than const char *.
	* selftest-diagnostic-path.h
	(selftest::test_diagnostic_event::test_diagnostic_event):
	Likewise.
	(selftest::test_diagnostic_event::get_logical_location): Update
	for change to logical_location type.
	(selftest::test_diagnostic_event::get_function_name): Drop.
	(selftest::test_diagnostic_event::m_logical_loc): Convert from
	test_logical_location to logical_location.
	(selftest::test_diagnostic_path::logical_location_from_funcname):
	New.
	(selftest::test_diagnostic_path::m_test_logical_loc_mgr): New
	field.
	* selftest-logical-location.cc: Include "selftest.h".
	(selftest::test_logical_location::test_logical_location): Drop.
	(selftest::test_logical_location_manager::~test_logical_location_manager):
	New.
	(selftest::test_logical_location::get_short_name): Replace with...
	(selftest::test_logical_location_manager::get_short_name):
	...this.
	(selftest::test_logical_location::get_name_with_scope): Replace
	with...
	(selftest::test_logical_location_manager::get_name_with_scope):
	...this.
	(selftest::test_logical_location::get_internal_name): Replace
	with...
	(selftest::test_logical_location_manager::get_internal_name):
	...this.
	(selftest::test_logical_location::get_kind): Replace with...
	(selftest::test_logical_location_manager::get_kind): ...this.
	(selftest::test_logical_location::get_name_for_path_output):
	Replace with...
	(selftest::test_logical_location_manager::get_name_for_path_output):
	...this.
	(selftest::test_logical_location_manager::logical_location_from_funcname):
	New.
	(selftest::test_logical_location_manager::item_from_funcname):
	New.
	(selftest::selftest_logical_location_cc_tests): New.
	* selftest-logical-location.h (class test_logical_location):
	Replace with...
	(class test_logical_location_manager): ...this.
	* selftest-run-tests.cc (selftest::run_tests): Call
	selftest_logical_location_cc_tests.
	* selftest.h (selftest::selftest_logical_location_cc_tests): New
	decl.
	* simple-diagnostic-path.cc
	(simple_diagnostic_path::simple_diagnostic_path): Add
	"logical_loc_mgr" param and pass it to base ctor.
	(simple_diagnostic_event::simple_diagnostic_event): Update init of
	m_logical_loc.
	(selftest::test_intraprocedural_path): Update for changes to
	logical locations.
	* simple-diagnostic-path.h: Likewise.
	* tree-diagnostic-client-data-hooks.cc
	(compiler_data_hooks::get_logical_location_manger): New.
	(compiler_data_hooks::get_current_logical_location): Update.
	(compiler_data_hooks::m_current_fndecl_logical_loc): Replace
	with...
	(compiler_data_hooks::m_logical_location_manager): ...this.
	* tree-logical-location.cc
	(compiler_logical_location::get_short_name_for_tree): Replace
	with...
	(tree_logical_location_manager::get_short_name): ...this.
	(compiler_logical_location::get_name_with_scope_for_tree): Replace
	with...
	(tree_logical_location_manager::get_name_with_scope): ...this.
	(compiler_logical_location::get_internal_name_for_tree): Replace
	with...
	(tree_logical_location_manager::get_internal_name): ...this.
	(compiler_logical_location::get_kind_for_tree): Replace with...
	(tree_logical_location_manager::get_kind): ...this.
	(compiler_logical_location::get_name_for_tree_for_path_output):
	Replace with...
	(tree_logical_location_manager::get_name_for_path_output):
	...this.
	(tree_logical_location::get_short_name): Drop.
	(tree_logical_location::get_name_with_scope): Drop.
	(tree_logical_location::get_internal_name): Drop.
	(tree_logical_location::get_kind): Drop.
	(tree_logical_location::get_name_for_path_output): Drop.
	(current_fndecl_logical_location::get_short_name): Drop.
	(current_fndecl_logical_location::get_name_with_scope): Drop.
	(current_fndecl_logical_location::get_internal_name): Drop.
	(current_fndecl_logical_location::get_kind): Drop.
	(current_fndecl_logical_location::get_name_for_path_output): Drop.
	* tree-logical-location.h (class compiler_logical_location): Drop.
	(class tree_logical_location): Drop.
	(class current_fndecl_logical_location): Drop.
	(class tree_logical_location_manager): New.

gcc/testsuite/ChangeLog:
	* gcc.dg/plugin/diagnostic_plugin_test_paths.cc: Update for
	changes to simple_diagnostic_path.

Signed-off-by: David Malcolm <dmalcolm@redhat.com>

0 files changed, 0 insertions, 0 deletions