The Battle for Wesnoth  1.19.0-dev
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
preproc_define Struct Reference

#include <preprocessor.hpp>

Public Member Functions

 preproc_define ()
 
 preproc_define (const std::string &val)
 
 preproc_define (const std::string &val, const std::vector< std::string > &args, const std::map< std::string, std::string > &optargs, const std::string &domain, int line, const std::string &loc, const std::string &dep_msg, std::optional< DEP_LEVEL > dep_lvl, const version_info &dep_ver)
 
bool is_deprecated () const
 
void write (config_writer &, const std::string &) const
 
void write_argument (config_writer &, const std::string &) const
 
void write_argument (config_writer &, const std::string &, const std::string &) const
 
void read (const config &)
 
void read_argument (const config &)
 
bool operator== (const preproc_define &) const
 
bool operator< (const preproc_define &) const
 
bool operator!= (const preproc_define &v) const
 

Static Public Member Functions

static preproc_map::value_type read_pair (const config &)
 

Public Attributes

std::string value
 
std::vector< std::string > arguments
 
std::map< std::string, std::string > optional_arguments
 
std::string textdomain
 
int linenum
 
std::string location
 
std::string deprecation_message
 
std::optional< DEP_LEVELdeprecation_level
 
version_info deprecation_version
 

Detailed Description

Definition at line 35 of file preprocessor.hpp.

Constructor & Destructor Documentation

◆ preproc_define() [1/3]

preproc_define::preproc_define ( )
inline

Definition at line 37 of file preprocessor.hpp.

◆ preproc_define() [2/3]

preproc_define::preproc_define ( const std::string &  val)
inlineexplicit

Definition at line 47 of file preprocessor.hpp.

◆ preproc_define() [3/3]

preproc_define::preproc_define ( const std::string &  val,
const std::vector< std::string > &  args,
const std::map< std::string, std::string > &  optargs,
const std::string &  domain,
int  line,
const std::string &  loc,
const std::string &  dep_msg,
std::optional< DEP_LEVEL dep_lvl,
const version_info dep_ver 
)
inline

Definition at line 57 of file preprocessor.hpp.

Member Function Documentation

◆ is_deprecated()

bool preproc_define::is_deprecated ( ) const
inline

Definition at line 95 of file preprocessor.hpp.

References deprecation_level.

Referenced by preprocessor_data::get_chunk(), and write().

◆ operator!=()

bool preproc_define::operator!= ( const preproc_define v) const
inline

Definition at line 112 of file preprocessor.hpp.

References operator==().

◆ operator<()

bool preproc_define::operator< ( const preproc_define v) const

Definition at line 140 of file preprocessor.cpp.

References linenum, and location.

◆ operator==()

bool preproc_define::operator== ( const preproc_define v) const

Definition at line 135 of file preprocessor.cpp.

References arguments, and value.

Referenced by operator!=().

◆ read()

void preproc_define::read ( const config cfg)

◆ read_argument()

void preproc_define::read_argument ( const config cfg)

Definition at line 204 of file preprocessor.cpp.

References arguments, config::has_attribute(), and optional_arguments.

Referenced by read().

◆ read_pair()

preproc_map::value_type preproc_define::read_pair ( const config cfg)
static

Definition at line 231 of file preprocessor.cpp.

References read().

Referenced by handle_preprocess_command(), and game_config::config_cache::read_defines_file().

◆ write()

void preproc_define::write ( config_writer writer,
const std::string &  name 
) const

◆ write_argument() [1/2]

void preproc_define::write_argument ( config_writer writer,
const std::string &  arg 
) const

◆ write_argument() [2/2]

void preproc_define::write_argument ( config_writer writer,
const std::string &  arg,
const std::string &  default_value 
) const

Member Data Documentation

◆ arguments

std::vector<std::string> preproc_define::arguments

Definition at line 79 of file preprocessor.hpp.

Referenced by preprocessor_data::get_chunk(), operator==(), read_argument(), and write().

◆ deprecation_level

std::optional<DEP_LEVEL> preproc_define::deprecation_level

Definition at line 91 of file preprocessor.hpp.

Referenced by preprocessor_data::get_chunk(), is_deprecated(), read(), and write().

◆ deprecation_message

std::string preproc_define::deprecation_message

Definition at line 89 of file preprocessor.hpp.

Referenced by preprocessor_data::get_chunk(), read(), and write().

◆ deprecation_version

version_info preproc_define::deprecation_version

Definition at line 93 of file preprocessor.hpp.

Referenced by preprocessor_data::get_chunk(), read(), and write().

◆ linenum

int preproc_define::linenum

Definition at line 85 of file preprocessor.hpp.

Referenced by preprocessor_data::get_chunk(), operator<(), read(), and write().

◆ location

std::string preproc_define::location

Definition at line 87 of file preprocessor.hpp.

Referenced by preprocessor_data::get_chunk(), operator<(), operator<<(), read(), and write().

◆ optional_arguments

std::map<std::string, std::string> preproc_define::optional_arguments

Definition at line 81 of file preprocessor.hpp.

Referenced by preprocessor_data::get_chunk(), read_argument(), and write().

◆ textdomain

std::string preproc_define::textdomain

Definition at line 83 of file preprocessor.hpp.

Referenced by preprocessor_data::get_chunk(), read(), and write().

◆ value

std::string preproc_define::value

Definition at line 77 of file preprocessor.hpp.

Referenced by preprocessor_data::get_chunk(), operator<<(), operator==(), read(), and write().


The documentation for this struct was generated from the following files: