Update tcl to version 8.5.13
[msysgit/kirr.git] / mingw / include / tcl.h
blobe921ec5339337222b17be398aa286105bdec84be
1 /*
2 * tcl.h --
4 * This header file describes the externally-visible facilities of the
5 * Tcl interpreter.
7 * Copyright (c) 1987-1994 The Regents of the University of California.
8 * Copyright (c) 1993-1996 Lucent Technologies.
9 * Copyright (c) 1994-1998 Sun Microsystems, Inc.
10 * Copyright (c) 1998-2000 by Scriptics Corporation.
11 * Copyright (c) 2002 by Kevin B. Kenny. All rights reserved.
13 * See the file "license.terms" for information on usage and redistribution of
14 * this file, and for a DISCLAIMER OF ALL WARRANTIES.
17 #ifndef _TCL
18 #define _TCL
21 * For C++ compilers, use extern "C"
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
29 * The following defines are used to indicate the various release levels.
32 #define TCL_ALPHA_RELEASE 0
33 #define TCL_BETA_RELEASE 1
34 #define TCL_FINAL_RELEASE 2
37 * When version numbers change here, must also go into the following files and
38 * update the version numbers:
40 * library/init.tcl (1 LOC patch)
41 * unix/configure.in (2 LOC Major, 2 LOC minor, 1 LOC patch)
42 * win/configure.in (as above)
43 * win/tcl.m4 (not patchlevel)
44 * win/makefile.bc (not patchlevel) 2 LOC
45 * README (sections 0 and 2, with and without separator)
46 * macosx/Tcl.pbproj/project.pbxproj (not patchlevel) 1 LOC
47 * macosx/Tcl.pbproj/default.pbxuser (not patchlevel) 1 LOC
48 * macosx/Tcl.xcode/project.pbxproj (not patchlevel) 2 LOC
49 * macosx/Tcl.xcode/default.pbxuser (not patchlevel) 1 LOC
50 * macosx/Tcl-Common.xcconfig (not patchlevel) 1 LOC
51 * win/README (not patchlevel) (sections 0 and 2)
52 * unix/tcl.spec (1 LOC patch)
53 * tools/tcl.hpj.in (not patchlevel, for windows installer)
54 * tools/tcl.wse.in (for windows installer)
55 * tools/tclSplash.bmp (not patchlevel)
58 #define TCL_MAJOR_VERSION 8
59 #define TCL_MINOR_VERSION 5
60 #define TCL_RELEASE_LEVEL TCL_FINAL_RELEASE
61 #define TCL_RELEASE_SERIAL 13
63 #define TCL_VERSION "8.5"
64 #define TCL_PATCH_LEVEL "8.5.13"
67 * The following definitions set up the proper options for Windows compilers.
68 * We use this method because there is no autoconf equivalent.
71 #ifndef __WIN32__
72 # if defined(_WIN32) || defined(WIN32) || defined(__MINGW32__) || defined(__BORLANDC__) || (defined(__WATCOMC__) && defined(__WINDOWS_386__))
73 # define __WIN32__
74 # ifndef WIN32
75 # define WIN32
76 # endif
77 # ifndef _WIN32
78 # define _WIN32
79 # endif
80 # endif
81 #endif
84 * STRICT: See MSDN Article Q83456
87 #ifdef __WIN32__
88 # ifndef STRICT
89 # define STRICT
90 # endif
91 #endif /* __WIN32__ */
94 * Utility macros: STRINGIFY takes an argument and wraps it in "" (double
95 * quotation marks), JOIN joins two arguments.
98 #ifndef STRINGIFY
99 # define STRINGIFY(x) STRINGIFY1(x)
100 # define STRINGIFY1(x) #x
101 #endif
102 #ifndef JOIN
103 # define JOIN(a,b) JOIN1(a,b)
104 # define JOIN1(a,b) a##b
105 #endif
108 * A special definition used to allow this header file to be included from
109 * windows resource files so that they can obtain version information.
110 * RC_INVOKED is defined by default by the windows RC tool.
112 * Resource compilers don't like all the C stuff, like typedefs and function
113 * declarations, that occur below, so block them out.
116 #ifndef RC_INVOKED
119 * Special macro to define mutexes, that doesn't do anything if we are not
120 * using threads.
123 #ifdef TCL_THREADS
124 #define TCL_DECLARE_MUTEX(name) static Tcl_Mutex name;
125 #else
126 #define TCL_DECLARE_MUTEX(name)
127 #endif
130 * Tcl's public routine Tcl_FSSeek() uses the values SEEK_SET, SEEK_CUR, and
131 * SEEK_END, all #define'd by stdio.h .
133 * Also, many extensions need stdio.h, and they've grown accustomed to tcl.h
134 * providing it for them rather than #include-ing it themselves as they
135 * should, so also for their sake, we keep the #include to be consistent with
136 * prior Tcl releases.
139 #include <stdio.h>
142 * Support for functions with a variable number of arguments.
144 * The following TCL_VARARGS* macros are to support old extensions
145 * written for older versions of Tcl where the macros permitted
146 * support for the varargs.h system as well as stdarg.h .
148 * New code should just directly be written to use stdarg.h conventions.
151 #include <stdarg.h>
152 #ifndef TCL_NO_DEPRECATED
153 # define TCL_VARARGS(type, name) (type name, ...)
154 # define TCL_VARARGS_DEF(type, name) (type name, ...)
155 # define TCL_VARARGS_START(type, name, list) (va_start(list, name), name)
156 #endif
159 * Macros used to declare a function to be exported by a DLL. Used by Windows,
160 * maps to no-op declarations on non-Windows systems. The default build on
161 * windows is for a DLL, which causes the DLLIMPORT and DLLEXPORT macros to be
162 * nonempty. To build a static library, the macro STATIC_BUILD should be
163 * defined.
165 * Note: when building static but linking dynamically to MSVCRT we must still
166 * correctly decorate the C library imported function. Use CRTIMPORT
167 * for this purpose. _DLL is defined by the compiler when linking to
168 * MSVCRT.
171 #if (defined(__WIN32__) && (defined(_MSC_VER) || (__BORLANDC__ >= 0x0550) || defined(__LCC__) || defined(__WATCOMC__) || (defined(__GNUC__) && defined(__declspec))))
172 # define HAVE_DECLSPEC 1
173 # ifdef STATIC_BUILD
174 # define DLLIMPORT
175 # define DLLEXPORT
176 # ifdef _DLL
177 # define CRTIMPORT __declspec(dllimport)
178 # else
179 # define CRTIMPORT
180 # endif
181 # else
182 # define DLLIMPORT __declspec(dllimport)
183 # define DLLEXPORT __declspec(dllexport)
184 # define CRTIMPORT __declspec(dllimport)
185 # endif
186 #else
187 # define DLLIMPORT
188 # if defined(__GNUC__) && __GNUC__ > 3
189 # define DLLEXPORT __attribute__ ((visibility("default")))
190 # else
191 # define DLLEXPORT
192 # endif
193 # define CRTIMPORT
194 #endif
197 * These macros are used to control whether functions are being declared for
198 * import or export. If a function is being declared while it is being built
199 * to be included in a shared library, then it should have the DLLEXPORT
200 * storage class. If is being declared for use by a module that is going to
201 * link against the shared library, then it should have the DLLIMPORT storage
202 * class. If the symbol is beind declared for a static build or for use from a
203 * stub library, then the storage class should be empty.
205 * The convention is that a macro called BUILD_xxxx, where xxxx is the name of
206 * a library we are building, is set on the compile line for sources that are
207 * to be placed in the library. When this macro is set, the storage class will
208 * be set to DLLEXPORT. At the end of the header file, the storage class will
209 * be reset to DLLIMPORT.
212 #undef TCL_STORAGE_CLASS
213 #ifdef BUILD_tcl
214 # define TCL_STORAGE_CLASS DLLEXPORT
215 #else
216 # ifdef USE_TCL_STUBS
217 # define TCL_STORAGE_CLASS
218 # else
219 # define TCL_STORAGE_CLASS DLLIMPORT
220 # endif
221 #endif
224 * Definitions that allow this header file to be used either with or without
225 * ANSI C features like function prototypes.
228 #undef _ANSI_ARGS_
229 #undef CONST
230 #ifndef INLINE
231 # define INLINE
232 #endif
234 #ifndef NO_CONST
235 # define CONST const
236 #else
237 # define CONST
238 #endif
240 #ifndef NO_PROTOTYPES
241 # define _ANSI_ARGS_(x) x
242 #else
243 # define _ANSI_ARGS_(x) ()
244 #endif
246 #ifdef USE_NON_CONST
247 # ifdef USE_COMPAT_CONST
248 # error define at most one of USE_NON_CONST and USE_COMPAT_CONST
249 # endif
250 # define CONST84
251 # define CONST84_RETURN
252 #else
253 # ifdef USE_COMPAT_CONST
254 # define CONST84
255 # define CONST84_RETURN CONST
256 # else
257 # define CONST84 CONST
258 # define CONST84_RETURN CONST
259 # endif
260 #endif
263 * Make sure EXTERN isn't defined elsewhere.
266 #ifdef EXTERN
267 # undef EXTERN
268 #endif /* EXTERN */
270 #ifdef __cplusplus
271 # define EXTERN extern "C" TCL_STORAGE_CLASS
272 #else
273 # define EXTERN extern TCL_STORAGE_CLASS
274 #endif
277 * The following code is copied from winnt.h. If we don't replicate it here,
278 * then <windows.h> can't be included after tcl.h, since tcl.h also defines
279 * VOID. This block is skipped under Cygwin and Mingw.
282 #if defined(__WIN32__) && !defined(HAVE_WINNT_IGNORE_VOID)
283 #ifndef VOID
284 #define VOID void
285 typedef char CHAR;
286 typedef short SHORT;
287 typedef long LONG;
288 #endif
289 #endif /* __WIN32__ && !HAVE_WINNT_IGNORE_VOID */
292 * Macro to use instead of "void" for arguments that must have type "void *"
293 * in ANSI C; maps them to type "char *" in non-ANSI systems.
296 #ifndef NO_VOID
297 #define VOID void
298 #else
299 #define VOID char
300 #endif
303 * Miscellaneous declarations.
306 #ifndef _CLIENTDATA
307 # ifndef NO_VOID
308 typedef void *ClientData;
309 # else
310 typedef int *ClientData;
311 # endif
312 # define _CLIENTDATA
313 #endif
316 * Darwin specific configure overrides (to support fat compiles, where
317 * configure runs only once for multiple architectures):
320 #ifdef __APPLE__
321 # ifdef __LP64__
322 # undef TCL_WIDE_INT_TYPE
323 # define TCL_WIDE_INT_IS_LONG 1
324 # define TCL_CFG_DO64BIT 1
325 # else /* !__LP64__ */
326 # define TCL_WIDE_INT_TYPE long long
327 # undef TCL_WIDE_INT_IS_LONG
328 # undef TCL_CFG_DO64BIT
329 # endif /* __LP64__ */
330 # undef HAVE_STRUCT_STAT64
331 #endif /* __APPLE__ */
334 * Define Tcl_WideInt to be a type that is (at least) 64-bits wide, and define
335 * Tcl_WideUInt to be the unsigned variant of that type (assuming that where
336 * we have one, we can have the other.)
338 * Also defines the following macros:
339 * TCL_WIDE_INT_IS_LONG - if wide ints are really longs (i.e. we're on a real
340 * 64-bit system.)
341 * Tcl_WideAsLong - forgetful converter from wideInt to long.
342 * Tcl_LongAsWide - sign-extending converter from long to wideInt.
343 * Tcl_WideAsDouble - converter from wideInt to double.
344 * Tcl_DoubleAsWide - converter from double to wideInt.
346 * The following invariant should hold for any long value 'longVal':
347 * longVal == Tcl_WideAsLong(Tcl_LongAsWide(longVal))
349 * Note on converting between Tcl_WideInt and strings. This implementation (in
350 * tclObj.c) depends on the function
351 * sprintf(...,"%" TCL_LL_MODIFIER "d",...).
354 #if !defined(TCL_WIDE_INT_TYPE)&&!defined(TCL_WIDE_INT_IS_LONG)
355 # if defined(__WIN32__)
356 # define TCL_WIDE_INT_TYPE __int64
357 # ifdef __BORLANDC__
358 # define TCL_LL_MODIFIER "L"
359 # else /* __BORLANDC__ */
360 # define TCL_LL_MODIFIER "I64"
361 # endif /* __BORLANDC__ */
362 # elif defined(__GNUC__)
363 # define TCL_WIDE_INT_TYPE long long
364 # define TCL_LL_MODIFIER "ll"
365 # else /* ! __WIN32__ && ! __GNUC__ */
367 * Don't know what platform it is and configure hasn't discovered what is
368 * going on for us. Try to guess...
370 # ifdef NO_LIMITS_H
371 # error please define either TCL_WIDE_INT_TYPE or TCL_WIDE_INT_IS_LONG
372 # else /* !NO_LIMITS_H */
373 # include <limits.h>
374 # if (INT_MAX < LONG_MAX)
375 # define TCL_WIDE_INT_IS_LONG 1
376 # else
377 # define TCL_WIDE_INT_TYPE long long
378 # endif
379 # endif /* NO_LIMITS_H */
380 # endif /* __WIN32__ */
381 #endif /* !TCL_WIDE_INT_TYPE & !TCL_WIDE_INT_IS_LONG */
382 #ifdef TCL_WIDE_INT_IS_LONG
383 # undef TCL_WIDE_INT_TYPE
384 # define TCL_WIDE_INT_TYPE long
385 #endif /* TCL_WIDE_INT_IS_LONG */
387 typedef TCL_WIDE_INT_TYPE Tcl_WideInt;
388 typedef unsigned TCL_WIDE_INT_TYPE Tcl_WideUInt;
390 #ifdef TCL_WIDE_INT_IS_LONG
391 # define Tcl_WideAsLong(val) ((long)(val))
392 # define Tcl_LongAsWide(val) ((long)(val))
393 # define Tcl_WideAsDouble(val) ((double)((long)(val)))
394 # define Tcl_DoubleAsWide(val) ((long)((double)(val)))
395 # ifndef TCL_LL_MODIFIER
396 # define TCL_LL_MODIFIER "l"
397 # endif /* !TCL_LL_MODIFIER */
398 #else /* TCL_WIDE_INT_IS_LONG */
400 * The next short section of defines are only done when not running on Windows
401 * or some other strange platform.
403 # ifndef TCL_LL_MODIFIER
404 # define TCL_LL_MODIFIER "ll"
405 # endif /* !TCL_LL_MODIFIER */
406 # define Tcl_WideAsLong(val) ((long)((Tcl_WideInt)(val)))
407 # define Tcl_LongAsWide(val) ((Tcl_WideInt)((long)(val)))
408 # define Tcl_WideAsDouble(val) ((double)((Tcl_WideInt)(val)))
409 # define Tcl_DoubleAsWide(val) ((Tcl_WideInt)((double)(val)))
410 #endif /* TCL_WIDE_INT_IS_LONG */
412 #if defined(__WIN32__)
413 # ifdef __BORLANDC__
414 typedef struct stati64 Tcl_StatBuf;
415 # elif defined(_WIN64)
416 typedef struct __stat64 Tcl_StatBuf;
417 # elif (defined(_MSC_VER) && (_MSC_VER < 1400)) || defined(_USE_32BIT_TIME_T)
418 typedef struct _stati64 Tcl_StatBuf;
419 # else
420 typedef struct _stat32i64 Tcl_StatBuf;
421 # endif /* _MSC_VER < 1400 */
422 #elif defined(__CYGWIN__)
423 typedef struct _stat32i64 {
424 dev_t st_dev;
425 unsigned short st_ino;
426 unsigned short st_mode;
427 short st_nlink;
428 short st_uid;
429 short st_gid;
430 /* Here is a 2-byte gap */
431 dev_t st_rdev;
432 /* Here is a 4-byte gap */
433 long long st_size;
434 struct {long tv_sec;} st_atim;
435 struct {long tv_sec;} st_mtim;
436 struct {long tv_sec;} st_ctim;
437 /* Here is a 4-byte gap */
438 } Tcl_StatBuf;
439 #elif defined(HAVE_STRUCT_STAT64)
440 typedef struct stat64 Tcl_StatBuf;
441 #else
442 typedef struct stat Tcl_StatBuf;
443 #endif
446 * Data structures defined opaquely in this module. The definitions below just
447 * provide dummy types. A few fields are made visible in Tcl_Interp
448 * structures, namely those used for returning a string result from commands.
449 * Direct access to the result field is discouraged in Tcl 8.0. The
450 * interpreter result is either an object or a string, and the two values are
451 * kept consistent unless some C code sets interp->result directly.
452 * Programmers should use either the function Tcl_GetObjResult() or
453 * Tcl_GetStringResult() to read the interpreter's result. See the SetResult
454 * man page for details.
456 * Note: any change to the Tcl_Interp definition below must be mirrored in the
457 * "real" definition in tclInt.h.
459 * Note: Tcl_ObjCmdProc functions do not directly set result and freeProc.
460 * Instead, they set a Tcl_Obj member in the "real" structure that can be
461 * accessed with Tcl_GetObjResult() and Tcl_SetObjResult().
464 typedef struct Tcl_Interp {
465 char *result; /* If the last command returned a string
466 * result, this points to it. */
467 void (*freeProc) _ANSI_ARGS_((char *blockPtr));
468 /* Zero means the string result is statically
469 * allocated. TCL_DYNAMIC means it was
470 * allocated with ckalloc and should be freed
471 * with ckfree. Other values give the address
472 * of function to invoke to free the result.
473 * Tcl_Eval must free it before executing next
474 * command. */
475 int errorLine; /* When TCL_ERROR is returned, this gives the
476 * line number within the command where the
477 * error occurred (1 if first line). */
478 } Tcl_Interp;
480 typedef struct Tcl_AsyncHandler_ *Tcl_AsyncHandler;
481 typedef struct Tcl_Channel_ *Tcl_Channel;
482 typedef struct Tcl_ChannelTypeVersion_ *Tcl_ChannelTypeVersion;
483 typedef struct Tcl_Command_ *Tcl_Command;
484 typedef struct Tcl_Condition_ *Tcl_Condition;
485 typedef struct Tcl_Dict_ *Tcl_Dict;
486 typedef struct Tcl_EncodingState_ *Tcl_EncodingState;
487 typedef struct Tcl_Encoding_ *Tcl_Encoding;
488 typedef struct Tcl_Event Tcl_Event;
489 typedef struct Tcl_InterpState_ *Tcl_InterpState;
490 typedef struct Tcl_LoadHandle_ *Tcl_LoadHandle;
491 typedef struct Tcl_Mutex_ *Tcl_Mutex;
492 typedef struct Tcl_Pid_ *Tcl_Pid;
493 typedef struct Tcl_RegExp_ *Tcl_RegExp;
494 typedef struct Tcl_ThreadDataKey_ *Tcl_ThreadDataKey;
495 typedef struct Tcl_ThreadId_ *Tcl_ThreadId;
496 typedef struct Tcl_TimerToken_ *Tcl_TimerToken;
497 typedef struct Tcl_Trace_ *Tcl_Trace;
498 typedef struct Tcl_Var_ *Tcl_Var;
501 * Definition of the interface to functions implementing threads. A function
502 * following this definition is given to each call of 'Tcl_CreateThread' and
503 * will be called as the main fuction of the new thread created by that call.
506 #if defined __WIN32__
507 typedef unsigned (__stdcall Tcl_ThreadCreateProc) _ANSI_ARGS_((ClientData clientData));
508 #else
509 typedef void (Tcl_ThreadCreateProc) _ANSI_ARGS_((ClientData clientData));
510 #endif
513 * Threading function return types used for abstracting away platform
514 * differences when writing a Tcl_ThreadCreateProc. See the NewThread function
515 * in generic/tclThreadTest.c for it's usage.
518 #if defined __WIN32__
519 # define Tcl_ThreadCreateType unsigned __stdcall
520 # define TCL_THREAD_CREATE_RETURN return 0
521 #else
522 # define Tcl_ThreadCreateType void
523 # define TCL_THREAD_CREATE_RETURN
524 #endif
527 * Definition of values for default stacksize and the possible flags to be
528 * given to Tcl_CreateThread.
531 #define TCL_THREAD_STACK_DEFAULT (0) /* Use default size for stack. */
532 #define TCL_THREAD_NOFLAGS (0000) /* Standard flags, default
533 * behaviour. */
534 #define TCL_THREAD_JOINABLE (0001) /* Mark the thread as joinable. */
537 * Flag values passed to Tcl_StringCaseMatch.
540 #define TCL_MATCH_NOCASE (1<<0)
543 * Flag values passed to Tcl_GetRegExpFromObj.
546 #define TCL_REG_BASIC 000000 /* BREs (convenience). */
547 #define TCL_REG_EXTENDED 000001 /* EREs. */
548 #define TCL_REG_ADVF 000002 /* Advanced features in EREs. */
549 #define TCL_REG_ADVANCED 000003 /* AREs (which are also EREs). */
550 #define TCL_REG_QUOTE 000004 /* No special characters, none. */
551 #define TCL_REG_NOCASE 000010 /* Ignore case. */
552 #define TCL_REG_NOSUB 000020 /* Don't care about subexpressions. */
553 #define TCL_REG_EXPANDED 000040 /* Expanded format, white space &
554 * comments. */
555 #define TCL_REG_NLSTOP 000100 /* \n doesn't match . or [^ ] */
556 #define TCL_REG_NLANCH 000200 /* ^ matches after \n, $ before. */
557 #define TCL_REG_NEWLINE 000300 /* Newlines are line terminators. */
558 #define TCL_REG_CANMATCH 001000 /* Report details on partial/limited
559 * matches. */
562 * Flags values passed to Tcl_RegExpExecObj.
565 #define TCL_REG_NOTBOL 0001 /* Beginning of string does not match ^. */
566 #define TCL_REG_NOTEOL 0002 /* End of string does not match $. */
569 * Structures filled in by Tcl_RegExpInfo. Note that all offset values are
570 * relative to the start of the match string, not the beginning of the entire
571 * string.
574 typedef struct Tcl_RegExpIndices {
575 long start; /* Character offset of first character in
576 * match. */
577 long end; /* Character offset of first character after
578 * the match. */
579 } Tcl_RegExpIndices;
581 typedef struct Tcl_RegExpInfo {
582 int nsubs; /* Number of subexpressions in the compiled
583 * expression. */
584 Tcl_RegExpIndices *matches; /* Array of nsubs match offset pairs. */
585 long extendStart; /* The offset at which a subsequent match
586 * might begin. */
587 long reserved; /* Reserved for later use. */
588 } Tcl_RegExpInfo;
591 * Picky compilers complain if this typdef doesn't appear before the struct's
592 * reference in tclDecls.h.
595 typedef Tcl_StatBuf *Tcl_Stat_;
596 typedef struct stat *Tcl_OldStat_;
599 * When a TCL command returns, the interpreter contains a result from the
600 * command. Programmers are strongly encouraged to use one of the functions
601 * Tcl_GetObjResult() or Tcl_GetStringResult() to read the interpreter's
602 * result. See the SetResult man page for details. Besides this result, the
603 * command function returns an integer code, which is one of the following:
605 * TCL_OK Command completed normally; the interpreter's result
606 * contains the command's result.
607 * TCL_ERROR The command couldn't be completed successfully; the
608 * interpreter's result describes what went wrong.
609 * TCL_RETURN The command requests that the current function return;
610 * the interpreter's result contains the function's
611 * return value.
612 * TCL_BREAK The command requests that the innermost loop be
613 * exited; the interpreter's result is meaningless.
614 * TCL_CONTINUE Go on to the next iteration of the current loop; the
615 * interpreter's result is meaningless.
618 #define TCL_OK 0
619 #define TCL_ERROR 1
620 #define TCL_RETURN 2
621 #define TCL_BREAK 3
622 #define TCL_CONTINUE 4
624 #define TCL_RESULT_SIZE 200
627 * Flags to control what substitutions are performed by Tcl_SubstObj():
630 #define TCL_SUBST_COMMANDS 001
631 #define TCL_SUBST_VARIABLES 002
632 #define TCL_SUBST_BACKSLASHES 004
633 #define TCL_SUBST_ALL 007
636 * Argument descriptors for math function callbacks in expressions:
639 typedef enum {
640 TCL_INT, TCL_DOUBLE, TCL_EITHER, TCL_WIDE_INT
641 } Tcl_ValueType;
643 typedef struct Tcl_Value {
644 Tcl_ValueType type; /* Indicates intValue or doubleValue is valid,
645 * or both. */
646 long intValue; /* Integer value. */
647 double doubleValue; /* Double-precision floating value. */
648 Tcl_WideInt wideValue; /* Wide (min. 64-bit) integer value. */
649 } Tcl_Value;
652 * Forward declaration of Tcl_Obj to prevent an error when the forward
653 * reference to Tcl_Obj is encountered in the function types declared below.
656 struct Tcl_Obj;
659 * Function types defined by Tcl:
662 typedef int (Tcl_AppInitProc) _ANSI_ARGS_((Tcl_Interp *interp));
663 typedef int (Tcl_AsyncProc) _ANSI_ARGS_((ClientData clientData,
664 Tcl_Interp *interp, int code));
665 typedef void (Tcl_ChannelProc) _ANSI_ARGS_((ClientData clientData, int mask));
666 typedef void (Tcl_CloseProc) _ANSI_ARGS_((ClientData data));
667 typedef void (Tcl_CmdDeleteProc) _ANSI_ARGS_((ClientData clientData));
668 typedef int (Tcl_CmdProc) _ANSI_ARGS_((ClientData clientData,
669 Tcl_Interp *interp, int argc, CONST84 char *argv[]));
670 typedef void (Tcl_CmdTraceProc) _ANSI_ARGS_((ClientData clientData,
671 Tcl_Interp *interp, int level, char *command, Tcl_CmdProc *proc,
672 ClientData cmdClientData, int argc, CONST84 char *argv[]));
673 typedef int (Tcl_CmdObjTraceProc) _ANSI_ARGS_((ClientData clientData,
674 Tcl_Interp *interp, int level, CONST char *command,
675 Tcl_Command commandInfo, int objc, struct Tcl_Obj * CONST * objv));
676 typedef void (Tcl_CmdObjTraceDeleteProc) _ANSI_ARGS_((ClientData clientData));
677 typedef void (Tcl_DupInternalRepProc) _ANSI_ARGS_((struct Tcl_Obj *srcPtr,
678 struct Tcl_Obj *dupPtr));
679 typedef int (Tcl_EncodingConvertProc)_ANSI_ARGS_((ClientData clientData,
680 CONST char *src, int srcLen, int flags, Tcl_EncodingState *statePtr,
681 char *dst, int dstLen, int *srcReadPtr, int *dstWrotePtr,
682 int *dstCharsPtr));
683 typedef void (Tcl_EncodingFreeProc)_ANSI_ARGS_((ClientData clientData));
684 typedef int (Tcl_EventProc) _ANSI_ARGS_((Tcl_Event *evPtr, int flags));
685 typedef void (Tcl_EventCheckProc) _ANSI_ARGS_((ClientData clientData,
686 int flags));
687 typedef int (Tcl_EventDeleteProc) _ANSI_ARGS_((Tcl_Event *evPtr,
688 ClientData clientData));
689 typedef void (Tcl_EventSetupProc) _ANSI_ARGS_((ClientData clientData,
690 int flags));
691 typedef void (Tcl_ExitProc) _ANSI_ARGS_((ClientData clientData));
692 typedef void (Tcl_FileProc) _ANSI_ARGS_((ClientData clientData, int mask));
693 typedef void (Tcl_FileFreeProc) _ANSI_ARGS_((ClientData clientData));
694 typedef void (Tcl_FreeInternalRepProc) _ANSI_ARGS_((struct Tcl_Obj *objPtr));
695 typedef void (Tcl_FreeProc) _ANSI_ARGS_((char *blockPtr));
696 typedef void (Tcl_IdleProc) _ANSI_ARGS_((ClientData clientData));
697 typedef void (Tcl_InterpDeleteProc) _ANSI_ARGS_((ClientData clientData,
698 Tcl_Interp *interp));
699 typedef int (Tcl_MathProc) _ANSI_ARGS_((ClientData clientData,
700 Tcl_Interp *interp, Tcl_Value *args, Tcl_Value *resultPtr));
701 typedef void (Tcl_NamespaceDeleteProc) _ANSI_ARGS_((ClientData clientData));
702 typedef int (Tcl_ObjCmdProc) _ANSI_ARGS_((ClientData clientData,
703 Tcl_Interp *interp, int objc, struct Tcl_Obj * CONST * objv));
704 typedef int (Tcl_PackageInitProc) _ANSI_ARGS_((Tcl_Interp *interp));
705 typedef int (Tcl_PackageUnloadProc) _ANSI_ARGS_((Tcl_Interp *interp,
706 int flags));
707 typedef void (Tcl_PanicProc) _ANSI_ARGS_((CONST char *format, ...));
708 typedef void (Tcl_TcpAcceptProc) _ANSI_ARGS_((ClientData callbackData,
709 Tcl_Channel chan, char *address, int port));
710 typedef void (Tcl_TimerProc) _ANSI_ARGS_((ClientData clientData));
711 typedef int (Tcl_SetFromAnyProc) _ANSI_ARGS_((Tcl_Interp *interp,
712 struct Tcl_Obj *objPtr));
713 typedef void (Tcl_UpdateStringProc) _ANSI_ARGS_((struct Tcl_Obj *objPtr));
714 typedef char *(Tcl_VarTraceProc) _ANSI_ARGS_((ClientData clientData,
715 Tcl_Interp *interp, CONST84 char *part1, CONST84 char *part2,
716 int flags));
717 typedef void (Tcl_CommandTraceProc) _ANSI_ARGS_((ClientData clientData,
718 Tcl_Interp *interp, CONST char *oldName, CONST char *newName,
719 int flags));
720 typedef void (Tcl_CreateFileHandlerProc) _ANSI_ARGS_((int fd, int mask,
721 Tcl_FileProc *proc, ClientData clientData));
722 typedef void (Tcl_DeleteFileHandlerProc) _ANSI_ARGS_((int fd));
723 typedef void (Tcl_AlertNotifierProc) _ANSI_ARGS_((ClientData clientData));
724 typedef void (Tcl_ServiceModeHookProc) _ANSI_ARGS_((int mode));
725 typedef ClientData (Tcl_InitNotifierProc) _ANSI_ARGS_((VOID));
726 typedef void (Tcl_FinalizeNotifierProc) _ANSI_ARGS_((ClientData clientData));
727 typedef void (Tcl_MainLoopProc) _ANSI_ARGS_((void));
730 * The following structure represents a type of object, which is a particular
731 * internal representation for an object plus a set of functions that provide
732 * standard operations on objects of that type.
735 typedef struct Tcl_ObjType {
736 char *name; /* Name of the type, e.g. "int". */
737 Tcl_FreeInternalRepProc *freeIntRepProc;
738 /* Called to free any storage for the type's
739 * internal rep. NULL if the internal rep does
740 * not need freeing. */
741 Tcl_DupInternalRepProc *dupIntRepProc;
742 /* Called to create a new object as a copy of
743 * an existing object. */
744 Tcl_UpdateStringProc *updateStringProc;
745 /* Called to update the string rep from the
746 * type's internal representation. */
747 Tcl_SetFromAnyProc *setFromAnyProc;
748 /* Called to convert the object's internal rep
749 * to this type. Frees the internal rep of the
750 * old type. Returns TCL_ERROR on failure. */
751 } Tcl_ObjType;
754 * One of the following structures exists for each object in the Tcl system.
755 * An object stores a value as either a string, some internal representation,
756 * or both.
759 typedef struct Tcl_Obj {
760 int refCount; /* When 0 the object will be freed. */
761 char *bytes; /* This points to the first byte of the
762 * object's string representation. The array
763 * must be followed by a null byte (i.e., at
764 * offset length) but may also contain
765 * embedded null characters. The array's
766 * storage is allocated by ckalloc. NULL means
767 * the string rep is invalid and must be
768 * regenerated from the internal rep. Clients
769 * should use Tcl_GetStringFromObj or
770 * Tcl_GetString to get a pointer to the byte
771 * array as a readonly value. */
772 int length; /* The number of bytes at *bytes, not
773 * including the terminating null. */
774 Tcl_ObjType *typePtr; /* Denotes the object's type. Always
775 * corresponds to the type of the object's
776 * internal rep. NULL indicates the object has
777 * no internal rep (has no type). */
778 union { /* The internal representation: */
779 long longValue; /* - an long integer value. */
780 double doubleValue; /* - a double-precision floating value. */
781 VOID *otherValuePtr; /* - another, type-specific value. */
782 Tcl_WideInt wideValue; /* - a long long value. */
783 struct { /* - internal rep as two pointers. */
784 VOID *ptr1;
785 VOID *ptr2;
786 } twoPtrValue;
787 struct { /* - internal rep as a wide int, tightly
788 * packed fields. */
789 VOID *ptr; /* Pointer to digits. */
790 unsigned long value;/* Alloc, used, and signum packed into a
791 * single word. */
792 } ptrAndLongRep;
793 } internalRep;
794 } Tcl_Obj;
797 * Macros to increment and decrement a Tcl_Obj's reference count, and to test
798 * whether an object is shared (i.e. has reference count > 1). Note: clients
799 * should use Tcl_DecrRefCount() when they are finished using an object, and
800 * should never call TclFreeObj() directly. TclFreeObj() is only defined and
801 * made public in tcl.h to support Tcl_DecrRefCount's macro definition. Note
802 * also that Tcl_DecrRefCount() refers to the parameter "obj" twice. This
803 * means that you should avoid calling it with an expression that is expensive
804 * to compute or has side effects.
807 void Tcl_IncrRefCount _ANSI_ARGS_((Tcl_Obj *objPtr));
808 void Tcl_DecrRefCount _ANSI_ARGS_((Tcl_Obj *objPtr));
809 int Tcl_IsShared _ANSI_ARGS_((Tcl_Obj *objPtr));
812 * The following structure contains the state needed by Tcl_SaveResult. No-one
813 * outside of Tcl should access any of these fields. This structure is
814 * typically allocated on the stack.
817 typedef struct Tcl_SavedResult {
818 char *result;
819 Tcl_FreeProc *freeProc;
820 Tcl_Obj *objResultPtr;
821 char *appendResult;
822 int appendAvl;
823 int appendUsed;
824 char resultSpace[TCL_RESULT_SIZE+1];
825 } Tcl_SavedResult;
828 * The following definitions support Tcl's namespace facility. Note: the first
829 * five fields must match exactly the fields in a Namespace structure (see
830 * tclInt.h).
833 typedef struct Tcl_Namespace {
834 char *name; /* The namespace's name within its parent
835 * namespace. This contains no ::'s. The name
836 * of the global namespace is "" although "::"
837 * is an synonym. */
838 char *fullName; /* The namespace's fully qualified name. This
839 * starts with ::. */
840 ClientData clientData; /* Arbitrary value associated with this
841 * namespace. */
842 Tcl_NamespaceDeleteProc *deleteProc;
843 /* Function invoked when deleting the
844 * namespace to, e.g., free clientData. */
845 struct Tcl_Namespace *parentPtr;
846 /* Points to the namespace that contains this
847 * one. NULL if this is the global
848 * namespace. */
849 } Tcl_Namespace;
852 * The following structure represents a call frame, or activation record. A
853 * call frame defines a naming context for a procedure call: its local scope
854 * (for local variables) and its namespace scope (used for non-local
855 * variables; often the global :: namespace). A call frame can also define the
856 * naming context for a namespace eval or namespace inscope command: the
857 * namespace in which the command's code should execute. The Tcl_CallFrame
858 * structures exist only while procedures or namespace eval/inscope's are
859 * being executed, and provide a Tcl call stack.
861 * A call frame is initialized and pushed using Tcl_PushCallFrame and popped
862 * using Tcl_PopCallFrame. Storage for a Tcl_CallFrame must be provided by the
863 * Tcl_PushCallFrame caller, and callers typically allocate them on the C call
864 * stack for efficiency. For this reason, Tcl_CallFrame is defined as a
865 * structure and not as an opaque token. However, most Tcl_CallFrame fields
866 * are hidden since applications should not access them directly; others are
867 * declared as "dummyX".
869 * WARNING!! The structure definition must be kept consistent with the
870 * CallFrame structure in tclInt.h. If you change one, change the other.
873 typedef struct Tcl_CallFrame {
874 Tcl_Namespace *nsPtr;
875 int dummy1;
876 int dummy2;
877 VOID *dummy3;
878 VOID *dummy4;
879 VOID *dummy5;
880 int dummy6;
881 VOID *dummy7;
882 VOID *dummy8;
883 int dummy9;
884 VOID *dummy10;
885 VOID *dummy11;
886 VOID *dummy12;
887 VOID *dummy13;
888 } Tcl_CallFrame;
891 * Information about commands that is returned by Tcl_GetCommandInfo and
892 * passed to Tcl_SetCommandInfo. objProc is an objc/objv object-based command
893 * function while proc is a traditional Tcl argc/argv string-based function.
894 * Tcl_CreateObjCommand and Tcl_CreateCommand ensure that both objProc and
895 * proc are non-NULL and can be called to execute the command. However, it may
896 * be faster to call one instead of the other. The member isNativeObjectProc
897 * is set to 1 if an object-based function was registered by
898 * Tcl_CreateObjCommand, and to 0 if a string-based function was registered by
899 * Tcl_CreateCommand. The other function is typically set to a compatibility
900 * wrapper that does string-to-object or object-to-string argument conversions
901 * then calls the other function.
904 typedef struct Tcl_CmdInfo {
905 int isNativeObjectProc; /* 1 if objProc was registered by a call to
906 * Tcl_CreateObjCommand; 0 otherwise.
907 * Tcl_SetCmdInfo does not modify this
908 * field. */
909 Tcl_ObjCmdProc *objProc; /* Command's object-based function. */
910 ClientData objClientData; /* ClientData for object proc. */
911 Tcl_CmdProc *proc; /* Command's string-based function. */
912 ClientData clientData; /* ClientData for string proc. */
913 Tcl_CmdDeleteProc *deleteProc;
914 /* Function to call when command is
915 * deleted. */
916 ClientData deleteData; /* Value to pass to deleteProc (usually the
917 * same as clientData). */
918 Tcl_Namespace *namespacePtr;/* Points to the namespace that contains this
919 * command. Note that Tcl_SetCmdInfo will not
920 * change a command's namespace; use
921 * TclRenameCommand or Tcl_Eval (of 'rename')
922 * to do that. */
923 } Tcl_CmdInfo;
926 * The structure defined below is used to hold dynamic strings. The only
927 * fields that clients should use are string and length, accessible via the
928 * macros Tcl_DStringValue and Tcl_DStringLength.
931 #define TCL_DSTRING_STATIC_SIZE 200
932 typedef struct Tcl_DString {
933 char *string; /* Points to beginning of string: either
934 * staticSpace below or a malloced array. */
935 int length; /* Number of non-NULL characters in the
936 * string. */
937 int spaceAvl; /* Total number of bytes available for the
938 * string and its terminating NULL char. */
939 char staticSpace[TCL_DSTRING_STATIC_SIZE];
940 /* Space to use in common case where string is
941 * small. */
942 } Tcl_DString;
944 #define Tcl_DStringLength(dsPtr) ((dsPtr)->length)
945 #define Tcl_DStringValue(dsPtr) ((dsPtr)->string)
946 #define Tcl_DStringTrunc Tcl_DStringSetLength
949 * Definitions for the maximum number of digits of precision that may be
950 * specified in the "tcl_precision" variable, and the number of bytes of
951 * buffer space required by Tcl_PrintDouble.
954 #define TCL_MAX_PREC 17
955 #define TCL_DOUBLE_SPACE (TCL_MAX_PREC+10)
958 * Definition for a number of bytes of buffer space sufficient to hold the
959 * string representation of an integer in base 10 (assuming the existence of
960 * 64-bit integers).
963 #define TCL_INTEGER_SPACE 24
966 * Flag values passed to Tcl_ConvertElement.
967 * TCL_DONT_USE_BRACES forces it not to enclose the element in braces, but to
968 * use backslash quoting instead.
969 * TCL_DONT_QUOTE_HASH disables the default quoting of the '#' character. It
970 * is safe to leave the hash unquoted when the element is not the first
971 * element of a list, and this flag can be used by the caller to indicate
972 * that condition.
975 #define TCL_DONT_USE_BRACES 1
976 #define TCL_DONT_QUOTE_HASH 8
979 * Flag that may be passed to Tcl_GetIndexFromObj to force it to disallow
980 * abbreviated strings.
983 #define TCL_EXACT 1
986 * Flag values passed to Tcl_RecordAndEval, Tcl_EvalObj, Tcl_EvalObjv.
987 * WARNING: these bit choices must not conflict with the bit choices for
988 * evalFlag bits in tclInt.h!
990 * Meanings:
991 * TCL_NO_EVAL: Just record this command
992 * TCL_EVAL_GLOBAL: Execute script in global namespace
993 * TCL_EVAL_DIRECT: Do not compile this script
994 * TCL_EVAL_INVOKE: Magical Tcl_EvalObjv mode for aliases/ensembles
995 * o Run in iPtr->lookupNsPtr or global namespace
996 * o Cut out of error traces
997 * o Don't reset the flags controlling ensemble
998 * error message rewriting.
1000 #define TCL_NO_EVAL 0x10000
1001 #define TCL_EVAL_GLOBAL 0x20000
1002 #define TCL_EVAL_DIRECT 0x40000
1003 #define TCL_EVAL_INVOKE 0x80000
1006 * Special freeProc values that may be passed to Tcl_SetResult (see the man
1007 * page for details):
1010 #define TCL_VOLATILE ((Tcl_FreeProc *) 1)
1011 #define TCL_STATIC ((Tcl_FreeProc *) 0)
1012 #define TCL_DYNAMIC ((Tcl_FreeProc *) 3)
1015 * Flag values passed to variable-related functions.
1018 #define TCL_GLOBAL_ONLY 1
1019 #define TCL_NAMESPACE_ONLY 2
1020 #define TCL_APPEND_VALUE 4
1021 #define TCL_LIST_ELEMENT 8
1022 #define TCL_TRACE_READS 0x10
1023 #define TCL_TRACE_WRITES 0x20
1024 #define TCL_TRACE_UNSETS 0x40
1025 #define TCL_TRACE_DESTROYED 0x80
1026 #define TCL_INTERP_DESTROYED 0x100
1027 #define TCL_LEAVE_ERR_MSG 0x200
1028 #define TCL_TRACE_ARRAY 0x800
1029 #ifndef TCL_REMOVE_OBSOLETE_TRACES
1030 /* Required to support old variable/vdelete/vinfo traces */
1031 #define TCL_TRACE_OLD_STYLE 0x1000
1032 #endif
1033 /* Indicate the semantics of the result of a trace */
1034 #define TCL_TRACE_RESULT_DYNAMIC 0x8000
1035 #define TCL_TRACE_RESULT_OBJECT 0x10000
1038 * Flag values for ensemble commands.
1041 #define TCL_ENSEMBLE_PREFIX 0x02/* Flag value to say whether to allow
1042 * unambiguous prefixes of commands or to
1043 * require exact matches for command names. */
1046 * Flag values passed to command-related functions.
1049 #define TCL_TRACE_RENAME 0x2000
1050 #define TCL_TRACE_DELETE 0x4000
1052 #define TCL_ALLOW_INLINE_COMPILATION 0x20000
1055 * The TCL_PARSE_PART1 flag is deprecated and has no effect. The part1 is now
1056 * always parsed whenever the part2 is NULL. (This is to avoid a common error
1057 * when converting code to use the new object based APIs and forgetting to
1058 * give the flag)
1061 #ifndef TCL_NO_DEPRECATED
1062 # define TCL_PARSE_PART1 0x400
1063 #endif
1066 * Types for linked variables:
1069 #define TCL_LINK_INT 1
1070 #define TCL_LINK_DOUBLE 2
1071 #define TCL_LINK_BOOLEAN 3
1072 #define TCL_LINK_STRING 4
1073 #define TCL_LINK_WIDE_INT 5
1074 #define TCL_LINK_CHAR 6
1075 #define TCL_LINK_UCHAR 7
1076 #define TCL_LINK_SHORT 8
1077 #define TCL_LINK_USHORT 9
1078 #define TCL_LINK_UINT 10
1079 #define TCL_LINK_LONG 11
1080 #define TCL_LINK_ULONG 12
1081 #define TCL_LINK_FLOAT 13
1082 #define TCL_LINK_WIDE_UINT 14
1083 #define TCL_LINK_READ_ONLY 0x80
1086 * Forward declarations of Tcl_HashTable and related types.
1089 typedef struct Tcl_HashKeyType Tcl_HashKeyType;
1090 typedef struct Tcl_HashTable Tcl_HashTable;
1091 typedef struct Tcl_HashEntry Tcl_HashEntry;
1093 typedef unsigned int (Tcl_HashKeyProc) _ANSI_ARGS_((Tcl_HashTable *tablePtr,
1094 VOID *keyPtr));
1095 typedef int (Tcl_CompareHashKeysProc) _ANSI_ARGS_((VOID *keyPtr,
1096 Tcl_HashEntry *hPtr));
1097 typedef Tcl_HashEntry *(Tcl_AllocHashEntryProc) _ANSI_ARGS_((
1098 Tcl_HashTable *tablePtr, VOID *keyPtr));
1099 typedef void (Tcl_FreeHashEntryProc) _ANSI_ARGS_((Tcl_HashEntry *hPtr));
1102 * This flag controls whether the hash table stores the hash of a key, or
1103 * recalculates it. There should be no reason for turning this flag off as it
1104 * is completely binary and source compatible unless you directly access the
1105 * bucketPtr member of the Tcl_HashTableEntry structure. This member has been
1106 * removed and the space used to store the hash value.
1109 #ifndef TCL_HASH_KEY_STORE_HASH
1110 # define TCL_HASH_KEY_STORE_HASH 1
1111 #endif
1114 * Structure definition for an entry in a hash table. No-one outside Tcl
1115 * should access any of these fields directly; use the macros defined below.
1118 struct Tcl_HashEntry {
1119 Tcl_HashEntry *nextPtr; /* Pointer to next entry in this hash bucket,
1120 * or NULL for end of chain. */
1121 Tcl_HashTable *tablePtr; /* Pointer to table containing entry. */
1122 #if TCL_HASH_KEY_STORE_HASH
1123 VOID *hash; /* Hash value, stored as pointer to ensure
1124 * that the offsets of the fields in this
1125 * structure are not changed. */
1126 #else
1127 Tcl_HashEntry **bucketPtr; /* Pointer to bucket that points to first
1128 * entry in this entry's chain: used for
1129 * deleting the entry. */
1130 #endif
1131 ClientData clientData; /* Application stores something here with
1132 * Tcl_SetHashValue. */
1133 union { /* Key has one of these forms: */
1134 char *oneWordValue; /* One-word value for key. */
1135 Tcl_Obj *objPtr; /* Tcl_Obj * key value. */
1136 int words[1]; /* Multiple integer words for key. The actual
1137 * size will be as large as necessary for this
1138 * table's keys. */
1139 char string[4]; /* String for key. The actual size will be as
1140 * large as needed to hold the key. */
1141 } key; /* MUST BE LAST FIELD IN RECORD!! */
1145 * Flags used in Tcl_HashKeyType.
1147 * TCL_HASH_KEY_RANDOMIZE_HASH -
1148 * There are some things, pointers for example
1149 * which don't hash well because they do not use
1150 * the lower bits. If this flag is set then the
1151 * hash table will attempt to rectify this by
1152 * randomising the bits and then using the upper
1153 * N bits as the index into the table.
1154 * TCL_HASH_KEY_SYSTEM_HASH - If this flag is set then all memory internally
1155 * allocated for the hash table that is not for an
1156 * entry will use the system heap.
1159 #define TCL_HASH_KEY_RANDOMIZE_HASH 0x1
1160 #define TCL_HASH_KEY_SYSTEM_HASH 0x2
1163 * Structure definition for the methods associated with a hash table key type.
1166 #define TCL_HASH_KEY_TYPE_VERSION 1
1167 struct Tcl_HashKeyType {
1168 int version; /* Version of the table. If this structure is
1169 * extended in future then the version can be
1170 * used to distinguish between different
1171 * structures. */
1172 int flags; /* Flags, see above for details. */
1173 Tcl_HashKeyProc *hashKeyProc;
1174 /* Calculates a hash value for the key. If
1175 * this is NULL then the pointer itself is
1176 * used as a hash value. */
1177 Tcl_CompareHashKeysProc *compareKeysProc;
1178 /* Compares two keys and returns zero if they
1179 * do not match, and non-zero if they do. If
1180 * this is NULL then the pointers are
1181 * compared. */
1182 Tcl_AllocHashEntryProc *allocEntryProc;
1183 /* Called to allocate memory for a new entry,
1184 * i.e. if the key is a string then this could
1185 * allocate a single block which contains
1186 * enough space for both the entry and the
1187 * string. Only the key field of the allocated
1188 * Tcl_HashEntry structure needs to be filled
1189 * in. If something else needs to be done to
1190 * the key, i.e. incrementing a reference
1191 * count then that should be done by this
1192 * function. If this is NULL then Tcl_Alloc is
1193 * used to allocate enough space for a
1194 * Tcl_HashEntry and the key pointer is
1195 * assigned to key.oneWordValue. */
1196 Tcl_FreeHashEntryProc *freeEntryProc;
1197 /* Called to free memory associated with an
1198 * entry. If something else needs to be done
1199 * to the key, i.e. decrementing a reference
1200 * count then that should be done by this
1201 * function. If this is NULL then Tcl_Free is
1202 * used to free the Tcl_HashEntry. */
1206 * Structure definition for a hash table. Must be in tcl.h so clients can
1207 * allocate space for these structures, but clients should never access any
1208 * fields in this structure.
1211 #define TCL_SMALL_HASH_TABLE 4
1212 struct Tcl_HashTable {
1213 Tcl_HashEntry **buckets; /* Pointer to bucket array. Each element
1214 * points to first entry in bucket's hash
1215 * chain, or NULL. */
1216 Tcl_HashEntry *staticBuckets[TCL_SMALL_HASH_TABLE];
1217 /* Bucket array used for small tables (to
1218 * avoid mallocs and frees). */
1219 int numBuckets; /* Total number of buckets allocated at
1220 * **bucketPtr. */
1221 int numEntries; /* Total number of entries present in
1222 * table. */
1223 int rebuildSize; /* Enlarge table when numEntries gets to be
1224 * this large. */
1225 int downShift; /* Shift count used in hashing function.
1226 * Designed to use high-order bits of
1227 * randomized keys. */
1228 int mask; /* Mask value used in hashing function. */
1229 int keyType; /* Type of keys used in this table. It's
1230 * either TCL_CUSTOM_KEYS, TCL_STRING_KEYS,
1231 * TCL_ONE_WORD_KEYS, or an integer giving the
1232 * number of ints that is the size of the
1233 * key. */
1234 Tcl_HashEntry *(*findProc) _ANSI_ARGS_((Tcl_HashTable *tablePtr,
1235 CONST char *key));
1236 Tcl_HashEntry *(*createProc) _ANSI_ARGS_((Tcl_HashTable *tablePtr,
1237 CONST char *key, int *newPtr));
1238 Tcl_HashKeyType *typePtr; /* Type of the keys used in the
1239 * Tcl_HashTable. */
1243 * Structure definition for information used to keep track of searches through
1244 * hash tables:
1247 typedef struct Tcl_HashSearch {
1248 Tcl_HashTable *tablePtr; /* Table being searched. */
1249 int nextIndex; /* Index of next bucket to be enumerated after
1250 * present one. */
1251 Tcl_HashEntry *nextEntryPtr;/* Next entry to be enumerated in the current
1252 * bucket. */
1253 } Tcl_HashSearch;
1256 * Acceptable key types for hash tables:
1258 * TCL_STRING_KEYS: The keys are strings, they are copied into the
1259 * entry.
1260 * TCL_ONE_WORD_KEYS: The keys are pointers, the pointer is stored
1261 * in the entry.
1262 * TCL_CUSTOM_TYPE_KEYS: The keys are arbitrary types which are copied
1263 * into the entry.
1264 * TCL_CUSTOM_PTR_KEYS: The keys are pointers to arbitrary types, the
1265 * pointer is stored in the entry.
1267 * While maintaining binary compatability the above have to be distinct values
1268 * as they are used to differentiate between old versions of the hash table
1269 * which don't have a typePtr and new ones which do. Once binary compatability
1270 * is discarded in favour of making more wide spread changes TCL_STRING_KEYS
1271 * can be the same as TCL_CUSTOM_TYPE_KEYS, and TCL_ONE_WORD_KEYS can be the
1272 * same as TCL_CUSTOM_PTR_KEYS because they simply determine how the key is
1273 * accessed from the entry and not the behaviour.
1276 #define TCL_STRING_KEYS 0
1277 #define TCL_ONE_WORD_KEYS 1
1278 #define TCL_CUSTOM_TYPE_KEYS -2
1279 #define TCL_CUSTOM_PTR_KEYS -1
1282 * Structure definition for information used to keep track of searches through
1283 * dictionaries. These fields should not be accessed by code outside
1284 * tclDictObj.c
1287 typedef struct {
1288 void *next; /* Search position for underlying hash
1289 * table. */
1290 int epoch; /* Epoch marker for dictionary being searched,
1291 * or -1 if search has terminated. */
1292 Tcl_Dict dictionaryPtr; /* Reference to dictionary being searched. */
1293 } Tcl_DictSearch;
1296 * Flag values to pass to Tcl_DoOneEvent to disable searches for some kinds of
1297 * events:
1300 #define TCL_DONT_WAIT (1<<1)
1301 #define TCL_WINDOW_EVENTS (1<<2)
1302 #define TCL_FILE_EVENTS (1<<3)
1303 #define TCL_TIMER_EVENTS (1<<4)
1304 #define TCL_IDLE_EVENTS (1<<5) /* WAS 0x10 ???? */
1305 #define TCL_ALL_EVENTS (~TCL_DONT_WAIT)
1308 * The following structure defines a generic event for the Tcl event system.
1309 * These are the things that are queued in calls to Tcl_QueueEvent and
1310 * serviced later by Tcl_DoOneEvent. There can be many different kinds of
1311 * events with different fields, corresponding to window events, timer events,
1312 * etc. The structure for a particular event consists of a Tcl_Event header
1313 * followed by additional information specific to that event.
1316 struct Tcl_Event {
1317 Tcl_EventProc *proc; /* Function to call to service this event. */
1318 struct Tcl_Event *nextPtr; /* Next in list of pending events, or NULL. */
1322 * Positions to pass to Tcl_QueueEvent:
1325 typedef enum {
1326 TCL_QUEUE_TAIL, TCL_QUEUE_HEAD, TCL_QUEUE_MARK
1327 } Tcl_QueuePosition;
1330 * Values to pass to Tcl_SetServiceMode to specify the behavior of notifier
1331 * event routines.
1334 #define TCL_SERVICE_NONE 0
1335 #define TCL_SERVICE_ALL 1
1338 * The following structure keeps is used to hold a time value, either as an
1339 * absolute time (the number of seconds from the epoch) or as an elapsed time.
1340 * On Unix systems the epoch is Midnight Jan 1, 1970 GMT.
1343 typedef struct Tcl_Time {
1344 long sec; /* Seconds. */
1345 long usec; /* Microseconds. */
1346 } Tcl_Time;
1348 typedef void (Tcl_SetTimerProc) _ANSI_ARGS_((Tcl_Time *timePtr));
1349 typedef int (Tcl_WaitForEventProc) _ANSI_ARGS_((Tcl_Time *timePtr));
1352 * TIP #233 (Virtualized Time)
1355 typedef void (Tcl_GetTimeProc) _ANSI_ARGS_((Tcl_Time *timebuf,
1356 ClientData clientData));
1357 typedef void (Tcl_ScaleTimeProc) _ANSI_ARGS_((Tcl_Time *timebuf,
1358 ClientData clientData));
1361 * Bits to pass to Tcl_CreateFileHandler and Tcl_CreateChannelHandler to
1362 * indicate what sorts of events are of interest:
1365 #define TCL_READABLE (1<<1)
1366 #define TCL_WRITABLE (1<<2)
1367 #define TCL_EXCEPTION (1<<3)
1370 * Flag values to pass to Tcl_OpenCommandChannel to indicate the disposition
1371 * of the stdio handles. TCL_STDIN, TCL_STDOUT, TCL_STDERR, are also used in
1372 * Tcl_GetStdChannel.
1375 #define TCL_STDIN (1<<1)
1376 #define TCL_STDOUT (1<<2)
1377 #define TCL_STDERR (1<<3)
1378 #define TCL_ENFORCE_MODE (1<<4)
1381 * Bits passed to Tcl_DriverClose2Proc to indicate which side of a channel
1382 * should be closed.
1385 #define TCL_CLOSE_READ (1<<1)
1386 #define TCL_CLOSE_WRITE (1<<2)
1389 * Value to use as the closeProc for a channel that supports the close2Proc
1390 * interface.
1393 #define TCL_CLOSE2PROC ((Tcl_DriverCloseProc *) 1)
1396 * Channel version tag. This was introduced in 8.3.2/8.4.
1399 #define TCL_CHANNEL_VERSION_1 ((Tcl_ChannelTypeVersion) 0x1)
1400 #define TCL_CHANNEL_VERSION_2 ((Tcl_ChannelTypeVersion) 0x2)
1401 #define TCL_CHANNEL_VERSION_3 ((Tcl_ChannelTypeVersion) 0x3)
1402 #define TCL_CHANNEL_VERSION_4 ((Tcl_ChannelTypeVersion) 0x4)
1403 #define TCL_CHANNEL_VERSION_5 ((Tcl_ChannelTypeVersion) 0x5)
1406 * TIP #218: Channel Actions, Ids for Tcl_DriverThreadActionProc.
1409 #define TCL_CHANNEL_THREAD_INSERT (0)
1410 #define TCL_CHANNEL_THREAD_REMOVE (1)
1413 * Typedefs for the various operations in a channel type:
1416 typedef int (Tcl_DriverBlockModeProc) _ANSI_ARGS_((
1417 ClientData instanceData, int mode));
1418 typedef int (Tcl_DriverCloseProc) _ANSI_ARGS_((ClientData instanceData,
1419 Tcl_Interp *interp));
1420 typedef int (Tcl_DriverClose2Proc) _ANSI_ARGS_((ClientData instanceData,
1421 Tcl_Interp *interp, int flags));
1422 typedef int (Tcl_DriverInputProc) _ANSI_ARGS_((ClientData instanceData,
1423 char *buf, int toRead, int *errorCodePtr));
1424 typedef int (Tcl_DriverOutputProc) _ANSI_ARGS_((ClientData instanceData,
1425 CONST84 char *buf, int toWrite, int *errorCodePtr));
1426 typedef int (Tcl_DriverSeekProc) _ANSI_ARGS_((ClientData instanceData,
1427 long offset, int mode, int *errorCodePtr));
1428 typedef int (Tcl_DriverSetOptionProc) _ANSI_ARGS_((
1429 ClientData instanceData, Tcl_Interp *interp,
1430 CONST char *optionName, CONST char *value));
1431 typedef int (Tcl_DriverGetOptionProc) _ANSI_ARGS_((
1432 ClientData instanceData, Tcl_Interp *interp,
1433 CONST84 char *optionName, Tcl_DString *dsPtr));
1434 typedef void (Tcl_DriverWatchProc) _ANSI_ARGS_((
1435 ClientData instanceData, int mask));
1436 typedef int (Tcl_DriverGetHandleProc) _ANSI_ARGS_((
1437 ClientData instanceData, int direction,
1438 ClientData *handlePtr));
1439 typedef int (Tcl_DriverFlushProc) _ANSI_ARGS_((ClientData instanceData));
1440 typedef int (Tcl_DriverHandlerProc) _ANSI_ARGS_((
1441 ClientData instanceData, int interestMask));
1442 typedef Tcl_WideInt (Tcl_DriverWideSeekProc) _ANSI_ARGS_((
1443 ClientData instanceData, Tcl_WideInt offset,
1444 int mode, int *errorCodePtr));
1446 * TIP #218, Channel Thread Actions
1448 typedef void (Tcl_DriverThreadActionProc) _ANSI_ARGS_ ((
1449 ClientData instanceData, int action));
1451 * TIP #208, File Truncation (etc.)
1453 typedef int (Tcl_DriverTruncateProc) _ANSI_ARGS_((
1454 ClientData instanceData, Tcl_WideInt length));
1457 * struct Tcl_ChannelType:
1459 * One such structure exists for each type (kind) of channel. It collects
1460 * together in one place all the functions that are part of the specific
1461 * channel type.
1463 * It is recommend that the Tcl_Channel* functions are used to access elements
1464 * of this structure, instead of direct accessing.
1467 typedef struct Tcl_ChannelType {
1468 char *typeName; /* The name of the channel type in Tcl
1469 * commands. This storage is owned by channel
1470 * type. */
1471 Tcl_ChannelTypeVersion version;
1472 /* Version of the channel type. */
1473 Tcl_DriverCloseProc *closeProc;
1474 /* Function to call to close the channel, or
1475 * TCL_CLOSE2PROC if the close2Proc should be
1476 * used instead. */
1477 Tcl_DriverInputProc *inputProc;
1478 /* Function to call for input on channel. */
1479 Tcl_DriverOutputProc *outputProc;
1480 /* Function to call for output on channel. */
1481 Tcl_DriverSeekProc *seekProc;
1482 /* Function to call to seek on the channel.
1483 * May be NULL. */
1484 Tcl_DriverSetOptionProc *setOptionProc;
1485 /* Set an option on a channel. */
1486 Tcl_DriverGetOptionProc *getOptionProc;
1487 /* Get an option from a channel. */
1488 Tcl_DriverWatchProc *watchProc;
1489 /* Set up the notifier to watch for events on
1490 * this channel. */
1491 Tcl_DriverGetHandleProc *getHandleProc;
1492 /* Get an OS handle from the channel or NULL
1493 * if not supported. */
1494 Tcl_DriverClose2Proc *close2Proc;
1495 /* Function to call to close the channel if
1496 * the device supports closing the read &
1497 * write sides independently. */
1498 Tcl_DriverBlockModeProc *blockModeProc;
1499 /* Set blocking mode for the raw channel. May
1500 * be NULL. */
1502 * Only valid in TCL_CHANNEL_VERSION_2 channels or later.
1504 Tcl_DriverFlushProc *flushProc;
1505 /* Function to call to flush a channel. May be
1506 * NULL. */
1507 Tcl_DriverHandlerProc *handlerProc;
1508 /* Function to call to handle a channel event.
1509 * This will be passed up the stacked channel
1510 * chain. */
1512 * Only valid in TCL_CHANNEL_VERSION_3 channels or later.
1514 Tcl_DriverWideSeekProc *wideSeekProc;
1515 /* Function to call to seek on the channel
1516 * which can handle 64-bit offsets. May be
1517 * NULL, and must be NULL if seekProc is
1518 * NULL. */
1520 * Only valid in TCL_CHANNEL_VERSION_4 channels or later.
1521 * TIP #218, Channel Thread Actions.
1523 Tcl_DriverThreadActionProc *threadActionProc;
1524 /* Function to call to notify the driver of
1525 * thread specific activity for a channel. May
1526 * be NULL. */
1529 * Only valid in TCL_CHANNEL_VERSION_5 channels or later.
1530 * TIP #208, File Truncation.
1532 Tcl_DriverTruncateProc *truncateProc;
1533 /* Function to call to truncate the underlying
1534 * file to a particular length. May be NULL if
1535 * the channel does not support truncation. */
1536 } Tcl_ChannelType;
1539 * The following flags determine whether the blockModeProc above should set
1540 * the channel into blocking or nonblocking mode. They are passed as arguments
1541 * to the blockModeProc function in the above structure.
1544 #define TCL_MODE_BLOCKING 0 /* Put channel into blocking mode. */
1545 #define TCL_MODE_NONBLOCKING 1 /* Put channel into nonblocking
1546 * mode. */
1549 * Enum for different types of file paths.
1552 typedef enum Tcl_PathType {
1553 TCL_PATH_ABSOLUTE,
1554 TCL_PATH_RELATIVE,
1555 TCL_PATH_VOLUME_RELATIVE
1556 } Tcl_PathType;
1559 * The following structure is used to pass glob type data amongst the various
1560 * glob routines and Tcl_FSMatchInDirectory.
1563 typedef struct Tcl_GlobTypeData {
1564 int type; /* Corresponds to bcdpfls as in 'find -t'. */
1565 int perm; /* Corresponds to file permissions. */
1566 Tcl_Obj *macType; /* Acceptable Mac type. */
1567 Tcl_Obj *macCreator; /* Acceptable Mac creator. */
1568 } Tcl_GlobTypeData;
1571 * Type and permission definitions for glob command.
1574 #define TCL_GLOB_TYPE_BLOCK (1<<0)
1575 #define TCL_GLOB_TYPE_CHAR (1<<1)
1576 #define TCL_GLOB_TYPE_DIR (1<<2)
1577 #define TCL_GLOB_TYPE_PIPE (1<<3)
1578 #define TCL_GLOB_TYPE_FILE (1<<4)
1579 #define TCL_GLOB_TYPE_LINK (1<<5)
1580 #define TCL_GLOB_TYPE_SOCK (1<<6)
1581 #define TCL_GLOB_TYPE_MOUNT (1<<7)
1583 #define TCL_GLOB_PERM_RONLY (1<<0)
1584 #define TCL_GLOB_PERM_HIDDEN (1<<1)
1585 #define TCL_GLOB_PERM_R (1<<2)
1586 #define TCL_GLOB_PERM_W (1<<3)
1587 #define TCL_GLOB_PERM_X (1<<4)
1590 * Flags for the unload callback function.
1593 #define TCL_UNLOAD_DETACH_FROM_INTERPRETER (1<<0)
1594 #define TCL_UNLOAD_DETACH_FROM_PROCESS (1<<1)
1597 * Typedefs for the various filesystem operations:
1600 typedef int (Tcl_FSStatProc) _ANSI_ARGS_((Tcl_Obj *pathPtr, Tcl_StatBuf *buf));
1601 typedef int (Tcl_FSAccessProc) _ANSI_ARGS_((Tcl_Obj *pathPtr, int mode));
1602 typedef Tcl_Channel (Tcl_FSOpenFileChannelProc) _ANSI_ARGS_((
1603 Tcl_Interp *interp, Tcl_Obj *pathPtr, int mode, int permissions));
1604 typedef int (Tcl_FSMatchInDirectoryProc) _ANSI_ARGS_((Tcl_Interp *interp,
1605 Tcl_Obj *result, Tcl_Obj *pathPtr, CONST char *pattern,
1606 Tcl_GlobTypeData * types));
1607 typedef Tcl_Obj * (Tcl_FSGetCwdProc) _ANSI_ARGS_((Tcl_Interp *interp));
1608 typedef int (Tcl_FSChdirProc) _ANSI_ARGS_((Tcl_Obj *pathPtr));
1609 typedef int (Tcl_FSLstatProc) _ANSI_ARGS_((Tcl_Obj *pathPtr,
1610 Tcl_StatBuf *buf));
1611 typedef int (Tcl_FSCreateDirectoryProc) _ANSI_ARGS_((Tcl_Obj *pathPtr));
1612 typedef int (Tcl_FSDeleteFileProc) _ANSI_ARGS_((Tcl_Obj *pathPtr));
1613 typedef int (Tcl_FSCopyDirectoryProc) _ANSI_ARGS_((Tcl_Obj *srcPathPtr,
1614 Tcl_Obj *destPathPtr, Tcl_Obj **errorPtr));
1615 typedef int (Tcl_FSCopyFileProc) _ANSI_ARGS_((Tcl_Obj *srcPathPtr,
1616 Tcl_Obj *destPathPtr));
1617 typedef int (Tcl_FSRemoveDirectoryProc) _ANSI_ARGS_((Tcl_Obj *pathPtr,
1618 int recursive, Tcl_Obj **errorPtr));
1619 typedef int (Tcl_FSRenameFileProc) _ANSI_ARGS_((Tcl_Obj *srcPathPtr,
1620 Tcl_Obj *destPathPtr));
1621 typedef void (Tcl_FSUnloadFileProc) _ANSI_ARGS_((Tcl_LoadHandle loadHandle));
1622 typedef Tcl_Obj * (Tcl_FSListVolumesProc) _ANSI_ARGS_((void));
1623 /* We have to declare the utime structure here. */
1624 struct utimbuf;
1625 typedef int (Tcl_FSUtimeProc) _ANSI_ARGS_((Tcl_Obj *pathPtr,
1626 struct utimbuf *tval));
1627 typedef int (Tcl_FSNormalizePathProc) _ANSI_ARGS_((Tcl_Interp *interp,
1628 Tcl_Obj *pathPtr, int nextCheckpoint));
1629 typedef int (Tcl_FSFileAttrsGetProc) _ANSI_ARGS_((Tcl_Interp *interp,
1630 int index, Tcl_Obj *pathPtr, Tcl_Obj **objPtrRef));
1631 typedef CONST char ** (Tcl_FSFileAttrStringsProc) _ANSI_ARGS_((
1632 Tcl_Obj *pathPtr, Tcl_Obj **objPtrRef));
1633 typedef int (Tcl_FSFileAttrsSetProc) _ANSI_ARGS_((Tcl_Interp *interp,
1634 int index, Tcl_Obj *pathPtr, Tcl_Obj *objPtr));
1635 typedef Tcl_Obj * (Tcl_FSLinkProc) _ANSI_ARGS_((Tcl_Obj *pathPtr,
1636 Tcl_Obj *toPtr, int linkType));
1637 typedef int (Tcl_FSLoadFileProc) _ANSI_ARGS_((Tcl_Interp * interp,
1638 Tcl_Obj *pathPtr, Tcl_LoadHandle *handlePtr,
1639 Tcl_FSUnloadFileProc **unloadProcPtr));
1640 typedef int (Tcl_FSPathInFilesystemProc) _ANSI_ARGS_((Tcl_Obj *pathPtr,
1641 ClientData *clientDataPtr));
1642 typedef Tcl_Obj * (Tcl_FSFilesystemPathTypeProc) _ANSI_ARGS_((
1643 Tcl_Obj *pathPtr));
1644 typedef Tcl_Obj * (Tcl_FSFilesystemSeparatorProc) _ANSI_ARGS_((
1645 Tcl_Obj *pathPtr));
1646 typedef void (Tcl_FSFreeInternalRepProc) _ANSI_ARGS_((ClientData clientData));
1647 typedef ClientData (Tcl_FSDupInternalRepProc) _ANSI_ARGS_((
1648 ClientData clientData));
1649 typedef Tcl_Obj * (Tcl_FSInternalToNormalizedProc) _ANSI_ARGS_((
1650 ClientData clientData));
1651 typedef ClientData (Tcl_FSCreateInternalRepProc) _ANSI_ARGS_((
1652 Tcl_Obj *pathPtr));
1654 typedef struct Tcl_FSVersion_ *Tcl_FSVersion;
1657 *----------------------------------------------------------------
1658 * Data structures related to hooking into the filesystem
1659 *----------------------------------------------------------------
1663 * Filesystem version tag. This was introduced in 8.4.
1665 #define TCL_FILESYSTEM_VERSION_1 ((Tcl_FSVersion) 0x1)
1668 * struct Tcl_Filesystem:
1670 * One such structure exists for each type (kind) of filesystem. It collects
1671 * together in one place all the functions that are part of the specific
1672 * filesystem. Tcl always accesses the filesystem through one of these
1673 * structures.
1675 * Not all entries need be non-NULL; any which are NULL are simply ignored.
1676 * However, a complete filesystem should provide all of these functions. The
1677 * explanations in the structure show the importance of each function.
1680 typedef struct Tcl_Filesystem {
1681 CONST char *typeName; /* The name of the filesystem. */
1682 int structureLength; /* Length of this structure, so future binary
1683 * compatibility can be assured. */
1684 Tcl_FSVersion version; /* Version of the filesystem type. */
1685 Tcl_FSPathInFilesystemProc *pathInFilesystemProc;
1686 /* Function to check whether a path is in this
1687 * filesystem. This is the most important
1688 * filesystem function. */
1689 Tcl_FSDupInternalRepProc *dupInternalRepProc;
1690 /* Function to duplicate internal fs rep. May
1691 * be NULL (but then fs is less efficient). */
1692 Tcl_FSFreeInternalRepProc *freeInternalRepProc;
1693 /* Function to free internal fs rep. Must be
1694 * implemented if internal representations
1695 * need freeing, otherwise it can be NULL. */
1696 Tcl_FSInternalToNormalizedProc *internalToNormalizedProc;
1697 /* Function to convert internal representation
1698 * to a normalized path. Only required if the
1699 * fs creates pure path objects with no
1700 * string/path representation. */
1701 Tcl_FSCreateInternalRepProc *createInternalRepProc;
1702 /* Function to create a filesystem-specific
1703 * internal representation. May be NULL if
1704 * paths have no internal representation, or
1705 * if the Tcl_FSPathInFilesystemProc for this
1706 * filesystem always immediately creates an
1707 * internal representation for paths it
1708 * accepts. */
1709 Tcl_FSNormalizePathProc *normalizePathProc;
1710 /* Function to normalize a path. Should be
1711 * implemented for all filesystems which can
1712 * have multiple string representations for
1713 * the same path object. */
1714 Tcl_FSFilesystemPathTypeProc *filesystemPathTypeProc;
1715 /* Function to determine the type of a path in
1716 * this filesystem. May be NULL. */
1717 Tcl_FSFilesystemSeparatorProc *filesystemSeparatorProc;
1718 /* Function to return the separator
1719 * character(s) for this filesystem. Must be
1720 * implemented. */
1721 Tcl_FSStatProc *statProc; /* Function to process a 'Tcl_FSStat()' call.
1722 * Must be implemented for any reasonable
1723 * filesystem. */
1724 Tcl_FSAccessProc *accessProc;
1725 /* Function to process a 'Tcl_FSAccess()'
1726 * call. Must be implemented for any
1727 * reasonable filesystem. */
1728 Tcl_FSOpenFileChannelProc *openFileChannelProc;
1729 /* Function to process a
1730 * 'Tcl_FSOpenFileChannel()' call. Must be
1731 * implemented for any reasonable
1732 * filesystem. */
1733 Tcl_FSMatchInDirectoryProc *matchInDirectoryProc;
1734 /* Function to process a
1735 * 'Tcl_FSMatchInDirectory()'. If not
1736 * implemented, then glob and recursive copy
1737 * functionality will be lacking in the
1738 * filesystem. */
1739 Tcl_FSUtimeProc *utimeProc; /* Function to process a 'Tcl_FSUtime()' call.
1740 * Required to allow setting (not reading) of
1741 * times with 'file mtime', 'file atime' and
1742 * the open-r/open-w/fcopy implementation of
1743 * 'file copy'. */
1744 Tcl_FSLinkProc *linkProc; /* Function to process a 'Tcl_FSLink()' call.
1745 * Should be implemented only if the
1746 * filesystem supports links (reading or
1747 * creating). */
1748 Tcl_FSListVolumesProc *listVolumesProc;
1749 /* Function to list any filesystem volumes
1750 * added by this filesystem. Should be
1751 * implemented only if the filesystem adds
1752 * volumes at the head of the filesystem. */
1753 Tcl_FSFileAttrStringsProc *fileAttrStringsProc;
1754 /* Function to list all attributes strings
1755 * which are valid for this filesystem. If not
1756 * implemented the filesystem will not support
1757 * the 'file attributes' command. This allows
1758 * arbitrary additional information to be
1759 * attached to files in the filesystem. */
1760 Tcl_FSFileAttrsGetProc *fileAttrsGetProc;
1761 /* Function to process a
1762 * 'Tcl_FSFileAttrsGet()' call, used by 'file
1763 * attributes'. */
1764 Tcl_FSFileAttrsSetProc *fileAttrsSetProc;
1765 /* Function to process a
1766 * 'Tcl_FSFileAttrsSet()' call, used by 'file
1767 * attributes'. */
1768 Tcl_FSCreateDirectoryProc *createDirectoryProc;
1769 /* Function to process a
1770 * 'Tcl_FSCreateDirectory()' call. Should be
1771 * implemented unless the FS is read-only. */
1772 Tcl_FSRemoveDirectoryProc *removeDirectoryProc;
1773 /* Function to process a
1774 * 'Tcl_FSRemoveDirectory()' call. Should be
1775 * implemented unless the FS is read-only. */
1776 Tcl_FSDeleteFileProc *deleteFileProc;
1777 /* Function to process a 'Tcl_FSDeleteFile()'
1778 * call. Should be implemented unless the FS
1779 * is read-only. */
1780 Tcl_FSCopyFileProc *copyFileProc;
1781 /* Function to process a 'Tcl_FSCopyFile()'
1782 * call. If not implemented Tcl will fall back
1783 * on open-r, open-w and fcopy as a copying
1784 * mechanism, for copying actions initiated in
1785 * Tcl (not C). */
1786 Tcl_FSRenameFileProc *renameFileProc;
1787 /* Function to process a 'Tcl_FSRenameFile()'
1788 * call. If not implemented, Tcl will fall
1789 * back on a copy and delete mechanism, for
1790 * rename actions initiated in Tcl (not C). */
1791 Tcl_FSCopyDirectoryProc *copyDirectoryProc;
1792 /* Function to process a
1793 * 'Tcl_FSCopyDirectory()' call. If not
1794 * implemented, Tcl will fall back on a
1795 * recursive create-dir, file copy mechanism,
1796 * for copying actions initiated in Tcl (not
1797 * C). */
1798 Tcl_FSLstatProc *lstatProc; /* Function to process a 'Tcl_FSLstat()' call.
1799 * If not implemented, Tcl will attempt to use
1800 * the 'statProc' defined above instead. */
1801 Tcl_FSLoadFileProc *loadFileProc;
1802 /* Function to process a 'Tcl_FSLoadFile()'
1803 * call. If not implemented, Tcl will fall
1804 * back on a copy to native-temp followed by a
1805 * Tcl_FSLoadFile on that temporary copy. */
1806 Tcl_FSGetCwdProc *getCwdProc;
1807 /* Function to process a 'Tcl_FSGetCwd()'
1808 * call. Most filesystems need not implement
1809 * this. It will usually only be called once,
1810 * if 'getcwd' is called before 'chdir'. May
1811 * be NULL. */
1812 Tcl_FSChdirProc *chdirProc; /* Function to process a 'Tcl_FSChdir()' call.
1813 * If filesystems do not implement this, it
1814 * will be emulated by a series of directory
1815 * access checks. Otherwise, virtual
1816 * filesystems which do implement it need only
1817 * respond with a positive return result if
1818 * the dirName is a valid directory in their
1819 * filesystem. They need not remember the
1820 * result, since that will be automatically
1821 * remembered for use by GetCwd. Real
1822 * filesystems should carry out the correct
1823 * action (i.e. call the correct system
1824 * 'chdir' api). If not implemented, then 'cd'
1825 * and 'pwd' will fail inside the
1826 * filesystem. */
1827 } Tcl_Filesystem;
1830 * The following definitions are used as values for the 'linkAction' flag to
1831 * Tcl_FSLink, or the linkProc of any filesystem. Any combination of flags can
1832 * be given. For link creation, the linkProc should create a link which
1833 * matches any of the types given.
1835 * TCL_CREATE_SYMBOLIC_LINK - Create a symbolic or soft link.
1836 * TCL_CREATE_HARD_LINK - Create a hard link.
1839 #define TCL_CREATE_SYMBOLIC_LINK 0x01
1840 #define TCL_CREATE_HARD_LINK 0x02
1843 * The following structure represents the Notifier functions that you can
1844 * override with the Tcl_SetNotifier call.
1847 typedef struct Tcl_NotifierProcs {
1848 Tcl_SetTimerProc *setTimerProc;
1849 Tcl_WaitForEventProc *waitForEventProc;
1850 Tcl_CreateFileHandlerProc *createFileHandlerProc;
1851 Tcl_DeleteFileHandlerProc *deleteFileHandlerProc;
1852 Tcl_InitNotifierProc *initNotifierProc;
1853 Tcl_FinalizeNotifierProc *finalizeNotifierProc;
1854 Tcl_AlertNotifierProc *alertNotifierProc;
1855 Tcl_ServiceModeHookProc *serviceModeHookProc;
1856 } Tcl_NotifierProcs;
1859 * The following structure represents a user-defined encoding. It collects
1860 * together all the functions that are used by the specific encoding.
1863 typedef struct Tcl_EncodingType {
1864 CONST char *encodingName; /* The name of the encoding, e.g. "euc-jp".
1865 * This name is the unique key for this
1866 * encoding type. */
1867 Tcl_EncodingConvertProc *toUtfProc;
1868 /* Function to convert from external encoding
1869 * into UTF-8. */
1870 Tcl_EncodingConvertProc *fromUtfProc;
1871 /* Function to convert from UTF-8 into
1872 * external encoding. */
1873 Tcl_EncodingFreeProc *freeProc;
1874 /* If non-NULL, function to call when this
1875 * encoding is deleted. */
1876 ClientData clientData; /* Arbitrary value associated with encoding
1877 * type. Passed to conversion functions. */
1878 int nullSize; /* Number of zero bytes that signify
1879 * end-of-string in this encoding. This number
1880 * is used to determine the source string
1881 * length when the srcLen argument is
1882 * negative. Must be 1 or 2. */
1883 } Tcl_EncodingType;
1886 * The following definitions are used as values for the conversion control
1887 * flags argument when converting text from one character set to another:
1889 * TCL_ENCODING_START - Signifies that the source buffer is the first
1890 * block in a (potentially multi-block) input
1891 * stream. Tells the conversion function to reset
1892 * to an initial state and perform any
1893 * initialization that needs to occur before the
1894 * first byte is converted. If the source buffer
1895 * contains the entire input stream to be
1896 * converted, this flag should be set.
1897 * TCL_ENCODING_END - Signifies that the source buffer is the last
1898 * block in a (potentially multi-block) input
1899 * stream. Tells the conversion routine to
1900 * perform any finalization that needs to occur
1901 * after the last byte is converted and then to
1902 * reset to an initial state. If the source
1903 * buffer contains the entire input stream to be
1904 * converted, this flag should be set.
1905 * TCL_ENCODING_STOPONERROR - If set, then the converter will return
1906 * immediately upon encountering an invalid byte
1907 * sequence or a source character that has no
1908 * mapping in the target encoding. If clear, then
1909 * the converter will skip the problem,
1910 * substituting one or more "close" characters in
1911 * the destination buffer and then continue to
1912 * convert the source.
1915 #define TCL_ENCODING_START 0x01
1916 #define TCL_ENCODING_END 0x02
1917 #define TCL_ENCODING_STOPONERROR 0x04
1920 * The following data structures and declarations are for the new Tcl parser.
1924 * For each word of a command, and for each piece of a word such as a variable
1925 * reference, one of the following structures is created to describe the
1926 * token.
1929 typedef struct Tcl_Token {
1930 int type; /* Type of token, such as TCL_TOKEN_WORD; see
1931 * below for valid types. */
1932 CONST char *start; /* First character in token. */
1933 int size; /* Number of bytes in token. */
1934 int numComponents; /* If this token is composed of other tokens,
1935 * this field tells how many of them there are
1936 * (including components of components, etc.).
1937 * The component tokens immediately follow
1938 * this one. */
1939 } Tcl_Token;
1942 * Type values defined for Tcl_Token structures. These values are defined as
1943 * mask bits so that it's easy to check for collections of types.
1945 * TCL_TOKEN_WORD - The token describes one word of a command,
1946 * from the first non-blank character of the word
1947 * (which may be " or {) up to but not including
1948 * the space, semicolon, or bracket that
1949 * terminates the word. NumComponents counts the
1950 * total number of sub-tokens that make up the
1951 * word. This includes, for example, sub-tokens
1952 * of TCL_TOKEN_VARIABLE tokens.
1953 * TCL_TOKEN_SIMPLE_WORD - This token is just like TCL_TOKEN_WORD except
1954 * that the word is guaranteed to consist of a
1955 * single TCL_TOKEN_TEXT sub-token.
1956 * TCL_TOKEN_TEXT - The token describes a range of literal text
1957 * that is part of a word. NumComponents is
1958 * always 0.
1959 * TCL_TOKEN_BS - The token describes a backslash sequence that
1960 * must be collapsed. NumComponents is always 0.
1961 * TCL_TOKEN_COMMAND - The token describes a command whose result
1962 * must be substituted into the word. The token
1963 * includes the enclosing brackets. NumComponents
1964 * is always 0.
1965 * TCL_TOKEN_VARIABLE - The token describes a variable substitution,
1966 * including the dollar sign, variable name, and
1967 * array index (if there is one) up through the
1968 * right parentheses. NumComponents tells how
1969 * many additional tokens follow to represent the
1970 * variable name. The first token will be a
1971 * TCL_TOKEN_TEXT token that describes the
1972 * variable name. If the variable is an array
1973 * reference then there will be one or more
1974 * additional tokens, of type TCL_TOKEN_TEXT,
1975 * TCL_TOKEN_BS, TCL_TOKEN_COMMAND, and
1976 * TCL_TOKEN_VARIABLE, that describe the array
1977 * index; numComponents counts the total number
1978 * of nested tokens that make up the variable
1979 * reference, including sub-tokens of
1980 * TCL_TOKEN_VARIABLE tokens.
1981 * TCL_TOKEN_SUB_EXPR - The token describes one subexpression of an
1982 * expression, from the first non-blank character
1983 * of the subexpression up to but not including
1984 * the space, brace, or bracket that terminates
1985 * the subexpression. NumComponents counts the
1986 * total number of following subtokens that make
1987 * up the subexpression; this includes all
1988 * subtokens for any nested TCL_TOKEN_SUB_EXPR
1989 * tokens. For example, a numeric value used as a
1990 * primitive operand is described by a
1991 * TCL_TOKEN_SUB_EXPR token followed by a
1992 * TCL_TOKEN_TEXT token. A binary subexpression
1993 * is described by a TCL_TOKEN_SUB_EXPR token
1994 * followed by the TCL_TOKEN_OPERATOR token for
1995 * the operator, then TCL_TOKEN_SUB_EXPR tokens
1996 * for the left then the right operands.
1997 * TCL_TOKEN_OPERATOR - The token describes one expression operator.
1998 * An operator might be the name of a math
1999 * function such as "abs". A TCL_TOKEN_OPERATOR
2000 * token is always preceeded by one
2001 * TCL_TOKEN_SUB_EXPR token for the operator's
2002 * subexpression, and is followed by zero or more
2003 * TCL_TOKEN_SUB_EXPR tokens for the operator's
2004 * operands. NumComponents is always 0.
2005 * TCL_TOKEN_EXPAND_WORD - This token is just like TCL_TOKEN_WORD except
2006 * that it marks a word that began with the
2007 * literal character prefix "{*}". This word is
2008 * marked to be expanded - that is, broken into
2009 * words after substitution is complete.
2012 #define TCL_TOKEN_WORD 1
2013 #define TCL_TOKEN_SIMPLE_WORD 2
2014 #define TCL_TOKEN_TEXT 4
2015 #define TCL_TOKEN_BS 8
2016 #define TCL_TOKEN_COMMAND 16
2017 #define TCL_TOKEN_VARIABLE 32
2018 #define TCL_TOKEN_SUB_EXPR 64
2019 #define TCL_TOKEN_OPERATOR 128
2020 #define TCL_TOKEN_EXPAND_WORD 256
2023 * Parsing error types. On any parsing error, one of these values will be
2024 * stored in the error field of the Tcl_Parse structure defined below.
2027 #define TCL_PARSE_SUCCESS 0
2028 #define TCL_PARSE_QUOTE_EXTRA 1
2029 #define TCL_PARSE_BRACE_EXTRA 2
2030 #define TCL_PARSE_MISSING_BRACE 3
2031 #define TCL_PARSE_MISSING_BRACKET 4
2032 #define TCL_PARSE_MISSING_PAREN 5
2033 #define TCL_PARSE_MISSING_QUOTE 6
2034 #define TCL_PARSE_MISSING_VAR_BRACE 7
2035 #define TCL_PARSE_SYNTAX 8
2036 #define TCL_PARSE_BAD_NUMBER 9
2039 * A structure of the following type is filled in by Tcl_ParseCommand. It
2040 * describes a single command parsed from an input string.
2043 #define NUM_STATIC_TOKENS 20
2045 typedef struct Tcl_Parse {
2046 CONST char *commentStart; /* Pointer to # that begins the first of one
2047 * or more comments preceding the command. */
2048 int commentSize; /* Number of bytes in comments (up through
2049 * newline character that terminates the last
2050 * comment). If there were no comments, this
2051 * field is 0. */
2052 CONST char *commandStart; /* First character in first word of
2053 * command. */
2054 int commandSize; /* Number of bytes in command, including first
2055 * character of first word, up through the
2056 * terminating newline, close bracket, or
2057 * semicolon. */
2058 int numWords; /* Total number of words in command. May be
2059 * 0. */
2060 Tcl_Token *tokenPtr; /* Pointer to first token representing the
2061 * words of the command. Initially points to
2062 * staticTokens, but may change to point to
2063 * malloc-ed space if command exceeds space in
2064 * staticTokens. */
2065 int numTokens; /* Total number of tokens in command. */
2066 int tokensAvailable; /* Total number of tokens available at
2067 * *tokenPtr. */
2068 int errorType; /* One of the parsing error types defined
2069 * above. */
2072 * The fields below are intended only for the private use of the parser.
2073 * They should not be used by functions that invoke Tcl_ParseCommand.
2076 CONST char *string; /* The original command string passed to
2077 * Tcl_ParseCommand. */
2078 CONST char *end; /* Points to the character just after the last
2079 * one in the command string. */
2080 Tcl_Interp *interp; /* Interpreter to use for error reporting, or
2081 * NULL. */
2082 CONST char *term; /* Points to character in string that
2083 * terminated most recent token. Filled in by
2084 * ParseTokens. If an error occurs, points to
2085 * beginning of region where the error
2086 * occurred (e.g. the open brace if the close
2087 * brace is missing). */
2088 int incomplete; /* This field is set to 1 by Tcl_ParseCommand
2089 * if the command appears to be incomplete.
2090 * This information is used by
2091 * Tcl_CommandComplete. */
2092 Tcl_Token staticTokens[NUM_STATIC_TOKENS];
2093 /* Initial space for tokens for command. This
2094 * space should be large enough to accommodate
2095 * most commands; dynamic space is allocated
2096 * for very large commands that don't fit
2097 * here. */
2098 } Tcl_Parse;
2101 * The following definitions are the error codes returned by the conversion
2102 * routines:
2104 * TCL_OK - All characters were converted.
2105 * TCL_CONVERT_NOSPACE - The output buffer would not have been large
2106 * enough for all of the converted data; as many
2107 * characters as could fit were converted though.
2108 * TCL_CONVERT_MULTIBYTE - The last few bytes in the source string were
2109 * the beginning of a multibyte sequence, but
2110 * more bytes were needed to complete this
2111 * sequence. A subsequent call to the conversion
2112 * routine should pass the beginning of this
2113 * unconverted sequence plus additional bytes
2114 * from the source stream to properly convert the
2115 * formerly split-up multibyte sequence.
2116 * TCL_CONVERT_SYNTAX - The source stream contained an invalid
2117 * character sequence. This may occur if the
2118 * input stream has been damaged or if the input
2119 * encoding method was misidentified. This error
2120 * is reported only if TCL_ENCODING_STOPONERROR
2121 * was specified.
2122 * TCL_CONVERT_UNKNOWN - The source string contained a character that
2123 * could not be represented in the target
2124 * encoding. This error is reported only if
2125 * TCL_ENCODING_STOPONERROR was specified.
2128 #define TCL_CONVERT_MULTIBYTE -1
2129 #define TCL_CONVERT_SYNTAX -2
2130 #define TCL_CONVERT_UNKNOWN -3
2131 #define TCL_CONVERT_NOSPACE -4
2134 * The maximum number of bytes that are necessary to represent a single
2135 * Unicode character in UTF-8. The valid values should be 3 or 6 (or perhaps 1
2136 * if we want to support a non-unicode enabled core). If 3, then Tcl_UniChar
2137 * must be 2-bytes in size (UCS-2) (the default). If 6, then Tcl_UniChar must
2138 * be 4-bytes in size (UCS-4). At this time UCS-2 mode is the default and
2139 * recommended mode. UCS-4 is experimental and not recommended. It works for
2140 * the core, but most extensions expect UCS-2.
2143 #ifndef TCL_UTF_MAX
2144 #define TCL_UTF_MAX 3
2145 #endif
2148 * This represents a Unicode character. Any changes to this should also be
2149 * reflected in regcustom.h.
2152 #if TCL_UTF_MAX > 4
2154 * unsigned int isn't 100% accurate as it should be a strict 4-byte value
2155 * (perhaps wchar_t). 64-bit systems may have troubles. The size of this
2156 * value must be reflected correctly in regcustom.h and
2157 * in tclEncoding.c.
2158 * XXX: Tcl is currently UCS-2 and planning UTF-16 for the Unicode
2159 * XXX: string rep that Tcl_UniChar represents. Changing the size
2160 * XXX: of Tcl_UniChar is /not/ supported.
2162 typedef unsigned int Tcl_UniChar;
2163 #else
2164 typedef unsigned short Tcl_UniChar;
2165 #endif
2168 * TIP #59: The following structure is used in calls 'Tcl_RegisterConfig' to
2169 * provide the system with the embedded configuration data.
2172 typedef struct Tcl_Config {
2173 CONST char *key; /* Configuration key to register. ASCII
2174 * encoded, thus UTF-8. */
2175 CONST char *value; /* The value associated with the key. System
2176 * encoding. */
2177 } Tcl_Config;
2180 * Flags for TIP#143 limits, detailing which limits are active in an
2181 * interpreter. Used for Tcl_{Add,Remove}LimitHandler type argument.
2184 #define TCL_LIMIT_COMMANDS 0x01
2185 #define TCL_LIMIT_TIME 0x02
2188 * Structure containing information about a limit handler to be called when a
2189 * command- or time-limit is exceeded by an interpreter.
2192 typedef void (Tcl_LimitHandlerProc) _ANSI_ARGS_((ClientData clientData,
2193 Tcl_Interp *interp));
2194 typedef void (Tcl_LimitHandlerDeleteProc) _ANSI_ARGS_((ClientData clientData));
2196 typedef struct mp_int mp_int;
2197 #define MP_INT_DECLARED
2198 typedef unsigned int mp_digit;
2199 #define MP_DIGIT_DECLARED
2202 * The following constant is used to test for older versions of Tcl in the
2203 * stubs tables.
2205 * Jan Nijtman's plus patch uses 0xFCA1BACF, so we need to pick a different
2206 * value since the stubs tables don't match.
2209 #define TCL_STUB_MAGIC ((int) 0xFCA3BACF)
2212 * The following function is required to be defined in all stubs aware
2213 * extensions. The function is actually implemented in the stub library, not
2214 * the main Tcl library, although there is a trivial implementation in the
2215 * main library in case an extension is statically linked into an application.
2218 EXTERN CONST char * Tcl_InitStubs _ANSI_ARGS_((Tcl_Interp *interp,
2219 CONST char *version, int exact));
2220 EXTERN CONST char * TclTomMathInitializeStubs _ANSI_ARGS_((
2221 Tcl_Interp *interp, CONST char *version,
2222 int epoch, int revision));
2224 #ifndef USE_TCL_STUBS
2227 * When not using stubs, make it a macro.
2230 #define Tcl_InitStubs(interp, version, exact) \
2231 Tcl_PkgInitStubsCheck(interp, version, exact)
2233 #endif
2236 * TODO - tommath stubs export goes here!
2241 * Public functions that are not accessible via the stubs table.
2242 * Tcl_GetMemoryInfo is needed for AOLserver. [Bug 1868171]
2245 EXTERN void Tcl_Main _ANSI_ARGS_((int argc, char **argv,
2246 Tcl_AppInitProc *appInitProc));
2247 EXTERN CONST char * Tcl_PkgInitStubsCheck _ANSI_ARGS_((Tcl_Interp *interp,
2248 CONST char *version, int exact));
2249 #if defined(TCL_THREADS) && defined(USE_THREAD_ALLOC)
2250 EXTERN void Tcl_GetMemoryInfo _ANSI_ARGS_((Tcl_DString *dsPtr));
2251 #endif
2254 * Include the public function declarations that are accessible via the stubs
2255 * table.
2258 #include "tclDecls.h"
2261 * Include platform specific public function declarations that are accessible
2262 * via the stubs table.
2265 #include "tclPlatDecls.h"
2268 * The following declarations either map ckalloc and ckfree to malloc and
2269 * free, or they map them to functions with all sorts of debugging hooks
2270 * defined in tclCkalloc.c.
2273 #ifdef TCL_MEM_DEBUG
2275 # define ckalloc(x) Tcl_DbCkalloc(x, __FILE__, __LINE__)
2276 # define ckfree(x) Tcl_DbCkfree(x, __FILE__, __LINE__)
2277 # define ckrealloc(x,y) Tcl_DbCkrealloc((x), (y),__FILE__, __LINE__)
2278 # define attemptckalloc(x) Tcl_AttemptDbCkalloc(x, __FILE__, __LINE__)
2279 # define attemptckrealloc(x,y) Tcl_AttemptDbCkrealloc((x), (y), __FILE__, __LINE__)
2281 #else /* !TCL_MEM_DEBUG */
2284 * If we are not using the debugging allocator, we should call the Tcl_Alloc,
2285 * et al. routines in order to guarantee that every module is using the same
2286 * memory allocator both inside and outside of the Tcl library.
2289 # define ckalloc(x) Tcl_Alloc(x)
2290 # define ckfree(x) Tcl_Free(x)
2291 # define ckrealloc(x,y) Tcl_Realloc(x,y)
2292 # define attemptckalloc(x) Tcl_AttemptAlloc(x)
2293 # define attemptckrealloc(x,y) Tcl_AttemptRealloc(x,y)
2294 # undef Tcl_InitMemory
2295 # define Tcl_InitMemory(x)
2296 # undef Tcl_DumpActiveMemory
2297 # define Tcl_DumpActiveMemory(x)
2298 # undef Tcl_ValidateAllMemory
2299 # define Tcl_ValidateAllMemory(x,y)
2301 #endif /* !TCL_MEM_DEBUG */
2303 #ifdef TCL_MEM_DEBUG
2304 # define Tcl_IncrRefCount(objPtr) \
2305 Tcl_DbIncrRefCount(objPtr, __FILE__, __LINE__)
2306 # define Tcl_DecrRefCount(objPtr) \
2307 Tcl_DbDecrRefCount(objPtr, __FILE__, __LINE__)
2308 # define Tcl_IsShared(objPtr) \
2309 Tcl_DbIsShared(objPtr, __FILE__, __LINE__)
2310 #else
2311 # define Tcl_IncrRefCount(objPtr) \
2312 ++(objPtr)->refCount
2314 * Use do/while0 idiom for optimum correctness without compiler warnings.
2315 * http://c2.com/cgi/wiki?TrivialDoWhileLoop
2317 # define Tcl_DecrRefCount(objPtr) \
2318 do { if (--(objPtr)->refCount <= 0) TclFreeObj(objPtr); } while(0)
2319 # define Tcl_IsShared(objPtr) \
2320 ((objPtr)->refCount > 1)
2321 #endif
2324 * Macros and definitions that help to debug the use of Tcl objects. When
2325 * TCL_MEM_DEBUG is defined, the Tcl_New declarations are overridden to call
2326 * debugging versions of the object creation functions.
2329 #ifdef TCL_MEM_DEBUG
2330 # undef Tcl_NewBignumObj
2331 # define Tcl_NewBignumObj(val) \
2332 Tcl_DbNewBignumObj(val, __FILE__, __LINE__)
2333 # undef Tcl_NewBooleanObj
2334 # define Tcl_NewBooleanObj(val) \
2335 Tcl_DbNewBooleanObj(val, __FILE__, __LINE__)
2336 # undef Tcl_NewByteArrayObj
2337 # define Tcl_NewByteArrayObj(bytes, len) \
2338 Tcl_DbNewByteArrayObj(bytes, len, __FILE__, __LINE__)
2339 # undef Tcl_NewDoubleObj
2340 # define Tcl_NewDoubleObj(val) \
2341 Tcl_DbNewDoubleObj(val, __FILE__, __LINE__)
2342 # undef Tcl_NewIntObj
2343 # define Tcl_NewIntObj(val) \
2344 Tcl_DbNewLongObj(val, __FILE__, __LINE__)
2345 # undef Tcl_NewListObj
2346 # define Tcl_NewListObj(objc, objv) \
2347 Tcl_DbNewListObj(objc, objv, __FILE__, __LINE__)
2348 # undef Tcl_NewLongObj
2349 # define Tcl_NewLongObj(val) \
2350 Tcl_DbNewLongObj(val, __FILE__, __LINE__)
2351 # undef Tcl_NewObj
2352 # define Tcl_NewObj() \
2353 Tcl_DbNewObj(__FILE__, __LINE__)
2354 # undef Tcl_NewStringObj
2355 # define Tcl_NewStringObj(bytes, len) \
2356 Tcl_DbNewStringObj(bytes, len, __FILE__, __LINE__)
2357 # undef Tcl_NewWideIntObj
2358 # define Tcl_NewWideIntObj(val) \
2359 Tcl_DbNewWideIntObj(val, __FILE__, __LINE__)
2360 #endif /* TCL_MEM_DEBUG */
2363 * Macros for clients to use to access fields of hash entries:
2366 #define Tcl_GetHashValue(h) ((h)->clientData)
2367 #define Tcl_SetHashValue(h, value) ((h)->clientData = (ClientData) (value))
2368 #define Tcl_GetHashKey(tablePtr, h) \
2369 ((char *) (((tablePtr)->keyType == TCL_ONE_WORD_KEYS || \
2370 (tablePtr)->keyType == TCL_CUSTOM_PTR_KEYS) \
2371 ? (h)->key.oneWordValue \
2372 : (h)->key.string))
2375 * Macros to use for clients to use to invoke find and create functions for
2376 * hash tables:
2379 #undef Tcl_FindHashEntry
2380 #define Tcl_FindHashEntry(tablePtr, key) \
2381 (*((tablePtr)->findProc))(tablePtr, key)
2382 #undef Tcl_CreateHashEntry
2383 #define Tcl_CreateHashEntry(tablePtr, key, newPtr) \
2384 (*((tablePtr)->createProc))(tablePtr, key, newPtr)
2387 * Macros that eliminate the overhead of the thread synchronization functions
2388 * when compiling without thread support.
2391 #ifndef TCL_THREADS
2392 #undef Tcl_MutexLock
2393 #define Tcl_MutexLock(mutexPtr)
2394 #undef Tcl_MutexUnlock
2395 #define Tcl_MutexUnlock(mutexPtr)
2396 #undef Tcl_MutexFinalize
2397 #define Tcl_MutexFinalize(mutexPtr)
2398 #undef Tcl_ConditionNotify
2399 #define Tcl_ConditionNotify(condPtr)
2400 #undef Tcl_ConditionWait
2401 #define Tcl_ConditionWait(condPtr, mutexPtr, timePtr)
2402 #undef Tcl_ConditionFinalize
2403 #define Tcl_ConditionFinalize(condPtr)
2404 #endif /* TCL_THREADS */
2406 #ifndef TCL_NO_DEPRECATED
2408 * Deprecated Tcl functions:
2411 # undef Tcl_EvalObj
2412 # define Tcl_EvalObj(interp,objPtr) \
2413 Tcl_EvalObjEx((interp),(objPtr),0)
2414 # undef Tcl_GlobalEvalObj
2415 # define Tcl_GlobalEvalObj(interp,objPtr) \
2416 Tcl_EvalObjEx((interp),(objPtr),TCL_EVAL_GLOBAL)
2419 * These function have been renamed. The old names are deprecated, but we
2420 * define these macros for backwards compatibilty.
2423 # define Tcl_Ckalloc Tcl_Alloc
2424 # define Tcl_Ckfree Tcl_Free
2425 # define Tcl_Ckrealloc Tcl_Realloc
2426 # define Tcl_Return Tcl_SetResult
2427 # define Tcl_TildeSubst Tcl_TranslateFileName
2428 # define panic Tcl_Panic
2429 # define panicVA Tcl_PanicVA
2430 #endif
2433 * Convenience declaration of Tcl_AppInit for backwards compatibility. This
2434 * function is not *implemented* by the tcl library, so the storage class is
2435 * neither DLLEXPORT nor DLLIMPORT.
2438 #undef TCL_STORAGE_CLASS
2439 #define TCL_STORAGE_CLASS
2441 EXTERN int Tcl_AppInit _ANSI_ARGS_((Tcl_Interp *interp));
2443 #undef TCL_STORAGE_CLASS
2444 #define TCL_STORAGE_CLASS DLLIMPORT
2446 #endif /* RC_INVOKED */
2449 * end block for C++
2452 #ifdef __cplusplus
2454 #endif
2456 #endif /* _TCL */
2459 * Local Variables:
2460 * mode: c
2461 * c-basic-offset: 4
2462 * fill-column: 78
2463 * End: