src/plugins/debugger/name_demangler.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 NAME_DEMANGLER_H
  35 #define NAME_DEMANGLER_H
  36
  37 #include <QtCore/QtGlobal>
  38
  39 QT_BEGIN_NAMESPACE
  40 class QString;
  41 QT_END_NAMESPACE
  42
  43 namespace Debugger {
  44 namespace Internal {
  45
  46 class NameDemanglerPrivate;
  47
  48 class NameDemangler
  49 {
  50 public:
  51     NameDemangler();
  52     ~NameDemangler();
  53
  54     /*
  55      * Demangles a mangled name. Also accepts a non-demangled name,
  56      * in which case it is not transformed.
  57      * Returns true <=> the name is not mangled or it is mangled correctly
  58      *                  according to the specification.
  59      */
  60     bool demangle(const QString &mangledName);
  61
  62     /*
  63      * A textual description of the error encountered, if there was one.
  64      * Only valid if demangle() returned false.
  65      */
  66     const QString &errorString() const;
  67
  68     /*
  69      * The demangled name. If the original name was not mangled, this
  70      * is identical to the input.
  71      * Only valid if demangle() returned true.
  72      */
  73     const QString &demangledName() const;
  74
  75 private:
  76     NameDemanglerPrivate *pImpl;
  77 };
  78
  79 } // namespace Internal
  80 } // namespace Debugger
  81
  82 #endif // Include guard.