GDB (xrefs)
Loading...
Searching...
No Matches
Functions
gdb.frames Namespace Reference

Functions

 get_priority (filter_item)
 
 set_priority (filter_item, priority)
 
 get_enabled (filter_item)
 
 set_enabled (filter_item, state)
 
 return_list (name)
 
 _sort_list ()
 
 _frame_iterator (frame, frame_low, frame_high, dap_semantics)
 
 frame_iterator (frame, frame_low, frame_high)
 
 execute_frame_filters (frame, frame_low, frame_high)
 

Detailed Description

Internal functions for working with frame-filters.

Function Documentation

◆ _frame_iterator()

gdb.frames._frame_iterator ( frame,
frame_low,
frame_high,
dap_semantics )
protected

Definition at line 162 of file frames.py.

References gdb.frames._sort_list().

Referenced by gdb.frames.execute_frame_filters(), and gdb.frames.frame_iterator().

◆ _sort_list()

gdb.frames._sort_list ( )
protected
Internal Worker function to merge all known frame-filter
lists, prune any filters with the state set to "disabled", and
sort the list on the frame-filter's "priority" attribute.

Returns:
    sorted_list: A sorted, pruned list of frame filters to
                 execute.

Definition at line 141 of file frames.py.

References gdb.frames.return_list().

Referenced by gdb.frames._frame_iterator().

◆ execute_frame_filters()

gdb.frames.execute_frame_filters ( frame,
frame_low,
frame_high )
Internal function called from GDB that will execute the chain
of frame filters.  Each filter is executed in priority order.
After the execution completes, slice the iterator to frame_low -
frame_high range.

Arguments:
    frame: The initial frame.

    frame_low: The low range of the slice, counting from 0.  If
    this is a negative integer then it indicates a backward slice
    (ie bt -4) which counts backward from the last frame in the
    backtrace.

    frame_high: The high range of the slice, inclusive.  If this
    is -1 then it indicates all frames until the end of the stack
    from frame_low.

Returns:
    frame_iterator: The sliced iterator after all frame
    filters have had a chance to execute, or None if no frame
    filters are registered.

Definition at line 247 of file frames.py.

References gdb.frames._frame_iterator().

◆ frame_iterator()

gdb.frames.frame_iterator ( frame,
frame_low,
frame_high )
Helper function that will execute the chain of frame filters.
Each filter is executed in priority order.  After the execution
completes, slice the iterator to frame_low - frame_high range.  An
iterator is always returned.  The iterator will always yield
frame decorator objects, but note that these decorators have
slightly different semantics from the ordinary ones: they will
always return a fully-qualified 'filename' (if possible) and will
never substitute the objfile name.

Arguments:
    frame: The initial frame.

    frame_low: The low range of the slice, counting from 0.  If
    this is a negative integer then it indicates a backward slice
    (ie bt -4) which counts backward from the last frame in the
    backtrace.

    frame_high: The high range of the slice, inclusive.  If this
    is -1 then it indicates all frames until the end of the stack
    from frame_low.

Returns:
    frame_iterator: The sliced iterator after all frame
    filters have had a chance to execute.

Definition at line 217 of file frames.py.

References gdb.frames._frame_iterator().

◆ get_enabled()

gdb.frames.get_enabled ( filter_item)
Internal worker function to return a filter's enabled state
from a frame filter object.  This is a fail free function as it is
used in sorting and filtering.  If a badly implemented frame
filter does not implement the enabled attribute, return False
(otherwise sorting/filtering will fail and prevent other frame
filters from executing).

Arguments:
    filter_item: An object conforming to the frame filter
                 interface.

Returns:
    The enabled state of the frame filter from the "enabled"
    attribute, or False.

Definition at line 59 of file frames.py.

Referenced by gdb.command.frame_filters.InfoFrameFilter.print_list().

◆ get_priority()

gdb.frames.get_priority ( filter_item)
Internal worker function to return the frame-filter's priority
from a frame filter object.  This is a fail free function as it is
used in sorting and filtering.  If a badly implemented frame
filter does not implement the priority attribute, return zero
(otherwise sorting/filtering will fail and prevent other frame
filters from executing).

Arguments:
    filter_item: An object conforming to the frame filter
                 interface.

Returns:
    The priority of the frame filter from the "priority"
    attribute, or zero.

Definition at line 26 of file frames.py.

Referenced by gdb.command.frame_filters.ShowFrameFilterPriority.get_filter_priority(), and gdb.command.frame_filters.InfoFrameFilter.print_list().

◆ return_list()

gdb.frames.return_list ( name)
Internal Worker function to return the frame filter
dictionary, depending on the name supplied as an argument.  If the
name is not "all", "global" or "progspace", it is assumed to name
an object-file.

Arguments:
    name: The name of the list, as specified by GDB user commands.

Returns:
    A dictionary object for a single specified dictionary, or a
    list containing all the items for "all"

Raises:
    gdb.GdbError:  A dictionary of that name cannot be found.

Definition at line 95 of file frames.py.

References gdb.current_progspace(), and gdb.objfiles().

Referenced by gdb.command.frame_filters._do_enable_frame_filter(), gdb.command.frame_filters.SetFrameFilterPriority._set_filter_priority(), gdb.frames._sort_list(), gdb.command.frame_filters.EnableFrameFilter.complete(), gdb.command.frame_filters.DisableFrameFilter.complete(), gdb.command.frame_filters.SetFrameFilterPriority.complete(), gdb.command.frame_filters.ShowFrameFilterPriority.get_filter_priority(), and gdb.command.frame_filters.InfoFrameFilter.invoke().

◆ set_enabled()

gdb.frames.set_enabled ( filter_item,
state )
Internal Worker function to set the frame-filter's enabled
state.

Arguments:
    filter_item: An object conforming to the frame filter
                 interface.
    state: True or False, depending on desired state.

Definition at line 82 of file frames.py.

Referenced by gdb.command.frame_filters._do_enable_frame_filter(), and gdb.command.frame_filters.InfoFrameFilter.invoke().

◆ set_priority()

gdb.frames.set_priority ( filter_item,
priority )
Internal worker function to set the frame-filter's priority.

Arguments:
    filter_item: An object conforming to the frame filter
                 interface.
    priority: The priority to assign as an integer.

Definition at line 47 of file frames.py.

Referenced by gdb.command.frame_filters.SetFrameFilterPriority._set_filter_priority().