File: headers.py

package info (click to toggle)
pygame 2.1.2%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 32,416 kB
  • sloc: ansic: 66,042; python: 46,176; javascript: 9,214; objc: 273; sh: 78; makefile: 56; cpp: 25
file content (51 lines) | stat: -rw-r--r-- 1,637 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
from ext.utils import get_sectionname, isections
from ext.indexer import tour_descinfo

import os


def setup(app):
    # This extension uses indexer collected tables.
    app.setup_extension("ext.indexer")

    # The target directory for the header files.
    app.add_config_value("headers_dest", ".", "html")

    # Create directory tree if missing?
    app.add_config_value("headers_mkdirs", False, "")

    # Suffix to tag onto file name before the '.h' extension
    app.add_config_value("headers_filename_sfx", "", "html")

    # Header template to use
    app.add_config_value("headers_template", "header.h", "html")

    # Write a header when its corresponding HTML page is written.
    app.connect("html-page-context", writer)


def writer(app, pagename, templatename, context, doctree):
    if doctree is None:
        return

    env = app.builder.env
    dirpath = os.path.abspath(app.config["headers_dest"])
    if app.config["headers_mkdirs"] and not os.path.lexists(dirpath):
        os.makedirs(dirpath)
    filename_suffix = app.config["headers_filename_sfx"]
    items = []
    for section in isections(doctree):
        tour_descinfo(items.append, section, env)
    if not items:
        return
    templates = app.builder.templates
    filename = "%s%s.h" % (os.path.basename(pagename), filename_suffix)
    filepath = os.path.join(dirpath, filename)
    template = app.config["headers_template"]
    header = open(filepath, "w", encoding="utf-8")
    context["hdr_items"] = items
    try:
        header.write(templates.render(template, context))
    finally:
        header.close()
        del context["hdr_items"]