File: app.py

package info (click to toggle)
seqan2 2.4.0%2Bdfsg-16
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 224,180 kB
  • sloc: cpp: 256,886; ansic: 91,672; python: 8,330; sh: 995; xml: 570; makefile: 252; awk: 51; javascript: 21
file content (322 lines) | stat: -rwxr-xr-x 13,577 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
#!/usr/bin/env python3
"""pyclangcheck driver code

This code is the driver code for the pyclangcheck tool.

Copyright: (c) 2010, Knut Reinert, FU Berlin
License:   3-clause BSD (see LICENSE)
"""



__author__ = 'Manuel Holtgrewe <manuel.holtgrewe@fu-berlin.de>'

import datetime
import optparse
import os
import os.path
import sys

import clang.cindex as ci

from . import simple_checks
from . import violations
from . import rules

def _hasFileLocation(node):
    """Return True if node has a file lcoation."""
    if hasattr(node, '_has_file_location'):
        return node._has_file_location
    if not hasattr(node, 'location'):
        node._has_file_location = False
        return False
    if not hasattr(node.location, 'file'):
        node._has_file_location = False
        return False
    if not node.location.file:
        node._has_file_location = False
        return False
    if not hasattr(node.location.file, 'name'):
        node._has_file_location = False
        return False
    if not node.location.file.name:
        node._has_file_location = False
        return False
    node._has_file_location = True
    return True


class FileCache(object):
    def __init__(self):
        self.cache = {}

    def get(self, path):
        if path in self.cache:
            return self.cache[path]
        with open(path, 'rb') as f:
            fcontents = f.readlines()
        self.cache[path] = fcontents
        return self.cache[path]


class CollectViolationsVisitor(object):
    """Visitor for AST nodes that collects rule violations."""
    
    def __init__(self, options, rules):
        self.options = options
        self.rules = rules
        for rule in self.rules:
            rule.visitor = self
        self.stack = []
        self.violations = {}
        self.file_cache = FileCache()
        self.class_stack = []
        self.seen_files = set()
        self.blocked_files = set()
   
    def seenToBlocked(self):
        """Move seen files to blocked files."""
        self.blocked_files |= self.seen_files

    def enterNode(self, node):
        """Called when a node is entered ("pre-order" traversal)."""
        self.stack.append(node)
        ck = ci.CursorKind
        if node.kind in [ck.CLASS_TEMPLATE, ck.CLASS_TEMPLATE_PARTIAL_SPECIALIZATION, ck.CLASS_DECL]:
            ## print 'PUSH CLASS', node.spelling
            self.class_stack.append(node)

        # Mark file as seen for nodes that are directly below the compilation unit.
        if len(self.stack) <= 2 and _hasFileLocation(node):
            self.seen_files.add(node.location.file.name)
        
        if self.options.verbosity >= 2:
            if node.extent.start.file:
                filename = node.extent.start.file.name
                lines = self.file_cache.get(filename)
                start = "%s:%d:%d" % (os.path.basename(filename), node.extent.start.line-1, node.extent.start.column-1)
                end = "%s:%d:%d" % ('#', node.extent.end.line-1, node.extent.end.column-1)
                lines = [x for x in lines[node.extent.start.line-1:node.extent.end.line]]
                if len(lines) == 1:
                    lines[0] = lines[0][node.extent.start.column - 1:node.extent.end.column-1]
                else:
                    lines[0] = lines[0][node.extent.start.column - 1:]
                    lines[-1] = lines[-1][:node.extent.end.column-1]
                if len(lines) > 1:
                    txt = '<multiline>'
                else:
                    txt = ''.join(lines).replace('\n', '\\n')
                print('  ' * len(self.stack), 'Entering', node.kind, node._kind_id, node.spelling, 'txt="%s"' % txt, "%s-%s" % (start, end))
        violations = []
        for rule in self.rules:
            if rule.allowVisit(node):
                #print ' ', ' ' * len(self.stack), 'Checking rule', rule.rule_id
                vs = rule.check(node)
                ## if self.options.verbosity >= 2:
                ##     for v in vs:
                ##         print 'VIOLATION', v
                violations += vs
        for v in violations:
            ## if self.options.verbosity >= 2:
            ##     print v
            self.violations[v.key()] = v

    def exitNode(self, node):
        """Called when a node is left ("post-order" traversa)."""
        self.stack.pop()
        if self.class_stack and self.class_stack[-1] is node:
            ## print 'POP CLASS', node.spelling
            self.class_stack.pop()

    def getCurrentClassName(self):
        """Returns name of current class."""
        if not self.class_stack:
            ## print 'CURRENT CLASS', None
            return None
        ## print 'CURRENT CLASS', self.class_stack[-1].spelling
        return self.class_stack[-1].spelling


class VisitAllowedRule(object):
    """Decides whether a AST node and its children is visited."""
    
    def __init__(self, options, blocked_files):
        self.options = options
        self.include_dirs = [os.path.abspath(x) for x in options.include_dirs]
        self.cache = {}
        self.blocked_files = blocked_files

    def visitAllowed(self, node):
        """Return True if visiting is allowed."""
        # Visit if translation unit.
        if node.kind == ci.CursorKind.TRANSLATION_UNIT:
            return True
        # Don't visit if it has no location (built-in).
        if not _hasFileLocation(node):
            return False
        # Try to hit cache.
        if node.location.file.name in self.cache:
            return self.cache[node.location.file.name]
        # Check whether the file is blocked.
        if node.location.file.name in self.blocked_files:
            # print 'Blocked', node.location.file.name
            self.cache[node.location.file.name] = False
            return False
        # Check whether node's location is below the include directories.  It is
        # only visited if this is the case.
        filename = os.path.abspath(node.location.file.name)
        result = False
        for x in self.include_dirs:
            if filename.startswith(x):
                # print filename, x
                result = True
                break
        self.cache[node.location.file.name] = result  # Save in cache.
        return result


class AstTraverser(object):
    """Traverses AST tree and applies given visitor object."""
    
    def __init__(self, node_visitor, options):
        self.node_visitor = node_visitor
        self.options = options
        self.visit_allowed_rule = VisitAllowedRule(options, node_visitor.blocked_files)

    def _recurse(self, node):
        """Recursion helper."""
        if not self.visit_allowed_rule.visitAllowed(node):
            return False  # We did not visit this node.
        self.node_visitor.enterNode(node)
        for c in node.get_children():
            self._recurse(c)
        self.node_visitor.exitNode(node)
        return True

    def run(self, filename):
        """Main entry point."""
        index = ci.Index.create()
        args = ['-I%s' % s for s in self.options.include_dirs]
        # print args
        tu = index.parse(filename, args=args)
        if self.options.verbosity >= 1:
            print('Translation unit: %s.' % tu.spelling)
        return self._recurse(tu.cursor)
    
    @classmethod
    def visitFile(klass, filename, node_visitor, options):
        """Don't instantiate AstTraverser yourself, use this function."""
        if options.verbosity >= 1:
            print('Checking', filename, file=sys.stderr)
        traverser = AstTraverser(node_visitor, options)
        res = traverser.run(filename)
        return res != True


def main():
    # ========================================================================
    # Parse command line arguments.
    # ========================================================================
    parser = optparse.OptionParser("USAGE: %prog [options] file.cpp")
    parser.add_option('-s', '--source-file', dest='source_files', default=[],
                      type='string', help='Specify source (.cpp) files.',
                      action='append')
    parser.add_option('-S', '--source-file-file', dest='source_file_files', default=[],
                      type='string', help='File with path to source files.',
                      action='append')
    parser.add_option('-i', '--include-dir', dest='include_dirs', default=[],
                      type='string', help='Specify include directories',
                      action='append')
    parser.add_option('-e', '--exclude-dir', dest='exclude_dirs', default=[],
                      type='string', help='Violations in these directories are not shown.',
                      action='append')
    parser.add_option('-q', '--quiet', dest='verbosity', default=1,
                      action='store_const', const=0, help='Fewer message.')
    parser.add_option('-v', '--verbose', dest='verbosity', default=1,
                      action='store_const', const=2, help='More messages.')
    parser.add_option('--ignore-nolint', dest='ignore_nolint', default=False,
                      action='store_const', const=True, help='Ignore // nolint statements.')
    parser.add_option('--dont-show-source', dest='show_source', default=True,
                      action='store_const', const=False, help='Suppress source line display')
    options, args = parser.parse_args()

    if len(args) != 0:
        parser.error('Incorrect number of arguments!')
        return 1

    # Load source files given in file of paths.
    for filename in options.source_file_files:
        with open(filename, 'rb') as f:
            options.source_files += [x.strip() for x in f.readlines()]

    # ========================================================================
    # Setup traversal.
    # ========================================================================

    # Recursion Rule: Only check symbols within the include directories.
    recurse_rules = []
    recurse_rules.append(rules.InIncludeDirsRule(options.include_dirs, options.exclude_dirs, options.source_files))
    # Define symbol naming rules.
    R = rules.GenericSymbolNameRule
    r = rules
    ck = ci.CursorKind
    check_rules = [
        R(ck.STRUCT_DECL                          , r.RE_STRUCT       , r.RULE_NAMING_STRUCT                ),
        R(ck.UNION_DECL                           , r.RE_TYPE         , r.RULE_NAMING_UNION                 ),
        R(ck.CLASS_DECL                           , r.RE_TYPE         , r.RULE_NAMING_CLASS                 ),
        R(ck.ENUM_DECL                            , r.RE_TYPE         , r.RULE_NAMING_ENUM                  ),
        R(ck.FIELD_DECL                           , r.RE_VARIABLE     , r.RULE_NAMING_FIELD                 ),
        R(ck.ENUM_CONSTANT_DECL                   , r.RE_CONSTANT     , r.RULE_NAMING_ENUM_CONSTANT         ),
        R(ck.FUNCTION_DECL                        , r.RE_FUNCTION     , r.RULE_NAMING_FUNCTION              ),
        R(ck.PARM_DECL                            , r.RE_VARIABLE     , r.RULE_NAMING_PARAMETER             ),
        R(ck.TYPEDEF_DECL                         , r.RE_TYPE         , r.RULE_NAMING_TYPEDEF               ),
        R(ck.CXX_METHOD                           , r.RE_FUNCTION     , r.RULE_NAMING_CXX_METHOD            ),
        R(ck.TEMPLATE_TYPE_PARAMETER              , r.RE_TYPE         , r.RULE_NAMING_TPL_TYPE_PARAMETER    ),
        R(ck.TEMPLATE_NON_TYPE_PARAMETER          , r.RE_CONSTANT     , r.RULE_NAMING_TPL_NON_TYPE_PARAMETER),
        R(ck.TEMPLATE_TEMPLATE_PARAMTER           , r.RE_TYPE         , r.RULE_NAMING_TPL_TPL_PARAMETER     ),
        #R(ck.FUNCTION_TEMPLATE                    , r.RE_FUNCTION     , r.RULE_NAMING_FUNCTION_TPL          ),
        R(ck.CLASS_TEMPLATE                       , r.RE_TYPE_TEMPLATE, r.RULE_NAMING_CLASS_TPL             ),
        R(ck.CLASS_TEMPLATE_PARTIAL_SPECIALIZATION, r.RE_TYPE_TEMPLATE, r.RULE_NAMING_CLASS_TPL_SPEC        ),
        rules.FunctionTemplateRule(),
        rules.VariableNameRule(),
    ]

    # ========================================================================
    # Perform traversal.
    # ========================================================================

    node_visitor = CollectViolationsVisitor(options, check_rules)
    for filename in options.source_files:
        start = datetime.datetime.now()
        res = AstTraverser.visitFile(filename, node_visitor, options)
        node_visitor.seenToBlocked()
        elapsed = datetime.datetime.now() - start
        print('  took', elapsed.seconds, 's', file=sys.stderr)
        if res:
            break

    # ========================================================================
    # Dumber checks (e.g. whitespace at end of file).
    # ========================================================================

    checkers = [simple_checks.WhitespaceChecker(),
                simple_checks.CommentChecker()]
    vs = {}
    for filename in node_visitor.seen_files:
        for checker in checkers:
            vs.update(checker.check(filename))

    # ========================================================================
    # Print violations.
    # ========================================================================

    print('VIOLATIONS')
    vs.update(node_visitor.violations)
    printer = violations.ViolationPrinter(options.ignore_nolint,
                                          options.show_source)
    printer.show(vs)
    return len(vs) > 0


if __name__ == '__main__':
    sys.exit(main())