Strip name suffix for body-nested package entities

GNAT appends Xn/Xb suffixes for entities which are nested in body
packages and GDB does not strip them when getting type pretty names.
This commit introduces a helper to strip them and then uses it where
relevant in pretty-printers.

For GitHub issue #3
Change-Id: Ic3c93e0eb34d17af101015c054e8b2004a967d58
no-tn-check

Author: pmderodat

gnatdbg/generics.py

@@ -7,7 +7,7 @@
 
 import gdb
 
-from gnatdbg.utils import gdb_code_names
+from gnatdbg.utils import gdb_code_names, pretty_typename
 
 
 regex_type = type(re.compile('.*'))
@@ -191,7 +191,8 @@ def _match(self, typ, mt):
                     types.append(typ)
 
             for typ in types:
-                type_name = str(typ) if self.match_pretty_name else typ.name
+                type_name = (pretty_typename(typ)
+                             if self.match_pretty_name else typ.name)
 
                 with mt.scope(self, typ):
 

gnatdbg/lists.py

@@ -8,6 +8,7 @@
 
 from gnatdbg.generics import Match
 from gnatdbg.printers import PrettyPrinter
+from gnatdbg.utils import pretty_typename
 
 
 class DoublyLinkedListPrinter(PrettyPrinter):
@@ -49,7 +50,7 @@ def children(self):
 
     def to_string(self):
         return '{} of length {}'.format(
-            str(self.value.type),
+            pretty_typename(self.value.type),
             self.length,
         )
 

gnatdbg/maps.py

@@ -8,6 +8,7 @@
 from gnatdbg.hash_tables import iterate, get_htable_pattern
 from gnatdbg.printers import PrettyPrinter
 from gnatdbg.red_black_trees import dfs, get_rbtree_pattern
+from gnatdbg.utils import pretty_typename
 
 
 class BaseMapPrinter(PrettyPrinter):
@@ -30,7 +31,7 @@ def children(self):
 
     def to_string(self):
         return '{} of length {}'.format(
-            str(self.value.type),
+            pretty_typename(self.value.type),
             self.length
         )
 

gnatdbg/sets.py

@@ -6,6 +6,7 @@
 from gnatdbg.hash_tables import iterate, get_htable_pattern
 from gnatdbg.printers import PrettyPrinter
 from gnatdbg.red_black_trees import dfs, get_rbtree_pattern
+from gnatdbg.utils import pretty_typename
 
 
 class BaseSetPrinter(PrettyPrinter):
@@ -19,7 +20,7 @@ def children(self):
 
     def to_string(self):
         return '{} of length {}'.format(
-            str(self.value.type),
+            pretty_typename(self.value.type),
             self.length
         )
 

gnatdbg/utils.py

@@ -2,6 +2,8 @@
 Gathering of various helpers that don't deserve their own submodule.
 """
 
+import re
+
 import gdb
 import gdb.printing
 
@@ -13,6 +15,8 @@
 }
 objfile_filter_true = lambda objfile: True # no-code-coverage
 
+bnpe_suffix_re = re.compile('X[bn]*$')
+
 
 def register_pretty_printers(printers, objfile_filter=objfile_filter_true):
     """
@@ -156,6 +160,27 @@ def encode_name(name):
     return name.lower().replace('.', '__')
 
 
+def pretty_typename(typ):
+    """
+    Return a pretty (Ada-like) name for the given type.
+
+    :param gdb.Type typ: Type whose name is requested.
+    :rtype: str
+    """
+    return strip_bnpe_suffix(str(typ))
+
+
+def strip_bnpe_suffix(name):
+    """
+    Strip suffix for body-nested package entities from "name".
+
+    :param str name: Name to strip.
+    :rtype: str
+    """
+    m = bnpe_suffix_re.search(name)
+    return name[:m.start()] if m else name
+
+
 def addr_to_val(addr, valtype):
     """
     Create a value based on the given address and type.

gnatdbg/vectors.py

@@ -6,6 +6,7 @@
 
 from gnatdbg.generics import Match
 from gnatdbg.printers import PrettyPrinter
+from gnatdbg.utils import pretty_typename
 
 
 class VectorPrinter(PrettyPrinter):
@@ -78,7 +79,8 @@ def children(self):
                 yield ('[{}]'.format(i), elt)
 
     def to_string(self):
-        return '{} of length {}'.format(str(self.value.type), self.length)
+        return '{} of length {}'.format(pretty_typename(self.value.type),
+                                        self.length)
 
 
 class VectorCursorPrinter(PrettyPrinter):