// $Id: ESMCI_LogErr.h,v 1.8.2.1 2010/02/05 19:58:55 svasquez Exp $
//
// Earth System Modeling Framework
// Copyright 2002-2010, University Corporation for Atmospheric Research, 
// Massachusetts Institute of Technology, Geophysical Fluid Dynamics 
// Laboratory, University of Michigan, National Centers for Environmental 
// Prediction, Los Alamos National Laboratory, Argonne National Laboratory, 
// NASA Goddard Space Flight Center.
// Licensed under the University of Illinois-NCSA License.

// ESMC Log include file for C++

// these lines prevent this file from being read more than once if it
// ends up being included multiple times

#ifndef ESMCI_LOGERR_H
#define ESMCI_LOGERR_H

//-----------------------------------------------------------------------------
//BOP
// !CLASS: ESMCI_Log - C++ interface to Log
//
// !DESCRIPTION:
//
// The code in this file defines the C++ Log members and declares all class
// data and methods.  All methods, except for the Set and Get methods, which
// are inlined, are defined in the companion file ESMCI\_LogErr.C
//
// !USES:

#include <stdlib.h>

#include "ESMC_LogErr.h"
#include "ESMCI_Util.h"
#include "ESMC_Conf.h"

namespace ESMCI{

class LogErr {
private:
// !PRIVATE TYPES:

    int numFilePtr;             // index into global array of File pointers
                                // for C++ I/O
    ESMC_Logical FileIsOpen;

    ESMC_Logical verbose;       // If set to ESMC_TF_TRUE, log messages written 
                                // out.

    ESMC_Logical flush;         // If true, all output is flushed

    ESMC_Logical rootOnly;

    int halt;

    int filetype;

    int stream;

    int max_elements;
    
    int *pet_number;
		
    ESMC_Logical fileI0;        // If true, output written to files

    int stdOutUnitNumber;       // Unit number corresponding to standard 
                                // out
    
  public:
// !PUBLIC MEMBER FUNCTIONS:
// (see ESMC\_LogErr.C for a description of these methods)
    
    bool AllocError(int *rcToReturn);
    bool AllocError(int LINE,const char FILE[],const char method[],int *rcToReturn);
    bool DeallocError(int *rcToReturn);
    bool DeallocError(int LINE,const char FILE[],const char method[],int *rcToReturn);
    void Close();
    bool FoundError(int rcToCheck,int *rcToReturn);
    bool FoundError(int rcToCheck,int LINE,const char FILE[],const char method[],
         int *rcToReturn);
    bool MsgAllocError(const char msg[],int *rcToReturn);
    bool MsgAllocError(const char msg[],int LINE,const char FILE[],const char method[],
      int *rcToReturn);
    bool MsgDeallocError(const char msg[],int *rcToReturn);
    bool MsgDeallocError(const char msg[],int LINE,const char FILE[],const char method[],
      int *rcToReturn);
    bool MsgFoundError(int rcToCheck,const char msg[],int *rcToReturn);
    bool MsgFoundError(int rcToCheck,const char msg[],int LINE,const char FILE[],
         const char method[],int *rcToReturn);
    void Open(const char filename[]);
    bool Write(const char msg[],int msgtype);
    bool Write(const char msg[],int msgtype,int LINE,const char FILE[],
         const char method[]);       
// !PUBLIC Variables:          
    FILE *ESMC_LogFile;
    char nameLogErrFile[32];
    int *pet_num;
    ESMC_LogType logtype;
    int *errorMask;
    int errorMaskCount;


  private:
// !PRIVATE MEMBER FUNCIONS:
    
};

} //namespace ESMCI

// the default global log object
extern ESMCI::LogErr ESMC_LogDefault;
extern "C" {
 void FTN(f_esmf_logwrite0)(const char *msg, int *msgtype, int *rc, ESMCI_FortranStrLenArg mlen);
 void FTN(f_esmf_logwrite1)(const char *msg, int *msgtype,
                            int *line, const char *file, const char *method, int *rc,
                            ESMCI_FortranStrLenArg mlen, ESMCI_FortranStrLenArg flen,
			    ESMCI_FortranStrLenArg mdlen);
}

//EOP


#endif  //ESMCI_LOGERR_H