util.hpp

Go to the documentation of this file.

/*
 * Copyright 2008,2009,2010,2011,2012 Stephan Ossowski, Korbinian Schneeberger,
 * Felix Ott, Joerg Hagmann, Alf Scotland, Sebastian Bender
 * 
 * This file is part of SHORE.
 * 
 * SHORE is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * SHORE is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with SHORE.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef SHORE_MISC_UTIL_HPP__
#define SHORE_MISC_UTIL_HPP__

#ifdef HAVE_CONFIG_H
  #include "config.h"
#endif

#include <string>
#include <vector>
#include <ctime>

#include <boost/progress.hpp>

#ifdef WITH_BACKTRACE
  #include <execinfo.h>
#endif

namespace shore {

enum ExtendedFlag
{
        XFLAG_NA=-1,
        XFLAG_FALSE=0,
        XFLAG_TRUE=1,
        XFLAG_IRRELEVANT=2
};

#ifdef WITH_BACKTRACE
inline void print_backtrace()
{
        void* buf[20];
        const int bs=::backtrace(buf,shore::size(buf));
        std::cerr<<"\nBacktrace:\n----------\n";
        ::backtrace_symbols_fd(buf,bs,STDERR_FILENO);
}
#endif // WITH_BACKTRACE

template<typename T>
void throw_exception(const T & ex)
{
  #ifdef DEBUG
        std::cerr<<"\nException generated: "<<ex.what()<<std::endl;
    #ifdef WITH_BACKTRACE
        print_backtrace();
    #endif // WITH_BACKTRACE
  #endif // DEBUG

        throw ex;
}

int get_maxopenfiles(const bool hardlim=false);

int get_nopenfiles();

std::string timestr();

uint64_t time_stamp();

class timer
{
 private:

        time_t m_start_time;
        time_t m_last_time;

 public:

        timer();

        std::pair<double,double> bump();

};

class progress_timer
{
 private:

        boost::progress_timer m_pt;
        const std::string m_name;

 public:

        progress_timer():m_pt(std::cerr),m_name("#") {}

        progress_timer(const std::string& name)
        :m_pt(std::cerr),m_name(name) {}

        ~progress_timer() { std::cerr<<m_name<<" "<<timestr()<<" | "; }
};

} // namespace

#endif // SHORE_MISC_UTIL_HPP__