tools/fmt-luadoc.php

   1 #!/usr/bin/php
   2 <?php
   3 ## USAGE
   4 #
   5 ## generate doc/luadoc.json.gz (lua binding doc)
   6 # ./waf configure --luadoc ....
   7 # ./waf
   8 # ./gtk2_ardour/arluadoc > doc/luadoc.json.gz
   9 #
  10 ## generate doc/ardourapi.json.gz (ardour header doxygen doc)
  11 # cd ../../tools/doxy2json
  12 # ./ardourdoc.sh
  13 # cd -
  14 #
  15 ## format HTML (using this scripterl)
  16 # php tools/fmt-luadoc.php > /tmp/luadoc.html
  17 #
  18
  19 $options = getopt("m");
  20 if (isset ($options['m'])) {
  21         $HTMLOUTPUT = false; ## set to false to output ardour-manual
  22 } else {
  23         $HTMLOUTPUT = true; ## set to false to output ardour-manual
  24 }
  25
  26 ################################################################################
  27 ################################################################################
  28
  29 $json = gzdecode (file_get_contents (dirname (__FILE__).'/../doc/luadoc.json.gz'));
  30 $doc = array ();
  31 $ardourversion = '';
  32 foreach (json_decode ($json, true) as $b) {
  33         if (!isset ($b['type'])) {
  34                 if (isset ($b['version'])) { $ardourversion = $b['version']; }
  35                 continue;
  36         }
  37         # reserved lua words
  38         $b ['lua'] = preg_replace ('/:_end/', ':end', $b ['lua']);
  39         $b ['lua'] = preg_replace ('/:_type/', ':type', $b ['lua']);
  40         $b ['ldec'] = preg_replace ('/ const/', '', preg_replace ('/ const&/', '', $b['decl']));
  41         if (isset ($b['ret'])) {
  42                 $b['ret'] = preg_replace ('/ const/', '', preg_replace ('/ const&/', '', $b['ret']));
  43         }
  44         $doc[] = $b;
  45 }
  46
  47 if (count ($doc) == 0) {
  48         fwrite (STDERR, "Failed to read luadoc.json\n");
  49         exit (1);
  50 }
  51
  52 ################################################################################
  53 ## Global result variables
  54 ################################################################################
  55
  56 $classlist = array ();
  57 $constlist = array ();
  58
  59
  60 ################################################################################
  61 ## Pre-process the data, collect functions, parse arguments, cross reference
  62 ################################################################################
  63
  64
  65 ################################################################################
  66 # some internal helper functions first
  67
  68 $funclist = array ();
  69 $classes = array ();
  70 $consts = array ();
  71
  72 function my_die ($msg) {
  73         fwrite (STDERR, $msg."\n");
  74         exit (1);
  75 }
  76
  77 ##function ptr_strip ($ctype) {
  78 #       # boost::shared_ptr<std::list<boost::shared_ptr<ARDOUR::Route>> > >
  79 #       # -> std::list<ARDOUR::Route>
  80 #       $ctype = preg_replace ('/boost::shared_ptr<([^>]*)[ ]*>/', '$1', $ctype);
  81 #       return preg_replace ('/boost::shared_ptr<([^>]*)[ ]*>/', '$1', $ctype);
  82 #}
  83
  84 function arg2lua ($argtype, $flags = 0) {
  85         global $classes;
  86         global $consts;
  87
  88         # LuaBridge abstracts C++ references
  89         $flags |= preg_match ('/&$/', $argtype);
  90         $arg = preg_replace ('/&$/', '', $argtype);
  91         $arg = preg_replace ('/ $/', '', $arg);
  92
  93         # filter out basic types
  94         $builtin = array ('float', 'double', 'bool', 'std::string', 'int', 'long', 'unsigned long', 'unsigned int', 'unsigned char', 'char', 'void', 'char*', 'unsigned char*', 'void*');
  95         if (in_array ($arg, $builtin)) {
  96                 return array ($arg => $flags);
  97         }
  98
  99         # check Class declarations first
 100         foreach (array_merge ($classes, $consts) as $b) {
 101                 if ($b['ldec'] == $arg) {
 102                         return array ($b['lua'] => $flags);
 103                 }
 104         }
 105
 106         # strip class pointers -- TODO Check C'tor for given class
 107         $arg = preg_replace ('/[&*]*$/', '', $argtype);
 108         foreach (array_merge ($classes, $consts) as $b) {
 109                 if ($b['ldec'] == $arg) {
 110                         return array ($b['lua'] => $flags);
 111                 }
 112         }
 113         if ($flags & 2) {
 114                 return array ($argtype => ($flags | 4));
 115         } else {
 116                 return array ('--MISSING (' . $argtype . ')--' => ($flags | 4));
 117         }
 118 }
 119
 120 function stripclass ($classname, $name) {
 121         $classname .= ':';
 122         if (strpos ($name, $classname) !== 0) {
 123                 my_die ('invalid class prefix: ' .$classname. ' -- '. $name);
 124         }
 125         return substr ($name, strlen ($classname));
 126 }
 127
 128 function datatype ($decl) {
 129         # TODO handle spaces in type. Works because
 130         # we don't yet have templated types (with_space <here >)
 131         return substr ($decl, 0, strrpos ($decl, ' '));
 132 }
 133
 134 function luafn2class ($lua) {
 135         return substr ($lua, 0, strrpos ($lua, ':'));
 136 }
 137
 138 function luafn2name ($lua) {
 139         $fn = strrpos ($lua, ':');
 140         if ($fn !== 0 && strlen($lua) > $fn + 1) {
 141                 return substr ($lua, $fn + 1);
 142         }
 143         my_die ('invalid class prefix: '. $name);
 144 }
 145
 146
 147 function checkclass ($b) {
 148         global $classlist;
 149         if (!isset ($classlist[luafn2class ($b['lua'])])) {
 150                 my_die ('MISSING CLASS FOR '. print_r ($b['lua'], true));
 151         }
 152 }
 153
 154 # parse functions argument list to lua-names
 155 function decl2args ($decl) {
 156         $start = strrpos ($decl, '(');
 157         $end = strrpos ($decl, ')');
 158         $args = substr ($decl, $start + 1, $end - $start - 1);
 159         $arglist = preg_split ('/, */', $args);
 160         $rv = array ();
 161         foreach ($arglist as $a) {
 162                 if (empty ($a)) { continue; }
 163                 $rv[] = arg2lua ($a);
 164         }
 165         return $rv;
 166 }
 167
 168 function canonical_ctor ($b) {
 169         $rv = '';
 170         if (preg_match('/[^(]*\(([^)*]*)\*\)(\(.*\))/', $b['decl'], $matches)) {
 171                 $lc = luafn2class ($b['lua']);
 172                 $cn = str_replace (':', '::', $lc);
 173                 $fn = substr ($lc, 1 + strrpos ($lc, ':'));
 174                 $rv = $cn . '::'. $fn . $matches[2];
 175         }
 176         return $rv;
 177 }
 178
 179 function canonical_decl ($b) {
 180         $rv = '';
 181         $pfx = '';
 182         # match clang's declatation format
 183         if (preg_match('/[^(]*\(([^)*]*)\*\)\((.*)\)/', $b['decl'], $matches)) {
 184                 if (strpos ($b['type'], 'Free Function') !== false) {
 185                         $pfx = str_replace (':', '::', luafn2class ($b['lua'])) . '::';
 186                 }
 187                 $fn = substr ($b['lua'], 1 + strrpos ($b['lua'], ':'));
 188                 $rv = $matches[1] . $fn . '(';
 189                 $arglist = preg_split ('/, */', $matches[2]);
 190                 $first = true;
 191                 foreach ($arglist as $a) {
 192                         if (!$first) { $rv .= ', '; }; $first = false;
 193                         if (empty ($a)) { continue; }
 194                         $a = preg_replace ('/([^>]) >/', '$1>', $a);
 195                         $a = preg_replace ('/^Cairo::/', '', $a); // special case cairo enums
 196                         $a = preg_replace ('/([^ ])&/', '$1 &', $a);
 197                         $a = str_replace ('vector', 'std::vector', $a);
 198                         $a = str_replace ('std::string', 'string', $a);
 199                         $a = str_replace ('string const', 'const string', $a);
 200                         $a = str_replace ('string', 'std::string', $a);
 201                         $rv .= $a;
 202                 }
 203                 $rv .= ')';
 204         }
 205         return $pfx . $rv;
 206 }
 207
 208 ################################################################################
 209 # step 1: build class indices
 210
 211 foreach ($doc as $b) {
 212         if (strpos ($b['type'], "[C] ") === 0) {
 213                 $classes[] = $b;
 214                 $classlist[$b['lua']] = $b;
 215                 if (strpos ($b['type'], 'Pointer Class') === false) {
 216                         $classdecl[$b['ldec']] = $b;
 217                 }
 218         }
 219 }
 220
 221 foreach ($classes as $c) {
 222         if (strpos ($c['type'], 'Pointer Class') !== false) { continue; }
 223         if (isset ($c['parent'])) {
 224                 if (isset ($classdecl[$c['parent']])) {
 225                         $classlist[$c['lua']]['luaparent'][] = $classdecl[$c['parent']]['lua'];
 226                 } else {
 227                         my_die ('unknown parent class: ' . print_r ($c, true));
 228                 }
 229         }
 230 }
 231
 232 # step 2: extract constants/enum
 233 foreach ($doc as $b) {
 234         switch ($b['type']) {
 235         case "Constant/Enum":
 236         case "Constant/Enum Member":
 237                 if (strpos ($b['ldec'], '::') === false) {
 238                         # for extern c enums, use the Lua Namespace
 239                         $b['ldec'] = str_replace (':', '::', luafn2class ($b['lua']));
 240                 }
 241                 $ns = str_replace ('::', ':', $b['ldec']);
 242                 $constlist[$ns][] = $b;
 243                 # arg2lua lookup
 244                 $b['lua'] = $ns;
 245                 $consts[] = $b;
 246                 break;
 247         default:
 248                 break;
 249         }
 250 }
 251
 252 # step 3: process functions
 253 foreach ($doc as $b) {
 254         switch ($b['type']) {
 255         case "Constructor":
 256         case "Weak/Shared Pointer Constructor":
 257                 checkclass ($b);
 258                 $classlist[luafn2class ($b['lua'])]['ctor'][] = array (
 259                         'name' => luafn2class ($b['lua']),
 260                         'args' => decl2args ($b['ldec']),
 261                         'cand' => canonical_ctor ($b)
 262                 );
 263                 break;
 264         case "Data Member":
 265                 checkclass ($b);
 266                 $classlist[luafn2class ($b['lua'])]['data'][] = array (
 267                         'name' => $b['lua'],
 268                         'ret'  => arg2lua (datatype ($b['ldec']))
 269                 );
 270                 break;
 271         case "Static C Function":
 272                 checkclass ($b);
 273                 if (strpos ($b['lua'], 'ARDOUR:DataType:') === 0) {
 274                         # special case ARDOUR:DataType convenience c'tor
 275                         $args = array ();
 276                         $ret = array (luafn2class ($b['lua']) => 0);
 277                         $canon = 'ARDOUR::LuaAPI::datatype_ctor_'.strtolower (luafn2name ($b['lua'])).'(lua_State*)';
 278                 } else {
 279                         my_die ('unhandled Static C: ' . print_r($b, true));
 280                 }
 281                 $classlist[luafn2class ($b['lua'])]['func'][] = array (
 282                         'bind' => $b,
 283                         'name' => $b['lua'],
 284                         'args' => $args,
 285                         'ret'  => $ret,
 286                         'ref'  => false,
 287                         'ext'  => false,
 288                         'cand' => $canon
 289                 );
 290                 break;
 291         case "C Function":
 292                 # we required C functions to be in a class namespace
 293         case "Ext C Function":
 294                 checkclass ($b);
 295                 $args = array (array ('--lua--' => 0));
 296                 $ret = array ('...' => 0);
 297                 $ns = luafn2class ($b['lua']);
 298                 $cls = $classlist[$ns];
 299                 if (preg_match ('/.*<([^>]*)[ ]*>/', $cls['ldec'], $templ)) {
 300                         # std::vector, std::list types
 301                         switch (stripclass($ns, $b['lua'])) {
 302                         case 'add':
 303                                 #$args = array (array ('LuaTable {'.$templ[1].'}' => 0));
 304                                 $args = array (arg2lua ($templ[1], 2));
 305                                 $ret = array ('LuaTable' => 0);
 306                                 break;
 307                         case 'iter':
 308                                 $args = array ();
 309                                 $ret = array ('LuaIter' => 0);
 310                                 break;
 311                         case 'table':
 312                                 $args = array ();
 313                                 $ret = array ('LuaTable' => 0);
 314                                 break;
 315                         default:
 316                                 break;
 317                         }
 318                 } else if (strpos ($cls['type'], ' Array') !== false) {
 319                         # catches  C:FloatArray, C:IntArray
 320                         $templ = preg_replace ('/[&*]*$/', '', $cls['ldec']);
 321                         switch (stripclass($ns, $b['lua'])) {
 322                         case 'array':
 323                                 $args = array ();
 324                                 $ret = array ('LuaMetaTable' => 0);
 325                                 break;
 326                         case 'get_table':
 327                                 $args = array ();
 328                                 $ret = array ('LuaTable' => 0);
 329                                 break;
 330                         case 'set_table':
 331                                 $args = array (array ('LuaTable {'.$templ.'}' => 0));
 332                                 $ret = array ('void' => 0);
 333                                 break;
 334                         default:
 335                                 break;
 336                         }
 337                 }
 338                 $classlist[luafn2class ($b['lua'])]['func'][] = array (
 339                         'bind' => $b,
 340                         'name' => $b['lua'],
 341                         'args' => $args,
 342                         'ret'  => $ret,
 343                         'ref'  => true,
 344                         'ext'  => true,
 345                         'cand' => canonical_decl ($b)
 346                 );
 347                 break;
 348         case "Free C Function":
 349                 $funclist[luafn2class ($b['lua'])][] = array (
 350                         'bind' => $b,
 351                         'name' => $b['lua'],
 352                         'args' => $args,
 353                         'ret'  => $ret,
 354                         'ref'  => false,
 355                         'ext'  => true,
 356                         'cand' => str_replace (':', '::', $b['lua']).'(lua_State*)'
 357                 );
 358                 break;
 359         case "Free Function":
 360         case "Free Function RefReturn":
 361                 $funclist[luafn2class ($b['lua'])][] = array (
 362                         'bind' => $b,
 363                         'name' => $b['lua'],
 364                         'args' => decl2args ($b['ldec']),
 365                         'ret'  => arg2lua ($b['ret']),
 366                         'ref'  => (strpos ($b['type'], "RefReturn") !== false),
 367                         'cand' => canonical_decl ($b)
 368                 );
 369                 break;
 370         case "Member Function":
 371         case "Member Function RefReturn":
 372         case "Member Pointer Function":
 373         case "Weak/Shared Pointer Function":
 374         case "Weak/Shared Pointer Function RefReturn":
 375         case "Weak/Shared Null Check":
 376         case "Static Member Function":
 377                 checkclass ($b);
 378                 $classlist[luafn2class ($b['lua'])]['func'][] = array (
 379                         'bind' => $b,
 380                         'name' => $b['lua'],
 381                         'args' => decl2args ($b['ldec']),
 382                         'ret'  => arg2lua ($b['ret']),
 383                         'ref'  => (strpos ($b['type'], "RefReturn") !== false),
 384                         'cand' => canonical_decl ($b)
 385                 );
 386                 break;
 387         case "Weak/Shared Pointer Cast":
 388                 checkclass ($b);
 389                 $classlist[luafn2class ($b['lua'])]['cast'][] = array (
 390                         'bind' => $b,
 391                         'name' => $b['lua'],
 392                         'args' => decl2args ($b['ldec']),
 393                         'ret'  => arg2lua ($b['ret']),
 394                         'ref'  => (strpos ($b['type'], "RefReturn") !== false),
 395                         'cand' => canonical_decl ($b)
 396                 );
 397                 break;
 398         case "Constant/Enum":
 399         case "Constant/Enum Member":
 400                 # already handled -> $consts
 401                 break;
 402         default:
 403                 if (strpos ($b['type'], "[C] ") !== 0) {
 404                         my_die ('unhandled type: ' . $b['type']);
 405                 }
 406                 break;
 407         }
 408 }
 409
 410
 411 # step 4: collect/group/sort
 412
 413 # step 4a: unify weak/shared Ptr classes
 414 foreach ($classlist as $ns => $cl) {
 415         if (strpos ($cl['type'], ' Array') !== false) {
 416                 $classlist[$ns]['arr'] = true;
 417                 continue;
 418         }
 419         foreach ($classes as $c) {
 420                 if ($c['lua'] == $ns) {
 421                         if (strpos ($c['type'], 'Pointer Class') !== false) {
 422                                 $classlist[$ns]['ptr'] = true;
 423                                 $classlist[$ns]['decl'] = 'boost::shared_ptr< '.$c['decl']. ' >, boost::weak_ptr< '.$c['decl']. ' >';
 424                                 break;
 425                         }
 426                 }
 427         }
 428 }
 429
 430 # step4b: sanity check
 431 foreach ($classlist as $ns => $cl) {
 432         if (isset ($classes[$ns]['parent']) && !isset ($classlist[$ns]['luaparent'])) {
 433                 my_die ('missing parent class: ' . print_r ($cl, true));
 434         }
 435 }
 436
 437 # step 4c: merge free functions into classlist
 438 foreach ($funclist as $ns => $fl) {
 439         if (isset ($classlist[$ns])) {
 440                 my_die ('Free Funcion in existing namespace: '.$ns.' '. print_r ($ns, true));
 441         }
 442         $classlist[$ns]['func'] = $fl;
 443         $classlist[$ns]['free'] = true;
 444 }
 445
 446 # step 4d: order to chaos
 447 # no array_multisort() here, sub-types are sorted after merging parents
 448 ksort ($classlist);
 449
 450
 451 ################################################################################
 452 ################################################################################
 453 ################################################################################
 454
 455
 456 #### -- split here --  ####
 457
 458 # from here on, only $classlist and $constlist arrays are relevant.
 459 # we also pull in C++ header annotation from doxygen to $api
 460
 461
 462 # read documentation from doxygen
 463 $json = gzdecode (file_get_contents (dirname (__FILE__).'/../doc/ardourapi.json.gz'));
 464 $api = array ();
 465 foreach (json_decode ($json, true) as $a) {
 466         if (!isset ($a['decl'])) { continue; }
 467         if (empty ($a['decl'])) { continue; }
 468         $canon = str_replace (' *', '*', $a['decl']);
 469         $api[$canon] = $a;
 470 }
 471
 472 # keep track of found/missing doc
 473 $dox_found = 0;
 474 $dox_miss = 0;
 475
 476 # retrive a value from $api
 477 function doxydoc ($canonical_declaration) {
 478         global $api;
 479         global $dox_found;
 480         global $dox_miss;
 481         if (isset ($api[$canonical_declaration])) {
 482                 $dox_found++;
 483                 return $api[$canonical_declaration]['doc'];
 484         } else {
 485                 $dox_miss++;
 486                 return '';
 487         }
 488 }
 489
 490 ################################################################################
 491 # OUTPUT
 492 ################################################################################
 493
 494
 495 ################################################################################
 496 # Helper functions
 497 define ('NL', "\n");
 498
 499 # constructors, enums (constants) use a dot.  (e.g. "LuaOSC.Address" -> "LuaOSC.Address" )
 500 function ctorname ($name) {
 501         return htmlentities (str_replace (':', '.', $name));
 502 }
 503
 504 # strip class prefix (e.g "Evoral:MidiEvent:channel"  -> "channel")
 505 function shortname ($name) {
 506         return htmlentities (substr ($name, strrpos ($name, ':') + 1));
 507 }
 508
 509 # retrieve variable name from    array["VARNAME"] => FLAGS
 510 function varname ($a) {
 511         return array_keys ($a)[0];
 512 }
 513
 514 # recusively collect class parents (derived classes)
 515 function traverse_parent ($ns, &$inherited) {
 516         global $classlist;
 517         $rv = '';
 518         if (isset ($classlist[$ns]['luaparent'])) {
 519                 $parents = array_unique ($classlist[$ns]['luaparent']);
 520                 asort ($parents);
 521                 foreach ($parents as $p) {
 522                         if (!empty ($rv)) { $rv .= ', '; }
 523                         $rv .= typelink ($p);
 524                         $inherited[$p] = $classlist[$p];
 525                         traverse_parent ($p, $inherited);
 526                 }
 527         }
 528         return $rv;
 529 }
 530
 531 # create a cross-reference to a type (class or enum)
 532 # *all* <a> links are generated here, currently anchors on a single page.
 533 function typelink ($a, $short = false, $argcls = '', $linkcls = '', $suffix = '') {
 534         global $classlist;
 535         global $constlist;
 536         if (isset($classlist[$a]['free'])) {
 537                 return '<a class="'.$linkcls.'" href="#'.htmlentities ($a).'">'.($short ? shortname($a) : ctorname($a)).$suffix.'</a>';
 538         } else if (in_array ($a, array_keys ($classlist))) {
 539                 return '<a class="'.$linkcls.'" href="#'.htmlentities($a).'">'.($short ? shortname($a) : htmlentities($a)).$suffix.'</a>';
 540         } else if (in_array ($a, array_keys ($constlist))) {
 541                 return '<a class="'.$linkcls.'" href="#'.ctorname ($a).'">'.($short ? shortname($a) : ctorname($a)).$suffix.'</a>';
 542         } else {
 543                 return '<span class="'.$argcls.'">'.htmlentities($a).$suffix.'</span>';
 544         }
 545 }
 546
 547 # output format function arguments
 548 function format_args ($args) {
 549         $rv = '<span class="functionargs"> (';
 550         $first = true;
 551         foreach ($args as $a) {
 552                 if (!$first) { $rv .= ', '; }; $first = false;
 553                 $flags = $a[varname ($a)];
 554                 if ($flags & 2) {
 555                         $rv .= '<em>LuaTable</em> {'.typelink (varname ($a), true, 'em').'}';
 556                 }
 557                 elseif ($flags & 1) {
 558                         $rv .= typelink (varname ($a), true, 'em', '', '&amp;');
 559                 }
 560                 else {
 561                         $rv .= typelink (varname ($a), true, 'em');
 562                 }
 563         }
 564         $rv .= ')</span>';
 565         return $rv;
 566 }
 567
 568 # format doxygen documentation for class-definition
 569 function format_doxyclass ($cl) {
 570         $rv = '';
 571         if (isset ($cl['decl'])) {
 572                 $doc = doxydoc ($cl['decl']);
 573                 if (!empty ($doc)) {
 574                         $rv.= '<div class="classdox">'.$doc.'</div>'.NL;
 575                 }
 576         }
 577         return $rv;
 578 }
 579
 580 # format doxygen documentation for class-members
 581 function format_doxydoc ($f) {
 582         $rv = '';
 583         if (isset ($f['cand'])) {
 584                 $doc = doxydoc ($f['cand']);
 585                 if (!empty ($doc)) {
 586                         $rv.= '<tr><td></td><td class="doc" colspan="2"><div class="dox">'.$doc;
 587                         $rv.= '</div></td></tr>'.NL;
 588                 } else if (0) { # debug
 589                         $rv.= '<tr><td></td><td class="doc" colspan="2"><p>'.htmlentities($f['cand']).'</p>';
 590                         $rv.= '</td></tr>'.NL;
 591                 }
 592         }
 593         return $rv;
 594 }
 595
 596 # usort() callback for class-members
 597 function name_sort_cb ($a, $b) {
 598         return strcmp ($a['name'], $b['name']);
 599 }
 600
 601 # main output function for every class
 602 function format_class_members ($ns, $cl, &$dups) {
 603         $rv = '';
 604         # print contructor - if any
 605         if (isset ($cl['ctor'])) {
 606                 usort ($cl['ctor'], 'name_sort_cb');
 607                 $rv.= ' <tr><th colspan="3">Constructor</th></tr>'.NL;
 608                 foreach ($cl['ctor'] as $f) {
 609                         $rv.= ' <tr><td class="def">&Copf;</td><td class="decl">';
 610                         $rv.= '<span class="functionname">'.ctorname ($f['name']).'</span>';
 611                         $rv.= format_args ($f['args']);
 612                         $rv.= '</td><td class="fill"></td></tr>'.NL;
 613                         # doxygen documentation (may be empty)
 614                         $rv.= format_doxydoc($f);
 615                 }
 616         }
 617
 618         # strip duplicates (inherited or derived methods)
 619         # e.g  AudioTrack -> Track -> Route -> SessionObject -> Stateful
 620         # all 5 have "isnil()"
 621         $nondups = array ();
 622         if (isset ($cl['func'])) {
 623                 foreach ($cl['func'] as $f) {
 624                         if (in_array (stripclass ($ns, $f['name']), $dups)) { continue; }
 625                         $nondups[] = $f;
 626                 }
 627         }
 628
 629         # print methods - if any
 630         if (count ($nondups) > 0) {
 631                 usort ($nondups, 'name_sort_cb');
 632                 $rv.= ' <tr><th colspan="3">Methods</th></tr>'.NL;
 633                 foreach ($nondups as $f) {
 634                         $dups[] = stripclass ($ns, $f['name']);
 635                         # return value/type
 636                         $rv.= ' <tr><td class="def">';
 637                         if ($f['ref'] && isset ($f['ext'])) {
 638                                 # external C functions
 639                                 $rv.= '<em>'.varname ($f['ret']).'</em>';
 640                         } elseif ($f['ref'] && varname ($f['ret']) == 'void') {
 641                                 # void functions with reference args
 642                                 $rv.= '<em>LuaTable</em>(...)';
 643                         } elseif ($f['ref']) {
 644                                 # functions with reference args and return value
 645                                 $rv.= '<em>LuaTable</em>('.typelink (varname ($f['ret']), true, 'em').', ...)';
 646                         } else {
 647                                 # normal class members
 648                                 $rv.= typelink (varname ($f['ret']), true, 'em');
 649                         }
 650                         # function declaration and arguments
 651                         $rv.= '</td><td class="decl">';
 652                         $rv.= '<span class="functionname"><abbr title="'.htmlentities($f['bind']['decl']).'">'.stripclass ($ns, $f['name']).'</abbr></span>';
 653                         $rv.= format_args ($f['args']);
 654                         $rv.= '</td><td class="fill"></td></tr>'.NL;
 655                         # doxygen documentation (may be empty)
 656                         $rv.= format_doxydoc($f);
 657                 }
 658         }
 659         # print cast - if any
 660         if (isset ($cl['cast'])) {
 661                 usort ($cl['cast'], 'name_sort_cb');
 662                 $rv.= ' <tr><th colspan="3">Cast</th></tr>'.NL;
 663                 foreach ($cl['cast'] as $f) {
 664                         $rv.= ' <tr><td class="def">';
 665                         $rv.= typelink (varname ($f['ret']), true, 'em');
 666                         # function declaration and arguments
 667                         $rv.= '</td><td class="decl">';
 668                         $rv.= '<span class="functionname"><abbr title="'.htmlentities($f['bind']['decl']).'">'.stripclass ($ns, $f['name']).'</abbr></span>';
 669                         $rv.= format_args ($f['args']);
 670                         $rv.= '</td><td class="fill"></td></tr>'.NL;
 671                         # doxygen documentation (may be empty)
 672                         $rv.= format_doxydoc($f);
 673                 }
 674         }
 675
 676         # print data members - if any
 677         if (isset ($cl['data'])) {
 678                 usort ($cl['data'], 'name_sort_cb');
 679                 $rv.= ' <tr><th colspan="3">Data Members</th></tr>'.NL;
 680                 foreach ($cl['data'] as $f) {
 681                         $rv.= ' <tr><td class="def">'.typelink (array_keys ($f['ret'])[0], false, 'em').'</td><td class="decl">';
 682                         $rv.= '<span class="functionname">'.stripclass ($ns, $f['name']).'</span>';
 683                         $rv.= '</td><td class="fill"></td></tr>'.NL;
 684                 }
 685         }
 686         return $rv;
 687 }
 688
 689
 690 ################################################################################
 691 # Start Output
 692
 693 if ($HTMLOUTPUT) {
 694
 695 ?><!DOCTYPE html>
 696 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 697 <head>
 698 <title>Ardour Lua Bindings</title>
 699 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 700 <style type="text/css">
 701 div.header         { text-align:center; }
 702 div.header h2      { margin:0; }
 703 div.header p       { margin:.25em; text-align:center; }
 704 div.luafooter      { text-align:center; font-size:80%; color: #888; margin: 2em 0; }
 705 #luaref            { max-width:60em; margin: 1em auto; }
 706
 707 #luaref h2                 { margin:2em 0 0 0; padding:0em; border-bottom: 1px solid black; }
 708 #luaref h3.cls             { margin:2em 0 0 0; padding: 0 0 0 1em; border: 1px dashed #6666ee; }
 709 #luaref h3.cls abbr        { text-decoration:none; cursor:default; }
 710 #luaref h4.cls             { margin:1em 0 0 0; }
 711 #luaref h3.class           { background-color: #aaee66; }
 712 #luaref h3.enum            { background-color: #aaaaaa; }
 713 #luaref h3.pointerclass    { background-color: #eeaa66; }
 714 #luaref h3.array           { background-color: #66aaee; }
 715 #luaref h3.opaque          { background-color: #6666aa; }
 716 #luaref p                  { text-align: justify; }
 717 #luaref p.cdecl            { text-align: right; float:right; font-size:90%; margin:0; padding: 0 0 0 1em; }
 718 #luaref ul.classindex      { columns: 2; -webkit-columns: 2; -moz-columns: 2; }
 719 #luaref div.clear          { clear:both; }
 720 #luaref p.classinfo        { margin: .25em 0; }
 721 #luaref div.code           { width:80%; margin:.5em auto; }
 722 #luaref div.code div       { width:45%; }
 723 #luaref div.code pre       { line-height: 1.2em; margin: .25em 0; }
 724 #luaref div.code samp      { color: green; font-weight: bold; background-color: #eee; }
 725 #luaref div.classdox       { padding: .1em 1em; }
 726 #luaref div.classdox p     { margin: .5em 0 .5em .6em; }
 727 #luaref div.classdox p     { margin: .5em 0 .5em .6em; }
 728 #luaref div.classdox       { padding: .1em 1em; }
 729 #luaref div.classdox p     { margin: .5em 0 .5em .6em; }
 730 #luaref table.classmembers { width: 100%; }
 731 #luaref table.classmembers th      { text-align:left; border-bottom:1px solid black; padding-top:1em; }
 732 #luaref table.classmembers td.def  { text-align:right; padding-right:.5em;  white-space: nowrap; }
 733 #luaref table.classmembers td.decl { text-align:left; padding-left:.5em; white-space: nowrap; }
 734 #luaref table.classmembers td.doc  { text-align:left; padding-left:.6em; line-height: 1.2em; font-size:80%; }
 735 #luaref table.classmembers td.doc div.dox {background-color:#eee; padding: .1em 1em; }
 736 #luaref table.classmembers td.doc p { margin: .5em 0; }
 737 #luaref table.classmembers td.doc p.para-brief { font-size:120%; }
 738 #luaref table.classmembers td.doc p.para-returns { font-size:120%; }
 739 #luaref table.classmembers td.doc dl { font-size:120%; line-height: 1.3em; }
 740 #luaref table.classmembers td.doc dt { font-style: italic; }
 741 #luaref table.classmembers td.fill { width: 99%; }
 742 #luaref table.classmembers span.em { font-style: italic; }
 743 #luaref span.functionname abbr     { text-decoration:none; cursor:default; }
 744 </style>
 745 </head>
 746 <body>
 747 <div class="header">
 748 <h2>Ardour Lua Bindings</h2>
 749 <p>
 750 <a href="#h_classes">Class Documentation</a>
 751 &nbsp;|&nbsp;
 752 <a href="#h_enum">Enum/Constants</a>
 753 &nbsp;|&nbsp;
 754 <a href="#h_index">Index</a>
 755 </p>
 756 </div>
 757
 758 <!-- #### SNIP #### !-->
 759
 760 <?php
 761
 762 } else {
 763
 764 ?>
 765 ---
 766 layout: default
 767 style: luadoc
 768 title: Class Reference
 769 ---
 770
 771 <p class="warning">
 772 This documention is far from complete may be inaccurate and subject to change.
 773 </p>
 774
 775 <?php
 776 }
 777 ?>
 778
 779 <div id="luaref">
 780
 781 <?php
 782
 783 ################################################################################
 784 # some general documentation -- should really go elsehere
 785
 786 ?>
 787
 788 <h2 id="h_intro">Overview</h2>
 789 <p>
 790 The top-level entry point are <?=typelink('ARDOUR:Session')?> and <?=typelink('ArdourUI:Editor')?>.
 791 Most other Classes are used indirectly starting with a Session function. e.g. Session:get_routes().
 792 </p>
 793 <p>
 794 A few classes are dedicated to certain script types, e.g. Lua DSP processors have exclusive access to
 795 <?=typelink('ARDOUR:DSP')?> and <?=typelink('ARDOUR:ChanMapping')?>. Action Hooks Scripts to
 796 <?=typelink('LuaSignal:Set')?> etc.
 797 </p>
 798 <p>
 799 Detailed documentation (parameter names, method description) is not yet available. Please stay tuned.
 800 </p>
 801 <h3>Short introduction to Ardour classes</h3>
 802 <p>
 803 Ardour's structure is object oriented. The main object is the Session. A Session contains Audio Tracks, Midi Tracks and Busses.
 804 Audio and Midi tracks are derived from a more general "Track" Object,  which in turn is derived from a "Route" (aka Bus).
 805 (We say "An Audio Track <em>is-a</em> Track <em>is-a</em> Route").
 806 Tracks contain specifics. For Example a track <em>has-a</em> diskstream (for file i/o).
 807 </p>
 808 <p>
 809 Operations are performed on objects. One gets a reference to an object and then calls a method.
 810 e.g <code>obj = Session:route_by_name("Audio")   obj:set_name("Guitar")</code>.
 811 </p>
 812 <p>
 813 Lua automatically follows C++ class inheritance. e.g one can directly call all SessionObject and Route methods on Track object. However lua does not automatically promote objects. A Route object which just happens to be a Track needs to be explicily cast to a Track. Methods for casts are provided with each class. Note that the cast may fail and return a <em>nil</em> reference.
 814 </p>
 815 <p>
 816 Likewise multiple inheritance is a <a href="http://www.lua.org/pil/16.3.html">non-trivial issue</a> in lua. To avoid performance penalties involved with lookups, explicit casts are required in this case. One example is <?=typelink('ARDOUR:SessionObject')?> which is-a StatefulDestructible which inhertis from both Stateful and Destructible.
 817 </p>
 818 <p>
 819 Object lifetimes are managed by the Session. Most Objects cannot be directly created, but one asks the Session to create or destroy them. This is mainly due to realtime constrains:
 820 you cannot simply remove a track that is currently processing audio. There are various <em>factory</em> methods for object creation or removal.
 821 </p>
 822 <h3>Pass by Reference</h3>
 823 <p>
 824 Since lua functions are closures, C++ methods that pass arguments by reference cannot be used as-is.
 825 All parameters passed to a C++ method which uses references are returned as Lua Table.
 826 If the C++ method also returns a value it is prefixed. Two parameters are returned: the value and a Lua Table holding the parameters.
 827 </p>
 828
 829 <div class="code">
 830         <div style="float:left;">C++
 831
 832 <pre><code class="cxx">void set_ref (int&amp; var, long&amp; val)
 833 {
 834         printf ("%d %ld\n", var, val);
 835         var = 5;
 836         val = 7;
 837 }
 838 </code></pre>
 839
 840         </div>
 841         <div style="float:right;">Lua
 842
 843 <pre><code class="lua">local var = 0;
 844 ref = set_ref (var, 2);
 845 -- output from C++ printf()
 846 </code><samp class="lua">0 2</samp><code>
 847 -- var is still 0 here
 848 print (ref[1], ref[2])
 849 </code><samp class="lua">5 7</samp></pre>
 850
 851         </div>
 852 </div>
 853 <div class="clear"></div>
 854 <div class="code">
 855         <div style="float:left;">
 856
 857 <pre><code class="cxx">int set_ref2 (int &amp;var, std::string unused)
 858 {
 859         var = 5;
 860         return 3;
 861 }
 862 </code></pre>
 863
 864         </div>
 865         <div style="float:right;">
 866 <pre><code class="lua">rv, ref = set_ref2 (0, "hello");
 867 print (rv, ref[1], ref[2])
 868 </code><samp class="lua">3 5 hello</samp></pre>
 869         </div>
 870 </div>
 871 <div class="clear"></div>
 872
 873 <h3>Pointer Classes</h3>
 874 <p>
 875 Libardour makes extensive use of reference counted <code>boost::shared_ptr</code> to manage lifetimes.
 876 The Lua bindings provide a complete abstration of this. There are no pointers in lua.
 877 For example a <?=typelink('ARDOUR:Route')?> is a pointer in C++, but lua functions operate on it like it was a class instance.
 878 </p>
 879 <p>
 880 <code>shared_ptr</code> are reference counted. Once assigned to a lua variable, the C++ object will be kept and remains valid.
 881 It is good practice to assign references to lua <code>local</code> variables or reset the variable to <code>nil</code> to drop the ref.
 882 </p>
 883 <p>
 884 All pointer classes have a <code>isnil ()</code> method. This is for two cases:
 885 Construction may fail. e.g. <code><?=typelink('ARDOUR:LuaAPI')?>.newplugin()</code>
 886 may not be able to find the given plugin and hence cannot create an object.
 887 </p>
 888 <p>
 889 The second case if for <code>boost::weak_ptr</code>. As opposed to <code>boost::shared_ptr</code> weak-pointers are not reference counted.
 890 The object may vanish at any time.
 891 If lua code calls a method on a nil object, the interpreter will raise an exception and the script will not continue.
 892 This is not unlike <code>a = nil a:test()</code> which results in en error "<em>attempt to index a nil value</em>".
 893 </p>
 894 <p>
 895 From the lua side of things there is no distinction between weak and shared pointers. They behave identically.
 896 Below they're inidicated in orange and have an arrow to indicate the pointer type.
 897 Pointer Classes cannot be created in lua scripts. It always requires a call to C++ to create the Object and obtain a reference to it.
 898 </p>
 899
 900
 901 <?php
 902
 903 #################################
 904 # Main output function -- Classes
 905
 906 echo '<h2 id="h_classes">Class Documentation</h2>'.NL;
 907 foreach ($classlist as $ns => $cl) {
 908         $dups = array ();
 909         $tbl =  format_class_members ($ns, $cl, $dups);
 910
 911         # format class title - depending on type
 912         if (empty ($tbl)) {
 913                 # classes with no members (no ctor, no methods, no data)
 914                 echo '<h3 id="'.htmlentities ($ns).'" class="cls opaque"><abbr title="Opaque Object">&empty;</abbr>&nbsp;'.htmlentities ($ns).'</h3>'.NL;
 915         }
 916         else if (isset ($classlist[$ns]['free'])) {
 917                 # free functions (no class)
 918                 echo '<h3 id="'.htmlentities ($ns).'" class="cls freeclass"><abbr title="Namespace">&Nopf;</abbr>&nbsp;'.ctorname($ns).'</h3>'.NL;
 919         }
 920         else if (isset ($classlist[$ns]['arr'])) {
 921                 # C Arrays
 922                 echo '<h3 id="'.htmlentities ($ns).'" class="cls array"><abbr title="C Array">&ctdot;</abbr>&nbsp;'.htmlentities ($ns).'</h3>'.NL;
 923         }
 924         else if (isset ($classlist[$ns]['ptr'])) {
 925                 # Pointer Classes
 926                 echo '<h3 id="'.htmlentities ($ns).'" class="cls pointerclass"><abbr title="Pointer Class">&Rarr;</abbr>&nbsp;'. htmlentities ($ns).'</h3>'.NL;
 927         }
 928         else {
 929                 # Normal Class
 930                 echo '<h3 id="'.htmlentities ($ns).'" class="cls class"><abbr title="Class">&comp;</abbr>&nbsp;'.htmlentities ($ns).'</h3>'.NL;
 931         }
 932
 933         # show original C++ declaration
 934         if (isset ($cl['decl'])) {
 935                 echo '<p class="cdecl"><em>C&#8225;</em>: '.htmlentities ($cl['decl']).'</p>'.NL;
 936         }
 937
 938         # print class inheritance (direct parent *name* only)
 939         $inherited = array ();
 940         $isa = traverse_parent ($ns, $inherited);
 941         if (!empty ($isa)) {
 942                 echo ' <p class="classinfo">is-a: '.$isa.'</p>'.NL;
 943         }
 944         echo '<div class="clear"></div>'.NL;
 945
 946
 947         # class documentation (if any)
 948         echo format_doxyclass ($cl);
 949
 950         # member documentation
 951         if (empty ($tbl)) {
 952                 echo '<p class="classinfo">This class object is only used indirectly as return-value and function-parameter. It provides no methods by itself.</p>'.NL;
 953         } else {
 954                 echo '<table class="classmembers">'.NL;
 955                 echo $tbl;
 956                 echo ' </table>'.NL;
 957         }
 958
 959         # traverse parent classes (all inherited members)
 960         foreach ($inherited as $pns => $pcl) {
 961                 $tbl = format_class_members ($pns, $pcl, $dups);
 962                 if (!empty ($tbl)) {
 963                         echo '<h4 class="cls">Inherited from '.$pns.'</h4>'.NL;
 964                         echo '<table class="classmembers">'.NL;
 965                         echo $tbl;
 966                         echo '</table>'.NL;
 967                 }
 968         }
 969 }
 970
 971 ####################
 972 # Enum and Constants
 973
 974 echo '<h2 id="h_enum">Enum/Constants</h2>'.NL;
 975 foreach ($constlist as $ns => $cs) {
 976         echo '<h3 id="'.ctorname ($ns).'" class="cls enum"><abbr title="Enum">&isin;</abbr>&nbsp;'.ctorname ($ns).'</h3>'.NL;
 977         echo '<ul class="enum">'.NL;
 978         foreach ($cs as $c) {
 979                 echo '<li class="const">'.ctorname ($c['lua']).'</li>'.NL;
 980         }
 981         echo '</ul>'.NL;
 982 }
 983
 984 ######################
 985 # Index of all classes
 986
 987 echo '<h2 id="h_index" >Class Index</h2>'.NL;
 988 echo '<ul class="classindex">'.NL;
 989 foreach ($classlist as $ns => $cl) {
 990         echo '<li>'.typelink($ns).'</li>'.NL;
 991 }
 992 echo '</ul>'.NL;
 993
 994
 995 # see how far there is still to go...
 996 fwrite (STDERR, "Found $dox_found annotations. missing: $dox_miss\n");
 997 echo '<!-- '.$dox_found.' / '.$dox_miss.' !-->'.NL;
 998
 999 ?>
1000 </div>
1001 <div class="luafooter">Ardour <?=$ardourversion?> &nbsp;-&nbsp; <?=date('r')?></div>
1002 <?php
1003
1004 if ($HTMLOUTPUT) {
1005         echo '<!-- #### SNIP #### !-->'.NL;
1006         echo '</body>'.NL;
1007         echo '</html>'.NL;
1008 }