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