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
/*******************************************************/
/* "C" Language Integrated Production System */
/* */
/* CLIPS Version 6.40 08/25/16 */
/* */
/* DEFMODULE HEADER FILE */
/*******************************************************/
/*************************************************************/
/* Purpose: Defines basic defmodule primitive functions such */
/* as allocating and deallocating, traversing, and finding */
/* defmodule data structures. */
/* */
/* Principal Programmer(s): */
/* Gary D. Riley */
/* */
/* Contributing Programmer(s): */
/* Brian L. Dantes */
/* */
/* Revision History: */
/* */
/* 6.23: Correction for FalseSymbol/TrueSymbol. DR0859 */
/* */
/* Corrected compilation errors for files */
/* generated by constructs-to-c. DR0861 */
/* */
/* 6.24: Renamed BOOLEAN macro type to intBool. */
/* */
/* 6.30: Changed integer type/precision. */
/* */
/* Removed conditional code for unsupported */
/* compilers/operating systems (IBM_MCW, */
/* MAC_MCW, and IBM_TBC). */
/* */
/* Added const qualifiers to remove C++ */
/* deprecation warnings. */
/* */
/* Converted API macros to function calls. */
/* */
/* 6.40: Removed LOCALE definition. */
/* */
/* Pragma once and other inclusion changes. */
/* */
/* Added support for booleans with <stdbool.h>. */
/* */
/* Removed use of void pointers for specific */
/* data structures. */
/* */
/* ALLOW_ENVIRONMENT_GLOBALS no longer supported. */
/* */
/* UDF redesign. */
/* */
/*************************************************************/
#ifndef _H_moduldef
#pragma once
#define _H_moduldef
typedef struct defmodule Defmodule;
typedef struct portItem PortItem;
typedef struct defmoduleItemHeader DefmoduleItemHeader;
typedef struct moduleItem ModuleItem;
typedef struct constructHeader ConstructHeader;
typedef struct moduleStackItem ModuleStackItem;
typedef void *AllocateModuleFunction(Environment *);
typedef void FreeModuleFunction(Environment *,void *);
typedef enum
{
DEFMODULE,
DEFRULE,
DEFTEMPLATE,
DEFFACTS,
DEFGLOBAL,
DEFFUNCTION,
DEFGENERIC,
DEFMETHOD,
DEFCLASS,
DEFMESSAGE_HANDLER,
DEFINSTANCES
} ConstructType;
#include <stdio.h>
#include "entities.h"
#include "userdata.h"
#include "utility.h"
struct constructHeader
{
ConstructType constructType;
CLIPSLexeme *name;
const char *ppForm;
DefmoduleItemHeader *whichModule;
unsigned long bsaveID;
ConstructHeader *next;
struct userData *usrData;
Environment *env;
};
struct defmoduleItemHeader
{
Defmodule *theModule;
ConstructHeader *firstItem;
ConstructHeader *lastItem;
};
typedef ConstructHeader *FindConstructFunction(Environment *,const char *);
typedef ConstructHeader *GetNextConstructFunction(Environment *,ConstructHeader *);
typedef bool IsConstructDeletableFunction(ConstructHeader *);
typedef bool DeleteConstructFunction(ConstructHeader *,Environment *);
typedef void FreeConstructFunction(Environment *,ConstructHeader *);
/**********************************************************************/
/* defmodule */
/* ---------- */
/* name: The name of the defmodule (stored as a reference in the */
/* table). */
/* */
/* ppForm: The pretty print representation of the defmodule (used by */
/* the save and ppdefmodule commands). */
/* */
/* itemsArray: An array of pointers to the module specific data used */
/* by each construct specified with the RegisterModuleItem */
/* function. The data pointer stored in the array is allocated by */
/* the allocateFunction in moduleItem data structure. */
/* */
/* importList: The list of items which are being imported by this */
/* module from other modules. */
/* */
/* next: A pointer to the next defmodule data structure. */
/**********************************************************************/
struct defmodule
{
ConstructHeader header;
DefmoduleItemHeader **itemsArray;
PortItem *importList;
PortItem *exportList;
bool visitedFlag;
};
struct portItem
{
CLIPSLexeme *moduleName;
CLIPSLexeme *constructType;
CLIPSLexeme *constructName;
PortItem *next;
};
#define MIHS (DefmoduleItemHeader *)
/**********************************************************************/
/* moduleItem */
/* ---------- */
/* name: The name of the construct which can be placed in a module. */
/* For example, "defrule". */
/* */
/* allocateFunction: Used to allocate a data structure containing all */
/* pertinent information related to a specific construct for a */
/* given module. For example, the deffacts construct stores a */
/* pointer to the first and last deffacts for each each module. */
/* */
/* freeFunction: Used to deallocate a data structure allocated by */
/* the allocateFunction. In addition, the freeFunction deletes */
/* all constructs of the specified type in the given module. */
/* */
/* bloadModuleReference: Used during a binary load to establish a */
/* link between the defmodule data structure and the data structure */
/* containing all pertinent module information for a specific */
/* construct. */
/* */
/* findFunction: Used to determine if a specified construct is in a */
/* specific module. The name is the specific construct is passed as */
/* a string and the function returns a pointer to the specified */
/* construct if it exists. */
/* */
/* exportable: If true, then the specified construct type can be */
/* exported (and hence imported). If false, it can't be exported. */
/* */
/* next: A pointer to the next moduleItem data structure. */
/**********************************************************************/
struct moduleItem
{
const char *name;
unsigned moduleIndex;
void *(*allocateFunction)(Environment *);
void (*freeFunction)(Environment *,void *);
void *(*bloadModuleReference)(Environment *,unsigned long);
void (*constructsToCModuleReference)(Environment *,FILE *,unsigned long,unsigned int,unsigned int);
FindConstructFunction *findFunction;
ModuleItem *next;
};
struct moduleStackItem
{
bool changeFlag;
Defmodule *theModule;
ModuleStackItem *next;
};
#define DEFMODULE_DATA 4
struct defmoduleData
{
struct moduleItem *LastModuleItem;
struct voidCallFunctionItem *AfterModuleChangeFunctions;
ModuleStackItem *ModuleStack;
bool CallModuleChangeFunctions;
Defmodule *ListOfDefmodules;
Defmodule *CurrentModule;
Defmodule *LastDefmodule;
unsigned NumberOfModuleItems;
struct moduleItem *ListOfModuleItems;
long ModuleChangeIndex;
bool MainModuleRedefinable;
#if (! RUN_TIME) && (! BLOAD_ONLY)
struct portConstructItem *ListOfPortConstructItems;
unsigned short NumberOfDefmodules;
struct voidCallFunctionItem *AfterModuleDefinedFunctions;
#endif
#if CONSTRUCT_COMPILER && (! RUN_TIME)
struct CodeGeneratorItem *DefmoduleCodeItem;
#endif
#if (BLOAD || BLOAD_ONLY || BLOAD_AND_BSAVE) && (! RUN_TIME)
unsigned long BNumberOfDefmodules;
unsigned long NumberOfPortItems;
struct portItem *PortItemArray;
Defmodule *DefmoduleArray;
#endif
};
#define DefmoduleData(theEnv) ((struct defmoduleData *) GetEnvironmentData(theEnv,DEFMODULE_DATA))
void InitializeDefmodules(Environment *);
Defmodule *FindDefmodule(Environment *,const char *);
const char *DefmoduleName(Defmodule *);
const char *DefmodulePPForm(Defmodule *);
Defmodule *GetNextDefmodule(Environment *,Defmodule *);
void RemoveAllDefmodules(Environment *,void *);
int AllocateModuleStorage(void);
unsigned RegisterModuleItem(Environment *,const char *,
AllocateModuleFunction *,
FreeModuleFunction *,
void *(*)(Environment *,unsigned long),
void (*)(Environment *,FILE *,unsigned long,unsigned int,unsigned int),
FindConstructFunction *);
void *GetModuleItem(Environment *,Defmodule *,unsigned);
void SetModuleItem(Environment *,Defmodule *,unsigned,void *);
Defmodule *GetCurrentModule(Environment *);
Defmodule *SetCurrentModule(Environment *,Defmodule *);
void GetCurrentModuleCommand(Environment *,UDFContext *,UDFValue *);
void SetCurrentModuleCommand(Environment *,UDFContext *,UDFValue *);
unsigned GetNumberOfModuleItems(Environment *);
void CreateMainModule(Environment *,void *);
void SetListOfDefmodules(Environment *,Defmodule *);
struct moduleItem *GetListOfModuleItems(Environment *);
struct moduleItem *FindModuleItem(Environment *,const char *);
void SaveCurrentModule(Environment *);
void RestoreCurrentModule(Environment *);
void AddAfterModuleChangeFunction(Environment *,const char *,VoidCallFunction *,int,void *);
void IllegalModuleSpecifierMessage(Environment *);
void AllocateDefmoduleGlobals(Environment *);
unsigned short GetNumberOfDefmodules(Environment *);
#endif /* _H_moduldef */