BashSpark
Loading...
Searching...
No Matches
bs::shell_node_dollar_arg Class Referencefinal

Extract an argument referenced with a leading $ (e.g. $@, $* or $1). More...

#include <shell_node.h>

Inheritance diagram for bs::shell_node_dollar_arg:
Collaboration diagram for bs::shell_node_dollar_arg:

Public Member Functions

 shell_node_dollar_arg (const std::size_t nPos, const std::uint64_t nArg)
 Construct a dollar-argument extractor.
 
std::string get_value (const shell_session &oSession) const override
 Retrieve the argument value via the session.
 
std::uint64_t get_arg () const noexcept
 Get referenced argument index.
 
- Public Member Functions inherited from bs::shell_node_session_extractor
 shell_node_session_extractor (const shell_node_type nType, const std::size_t nPos)
 Construct a session extractor node.
 
void expand (std::vector< std::string > &vTokens, shell_session &oSession, bool bSplit) const override
 Expand by retrieving the value via get_value() and appending it.
 
- Public Member Functions inherited from bs::shell_node_expandable
 shell_node_expandable (const shell_node_type nType, const std::size_t nPos)
 Construct an expandable node.
 
- Public Member Functions inherited from bs::shell_node
virtual ~shell_node ()=default
 Virtual default destructor for polymorphic deletion.
 
shell_node_type get_type () const noexcept
 Get the node type.
 
std::size_t get_pos () const noexcept
 Get node position in the original input stream.
 

Additional Inherited Members

- Protected Member Functions inherited from bs::shell_node
 shell_node (const shell_node_type nType, const std::size_t nPos)
 Protected constructor used by derived classes.
 
- Protected Attributes inherited from bs::shell_node
const shell_node_type m_nType
 Node type.
 
const std::size_t m_nPos
 Position in the input stream.
 

Detailed Description

Extract an argument referenced with a leading $ (e.g. $@, $* or $1).

Constructor & Destructor Documentation

◆ shell_node_dollar_arg()

bs::shell_node_dollar_arg::shell_node_dollar_arg ( const std::size_t  nPos,
const std::uint64_t  nArg 
)
inline

Construct a dollar-argument extractor.

Parameters
nPosPosition in stream.
nArgArgument index referenced.

Member Function Documentation

◆ get_arg()

std::uint64_t bs::shell_node_dollar_arg::get_arg ( ) const
inlinenoexcept

Get referenced argument index.

Returns
std::size_t Argument index.

◆ get_value()

std::string bs::shell_node_dollar_arg::get_value ( const shell_session oSession) const
overridevirtual

Retrieve the argument value via the session.

Parameters
oSessionActive session.
Returns
std::string Argument string.

Implements bs::shell_node_session_extractor.


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