1 /*
2  * tcl.h --
3  *
4  *	This header file describes the externally-visible facilities of the
5  *	Tcl interpreter.
6  *
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.
12  *
13  * See the file "license.terms" for information on usage and redistribution of
14  * this file, and for a DISCLAIMER OF ALL WARRANTIES.
15  */
16 
17 #ifndef _TCL
18 #define _TCL
19 
20 /*
21  * For C++ compilers, use extern "C"
22  */
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /*
29  * The following defines are used to indicate the various release levels.
30  */
31 
32 #define TCL_ALPHA_RELEASE	0
33 #define TCL_BETA_RELEASE	1
34 #define TCL_FINAL_RELEASE	2
35 
36 /*
37  * When version numbers change here, must also go into the following files and
38  * update the version numbers:
39  *
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)
56  */
57 
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
62 
63 #define TCL_VERSION	    "8.5"
64 #define TCL_PATCH_LEVEL	    "8.5.13"
65 
66 /*
67  * The following definitions set up the proper options for Windows compilers.
68  * We use this method because there is no autoconf equivalent.
69  */
70 
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
82 
83 /*
84  * STRICT: See MSDN Article Q83456
85  */
86 
87 #ifdef __WIN32__
88 #   ifndef STRICT
89 #	define STRICT
90 #   endif
91 #endif /* __WIN32__ */
92 
93 /*
94  * Utility macros: STRINGIFY takes an argument and wraps it in "" (double
95  * quotation marks), JOIN joins two arguments.
96  */
97 
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
106 
107 /*
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.
111  *
112  * Resource compilers don't like all the C stuff, like typedefs and function
113  * declarations, that occur below, so block them out.
114  */
115 
116 #ifndef RC_INVOKED
117 
118 /*
119  * Special macro to define mutexes, that doesn't do anything if we are not
120  * using threads.
121  */
122 
123 #ifdef TCL_THREADS
124 #define TCL_DECLARE_MUTEX(name) static Tcl_Mutex name;
125 #else
126 #define TCL_DECLARE_MUTEX(name)
127 #endif
128 
129 /*
130  * Tcl's public routine Tcl_FSSeek() uses the values SEEK_SET, SEEK_CUR, and
131  * SEEK_END, all #define'd by stdio.h .
132  *
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.
137  */
138 
139 #include <stdio.h>
140 
141 /*
142  * Support for functions with a variable number of arguments.
143  *
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 .
147  *
148  * New code should just directly be written to use stdarg.h conventions.
149  */
150 
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
157 
158 /*
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.
164  *
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.
169  */
170 
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
195 
196 /*
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.
204  *
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.
210  */
211 
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
222 
223 /*
224  * Definitions that allow this header file to be used either with or without
225  * ANSI C features like function prototypes.
226  */
227 
228 #undef _ANSI_ARGS_
229 #undef CONST
230 #ifndef INLINE
231 #   define INLINE
232 #endif
233 
234 #ifndef NO_CONST
235 #   define CONST const
236 #else
237 #   define CONST
238 #endif
239 
240 #ifndef NO_PROTOTYPES
241 #   define _ANSI_ARGS_(x)	x
242 #else
243 #   define _ANSI_ARGS_(x)	()
244 #endif
245 
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
261 
262 /*
263  * Make sure EXTERN isn't defined elsewhere.
264  */
265 
266 #ifdef EXTERN
267 #   undef EXTERN
268 #endif /* EXTERN */
269 
270 #ifdef __cplusplus
271 #   define EXTERN extern "C" TCL_STORAGE_CLASS
272 #else
273 #   define EXTERN extern TCL_STORAGE_CLASS
274 #endif
275 
276 /*
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.
280  */
281 
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 */
290 
291 /*
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.
294  */
295 
296 #ifndef NO_VOID
297 #define VOID	void
298 #else
299 #define VOID	char
300 #endif
301 
302 /*
303  * Miscellaneous declarations.
304  */
305 
306 #ifndef _CLIENTDATA
307 #   ifndef NO_VOID
308 	typedef void *ClientData;
309 #   else
310 	typedef int *ClientData;
311 #   endif
312 #   define _CLIENTDATA
313 #endif
314 
315 /*
316  * Darwin specific configure overrides (to support fat compiles, where
317  * configure runs only once for multiple architectures):
318  */
319 
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__ */
332 
333 /*
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.)
337  *
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.
345  *
346  * The following invariant should hold for any long value 'longVal':
347  *	longVal == Tcl_WideAsLong(Tcl_LongAsWide(longVal))
348  *
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",...).
352  */
353 
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__ */
366 /*
367  * Don't know what platform it is and configure hasn't discovered what is
368  * going on for us. Try to guess...
369  */
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 */
386 
387 typedef TCL_WIDE_INT_TYPE		Tcl_WideInt;
388 typedef unsigned TCL_WIDE_INT_TYPE	Tcl_WideUInt;
389 
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 */
399 /*
400  * The next short section of defines are only done when not running on Windows
401  * or some other strange platform.
402  */
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 */
411 
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) && !defined(__APPLE__)
440     typedef struct stat64 Tcl_StatBuf;
441 #else
442     typedef struct stat Tcl_StatBuf;
443 #endif
444 
445 /*
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.
455  *
456  * Note: any change to the Tcl_Interp definition below must be mirrored in the
457  * "real" definition in tclInt.h.
458  *
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().
462  */
463 
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;
479 
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;
499 
500 /*
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.
504  */
505 
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
511 
512 /*
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.
516  */
517 
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
525 
526 /*
527  * Definition of values for default stacksize and the possible flags to be
528  * given to Tcl_CreateThread.
529  */
530 
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. */
535 
536 /*
537  * Flag values passed to Tcl_StringCaseMatch.
538  */
539 
540 #define TCL_MATCH_NOCASE	(1<<0)
541 
542 /*
543  * Flag values passed to Tcl_GetRegExpFromObj.
544  */
545 
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. */
560 
561 /*
562  * Flags values passed to Tcl_RegExpExecObj.
563  */
564 
565 #define	TCL_REG_NOTBOL	0001	/* Beginning of string does not match ^.  */
566 #define	TCL_REG_NOTEOL	0002	/* End of string does not match $. */
567 
568 /*
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.
572  */
573 
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;
580 
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;
589 
590 /*
591  * Picky compilers complain if this typdef doesn't appear before the struct's
592  * reference in tclDecls.h.
593  */
594 
595 typedef Tcl_StatBuf *Tcl_Stat_;
596 typedef struct stat *Tcl_OldStat_;
597 
598 /*
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:
604  *
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.
616  */
617 
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
623 
624 #define TCL_RESULT_SIZE		200
625 
626 /*
627  * Flags to control what substitutions are performed by Tcl_SubstObj():
628  */
629 
630 #define TCL_SUBST_COMMANDS	001
631 #define TCL_SUBST_VARIABLES	002
632 #define TCL_SUBST_BACKSLASHES	004
633 #define TCL_SUBST_ALL		007
634 
635 /*
636  * Argument descriptors for math function callbacks in expressions:
637  */
638 
639 typedef enum {
640     TCL_INT, TCL_DOUBLE, TCL_EITHER, TCL_WIDE_INT
641 } Tcl_ValueType;
642 
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;
650 
651 /*
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.
654  */
655 
656 struct Tcl_Obj;
657 
658 /*
659  * Function types defined by Tcl:
660  */
661 
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));
728 
729 /*
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.
733  */
734 
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;
752 
753 /*
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.
757  */
758 
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;
795 
796 /*
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.
802  */
803 
804 void		Tcl_IncrRefCount _ANSI_ARGS_((Tcl_Obj *objPtr));
805 void		Tcl_DecrRefCount _ANSI_ARGS_((Tcl_Obj *objPtr));
806 int		Tcl_IsShared _ANSI_ARGS_((Tcl_Obj *objPtr));
807 
808 /*
809  * The following structure contains the state needed by Tcl_SaveResult. No-one
810  * outside of Tcl should access any of these fields. This structure is
811  * typically allocated on the stack.
812  */
813 
814 typedef struct Tcl_SavedResult {
815     char *result;
816     Tcl_FreeProc *freeProc;
817     Tcl_Obj *objResultPtr;
818     char *appendResult;
819     int appendAvl;
820     int appendUsed;
821     char resultSpace[TCL_RESULT_SIZE+1];
822 } Tcl_SavedResult;
823 
824 /*
825  * The following definitions support Tcl's namespace facility. Note: the first
826  * five fields must match exactly the fields in a Namespace structure (see
827  * tclInt.h).
828  */
829 
830 typedef struct Tcl_Namespace {
831     char *name;			/* The namespace's name within its parent
832 				 * namespace. This contains no ::'s. The name
833 				 * of the global namespace is "" although "::"
834 				 * is an synonym. */
835     char *fullName;		/* The namespace's fully qualified name. This
836 				 * starts with ::. */
837     ClientData clientData;	/* Arbitrary value associated with this
838 				 * namespace. */
839     Tcl_NamespaceDeleteProc *deleteProc;
840 				/* Function invoked when deleting the
841 				 * namespace to, e.g., free clientData. */
842     struct Tcl_Namespace *parentPtr;
843 				/* Points to the namespace that contains this
844 				 * one. NULL if this is the global
845 				 * namespace. */
846 } Tcl_Namespace;
847 
848 /*
849  * The following structure represents a call frame, or activation record. A
850  * call frame defines a naming context for a procedure call: its local scope
851  * (for local variables) and its namespace scope (used for non-local
852  * variables; often the global :: namespace). A call frame can also define the
853  * naming context for a namespace eval or namespace inscope command: the
854  * namespace in which the command's code should execute. The Tcl_CallFrame
855  * structures exist only while procedures or namespace eval/inscope's are
856  * being executed, and provide a Tcl call stack.
857  *
858  * A call frame is initialized and pushed using Tcl_PushCallFrame and popped
859  * using Tcl_PopCallFrame. Storage for a Tcl_CallFrame must be provided by the
860  * Tcl_PushCallFrame caller, and callers typically allocate them on the C call
861  * stack for efficiency. For this reason, Tcl_CallFrame is defined as a
862  * structure and not as an opaque token. However, most Tcl_CallFrame fields
863  * are hidden since applications should not access them directly; others are
864  * declared as "dummyX".
865  *
866  * WARNING!! The structure definition must be kept consistent with the
867  * CallFrame structure in tclInt.h. If you change one, change the other.
868  */
869 
870 typedef struct Tcl_CallFrame {
871     Tcl_Namespace *nsPtr;
872     int dummy1;
873     int dummy2;
874     VOID *dummy3;
875     VOID *dummy4;
876     VOID *dummy5;
877     int dummy6;
878     VOID *dummy7;
879     VOID *dummy8;
880     int dummy9;
881     VOID *dummy10;
882     VOID *dummy11;
883     VOID *dummy12;
884     VOID *dummy13;
885 } Tcl_CallFrame;
886 
887 /*
888  * Information about commands that is returned by Tcl_GetCommandInfo and
889  * passed to Tcl_SetCommandInfo. objProc is an objc/objv object-based command
890  * function while proc is a traditional Tcl argc/argv string-based function.
891  * Tcl_CreateObjCommand and Tcl_CreateCommand ensure that both objProc and
892  * proc are non-NULL and can be called to execute the command. However, it may
893  * be faster to call one instead of the other. The member isNativeObjectProc
894  * is set to 1 if an object-based function was registered by
895  * Tcl_CreateObjCommand, and to 0 if a string-based function was registered by
896  * Tcl_CreateCommand. The other function is typically set to a compatibility
897  * wrapper that does string-to-object or object-to-string argument conversions
898  * then calls the other function.
899  */
900 
901 typedef struct Tcl_CmdInfo {
902     int isNativeObjectProc;	/* 1 if objProc was registered by a call to
903 				 * Tcl_CreateObjCommand; 0 otherwise.
904 				 * Tcl_SetCmdInfo does not modify this
905 				 * field. */
906     Tcl_ObjCmdProc *objProc;	/* Command's object-based function. */
907     ClientData objClientData;	/* ClientData for object proc. */
908     Tcl_CmdProc *proc;		/* Command's string-based function. */
909     ClientData clientData;	/* ClientData for string proc. */
910     Tcl_CmdDeleteProc *deleteProc;
911 				/* Function to call when command is
912 				 * deleted. */
913     ClientData deleteData;	/* Value to pass to deleteProc (usually the
914 				 * same as clientData). */
915     Tcl_Namespace *namespacePtr;/* Points to the namespace that contains this
916 				 * command. Note that Tcl_SetCmdInfo will not
917 				 * change a command's namespace; use
918 				 * TclRenameCommand or Tcl_Eval (of 'rename')
919 				 * to do that. */
920 } Tcl_CmdInfo;
921 
922 /*
923  * The structure defined below is used to hold dynamic strings. The only
924  * fields that clients should use are string and length, accessible via the
925  * macros Tcl_DStringValue and Tcl_DStringLength.
926  */
927 
928 #define TCL_DSTRING_STATIC_SIZE 200
929 typedef struct Tcl_DString {
930     char *string;		/* Points to beginning of string: either
931 				 * staticSpace below or a malloced array. */
932     int length;			/* Number of non-NULL characters in the
933 				 * string. */
934     int spaceAvl;		/* Total number of bytes available for the
935 				 * string and its terminating NULL char. */
936     char staticSpace[TCL_DSTRING_STATIC_SIZE];
937 				/* Space to use in common case where string is
938 				 * small. */
939 } Tcl_DString;
940 
941 #define Tcl_DStringLength(dsPtr) ((dsPtr)->length)
942 #define Tcl_DStringValue(dsPtr) ((dsPtr)->string)
943 #define Tcl_DStringTrunc Tcl_DStringSetLength
944 
945 /*
946  * Definitions for the maximum number of digits of precision that may be
947  * specified in the "tcl_precision" variable, and the number of bytes of
948  * buffer space required by Tcl_PrintDouble.
949  */
950 
951 #define TCL_MAX_PREC		17
952 #define TCL_DOUBLE_SPACE	(TCL_MAX_PREC+10)
953 
954 /*
955  * Definition for a number of bytes of buffer space sufficient to hold the
956  * string representation of an integer in base 10 (assuming the existence of
957  * 64-bit integers).
958  */
959 
960 #define TCL_INTEGER_SPACE	24
961 
962 /*
963  * Flag values passed to Tcl_ConvertElement.
964  * TCL_DONT_USE_BRACES forces it not to enclose the element in braces, but to
965  *	use backslash quoting instead.
966  * TCL_DONT_QUOTE_HASH disables the default quoting of the '#' character. It
967  *	is safe to leave the hash unquoted when the element is not the first
968  *	element of a list, and this flag can be used by the caller to indicate
969  *	that condition.
970  */
971 
972 #define TCL_DONT_USE_BRACES	1
973 #define TCL_DONT_QUOTE_HASH	8
974 
975 /*
976  * Flag that may be passed to Tcl_GetIndexFromObj to force it to disallow
977  * abbreviated strings.
978  */
979 
980 #define TCL_EXACT	1
981 
982 /*
983  * Flag values passed to Tcl_RecordAndEval, Tcl_EvalObj, Tcl_EvalObjv.
984  * WARNING: these bit choices must not conflict with the bit choices for
985  * evalFlag bits in tclInt.h!
986  *
987  * Meanings:
988  *	TCL_NO_EVAL:		Just record this command
989  *	TCL_EVAL_GLOBAL:	Execute script in global namespace
990  *	TCL_EVAL_DIRECT:	Do not compile this script
991  *	TCL_EVAL_INVOKE:	Magical Tcl_EvalObjv mode for aliases/ensembles
992  *				o Run in iPtr->lookupNsPtr or global namespace
993  *				o Cut out of error traces
994  *				o Don't reset the flags controlling ensemble
995  *				  error message rewriting.
996  */
997 #define TCL_NO_EVAL		0x10000
998 #define TCL_EVAL_GLOBAL		0x20000
999 #define TCL_EVAL_DIRECT		0x40000
1000 #define TCL_EVAL_INVOKE		0x80000
1001 
1002 /*
1003  * Special freeProc values that may be passed to Tcl_SetResult (see the man
1004  * page for details):
1005  */
1006 
1007 #define TCL_VOLATILE		((Tcl_FreeProc *) 1)
1008 #define TCL_STATIC		((Tcl_FreeProc *) 0)
1009 #define TCL_DYNAMIC		((Tcl_FreeProc *) 3)
1010 
1011 /*
1012  * Flag values passed to variable-related functions.
1013  */
1014 
1015 #define TCL_GLOBAL_ONLY		 1
1016 #define TCL_NAMESPACE_ONLY	 2
1017 #define TCL_APPEND_VALUE	 4
1018 #define TCL_LIST_ELEMENT	 8
1019 #define TCL_TRACE_READS		 0x10
1020 #define TCL_TRACE_WRITES	 0x20
1021 #define TCL_TRACE_UNSETS	 0x40
1022 #define TCL_TRACE_DESTROYED	 0x80
1023 #define TCL_INTERP_DESTROYED	 0x100
1024 #define TCL_LEAVE_ERR_MSG	 0x200
1025 #define TCL_TRACE_ARRAY		 0x800
1026 #ifndef TCL_REMOVE_OBSOLETE_TRACES
1027 /* Required to support old variable/vdelete/vinfo traces */
1028 #define TCL_TRACE_OLD_STYLE	 0x1000
1029 #endif
1030 /* Indicate the semantics of the result of a trace */
1031 #define TCL_TRACE_RESULT_DYNAMIC 0x8000
1032 #define TCL_TRACE_RESULT_OBJECT  0x10000
1033 
1034 /*
1035  * Flag values for ensemble commands.
1036  */
1037 
1038 #define TCL_ENSEMBLE_PREFIX 0x02/* Flag value to say whether to allow
1039 				 * unambiguous prefixes of commands or to
1040 				 * require exact matches for command names. */
1041 
1042 /*
1043  * Flag values passed to command-related functions.
1044  */
1045 
1046 #define TCL_TRACE_RENAME 0x2000
1047 #define TCL_TRACE_DELETE 0x4000
1048 
1049 #define TCL_ALLOW_INLINE_COMPILATION 0x20000
1050 
1051 /*
1052  * The TCL_PARSE_PART1 flag is deprecated and has no effect. The part1 is now
1053  * always parsed whenever the part2 is NULL. (This is to avoid a common error
1054  * when converting code to use the new object based APIs and forgetting to
1055  * give the flag)
1056  */
1057 
1058 #ifndef TCL_NO_DEPRECATED
1059 #   define TCL_PARSE_PART1	0x400
1060 #endif
1061 
1062 /*
1063  * Types for linked variables:
1064  */
1065 
1066 #define TCL_LINK_INT		1
1067 #define TCL_LINK_DOUBLE		2
1068 #define TCL_LINK_BOOLEAN	3
1069 #define TCL_LINK_STRING		4
1070 #define TCL_LINK_WIDE_INT	5
1071 #define TCL_LINK_CHAR		6
1072 #define TCL_LINK_UCHAR		7
1073 #define TCL_LINK_SHORT		8
1074 #define TCL_LINK_USHORT		9
1075 #define TCL_LINK_UINT		10
1076 #define TCL_LINK_LONG		11
1077 #define TCL_LINK_ULONG		12
1078 #define TCL_LINK_FLOAT		13
1079 #define TCL_LINK_WIDE_UINT	14
1080 #define TCL_LINK_READ_ONLY	0x80
1081 
1082 /*
1083  * Forward declarations of Tcl_HashTable and related types.
1084  */
1085 
1086 typedef struct Tcl_HashKeyType Tcl_HashKeyType;
1087 typedef struct Tcl_HashTable Tcl_HashTable;
1088 typedef struct Tcl_HashEntry Tcl_HashEntry;
1089 
1090 typedef unsigned int (Tcl_HashKeyProc) _ANSI_ARGS_((Tcl_HashTable *tablePtr,
1091 	VOID *keyPtr));
1092 typedef int (Tcl_CompareHashKeysProc) _ANSI_ARGS_((VOID *keyPtr,
1093 	Tcl_HashEntry *hPtr));
1094 typedef Tcl_HashEntry *(Tcl_AllocHashEntryProc) _ANSI_ARGS_((
1095 	Tcl_HashTable *tablePtr, VOID *keyPtr));
1096 typedef void (Tcl_FreeHashEntryProc) _ANSI_ARGS_((Tcl_HashEntry *hPtr));
1097 
1098 /*
1099  * This flag controls whether the hash table stores the hash of a key, or
1100  * recalculates it. There should be no reason for turning this flag off as it
1101  * is completely binary and source compatible unless you directly access the
1102  * bucketPtr member of the Tcl_HashTableEntry structure. This member has been
1103  * removed and the space used to store the hash value.
1104  */
1105 
1106 #ifndef TCL_HASH_KEY_STORE_HASH
1107 #   define TCL_HASH_KEY_STORE_HASH 1
1108 #endif
1109 
1110 /*
1111  * Structure definition for an entry in a hash table. No-one outside Tcl
1112  * should access any of these fields directly; use the macros defined below.
1113  */
1114 
1115 struct Tcl_HashEntry {
1116     Tcl_HashEntry *nextPtr;	/* Pointer to next entry in this hash bucket,
1117 				 * or NULL for end of chain. */
1118     Tcl_HashTable *tablePtr;	/* Pointer to table containing entry. */
1119 #if TCL_HASH_KEY_STORE_HASH
1120     VOID *hash;			/* Hash value, stored as pointer to ensure
1121 				 * that the offsets of the fields in this
1122 				 * structure are not changed. */
1123 #else
1124     Tcl_HashEntry **bucketPtr;	/* Pointer to bucket that points to first
1125 				 * entry in this entry's chain: used for
1126 				 * deleting the entry. */
1127 #endif
1128     ClientData clientData;	/* Application stores something here with
1129 				 * Tcl_SetHashValue. */
1130     union {			/* Key has one of these forms: */
1131 	char *oneWordValue;	/* One-word value for key. */
1132 	Tcl_Obj *objPtr;	/* Tcl_Obj * key value. */
1133 	int words[1];		/* Multiple integer words for key. The actual
1134 				 * size will be as large as necessary for this
1135 				 * table's keys. */
1136 	char string[4];		/* String for key. The actual size will be as
1137 				 * large as needed to hold the key. */
1138     } key;			/* MUST BE LAST FIELD IN RECORD!! */
1139 };
1140 
1141 /*
1142  * Flags used in Tcl_HashKeyType.
1143  *
1144  * TCL_HASH_KEY_RANDOMIZE_HASH -
1145  *				There are some things, pointers for example
1146  *				which don't hash well because they do not use
1147  *				the lower bits. If this flag is set then the
1148  *				hash table will attempt to rectify this by
1149  *				randomising the bits and then using the upper
1150  *				N bits as the index into the table.
1151  * TCL_HASH_KEY_SYSTEM_HASH -	If this flag is set then all memory internally
1152  *                              allocated for the hash table that is not for an
1153  *                              entry will use the system heap.
1154  */
1155 
1156 #define TCL_HASH_KEY_RANDOMIZE_HASH 0x1
1157 #define TCL_HASH_KEY_SYSTEM_HASH    0x2
1158 
1159 /*
1160  * Structure definition for the methods associated with a hash table key type.
1161  */
1162 
1163 #define TCL_HASH_KEY_TYPE_VERSION 1
1164 struct Tcl_HashKeyType {
1165     int version;		/* Version of the table. If this structure is
1166 				 * extended in future then the version can be
1167 				 * used to distinguish between different
1168 				 * structures. */
1169     int flags;			/* Flags, see above for details. */
1170     Tcl_HashKeyProc *hashKeyProc;
1171 				/* Calculates a hash value for the key. If
1172 				 * this is NULL then the pointer itself is
1173 				 * used as a hash value. */
1174     Tcl_CompareHashKeysProc *compareKeysProc;
1175 				/* Compares two keys and returns zero if they
1176 				 * do not match, and non-zero if they do. If
1177 				 * this is NULL then the pointers are
1178 				 * compared. */
1179     Tcl_AllocHashEntryProc *allocEntryProc;
1180 				/* Called to allocate memory for a new entry,
1181 				 * i.e. if the key is a string then this could
1182 				 * allocate a single block which contains
1183 				 * enough space for both the entry and the
1184 				 * string. Only the key field of the allocated
1185 				 * Tcl_HashEntry structure needs to be filled
1186 				 * in. If something else needs to be done to
1187 				 * the key, i.e. incrementing a reference
1188 				 * count then that should be done by this
1189 				 * function. If this is NULL then Tcl_Alloc is
1190 				 * used to allocate enough space for a
1191 				 * Tcl_HashEntry and the key pointer is
1192 				 * assigned to key.oneWordValue. */
1193     Tcl_FreeHashEntryProc *freeEntryProc;
1194 				/* Called to free memory associated with an
1195 				 * entry. If something else needs to be done
1196 				 * to the key, i.e. decrementing a reference
1197 				 * count then that should be done by this
1198 				 * function. If this is NULL then Tcl_Free is
1199 				 * used to free the Tcl_HashEntry. */
1200 };
1201 
1202 /*
1203  * Structure definition for a hash table.  Must be in tcl.h so clients can
1204  * allocate space for these structures, but clients should never access any
1205  * fields in this structure.
1206  */
1207 
1208 #define TCL_SMALL_HASH_TABLE 4
1209 struct Tcl_HashTable {
1210     Tcl_HashEntry **buckets;	/* Pointer to bucket array. Each element
1211 				 * points to first entry in bucket's hash
1212 				 * chain, or NULL. */
1213     Tcl_HashEntry *staticBuckets[TCL_SMALL_HASH_TABLE];
1214 				/* Bucket array used for small tables (to
1215 				 * avoid mallocs and frees). */
1216     int numBuckets;		/* Total number of buckets allocated at
1217 				 * **bucketPtr. */
1218     int numEntries;		/* Total number of entries present in
1219 				 * table. */
1220     int rebuildSize;		/* Enlarge table when numEntries gets to be
1221 				 * this large. */
1222     int downShift;		/* Shift count used in hashing function.
1223 				 * Designed to use high-order bits of
1224 				 * randomized keys. */
1225     int mask;			/* Mask value used in hashing function. */
1226     int keyType;		/* Type of keys used in this table. It's
1227 				 * either TCL_CUSTOM_KEYS, TCL_STRING_KEYS,
1228 				 * TCL_ONE_WORD_KEYS, or an integer giving the
1229 				 * number of ints that is the size of the
1230 				 * key. */
1231     Tcl_HashEntry *(*findProc) _ANSI_ARGS_((Tcl_HashTable *tablePtr,
1232 	    CONST char *key));
1233     Tcl_HashEntry *(*createProc) _ANSI_ARGS_((Tcl_HashTable *tablePtr,
1234 	    CONST char *key, int *newPtr));
1235     Tcl_HashKeyType *typePtr;	/* Type of the keys used in the
1236 				 * Tcl_HashTable. */
1237 };
1238 
1239 /*
1240  * Structure definition for information used to keep track of searches through
1241  * hash tables:
1242  */
1243 
1244 typedef struct Tcl_HashSearch {
1245     Tcl_HashTable *tablePtr;	/* Table being searched. */
1246     int nextIndex;		/* Index of next bucket to be enumerated after
1247 				 * present one. */
1248     Tcl_HashEntry *nextEntryPtr;/* Next entry to be enumerated in the current
1249 				 * bucket. */
1250 } Tcl_HashSearch;
1251 
1252 /*
1253  * Acceptable key types for hash tables:
1254  *
1255  * TCL_STRING_KEYS:		The keys are strings, they are copied into the
1256  *				entry.
1257  * TCL_ONE_WORD_KEYS:		The keys are pointers, the pointer is stored
1258  *				in the entry.
1259  * TCL_CUSTOM_TYPE_KEYS:	The keys are arbitrary types which are copied
1260  *				into the entry.
1261  * TCL_CUSTOM_PTR_KEYS:		The keys are pointers to arbitrary types, the
1262  *				pointer is stored in the entry.
1263  *
1264  * While maintaining binary compatability the above have to be distinct values
1265  * as they are used to differentiate between old versions of the hash table
1266  * which don't have a typePtr and new ones which do. Once binary compatability
1267  * is discarded in favour of making more wide spread changes TCL_STRING_KEYS
1268  * can be the same as TCL_CUSTOM_TYPE_KEYS, and TCL_ONE_WORD_KEYS can be the
1269  * same as TCL_CUSTOM_PTR_KEYS because they simply determine how the key is
1270  * accessed from the entry and not the behaviour.
1271  */
1272 
1273 #define TCL_STRING_KEYS		0
1274 #define TCL_ONE_WORD_KEYS	1
1275 #define TCL_CUSTOM_TYPE_KEYS	-2
1276 #define TCL_CUSTOM_PTR_KEYS	-1
1277 
1278 /*
1279  * Structure definition for information used to keep track of searches through
1280  * dictionaries. These fields should not be accessed by code outside
1281  * tclDictObj.c
1282  */
1283 
1284 typedef struct {
1285     void *next;			/* Search position for underlying hash
1286 				 * table. */
1287     int epoch;			/* Epoch marker for dictionary being searched,
1288 				 * or -1 if search has terminated. */
1289     Tcl_Dict dictionaryPtr;	/* Reference to dictionary being searched. */
1290 } Tcl_DictSearch;
1291 
1292 /*
1293  * Flag values to pass to Tcl_DoOneEvent to disable searches for some kinds of
1294  * events:
1295  */
1296 
1297 #define TCL_DONT_WAIT		(1<<1)
1298 #define TCL_WINDOW_EVENTS	(1<<2)
1299 #define TCL_FILE_EVENTS		(1<<3)
1300 #define TCL_TIMER_EVENTS	(1<<4)
1301 #define TCL_IDLE_EVENTS		(1<<5)	/* WAS 0x10 ???? */
1302 #define TCL_ALL_EVENTS		(~TCL_DONT_WAIT)
1303 
1304 /*
1305  * The following structure defines a generic event for the Tcl event system.
1306  * These are the things that are queued in calls to Tcl_QueueEvent and
1307  * serviced later by Tcl_DoOneEvent. There can be many different kinds of
1308  * events with different fields, corresponding to window events, timer events,
1309  * etc. The structure for a particular event consists of a Tcl_Event header
1310  * followed by additional information specific to that event.
1311  */
1312 
1313 struct Tcl_Event {
1314     Tcl_EventProc *proc;	/* Function to call to service this event. */
1315     struct Tcl_Event *nextPtr;	/* Next in list of pending events, or NULL. */
1316 };
1317 
1318 /*
1319  * Positions to pass to Tcl_QueueEvent:
1320  */
1321 
1322 typedef enum {
1323     TCL_QUEUE_TAIL, TCL_QUEUE_HEAD, TCL_QUEUE_MARK
1324 } Tcl_QueuePosition;
1325 
1326 /*
1327  * Values to pass to Tcl_SetServiceMode to specify the behavior of notifier
1328  * event routines.
1329  */
1330 
1331 #define TCL_SERVICE_NONE 0
1332 #define TCL_SERVICE_ALL 1
1333 
1334 /*
1335  * The following structure keeps is used to hold a time value, either as an
1336  * absolute time (the number of seconds from the epoch) or as an elapsed time.
1337  * On Unix systems the epoch is Midnight Jan 1, 1970 GMT.
1338  */
1339 
1340 typedef struct Tcl_Time {
1341     long sec;			/* Seconds. */
1342     long usec;			/* Microseconds. */
1343 } Tcl_Time;
1344 
1345 typedef void (Tcl_SetTimerProc) _ANSI_ARGS_((Tcl_Time *timePtr));
1346 typedef int (Tcl_WaitForEventProc) _ANSI_ARGS_((Tcl_Time *timePtr));
1347 
1348 /*
1349  * TIP #233 (Virtualized Time)
1350  */
1351 
1352 typedef void (Tcl_GetTimeProc)   _ANSI_ARGS_((Tcl_Time *timebuf,
1353 	ClientData clientData));
1354 typedef void (Tcl_ScaleTimeProc) _ANSI_ARGS_((Tcl_Time *timebuf,
1355 	ClientData clientData));
1356 
1357 /*
1358  * Bits to pass to Tcl_CreateFileHandler and Tcl_CreateChannelHandler to
1359  * indicate what sorts of events are of interest:
1360  */
1361 
1362 #define TCL_READABLE		(1<<1)
1363 #define TCL_WRITABLE		(1<<2)
1364 #define TCL_EXCEPTION		(1<<3)
1365 
1366 /*
1367  * Flag values to pass to Tcl_OpenCommandChannel to indicate the disposition
1368  * of the stdio handles. TCL_STDIN, TCL_STDOUT, TCL_STDERR, are also used in
1369  * Tcl_GetStdChannel.
1370  */
1371 
1372 #define TCL_STDIN		(1<<1)
1373 #define TCL_STDOUT		(1<<2)
1374 #define TCL_STDERR		(1<<3)
1375 #define TCL_ENFORCE_MODE	(1<<4)
1376 
1377 /*
1378  * Bits passed to Tcl_DriverClose2Proc to indicate which side of a channel
1379  * should be closed.
1380  */
1381 
1382 #define TCL_CLOSE_READ		(1<<1)
1383 #define TCL_CLOSE_WRITE		(1<<2)
1384 
1385 /*
1386  * Value to use as the closeProc for a channel that supports the close2Proc
1387  * interface.
1388  */
1389 
1390 #define TCL_CLOSE2PROC		((Tcl_DriverCloseProc *) 1)
1391 
1392 /*
1393  * Channel version tag. This was introduced in 8.3.2/8.4.
1394  */
1395 
1396 #define TCL_CHANNEL_VERSION_1	((Tcl_ChannelTypeVersion) 0x1)
1397 #define TCL_CHANNEL_VERSION_2	((Tcl_ChannelTypeVersion) 0x2)
1398 #define TCL_CHANNEL_VERSION_3	((Tcl_ChannelTypeVersion) 0x3)
1399 #define TCL_CHANNEL_VERSION_4	((Tcl_ChannelTypeVersion) 0x4)
1400 #define TCL_CHANNEL_VERSION_5	((Tcl_ChannelTypeVersion) 0x5)
1401 
1402 /*
1403  * TIP #218: Channel Actions, Ids for Tcl_DriverThreadActionProc.
1404  */
1405 
1406 #define TCL_CHANNEL_THREAD_INSERT (0)
1407 #define TCL_CHANNEL_THREAD_REMOVE (1)
1408 
1409 /*
1410  * Typedefs for the various operations in a channel type:
1411  */
1412 
1413 typedef int	(Tcl_DriverBlockModeProc) _ANSI_ARGS_((
1414 		    ClientData instanceData, int mode));
1415 typedef int	(Tcl_DriverCloseProc) _ANSI_ARGS_((ClientData instanceData,
1416 		    Tcl_Interp *interp));
1417 typedef int	(Tcl_DriverClose2Proc) _ANSI_ARGS_((ClientData instanceData,
1418 		    Tcl_Interp *interp, int flags));
1419 typedef int	(Tcl_DriverInputProc) _ANSI_ARGS_((ClientData instanceData,
1420 		    char *buf, int toRead, int *errorCodePtr));
1421 typedef int	(Tcl_DriverOutputProc) _ANSI_ARGS_((ClientData instanceData,
1422 		    CONST84 char *buf, int toWrite, int *errorCodePtr));
1423 typedef int	(Tcl_DriverSeekProc) _ANSI_ARGS_((ClientData instanceData,
1424 		    long offset, int mode, int *errorCodePtr));
1425 typedef int	(Tcl_DriverSetOptionProc) _ANSI_ARGS_((
1426 		    ClientData instanceData, Tcl_Interp *interp,
1427 		    CONST char *optionName, CONST char *value));
1428 typedef int	(Tcl_DriverGetOptionProc) _ANSI_ARGS_((
1429 		    ClientData instanceData, Tcl_Interp *interp,
1430 		    CONST84 char *optionName, Tcl_DString *dsPtr));
1431 typedef void	(Tcl_DriverWatchProc) _ANSI_ARGS_((
1432 		    ClientData instanceData, int mask));
1433 typedef int	(Tcl_DriverGetHandleProc) _ANSI_ARGS_((
1434 		    ClientData instanceData, int direction,
1435 		    ClientData *handlePtr));
1436 typedef int	(Tcl_DriverFlushProc) _ANSI_ARGS_((ClientData instanceData));
1437 typedef int	(Tcl_DriverHandlerProc) _ANSI_ARGS_((
1438 		    ClientData instanceData, int interestMask));
1439 typedef Tcl_WideInt (Tcl_DriverWideSeekProc) _ANSI_ARGS_((
1440 		    ClientData instanceData, Tcl_WideInt offset,
1441 		    int mode, int *errorCodePtr));
1442 /*
1443  * TIP #218, Channel Thread Actions
1444  */
1445 typedef void	(Tcl_DriverThreadActionProc) _ANSI_ARGS_ ((
1446 		    ClientData instanceData, int action));
1447 /*
1448  * TIP #208, File Truncation (etc.)
1449  */
1450 typedef int	(Tcl_DriverTruncateProc) _ANSI_ARGS_((
1451 		    ClientData instanceData, Tcl_WideInt length));
1452 
1453 /*
1454  * struct Tcl_ChannelType:
1455  *
1456  * One such structure exists for each type (kind) of channel. It collects
1457  * together in one place all the functions that are part of the specific
1458  * channel type.
1459  *
1460  * It is recommend that the Tcl_Channel* functions are used to access elements
1461  * of this structure, instead of direct accessing.
1462  */
1463 
1464 typedef struct Tcl_ChannelType {
1465     char *typeName;		/* The name of the channel type in Tcl
1466 				 * commands. This storage is owned by channel
1467 				 * type. */
1468     Tcl_ChannelTypeVersion version;
1469 				/* Version of the channel type. */
1470     Tcl_DriverCloseProc *closeProc;
1471 				/* Function to call to close the channel, or
1472 				 * TCL_CLOSE2PROC if the close2Proc should be
1473 				 * used instead. */
1474     Tcl_DriverInputProc *inputProc;
1475 				/* Function to call for input on channel. */
1476     Tcl_DriverOutputProc *outputProc;
1477 				/* Function to call for output on channel. */
1478     Tcl_DriverSeekProc *seekProc;
1479 				/* Function to call to seek on the channel.
1480 				 * May be NULL. */
1481     Tcl_DriverSetOptionProc *setOptionProc;
1482 				/* Set an option on a channel. */
1483     Tcl_DriverGetOptionProc *getOptionProc;
1484 				/* Get an option from a channel. */
1485     Tcl_DriverWatchProc *watchProc;
1486 				/* Set up the notifier to watch for events on
1487 				 * this channel. */
1488     Tcl_DriverGetHandleProc *getHandleProc;
1489 				/* Get an OS handle from the channel or NULL
1490 				 * if not supported. */
1491     Tcl_DriverClose2Proc *close2Proc;
1492 				/* Function to call to close the channel if
1493 				 * the device supports closing the read &
1494 				 * write sides independently. */
1495     Tcl_DriverBlockModeProc *blockModeProc;
1496 				/* Set blocking mode for the raw channel. May
1497 				 * be NULL. */
1498     /*
1499      * Only valid in TCL_CHANNEL_VERSION_2 channels or later.
1500      */
1501     Tcl_DriverFlushProc *flushProc;
1502 				/* Function to call to flush a channel. May be
1503 				 * NULL. */
1504     Tcl_DriverHandlerProc *handlerProc;
1505 				/* Function to call to handle a channel event.
1506 				 * This will be passed up the stacked channel
1507 				 * chain. */
1508     /*
1509      * Only valid in TCL_CHANNEL_VERSION_3 channels or later.
1510      */
1511     Tcl_DriverWideSeekProc *wideSeekProc;
1512 				/* Function to call to seek on the channel
1513 				 * which can handle 64-bit offsets. May be
1514 				 * NULL, and must be NULL if seekProc is
1515 				 * NULL. */
1516     /*
1517      * Only valid in TCL_CHANNEL_VERSION_4 channels or later.
1518      * TIP #218, Channel Thread Actions.
1519      */
1520     Tcl_DriverThreadActionProc *threadActionProc;
1521 				/* Function to call to notify the driver of
1522 				 * thread specific activity for a channel. May
1523 				 * be NULL. */
1524 
1525     /*
1526      * Only valid in TCL_CHANNEL_VERSION_5 channels or later.
1527      * TIP #208, File Truncation.
1528      */
1529     Tcl_DriverTruncateProc *truncateProc;
1530 				/* Function to call to truncate the underlying
1531 				 * file to a particular length. May be NULL if
1532 				 * the channel does not support truncation. */
1533 } Tcl_ChannelType;
1534 
1535 /*
1536  * The following flags determine whether the blockModeProc above should set
1537  * the channel into blocking or nonblocking mode. They are passed as arguments
1538  * to the blockModeProc function in the above structure.
1539  */
1540 
1541 #define TCL_MODE_BLOCKING	0	/* Put channel into blocking mode. */
1542 #define TCL_MODE_NONBLOCKING	1	/* Put channel into nonblocking
1543 					 * mode. */
1544 
1545 /*
1546  * Enum for different types of file paths.
1547  */
1548 
1549 typedef enum Tcl_PathType {
1550     TCL_PATH_ABSOLUTE,
1551     TCL_PATH_RELATIVE,
1552     TCL_PATH_VOLUME_RELATIVE
1553 } Tcl_PathType;
1554 
1555 /*
1556  * The following structure is used to pass glob type data amongst the various
1557  * glob routines and Tcl_FSMatchInDirectory.
1558  */
1559 
1560 typedef struct Tcl_GlobTypeData {
1561     int type;			/* Corresponds to bcdpfls as in 'find -t'. */
1562     int perm;			/* Corresponds to file permissions. */
1563     Tcl_Obj *macType;		/* Acceptable Mac type. */
1564     Tcl_Obj *macCreator;	/* Acceptable Mac creator. */
1565 } Tcl_GlobTypeData;
1566 
1567 /*
1568  * Type and permission definitions for glob command.
1569  */
1570 
1571 #define TCL_GLOB_TYPE_BLOCK		(1<<0)
1572 #define TCL_GLOB_TYPE_CHAR		(1<<1)
1573 #define TCL_GLOB_TYPE_DIR		(1<<2)
1574 #define TCL_GLOB_TYPE_PIPE		(1<<3)
1575 #define TCL_GLOB_TYPE_FILE		(1<<4)
1576 #define TCL_GLOB_TYPE_LINK		(1<<5)
1577 #define TCL_GLOB_TYPE_SOCK		(1<<6)
1578 #define TCL_GLOB_TYPE_MOUNT		(1<<7)
1579 
1580 #define TCL_GLOB_PERM_RONLY		(1<<0)
1581 #define TCL_GLOB_PERM_HIDDEN		(1<<1)
1582 #define TCL_GLOB_PERM_R			(1<<2)
1583 #define TCL_GLOB_PERM_W			(1<<3)
1584 #define TCL_GLOB_PERM_X			(1<<4)
1585 
1586 /*
1587  * Flags for the unload callback function.
1588  */
1589 
1590 #define TCL_UNLOAD_DETACH_FROM_INTERPRETER	(1<<0)
1591 #define TCL_UNLOAD_DETACH_FROM_PROCESS		(1<<1)
1592 
1593 /*
1594  * Typedefs for the various filesystem operations:
1595  */
1596 
1597 typedef int (Tcl_FSStatProc) _ANSI_ARGS_((Tcl_Obj *pathPtr, Tcl_StatBuf *buf));
1598 typedef int (Tcl_FSAccessProc) _ANSI_ARGS_((Tcl_Obj *pathPtr, int mode));
1599 typedef Tcl_Channel (Tcl_FSOpenFileChannelProc) _ANSI_ARGS_((
1600 	Tcl_Interp *interp, Tcl_Obj *pathPtr, int mode, int permissions));
1601 typedef int (Tcl_FSMatchInDirectoryProc) _ANSI_ARGS_((Tcl_Interp *interp,
1602 	Tcl_Obj *result, Tcl_Obj *pathPtr, CONST char *pattern,
1603 	Tcl_GlobTypeData * types));
1604 typedef Tcl_Obj * (Tcl_FSGetCwdProc) _ANSI_ARGS_((Tcl_Interp *interp));
1605 typedef int (Tcl_FSChdirProc) _ANSI_ARGS_((Tcl_Obj *pathPtr));
1606 typedef int (Tcl_FSLstatProc) _ANSI_ARGS_((Tcl_Obj *pathPtr,
1607 	Tcl_StatBuf *buf));
1608 typedef int (Tcl_FSCreateDirectoryProc) _ANSI_ARGS_((Tcl_Obj *pathPtr));
1609 typedef int (Tcl_FSDeleteFileProc) _ANSI_ARGS_((Tcl_Obj *pathPtr));
1610 typedef int (Tcl_FSCopyDirectoryProc) _ANSI_ARGS_((Tcl_Obj *srcPathPtr,
1611 	Tcl_Obj *destPathPtr, Tcl_Obj **errorPtr));
1612 typedef int (Tcl_FSCopyFileProc) _ANSI_ARGS_((Tcl_Obj *srcPathPtr,
1613 	Tcl_Obj *destPathPtr));
1614 typedef int (Tcl_FSRemoveDirectoryProc) _ANSI_ARGS_((Tcl_Obj *pathPtr,
1615 	int recursive, Tcl_Obj **errorPtr));
1616 typedef int (Tcl_FSRenameFileProc) _ANSI_ARGS_((Tcl_Obj *srcPathPtr,
1617 	Tcl_Obj *destPathPtr));
1618 typedef void (Tcl_FSUnloadFileProc) _ANSI_ARGS_((Tcl_LoadHandle loadHandle));
1619 typedef Tcl_Obj * (Tcl_FSListVolumesProc) _ANSI_ARGS_((void));
1620 /* We have to declare the utime structure here. */
1621 struct utimbuf;
1622 typedef int (Tcl_FSUtimeProc) _ANSI_ARGS_((Tcl_Obj *pathPtr,
1623 	struct utimbuf *tval));
1624 typedef int (Tcl_FSNormalizePathProc) _ANSI_ARGS_((Tcl_Interp *interp,
1625 	Tcl_Obj *pathPtr, int nextCheckpoint));
1626 typedef int (Tcl_FSFileAttrsGetProc) _ANSI_ARGS_((Tcl_Interp *interp,
1627 	int index, Tcl_Obj *pathPtr, Tcl_Obj **objPtrRef));
1628 typedef CONST char ** (Tcl_FSFileAttrStringsProc) _ANSI_ARGS_((
1629 	Tcl_Obj *pathPtr, Tcl_Obj **objPtrRef));
1630 typedef int (Tcl_FSFileAttrsSetProc) _ANSI_ARGS_((Tcl_Interp *interp,
1631 	int index, Tcl_Obj *pathPtr, Tcl_Obj *objPtr));
1632 typedef Tcl_Obj * (Tcl_FSLinkProc) _ANSI_ARGS_((Tcl_Obj *pathPtr,
1633 	Tcl_Obj *toPtr, int linkType));
1634 typedef int (Tcl_FSLoadFileProc) _ANSI_ARGS_((Tcl_Interp * interp,
1635 	Tcl_Obj *pathPtr, Tcl_LoadHandle *handlePtr,
1636 	Tcl_FSUnloadFileProc **unloadProcPtr));
1637 typedef int (Tcl_FSPathInFilesystemProc) _ANSI_ARGS_((Tcl_Obj *pathPtr,
1638 	ClientData *clientDataPtr));
1639 typedef Tcl_Obj * (Tcl_FSFilesystemPathTypeProc) _ANSI_ARGS_((
1640 	Tcl_Obj *pathPtr));
1641 typedef Tcl_Obj * (Tcl_FSFilesystemSeparatorProc) _ANSI_ARGS_((
1642 	Tcl_Obj *pathPtr));
1643 typedef void (Tcl_FSFreeInternalRepProc) _ANSI_ARGS_((ClientData clientData));
1644 typedef ClientData (Tcl_FSDupInternalRepProc) _ANSI_ARGS_((
1645 	ClientData clientData));
1646 typedef Tcl_Obj * (Tcl_FSInternalToNormalizedProc) _ANSI_ARGS_((
1647 	ClientData clientData));
1648 typedef ClientData (Tcl_FSCreateInternalRepProc) _ANSI_ARGS_((
1649 	Tcl_Obj *pathPtr));
1650 
1651 typedef struct Tcl_FSVersion_ *Tcl_FSVersion;
1652 
1653 /*
1654  *----------------------------------------------------------------
1655  * Data structures related to hooking into the filesystem
1656  *----------------------------------------------------------------
1657  */
1658 
1659 /*
1660  * Filesystem version tag.  This was introduced in 8.4.
1661  */
1662 #define TCL_FILESYSTEM_VERSION_1	((Tcl_FSVersion) 0x1)
1663 
1664 /*
1665  * struct Tcl_Filesystem:
1666  *
1667  * One such structure exists for each type (kind) of filesystem. It collects
1668  * together in one place all the functions that are part of the specific
1669  * filesystem. Tcl always accesses the filesystem through one of these
1670  * structures.
1671  *
1672  * Not all entries need be non-NULL; any which are NULL are simply ignored.
1673  * However, a complete filesystem should provide all of these functions. The
1674  * explanations in the structure show the importance of each function.
1675  */
1676 
1677 typedef struct Tcl_Filesystem {
1678     CONST char *typeName;	/* The name of the filesystem. */
1679     int structureLength;	/* Length of this structure, so future binary
1680 				 * compatibility can be assured. */
1681     Tcl_FSVersion version;	/* Version of the filesystem type. */
1682     Tcl_FSPathInFilesystemProc *pathInFilesystemProc;
1683 				/* Function to check whether a path is in this
1684 				 * filesystem. This is the most important
1685 				 * filesystem function. */
1686     Tcl_FSDupInternalRepProc *dupInternalRepProc;
1687 				/* Function to duplicate internal fs rep. May
1688 				 * be NULL (but then fs is less efficient). */
1689     Tcl_FSFreeInternalRepProc *freeInternalRepProc;
1690 				/* Function to free internal fs rep. Must be
1691 				 * implemented if internal representations
1692 				 * need freeing, otherwise it can be NULL. */
1693     Tcl_FSInternalToNormalizedProc *internalToNormalizedProc;
1694 				/* Function to convert internal representation
1695 				 * to a normalized path. Only required if the
1696 				 * fs creates pure path objects with no
1697 				 * string/path representation. */
1698     Tcl_FSCreateInternalRepProc *createInternalRepProc;
1699 				/* Function to create a filesystem-specific
1700 				 * internal representation. May be NULL if
1701 				 * paths have no internal representation, or
1702 				 * if the Tcl_FSPathInFilesystemProc for this
1703 				 * filesystem always immediately creates an
1704 				 * internal representation for paths it
1705 				 * accepts. */
1706     Tcl_FSNormalizePathProc *normalizePathProc;
1707 				/* Function to normalize a path.  Should be
1708 				 * implemented for all filesystems which can
1709 				 * have multiple string representations for
1710 				 * the same path object. */
1711     Tcl_FSFilesystemPathTypeProc *filesystemPathTypeProc;
1712 				/* Function to determine the type of a path in
1713 				 * this filesystem. May be NULL. */
1714     Tcl_FSFilesystemSeparatorProc *filesystemSeparatorProc;
1715 				/* Function to return the separator
1716 				 * character(s) for this filesystem. Must be
1717 				 * implemented. */
1718     Tcl_FSStatProc *statProc;	/* Function to process a 'Tcl_FSStat()' call.
1719 				 * Must be implemented for any reasonable
1720 				 * filesystem. */
1721     Tcl_FSAccessProc *accessProc;
1722 				/* Function to process a 'Tcl_FSAccess()'
1723 				 * call. Must be implemented for any
1724 				 * reasonable filesystem. */
1725     Tcl_FSOpenFileChannelProc *openFileChannelProc;
1726 				/* Function to process a
1727 				 * 'Tcl_FSOpenFileChannel()' call. Must be
1728 				 * implemented for any reasonable
1729 				 * filesystem. */
1730     Tcl_FSMatchInDirectoryProc *matchInDirectoryProc;
1731 				/* Function to process a
1732 				 * 'Tcl_FSMatchInDirectory()'.  If not
1733 				 * implemented, then glob and recursive copy
1734 				 * functionality will be lacking in the
1735 				 * filesystem. */
1736     Tcl_FSUtimeProc *utimeProc;	/* Function to process a 'Tcl_FSUtime()' call.
1737 				 * Required to allow setting (not reading) of
1738 				 * times with 'file mtime', 'file atime' and
1739 				 * the open-r/open-w/fcopy implementation of
1740 				 * 'file copy'. */
1741     Tcl_FSLinkProc *linkProc;	/* Function to process a 'Tcl_FSLink()' call.
1742 				 * Should be implemented only if the
1743 				 * filesystem supports links (reading or
1744 				 * creating). */
1745     Tcl_FSListVolumesProc *listVolumesProc;
1746 				/* Function to list any filesystem volumes
1747 				 * added by this filesystem. Should be
1748 				 * implemented only if the filesystem adds
1749 				 * volumes at the head of the filesystem. */
1750     Tcl_FSFileAttrStringsProc *fileAttrStringsProc;
1751 				/* Function to list all attributes strings
1752 				 * which are valid for this filesystem. If not
1753 				 * implemented the filesystem will not support
1754 				 * the 'file attributes' command. This allows
1755 				 * arbitrary additional information to be
1756 				 * attached to files in the filesystem. */
1757     Tcl_FSFileAttrsGetProc *fileAttrsGetProc;
1758 				/* Function to process a
1759 				 * 'Tcl_FSFileAttrsGet()' call, used by 'file
1760 				 * attributes'. */
1761     Tcl_FSFileAttrsSetProc *fileAttrsSetProc;
1762 				/* Function to process a
1763 				 * 'Tcl_FSFileAttrsSet()' call, used by 'file
1764 				 * attributes'.  */
1765     Tcl_FSCreateDirectoryProc *createDirectoryProc;
1766 				/* Function to process a
1767 				 * 'Tcl_FSCreateDirectory()' call. Should be
1768 				 * implemented unless the FS is read-only. */
1769     Tcl_FSRemoveDirectoryProc *removeDirectoryProc;
1770 				/* Function to process a
1771 				 * 'Tcl_FSRemoveDirectory()' call. Should be
1772 				 * implemented unless the FS is read-only. */
1773     Tcl_FSDeleteFileProc *deleteFileProc;
1774 				/* Function to process a 'Tcl_FSDeleteFile()'
1775 				 * call. Should be implemented unless the FS
1776 				 * is read-only. */
1777     Tcl_FSCopyFileProc *copyFileProc;
1778 				/* Function to process a 'Tcl_FSCopyFile()'
1779 				 * call. If not implemented Tcl will fall back
1780 				 * on open-r, open-w and fcopy as a copying
1781 				 * mechanism, for copying actions initiated in
1782 				 * Tcl (not C). */
1783     Tcl_FSRenameFileProc *renameFileProc;
1784 				/* Function to process a 'Tcl_FSRenameFile()'
1785 				 * call. If not implemented, Tcl will fall
1786 				 * back on a copy and delete mechanism, for
1787 				 * rename actions initiated in Tcl (not C). */
1788     Tcl_FSCopyDirectoryProc *copyDirectoryProc;
1789 				/* Function to process a
1790 				 * 'Tcl_FSCopyDirectory()' call. If not
1791 				 * implemented, Tcl will fall back on a
1792 				 * recursive create-dir, file copy mechanism,
1793 				 * for copying actions initiated in Tcl (not
1794 				 * C). */
1795     Tcl_FSLstatProc *lstatProc;	/* Function to process a 'Tcl_FSLstat()' call.
1796 				 * If not implemented, Tcl will attempt to use
1797 				 * the 'statProc' defined above instead. */
1798     Tcl_FSLoadFileProc *loadFileProc;
1799 				/* Function to process a 'Tcl_FSLoadFile()'
1800 				 * call. If not implemented, Tcl will fall
1801 				 * back on a copy to native-temp followed by a
1802 				 * Tcl_FSLoadFile on that temporary copy. */
1803     Tcl_FSGetCwdProc *getCwdProc;
1804 				/* Function to process a 'Tcl_FSGetCwd()'
1805 				 * call. Most filesystems need not implement
1806 				 * this. It will usually only be called once,
1807 				 * if 'getcwd' is called before 'chdir'. May
1808 				 * be NULL. */
1809     Tcl_FSChdirProc *chdirProc;	/* Function to process a 'Tcl_FSChdir()' call.
1810 				 * If filesystems do not implement this, it
1811 				 * will be emulated by a series of directory
1812 				 * access checks. Otherwise, virtual
1813 				 * filesystems which do implement it need only
1814 				 * respond with a positive return result if
1815 				 * the dirName is a valid directory in their
1816 				 * filesystem. They need not remember the
1817 				 * result, since that will be automatically
1818 				 * remembered for use by GetCwd. Real
1819 				 * filesystems should carry out the correct
1820 				 * action (i.e. call the correct system
1821 				 * 'chdir' api). If not implemented, then 'cd'
1822 				 * and 'pwd' will fail inside the
1823 				 * filesystem. */
1824 } Tcl_Filesystem;
1825 
1826 /*
1827  * The following definitions are used as values for the 'linkAction' flag to
1828  * Tcl_FSLink, or the linkProc of any filesystem. Any combination of flags can
1829  * be given. For link creation, the linkProc should create a link which
1830  * matches any of the types given.
1831  *
1832  * TCL_CREATE_SYMBOLIC_LINK -	Create a symbolic or soft link.
1833  * TCL_CREATE_HARD_LINK -	Create a hard link.
1834  */
1835 
1836 #define TCL_CREATE_SYMBOLIC_LINK	0x01
1837 #define TCL_CREATE_HARD_LINK		0x02
1838 
1839 /*
1840  * The following structure represents the Notifier functions that you can
1841  * override with the Tcl_SetNotifier call.
1842  */
1843 
1844 typedef struct Tcl_NotifierProcs {
1845     Tcl_SetTimerProc *setTimerProc;
1846     Tcl_WaitForEventProc *waitForEventProc;
1847     Tcl_CreateFileHandlerProc *createFileHandlerProc;
1848     Tcl_DeleteFileHandlerProc *deleteFileHandlerProc;
1849     Tcl_InitNotifierProc *initNotifierProc;
1850     Tcl_FinalizeNotifierProc *finalizeNotifierProc;
1851     Tcl_AlertNotifierProc *alertNotifierProc;
1852     Tcl_ServiceModeHookProc *serviceModeHookProc;
1853 } Tcl_NotifierProcs;
1854 
1855 /*
1856  * The following structure represents a user-defined encoding. It collects
1857  * together all the functions that are used by the specific encoding.
1858  */
1859 
1860 typedef struct Tcl_EncodingType {
1861     CONST char *encodingName;	/* The name of the encoding, e.g. "euc-jp".
1862 				 * This name is the unique key for this
1863 				 * encoding type. */
1864     Tcl_EncodingConvertProc *toUtfProc;
1865 				/* Function to convert from external encoding
1866 				 * into UTF-8. */
1867     Tcl_EncodingConvertProc *fromUtfProc;
1868 				/* Function to convert from UTF-8 into
1869 				 * external encoding. */
1870     Tcl_EncodingFreeProc *freeProc;
1871 				/* If non-NULL, function to call when this
1872 				 * encoding is deleted. */
1873     ClientData clientData;	/* Arbitrary value associated with encoding
1874 				 * type. Passed to conversion functions. */
1875     int nullSize;		/* Number of zero bytes that signify
1876 				 * end-of-string in this encoding. This number
1877 				 * is used to determine the source string
1878 				 * length when the srcLen argument is
1879 				 * negative. Must be 1 or 2. */
1880 } Tcl_EncodingType;
1881 
1882 /*
1883  * The following definitions are used as values for the conversion control
1884  * flags argument when converting text from one character set to another:
1885  *
1886  * TCL_ENCODING_START -		Signifies that the source buffer is the first
1887  *				block in a (potentially multi-block) input
1888  *				stream. Tells the conversion function to reset
1889  *				to an initial state and perform any
1890  *				initialization that needs to occur before the
1891  *				first byte is converted. If the source buffer
1892  *				contains the entire input stream to be
1893  *				converted, this flag should be set.
1894  * TCL_ENCODING_END -		Signifies that the source buffer is the last
1895  *				block in a (potentially multi-block) input
1896  *				stream. Tells the conversion routine to
1897  *				perform any finalization that needs to occur
1898  *				after the last byte is converted and then to
1899  *				reset to an initial state. If the source
1900  *				buffer contains the entire input stream to be
1901  *				converted, this flag should be set.
1902  * TCL_ENCODING_STOPONERROR -	If set, then the converter will return
1903  *				immediately upon encountering an invalid byte
1904  *				sequence or a source character that has no
1905  *				mapping in the target encoding. If clear, then
1906  *				the converter will skip the problem,
1907  *				substituting one or more "close" characters in
1908  *				the destination buffer and then continue to
1909  *				convert the source.
1910  */
1911 
1912 #define TCL_ENCODING_START		0x01
1913 #define TCL_ENCODING_END		0x02
1914 #define TCL_ENCODING_STOPONERROR	0x04
1915 
1916 /*
1917  * The following data structures and declarations are for the new Tcl parser.
1918  */
1919 
1920 /*
1921  * For each word of a command, and for each piece of a word such as a variable
1922  * reference, one of the following structures is created to describe the
1923  * token.
1924  */
1925 
1926 typedef struct Tcl_Token {
1927     int type;			/* Type of token, such as TCL_TOKEN_WORD; see
1928 				 * below for valid types. */
1929     CONST char *start;		/* First character in token. */
1930     int size;			/* Number of bytes in token. */
1931     int numComponents;		/* If this token is composed of other tokens,
1932 				 * this field tells how many of them there are
1933 				 * (including components of components, etc.).
1934 				 * The component tokens immediately follow
1935 				 * this one. */
1936 } Tcl_Token;
1937 
1938 /*
1939  * Type values defined for Tcl_Token structures. These values are defined as
1940  * mask bits so that it's easy to check for collections of types.
1941  *
1942  * TCL_TOKEN_WORD -		The token describes one word of a command,
1943  *				from the first non-blank character of the word
1944  *				(which may be " or {) up to but not including
1945  *				the space, semicolon, or bracket that
1946  *				terminates the word. NumComponents counts the
1947  *				total number of sub-tokens that make up the
1948  *				word. This includes, for example, sub-tokens
1949  *				of TCL_TOKEN_VARIABLE tokens.
1950  * TCL_TOKEN_SIMPLE_WORD -	This token is just like TCL_TOKEN_WORD except
1951  *				that the word is guaranteed to consist of a
1952  *				single TCL_TOKEN_TEXT sub-token.
1953  * TCL_TOKEN_TEXT -		The token describes a range of literal text
1954  *				that is part of a word. NumComponents is
1955  *				always 0.
1956  * TCL_TOKEN_BS -		The token describes a backslash sequence that
1957  *				must be collapsed. NumComponents is always 0.
1958  * TCL_TOKEN_COMMAND -		The token describes a command whose result
1959  *				must be substituted into the word. The token
1960  *				includes the enclosing brackets. NumComponents
1961  *				is always 0.
1962  * TCL_TOKEN_VARIABLE -		The token describes a variable substitution,
1963  *				including the dollar sign, variable name, and
1964  *				array index (if there is one) up through the
1965  *				right parentheses. NumComponents tells how
1966  *				many additional tokens follow to represent the
1967  *				variable name. The first token will be a
1968  *				TCL_TOKEN_TEXT token that describes the
1969  *				variable name. If the variable is an array
1970  *				reference then there will be one or more
1971  *				additional tokens, of type TCL_TOKEN_TEXT,
1972  *				TCL_TOKEN_BS, TCL_TOKEN_COMMAND, and
1973  *				TCL_TOKEN_VARIABLE, that describe the array
1974  *				index; numComponents counts the total number
1975  *				of nested tokens that make up the variable
1976  *				reference, including sub-tokens of
1977  *				TCL_TOKEN_VARIABLE tokens.
1978  * TCL_TOKEN_SUB_EXPR -		The token describes one subexpression of an
1979  *				expression, from the first non-blank character
1980  *				of the subexpression up to but not including
1981  *				the space, brace, or bracket that terminates
1982  *				the subexpression. NumComponents counts the
1983  *				total number of following subtokens that make
1984  *				up the subexpression; this includes all
1985  *				subtokens for any nested TCL_TOKEN_SUB_EXPR
1986  *				tokens. For example, a numeric value used as a
1987  *				primitive operand is described by a
1988  *				TCL_TOKEN_SUB_EXPR token followed by a
1989  *				TCL_TOKEN_TEXT token. A binary subexpression
1990  *				is described by a TCL_TOKEN_SUB_EXPR token
1991  *				followed by the TCL_TOKEN_OPERATOR token for
1992  *				the operator, then TCL_TOKEN_SUB_EXPR tokens
1993  *				for the left then the right operands.
1994  * TCL_TOKEN_OPERATOR -		The token describes one expression operator.
1995  *				An operator might be the name of a math
1996  *				function such as "abs". A TCL_TOKEN_OPERATOR
1997  *				token is always preceeded by one
1998  *				TCL_TOKEN_SUB_EXPR token for the operator's
1999  *				subexpression, and is followed by zero or more
2000  *				TCL_TOKEN_SUB_EXPR tokens for the operator's
2001  *				operands. NumComponents is always 0.
2002  * TCL_TOKEN_EXPAND_WORD -	This token is just like TCL_TOKEN_WORD except
2003  *				that it marks a word that began with the
2004  *				literal character prefix "{*}". This word is
2005  *				marked to be expanded - that is, broken into
2006  *				words after substitution is complete.
2007  */
2008 
2009 #define TCL_TOKEN_WORD		1
2010 #define TCL_TOKEN_SIMPLE_WORD	2
2011 #define TCL_TOKEN_TEXT		4
2012 #define TCL_TOKEN_BS		8
2013 #define TCL_TOKEN_COMMAND	16
2014 #define TCL_TOKEN_VARIABLE	32
2015 #define TCL_TOKEN_SUB_EXPR	64
2016 #define TCL_TOKEN_OPERATOR	128
2017 #define TCL_TOKEN_EXPAND_WORD	256
2018 
2019 /*
2020  * Parsing error types. On any parsing error, one of these values will be
2021  * stored in the error field of the Tcl_Parse structure defined below.
2022  */
2023 
2024 #define TCL_PARSE_SUCCESS		0
2025 #define TCL_PARSE_QUOTE_EXTRA		1
2026 #define TCL_PARSE_BRACE_EXTRA		2
2027 #define TCL_PARSE_MISSING_BRACE		3
2028 #define TCL_PARSE_MISSING_BRACKET	4
2029 #define TCL_PARSE_MISSING_PAREN		5
2030 #define TCL_PARSE_MISSING_QUOTE		6
2031 #define TCL_PARSE_MISSING_VAR_BRACE	7
2032 #define TCL_PARSE_SYNTAX		8
2033 #define TCL_PARSE_BAD_NUMBER		9
2034 
2035 /*
2036  * A structure of the following type is filled in by Tcl_ParseCommand. It
2037  * describes a single command parsed from an input string.
2038  */
2039 
2040 #define NUM_STATIC_TOKENS 20
2041 
2042 typedef struct Tcl_Parse {
2043     CONST char *commentStart;	/* Pointer to # that begins the first of one
2044 				 * or more comments preceding the command. */
2045     int commentSize;		/* Number of bytes in comments (up through
2046 				 * newline character that terminates the last
2047 				 * comment). If there were no comments, this
2048 				 * field is 0. */
2049     CONST char *commandStart;	/* First character in first word of
2050 				 * command. */
2051     int commandSize;		/* Number of bytes in command, including first
2052 				 * character of first word, up through the
2053 				 * terminating newline, close bracket, or
2054 				 * semicolon. */
2055     int numWords;		/* Total number of words in command. May be
2056 				 * 0. */
2057     Tcl_Token *tokenPtr;	/* Pointer to first token representing the
2058 				 * words of the command. Initially points to
2059 				 * staticTokens, but may change to point to
2060 				 * malloc-ed space if command exceeds space in
2061 				 * staticTokens. */
2062     int numTokens;		/* Total number of tokens in command. */
2063     int tokensAvailable;	/* Total number of tokens available at
2064 				 * *tokenPtr. */
2065     int errorType;		/* One of the parsing error types defined
2066 				 * above. */
2067 
2068     /*
2069      * The fields below are intended only for the private use of the parser.
2070      * They should not be used by functions that invoke Tcl_ParseCommand.
2071      */
2072 
2073     CONST char *string;		/* The original command string passed to
2074 				 * Tcl_ParseCommand. */
2075     CONST char *end;		/* Points to the character just after the last
2076 				 * one in the command string. */
2077     Tcl_Interp *interp;		/* Interpreter to use for error reporting, or
2078 				 * NULL. */
2079     CONST char *term;		/* Points to character in string that
2080 				 * terminated most recent token. Filled in by
2081 				 * ParseTokens. If an error occurs, points to
2082 				 * beginning of region where the error
2083 				 * occurred (e.g. the open brace if the close
2084 				 * brace is missing). */
2085     int incomplete;		/* This field is set to 1 by Tcl_ParseCommand
2086 				 * if the command appears to be incomplete.
2087 				 * This information is used by
2088 				 * Tcl_CommandComplete. */
2089     Tcl_Token staticTokens[NUM_STATIC_TOKENS];
2090 				/* Initial space for tokens for command. This
2091 				 * space should be large enough to accommodate
2092 				 * most commands; dynamic space is allocated
2093 				 * for very large commands that don't fit
2094 				 * here. */
2095 } Tcl_Parse;
2096 
2097 /*
2098  * The following definitions are the error codes returned by the conversion
2099  * routines:
2100  *
2101  * TCL_OK -			All characters were converted.
2102  * TCL_CONVERT_NOSPACE -	The output buffer would not have been large
2103  *				enough for all of the converted data; as many
2104  *				characters as could fit were converted though.
2105  * TCL_CONVERT_MULTIBYTE -	The last few bytes in the source string were
2106  *				the beginning of a multibyte sequence, but
2107  *				more bytes were needed to complete this
2108  *				sequence. A subsequent call to the conversion
2109  *				routine should pass the beginning of this
2110  *				unconverted sequence plus additional bytes
2111  *				from the source stream to properly convert the
2112  *				formerly split-up multibyte sequence.
2113  * TCL_CONVERT_SYNTAX -		The source stream contained an invalid
2114  *				character sequence. This may occur if the
2115  *				input stream has been damaged or if the input
2116  *				encoding method was misidentified. This error
2117  *				is reported only if TCL_ENCODING_STOPONERROR
2118  *				was specified.
2119  * TCL_CONVERT_UNKNOWN -	The source string contained a character that
2120  *				could not be represented in the target
2121  *				encoding. This error is reported only if
2122  *				TCL_ENCODING_STOPONERROR was specified.
2123  */
2124 
2125 #define TCL_CONVERT_MULTIBYTE	-1
2126 #define TCL_CONVERT_SYNTAX	-2
2127 #define TCL_CONVERT_UNKNOWN	-3
2128 #define TCL_CONVERT_NOSPACE	-4
2129 
2130 /*
2131  * The maximum number of bytes that are necessary to represent a single
2132  * Unicode character in UTF-8. The valid values should be 3 or 6 (or perhaps 1
2133  * if we want to support a non-unicode enabled core). If 3, then Tcl_UniChar
2134  * must be 2-bytes in size (UCS-2) (the default). If 6, then Tcl_UniChar must
2135  * be 4-bytes in size (UCS-4). At this time UCS-2 mode is the default and
2136  * recommended mode. UCS-4 is experimental and not recommended. It works for
2137  * the core, but most extensions expect UCS-2.
2138  */
2139 
2140 #ifndef TCL_UTF_MAX
2141 #define TCL_UTF_MAX		3
2142 #endif
2143 
2144 /*
2145  * This represents a Unicode character. Any changes to this should also be
2146  * reflected in regcustom.h.
2147  */
2148 
2149 #if TCL_UTF_MAX > 4
2150     /*
2151      * unsigned int isn't 100% accurate as it should be a strict 4-byte value
2152      * (perhaps wchar_t). 64-bit systems may have troubles. The size of this
2153      * value must be reflected correctly in regcustom.h and
2154      * in tclEncoding.c.
2155      * XXX: Tcl is currently UCS-2 and planning UTF-16 for the Unicode
2156      * XXX: string rep that Tcl_UniChar represents.  Changing the size
2157      * XXX: of Tcl_UniChar is /not/ supported.
2158      */
2159 typedef unsigned int Tcl_UniChar;
2160 #else
2161 typedef unsigned short Tcl_UniChar;
2162 #endif
2163 
2164 /*
2165  * TIP #59: The following structure is used in calls 'Tcl_RegisterConfig' to
2166  * provide the system with the embedded configuration data.
2167  */
2168 
2169 typedef struct Tcl_Config {
2170     CONST char *key;		/* Configuration key to register. ASCII
2171 				 * encoded, thus UTF-8. */
2172     CONST char *value;		/* The value associated with the key. System
2173 				 * encoding. */
2174 } Tcl_Config;
2175 
2176 /*
2177  * Flags for TIP#143 limits, detailing which limits are active in an
2178  * interpreter. Used for Tcl_{Add,Remove}LimitHandler type argument.
2179  */
2180 
2181 #define TCL_LIMIT_COMMANDS	0x01
2182 #define TCL_LIMIT_TIME		0x02
2183 
2184 /*
2185  * Structure containing information about a limit handler to be called when a
2186  * command- or time-limit is exceeded by an interpreter.
2187  */
2188 
2189 typedef void (Tcl_LimitHandlerProc) _ANSI_ARGS_((ClientData clientData,
2190 	Tcl_Interp *interp));
2191 typedef void (Tcl_LimitHandlerDeleteProc) _ANSI_ARGS_((ClientData clientData));
2192 
2193 typedef struct mp_int mp_int;
2194 #define MP_INT_DECLARED
2195 typedef unsigned int mp_digit;
2196 #define MP_DIGIT_DECLARED
2197 
2198 /*
2199  * The following constant is used to test for older versions of Tcl in the
2200  * stubs tables.
2201  *
2202  * Jan Nijtman's plus patch uses 0xFCA1BACF, so we need to pick a different
2203  * value since the stubs tables don't match.
2204  */
2205 
2206 #define TCL_STUB_MAGIC		((int) 0xFCA3BACF)
2207 
2208 /*
2209  * The following function is required to be defined in all stubs aware
2210  * extensions. The function is actually implemented in the stub library, not
2211  * the main Tcl library, although there is a trivial implementation in the
2212  * main library in case an extension is statically linked into an application.
2213  */
2214 
2215 EXTERN CONST char *	Tcl_InitStubs _ANSI_ARGS_((Tcl_Interp *interp,
2216 			    CONST char *version, int exact));
2217 EXTERN CONST char *	TclTomMathInitializeStubs _ANSI_ARGS_((
2218 			    Tcl_Interp *interp, CONST char *version,
2219 			    int epoch, int revision));
2220 
2221 #ifndef USE_TCL_STUBS
2222 
2223 /*
2224  * When not using stubs, make it a macro.
2225  */
2226 
2227 #define Tcl_InitStubs(interp, version, exact) \
2228     Tcl_PkgInitStubsCheck(interp, version, exact)
2229 
2230 #endif
2231 
2232     /*
2233      * TODO - tommath stubs export goes here!
2234      */
2235 
2236 
2237 /*
2238  * Public functions that are not accessible via the stubs table.
2239  * Tcl_GetMemoryInfo is needed for AOLserver. [Bug 1868171]
2240  */
2241 
2242 EXTERN void		Tcl_Main _ANSI_ARGS_((int argc, char **argv,
2243 			    Tcl_AppInitProc *appInitProc));
2244 EXTERN CONST char *	Tcl_PkgInitStubsCheck _ANSI_ARGS_((Tcl_Interp *interp,
2245 			    CONST char *version, int exact));
2246 #if defined(TCL_THREADS) && defined(USE_THREAD_ALLOC)
2247 EXTERN void		Tcl_GetMemoryInfo _ANSI_ARGS_((Tcl_DString *dsPtr));
2248 #endif
2249 
2250 /*
2251  * Include the public function declarations that are accessible via the stubs
2252  * table.
2253  */
2254 
2255 #include "tclDecls.h"
2256 
2257 /*
2258  * Include platform specific public function declarations that are accessible
2259  * via the stubs table.
2260  */
2261 
2262 #include "tclPlatDecls.h"
2263 
2264 /*
2265  * The following declarations either map ckalloc and ckfree to malloc and
2266  * free, or they map them to functions with all sorts of debugging hooks
2267  * defined in tclCkalloc.c.
2268  */
2269 
2270 #ifdef TCL_MEM_DEBUG
2271 
2272 #   define ckalloc(x) Tcl_DbCkalloc(x, __FILE__, __LINE__)
2273 #   define ckfree(x)  Tcl_DbCkfree(x, __FILE__, __LINE__)
2274 #   define ckrealloc(x,y) Tcl_DbCkrealloc((x), (y),__FILE__, __LINE__)
2275 #   define attemptckalloc(x) Tcl_AttemptDbCkalloc(x, __FILE__, __LINE__)
2276 #   define attemptckrealloc(x,y) Tcl_AttemptDbCkrealloc((x), (y), __FILE__, __LINE__)
2277 
2278 #else /* !TCL_MEM_DEBUG */
2279 
2280 /*
2281  * If we are not using the debugging allocator, we should call the Tcl_Alloc,
2282  * et al. routines in order to guarantee that every module is using the same
2283  * memory allocator both inside and outside of the Tcl library.
2284  */
2285 
2286 #   define ckalloc(x) Tcl_Alloc(x)
2287 #   define ckfree(x) Tcl_Free(x)
2288 #   define ckrealloc(x,y) Tcl_Realloc(x,y)
2289 #   define attemptckalloc(x) Tcl_AttemptAlloc(x)
2290 #   define attemptckrealloc(x,y) Tcl_AttemptRealloc(x,y)
2291 #   undef  Tcl_InitMemory
2292 #   define Tcl_InitMemory(x)
2293 #   undef  Tcl_DumpActiveMemory
2294 #   define Tcl_DumpActiveMemory(x)
2295 #   undef  Tcl_ValidateAllMemory
2296 #   define Tcl_ValidateAllMemory(x,y)
2297 
2298 #endif /* !TCL_MEM_DEBUG */
2299 
2300 #ifdef TCL_MEM_DEBUG
2301 #   define Tcl_IncrRefCount(objPtr) \
2302 	Tcl_DbIncrRefCount(objPtr, __FILE__, __LINE__)
2303 #   define Tcl_DecrRefCount(objPtr) \
2304 	Tcl_DbDecrRefCount(objPtr, __FILE__, __LINE__)
2305 #   define Tcl_IsShared(objPtr) \
2306 	Tcl_DbIsShared(objPtr, __FILE__, __LINE__)
2307 #else
2308 #   define Tcl_IncrRefCount(objPtr) \
2309 	++(objPtr)->refCount
2310     /*
2311      * Use do/while0 idiom for optimum correctness without compiler warnings.
2312      * http://c2.com/cgi/wiki?TrivialDoWhileLoop
2313      */
2314 #   define Tcl_DecrRefCount(objPtr) \
2315 	do { \
2316 	    Tcl_Obj *_objPtr = (objPtr); \
2317 	    if (--(_objPtr)->refCount <= 0) { \
2318 		TclFreeObj(_objPtr); \
2319 	    } \
2320 	} while(0)
2321 #   define Tcl_IsShared(objPtr) \
2322 	((objPtr)->refCount > 1)
2323 #endif
2324 
2325 /*
2326  * Macros and definitions that help to debug the use of Tcl objects. When
2327  * TCL_MEM_DEBUG is defined, the Tcl_New declarations are overridden to call
2328  * debugging versions of the object creation functions.
2329  */
2330 
2331 #ifdef TCL_MEM_DEBUG
2332 #  undef  Tcl_NewBignumObj
2333 #  define Tcl_NewBignumObj(val) \
2334      Tcl_DbNewBignumObj(val, __FILE__, __LINE__)
2335 #  undef  Tcl_NewBooleanObj
2336 #  define Tcl_NewBooleanObj(val) \
2337      Tcl_DbNewBooleanObj(val, __FILE__, __LINE__)
2338 #  undef  Tcl_NewByteArrayObj
2339 #  define Tcl_NewByteArrayObj(bytes, len) \
2340      Tcl_DbNewByteArrayObj(bytes, len, __FILE__, __LINE__)
2341 #  undef  Tcl_NewDoubleObj
2342 #  define Tcl_NewDoubleObj(val) \
2343      Tcl_DbNewDoubleObj(val, __FILE__, __LINE__)
2344 #  undef  Tcl_NewIntObj
2345 #  define Tcl_NewIntObj(val) \
2346      Tcl_DbNewLongObj(val, __FILE__, __LINE__)
2347 #  undef  Tcl_NewListObj
2348 #  define Tcl_NewListObj(objc, objv) \
2349      Tcl_DbNewListObj(objc, objv, __FILE__, __LINE__)
2350 #  undef  Tcl_NewLongObj
2351 #  define Tcl_NewLongObj(val) \
2352      Tcl_DbNewLongObj(val, __FILE__, __LINE__)
2353 #  undef  Tcl_NewObj
2354 #  define Tcl_NewObj() \
2355      Tcl_DbNewObj(__FILE__, __LINE__)
2356 #  undef  Tcl_NewStringObj
2357 #  define Tcl_NewStringObj(bytes, len) \
2358      Tcl_DbNewStringObj(bytes, len, __FILE__, __LINE__)
2359 #  undef  Tcl_NewWideIntObj
2360 #  define Tcl_NewWideIntObj(val) \
2361      Tcl_DbNewWideIntObj(val, __FILE__, __LINE__)
2362 #endif /* TCL_MEM_DEBUG */
2363 
2364 /*
2365  * Macros for clients to use to access fields of hash entries:
2366  */
2367 
2368 #define Tcl_GetHashValue(h) ((h)->clientData)
2369 #define Tcl_SetHashValue(h, value) ((h)->clientData = (ClientData) (value))
2370 #define Tcl_GetHashKey(tablePtr, h) \
2371 	((char *) (((tablePtr)->keyType == TCL_ONE_WORD_KEYS || \
2372 		    (tablePtr)->keyType == TCL_CUSTOM_PTR_KEYS) \
2373 		   ? (h)->key.oneWordValue \
2374 		   : (h)->key.string))
2375 
2376 /*
2377  * Macros to use for clients to use to invoke find and create functions for
2378  * hash tables:
2379  */
2380 
2381 #undef  Tcl_FindHashEntry
2382 #define Tcl_FindHashEntry(tablePtr, key) \
2383 	(*((tablePtr)->findProc))(tablePtr, key)
2384 #undef  Tcl_CreateHashEntry
2385 #define Tcl_CreateHashEntry(tablePtr, key, newPtr) \
2386 	(*((tablePtr)->createProc))(tablePtr, key, newPtr)
2387 
2388 /*
2389  * Macros that eliminate the overhead of the thread synchronization functions
2390  * when compiling without thread support.
2391  */
2392 
2393 #ifndef TCL_THREADS
2394 #undef  Tcl_MutexLock
2395 #define Tcl_MutexLock(mutexPtr)
2396 #undef  Tcl_MutexUnlock
2397 #define Tcl_MutexUnlock(mutexPtr)
2398 #undef  Tcl_MutexFinalize
2399 #define Tcl_MutexFinalize(mutexPtr)
2400 #undef  Tcl_ConditionNotify
2401 #define Tcl_ConditionNotify(condPtr)
2402 #undef  Tcl_ConditionWait
2403 #define Tcl_ConditionWait(condPtr, mutexPtr, timePtr)
2404 #undef  Tcl_ConditionFinalize
2405 #define Tcl_ConditionFinalize(condPtr)
2406 #endif /* TCL_THREADS */
2407 
2408 #ifndef TCL_NO_DEPRECATED
2409     /*
2410      * These function have been renamed. The old names are deprecated, but we
2411      * define these macros for backwards compatibilty.
2412      */
2413 
2414 #   define Tcl_Ckalloc		Tcl_Alloc
2415 #   define Tcl_Ckfree		Tcl_Free
2416 #   define Tcl_Ckrealloc	Tcl_Realloc
2417 #   define Tcl_Return		Tcl_SetResult
2418 #   define Tcl_TildeSubst	Tcl_TranslateFileName
2419 #   define panic		Tcl_Panic
2420 #   define panicVA		Tcl_PanicVA
2421 #endif
2422 
2423 /*
2424  * Convenience declaration of Tcl_AppInit for backwards compatibility. This
2425  * function is not *implemented* by the tcl library, so the storage class is
2426  * neither DLLEXPORT nor DLLIMPORT.
2427  */
2428 
2429 #undef TCL_STORAGE_CLASS
2430 #define TCL_STORAGE_CLASS
2431 
2432 EXTERN int		Tcl_AppInit _ANSI_ARGS_((Tcl_Interp *interp));
2433 
2434 #undef TCL_STORAGE_CLASS
2435 #define TCL_STORAGE_CLASS DLLIMPORT
2436 
2437 #endif /* RC_INVOKED */
2438 
2439 /*
2440  * end block for C++
2441  */
2442 
2443 #ifdef __cplusplus
2444 }
2445 #endif
2446 
2447 #endif /* _TCL */
2448 
2449 /*
2450  * Local Variables:
2451  * mode: c
2452  * c-basic-offset: 4
2453  * fill-column: 78
2454  * End:
2455  */
2456