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
|
/*******************************************************/
/* "C" Language Integrated Production System */
/* */
/* CLIPS Version 6.24 06/05/06 */
/* */
/* DEFTEMPLATE MODULE */
/*******************************************************/
/*************************************************************/
/* Purpose: Defines basic deftemplate primitive functions */
/* such as allocating and deallocating, traversing, and */
/* finding deftemplate data structures. */
/* */
/* Principal Programmer(s): */
/* Gary D. Riley */
/* */
/* Contributing Programmer(s): */
/* Brian L. Donnell */
/* */
/* Revision History: */
/* 6.23: Added support for templates maintaining their */
/* own list of facts. */
/* */
/* 6.24: Renamed BOOLEAN macro type to intBool. */
/* */
/* Corrected code to remove run-time program */
/* compiler warnings. */
/* */
/*************************************************************/
#define _TMPLTDEF_SOURCE_
#include "setup.h"
#if DEFTEMPLATE_CONSTRUCT
#include <stdio.h>
#define _STDIO_INCLUDED_
#include "memalloc.h"
#include "exprnops.h"
#include "cstrccom.h"
#include "network.h"
#include "tmpltpsr.h"
#include "tmpltbsc.h"
#include "tmpltutl.h"
#include "tmpltfun.h"
#include "router.h"
#include "modulpsr.h"
#include "modulutl.h"
#include "cstrnchk.h"
#include "envrnmnt.h"
#if BLOAD || BLOAD_ONLY || BLOAD_AND_BSAVE
#include "bload.h"
#include "tmpltbin.h"
#endif
#if CONSTRUCT_COMPILER && (! RUN_TIME)
#include "tmpltcmp.h"
#endif
#include "tmpltdef.h"
/***************************************/
/* LOCAL INTERNAL FUNCTION DEFINITIONS */
/***************************************/
static void *AllocateModule(void *);
static void ReturnModule(void *,void *);
static void ReturnDeftemplate(void *,void *);
static void InitializeDeftemplateModules(void *);
static void DeallocateDeftemplateData(void *);
static void DestroyDeftemplateAction(void *,struct constructHeader *,void *);
static void DestroyDeftemplate(void *,void *);
/******************************************************************/
/* InitializeDeftemplates: Initializes the deftemplate construct. */
/******************************************************************/
globle void InitializeDeftemplates(
void *theEnv)
{
globle struct entityRecord deftemplatePtrRecord = { "DEFTEMPLATE_PTR",
DEFTEMPLATE_PTR,1,0,0,
NULL,
NULL,NULL,
NULL,
NULL,
DecrementDeftemplateBusyCount,
IncrementDeftemplateBusyCount,
NULL,NULL,NULL,NULL };
AllocateEnvironmentData(theEnv,DEFTEMPLATE_DATA,sizeof(struct deftemplateData),DeallocateDeftemplateData);
memcpy(&DeftemplateData(theEnv)->DeftemplatePtrRecord,&deftemplatePtrRecord,sizeof(struct entityRecord));
InitializeFacts(theEnv);
InitializeDeftemplateModules(theEnv);
DeftemplateBasicCommands(theEnv);
DeftemplateFunctions(theEnv);
DeftemplateData(theEnv)->DeftemplateConstruct =
AddConstruct(theEnv,"deftemplate","deftemplates",ParseDeftemplate,EnvFindDeftemplate,
GetConstructNamePointer,GetConstructPPForm,
GetConstructModuleItem,EnvGetNextDeftemplate,SetNextConstruct,
EnvIsDeftemplateDeletable,EnvUndeftemplate,ReturnDeftemplate);
InstallPrimitive(theEnv,(ENTITY_RECORD_PTR) &DeftemplateData(theEnv)->DeftemplatePtrRecord,DEFTEMPLATE_PTR);
}
/******************************************************/
/* DeallocateDeftemplateData: Deallocates environment */
/* data for the deftemplate construct. */
/******************************************************/
static void DeallocateDeftemplateData(
void *theEnv)
{
#if ! RUN_TIME
struct deftemplateModule *theModuleItem;
void *theModule;
#endif
#if BLOAD || BLOAD_AND_BSAVE
if (Bloaded(theEnv)) return;
#endif
DoForAllConstructs(theEnv,DestroyDeftemplateAction,DeftemplateData(theEnv)->DeftemplateModuleIndex,FALSE,NULL);
#if ! RUN_TIME
for (theModule = EnvGetNextDefmodule(theEnv,NULL);
theModule != NULL;
theModule = EnvGetNextDefmodule(theEnv,theModule))
{
theModuleItem = (struct deftemplateModule *)
GetModuleItem(theEnv,(struct defmodule *) theModule,
DeftemplateData(theEnv)->DeftemplateModuleIndex);
rtn_struct(theEnv,deftemplateModule,theModuleItem);
}
#endif
}
/*****************************************************/
/* DestroyDeftemplateAction: Action used to remove */
/* deftemplates as a result of DestroyEnvironment. */
/*****************************************************/
#if IBM_TBC
#pragma argsused
#endif
static void DestroyDeftemplateAction(
void *theEnv,
struct constructHeader *theConstruct,
void *buffer)
{
#if MAC_MCW || IBM_MCW || MAC_XCD
#pragma unused(buffer)
#endif
struct deftemplate *theDeftemplate = (struct deftemplate *) theConstruct;
if (theDeftemplate == NULL) return;
DestroyDeftemplate(theEnv,theDeftemplate);
}
/*************************************************************/
/* InitializeDeftemplateModules: Initializes the deftemplate */
/* construct for use with the defmodule construct. */
/*************************************************************/
static void InitializeDeftemplateModules(
void *theEnv)
{
DeftemplateData(theEnv)->DeftemplateModuleIndex = RegisterModuleItem(theEnv,"deftemplate",
AllocateModule,
ReturnModule,
#if BLOAD_AND_BSAVE || BLOAD || BLOAD_ONLY
BloadDeftemplateModuleReference,
#else
NULL,
#endif
#if CONSTRUCT_COMPILER && (! RUN_TIME)
DeftemplateCModuleReference,
#else
NULL,
#endif
EnvFindDeftemplate);
#if (! BLOAD_ONLY) && (! RUN_TIME) && DEFMODULE_CONSTRUCT
AddPortConstructItem(theEnv,"deftemplate",SYMBOL);
#endif
}
/***************************************************/
/* AllocateModule: Allocates a deftemplate module. */
/***************************************************/
static void *AllocateModule(
void *theEnv)
{
return((void *) get_struct(theEnv,deftemplateModule));
}
/*************************************************/
/* ReturnModule: Deallocates a deftemplate module. */
/*************************************************/
static void ReturnModule(
void *theEnv,
void *theItem)
{
FreeConstructHeaderModule(theEnv,(struct defmoduleItemHeader *) theItem,DeftemplateData(theEnv)->DeftemplateConstruct);
rtn_struct(theEnv,deftemplateModule,theItem);
}
/****************************************************************/
/* GetDeftemplateModuleItem: Returns a pointer to the defmodule */
/* item for the specified deftemplate or defmodule. */
/****************************************************************/
globle struct deftemplateModule *GetDeftemplateModuleItem(
void *theEnv,
struct defmodule *theModule)
{
return((struct deftemplateModule *) GetConstructModuleItemByIndex(theEnv,theModule,DeftemplateData(theEnv)->DeftemplateModuleIndex));
}
/*****************************************************/
/* EnvFindDeftemplate: Searches for a deftemplate in */
/* the list of deftemplates. Returns a pointer to */
/* the deftemplate if found, otherwise NULL. */
/*****************************************************/
globle void *EnvFindDeftemplate(
void *theEnv,
char *deftemplateName)
{
return(FindNamedConstruct(theEnv,deftemplateName,DeftemplateData(theEnv)->DeftemplateConstruct));
}
/***********************************************************************/
/* EnvGetNextDeftemplate: If passed a NULL pointer, returns the first */
/* deftemplate in the ListOfDeftemplates. Otherwise returns the next */
/* deftemplate following the deftemplate passed as an argument. */
/***********************************************************************/
globle void *EnvGetNextDeftemplate(
void *theEnv,
void *deftemplatePtr)
{
return((void *) GetNextConstructItem(theEnv,(struct constructHeader *) deftemplatePtr,DeftemplateData(theEnv)->DeftemplateModuleIndex));
}
/***********************************************************/
/* EnvIsDeftemplateDeletable: Returns TRUE if a particular */
/* deftemplate can be deleted, otherwise returns FALSE. */
/***********************************************************/
globle intBool EnvIsDeftemplateDeletable(
void *theEnv,
void *vTheDeftemplate)
{
struct deftemplate *theDeftemplate = (struct deftemplate *) vTheDeftemplate;
if (! ConstructsDeletable(theEnv))
{ return FALSE; }
if (theDeftemplate->busyCount > 0) return(FALSE);
if (theDeftemplate->patternNetwork != NULL) return(FALSE);
return(TRUE);
}
/**************************************************************/
/* ReturnDeftemplate: Returns the data structures associated */
/* with a deftemplate construct to the pool of free memory. */
/**************************************************************/
static void ReturnDeftemplate(
void *theEnv,
void *vTheConstruct)
{
#if (MAC_MCW || IBM_MCW) && (RUN_TIME || BLOAD_ONLY)
#pragma unused(theEnv,vTheConstruct)
#endif
#if (! BLOAD_ONLY) && (! RUN_TIME)
struct deftemplate *theConstruct = (struct deftemplate *) vTheConstruct;
struct templateSlot *slotPtr;
if (theConstruct == NULL) return;
/*====================================================================*/
/* If a template is redefined, then we want to save its debug status. */
/*====================================================================*/
#if DEBUGGING_FUNCTIONS
DeftemplateData(theEnv)->DeletedTemplateDebugFlags = 0;
if (theConstruct->watch) BitwiseSet(DeftemplateData(theEnv)->DeletedTemplateDebugFlags,0);
#endif
/*===========================================*/
/* Free storage used by the templates slots. */
/*===========================================*/
slotPtr = theConstruct->slotList;
while (slotPtr != NULL)
{
DecrementSymbolCount(theEnv,slotPtr->slotName);
RemoveHashedExpression(theEnv,slotPtr->defaultList);
slotPtr->defaultList = NULL;
RemoveConstraint(theEnv,slotPtr->constraints);
slotPtr->constraints = NULL;
slotPtr = slotPtr->next;
}
ReturnSlots(theEnv,theConstruct->slotList);
/*==================================*/
/* Free storage used by the header. */
/*==================================*/
DeinstallConstructHeader(theEnv,&theConstruct->header);
rtn_struct(theEnv,deftemplate,theConstruct);
#endif
}
/**************************************************************/
/* DestroyDeftemplate: Returns the data structures associated */
/* with a deftemplate construct to the pool of free memory. */
/**************************************************************/
static void DestroyDeftemplate(
void *theEnv,
void *vTheConstruct)
{
#if (MAC_MCW || IBM_MCW) && (RUN_TIME || BLOAD_ONLY)
#pragma unused(vTheConstruct)
#endif
struct deftemplate *theConstruct = (struct deftemplate *) vTheConstruct;
#if (! BLOAD_ONLY) && (! RUN_TIME)
struct templateSlot *slotPtr, *nextSlot;
#endif
if (theConstruct == NULL) return;
#if (! BLOAD_ONLY) && (! RUN_TIME)
slotPtr = theConstruct->slotList;
while (slotPtr != NULL)
{
nextSlot = slotPtr->next;
rtn_struct(theEnv,templateSlot,slotPtr);
slotPtr = nextSlot;
}
#endif
DestroyFactPatternNetwork(theEnv,theConstruct->patternNetwork);
/*==================================*/
/* Free storage used by the header. */
/*==================================*/
#if (! BLOAD_ONLY) && (! RUN_TIME)
DeinstallConstructHeader(theEnv,&theConstruct->header);
rtn_struct(theEnv,deftemplate,theConstruct);
#endif
}
/***********************************************/
/* ReturnSlots: Returns the slot structures of */
/* a deftemplate to free memory. */
/***********************************************/
globle void ReturnSlots(
void *theEnv,
struct templateSlot *slotPtr)
{
#if (MAC_MCW || IBM_MCW) && (RUN_TIME || BLOAD_ONLY)
#pragma unused(theEnv,slotPtr)
#endif
#if (! BLOAD_ONLY) && (! RUN_TIME)
struct templateSlot *nextSlot;
while (slotPtr != NULL)
{
nextSlot = slotPtr->next;
ReturnExpression(theEnv,slotPtr->defaultList);
RemoveConstraint(theEnv,slotPtr->constraints);
rtn_struct(theEnv,templateSlot,slotPtr);
slotPtr = nextSlot;
}
#endif
}
/*************************************************/
/* DecrementDeftemplateBusyCount: Decrements the */
/* busy count of a deftemplate data structure. */
/*************************************************/
globle void DecrementDeftemplateBusyCount(
void *theEnv,
void *vTheTemplate)
{
struct deftemplate *theTemplate = (struct deftemplate *) vTheTemplate;
if (! ConstructData(theEnv)->ClearInProgress) theTemplate->busyCount--;
}
/*************************************************/
/* IncrementDeftemplateBusyCount: Increments the */
/* busy count of a deftemplate data structure. */
/*************************************************/
#if IBM_TBC
#pragma argsused
#endif
globle void IncrementDeftemplateBusyCount(
void *theEnv,
void *vTheTemplate)
{
struct deftemplate *theTemplate = (struct deftemplate *) vTheTemplate;
#if MAC_MCW || IBM_MCW || MAC_XCD
#pragma unused(theEnv)
#endif
theTemplate->busyCount++;
}
/*******************************************************************/
/* EnvGetNextFactInTemplate: If passed a NULL pointer, returns the */
/* first fact in the template's fact-list. Otherwise returns the */
/* next template fact following the fact passed as an argument. */
/*******************************************************************/
#if IBM_TBC
#pragma argsused
#endif
globle void *EnvGetNextFactInTemplate(
void *theEnv,
void *theTemplate,
void *factPtr)
{
#if MAC_MCW || IBM_MCW || MAC_XCD
#pragma unused(theEnv)
#endif
if (factPtr == NULL)
{ return((void *) ((struct deftemplate *) theTemplate)->factList); }
if (((struct fact *) factPtr)->garbage) return(NULL);
return((void *) ((struct fact *) factPtr)->nextTemplateFact);
}
#endif /* DEFTEMPLATE_CONSTRUCT */
|
