executabletargetinfo.py

##############################################################################
# @file  executabletargetinfo.py
# @brief Provides information about executables built by BASIS.
#
# @note The executabletargetinfo.py module is automatically created by
#       BASIS from the template file executabletargetinfo.py.in which is
#       part of the BASIS installation.
#
# Copyright (c) 2011 University of Pennsylvania. All rights reserved.<br />
# See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.
#
# Contact: SBIA Group <sbia-software at uphs.upenn.edu>
#
# @ingroup BasisPythonUtilities
##############################################################################

"""
Provides information about executables built by BASIS.

Copyright (c) 2011 University of Pennsylvania. All rights reserved.
See COPYING file or https://www.rad.upenn.edu/sbia/software/license.html.

Contact: SBIA Group <sbia-software at uphs.upenn.edu>

"""

# ============================================================================
# modules
# ============================================================================

import os.path # path functions
import sys     # argv[0]

from sbia.basis.which import which, WhichError

# ============================================================================
# global variables
# ============================================================================

_module_dir = os.path.realpath(os.path.dirname(__file__))
_locations  = None

# ============================================================================
# public function
# ============================================================================

## @addtogroup BasisPythonUtilities
# @{


# ----------------------------------------------------------------------------
def get_target_uid(target):
    """
    Get UID of build target.
    
    The UID of a build target is its name prepended by a namespace identifier
    which should be unique for each project.
    
    This function further initializes the dictionaries storing the information
    about the executable targets upon the first invocation. Reason to do it
    here is that every access to the dictionaries first calls this function
    to get the UID of a build target. Moreover, also this function needs to
    have the already initialized dictionaries to ensure that an already valid
    target identifier is not modified.
    
    """
    global _locations
    
    # initialize module if not done yet - this is only done here because
    # whenever information is looked up about an executable target, this
    # function is invoked first
    if _locations is None:
        _initialize()
    # handle invalid arguments
    if target is None or target == "":
        return None
    # in case of a leading namespace separator, do not modify target name
    if target.startswith('.'):
        return target
    # project namespace
    prefix = 'sbia.basis'
    # try prepending namespace or parts of it until target is known
    separator = '.'
    while True:
        if separator.join([prefix, target]) in _locations:
            return separator.join([prefix, target])
        parts = prefix.split(separator, 1)
        if len(parts) == 1:
            break
        prefix = parts[0]
    # otherwise, return target name unchanged
    return target

# ----------------------------------------------------------------------------
def is_known_target(target):
    """Determine whether a given build target is known by this module."""
    global _locations
    uid = get_target_uid(target)
    if uid is None or uid == "":
        return False
    if uid.startswith('.'):
        uid = uid[1:]
    return uid in _locations

# ----------------------------------------------------------------------------
def get_executable_name(target=None):
    """
    Get name of executable file built by given target. If no target is
    specified, the name of this executable is returned.
    
    """
    path = get_executable_path(target)
    if path is None:
        return None
    return os.path.basename(path)

# ----------------------------------------------------------------------------
def get_executable_directory(target=None):
    """
    Get directory of executable file built by given target. If no target is
    specified, the directory of this executable is returned.
    
    """
    path = get_executable_path(target)
    if path is None:
        return None
    return os.path.dirname(path)

# ----------------------------------------------------------------------------
def get_executable_path(target=None):
    """
    Get absolute path of executable file.
    
    This function determines the absolute file path of an executable. If no
    arguments are given, the absolute path of this executable is returned.
    If the given argument is a known build target name, the absolute path
    of the executable built by this target is returned. Otherwise, the named
    command is searched in the system PATH and it's absolute path returned
    if found. If the given argument is neither the name of a known build target
    nor an executable found on the PATH, undef is returned.
    
    """
    global _module_dir
    global _locations
    
    path = None
    if target is None:
        path = os.path.realpath(sys.argv [0])
        if os.path.isdir(path):
            path += "/<stdin>" # interactive shell
    else:
        uid = get_target_uid(target)
        if uid is not None and uid.startswith('.'):
            uid = uid[1:]
        if uid is not None and uid in _locations:
            path = os.path.normpath(os.path.join(_module_dir, _locations[uid]))
            if '$(IntDir)' in path:
                for intdir in ['Release', 'Debug', 'RelWithDebInfo', 'MinSizeRel']:
                    tmppath = path.replace('$(IntDir)', intdir)
                    if os.path.exists(tmppath):
                        path = tmppath
                        break
                path = path.replace('$(IntDir)', '')
        else:
            try:
                path = which (target)
            except WhichError:
                pass
    
    return path


## @}
# end of Doxygen group

# ============================================================================
# private functions
# ============================================================================

# ----------------------------------------------------------------------------
def _initialize():
    """Initialize dictionaries with information about executable targets."""
    global _locations
    
    _locations = {
        'sbia.basis.basisproject' : '../../../../bin/basisproject',
        'sbia.basis.which' : '../../../../bin/which',
        'sbia.basis.doxyfilter' : '../../../doxyfilter',
        'sbia.basis.doxyfilter-matlab' : '../../../doxyfilter-matlab',
        'sbia.basis.doxyfilter-bash' : '../../../doxyfilter-bash',
        'sbia.basis.doxyfilter-cmake' : '../../../doxyfilter-cmake',
        'sbia.basis.doxyfilter-python' : '../../../doxyfilter-python',
        'sbia.basis.testdriver' : '../../../../bin/basistest-driver',
        'sbia.basis.basistest-svn' : '../../../../bin/basistest-svn',
        'sbia.basis.basistest-slave' : '../../../../bin/basistest-slave',
        'sbia.basis.basistest-master' : '../../../../bin/basistest-master',
        'sbia.basis.basistest-cron' : '../../../../bin/basistest-cron',
        'sbia.basis.basistest' : '../../../../bin/basistest',
        'sbia.basis.make_html_verbatim' : '../../../../bin/make_html_verbatim',
        'sbia.basis.dummy_command' : '../../../../../../../../../home/schuha/sandbox/build/basis-1.2.3/Testing/bin/dummy_command',
        'sbia.basis.test_matlabtools' : '../../../../../../../../../home/schuha/sandbox/build/basis-1.2.3/Testing/bin/test_matlabtools',
        'sbia.basis.test_basisproject' : '../../../../../../../../../home/schuha/sandbox/build/basis-1.2.3/Testing/bin/test_basisproject',
        'sbia.basis.test_path' : '../../../../../../../../../home/schuha/sandbox/build/basis-1.2.3/Testing/bin/test_path',
        'sbia.basis.test_subprocess' : '../../../../../../../../../home/schuha/sandbox/build/basis-1.2.3/Testing/bin/test_subprocess',
        'sbia.basis.test_core' : '../../../../../../../../../home/schuha/sandbox/build/basis-1.2.3/Testing/bin/test_core',
        'sbia.basis.test_shtap' : '../../../../../../../../../home/schuha/sandbox/build/basis-1.2.3/Testing/bin/test_shtap',
        'sbia.basis.parseargs' : '../../../../../../../../../home/schuha/sandbox/build/basis-1.2.3/Testing/bin/parseargs',
        'sbia.basis.test_utilities' : '../../../../../../../../../home/schuha/sandbox/build/basis-1.2.3/Testing/bin/test_utilities',
    }