Ruminate
Type introspection for C
 All Classes Files Functions Enumerations Enumerator Macros Pages
RFrame Struct Reference

An opaque struct representing a call stack frame. More...

Public Member Functions

void r_frame_ref (RFrame *frame)
 Increment the reference count of this RFrame. More...
 
void r_frame_unref (RFrame *frame)
 Decrement the reference count of this RFrame. More...
 
RStringr_frame_function_name (RFrame *frame, GError **error)
 Get the name of the function this RFrame represents. More...
 
RStringr_frame_module_name (RFrame *frame, GError **error)
 Get the name of the module which contains this frame. More...
 
RStringr_frame_compile_unit_name (RFrame *frame, GError **error)
 Get the name of the compile unit which contains this frame. More...
 
RTyper_frame_function_type (RFrame *frame, GError **error)
 Get the type of this function. More...
 
uintmax_t r_frame_line (RFrame *frame, GError **error)
 Get the line number that this frame is at. More...
 

Detailed Description

An opaque struct representing a call stack frame.

Member Function Documentation

RString * r_frame_compile_unit_name ( RFrame frame,
GError **  error 
)

Get the name of the compile unit which contains this frame.

This is usually the name of the file which defined this function.

Returns
a RString containing the name of this compile unit.
Parameters
[in]framethe frame to get the compile unit name of
[out]errorsee errors.h
RString * r_frame_function_name ( RFrame frame,
GError **  error 
)

Get the name of the function this RFrame represents.

Returns
a RString containing the name of this function.
Parameters
[in]framethe frame to get the name of
[out]errorsee errors.h
RType * r_frame_function_type ( RFrame frame,
GError **  error 
)

Get the type of this function.

Returns
an RType representing the type of this function.
Parameters
[in]framethe frame to get the type of
[out]errorsee errors.h
uintmax_t r_frame_line ( RFrame frame,
GError **  error 
)

Get the line number that this frame is at.

Returns
the line number that this frame is at
Parameters
[in]framethe frame to get the line number of
[out]errorsee errors.h
RString * r_frame_module_name ( RFrame frame,
GError **  error 
)

Get the name of the module which contains this frame.

This is usually the name of the executable or library.

Returns
a RString containing the name of this module.
Parameters
[in]framethe frame to get the module name of
[out]errorsee errors.h
void r_frame_ref ( RFrame frame)

Increment the reference count of this RFrame.

Parameters
[in]framethe frame to increment the reference count of
void r_frame_unref ( RFrame frame)

Decrement the reference count of this RFrame.

The RFrame will be freed if it's reference count drops to zero.

Parameters
[in]framethe frame to decrement the reference count of

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