streams.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef STREAMS_H
#define STREAMS_H
 
#include <stdarg.h>
#include <stdio.h>
#include "grassroots_util_library.h"
#include "typedefs.h"
 
#define STM_LEVEL_NONE      (0)
 
 
#define STM_LEVEL_SEVERE  (1024)
 
#define STM_LEVEL_WARNING (1025)
 
#define STM_LEVEL_INFO    (1026)
 
#define STM_LEVEL_FINE    (1027)
 
#define STM_LEVEL_FINER   (1028)
 
#define STM_LEVEL_FINEST  (1029)
 
 
#define STM_LEVEL_ALL   (0xFFFFFFFF)
 
 
 
/******** FORWARD DECLARATION ******/
struct OutputStream;
 
 
typedef struct OutputStream
{
  int (*st_print_fn) (struct OutputStream *stream_p, const uint32 level, const char * const filename_s, const int line_number, const char *message_s, va_list args);
 
  bool (*st_flush_fn) (struct OutputStream *stream_p);
 
  void (*st_free_stream_fn) (struct OutputStream *stream_p);
} OutputStream;
 
 
#ifdef __cplusplus
  extern "C" {
#endif
 
 
GRASSROOTS_UTIL_API bool InitDefaultOutputStream (void);
 
 
GRASSROOTS_UTIL_API void FreeDefaultOutputStream (void);
 
 
GRASSROOTS_UTIL_API void SetDefaultErrorStream (OutputStream *stream_p);
 
 
GRASSROOTS_UTIL_API void SetDefaultLogStream (OutputStream *stream_p);
 
 
GRASSROOTS_UTIL_API void FreeOutputStream (struct OutputStream *stream_p);
 
 
GRASSROOTS_UTIL_API int PrintToOutputStream (OutputStream *stream_p, const char * const filename_s, const int line_number, const char *message_s, ...);
 
 
GRASSROOTS_UTIL_API int PrintErrors (const uint32 level, const char * const filename_s, const int line_number, const char *message, ...);
 
 
GRASSROOTS_UTIL_API int PrintLog (const uint32 level, const char * const filename_s, const int line_number, const char *message_s, ...);
 
 
GRASSROOTS_UTIL_API int PrintErrorsVarArgs (const uint32 level, const char * const filename_s, const int line_number, const char *message_s, va_list args);
 
 
GRASSROOTS_UTIL_API int PrintLogVarArgs (const uint32 level, const char * const filename_s, const int line_number, const char *message_s, va_list args);
 
GRASSROOTS_UTIL_API OutputStream *GetLogOutput (void);
 
 
GRASSROOTS_UTIL_API OutputStream *GetErrorsOutput (void);
 
 
GRASSROOTS_UTIL_API bool FlushOutputStream (OutputStream *stream_p);
 
 
GRASSROOTS_UTIL_API bool FlushLog (void);
 
 
GRASSROOTS_UTIL_API bool FlushErrors (void);
 
 
#ifdef __cplusplus
}
#endif
 
#endif  /* STREAMS_H */