cppcheck/addons/cppcheckdata.py at master · 2php/cppcheck · GitHub

History

executable file

802 lines (695 loc) · 25.8 KB

Raw

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

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

"""

cppcheckdata

This is a Python module that helps you access Cppcheck dump data.

License: No restrictions, use this as you need.

"""

import xml.etree.ElementTree as ET

import argparse

from fnmatch import fnmatch

class Directive:

"""

Directive class. Contains information about each preprocessor directive in the source code.

Attributes:

str The directive line, with all C or C++ comments removed

file Name of (possibly included) file where directive is defined

linenr Line number in (possibly included) file where directive is defined

To iterate through all directives use such code:

@code

data = cppcheckdata.parsedump(...)

for cfg in data.configurations:

for directive in cfg.directives:

print(directive.str)

@endcode

"""

str = None

file = None

linenr = None

def __init__(self, element):

self.str = element.get('str')

self.file = element.get('file')

self.linenr = element.get('linenr')

class ValueType:

"""

ValueType class. Contains (promoted) type information for each node in the AST.

"""

type = None

sign = None

bits = 0

constness = 0

pointer = 0

typeScopeId = None

typeScope = None

originalTypeName = None

def __init__(self, element):

self.type = element.get('valueType-type')

self.sign = element.get('valueType-sign')

bits = element.get('valueType-bits')

if bits:

self.bits = int(bits)

self.typeScopeId = element.get('valueType-typeScope')

self.originalTypeName = element.get('valueType-originalTypeName')

constness = element.get('valueType-constness')

if constness:

self.constness = int(constness)

else:

self.constness = 0

pointer = element.get('valueType-pointer')

if pointer:

self.pointer = int(pointer)

else:

self.pointer = 0

def setId(self, IdMap):

self.typeScope = IdMap[self.typeScopeId]

def isIntegral(self):

return self.type in {'bool', 'char', 'short', 'int', 'long', 'long long'}

def isFloat(self):

return self.type in {'float', 'double', 'long double'}

def isEnum(self):

return self.typeScope and self.typeScope.type == "Enum"

class Token:

"""

Token class. Contains information about each token in the source code.

The CppcheckData.tokenlist is a list of Token items

C++ class: http://cppcheck.net/devinfo/doxyoutput/classToken.html

Attributes:

str Token string

next Next token in tokenlist. For last token, next is None.

previous Previous token in tokenlist. For first token, previous is None.

link Linked token in tokenlist. Each '(', '[' and '{' are linked to the

corresponding '}', ']' and ')'. For templates, the '<' is linked to

the corresponding '>'.

scope Scope information for this token. See the Scope class.

isName Is this token a symbol name

isNumber Is this token a number, for example 123, 12.34

isInt Is this token a int value such as 1234

isFloat Is this token a int value such as 12.34

isString Is this token a string literal such as "hello"

strlen string length for string literal

isChar Is this token a char literal such as 'x'

isOp Is this token a operator

isArithmeticalOp Is this token a arithmetic operator

isAssignmentOp Is this token a assignment operator

isComparisonOp Is this token a comparison operator

isLogicalOp Is this token a logical operator: && ||

isUnsigned Is this token a unsigned type

isSigned Is this token a signed type

varId varId for token, each variable has a unique non-zero id

variable Variable information for this token. See the Variable class.

function If this token points at a function call, this attribute has the Function

information. See the Function class.

values Possible values of token

valueType type information

typeScope type scope (token->type()->classScope)

astParent ast parent

astOperand1 ast operand1

astOperand2 ast operand2

file file name

linenr line number

To iterate through all tokens use such code:

@code

data = cppcheckdata.parsedump(...)

for cfg in data.configurations:

code = ''

for token in cfg.tokenlist:

code = code + token.str + ' '

print(code)

@endcode

"""

Id = None

str = None

next = None

previous = None

linkId = None

link = None

scopeId = None

scope = None

isName = False

isNumber = False

isInt = False

isFloat = False

isString = False

strlen = None

isChar = False

isOp = False

isArithmeticalOp = False

isAssignmentOp = False

isComparisonOp = False

isLogicalOp = False

isUnsigned = False

isSigned = False

varId = None

variableId = None

variable = None

functionId = None

function = None

valuesId = None

values = None

valueType = None

typeScopeId = None

typeScope = None

astParentId = None

astParent = None

astOperand1Id = None

astOperand1 = None

astOperand2Id = None

astOperand2 = None

file = None

linenr = None

def __init__(self, element):

self.Id = element.get('id')

self.str = element.get('str')

self.next = None

self.previous = None

self.scopeId = element.get('scope')

self.scope = None

type = element.get('type')

if type == 'name':

self.isName = True

if element.get('isUnsigned'):

self.isUnsigned = True

if element.get('isSigned'):

self.isSigned = True

elif type == 'number':

self.isNumber = True

if element.get('isInt'):

self.isInt = True

elif element.get('isFloat'):

self.isFloat = True

elif type == 'string':

self.isString = True

self.strlen = int(element.get('strlen'))

elif type == 'char':

self.isChar = True

elif type == 'op':

self.isOp = True

if element.get('isArithmeticalOp'):

self.isArithmeticalOp = True

elif element.get('isAssignmentOp'):

self.isAssignmentOp = True

elif element.get('isComparisonOp'):

self.isComparisonOp = True

elif element.get('isLogicalOp'):

self.isLogicalOp = True

self.linkId = element.get('link')

self.link = None

self.varId = element.get('varId')

self.variableId = element.get('variable')

self.variable = None

self.functionId = element.get('function')

self.function = None

self.valuesId = element.get('values')

self.values = None

if element.get('valueType-type'):

self.valueType = ValueType(element)

else:

self.valueType = None

self.typeScopeId = element.get('type-scope')

self.typeScope = None

self.astParentId = element.get('astParent')

self.astParent = None

self.astOperand1Id = element.get('astOperand1')

self.astOperand1 = None

self.astOperand2Id = element.get('astOperand2')

self.astOperand2 = None

self.file = element.get('file')

self.linenr = element.get('linenr')

def setId(self, IdMap):

self.scope = IdMap[self.scopeId]

self.link = IdMap[self.linkId]

self.variable = IdMap[self.variableId]

self.function = IdMap[self.functionId]

self.values = IdMap[self.valuesId]

self.typeScope = IdMap[self.typeScopeId]

self.astParent = IdMap[self.astParentId]

self.astOperand1 = IdMap[self.astOperand1Id]

self.astOperand2 = IdMap[self.astOperand2Id]

if self.valueType:

self.valueType.setId(IdMap)

def getValue(self, v):

"""

Get value if it exists

Returns None if it doesn't exist

"""

if not self.values:

return None

for value in self.values:

if value.intvalue == v:

return value

return None

class Scope:

"""

Scope. Information about global scope, function scopes, class scopes, inner scopes, etc.

C++ class: http://cppcheck.net/devinfo/doxyoutput/classScope.html

Attributes

bodyStart The { Token for this scope

bodyEnd The } Token for this scope

className Name of this scope.

For a function scope, this is the function name;

For a class scope, this is the class name.

type Type of scope: Global, Function, Class, If, While

"""

Id = None

bodyStartId = None

bodyStart = None

bodyEndId = None

bodyEnd = None

className = None

nestedInId = None

nestedIn = None

type = None

def __init__(self, element):

self.Id = element.get('id')

self.className = element.get('className')

self.bodyStartId = element.get('bodyStart')

self.bodyStart = None

self.bodyEndId = element.get('bodyEnd')

self.bodyEnd = None

self.nestedInId = element.get('nestedIn')

self.nestedIn = None

self.type = element.get('type')

def setId(self, IdMap):

self.bodyStart = IdMap[self.bodyStartId]

self.bodyEnd = IdMap[self.bodyEndId]

self.nestedIn = IdMap[self.nestedInId]

class Function:

"""

Information about a function

C++ class:

http://cppcheck.net/devinfo/doxyoutput/classFunction.html

"""

Id = None

argument = None

argumentId = None

tokenDef = None

tokenDefId = None

name = None

type = None

isVirtual = None

isImplicitlyVirtual = None

def __init__(self, element):

self.Id = element.get('id')

self.tokenDefId = element.get('tokenDef')

self.name = element.get('name')

self.type = element.get('type')

isVirtual = element.get('isVirtual')

self.isVirtual = (isVirtual and isVirtual == 'true')

isImplicitlyVirtual = element.get('isImplicitlyVirtual')

self.isImplicitlyVirtual = (isImplicitlyVirtual and isImplicitlyVirtual == 'true')

self.argument = {}

self.argumentId = {}

for arg in element:

self.argumentId[int(arg.get('nr'))] = arg.get('variable')

def setId(self, IdMap):

for argnr, argid in self.argumentId.items():

self.argument[argnr] = IdMap[argid]

self.tokenDef = IdMap[self.tokenDefId]

class Variable:

"""

Information about a variable

C++ class:

http://cppcheck.net/devinfo/doxyoutput/classVariable.html

Attributes:

nameToken Name token in variable declaration

typeStartToken Start token of variable declaration

typeEndToken End token of variable declaration

access Global/Local/Namespace/Public/Protected/Public/Throw/Argument

scope Variable scope

isArgument Is this variable a function argument?

isArray Is this variable an array?

isClass Is this variable a class or struct?

isConst Is this variable a const variable?

isExtern Is this variable an extern variable?

isLocal Is this variable a local variable?

isPointer Is this variable a pointer

isReference Is this variable a reference

isStatic Is this variable static?

constness Variable constness (same encoding as ValueType::constness)

"""

Id = None

nameTokenId = None

nameToken = None

typeStartTokenId = None

typeStartToken = None

typeEndTokenId = None

typeEndToken = None

access = None

scopeId = None

scope = None

isArgument = False

isArray = False

isClass = False

isConst = False

isExtern = False

isLocal = False

isPointer = False

isReference = False

isStatic = False

constness = 0

def __init__(self, element):

self.Id = element.get('id')

self.nameTokenId = element.get('nameToken')

self.nameToken = None

self.typeStartTokenId = element.get('typeStartToken')

self.typeStartToken = None

self.typeEndTokenId = element.get('typeEndToken')

self.typeEndToken = None

self.access = element.get('access')

self.scopeId = element.get('scope')

self.scope = None

self.isArgument = element.get('isArgument') == 'true'

self.isArray = element.get('isArray') == 'true'

self.isClass = element.get('isClass') == 'true'

self.isConst = element.get('isConst') == 'true'

self.isExtern = element.get('isExtern') == 'true'

self.isLocal = element.get('isLocal') == 'true'

self.isPointer = element.get('isPointer') == 'true'

self.isReference = element.get('isReference') == 'true'

self.isStatic = element.get('isStatic') == 'true'

self.constness = element.get('constness')

if self.constness:

self.constness = int(self.constness)

def setId(self, IdMap):

self.nameToken = IdMap[self.nameTokenId]

self.typeStartToken = IdMap[self.typeStartTokenId]

self.typeEndToken = IdMap[self.typeEndTokenId]

self.scope = IdMap[self.scopeId]

class ValueFlow:

"""

ValueFlow::Value class

Each possible value has a ValueFlow::Value item.

Each ValueFlow::Value either has a intvalue or tokvalue

C++ class:

http://cppcheck.net/devinfo/doxyoutput/classValueFlow_1_1Value.html

Attributes:

values Possible values

"""

Id = None

values = None

class Value:

"""

Value class

Attributes:

intvalue integer value

tokvalue token value

condition condition where this Value comes from

"""

intvalue = None

tokvalue = None

condition = None

def __init__(self, element):

self.intvalue = element.get('intvalue')

if self.intvalue:

self.intvalue = int(self.intvalue)

self.tokvalue = element.get('tokvalue')

self.condition = element.get('condition-line')

if self.condition:

self.condition = int(self.condition)

def __init__(self, element):

self.Id = element.get('id')

self.values = []

for value in element:

self.values.append(ValueFlow.Value(value))

class Suppression:

"""

Suppression class

This class contains a suppression entry to suppress a warning.

Attributes

errorId The id string of the error to suppress, can be a wildcard

fileName The name of the file to suppress warnings for, can include wildcards

lineNumber The number of the line to suppress warnings from, can be 0 to represent any line

symbolName The name of the symbol to match warnings for, can include wildcards

"""

errorId = None

fileName = None

lineNumber = None

symbolName = None

def __init__(self, element):

self.errorId = element.get('errorId')

self.fileName = element.get('fileName')

self.lineNumber = element.get('lineNumber')

self.symbolName = element.get('symbolName')

def isMatch(self, file, line, message, errorId):

if ((self.fileName is None or fnmatch(file, self.fileName))

and (self.lineNumber is None or line == self.lineNumber)

and (self.symbolName is None or fnmatch(message, '*'+self.symbolName+'*'))

and fnmatch(errorId, self.errorId)):

return True

else:

return False

class Configuration:

"""

Configuration class

This class contains the directives, tokens, scopes, functions,

variables, value flows, and suppressions for one configuration.

Attributes:

name Name of the configuration, "" for default

directives List of Directive items

tokenlist List of Token items

scopes List of Scope items

functions List of Function items

variables List of Variable items

valueflow List of ValueFlow values

"""

name = ''

directives = []

tokenlist = []

scopes = []

functions = []

variables = []

valueflow = []

def __init__(self, confignode):

self.name = confignode.get('cfg')

self.directives = []

self.tokenlist = []

self.scopes = []

self.functions = []

self.variables = []

self.valueflow = []

arguments = []

for element in confignode:

if element.tag == 'directivelist':

for directive in element:

self.directives.append(Directive(directive))

if element.tag == 'tokenlist':

for token in element:

self.tokenlist.append(Token(token))

# set next/previous..

prev = None

for token in self.tokenlist:

token.previous = prev

if prev:

prev.next = token

prev = token

if element.tag == 'scopes':

for scope in element:

self.scopes.append(Scope(scope))

for functionList in scope:

if functionList.tag == 'functionList':

for function in functionList:

self.functions.append(Function(function))

if element.tag == 'variables':

for variable in element:

var = Variable(variable)

if var.nameTokenId:

self.variables.append(var)

else:

arguments.append(var)

if element.tag == 'valueflow':

for values in element:

self.valueflow.append(ValueFlow(values))

IdMap = {None: None, '0': None, '00000000': None, '0000000000000000': None}

for token in self.tokenlist:

IdMap[token.Id] = token

for scope in self.scopes:

IdMap[scope.Id] = scope

for function in self.functions:

IdMap[function.Id] = function

for variable in self.variables:

IdMap[variable.Id] = variable

for variable in arguments:

IdMap[variable.Id] = variable

for values in self.valueflow:

IdMap[values.Id] = values.values

for token in self.tokenlist:

token.setId(IdMap)

for scope in self.scopes:

scope.setId(IdMap)

for function in self.functions:

function.setId(IdMap)

for variable in self.variables:

variable.setId(IdMap)

for variable in arguments:

variable.setId(IdMap)

class Platform:

"""

Platform class

This class contains type sizes

Attributes:

name Name of the platform

char_bit CHAR_BIT value

short_bit SHORT_BIT value

int_bit INT_BIT value

long_bit LONG_BIT value

long_long_bit LONG_LONG_BIT value

pointer_bit POINTER_BIT value

"""

name = ''

char_bit = 0

short_bit = 0

int_bit = 0

long_bit = 0

long_long_bit = 0

pointer_bit = 0

def __init__(self, platformnode):

self.name = platformnode.get('name')

self.char_bit = int(platformnode.get('char_bit'))

self.short_bit = int(platformnode.get('short_bit'))

self.int_bit = int(platformnode.get('int_bit'))

self.long_bit = int(platformnode.get('long_bit'))

self.long_long_bit = int(platformnode.get('long_long_bit'))

self.pointer_bit = int(platformnode.get('pointer_bit'))

class CppcheckData:

"""

Class that makes cppcheck dump data available

Contains a list of Configuration instances

Attributes:

configurations List of Configurations

To iterate through all configurations use such code:

@code

data = cppcheckdata.parsedump(...)

for cfg in data.configurations:

print('cfg: ' + cfg.name)

@endcode

To iterate through all tokens in each configuration use such code:

@code

data = cppcheckdata.parsedump(...)

for cfg in data.configurations:

print('cfg: ' + cfg.name)

code = ''

for token in cfg.tokenlist:

code = code + token.str + ' '

print(' ' + code)

@endcode

To iterate through all scopes (functions, types, etc) use such code:

@code

data = cppcheckdata.parsedump(...)

for cfg in data.configurations:

print('cfg: ' + cfg.name)

for scope in cfg.scopes:

print(' type:' + scope.type + ' name:' + scope.className)

@endcode

"""

rawTokens = []

platform = None

configurations = []

suppressions = []

def __init__(self, filename):

self.configurations = []

data = ET.parse(filename)

for platformNode in data.getroot():

if platformNode.tag == 'platform':

self.platform = Platform(platformNode)

for rawTokensNode in data.getroot():

if rawTokensNode.tag != 'rawtokens':

continue

files = []

for node in rawTokensNode:

if node.tag == 'file':

files.append(node.get('name'))

elif node.tag == 'tok':

tok = Token(node)

tok.file = files[int(node.get('fileIndex'))]

self.rawTokens.append(tok)

for i in range(len(self.rawTokens) - 1):

self.rawTokens[i + 1].previous = self.rawTokens[i]

self.rawTokens[i].next = self.rawTokens[i + 1]

for suppressionsNode in data.getroot():

if suppressionsNode.tag == "suppressions":

for suppression in suppressionsNode:

self.suppressions.append(Suppression(suppression))

# root is 'dumps' node, each config has its own 'dump' subnode.

for cfgnode in data.getroot():

if cfgnode.tag == 'dump':

self.configurations.append(Configuration(cfgnode))

def parsedump(filename):

"""

parse a cppcheck dump file

"""

return CppcheckData(filename)

def astIsFloat(token):

"""

Check if type of ast node is float/double

"""

if not token:

return False

if token.str == '.':

return astIsFloat(token.astOperand2)

if token.str in '+-*/%':

return astIsFloat(token.astOperand1) or astIsFloat(token.astOperand2)

if not token.variable:

# float literal?

if token.str[0].isdigit():

for c in token.str:

if c == 'f' or c == '.' or c == 'E':

return True

return False

typeToken = token.variable.typeStartToken

endToken = token.variable.typeEndToken

while typeToken != endToken:

if typeToken.str == 'float' or typeToken.str == 'double':

return True

typeToken = typeToken.next

if typeToken.str == 'float' or typeToken.str == 'double':

return True

return False

class CppCheckFormatter(argparse.HelpFormatter):

"""

Properly formats multiline argument helps

"""

def _split_lines(self, text, width):

# this is the RawTextHelpFormatter._split_lines

if text.startswith('R|'):

return text[2:].splitlines()

return argparse.HelpFormatter._split_lines(self, text, width)

def ArgumentParser():

"""

Returns an argparse argument parser with an already-added

argument definition for -t/--template

"""

parser = argparse.ArgumentParser(formatter_class=CppCheckFormatter)

parser.add_argument('-t', '--template', metavar='<text>',

default='{callstack}: ({severity}) {message}',

help="R|Format the error messages. E.g.\n"

"'{file}:{line},{severity},{id},{message}' or\n"

"'{file}({line}):({severity}) {message}' or\n"

"'{callstack} {message}'\n"

"Pre-defined templates: gcc, vs, edit")

return parser

def reportError(template, callstack=(), severity='', message='', errorId='', suppressions=None, outputFunc=None):

"""

Format an error message according to the template.

:param template: format string, or 'gcc', 'vs' or 'edit'.

:param callstack: e.g. [['file1.cpp',10],['file2.h','20'], ... ]

:param severity: e.g. 'error', 'warning' ...

:param id: message ID.

:param message: message text.

"""

# expand predefined templates

if template == 'gcc':

template = '{file}:{line}: {severity}: {message}'

elif template == 'vs':

template = '{file}({line}): {severity}: {message}'

elif template == 'edit':

template = '{file} +{line}: {severity}: {message}'

# compute 'callstack}, {file} and {line} replacements

stack = ' -> '.join('[' + f + ':' + str(l) + ']' for (f, l) in callstack)

file = callstack[-1][0]

line = str(callstack[-1][1])

if suppressions is not None and any(suppression.isMatch(file, line, message, errorId) for suppression in suppressions):

return None

outputLine = template.format(callstack=stack, file=file, line=line,

severity=severity, message=message, id=errorId)

if outputFunc is not None:

outputFunc(outputLine)

# format message

return outputLine

cppcheck/addons/cppcheckdata.py at master · 2php/cppcheck · GitHub

Expand file tree

Breadcrumbs

cppcheckdata.py

Latest commit

History

Breadcrumbs

cppcheckdata.py

File metadata and controls