checkProjectStructure Namespace Reference

Classes
class	Analyzer
class	AnalyzerOptions
class	AutoContainer
class	CheckResult
class	ConReporter
class	DepsConsole
class	Entry
class	ErrorDataCollector
class	FilteredReporter
class	FirstIncludeError
class	IncludesError
class	SortableInclude
class	XmlReporter

Functions
def	isSpecialInclude (includePath)
def	checkExternalInclude (incA, incB)
def	isCppInclude (inc)
def	checkCppInclude (incA, incB)
def	checkLocalInclude (pathA, pathB)
def	checkIncludeDepth (pathA, pathB)
def	namespaceFilter (namespace)
def	filterNonProjectIncludes (includes)
def	depsCheckDir (args, path)
def	checkDependencies (includes, depsChecker, args)
def	parseArgs ()
def	setupOptions (analyzerOptions, args)
def	findAccessibleSourceDirs ()
def	printSectionSeparator ()
def	main ()

Variables
dictionary	EXCLUSIONS
dictionary	USER_SOURCE_DIRS
	SOURCE_DIRS = dict((k, RULE_ID_TO_CLASS_MAP[v]) for k, v in USER_SOURCE_DIRS.items())
dictionary	INCLUDE_PRIORITIES = {'"src': 100, '"mongo': 125, '"zeromq': 125, '"plugins': 150, '"catapult': 200, '"tests': 500}

Function Documentation

checkCppInclude()

def checkProjectStructure.checkCppInclude	(		incA,
			incB
	)

Here is the call graph for this function:

Here is the caller graph for this function:

checkDependencies()

def checkProjectStructure.checkDependencies	(		includes,
			depsChecker,
			args
	)

Here is the call graph for this function:

Here is the caller graph for this function:

checkExternalInclude()

def checkProjectStructure.checkExternalInclude	(		incA,
			incB
	)

Here is the caller graph for this function:

checkIncludeDepth()

def checkProjectStructure.checkIncludeDepth	(		pathA,
			pathB
	)

Here is the caller graph for this function:

checkLocalInclude()

def checkProjectStructure.checkLocalInclude	(		pathA,
			pathB
	)

Here is the caller graph for this function:

depsCheckDir()

def checkProjectStructure.depsCheckDir	(		args,
			path
	)

Here is the caller graph for this function:

filterNonProjectIncludes()

def checkProjectStructure.filterNonProjectIncludes

(

includes

)

Here is the caller graph for this function:

findAccessibleSourceDirs()

def checkProjectStructure.findAccessibleSourceDirs

(

)

Here is the caller graph for this function:

isCppInclude()

def checkProjectStructure.isCppInclude

(

inc

)

Here is the caller graph for this function:

isSpecialInclude()

def checkProjectStructure.isSpecialInclude

(

includePath

)

Here is the caller graph for this function:

main()

def checkProjectStructure.main

(

)

Here is the call graph for this function:

namespaceFilter()

def checkProjectStructure.namespaceFilter

(

namespace

)

parseArgs()

def checkProjectStructure.parseArgs

(

)

Here is the caller graph for this function:

printSectionSeparator()

def checkProjectStructure.printSectionSeparator

(

)

Here is the caller graph for this function:

setupOptions()

def checkProjectStructure.setupOptions	(		analyzerOptions,
			args
	)

Here is the caller graph for this function:

Variable Documentation

EXCLUSIONS

dictionary checkProjectStructure.EXCLUSIONS

Initial value:

=  {
    'SKIP_FILES': SKIP_FILES,
    'NAMESPACES_FALSEPOSITIVES': NAMESPACES_FALSEPOSITIVES,
    'EMPTYLINES_FALSEPOSITIVES': EMPTYLINES_FALSEPOSITIVES,
    'LONGLINES_FALSEPOSITIVES': LONGLINES_FALSEPOSITIVES,
    'CORE_FIRSTINCLUDES': CORE_FIRSTINCLUDES,
    'PLUGINS_FIRSTINCLUDES': PLUGINS_FIRSTINCLUDES,
    'TOOLS_FIRSTINCLUDES': TOOLS_FIRSTINCLUDES,
    'EXTENSION_FIRSTINCLUDES': EXTENSION_FIRSTINCLUDES
}

INCLUDE_PRIORITIES

dictionary checkProjectStructure.INCLUDE_PRIORITIES = {'"src': 100, '"mongo': 125, '"zeromq': 125, '"plugins': 150, '"catapult': 200, '"tests': 500}

SOURCE_DIRS

checkProjectStructure.SOURCE_DIRS = dict((k, RULE_ID_TO_CLASS_MAP[v]) for k, v in USER_SOURCE_DIRS.items())

USER_SOURCE_DIRS

dictionary checkProjectStructure.USER_SOURCE_DIRS

Initial value:

=  {
    'src': Rules.Default,
    'sdk': Rules.Plugin,
    'tests': Rules.Default,
    'plugins': Rules.Plugin,
    'extensions': Rules.Extension,
    'tools': Rules.Tools,
    'internal/tools': Rules.Tools
}