fuse_gmock_files Namespace Reference

Functions
def	GetGTestRootDir (gmock_root)
def	ValidateGMockRootDir (gmock_root)
def	ValidateOutputDir (output_dir)
def	FuseGMockH (gmock_root, output_dir)
def	FuseGMockAllCcToFile (gmock_root, output_file)
def	FuseGMockGTestAllCc (gmock_root, output_dir)
def	FuseGMock (gmock_root, output_dir)
def	main ()

Variables
string	__author__ = 'wan@google.com (Zhanyong Wan)'
	DEFAULT_GMOCK_ROOT_DIR = os.path.join(os.path.dirname(__file__), '..')
	gtest = fuse_gtest_files
	INCLUDE_GMOCK_FILE_REGEX = re.compile(r'^\s*#\s*include\s*"(gmock/.+)"')
string	GMOCK_H_SEED = 'include/gmock/gmock.h'
string	GMOCK_ALL_CC_SEED = 'src/gmock-all.cc'
string	GTEST_H_OUTPUT = 'gtest/gtest.h'
string	GMOCK_H_OUTPUT = 'gmock/gmock.h'
string	GMOCK_GTEST_ALL_CC_OUTPUT = 'gmock-gtest-all.cc'

Function Documentation

def fuse_gmock_files.FuseGMock	(		gmock_root,
			output_dir
	)

Fuses gtest.h, gmock.h, and gmock-gtest-all.h.

Definition at line 215 of file fuse_gmock_files.py.

References FuseGMockGTestAllCc(), FuseGMockH(), GetGTestRootDir(), ValidateGMockRootDir(), and ValidateOutputDir().

Referenced by main().

def FuseGMock(gmock_root, output_dir):
  """Fuses gtest.h, gmock.h, and gmock-gtest-all.h."""

  ValidateGMockRootDir(gmock_root)
  ValidateOutputDir(output_dir)

  gtest.FuseGTestH(GetGTestRootDir(gmock_root), output_dir)
  FuseGMockH(gmock_root, output_dir)
  FuseGMockGTestAllCc(gmock_root, output_dir)

def fuse_gmock_files.FuseGMockAllCcToFile	(		gmock_root,
			output_file
	)

Scans folder gmock_root to fuse gmock-all.cc into output_file.

Definition at line 159 of file fuse_gmock_files.py.

Referenced by FuseGMockGTestAllCc().

def FuseGMockAllCcToFile(gmock_root, output_file):
  """Scans folder gmock_root to fuse gmock-all.cc into output_file."""

  processed_files = sets.Set()

  def ProcessFile(gmock_source_file):
    """Processes the given gmock source file."""

    # We don't process the same #included file twice.
    if gmock_source_file in processed_files:
      return

    processed_files.add(gmock_source_file)

    # Reads each line in the given gmock source file.
    for line in file(os.path.join(gmock_root, gmock_source_file), 'r'):
      m = INCLUDE_GMOCK_FILE_REGEX.match(line)
      if m:
        # It's '#include "gmock/foo.h"'.  We treat it as '#include
        # "gmock/gmock.h"', as all other gmock headers are being fused
        # into gmock.h and cannot be #included directly.

        # There is no need to #include "gmock/gmock.h" more than once.
        if not GMOCK_H_SEED in processed_files:
          processed_files.add(GMOCK_H_SEED)
          output_file.write('#include "%s"\n' % (GMOCK_H_OUTPUT,))
      else:
        m = gtest.INCLUDE_GTEST_FILE_REGEX.match(line)
        if m:
          # It's '#include "gtest/..."'.
          # There is no need to #include gtest.h as it has been
          # #included by gtest-all.cc.
          pass
        else:
          m = gtest.INCLUDE_SRC_FILE_REGEX.match(line)
          if m:
            # It's '#include "src/foo"' - let's process it recursively.
            ProcessFile(m.group(1))
          else:
            # Otherwise we copy the line unchanged to the output file.
            output_file.write(line)

  ProcessFile(GMOCK_ALL_CC_SEED)

def fuse_gmock_files.FuseGMockGTestAllCc	(		gmock_root,
			output_dir
	)

Scans folder gmock_root to generate gmock-gtest-all.cc in output_dir.

Definition at line 204 of file fuse_gmock_files.py.

References FuseGMockAllCcToFile(), and GetGTestRootDir().

Referenced by FuseGMock().

def FuseGMockGTestAllCc(gmock_root, output_dir):
  """Scans folder gmock_root to generate gmock-gtest-all.cc in output_dir."""

  output_file = file(os.path.join(output_dir, GMOCK_GTEST_ALL_CC_OUTPUT), 'w')
  # First, fuse gtest-all.cc into gmock-gtest-all.cc.
  gtest.FuseGTestAllCcToFile(GetGTestRootDir(gmock_root), output_file)
  # Next, append fused gmock-all.cc to gmock-gtest-all.cc.
  FuseGMockAllCcToFile(gmock_root, output_file)
  output_file.close()

def fuse_gmock_files.FuseGMockH	(		gmock_root,
			output_dir
	)

Scans folder gmock_root to generate gmock/gmock.h in output_dir.

Definition at line 119 of file fuse_gmock_files.py.

Referenced by FuseGMock().

def FuseGMockH(gmock_root, output_dir):
  """Scans folder gmock_root to generate gmock/gmock.h in output_dir."""

  output_file = file(os.path.join(output_dir, GMOCK_H_OUTPUT), 'w')
  processed_files = sets.Set()  # Holds all gmock headers we've processed.

  def ProcessFile(gmock_header_path):
    """Processes the given gmock header file."""

    # We don't process the same header twice.
    if gmock_header_path in processed_files:
      return

    processed_files.add(gmock_header_path)

    # Reads each line in the given gmock header.
    for line in file(os.path.join(gmock_root, gmock_header_path), 'r'):
      m = INCLUDE_GMOCK_FILE_REGEX.match(line)
      if m:
        # It's '#include "gmock/..."' - let's process it recursively.
        ProcessFile('include/' + m.group(1))
      else:
        m = gtest.INCLUDE_GTEST_FILE_REGEX.match(line)
        if m:
          # It's '#include "gtest/foo.h"'.  We translate it to
          # "gtest/gtest.h", regardless of what foo is, since all
          # gtest headers are fused into gtest/gtest.h.

          # There is no need to #include gtest.h twice.
          if not gtest.GTEST_H_SEED in processed_files:
            processed_files.add(gtest.GTEST_H_SEED)
            output_file.write('#include "%s"\n' % (gtest.GTEST_H_OUTPUT,))
        else:
          # Otherwise we copy the line unchanged to the output file.
          output_file.write(line)

  ProcessFile(GMOCK_H_SEED)
  output_file.close()

def fuse_gmock_files.GetGTestRootDir

(

gmock_root

)

Returns the root directory of Google Test.

Definition at line 91 of file fuse_gmock_files.py.

Referenced by FuseGMock(), FuseGMockGTestAllCc(), and ValidateGMockRootDir().

def GetGTestRootDir(gmock_root):
  """Returns the root directory of Google Test."""

  return os.path.join(gmock_root, '../googletest')

def fuse_gmock_files.main

(

void

)

Definition at line 226 of file fuse_gmock_files.py.

References FuseGMock().

def main():
  argc = len(sys.argv)
  if argc == 2:
    # fuse_gmock_files.py OUTPUT_DIR
    FuseGMock(DEFAULT_GMOCK_ROOT_DIR, sys.argv[1])
  elif argc == 3:
    # fuse_gmock_files.py GMOCK_ROOT_DIR OUTPUT_DIR
    FuseGMock(sys.argv[1], sys.argv[2])
  else:
    print __doc__
    sys.exit(1)

def fuse_gmock_files.ValidateGMockRootDir

(

gmock_root

)

Makes sure gmock_root points to a valid gmock root directory.

The function aborts the program on failure.

Definition at line 97 of file fuse_gmock_files.py.

References GetGTestRootDir().

Referenced by FuseGMock().

def ValidateGMockRootDir(gmock_root):
  """Makes sure gmock_root points to a valid gmock root directory.

  The function aborts the program on failure.
  """

  gtest.ValidateGTestRootDir(GetGTestRootDir(gmock_root))
  gtest.VerifyFileExists(gmock_root, GMOCK_H_SEED)
  gtest.VerifyFileExists(gmock_root, GMOCK_ALL_CC_SEED)

def fuse_gmock_files.ValidateOutputDir

(

output_dir

)

Makes sure output_dir points to a valid output directory.

The function aborts the program on failure.

Definition at line 108 of file fuse_gmock_files.py.

Referenced by FuseGMock().

def ValidateOutputDir(output_dir):
  """Makes sure output_dir points to a valid output directory.

  The function aborts the program on failure.
  """

  gtest.VerifyOutputFile(output_dir, gtest.GTEST_H_OUTPUT)
  gtest.VerifyOutputFile(output_dir, GMOCK_H_OUTPUT)
  gtest.VerifyOutputFile(output_dir, GMOCK_GTEST_ALL_CC_OUTPUT)

Variable Documentation

string fuse_gmock_files.__author__ = 'wan@google.com (Zhanyong Wan)'

private

Definition at line 62 of file fuse_gmock_files.py.

fuse_gmock_files.DEFAULT_GMOCK_ROOT_DIR = os.path.join(os.path.dirname(__file__), '..')

Definition at line 71 of file fuse_gmock_files.py.

string fuse_gmock_files.GMOCK_ALL_CC_SEED = 'src/gmock-all.cc'

Definition at line 83 of file fuse_gmock_files.py.

string fuse_gmock_files.GMOCK_GTEST_ALL_CC_OUTPUT = 'gmock-gtest-all.cc'

Definition at line 88 of file fuse_gmock_files.py.

string fuse_gmock_files.GMOCK_H_OUTPUT = 'gmock/gmock.h'

Definition at line 87 of file fuse_gmock_files.py.

string fuse_gmock_files.GMOCK_H_SEED = 'include/gmock/gmock.h'

Definition at line 82 of file fuse_gmock_files.py.

fuse_gmock_files.gtest = fuse_gtest_files

Definition at line 76 of file fuse_gmock_files.py.

Referenced by option(), and set().

string fuse_gmock_files.GTEST_H_OUTPUT = 'gtest/gtest.h'

Definition at line 86 of file fuse_gmock_files.py.

fuse_gmock_files.INCLUDE_GMOCK_FILE_REGEX = re.compile(r'^\s*#\s*include\s*"(gmock/.+)"')

Definition at line 79 of file fuse_gmock_files.py.