update default URL to follow harrison website restructuring

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

diff --git a/tools/fmt-luadoc.php b/tools/fmt-luadoc.php
index 530a4d8c48e856259b868f12701f86f2c5e44fc0..38221c7f1419f533b605fe91c7841c3dcfe82fba 100755 (executable)
--- a/tools/fmt-luadoc.php
+++ b/tools/fmt-luadoc.php
@@ -91,7 +91,7 @@ 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);
        }
@@ -261,6 +261,13 @@ foreach ($doc as $b) {
                        'cand' => canonical_ctor ($b)
                );
                break;
+       case "Property":
+               checkclass ($b);
+               $classlist[luafn2class ($b['lua'])]['props'][] = array (
+                       'name' => $b['lua'],
+                       'ret'  => arg2lua (datatype ($b['ldec']))
+               );
+               break;
        case "Data Member":
                checkclass ($b);
                $classlist[luafn2class ($b['lua'])]['data'][] = array (
@@ -384,6 +391,7 @@ foreach ($doc as $b) {
                        'cand' => canonical_decl ($b)
                );
                break;
+       case "Cast":
        case "Weak/Shared Pointer Cast":
                checkclass ($b);
                $classlist[luafn2class ($b['lua'])]['cast'][] = array (
@@ -414,14 +422,17 @@ foreach ($doc as $b) {
 foreach ($classlist as $ns => $cl) {
        if (strpos ($cl['type'], ' Array') !== false) {
                $classlist[$ns]['arr'] = true;
+               $classlist[$ns]['cdecl'] = $cl['decl'];
                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']. ' >';
+                               $classlist[$ns]['cdecl'] = 'boost::shared_ptr< '.$c['decl']. ' >, boost::weak_ptr< '.$c['decl']. ' >';
                                break;
+                       } else {
+                               $classlist[$ns]['cdecl'] = $c['decl'];
                        }
                }
        }
@@ -481,10 +492,19 @@ function doxydoc ($canonical_declaration) {
        if (isset ($api[$canonical_declaration])) {
                $dox_found++;
                return $api[$canonical_declaration]['doc'];
-       } else {
-               $dox_miss++;
-               return '';
        }
+       // remove template namespace e.g.
+       //  "ARDOUR::Track::bounceable(boost::shared_ptr<ARDOUR::Processor>"
+       //  "ARDOUR::Track::bounceable(boost::shared_ptr<Processor>"
+       $cn = preg_replace ('/<[^>]*::([^>]*)>/', '<$1>', $canonical_declaration);
+       if (isset ($api[$cn])) {
+               $dox_found++;
+               return $api[$cn]['doc'];
+       }
+       #fwrite (STDERR, $canonical_declaration."\n"); # XXX DEBUG
+
+       $dox_miss++;
+       return '';
 }
 
 ################################################################################
@@ -673,6 +693,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');
@@ -769,7 +800,7 @@ title: Class Reference
 ---
 
 <p class="warning">
-This documention is far from complete may be inaccurate and subject to change.
+This documentation is far from complete may be inaccurate and subject to change.
 </p>
 
 <?php
@@ -931,8 +962,8 @@ foreach ($classlist as $ns => $cl) {
        }
 
        # show original C++ declaration
-       if (isset ($cl['decl'])) {
-               echo '<p class="cdecl"><em>C&#8225;</em>: '.htmlentities ($cl['decl']).'</p>'.NL;
+       if (isset ($cl['cdecl'])) {
+               echo '<p class="cdecl"><em>C&#8225;</em>: '.htmlentities ($cl['cdecl']).'</p>'.NL;
        }
 
        # print class inheritance (direct parent *name* only)