poxy 0.18.0__py3-none-any.whl → 0.19.1__py3-none-any.whl

poxy/run.py

@@ -11,9 +11,10 @@ import concurrent.futures as futures
 import os
 import subprocess
 import tempfile
-from distutils.dir_util import copy_tree
-from io import StringIO
+import copy
+import sys
 
+from io import StringIO
 from lxml import etree
 from trieregex import TrieRegEx
 
@@ -23,6 +24,19 @@ from .svg import SVG
 from .utils import *
 from .version import *
 
+if sys.version_info >= (3, 8):
+    import shutil
+
+    def copy_tree(src, dest):
+        shutil.copytree(str(src), str(dest), dirs_exist_ok=True)
+
+else:
+    import distutils.dir_util
+
+    def copy_tree(src, dest):
+        distutils.dir_util.copy_tree(str(src), str(dest))
+
+
 # =======================================================================================================================
 # HELPERS
 # =======================================================================================================================
@@ -466,6 +480,78 @@ def postprocess_xml(context: Context):
             if changed:
                 xml_utils.write(root, xml_file)
 
+        # doxygen >= 1.9.7 needs some special handling to play nice with m.css
+        # see: https://github.com/mosra/m.css/issues/239
+        if doxygen.version() >= (1, 9, 7):
+
+            member_references = dict()
+
+            # collect all the unresolved references
+            for xml_file in xml_files:
+                root = xml_utils.read(xml_file)
+                if root.tag != r'doxygen':
+                    continue
+                compounddef = root.find(r'compounddef')
+                if compounddef is None:
+                    continue
+                compound_kind = compounddef.get(r'kind')
+                if compound_kind is None or not compound_kind or not compound_kind in (r'file', r'namespace'):
+                    continue
+                for sectiondef in compounddef.findall(r'sectiondef'):
+                    for member in sectiondef.findall(r'member'):
+                        refid = member.get(r'refid')
+                        if refid is not None:
+                            refid = str(refid)
+                        if refid and refid not in member_references:
+                            member_references[refid] = None
+
+            if member_references:
+
+                # resolve
+                for xml_file in xml_files:
+                    root = xml_utils.read(xml_file)
+                    if root.tag != r'doxygen':
+                        continue
+                    compounddef = root.find(r'compounddef')
+                    if compounddef is None:
+                        continue
+                    for sectiondef in compounddef.findall(r'sectiondef'):
+                        for memberdef in sectiondef.findall(r'memberdef'):
+                            id = memberdef.get(r'id')
+                            if id is not None:
+                                id = str(id)
+                            if id and id in member_references and member_references[id] is None:
+                                member_references[id] = memberdef
+                for id, memberdef in member_references.items():
+                    if memberdef is None:
+                        context.warning(rf"could not resolve <member> reference with id '{id}'!")
+
+                # replace
+                for xml_file in xml_files:
+                    root = xml_utils.read(xml_file)
+                    if root.tag != r'doxygen':
+                        continue
+                    compounddef = root.find(r'compounddef')
+                    if compounddef is None:
+                        continue
+                    compound_kind = compounddef.get(r'kind')
+                    if compound_kind is None or not compound_kind or not compound_kind in (r'file', r'namespace'):
+                        continue
+                    changed = False
+                    for sectiondef in compounddef.findall(r'sectiondef'):
+                        replacements = []
+                        for member in sectiondef.findall(r'member'):
+                            refid = member.get(r'refid')
+                            if refid is not None:
+                                refid = str(refid)
+                            if refid and refid in member_references and member_references[refid] is not None:
+                                replacements.append((member, member_references[refid]))
+                        for member, memberdef in replacements:
+                            sectiondef.replace(member, copy.deepcopy(memberdef))
+                            changed = True
+                    if changed:
+                        xml_utils.write(root, xml_file)
+
         # now do '<doxygen>' files
         for xml_file in xml_files:
             root = xml_utils.read(xml_file)
@@ -503,15 +589,6 @@ def postprocess_xml(context: Context):
             compound_title = compounddef.find(r'title')
             compound_title = compound_title.text if compound_title is not None else compound_name
 
-            # fix weird regression in doxygen 1.9.7
-            if compound_kind == r'file' and doxygen.version() == (1, 9, 7):
-                sectiondefs = [s for s in compounddef.findall(r'sectiondef') if s.get(r'kind') == r'define']
-                for sectiondef in sectiondefs:
-                    members = [m for m in sectiondef.findall(r'member') if m.get(r'kind') == r'define']
-                    for member in members:
-                        sectiondef.remove(member)
-                        changed = True
-
             # do a bit of cleanup of <programlisting>
             for programlisting in compounddef.iterdescendants(tag="programlisting"):
                 # fix &amp;zwj; mangling (zero-width joiners don't make sense in code blocks anyways)
@@ -630,8 +707,10 @@ def postprocess_xml(context: Context):
                                     changed = True
                                     if attr is not None:
                                         member.set(attr, attr_value)
-                                    elif kw == r'friend':
-                                        member.set(r'kind', r'friend')
+                                    if kw == r'friend' and type.text == r'' and member.get(r'kind') == r'variable':
+                                        type.text = r'friend'
+                                        matched_bad_keyword = False
+                                        break
 
                     # fix issues with trailing return types
                     if 1:
@@ -1108,11 +1187,13 @@ def parse_xml(context: Context):
     context.verbose_object(r'Context.code_blocks', context.code_blocks)
 
 
-def clean_xml(context: Context):
+def clean_xml(context: Context, dir=None):
     assert context is not None
     assert isinstance(context, Context)
+    if dir is None:
+        dir = context.temp_xml_dir
 
-    xml_files = get_all_files(context.temp_xml_dir, any=(r'*.xml'))
+    xml_files = get_all_files(dir, any=(r'*.xml'))
     for xml_file in xml_files:
         root = xml_utils.read(
             xml_file, parser=xml_utils.create_parser(remove_blank_text=True), logger=context.verbose_logger  #
@@ -1674,6 +1755,7 @@ def run(
     temp_dir: Path = None,
     copy_config_to: Path = None,
     versions_in_navbar: bool = False,
+    keep_original_xml: bool = False,
     **kwargs,
 ):
     timer = lambda desc: ScopeTimer(desc, print_start=True, print_end=context.verbose_logger)
@@ -1707,7 +1789,11 @@ def run(
         # generate + postprocess XML in temp_xml_dir
         # (we always do this even when output_xml is false because it is required by the html)
         with timer(rf'Generating XML files with Doxygen {doxygen.version_string()}') as t:
+            delete_directory(context.temp_original_xml_dir)
             run_doxygen(context)
+            if keep_original_xml:
+                copy_tree(context.temp_xml_dir, context.temp_original_xml_dir)
+                clean_xml(context, dir=context.temp_original_xml_dir)
         with timer(r'Post-processing XML files') as t:
             if context.xml_v2:
                 postprocess_xml_v2(context)
@@ -1722,7 +1808,7 @@ def run(
         # XML (the user-requested copy)
         if context.output_xml:
             with ScopeTimer(r'Copying XML', print_start=True, print_end=context.verbose_logger) as t:
-                copy_tree(str(context.temp_xml_dir), str(context.xml_dir))
+                copy_tree(context.temp_xml_dir, context.xml_dir)
 
             # copy tagfile
             if context.generate_tagfile and context.tagfile_path:
@@ -1745,7 +1831,7 @@ def run(
             # copy fonts
             if context.copy_assets:
                 with ScopeTimer(r'Copying fonts', print_start=True, print_end=context.verbose_logger) as t:
-                    copy_tree(str(paths.FONTS), str(Path(context.assets_dir, r'fonts')))
+                    copy_tree(paths.FONTS, Path(context.assets_dir, r'fonts'))
 
             # copy tagfile
             if context.generate_tagfile and context.tagfile_path:

poxy/version.txt

@@ -1 +1 @@
-0.18.0
+0.19.1