logo

overlay

My own overlay for experimentations, use with caution, no support is provided git clone https://hacktivis.me/git/overlay.git

1.32-deprecation-parse-fixes.patch (7181B)

    

  1. From 2667d8cd95a2a29c35c1bb8f4629c22fd0aa98e9 Mon Sep 17 00:00:00 2001

  2. From: Xavier Claessens <xavier.claessens@collabora.com>

  3. Date: Thu, 2 Jan 2020 21:56:10 -0500

  4. Subject: [PATCH 1/3] Skip G_GNUC_(BEGIN|END)_IGNORE_DEPRECATIONS lines

  5. 

  6. For some reason, glib has to put empty line before and after each of

  7. these lines otherwise the symbol following it is undeclared.

  8. ---

  9.  gtkdoc/scan.py | 5 +++++

  10.  1 file changed, 5 insertions(+)

  11. 

  12. diff --git a/gtkdoc/scan.py b/gtkdoc/scan.py

  13. index d04d4d4..7de08ad 100644

  14. --- a/gtkdoc/scan.py

  15. +++ b/gtkdoc/scan.py

  16. @@ -561,6 +561,11 @@ def ScanHeaderContent(input_lines, decl_list, get_types, options):

  17.                      logging.info('Found start of comment: %s', line.strip())

  18.                  continue

  19.  

  20. +            # Skip begin/end deprecation macros.

  21. +            m = re.search(r'^\s*G_GNUC_(BEGIN|END)_IGNORE_DEPRECATIONS', line)

  22. +            if m:

  23. +                continue

  24. +

  25.              logging.info('no decl: %s', line.strip())

  26.  

  27.              cm = [m.match(line) for m in CLINE_MATCHER]

  28. -- 

  29. 2.20.1

  30. 

  31. 

  32. From 9e58548688c9768cf41c59ccef531d438ffb2504 Mon Sep 17 00:00:00 2001

  33. From: Xavier Claessens <xavier.claessens@collabora.com>

  34. Date: Fri, 3 Jan 2020 06:47:47 -0500

  35. Subject: [PATCH 2/3] typedef can be followed by decorator

  36. 

  37. ---

  38.  gtkdoc/scan.py | 30 +++++++++++++++++-------------

  39.  1 file changed, 17 insertions(+), 13 deletions(-)

  40. 

  41. diff --git a/gtkdoc/scan.py b/gtkdoc/scan.py

  42. index 7de08ad..5a5da92 100644

  43. --- a/gtkdoc/scan.py

  44. +++ b/gtkdoc/scan.py

  45. @@ -96,19 +96,8 @@ CLINE_MATCHER = [

  46.          (struct|union)\s*

  47.          \w*\s*{""", re.VERBOSE),

  48.      # 12-14: OTHER TYPEDEFS

  49. -    re.compile(

  50. -        r"""^\s*typedef\s+

  51. -        (?:struct|union)\s+\w+[\s\*]+

  52. -        (\w+)                                # 1: name

  53. -        \s*;""", re.VERBOSE),

  54. -    re.compile(

  55. -        r"""^\s*

  56. -        (?:G_GNUC_EXTENSION\s+)?

  57. -        typedef\s+

  58. -        (.+[\s\*])                           # 1: e.g. 'unsigned int'

  59. -        (\w+)                                # 2: name

  60. -        (?:\s*\[[^\]]+\])*

  61. -        \s*;""", re.VERBOSE),

  62. +    None,  # in InitScanner()

  63. +    None,  # in InitScanner()

  64.      re.compile(r'^\s*typedef\s+'),

  65.      # 15: VARIABLES (extern'ed variables)

  66.      None,  # in InitScanner()

  67. @@ -267,6 +256,21 @@ def InitScanner(options):

  68.          %s                                   # 3: optional decorator

  69.          \s*;""" % optional_decorators_regex, re.VERBOSE)

  70.      # OTHER TYPEDEFS

  71. +    CLINE_MATCHER[12] = re.compile(

  72. +        r"""^\s*typedef\s+

  73. +        (?:struct|union)\s+\w+[\s\*]+

  74. +        (\w+)                                # 1: name

  75. +        %s                                   # 2: optional decorator

  76. +        \s*;""" % optional_decorators_regex, re.VERBOSE)

  77. +    CLINE_MATCHER[13] = re.compile(

  78. +        r"""^\s*

  79. +        (?:G_GNUC_EXTENSION\s+)?

  80. +        typedef\s+

  81. +        (.+?[\s\*])                          # 1: e.g. 'unsigned int'

  82. +        (\w+)                                # 2: name

  83. +        (?:\s*\[[^\]]+\])*

  84. +        %s                                   # 3: optional decorator

  85. +        \s*;""" % optional_decorators_regex, re.VERBOSE)

  86.      CLINE_MATCHER[15] = re.compile(

  87.          r"""^\s*

  88.          (?:extern|[A-Za-z_]+VAR%s)\s+

  89. -- 

  90. 2.20.1

  91. 

  92. 

  93. From 5bfe23f0257e1b4c6c9a4e3a2dbb180455f753f2 Mon Sep 17 00:00:00 2001

  94. From: Jason Crain <jason@inspiresomeone.us>

  95. Date: Mon, 6 Jan 2020 19:05:42 -0700

  96. Subject: [PATCH 3/3] scan: support deprecated struct members

  97. 

  98. gcc allows deprecating members of structs. For example:

  99. 

  100. struct data {

  101.   int x G_GNUC_DEPRECATED_FOR(replacement);

  102. };

  103. 

  104. However, this currently causes the entire struct to be marked as

  105. deprecated and confuses mkdb because it doesn't understand the

  106. G_GNUC_DEPRECATED_FOR symbol.

  107. 

  108. Fix this by having the whole struct only be marked as deprecated if the

  109. '_DEPRECATED' is after the closing bracket of the struct, similar to how

  110. it already does for enums, and having scan automatically remove all

  111. G_GNUC_* decorators from struct members, similar to how it already does

  112. for functions.

  113. ---

  114.  gtkdoc/scan.py | 12 ++++++++++--

  115.  tests/scan.py  | 17 +++++++++++++++++

  116.  2 files changed, 27 insertions(+), 2 deletions(-)

  117. 

  118. diff --git a/gtkdoc/scan.py b/gtkdoc/scan.py

  119. index 5a5da92..6c6534a 100644

  120. --- a/gtkdoc/scan.py

  121. +++ b/gtkdoc/scan.py

  122. @@ -538,7 +538,7 @@ def ScanHeaderContent(input_lines, decl_list, get_types, options):

  123.          # section (#endif /* XXX_DEPRECATED */

  124.          if deprecated_conditional_nest == 0 and '_DEPRECATED' in line:

  125.              m = re.search(r'^\s*#\s*(if*|define|endif)', line)

  126. -            if not (m or in_declaration == 'enum'):

  127. +            if not (m or in_declaration == 'enum' or in_declaration == 'struct'):

  128.                  logging.info('Found deprecation annotation (decl: "%s"): "%s"',

  129.                               in_declaration, line.strip())

  130.                  deprecated_conditional_nest += 0.1

  131. @@ -953,9 +953,17 @@ def ScanHeaderContent(input_lines, decl_list, get_types, options):

  132.                      title = '<TITLE>%s</TITLE>' % objectname

  133.  

  134.                  logging.info('Store struct: "%s"', symbol)

  135. +                # Structs could contain deprecated members and that doesn't

  136. +                # mean the whole struct is deprecated, so they are ignored when

  137. +                # setting deprecated_conditional_nest above. Here we can check

  138. +                # if the _DEPRECATED is between '}' and ';' which would mean

  139. +                # the struct as a whole is deprecated.

  140. +                if re.search(r'\n\s*\}.*_DEPRECATED.*;\s*$', decl):

  141. +                    deprecated = '<DEPRECATED/>\n'

  142.                  if AddSymbolToList(slist, symbol):

  143.                      structsym = in_declaration.upper()

  144. -                    stripped_decl = re.sub('(%s)' % optional_decorators_regex, '', decl)

  145. +                    regex = r'(?:\s+(?:G_GNUC_\w+(?:\(\w*\))?%s))' % ignore_decorators

  146. +                    stripped_decl = re.sub(regex, '', decl)

  147.                      decl_list.append('<%s>\n<NAME>%s</NAME>\n%s%s</%s>\n' %

  148.                                       (structsym, symbol, deprecated, stripped_decl, structsym))

  149.                      if symbol in forward_decls:

  150. diff --git a/tests/scan.py b/tests/scan.py

  151. index ad63541..6d608b6 100755

  152. --- a/tests/scan.py

  153. +++ b/tests/scan.py

  154. @@ -552,6 +552,23 @@ class ScanHeaderContentStructs(ScanHeaderContentTestCase):

  155.          slist, doc_comments = self.scanHeaderContent([header])

  156.          self.assertDecl('data', expected, slist)

  157.  

  158. +    def test_HandleDeprecatedMemberDecorator(self):

  159. +        """Struct with deprecated members."""

  160. +        header = textwrap.dedent("""\

  161. +            struct data {

  162. +              int x1 G_GNUC_DEPRECATED;

  163. +              int x2 G_GNUC_DEPRECATED_FOR(replacement);

  164. +            };""")

  165. +        expected = textwrap.dedent("""\

  166. +            struct data {

  167. +              int x1;

  168. +              int x2;

  169. +            };""")

  170. +        scan.InitScanner(self.options)

  171. +        slist, doc_comments = self.scanHeaderContent(

  172. +                header.splitlines(keepends=True))

  173. +        self.assertDecl('data', expected, slist)

  174. +

  175.  

  176.  class ScanHeaderContentUnions(ScanHeaderContentTestCase):

  177.      """Test parsing of union declarations."""

  178. -- 

  179. 2.20.1

  180.