tcl.h
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:83k
源码类别:

通讯编程

开发平台:

Visual C++

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