KIM API V2
KIM_Log.h
Go to the documentation of this file.
1 /* */
2 /* CDDL HEADER START */
3 /* */
4 /* The contents of this file are subject to the terms of the Common */
5 /* Development and Distribution License Version 1.0 (the "License"). */
6 /* */
7 /* You can obtain a copy of the license at */
8 /* http://www.opensource.org/licenses/CDDL-1.0. See the License for the */
9 /* specific language governing permissions and limitations under the License. */
10 /* */
11 /* When distributing Covered Code, include this CDDL HEADER in each file and */
12 /* include the License file in a prominent location with the name */
13 /* LICENSE.CDDL. */
14 /* If applicable, add the following below this CDDL HEADER, with the fields */
15 /* enclosed by brackets "[]" replaced with your own identifying information: */
16 /* */
17 /* Portions Copyright (c) [yyyy] [name of copyright owner]. */
18 /* All rights reserved. */
19 /* */
20 /* CDDL HEADER END */
21 /* */
22 
23 /* */
24 /* Copyright (c) 2016--2018, Regents of the University of Minnesota. */
25 /* All rights reserved. */
26 /* */
27 /* Contributors: */
28 /* Ryan S. Elliott */
29 /* */
30 
31 /* */
32 /* Release: This file is part of the kim-api-v2.0.0-beta.1 package. */
33 /* */
34 
35 
36 #ifndef KIM_LOG_H_
37 #define KIM_LOG_H_
38 
39 /* Forward declarations */
40 #ifndef KIM_LOG_VERBOSITY_DEFINED_
41 #define KIM_LOG_VERBOSITY_DEFINED_
43 #endif
44 
45 struct KIM_Log;
46 
47 #ifndef KIM_LOG_DEFINED_
48 #define KIM_LOG_DEFINED_
49 typedef struct KIM_Log KIM_Log;
50 #endif
51 
52 int KIM_Log_Create(KIM_Log ** const log);
53 void KIM_Log_Destroy(KIM_Log ** const log);
54 
55 char const * const KIM_Log_GetID(KIM_Log const * const log);
56 void KIM_Log_SetID(KIM_Log * const log, char const * const id);
57 
58 void KIM_Log_PushVerbosity(KIM_Log * const log,
59  KIM_LogVerbosity const logVerbosity);
60 void KIM_Log_PopVerboisty(KIM_Log * const log);
61 
62 void KIM_Log_LogEntry(KIM_Log const * const log,
63  KIM_LogVerbosity const logVerbosity,
64  char const * const message,
65  int const lineNumber, char const * const fileName);
66 
67 
68 #endif /* KIM_LOG_H_ */
void KIM_Log_Destroy(KIM_Log **const log)
int KIM_Log_Create(KIM_Log **const log)
struct KIM_Log KIM_Log
Definition: KIM_Log.h:49
void KIM_Log_LogEntry(KIM_Log const *const log, KIM_LogVerbosity const logVerbosity, char const *const message, int const lineNumber, char const *const fileName)
void KIM_Log_PushVerbosity(KIM_Log *const log, KIM_LogVerbosity const logVerbosity)
void KIM_Log_SetID(KIM_Log *const log, char const *const id)
char const *const KIM_Log_GetID(KIM_Log const *const log)
void KIM_Log_PopVerboisty(KIM_Log *const log)