Go to file

Dmitry Ledentsov 7b6300707b Update README.md		2012-10-02 10:00:10 +03:00
contrib	missing valid methods, README	2012-10-02 06:49:35 +02:00
docs	docs: Regenerated HTML documentation	2012-04-30 15:37:36 +00:00
Lua	missing valid methods, README	2012-10-02 06:49:35 +02:00
LuaBridge@7a0d8a4a8c	lua wrapper for pugixml using luabridge\n todo: proper project description	2012-10-01 22:39:56 +02:00
scripts	moved to contrib directory	2012-10-01 22:46:52 +02:00
src	Fix find_child_by_attribute assertion for attributes with null name/value.	2012-09-29 06:36:29 +00:00
tests	Fix find_child_by_attribute assertion for attributes with null name/value.	2012-09-29 06:36:29 +00:00
.gitignore	initial commit	2012-10-01 22:42:05 +02:00
.gitmodules	lua wrapper for pugixml using luabridge\n todo: proper project description	2012-10-01 22:39:56 +02:00
Jamfile.jam	Updated version number and copyright year everywhere	2012-04-03 05:04:07 +00:00
Jamrules.jam	tests: Fixed gcc version detection	2012-03-07 09:01:36 +00:00
Notepad++.lnk	initial commit	2012-10-01 22:42:05 +02:00
pugixml_readme.txt	missing valid methods, README	2012-10-02 06:49:35 +02:00
README.md	Update README.md	2012-10-02 10:00:10 +03:00

README.md

pugilua

An almost one-to-one lua binding for pugixm;. Currently, work in progress ...

Usage

Use the visual studio project to compile in Visual Studio. The release build will be copied into the Lua/lib folder, where you can start lua directly and use the library by calling require 'pugilua'. Follow the test for API differences from the original C++ API. Pugilua objects reside in the pugi 'namespace' in Lua.

A usage sketch:

require 'pugilua'

local doc=pugi.xml_document()
local res=doc:load_file [[..\..\scripts\pugilua\pugilua.vcxproj]]
assert(res.valid)
print(res.description)

local node=doc:child('Project')
assert(node.valid)

API differences

There's no explicit cast to boolean of the pugilua objects, hence the classes xml_parse_result, xml_node and xml_document have a boolean property valid
lua classes have no inheritance
Getter methods are mapped to lua properties and not methods

Dependencies

pugixml the original library
lua the language, Lua 5.1.4 from luaforwindows, but it should work for every proper lua which is supported by LuaBridge
LuaBridge for the declarative bindings to Lua

License

This library is distributed under the MIT License:

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.