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

**

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

** Contact: Qt Software Information (qt-info@nokia.com)

**

** This file is part of the $MODULE$ 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 either Technology Preview License Agreement or the

** Beta Release License Agreement.

**

** 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.0, included in the file LGPL_EXCEPTION.txt in this

** package.

**

** GNU General Public License Usage

** Alternatively, this file may be used under the terms of the GNU

** General Public License version 3.0 as published by the Free Software

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

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

** ensure the GNU General Public License version 3.0 requirements will be

** met: http://www.gnu.org/copyleft/gpl.html.

**

** If you are unsure which license is appropriate for your use, please

** contact the sales department at qt-sales@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 DUMP_VAR(v) \

{ \

    QString s(v); \

    QStringList list = project->values(s); \

    printf("----------------------------------\n", qPrintable(s)); \

    printf("Dumping %s (%d items) from %s, %d\n", \

            qPrintable(s), \

            list.count(), \

            __FILE__, \

            __LINE__); \

    foreach(QString l, list) \

        printf("\t%s\n", qPrintable(l)); \

}

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);

    QString tempPath(resultPath);

    bool isEpoc = false;

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

        isEpoc = true;

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

    }

    QFileInfo fi(fileInfo(resultPath));

    if(fi.isDir()) {

        if (isEpoc)

            resultPath = fi.absoluteFilePath();//canonicalFilePath();

        else

            resultPath = fi.canonicalFilePath();            

    } else {

        if (isEpoc)

            resultPath = fi.absolutePath();//canonicalPath();

        else

            resultPath = fi.canonicalPath();

    }

    //some fix for the not existed EPOC32\include folder

    if (isEpoc) {

        int index = resultPath.lastIndexOf("/epoc32/"); 

        QString tmpRes = resultPath.mid(index);

        if (tmpRes != tempPath) {

            //we have the problems for not existed include directory

            //change the path

            resultPath.replace(tmpRes, tempPath);

            }

    }

    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;

    //if(!project->isActiveConfig("build_pass"))

    //    t << "// = Command: " << build_args().replace("$(QMAKE)",

    //                  (project->isEmpty("QMAKE_QMAKE") ? QString("qmake") : var("QMAKE_QMAKE"))) << endl;

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

    t << endl;

    // defining define for bld.inf

    QString shortProFilename = project->projectFile();

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

    shortProFilename.replace(QString(".pro"), 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 (getTargetExtension() == "exe") {

        generatePkg = true;

    } else {

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

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

                generatePkg = true;

                break;

            }

        }

    }

    if (generatePkg) {

        QStringList platformList = project->values("SYMBIAN_PLATFORMS");

        foreach(QString platform, platformList) {

            if(platform.compare("WINSCW", Qt::CaseInsensitive)) {

                generatePkgFile(platform.toLower(), "udeb", iconFile);

                generatePkgFile(platform.toLower(), "urel", 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 {

        fprintf(stderr, "Error: Could not open wrapper makefile '%s'\n", qPrintable(wrapperFileName));

        return false;

    }

    if (getTargetExtension() == "subdirs") {

            // 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(QString(".pro"), QString(""));

    QString mmpFilename = shortProFilename;

    mmpFilename.append("_");

    mmpFilename.append(uid3);

    mmpFilename.append(".mmp");

    writeMmpFile(mmpFilename, symbianLangCodes);

    if (getTargetExtension() == "exe") {

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

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

            appname = removePathSeparators(appname);

            writeRegRssFile(appname, userRssRules);

            writeRssFile(appname, numberOfIcons, iconFile);

            writeLocFile(appname, symbianLangCodes);

        }

    }

    writeCustomDefFile();

    writeWrapperMakefile(wrapperMakefile, isPrimaryMakefile);

    return true;

}

bool SymbianMakefileGenerator::generatePkgFile(const QString &compiler, const QString &config, const QString &iconFile) {

    QString pkgFilename = QString("%1_%2_%3.%4")

                          .arg(fileInfo(project->projectFile()).completeBaseName())

                          .arg(compiler)

                          .arg(config)

                          .arg("pkg");

    QFile pkgFile(pkgFilename);

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

        return false;

    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;

    // language, (*** hardcoded to english atm)

    t << "; Language" << endl;

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

    // name of application, UID and version

    QString applicationName = project->first("TARGET");

    int last = applicationName.lastIndexOf(QLatin1Char('/'));

    applicationName = applicationName.mid( last == -1 ? 0 : last+1 );

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

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

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

    // vendor names (*** hardcoded for now)

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

    t << "%{\"Nokia, Qt Software\"}" << endl << endl;

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

    t << ":\"Nokia, Qt Software\"" << endl << endl;

    // Dependencies

    t << "; Dependencies" << endl;

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

        QStringList dependencies = project->values(item + ".depends");

        foreach(QString dependency, dependencies) {

            t << dependency << 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/%2/%3")

                              .arg(epocRoot())

                              .arg(compiler)

                              .arg(config);

    if (getTargetExtension() == "exe") {

        // deploy .exe file

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

        QString exeFile = applicationName + ".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(applicationName + ".rsc")

                 .arg(installPathResource)

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

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

                 .arg(epocRoot())

                 .arg(applicationName + "_reg.rsc")

                 .arg(installPathRegResource)

                 .arg(applicationName + "_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, compiler, config, 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;

    }

    return true;

}

bool SymbianMakefileGenerator::writeCustomDefFile() {

    if(targetType.compare("plugin", Qt::CaseInsensitive) == 0 && !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 {

            return false;

        }

    }

    return true;

}

void SymbianMakefileGenerator::init()

{

    MakefileGenerator::init();

/*

    DUMP_VAR("GENERATED_SOURCES");

*/

    // fixing again !!!

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

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

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

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

    if(!isConfigSetToSymbian())

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

    // bld.inf

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

    // .mmp

    initMmpVariables();

    // UID1

    uid1 = generateUID1();

    // check TARGET.UID2 and TARGET.UID3 presence

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

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

    } else {

        uid3 = generateUID3();

    }

    // some fix

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

        targetType = "exe";

    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 = "staticlib";

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

            targetType = "plugin";

        else // for now it will be default

            targetType = "dll";

    }

    else // fix

        targetType = "subdirs";

    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(getTargetExtension() == "exe") {

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

                // exe and also gui

                uid2 = "0x100039CE";

            } else {

                // exe but not gui.. uid2 is ignored anyway

                // set it to 0

                uid2 = "0";

            }

        } else if(getTargetExtension() == "dll" || getTargetExtension() == "lib") {

            uid2 = "0x1000008d";

        }

    }

    uid2 = uid2.trimmed();

    uid3 = uid3.trimmed();

    // UID is valid as either hex or decimal, so just convert it to number and back to hex

    // to get proper string for private dir

    bool conversionOk = false;

    uint uidNum = uid3.toUInt(&conversionOk, 0);

    if (!conversionOk) {

        fprintf(stderr, "Error: Invalid UID \"%s\".", uid3.toUtf8().constData());

    } else {

        privateDirUid.setNum(uidNum, 16);

        while (privateDirUid.length() < 8)

            privateDirUid.insert(0,QLatin1Char('0'));

    }

}

QString SymbianMakefileGenerator::getTargetExtension() {

    QString ret;

    if(targetType.compare("exe", Qt::CaseInsensitive) == 0 || targetType.compare("app", Qt::CaseInsensitive) == 0) {

        ret.append("exe");

    } else if (targetType.compare("staticlib",Qt::CaseInsensitive) == 0) {

        ret.append("lib");

    } else if (targetType.compare("dll", Qt::CaseInsensitive) == 0 || targetType.compare("plugin", Qt::CaseInsensitive) == 0) {