/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the qmake application of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** 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 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain

** additional rights.  These rights are described in the Nokia Qt LGPL

** Exception version 1.1, included in the file LGPL_EXCEPTION.txt in this

** package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "symmake.h"

#include "initprojectdeploy_symbian.h"

#include <qstring.h>

#include <qhash.h>

#include <qstringlist.h>

#include <qdir.h>

#include <qdatetime.h>

#include <stdlib.h>

#include <qdebug.h>

#define RESOURCE_DIRECTORY_MMP "/resource/apps"

#define RESOURCE_DIRECTORY_RESOURCE "\\\\resource\\\\apps\\\\"

#define REGISTRATION_RESOURCE_DIRECTORY_HW "/private/10003a3f/import/apps"

#define PLUGIN_COMMON_DEF_FILE_FOR_MMP "./plugin_common.def"

#define PLUGIN_COMMON_DEF_FILE_ACTUAL "plugin_commonU.def"

#define BLD_INF_FILENAME_LEN (sizeof(BLD_INF_FILENAME) - 1)

#define BLD_INF_RULES_BASE "BLD_INF_RULES."

#define BLD_INF_TAG_PLATFORMS "prj_platforms"

#define BLD_INF_TAG_MMPFILES "prj_mmpfiles"

#define BLD_INF_TAG_TESTMMPFILES "prj_testmmpfiles"

#define BLD_INF_TAG_EXTENSIONS "prj_extensions"

#define RSS_RULES "RSS_RULES"

#define RSS_RULES_BASE "RSS_RULES."

#define RSS_TAG_NBROFICONS "number_of_icons"

#define RSS_TAG_ICONFILE "icon_file"

#define MMP_TARGET "TARGET"

#define MMP_TARGETTYPE "TARGETTYPE"

#define MMP_SECUREID "SECUREID"

#define SIS_TARGET "sis"

#define OK_SIS_TARGET "ok_sis"

#define FAIL_SIS_NOPKG_TARGET "fail_sis_nopkg"

#define FAIL_SIS_NOCACHE_TARGET "fail_sis_nocache"

#define RESTORE_BUILD_TARGET "restore_build"

#define PRINT_FILE_CREATE_ERROR(filename) fprintf(stderr, "Error: Could not create '%s'\n", qPrintable(filename));

QString SymbianMakefileGenerator::fixPathForMmp(const QString& origPath, const QDir& parentDir)

{

    static QString epocRootStr;

    if (epocRootStr.isEmpty()) {

        QFileInfo efi(epocRoot());

        epocRootStr = efi.canonicalFilePath();

        if (epocRootStr.isEmpty()) {

            fprintf(stderr, "Unable to resolve epocRoot '%s' to real dir on current drive, defaulting to '/' for mmp paths\n", qPrintable(epocRoot()));

            epocRootStr = "/";

        }

        if (!epocRootStr.endsWith("/"))

            epocRootStr += "/";

        epocRootStr += "epoc32/";

    }

    QString resultPath = origPath;

    // Make it relative, unless it starts with "%epocroot%/epoc32/"

    if (resultPath.startsWith(epocRootStr, Qt::CaseInsensitive)) {

        resultPath.replace(epocRootStr, "/epoc32/", Qt::CaseInsensitive);

    } else {

        resultPath = parentDir.relativeFilePath(resultPath);

    }

    resultPath = QDir::cleanPath(resultPath);

    if (resultPath.isEmpty())

        resultPath = ".";

    return resultPath;

}

QString SymbianMakefileGenerator::canonizePath(const QString& origPath)

{

    // Since current path gets appended almost always anyway, use it as default

    // for nonexisting paths.

    static QString defaultPath;

    if (defaultPath.isEmpty()) {

        QFileInfo fi(".");

        defaultPath = fi.canonicalFilePath();

    }

    // Prepend epocroot to any paths beginning with "/epoc32/"

    QString resultPath = QDir::fromNativeSeparators(origPath);

    if (resultPath.startsWith("/epoc32/", Qt::CaseInsensitive))

        resultPath = QDir::fromNativeSeparators(epocRoot()) + resultPath.mid(1);

    QFileInfo fi(fileInfo(resultPath));

    if (fi.isDir()) {

        resultPath = fi.canonicalFilePath();

    } else {

        resultPath = fi.canonicalPath();

    }

    resultPath = QDir::cleanPath(resultPath);

    if (resultPath.isEmpty())

        resultPath = defaultPath;

    return resultPath;

}

SymbianMakefileGenerator::SymbianMakefileGenerator() : MakefileGenerator() { }

SymbianMakefileGenerator::~SymbianMakefileGenerator() { }

void SymbianMakefileGenerator::writeHeader(QTextStream &t)

{

    t << "// ============================================================================" << endl;

    t << "// * Makefile for building: " << escapeFilePath(var("TARGET")) << endl;

    t << "// * Generated by qmake (" << qmake_version() << ") (Qt " << QT_VERSION_STR << ") on: ";

    t << QDateTime::currentDateTime().toString(Qt::ISODate) << endl;

    t << "// * This file is generated by qmake and should not be modified by the" << endl;

    t << "// * user." << endl;

    t << "// * Project:  " << fileFixify(project->projectFile()) << endl;

    t << "// * Template: " << var("TEMPLATE") << endl;

    t << "// ============================================================================" << endl;

    t << endl;

    // Defining define for bld.inf

    QString shortProFilename = project->projectFile();

    shortProFilename.replace(0, shortProFilename.lastIndexOf("/") + 1, QString(""));

    shortProFilename.replace(Option::pro_ext, QString(""));

    QString bldinfDefine = shortProFilename;

    bldinfDefine.append("_");

    bldinfDefine.append(generate_uid(project->projectFile()));

    bldinfDefine.prepend("BLD_INF_");

    removeSpecialCharacters(bldinfDefine);

    t << "#define " << bldinfDefine.toUpper() << endl << endl;

}

bool SymbianMakefileGenerator::writeMakefile(QTextStream &t)

{

    writeHeader(t);

    QString numberOfIcons;

    QString iconFile;

    QStringList userRssRules;

    readRssRules(numberOfIcons, iconFile, userRssRules);

    // Get the application translations and convert to symbian OS lang code, i.e. decical number

    QStringList symbianLangCodes = symbianLangCodesFromTsFiles();

    // Generate pkg files if there are any actual files to deploy

    bool generatePkg = false;

    if (targetType == TypeExe) {

        generatePkg = true;

    } else {

        foreach(QString item, project->values("DEPLOYMENT")) {

            if (!project->values(item + ".sources").isEmpty()) {

                generatePkg = true;

                break;

            }

        }

    }

    if (generatePkg) {

        generatePkgFile(iconFile);

    }

    writeBldInfContent(t, generatePkg);

    // Generate empty wrapper makefile here, because wrapper makefile must exist before writeMkFile,

    // but all required data is not yet available.

    bool isPrimaryMakefile = true;

    QString wrapperFileName("Makefile");

    QString outputFileName = fileInfo(Option::output.fileName()).fileName();

    if (outputFileName != BLD_INF_FILENAME) {

        wrapperFileName.append(".").append((outputFileName.size() > BLD_INF_FILENAME_LEN && outputFileName.left(BLD_INF_FILENAME_LEN) == BLD_INF_FILENAME) ? outputFileName.mid(8) : outputFileName);

        isPrimaryMakefile = false;

    }

    QFile wrapperMakefile(wrapperFileName);

    if (wrapperMakefile.open(QIODevice::WriteOnly)) {

        generatedFiles << wrapperFileName;

    } else {

        PRINT_FILE_CREATE_ERROR(wrapperFileName);

        return false;

    }

    if (targetType == TypeSubdirs) {

        // If we have something to deploy, generate extension makefile for just that, since

        // normal extension makefile is not getting generated and we need emulator deployment to be done.

        if (generatePkg)

            writeMkFile(wrapperFileName, true);

        writeWrapperMakefile(wrapperMakefile, isPrimaryMakefile);

        return true;

    }

    writeMkFile(wrapperFileName, false);

    QString shortProFilename = project->projectFile();

    shortProFilename.replace(0, shortProFilename.lastIndexOf("/") + 1, QString(""));

    shortProFilename.replace(Option::pro_ext, QString(""));

    QString mmpFilename = shortProFilename;

    mmpFilename.append("_");

    mmpFilename.append(uid3);

    mmpFilename.append(Option::mmp_ext);

    writeMmpFile(mmpFilename, symbianLangCodes);

    if (targetType == TypeExe) {

        if (!project->values("CONFIG").contains("no_icon", Qt::CaseInsensitive)) {

            writeRegRssFile(userRssRules);

            writeRssFile(numberOfIcons, iconFile);

            writeLocFile(symbianLangCodes);

        }

    }

    writeCustomDefFile();

    writeWrapperMakefile(wrapperMakefile, isPrimaryMakefile);

    return true;

}

void SymbianMakefileGenerator::generatePkgFile(const QString &iconFile)

{

    QString pkgFilename = QString("%1_template.%2")

                          .arg(fixedTarget)

                          .arg("pkg");

    QFile pkgFile(pkgFilename);

    if (!pkgFile.open(QIODevice::WriteOnly | QIODevice::Text)) {

        PRINT_FILE_CREATE_ERROR(pkgFilename);

        return;

    }

    generatedFiles << pkgFile.fileName();

    // Header info

    QTextStream t(&pkgFile);

    t << QString("; %1 generated by qmake at %2").arg(pkgFilename).arg(QDateTime::currentDateTime().toString(Qt::ISODate))  << endl;

    t << "; This file is generated by qmake and should not be modified by the user" << endl;

    t << ";" << endl << endl;

    // Construct QStringList from pkg_prerules since we need search it before printed to file

    QStringList rawPkgPreRules;

    foreach(QString deploymentItem, project->values("DEPLOYMENT")) {

        foreach(QString pkgrulesItem, project->values(deploymentItem + ".pkg_prerules")) {

            QStringList pkgrulesValue = project->values(pkgrulesItem);

            // If there is no stringlist defined for a rule, use rule name directly

            // This is convenience for defining single line mmp statements

            if (pkgrulesValue.isEmpty()) {

                rawPkgPreRules << pkgrulesItem;

            } else {

                foreach(QString pkgrule, pkgrulesValue) {

                    rawPkgPreRules << pkgrule;

                }

            }

        }

    }

    // Apply some defaults if specific data does not exist in PKG pre-rules

    if (!containsStartWithItem('&', rawPkgPreRules)) {

        // language, (*** hardcoded to english atm, should be parsed from TRANSLATIONS)

        t << "; Language" << endl;

        t << "&EN" << endl << endl;

    } else {

        // In case user defines langs, he must take care also about SIS header

        if (!containsStartWithItem('#', rawPkgPreRules))

            fprintf(stderr, "Warning: If language is defined with DEPLOYMENT pkg_prerules, also the SIS header must be defined\n");

    }

    // name of application, UID and version

    QString applicationVersion = project->first("VERSION").isEmpty() ? "1,0,0" : project->first("VERSION").replace('.', ',');

    if (!containsStartWithItem('#', rawPkgPreRules)) {

        QString visualTarget = escapeFilePath(fileFixify(project->first("TARGET")));

        visualTarget = removePathSeparators(visualTarget);

        t << "; SIS header: name, uid, version" << endl;

        t << QString("#{\"%1\"},(%2),%3").arg(visualTarget).arg(uid3).arg(applicationVersion) << endl << endl;

    }

    // Localized vendor name

    if (!containsStartWithItem('%', rawPkgPreRules)) {

        t << "; Localised Vendor name" << endl;

        t << "%{\"Vendor\"}" << endl << endl;

    }

    // Unique vendor name

    if (!containsStartWithItem(':', rawPkgPreRules)) {

        t << "; Unique Vendor name" << endl;

        t << ":\"Vendor\"" << endl << endl;

    }

    // PKG pre-rules - these are added before actual file installations i.e. SIS package body

    if (rawPkgPreRules.size()) {

        t << "; Manual PKG pre-rules from PRO files" << endl;

        foreach(QString item, rawPkgPreRules) {

            t << item << endl;

        }

        t << endl;

    }

    // Install paths on the phone *** should be dynamic at some point

    QString installPathBin = "!:\\sys\\bin";

    QString installPathResource = "!:\\resource\\apps";

    QString installPathRegResource = "!:\\private\\10003a3f\\import\\apps";

    // Find location of builds

    QString epocReleasePath = QString("%1epoc32/release/$(PLATFORM)/$(TARGET)")

                              .arg(epocRoot());

    if (targetType == TypeExe) {

        // deploy .exe file

        t << "; Executable and default resource files" << endl;

        QString exeFile = fixedTarget + ".exe";

        t << QString("\"%1/%2\"    - \"%3\\%4\"")

             .arg(epocReleasePath)

             .arg(exeFile)

             .arg(installPathBin)

             .arg(exeFile) << endl;

        // deploy rsc & reg_rsc file

        if (!project->values("CONFIG").contains("no_icon", Qt::CaseInsensitive)) {

            t << QString("\"%1epoc32/data/z/resource/apps/%2\"    - \"%3\\%4\"")

                 .arg(epocRoot())

                 .arg(fixedTarget + ".rsc")

                 .arg(installPathResource)

                 .arg(fixedTarget + ".rsc") << endl;

            t << QString("\"%1epoc32/data/z/private/10003a3f/import/apps/%2\"    - \"%3\\%4\"")

                 .arg(epocRoot())

                 .arg(fixedTarget + "_reg.rsc")

                 .arg(installPathRegResource)

                 .arg(fixedTarget + "_reg.rsc") << endl;

            QString myIconFile = iconFile;

            myIconFile = myIconFile.replace("\\\\", "\\");

            if (!iconFile.isEmpty())  {

                t << QString("\"%1epoc32/data/z%2\"    - \"!:%3\"")

                     .arg(epocRoot())

                     .arg(QString(myIconFile).replace('\\','/'))

                     .arg(myIconFile) << endl << endl;

            }

        }

    }

    // deploy any additional DEPLOYMENT  files

    DeploymentList depList;

    QString remoteTestPath;

    remoteTestPath = QString("!:\\private\\%1").arg(privateDirUid);

    initProjectDeploySymbian(project, depList, remoteTestPath, true, "$(PLATFORM)", "$(TARGET)", generatedDirs, generatedFiles);

    if (depList.size())

        t << "; DEPLOYMENT" << endl;

    for (int i = 0; i < depList.size(); ++i)  {

        t << QString("\"%1\"    - \"%2\"")

             .arg(QString(depList.at(i).from).replace('\\','/'))

             .arg(depList.at(i).to) << endl;

    }

    t << endl;

    // PKG post-rules - these are added after actual file installations i.e. SIS package body

    t << "; Manual PKG post-rules from PRO files" << endl;

    foreach(QString deploymentItem, project->values("DEPLOYMENT")) {

        foreach(QString pkgrulesItem, project->values(deploymentItem + ".pkg_postrules")) {

            QStringList pkgrulesValue = project->values(pkgrulesItem);

            // If there is no stringlist defined for a rule, use rule name directly

            // This is convenience for defining single line statements

            if (pkgrulesValue.isEmpty()) {

                t << pkgrulesItem << endl;

            } else {

                foreach(QString pkgrule, pkgrulesValue) {

                    t << pkgrule << endl;

                }

            }

            t << endl;

        }

    }

}

bool SymbianMakefileGenerator::containsStartWithItem(const QChar &c, const QStringList& src)

{

    bool result = false;

    foreach(QString str, src) {

        if (str.startsWith(c)) {

            result =  true;

            break;

        }

    }

    return result;

}

void SymbianMakefileGenerator::writeCustomDefFile()

{

    if (targetType == TypePlugin && !project->values("CONFIG").contains("stdbinary", Qt::CaseInsensitive)) {

        // Create custom def file for plugin

        QFile ft(QLatin1String(PLUGIN_COMMON_DEF_FILE_ACTUAL));

        if (ft.open(QIODevice::WriteOnly)) {

            generatedFiles << ft.fileName();

            QTextStream t(&ft);

            t << "; ==============================================================================" << endl;

            t << "; Generated by qmake (" << qmake_version() << ") (Qt " << QT_VERSION_STR << ") on: ";

            t << QDateTime::currentDateTime().toString(Qt::ISODate) << endl;

            t << "; This file is generated by qmake and should not be modified by the" << endl;

            t << "; user." << endl;

            t << ";  Name        : " PLUGIN_COMMON_DEF_FILE_ACTUAL << endl;

            t << ";  Part of     : " << project->values("TARGET").join(" ") << endl;

            t << ";  Description : Fixes common plugin symbols to known ordinals" << endl;

            t << ";  Version     : " << endl;

            t << ";" << endl;

            t << "; ==============================================================================" << "\n" << endl;

            t << endl;

            t << "EXPORTS" << endl;

            t << "\tqt_plugin_query_verification_data @ 1 NONAME" << endl;

            t << "\tqt_plugin_instance @ 2 NONAME" << endl;

            t << endl;

        } else {

            PRINT_FILE_CREATE_ERROR(QString(PLUGIN_COMMON_DEF_FILE_ACTUAL))

        }

    }

}

void SymbianMakefileGenerator::init()

{

    MakefileGenerator::init();

    fixedTarget = escapeFilePath(fileFixify(project->first("TARGET")));

    fixedTarget = removePathSeparators(fixedTarget);

    removeSpecialCharacters(fixedTarget);

    if (0 != project->values("QMAKE_PLATFORM").size())

        platform = varGlue("QMAKE_PLATFORM", "", " ", "");

    if (0 == project->values("QMAKESPEC").size())

        project->values("QMAKESPEC").append(qgetenv("QMAKESPEC"));

    project->values("QMAKE_LIBS") += escapeFilePaths(project->values("LIBS"));

    project->values("QMAKE_LIBS_PRIVATE") += escapeFilePaths(project->values("LIBS_PRIVATE"));

    // bld.inf

    project->values("MAKEFILE") += BLD_INF_FILENAME;

    // .mmp

    initMmpVariables();

    // Check TARGET.UID3 presence

    if (0 != project->values("TARGET.UID3").size()) {

        uid3 = project->first("TARGET.UID3");

    } else {

        uid3 = generateUID3();

    }

    if ((project->values("TEMPLATE")).contains("app"))

        targetType = TypeExe;

    else if ((project->values("TEMPLATE")).contains("lib")) {

        // Check CONFIG to see if we are to build staticlib or dll

        if (project->values("CONFIG").contains("staticlib") || project->values("CONFIG").contains("static"))

            targetType = TypeLib;

        else if (project->values("CONFIG").contains("plugin"))

            targetType = TypePlugin;

        else

            targetType = TypeDll;

    } else {

        targetType = TypeSubdirs;

    }

    if (0 != project->values("TARGET.UID2").size()) {

        uid2 = project->first("TARGET.UID2");

    } else if (project->values("CONFIG").contains("stdbinary", Qt::CaseInsensitive)) {

        uid2 = "0x20004C45";

    } else {

        if (targetType == TypeExe) {

            if (project->values("QT").contains("gui", Qt::CaseInsensitive)) {

                // exe and gui -> uid2 needed

                uid2 = "0x100039CE";

            } else {

                // exe but not gui: uid2 is ignored anyway -> set it to 0

                uid2 = "0";

            }

        } else if (targetType == TypeDll || targetType == TypeLib || targetType == TypePlugin) {

            uid2 = "0x1000008d";

        }

    }

    uid2 = uid2.trimmed();

    uid3 = uid3.trimmed();