SoErrorStack.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (01 2010)
**=======================================================================*/
 
#if !defined(SO_ERROR_STACK_H)
#define  SO_ERROR_STACK_H
 
#include <Inventor/errors/SoError.h>
 
class  SoErrorStack : public SoError 
{
public:
 
  struct StackFrame
  {
    int frameIndex; // Index of this frame in the callstack, 0 is top one.
 
    SbString functionName; // Function reached in this frame.
    int lineNumber; // Line number in the frame.
 
    SbString moduleName;  // Module which contains the function.
    SbString moduleDescription; // More information about the module (Type, fullpath...)
  };
  
  static void setHandlerCallback(SoErrorCB *cb, void *data);
 
  static SoErrorCB *getHandlerCallback();
 
  static void* getHandlerData();
 
  static SoType getClassTypeId();
 
  virtual SoType getTypeId() const;
 
  static void post();
 
  std::vector< SoErrorStack::StackFrame > getStackFrames() const;
 
  SbString getStack() const;
 
 private:
 
  // Initializes SoErrorStack class
  static void initClass();
  static void exitClass();
 
private:
 
  SoErrorStack();
  virtual ~SoErrorStack();
 
  // Signals handler.
  static void signalHandler(int signo);
 
  static  SoType s_classTypeId; // Type id of SoDebugError class
  static  SoErrorCB* s_handlerCB; // Handler callback for class
  static  void* s_cbData; // User data for callback
 
  typedef void (*tHandler)(int);
 
  // We keep the old handlers in case of, if they are not null we'll call them 
  // in the handler.
  static tHandler s_handlerSIGINT;
  static tHandler s_handlerSIGILL;
  static tHandler s_handlerSIGFPE;
  static tHandler s_handlerSIGSEGV;
  static tHandler s_handlerSIGTERM;
  static tHandler s_handlerSIGABRT;
 
  // Data for the custom callbacks.
  std::vector< SoErrorStack::StackFrame > m_stack;
  SbString m_decodedStack;
};
 
 
#endif // SO_ERROR_STACK_H