src/python/m5/util/orderdict.py

   1 # Copyright (c) 2005 The Regents of The University of Michigan
   2 # All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met: redistributions of source code must retain the above copyright
   7 # notice, this list of conditions and the following disclaimer;
   8 # redistributions in binary form must reproduce the above copyright
   9 # notice, this list of conditions and the following disclaimer in the
  10 # documentation and/or other materials provided with the distribution;
  11 # neither the name of the copyright holders nor the names of its
  12 # contributors may be used to endorse or promote products derived from
  13 # this software without specific prior written permission.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  18 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  19 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 #
  27 # Authors: Nathan Binkert
  28
  29 __all__ = [ 'orderdict' ]
  30
  31 from UserDict import DictMixin
  32
  33 class orderdict(dict, DictMixin):
  34     def __init__(self, *args, **kwargs):
  35         if len(args) > 1:
  36             raise TypeError("expected at most one argument, got %d" % \
  37                             len(args))
  38         self._keys = []
  39         self.update(*args, **kwargs)
  40
  41     def __setitem__(self, key, item):
  42         if key not in self:
  43             self._keys.append(key)
  44         super(orderdict, self).__setitem__(key, item)
  45
  46     def __delitem__(self, key):
  47         super(orderdict, self).__delitem__(key)
  48         self._keys.remove(key)
  49
  50     def clear(self):
  51         super(orderdict, self).clear()
  52         self._keys = []
  53
  54     def iterkeys(self):
  55         for key in self._keys:
  56             yield key
  57
  58     def itervalues(self):
  59         for key in self._keys:
  60             yield self[key]
  61
  62     def iteritems(self):
  63         for key in self._keys:
  64             yield key, self[key]
  65
  66     def keys(self):
  67         return self._keys[:]
  68
  69     def values(self):
  70         return [ self[key] for key in self._keys ]
  71
  72     def items(self):
  73         return [ (self[key],key) for key in self._keys ]