Clingo::Config Class Reference

Class modeling a mutable configuration entry. More...

#include <config.hh>

Inheritance diagram for Clingo::Config:

Public Member Functions
	Config (clingo_config_t *stats, ProgramId key)
	Construct from the underlying C API type and a key.
auto	array () const -> ConfigArray
	Access the configuration entry as an array.
auto	at (size_t index) const -> Config
	Get the configuration entry at the given index in the array.
auto	operator[] (size_t index) const -> Config
	Get the configuration entry at the given index in the array.
auto	map () const -> ConfigMap
	Access the configuration entry as a map.
auto	get (std::string_view name) const -> Config
	Get the configuration entry with the given name in the map.
auto	operator[] (std::string_view name) const -> Config
	Get the configuration entry with the given name in the map.
void	value (std::string_view value) const
	Set the value of the configuration entry.
auto	operator= (std::string_view value) const -> Config
	Set the value of the configuration entry.
template<class Handler >
void	add (std::string_view name, std::string_view description, Handler &&handler) const
	Add a new configuration entry with a custom handler.
void	add (std::string_view name, std::string_view description) const
	Add a new configuration entry.
auto	value () const -> std::optional< std::string_view >
	Get the value of the configuration entry.
Public Member Functions inherited from Clingo::ConstConfig
	ConstConfig (clingo_config_t const *stats, ProgramId key)
	Construct from the underlying C API type and a key.
auto	type () const -> ConfigType
	Get the type of the configuration entry.
auto	array () const -> ConstConfigArray
	Access the configuration entry as an array.
auto	at (size_t index) const -> ConstConfig
	Get the configuration entry at the given index in the array.
auto	operator[] (size_t index) const -> ConstConfig
	Get the configuration entry at the given index in the array.
auto	map () const -> ConstConfigMap
	Access the configuration entry as a map.
auto	get (std::string_view name) const -> ConstConfig
	Get the configuration entry with the given name in the map.
auto	operator[] (std::string_view name) const -> ConstConfig
	Get the configuration entry with the given name in the map.
auto	value () const -> std::optional< std::string_view >
	Get the value of the configuration entry.
auto	operator* () const -> std::optional< std::string_view >
	Get the value of the configuration entry.
auto	description () const -> std::string_view
	Get the description of the configuration entry.
auto	to_string () const -> std::string
	Get a string representation of the configuration entry.

Friends
auto	c_cast (Config const &stats) -> clingo_config_t *
	Cast the configuration to the underlying C API type.

Detailed Description

Class modeling a mutable configuration entry.

Constructor & Destructor Documentation

Config()

Clingo::Config::Config ( clingo_config_t *  stats, ProgramId  key  )

inlineexplicit

Construct from the underlying C API type and a key.

Parameters

stats	the underlying C API type
key	the key of the configuration entry

Member Function Documentation

add() [1/2]

void Clingo::Config::add ( std::string_view  name, std::string_view  description  ) const

inline

Add a new configuration entry.

Adds a configuration entry with the given name and description. The entry is just for organizational purposes and has no value.

Parameters

name	entry name
description	entry description

add() [2/2]

template<class Handler >

void Clingo::Config::add ( std::string_view  name, std::string_view  description, Handler &&  handler  ) const

inline

Add a new configuration entry with a custom handler.

Adds a configuration entry with the given name and description, and binds it to a handler. The handler can provide get/set logic for the entry.

Handler can implement:

• get() -> std::string
• get(std::optional<size_t>) -> std::string
• set(std::string_view) -> void
• set(std::optional<size_t>, std::string_view) -> void
• size() -> size_t

Entries that have a value should implement get and/or set; entries with values under an array must implement get/set with an index. Array entries must implement size.

Note

It is up to the user to handle array insertion. Possible options include increasing the size of an array upon assignment of values or by setting a special size field that controls the size of the array.

Template Parameters

Handler

type of the handler

Parameters

name	entry name
description	entry description
handler	handler object for custom get/set logic

operator=()

auto Clingo::Config::operator= ( std::string_view  value ) const -> Config

inline

Set the value of the configuration entry.

Parameters

value

the new value of the configuration entry

Returns

the configuration entry itself

operator[]() [1/2]

auto Clingo::Config::operator[] ( size_t  index ) const -> Config

inline

Get the configuration entry at the given index in the array.

Parameters

index

the index of the configuration entry

Returns

the configuration entry at the given index

operator[]() [2/2]

auto Clingo::Config::operator[] ( std::string_view  name ) const -> Config

inline

Get the configuration entry with the given name in the map.

Parameters

name	the name of the configuration entry in the map

Returns

the configuration entry with the given name

value() [1/2]

auto Clingo::ConstConfig::value ( ) const -> std::optional<std::string_view>

inline

Get the value of the configuration entry.

The return might be empty if no value is assigned to the configuration entry.

Returns

the value of the configuration entry

value() [2/2]

void Clingo::Config::value ( std::string_view  value ) const

inline

Set the value of the configuration entry.

Parameters

value

the new value of the configuration entry

Friends And Related Symbol Documentation

c_cast

auto c_cast ( Config const &  stats ) -> clingo_config_t *

friend

Cast the configuration to the underlying C API type.

Parameters

stats

the configuration to cast

Returns

the underlying C API type

---

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

• clingo/config.hh