diagnostics::output_spec::key_handler Class Reference

#include <output-spec.h>

Inheritance diagram for diagnostics::output_spec::key_handler:

Public Types
enum class	result { ok , unrecognized , malformed_value }

Public Member Functions
virtual enum result	maybe_handle_kv (const context &ctxt, const std::string &key, const std::string &value)=0
virtual void	get_keys (auto_vec< const char * > &out) const =0
enum result	parse_bool_value (const context &ctxt, const std::string &key, const std::string &value, bool &out) const
template<typename EnumType, size_t NumValues>
enum result	parse_enum_value (const context &ctxt, const std::string &key, const std::string &value, const std::array< std::pair< const char *, EnumType >, NumValues > &value_names, EnumType &out) const
template<typename EnumType, size_t NumValues>
key_handler::result	parse_enum_value (const context &ctxt, const std::string &key, const std::string &value, const std::array< std::pair< const char *, EnumType >, NumValues > &value_names, EnumType &out) const

Detailed Description

An abstract base class for schemes, and for client-specific keys.   

Member Enumeration Documentation

result

enum class diagnostics::output_spec::key_handler::result

strong

Enumerator
ok
unrecognized
malformed_value

Member Function Documentation

get_keys()

virtual void diagnostics::output_spec::key_handler::get_keys ( auto_vec< const char * > & out ) const

pure virtual

Implemented in diagnostics::output_spec::html_scheme_handler, diagnostics::output_spec::sarif_scheme_handler, and diagnostics::output_spec::text_scheme_handler.

Referenced by diagnostics::output_spec::context::report_unknown_key().

maybe_handle_kv()

virtual enum result diagnostics::output_spec::key_handler::maybe_handle_kv ( const context & ctxt, const std::string & key, const std::string & value )

pure virtual

Implemented in diagnostics::output_spec::html_scheme_handler, diagnostics::output_spec::sarif_scheme_handler, and diagnostics::output_spec::text_scheme_handler.

Referenced by diagnostics::output_spec::context::handle_kv().

parse_bool_value()

enum key_handler::result diagnostics::output_spec::key_handler::parse_bool_value	(	const context &	ctxt,
		const std::string &	key,
		const std::string &	value,
		bool &	out ) const

References diagnostics::output_spec::context::get_option_name(), diagnostics::output_spec::context::get_unparsed_spec(), malformed_value, ok, and diagnostics::output_spec::context::report_error().

Referenced by diagnostics::output_spec::html_scheme_handler::maybe_handle_kv(), diagnostics::output_spec::sarif_scheme_handler::maybe_handle_kv(), and diagnostics::output_spec::text_scheme_handler::maybe_handle_kv().

parse_enum_value() [1/2]

template<typename EnumType, size_t NumValues>

key_handler::result diagnostics::output_spec::key_handler::parse_enum_value	(	const context &	ctxt,
		const std::string &	key,
		const std::string &	value,
		const std::array< std::pair< const char *, EnumType >, NumValues > &	value_names,
		EnumType &	out ) const

References diagnostics::output_spec::context::get_option_name(), diagnostics::output_spec::context::get_unparsed_spec(), malformed_value, ok, and diagnostics::output_spec::context::report_error().

parse_enum_value() [2/2]

template<typename EnumType, size_t NumValues>

enum result diagnostics::output_spec::key_handler::parse_enum_value	(	const context &	ctxt,
		const std::string &	key,
		const std::string &	value,
		const std::array< std::pair< const char *, EnumType >, NumValues > &	value_names,
		EnumType &	out ) const

Referenced by diagnostics::output_spec::sarif_scheme_handler::maybe_handle_kv().

---

The documentation for this class was generated from the following files:

• output-spec.h
• output-spec.cc