OpenDNSSEC-enforcer  1.4.9
message.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008-2009 Nominet UK. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
19  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
21  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
22  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
23  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  */
26 
27 #ifndef KSM_MESSAGE_H
28 #define KSM_MESSAGE_H
29 
30 /*+
31  * Filename: message.h
32  *
33  * Description:
34  * Definitions of the message utility functions and data structures.
35 -*/
36 
37 #include <stdarg.h>
38 
39 #include <ksm/system_includes.h>
40 #include <ksm/memory.h>
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 typedef void (*MSG_OUTPUT_FUNCTION)(const char* text);
47 
48 typedef struct {
49  int min; /* Base value of the error code range */
50  int max; /* Maximum error code value */
51  const char** message; /* Message text value */
52  MSG_OUTPUT_FUNCTION output; /* Output function for this message block */
54 
55 
56 void MsgInit(void);
57 void MsgDefaultOutput(const char* text);
58 void MsgNoOutput(const char* text);
59 void MsgRegister(int min, int max, const char** message,
60  MSG_OUTPUT_FUNCTION output);
61 int MsgFindCodeBlock(int status);
62 const char* MsgText(int status);
64 void MsgSetOutput(int code, MSG_OUTPUT_FUNCTION output);
65 int MsgLog(int status, ...);
66 int MsgLogAp(int status, va_list ap);
67 void MsgRundown(void);
68 
69 
70 #ifdef __cplusplus
71 }
72 #endif
73 
74 #endif /* KSM_MESSAGE_H */
void MsgNoOutput(const char *text)
Definition: message.c:104
#define max(x, y)
int MsgLogAp(int status, va_list ap)
Definition: message.c:371
#define min(x, y)
int MsgLog(int status,...)
Definition: message.c:335
const char * MsgText(int status)
Definition: message.c:223
MSG_OUTPUT_FUNCTION MsgGetOutput(int status)
Definition: message.c:258
int MsgFindCodeBlock(int status)
Definition: message.c:186
MSG_OUTPUT_FUNCTION output
Definition: message.h:52
void MsgRegister(int min, int max, const char **message, MSG_OUTPUT_FUNCTION output)
Definition: message.c:141
const char ** message
Definition: message.h:51
void MsgRundown(void)
Definition: message.c:412
void MsgSetOutput(int code, MSG_OUTPUT_FUNCTION output)
Definition: message.c:290
void MsgDefaultOutput(const char *text)
Definition: message.c:84
void MsgInit(void)
Definition: message.c:63
void(* MSG_OUTPUT_FUNCTION)(const char *text)
Definition: message.h:46