aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/literasc.py
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2012-12-31 23:10:27 +0000
committerDavid Robillard <d@drobilla.net>2012-12-31 23:10:27 +0000
commit4a603a28de272c818100185ffbc8693585d7be9f (patch)
treebf8cbadb49bfefd61776185a3e20b192c2a0c64a /plugins/literasc.py
parentb09f94596a7361f01b835d811e14269ecec5272a (diff)
downloadlv2-4a603a28de272c818100185ffbc8693585d7be9f.tar.xz
Generate book from example plugin source.
Diffstat (limited to 'plugins/literasc.py')
-rwxr-xr-xplugins/literasc.py113
1 files changed, 113 insertions, 0 deletions
diff --git a/plugins/literasc.py b/plugins/literasc.py
new file mode 100755
index 0000000..b7b65cd
--- /dev/null
+++ b/plugins/literasc.py
@@ -0,0 +1,113 @@
+#!/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
+
+ for c in code:
+ if prev_c == '/' and c == '*':
+ output += format_code('c', chunk[0:len(chunk)-1])
+ in_comment = True
+ in_comment_start = True
+ n_stars = 1
+ chunk = ''
+ elif in_comment and prev_c == '*' and c == '/':
+ if n_stars > 2:
+ output += format_text(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('txt', 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('txt', 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'):
+ 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:])