gdb.frames
index
/opt/gsrc/packages/gdb-7.11.1/share/gdb/python/gdb/frames.py

Internal functions for working with frame-filters.

 
Modules
       
collections
gdb
itertools

 
Functions
       
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.  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.  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 change to execute, or None if no frame
    filters are registered.
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.
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.
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.
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.
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.