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
|
/*
This file is part of Poti
Poti is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Poti is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser Public License for more details.
You should have received a copy of the GNU Lesser Public License
along with Poti. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __POTI_H
#define __POTI_H
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <stdbool.h>
#if defined(__cplusplus)
extern "C" {
#endif
typedef enum {
PAJE_DefineContainerType,
PAJE_DefineVariableType,
PAJE_DefineStateType,
PAJE_DefineEventType,
PAJE_DefineLinkType,
PAJE_DefineEntityValue,
PAJE_CreateContainer,
PAJE_DestroyContainer,
PAJE_SetVariable,
PAJE_AddVariable,
PAJE_SubVariable,
PAJE_SetState,
PAJE_PushState,
PAJE_PopState,
PAJE_ResetState,
PAJE_StartLink,
PAJE_EndLink,
PAJE_NewEvent,
PAJE_FinalMarker //add new events above if necessary
} e_event_type;
/*
* Default initialization function
*/
bool poti_init (void);
/*
* Default initialization function with filename
*/
bool poti_init_filename (const char *filename);
/*
* Customized initialization function
*/
bool poti_init_custom (const char *filename, bool basic_events, bool legacy_header, bool no_comments, bool with_alias, bool relative_timestamps);
/*
* Function to close opened file
*/
void poti_close (void);
/*
* Function to generate the header
*/
void poti_header (void);
/*
* Function to create a one-line comment
*/
void poti_comment (const char *format, ...);
/*
* poti_header_event: defines a new event, see examples/eventdef.c for details
*/
int poti_header_DeclareEvent (int type, int num_extras, ...);
/*
* Main API: functions to define the type hierarchy and raise events
*/
void poti_DefineContainerType (const char *alias, const char *containerType, const char *name);
void poti_DefineVariableType (const char *alias, const char *containerType, const char *name, const char *color);
void poti_DefineStateType (const char *alias, const char *containerType, const char *name);
void poti_DefineEventType (const char *alias, const char *containerType, const char *name);
void poti_DefineLinkType (const char *alias, const char *containerType, const char *startContainerType, const char *endContainerType, const char *name);
void poti_DefineEntityValue (const char *alias, const char *entityType, const char *name, const char *color);
void poti_CreateContainer (double timestamp, const char *alias, const char *type, const char *container, const char *name);
void poti_DestroyContainer (double timestamp, const char *type, const char *container);
void poti_SetVariable (double timestamp, const char *container, const char *type, double value);
void poti_AddVariable (double timestamp, const char *container, const char *type, double value);
void poti_SubVariable (double timestamp, const char *container, const char *type, double value);
void poti_SetState (double timestamp, const char *container, const char *type, const char *value);
void poti_PushState (double timestamp, const char *container, const char *type, const char *value);
void poti_PopState (double timestamp, const char *container, const char *type);
void poti_ResetState (double timestamp, const char *container, const char *type);
void poti_StartLink (double timestamp, const char *container, const char *type, const char *sourceContainer, const char *value, const char *key);
void poti_EndLink (double timestamp, const char *container, const char *type, const char *endContainer, const char *value, const char *key);
void poti_NewEvent (double timestamp, const char *container, const char *type, const char *value);
/*
* Main API with unique identifiers exposed and optional extra fields: functions to define the type hierarchy and raise events
*/
void poti_user_DefineContainerType (const int unique, const char *alias, const char *containerType, const char *name, int extra, ...);
void poti_user_DefineVariableType (const int unique, const char *alias, const char *containerType, const char *name, const char *color, int extra, ...);
void poti_user_DefineStateType (const int unique, const char *alias, const char *containerType, const char *name, int extra, ...);
void poti_user_DefineEventType (const int unique, const char *alias, const char *containerType, const char *name, int extra, ...);
void poti_user_DefineLinkType (const int unique, const char *alias, const char *containerType, const char *startContainerType, const char *endContainerType, const char *name, int extra, ...);
void poti_user_DefineEntityValue (const int unique, const char *alias, const char *entityType, const char *name, const char *color, int extra, ...);
void poti_user_CreateContainer (const int unique, double timestamp, const char *alias, const char *type, const char *container, const char *name, int extra, ...);
void poti_user_DestroyContainer (const int unique, double timestamp, const char *type, const char *container, int extra, ...);
void poti_user_SetVariable (const int unique, double timestamp, const char *container, const char *type, double value, int extra, ...);
void poti_user_AddVariable (const int unique, double timestamp, const char *container, const char *type, double value, int extra, ...);
void poti_user_SubVariable (const int unique, double timestamp, const char *container, const char *type, double value, int extra, ...);
void poti_user_SetState (const int unique, double timestamp, const char *container, const char *type, const char *value, int extra, ...);
void poti_user_PushState (const int unique, double timestamp, const char *container, const char *type, const char *value, int extra, ...);
void poti_user_PopState (const int unique, double timestamp, const char *container, const char *type, int extra, ...);
void poti_user_ResetState (const int unique, double timestamp, const char *container, const char *type, int extra, ...);
void poti_user_StartLink (const int unique, double timestamp, const char *container, const char *type, const char *sourceContainer, const char *value, const char *key, int extra, ...);
void poti_user_EndLink (const int unique, double timestamp, const char *container, const char *type, const char *endContainer, const char *value, const char *key, int extra, ...);
void poti_user_NewEvent (const int unique, double timestamp, const char *container, const char *type, const char *value, int extra, ...);
/*
* Unalised API: without alias parameters
*/
void poti_DContainerType (const char *containerType, const char *name);
void poti_DVariableType (const char *containerType, const char *name, const char *color);
void poti_DStateType (const char *containerType, const char *name);
void poti_DEventType (const char *containerType, const char *name);
void poti_DLinkType (const char *containerType, const char *startContainerType, const char *endContainerType, const char *name);
void poti_DEntityValue (const char *entityType, const char *name, const char *color);
void poti_ECreateContainer (double timestamp, const char *type, const char *container, const char *name);
void poti_EDestroyContainer (double timestamp, const char *type, const char *container);
void poti_ESetVariable (double timestamp, const char *container, const char *type, double value);
void poti_EAddVariable (double timestamp, const char *container, const char *type, double value);
void poti_ESubVariable (double timestamp, const char *container, const char *type, double value);
void poti_ESetState (double timestamp, const char *container, const char *type, const char *value);
void poti_EPushState (double timestamp, const char *container, const char *type, const char *value);
void poti_EPopState (double timestamp, const char *container, const char *type);
void poti_EResetState (double timestamp, const char *container, const char *type);
void poti_EStartLink (double timestamp, const char *container, const char *type, const char *sourceContainer, const char *value, const char *key);
void poti_EEndLink (double timestamp, const char *container, const char *type, const char *endContainer, const char *value, const char *key);
#if defined(__cplusplus)
}
#endif
#endif
|
