LuaXML

AutoPlay Media Studio Addons and Plugin Directory

LuaXML

Overview LuaXML provides a minimal set of functions for the processing of XML data in Lua. It offers a very simple and natural mapping between the XML data format and Lua tables, which allows one to parse XML data just using Lua's normal table access and iteration methods. Child elements and text content are represented as array data having numerical keys, with a string at index 0 representing the name of an element's tag. Attributes are represented as array data having string keys, i.e. name/value pairs. LuaXML is published under the same liberal licensing conditions as Lua itself. This means that LuaXML is free software and can be freely used for both academic and commercial purposes. Download A zip file containing the source code and compiled binaries can be found at: http://www.viremo.de/LuaXML/ Installation Here is how to make the LuaXML module available to your AutoPlay Media Studio 8.0 project: 1. Download the LuaXML module and extract it to a temporary location. 2. Copy the LuaXml.lua and LuaXML_lib.dll files to your project's Scripts folder. 3. Add the following require to your project, e.g. in Global Functions: require("LuaXml") Usage The LuaXML functions are documented here: http://www.viremo.de/LuaXML/#documentation The LuaXML module works off native Lua data and represents XML as a table where: - the tag for an element is stored at index 0 - child elements/content are numerically indexed beginning at index 1 - attributes are represented by name/value pairs For example, this bit of XML: <items> <note id="1" date="2010-05-07"> <to>Everyone</to> <from>Will</from> <heading>Reminder</heading> <body>AutoPlay needs more cowbell.</body> </note> <image date="2010-05-07" file="cowbell.jpg" /> <sound date="2010-05-07" file="cowbell.mp3" /> </items> ...would be represented by the following table: tb = {[0]="items", {[0]="note", date="2010-05-07", id="1", {[0]="to","Everyone"}, {[0]="from","Will"}, {[0]="heading","Reminder"}, {[0]="body","AutoPlay needs more cowbell."} }, {[0]="image", file="cowbell.jpg", date="2010-05-07"}, {[0]="sound", file="cowbell.mp3", date="2010-05-07"}}; This makes modifying the XML very easy; you can modify any part of the XML just by changing the table. Examples For many Lua examples it helps to define an AutoPlay-compatible print function. For example, you can add the following function to your Global Functions to redirect all print output to a Debug window: function print (...) Debug.ShowWindow(true); local p = ""; for i,v in ipairs(arg) do p = p .. string.gsub(tostring(v),"r?n","rn") .. "t"; end p = p .. "rn"; Debug.Print(p); end -- The following example assumes you have the above print function defined. require("LuaXml") -- an example XML string local str = [[ <items> <note id="1" date="2010-05-07"> <to>Everyone</to> <from>Will</from> <heading>Reminder</heading> <body>AutoPlay needs more cowbell.</body> </note> <note id="2" date="2010-05-07"> <to>Mark</to> <from>Lorne</from> <heading>Movie?</heading> <body>Still want to go see that movie next week?</body> </note> <image date="2010-05-08" file="fax_0023.png" /> <sound date="2010-05-08" file="message_0086.mp3" /> <note id="3" date="2012-12-21"> <to>World</to> <from>CATS</from> <heading>All your base are belong to us</heading> <body>You have no chance to survive make your time</body> </note> </items> ]] -- load XML data from a string into local table xfile local x = xml.eval(str); -- you can change the xml by modifying the table directly -- attributes are stored as key-value pairs -- elements are numerically indexed -- search for note element with attribute id="3" local xnote = x:find("note", "id", "3") -- if found... if xnote then -- ...print it print("Before:") print(xnote); print("-------------n") -- change the date attribute xnote["date"] = "2036-04-13" -- add a new time attribute xnote["time"] = "16:45" -- add another node and set its value xnote:append("comment")[1] = "Somebody set up us the bomb." print("After:") print(xnote); print("-------------n") -- note that changing the xnote table also changed the x table -- which represents the entire xml document -- convert the xml to a string and print it print(x:str()); end print("-------------") -- print the values of all the heading elements for i,node in ipairs(x) do -- only process the note elements if (node:tag() == "note") then -- search for a heading element inside this note local h = node:find("heading") if h then -- print the value of the heading element print(h[1]); end end end Note that the LuaXML module isn't limited to table data and can convert any Lua variable to XML using xml.str(), xml.save(), etc. For example, myString = "Hello World"; print(xml.str(myString)); ...produces this output: <string> Hello World </string> A table containing a list of numerically indexed items, with nothing at index 0, like this: tb = {"apple","orange","peach","lemon","kiwi","watermelon"} print(xml.str(tb)); ...produces this output: <table> apple orange peach lemon kiwi watermelon </table> Name/value pairs inside a table become attributes, so: tb = { ["apple"]="green", ["orange"]="orange", ["peach"]="peach", ["lemon"]="yellow", ["kiwi"]="green", ["watermelon"]="red" } print(xml.str(tb)); ...produces this output: <table watermelon="red" peach="peach" kiwi="green" apple="green" orange="orange" lemon="yellow" /> Note that if you don't specify the tag at index 0 or as a parameter in the xml.str() call, the tag name for the outer element is based on the data type, e.g. "string" and "table" above. License LuaXML is licensed under the terms of the MIT license reproduced below, the same as Lua itself. This means that LuaXML is free software and can be freely used for both academic and commercial purposes. Copyright (C) 2007-2009 Gerald Franz, www.viremo.de Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Keywords	LUA Modules LuaXML
Category	LUA Modules
Download (External)	http://viremo.eludi.net/LuaXML/LuaXML_101012.zip
Date Submitted	Jun 2, 2010
Contact Name	Indigo Rose Software
Email	send email to Indigo Rose Software
More Info	http://viremo.eludi.net/LuaXML/index.html
Write a Review Report Broken Link

Links by indigorose

Other links in this category

Category List

Audio (3)
LUA Modules (10)
Templates (0)
Buttons (5)
Plugins (48)
Tools (0)
Examples (4)
Scripts (2)
Tutorials (0)
Images (2)
Skins (0)

All items listed in this directory are intended for use with AutoPlay Media Studio 8 and may not work correctly with previous versions.

Copyright © 2010 Indigo Rose Software. All Rights Reserved. Terms of Use. Privacy Policy