/usr/include/gap/calls.h is in gap-dev 4r6p5-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /****************************************************************************
**
*W calls.h GAP source Martin Schönert
**
**
*Y Copyright (C) 1996, Lehrstuhl D für 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 declares the functions of the generic function call mechanism
** package.
**
** This package defines the *call mechanism* through which one GAP function,
** named the *caller*, can temporarily transfer control to another function,
** named the *callee*.
**
** There are *compiled functions* and *interpreted functions*. Thus there
** are four possible pairings of caller and callee.
**
** If the caller is compiled, then the call comes directly from the caller.
** If it is interpreted, then the call comes from one of the functions
** 'EvalFunccall<i>args' that implement evaluation of function calls.
**
** If the callee is compiled, then the call goes directly to the callee.
** If it is interpreted, then the call goes to one of the handlers
** 'DoExecFunc<i>args' that implement execution of function bodies.
**
** The call mechanism makes it in any case unneccessary for the calling code
** to know whether the callee is a compiled or an interpreted function.
** Likewise the called code need not know, actually cannot know, whether the
** caller is a compiled or an interpreted function.
**
** Also the call mechanism checks that the number of arguments passed by the
** caller is the same as the number of arguments expected by the callee, or
** it collects the arguments in a list if the callee allows a variable
** number of arguments.
**
** Finally the call mechanism profiles all functions if requested.
**
** All this has very little overhead. In the case of one compiled function
** calling another compiled function, which expects fewer than 4 arguments,
** with no profiling, the overhead is only a couple of instructions.
*/
#ifndef GAP_CALLS_H
#define GAP_CALLS_H
/****************************************************************************
**
*T ObjFunc . . . . . . . . . . . . . . . . type of function returning object
**
** 'ObjFunc' is the type of a function returning an object.
*/
typedef Obj (* ObjFunc) (/*arguments*/);
/****************************************************************************
**
*F HDLR_FUNC(<func>,<i>) . . . . . . . . . <i>-th call handler of a function
*F NAME_FUNC(<func>) . . . . . . . . . . . . . . . . . . name of a function
*F NARG_FUNC(<func>) . . . . . . . . . . . number of arguments of a function
*F NAMS_FUNC(<func>) . . . . . . . . names of local variables of a function
*F NAMI_FUNC(<func>) . . . . . . name of <i>-th local variable of a function
*F PROF_FUNC(<func>) . . . . . . . . profiling information bag of a function
*F NLOC_FUNC(<func>) . . . . . . . . . . . . number of locals of a function
*F BODY_FUNC(<func>) . . . . . . . . . . . . . . . . . . body of a function
*F ENVI_FUNC(<func>) . . . . . . . . . . . . . . . environment of a function
*F FEXS_FUNC(<func>) . . . . . . . . . . . . func. expr. list of a function
*V SIZE_FUNC . . . . . . . . . . . . . . . . . size of the bag of a function
**
** These macros make it possible to access the various components of a
** function.
**
** 'HDLR_FUNC(<func>,<i>)' is the <i>-th handler of the function <func>.
**
** 'NAME_FUNC(<func>)' is the name of the function.
**
** 'NARG_FUNC(<func>)' is the number of arguments (-1 if <func> accepts a
** variable number of arguments).
**
** 'NAMS_FUNC(<func>)' is the list of the names of the local variables,
**
** 'NAMI_FUNC(<func>,<i>)' is the name of the <i>-th local variable.
**
** 'PROF_FUNC(<func>)' is the profiling information bag.
**
** 'NLOC_FUNC(<func>)' is the number of local variables of the interpreted
** function <func>.
**
** 'BODY_FUNC(<func>)' is the body.
**
** 'ENVI_FUNC(<func>)' is the environment (i.e., the local variables bag
** that was current when <func> was created).
**
** 'FEXS_FUNC(<func>)' is the function expressions list (i.e., the list of
** the function expressions of the functions defined inside of <func>).
**
*/
#define HDLR_FUNC(func,i) (* (ObjFunc*) (ADDR_OBJ(func) + 0 +(i)) )
#define NAME_FUNC(func) (* (ADDR_OBJ(func) + 8 ) )
#define NARG_FUNC(func) (* (Int*) (ADDR_OBJ(func) + 9 ) )
#define NAMS_FUNC(func) (* (ADDR_OBJ(func) +10 ) )
#define NAMI_FUNC(func,i) ((Char *)CHARS_STRING(ELM_LIST(NAMS_FUNC(func),i)))
#define PROF_FUNC(func) (* (ADDR_OBJ(func) +11 ) )
#define NLOC_FUNC(func) (* (UInt*) (ADDR_OBJ(func) +12 ) )
#define BODY_FUNC(func) (* (ADDR_OBJ(func) +13 ) )
#define ENVI_FUNC(func) (* (ADDR_OBJ(func) +14 ) )
#define FEXS_FUNC(func) (* (ADDR_OBJ(func) +15 ) )
#define SIZE_FUNC (16*sizeof(Bag))
/****************************************************************************
**
*F IS_FUNC( <obj> ) . . . . . . . . . . . . . check if object is a function
*/
#define IS_FUNC(obj) (TNUM_OBJ(obj) == T_FUNCTION)
/****************************************************************************
**
*F CALL_0ARGS(<func>) . . . . . . . . . call a function with 0 arguments
*F CALL_1ARGS(<func>,<arg1>) . . . . . . call a function with 1 arguments
*F CALL_2ARGS(<func>,<arg1>...) . . . . call a function with 2 arguments
*F CALL_3ARGS(<func>,<arg1>...) . . . . call a function with 3 arguments
*F CALL_4ARGS(<func>,<arg1>...) . . . . call a function with 4 arguments
*F CALL_5ARGS(<func>,<arg1>...) . . . . call a function with 5 arguments
*F CALL_6ARGS(<func>,<arg1>...) . . . . call a function with 6 arguments
*F CALL_XARGS(<func>,<args>) . . . . . . call a function with more arguments
**
** 'CALL_<i>ARGS' passes control to the function <func>, which must be a
** function object ('T_FUNCTION'). It returns the return value of <func>.
** 'CALL_0ARGS' is for calls passing no arguments, 'CALL_1ARGS' for calls
** passing one argument, and so on. 'CALL_XARGS' is for calls passing more
** than 5 arguments, where the arguments must be collected in a plain list,
** and this plain list must then be passed.
**
** 'CALL_<i>ARGS' can be used independently of whether the called function
** is a compiled or interpreted function. It checks that the number of
** passed arguments is the same as the number of arguments expected by the
** callee, or it collects the arguments in a list if the callee allows a
** variable number of arguments.
*/
#define CALL_0ARGS(f) HDLR_FUNC(f,0)(f)
#define CALL_1ARGS(f,a1) HDLR_FUNC(f,1)(f,a1)
#define CALL_2ARGS(f,a1,a2) HDLR_FUNC(f,2)(f,a1,a2)
#define CALL_3ARGS(f,a1,a2,a3) HDLR_FUNC(f,3)(f,a1,a2,a3)
#define CALL_4ARGS(f,a1,a2,a3,a4) HDLR_FUNC(f,4)(f,a1,a2,a3,a4)
#define CALL_5ARGS(f,a1,a2,a3,a4,a5) HDLR_FUNC(f,5)(f,a1,a2,a3,a4,a5)
#define CALL_6ARGS(f,a1,a2,a3,a4,a5,a6) HDLR_FUNC(f,6)(f,a1,a2,a3,a4,a5,a6)
#define CALL_XARGS(f,as) HDLR_FUNC(f,7)(f,as)
/****************************************************************************
**
*F CALL_0ARGS_PROF( <func>, <arg1> ) . . . . . call a prof func with 0 args
*F CALL_1ARGS_PROF( <func>, <arg1>, ... ) . . call a prof func with 1 args
*F CALL_2ARGS_PROF( <func>, <arg1>, ... ) . . call a prof func with 2 args
*F CALL_3ARGS_PROF( <func>, <arg1>, ... ) . . call a prof func with 3 args
*F CALL_4ARGS_PROF( <func>, <arg1>, ... ) . . call a prof func with 4 args
*F CALL_5ARGS_PROF( <func>, <arg1>, ... ) . . call a prof func with 5 args
*F CALL_6ARGS_PROF( <func>, <arg1>, ... ) . . call a prof func with 6 args
*F CALL_XARGS_PROF( <func>, <arg1>, ... ) . . call a prof func with X args
**
** 'CALL_<i>ARGS_PROF' is used in the profile handler 'DoProf<i>args' to
** call the real handler stored in the profiling information of the
** function.
*/
#define CALL_0ARGS_PROF(f) \
HDLR_FUNC(PROF_FUNC(f),0)(f)
#define CALL_1ARGS_PROF(f,a1) \
HDLR_FUNC(PROF_FUNC(f),1)(f,a1)
#define CALL_2ARGS_PROF(f,a1,a2) \
HDLR_FUNC(PROF_FUNC(f),2)(f,a1,a2)
#define CALL_3ARGS_PROF(f,a1,a2,a3) \
HDLR_FUNC(PROF_FUNC(f),3)(f,a1,a2,a3)
#define CALL_4ARGS_PROF(f,a1,a2,a3,a4) \
HDLR_FUNC(PROF_FUNC(f),4)(f,a1,a2,a3,a4)
#define CALL_5ARGS_PROF(f,a1,a2,a3,a4,a5) \
HDLR_FUNC(PROF_FUNC(f),5)(f,a1,a2,a3,a4,a5)
#define CALL_6ARGS_PROF(f,a1,a2,a3,a4,a5,a6) \
HDLR_FUNC(PROF_FUNC(f),6)(f,a1,a2,a3,a4,a5,a6)
#define CALL_XARGS_PROF(f,as) \
HDLR_FUNC(PROF_FUNC(f),7)(f,as)
/****************************************************************************
**
*F COUNT_PROF( <prof> ) . . . . . . . . number of invocations of a function
*F TIME_WITH_PROF( <prof> ) . . . . . . time with children in a function
*F TIME_WOUT_PROF( <prof> ) . . . . . . time without children in a function
*F STOR_WITH_PROF( <prof> ) . . . . storage with children in a function
*F STOR_WOUT_PROF( <prof> ) . . . . storage without children in a function
*V LEN_PROF . . . . . . . . . . . length of a profiling bag for a function
**
** With each function we associate two time measurements. First the *time
** spent by this function without its children*, i.e., the amount of time
** during which this function was active. Second the *time spent by this
** function with its children*, i.e., the amount of time during which this
** function was either active or suspended.
**
** Likewise with each function we associate the two storage measurements,
** the storage spent by this function without its children and the storage
** spent by this function with its children.
**
** These macros make it possible to access the various components of a
** profiling information bag <prof> for a function <func>.
**
** 'COUNT_PROF(<prof>)' is the number of calls to the function <func>.
** 'TIME_WITH_PROF(<prof>) is the time spent while the function <func> was
** either active or suspended. 'TIME_WOUT_PROF(<prof>)' is the time spent
** while the function <func> was active. 'STOR_WITH_PROF(<prof>)' is the
** amount of storage allocated while the function <func> was active or
** suspended. 'STOR_WOUT_PROF(<prof>)' is the amount of storage allocated
** while the function <func> was active. 'LEN_PROF' is the length of a
** profiling information bag.
*/
#define COUNT_PROF(prof) (INT_INTOBJ(ELM_PLIST(prof,1)))
#define TIME_WITH_PROF(prof) (INT_INTOBJ(ELM_PLIST(prof,2)))
#define TIME_WOUT_PROF(prof) (INT_INTOBJ(ELM_PLIST(prof,3)))
#define STOR_WITH_PROF(prof) (INT_INTOBJ(ELM_PLIST(prof,4)))
#define STOR_WOUT_PROF(prof) (INT_INTOBJ(ELM_PLIST(prof,5)))
#define SET_COUNT_PROF(prof,n) SET_ELM_PLIST(prof,1,INTOBJ_INT(n))
#define SET_TIME_WITH_PROF(prof,n) SET_ELM_PLIST(prof,2,INTOBJ_INT(n))
#define SET_TIME_WOUT_PROF(prof,n) SET_ELM_PLIST(prof,3,INTOBJ_INT(n))
#define SET_STOR_WITH_PROF(prof,n) SET_ELM_PLIST(prof,4,INTOBJ_INT(n))
#define SET_STOR_WOUT_PROF(prof,n) SET_ELM_PLIST(prof,5,INTOBJ_INT(n))
#define LEN_PROF 5
/****************************************************************************
**
*F * * * * * * * * * * * * * create a new function * * * * * * * * * * * * *
*/
/****************************************************************************
**
*F InitHandlerFunc( <handler>, <cookie> ) . . . . . . . . register a handler
**
** Every handler should be registered (once) before it is installed in any
** function bag. This is needed so that it can be identified when loading a
** saved workspace. <cookie> should be a unique C string, identifying the
** handler
*/
extern void InitHandlerRegistration( void );
extern void InitHandlerFunc (
ObjFunc hdlr,
const Char * cookie );
extern const Char * CookieOfHandler(
ObjFunc hdlr );
extern ObjFunc HandlerOfCookie (
const Char * cookie );
extern void SortHandlers( UInt byWhat );
/****************************************************************************
**
*F NewFunction( <name>, <narg>, <nams>, <hdlr> ) . . . make a new function
*F NewFunctionC( <name>, <narg>, <nams>, <hdlr> ) . . . make a new function
*F NewFunctionT( <type>, <size>, <name>, <narg>, <nams>, <hdlr> )
*F NewFunctionCT( <type>, <size>, <name>, <narg>, <nams>, <hdlr> )
**
** 'NewFunction' creates and returns a new function. <name> must be a GAP
** string containing the name of the function. <narg> must be the number of
** arguments, where -1 means a variable number of arguments. <nams> must be
** a GAP list containg the names of the arguments. <hdlr> must be the
** C function (accepting <self> and the <narg> arguments) that will be
** called to execute the function.
**
** 'NewFunctionC' does the same as 'NewFunction', but expects <name> and
** <nams> as C strings.
**
** 'NewFunctionT' does the same as 'NewFunction', but allows to specify the
** <type> and <size> of the newly created bag.
**
** 'NewFunctionCT' does the same as 'NewFunction', but expects <name> and
** <nams> as C strings, and allows to specify the <type> and <size> of the
** newly created bag.
*/
extern Obj NewFunction (
Obj name,
Int narg,
Obj nams,
ObjFunc hdlr );
extern Obj NewFunctionC (
const Char * name,
Int narg,
const Char * nams,
ObjFunc hdlr );
extern Obj NewFunctionT (
UInt type,
UInt size,
Obj name,
Int narg,
Obj nams,
ObjFunc hdlr );
extern Obj NewFunctionCT (
UInt type,
UInt size,
const Char * name,
Int narg,
const Char * nams,
ObjFunc hdlr );
/****************************************************************************
**
*F * * * * * * * * * * * * * type and print function * * * * * * * * * * * *
*/
/****************************************************************************
**
*F PrintFunction( <func> ) . . . . . . . . . . . . . . . print a function
**
** 'PrintFunction' prints the function <func> in abbreviated form if
** 'PrintObjFull' is false.
*/
extern void PrintFunction (
Obj func );
/****************************************************************************
**
*F FuncCALL_FUNC_LIST( <self>, <func>, <list> ) . . . . . . call a function
**
** 'FuncCALL_FUNC_LIST' implements the internal function 'CallFuncList'.
**
** 'CallFuncList( <func>, <list> )'
**
** 'CallFuncList' calls the function <func> with the arguments list <list>,
** i.e., it is equivalent to '<func>( <list>[1], <list>[2]... )'.
*/
extern Obj FuncCALL_FUNC_LIST (
Obj self,
Obj func,
Obj list );
extern Obj CallFuncListOper;
/****************************************************************************
**
*F * * * * * * * * * * * * * initialize package * * * * * * * * * * * * * * *
*/
/****************************************************************************
**
*F InitInfoCalls() . . . . . . . . . . . . . . . . . table of init functions
*/
StructInitInfo * InitInfoCalls ( void );
#endif // GAP_CALLS_H
/****************************************************************************
**
*E calls.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . ends here
*/
|