diff options
Diffstat (limited to 'generic/tcl.h')
| -rw-r--r-- | generic/tcl.h | 91 |
1 files changed, 46 insertions, 45 deletions
diff --git a/generic/tcl.h b/generic/tcl.h index c3426f1..dc8d3f7 100644 --- a/generic/tcl.h +++ b/generic/tcl.h @@ -13,7 +13,7 @@ * See the file "license.terms" for information on usage and redistribution of * this file, and for a DISCLAIMER OF ALL WARRANTIES. * - * RCS: @(#) $Id: tcl.h,v 1.285 2008/12/19 03:54:44 dgp Exp $ + * RCS: @(#) $Id: tcl.h,v 1.286 2009/01/06 09:49:38 dkf Exp $ */ #ifndef _TCL @@ -274,7 +274,7 @@ extern "C" { #endif /* - * Make sure EXTERN isn't defined elsewhere + * Make sure EXTERN isn't defined elsewhere. */ #ifdef EXTERN @@ -538,9 +538,10 @@ typedef void (Tcl_ThreadCreateProc) (ClientData clientData); * given to Tcl_CreateThread. */ -#define TCL_THREAD_STACK_DEFAULT (0) /* Use default size for stack */ -#define TCL_THREAD_NOFLAGS (0000) /* Standard flags, default behaviour */ -#define TCL_THREAD_JOINABLE (0001) /* Mark the thread as joinable */ +#define TCL_THREAD_STACK_DEFAULT (0) /* Use default size for stack. */ +#define TCL_THREAD_NOFLAGS (0000) /* Standard flags, default + * behaviour. */ +#define TCL_THREAD_JOINABLE (0001) /* Mark the thread as joinable. */ /* * Flag values passed to Tcl_StringCaseMatch. @@ -552,20 +553,20 @@ typedef void (Tcl_ThreadCreateProc) (ClientData clientData); * Flag values passed to Tcl_GetRegExpFromObj. */ -#define TCL_REG_BASIC 000000 /* BREs (convenience) */ -#define TCL_REG_EXTENDED 000001 /* EREs */ -#define TCL_REG_ADVF 000002 /* advanced features in EREs */ -#define TCL_REG_ADVANCED 000003 /* AREs (which are also EREs) */ -#define TCL_REG_QUOTE 000004 /* no special characters, none */ -#define TCL_REG_NOCASE 000010 /* ignore case */ -#define TCL_REG_NOSUB 000020 /* don't care about subexpressions */ -#define TCL_REG_EXPANDED 000040 /* expanded format, white space & - * comments */ +#define TCL_REG_BASIC 000000 /* BREs (convenience). */ +#define TCL_REG_EXTENDED 000001 /* EREs. */ +#define TCL_REG_ADVF 000002 /* Advanced features in EREs. */ +#define TCL_REG_ADVANCED 000003 /* AREs (which are also EREs). */ +#define TCL_REG_QUOTE 000004 /* No special characters, none. */ +#define TCL_REG_NOCASE 000010 /* Ignore case. */ +#define TCL_REG_NOSUB 000020 /* Don't care about subexpressions. */ +#define TCL_REG_EXPANDED 000040 /* Expanded format, white space & + * comments. */ #define TCL_REG_NLSTOP 000100 /* \n doesn't match . or [^ ] */ -#define TCL_REG_NLANCH 000200 /* ^ matches after \n, $ before */ -#define TCL_REG_NEWLINE 000300 /* newlines are line terminators */ -#define TCL_REG_CANMATCH 001000 /* report details on partial/limited - * matches */ +#define TCL_REG_NLANCH 000200 /* ^ matches after \n, $ before. */ +#define TCL_REG_NEWLINE 000300 /* Newlines are line terminators. */ +#define TCL_REG_CANMATCH 001000 /* Report details on partial/limited + * matches. */ /* * Flags values passed to Tcl_RegExpExecObj. @@ -777,19 +778,19 @@ typedef struct Tcl_Obj { * internal rep. NULL indicates the object has * no internal rep (has no type). */ union { /* The internal representation: */ - long longValue; /* - an long integer value */ - double doubleValue; /* - a double-precision floating value */ - VOID *otherValuePtr; /* - another, type-specific value */ - Tcl_WideInt wideValue; /* - a long long value */ - struct { /* - internal rep as two pointers */ + long longValue; /* - an long integer value. */ + double doubleValue; /* - a double-precision floating value. */ + VOID *otherValuePtr; /* - another, type-specific value. */ + Tcl_WideInt wideValue; /* - a long long value. */ + struct { /* - internal rep as two pointers. */ VOID *ptr1; VOID *ptr2; } twoPtrValue; struct { /* - internal rep as a wide int, tightly - * packed fields */ - VOID *ptr; /* Pointer to digits */ + * packed fields. */ + VOID *ptr; /* Pointer to digits. */ unsigned long value;/* Alloc, used, and signum packed into a - * single word */ + * single word. */ } ptrAndLongRep; } internalRep; } Tcl_Obj; @@ -1038,10 +1039,10 @@ typedef struct Tcl_DString { #define TCL_LEAVE_ERR_MSG 0x200 #define TCL_TRACE_ARRAY 0x800 #ifndef TCL_REMOVE_OBSOLETE_TRACES -/* Required to support old variable/vdelete/vinfo traces */ +/* Required to support old variable/vdelete/vinfo traces. */ #define TCL_TRACE_OLD_STYLE 0x1000 #endif -/* Indicate the semantics of the result of a trace */ +/* Indicate the semantics of the result of a trace. */ #define TCL_TRACE_RESULT_DYNAMIC 0x8000 #define TCL_TRACE_RESULT_OBJECT 0x10000 @@ -1409,7 +1410,7 @@ typedef void (Tcl_ScaleTimeProc) (Tcl_Time *timebuf, ClientData clientData); #define TCL_CHANNEL_VERSION_5 ((Tcl_ChannelTypeVersion) 0x5) /* - * TIP #218: Channel Actions, Ids for Tcl_DriverThreadActionProc + * TIP #218: Channel Actions, Ids for Tcl_DriverThreadActionProc. */ #define TCL_CHANNEL_THREAD_INSERT (0) @@ -1501,7 +1502,7 @@ typedef struct Tcl_ChannelType { /* Set blocking mode for the raw channel. May * be NULL. */ /* - * Only valid in TCL_CHANNEL_VERSION_2 channels or later + * Only valid in TCL_CHANNEL_VERSION_2 channels or later. */ Tcl_DriverFlushProc *flushProc; /* Function to call to flush a channel. May be @@ -1511,7 +1512,7 @@ typedef struct Tcl_ChannelType { * This will be passed up the stacked channel * chain. */ /* - * Only valid in TCL_CHANNEL_VERSION_3 channels or later + * Only valid in TCL_CHANNEL_VERSION_3 channels or later. */ Tcl_DriverWideSeekProc *wideSeekProc; /* Function to call to seek on the channel @@ -1519,8 +1520,8 @@ typedef struct Tcl_ChannelType { * NULL, and must be NULL if seekProc is * NULL. */ /* - * Only valid in TCL_CHANNEL_VERSION_4 channels or later - * TIP #218, Channel Thread Actions + * Only valid in TCL_CHANNEL_VERSION_4 channels or later. + * TIP #218, Channel Thread Actions. */ Tcl_DriverThreadActionProc *threadActionProc; /* Function to call to notify the driver of @@ -1528,8 +1529,8 @@ typedef struct Tcl_ChannelType { * be NULL. */ /* - * Only valid in TCL_CHANNEL_VERSION_5 channels or later - * TIP #208, File Truncation + * Only valid in TCL_CHANNEL_VERSION_5 channels or later. + * TIP #208, File Truncation. */ Tcl_DriverTruncateProc *truncateProc; /* Function to call to truncate the underlying @@ -1563,14 +1564,14 @@ typedef enum Tcl_PathType { */ typedef struct Tcl_GlobTypeData { - int type; /* Corresponds to bcdpfls as in 'find -t' */ - int perm; /* Corresponds to file permissions */ - Tcl_Obj *macType; /* Acceptable mac type */ - Tcl_Obj *macCreator; /* Acceptable mac creator */ + int type; /* Corresponds to bcdpfls as in 'find -t'. */ + int perm; /* Corresponds to file permissions. */ + Tcl_Obj *macType; /* Acceptable Mac type. */ + Tcl_Obj *macCreator; /* Acceptable Mac creator. */ } Tcl_GlobTypeData; /* - * Type and permission definitions for glob command + * Type and permission definitions for glob command. */ #define TCL_GLOB_TYPE_BLOCK (1<<0) @@ -1589,7 +1590,7 @@ typedef struct Tcl_GlobTypeData { #define TCL_GLOB_PERM_X (1<<4) /* - * Flags for the unload callback function + * Flags for the unload callback function. */ #define TCL_UNLOAD_DETACH_FROM_INTERPRETER (1<<0) @@ -2162,9 +2163,9 @@ typedef unsigned short Tcl_UniChar; typedef struct Tcl_Config { const char *key; /* Configuration key to register. ASCII - * encoded, thus UTF-8 */ + * encoded, thus UTF-8. */ const char *value; /* The value associated with the key. System - * encoding */ + * encoding. */ } Tcl_Config; /* @@ -2346,7 +2347,7 @@ EXTERN void Tcl_GetMemoryInfo (Tcl_DString *dsPtr); /* - * Single public declaration for NRE + * Single public declaration for NRE. */ typedef int (Tcl_NRPostProc) (ClientData data[], Tcl_Interp *interp, @@ -2413,7 +2414,7 @@ typedef int (Tcl_NRPostProc) (ClientData data[], Tcl_Interp *interp, # define Tcl_IncrRefCount(objPtr) \ ++(objPtr)->refCount /* - * Use do/while0 idiom for optimum correctness without compiler warnings + * Use do/while0 idiom for optimum correctness without compiler warnings. * http://c2.com/cgi/wiki?TrivialDoWhileLoop */ # define Tcl_DecrRefCount(objPtr) \ |