shiboken: Introduce enumeration for C++ indirections

Replace the int "indirections" field of TypeInfo and AbstractMetaType
by a Vector of an enumeration representing '*' and "* const".
It is then possible distinguish between "int *" and "int *const".

Task-number: PYSIDE-672
Change-Id: I68677fa515abb7e94217fc1c2b6ac28b42678284
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>

8 files changed, 74 insertions, 34 deletions

diff --git a/sources/shiboken2/ApiExtractor/abstractmetabuilder.cpp b/sources/shiboken2/ApiExtractor/abstractmetabuilder.cpp
index a4186da1a..1fa4bde9c 100644
--- a/sources/shiboken2/ApiExtractor/abstractmetabuilder.cpp
+++ b/sources/shiboken2/ApiExtractor/abstractmetabuilder.cpp
@@ -2344,7 +2344,7 @@ AbstractMetaType *AbstractMetaBuilderPrivate::translateTypeStatic(const TypeInfo
     if (!typeInfo.arrayElements().isEmpty() && !isConstCharStarCase) {
         TypeInfo newInfo;
         //newInfo.setArguments(typeInfo.arguments());
-        newInfo.setIndirections(typeInfo.indirections());
+        newInfo.setIndirectionsV(typeInfo.indirectionsV());
         newInfo.setConstant(typeInfo.isConstant());
         newInfo.setFunctionPointer(typeInfo.isFunctionPointer());
         newInfo.setQualifiedName(typeInfo.qualifiedName());
@@ -2457,7 +2457,7 @@ AbstractMetaType *AbstractMetaBuilderPrivate::translateTypeStatic(const TypeInfo
 
     AbstractMetaType *metaType = new AbstractMetaType;
     metaType->setTypeEntry(type);
-    metaType->setIndirections(typeInfo.indirections());
+    metaType->setIndirectionsV(typeInfo.indirectionsV());
     metaType->setReferenceType(typeInfo.referenceType());
     metaType->setConstant(typeInfo.isConstant());
     metaType->setOriginalTypeDescription(_typei.toString());
@@ -2842,7 +2842,7 @@ bool AbstractMetaBuilderPrivate::inheritTemplate(AbstractMetaClass *subclass,
             temporaryType->setTypeEntry(t);
             temporaryType->setConstant(i.isConstant());
             temporaryType->setReferenceType(i.referenceType());
-            temporaryType->setIndirections(i.indirections());
+            temporaryType->setIndirectionsV(i.indirectionsV());
             temporaryType->decideUsagePattern();
             templateTypes << temporaryType;
         } else {
diff --git a/sources/shiboken2/ApiExtractor/abstractmetalang.cpp b/sources/shiboken2/ApiExtractor/abstractmetalang.cpp
index 849c805db..489d2e4aa 100644
--- a/sources/shiboken2/ApiExtractor/abstractmetalang.cpp
+++ b/sources/shiboken2/ApiExtractor/abstractmetalang.cpp
@@ -31,6 +31,8 @@
 #include "typedatabase.h"
 #include "typesystem.h"
 
+#include <parser/codemodel.h>
+
 #ifndef QT_NO_DEBUG_STREAM
 #  include <QtCore/QMetaEnum>
 #  include <QtCore/QMetaObject>
@@ -113,7 +115,6 @@ void AbstractMetaAttributes::assignMetaAttributes(const AbstractMetaAttributes &
 AbstractMetaType::AbstractMetaType() :
     m_constant(false),
     m_cppInstantiation(true),
-    m_indirections(0),
     m_reserved(0)
 {
 }
@@ -156,7 +157,7 @@ AbstractMetaType *AbstractMetaType::copy() const
     cpy->setTypeUsagePattern(typeUsagePattern());
     cpy->setConstant(isConstant());
     cpy->setReferenceType(referenceType());
-    cpy->setIndirections(indirections());
+    cpy->setIndirectionsV(indirectionsV());
     cpy->setInstantiations(instantiations());
     cpy->setArrayElementCount(arrayElementCount());
     cpy->setOriginalTypeDescription(originalTypeDescription());
@@ -291,8 +292,12 @@ QDebug operator<<(QDebug d, const AbstractMetaType *at)
             d << ", typeEntry=" << at->typeEntry() << ", signature=\""
                 << at->cppSignature() << "\", pattern="
                 << at->typeUsagePattern();
-            if (at->indirections())
-                d << ", indirections=" << at->indirections();
+            const auto indirections = at->indirectionsV();
+            if (!indirections.isEmpty()) {
+                d << ", indirections=";
+                for (auto i : indirections)
+                    d << ' ' << TypeInfo::indirectionKeyword(i);
+            }
             if (at->referenceType())
                 d << ", reftype=" << at->referenceType();
             if (at->isConstant())
@@ -2255,10 +2260,10 @@ QString AbstractMetaType::formatSignature(bool minimal) const
         result += QLatin1String(" >");
     }
 
-    if (!minimal && (m_indirections != 0 || m_referenceType != NoReference))
+    if (!minimal && (!m_indirections.isEmpty() || m_referenceType != NoReference))
         result += QLatin1Char(' ');
-    if (m_indirections)
-        result += QString(m_indirections, QLatin1Char('*'));
+    for (Indirection i : m_indirections)
+        result += TypeInfo::indirectionKeyword(i);
     switch (referenceType()) {
     case NoReference:
         break;
diff --git a/sources/shiboken2/ApiExtractor/abstractmetalang.h b/sources/shiboken2/ApiExtractor/abstractmetalang.h
index d1a0fbf88..e05079bdc 100644
--- a/sources/shiboken2/ApiExtractor/abstractmetalang.h
+++ b/sources/shiboken2/ApiExtractor/abstractmetalang.h
@@ -288,6 +288,7 @@ class AbstractMetaType
 {
     Q_GADGET
 public:
+    typedef QVector<Indirection> Indirections;
 
     enum TypeUsagePattern {
         InvalidPattern,
@@ -443,16 +444,21 @@ public:
 
     int actualIndirections() const
     {
-        return m_indirections + (m_referenceType == LValueReference ? 1 : 0);
-    }
-    int indirections() const
-    {
-        return m_indirections;
+        return m_indirections.size() + (m_referenceType == LValueReference ? 1 : 0);
     }
+
+    Indirections indirectionsV() const { return m_indirections; }
+    void setIndirectionsV(const Indirections &i) { m_indirections = i; }
+    void clearIndirections() { m_indirections.clear(); }
+
+    // "Legacy"?
+    int indirections() const { return m_indirections.size(); }
     void setIndirections(int indirections)
     {
-        m_indirections = indirections;
+        m_indirections = Indirections(indirections, Indirection::Pointer);
     }
+    void addIndirection(Indirection i = Indirection::Pointer)
+        { m_indirections.append(i); }
 
     void setArrayElementCount(int n)
     {
@@ -541,12 +547,13 @@ private:
     int m_arrayElementCount = -1;
     const AbstractMetaType *m_arrayElementType = nullptr;
     const AbstractMetaType *m_originalTemplateType = nullptr;
+    Indirections m_indirections;
 
     TypeUsagePattern m_pattern = InvalidPattern;
     uint m_constant : 1;
     uint m_cppInstantiation : 1;
-    int m_indirections : 4;
-    uint m_reserved : 26; // unused
+    uint m_reserved : 30; // unused
+
     ReferenceType m_referenceType = NoReference;
     AbstractMetaTypeList m_children;
 
diff --git a/sources/shiboken2/ApiExtractor/parser/codemodel.cpp b/sources/shiboken2/ApiExtractor/parser/codemodel.cpp
index 39f438f4e..4ad86bd15 100644
--- a/sources/shiboken2/ApiExtractor/parser/codemodel.cpp
+++ b/sources/shiboken2/ApiExtractor/parser/codemodel.cpp
@@ -140,7 +140,7 @@ TypeInfo TypeInfo::combine(const TypeInfo &__lhs, const TypeInfo &__rhs)
     __result.setVolatile(__result.isVolatile() || __rhs.isVolatile());
     if (__rhs.referenceType() > __result.referenceType())
         __result.setReferenceType(__rhs.referenceType());
-    __result.setIndirections(__result.indirections() + __rhs.indirections());
+    __result.m_indirections.append(__rhs.m_indirections);
     __result.setArrayElements(__result.arrayElements() + __rhs.arrayElements());
     __result.m_instantiations.append(__rhs.m_instantiations);
 
@@ -149,7 +149,7 @@ TypeInfo TypeInfo::combine(const TypeInfo &__lhs, const TypeInfo &__rhs)
 
 bool TypeInfo::isVoid() const
 {
-    return m_indirections == 0 && m_referenceType == NoReference
+    return m_indirections.isEmpty() && m_referenceType == NoReference
         && m_arguments.isEmpty() && m_arrayElements.isEmpty()
         && m_instantiations.isEmpty()
         && m_qualifiedName.size() == 1
@@ -218,8 +218,8 @@ QString TypeInfo::toString() const
         tmp += QLatin1Char('>');
     }
 
-    if (indirections())
-        tmp += QString(indirections(), QLatin1Char('*'));
+    for (Indirection i : m_indirections)
+        tmp.append(indirectionKeyword(i));
 
     switch (referenceType()) {
     case NoReference:
@@ -273,6 +273,12 @@ bool TypeInfo::operator==(const TypeInfo &other) const
            && m_instantiations == other.m_instantiations;
 }
 
+QString TypeInfo::indirectionKeyword(Indirection i)
+{
+    return i == Indirection::Pointer
+        ? QStringLiteral("*") : QStringLiteral("* const");
+}
+
 #ifndef QT_NO_DEBUG_STREAM
 template <class It>
 void formatSequence(QDebug &d, It i1, It i2, const char *separator=", ")
@@ -293,8 +299,11 @@ void TypeInfo::formatDebug(QDebug &d) const
         d << ", [const]";
     if (m_volatile)
         d << ", [volatile]";
-    if (m_indirections)
-        d << ", indirections=" << m_indirections;
+    if (!m_indirections.isEmpty()) {
+        d << ", indirections=";
+        for (auto i : m_indirections)
+            d << ' ' << TypeInfo::indirectionKeyword(i);
+    }
     switch (m_referenceType) {
     case NoReference:
         break;
diff --git a/sources/shiboken2/ApiExtractor/parser/codemodel.h b/sources/shiboken2/ApiExtractor/parser/codemodel.h
index fbc1f2b7a..1bc3e6e12 100644
--- a/sources/shiboken2/ApiExtractor/parser/codemodel.h
+++ b/sources/shiboken2/ApiExtractor/parser/codemodel.h
@@ -100,6 +100,8 @@ class TypeInfo
 {
     friend class TypeParser;
 public:
+    typedef QVector<Indirection> Indirections;
+
     TypeInfo() : flags(0), m_referenceType(NoReference) {}
 
     QStringList qualifiedName() const
@@ -137,14 +139,16 @@ public:
     ReferenceType referenceType() const { return m_referenceType; }
     void setReferenceType(ReferenceType r) { m_referenceType = r; }
 
-    int indirections() const
-    {
-        return m_indirections;
-    }
+    Indirections indirectionsV() const { return m_indirections; }
+    void setIndirectionsV(const Indirections &i) { m_indirections = i; }
+    void addIndirection(Indirection i) { m_indirections.append(i); }
+
+    // "Legacy", rename?
+    int indirections() const { return m_indirections.size(); }
 
     void setIndirections(int indirections)
     {
-        m_indirections = indirections;
+        m_indirections = Indirections(indirections, Indirection::Pointer);
     }
 
     bool isFunctionPointer() const
@@ -197,6 +201,8 @@ public:
     void formatDebug(QDebug &d) const;
 #endif
 
+    static QString indirectionKeyword(Indirection i);
+
 private:
     static TypeInfo resolveType(CodeModelItem item, TypeInfo const &__type, CodeModelItem __scope);
 
@@ -204,6 +210,7 @@ private:
     QStringList m_arrayElements;
     QVector<TypeInfo> m_arguments;
     QVector<TypeInfo> m_instantiations;
+    Indirections m_indirections;
 
     union {
         uint flags;
@@ -212,8 +219,7 @@ private:
             uint m_constant: 1;
             uint m_volatile: 1;
             uint m_functionPointer: 1;
-            uint m_indirections: 6;
-            uint m_padding: 23;
+            uint m_padding: 29;
         };
     };
 
diff --git a/sources/shiboken2/ApiExtractor/parser/codemodel_enums.h b/sources/shiboken2/ApiExtractor/parser/codemodel_enums.h
index b8a10ba93..9a3cc0e07 100644
--- a/sources/shiboken2/ApiExtractor/parser/codemodel_enums.h
+++ b/sources/shiboken2/ApiExtractor/parser/codemodel_enums.h
@@ -41,4 +41,10 @@ enum EnumKind {
     EnumClass      // C++ 11    : enum class Foo { value1, value2 }
 };
 
+enum class Indirection
+{
+    Pointer, // int *
+    ConstPointer // int *const
+};
+
 #endif // CODEMODEL_ENUMS_H
diff --git a/sources/shiboken2/ApiExtractor/typeparser.cpp b/sources/shiboken2/ApiExtractor/typeparser.cpp
index 919da5471..11f04d079 100644
--- a/sources/shiboken2/ApiExtractor/typeparser.cpp
+++ b/sources/shiboken2/ApiExtractor/typeparser.cpp
@@ -167,6 +167,7 @@ TypeInfo TypeParser::parse(const QString &str, QString *errorMessage)
     bool colon_prefix = false;
     bool in_array = false;
     QString array;
+    bool seenStar = false;
 
     Scanner::Token tok = scanner.nextToken(errorMessage);
     while (tok != Scanner::NoToken) {
@@ -191,7 +192,8 @@ TypeInfo TypeParser::parse(const QString &str, QString *errorMessage)
         switch (tok) {
 
         case Scanner::StarToken:
-            ++stack.top()->m_indirections;
+            seenStar = true;
+            stack.top()->addIndirection(Indirection::Pointer);
             break;
 
         case Scanner::AmpersandToken:
@@ -231,7 +233,12 @@ TypeInfo TypeParser::parse(const QString &str, QString *errorMessage)
             break;
 
         case Scanner::ConstToken:
-            stack.top()->m_constant = true;
+            if (seenStar) { // "int *const": Last indirection is const.
+                Q_ASSERT(!stack.top()->m_indirections.isEmpty());
+                *stack.top()->m_indirections.rbegin() = Indirection::ConstPointer;
+            } else {
+                stack.top()->m_constant = true;
+            }
             break;
 
         case Scanner::OpenParenToken: // function pointers not supported
diff --git a/sources/shiboken2/generator/shiboken2/shibokengenerator.cpp b/sources/shiboken2/generator/shiboken2/shibokengenerator.cpp
index 50368574a..490e71ec9 100644
--- a/sources/shiboken2/generator/shiboken2/shibokengenerator.cpp
+++ b/sources/shiboken2/generator/shiboken2/shibokengenerator.cpp
@@ -2299,7 +2299,7 @@ AbstractMetaType* ShibokenGenerator::buildAbstractMetaTypeFromTypeEntry(const Ty
         return m_metaTypeFromStringCache.value(typeName);
     AbstractMetaType* metaType = new AbstractMetaType;
     metaType->setTypeEntry(typeEntry);
-    metaType->setIndirections(0);
+    metaType->clearIndirections();
     metaType->setReferenceType(NoReference);
     metaType->setConstant(false);
     metaType->decideUsagePattern();