IpJournalist.hpp

Go to the documentation of this file.

// Copyright (C) 2004, 2009 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// Authors:  Carl Laird, Andreas Waechter     IBM    2004-08-13

#ifndef __IPJOURNALIST_HPP__
#define __IPJOURNALIST_HPP__

#include "IpoptConfig.h"
#include "IpTypes.hpp"
#include "IpReferenced.hpp"
#include "IpSmartPtr.hpp"

#include <cstdarg>
#include <cstdio>
#include <string>
#include <vector>
#include <ostream>

namespace Ipopt
{

// forward declarations
class Journal;
class FileJournal;


enum EJournalLevel
{
   J_INSUPPRESSIBLE = -1,
   J_NONE = 0,
   J_ERROR,
   J_STRONGWARNING,
   J_SUMMARY,
   J_WARNING,
   J_ITERSUMMARY,
   J_DETAILED,
   J_MOREDETAILED,
   J_VECTOR,
   J_MOREVECTOR,
   J_MATRIX,
   J_MOREMATRIX,
   J_ALL,
   J_LAST_LEVEL
};

enum EJournalCategory
{
   J_DBG = 0,
   J_STATISTICS,
   J_MAIN,
   J_INITIALIZATION,
   J_BARRIER_UPDATE,
   J_SOLVE_PD_SYSTEM,
   J_FRAC_TO_BOUND,
   J_LINEAR_ALGEBRA,
   J_LINE_SEARCH,
   J_HESSIAN_APPROXIMATION,
   J_SOLUTION,
   J_DOCUMENTATION,
   J_NLP,
   J_TIMING_STATISTICS,
   J_USER_APPLICATION, 
   J_USER1,            
   J_USER2,            
   J_USER3,            
   J_USER4,            
   J_USER5,            
   J_USER6,            
   J_USER7,            
   J_USER8,            
   J_USER9,            
   J_USER10,           
   J_USER11,           
   J_USER12,           
   J_USER13,           
   J_USER14,           
   J_USER15,           
   J_USER16,           
   J_USER17,           
   J_LAST_CATEGORY
};

class IPOPTLIB_EXPORT Journalist: public ReferencedObject
{
public:

   Journalist();

   virtual ~Journalist();


#ifdef __GNUC__
   __attribute__((format(printf, 4, 5)))
#endif
   virtual void Printf(
      EJournalLevel    level,
      EJournalCategory category,
      const char*      format,
      ...
   ) const;

   virtual void PrintStringOverLines(
      EJournalLevel      level,
      EJournalCategory   category,
      Index              indent_spaces,
      Index              max_length,
      const std::string& line
   ) const;

#ifdef __GNUC__
   __attribute__((format(printf, 5, 6)))
#endif
   virtual void PrintfIndented(
      EJournalLevel    level,
      EJournalCategory category,
      Index            indent_level,
      const char*      format,
      ...
   ) const;

   virtual void VPrintf(
      EJournalLevel    level,
      EJournalCategory category,
      const char*      pformat,
      va_list          ap
   ) const;

   virtual void VPrintfIndented(
      EJournalLevel    level,
      EJournalCategory category,
      Index            indent_level,
      const char*      pformat,
      va_list          ap
   ) const;

   virtual bool ProduceOutput(
      EJournalLevel    level,
      EJournalCategory category
   ) const;

   virtual void FlushBuffer() const;


   virtual bool AddJournal(
      const SmartPtr<Journal> jrnl
   );

   virtual SmartPtr<Journal> AddFileJournal(
      const std::string& location_name,            
      const std::string& fname,                    
      EJournalLevel      default_level = J_WARNING,
      bool               file_append = false       
   );

   virtual SmartPtr<Journal> GetJournal(
      const std::string& location_name
   );

   virtual void DeleteAllJournals();

private:

   Journalist(
      const Journalist&
   );

   void operator=(
      const Journalist&
   );

   //** Private Data Members. */
   std::vector<SmartPtr<Journal> > journals_;
};

class IPOPTLIB_EXPORT Journal: public ReferencedObject
{
public:
   Journal(
      const std::string& name,
      EJournalLevel      default_level
   );

   virtual ~Journal();

   virtual std::string Name();

   virtual void SetPrintLevel(
      EJournalCategory category,
      EJournalLevel    level
   );

   virtual void SetAllPrintLevels(
      EJournalLevel level
   );


   virtual bool IsAccepted(
      EJournalCategory category,
      EJournalLevel    level
   ) const;

   virtual void Print(
      EJournalCategory category,
      EJournalLevel    level,
      const char*      str
   )
   {
      PrintImpl(category, level, str);
   }

   virtual void Printf(
      EJournalCategory category,
      EJournalLevel    level,
      const char*      pformat,
      va_list          ap
   )
   {
      PrintfImpl(category, level, pformat, ap);
   }

   virtual void FlushBuffer()
   {
      FlushBufferImpl();
   }

protected:

   virtual void PrintImpl(
      EJournalCategory category,
      EJournalLevel    level,
      const char*      str
   ) = 0;

   virtual void PrintfImpl(
      EJournalCategory category,
      EJournalLevel    level,
      const char*      pformat,
      va_list          ap
   ) = 0;

   virtual void FlushBufferImpl() = 0;

private:

   Journal();

   Journal(
      const Journal&
   );

   void operator=(
      const Journal&
   );

   std::string name_;

   Index print_levels_[J_LAST_CATEGORY];
};

class IPOPTLIB_EXPORT FileJournal: public Journal
{
public:
   FileJournal(
      const std::string& name,
      EJournalLevel default_level
   );

   virtual ~FileJournal();

   virtual bool Open(
      const char* fname,             
      bool        fappend = false    
   );

protected:

   virtual void PrintImpl(
      EJournalCategory /*category*/,
      EJournalLevel    /*level*/,
      const char*      str
   );

   virtual void PrintfImpl(
      EJournalCategory /*category*/,
      EJournalLevel    /*level*/,
      const char*      pformat,
      va_list          ap
   );

   virtual void FlushBufferImpl();

private:

   FileJournal();

   FileJournal(
      const FileJournal&
   );

   void operator=(
      const FileJournal&
   );

   FILE* file_;
};

class IPOPTLIB_EXPORT StreamJournal: public Journal
{
public:
   StreamJournal(
      const std::string& name,
      EJournalLevel default_level
   );

   virtual ~StreamJournal()
   { }

   void SetOutputStream(
      std::ostream* os
   );

protected:

   virtual void PrintImpl(
      EJournalCategory /*category*/,
      EJournalLevel    /*level*/,
      const char*      str
   );

   virtual void PrintfImpl(
      EJournalCategory /*category*/,
      EJournalLevel    /*level*/,
      const char*      pformat,
      va_list          ap
   );

   virtual void FlushBufferImpl();

private:

   StreamJournal();

   StreamJournal(
      const StreamJournal&
   );

   void operator=(
      const StreamJournal&
   );

   std::ostream* os_;

   char buffer_[32768];
};

} // namespace

#endif