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 (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef NAME_DEMANGLER_H
  34 #define NAME_DEMANGLER_H
  35
  36 #include <QtCore/QtGlobal>
  37
  38 QT_BEGIN_NAMESPACE
  39 class QString;
  40 QT_END_NAMESPACE
  41
  42 namespace Debugger {
  43 namespace Internal {
  44
  45 class NameDemanglerPrivate;
  46
  47 class NameDemangler
  48 {
  49 public:
  50     NameDemangler();
  51     ~NameDemangler();
  52
  53     /*
  54      * Demangles a mangled name. Also accepts a non-demangled name,
  55      * in which case it is not transformed.
  56      * Returns true <=> the name is not mangled or it is mangled correctly
  57      *                  according to the specification.
  58      */
  59     bool demangle(const QString &mangledName);
  60
  61     /*
  62      * A textual description of the error encountered, if there was one.
  63      * Only valid if demangle() returned false.
  64      */
  65     const QString &errorString() const;
  66
  67     /*
  68      * The demangled name. If the original name was not mangled, this
  69      * is identical to the input.
  70      * Only valid if demangle() returned true.
  71      */
  72     const QString &demangledName() const;
  73
  74 private:
  75     NameDemanglerPrivate *pImpl;
  76 };
  77
  78 } // namespace Internal
  79 } // namespace Debugger
  80
  81 #endif // Include guard.