aboutsummaryrefslogtreecommitdiff
path: root/libs/installer_quick/src/installerquick.h
blob: 5d9c910612ec99eaf54d20d7cbefb68f35e4ce81 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
#ifndef INSTALLERQUICK_H
#define INSTALLERQUICK_H

#include <uibase/game_features/moddatachecker.h>
#include <uibase/iplugininstallersimple.h>

class InstallerQuick : public MOBase::IPluginInstallerSimple
{
  Q_OBJECT
  Q_INTERFACES(MOBase::IPlugin MOBase::IPluginInstaller MOBase::IPluginInstallerSimple)
#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)
  Q_PLUGIN_METADATA(IID "org.tannin.InstallerQuick")
#endif

public:
  InstallerQuick();

  // Plugin functions:
  virtual bool init(MOBase::IOrganizer* moInfo) override;
  virtual QString name() const override;
  virtual QString localizedName() const override;
  virtual QString author() const override;
  virtual QString description() const override;
  virtual MOBase::VersionInfo version() const override;
  virtual QList<MOBase::PluginSetting> settings() const override;

  // Installer functions:
  virtual unsigned int priority() const override;
  virtual bool isManualInstaller() const override;
  virtual bool
  isArchiveSupported(std::shared_ptr<const MOBase::IFileTree> tree) const override;

  // Simple installer functions:
  virtual EInstallResult install(MOBase::GuessedValue<QString>& modName,
                                 std::shared_ptr<MOBase::IFileTree>& tree,
                                 QString& version, int& modID) override;

private:
  /**
   * @brief Check if the archive is a "DataText" archive.
   *
   * A "DataText" archive is defined as having exactly one folder named like the data
   * folder of the game (`dataFolderName`) and one or more text or PDF files (standard
   * package from french modding site).
   *
   * @param tree The tree to check.
   * @param dataFolderName Name of the data folder (e.g., "data" for gamebryo games).
   * @param checker The mod data checker, or a null pointer if none is available.
   *
   * @return true if the tree represents a "DataText" archive, false otherwise.
   */
  bool isDataTextArchiveTopLayer(std::shared_ptr<const MOBase::IFileTree> tree,
                                 QString const& dataFolderName,
                                 MOBase::ModDataChecker* checker) const;

  /**
   * @brief Get the base of the archive.
   *
   * The base of the archive is either a "DataText" folder (i.e., a folder containing
   * TXT or PDF files and a valid data folder), or an actual data folder.
   *
   * @param tree The tree to check.
   * @param dataFolderName Name of the data folder (e.g., "data" for gamebryo games).
   * @param checker The mod data checker, or a null pointer if none is available.
   *
   * @return the "base" of the archive, or a null pointer if none was found.
   */
  std::shared_ptr<const MOBase::IFileTree>
  getSimpleArchiveBase(std::shared_ptr<const MOBase::IFileTree> dataTree,
                       QString const& dataFolderName,
                       MOBase::ModDataChecker* checker) const;

private:
  const MOBase::IOrganizer* m_MOInfo;
};

#endif  // INSTALLERQUICK_H