Basis.pm

Go to the documentation of this file.

# ============================================================================
# Copyright (c) 2011-2012 University of Pennsylvania
# Copyright (c) 2013-2016 Andreas Schuh
# All rights reserved.
#
# See COPYING file for license information or visit
# https://cmake-basis.github.io/download.html#license
# ============================================================================

##############################################################################
# @file  Basis.pm
# @brief BASIS utilities of BASIS package.
#
# @note The Basis.pm module was automatically created by BASIS from the
#       template file Basis.pm.in which is part of BASIS.
#
# This module imports the modules of the BASIS utilities for Perl and exports
# these utility functions as part of its own package scope next to the functions
# defined by this module itself. Hence, it is sufficient to only use this module.
#
# @ingroup BasisPerlUtilities
##############################################################################

use strict;
use warnings;

package BASIS::Basis;
{
    $BASIS::Basis::VERSION = 3.03_00;
}


## @addtogroup BasisPerlUtilities
# @{


# ============================================================================
# exports
# ============================================================================

use BASIS::Sub::Exporter -setup => {
    exports => [
        qw(print_contact print_version targetuid istarget exepath exename
           exedir tostring qsplit execute)],
    groups => {
        default    => [qw(print_contact print_version exepath exename exedir execute)],
        everything => [qw(print_contact print_version targetuid istarget
                          exepath exename exedir tostring qsplit execute)]
    }
};

# ============================================================================
# configuration
# ============================================================================

## @brief Project name.
use constant PROJECT   => 'BASIS';
## @brief Project release.
use constant RELEASE   => 'v3.3 (71f5085)';
## @brief Default copyright of executables.
use constant COPYRIGHT => '2011-12 University of Pennsylvania, 2013-14 Carnegie Mellon University, 2013-16 Andreas Schuh';
## @brief Default license of executables.
use constant LICENSE   => 'See https://cmake-basis.github.io/download.html#license or COPYING file.';
## @brief Default contact to use for help output of executables.
use constant CONTACT   => 'andreas.schuh.84@gmail.com';

# ============================================================================
# custom utilities
# ============================================================================

my ($_TARGET_PREFIX, %_EXECUTABLE_TARGETS, $_TARGETS_BASE);

BEGIN {
    use File::Basename qw(dirname);

    $_TARGET_PREFIX = 'basis';

    %_EXECUTABLE_TARGETS = (
        'basis.basisproject'           => '../../../bin/basisproject',
        'basis.testdriver'             => '../../testdriver',
        'basis.basistest'              => '../../../bin/basistest',
        'basis.basistest-master'       => '../../basistest-master',
        'basis.basistest-slave'        => '../../basistest-slave',
        'basis.basistest-cron'         => '../../basistest-cron',
        'basis.basistest-svn'          => '../../basistest-svn',
        'basis.doxyfilter'             => '../../doxyfilter',
        'basis.doxyfilter-perl'        => '../../doxyfilter-perl',
        'basis.dummy_command'          => '../../../bin/dummy_command',
        'basis.test_future_statements' => '',
        'basis.test_matlabtools'       => '',
        'basis.test_basisproject'      => '',
        'basis.test_os'                => '../../../bin/test_os',
        'basis.test_path'              => '../../../bin/test_path',
        'basis.test_subprocess'        => '../../../bin/test_subprocess',
        'basis.test_core'              => '',
        'basis.test_shutilities'       => '',
        'basis.test_shtap'             => '',
        'basis.parseargs'              => '../../../bin/parseargs',
        'basis.test_utilities'         => ''
    );

    $_TARGETS_BASE = dirname(__FILE__);
}

use BASIS::Utilities qw(tostring qsplit),
        print_contact => { contact => CONTACT },
        print_version => { project => PROJECT, version => RELEASE, copyright => COPYRIGHT, license => LICENSE },
        targetuid     => { prefix => $_TARGET_PREFIX, targets => \%_EXECUTABLE_TARGETS, base => $_TARGETS_BASE },
        istarget      => { prefix => $_TARGET_PREFIX, targets => \%_EXECUTABLE_TARGETS, base => $_TARGETS_BASE },
        exepath       => { prefix => $_TARGET_PREFIX, targets => \%_EXECUTABLE_TARGETS, base => $_TARGETS_BASE },
        exename       => { prefix => $_TARGET_PREFIX, targets => \%_EXECUTABLE_TARGETS, base => $_TARGETS_BASE },
        exedir        => { prefix => $_TARGET_PREFIX, targets => \%_EXECUTABLE_TARGETS, base => $_TARGETS_BASE },
        execute       => { prefix => $_TARGET_PREFIX, targets => \%_EXECUTABLE_TARGETS, base => $_TARGETS_BASE };


## @}
# end of Doxygen group


1; # indicate success of module loading