MeVis/ThirdParty/Sources/Inventor/inventor/lib/mevis/include/Inventor/SoTrace.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2004 MeVis gGmbH  All Rights Reserved.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: MeVis, Center for Medical Diagnostic Systems and
 *  Visualization GmbH, Universit�tsallee 29, D-28359 Bremen, GERMANY, or:
 *
 *  http://www.mevis.de
 *
 */

/*
 * Copyright (C) 2004   MeVis Research GmbH
 *
 _______________________________________________________________________
 _______________  M E V I S   R E S E A R C H   G M B H  _______________
 |
 |   Description:
 |   This include file contains a class to manage a buffer for a stack
 |   and a list of string pointers for tracing debug and release code.
 |
 |   Author(s)      : Wolf Spindler, Felix Ritter
 |
 _______________  M E V I S   R E S E A R C H   G M B H  _______________
 _______________________________________________________________________
 */

#ifndef  _SO_TRACE_
#define  _SO_TRACE_

#include <Inventor/system/SbSystem.h>
#include <Inventor/SbString.h>
#include <Inventor/SbTypeDefs.h>


#if !defined(DISABLE_ERRORTRACING)

# define SO_TRACE_IN(__classAndMethod___)  \
   static const char *const __SO_TRACE_IN_STRING_BUF = __FILE__ ":" __classAndMethod___; \
   SoTrace<uint16_t> __SoTraceObject(__SO_TRACE_IN_STRING_BUF, SoGlobalTraceBuffer);

#else

# define SO_TRACE_IN(__classAndMethod___)

#endif  // DISABLE_ERRORTRACING

typedef uint16_t SoGlobalTraceBufferType;




template <typename INDEXTYPE> class SoTraceBuffer
{
   public:

      inline SoTraceBuffer() {
         _initClass();
      }

      inline void       add(const char *const traceInString) {
         _traceStack[_traceStackTop] = traceInString;
         ++_traceStackTop;

         _traceList[_traceListEnd] = traceInString;
         ++_traceListEnd;
      }

      inline void       remove() {
         _traceStackTop = static_cast<INDEXTYPE>((_traceStackTop - 1) & _bufferIndexMask);

         _traceStack[_traceStackTop] = NULL;
      }

      inline INDEXTYPE  getTraceStackTop() const {
         return _traceStackTop;
      }

      inline INDEXTYPE  getTraceListEnd() const {
         return _traceListEnd;
      }

      inline const char *const *getTraceStack() const {
         return _traceStack;
      }

      inline const char *const *getTraceList() const {
         return _traceList;
      }

      inline SoGlobalTraceBufferType getMaxNumTraceListDumps() const {
         return _maxNumTraceListDumps;
      }

      inline void       setMaxNumTraceListDumps(SoGlobalTraceBufferType num) {
         _maxNumTraceListDumps = num;
      }

      inline SoGlobalTraceBufferType getMaxNumTraceStackDumps() const {
         return _maxNumTraceStackDumps;
      }

      inline void       setMaxNumTraceStackDumps(SoGlobalTraceBufferType num) {
         _maxNumTraceStackDumps = num;
      }

      SbString          getTraceDumpString() const;

   private:

      inline void       _initClass() {
         memset(_traceStack, 0, _numBufBytes);
         memset(_traceList,  0, _numBufBytes);

         _traceStackTop = 0;
         _traceListEnd  = 0;
      }

      enum {
         _numBufEntries   = (1L << (sizeof(INDEXTYPE) << 3)) ,
         _numBufBytes     = _numBufEntries * sizeof(const char *),
         _bufferIndexMask = _numBufEntries - 1
      };

      INDEXTYPE         _traceStackTop;

      INDEXTYPE         _traceListEnd;

      const char       *_traceStack[_numBufEntries];

      const char       *_traceList[_numBufEntries];

      SoGlobalTraceBufferType _maxNumTraceListDumps;

      SoGlobalTraceBufferType _maxNumTraceStackDumps;
};



extern INVENTOR_API SoTraceBuffer<SoGlobalTraceBufferType> SoGlobalTraceBuffer;


template <typename INDEXTYPE>
SbString
SoTraceBuffer<INDEXTYPE>::getTraceDumpString() const
{
  try {
    char num[512] = "";

    SbString endLineStr = "\n";

    SbString                traceListStr = "";
    SoGlobalTraceBufferType indexCounter = 0;
    SoGlobalTraceBufferType entry        = 0;

    if((_maxNumTraceStackDumps > 0) && (getTraceStackTop() > 0)) {
      sprintf(num, "\nCall stack of the last %d traced functions:\n", _maxNumTraceStackDumps);
      traceListStr += num;

      SoGlobalTraceBufferType stackCnt    = 0;
      const char * const *traceStack      = getTraceStack();
      SoGlobalTraceBufferType stackTop    = getTraceStackTop();
      SoGlobalTraceBufferType stackPreTop = stackTop;
      stackPreTop--;
      indexCounter = 1;

      for(entry = stackPreTop; (entry != stackTop) && (stackCnt < _maxNumTraceStackDumps); entry--, stackCnt++) {
        sprintf(num, "%5d ", indexCounter);

        const char *entryStrPtr = traceStack[entry];

        if(entryStrPtr) {
          traceListStr += ((SbString)num);
          traceListStr += entryStrPtr;
          traceListStr += endLineStr;
        }

        indexCounter++;
      }
    }

    if(_maxNumTraceListDumps > 0) {
      SoGlobalTraceBufferType listCnt = 0;
      sprintf(num, "\nCall list of the %d most recently traced functions:\n", _maxNumTraceListDumps);
      traceListStr += num;
      SoGlobalTraceBufferType listEnd    = getTraceListEnd();
      SoGlobalTraceBufferType listPreEnd = listEnd;
      listPreEnd--;
      indexCounter = 1;
      const char * const *traceList = SoGlobalTraceBuffer.getTraceList();
      entry=0;

      for(entry = listPreEnd; (entry != listEnd) && (listCnt < _maxNumTraceListDumps); entry--, listCnt++) {
        sprintf(num, "%5d ", indexCounter);

        const char *entryStrPtr = traceList[entry];

        if(entryStrPtr) {
          traceListStr += ((SbString)num);
          traceListStr += entryStrPtr;
          traceListStr += endLineStr;
        }

        indexCounter++;
      }
    }

    return traceListStr;
  }
  catch(...) {
    return "<Could not determine last called functions or function stack>";
  }
}



template <typename INDEXTYPE> class SoTrace
{
   public:

      inline SoTrace(const char *const traceInString, SoTraceBuffer<INDEXTYPE> &traceBuf) : _traceBuf(traceBuf) {
         traceBuf.add(traceInString);
      }

      inline ~SoTrace() {
         _traceBuf.remove();
      }

   private:

      SoTraceBuffer<INDEXTYPE> &_traceBuf;

      inline SoTrace(const SoTrace &trace) : _traceBuf(trace._traceBuf) {
      }

      inline SoTrace<INDEXTYPE> &operator=(const SoTrace &trace) {
         return *this;
      }
};

#endif  // _SO_TYPE_