guts
gutsConventions.h File Reference
#include <string>
Include dependency graph for gutsConventions.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define UNINITIALIZEDNUMBERQUANTITY   -123456
 Represents an uninitialized numeric quantity. More...
 
#define UNINITIALIZEDSTRINGQUANTITY   "na"
 Represents an uninitialized string quantity. More...
 
#define EC__FILENOTFOUND   301
 File not found error code. More...
 
#define EC__G4NUMBERERROR   302
 G4 number error code. More...
 
#define KBOLD   "\x1B[1m"
 ANSI code for bold text. More...
 
#define KRED   "\x1B[31m"
 ANSI code for red colored text. More...
 
#define KGRN   "\x1B[32m"
 ANSI code for green colored text. More...
 
#define KYEL   "\x1B[33m"
 ANSI code for yellow colored text. More...
 
#define KBLU   "\x1B[34m"
 ANSI code for blue colored text. More...
 
#define KMAG   "\x1B[35m"
 ANSI code for magenta colored text. More...
 
#define KCYN   "\x1B[36m"
 ANSI code for cyan colored text. More...
 
#define KWHT   "\x1B[37m"
 ANSI code for white colored text. More...
 
#define RST   "\x1B[0m"
 ANSI code to reset text formatting. More...
 
#define FRED(x)   KRED x RST
 Macro to wrap text in red color. More...
 
#define FGRN(x)   KGRN x RST
 Macro to wrap text in green color. More...
 
#define FYEL(x)   KYEL x RST
 Macro to wrap text in yellow color. More...
 
#define FBLU(x)   KBLU x RST
 Macro to wrap text in blue color. More...
 
#define FMAG(x)   KMAG x RST
 Macro to wrap text in magenta color. More...
 
#define FCYN(x)   KCYN x RST
 Macro to wrap text in cyan color. More...
 
#define FWHT(x)   KWHT x RST
 Macro to wrap text in white color. More...
 
#define BOLD(x)   KBOLD x RST
 Macro to wrap text in bold. More...
 
#define UNDL(x)   "\x1B[4m" x RST
 Macro to wrap text with underline. More...
 
#define FATALERRORL   BOLD(FRED("Error: "))
 Fatal error label. More...
 
#define GWARNING   BOLD(FYEL("Warning: "))
 Warning label. More...
 
#define CONSTRUCTORLOG   "↑"
 Log symbol for constructor. More...
 
#define DESTRUCTORLOG   "↓"
 Log symbol for destructor. More...
 
#define POINTITEM   "•"
 Symbol for point item. More...
 
#define CIRCLEITEM   "◦"
 Symbol for circle item. More...
 
#define SQUAREITEM   "◻︎"
 Symbol for square item. More...
 
#define ARROWITEM   "➤"
 Symbol for arrow item. More...
 
#define GREENPOINTITEM   BOLD(FGRN(POINTITEM))
 Green point item. More...
 
#define GREENCIRCLEITEM   BOLD(FGRN(CIRCLEITEM))
 Green circle item. More...
 
#define GREENSQUAREITEM   BOLD(FGRN(SQUAREITEM))
 Green square item. More...
 
#define GREENARROWITEM   BOLD(FGRN(ARROWITEM))
 Green arrow item. More...
 
#define REDPOINTITEM   BOLD(FRED(POINTITEM))
 Red point item. More...
 
#define REDCIRCLEITEM   BOLD(FRED(CIRCLEITEM))
 Red circle item. More...
 
#define REDSQUAREITEM   BOLD(FRED(SQUAREITEM))
 Red square item. More...
 
#define REDARROWITEM   BOLD(FRED(ARROWITEM))
 Red arrow item. More...
 
#define GTAB   " "
 One tab spacing. More...
 
#define GTABTAB   GTAB GTAB
 Two tab spacing. More...
 
#define GTABTABTAB   GTAB GTAB GTAB
 Three tab spacing. More...
 
#define TPOINTITEM   GTAB POINTITEM
 Point item with single tab. More...
 
#define TCIRCLEITEM   GTAB CIRCLEITEM
 Circle item with single tab. More...
 
#define TSQUAREITEM   GTAB SQUAREITEM
 Square item with single tab. More...
 
#define TARROWITEM   GTAB ARROWITEM
 Arrow item with single tab. More...
 
#define TGREENPOINTITEM   GTAB GREENPOINTITEM
 Green point item with single tab. More...
 
#define TGREENCIRCLEITEM   GTAB GREENCIRCLEITEM
 Green circle item with single tab. More...
 
#define TGREENSQUAREITEM   GTAB GREENSQUAREITEM
 Green square item with single tab. More...
 
#define TGREENARROWITEM   GTAB GREENARROWITEM
 Green arrow item with single tab. More...
 
#define TREDPOINTITEM   GTAB REDPOINTITEM
 Red point item with single tab. More...
 
#define TREDCIRCLEITEM   GTAB REDCIRCLEITEM
 Red circle item with single tab. More...
 
#define TREDSQUAREITEM   GTAB REDSQUAREITEM
 Red square item with single tab. More...
 
#define TREDARROWITEM   GTAB REDARROWITEM
 Red arrow item with single tab. More...
 
#define TTPOINTITEM   GTABTAB POINTITEM
 Point item with double tab. More...
 
#define TTCIRCLEITEM   GTABTAB CIRCLEITEM
 Circle item with double tab. More...
 
#define TTSQUAREITEM   GTABTAB SQUAREITEM
 Square item with double tab. More...
 
#define TTARROWITEM   GTABTAB ARROWITEM
 Arrow item with double tab. More...
 
#define TTGREENPOINTITEM   GTABTAB GREENPOINTITEM
 Green point item with double tab. More...
 
#define TTGREENCIRCLEITEM   GTABTAB GREENCIRCLEITEM
 Green circle item with double tab. More...
 
#define TTGREENSQUAREITEM   GTABTAB GREENSQUAREITEM
 Green square item with double tab. More...
 
#define TTGREENARROWITEM   GTABTAB GREENARROWITEM
 Green arrow item with double tab. More...
 
#define TTREDPOINTITEM   GTABTAB REDPOINTITEM
 Red point item with double tab. More...
 
#define TTREDCIRCLEITEM   GTABTAB REDCIRCLEITEM
 Red circle item with double tab. More...
 
#define TTREDSQUAREITEM   GTABTAB REDSQUAREITEM
 Red square item with double tab. More...
 
#define TTREDARROWITEM   GTABTAB REDARROWITEM
 Red arrow item with double tab. More...
 
#define HHL   "⏵"
 Highlight left symbol. More...
 
#define HHR   "⏴"
 Highlight right symbol. More...
 
#define RSTHHR   HHR RST
 Reset highlight right. More...
 
#define GREENHHL   KGRN HHL
 Green highlight left. More...
 
#define REDHHL   KRED HHL
 Red highlight left. More...
 
#define YELLOWHHL   KYEL HHL
 Yellow highlight left. More...
 
#define BOLDWHHL   BOLD(HHL)
 Bold white highlight left. More...
 

Functions

void gexit (int error)
 Thread-safe exit function with error code. More...
 
void gLogClassConstruct (std::string className)
 Logs the construction of a class instance. More...
 
void gLogCopyConstruct (std::string className)
 Logs the copy construction of a class instance. More...
 
void gLogMoveConstruct (std::string className)
 Logs the move construction of a class instance. More...
 
void gLogClassDestruct (std::string className)
 Logs the destruction of a class instance. More...
 
void gLogMessage (std::string message)
 Logs a message. More...
 

Macro Definition Documentation

◆ ARROWITEM

#define ARROWITEM   "➤"

Definition at line 90 of file gutsConventions.h.

◆ BOLD

#define BOLD (   x)    KBOLD x RST

Definition at line 77 of file gutsConventions.h.

◆ BOLDWHHL

#define BOLDWHHL   BOLD(HHL)

Definition at line 140 of file gutsConventions.h.

◆ CIRCLEITEM

#define CIRCLEITEM   "◦"

Definition at line 88 of file gutsConventions.h.

◆ CONSTRUCTORLOG

#define CONSTRUCTORLOG   "↑"

Definition at line 83 of file gutsConventions.h.

◆ DESTRUCTORLOG

#define DESTRUCTORLOG   "↓"

Definition at line 84 of file gutsConventions.h.

◆ EC__FILENOTFOUND

#define EC__FILENOTFOUND   301

Definition at line 17 of file gutsConventions.h.

◆ EC__G4NUMBERERROR

#define EC__G4NUMBERERROR   302

Definition at line 18 of file gutsConventions.h.

◆ FATALERRORL

#define FATALERRORL   BOLD(FRED("Error: "))

Definition at line 80 of file gutsConventions.h.

◆ FBLU

#define FBLU (   x)    KBLU x RST

Definition at line 72 of file gutsConventions.h.

◆ FCYN

#define FCYN (   x)    KCYN x RST

Definition at line 74 of file gutsConventions.h.

◆ FGRN

#define FGRN (   x)    KGRN x RST

Definition at line 70 of file gutsConventions.h.

◆ FMAG

#define FMAG (   x)    KMAG x RST

Definition at line 73 of file gutsConventions.h.

◆ FRED

#define FRED (   x)    KRED x RST

Definition at line 69 of file gutsConventions.h.

◆ FWHT

#define FWHT (   x)    KWHT x RST

Definition at line 75 of file gutsConventions.h.

◆ FYEL

#define FYEL (   x)    KYEL x RST

Definition at line 71 of file gutsConventions.h.

◆ GREENARROWITEM

#define GREENARROWITEM   BOLD(FGRN(ARROWITEM))

Definition at line 94 of file gutsConventions.h.

◆ GREENCIRCLEITEM

#define GREENCIRCLEITEM   BOLD(FGRN(CIRCLEITEM))

Definition at line 92 of file gutsConventions.h.

◆ GREENHHL

#define GREENHHL   KGRN HHL

Definition at line 137 of file gutsConventions.h.

◆ GREENPOINTITEM

#define GREENPOINTITEM   BOLD(FGRN(POINTITEM))

Definition at line 91 of file gutsConventions.h.

◆ GREENSQUAREITEM

#define GREENSQUAREITEM   BOLD(FGRN(SQUAREITEM))

Definition at line 93 of file gutsConventions.h.

◆ GTAB

#define GTAB   " "

Definition at line 101 of file gutsConventions.h.

◆ GTABTAB

#define GTABTAB   GTAB GTAB

Definition at line 102 of file gutsConventions.h.

◆ GTABTABTAB

#define GTABTABTAB   GTAB GTAB GTAB

Definition at line 103 of file gutsConventions.h.

◆ GWARNING

#define GWARNING   BOLD(FYEL("Warning: "))

Definition at line 81 of file gutsConventions.h.

◆ HHL

#define HHL   "⏵"

Definition at line 134 of file gutsConventions.h.

◆ HHR

#define HHR   "⏴"

Definition at line 135 of file gutsConventions.h.

◆ KBLU

#define KBLU   "\x1B[34m"

Definition at line 46 of file gutsConventions.h.

◆ KBOLD

#define KBOLD   "\x1B[1m"

Definition at line 26 of file gutsConventions.h.

◆ KCYN

#define KCYN   "\x1B[36m"

Definition at line 56 of file gutsConventions.h.

◆ KGRN

#define KGRN   "\x1B[32m"

Definition at line 36 of file gutsConventions.h.

◆ KMAG

#define KMAG   "\x1B[35m"

Definition at line 51 of file gutsConventions.h.

◆ KRED

#define KRED   "\x1B[31m"

Definition at line 31 of file gutsConventions.h.

◆ KWHT

#define KWHT   "\x1B[37m"

Definition at line 61 of file gutsConventions.h.

◆ KYEL

#define KYEL   "\x1B[33m"

Definition at line 41 of file gutsConventions.h.

◆ POINTITEM

#define POINTITEM   "•"

Definition at line 87 of file gutsConventions.h.

◆ REDARROWITEM

#define REDARROWITEM   BOLD(FRED(ARROWITEM))

Definition at line 98 of file gutsConventions.h.

◆ REDCIRCLEITEM

#define REDCIRCLEITEM   BOLD(FRED(CIRCLEITEM))

Definition at line 96 of file gutsConventions.h.

◆ REDHHL

#define REDHHL   KRED HHL

Definition at line 138 of file gutsConventions.h.

◆ REDPOINTITEM

#define REDPOINTITEM   BOLD(FRED(POINTITEM))

Definition at line 95 of file gutsConventions.h.

◆ REDSQUAREITEM

#define REDSQUAREITEM   BOLD(FRED(SQUAREITEM))

Definition at line 97 of file gutsConventions.h.

◆ RST

#define RST   "\x1B[0m"

Definition at line 66 of file gutsConventions.h.

◆ RSTHHR

#define RSTHHR   HHR RST

Definition at line 136 of file gutsConventions.h.

◆ SQUAREITEM

#define SQUAREITEM   "◻︎"

Definition at line 89 of file gutsConventions.h.

◆ TARROWITEM

#define TARROWITEM   GTAB ARROWITEM

Definition at line 109 of file gutsConventions.h.

◆ TCIRCLEITEM

#define TCIRCLEITEM   GTAB CIRCLEITEM

Definition at line 107 of file gutsConventions.h.

◆ TGREENARROWITEM

#define TGREENARROWITEM   GTAB GREENARROWITEM

Definition at line 113 of file gutsConventions.h.

◆ TGREENCIRCLEITEM

#define TGREENCIRCLEITEM   GTAB GREENCIRCLEITEM

Definition at line 111 of file gutsConventions.h.

◆ TGREENPOINTITEM

#define TGREENPOINTITEM   GTAB GREENPOINTITEM

Definition at line 110 of file gutsConventions.h.

◆ TGREENSQUAREITEM

#define TGREENSQUAREITEM   GTAB GREENSQUAREITEM

Definition at line 112 of file gutsConventions.h.

◆ TPOINTITEM

#define TPOINTITEM   GTAB POINTITEM

Definition at line 106 of file gutsConventions.h.

◆ TREDARROWITEM

#define TREDARROWITEM   GTAB REDARROWITEM

Definition at line 117 of file gutsConventions.h.

◆ TREDCIRCLEITEM

#define TREDCIRCLEITEM   GTAB REDCIRCLEITEM

Definition at line 115 of file gutsConventions.h.

◆ TREDPOINTITEM

#define TREDPOINTITEM   GTAB REDPOINTITEM

Definition at line 114 of file gutsConventions.h.

◆ TREDSQUAREITEM

#define TREDSQUAREITEM   GTAB REDSQUAREITEM

Definition at line 116 of file gutsConventions.h.

◆ TSQUAREITEM

#define TSQUAREITEM   GTAB SQUAREITEM

Definition at line 108 of file gutsConventions.h.

◆ TTARROWITEM

#define TTARROWITEM   GTABTAB ARROWITEM

Definition at line 123 of file gutsConventions.h.

◆ TTCIRCLEITEM

#define TTCIRCLEITEM   GTABTAB CIRCLEITEM

Definition at line 121 of file gutsConventions.h.

◆ TTGREENARROWITEM

#define TTGREENARROWITEM   GTABTAB GREENARROWITEM

Definition at line 127 of file gutsConventions.h.

◆ TTGREENCIRCLEITEM

#define TTGREENCIRCLEITEM   GTABTAB GREENCIRCLEITEM

Definition at line 125 of file gutsConventions.h.

◆ TTGREENPOINTITEM

#define TTGREENPOINTITEM   GTABTAB GREENPOINTITEM

Definition at line 124 of file gutsConventions.h.

◆ TTGREENSQUAREITEM

#define TTGREENSQUAREITEM   GTABTAB GREENSQUAREITEM

Definition at line 126 of file gutsConventions.h.

◆ TTPOINTITEM

#define TTPOINTITEM   GTABTAB POINTITEM

Definition at line 120 of file gutsConventions.h.

◆ TTREDARROWITEM

#define TTREDARROWITEM   GTABTAB REDARROWITEM

Definition at line 131 of file gutsConventions.h.

◆ TTREDCIRCLEITEM

#define TTREDCIRCLEITEM   GTABTAB REDCIRCLEITEM

Definition at line 129 of file gutsConventions.h.

◆ TTREDPOINTITEM

#define TTREDPOINTITEM   GTABTAB REDPOINTITEM

Definition at line 128 of file gutsConventions.h.

◆ TTREDSQUAREITEM

#define TTREDSQUAREITEM   GTABTAB REDSQUAREITEM

Definition at line 130 of file gutsConventions.h.

◆ TTSQUAREITEM

#define TTSQUAREITEM   GTABTAB SQUAREITEM

Definition at line 122 of file gutsConventions.h.

◆ UNDL

#define UNDL (   x)    "\x1B[4m" x RST

Definition at line 78 of file gutsConventions.h.

◆ UNINITIALIZEDNUMBERQUANTITY

#define UNINITIALIZEDNUMBERQUANTITY   -123456

Definition at line 9 of file gutsConventions.h.

◆ UNINITIALIZEDSTRINGQUANTITY

#define UNINITIALIZEDSTRINGQUANTITY   "na"

Definition at line 14 of file gutsConventions.h.

◆ YELLOWHHL

#define YELLOWHHL   KYEL HHL

Definition at line 139 of file gutsConventions.h.

Function Documentation

◆ gexit()

void gexit ( int  error)

This function is used to exit the program with a specific error code, ensuring any necessary cleanup or logging can occur before termination.

Parameters
errorThe error code to exit with.

Definition at line 14 of file gutsConventions.cc.

◆ gLogClassConstruct()

void gLogClassConstruct ( std::string  className)
Parameters
classNameThe name of the class being constructed.

Definition at line 24 of file gutsConventions.cc.

◆ gLogClassDestruct()

void gLogClassDestruct ( std::string  className)
Parameters
classNameThe name of the class being destructed.

Definition at line 45 of file gutsConventions.cc.

◆ gLogCopyConstruct()

void gLogCopyConstruct ( std::string  className)
Parameters
classNameThe name of the class being copy-constructed.

Definition at line 31 of file gutsConventions.cc.

◆ gLogMessage()

void gLogMessage ( std::string  message)

This function logs a given message, typically used for debugging or informational purposes.

Parameters
messageThe message to be logged.

Definition at line 51 of file gutsConventions.cc.

◆ gLogMoveConstruct()

void gLogMoveConstruct ( std::string  className)
Parameters
classNameThe name of the class being move-constructed.

Definition at line 38 of file gutsConventions.cc.