bs::shell_node_dollar_special Class Reference

Special dollar items such as $?, $#, $$, etc. (implementation-specific). More...

#include <shell_node.h>

Inheritance diagram for bs::shell_node_dollar_special:

Collaboration diagram for bs::shell_node_dollar_special:

Public Member Functions
	shell_node_dollar_special (const std::size_t nPos, const char cItem)
	Construct a dollar-special node.
std::string	get_value (const shell_session &oSession) const override
	Return the special item's textual value.
char	get_item () const noexcept
	Get the identifying character for this special item.
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

Special dollar items such as $?, $#, $$, etc. (implementation-specific).

Constructor & Destructor Documentation

shell_node_dollar_special()

bs::shell_node_dollar_special::shell_node_dollar_special ( const std::size_t  nPos, const char  cItem  )

inline

Construct a dollar-special node.

Parameters

nPos	Position in stream.
cItem	Character identifying the special item.

Member Function Documentation

get_item()

char bs::shell_node_dollar_special::get_item ( ) const

inlinenoexcept

Get the identifying character for this special item.

Returns

char Character such as '?', '#', etc.

get_value()

std::string bs::shell_node_dollar_special::get_value ( const shell_session &  oSession ) const

overridevirtual

Return the special item's textual value.

Parameters

oSession

Active session for context.

Returns

std::string Resolved value for the special item.

Implements bs::shell_node_session_extractor.

---

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

• /home/runner/work/bashspark/bashspark/include/BashSpark/shell/shell_node.h
• /home/runner/work/bashspark/bashspark/src/BashSpark/shell/shell_node_expand.cpp