tim::source_location Class Reference

Provides source location information and variadic joining of source location tags. More...

#include "timemory/general/source_location.hpp"

Collaboration diagram for tim::source_location:

Classes
struct	captured

Public Types
enum class	mode : short {   blank = 0 ,   basic = 1 ,   full = 2 ,   complete = 3 }
using	join_type = mpl::apply< std::string >
using	result_type = std::tuple< std::string, size_t >

Public Member Functions
template<typename... ArgsT, enable_if_t<!is_constant_char< ArgsT... >(), int > = 0>
	source_location (const mode &_mode, const char *_func, int _line, const char *_fname, ArgsT &&...)
template<typename... ArgsT, enable_if_t< is_constant_char< ArgsT... >(), int > = 0>
	source_location (const mode &_mode, const char *_func, int _line, const char *_fname, ArgsT &&... _args)
	source_location ()=delete
	~source_location ()=default
	source_location (const source_location &)=delete
	source_location (source_location &&)=default
source_location &	operator= (const source_location &)=delete
source_location &	operator= (source_location &&)=default
template<typename... ArgsT, enable_if_t<(sizeof...(ArgsT) > 0) &&!is_constant_char< ArgsT... >(), int > = 0>
const captured &	get_captured (ArgsT &&... _args)
const captured &	get_captured () const
template<typename... ArgsT, enable_if_t<(sizeof...(ArgsT) > 0) &&is_constant_char< ArgsT... >(), int > = 0>
const captured &	get_captured (ArgsT &&...)

Static Public Member Functions
template<typename... ArgsT>
static captured	get_captured_inline (const mode &_mode, const char *_func, int _line, const char *_fname, ArgsT &&... _args)

Protected Member Functions
void	compute_data (const char *_func)
void	compute_data (const char *_func, int _line, const char *_fname, bool shorten)

Detailed Description

Provides source location information and variadic joining of source location tags.

Definition at line 78 of file source_location.hpp.

Member Typedef Documentation

join_type

using tim::source_location::join_type = mpl::apply<std::string>

Definition at line 81 of file source_location.hpp.

result_type

using tim::source_location::result_type = std::tuple<std::string, size_t>

Definition at line 82 of file source_location.hpp.

Member Enumeration Documentation

mode

enum class tim::source_location::mode : short

strong

Enumerator
blank
basic
full
complete

Definition at line 98 of file source_location.hpp.

    {
        blank    = 0,
        basic    = 1,
        full     = 2,
        complete = 3
    };

Constructor & Destructor Documentation

source_location() [1/5]

template<typename... ArgsT, enable_if_t<!is_constant_char< ArgsT... >(), int > = 0>

tim::source_location::source_location ( const mode &  _mode, const char *  _func, int  _line, const char *  _fname, ArgsT &&  ...  )

inline

Definition at line 189 of file source_location.hpp.

    : m_mode(_mode)
    {
        switch(m_mode)
        {
            case mode::blank: break;
            case mode::basic: compute_data(_func); break;
            case mode::complete:
            case mode::full:
                compute_data(_func, _line, _fname, m_mode == mode::full);
                break;
        }
    }

References basic, blank, complete, compute_data(), and full.

source_location() [2/5]

template<typename... ArgsT, enable_if_t< is_constant_char< ArgsT... >(), int > = 0>

tim::source_location::source_location ( const mode &  _mode, const char *  _func, int  _line, const char *  _fname, ArgsT &&...  _args  )

inline

Definition at line 208 of file source_location.hpp.

    : m_mode(_mode)
    {
        auto _arg = join_type::join("", _args...);
        switch(m_mode)
        {
            case mode::blank:
            {
                // label and hash
                auto&& _label = _arg;
                auto&& _hash  = add_hash_id(_label);
                m_captured    = captured(result_type{ _label, _hash });
                break;
            }
            case mode::basic:
            {
                compute_data(_func);
                auto&& _label = _join(_arg.c_str());
                auto&& _hash  = add_hash_id(_label);
                m_captured    = captured(result_type{ _label, _hash });
                break;
            }
            case mode::full:
            case mode::complete:
            {
                compute_data(_func, _line, _fname, m_mode == mode::full);
                // label and hash
                auto&& _label = _join(_arg.c_str());
                auto&& _hash  = add_hash_id(_label);
                m_captured    = captured(result_type{ _label, _hash });
                break;
            }
        }
    }

References tim::_args, basic, blank, complete, compute_data(), full, and tim::plotting::operation::join().

source_location() [3/5]

tim::source_location::source_location ( )

delete

~source_location()

tim::source_location::~source_location ( )

default

source_location() [4/5]

tim::source_location::source_location ( const source_location &  )

delete

source_location() [5/5]

tim::source_location::source_location ( source_location &&  )

default

Member Function Documentation

compute_data() [1/2]

void tim::source_location::compute_data ( const char *  _func )

inlineprotected

Definition at line 256 of file source_location.hpp.

{ m_prefix = _func; }

Referenced by source_location().

compute_data() [2/2]

void tim::source_location::compute_data ( const char *  _func, int  _line, const char *  _fname, bool  shorten  )

inlineprotected

Definition at line 260 of file source_location.hpp.

    {
#if defined(TIMEMORY_WINDOWS)
        static const char delim = '\\';
#else
        static const char delim = '/';
#endif
        std::string _filename(_fname);
        if(shorten)
        {
            if(_filename.find(delim) != std::string::npos)
                _filename = _filename.substr(_filename.find_last_of(delim) + 1);
        }
 
        if(_line < 0)
        {
            if(_filename.length() > 0)
            {
                m_prefix = join_type::join("", _func, '@', _filename);
            }
            else
            {
                m_prefix = _func;
            }
        }
        else
        {
            if(_filename.length() > 0)
            {
                m_prefix = join_type::join("", _func, '@', _filename, ':', _line);
            }
            else
            {
                m_prefix = join_type::join("", _func, ':', _line);
            }
        }
    }

References tim::plotting::operation::join().

get_captured() [1/3]

const captured & tim::source_location::get_captured ( ) const

inline

Definition at line 311 of file source_location.hpp.

{ return m_captured; }

get_captured() [2/3]

template<typename... ArgsT, enable_if_t<(sizeof...(ArgsT) > 0) &&!is_constant_char< ArgsT... >(), int > = 0>

const captured & tim::source_location::get_captured ( ArgsT &&...  _args )

inline

Definition at line 304 of file source_location.hpp.

    {
        return m_captured.set(*this, std::forward<ArgsT>(_args)...);
    }

References tim::_args.

get_captured() [3/3]

template<typename... ArgsT, enable_if_t<(sizeof...(ArgsT) > 0) &&is_constant_char< ArgsT... >(), int > = 0>

const captured & tim::source_location::get_captured ( ArgsT &&  ... )

inline

Definition at line 318 of file source_location.hpp.

    {
        return m_captured;
    }

get_captured_inline()

template<typename... ArgsT>

static captured tim::source_location::get_captured_inline ( const mode &  _mode, const char *  _func, int  _line, const char *  _fname, ArgsT &&...  _args  )

inlinestatic

Definition at line 173 of file source_location.hpp.

    {
        source_location _loc{ _mode, _func, _line, _fname,
                              std::forward<ArgsT>(_args)... };
        return _loc.get_captured(std::forward<ArgsT>(_args)...);
    }

References tim::_args.

operator=() [1/2]

source_location & tim::source_location::operator= ( const source_location &  )

delete

operator=() [2/2]

source_location & tim::source_location::operator= ( source_location &&  )

default

---

The documentation for this class was generated from the following file:

• timemory/general/source_location.hpp