androidconfigurations.h 8.32 KB
Newer Older
BogDan Vatra's avatar
BogDan Vatra committed
1 2
/**************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 BogDan Vatra <bog_dan_ro@yahoo.com>
** Contact: http://www.qt.io/licensing
BogDan Vatra's avatar
BogDan Vatra committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
BogDan Vatra's avatar
BogDan Vatra committed
7
**
hjk's avatar
hjk committed
8 9 10 11
** 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
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
BogDan Vatra's avatar
BogDan Vatra committed
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
hjk committed
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
BogDan Vatra's avatar
BogDan Vatra committed
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
BogDan Vatra's avatar
BogDan Vatra committed
30 31 32 33

#ifndef ANDROIDCONFIGURATIONS_H
#define ANDROIDCONFIGURATIONS_H

34 35
#include "android_global.h"

BogDan Vatra's avatar
BogDan Vatra committed
36 37
#include <QObject>
#include <QString>
38
#include <QStringList>
BogDan Vatra's avatar
BogDan Vatra committed
39
#include <QVector>
40 41
#include <QHash>
#include <QMap>
Daniel Teske's avatar
Daniel Teske committed
42
#include <QFutureInterface>
43

44
#include <utils/fileutils.h>
BogDan Vatra's avatar
BogDan Vatra committed
45 46 47 48 49

QT_BEGIN_NAMESPACE
class QSettings;
QT_END_NAMESPACE

50 51 52 53 54 55
namespace ProjectExplorer {
class Abi;
class Project;
}

namespace Utils { class Environment; }
56

BogDan Vatra's avatar
BogDan Vatra committed
57
namespace Android {
Daniel Teske's avatar
Daniel Teske committed
58
class AndroidPlugin;
BogDan Vatra's avatar
BogDan Vatra committed
59

hjk's avatar
hjk committed
60 61
struct AndroidDeviceInfo
{
BogDan Vatra's avatar
BogDan Vatra committed
62
    QString serialNumber;
63
    QStringList cpuAbi;
BogDan Vatra's avatar
BogDan Vatra committed
64
    int sdk;
Daniel Teske's avatar
Daniel Teske committed
65 66
    enum State { OkState, UnAuthorizedState, OfflineState };
    State state;
67
    bool unauthorized;
68 69
    enum AndroidDeviceType { Hardware, Emulator };
    AndroidDeviceType type;
70 71

    static QStringList adbSelector(const QString &serialNumber);
BogDan Vatra's avatar
BogDan Vatra committed
72 73
};

74 75 76 77 78 79 80 81 82 83 84
class SdkPlatform
{
public:
    SdkPlatform()
        : apiLevel(-1)
    {}
    int apiLevel;
    QString name;
    QStringList abis;
};

85
class ANDROID_EXPORT AndroidConfig
BogDan Vatra's avatar
BogDan Vatra committed
86
{
hjk's avatar
hjk committed
87
public:
Daniel Teske's avatar
Daniel Teske committed
88 89 90 91 92
    AndroidConfig();

    void load(const QSettings &settings);
    void save(QSettings &settings) const;

93
    static QStringList apiLevelNamesFor(const QList<SdkPlatform> &platforms);
94
    static QString apiLevelNameFor(const SdkPlatform &platform);
95
    QList<SdkPlatform> sdkTargets(int minApiLevel = 0) const;
Daniel Teske's avatar
Daniel Teske committed
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120

    Utils::FileName sdkLocation() const;
    void setSdkLocation(const Utils::FileName &sdkLocation);

    Utils::FileName ndkLocation() const;
    void setNdkLocation(const Utils::FileName &ndkLocation);

    Utils::FileName antLocation() const;
    void setAntLocation(const Utils::FileName &antLocation);

    Utils::FileName openJDKLocation() const;
    void setOpenJDKLocation(const Utils::FileName &openJDKLocation);

    Utils::FileName keystoreLocation() const;
    void setKeystoreLocation(const Utils::FileName &keystoreLocation);

    QString toolchainHost() const;
    QStringList makeExtraSearchDirectories() const;

    unsigned partitionSize() const;
    void setPartitionSize(unsigned partitionSize);

    bool automaticKitCreation() const;
    void setAutomaticKitCreation(bool b);

BogDan Vatra's avatar
BogDan Vatra committed
121 122 123
    bool useGrandle() const;
    void setUseGradle(bool b);

Tobias Hunger's avatar
Tobias Hunger committed
124 125
    Utils::FileName adbToolPath() const;
    Utils::FileName androidToolPath() const;
126
    Utils::Environment androidToolEnvironment() const;
Tobias Hunger's avatar
Tobias Hunger committed
127 128
    Utils::FileName antToolPath() const;
    Utils::FileName emulatorToolPath() const;
Daniel Teske's avatar
Daniel Teske committed
129 130


Daniel Teske's avatar
Daniel Teske committed
131 132
    Utils::FileName gccPath(const ProjectExplorer::Abi &abi, const QString &ndkToolChainVersion) const;
    Utils::FileName gdbPath(const ProjectExplorer::Abi &abi, const QString &ndkToolChainVersion) const;
Daniel Teske's avatar
Daniel Teske committed
133

Tobias Hunger's avatar
Tobias Hunger committed
134
    Utils::FileName keytoolPath() const;
Daniel Teske's avatar
Daniel Teske committed
135

136 137 138 139 140 141 142 143 144 145 146 147
    class CreateAvdInfo
    {
    public:
        QString target;
        QString name;
        QString abi;
        int sdcardSize;
        QString error; // only used in the return value of createAVD
    };

    CreateAvdInfo gatherCreateAVDInfo(QWidget *parent, int minApiLevel = 0, QString targetArch = QString()) const;
    QFuture<CreateAvdInfo> createAVD(CreateAvdInfo info) const;
BogDan Vatra's avatar
BogDan Vatra committed
148
    bool removeAVD(const QString &name) const;
Daniel Teske's avatar
Daniel Teske committed
149

150
    QVector<AndroidDeviceInfo> connectedDevices(QString *error = 0) const;
151 152

    QFuture<QVector<AndroidDeviceInfo> > androidVirtualDevicesFuture();
153
    QVector<AndroidDeviceInfo> androidVirtualDevices() const;
154

155 156
    QString startAVD(const QString &name, int apiLevel, QString cpuAbi) const;
    bool startAVDAsync(const QString &avdName) const;
157
    QString findAvd(int apiLevel, const QString &cpuAbi) const;
Daniel Teske's avatar
Daniel Teske committed
158
    QString waitForAvd(int apiLevel, const QString &cpuAbi, const QFutureInterface<bool> &fi = QFutureInterface<bool>()) const;
159
    QString bestNdkPlatformMatch(int target) const;
BogDan Vatra's avatar
BogDan Vatra committed
160

Daniel Teske's avatar
Daniel Teske committed
161 162 163 164
    static ProjectExplorer::Abi abiForToolChainPrefix(const QString &toolchainPrefix);
    static QLatin1String toolchainPrefix(const ProjectExplorer::Abi &abi);
    static QLatin1String toolsPrefix(const ProjectExplorer::Abi &abi);
    static QLatin1String displayName(const ProjectExplorer::Abi &abi);
BogDan Vatra's avatar
BogDan Vatra committed
165

166
    QString getProductModel(const QString &device) const;
167
    bool hasFinishedBooting(const QString &device) const;
Daniel Teske's avatar
Daniel Teske committed
168 169
    bool waitForBooted(const QString &serialNumber, const QFutureInterface<bool> &fi) const;
    bool isConnected(const QString &serialNumber) const;
170

171
    SdkPlatform highestAndroidSdk() const;
Daniel Teske's avatar
Daniel Teske committed
172
private:
173
    static CreateAvdInfo createAVDImpl(CreateAvdInfo info, Utils::FileName androidToolPath, Utils::Environment env);
174
    static QVector<AndroidDeviceInfo> androidVirtualDevicesImpl(const Utils::FileName &androidTool, const Utils::Environment &environment);
175

Daniel Teske's avatar
Daniel Teske committed
176
    Utils::FileName toolPath(const ProjectExplorer::Abi &abi, const QString &ndkToolChainVersion) const;
Daniel Teske's avatar
Daniel Teske committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
    Utils::FileName openJDKBinPath() const;
    int getSDKVersion(const QString &device) const;
    QStringList getAbis(const QString &device) const;
    bool isBootToQt(const QString &device) const;

    void updateAvailableSdkPlatforms() const;
    void updateNdkInformation() const;

    Utils::FileName m_sdkLocation;
    Utils::FileName m_ndkLocation;
    Utils::FileName m_antLocation;
    Utils::FileName m_openJDKLocation;
    Utils::FileName m_keystoreLocation;
    QStringList m_makeExtraSearchDirectories;
    unsigned m_partitionSize;
    bool m_automaticKitCreation;
BogDan Vatra's avatar
BogDan Vatra committed
193
    bool m_useGradle;
Daniel Teske's avatar
Daniel Teske committed
194 195 196

    //caches
    mutable bool m_availableSdkPlatformsUpToDate;
197 198
    mutable QVector<SdkPlatform> m_availableSdkPlatforms;
    static bool sortSdkPlatformByApiLevel(const SdkPlatform &a, const SdkPlatform &b);
Daniel Teske's avatar
Daniel Teske committed
199 200 201 202 203 204 205 206

    mutable bool m_NdkInformationUpToDate;
    mutable QString m_toolchainHost;
    mutable QVector<int> m_availableNdkPlatforms;

    mutable QHash<QString, QString> m_serialNumberToDeviceName;
};

207
class ANDROID_EXPORT AndroidConfigurations : public QObject
Daniel Teske's avatar
Daniel Teske committed
208 209 210 211 212
{
    friend class Android::AndroidPlugin;
    Q_OBJECT

public:
hjk's avatar
hjk committed
213
    static const AndroidConfig &currentConfig();
Daniel Teske's avatar
Daniel Teske committed
214 215 216 217
    static void setConfig(const AndroidConfig &config);
    static AndroidConfigurations *instance();

    static void updateAndroidDevice();
218 219
    enum Options { None, FilterAndroid5 };
    static AndroidDeviceInfo showDeviceDialog(ProjectExplorer::Project *project, int apiLevel, const QString &abi, Options options);
Daniel Teske's avatar
Daniel Teske committed
220 221
    static void setDefaultDevice(ProjectExplorer::Project *project, const QString &abi, const QString &serialNumber); // serial number or avd name
    static QString defaultDevice(ProjectExplorer::Project *project, const QString &abi); // serial number or avd name
222
public slots:
Daniel Teske's avatar
Daniel Teske committed
223
    static void clearDefaultDevices(ProjectExplorer::Project *project);
224
    static void updateToolChainList();
Daniel Teske's avatar
Daniel Teske committed
225
    static void updateAutomaticKitList();
226
    static bool force32bitEmulator();
227

BogDan Vatra's avatar
BogDan Vatra committed
228 229 230 231 232 233 234 235 236 237
signals:
    void updated();

private:
    AndroidConfigurations(QObject *parent);
    void load();
    void save();

    static AndroidConfigurations *m_instance;
    AndroidConfig m_config;
238 239

    QMap<ProjectExplorer::Project *, QMap<QString, QString> > m_defaultDeviceForAbi;
240
    bool m_force32bit;
BogDan Vatra's avatar
BogDan Vatra committed
241 242 243 244 245
};

} // namespace Android

#endif // ANDROIDCONFIGURATIONS_H