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
|
/*
* Universal Routines
* by Tom Epperly
* Created: 3/27/1990
* Version: $Revision: 1.7 $
* Version control file: $RCSfile: universal.h,v $
* Date last modified: $Date: 1997/07/18 12:36:21 $
* Last modified by: $Author: mthomas $
*
* This file is part of the Ascend Language Interpreter.
*
* Copyright (C) 1990, 1993, 1994 Thomas Guthrie Epperly
*
* The Ascend Language Interpreter is free software; you can redistribute
* it and/or modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* The Ascend Language Interpreter is distributed in hope that it will be
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file
* Universal Routines.
* <pre>
* When #including universal.h, make sure these files are #included first:
* #include "utilities/ascConfig.h"
* #include "fractions.h"
* #include "compiler.h"
* #include "dimen.h"
* #include "child.h"
* #include "list.h"
* #include "instance_enum.h"
* #include "type_desc.h"
* </pre>
*/
#ifndef ASC_UNIVERSAL_H
#define ASC_UNIVERSAL_H
/** @addtogroup compiler_universal Compiler Universal Routines
@{
*/
#define UniversalTable gl_list_t
extern struct UniversalTable *CreateUniversalTable(void);
/**<
* Create an empty table for holding the universal instances.
*/
extern void DestroyUniversalTable(struct UniversalTable *table);
/**<
* Destroy the list, but not the instances contained in the list.
*/
extern struct UniversalTable *MergeTables(struct UniversalTable *table1,
struct UniversalTable *table2);
/**<
* Merge the contents of two universal tables and make a joint table.
* The old tables are probably destroyed.
* NOT IMPLEMENTED.
* @todo Implement compiler/universal.c MergeTables().
*/
extern void SetUniversalTable(struct UniversalTable * table);
/**<
* Set the global universal table to "table". This replaces the previous
* universal table, if one existed. In general for instantiation to
* correctly handle universal instances, there must be an non-NULL
* universal table. The universal table is initially NULL.
*/
extern struct UniversalTable *GetUniversalTable(void);
/**<
* Return a pointer to the current global universal table.
*/
extern struct Instance *LookupInstance(struct UniversalTable *table,
struct TypeDescription *desc);
/**<
* Return the pointer to the universal instance of type desc. This will
* return NULL if no such instance is in the table.
*/
extern void AddUniversalInstance(struct UniversalTable *table,
struct TypeDescription *desc,
struct Instance *inst);
/**<
* Add a type to the universal table. Add the type "desc" to the universal
* list. inst is the instance that all instances of type "desc" should be.
* This assumes that desc is not already in the list.
* This does no checking that the instance given is of the type given --
* it is assumed the user knows what they are doing, particularly in
* handling universals around refinement and merging.
*/
extern unsigned long NumberTypes(struct UniversalTable *table);
/**<
* Return the number of types found in the table.
*/
extern void ChangeUniversalInstance(struct UniversalTable *table,
struct Instance *oldinst,
struct Instance *newinst);
/**<
* Change any references of oldinst into newinst.
*/
extern void RemoveUniversalInstance(struct UniversalTable *table,
struct Instance *inst);
/**<
* Remove any type entry that contains instance inst.
*/
extern struct TypeDescription *GetTypeDescription(struct UniversalTable *table,
unsigned long pos);
/**<
* Return the type description in position pos. Note that the instance
* may be more refined that the type.
*/
extern struct Instance *GetInstance(struct UniversalTable *table,
unsigned long pos);
/**<
* Return the instance in position pos.
*/
/* @} */
#endif /* ASC_UNIVERSAL_H */
|