source: specdomain/trunk/src/specdomain/sphinxcontrib/specdomain.py @ 988

Last change on this file since 988 was 988, checked in by jemian, 10 years ago

refs #8, add variables to the index in two ways, add mac declarations to index in two ways

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 13.6 KB
Line 
1# -*- coding: utf-8 -*-
2"""
3    sphinxcontrib.specdomain
4    ~~~~~~~~~~~~~~~~~~~~~~~~~~
5
6    :synopsis: SPEC domain for Sphinx
7   
8    Automatically insert ReST-formatted extended comments
9    from SPEC files for macro definitions and variable declarations into
10    the Sphinx doctree, thus avoiding duplication between docstrings and documentation
11    for those who like elaborate docstrings.
12
13    :copyright: Copyright 2012 by BCDA, Advanced Photon Source, Argonne National Laboratory
14    :license: ANL Open Source License, see LICENSE for details.
15"""
16
17# http://sphinx.pocoo.org/ext/appapi.html
18
19import os
20import re
21import string                                           #@UnusedImport
22import sys                                              #@UnusedImport
23
24from docutils import nodes                              #@UnusedImport
25from docutils.parsers.rst import directives             #@UnusedImport
26
27from sphinx import addnodes
28from sphinx.roles import XRefRole
29from sphinx.locale import l_, _                         #@UnusedImport
30from sphinx.directives import ObjectDescription
31from sphinx.domains import Domain, ObjType, Index       #@UnusedImport
32from sphinx.util.compat import Directive                #@UnusedImport
33from sphinx.util.nodes import make_refnode, nested_parse_with_titles    #@UnusedImport
34from sphinx.util.docfields import Field, TypedField
35from sphinx.util.docstrings import prepare_docstring    #@UnusedImport
36
37#from docutils.statemachine import ViewList, string2lines
38#import sphinx.util.nodes
39from sphinx.ext.autodoc import Documenter, bool_option
40#from sphinx.util.inspect import getargspec, isdescriptor, safe_getmembers, \
41#     safe_getattr, safe_repr
42#from sphinx.util.pycompat import base_exception, class_types
43from specmacrofileparser import SpecMacrofileParser
44from docutils.statemachine import ViewList    #@UnusedImport
45
46
47# TODO: merge these with specmacrofileparser.py
48match_all                   = r'.*'
49non_greedy_filler           = match_all + r'?'
50double_quote_string_match   = r'("' + non_greedy_filler + r'")'
51word_match                  = r'((?:[a-z_]\w*))'
52cdef_match                  = r'(cdef)'
53
54
55spec_macro_sig_re = re.compile(
56                               r'''^ ([a-zA-Z_]\w*)         # macro name
57                               ''', re.VERBOSE)
58
59spec_func_sig_re = re.compile(word_match + r'\('
60                      + r'(' + match_all + r')' 
61                      + r'\)', 
62                      re.IGNORECASE|re.DOTALL)
63
64spec_cdef_name_sig_re = re.compile(double_quote_string_match, 
65                                   re.IGNORECASE|re.DOTALL)
66
67
68class SpecMacroDocumenter(Documenter):
69    """
70    Document a SPEC macro source code file (autodoc.Documenter subclass)
71   
72    This code responds to the ReST file directive::
73   
74        .. autospecmacro:: partial/path/name/somefile.mac
75            :displayorder: fileorder
76   
77    The ``:displayorder`` parameter indicates how the
78    contents will be sorted for appearance in the ReST document.
79   
80        **fileorder** or **file**
81            Items will be documented in the order in
82            which they appear in the ``.mac`` file.
83       
84        **alphabetical** or **alpha**
85            Items will be documented in alphabetical order.
86   
87    .. tip::
88        A (near) future enhancement will provide for
89        documenting all macro files in a directory, with optional
90        recursion into subdirectories.  By default, the code will
91        only document files that match the glob pattern ``*.mac``.
92        (This could be defined as a list in the ``conf.py`` file.)
93        Such as::
94       
95           .. spec:directory:: partial/path/name
96              :recursion:
97              :displayorder: alphabetical
98    """
99
100    objtype = 'specmacro'
101    member_order = 50
102    priority = 0
103    #: true if the generated content may contain titles
104    titles_allowed = True
105
106    option_spec = {
107        'displayorder': bool_option,
108    }
109
110    @classmethod
111    def can_document_member(cls, member, membername, isattr, parent):
112        # don't document submodules automatically
113        #return isinstance(member, (FunctionType, BuiltinFunctionType))
114        r = membername in ('SpecMacroDocumenter', )
115        return r
116   
117    def generate(self, *args, **kw):
118        """
119        Generate reST for the object given by *self.name*, and possibly for
120        its members.
121        """
122        # now, parse the SPEC macro file
123        macrofile = self.parse_name()
124        spec = SpecMacrofileParser(macrofile)
125        extended_comment = spec.ReST()
126        rest = prepare_docstring(extended_comment)
127
128        #self.add_line(u'', '<autodoc>')
129        #sig = self.format_signature()
130        #self.add_directive_header(sig)
131       
132        # TODO: provide links from each to highlighted source code blocks (like Python documenters).
133        # This works for now.
134        self.add_line(u'', '<autodoc>')
135        self.add_line(u'.. index:: SPEC macro file; %s' % macrofile, '<autodoc>')
136        self.add_line(u'.. index:: !%s' % os.path.split(macrofile)[1], '<autodoc>')
137        self.add_line(u'', '<autodoc>')
138        line = 'source code:  :download:`%s <%s>`' % (macrofile, macrofile)
139        self.add_line(line, macrofile)
140
141        self.add_line(u'', '<autodoc>')
142        for linenumber, line in enumerate(rest):
143            self.add_line(line, macrofile, linenumber)
144
145        #self.add_content(rest)
146        #self.document_members(all_members)
147
148    def resolve_name(self, modname, parents, path, base):
149        if modname is not None:
150            self.directive.warn('"::" in autospecmacro name doesn\'t make sense')
151        return (path or '') + base, []
152
153    def parse_name(self):
154        """Determine what file to parse.
155       
156        :returns: True if if parsing was successful
157        """
158        ret = self.name
159        self.fullname = os.path.abspath(ret)
160        self.objpath, self.modname = os.path.split(self.fullname)
161        self.args = None
162        self.retann = None
163        if self.args or self.retann:
164            self.directive.warn('signature arguments or return annotation '
165                                'given for autospecmacro %s' % self.fullname)
166        return ret
167
168
169class SpecMacroObject(ObjectDescription):
170    """
171    Description of a SPEC macro definition
172    """
173
174    doc_field_types = [
175        TypedField('parameter', label=l_('Parameters'),
176                   names=('param', 'parameter', 'arg', 'argument',
177                          'keyword', 'kwarg', 'kwparam'),
178                   typerolename='def', typenames=('paramtype', 'type'),
179                   can_collapse=True),
180        Field('returnvalue', label=l_('Returns'), has_arg=False,
181              names=('returns', 'return')),
182        Field('returntype', label=l_('Return type'), has_arg=False,
183              names=('rtype',)),
184    ]
185
186    def add_target_and_index(self, name, sig, signode):
187        targetname = '%s-%s' % (self.objtype, name)
188        signode['ids'].append(targetname)
189        self.state.document.note_explicit_target(signode)
190        indextext = self._get_index_text(name)
191        if indextext:
192            self.indexnode['entries'].append(('single', indextext,
193                                              targetname, ''))
194
195    def _get_index_text(self, name):
196        macro_types = {
197            'def':  'SPEC macro definition; %s',
198            'rdef': 'SPEC run-time macro definition; %s',
199            'cdef': 'SPEC chained macro definition; %s',
200        }
201        if self.objtype in macro_types:
202            return _(macro_types[self.objtype]) % name
203        else:
204            return ''
205
206    def handle_signature(self, sig, signode):
207        '''return the name of this object from its signature'''
208        # Must be able to match these (without preceding def or rdef)
209        #     def macro_name
210        #     def macro_name()
211        #     def macro_name(arg1, arg2)
212        #     rdef macro_name
213        #     cdef("macro_name", "content", "groupname", flags)
214        m = spec_func_sig_re.match(sig) or spec_macro_sig_re.match(sig)
215        if m is None:
216            raise ValueError
217        arglist = m.groups()
218        name = arglist[0]
219        args = []
220        if len(arglist) > 1:
221            args = arglist[1:]
222            if name == 'cdef':
223                # TODO: need to match complete arg list
224                # several different signatures are possible (see cdef-examples.mac)
225                # for now, just get the macro name and ignore the arg list
226                m = spec_cdef_name_sig_re.match(args[0])
227                arglist = m.groups()
228                name = arglist[0].strip('"')
229                args = ['<<< cdef argument list not handled yet >>>']       # FIXME:
230        signode += addnodes.desc_name(name, name)
231        if len(args) > 0:
232            signode += addnodes.desc_addname(args, args)
233        return name
234
235
236class SpecVariableObject(ObjectDescription):
237    """
238    Description of a SPEC variable
239    """
240   
241    # TODO: The directive that declares the variable should be the primary (bold) index.
242    # TODO: array variables are not handled at all
243    # TODO: variables cited by *role* should link back to their *directive* declarations
244    #       probably need to override handle_signature() and add_target_and_index()
245
246    def handle_signature(self, sig, signode):
247        '''return the name of this object from its signature'''
248        # TODO: Should it match a regular expression?
249        # TODO: What if global or local? 
250        return sig
251
252    def add_target_and_index(self, name, sig, signode):
253        targetname = '%s-%s' % (self.objtype, name)
254        signode['ids'].append(targetname)
255        # TODO: index entry here is at line before directive, now must get it right
256        # TODO: role does not point back to it yet
257        # http://sphinx.pocoo.org/markup/misc.html#directive-index
258        text = u'! ' + sig      # TODO: How to use emphasized index entry in this context?
259        text = sig              # FIXME: temporary override
260        self.indexnode['entries'].append(('single', text, targetname, ''))
261        text = u'SPEC %s variable; %s' % (self.objtype, sig)
262        self.indexnode['entries'].append(('single', text, targetname, ''))
263
264class SpecXRefRole(XRefRole):
265    """ """
266   
267    def process_link(self, env, refnode, has_explicit_title, title, target):
268        key = ":".join((refnode['refdomain'], refnode['reftype']))
269        refnode[key] = env.temp_data.get(key)        # key was 'spec:def'
270        if not has_explicit_title:
271            title = title.lstrip(':')   # only has a meaning for the target
272            target = target.lstrip('~') # only has a meaning for the title
273            # if the first character is a tilde, don't display the module/class
274            # parts of the contents
275            if title[0:1] == '~':
276                title = title[1:]
277                colon = title.rfind(':')
278                if colon != -1:
279                    title = title[colon+1:]
280        return title, target
281
282    def result_nodes(self, document, env, node, is_ref):
283        # this code adds index entries for each role instance
284        if not is_ref:
285            return [node], []
286        varname = node['reftarget']
287        tgtid = 'index-%s' % env.new_serialno('index')
288        indexnode = addnodes.index()
289        indexnode['entries'] = [
290            ('single', varname, tgtid, ''),
291            #('single', _('environment variable; %s') % varname, tgtid, ''),
292        ]
293        targetnode = nodes.target('', '', ids=[tgtid])
294        document.note_explicit_target(targetnode)
295        return [indexnode, targetnode, node], []
296
297
298class SpecDomain(Domain):
299    """SPEC language domain."""
300   
301    name = 'spec'
302    label = 'SPEC, http://www.certif.com'
303    object_types = {    # type of object that a domain can document
304        'def':        ObjType(l_('def'),        'def'),
305        'rdef':       ObjType(l_('rdef'),       'rdef'),
306        'cdef':       ObjType(l_('cdef'),       'cdef'),
307        'global':     ObjType(l_('global'),     'global'),
308        'local':      ObjType(l_('local'),      'local'),
309        'constant':   ObjType(l_('constant'),   'constant'),
310        #'specmacro':  ObjType(l_('specmacro'),  'specmacro'),
311    }
312    directives = {
313        'def':          SpecMacroObject,
314        'rdef':         SpecMacroObject,
315        'cdef':         SpecMacroObject,
316        'global':       SpecVariableObject,
317        'local':        SpecVariableObject,
318        'constant':     SpecVariableObject,
319    }
320    roles = {
321        'def' :     SpecXRefRole(),
322        'rdef':     SpecXRefRole(),
323        'cdef':     SpecXRefRole(),
324        'global':   SpecXRefRole(),
325        'local':    SpecXRefRole(),
326        'constant': SpecXRefRole(),
327    }
328    initial_data = {
329        'objects': {}, # fullname -> docname, objtype
330    }
331
332    def clear_doc(self, docname):
333        for (typ, name), doc in self.data['objects'].items():
334            if doc == docname:
335                del self.data['objects'][typ, name]
336
337    def resolve_xref(self, env, fromdocname, builder, typ, target, node,
338                     contnode):
339        objects = self.data['objects']
340        objtypes = self.objtypes_for_role(typ)
341        for objtype in objtypes:
342            if (objtype, target) in objects:
343                return make_refnode(builder, fromdocname,
344                                    objects[objtype, target],
345                                    objtype + '-' + target,
346                                    contnode, target + ' ' + objtype)
347
348    def get_objects(self):
349        for (typ, name), docname in self.data['objects'].iteritems():
350            yield name, name, typ, docname, typ + '-' + name, 1
351
352
353# http://sphinx.pocoo.org/ext/tutorial.html#the-setup-function
354
355def setup(app):
356    app.add_domain(SpecDomain)
357    app.add_autodocumenter(SpecMacroDocumenter)
358    app.add_config_value('autospecmacrodir_process_subdirs', True, True)
Note: See TracBrowser for help on using the repository browser.