gdb/python/lib/gdb/FrameIterator.py

   1 # Copyright (C) 2013-2021 Free Software Foundation, Inc.
   2
   3 # This program is free software; you can redistribute it and/or modify
   4 # it under the terms of the GNU General Public License as published by
   5 # the Free Software Foundation; either version 3 of the License, or
   6 # (at your option) any later version.
   7 #
   8 # This program is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 # GNU General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU General Public License
  14 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15
  16
  17 class FrameIterator(object):
  18     """A gdb.Frame iterator.  Iterates over gdb.Frames or objects that
  19     conform to that interface."""
  20
  21     def __init__(self, frame_obj):
  22         """Initialize a FrameIterator.
  23
  24         Arguments:
  25             frame_obj the starting frame."""
  26
  27         super(FrameIterator, self).__init__()
  28         self.frame = frame_obj
  29
  30     def __iter__(self):
  31         return self
  32
  33     def next(self):
  34         """next implementation.
  35
  36         Returns:
  37             The next oldest frame."""
  38
  39         result = self.frame
  40         if result is None:
  41             raise StopIteration
  42         self.frame = result.older()
  43         return result
  44
  45     # Python 3.x requires __next__(self) while Python 2.x requires
  46     # next(self).  Define next(self), and for Python 3.x create this
  47     # wrapper.
  48     def __next__(self):
  49         return self.next()