src/build_tools/embed_pathname.py

# -*- coding: utf-8 -*-
# Copyright 2010-2015, Google Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution.
#     * Neither the name of Google Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""A script to embed the given (relative) path name to C/C++ characters array.

Example:
  ./embed_pathname.py --path_to_be_embedded=d:\data\mozc
      --constant_name=kMozcDataDir --output=mozc_data_dir.h
  Then you will get 'mozc_data_dir.h' which consists of the following line.
      const char kMozcDataDir[] = "d:\\data\\mozc";
"""

__author__ = "yukawa"

from optparse import OptionParser
import os
import sys


def ParseOption():
  """Parse command line options."""
  parser = OptionParser()
  parser.add_option('--path_to_be_embedded', dest='path_to_be_embedded')
  parser.add_option('--constant_name', dest='constant_name')
  parser.add_option('--output', dest='output')

  (options, unused_args) = parser.parse_args()
  if not all(vars(options).values()):
    print parser.print_help()
    sys.exit(1)

  return options


def main():
  opt = ParseOption()
  path = os.path.abspath(opt.path_to_be_embedded)
  # TODO(yukawa): Consider the case of non-ASCII characters.
  escaped_path = path.encode('string-escape')
  with open(opt.output, 'w') as output_file:
    output_file.write(
        'const char %s[] = "%s";\n' % (opt.constant_name, escaped_path))


if __name__ == '__main__':
  main()