_text.tcl File Reference

Go to the source code of this file.

Functions/Subroutines
set bulleting *[%]	global (%)<%>}retBullet(type ivar
ret	EnumBullet (type ivar)
ret	Text (type text)
ret	Store (type op, type args)
ret	Off ()
ret	On ()
ret	IsOff ()
ret	NewEnv (type name, type script)
ret	TextInitialize ()
ret	Section (type name)
ret	Subsection (type name)
ret	CloseParagraph (optional id={)}
ret	SaveContext ()
ret	RestoreContext ()
ret	SetContext (type id)
ret	SaveEnv ()
ret	NewVerbatim ()
ret	Verbatim ()
ret	text_plain_text (type text)
ret	text_postprocess (type text)
ret	SECT (type text)
ret	SUBSECT (type text)
ret	PARA (type arguments)
ret	strong (type text)
ret	em (type text)
ret	parray_stderr (type a, optional pattern=*)
Variables
set lmarginIncrement global	rmarginThreshold
set rmarginThreshold global	bulleting
global	cmds = [list]
global	pEnv = {}
global	para = ""
global	nextId = 0
global	currentId = {}
global	currentEnv = {}
global	contexts = [list]
global	off = 1

Function Documentation

ret CloseParagraph ( )

Definition at line 162 of file _text.tcl.

References global(), PARA(), and Store().

00162                                   {)} {
00163     global para currentId
00164     if {$para != {}} {
00165     if {$id == {}} { id =  $currentId}
00166     Store PARA $id $para
00167     /* puts_stderr "CloseParagraph $id"*/
00168     }
00169      para =  ""
00170     return
00171 }

Here is the call graph for this function:

ret em ( type text )

Definition at line 408 of file _text.tcl.

00408 {return _${text}_}

ret EnumBullet ( type ivar )

Definition at line 43 of file _text.tcl.

References global().

00043                             {
00044     global enumeration ; upvar $ivar i
00045     set res [lindex $enumeration $i]
00046     set i [expr {($i + 1) % [llength $enumeration]}]
00047     return $res
00048 }

Here is the call graph for this function:

set bulleting* [%] global ( % )

Definition at line 34 of file _text.tcl.

References bulleting.

Referenced by _doc(), _msg(), _tci(), _tcl(), _tcr(), _tex(), Application(), bench(), bench_tmpfile(), CloseParagraph(), EnumBullet(), Exclude(), IsOff(), Module(), NewEnv(), NewVerbatim(), Off(), On(), PARA(), RestoreContext(), SaveContext(), SaveEnv(), SetContext(), Store(), Text(), text_postprocess(), TextInitialize(), and Verbatim().

00034                                                {[%] (%) <%>}
00035 
00036 ret  Bullet (type ivar) {
00037     global bulleting ; upvar $ivar i
00038     set res [lindex $bulleting $i]
00039     set i [expr {($i + 1) % [llength $bulleting]}]
00040     return $res
00041 }

Here is the caller graph for this function:

ret IsOff ( )

Definition at line 90 of file _text.tcl.

References global().

Referenced by text_plain_text().

00090 {global off ; return [expr {$off == 1}]}

Here is the call graph for this function:

Here is the caller graph for this function:

ret NewEnv	(	type	name,
		type	script
	)

Definition at line 99 of file _text.tcl.

References currentEnv, global(), and SaveEnv().

Referenced by NewVerbatim(), and TextInitialize().

00099                                       {
00100     global currentId  nextId currentEnv
00101 
00102     #puts_stderr "NewEnv ($name)"
00103 
00104     set    parentId  $currentId
00105     set    currentId $nextId
00106     incr              nextId
00107 
00108     append currentEnv(NAME) -$parentId-$name
00109     set currentEnv(parent) $parentId
00110     set currentEnv(id)     $currentId
00111 
00112     # Always squash a verbatim environment inherited from the previous
00113     # environment ...
00114     catch {unset currentEnv(verbenv)}
00115 
00116     uplevel $script
00117     SaveEnv
00118     return $currentId
00119 }

Here is the call graph for this function:

Here is the caller graph for this function:

ret NewVerbatim ( )

Definition at line 211 of file _text.tcl.

References currentEnv, global(), NewEnv(), and Verbatim().

Referenced by Verbatim().

00211                     {
00212     global currentEnv
00213     return [NewEnv Verbatim {set currentEnv(verbatim) 1}]
00214 }

Here is the call graph for this function:

Here is the caller graph for this function:

ret Off ( )

Definition at line 88 of file _text.tcl.

References global().

00088 {global off ; set off 1 ; return}

Here is the call graph for this function:

ret On ( )

Definition at line 89 of file _text.tcl.

References global().

00089 {global off para ; set off 0 ; set para "" ; return}

Here is the call graph for this function:

ret PARA ( type arguments )

Definition at line 314 of file _text.tcl.

References global(), para, and pEnv.

Referenced by CloseParagraph().

00314                            {
00315     global pEnv
00316     upvar linebuffer linebuffer
00317 
00318     foreach {env text} $arguments break
00319     array set para $pEnv($env)
00320 
00321     #puts_stderr "PARA $env"
00322     #parray_stderr para
00323     #puts_stderr "     \{$text\}"
00324     #puts_stderr ""
00325 
00326     # Use the information in the referenced environment to format the paragraph.
00327 
00328     if {$para(verbatim)} {
00329     set text [textutil::adjust::undent $text]
00330     } else {
00331     # The size is determined through the set left and right margins
00332     # right margin is fixed at 80, left margin is variable. Size
00333     # is at least 20. I.e. when left margin > 60 right margin is
00334     # shifted out to the right.
00335 
00336     set size [expr {80 - $para(lmargin)}]
00337     if {$size < 20} {set size 20}
00338 
00339     set text [textutil::adjust::adjust $text -length $size]
00340     }
00341 
00342     # Now apply prefixes, (ws prefixes bulleting), at last indentation.
00343 
00344     if {[string length $para(prefix)] > 0} {
00345     set text [textutil::adjust::indent $text $para(prefix)]
00346     }
00347 
00348     if {$para(listtype) != {}} {
00349     switch -exact $para(listtype) {
00350         bullet {
00351         # Indent for bullet, but not the first line. This is
00352         # prefixed by the bullet itself.
00353 
00354         set thebullet $para(bullet)
00355         }
00356         enum {
00357         # Handling the enumeration counter. Special case: An
00358         # example as first paragraph in an item has to use the
00359         # counter in environment it is derived from to prevent
00360         # miscounting.
00361 
00362         if {[info exists para(example)]} {
00363             set parent $para(parent)
00364             array set __ $pEnv($parent)
00365             if {![info exists __(counter)]} {
00366             set __(counter) 1
00367             } else {
00368             incr __(counter)
00369             }
00370             set pEnv($parent) [array get __] ; # Save context change ...
00371             set n $__(counter)
00372         } else {
00373             if {![info exists para(counter)]} {
00374             set para(counter) 1
00375             } else {
00376             incr para(counter)
00377             }
00378             set pEnv($env) [array get para] ; # Save context change ...
00379             set n $para(counter)
00380         }
00381 
00382         set thebullet [string map [list % $n] $para(bullet)]
00383         }
00384     }
00385 
00386     set blen [string length $thebullet]
00387     if {$blen >= [string length $para(wspfx)]} {
00388         set text    "$thebullet\n[textutil::adjust::indent $text $para(wspfx)]"
00389     } else {
00390         set fprefix $thebullet[string range $para(wspfx) $blen end]
00391         set text    "${fprefix}[textutil::adjust::indent $text $para(wspfx) 1]"
00392     }
00393     }
00394 
00395     if {$para(lmargin) > 0} {
00396     set text [textutil::adjust::indent $text \
00397               [textutil::repeat::strRepeat " " $para(lmargin)]]
00398     }
00399 
00400     lappend linebuffer ""
00401     lappend linebuffer $text
00402     return
00403 }

Here is the call graph for this function:

Here is the caller graph for this function:

ret parray_stderr	(	type	a,
		optional	pattern = `*`
	)

Definition at line 412 of file _text.tcl.

References error(), and name.

00412                                                   {
00413     upvar 1 $a array
00414     if {![array exists array]} {
00415         error "\"$a\" isn't an array"
00416     }
00417     set maxl 0
00418     foreach name [lsort [array names array $pattern]] {
00419         if {[string length $name] > $maxl} {
00420             set maxl [string length $name]
00421         }
00422     }
00423     set maxl [expr {$maxl + [string length $a] + 2}]
00424     foreach name [lsort [array names array $pattern]] {
00425         set nameString [format %s(%s) $a $name]
00426         puts_stderr "    [format "%-*s = {%s}" $maxl $nameString $array($name)]"
00427     }
00428 }

Here is the call graph for this function:

ret RestoreContext ( )

Definition at line 181 of file _text.tcl.

References global(), and SetContext().

Referenced by Verbatim().

00181                        {
00182     global                contexts
00183     SetContext   [lindex $contexts end]
00184     set contexts [lrange $contexts 0 end-1]
00185 
00186     #global currentId currentEnv ; puts_stderr "<<Restored $currentId ($currentEnv(NAME))"
00187     return
00188 }

Here is the call graph for this function:

Here is the caller graph for this function:

ret SaveContext ( )

Definition at line 173 of file _text.tcl.

References global().

Referenced by Verbatim().

00173                     {
00174     global  contexts  currentId
00175     lappend contexts $currentId
00176 
00177     #global currentEnv ; puts_stderr "Save>> $currentId ($currentEnv(NAME))"
00178     return
00179 }

Here is the call graph for this function:

Here is the caller graph for this function:

ret SaveEnv ( )

Definition at line 203 of file _text.tcl.

References global(), and pEnv.

Referenced by NewEnv(), and Verbatim().

00203                 {
00204     global pEnv  currentId             currentEnv
00205     set    pEnv($currentId) [array get currentEnv]
00206     return
00207 }

Here is the call graph for this function:

Here is the caller graph for this function:

ret SECT ( type text )

Definition at line 282 of file _text.tcl.

Referenced by Section().

00282                       {
00283     upvar linebuffer linebuffer
00284 
00285     # text is actually the list of arguments, having one element, the text.
00286     set text [lindex $text 0]
00287     #puts_stderr "SECT $text"
00288     #puts_stderr ""
00289 
00290     # Write section title, underline it
00291 
00292     lappend linebuffer ""
00293     lappend linebuffer $text
00294     lappend linebuffer [textutil::repeat::strRepeat = [string length $text]]
00295     return
00296 }

Here is the caller graph for this function:

ret Section ( type name )

Definition at line 159 of file _text.tcl.

References SECT(), and Store().

00159 {Store SECT    $name ; return}

Here is the call graph for this function:

ret SetContext ( type id )

Definition at line 190 of file _text.tcl.

References global().

Referenced by RestoreContext().

00190                           {
00191     global    currentId currentEnv pEnv
00192     set       currentId $id
00193 
00194     # Ensure that array is clean before setting hte new block of
00195     # information.
00196     unset     currentEnv
00197     array set currentEnv $pEnv($currentId)
00198 
00199     #puts_stderr "--Set $currentId ($currentEnv(NAME))"
00200     return
00201 }

Here is the call graph for this function:

Here is the caller graph for this function:

ret Store	(	type	op,
		type	args
	)

Definition at line 87 of file _text.tcl.

References cmds, and global().

Referenced by CloseParagraph(), Section(), and Subsection().

00087 {global cmds ; lappend cmds [list $op $args] ; return}

Here is the call graph for this function:

Here is the caller graph for this function:

ret strong ( type text )

Definition at line 407 of file _text.tcl.

00407 {return *${text}*}

ret SUBSECT ( type text )

Definition at line 298 of file _text.tcl.

Referenced by Subsection().

00298                          {
00299     upvar linebuffer linebuffer
00300 
00301     # text is actually the list of arguments, having one element, the text.
00302     set text [lindex $text 0]
00303     #puts_stderr "SUBSECT $text"
00304     #puts_stderr ""
00305 
00306     # Write subsection title, underline it (with less emphasis)
00307 
00308     lappend linebuffer ""
00309     lappend linebuffer $text
00310     lappend linebuffer [textutil::repeat::strRepeat - [string length $text]]
00311     return
00312 }

Here is the caller graph for this function:

ret Subsection ( type name )

Definition at line 160 of file _text.tcl.

References Store(), and SUBSECT().

00160 {Store SUBSECT $name ; return}

Here is the call graph for this function:

ret Text ( type text )

Definition at line 86 of file _text.tcl.

References global().

Referenced by text_plain_text(), and TextInitialize().

00086 {global para ; append para $text ; return}

Here is the call graph for this function:

Here is the caller graph for this function:

ret text_plain_text ( type text )

Definition at line 232 of file _text.tcl.

References IsOff(), and Text().

00232                                  {
00233     #puts_stderr "<<text_plain_text>>"
00234 
00235     if  {[IsOff]} {return}
00236 
00237     # Note: Whenever we get plain text it is possible that a macro for
00238     # visual markup actually generated output before the expander got
00239     # to the current text. This output was captured by the expander in
00240     # its current context. Given the current organization of the
00241     # engine we have to retrieve this formatted text from the expander
00242     # or it will be lost. This is the purpose of the 'ctopandclear',
00243     # which retrieves the data and also clears the capture buffer. The
00244     # latter to prevent us from retrieving it again later, after the
00245     # next macro added more data.
00246 
00247     set text [ex_ctopandclear]$text
00248 
00249     # ... TODO ... Handling of example => verbatim
00250 
00251     if {[string length [string trim $text]] == 0} return
00252 
00253     Text $text
00254     return
00255 }

Here is the call graph for this function:

ret text_postprocess ( type text )

Definition at line 259 of file _text.tcl.

References cmds, global(), and state.

00259                                   {
00260 
00261     #puts_stderr XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
00262     #puts_stderr <<$text>>
00263     #puts_stderr XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
00264 
00265     global cmds
00266     # The argument is not relevant. Access the display list, perform
00267     # the final layouting and return its result.
00268 
00269     set linebuffer [list]
00270     array set state {lmargin 0 rmargin 0}
00271     foreach cmd $cmds {
00272     foreach {op arguments} $cmd break
00273     $op $arguments
00274     }
00275 
00276     #puts_stderr XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
00277 
00278     return [join $linebuffer \n]
00279 }

Here is the call graph for this function:

ret TextInitialize ( )

Definition at line 123 of file _text.tcl.

References cmds, Display(), first(), global(), NewEnv(), and Text().

00124 00125 00126 00127 00128 00129 00130 00131 00132 00133 00134 00135 00136 00137 00138 00139 00140 00141 00142 00143 00144 00145 00146 00147 00148 00149 00150 00151 00152     } 00153     } 00154 00155 }

class="fragment">00123 { global off ; set off 1 global cmds ; set cmds [list] ; # Display list global pEnv ; array set pEnv {} ; # Defined paragraph environments (bulleting, indentation, other). global para ; set para "" ; # Text buffer for paragraphs. global nextId ; set nextId 0 ; # Counter for environment generation. global currentId ; set currentId {} ; # Id of current environment in 'pEnv' global currentEnv ; array set currentEnv {} ; # Current environment, expanded form. global contexts ; set contexts [list] ; # Stack of saved environments. # lmargin = location of left margin for text. # prefix = prefix string to use for all lines. # wspfx = whitespace prefix for all but the first line # listtype = type of list, if any # bullet = bullet to use for unordered, bullet template for ordered. # verbatim = flag if verbatim formatting requested. # next = if present the environment to use after closing the paragraph using this one. NewEnv Base { array set currentEnv { lmargin 0 prefix {} wspfx {} listtype {} bullet {} verbatim 0 bulleting 0 enumeration 0 return

Here is the call graph for this function:

ret Verbatim ( )

Definition at line 216 of file _text.tcl.

References currentEnv, global(), NewVerbatim(), RestoreContext(), SaveContext(), and SaveEnv().

Referenced by NewVerbatim().

00216                  {
00217     global currentEnv
00218     if {![info exists currentEnv(verbenv)]} {
00219     SaveContext
00220     set verb [NewVerbatim]
00221     RestoreContext
00222 
00223     # Remember verbatim mode in the base environment
00224     set currentEnv(verbenv) $verb
00225     SaveEnv
00226     }
00227     return $currentEnv(verbenv)
00228 }