diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2023-05-01 14:07:59 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2023-05-01 14:07:59 (GMT) |
commit | 75554201664b7e701f13d53c97aa385cd1ff0114 (patch) | |
tree | 9beab2c0cca5f8d1978d21b9ade59cd09e149ec4 /generic | |
parent | 10c71dc8b9b6b31ccb669be71f22adafdddfce6e (diff) | |
download | tcl-75554201664b7e701f13d53c97aa385cd1ff0114.zip tcl-75554201664b7e701f13d53c97aa385cd1ff0114.tar.gz tcl-75554201664b7e701f13d53c97aa385cd1ff0114.tar.bz2 |
Add doc comments, fix a typo in a manpage
Diffstat (limited to 'generic')
-rw-r--r-- | generic/tclOOCall.c | 82 |
1 files changed, 70 insertions, 12 deletions
diff --git a/generic/tclOOCall.c b/generic/tclOOCall.c index 5a0eeea..57f8860 100644 --- a/generic/tclOOCall.c +++ b/generic/tclOOCall.c @@ -2110,11 +2110,24 @@ AddDefinitionNamespaceToChain( definePtr->num++; } +/* + * ---------------------------------------------------------------------- + * + * FindClassProps -- + * + * Discover the properties known to a class and its superclasses. + * The property names become the keys in the accumulator hash table + * (which is used as a set). + * + * ---------------------------------------------------------------------- + */ + static void FindClassProps( - Class *clsPtr, - int writable, - Tcl_HashTable *accumulator) + Class *clsPtr, /* The object to inspect. Must exist. */ + int writable, /* Whether we're after the readable or writable + * property set. */ + Tcl_HashTable *accumulator) /* Where to gather the names. */ { int i, dummy; Tcl_Obj *propName; @@ -2148,11 +2161,24 @@ FindClassProps( } } +/* + * ---------------------------------------------------------------------- + * + * FindObjectProps -- + * + * Discover the properties known to an object and all its classes. + * The property names become the keys in the accumulator hash table + * (which is used as a set). + * + * ---------------------------------------------------------------------- + */ + static void FindObjectProps( - Object *oPtr, - int writable, - Tcl_HashTable *accumulator) + Object *oPtr, /* The object to inspect. Must exist. */ + int writable, /* Whether we're after the readable or writable + * property set. */ + Tcl_HashTable *accumulator) /* Where to gather the names. */ { int i, dummy; Tcl_Obj *propName; @@ -2173,11 +2199,27 @@ FindObjectProps( FindClassProps(oPtr->selfCls, writable, accumulator); } +/* + * ---------------------------------------------------------------------- + * + * TclOOGetAllClassProperties -- + * + * Get the list of all properties known to a class, including to its + * superclasses. Manages a cache so this operation is usually cheap. + * The order of properties in the resulting list is undefined. + * + * ---------------------------------------------------------------------- + */ + Tcl_Obj * TclOOGetAllClassProperties( - Class *clsPtr, - int writable, - int *allocated) + Class *clsPtr, /* The class to inspect. Must exist. */ + int writable, /* Whether to get writable properties. If + * false, readable properties will be returned + * instead. */ + int *allocated) /* Address of variable to set to true if a + * Tcl_Obj was allocated and may be safely + * modified by the caller. */ { Tcl_HashTable hashTable; FOREACH_HASH_DECLS; @@ -2239,11 +2281,27 @@ TclOOGetAllClassProperties( return result; } +/* + * ---------------------------------------------------------------------- + * + * TclOOGetAllObjectProperties -- + * + * Get the list of all properties known to a object, including to its + * classes. Manages a cache so this operation is usually cheap. + * The order of properties in the resulting list is undefined. + * + * ---------------------------------------------------------------------- + */ + Tcl_Obj * TclOOGetAllObjectProperties( - Object *oPtr, - int writable, - int *allocated) + Object *oPtr, /* The object to inspect. Must exist. */ + int writable, /* Whether to get writable properties. If + * false, readable properties will be returned + * instead. */ + int *allocated) /* Address of variable to set to true if a + * Tcl_Obj was allocated and may be safely + * modified by the caller. */ { Tcl_HashTable hashTable; FOREACH_HASH_DECLS; |