uuu
uuu (Universal Update Utility), mfgtools 3.0
Loading...
Searching...
No Matches
BuiltInScript Class Reference

#include <buildincmd.h>

Classes

class  Arg
 A class for representing arguments of built-in scripts represented by BuiltInScript. More...

Public Member Functions

 BuiltInScript ()
 BuiltInScript (const BuiltInScriptRawData *p)
 Create a new BuiltInScript instance by extracting information from a BuiltInScriptRawData instance.
std::string replace_script_args (const std::vector< std::string > &args) const
 Replace built-in script's arguments by actual values given in args
void show () const
 Print the built-in script to stdout followed by a newline.
void show_cmd () const
 Print the script's name, its description and its arguments to stdout.

Public Attributes

const std::string m_text
 The actual script which is being represented.
const std::string m_desc
 A description of the script's purpose.
const std::string m_name
 A short name of the built-in script.
std::vector< Argm_args
 The arguments of the built-in script.

Private Member Functions

bool find_args (const std::string &arg) const
 Check if the BuiltInScript instance has an argument called arg

Constructor & Destructor Documentation

◆ BuiltInScript() [1/2]

BuiltInScript::BuiltInScript ( )
inline

◆ BuiltInScript() [2/2]

BuiltInScript::BuiltInScript ( const BuiltInScriptRawData * p)

Create a new BuiltInScript instance by extracting information from a BuiltInScriptRawData instance.

Parameters
[in]pThe BuiltInScriptRawData containing all data of the script this BuiltInScript instance shall represent

Member Function Documentation

◆ find_args()

bool BuiltInScript::find_args ( const std::string & arg) const
private

Check if the BuiltInScript instance has an argument called arg

Parameters
[in]argThe argument for which its existence in the BuiltInScript shall be checked
Returns
true if BuiltInScript has an argument named arg, false otherwise

◆ replace_script_args()

std::string BuiltInScript::replace_script_args ( const std::vector< std::string > & args) const

Replace built-in script's arguments by actual values given in args

Parameters
[in]argsThe actual values that shall replace the arguments (the order must fit the order of the arguments in the script)
Returns
A copy of the built-in script with the arguments replaced by their actual values

◆ show()

void BuiltInScript::show ( ) const

Print the built-in script to stdout followed by a newline.

◆ show_cmd()

void BuiltInScript::show_cmd ( ) const

Print the script's name, its description and its arguments to stdout.

Member Data Documentation

◆ m_args

std::vector<Arg> BuiltInScript::m_args

The arguments of the built-in script.

◆ m_desc

const std::string BuiltInScript::m_desc

A description of the script's purpose.

◆ m_name

const std::string BuiltInScript::m_name

A short name of the built-in script.

◆ m_text

const std::string BuiltInScript::m_text

The actual script which is being represented.


The documentation for this class was generated from the following files:
  • /home/builder/.cache/aurutils/sync/mfgtools-git/src/mfgtools-git/uuu/buildincmd.h
  • /home/builder/.cache/aurutils/sync/mfgtools-git/src/mfgtools-git/uuu/buildincmd.cpp