Namespaces | Macros | Functions | Variables
basis.h File Reference

BASIS utilities of BASIS project of BASIS package. More...

#include <basis/utilities.h>
+ Include dependency graph for basis.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 basis
 

Macros

#define _BASIS_BASIS_BASIS_H
 

Functions

std::string basis::bindir ()
 Get absolute path to directory containing runtime executables. More...
 
std::string basis::datadir ()
 Get absolute path to directory containing auxiliary data. More...
 
int basis::execute (const std::string &cmd, bool quiet=false, std::ostream *out=NULL, bool allow_fail=false, int verbose=0, bool simulate=false)
 Execute command as subprocess. More...
 
int basis::execute (std::vector< std::string > args, bool quiet=false, std::ostream *out=NULL, bool allow_fail=false, int verbose=0, bool simulate=false)
 Execute command as subprocess. More...
 
std::string basis::exedir (const std::string &name=std::string())
 Get directory of executable file. More...
 
std::string basis::exename (const std::string &name=std::string())
 Get name of executable file. More...
 
std::string basis::exepath (const std::string &name=std::string())
 Get absolute path of executable file. More...
 
bool basis::istarget (const std::string &name)
 Determine whether a given build target is known. More...
 
std::string basis::libdir ()
 Get absolute path to directory containing libraries. More...
 
std::string basis::libexecdir ()
 Get absolute path to directory containing auxiliary executables. More...
 
void basis::print_contact (const char *contact=NULL)
 Print contact information. More...
 
void basis::print_version (const char *name, const char *version=NULL, const char *project=NULL, const char *copyright=NULL, const char *license=NULL)
 Print version information including copyright and license notices. More...
 
std::string basis::targetuid (const std::string &name)
 Get UID of build target. More...
 

Variables

const char * basis::CONTACT = "andreas.schuh.84@gmail.com"
 Default contact to use for help output of executables. More...
 
const char * basis::COPYRIGHT = "2011-12 University of Pennsylvania, 2013-14 Carnegie Mellon University, 2013-16 Andreas Schuh"
 Default copyright of executables. More...
 
const char * basis::LICENSE = "See https://cmake-basis.github.io/download.html#license or COPYING file."
 Default license of executables. More...
 
const char * basis::PROJECT = "BASIS"
 The project name. More...
 
const char * basis::RELEASE = "v3.3 (fb18c98)"
 Complete version information as output by –version option. More...
 
const char * basis::VERSION = "3.3.1"
 The version string given as "<major>.<minor>.<patch>". More...
 
const unsigned int basis::VERSION_MAJOR = 3
 The major version number. More...
 
const unsigned int basis::VERSION_MINOR = 3
 The minor version number. More...
 
const unsigned int basis::VERSION_PATCH = 0
 The patch number. More...
 

Detailed Description

BASIS utilities of BASIS project of BASIS package.

Note
The basis.h module was automatically generated by BASIS from the template file basis.h.in which is part of the BASIS installation.

This header file includes the header files of the remaining BASIS utilities. Hence, it is sufficient to only include this header file.

Definition in file basis.h.

Macro Definition Documentation

§ _BASIS_BASIS_BASIS_H

#define _BASIS_BASIS_BASIS_H

Definition at line 25 of file basis.h.