src/breakpad/src/common/windows/dia_util.h

   1 // Copyright 2013 Google Inc. All rights reserved.
   2 //
   3 // Redistribution and use in source and binary forms, with or without
   4 // modification, are permitted provided that the following conditions are
   5 // met:
   6 //
   7 //     * Redistributions of source code must retain the above copyright
   8 // notice, this list of conditions and the following disclaimer.
   9 //     * Redistributions in binary form must reproduce the above
  10 // copyright notice, this list of conditions and the following disclaimer
  11 // in the documentation and/or other materials provided with the
  12 // distribution.
  13 //     * Neither the name of Google Inc. nor the names of its
  14 // contributors may be used to endorse or promote products derived from
  15 // this software without specific prior written permission.
  16 //
  17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 // Utilities for loading debug streams and tables from a PDB file.
  30
  31 #ifndef COMMON_WINDOWS_DIA_UTIL_H_
  32 #define COMMON_WINDOWS_DIA_UTIL_H_
  33
  34 #include <Windows.h>
  35 #include <dia2.h>
  36
  37 namespace google_breakpad {
  38
  39 // Find the debug stream of the given |name| in the given |session|. Returns
  40 // true on success, false on error of if the stream does not exist. On success
  41 // the stream will be returned via |debug_stream|.
  42 bool FindDebugStream(const wchar_t* name,
  43                      IDiaSession* session,
  44                      IDiaEnumDebugStreamData** debug_stream);
  45
  46 // Finds the first table implementing the COM interface with ID |iid| in the
  47 // given |session|. Returns true on success, false on error or if no such
  48 // table is found. On success the table will be returned via |table|.
  49 bool FindTable(REFIID iid, IDiaSession* session, void** table);
  50
  51 // A templated version of FindTable. Finds the first table implementing type
  52 // |InterfaceType| in the given |session|. Returns true on success, false on
  53 // error or if no such table is found. On success the table will be returned via
  54 // |table|.
  55 template<typename InterfaceType>
  56 bool FindTable(IDiaSession* session, InterfaceType** table) {
  57   return FindTable(__uuidof(InterfaceType),
  58                    session,
  59                    reinterpret_cast<void**>(table));
  60 }
  61
  62 }  // namespace google_breakpad
  63
  64 #endif  // COMMON_WINDOWS_DIA_UTIL_H_