UTDebugSymbolInfo.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program 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, version 2.0 of the
// License.
//
// This program 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 this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_DEBUG_SYMBOL_INFO_H_
#define _UT_DEBUG_SYMBOL_INFO_H_


//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTPath.h"


//==================================================================================================
class UT_EXPORT DebugSymbolInfo_t
//==================================================================================================
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
    inline                  DebugSymbolInfo_t();

    inline                  DebugSymbolInfo_t(  byte* function_name_buf,
                                                int function_name_buf_size );

    inline                  DebugSymbolInfo_t(  byte* function_name_buf,
                                                int function_name_buf_size,
                                                byte* file_name_buf,
                                                int file_name_buf_size );

    bool                    SetAddr(    const void* address,
                                        bool collect_file_name = true,
                                        bool file_leaf_name_only = true );

    inline const String_t&  FunctionName() const;

    inline uint32           FunctionOffset() const;

    inline const Path_t&    FileName() const;

    inline uint32           FileLineNumber() const;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    String_t                m_function_name;
    uint32                  m_function_offset;
    Path_t                  m_file_name;
    uint32                  m_file_line_number;

    friend class DebugSymbolInfoCacheEntry_t;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations
//===
//==================================================================================================
//==================================================================================================
inline 
DebugSymbolInfo_t::DebugSymbolInfo_t()
{
    m_function_offset = 0xFFFFFFFF;
    m_file_line_number = 0;
}


inline
DebugSymbolInfo_t::DebugSymbolInfo_t( byte* function_name_buf, int function_name_buf_size )
: m_function_name( function_name_buf, function_name_buf_size )
{
    m_function_offset = 0xFFFFFFFF;
    m_file_line_number = 0;
}


inline
DebugSymbolInfo_t::DebugSymbolInfo_t(   byte* function_name_buf,
                                        int function_name_buf_size,
                                        byte* file_name_buf,
                                        int file_name_buf_size )
:   m_function_name( function_name_buf, function_name_buf_size ),
    m_file_name( file_name_buf, file_name_buf_size )
{
    m_function_offset = 0xFFFFFFFF;
    m_file_line_number = 0;
}


inline const String_t&
DebugSymbolInfo_t::FunctionName() const
{
    assert( m_function_name.LengthBytes() );
    return m_function_name;
}


inline uint32
DebugSymbolInfo_t::FunctionOffset() const
{
    return m_function_offset;
}


inline const Path_t&
DebugSymbolInfo_t::FileName() const
{
    return m_file_name;
}


inline uint32
DebugSymbolInfo_t::FileLineNumber() const
{
    return m_file_line_number;
}


#endif // _UT_DEBUG_SYMBOL_INFO_H_