File: StructuredText.py

package info (click to toggle)
python-pmw 2.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 4,968 kB
  • sloc: python: 42,737; makefile: 4
file content (297 lines) | stat: -rw-r--r-- 8,542 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
#!/bin/env python

import cgi
import html
import re
import sys


# Characters that can come before and after a font change string.
before = '([- \n(]|^)'
after = "([-) \n,.:;'!?]|$)"
after_link = "(.|\n|$)"

# Font types:

# 'italic'
reg_em = re.compile(before + "'([^ ']([^\n']*[^ ])?)'" + after)

# Let single quotes be escaped with a backslash: \'
reg_escape_em = re.compile("\\\\'")

# *bold*
reg_strong = re.compile(before + "\*([^ *]([^\n*]*[^ ])?)\*" + after)

# /code/
reg_code = re.compile(before + "/([^ /]([^\n/]*[^ ])?)/" + after)

# ~~link~~text~~
reg_link = re.compile(before + "~~([^ ][^\n]*[^ ])~~([^ ][^\n]*[^ ])~~" + after)

# ~link~
reg_pmw_link = re.compile(before + "~([^ ][^\n~]*[^ ])~" + after_link)


# Paragraph types:

# - bullet list
reg_bullet = re.compile('[ \n]*[o*-][ \n]+([^\0]*)')

# 1.2.3 ordered list
reg_ol = re.compile('[ \n]*(([0-9]+|[a-zA-Z]+)\.)+[ \n]+([^\0]*|$)')

# (99) ordered list
reg_olp = re.compile('[ \n]*\([0-9]+\)[ \n]+([^\0]*|$)')

# -- definition list
reg_dl = re.compile('[ \n]*([^\n]+) +--[ \n]+([^\0]*)')

# # preformated code
reg_pre=re.compile('[ \n]*#([^\0]*)')


# A single line paragraph ending in ':' is a heading
reg_nl=re.compile('\n')

# To remove leading spaces and # on each line in preformated code:
reg_remove_hash=re.compile('\n *#')


reg_indent_tab = re.compile('(\n|^)( *)\t')
reg_indent_space = re.compile('\n( *)')
reg_paragraph_divider = re.compile('(\n *)+\n')

reg_extra_dl = re.compile("</dl>\n<dl>")
reg_extra_ul = re.compile("</ul>\n<ul>")
reg_extra_ol = re.compile("</ol>\n<ol>")

def gethtml(structuredString):
    '''\
    An HTML structured text formatter.
    Model text as structured collection of paragraphs.
    Structure is implied by the indentation level.

    Convert a string containing structured text into a structured
    text object.
      structuredString -- The string to be parsed.

    Return an HTML string representation of the structured text data.
    '''

    # Turn <, >, &, etc into html escape sequences and remove tabs.
    escapedText = html.escape(structuredString)
    escapedText = re.sub('&#x27;', "'", escapedText)
    noTabstext = untabify(escapedText)

    #########
    # Not yet finished
    # # Convert '.. [ref1] "Foo" by Bar', A to a named link.
    # print('===')
    # print(noTabstext)
    # print('===')
    # #Find out what \0 means inside []. Maybe convert to re module.
    # noTabstext = re.sub(
    #     '(^|\n) *\.\. \[([0-9_a-zA-Z-]+)\]',
    #     '\n  <a name="\\2">[\\2]</a>',
    #     noTabstext)
    #             
    # # Convert '[ref1]' to a link within the document.
    # noTabstext = re.sub(
    #     '([\0- ,])\[([0-9_a-zA-Z-]+)\]([\0- ,.:])',
    #     '\\1<a href="#\\2">[\\2]</a>\\3',
    #     noTabstext)
    #             
    # # Convert '[foo.html]' to an external link.
    # noTabstext = re.sub(
    #     '([\0- ,])\[([^]]+)\.html\]([\0- ,.:])',
    #     '\\1<a href="\\2.html">[\\2]</a>\\3',
    #     noTabstext)

    # Split the text into a list of paragraphs separted by a blank line.
    parasAndSpaces = reg_paragraph_divider.split(noTabstext)

    # Ignore white space between paragraphs
    rawParagraphs = []
    inPara = 1
    for para in parasAndSpaces:
        if inPara:
            rawParagraphs.append(para)
        inPara = not inPara

    # Create a list of (indent, para), where 'indent' is the number
    # of spaces on the first line and 'para' is the text'
    paragraphs = list(map(indent_level, rawParagraphs))

    # Create a list of (para, structure), where 'para' is the text of
    # a paragraph and 'structure' is a similar list of 'child'
    # paragraphs (ie, those indented further than 'para').
    structure=parse_structure(paragraphs)
    #print('<pre>')
    #print_structure(structure)
    #print('</pre>')

    s=structure_to_string(structure, 1)
    s=reg_extra_dl.sub('\n',s)
    s=reg_extra_ul.sub('\n',s)
    s=reg_extra_ol.sub('\n',s)
    return s

def print_structure(structure, indent = ''):
    import string
    print(indent + str(len(structure)))
    for p, s in structure:
        print(indent + p[:20].strip())
        if len(s) > 0:
            print_structure(s, indent = indent + '    ')

def changefonts(s):
    s=reg_em.sub('\\1<em>\\2</em>\\4',s)
    s=reg_escape_em.sub("'",s)
    s=reg_strong.sub('\\1<strong>\\2</strong>\\4',s)
    s=reg_code.sub('\\1<code>\\2</code>\\4',s)
    s=reg_link.sub('\\1<a href="\\2">\\3</a>\\4',s)
    s=reg_pmw_link.sub('\\1<a href="\\2.html">Pmw.\\2</a>\\3',s)
    return s

def untabify(aString):
    '''\
    Convert indentation tabs to spaces.
    '''
    result=''
    rest=aString
    while 1:
        match = reg_indent_tab.search(rest)
        if match is not None:
            start = match.start()
            lnl=len(match.group(1))
            indent=len(match.group(2))

            result=result+rest[:start]
            rest="\n%s%s" % (' ' * ((indent//8+1)*8),
                             rest[start+indent+1+lnl:])
        else:
            return result+rest

def indent_level(aString):
    '''\
    Find the minimum indentation for a string, not counting blank lines.
    '''
    start=0
    text='\n'+aString
    indent=l=len(text)
    while 1:
        match = reg_indent_space.search(text,start)
        if match is not None:
            start = match.start()
            i=len(match.group(1))
            start=start+i+1
            if start < l and text[start] != '\n':       # Skip blank lines
                if not i:
                    return (0,aString)
                if i < indent:
                    indent = i
        else:
            return (indent,aString)

def paragraphs(list,start):
    l=len(list)
    level=list[start][0]
    i=start+1
    while i < l and list[i][0] > level:
        i=i+1
    return i-1-start

def parse_structure(list):
    if not list:
        return []
    i=0
    l=len(list)
    r=[]
    while i < l:
        sublen=paragraphs(list,i)
        i=i+1
        r.append((list[i-1][1],parse_structure(list[i:i+sublen])))
        i=i+sublen
    return r

def ul(p, after):
    p = changefonts(p)
    if p:
        p="<p>%s</p>" % p
    return '<ul><li>%s\n%s\n</li></ul>\n' % (p,after)

def ol(p, after):
    p = changefonts(p)
    if p:
        p="<p>%s</p>" % p
    return '<ol><li>%s\n%s\n</li></ol>\n' % (p,after)

def dl(t, d, after):
    t = changefonts(t)
    d = changefonts(d)
    return '<dl><dt>%s</dt><dd>%s<p></p>\n%s\n</dd></dl>\n' % (t,d,after)

def head(p, level, after):
    p = changefonts(p)
    if level > 0 and level < 6:
        return '<h%d>%s</h%d>\n%s\n' % (level, p, level, after)
    else:
        p = "<p><strong>%s</strong><p>" % p
        return '<dl><dt>%s\n</dt><dd>%s\n</dd></dl>\n' % (p, after)

# hash mark (#) at start of line indicates preformatted text
def pre(p, after):
    # Do not call changefonts for preformatted text.
    p = reg_remove_hash.sub('\n', p)
    return '<dl><dd><pre>%s</pre></dd></dl>\n%s\n' % (p, after)

def normal(p,after):
    p = changefonts(p)
    return '<p>%s</p>\n%s\n' % (p,after)

def structure_to_string(structure, level):
    r = ''
    for text, sub_structure in structure:
        match = reg_bullet.match(text)
        if match is not None:
            p = match.group(1)
            r = r + ul(p,structure_to_string(sub_structure, level))
            continue

        match = reg_ol.match(text)
        if match is not None:
            p = match.group(3)
            r = r + ol(p,structure_to_string(sub_structure, level))
            continue

        match = reg_olp.match(text)
        if match is not None:
            p = match.group(1)
            r = r + ol(p,structure_to_string(sub_structure, level))
            continue

        match = reg_dl.match(text)
        if match is not None:
            t,d = match.group(1,2)
            r = r + dl(t,d,structure_to_string(sub_structure, level))
            continue

        match = reg_pre.match(text)
        if match is not None:
            p = match.group(1)
            r = r + pre(p,structure_to_string(sub_structure, level))
            continue

        # Not yet finished
        # match = reg_nl.match(text)
        # if match is None and sub_structure and text[-1:] != ':':
        #     r = r + head(text, level,
        #             structure_to_string(sub_structure, level and level + 1))
        #     continue

        r = r + normal(text,structure_to_string(sub_structure, level))

    return r

if __name__ == '__main__':
    print(gethtml(open('StructuredText.test').read()))