class section

Declaration

class section { /* full declaration omitted */ };

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:32

Method Overview

• public void add_entry(const std::string & key, const std::string & val)
• public void add_entry(const std::string & key, const pika::util::section::entry_type & val)
• public void add_notification_callback(const std::string & key, const pika::util::section::entry_changed_func & callback)
• public void add_section(const std::string & sec_name, pika::util::section & sec, pika::util::section * root = nullptr)
• public pika::util::section * add_section_if_new(const std::string & sec_name)
• protected pika::util::section & clone_from(const pika::util::section & rhs, pika::util::section * root = nullptr)
• public void dump(int ind = 0) const
• public void dump(int ind, std::ostream & strm) const
• public void expand(std::string & str, std::string::size_type len) const
• public std::string expand(const std::string & str) const
• public const pika::util::section::entry_map & get_entries() const
• public template <typename T>std::string get_entry(const std::string & key, T dflt) const
• public std::string get_entry(const std::string & key, const std::string & dflt) const
• public std::string get_entry(const std::string & key) const
• public std::string get_full_name() const
• public std::string get_name() const
• public std::string get_parent_name() const
• public pika::util::section * get_root() const
• public pika::util::section * get_section(const std::string & sec_name)
• public const pika::util::section * get_section(const std::string & sec_name) const
• public pika::util::section::section_map & get_sections()
• public const pika::util::section::section_map & get_sections() const
• public bool has_entry(const std::string & key) const
• public bool has_section(const std::string & sec_name) const
• protected void line_msg(std::string msg, const std::string & file, int lnum = 0, const std::string & line = "")
• public void merge(const std::string & second)
• public void merge(pika::util::section & second)
• public void parse(const std::string & sourcename, const std::vector<std::string> & lines, bool verify_existing = true, bool weed_out_comments = true, bool replace_existing = true)
• public void parse(const std::string & sourcename, const std::string & line, bool verify_existing = true, bool weed_out_comments = true, bool replace_existing = true)
• public void read(const std::string & filename)
• public section(const pika::util::section & in)
• public section(const std::string & filename, pika::util::section * root = nullptr)
• public section()
• public void set_name(const std::string & name)
• public void set_root(pika::util::section * r, bool recursive = false)
• public ~section()

Methods

void add_entry(const std::string& key,
               const std::string& val)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:171

Parameters

const std::string& key

const std::string& val

void add_entry(
    const std::string& key,
    const pika::util::section::entry_type& val)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:165

Parameters

const std::string& key

const pika::util::section::entry_type& val

void add_notification_callback(
    const std::string& key,
    const pika::util::section::entry_changed_func&
        callback)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:203

Parameters

const std::string& key

const pika::util::section::entry_changed_func& callback

void add_section(
    const std::string& sec_name,
    pika::util::section& sec,
    pika::util::section* root = nullptr)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:125

Parameters

const std::string& sec_name

pika::util::section& sec

pika::util::section* root = nullptr

pika::util::section* add_section_if_new(
    const std::string& sec_name)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:132

Parameters

const std::string& sec_name

pika::util::section& clone_from(
    const pika::util::section& rhs,
    pika::util::section* root = nullptr)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:61

Parameters

const pika::util::section& rhs

pika::util::section* root = nullptr

void dump(int ind = 0) const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:122

Parameters

int ind = 0

void dump(int ind, std::ostream& strm) const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:123

Parameters

int ind

std::ostream& strm

void expand(std::string& str,
            std::string::size_type len) const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:243

Parameters

std::string& str

std::string::size_type len

std::string expand(const std::string& str) const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:237

Parameters

const std::string& str

const pika::util::section::entry_map&
get_entries() const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:210

template <typename T>
std::string get_entry(const std::string& key,
                      T dflt) const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:197

Parameters

const std::string& key

T dflt

std::string get_entry(
    const std::string& key,
    const std::string& dflt) const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:189

Parameters

const std::string& key

const std::string& dflt

std::string get_entry(
    const std::string& key) const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:183

Parameters

const std::string& key

std::string get_full_name() const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:272

std::string get_name() const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:264

std::string get_parent_name() const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:268

pika::util::section* get_root() const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:260

pika::util::section* get_section(
    const std::string& sec_name)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:144

Parameters

const std::string& sec_name

const pika::util::section* get_section(
    const std::string& sec_name) const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:150

Parameters

const std::string& sec_name

pika::util::section::section_map& get_sections()

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:156

const pika::util::section::section_map&
get_sections() const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:160

bool has_entry(const std::string& key) const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:177

Parameters

const std::string& key

bool has_section(
    const std::string& sec_name) const

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:138

Parameters

const std::string& sec_name

void line_msg(std::string msg,
              const std::string& file,
              int lnum = 0,
              const std::string& line = "")

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:58

Parameters

std::string msg

const std::string& file

int lnum = 0

const std::string& line = ""

void merge(const std::string& second)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:120

Parameters

const std::string& second

void merge(pika::util::section& second)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:121

Parameters

pika::util::section& second

void parse(const std::string& sourcename,
           const std::vector<std::string>& lines,
           bool verify_existing = true,
           bool weed_out_comments = true,
           bool replace_existing = true)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:103

Parameters

const std::string& sourcename

const std::vector<std::string>& lines

bool verify_existing = true

bool weed_out_comments = true

bool replace_existing = true

void parse(const std::string& sourcename,
           const std::string& line,
           bool verify_existing = true,
           bool weed_out_comments = true,
           bool replace_existing = true)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:108

Parameters

const std::string& sourcename

const std::string& line

bool verify_existing = true

bool weed_out_comments = true

bool replace_existing = true

void read(const std::string& filename)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:119

Parameters

const std::string& filename

section(const pika::util::section& in)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:98

Parameters

const pika::util::section& in

section(const std::string& filename,
        pika::util::section* root = nullptr)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:97

Parameters

const std::string& filename

pika::util::section* root = nullptr

section()

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:96

void set_name(const std::string& name)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:279

Parameters

const std::string& name

void set_root(pika::util::section* r,
              bool recursive = false)

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:249

Parameters

pika::util::section* r

bool recursive = false

~section()

Declared at: libs/pika/ini/include/pika/ini/ini.hpp:99