Add some test for number protocol functions

Add a basic complex number based on std::complex
with some number protocols (note the name Complex
is already taken by a primitive type in libsample).

Pick-to: 6.5
Task-number: PYSIDE-2446
Change-Id: Ie1427761c0048f57a02bc8d59c3181567ce3a199
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>

8 files changed, 151 insertions, 0 deletions

diff --git a/sources/shiboken6/tests/libsample/CMakeLists.txt b/sources/shiboken6/tests/libsample/CMakeLists.txt
index 553384547..926972340 100644
--- a/sources/shiboken6/tests/libsample/CMakeLists.txt
+++ b/sources/shiboken6/tests/libsample/CMakeLists.txt
@@ -64,6 +64,7 @@ renaming.cpp renaming.h
 sample.cpp sample.h
 samplenamespace.cpp samplenamespace.h
 sbkdate.cpp sbkdate.h
+stdcomplex.cpp stdcomplex.h
 simplefile.cpp simplefile.h
 size.cpp size.h
 snakecasetest.cpp snakecasetest.h
diff --git a/sources/shiboken6/tests/libsample/stdcomplex.cpp b/sources/shiboken6/tests/libsample/stdcomplex.cpp
new file mode 100644
index 000000000..2969d2ed7
--- /dev/null
+++ b/sources/shiboken6/tests/libsample/stdcomplex.cpp
@@ -0,0 +1,22 @@
+// Copyright (C) 2023 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
+
+#include "stdcomplex.h"
+
+#include <iostream>
+
+StdComplex::StdComplex() noexcept = default;
+
+StdComplex::StdComplex(double re, double img) noexcept : m_impl(re, img)
+{
+}
+
+StdComplex::StdComplex(const Impl &impl) noexcept : m_impl(impl)
+{
+}
+
+std::ostream &operator<<(std::ostream &str, const StdComplex &c)
+{
+    str << "Complex(" << c.real() << ", " << c.imag() << ')';
+    return str;
+}
diff --git a/sources/shiboken6/tests/libsample/stdcomplex.h b/sources/shiboken6/tests/libsample/stdcomplex.h
new file mode 100644
index 000000000..67a0763b7
--- /dev/null
+++ b/sources/shiboken6/tests/libsample/stdcomplex.h
@@ -0,0 +1,50 @@
+// Copyright (C) 2023 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
+
+#ifndef STDCOMPLEX_H
+#define STDCOMPLEX_H
+
+#include "libsamplemacros.h"
+
+#include <complex>
+#include <iosfwd>
+
+// A complex number based on std::complex for exercising esoteric number
+// protocols (Py_nb_). For standard number protocols, see Point.
+
+class LIBSAMPLE_API StdComplex
+{
+    using Impl = std::complex<double>;
+
+public:
+    StdComplex() noexcept;
+    explicit StdComplex(double re, double img) noexcept;
+
+    double real() const { return m_impl.real(); }
+    double imag() const { return m_impl.imag(); }
+
+    double abs_value() const { return std::abs(m_impl); } // abs() is reserved Python word
+
+    friend inline bool operator==(const StdComplex &c1, const StdComplex &c2) noexcept
+    { return c1.m_impl == c2.m_impl; }
+    friend inline bool operator!=(const StdComplex &c1, const StdComplex &c2) noexcept
+    { return c1.m_impl != c2.m_impl; }
+
+    friend inline StdComplex operator+(const StdComplex &c1, const StdComplex &c2) noexcept
+    { return StdComplex(c1.m_impl + c2.m_impl); }
+    friend inline StdComplex operator-(const StdComplex &c1, const StdComplex &c2) noexcept
+    { return StdComplex(c1.m_impl - c2.m_impl); }
+    friend inline StdComplex operator*(const StdComplex &c1, const StdComplex &c2) noexcept
+    { return StdComplex(c1.m_impl * c2.m_impl); }
+    friend inline StdComplex operator/(const StdComplex &c1, const StdComplex &c2) noexcept
+    { return StdComplex(c1.m_impl / c2.m_impl); }
+
+private:
+    explicit StdComplex(const Impl &impl) noexcept;
+
+    Impl m_impl;
+};
+
+std::ostream &operator<<(std::ostream &str, const StdComplex &c);
+
+#endif // STDCOMPLEX_H
diff --git a/sources/shiboken6/tests/samplebinding/CMakeLists.txt b/sources/shiboken6/tests/samplebinding/CMakeLists.txt
index dff3fff62..fc812feb8 100644
--- a/sources/shiboken6/tests/samplebinding/CMakeLists.txt
+++ b/sources/shiboken6/tests/samplebinding/CMakeLists.txt
@@ -116,6 +116,7 @@ ${CMAKE_CURRENT_BINARY_DIR}/sample/samplenamespace_someclass_someinnerclass_wrap
 ${CMAKE_CURRENT_BINARY_DIR}/sample/samplenamespace_someclass_someotherinnerclass_wrapper.cpp
 ${CMAKE_CURRENT_BINARY_DIR}/sample/samplenamespace_someclass_wrapper.cpp
 ${CMAKE_CURRENT_BINARY_DIR}/sample/samplenamespace_derivedfromnamespace_wrapper.cpp
+${CMAKE_CURRENT_BINARY_DIR}/sample/stdcomplex_wrapper.cpp
 ${CMAKE_CURRENT_BINARY_DIR}/sample/simplefile_wrapper.cpp
 ${CMAKE_CURRENT_BINARY_DIR}/sample/size_wrapper.cpp
 ${CMAKE_CURRENT_BINARY_DIR}/sample/sizef_wrapper.cpp
diff --git a/sources/shiboken6/tests/samplebinding/global.h b/sources/shiboken6/tests/samplebinding/global.h
index f73fdd503..64806417a 100644
--- a/sources/shiboken6/tests/samplebinding/global.h
+++ b/sources/shiboken6/tests/samplebinding/global.h
@@ -56,6 +56,7 @@
 #include "removednamespaces.h"
 #include "sample.h"
 #include "samplenamespace.h"
+#include "stdcomplex.h"
 #include "simplefile.h"
 #include "size.h"
 #include "snakecasetest.h"
diff --git a/sources/shiboken6/tests/samplebinding/samplesnippets.cpp b/sources/shiboken6/tests/samplebinding/samplesnippets.cpp
index 12ff7fc1d..c55950052 100644
--- a/sources/shiboken6/tests/samplebinding/samplesnippets.cpp
+++ b/sources/shiboken6/tests/samplebinding/samplesnippets.cpp
@@ -18,3 +18,11 @@ static PyObject *Sbk_IntWrapper_add_ints(PyObject * /* self */, PyObject *args)
 }
 }
 // @snippet intwrapper_add_ints
+
+// @snippet stdcomplex_floor
+%PYARG_0 = PyFloat_FromDouble(std::floor(%CPPSELF.abs_value()));
+// @snippet stdcomplex_floor
+
+// @snippet stdcomplex_ceil
+%PYARG_0 = PyFloat_FromDouble(std::ceil(%CPPSELF.abs_value()));
+// @snippet stdcomplex_ceil
diff --git a/sources/shiboken6/tests/samplebinding/stdcomplex_test.py b/sources/shiboken6/tests/samplebinding/stdcomplex_test.py
new file mode 100644
index 000000000..5e1223636
--- /dev/null
+++ b/sources/shiboken6/tests/samplebinding/stdcomplex_test.py
@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+# Copyright (C) 2023 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
+
+'''Test cases for StdComplex class'''
+
+import os
+import math
+import sys
+import unittest
+
+from pathlib import Path
+sys.path.append(os.fspath(Path(__file__).resolve().parents[1]))
+from shiboken_paths import init_paths
+init_paths()
+
+from sample import StdComplex
+
+
+REAL = 5.0
+IMAG = 2.3
+
+
+class StdComplexTest(unittest.TestCase):
+    '''Test case for StdComplex class, exercising esoteric number
+       protocols (Py_nb_). For standard number protocols, see Point.'''
+
+    def testFloor(self):
+        pt = StdComplex(REAL, IMAG)
+        self.assertEqual(math.floor(pt), math.floor(pt.abs_value()))
+
+    def testCeil(self):
+        pt = StdComplex(REAL, IMAG)
+        self.assertEqual(math.ceil(pt), math.ceil(pt.abs_value()))
+
+    def testPlusOperator(self):
+        '''Test StdComplex class + operator.'''
+        pt1 = StdComplex(REAL, IMAG)
+        pt2 = StdComplex(0.5, 3.2)
+        self.assertEqual(pt1 + pt2, StdComplex(REAL + 0.5, IMAG + 3.2))
+
+    def testEqualOperator(self):
+        '''Test StdComplex class == operator.'''
+        pt1 = StdComplex(REAL, IMAG)
+        pt2 = StdComplex(REAL, IMAG)
+        pt3 = StdComplex(0.5, 3.2)
+        self.assertTrue(pt1 == pt1)
+        self.assertTrue(pt1 == pt2)
+        self.assertFalse(pt1 == pt3)
+
+
+if __name__ == '__main__':
+    unittest.main()
diff --git a/sources/shiboken6/tests/samplebinding/typesystem_sample.xml b/sources/shiboken6/tests/samplebinding/typesystem_sample.xml
index abc3c9949..81bb814e9 100644
--- a/sources/shiboken6/tests/samplebinding/typesystem_sample.xml
+++ b/sources/shiboken6/tests/samplebinding/typesystem_sample.xml
@@ -2401,6 +2401,21 @@
 
     <object-type name="ObjectTypeByValue" />
 
+    <value-type name="StdComplex">
+        <extra-includes>
+            <include file-name="cmath" location="global"/>
+        </extra-includes>
+        <!-- PYSIDE-2446: number protocols without a Py_nb_ constant. -->
+        <add-function signature="__floor__()" return-type="double">
+            <inject-code class="target" position="end"
+                         file="samplesnippets.cpp" snippet="stdcomplex_floor"/>
+        </add-function>
+        <add-function signature="__ceil__()" return-type="double">
+            <inject-code class="target" position="end"
+                         file="samplesnippets.cpp" snippet="stdcomplex_ceil"/>
+        </add-function>
+    </value-type>
+
     <object-type name="TemplatePtr">
         <modify-function signature="dummy(std::list&lt;std::pair&lt;BlackBox *, BlackBox *&gt; &gt; &amp;)" rename="dummy_method" />
     </object-type>