gen_gtest_pred_impl Namespace Reference

Functions
def	HeaderPreamble (n)
def	Arity (n)
def	Title (word)
def	OneTo (n)
def	Iter (n, format, sep='')
def	ImplementationForArity (n)
def	HeaderPostamble ()
def	GenerateFile (path, content)
def	GenerateHeader (n)
def	UnitTestPreamble ()
def	TestsForArity (n)
def	UnitTestPostamble ()
def	GenerateUnitTest (n)
def	_Main ()

Variables
str	__author__ = 'wan@google.com (Zhanyong Wan)'
os	SCRIPT_DIR = os.path.dirname(sys.argv[0])
os	HEADER = os.path.join(SCRIPT_DIR, '../include/gtest/gtest_pred_impl.h')
os	UNIT_TEST = os.path.join(SCRIPT_DIR, '../test/gtest_pred_impl_unittest.cc')

Detailed Description

gen_gtest_pred_impl.py v0.1

Generates the implementation of Google Test predicate assertions and
accompanying tests.

Usage:

  gen_gtest_pred_impl.py MAX_ARITY

where MAX_ARITY is a positive integer.

The command generates the implementation of up-to MAX_ARITY-ary
predicate assertions, and writes it to file gtest_pred_impl.h in the
directory where the script is.  It also generates the accompanying
unit test in file gtest_pred_impl_unittest.cc.

Function Documentation

_Main()

def gen_gtest_pred_impl._Main ( )

protected

The entry point of the script.  Generates the header file and its
unit test.

Arity()

def gen_gtest_pred_impl.Arity

(

n

)

Returns the English name of the given arity.

GenerateFile()

def gen_gtest_pred_impl.GenerateFile	(		path,
			content
	)

Given a file path and a content string, overwrites it with the
given content.

GenerateHeader()

def gen_gtest_pred_impl.GenerateHeader

(

n

)

Given the maximum arity n, updates the header file that implements
the predicate assertions.

GenerateUnitTest()

def gen_gtest_pred_impl.GenerateUnitTest

(

n

)

Returns the tests for up-to n-ary predicate assertions.

HeaderPostamble()

def gen_gtest_pred_impl.HeaderPostamble

(

)

Returns the postamble for the header file.

HeaderPreamble()

def gen_gtest_pred_impl.HeaderPreamble

(

n

)

Returns the preamble for the header file.

Args:
  n:  the maximum arity of the predicate macros to be generated.

ImplementationForArity()

def gen_gtest_pred_impl.ImplementationForArity

(

n

)

Returns the implementation of n-ary predicate assertions.

Iter()

def gen_gtest_pred_impl.Iter	(		n,
			format,
			sep = ''
	)

Given a positive integer n, a format string that contains 0 or
more '%s' format specs, and optionally a separator string, returns
the join of n strings, each formatted with the format string on an
iterator ranged from 1 to n.

Example:

Iter(3, 'v%s', sep=', ') returns 'v1, v2, v3'.

OneTo()

def gen_gtest_pred_impl.OneTo

(

n

)

Returns the list [1, 2, 3, ..., n].

TestsForArity()

def gen_gtest_pred_impl.TestsForArity

(

n

)

Returns the tests for n-ary predicate assertions.

Title()

def gen_gtest_pred_impl.Title

(

word

)

Returns the given word in title case.  The difference between
this and string's title() method is that Title('4-ary') is '4-ary'
while '4-ary'.title() is '4-Ary'.

UnitTestPostamble()

def gen_gtest_pred_impl.UnitTestPostamble

(

)

Returns the postamble for the tests.

UnitTestPreamble()

def gen_gtest_pred_impl.UnitTestPreamble

(

)

Returns the preamble for the unit test file.

Variable Documentation

__author__

str gen_gtest_pred_impl.__author__ = 'wan@google.com (Zhanyong Wan)'

private

HEADER

os gen_gtest_pred_impl.HEADER = os.path.join(SCRIPT_DIR, '../include/gtest/gtest_pred_impl.h')

SCRIPT_DIR

os gen_gtest_pred_impl.SCRIPT_DIR = os.path.dirname(sys.argv[0])

UNIT_TEST

os gen_gtest_pred_impl.UNIT_TEST = os.path.join(SCRIPT_DIR, '../test/gtest_pred_impl_unittest.cc')