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
/*******************************************************/
/* "C" Language Integrated Production System */
/* */
/* CLIPS Version 6.40 10/18/16 */
/* */
/* ENVIRONMENT MODULE */
/*******************************************************/
/*************************************************************/
/* Purpose: Routines for supporting multiple environments. */
/* */
/* Principal Programmer(s): */
/* Gary D. Riley */
/* */
/* Revision History: */
/* */
/* 6.24: Added code to CreateEnvironment to free */
/* already allocated data if one of the malloc */
/* calls fail. */
/* */
/* Modified AllocateEnvironmentData to print a */
/* message if it was unable to allocate memory. */
/* */
/* Renamed BOOLEAN macro type to intBool. */
/* */
/* Added CreateRuntimeEnvironment function. */
/* */
/* Added support for context information when an */
/* environment is created (i.e a pointer from the */
/* CLIPS environment to its parent environment). */
/* */
/* 6.30: Added support for passing context information */
/* to user defined functions and callback */
/* functions. */
/* */
/* Support for hashing EXTERNAL_ADDRESS_TYPE */
/* data type. */
/* */
/* Added const qualifiers to remove C++ */
/* deprecation warnings. */
/* */
/* Removed deallocating message parameter from */
/* EnvReleaseMem. */
/* */
/* Removed support for BLOCK_MEMORY. */
/* */
/* 6.40: Refactored code to reduce header dependencies */
/* in sysdep.c. */
/* */
/* 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. */
/* */
/* Eval support for run time and bload only. */
/* */
/*************************************************************/
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "setup.h"
#include "bmathfun.h"
#include "commline.h"
#include "emathfun.h"
#include "engine.h"
#include "filecom.h"
#include "iofun.h"
#include "memalloc.h"
#include "miscfun.h"
#include "multifun.h"
#include "parsefun.h"
#include "prccode.h"
#include "prcdrfun.h"
#include "prdctfun.h"
#include "prntutil.h"
#include "proflfun.h"
#include "router.h"
#include "sortfun.h"
#include "strngfun.h"
#include "sysdep.h"
#include "textpro.h"
#include "utility.h"
#include "watch.h"
#if DEFFACTS_CONSTRUCT
#include "dffctdef.h"
#endif
#if DEFRULE_CONSTRUCT
#include "ruledef.h"
#endif
#if DEFGENERIC_CONSTRUCT
#include "genrccom.h"
#endif
#if DEFFUNCTION_CONSTRUCT
#include "dffnxfun.h"
#endif
#if DEFGLOBAL_CONSTRUCT
#include "globldef.h"
#endif
#if DEFTEMPLATE_CONSTRUCT
#include "tmpltdef.h"
#endif
#if OBJECT_SYSTEM
#include "classini.h"
#endif
#if DEVELOPER
#include "developr.h"
#endif
#include "envrnmnt.h"
#define SIZE_ENVIRONMENT_HASH 131
/*******************************************************/
/* AllocateEnvironmentData: Allocates environment data */
/* for the specified environment data record. */
/*******************************************************/
bool AllocateEnvironmentData(
Environment *theEnvironment,
unsigned position,
size_t size,
EnvironmentCleanupFunction *cleanupFunction)
{
/*================================================================*/
/* Check to see if the data position exceeds the maximum allowed. */
/*================================================================*/
if (position >= MAXIMUM_ENVIRONMENT_POSITIONS)
{
printf("\n[ENVRNMNT2] Environment data position %d exceeds the maximum allowed.\n",position);
return false;
}
/*============================================================*/
/* Check if the environment data has already been registered. */
/*============================================================*/
if (theEnvironment->theData[position] != NULL)
{
printf("\n[ENVRNMNT3] Environment data position %d already allocated.\n",position);
return false;
}
/*====================*/
/* Allocate the data. */
/*====================*/
theEnvironment->theData[position] = malloc(size);
if (theEnvironment->theData[position] == NULL)
{
printf("\n[ENVRNMNT4] Environment data position %d could not be allocated.\n",position);
return false;
}
memset(theEnvironment->theData[position],0,size);
/*=============================*/
/* Store the cleanup function. */
/*=============================*/
theEnvironment->cleanupFunctions[position] = cleanupFunction;
/*===============================*/
/* Data successfully registered. */
/*===============================*/
return true;
}
/**********************************************/
/* GetEnvironmentContext: Returns the context */
/* of the specified environment. */
/**********************************************/
void *GetEnvironmentContext(
Environment *theEnvironment)
{
return theEnvironment->context;
}
/*******************************************/
/* SetEnvironmentContext: Sets the context */
/* of the specified environment. */
/*******************************************/
void *SetEnvironmentContext(
Environment *theEnvironment,
void *theContext)
{
void *oldContext;
oldContext = theEnvironment->context;
theEnvironment->context = theContext;
return oldContext;
}
/**************************************************/
/* AddEnvironmentCleanupFunction: Adds a function */
/* to the ListOfCleanupEnvironmentFunctions. */
/**************************************************/
bool AddEnvironmentCleanupFunction(
Environment *theEnv,
const char *name,
EnvironmentCleanupFunction *functionPtr,
int priority)
{
struct environmentCleanupFunction *newPtr, *currentPtr, *lastPtr = NULL;
newPtr = (struct environmentCleanupFunction *) malloc(sizeof(struct environmentCleanupFunction));
if (newPtr == NULL)
{ return false; }
newPtr->name = name;
newPtr->func = functionPtr;
newPtr->priority = priority;
if (theEnv->listOfCleanupEnvironmentFunctions == NULL)
{
newPtr->next = NULL;
theEnv->listOfCleanupEnvironmentFunctions = newPtr;
return true;
}
currentPtr = theEnv->listOfCleanupEnvironmentFunctions;
while ((currentPtr != NULL) ? (priority < currentPtr->priority) : false)
{
lastPtr = currentPtr;
currentPtr = currentPtr->next;
}
if (lastPtr == NULL)
{
newPtr->next = theEnv->listOfCleanupEnvironmentFunctions;
theEnv->listOfCleanupEnvironmentFunctions = newPtr;
}
else
{
newPtr->next = currentPtr;
lastPtr->next = newPtr;
}
return true;
}