[gi-docgen/validate-type-fragment] utils: Validate the type fragment

[Emmanuele Bassi <ebassi src gnome org>]

commit 67f4e50390fba359f6a9c69aa81d3541ec54120b
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Sun Nov 7 18:12:10 2021 +0000

    utils: Validate the type fragment
    
    If we find a link to a valid type, but with the wrong fragment, we will
    end up creating an invalid link, unless the generic `type` fragment is
    used. To avoid this case, we are going to evaluate the fragment against
    the expected one given the resolved type.

 gidocgen/utils.py | 53 ++++++++++++++++++++++++++++++-----------------------
 1 file changed, 30 insertions(+), 23 deletions(-)
---
diff --git a/gidocgen/utils.py b/gidocgen/utils.py
index de3a488..dd2544f 100644
--- a/gidocgen/utils.py
+++ b/gidocgen/utils.py
@@ -300,29 +300,36 @@ class LinkGenerator:
                 return None
         t = namespace.find_real_type(name)
         if t is not None and t.base_ctype is not None:
-            if fragment == 'type':
-                if isinstance(t, gir.Alias):
-                    self._fragment = 'alias'
-                elif isinstance(t, gir.BitField):
-                    self._fragment = 'flags'
-                elif isinstance(t, gir.Callback):
-                    self._fragment = 'callback'
-                elif isinstance(t, gir.Class):
-                    self._fragment = 'class'
-                elif isinstance(t, gir.Constant):
-                    self._fragment = 'const'
-                elif isinstance(t, gir.Enumeration):
-                    self._fragment = 'enum'
-                elif isinstance(t, gir.ErrorDomain):
-                    self._fragment = 'error'
-                elif isinstance(t, gir.Interface):
-                    self._fragment = 'iface'
-                elif isinstance(t, gir.Record) or isinstance(t, gir.Union):
-                    self._fragment = 'struct'
-                else:
-                    return LinkParseError(self._line, self._start, self._end,
-                                          self._fragment, self._endpoint,
-                                          f"Invalid type {t} for '{ns}.{name}'")
+            # We determine the fragment here, in case `type` was used,
+            # or for validating the fragment passed, to avoid creating
+            # invalid links
+            if isinstance(t, gir.Alias):
+                type_fragment = 'alias'
+            elif isinstance(t, gir.BitField):
+                type_fragment = 'flags'
+            elif isinstance(t, gir.Callback):
+                type_fragment = 'callback'
+            elif isinstance(t, gir.Class):
+                type_fragment = 'class'
+            elif isinstance(t, gir.Constant):
+                type_fragment = 'const'
+            elif isinstance(t, gir.Enumeration):
+                type_fragment = 'enum'
+            elif isinstance(t, gir.ErrorDomain):
+                type_fragment = 'error'
+            elif isinstance(t, gir.Interface):
+                type_fragment = 'iface'
+            elif isinstance(t, gir.Record) or isinstance(t, gir.Union):
+                type_fragment = 'struct'
+            else:
+                return LinkParseError(self._line, self._start, self._end,
+                                      self._fragment, self._endpoint,
+                                      f"Invalid type {t} for '{ns}.{name}'")
+            if fragment != 'type' and fragment != type_fragment:
+                return LinkParseError(self._line, self._start, self._end,
+                                      self._fragment, self._endpoint,
+                                      f"Invalid fragment for '{ns}.{name}': it should be {type_fragment}")
+            self._fragment = type_fragment
             self._name = name
             self._type = t.base_ctype
             return None