if (isset ($b['version'])) { $ardourversion = $b['version']; }
continue;
}
+ # reserved lua words
$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']));
if (isset ($b['ret'])) {
$b['ret'] = preg_replace ('/ const/', '', preg_replace ('/ const&/', '', $b['ret']));
$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);
}
'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 (
'ext' => true,
'cand' => str_replace (':', '::', $b['lua']).'(lua_State*)'
);
- fwrite (STDERR, print_r ($b, true));
break;
case "Free Function":
case "Free Function RefReturn":
case "Weak/Shared Pointer Function":
case "Weak/Shared Pointer Function RefReturn":
case "Weak/Shared Null Check":
- case "Weak/Shared Pointer Cast":
case "Static Member Function":
checkclass ($b);
$classlist[luafn2class ($b['lua'])]['func'][] = array (
'cand' => canonical_decl ($b)
);
break;
+ case "Cast":
+ case "Weak/Shared Pointer Cast":
+ checkclass ($b);
+ $classlist[luafn2class ($b['lua'])]['cast'][] = array (
+ 'bind' => $b,
+ 'name' => $b['lua'],
+ 'args' => decl2args ($b['ldec']),
+ 'ret' => arg2lua ($b['ret']),
+ 'ref' => (strpos ($b['type'], "RefReturn") !== false),
+ 'cand' => canonical_decl ($b)
+ );
+ break;
case "Constant/Enum":
case "Constant/Enum Member":
# already handled -> $consts
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'];
}
}
}
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 '';
}
################################################################################
$rv.= format_doxydoc($f);
}
}
+ # print cast - if any
+ if (isset ($cl['cast'])) {
+ usort ($cl['cast'], 'name_sort_cb');
+ $rv.= ' <tr><th colspan="3">Cast</th></tr>'.NL;
+ foreach ($cl['cast'] as $f) {
+ $rv.= ' <tr><td class="def">';
+ $rv.= typelink (varname ($f['ret']), true, 'em');
+ # function declaration and arguments
+ $rv.= '</td><td class="decl">';
+ $rv.= '<span class="functionname"><abbr title="'.htmlentities($f['bind']['decl']).'">'.stripclass ($ns, $f['name']).'</abbr></span>';
+ $rv.= format_args ($f['args']);
+ $rv.= '</td><td class="fill"></td></tr>'.NL;
+ # doxygen documentation (may be empty)
+ $rv.= format_doxydoc($f);
+ }
+ }
+
+ # 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');
---
<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
e.g <code>obj = Session:route_by_name("Audio") obj:set_name("Guitar")</code>.
</p>
<p>
+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.
+</p>
+<p>
+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.
+</p>
+<p>
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:
you cannot simply remove a track that is currently processing audio. There are various <em>factory</em> methods for object creation or removal.
</p>
}
# show original C++ declaration
- if (isset ($cl['decl'])) {
- echo '<p class="cdecl"><em>C‡</em>: '.htmlentities ($cl['decl']).'</p>'.NL;
+ if (isset ($cl['cdecl'])) {
+ echo '<p class="cdecl"><em>C‡</em>: '.htmlentities ($cl['cdecl']).'</p>'.NL;
}
# print class inheritance (direct parent *name* only)
projects / ardour.git / blobdiff