Add an API to support build system generators.

More generally, a plugin-based API to support performing arbitrary
operations producing some output given a resolved qbs project.

Task-number: QBS-658
Change-Id: I5c0c3652520ec17e751ad9980bc186dde58e48d1
Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>

12 files changed, 139 insertions, 2 deletions

diff --git a/src/app/qbs/commandlinefrontend.cpp b/src/app/qbs/commandlinefrontend.cpp
index e40dbb566..50332a700 100644
--- a/src/app/qbs/commandlinefrontend.cpp
+++ b/src/app/qbs/commandlinefrontend.cpp
@@ -342,6 +342,10 @@ void CommandLineFrontend::handleProjectsResolved()
         if (m_cancelStatus != CancelStatusNone)
             throw ErrorInfo(Tr::tr("Execution canceled."));
         switch (m_parser.command()) {
+        case GenerateCommandType:
+            generate();
+            qApp->quit();
+            break;
         case ResolveCommandType:
             qApp->quit();
             break;
@@ -463,6 +467,28 @@ void CommandLineFrontend::build()
     m_currentBuildEffort = 0;
 }
 
+void CommandLineFrontend::generate()
+{
+    const QString generatorName = m_parser.generateOptions().generatorName();
+    QSharedPointer<ProjectGenerator> generator(ProjectGeneratorManager::findGenerator(generatorName));
+    if (!generator) {
+        const QString generatorNames = ProjectGeneratorManager::loadedGeneratorNames()
+                .join(QLatin1String("\n\t"));
+        if (generatorName.isEmpty()) {
+            throw ErrorInfo(Tr::tr("No generator specified. Available generators:\n\t%1")
+                            .arg(generatorNames));
+        }
+
+        throw ErrorInfo(Tr::tr("No generator named '%1'. Available generators:\n\t%2")
+                        .arg(generatorName)
+                        .arg(generatorNames));
+    }
+
+    generator->clearProjects();
+    generator->addProjects(m_projects);
+    generator->generate(m_parser.installOptions());
+}
+
 int CommandLineFrontend::runTarget()
 {
     try {
diff --git a/src/app/qbs/commandlinefrontend.h b/src/app/qbs/commandlinefrontend.h
index ee315499b..df5c3f2aa 100644
--- a/src/app/qbs/commandlinefrontend.h
+++ b/src/app/qbs/commandlinefrontend.h
@@ -80,6 +80,7 @@ private:
     void makeClean();
     int runShell();
     void build();
+    void generate();
     int runTarget();
     void updateTimestamps();
     void dumpNodesTree();
diff --git a/src/app/qbs/parser/command.cpp b/src/app/qbs/parser/command.cpp
index bfe58cfed..2426d2076 100644
--- a/src/app/qbs/parser/command.cpp
+++ b/src/app/qbs/parser/command.cpp
@@ -188,6 +188,36 @@ QList<CommandLineOption::Type> ResolveCommand::supportedOptions() const
     return resolveOptions();
 }
 
+QString GenerateCommand::shortDescription() const
+{
+    return Tr::tr("Generate files for another build tool.");
+}
+
+QString GenerateCommand::longDescription() const
+{
+    QString description = Tr::tr("qbs %1 [options] [[variant] [property:value] ...] ...\n")
+            .arg(representation());
+    description += Tr::tr("Generates project files to build the project using another build tool.");
+    return description += supportedOptionsDescription();
+}
+
+QString GenerateCommand::representation() const
+{
+    return QLatin1String("generate");
+}
+
+QList<CommandLineOption::Type> GenerateCommand::supportedOptions() const
+{
+    return QList<CommandLineOption::Type>()
+            << CommandLineOption::FileOptionType
+            << CommandLineOption::LogLevelOptionType
+            << CommandLineOption::VerboseOptionType
+            << CommandLineOption::QuietOptionType
+            << CommandLineOption::ShowProgressOptionType
+            << CommandLineOption::LogTimeOptionType
+            << CommandLineOption::GeneratorOptionType;
+}
+
 QString BuildCommand::shortDescription() const
 {
     return Tr::tr("Build (parts of) a project. This is the default command.");
diff --git a/src/app/qbs/parser/command.h b/src/app/qbs/parser/command.h
index 51f07b7fe..cf6510a87 100644
--- a/src/app/qbs/parser/command.h
+++ b/src/app/qbs/parser/command.h
@@ -81,6 +81,19 @@ private:
     QList<CommandLineOption::Type> supportedOptions() const;
 };
 
+class GenerateCommand : public Command
+{
+public:
+    GenerateCommand(CommandLineOptionPool &optionPool) : Command(optionPool) {}
+
+private:
+    CommandType type() const { return GenerateCommandType; }
+    QString shortDescription() const;
+    QString longDescription() const;
+    QString representation() const;
+    QList<CommandLineOption::Type> supportedOptions() const;
+};
+
 class BuildCommand : public Command
 {
 public:
diff --git a/src/app/qbs/parser/commandlineoption.cpp b/src/app/qbs/parser/commandlineoption.cpp
index a6b791c27..5d3c661b6 100644
--- a/src/app/qbs/parser/commandlineoption.cpp
+++ b/src/app/qbs/parser/commandlineoption.cpp
@@ -115,6 +115,33 @@ void BuildDirectoryOption::doParse(const QString &representation, QStringList &i
     m_projectBuildDirectory = getArgument(representation, input);
 }
 
+QString GeneratorOption::description(CommandType command) const
+{
+    Q_UNUSED(command);
+    return Tr::tr("%1|%2 <generator>\n"
+                  "\tUse the given build system generator.\n")
+            .arg(longRepresentation(), shortRepresentation());
+}
+
+QString GeneratorOption::shortRepresentation() const
+{
+    return QLatin1String("-g");
+}
+
+QString GeneratorOption::longRepresentation() const
+{
+    return QLatin1String("--generator");
+}
+
+void GeneratorOption::doParse(const QString &representation, QStringList &input)
+{
+    m_generatorName = getArgument(representation, input);
+    if (m_generatorName.isEmpty()) {
+        throw ErrorInfo(Tr::tr("Invalid use of option '%1': No generator given.\nUsage: %2")
+                    .arg(representation, description(command())));
+    }
+}
+
 static QString loglevelLongRepresentation() { return QLatin1String("--log-level"); }
 
 QString VerboseOption::description(CommandType command) const
diff --git a/src/app/qbs/parser/commandlineoption.h b/src/app/qbs/parser/commandlineoption.h
index a319365d7..7ffa18074 100644
--- a/src/app/qbs/parser/commandlineoption.h
+++ b/src/app/qbs/parser/commandlineoption.h
@@ -57,7 +57,8 @@ public:
         BuildNonDefaultOptionType,
         LogTimeOptionType,
         ShowCommandLinesOptionType,
-        SettingsDirOptionType
+        SettingsDirOptionType,
+        GeneratorOptionType
     };
 
     virtual ~CommandLineOption();
@@ -109,6 +110,21 @@ private:
     QString m_projectBuildDirectory;
 };
 
+class GeneratorOption : public CommandLineOption
+{
+public:
+    QString generatorName() const { return m_generatorName; }
+
+private:
+    QString description(CommandType command) const;
+    QString shortRepresentation() const;
+    QString longRepresentation() const;
+    void doParse(const QString &representation, QStringList &input);
+
+private:
+    QString m_generatorName;
+};
+
 class CountingOption : public CommandLineOption
 {
 public:
diff --git a/src/app/qbs/parser/commandlineoptionpool.cpp b/src/app/qbs/parser/commandlineoptionpool.cpp
index b5298dab5..dcd734002 100644
--- a/src/app/qbs/parser/commandlineoptionpool.cpp
+++ b/src/app/qbs/parser/commandlineoptionpool.cpp
@@ -107,6 +107,9 @@ CommandLineOption *CommandLineOptionPool::getOption(CommandLineOption::Type type
         case CommandLineOption::SettingsDirOptionType:
             option = new SettingsDirOption;
             break;
+        case CommandLineOption::GeneratorOptionType:
+            option = new GeneratorOption;
+            break;
         default:
             qFatal("Unknown option type %d", type);
         }
@@ -227,4 +230,9 @@ SettingsDirOption *CommandLineOptionPool::settingsDirOption() const
     return static_cast<SettingsDirOption *>(getOption(CommandLineOption::SettingsDirOptionType));
 }
 
+GeneratorOption *CommandLineOptionPool::generatorOption() const
+{
+    return static_cast<GeneratorOption *>(getOption(CommandLineOption::GeneratorOptionType));
+}
+
 } // namespace qbs
diff --git a/src/app/qbs/parser/commandlineoptionpool.h b/src/app/qbs/parser/commandlineoptionpool.h
index e3eafaadc..76c89bb38 100644
--- a/src/app/qbs/parser/commandlineoptionpool.h
+++ b/src/app/qbs/parser/commandlineoptionpool.h
@@ -64,6 +64,7 @@ public:
     LogTimeOption *logTimeOption() const;
     ShowCommandLinesOption *showCommandLinesOption() const;
     SettingsDirOption *settingsDirOption() const;
+    GeneratorOption *generatorOption() const;
 
 private:
     mutable QHash<CommandLineOption::Type, CommandLineOption *> m_options;
diff --git a/src/app/qbs/parser/commandlineparser.cpp b/src/app/qbs/parser/commandlineparser.cpp
index 675285c1c..5cf445b05 100644
--- a/src/app/qbs/parser/commandlineparser.cpp
+++ b/src/app/qbs/parser/commandlineparser.cpp
@@ -41,6 +41,7 @@
 #include <tools/buildoptions.h>
 #include <tools/cleanoptions.h>
 #include <tools/error.h>
+#include <tools/generateoptions.h>
 #include <tools/hostosinfo.h>
 #include <tools/installoptions.h>
 #include <tools/preferences.h>
@@ -157,6 +158,14 @@ CleanOptions CommandLineParser::cleanOptions() const
     return options;
 }
 
+GenerateOptions CommandLineParser::generateOptions() const
+{
+    Q_ASSERT(command() == GenerateCommandType);
+    GenerateOptions options;
+    options.setGeneratorName(d->optionPool.generatorOption()->generatorName());
+    return options;
+}
+
 InstallOptions CommandLineParser::installOptions() const
 {
     Q_ASSERT(command() == InstallCommandType || command() == RunCommandType);
@@ -365,6 +374,7 @@ Command *CommandLineParser::CommandLineParserPrivate::commandFromString(const QS
 QList<Command *> CommandLineParser::CommandLineParserPrivate::allCommands() const
 {
     return QList<Command *>()
+            << commandPool.getCommand(GenerateCommandType)
             << commandPool.getCommand(ResolveCommandType)
             << commandPool.getCommand(BuildCommandType)
             << commandPool.getCommand(CleanCommandType)
diff --git a/src/app/qbs/parser/commandlineparser.h b/src/app/qbs/parser/commandlineparser.h
index ae5744377..d6880be05 100644
--- a/src/app/qbs/parser/commandlineparser.h
+++ b/src/app/qbs/parser/commandlineparser.h
@@ -38,6 +38,7 @@
 namespace qbs {
 class BuildOptions;
 class CleanOptions;
+class GenerateOptions;
 class InstallOptions;
 class Settings;
 
@@ -58,6 +59,7 @@ public:
     QString projectBuildDirectory() const;
     BuildOptions buildOptions() const;
     CleanOptions cleanOptions() const;
+    GenerateOptions generateOptions() const;
     InstallOptions installOptions() const;
     bool force() const;
     bool forceTimestampCheck() const;
diff --git a/src/app/qbs/parser/commandpool.cpp b/src/app/qbs/parser/commandpool.cpp
index e34b8f467..81463e5c1 100644
--- a/src/app/qbs/parser/commandpool.cpp
+++ b/src/app/qbs/parser/commandpool.cpp
@@ -50,6 +50,9 @@ qbs::Command *CommandPool::getCommand(CommandType type) const
         case ResolveCommandType:
             command = new ResolveCommand(m_optionPool);
             break;
+        case GenerateCommandType:
+            command = new GenerateCommand(m_optionPool);
+            break;
         case BuildCommandType:
             command = new BuildCommand(m_optionPool);
             break;
diff --git a/src/app/qbs/parser/commandtype.h b/src/app/qbs/parser/commandtype.h
index b8e166035..861c522cd 100644
--- a/src/app/qbs/parser/commandtype.h
+++ b/src/app/qbs/parser/commandtype.h
@@ -35,7 +35,7 @@ namespace qbs {
 enum CommandType {
     ResolveCommandType, BuildCommandType, CleanCommandType, RunCommandType, ShellCommandType,
     StatusCommandType, UpdateTimestampsCommandType, DumpNodesTreeCommandType,
-    InstallCommandType, HelpCommandType
+    InstallCommandType, HelpCommandType, GenerateCommandType
 };
 
 } // namespace qbs