[sipify] Add support for abstract classes

qgis · Apr 7, 2017 · cfeab26 · nyalldawson · Apr 7, 2017 · m-kuhn
1 parent cd3528a
commit cfeab26
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 3 deletions.
diff --git a/cmake_templates/Doxyfile.in b/cmake_templates/Doxyfile.in
@@ -1363,7 +1363,8 @@ EXPAND_AS_DEFINED      = "SIP_TRANSFER" \
                          "SIP_CONVERT_TO_SUBCLASS_CODE" \
                          "SIP_FEATURE" \
                          "SIP_IF_FEATURE" \
-                         "SIP_END"
+                         "SIP_END" \
+                         "SIP_ABSTRACT"
 
 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
 # doxygen's preprocessor will remove all function-like macros that are alone

diff --git a/scripts/sipify.pl b/scripts/sipify.pl
@@ -227,7 +227,7 @@ sub processDoxygenLine
     }
 
     # class declaration started
-    if ( $line =~ m/^(\s*class)\s*([A-Z]+_EXPORT)?\s+(\w+)(\s*\:.*)?$/ ){
+    if ( $line =~ m/^(\s*class)\s*([A-Z]+_EXPORT)?\s+(\w+)(\s*\:.*)?(\s*SIP_ABSTRACT)?$/ ){
         do {no warnings 'uninitialized';
             $classname = $3;
             $line =~ m/\b[A-Z]+_EXPORT\b/ or die "Class$classname in $headerfile should be exported with appropriate [LIB]_EXPORT macro. If this should not be available in python, wrap it in a `#ifndef SIP_RUN` block.";
@@ -241,6 +241,9 @@ sub processDoxygenLine
             $m =~ s/(\s*:)?\s*$//;
             $line .= $m;
         }
+        if ($5) {
+            $line .= ' /Abstract/';
+        }
 
         $line .= "\n{\n";
         if ( $comment !~ m/^\s*$/ ){

diff --git a/src/core/qgis.h b/src/core/qgis.h
@@ -472,3 +472,8 @@ typedef unsigned long long qgssize;
  * Will insert a `%End` directive in sip files
  */
 #define SIP_END
+
+/*
+ * Class level annotation for abstract classes
+ */
+#define SIP_ABSTRACT
diff --git a/tests/scripts/sipifyheader.expected.sip b/tests/scripts/sipifyheader.expected.sip
@@ -201,8 +201,20 @@ A constructor with definition in header on several lines
 
 }
 
-QFlags<QgsSipifyHeader::MyEnum> operator|(QgsSipifyHeader::MyEnum f1, QFlags<QgsSipifyHeader::MyEnum> f2);
+class AbstractClass /Abstract/
+{
+%Docstring
+ Documentation goes here
+%End
 
+%TypeHeaderCode
+#include "sipifyheader.h"
+%End
+  public:
+    explicit AbstractClass();
+%Docstring
+A constructor
+%End
 
 /************************************************************************
  * This file has been generated automatically from                      *

diff --git a/tests/scripts/sipifyheader.h b/tests/scripts/sipifyheader.h
@@ -259,6 +259,28 @@ class CORE_EXPORT ClassWithPrivateInheritanceOnly : private QgsBaseClass
 
 }
 
+/**
+ * \class AbstractClass
+ * \ingroup core
+ * Documentation goes here
+ */
+class CORE_EXPORT AbstractClass SIP_ABSTRACT
+{
+  public:
+    //! A constructor
+    explicit AbstractClass()
+    {
+    }
+
+  private:
+
+    /**
+     * This method should be overridden by subclasses but not exposed to the public
+     * or protected API.
+     */
+    virtual QString reason() = 0;
+}
+
 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsSipifyHeader::Flags )