Functions
	_CheckApiTestFile (input_api, output_api)

	CheckChangeOnUpload (input_api, output_api)

	CheckChangeOnCommit (input_api, output_api)

	_CheckNoBannedFunctions (input_api, output_api)

	_CheckUnwantedDependencies (input_api, output_api)

	_CheckIncludeOrderForScope (scope, input_api, file_path, changed_linenums)

	_CheckIncludeOrderInFile (input_api, f, changed_linenums)

	_CheckIncludeOrder (input_api, output_api)

	_CheckLibcxxRevision (input_api, output_api)

	_CheckTestDuplicates (input_api, output_api)

	_CheckPngNames (input_api, output_api)

	_CheckUselessForwardDeclarations (input_api, output_api)

	ChecksCommon (input_api, output_api)

	_CheckPublicHeaders (input_api, output_api)

Variables
bool	USE_PYTHON3 = True

str	PRESUBMIT_VERSION = '2.0.0'

list	LINT_FILTERS

tuple	_INCLUDE_ORDER_WARNING

	_KNOWN_ROBOTS

str	_THIRD_PARTY = 'third_party/'

tuple	_BANNED_CPP_FUNCTIONS

Detailed Description

Presubmit script for pdfium.

See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
for more details about the presubmit API built into depot_tools.

Function Documentation

◆ _CheckApiTestFile()

PRESUBMIT._CheckApiTestFile	(		input_api,
			output_api )

protected

Checks that the public headers match the API tests.

Definition at line 14 of file PRESUBMIT.py.

Referenced by CheckChangeOnCommit(), and CheckChangeOnUpload().

Here is the caller graph for this function:

◆ _CheckIncludeOrder()

PRESUBMIT._CheckIncludeOrder	(		input_api,
			output_api )

protected

Checks that the #include order is correct.

1. The corresponding header for source files.
2. C system files in alphabetical order
3. C++ system files in alphabetical order
4. Project's .h files in alphabetical order

Each region separated by #if, #elif, #else, #endif, #define and #undef follows
these rules separately.

Definition at line 351 of file PRESUBMIT.py.

References _CheckIncludeOrderInFile(), and set.

Referenced by ChecksCommon().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _CheckIncludeOrderForScope()

PRESUBMIT._CheckIncludeOrderForScope	(	scope,
		input_api,
		file_path,
		changed_linenums )

protected

Checks that the lines in scope occur in the right order.

1. C system files in alphabetical order
2. C++ system files in alphabetical order
3. Project's .h files

Definition at line 220 of file PRESUBMIT.py.

Referenced by _CheckIncludeOrderInFile().

Here is the caller graph for this function:

◆ _CheckIncludeOrderInFile()

PRESUBMIT._CheckIncludeOrderInFile	(	input_api,
		f,
		changed_linenums )

protected

Checks the #include order for the given file f.

Definition at line 274 of file PRESUBMIT.py.

References _CheckIncludeOrderForScope().

Referenced by _CheckIncludeOrder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _CheckLibcxxRevision()

PRESUBMIT._CheckLibcxxRevision	(		input_api,
			output_api )

protected

Makes sure that libcxx_revision is set correctly.

Definition at line 375 of file PRESUBMIT.py.

Referenced by ChecksCommon().

Here is the caller graph for this function:

◆ _CheckNoBannedFunctions()

PRESUBMIT._CheckNoBannedFunctions	(		input_api,
			output_api )

protected

Makes sure that banned functions are not used.

Definition at line 79 of file PRESUBMIT.py.

Referenced by ChecksCommon(), and PRESUBMIT_test.BannedTypeCheckTest.testBannedCppFunctions().

Here is the caller graph for this function:

◆ _CheckPngNames()

PRESUBMIT._CheckPngNames	(		input_api,
			output_api )

protected

Checks that .png files have the right file name format, which must be in
the form:

NAME_expected(_gdi)?(_(agg|skia))?(_(linux|mac|win))?.pdf.\d+.png

This must be the same format as the one in testing/corpus's PRESUBMIT.py.

Definition at line 427 of file PRESUBMIT.py.

Referenced by ChecksCommon(), and PRESUBMIT_test.CheckChangeOnUploadTest.testCheckPngNames().

Here is the caller graph for this function:

◆ _CheckPublicHeaders()

PRESUBMIT._CheckPublicHeaders	(		input_api,
			output_api )

protected

Checks that the public headers match the API tests.

Definition at line 14 of file PRESUBMIT.py.

References _CheckPublicHeaders().

Referenced by _CheckPublicHeaders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _CheckTestDuplicates()

PRESUBMIT._CheckTestDuplicates	(		input_api,
			output_api )

protected

Checks that pixel and javascript tests don't contain duplicates.
We use .in and .pdf files, having both can cause race conditions on the bots,
which run the tests in parallel.

Definition at line 397 of file PRESUBMIT.py.

Referenced by ChecksCommon().

Here is the caller graph for this function:

◆ _CheckUnwantedDependencies()

PRESUBMIT._CheckUnwantedDependencies	(		input_api,
			output_api )

protected

Runs checkdeps on #include statements added in this
change. Breaking - rules is an error, breaking ! rules is a
warning.

Definition at line 150 of file PRESUBMIT.py.

Referenced by ChecksCommon().

Here is the caller graph for this function:

◆ _CheckUselessForwardDeclarations()

PRESUBMIT._CheckUselessForwardDeclarations	(		input_api,
			output_api )

protected

Checks that added or removed lines in non third party affected
   header files do not lead to new useless class or struct forward
   declaration.

Definition at line 449 of file PRESUBMIT.py.

References sum.

Referenced by ChecksCommon().

Here is the caller graph for this function:

◆ CheckChangeOnCommit()

PRESUBMIT.CheckChangeOnCommit	(		input_api,
			output_api )

Definition at line 42 of file PRESUBMIT.py.

References _CheckApiTestFile().

Here is the call graph for this function:

◆ CheckChangeOnUpload()

PRESUBMIT.CheckChangeOnUpload	(		input_api,
			output_api )

Definition at line 36 of file PRESUBMIT.py.

References _CheckApiTestFile().

Here is the call graph for this function:

◆ ChecksCommon()

PRESUBMIT.ChecksCommon	(		input_api,
			output_api )

Definition at line 496 of file PRESUBMIT.py.

References _CheckIncludeOrder(), _CheckLibcxxRevision(), _CheckNoBannedFunctions(), _CheckPngNames(), _CheckTestDuplicates(), _CheckUnwantedDependencies(), and _CheckUselessForwardDeclarations().

Here is the call graph for this function:

Variable Documentation

◆ _BANNED_CPP_FUNCTIONS

tuple PRESUBMIT._BANNED_CPP_FUNCTIONS

protected

Initial value:

=  (
    (
        r'/\busing namespace ',
        (
            'Using directives ("using namespace x") are banned by the Google',
            'Style Guide (',
            'https://google.github.io/styleguide/cppguide.html#Namespaces ).',
            'Explicitly qualify symbols or use using declarations ("using',
            'x::foo").',
        ),
        True,
        [_THIRD_PARTY],
    ),
    (
        r'/v8::Isolate::(?:|Try)GetCurrent()',
        (
            'v8::Isolate::GetCurrent() and v8::Isolate::TryGetCurrent() are',
            'banned. Hold a pointer to the v8::Isolate that was entered. Use',
            'v8::Isolate::IsCurrent() to check whether a given v8::Isolate is',
            'entered.',
        ),
        True,
        (),
    ),
)

Definition at line 52 of file PRESUBMIT.py.

◆ _INCLUDE_ORDER_WARNING

tuple PRESUBMIT._INCLUDE_ORDER_WARNING

protected

Initial value:

=  (
    'Your #include order seems to be broken. Remember to use the right '
    'collation (LC_COLLATE=C) and check\nhttps://google.github.io/styleguide/'
    'cppguide.html#Names_and_Order_of_Includes')

Definition at line 35 of file PRESUBMIT.py.

◆ _KNOWN_ROBOTS

PRESUBMIT._KNOWN_ROBOTS

protected

Initial value:

1= set() | set(

2 '%s@skia-public.iam.gserviceaccount.com' % s for s in ('pdfium-autoroll',))

set

QFuture< QSet< QChar > > set

[10]

Definition src_concurrent_qtconcurrentfilter.cpp:77

Definition at line 42 of file PRESUBMIT.py.

◆ _THIRD_PARTY

str PRESUBMIT._THIRD_PARTY = 'third_party/'

protected

Definition at line 45 of file PRESUBMIT.py.

◆ LINT_FILTERS

list PRESUBMIT.LINT_FILTERS

Initial value:

=  [
  # Rvalue ref checks are unreliable.
  '-build/c++11',
  # Need to fix header names not matching cpp names.
  '-build/include_order',
  # Too many to fix at the moment.
  '-readability/casting',
  # Need to refactor large methods to fix.
  '-readability/fn_size',
  # Lots of usage to fix first.
  '-runtime/int',
  # Lots of non-const references need to be fixed
  '-runtime/references',
  # We are not thread safe, so this will never pass.
  '-runtime/threadsafe_fn',
  # Figure out how to deal with #defines that git cl format creates.
  '-whitespace/indent',
]

Definition at line 15 of file PRESUBMIT.py.

◆ PRESUBMIT_VERSION

str PRESUBMIT.PRESUBMIT_VERSION = '2.0.0'

Definition at line 11 of file PRESUBMIT.py.

◆ USE_PYTHON3

bool PRESUBMIT.USE_PYTHON3 = True

Definition at line 11 of file PRESUBMIT.py.

Functions

Variables

Detailed Description

Function Documentation

◆ _CheckApiTestFile()

◆ _CheckIncludeOrder()

◆ _CheckIncludeOrderForScope()

◆ _CheckIncludeOrderInFile()

◆ _CheckLibcxxRevision()

◆ _CheckNoBannedFunctions()

◆ _CheckPngNames()

◆ _CheckPublicHeaders()

◆ _CheckTestDuplicates()

◆ _CheckUnwantedDependencies()

◆ _CheckUselessForwardDeclarations()

◆ CheckChangeOnCommit()

◆ CheckChangeOnUpload()

◆ ChecksCommon()

Variable Documentation

◆ _BANNED_CPP_FUNCTIONS

◆ _INCLUDE_ORDER_WARNING

◆ _KNOWN_ROBOTS

◆ _THIRD_PARTY

◆ LINT_FILTERS

◆ PRESUBMIT_VERSION

◆ USE_PYTHON3