Debug.hpp

Aller à la documentation de ce fichier.

/// \file 
///     Définition des classes utiles pour le debug

#ifndef GUARD_Debug_h
#define GUARD_Debug_h

#include <iostream>
#include <fstream>
#include <string>
#include <iomanip>


#include <time.h>


using namespace std;
// Trace activée
static const bool debug = true;

///////////////////////////////////////////////////////////////////////////////
/// Représente un canal de sortie 
///
/// Les informations de debug sont dirigée dans un canal : fichier,
/// cout, cerr,... Les canaux sont déclarées au niveau globale.
///////////////////////////////////////////////////////////////////////////////
class Channel{
        friend class Trace;
        /// Flot de sortie
        ostream* traceFile;
public:
        /// Contructeur avec un flot de sortie comme paramètre par défaut cout
        /// \param      o flot de srotie
        Channel(ostream* o = &cout):
                traceFile(o)
        {}
        /// Permet de changer de flot
        void reset(ostream* o){
                traceFile = o;
        }
};

///////////////////////////////////////////////////////////////////////////////
/// Représente une trace
///
/// L'utilisation typique est de créer une instance de Trace à l'entrée d'une
/// fonction et loguer des informations dans cette trace.
///////////////////////////////////////////////////////////////////////////////
class Trace{
        /// Flot de sortie
        Channel* pChannel;
        /// Nom de la trace
        const char* name;
        /// Affiche les messages
        bool display;
        /// Chronomètre
        time_t start, end;
public:
        /// Constructeur d'une trace
        /// \param _name : nom à afficher avec un message
        /// \param _pChannel : un flot de sortie
        /// \param _display : affiche les messages ou non
        Trace(const char* _name, Channel& _pChannel, bool _display = true){
                if(debug){
                        time(&start);                   
                        name = _name;
                        pChannel = &_pChannel;
                        display = _display;
                        // Affiche la création d'une trace
                        if(pChannel->traceFile && display){
                                *pChannel->traceFile << "->\t" << name << endl;
                        }
                }
        }
        ~Trace(){
                if(debug){
                        time(&end);             
                        // Affiche la destruction d'une trace
                        if(pChannel->traceFile && display){
                                float dif = difftime (end,start);
                                *pChannel->traceFile << "<-\t" << name  << setw(10) << dif << " secondes" << endl;
                        }
                }
        }
        /// Affiche un message dans la trace (C style)
        void print(const char* txt){
                if(debug){
                        if(pChannel->traceFile && display){
                                *pChannel->traceFile << "\t" <<  txt << endl;
                        }
                }
        }
        /// Affiche un message dans la trace (STL style)
        void print(const string txt){
                if(debug){
                        if(pChannel->traceFile && display){
                                *pChannel->traceFile << "\t" <<  txt << endl;
                        }
                }
        }
                
};
#endif

---