qt-creator/src/plugins/projectexplorer/jsonwizard/jsonwizardfilegenerator.cpp

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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 http://www.qt.io/terms-conditions.  For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** 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.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include "jsonwizardfilegenerator.h"

#include "../projectexplorer.h"
#include "jsonwizard.h"
#include "jsonwizardfactory.h"

#include <coreplugin/editormanager/editormanager.h>

#include <utils/fileutils.h>
#include <utils/qtcassert.h>
#include <utils/macroexpander.h>
#include <utils/templateengine.h>

#include <QCoreApplication>
#include <QDir>
#include <QVariant>

namespace ProjectExplorer {
namespace Internal {

bool JsonWizardFileGenerator::setup(const QVariant &data, QString *errorMessage)
{
    QVariantList list = JsonWizardFactory::objectOrList(data, errorMessage);
    if (list.isEmpty())
        return false;

    foreach (const QVariant &d, list) {
        if (d.type() != QVariant::Map) {
            *errorMessage = QCoreApplication::translate("ProjectExplorer::JsonFieldPage",
                                                        "Files data list entry is not an object.");
            return false;
        }

        File f;

        const QVariantMap tmp = d.toMap();
        f.source = tmp.value(QLatin1String("source")).toString();
        f.target = tmp.value(QLatin1String("target")).toString();
        f.condition = tmp.value(QLatin1String("condition"), true);
        f.isBinary = tmp.value(QLatin1String("isBinary"), false);
        f.overwrite = tmp.value(QLatin1String("overwrite"), false);
        f.openInEditor = tmp.value(QLatin1String("openInEditor"), false);
        f.openAsProject = tmp.value(QLatin1String("openAsProject"), false);

        const QVariant options = tmp.value(QLatin1String("options"));
        if (!options.isNull()) {
            const QVariantList optList = JsonWizardFactory::objectOrList(options, errorMessage);
            if (optList.isEmpty())
                return false;

            foreach (const QVariant &o, optList) {
                QVariantMap optionObject = o.toMap();
                File::OptionDefinition odef;
                odef.key = optionObject.value(QLatin1String("key")).toString();
                odef.value = optionObject.value(QLatin1String("value")).toString();
                odef.condition = optionObject.value(QLatin1String("condition"), QLatin1String("true")).toString();
                if (odef.key.isEmpty()) {
                    *errorMessage = QCoreApplication::translate("ProjectExplorer::Internal::JsonWizardFileGenerator",
                                                                "No 'key' in options object.");
                    return false;
                }
                f.options.append(odef);
            }
        }

        if (f.source.isEmpty() && f.target.isEmpty()) {
            *errorMessage = QCoreApplication::translate("ProjectExplorer::JsonFieldPage",
                                                        "Source and target are both empty.");
            return false;
        }

        if (f.target.isEmpty())
            f.target = f.source;

        m_fileList << f;
    }

    return true;
}

Core::GeneratedFiles JsonWizardFileGenerator::fileList(Utils::MacroExpander *expander,
                                                       const QString &wizardDir, const QString &projectDir,
                                                       QString *errorMessage)
{
    errorMessage->clear();

    QDir wizard(wizardDir);
    QDir project(projectDir);

    Core::GeneratedFiles result;

    foreach (const File &f, m_fileList) {
        if (!JsonWizard::boolFromVariant(f.condition, expander))
            continue;

        const bool keepExisting = f.source.isEmpty();
        const QString targetPath = project.absoluteFilePath(expander->expand(f.target));
        const QString sourcePath
                = keepExisting ? targetPath : wizard.absoluteFilePath(expander->expand(f.source));
        const bool isBinary = JsonWizard::boolFromVariant(f.isBinary, expander);

        // Read contents of source file
        const QFile::OpenMode openMode
                = JsonWizard::boolFromVariant(isBinary, expander)
                ? QIODevice::ReadOnly : (QIODevice::ReadOnly|QIODevice::Text);

        Utils::FileReader reader;
        if (!reader.fetch(sourcePath, openMode, errorMessage))
            return Core::GeneratedFiles();

        // Generate file information:
        Core::GeneratedFile gf;
        gf.setPath(targetPath);

        if (!keepExisting) {
            if (isBinary) {
                gf.setBinary(true);
                gf.setBinaryContents(reader.data());
            } else {
                // TODO: Document that input files are UTF8 encoded!
                gf.setBinary(false);
                Utils::MacroExpander nested;
                const File *fPtr = &f;
                Utils::MacroExpander *thisExpander = &nested;
                nested.registerExtraResolver([fPtr, thisExpander](QString n, QString *ret) -> bool {
                    foreach (const File::OptionDefinition &od, fPtr->options) {
                        if (!JsonWizard::boolFromVariant(od.condition, thisExpander))
                            continue;
                        if (n == od.key) {
                            *ret = od.value;
                            return true;
                        }
                    }
                    return false;
                });
                nested.registerExtraResolver([expander](QString n, QString *ret) { return expander->resolveMacro(n, ret); });

                gf.setContents(Utils::TemplateEngine::processText(&nested, QString::fromUtf8(reader.data()),
                                                                  errorMessage));
                if (!errorMessage->isEmpty()) {
                    *errorMessage = QCoreApplication::translate("ProjectExplorer::JsonWizard", "When processing \"%1\":<br>%2")
                            .arg(sourcePath, *errorMessage);
                    return Core::GeneratedFiles();
                }
            }
        }

        Core::GeneratedFile::Attributes attributes = 0;
        if (JsonWizard::boolFromVariant(f.openInEditor, expander))
            attributes |= Core::GeneratedFile::OpenEditorAttribute;
        if (JsonWizard::boolFromVariant(f.openAsProject, expander))
            attributes |= Core::GeneratedFile::OpenProjectAttribute;
        if (JsonWizard::boolFromVariant(f.overwrite, expander))
            attributes |= Core::GeneratedFile::ForceOverwrite;

        if (keepExisting)
            attributes |= Core::GeneratedFile::KeepExistingFileAttribute;

        gf.setAttributes(attributes);
        result.append(gf);
    }

    return result;
}

bool JsonWizardFileGenerator::writeFile(const JsonWizard *wizard, Core::GeneratedFile *file, QString *errorMessage)
{
    Q_UNUSED(wizard);
    if (!(file->attributes() & Core::GeneratedFile::KeepExistingFileAttribute)) {
        if (!file->write(errorMessage))
            return false;
    }
    return true;
}

} // namespace Internal
} // namespace ProjectExplorer