From 4d6c315c1e943642bd639c6647e4d76baa418aee Mon Sep 17 00:00:00 2001 From: Marko Budiselic Date: Sun, 18 Dec 2016 19:21:29 +0100 Subject: [PATCH 01/13] Block Allocator Test - initial implementation Summary: Block Allocator Test - initial implementation Test Plan: ctest -R memgraph_unit_block_allocator Reviewers: sale Subscribers: sale, buda Differential Revision: https://memgraph.phacility.com/D20 --- include/utils/auto_scope.hpp | 7 ++ include/utils/memory/block_allocator.hpp | 39 ++++++--- tests/unit/CMakeLists.txt | 2 + tests/unit/basic_bloom_filter.cpp | 47 +++++----- tests/unit/block_allocator.cpp | 24 +++++ tests/unit/parameter_index.cpp | 5 +- tests/unit/program_argument.cpp | 106 ++++++++++++----------- 7 files changed, 142 insertions(+), 88 deletions(-) create mode 100644 tests/unit/block_allocator.cpp diff --git a/include/utils/auto_scope.hpp b/include/utils/auto_scope.hpp index 10de5751f..119078a91 100644 --- a/include/utils/auto_scope.hpp +++ b/include/utils/auto_scope.hpp @@ -55,3 +55,10 @@ private: TOKEN_PASTE(auto_, counter)(TOKEN_PASTE(auto_func_, counter)); #define Auto(Destructor) Auto_INTERNAL(Destructor, __COUNTER__) + +// -- example: +// Auto(f()); +// -- is expended to: +// auto auto_func_1 = [&]() { f(); }; +// OnScopeExit auto_1(auto_func_1); +// -- f() is called at the end of a scope diff --git a/include/utils/memory/block_allocator.hpp b/include/utils/memory/block_allocator.hpp index f0c0e6475..f7eb3791f 100644 --- a/include/utils/memory/block_allocator.hpp +++ b/include/utils/memory/block_allocator.hpp @@ -5,6 +5,9 @@ #include "utils/auto_scope.hpp" +/* @brief Allocates blocks of block_size and stores + * the pointers on allocated blocks inside a vector. + */ template class BlockAllocator { @@ -23,29 +26,45 @@ public: BlockAllocator(size_t capacity = 0) { for (size_t i = 0; i < capacity; ++i) - blocks.emplace_back(); + unused_.emplace_back(); } ~BlockAllocator() { - for (auto b : blocks) { - free(b.data); - } - blocks.clear(); + for (auto block : unused_) + free(block.data); + unused_.clear(); + for (auto block : release_) + free(block.data); + release_.clear(); + } + + size_t unused_size() const + { + return unused_.size(); + } + + size_t release_size() const + { + return release_.size(); } // Returns nullptr on no memory. void *acquire() { - if (blocks.size() == 0) blocks.emplace_back(); + if (unused_.size() == 0) unused_.emplace_back(); - auto ptr = blocks.back().data; - Auto(blocks.pop_back()); + auto ptr = unused_.back().data; + Auto(unused_.pop_back()); return ptr; } - void release(void *ptr) { blocks.emplace_back(ptr); } + void release(void *ptr) { release_.emplace_back(ptr); } private: - std::vector blocks; + // TODO: try implement with just one vector + // but consecutive acquire release calls should work + // TODO: measure first! + std::vector unused_; + std::vector release_; }; diff --git a/tests/unit/CMakeLists.txt b/tests/unit/CMakeLists.txt index df6ecb100..85b360288 100644 --- a/tests/unit/CMakeLists.txt +++ b/tests/unit/CMakeLists.txt @@ -26,6 +26,8 @@ foreach(test_cpp ${test_type_cpps}) set_target_properties(${target_name} PROPERTIES OUTPUT_NAME ${exec_name}) # link libraries + # gtest + target_link_libraries(${target_name} gtest gtest_main) # filesystem target_link_libraries(${target_name} stdc++fs) # threads (cross-platform) diff --git a/tests/unit/basic_bloom_filter.cpp b/tests/unit/basic_bloom_filter.cpp index ac4df7fc2..15a41294c 100644 --- a/tests/unit/basic_bloom_filter.cpp +++ b/tests/unit/basic_bloom_filter.cpp @@ -9,37 +9,34 @@ #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wwritable-strings" -using StringHashFunction = std::function; - -TEST_CASE("BloomFilter Test") { - StringHashFunction hash1 = fnv64; - StringHashFunction hash2 = fnv1a64; +using StringHashFunction = std::function; - auto c = [](auto x) -> int { - return x % 4; - } ; - std::vector funcs = { - hash1, hash2 - }; +TEST_CASE("BloomFilter Test") +{ + StringHashFunction hash1 = fnv64; + StringHashFunction hash2 = fnv1a64; - BloomFilter bloom(funcs); + auto c = [](auto x) -> int { return x % 4; }; + std::vector funcs = {hash1, hash2}; - std::string test = "test"; - std::string kifla = "kifla"; + BloomFilter bloom(funcs); - std::cout << hash1(test) << std::endl; - std::cout << hash2(test) << std::endl; - - std::cout << hash1(kifla) << std::endl; - std::cout << hash2(kifla) << std::endl; + std::string test = "test"; + std::string kifla = "kifla"; - std::cout << bloom.contains(test) << std::endl; - bloom.insert(test); - std::cout << bloom.contains(test) << std::endl; + std::cout << hash1(test) << std::endl; + std::cout << hash2(test) << std::endl; - std::cout << bloom.contains(kifla) << std::endl; - bloom.insert(kifla); - std::cout << bloom.contains(kifla) << std::endl; + std::cout << hash1(kifla) << std::endl; + std::cout << hash2(kifla) << std::endl; + + std::cout << bloom.contains(test) << std::endl; + bloom.insert(test); + std::cout << bloom.contains(test) << std::endl; + + std::cout << bloom.contains(kifla) << std::endl; + bloom.insert(kifla); + std::cout << bloom.contains(kifla) << std::endl; } #pragma clang diagnostic pop diff --git a/tests/unit/block_allocator.cpp b/tests/unit/block_allocator.cpp new file mode 100644 index 000000000..35bf9cfdc --- /dev/null +++ b/tests/unit/block_allocator.cpp @@ -0,0 +1,24 @@ +#include "gtest/gtest.h" + +#include "utils/memory/block_allocator.hpp" + +TEST(BlockAllocatorTest, UnusedVsReleaseSize) +{ + BlockAllocator<64> block_allocator(10); + void *block = block_allocator.acquire(); + block_allocator.release(block); + EXPECT_EQ(block_allocator.unused_size(), 9); + EXPECT_EQ(block_allocator.release_size(), 1); +} + +TEST(BlockAllocatorTest, CountMallocAndFreeCalls) +{ + // TODO: implementation + EXPECT_EQ(true, true); +} + +int main(int argc, char **argv) +{ + ::testing::InitGoogleTest(&argc, argv); + return RUN_ALL_TESTS(); +} diff --git a/tests/unit/parameter_index.cpp b/tests/unit/parameter_index.cpp index 542591dd6..b2d137c79 100644 --- a/tests/unit/parameter_index.cpp +++ b/tests/unit/parameter_index.cpp @@ -8,12 +8,13 @@ using ParameterIndexKey::Type::Projection; auto main() -> int { - std::map parameter_index; + std::map parameter_index; parameter_index[ParameterIndexKey(InternalId, "n1")] = 0; parameter_index[ParameterIndexKey(InternalId, "n2")] = 1; - permanent_assert(parameter_index.size() == 2, "Parameter index size should be 2"); + permanent_assert(parameter_index.size() == 2, + "Parameter index size should be 2"); return 0; } diff --git a/tests/unit/program_argument.cpp b/tests/unit/program_argument.cpp index a12ae190f..c5c54996e 100644 --- a/tests/unit/program_argument.cpp +++ b/tests/unit/program_argument.cpp @@ -6,80 +6,84 @@ #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wwritable-strings" -TEST_CASE("ProgramArgument FlagOnly Test") { - CLEAR_ARGS(); +TEST_CASE("ProgramArgument FlagOnly Test") +{ + CLEAR_ARGS(); - int argc = 2; - char* argv[] = {"ProgramArgument FlagOnly Test", "-test"}; + int argc = 2; + char *argv[] = {"ProgramArgument FlagOnly Test", "-test"}; - REGISTER_ARGS(argc, argv); - REGISTER_REQUIRED_ARGS({"-test"}); + REGISTER_ARGS(argc, argv); + REGISTER_REQUIRED_ARGS({"-test"}); - REQUIRE(CONTAINS_FLAG("-test") == true); + REQUIRE(CONTAINS_FLAG("-test") == true); } -TEST_CASE("ProgramArgument Single Entry Test") { - CLEAR_ARGS(); +TEST_CASE("ProgramArgument Single Entry Test") +{ + CLEAR_ARGS(); - int argc = 3; - char* argv[] = {"ProgramArgument Single Entry Test", "-bananas", "99"}; + int argc = 3; + char *argv[] = {"ProgramArgument Single Entry Test", "-bananas", "99"}; - REGISTER_REQUIRED_ARGS({"-bananas"}); - REGISTER_ARGS(argc, argv); + REGISTER_REQUIRED_ARGS({"-bananas"}); + REGISTER_ARGS(argc, argv); - REQUIRE(GET_ARG("-bananas", "100").get_int() == 99); + REQUIRE(GET_ARG("-bananas", "100").get_int() == 99); } -TEST_CASE("ProgramArgument Multiple Entries Test") { - CLEAR_ARGS(); +TEST_CASE("ProgramArgument Multiple Entries Test") +{ + CLEAR_ARGS(); - int argc = 4; - char* argv[] = {"ProgramArgument Multiple Entries Test", "-files", - "first_file.txt", "second_file.txt"}; + int argc = 4; + char *argv[] = {"ProgramArgument Multiple Entries Test", "-files", + "first_file.txt", "second_file.txt"}; - REGISTER_ARGS(argc, argv); + REGISTER_ARGS(argc, argv); - auto files = GET_ARGS("-files", {}); + auto files = GET_ARGS("-files", {}); - REQUIRE(files[0].get_string() == "first_file.txt"); + REQUIRE(files[0].get_string() == "first_file.txt"); } -TEST_CASE("ProgramArgument Combination Test") { - CLEAR_ARGS(); +TEST_CASE("ProgramArgument Combination Test") +{ + CLEAR_ARGS(); - int argc = 14; - char* argv[] = {"ProgramArgument Combination Test", - "-run_tests", - "-tests", - "Test1", - "Test2", - "Test3", - "-run_times", - "10", - "-export", - "test1.txt", - "test2.txt", - "test3.txt", - "-import", - "data.txt"}; + int argc = 14; + char *argv[] = {"ProgramArgument Combination Test", + "-run_tests", + "-tests", + "Test1", + "Test2", + "Test3", + "-run_times", + "10", + "-export", + "test1.txt", + "test2.txt", + "test3.txt", + "-import", + "data.txt"}; - REGISTER_ARGS(argc, argv); + REGISTER_ARGS(argc, argv); - REQUIRE(CONTAINS_FLAG("-run_tests") == true); + REQUIRE(CONTAINS_FLAG("-run_tests") == true); - auto tests = GET_ARGS("-tests", {}); - REQUIRE(tests[0].get_string() == "Test1"); - REQUIRE(tests[1].get_string() == "Test2"); - REQUIRE(tests[2].get_string() == "Test3"); + auto tests = GET_ARGS("-tests", {}); + REQUIRE(tests[0].get_string() == "Test1"); + REQUIRE(tests[1].get_string() == "Test2"); + REQUIRE(tests[2].get_string() == "Test3"); - REQUIRE(GET_ARG("-run_times", "0").get_int() == 10); + REQUIRE(GET_ARG("-run_times", "0").get_int() == 10); - auto exports = GET_ARGS("-export", {}); - REQUIRE(exports[0].get_string() == "test1.txt"); - REQUIRE(exports[1].get_string() == "test2.txt"); - REQUIRE(exports[2].get_string() == "test3.txt"); + auto exports = GET_ARGS("-export", {}); + REQUIRE(exports[0].get_string() == "test1.txt"); + REQUIRE(exports[1].get_string() == "test2.txt"); + REQUIRE(exports[2].get_string() == "test3.txt"); - REQUIRE(GET_ARG("-import", "test.txt").get_string() == "data.txt"); + REQUIRE(GET_ARG("-import", "test.txt").get_string() == "data.txt"); } #pragma clang diagnostic pop From dc3433aa8ad283df577fbabe69f736aa6678fce3 Mon Sep 17 00:00:00 2001 From: Marko Budiselic Date: Sun, 18 Dec 2016 20:26:08 +0100 Subject: [PATCH 02/13] Stack Allocator Unit Test Summary: Stack Allocator Unit Test Test Plan: manual (unit tests are not passing because malloc and free counters have to be added) Reviewers: sale Subscribers: sale, buda Differential Revision: https://memgraph.phacility.com/D21 --- include/utils/memory/stack_allocator.hpp | 1 + tests/unit/block_allocator.cpp | 2 +- tests/unit/stack_allocator.cpp | 34 ++++++++++++++++++++++++ 3 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 tests/unit/stack_allocator.cpp diff --git a/include/utils/memory/stack_allocator.hpp b/include/utils/memory/stack_allocator.hpp index 287bdad6a..15623e49d 100644 --- a/include/utils/memory/stack_allocator.hpp +++ b/include/utils/memory/stack_allocator.hpp @@ -3,6 +3,7 @@ #include #include "utils/exceptions/out_of_memory.hpp" +#include "utils/likely.hpp" #include "utils/memory/block_allocator.hpp" // http://en.cppreference.com/w/cpp/language/new diff --git a/tests/unit/block_allocator.cpp b/tests/unit/block_allocator.cpp index 35bf9cfdc..e2de1e405 100644 --- a/tests/unit/block_allocator.cpp +++ b/tests/unit/block_allocator.cpp @@ -14,7 +14,7 @@ TEST(BlockAllocatorTest, UnusedVsReleaseSize) TEST(BlockAllocatorTest, CountMallocAndFreeCalls) { // TODO: implementation - EXPECT_EQ(true, true); + EXPECT_EQ(true, false); } int main(int argc, char **argv) diff --git a/tests/unit/stack_allocator.cpp b/tests/unit/stack_allocator.cpp new file mode 100644 index 000000000..006ffbe36 --- /dev/null +++ b/tests/unit/stack_allocator.cpp @@ -0,0 +1,34 @@ +#include "gtest/gtest.h" + +#include "utils/memory/stack_allocator.hpp" + +struct Object +{ + int a; + int b; + + Object(int a, int b) : a(a), b(b) {} +}; + +TEST(StackAllocatorTest, AllocationAndObjectValidity) +{ + StackAllocator allocator; + for (int i = 0; i < 64 * 1024; ++i) + { + auto object = allocator.make(1, 2); + ASSERT_EQ(object->a, 1); + ASSERT_EQ(object->b, 2); + } +} + +TEST(StackAllocatorTest, CountMallocAndFreeCalls) +{ + // TODO: implementation + EXPECT_EQ(true, false); +} + +int main(int argc, char **argv) +{ + ::testing::InitGoogleTest(&argc, argv); + return RUN_ALL_TESTS(); +} From 362bc3ba48abf40529111e6aa6b3404d6d5ea2ab Mon Sep 17 00:00:00 2001 From: Marko Budiselic Date: Mon, 19 Dec 2016 18:32:44 +0100 Subject: [PATCH 03/13] Bug fixes: RELEASE MODE - asserts --- cmake/copy_includes.cmake | 3 +- include/utils/assert.hpp | 5 +- include/utils/exceptions/basic_exception.hpp | 52 +++----- include/utils/signals/handler.hpp | 52 ++++---- include/utils/stacktrace/log.hpp | 11 ++ include/utils/{ => stacktrace}/stacktrace.hpp | 69 +++++------ include/utils/terminate_handler.hpp | 32 +++-- src/memgraph_bolt.cpp | 114 +++++++++--------- src/storage/edge_accessor.cpp | 7 +- tests/integration/cleaning.cpp | 69 ++++++----- tests/integration/index.cpp | 109 +++++++++++------ tests/integration/snapshot.cpp | 72 ++++++----- tests/unit/signal_handler.cpp | 17 +-- 13 files changed, 338 insertions(+), 274 deletions(-) create mode 100644 include/utils/stacktrace/log.hpp rename include/utils/{ => stacktrace}/stacktrace.hpp (52%) diff --git a/cmake/copy_includes.cmake b/cmake/copy_includes.cmake index 4b0ad5a4b..5508be6cd 100644 --- a/cmake/copy_includes.cmake +++ b/cmake/copy_includes.cmake @@ -118,7 +118,8 @@ FILE(COPY ${include_dir}/utils/char_str.hpp DESTINATION ${build_include_dir}/uti FILE(COPY ${include_dir}/utils/void.hpp DESTINATION ${build_include_dir}/utils) FILE(COPY ${include_dir}/utils/array_store.hpp DESTINATION ${build_include_dir}/utils) FILE(COPY ${include_dir}/utils/bswap.hpp DESTINATION ${build_include_dir}/utils) -FILE(COPY ${include_dir}/utils/stacktrace.hpp DESTINATION ${build_include_dir}/utils) +FILE(COPY ${include_dir}/utils/stacktrace/stacktrace.hpp DESTINATION ${build_include_dir}/utils/stacktrace) +FILE(COPY ${include_dir}/utils/stacktrace/log.hpp DESTINATION ${build_include_dir}/utils/stacktrace) FILE(COPY ${include_dir}/utils/auto_scope.hpp DESTINATION ${build_include_dir}/utils) FILE(COPY ${include_dir}/utils/assert.hpp DESTINATION ${build_include_dir}/utils) FILE(COPY ${include_dir}/utils/reference_wrapper.hpp DESTINATION ${build_include_dir}/utils) diff --git a/include/utils/assert.hpp b/include/utils/assert.hpp index 52c4ee49c..b5fec6070 100644 --- a/include/utils/assert.hpp +++ b/include/utils/assert.hpp @@ -25,9 +25,12 @@ // parmanant exception will always be executed #define permanent_assert(condition, message) \ - if (!(condition)) { \ + if (!(condition)) \ + { \ std::ostringstream s; \ s << message; \ + std::cout << s.str() << std::endl; \ + std::exit(EXIT_FAILURE); \ } // assert_error_handler_(__FILE__, __LINE__, s.str().c_str()); diff --git a/include/utils/exceptions/basic_exception.hpp b/include/utils/exceptions/basic_exception.hpp index 32459dcbf..9a30e854b 100644 --- a/include/utils/exceptions/basic_exception.hpp +++ b/include/utils/exceptions/basic_exception.hpp @@ -4,39 +4,25 @@ #include #include "utils/auto_scope.hpp" -#include "utils/stacktrace.hpp" +#include "utils/stacktrace/stacktrace.hpp" -class BasicException : public std::exception { - public: - BasicException(const std::string &message, uint64_t stacktrace_size) noexcept - : message_(message), - stacktrace_size_(stacktrace_size) { - generate_stacktrace(); - } - BasicException(const std::string &message) noexcept : message_(message), - stacktrace_size_(10) { - generate_stacktrace(); - } - - template - BasicException(const std::string &format, Args &&... args) noexcept - : BasicException(fmt::format(format, std::forward(args)...)) {} - - const char *what() const noexcept override { return message_.c_str(); } - - private: - std::string message_; - uint64_t stacktrace_size_; - - void generate_stacktrace() { -#ifndef NDEBUG - Stacktrace stacktrace; - - int size = std::min(stacktrace_size_, stacktrace.size()); - for (int i = 0; i < size; i++) { - message_.append(fmt::format("\n at {} ({})", stacktrace[i].function, - stacktrace[i].location)); +class BasicException : public std::exception +{ +public: + BasicException(const std::string &message) noexcept : message_(message) + { + Stacktrace stacktrace; + message_.append(stacktrace.dump()); } -#endif - } + + template + BasicException(const std::string &format, Args &&... args) noexcept + : BasicException(fmt::format(format, std::forward(args)...)) + { + } + + const char *what() const noexcept override { return message_.c_str(); } + +private: + std::string message_; }; diff --git a/include/utils/signals/handler.hpp b/include/utils/signals/handler.hpp index 18d833870..c9328b28d 100644 --- a/include/utils/signals/handler.hpp +++ b/include/utils/signals/handler.hpp @@ -8,34 +8,40 @@ using Function = std::function; -enum class Signal : int { - Terminate = SIGTERM, - SegmentationFault = SIGSEGV, - Interupt = SIGINT, - Quit = SIGQUIT, - Abort = SIGABRT +// TODO: align bits so signals can be combined +// Signal::Terminate | Signal::Interupt +enum class Signal : int +{ + Terminate = SIGTERM, + SegmentationFault = SIGSEGV, + Interupt = SIGINT, + Quit = SIGQUIT, + Abort = SIGABRT, + BusError = SIGBUS, }; -class SignalHandler { - private: - static std::map> handlers_; +class SignalHandler +{ +private: + static std::map> handlers_; - static void handle(int signal) { handlers_[signal](); } + static void handle(int signal) { handlers_[signal](); } - public: - static void register_handler(Signal signal, Function func) { - int signal_number = static_cast(signal); - handlers_[signal_number] = func; - std::signal(signal_number, SignalHandler::handle); - } - - // TODO possible changes if signelton needed later - /* - static SignalHandler& instance() { - static SignalHandler instance; - return instance; +public: + static void register_handler(Signal signal, Function func) + { + int signal_number = static_cast(signal); + handlers_[signal_number] = func; + std::signal(signal_number, SignalHandler::handle); } - */ + + // TODO possible changes if signelton needed later + /* + static SignalHandler& instance() { + static SignalHandler instance; + return instance; + } + */ }; std::map> SignalHandler::handlers_ = {}; diff --git a/include/utils/stacktrace/log.hpp b/include/utils/stacktrace/log.hpp new file mode 100644 index 000000000..31f273f4f --- /dev/null +++ b/include/utils/stacktrace/log.hpp @@ -0,0 +1,11 @@ +#pragma once + +#include "logging/default.hpp" +#include "utils/stacktrace/stacktrace.hpp" + +void log_stacktrace(const std::string& title) +{ + Stacktrace stacktrace; + logging::info(title); + logging::info(stacktrace.dump()); +} diff --git a/include/utils/stacktrace.hpp b/include/utils/stacktrace/stacktrace.hpp similarity index 52% rename from include/utils/stacktrace.hpp rename to include/utils/stacktrace/stacktrace.hpp index ce063438a..e33050def 100644 --- a/include/utils/stacktrace.hpp +++ b/include/utils/stacktrace/stacktrace.hpp @@ -1,10 +1,10 @@ #pragma once #include -#include #include - #include +#include + #include "utils/auto_scope.hpp" class Stacktrace @@ -13,11 +13,13 @@ public: class Line { public: - Line(const std::string& original) : original(original) {} + Line(const std::string &original) : original(original) {} - Line(const std::string& original, const std::string& function, - const std::string& location) - : original(original), function(function), location(location) {} + Line(const std::string &original, const std::string &function, + const std::string &location) + : original(original), function(function), location(location) + { + } std::string original, function, location; }; @@ -26,17 +28,17 @@ public: Stacktrace() { - void* addresses[stacktrace_depth]; + void *addresses[stacktrace_depth]; auto depth = backtrace(addresses, stacktrace_depth); // will this leak if backtrace_symbols throws? - char** symbols = nullptr; + char **symbols = nullptr; Auto(free(symbols)); symbols = backtrace_symbols(addresses, depth); // skip the first one since it will be Stacktrace::Stacktrace() - for(int i = 1; i < depth; ++i) + for (int i = 1; i < depth; ++i) lines.emplace_back(format(symbols[i])); } @@ -48,54 +50,53 @@ public: auto end() const { return lines.end(); } auto cend() const { return lines.cend(); } - const Line& operator[](size_t idx) const - { - return lines[idx]; - } + const Line &operator[](size_t idx) const { return lines[idx]; } - size_t size() const - { - return lines.size(); - } + size_t size() const { return lines.size(); } template - void dump(Stream& stream) { - stream << dump(); + void dump(Stream &stream) + { + stream << dump(); } - - std::string dump() { - std::string message; - for (int i = 0; i < size(); i++) { - message.append(fmt::format("at {} ({}) \n", lines[i].function, - lines[i].location)); - } - return message; + + std::string dump() + { + std::string message; + for (size_t i = 0; i < size(); i++) + { + message.append(fmt::format("at {} ({}) \n", lines[i].function, + lines[i].location)); + } + return message; } private: std::vector lines; - Line format(const std::string& original) + Line format(const std::string &original) { using namespace abi; auto line = original; auto begin = line.find('('); - auto end = line.find('+'); + auto end = line.find('+'); - if(begin == std::string::npos || end == std::string::npos) + if (begin == std::string::npos || end == std::string::npos) return {original}; line[end] = '\0'; int s; - auto demangled = __cxa_demangle(line.data() + begin + 1, nullptr, - nullptr, &s); + auto demangled = + __cxa_demangle(line.data() + begin + 1, nullptr, nullptr, &s); auto location = line.substr(0, begin); - auto function = demangled ? std::string(demangled) - : fmt::format("{}()", original.substr(begin + 1, end - begin - 1)); + auto function = + demangled ? std::string(demangled) + : fmt::format("{}()", original.substr(begin + 1, + end - begin - 1)); return {original, function, location}; } diff --git a/include/utils/terminate_handler.hpp b/include/utils/terminate_handler.hpp index 467522e44..c24e1a27f 100644 --- a/include/utils/terminate_handler.hpp +++ b/include/utils/terminate_handler.hpp @@ -1,28 +1,34 @@ #pragma once #include "utils/auto_scope.hpp" -#include "utils/stacktrace.hpp" +#include "utils/stacktrace/stacktrace.hpp" #include #include // TODO: log to local file or remote database -void stacktrace(std::ostream& stream) noexcept { - Stacktrace stacktrace; - stacktrace.dump(stream); +void stacktrace(std::ostream &stream) noexcept +{ + Stacktrace stacktrace; + stacktrace.dump(stream); } // TODO: log to local file or remote database -void terminate_handler(std::ostream& stream) noexcept { - if (auto exc = std::current_exception()) { - try { - std::rethrow_exception(exc); - } catch (std::exception& ex) { - stream << ex.what() << std::endl << std::endl; - stacktrace(stream); +void terminate_handler(std::ostream &stream) noexcept +{ + if (auto exc = std::current_exception()) + { + try + { + std::rethrow_exception(exc); + } + catch (std::exception &ex) + { + stream << ex.what() << std::endl << std::endl; + stacktrace(stream); + } } - } - std::abort(); + std::abort(); } void terminate_handler() noexcept { terminate_handler(std::cout); } diff --git a/src/memgraph_bolt.cpp b/src/memgraph_bolt.cpp index 1c0585068..7f6498794 100644 --- a/src/memgraph_bolt.cpp +++ b/src/memgraph_bolt.cpp @@ -1,5 +1,5 @@ -#include #include +#include #include "communication/bolt/v1/server/server.hpp" #include "communication/bolt/v1/server/worker.hpp" @@ -10,78 +10,74 @@ #include "logging/streams/stdout.hpp" #include "utils/signals/handler.hpp" -#include "utils/stacktrace.hpp" #include "utils/terminate_handler.hpp" +#include "utils/stacktrace/log.hpp" -static bolt::Server* serverptr; +static bolt::Server *serverptr; Logger logger; -static constexpr const char* interface = "0.0.0.0"; -static constexpr const char* port = "7687"; +// TODO: load from configuration +static constexpr const char *interface = "0.0.0.0"; +static constexpr const char *port = "7687"; -void throw_and_stacktace(std::string message) { - Stacktrace stacktrace; - logger.info(stacktrace.dump()); -} - -int main(void) { - // TODO figure out what is the relationship between this and signals - // that are configured below - std::set_terminate(&terminate_handler); - -// logger init +int main(void) +{ +// logging init #ifdef SYNC_LOGGER - logging::init_sync(); + logging::init_sync(); #else - logging::init_async(); + logging::init_async(); #endif - logging::log->pipe(std::make_unique()); + logging::log->pipe(std::make_unique()); - // get Main logger - logger = logging::log->logger("Main"); - logger.info("{}", logging::log->type()); + // logger init + logger = logging::log->logger("Main"); + logger.info("{}", logging::log->type()); - SignalHandler::register_handler(Signal::SegmentationFault, []() { - throw_and_stacktace("SegmentationFault signal raised"); - exit(1); - }); + // unhandled exception handler + std::set_terminate(&terminate_handler); - SignalHandler::register_handler(Signal::Terminate, []() { - throw_and_stacktace("Terminate signal raised"); - exit(1); - }); + // signal handling + SignalHandler::register_handler(Signal::SegmentationFault, []() { + log_stacktrace("SegmentationFault signal raised"); + std::exit(EXIT_FAILURE); + }); + SignalHandler::register_handler(Signal::Terminate, []() { + log_stacktrace("Terminate signal raised"); + std::exit(EXIT_FAILURE); + }); + SignalHandler::register_handler(Signal::Abort, []() { + log_stacktrace("Abort signal raised"); + std::exit(EXIT_FAILURE); + }); - SignalHandler::register_handler(Signal::Abort, []() { - throw_and_stacktace("Abort signal raised"); - exit(1); - }); + // initialize socket + io::Socket socket; + try + { + socket = io::Socket::bind(interface, port); + } + catch (io::NetworkError e) + { + logger.error("Cannot bind to socket on {} at {}", interface, port); + logger.error("{}", e.what()); + std::exit(EXIT_FAILURE); + } + socket.set_non_blocking(); + socket.listen(1024); + logger.info("Listening on {} at {}", interface, port); - io::Socket socket; + // initialize server + bolt::Server server(std::move(socket)); + serverptr = &server; - try { - socket = io::Socket::bind(interface, port); - } catch (io::NetworkError e) { - logger.error("Cannot bind to socket on {} at {}", interface, port); - logger.error("{}", e.what()); + // server start with N threads + // TODO: N should be configurable + auto N = std::thread::hardware_concurrency(); + logger.info("Starting {} workers", N); + server.start(N); - std::exit(EXIT_FAILURE); - } - - socket.set_non_blocking(); - socket.listen(1024); - - logger.info("Listening on {} at {}", interface, port); - - bolt::Server server(std::move(socket)); - serverptr = &server; - - // TODO: N should be configurable - auto N = std::thread::hardware_concurrency(); - logger.info("Starting {} workers", N); - server.start(N); - - logger.info("Shutting down..."); - - return EXIT_SUCCESS; + logger.info("Shutting down..."); + return EXIT_SUCCESS; } diff --git a/src/storage/edge_accessor.cpp b/src/storage/edge_accessor.cpp index c8267e91b..3dbded0f7 100644 --- a/src/storage/edge_accessor.cpp +++ b/src/storage/edge_accessor.cpp @@ -2,6 +2,7 @@ #include +#include "utils/assert.hpp" #include "storage/vertex_record.hpp" #include "storage/edge_type/edge_type.hpp" @@ -10,10 +11,12 @@ void EdgeAccessor::remove() const RecordAccessor::remove(); auto from_va = from(); - assert(from_va.fill()); + auto from_va_is_full = from_va.fill(); + runtime_assert(from_va_is_full, "From Vertex Accessor is empty"); auto to_va = to(); - assert(to_va.fill()); + auto to_va_is_full = to_va.fill(); + permanent_assert(to_va_is_full, "To Vertex Accessor is empty"); from_va.update().record->data.out.remove(vlist); to_va.update().record->data.in.remove(vlist); diff --git a/tests/integration/cleaning.cpp b/tests/integration/cleaning.cpp index 7bdbb3bf8..1cbfeb45b 100644 --- a/tests/integration/cleaning.cpp +++ b/tests/integration/cleaning.cpp @@ -1,19 +1,24 @@ #include "_hardcoded_query/basic.hpp" #include "logging/default.hpp" #include "logging/streams/stdout.hpp" +#include "query/preprocesor.hpp" #include "query/strip/stripper.hpp" +#include "utils/assert.hpp" #include "utils/sysinfo/memory.hpp" -template -void run(size_t n, std::string &query, S &stripper, Q &qf) +QueryPreprocessor preprocessor; + +template +void run(size_t n, std::string &query, Q &qf) { - auto stripped = stripper.strip(query); - std::cout << "Running query [" << stripped.hash << "] for " << n << " time." - << std::endl; + auto stripped = preprocessor.preprocess(query); + + logging::info("Running query [{}] x {}.", stripped.hash, n); + for (int i = 0; i < n; i++) { properties_t vec = stripped.arguments; - assert(qf[stripped.hash](std::move(vec))); + permanent_assert(qf[stripped.hash](std::move(vec)), "Query failed!"); } } @@ -29,13 +34,10 @@ int main(void) logging::init_async(); logging::log->pipe(std::make_unique()); - size_t entities_number = 1000; - Db db("cleaning"); - auto query_functions = hardcode::load_basic_functions(db); - - auto stripper = make_query_stripper(TK_LONG, TK_FLOAT, TK_STR, TK_BOOL); + size_t entities_number = 1000; + auto query_functions = hardcode::load_basic_functions(db); std::string create_vertex_label = "CREATE (n:LABEL {name: \"cleaner_test\"}) RETURN n"; @@ -49,17 +51,21 @@ int main(void) // clean vertices // delete vertices a // clean vertices - run(entities_number, create_vertex_label, stripper, query_functions); - assert(db.graph.vertices.access().size() == entities_number); + run(entities_number, create_vertex_label, query_functions); + permanent_assert(db.graph.vertices.access().size() == entities_number, + "Entities number doesn't match"); clean_vertex(db); - assert(db.graph.vertices.access().size() == entities_number); + permanent_assert(db.graph.vertices.access().size() == entities_number, + "Entities number doesn't match (after cleaning)"); - run(1, delete_label_vertices, stripper, query_functions); - assert(db.graph.vertices.access().size() == entities_number); + run(1, delete_label_vertices, query_functions); + permanent_assert(db.graph.vertices.access().size() == entities_number, + "Entities number doesn't match (delete label vertices)"); clean_vertex(db); - assert(db.graph.vertices.access().size() == 0); + permanent_assert(db.graph.vertices.access().size() == 0, + "Db should be empty"); // ******************************* TEST 2 ********************************// // add vertices a @@ -68,26 +74,33 @@ int main(void) // delete vertices a // clean vertices // delete vertices all - run(entities_number, create_vertex_label, stripper, query_functions); - assert(db.graph.vertices.access().size() == entities_number); + run(entities_number, create_vertex_label, query_functions); + permanent_assert(db.graph.vertices.access().size() == entities_number, + "Entities number doesn't match"); - run(entities_number, create_vertex_other, stripper, query_functions); - assert(db.graph.vertices.access().size() == entities_number * 2); + run(entities_number, create_vertex_other, query_functions); + permanent_assert(db.graph.vertices.access().size() == entities_number * 2, + "Entities number doesn't match"); clean_vertex(db); - assert(db.graph.vertices.access().size() == entities_number * 2); + permanent_assert(db.graph.vertices.access().size() == entities_number * 2, + "Entities number doesn't match"); - run(1, delete_label_vertices, stripper, query_functions); - assert(db.graph.vertices.access().size() == entities_number * 2); + run(1, delete_label_vertices, query_functions); + permanent_assert(db.graph.vertices.access().size() == entities_number * 2, + "Entities number doesn't match"); clean_vertex(db); - assert(db.graph.vertices.access().size() == entities_number); + permanent_assert(db.graph.vertices.access().size() == entities_number, + "Entities number doesn't match"); - run(1, delete_all_vertices, stripper, query_functions); - assert(db.graph.vertices.access().size() == entities_number); + run(1, delete_all_vertices, query_functions); + permanent_assert(db.graph.vertices.access().size() == entities_number, + "Entities number doesn't match"); clean_vertex(db); - assert(db.graph.vertices.access().size() == 0); + permanent_assert(db.graph.vertices.access().size() == 0, + "Db should be empty"); // TODO: more tests diff --git a/tests/integration/index.cpp b/tests/integration/index.cpp index 6afc345b6..762134d58 100644 --- a/tests/integration/index.cpp +++ b/tests/integration/index.cpp @@ -3,10 +3,16 @@ #include "_hardcoded_query/basic.hpp" #include "logging/default.hpp" #include "logging/streams/stdout.hpp" +#include "query/preprocesor.hpp" #include "query/strip/stripper.hpp" #include "storage/indexes/indexes.hpp" +#include "utils/assert.hpp" +#include "utils/signals/handler.hpp" +#include "utils/stacktrace/log.hpp" #include "utils/sysinfo/memory.hpp" +QueryPreprocessor preprocessor; + // Returns uniform random size_t generator from range [0,n> auto rand_gen(size_t n) { @@ -17,44 +23,43 @@ auto rand_gen(size_t n) void run(size_t n, std::string &query, Db &db) { - auto stripper = make_query_stripper(TK_LONG, TK_FLOAT, TK_STR, TK_BOOL); + auto qf = hardcode::load_basic_functions(db); + auto stripped = preprocessor.preprocess(query); - auto qf = hardcode::load_basic_functions(db); + logging::info("Running query [{}] x {}.", stripped.hash, n); - auto stripped = stripper.strip(query); - std::cout << "Running query [" << stripped.hash << "] for " << n << " time." - << std::endl; - for (int i = 0; i < n; i++) { + for (int i = 0; i < n; i++) + { properties_t vec = stripped.arguments; - assert(qf[stripped.hash](std::move(vec))); + auto commited = qf[stripped.hash](std::move(vec)); + permanent_assert(commited, "Query execution failed"); } } void add_edge(size_t n, Db &db) { - auto stripper = make_query_stripper(TK_LONG, TK_FLOAT, TK_STR, TK_BOOL); - auto qf = hardcode::load_basic_functions(db); - std::string query = "MATCH (n1), (n2) WHERE ID(n1)=0 AND " "ID(n2)=1 CREATE (n1)<-[r:IS {age: " "25,weight: 70}]-(n2) RETURN r"; + auto stripped = preprocessor.preprocess(query); - auto stripped = stripper.strip(query); - std::cout << "Running query [" << stripped.hash << "] for " << n - << " time to add edge." << std::endl; + logging::info("Running query [{}] (add edge) x {}", stripped.hash, n); std::vector vertices; - for (auto &v : db.graph.vertices.access()) { + for (auto &v : db.graph.vertices.access()) + { vertices.push_back(v.second.id); } + permanent_assert(vertices.size() > 0, "Vertices size is zero"); auto rand = rand_gen(vertices.size()); - for (int i = 0; i < n; i++) { + for (int i = 0; i < n; i++) + { properties_t vec = stripped.arguments; - vec[0] = Property(Int64(vertices[rand()]), Flags::Int64); - vec[1] = Property(Int64(vertices[rand()]), Flags::Int64); - assert(qf[stripped.hash](std::move(vec))); + vec[0] = Property(Int64(vertices[rand()]), Flags::Int64); + vec[1] = Property(Int64(vertices[rand()]), Flags::Int64); + permanent_assert(qf[stripped.hash](std::move(vec)), "Add edge failed"); } } @@ -64,7 +69,7 @@ void add_property(Db &db, StoredProperty &prop) t.vertex_access().fill().update().for_all([&](auto va) { va.set(prop); }); - assert(t.commit()); + permanent_assert(t.commit(), "Add property failed"); } void add_vertex_property_serial_int(Db &db, PropertyFamily &f) @@ -79,7 +84,7 @@ void add_vertex_property_serial_int(Db &db, PropertyFamily &f) i++; }); - assert(t.commit()); + permanent_assert(t.commit(), "Add vertex property serial int failed"); } void add_edge_property_serial_int(Db &db, PropertyFamily &f) @@ -94,7 +99,7 @@ void add_edge_property_serial_int(Db &db, PropertyFamily &f) i++; }); - assert(t.commit()); + permanent_assert(t.commit(), "Add Edge property serial int failed"); } template @@ -103,8 +108,9 @@ size_t size(Db &db, IndexHolder &h) DbAccessor t(db); size_t count = 0; - auto oin = h.get_read(); - if (oin.is_present()) { + auto oin = h.get_read(); + if (oin.is_present()) + { oin.get()->for_range(t).for_all([&](auto va) mutable { count++; }); } @@ -115,8 +121,10 @@ size_t size(Db &db, IndexHolder &h) void assert_empty(Db &db) { - assert(db.graph.vertices.access().size() == 0); - assert(db.graph.edges.access().size() == 0); + permanent_assert(db.graph.vertices.access().size() == 0, + "DB isn't empty (vertices)"); + permanent_assert(db.graph.edges.access().size() == 0, + "DB isn't empty (edges)"); } void clean_vertex(Db &db) @@ -136,7 +144,7 @@ void clean_edge(Db &db) void clear_database(Db &db) { std::string delete_all_vertices = "MATCH (n) DELETE n"; - std::string delete_all_edges = "MATCH ()-[r]-() DELETE r"; + std::string delete_all_edges = "MATCH ()-[r]-() DELETE r"; run(1, delete_all_edges, db); run(1, delete_all_vertices, db); @@ -151,14 +159,16 @@ bool equal(Db &a, Db &b) auto acc_a = a.graph.vertices.access(); auto acc_b = b.graph.vertices.access(); - if (acc_a.size() != acc_b.size()) { + if (acc_a.size() != acc_b.size()) + { return false; } auto it_a = acc_a.begin(); auto it_b = acc_b.begin(); - for (auto i = acc_a.size(); i > 0; i--) { + for (auto i = acc_a.size(); i > 0; i--) + { // TODO: compare } } @@ -167,14 +177,16 @@ bool equal(Db &a, Db &b) auto acc_a = a.graph.edges.access(); auto acc_b = b.graph.edges.access(); - if (acc_a.size() != acc_b.size()) { + if (acc_a.size() != acc_b.size()) + { return false; } auto it_a = acc_a.begin(); auto it_b = acc_b.begin(); - for (auto i = acc_a.size(); i > 0; i--) { + for (auto i = acc_a.size(); i > 0; i--) + { // TODO: compare } } @@ -187,6 +199,16 @@ int main(void) logging::init_async(); logging::log->pipe(std::make_unique()); + SignalHandler::register_handler(Signal::SegmentationFault, []() { + log_stacktrace("SegmentationFault signal raised"); + std::exit(EXIT_FAILURE); + }); + + SignalHandler::register_handler(Signal::BusError, []() { + log_stacktrace("Bus error signal raised"); + std::exit(EXIT_FAILURE); + }); + size_t cvl_n = 1; std::string create_vertex_label = @@ -194,7 +216,7 @@ int main(void) std::string create_vertex_other = "CREATE (n:OTHER {name: \"cleaner_test\"}) RETURN n"; std::string delete_label_vertices = "MATCH (n:LABEL) DELETE n"; - std::string delete_all_vertices = "MATCH (n) DELETE n"; + std::string delete_all_vertices = "MATCH (n) DELETE n"; IndexDefinition vertex_property_nonunique_unordered = { IndexLocation{VertexSide, Option("prop"), @@ -215,15 +237,19 @@ int main(void) // ******************************* TEST 1 ********************************// { - std::cout << "TEST1" << std::endl; + logging::info("TEST 1"); // add indexes // add vertices LABEL // add edges // add vertices property // assert index size. Db db("index", false); - assert(db.indexes().add_index(vertex_property_nonunique_unordered)); - assert(db.indexes().add_index(edge_property_nonunique_unordered)); + permanent_assert( + db.indexes().add_index(vertex_property_nonunique_unordered), + "Add vertex index failed"); + permanent_assert( + db.indexes().add_index(edge_property_nonunique_unordered), + "Add edge index failed"); run(cvl_n, create_vertex_label, db); auto sp = StoredProperty( @@ -232,18 +258,21 @@ int main(void) .family_key()); add_property(db, sp); - assert(cvl_n == - size(db, db.graph.vertices.property_family_find_or_create("prop") - .index)); + permanent_assert( + cvl_n == size(db, db.graph.vertices + .property_family_find_or_create("prop") + .index), + "Create vertex property failed"); add_edge(cvl_n, db); add_edge_property_serial_int( db, db.graph.edges.property_family_find_or_create("prop")); - assert( + permanent_assert( cvl_n == - size(db, - db.graph.edges.property_family_find_or_create("prop").index)); + size(db, db.graph.edges.property_family_find_or_create("prop") + .index), + "Create edge property failed"); } // TODO: more tests diff --git a/tests/integration/snapshot.cpp b/tests/integration/snapshot.cpp index 6c8309e44..2c2157c87 100644 --- a/tests/integration/snapshot.cpp +++ b/tests/integration/snapshot.cpp @@ -1,12 +1,18 @@ #include +#include "_hardcoded_query/basic.hpp" #include "logging/default.hpp" #include "logging/streams/stdout.hpp" -#include "_hardcoded_query/basic.hpp" +#include "query/preprocesor.hpp" #include "query/strip/stripper.hpp" #include "storage/indexes/indexes.hpp" +#include "utils/assert.hpp" +#include "utils/signals/handler.hpp" +#include "utils/stacktrace/log.hpp" #include "utils/sysinfo/memory.hpp" +QueryPreprocessor preprocessor; + // Returns uniform random size_t generator from range [0,n> auto rand_gen(size_t n) { @@ -17,32 +23,28 @@ auto rand_gen(size_t n) void run(size_t n, std::string &query, Db &db) { - auto stripper = make_query_stripper(TK_LONG, TK_FLOAT, TK_STR, TK_BOOL); + auto qf = hardcode::load_basic_functions(db); + auto stripped = preprocessor.preprocess(query); - auto qf = hardcode::load_basic_functions(db); + logging::info("Running query {} [{}] x {}.", query, stripped.hash, n); - auto stripped = stripper.strip(query); - std::cout << "Running query [" << stripped.hash << "] for " << n << " time." - << std::endl; for (int i = 0; i < n; i++) { properties_t vec = stripped.arguments; - assert(qf[stripped.hash](std::move(vec))); + permanent_assert(qf[stripped.hash](std::move(vec)), "Query aborted"); } } void add_edge(size_t n, Db &db) { - auto stripper = make_query_stripper(TK_LONG, TK_FLOAT, TK_STR, TK_BOOL); - auto qf = hardcode::load_basic_functions(db); + auto qf = hardcode::load_basic_functions(db); std::string query = "MATCH (n1), (n2) WHERE ID(n1)=0 AND " "ID(n2)=1 CREATE (n1)<-[r:IS {age: " "25,weight: 70}]-(n2) RETURN r"; + auto stripped = preprocessor.preprocess(query); - auto stripped = stripper.strip(query); - std::cout << "Running query [" << stripped.hash << "] for " << n - << " time to add edge." << std::endl; + logging::info("Running query {} [{}] x {}.", query, stripped.hash, n); std::vector vertices; for (auto &v : db.graph.vertices.access()) @@ -56,7 +58,7 @@ void add_edge(size_t n, Db &db) properties_t vec = stripped.arguments; vec[0] = Property(Int64(vertices[rand()]), Flags::Int64); vec[1] = Property(Int64(vertices[rand()]), Flags::Int64); - assert(qf[stripped.hash](std::move(vec))); + permanent_assert(qf[stripped.hash](std::move(vec)), "Query aborted"); } } @@ -66,7 +68,8 @@ void add_property(Db &db, StoredProperty &prop) t.vertex_access().fill().for_all([&](auto va) { va.set(prop); }); - assert(t.commit()); + permanent_assert(t.commit(), "add property query aborted"); + ; } void add_property_different_int(Db &db, PropertyFamily &f) @@ -81,7 +84,7 @@ void add_property_different_int(Db &db, PropertyFamily &f) i++; }); - assert(t.commit()); + permanent_assert(t.commit(), "add property different int aborted"); } size_t size(Db &db, IndexHolder &h) @@ -102,8 +105,8 @@ size_t size(Db &db, IndexHolder &h) void assert_empty(Db &db) { - assert(db.graph.vertices.access().size() == 0); - assert(db.graph.edges.access().size() == 0); + permanent_assert(db.graph.vertices.access().size() == 0, "Db isn't empty"); + permanent_assert(db.graph.edges.access().size() == 0, "Db isn't empty"); } void clean_vertex(Db &db) @@ -178,6 +181,11 @@ int main(void) logging::init_async(); logging::log->pipe(std::make_unique()); + SignalHandler::register_handler(Signal::SegmentationFault, []() { + log_stacktrace("SegmentationFault signal raised"); + std::exit(EXIT_FAILURE); + }); + size_t cvl_n = 1000; std::string create_vertex_label = @@ -187,9 +195,8 @@ int main(void) std::string delete_label_vertices = "MATCH (n:LABEL) DELETE n"; std::string delete_all_vertices = "MATCH (n) DELETE n"; - // ******************************* TEST 1 ********************************// { - std::cout << "TEST1" << std::endl; + logging::info("TEST 1"); // make snapshot of empty db // add vertexs // add edges @@ -203,11 +210,11 @@ int main(void) clear_database(db); db.snap_engine.import(); assert_empty(db); + logging::info("END of TEST 1"); } - // ******************************* TEST 2 ********************************// { - std::cout << "TEST2" << std::endl; + logging::info("TEST 2"); // add vertexs // add edges // make snapshot of db @@ -223,13 +230,12 @@ int main(void) db.snap_engine.import(); { Db db2("snapshot"); - assert(equal(db, db2)); + permanent_assert(equal(db, db2), "Dbs aren't equal"); } } - // ******************************* TEST 3 ********************************// { - std::cout << "TEST3" << std::endl; + logging::info("TEST 3"); // add vertexs // add edges // make snapshot of db @@ -240,13 +246,12 @@ int main(void) db.snap_engine.make_snapshot(); { Db db2("not_snapshot"); - assert(!equal(db, db2)); + permanent_assert(!equal(db, db2), "Dbs are equal"); } } - // ******************************* TEST 4 ********************************// { - std::cout << "TEST4" << std::endl; + logging::info("TEST 4"); // add vertices LABEL // add properties // add vertices LABEL @@ -265,14 +270,17 @@ int main(void) IndexLocation{VertexSide, Option("prop"), Option(), Option()}, IndexType{false, None}}; - assert(db.indexes().add_index(idef)); - assert(cvl_n == size(db, family.index)); + permanent_assert(db.indexes().add_index(idef), "Index isn't added"); + permanent_assert(cvl_n == size(db, family.index), + "Index size isn't valid"); db.snap_engine.make_snapshot(); { Db db2("snapshot"); - assert(cvl_n == size(db, db2.graph.vertices - .property_family_find_or_create("prop") - .index)); + permanent_assert( + cvl_n == size(db, db2.graph.vertices + .property_family_find_or_create("prop") + .index), + "Index size isn't valid"); } } diff --git a/tests/unit/signal_handler.cpp b/tests/unit/signal_handler.cpp index 12ee95e5a..d61e50e09 100644 --- a/tests/unit/signal_handler.cpp +++ b/tests/unit/signal_handler.cpp @@ -6,14 +6,15 @@ #include #include "utils/signals/handler.hpp" -#include "utils/stacktrace.hpp" +#include "utils/stacktrace/stacktrace.hpp" -TEST_CASE("SignalHandler Segmentation Fault Test") { - SignalHandler::register_handler(Signal::SegmentationFault, []() { - std::cout << "Segmentation Fault" << std::endl; - Stacktrace stacktrace; - std::cout << stacktrace.dump() << std::endl; - }); +TEST_CASE("SignalHandler Segmentation Fault Test") +{ + SignalHandler::register_handler(Signal::SegmentationFault, []() { + std::cout << "Segmentation Fault" << std::endl; + Stacktrace stacktrace; + std::cout << stacktrace.dump() << std::endl; + }); - std::raise(SIGSEGV); + std::raise(SIGSEGV); } From 96406615199bf7fd71a4f978091e718ac388d386 Mon Sep 17 00:00:00 2001 From: Marko Budiselic Date: Tue, 20 Dec 2016 15:49:07 +0100 Subject: [PATCH 04/13] Doxygen setup Summary: Doxygen setup Test Plan: run doxygen Doxyfile Reviewers: sale Subscribers: buda, sale Differential Revision: https://memgraph.phacility.com/D22 --- Doxyfile | 2436 +++++++++++++++++++++++++++++++++++++++++++++++ Doxylogo.png | Bin 0 -> 6742 bytes docs/.gitignore | 2 + docs/README.md | 7 + docs/index.md | 1 - 5 files changed, 2445 insertions(+), 1 deletion(-) create mode 100644 Doxyfile create mode 100644 Doxylogo.png create mode 100644 docs/.gitignore create mode 100644 docs/README.md delete mode 100644 docs/index.md diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 000000000..77d57872c --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2436 @@ +# Doxyfile 1.8.11 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "The World's Most Powerful Graph Database" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = Doxylogo.png + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, +# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = */.git/* +EXCLUDE_PATTERNS += */build/* +EXCLUDE_PATTERNS += */cmake/* +EXCLUDE_PATTERNS += */config/* +EXCLUDE_PATTERNS += */docker/* +EXCLUDE_PATTERNS += */docs/* +EXCLUDE_PATTERNS += */libs/* +EXCLUDE_PATTERNS += */release/* +EXCLUDE_PATTERNS += */Testing/* +EXCLUDE_PATTERNS += */tests/* + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 28 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 250 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /