michael@0: // Copyright (c) 2006, Google Inc.
michael@0: // All rights reserved.
michael@0: //
michael@0: // Redistribution and use in source and binary forms, with or without
michael@0: // modification, are permitted provided that the following conditions are
michael@0: // met:
michael@0: //
michael@0: //     * Redistributions of source code must retain the above copyright
michael@0: // notice, this list of conditions and the following disclaimer.
michael@0: //     * Redistributions in binary form must reproduce the above
michael@0: // copyright notice, this list of conditions and the following disclaimer
michael@0: // in the documentation and/or other materials provided with the
michael@0: // distribution.
michael@0: //     * Neither the name of Google Inc. nor the names of its
michael@0: // contributors may be used to endorse or promote products derived from
michael@0: // this software without specific prior written permission.
michael@0: //
michael@0: // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0: // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0: // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0: // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
michael@0: // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
michael@0: // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
michael@0: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
michael@0: // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
michael@0: // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0: // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
michael@0: // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: 
michael@0: // address_map.h: Address maps.
michael@0: //
michael@0: // An address map contains a set of objects keyed by address.  Objects are
michael@0: // retrieved from the map by returning the object with the highest key less
michael@0: // than or equal to the lookup key.
michael@0: //
michael@0: // Author: Mark Mentovai
michael@0: 
michael@0: #ifndef PROCESSOR_ADDRESS_MAP_H__
michael@0: #define PROCESSOR_ADDRESS_MAP_H__
michael@0: 
michael@0: #include <map>
michael@0: 
michael@0: namespace google_breakpad {
michael@0: 
michael@0: // Forward declarations (for later friend declarations).
michael@0: template<class, class> class AddressMapSerializer;
michael@0: 
michael@0: template<typename AddressType, typename EntryType>
michael@0: class AddressMap {
michael@0:  public:
michael@0:   AddressMap() : map_() {}
michael@0: 
michael@0:   // Inserts an entry into the map.  Returns false without storing the entry
michael@0:   // if an entry is already stored in the map at the same address as specified
michael@0:   // by the address argument.
michael@0:   bool Store(const AddressType &address, const EntryType &entry);
michael@0: 
michael@0:   // Locates the entry stored at the highest address less than or equal to
michael@0:   // the address argument.  If there is no such range, returns false.  The
michael@0:   // entry is returned in entry, which is a required argument.  If
michael@0:   // entry_address is not NULL, it will be set to the address that the entry
michael@0:   // was stored at.
michael@0:   bool Retrieve(const AddressType &address,
michael@0:                 EntryType *entry, AddressType *entry_address) const;
michael@0: 
michael@0:   // Empties the address map, restoring it to the same state as when it was
michael@0:   // initially created.
michael@0:   void Clear();
michael@0: 
michael@0:  private:
michael@0:   friend class AddressMapSerializer<AddressType, EntryType>;
michael@0:   friend class ModuleComparer;
michael@0: 
michael@0:   // Convenience types.
michael@0:   typedef std::map<AddressType, EntryType> AddressToEntryMap;
michael@0:   typedef typename AddressToEntryMap::const_iterator MapConstIterator;
michael@0:   typedef typename AddressToEntryMap::value_type MapValue;
michael@0: 
michael@0:   // Maps the address of each entry to an EntryType.
michael@0:   AddressToEntryMap map_;
michael@0: };
michael@0: 
michael@0: }  // namespace google_breakpad
michael@0: 
michael@0: #endif  // PROCESSOR_ADDRESS_MAP_H__