Add gcc.Location.in_system_header attribute

Author: davidmalcolm

docs/basics.rst

@@ -542,3 +542,14 @@ Working with source code
    .. py:attribute:: column
 
       (int) Column number within source file  (starting at 1, not 0)
+
+   .. py:attribute:: in_system_header
+
+      (bool) This attribute flags locations that are within a system header
+      file.  It may be of use when writing custom warnings, so that you
+      can filter out issues in system headers, leaving just those within
+      the user's code::
+
+         # Don't report on issues found in system headers:
+         if decl.location.in_system_header:
+             return

gcc-c-api/gcc-location.c

@@ -57,6 +57,11 @@ GCC_PUBLIC_API (bool) gcc_location_is_unknown (gcc_location loc)
   return UNKNOWN_LOCATION == loc.inner;
 }
 
+GCC_IMPLEMENT_PUBLIC_API (bool) gcc_location_get_in_system_header (gcc_location loc)
+{
+  return in_system_header_at (loc.inner);
+}
+
 GCC_IMPLEMENT_PUBLIC_API (void) gcc_set_input_location (gcc_location loc)
 {
   input_location = loc.inner;

gcc-c-api/location.xml

@@ -33,6 +33,9 @@
 
     <attribute name="is_unknown" kind="bool">
     </attribute>
+
+    <attribute name="in_system_header" kind="bool">
+    </attribute>
   </type>
 
   <attribute name="input_location" kind="location" access="rw">

generate-location-c.py

@@ -62,7 +62,13 @@ def generate_location():
                                    [PyGetSetDef('file', 'PyGccLocation_get_file', None, 'Name of the source file'),
                                     PyGetSetDef('line', 'PyGccLocation_get_line', None, 'Line number within source file'),
                                     PyGetSetDef('column', 'PyGccLocation_get_column', None, 'Column number within source file'),
-                                    ])
+                                    ],
+                                   identifier_prefix='PyGccLocation',
+                                   typename='PyGccLocation')
+    getsettable.add_simple_getter(cu,
+                                  'in_system_header',
+                                  'PyBool_FromLong(gcc_location_in_system_header_at(self->loc))',
+                                  'Boolean: is this location within a system header?')
     cu.add_defn(getsettable.c_defn())
 
     pytype = PyGccWrapperTypeObject(identifier = 'PyGccLocation_TypeObj',

tests/plugin/callgraph/input.c

@@ -19,8 +19,11 @@
 
 #include <stdio.h>
 
+extern const char *name;
+
 void foo()
 {
+    printf ("hello %s\n", name);
 }
 
 void bar(void)

tests/plugin/callgraph/script.py

@@ -36,6 +36,8 @@ def on_pass_execution(p, fn):
             print('cgn:')
             # print(dir(cgn))
             print('  cgn.decl: %r' % cgn.decl)
+            print('  cgn.decl.location.in_system_header: %r'
+                  % cgn.decl.location.in_system_header)
             print('  cgn.callers: %r' % cgn.callers)
             print('  cgn.callees: %r' % cgn.callees)
             for e in cgn.callers:

tests/plugin/callgraph/stdout.txt

@@ -56,12 +56,23 @@ class CallgraphEdge(__builtin__.object)
  |  __new__ = <built-in method __new__ of gcc.WrapperMeta object>
  |      T.__new__(S, ...) -> a new object with type S, a subtype of T
 
+cgn:
+  cgn.decl: gcc.FunctionDecl('printf')
+  cgn.decl.location.in_system_header: True
+  cgn.callers: [gcc.CallgraphEdge()]
+  cgn.callees: []
+gcc.CallgraphEdge()
+e.caller: gcc.CallgraphNode()
+e.callee: gcc.CallgraphNode()
+e.call_stmt: gcc.GimpleCall() printf ("hello %s\n", name.0);
 cgn:
   cgn.decl: gcc.FunctionDecl('baz')
+  cgn.decl.location.in_system_header: False
   cgn.callers: []
   cgn.callees: [gcc.CallgraphEdge(), gcc.CallgraphEdge(), gcc.CallgraphEdge()]
 cgn:
   cgn.decl: gcc.FunctionDecl('bar')
+  cgn.decl.location.in_system_header: False
   cgn.callers: [gcc.CallgraphEdge(), gcc.CallgraphEdge(), gcc.CallgraphEdge()]
   cgn.callees: [gcc.CallgraphEdge(), gcc.CallgraphEdge(), gcc.CallgraphEdge()]
 gcc.CallgraphEdge()
@@ -78,8 +89,9 @@ e.callee: gcc.CallgraphNode()
 e.call_stmt: gcc.GimpleCall() bar ();
 cgn:
   cgn.decl: gcc.FunctionDecl('foo')
+  cgn.decl.location.in_system_header: False
   cgn.callers: [gcc.CallgraphEdge(), gcc.CallgraphEdge(), gcc.CallgraphEdge()]
-  cgn.callees: []
+  cgn.callees: [gcc.CallgraphEdge()]
 gcc.CallgraphEdge()
 e.caller: gcc.CallgraphNode()
 e.callee: gcc.CallgraphNode()