node/tools/cpplint.py at patch-1 · computerscienceiscool/node · GitHub

History

executable file

8035 lines (6992 loc) · 298 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

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

#!/usr/bin/env python3

# Redistribution and use in source and binary forms, with or without

# modification, are permitted provided that the following conditions are

# met:

# * Redistributions of source code must retain the above copyright

# notice, this list of conditions and the following disclaimer.

# * Redistributions in binary form must reproduce the above

# copyright notice, this list of conditions and the following disclaimer

# in the documentation and/or other materials provided with the

# distribution.

# * Neither the name of Google Inc. nor the names of its

# contributors may be used to endorse or promote products derived from

# this software without specific prior written permission.

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""Does google-lint on c++ files.

The goal of this script is to identify places in the code that *may*

be in non-compliance with google style. It does not attempt to fix

up these problems -- the point is to educate. It does also not

attempt to find all problems, or to ensure that everything it does

find is legitimately a problem.

In particular, we can get very confused by /* and // inside strings!

We do a small hack, which is to ignore //'s with "'s after them on the

same line, but it is far from perfect (in either direction).

"""

from __future__ import annotations # PEP 604 not in 3.9

import codecs

import collections

import copy

import getopt

import glob

import itertools

import math # for log

import os

import re

import string

import sys

import sysconfig

import unicodedata

import xml.etree.ElementTree

# if empty, use defaults

_valid_extensions: set[str] = set()

__VERSION__ = "2.0.3-dev0"

_USAGE = """

[--filter=-x,+y,...]

[--counting=total|toplevel|detailed] [--root=subdir]

[--repository=path]

[--linelength=digits] [--headers=x,y,...] [--third_party_headers=pattern]

[--recursive]

[--exclude=path]

[--extensions=hpp,cpp,...]

[--includeorder=default|standardcfirst]

[--config=filename]

[--quiet]

[--version]

<file> [file] ...

Style checker for C/C++ source files.

This is a fork of the Google style checker with minor extensions.

The style guidelines this tries to follow are those in

https://google.github.io/styleguide/cppguide.html

Every problem is given a confidence score from 1-5, with 5 meaning we are

certain of the problem, and 1 meaning it could be a legitimate construct.

This will miss some errors, and is not a substitute for a code review.

To suppress false-positive errors of certain categories, add a

'NOLINT(category[, category...])' comment to the line. NOLINT or NOLINT(*)

suppresses errors of all categories on that line. To suppress categories

on the next line use NOLINTNEXTLINE instead of NOLINT. To suppress errors in

a block of code 'NOLINTBEGIN(category[, category...])' comment to a line at

the start of the block and to end the block add a comment with 'NOLINTEND'.

NOLINT blocks are inclusive so any statements on the same line as a BEGIN

or END will have the error suppression applied.

The files passed in will be linted; at least one file must be provided.

Default linted extensions are %s.

Other file types will be ignored.

Change the extensions with the --extensions flag.

Flags:

By default, the output is formatted to ease emacs parsing. Visual Studio

compatible output (vs7) may also be used. Further support exists for

eclipse (eclipse), and JUnit (junit). XML parsers such as those used

in Jenkins and Bamboo may also be used.

The sed format outputs sed commands that should fix some of the errors.

Note that this requires gnu sed. If that is installed as gsed on your

system (common e.g. on macOS with homebrew) you can use the gsed output

format. Sed commands are written to stdout, not stderr, so you should be

able to pipe output straight to a shell to run the fixes.

verbose=#

Specify a number 0-5 to restrict errors to certain verbosity levels.

Errors with lower verbosity levels have lower confidence and are more

likely to be false positives.

quiet

Don't print anything if no errors are found.

filter=-x,+y,...

Specify a comma-separated list of category-filters to apply: only

error messages whose category names pass the filters will be printed.

(Category names are printed with the message and look like

"[whitespace/indent]".) Filters are evaluated left to right.

"-FOO" means "do not print categories that start with FOO".

"+FOO" means "do print categories that start with FOO".

Examples: --filter=-whitespace,+whitespace/braces

--filter=-whitespace,-runtime/printf,+runtime/printf_format

--filter=-,+build/include_what_you_use

To see a list of all the categories used in cpplint, pass no arg:

--filter=

Filters can directly be limited to files and also line numbers. The

syntax is category:file:line , where line is optional. The filter limitation

works for both + and - and can be combined with ordinary filters:

Examples: --filter=-whitespace:foo.h,+whitespace/braces:foo.h

--filter=-whitespace,-runtime/printf:foo.h:14,+runtime/printf_format:foo.h

--filter=-,+build/include_what_you_use:foo.h:321

counting=total|toplevel|detailed

The total number of errors found is always printed. If

'toplevel' is provided, then the count of errors in each of

the top-level categories like 'build' and 'whitespace' will

also be printed. If 'detailed' is provided, then a count

is provided for each category like 'legal/copyright'.

repository=path

The top level directory of the repository, used to derive the header

guard CPP variable. By default, this is determined by searching for a

path that contains .git, .hg, or .svn. When this flag is specified, the

given path is used instead. This option allows the header guard CPP

variable to remain consistent even if members of a team have different

repository root directories (such as when checking out a subdirectory

with SVN). In addition, users of non-mainstream version control systems

can use this flag to ensure readable header guard CPP variables.

Examples:

Assuming that Alice checks out ProjectName and Bob checks out

ProjectName/trunk and trunk contains src/chrome/ui/browser.h, then

with no --repository flag, the header guard CPP variable will be:

Alice => TRUNK_SRC_CHROME_BROWSER_UI_BROWSER_H_

Bob => SRC_CHROME_BROWSER_UI_BROWSER_H_

If Alice uses the --repository=trunk flag and Bob omits the flag or

uses --repository=. then the header guard CPP variable will be:

Alice => SRC_CHROME_BROWSER_UI_BROWSER_H_

Bob => SRC_CHROME_BROWSER_UI_BROWSER_H_

root=subdir

The root directory used for deriving header guard CPP variable.

This directory is relative to the top level directory of the repository

which by default is determined by searching for a directory that contains

.git, .hg, or .svn but can also be controlled with the --repository flag.

If the specified directory does not exist, this flag is ignored.

Examples:

Assuming that src is the top level directory of the repository (and

cwd=top/src), the header guard CPP variables for

src/chrome/browser/ui/browser.h are:

No flag => CHROME_BROWSER_UI_BROWSER_H_

--root=chrome => BROWSER_UI_BROWSER_H_

--root=chrome/browser => UI_BROWSER_H_

--root=.. => SRC_CHROME_BROWSER_UI_BROWSER_H_

linelength=digits

This is the allowed line length for the project. The default value is

80 characters.

Examples:

--linelength=120

recursive

Search for files to lint recursively. Each directory given in the list

of files to be linted is replaced by all files that descend from that

directory. Files with extensions not in the valid extensions list are

excluded.

exclude=path

Exclude the given path from the list of files to be linted. Relative

paths are evaluated relative to the current directory and shell globbing

is performed. This flag can be provided multiple times to exclude

multiple files.

Examples:

--exclude=one.cc

--exclude=src/*.cc

--exclude=src/*.cc --exclude=test/*.cc

extensions=extension,extension,...

The allowed file extensions that cpplint will check

Examples:

--extensions=%s

includeorder=default|standardcfirst

For the build/include_order rule, the default is to blindly assume angle

bracket includes with file extension are c-system-headers (default),

even knowing this will have false classifications.

The default is established at google.

standardcfirst means to instead use an allow-list of known c headers and

treat all others as separate group of "other system headers". The C headers

included are those of the C-standard lib and closely related ones.

config=filename

Search for config files with the specified name instead of CPPLINT.cfg

headers=x,y,...

The header extensions that cpplint will treat as .h in checks. Values are

automatically added to --extensions list.

(by default, only files with extensions %s will be assumed to be headers)

third_party_headers=pattern

Regex for identifying third-party headers to exclude from include checks.

Examples:

--headers=%s

--headers=hpp,hxx

--headers=hpp

cpplint.py supports per-directory configurations specified in CPPLINT.cfg

files. CPPLINT.cfg file can contain a number of key=value pairs.

Currently the following options are supported:

set noparent

filter=+filter1,-filter2,...

exclude_files=regex

linelength=80

root=subdir

headers=x,y,...

third_party_headers=pattern

"set noparent" option prevents cpplint from traversing directory tree

upwards looking for more .cfg files in parent directories. This option

is usually placed in the top-level project directory.

The "filter" option is similar in function to --filter flag. It specifies

message filters in addition to the |_DEFAULT_FILTERS| and those specified

through --filter command-line flag.

"exclude_files" allows to specify a regular expression to be matched against

a file name. If the expression matches, the file is skipped and not run

through the linter.

"linelength" allows to specify the allowed line length for the project.

The "root" option is similar in function to the --root flag (see example

above). Paths are relative to the directory of the CPPLINT.cfg.

The "headers" option is similar in function to the --headers flag

(see example above).

CPPLINT.cfg has an effect on files in the same directory and all

sub-directories, unless overridden by a nested configuration file.

Example file:

filter=-build/include_order,+build/include_alpha

exclude_files=.*\\.cc

The above example disables build/include_order warning and enables

build/include_alpha as well as excludes all .cc from being

processed by linter, in the current directory (where the .cfg

file is located) and all sub-directories.

"""

# We categorize each error message we print. Here are the categories.

# We want an explicit list so we can list them all in cpplint --filter=.

# If you add a new error message with a new category, add it to the list

# here! cpplint_unittest.py should tell you if you forget to do this.

_ERROR_CATEGORIES = [

"build/c++11",

"build/c++17",

"build/deprecated",

"build/endif_comment",

"build/explicit_make_pair",

"build/forward_decl",

"build/header_guard",

"build/include",

"build/include_alpha",

"build/include_inline",

"build/include_order",

"build/include_subdir",

"build/include_what_you_use",

"build/namespaces_headers",

"build/namespaces/header/block/literals",

"build/namespaces/header/block/nonliterals",

"build/namespaces/header/namespace/literals",

"build/namespaces/header/namespace/nonliterals",

"build/namespaces/source/block/literals",

"build/namespaces/source/block/nonliterals",

"build/namespaces/source/namespace/literals",

"build/namespaces/source/namespace/nonliterals",

"build/printf_format",

"build/storage_class",

"legal/copyright",

"readability/alt_tokens",

"readability/braces",

"readability/casting",

"readability/check",

"readability/constructors",

"readability/fn_size",

"readability/inheritance",

"readability/multiline_comment",

"readability/multiline_string",

"readability/namespace",

"readability/nolint",

"readability/nul",

"readability/todo",

"readability/utf8",

"runtime/arrays",

"runtime/casting",

"runtime/explicit",

"runtime/int",

"runtime/init",

"runtime/invalid_increment",

"runtime/member_string_references",

"runtime/memset",

"runtime/operator",

"runtime/printf",

"runtime/printf_format",

"runtime/references",

"runtime/string",

"runtime/threadsafe_fn",

"runtime/vlog",

"runtime/v8_persistent",

"whitespace/blank_line",

"whitespace/braces",

"whitespace/comma",

"whitespace/comments",

"whitespace/empty_conditional_body",

"whitespace/empty_if_body",

"whitespace/empty_loop_body",

"whitespace/end_of_line",

"whitespace/ending_newline",

"whitespace/forcolon",

"whitespace/indent",

"whitespace/indent_namespace",

"whitespace/line_length",

"whitespace/newline",

"whitespace/operators",

"whitespace/parens",

"whitespace/semicolon",

"whitespace/tab",

"whitespace/todo",

]

# keywords to use with --outputs which generate stdout for machine processing

_MACHINE_OUTPUTS = ["junit", "sed", "gsed"]

# These error categories are no longer enforced by cpplint, but for backwards-

# compatibility they may still appear in NOLINT comments.

_LEGACY_ERROR_CATEGORIES = [

"build/class",

"readability/streams",

"readability/function",

]

# These prefixes for categories should be ignored since they relate to other

# tools which also use the NOLINT syntax, e.g. clang-tidy.

_OTHER_NOLINT_CATEGORY_PREFIXES = [

"clang-analyzer-",

"abseil-",

"altera-",

"android-",

"boost-",

"bugprone-",

"cert-",

"concurrency-",

"cppcoreguidelines-",

"darwin-",

"fuchsia-",

"google-",

"hicpp-",

"linuxkernel-",

"llvm-",

"llvmlibc-",

"misc-",

"modernize-",

"mpi-",

"objc-",

"openmp-",

"performance-",

"portability-",

"readability-",

"zircon-",

]

# The default state of the category filter. This is overridden by the --filter=

# flag. By default all errors are on, so only add here categories that should be

# off by default (i.e., categories that must be enabled by the --filter= flags).

# All entries here should start with a '-' or '+', as in the --filter= flag.

_DEFAULT_FILTERS = [

"-build/include_alpha",

"-readability/fn_size",

"-runtime/references",

]

# The default list of categories suppressed for C (not C++) files.

_DEFAULT_C_SUPPRESSED_CATEGORIES = [

"readability/casting",

]

# The default list of categories suppressed for Linux Kernel files.

_DEFAULT_KERNEL_SUPPRESSED_CATEGORIES = [

"whitespace/tab",

]

# We used to check for high-bit characters, but after much discussion we

# decided those were OK, as long as they were in UTF-8 and didn't represent

# hard-coded international strings, which belong in a separate i18n file.

# C++ headers

_CPP_HEADERS = frozenset(

[

# Legacy

"algobase.h",

"algo.h",

"alloc.h",

"builtinbuf.h",

"bvector.h",

# 'complex.h', collides with System C header "complex.h" since C11

"defalloc.h",

"deque.h",

"editbuf.h",

"fstream.h",

"function.h",

"hash_map",

"hash_map.h",

"hash_set",

"hash_set.h",

"hashtable.h",

"heap.h",

"indstream.h",

"iomanip.h",

"iostream.h",

"istream.h",

"iterator.h",

"list.h",

"map.h",

"multimap.h",

"multiset.h",

"ostream.h",

"pair.h",

"parsestream.h",

"pfstream.h",

"procbuf.h",

"pthread_alloc",

"pthread_alloc.h",

"rope",

"rope.h",

"ropeimpl.h",

"set.h",

"slist",

"slist.h",

"stack.h",

"stdiostream.h",

"stl_alloc.h",

"stl_relops.h",

"streambuf.h",

"stream.h",

"strfile.h",

"strstream.h",

"tempbuf.h",

"tree.h",

"type_traits.h",

"vector.h",

# C++ library headers

"algorithm",

"array",

"atomic",

"bitset",

"chrono",

"codecvt",

"complex",

"condition_variable",

"deque",

"exception",

"forward_list",

"fstream",

"functional",

"future",

"initializer_list",

"iomanip",

"ios",

"iosfwd",

"iostream",

"istream",

"iterator",

"limits",

"list",

"locale",

"map",

"memory",

"mutex",

"new",

"numeric",

"ostream",

"queue",

"random",

"ratio",

"regex",

"scoped_allocator",

"set",

"sstream",

"stack",

"stdexcept",

"streambuf",

"string",

"strstream",

"system_error",

"thread",

"tuple",

"typeindex",

"typeinfo",

"type_traits",

"unordered_map",

"unordered_set",

"utility",

"valarray",

"vector",

# C++14 headers

"shared_mutex",

# C++17 headers

"any",

"charconv",

"codecvt",

"execution",

"filesystem",

"memory_resource",

"optional",

"string_view",

"variant",

# C++20 headers

"barrier",

"bit",

"compare",

"concepts",

"coroutine",

"format",

"latch",

"numbers",

"ranges",

"semaphore",

"source_location",

"span",

"stop_token",

"syncstream",

"version",

# C++23 headers

"expected",

"flat_map",

"flat_set",

"generator",

"mdspan",

"print",

"spanstream",

"stacktrace",

"stdfloat",

# C++ headers for C library facilities

"cassert",

"ccomplex",

"cctype",

"cerrno",

"cfenv",

"cfloat",

"cinttypes",

"ciso646",

"climits",

"clocale",

"cmath",

"csetjmp",

"csignal",

"cstdalign",

"cstdarg",

"cstdbool",

"cstddef",

"cstdint",

"cstdio",

"cstdlib",

"cstring",

"ctgmath",

"ctime",

"cuchar",

"cwchar",

"cwctype",

]

)

# C headers

_C_HEADERS = frozenset(

[

# System C headers

"assert.h",

"complex.h",

"ctype.h",

"errno.h",

"fenv.h",

"float.h",

"inttypes.h",

"iso646.h",

"limits.h",

"locale.h",

"math.h",

"setjmp.h",

"signal.h",

"stdalign.h",

"stdarg.h",

"stdatomic.h",

"stdbool.h",

"stddef.h",

"stdint.h",

"stdio.h",

"stdlib.h",

"stdnoreturn.h",

"string.h",

"tgmath.h",

"threads.h",

"time.h",

"uchar.h",

"wchar.h",

"wctype.h",

# C23 headers

"stdbit.h",

"stdckdint.h",

# additional POSIX C headers

"aio.h",

"arpa/inet.h",

"cpio.h",

"dirent.h",

"dlfcn.h",

"fcntl.h",

"fmtmsg.h",

"fnmatch.h",

"ftw.h",

"glob.h",

"grp.h",

"iconv.h",

"langinfo.h",

"libgen.h",

"monetary.h",

"mqueue.h",

"ndbm.h",

"net/if.h",

"netdb.h",

"netinet/in.h",

"netinet/tcp.h",

"nl_types.h",

"poll.h",

"pthread.h",

"pwd.h",

"regex.h",

"sched.h",

"search.h",

"semaphore.h",

"setjmp.h",

"signal.h",

"spawn.h",

"strings.h",

"stropts.h",

"syslog.h",

"tar.h",

"termios.h",

"trace.h",

"ulimit.h",

"unistd.h",

"utime.h",

"utmpx.h",

"wordexp.h",

# additional GNUlib headers

"a.out.h",

"aliases.h",

"alloca.h",

"ar.h",

"argp.h",

"argz.h",

"byteswap.h",

"crypt.h",

"endian.h",

"envz.h",

"err.h",

"error.h",

"execinfo.h",

"fpu_control.h",

"fstab.h",

"fts.h",

"getopt.h",

"gshadow.h",

"ieee754.h",

"ifaddrs.h",

"libintl.h",

"mcheck.h",

"mntent.h",

"obstack.h",

"paths.h",

"printf.h",

"pty.h",

"resolv.h",

"shadow.h",

"sysexits.h",

"ttyent.h",

# Additional linux glibc headers

"dlfcn.h",

"elf.h",

"features.h",

"gconv.h",

"gnu-versions.h",

"lastlog.h",

"libio.h",

"link.h",

"malloc.h",

"memory.h",

"netash/ash.h",

"netatalk/at.h",

"netax25/ax25.h",

"neteconet/ec.h",

"netipx/ipx.h",

"netiucv/iucv.h",

"netpacket/packet.h",

"netrom/netrom.h",

"netrose/rose.h",

"nfs/nfs.h",

"nl_types.h",

"nss.h",

"re_comp.h",

"regexp.h",

"sched.h",

"sgtty.h",

"stab.h",

"stdc-predef.h",

"stdio_ext.h",

"syscall.h",

"termio.h",

"thread_db.h",

"ucontext.h",

"ustat.h",

"utmp.h",

"values.h",

"wait.h",

"xlocale.h",

# Hardware specific headers

"arm_neon.h",

"emmintrin.h",

"xmmintin.h",

]

)

# Folders of C libraries so commonly used in C++,

# that they have parity with standard C libraries.

C_STANDARD_HEADER_FOLDERS = frozenset(

[

# standard C library

"sys",

# glibc for linux

"arpa",

"asm-generic",

"bits",

"gnu",

"net",

"netinet",

"protocols",

"rpc",

"rpcsvc",

"scsi",

# linux kernel header

"drm",

"linux",

"misc",

"mtd",

"rdma",

"sound",

"video",

"xen",

]

)

# Type names

_TYPES = re.compile(

r"^(?:"

# [dcl.type.simple]

r"(char(16_t|32_t)?)|wchar_t|"

# [support.types]

r"(ptrdiff_t|size_t|max_align_t|nullptr_t)|"

# [cstdint.syn]

r"(u?int(_fast|_least)?(8|16|32|64)_t)|"

r"(u?int(max|ptr)_t)|"

r")$"

)

# Pattern for matching FileInfo.BaseName() against test file name

_test_suffixes = ["_test", "_regtest", "_unittest"]

_TEST_FILE_SUFFIX = "(" + "|".join(_test_suffixes) + r")$"

# Pattern that matches only complete whitespace, possibly across multiple lines.

_EMPTY_CONDITIONAL_BODY_PATTERN = re.compile(r"^\s*$", re.DOTALL)

# Assertion macros. These are defined in base/logging.h and

# testing/base/public/gunit.h.

_CHECK_MACROS = [

"DCHECK",

"CHECK",

"EXPECT_TRUE",

"ASSERT_TRUE",

"EXPECT_FALSE",

"ASSERT_FALSE",

]

# Replacement macros for CHECK/DCHECK/EXPECT_TRUE/EXPECT_FALSE

_CHECK_REPLACEMENT: dict[str, dict[str, str]] = {macro_var: {} for macro_var in _CHECK_MACROS}

for op, replacement in [

("==", "EQ"),

("!=", "NE"),

(">=", "GE"),

(">", "GT"),

("<=", "LE"),

("<", "LT"),

_CHECK_REPLACEMENT["DCHECK"][op] = f"DCHECK_{replacement}"

_CHECK_REPLACEMENT["CHECK"][op] = f"CHECK_{replacement}"

_CHECK_REPLACEMENT["EXPECT_TRUE"][op] = f"EXPECT_{replacement}"

_CHECK_REPLACEMENT["ASSERT_TRUE"][op] = f"ASSERT_{replacement}"

for op, inv_replacement in [

("==", "NE"),

("!=", "EQ"),

(">=", "LT"),

(">", "LE"),

("<=", "GT"),

("<", "GE"),

_CHECK_REPLACEMENT["EXPECT_FALSE"][op] = f"EXPECT_{inv_replacement}"

_CHECK_REPLACEMENT["ASSERT_FALSE"][op] = f"ASSERT_{inv_replacement}"

# Alternative tokens and their replacements. For full list, see section 2.5

# Alternative tokens [lex.digraph] in the C++ standard.

# Digraphs (such as '%:') are not included here since it's a mess to

# match those on a word boundary.

_ALT_TOKEN_REPLACEMENT = {

"and": "&&",

"bitor": "|",

"or": "||",

"xor": "^",

"compl": "~",

"bitand": "&",

"and_eq": "&=",

"or_eq": "|=",

"xor_eq": "^=",

"not": "!",

"not_eq": "!=",

}

# Compile regular expression that matches all the above keywords. The "[ =()]"

# bit is meant to avoid matching these keywords outside of boolean expressions.

# False positives include C-style multi-line comments and multi-line strings

# but those have always been troublesome for cpplint.

_ALT_TOKEN_REPLACEMENT_PATTERN = re.compile(

r"([ =()])(" + ("|".join(_ALT_TOKEN_REPLACEMENT.keys())) + r")([ (]|$)"

)

# These constants define types of headers for use with

# _IncludeState.CheckNextIncludeOrder().

_C_SYS_HEADER = 1

_CPP_SYS_HEADER = 2

_OTHER_SYS_HEADER = 3

_LIKELY_MY_HEADER = 4

_POSSIBLE_MY_HEADER = 5

_OTHER_HEADER = 6

# These constants define the current inline assembly state

_NO_ASM = 0 # Outside of inline assembly block

_INSIDE_ASM = 1 # Inside inline assembly block

_END_ASM = 2 # Last line of inline assembly block

_BLOCK_ASM = 3 # The whole block is an inline assembly block

# Match start of assembly blocks

_MATCH_ASM = re.compile(

r"^\s*(?:asm|_asm|__asm|__asm__)"

r"(?:\s+(volatile|__volatile__))?"

r"\s*[{(]"

)

# Match strings that indicate we're working on a C (not C++) file.

_SEARCH_C_FILE = re.compile(

r"\b(?:LINT_C_FILE|"

r"vim?:\s*.*(\s*|:)filetype=c(\s*|:|$))"

)

# Match string that indicates we're working on a Linux Kernel file.

_SEARCH_KERNEL_FILE = re.compile(r"\b(?:LINT_KERNEL_FILE)")

_NULL_TOKEN_PATTERN = re.compile(r'\bNULL\b')

_V8_PERSISTENT_PATTERN = re.compile(r'\bv8::Persistent\b')

_RIGHT_LEANING_POINTER_PATTERN = re.compile(r'[^=|(,\s><);&?:}]'

r'(?<!(sizeof|return))'

r'\s\*[a-zA-z_][0-9a-zA-z_]*')

# Commands for sed to fix the problem

_SED_FIXUPS = {

"Remove spaces around =": r"s/ = /=/",

"Remove spaces around !=": r"s/ != /!=/",

"Remove space before ( in if (": r"s/if (/if(/",

"Remove space before ( in for (": r"s/for (/for(/",

"Remove space before ( in while (": r"s/while (/while(/",

"Remove space before ( in switch (": r"s/switch (/switch(/",

"Should have a space between // and comment": r"s/\/\//\/\/ /",

"Missing space before {": r"s/$[^ ]${/\1 {/",

"Tab found, replace by spaces": r"s/\t/ /g",

"Line ends in whitespace. Consider deleting these extra spaces.": r"s/\s*$//",

"You don't need a ; after a }": r"s/};/}/",

"Missing space after ,": r"s/,$[^ ]$/, \1/g",

}

# Used for backwards compatibility and ease of use

_FILTER_SHORTCUTS = {

"build/namespaces_literals": [

"build/namespaces/header/block/literals",

"build/namespaces/header/namespace/literals",

"build/namespaces/source/block/literals",

"build/namespaces/source/namespace/literals",

]

}

# The root directory used for deriving header guard CPP variable.

# This is set by --root flag.

_root = None

_root_debug = False

# The top level repository directory. If set, _root is calculated relative to

# this directory instead of the directory containing version control artifacts.

# This is set by the --repository flag.

_repository = None

# Files to exclude from linting. This is set by the --exclude flag.

_excludes = None

# Whether to suppress all PrintInfo messages, UNRELATED to --quiet flag

_quiet = False

# The allowed line length of files.

# This is set by --linelength flag.

_line_length = 80

# This allows to use different include order rule than default

_include_order = "default"

# This allows different config files to be used

_config_filename = ".cpplint"

# Treat all headers starting with 'h' equally: .h, .hpp, .hxx etc.

# This is set by --headers flag.

_hpp_headers: set[str] = set()

# These headers are excluded from [build/include_subdir], [build/include_order], and

# [build/include_alpha]

# The default checks are following

# - Anything not following google file name conventions (containing an

# uppercase character, such as Python.h or nsStringAPI.h, for example).

# - Lua headers.

# Default pattern for third-party headers (uppercase .h or Lua headers).

_THIRD_PARTY_HEADERS_DEFAULT = r"^(?:[^/]*[A-Z][^/]*\.h|lua\.h|lauxlib\.h|lualib\.h)$"

_third_party_headers_pattern = re.compile(_THIRD_PARTY_HEADERS_DEFAULT)

class ErrorSuppressions:

View remainder of file in raw view

node/tools/cpplint.py at patch-1 · computerscienceiscool/node · GitHub

Navigation Menu

Expand file tree

Breadcrumbs

cpplint.py

Latest commit

History

Breadcrumbs

cpplint.py

File metadata and controls

Footer

Footer navigation