1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* 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.
*/
/**
* @file parc_LogLevel.h
* @brief Logging levels for PARCLog
*
* A PARCLogLevel represents both the severity level of a particular PARCLogEntry,
* and the threshold of a particular PARCLog instance.
*
*/
#ifndef PARC_Library_parc_LogLevel_h
#define PARC_Library_parc_LogLevel_h
typedef unsigned char PARCLogLevel;
/** OFF is a special level that can be used to turn off logging. */
extern const PARCLogLevel PARCLogLevel_Off;
/** ALL indicates that all messages should be logged. */
extern const PARCLogLevel PARCLogLevel_All;
/** PARCLogLevel_Emergency is a message level indicating the system is unusable. */
extern const PARCLogLevel PARCLogLevel_Emergency;
/** PARCLogLevel_Alert is a message level indicating action must be taken immediately to ensure correctness. */
extern const PARCLogLevel PARCLogLevel_Alert;
/** PARCLogLevel_Critical is a message level for critical conditions. */
extern const PARCLogLevel PARCLogLevel_Critical;
/** PARCLogLevel_Error is a message level reporting error conditions. */
extern const PARCLogLevel PARCLogLevel_Error;
/** PARCLogLevel_Warning indicates a fairly detailed tracing message. */
extern const PARCLogLevel PARCLogLevel_Warning;
/** FINEST indicates a normal but significant condition. */
extern const PARCLogLevel PARCLogLevel_Notice;
/** INFO is a message level for informational messages. */
extern const PARCLogLevel PARCLogLevel_Info;
/** INFO is a message level for debug-level messages. */
extern const PARCLogLevel PARCLogLevel_Debug;
/**
* Compare `PARCLogLevel` instances @p levelA and @p levelA for order.
*
* @param [in] levelA An instance of PARCLogLevel.
* @param [in] levelB An instance of PARCLogLevel.
*
* @return < 0 levelA is less than levelB
* @return == 0 levelA is equal to levelB
* @return > 0 levelA is greater than levelB
*
* Example:
* @code
* {
* int comparison = parcLogLevel_Compare(PARCLogLevel_Notice, PARCLogLevel_Notice);
* }
* @endcode
*/
#define parcLogLevel_Compare(_levelA_, _levelB_) (_levelA_ - _levelB_)
//int parcLogLevel_Compare(const PARCLogLevel levelA, const PARCLogLevel levelB);
/**
* Determine if two instances of PARCLogLevel are equal.
*
* @param [in] levelA An instance of PARCLogLevel.
* @param [in] levelB An instance of PARCLogLevel.
*
* @return true The instances are equal.
* @return false The instances are not equal.
*
* Example:
* @code
* {
* bool equal = parcLogLevel_Equals(PARCLogLevel_Notice, PARCLogLevel_Notice);
* }
* @endcode
*/
int parcLogLevel_Equals(const PARCLogLevel levelA, const PARCLogLevel levelB);
/**
* Get the string representation of the PARCLogLevel;
*
* @param [in] level A valid PARCLogLevel
*
* @return A pointer to a constant, nul-terminated C string.
*
* Example:
* @code
* {
* const char * logLevelString = parcLogLevel_ToString(PARCLogLevel_Emergency);
* }
* @endcode
*/
const char *parcLogLevel_ToString(const PARCLogLevel level);
/**
* Given a string representation of a logging level, return the corresponding PARCLogLevel value.
*
* The string is case insensitive.
*
* Unknown or uninterpretable strings return PARCLogLevel_All.
*
* @param [in] levelAsString A nul-terminated C string representation of the logging level.
*
* @return A valid PARCLogLevel.
*
* Example:
* @code
* {
* PARCLogLevel level = parcLogLevel_FromString("Emergency");
* }
* @endcode
*/
PARCLogLevel parcLogLevel_FromString(const char *levelAsString);
#endif
|
