File: namingng.py

package info (click to toggle)
cppcheck 2.18.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 26,132 kB
  • sloc: cpp: 268,935; python: 20,890; ansic: 8,090; sh: 1,045; makefile: 1,008; xml: 1,005; cs: 291
file content (420 lines) | stat: -rwxr-xr-x 16,685 bytes parent folder | download | duplicates (2)
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
#!/usr/bin/env python3
#
# cppcheck addon for naming conventions
# An enhanced version. Configuration is taken from a json file
# It supports to check for type-based prefixes in function or variable names.
# Aside from include guard naming, include guard presence can also be tested.
#
# Example usage (variable name must start with lowercase, function name must start with uppercase):
# $ cppcheck --dump path-to-src/
# $ python namingng.py test.c.dump
#
# JSON format:
#
# {
#    "RE_VARNAME": ["[a-z]*[a-zA-Z0-9_]*\\Z"],
#    "RE_PRIVATE_MEMBER_VARIABLE": null,
#    "RE_FUNCTIONNAME": ["[a-z0-9A-Z]*\\Z"],
#    "_comment": "comments can be added to the config with underscore-prefixed keys",
#    "include_guard": {
#        "input": "path",
#        "prefix": "GUARD_",
#        "case": "upper",
#        "max_linenr": 5,
#        "RE_HEADERFILE": "[^/].*\\.h\\Z",
#        "required": true
#    },
#    "var_prefixes": {"uint32_t": "ui32"},
#    "function_prefixes": {"uint16_t": "ui16",
#                          "uint32_t": "ui32"}
# }
#
# RE_VARNAME, RE_PRIVATE_MEMBER_VARIABLE and RE_FUNCTIONNAME are regular expressions to cover the basic names
# In var_prefixes and function_prefixes there are the variable-type/prefix pairs

import cppcheckdata
import sys
import os
import re
import json

# Auxiliary class
class DataStruct:
    def __init__(self, file, linenr, string, column=0):
        self.file = file
        self.linenr = linenr
        self.str = string
        self.column = column

def reportNamingError(location,message,errorId='namingConvention',severity='style',extra='',column=None):
    cppcheckdata.reportError(location,severity,message,'namingng',errorId,extra,columnOverride=column)

def configError(error,fatal=True):
    print('config error: %s'%error)
    if fatal:
        sys.exit(1)

def validateConfigREs(list_or_dict,json_key):
    have_error = False
    for item in list_or_dict:
        try:
            re.compile(item)
        except re.error as err:
            configError("item '%s' of '%s' is not a valid regular expression: %s"%(item,json_key,err),fatal=False)
            have_error = True
            continue
        if not isinstance(list_or_dict,dict):
            continue
        # item is actually a dict key; check value
        value = list_or_dict[item]
        if (not isinstance(value,list) or len(value) != 2
                or not isinstance(value[0],bool) or not isinstance(value[1],str)):
            configError("item '%s' of '%s' must be an array [bool,string]"%(item,json_key),fatal=False)
            have_error = True

    return have_error

def loadConfig(configfile):
    if not os.path.exists(configfile):
        configError("cannot find config file '%s'"%configfile)

    try:
        with open(configfile) as fh:
            data = json.load(fh)
    except json.JSONDecodeError as e:
        configError("error parsing config file as JSON at line %d: %s"%(e.lineno,e.msg))
    except Exception as e:
        configError("error opening config file '%s': %s"%(configfile,e))

    if not isinstance(data, dict):
        configError('config file must contain a JSON object at the top level')

    # All errors are emitted before bailing out, to make the unit test more
    # effective.
    have_error = False

    # Put config items in a class, so that settings can be accessed using
    # config.feature
    class Config:
        pass
    config = Config()

    mapping = {
        'file':                     ('RE_FILE', (list,)),
        'namespace':                ('RE_NAMESPACE', (list,dict)),
        'include_guard':            ('include_guard', (dict,)),
        'variable':                 ('RE_VARNAME', (list,dict)),
        'variable_prefixes':        ('var_prefixes', (dict,), {}),
        'private_member':           ('RE_PRIVATE_MEMBER_VARIABLE', (list,dict)),
        'public_member':            ('RE_PUBLIC_MEMBER_VARIABLE', (list,dict)),
        'global_variable':          ('RE_GLOBAL_VARNAME', (list,dict)),
        'function_name':            ('RE_FUNCTIONNAME', (list,dict)),
        'function_prefixes':        ('function_prefixes', (dict,), {}),
        'class_name':               ('RE_CLASS_NAME', (list,dict)),
        'skip_one_char_variables':  ('skip_one_char_variables', (bool,)),
    }

    # parse defined keys and store as members of config object
    for key,opts in mapping.items():
        json_key = opts[0]
        req_type = opts[1]
        default = None if len(opts)<3 else opts[2]

        value = data.pop(json_key,default)
        if value is not None and type(value) not in req_type:
            req_typename = ' or '.join([tp.__name__ for tp in req_type])
            got_typename = type(value).__name__
            configError('%s must be %s (not %s), or not set'%(json_key,req_typename,got_typename),fatal=False)
            have_error = True
            continue

        # type list implies that this is either a list of REs or a dict with RE keys
        if list in req_type and value is not None:
            re_error = validateConfigREs(value,json_key)
            if re_error:
                have_error = True

        setattr(config,key,value)

    # check remaining keys, only accept underscore-prefixed comments
    for key,value in data.items():
        if key == '' or key[0] != '_':
            configError("unknown config key '%s'"%key,fatal=False)
            have_error = True

    if have_error:
        sys.exit(1)

    # pylint: disable-next=no-member - TODO: fix this
    if config.include_guard:
        # pylint: disable-next=no-member - TODO: fix this
        config.include_guard_header_re = config.include_guard.get('RE_HEADERFILE',"[^/].*\\.h\\Z")

    return config


def evalExpr(conf, exp, mockToken, msgType):
    report_as_error = False
    msg = msgType + ' ' + mockToken.str + ' violates naming convention'

    if isinstance(conf, dict):
        report_as_error = conf[exp][0]
        msg += ': ' + conf[exp][1]

    res = re.match(exp,mockToken.str)
    if bool(res) == report_as_error:
        reportNamingError(mockToken,msg)

def check_include_guard_name(conf,directive):
    parts = directive.str.split()
    if len(parts) != 2:
        msg = 'syntax error'
        reportNamingError(directive,msg,'syntax')
        return None,None
    guard_name = parts[1]
    guard_column = 1+directive.str.find(guard_name)

    filename = directive.file
    if conf.include_guard.get('input','path') == 'basename':
        filename = os.path.basename(filename)
    use_case = conf.include_guard.get('case','upper')
    if use_case == 'upper':
        filename = filename.upper()
    elif use_case == 'lower':
        filename = filename.lower()
    elif use_case == 'keep':
        pass # keep filename case as-is
    else:
        print("invalid config value for 'case': '%s'"%use_case,file=sys.stderr)
        sys.exit(1)

    barename = re.sub('[^A-Za-z0-9]','_',filename).strip('_')
    expect_guard_name = conf.include_guard.get('prefix','') + barename + conf.include_guard.get('suffix','')
    if expect_guard_name != guard_name:
        msg = 'include guard naming violation; %s != %s'%(guard_name,expect_guard_name)
        reportNamingError(directive,msg,'includeGuardName',column=guard_column)

    return guard_name,guard_column

def check_include_guards(conf,cfg,unguarded_include_files):
    # Scan for '#ifndef FILE_H' as the first directive, in the first N lines.
    # Then test whether the next directive #defines the found name.
    # Various tests are done:
    # - check include guards for their naming and consistency
    # - test whether include guards are in place
    max_linenr = conf.include_guard.get('max_linenr', 5)

    def report(directive,msg,errorId,severity='style',column=0):
        reportNamingError(directive,msg,errorId,severity=severity,column=column)

    def report_pending_ifndef(directive,column):
        report(directive,'include guard #ifndef is not followed by #define','includeGuardIncomplete',column=column)

    last_fn = None
    pending_ifndef = None
    guard_column = None
    phase = 0
    for directive in cfg.directives:
        if last_fn != directive.file:
            if pending_ifndef:
                report_pending_ifndef(pending_ifndef,guard_column)
                pending_ifndef = None
            last_fn = directive.file
            phase = 0
        if phase == -1:
            # ignore (the remainder of) this file
            continue
        if not re.match(conf.include_guard_header_re,directive.file):
            phase = -1
            continue

        if directive.linenr > max_linenr:
            if phase == 0 and conf.include_guard.get('required',1):
                report(directive,'include guard not found before line %d'%max_linenr,'includeGuardMissing')
            phase = -1
            continue

        if phase == 0:
            # looking for '#ifndef FILE_H'
            if not directive.str.startswith('#ifndef'):
                if conf.include_guard.get('required',1):
                    report(directive,'first preprocessor directive should be include guard #ifndef','includeGuardMissing')
                phase = -1
                continue
            guard_name,guard_column = check_include_guard_name(conf,directive)
            if guard_name is None:
                phase = -1
                continue
            pending_ifndef = directive
            phase = 1
        elif phase == 1:
            pending_ifndef = None
            # looking for '#define FILE_H'
            if not directive.str.startswith('#define'):
                report(directive,'second preprocessor directive should be include guard #define','includeGuardIncomplete')
                phase = -1
                continue
            parts = directive.str.split()
            if len(parts) == 1:
                report(directive,'syntax error','syntax')
                phase = -1
                continue
            if guard_name != parts[1]:
                report(directive,'include guard does not guard; %s != %s'%(guard_name,parts[1]),'includeGuardAwayFromDuty',severity='warning',column=guard_column)

            unguarded_include_files.remove(directive.file)

            phase = -1
    if pending_ifndef:
        report_pending_ifndef(pending_ifndef,guard_column)

def process(dumpfiles, configfile, cli, debugprint):
    conf = loadConfig(configfile)

    for afile in dumpfiles:
        if not afile[-5:] == '.dump':
            continue
        if not cli:
            print('Checking ' + afile + '...')
        data = cppcheckdata.CppcheckData(afile)
        process_data(conf,data,cli,debugprint)

def check_file_naming(conf,data):
    for source_file in data.files:
        basename = os.path.basename(source_file)
        good = False
        for exp in conf.file:
            good |= bool(re.match(exp, source_file))
            good |= bool(re.match(exp, basename))
        if not good:
            mockToken = DataStruct(source_file, 0, basename)
            reportNamingError(mockToken, 'File name ' + basename + ' violates naming convention')

def check_namespace_naming(conf,data):
    for tk in data.rawTokens:
        if tk.str != 'namespace':
            continue
        mockToken = DataStruct(tk.next.file, tk.next.linenr, tk.next.str, tk.next.column)
        for exp in conf.namespace:
            evalExpr(conf.namespace, exp, mockToken, 'Namespace')

def check_variable_naming(conf,cfg,debugprint):
    for var in cfg.variables:
        if not var.nameToken:
            continue
        if var.access in ('Global','Public','Private'):
            continue
        prev = var.nameToken.previous
        varType = prev.str
        while "*" in varType and len(varType.replace("*", "")) == 0:
            prev = prev.previous
            varType = prev.str + varType

        if debugprint:
            print("Variable Name: " + str(var.nameToken.str))
            print("original Type Name: " + str(var.nameToken.valueType.originalTypeName))
            print("Type Name: " + var.nameToken.valueType.type)
            print("Sign: " + str(var.nameToken.valueType.sign))
            print("variable type: " + varType)
            print("\n")
            print("\t-- {} {}".format(varType, str(var.nameToken.str)))

        if conf.skip_one_char_variables and len(var.nameToken.str) == 1:
            continue
        if varType in conf.variable_prefixes:
            prefix = conf.variable_prefixes[varType]
            if not var.nameToken.str.startswith(prefix):
                reportNamingError(var.typeStartToken,
                                    'Variable ' +
                                    var.nameToken.str +
                                    ' violates naming convention',
                                    column=var.nameToken.column)

        mockToken = DataStruct(var.typeStartToken.file, var.typeStartToken.linenr, var.nameToken.str, var.nameToken.column)
        for exp in conf.variable:
            evalExpr(conf.variable, exp, mockToken, 'Variable')

# Naming check for Global, Private and Public member variables
def check_gpp_naming(conf_list,cfg,access,message):
    for var in cfg.variables:
        if var.access != access:
            continue
        mockToken = DataStruct(var.typeStartToken.file, var.typeStartToken.linenr, var.nameToken.str, var.nameToken.column)
        for exp in conf_list:
            evalExpr(conf_list, exp, mockToken, message)

def check_function_naming(conf,cfg,debugprint):
    for token in cfg.tokenlist:
        if not token.function:
            continue
        if token.function.type in ('Constructor', 'Destructor', 'CopyConstructor', 'MoveConstructor'):
            continue
        retval = token.previous.str
        prev = token.previous
        while "*" in retval and len(retval.replace("*", "")) == 0:
            prev = prev.previous
            retval = prev.str + retval
        if debugprint:
            print("\t:: {} {}".format(retval, token.function.name))

        if retval and retval in conf.function_prefixes:
            if not token.function.name.startswith(conf.function_prefixes[retval]):
                reportNamingError(token, 'Function ' + token.function.name + ' violates naming convention', column=token.column)
        mockToken = DataStruct(token.file, token.linenr, token.function.name, token.column)
        msgType = 'Function'
        for exp in conf.function_name:
            evalExpr(conf.function_name, exp, mockToken, msgType)

def check_class_naming(conf,cfg):
    for fnc in cfg.functions:
        if fnc.type not in ('Constructor','Destructor'):
            continue
        mockToken = DataStruct(fnc.tokenDef.file, fnc.tokenDef.linenr, fnc.name, fnc.tokenDef.column)
        msgType = 'Class ' + fnc.type
        for exp in conf.class_name:
            evalExpr(conf.class_name, exp, mockToken, msgType)

def process_data(conf,data,cli,debugprint):
    if conf.file:
        check_file_naming(conf,data)

    if conf.namespace:
        check_namespace_naming(conf,data)

    unguarded_include_files = []
    if conf.include_guard and conf.include_guard.get('required',1):
        unguarded_include_files = [fn for fn in data.files if re.match(conf.include_guard_header_re,fn)]

    for cfg in data.configurations:
        if not cli:
            print('Checking config %s...' % cfg.name)
        if conf.variable:
            check_variable_naming(conf,cfg,debugprint)
        if conf.private_member:
            check_gpp_naming(conf.private_member,cfg,'Private','Private member variable')
        if conf.public_member:
            check_gpp_naming(conf.public_member,cfg,'Public','Public member variable')
        if conf.global_variable:
            check_gpp_naming(conf.global_variable,cfg,'Global','Global variable')
        if conf.function_name:
            check_function_naming(conf,cfg,debugprint)
        if conf.class_name:
            check_class_naming(conf,cfg)
        if conf.include_guard:
            check_include_guards(conf,cfg,unguarded_include_files)

    for fn in unguarded_include_files:
        mockToken = DataStruct(fn,0,os.path.basename(fn))
        reportNamingError(mockToken,'Missing include guard','includeGuardMissing')

if __name__ == "__main__":
    parser = cppcheckdata.ArgumentParser()
    parser.add_argument("--debugprint", action="store_true", default=False,
                        help="Add debug prints")
    parser.add_argument("--configfile", type=str, default="namingng.config.json",
                        help="Naming check config file")

    args = parser.parse_args()
    process(args.dumpfile, args.configfile, args.cli, args.debugprint)

    sys.exit(0)