Towards fixing luadoc, manual page creation

tools/doxy2json/ardourdoc.sh

@@ -4,7 +4,7 @@ set -e
 make
 cd ../..
 test -f libs/ardour/ardour/ardour.h
-LLVMINCLUDE="-I /usr/lib/llvm-3.6/include -I /usr/lib/llvm-3.6/lib/clang/3.6.2/include/"
+LLVMINCLUDE="-I `llvm-config --includedir` -I `llvm-config --libdir`/clang/`llvm-config --version`/include/"
 
 TMPFILE=`mktemp`
 trap 'rm -f $TMPFILE' exit SIGINT SIGTERM
@@ -13,11 +13,11 @@ echo "# analyzing source.. -> $TMPFILE"
 time ./tools/doxy2json/doxy2json -j 4 \
 	$LLVMINCLUDE \
 	-D PACKAGE=\"doc\" \
-	-D PROGRAM_NAME=\"Ardour\" -D PROGRAM_VERSION=\"4\" -D LOCALEDIR=\"/\" \
+	-D PROGRAM_NAME=\"Ardour\" -D PROGRAM_VERSION=\"6\" -D LOCALEDIR=\"/\" \
 	-D ARCH_X86 -D CONFIG_ARCH=\"x86_64\" -D WAF_BUILD \
 	-D HAVE_AUBIO=1 -D HAVE_ALSA=1 -D HAVE_GLIB=1 -D HAVE_LIBS_LUA=1 -D HAVE_XML=1 -D PTFORMAT=1 \
 	-D HAVE_SAMPLERATE=1 -D HAVE_LV2=1 -D HAVE_LV2_1_10_0=1 -D HAVE_SERD=1 -D HAVE_SORD=1 -D HAVE_SRATOM=1 -D HAVE_LILV=1 -D HAVE_LV2_1_0_0=1 \
-	-D HAVE_LILV_0_16_0=1 -D HAVE_LILV_0_19_2=1 -D HAVE_LILV_0_21_3=1 -D HAVE_SUIL=1 -D LV2_SUPPORT=1 -D LV2_EXTENDED=1 -D HAVE_GTK=1 -D HAVE_LIBS_GTKMM2EXT=1 \
+	-D HAVE_SUIL=1 -D LV2_SUPPORT=1 -D LV2_EXTENDED=1 -D HAVE_GTK=1 -D HAVE_LIBS_GTKMM2EXT=1 \
 	-D HAVE_X11=1  -D LXVST_64BIT=1 -D LXVST_SUPPORT=1 -D HAVE_TAGLIB=1 -D HAVE_POSIX_MEMALIGN=1 -D HAVE_VAMPSDK=1 -D HAVE_VAMPHOSTSDK=1 -D HAVE_RUBBERBAND=1 -D ENABLE_NLS=1 \
 	-D HAVE_CURL=1 -D HAVE_LO=1 -D HAVE_LRDF=1 -D _VAMP_NO_PLUGIN_NAMESPACE=1 \
 	-I libs/ardour -I libs/pbd -I libs/lua -I gtk2_ardour -I libs/temporal -I libs/audiographer -I libs/ptformat -I libs/fst \
@@ -29,8 +29,11 @@ time ./tools/doxy2json/doxy2json -j 4 \
 	\
 	libs/ardour/*.cc libs/pbd/*.cc \
 	gtk2_ardour/*.cc \
+	libs/libltc/ltc/ltc.h \
 	/usr/include/cairomm-1.0/cairomm/context.h \
 	/usr/include/vamp-sdk/Plugin.h \
+	~/gtk/inst/include/cairomm-1.0/cairomm/context.h \
+	~/gtk/inst/include/vamp-sdk/Plugin.h \
 > $TMPFILE
 
 ls -lh $TMPFILE
@@ -46,8 +49,8 @@ foreach (json_decode (\$json, true) as \$a) {
 	\$a['decl'] = str_replace ('size_t', 'unsigned long', \$a['decl']);
 	\$a['decl'] = str_replace ('uint32_t', 'unsigned int', \$a['decl']);
 	\$a['decl'] = str_replace ('int32_t', 'int', \$a['decl']);
-	\$a['decl'] = str_replace ('framepos_t', 'long', \$a['decl']);
-	\$a['decl'] = str_replace ('framecnt_t', 'long', \$a['decl']);
+	\$a['decl'] = str_replace ('samplepos_t', 'long', \$a['decl']);
+	\$a['decl'] = str_replace ('samplecnt_t', 'long', \$a['decl']);
 	\$a['decl'] = str_replace ('frameoffset_t', 'long', \$a['decl']);
 	\$a['decl'] = str_replace ('int64_t', 'long', \$a['decl']);
 	\$a['decl'] = str_replace ('uint8_t', 'unsigned char', \$a['decl']);

tools/fmt-luadoc.php

@@ -105,6 +105,9 @@ function arg2lua ($argtype, $flags = 0) {
 	if ($arg == 'luabridge::LuaRef') {
 		return array ('Lua-Function' => $flags | 4);
 	}
+	if ($arg == 'LTC_TV_STANDARD') {
+		$arg = 'ARDOUR::DSP::LTC_TV_STANDARD';
+	}
 
 	# check Class declarations first
 	foreach (array_merge ($classes, $consts) as $b) {
@@ -871,10 +874,10 @@ Operations are performed on objects. One gets a reference to an object and then
 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.
+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 explicitly 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.
+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 inherits 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:
@@ -882,7 +885,7 @@ you cannot simply remove a track that is currently processing audio. There are v
 </p>
 <h3>Pass by Reference</h3>
 <p>
-Since lua functions are closures, C++ methods that pass arguments by reference cannot be used as-is.
+Since Lua functions are closures, C++ methods that pass arguments by reference cannot be used as-is.
 All parameters passed to a C++ method which uses references are returned as Lua Table.
 If the C++ method also returns a value it is prefixed. Two parameters are returned: the value and a Lua Table holding the parameters.
 </p>
@@ -934,12 +937,12 @@ print (rv, ref[1], ref[2])
 <h3>Pointer Classes</h3>
 <p>
 Libardour makes extensive use of reference counted <code>boost::shared_ptr</code> to manage lifetimes.
-The Lua bindings provide a complete abstration of this. There are no pointers in lua.
-For example a <?=typelink('ARDOUR:Route')?> is a pointer in C++, but lua functions operate on it like it was a class instance.
+The Lua bindings provide a complete abstraction of this. There are no pointers in Lua.
+For example a <?=typelink('ARDOUR:Route')?> is a pointer in C++, but Lua functions operate on it like it was a class instance.
 </p>
 <p>
-<code>shared_ptr</code> are reference counted. Once assigned to a lua variable, the C++ object will be kept and remains valid.
-It is good practice to assign references to lua <code>local</code> variables or reset the variable to <code>nil</code> to drop the ref.
+<code>shared_ptr</code> are reference counted. Once assigned to a Lua variable, the C++ object will be kept and remains valid.
+It is good practice to assign references to Lua <code>local</code> variables or reset the variable to <code>nil</code> to drop the ref.
 </p>
 <p>
 All pointer classes have a <code>isnil ()</code> method. This is for two cases:
@@ -949,13 +952,13 @@ may not be able to find the given plugin and hence cannot create an object.
 <p>
 The second case if for <code>boost::weak_ptr</code>. As opposed to <code>boost::shared_ptr</code> weak-pointers are not reference counted.
 The object may vanish at any time.
-If lua code calls a method on a nil object, the interpreter will raise an exception and the script will not continue.
+If Lua code calls a method on a nil object, the interpreter will raise an exception and the script will not continue.
 This is not unlike <code>a = nil a:test()</code> which results in en error "<em>attempt to index a nil value</em>".
 </p>
 <p>
-From the lua side of things there is no distinction between weak and shared pointers. They behave identically.
-Below they're inidicated in orange and have an arrow to indicate the pointer type.
-Pointer Classes cannot be created in lua scripts. It always requires a call to C++ to create the Object and obtain a reference to it.
+From the Lua side of things there is no distinction between weak and shared pointers. They behave identically.
+Below they're indicated in orange and have an arrow to indicate the pointer type.
+Pointer Classes cannot be created in Lua scripts. It always requires a call to C++ to create the Object and obtain a reference to it.
 </p>
 
 

tools/update_luadoc.sh

@@ -22,7 +22,7 @@ if test -f $AMANUAL/include/class-reference.html; then
 	php $DIR/fmt-luadoc.php -m > $AMANUAL/include/class-reference.html
 	ls -l $AMANUAL/include/class-reference.html
 	cd $AMANUAL/
-	./build.py
+	./build.py --nopdf
 else
 	php $DIR/fmt-luadoc.php > /tmp/luadoc.html
 	ls -l /tmp/luadoc.html