extend lua-doc to show properties
authorRobin Gareus <robin@gareus.org>
Mon, 15 Aug 2016 22:21:59 +0000 (00:21 +0200)
committerRobin Gareus <robin@gareus.org>
Mon, 15 Aug 2016 22:25:59 +0000 (00:25 +0200)
libs/lua/LuaBridge/detail/Namespace.h
tools/fmt-luadoc.php

index 0be54456b3a2b0077768de79801c4d70d898b5c9..07963f47db25605c171ac973a8f301c30aaab2b0 100644 (file)
@@ -790,6 +790,7 @@ private:
     template <class TG, class TS>
     Class <T>& addProperty (char const* name, TG (T::* get) () const, bool (T::* set) (TS))
     {
+      DATADOC ("Property", name, get)
       // Add to __propget in class and const tables.
       {
         rawgetfield (L, -2, "__propget");
index 7f7b35d589c74084deb71a85cb4dd516611cead9..d091bd0a0e79ed59ebb262db89dae3ffd38c0884 100755 (executable)
@@ -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 (
@@ -686,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;
+               }
+       }
+       return $rv;
        # print data members - if any
        if (isset ($cl['data'])) {
                usort ($cl['data'], 'name_sort_cb');