wxPython/SWIG/swig.python-docstring.patch

   1 Index: Source/Modules/python.cxx
   2 ===================================================================
   3 RCS file: /cvsroot/SWIG/Source/Modules/python.cxx,v
   4 retrieving revision 1.33
   5 diff -u -4 -r1.33 python.cxx
   6 --- Source/Modules/python.cxx   9 Dec 2003 02:52:07 -0000       1.33
   7 +++ Source/Modules/python.cxx   11 Dec 2003 18:11:22 -0000
   8 @@ -54,8 +54,17 @@
   9  static  int       have_constructor;
  10  static  int       have_repr;
  11  static  String   *real_classname;
  12
  13 +/* flags for the make_autodoc function */
  14 +enum autodoc_t {
  15 +  AUTODOC_CLASS,
  16 +  AUTODOC_CTOR,
  17 +  AUTODOC_DTOR,
  18 +  AUTODOC_STATICFUNC,
  19 +  AUTODOC_FUNC
  20 +};
  21 +
  22  static const char *usage = (char *)"\
  23  Python Options (available with -python)\n\
  24       -ldflags        - Print runtime libraries to link with\n\
  25       -globals <name> - Set <name> used to access C global variable [default: 'cvar']\n\
  26 @@ -417,17 +426,23 @@
  27     *    functions.
  28     * ------------------------------------------------------------ */
  29
  30    void emitFunctionShadowHelper(Node *n, File *f_dest, String *name, int kw) {
  31 -    if ( ! have_addtofunc(n) ) {
  32 -      /* If there is no addtofunc directive then just assign from the extension module */
  33 +    if ( ! have_addtofunc(n) && ! have_docstring(n) ) {
  34 +      /* If there is no addtofunc or docstring directive then just assign from the extension module */
  35        Printv(f_dest, "\n", name, " = ", module, ".", name, "\n", NIL);
  36      } else {
  37        /* Otherwise make a wrapper function to insert the code into */
  38        Printv(f_dest, "\ndef ", name, "(*args", (kw ? ", **kwargs" : ""), "):\n", NIL);
  39 -      Printv(f_dest, tab4, "val = ", funcCallHelper(name, kw), "\n", NIL);
  40 -      Printv(f_dest, tab4, addtofunc(n), "\n", NIL);
  41 -      Printv(f_dest, tab4, "return val\n", NIL);
  42 +      if ( have_docstring(n) )
  43 +        Printv(f_dest, tab4, docstring(n, AUTODOC_FUNC, tab4), "\n", NIL);
  44 +      if ( have_addtofunc(n) ) {
  45 +        Printv(f_dest, tab4, "val = ", funcCallHelper(name, kw), "\n", NIL);
  46 +        Printv(f_dest, tab4, addtofunc(n), "\n", NIL);
  47 +        Printv(f_dest, tab4, "return val\n", NIL);
  48 +      } else {
  49 +        Printv(f_dest, tab4, "return ", funcCallHelper(name, kw), "\n", NIL);
  50 +      }
  51      }
  52    }
  53
  54
  55 @@ -441,8 +456,246 @@
  56    }
  57
  58
  59    /* ------------------------------------------------------------
  60 +   * have_docstring()
  61 +   *    Check if there is a docstring directive and it has text,
  62 +   *    or there is an autodoc flag set
  63 +   * ------------------------------------------------------------ */
  64 +
  65 +  bool have_docstring(Node *n) {
  66 +    String* str = Getattr(n, "feature:docstring");
  67 +    return (str != NULL && Len(str) > 0) ||
  68 +        (Getattr(n,"feature:autodoc") && !Getattr(n, "feature:noautodoc"));
  69 +  }
  70 +
  71 +  /* ------------------------------------------------------------
  72 +   * docstring()
  73 +   *    Get the docstring text, stripping off {} if neccessary,
  74 +   *    and enclose in triple double quotes.  If autodoc is also
  75 +   *    set then it will build a combined docstring.
  76 +   * ------------------------------------------------------------ */
  77 +
  78 +  String *docstring(Node *n, autodoc_t ad_type, const String* indent) {
  79 +    String* str = Getattr(n, "feature:docstring");
  80 +    bool have_ds = (str != NULL && Len(str) > 0);
  81 +    bool have_auto = (Getattr(n,"feature:autodoc") && !Getattr(n, "feature:noautodoc"));
  82 +    char* triple_double = "\"\"\"";
  83 +    String* autodoc = NULL;
  84 +    String* doc = NULL;
  85 +
  86 +    if ( have_ds ) {
  87 +      char* t = Char(str);
  88 +      if (*t == '{') {
  89 +        Delitem(str ,0);
  90 +        Delitem(str,DOH_END);
  91 +      }
  92 +    }
  93 +
  94 +    if ( have_auto ) {
  95 +      autodoc = make_autodoc(n, ad_type);
  96 +      have_auto = (autodoc != NULL && Len(autodoc) > 0);
  97 +    }
  98 +
  99 +//     if ( have_auto && have_ds )
 100 +//       doc = NewStringf("%s%s\n\n%s%s", triple_double, autodoc, str, triple_double);
 101 +//     else if ( !have_auto && have_ds )
 102 +//       doc = NewStringf("%s%s%s", triple_double, str, triple_double);
 103 +//     else
 104 +//       doc = NewStringf("%s%s%s", triple_double, autodoc, triple_double);
 105 +
 106 +
 107 +    // If there is more than one line then make docstrings like this:
 108 +    //
 109 +    //      """
 110 +    //      This is line1
 111 +    //      And here is line2 followed by the rest of them
 112 +    //      """
 113 +    //
 114 +    // otherwise, put it all on a single line
 115 +    //
 116 +    if ( have_auto && have_ds ) {       // Both autodoc and docstring are present
 117 +      doc = NewString("");
 118 +      Printv(doc, triple_double, "\n",
 119 +                  pythoncode(autodoc, indent), "\n",
 120 +                  pythoncode(str, indent),
 121 +                  indent, triple_double, NIL);
 122 +    }
 123 +    else if ( !have_auto && have_ds ) { // only docstring
 124 +      if (Strchr(str, '\n') == NULL) {
 125 +        doc = NewStringf("%s%s%s", triple_double, str, triple_double);
 126 +      }
 127 +      else {
 128 +      doc = NewString("");
 129 +      Printv(doc, triple_double, "\n",
 130 +                  pythoncode(str, indent),
 131 +                  indent, triple_double, NIL);
 132 +      }
 133 +    }
 134 +    else if ( have_auto && !have_ds ) { // only autodoc
 135 +      if (Strchr(autodoc, '\n') == NULL) {
 136 +        doc = NewStringf("%s%s%s", triple_double, autodoc, triple_double);
 137 +      }
 138 +      else {
 139 +      doc = NewString("");
 140 +      Printv(doc, triple_double, "\n",
 141 +                  pythoncode(autodoc, indent),
 142 +                  indent, triple_double, NIL);
 143 +      }
 144 +    }
 145 +    else
 146 +      doc = NewString("");
 147 +
 148 +    // Save the generated strings in the parse tree in case they are used later
 149 +    // by post processing tools
 150 +    Setattr(n, "python:docstring", doc);
 151 +    Setattr(n, "python:autodoc", autodoc);
 152 +    return doc;
 153 +  }
 154 +
 155 +
 156 +  /* ------------------------------------------------------------
 157 +   * make_autodoc()
 158 +   *    Build a docstring for the node, using parameter and other
 159 +   *    info in the parse tree.  If the value of the autodoc
 160 +   *    attribute is "0" then do not include parameter types, if
 161 +   *    it is "1" (the default) then do.  If it has some other
 162 +   *    value then assume it is supplied by the extension writer
 163 +   *    and use it directly.
 164 +   * ------------------------------------------------------------ */
 165 +
 166 +  String* make_autodoc(Node *n, autodoc_t ad_type) {
 167 +
 168 +    if (ad_type == AUTODOC_CLASS)
 169 +      return NULL;  // No function call to document in this case
 170 +
 171 +    // If the function is overloaded then this funciton is called
 172 +    // for the last one.  Rewind to the first so the docstrings are
 173 +    // in order.
 174 +    while ( Getattr(n, "sym:previousSibling") )
 175 +      n = Getattr(n, "sym:previousSibling");
 176 +
 177 +    String* doc  = NewString("");
 178 +    while (n) {
 179 +      bool showTypes = false;
 180 +      bool skipAuto = false;
 181 +
 182 +      // check how should the parameters be rendered?
 183 +      String* autodoc = Getattr(n, "feature:autodoc");
 184 +      if (Strcmp(autodoc, "0") == 0)
 185 +        showTypes = false;
 186 +      else if (Strcmp(autodoc, "1") == 0)
 187 +        showTypes = true;
 188 +      else {
 189 +        // if not "0" or "1" then autodoc is already the string that should be used
 190 +        Printf(doc, "%s", autodoc);
 191 +        skipAuto = true;
 192 +      }
 193 +
 194 +      if (!skipAuto) {
 195 +        String*   symname = Getattr(n, "sym:name");
 196 +        SwigType* type    = Getattr(n, "type");
 197 +
 198 +        if (type) {
 199 +          if (Strcmp(type, "void") == 0)
 200 +            type = NULL;
 201 +          else {
 202 +            type = SwigType_base(type);
 203 +            Node* lookup = Swig_symbol_clookup(type, 0);
 204 +            if (lookup)
 205 +              type = Getattr(lookup, "sym:name");
 206 +          }
 207 +        }
 208 +
 209 +        switch ( ad_type ) {
 210 +        case AUTODOC_CTOR:
 211 +          if ( Strcmp(class_name, symname) == 0)
 212 +            Printf(doc, "__init__(%s) -> %s", make_autodocParmList(n, showTypes), class_name);
 213 +          else
 214 +            Printf(doc, "%s(%s) -> %s", symname, make_autodocParmList(n, showTypes), class_name);
 215 +          break;
 216 +
 217 +        case AUTODOC_DTOR:
 218 +          Printf(doc, "__del__()");
 219 +          break;
 220 +
 221 +        case AUTODOC_STATICFUNC:
 222 +          Printf(doc, "%s.%s(%s)", class_name, symname, make_autodocParmList(n, showTypes));
 223 +          if (type) Printf(doc, " -> %s", type);
 224 +          break;
 225 +
 226 +        case AUTODOC_FUNC:
 227 +          Printf(doc, "%s(%s)", symname, make_autodocParmList(n, showTypes));
 228 +          if (type) Printf(doc, " -> %s", type);
 229 +          break;
 230 +        }
 231 +      }
 232 +
 233 +      // if it's overloaded then get the next decl and loop around again
 234 +      n = Getattr(n, "sym:nextSibling");
 235 +      if (n)
 236 +        Printf(doc, "\n");
 237 +    }
 238 +
 239 +    return doc;
 240 +  }
 241 +
 242 +
 243 +  String* make_autodocParmList(Node* n, bool showTypes) {
 244 +    String*   doc = NewString("");
 245 +    ParmList* plist = Getattr(n,"parms");
 246 +    Parm*     p;
 247 +    Node*     lookup;
 248 +    int       lines = 0;
 249 +    const int maxwidth = 50;
 250 +
 251 +
 252 +    for (p = plist; p; p = nextSibling(p)) {
 253 +      String*   name =  Getattr(p, "name");
 254 +      String*   value = Getattr(p, "value");
 255 +
 256 +      if ( Len(doc) ) {
 257 +        // add a comma to the previous one if any
 258 +        Printf(doc, ", ");
 259 +
 260 +        // Do we need to wrap a long line?
 261 +        if ((Len(doc) - lines*maxwidth) > maxwidth) {
 262 +          Printf(doc, "\n%s", tab4);
 263 +          lines += 1;
 264 +        }
 265 +      }
 266 +
 267 +      // Do the param type too?
 268 +      if (showTypes) {
 269 +        SwigType* type =  SwigType_base(Getattr(p, "type"));
 270 +        lookup = Swig_symbol_clookup(type, 0);
 271 +        if (lookup)
 272 +          type = Getattr(lookup, "sym:name");
 273 +        Printf(doc, "%s ", type);
 274 +      }
 275 +
 276 +      if (name)
 277 +        Printf(doc, "%s", name);
 278 +      else
 279 +        Printf(doc, "??");
 280 +
 281 +      if (value) {
 282 +        if (Strcmp(value, "NULL") == 0)
 283 +          value = NewString("None");
 284 +        else {
 285 +          lookup = Swig_symbol_clookup(value, 0);
 286 +          if (lookup)
 287 +            value = Getattr(lookup, "sym:name");
 288 +        }
 289 +        Printf(doc, "=%s", value);
 290 +      }
 291 +    }
 292 +
 293 +    return doc;
 294 +  }
 295 +
 296 +
 297 +  /* ------------------------------------------------------------
 298     * have_addtofunc()
 299     *    Check if there is a %addtofunc directive and it has text
 300     * ------------------------------------------------------------ */
 301
 302 @@ -1663,9 +1916,11 @@
 303           Printf(f_shadow, modern ? "(object)" : "(_object)");
 304         }
 305        }
 306        Printf(f_shadow,":\n");
 307 -
 308 +      if ( Getattr(n, "feature:docstring") ) // don't use have_docstring in this case because autodoc doesn't apply
 309 +          Printv(f_shadow, tab4, docstring(n, AUTODOC_CLASS, tab4), "\n", NIL);
 310 +
 311        if (!modern) {
 312          Printv(f_shadow,tab4,"__swig_setmethods__ = {}\n",NIL);
 313          if (Len(base_class)) {
 314            Printf(f_shadow,"%sfor _s in [%s]: __swig_setmethods__.update(_s.__swig_setmethods__)\n",tab4,base_class);
 315 @@ -1798,16 +2053,22 @@
 316           Delete(pyaction);
 317           Printv(f_shadow,pycode,"\n",NIL);
 318         } else {
 319
 320 -          Printv(f_shadow, tab4, "def ", symname, "(*args", (allow_kwargs ? ", **kwargs" : ""), "): ", NIL);
 321 -          if ( have_addtofunc(n) ) {
 322 -            Printv(f_shadow, "\n", NIL);
 323 -            Printv(f_shadow, tab8, "val = ", funcCallHelper(Swig_name_member(class_name,symname), allow_kwargs), "\n", NIL);
 324 -            Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
 325 -            Printv(f_shadow, tab8, "return val\n", NIL);
 326 +          Printv(f_shadow, tab4, "def ", symname, "(*args", (allow_kwargs ? ", **kwargs" : ""), "):", NIL);
 327 +          if ( ! have_addtofunc(n) && ! have_docstring(n)) {
 328 +            Printv(f_shadow, " return ", funcCallHelper(Swig_name_member(class_name,symname), allow_kwargs), "\n", NIL);
 329            } else {
 330 -            Printv(f_shadow, "return ", funcCallHelper(Swig_name_member(class_name,symname), allow_kwargs), "\n", NIL);
 331 +            Printv(f_shadow, "\n", NIL);
 332 +            if ( have_docstring(n) )
 333 +              Printv(f_shadow, tab8, docstring(n, AUTODOC_FUNC, tab8), "\n", NIL);
 334 +            if ( have_addtofunc(n) ) {
 335 +              Printv(f_shadow, tab8, "val = ", funcCallHelper(Swig_name_member(class_name,symname), allow_kwargs), "\n", NIL);
 336 +              Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
 337 +              Printv(f_shadow, tab8, "return val\n\n", NIL);
 338 +            } else {
 339 +              Printv(f_shadow, tab8, "return ", funcCallHelper(Swig_name_member(class_name,symname), allow_kwargs), "\n\n", NIL);
 340 +            }
 341            }
 342          }
 343
 344        }
 345 @@ -1822,14 +2083,20 @@
 346    virtual int staticmemberfunctionHandler(Node *n) {
 347      String *symname = Getattr(n,"sym:name");
 348      Language::staticmemberfunctionHandler(n);
 349      if (shadow) {
 350 -      if ( !classic && have_addtofunc(n) ) {
 351 +      if ( !classic && (have_addtofunc(n) || have_docstring(n)) ) {
 352          int kw = (check_kwargs(n) && !Getattr(n,"sym:overloaded")) ? 1 : 0;
 353          Printv(f_shadow, tab4, "def ", symname, "(*args", (kw ? ", **kwargs" : ""), "):\n", NIL);
 354 -        Printv(f_shadow, tab8, "val = ", funcCallHelper(Swig_name_member(class_name, symname), kw), "\n", NIL);
 355 -        Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
 356 -        Printv(f_shadow, tab8, "return val\n", NIL);
 357 +        if ( have_docstring(n) )
 358 +          Printv(f_shadow, tab8, docstring(n, AUTODOC_STATICFUNC, tab8), "\n", NIL);
 359 +        if ( have_addtofunc(n) ) {
 360 +          Printv(f_shadow, tab8, "val = ", funcCallHelper(Swig_name_member(class_name, symname), kw), "\n", NIL);
 361 +          Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
 362 +          Printv(f_shadow, tab8, "return val\n\n", NIL);
 363 +        } else {
 364 +          Printv(f_shadow, tab8, "return ", funcCallHelper(Swig_name_member(class_name, symname), kw), "\n\n", NIL);
 365 +        }
 366          Printv(f_shadow, tab4, modern ? "" : "if _newclass:",  symname,
 367                 " = staticmethod(", symname, ")\n", NIL);
 368
 369          if (!modern) {
 370 @@ -1914,8 +2181,10 @@
 371             }
 372
 373              Printv(f_shadow, tab4, "def __init__(self, *args",
 374                     (allow_kwargs ? ", **kwargs" : ""), "):\n", NIL);
 375 +            if ( have_docstring(n) )
 376 +              Printv(f_shadow, tab8, docstring(n, AUTODOC_CTOR, tab8), "\n", NIL);
 377              Printv(f_shadow, pass_self, NIL);
 378              if (!modern) {
 379                Printv(f_shadow, tab8, "_swig_setattr(self, ", rclassname, ", 'this', ",
 380                       funcCallHelper(Swig_name_construct(symname), allow_kwargs), ")\n", NIL);
 381 @@ -1929,9 +2198,9 @@
 382                Printv(f_shadow, tab8, "self.thisown = 1\n", NIL);
 383                Printv(f_shadow, tab8, "del newobj.thisown\n", NIL);
 384              }
 385              if ( have_addtofunc(n) )
 386 -              Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
 387 +              Printv(f_shadow, tab8, addtofunc(n), "\n\n", NIL);
 388             Delete(pass_self);
 389           }
 390           have_constructor = 1;
 391         } else {
 392 @@ -1947,8 +2216,10 @@
 393           } else {
 394
 395              Printv(f_shadow_stubs, "\ndef ", symname, "(*args",
 396                     (allow_kwargs ? ", **kwargs" : ""), "):\n", NIL);
 397 +            if ( have_docstring(n) )
 398 +              Printv(f_shadow_stubs, tab4, docstring(n, AUTODOC_CTOR, tab4), "\n", NIL);
 399              Printv(f_shadow_stubs, tab4, "val = ",
 400                     funcCallHelper(Swig_name_construct(symname), allow_kwargs), "\n", NIL);
 401             Printv(f_shadow_stubs, tab4, "val.thisown = 1\n", NIL);
 402              if ( have_addtofunc(n) )
 403 @@ -1980,13 +2251,15 @@
 404         Delete(pyaction);
 405         Printv(f_shadow,pycode,"\n", NIL);
 406        } else {
 407         Printv(f_shadow, tab4, "def __del__(self, destroy=", module, ".", Swig_name_destroy(symname), "):\n", NIL);
 408 +        if ( have_docstring(n) )
 409 +              Printv(f_shadow, tab8, docstring(n, AUTODOC_DTOR, tab8), "\n", NIL);
 410         if ( have_addtofunc(n) )
 411           Printv(f_shadow, tab8, addtofunc(n), "\n", NIL);
 412         Printv(f_shadow, tab8, "try:\n", NIL);
 413 -       Printv(f_shadow, tab4, tab8, "if self.thisown: destroy(self)\n", NIL);
 414 -       Printv(f_shadow, tab8, "except: pass\n", NIL);
 415 +       Printv(f_shadow, tab8, tab4, "if self.thisown: destroy(self)\n", NIL);
 416 +       Printv(f_shadow, tab8, "except: pass\n\n", NIL);
 417        }
 418      }
 419      return SWIG_OK;
 420    }