Date: Wed, 13 Jun 2007 10:20:42 +0000 Subject: Added links to the README file. self-documenting feature: literal code with syntax highlight Moved the front-end to the base dir. This way it works without installing. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5234 929543f6-e4f2-0310-98a6-ba3bd3dd1d04 --- .../docs/pygments_code_block_directive.py.html | 232 ++++++++++++++++----- 1 file changed, 179 insertions(+), 53 deletions(-) (limited to 'sandbox/code-block-directive/docs/pygments_code_block_directive.py.html') diff --git a/sandbox/code-block-directive/docs/pygments_code_block_directive.py.html b/sandbox/code-block-directive/docs/pygments_code_block_directive.py.html index 15af90a8c..ba7364dbe 100644 --- a/sandbox/code-block-directive/docs/pygments_code_block_directive.py.html +++ b/sandbox/code-block-directive/docs/pygments_code_block_directive.py.html @@ -6,9 +6,9 @@ - + - +

@@ -19,7 +19,7 @@ Author: a Pygments author|contributor; Felix Wiemann; Guenter Milde Date: -$Date$ +2007-06-08 Copyright: This module has been placed in the public domain. @@ -45,92 +45,218 @@ documentation, and a +

System Message: ERROR/3 (/usr/src/docutils-svn/sandbox/code-block-directive/pygments_code_block_directive.py.txt, line 23)

Unknown directive type "code-block".

-"""Define and register a code-block directive using pygments
-"""
+.. code-block::
+
+  """Define and register a code-block directive using pygments
+  """
+

Requirements

System Message: ERROR/3 (/usr/src/docutils-svn/sandbox/code-block-directive/pygments_code_block_directive.py.txt, line 31)

Unknown directive type "code-block".

-from docutils import nodes
-from docutils.parsers.rst import directives
-import pygments
-from pygments.lexers import get_lexer_by_name
-from pygments_docutils_formatter import DocutilsFormatter
+.. code-block::
+
+  from docutils import nodes
+  from docutils.parsers.rst import directives
+  try:
+      import pygments
+      from pygments.lexers import get_lexer_by_name
+      from pygments.formatters.html import _get_ttype_class
+  except ImportError:
+      pass
+
+
+

Customisation

Do not insert inline nodes for the following tokens. (You could add e.g. Token.Punctuation like ['', 'p'].)

System Message: ERROR/3 (/usr/src/docutils-svn/sandbox/code-block-directive/pygments_code_block_directive.py.txt, line 50)

Unknown directive type "code-block".

-unstyled_tokens = ['']
+.. code-block::
+
+  unstyled_tokens = ['']
+

DocutilsInterface

This interface class combines code from +pygments.formatters.html and pygments.formatters.others.

It does not require anything of docutils and could also become a part of +pygments

System Message: ERROR/3 (/usr/src/docutils-svn/sandbox/code-block-directive/pygments_code_block_directive.py.txt, line 63)

Unknown directive type "code-block".

+.. code-block::
+
+  class DocutilsInterface(object):
+      """Parse `code` string and yield "classified" tokens.
+
+      Arguments
+
+        code     -- string of source code to parse
+        language -- formal language the code is written in.
+
+      Merge subsequent tokens of the same token-type.
+
+      Yields the tokens as ``(ttype_class, value)`` tuples,
+      where ttype_class is taken from pygments.token.STANDARD_TYPES and
+      corresponds to the class argument used in pygments html output.
+
+      """
+
+      def __init__(self, code, language):
+          self.code = code
+          self.language = language
+
+      def lex(self):
+          # Get lexer for language (use text as fallback)
+          try:
+              lexer = get_lexer_by_name(self.language)
+          except ValueError:
+              # info: "no pygments lexer for %s, using 'text'"%self.language
+              lexer = get_lexer_by_name('text')
+          return pygments.lex(self.code, lexer)
+
+
+      def join(self, tokens):
+          """join subsequent tokens of same token-type
+          """
+          tokens = iter(tokens)
+          (lasttype, lastval) = tokens.next()
+          for ttype, value in tokens:
+              if ttype is lasttype:
+                  lastval += value
+              else:
+                  yield(lasttype, lastval)
+                  (lasttype, lastval) = (ttype, value)
+          yield(lasttype, lastval)
+
+      def __iter__(self):
+          """parse code string and yield "clasified" tokens
+          """
+          try:
+              tokens = self.lex()
+          except IOError:
+              print "INFO: Pygments lexer not found, using fallback"
+              # TODO: write message to INFO
+              yield ('', self.code)
+              return
+
+          for ttype, value in self.join(tokens):
+              yield (_get_ttype_class(ttype), value)
+
+
+
+

code_block_directive

System Message: ERROR/3 (/usr/src/docutils-svn/sandbox/code-block-directive/pygments_code_block_directive.py.txt, line 127)

Unknown directive type "code-block".

-def code_block_directive(name, arguments, options, content, lineno,
-                       content_offset, block_text, state, state_machine):
-    language = arguments[0]
-    # create a literal block element and set class argument
-    code_block = nodes.literal_block(raw_content=content,
-                                     classes=["code-block", language])
-    # Get lexer for language (use text as fallback)
-    try:
-        lexer = get_lexer_by_name(language)
-    except ValueError:
-        lexer = get_lexer_by_name('text')
-
-    # parse content with pygments
-    tokens = list(pygments.lex(u'\n'.join(content), lexer))
-
-    for cls, value in DocutilsFormatter(tokens):
-        if cls in unstyled_tokens:
-            # insert as Text to decrease the verbosity of the output.
-            code_block += nodes.Text(value, value)
-        else:
-            code_block += nodes.inline(value, value, classes=[cls])
-
-    return [code_block]
+.. code-block::
+
+  def code_block_directive(name, arguments, options, content, lineno,
+                         content_offset, block_text, state, state_machine):
+      """parse and classify content of a code_block
+      """
+      language = arguments[0]
+      # create a literal block element and set class argument
+      code_block = nodes.literal_block(classes=["code-block", language])
+
+      # parse content with pygments and add to code_block element
+      for cls, value in DocutilsInterface(u'\n'.join(content), language):
+          if cls in unstyled_tokens:
+              # insert as Text to decrease the verbosity of the output.
+              code_block += nodes.Text(value, value)
+          else:
+              code_block += nodes.inline(value, value, classes=[cls])
+
+      return [code_block]
+
+

Register Directive

System Message: ERROR/3 (/usr/src/docutils-svn/sandbox/code-block-directive/pygments_code_block_directive.py.txt, line 151)

Unknown directive type "code-block".

-code_block_directive.arguments = (1, 0, 1)
-code_block_directive.content = 1
-directives.register_directive('code-block', code_block_directive)
+.. code-block::
+
+  code_block_directive.arguments = (1, 0, 1)
+  code_block_directive.content = 1
+  directives.register_directive('code-block', code_block_directive)
+

Test output

If called from the command line, call the docutils publisher to render the -input:

+input

System Message: ERROR/3 (/usr/src/docutils-svn/sandbox/code-block-directive/pygments_code_block_directive.py.txt, line 169)

Unknown directive type "code-block".

-if __name__ == '__main__':
-    from docutils.core import publish_cmdline, default_description
-    description = "code-block directive test output" + default_description
-    try:
-        import locale
-        locale.setlocale(locale.LC_ALL, '')
-    except:
-        pass
-    # Uncomment the desired output format:
-    publish_cmdline(writer_name='pseudoxml', description=description)
-    # publish_cmdline(writer_name='xml', description=description)
-    # publish_cmdline(writer_name='html', description=description)
-    # publish_cmdline(writer_name='latex', description=description)
-    # publish_cmdline(writer_name='newlatex2e', description=description)
+.. code-block::
+
+  if __name__ == '__main__':
+      from docutils.core import publish_cmdline, default_description
+      description = "code-block directive test output" + default_description
+      try:
+          import locale
+          locale.setlocale(locale.LC_ALL, '')
+      except:
+          pass
+      # Uncomment the desired output format:
+      publish_cmdline(writer_name='pseudoxml', description=description)
+      # publish_cmdline(writer_name='xml', description=description)
+      # publish_cmdline(writer_name='html', description=description)
+      # publish_cmdline(writer_name='latex', description=description)
+      # publish_cmdline(writer_name='newlatex2e', description=description)
+
+
+

+ -- cgit v1.2.1