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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231 | /**
* Copyright (c) 2020-2024 by Altair Engineering, Inc.
* All rights reserved.
*
* Altair Engineering, Inc. makes this software available as part of the Vision
* tool platform. As long as you are a licensee of the Vision tool platform
* you may make copies of the software and modify it to be used within the
* Vision tool platform, but you must include all of this notice on any copy.
* Redistribution without written permission to any third party, with or
* without modification, is not permitted.
* Altair Engineering, Inc. does not warrant that this software is error free
* or fit for any purpose. Altair Engineering, Inc. disclaims any liability for
* all claims, expenses, losses, damages and costs any user may incur as a
* result of using, copying or modifying the software.
* ============================================================================
* @c-code
* Example for Debug Messages
* @section
* C Level Examples
* @description
* Message and debug C-Level API.
* @files
* zdb/debugZdb.c
* @tag
* zdb
*/
#include <stdio.h>
#include "ce_utilities/ce_Defines.h"
#include "ce_utilities/ce_Types.h"
#include "ce_utilities/ce_String.h"
#include "ce_utilities/ce_Error.h"
#include "ce_utilities/ce_Message.h"
#include "ce_utilities/ce_Progress.h"
#include "ce_utilities/ce_Debug.h"
#include "zdb/zdb.h"
#include "zdb/zvalidate.h"
#include "zdb/zdbmem.h"
/**
* convert message types to string.
*/
static const char* type2str(ce_MessageType type) {
switch (type) {
case CE_MESSAGE_TYPE_TITLE:
return " ";
case CE_MESSAGE_TYPE_FATAL:
return "FAT:";
case CE_MESSAGE_TYPE_ERROR:
return "ERR:";
case CE_MESSAGE_TYPE_WARNING:
return "WAR:";
case CE_MESSAGE_TYPE_DEBUG:
return "DBG:";
case CE_MESSAGE_TYPE_UNKNOWN:
return "UNK:";
case CE_MESSAGE_TYPE_INTERNAL:
return "INT:";
case CE_MESSAGE_TYPE_LOG:
return "LOG:";
case CE_MESSAGE_TYPE_INFO:
return " ";
case CE_MESSAGE_TYPE_VERBOSE:
return " ";
}
return "???";
}
/**
* message callback.
*/
static void msgCallback(
ce_Time timeStamp,
ce_MessageType type,
const char *message,
const char *fileName,
ce_Int64 fileLine,
const char *tclScript
) {
UNUSED(timeStamp);
UNUSED(fileName);
UNUSED(fileLine);
UNUSED(tclScript);
if (type == CE_MESSAGE_TYPE_INTERNAL) {
return;
}
printf("%s %s\n", type2str(type), message);
}
/**
* progress callback.
*/
static ce_Bool progCallback(
double progress,
const char* msg
) {
ce_Bool interrupted = ce_False;
ce_MessagePrint(CE_MESSAGE_TYPE_INFO, "Progress %g %s\n", progress, msg);
return interrupted;
}
/**
* Main function.
*/
int main(int argc, char** argv) {
const char* inBinfile = NULL;
const char* logfile = NULL;
const char* debugFlag = NULL;
ce_Bool timesteps = ce_False;
DB* db = NULL;
ce_Bool ok;
int i;
/**
* init signal handler.
*/
ce_DebugInstallSignalHandler();
/**
* init message system.
*/
ce_MessageInit();
/**
* Need : the path to the binfile.
* Optional: the path to the logfile.
*/
if (argc < 2) {
ce_MessagePrint(CE_MESSAGE_TYPE_ERROR,
"Usage: %s <INBINFILE>"
" ?-logfile <LOGFILE>? ?-debugflag <DEBUGFLAG>? ?-timesteps on?\n",
argv[0]);
goto end;
}
/**
* get arguments.
*/
inBinfile = argv[1];
for (i = 2; i < argc-1; i++) {
if (ce_StringIsEqual(argv[i], "-logfile")) {
logfile = argv[++i];
} else if (ce_StringIsEqual(argv[i], "-debugflag")) {
debugFlag = argv[++i];
} else if (ce_StringIsEqual(argv[i], "-timesteps")) {
timesteps = ce_StringIsEqual(argv[++i], "on");
}
}
/**
* enable logfile or message callback
*/
if (logfile) {
ok = ce_MessageOpenLogfile(logfile, ce_False, ce_True, ce_True);
if (!ok) {
fprintf(stderr, "Problem %s\n", ce_ErrorGet());
exit(1);
}
ce_MessageSetStoreMessages(zFalse);
} else {
ce_MessageSetCallback(msgCallback, ce_True);
}
/**
* enable progress callback.
*/
ce_ProgressInit(progCallback, 5, 10);
/**
* enable debug flags
*/
if (debugFlag) {
ce_MessageEnableDebug(debugFlag);
}
/**
* Begin Progress.
*/
ce_ProgressBegin();
/**
* Enable timesteps.
*/
if (timesteps) {
ce_ProgressEnableTimestep(ce_True);
}
/**
* Open the database.
*/
ce_ProgressPush("Open", 0.75, ce_False);
db = zOpenDataBase(inBinfile);
if (!db) {
ce_MessagePrint(CE_MESSAGE_TYPE_ERROR, "Problem %s", ce_ErrorGet());
goto end;
}
ce_ProgressPop(zFalse, zFalse);
/**
* Example for validating the database
*/
if (!zValidateDB(db, USE_BUILTIN_DEFAULT_FLAGS)) {
ce_MessagePrint(CE_MESSAGE_TYPE_ERROR, "Problem %s", ce_ErrorGet());
goto end;
}
/**
* Close the database.
*/
ce_ProgressPush("Close", 1.0, ce_False);
if (!zCloseDataBase(db)) {
ce_MessagePrint(CE_MESSAGE_TYPE_ERROR, "Problem %s", ce_ErrorGet());
goto end;
}
ce_ProgressPop(zFalse, zFalse);
/**
* End Progress.
*/
ce_ProgressEnd();
/**
* Close Message system.
*/
end:
ce_MessageFinit();
return 0;
}
|