qt-creator/src/plugins/android/androidrunner.h

/****************************************************************************
**
** Copyright (C) 2016 BogDan Vatra <bog_dan_ro@yahoo.com>
** 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 "androidconfigurations.h"
#include "androidrunnable.h"

#include <projectexplorer/runconfiguration.h>
#include <qmldebug/qmldebugcommandlinearguments.h>

#include <QFutureInterface>
#include <QObject>
#include <QTimer>
#include <QTcpSocket>
#include <QThread>
#include <QProcess>
#include <QMutex>

namespace Android {
class AndroidRunConfiguration;

namespace Internal {

class AndroidRunner : public QThread
{
    Q_OBJECT

    enum DebugHandShakeType {
        PingPongFiles,
        SocketHandShake
    };

public:
    AndroidRunner(QObject *parent, AndroidRunConfiguration *runConfig,
                  Core::Id runMode);
    ~AndroidRunner();

    QString displayName() const;
    void setRunnable(const AndroidRunnable &runnable);
    const AndroidRunnable &runnable() const { return m_androidRunnable; }

public:
    void start();
    void stop();
    void handleRemoteDebuggerRunning();

signals:
    void remoteServerRunning(const QByteArray &serverChannel, int pid);
    void remoteProcessStarted(Utils::Port gdbServerPort, Utils::Port qmlPort);
    void remoteProcessFinished(const QString &errString = QString());

    void remoteOutput(const QString &output);
    void remoteErrorOutput(const QString &output);

private:
    void checkPID();
    void logcatReadStandardError();
    void logcatReadStandardOutput();
    void asyncStart();
    void asyncStop();
    Q_INVOKABLE void launchAVDProcesses();
    void adbKill(qint64 pid);
    QStringList selector() const { return m_selector; }
    void forceStop();
    void findPs();
    void logcatProcess(const QByteArray &text, QByteArray &buffer, bool onlyError);
    bool adbShellAmNeedsQuotes();
    void launchAVD();
    bool runAdb(const QStringList &args, QString *errorMessage = nullptr, int timeoutS = 10);
private:
    AndroidRunConfiguration *m_runConfig;
    QString m_launchedAVDName;
    QFutureInterface<bool> m_avdFutureInterface;
    QProcess m_adbLogcatProcess;
    QProcess m_psProc;
    QTimer m_checkPIDTimer;
    bool m_wasStarted;
    int m_tries;
    QByteArray m_stdoutBuffer;
    QByteArray m_stderrBuffer;
    AndroidRunnable m_androidRunnable;
    qint64 m_processPID;
    bool m_useCppDebugger;
    QmlDebug::QmlDebugServicesPreset m_qmlDebugServices;
    Utils::Port m_localGdbServerPort; // Local end of forwarded debug socket.
    Utils::Port m_qmlPort;
    QString m_pingFile;
    QString m_pongFile;
    QString m_gdbserverPath;
    QString m_gdbserverSocket;
    QString m_adb;
    bool m_isBusyBox;
    QStringList m_selector;
    QMutex m_mutex;
    QRegExp m_logCatRegExp;
    DebugHandShakeType m_handShakeMethod = SocketHandShake;
    QTcpSocket *m_socket;
    bool m_customPort;
};

} // namespace Internal
} // namespace Android