OpenTTD Source  20240919-master-gdf0233f4c2
Public Types | Public Member Functions | Data Fields
GetOptData Struct Reference

Data storage for parsing command line options. More...

#include <getoptdata.h>

Public Types

using OptionSpan = std::span< const OptionData >
 
using ArgumentSpan = std::span< char *const >
 

Public Member Functions

 GetOptData (ArgumentSpan arguments, OptionSpan options)
 Constructor of the data store. More...
 
int GetOpt ()
 Find the next option. More...
 
int GetOpt (const OptionData &option)
 

Data Fields

ArgumentSpan arguments
 Remaining command line arguments.
 
const OptionSpan options
 Command line option descriptions.
 
const char * opt = nullptr
 Option value, if available (else nullptr).
 
const char * cont = nullptr
 Next call to GetOpt should start here (in the middle of an argument).
 

Detailed Description

Data storage for parsing command line options.

Definition at line 29 of file getoptdata.h.

Constructor & Destructor Documentation

◆ GetOptData()

GetOptData::GetOptData ( ArgumentSpan  arguments,
OptionSpan  options 
)
inline

Constructor of the data store.

Parameters
argumentThe command line arguments, excluding the program name.
optionsCommand line option descriptions.

Definition at line 43 of file getoptdata.h.

Member Function Documentation

◆ GetOpt()

int GetOptData::GetOpt ( )

Find the next option.

Returns
Function returns one
  • An option letter if it found another option.
  • -1 if option processing is finished. Inspect #argv and #numleft to find the command line arguments.
  • -2 if an error was encountered.

Definition at line 22 of file getoptdata.cpp.

References arguments, cont, and options.

Referenced by main().

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