/
cstrccom.c
1658 lines (1375 loc) · 54.5 KB
/
cstrccom.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 07/01/05 */
/* */
/* CONSTRUCT COMMANDS MODULE */
/*******************************************************/
/*************************************************************/
/* Purpose: Contains generic routines for deleting, pretty */
/* printing, finding, obtaining module information, */
/* obtaining lists of constructs, listing constructs, and */
/* manipulation routines. */
/* */
/* Principal Programmer(s): */
/* Gary D. Riley */
/* Brian L. Dantes */
/* */
/* Contributing Programmer(s): */
/* */
/* Revision History: */
/* 6.23: Modified GetConstructList to remove buffer */
/* overflow problem with large construct/module */
/* names. DR0858 */
/* */
/* Changed name of variable log to logName */
/* because of Unix compiler warnings of shadowed */
/* definitions. */
/* */
/* Correction for FalseSymbol/TrueSymbol. DR0859 */
/* */
/* 6.24: Corrected an error when compiling as a C++ */
/* file. DR0868 */
/* */
/* Renamed BOOLEAN macro type to intBool. */
/* */
/* Added ConstructsDeletable function. */
/* */
/*************************************************************/
#define _CSTRCCOM_SOURCE_
#include <string.h>
#include "setup.h"
#include "constant.h"
#include "envrnmnt.h"
#include "memalloc.h"
#include "moduldef.h"
#include "argacces.h"
#include "multifld.h"
#include "modulutl.h"
#include "router.h"
#include "utility.h"
#include "commline.h"
#include "sysdep.h"
#if BLOAD || BLOAD_ONLY || BLOAD_AND_BSAVE
#include "bload.h"
#endif
#if (! BLOAD_ONLY) && (! RUN_TIME)
#include "cstrcpsr.h"
#endif
#include "cstrccom.h"
/***************************************/
/* LOCAL INTERNAL FUNCTION DEFINITIONS */
/***************************************/
#if DEBUGGING_FUNCTIONS
static void ConstructPrintWatch(void *,char *,struct construct *,void *,
unsigned (*)(void *,void *));
static unsigned ConstructWatchSupport(void *,struct construct *,char *,
char *,EXPRESSION *,intBool,
unsigned,unsigned (*)(void *,void *),
void (*)(void *,unsigned,void *));
#endif
#if (! RUN_TIME)
/************************************/
/* AddConstructToModule: Adds a */
/* construct to the current module. */
/************************************/
globle void AddConstructToModule(
struct constructHeader *theConstruct)
{
if (theConstruct->whichModule->lastItem == NULL)
{ theConstruct->whichModule->firstItem = theConstruct; }
else
{ theConstruct->whichModule->lastItem->next = theConstruct; }
theConstruct->whichModule->lastItem = theConstruct;
theConstruct->next = NULL;
}
#endif /* (! RUN_TIME) */
/****************************************************/
/* DeleteNamedConstruct: Generic driver routine for */
/* deleting a specific construct from a module. */
/****************************************************/
globle intBool DeleteNamedConstruct(
void *theEnv,
char *constructName,
struct construct *constructClass)
{
#if (! BLOAD_ONLY)
void *constructPtr;
/*=============================*/
/* Constructs can't be deleted */
/* while a bload is in effect. */
/*=============================*/
#if BLOAD || BLOAD_ONLY || BLOAD_AND_BSAVE
if (Bloaded(theEnv) == TRUE) return(FALSE);
#endif
/*===============================*/
/* Look for the named construct. */
/*===============================*/
constructPtr = (*constructClass->findFunction)(theEnv,constructName);
/*========================================*/
/* If the construct was found, delete it. */
/*========================================*/
if (constructPtr != NULL)
{ return((*constructClass->deleteFunction)(theEnv,constructPtr)); }
/*========================================*/
/* If the construct wasn't found, but the */
/* special symbol * was used, then delete */
/* all constructs of the specified type. */
/*========================================*/
if (strcmp("*",constructName) == 0)
{
(*constructClass->deleteFunction)(theEnv,NULL);
return(TRUE);
}
/*===============================*/
/* Otherwise, return FALSE to */
/* indicate no deletion occured. */
/*===============================*/
return(FALSE);
#else
#if MAC_MCW || WIN_MCW || MAC_XCD
#pragma unused(theEnv,constructName,constructClass)
#endif
return(FALSE);
#endif
}
/*******************************************/
/* FindNamedConstruct: Generic routine for */
/* searching for a specified construct. */
/*******************************************/
globle void *FindNamedConstruct(
void *theEnv,
char *constructName,
struct construct *constructClass)
{
void *theConstruct;
SYMBOL_HN *findValue;
/*==========================*/
/* Save the current module. */
/*==========================*/
SaveCurrentModule(theEnv);
/*=========================================================*/
/* Extract the construct name. If a module was specified, */
/* then ExtractModuleAndConstructName will set the current */
/* module to the module specified in the name. */
/*=========================================================*/
constructName = ExtractModuleAndConstructName(theEnv,constructName);
/*=================================================*/
/* If a valid construct name couldn't be extracted */
/* or the construct name isn't in the symbol table */
/* (which means the construct doesn't exist), then */
/* return NULL to indicate the specified construct */
/* couldn't be found. */
/*=================================================*/
if ((constructName == NULL) ?
TRUE :
((findValue = (SYMBOL_HN *) FindSymbolHN(theEnv,constructName)) == NULL))
{
RestoreCurrentModule(theEnv);
return(NULL);
}
/*===============================================*/
/* Loop through every construct of the specified */
/* class in the current module checking to see */
/* if the construct's name matches the construct */
/* being sought. If found, restore the current */
/* module and return a pointer to the construct. */
/*===============================================*/
for (theConstruct = (*constructClass->getNextItemFunction)(theEnv,NULL);
theConstruct != NULL;
theConstruct = (*constructClass->getNextItemFunction)(theEnv,theConstruct))
{
if (findValue == (*constructClass->getConstructNameFunction)((struct constructHeader *) theConstruct))
{
RestoreCurrentModule(theEnv);
return (theConstruct);
}
}
/*=============================*/
/* Restore the current module. */
/*=============================*/
RestoreCurrentModule(theEnv);
/*====================================*/
/* Return NULL to indicated the named */
/* construct was not found. */
/*====================================*/
return(NULL);
}
/*****************************************/
/* UndefconstructCommand: Driver routine */
/* for the undef<construct> commands. */
/*****************************************/
globle void UndefconstructCommand(
void *theEnv,
char *command,
struct construct *constructClass)
{
char *constructName;
char buffer[80];
/*==============================================*/
/* Get the name of the construct to be deleted. */
/*==============================================*/
gensprintf(buffer,"%s name",constructClass->constructName);
constructName = GetConstructName(theEnv,command,buffer);
if (constructName == NULL) return;
#if (! RUN_TIME) && (! BLOAD_ONLY)
/*=============================================*/
/* Check to see if the named construct exists. */
/*=============================================*/
if (((*constructClass->findFunction)(theEnv,constructName) == NULL) &&
(strcmp("*",constructName) != 0))
{
CantFindItemErrorMessage(theEnv,constructClass->constructName,constructName);
return;
}
/*===============================================*/
/* If the construct does exist, try deleting it. */
/*===============================================*/
else if (DeleteNamedConstruct(theEnv,constructName,constructClass) == FALSE)
{
CantDeleteItemErrorMessage(theEnv,constructClass->constructName,constructName);
return;
}
return;
#else
/*=====================================*/
/* Constructs can't be deleted in a */
/* run-time or bload only environment. */
/*=====================================*/
CantDeleteItemErrorMessage(theEnv,constructClass->constructName,constructName);
return;
#endif
}
/******************************************/
/* PPConstructCommand: Driver routine for */
/* the ppdef<construct> commands. */
/******************************************/
globle void PPConstructCommand(
void *theEnv,
char *command,
struct construct *constructClass)
{
char *constructName;
char buffer[80];
/*===============================*/
/* Get the name of the construct */
/* to be "pretty printed." */
/*===============================*/
gensprintf(buffer,"%s name",constructClass->constructName);
constructName = GetConstructName(theEnv,command,buffer);
if (constructName == NULL) return;
/*================================*/
/* Call the driver routine for */
/* pretty printing the construct. */
/*================================*/
if (PPConstruct(theEnv,constructName,WDISPLAY,constructClass) == FALSE)
{ CantFindItemErrorMessage(theEnv,constructClass->constructName,constructName); }
}
/***********************************/
/* PPConstruct: Driver routine for */
/* pretty printing a construct. */
/***********************************/
globle int PPConstruct(
void *theEnv,
char *constructName,
char *logicalName,
struct construct *constructClass)
{
void *constructPtr;
/*==================================*/
/* Use the construct's name to find */
/* a pointer to actual construct. */
/*==================================*/
constructPtr = (*constructClass->findFunction)(theEnv,constructName);
if (constructPtr == NULL) return(FALSE);
/*==============================================*/
/* If the pretty print form is NULL (because of */
/* conserve-mem), return TRUE (which indicates */
/* the construct was found). */
/*==============================================*/
if ((*constructClass->getPPFormFunction)(theEnv,(struct constructHeader *) constructPtr) == NULL)
{ return(TRUE); }
/*============================================*/
/* Print the pretty print string in smaller */
/* chunks. (VMS had a bug that didn't allow */
/* printing a string greater than 512 bytes.) */
/*============================================*/
PrintInChunks(theEnv,logicalName,(*constructClass->getPPFormFunction)(theEnv,(struct constructHeader *) constructPtr));
/*=======================================*/
/* Return TRUE to indicate the construct */
/* was found and pretty printed. */
/*=======================================*/
return(TRUE);
}
/*********************************************/
/* GetConstructModuleCommand: Driver routine */
/* for def<construct>-module routines */
/*********************************************/
globle SYMBOL_HN *GetConstructModuleCommand(
void *theEnv,
char *command,
struct construct *constructClass)
{
char *constructName;
char buffer[80];
struct defmodule *constructModule;
/*=========================================*/
/* Get the name of the construct for which */
/* we want to determine its module. */
/*=========================================*/
gensprintf(buffer,"%s name",constructClass->constructName);
constructName = GetConstructName(theEnv,command,buffer);
if (constructName == NULL) return((SYMBOL_HN *) EnvFalseSymbol(theEnv));
/*==========================================*/
/* Get a pointer to the construct's module. */
/*==========================================*/
constructModule = GetConstructModule(theEnv,constructName,constructClass);
if (constructModule == NULL)
{
CantFindItemErrorMessage(theEnv,constructClass->constructName,constructName);
return((SYMBOL_HN *) EnvFalseSymbol(theEnv));
}
/*============================================*/
/* Return the name of the construct's module. */
/*============================================*/
return(constructModule->name);
}
/******************************************/
/* GetConstructModule: Driver routine for */
/* getting the module for a construct */
/******************************************/
globle struct defmodule *GetConstructModule(
void *theEnv,
char *constructName,
struct construct *constructClass)
{
struct constructHeader *constructPtr;
int count;
unsigned position;
SYMBOL_HN *theName;
/*====================================================*/
/* If the construct name contains a module specifier, */
/* then get a pointer to the defmodule associated */
/* with the specified name. */
/*====================================================*/
if ((position = FindModuleSeparator(constructName)) != FALSE)
{
theName = ExtractModuleName(theEnv,position,constructName);
if (theName != NULL)
{ return((struct defmodule *) EnvFindDefmodule(theEnv,ValueToString(theName))); }
}
/*============================================*/
/* No module was specified, so search for the */
/* named construct in the current module and */
/* modules from which it imports. */
/*============================================*/
constructPtr = (struct constructHeader *)
FindImportedConstruct(theEnv,constructClass->constructName,NULL,constructName,
&count,TRUE,NULL);
if (constructPtr == NULL) return(NULL);
return(constructPtr->whichModule->theModule);
}
/*************************************/
/* Undefconstruct: Generic C routine */
/* for deleting a construct. */
/*************************************/
globle intBool Undefconstruct(
void *theEnv,
void *theConstruct,
struct construct *constructClass)
{
#if BLOAD_ONLY || RUN_TIME
#if MAC_MCW || WIN_MCW || MAC_XCD
#pragma unused(theConstruct)
#pragma unused(constructClass)
#pragma unused(theEnv)
#endif
return(FALSE);
#else
void *currentConstruct,*nextConstruct;
intBool success;
/*================================================*/
/* Delete all constructs of the specified type if */
/* the construct pointer is the NULL pointer. */
/*================================================*/
if (theConstruct == NULL)
{
success = TRUE;
/*===================================================*/
/* Loop through all of the constructs in the module. */
/*===================================================*/
currentConstruct = (*constructClass->getNextItemFunction)(theEnv,NULL);
while (currentConstruct != NULL)
{
/*==============================*/
/* Remember the next construct. */
/*==============================*/
nextConstruct = (*constructClass->getNextItemFunction)(theEnv,currentConstruct);
/*=============================*/
/* Try deleting the construct. */
/*=============================*/
if ((*constructClass->isConstructDeletableFunction)(theEnv,currentConstruct))
{
RemoveConstructFromModule(theEnv,(struct constructHeader *) currentConstruct);
(*constructClass->freeFunction)(theEnv,currentConstruct);
}
else
{
CantDeleteItemErrorMessage(theEnv,constructClass->constructName,
ValueToString((*constructClass->getConstructNameFunction)((struct constructHeader *) currentConstruct)));
success = FALSE;
}
/*================================*/
/* Move on to the next construct. */
/*================================*/
currentConstruct = nextConstruct;
}
/*=======================================*/
/* Perform periodic cleanup if embedded. */
/*=======================================*/
if ((EvaluationData(theEnv)->CurrentEvaluationDepth == 0) && (! CommandLineData(theEnv)->EvaluatingTopLevelCommand) &&
(EvaluationData(theEnv)->CurrentExpression == NULL))
{ PeriodicCleanup(theEnv,TRUE,FALSE); }
/*============================================*/
/* Return TRUE if all constructs successfully */
/* deleted, otherwise FALSE. */
/*============================================*/
return(success);
}
/*==================================================*/
/* Return FALSE if the construct cannot be deleted. */
/*==================================================*/
if ((*constructClass->isConstructDeletableFunction)(theEnv,theConstruct) == FALSE)
{ return(FALSE); }
/*===========================*/
/* Remove the construct from */
/* the list in its module. */
/*===========================*/
RemoveConstructFromModule(theEnv,(struct constructHeader *) theConstruct);
/*=======================*/
/* Delete the construct. */
/*=======================*/
(*constructClass->freeFunction)(theEnv,theConstruct);
/*=======================================*/
/* Perform periodic cleanup if embedded. */
/*=======================================*/
if ((EvaluationData(theEnv)->CurrentEvaluationDepth == 0) && (! CommandLineData(theEnv)->EvaluatingTopLevelCommand) &&
(EvaluationData(theEnv)->CurrentExpression == NULL))
{ PeriodicCleanup(theEnv,TRUE,FALSE); }
/*=============================*/
/* Return TRUE to indicate the */
/* construct was deleted. */
/*=============================*/
return(TRUE);
#endif
}
/***********************************/
/* SaveConstruct: Generic routine */
/* for saving a construct class. */
/***********************************/
globle void SaveConstruct(
void *theEnv,
void *theModule,
char *logicalName,
struct construct *constructClass)
{
char *ppform;
struct constructHeader *theConstruct;
/*==========================*/
/* Save the current module. */
/*==========================*/
SaveCurrentModule(theEnv);
/*===========================*/
/* Set the current module to */
/* the one we're examining. */
/*===========================*/
EnvSetCurrentModule(theEnv,theModule);
/*==============================================*/
/* Loop through each construct of the specified */
/* construct class in the module. */
/*==============================================*/
for (theConstruct = (struct constructHeader *)
(*constructClass->getNextItemFunction)(theEnv,NULL);
theConstruct != NULL;
theConstruct = (struct constructHeader *)
(*constructClass->getNextItemFunction)(theEnv,theConstruct))
{
/*==========================================*/
/* Print the construct's pretty print form. */
/*==========================================*/
ppform = (*constructClass->getPPFormFunction)(theEnv,theConstruct);
if (ppform != NULL)
{
PrintInChunks(theEnv,logicalName,ppform);
EnvPrintRouter(theEnv,logicalName,"\n");
}
}
/*=============================*/
/* Restore the current module. */
/*=============================*/
RestoreCurrentModule(theEnv);
}
/*********************************************************/
/* GetConstructModuleName: Generic routine for returning */
/* the name of the module to which a construct belongs */
/*********************************************************/
globle char *GetConstructModuleName(
struct constructHeader *theConstruct)
{ return(EnvGetDefmoduleName(NULL,(void *) theConstruct->whichModule->theModule)); }
/*********************************************************/
/* GetConstructNameString: Generic routine for returning */
/* the name string of a construct. */
/*********************************************************/
globle char *GetConstructNameString(
struct constructHeader *theConstruct)
{ return(ValueToString(theConstruct->name)); }
/**************************************************/
/* EnvGetConstructNameString: Generic routine for */
/* returning the name string of a construct. */
/**************************************************/
#if WIN_BTC
#pragma argsused
#endif
globle char *EnvGetConstructNameString(
void *theEnv,
struct constructHeader *theConstruct)
{
#if MAC_MCW || WIN_MCW || MAC_XCD
#pragma unused(theEnv)
#endif
return(ValueToString(theConstruct->name));
}
/**********************************************************/
/* GetConstructNamePointer: Generic routine for returning */
/* the name pointer of a construct. */
/**********************************************************/
globle SYMBOL_HN *GetConstructNamePointer(
struct constructHeader *theConstruct)
{ return(theConstruct->name); }
/************************************************/
/* GetConstructListFunction: Generic Routine */
/* for retrieving the constructs in a module. */
/************************************************/
globle void GetConstructListFunction(
void *theEnv,
char *functionName,
DATA_OBJECT_PTR returnValue,
struct construct *constructClass)
{
struct defmodule *theModule;
DATA_OBJECT result;
int numArgs;
/*============================================*/
/* Check for the correct number of arguments. */
/*============================================*/
if ((numArgs = EnvArgCountCheck(theEnv,functionName,NO_MORE_THAN,1)) == -1)
{
EnvSetMultifieldErrorValue(theEnv,returnValue);
return;
}
/*====================================*/
/* If an argument was given, check to */
/* see that it's a valid module name. */
/*====================================*/
if (numArgs == 1)
{
/*======================================*/
/* Only symbols are valid module names. */
/*======================================*/
EnvRtnUnknown(theEnv,1,&result);
if (GetType(result) != SYMBOL)
{
EnvSetMultifieldErrorValue(theEnv,returnValue);
ExpectedTypeError1(theEnv,functionName,1,"defmodule name");
return;
}
/*===========================================*/
/* Verify that the named module exists or is */
/* the symbol * (for obtaining the construct */
/* list for all modules). */
/*===========================================*/
if ((theModule = (struct defmodule *) EnvFindDefmodule(theEnv,DOToString(result))) == NULL)
{
if (strcmp("*",DOToString(result)) != 0)
{
EnvSetMultifieldErrorValue(theEnv,returnValue);
ExpectedTypeError1(theEnv,functionName,1,"defmodule name");
return;
}
theModule = NULL;
}
}
/*=====================================*/
/* Otherwise use the current module to */
/* generate the construct list. */
/*=====================================*/
else
{ theModule = ((struct defmodule *) EnvGetCurrentModule(theEnv)); }
/*=============================*/
/* Call the driver routine to */
/* get the list of constructs. */
/*=============================*/
GetConstructList(theEnv,returnValue,constructClass,theModule);
}
/********************************************/
/* GetConstructList: Generic C Routine for */
/* retrieving the constructs in a module. */
/********************************************/
globle void GetConstructList(
void *theEnv,
DATA_OBJECT_PTR returnValue,
struct construct *constructClass,
struct defmodule *theModule)
{
void *theConstruct;
unsigned long count = 0;
struct multifield *theList;
SYMBOL_HN *theName;
struct defmodule *loopModule;
int allModules = FALSE;
#if WIN_BTC
size_t largestConstructNameSize, bufferSize = 80; /* prevents warning */
#else
size_t largestConstructNameSize = 0, bufferSize = 80; /* prevents warning */
#endif
char *buffer;
/*==========================*/
/* Save the current module. */
/*==========================*/
SaveCurrentModule(theEnv);
/*=======================================*/
/* If the module specified is NULL, then */
/* get all constructs in all modules. */
/*=======================================*/
if (theModule == NULL)
{
theModule = (struct defmodule *) EnvGetNextDefmodule(theEnv,NULL);
allModules = TRUE;
}
/*======================================================*/
/* Count the number of constructs to be retrieved and */
/* determine the buffer size needed to store the */
/* module-name::construct-names that will be generated. */
/*======================================================*/
loopModule = theModule;
while (loopModule != NULL)
{
size_t tempSize;
/*======================================================*/
/* Set the current module to the module being examined. */
/*======================================================*/
EnvSetCurrentModule(theEnv,(void *) loopModule);
/*===========================================*/
/* Loop over every construct in the module. */
/*===========================================*/
theConstruct = NULL;
largestConstructNameSize = 0;
while ((theConstruct = (*constructClass->getNextItemFunction)(theEnv,theConstruct)) != NULL)
{
/*================================*/
/* Increment the construct count. */
/*================================*/
count++;
/*=================================================*/
/* Is this the largest construct name encountered? */
/*=================================================*/
tempSize = strlen(ValueToString((*constructClass->getConstructNameFunction)((struct constructHeader *) theConstruct)));
if (tempSize > largestConstructNameSize)
{ largestConstructNameSize = tempSize; }
}
/*========================================*/
/* Determine the size of the module name. */
/*========================================*/
tempSize = strlen(EnvGetDefmoduleName(theEnv,loopModule));
/*======================================================*/
/* The buffer must be large enough for the module name, */
/* the largest name of all the constructs, and the ::. */
/*======================================================*/
if ((tempSize + largestConstructNameSize + 5) > bufferSize)
{ bufferSize = tempSize + largestConstructNameSize + 5; }
/*=============================*/
/* Move on to the next module. */
/*=============================*/
if (allModules) loopModule = (struct defmodule *) EnvGetNextDefmodule(theEnv,loopModule);
else loopModule = NULL;
}
/*===========================*/
/* Allocate the name buffer. */
/*===========================*/
buffer = (char *) genalloc(theEnv,bufferSize);
/*================================*/
/* Create the multifield value to */
/* store the construct names. */
/*================================*/
SetpType(returnValue,MULTIFIELD);
SetpDOBegin(returnValue,1);
SetpDOEnd(returnValue,(long) count);
theList = (struct multifield *) EnvCreateMultifield(theEnv,count);
SetpValue(returnValue,(void *) theList);
/*===========================*/
/* Store the construct names */
/* in the multifield value. */
/*===========================*/
loopModule = theModule;
count = 1;
while (loopModule != NULL)
{
/*============================*/
/* Set the current module to */
/* the module being examined. */
/*============================*/
EnvSetCurrentModule(theEnv,(void *) loopModule);
/*===============================*/
/* Add each construct name found */
/* in the module to the list. */
/*===============================*/
theConstruct = NULL;
while ((theConstruct = (*constructClass->getNextItemFunction)(theEnv,theConstruct)) != NULL)
{
theName = (*constructClass->getConstructNameFunction)((struct constructHeader *) theConstruct);
SetMFType(theList,count,SYMBOL);
if (allModules)
{
genstrcpy(buffer,EnvGetDefmoduleName(theEnv,loopModule));
genstrcat(buffer,"::");
genstrcat(buffer,ValueToString(theName));
SetMFValue(theList,count,EnvAddSymbol(theEnv,buffer));
}
else
{ SetMFValue(theList,count,EnvAddSymbol(theEnv,ValueToString(theName))); }
count++;
}
/*==================================*/
/* Move on to the next module (if */
/* the list is to contain the names */
/* of constructs from all modules). */
/*==================================*/
if (allModules) loopModule = (struct defmodule *) EnvGetNextDefmodule(theEnv,loopModule);
else loopModule = NULL;
}
/*=========================*/
/* Return the name buffer. */
/*=========================*/
genfree(theEnv,buffer,bufferSize);
/*=============================*/
/* Restore the current module. */
/*=============================*/
RestoreCurrentModule(theEnv);
}
/*********************************************/
/* ListConstructCommand: Generic Routine for */
/* listing the constructs in a module. */
/*********************************************/
globle void ListConstructCommand(
void *theEnv,
char *functionName,
struct construct *constructClass)
{
struct defmodule *theModule;
DATA_OBJECT result;
int numArgs;
/*============================================*/
/* Check for the correct number of arguments. */
/*============================================*/
if ((numArgs = EnvArgCountCheck(theEnv,functionName,NO_MORE_THAN,1)) == -1) return;
/*====================================*/
/* If an argument was given, check to */
/* see that it's a valid module name. */
/*====================================*/
if (numArgs == 1)
{
/*======================================*/
/* Only symbols are valid module names. */
/*======================================*/
EnvRtnUnknown(theEnv,1,&result);
if (GetType(result) != SYMBOL)
{
ExpectedTypeError1(theEnv,functionName,1,"defmodule name");
return;
}
/*===========================================*/
/* Verify that the named module exists or is */
/* the symbol * (for obtaining the construct */
/* list for all modules). */
/*===========================================*/
if ((theModule = (struct defmodule *) EnvFindDefmodule(theEnv,DOToString(result))) == NULL)
{
if (strcmp("*",DOToString(result)) != 0)
{
ExpectedTypeError1(theEnv,functionName,1,"defmodule name");
return;
}
theModule = NULL;
}
}
/*=====================================*/
/* Otherwise use the current module to */
/* generate the construct list. */
/*=====================================*/
else
{ theModule = ((struct defmodule *) EnvGetCurrentModule(theEnv)); }
/*=========================*/
/* Call the driver routine */
/* to list the constructs. */
/*=========================*/
ListConstruct(theEnv,constructClass,WDISPLAY,theModule);
}
/*****************************************/
/* ListConstruct: Generic C Routine for */
/* listing the constructs in a module. */
/*****************************************/