LBPM/common/Utilities.h

#ifndef included_Utilities
#define included_Utilities

#include <cstdarg>
#include <vector>

#include "StackTrace/Utilities.h"


namespace Utilities {


// Functions inherited from StackTrace::Utilities
using StackTrace::Utilities::abort;
using StackTrace::Utilities::cause_segfault;
using StackTrace::Utilities::clearErrorHandlers;
using StackTrace::Utilities::exec;
using StackTrace::Utilities::getMemoryUsage;
using StackTrace::Utilities::getSystemMemory;
using StackTrace::Utilities::setAbortBehavior;
using StackTrace::Utilities::setErrorHandlers;
using StackTrace::Utilities::tick;
using StackTrace::Utilities::time;
using StackTrace::Utilities::sleep_ms;
using StackTrace::Utilities::sleep_s;


/*!
 * \brief Start MPI, error handlers
 * \details This routine will peform the default startup sequence
 * \param argc              argc from main
 * \param argv              argv from main
 */
void startup( int argc, char **argv );

/*!
 * \brief Stop MPI, error handlers
 * \details This routine will peform the default shutdown sequence to match startup
 */
void shutdown();


/*!
 * Get an environmental variable
 * @param name              The name of the environmental variable
 * @return                  The value of the enviornmental variable
 */
std::string getenv( const std::string &name );


/*!
 * Set an environmental variable
 * @param name              The name of the environmental variable
 * @param value             The value to set
 */
void setenv( const std::string &name, const std::string &value );


//! std::string version of sprintf
inline std::string stringf( const char *format, ... );


//! Factor a number into it's prime factors
std::vector<int> factor(size_t number);


//! Null use function
void nullUse( void* );


} // namespace Utilities


#include "common/UtilityMacros.h"


// stringf
inline std::string Utilities::stringf( const char *format, ... )
{
    va_list ap;
    va_start( ap, format );
    char tmp[4096];
    vsprintf( tmp, format, ap );
    va_end( ap );
    return std::string( tmp );
}


#endif