blob: 5ed5b0c225ff296962404635ab69e6e347c8656d (
plain)
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
|
#!/usr/bin/env python
# Creates a man page from a C file.
# Comments beginning with `/**` are treated as Markdown.
# Non-blank lines immediately following a Markdown comment are treated
# as function signatures or examples and included verbatim. The
# immediately preceding markdown chunk is printed after the example
# as a comment on it.
# That's about it!
import sys
import re
if len(sys.argv) > 1:
sourcefile = sys.argv[1]
else:
print("Usage: make_man_page.py sourcefile")
exit(1)
comment_start_re = re.compile('^\/\*\* ?')
comment_delim_re = re.compile('^[/ ]\** ?')
comment_end_re = re.compile('^ \**\/')
blank_re = re.compile('^\s*$')
macro_re = re.compile('CMARK_EXPORT *')
mdlines = []
chunk = []
sig = []
with open(sourcefile, 'r') as cmarkh:
state = 'default'
for line in cmarkh:
# state transition
oldstate = state
if comment_start_re.match(line):
state = 'markdown'
elif comment_end_re.match(line) and state == 'markdown':
continue
elif comment_delim_re.match(line) and state == 'markdown':
state = 'markdown'
elif blank_re.match(line):
state = 'default'
elif state == 'markdown':
state = 'signature'
# handle line
if state == 'markdown':
chunk.append(re.sub(comment_delim_re, '', line))
elif state == 'signature':
ln = re.sub(macro_re, '', line)
if not re.match(blank_re, ln):
sig.append(' ' + ln)
elif oldstate == 'signature' and state != 'signature':
if len(mdlines) > 0 and mdlines[-1] != '\n':
mdlines.append('\n')
mdlines += sig # add sig, then prepended markdown comment
if len(mdlines) > 0 and mdlines[-1] != '\n':
mdlines.append('\n')
mdlines += chunk
chunk = []
sig = []
elif oldstate == 'markdown' and state != 'signature':
if len(mdlines) > 0 and mdlines[-1] != '\n':
mdlines.append('\n')
mdlines += chunk # add markdown chunk
chunk = []
mdlines.append('\n')
sys.stdout.write(''.join(mdlines))
|
