aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/literasc.py
blob: 5c5b80e73e50efe88e082172c169b7b703343721 (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
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
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Literasc, a simple literate programming tool for C, C++, and Turtle.
# Copyright 2012 David Robillard <d@drobilla.net>
#
# Unlike many LP tools, this tool uses normal source code as input, there is no
# tangle/weave and no special file format.  The literate parts of the program
# are written in comments, which are emitted as paragraphs of regular text
# interleaved with code.  Asciidoc is both the comment and output syntax.

import os
import re
import sys

def format_text(text):
    'Format a text (comment) fragment and return it as a marked up string'
    return '\n\n' + re.sub('\n *', '\n', text.strip()) + '\n\n'

def format_code(lang, code):
    if code.strip() == '':
        return code

    head = '[source,%s]' % lang
    sep  = '-' * len(head) + '\n'
    return head + '\n' + sep + code.strip('\n') + '\n' + sep

def format_c_source(filename, file):
    output           = '=== %s ===\n' % os.path.basename(filename)
    chunk            = ''
    prev_c           = 0
    in_comment       = False
    in_comment_start = False
    n_stars          = 0
    code             = ''
    for line in file:
        code += line

    # Skip initial license comment
    if code[0:2] == '/*':
        code = code[code.find('*/') + 2:]

    for c in code:
        if prev_c == '/' and c == '*':
            in_comment_start = True
            n_stars = 1
        elif in_comment_start:
            if c == '*':
                n_stars += 1
            else:
                if n_stars > 1:
                    output += format_code('c', chunk[0:len(chunk) - 1])
                    chunk = ''
                    in_comment = True
                else:
                    chunk += '*' + c
                in_comment_start = False
        elif in_comment and prev_c == '*' and c == '/':
            if n_stars > 1:
                output += format_text(chunk[0:len(chunk) - 1])
            else:
                output += format_code('c', '/* ' + chunk[0:len(chunk) - 1] + '*/')
            in_comment = False
            in_comment_start = False
            chunk = ''
        elif in_comment_start and c == '*':
            n_stars += 1
        else:
            chunk += c
        prev_c = c

    return output + format_code('c', chunk)

def format_ttl_source(filename, file):
    output           = '=== %s ===\n' % os.path.basename(filename)

    in_comment = False
    chunk      = ''
    for line in file:
        is_comment = line.strip().startswith('#')
        if in_comment:
            if is_comment:
                chunk += line.strip().lstrip('# ') + ' \n'
            else:
                output += format_text(chunk)
                in_comment = False
                chunk = line
        else:
            if is_comment:
                output += format_code('n3', chunk)
                in_comment = True
                chunk = line.strip().lstrip('# ') + ' \n'
            else:
                chunk += line

    if in_comment:
        return output + format_text(chunk)
    else:
        return output + format_code('n3', chunk)

def gen(out, filenames):
    for filename in filenames:
        file = open(filename)
        if not file:
            sys.stderr.write('Failed to open file %s\n' % filename)
            continue

        if filename.endswith('.c') or filename.endswith('.h'):
            out.write(format_c_source(filename, file))
        elif filename.endswith('.ttl') or filename.endswith('.ttl.in'):
            out.write(format_ttl_source(filename, file))
        elif filename.endswith('.txt'):
            for line in file:
                out.write(line)
            out.write('\n')
        else:
            sys.stderr.write("Unknown source format `%s'" % (
                filename[filename.find('.'):]))

        file.close()

if __name__ == "__main__":
    if len(sys.argv) < 2:
        sys.stderr.write('Usage: %s FILENAME...\n' % sys.argv[1])
        sys.exit(1)

    gen(sys.argv[1:])