ers::Context Class Reference

Source context for Issue. More...

#include <Context.h>

Public Member Functions
	Context (const std::string &filename, int line_number, const std::string &function_name, const std::string &compiler_name, const std::string &compiler_version, const std::string &compilation_time, const std::string &compilation_date, const std::string &package)
const std::string &	file () const throw ()
int	line () const throw ()
const std::string &	function () const throw ()
const std::string &	position () const
const std::string &	compiler () const
const std::string &	compilation () const
const std::string &	package_name () const throw ()
int	stack_frames () const throw ()
const std::string &	stack_frame (int i) const
std::vector< std::string >	qualifiers () const throw ()

Static Public Member Functions
static const Context *	empty ()
static std::string &	host_type ()
	type of target host
static int	debug_level ()
static void	add_qualifier (const std::string &qualif)

Static Protected Member Functions
static void	build_host_type ()

Protected Attributes
std::string	m_file_name
int	m_line_number
std::string	m_function_name
std::string	m_compiler_name
std::string	m_compiler_version
std::string	m_compilation_date
std::string	m_compilation_time
std::string	m_package_name
std::string	m_compiler
std::string	m_position
std::string	m_compilation
std::vector< std::string >	m_stack_frames

Static Protected Attributes
static Context *	empty_instance = 0
static std::string	s_host_type
static std::vector< std::string >	default_qualifiers

Detailed Description

Source context for Issue.

This class encapsulates Context information for an issue. The context of an issue is the location in the code the issue was constructed. The context acts as an encapsulator for compilator generted information like:

• source file
• source line
• function name
• compilation date and time
• compilator type

The current context can be obtained using the macro ERS_HERE An empty context can be obtained using the macro ERS_EMPTY

Author

Matthias Wiesmann

Version

1.1 - now returns references

Note

it should be possible to optimize out the compilation text string, have only one default instance if all the code share the same info. This would save some memory space.

Definition at line 42 of file Context.h.

Constructor & Destructor Documentation

Context()

ers::Context::Context	(	const std::string &	filename,
		int	line_number,
		const std::string &	function_name,
		const std::string &	compiler_name,
		const std::string &	compiler_version,
		const std::string &	compilation_time,
		const std::string &	compilation_date,
		const std::string &	package_name )

Constructor - defines an Issue context. This constructor should generally not be called directly, instead use the macro ERS_HERE.

Parameters

filename	name of the source code file
line_number	line_number in the source code
function_name	name of the function - either pretty printed or not
compiler_name	name of the compiler
compiler_version	version of the compiler
compilation_time	time of the compilation
compilation_date	date of the compilation

Definition at line 71 of file Context.cxx.

                                             {
    this->m_file_name = filename ; 
    this->m_line_number = line_number ; 
    this->m_function_name = function_name ; 
    this->m_compiler_name = compiler_name ; 
    this->m_compiler_version = compiler_version ; 
    this->m_compilation_date = compilation_date ; 
    this->m_compilation_time = compilation_time ; 
    this->m_package_name = package_name ; 
#if defined(__GNU_LIBRARY__)
    void * array[128] ; 
    const int n_size =  backtrace (array,128) ; 
    char ** symbols = backtrace_symbols(array, n_size);
    for (int i = 1; i < n_size; i++) { // we start at 1, current position is noise 
    this->m_stack_frames.push_back(symbols[i]);
    } // for
    free(symbols);
#endif
} // Context

Member Function Documentation

add_qualifier()

void ers::Context::add_qualifier ( const std::string & qualif )

static

Definition at line 56 of file Context.cxx.

                                                      {
    default_qualifiers.push_back(qualif) ;
} // add_qualifier

Referenced by main().

build_host_type()

void ers::Context::build_host_type ( )

staticprotected

stack frames

Definition at line 189 of file Context.cxx.

                                 {
    std::ostringstream plateform_s ;
#if defined(__linux__) 
    plateform_s << "linux" ; 
#endif
#if defined(__OpenBSD__)
    plateform_s << "OpenBSD" ;
#endif
#if defined(__FreeBSD__) 
    plateform_s << "FreeBSD" ;
#endif
#if defined(__APPLE__) && defined(__MACH__)
    plateform_s << "Darwin" ; 
#endif
#if defined(__SOLARIS__)
    plateform_s << "Solaris" ;
#endif    
    plateform_s << "/" ; 
#if defined(__POWERPC__)  || defined(__ppc__ ) || defined( __PPC__ ) || defined( powerpc ) || defined( ppc )
    plateform_s << "PowerPC" ; 
#endif
#if defined(__i386__) || defined(__INTEL__) || defined( intel ) || defined( _M_IX86 ) 
    plateform_s << "i386" ;
#endif
#if defined(sparc) || defined(__sparc)   
    plateform_s << "Sparc" ; 
#endif
   s_host_type=  plateform_s.str();
} // build_host_type

compilation()

const std::string & ers::Context::compilation

(

)

const

Returns

compilation time and date

Pretty printed compilation time description

Returns

reference to string containing description

Definition at line 168 of file Context.cxx.

                                                {
    if (m_compilation.empty()) {
    std::ostringstream compilation_s ;
    if (! m_compilation_time.empty()) {
        compilation_s << m_compilation_time << " " ; 
    } // compilation time
    if (! m_compilation_date.empty()) {
        compilation_s << m_compilation_date ; 
    } // compilation date
    m_compilation = compilation_s.str(); 
    } // if
    return m_compilation ; 
} // compilation

compiler()

const std::string & ers::Context::compiler

(

)

const

Returns

compiler (compiler-name + compiler-version)

Pretty printed compiler name

Returns

reference to string containing format

Definition at line 151 of file Context.cxx.

                                             {
    if (m_compiler.empty()) {
    if (! m_compiler_name.empty()) {
        std::ostringstream compiler_s ;
        compiler_s << m_compiler_name << " " << m_compiler_version ; 
        m_compiler = compiler_s.str(); 
    } else {
        m_compiler = "unknown" ; 
    } 
    } // build cache
    return m_compiler ; 
} // compiler

debug_level()

int ers::Context::debug_level ( )

static

Gives the current debug level

Returns

debug level, or -1 if it cannot be determined

Definition at line 48 of file Context.cxx.

                            {
#if defined(DEBUG_LEVEL) 
    return DEBUG_LEVEL ; 
#else 
    return -1 ; 
#endif
} // debug_level

Referenced by ers::Issue::insert().

empty()

const ers::Context * ers::Context::empty ( )

static

Returns the empty instance

Returns

a pointer to the empty instance.

Definition at line 27 of file Context.cxx.

                                    {
    if (! empty_instance) {
    std::string empty = "" ; 
    empty_instance = new ers::Context(empty,0,empty,empty,empty,empty,empty,empty) ; 
    } // if 
    return empty_instance ; 
} // empty 

Referenced by empty().

file()

const std::string & ers::Context::file	(		)	const
throw	(	)

Returns

file-name

The source code file name

Returns

path of the source file

Definition at line 98 of file Context.cxx.

                                                 {
    return m_file_name ; 
} // file

function()

const std::string & ers::Context::function	(		)	const
throw	(	)

Returns

function name

Name of the function containing the context

Returns

name of the function

Definition at line 114 of file Context.cxx.

                                                     {
    return m_function_name ; 
} // function

Referenced by ers::NotImplemented::NotImplemented().

host_type()

std::string & ers::Context::host_type ( )

static

type of target host

Tries to gues the host name

Returns

a string describing the host, in the form architecture-operating-system

Definition at line 39 of file Context.cxx.

                                  {
    if (s_host_type.empty()) build_host_type() ; 
    return s_host_type ; 
} // plateform

line()

int ers::Context::line	(		)	const
throw	(	)

Returns

line-number

The line number in the source code

Returns

line number

Definition at line 106 of file Context.cxx.

                                   {
    return m_line_number ; 
} // line 

package_name()

const std::string & ers::Context::package_name	(		)	const
throw	(	)

Returns

package name (if defined by CMT)

package name

Definition at line 185 of file Context.cxx.

                                                         {
    return m_package_name ; 
} // package_name

position()

const std::string & ers::Context::position

(

)

const

Returns

position (i.e file+line+function)

Pretty printed code position format: file_name:line_number (function_name)

Returns

reference to string containing format

Note

the file name is truncated from the last slash

Definition at line 124 of file Context.cxx.

                                             {
    if (m_position.empty()) {
    std::ostringstream position_s ;
    if (! m_package_name.empty()) {
        position_s << m_package_name << ":" ; 
    } 
    if (! m_file_name.empty()) {
        const std::string::size_type p = m_file_name.rfind('/') ; 
        if (std::string::npos == p) {
        position_s << m_file_name ; 
        } else {
        position_s << (m_file_name.substr(p+1)) ; 
        } //
        position_s << ":" << m_line_number << " ";
    } 
    if (! m_function_name.empty()) {
        position_s << "(" << m_function_name << ")" ;
    } // if
    m_position = position_s.str();
    } // cached version not calculated 
    return m_position ; 
} // position

qualifiers()

std::vector< std::string > ers::Context::qualifiers	(		)	const
throw	(	)

Returns

array of qualifiers

Returns the set of qualifiers associated with context At the moment, this includes the default qualifiers plus the package

Returns

array of strings represnting the qualifiers

Definition at line 232 of file Context.cxx.

                                                           {
    std::vector<std::string> qualif = default_qualifiers ;
    if (! m_package_name.empty()) {
    qualif.push_back(m_package_name) ; 
    } // if 
    return qualif ; 
} // qualifiers

stack_frame()

const std::string & ers::Context::stack_frame

(

int

i

)

const

Returns

stack frame with index

Definition at line 223 of file Context.cxx.

                                                     {
   return m_stack_frames[i] ; 
} // stack_frame

stack_frames()

int ers::Context::stack_frames	(		)	const
throw	(	)

Returns

number of stack frames

Definition at line 219 of file Context.cxx.

                                           {
   return m_stack_frames.size();
} // stack_frames

Member Data Documentation

default_qualifiers

std::vector< std::string > ers::Context::default_qualifiers

staticprotected

vector of default qualifiers

Definition at line 46 of file Context.h.

empty_instance

ers::Context * ers::Context::empty_instance = 0

staticprotected

Definition at line 44 of file Context.h.

Referenced by empty().

m_compilation

std::string ers::Context::m_compilation

mutableprotected

compilation (cache)

Definition at line 57 of file Context.h.

m_compilation_date

std::string ers::Context::m_compilation_date

protected

compilation date

Definition at line 52 of file Context.h.

m_compilation_time

std::string ers::Context::m_compilation_time

protected

compilation time

Definition at line 53 of file Context.h.

m_compiler

std::string ers::Context::m_compiler

mutableprotected

compilation string (cache)

Definition at line 55 of file Context.h.

m_compiler_name

std::string ers::Context::m_compiler_name

protected

compiler name

Definition at line 50 of file Context.h.

m_compiler_version

std::string ers::Context::m_compiler_version

protected

compiler version

Definition at line 51 of file Context.h.

m_file_name

std::string ers::Context::m_file_name

protected

source file-name

Definition at line 47 of file Context.h.

m_function_name

std::string ers::Context::m_function_name

protected

source function name (can be pretty printed or not)

Definition at line 49 of file Context.h.

m_line_number

int ers::Context::m_line_number

protected

source line-number

Definition at line 48 of file Context.h.

m_package_name

std::string ers::Context::m_package_name

protected

Definition at line 54 of file Context.h.

m_position

std::string ers::Context::m_position

mutableprotected

code position (cache)

Definition at line 56 of file Context.h.

m_stack_frames

std::vector<std::string> ers::Context::m_stack_frames

protected

Definition at line 58 of file Context.h.

s_host_type

std::string ers::Context::s_host_type

staticprotected

host_type

Definition at line 45 of file Context.h.

---

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

• Context.h
• Context.cxx