missing valid methods, README

This commit is contained in:
d-led 2012-10-02 06:49:35 +02:00
parent d3f972a073
commit d20b9b5a96
7 changed files with 114 additions and 17 deletions

21
Lua/lib/LICENSE.txt Normal file
View File

@ -0,0 +1,21 @@
Copyright (C) 1994-2008 Lua.org, PUC-Rio.
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.

Binary file not shown.

Binary file not shown.

View File

@ -4,6 +4,7 @@ local doc=pugi.xml_document()
os.execute("cd") os.execute("cd")
local res=doc:load_file [[..\..\scripts\pugilua\pugilua.vcxproj]] local res=doc:load_file [[..\..\scripts\pugilua\pugilua.vcxproj]]
print(res.description) print(res.description)
assert(res.valid)
local node=doc:child('Project') local node=doc:child('Project')
assert(node.valid) assert(node.valid)

65
README.md Normal file
View File

@ -0,0 +1,65 @@
pugilua
=======
An almost one-to-one lua binding for [pugixm](http://pugixml.org/)
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](https://github.com/zeux/pugixml) the original library
* [lua](http://www.lua.org/) the language, Lua 5.1.4 from [luaforwindows](http://code.google.com/p/luaforwindows/), but it should work for every proper lua which is supported by LuaBridge
* [LuaBridge](https://github.com/vinniefalco/LuaBridge) for the declarative bindings to Lua
License
-------
This library is distributed under the MIT License:
Copyright (c) 2012 Dmitry Ledentsov
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.

View File

@ -12,12 +12,16 @@ namespace pugi {
public: public:
lxml_parse_result(pugi::xml_parse_result& r):res(r) { } lxml_parse_result(pugi::xml_parse_result& r):res(r) { }
lxml_parse_result() { } lxml_parse_result() { }
public: public:
std::string description() const { std::string description() const {
return res.description(); return res.description();
} }
bool valid() const {
return (bool)res;
}
private: private:
pugi::xml_parse_result res; pugi::xml_parse_result res;
}; };
@ -26,7 +30,7 @@ namespace pugi {
public: public:
lxml_node(pugi::xml_node& n):node(n){} lxml_node(pugi::xml_node& n):node(n){}
lxml_node() { } lxml_node() { }
public: public:
bool valid() const { bool valid() const {
return (bool)node; return (bool)node;
@ -55,6 +59,10 @@ namespace pugi {
return RefCountedPtr<lxml_node>(new lxml_node(doc.child(name))); return RefCountedPtr<lxml_node>(new lxml_node(doc.child(name)));
} }
bool valid() const {
return (bool)doc;
}
private: private:
pugi::xml_document doc; pugi::xml_document doc;
}; };
@ -67,23 +75,25 @@ void register_pugilua (lua_State* L) {
luabridge::getGlobalNamespace(L) luabridge::getGlobalNamespace(L)
.beginNamespace("pugi") .beginNamespace("pugi")
.beginClass<lxml_parse_result>("xml_parse_result") .beginClass<lxml_parse_result>("xml_parse_result")
.addConstructor<void (*)()>() .addConstructor<void (*)()>()
.addProperty("description",&lxml_parse_result::description) .addProperty("description",&lxml_parse_result::description)
.endClass() .addProperty("valid",&lxml_parse_result::valid)
.endClass()
.beginClass<lxml_node>("xml_node") .beginClass<lxml_node>("xml_node")
.addConstructor<void (*)()>() .addConstructor<void (*)()>()
.addProperty("valid",&lxml_node::valid) .addProperty("valid",&lxml_node::valid)
.addProperty("name",&lxml_node::name) .addProperty("name",&lxml_node::name)
.addFunction("child",&lxml_node::child) .addFunction("child",&lxml_node::child)
.endClass() .endClass()
.beginClass<lxml_document>("xml_document") .beginClass<lxml_document>("xml_document")
.addConstructor<void (*)()>() .addConstructor<void (*)()>()
.addFunction("load_file",&lxml_document::load_file) .addProperty("valid",&lxml_document::valid)
.addFunction("child",&lxml_document::child) .addFunction("load_file",&lxml_document::load_file)
.endClass() .addFunction("child",&lxml_document::child)
.endClass()
.endNamespace() .endNamespace()
; ;