cpplint.FileInfo Class Reference

Inheritance diagram for cpplint.FileInfo:

Collaboration diagram for cpplint.FileInfo:

Public Member Functions
def	__init__ (self, filename)
def	FullName (self)
def	RepositoryName (self)
def	Split (self)
def	BaseName (self)
def	Extension (self)
def	NoExtension (self)
def	IsSource (self)
def	__init__ (self, filename)
def	FullName (self)
def	RepositoryName (self)
def	Split (self)
def	BaseName (self)
def	Extension (self)
def	NoExtension (self)
def	IsSource (self)
def	__init__ (self, filename)
def	FullName (self)
def	RepositoryName (self)
def	Split (self)
def	BaseName (self)
def	Extension (self)
def	NoExtension (self)
def	IsSource (self)

Private Attributes
	_filename

Detailed Description

Provides utility functions for filenames.

FileInfo provides easy access to the components of a file's path
relative to the project root.

Definition at line 1250 of file ioda/tools/cpplint.py.

Constructor & Destructor Documentation

__init__() [1/3]

def cpplint.FileInfo.__init__	(		self,
			filename
	)

Definition at line 1257 of file ioda/tools/cpplint.py.

Here is the caller graph for this function:

__init__() [2/3]

def cpplint.FileInfo.__init__	(		self,
			filename
	)

Definition at line 1257 of file oops/tools/cpplint.py.

Here is the call graph for this function:

__init__() [3/3]

def cpplint.FileInfo.__init__	(		self,
			filename
	)

Definition at line 1257 of file ufo/tools/cpplint.py.

Here is the call graph for this function:

Member Function Documentation

BaseName() [1/3]

def cpplint.FileInfo.BaseName

(

self

)

File base name - text after the final slash, before the final period.

Definition at line 1339 of file ioda/tools/cpplint.py.

Here is the call graph for this function:

Here is the caller graph for this function:

BaseName() [2/3]

def cpplint.FileInfo.BaseName

(

self

)

File base name - text after the final slash, before the final period.

Definition at line 1339 of file oops/tools/cpplint.py.

Here is the call graph for this function:

BaseName() [3/3]

def cpplint.FileInfo.BaseName

(

self

)

File base name - text after the final slash, before the final period.

Definition at line 1339 of file ufo/tools/cpplint.py.

Here is the call graph for this function:

Extension() [1/3]

def cpplint.FileInfo.Extension

(

self

)

File extension - text following the final period, includes that period.

Definition at line 1343 of file ufo/tools/cpplint.py.

Here is the call graph for this function:

Extension() [2/3]

def cpplint.FileInfo.Extension

(

self

)

File extension - text following the final period, includes that period.

Definition at line 1343 of file ioda/tools/cpplint.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Extension() [3/3]

def cpplint.FileInfo.Extension

(

self

)

File extension - text following the final period, includes that period.

Definition at line 1343 of file oops/tools/cpplint.py.

Here is the call graph for this function:

FullName() [1/3]

def cpplint.FileInfo.FullName

(

self

)

Make Windows paths like Unix.

Definition at line 1260 of file oops/tools/cpplint.py.

Here is the call graph for this function:

FullName() [2/3]

def cpplint.FileInfo.FullName

(

self

)

Make Windows paths like Unix.

Definition at line 1260 of file ioda/tools/cpplint.py.

Here is the caller graph for this function:

FullName() [3/3]

def cpplint.FileInfo.FullName

(

self

)

Make Windows paths like Unix.

Definition at line 1260 of file ufo/tools/cpplint.py.

Here is the call graph for this function:

IsSource() [1/3]

def cpplint.FileInfo.IsSource

(

self

)

File has a source file extension.

Definition at line 1351 of file ufo/tools/cpplint.py.

Here is the call graph for this function:

IsSource() [2/3]

def cpplint.FileInfo.IsSource

(

self

)

File has a source file extension.

Definition at line 1351 of file ioda/tools/cpplint.py.

Here is the call graph for this function:

Here is the caller graph for this function:

IsSource() [3/3]

def cpplint.FileInfo.IsSource

(

self

)

File has a source file extension.

Definition at line 1351 of file oops/tools/cpplint.py.

Here is the call graph for this function:

NoExtension() [1/3]

def cpplint.FileInfo.NoExtension

(

self

)

File has no source file extension.

Definition at line 1347 of file oops/tools/cpplint.py.

Here is the call graph for this function:

NoExtension() [2/3]

def cpplint.FileInfo.NoExtension

(

self

)

File has no source file extension.

Definition at line 1347 of file ufo/tools/cpplint.py.

Here is the call graph for this function:

NoExtension() [3/3]

def cpplint.FileInfo.NoExtension

(

self

)

File has no source file extension.

Definition at line 1347 of file ioda/tools/cpplint.py.

Here is the call graph for this function:

Here is the caller graph for this function:

RepositoryName() [1/3]

def cpplint.FileInfo.RepositoryName

(

self

)

FullName after removing the local path to the repository.

If we have a real absolute path name here we can try to do something smart:
detecting the root of the checkout and truncating /path/to/checkout from
the name so that we get header guards that don't include things like
"C:\Documents and Settings\..." or "/home/username/..." in them and thus
people on different computers who have checked the source out to different
locations won't see bogus errors.

Definition at line 1264 of file oops/tools/cpplint.py.

Here is the call graph for this function:

RepositoryName() [2/3]

def cpplint.FileInfo.RepositoryName

(

self

)

FullName after removing the local path to the repository.

If we have a real absolute path name here we can try to do something smart:
detecting the root of the checkout and truncating /path/to/checkout from
the name so that we get header guards that don't include things like
"C:\Documents and Settings\..." or "/home/username/..." in them and thus
people on different computers who have checked the source out to different
locations won't see bogus errors.

Definition at line 1264 of file ioda/tools/cpplint.py.

Here is the call graph for this function:

Here is the caller graph for this function:

RepositoryName() [3/3]

def cpplint.FileInfo.RepositoryName

(

self

)

FullName after removing the local path to the repository.

If we have a real absolute path name here we can try to do something smart:
detecting the root of the checkout and truncating /path/to/checkout from
the name so that we get header guards that don't include things like
"C:\Documents and Settings\..." or "/home/username/..." in them and thus
people on different computers who have checked the source out to different
locations won't see bogus errors.

Definition at line 1264 of file ufo/tools/cpplint.py.

Here is the call graph for this function:

Split() [1/3]

def cpplint.FileInfo.Split

(

self

)

Splits the file into the directory, basename, and extension.

For 'chrome/browser/browser.cc', Split() would
return ('chrome/browser', 'browser', '.cc')

Returns:
  A tuple of (directory, basename, extension).

Definition at line 1325 of file ioda/tools/cpplint.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Split() [2/3]

def cpplint.FileInfo.Split

(

self

)

Splits the file into the directory, basename, and extension.

For 'chrome/browser/browser.cc', Split() would
return ('chrome/browser', 'browser', '.cc')

Returns:
  A tuple of (directory, basename, extension).

Definition at line 1325 of file ufo/tools/cpplint.py.

Here is the call graph for this function:

Split() [3/3]

def cpplint.FileInfo.Split

(

self

)

Splits the file into the directory, basename, and extension.

For 'chrome/browser/browser.cc', Split() would
return ('chrome/browser', 'browser', '.cc')

Returns:
  A tuple of (directory, basename, extension).

Definition at line 1325 of file oops/tools/cpplint.py.

Here is the call graph for this function:

Member Data Documentation

_filename

cpplint.FileInfo._filename

private

Definition at line 1258 of file ioda/tools/cpplint.py.

---

The documentation for this class was generated from the following file:

• ioda/tools/cpplint.py