NCBI C++ ToolKit
Public Types | Public Member Functions | Public Attributes | List of all members
SMacroFuncWithArgs Struct Reference

Search Toolkit Book for SMacroFuncWithArgs

Structure to store parsed function name and its arguments - as it appears in the macro It is used when a macro is about to be opened in the macro editor, it does not play a role When a macro is parsed. More...

#include <gui/widgets/edit/macro_parse_functions.hpp>

+ Inheritance diagram for SMacroFuncWithArgs:
+ Collaboration diagram for SMacroFuncWithArgs:

Public Types

using TArgs = vector< string >
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 SMacroFuncWithArgs (const string &func_name)
 
 SMacroFuncWithArgs ()
 
 SMacroFuncWithArgs (const SMacroFuncWithArgs &)
 
bool operator== (const SMacroFuncWithArgs &) const
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Public Attributes

string m_FuncName
 
TArgs m_FuncArgs
 
bool m_Negate { false }
 
string m_ParentFnc
 
CRef< SMacroFuncWithArgsm_ChildFnc { nullptr }
 

Additional Inherited Members

- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Structure to store parsed function name and its arguments - as it appears in the macro It is used when a macro is about to be opened in the macro editor, it does not play a role When a macro is parsed.

Definition at line 45 of file macro_parse_functions.hpp.

Member Typedef Documentation

◆ TArgs

Definition at line 47 of file macro_parse_functions.hpp.

Constructor & Destructor Documentation

◆ SMacroFuncWithArgs() [1/3]

SMacroFuncWithArgs::SMacroFuncWithArgs ( const string func_name)
inline

Definition at line 48 of file macro_parse_functions.hpp.

◆ SMacroFuncWithArgs() [2/3]

SMacroFuncWithArgs::SMacroFuncWithArgs ( )
inline

Definition at line 49 of file macro_parse_functions.hpp.

Referenced by SMacroFuncWithArgs().

◆ SMacroFuncWithArgs() [3/3]

SMacroFuncWithArgs::SMacroFuncWithArgs ( const SMacroFuncWithArgs other)

Member Function Documentation

◆ operator==()

bool SMacroFuncWithArgs::operator== ( const SMacroFuncWithArgs other) const

Member Data Documentation

◆ m_ChildFnc

CRef<SMacroFuncWithArgs> SMacroFuncWithArgs::m_ChildFnc { nullptr }

◆ m_FuncArgs

TArgs SMacroFuncWithArgs::m_FuncArgs

◆ m_FuncName

string SMacroFuncWithArgs::m_FuncName

◆ m_Negate

bool SMacroFuncWithArgs::m_Negate { false }

◆ m_ParentFnc

string SMacroFuncWithArgs::m_ParentFnc

Definition at line 57 of file macro_parse_functions.hpp.

Referenced by operator<<(), operator==(), and SMacroFuncWithArgs().


The documentation for this struct was generated from the following files:
Modified on Fri Dec 01 04:44:01 2023 by modify_doxy.py rev. 669887