EoaCore Class Reference

#include <EoaCore.hxx>

Inheritance diagram for EoaCore:

[legend]

Collaboration diagram for EoaCore:

[legend]

List of all members.

Public Member Functions
	EoaCore ()
virtual	~EoaCore () throw ()
const char *	what (void) const throw ()
void	AppendWhat (const char *child)
Static Public Attributes
static unsigned int	gBacktraceSymbols = 5
	The number of backtrace symbols to add to the "what" string.
Private Attributes
char	fWhat [2048]
	What exception generated this object.

---

Detailed Description

The root exception for all exceptions explicitly thrown by the oaCore library. All exceptions declared by this library should be derived from this class, and not std::exception. New exceptions can be derived from EoaCore by creating a new class

 class EoaChild :public EoaCore {
 public:
     EoaChild() {AppendWhat("EoaChild");};
 };

But the prefered way to create derived exception classes is to use the OA_EXCEPTION macro. This is used as follows

 OA_EXCEPTION(EChild,EoaCore);
 OA_EXCEPTION(EGrandChild,EChild);
 ...
 try {
   throw EChild();
 }
 catch (EoaCore& ex) {
   std::cout << ex.what << std::endl;
 }

This can add a backtrace at the point of the exception. The number of backtrace frames to be shown is controlled with the EoaCore::gBacktraceSymbols static variable.

Definition at line 45 of file EoaCore.hxx.

---

Constructor & Destructor Documentation

EoaCore::EoaCore

(

)

Definition at line 13 of file EoaCore.cxx.

References fWhat, and gBacktraceSymbols.

                 {
    fWhat[0] = 0;
#ifdef _GNU_SOURCE
    if (gBacktraceSymbols>0) {
        const unsigned int bufferSize=100;
        if (gBacktraceSymbols>bufferSize) gBacktraceSymbols = bufferSize;
        void *buffer[bufferSize];
        unsigned int frames = bufferSize;
        if (gBacktraceSymbols<frames) frames = gBacktraceSymbols;
        int nFrames = backtrace(buffer,frames);
        char **symbols = backtrace_symbols(buffer,nFrames);
        if (symbols != NULL) {
            unsigned int len = 0;
            std::strcat(fWhat,"Backtrace:\n");
            for (int i = 0; i<nFrames; ++i) {
                std::string sym(symbols[i]);
                std::string lib;
                std::string::size_type s = sym.find_last_of('/');
                if (s != std::string::npos) sym = sym.substr(s+1);
                s = sym.find_first_of('(');
                if (s != std::string::npos) lib = sym.substr(0,s);
                sym = sym.substr(s+1);
                std::string::size_type t = sym.find_first_of(')');
                if (s != std::string::npos
                    && t != std::string::npos) sym = sym.substr(0,t);
                else sym="";
                if (lib.empty() && sym.empty()) continue;
                len += lib.length();
                len += sym.length() + 6;
                if (2*len>sizeof(fWhat)) break;
                std::strcat(fWhat," --> ");
                if (!lib.empty()) std::strcat(fWhat,lib.c_str());
                if (!sym.empty()) {
                    std::strcat(fWhat,": ");
                    std::strcat(fWhat,sym.c_str());
                }
                std::strcat(fWhat,"\n");
            }
            std::free(symbols);
        }
    }
#endif
    std::strcat(fWhat,"Exception:  EoaCore");
}

virtual EoaCore::~EoaCore

(

)

throw () [inline, virtual]

Definition at line 54 of file EoaCore.hxx.

{}

---

Member Function Documentation

void EoaCore::AppendWhat

(

const char *

child

)

Used in constructors of classes which inherit EoaCore to add text to the What string. Here is a comprehensive example of how to construct an exception derived from EoaCore:

    /// class EoaChild : public EoaCore {
    /// public: 
    ///   EoaChild() {AppendWhat("EoaChild");}
    /// };
    /// 

Definition at line 58 of file EoaCore.cxx.

References fWhat.

                                          {
    unsigned int wLen = std::strlen(fWhat);
    unsigned int cLen = std::strlen(child);
    if (wLen+cLen < sizeof(fWhat)-5) {
        std::strcat(fWhat,"::");
        std::strcat(fWhat,child);
    }
}

const char* EoaCore::what

(

void

)

const throw () [inline]

Inherited from exception to return the name of the exception as a null terminated string.

Definition at line 58 of file EoaCore.hxx.

References fWhat.

{return fWhat;}

---

Member Data Documentation

char EoaCore::fWhat[2048] [private]

What exception generated this object.

Definition at line 47 of file EoaCore.hxx.

Referenced by AppendWhat(), EoaCore(), and what().

unsigned int EoaCore::gBacktraceSymbols = 5 [static]

The number of backtrace symbols to add to the "what" string.

Definition at line 51 of file EoaCore.hxx.

Referenced by EoaCore().

---

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

• src/EoaCore.hxx
• src/EoaCore.cxx