Do not bundle default system_config (prefer built-in defaults)

[ardour.git] / tools / fmt-luadoc.php

diff --git a/tools/fmt-luadoc.php b/tools/fmt-luadoc.php
index 7f7b35d589c74084deb71a85cb4dd516611cead9..b13e38617caf77f2b7c31a75ca67ba958f20d006 100755 (executable)
--- a/tools/fmt-luadoc.php
+++ b/tools/fmt-luadoc.php
@@ -38,8 +38,14 @@ foreach (json_decode ($json, true) as $b) {
        $b ['lua'] = preg_replace ('/:_end/', ':end', $b ['lua']);
        $b ['lua'] = preg_replace ('/:_type/', ':type', $b ['lua']);
        $b ['ldec'] = preg_replace ('/ const/', '', preg_replace ('/ const&/', '', $b['decl']));
+       $b ['ldec'] = preg_replace ('/_VampHost::/', '', $b['ldec']);
+       $b ['decl'] = preg_replace ('/_VampHost::/', '', $b['decl']);
        if (isset ($b['ret'])) {
                $b['ret'] = preg_replace ('/ const/', '', preg_replace ('/ const&/', '', $b['ret']));
+               $b['ret'] = preg_replace ('/_VampHost::/', '', $b['ret']);
+       }
+       if (isset ($b['parent'])) {
+               $b ['parent'] = preg_replace ('/_VampHost::/', '', $b['parent']);
        }
        $doc[] = $b;
 }
@@ -91,11 +97,15 @@ function arg2lua ($argtype, $flags = 0) {
        $arg = preg_replace ('/ $/', '', $arg);
 
        # 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*');
+       $builtin = array ('float', 'double', 'bool', 'std::string', 'int', 'short', 'long', 'unsigned int', 'unsigned short', 'unsigned long', 'unsigned char', 'char', 'void', 'char*', 'unsigned char*', 'void*');
        if (in_array ($arg, $builtin)) {
                return array ($arg => $flags);
        }
 
+       if ($arg == 'luabridge::LuaRef') {
+               return array ('Lua-Function' => $flags | 4);
+       }
+
        # check Class declarations first
        foreach (array_merge ($classes, $consts) as $b) {
                if ($b['ldec'] == $arg) {
@@ -194,6 +204,8 @@ function canonical_decl ($b) {
                        $a = preg_replace ('/([^>]) >/', '$1>', $a);
                        $a = preg_replace ('/^Cairo::/', '', $a); // special case cairo enums
                        $a = preg_replace ('/([^ ])&/', '$1 &', $a);
+                       $a = preg_replace ('/std::vector<([^>]*)> const/', 'const std::vector<$1>', $a);
+                       $a = str_replace ('std::vector', 'vector', $a);
                        $a = str_replace ('vector', 'std::vector', $a);
                        $a = str_replace ('std::string', 'string', $a);
                        $a = str_replace ('string const', 'const string', $a);
@@ -258,7 +270,24 @@ foreach ($doc as $b) {
                $classlist[luafn2class ($b['lua'])]['ctor'][] = array (
                        'name' => luafn2class ($b['lua']),
                        'args' => decl2args ($b['ldec']),
-                       'cand' => canonical_ctor ($b)
+                       'cand' => canonical_ctor ($b),
+                       'nil' => false
+               );
+               break;
+       case "Weak/Shared Pointer NIL Constructor":
+               checkclass ($b);
+               $classlist[luafn2class ($b['lua'])]['ctor'][] = array (
+                       'name' => luafn2class ($b['lua']),
+                       'args' => decl2args ($b['ldec']),
+                       'cand' => canonical_ctor ($b),
+                       'nil' => true
+               );
+               break;
+       case "Property":
+               checkclass ($b);
+               $classlist[luafn2class ($b['lua'])]['props'][] = array (
+                       'name' => $b['lua'],
+                       'ret'  => arg2lua (datatype ($b['ldec']))
                );
                break;
        case "Data Member":
@@ -533,6 +562,7 @@ function traverse_parent ($ns, &$inherited) {
                asort ($parents);
                foreach ($parents as $p) {
                        if (!empty ($rv)) { $rv .= ', '; }
+                       if ($p == $ns) { continue; }
                        $rv .= typelink ($p);
                        $inherited[$p] = $classlist[$p];
                        traverse_parent ($p, $inherited);
@@ -564,7 +594,10 @@ function format_args ($args) {
        foreach ($args as $a) {
                if (!$first) { $rv .= ', '; }; $first = false;
                $flags = $a[varname ($a)];
-               if ($flags & 2) {
+               if ($flags & 4) {
+                       $rv .= '<span>'.varname ($a).'</span>';
+               }
+               else if ($flags & 2) {
                        $rv .= '<em>LuaTable</em> {'.typelink (varname ($a), true, 'em').'}';
                }
                elseif ($flags & 1) {
@@ -619,7 +652,13 @@ function format_class_members ($ns, $cl, &$dups) {
                usort ($cl['ctor'], 'name_sort_cb');
                $rv.= ' <tr><th colspan="3">Constructor</th></tr>'.NL;
                foreach ($cl['ctor'] as $f) {
-                       $rv.= ' <tr><td class="def">&Copf;</td><td class="decl">';
+                       $rv.= ' <tr>';
+                       if ($f['nil']) {
+                               $rv.= '<td class="def"><abbr title="Nil Pointer Constructor">&alefsym;</abbr></td>';
+                       } else {
+                               $rv.= '<td class="def">&Copf;</td>';
+                       }
+                       $rv.= '<td class="decl">';
                        $rv.= '<span class="functionname">'.ctorname ($f['name']).'</span>';
                        $rv.= format_args ($f['args']);
                        $rv.= '</td><td class="fill"></td></tr>'.NL;
@@ -686,6 +725,17 @@ function format_class_members ($ns, $cl, &$dups) {
                }
        }
 
+       # print properties - if any
+       if (isset ($cl['props'])) {
+               usort ($cl['props'], 'name_sort_cb');
+               $rv.= ' <tr><th colspan="3">Properties</th></tr>'.NL;
+               foreach ($cl['props'] as $f) {
+                       $rv.= ' <tr><td class="def">'.typelink (array_keys ($f['ret'])[0], false, 'em').'</td><td class="decl">';
+                       $rv.= '<span class="functionname">'.stripclass ($ns, $f['name']).'</span>';
+                       $rv.= '</td><td class="fill"></td></tr>'.NL;
+               }
+       }
+
        # print data members - if any
        if (isset ($cl['data'])) {
                usort ($cl['data'], 'name_sort_cb');
@@ -694,6 +744,8 @@ function format_class_members ($ns, $cl, &$dups) {
                        $rv.= ' <tr><td class="def">'.typelink (array_keys ($f['ret'])[0], false, 'em').'</td><td class="decl">';
                        $rv.= '<span class="functionname">'.stripclass ($ns, $f['name']).'</span>';
                        $rv.= '</td><td class="fill"></td></tr>'.NL;
+                       $f['cand'] = str_replace (':', '::', $f['name']);
+                       $rv.= format_doxydoc($f);
                }
        }
        return $rv;
@@ -754,6 +806,7 @@ div.luafooter      { text-align:center; font-size:80%; color: #888; margin: 2em
 #luaref table.classmembers td.fill { width: 99%; }
 #luaref table.classmembers span.em { font-style: italic; }
 #luaref span.functionname abbr     { text-decoration:none; cursor:default; }
+#luaref table.classmembers td.def abbr { text-decoration:none; cursor:default; }
 </style>
 </head>
 <body>
@@ -775,11 +828,6 @@ div.luafooter      { text-align:center; font-size:80%; color: #888; margin: 2em
 } else {
 
 ?>
----
-layout: default
-style: luadoc
-title: Class Reference
----
 
 <p class="warning">
 This documentation is far from complete may be inaccurate and subject to change.