include/EDoc/StdErrNotifier.h

Go to the documentation of this file.

/*******************************************************************************

   Copyright (C) 2007 by Brendon Costa

   This library is free software; you can redistribute it and/or modify 
   it under the terms of the "LGPL Like" License defined in the file COPYING 
   that should have been distributed along with this source.

   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.  

   You should have received a copy of the "LGPL Like" License 
   along with this library; see the file COPYING. if not, it can be 
   obtained from the EDoc++ website: 
   http://edoc.sourceforge.net/license.html

*******************************************************************************/
#ifndef EDOC_STDERRNOTIFIER_H
#define EDOC_STDERRNOTIFIER_H

#include "EDoc/stdint.h"
#include "EDoc/NotificationIFace.h"

namespace EDoc
{
   //===========================================================================
   /** \brief Standard implementation of NotificationIFace that notifies users
    * of events through the stderr stream.
    *
    * This will display events in a format that should be simple for automated
    * parsers to extract infromation from.
    *
    * Note: This does not display events as they occur, but queues them in a
    * list that can be displayed at a later time. This is to avoid events being
    * intermixed with progress bar indication data. All events will be displayed
    * by calling PrintAll()
    */
   class StdErrNotifier : public NotificationIFace
   {
   public:

      //------------------------------------------------------------------------
      /** \brief Constructor.
       *
       * Adds all the standard notification events found in events.inc upon
       * construction.
       */
      StdErrNotifier(bool show_details_in);
      
      //------------------------------------------------------------------------
      /** \brief Destructor.
       */
      virtual ~StdErrNotifier();
      
      //------------------------------------------------------------------------
      /** \brief Registers a new event type.
       */
      void RegisterEvent(EventType type, EventCode code, std::string name, 
         std::string summary);

      //------------------------------------------------------------------------
      /** \brief Prints an event.
       */
      void PrintEvent(EventCode code, const std::string& message);

      //------------------------------------------------------------------------
      /** \brief See NotificationIFace::Event()
       */
      virtual void Event(EventCode code, 
         const char* source_file, 
         unsigned int source_line, 
         std::string message,
         const Function* function, 
         const File* file, 
         uint32_t line, 
         const File* rfile, 
         uint32_t rline, 
         const Type* type, 
         const PropogatingException* prop_exc,
         const FunctionType* function_type,
         const char* extra);

      //------------------------------------------------------------------------
      /** \brief Displays current configuration.
       */
      std::ostream& Print(std::ostream& out) const;
      
      //------------------------------------------------------------------------
      /** \brief Prints all currently queued events to stderr.
       */
      void PrintAll();
      
      //------------------------------------------------------------------------
      /** \brief Returns the total number of error type events encountered.
       */
      uint32_t GetTotalErrorCount() const
      {
         return error_count;
      }

      //------------------------------------------------------------------------

   private:
      
      //------------------------------------------------------------------------
      /** \brief Temporary structure for storing events for display at alater
       * date.
       */
      struct Details
      {
         //---------------------------------------------------------------------
         /** \brief Constructor.
          */
         Details() {}
         
         //---------------------------------------------------------------------
         /** \brief Constructor.
          */
         Details(EventType type_in, 
               std::string name_in, 
               std::string summary_in) :

            type(type_in),
            name(name_in),
            summary(summary_in)
         {}
         
         //---------------------------------------------------------------------
         /** \brief The type of the event that occured.
          */
         EventType type;

         //---------------------------------------------------------------------
         /** \brief The name of the event that occured.
          */
         std::string name;

         //---------------------------------------------------------------------
         /** \brief A summary of the event.
          */
         std::string summary;

         //---------------------------------------------------------------------
      };
      
      //------------------------------------------------------------------------
      /** \brief Lists all possible event types that may occur.
       */
      std::map<EventCode, Details> event_types;

      //------------------------------------------------------------------------
      /** \brief A list of enqueued events that have yet to be displayed.
       */
      std::list<std::string> messages;

      //------------------------------------------------------------------------
      /** \brief If true display details about notification events.
       */
      bool show_details;

      //------------------------------------------------------------------------
      /** \brief Stores statistics for the number of the events were errors.
       */
      uint32_t error_count;

      //------------------------------------------------------------------------

   };
   //===========================================================================
}

#endif // EDOC_STDERRNOTIFIER_H

---