src/libs/qtcreatorcdbext/common.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef COMMON_H
  35 #define COMMON_H
  36
  37 // Define KDEXT_64BIT to make all wdbgexts APIs recognize 64 bit addresses
  38 // It is recommended for extensions to use 64 bit headers from wdbgexts so
  39 // the extensions could support 64 bit targets.
  40
  41 #include <string>
  42 #include <sstream>
  43
  44 #include <windows.h>
  45 #define KDEXT_64BIT
  46 #include <wdbgexts.h>
  47 #include <dbgeng.h>
  48
  49 typedef IDebugControl CIDebugControl;
  50 typedef IDebugSymbols3 CIDebugSymbols;
  51 typedef IDebugSymbolGroup2 CIDebugSymbolGroup;
  52 typedef IDebugClient5 CIDebugClient;
  53 typedef IDebugSystemObjects CIDebugSystemObjects;
  54 typedef IDebugDataSpaces4 CIDebugDataSpaces;
  55 typedef IDebugAdvanced2 CIDebugAdvanced;
  56 typedef IDebugRegisters2 CIDebugRegisters;
  57
  58 // Utility messages
  59 std::string winErrorMessage(unsigned long error);
  60 std::string winErrorMessage();
  61 std::string msgDebugEngineComResult(HRESULT hr);
  62 std::string msgDebugEngineComFailed(const char *func, HRESULT hr);
  63
  64 // Debug helper for anything streamable as in 'DebugPrint() << object'
  65 // Derives from std::ostringstream and print out everything accumulated in destructor.
  66 struct DebugPrint : public std::ostringstream {
  67     DebugPrint() {}
  68     ~DebugPrint() {
  69         dprintf("DEBUG: %s\n", str().c_str());
  70     }
  71 };
  72
  73 ULONG currentThreadId(IDebugSystemObjects *sysObjects);
  74 ULONG currentThreadId(CIDebugClient *client);
  75 ULONG currentProcessId(IDebugSystemObjects *sysObjects);
  76 ULONG currentProcessId(CIDebugClient *client);
  77 std::string moduleNameByOffset(CIDebugSymbols *symbols, ULONG64 offset);
  78
  79 #ifdef QTC_TRACE
  80 #  define QTC_TRACE_IN dprintf(">%s\n", __FUNCTION__);
  81 #  define QTC_TRACE_OUT dprintf("<%s\n", __FUNCTION__);
  82 #else
  83 #  define QTC_TRACE_IN
  84 #  define QTC_TRACE_OUT
  85 #endif
  86
  87 #endif // COMMON_H