xpathselect-1.4+14.04.20140303/0000755000015201777760000000000012305004473016271 5ustar pbusernogroup00000000000000xpathselect-1.4+14.04.20140303/test/0000755000015201777760000000000012305004473017250 5ustar pbusernogroup00000000000000xpathselect-1.4+14.04.20140303/test/test_xpath_tree.cpp0000644000015201777760000001471112305004311023151 0ustar pbusernogroup00000000000000/* * Copyright (C) 2012 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #include "gtest/gtest.h" #include "xpathselect.h" #include "node.h" #include "dummynode.h" #include class TestTreeFixture: public ::testing::Test { public: void SetUp() override { root_ = std::make_shared("Root"); child_l1_ = std::make_shared("ChildLeft1"); child_r1_ = std::make_shared("ChildRight1"); leaf_1_ = std::make_shared("Leaf"); leaf_2_ = std::make_shared("Leaf"); root_->AddChild(child_l1_); root_->AddChild(child_r1_); child_l1_->AddChild(leaf_1_); child_l1_->AddChild(leaf_2_); } typedef std::shared_ptr NodePtr; NodePtr root_; NodePtr child_l1_; NodePtr child_r1_; NodePtr leaf_1_; NodePtr leaf_2_; }; TEST_F(TestTreeFixture, test_simple) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/"); ASSERT_EQ(1, result.size()); } TEST_F(TestTreeFixture, test_simple_absolute) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root/ChildLeft1"); ASSERT_EQ(1, result.size()); auto expected = child_l1_; auto actual = result.front(); ASSERT_EQ(expected, actual); } TEST_F(TestTreeFixture, test_simple_relative) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "//ChildRight1"); ASSERT_EQ(1, result.size()); ASSERT_EQ(child_r1_, result.front()); } TEST_F(TestTreeFixture, test_complex_relative) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "//Root/ChildRight1"); ASSERT_EQ(1, result.size()); ASSERT_EQ(child_r1_, result.front()); } TEST_F(TestTreeFixture, test_relative_multiple_return) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "//Leaf"); ASSERT_EQ(2, result.size()); for(xpathselect::Node::Ptr n : result) { ASSERT_TRUE(n == leaf_1_ || n == leaf_2_ ); } } TEST_F(TestTreeFixture, test_relative_wildcard) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "//ChildLeft1/*"); ASSERT_EQ(2, result.size()); for(xpathselect::Node::Ptr n : result) { ASSERT_TRUE(n == leaf_1_ || n == leaf_2_ ); } } TEST_F(TestTreeFixture, test_absolute_wildcard) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root/ChildLeft1/*"); ASSERT_EQ(2, result.size()); for(xpathselect::Node::Ptr n : result) { ASSERT_TRUE(n == leaf_1_ || n == leaf_2_ ); } } TEST_F(TestTreeFixture, test_simple_absolute_property_match) { child_l1_->AddProperty("visible", "True"); xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root/ChildLeft1[visible=True]"); ASSERT_EQ(1, result.size()); ASSERT_EQ(child_l1_, result.front()); } TEST_F(TestTreeFixture, test_simple_relative_property_match) { child_l1_->AddProperty("visible", true); xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "//ChildLeft1[visible=True]"); ASSERT_EQ(1, result.size()); ASSERT_EQ(child_l1_, result.front()); } TEST_F(TestTreeFixture, test_absolute_multiple_property_match) { root_->AddProperty("number", 45); child_l1_->AddProperty("visible", true); xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root[number=45]/ChildLeft1[visible=True]"); ASSERT_EQ(1, result.size()); ASSERT_EQ(child_l1_, result.front()); } TEST_F(TestTreeFixture, test_mixed_query_simple) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root//Leaf"); ASSERT_EQ(2, result.size()); for(auto n : result) { ASSERT_TRUE(n == leaf_1_ || n == leaf_2_ ); } } TEST_F(TestTreeFixture, test_mixed_query_property_match) { leaf_1_->AddProperty("visible", true); xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root//Leaf[visible=True]"); ASSERT_EQ(1, result.size()); ASSERT_EQ(leaf_1_, result.front()); } TEST_F(TestTreeFixture, test_search_node_with_wildcard_and_property) { child_l1_->AddProperty("visible", true); xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root//*[visible=True]"); ASSERT_EQ(1, result.size()); ASSERT_EQ(child_l1_, result.front()); } TEST_F(TestTreeFixture, test_wildcard) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root/*"); ASSERT_EQ(2, result.size()); for(auto n : result) { ASSERT_TRUE(n == child_l1_ || n == child_r1_ ); } } TEST_F(TestTreeFixture, test_parent) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root/ChildLeft1/.."); ASSERT_EQ(1, result.size()); ASSERT_EQ(root_, result.front()); } TEST_F(TestTreeFixture, test_parent_on_root) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root/.."); ASSERT_EQ(1, result.size()); ASSERT_EQ(root_, result.front()); } TEST_F(TestTreeFixture, test_parent_on_leaf) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root/ChildLeft1/Leaf/.."); ASSERT_EQ(1, result.size()); ASSERT_EQ(child_l1_, result.front()); } TEST_F(TestTreeFixture, test_double_parent_on_leaf) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root/ChildLeft1/Leaf/../.."); ASSERT_EQ(1, result.size()); ASSERT_EQ(root_, result.front()); } TEST_F(TestTreeFixture, test_parent_and_child) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root/ChildLeft1/../ChildLeft1/../ChildLeft1"); ASSERT_EQ(1, result.size()); ASSERT_EQ(child_l1_, result.front()); } TEST_F(TestTreeFixture, test_invalid_query_search) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root///Leaf"); ASSERT_EQ(0, result.size()); } TEST_F(TestTreeFixture, test_invalid_query_multiple_searches) { xpathselect::NodeVector result = xpathselect::SelectNodes(root_, "/Root////"); ASSERT_EQ(0, result.size()); } xpathselect-1.4+14.04.20140303/test/test_xpath_simple.cpp0000644000015201777760000000453412305004311023505 0ustar pbusernogroup00000000000000/* * Copyright (C) 2012 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #include "gtest/gtest.h" #include "node.h" #include "xpathselect.h" #include "dummynode.h" // empty query must select tree root. TEST(TestXPath, test_select_empty_tree) { xpathselect::Node::Ptr tree_root = std::make_shared(); xpathselect::NodeVector result = xpathselect::SelectNodes(tree_root, ""); ASSERT_EQ(1, result.size()); } // test explicitly selecting tree root without node name TEST(TestXPath, test_select_tree_root) { xpathselect::Node::Ptr tree_root = std::make_shared("RootNode"); xpathselect::NodeVector result = xpathselect::SelectNodes(tree_root, "/"); ASSERT_EQ(result.size(), 1); ASSERT_EQ(result.front(), tree_root); } // test explicitly selecting tree root without node name TEST(TestXPath, test_select_tree_root_with_name) { xpathselect::Node::Ptr tree_root = std::make_shared("RootNode"); xpathselect::NodeVector result = xpathselect::SelectNodes(tree_root, "/RootNode"); ASSERT_EQ(result.size(), 1); ASSERT_EQ(result.front(), tree_root); } // test explicitly selecting tree root with relative query TEST(TestXPath, test_select_tree_root_with_relative_query) { xpathselect::Node::Ptr tree_root = std::make_shared("RootNode"); xpathselect::NodeVector result = xpathselect::SelectNodes(tree_root, "//RootNode"); ASSERT_EQ(result.size(), 1); ASSERT_EQ(result.front(), tree_root); } // test explicitly selecting tree root with relative query TEST(TestXPath, test_select_tree_root_with_empty_relative_query) { xpathselect::Node::Ptr tree_root = std::make_shared("RootNode"); xpathselect::NodeVector result = xpathselect::SelectNodes(tree_root, "//"); ASSERT_EQ(result.size(), 1); ASSERT_EQ(result.front(), tree_root); } xpathselect-1.4+14.04.20140303/test/CMakeLists.txt0000644000015201777760000000350712305004311022004 0ustar pbusernogroup00000000000000 include_directories(../lib) find_path(GTEST_SRC_DIR gtest.cc PATHS /usr/src/gtest/src) set(CMAKE_CXX_FLAGS "-ggdb -O0 -Wall") if(CMAKE_BUILD_TYPE STREQUAL "Debug") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DDEBUG" ) endif(CMAKE_BUILD_TYPE STREQUAL "Debug") # Detect if C++11 support is available, and attempt fallback to C++0x support if(CMAKE_COMPILER_IS_GNUCXX) execute_process(COMMAND ${CMAKE_C_COMPILER} -dumpversion OUTPUT_VARIABLE GCC_VERSION) if (GCC_VERSION VERSION_GREATER 4.7 OR GCC_VERSION VERSION_EQUAL 4.7) message(STATUS "C++11 activated.") add_definitions("-std=c++11") #run all tests set(SOURCES test_main.cpp test_xpath_simple.cpp test_xpath_tree.cpp dummynode.h test_parser.cpp) add_executable(test-runner ${SOURCES}) add_dependencies (test-runner gtest) add_dependencies (test-runner ../lib) target_link_libraries(test-runner gtest xpathselect) elseif(GCC_VERSION VERSION_GREATER 4.3 OR GCC_VERSION VERSION_EQUAL 4.3) message(WARNING "C++0x activated. Tests have been disabled") add_definitions("-std=c++0x") else () message(FATAL_ERROR "C++11 needed. Therefore a gcc compiler with a version higher than 4.3 is needed.") endif() else(CMAKE_COMPILER_IS_GNUCXX) add_definitions("-std=c++11") #turn on and hope non-gnu compiler supports it endif(CMAKE_COMPILER_IS_GNUCXX) # Check for google test and build it locally set( GTEST_ROOT_DIR "/usr/src/gtest" # Default value, adjustable by user with e.g., ccmake CACHE PATH "Path to Google test srcs" ) find_path(GTEST_INCLUDE_DIR gtest/gtest.h) if (GTEST_INCLUDE_DIR) #FIXME - hardcoded is bad! add_subdirectory( ${GTEST_ROOT_DIR} gtest ) endif(GTEST_INCLUDE_DIR) enable_testing() add_test(TestSuite test-runner) add_custom_target (test COMMAND ./test-runner) xpathselect-1.4+14.04.20140303/test/dummynode.h0000644000015201777760000000577012305004311021422 0ustar pbusernogroup00000000000000/* * Copyright (C) 2012 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #ifndef _DUMMYNODE_H #define _DUMMYNODE_H #include "node.h" #include // simple implementation of the node interface for testing purposes. class DummyNode: public xpathselect::Node, public std::enable_shared_from_this { public: typedef std::shared_ptr Ptr; DummyNode(std::string name="DummyNode") : name_(name) { static int32_t id = 1; id_ = id++; } std::string GetName() const override { return name_; } std::string GetPath() const override { return std::string(); } int32_t GetId() const override { return id_; } void SetName(std::string const& name) { name_ = name; } bool MatchStringProperty(const std::string& name, const std::string& value) const override { auto it = string_properties_.find(name); if (it == string_properties_.end() || it->second != value) return false; return true; } bool MatchBooleanProperty(const std::string& name, bool value) const override { auto it = bool_properties_.find(name); if (it == bool_properties_.end() || it->second != value) return false; return true; } bool MatchIntegerProperty(const std::string& name, int value) const override { auto it = int_properties_.find(name); if (it == int_properties_.end() || it->second != value) return false; return true; } xpathselect::NodeVector Children() const override { return children_; } virtual Node::Ptr GetParent() const override { return parent_; } void AddChild(Ptr const& child) { child->parent_ = shared_from_this(); children_.push_back(child); } void AddProperty(std::string const& name, std::string const& value) { string_properties_[name] = value; } void AddProperty(std::string const& name, bool value) { bool_properties_[name] = value; } void AddProperty(std::string const& name, int value) { int_properties_[name] = value; } private: int32_t id_; std::string name_; xpathselect::Node::Ptr parent_; xpathselect::NodeVector children_; std::map string_properties_; std::map int_properties_; std::map bool_properties_; }; #endif xpathselect-1.4+14.04.20140303/test/test_parser.cpp0000644000015201777760000010273612305004331022311 0ustar pbusernogroup00000000000000/* * Copyright (C) 2012 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #include "gtest/gtest.h" #include "parser.h" #include "xpathquerypart.h" #include #include #include #include #include #include #include #include #include #include namespace qi = boost::spirit::qi; namespace ascii = boost::spirit::ascii; namespace parser = xpathselect::parser; // utility function to test parsers: template bool test_parser_attr(std::string input, P const& p, T& attr) { using boost::spirit::qi::parse; std::string::iterator f = input.begin(); std::string::iterator l = input.end(); if (parse(f, l, p, attr) && (f == l)) { return true; } else { return false; } } template bool test_parser_attr(std::string input, P const& p) { using boost::spirit::qi::parse; std::string::iterator f = input.begin(); std::string::iterator l = input.end(); if (parse(f, l, p) && (f == l)) { return true; } else { return false; } } // a boost static visitor that checks value equality and type equality. template class variant_equality_assertion : public boost::static_visitor<> { public: variant_equality_assertion( T const& expected) : expected_(expected) {} void operator()( T & operand ) const { ASSERT_EQ(expected_, operand); } template void operator()( U & operand ) const { FAIL() << "Variant contained incorrect type! Expected: '" << expected_ << "' Actual: '" << operand << "' Actual type is: " << typeid(U).name(); } private: T expected_; }; ////////////////////////////////////// // Tests for basic type support: ////////////////////////////////////// // Test python representations for boolean values: TEST(TestXPathParser, test_basic_type_boolean) { bool result = false; parser::xpath_grammar g; ASSERT_TRUE(test_parser_attr("True", g.bool_type, result)); ASSERT_TRUE(result); ASSERT_TRUE(test_parser_attr("False", g.bool_type, result)); ASSERT_FALSE(result); ASSERT_FALSE(test_parser_attr("true", g.bool_type, result)); ASSERT_FALSE(test_parser_attr("false", g.bool_type, result)); ASSERT_FALSE(test_parser_attr("1", g.bool_type, result)); ASSERT_FALSE(test_parser_attr("0", g.bool_type, result)); } // test character escape codes: class TestXPathParserCharacterEscapeCodes : public ::testing::TestWithParam > { }; TEST_P(TestXPathParserCharacterEscapeCodes, test_character_escape_codes) { auto p = GetParam(); std::string input = p.first; char expected_result = p.second; char actual_result = 0; parser::xpath_grammar g; ASSERT_TRUE(test_parser_attr(input, g.unesc_char, actual_result)); ASSERT_EQ(expected_result, actual_result); } INSTANTIATE_TEST_CASE_P(BasicCharacterCodes, TestXPathParserCharacterEscapeCodes, ::testing::Values( std::pair("\\a", '\a'), std::pair("\\b", '\b'), std::pair("\\f", '\f'), std::pair("\\n", '\n'), std::pair("\\r", '\r'), std::pair("\\t", '\t'), std::pair("\\v", '\v'), std::pair("\\\\", '\\'), std::pair("\\\'", '\''), std::pair("\\\"", '\"') )); class QuotedStringTests : public ::testing::TestWithParam > { }; TEST_P(QuotedStringTests, quoted_string_parameter_test) { std::string input = std::get<0>(GetParam()); std::string expected_output = std::get<1>(GetParam()); bool expected_pass = std::get<2>(GetParam()); std::string actual_result; parser::xpath_grammar g; ASSERT_EQ(expected_pass, test_parser_attr(input, g.unesc_str, actual_result)); if (expected_pass) ASSERT_EQ(expected_output, actual_result); } INSTANTIATE_TEST_CASE_P(BasicStrings, QuotedStringTests, ::testing::Values( std::make_tuple("\"Hello\"", "Hello", true), std::make_tuple("\"Hello World\"", "Hello World", true), std::make_tuple("\"a b c d\"", "a b c d", true), std::make_tuple("\"\\x41\"", "A", true), std::make_tuple("\"\\x08\"", "\b", true) )); INSTANTIATE_TEST_CASE_P(PunctuationStrings, QuotedStringTests, ::testing::Values( std::make_tuple("\".\"", ".", true), std::make_tuple("\",\"", ",", true), std::make_tuple("\"<\"", "<", true), std::make_tuple("\">\"", ">", true), std::make_tuple("\"/\"", "/", true), std::make_tuple("\"?\"", "?", true), std::make_tuple("\":\"", ":", true), std::make_tuple("\";\"", ";", true), std::make_tuple("\"'\"", "'", true), // '"' tested below std::make_tuple("\"[\"", "[", true), std::make_tuple("\"]\"", "]", true), std::make_tuple("\"{\"", "{", true), std::make_tuple("\"}\"", "}", true), std::make_tuple("\"\\\\\"", "\\", true), std::make_tuple("\"|\"", "|", true), std::make_tuple("\"~\"", "~", true), std::make_tuple("\"`\"", "`", true), std::make_tuple("\"!\"", "!", true), std::make_tuple("\"@\"", "@", true), std::make_tuple("\"#\"", "#", true), std::make_tuple("\"$\"", "$", true), std::make_tuple("\"%\"", "%", true), std::make_tuple("\"^\"", "^", true), std::make_tuple("\"&\"", "&", true), std::make_tuple("\"*\"", "*", true), std::make_tuple("\"(\"", "(", true), std::make_tuple("\")\"", ")", true), std::make_tuple("\"-\"", "-", true), std::make_tuple("\"_\"", "_", true), std::make_tuple("\"+\"", "+", true), std::make_tuple("\"=\"", "=", true) )); INSTANTIATE_TEST_CASE_P(QuoteStrings, QuotedStringTests, ::testing::Values( std::make_tuple("\"\\\"\"", "\"", true), std::make_tuple("\"\\\'\"", "\'", true) )); INSTANTIATE_TEST_CASE_P(NumberStrings, QuotedStringTests, ::testing::Values( std::make_tuple("\"0\"", "0", true), std::make_tuple("\"1\"", "1", true), std::make_tuple("\"2\"", "2", true), std::make_tuple("\"3\"", "3", true), std::make_tuple("\"4\"", "4", true), std::make_tuple("\"5\"", "5", true), std::make_tuple("\"6\"", "6", true), std::make_tuple("\"7\"", "7", true), std::make_tuple("\"8\"", "8", true), std::make_tuple("\"9\"", "9", true) )); TEST(TestIntegerTypes, test_signed_integers) { int result = 0; parser::xpath_grammar g; ASSERT_TRUE(test_parser_attr("123", g.int_type, result)); ASSERT_EQ(123, result); ASSERT_TRUE(test_parser_attr("+456", g.int_type, result)); ASSERT_EQ(456, result); ASSERT_TRUE(test_parser_attr("-123", g.int_type, result)); ASSERT_EQ(-123, result); } // This test fails due to a bug in boost::spirit: https://svn.boost.org/trac/boost/ticket/9007 // TEST(TestIntegerTypes, test_integer_overflow) // { // int result; // // store range of int in a long, since we'll be extending them // long min_int = std::numeric_limits::min(); // long max_int = std::numeric_limits::max(); // qi::int_parser r; // ASSERT_TRUE(test_parser_attr(std::to_string(min_int), r, result)); // ASSERT_EQ(min_int, result); // ASSERT_TRUE(test_parser_attr(std::to_string(max_int), r, result)); // ASSERT_EQ(max_int, result); // min_int -= 1; // max_int += 1; // // these last two assertions are failing. I expect the parsing to fail, but it's passing // // for some reason. // ASSERT_FALSE(test_parser_attr(std::to_string(min_int), r, result)) << min_int; // ASSERT_FALSE(test_parser_attr(std::to_string(max_int), r, result)) << max_int; // } //////////////////////////////////// // more complicated grammar tests //////////////////////////////////// /// Tests for parameter names: class TestXPathParserParamNames : public ::testing::TestWithParam > { }; TEST_P(TestXPathParserParamNames, test_param_name) { auto p = GetParam(); std::string input = p.first; bool expect_pass = p.second; parser::xpath_grammar g; std::string result; ASSERT_EQ( expect_pass, test_parser_attr(input, g.param_name, result) ); if (expect_pass) ASSERT_EQ(input, result); } INSTANTIATE_TEST_CASE_P(BasicNodeNames, TestXPathParserParamNames, ::testing::Values( std::pair("a b", false), std::pair("a*", false), std::pair("HelloWorld", true), std::pair("H", true), std::pair("h", true), std::pair("1", true), std::pair("node-name", true), std::pair("node_name", true), std::pair("node\\name", true), std::pair("node::name", false), std::pair("node.name", false), std::pair("node name", false), std::pair("..", false) )); /// Tests for parameter values. This test is much larger than it should be, since it seems to be // impossible to parameterise tests for both type and value. The solution I use here is to have // the actual test in a base class template method, and have several derive classes use different // value parameters. Ugly, but probably the best we can do with google test. class TestParamValues : public ::testing::Test { public: template void test_param_value(PairType const& input_pair) const { RecordProperty("FirstType", typeid(typename PairType::first_type).name()); RecordProperty("SecondType", typeid(typename PairType::second_type).name()); std::string input = input_pair.first; typename PairType::second_type expected_result = input_pair.second; parser::xpath_grammar g; xpathselect::XPathQueryParam::ParamValueType result; ASSERT_TRUE( test_parser_attr(input, g.param_value, result) ); boost::apply_visitor( variant_equality_assertion(expected_result), result ); } }; // test string parameter values: class TestStringParamValues : public ::testing::WithParamInterface > , public TestParamValues { }; TEST_P(TestStringParamValues, test_param_value_str) { auto p = GetParam(); test_param_value(p); } INSTANTIATE_TEST_CASE_P(StringParams, TestStringParamValues, ::testing::Values( std::pair("\"a b\"", "a b" ), std::pair("\"a.b,c/\\d^\"", "a.b,c/\\d^" ) )); // test boolean parameter values: class TestBoolParamValues : public ::testing::WithParamInterface > , public TestParamValues { }; TEST_P(TestBoolParamValues, test_param_value_bool) { auto p = GetParam(); test_param_value(p); } INSTANTIATE_TEST_CASE_P(StringParams, TestBoolParamValues, ::testing::Values( std::pair("True", true ), std::pair("False", false ) )); // test integer parameter values: class TestIntParamValues : public ::testing::WithParamInterface > , public TestParamValues { }; TEST_P(TestIntParamValues, test_param_value_bool) { auto p = GetParam(); test_param_value(p); } INSTANTIATE_TEST_CASE_P(IntegerParams, TestIntParamValues, ::testing::Values( std::pair("123", 123 ), std::pair("0", 0 ), std::pair("-123", -123 ) )); /// Tests for the node names: class TestXPathParserNodeNames : public ::testing::TestWithParam > { }; TEST_P(TestXPathParserNodeNames, test_spec_node_name) { auto p = GetParam(); std::string input = p.first; bool expect_pass = p.second; parser::xpath_grammar g; std::string result; ASSERT_EQ( expect_pass, test_parser_attr(input, g.spec_node_name, result) ); if (expect_pass) ASSERT_EQ(input, result); } INSTANTIATE_TEST_CASE_P(BasicNodeNames, TestXPathParserNodeNames, ::testing::Values( std::pair("a b", true), std::pair("a ", false), std::pair(" ", false), std::pair(" b", false), std::pair("a b", true), std::pair("a b b a", true), std::pair("a*", false), std::pair("HelloWorld", true), std::pair("H", true), std::pair("h", true), std::pair("1", true), std::pair("node-name", true), std::pair("node_name", true), std::pair("node\\name", true), std::pair("node::name", true), std::pair("node::name::extra", true) )); class TestXPathParserWildcardNodeName : public ::testing::TestWithParam > { }; TEST_P(TestXPathParserWildcardNodeName, test_wildcard_node_name_rejects_everything_else) { auto p = GetParam(); std::string input = p.first; bool expect_pass = p.second; parser::xpath_grammar g; std::string result; ASSERT_EQ( expect_pass, test_parser_attr(input, g.wildcard_node_name, result) ); if (expect_pass) ASSERT_EQ(input, result); } INSTANTIATE_TEST_CASE_P(BasicNodeNames, TestXPathParserWildcardNodeName, ::testing::Values( std::pair("", false), std::pair("* ", false), std::pair("**", false), std::pair(" ", false), std::pair("8", false), std::pair("\t", false), std::pair("node-name", false), std::pair("node_name", false), std::pair("*", true) )); TEST(TestXPathParser, test_param_parser_string_value_works) { std::string input("name=\"value\""); parser::xpath_grammar g; xpathselect::XPathQueryParam result; ASSERT_EQ( true, test_parser_attr(input, g.param, result) ); ASSERT_EQ("name", result.param_name); boost::apply_visitor( variant_equality_assertion("value"), result.param_value ); } TEST(TestXPathParser, test_param_parser_bool_value_works) { std::string input("name=True"); parser::xpath_grammar g; xpathselect::XPathQueryParam result; ASSERT_EQ( true, test_parser_attr(input, g.param, result) ); ASSERT_EQ("name", result.param_name); boost::apply_visitor( variant_equality_assertion(true), result.param_value ); } TEST(TestXPathParser, test_param_parser_string_int_works) { std::string input("name=123456"); parser::xpath_grammar g; xpathselect::XPathQueryParam result; ASSERT_EQ( true, test_parser_attr(input, g.param, result) ); ASSERT_EQ("name", result.param_name); boost::apply_visitor( variant_equality_assertion(123456), result.param_value ); } TEST(TestXPathParser, test_param_parser_fails) { std::string input("name="); parser::xpath_grammar g; xpathselect::XPathQueryParam result; ASSERT_FALSE( test_parser_attr(input, g.param, result) ); } TEST(TestXPathParser, test_param_list_single_value) { std::string input("[name=123]"); parser::xpath_grammar g; xpathselect::ParamList result; ASSERT_EQ( true, test_parser_attr(input, g.param_list, result) ); ASSERT_EQ(1, result.size()); ASSERT_EQ("name", result.at(0).param_name); boost::apply_visitor( variant_equality_assertion(123), result.at(0).param_value ); } TEST(TestXPathParser, test_param_list_two_values) { std::string input("[name=\"value\",visible=True]"); parser::xpath_grammar g; xpathselect::ParamList result; ASSERT_EQ( true, test_parser_attr(input, g.param_list, result) ); ASSERT_EQ(2, result.size()); ASSERT_EQ("name", result.at(0).param_name); boost::apply_visitor( variant_equality_assertion("value"), result.at(0).param_value ); ASSERT_EQ("visible", result.at(1).param_name); boost::apply_visitor( variant_equality_assertion(true), result.at(1).param_value ); } TEST(TestXPathParser, test_spec_node_with_parameter) { std::string input("node_name[param_name=123]"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_EQ( true, test_parser_attr(input, g.spec_node, result) ); ASSERT_EQ("node_name", result.node_name_); ASSERT_FALSE(result.parameter.empty()); ASSERT_EQ("param_name", result.parameter.at(0).param_name); boost::apply_visitor( variant_equality_assertion(123), result.parameter.at(0).param_value ); } TEST(TestXPathParser, test_spec_node_without_parameter) { std::string input("node_name"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_EQ( true, test_parser_attr(input, g.spec_node, result) ); ASSERT_EQ("node_name", result.node_name_); ASSERT_TRUE(result.parameter.empty()); } TEST(TestXPathParser, test_wildcard_node) { std::string input("*"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_EQ( true, test_parser_attr(input, g.wildcard_node, result) ); ASSERT_EQ("*", result.node_name_); ASSERT_TRUE(result.parameter.empty()); } TEST(TestXPathParser, test_wildcard_node_rejects_parameters) { std::string input("*[foo=bar]"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_FALSE( test_parser_attr(input, g.wildcard_node, result) ); } TEST(TestXPathParser, test_wildcard_node_with_params) { std::string input("*[param_name=123]"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_EQ( true, test_parser_attr(input, g.wildcard_node_with_params, result) ); ASSERT_EQ("*", result.node_name_); ASSERT_FALSE(result.parameter.empty()); ASSERT_EQ("param_name", result.parameter.at(0).param_name); boost::apply_visitor( variant_equality_assertion(123), result.parameter.at(0).param_value ); } TEST(TestXPathParser, test_node_can_be_a_wildcard_node_with_params) { std::string input("*[name=\"value\"]"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_EQ( true, test_parser_attr(input, g.node, result) ); ASSERT_EQ( "*", result.node_name_ ); ASSERT_EQ( xpathselect::XPathQueryPart::QueryPartType::Normal, result.Type() ); ASSERT_EQ( 1, result.parameter.size() ); ASSERT_EQ( "name", result.parameter.at(0).param_name ); boost::apply_visitor( variant_equality_assertion("value"), result.parameter.at(0).param_value ); } TEST(TestXPathParser, test_node_can_be_a_wildcard_node_without_params) { std::string input("*"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_EQ( true, test_parser_attr(input, g.node, result) ); ASSERT_EQ( "*", result.node_name_ ); ASSERT_EQ( xpathselect::XPathQueryPart::QueryPartType::Normal, result.Type() ); } TEST(TestXPathParser, test_node_can_be_a_spec_node_with_params) { std::string input("foo[name=\"value\"]"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_EQ( true, test_parser_attr(input, g.node, result) ); ASSERT_EQ( "foo", result.node_name_ ); ASSERT_EQ( xpathselect::XPathQueryPart::QueryPartType::Normal, result.Type() ); ASSERT_EQ( 1, result.parameter.size() ); ASSERT_EQ( "name", result.parameter.at(0).param_name ); boost::apply_visitor( variant_equality_assertion("value"), result.parameter.at(0).param_value ); } TEST(TestXPathParser, test_node_can_be_a_spec_node_without_params) { std::string input("foo"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_EQ( true, test_parser_attr(input, g.node, result) ); ASSERT_EQ( "foo", result.node_name_ ); ASSERT_EQ( xpathselect::XPathQueryPart::QueryPartType::Normal, result.Type() ); } TEST(TestXPathParser, test_node_can_be_a_parent_node) { std::string input(".."); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_EQ( true, test_parser_attr(input, g.node, result) ); ASSERT_EQ( "..", result.node_name_ ); ASSERT_EQ( xpathselect::XPathQueryPart::QueryPartType::Parent, result.Type() ); } TEST(TestXPathParser, test_search_node_followed_by_normal_node) { // the search_node grammar fails if it's at the end of the line, so we need // to give it some more data, even though we're not actually matching it. std::string input("//node_name"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; // however, this means we can't use the test_parser_attr function, since it // returns false on a partial match. Use the parse(...) function directly: ASSERT_TRUE( parse(input.begin(), input.end(),g.search_node, result) ); ASSERT_TRUE( result.Type() == xpathselect::XPathQueryPart::QueryPartType::Search ); } TEST(TestXPathParser, test_search_node_followed_by_wildcard_node_with_parameters) { // the search_node grammar fails if it's at the end of the line, so we need // to give it some more data, even though we're not actually matching it. std::string input("//*[foo=\"bar\"]"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; // however, this means we can't use the test_parser_attr function, since it // returns false on a partial match. Use the parse(...) function directly: ASSERT_TRUE( parse(input.begin(), input.end(),g.search_node, result) ); ASSERT_TRUE( result.Type() == xpathselect::XPathQueryPart::QueryPartType::Search ); } TEST(TestXPathParser, test_search_node_cannot_have_parameters) { std::string input("//[param_name=value]"); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_FALSE( test_parser_attr(input, g.search_node, result) ); } TEST(TestXPathParser, test_parent_node) { std::string input(".."); parser::xpath_grammar g; xpathselect::XPathQueryPart result; ASSERT_TRUE( test_parser_attr(input, g.parent_node, result) ); ASSERT_TRUE( result.Type() == xpathselect::XPathQueryPart::QueryPartType::Parent ); } TEST(TestXPathParser, test_normal_sep_works) { std::string input("/"); parser::xpath_grammar g; ASSERT_EQ( true, test_parser_attr(input, g.normal_sep) ); } TEST(TestXPathParser, test_normal_sep_does_not_match_search_node) { std::string input("//"); parser::xpath_grammar g; ASSERT_FALSE( test_parser_attr(input, g.normal_sep) ); } TEST(TestXPathParser, test_can_extract_query_list) { std::string input("/node1/node2"); parser::xpath_grammar g; xpathselect::QueryList result; ASSERT_TRUE(test_parser_attr(input, g.node_sequence, result)); ASSERT_EQ(2, result.size()); ASSERT_EQ("node1", result.at(0).node_name_); ASSERT_TRUE(result.at(0).parameter.empty()); ASSERT_EQ("node2", result.at(1).node_name_); ASSERT_TRUE(result.at(1).parameter.empty()); } TEST(TestXPathParser, test_can_extract_query_list_with_search) { std::string input("//node1"); parser::xpath_grammar g; xpathselect::QueryList result; ASSERT_TRUE(test_parser_attr(input, g.node_sequence, result)); ASSERT_EQ(2, result.size()); ASSERT_TRUE(result.at(0).Type() == xpathselect::XPathQueryPart::QueryPartType::Search ); ASSERT_TRUE(result.at(1).Type() == xpathselect::XPathQueryPart::QueryPartType::Normal ); ASSERT_TRUE(result.at(0).parameter.empty()); ASSERT_EQ("node1", result.at(1).node_name_); ASSERT_TRUE(result.at(1).parameter.empty()); } TEST(TestXPathParser, test_mix_search_and_normal) { std::string input("/node1//node2"); parser::xpath_grammar g; xpathselect::QueryList result; ASSERT_TRUE(test_parser_attr(input, g.node_sequence, result)); ASSERT_EQ(3, result.size()); ASSERT_EQ("node1", result.at(0).node_name_); ASSERT_TRUE(result.at(0).Type() == xpathselect::XPathQueryPart::QueryPartType::Normal ); ASSERT_TRUE(result.at(0).parameter.empty()); ASSERT_TRUE(result.at(1).Type() == xpathselect::XPathQueryPart::QueryPartType::Search ); ASSERT_TRUE(result.at(1).parameter.empty()); ASSERT_EQ("node2", result.at(2).node_name_); ASSERT_TRUE(result.at(2).Type() == xpathselect::XPathQueryPart::QueryPartType::Normal ); ASSERT_TRUE(result.at(2).parameter.empty()); } TEST(TestXPathParser, test_mix_search_and_long_normal) { std::string input("/node1//node2[name=\"val\"]/node3"); parser::xpath_grammar g; xpathselect::QueryList result; ASSERT_TRUE(test_parser_attr(input, g.node_sequence, result)); ASSERT_EQ(4, result.size()); ASSERT_EQ("node1", result.at(0).node_name_); ASSERT_TRUE(result.at(0).parameter.empty()); ASSERT_TRUE(result.at(1).Type() == xpathselect::XPathQueryPart::QueryPartType::Search ); ASSERT_TRUE(result.at(1).parameter.empty()); ASSERT_EQ("node2", result.at(2).node_name_); ASSERT_EQ(1, result.at(2).parameter.size()); ASSERT_EQ("name", result.at(2).parameter.at(0).param_name); boost::apply_visitor( variant_equality_assertion("val"), result.at(2).parameter.at(0).param_value ); ASSERT_EQ("node3", result.at(3).node_name_); ASSERT_TRUE(result.at(3).parameter.empty()); } TEST(TestXPathParser, test_mix_normal_and_parent) { std::string input("/node1/.."); parser::xpath_grammar g; xpathselect::QueryList result; ASSERT_TRUE(test_parser_attr(input, g.node_sequence, result)); ASSERT_EQ(2, result.size()); ASSERT_EQ("node1", result.at(0).node_name_); ASSERT_TRUE(result.at(0).parameter.empty()); ASSERT_TRUE(result.at(1).Type() == xpathselect::XPathQueryPart::QueryPartType::Parent ); ASSERT_TRUE(result.at(1).parameter.empty()); } TEST(TestXPathParser, test_mix_normal_and_parent_and_wildcard) { std::string input("/node1/../*"); parser::xpath_grammar g; xpathselect::QueryList result; ASSERT_TRUE(test_parser_attr(input, g.node_sequence, result)); ASSERT_EQ(3, result.size()); ASSERT_EQ("node1", result.at(0).node_name_); ASSERT_TRUE(result.at(0).parameter.empty()); ASSERT_TRUE(result.at(1).Type() == xpathselect::XPathQueryPart::QueryPartType::Parent ); ASSERT_TRUE(result.at(1).parameter.empty()); ASSERT_TRUE(result.at(2).node_name_ == "*" ); ASSERT_TRUE(result.at(2).parameter.empty()); } class TestXPathParserQueryStrings : public ::testing::TestWithParam > {}; TEST_P(TestXPathParserQueryStrings, test_query_acceptance) { auto p = GetParam(); std::string input = p.first; bool expect_pass = p.second; parser::xpath_grammar g; xpathselect::QueryList result; ASSERT_EQ( expect_pass, test_parser_attr(input, g, result) ); } INSTANTIATE_TEST_CASE_P(BasicNodeNames, TestXPathParserQueryStrings, ::testing::Values( // queries that must all parse correctly: std::pair("//root", true), std::pair("/root", true), std::pair("/root/node1", true), std::pair("/root//node1", true), std::pair("//root", true), std::pair("/root//node1/node2", true), std::pair("/root[p=1]//node1[p=\"2\"]/node3", true), std::pair("/root[p=True,n=2,d=\"e3\"]", true), std::pair("//root[p=1,n=2,d=\"e3\"]", true), std::pair("/Root//*[p=1]", true), std::pair("/Root//*[p=1,v=\"sj\",c=False]", true), // queries that must not parse correctly: std::pair("//", false), std::pair("/root//", false), std::pair("/root///", false), std::pair("/ /", false), std::pair("", false), std::pair(" ", false), std::pair("//*", false), std::pair("/Root///Leaf", false), std::pair("/Root////", false), std::pair("/Root/..*", false), std::pair("/Root/../Child//..", false) )); xpathselect-1.4+14.04.20140303/test/test_main.cpp0000644000015201777760000000135212305004311021727 0ustar pbusernogroup00000000000000/* * Copyright (C) 2012 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #include "gtest/gtest.h" int main(int argc, char **argv) { ::testing::InitGoogleTest(&argc, argv); return RUN_ALL_TESTS(); } xpathselect-1.4+14.04.20140303/CMakeLists.txt0000644000015201777760000000113312305004311021016 0ustar pbusernogroup00000000000000# # CMake file for autopilot daemon & test app. cmake_minimum_required(VERSION 2.6) project(xpathselect) include (GNUInstallDirs) set (VERSION 1.4) if(CMAKE_BUILD_TYPE STREQUAL "coverage") message("Building for coverage") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --coverage" ) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --coverage" ) set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} --coverage" ) set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --coverage" ) endif(CMAKE_BUILD_TYPE STREQUAL "coverage") INCLUDE(FindPkgConfig) add_subdirectory(lib) add_subdirectory(test) xpathselect-1.4+14.04.20140303/lib/0000755000015201777760000000000012305004473017037 5ustar pbusernogroup00000000000000xpathselect-1.4+14.04.20140303/lib/xpathquerypart.h0000644000015201777760000000630612305004311022305 0ustar pbusernogroup00000000000000/* * Copyright (C) 2013 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #ifndef _XPATHQUERYPART_H #define _XPATHQUERYPART_H #include #include #include #include #include #include #include #include "node.h" namespace xpathselect { // stores a parameter name, value pair. struct XPathQueryParam { typedef boost::variant ParamValueType; std::string param_name; ParamValueType param_value; }; typedef std::vector ParamList; // Stores a part of an XPath query. struct XPathQueryPart { public: XPathQueryPart() {} XPathQueryPart(std::string node_name) : node_name_(node_name) {} enum class QueryPartType {Normal, Search, Parent}; bool Matches(Node::Ptr const& node) const { bool matches = (node_name_ == "*" || node->GetName() == node_name_); if (!parameter.empty()) { for (auto param : parameter) { switch(param.param_value.which()) { case 0: { matches &= node->MatchStringProperty(param.param_name, boost::get(param.param_value)); } break; case 1: { matches &= node->MatchBooleanProperty(param.param_name, boost::get(param.param_value)); } break; case 2: { matches &= node->MatchIntegerProperty(param.param_name, boost::get(param.param_value)); } break; } } } return matches; } QueryPartType Type() const { if (node_name_ == "") return QueryPartType::Search; else if (node_name_ == "..") return QueryPartType::Parent; else return QueryPartType::Normal; } void Dump() const { if (Type() == QueryPartType::Search) std::cout << " "; else std::cout << "[" << node_name_ << "] "; } std::string node_name_; ParamList parameter; }; typedef std::vector QueryList; } #endif xpathselect-1.4+14.04.20140303/lib/parser.h0000644000015201777760000002427312305004331020505 0ustar pbusernogroup00000000000000/* * Copyright (C) 2013 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #ifndef _PARSER_H #define _PARSER_H #include #include #include #include #include #include #include #include #include #include "xpathquerypart.h" // this allows spirit to lazily construct these two structs... BOOST_FUSION_ADAPT_STRUCT( xpathselect::XPathQueryPart, (std::string, node_name_) (xpathselect::ParamList, parameter) ); BOOST_FUSION_ADAPT_STRUCT( xpathselect::XPathQueryParam, (std::string, param_name) (xpathselect::XPathQueryParam::ParamValueType, param_value) ); namespace xpathselect { namespace parser { namespace qi = boost::spirit::qi; namespace phoenix = boost::phoenix; // python_bool_policy determines what can be considered truthy. We follow python // repr format. struct python_bool_policy : qi::bool_policies<> { template static bool parse_true(Iterator& first, Iterator const& last, Attribute& attr) { if (qi::detail::string_parse("True", first, last, qi::unused)) { boost::spirit::traits::assign_to(true, attr); // result is true return true; // parsing succeeded } return false; // parsing failed } template static bool parse_false(Iterator& first, Iterator const& last, Attribute& attr) { if (qi::detail::string_parse("False", first, last, qi::unused)) { boost::spirit::traits::assign_to(false, attr); // result is false return true; } return false; } }; // This is the main XPath grammar. It looks horrible, until you emerse yourself in it for a few // days, then the beauty of boost::spirit creeps into your brain. To help future programmers, // I've heavily commented this. // // The first template parameter to this grammar defines the type of iterator the grammer will operate // on - it must adhere to std::forward_iterator. The second template parameter is the type // that this grammar will produce (in this case: a list of XPathQueryPart objects). template struct xpath_grammar : qi::grammar { xpath_grammar() : xpath_grammar::base_type(node_sequence) // node_sequence is the start rule. { using namespace qi::labels; // character escape codes. The input on the left will produce the output on // the right: unesc_char.add("\\a", '\a') ("\\b", '\b') ("\\f", '\f') ("\\n", '\n') ("\\r", '\r') ("\\t", '\t') ("\\v", '\v') ("\\\\", '\\') ("\\\'", '\'') ("\\\"", '\"'); unesc_str = '"' >> *( unesc_char | qi::alnum | qi::space | "\\x" >> qi::hex ) >> '"'; unesc_str = '"' >> *(unesc_char | "\\x" >> qi::hex | (qi::print - '"')) >> '"' ; int_type = qi::int_parser(); // Parameter grammar: // parameter name can contain some basic text (no spaces or '.') param_name = +qi::char_("a-zA-Z0-9_\\-"); // parameter values can be several different types. // Alternatives are tried left to right, and the first match found is the one used. param_value = unesc_str | int_type | bool_type; // parameter specification is simple: name=value param %= param_name >> '=' >> param_value; // a parameter list is a list of parameters separated by ',''s surrounded in '[...]' param_list = '[' >> param % ',' >> ']'; // spec_node_name is a node name that has been explicitly specified. // it must start and end with a non-space character, but you can have // spaces in the middle. spec_node_name = +qi::char_("a-zA-Z0-9_\\-") >> *(+qi::char_(" :") >> +qi::char_("a-zA-Z0-9_\\-")); // a wildcard node name is simply a '*' wildcard_node_name = qi::char_("*"); // a spec_node consists of a specified node name, followed by an *optional* parameter list. spec_node %= spec_node_name >> -(param_list); // a wildcard node is a '*' without parameters: wildcard_node %= wildcard_node_name >> !param_list; // wildcard nodes can also have parameters: wildcard_node_with_params %= wildcard_node_name >> param_list; // A parent node is '..' as long as it's followed by a normal separator or end of input: parent_node = qi::lit("..")[qi::_val = XPathQueryPart("..")]; // node is simply any kind of code defined thus far: node = spec_node | wildcard_node_with_params | wildcard_node | parent_node; // a search node is '//' as long as it's followed by a spec node or a wildcard node with parameters. // we don't allow '//*' since it would match everything in the tree, and cause HUGE amounts of // data to be transmitted. search_node = "//" >> &(spec_node | wildcard_node_with_params)[qi::_val = XPathQueryPart()]; // a normal separator is a '/' as long as it's followed by something other than another '/' normal_sep = '/' >> !qi::lit('/'); separator = normal_sep | search_node; // nodes can be separated by normal_sep or search_node. // this is the money shot: a node sequence is one or more of a separator, followed by an // optional node. node_sequence %= +(separator >> -node); // DEBUGGING SUPPORT: // define DEBUG in order to have boost::spirit spit out useful debug information: #ifdef DEBUG // this gives english names to all the grammar rules: spec_node_name.name("spec_node_name"); wildcard_node_name.name("wildcard_node_name"); search_node.name("search_node"); normal_sep.name("normal_separator"); separator.name("separator"); param_name.name("param_name"); param_value.name("param_value"); param.name("param"); spec_node.name("spec_node"); wildcard_node.name("wildcard_node"); wildcard_node.name("wildcard_node_with_params"); node.name("node"); node_sequence.name("node_sequence"); param_list.name("param_list"); // set up error logging: qi::on_error( node_sequence, std::cout << phoenix::val("Error! Expecting ") << qi::_4 // what failed? << phoenix::val(" here: \"") << phoenix::construct(qi::_3, qi::_2) // iterators to error-pos, end << phoenix::val("\"") << std::endl ); // specify which rules we want debug info about (all of them): qi::debug(spec_node_name); qi::debug(wildcard_node_name); qi::debug(search_node); qi::debug(normal_sep); qi::debug(separator); qi::debug(param_name); qi::debug(param_value); qi::debug(param); qi::debug(spec_node); qi::debug(wildcard_node); qi::debug(wildcard_node_with_params); qi::debug(node); qi::debug(node_sequence); qi::debug(param_list); #endif } // declare all the rules. The second template parameter is the type they produce. // basic type rules: // parse python Boolean represetnations 'True' or 'False': qi::bool_parser bool_type; // parse an escaped byte string. qi::rule unesc_str; // symbol table for chracter scape codes. qi::symbols unesc_char; // parse integers, first signed then unsigned: qi::rule int_type; // more complicated language rules: qi::rule spec_node_name; qi::rule wildcard_node_name; qi::rule search_node; qi::rule parent_node; qi::rule normal_sep; qi::rule separator; qi::rule param_name; qi::rule param_value; qi::rule param; qi::rule param_list; qi::rule spec_node; qi::rule wildcard_node; qi::rule wildcard_node_with_params; qi::rule node; qi::rule node_sequence; }; } } #endif xpathselect-1.4+14.04.20140303/lib/xpathselect.h0000644000015201777760000000157512305004311021533 0ustar pbusernogroup00000000000000/* * Copyright (C) 2012 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #ifndef _XPATHSELECT_H #define _XPATHSELECT_H #include "node.h" namespace xpathselect { /// Search the node tree beginning with 'root' and return nodes that /// match 'query'. extern "C" NodeVector SelectNodes(Node::Ptr const& root, std::string query); } #endif xpathselect-1.4+14.04.20140303/lib/CMakeLists.txt0000644000015201777760000000323312305004311021567 0ustar pbusernogroup00000000000000FIND_PACKAGE( Boost 1.40 REQUIRED ) INCLUDE_DIRECTORIES( ${Boost_INCLUDE_DIR} ) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC -Wall -Wl,--no-undefined") if(CMAKE_BUILD_TYPE STREQUAL "Debug") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DDEBUG" ) endif(CMAKE_BUILD_TYPE STREQUAL "Debug") set(SOURCES node.cpp xpathselect.h xpathselect.cpp parser.cpp parser.h) set(HEADERS node.h xpathselect.h) if(CMAKE_COMPILER_IS_GNUCXX) execute_process(COMMAND ${CMAKE_C_COMPILER} -dumpversion OUTPUT_VARIABLE GCC_VERSION) if (GCC_VERSION VERSION_GREATER 4.7 OR GCC_VERSION VERSION_EQUAL 4.7) message(STATUS "C++11 activated.") add_definitions("-std=c++11") elseif(GCC_VERSION VERSION_GREATER 4.3 OR GCC_VERSION VERSION_EQUAL 4.3) message(WARNING "C++0x activated. If you get any errors update to a compiler which fully supports C++11") add_definitions("-std=c++0x") else () message(FATAL_ERROR "C++11 needed. Therefore a gcc compiler with a version higher than 4.3 is needed.") endif() else(CMAKE_COMPILER_IS_GNUCXX) add_definitions("-std=c++11") #turn on and hope non-gnu compiler supports it endif(CMAKE_COMPILER_IS_GNUCXX) add_library(xpathselect SHARED ${SOURCES}) target_link_libraries(xpathselect ${Boost_LIBRARIES}) set_target_properties(xpathselect PROPERTIES VERSION ${VERSION} SOVERSION ${VERSION}) install(TARGETS xpathselect LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}) install(FILES ${HEADERS} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}) configure_file(xpathselect.pc.in xpathselect.pc @ONLY) install(FILES ${CMAKE_BINARY_DIR}/lib/xpathselect.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig) xpathselect-1.4+14.04.20140303/lib/xpathselect.cpp0000644000015201777760000001552712305004311022070 0ustar pbusernogroup00000000000000/* * Copyright (C) 2012 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #include #include #include "xpathselect.h" #include "xpathquerypart.h" #include "parser.h" namespace xpathselect { // anonymous namespace for internal-only utility class: namespace { QueryList GetQueryPartsFromQuery(std::string const& query) { xpathselect::parser::xpath_grammar grammar; QueryList query_parts; auto begin = query.cbegin(); auto end = query.cend(); if (boost::spirit::qi::parse(begin, end, grammar, query_parts) && (begin == end)) { #ifdef DEBUG std::cout << "Query parts are: "; for (auto n : query_parts) n.Dump(); std::cout << std::endl; #endif return query_parts; } #ifdef DEBUG std::cout << "Query failed." << std::endl; #endif return QueryList(); } // Starting at each node listed in 'start_points', search the tree for nodes that match // 'next_match'. next_match *must* be a normal query part object, not a search token. NodeList SearchTreeForNode(NodeList const& start_points, XPathQueryPart const& next_match) { NodeList matches; for (auto root: start_points) { // non-recursive BFS traversal to find starting points: std::queue queue; queue.push(root); while (!queue.empty()) { Node::Ptr node = queue.front(); queue.pop(); if (next_match.Matches(node)) { // found one. We keep going deeper, as there may be another node beneath this one // with the same node name. matches.push_back(node); } // Add all children of current node to queue. for(Node::Ptr child : node->Children()) { queue.push(child); } } } return matches; } } // end of anonymous namespace NodeVector SelectNodes(Node::Ptr const& root, std::string query) { // allow users to be lazy when specifying tree root: if (query == "" || query == "/" || query == "//") { query = "/" + root->GetName(); } QueryList query_parts = GetQueryPartsFromQuery(query); if (query_parts.empty()) return NodeVector(); auto query_part = query_parts.cbegin(); NodeList start_nodes { root }; while (query_part != query_parts.cend()) { // If the current query piece is a recursive search token ('//')... if (query_part->Type() == XPathQueryPart::QueryPartType::Search) { // advance to look at the next piece. ++query_part; // do some sanity checking... if (query_part->Type() == XPathQueryPart::QueryPartType::Search) // invalid query - cannot specify multiple search sequences in a row. return NodeVector(); // then find all the nodes that match the new query part, and store them as // the new start nodes. We pass in 'start_nodes' rather than 'root' since // there's a chance we'll be doing more than one search in different parts of the tree. start_nodes = SearchTreeForNode(start_nodes, *query_part); } else if (query_part->Type() == XPathQueryPart::QueryPartType::Parent) { // This part of the query selects the parent node. If the current node has no // parent (i.e.- we're already at the root of the tree) then this is a no-op: NodeList new_start_nodes; for (auto n: start_nodes) { auto parent = n->GetParent(); new_start_nodes.push_back(parent ? parent : n); } start_nodes = new_start_nodes; } else { // this isn't a search token. Look at each node in the start_nodes list, // and discard any that don't match the current query part. // C++11 is the shit: start_nodes.erase( std::remove_if( start_nodes.begin(), start_nodes.end(), [query_part](Node::Ptr n) -> bool { return ! query_part->Matches(n); } ), start_nodes.end() ); } // then replace each node still in the list with all it's children. // ... but only if we're not on the last query part, and only if the // next query part is not a parent node... auto next_query_part = query_part + 1; if (next_query_part != query_parts.cend() && next_query_part->Type() != XPathQueryPart::QueryPartType::Parent) { NodeList new_start_nodes; for (auto node: start_nodes) { auto children = node->Children(); if (children.size()) { new_start_nodes.insert( new_start_nodes.end(), children.begin(), children.end()); } } start_nodes = new_start_nodes; } ++query_part; } // remove duplicate nodes by sorting & unique'ing: // we could probably do this better, but since start_nodes is // typically very small at this stage, I'm not sure it's worth it: start_nodes.sort([](Node::Ptr a, Node::Ptr b) -> bool { return a->GetId() < b->GetId(); }); start_nodes.unique([](Node::Ptr a, Node::Ptr b) -> bool { return a->GetId() == b->GetId(); }); return NodeVector(start_nodes.begin(), start_nodes.end()); } } xpathselect-1.4+14.04.20140303/lib/node.h0000644000015201777760000000350212305004311020124 0ustar pbusernogroup00000000000000/* * Copyright (C) 2012 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #ifndef _NODE_H #define _NODE_H #include #include #include #include #include namespace xpathselect { /// Represents a node in the object tree. Provide an implementation of /// this class in your own code. class Node { public: typedef std::shared_ptr Ptr; /// Get the node's name. virtual std::string GetName() const =0; /// Get the node's full path virtual std::string GetPath() const =0; /// Get this node's ID. virtual int32_t GetId() const =0; virtual bool MatchBooleanProperty(const std::string& name, bool value) const =0; virtual bool MatchIntegerProperty(const std::string& name, int32_t value) const =0; virtual bool MatchStringProperty(const std::string& name, const std::string& value) const =0; /// Return a list of the children of this node. virtual std::vector Children() const =0; /// Return a pointer to the parent class. virtual Node::Ptr GetParent() const =0; }; /// NodeList is how we return lists of nodes. typedef std::vector NodeVector; typedef std::list NodeList; } #endif xpathselect-1.4+14.04.20140303/lib/parser.cpp0000644000015201777760000000117412305004311021031 0ustar pbusernogroup00000000000000/* * Copyright (C) 2013 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #include "parser.h" xpathselect-1.4+14.04.20140303/lib/xpathselect.pc.in0000644000015201777760000000034112305004311022301 0ustar pbusernogroup00000000000000prefix=@CMAKE_INSTALL_PREFIX@ libdir=${prefix}/lib/@CMAKE_LIBRARY_ARCHITECTURE@ includedir=${prefix}/include Cflags: -I${includedir} Libs: -lxpathselect Name: libxpathselect Description: libxpathselect. Version: @VERSION@ xpathselect-1.4+14.04.20140303/lib/node.cpp0000644000015201777760000000117212305004311020460 0ustar pbusernogroup00000000000000/* * Copyright (C) 2012 Canonical Ltd * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3 as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ #include "node.h" xpathselect-1.4+14.04.20140303/COPYING0000644000015201777760000010451312305004311017317 0ustar pbusernogroup00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read .