1bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson# formatting.py
2bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson# Sphinx extension providing formatting for Gallium-specific data
3bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson# (c) Corbin Simpson 2010
4bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson# Public domain to the extent permitted; contact author for special licensing
5bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson
6bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpsonimport docutils.nodes
7bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpsonimport sphinx.addnodes
8bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson
9bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpsondef parse_envvar(env, sig, signode):
10bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    envvar, t, default = sig.split(" ", 2)
11bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    envvar = envvar.strip().upper()
12bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    t = " Type: %s" % t.strip(" <>").lower()
13bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    default = " Default: %s" % default.strip(" ()")
14bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    signode += sphinx.addnodes.desc_name(envvar, envvar)
15bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    signode += sphinx.addnodes.desc_type(t, t)
16bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    signode += sphinx.addnodes.desc_annotation(default, default)
17bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    return envvar
18bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson
19bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpsondef parse_opcode(env, sig, signode):
20bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    opcode, desc = sig.split("-", 1)
21bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    opcode = opcode.strip().upper()
22bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    desc = " (%s)" % desc.strip()
23bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    signode += sphinx.addnodes.desc_name(opcode, opcode)
24bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    signode += sphinx.addnodes.desc_annotation(desc, desc)
25bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    return opcode
26bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson
27bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpsondef setup(app):
28bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    app.add_description_unit("envvar", "envvar", "%s (environment variable)",
29bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson        parse_envvar)
30bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson    app.add_description_unit("opcode", "opcode", "%s (TGSI opcode)",
31bf357aedffd659e43ef9ceefa875c08991a5f46dCorbin Simpson        parse_opcode)
32