diagnostics::output_spec::scheme_handler Class Reference

#include <output-spec.h>

Inheritance diagram for diagnostics::output_spec::scheme_handler:

Collaboration diagram for diagnostics::output_spec::scheme_handler:

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

Public Member Functions
	scheme_handler (std::string scheme_name)
virtual	~scheme_handler ()
const std::string &	get_scheme_name () const
virtual std::unique_ptr< sink >	make_sink (const context &ctxt, diagnostics::context &dc)=0
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

Private Attributes
const std::string	m_scheme_name

Detailed Description

Abstract subclass for handling particular schemes and their keys.   

Member Enumeration Documentation

result

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

stronginherited

Enumerator
ok
unrecognized
malformed_value

Constructor & Destructor Documentation

scheme_handler()

diagnostics::output_spec::scheme_handler::scheme_handler ( std::string scheme_name )

inline

References m_scheme_name.

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

~scheme_handler()

virtual diagnostics::output_spec::scheme_handler::~scheme_handler ( )

inlinevirtual

Member Function Documentation

get_keys()

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

pure virtualinherited

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().

get_scheme_name()

const std::string & diagnostics::output_spec::scheme_handler::get_scheme_name ( ) const

inline

References m_scheme_name.

Referenced by diagnostics::output_spec::html_scheme_handler::make_sink(), diagnostics::output_spec::sarif_scheme_handler::make_sink(), and diagnostics::output_spec::context::report_unknown_key().

make_sink()

virtual std::unique_ptr< sink > diagnostics::output_spec::scheme_handler::make_sink ( const context & ctxt, diagnostics::context & dc )

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::output_factory::make_sink().

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 virtualinherited

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

inherited

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

inherited

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

inherited

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

Field Documentation

m_scheme_name

const std::string diagnostics::output_spec::scheme_handler::m_scheme_name

private

Referenced by get_scheme_name(), and scheme_handler().

---

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

• output-spec.h