-
Notifications
You must be signed in to change notification settings - Fork 0
/
classpsr.c
executable file
·943 lines (860 loc) · 34.4 KB
/
classpsr.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
/*******************************************************/
/* "C" Language Integrated Production System */
/* */
/* CLIPS Version 6.30 01/25/15 */
/* */
/* CLASS PARSER MODULE */
/*******************************************************/
/**************************************************************/
/* Purpose: Parsing Routines for Defclass Construct */
/* */
/* Principal Programmer(s): */
/* Brian L. Dantes */
/* */
/* Contributing Programmer(s): */
/* */
/* Revision History: */
/* */
/* 6.24: Added allowed-classes slot facet. */
/* */
/* Converted INSTANCE_PATTERN_MATCHING to */
/* DEFRULE_CONSTRUCT. */
/* */
/* Renamed BOOLEAN macro type to intBool. */
/* */
/* 6.30: Added support to allow CreateClassScopeMap to */
/* be used by other functions. */
/* */
/* Changed integer type/precision. */
/* */
/* GetConstructNameAndComment API change. */
/* */
/* Added const qualifiers to remove C++ */
/* deprecation warnings. */
/* */
/* Converted API macros to function calls. */
/* */
/* Changed find construct functionality so that */
/* imported modules are search when locating a */
/* named construct. */
/* */
/**************************************************************/
/* =========================================
*****************************************
EXTERNAL DEFINITIONS
=========================================
***************************************** */
#include "setup.h"
#if OBJECT_SYSTEM && (! BLOAD_ONLY) && (! RUN_TIME)
#if BLOAD || BLOAD_AND_BSAVE
#include "bload.h"
#endif
#include "classcom.h"
#include "classfun.h"
#include "clsltpsr.h"
#include "cstrcpsr.h"
#include "envrnmnt.h"
#include "inherpsr.h"
#include "memalloc.h"
#include "modulpsr.h"
#include "modulutl.h"
#include "msgpsr.h"
#include "router.h"
#include "scanner.h"
#define _CLASSPSR_SOURCE_
#include "classpsr.h"
/* =========================================
*****************************************
CONSTANTS
=========================================
***************************************** */
#define ROLE_RLN "role"
#define ABSTRACT_RLN "abstract"
#define CONCRETE_RLN "concrete"
#define HANDLER_DECL "message-handler"
#define SLOT_RLN "slot"
#define SGL_SLOT_RLN "single-slot"
#define MLT_SLOT_RLN "multislot"
#define DIRECT 0
#define INHERIT 1
/* =========================================
*****************************************
INTERNALLY VISIBLE FUNCTION HEADERS
=========================================
***************************************** */
static intBool ValidClassName(void *,const char *,DEFCLASS **);
static intBool ParseSimpleQualifier(void *,const char *,const char *,const char *,const char *,intBool *,intBool *);
static intBool ReadUntilClosingParen(void *,const char *,struct token *);
static void AddClass(void *,DEFCLASS *);
static void BuildSubclassLinks(void *,DEFCLASS *);
static void FormInstanceTemplate(void *,DEFCLASS *);
static void FormSlotNameMap(void *,DEFCLASS *);
static TEMP_SLOT_LINK *MergeSlots(void *,TEMP_SLOT_LINK *,DEFCLASS *,short *,int);
static void PackSlots(void *,DEFCLASS *,TEMP_SLOT_LINK *);
static void CreatePublicSlotMessageHandlers(void *,DEFCLASS *);
/* =========================================
*****************************************
EXTERNALLY VISIBLE FUNCTIONS
=========================================
***************************************** */
/***************************************************************************************
NAME : ParseDefclass
DESCRIPTION : (defclass ...) is a construct (as
opposed to a function), thus no variables
may be used. This means classes may only
be STATICALLY defined (like rules).
INPUTS : The logical name of the router
for the parser input
RETURNS : FALSE if successful parse, TRUE otherwise
SIDE EFFECTS : Inserts valid class definition into
Class Table.
NOTES : H/L Syntax :
(defclass <name> [<comment>]
(is-a <superclass-name>+)
<class-descriptor>*)
<class-descriptor> :== (slot <name> <slot-descriptor>*) |
(role abstract|concrete) |
(pattern-match reactive|non-reactive)
These are for documentation only:
(message-handler <name> [<type>])
<slot-descriptor> :== (default <default-expression>) |
(default-dynamic <default-expression>) |
(storage shared|local) |
(access read-only|read-write|initialize-only) |
(propagation no-inherit|inherit) |
(source composite|exclusive)
(pattern-match reactive|non-reactive)
(visibility public|private)
(override-message <message-name>)
(type ...) |
(cardinality ...) |
(allowed-symbols ...) |
(allowed-strings ...) |
(allowed-numbers ...) |
(allowed-integers ...) |
(allowed-floats ...) |
(allowed-values ...) |
(allowed-instance-names ...) |
(allowed-classes ...) |
(range ...)
<default-expression> ::= ?NONE | ?VARIABLE | <expression>*
***************************************************************************************/
globle int ParseDefclass(
void *theEnv,
const char *readSource)
{
SYMBOL_HN *cname;
DEFCLASS *cls;
PACKED_CLASS_LINKS *sclasses,*preclist;
TEMP_SLOT_LINK *slots = NULL;
int roleSpecified = FALSE,
abstract = FALSE,
parseError;
#if DEFRULE_CONSTRUCT
int patternMatchSpecified = FALSE,
reactive = TRUE;
#endif
SetPPBufferStatus(theEnv,ON);
FlushPPBuffer(theEnv);
SetIndentDepth(theEnv,3);
SavePPBuffer(theEnv,"(defclass ");
#if BLOAD || BLOAD_ONLY || BLOAD_AND_BSAVE
if ((Bloaded(theEnv)) && (! ConstructData(theEnv)->CheckSyntaxMode))
{
CannotLoadWithBloadMessage(theEnv,"defclass");
return(TRUE);
}
#endif
cname = GetConstructNameAndComment(theEnv,readSource,&DefclassData(theEnv)->ObjectParseToken,"defclass",
EnvFindDefclassInModule,NULL,"#",TRUE,
TRUE,TRUE,FALSE);
if (cname == NULL)
return(TRUE);
if (ValidClassName(theEnv,ValueToString(cname),&cls) == FALSE)
return(TRUE);
sclasses = ParseSuperclasses(theEnv,readSource,cname);
if (sclasses == NULL)
return(TRUE);
preclist = FindPrecedenceList(theEnv,cls,sclasses);
if (preclist == NULL)
{
DeletePackedClassLinks(theEnv,sclasses,TRUE);
return(TRUE);
}
parseError = FALSE;
GetToken(theEnv,readSource,&DefclassData(theEnv)->ObjectParseToken);
while (GetType(DefclassData(theEnv)->ObjectParseToken) != RPAREN)
{
if (GetType(DefclassData(theEnv)->ObjectParseToken) != LPAREN)
{
SyntaxErrorMessage(theEnv,"defclass");
parseError = TRUE;
break;
}
PPBackup(theEnv);
PPCRAndIndent(theEnv);
SavePPBuffer(theEnv,"(");
GetToken(theEnv,readSource,&DefclassData(theEnv)->ObjectParseToken);
if (GetType(DefclassData(theEnv)->ObjectParseToken) != SYMBOL)
{
SyntaxErrorMessage(theEnv,"defclass");
parseError = TRUE;
break;
}
if (strcmp(DOToString(DefclassData(theEnv)->ObjectParseToken),ROLE_RLN) == 0)
{
if (ParseSimpleQualifier(theEnv,readSource,ROLE_RLN,CONCRETE_RLN,ABSTRACT_RLN,
&roleSpecified,&abstract) == FALSE)
{
parseError = TRUE;
break;
}
}
#if DEFRULE_CONSTRUCT
else if (strcmp(DOToString(DefclassData(theEnv)->ObjectParseToken),MATCH_RLN) == 0)
{
if (ParseSimpleQualifier(theEnv,readSource,MATCH_RLN,NONREACTIVE_RLN,REACTIVE_RLN,
&patternMatchSpecified,&reactive) == FALSE)
{
parseError = TRUE;
break;
}
}
#endif
else if (strcmp(DOToString(DefclassData(theEnv)->ObjectParseToken),SLOT_RLN) == 0)
{
slots = ParseSlot(theEnv,readSource,slots,preclist,FALSE,FALSE);
if (slots == NULL)
{
parseError = TRUE;
break;
}
}
else if (strcmp(DOToString(DefclassData(theEnv)->ObjectParseToken),SGL_SLOT_RLN) == 0)
{
slots = ParseSlot(theEnv,readSource,slots,preclist,FALSE,TRUE);
if (slots == NULL)
{
parseError = TRUE;
break;
}
}
else if (strcmp(DOToString(DefclassData(theEnv)->ObjectParseToken),MLT_SLOT_RLN) == 0)
{
slots = ParseSlot(theEnv,readSource,slots,preclist,TRUE,TRUE);
if (slots == NULL)
{
parseError = TRUE;
break;
}
}
else if (strcmp(DOToString(DefclassData(theEnv)->ObjectParseToken),HANDLER_DECL) == 0)
{
if (ReadUntilClosingParen(theEnv,readSource,&DefclassData(theEnv)->ObjectParseToken) == FALSE)
{
parseError = TRUE;
break;
}
}
else
{
SyntaxErrorMessage(theEnv,"defclass");
parseError = TRUE;
break;
}
GetToken(theEnv,readSource,&DefclassData(theEnv)->ObjectParseToken);
}
if ((GetType(DefclassData(theEnv)->ObjectParseToken) != RPAREN) || (parseError == TRUE))
{
DeletePackedClassLinks(theEnv,sclasses,TRUE);
DeletePackedClassLinks(theEnv,preclist,TRUE);
DeleteSlots(theEnv,slots);
return(TRUE);
}
SavePPBuffer(theEnv,"\n");
/* =========================================================================
The abstract/reactive qualities of a class are inherited if not specified
========================================================================= */
if (roleSpecified == FALSE)
{
if (preclist->classArray[1]->system && /* Change to cause */
(DefclassData(theEnv)->ClassDefaultsMode == CONVENIENCE_MODE)) /* default role of */
{ abstract = FALSE; } /* classes to be concrete. */
else
{ abstract = preclist->classArray[1]->abstract; }
}
#if DEFRULE_CONSTRUCT
if (patternMatchSpecified == FALSE)
{
if ((preclist->classArray[1]->system) && /* Change to cause */
(! abstract) && /* default pattern-match */
(DefclassData(theEnv)->ClassDefaultsMode == CONVENIENCE_MODE)) /* of classes to be */
{ reactive = TRUE; } /* reactive. */
else
{ reactive = preclist->classArray[1]->reactive; }
}
/* ================================================================
An abstract class cannot have direct instances, thus it makes no
sense for it to be reactive since it will have no objects to
respond to pattern-matching
================================================================ */
if (abstract && reactive)
{
PrintErrorID(theEnv,"CLASSPSR",1,FALSE);
EnvPrintRouter(theEnv,WERROR,"An abstract class cannot be reactive.\n");
DeletePackedClassLinks(theEnv,sclasses,TRUE);
DeletePackedClassLinks(theEnv,preclist,TRUE);
DeleteSlots(theEnv,slots);
return(TRUE);
}
#endif
/* =======================================================
If we're only checking syntax, don't add the
successfully parsed defclass to the KB.
======================================================= */
if (ConstructData(theEnv)->CheckSyntaxMode)
{
DeletePackedClassLinks(theEnv,sclasses,TRUE);
DeletePackedClassLinks(theEnv,preclist,TRUE);
DeleteSlots(theEnv,slots);
return(FALSE);
}
cls = NewClass(theEnv,cname);
cls->abstract = abstract;
#if DEFRULE_CONSTRUCT
cls->reactive = reactive;
#endif
cls->directSuperclasses.classCount = sclasses->classCount;
cls->directSuperclasses.classArray = sclasses->classArray;
/* =======================================================
This is a hack to let functions which need to iterate
over a class AND its superclasses to conveniently do so
The real precedence list starts in position 1
======================================================= */
preclist->classArray[0] = cls;
cls->allSuperclasses.classCount = preclist->classCount;
cls->allSuperclasses.classArray = preclist->classArray;
rtn_struct(theEnv,packedClassLinks,sclasses);
rtn_struct(theEnv,packedClassLinks,preclist);
/* =================================
Shove slots into contiguous array
================================= */
if (slots != NULL)
PackSlots(theEnv,cls,slots);
AddClass(theEnv,cls);
return(FALSE);
}
/* =========================================
*****************************************
INTERNALLY VISIBLE FUNCTIONS
=========================================
***************************************** */
/***********************************************************
NAME : ValidClassName
DESCRIPTION : Determines if a new class of the given
name can be defined in the current module
INPUTS : 1) The new class name
2) Buffer to hold class address
RETURNS : TRUE if OK, FALSE otherwise
SIDE EFFECTS : Error message printed if not OK
NOTES : GetConstructNameAndComment() (called before
this function) ensures that the defclass
name does not conflict with one from
another module
***********************************************************/
static intBool ValidClassName(
void *theEnv,
const char *theClassName,
DEFCLASS **theDefclass)
{
*theDefclass = (DEFCLASS *) EnvFindDefclassInModule(theEnv,theClassName);
if (*theDefclass != NULL)
{
/* ===================================
System classes (which are visible
in all modules) cannot be redefined
=================================== */
if ((*theDefclass)->system)
{
PrintErrorID(theEnv,"CLASSPSR",2,FALSE);
EnvPrintRouter(theEnv,WERROR,"Cannot redefine a predefined system class.\n");
return(FALSE);
}
/* ===============================================
A class in the current module can only be
redefined if it is not in use, e.g., instances,
generic function method restrictions, etc.
=============================================== */
if ((EnvIsDefclassDeletable(theEnv,(void *) *theDefclass) == FALSE) &&
(! ConstructData(theEnv)->CheckSyntaxMode))
{
PrintErrorID(theEnv,"CLASSPSR",3,FALSE);
EnvPrintRouter(theEnv,WERROR,EnvGetDefclassName(theEnv,(void *) *theDefclass));
EnvPrintRouter(theEnv,WERROR," class cannot be redefined while\n");
EnvPrintRouter(theEnv,WERROR," outstanding references to it still exist.\n");
return(FALSE);
}
}
return(TRUE);
}
/***************************************************************
NAME : ParseSimpleQualifier
DESCRIPTION : Parses abstract/concrete role and
pattern-matching reactivity for class
INPUTS : 1) The input logical name
2) The name of the qualifier being parsed
3) The qualifier value indicating that the
qualifier should be false
4) The qualifier value indicating that the
qualifier should be TRUE
5) A pointer to a bitmap indicating
if the qualifier has already been parsed
6) A buffer to store the value of the qualifier
RETURNS : TRUE if all OK, FALSE otherwise
SIDE EFFECTS : Bitmap and qualifier buffers set
Messages printed on errors
NOTES : None
***************************************************************/
static intBool ParseSimpleQualifier(
void *theEnv,
const char *readSource,
const char *classQualifier,
const char *clearRelation,
const char *setRelation,
intBool *alreadyTestedFlag,
intBool *binaryFlag)
{
if (*alreadyTestedFlag)
{
PrintErrorID(theEnv,"CLASSPSR",4,FALSE);
EnvPrintRouter(theEnv,WERROR,"Class ");
EnvPrintRouter(theEnv,WERROR,classQualifier);
EnvPrintRouter(theEnv,WERROR," already declared.\n");
return(FALSE);
}
SavePPBuffer(theEnv," ");
GetToken(theEnv,readSource,&DefclassData(theEnv)->ObjectParseToken);
if (GetType(DefclassData(theEnv)->ObjectParseToken) != SYMBOL)
goto ParseSimpleQualifierError;
if (strcmp(DOToString(DefclassData(theEnv)->ObjectParseToken),setRelation) == 0)
*binaryFlag = TRUE;
else if (strcmp(DOToString(DefclassData(theEnv)->ObjectParseToken),clearRelation) == 0)
*binaryFlag = FALSE;
else
goto ParseSimpleQualifierError;
GetToken(theEnv,readSource,&DefclassData(theEnv)->ObjectParseToken);
if (GetType(DefclassData(theEnv)->ObjectParseToken) != RPAREN)
goto ParseSimpleQualifierError;
*alreadyTestedFlag = TRUE;
return(TRUE);
ParseSimpleQualifierError:
SyntaxErrorMessage(theEnv,"defclass");
return(FALSE);
}
/***************************************************
NAME : ReadUntilClosingParen
DESCRIPTION : Skips over tokens until a ')' is
encountered.
INPUTS : 1) The logical input source
2) A buffer for scanned tokens
RETURNS : TRUE if ')' read, FALSE
otherwise
SIDE EFFECTS : Tokens read
NOTES : Expects first token after opening
paren has already been scanned
***************************************************/
static intBool ReadUntilClosingParen(
void *theEnv,
const char *readSource,
struct token *inputToken)
{
int cnt = 1,lparen_read = FALSE;
do
{
if (lparen_read == FALSE)
SavePPBuffer(theEnv," ");
GetToken(theEnv,readSource,inputToken);
if (inputToken->type == STOP)
{
SyntaxErrorMessage(theEnv,"message-handler declaration");
return(FALSE);
}
else if (inputToken->type == LPAREN)
{
lparen_read = TRUE;
cnt++;
}
else if (inputToken->type == RPAREN)
{
cnt--;
if (lparen_read == FALSE)
{
PPBackup(theEnv);
PPBackup(theEnv);
SavePPBuffer(theEnv,")");
}
lparen_read = FALSE;
}
else
lparen_read = FALSE;
}
while (cnt > 0);
return(TRUE);
}
/*****************************************************************************
NAME : AddClass
DESCRIPTION : Determines the precedence list of the new class.
If it is valid, the routine checks to see if the class
already exists. If it does not, all the subclass
links are made from the class's direct superclasses,
and the class is inserted in the hash table. If it
does, all sublclasses are deleted. An error will occur
if any instances of the class (direct or indirect) exist.
If all checks out, the old definition is replaced by the new.
INPUTS : The new class description
RETURNS : Nothing useful
SIDE EFFECTS : The class is deleted if there is an error.
NOTES : No change in the class graph state will occur
if there were any errors.
Assumes class is not busy!!!
*****************************************************************************/
static void AddClass(
void *theEnv,
DEFCLASS *cls)
{
DEFCLASS *ctmp;
#if DEBUGGING_FUNCTIONS
int oldTraceInstances = FALSE,
oldTraceSlots = FALSE;
#endif
/* ===============================================
If class does not already exist, insert and
form progeny links with all direct superclasses
=============================================== */
cls->hashTableIndex = HashClass(GetDefclassNamePointer((void *) cls));
ctmp = (DEFCLASS *) EnvFindDefclassInModule(theEnv,EnvGetDefclassName(theEnv,(void *) cls));
if (ctmp != NULL)
{
#if DEBUGGING_FUNCTIONS
oldTraceInstances = ctmp->traceInstances;
oldTraceSlots = ctmp->traceSlots;
#endif
DeleteClassUAG(theEnv,ctmp);
}
PutClassInTable(theEnv,cls);
BuildSubclassLinks(theEnv,cls);
InstallClass(theEnv,cls,TRUE);
AddConstructToModule((struct constructHeader *) cls);
FormInstanceTemplate(theEnv,cls);
FormSlotNameMap(theEnv,cls);
AssignClassID(theEnv,cls);
#if DEBUGGING_FUNCTIONS
if (cls->abstract)
{
cls->traceInstances = FALSE;
cls->traceSlots = FALSE;
}
else
{
if (oldTraceInstances)
cls->traceInstances = TRUE;
if (oldTraceSlots)
cls->traceSlots = TRUE;
}
#endif
#if DEBUGGING_FUNCTIONS
if (EnvGetConserveMemory(theEnv) == FALSE)
EnvSetDefclassPPForm(theEnv,(void *) cls,CopyPPBuffer(theEnv));
#endif
#if DEFMODULE_CONSTRUCT
/* =========================================
Create a bitmap indicating whether this
class is in scope or not for every module
========================================= */
cls->scopeMap = (BITMAP_HN *) CreateClassScopeMap(theEnv,cls);
#endif
/* ==============================================
Define get- and put- handlers for public slots
============================================== */
CreatePublicSlotMessageHandlers(theEnv,cls);
}
/*******************************************************
NAME : BuildSubclassLinks
DESCRIPTION : Follows the list of superclasses
for a class and puts the class in
each of the superclasses' subclass
list.
INPUTS : The address of the class
RETURNS : Nothing useful
SIDE EFFECTS : The subclass lists for every superclass
are modified.
NOTES : Assumes the superclass list is formed.
*******************************************************/
static void BuildSubclassLinks(
void *theEnv,
DEFCLASS *cls)
{
long i;
for (i = 0 ; i < cls->directSuperclasses.classCount ; i++)
AddClassLink(theEnv,&cls->directSuperclasses.classArray[i]->directSubclasses,cls,-1);
}
/**********************************************************
NAME : FormInstanceTemplate
DESCRIPTION : Forms a contiguous array of instance
slots for use in creating instances later
Also used in determining instance slot
indices a priori during handler defns
INPUTS : The class
RETURNS : Nothing useful
SIDE EFFECTS : Contiguous array of instance slots formed
NOTES : None
**********************************************************/
static void FormInstanceTemplate(
void *theEnv,
DEFCLASS *cls)
{
TEMP_SLOT_LINK *islots = NULL,*stmp;
short scnt = 0;
long i;
/* ========================
Get direct class's slots
======================== */
islots = MergeSlots(theEnv,islots,cls,&scnt,DIRECT);
/* ===================================================================
Get all inherited slots - a more specific slot takes precedence
over more general, i.e. the first class in the precedence list with
a particular slot gets to specify its default value
=================================================================== */
for (i = 1 ; i < cls->allSuperclasses.classCount ; i++)
islots = MergeSlots(theEnv,islots,cls->allSuperclasses.classArray[i],&scnt,INHERIT);
/* ===================================================
Allocate a contiguous array to store all the slots.
=================================================== */
cls->instanceSlotCount = scnt;
cls->localInstanceSlotCount = 0;
if (scnt > 0)
cls->instanceTemplate = (SLOT_DESC **) gm2(theEnv,(scnt * sizeof(SLOT_DESC *)));
for (i = 0 ; i < scnt ; i++)
{
stmp = islots;
islots = islots->nxt;
cls->instanceTemplate[i] = stmp->desc;
if (stmp->desc->shared == 0)
cls->localInstanceSlotCount++;
rtn_struct(theEnv,tempSlotLink,stmp);
}
}
/**********************************************************
NAME : FormSlotNameMap
DESCRIPTION : Forms a mapping of the slot name ids into
the instance template. Given the slot
name id, this map provides a much faster
lookup of a slot. The id is stored
statically in object patterns and can
be looked up via a hash table at runtime
as well.
INPUTS : The class
RETURNS : Nothing useful
SIDE EFFECTS : Contiguous array of integers formed
The position in the array corresponding
to a slot name id holds an the index
into the instance template array holding
the slot
The max slot name id for the class is
also stored to make deletion of the slots
easier
NOTES : Assumes the instance template has already
been formed
**********************************************************/
static void FormSlotNameMap(
void *theEnv,
DEFCLASS *cls)
{
long i;
cls->maxSlotNameID = 0;
cls->slotNameMap = NULL;
if (cls->instanceSlotCount == 0)
return;
for (i = 0 ; i < cls->instanceSlotCount ; i++)
if (cls->instanceTemplate[i]->slotName->id > cls->maxSlotNameID)
cls->maxSlotNameID = cls->instanceTemplate[i]->slotName->id;
cls->slotNameMap = (unsigned *) gm2(theEnv,(sizeof(unsigned) * (cls->maxSlotNameID + 1)));
for (i = 0 ; i <= cls->maxSlotNameID ; i++)
cls->slotNameMap[i] = 0;
for (i = 0 ; i < cls->instanceSlotCount ; i++)
cls->slotNameMap[cls->instanceTemplate[i]->slotName->id] = i + 1;
}
/********************************************************************
NAME : MergeSlots
DESCRIPTION : Adds non-duplicate slots to list and increments
slot count for the class instance template
INPUTS : 1) The old slot list
2) The address of class containing new slots
3) Caller's buffer for # of slots
4) A flag indicating whether the new list of slots
is from the direct parent-class or not.
RETURNS : The address of the new expanded list, or NULL
for an empty list
SIDE EFFECTS : The list is expanded
Caller's slot count is adjusted.
NOTES : Lists are assumed to contain no duplicates
*******************************************************************/
static TEMP_SLOT_LINK *MergeSlots(
void *theEnv,
TEMP_SLOT_LINK *old,
DEFCLASS *cls,
short *scnt,
int src)
{
TEMP_SLOT_LINK *cur,*tmp;
register int i;
SLOT_DESC *newSlot;
/* ======================================
Process the slots in reverse order
since we are pushing them onto a stack
====================================== */
for (i = (int) (cls->slotCount - 1) ; i >= 0 ; i--)
{
newSlot = &cls->slots[i];
/* ==========================================
A class can prevent it slots from being
propagated to all but its direct instances
========================================== */
if ((newSlot->noInherit == 0) ? TRUE : (src == DIRECT))
{
cur = old;
while ((cur != NULL) ? (newSlot->slotName != cur->desc->slotName) : FALSE)
cur = cur->nxt;
if (cur == NULL)
{
tmp = get_struct(theEnv,tempSlotLink);
tmp->desc = newSlot;
tmp->nxt = old;
old = tmp;
(*scnt)++;
}
}
}
return(old);
}
/***********************************************************************
NAME : PackSlots
DESCRIPTION : Groups class-slots into a contiguous array
"slots" field points to array
"slotCount" field set
INPUTS : 1) The class
2) The list of slots
RETURNS : Nothing useful
SIDE EFFECTS : Temporary list deallocated, contiguous array allocated,
and nxt pointers linked
Class pointer set for slots
NOTES : Assumes class->slotCount == 0 && class->slots == NULL
***********************************************************************/
static void PackSlots(
void *theEnv,
DEFCLASS *cls,
TEMP_SLOT_LINK *slots)
{
TEMP_SLOT_LINK *stmp,*sprv;
long i;
stmp = slots;
while (stmp != NULL)
{
stmp->desc->cls = cls;
cls->slotCount++;
stmp = stmp->nxt;
}
cls->slots = (SLOT_DESC *) gm2(theEnv,(sizeof(SLOT_DESC) * cls->slotCount));
stmp = slots;
for (i = 0 ; i < cls->slotCount ; i++)
{
sprv = stmp;
stmp = stmp->nxt;
GenCopyMemory(SLOT_DESC,1,&(cls->slots[i]),sprv->desc);
cls->slots[i].sharedValue.desc = &(cls->slots[i]);
cls->slots[i].sharedValue.value = NULL;
rtn_struct(theEnv,slotDescriptor,sprv->desc);
rtn_struct(theEnv,tempSlotLink,sprv);
}
}
#if DEFMODULE_CONSTRUCT
/********************************************************
NAME : CreateClassScopeMap
DESCRIPTION : Creates a bitmap where each bit position
corresponds to a module id. If the bit
is set, the class is in scope for that
module, otherwise it is not.
INPUTS : The class
RETURNS : Nothing useful
SIDE EFFECTS : Scope bitmap created and attached
NOTES : Uses FindImportedConstruct()
********************************************************/
globle void *CreateClassScopeMap(
void *theEnv,
DEFCLASS *theDefclass)
{
unsigned scopeMapSize;
char *scopeMap;
const char *className;
struct defmodule *matchModule,
*theModule;
int moduleID,count;
void *theBitMap;
className = ValueToString(theDefclass->header.name);
matchModule = theDefclass->header.whichModule->theModule;
scopeMapSize = (sizeof(char) * ((GetNumberOfDefmodules(theEnv) / BITS_PER_BYTE) + 1));
scopeMap = (char *) gm2(theEnv,scopeMapSize);
ClearBitString((void *) scopeMap,scopeMapSize);
SaveCurrentModule(theEnv);
for (theModule = (struct defmodule *) EnvGetNextDefmodule(theEnv,NULL) ;
theModule != NULL ;
theModule = (struct defmodule *) EnvGetNextDefmodule(theEnv,(void *) theModule))
{
EnvSetCurrentModule(theEnv,(void *) theModule);
moduleID = (int) theModule->bsaveID;
if (FindImportedConstruct(theEnv,"defclass",matchModule,
className,&count,TRUE,NULL) != NULL)
SetBitMap(scopeMap,moduleID);
}
RestoreCurrentModule(theEnv);
theBitMap = (BITMAP_HN *) EnvAddBitMap(theEnv,scopeMap,scopeMapSize);
IncrementBitMapCount(theBitMap);
rm(theEnv,(void *) scopeMap,scopeMapSize);
return(theBitMap);
}
#endif
/*****************************************************************************
NAME : CreatePublicSlotMessageHandlers
DESCRIPTION : Creates a get-<slot-name> and
put-<slot-name> handler for every
public slot in a class.
The syntax of the message-handlers
created are:
(defmessage-handler <class> get-<slot-name> primary ()
?self:<slot-name>)
For single-field slots:
(defmessage-handler <class> put-<slot-name> primary (?value)
(bind ?self:<slot-name> ?value))
For multifield slots:
(defmessage-handler <class> put-<slot-name> primary ($?value)
(bind ?self:<slot-name> ?value))
INPUTS : The defclass
RETURNS : Nothing useful
SIDE EFFECTS : Message-handlers created
NOTES : None
******************************************************************************/
static void CreatePublicSlotMessageHandlers(
void *theEnv,
DEFCLASS *theDefclass)
{
long i;
register SLOT_DESC *sd;
for (i = 0 ; i < theDefclass->slotCount ; i++)
{
sd = &theDefclass->slots[i];
CreateGetAndPutHandlers(theEnv,sd);
}
for (i = 0 ; i < theDefclass->handlerCount ; i++)
theDefclass->handlers[i].system = TRUE;
}
#endif