forked from epics-extensions/StripTool
-
Notifications
You must be signed in to change notification settings - Fork 0
/
StripConfig.h
481 lines (401 loc) · 15.2 KB
/
StripConfig.h
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
/*************************************************************************\
* Copyright (c) 1994-2004 The University of Chicago, as Operator of Argonne
* National Laboratory.
* Copyright (c) 1997-2003 Southeastern Universities Research Association,
* as Operator of Thomas Jefferson National Accelerator Facility.
* Copyright (c) 1997-2002 Deutches Elektronen-Synchrotron in der Helmholtz-
* Gemelnschaft (DESY).
* This file is distributed subject to a Software License Agreement found
* in the file LICENSE that is included with this distribution.
\*************************************************************************/
#ifndef _StripConfig
#define _StripConfig
#ifndef NO_X11_HERE /* Albert */
#include <X11/Xlib.h>
#include <X11/Intrinsic.h>
#endif /* Albert */
#include <stdio.h>
#include <stdarg.h>
#include <limits.h>
#ifndef NO_X11_HERE /* Albert */
#include <float.h>
#endif /* Albert */
#ifdef WIN32
/* WIN32 does not have unistd.h */
#else
# include <unistd.h>
#endif
#include "StripDefines.h"
#include "StripMisc.h"
#ifndef NO_X11_HERE /* Albert */
#include "cColorManager.h"
#endif /* Albert */
extern char *untitled_;
typedef enum _StripScaleType
{
STRIPSCALE_LINEAR = 0,
STRIPSCALE_LOG_10,
STRIPSCALE_NUM_TYPES
}
StripScaleType;
typedef enum _StripGridVisibility
{
STRIPGRID_NONE = 0,
STRIPGRID_SOME,
STRIPGRID_ALL,
STRIPGRID_NUM_TYPES
}
StripGridVisibility;
/* ======= Default Values ======= */
#define STRIPDEF_TITLE untitled_
#define STRIPDEF_TIME_TIMESPAN STRIP_DEFAULT_TIMESPAN
#define STRIPDEF_TIME_NUM_SAMPLES 7200
#define STRIPDEF_TIME_SAMPLE_INTERVAL 1
#define STRIPDEF_TIME_REFRESH_INTERVAL 1
#define STRIPDEF_COLOR_BACKGROUND_STR "White"
#define STRIPDEF_COLOR_FOREGROUND_STR "Black"
#define STRIPDEF_COLOR_GRID_STR "Grey75"
#define STRIPDEF_COLOR_COLOR1_STR "Blue"
#define STRIPDEF_COLOR_COLOR2_STR "OliveDrab"
#define STRIPDEF_COLOR_COLOR3_STR "Brown"
#define STRIPDEF_COLOR_COLOR4_STR "CadetBlue"
#define STRIPDEF_COLOR_COLOR5_STR "Orange"
#define STRIPDEF_COLOR_COLOR6_STR "Purple"
#define STRIPDEF_COLOR_COLOR7_STR "Red"
#define STRIPDEF_COLOR_COLOR8_STR "Gold"
#define STRIPDEF_COLOR_COLOR9_STR "RosyBrown"
#define STRIPDEF_COLOR_COLOR10_STR "YellowGreen"
#define STRIPDEF_OPTION_GRID_XON 1
#define STRIPDEF_OPTION_GRID_YON 1
#define STRIPDEF_OPTION_AXIS_YCOLORSTAT 1
#define STRIPDEF_OPTION_GRAPH_LINEWIDTH 2
#define STRIPDEF_CURVE_NAME "Curve"
#define STRIPDEF_CURVE_EGU "Undefined"
#define STRIPDEF_CURVE_COMMENT ""
#define STRIPDEF_CURVE_PRECISION 4
#define STRIPDEF_CURVE_MIN 1e-7
#define STRIPDEF_CURVE_MAX 1e+7
#define STRIPDEF_CURVE_SCALE STRIPSCALE_LINEAR
#define STRIPDEF_CURVE_PLOTSTAT STRIPCURVE_PLOTTED
#define STRIPDEF_CURVE_ID NULL
/* ====== Min/Max values for all attributes requiring range checking ====== */
#define STRIPMIN_TIME_TIMESPAN 1
#define STRIPMAX_TIME_TIMESPAN UINT_MAX
#define STRIPMIN_TIME_NUM_SAMPLES 7200
#define STRIPMAX_TIME_NUM_SAMPLES 65536
#define STRIPMIN_TIME_SAMPLE_INTERVAL 0.01
#define STRIPMAX_TIME_SAMPLE_INTERVAL DBL_MAX
#define STRIPMIN_TIME_REFRESH_INTERVAL 0.1
#define STRIPMAX_TIME_REFRESH_INTERVAL DBL_MAX
#define STRIPMIN_OPTION_GRID_XON STRIPGRID_NONE
#define STRIPMAX_OPTION_GRID_XON STRIPGRID_ALL
#define STRIPMIN_OPTION_GRID_YON STRIPGRID_NONE
#define STRIPMAX_OPTION_GRID_YON STRIPGRID_ALL
#define STRIPMIN_OPTION_GRAPH_LINEWIDTH 0
#define STRIPMAX_OPTION_GRAPH_LINEWIDTH 10
#define STRIPMIN_CURVE_PRECISION 0
#define STRIPMAX_CURVE_PRECISION 20
#define STRIPCONFIG_NUMCOLORS (STRIP_MAX_CURVES + 3)
#define STRIPCONFIG_MAX_CALLBACKS 10
typedef int StripConfigMaskElement;
typedef int StripConfigAttribute;
typedef enum _StripConfigAttributeEnum
{
STRIPCONFIG_TITLE = 1, /* (char *) rw */
STRIPCONFIG_FILENAME, /* (char *) rw */
STRIPCONFIG_TIME_TIMESPAN, /* (unsigned) rw */
STRIPCONFIG_TIME_NUM_SAMPLES, /* (int) rw */
STRIPCONFIG_TIME_SAMPLE_INTERVAL, /* (double) rw */
STRIPCONFIG_TIME_REFRESH_INTERVAL, /* (double) rw */
STRIPCONFIG_COLOR_BACKGROUND, /* (cColor *) r */
STRIPCONFIG_COLOR_FOREGROUND, /* (cColor *) r */
STRIPCONFIG_COLOR_GRID, /* (cColor *) r */
STRIPCONFIG_COLOR_COLOR1, /* (cColor *) r */
STRIPCONFIG_COLOR_COLOR2, /* (cColor *) r */
STRIPCONFIG_COLOR_COLOR3, /* (cColor *) r */
STRIPCONFIG_COLOR_COLOR4, /* (cColor *) r */
STRIPCONFIG_COLOR_COLOR5, /* (cColor *) r */
STRIPCONFIG_COLOR_COLOR6, /* (cColor *) r */
STRIPCONFIG_COLOR_COLOR7, /* (cColor *) r */
STRIPCONFIG_COLOR_COLOR8, /* (cColor *) r */
STRIPCONFIG_COLOR_COLOR9, /* (cColor *) r */
STRIPCONFIG_COLOR_COLOR10, /* (cColor *) r */
STRIPCONFIG_OPTION_GRID_XON, /* (int) rw */
STRIPCONFIG_OPTION_GRID_YON, /* (int) rw */
STRIPCONFIG_OPTION_AXIS_YCOLORSTAT, /* (int) rw */
STRIPCONFIG_OPTION_GRAPH_LINEWIDTH, /* (int) rw */
STRIPCONFIG_TERMINATOR
}
StripConfigAttributeEnum;
#define STRIPCONFIG_FIRST_ATTRIBUTE 1
#define STRIPCONFIG_LAST_ATTRIBUTE (STRIPCONFIG_TERMINATOR-1)
#define STRIPCONFIG_NUM_ATTRIBUTE \
(STRIPCONFIG_LAST_ATTRIBUTE - STRIPCONFIG_FIRST_ATTRIBUTE + 1)
/* StripConfigMaskElement
*
* Individual elements which can be set or unset in a StripConfigMask
* data structure. There is a one-to-one correspondance between
* StripConfigAttribute values and the related StripConfigMaskElement
* values.
*/
typedef enum _StripConfigMaskElementEnum
{
SCFGMASK_TITLE = STRIPCONFIG_TITLE,
SCFGMASK_FILENAME = STRIPCONFIG_FILENAME,
/* time */
SCFGMASK_TIME_TIMESPAN = STRIPCONFIG_TIME_TIMESPAN,
SCFGMASK_TIME_NUM_SAMPLES = STRIPCONFIG_TIME_NUM_SAMPLES,
SCFGMASK_TIME_SAMPLE_INTERVAL = STRIPCONFIG_TIME_SAMPLE_INTERVAL,
SCFGMASK_TIME_REFRESH_INTERVAL = STRIPCONFIG_TIME_REFRESH_INTERVAL,
/* color */
SCFGMASK_COLOR_BACKGROUND = STRIPCONFIG_COLOR_BACKGROUND,
SCFGMASK_COLOR_FOREGROUND = STRIPCONFIG_COLOR_FOREGROUND,
SCFGMASK_COLOR_GRID = STRIPCONFIG_COLOR_GRID,
SCFGMASK_COLOR_COLOR1 = STRIPCONFIG_COLOR_COLOR1,
SCFGMASK_COLOR_COLOR2 = STRIPCONFIG_COLOR_COLOR2,
SCFGMASK_COLOR_COLOR3 = STRIPCONFIG_COLOR_COLOR3,
SCFGMASK_COLOR_COLOR4 = STRIPCONFIG_COLOR_COLOR4,
SCFGMASK_COLOR_COLOR5 = STRIPCONFIG_COLOR_COLOR5,
SCFGMASK_COLOR_COLOR6 = STRIPCONFIG_COLOR_COLOR6,
SCFGMASK_COLOR_COLOR7 = STRIPCONFIG_COLOR_COLOR7,
SCFGMASK_COLOR_COLOR8 = STRIPCONFIG_COLOR_COLOR8,
SCFGMASK_COLOR_COLOR9 = STRIPCONFIG_COLOR_COLOR9,
SCFGMASK_COLOR_COLOR10 = STRIPCONFIG_COLOR_COLOR10,
/* options */
SCFGMASK_OPTION_GRID_XON = STRIPCONFIG_OPTION_GRID_XON,
SCFGMASK_OPTION_GRID_YON = STRIPCONFIG_OPTION_GRID_YON,
SCFGMASK_OPTION_AXIS_YCOLORSTAT = STRIPCONFIG_OPTION_AXIS_YCOLORSTAT,
SCFGMASK_OPTION_GRAPH_LINEWIDTH = STRIPCONFIG_OPTION_GRAPH_LINEWIDTH,
/* curves */
SCFGMASK_CURVE_NAME,
SCFGMASK_CURVE_EGU,
SCFGMASK_CURVE_COMMENT,
SCFGMASK_CURVE_PRECISION,
SCFGMASK_CURVE_MIN,
SCFGMASK_CURVE_MAX,
SCFGMASK_CURVE_SCALE,
SCFGMASK_CURVE_PLOTSTAT,
SCFGMASK_TERMINATOR
}
StripConfigMaskElementEnum;
#define SCFGMASK_FIRST_ELEMENT 1
#define SCFGMASK_LAST_ELEMENT (SCFGMASK_TERMINATOR-1)
#define SCFGMASK_NUM_ELEMENTS \
(SCFGMASK_LAST_ELEMENT - SCFGMASK_FIRST_ELEMENT + 1)
/* StripConfigMask
*
* Structure containing info bits. Must be accessed through
* utility functions.
*/
#define STRIPCFGMASK_NBYTES \
((SCFGMASK_NUM_ELEMENTS + CHAR_BIT) / CHAR_BIT)
typedef struct _StripConfigMask
{
char bytes[STRIPCFGMASK_NBYTES];
}
StripConfigMask;
/* StripConfigMask_clear
*
* Zeroes out all bits.
*/
void StripConfigMask_clear (StripConfigMask *);
/* StripConfigMask_set
*
* Sets the specified bit high.
*/
#define StripConfigMask_set(pmask, elem) \
((pmask)->bytes[((elem)-SCFGMASK_FIRST_ELEMENT)/CHAR_BIT] |= \
(1 << (((elem)-SCFGMASK_FIRST_ELEMENT)%CHAR_BIT)))
/* StripConfigMask_unset
*
* Sets the specified bit low.
*/
#define StripConfigMask_unset(pmask, elem) \
((pmask)->bytes[((elem)-SCFGMASK_FIRST_ELEMENT)/CHAR_BIT] &= \
~(1 << (((elem)-SCFGMASK_FIRST_ELEMENT)%CHAR_BIT)))
/* StripConfigMask_stat
*
* Returns the status of the specified bit.
*/
#define StripConfigMask_stat(pmask, elem) \
((pmask)->bytes[((elem)-SCFGMASK_FIRST_ELEMENT)/CHAR_BIT] & \
(1 << (((elem)-SCFGMASK_FIRST_ELEMENT)%CHAR_BIT)))
/* StripConfigMask_test
*
* Takes two masks, A and B. Returns true if B AND A == B.
*/
int StripConfigMask_test (StripConfigMask *A, StripConfigMask *B);
/* StripConfigMask_and
*
* A = A AND B
*/
void StripConfigMask_and (StripConfigMask *A, StripConfigMask *B);
/* StripConfigMask_or
*
* A = A OR B
*/
void StripConfigMask_or (StripConfigMask *A, StripConfigMask *B);
/* StripConfigMask_xor
*
* A = A XOR B
*/
void StripConfigMask_xor (StripConfigMask *A, StripConfigMask *B);
/* StripConfigMask_intersect
*
* returns {A AND B} != {}
*/
int StripConfigMask_intersect (StripConfigMask *A, StripConfigMask *B);
/* STRIPCFGMASK_XXX
*
* Predefined Masks comprised of related sets of elements.
*/
extern StripConfigMask SCFGMASK_TIME;
extern StripConfigMask SCFGMASK_COLOR;
extern StripConfigMask SCFGMASK_OPTION;
extern StripConfigMask SCFGMASK_CURVE;
extern StripConfigMask SCFGMASK_ALL;
/* ======= Data Types ======= */
typedef void (*StripConfigUpdateFunc) (StripConfigMask, void *);
#ifndef NO_X11_HERE /* Albert */
typedef struct _StripCurveDetail
{
char name[STRIP_MAX_NAME_CHAR+1];
char egu[STRIP_MAX_EGU_CHAR+1];
char comment[STRIP_MAX_COMMENT_CHAR+1];
int precision;
double min, max;
int scale;
int plotstat;
short valid;
cColor *color;
void *id;
StripConfigMask update_mask; /* fields updated since last update */
StripConfigMask set_mask; /* fields without default values */
}
StripCurveDetail;
typedef struct _StripConfig
{
cColorManager scm;
XVisualInfo xvi;
char *title;
char *filename;
FILE *logfile;
#if 0
/* KE: Not used, not available on WIN32 */
struct passwd user;
#endif
struct _Time {
unsigned timespan;
int num_samples;
double sample_interval;
double refresh_interval;
} Time;
struct _Color {
cColor background;
cColor foreground;
cColor grid;
cColor color[STRIP_MAX_CURVES];
} Color;
struct _Option {
int grid_xon;
int grid_yon;
int axis_ycolorstat;
int graph_linewidth;
} Option;
struct _Curves {
StripCurveDetail Detail[STRIP_MAX_CURVES];
int plot_order[STRIP_MAX_CURVES];
} Curves;
struct _UpdateInfo {
StripConfigMask update_mask;
struct _Callbacks {
StripConfigMask call_event;
StripConfigUpdateFunc call_func;
void *call_data;
} Callbacks[STRIPCONFIG_MAX_CALLBACKS];
int callback_count;
} UpdateInfo;
}
StripConfig;
#endif /* Albert */
/*
* StripConfig_preinit
*
* Initializes global constants (SCFGMASK_TIME, etc.)
*/
void StripConfig_preinit (void);
/*
* StripConfig_init
*
* Allocates storage for a StripConfig structure and initializes it
* with default values. Then reads config info from the specified
* stdio stream, if it's not null. See StripConfig_load() below for
* specifics on how the file is read.
*/
#ifndef NO_X11_HERE /* Albert */
StripConfig *StripConfig_init (cColorManager,
XVisualInfo *,
FILE *,
StripConfigMask);
/* StripConfig_clone
*
* Creates and returns a copy of the specified config object.
*/
StripConfig *StripConfig_clone (StripConfig *);
/*
* StripConfig_delete
*
* Deallocates storage for the StripConfig structure.
*/
void StripConfig_delete (StripConfig *);
/*
* StripConfig_set/getattr
*
* Sets/gets the specified attributes, returning true on success.
*/
int StripConfig_setattr (StripConfig *, ...);
int StripConfig_getattr (StripConfig *, ...);
/*
* StripConfig_write
*
* Attempts to write configuration info to the specified stdio stream.
* Writing is begun at the current file pointer. Output format is:
* <ascii-attribute-name><whitespace><ascii-attribute-value><end-of-line>
* for each selected attribute. The mask specifies which attributes to
* write to the file.
*/
int StripConfig_write (StripConfig *, FILE *, StripConfigMask);
/*
* StripConfig_load
*
* Attempts to read configuration info from the specified stdio stream.
* Reading is begun at the current file pointer and continues until an
* end-of-file is encoutered. Any unrecognized lines are ignored.
* The mask specifies which attributes to load from the file.
*/
int StripConfig_load (StripConfig *, FILE *, StripConfigMask);
/*
* StripConfig_addcallback
*
* Causes all update event callbacks which match the mask to be called.
*/
int StripConfig_addcallback (StripConfig *,
StripConfigMask,
StripConfigUpdateFunc, /* callback function */
void *); /* client data */
/*
* StripConfig_update
*
* Causes all pending update event callbacks which match the
* mask to be called.
*/
void StripConfig_update (StripConfig *, StripConfigMask);
/*
* StripConfig_reset_details
*
* Given a StripCurveDetail pointer, intializes all fields
* to defaults.
*/
void StripConfig_reset_details (StripConfig *, StripCurveDetail *);
#endif /* Albert */
#endif