From f595aa5d9d45bc772d2e9aea24f44dc5d43c45be Mon Sep 17 00:00:00 2001
From: Friedemann Kleint <Friedemann.Kleint@qt.io>
Date: Thu, 18 Oct 2018 13:03:24 +0200
Subject: Add snippet extraction to shiboken

Add a snippet attribute to inject-code and conversion-rule
instructing shiboken to extract code from a source file using
annotations.

Task-number: PYSIDE-834
Change-Id: I576c4a48fe68e9d26fe46e324af5baa88a5c1d34
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: Christian Tismer <tismer@stackless.com>
---
 sources/shiboken2/ApiExtractor/typesystem.cpp | 38 +++++++++++++++++++++++++--
 1 file changed, 36 insertions(+), 2 deletions(-)

(limited to 'sources/shiboken2/ApiExtractor/typesystem.cpp')

diff --git a/sources/shiboken2/ApiExtractor/typesystem.cpp b/sources/shiboken2/ApiExtractor/typesystem.cpp
index 21c35bda6..2c7f5eeaa 100644
--- a/sources/shiboken2/ApiExtractor/typesystem.cpp
+++ b/sources/shiboken2/ApiExtractor/typesystem.cpp
@@ -90,6 +90,7 @@ static inline QString writeAttribute() { return QStringLiteral("write"); }
 static inline QString replaceAttribute() { return QStringLiteral("replace"); }
 static inline QString toAttribute() { return QStringLiteral("to"); }
 static inline QString signatureAttribute() { return QStringLiteral("signature"); }
+static inline QString snippetAttribute() { return QStringLiteral("snippet"); }
 static inline QString staticAttribute() { return QStringLiteral("static"); }
 static inline QString threadAttribute() { return QStringLiteral("thread"); }
 static inline QString sourceAttribute() { return QStringLiteral("source"); }
@@ -128,6 +129,31 @@ static bool setRejectionRegularExpression(const QString &patternIn,
     return true;
 }
 
+// Extract a snippet from a file within annotation "// @snippet label".
+static QString extractSnippet(const QString &code, const QString &snippetLabel)
+{
+    if (snippetLabel.isEmpty())
+        return code;
+    const QString pattern = QStringLiteral(R"(^\s*//\s*@snippet\s+)")
+        + QRegularExpression::escape(snippetLabel)
+        + QStringLiteral(R"(\s*$)");
+    const QRegularExpression snippetRe(pattern);
+    Q_ASSERT(snippetRe.isValid());
+
+    bool useLine = false;
+    QString result;
+    const auto lines = code.splitRef(QLatin1Char('\n'));
+    for (const QStringRef &line : lines) {
+        if (snippetRe.match(line).hasMatch()) {
+            useLine = !useLine;
+            if (!useLine)
+                break; // End of snippet reached
+        } else if (useLine)
+            result += line.toString() + QLatin1Char('\n');
+    }
+    return result;
+}
+
 template <class EnumType, Qt::CaseSensitivity cs = Qt::CaseInsensitive>
 struct EnumLookup
 {
@@ -1546,6 +1572,7 @@ bool Handler::parseCustomConversion(const QXmlStreamReader &,
     }
 
     QString sourceFile;
+    QString snippetLabel;
     TypeSystem::Language lang = TypeSystem::NativeCode;
     for (int i = attributes->size() - 1; i >= 0; --i) {
         const QStringRef name = attributes->at(i).qualifiedName();
@@ -1558,6 +1585,8 @@ bool Handler::parseCustomConversion(const QXmlStreamReader &,
             }
         } else if (name == QLatin1String("file")) {
             sourceFile = attributes->takeAt(i).value().toString();
+        } else if (name == snippetAttribute()) {
+            snippetLabel = attributes->takeAt(i).value().toString();
         }
     }
 
@@ -1585,7 +1614,9 @@ bool Handler::parseCustomConversion(const QXmlStreamReader &,
 
             QFile conversionSource(sourceFile);
             if (conversionSource.open(QIODevice::ReadOnly | QIODevice::Text)) {
-                topElement.entry->setConversionRule(QLatin1String(conversionFlag) + QString::fromUtf8(conversionSource.readAll()));
+                const QString conversionRule =
+                    extractSnippet(QString::fromUtf8(conversionSource.readAll()), snippetLabel);
+                topElement.entry->setConversionRule(QLatin1String(conversionFlag) + conversionRule);
             } else {
                 qCWarning(lcShiboken).noquote().nospace()
                     << "File containing conversion code for "
@@ -2197,6 +2228,7 @@ bool Handler::parseInjectCode(const QXmlStreamReader &,
     TypeSystem::CodeSnipPosition position = TypeSystem::CodeSnipPositionBeginning;
     TypeSystem::Language lang = TypeSystem::TargetLangCode;
     QString fileName;
+    QString snippetLabel;
     for (int i = attributes->size() - 1; i >= 0; --i) {
         const QStringRef name = attributes->at(i).qualifiedName();
         if (name == classAttribute()) {
@@ -2215,6 +2247,8 @@ bool Handler::parseInjectCode(const QXmlStreamReader &,
             }
         } else if (name == QLatin1String("file")) {
             fileName = attributes->takeAt(i).value().toString();
+        } else if (name == snippetAttribute()) {
+            snippetLabel = attributes->takeAt(i).value().toString();
         }
     }
 
@@ -2235,7 +2269,7 @@ bool Handler::parseInjectCode(const QXmlStreamReader &,
                                                 "// START of custom code block [file: ");
                 content += fileName;
                 content += QLatin1String("]\n");
-                content += QString::fromUtf8(codeFile.readAll());
+                content += extractSnippet(QString::fromUtf8(codeFile.readAll()), snippetLabel);
                 content += QLatin1String("\n// END of custom code block [file: ");
                 content += fileName;
                 content += QLatin1String("]\n// ========================================================================\n");
-- 
cgit v1.2.3