2 '\" Copyright (c) 1995-1996 Sun Microsystems, Inc.
4 '\" See the file "license.terms" for information on usage and redistribution
5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7 '\" RCS: @(#) $Id: Alloc.3,v 1.8 2002/10/09 09:38:38 dkf Exp $
9 '\" The definitions below are for supplemental macros used in Tcl/Tk
12 '\" .AP type name in/out ?indent?
13 '\" Start paragraph describing an argument to a library procedure.
14 '\" type is type of argument (int, etc.), in/out is either "in", "out",
15 '\" or "in/out" to describe whether procedure reads or modifies arg,
16 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
17 '\" needed; use .AS below instead)
20 '\" Give maximum sizes of arguments for setting tab stops. Type and
21 '\" name are examples of largest possible arguments that will be passed
22 '\" to .AP later. If args are omitted, default tab stops are used.
25 '\" Start box enclosure. From here until next .BE, everything will be
26 '\" enclosed in one large box.
29 '\" End of box enclosure.
32 '\" Begin code excerpt.
37 '\" .VS ?version? ?br?
38 '\" Begin vertical sidebar, for use in marking newly-changed parts
39 '\" of man pages. The first argument is ignored and used for recording
40 '\" the version when the .VS was added, so that the sidebars can be
41 '\" found and removed when they reach a certain age. If another argument
42 '\" is present, then a line break is forced before starting the sidebar.
45 '\" End of vertical sidebar.
48 '\" Begin an indented unfilled display.
51 '\" End of indented unfilled display.
54 '\" Start of list of standard options for a Tk widget. The
55 '\" options follow on successive lines, in four columns separated
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.
70 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
72 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
76 '\" # Start an argument description
80 . ie !"\\$2"" .TP \\n()Cu
85 \&\\$1 \\fI\\$2\\fP (\\$3)
98 '\" # define tabbing values for .AP
101 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
104 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
105 .nr )C \\n()Bu+\\w'(in/out)'u+2n
107 .AS Tcl_Interp Tcl_CreateInterp in/out
108 '\" # BS - start boxed text
109 '\" # ^y = starting y location
117 .if n \l'\\n(.lu\(ul'
120 '\" # BE - end boxed text (draw box now)
125 .ie n \l'\\n(^lu\(ul'
127 .\" Draw four-sided box normally, but don't draw top of
128 .\" box if the box started on an earlier page.
130 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
133 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
140 '\" # VS - start vertical sidebar
141 '\" # ^Y = starting y location
142 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
146 .ie n 'mc \s12\(br\s0
149 '\" # VE - end of vertical sidebar
157 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
164 '\" # Special macro to handle page bottom: finish off current
165 '\" # box/sidebar if in box/sidebar mode, then invoked standard
166 '\" # page bottom macro.
173 .\" Draw three-sided box if this is the box's first page,
174 .\" draw two sides but no top otherwise.
175 .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
176 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
179 .nr ^x \\n(^tu+1v-\\n(^Yu
180 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
193 '\" # DS - begin display
199 '\" # DE - end display
205 '\" # SO - start of list of standard options
207 .SH "STANDARD OPTIONS"
213 '\" # SE - end of list of standard options
218 See the \\fBoptions\\fR manual entry for details on the standard options.
220 '\" # OP - start of full description for a single option
225 Command-Line Name: \\fB\\$1\\fR
226 Database Name: \\fB\\$2\\fR
227 Database Class: \\fB\\$3\\fR
231 '\" # CS - begin code excerpt
237 '\" # CE - end code excerpt
245 .TH Tcl_Alloc 3 7.5 Tcl "Tcl Library Procedures"
248 Tcl_Alloc, Tcl_Free, Tcl_Realloc, Tcl_AttemptAlloc, Tcl_AttemptRealloc, ckalloc, ckfree, ckrealloc, attemptckalloc, attemptckrealloc \- allocate or free heap memory
251 \fB#include <tcl.h>\fR
254 \fBTcl_Alloc\fR(\fIsize\fR)
257 \fBTcl_Free\fR(\fIptr\fR)
260 \fBTcl_Realloc\fR(\fIptr, size\fR)
263 \fBTcl_AttemptAlloc\fR(\fIsize\fR)
266 \fBTcl_AttemptRealloc\fR(\fIptr, size\fR)
269 \fBckalloc\fR(\fIsize\fR)
272 \fBckfree\fR(\fIptr\fR)
275 \fBckrealloc\fR(\fIptr, size\fR)
278 \fBattemptckalloc\fR(\fIsize\fR)
281 \fBattemptckrealloc\fR(\fIptr, size\fR)
285 Size in bytes of the memory block to allocate.
287 Pointer to memory block to free or realloc.
292 These procedures provide a platform and compiler independent interface
293 for memory allocation. Programs that need to transfer ownership of
294 memory blocks between Tcl and other modules should use these routines
295 rather than the native \fBmalloc()\fR and \fBfree()\fR routines
296 provided by the C run-time library.
298 \fBTcl_Alloc\fR returns a pointer to a block of at least \fIsize\fR
299 bytes suitably aligned for any use.
301 \fBTcl_Free\fR makes the space referred to by \fIptr\fR available for
304 \fBTcl_Realloc\fR changes the size of the block pointed to by
305 \fIptr\fR to \fIsize\fR bytes and returns a pointer to the new block.
306 The contents will be unchanged up to the lesser of the new and old
307 sizes. The returned location may be different from \fIptr\fR.
309 \fBTcl_AttemptAlloc\fR and \fBTcl_AttemptRealloc\fR are identical in
310 function to \fBTcl_Alloc\fR and \fBTcl_Realloc\fR, except that
311 \fBTcl_AttemptAlloc\fR and \fBTcl_AttemptRealloc\fR will not cause the Tcl
312 interpreter to \fBpanic\fR if the memory allocation fails. If the
313 allocation fails, these functions will return NULL. Note that on some
314 platforms, attempting to allocate a block of memory will also cause
315 these functions to return NULL.
317 The procedures \fBckalloc\fR, \fBckfree\fR, \fBckrealloc\fR,
318 \fBattemptckalloc\fR, and \fBattemptckrealloc\fR are implemented
319 as macros. Normally, they are synonyms for the corresponding
320 procedures documented on this page. When Tcl and all modules
321 calling Tcl are compiled with \fBTCL_MEM_DEBUG\fR defined, however,
322 these macros are redefined to be special debugging versions of
323 of these procedures. To support Tcl's memory debugging within a
324 module, use the macros rather than direct calls to \fBTcl_Alloc\fR, etc.
327 alloc, allocation, free, malloc, memory, realloc, TCL_MEM_DEBUG