class invalid_syntax

Declaration

class invalid_syntax : public error_with_option_name { /* full declaration omitted */ };

Description

Class thrown when there's syntax error either for command line or config file options. See derived children for concrete classes.

Declared at: libs/pika/program_options/include/pika/program_options/errors.hpp:321

Inherits from: error_with_option_name

Member Variables

protected pika::program_options::invalid_syntax::kind_t m_kind

Inherited from error_with_option_name:

protected m_option_style

protected m_substitutions

protected m_substitution_defaults

public m_error_template

protected m_message

Method Overview

• protected std::string get_template(pika::program_options::invalid_syntax::kind_t kind)
• public invalid_syntax(pika::program_options::invalid_syntax::kind_t kind, const std::string & option_name = "", const std::string & original_token = "", int option_style = 0)
• public pika::program_options::invalid_syntax::kind_t kind() const
• public virtual std::string tokens() const
• public ~invalid_syntax() noexcept

Inherited from error_with_option_name:

• public add_context
• protected get_canonical_option_name
• protected get_canonical_option_prefix
• public get_option_name
• protected replace_token
• public set_option_name
• public set_original_token
• public set_prefix
• public set_substitute
• public set_substitute_default
• protected substitute_placeholders
• public what

Inherited from error:

Methods

std::string get_template(
    pika::program_options::invalid_syntax::kind_t
        kind)

Description

Used to convert kind_t to a related error text

Declared at: libs/pika/program_options/include/pika/program_options/errors.hpp:358

Parameters

pika::program_options::invalid_syntax::kind_t kind

invalid_syntax(
    pika::program_options::invalid_syntax::kind_t
        kind,
    const std::string& option_name = "",
    const std::string& original_token = "",
    int option_style = 0)

Declared at: libs/pika/program_options/include/pika/program_options/errors.hpp:335

Parameters

pika::program_options::invalid_syntax::kind_t kind

const std::string& option_name = ""

const std::string& original_token = ""

int option_style = 0

pika::program_options::invalid_syntax::kind_t
kind() const

Declared at: libs/pika/program_options/include/pika/program_options/errors.hpp:345

virtual std::string tokens() const

Description

Convenience functions for backwards compatibility

Declared at: libs/pika/program_options/include/pika/program_options/errors.hpp:351

~invalid_syntax() noexcept

Description

gcc says that throw specification on dtor is loosened without this line

Declared at: libs/pika/program_options/include/pika/program_options/errors.hpp:343