Debugger: rename gdb/gdbmi.{h,cpp} into debuggerprotocol.{h,cpp}

The scope is a bit broader nowadays.

Change-Id: I9578da94f06df199be5668c1751fd7bfb37f1c5b
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>

src/plugins/debugger/debuggerprotocol.h

@@ -0,0 +1,181 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#ifndef DEBUGGER_PROTOCOL_H
+#define DEBUGGER_PROTOCOL_H
+
+#include "debugger_global.h"
+
+#include <QByteArray>
+#include <QList>
+#include <QVariant>
+
+namespace Debugger {
+namespace Internal {
+
+/*
+
+output ==>
+    ( out-of-band-record )* [ result-record ] "(gdb)" nl
+result-record ==>
+     [ token ] "^" result-class ( "," result )* nl
+out-of-band-record ==>
+    async-record | stream-record
+async-record ==>
+    exec-async-output | status-async-output | notify-async-output
+exec-async-output ==>
+    [ token ] "*" async-output
+status-async-output ==>
+    [ token ] "+" async-output
+notify-async-output ==>
+    [ token ] "=" async-output
+async-output ==>
+    async-class ( "," result )* nl
+result-class ==>
+    "done" | "running" | "connected" | "error" | "exit"
+async-class ==>
+    "stopped" | others (where others will be added depending on the needs--this is still in development).
+result ==>
+     variable "=" value
+variable ==>
+     string
+value ==>
+     const | tuple | list
+const ==>
+    c-string
+tuple ==>
+     "{}" | "{" result ( "," result )* "}"
+list ==>
+     "[]" | "[" value ( "," value )* "]" | "[" result ( "," result )* "]"
+stream-record ==>
+    console-stream-output | target-stream-output | log-stream-output
+console-stream-output ==>
+    "~" c-string
+target-stream-output ==>
+    "@" c-string
+log-stream-output ==>
+    "&" c-string
+nl ==>
+    CR | CR-LF
+token ==>
+    any sequence of digits.
+
+ */
+
+// FIXME: rename into GdbMiValue
+class GdbMi
+{
+public:
+    GdbMi() : m_type(Invalid) {}
+
+    QByteArray m_name;
+    QByteArray m_data;
+    QList<GdbMi> m_children;
+
+    enum Type {
+        Invalid,
+        Const,
+        Tuple,
+        List
+    };
+
+    Type m_type;
+
+    inline Type type() const { return m_type; }
+    inline QByteArray name() const { return m_name; }
+    inline bool hasName(const char *name) const { return m_name == name; }
+
+    inline bool isValid() const { return m_type != Invalid; }
+    inline bool isConst() const { return m_type == Const; }
+    inline bool isTuple() const { return m_type == Tuple; }
+    inline bool isList() const { return m_type == List; }
+
+
+    inline QByteArray data() const { return m_data; }
+    inline const QList<GdbMi> &children() const { return m_children; }
+    inline int childCount() const { return m_children.size(); }
+
+    const GdbMi &childAt(int index) const { return m_children[index]; }
+    GdbMi &childAt(int index) { return m_children[index]; }
+    GdbMi findChild(const char *name) const;
+
+    QByteArray toString(bool multiline = false, int indent = 0) const;
+    qulonglong toAddress() const;
+    void fromString(const QByteArray &str);
+    void fromStringMultiple(const QByteArray &str);
+
+private:
+    friend class GdbResponse;
+    friend class GdbEngine;
+
+    static QByteArray parseCString(const char *&from, const char *to);
+    static QByteArray escapeCString(const QByteArray &ba);
+    void parseResultOrValue(const char *&from, const char *to);
+    void parseValue(const char *&from, const char *to);
+    void parseTuple(const char *&from, const char *to);
+    void parseTuple_helper(const char *&from, const char *to);
+    void parseList(const char *&from, const char *to);
+
+    void dumpChildren(QByteArray *str, bool multiline, int indent) const;
+};
+
+enum GdbResultClass
+{
+    // "done" | "running" | "connected" | "error" | "exit"
+    GdbResultUnknown,
+    GdbResultDone,
+    GdbResultRunning,
+    GdbResultConnected,
+    GdbResultError,
+    GdbResultExit
+};
+
+class GdbResponse
+{
+public:
+    GdbResponse() : token(-1), resultClass(GdbResultUnknown) {}
+    QByteArray toString() const;
+    static QByteArray stringFromResultClass(GdbResultClass resultClass);
+
+    int            token;
+    GdbResultClass resultClass;
+    GdbMi          data;
+    QVariant       cookie;
+    QByteArray     logStreamOutput;
+    QByteArray     consoleStreamOutput;
+};
+
+void extractGdbVersion(const QString &msg,
+    int *gdbVersion, int *gdbBuildVersion, bool *isMacGdb, bool *isQnxGdb);
+
+} // namespace Internal
+} // namespace Debugger
+
+
+#endif // DEBUGGER_PROTOCOL_H