text: /****************************************************************************
  **
  ** Copyright (C) 2016 The Qt Company Ltd.
  ** Contact: https://www.qt.io/licensing/
  **
  ** 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 The Qt Company. For licensing terms
  ** and conditions see https://www.qt.io/terms-conditions. For further
  ** information use the contact form at https://www.qt.io/contact-us.
  **
  ** GNU General Public License Usage
  ** Alternatively, this file may be used under the terms of the GNU
  ** General Public License version 3 as published by the Free Software
  ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
  ** included in the packaging of this file. Please review the following
  ** information to ensure the GNU General Public License requirements will
  ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
  **
  ****************************************************************************/
  
  #pragma once
  
  #include <QStack>
  #include <QPointer>
  #include <QTimer>
  
  #include <coreplugin/icontext.h>
  #include <debugger/debuggerconstants.h>
  #include <qmldebug/baseenginedebugclient.h>
  
  namespace QmlDebug {
  class BaseEngineDebugClient;
  class BaseToolsClient;
  class ObjectReference;
  class FileReference;
  class QmlDebugConnection;
  }
  
  namespace Debugger {
  namespace Internal {
  
  class DebuggerEngine;
  class QmlEngine;
  class WatchItem;
  
  //map <filename, editorRevision> -> <lineNumber, columnNumber> -> debugId
  typedef
  QHash<QPair<QString, int>, QHash<QPair<int, int>, QList<int> > > DebugIdHash;
  
  class QmlInspectorAgent : public QObject
  {
      Q_OBJECT
  
  public:
      QmlInspectorAgent(QmlEngine *engine, QmlDebug::QmlDebugConnection *connection);
  
      quint32 queryExpressionResult(int debugId, const QString &expression);
      void assignValue(const WatchItem *data, const QString &expression, const QVariant &valueV);
      void updateWatchData(const WatchItem &data);
      void watchDataSelected(qint64 id);
      void enableTools(bool enable);
  
  private:
      bool selectObjectInTree(int debugId);
      void addObjectWatch(int objectDebugId);
  
      QmlDebug::ObjectReference objectForId(int objectDebugId) const;
      QString displayName(int objectDebugId) const;
      void reloadEngines();
      void fetchObject(int debugId);
  
      void updateState();
      void onResult(quint32 queryId, const QVariant &value, const QByteArray &type);
      void newObject(int engineId, int objectId, int parentId);
      void onValueChanged(int debugId, const QByteArray &propertyName, const QVariant &value);
  
      void queryEngineContext();
      void updateObjectTree(const QmlDebug::ContextReference &context);
      void verifyAndInsertObjectInTree(const QmlDebug::ObjectReference &object);
      void insertObjectInTree(const QmlDebug::ObjectReference &result);
  
      void buildDebugIdHashRecursive(const QmlDebug::ObjectReference &ref);
      void addWatchData(const QmlDebug::ObjectReference &obj,
                        const QString &parentIname, bool append);
  
      enum LogDirection {
          LogSend,
          LogReceive
      };
      void log(LogDirection direction, const QString &message);
  
      bool isConnected() const;
      void clearObjectTree();
  
      void clientStateChanged(QmlDebug::QmlDebugClient::State state);
      void toolsClientStateChanged(QmlDebug::QmlDebugClient::State state);
      void engineClientStateChanged(QmlDebug::QmlDebugClient::State state);
  
      void selectObjectsFromToolsClient(const QList<int> &debugIds);
  
      void onSelectActionTriggered(bool checked);
      void onZoomActionTriggered(bool checked);
      void onShowAppOnTopChanged(bool checked);
      void onReloaded();
      void jumpToObjectDefinitionInEditor(const QmlDebug::FileReference &objSource, int debugId = -1);
  
      void setActiveEngineClient(QmlDebug::BaseEngineDebugClient *client);
  
      enum SelectionTarget { NoTarget, ToolTarget, EditorTarget };
      void selectObject(
              const QmlDebug::ObjectReference &objectReference,
              SelectionTarget target);
  
  private:
      QPointer<QmlEngine> m_qmlEngine;
      QmlDebug::BaseEngineDebugClient *m_engineClient;
  
      quint32 m_engineQueryId;
      quint32 m_rootContextQueryId;
      int m_objectToSelect;
      QList<quint32> m_objectTreeQueryIds;
      QStack<QmlDebug::ObjectReference> m_objectStack;
      QmlDebug::EngineReference m_engine;
      QHash<int, QString> m_debugIdToIname;
      QHash<int, QmlDebug::FileReference> m_debugIdLocations;
      DebugIdHash m_debugIdHash;
  
      QList<int> m_objectWatches;
      QList<int> m_fetchDataIds;
      QTimer m_delayQueryTimer;
  
      DebuggerEngine *m_masterEngine;
      QHash<QString, QmlDebug::BaseEngineDebugClient*> m_engineClients;
      QmlDebug::BaseToolsClient *m_toolsClient;
  
      SelectionTarget m_targetToSync;
      int m_debugIdToSelect;
  
      int m_currentSelectedDebugId;
      QString m_currentSelectedDebugName;
  
      // toolbar
      bool m_toolsClientConnected;
      Core::Context m_inspectorToolsContext;
      QAction *m_selectAction;
      QAction *m_zoomAction;
      QAction *m_showAppOnTopAction;
  
      bool m_engineClientConnected;
  };
  
  } // Internal
  } // Debugger
  