MMP_RULES overriding qmake variables now warns user

Added warning to qmake when it detects MMP_RULES that override
MMP statements created by qmake variables.

Also harmonized the way << operator is used with #defined strings in
symmake.cpp.

Task-number: QTBUG-5407
Reviewed-by: Janne Anttila

2 files changed, 111 insertions, 50 deletions

diff --git a/qmake/generators/symbian/symmake.cpp b/qmake/generators/symbian/symmake.cpp
index afaf338..8379ed9 100644
--- a/qmake/generators/symbian/symmake.cpp
+++ b/qmake/generators/symbian/symmake.cpp
@@ -77,6 +77,15 @@
 #define MMP_LINKEROPTION_CW "LINKEROPTION CW"
 #define MMP_LINKEROPTION_ARMCC "LINKEROPTION ARMCC"
 #define MMP_LINKEROPTION_GCCE "LINKEROPTION GCCE"
+#define MMP_CAPABILITY "CAPABILITY"
+#define MMP_EPOCALLOWDLLDATA "EPOCALLOWDLLDATA"
+#define MMP_EPOCHEAPSIZE "EPOCHEAPSIZE"
+#define MMP_EPOCSTACKSIZE "EPOCSTACKSIZE"
+#define MMP_UID "UID"
+#define MMP_VENDORID "VENDORID"
+#define MMP_VERSION "VERSION"
+#define MMP_START_RESOURCE "START RESOURCE"
+#define MMP_END_RESOURCE "END"
 
 #define SIS_TARGET "sis"
 #define OK_SIS_TARGET "ok_sis"
@@ -155,7 +164,7 @@ 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 << "// * 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;
@@ -444,7 +453,7 @@ void SymbianMakefileGenerator::writeCustomDefFile()
             QTextStream t(&ft);
 
             t << "; ==============================================================================" << endl;
-            t << "; Generated by qmake (" << qmake_version() << ") (Qt " << QT_VERSION_STR << ") on: ";
+            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;
@@ -646,30 +655,76 @@ void SymbianMakefileGenerator::initMmpVariables()
 
     // Check MMP_RULES for singleton keywords that are overridden
     QStringList overridableMmpKeywords;
+    QStringList restrictableMmpKeywords;
+    QStringList restrictedMmpKeywords;
+    bool inResourceBlock = false;
+
     overridableMmpKeywords << QLatin1String(MMP_TARGETTYPE);
+    restrictableMmpKeywords << QLatin1String(MMP_TARGET) << QLatin1String(MMP_SECUREID)
+       << QLatin1String(MMP_OPTION_CW) << QLatin1String(MMP_OPTION_ARMCC)
+       << QLatin1String(MMP_OPTION_GCCE) << QLatin1String(MMP_LINKEROPTION_CW)
+       << QLatin1String(MMP_LINKEROPTION_ARMCC) << QLatin1String(MMP_LINKEROPTION_GCCE)
+       << QLatin1String(MMP_CAPABILITY) << QLatin1String(MMP_EPOCALLOWDLLDATA)
+       << QLatin1String(MMP_EPOCHEAPSIZE) << QLatin1String(MMP_EPOCSTACKSIZE)
+       << QLatin1String(MMP_UID) << QLatin1String(MMP_VENDORID)
+       << QLatin1String(MMP_VERSION);
 
     foreach (QString item, project->values("MMP_RULES")) {
         if (project->values(item).isEmpty()) {
-            checkOverridability(overridableMmpKeywords, item);
+            handleMmpRulesOverrides(item, inResourceBlock, restrictedMmpKeywords,
+                                    restrictableMmpKeywords, overridableMmpKeywords);
         } else {
             foreach (QString itemRow, project->values(item)) {
-                checkOverridability(overridableMmpKeywords, itemRow);
+                handleMmpRulesOverrides(itemRow, inResourceBlock, restrictedMmpKeywords,
+                                        restrictableMmpKeywords, overridableMmpKeywords);
             }
         }
     }
+
+    if (restrictedMmpKeywords.size()) {
+        fprintf(stderr, "Warning: Restricted statements detected in MMP_RULES:\n"
+                "         (%s)\n"
+                "         Use corresponding qmake variable(s) instead.\n",
+                qPrintable(restrictedMmpKeywords.join(", ")));
+        }
 }
 
-void SymbianMakefileGenerator::checkOverridability(QStringList &overridableKeywords, QString &checkString)
+void SymbianMakefileGenerator::handleMmpRulesOverrides(QString &checkString,
+                                                       bool &inResourceBlock,
+                                                       QStringList &restrictedMmpKeywords,
+                                                       const QStringList &restrictableMmpKeywords,
+                                                       const QStringList &overridableMmpKeywords)
 {
-    // Check if checkString contains overridable keyword and
-    // add the keyword to overridden keywords list if so.
     QString simplifiedString = checkString.simplified();
-    foreach (QString item, overridableKeywords) {
-        if (simplifiedString.startsWith(item))
-            appendIfnotExist(overriddenMmpKeywords, item);
+
+    if (!inResourceBlock && simplifiedString.startsWith(MMP_START_RESOURCE, Qt::CaseInsensitive))
+        inResourceBlock = true;
+    else if (inResourceBlock && simplifiedString.startsWith(MMP_END_RESOURCE, Qt::CaseInsensitive))
+        inResourceBlock = false;
+
+    // Allow restricted and overridable items in RESOURCE blocks as those do not actually
+    // override anything.
+    if (!inResourceBlock) {
+        appendKeywordIfMatchFound(overriddenMmpKeywords, overridableMmpKeywords, simplifiedString);
+        appendKeywordIfMatchFound(restrictedMmpKeywords, restrictableMmpKeywords, simplifiedString);
+    }
+}
+
+void SymbianMakefileGenerator::appendKeywordIfMatchFound(QStringList &list,
+                                                         const QStringList &keywordList,
+                                                         QString &checkString)
+{
+    // Check if checkString starts with any supplied keyword and
+    // add the found keyword to list if it does.
+    foreach (QString item, keywordList) {
+        if (checkString.startsWith(QString(item).append(" "), Qt::CaseInsensitive)
+            || checkString.compare(item, Qt::CaseInsensitive) == 0) {
+            appendIfnotExist(list, item);
+        }
     }
 }
 
+
 bool SymbianMakefileGenerator::removeDuplicatedStrings(QStringList &stringList)
 {
     QStringList tmpStringList;
@@ -690,7 +745,7 @@ bool SymbianMakefileGenerator::removeDuplicatedStrings(QStringList &stringList)
 void SymbianMakefileGenerator::writeMmpFileHeader(QTextStream &t)
 {
     t << "// ==============================================================================" << endl;
-    t << "// Generated by qmake (" << qmake_version() << ") (Qt " << QT_VERSION_STR << ") on: ";
+    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;
@@ -775,7 +830,7 @@ void SymbianMakefileGenerator::writeMmpFileMacrosPart(QTextStream& t)
 
 void SymbianMakefileGenerator::addMacro(QTextStream& t, const QString& value)
 {
-    t << "MACRO" << "\t\t" <<  value << endl;
+    t << "MACRO\t\t" <<  value << endl;
 }
 
 
@@ -784,28 +839,28 @@ void SymbianMakefileGenerator::writeMmpFileTargetPart(QTextStream& t)
     bool skipTargetType = overriddenMmpKeywords.contains(MMP_TARGETTYPE);
 
     if (targetType == TypeExe) {
-        t << MMP_TARGET << "\t\t" << fixedTarget << ".exe" << endl;
+        t << MMP_TARGET "\t\t" << fixedTarget << ".exe" << endl;
         if (!skipTargetType) {
             if (project->values("CONFIG").contains("stdbinary", Qt::CaseInsensitive))
-                t << MMP_TARGETTYPE << "\t\t" << "STDEXE" << endl;
+                t << MMP_TARGETTYPE "\t\tSTDEXE" << endl;
             else
-                t << MMP_TARGETTYPE << "\t\t" << "EXE" << endl;
+                t << MMP_TARGETTYPE "\t\tEXE" << endl;
         }
     } else if (targetType == TypeDll || targetType == TypePlugin) {
-        t << MMP_TARGET << "\t\t" << fixedTarget << ".dll" << endl;
+        t << MMP_TARGET "\t\t" << fixedTarget << ".dll" << endl;
         if (!skipTargetType) {
             if (project->values("CONFIG").contains("stdbinary", Qt::CaseInsensitive))
-                t << MMP_TARGETTYPE << "\t\t" << "STDDLL" << endl;
+                t << MMP_TARGETTYPE "\t\tSTDDLL" << endl;
             else
-                t << MMP_TARGETTYPE << "\t\t" << "DLL" << endl;
+                t << MMP_TARGETTYPE "\t\tDLL" << endl;
         }
     } else if (targetType == TypeLib) {
-        t << MMP_TARGET << "\t\t" << fixedTarget << ".lib" << endl;
+        t << MMP_TARGET "\t\t" << fixedTarget << ".lib" << endl;
         if (!skipTargetType) {
             if (project->values("CONFIG").contains("stdbinary", Qt::CaseInsensitive))
-                t << MMP_TARGETTYPE << "\t\t" << "STDLIB" << endl;
+                t << MMP_TARGETTYPE "\t\tSTDLIB" << endl;
             else
-                t << MMP_TARGETTYPE << "\t\t" << "LIB" << endl;
+                t << MMP_TARGETTYPE "\t\tLIB" << endl;
         }
     } else {
         fprintf(stderr, "Error: Unexpected targettype (%d) in SymbianMakefileGenerator::writeMmpFileTargetPart\n", targetType);
@@ -813,30 +868,30 @@ void SymbianMakefileGenerator::writeMmpFileTargetPart(QTextStream& t)
 
     t << endl;
 
-    t << "UID" << "\t\t" << uid2 << " " << uid3 << endl;
+    t << MMP_UID "\t\t" << uid2 << " " << uid3 << endl;
 
     if (0 != project->values("TARGET.SID").size()) {
-        t << MMP_SECUREID << "\t\t" << project->values("TARGET.SID").join(" ") << endl;
+        t << MMP_SECUREID "\t\t" << project->values("TARGET.SID").join(" ") << endl;
     } else {
         if (0 == uid3.size())
-            t << MMP_SECUREID << "\t\t" << "0" << endl;
+            t << MMP_SECUREID "\t\t0" << endl;
         else
-            t << MMP_SECUREID << "\t\t" << uid3 << endl;
+            t << MMP_SECUREID "\t\t" << uid3 << endl;
     }
 
     // default value used from mkspecs is 0
     if (0 != project->values("TARGET.VID").size()) {
-        t << "VENDORID" << "\t\t" << project->values("TARGET.VID").join(" ") << endl;
+        t << MMP_VENDORID "\t\t" << project->values("TARGET.VID").join(" ") << endl;
     }
 
     t << endl;
 
     if (0 != project->first("TARGET.EPOCSTACKSIZE").size())
-        t << "EPOCSTACKSIZE" << "\t\t" << project->first("TARGET.EPOCSTACKSIZE") << endl;
+        t << MMP_EPOCSTACKSIZE "\t\t" << project->first("TARGET.EPOCSTACKSIZE") << endl;
     if (0 != project->values("TARGET.EPOCHEAPSIZE").size())
-        t << "EPOCHEAPSIZE" << "\t\t" << project->values("TARGET.EPOCHEAPSIZE").join(" ") << endl;
+        t << MMP_EPOCHEAPSIZE "\t\t" << project->values("TARGET.EPOCHEAPSIZE").join(" ") << endl;
     if (0 != project->values("TARGET.EPOCALLOWDLLDATA").size())
-        t << "EPOCALLOWDLLDATA" << endl;
+        t << MMP_EPOCALLOWDLLDATA << endl;
 
     if (targetType == TypePlugin && !project->values("CONFIG").contains("stdbinary", Qt::CaseInsensitive)) {
         // Use custom def file for Qt plugins
@@ -865,20 +920,20 @@ void SymbianMakefileGenerator::writeMmpFileResourcePart(QTextStream& t, QStringL
             t << lang << " "; // no endl
         }
         t << endl;
-        t << "START RESOURCE\t\t" << locTarget << endl;
+        t << MMP_START_RESOURCE "\t\t" << locTarget << endl;
         t << "HEADER" << endl;
         t << "TARGETPATH\t\t\t" RESOURCE_DIRECTORY_MMP << endl;
-        t << "END" << endl << endl;
+        t << MMP_END_RESOURCE << endl << endl;
 
         QString regTarget = fixedTarget;
         regTarget.append("_reg.rss");
 
         t << "SOURCEPATH\t\t\t." << endl;
-        t << "START RESOURCE\t\t" << regTarget << endl;
+        t << MMP_START_RESOURCE "\t\t" << regTarget << endl;
         if (isForSymbianSbsv2())
             t << "DEPENDS " << fixedTarget << ".rsg" << endl;
         t << "TARGETPATH\t\t" REGISTRATION_RESOURCE_DIRECTORY_HW << endl;
-        t << "END" << endl << endl;
+        t << MMP_END_RESOURCE << endl << endl;
     }
 }
 
@@ -890,7 +945,7 @@ void SymbianMakefileGenerator::writeMmpFileSystemIncludePart(QTextStream& t)
         QStringList values = it.value();
         for (int i = 0; i < values.size(); ++i) {
             QString handledPath = values.at(i);
-            t << "SYSTEMINCLUDE" << "\t\t" << fixPathForMmp(handledPath, current) << endl;
+            t << "SYSTEMINCLUDE\t\t" << fixPathForMmp(handledPath, current) << endl;
         }
     }
 
@@ -946,14 +1001,14 @@ void SymbianMakefileGenerator::writeMmpFileCapabilityPart(QTextStream& t)
 {
     if (0 != project->first("TARGET.CAPABILITY").size()) {
         QStringList &capabilities = project->values("TARGET.CAPABILITY");
-        t << "CAPABILITY" << "\t\t";
+        t << MMP_CAPABILITY "\t\t";
 
         for (int i = 0; i < capabilities.size(); ++i) {
             QString cap = capabilities.at(i);
             t << cap << " ";
         }
     } else {
-        t << "CAPABILITY" << "\t\t" << "None";
+        t << MMP_CAPABILITY "\t\tNone";
     }
     t << endl << endl;
 }
@@ -1048,21 +1103,21 @@ void SymbianMakefileGenerator::writeMmpFileCompilerOptionPart(QTextStream& t)
     if (!gccelink.isEmpty() && gccelink[gccelink.size()-1] == ' ')
         gccelink.chop(1);
 
-    if (!cw.isEmpty() && !overriddenMmpKeywords.contains(MMP_OPTION_CW))
+    if (!cw.isEmpty())
         t << MMP_OPTION_CW " " << cw <<  endl;
-    if (!armcc.isEmpty() && !overriddenMmpKeywords.contains(MMP_OPTION_ARMCC))
+    if (!armcc.isEmpty())
         t << MMP_OPTION_ARMCC " " << armcc <<  endl;
-    if (!gcce.isEmpty() && !overriddenMmpKeywords.contains(MMP_OPTION_GCCE))
+    if (!gcce.isEmpty())
         t << MMP_OPTION_GCCE " " << gcce <<  endl;
 
-    if (!cwlink.isEmpty() && !overriddenMmpKeywords.contains(MMP_LINKEROPTION_CW))
+    if (!cwlink.isEmpty())
         t << MMP_LINKEROPTION_CW " " << cwlink <<  endl;
-    if (!armlink.isEmpty() && !overriddenMmpKeywords.contains(MMP_LINKEROPTION_ARMCC))
+    if (!armlink.isEmpty())
         t << MMP_LINKEROPTION_ARMCC " " << armlink <<  endl;
-    if (!gccelink.isEmpty() && !overriddenMmpKeywords.contains(MMP_LINKEROPTION_GCCE))
+    if (!gccelink.isEmpty())
         t << MMP_LINKEROPTION_GCCE " " << gccelink <<  endl;
 
-    t <<  endl;
+    t << endl;
 }
 
 void SymbianMakefileGenerator::writeMmpFileBinaryVersionPart(QTextStream& t)
@@ -1098,7 +1153,7 @@ void SymbianMakefileGenerator::writeMmpFileBinaryVersionPart(QTextStream& t)
         mmpVersion = "10.0"; // Default binary version for symbian is 10.0
     }
 
-    t << "VERSION " << mmpVersion  << endl;
+    t << MMP_VERSION " " << mmpVersion  << endl;
 }
 
 void SymbianMakefileGenerator::writeMmpFileRulesPart(QTextStream& t)
@@ -1265,7 +1320,7 @@ void SymbianMakefileGenerator::writeRegRssFile(QStringList &userItems)
         generatedFiles << ft.fileName();
         QTextStream t(&ft);
         t << "// ============================================================================" << endl;
-        t << "// * Generated by qmake (" << qmake_version() << ") (Qt " << QT_VERSION_STR << ") on: ";
+        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;
@@ -1274,8 +1329,7 @@ void SymbianMakefileGenerator::writeRegRssFile(QStringList &userItems)
         t << "#include <" << fixedTarget << ".rsg>" << endl;
         t << "#include <appinfo.rh>" << endl;
         t << endl;
-        //t << "#include <data_caging_paths.hrh>" << "\n" << endl;
-        t << "UID2 " << "KUidAppRegistrationResourceFile" << endl;
+        t << "UID2 KUidAppRegistrationResourceFile" << endl;
         t << "UID3 " << uid3 << endl << endl;
         t << "RESOURCE APP_REGISTRATION_INFO" << endl;
         t << "\t{" << endl;
@@ -1300,7 +1354,7 @@ void SymbianMakefileGenerator::writeRssFile(QString &numberOfIcons, QString &ico
         generatedFiles << ft.fileName();
         QTextStream t(&ft);
         t << "// ============================================================================" << endl;
-        t << "// * Generated by qmake (" << qmake_version() << ") (Qt " << QT_VERSION_STR << ") on: ";
+        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;
@@ -1346,7 +1400,7 @@ void SymbianMakefileGenerator::writeLocFile(QStringList &symbianLangCodes)
         generatedFiles << ft.fileName();
         QTextStream t(&ft);
         t << "// ============================================================================" << endl;
-        t << "// * Generated by qmake (" << qmake_version() << ") (Qt " << QT_VERSION_STR << ") on: ";
+        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;
diff --git a/qmake/generators/symbian/symmake.h b/qmake/generators/symbian/symmake.h
index 2e78c46..1a20e64 100644
--- a/qmake/generators/symbian/symmake.h
+++ b/qmake/generators/symbian/symmake.h
@@ -96,7 +96,14 @@ protected:
     QString generateUID3();
 
     void initMmpVariables();
-    void checkOverridability(QStringList &overridableKeywords, QString &checkString);
+    void handleMmpRulesOverrides(QString &checkString,
+                                 bool &inResourceBlock,
+                                 QStringList &restrictedMmpKeywords,
+                                 const QStringList &restrictableMmpKeywords,
+                                 const QStringList &overridableMmpKeywords);
+    void appendKeywordIfMatchFound(QStringList &list,
+                                   const QStringList &keywordList,
+                                   QString &checkString);
 
     void writeHeader(QTextStream &t);
     void writeBldInfContent(QTextStream& t, bool addDeploymentExtension, const QString &iconFile);