prism/c/options_8hpp_source.html

#ifndef PRISM_OPTIONS_HPP

#define PRISM_OPTIONS_HPP


#include "prism/compiler/cplusplus.hpp"


#include "prism/options.h"


#include <memory>


namespace prism {


struct options_deleter {

    void operator()(pm_options_t *options) const noexcept { pm_options_free(options); }

};


using unique_options = std::unique_ptr<pm_options_t, options_deleter>;


[[nodiscard]] inline unique_options


make_options() noexcept {

    return unique_options(pm_options_new());

}


}


#endif

options.h
The options that can be passed to parsing.

pm_options_t
struct pm_options_t pm_options_t
The options that can be passed to the parser.
Definition options.h:30

pm_options_new
PRISM_NODISCARD PRISM_EXPORTED_FUNCTION pm_options_t * pm_options_new(void)
Allocate a new options struct.

pm_options_free
PRISM_EXPORTED_FUNCTION void pm_options_free(pm_options_t *options) PRISM_NONNULL(1)
Free both the held memory of the given options struct and the struct itself.

prism::unique_options
std::unique_ptr< pm_options_t, options_deleter > unique_options
An owned set of options.
Definition options.hpp:28

prism::make_options
unique_options make_options() noexcept
Allocate a new set of options with every option at its default.
Definition options.hpp:37

prism::options_deleter
Frees options with pm_options_free.
Definition options.hpp:18

prism::options_deleter::operator()
void operator()(pm_options_t *options) const noexcept
Free the given options.
Definition options.hpp:24