5 ## generate doc/luadoc.json.gz (lua binding doc)
6 # ./waf configure --luadoc ....
8 # ./gtk2_ardour/arluadoc > doc/luadoc.json.gz
10 ## generate doc/ardourapi.json.gz (ardour header doxygen doc)
11 # cd ../../tools/doxy2json
15 ## format HTML (using this scripterl)
16 # php tools/fmt-luadoc.php > /tmp/luadoc.html
19 $options = getopt("m");
20 if (isset ($options['m'])) {
21 $HTMLOUTPUT = false; ## set to false to output ardour-manual
23 $HTMLOUTPUT = true; ## set to false to output ardour-manual
26 ################################################################################
27 ################################################################################
29 $json = gzdecode (file_get_contents (dirname (__FILE__).'/../doc/luadoc.json.gz'));
32 foreach (json_decode ($json, true) as $b) {
33 if (!isset ($b['type'])) {
34 if (isset ($b['version'])) { $ardourversion = $b['version']; }
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 $b ['ldec'] = preg_replace ('/_VampHost::/', '', $b['ldec']);
42 $b ['decl'] = preg_replace ('/_VampHost::/', '', $b['decl']);
43 if (isset ($b['ret'])) {
44 $b['ret'] = preg_replace ('/ const/', '', preg_replace ('/ const&/', '', $b['ret']));
45 $b['ret'] = preg_replace ('/_VampHost::/', '', $b['ret']);
47 if (isset ($b['parent'])) {
48 $b ['parent'] = preg_replace ('/_VampHost::/', '', $b['parent']);
53 if (count ($doc) == 0) {
54 fwrite (STDERR, "Failed to read luadoc.json\n");
58 ################################################################################
59 ## Global result variables
60 ################################################################################
62 $classlist = array ();
63 $constlist = array ();
66 ################################################################################
67 ## Pre-process the data, collect functions, parse arguments, cross reference
68 ################################################################################
71 ################################################################################
72 # some internal helper functions first
78 function my_die ($msg) {
79 fwrite (STDERR, $msg."\n");
83 ##function ptr_strip ($ctype) {
84 # # boost::shared_ptr<std::list<boost::shared_ptr<ARDOUR::Route>> > >
85 # # -> std::list<ARDOUR::Route>
86 # $ctype = preg_replace ('/boost::shared_ptr<([^>]*)[ ]*>/', '$1', $ctype);
87 # return preg_replace ('/boost::shared_ptr<([^>]*)[ ]*>/', '$1', $ctype);
90 function arg2lua ($argtype, $flags = 0) {
94 # LuaBridge abstracts C++ references
95 $flags |= preg_match ('/&$/', $argtype);
96 $arg = preg_replace ('/&$/', '', $argtype);
97 $arg = preg_replace ('/ $/', '', $arg);
99 # filter out basic types
100 $builtin = array ('float', 'double', 'bool', 'std::string', 'int', 'short', 'long', 'unsigned int', 'unsigned short', 'unsigned long', 'unsigned char', 'char', 'void', 'char*', 'unsigned char*', 'void*');
101 if (in_array ($arg, $builtin)) {
102 return array ($arg => $flags);
105 if ($arg == 'luabridge::LuaRef') {
106 return array ('Lua-Function' => $flags | 4);
109 # check Class declarations first
110 foreach (array_merge ($classes, $consts) as $b) {
111 if ($b['ldec'] == $arg) {
112 return array ($b['lua'] => $flags);
116 # strip class pointers -- TODO Check C'tor for given class
117 $arg = preg_replace ('/[&*]*$/', '', $argtype);
118 foreach (array_merge ($classes, $consts) as $b) {
119 if ($b['ldec'] == $arg) {
120 return array ($b['lua'] => $flags);
124 return array ($argtype => ($flags | 4));
126 return array ('--MISSING (' . $argtype . ')--' => ($flags | 4));
130 function stripclass ($classname, $name) {
132 if (strpos ($name, $classname) !== 0) {
133 my_die ('invalid class prefix: ' .$classname. ' -- '. $name);
135 return substr ($name, strlen ($classname));
138 function datatype ($decl) {
139 # TODO handle spaces in type. Works because
140 # we don't yet have templated types (with_space <here >)
141 return substr ($decl, 0, strrpos ($decl, ' '));
144 function luafn2class ($lua) {
145 return substr ($lua, 0, strrpos ($lua, ':'));
148 function luafn2name ($lua) {
149 $fn = strrpos ($lua, ':');
150 if ($fn !== 0 && strlen($lua) > $fn + 1) {
151 return substr ($lua, $fn + 1);
153 my_die ('invalid class prefix: '. $name);
157 function checkclass ($b) {
159 if (!isset ($classlist[luafn2class ($b['lua'])])) {
160 my_die ('MISSING CLASS FOR '. print_r ($b['lua'], true));
164 # parse functions argument list to lua-names
165 function decl2args ($decl) {
166 $start = strrpos ($decl, '(');
167 $end = strrpos ($decl, ')');
168 $args = substr ($decl, $start + 1, $end - $start - 1);
169 $arglist = preg_split ('/, */', $args);
171 foreach ($arglist as $a) {
172 if (empty ($a)) { continue; }
173 $rv[] = arg2lua ($a);
178 function canonical_ctor ($b) {
180 if (preg_match('/[^(]*\(([^)*]*)\*\)(\(.*\))/', $b['decl'], $matches)) {
181 $lc = luafn2class ($b['lua']);
182 $cn = str_replace (':', '::', $lc);
183 $fn = substr ($lc, 1 + strrpos ($lc, ':'));
184 $rv = $cn . '::'. $fn . $matches[2];
189 function canonical_decl ($b) {
192 # match clang's declatation format
193 if (preg_match('/[^(]*\(([^)*]*)\*\)\((.*)\)/', $b['decl'], $matches)) {
194 if (strpos ($b['type'], 'Free Function') !== false) {
195 $pfx = str_replace (':', '::', luafn2class ($b['lua'])) . '::';
197 $fn = substr ($b['lua'], 1 + strrpos ($b['lua'], ':'));
198 $rv = $matches[1] . $fn . '(';
199 $arglist = preg_split ('/, */', $matches[2]);
201 foreach ($arglist as $a) {
202 if (!$first) { $rv .= ', '; }; $first = false;
203 if (empty ($a)) { continue; }
204 $a = preg_replace ('/([^>]) >/', '$1>', $a);
205 $a = preg_replace ('/^Cairo::/', '', $a); // special case cairo enums
206 $a = preg_replace ('/([^ ])&/', '$1 &', $a);
207 $a = preg_replace ('/std::vector<([^>]*)> const/', 'const std::vector<$1>', $a);
208 $a = str_replace ('std::vector', 'vector', $a);
209 $a = str_replace ('vector', 'std::vector', $a);
210 $a = str_replace ('std::string', 'string', $a);
211 $a = str_replace ('string const', 'const string', $a);
212 $a = str_replace ('string', 'std::string', $a);
220 ################################################################################
221 # step 1: build class indices
223 foreach ($doc as $b) {
224 if (strpos ($b['type'], "[C] ") === 0) {
226 $classlist[$b['lua']] = $b;
227 if (strpos ($b['type'], 'Pointer Class') === false) {
228 $classdecl[$b['ldec']] = $b;
233 foreach ($classes as $c) {
234 if (strpos ($c['type'], 'Pointer Class') !== false) { continue; }
235 if (isset ($c['parent'])) {
236 if (isset ($classdecl[$c['parent']])) {
237 $classlist[$c['lua']]['luaparent'][] = $classdecl[$c['parent']]['lua'];
239 my_die ('unknown parent class: ' . print_r ($c, true));
244 # step 2: extract constants/enum
245 foreach ($doc as $b) {
246 switch ($b['type']) {
247 case "Constant/Enum":
248 case "Constant/Enum Member":
249 if (strpos ($b['ldec'], '::') === false) {
250 # for extern c enums, use the Lua Namespace
251 $b['ldec'] = str_replace (':', '::', luafn2class ($b['lua']));
253 $ns = str_replace ('::', ':', $b['ldec']);
254 $constlist[$ns][] = $b;
264 # step 3: process functions
265 foreach ($doc as $b) {
266 switch ($b['type']) {
268 case "Weak/Shared Pointer Constructor":
270 $classlist[luafn2class ($b['lua'])]['ctor'][] = array (
271 'name' => luafn2class ($b['lua']),
272 'args' => decl2args ($b['ldec']),
273 'cand' => canonical_ctor ($b)
278 $classlist[luafn2class ($b['lua'])]['props'][] = array (
280 'ret' => arg2lua (datatype ($b['ldec']))
285 $classlist[luafn2class ($b['lua'])]['data'][] = array (
287 'ret' => arg2lua (datatype ($b['ldec']))
290 case "Static C Function":
292 if (strpos ($b['lua'], 'ARDOUR:DataType:') === 0) {
293 # special case ARDOUR:DataType convenience c'tor
295 $ret = array (luafn2class ($b['lua']) => 0);
296 $canon = 'ARDOUR::LuaAPI::datatype_ctor_'.strtolower (luafn2name ($b['lua'])).'(lua_State*)';
298 my_die ('unhandled Static C: ' . print_r($b, true));
300 $classlist[luafn2class ($b['lua'])]['func'][] = array (
311 # we required C functions to be in a class namespace
312 case "Ext C Function":
314 $args = array (array ('--lua--' => 0));
315 $ret = array ('...' => 0);
316 $ns = luafn2class ($b['lua']);
317 $cls = $classlist[$ns];
318 if (preg_match ('/.*<([^>]*)[ ]*>/', $cls['ldec'], $templ)) {
319 # std::vector, std::list types
320 switch (stripclass($ns, $b['lua'])) {
322 #$args = array (array ('LuaTable {'.$templ[1].'}' => 0));
323 $args = array (arg2lua ($templ[1], 2));
324 $ret = array ('LuaTable' => 0);
328 $ret = array ('LuaIter' => 0);
332 $ret = array ('LuaTable' => 0);
337 } else if (strpos ($cls['type'], ' Array') !== false) {
338 # catches C:FloatArray, C:IntArray
339 $templ = preg_replace ('/[&*]*$/', '', $cls['ldec']);
340 switch (stripclass($ns, $b['lua'])) {
343 $ret = array ('LuaMetaTable' => 0);
347 $ret = array ('LuaTable' => 0);
350 $args = array (array ('LuaTable {'.$templ.'}' => 0));
351 $ret = array ('void' => 0);
357 $classlist[luafn2class ($b['lua'])]['func'][] = array (
364 'cand' => canonical_decl ($b)
367 case "Free C Function":
368 $funclist[luafn2class ($b['lua'])][] = array (
375 'cand' => str_replace (':', '::', $b['lua']).'(lua_State*)'
378 case "Free Function":
379 case "Free Function RefReturn":
380 $funclist[luafn2class ($b['lua'])][] = array (
383 'args' => decl2args ($b['ldec']),
384 'ret' => arg2lua ($b['ret']),
385 'ref' => (strpos ($b['type'], "RefReturn") !== false),
386 'cand' => canonical_decl ($b)
389 case "Member Function":
390 case "Member Function RefReturn":
391 case "Member Pointer Function":
392 case "Weak/Shared Pointer Function":
393 case "Weak/Shared Pointer Function RefReturn":
394 case "Weak/Shared Null Check":
395 case "Static Member Function":
397 $classlist[luafn2class ($b['lua'])]['func'][] = array (
400 'args' => decl2args ($b['ldec']),
401 'ret' => arg2lua ($b['ret']),
402 'ref' => (strpos ($b['type'], "RefReturn") !== false),
403 'cand' => canonical_decl ($b)
407 case "Weak/Shared Pointer Cast":
409 $classlist[luafn2class ($b['lua'])]['cast'][] = array (
412 'args' => decl2args ($b['ldec']),
413 'ret' => arg2lua ($b['ret']),
414 'ref' => (strpos ($b['type'], "RefReturn") !== false),
415 'cand' => canonical_decl ($b)
418 case "Constant/Enum":
419 case "Constant/Enum Member":
420 # already handled -> $consts
423 if (strpos ($b['type'], "[C] ") !== 0) {
424 my_die ('unhandled type: ' . $b['type']);
431 # step 4: collect/group/sort
433 # step 4a: unify weak/shared Ptr classes
434 foreach ($classlist as $ns => $cl) {
435 if (strpos ($cl['type'], ' Array') !== false) {
436 $classlist[$ns]['arr'] = true;
437 $classlist[$ns]['cdecl'] = $cl['decl'];
440 foreach ($classes as $c) {
441 if ($c['lua'] == $ns) {
442 if (strpos ($c['type'], 'Pointer Class') !== false) {
443 $classlist[$ns]['ptr'] = true;
444 $classlist[$ns]['cdecl'] = 'boost::shared_ptr< '.$c['decl']. ' >, boost::weak_ptr< '.$c['decl']. ' >';
447 $classlist[$ns]['cdecl'] = $c['decl'];
453 # step4b: sanity check
454 foreach ($classlist as $ns => $cl) {
455 if (isset ($classes[$ns]['parent']) && !isset ($classlist[$ns]['luaparent'])) {
456 my_die ('missing parent class: ' . print_r ($cl, true));
460 # step 4c: merge free functions into classlist
461 foreach ($funclist as $ns => $fl) {
462 if (isset ($classlist[$ns])) {
463 my_die ('Free Funcion in existing namespace: '.$ns.' '. print_r ($ns, true));
465 $classlist[$ns]['func'] = $fl;
466 $classlist[$ns]['free'] = true;
469 # step 4d: order to chaos
470 # no array_multisort() here, sub-types are sorted after merging parents
474 ################################################################################
475 ################################################################################
476 ################################################################################
479 #### -- split here -- ####
481 # from here on, only $classlist and $constlist arrays are relevant.
482 # we also pull in C++ header annotation from doxygen to $api
485 # read documentation from doxygen
486 $json = gzdecode (file_get_contents (dirname (__FILE__).'/../doc/ardourapi.json.gz'));
488 foreach (json_decode ($json, true) as $a) {
489 if (!isset ($a['decl'])) { continue; }
490 if (empty ($a['decl'])) { continue; }
491 $canon = str_replace (' *', '*', $a['decl']);
495 # keep track of found/missing doc
499 # retrive a value from $api
500 function doxydoc ($canonical_declaration) {
504 if (isset ($api[$canonical_declaration])) {
506 return $api[$canonical_declaration]['doc'];
508 // remove template namespace e.g.
509 // "ARDOUR::Track::bounceable(boost::shared_ptr<ARDOUR::Processor>"
510 // "ARDOUR::Track::bounceable(boost::shared_ptr<Processor>"
511 $cn = preg_replace ('/<[^>]*::([^>]*)>/', '<$1>', $canonical_declaration);
512 if (isset ($api[$cn])) {
514 return $api[$cn]['doc'];
516 #fwrite (STDERR, $canonical_declaration."\n"); # XXX DEBUG
522 ################################################################################
524 ################################################################################
527 ################################################################################
531 # constructors, enums (constants) use a dot. (e.g. "LuaOSC.Address" -> "LuaOSC.Address" )
532 function ctorname ($name) {
533 return htmlentities (str_replace (':', '.', $name));
536 # strip class prefix (e.g "Evoral:MidiEvent:channel" -> "channel")
537 function shortname ($name) {
538 return htmlentities (substr ($name, strrpos ($name, ':') + 1));
541 # retrieve variable name from array["VARNAME"] => FLAGS
542 function varname ($a) {
543 return array_keys ($a)[0];
546 # recusively collect class parents (derived classes)
547 function traverse_parent ($ns, &$inherited) {
550 if (isset ($classlist[$ns]['luaparent'])) {
551 $parents = array_unique ($classlist[$ns]['luaparent']);
553 foreach ($parents as $p) {
554 if (!empty ($rv)) { $rv .= ', '; }
555 $rv .= typelink ($p);
556 $inherited[$p] = $classlist[$p];
557 traverse_parent ($p, $inherited);
563 # create a cross-reference to a type (class or enum)
564 # *all* <a> links are generated here, currently anchors on a single page.
565 function typelink ($a, $short = false, $argcls = '', $linkcls = '', $suffix = '') {
568 if (isset($classlist[$a]['free'])) {
569 return '<a class="'.$linkcls.'" href="#'.htmlentities ($a).'">'.($short ? shortname($a) : ctorname($a)).$suffix.'</a>';
570 } else if (in_array ($a, array_keys ($classlist))) {
571 return '<a class="'.$linkcls.'" href="#'.htmlentities($a).'">'.($short ? shortname($a) : htmlentities($a)).$suffix.'</a>';
572 } else if (in_array ($a, array_keys ($constlist))) {
573 return '<a class="'.$linkcls.'" href="#'.ctorname ($a).'">'.($short ? shortname($a) : ctorname($a)).$suffix.'</a>';
575 return '<span class="'.$argcls.'">'.htmlentities($a).$suffix.'</span>';
579 # output format function arguments
580 function format_args ($args) {
581 $rv = '<span class="functionargs"> (';
583 foreach ($args as $a) {
584 if (!$first) { $rv .= ', '; }; $first = false;
585 $flags = $a[varname ($a)];
587 $rv .= '<span>'.varname ($a).'</span>';
589 else if ($flags & 2) {
590 $rv .= '<em>LuaTable</em> {'.typelink (varname ($a), true, 'em').'}';
592 elseif ($flags & 1) {
593 $rv .= typelink (varname ($a), true, 'em', '', '&');
596 $rv .= typelink (varname ($a), true, 'em');
603 # format doxygen documentation for class-definition
604 function format_doxyclass ($cl) {
606 if (isset ($cl['decl'])) {
607 $doc = doxydoc ($cl['decl']);
609 $rv.= '<div class="classdox">'.$doc.'</div>'.NL;
615 # format doxygen documentation for class-members
616 function format_doxydoc ($f) {
618 if (isset ($f['cand'])) {
619 $doc = doxydoc ($f['cand']);
621 $rv.= '<tr><td></td><td class="doc" colspan="2"><div class="dox">'.$doc;
622 $rv.= '</div></td></tr>'.NL;
623 } else if (0) { # debug
624 $rv.= '<tr><td></td><td class="doc" colspan="2"><p>'.htmlentities($f['cand']).'</p>';
625 $rv.= '</td></tr>'.NL;
631 # usort() callback for class-members
632 function name_sort_cb ($a, $b) {
633 return strcmp ($a['name'], $b['name']);
636 # main output function for every class
637 function format_class_members ($ns, $cl, &$dups) {
639 # print contructor - if any
640 if (isset ($cl['ctor'])) {
641 usort ($cl['ctor'], 'name_sort_cb');
642 $rv.= ' <tr><th colspan="3">Constructor</th></tr>'.NL;
643 foreach ($cl['ctor'] as $f) {
644 $rv.= ' <tr><td class="def">ℂ</td><td class="decl">';
645 $rv.= '<span class="functionname">'.ctorname ($f['name']).'</span>';
646 $rv.= format_args ($f['args']);
647 $rv.= '</td><td class="fill"></td></tr>'.NL;
648 # doxygen documentation (may be empty)
649 $rv.= format_doxydoc($f);
653 # strip duplicates (inherited or derived methods)
654 # e.g AudioTrack -> Track -> Route -> SessionObject -> Stateful
655 # all 5 have "isnil()"
657 if (isset ($cl['func'])) {
658 foreach ($cl['func'] as $f) {
659 if (in_array (stripclass ($ns, $f['name']), $dups)) { continue; }
664 # print methods - if any
665 if (count ($nondups) > 0) {
666 usort ($nondups, 'name_sort_cb');
667 $rv.= ' <tr><th colspan="3">Methods</th></tr>'.NL;
668 foreach ($nondups as $f) {
669 $dups[] = stripclass ($ns, $f['name']);
671 $rv.= ' <tr><td class="def">';
672 if ($f['ref'] && isset ($f['ext'])) {
673 # external C functions
674 $rv.= '<em>'.varname ($f['ret']).'</em>';
675 } elseif ($f['ref'] && varname ($f['ret']) == 'void') {
676 # void functions with reference args
677 $rv.= '<em>LuaTable</em>(...)';
678 } elseif ($f['ref']) {
679 # functions with reference args and return value
680 $rv.= '<em>LuaTable</em>('.typelink (varname ($f['ret']), true, 'em').', ...)';
682 # normal class members
683 $rv.= typelink (varname ($f['ret']), true, 'em');
685 # function declaration and arguments
686 $rv.= '</td><td class="decl">';
687 $rv.= '<span class="functionname"><abbr title="'.htmlentities($f['bind']['decl']).'">'.stripclass ($ns, $f['name']).'</abbr></span>';
688 $rv.= format_args ($f['args']);
689 $rv.= '</td><td class="fill"></td></tr>'.NL;
690 # doxygen documentation (may be empty)
691 $rv.= format_doxydoc($f);
694 # print cast - if any
695 if (isset ($cl['cast'])) {
696 usort ($cl['cast'], 'name_sort_cb');
697 $rv.= ' <tr><th colspan="3">Cast</th></tr>'.NL;
698 foreach ($cl['cast'] as $f) {
699 $rv.= ' <tr><td class="def">';
700 $rv.= typelink (varname ($f['ret']), true, 'em');
701 # function declaration and arguments
702 $rv.= '</td><td class="decl">';
703 $rv.= '<span class="functionname"><abbr title="'.htmlentities($f['bind']['decl']).'">'.stripclass ($ns, $f['name']).'</abbr></span>';
704 $rv.= format_args ($f['args']);
705 $rv.= '</td><td class="fill"></td></tr>'.NL;
706 # doxygen documentation (may be empty)
707 $rv.= format_doxydoc($f);
711 # print properties - if any
712 if (isset ($cl['props'])) {
713 usort ($cl['props'], 'name_sort_cb');
714 $rv.= ' <tr><th colspan="3">Properties</th></tr>'.NL;
715 foreach ($cl['props'] as $f) {
716 $rv.= ' <tr><td class="def">'.typelink (array_keys ($f['ret'])[0], false, 'em').'</td><td class="decl">';
717 $rv.= '<span class="functionname">'.stripclass ($ns, $f['name']).'</span>';
718 $rv.= '</td><td class="fill"></td></tr>'.NL;
722 # print data members - if any
723 if (isset ($cl['data'])) {
724 usort ($cl['data'], 'name_sort_cb');
725 $rv.= ' <tr><th colspan="3">Data Members</th></tr>'.NL;
726 foreach ($cl['data'] as $f) {
727 $rv.= ' <tr><td class="def">'.typelink (array_keys ($f['ret'])[0], false, 'em').'</td><td class="decl">';
728 $rv.= '<span class="functionname">'.stripclass ($ns, $f['name']).'</span>';
729 $rv.= '</td><td class="fill"></td></tr>'.NL;
730 $f['cand'] = str_replace (':', '::', $f['name']);
731 $rv.= format_doxydoc($f);
738 ################################################################################
744 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
746 <title>Ardour Lua Bindings</title>
747 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
748 <style type="text/css">
749 div.header { text-align:center; }
750 div.header h2 { margin:0; }
751 div.header p { margin:.25em; text-align:center; }
752 div.luafooter { text-align:center; font-size:80%; color: #888; margin: 2em 0; }
753 #luaref { max-width:60em; margin: 1em auto; }
755 #luaref h2 { margin:2em 0 0 0; padding:0em; border-bottom: 1px solid black; }
756 #luaref h3.cls { margin:2em 0 0 0; padding: 0 0 0 1em; border: 1px dashed #6666ee; }
757 #luaref h3.cls abbr { text-decoration:none; cursor:default; }
758 #luaref h4.cls { margin:1em 0 0 0; }
759 #luaref h3.class { background-color: #aaee66; }
760 #luaref h3.enum { background-color: #aaaaaa; }
761 #luaref h3.pointerclass { background-color: #eeaa66; }
762 #luaref h3.array { background-color: #66aaee; }
763 #luaref h3.opaque { background-color: #6666aa; }
764 #luaref p { text-align: justify; }
765 #luaref p.cdecl { text-align: right; float:right; font-size:90%; margin:0; padding: 0 0 0 1em; }
766 #luaref ul.classindex { columns: 2; -webkit-columns: 2; -moz-columns: 2; }
767 #luaref div.clear { clear:both; }
768 #luaref p.classinfo { margin: .25em 0; }
769 #luaref div.code { width:80%; margin:.5em auto; }
770 #luaref div.code div { width:45%; }
771 #luaref div.code pre { line-height: 1.2em; margin: .25em 0; }
772 #luaref div.code samp { color: green; font-weight: bold; background-color: #eee; }
773 #luaref div.classdox { padding: .1em 1em; }
774 #luaref div.classdox p { margin: .5em 0 .5em .6em; }
775 #luaref div.classdox p { margin: .5em 0 .5em .6em; }
776 #luaref div.classdox { padding: .1em 1em; }
777 #luaref div.classdox p { margin: .5em 0 .5em .6em; }
778 #luaref table.classmembers { width: 100%; }
779 #luaref table.classmembers th { text-align:left; border-bottom:1px solid black; padding-top:1em; }
780 #luaref table.classmembers td.def { text-align:right; padding-right:.5em; white-space: nowrap; }
781 #luaref table.classmembers td.decl { text-align:left; padding-left:.5em; white-space: nowrap; }
782 #luaref table.classmembers td.doc { text-align:left; padding-left:.6em; line-height: 1.2em; font-size:80%; }
783 #luaref table.classmembers td.doc div.dox {background-color:#eee; padding: .1em 1em; }
784 #luaref table.classmembers td.doc p { margin: .5em 0; }
785 #luaref table.classmembers td.doc p.para-brief { font-size:120%; }
786 #luaref table.classmembers td.doc p.para-returns { font-size:120%; }
787 #luaref table.classmembers td.doc dl { font-size:120%; line-height: 1.3em; }
788 #luaref table.classmembers td.doc dt { font-style: italic; }
789 #luaref table.classmembers td.fill { width: 99%; }
790 #luaref table.classmembers span.em { font-style: italic; }
791 #luaref span.functionname abbr { text-decoration:none; cursor:default; }
796 <h2>Ardour Lua Bindings</h2>
798 <a href="#h_classes">Class Documentation</a>
800 <a href="#h_enum">Enum/Constants</a>
802 <a href="#h_index">Index</a>
806 <!-- #### SNIP #### !-->
816 title: Class Reference
820 This documentation is far from complete may be inaccurate and subject to change.
831 ################################################################################
832 # some general documentation -- should really go elsehere
836 <h2 id="h_intro">Overview</h2>
838 The top-level entry point are <?=typelink('ARDOUR:Session')?> and <?=typelink('ArdourUI:Editor')?>.
839 Most other Classes are used indirectly starting with a Session function. e.g. Session:get_routes().
842 A few classes are dedicated to certain script types, e.g. Lua DSP processors have exclusive access to
843 <?=typelink('ARDOUR:DSP')?> and <?=typelink('ARDOUR:ChanMapping')?>. Action Hooks Scripts to
844 <?=typelink('LuaSignal:Set')?> etc.
847 Detailed documentation (parameter names, method description) is not yet available. Please stay tuned.
849 <h3>Short introduction to Ardour classes</h3>
851 Ardour's structure is object oriented. The main object is the Session. A Session contains Audio Tracks, Midi Tracks and Busses.
852 Audio and Midi tracks are derived from a more general "Track" Object, which in turn is derived from a "Route" (aka Bus).
853 (We say "An Audio Track <em>is-a</em> Track <em>is-a</em> Route").
854 Tracks contain specifics. For Example a track <em>has-a</em> diskstream (for file i/o).
857 Operations are performed on objects. One gets a reference to an object and then calls a method.
858 e.g <code>obj = Session:route_by_name("Audio") obj:set_name("Guitar")</code>.
861 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.
864 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.
867 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:
868 you cannot simply remove a track that is currently processing audio. There are various <em>factory</em> methods for object creation or removal.
870 <h3>Pass by Reference</h3>
872 Since lua functions are closures, C++ methods that pass arguments by reference cannot be used as-is.
873 All parameters passed to a C++ method which uses references are returned as Lua Table.
874 If the C++ method also returns a value it is prefixed. Two parameters are returned: the value and a Lua Table holding the parameters.
878 <div style="float:left;">C++
880 <pre><code class="cxx">void set_ref (int& var, long& val)
882 printf ("%d %ld\n", var, val);
889 <div style="float:right;">Lua
891 <pre><code class="lua">local var = 0;
892 ref = set_ref (var, 2);
893 -- output from C++ printf()
894 </code><samp class="lua">0 2</samp><code>
895 -- var is still 0 here
896 print (ref[1], ref[2])
897 </code><samp class="lua">5 7</samp></pre>
901 <div class="clear"></div>
903 <div style="float:left;">
905 <pre><code class="cxx">int set_ref2 (int &var, std::string unused)
913 <div style="float:right;">
914 <pre><code class="lua">rv, ref = set_ref2 (0, "hello");
915 print (rv, ref[1], ref[2])
916 </code><samp class="lua">3 5 hello</samp></pre>
919 <div class="clear"></div>
921 <h3>Pointer Classes</h3>
923 Libardour makes extensive use of reference counted <code>boost::shared_ptr</code> to manage lifetimes.
924 The Lua bindings provide a complete abstration of this. There are no pointers in lua.
925 For example a <?=typelink('ARDOUR:Route')?> is a pointer in C++, but lua functions operate on it like it was a class instance.
928 <code>shared_ptr</code> are reference counted. Once assigned to a lua variable, the C++ object will be kept and remains valid.
929 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.
932 All pointer classes have a <code>isnil ()</code> method. This is for two cases:
933 Construction may fail. e.g. <code><?=typelink('ARDOUR:LuaAPI')?>.newplugin()</code>
934 may not be able to find the given plugin and hence cannot create an object.
937 The second case if for <code>boost::weak_ptr</code>. As opposed to <code>boost::shared_ptr</code> weak-pointers are not reference counted.
938 The object may vanish at any time.
939 If lua code calls a method on a nil object, the interpreter will raise an exception and the script will not continue.
940 This is not unlike <code>a = nil a:test()</code> which results in en error "<em>attempt to index a nil value</em>".
943 From the lua side of things there is no distinction between weak and shared pointers. They behave identically.
944 Below they're inidicated in orange and have an arrow to indicate the pointer type.
945 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.
951 #################################
952 # Main output function -- Classes
954 echo '<h2 id="h_classes">Class Documentation</h2>'.NL;
955 foreach ($classlist as $ns => $cl) {
957 $tbl = format_class_members ($ns, $cl, $dups);
959 # format class title - depending on type
961 # classes with no members (no ctor, no methods, no data)
962 echo '<h3 id="'.htmlentities ($ns).'" class="cls opaque"><abbr title="Opaque Object">∅</abbr> '.htmlentities ($ns).'</h3>'.NL;
964 else if (isset ($classlist[$ns]['free'])) {
965 # free functions (no class)
966 echo '<h3 id="'.htmlentities ($ns).'" class="cls freeclass"><abbr title="Namespace">ℕ</abbr> '.ctorname($ns).'</h3>'.NL;
968 else if (isset ($classlist[$ns]['arr'])) {
970 echo '<h3 id="'.htmlentities ($ns).'" class="cls array"><abbr title="C Array">⋯</abbr> '.htmlentities ($ns).'</h3>'.NL;
972 else if (isset ($classlist[$ns]['ptr'])) {
974 echo '<h3 id="'.htmlentities ($ns).'" class="cls pointerclass"><abbr title="Pointer Class">↠</abbr> '. htmlentities ($ns).'</h3>'.NL;
978 echo '<h3 id="'.htmlentities ($ns).'" class="cls class"><abbr title="Class">∁</abbr> '.htmlentities ($ns).'</h3>'.NL;
981 # show original C++ declaration
982 if (isset ($cl['cdecl'])) {
983 echo '<p class="cdecl"><em>C‡</em>: '.htmlentities ($cl['cdecl']).'</p>'.NL;
986 # print class inheritance (direct parent *name* only)
987 $inherited = array ();
988 $isa = traverse_parent ($ns, $inherited);
990 echo ' <p class="classinfo">is-a: '.$isa.'</p>'.NL;
992 echo '<div class="clear"></div>'.NL;
995 # class documentation (if any)
996 echo format_doxyclass ($cl);
998 # member documentation
1000 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;
1002 echo '<table class="classmembers">'.NL;
1004 echo ' </table>'.NL;
1007 # traverse parent classes (all inherited members)
1008 foreach ($inherited as $pns => $pcl) {
1009 $tbl = format_class_members ($pns, $pcl, $dups);
1010 if (!empty ($tbl)) {
1011 echo '<h4 class="cls">Inherited from '.$pns.'</h4>'.NL;
1012 echo '<table class="classmembers">'.NL;
1019 ####################
1020 # Enum and Constants
1022 echo '<h2 id="h_enum">Enum/Constants</h2>'.NL;
1023 foreach ($constlist as $ns => $cs) {
1024 echo '<h3 id="'.ctorname ($ns).'" class="cls enum"><abbr title="Enum">∈</abbr> '.ctorname ($ns).'</h3>'.NL;
1025 echo '<ul class="enum">'.NL;
1026 foreach ($cs as $c) {
1027 echo '<li class="const">'.ctorname ($c['lua']).'</li>'.NL;
1032 ######################
1033 # Index of all classes
1035 echo '<h2 id="h_index" >Class Index</h2>'.NL;
1036 echo '<ul class="classindex">'.NL;
1037 foreach ($classlist as $ns => $cl) {
1038 echo '<li>'.typelink($ns).'</li>'.NL;
1043 # see how far there is still to go...
1044 fwrite (STDERR, "Found $dox_found annotations. missing: $dox_miss\n");
1045 echo '<!-- '.$dox_found.' / '.$dox_miss.' !-->'.NL;
1049 <div class="luafooter">Ardour <?=$ardourversion?> - <?=date('r')?></div>
1053 echo '<!-- #### SNIP #### !-->'.NL;