Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/tools/build/v2/util/print.jam @ 12

Last change on this file since 12 was 12, checked in by landauf, 18 years ago

added boost
File size: 13.8 KB
Line 
1# (C) Copyright Rene Rivera, 2002-2003.
2#
3# See accompanying license for terms and conditions of use.
4#
5
6# Utilities for generating format independent output. Using these
7# will help in generation of documentation in at minimum plain/console
8# and html.
9
10import modules ;
11import numbers ;
12import string ;
13import regex ;
14
15# The current output target. Defaults to console.
16output-target = console ;
17
18# The current output type. Defaults to plain.
19output-type = plain ;
20
21# Whitespace.
22.whitespace = [ string.whitespace ] ;
23
24# Set the target and type of output to generate. This sets both
25# the destination output and the type of docs to generate to that
26# output. The target can be either a file or "console" for echoing
27# to the console. If the type of output is not specified it defaults
28# to plain text.
29#
30rule output (
31    target # The target file or device; file or "console".
32    type ? # The type of output; "plain", or "html".
33    )
34{
35    type ?= plain ;
36    if $(output-target) != $(target)
37    {
38        output-target = $(target) ;
39        output-type = $(type) ;
40        if $(output-type) = html
41        {
42            text
43                "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\">"
44                "<html>"
45                "<head>"
46                "</head>"
47                "<body link=\"#0000ff\" vlink=\"#800080\">"
48                : true
49                : prefix ;
50            text
51                "</body>"
52                "</html>"
53                :
54                : suffix ;
55        }
56    }
57}
58
59# Generate a section with a description. The type of output can be
60# controlled by the value of the 'output-type' variable. If not set
61# it defaults to 'console' indicating immediate display to the console.
62# Other possible values are: 'html-file'.
63#
64rule section (
65    name # The name of the section.
66    description * # A number of description lines.
67    )
68{
69    if $(output-type) = plain
70    {
71        lines [ split-at-words $(name): ] ;
72        lines ;
73    }
74    else if $(output-type) = html
75    {
76        name = [ escape-html $(name) ] ;
77        text <h3>$(name)</h3> <p> ;
78    }
79    local pre = ;
80    while $(description)
81    {
82        local paragraph = ;
83        while $(description) && [ string.is-whitespace $(description[1]) ] { description = $(description[2-]) ; }
84        if $(pre)
85        {
86            while $(description) && (
87                $(pre) = " $(description[1])" ||
88                ( $(pre) < [ string.chars [ MATCH "^([$(.whitespace)]*)" : " $(description[1])" ] ] )
89                )
90                { paragraph += $(description[1]) ; description = $(description[2-]) ; }
91            while [ string.is-whitespace $(paragraph[-1]) ] { paragraph = $(paragraph[1--2]) ; }
92            pre = ;
93            if $(output-type) = plain
94            {
95                lines $(paragraph) "" : "  " "  " ;
96            }
97            else if $(output-type) = html
98            {
99                text <blockquote> ;
100                lines $(paragraph) ;
101                text </blockquote> ;
102            }
103        }
104        else
105        {
106            while $(description) && ! [ string.is-whitespace $(description[1]) ]
107                { paragraph += $(description[1]) ; description = $(description[2-]) ; }
108            if $(paragraph[1]) = :: && ! $(paragraph[2])
109            {
110                pre = " " ;
111            }
112            if $(paragraph[1]) = ::
113            {
114                if $(output-type) = plain
115                {
116                    lines $(paragraph[2-]) "" : "  " "  " ;
117                    lines ;
118                }
119                else if $(output-type) = html
120                {
121                    text <blockquote> ;
122                    lines $(paragraph[2-]) ;
123                    text </blockquote> ;
124                }
125            }
126            else
127            {
128                local p = [ MATCH "(.*)(::)$" : $(paragraph[-1]) ] ;
129                local pws = [ MATCH "([         ]*)$" : $(p[1]) ] ;
130                p = [ MATCH "(.*)($(pws))($(p[2]))$" :  $(paragraph[-1]) ] ;
131                if $(p[3]) = ::
132                {
133                    pre = [ string.chars [ MATCH "^([$(.whitespace)]*)" : " $(p[1])" ] ] ;
134                    if ! $(p[2]) || $(p[2]) = "" { paragraph = $(paragraph[1--2]) $(p[1]): ; }
135                    else { paragraph = $(paragraph[1--2]) $(p[1]) ; }
136                    if $(output-type) = plain
137                    {
138                        lines [ split-at-words " " $(paragraph) ] : "  " "  " ;
139                        lines ;
140                    }
141                    else if $(output-type) = html
142                    {
143                        text </p> <p> [ escape-html $(paragraph) ] ;
144                    }
145                }
146                else
147                {
148                    if $(output-type) = plain
149                    {
150                        lines [ split-at-words " " $(paragraph) ] : "  " "  " ;
151                        lines ;
152                    }
153                    else if $(output-type) = html
154                    {
155                        text </p> <p> [ escape-html $(paragraph) ] ;
156                    }
157                }
158            }
159        }
160    }
161    if $(output-type) = html
162    {
163        text </p> ;
164    }
165}
166
167# Generate the start of a list of items. The type of output can be
168# controlled by the value of the 'output-type' variable. If not set
169# it defaults to 'console' indicating immediate display to the console.
170# Other possible values are: 'html-file'.
171#
172rule list-start ( )
173{
174    if $(output-type) = plain
175    {
176    }
177    else if $(output-type) = html
178    {
179        text <ul> ;
180    }
181}
182
183# Generate an item in a list. The type of output can be
184# controlled by the value of the 'output-type' variable. If not set
185# it defaults to 'console' indicating immediate display to the console.
186# Other possible values are: 'html-file'.
187#
188rule list-item (
189    item + # The item to list.
190    )
191{
192    if $(output-type) = plain
193    {
194        lines [ split-at-words "*" $(item) ] : "  " ;
195    }
196    else if $(output-type) = html
197    {
198        text <li> [ escape-html $(item) ] </li> ;
199    }
200}
201
202# Generate the end of a list of items. The type of output can be
203# controlled by the value of the 'output-type' variable. If not set
204# it defaults to 'console' indicating immediate display to the console.
205# Other possible values are: 'html-file'.
206#
207rule list-end ( )
208{
209    if $(output-type) = plain
210    {
211        lines ;
212    }
213    else if $(output-type) = html
214    {
215        text </ul> ;
216    }
217}
218
219# Split the given text into separate lines, word-wrapping to a margin.
220# The default margin is 78 characters.
221#
222rule split-at-words (
223    text + # The text to split.
224    : margin ? # An optional margin, default is 78.
225    )
226{
227    local lines = ;
228    text = [ string.words $(text:J=" ") ] ;
229    text = $(text:J=" ") ;
230    margin ?= 78 ;
231    local char-match-1 = ".?" ;
232    local char-match = "" ;
233    while $(margin) != 0
234    {
235        char-match = $(char-match)$(char-match-1) ;
236        margin = [ numbers.decrement $(margin) ] ;
237    }
238    while $(text)
239    {
240        local s = "" ;
241        local t = "" ;
242        # divide s into the first X characters and the rest
243        s = [ MATCH "^($(char-match))(.*)" : $(text) ] ;
244       
245        if $(s[2])
246        {
247            # split the first half at a space
248            t = [ MATCH "^(.*)[\\ ]([^\\ ]*)$" : $(s[1]) ] ;
249        }
250        else
251        {
252            t = $(s) ;
253        }
254       
255        if ! $(t[2])
256        {
257            t += "" ;
258        }
259       
260        text = $(t[2])$(s[2]) ;
261        lines += $(t[1]) ;
262    }
263    return $(lines) ;
264}
265
266# Generate a set of fixed lines. Each single item passed in is
267# output on a separate line. For console this just echos each line,
268# but for html this will split them with <br>.
269#
270rule lines (
271    text * # The lines of text.
272    : indent ? # Optional indentation prepended to each line after the first one.
273    outdent ? # Optional indentation to prepend to the first line.
274    )
275{
276    text ?= "" ;
277    indent ?= "" ;
278    outdent ?= "" ;
279    if $(output-type) = plain
280    {
281        text $(outdent)$(text[1]) $(indent)$(text[2-]) ;
282    }
283    else if $(output-type) = html
284    {
285        local indent-chars = [ string.chars $(indent) ] ;
286        indent = "" ;
287        for local c in $(indent-chars)
288        {
289            if $(c) = " " { c = &nbsp; ; }
290            else if $(c) = "    " { c = &nbsp;&nbsp;&nbsp;&nbsp; ; }
291            indent = $(indent)$(c) ;
292        }
293        local html-text = [ escape-html $(text) : &nbsp; ] ;
294        text $(html-text[1])<br> $(indent)$(html-text[2-])<br> ;
295    }
296}
297
298# Output text directly to the current target. When doing output
299# to a file, one can indicate if the text should be output to
300# "prefix" it, as the "body" (default), or "suffix" of the file. This is
301# independant of the actual execution order of the text rule. This rule
302# invokes a singular action, one action only once, which does the
303# build of the file. Therefore actions on the target outside of this
304# rule will happen entirely before and/or after all output using this rule.
305#
306rule text (
307    strings * # The strings of text to output.
308    : overwrite ? # true to overwrite the output (if it is a file)
309    : prefix-body-suffix ? # Indication to output prefix, body, or suffix (for a file).
310    )
311{
312    prefix-body-suffix ?= body ;
313    if $(output-target) = console
314    {
315        if ! $(strings)
316        {
317            ECHO ;
318        }
319        else
320        {
321            while $(strings)
322            {
323                ECHO $(strings[1]) ;
324                strings = $(strings[2-]) ;
325            }
326        }
327    }
328    # We ignore empty output because the Windows ECHO command is
329    # braindamaged. It doesn't have any facility for echoing a blank line.
330    else if $(output-target)
331    {
332        if ! $($(output-target).did-action)
333        {
334            $(output-target).did-action = yes ;
335            _ on $(output-target) = " " ;
336            nl on $(output-target) = "
337" ;
338            text-redirect-0 on $(output-target) = ">>" ;
339            text-redirect-n on $(output-target) = ">>" ;
340            text-front on $(output-target) = ;
341            text-prefix on $(output-target) = ;
342            text-body on $(output-target) = ;
343            text-suffix on $(output-target) = ;
344            text-action $(output-target) ;
345            text-front-section.$(soutput-target) = ;
346        }
347        if $(overwrite)
348        {
349            text-redirect-0 on $(output-target) = ">" ;
350        }
351        if ! $(text-front-section.$(output-target))
352        {
353            text-front on $(output-target) = [ echo-cmd $(strings[1]) ] ;
354            text-front-section.$(output-target) = $(prefix-body-suffix) ;
355            strings = $(strings[2-]) ;
356        }
357        if $(strings)
358        {
359            if ( $(prefix-body-suffix) = prefix &&
360                    $(text-front-section.$(output-target)) != prefix ) ||
361                ( $(prefix-body-suffix) = body &&
362                $(text-front-section.$(output-target)) = suffix )
363            {
364                text-$(text-front-section.$(output-target)) on $(output-target) =
365                    [ on $(output-target) return $(text-front) ]
366                    [ on $(output-target) return $(text-$(text-front-section.$(output-target))) ] ;
367                text-front on $(output-target) = [ echo-cmd $(strings[1]) ] ;
368                text-front-section.$(output-target) = $(prefix-body-suffix) ;
369                strings = $(strings[2-]) ;
370            }
371            while $(strings)
372            {
373                text-$(prefix-body-suffix) on $(output-target) += [ echo-cmd $(strings[1]) ] ;
374                strings = $(strings[2-]) ;
375            }
376        }
377    }
378}
379
380# Outputs the text to the current targets, after word-wrapping it.
381rule wrapped-text ( text + )
382{
383    local lines = [ split-at-words $(text) ] ;
384    text $(lines) ;
385}
386
387# Escapes text into html/xml printable equivalents.
388# Does not know about tags and therefore tags fed into
389# this will also be escaped. Currently escapes space, "<", ">", and "&".
390#
391rule escape-html (
392    text + # The text to escape.
393    : space ? # What to replace spaces with, defaults to " ".
394    )
395{
396    local html-text = ;
397    while $(text)
398    {
399        local html = $(text[1]) ;
400        text = $(text[2-]) ;
401        html = [ regex.replace $(html) "&" "&amp;" ] ;
402        html = [ regex.replace $(html) "<" "&lt;" ] ;
403        html = [ regex.replace $(html) ">" "&gt;" ] ;
404        if $(space)
405        {
406            html = [ regex.replace $(html) " " "$(space)" ] ;
407        }
408        html-text += $(html) ;
409    }
410    return $(html-text) ;
411}
412
413# Outputs the text strings collected by the text rule to the output
414# file.
415#
416actions quietly text-action
417{
418$(text-front)$(_)$(text-redirect-0)$(_)"$(<)"
419$(text-prefix)$(_)$(text-redirect-n)$(_)"$(<)"$(nl)
420$(text-body)$(_)$(text-redirect-n)$(_)"$(<)"$(nl)
421$(text-suffix)$(_)$(text-redirect-n)$(_)"$(<)"$(nl)
422}
423
424if [ modules.peek : NT ]
425{
426    rule echo-cmd ( string ? )
427    {
428        if $(string) || $(string) != ""
429        {
430            local escaped = [ regex.escape $(string) : "&|()<>^" : "^" ] ;
431            return "echo $(escaped)" ;
432        }
433        else
434        {
435            return "echo." ;
436        }
437    }
438}
439else
440{
441    rule echo-cmd ( string ? )
442    {
443        if $(string) || $(string) != ""
444        {
445            local escaped = [ regex.escape $(string) : "\\\"" : "\\" ] ;
446            return "echo \"$(escaped)\"" ;
447        }
448        else
449        {
450            return "echo" ;
451        }
452    }
453}
454
455local rule __test__ ( )
456{
457    import assert ;
458   
459    assert.result one two three : split-at-words one two three : 5 ;
460    assert.result "one two" three : split-at-words one two three : 8 ;
461    assert.result "one two" three : split-at-words one two three : 9 ;
462    assert.result "one two three" : split-at-words one two three ;
463    # VP, 2004-12-03 The following test fails for some reason,
464    # so commenting it out.
465    #assert.result "one&nbsp;two&nbsp;three" "&amp;&lt;&gt;" :
466    #    escape-html "one two three" "&<>" ;
467}
Note: See TracBrowser for help on using the repository browser.