debug.h

Go to the documentation of this file.

#pragma once
 
/*+
________________________________________________________________________
 
 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H.Lammertink
 Date:          Jun 2003
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "basicmod.h"
#include "gendefs.h"
#include "bufstring.h"
 
namespace google_breakpad { class ExceptionHandler; }
 
namespace DBG
{
    mGlobal(Basic) void turnOn( int flag );
    mGlobal(Basic) bool isOn( int flag=0xffff );
    mGlobal(Basic) void message(const char*);     
    mGlobal(Basic) void message(const char*, const char* cname,
                                const char* fname, int linrnr);
    mGlobal(Basic) void message(int flag, const char* msg);
    mGlobal(Basic) void message(int flag, const char*, const char* cname,
                                const char* fname, int linrnr);
    mGlobal(Basic) void putProgInfo(int,char**);
    mGlobal(Basic) void forceCrash(bool withdump);
    mGlobal(Basic) bool crashOnNaN();
    mGlobal(Basic) bool setCrashOnProgError(bool yn);
};
 
extern "C" {
 
    mGlobal(Basic) int od_debug_isOn( int flag );
    mGlobal(Basic) void od_debug_message( const char* msg );
    mGlobal(Basic) void od_debug_messagef( int flag, const char* msg );
    mGlobal(Basic) void od_debug_putProgInfo(int,char**);
    mGlobal(Basic) void od_putProgInfo(int,char**);
    mGlobal(Basic) void od_init_test_program(int,char**);
}
 
# define pDebugMsg(msg) \
    DBG::message(msg,::className(*this),__FILE__,__LINE__)
# define pFreeDebugMsg(msg) \
    DBG::message(msg,__func__,__FILE__,__LINE__)
# define pFDebugMsg(flag,msg) \
    DBG::message(flag,msg,::className(*this),__FILE__,__LINE__)
# define pFreeFDebugMsg(flag,msg) \
    DBG::message(flag,msg,__func__,__FILE__,__LINE__)
 
 
namespace System
{
 
mExpClass(Basic) CrashDumper
{
public:
    static CrashDumper& getInstance();
 
    bool                isOK() const { return handler_; }
 
    void                sendDump(const char* filename);
 
    void                setSendAppl( const char* a )    { sendappl_ = a; }
 
    static FixedString  sSenderAppl();          //None
    static FixedString  sUiSenderAppl();        //od_uiReportIssue
 
private:
                                        CrashDumper();
 
    void                                init();
 
    static CrashDumper*                 theinst_;
 
    BufferString                        sendappl_;
    google_breakpad::ExceptionHandler*  handler_ = nullptr;
};
 
} // namespace System
 
 
 
/*
    This is a list of reserved debug masks, in order to avoid conflicts.
    Don't just throw any of these away or change a value, adding new masks
    should be OK.
*/
 
#define DBG_DBG         0x0001  // general, low frequency stuff
#define DBG_MT          0x0002  // multi-threaded stuff
#define DBG_UI          0x0004  // ui-related stuff
#define DBG_IO          0x0008  // general I/O stuff
#define DBG_SOCKIO      0x0010  // socket I/O
#define DBG_MM          0x0020  // Multi-machine batch processing
#define DBG_SETTINGS    0x0040  // User settings
#define DBG_PROGSTART   0x0080  // Program start and stop
#define DBG_FILEPATH    0x0100  // File name handling, conversion, etc.
#define DGB_SERVICES    0x0200  // Network service managers