2 '\" Copyright (c) 2007 Donal K. Fellows
4 '\" See the file "license.terms" for information on usage and redistribution
5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7 .TH Tcl_Class 3 0.1 TclOO "TclOO Library Functions"
8 .\" The -*- nroff -*- definitions below are for supplemental macros used
9 .\" in Tcl/Tk manual entries.
11 .\" .AP type name in/out ?indent?
12 .\" Start paragraph describing an argument to a library procedure.
13 .\" type is type of argument (int, etc.), in/out is either "in", "out",
14 .\" or "in/out" to describe whether procedure reads or modifies arg,
15 .\" and indent is equivalent to second arg of .IP (shouldn't ever be
16 .\" needed; use .AS below instead)
19 .\" Give maximum sizes of arguments for setting tab stops. Type and
20 .\" name are examples of largest possible arguments that will be passed
21 .\" to .AP later. If args are omitted, default tab stops are used.
24 .\" Start box enclosure. From here until next .BE, everything will be
25 .\" enclosed in one large box.
28 .\" End of box enclosure.
31 .\" Begin code excerpt.
36 .\" .VS ?version? ?br?
37 .\" Begin vertical sidebar, for use in marking newly-changed parts
38 .\" of man pages. The first argument is ignored and used for recording
39 .\" the version when the .VS was added, so that the sidebars can be
40 .\" found and removed when they reach a certain age. If another argument
41 .\" is present, then a line break is forced before starting the sidebar.
44 .\" End of vertical sidebar.
47 .\" Begin an indented unfilled display.
50 .\" End of indented unfilled display.
53 .\" Start of list of standard options for a Tk widget. The manpage
54 .\" argument defines where to look up the standard options; if
55 .\" omitted, defaults to "options". The options follow on successive
56 .\" lines, in three columns separated by tabs.
59 .\" End of list of standard options for a Tk widget.
61 .\" .OP cmdName dbName dbClass
62 .\" Start of description of a specific option. cmdName gives the
63 .\" option's name as specified in the class command, dbName gives
64 .\" the option's name in the option database, and dbClass gives
65 .\" the option's class in the option database.
68 .\" Print arg1 underlined, then print arg2 normally.
71 .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation).
74 .\" Print an open parenthesis, arg1 in quotes, then arg2 normally
75 .\" (for trailing punctuation) and then a closing parenthesis.
77 .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
81 .\" # Start an argument description
85 . ie !"\\$2"" .TP \\n()Cu
90 \&\\$1 \\fI\\$2\\fP (\\$3)
103 .\" # define tabbing values for .AP
106 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
109 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
110 .nr )C \\n()Bu+\\w'(in/out)'u+2n
112 .AS Tcl_Interp Tcl_CreateInterp in/out
113 .\" # BS - start boxed text
114 .\" # ^y = starting y location
122 .if n \l'\\n(.lu\(ul'
125 .\" # BE - end boxed text (draw box now)
130 .ie n \l'\\n(^lu\(ul'
132 .\" Draw four-sided box normally, but don't draw top of
133 .\" box if the box started on an earlier page.
135 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
138 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
145 .\" # VS - start vertical sidebar
146 .\" # ^Y = starting y location
147 .\" # ^v = 1 (for troff; for nroff this doesn't matter)
151 .ie n 'mc \s12\(br\s0
154 .\" # VE - end of vertical sidebar
162 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
169 .\" # Special macro to handle page bottom: finish off current
170 .\" # box/sidebar if in box/sidebar mode, then invoked standard
171 .\" # page bottom macro.
178 .\" Draw three-sided box if this is the box's first page,
179 .\" draw two sides but no top otherwise.
180 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
181 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
184 .nr ^x \\n(^tu+1v-\\n(^Yu
185 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
198 .\" # DS - begin display
204 .\" # DE - end display
210 .\" # SO - start of list of standard options
212 'ie '\\$1'' .ds So \\fBoptions\\fR
213 'el .ds So \\fB\\$1\\fR
214 .SH "STANDARD OPTIONS"
220 .\" # SE - end of list of standard options
225 See the \\*(So manual entry for details on the standard options.
227 .\" # OP - start of full description for a single option
232 Command-Line Name: \\fB\\$1\\fR
233 Database Name: \\fB\\$2\\fR
234 Database Class: \\fB\\$3\\fR
238 .\" # CS - begin code excerpt
244 .\" # CE - end code excerpt
249 .\" # UL - underline word
253 .\" # QW - apply quotation marks to word
255 .ie '\\*(lq'"' ``\\$1''\\$2
256 .\"" fix emacs highlighting
257 .el \\*(lq\\$1\\*(rq\\$2
259 .\" # PQ - apply parens and quotation marks to word
261 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
262 .\"" fix emacs highlighting
263 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
265 .\" # QR - quoted range
267 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
268 .\"" fix emacs highlighting
269 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
271 .\" # MT - "empty" string
276 '\" Note: do not modify the .SH NAME line immediately below!
278 Tcl_ClassGetMetadata, Tcl_ClassSetMetadata, Tcl_CopyObjectInstance, Tcl_GetClassAsObject, Tcl_GetObjectAsClass, Tcl_GetObjectCommand, Tcl_GetObjectFromObj, Tcl_GetObjectName, Tcl_GetObjectNamespace, Tcl_NewObjectInstance, Tcl_ObjectDeleted, Tcl_ObjectGetMetadata, Tcl_ObjectGetMethodNameMapper, Tcl_ObjectSetMetadata, Tcl_ObjectSetMethodNameMapper \- manipulate objects and classes
281 \fB#include <tclOO.h>\fR
284 \fBTcl_GetObjectFromObj\fR(\fIinterp, objPtr\fR)
287 \fBTcl_GetClassAsObject\fR(\fIclass\fR)
290 \fBTcl_GetObjectAsClass\fR(\fIobject\fR)
293 \fBTcl_GetObjectName\fR(\fIinterp, object\fR)
296 \fBTcl_GetObjectCommand\fR(\fIobject\fR)
299 \fBTcl_GetObjectNamespace\fR(\fIobject\fR)
302 \fBTcl_NewObjectInstance\fR(\fIinterp, class, name, nsName, objc, objv, skip\fR)
305 \fBTcl_CopyObjectInstance\fR(\fIinterp, object, name, nsName\fR)
308 \fBTcl_ObjectDeleted\fR(\fIobject\fR)
311 \fBTcl_ObjectGetMetadata\fR(\fIobject, metaTypePtr\fR)
313 \fBTcl_ObjectSetMetadata\fR(\fIobject, metaTypePtr, metadata\fR)
316 \fBTcl_ClassGetMetadata\fR(\fIclass, metaTypePtr\fR)
318 \fBTcl_ClassSetMetadata\fR(\fIclass, metaTypePtr, metadata\fR)
320 Tcl_ObjectMapMethodNameProc
321 \fBTcl_ObjectGetMethodNameMapper\fR(\fIobject\fR)
323 \fBTcl_ObjectSetMethodNameMapper\fR(\fIobject\fR, \fImethodNameMapper\fR)
325 .AS ClientData metadata in/out
326 .AP Tcl_Interp *interp in/out
327 Interpreter providing the context for looking up or creating an object, and
328 into whose result error messages will be written on failure.
329 .AP Tcl_Obj *objPtr in
330 The name of the object to look up.
331 .AP Tcl_Object object in
332 Reference to the object to operate upon.
333 .AP Tcl_Class class in
334 Reference to the class to operate upon.
335 .AP "const char" *name in
336 The name of the object to create, or NULL if a new unused name is to be
337 automatically selected.
338 .AP "const char" *nsName in
339 The name of the namespace to create for the object's private use, or NULL if a
340 new unused name is to be automatically selected.
342 The number of elements in the \fIobjv\fR array.
343 .AP "Tcl_Obj *const" *objv in
344 The arguments to the command to create the instance of the class.
346 The number of arguments at the start of the argument array, \fIobjv\fR, that
347 are not arguments to any constructors.
348 .AP Tcl_ObjectMetadataType *metaTypePtr in
349 The type of \fImetadata\fR being set with \fBTcl_ClassSetMetadata\fR or
350 retrieved with \fBTcl_ClassGetMetadata\fR.
351 .AP ClientData metadata in
352 An item of metadata to attach to the class, or NULL to remove the metadata
353 associated with a particular \fImetaTypePtr\fR.
354 .AP "Tcl_ObjectMapMethodNameProc" "methodNameMapper" in
355 A pointer to a function to call to adjust the mapping of objects and method
356 names to implementations, or NULL when no such mapping is required.
360 Objects are typed entities that have a set of operations ("methods")
361 associated with them. Classes are objects that can manufacture objects. Each
362 class can be viewed as an object itself; the object view can be retrieved
363 using \fBTcl_GetClassAsObject\fR which always returns the object when applied
364 to a non-destroyed class, and an object can be viewed as a class with the aid
365 of the \fBTcl_GetObjectAsClass\fR (which either returns the class, or NULL if
366 the object is not a class). An object may be looked up using the
367 \fBTcl_GetObjectFromObj\fR function, which either returns an object or NULL
368 (with an error message in the interpreter result) if the object cannot be
369 found. The correct way to look up a class by name is to look up the object
370 with that name, and then to use \fBTcl_GetObjectAsClass\fR.
372 Every object has its own command and namespace associated with it. The command
373 may be retrieved using the \fBTcl_GetObjectCommand\fR function, the name of
374 the object (and hence the name of the command) with \fBTcl_GetObjectName\fR,
375 and the namespace may be retrieved using the \fBTcl_GetObjectNamespace\fR
376 function. Note that the Tcl_Obj reference returned by \fBTcl_GetObjectName\fR
377 is a shared reference.
379 Instances of classes are created using \fBTcl_NewObjectInstance\fR, which
380 creates an object from any class (and which is internally called by both
381 the \fBcreate\fR and \fBnew\fR methods of the \fBoo::class\fR class). It takes
382 parameters that optionally give the name of the object and namespace to
383 create, and which describe the arguments to pass to the class's constructor
384 (if any). The result of the function will be either a reference to the newly
385 created object, or NULL if the creation failed (when an error message will be
386 left in the interpreter result). In addition, objects may be copied by using
387 \fBTcl_CopyObjectInstance\fR which creates a copy of an object without running
389 .SH "OBJECT AND CLASS METADATA"
391 Every object and every class may have arbitrary amounts of metadata attached
392 to it, which the object or class attaches no meaning to beyond what is
393 described in a Tcl_ObjectMetadataType structure instance. Metadata to be
394 attached is described by the type of the metadata (given in the
395 \fImetaTypePtr\fR argument) and an arbitrary pointer (the \fImetadata\fR
396 argument) that are given to \fBTcl_ObjectSetMetadata\fR and
397 \fBTcl_ClassSetMetadata\fR, and a particular piece of metadata can be
398 retrieved given its type using \fBTcl_ObjectGetMetadata\fR and
399 \fBTcl_ClassGetMetadata\fR. If the \fImetadata\fR parameter to either
400 \fBTcl_ObjectSetMetadata\fR or \fBTcl_ClassSetMetadata\fR is NULL, the
401 metadata is removed if it was attached, and the results of
402 \fBTcl_ObjectGetMetadata\fR and \fBTcl_ClassGetMetadata\fR are NULL if the
403 given type of metadata was not attached. It is not an error to request or
404 remove a piece of metadata that was not attached.
405 .SS "TCL_OBJECTMETADATATYPE STRUCTURE"
407 The contents of the Tcl_ObjectMetadataType structure are as follows:
410 typedef const struct {
412 const char *\fIname\fR;
413 Tcl_ObjectMetadataDeleteProc *\fIdeleteProc\fR;
414 Tcl_CloneProc *\fIcloneProc\fR;
415 } \fBTcl_ObjectMetadataType\fR;
418 The \fIversion\fR field allows for future expansion of the structure, and
419 should always be declared equal to TCL_OO_METADATA_VERSION_CURRENT. The
420 \fIname\fR field provides a human-readable name for the type, and is reserved
423 The \fIdeleteProc\fR field gives a function of type
424 Tcl_ObjectMetadataDeleteProc that is used to delete a particular piece of
425 metadata, and is called when the attached metadata is replaced or removed; the
426 field must not be NULL.
428 The \fIcloneProc\fR field gives a function that is used to copy a piece of
429 metadata (used when a copy of an object is created using
430 \fBTcl_CopyObjectInstance\fR); if NULL, the metadata will be just directly
432 .SS "TCL_OBJECTMETADATADELETEPROC FUNCTION SIGNATURE"
434 Functions matching this signature are used to delete metadata associated with
438 typedef void \fBTcl_ObjectMetadataDeleteProc\fR(
439 ClientData \fImetadata\fR);
442 The \fImetadata\fR argument gives the address of the metadata to be
444 .SS "TCL_CLONEPROC FUNCTION SIGNATURE"
446 Functions matching this signature are used to create copies of metadata
447 associated with a class or object.
450 typedef int \fBTcl_CloneProc\fR(
451 Tcl_Interp *\fIinterp\fR,
452 ClientData \fIsrcMetadata\fR,
453 ClientData *\fIdstMetadataPtr\fR);
456 The \fIinterp\fR argument gives a place to write an error message when the
457 attempt to clone the object is to fail, in which case the clone procedure must
458 also return TCL_ERROR; it should return TCL_OK otherwise.
459 The \fIsrcMetadata\fR argument gives the address of the metadata to be cloned,
460 and the cloned metadata should be written into the variable pointed to by
461 \fIdstMetadataPtr\fR; a NULL should be written if the metadata is to not be
462 cloned but the overall object copy operation is still to succeed.
463 .SH "OBJECT METHOD NAME MAPPING"
464 It is possible to control, on a per-object basis, what methods are invoked
465 when a particular method is invoked. Normally this is done by looking up the
466 method name in the object and then in the class hierarchy, but fine control of
467 exactly what the value used to perform the look up is afforded through the
468 ability to set a method name mapper callback via
469 \fBTcl_ObjectSetMethodNameMapper\fR (and its introspection counterpart,
470 \fBTcl_ObjectGetMethodNameMapper\fR, which returns the current mapper). The
471 current mapper (if any) is invoked immediately before looking up what chain of
472 method implementations is to be used.
473 .SS "TCL_OBJECTMAPMETHODNAMEPROC FUNCTION SIGNATURE"
474 The \fITcl_ObjectMapMethodNameProc\fR callback is defined as follows:
477 typedef int \fBTcl_ObjectMapMethodNameProc\fR(
478 Tcl_Interp *\fIinterp\fR,
479 Tcl_Object \fIobject\fR,
480 Tcl_Class *\fIstartClsPtr\fR,
481 Tcl_Obj *\fImethodNameObj\fR);
484 If the result is TCL_OK, the remapping is assumed to have been done. If the
485 result is TCL_ERROR, an error message will have been left in \fIinterp\fR and
486 the method call will fail. If the result is TCL_BREAK, the standard method
487 name lookup rules will be used; the behavior of other result codes is
488 currently undefined. The \fIobject\fR parameter says which object is being
489 processed. The \fIstartClsPtr\fR parameter points to a variable that contains
490 the first class to provide a definition in the method chain to process, or
491 NULL if the whole chain is to be processed (the argument itself is never
492 NULL); this variable may be updated by the callback. The \fImethodNameObj\fR
493 parameter gives an unshared object containing the name of the method being
494 invoked, as provided by the user; this object may be updated by the callback.
496 Method(3), oo::class(n), oo::copy(n), oo::define(n), oo::object(n)
498 class, constructor, object
OSDN Git Service
