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
|
#############################################################################
##
#W variable.g GAP library Frank Celler
##
#H @(#)$Id: variable.g,v 4.14.4.3 2005/11/26 06:59:01 gap Exp $
##
#Y Copyright (C) 1997, Lehrstuhl D fuer Mathematik, RWTH Aachen, Germany
#Y (C) 1998 School Math and Comp. Sci., University of St. Andrews, Scotland
#Y Copyright (C) 2002 The GAP Group
##
## This file contains the functions for the special handling of those global
## variables in {\GAP} library files that are *not* functions;
## they are declared with `DeclareGlobalVariable' and initialized with
## `InstallValue' resp.~`InstallFlushableValue'.
##
## For the global functions in the {\GAP} libraray, see `oper.g'.
##
Revision.variable_g :=
"@(#)$Id: variable.g,v 4.14.4.3 2005/11/26 06:59:01 gap Exp $";
#############################################################################
##
#C IsToBeDefinedObj. . . . . . . . represenation of "to be defined" objects
##
DeclareCategory( "IsToBeDefinedObj", IsObject );
#############################################################################
##
#V ToBeDefinedObjFamily . . . . . . . . . family of "to be defined" objects
##
BIND_GLOBAL( "ToBeDefinedObjFamily",
NewFamily( "ToBeDefinedObjFamily", IsToBeDefinedObj ) );
#############################################################################
##
#V ToBeDefinedObjType . . . . . . . . . . . type of "to be defined" objects
##
BIND_GLOBAL( "ToBeDefinedObjType", NewType(
ToBeDefinedObjFamily, IsPositionalObjectRep ) );
#############################################################################
##
#F NewToBeDefinedObj() . . . . . . . . . create a new "to be defined" object
##
BIND_GLOBAL( "NewToBeDefinedObj",
name -> Objectify( ToBeDefinedObjType, [ name ] ) );
#############################################################################
##
#M PrintObj( <obj> ) . . . . . . . . . . . . . print "to be defined" object
##
InstallMethod( PrintObj,
"for 'to be defined' objects",
[ IsToBeDefinedObj ],
function(obj)
Print( "<< ",obj![1]," to be defined>>" );
end );
#############################################################################
##
#O FlushCaches( ) . . . . . . . . . . . . . . . . . . . . . Clear all caches
##
## `FlushCaches()' will clear all clearable internal caches defined by
## `InstallFlushableValue'.
## These caches hold objects like finite fields once created and are used
## to speed up computations as well as to avoid creating unique objects
## several times, so `FlushCaches' is thought for debugging purposes.
##
## All methods for `FlushCaches' must be installed that they clear the
## cache and then return on `TryNextMethod', thus one call to `FlushCaches'
## allows one to run all methods.
##
DeclareOperation( "FlushCaches", [] );
# This method is just that one method is callable. It is installed first, so
# it will be last in line.
InstallMethod( FlushCaches, "return method", [], function() end );
#############################################################################
##
#F DeclareGlobalVariable( <name>[, <description>] )
##
## `DeclareGlobalVariable' creates a new global variable named by the
## string <name>.
## If the second argument <description> is entered then this must be
## a string that describes the meaning of the global variable.
## Values can be assigned to the new variable with `InstallValue' or
## `InstallFlushableValue'.
##
BIND_GLOBAL( "DeclareGlobalVariable", function( arg )
BIND_GLOBAL( arg[1], NewToBeDefinedObj(arg[1]) );
end );
#############################################################################
##
#F InstallValue( <gvar>, <value> )
#F InstallFlushableValue( <gvar>, <value> )
##
## `InstallValue' assigns the value <value> to the global variable <gvar>.
## `InstallFlushableValue' does the same but additionally provides that
## each call of `FlushCaches' will assign a structural copy of <value>
## to <gvar>.
##
## `InstallValue' does *not* work if <value> is an ``immediate object''
## (i.e., an internally represented small integer or finite field element).
## Furthermore, `InstallFlushableValue' works only if <value> is a list
## or a record.
##
## Using `DeclareGlobalVariable' and `InstallFlushableValue' has several
## advantages, compared to simple assignments.
## 1. The initial value must be written down only once in the file;
## this is an argument in particular for the variable `Primes2'.
## 2. The implementation of `FlushCaches' is not prescribed,
## at least it is hidden in the function `InstallFlushableValue'.
## 3. It is possible to access the `#V' global variables from within GAP,
## perhaps separately for each package.
## Note that the assignments of other global variables via
## `DeclareOperation', `DeclareProperty' etc. would admit this already.
#T (This would raise the question whether also immutable `#V' variables
#T shall be defined via a function call.)
##
## (Note that `InstallFlushableValue' makes sense only for *mutable*
## global lists.)
##
BIND_GLOBAL( "InstallValue", function ( gvar, value )
if (not IsBound(REREADING) or REREADING = false) and not
IsToBeDefinedObj( gvar ) then
Error("InstallValue: a value has been installed already");
fi;
# if IsFamily( value ) then
# INFO_INSTALL( 1,
# "please use `BindGlobal' for the family object ",
# value!.NAME, ", not `InstallValue'" );
# fi;
CLONE_OBJ (gvar, value);
end);
BIND_GLOBAL( "InstallFlushableValue", function( gvar, value )
local initval;
if not ( IS_LIST( value ) or IS_REC( value ) ) then
Error( "<value> must be a list or a record" );
fi;
# Make a structural copy of the initial value.
initval:= DEEP_COPY_OBJ( value );
# Initialize the variable.
InstallValue( gvar, value );
# Install the method to flush the cache.
InstallMethod( FlushCaches,
[],
function()
CLONE_OBJ( gvar, DEEP_COPY_OBJ( initval ) );
TryNextMethod();
end );
end );
## Bind some keywords as global variables such that <Tab> completion works
## for them. These variables are not accessible.
BIND_GLOBAL( "Unbind", 0 );
BIND_GLOBAL( "true", 0 );
BIND_GLOBAL( "false", 0 );
BIND_GLOBAL( "while", 0 );
BIND_GLOBAL( "repeat", 0 );
BIND_GLOBAL( "until", 0 );
BIND_GLOBAL( "SaveWorkspace", 0 );
BIND_GLOBAL( "else", 0 );
BIND_GLOBAL( "elif", 0 );
BIND_GLOBAL( "function", 0 );
BIND_GLOBAL( "local", 0 );
BIND_GLOBAL( "return", 0 );
BIND_GLOBAL( "then", 0 );
BIND_GLOBAL( "quit", 0 );
BIND_GLOBAL( "break", 0 );
BIND_GLOBAL( "continue", 0 );
BIND_GLOBAL( "IsBound", 0 );
BIND_GLOBAL( "TryNextMethod", 0 );
BIND_GLOBAL( "Info", 0 );
BIND_GLOBAL( "Assert", 0 );
#############################################################################
##
#E
|
