FMI Library: part of JModelica.org
jm_callbacks.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2012 Modelon AB
3 
4  This program is free software: you can redistribute it and/or modify
5  it under the terms of the BSD style license.
6 
7  This program is distributed in the hope that it will be useful,
8  but WITHOUT ANY WARRANTY; without even the implied warranty of
9  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  FMILIB_License.txt file for more details.
11 
12  You should have received a copy of the FMILIB_License.txt file
13  along with this program. If not, contact Modelon AB <http://www.modelon.com>.
14 */
15 
16 #ifndef JM_CALLBACKS_H
17 #define JM_CALLBACKS_H
18 #include <stddef.h>
19 #include <stdarg.h>
20 
21 #include <fmilib_config.h>
22 
23 #include "jm_types.h"
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
37 typedef struct jm_callbacks jm_callbacks;
38 
45 typedef jm_voidp (*jm_malloc_f)(size_t size);
46 
48 typedef jm_voidp (*jm_realloc_f)(void *ptr, size_t size);
49 
51 typedef jm_voidp (*jm_calloc_f)(size_t numitems, size_t itemsize);
52 
54 typedef void (*jm_free_f)(jm_voidp p);
68 typedef void (*jm_logger_f)(jm_callbacks* c, jm_string module, jm_log_level_enu_t log_level, jm_string message);
69 
71 #define JM_MAX_ERROR_MESSAGE_SIZE 2000
72 
74 struct jm_callbacks {
76  jm_malloc_f malloc;
78  jm_calloc_f calloc;
80  jm_realloc_f realloc;
82  jm_free_f free;
84  jm_logger_f logger;
86  jm_log_level_enu_t log_level;
88  jm_voidp context;
90  char errMessageBuffer[JM_MAX_ERROR_MESSAGE_SIZE];
91 };
92 
99 static jm_string jm_get_last_error(jm_callbacks* cb) {return cb->errMessageBuffer; }
100 
104 static void jm_clear_last_error(jm_callbacks* cb) { cb->errMessageBuffer[0] = 0; }
105 
112 FMILIB_EXPORT
113 void jm_set_default_callbacks(jm_callbacks* c);
114 
119 FMILIB_EXPORT
120 jm_callbacks* jm_get_default_callbacks(void);
121 
125 FMILIB_EXPORT
126 void jm_default_logger(jm_callbacks* c, jm_string module, jm_log_level_enu_t log_level, jm_string message);
127 
135 FMILIB_EXPORT
136 void jm_log(jm_callbacks* cb, const char* module, jm_log_level_enu_t log_level, const char* fmt, ...);
137 
141 FMILIB_EXPORT
142 void jm_log_v(jm_callbacks* cb, const char* module, jm_log_level_enu_t log_level, const char* fmt, va_list ap);
143 
146 FMILIB_EXPORT
147 void jm_log_fatal_v(jm_callbacks* cb, const char* module, const char* fmt, va_list ap);
150 FMILIB_EXPORT
151 void jm_log_fatal(jm_callbacks* cb, const char* module, const char* fmt, ...);
152 
155 FMILIB_EXPORT
156 void jm_log_error_v(jm_callbacks* cb, const char* module, const char* fmt, va_list ap);
157 
160 FMILIB_EXPORT
161 void jm_log_error(jm_callbacks* cb, const char* module, const char* fmt, ...);
162 
165 FMILIB_EXPORT
166 void jm_log_warning_v(jm_callbacks* cb, const char* module, const char* fmt, va_list ap);
167 
170 FMILIB_EXPORT
171 void jm_log_warning(jm_callbacks* cb, const char* module, const char* fmt, ...);
172 
175 FMILIB_EXPORT
176 void jm_log_info_v(jm_callbacks* cb, const char* module, const char* fmt, va_list ap);
179 FMILIB_EXPORT
180 void jm_log_info(jm_callbacks* cb, const char* module, const char* fmt, ...);
181 
184 FMILIB_EXPORT
185 void jm_log_verbose_v(jm_callbacks* cb, const char* module, const char* fmt, va_list ap);
188 FMILIB_EXPORT
189 void jm_log_verbose(jm_callbacks* cb, const char* module, const char* fmt, ...);
190 
191 #ifdef FMILIB_ENABLE_LOG_LEVEL_DEBUG
192 
196 FMILIB_EXPORT
197 void jm_log_debug_v(jm_callbacks* cb, const char* module, const char* fmt, va_list ap);
202 FMILIB_EXPORT
203 void jm_log_debug(jm_callbacks* cb, const char* module, const char* fmt, ...);
204 #else
205 
209 static void jm_log_debug_v(jm_callbacks* cb, const char* module, const char* fmt, va_list ap) {}
214 static void jm_log_debug(jm_callbacks* cb, const char* module, const char* fmt, ...) {}
215 #endif
216 
217 
218 /* @}
219 */
220 
221 #ifdef __cplusplus
222 }
223 #endif
224 /* JM_CONTEXT_H */
225 #endif
jm_log_info_v
FMILIB_EXPORT void jm_log_info_v(jm_callbacks *cb, const char *module, const char *fmt, va_list ap)
Send an info message to the logger function. See jm_log() for details.
jm_callbacks::calloc
jm_calloc_f calloc
Allocate zero initialized memory.
Definition: jm_callbacks.h:77
fmilib_config.h
Library configuration file generated by the build system.
jm_log_warning_v
FMILIB_EXPORT void jm_log_warning_v(jm_callbacks *cb, const char *module, const char *fmt, va_list ap)
Send a warning message to the logger function. See jm_log() for details.
c
size_t jm_callbacks * c
Definition: jm_vector_template.h:37
jm_get_default_callbacks
FMILIB_EXPORT jm_callbacks * jm_get_default_callbacks(void)
Get default callbacks. The function never returns NULL.
jm_voidp
void * jm_voidp
A void pointer.
Definition: jm_types.h:35
jm_realloc_f
jm_voidp(* jm_realloc_f)(void *ptr, size_t size)
Re-allocation function type.
Definition: jm_callbacks.h:48
jm_clear_last_error
static void jm_clear_last_error(jm_callbacks *cb)
Clear the last generated log message.
Definition: jm_callbacks.h:103
jm_log_debug_v
static void jm_log_debug_v(jm_callbacks *cb, const char *module, const char *fmt, va_list ap)
Send a debug message to the logger function. See jm_log() for details.
Definition: jm_callbacks.h:208
jm_log_v
FMILIB_EXPORT void jm_log_v(jm_callbacks *cb, const char *module, jm_log_level_enu_t log_level, const char *fmt, va_list ap)
Send a message to the logger function.
jm_callbacks::errMessageBuffer
char errMessageBuffer[JM_MAX_ERROR_MESSAGE_SIZE]
The buffer used along with jm_get_last_error()
Definition: jm_callbacks.h:89
jm_log
FMILIB_EXPORT void jm_log(jm_callbacks *cb, const char *module, jm_log_level_enu_t log_level, const char *fmt,...)
Send a message to the logger function.
jm_calloc_f
jm_voidp(* jm_calloc_f)(size_t numitems, size_t itemsize)
Zero-initialized allocation function type.
Definition: jm_callbacks.h:51
jm_log_level_enu_t
jm_log_level_enu_t
Log levels supported via the logger functions in jm_callbacks.
Definition: jm_types.h:51
size
v size
Definition: jm_vector_template.h:62
jm_callbacks::log_level
jm_log_level_enu_t log_level
Logging level.
Definition: jm_callbacks.h:85
jm_log_fatal_v
FMILIB_EXPORT void jm_log_fatal_v(jm_callbacks *cb, const char *module, const char *fmt, va_list ap)
Send a fatal error message to the logger function. See jm_log() for details.
FMILIB_EXPORT
#define FMILIB_EXPORT
Used to declare the public API of the library needed for dynamic linking.
jm_get_last_error
static jm_string jm_get_last_error(jm_callbacks *cb)
Get the last log message produced by the library.
Definition: jm_callbacks.h:98
jm_log_warning
FMILIB_EXPORT void jm_log_warning(jm_callbacks *cb, const char *module, const char *fmt,...)
Send a warning message to the logger function. See jm_log() for details.
jm_set_default_callbacks
FMILIB_EXPORT void jm_set_default_callbacks(jm_callbacks *c)
Set the structure to be returned by jm_get_default_callbacks().
jm_log_fatal
FMILIB_EXPORT void jm_log_fatal(jm_callbacks *cb, const char *module, const char *fmt,...)
Send a fatal error message to the logger function. See jm_log() for details.
jm_malloc_f
jm_voidp(* jm_malloc_f)(size_t size)
Allocation function type.
Definition: jm_callbacks.h:45
jm_log_error_v
FMILIB_EXPORT void jm_log_error_v(jm_callbacks *cb, const char *module, const char *fmt, va_list ap)
Send a error message to the logger function. See jm_log() for details.
jm_callbacks::malloc
jm_malloc_f malloc
Allocate non-initialized memory.
Definition: jm_callbacks.h:75
jm_callbacks::context
jm_voidp context
Arbitrary context pointer passed to the logger function.
Definition: jm_callbacks.h:87
jm_string
const char * jm_string
A constant string.
Definition: jm_types.h:33
jm_log_info
FMILIB_EXPORT void jm_log_info(jm_callbacks *cb, const char *module, const char *fmt,...)
Send an info message to the logger function. See jm_log() for details.
jm_default_logger
FMILIB_EXPORT void jm_default_logger(jm_callbacks *c, jm_string module, jm_log_level_enu_t log_level, jm_string message)
The default logger implementation prints messages to stderr.
jm_callbacks
The callbacks struct is sent to all the modules in the library.
Definition: jm_callbacks.h:73
jm_logger_f
void(* jm_logger_f)(jm_callbacks *c, jm_string module, jm_log_level_enu_t log_level, jm_string message)
Logger callback type.
Definition: jm_callbacks.h:67
jm_log_verbose_v
FMILIB_EXPORT void jm_log_verbose_v(jm_callbacks *cb, const char *module, const char *fmt, va_list ap)
Send a verbose message to the logger function. See jm_log() for details.
JM_MAX_ERROR_MESSAGE_SIZE
#define JM_MAX_ERROR_MESSAGE_SIZE
Maximum message size that can be stored in the jm_callbacks struct.
Definition: jm_callbacks.h:70
jm_callbacks::realloc
jm_realloc_f realloc
Re-allocate memory.
Definition: jm_callbacks.h:79
jm_callbacks::free
jm_free_f free
Free-allocated memory.
Definition: jm_callbacks.h:81
jm_log_verbose
FMILIB_EXPORT void jm_log_verbose(jm_callbacks *cb, const char *module, const char *fmt,...)
Send a verbose message to the logger function. See jm_log() for details.
jm_callbacks::logger
jm_logger_f logger
Logging callback.
Definition: jm_callbacks.h:83
jm_log_error
FMILIB_EXPORT void jm_log_error(jm_callbacks *cb, const char *module, const char *fmt,...)
Send a error message to the logger function. See jm_log() for details.
jm_log_debug
static void jm_log_debug(jm_callbacks *cb, const char *module, const char *fmt,...)
Send a debug message to the logger function. See jm_log() for details.
Definition: jm_callbacks.h:213
jm_types.h
jm_free_f
void(* jm_free_f)(jm_voidp p)
Free memory function type.
Definition: jm_callbacks.h:54
Generated by   doxygen 1.8.11