ardour/ardour
ardour
/
ardour
13
1
Fork 0
Code Pull Requests Releases Activity

update luadoc

This commit is contained in:
Robin Gareus 2016-03-22 00:50:14 +01:00
parent d062e1a84e
commit e105d50d66
2 changed files with 204 additions and 198 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

382
doc/luadoc.json
View File

@ -1,5 +1,5 @@
[ [
{"version" : "4.7-421-g7083d71"}, {"version" : "4.7-430-g307f0b4"},
{"type" : "[C] Class", {"type" : "[C] Class",
"lua" : "C:StringList", "lua" : "C:StringList",
@ -269,14 +269,124 @@
"decl" : "PBD::Controllable::GroupControlDisposition" "decl" : "PBD::Controllable::GroupControlDisposition"
}, },
{"type" : "[C] Class", {"type" : "[C] Class",
"lua" : "ARDOUR:BBT_TIME", "lua" : "Timecode:BBT_TIME",
"decl" : "Timecode::BBT_Time" "decl" : "Timecode::BBT_Time"
}, },
{"type" : "Constructor", {"type" : "Constructor",
"lua" : "ARDOUR:BBT_TIME:", "lua" : "Timecode:BBT_TIME:",
"ret" : "void", "ret" : "void",
"decl" : "void (*)(unsigned int, unsigned int, unsigned int)" "decl" : "void (*)(unsigned int, unsigned int, unsigned int)"
}, },
{"type" : "[C] Class",
"lua" : "Evoral:Parameter",
"decl" : "Evoral::Parameter"
},
{"type" : "Constructor",
"lua" : "Evoral:Parameter:",
"ret" : "void",
"decl" : "void (*)(unsigned int, unsigned char, unsigned int)"
},
{"type" : "Member Function",
"lua" : "Evoral:Parameter:type",
"ret" : "unsigned int",
"decl" : "unsigned int (Evoral::Parameter::*)()"
},
{"type" : "Member Function",
"lua" : "Evoral:Parameter:channel",
"ret" : "unsigned char",
"decl" : "unsigned char (Evoral::Parameter::*)()"
},
{"type" : "Member Function",
"lua" : "Evoral:Parameter:id",
"ret" : "unsigned int",
"decl" : "unsigned int (Evoral::Parameter::*)()"
},
{"type" : "[C] Class",
"lua" : "Evoral:ControlList",
"decl" : "boost::weak_ptr<Evoral::ControlList>"
},
{"type" : "[C] Class",
"lua" : "Evoral:ControlList",
"decl" : "boost::shared_ptr<Evoral::ControlList>"
},
{"type" : "[C] Weak/Shared Pointer Class",
"lua" : "Evoral:ControlList",
"decl" : "Evoral::ControlList"
},
{"type" : "Weak/Shared Null Check",
"lua" : "Evoral:ControlList:isnil",
"ret" : "bool",
"decl" : "void (*)()"
},
{"type" : "Weak/Shared Pointer Function",
"lua" : "Evoral:ControlList:add",
"ret" : "void",
"decl" : "void (Evoral::ControlList::*)(double, double, bool, bool)"
},
{"type" : "[C] Class",
"lua" : "Evoral:ControlSet",
"decl" : "boost::weak_ptr<Evoral::ControlSet>"
},
{"type" : "[C] Class",
"lua" : "Evoral:ControlSet",
"decl" : "boost::shared_ptr<Evoral::ControlSet>"
},
{"type" : "[C] Weak/Shared Pointer Class",
"lua" : "Evoral:ControlSet",
"decl" : "Evoral::ControlSet"
},
{"type" : "Weak/Shared Null Check",
"lua" : "Evoral:ControlSet:isnil",
"ret" : "bool",
"decl" : "void (*)()"
},
{"type" : "[C] Class",
"lua" : "Evoral:Control",
"decl" : "boost::weak_ptr<Evoral::Control>"
},
{"type" : "[C] Class",
"lua" : "Evoral:Control",
"decl" : "boost::shared_ptr<Evoral::Control>"
},
{"type" : "[C] Weak/Shared Pointer Class",
"lua" : "Evoral:Control",
"decl" : "Evoral::Control"
},
{"type" : "Weak/Shared Null Check",
"lua" : "Evoral:Control:isnil",
"ret" : "bool",
"decl" : "void (*)()"
},
{"type" : "Weak/Shared Pointer Function",
"lua" : "Evoral:Control:list",
"ret" : "boost::shared_ptr<Evoral::ControlList>",
"decl" : "boost::shared_ptr<Evoral::ControlList> (Evoral::Control::*)()"
},
{"type" : "[C] Class",
"lua" : "Evoral:ParameterDescriptor",
"decl" : "Evoral::ParameterDescriptor"
},
{"type" : "Constructor",
"lua" : "Evoral:ParameterDescriptor:",
"ret" : "void",
"decl" : "void (*)()"
},
{"type" : "Data Member",
"lua" : "Evoral:ParameterDescriptor:lower",
"decl" : "float Evoral::ParameterDescriptor::*"
},
{"type" : "Data Member",
"lua" : "Evoral:ParameterDescriptor:upper",
"decl" : "float Evoral::ParameterDescriptor::*"
},
{"type" : "Data Member",
"lua" : "Evoral:ParameterDescriptor:normal",
"decl" : "float Evoral::ParameterDescriptor::*"
},
{"type" : "Data Member",
"lua" : "Evoral:ParameterDescriptor:toggled",
"decl" : "bool Evoral::ParameterDescriptor::*"
},
{"type" : "[C] Class", {"type" : "[C] Class",
"lua" : "ARDOUR:PluginInfo", "lua" : "ARDOUR:PluginInfo",
"decl" : "boost::weak_ptr<ARDOUR::PluginInfo>" "decl" : "boost::weak_ptr<ARDOUR::PluginInfo>"
@ -887,30 +997,6 @@
"ret" : "bool", "ret" : "bool",
"decl" : "void (*)()" "decl" : "void (*)()"
}, },
{"type" : "[C] Class",
"lua" : "ARDOUR:EvoralParameter",
"decl" : "Evoral::Parameter"
},
{"type" : "Constructor",
"lua" : "ARDOUR:EvoralParameter:",
"ret" : "void",
"decl" : "void (*)(unsigned int, unsigned char, unsigned int)"
},
{"type" : "Member Function",
"lua" : "ARDOUR:EvoralParameter:type",
"ret" : "unsigned int",
"decl" : "unsigned int (Evoral::Parameter::*)()"
},
{"type" : "Member Function",
"lua" : "ARDOUR:EvoralParameter:channel",
"ret" : "unsigned char",
"decl" : "unsigned char (Evoral::Parameter::*)()"
},
{"type" : "Member Function",
"lua" : "ARDOUR:EvoralParameter:id",
"ret" : "unsigned int",
"decl" : "unsigned int (Evoral::Parameter::*)()"
},
{"type" : "[C] Class", {"type" : "[C] Class",
"lua" : "ARDOUR:PresetRecord", "lua" : "ARDOUR:PresetRecord",
"decl" : "ARDOUR::Plugin::PresetRecord" "decl" : "ARDOUR::Plugin::PresetRecord"
@ -931,45 +1017,6 @@
"lua" : "ARDOUR:PresetRecord:valid", "lua" : "ARDOUR:PresetRecord:valid",
"decl" : "bool ARDOUR::Plugin::PresetRecord::*" "decl" : "bool ARDOUR::Plugin::PresetRecord::*"
}, },
{"type" : "[C] Class",
"lua" : "ARDOUR:EvoralControlList",
"decl" : "boost::weak_ptr<Evoral::ControlList>"
},
{"type" : "[C] Class",
"lua" : "ARDOUR:EvoralControlList",
"decl" : "boost::shared_ptr<Evoral::ControlList>"
},
{"type" : "[C] Weak/Shared Pointer Class",
"lua" : "ARDOUR:EvoralControlList",
"decl" : "Evoral::ControlList"
},
{"type" : "Weak/Shared Null Check",
"lua" : "ARDOUR:EvoralControlList:isnil",
"ret" : "bool",
"decl" : "void (*)()"
},
{"type" : "Weak/Shared Pointer Function",
"lua" : "ARDOUR:EvoralControlList:add",
"ret" : "void",
"decl" : "void (Evoral::ControlList::*)(double, double, bool, bool)"
},
{"type" : "[C] Class",
"lua" : "ARDOUR:EvoralControlSet",
"decl" : "boost::weak_ptr<Evoral::ControlSet>"
},
{"type" : "[C] Class",
"lua" : "ARDOUR:EvoralControlSet",
"decl" : "boost::shared_ptr<Evoral::ControlSet>"
},
{"type" : "[C] Weak/Shared Pointer Class",
"lua" : "ARDOUR:EvoralControlSet",
"decl" : "Evoral::ControlSet"
},
{"type" : "Weak/Shared Null Check",
"lua" : "ARDOUR:EvoralControlSet:isnil",
"ret" : "bool",
"decl" : "void (*)()"
},
{"type" : "[C] Derived Class", {"type" : "[C] Derived Class",
"lua" : "ARDOUR:Automatable", "lua" : "ARDOUR:Automatable",
"decl" : "boost::shared_ptr<ARDOUR::Automatable>", "decl" : "boost::shared_ptr<ARDOUR::Automatable>",
@ -995,53 +1042,6 @@
"ret" : "boost::shared_ptr<ARDOUR::AutomationControl>", "ret" : "boost::shared_ptr<ARDOUR::AutomationControl>",
"decl" : "boost::shared_ptr<ARDOUR::AutomationControl> (ARDOUR::Automatable::*)(Evoral::Parameter, bool)" "decl" : "boost::shared_ptr<ARDOUR::AutomationControl> (ARDOUR::Automatable::*)(Evoral::Parameter, bool)"
}, },
{"type" : "[C] Class",
"lua" : "ARDOUR:EvoralControl",
"decl" : "boost::weak_ptr<Evoral::Control>"
},
{"type" : "[C] Class",
"lua" : "ARDOUR:EvoralControl",
"decl" : "boost::shared_ptr<Evoral::Control>"
},
{"type" : "[C] Weak/Shared Pointer Class",
"lua" : "ARDOUR:EvoralControl",
"decl" : "Evoral::Control"
},
{"type" : "Weak/Shared Null Check",
"lua" : "ARDOUR:EvoralControl:isnil",
"ret" : "bool",
"decl" : "void (*)()"
},
{"type" : "Weak/Shared Pointer Function",
"lua" : "ARDOUR:EvoralControl:list",
"ret" : "boost::shared_ptr<Evoral::ControlList>",
"decl" : "boost::shared_ptr<Evoral::ControlList> (Evoral::Control::*)()"
},
{"type" : "[C] Class",
"lua" : "ARDOUR:EvoralParameterDescriptor",
"decl" : "Evoral::ParameterDescriptor"
},
{"type" : "Constructor",
"lua" : "ARDOUR:EvoralParameterDescriptor:",
"ret" : "void",
"decl" : "void (*)()"
},
{"type" : "Data Member",
"lua" : "ARDOUR:EvoralParameterDescriptor:lower",
"decl" : "float Evoral::ParameterDescriptor::*"
},
{"type" : "Data Member",
"lua" : "ARDOUR:EvoralParameterDescriptor:upper",
"decl" : "float Evoral::ParameterDescriptor::*"
},
{"type" : "Data Member",
"lua" : "ARDOUR:EvoralParameterDescriptor:normal",
"decl" : "float Evoral::ParameterDescriptor::*"
},
{"type" : "Data Member",
"lua" : "ARDOUR:EvoralParameterDescriptor:toggled",
"decl" : "bool Evoral::ParameterDescriptor::*"
},
{"type" : "[C] Derived Class", {"type" : "[C] Derived Class",
"lua" : "ARDOUR:ParameterDescriptor", "lua" : "ARDOUR:ParameterDescriptor",
"decl" : "ARDOUR::ParameterDescriptor", "decl" : "ARDOUR::ParameterDescriptor",
@ -2820,389 +2820,389 @@
"decl" : "int (*)(lua_State*)" "decl" : "int (*)(lua_State*)"
}, },
{"type" : "[C] Class", {"type" : "[C] Class",
"lua" : "ARDOUR:RegionSelection", "lua" : "ArdourUI:RegionSelection",
"decl" : "RegionSelection" "decl" : "RegionSelection"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:RegionSelection:clear_all", "lua" : "ArdourUI:RegionSelection:clear_all",
"ret" : "void", "ret" : "void",
"decl" : "void (RegionSelection::*)()" "decl" : "void (RegionSelection::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:RegionSelection:start", "lua" : "ArdourUI:RegionSelection:start",
"ret" : "long", "ret" : "long",
"decl" : "long (RegionSelection::*)()" "decl" : "long (RegionSelection::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:RegionSelection:end_frame", "lua" : "ArdourUI:RegionSelection:end_frame",
"ret" : "long", "ret" : "long",
"decl" : "long (RegionSelection::*)()" "decl" : "long (RegionSelection::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:RegionSelection:n_midi_regions", "lua" : "ArdourUI:RegionSelection:n_midi_regions",
"ret" : "unsigned long", "ret" : "unsigned long",
"decl" : "unsigned long (RegionSelection::*)()" "decl" : "unsigned long (RegionSelection::*)()"
}, },
{"type" : "[C] Class", {"type" : "[C] Class",
"lua" : "ARDOUR:ArdourMarker", "lua" : "ArdourUI:ArdourMarker",
"decl" : "ArdourMarker" "decl" : "ArdourMarker"
}, },
{"type" : "[C] Class", {"type" : "[C] Class",
"lua" : "ARDOUR:Editor", "lua" : "ArdourUI:Editor",
"decl" : "PublicEditor" "decl" : "PublicEditor"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:snap_type", "lua" : "ArdourUI:Editor:snap_type",
"ret" : "Editing::SnapType", "ret" : "Editing::SnapType",
"decl" : "Editing::SnapType (PublicEditor::*)()" "decl" : "Editing::SnapType (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:snap_mode", "lua" : "ArdourUI:Editor:snap_mode",
"ret" : "Editing::SnapMode", "ret" : "Editing::SnapMode",
"decl" : "Editing::SnapMode (PublicEditor::*)()" "decl" : "Editing::SnapMode (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:set_snap_mode", "lua" : "ArdourUI:Editor:set_snap_mode",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(Editing::SnapMode)" "decl" : "void (PublicEditor::*)(Editing::SnapMode)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:set_snap_threshold", "lua" : "ArdourUI:Editor:set_snap_threshold",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(double)" "decl" : "void (PublicEditor::*)(double)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:undo", "lua" : "ArdourUI:Editor:undo",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(unsigned int)" "decl" : "void (PublicEditor::*)(unsigned int)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:redo", "lua" : "ArdourUI:Editor:redo",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(unsigned int)" "decl" : "void (PublicEditor::*)(unsigned int)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:set_mouse_mode", "lua" : "ArdourUI:Editor:set_mouse_mode",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(Editing::MouseMode, bool)" "decl" : "void (PublicEditor::*)(Editing::MouseMode, bool)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:current_mouse_mode", "lua" : "ArdourUI:Editor:current_mouse_mode",
"ret" : "Editing::MouseMode", "ret" : "Editing::MouseMode",
"decl" : "Editing::MouseMode (PublicEditor::*)()" "decl" : "Editing::MouseMode (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:consider_auditioning", "lua" : "ArdourUI:Editor:consider_auditioning",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(boost::shared_ptr<ARDOUR::Region>)" "decl" : "void (PublicEditor::*)(boost::shared_ptr<ARDOUR::Region>)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:new_region_from_selection", "lua" : "ArdourUI:Editor:new_region_from_selection",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:separate_region_from_selection", "lua" : "ArdourUI:Editor:separate_region_from_selection",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:pixel_to_sample", "lua" : "ArdourUI:Editor:pixel_to_sample",
"ret" : "long", "ret" : "long",
"decl" : "long (PublicEditor::*)(double)" "decl" : "long (PublicEditor::*)(double)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:sample_to_pixel", "lua" : "ArdourUI:Editor:sample_to_pixel",
"ret" : "double", "ret" : "double",
"decl" : "double (PublicEditor::*)(long)" "decl" : "double (PublicEditor::*)(long)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:play_selection", "lua" : "ArdourUI:Editor:play_selection",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:play_with_preroll", "lua" : "ArdourUI:Editor:play_with_preroll",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:maybe_locate_with_edit_preroll", "lua" : "ArdourUI:Editor:maybe_locate_with_edit_preroll",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(long)" "decl" : "void (PublicEditor::*)(long)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:goto_nth_marker", "lua" : "ArdourUI:Editor:goto_nth_marker",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(int)" "decl" : "void (PublicEditor::*)(int)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:add_location_from_playhead_cursor", "lua" : "ArdourUI:Editor:add_location_from_playhead_cursor",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:remove_location_at_playhead_cursor", "lua" : "ArdourUI:Editor:remove_location_at_playhead_cursor",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:set_show_measures", "lua" : "ArdourUI:Editor:set_show_measures",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(bool)" "decl" : "void (PublicEditor::*)(bool)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:show_measures", "lua" : "ArdourUI:Editor:show_measures",
"ret" : "bool", "ret" : "bool",
"decl" : "bool (PublicEditor::*)()" "decl" : "bool (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:remove_tracks", "lua" : "ArdourUI:Editor:remove_tracks",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:effective_mouse_mode", "lua" : "ArdourUI:Editor:effective_mouse_mode",
"ret" : "Editing::MouseMode", "ret" : "Editing::MouseMode",
"decl" : "Editing::MouseMode (PublicEditor::*)()" "decl" : "Editing::MouseMode (PublicEditor::*)()"
}, },
{"type" : "Member Function RefReturn", {"type" : "Member Function RefReturn",
"lua" : "ARDOUR:Editor:do_import", "lua" : "ArdourUI:Editor:do_import",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(std::vector<std::string >, Editing::ImportDisposition, Editing::ImportMode, ARDOUR::SrcQuality, long&, boost::shared_ptr<ARDOUR::PluginInfo>)" "decl" : "void (PublicEditor::*)(std::vector<std::string >, Editing::ImportDisposition, Editing::ImportMode, ARDOUR::SrcQuality, long&, boost::shared_ptr<ARDOUR::PluginInfo>)"
}, },
{"type" : "Member Function RefReturn", {"type" : "Member Function RefReturn",
"lua" : "ARDOUR:Editor:do_embed", "lua" : "ArdourUI:Editor:do_embed",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(std::vector<std::string >, Editing::ImportDisposition, Editing::ImportMode, long&, boost::shared_ptr<ARDOUR::PluginInfo>)" "decl" : "void (PublicEditor::*)(std::vector<std::string >, Editing::ImportDisposition, Editing::ImportMode, long&, boost::shared_ptr<ARDOUR::PluginInfo>)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:export_audio", "lua" : "ArdourUI:Editor:export_audio",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:stem_export", "lua" : "ArdourUI:Editor:stem_export",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:export_selection", "lua" : "ArdourUI:Editor:export_selection",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:export_range", "lua" : "ArdourUI:Editor:export_range",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:set_zoom_focus", "lua" : "ArdourUI:Editor:set_zoom_focus",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(Editing::ZoomFocus)" "decl" : "void (PublicEditor::*)(Editing::ZoomFocus)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:get_zoom_focus", "lua" : "ArdourUI:Editor:get_zoom_focus",
"ret" : "Editing::ZoomFocus", "ret" : "Editing::ZoomFocus",
"decl" : "Editing::ZoomFocus (PublicEditor::*)()" "decl" : "Editing::ZoomFocus (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:get_current_zoom", "lua" : "ArdourUI:Editor:get_current_zoom",
"ret" : "long", "ret" : "long",
"decl" : "long (PublicEditor::*)()" "decl" : "long (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:reset_zoom", "lua" : "ArdourUI:Editor:reset_zoom",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(long)" "decl" : "void (PublicEditor::*)(long)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:select_all_tracks", "lua" : "ArdourUI:Editor:select_all_tracks",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:deselect_all", "lua" : "ArdourUI:Editor:deselect_all",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:set_stationary_playhead", "lua" : "ArdourUI:Editor:set_stationary_playhead",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(bool)" "decl" : "void (PublicEditor::*)(bool)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:stationary_playhead", "lua" : "ArdourUI:Editor:stationary_playhead",
"ret" : "bool", "ret" : "bool",
"decl" : "bool (PublicEditor::*)()" "decl" : "bool (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:set_follow_playhead", "lua" : "ArdourUI:Editor:set_follow_playhead",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(bool, bool)" "decl" : "void (PublicEditor::*)(bool, bool)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:follow_playhead", "lua" : "ArdourUI:Editor:follow_playhead",
"ret" : "bool", "ret" : "bool",
"decl" : "bool (PublicEditor::*)()" "decl" : "bool (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:dragging_playhead", "lua" : "ArdourUI:Editor:dragging_playhead",
"ret" : "bool", "ret" : "bool",
"decl" : "bool (PublicEditor::*)()" "decl" : "bool (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:leftmost_sample", "lua" : "ArdourUI:Editor:leftmost_sample",
"ret" : "long", "ret" : "long",
"decl" : "long (PublicEditor::*)()" "decl" : "long (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:current_page_samples", "lua" : "ArdourUI:Editor:current_page_samples",
"ret" : "long", "ret" : "long",
"decl" : "long (PublicEditor::*)()" "decl" : "long (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:visible_canvas_height", "lua" : "ArdourUI:Editor:visible_canvas_height",
"ret" : "double", "ret" : "double",
"decl" : "double (PublicEditor::*)()" "decl" : "double (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:temporal_zoom_step", "lua" : "ArdourUI:Editor:temporal_zoom_step",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(bool)" "decl" : "void (PublicEditor::*)(bool)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:override_visible_track_count", "lua" : "ArdourUI:Editor:override_visible_track_count",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:scroll_tracks_down_line", "lua" : "ArdourUI:Editor:scroll_tracks_down_line",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:scroll_tracks_up_line", "lua" : "ArdourUI:Editor:scroll_tracks_up_line",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:scroll_down_one_track", "lua" : "ArdourUI:Editor:scroll_down_one_track",
"ret" : "bool", "ret" : "bool",
"decl" : "bool (PublicEditor::*)(bool)" "decl" : "bool (PublicEditor::*)(bool)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:scroll_up_one_track", "lua" : "ArdourUI:Editor:scroll_up_one_track",
"ret" : "bool", "ret" : "bool",
"decl" : "bool (PublicEditor::*)(bool)" "decl" : "bool (PublicEditor::*)(bool)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:reset_x_origin", "lua" : "ArdourUI:Editor:reset_x_origin",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(long)" "decl" : "void (PublicEditor::*)(long)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:get_y_origin", "lua" : "ArdourUI:Editor:get_y_origin",
"ret" : "double", "ret" : "double",
"decl" : "double (PublicEditor::*)()" "decl" : "double (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:reset_y_origin", "lua" : "ArdourUI:Editor:reset_y_origin",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(double)" "decl" : "void (PublicEditor::*)(double)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:remove_last_capture", "lua" : "ArdourUI:Editor:remove_last_capture",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:maximise_editing_space", "lua" : "ArdourUI:Editor:maximise_editing_space",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:restore_editing_space", "lua" : "ArdourUI:Editor:restore_editing_space",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:toggle_meter_updating", "lua" : "ArdourUI:Editor:toggle_meter_updating",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)()" "decl" : "void (PublicEditor::*)()"
}, },
{"type" : "Member Function RefReturn", {"type" : "Member Function RefReturn",
"lua" : "ARDOUR:Editor:get_nudge_distance", "lua" : "ArdourUI:Editor:get_nudge_distance",
"ret" : "long", "ret" : "long",
"decl" : "long (PublicEditor::*)(long, long&)" "decl" : "long (PublicEditor::*)(long, long&)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:get_paste_offset", "lua" : "ArdourUI:Editor:get_paste_offset",
"ret" : "long", "ret" : "long",
"decl" : "long (PublicEditor::*)(long, unsigned int, long)" "decl" : "long (PublicEditor::*)(long, unsigned int, long)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:get_grid_beat_divisions", "lua" : "ArdourUI:Editor:get_grid_beat_divisions",
"ret" : "unsigned int", "ret" : "unsigned int",
"decl" : "unsigned int (PublicEditor::*)(long)" "decl" : "unsigned int (PublicEditor::*)(long)"
}, },
{"type" : "Member Function RefReturn", {"type" : "Member Function RefReturn",
"lua" : "ARDOUR:Editor:get_grid_type_as_beats", "lua" : "ArdourUI:Editor:get_grid_type_as_beats",
"ret" : "Evoral::Beats", "ret" : "Evoral::Beats",
"decl" : "Evoral::Beats (PublicEditor::*)(bool&, long)" "decl" : "Evoral::Beats (PublicEditor::*)(bool&, long)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:toggle_ruler_video", "lua" : "ArdourUI:Editor:toggle_ruler_video",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(bool)" "decl" : "void (PublicEditor::*)(bool)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:toggle_xjadeo_proc", "lua" : "ArdourUI:Editor:toggle_xjadeo_proc",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(int)" "decl" : "void (PublicEditor::*)(int)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:get_videotl_bar_height", "lua" : "ArdourUI:Editor:get_videotl_bar_height",
"ret" : "int", "ret" : "int",
"decl" : "int (PublicEditor::*)()" "decl" : "int (PublicEditor::*)()"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:set_video_timeline_height", "lua" : "ArdourUI:Editor:set_video_timeline_height",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(int)" "decl" : "void (PublicEditor::*)(int)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:center_screen", "lua" : "ArdourUI:Editor:center_screen",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(long)" "decl" : "void (PublicEditor::*)(long)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:get_smart_mode", "lua" : "ArdourUI:Editor:get_smart_mode",
"ret" : "bool", "ret" : "bool",
"decl" : "bool (PublicEditor::*)()" "decl" : "bool (PublicEditor::*)()"
}, },
{"type" : "Member Function RefReturn", {"type" : "Member Function RefReturn",
"lua" : "ARDOUR:Editor:get_pointer_position", "lua" : "ArdourUI:Editor:get_pointer_position",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(double&, double&)" "decl" : "void (PublicEditor::*)(double&, double&)"
}, },
{"type" : "Member Function RefReturn", {"type" : "Member Function RefReturn",
"lua" : "ARDOUR:Editor:find_location_from_marker", "lua" : "ArdourUI:Editor:find_location_from_marker",
"ret" : "ARDOUR::Location*", "ret" : "ARDOUR::Location*",
"decl" : "ARDOUR::Location* (PublicEditor::*)(ArdourMarker*, bool&)" "decl" : "ARDOUR::Location* (PublicEditor::*)(ArdourMarker*, bool&)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:find_marker_from_location_id", "lua" : "ArdourUI:Editor:find_marker_from_location_id",
"ret" : "ArdourMarker*", "ret" : "ArdourMarker*",
"decl" : "ArdourMarker* (PublicEditor::*)(PBD::ID, bool)" "decl" : "ArdourMarker* (PublicEditor::*)(PBD::ID, bool)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:mouse_add_new_marker", "lua" : "ArdourUI:Editor:mouse_add_new_marker",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(long, bool)" "decl" : "void (PublicEditor::*)(long, bool)"
}, },
{"type" : "Member Function", {"type" : "Member Function",
"lua" : "ARDOUR:Editor:access_action", "lua" : "ArdourUI:Editor:access_action",
"ret" : "void", "ret" : "void",
"decl" : "void (PublicEditor::*)(std::string, std::string)" "decl" : "void (PublicEditor::*)(std::string, std::string)"
}, },

20
tools/fmt-luadoc.php
View File

@ -202,7 +202,7 @@ foreach ($doc as $b) {
switch (stripclass($ns, $b['lua'])) { switch (stripclass($ns, $b['lua'])) {
case 'add': case 'add':
$args = array (array ('LuaTable {'.$templ[1].'}' => 0)); $args = array (array ('LuaTable {'.$templ[1].'}' => 0));
$ret = array ('void' => 0); $ret = array ('LuaTable' => 0);
break; break;
case 'iter': case 'iter':
$args = array (); $args = array ();
@ -235,6 +235,7 @@ foreach ($doc as $b) {
} }
} }
$classlist[luafn2class ($b['lua'])]['func'][] = array ( $classlist[luafn2class ($b['lua'])]['func'][] = array (
'bind' => $b,
'name' => $b['lua'], 'name' => $b['lua'],
'args' => $args, 'args' => $args,
'ret' => $ret, 'ret' => $ret,
@ -245,6 +246,7 @@ foreach ($doc as $b) {
case "Free Function": case "Free Function":
case "Free Function RefReturn": case "Free Function RefReturn":
$funclist[luafn2class ($b['lua'])][] = array ( $funclist[luafn2class ($b['lua'])][] = array (
'bind' => $b,
'name' => $b['lua'], 'name' => $b['lua'],
'args' => decl2args ($b['decl']), 'args' => decl2args ($b['decl']),
'ret' => arg2lua ($b['ret']), 'ret' => arg2lua ($b['ret']),
@ -261,6 +263,7 @@ foreach ($doc as $b) {
case "Static Member Function": case "Static Member Function":
checkclass ($b); checkclass ($b);
$classlist[luafn2class ($b['lua'])]['func'][] = array ( $classlist[luafn2class ($b['lua'])]['func'][] = array (
'bind' => $b,
'name' => $b['lua'], 'name' => $b['lua'],
'args' => decl2args ($b['decl']), 'args' => decl2args ($b['decl']),
'ret' => arg2lua ($b['ret']), 'ret' => arg2lua ($b['ret']),
@ -380,7 +383,9 @@ function typelink ($a, $short = false, $argcls = '', $linkcls = '', $suffix = ''
global $constlist; global $constlist;
# all cross-reference links are generated here. # all cross-reference links are generated here.
# currently anchors on a single page. # currently anchors on a single page.
if (in_array ($a, array_keys ($classlist))) { if (isset($classlist[$a]['free'])) {
return '<a class="'.$linkcls.'" href="#'.htmlentities ($a).'">'.($short ? shortname($a) : ctorname($a)).$suffix.'</a>';
} else if (in_array ($a, array_keys ($classlist))) {
return '<a class="'.$linkcls.'" href="#'.htmlentities($a).'">'.($short ? shortname($a) : htmlentities($a)).$suffix.'</a>'; return '<a class="'.$linkcls.'" href="#'.htmlentities($a).'">'.($short ? shortname($a) : htmlentities($a)).$suffix.'</a>';
} else if (in_array ($a, array_keys ($constlist))) { } else if (in_array ($a, array_keys ($constlist))) {
return '<a class="'.$linkcls.'" href="#'.ctorname ($a).'">'.($short ? shortname($a) : ctorname($a)).$suffix.'</a>'; return '<a class="'.$linkcls.'" href="#'.ctorname ($a).'">'.($short ? shortname($a) : ctorname($a)).$suffix.'</a>';
@ -442,7 +447,7 @@ function format_class_members ($ns, $cl, &$dups) {
$rv.= typelink (varname ($f['ret']), true, 'em'); $rv.= typelink (varname ($f['ret']), true, 'em');
} }
$rv.= '</td><td class="decl">'; $rv.= '</td><td class="decl">';
$rv.= '<span class="functionname">'.stripclass ($ns, $f['name']).'</span>'; $rv.= '<span class="functionname"><abbr title="'.htmlentities($f['bind']['decl']).'">'.stripclass ($ns, $f['name']).'</abbr></span>';
$rv.= format_args ($f['args']); $rv.= format_args ($f['args']);
$rv.= '</td><td class="fill"></td></tr>'.NL; $rv.= '</td><td class="fill"></td></tr>'.NL;
} }
@ -488,6 +493,7 @@ table.classmembers td.def { text-align:right; padding-right:.5em; white-space:
table.classmembers td.decl { text-align:left; padding-left:.5em; white-space: nowrap; } table.classmembers td.decl { text-align:left; padding-left:.5em; white-space: nowrap; }
table.classmembers td.fill { width: 99%;} table.classmembers td.fill { width: 99%;}
table.classmembers span.em { font-style: italic;} table.classmembers span.em { font-style: italic;}
span.functionname abbr { text-decoration:none; cursor:default;}
div.header {text-align:center;} div.header {text-align:center;}
div.header h1 {margin:0;} div.header h1 {margin:0;}
div.header p {margin:.25em;} div.header p {margin:.25em;}
@ -529,16 +535,16 @@ foreach ($classlist as $ns => $cl) {
# format class title # format class title
if (empty ($tbl)) { if (empty ($tbl)) {
echo '<h2 id="'.$ns.'" class="cls opaque"><abbr title="Opaque Object">&empty;</abbr>&nbsp;'.$ns.'</h2>'.NL; echo '<h2 id="'.htmlentities ($ns).'" class="cls opaque"><abbr title="Opaque Object">&empty;</abbr>&nbsp;'.htmlentities ($ns).'</h2>'.NL;
} }
else if (isset ($classlist[$ns]['free'])) { else if (isset ($classlist[$ns]['free'])) {
echo '<h2 id="'.$ns.'" class="cls freeclass"><abbr title="Namespace">&Nopf;</abbr>&nbsp;'.$ns.'</h2>'.NL; echo '<h2 id="'.htmlentities ($ns).'" class="cls freeclass"><abbr title="Namespace">&Nopf;</abbr>&nbsp;'.ctorname($ns).'</h2>'.NL;
} }
else if (isset ($classlist[$ns]['arr'])) { else if (isset ($classlist[$ns]['arr'])) {
echo '<h2 id="'.$ns.'" class="cls array"><abbr title="C Array">&ctdot;</abbr>&nbsp;'.$ns.'</h2>'.NL; echo '<h2 id="'.htmlentities ($ns).'" class="cls array"><abbr title="C Array">&ctdot;</abbr>&nbsp;'.htmlentities ($ns).'</h2>'.NL;
} }
else if (isset ($classlist[$ns]['ptr'])) { else if (isset ($classlist[$ns]['ptr'])) {
echo '<h2 id="'.$ns.'" class="cls pointerclass"><abbr title="Pointer Class">&Rarr;</abbr>&nbsp;'.$ns.'</h2>'.NL; echo '<h2 id="'.htmlentities ($ns).'" class="cls pointerclass"><abbr title="Pointer Class">&Rarr;</abbr>&nbsp;'. htmlentities ($ns).'</h2>'.NL;
} else { } else {
echo '<h2 id="'.htmlentities ($ns).'" class="cls class"><abbr title="Class">&comp;</abbr>&nbsp;'.htmlentities ($ns).'</h2>'.NL; echo '<h2 id="'.htmlentities ($ns).'" class="cls class"><abbr title="Class">&comp;</abbr>&nbsp;'.htmlentities ($ns).'</h2>'.NL;
} }