/
argacces.c
1028 lines (882 loc) · 37 KB
/
argacces.c
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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*******************************************************/
/* "C" Language Integrated Production System */
/* */
/* CLIPS Version 6.24 06/05/06 */
/* */
/* ARGUMENT ACCESS MODULE */
/*******************************************************/
/*************************************************************/
/* Purpose: Provides access routines for accessing arguments */
/* passed to user or system functions defined using the */
/* DefineFunction protocol. */
/* */
/* Principal Programmer(s): */
/* Gary D. Riley */
/* */
/* Contributing Programmer(s): */
/* Brian L. Dantes */
/* */
/* Revision History: */
/* */
/* 6.24: Renamed BOOLEAN macro type to intBool. */
/* */
/* Added IllegalLogicalNameMessage function. */
/* */
/*************************************************************/
#define _ARGACCES_SOURCE_
#include "setup.h"
#include <stdio.h>
#define _STDIO_INCLUDED_
#include <string.h>
#include <ctype.h>
#include <stdlib.h>
#include "envrnmnt.h"
#include "extnfunc.h"
#include "router.h"
#include "cstrnchk.h"
#include "insfun.h"
#include "factmngr.h"
#include "prntutil.h"
#include "sysdep.h"
#include "argacces.h"
/***************************************/
/* LOCAL INTERNAL FUNCTION DEFINITIONS */
/***************************************/
static void NonexistantError(void *,char *,char *,int);
static void ExpectedTypeError3(void *,char *,char *,int,char *);
/*******************************************************************/
/* EnvRtnLexeme: Access function to retrieve the nth argument from */
/* a user or system function defined using the DefineFunction */
/* protocol. The argument retrieved must be a symbol, string, or */
/* instance name, otherwise an error is generated. Only the */
/* value of the argument is returned (i.e. the string "a" would */
/* be returned for a, "a", and [a]). */
/*******************************************************************/
globle char *EnvRtnLexeme(
void *theEnv,
int argumentPosition)
{
int count = 1;
DATA_OBJECT result;
struct expr *argPtr;
/*=====================================================*/
/* Find the appropriate argument in the argument list. */
/*=====================================================*/
for (argPtr = EvaluationData(theEnv)->CurrentExpression->argList;
(argPtr != NULL) && (count < argumentPosition);
argPtr = argPtr->nextArg)
{ count++; }
if (argPtr == NULL)
{
NonexistantError(theEnv,"RtnLexeme",
ValueToString(ExpressionFunctionCallName(EvaluationData(theEnv)->CurrentExpression)),
argumentPosition);
SetHaltExecution(theEnv,TRUE);
SetEvaluationError(theEnv,TRUE);
return(NULL);
}
/*============================================*/
/* Return the value of the nth argument if it */
/* is a symbol, string, or instance name. */
/*============================================*/
EvaluateExpression(theEnv,argPtr,&result);
if ((result.type == SYMBOL) ||
#if OBJECT_SYSTEM
(result.type == INSTANCE_NAME) ||
#endif
(result.type == STRING))
{ return(ValueToString(result.value));}
/*======================================================*/
/* Generate an error if the argument is the wrong type. */
/*======================================================*/
ExpectedTypeError3(theEnv,"RtnLexeme",
ValueToString(ExpressionFunctionCallName(EvaluationData(theEnv)->CurrentExpression)),
argumentPosition,"symbol, string, or instance name");
SetHaltExecution(theEnv,TRUE);
SetEvaluationError(theEnv,TRUE);
return(NULL);
}
/*******************************************************************/
/* EnvRtnDouble: Access function to retrieve the nth argument from */
/* a user or system function defined using the DefineFunction */
/* protocol. The argument retrieved must be a either a float or */
/* an integer (type conversion to a float is performed for */
/* integers), otherwise an error is generated. Only the value of */
/* the argument is returned (i.e. the float 3.0 would be */
/* returned for 3.0 and 3). */
/*******************************************************************/
globle double EnvRtnDouble(
void *theEnv,
int argumentPosition)
{
int count = 1;
DATA_OBJECT result;
struct expr *argPtr;
/*=====================================================*/
/* Find the appropriate argument in the argument list. */
/*=====================================================*/
for (argPtr = EvaluationData(theEnv)->CurrentExpression->argList;
(argPtr != NULL) && (count < argumentPosition);
argPtr = argPtr->nextArg)
{ count++; }
if (argPtr == NULL)
{
NonexistantError(theEnv,"RtnDouble",
ValueToString(ExpressionFunctionCallName(EvaluationData(theEnv)->CurrentExpression)),
argumentPosition);
SetHaltExecution(theEnv,TRUE);
SetEvaluationError(theEnv,TRUE);
return(1.0);
}
/*======================================*/
/* Return the value of the nth argument */
/* if it is a float or integer. */
/*======================================*/
EvaluateExpression(theEnv,argPtr,&result);
if (result.type == FLOAT)
{ return(ValueToDouble(result.value)); }
else if (result.type == INTEGER)
{ return((double) ValueToLong(result.value)); }
/*======================================================*/
/* Generate an error if the argument is the wrong type. */
/*======================================================*/
ExpectedTypeError3(theEnv,"RtnDouble",
ValueToString(ExpressionFunctionCallName(EvaluationData(theEnv)->CurrentExpression)),
argumentPosition,"number");
SetHaltExecution(theEnv,TRUE);
SetEvaluationError(theEnv,TRUE);
return(1.0);
}
/*****************************************************************/
/* EnvRtnLong: Access function to retrieve the nth argument from */
/* a user or system function defined using the DefineFunction */
/* protocol. The argument retrieved must be a either a float */
/* or an integer (type conversion to an integer is performed */
/* for floats), otherwise an error is generated. Only the */
/* value of the argument is returned (i.e. the integer 4 */
/* would be returned for 4.3 and 4). */
/*****************************************************************/
globle long long EnvRtnLong(
void *theEnv,
int argumentPosition)
{
int count = 1;
DATA_OBJECT result;
struct expr *argPtr;
/*=====================================================*/
/* Find the appropriate argument in the argument list. */
/*=====================================================*/
for (argPtr = EvaluationData(theEnv)->CurrentExpression->argList;
(argPtr != NULL) && (count < argumentPosition);
argPtr = argPtr->nextArg)
{ count++; }
if (argPtr == NULL)
{
NonexistantError(theEnv,"RtnLong",
ValueToString(ExpressionFunctionCallName(EvaluationData(theEnv)->CurrentExpression)),
argumentPosition);
SetHaltExecution(theEnv,TRUE);
SetEvaluationError(theEnv,TRUE);
return(1L);
}
/*======================================*/
/* Return the value of the nth argument */
/* if it is a float or integer. */
/*======================================*/
EvaluateExpression(theEnv,argPtr,&result);
if (result.type == FLOAT)
{ return((long) ValueToDouble(result.value)); }
else if (result.type == INTEGER)
{ return(ValueToLong(result.value)); }
/*======================================================*/
/* Generate an error if the argument is the wrong type. */
/*======================================================*/
ExpectedTypeError3(theEnv,"RtnLong",
ValueToString(ExpressionFunctionCallName(EvaluationData(theEnv)->CurrentExpression)),
argumentPosition,"number");
SetHaltExecution(theEnv,TRUE);
SetEvaluationError(theEnv,TRUE);
return(1L);
}
/********************************************************************/
/* EnvRtnUnknown: Access function to retrieve the nth argument from */
/* a user or system function defined using the DefineFunction */
/* protocol. The argument retrieved can be of any type. The value */
/* and type of the argument are returned in a DATA_OBJECT */
/* structure provided by the calling function. */
/********************************************************************/
globle DATA_OBJECT_PTR EnvRtnUnknown(
void *theEnv,
int argumentPosition,
DATA_OBJECT_PTR returnValue)
{
int count = 1;
struct expr *argPtr;
/*=====================================================*/
/* Find the appropriate argument in the argument list. */
/*=====================================================*/
for (argPtr = EvaluationData(theEnv)->CurrentExpression->argList;
(argPtr != NULL) && (count < argumentPosition);
argPtr = argPtr->nextArg)
{ count++; }
if (argPtr == NULL)
{
NonexistantError(theEnv,"RtnUnknown",
ValueToString(ExpressionFunctionCallName(EvaluationData(theEnv)->CurrentExpression)),
argumentPosition);
SetHaltExecution(theEnv,TRUE);
SetEvaluationError(theEnv,TRUE);
return(NULL);
}
/*=======================================*/
/* Return the value of the nth argument. */
/*=======================================*/
EvaluateExpression(theEnv,argPtr,returnValue);
return(returnValue);
}
/***********************************************************/
/* EnvRtnArgCount: Returns the length of the argument list */
/* for the function call currently being evaluated. */
/***********************************************************/
globle int EnvRtnArgCount(
void *theEnv)
{
int count = 0;
struct expr *argPtr;
for (argPtr = EvaluationData(theEnv)->CurrentExpression->argList;
argPtr != NULL;
argPtr = argPtr->nextArg)
{ count++; }
return(count);
}
/************************************************************************/
/* EnvArgCountCheck: Given the expected number of arguments, determines */
/* if the function currently being evaluated has the correct number */
/* of arguments. Three types of argument checking are provided by */
/* this function: 1) The function has exactly the expected number of */
/* arguments; 2) The function has at least the expected number of */
/* arguments; 3) The function has at most the expected number of */
/* arguments. The number of arguments is returned if no error occurs, */
/* otherwise -1 is returned. */
/************************************************************************/
globle int EnvArgCountCheck(
void *theEnv,
char *functionName,
int countRelation,
int expectedNumber)
{
int numberOfArguments;
/*==============================================*/
/* Get the number of arguments for the function */
/* currently being evaluated. */
/*==============================================*/
numberOfArguments = EnvRtnArgCount(theEnv);
/*=========================================================*/
/* If the function satisfies expected number of arguments, */
/* constraint, then return the number of arguments found. */
/*=========================================================*/
if (countRelation == EXACTLY)
{ if (numberOfArguments == expectedNumber) return(numberOfArguments); }
else if (countRelation == AT_LEAST)
{ if (numberOfArguments >= expectedNumber) return(numberOfArguments); }
else if (countRelation == NO_MORE_THAN)
{ if (numberOfArguments <= expectedNumber) return(numberOfArguments); }
/*================================================*/
/* The correct number of arguments was not found. */
/* Generate an error message and return -1. */
/*================================================*/
ExpectedCountError(theEnv,functionName,countRelation,expectedNumber);
SetHaltExecution(theEnv,TRUE);
SetEvaluationError(theEnv,TRUE);
return(-1);
}
/****************************************************************/
/* EnvArgRangeCheck: Checks that the number of arguments passed */
/* to a function falls within a specified minimum and maximum */
/* range. The number of arguments passed to the function is */
/* returned if no error occurs, otherwise -1 is returned. */
/****************************************************************/
globle int EnvArgRangeCheck(
void *theEnv,
char *functionName,
int min,
int max)
{
int numberOfArguments;
numberOfArguments = EnvRtnArgCount(theEnv);
if ((numberOfArguments < min) || (numberOfArguments > max))
{
PrintErrorID(theEnv,"ARGACCES",1,FALSE);
EnvPrintRouter(theEnv,WERROR,"Function ");
EnvPrintRouter(theEnv,WERROR,functionName);
EnvPrintRouter(theEnv,WERROR," expected at least ");
PrintLongInteger(theEnv,WERROR,(long) min);
EnvPrintRouter(theEnv,WERROR," and no more than ");
PrintLongInteger(theEnv,WERROR,(long) max);
EnvPrintRouter(theEnv,WERROR," arguments.\n");
SetHaltExecution(theEnv,TRUE);
SetEvaluationError(theEnv,TRUE);
return(-1);
}
return(numberOfArguments);
}
/*************************************************************/
/* EnvArgTypeCheck: Retrieves the nth argument passed to the */
/* function call currently being evaluated and determines */
/* if it matches a specified type. Returns TRUE if the */
/* argument was successfully retrieved and is of the */
/* appropriate type, otherwise returns FALSE. */
/*************************************************************/
globle int EnvArgTypeCheck(
void *theEnv,
char *functionName,
int argumentPosition,
int expectedType,
DATA_OBJECT_PTR returnValue)
{
/*========================*/
/* Retrieve the argument. */
/*========================*/
EnvRtnUnknown(theEnv,argumentPosition,returnValue);
if (EvaluationData(theEnv)->EvaluationError) return(FALSE);
/*========================================*/
/* If the argument's type exactly matches */
/* the expected type, then return TRUE. */
/*========================================*/
if (returnValue->type == expectedType) return (TRUE);
/*=============================================================*/
/* Some expected types encompass more than one primitive type. */
/* If the argument's type matches one of the primitive types */
/* encompassed by the expected type, then return TRUE. */
/*=============================================================*/
if ((expectedType == INTEGER_OR_FLOAT) &&
((returnValue->type == INTEGER) || (returnValue->type == FLOAT)))
{ return(TRUE); }
if ((expectedType == SYMBOL_OR_STRING) &&
((returnValue->type == SYMBOL) || (returnValue->type == STRING)))
{ return(TRUE); }
#if OBJECT_SYSTEM
if (((expectedType == SYMBOL_OR_STRING) || (expectedType == SYMBOL)) &&
(returnValue->type == INSTANCE_NAME))
{ return(TRUE); }
if ((expectedType == INSTANCE_NAME) &&
((returnValue->type == INSTANCE_NAME) || (returnValue->type == SYMBOL)))
{ return(TRUE); }
if ((expectedType == INSTANCE_OR_INSTANCE_NAME) &&
((returnValue->type == INSTANCE_ADDRESS) ||
(returnValue->type == INSTANCE_NAME) ||
(returnValue->type == SYMBOL)))
{ return(TRUE); }
#endif
/*===========================================================*/
/* If the expected type is float and the argument's type is */
/* integer (or vice versa), then convert the argument's type */
/* to match the expected type and then return TRUE. */
/*===========================================================*/
if ((returnValue->type == INTEGER) && (expectedType == FLOAT))
{
returnValue->type = FLOAT;
returnValue->value = (void *) EnvAddDouble(theEnv,(double) ValueToLong(returnValue->value));
return(TRUE);
}
if ((returnValue->type == FLOAT) && (expectedType == INTEGER))
{
returnValue->type = INTEGER;
returnValue->value = (void *) EnvAddLong(theEnv,(long long) ValueToDouble(returnValue->value));
return(TRUE);
}
/*=====================================================*/
/* The argument's type didn't match the expected type. */
/* Print an error message and return FALSE. */
/*=====================================================*/
if (expectedType == FLOAT) ExpectedTypeError1(theEnv,functionName,argumentPosition,"float");
else if (expectedType == INTEGER) ExpectedTypeError1(theEnv,functionName,argumentPosition,"integer");
else if (expectedType == SYMBOL) ExpectedTypeError1(theEnv,functionName,argumentPosition,"symbol");
else if (expectedType == STRING) ExpectedTypeError1(theEnv,functionName,argumentPosition,"string");
else if (expectedType == MULTIFIELD) ExpectedTypeError1(theEnv,functionName,argumentPosition,"multifield");
else if (expectedType == INTEGER_OR_FLOAT) ExpectedTypeError1(theEnv,functionName,argumentPosition,"integer or float");
else if (expectedType == SYMBOL_OR_STRING) ExpectedTypeError1(theEnv,functionName,argumentPosition,"symbol or string");
#if OBJECT_SYSTEM
else if (expectedType == INSTANCE_NAME) ExpectedTypeError1(theEnv,functionName,argumentPosition,"instance name");
else if (expectedType == INSTANCE_ADDRESS) ExpectedTypeError1(theEnv,functionName,argumentPosition,"instance address");
else if (expectedType == INSTANCE_OR_INSTANCE_NAME) ExpectedTypeError1(theEnv,functionName,argumentPosition,"instance address or instance name");
#endif
SetHaltExecution(theEnv,TRUE);
SetEvaluationError(theEnv,TRUE);
return(FALSE);
}
/******************************************************************/
/* GetNumericArgument: Evaluates an expression to yield a numeric */
/* argument. This provides quicker retrieval than using some of */
/* the other argument access routines. The numeric argument is */
/* returned in a DATA_OBJECT supplied by the calling function. */
/* TRUE is returned if a numeric argument was successfully */
/* retrieved, otherwise FALSE is returned. */
/******************************************************************/
globle intBool GetNumericArgument(
void *theEnv,
struct expr *theArgument,
char *functionName,
DATA_OBJECT *result,
intBool convertToFloat,
int whichArgument)
{
unsigned short theType;
void *theValue;
/*==================================================================*/
/* Evaluate the expression (don't bother calling EvaluateExpression */
/* if the type is float or integer). */
/*==================================================================*/
switch(theArgument->type)
{
case FLOAT:
case INTEGER:
theType = theArgument->type;
theValue = theArgument->value;
break;
default:
EvaluateExpression(theEnv,theArgument,result);
theType = result->type;
theValue = result->value;
break;
}
/*==========================================*/
/* If the argument is not float or integer, */
/* print an error message and return FALSE. */
/*==========================================*/
if ((theType != FLOAT) && (theType != INTEGER))
{
ExpectedTypeError1(theEnv,functionName,whichArgument,"integer or float");
SetHaltExecution(theEnv,TRUE);
SetEvaluationError(theEnv,TRUE);
result->type = INTEGER;
result->value = (void *) EnvAddLong(theEnv,0LL);
return(FALSE);
}
/*==========================================================*/
/* If the argument is an integer and the "convert to float" */
/* flag is TRUE, then convert the integer to a float. */
/*==========================================================*/
if ((convertToFloat) && (theType == INTEGER))
{
theType = FLOAT;
theValue = (void *) EnvAddDouble(theEnv,(double) ValueToLong(theValue));
}
/*============================================================*/
/* The numeric argument was successfully retrieved. Store the */
/* argument in the user supplied DATA_OBJECT and return TRUE. */
/*============================================================*/
result->type = theType;
result->value = theValue;
return(TRUE);
}
/*********************************************************************/
/* GetLogicalName: Retrieves the nth argument passed to the function */
/* call currently being evaluated and determines if it is a valid */
/* logical name. If valid, the logical name is returned, otherwise */
/* NULL is returned. */
/*********************************************************************/
globle char *GetLogicalName(
void *theEnv,
int whichArgument,
char *defaultLogicalName)
{
char *logicalName;
DATA_OBJECT result;
EnvRtnUnknown(theEnv,whichArgument,&result);
if ((GetType(result) == SYMBOL) ||
(GetType(result) == STRING) ||
(GetType(result) == INSTANCE_NAME))
{
logicalName = ValueToString(result.value);
if ((strcmp(logicalName,"t") == 0) || (strcmp(logicalName,"T") == 0))
{ logicalName = defaultLogicalName; }
}
else if (GetType(result) == FLOAT)
{
logicalName = ValueToString(EnvAddSymbol(theEnv,FloatToString(theEnv,DOToDouble(result))));
}
else if (GetType(result) == INTEGER)
{
logicalName = ValueToString(EnvAddSymbol(theEnv,LongIntegerToString(theEnv,DOToLong(result))));
}
else
{ logicalName = NULL; }
return(logicalName);
}
/************************************************************/
/* GetFileName: Retrieves the nth argument passed to the */
/* function call currently being evaluated and determines */
/* if it is a valid file name. If valid, the file name is */
/* returned, otherwise NULL is returned. */
/************************************************************/
globle char *GetFileName(
void *theEnv,
char *functionName,
int whichArgument)
{
DATA_OBJECT result;
EnvRtnUnknown(theEnv,whichArgument,&result);
if ((GetType(result) != STRING) && (GetType(result) != SYMBOL))
{
ExpectedTypeError1(theEnv,functionName,whichArgument,"file name");
return(NULL);
}
return(DOToString(result));
}
/******************************************************************/
/* OpenErrorMessage: Generalized error message for opening files. */
/******************************************************************/
globle void OpenErrorMessage(
void *theEnv,
char *functionName,
char *fileName)
{
PrintErrorID(theEnv,"ARGACCES",2,FALSE);
EnvPrintRouter(theEnv,WERROR,"Function ");
EnvPrintRouter(theEnv,WERROR,functionName);
EnvPrintRouter(theEnv,WERROR," was unable to open file ");
EnvPrintRouter(theEnv,WERROR,fileName);
EnvPrintRouter(theEnv,WERROR,".\n");
}
/************************************************************/
/* GetModuleName: Retrieves the nth argument passed to the */
/* function call currently being evaluated and determines */
/* if it is a valid module name. If valid, the module */
/* name is returned or NULL is returned to indicate all */
/* modules. */
/************************************************************/
globle struct defmodule *GetModuleName(
void *theEnv,
char *functionName,
int whichArgument,
int *error)
{
DATA_OBJECT result;
struct defmodule *theModule;
*error = FALSE;
/*========================*/
/* Retrieve the argument. */
/*========================*/
EnvRtnUnknown(theEnv,whichArgument,&result);
/*=================================*/
/* A module name must be a symbol. */
/*=================================*/
if (GetType(result) != SYMBOL)
{
ExpectedTypeError1(theEnv,functionName,whichArgument,"defmodule name");
*error = TRUE;
return(NULL);
}
/*=======================================*/
/* Check to see that the symbol actually */
/* corresponds to a defined module. */
/*=======================================*/
if ((theModule = (struct defmodule *) EnvFindDefmodule(theEnv,DOToString(result))) == NULL)
{
if (strcmp("*",DOToString(result)) != 0)
{
ExpectedTypeError1(theEnv,functionName,whichArgument,"defmodule name");
*error = TRUE;
}
return(NULL);
}
/*=================================*/
/* Return a pointer to the module. */
/*=================================*/
return(theModule);
}
/****************************************************************/
/* GetConstructName: Retrieves the 1st argument passed to the */
/* function call currently being evaluated and determines if */
/* it is a valid name for a construct. Also checks that the */
/* function is only passed a single argument. This routine */
/* is used by functions such as ppdeftemplate, undefrule, */
/* etc... to retrieve the construct name on which to operate. */
/****************************************************************/
globle char *GetConstructName(
void *theEnv,
char *functionName,
char *constructType)
{
DATA_OBJECT result;
if (EnvRtnArgCount(theEnv) != 1)
{
ExpectedCountError(theEnv,functionName,EXACTLY,1);
return(NULL);
}
EnvRtnUnknown(theEnv,1,&result);
if (GetType(result) != SYMBOL)
{
ExpectedTypeError1(theEnv,functionName,1,constructType);
return(NULL);
}
return(DOToString(result));
}
/**************************************************************************/
/* NonexistantError: Prints the error message for a nonexistant argument. */
/**************************************************************************/
static void NonexistantError(
void *theEnv,
char *accessFunction,
char *functionName,
int argumentPosition)
{
PrintErrorID(theEnv,"ARGACCES",3,FALSE);
EnvPrintRouter(theEnv,WERROR,"Function ");
EnvPrintRouter(theEnv,WERROR,accessFunction);
EnvPrintRouter(theEnv,WERROR," received a request from function ");
EnvPrintRouter(theEnv,WERROR,functionName);
EnvPrintRouter(theEnv,WERROR," for argument #");
PrintLongInteger(theEnv,WERROR,(long int) argumentPosition);
EnvPrintRouter(theEnv,WERROR," which is non-existent\n");
}
/*********************************************************/
/* ExpectedCountError: Prints the error message for an */
/* incorrect number of arguments passed to a function. */
/*********************************************************/
globle void ExpectedCountError(
void *theEnv,
char *functionName,
int countRelation,
int expectedNumber)
{
PrintErrorID(theEnv,"ARGACCES",4,FALSE);
EnvPrintRouter(theEnv,WERROR,"Function ");
EnvPrintRouter(theEnv,WERROR,functionName);
if (countRelation == EXACTLY)
{ EnvPrintRouter(theEnv,WERROR," expected exactly "); }
else if (countRelation == AT_LEAST)
{ EnvPrintRouter(theEnv,WERROR," expected at least "); }
else if (countRelation == NO_MORE_THAN)
{ EnvPrintRouter(theEnv,WERROR," expected no more than "); }
else
{ EnvPrintRouter(theEnv,WERROR," generated an illegal argument check for "); }
PrintLongInteger(theEnv,WERROR,(long int) expectedNumber);
EnvPrintRouter(theEnv,WERROR," argument(s)\n");
}
/*************************************************************/
/* NAME : CheckFunctionArgCount */
/* DESCRIPTION : Checks the number of arguments against */
/* the system function restriction list */
/* INPUTS : 1) Name of the calling function */
/* 2) The restriction list can be NULL */
/* 3) The number of arguments */
/* RETURNS : TRUE if OK, FALSE otherwise */
/* SIDE EFFECTS : EvaluationError set on errrors */
/* NOTES : Used to check generic function implicit */
/* method (system function) calls and system */
/* function calls which have the sequence */
/* expansion operator in their argument list */
/*************************************************************/
globle intBool CheckFunctionArgCount(
void *theEnv,
char *functionName,
char *restrictions,
int argumentCount)
{
register int minArguments, maxArguments;
char theChar[2];
theChar[0] = '0';
theChar[1] = EOS;
/*=====================================================*/
/* If there are no restrictions, then there is no need */
/* to check for the correct number of arguments. */
/*=====================================================*/
if (restrictions == NULL) return(TRUE);
/*===========================================*/
/* Determine the minimum number of arguments */
/* required by the function. */
/*===========================================*/
if (isdigit(restrictions[0]))
{
theChar[0] = restrictions[0];
minArguments = atoi(theChar);
}
else
{ minArguments = -1; }
/*===========================================*/
/* Determine the maximum number of arguments */
/* required by the function. */
/*===========================================*/
if (isdigit(restrictions[1]))
{
theChar[0] = restrictions[1];
maxArguments = atoi(theChar);
}
else
{ maxArguments = 10000; }
/*==============================================*/
/* If the function expects exactly N arguments, */
/* then check to see if there are N arguments. */
/*==============================================*/
if (minArguments == maxArguments)
{
if (argumentCount != minArguments)
{
ExpectedCountError(theEnv,functionName,EXACTLY,minArguments);
SetEvaluationError(theEnv,TRUE);
return(FALSE);
}
return(TRUE);
}
/*==================================*/
/* Check to see if there were fewer */
/* arguments passed than expected. */
/*==================================*/
if (argumentCount < minArguments)
{
ExpectedCountError(theEnv,functionName,AT_LEAST,minArguments);
SetEvaluationError(theEnv,TRUE);
return(FALSE);
}
/*=================================*/
/* Check to see if there were more */
/* arguments passed than expected. */
/*=================================*/
if (argumentCount > maxArguments)
{
ExpectedCountError(theEnv,functionName,NO_MORE_THAN,maxArguments);
SetEvaluationError(theEnv,TRUE);
return(FALSE);
}
/*===============================*/
/* The number of arguments falls */
/* within the expected range. */
/*===============================*/
return(TRUE);
}
/*******************************************************************/
/* ExpectedTypeError1: Prints the error message for the wrong type */
/* of argument passed to a user or system defined function. The */
/* expected type is passed as a string to this function. */
/*******************************************************************/
globle void ExpectedTypeError1(
void *theEnv,
char *functionName,
int whichArg,
char *expectedType)
{
PrintErrorID(theEnv,"ARGACCES",5,FALSE);
EnvPrintRouter(theEnv,WERROR,"Function ");
EnvPrintRouter(theEnv,WERROR,functionName);
EnvPrintRouter(theEnv,WERROR," expected argument #");
PrintLongInteger(theEnv,WERROR,(long int) whichArg);
EnvPrintRouter(theEnv,WERROR," to be of type ");
EnvPrintRouter(theEnv,WERROR,expectedType);
EnvPrintRouter(theEnv,WERROR,"\n");
}
/**************************************************************/
/* ExpectedTypeError2: Prints the error message for the wrong */
/* type of argument passed to a user or system defined */
/* function. The expected type is derived by examining the */
/* function's argument restriction list. */
/**************************************************************/
globle void ExpectedTypeError2(
void *theEnv,
char *functionName,
int whichArg)
{
struct FunctionDefinition *theFunction;
char *theType;
theFunction = FindFunction(theEnv,functionName);
if (theFunction == NULL) return;
theType = GetArgumentTypeName(GetNthRestriction(theFunction,whichArg));
ExpectedTypeError1(theEnv,functionName,whichArg,theType);
}
/*******************************************************************/
/* ExpectedTypeError3: Prints the error message for the wrong type */
/* of argument passed to a user or system defined function when */
/* the argument was requested by calling RtnLexeme, RtnLong, or */
/* RtnDouble. */
/*******************************************************************/
static void ExpectedTypeError3(
void *theEnv,
char *accessFunction,
char *functionName,
int argumentPosition,
char *type)
{
PrintErrorID(theEnv,"ARGACCES",6,FALSE);
EnvPrintRouter(theEnv,WERROR,"Function ");
EnvPrintRouter(theEnv,WERROR,accessFunction);
EnvPrintRouter(theEnv,WERROR," received a request from function ");
EnvPrintRouter(theEnv,WERROR,functionName);
EnvPrintRouter(theEnv,WERROR," for argument #");
PrintLongInteger(theEnv,WERROR,(long int) argumentPosition);
EnvPrintRouter(theEnv,WERROR," which is not of type ");
EnvPrintRouter(theEnv,WERROR,type);
EnvPrintRouter(theEnv,WERROR,"\n");
}
/***************************************************/
/* GetFactOrInstanceArgument: Utility routine for */
/* retrieving a fact or instance argument */
/***************************************************/
void *GetFactOrInstanceArgument(
void *theEnv,
int thePosition,
DATA_OBJECT *item,
char *functionName)
{
#if DEFTEMPLATE_CONSTRUCT || OBJECT_SYSTEM
void *ptr;
#endif
/*==============================*/
/* Retrieve the first argument. */
/*==============================*/
EnvRtnUnknown(theEnv,thePosition,item);
/*==================================================*/
/* Fact and instance addresses are valid arguments. */
/*==================================================*/
if ((GetpType(item) == FACT_ADDRESS) ||
(GetpType(item) == INSTANCE_ADDRESS))
{ return(GetpValue(item)); }
/*==================================================*/
/* An integer is a valid argument if it corresponds */
/* to the fact index of an existing fact. */
/*==================================================*/
#if DEFTEMPLATE_CONSTRUCT
else if (GetpType(item) == INTEGER)
{
if ((ptr = (void *) FindIndexedFact(theEnv,DOPToLong(item))) == NULL)
{
char tempBuffer[20];
gensprintf(tempBuffer,"f-%lld",DOPToLong(item));
CantFindItemErrorMessage(theEnv,"fact",tempBuffer);
}
return(ptr);
}
#endif
/*================================================*/
/* Instance names and symbols are valid arguments */
/* if they correspond to an existing instance. */
/*================================================*/
#if OBJECT_SYSTEM
else if ((GetpType(item) == INSTANCE_NAME) || (GetpType(item) == SYMBOL))
{
if ((ptr = (void *) FindInstanceBySymbol(theEnv,(SYMBOL_HN *) GetpValue(item))) == NULL)