Source

wxPython / wx / tools / Editra / scripts / gen_stc_doc.py

Full commit
#!/usr/bin/env python
###############################################################################
# Name: gen_lexer_doc.py                                                      #
# Purpose: Generate html for lexer docuemntation                              #
# Author: Cody Precord <cprecord@editra.org>                                  #
# Copyright: (c) 2009 Cody Precord <staff@editra.org>                         #
# License: wxWindows License                                                  #
###############################################################################

"""
Lexer Documentation Generator

Generates html documentation for the STC lexers and style flags.

"""

__author__ = "Cody Precord <cprecord@editra.org>"
__svnid__ = "$Id: gen_stc_doc.py 63082 2010-01-05 21:17:26Z CJP $"
__revision__ = "$Revision: 63082 $"

#-----------------------------------------------------------------------------#
# Imports
import sys
import wx
import wx.stc as stc

#-----------------------------------------------------------------------------#

# Special case lexer to syntax spec mappings
LEXMAP = { 'BASH'     : ['SH',],
           'BATCH'    : ['BAT',],
           'CPP'      : ['C',],
           'F77'      : ['F',],
           'FLAGSHIP' : ['FS',],
           'FORTRAN'  : ['F',],
           'GUI4CLI'  : ['GC',],
           'HASKELL'  : ['HA',],
           'HTML'     : ['H', 'HJ', 'HJA', 'HBA'],
           'INNOSETUP': ['INNO',],
           'LATEX'    : ['TEX',],
           'MAKEFILE' : ['MAKE',],
           'OCTAVE'   : ['MATLAB',],
           'PASCAL'   : ['C',],
           'PERL'     : ['PL',],
           'PROPERTIES' : ['PROPS',],
           'PYTHON'   : ['P',],
           'RUBY'     : ['RB',],
           'SMALLTALK': ['ST',],
           'VB'       : ['B',],
           'VBSCRIPT' : ['B',],
           'VERILOG'  : ['V',],
           'XML'      : ['H',],
          }

#-----------------------------------------------------------------------------#
# HTML objects

class Title(object):
    """Represents a title tag"""
    def __init__(self, title, mode):
        assert isinstance(title, basestring)
        object.__init__(self)

        # Attributes
        self.mode = mode
        self._title = title

    def __str__(self):
        if self.mode == 'html':
            val = "<h3 id=\"%s\">%s:</h3>\n" % (self._title, self._title)
        elif self.mode == 'moin':
            val = "<<Anchor(%s)>>\n== %s ==\n" % (self._title, self._title)
        return val

class LexerLabel(object):
    """Represents a lexer id label"""
    def __init__(self, lexer, mode):
        assert isinstance(lexer, basestring)
        object.__init__(self)

        # Attributes
        self.mode = mode
        self._lexer = lexer

    def __str__(self):
        if self.mode == 'html':
            val = "<h4>Lexer Id: <em>%s</em></h4>\n" % self._lexer
        else:
            val = "==== Lexer Id: %s ====\n" % self._lexer
        return val

class UnorderedList(object):
    """Represents a <ul> </ul> list"""
    def __init__(self, items, mode):
        assert isinstance(items, list)
        object.__init__(self)

        # Attributes
        self.mode = mode
        self._items = items

    def __str__(self):
        if self.mode == 'html':
            val = "<ul>\n%s\n</ul>" % self.FormatItems()
        elif self.mode == 'moin':
            val = "%s" % self.FormatItems()
        return val

    def FormatItems(self):
        """Format the item list
        @return: string

        """
        if self.mode == 'html':
            tmpl = "<li>%s</li>\n"
        else:
            tmpl = " * %s\n"
        rval = ""
        for item in self._items:
            rval += tmpl % item
        return rval

class Index(object):
    """Represents the link index"""
    def __init__(self, langs, mode):
        """@param langs: list of languages"""
        object.__init__(self)

        # Attrbutes
        self.mode = mode
        self._langs = langs

    def __str__(self):
        """Create the html table"""
        if self.mode == 'html':
            tmpl = "<table cellpadding=\"3px\" cellspacing=\"0\" border=\"0\" width=\"100%%\">"
            tmpl += "<tr valign=\"top\">"
            tmpl += "<td>%s</td><td>%s</td><td>%s</td>\n"
            tmpl += "</tr>\n</table>\n<hr/>\n"
        elif self.mode == 'moin':
            return "<<TableOfContents(2)>>\n"
        div = len(self._langs) / 3
        items1 = self.makeLinks(self._langs[:div])
        items2 = self.makeLinks(self._langs[div:div+div])
        items3 = self.makeLinks(self._langs[-1*div:])
        return tmpl % (UnorderedList(items1, mode),
                       UnorderedList(items2, mode),
                       UnorderedList(items3, mode))

    def makeLinks(self, items):
        """Make a list of anchor links
        @param items: list of strings
        @return: list of string

        """
        rval = list()
        if self.mode == 'html':
            rval = ["<a href=\"#%s\">%s</a>" % (item, item) for item in items]
        elif self.mode == 'moin':
            rval = ["[[#%s|%s]]" % (item, item) for item in items]
        return rval

class Intro(object):
    def __init__(self, mode):
        object.__init__(self)

        # Attributes
        self.mode = mode

    def __str__(self):
        rval = ''
        if self.mode == 'html':
            rval = "<h1>StyledTextCtrl Quick Reference</h1>"
            rval += "\n<hr/>\n"
        elif self.mode == 'moin':
            rval = "= StyledTextCtrl Quick Reference =\n----\n"
        return rval

class SubSection(object):
    """Represents a subsection for a given language type"""
    def __init__(self, lang, lex, mode):
        assert isinstance(lang, basestring)
        object.__init__(self)

        # Attributes
        self.mode = mode
        self.langid = lang.upper()
        self.title = Title(lang.title(), mode)
        self.lexer = LexerLabel(lex, mode)

    def __str__(self):
        if self.mode == 'html':
            tmpl = "%s%s%s\n<hr/>"
        elif self.mode == 'moin':
            tmpl = "%s%s%s\n----\n"
        styles = self.GetStyleList()
        return tmpl % (self.title, self.lexer, styles)

    def GetStyleList(self):
        """Get the list of styles available for this subsections language
        @return: UnorderedList

        """
        langids = LEXMAP.get(self.langid, [self.langid,])
        slist = list()
        for langid in langids:
            sid = "STC_%s_" % langid
            for item in dir(stc):
                if item.startswith(sid):
                    slist.append(item)
        slist.sort()
        return UnorderedList(slist, self.mode)

#-----------------------------------------------------------------------------#

def collectLexers():
    """Get all the lexer identifiers
    @return: list of strings

    """
    rlist = list()
    for item in dir(stc):
        if item.startswith('STC_LEX_'):
            rlist.append(item)
    rlist.sort()
    return rlist

def deriveLanguageNames(lexlist):
    """Derive the language names from the lexer identifier list
    @return: list of strings

    """
    rlist = list()
    for item in lexlist:
        lang = item.rsplit('_', 1)[-1]
        rlist.append(lang)
    return rlist

#-----------------------------------------------------------------------------#

def generateOutput(mode):
    """Generates the html output
    @return: list of html objects

    """
    lexers = collectLexers()
    langs = deriveLanguageNames(lexers)
    lang2lex = zip(langs, lexers)
    output = [Intro(mode), Index([lang.title() for lang in langs], mode),]
    for lang, lex in lang2lex:
        sub = SubSection(lang, lex, mode)
        output.append(sub)

    f = open('stcdoc.%s' % mode, 'wb')
    for obj in output:
        f.write(str(obj))
    f.close()

#-----------------------------------------------------------------------------#

if __name__ == '__main__':
    mode = 'html' # default to html
    if len(sys.argv) > 1:
        if sys.argv[1] == 'moin':
            mode = 'moin'
    generateOutput(mode)