util/X86LINUX64/man/man3/Tcl_DStringLength.3

   1 '\"
   2 '\" Copyright (c) 1993 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 .TH Tcl_DString 3 7.4 Tcl "Tcl Library Procedures"
   9 .\" The -*- nroff -*- definitions below are for supplemental macros used
  10 .\" in Tcl/Tk manual entries.
  11 .\"
  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)
  18 .\"
  19 .\" .AS ?type? ?name?
  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.
  23 .\"
  24 .\" .BS
  25 .\"     Start box enclosure.  From here until next .BE, everything will be
  26 .\"     enclosed in one large box.
  27 .\"
  28 .\" .BE
  29 .\"     End of box enclosure.
  30 .\"
  31 .\" .CS
  32 .\"     Begin code excerpt.
  33 .\"
  34 .\" .CE
  35 .\"     End code excerpt.
  36 .\"
  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.
  43 .\"
  44 .\" .VE
  45 .\"     End of vertical sidebar.
  46 .\"
  47 .\" .DS
  48 .\"     Begin an indented unfilled display.
  49 .\"
  50 .\" .DE
  51 .\"     End of indented unfilled display.
  52 .\"
  53 .\" .SO ?manpage?
  54 .\"     Start of list of standard options for a Tk widget. The manpage
  55 .\"     argument defines where to look up the standard options; if
  56 .\"     omitted, defaults to "options". The options follow on successive
  57 .\"     lines, in three columns separated by tabs.
  58 .\"
  59 .\" .SE
  60 .\"     End of list of standard options for a Tk widget.
  61 .\"
  62 .\" .OP cmdName dbName dbClass
  63 .\"     Start of description of a specific option.  cmdName gives the
  64 .\"     option's name as specified in the class command, dbName gives
  65 .\"     the option's name in the option database, and dbClass gives
  66 .\"     the option's class in the option database.
  67 .\"
  68 .\" .UL arg1 arg2
  69 .\"     Print arg1 underlined, then print arg2 normally.
  70 .\"
  71 .\" .QW arg1 ?arg2?
  72 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  73 .\"
  74 .\" .PQ arg1 ?arg2?
  75 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  76 .\"     (for trailing punctuation) and then a closing parenthesis.
  77 .\"
  78 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  79 .if t .wh -1.3i ^B
  80 .nr ^l \n(.l
  81 .ad b
  82 .\"     # Start an argument description
  83 .de AP
  84 .ie !"\\$4"" .TP \\$4
  85 .el \{\
  86 .   ie !"\\$2"" .TP \\n()Cu
  87 .   el          .TP 15
  88 .\}
  89 .ta \\n()Au \\n()Bu
  90 .ie !"\\$3"" \{\
  91 \&\\$1 \\fI\\$2\\fP (\\$3)
  92 .\".b
  93 .\}
  94 .el \{\
  95 .br
  96 .ie !"\\$2"" \{\
  97 \&\\$1  \\fI\\$2\\fP
  98 .\}
  99 .el \{\
 100 \&\\fI\\$1\\fP
 101 .\}
 102 .\}
 103 ..
 104 .\"     # define tabbing values for .AP
 105 .de AS
 106 .nr )A 10n
 107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 108 .nr )B \\n()Au+15n
 109 .\"
 110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 112 ..
 113 .AS Tcl_Interp Tcl_CreateInterp in/out
 114 .\"     # BS - start boxed text
 115 .\"     # ^y = starting y location
 116 .\"     # ^b = 1
 117 .de BS
 118 .br
 119 .mk ^y
 120 .nr ^b 1u
 121 .if n .nf
 122 .if n .ti 0
 123 .if n \l'\\n(.lu\(ul'
 124 .if n .fi
 125 ..
 126 .\"     # BE - end boxed text (draw box now)
 127 .de BE
 128 .nf
 129 .ti 0
 130 .mk ^t
 131 .ie n \l'\\n(^lu\(ul'
 132 .el \{\
 133 .\"     Draw four-sided box normally, but don't draw top of
 134 .\"     box if the box started on an earlier page.
 135 .ie !\\n(^b-1 \{\
 136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 137 .\}
 138 .el \}\
 139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 140 .\}
 141 .\}
 142 .fi
 143 .br
 144 .nr ^b 0
 145 ..
 146 .\"     # VS - start vertical sidebar
 147 .\"     # ^Y = starting y location
 148 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 149 .de VS
 150 .if !"\\$2"" .br
 151 .mk ^Y
 152 .ie n 'mc \s12\(br\s0
 153 .el .nr ^v 1u
 154 ..
 155 .\"     # VE - end of vertical sidebar
 156 .de VE
 157 .ie n 'mc
 158 .el \{\
 159 .ev 2
 160 .nf
 161 .ti 0
 162 .mk ^t
 163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 164 .sp -1
 165 .fi
 166 .ev
 167 .\}
 168 .nr ^v 0
 169 ..
 170 .\"     # Special macro to handle page bottom:  finish off current
 171 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 172 .\"     # page bottom macro.
 173 .de ^B
 174 .ev 2
 175 'ti 0
 176 'nf
 177 .mk ^t
 178 .if \\n(^b \{\
 179 .\"     Draw three-sided box if this is the box's first page,
 180 .\"     draw two sides but no top otherwise.
 181 .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
 182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 183 .\}
 184 .if \\n(^v \{\
 185 .nr ^x \\n(^tu+1v-\\n(^Yu
 186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 187 .\}
 188 .bp
 189 'fi
 190 .ev
 191 .if \\n(^b \{\
 192 .mk ^y
 193 .nr ^b 2
 194 .\}
 195 .if \\n(^v \{\
 196 .mk ^Y
 197 .\}
 198 ..
 199 .\"     # DS - begin display
 200 .de DS
 201 .RS
 202 .nf
 203 .sp
 204 ..
 205 .\"     # DE - end display
 206 .de DE
 207 .fi
 208 .RE
 209 .sp
 210 ..
 211 .\"     # SO - start of list of standard options
 212 .de SO
 213 'ie '\\$1'' .ds So \\fBoptions\\fR
 214 'el .ds So \\fB\\$1\\fR
 215 .SH "STANDARD OPTIONS"
 216 .LP
 217 .nf
 218 .ta 5.5c 11c
 219 .ft B
 220 ..
 221 .\"     # SE - end of list of standard options
 222 .de SE
 223 .fi
 224 .ft R
 225 .LP
 226 See the \\*(So manual entry for details on the standard options.
 227 ..
 228 .\"     # OP - start of full description for a single option
 229 .de OP
 230 .LP
 231 .nf
 232 .ta 4c
 233 Command-Line Name:      \\fB\\$1\\fR
 234 Database Name:  \\fB\\$2\\fR
 235 Database Class: \\fB\\$3\\fR
 236 .fi
 237 .IP
 238 ..
 239 .\"     # CS - begin code excerpt
 240 .de CS
 241 .RS
 242 .nf
 243 .ta .25i .5i .75i 1i
 244 ..
 245 .\"     # CE - end code excerpt
 246 .de CE
 247 .fi
 248 .RE
 249 ..
 250 .\"     # UL - underline word
 251 .de UL
 252 \\$1\l'|0\(ul'\\$2
 253 ..
 254 .\"     # QW - apply quotation marks to word
 255 .de QW
 256 .ie '\\*(lq'"' ``\\$1''\\$2
 257 .\"" fix emacs highlighting
 258 .el \\*(lq\\$1\\*(rq\\$2
 259 ..
 260 .\"     # PQ - apply parens and quotation marks to word
 261 .de PQ
 262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 263 .\"" fix emacs highlighting
 264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 265 ..
 266 .\"     # QR - quoted range
 267 .de QR
 268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 269 .\"" fix emacs highlighting
 270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 271 ..
 272 .\"     # MT - "empty" string
 273 .de MT
 274 .QW ""
 275 ..
 276 .BS
 277 .SH NAME
 278 Tcl_DStringInit, Tcl_DStringAppend, Tcl_DStringAppendElement, Tcl_DStringStartSublist, Tcl_DStringEndSublist, Tcl_DStringLength, Tcl_DStringValue, Tcl_DStringSetLength, Tcl_DStringTrunc, Tcl_DStringFree, Tcl_DStringResult, Tcl_DStringGetResult \- manipulate dynamic strings
 279 .SH SYNOPSIS
 280 .nf
 281 \fB#include <tcl.h>\fR
 282 .sp
 283 \fBTcl_DStringInit\fR(\fIdsPtr\fR)
 284 .sp
 285 char *
 286 \fBTcl_DStringAppend\fR(\fIdsPtr, bytes, length\fR)
 287 .sp
 288 char *
 289 \fBTcl_DStringAppendElement\fR(\fIdsPtr, element\fR)
 290 .sp
 291 \fBTcl_DStringStartSublist\fR(\fIdsPtr\fR)
 292 .sp
 293 \fBTcl_DStringEndSublist\fR(\fIdsPtr\fR)
 294 .sp
 295 int
 296 \fBTcl_DStringLength\fR(\fIdsPtr\fR)
 297 .sp
 298 char *
 299 \fBTcl_DStringValue\fR(\fIdsPtr\fR)
 300 .sp
 301 \fBTcl_DStringSetLength\fR(\fIdsPtr, newLength\fR)
 302 .sp
 303 \fBTcl_DStringTrunc\fR(\fIdsPtr, newLength\fR)
 304 .sp
 305 \fBTcl_DStringFree\fR(\fIdsPtr\fR)
 306 .sp
 307 \fBTcl_DStringResult\fR(\fIinterp, dsPtr\fR)
 308 .sp
 309 \fBTcl_DStringGetResult\fR(\fIinterp, dsPtr\fR)
 310 .SH ARGUMENTS
 311 .AS Tcl_DString newLength in/out
 312 .AP Tcl_DString *dsPtr in/out
 313 Pointer to structure that is used to manage a dynamic string.
 314 .AP "const char" *bytes in
 315 Pointer to characters to append to dynamic string.
 316 .AP "const char" *element in
 317 Pointer to characters to append as list element to dynamic string.
 318 .AP int length in
 319 Number of bytes from \fIbytes\fR to add to dynamic string.  If -1,
 320 add all characters up to null terminating character.
 321 .AP int newLength in
 322 New length for dynamic string, not including null terminating
 323 character.
 324 .AP Tcl_Interp *interp in/out
 325 Interpreter whose result is to be set from or moved to the
 326 dynamic string.
 327 .BE
 328
 329 .SH DESCRIPTION
 330 .PP
 331 Dynamic strings provide a mechanism for building up arbitrarily long
 332 strings by gradually appending information.  If the dynamic string is
 333 short then there will be no memory allocation overhead;  as the string
 334 gets larger, additional space will be allocated as needed.
 335 .PP
 336 \fBTcl_DStringInit\fR initializes a dynamic string to zero length.
 337 The Tcl_DString structure must have been allocated by the caller.
 338 No assumptions are made about the current state of the structure;
 339 anything already in it is discarded.
 340 If the structure has been used previously, \fBTcl_DStringFree\fR should
 341 be called first to free up any memory allocated for the old
 342 string.
 343 .PP
 344 \fBTcl_DStringAppend\fR adds new information to a dynamic string,
 345 allocating more memory for the string if needed.
 346 If \fIlength\fR is less than zero then everything in \fIbytes\fR
 347 is appended to the dynamic string;  otherwise \fIlength\fR
 348 specifies the number of bytes to append.
 349 \fBTcl_DStringAppend\fR returns a pointer to the characters of
 350 the new string.  The string can also be retrieved from the
 351 \fIstring\fR field of the Tcl_DString structure.
 352 .PP
 353 \fBTcl_DStringAppendElement\fR is similar to \fBTcl_DStringAppend\fR
 354 except that it does not take a \fIlength\fR argument (it appends
 355 all of \fIelement\fR) and it converts the string to a proper list element
 356 before appending.
 357 \fBTcl_DStringAppendElement\fR adds a separator space before the
 358 new list element unless the new list element is the first in a
 359 list or sub-list (i.e. either the current string is empty, or it
 360 contains the single character
 361 .QW { ,
 362 or the last two characters of the current string are
 363 .QW " {" ).
 364 \fBTcl_DStringAppendElement\fR returns a pointer to the
 365 characters of the new string.
 366 .PP
 367 \fBTcl_DStringStartSublist\fR and \fBTcl_DStringEndSublist\fR can be
 368 used to create nested lists.
 369 To append a list element that is itself a sublist, first
 370 call \fBTcl_DStringStartSublist\fR, then call \fBTcl_DStringAppendElement\fR
 371 for each of the elements in the sublist, then call
 372 \fBTcl_DStringEndSublist\fR to end the sublist.
 373 \fBTcl_DStringStartSublist\fR appends a space character if needed,
 374 followed by an open brace;  \fBTcl_DStringEndSublist\fR appends
 375 a close brace.
 376 Lists can be nested to any depth.
 377 .PP
 378 \fBTcl_DStringLength\fR is a macro that returns the current length
 379 of a dynamic string (not including the terminating null character).
 380 \fBTcl_DStringValue\fR is a  macro that returns a pointer to the
 381 current contents of a dynamic string.
 382 .PP
 383 .PP
 384 \fBTcl_DStringSetLength\fR changes the length of a dynamic string.
 385 If \fInewLength\fR is less than the string's current length, then
 386 the string is truncated.
 387 If \fInewLength\fR is greater than the string's current length,
 388 then the string will become longer and new space will be allocated
 389 for the string if needed.
 390 However, \fBTcl_DStringSetLength\fR will not initialize the new
 391 space except to provide a terminating null character;  it is up to the
 392 caller to fill in the new space.
 393 \fBTcl_DStringSetLength\fR does not free up the string's storage space
 394 even if the string is truncated to zero length, so \fBTcl_DStringFree\fR
 395 will still need to be called.
 396 .PP
 397 \fBTcl_DStringTrunc\fR changes the length of a dynamic string.
 398 This procedure is now deprecated.  \fBTcl_DStringSetLength\fR  should
 399 be used instead.
 400 .PP
 401 \fBTcl_DStringFree\fR should be called when you are finished using
 402 the string.  It frees up any memory that was allocated for the string
 403 and reinitializes the string's value to an empty string.
 404 .PP
 405 \fBTcl_DStringResult\fR sets the result of \fIinterp\fR to the value of
 406 the dynamic string given by \fIdsPtr\fR.  It does this by moving
 407 a pointer from \fIdsPtr\fR to the interpreter's result.
 408 This saves the cost of allocating new memory and copying the string.
 409 \fBTcl_DStringResult\fR also reinitializes the dynamic string to
 410 an empty string.
 411 .PP
 412 \fBTcl_DStringGetResult\fR does the opposite of \fBTcl_DStringResult\fR.
 413 It sets the value of \fIdsPtr\fR to the result of \fIinterp\fR and
 414 it clears \fIinterp\fR's result.
 415 If possible it does this by moving a pointer rather than by copying
 416 the string.
 417
 418 .SH KEYWORDS
 419 append, dynamic string, free, result