source: rtems-central/rtemsqual/glossary.py @ c0ac12a

Last change on this file since c0ac12a was c0ac12a, checked in by Sebastian Huber <sebastian.huber@…>, on Feb 25, 2020 at 12:54:17 PM

Initial import

  • Property mode set to 100644
File size: 5.6 KB
Line 
1# SPDX-License-Identifier: BSD-2-Clause
2""" This module provides functions for glossary of terms generation. """
3
4# Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de)
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions
8# are met:
9# 1. Redistributions of source code must retain the above copyright
10#    notice, this list of conditions and the following disclaimer.
11# 2. Redistributions in binary form must reproduce the above copyright
12#    notice, this list of conditions and the following disclaimer in the
13#    documentation and/or other materials provided with the distribution.
14#
15# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25# POSSIBILITY OF SUCH DAMAGE.
26
27import glob
28import re
29from typing import Dict
30
31from rtemsqual.content import MacroToSphinx, SphinxContent
32from rtemsqual.items import Item, ItemCache
33
34ItemMap = Dict[str, Item]
35
36
37def _gather_glossary_groups(item: Item, glossary_groups: ItemMap) -> None:
38    for child in item.children:
39        _gather_glossary_groups(child, glossary_groups)
40    if item["type"] == "glossary" and item["glossary-type"] == "group":
41        glossary_groups[item.uid] = item
42
43
44def _gather_glossary_terms(item: Item, glossary_terms: ItemMap) -> None:
45    for child in item.children:
46        _gather_glossary_terms(child, glossary_terms)
47    if item["type"] == "glossary" and item["glossary-type"] == "term":
48        glossary_terms[item.uid] = item
49
50
51def _generate_glossary_content(terms: ItemMap) -> SphinxContent:
52    content = SphinxContent()
53    content.add_header("Glossary", level="*")
54    content.add_blank_line()
55    content.add_line(".. glossary::")
56    content.add_line(":sorted:", indent=1)
57    macro_to_sphinx = MacroToSphinx()
58    macro_to_sphinx.set_terms(terms)
59    for item in sorted(terms.values(),
60                       key=lambda x: x["glossary-term"].lower()):
61        text = macro_to_sphinx.substitute(item["text"].strip())
62        content.register_license(item["SPDX-License-Identifier"])
63        for statement in item["copyrights"]:
64            content.register_copyright(statement)
65        content.add_definition_item(item["glossary-term"],
66                                    text.split("\n"),
67                                    indent=1)
68    content.add_licence_and_copyrights()
69    return content
70
71
72def _make_glossary_term_uid(term: str) -> str:
73    return ("RTEMS-GLOS-TERM-" +
74            re.sub(r"[^a-zA-Z0-9]+", "", term.replace("+", "X")).upper())
75
76
77def _find_glossary_terms(path: str, document_terms: ItemMap,
78                         project_terms: ItemMap) -> None:
79    for src in glob.glob(path + "/**/*.rst", recursive=True):
80        if src.endswith("glossary.rst"):
81            continue
82        with open(src, "r") as out:
83            for term in re.findall(":term:`([^`]+)`", out.read()):
84                uid = _make_glossary_term_uid(term)
85                document_terms[uid] = project_terms[uid]
86
87
88def _resolve_glossary_term(document_terms: ItemMap, project_terms: ItemMap,
89                           term: Item) -> None:
90    for match in re.findall(r"@@|@([a-z]+){([^}]+)}", term["text"]):
91        if match[1] and match[1] not in document_terms:
92            new_term = project_terms[match[1]]
93            document_terms[match[1]] = new_term
94            _resolve_glossary_term(document_terms, project_terms, new_term)
95
96
97def _resolve_glossary_terms(document_terms: ItemMap,
98                            project_terms: ItemMap) -> None:
99    for term in list(document_terms.values()):
100        _resolve_glossary_term(document_terms, project_terms, term)
101
102
103def _generate_project_glossary(target: str, project_terms: ItemMap) -> None:
104    if target:
105        content = _generate_glossary_content(project_terms)
106        content.write(target)
107
108
109def _generate_document_glossary(config: dict, project_terms: ItemMap) -> None:
110    document_terms = {}  # type: ItemMap
111    for path in config["rest-source-paths"]:
112        _find_glossary_terms(path, document_terms, project_terms)
113    _resolve_glossary_terms(document_terms, project_terms)
114    content = _generate_glossary_content(document_terms)
115    content.write(config["target"])
116
117
118def generate(config: dict, item_cache: ItemCache) -> None:
119    """
120    Generates glossaries of terms according to the configuration.
121
122    :param config: A dictionary with configuration entries.
123    :param item_cache: The specification item cache containing the glossary
124                       groups and terms.
125    """
126    groups = {}  # type: ItemMap
127    for item in item_cache.top_level.values():
128        _gather_glossary_groups(item, groups)
129
130    project_terms = {}  # type: ItemMap
131    for group in config["project-groups"]:
132        _gather_glossary_terms(groups[group], project_terms)
133
134    _generate_project_glossary(config["project-target"], project_terms)
135
136    for document_config in config["documents"]:
137        _generate_document_glossary(document_config, project_terms)
Note: See TracBrowser for help on using the repository browser.