pygments.rb 1.2.1 → 2.0.0

data/vendor/pygments-main/doc/docs/formatterdevelopment.rst

@@ -1,169 +0,0 @@
-.. -*- mode: rst -*-
-
-========================
-Write your own formatter
-========================
-
-As well as creating :doc:`your own lexer <lexerdevelopment>`, writing a new
-formatter for Pygments is easy and straightforward.
-
-A formatter is a class that is initialized with some keyword arguments (the
-formatter options) and that must provides a `format()` method.
-Additionally a formatter should provide a `get_style_defs()` method that
-returns the style definitions from the style in a form usable for the
-formatter's output format.
-
-
-Quickstart
-==========
-
-The most basic formatter shipped with Pygments is the `NullFormatter`. It just
-sends the value of a token to the output stream:
-
-.. sourcecode:: python
-
-    from pygments.formatter import Formatter
-
-    class NullFormatter(Formatter):
-        def format(self, tokensource, outfile):
-            for ttype, value in tokensource:
-                outfile.write(value)
-
-As you can see, the `format()` method is passed two parameters: `tokensource`
-and `outfile`. The first is an iterable of ``(token_type, value)`` tuples,
-the latter a file like object with a `write()` method.
-
-Because the formatter is that basic it doesn't overwrite the `get_style_defs()`
-method.
-
-
-Styles
-======
-
-Styles aren't instantiated but their metaclass provides some class functions
-so that you can access the style definitions easily.
-
-Styles are iterable and yield tuples in the form ``(ttype, d)`` where `ttype`
-is a token and `d` is a dict with the following keys:
-
-``'color'``
-    Hexadecimal color value (eg: ``'ff0000'`` for red) or `None` if not
-    defined.
-
-``'bold'``
-    `True` if the value should be bold
-
-``'italic'``
-    `True` if the value should be italic
-
-``'underline'``
-    `True` if the value should be underlined
-
-``'bgcolor'``
-    Hexadecimal color value for the background (eg: ``'eeeeeee'`` for light
-    gray) or `None` if not defined.
-
-``'border'``
-    Hexadecimal color value for the border (eg: ``'0000aa'`` for a dark
-    blue) or `None` for no border.
-
-Additional keys might appear in the future, formatters should ignore all keys
-they don't support.
-
-
-HTML 3.2 Formatter
-==================
-
-For an more complex example, let's implement a HTML 3.2 Formatter. We don't
-use CSS but inline markup (``<u>``, ``<font>``, etc). Because this isn't good
-style this formatter isn't in the standard library ;-)
-
-.. sourcecode:: python
-
-    from pygments.formatter import Formatter
-
-    class OldHtmlFormatter(Formatter):
-
-        def __init__(self, **options):
-            Formatter.__init__(self, **options)
-
-            # create a dict of (start, end) tuples that wrap the
-            # value of a token so that we can use it in the format
-            # method later
-            self.styles = {}
-
-            # we iterate over the `_styles` attribute of a style item
-            # that contains the parsed style values.
-            for token, style in self.style:
-                start = end = ''
-                # a style item is a tuple in the following form:
-                # colors are readily specified in hex: 'RRGGBB'
-                if style['color']:
-                    start += '<font color="#%s">' % style['color']
-                    end = '</font>' + end
-                if style['bold']:
-                    start += '<b>'
-                    end = '</b>' + end
-                if style['italic']:
-                    start += '<i>'
-                    end = '</i>' + end
-                if style['underline']:
-                    start += '<u>'
-                    end = '</u>' + end
-                self.styles[token] = (start, end)
-
-        def format(self, tokensource, outfile):
-            # lastval is a string we use for caching
-            # because it's possible that an lexer yields a number
-            # of consecutive tokens with the same token type.
-            # to minimize the size of the generated html markup we
-            # try to join the values of same-type tokens here
-            lastval = ''
-            lasttype = None
-
-            # wrap the whole output with <pre>
-            outfile.write('<pre>')
-
-            for ttype, value in tokensource:
-                # if the token type doesn't exist in the stylemap
-                # we try it with the parent of the token type
-                # eg: parent of Token.Literal.String.Double is
-                # Token.Literal.String
-                while ttype not in self.styles:
-                    ttype = ttype.parent
-                if ttype == lasttype:
-                    # the current token type is the same of the last
-                    # iteration. cache it
-                    lastval += value
-                else:
-                    # not the same token as last iteration, but we
-                    # have some data in the buffer. wrap it with the
-                    # defined style and write it to the output file
-                    if lastval:
-                        stylebegin, styleend = self.styles[lasttype]
-                        outfile.write(stylebegin + lastval + styleend)
-                    # set lastval/lasttype to current values
-                    lastval = value
-                    lasttype = ttype
-
-            # if something is left in the buffer, write it to the
-            # output file, then close the opened <pre> tag
-            if lastval:
-                stylebegin, styleend = self.styles[lasttype]
-                outfile.write(stylebegin + lastval + styleend)
-            outfile.write('</pre>\n')
-
-The comments should explain it. Again, this formatter doesn't override the
-`get_style_defs()` method. If we would have used CSS classes instead of
-inline HTML markup, we would need to generate the CSS first. For that
-purpose the `get_style_defs()` method exists:
-
-
-Generating Style Definitions
-============================
-
-Some formatters like the `LatexFormatter` and the `HtmlFormatter` don't
-output inline markup but reference either macros or css classes. Because
-the definitions of those are not part of the output, the `get_style_defs()`
-method exists. It is passed one parameter (if it's used and how it's used
-is up to the formatter) and has to return a string or ``None``.

data/vendor/pygments-main/doc/docs/formatters.rst

@@ -1,48 +0,0 @@
-.. -*- mode: rst -*-
-
-====================
-Available formatters
-====================
-
-This page lists all builtin formatters.
-
-Common options
-==============
-
-All formatters support these options:
-
-`encoding`
-    If given, must be an encoding name (such as ``"utf-8"``). This will
-    be used to convert the token strings (which are Unicode strings)
-    to byte strings in the output (default: ``None``).
-    It will also be written in an encoding declaration suitable for the
-    document format if the `full` option is given (e.g. a ``meta
-    content-type`` directive in HTML or an invocation of the `inputenc`
-    package in LaTeX).
-
-    If this is ``""`` or ``None``, Unicode strings will be written
-    to the output file, which most file-like objects do not support.
-    For example, `pygments.highlight()` will return a Unicode string if
-    called with no `outfile` argument and a formatter that has `encoding`
-    set to ``None`` because it uses a `StringIO.StringIO` object that
-    supports Unicode arguments to `write()`. Using a regular file object
-    wouldn't work.
-
-    .. versionadded:: 0.6
-
-`outencoding`
-    When using Pygments from the command line, any `encoding` option given is
-    passed to the lexer and the formatter. This is sometimes not desirable,
-    for example if you want to set the input encoding to ``"guess"``.
-    Therefore, `outencoding` has been introduced which overrides `encoding`
-    for the formatter if given.
-
-    .. versionadded:: 0.7
-
-
-Formatter classes
-=================
-
-All these classes are importable from :mod:`pygments.formatters`.
-
-.. pygmentsdoc:: formatters

data/vendor/pygments-main/doc/docs/index.rst

@@ -1,66 +0,0 @@
-Pygments documentation
-======================
-
-**Starting with Pygments**
-
-.. toctree::
-   :maxdepth: 1
-
-   ../download
-   quickstart
-   cmdline
-
-**Builtin components**
-
-.. toctree::
-   :maxdepth: 1
-
-   lexers
-   filters
-   formatters
-   styles
-
-**Reference**
-
-.. toctree::
-   :maxdepth: 1
-
-   unicode
-   tokens
-   api
-
-**Hacking for Pygments**
-
-.. toctree::
-   :maxdepth: 1
-
-   lexerdevelopment
-   formatterdevelopment
-   filterdevelopment
-   plugins
-
-**Hints and tricks**
-
-.. toctree::
-   :maxdepth: 1
-
-   rstdirective
-   moinmoin
-   java
-   integrate
-
-**About Pygments**
-              
-.. toctree::
-   :maxdepth: 1
-
-   changelog
-   authors
-
-
-If you find bugs or have suggestions for the documentation, please look
-:ref:`here <contribute>` for info on how to contact the team.
-
-.. XXX You can download an offline version of this documentation from the
-   :doc:`download page </download>`.
-

data/vendor/pygments-main/doc/docs/integrate.rst

@@ -1,40 +0,0 @@
-.. -*- mode: rst -*-
-
-===================================
-Using Pygments in various scenarios
-===================================
-
-Markdown
---------
-
-Since Pygments 0.9, the distribution ships Markdown_ preprocessor sample code
-that uses Pygments to render source code in
-:file:`external/markdown-processor.py`.  You can copy and adapt it to your
-liking.
-
-.. _Markdown: http://www.freewisdom.org/projects/python-markdown/
-
-TextMate
---------
-
-Antonio Cangiano has created a Pygments bundle for TextMate that allows to
-colorize code via a simple menu option.  It can be found here_.
-
-.. _here: http://antoniocangiano.com/2008/10/28/pygments-textmate-bundle/
-
-Bash completion
----------------
-
-The source distribution contains a file ``external/pygments.bashcomp`` that
-sets up completion for the ``pygmentize`` command in bash.
-
-Wrappers for other languages
-----------------------------
-
-These libraries provide Pygments highlighting for users of other languages
-than Python:
-
-* `pygments.rb <https://github.com/tmm1/pygments.rb>`_, a pygments wrapper for Ruby
-* `Clygments <https://github.com/bfontaine/clygments>`_, a pygments wrapper for
-  Clojure
-* `PHPygments <https://github.com/capynet/PHPygments>`_, a pygments wrapper for PHP

data/vendor/pygments-main/doc/docs/java.rst

@@ -1,70 +0,0 @@
-=====================
-Use Pygments in Java
-=====================
-
-Thanks to `Jython <http://www.jython.org>`_ it is possible to use Pygments in
-Java.
-
-This page is a simple tutorial to get an idea of how this works. You can
-then look at the `Jython documentation <http://www.jython.org/docs/>`_ for more
-advanced uses.
-
-Since version 1.5, Pygments is deployed on `Maven Central
-<http://repo1.maven.org/maven2/org/pygments/pygments/>`_ as a JAR, as is Jython
-which makes it a lot easier to create a Java project.
-
-Here is an example of a `Maven <http://www.maven.org>`_ ``pom.xml`` file for a
-project running Pygments:
-
-.. sourcecode:: xml
-
-    <?xml version="1.0" encoding="UTF-8"?>
-
-    <project xmlns="http://maven.apache.org/POM/4.0.0"
-             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
-                                 http://maven.apache.org/maven-v4_0_0.xsd">
-      <modelVersion>4.0.0</modelVersion>
-      <groupId>example</groupId>
-      <artifactId>example</artifactId>
-      <version>1.0-SNAPSHOT</version>
-      <dependencies>
-        <dependency>
-          <groupId>org.python</groupId>
-          <artifactId>jython-standalone</artifactId>
-          <version>2.5.3</version>
-        </dependency>
-        <dependency>
-          <groupId>org.pygments</groupId>
-          <artifactId>pygments</artifactId>
-          <version>1.5</version>
-          <scope>runtime</scope>
-        </dependency>
-      </dependencies>
-    </project>
-
-The following Java example:
-
-.. sourcecode:: java
-
-    PythonInterpreter interpreter = new PythonInterpreter();
-
-    // Set a variable with the content you want to work with
-    interpreter.set("code", code);
-
-    // Simple use Pygments as you would in Python
-    interpreter.exec("from pygments import highlight\n"
-        + "from pygments.lexers import PythonLexer\n"
-        + "from pygments.formatters import HtmlFormatter\n"
-        + "\nresult = highlight(code, PythonLexer(), HtmlFormatter())");
-
-    // Get the result that has been set in a variable
-    System.out.println(interpreter.get("result", String.class));
-
-will print something like:
-
-.. sourcecode:: html
-
-    <div class="highlight">
-    <pre><span class="k">print</span> <span class="s">&quot;Hello World&quot;</span></pre>
-    </div>