From: Robin Gareus Date: Mon, 21 Mar 2016 18:06:51 +0000 (+0100) Subject: update Lua Binding Doc and html generator X-Git-Tag: 5.0-pre0~1256 X-Git-Url: https://main.carlh.net/gitweb/?p=ardour.git;a=commitdiff_plain;h=9f0130249d3b5f56a4ed3cb84d8e8f2e62053206 update Lua Binding Doc and html generator --- diff --git a/doc/luadoc.json b/doc/luadoc.json index 1117c2fa03..b3c4236020 100644 --- a/doc/luadoc.json +++ b/doc/luadoc.json @@ -1,138 +1,164 @@ [ +{"version" : "4.7-421-g7083d71"}, + {"type" : "[C] Class", - "lua" : "ARDOUR:StringList", + "lua" : "C:StringList", "decl" : "std::list" }, {"type" : "Constructor", - "lua" : "ARDOUR:StringList:", + "lua" : "C:StringList:", "ret" : "void", "decl" : "void (*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:StringList:empty", + "lua" : "C:StringList:empty", "ret" : "bool", "decl" : "bool (std::list::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:StringList:size", + "lua" : "C:StringList:size", "ret" : "unsigned long", "decl" : "unsigned long (std::list::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:StringList:reverse", + "lua" : "C:StringList:reverse", "ret" : "void", "decl" : "void (std::list::*)()" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:StringList:iter", + "lua" : "C:StringList:iter", "decl" : "int (*)(lua_State*)" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:StringList:table", + "lua" : "C:StringList:table", "decl" : "int (*)(lua_State*)" }, {"type" : "Member Function", - "lua" : "ARDOUR:StringList:unique", + "lua" : "C:StringList:unique", "ret" : "void", "decl" : "void (std::list::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:StringList:push_back", + "lua" : "C:StringList:push_back", "ret" : "void", "decl" : "void (std::list::*)(std::string)" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:StringList:add", + "lua" : "C:StringList:add", "decl" : "int (*)(lua_State*)" }, {"type" : "[C] Class", - "lua" : "ARDOUR:StringVector", + "lua" : "C:StringVector", "decl" : "std::vector" }, {"type" : "Constructor", - "lua" : "ARDOUR:StringVector:", + "lua" : "C:StringVector:", "ret" : "void", "decl" : "void (*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:StringVector:empty", + "lua" : "C:StringVector:empty", "ret" : "bool", "decl" : "bool (std::vector::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:StringVector:size", + "lua" : "C:StringVector:size", "ret" : "unsigned long", "decl" : "unsigned long (std::vector::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:StringVector:push_back", + "lua" : "C:StringVector:push_back", "ret" : "void", "decl" : "void (std::vector::*)(std::string)" }, {"type" : "Member Function", - "lua" : "ARDOUR:StringVector:at", + "lua" : "C:StringVector:at", "ret" : "std::string&", "decl" : "std::string& (std::vector::*)(unsigned long)" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:StringVector:add", + "lua" : "C:StringVector:add", "decl" : "int (*)(lua_State*)" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:StringVector:iter", + "lua" : "C:StringVector:iter", "decl" : "int (*)(lua_State*)" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:StringVector:table", + "lua" : "C:StringVector:table", "decl" : "int (*)(lua_State*)" }, {"type" : "[C] Array", - "lua" : "ARDOUR:FloatArray", + "lua" : "C:FloatArray", "decl" : "float*" }, +{"type" : "Ext C Function", + "lua" : "C:FloatArray:array", + "decl" : "int (*)(lua_State*)" +}, +{"type" : "Ext C Function", + "lua" : "C:FloatArray:get_table", + "decl" : "int (*)(lua_State*)" +}, +{"type" : "Ext C Function", + "lua" : "C:FloatArray:set_table", + "decl" : "int (*)(lua_State*)" +}, {"type" : "[C] Array", - "lua" : "ARDOUR:IntArray", + "lua" : "C:IntArray", "decl" : "int*" }, +{"type" : "Ext C Function", + "lua" : "C:IntArray:array", + "decl" : "int (*)(lua_State*)" +}, +{"type" : "Ext C Function", + "lua" : "C:IntArray:get_table", + "decl" : "int (*)(lua_State*)" +}, +{"type" : "Ext C Function", + "lua" : "C:IntArray:set_table", + "decl" : "int (*)(lua_State*)" +}, {"type" : "[C] Class", - "lua" : "ARDOUR:DoubleVector", + "lua" : "C:DoubleVector", "decl" : "std::vector" }, {"type" : "Constructor", - "lua" : "ARDOUR:DoubleVector:", + "lua" : "C:DoubleVector:", "ret" : "void", "decl" : "void (*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:DoubleVector:empty", + "lua" : "C:DoubleVector:empty", "ret" : "bool", "decl" : "bool (std::vector::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:DoubleVector:size", + "lua" : "C:DoubleVector:size", "ret" : "unsigned long", "decl" : "unsigned long (std::vector::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:DoubleVector:push_back", + "lua" : "C:DoubleVector:push_back", "ret" : "void", "decl" : "void (std::vector::*)(double)" }, {"type" : "Member Function", - "lua" : "ARDOUR:DoubleVector:at", + "lua" : "C:DoubleVector:at", "ret" : "double&", "decl" : "double& (std::vector::*)(unsigned long)" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:DoubleVector:add", + "lua" : "C:DoubleVector:add", "decl" : "int (*)(lua_State*)" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:DoubleVector:iter", + "lua" : "C:DoubleVector:iter", "decl" : "int (*)(lua_State*)" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:DoubleVector:table", + "lua" : "C:DoubleVector:table", "decl" : "int (*)(lua_State*)" }, {"type" : "[C] Class", @@ -629,7 +655,7 @@ "ret" : "float", "decl" : "float (ARDOUR::Region::*)()" }, -{"type" : "Weak/Shared Pointer Function", +{"type" : "Weak/Shared Pointer Function RefReturn", "lua" : "ARDOUR:Region:sync_offset", "ret" : "long", "decl" : "long (ARDOUR::Region::*)(int&)" @@ -1149,7 +1175,7 @@ "ret" : "unsigned int", "decl" : "unsigned int (ARDOUR::Plugin::*)()" }, -{"type" : "Weak/Shared Pointer Function", +{"type" : "Weak/Shared Pointer Function RefReturn", "lua" : "ARDOUR:PluginInsert:nth_parameter", "ret" : "unsigned int", "decl" : "unsigned int (ARDOUR::Plugin::*)(unsigned int, bool&)" @@ -1834,56 +1860,56 @@ "decl" : "int (*)(lua_State*)" }, {"type" : "[C] Class", - "lua" : "ARDOUR:ARDOUR:DeviceStatus", + "lua" : "ARDOUR:DeviceStatus", "decl" : "ARDOUR::AudioBackend::DeviceStatus" }, {"type" : "Data Member", - "lua" : "ARDOUR:ARDOUR:DeviceStatus:name", + "lua" : "ARDOUR:DeviceStatus:name", "decl" : "std::string ARDOUR::AudioBackend::DeviceStatus::*" }, {"type" : "Data Member", - "lua" : "ARDOUR:ARDOUR:DeviceStatus:available", + "lua" : "ARDOUR:DeviceStatus:available", "decl" : "bool ARDOUR::AudioBackend::DeviceStatus::*" }, {"type" : "[C] Class", - "lua" : "ARDOUR:ARDOUR:DeviceStatusVector", + "lua" : "ARDOUR:DeviceStatusVector", "decl" : "std::vector" }, {"type" : "Constructor", - "lua" : "ARDOUR:ARDOUR:DeviceStatusVector:", + "lua" : "ARDOUR:DeviceStatusVector:", "ret" : "void", "decl" : "void (*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:ARDOUR:DeviceStatusVector:empty", + "lua" : "ARDOUR:DeviceStatusVector:empty", "ret" : "bool", "decl" : "bool (std::vector::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:ARDOUR:DeviceStatusVector:size", + "lua" : "ARDOUR:DeviceStatusVector:size", "ret" : "unsigned long", "decl" : "unsigned long (std::vector::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:ARDOUR:DeviceStatusVector:push_back", + "lua" : "ARDOUR:DeviceStatusVector:push_back", "ret" : "void", "decl" : "void (std::vector::*)(ARDOUR::AudioBackend::DeviceStatus)" }, {"type" : "Member Function", - "lua" : "ARDOUR:ARDOUR:DeviceStatusVector:at", + "lua" : "ARDOUR:DeviceStatusVector:at", "ret" : "ARDOUR::AudioBackend::DeviceStatus&", "decl" : "ARDOUR::AudioBackend::DeviceStatus& (std::vector::*)(unsigned long)" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:ARDOUR:DeviceStatusVector:add", + "lua" : "ARDOUR:DeviceStatusVector:add", "decl" : "int (*)(lua_State*)" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:ARDOUR:DeviceStatusVector:iter", + "lua" : "ARDOUR:DeviceStatusVector:iter", "decl" : "int (*)(lua_State*)" }, {"type" : "Ext C Function", - "lua" : "ARDOUR:ARDOUR:DeviceStatusVector:table", + "lua" : "ARDOUR:DeviceStatusVector:table", "decl" : "int (*)(lua_State*)" }, {"type" : "[C] Class", @@ -2940,12 +2966,12 @@ "ret" : "Editing::MouseMode", "decl" : "Editing::MouseMode (PublicEditor::*)()" }, -{"type" : "Member Function", +{"type" : "Member Function RefReturn", "lua" : "ARDOUR:Editor:do_import", "ret" : "void", "decl" : "void (PublicEditor::*)(std::vector, Editing::ImportDisposition, Editing::ImportMode, ARDOUR::SrcQuality, long&, boost::shared_ptr)" }, -{"type" : "Member Function", +{"type" : "Member Function RefReturn", "lua" : "ARDOUR:Editor:do_embed", "ret" : "void", "decl" : "void (PublicEditor::*)(std::vector, Editing::ImportDisposition, Editing::ImportMode, long&, boost::shared_ptr)" @@ -3105,7 +3131,7 @@ "ret" : "void", "decl" : "void (PublicEditor::*)()" }, -{"type" : "Member Function", +{"type" : "Member Function RefReturn", "lua" : "ARDOUR:Editor:get_nudge_distance", "ret" : "long", "decl" : "long (PublicEditor::*)(long, long&)" @@ -3120,7 +3146,7 @@ "ret" : "unsigned int", "decl" : "unsigned int (PublicEditor::*)(long)" }, -{"type" : "Member Function", +{"type" : "Member Function RefReturn", "lua" : "ARDOUR:Editor:get_grid_type_as_beats", "ret" : "Evoral::Beats", "decl" : "Evoral::Beats (PublicEditor::*)(bool&, long)" @@ -3155,12 +3181,12 @@ "ret" : "bool", "decl" : "bool (PublicEditor::*)()" }, -{"type" : "Member Function", +{"type" : "Member Function RefReturn", "lua" : "ARDOUR:Editor:get_pointer_position", "ret" : "void", "decl" : "void (PublicEditor::*)(double&, double&)" }, -{"type" : "Member Function", +{"type" : "Member Function RefReturn", "lua" : "ARDOUR:Editor:find_location_from_marker", "ret" : "ARDOUR::Location*", "decl" : "ARDOUR::Location* (PublicEditor::*)(ArdourMarker*, bool&)" diff --git a/gtk2_ardour/luadoc.cc b/gtk2_ardour/luadoc.cc index 794740eeda..11fd7aa984 100644 --- a/gtk2_ardour/luadoc.cc +++ b/gtk2_ardour/luadoc.cc @@ -3,17 +3,24 @@ #include #include "ardour/luabindings.h" +#include "ardour/revision.h" #include "luainstance.h" +#ifdef WAF_BUILD +#include "gtk2ardour-version.h" +#endif + int main (int argc, char **argv) { luabridge::setPrintBindings (true); LuaState lua; lua_State* L = lua.getState (); #ifdef LUADOCOUT + printf ("-- %s\n", ARDOUR::revision); printf ("doc = {\n"); #else printf ("[\n"); + printf ("{\"version\" : \"%s\"},\n\n", ARDOUR::revision); #endif LuaInstance::register_classes (L); ARDOUR::LuaBindings::dsp (L); diff --git a/tools/fmt-luadoc.php b/tools/fmt-luadoc.php index b51d7e7e86..758d2c600a 100755 --- a/tools/fmt-luadoc.php +++ b/tools/fmt-luadoc.php @@ -1,26 +1,52 @@ #!/usr/bin/php doc/luadoc.json +# +# php tools/fmt-luadoc.php > /tmp/luadoc.html +# + +################################################################################ +################################################################################ -$json = file_get_contents('../doc/luadoc.json'); -$doc = array(); -foreach (json_decode($json, true) as $b) { - if (!isset ($b['type'])) { continue;} +$json = file_get_contents (dirname (__FILE__).'/../doc/luadoc.json'); +$doc = array (); +foreach (json_decode ($json, true) as $b) { + if (!isset ($b['type'])) { continue; } $doc[] = $b; } +if (count ($doc) == 0) { + fwrite (STDERR, "Failed to read luadoc.json\n"); + exit (1); +} + +################################################################################ +## Global result variables ################################################################################ -$classes = array(); -$consts = array(); -$constslist = array(); -$funclist = array(); -$classlist = array(); +$classlist = array (); +$funclist = array (); +$constlist = array (); + +################################################################################ +## Pre-process the data, collect functions, parse arguments, cross reference ################################################################################ + +################################################################################ +# some internal helper functions first + +$classes = array (); +$consts = array (); + function my_die ($msg) { - fwrite(STDERR,$msg."\n"); - exit(1); + fwrite (STDERR, $msg."\n"); + exit (1); } ##function ptr_strip ($ctype) { @@ -35,16 +61,19 @@ function arg2lua ($argtype) { global $consts; # LuaBridge abstracts C++ references + $flags = preg_match ('/&$/', $argtype); $arg = preg_replace ('/&$/', '', $argtype); # filter out basic types $builtin = array ('float', 'double', 'bool', 'std::string', 'int', 'long', 'unsigned long', 'unsigned int', 'unsigned char', 'char', 'void', 'char*', 'unsigned char*', 'void*'); - if (in_array ($arg, $builtin)) return $argtype; + if (in_array ($arg, $builtin)) { + return array ($arg => $flags); + } # check Class declarations first foreach (array_merge ($classes, $consts) as $b) { if ($b['decl'] == $arg) { - return $b['lua']; + return array ($b['lua'] => $flags); } } @@ -52,16 +81,16 @@ function arg2lua ($argtype) { $arg = preg_replace ('/[&*]*$/', '', $argtype); foreach (array_merge ($classes, $consts) as $b) { if ($b['decl'] == $arg) { - return $b['lua']; + return array ($b['lua'] => $flags); } } - return '--MISSING (' . $argtype . ')--'; + return array ('--MISSING (' . $argtype . ')--' => ($flags | 4)); } function stripclass ($classname, $name) { $classname .= ':'; - if (strpos($name, $classname) !== 0) { - my_die ('invalid class prefix' .$classname. ' -- '. $name); + if (strpos ($name, $classname) !== 0) { + my_die ('invalid class prefix: ' .$classname. ' -- '. $name); } return substr ($name, strlen ($classname)); } @@ -69,17 +98,17 @@ function stripclass ($classname, $name) { function datatype ($decl) { # TODO handle spaces in type. Works because # we don't yet have templated types (with_space ) - return substr($decl, 0, strpos ($decl, ' ')); + return substr ($decl, 0, strpos ($decl, ' ')); } function luafn2class ($lua) { - return substr($lua, 0, strrpos ($lua, ':')); + return substr ($lua, 0, strrpos ($lua, ':')); } function checkclass ($b) { global $classlist; - if (!isset ($classlist[luafn2class($b['lua'])])) { - my_die ('MISSING CLASS FOR '. print_r($b['lua'], true)); + if (!isset ($classlist[luafn2class ($b['lua'])])) { + my_die ('MISSING CLASS FOR '. print_r ($b['lua'], true)); } } @@ -92,7 +121,7 @@ function decl2args ($decl) { $rv = array (); foreach ($arglist as $a) { if (empty ($a)) { continue; } - $rv[] = arg2lua($a); + $rv[] = arg2lua ($a); } return $rv; } @@ -103,17 +132,20 @@ function decl2args ($decl) { foreach ($doc as $b) { if (strpos ($b['type'], "[C] ") === 0) { $classes[] = $b; - $classlist[$b['lua']] = array (); - $classindex[$b['lua']] = $b; - $classdecl[$b['decl']] = $b; + $classlist[$b['lua']] = $b; + if (strpos ($b['type'], 'Pointer Class') === false) { + $classdecl[$b['decl']] = $b; + } } } + foreach ($classes as $c) { + if (strpos ($c['type'], 'Pointer Class') !== false) { continue; } if (isset ($c['parent'])) { if (isset ($classdecl[$c['parent']])) { - $classindex[$c['lua']]['luaparent'] = $classdecl[$c['parent']]['lua']; + $classlist[$c['lua']]['luaparent'][] = $classdecl[$c['parent']]['lua']; } else { - my_die ('unknown parent class: ' . print_r($c, true)); + my_die ('unknown parent class: ' . print_r ($c, true)); } } } @@ -123,12 +155,13 @@ foreach ($doc as $b) { switch ($b['type']) { case "Constant/Enum": case "Constant/Enum Member": - $ns = luafn2class($b['lua']); - $constlist[$ns][] = $b; if (strpos ($b['decl'], '::') === false) { # for extern c enums, use the Lua Namespace - $b['decl'] = str_replace (':', '::', luafn2class($b['lua'])); + $b['decl'] = str_replace (':', '::', luafn2class ($b['lua'])); } + $ns = str_replace ('::', ':', $b['decl']); + $constlist[$ns][] = $b; + # arg2lua lookup $b['lua'] = $ns; $consts[] = $b; break; @@ -143,39 +176,41 @@ foreach ($doc as $b) { case "Constructor": case "Weak/Shared Pointer Constructor": checkclass ($b); - $classlist[luafn2class($b['lua'])]['ctor'][] = array ( - 'name' => luafn2class($b['lua']), + $classlist[luafn2class ($b['lua'])]['ctor'][] = array ( + 'name' => luafn2class ($b['lua']), 'args' => decl2args ($b['decl']), ); break; case "Data Member": checkclass ($b); - $classlist[luafn2class($b['lua'])]['data'][] = array ( + $classlist[luafn2class ($b['lua'])]['data'][] = array ( 'name' => $b['lua'], - 'ret' => arg2lua (datatype($b['decl'])) + 'ret' => arg2lua (datatype ($b['decl'])) ); break; case "C Function": # we required C functions to be in a class namespace case "Ext C Function": checkclass ($b); - $classlist[luafn2class($b['lua'])]['func'][] = array ( + $classlist[luafn2class ($b['lua'])]['func'][] = array ( 'name' => $b['lua'], - 'args' => array ('--custom--'), // XXX - 'ret' => '(LUA)', // XXX + 'args' => array (array ('--custom--' => 0)), // XXX + 'ret' => array ('...' => 0), // XXX + 'ref' => true, 'ext' => true ); break; case "Free Function": case "Free Function RefReturn": - $funclist[luafn2class($b['lua'])][] = array ( + $funclist[luafn2class ($b['lua'])][] = array ( 'name' => $b['lua'], 'args' => decl2args ($b['decl']), 'ret' => arg2lua ($b['ret']), - 'ref' => (strpos($b['type'], "RefReturn") !== false) + 'ref' => (strpos ($b['type'], "RefReturn") !== false) ); break; case "Member Function": + case "Member Function RefReturn": case "Member Pointer Function": case "Weak/Shared Pointer Function": case "Weak/Shared Pointer Function RefReturn": @@ -183,14 +218,12 @@ foreach ($doc as $b) { case "Weak/Shared Pointer Cast": case "Static Member Function": checkclass ($b); - $classlist[luafn2class($b['lua'])]['func'][] = array ( + $classlist[luafn2class ($b['lua'])]['func'][] = array ( 'name' => $b['lua'], 'args' => decl2args ($b['decl']), 'ret' => arg2lua ($b['ret']), - 'ref' => (strpos($b['type'], "RefReturn") !== false) + 'ref' => (strpos ($b['type'], "RefReturn") !== false) ); - #print_r(decl2args ($b['decl'])); - #echo arg2lua ($b['ret'])."\n"; break; case "Constant/Enum": case "Constant/Enum Member": @@ -205,110 +238,276 @@ foreach ($doc as $b) { } -## TODO... +# step 4: collect/group/sort # step 4a: unify weak/shared Ptr classes -# step 4b: group namespaces (class, enums) - -## list of possible functions producing the given type -## -> see also arg2lua() -#function arg2src ($argtype) { -# global $classes; -# global $consts; -# $rv = array (); -# # filter out basic types -# $builtin = array ('float', 'double', 'bool', 'std::string', 'int'); -# if (in_array ($builtin)) return $rv; -# -# # check class c'tors end enums -# foreach (array_merge ($classes, $consts) as $b) { -# if (strpos ($b['decl'], $argtype) === 0) { -# $rv[$b['lua']] = $b; -# } -# } -# # check C++ declarations next -# foreach ($doc as $b) { -# if (isset($b['ret']) && $b['ret'] == $argtype) { -# $rv[$b['lua']] = $b; -# } -# if (strpos ($b['decl'], $argtype) === 0) { -# $rv[$b['lua']] = $b; -# } -# } -# # check lua-name for extern c enums -# $argtype = str_replace ('::', ':', $argtype); -# foreach ($doc as $b) { -# if (strpos ($b['lua'], $argtype) === 0) { -# $rv[$b['lua']] = $b; -# } -# } -# return $rv; -#} +foreach ($classlist as $ns => $cl) { + if (strpos ($cl['type'], ' Array') !== false) { + $classlist[$ns]['arr'] = true; + continue; + } + foreach ($classes as $c) { + if ($c['lua'] == $ns) { + if (strpos ($c['type'], 'Pointer Class') !== false) { + $classlist[$ns]['ptr'] = true; + $classlist[$ns]['decl'] = 'boost::shared_ptr< '.$c['decl']. ' >, boost::weak_ptr< '.$c['decl']. ' >'; + break; + } + } + } +} + +# step4b: sanity check +foreach ($classlist as $ns => $cl) { + if (isset ($classes[$ns]['parent']) && !isset ($classlist[$ns]['luaparent'])) { + my_die ('missing parent class: ' . print_r ($cl, true)); + } +} + +# step 4c: merge free functions into classlist +foreach ($funclist as $ns => $fl) { + if (isset ($classlist[$ns])) { + my_die ('Free Funcion in existing namespace: '.$ns.' '. print_r ($ns, true)); + } + $classlist[$ns]['func'] = $fl; + $classlist[$ns]['free'] = true; +} + +# step 4d: order to chaos +# no array_multisort() here, sub-types are sorted after merging parents +ksort ($classlist); + + +################################################################################ +# OUTPUT +################################################################################ -# step 5: output + +################################################################################ +# Helper functions define ('NL', "\n"); -echo ''.NL; -echo ''; +function ctorname ($name) { + return htmlentities (str_replace (':', '.', $name)); +} + +function varname ($a) { + return array_keys ($a)[0]; +} + +function name_sort_cb ($a, $b) { + return strcmp ($a['name'], $b['name']); +} + +function typelink ($a, $linkcls = '', $argcls = '') { + global $classlist; + global $constlist; + if (in_array ($a, array_keys ($classlist))) { + return ''.$a.''; + } else if (in_array ($a, array_keys ($constlist))) { + return ''.ctorname ($a).''; + } else { + return ''.$a.''; + } +} function format_args ($args) { - $rv = ' ('; + $rv = ' ('; $first = true; foreach ($args as $a) { - if (!$first) { $rv .= ', '; } - $rv .= ''.$a.''; - $first = false; + if (!$first) { $rv .= ', '; }; $first = false; + $flags = $a[varname ($a)]; + if ($flags & 1) { + $rv .= typelink (varname ($a).'&', '', 'em'); + } else { + $rv .= typelink (varname ($a), '', 'em'); + } } - $rv .= ')'; + $rv .= ')'; return $rv; } -function ctorname ($name) { - return str_replace (':', '.', $name); -} - -foreach ($classlist as $ns => $cl) { - echo '

'.$ns.'

'.NL; - if (isset ($classindex[$ns]['luaparent'])) { - echo '

is-a '.$classindex[$ns]['luaparent'].'

'.NL; - } - // TODO highlight Pointer Classes - - // TODO optionally traverse all parent classes.. - // function format_class_members() +function format_class_members ($ns, $cl, &$dups) { + $rv = ''; if (isset ($cl['ctor'])) { - echo '

Constructor

'.NL; - echo '
    '.NL; + usort ($cl['ctor'], 'name_sort_cb'); + $rv.= ' Constructor'.NL; foreach ($cl['ctor'] as $f) { - echo '
  • '.ctorname($f['name']).format_args($f['args']).'
    • '.NL; + $rv.= ' ℂ'; + $rv.= ''.ctorname ($f['name']).''; + $rv.= format_args ($f['args']); + $rv.= ''.NL; } - echo '
'.NL; } + $nondups = array (); if (isset ($cl['func'])) { - echo '

Methods

'.NL; - echo '
    '.NL; foreach ($cl['func'] as $f) { - echo '
  • '.$f['ret'].' '.stripclass($ns, $f['name']).format_args($f['args']).'
    • '.NL; + if (in_array (stripclass ($ns, $f['name']), $dups)) { continue; } + $nondups[] = $f; } - echo '
'.NL; + } + if (count ($nondups) > 0) { + usort ($nondups, 'name_sort_cb'); + $rv.= ' Methods'.NL; + foreach ($nondups as $f) { + $dups[] = stripclass ($ns, $f['name']); + $rv.= ' '; + if ($f['ref'] && isset ($f['ext'])) { + # external C functions + $rv.= 'LuaTable'; + } elseif ($f['ref'] && varname ($f['ret']) == 'void') { + # functions with reference args return args + $rv.= 'LuaTable(...)'; + } elseif ($f['ref']) { + $rv.= 'LuaTable('.typelink (varname ($f['ret'])).', ...)'; + } else { + $rv.= typelink (varname ($f['ret'])); + } + $rv.= ''; + $rv.= ''.stripclass ($ns, $f['name']).''; + $rv.= format_args ($f['args']); + $rv.= ''.NL; +} } if (isset ($cl['data'])) { - echo '

Data

'.NL; - echo '
    '.NL; + usort ($cl['data'], 'name_sort_cb'); + $rv.= ' Data Members'.NL; foreach ($cl['data'] as $f) { - echo '
  • '.stripclass($ns, $f['name']).'
    • '.NL; + $rv.= ' '.typelink (array_keys ($f['ret'])[0]).''; + $rv.= ''.stripclass ($ns, $f['name']).''; + $rv.= ''.NL; } - echo '
'.NL; } + return $rv; } -foreach ($funclist as $ns => $fl) { - echo '

'.$ns.'

'.NL; - echo '
    '.NL; - foreach ($fl as $f) { - echo '
  • '.$f['ret'].' '.stripclass($ns, $f['name']).format_args($f['args']).'
    • '.NL; + +################################################################################ +# Start Output +?> + + +Ardour Lua Bindings + + + + +
    +

    Ardour Lua Bindings

    +

    +Class Documentation + |  +Enum/Constants + |  +Index +

    +
    +
    + +Class Documentation'.NL; + +foreach ($classlist as $ns => $cl) { + $dups = array (); + $tbl = format_class_members ($ns, $cl, $dups); + + if (empty ($tbl)) { + # place-holder class (maybe collect at bottom??) + echo '

    ∅ '.$ns.'

    '.NL; + } + else if (isset ($classlist[$ns]['free'])) { + echo '

    ℕ '.$ns.'

    '.NL; + } + else if (isset ($classlist[$ns]['arr'])) { + echo '

    ⋯ '.$ns.'

    '.NL; + } + else if (isset ($classlist[$ns]['ptr'])) { + echo '

    ↠ '.$ns.'

    '.NL; + } else { + echo '

    ∁ '.htmlentities ($ns).'

    '.NL; + } + if (isset ($cl['decl'])) { + echo '

    C‡: '.htmlentities ($cl['decl']).'

    '.NL; + } + + $inherited = array (); + if (isset ($classlist[$ns]['luaparent'])) { + $parents = array_unique ($classlist[$ns]['luaparent']); + asort ($parents); + echo '

    is-a: '; + $first = true; + foreach ($parents as $p) { + if (!$first) { echo ', '; }; $first = false; + echo typelink ($p); + $inherited[$p] = $classlist[$p]; + } + echo '

    '.NL; + } + echo '
    '.NL; + + if (empty ($tbl)) { + echo '

    This class object is only used indirectly as return-value and function-parameter.

    '.NL; + } else { + echo ''.NL; + echo $tbl; + echo '
    '.NL; } - echo '
'.NL; + + // traverse all parent classes.. + foreach ($inherited as $pns => $pcl) { + $tbl = format_class_members ($pns, $pcl, $dups); + if (!empty ($tbl)) { + echo '

Inherited from '.$pns.'

'.NL; + echo ''.NL; + echo $tbl; + echo '
'.NL; + } + } +} + +echo '

Enum/Constants

'.NL; +foreach ($constlist as $ns => $cs) { + echo '

∈ '.ctorname ($ns).'

'.NL; + echo '
    '.NL; + foreach ($cs as $c) { + echo '
  • '.ctorname ($c['lua']).'
    • '.NL; + } + echo '
'.NL; } -echo "\n\n"; +echo '

Class Index

'.NL; +echo '
    '.NL; +foreach ($classlist as $ns => $cl) { + echo '
  • '.$ns.'
    • '.NL; +} +echo '
'.NL; + + + +?> + + +