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 class orderdict(dict):
  32     def __init__(self, d = {}):
  33         self._keys = d.keys()
  34         super(orderdict, self).__init__(d)
  35
  36     def __setitem__(self, key, item):
  37         super(orderdict, self).__setitem__(key, item)
  38         if not hasattr(self, '_keys'):
  39             self._keys = [key,]
  40         if key not in self._keys:
  41             self._keys.append(key)
  42
  43     def __delitem__(self, key):
  44         super(orderdict, self).__delitem__(key)
  45         self._keys.remove(key)
  46
  47     def clear(self):
  48         super(orderdict, self).clear()
  49         self._keys = []
  50
  51     def items(self):
  52         for i in self._keys:
  53             yield i, self[i]
  54
  55     def keys(self):
  56         return self._keys
  57
  58     def popitem(self):
  59         if len(self._keys) == 0:
  60             raise KeyError('dictionary is empty')
  61         else:
  62             key = self._keys[-1]
  63             val = self[key]
  64             del self[key]
  65             return key, val
  66
  67     def setdefault(self, key, failobj = None):
  68         super(orderdict, self).setdefault(key, failobj)
  69         if key not in self._keys:
  70             self._keys.append(key)
  71
  72     def update(self, d):
  73         for key in d.keys():
  74             if not self.has_key(key):
  75                 self._keys.append(key)
  76         super(orderdict, self).update(d)
  77
  78     def values(self):
  79         for i in self._keys:
  80             yield self[i]