Script updates

[wxWidgets.git] / wxPython / SWIG / swig.python-docstring.patch

diff --git a/wxPython/SWIG/swig.python-docstring.patch b/wxPython/SWIG/swig.python-docstring.patch
index a6dd0c57c1621b4cd1cd2baf96df748d45a01ced..47aac607abc9f7b528c60166818f5781fc3aad35 100644 (file)
--- a/wxPython/SWIG/swig.python-docstring.patch
+++ b/wxPython/SWIG/swig.python-docstring.patch
@@ -1,15 +1,15 @@
 Index: Source/Modules/python.cxx
 ===================================================================
 RCS file: /cvsroot/SWIG/Source/Modules/python.cxx,v
 Index: Source/Modules/python.cxx
 ===================================================================
 RCS file: /cvsroot/SWIG/Source/Modules/python.cxx,v

-retrieving revision 1.27
-diff -u -r1.27 python.cxx
---- Source/Modules/python.cxx  12 Nov 2003 17:14:00 -0000      1.27
-+++ Source/Modules/python.cxx  19 Nov 2003 06:23:46 -0000
-@@ -315,6 +315,17 @@
-      -noexcept       - No automatic exception handling\n\
-      -noproxy        - Don't generate proxy classes \n\n";
+retrieving revision 1.40
+diff -u -4 -r1.40 python.cxx
+--- Source/Modules/python.cxx  24 Jan 2004 00:25:31 -0000      1.40
++++ Source/Modules/python.cxx  30 Jan 2004 22:22:16 -0000
+@@ -50,8 +50,17 @@
+ static  int       have_constructor;
+ static  int       have_repr;
+ static  String   *real_classname;

  
  

-+

 +/* flags for the make_autodoc function */
 +enum autodoc_t {
 +  AUTODOC_CLASS,
 +/* flags for the make_autodoc function */
 +enum autodoc_t {
 +  AUTODOC_CLASS,


@@ -19,17 +19,19 @@ diff -u -r1.27 python.cxx
 +  AUTODOC_FUNC
 +};
 +
 +  AUTODOC_FUNC
 +};
 +

-+
- class PYTHON : public Language {
- public:
- 
-@@ -662,15 +673,21 @@
+ static const char *usage = (char *)"\
+ Python Options (available with -python)\n\
+      -ldflags        - Print runtime libraries to link with\n\
+      -globals <name> - Set <name> used to access C global variable [default: 'cvar']\n\
+@@ -417,17 +426,23 @@
+    *    functions.

     * ------------------------------------------------------------ */
  
    void emitFunctionShadowHelper(Node *n, File *f_dest, String *name, int kw) {
 -    if ( ! have_addtofunc(n) ) {
     * ------------------------------------------------------------ */
  
    void emitFunctionShadowHelper(Node *n, File *f_dest, String *name, int kw) {
 -    if ( ! have_addtofunc(n) ) {

+-      /* If there is no addtofunc directive then just assign from the extension module */

 +    if ( ! have_addtofunc(n) && ! have_docstring(n) ) {
 +    if ( ! have_addtofunc(n) && ! have_docstring(n) ) {

-       /* If there is no addtofunc directive then just assign from the extension module */
++      /* If there is no addtofunc or docstring directive then just assign from the extension module */

        Printv(f_dest, "\n", name, " = ", module, ".", name, "\n", NIL);
      } else {
        /* Otherwise make a wrapper function to insert the code into */
        Printv(f_dest, "\n", name, " = ", module, ".", name, "\n", NIL);
      } else {
        /* Otherwise make a wrapper function to insert the code into */


@@ -38,7 +40,7 @@ diff -u -r1.27 python.cxx
 -      Printv(f_dest, tab4, addtofunc(n), "\n", NIL);
 -      Printv(f_dest, tab4, "return val\n", NIL);
 +      if ( have_docstring(n) )
 -      Printv(f_dest, tab4, addtofunc(n), "\n", NIL);
 -      Printv(f_dest, tab4, "return val\n", NIL);
 +      if ( have_docstring(n) )

-+        Printv(f_dest, tab4, docstring(n, AUTODOC_FUNC), "\n", NIL);
++        Printv(f_dest, tab4, docstring(n, AUTODOC_FUNC, tab4), "\n", NIL);

 +      if ( have_addtofunc(n) ) {
 +        Printv(f_dest, tab4, "val = ", funcCallHelper(name, kw), "\n", NIL);
 +        Printv(f_dest, tab4, addtofunc(n), "\n", NIL);
 +      if ( have_addtofunc(n) ) {
 +        Printv(f_dest, tab4, "val = ", funcCallHelper(name, kw), "\n", NIL);
 +        Printv(f_dest, tab4, addtofunc(n), "\n", NIL);


@@ -49,7 +51,9 @@ diff -u -r1.27 python.cxx
      }
    }
  
      }
    }
  

-@@ -686,6 +703,193 @@
+ 
+@@ -441,8 +456,248 @@
+   }

  
  
    /* ------------------------------------------------------------
  
  
    /* ------------------------------------------------------------


@@ -67,17 +71,17 @@ diff -u -r1.27 python.cxx
 +  /* ------------------------------------------------------------
 +   * docstring()
 +   *    Get the docstring text, stripping off {} if neccessary,
 +  /* ------------------------------------------------------------
 +   * docstring()
 +   *    Get the docstring text, stripping off {} if neccessary,

-+   *    and enclose in triple-double quotes.  If autodoc is also
++   *    and enclose in triple double quotes.  If autodoc is also

 +   *    set then it will build a combined docstring.
 +   * ------------------------------------------------------------ */
 +
 +   *    set then it will build a combined docstring.
 +   * ------------------------------------------------------------ */
 +

-+  String *docstring(Node *n, autodoc_t ad_type) {
++  String *docstring(Node *n, autodoc_t ad_type, const String* indent) {

 +    String* str = Getattr(n, "feature:docstring");
 +    bool have_ds = (str != NULL && Len(str) > 0);
 +    bool have_auto = (Getattr(n,"feature:autodoc") && !Getattr(n, "feature:noautodoc"));
 +    char* triple_double = "\"\"\"";
 +    String* str = Getattr(n, "feature:docstring");
 +    bool have_ds = (str != NULL && Len(str) > 0);
 +    bool have_auto = (Getattr(n,"feature:autodoc") && !Getattr(n, "feature:noautodoc"));
 +    char* triple_double = "\"\"\"";

-+    String* autodoc;
-+    String* doc;
++    String* autodoc = NULL;
++    String* doc = NULL;

 +
 +    if ( have_ds ) {
 +      char* t = Char(str);
 +
 +    if ( have_ds ) {
 +      char* t = Char(str);


@@ -92,13 +96,49 @@ diff -u -r1.27 python.cxx
 +      have_auto = (autodoc != NULL && Len(autodoc) > 0);
 +    }
 +    
 +      have_auto = (autodoc != NULL && Len(autodoc) > 0);
 +    }
 +    

-+    if ( have_auto && have_ds )
-+      doc = NewStringf("%s%s\n\n%s%s", triple_double, autodoc, str, triple_double);
-+    else if ( !have_auto && have_ds )
-+      doc = NewStringf("%s%s%s", triple_double, str, triple_double);
++    // If there is more than one line then make docstrings like this:
++    //
++    //      """
++    //      This is line1
++    //      And here is line2 followed by the rest of them
++    //      """
++    //
++    // otherwise, put it all on a single line
++    //
++    if ( have_auto && have_ds ) {       // Both autodoc and docstring are present
++      doc = NewString("");
++      Printv(doc, triple_double, "\n",
++                  pythoncode(autodoc, indent), "\n",
++                  pythoncode(str, indent), 
++                  indent, triple_double, NIL);
++    }
++    else if ( !have_auto && have_ds ) { // only docstring
++      if (Strchr(str, '\n') == NULL) {
++        doc = NewStringf("%s%s%s", triple_double, str, triple_double);
++      }
++      else {
++      doc = NewString("");
++      Printv(doc, triple_double, "\n",
++                  pythoncode(str, indent),
++                  indent, triple_double, NIL);
++      }
++    }
++    else if ( have_auto && !have_ds ) { // only autodoc
++      if (Strchr(autodoc, '\n') == NULL) {
++        doc = NewStringf("%s%s%s", triple_double, autodoc, triple_double);
++      }
++      else {
++      doc = NewString("");
++      Printv(doc, triple_double, "\n",
++                  pythoncode(autodoc, indent),
++                  indent, triple_double, NIL);
++      }
++    }

 +    else
 +    else

-+      doc = NewStringf("%s%s%s", triple_double, autodoc, triple_double);
++      doc = NewString("");

 +
 +

++    // Save the generated strings in the parse tree in case they are used later
++    // by post processing tools

 +    Setattr(n, "python:docstring", doc);
 +    Setattr(n, "python:autodoc", autodoc);
 +    return doc;
 +    Setattr(n, "python:docstring", doc);
 +    Setattr(n, "python:autodoc", autodoc);
 +    return doc;


@@ -118,18 +158,8 @@ diff -u -r1.27 python.cxx
 +  String* make_autodoc(Node *n, autodoc_t ad_type) {
 +
 +    if (ad_type == AUTODOC_CLASS)
 +  String* make_autodoc(Node *n, autodoc_t ad_type) {
 +
 +    if (ad_type == AUTODOC_CLASS)

-+      return NULL;  // No function call do document in this case
++      return NULL;  // No function call to document in this case

 +
 +

-+    // check how should the parameters be rendered?
-+    String* autodoc = Getattr(n, "feature:autodoc");
-+    bool showTypes;
-+    if (Strcmp(autodoc, "0") == 0)
-+      showTypes = false;
-+    else if (Strcmp(autodoc, "1") == 0)
-+      showTypes = true;
-+    else
-+      return autodoc;
-+    

 +    // If the function is overloaded then this funciton is called
 +    // for the last one.  Rewind to the first so the docstrings are
 +    // in order.
 +    // If the function is overloaded then this funciton is called
 +    // for the last one.  Rewind to the first so the docstrings are
 +    // in order.


@@ -138,6 +168,22 @@ diff -u -r1.27 python.cxx
 +    
 +    String* doc  = NewString("");
 +    while (n) {
 +    
 +    String* doc  = NewString("");
 +    while (n) {

++      bool showTypes = false;
++      bool skipAuto = false;
++      
++      // check how should the parameters be rendered?
++      String* autodoc = Getattr(n, "feature:autodoc");
++      if (Strcmp(autodoc, "0") == 0)
++        showTypes = false;
++      else if (Strcmp(autodoc, "1") == 0)
++        showTypes = true;
++      else {
++        // if not "0" or "1" then autodoc is already the string that should be used
++        Printf(doc, "%s", autodoc);
++        skipAuto = true;
++      }
++
++      if (!skipAuto) {

 +        String*   symname = Getattr(n, "sym:name");
 +        SwigType* type    = Getattr(n, "type");
 +      
 +        String*   symname = Getattr(n, "sym:name");
 +        SwigType* type    = Getattr(n, "type");
 +      


@@ -145,11 +191,16 @@ diff -u -r1.27 python.cxx
 +          if (Strcmp(type, "void") == 0)
 +            type = NULL;
 +          else {
 +          if (Strcmp(type, "void") == 0)
 +            type = NULL;
 +          else {

-+            type = SwigType_base(type);
-+            Node* lookup = Swig_symbol_clookup(type, 0);
-+            if (lookup)
-+              type = Getattr(lookup, "sym:name");
-+          }
++            SwigType* qt = SwigType_typedef_resolve_all(type);
++            if (SwigType_isenum(qt))
++              type = NewString("int");
++            else {
++              type = SwigType_base(type);
++              Node* lookup = Swig_symbol_clookup(type, 0);
++              if (lookup)
++                type = Getattr(lookup, "sym:name");
++            }
++          }     

 +        }
 +        
 +        switch ( ad_type ) {
 +        }
 +        
 +        switch ( ad_type ) {


@@ -163,9 +214,9 @@ diff -u -r1.27 python.cxx
 +        case AUTODOC_DTOR:
 +          Printf(doc, "__del__()");
 +          break;
 +        case AUTODOC_DTOR:
 +          Printf(doc, "__del__()");
 +          break;

-+            
++        

 +        case AUTODOC_STATICFUNC:
 +        case AUTODOC_STATICFUNC:

-+          Printf(doc, "%s.%s(%s)", class_name, symname, make_autodocParmList(n, showTypes));
++          Printf(doc, "%s(%s)", symname, make_autodocParmList(n, showTypes));

 +          if (type) Printf(doc, " -> %s", type);
 +          break;
 +                      
 +          if (type) Printf(doc, " -> %s", type);
 +          break;
 +                      


@@ -174,11 +225,12 @@ diff -u -r1.27 python.cxx
 +          if (type) Printf(doc, " -> %s", type);
 +          break;            
 +        }
 +          if (type) Printf(doc, " -> %s", type);
 +          break;            
 +        }

-+
-+        // if it's overloaded then get the next decl and loop around again
-+        n = Getattr(n, "sym:nextSibling");
-+        if (n)
-+          Printf(doc, "\n");
++      }
++      
++      // if it's overloaded then get the next decl and loop around again
++      n = Getattr(n, "sym:nextSibling");
++      if (n)
++        Printf(doc, "\n");

 +    }
 +          
 +    return doc;
 +    }
 +          
 +    return doc;


@@ -204,7 +256,7 @@ diff -u -r1.27 python.cxx
 +
 +        // Do we need to wrap a long line?
 +        if ((Len(doc) - lines*maxwidth) > maxwidth) {
 +
 +        // Do we need to wrap a long line?
 +        if ((Len(doc) - lines*maxwidth) > maxwidth) {

-+          Printf(doc, "\n    ");
++          Printf(doc, "\n%s", tab4);

 +          lines += 1;
 +        }
 +      }
 +          lines += 1;
 +        }
 +      }


@@ -212,9 +264,14 @@ diff -u -r1.27 python.cxx
 +      // Do the param type too?
 +      if (showTypes) {
 +        SwigType* type =  SwigType_base(Getattr(p, "type"));
 +      // Do the param type too?
 +      if (showTypes) {
 +        SwigType* type =  SwigType_base(Getattr(p, "type"));

-+        lookup = Swig_symbol_clookup(type, 0);
-+        if (lookup)
-+          type = Getattr(lookup, "sym:name");
++        SwigType* qt = SwigType_typedef_resolve_all(type);
++        if (SwigType_isenum(qt))
++          type = NewString("int");
++        else {
++          lookup = Swig_symbol_clookup(type, 0);
++          if (lookup)
++            type = Getattr(lookup, "sym:name");
++        }

 +        Printf(doc, "%s ", type);
 +      }
 +
 +        Printf(doc, "%s ", type);
 +      }
 +


@@ -243,18 +300,22 @@ diff -u -r1.27 python.cxx
     * have_addtofunc()
     *    Check if there is a %addtofunc directive and it has text
     * ------------------------------------------------------------ */
     * have_addtofunc()
     *    Check if there is a %addtofunc directive and it has text
     * ------------------------------------------------------------ */

-@@ -1908,7 +2112,9 @@
+ 
+@@ -1731,9 +1986,11 @@
+         Printf(f_shadow, modern ? "(object)" : "(_object)");

        }
        }
        Printf(f_shadow,":\n");
 -
        }
        }
        Printf(f_shadow,":\n");
 -

-+      if ( have_docstring(n) )
-+          Printv(f_shadow, tab4, docstring(n, AUTODOC_CLASS), "\n", NIL);
++      if ( Getattr(n, "feature:docstring") ) // don't use have_docstring in this case because autodoc doesn't apply
++          Printv(f_shadow, tab4, docstring(n, AUTODOC_CLASS, tab4), "\n", NIL);

 +      
        if (!modern) {
          Printv(f_shadow,tab4,"__swig_setmethods__ = {}\n",NIL);
          if (Len(base_class)) {
 +      
        if (!modern) {
          Printv(f_shadow,tab4,"__swig_setmethods__ = {}\n",NIL);
          if (Len(base_class)) {

-@@ -2043,14 +2249,20 @@
+           Printf(f_shadow,"%sfor _s in [%s]: __swig_setmethods__.update(_s.__swig_setmethods__)\n",tab4,base_class);
+@@ -1866,16 +2123,22 @@
+         Delete(pyaction);

          Printv(f_shadow,pycode,"\n",NIL);
        } else {
  
          Printv(f_shadow,pycode,"\n",NIL);
        } else {
  


@@ -271,7 +332,7 @@ diff -u -r1.27 python.cxx
 -            Printv(f_shadow, "return ", funcCallHelper(Swig_name_member(class_name,symname), allow_kwargs), "\n", NIL);
 +            Printv(f_shadow, "\n", NIL);
 +            if ( have_docstring(n) )
 -            Printv(f_shadow, "return ", funcCallHelper(Swig_name_member(class_name,symname), allow_kwargs), "\n", NIL);
 +            Printv(f_shadow, "\n", NIL);
 +            if ( have_docstring(n) )

-+              Printv(f_shadow, tab8, docstring(n, AUTODOC_FUNC), "\n", NIL);
++              Printv(f_shadow, tab8, docstring(n, AUTODOC_FUNC, tab8), "\n", NIL);

 +            if ( have_addtofunc(n) ) {
 +              Printv(f_shadow, tab8, "val = ", funcCallHelper(Swig_name_member(class_name,symname), allow_kwargs), "\n", NIL);
 +              Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
 +            if ( have_addtofunc(n) ) {
 +              Printv(f_shadow, tab8, "val = ", funcCallHelper(Swig_name_member(class_name,symname), allow_kwargs), "\n", NIL);
 +              Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);


@@ -282,7 +343,9 @@ diff -u -r1.27 python.cxx
            }
          }
  
            }
          }
  

-@@ -2067,12 +2279,18 @@
+       }
+@@ -1890,14 +2153,20 @@
+   virtual int staticmemberfunctionHandler(Node *n) {

      String *symname = Getattr(n,"sym:name");
      Language::staticmemberfunctionHandler(n);
      if (shadow) {
      String *symname = Getattr(n,"sym:name");
      Language::staticmemberfunctionHandler(n);
      if (shadow) {


@@ -294,7 +357,7 @@ diff -u -r1.27 python.cxx
 -        Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
 -        Printv(f_shadow, tab8, "return val\n", NIL);
 +        if ( have_docstring(n) )
 -        Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
 -        Printv(f_shadow, tab8, "return val\n", NIL);
 +        if ( have_docstring(n) )

-+          Printv(f_shadow, tab8, docstring(n, AUTODOC_STATICFUNC), "\n", NIL);
++          Printv(f_shadow, tab8, docstring(n, AUTODOC_STATICFUNC, tab8), "\n", NIL);

 +        if ( have_addtofunc(n) ) {
 +          Printv(f_shadow, tab8, "val = ", funcCallHelper(Swig_name_member(class_name, symname), kw), "\n", NIL);
 +          Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
 +        if ( have_addtofunc(n) ) {
 +          Printv(f_shadow, tab8, "val = ", funcCallHelper(Swig_name_member(class_name, symname), kw), "\n", NIL);
 +          Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);


@@ -305,16 +368,20 @@ diff -u -r1.27 python.cxx
          Printv(f_shadow, tab4, modern ? "" : "if _newclass:",  symname,
                 " = staticmethod(", symname, ")\n", NIL);
  
          Printv(f_shadow, tab4, modern ? "" : "if _newclass:",  symname,
                 " = staticmethod(", symname, ")\n", NIL);
  

-@@ -2159,6 +2377,8 @@
+         if (!modern) {
+@@ -1982,8 +2251,10 @@
+           }

  
              Printv(f_shadow, tab4, "def __init__(self, *args",
                     (allow_kwargs ? ", **kwargs" : ""), "):\n", NIL);
 +            if ( have_docstring(n) )
  
              Printv(f_shadow, tab4, "def __init__(self, *args",
                     (allow_kwargs ? ", **kwargs" : ""), "):\n", NIL);
 +            if ( have_docstring(n) )

-+              Printv(f_shadow, tab8, docstring(n, AUTODOC_CTOR), "\n", NIL);
++              Printv(f_shadow, tab8, docstring(n, AUTODOC_CTOR, tab8), "\n", NIL);

              Printv(f_shadow, pass_self, NIL);
              if (!modern) {
                Printv(f_shadow, tab8, "_swig_setattr(self, ", rclassname, ", 'this', ", 
              Printv(f_shadow, pass_self, NIL);
              if (!modern) {
                Printv(f_shadow, tab8, "_swig_setattr(self, ", rclassname, ", 'this', ", 

-@@ -2174,7 +2394,7 @@
+                      funcCallHelper(Swig_name_construct(symname), allow_kwargs), ")\n", NIL);
+@@ -1997,9 +2268,9 @@
+               Printv(f_shadow, tab8, "self.thisown = 1\n", NIL);

                Printv(f_shadow, tab8, "del newobj.thisown\n", NIL);
              }
              if ( have_addtofunc(n) )
                Printv(f_shadow, tab8, "del newobj.thisown\n", NIL);
              }
              if ( have_addtofunc(n) )


@@ -323,27 +390,33 @@ diff -u -r1.27 python.cxx
            Delete(pass_self);
          }
          have_constructor = 1;
            Delete(pass_self);
          }
          have_constructor = 1;

-@@ -2192,6 +2412,8 @@
+       } else {
+@@ -2015,8 +2286,10 @@
+         } else {

  
              Printv(f_shadow_stubs, "\ndef ", symname, "(*args",
                     (allow_kwargs ? ", **kwargs" : ""), "):\n", NIL);
 +            if ( have_docstring(n) )
  
              Printv(f_shadow_stubs, "\ndef ", symname, "(*args",
                     (allow_kwargs ? ", **kwargs" : ""), "):\n", NIL);
 +            if ( have_docstring(n) )

-+              Printv(f_shadow_stubs, tab4, docstring(n, AUTODOC_CTOR), "\n", NIL);
++              Printv(f_shadow_stubs, tab4, docstring(n, AUTODOC_CTOR, tab4), "\n", NIL);

              Printv(f_shadow_stubs, tab4, "val = ",
                     funcCallHelper(Swig_name_construct(symname), allow_kwargs), "\n", NIL);
            Printv(f_shadow_stubs, tab4, "val.thisown = 1\n", NIL);
              Printv(f_shadow_stubs, tab4, "val = ",
                     funcCallHelper(Swig_name_construct(symname), allow_kwargs), "\n", NIL);
            Printv(f_shadow_stubs, tab4, "val.thisown = 1\n", NIL);

-@@ -2225,11 +2447,13 @@
+             if ( have_addtofunc(n) )
+@@ -2048,13 +2321,15 @@
+       Delete(pyaction);

        Printv(f_shadow,pycode,"\n", NIL);
        } else {
        Printv(f_shadow, tab4, "def __del__(self, destroy=", module, ".", Swig_name_destroy(symname), "):\n", NIL);
 +        if ( have_docstring(n) )
        Printv(f_shadow,pycode,"\n", NIL);
        } else {
        Printv(f_shadow, tab4, "def __del__(self, destroy=", module, ".", Swig_name_destroy(symname), "):\n", NIL);
 +        if ( have_docstring(n) )

-+              Printv(f_shadow, tab8, docstring(n, AUTODOC_DTOR), "\n", NIL);
++              Printv(f_shadow, tab8, docstring(n, AUTODOC_DTOR, tab8), "\n", NIL);

        if ( have_addtofunc(n) )
          Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
        Printv(f_shadow, tab8, "try:\n", NIL);
        if ( have_addtofunc(n) )
          Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
        Printv(f_shadow, tab8, "try:\n", NIL);

-       Printv(f_shadow, tab4, tab8, "if self.thisown: destroy(self)\n", NIL);
+-      Printv(f_shadow, tab4, tab8, "if self.thisown: destroy(self)\n", NIL);

 -      Printv(f_shadow, tab8, "except: pass\n", NIL);
 -      Printv(f_shadow, tab8, "except: pass\n", NIL);

++      Printv(f_shadow, tab8, tab4, "if self.thisown: destroy(self)\n", NIL);

 +      Printv(f_shadow, tab8, "except: pass\n\n", NIL);
        }
      }
      return SWIG_OK;
 +      Printv(f_shadow, tab8, "except: pass\n\n", NIL);
        }
      }
      return SWIG_OK;

+   }