cmake.py

Go to the documentation of this file.

# Software License Agreement (BSD License)
#
# Copyright (c) 2013, Yujin Robot, 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 Yujin Robot 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.

##############################################################################
# Imports
##############################################################################

import sys
import os
import subprocess
import shutil
import cmake_var
import glob

##############################################################################
# Public Functions
##############################################################################

def execute_cmake(src_path, build_path):
    if not os.path.isdir(build_path):
        os.mkdir(build_path)
    ws_path = os.path.join(parent_directory(build_path))
    override_cmake_str =  '-DCMAKE_USER_MAKE_RULES_OVERRIDE:STRING="' + override_filename() + '" '
    cache_cmake_str =  '-C "' + os.path.join(ws_path, 'config.cmake') + '" '
    devel_prefix = '-DCATKIN_DEVEL_PREFIX=' + os.path.join(ws_path, 'devel') + ' '
    cmake_command = 'cmake -G "NMake Makefiles" ' + cache_cmake_str + override_cmake_str + devel_prefix + src_path
    print("\nExecuting cmake on the workspace source directory:\n")
    print("  %s\n" % cmake_command)
    os.chdir(build_path) 
    proc = subprocess.Popen(cmake_command, shell=True)
    proc.wait()

def execute_nmake(build_path):
    if not os.path.isdir(build_path):
        execute_cmake(src_path, build_path)
    if not os.path.isfile(os.path.join(build_path, 'CMakeCache.txt')):
        execute_cmake(src_path, build_path)
    os.chdir(build_path) 
    print("\nExecuting nmake in the root build directory\n")
    proc = subprocess.Popen('nmake', shell=True)
    proc.wait()

def execute_nmake_install(build_path):
    if not os.path.isdir(build_path):
        execute_cmake(src_path, build_path)
    if not os.path.isfile(os.path.join(build_path, 'CMakeCache.txt')):
        execute_cmake(src_path, build_path)
    os.chdir(build_path) 
    print("\nExecuting nmake in the root build directory and install\n")
    proc = subprocess.Popen('nmake install', shell=True)
    returncode = proc.wait()
    if returncode == 0:
        copy_debuginfo(build_path)
    
def override_filename():
    return os.path.join(os.path.dirname(__file__), 'cmake', 'MsvcOverrides.cmake')

def parent_directory(path):
    return os.path.abspath(os.path.join(path, os.pardir))

def copy_debuginfo(build_path):
    ws_path = os.path.join(parent_directory(build_path))
    pdb_path = os.path.join(ws_path, 'devel', 'bin', '*.pdb')
    install_root = cmake_var.get_value(os.path.join(ws_path, 'config.cmake'), 'INSTALL_ROOT')
    install_path = os.path.join(install_root, 'bin')
    pdb_files = glob.glob(pdb_path)
    print("Install the debug info files...")
    for i in pdb_files:
        dst_name = os.path.join(install_path, os.path.basename(i))
        if os.path.isfile(dst_name) == True:
            print("-- Up-to-date: " + dst_name)
        else:
            print("-- Installing: " + dst_name)
        shutil.copy(i, dst_name)