Speed: Avoid some repeated string constant initialization

This patch introduces a basic concept to avoid the repetition of
string constant creation in Python by using helper functions
returning static instances.

There is currently no real shiboken finalization, so we postpone
finalization until shiboken has one:

- call the finalize_strings() function
- build finalization for other stuff (all signatures etc)

Initial-patch-by: Christian Tismer <tismer@stackless.com>
Task-number: PYSIDE-1087
Change-Id: If3483ba91f719ee0472eb53583460ba35163bc9d
Reviewed-by: Christian Tismer <tismer@stackless.com>

1 files changed, 65 insertions, 59 deletions

diff --git a/sources/shiboken2/libshiboken/signature.cpp b/sources/shiboken2/libshiboken/signature.cpp
index 746b026c4..5430ab064 100644
--- a/sources/shiboken2/libshiboken/signature.cpp
+++ b/sources/shiboken2/libshiboken/signature.cpp
@@ -39,6 +39,8 @@
 
 #include "basewrapper.h"
 #include "autodecref.h"
+#include "sbkstaticstrings.h"
+#include "sbkstaticstrings_p.h"
 
 extern "C"
 {
@@ -51,11 +53,11 @@ extern "C"
 
 // These constants were needed in former versions of the module:
 #define PYTHON_HAS_QUALNAME             (PY_VERSION_HEX >= 0x03030000)
-#define PYTHON_HAS_UNICODE              (PY_VERSION_HEX >= 0x03000000)
 #define PYTHON_HAS_WEAKREF_PYCFUNCTION  (PY_VERSION_HEX >= 0x030500A0)
 #define PYTHON_IS_PYTHON3               (PY_VERSION_HEX >= 0x03000000)
 #define PYTHON_HAS_KEYWORDONLY          (PYTHON_IS_PYTHON3)
 #define PYTHON_USES_PERCENT_V_FORMAT    (PYTHON_IS_PYTHON3)
+#define PYTHON_USES_D_COMMON            (PY_VERSION_HEX >= 0x03020000)
 #define PYTHON_HAS_DESCR_REDUCE         (PY_VERSION_HEX >= 0x03040000)
 #define PYTHON_HAS_METH_REDUCE          (PYTHON_HAS_DESCR_REDUCE)
 #define PYTHON_NEEDS_ITERATOR_FLAG      (!PYTHON_IS_PYTHON3)
@@ -64,7 +66,7 @@ extern "C"
 #define PYTHON_HAS_INT_AND_LONG         (!PYTHON_IS_PYTHON3)
 
 // These constants are still in use:
-#define PYTHON_USES_D_COMMON            (PY_VERSION_HEX >= 0x03020000)
+#define PYTHON_USES_UNICODE             (PY_VERSION_HEX >= 0x03000000)
 
 typedef struct safe_globals_struc {
     // init part 1: get arg_dict
@@ -84,11 +86,11 @@ static safe_globals pyside_globals = nullptr;
 
 static PyObject *GetTypeKey(PyObject *ob);
 
-static PyObject *GetSignature_Function(PyObject *, const char *);
-static PyObject *GetSignature_TypeMod(PyObject *, const char *);
-static PyObject *GetSignature_Wrapper(PyObject *, const char *);
+static PyObject *GetSignature_Function(PyObject *, PyObject *);
+static PyObject *GetSignature_TypeMod(PyObject *, PyObject *);
+static PyObject *GetSignature_Wrapper(PyObject *, PyObject *);
 static PyObject *get_signature(PyObject *self, PyObject *args);
-static PyObject *get_signature_intern(PyObject *ob, const char *modifier);
+static PyObject *get_signature_intern(PyObject *ob, PyObject *modifier);
 
 static PyObject *PySide_BuildSignatureProps(PyObject *class_mod);
 
@@ -108,10 +110,10 @@ CreateSignature(PyObject *props, PyObject *key)
                                  const_cast<char *>("(OO)"), props, key);
 }
 
-typedef PyObject *(*signaturefunc)(PyObject *, const char *);
+typedef PyObject *(*signaturefunc)(PyObject *, PyObject *);
 
 static PyObject *
-_get_written_signature(signaturefunc sf, PyObject *ob, const char *modifier)
+_get_written_signature(signaturefunc sf, PyObject *ob, PyObject *modifier)
 {
     /*
      * Be a writable Attribute, but have a computed value.
@@ -134,19 +136,19 @@ _get_written_signature(signaturefunc sf, PyObject *ob, const char *modifier)
 }
 
 static PyObject *
-pyside_cf_get___signature__(PyObject *func, const char *modifier)
+pyside_cf_get___signature__(PyObject *func, PyObject *modifier)
 {
     init_module_2();
     return _get_written_signature(GetSignature_Function, func, modifier);
 }
 
 static PyObject *
-pyside_sm_get___signature__(PyObject *sm, const char *modifier)
+pyside_sm_get___signature__(PyObject *sm, PyObject *modifier)
 {
     init_module_2();
-    Shiboken::AutoDecRef func(PyObject_GetAttrString(sm, "__func__"));
+    Shiboken::AutoDecRef func(PyObject_GetAttr(sm, Shiboken::PyMagicName::func()));
     if (Py_TYPE(func) == PepFunction_TypePtr)
-        return PyObject_GetAttrString(func, "__signature__");
+        return PyObject_GetAttr(func, Shiboken::PyMagicName::signature());
     return _get_written_signature(GetSignature_Function, func, modifier);
 }
 
@@ -158,7 +160,7 @@ _get_class_of_cf(PyObject *ob_cf)
         selftype = PyDict_GetItem(pyside_globals->map_dict, ob_cf);
         if (selftype == nullptr) {
             // This must be an overloaded function that we handled special.
-            Shiboken::AutoDecRef special(Py_BuildValue("(Os)", ob_cf, "overload"));
+            Shiboken::AutoDecRef special(Py_BuildValue("(OO)", ob_cf, Shiboken::PyName::overload()));
             selftype = PyDict_GetItem(pyside_globals->map_dict, special);
             if (selftype == nullptr) {
                 // This is probably a module function. We will return type(None).
@@ -176,15 +178,15 @@ _get_class_of_cf(PyObject *ob_cf)
 static PyObject *
 _get_class_of_sm(PyObject *ob_sm)
 {
-    Shiboken::AutoDecRef func(PyObject_GetAttrString(ob_sm, "__func__"));
+    Shiboken::AutoDecRef func(PyObject_GetAttr(ob_sm, Shiboken::PyMagicName::func()));
     return _get_class_of_cf(func);
 }
 
 static PyObject *
 _get_class_of_descr(PyObject *ob)
 {
-    Shiboken::AutoDecRef func_name(PyObject_GetAttrString(ob, "__name__"));
-    return PyObject_GetAttrString(ob, "__objclass__");
+    Shiboken::AutoDecRef func_name(PyObject_GetAttr(ob, Shiboken::PyMagicName::name()));
+    return PyObject_GetAttr(ob, Shiboken::PyMagicName::objclass());
 }
 
 static PyObject *
@@ -216,10 +218,10 @@ get_funcname(PyObject *ob)
 {
     PyObject *func = ob;
     if (Py_TYPE(ob) == PepStaticMethod_TypePtr)
-        func = PyObject_GetAttrString(ob, "__func__");
+        func = PyObject_GetAttr(ob, Shiboken::PyMagicName::func());
     else
         Py_INCREF(func);
-    PyObject *func_name = PyObject_GetAttrString(func, "__name__");
+    PyObject *func_name = PyObject_GetAttr(func, Shiboken::PyMagicName::name());
     Py_DECREF(func);
     if (func_name == nullptr)
         Py_FatalError("unexpected name problem in compute_name_key");
@@ -287,7 +289,7 @@ name_key_to_func(PyObject *ob)
 }
 
 static PyObject *
-pyside_md_get___signature__(PyObject *ob_md, const char *modifier)
+pyside_md_get___signature__(PyObject *ob_md, PyObject *modifier)
 {
     init_module_2();
     Shiboken::AutoDecRef func(name_key_to_func(ob_md));
@@ -299,14 +301,14 @@ pyside_md_get___signature__(PyObject *ob_md, const char *modifier)
 }
 
 static PyObject *
-pyside_wd_get___signature__(PyObject *ob, const char *modifier)
+pyside_wd_get___signature__(PyObject *ob, PyObject *modifier)
 {
     init_module_2();
     return _get_written_signature(GetSignature_Wrapper, ob, modifier);
 }
 
 static PyObject *
-pyside_tp_get___signature__(PyObject *obtype_mod, const char *modifier)
+pyside_tp_get___signature__(PyObject *obtype_mod, PyObject *modifier)
 {
     init_module_2();
     return _get_written_signature(GetSignature_TypeMod, obtype_mod, modifier);
@@ -314,7 +316,7 @@ pyside_tp_get___signature__(PyObject *obtype_mod, const char *modifier)
 
 // forward
 static PyObject *
-GetSignature_Cached(PyObject *props, const char *func_kind, const char *modifier);
+GetSignature_Cached(PyObject *props, PyObject *func_kind, PyObject *modifier);
 
 static PyObject *
 GetTypeKey(PyObject *ob)
@@ -332,8 +334,8 @@ GetTypeKey(PyObject *ob)
      *
      * This is the PyCFunction behavior, as opposed to Python functions.
      */
-    Shiboken::AutoDecRef class_name(PyObject_GetAttrString(ob, "__name__"));
-    Shiboken::AutoDecRef module_name(PyObject_GetAttrString(ob, "__module__"));
+    Shiboken::AutoDecRef class_name(PyObject_GetAttr(ob, Shiboken::PyMagicName::name()));
+    Shiboken::AutoDecRef module_name(PyObject_GetAttr(ob, Shiboken::PyMagicName::module()));
 
     if (module_name.isNull())
         PyErr_Clear();
@@ -364,7 +366,7 @@ TypeKey_to_PropsDict(PyObject *type_key, PyObject *obtype)
 }
 
 static PyObject *
-GetSignature_Function(PyObject *obfunc, const char *modifier)
+GetSignature_Function(PyObject *obfunc, PyObject *modifier)
 {
     // make sure that we look into PyCFunction, only...
     if (Py_TYPE(obfunc) == PepFunction_TypePtr)
@@ -376,29 +378,29 @@ GetSignature_Function(PyObject *obfunc, const char *modifier)
     PyObject *dict = TypeKey_to_PropsDict(type_key, obtype_mod);
     if (dict == nullptr)
         return nullptr;
-    Shiboken::AutoDecRef func_name(PyObject_GetAttrString(obfunc, "__name__"));
+    Shiboken::AutoDecRef func_name(PyObject_GetAttr(obfunc, Shiboken::PyMagicName::name()));
     PyObject *props = !func_name.isNull() ? PyDict_GetItem(dict, func_name) : nullptr;
     if (props == nullptr)
         Py_RETURN_NONE;
 
     int flags = PyCFunction_GET_FLAGS(obfunc);
-    const char *func_kind;
+    PyObject *func_kind;
     if (PyModule_Check(obtype_mod))
-        func_kind = "function";
+        func_kind = Shiboken::PyName::function();
     else if (flags & METH_CLASS)
-        func_kind = "classmethod";
+        func_kind = Shiboken::PyName::classmethod();
     else if (flags & METH_STATIC)
-        func_kind = "staticmethod";
+        func_kind = Shiboken::PyName::staticmethod();
     else
-        func_kind = "method";
+        func_kind = Shiboken::PyName::method();
     return GetSignature_Cached(props, func_kind, modifier);
 }
 
 static PyObject *
-GetSignature_Wrapper(PyObject *ob, const char *modifier)
+GetSignature_Wrapper(PyObject *ob, PyObject *modifier)
 {
-    Shiboken::AutoDecRef func_name(PyObject_GetAttrString(ob, "__name__"));
-    Shiboken::AutoDecRef objclass(PyObject_GetAttrString(ob, "__objclass__"));
+    Shiboken::AutoDecRef func_name(PyObject_GetAttr(ob, Shiboken::PyMagicName::name()));
+    Shiboken::AutoDecRef objclass(PyObject_GetAttr(ob, Shiboken::PyMagicName::objclass()));
     Shiboken::AutoDecRef class_key(GetTypeKey(objclass));
 
     if (func_name.isNull() || objclass.isNull() || class_key.isNull())
@@ -409,13 +411,13 @@ GetSignature_Wrapper(PyObject *ob, const char *modifier)
     PyObject *props = PyDict_GetItem(dict, func_name);
     if (props == nullptr)
         Py_RETURN_NONE;
-    return GetSignature_Cached(props, "method", modifier);
+    return GetSignature_Cached(props, Shiboken::PyName::method(), modifier);
 }
 
 static PyObject *
-GetSignature_TypeMod(PyObject *ob, const char *modifier)
+GetSignature_TypeMod(PyObject *ob, PyObject *modifier)
 {
-    Shiboken::AutoDecRef ob_name(PyObject_GetAttrString(ob, "__name__"));
+    Shiboken::AutoDecRef ob_name(PyObject_GetAttr(ob, Shiboken::PyMagicName::name()));
     Shiboken::AutoDecRef ob_key(GetTypeKey(ob));
 
     PyObject *dict = TypeKey_to_PropsDict(ob_key, ob);
@@ -424,19 +426,26 @@ GetSignature_TypeMod(PyObject *ob, const char *modifier)
     PyObject *props = PyDict_GetItem(dict, ob_name);
     if (props == nullptr)
         Py_RETURN_NONE;
-    return GetSignature_Cached(props, "method", modifier);
+    return GetSignature_Cached(props, Shiboken::PyName::method(), modifier);
 }
 
 static PyObject *
-GetSignature_Cached(PyObject *props, const char *func_kind, const char *modifier)
+GetSignature_Cached(PyObject *props, PyObject *func_kind, PyObject *modifier)
 {
     // Special case: We want to know the func_kind.
-    if (modifier && strcmp(modifier, "__func_kind__") == 0)
-        return Py_BuildValue("s", func_kind);
+    if (modifier) {
+#if PYTHON_USES_UNICODE
+        PyUnicode_InternInPlace(&modifier);
+#else
+        PyString_InternInPlace(&modifier);
+#endif
+        if (modifier == Shiboken::PyMagicName::func_kind())
+            return Py_BuildValue("O", func_kind);
+    }
 
     Shiboken::AutoDecRef key(modifier == nullptr
-                             ? Py_BuildValue("s", func_kind)
-                             : Py_BuildValue("(ss)", func_kind, modifier));
+                             ? Py_BuildValue("O", func_kind)
+                             : Py_BuildValue("(OO)", func_kind, modifier));
     PyObject *value = PyDict_GetItem(props, key);
     if (value == nullptr) {
         // we need to compute a signature object
@@ -478,13 +487,10 @@ init_phase_1(void)
 #ifdef Py_LIMITED_API
         // We must work for multiple versions, so use source code.
 #else
-        Shiboken::AutoDecRef marshal_str(Py_BuildValue("s", "marshal"));
-        if (marshal_str.isNull())
-            goto error;
-        Shiboken::AutoDecRef marshal_module(PyImport_Import(marshal_str));
+        Shiboken::AutoDecRef marshal_module(PyImport_Import(Shiboken::PyName::marshal()));
         if (marshal_module.isNull())
             goto error;
-        Shiboken::AutoDecRef loads(PyObject_GetAttrString(marshal_module, "loads"));
+        Shiboken::AutoDecRef loads(PyObject_GetAttr(marshal_module, Shiboken::PyName::loads()));
         if (loads.isNull())
             goto error;
 #endif
@@ -496,7 +502,7 @@ init_phase_1(void)
             goto error;
 #ifdef Py_LIMITED_API
         PyObject *builtins = PyEval_GetBuiltins();
-        PyObject *compile = PyDict_GetItemString(builtins, "compile");
+        PyObject *compile = PyDict_GetItem(builtins, Shiboken::PyName::compile());
         if (compile == nullptr)
             goto error;
         Shiboken::AutoDecRef code_obj(PyObject_CallFunction(compile, "Oss",
@@ -513,7 +519,7 @@ init_phase_1(void)
             goto error;
         // Initialize the module
         PyObject *mdict = PyModule_GetDict(p->helper_module);
-        if (PyDict_SetItemString(mdict, "__builtins__", PyEval_GetBuiltins()) < 0)
+        if (PyDict_SetItem(mdict, Shiboken::PyMagicName::builtins(), PyEval_GetBuiltins()) < 0)
             goto error;
         /*
          * Unpack an embedded ZIP file with more signature modules.
@@ -559,7 +565,7 @@ init_phase_1(void)
     }
 error:
     PyErr_Print();
-    PyErr_SetString(PyExc_SystemError, "could not initialize part 1");
+    Py_FatalError("could not initialize part 1");
     return nullptr;
 }
 
@@ -601,11 +607,10 @@ init_phase_2(safe_globals_struc *p, PyMethodDef *methods)
         if (p->finish_import_func == nullptr)
             goto error;
         return 0;
-        return 0;
     }
 error:
     PyErr_Print();
-    PyErr_SetString(PyExc_SystemError, "could not initialize part 2");
+    Py_FatalError("could not initialize part 2");
     return -1;
 }
 
@@ -803,7 +808,7 @@ static PyGetSetDef new_PyWrapperDescr_getsets[] = {
 //
 
 static PyObject *
-get_signature_intern(PyObject *ob, const char *modifier)
+get_signature_intern(PyObject *ob, PyObject *modifier)
 {
     if (PyType_IsSubtype(Py_TYPE(ob), &PyCFunction_Type))
         return pyside_cf_get___signature__(ob, modifier);
@@ -822,11 +827,11 @@ static PyObject *
 get_signature(PyObject * /* self */, PyObject *args)
 {
     PyObject *ob;
-    const char *modifier = nullptr;
+    PyObject *modifier = nullptr;
 
     init_module_1();
 
-    if (!PyArg_ParseTuple(args, "O|s", &ob, &modifier))
+    if (!PyArg_ParseTuple(args, "O|O", &ob, &modifier))
         return nullptr;
     if (Py_TYPE(ob) == PepFunction_TypePtr)
         Py_RETURN_NONE;
@@ -1110,13 +1115,14 @@ _build_func_to_type(PyObject *obtype)
          * "{name}.overload".
          */
         PyObject *descr = PyDict_GetItemString(dict, meth->ml_name);
-        const char *look_attr = meth->ml_flags & METH_STATIC ? "__func__" : "__name__";
+        PyObject *look_attr = meth->ml_flags & METH_STATIC
+            ? Shiboken::PyMagicName::func() : Shiboken::PyMagicName::name();
         int check_name = meth->ml_flags & METH_STATIC ? 0 : 1;
         if (descr == nullptr)
             return -1;
 
         // We first check all methods if one is hidden by something else.
-        Shiboken::AutoDecRef look(PyObject_GetAttrString(descr, look_attr));
+        Shiboken::AutoDecRef look(PyObject_GetAttr(descr, look_attr));
         Shiboken::AutoDecRef given(Py_BuildValue("s", meth->ml_name));
         if (look.isNull()
             || (check_name && PyObject_RichCompareBool(look, given, Py_EQ) != 1)) {
@@ -1223,7 +1229,7 @@ SetError_Argument(PyObject *args, const char *func_name)
  */
 
 PyObject *
-Sbk_TypeGet___signature__(PyObject *ob, const char *modifier)
+Sbk_TypeGet___signature__(PyObject *ob, PyObject *modifier)
 {
     return pyside_tp_get___signature__(ob, modifier);
 }