michael@0: // Copyright (c) 2010, 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: // static_address_map.h: StaticAddressMap.
michael@0: //
michael@0: // StaticAddressMap is a wrapper class of StaticMap, just as AddressMap wraps
michael@0: // std::map.  StaticAddressMap provides read-only Retrieve() operation, similar
michael@0: // as AddressMap.  However, the difference between StaticAddressMap and
michael@0: // AddressMap is that StaticAddressMap does not support dynamic operation
michael@0: // Store() due to the static nature of the underlying StaticMap.
michael@0: //
michael@0: // See address_map.h for reference.
michael@0: //
michael@0: // Author: Siyang Xie (lambxsy@google.com)
michael@0: 
michael@0: #ifndef PROCESSOR_STATIC_ADDRESS_MAP_H__
michael@0: #define PROCESSOR_STATIC_ADDRESS_MAP_H__
michael@0: 
michael@0: #include "processor/static_map-inl.h"
michael@0: 
michael@0: namespace google_breakpad {
michael@0: 
michael@0: // AddressType MUST be a basic type, e.g.: integer types etc
michael@0: // EntryType could be a complex type, so we retrieve its pointer instead.
michael@0: template<typename AddressType, typename EntryType>
michael@0: class StaticAddressMap {
michael@0:  public:
michael@0:   StaticAddressMap(): map_() { }
michael@0:   explicit StaticAddressMap(const char *map_data): map_(map_data) { }
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:                 const EntryType *&entry, AddressType *entry_address) const;
michael@0: 
michael@0:  private:
michael@0:   friend class ModuleComparer;
michael@0:   // Convenience types.
michael@0:   typedef StaticAddressMap* SelfPtr;
michael@0:   typedef StaticMap<AddressType, EntryType> AddressToEntryMap;
michael@0:   typedef typename AddressToEntryMap::const_iterator MapConstIterator;
michael@0: 
michael@0:   AddressToEntryMap map_;
michael@0: };
michael@0: 
michael@0: }  // namespace google_breakpad
michael@0: 
michael@0: #endif  // PROCESSOR_STATIC_ADDRESS_MAP_H__
michael@0: