erreur.h

Go to the documentation of this file.

/*  Implémentation Linux de la bibliotheque XADLL de Sidena
 *  Copyright (C) 2005 ENSTAR
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  You can contact us:
 *    Association ENSTAR
 *    Ecole Nationale Superieure de Techniques Avancees
 *    32 boulevard Victor
 *    75739 Paris Cedex 15
 *    FRANCE
 *
 *    enstar@ensta.fr
 */

/* $Id: erreur.h 49 2006-03-14 11:01:24Z francois $ */

/** @file    erreur.h
 *  @brief   Module de gestion des messages de log/erreur
 *  @author  Francois Fevotte <francois.fevotte@ensta.org>
 *  $Revision: 49 $
 *  $Date: 2006-03-14 12:01:24 +0100 (Tue, 14 Mar 2006) $
 *
 *  Ce module permet de gérer l'affichage de messages sur le flux d'erreur standard et dans un fichier de log.
 *  Il utilise un certain nombre de macros qui doivent être redéfinies dans le fichier appelant
 *  (@ref LOGFILE, @ref LOG_LEVEL, @ref SCREEN_LEVEL, @ref SOURCE_ERREUR).
 *
 *  Les fonctions d'affichage des messages sont décrites dans l'espace de noms @link erreur::generique erreur@endlink.
 *
 *  Exemple d'inclusion des fonctions de gestion d'erreur :
 *
 *  fich1.c :
 *  @code
 *    #define SOURCE_ERREUR "fich1.c"
 *    #include "erreur.h"
 *    
 *    //...
 *    
 *    erreur::warning( "attention" );
 *  @endcode
 *
 *  fich2.c :
 *  @code
 *    #define SOURCE_ERREUR "fich2.c"
 *    #include "erreur.h"
 *
 *    //...
 *
 *    erreur::fatale( "crash" );
 *  @endcode
 */

#ifndef ERREUR_C
#define ERREUR_C


/* Gestion des mots clés 'extern' : seul le fichier xalib.c définira réellement le fichier de log */
#ifdef XALIB_C
#define EXTERN
#else
#define EXTERN extern
#endif

/** @brief Emplacement du fichier de log des erreurs
 */
EXTERN FILE* logfile;


/** @brief Fichier de log des erreurs 
 *  
 *  Chemin relatif vers le fichier de log dans lequel seront stockés les messages.
 *  Le fichier doit pouvoir être ouvert en écriture ou créé le cas échéant
 */
#ifndef LOGFILE
#define LOGFILE "./xa.log"
#endif

/** @brief Niveau de priorité maximum des messages affichés à l'écran
 *
 *  Seuls les messages de priorité inférieure ou égale à ce niveau seront affichés sur le flux d'erreur.
 */
#ifndef SCREEN_LEVEL
#define SCREEN_LEVEL 3
#endif

/** @brief Niveau de priorité maximum des messages ajoutés au log 
 *
 *  Seuls les messages de priorité inférieure ou égale à ce niveau seront ajoutés au fichier de log.
 */
#ifndef LOG_LEVEL
#define LOG_LEVEL 2
#endif

/** @brief Fichier source déclenchant l'erreur
 *
 *  Cette macro doit contenir le nom du fichier source qui déclenche l'erreur.
 *  C'est le nom de fichier qui apparaitra en début de ligne lors de l'affichage du message.
 */
#ifndef SOURCE_ERREUR
#define SOURCE_ERREUR "inconnu"
#endif

#include <stdlib.h>
#include <time.h>
#include <stdio.h>


/** @namespace erreur
 *  @brief Module de gestion des messages de log/erreur
 *
 *  L'utilisation de ce module est détaillée dans la documentation du fichier erreur.h
 *
 *  @see erreur.h
 */
namespace erreur
{
  void openlog();
  void log(char *message, int prio);
  void screen(char *message, int prio);
  void fatale(char *message);
  void warning(char *message);
  void debug(char *message);
  void generique(char *message, int prio);
  void closelog();
}

/** @brief Ouverture du fichier de log
 *
 *  Ouvre le fichier de log designe par la macro LOGFILE
 *  dans la variable globale logfile
 */
inline void erreur::openlog()
{
  logfile=fopen(LOGFILE,"a");
  if( logfile==NULL )
    {
      perror( "erreur::openlog " );
      exit(EXIT_FAILURE);
    }
}

/** @brief Fermeture du fichier de log
 */
inline void erreur::closelog()
{
  fclose(logfile);
}

/** @brief Ajout d'un message au log
 *
 *  Ajoute le message d'erreur à la fin du fichier de log défini par la macro LOGFILE
 *  selon le format :
 *    @verbatim priorité [source]    aaaa/mm/jj hh:mm:ss    message @endverbatim
 *
 *  @param message le message d'erreur
 *  @param prio la priorié du message:
 *           @li 1 erreur fatale
 *           @li 2 warning
 *           @li 3 message de déboguage
 */
inline void erreur::log(char *message, int prio)
{
  time_t tmp;
  struct tm *tmp2;
  
  time(&tmp);
  tmp2 = localtime(&tmp);

  fprintf( logfile, "<niveau%d> [%s]\t%4d/%02d/%02d %02d:%02d:%02d\t%s\t</niveau%d>\n",
           prio,SOURCE_ERREUR,
           tmp2->tm_year+1900,tmp2->tm_mon,tmp2->tm_mday,
           tmp2->tm_hour,tmp2->tm_min,tmp2->tm_sec,
           message, prio);
}


/** @brief Affichage d'un message à l'écran
 *  
 *  Affiche le message sur la sortie d'erreur standard selon le format :
 *    @verbatim priorité [source]    message @endverbatim
 *
 *  @param message le message d'erreur
 *  @param prio la priorié du message:
 *           @li 1 erreur fatale
 *           @li 2 warning
 *           @li 3 message de déboguage
 */
inline void erreur::screen(char *message, int prio)
{
  fprintf( stderr, "<niveau%d> [%s]\t%s\t</niveau%d>\n", prio, SOURCE_ERREUR, message, prio);
  fflush( stderr );
}


/** @brief Message d'erreur fatale
 *
 *  Traite un message de priorité 1 (erreur fatale) selon le mode de erreur::generique()
 *
 *  @param message le message d'erreur
 */
inline void erreur::fatale(char *message)
{
#if LOG_LEVEL>0
  log(message,1);
#endif

#if SCREEN_LEVEL>0
  screen(message,1);
#endif
}


/** @brief Message de warning
 *
 *  Traite un message de priorité 2 (warning) selon le mode de erreur::generique()
 *
 *  @param message le message de warning
 */
inline void erreur::warning(char *message)
{
#if LOG_LEVEL>1
  log(message,2);
#endif

#if SCREEN_LEVEL>1
  screen(message,2);
#endif
}

/** @brief Message de déboguage
 *
 *  Traite un message de priorité 3 (déboguage) selon le mode de erreur::generique()
 *
 *  @param message le message de déboguage
 */
inline void erreur::debug(char *message)
{
#if LOG_LEVEL>2
  log(message,3);
#endif

#if SCREEN_LEVEL>2
  screen(message,3);
#endif
}


/** @brief Message d'erreur
 *
 *  Traite un message d'erreur de priorité donnée :
 *    @li si la priorité du message est inférieure à LOG_LEVEL,
 *           le message est ajouté au log (Cf. log() )
 *    @li si la priorité du message est inférieure à SCREEN_LEVEL,
 *           le message est affiché sur le flux d'erreurs (Cf. screen() )
 *
 *  @param message le message d'erreur
 *  @param prio la priorité du message
 */
inline void erreur::generique(char *message, int prio=4)
{
  if( prio<LOG_LEVEL )
    log(message,prio);
  
  if( prio<SCREEN_LEVEL )
    screen(message,prio);
}

#undef LOGFILE
#undef SCREEN_LEVEL
#undef LOG_LEVEL
#undef SOURCE_ERREUR

#endif

---