├── .gitmodules ├── .travis.yml ├── .gitignore ├── src ├── Utils.h ├── System.cpp └── Manager.cpp ├── include └── ecs │ ├── Entity.h │ ├── ComponentType.h │ ├── Component.h │ ├── System.h │ ├── ComponentStore.h │ └── Manager.h ├── LICENSE.txt ├── ecs.dox ├── README.md ├── tests ├── System_test.cpp ├── ComponentStore_test.cpp └── Manager_test.cpp ├── CMakeLists.txt ├── examples └── basic │ └── basic.cpp └── Doxyfile /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "googletest"] 2 | path = googletest 3 | url = https://git.chromium.org/git/external/googletest.git 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: cpp 2 | 3 | compiler: 4 | - gcc 5 | - clang 6 | 7 | before_install: 8 | - sudo apt-get update -qq 9 | - sudo apt-get install -qq cppcheck 10 | 11 | before_script: 12 | - mkdir build 13 | - cd build 14 | - cmake .. 15 | 16 | script: make && make test 17 | 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | Debug 2 | Release 3 | build 4 | Makefile 5 | .cproject 6 | .project 7 | /ecs 8 | *.a 9 | 10 | *.sln 11 | *.ncb 12 | *.suo 13 | *.user 14 | *sdf 15 | *.vc* 16 | *~ 17 | doc 18 | core 19 | *ipch 20 | .settings/ 21 | 22 | CMakeCache.txt 23 | CMakeFiles 24 | *.cmake 25 | *.dir 26 | Testing 27 | Win32 28 | -------------------------------------------------------------------------------- /src/Utils.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @file Utils.h 3 | * @ingroup ecs 4 | * @brief Utilities and compatibility macros. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | #pragma once 12 | 13 | 14 | // Detect whether the compiler supports C++11 virtual override specifiers. 15 | #if (defined(__GNUC__) && (__GNUC__ == 4)) // We do not care of GCC prior 4.x (without any form of C++11 support) 16 | /// GCC 4.7 and following have "override" and "final" support when called with -std=c++0x (or -std=c++11 starting with GCC 4.7) 17 | #if ((__GNUC_MINOR__ < 7) || !defined(__GXX_EXPERIMENTAL_CXX0X__)) 18 | /// GCC 4.6 and below does not know the "override" specifier, so we define it as nothing 19 | #define override // nothing 20 | #endif 21 | #endif 22 | -------------------------------------------------------------------------------- /include/ecs/Entity.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @file Entity.h 3 | * @ingroup ecs 4 | * @brief An ecs::Entity is an Id referencing a game object. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | #pragma once 12 | 13 | namespace ecs { 14 | 15 | /** 16 | * @brief An Entity is a positive Id referencing a game object. Its data are in Components, and logic in Systems. 17 | * @ingroup ecs 18 | * 19 | * An Entity represents an object, but does not contain any data by its own, nor any logic. 20 | * It is only defined as a aggregation of Components, processed and updated by associated Systems. 21 | */ 22 | typedef unsigned int Entity; 23 | 24 | /** 25 | * @brief Entities are strictly positive Ids. 26 | * @ingroup ecs 27 | */ 28 | static const Entity _invalidEntity = 0; 29 | 30 | } // namespace ecs 31 | -------------------------------------------------------------------------------- /include/ecs/ComponentType.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @file ComponentType.h 3 | * @ingroup ecs 4 | * @brief A ecs::ComponentType is a positive Id referencing a type of ecs::Component. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | #pragma once 12 | 13 | #include 14 | 15 | namespace ecs { 16 | 17 | /** 18 | * @brief A ComponentType is a positive Id referencing a type of Component. 19 | * @ingroup ecs 20 | */ 21 | typedef unsigned int ComponentType; 22 | 23 | /** 24 | * @brief ComponentType are strictly positive Ids. 25 | * @ingroup ecs 26 | */ 27 | static const ComponentType _invalidComponentType = 0; 28 | 29 | /** 30 | * @brief Sorted List (set) of ComponentType (of an Entity, or required by a System) 31 | * @ingroup ecs 32 | */ 33 | typedef std::set ComponentTypeSet; 34 | 35 | } // namespace ecs 36 | -------------------------------------------------------------------------------- /include/ecs/Component.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @file Component.h 3 | * @ingroup ecs 4 | * @brief A ecs::Component keep the data for one aspect of an ecs::Entity. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | #pragma once 12 | 13 | #include 14 | 15 | namespace ecs { 16 | 17 | /** 18 | * @brief A Component keep the data for one aspect of an Entity. 19 | * @ingroup ecs 20 | * 21 | * A Component is a data structure that maintain a sub-state of an entity. 22 | * The state of any Entity can be described by a few standard Components. 23 | * 24 | * Every Component class must derived from this struct and define its own/unique positive #ComponentType. 25 | */ 26 | struct Component { 27 | /// Default invalid component type 28 | static const ComponentType _mType = _invalidComponentType; 29 | }; 30 | 31 | } // namespace ecs 32 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is furnished 10 | to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 19 | WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 20 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- /ecs.dox: -------------------------------------------------------------------------------- 1 | /** 2 | * @mainpage C++11 Entity-Component-System library. 3 | * 4 | * Entity-component-system (ECS) is a software architecture pattern based on the concept of Composition over Inheritance and Data-Driven Programming techniques. 5 | * As such, it is a paradigm orthogonal to Object Oriented Programming. 6 | * 7 | * - An @ref ecs::Entity "Entity" represents an object, but does not contain any data by its own, nor any logic. It is only defined as an aggregation of Components, processed by associated Systems. 8 | * - A @ref ecs::Component "Component" is a data structure that maintain a sub-state of an entity. The state of any Entity can be described by a few standard Components. 9 | * - A @ref ecs::System "System" is a program runing logic and updating data on any Entity holding a certain set of Components. Systems run repeteadly on all corresponding Entities. 10 | */ 11 | 12 | /** 13 | * @defgroup ecs ecs 14 | * @brief A simple C++11 Entity-Component-System library. 15 | */ 16 | 17 | /** 18 | * @dir src 19 | * @brief Source directory of the #ecs library. 20 | * @ingroup ecs 21 | */ 22 | 23 | /** 24 | * @dir include 25 | * @brief Include directory of the #ecs library. 26 | * @ingroup ecs 27 | */ 28 | -------------------------------------------------------------------------------- /src/System.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * @file System.cpp 3 | * @ingroup ecs 4 | * @brief A ecs::System manages all ecs::Entity having all required ecs::Component. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | 12 | #include 13 | #include 14 | 15 | namespace ecs { 16 | 17 | System::System(Manager& aManager) : 18 | mManager(aManager) { 19 | } 20 | 21 | System::~System() { 22 | } 23 | 24 | /** 25 | * @brief Update function - for all matching Entities. 26 | * 27 | * @param[in] aElapsedTime Elapsed time since last update call, in seconds. 28 | */ 29 | size_t System::updateEntities(float aElapsedTime) { 30 | size_t nbUpdatedEntities = 0; 31 | 32 | for (auto entity = mMatchingEntities.begin(); 33 | entity != mMatchingEntities.end(); 34 | ++entity) { 35 | // For each matching Entity, call the specialized System update method. 36 | updateEntity(aElapsedTime, *entity); 37 | ++nbUpdatedEntities; 38 | } 39 | 40 | return nbUpdatedEntities; 41 | } 42 | 43 | /* virtual pure method to be specialized by user classes 44 | void System::updateEntity(float aElapsedTime, Entity aEntity) { 45 | } 46 | */ 47 | 48 | } // namespace ecs 49 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ecs 2 | --- 3 | 4 | ![ecs build status](https://api.travis-ci.org/SRombauts/ecs.png "ecs build status") 5 | 6 | A simple C++11 Entity-Component-System library. 7 | 8 | ### Entity-Component-System 9 | 10 | Entity-component-system (ECS) is a software architecture pattern based on the concept of Composition over Inheritance and Data-Driven Programming techniques. 11 | As such, it is a paradigm orthogonal to Object Oriented Programming. 12 | 13 | - An Entity represents an object, but does not contain any data by its own, nor any logic. It is only defined as an aggregation of Components, processed by associated Systems. 14 | - A Component is a data structure that maintain a sub-state of an entity. The state of any Entity can be described by a few standard Components. 15 | - A System is a program runing logic and updating data on any Entity holding a certain set of Components. Systems run repeteadly on all corresponding Entities. 16 | 17 | ### Goals 18 | 19 | Build an efficient, small, simple and easy to use framework, written in modern C++11 but compatible with widespread compilers (Visual Studio 2010 and GCC 4.6). 20 | Provide full Doxygen documentation, full test coverage and a few samples to show how to use it. 21 | 22 | ### Requirements 23 | 24 | Developements and tests are done under the following OSs: 25 | - Debian 7 26 | - Ubuntu 12.10 27 | - Windows XP/7/8 28 | And following IDEs/Compilers 29 | - GCC 4.7.2 30 | - GCC 4.6.3 with Travis-CI 31 | - Visual Studio Express 2010/2013 for testing compatibility purpose 32 | 33 | ### Continuous Integration 34 | 35 | This project is continuously tested under Ubuntu Linux with the gcc and clang compilers 36 | using the Travis CI community service with the above CMake building and testing procedure. 37 | 38 | Detailed results can be seen online: https://travis-ci.org/SRombauts/ecs 39 | 40 | ### License 41 | 42 | Copyright (c) 2014 Sébastien Rombauts (sebastien.rombauts@gmail.com) 43 | 44 | Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 45 | or copy at http://opensource.org/licenses/MIT) 46 | 47 | ## See also: 48 | 49 | - [Entity Component System on Wikipedia](http://en.wikipedia.org/wiki/Entity_component_system) 50 | - [Rdbms With Code In Systems](http://entity-systems.wikidot.com/rdbms-with-code-in-systems) 51 | - [Nytro Game Engine DevBlog](http://blog.7thfactor.com/?p=436) 52 | - [libes](https://github.com/jube/libes) 53 | -------------------------------------------------------------------------------- /tests/System_test.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * @file System_test.cpp 3 | * @ingroup ecs_test 4 | * @brief Test of a System. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | 12 | #include 13 | #include 14 | #include 15 | 16 | #include "../src/Utils.h" // defines the "override" identifier if needed (gcc < 4.7) 17 | 18 | #include 19 | 20 | 21 | // A test System 22 | class SystemTest1 : public ecs::System { 23 | public: 24 | explicit SystemTest1(ecs::Manager& aManager) : 25 | ecs::System(aManager) { 26 | } 27 | 28 | // Update function - for a given matching Entity - specialized. 29 | virtual void updateEntity(float, ecs::Entity) override { 30 | } 31 | }; 32 | 33 | // Adding/removing/testing for presence 34 | TEST(System, hasHadRemove) { 35 | ecs::Manager manager; 36 | SystemTest1 system(manager); 37 | ecs::Entity entity1 = 1; 38 | ecs::Entity entity2 = 2; 39 | // Before any insertion 40 | EXPECT_FALSE(system.hasEntity(entity1)); 41 | EXPECT_FALSE(system.hasEntity(entity2)); 42 | EXPECT_EQ(0U, system.unregisterEntity(entity1)); 43 | EXPECT_EQ(0U, system.unregisterEntity(entity2)); 44 | // Add an Entity 45 | EXPECT_TRUE(system.registerEntity(entity1)); 46 | EXPECT_TRUE(system.hasEntity(entity1)); 47 | EXPECT_FALSE(system.hasEntity(entity2)); 48 | // Error: An Entity can be inserted only once for a given Entity 49 | EXPECT_FALSE(system.registerEntity(entity1)); 50 | EXPECT_TRUE(system.hasEntity(entity1)); 51 | EXPECT_FALSE(system.hasEntity(entity2)); 52 | // Add the second Entity 53 | EXPECT_TRUE(system.registerEntity(entity2)); 54 | EXPECT_TRUE(system.hasEntity(entity1)); 55 | EXPECT_TRUE(system.hasEntity(entity2)); 56 | // Error: An Entity can be inserted only once for a given Entity 57 | EXPECT_FALSE(system.registerEntity(entity2)); 58 | EXPECT_TRUE(system.hasEntity(entity1)); 59 | EXPECT_TRUE(system.hasEntity(entity2)); 60 | // Remove the first Entity 61 | EXPECT_EQ(1U, system.unregisterEntity(entity1)); 62 | EXPECT_FALSE(system.hasEntity(entity1)); 63 | EXPECT_TRUE(system.hasEntity(entity2)); 64 | // An Entity can be removed only once for a given Entity 65 | EXPECT_EQ(0U, system.unregisterEntity(entity1)); 66 | EXPECT_FALSE(system.hasEntity(entity1)); 67 | EXPECT_TRUE(system.hasEntity(entity2)); 68 | // Insert again the second Entity 69 | EXPECT_TRUE(system.registerEntity(entity1)); 70 | EXPECT_TRUE(system.hasEntity(entity1)); 71 | EXPECT_TRUE(system.hasEntity(entity2)); 72 | // Remove the the first Entity 73 | EXPECT_EQ(1U, system.unregisterEntity(entity1)); 74 | EXPECT_FALSE(system.hasEntity(entity1)); 75 | EXPECT_TRUE(system.hasEntity(entity2)); 76 | // Remove the the second Entity 77 | EXPECT_EQ(1U, system.unregisterEntity(entity2)); 78 | EXPECT_FALSE(system.hasEntity(entity1)); 79 | EXPECT_FALSE(system.hasEntity(entity2)); 80 | } 81 | -------------------------------------------------------------------------------- /src/Manager.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * @file Manager.cpp 3 | * @ingroup ecs 4 | * @brief Manage associations of ecs::Entity, ecs::Component and ecs::System. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | 12 | #include 13 | 14 | #include 15 | 16 | namespace ecs { 17 | 18 | Manager::Manager() : 19 | mLastEntity(_invalidEntity), 20 | mEntities(), 21 | mComponentStores(), 22 | mSystems() { 23 | } 24 | 25 | Manager::~Manager() { 26 | } 27 | 28 | // Add a System. 29 | /// @todo Register the System with existing matching Entities? Or only allow Systems to be added during init? 30 | void Manager::addSystem(const System::Ptr& aSystemPtr) { 31 | // Check that required Components are specified 32 | if ((!aSystemPtr) || (aSystemPtr->getRequiredComponents().empty())) { 33 | throw std::runtime_error("System shall specified required Components"); 34 | } 35 | // Simply copy the pointer (instead of moving it) to allow for multiple insertion of the same shared pointer. 36 | mSystems.push_back(aSystemPtr); 37 | } 38 | 39 | // Register an Entity to all matching Systems. 40 | size_t Manager::registerEntity(const Entity aEntity) { 41 | size_t nbAssociatedSystems = 0; 42 | 43 | auto entity = mEntities.find(aEntity); 44 | if (mEntities.end() == entity) { 45 | throw std::runtime_error("The Entity does not exist"); 46 | } 47 | auto entityComponents = (*entity).second; 48 | 49 | // Cycle through all Systems to check which ones can be interested by the Entity 50 | for (auto system = mSystems.begin(); 51 | system != mSystems.end(); 52 | ++system) { 53 | auto systemRequiredComponents = (*system)->getRequiredComponents(); 54 | // Check if all Components Required by the System are in the Entity (use sorted sets) 55 | if (std::includes(entityComponents.begin(), entityComponents.end(), 56 | systemRequiredComponents.begin(), systemRequiredComponents.end())) { 57 | // Register the matching Entity 58 | // TODO(SRombauts) shall throw in case of failure! 59 | (*system)->registerEntity(aEntity); 60 | ++nbAssociatedSystems; 61 | } 62 | } 63 | 64 | return nbAssociatedSystems; 65 | } 66 | 67 | // Unregister an Entity from all matching Systems. 68 | size_t Manager::unregisterEntity(const Entity aEntity) { 69 | size_t nbAssociatedSystems = 0; 70 | 71 | auto entity = mEntities.find(aEntity); 72 | if (mEntities.end() == entity) { 73 | throw std::runtime_error("The Entity does not exist"); 74 | } 75 | auto entityComponents = (*entity).second; 76 | 77 | // Cycle through all Systems to unregister the Entity 78 | for (auto system = mSystems.begin(); 79 | system != mSystems.end(); 80 | ++system) { 81 | // Simply try to unregister the matching Entity 82 | nbAssociatedSystems += (*system)->unregisterEntity(aEntity); 83 | } 84 | 85 | return nbAssociatedSystems; 86 | } 87 | 88 | // Update all Entities of all Systems. 89 | size_t Manager::updateEntities(float abElapsedTime) { 90 | size_t nbUpdatedEntities = 0; 91 | 92 | for (auto system = mSystems.begin(); 93 | system != mSystems.end(); 94 | ++system) { 95 | nbUpdatedEntities += (*system)->updateEntities(abElapsedTime); 96 | } 97 | 98 | return nbUpdatedEntities; 99 | } 100 | 101 | } // namespace ecs 102 | 103 | 104 | 105 | -------------------------------------------------------------------------------- /tests/ComponentStore_test.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * @file ComponentStore_test.cpp 3 | * @ingroup ecs_test 4 | * @brief Test of a ComponentStore. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | 12 | #include 13 | #include 14 | #include 15 | 16 | #include 17 | 18 | 19 | // A test Component 20 | struct ComponentTest1 : public ecs::Component { 21 | static const ecs::ComponentType _mType; 22 | 23 | // A simple test constructor, init the test value 24 | explicit ComponentTest1(int a) : m(a) { 25 | } 26 | 27 | int m; // A simple test value 28 | }; 29 | const ecs::ComponentType ComponentTest1::_mType = 1; 30 | 31 | // Adding/removing/testing for presence 32 | TEST(ComponentStore, hasHadRemove) { 33 | ecs::ComponentStore store; 34 | ecs::Entity entity1 = 1; 35 | ecs::Entity entity2 = 2; 36 | // Before any insertion 37 | EXPECT_FALSE(store.has(entity1)); 38 | EXPECT_FALSE(store.has(entity2)); 39 | EXPECT_THROW(store.get(entity1), std::out_of_range); 40 | EXPECT_THROW(store.get(entity2), std::out_of_range); 41 | EXPECT_FALSE(store.remove(entity1)); 42 | EXPECT_FALSE(store.remove(entity2)); 43 | // Add a component to the first Entity (using a temporary rvalue) 44 | EXPECT_TRUE(store.add(entity1, ComponentTest1(123))); 45 | EXPECT_TRUE(store.has(entity1)); 46 | EXPECT_FALSE(store.has(entity2)); 47 | EXPECT_NO_THROW(store.get(entity1)); 48 | EXPECT_EQ(123, store.get(entity1).m); 49 | EXPECT_THROW(store.get(entity2), std::out_of_range); 50 | // Error: A component can be inserted only once for a given Entity 51 | EXPECT_FALSE(store.add(entity1, ComponentTest1(666))); 52 | EXPECT_TRUE(store.has(entity1)); 53 | EXPECT_FALSE(store.has(entity2)); 54 | // Add a component to the second Entity (using std::move to get the requierd rvalue) 55 | ComponentTest1 component2(456); 56 | EXPECT_TRUE(store.add(entity2, std::move(component2))); 57 | EXPECT_TRUE(store.has(entity1)); 58 | EXPECT_TRUE(store.has(entity2)); 59 | EXPECT_NO_THROW(store.get(entity1)); 60 | EXPECT_EQ(123, store.get(entity1).m); 61 | EXPECT_NO_THROW(store.get(entity2)); 62 | EXPECT_EQ(456, store.get(entity2).m); 63 | // Error: A component can be inserted only once for a given Entity 64 | EXPECT_FALSE(store.add(entity2, ComponentTest1(666))); 65 | EXPECT_TRUE(store.has(entity1)); 66 | EXPECT_TRUE(store.has(entity2)); 67 | // Remove the component of the first Entity 68 | EXPECT_TRUE(store.remove(entity1)); 69 | EXPECT_FALSE(store.has(entity1)); 70 | EXPECT_TRUE(store.has(entity2)); 71 | // A component can be removed only once for a given Entity 72 | EXPECT_FALSE(store.remove(entity1)); 73 | EXPECT_FALSE(store.has(entity1)); 74 | EXPECT_TRUE(store.has(entity2)); 75 | // Insert a new component to the second Entity 76 | EXPECT_TRUE(store.add(entity1, ComponentTest1(789))); 77 | EXPECT_TRUE(store.has(entity1)); 78 | EXPECT_TRUE(store.has(entity2)); 79 | EXPECT_NO_THROW(store.get(entity1)); 80 | EXPECT_EQ(789, store.get(entity1).m); 81 | EXPECT_NO_THROW(store.get(entity2)); 82 | EXPECT_EQ(456, store.get(entity2).m); 83 | // Extract the component of the first Entity 84 | ComponentTest1 component3 = store.extract(entity1); 85 | EXPECT_EQ(789, component3.m); 86 | EXPECT_FALSE(store.has(entity1)); 87 | EXPECT_TRUE(store.has(entity2)); 88 | // Remove the component of the second Entity 89 | EXPECT_TRUE(store.remove(entity2)); 90 | EXPECT_FALSE(store.has(entity1)); 91 | EXPECT_FALSE(store.has(entity2)); 92 | } 93 | -------------------------------------------------------------------------------- /include/ecs/System.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @file System.h 3 | * @ingroup ecs 4 | * @brief A ecs::System manages all ecs::Entity having all required ecs::Component. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | #pragma once 12 | 13 | #include 14 | #include 15 | 16 | #include 17 | #include 18 | 19 | namespace ecs { 20 | 21 | class Manager; 22 | 23 | /** 24 | * @brief A System manages any Entity having all required Component. 25 | * @ingroup ecs 26 | * 27 | * A System is a program running logic and updating data on any Entity holding a certain set of Components. 28 | * Systems run repeatedly on all corresponding Entities. 29 | * 30 | * This is a base class that needs to be subclassed. 31 | * 32 | * @todo Add an additional Entity list, matching an other Component list, to work with (for collision for instance) 33 | */ 34 | class System { 35 | public: 36 | /// A shared pointer to a System is needed to add multiple entry into the vector of Systems, for multi-execution. 37 | typedef std::shared_ptr Ptr; 38 | 39 | /** 40 | * @brief Constructor. 41 | * 42 | * @param[in] aManager Reference to the manager needed to access Entity Components. 43 | */ 44 | explicit System(Manager& aManager); 45 | 46 | /** 47 | * @brief Destructor. 48 | */ 49 | virtual ~System(); 50 | 51 | /** 52 | * @brief Get the Types of all the Components required by the System. 53 | */ 54 | inline const ComponentTypeSet& getRequiredComponents() const { 55 | return mRequiredComponents; 56 | } 57 | 58 | /** 59 | * @brief Register a matching Entity, having all required Components. 60 | * 61 | * @param[in] aEntity Matching Entity 62 | * 63 | * @return true if the Entity has been inserted successfully 64 | */ 65 | inline bool registerEntity(Entity aEntity) { 66 | return mMatchingEntities.insert(aEntity).second; 67 | } 68 | 69 | /** 70 | * @brief Register a matching Entity, having all required Components. 71 | * 72 | * @param[in] aEntity Matching Entity 73 | * 74 | * @return 1 if the Entity has been removed successfully, 0 otherwize 75 | */ 76 | inline size_t unregisterEntity(Entity aEntity) { 77 | return mMatchingEntities.erase(aEntity); 78 | } 79 | 80 | /** 81 | * @brief Test if the System has registered this Entity. 82 | * 83 | * @param[in] aEntity Id of the Entity to find. 84 | * 85 | * @return true if finding the Entity succeeded. 86 | */ 87 | inline bool hasEntity(Entity aEntity) const { 88 | return (mMatchingEntities.end() != mMatchingEntities.find(aEntity)); 89 | } 90 | 91 | /** 92 | * @brief Update function - for all matching Entities. 93 | * 94 | * @param[in] aElapsedTime Elapsed time since last update call, in seconds. 95 | * 96 | * @return Number of updated Entities 97 | */ 98 | size_t updateEntities(float aElapsedTime); 99 | 100 | /** 101 | * @brief Update function - for a given matching Entity - virtual pure. 102 | * 103 | * @param[in] aElapsedTime Elapsed time since last update call, in seconds. 104 | * @param[in] aEntity Matching Entity 105 | */ 106 | virtual void updateEntity(float aElapsedTime, Entity aEntity) = 0; 107 | 108 | protected: 109 | /** 110 | * @brief Specify what are required Components of te System. 111 | * 112 | * @param[in] aRequiredComponents List the Types of all the Components required by the System. 113 | */ 114 | inline void setRequiredComponents(ComponentTypeSet&& aRequiredComponents) { 115 | mRequiredComponents = std::move(aRequiredComponents); 116 | } 117 | 118 | /** 119 | * @brief Reference to the manager needed to access Entity Components. 120 | */ 121 | Manager& mManager; 122 | 123 | private: 124 | /** 125 | * @brief List the Types of all the Components required by the System. 126 | */ 127 | ComponentTypeSet mRequiredComponents; 128 | 129 | /** 130 | * @brief List all the matching Entities having required Components for the System. 131 | */ 132 | std::set mMatchingEntities; 133 | }; 134 | 135 | } // namespace ecs 136 | -------------------------------------------------------------------------------- /include/ecs/ComponentStore.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @file ComponentStore.h 3 | * @ingroup ecs 4 | * @brief A ecs::ComponentStore keep the data of a certain type of ecs::Component for all concerned Entities. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | #pragma once 12 | 13 | #include 14 | #include 15 | 16 | #include 17 | #include 18 | 19 | namespace ecs { 20 | 21 | /** 22 | * @brief Abstract base class for all templated ComponentStore. 23 | * @ingroup ecs 24 | */ 25 | class IComponentStore { 26 | public: 27 | /** 28 | * @brief Unique pointer to a ComponentStore 29 | * 30 | * @todo Remove the use of a pointer => move the ComponentStore into the manager 31 | */ 32 | typedef std::unique_ptr Ptr; 33 | }; 34 | 35 | /** 36 | * @brief A ComponentStore keep all the data of a certain type of Component for all concerned Entities. 37 | * @ingroup ecs 38 | * 39 | * @tparam C A structure derived from Component, of a certain type of Component. 40 | * 41 | * @todo Throw instead of returning false in case of error? 42 | */ 43 | template 44 | class ComponentStore : public IComponentStore { 45 | static_assert(std::is_base_of::value, "C must derived from the Component struct"); 46 | static_assert(C::_mType != _invalidComponentType, "C must define a valid non-zero _mType"); 47 | 48 | public: 49 | /// Constructor. 50 | ComponentStore() { 51 | } 52 | /// Destructor. 53 | ~ComponentStore() { 54 | } 55 | 56 | /** 57 | * @brief Add (move) a Component (of the same type as the ComponentStore) associated to an Entity. 58 | * 59 | * Move a new Component into the Store, associating it to its Entity. 60 | * Using 'rvalue' (using the move semantic of C++11) requires: 61 | * - calling add() with 'std::move(component)', for instance; 62 | * store.add(entity1, ComponentTest1(123); 63 | * - calling add() with a new temporary 'ComponentXxx(args)', for instance; 64 | * ComponentTest1 component1(123); 65 | * store.add(entity1, std::move(component1)); 66 | * 67 | * @param[in] aEntity Id of the Entity with the Component to add. 68 | * @param[in] aComponent 'rvalue' to a new Component (of the store type) to add. 69 | * 70 | * @return true if insertion succeeded 71 | * 72 | * @todo Throw in case of failure! 73 | */ 74 | inline bool add(const Entity aEntity, C&& aComponent) { 75 | return mStore.insert(std::make_pair(aEntity, std::move(aComponent))).second; 76 | } 77 | 78 | /** 79 | * @brief Remove (destroy) the specified Component associated to an Entity. 80 | * 81 | * @param[in] aEntity Id of the Entity to remove. 82 | * 83 | * @return true if finding and removing the Entity succeeded. 84 | */ 85 | inline bool remove(Entity aEntity) { 86 | return (0 < mStore.erase(aEntity)); 87 | } 88 | 89 | /** 90 | * @brief Test if the store contains a Component for the specified Entity. 91 | * 92 | * @param[in] aEntity Id of the Entity to find. 93 | * 94 | * @return true if finding the Entity and its associated Component succeeded. 95 | */ 96 | inline bool has(Entity aEntity) const { 97 | return (mStore.end() != mStore.find(aEntity)); 98 | } 99 | 100 | /** 101 | * @brief Get access to the Component associated with the specified Entity. 102 | * 103 | * Throws std::out_of_range exception if the Entity and its associated Component is not found. 104 | * 105 | * @param[in] aEntity Id of the Entity to find. 106 | * 107 | * @return Reference to the Component associated with the specified Entity (or throws). 108 | */ 109 | inline C& get(Entity aEntity) { 110 | return mStore.at(aEntity); 111 | } 112 | 113 | /** 114 | * @brief Extract (move out) the Component associated with the specified Entity. 115 | * 116 | * Throws std::out_of_range exception if the Entity and its associated Component is not found. 117 | * 118 | * @param[in] aEntity Id of the Entity to find. 119 | * 120 | * @return The Component associated with the specified Entity (or throw). 121 | */ 122 | inline C extract(Entity aEntity) { 123 | C component = std::move(mStore.at(aEntity)); 124 | mStore.erase(aEntity); 125 | return component; 126 | } 127 | 128 | /** 129 | * @brief Get access to the underlying Component map. 130 | * 131 | * @return Reference to the underlying Component map. 132 | */ 133 | inline const std::unordered_map& getComponents() { 134 | return mStore; 135 | } 136 | 137 | private: 138 | std::unordered_map mStore; ///< Hash map of stored Components 139 | static const ComponentType _mType = C::_mType; ///< Type of stored Components 140 | }; 141 | 142 | } // namespace ecs 143 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # Main CMake file for compiling the library itself, examples and tests. 2 | # 3 | # Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 4 | # 5 | # Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 6 | # or copy at http://opensource.org/licenses/MIT) 7 | 8 | cmake_minimum_required(VERSION 2.6) 9 | project(ecs) 10 | 11 | # Define useful variables to handle OS differences: 12 | if (WIN32) 13 | set(DEV_NULL "NUL") 14 | else (WIN32) 15 | set(DEV_NULL "/dev/null") 16 | endif (WIN32) 17 | # then Compiler/IDE differences: 18 | if (MSVC) 19 | set(CPPLINT_ARG_OUTPUT "--output=vs7") 20 | set(CPPCHECK_ARG_TEMPLATE "--template=vs") 21 | # disable Visual Studio warnings for fopen() used in the example 22 | add_definitions(-D_CRT_SECURE_NO_WARNINGS) 23 | else (MSVC) 24 | set(CPPLINT_ARG_OUTPUT "--output=eclipse") 25 | set(CPPCHECK_ARG_TEMPLATE "--template=gcc") 26 | if (CMAKE_COMPILER_IS_GNUCXX) 27 | # GCC flags 28 | add_definitions(-rdynamic -fstack-protector-all -Wall -Wextra -pedantic -Wformat-security -Winit-self -Wswitch-default -Wswitch-enum -Wfloat-equal -Wshadow -Wcast-qual -Wconversion -Wlogical-op -Winline -Wsuggest-attribute=pure -Wsuggest-attribute=const) 29 | elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") 30 | # Clang flags 31 | add_definitions(-fstack-protector-all -Wall -Wextra -pedantic -Wformat-security -Winit-self -Wswitch-default -Wswitch-enum -Wfloat-equal -Wshadow -Wcast-qual -Wconversion -Winline) 32 | endif (CMAKE_COMPILER_IS_GNUCXX) 33 | message(STATUS "C++11 activated") 34 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x") # -std=c++11 35 | endif (MSVC) 36 | # and then common variables 37 | set(CPPLINT_ARG_VERBOSE "--verbose=3") 38 | set(CPPLINT_ARG_LINELENGTH "--linelength=120") 39 | 40 | 41 | ## Core source code ## 42 | 43 | # adding a new file require explicittly modifing the CMakeLists.txt 44 | # so that CMake knows that it should rebuild the project (it is best practice) 45 | 46 | # list of sources files of the library 47 | set(ECS_SRC 48 | ${PROJECT_SOURCE_DIR}/src/Manager.cpp 49 | ${PROJECT_SOURCE_DIR}/src/System.cpp 50 | ) 51 | source_group(src FILES ${ECS_SRC}) 52 | 53 | # list of header files 54 | set(ECS_INC 55 | ${PROJECT_SOURCE_DIR}/include/ecs/Component.h 56 | ${PROJECT_SOURCE_DIR}/include/ecs/ComponentType.h 57 | ${PROJECT_SOURCE_DIR}/include/ecs/ComponentStore.h 58 | ${PROJECT_SOURCE_DIR}/include/ecs/Entity.h 59 | ${PROJECT_SOURCE_DIR}/include/ecs/Manager.h 60 | ${PROJECT_SOURCE_DIR}/include/ecs/System.h 61 | ) 62 | source_group(include FILES ${ECS_INC}) 63 | 64 | # list of test files of the library 65 | set(ECS_TESTS 66 | ${PROJECT_SOURCE_DIR}/tests/Manager_test.cpp 67 | ${PROJECT_SOURCE_DIR}/tests/ComponentStore_test.cpp 68 | ${PROJECT_SOURCE_DIR}/tests/System_test.cpp 69 | ) 70 | source_group(tests FILES ${ECS_TESTS}) 71 | 72 | # list of example files of the library 73 | set(ECS_EXAMPLES 74 | ${PROJECT_SOURCE_DIR}/examples/basic/basic.cpp 75 | ) 76 | source_group(basic FILES ${ECS_EXAMPLES}) 77 | 78 | # list of doc files of the library 79 | set(ECS_DOC 80 | README.md 81 | LICENSE.txt 82 | ecs.dox 83 | ) 84 | source_group(doc FILES ${ECS_DOC}) 85 | 86 | # All includes are relative to the "include" directory 87 | include_directories("${PROJECT_SOURCE_DIR}/include") 88 | 89 | # add sources of the library as a "ecs" static library 90 | add_library(ecs ${ECS_SRC} ${ECS_INC} ${ECS_DOC}) 91 | 92 | # Position Independant Code for shared librarie 93 | if(UNIX AND (CMAKE_COMPILER_IS_GNUCXX OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")) 94 | set_target_properties(ecs PROPERTIES COMPILE_FLAGS "-fPIC") 95 | endif(UNIX AND (CMAKE_COMPILER_IS_GNUCXX OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")) 96 | 97 | 98 | # Optional additional targets: 99 | 100 | option(ECS_RUN_CPPLINT "Run cpplint.py tool for Google C++ StyleGuide." ON) 101 | if (ECS_RUN_CPPLINT) 102 | # add a cpplint target to the "all" target 103 | add_custom_target(ecs_cpplint 104 | ALL 105 | COMMAND python ${PROJECT_SOURCE_DIR}/cpplint.py ${CPPLINT_ARG_OUTPUT} ${CPPLINT_ARG_VERBOSE} ${CPPLINT_ARG_LINELENGTH} ${ECS_SRC} ${ECS_INC} ${ECS_TESTS} 106 | ) 107 | else (ECS_RUN_CPPLINT) 108 | message(STATUS "ECS_RUN_CPPLINT OFF") 109 | endif (ECS_RUN_CPPLINT) 110 | 111 | option(ECS_RUN_CPPCHECK "Run cppcheck C++ static analysis tool." ON) 112 | if (ECS_RUN_CPPCHECK) 113 | # add a cppcheck target to the "all" target 114 | add_custom_target(ecs_cppcheck 115 | ALL 116 | COMMAND cppcheck -j 4 cppcheck --enable=style --quiet ${CPPCHECK_ARG_TEMPLATE} ${PROJECT_SOURCE_DIR}/src 117 | ) 118 | else (ECS_RUN_CPPCHECK) 119 | message(STATUS "ECS_RUN_CPPCHECK OFF") 120 | endif (ECS_RUN_CPPCHECK) 121 | 122 | option(ECS_RUN_DOXYGEN "Run Doxygen C++ documentation tool." ON) 123 | if (ECS_RUN_DOXYGEN) 124 | find_package(Doxygen) 125 | if (DOXYGEN_FOUND) 126 | # add a Doxygen target to the "all" target 127 | add_custom_target(ecs_doxygen 128 | ALL 129 | COMMAND doxygen Doxyfile > ${DEV_NULL} 130 | WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} 131 | ) 132 | else(DOXYGEN_FOUND) 133 | message(STATUS "Doxygen not found") 134 | endif(DOXYGEN_FOUND) 135 | else(ECS_RUN_DOXYGEN) 136 | message(STATUS "ECS_RUN_DOXYGEN OFF") 137 | endif(ECS_RUN_DOXYGEN) 138 | 139 | option(ECS_BUILD_EXAMPLES "Build examples." ON) 140 | if (ECS_BUILD_EXAMPLES) 141 | # add the basic example executable 142 | add_executable(ecs_example_basic ${ECS_EXAMPLES}) 143 | target_link_libraries(ecs_example_basic gtest_main ecs) 144 | else(ECS_BUILD_EXAMPLES) 145 | message(STATUS "ECS_BUILD_EXAMPLES OFF") 146 | endif(ECS_BUILD_EXAMPLES) 147 | 148 | option(ECS_BUILD_TESTS "Build and run tests." ON) 149 | if (ECS_BUILD_TESTS) 150 | if (MSVC) 151 | # Specific flags for gtest lib 152 | set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /MT") 153 | set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /MTd") 154 | endif (MSVC) 155 | 156 | # add the subdirectory containing the CMakeLists.txt for the gtest library 157 | add_subdirectory(googletest) 158 | include_directories("${PROJECT_SOURCE_DIR}/googletest/include") 159 | 160 | # add the unit test executable 161 | add_executable(ecs_tests ${ECS_TESTS}) 162 | target_link_libraries(ecs_tests gtest_main ecs) 163 | 164 | # add a "test" target: 165 | enable_testing() 166 | 167 | # does the tests pass? 168 | add_test(UnitTests ecs_tests) 169 | 170 | if (ECS_BUILD_EXAMPLES) 171 | # does the example runs successfully? 172 | add_test(BasicExample ecs_example_basic) 173 | endif(ECS_BUILD_EXAMPLES) 174 | else(ECS_BUILD_TESTS) 175 | message(STATUS "ECS_BUILD_TESTS OFF") 176 | endif(ECS_BUILD_TESTS) 177 | 178 | -------------------------------------------------------------------------------- /include/ecs/Manager.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @file Manager.h 3 | * @ingroup ecs 4 | * @brief Manage associations of ecs::Entity, ecs::Component and ecs::System. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | #pragma once 12 | 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include // std::shared_ptr 24 | #include 25 | #include 26 | #include 27 | 28 | /** 29 | * @brief A simple C++11 Entity-Component-System library. 30 | * @ingroup ecs 31 | */ 32 | namespace ecs { 33 | 34 | /** 35 | * @brief Manage associations of Entity, Component and System. 36 | * @ingroup ecs 37 | * 38 | * @todo Map ComponentStore by value, not by pointer. 39 | * @todo Add a Manager::unregisterEntity() method. 40 | * @todo Add a Manager::destroyEntity() method. 41 | * @todo Add a Manager::extractComponent() method. 42 | * @todo Wrap createEntity() -> addComponent() -> registerEntity() methods into a Transaction. 43 | * @todo Throw instead of returning false in case of error? 44 | */ 45 | class Manager { 46 | public: 47 | /// Constructor 48 | Manager(); 49 | /// Destructor 50 | virtual ~Manager(); 51 | 52 | /** 53 | * @brief Create a ComponentStore for a certain type of Component. 54 | * @ingroup ecs 55 | * 56 | * @tparam C A structure derived from Component, of a certain type of Component. 57 | */ 58 | template 59 | inline bool createComponentStore() { 60 | static_assert(std::is_base_of::value, "C must derived from the Component struct"); 61 | static_assert(C::_mType != _invalidComponentType, "C must define a valid non-zero _mType"); 62 | return mComponentStores.insert(std::make_pair(C::_mType, IComponentStore::Ptr(new ComponentStore()))).second; 63 | } 64 | 65 | /** 66 | * @brief Get (access to) the ComponentStore of a certain type of Component. 67 | * @ingroup ecs 68 | * 69 | * Throws std::runtime_error if the ComponentStore does not exist. 70 | * 71 | * @tparam C A structure derived from Component, of a certain type of Component. 72 | * 73 | * @return Reference to the ComponentStore of the specified type (or throws). 74 | */ 75 | template 76 | inline ComponentStore& getComponentStore() { 77 | static_assert(std::is_base_of::value, "C must derived from the Component struct"); 78 | static_assert(C::_mType != _invalidComponentType, "C must define a valid non-zero _mType"); 79 | auto iComponentStore = mComponentStores.find(C::_mType); 80 | if (mComponentStores.end() == iComponentStore) { 81 | throw std::runtime_error("The ComponentStore does not exist"); 82 | } 83 | return reinterpret_cast&>(*(iComponentStore->second)); 84 | } 85 | 86 | /** 87 | * @brief Add a System. 88 | * 89 | * Require a shared pointer (instead of a unique_ptr) to a System to be able to handle multiple entries 90 | * into the vector of managed Systems (for multi-execution of a same System). 91 | * 92 | * @param[in] aSystemPtr Shared pointer to the System to add. 93 | */ 94 | void addSystem(const System::Ptr& aSystemPtr); 95 | 96 | /** 97 | * @brief Create a new Entity - simply allocate an new Id. 98 | * 99 | * @return Id of the new Entity. 100 | */ 101 | inline Entity createEntity() { 102 | assert(mLastEntity < std::numeric_limits::max()); 103 | mEntities.insert(std::make_pair((mLastEntity + 1), ComponentTypeSet())); // can trow std::bad_alloc 104 | return (++mLastEntity); 105 | } 106 | 107 | /** 108 | * @brief Add (move) a Component (of the same type as the ComponentStore) associated to an Entity. 109 | * 110 | * Throws std::runtime_error if the Entity does not exist. 111 | * Throws std::runtime_error if the ComponentStore does not exist. 112 | * 113 | * Move a new Component into the Store, associating it to its Entity. 114 | * Using 'rvalue' (using the move semantic of C++11) requires: 115 | * - calling add() with 'std::move(component)', for instance; 116 | * store.add(entity1, ComponentTest1(123); 117 | * - calling add() with a new temporary 'ComponentXxx(args)', for instance; 118 | * ComponentTest1 component1(123); 119 | * store.add(entity1, std::move(component1)); 120 | * 121 | * @tparam C A structure derived from Component, of a certain type of Component. 122 | * 123 | * @param[in] aEntity Id of the Entity with the Component to add. 124 | * @param[in] aComponent 'rvalue' to a new Component (of the store type) to add. 125 | * 126 | * @return true if insertion succeeded 127 | */ 128 | template 129 | inline bool addComponent(const Entity aEntity, C&& aComponent) { 130 | static_assert(std::is_base_of::value, "C must derived from the Component struct"); 131 | static_assert(C::_mType != _invalidComponentType, "C must define a valid non-zero _mType"); 132 | // Access corresponding Entity 133 | auto entity = mEntities.find(aEntity); 134 | if (mEntities.end() == entity) { 135 | throw std::runtime_error("The Entity does not exist"); 136 | } 137 | // Add the ComponentType to the Entity 138 | (*entity).second.insert(C::_mType); 139 | // Add the Component to the corresponding Store 140 | return getComponentStore().add(aEntity, std::move(aComponent)); 141 | } 142 | 143 | /** 144 | * @brief Register an Entity to all matching Systems. 145 | * 146 | * Systems needed to be added to the manager before registering any Entity. 147 | * Components need to be added to the Entity before registering the Entity. 148 | * 149 | * @param[in] aEntity Id of the Entity to register. 150 | * 151 | * @return Number of Systems associated to the Entity. 152 | */ 153 | size_t registerEntity(const Entity aEntity); 154 | 155 | /** 156 | * @brief Unregister an Entity from all matching Systems. 157 | * 158 | * @param[in] aEntity Id of the Entity to register. 159 | * 160 | * @return Number of Systems unassociated with the Entity. 161 | */ 162 | size_t unregisterEntity(const Entity aEntity); 163 | 164 | /** 165 | * @brief Update all Entities of all Systems. 166 | * 167 | * @param[in] abElapsedTime Elapsed time since last update call, in seconds. 168 | * 169 | * @return Number update of Entities (an Entity can be updated multiple time by multiple Systems). 170 | */ 171 | size_t updateEntities(float abElapsedTime); 172 | 173 | private: 174 | /// Id of the last created Entity (start with invalid Id 0). 175 | Entity mLastEntity; 176 | 177 | /** 178 | * @brief Hashmap of all registered entities, listing the Type of their Components. 179 | * 180 | * This only associates the Id of each Entity with Types of all it Components. 181 | * Using a hashmap, since the number of Entities can be very high. 182 | */ 183 | std::unordered_map mEntities; 184 | 185 | /** 186 | * @brief Map of all Components by type and Entity. 187 | * 188 | * Store all Components of each Entity, by ComponentType. 189 | * Using a standard map, since the number of ComponentType does not usually grow very high. 190 | * 191 | * @todo Map ComponentStore by value, not by pointer. 192 | */ 193 | std::map mComponentStores; 194 | 195 | /** 196 | * @brief List of all Systems, ordered by insertion (first created, first executed). 197 | * 198 | * If a pointer to a System is inserted twice, it is executed twice in each iteration (in the order of insertion). 199 | */ 200 | std::vector mSystems; 201 | }; 202 | 203 | } // namespace ecs 204 | -------------------------------------------------------------------------------- /examples/basic/basic.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * @file basic.cpp 3 | * @ingroup ecs_basic_example 4 | * @brief Basic example of the Entity-Component-System manager. 5 | * 6 | * Basic example moving balls with simple collision detection. 7 | * 8 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 9 | * 10 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 11 | * or copy at http://opensource.org/licenses/MIT) 12 | */ 13 | 14 | #include 15 | #include 16 | #include 17 | 18 | #include 19 | 20 | #include // srand, rand 21 | 22 | // Component to store a 2d position 23 | struct Position : public ecs::Component { 24 | static const ecs::ComponentType _mType; 25 | 26 | float x; // x coordinates in meters 27 | float y; // y coordinates in meters 28 | 29 | // Initialize coordinates 30 | Position(float aX, float aY) : x(aX), y(aY) { 31 | } 32 | }; 33 | 34 | // Component to store a 2d speed 35 | struct Speed : public ecs::Component { 36 | static const ecs::ComponentType _mType; 37 | 38 | float vx; // speed along x coordinates in m/s 39 | float vy; // speed along y coordinates in m/s 40 | 41 | // Initialize speed coordinates 42 | Speed(float aX, float aY) : vx(aX), vy(aY) { 43 | } 44 | }; 45 | 46 | // Component to detect collisions 47 | struct Collidable : public ecs::Component { 48 | static const ecs::ComponentType _mType; 49 | 50 | float radius; 51 | 52 | // Initialize radius 53 | Collidable(float aRadius) : radius(aRadius) { 54 | } 55 | }; 56 | 57 | // Component to detect restrict the play area 58 | struct Area : public ecs::Component { 59 | static const ecs::ComponentType _mType; 60 | 61 | float left; 62 | float right; 63 | float top; 64 | float bottom; 65 | 66 | // Initialize area 67 | Area(float aLeft, float aRight, float aTop, float aDown) : 68 | left(aLeft), right(aRight), top(aTop), bottom(aDown) { 69 | } 70 | }; 71 | 72 | const ecs::ComponentType Position::_mType = 1; 73 | const ecs::ComponentType Speed::_mType = 2; 74 | const ecs::ComponentType Collidable::_mType = 3; 75 | const ecs::ComponentType Area::_mType = 4; 76 | 77 | 78 | // A System to update Position with Speed data 79 | class SystemMove : public ecs::System { 80 | public: 81 | SystemMove(ecs::Manager& aManager) : 82 | ecs::System(aManager) { 83 | ecs::ComponentTypeSet requiredComponents; 84 | requiredComponents.insert(Position::_mType); 85 | requiredComponents.insert(Speed::_mType); 86 | setRequiredComponents(std::move(requiredComponents)); 87 | } 88 | 89 | // Update Position with Speed data and elapsed time 90 | virtual void updateEntity(float aElapsedTime, ecs::Entity aEntity) { 91 | const Speed& speed = mManager.getComponentStore().get(aEntity); 92 | Position& position = mManager.getComponentStore().get(aEntity); 93 | 94 | position.x += (speed.vx) * aElapsedTime; 95 | position.y += (speed.vy) * aElapsedTime; 96 | } 97 | }; 98 | 99 | // A System to update Speed and Position with collision detection 100 | class SystemCollide : public ecs::System { 101 | public: 102 | SystemCollide(ecs::Manager& aManager) : 103 | ecs::System(aManager) { 104 | ecs::ComponentTypeSet requiredComponents; 105 | requiredComponents.insert(Position::_mType); 106 | requiredComponents.insert(Speed::_mType); 107 | requiredComponents.insert(Collidable::_mType); 108 | setRequiredComponents(std::move(requiredComponents)); 109 | } 110 | 111 | // Update Speed with collision detection 112 | virtual void updateEntity(float aElapsedTime, ecs::Entity aEntity) { 113 | Speed& speed = mManager.getComponentStore().get(aEntity); 114 | Position& position = mManager.getComponentStore().get(aEntity); 115 | const Collidable& collidable = mManager.getComponentStore().get(aEntity); 116 | 117 | // Detect collisions with limits of the Area 118 | const Area& area = mManager.getComponentStore().getComponents().begin()->second; 119 | if (position.x >= area.right) { 120 | position.x -= (position.x - area.right); 121 | speed.vx = -speed.vx; 122 | std::cout << "Entity #" << aEntity << " Collision(right): (" << position.x << ", " << position.y << ")\n"; 123 | } else if (position.x <= area.left) { 124 | position.x += (area.left - position.x); 125 | speed.vx = -speed.vx; 126 | std::cout << "Entity #" << aEntity << " Collision(left): (" << position.x << ", " << position.y << ")\n"; 127 | } 128 | if (position.y >= area.top) { 129 | position.y -= (position.y - area.top); 130 | speed.vy = -speed.vy; 131 | std::cout << "Entity #" << aEntity << " Collision(top): (" << position.x << ", " << position.y << ")\n"; 132 | } else if (position.y <= area.bottom) { 133 | position.y += (area.bottom - position.y); 134 | speed.vy = -speed.vy; 135 | std::cout << "Entity #" << aEntity << " Collision(bottom): (" << position.x << ", " << position.y << ")\n"; 136 | } 137 | 138 | // TODO Detect collision with other entities 139 | } 140 | }; 141 | 142 | // A System to "draw" (print) the Entity 143 | class SystemDraw : public ecs::System { 144 | public: 145 | SystemDraw(ecs::Manager& aManager) : 146 | ecs::System(aManager) { 147 | ecs::ComponentTypeSet requiredComponents; 148 | requiredComponents.insert(Position::_mType); 149 | setRequiredComponents(std::move(requiredComponents)); 150 | } 151 | 152 | // "Draw" (print) the Entity 153 | virtual void updateEntity(float aElapsedTime, ecs::Entity aEntity) { 154 | const Position& position = mManager.getComponentStore().get(aEntity); 155 | std::cout << "Entity #" << aEntity << " (" << position.x << ", " << position.y << ")\n"; 156 | } 157 | }; 158 | 159 | 160 | /** 161 | * Basic example moving balls with simple collision detection. 162 | */ 163 | int main() { 164 | bool bRet = true; 165 | ecs::Manager manager; 166 | 167 | // NOTE : for testing purpose only: 168 | std::cout << "sizeof(manager)=" << sizeof(manager) << std::endl; 169 | std::cout << "sizeof(Position)=" << sizeof(Position) << std::endl; 170 | std::cout << "sizeof(Speed)=" << sizeof(Speed) << std::endl; 171 | std::cout << "sizeof(Collidable)=" << sizeof(Collidable) << std::endl; 172 | std::cout << "sizeof(Area)=" << sizeof(Area) << std::endl; 173 | 174 | // Create all ComponentStore 175 | bRet &= manager.createComponentStore(); 176 | bRet &= manager.createComponentStore(); 177 | bRet &= manager.createComponentStore(); 178 | bRet &= manager.createComponentStore(); 179 | 180 | std::cout << "sizeof(storePosition)=" << sizeof(manager.getComponentStore()) << std::endl; 181 | std::cout << "sizeof(storeSpeed)=" << sizeof(manager.getComponentStore()) << std::endl; 182 | std::cout << "sizeof(storeCollidable)=" << sizeof(manager.getComponentStore()) << std::endl; 183 | std::cout << "sizeof(storeArea)=" << sizeof(manager.getComponentStore()) << std::endl; 184 | 185 | // Create the Systems 186 | manager.addSystem(ecs::System::Ptr(new SystemMove(manager))); 187 | manager.addSystem(ecs::System::Ptr(new SystemCollide(manager))); 188 | manager.addSystem(ecs::System::Ptr(new SystemDraw(manager))); 189 | 190 | // Create an Area Entity 191 | ecs::Entity area = manager.createEntity(); 192 | bRet &= manager.addComponent(area, Area(-1.0f, 1.0f, 1.0f, -1.0f)); 193 | manager.registerEntity(area); 194 | 195 | // Create a few Entities 196 | size_t nbRegistered = 0; 197 | for (size_t i = 0; i < 2; ++i) { 198 | // Create an Entity, with its Components, and register it to appropriate Systems 199 | ecs::Entity ball = manager.createEntity(); 200 | bRet &= manager.addComponent(ball, Position(0.0f, 0.0f)); // spawn at origin 201 | bRet &= manager.addComponent(ball, Speed(10.0f*(rand()-RAND_MAX/2)/RAND_MAX, 202 | 10.0f*(rand()-RAND_MAX/2)/RAND_MAX)); 203 | bRet &= manager.addComponent(ball, Collidable(0.05f)); // 10cm wide ball 204 | nbRegistered += manager.registerEntity(ball); 205 | } 206 | std::cout << "Created " << nbRegistered << " Entities\n"; 207 | 208 | // Update them a few time, emulating a 30fps update 209 | size_t nbUpdated = 0; 210 | for (size_t i = 0; i < 20; ++i) { 211 | nbUpdated += manager.updateEntities(0.032f); // 32ms (30fps) 212 | } 213 | std::cout << "Updated them " << nbUpdated << " time\n"; 214 | 215 | std::cout << "Done (ret=" << bRet << ")\n"; 216 | return (bRet?0:1); 217 | } 218 | -------------------------------------------------------------------------------- /tests/Manager_test.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * @file Manager_test.cpp 3 | * @ingroup ecs_test 4 | * @brief Test of the Entity-Component-System manager. 5 | * 6 | * Copyright (c) 2014 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | 12 | #include 13 | 14 | #include "../src/Utils.h" // defines the "override" identifier if needed (gcc < 4.7) 15 | 16 | #include 17 | 18 | // A Test Component 19 | struct ComponentTest1a : public ecs::Component { 20 | static const ecs::ComponentType _mType; 21 | 22 | explicit ComponentTest1a(float aInitValue = 0.0f) : mValue(aInitValue) { 23 | } 24 | 25 | float mValue; 26 | }; 27 | const ecs::ComponentType ComponentTest1a::_mType = 1; 28 | // Erroneous component (same type as Test1a) 29 | struct ComponentTest1b : public ecs::Component { 30 | static const ecs::ComponentType _mType; 31 | }; 32 | const ecs::ComponentType ComponentTest1b::_mType = 1; // this is an error 33 | // A second Component 34 | struct ComponentTest2 : public ecs::Component { 35 | static const ecs::ComponentType _mType; 36 | 37 | ComponentTest2(float aInitValue1 = 0.0f, float aInitValue2 = 0.0f) : mValue1(aInitValue1), mValue2(aInitValue2) { 38 | } 39 | 40 | float mValue1; 41 | float mValue2; 42 | }; 43 | const ecs::ComponentType ComponentTest2::_mType = 2; 44 | // A third Component 45 | struct ComponentTest3 : public ecs::Component { 46 | static const ecs::ComponentType _mType; 47 | }; 48 | const ecs::ComponentType ComponentTest3::_mType = 3; 49 | 50 | 51 | // A test System, requiring ComponentTest1a 52 | class SystemTest1 : public ecs::System { 53 | public: 54 | explicit SystemTest1(ecs::Manager& aManager) : 55 | ecs::System(aManager) { 56 | ecs::ComponentTypeSet requiredComponents; 57 | requiredComponents.insert(ComponentTest1a::_mType); 58 | setRequiredComponents(std::move(requiredComponents)); 59 | } 60 | 61 | // Update function - for a given matching Entity - specialized. 62 | virtual void updateEntity(float aElapsedTime, ecs::Entity aEntity) override { 63 | mManager.getComponentStore().get(aEntity).mValue += aElapsedTime; 64 | } 65 | }; 66 | 67 | 68 | // A test System, requiring ComponentTest1a and ComponentTest2 69 | class SystemTest2 : public ecs::System { 70 | public: 71 | explicit SystemTest2(ecs::Manager& aManager) : 72 | ecs::System(aManager) { 73 | ecs::ComponentTypeSet requiredComponents; 74 | requiredComponents.insert(ComponentTest1a::_mType); 75 | requiredComponents.insert(ComponentTest2::_mType); 76 | setRequiredComponents(std::move(requiredComponents)); 77 | } 78 | 79 | // Update function - for a given matching Entity - specialized. 80 | virtual void updateEntity(float, ecs::Entity aEntity) override { 81 | float value = mManager.getComponentStore().get(aEntity).mValue; 82 | mManager.getComponentStore().get(aEntity).mValue1 += value; 83 | mManager.getComponentStore().get(aEntity).mValue2 += value; 84 | } 85 | }; 86 | 87 | // Creating entities 88 | TEST(Manager, createEntity) { 89 | ecs::Manager manager; 90 | EXPECT_EQ((ecs::Entity)1, manager.createEntity()); 91 | EXPECT_EQ((ecs::Entity)2, manager.createEntity()); 92 | EXPECT_EQ((ecs::Entity)3, manager.createEntity()); 93 | } 94 | 95 | // Creating Component stores 96 | TEST(Manager, createComponentStore) { 97 | ecs::Manager manager; 98 | EXPECT_TRUE(manager.createComponentStore()); 99 | EXPECT_FALSE(manager.createComponentStore()); 100 | EXPECT_FALSE(manager.createComponentStore()); 101 | EXPECT_TRUE(manager.createComponentStore()); 102 | EXPECT_FALSE(manager.createComponentStore()); 103 | } 104 | 105 | // Finding Component stores 106 | TEST(Manager, getComponentStore) { 107 | ecs::Manager manager; 108 | EXPECT_THROW(manager.getComponentStore(), std::runtime_error); 109 | EXPECT_TRUE(manager.createComponentStore()); 110 | EXPECT_NO_THROW(manager.getComponentStore()); 111 | EXPECT_THROW(manager.getComponentStore(), std::runtime_error); 112 | EXPECT_TRUE(manager.createComponentStore()); 113 | EXPECT_NO_THROW(manager.getComponentStore()); 114 | } 115 | 116 | // Adding Component to stores 117 | TEST(Manager, addComponent) { 118 | ecs::Manager manager; 119 | ecs::Entity entity1 = manager.createEntity(); 120 | EXPECT_THROW(manager.addComponent(entity1, ComponentTest1a()), std::runtime_error); 121 | EXPECT_TRUE(manager.createComponentStore()); 122 | EXPECT_TRUE(manager.addComponent(entity1, ComponentTest1a())); 123 | ecs::Entity entityUnknown = 666; 124 | EXPECT_THROW(manager.addComponent(entityUnknown, ComponentTest1a()), std::runtime_error); 125 | } 126 | 127 | // Registering Entity with Systems 128 | TEST(Manager, registerEntityToSystems) { 129 | ecs::Manager manager; 130 | EXPECT_TRUE(manager.createComponentStore()); 131 | EXPECT_TRUE(manager.createComponentStore()); 132 | 133 | // Register Systems 134 | manager.addSystem(ecs::System::Ptr(new SystemTest1(manager))); 135 | manager.addSystem(ecs::System::Ptr(new SystemTest2(manager))); 136 | 137 | // Register first Entity (matching with System1) 138 | ecs::Entity entity1 = manager.createEntity(); 139 | EXPECT_TRUE(manager.addComponent(entity1, ComponentTest1a())); 140 | EXPECT_EQ(1U, manager.registerEntity(entity1)); 141 | 142 | // Update Systems 143 | EXPECT_EQ(1U, manager.updateEntities(0.016667f)); // 16.667ms 144 | EXPECT_FLOAT_EQ(0.016667f, manager.getComponentStore().get(entity1).mValue); 145 | 146 | 147 | // Register second Entity (matching with System1) 148 | ecs::Entity entity2 = manager.createEntity(); 149 | EXPECT_TRUE(manager.addComponent(entity2, ComponentTest1a())); 150 | EXPECT_EQ(1U, manager.registerEntity(entity2)); 151 | 152 | // Update Systems 153 | EXPECT_EQ(2U, manager.updateEntities(0.016667f)); // 16.667ms 154 | EXPECT_FLOAT_EQ(2*0.016667f, manager.getComponentStore().get(entity1).mValue); 155 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity2).mValue); 156 | 157 | 158 | // Register third Entity (matching with the two System1 & System2) 159 | ecs::Entity entity3 = manager.createEntity(); 160 | EXPECT_TRUE(manager.addComponent(entity3, ComponentTest1a())); 161 | EXPECT_TRUE(manager.addComponent(entity3, ComponentTest2())); 162 | EXPECT_EQ(2U, manager.registerEntity(entity3)); 163 | 164 | // Update Systems 165 | EXPECT_EQ(4U, manager.updateEntities(0.016667f)); // 16.667ms 166 | EXPECT_FLOAT_EQ(3*0.016667f, manager.getComponentStore().get(entity1).mValue); 167 | EXPECT_FLOAT_EQ(2*0.016667f, manager.getComponentStore().get(entity2).mValue); 168 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue); 169 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue1); 170 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue2); 171 | 172 | 173 | // Unregister Entities (updating systems in between, to verfiy unregistrations) 174 | EXPECT_EQ(2U, manager.unregisterEntity(entity3)); 175 | EXPECT_EQ(2U, manager.updateEntities(0.016667f)); // 16.667ms 176 | EXPECT_FLOAT_EQ(4*0.016667f, manager.getComponentStore().get(entity1).mValue); 177 | EXPECT_FLOAT_EQ(3*0.016667f, manager.getComponentStore().get(entity2).mValue); 178 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue); 179 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue1); 180 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue2); 181 | 182 | EXPECT_EQ(1U, manager.unregisterEntity(entity2)); 183 | EXPECT_EQ(1U, manager.updateEntities(0.016667f)); // 16.667ms 184 | EXPECT_FLOAT_EQ(5*0.016667f, manager.getComponentStore().get(entity1).mValue); 185 | EXPECT_FLOAT_EQ(3*0.016667f, manager.getComponentStore().get(entity2).mValue); 186 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue); 187 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue1); 188 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue2); 189 | 190 | EXPECT_EQ(1U, manager.unregisterEntity(entity1)); 191 | EXPECT_EQ(0U, manager.updateEntities(0.016667f)); // 16.667ms 192 | EXPECT_FLOAT_EQ(5*0.016667f, manager.getComponentStore().get(entity1).mValue); 193 | EXPECT_FLOAT_EQ(3*0.016667f, manager.getComponentStore().get(entity2).mValue); 194 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue); 195 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue1); 196 | EXPECT_FLOAT_EQ(1*0.016667f, manager.getComponentStore().get(entity3).mValue2); 197 | } 198 | -------------------------------------------------------------------------------- /Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.3.1 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project 5 | # 6 | # All text after a hash (#) is considered a comment and will be ignored 7 | # The format is: 8 | # TAG = value [value, ...] 9 | # For lists items can also be appended using: 10 | # TAG += value [value, ...] 11 | # Values that contain spaces should be placed between quotes (" ") 12 | 13 | #--------------------------------------------------------------------------- 14 | # Project related configuration options 15 | #--------------------------------------------------------------------------- 16 | 17 | # This tag specifies the encoding used for all characters in the config file 18 | # that follow. The default is UTF-8 which is also the encoding used for all 19 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 20 | # iconv built into libc) for the transcoding. See 21 | # http://www.gnu.org/software/libiconv for the list of possible encodings. 22 | 23 | DOXYFILE_ENCODING = UTF-8 24 | 25 | # The PROJECT_NAME tag is a single word (or sequence of words) that should 26 | # identify the project. Note that if you do not use Doxywizard you need 27 | # to put quotes around the project name if it contains spaces. 28 | 29 | PROJECT_NAME = ecs 30 | 31 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. 32 | # This could be handy for archiving the generated documentation or 33 | # if some version control system is used. 34 | 35 | PROJECT_NUMBER = 0.0.0 36 | 37 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 38 | # for a project that appears at the top of each page and should give viewer 39 | # a quick idea about the purpose of the project. Keep the description short. 40 | 41 | PROJECT_BRIEF = "A simple C++ Entity-Component-System (ECS) library." 42 | 43 | # With the PROJECT_LOGO tag one can specify an logo or icon that is 44 | # included in the documentation. The maximum height of the logo should not 45 | # exceed 55 pixels and the maximum width should not exceed 200 pixels. 46 | # Doxygen will copy the logo to the output directory. 47 | 48 | PROJECT_LOGO = 49 | 50 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 51 | # base path where the generated documentation will be put. 52 | # If a relative path is entered, it will be relative to the location 53 | # where doxygen was started. If left blank the current directory will be used. 54 | 55 | OUTPUT_DIRECTORY = doc 56 | 57 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 58 | # 4096 sub-directories (in 2 levels) under the output directory of each output 59 | # format and will distribute the generated files over these directories. 60 | # Enabling this option can be useful when feeding doxygen a huge amount of 61 | # source files, where putting all generated files in the same directory would 62 | # otherwise cause performance problems for the file system. 63 | 64 | CREATE_SUBDIRS = NO 65 | 66 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 67 | # documentation generated by doxygen is written. Doxygen will use this 68 | # information to generate all constant output in the proper language. 69 | # The default language is English, other supported languages are: 70 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 71 | # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 72 | # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 73 | # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 74 | # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 75 | # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 76 | 77 | OUTPUT_LANGUAGE = English 78 | 79 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 80 | # include brief member descriptions after the members that are listed in 81 | # the file and class documentation (similar to JavaDoc). 82 | # Set to NO to disable this. 83 | 84 | BRIEF_MEMBER_DESC = YES 85 | 86 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 87 | # the brief description of a member or function before the detailed description. 88 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 89 | # brief descriptions will be completely suppressed. 90 | 91 | REPEAT_BRIEF = YES 92 | 93 | # This tag implements a quasi-intelligent brief description abbreviator 94 | # that is used to form the text in various listings. Each string 95 | # in this list, if found as the leading text of the brief description, will be 96 | # stripped from the text and the result after processing the whole list, is 97 | # used as the annotated text. Otherwise, the brief description is used as-is. 98 | # If left blank, the following values are used ("$name" is automatically 99 | # replaced with the name of the entity): "The $name class" "The $name widget" 100 | # "The $name file" "is" "provides" "specifies" "contains" 101 | # "represents" "a" "an" "the" 102 | 103 | ABBREVIATE_BRIEF = "The $name class" \ 104 | "The $name widget" \ 105 | "The $name file" \ 106 | is \ 107 | provides \ 108 | specifies \ 109 | contains \ 110 | represents \ 111 | a \ 112 | an \ 113 | the 114 | 115 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 116 | # Doxygen will generate a detailed section even if there is only a brief 117 | # description. 118 | 119 | ALWAYS_DETAILED_SEC = NO 120 | 121 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 122 | # inherited members of a class in the documentation of that class as if those 123 | # members were ordinary class members. Constructors, destructors and assignment 124 | # operators of the base classes will not be shown. 125 | 126 | INLINE_INHERITED_MEMB = NO 127 | 128 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 129 | # path before files name in the file list and in the header files. If set 130 | # to NO the shortest path that makes the file name unique will be used. 131 | 132 | FULL_PATH_NAMES = YES 133 | 134 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 135 | # can be used to strip a user-defined part of the path. Stripping is 136 | # only done if one of the specified strings matches the left-hand part of 137 | # the path. The tag can be used to show relative paths in the file list. 138 | # If left blank the directory from which doxygen is run is used as the 139 | # path to strip. Note that you specify absolute paths here, but also 140 | # relative paths, which will be relative from the directory where doxygen is 141 | # started. 142 | 143 | STRIP_FROM_PATH = 144 | 145 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 146 | # the path mentioned in the documentation of a class, which tells 147 | # the reader which header file to include in order to use a class. 148 | # If left blank only the name of the header file containing the class 149 | # definition is used. Otherwise one should specify the include paths that 150 | # are normally passed to the compiler using the -I flag. 151 | 152 | STRIP_FROM_INC_PATH = 153 | 154 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 155 | # (but less readable) file names. This can be useful if your file system 156 | # doesn't support long names like on DOS, Mac, or CD-ROM. 157 | 158 | SHORT_NAMES = NO 159 | 160 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 161 | # will interpret the first line (until the first dot) of a JavaDoc-style 162 | # comment as the brief description. If set to NO, the JavaDoc 163 | # comments will behave just like regular Qt-style comments 164 | # (thus requiring an explicit @brief command for a brief description.) 165 | 166 | JAVADOC_AUTOBRIEF = NO 167 | 168 | # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 169 | # interpret the first line (until the first dot) of a Qt-style 170 | # comment as the brief description. If set to NO, the comments 171 | # will behave just like regular Qt-style comments (thus requiring 172 | # an explicit \brief command for a brief description.) 173 | 174 | QT_AUTOBRIEF = NO 175 | 176 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 177 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// 178 | # comments) as a brief description. This used to be the default behaviour. 179 | # The new default is to treat a multi-line C++ comment block as a detailed 180 | # description. Set this tag to YES if you prefer the old behaviour instead. 181 | 182 | MULTILINE_CPP_IS_BRIEF = NO 183 | 184 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 185 | # member inherits the documentation from any documented member that it 186 | # re-implements. 187 | 188 | INHERIT_DOCS = YES 189 | 190 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 191 | # a new page for each member. If set to NO, the documentation of a member will 192 | # be part of the file/class/namespace that contains it. 193 | 194 | SEPARATE_MEMBER_PAGES = NO 195 | 196 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. 197 | # Doxygen uses this value to replace tabs by spaces in code fragments. 198 | 199 | TAB_SIZE = 7 200 | 201 | # This tag can be used to specify a number of aliases that acts 202 | # as commands in the documentation. An alias has the form "name=value". 203 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to 204 | # put the command \sideeffect (or @sideeffect) in the documentation, which 205 | # will result in a user-defined paragraph with heading "Side Effects:". 206 | # You can put \n's in the value part of an alias to insert newlines. 207 | 208 | ALIASES = 209 | 210 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 211 | # A mapping has the form "name=value". For example adding 212 | # "class=itcl::class" will allow you to use the command class in the 213 | # itcl::class meaning. 214 | 215 | TCL_SUBST = 216 | 217 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 218 | # sources only. Doxygen will then generate output that is more tailored for C. 219 | # For instance, some of the names that are used will be different. The list 220 | # of all members will be omitted, etc. 221 | 222 | OPTIMIZE_OUTPUT_FOR_C = NO 223 | 224 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 225 | # sources only. Doxygen will then generate output that is more tailored for 226 | # Java. For instance, namespaces will be presented as packages, qualified 227 | # scopes will look different, etc. 228 | 229 | OPTIMIZE_OUTPUT_JAVA = NO 230 | 231 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 232 | # sources only. Doxygen will then generate output that is more tailored for 233 | # Fortran. 234 | 235 | OPTIMIZE_FOR_FORTRAN = NO 236 | 237 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 238 | # sources. Doxygen will then generate output that is tailored for 239 | # VHDL. 240 | 241 | OPTIMIZE_OUTPUT_VHDL = NO 242 | 243 | # Doxygen selects the parser to use depending on the extension of the files it 244 | # parses. With this tag you can assign which parser to use for a given 245 | # extension. Doxygen has a built-in mapping, but you can override or extend it 246 | # using this tag. The format is ext=language, where ext is a file extension, 247 | # and language is one of the parsers supported by doxygen: IDL, Java, 248 | # Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 249 | # C++. For instance to make doxygen treat .inc files as Fortran files (default 250 | # is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 251 | # that for custom extensions you also need to set FILE_PATTERNS otherwise the 252 | # files are not read by doxygen. 253 | 254 | EXTENSION_MAPPING = 255 | 256 | # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 257 | # comments according to the Markdown format, which allows for more readable 258 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 259 | # The output of markdown processing is further processed by doxygen, so you 260 | # can mix doxygen, HTML, and XML commands with Markdown formatting. 261 | # Disable only in case of backward compatibilities issues. 262 | 263 | MARKDOWN_SUPPORT = YES 264 | 265 | # When enabled doxygen tries to link words that correspond to documented classes, 266 | # or namespaces to their corresponding documentation. Such a link can be 267 | # prevented in individual cases by by putting a % sign in front of the word or 268 | # globally by setting AUTOLINK_SUPPORT to NO. 269 | 270 | AUTOLINK_SUPPORT = YES 271 | 272 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 273 | # to include (a tag file for) the STL sources as input, then you should 274 | # set this tag to YES in order to let doxygen match functions declarations and 275 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 276 | # func(std::string) {}). This also makes the inheritance and collaboration 277 | # diagrams that involve STL classes more complete and accurate. 278 | 279 | BUILTIN_STL_SUPPORT = NO 280 | 281 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 282 | # enable parsing support. 283 | 284 | CPP_CLI_SUPPORT = NO 285 | 286 | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 287 | # Doxygen will parse them like normal C++ but will assume all classes use public 288 | # instead of private inheritance when no explicit protection keyword is present. 289 | 290 | SIP_SUPPORT = NO 291 | 292 | # For Microsoft's IDL there are propget and propput attributes to indicate 293 | # getter and setter methods for a property. Setting this option to YES (the 294 | # default) will make doxygen replace the get and set methods by a property in 295 | # the documentation. This will only work if the methods are indeed getting or 296 | # setting a simple type. If this is not the case, or you want to show the 297 | # methods anyway, you should set this option to NO. 298 | 299 | IDL_PROPERTY_SUPPORT = YES 300 | 301 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 302 | # tag is set to YES, then doxygen will reuse the documentation of the first 303 | # member in the group (if any) for the other members of the group. By default 304 | # all members of a group must be documented explicitly. 305 | 306 | DISTRIBUTE_GROUP_DOC = NO 307 | 308 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 309 | # the same type (for instance a group of public functions) to be put as a 310 | # subgroup of that type (e.g. under the Public Functions section). Set it to 311 | # NO to prevent subgrouping. Alternatively, this can be done per class using 312 | # the \nosubgrouping command. 313 | 314 | SUBGROUPING = YES 315 | 316 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 317 | # unions are shown inside the group in which they are included (e.g. using 318 | # @ingroup) instead of on a separate page (for HTML and Man pages) or 319 | # section (for LaTeX and RTF). 320 | 321 | INLINE_GROUPED_CLASSES = NO 322 | 323 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 324 | # unions with only public data fields will be shown inline in the documentation 325 | # of the scope in which they are defined (i.e. file, namespace, or group 326 | # documentation), provided this scope is documented. If set to NO (the default), 327 | # structs, classes, and unions are shown on a separate page (for HTML and Man 328 | # pages) or section (for LaTeX and RTF). 329 | 330 | INLINE_SIMPLE_STRUCTS = NO 331 | 332 | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 333 | # is documented as struct, union, or enum with the name of the typedef. So 334 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 335 | # with name TypeT. When disabled the typedef will appear as a member of a file, 336 | # namespace, or class. And the struct will be named TypeS. This can typically 337 | # be useful for C code in case the coding convention dictates that all compound 338 | # types are typedef'ed and only the typedef is referenced, never the tag name. 339 | 340 | TYPEDEF_HIDES_STRUCT = NO 341 | 342 | # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 343 | # determine which symbols to keep in memory and which to flush to disk. 344 | # When the cache is full, less often used symbols will be written to disk. 345 | # For small to medium size projects (<1000 input files) the default value is 346 | # probably good enough. For larger projects a too small cache size can cause 347 | # doxygen to be busy swapping symbols to and from disk most of the time 348 | # causing a significant performance penalty. 349 | # If the system has enough physical memory increasing the cache will improve the 350 | # performance by keeping more symbols in memory. Note that the value works on 351 | # a logarithmic scale so increasing the size by one will roughly double the 352 | # memory usage. The cache size is given by this formula: 353 | # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 354 | # corresponding to a cache size of 2^16 = 65536 symbols. 355 | 356 | SYMBOL_CACHE_SIZE = 0 357 | 358 | # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 359 | # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 360 | # their name and scope. Since this can be an expensive process and often the 361 | # same symbol appear multiple times in the code, doxygen keeps a cache of 362 | # pre-resolved symbols. If the cache is too small doxygen will become slower. 363 | # If the cache is too large, memory is wasted. The cache size is given by this 364 | # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 365 | # corresponding to a cache size of 2^16 = 65536 symbols. 366 | 367 | LOOKUP_CACHE_SIZE = 0 368 | 369 | #--------------------------------------------------------------------------- 370 | # Build related configuration options 371 | #--------------------------------------------------------------------------- 372 | 373 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 374 | # documentation are documented, even if no documentation was available. 375 | # Private class members and static file members will be hidden unless 376 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 377 | 378 | EXTRACT_ALL = YES 379 | 380 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 381 | # will be included in the documentation. 382 | 383 | EXTRACT_PRIVATE = NO 384 | 385 | # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 386 | # scope will be included in the documentation. 387 | 388 | EXTRACT_PACKAGE = NO 389 | 390 | # If the EXTRACT_STATIC tag is set to YES all static members of a file 391 | # will be included in the documentation. 392 | 393 | EXTRACT_STATIC = NO 394 | 395 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 396 | # defined locally in source files will be included in the documentation. 397 | # If set to NO only classes defined in header files are included. 398 | 399 | EXTRACT_LOCAL_CLASSES = YES 400 | 401 | # This flag is only useful for Objective-C code. When set to YES local 402 | # methods, which are defined in the implementation section but not in 403 | # the interface are included in the documentation. 404 | # If set to NO (the default) only methods in the interface are included. 405 | 406 | EXTRACT_LOCAL_METHODS = NO 407 | 408 | # If this flag is set to YES, the members of anonymous namespaces will be 409 | # extracted and appear in the documentation as a namespace called 410 | # 'anonymous_namespace{file}', where file will be replaced with the base 411 | # name of the file that contains the anonymous namespace. By default 412 | # anonymous namespaces are hidden. 413 | 414 | EXTRACT_ANON_NSPACES = NO 415 | 416 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 417 | # undocumented members of documented classes, files or namespaces. 418 | # If set to NO (the default) these members will be included in the 419 | # various overviews, but no documentation section is generated. 420 | # This option has no effect if EXTRACT_ALL is enabled. 421 | 422 | HIDE_UNDOC_MEMBERS = NO 423 | 424 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 425 | # undocumented classes that are normally visible in the class hierarchy. 426 | # If set to NO (the default) these classes will be included in the various 427 | # overviews. This option has no effect if EXTRACT_ALL is enabled. 428 | 429 | HIDE_UNDOC_CLASSES = NO 430 | 431 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 432 | # friend (class|struct|union) declarations. 433 | # If set to NO (the default) these declarations will be included in the 434 | # documentation. 435 | 436 | HIDE_FRIEND_COMPOUNDS = NO 437 | 438 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 439 | # documentation blocks found inside the body of a function. 440 | # If set to NO (the default) these blocks will be appended to the 441 | # function's detailed documentation block. 442 | 443 | HIDE_IN_BODY_DOCS = NO 444 | 445 | # The INTERNAL_DOCS tag determines if documentation 446 | # that is typed after a \internal command is included. If the tag is set 447 | # to NO (the default) then the documentation will be excluded. 448 | # Set it to YES to include the internal documentation. 449 | 450 | INTERNAL_DOCS = NO 451 | 452 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 453 | # file names in lower-case letters. If set to YES upper-case letters are also 454 | # allowed. This is useful if you have classes or files whose names only differ 455 | # in case and if your file system supports case sensitive file names. Windows 456 | # and Mac users are advised to set this option to NO. 457 | 458 | CASE_SENSE_NAMES = NO 459 | 460 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 461 | # will show members with their full class and namespace scopes in the 462 | # documentation. If set to YES the scope will be hidden. 463 | 464 | HIDE_SCOPE_NAMES = NO 465 | 466 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 467 | # will put a list of the files that are included by a file in the documentation 468 | # of that file. 469 | 470 | SHOW_INCLUDE_FILES = YES 471 | 472 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 473 | # will list include files with double quotes in the documentation 474 | # rather than with sharp brackets. 475 | 476 | FORCE_LOCAL_INCLUDES = NO 477 | 478 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 479 | # is inserted in the documentation for inline members. 480 | 481 | INLINE_INFO = YES 482 | 483 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 484 | # will sort the (detailed) documentation of file and class members 485 | # alphabetically by member name. If set to NO the members will appear in 486 | # declaration order. 487 | 488 | SORT_MEMBER_DOCS = YES 489 | 490 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 491 | # brief documentation of file, namespace and class members alphabetically 492 | # by member name. If set to NO (the default) the members will appear in 493 | # declaration order. 494 | 495 | SORT_BRIEF_DOCS = NO 496 | 497 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 498 | # will sort the (brief and detailed) documentation of class members so that 499 | # constructors and destructors are listed first. If set to NO (the default) 500 | # the constructors will appear in the respective orders defined by 501 | # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 502 | # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 503 | # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 504 | 505 | SORT_MEMBERS_CTORS_1ST = NO 506 | 507 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 508 | # hierarchy of group names into alphabetical order. If set to NO (the default) 509 | # the group names will appear in their defined order. 510 | 511 | SORT_GROUP_NAMES = NO 512 | 513 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 514 | # sorted by fully-qualified names, including namespaces. If set to 515 | # NO (the default), the class list will be sorted only by class name, 516 | # not including the namespace part. 517 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 518 | # Note: This option applies only to the class list, not to the 519 | # alphabetical list. 520 | 521 | SORT_BY_SCOPE_NAME = NO 522 | 523 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 524 | # do proper type resolution of all parameters of a function it will reject a 525 | # match between the prototype and the implementation of a member function even 526 | # if there is only one candidate or it is obvious which candidate to choose 527 | # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 528 | # will still accept a match between prototype and implementation in such cases. 529 | 530 | STRICT_PROTO_MATCHING = NO 531 | 532 | # The GENERATE_TODOLIST tag can be used to enable (YES) or 533 | # disable (NO) the todo list. This list is created by putting \todo 534 | # commands in the documentation. 535 | 536 | GENERATE_TODOLIST = YES 537 | 538 | # The GENERATE_TESTLIST tag can be used to enable (YES) or 539 | # disable (NO) the test list. This list is created by putting \test 540 | # commands in the documentation. 541 | 542 | GENERATE_TESTLIST = YES 543 | 544 | # The GENERATE_BUGLIST tag can be used to enable (YES) or 545 | # disable (NO) the bug list. This list is created by putting \bug 546 | # commands in the documentation. 547 | 548 | GENERATE_BUGLIST = YES 549 | 550 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 551 | # disable (NO) the deprecated list. This list is created by putting 552 | # \deprecated commands in the documentation. 553 | 554 | GENERATE_DEPRECATEDLIST= YES 555 | 556 | # The ENABLED_SECTIONS tag can be used to enable conditional 557 | # documentation sections, marked by \if section-label ... \endif 558 | # and \cond section-label ... \endcond blocks. 559 | 560 | ENABLED_SECTIONS = 561 | 562 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 563 | # the initial value of a variable or macro consists of for it to appear in 564 | # the documentation. If the initializer consists of more lines than specified 565 | # here it will be hidden. Use a value of 0 to hide initializers completely. 566 | # The appearance of the initializer of individual variables and macros in the 567 | # documentation can be controlled using \showinitializer or \hideinitializer 568 | # command in the documentation regardless of this setting. 569 | 570 | MAX_INITIALIZER_LINES = 30 571 | 572 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 573 | # at the bottom of the documentation of classes and structs. If set to YES the 574 | # list will mention the files that were used to generate the documentation. 575 | 576 | SHOW_USED_FILES = YES 577 | 578 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 579 | # This will remove the Files entry from the Quick Index and from the 580 | # Folder Tree View (if specified). The default is YES. 581 | 582 | SHOW_FILES = YES 583 | 584 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 585 | # Namespaces page. This will remove the Namespaces entry from the Quick Index 586 | # and from the Folder Tree View (if specified). The default is YES. 587 | 588 | SHOW_NAMESPACES = NO 589 | 590 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 591 | # doxygen should invoke to get the current version for each file (typically from 592 | # the version control system). Doxygen will invoke the program by executing (via 593 | # popen()) the command , where is the value of 594 | # the FILE_VERSION_FILTER tag, and is the name of an input file 595 | # provided by doxygen. Whatever the program writes to standard output 596 | # is used as the file version. See the manual for examples. 597 | 598 | FILE_VERSION_FILTER = 599 | 600 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 601 | # by doxygen. The layout file controls the global structure of the generated 602 | # output files in an output format independent way. To create the layout file 603 | # that represents doxygen's defaults, run doxygen with the -l option. 604 | # You can optionally specify a file name after the option, if omitted 605 | # DoxygenLayout.xml will be used as the name of the layout file. 606 | 607 | LAYOUT_FILE = 608 | 609 | # The CITE_BIB_FILES tag can be used to specify one or more bib files 610 | # containing the references data. This must be a list of .bib files. The 611 | # .bib extension is automatically appended if omitted. Using this command 612 | # requires the bibtex tool to be installed. See also 613 | # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 614 | # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 615 | # feature you need bibtex and perl available in the search path. Do not use 616 | # file names with spaces, bibtex cannot handle them. 617 | 618 | CITE_BIB_FILES = 619 | 620 | #--------------------------------------------------------------------------- 621 | # configuration options related to warning and progress messages 622 | #--------------------------------------------------------------------------- 623 | 624 | # The QUIET tag can be used to turn on/off the messages that are generated 625 | # by doxygen. Possible values are YES and NO. If left blank NO is used. 626 | 627 | QUIET = NO 628 | 629 | # The WARNINGS tag can be used to turn on/off the warning messages that are 630 | # generated by doxygen. Possible values are YES and NO. If left blank 631 | # NO is used. 632 | 633 | WARNINGS = YES 634 | 635 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 636 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 637 | # automatically be disabled. 638 | 639 | WARN_IF_UNDOCUMENTED = YES 640 | 641 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 642 | # potential errors in the documentation, such as not documenting some 643 | # parameters in a documented function, or documenting parameters that 644 | # don't exist or using markup commands wrongly. 645 | 646 | WARN_IF_DOC_ERROR = YES 647 | 648 | # The WARN_NO_PARAMDOC option can be enabled to get warnings for 649 | # functions that are documented, but have no documentation for their parameters 650 | # or return value. If set to NO (the default) doxygen will only warn about 651 | # wrong or incomplete parameter documentation, but not about the absence of 652 | # documentation. 653 | 654 | WARN_NO_PARAMDOC = YES 655 | 656 | # The WARN_FORMAT tag determines the format of the warning messages that 657 | # doxygen can produce. The string should contain the $file, $line, and $text 658 | # tags, which will be replaced by the file and line number from which the 659 | # warning originated and the warning text. Optionally the format may contain 660 | # $version, which will be replaced by the version of the file (if it could 661 | # be obtained via FILE_VERSION_FILTER) 662 | 663 | # GCC Format: 664 | #WARN_FORMAT = "$file:$line: $text" 665 | # Visual Studio Format: 666 | WARN_FORMAT = "$file($line): $text" 667 | 668 | # The WARN_LOGFILE tag can be used to specify a file to which warning 669 | # and error messages should be written. If left blank the output is written 670 | # to stderr. 671 | 672 | WARN_LOGFILE = 673 | 674 | #--------------------------------------------------------------------------- 675 | # configuration options related to the input files 676 | #--------------------------------------------------------------------------- 677 | 678 | # The INPUT tag can be used to specify the files and/or directories that contain 679 | # documented source files. You may enter file names like "myfile.cpp" or 680 | # directories like "/usr/src/myproject". Separate the files or directories 681 | # with spaces. 682 | 683 | INPUT = src include ecs.dox 684 | 685 | # This tag can be used to specify the character encoding of the source files 686 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 687 | # also the default input encoding. Doxygen uses libiconv (or the iconv built 688 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 689 | # the list of possible encodings. 690 | 691 | INPUT_ENCODING = UTF-8 692 | 693 | # If the value of the INPUT tag contains directories, you can use the 694 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 695 | # and *.h) to filter out the source-files in the directories. If left 696 | # blank the following patterns are tested: 697 | # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 698 | # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 699 | # *.f90 *.f *.for *.vhd *.vhdl 700 | 701 | FILE_PATTERNS = *.cpp \ 702 | *.h \ 703 | *.dox 704 | 705 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories 706 | # should be searched for input files as well. Possible values are YES and NO. 707 | # If left blank NO is used. 708 | 709 | RECURSIVE = YES 710 | 711 | # The EXCLUDE tag can be used to specify files and/or directories that should be 712 | # excluded from the INPUT source files. This way you can easily exclude a 713 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 714 | # Note that relative paths are relative to the directory from which doxygen is 715 | # run. 716 | 717 | EXCLUDE = 718 | 719 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 720 | # directories that are symbolic links (a Unix file system feature) are excluded 721 | # from the input. 722 | 723 | EXCLUDE_SYMLINKS = NO 724 | 725 | # If the value of the INPUT tag contains directories, you can use the 726 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 727 | # certain files from those directories. Note that the wildcards are matched 728 | # against the file with absolute path, so to exclude all test directories 729 | # for example use the pattern */test/* 730 | 731 | EXCLUDE_PATTERNS = 732 | 733 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 734 | # (namespaces, classes, functions, etc.) that should be excluded from the 735 | # output. The symbol name can be a fully qualified name, a word, or if the 736 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 737 | # AClass::ANamespace, ANamespace::*Test 738 | 739 | EXCLUDE_SYMBOLS = 740 | 741 | # The EXAMPLE_PATH tag can be used to specify one or more files or 742 | # directories that contain example code fragments that are included (see 743 | # the \include command). 744 | 745 | EXAMPLE_PATH = 746 | 747 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 748 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 749 | # and *.h) to filter out the source-files in the directories. If left 750 | # blank all files are included. 751 | 752 | EXAMPLE_PATTERNS = * 753 | 754 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 755 | # searched for input files to be used with the \include or \dontinclude 756 | # commands irrespective of the value of the RECURSIVE tag. 757 | # Possible values are YES and NO. If left blank NO is used. 758 | 759 | EXAMPLE_RECURSIVE = NO 760 | 761 | # The IMAGE_PATH tag can be used to specify one or more files or 762 | # directories that contain image that are included in the documentation (see 763 | # the \image command). 764 | 765 | IMAGE_PATH = 766 | 767 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 768 | # invoke to filter for each input file. Doxygen will invoke the filter program 769 | # by executing (via popen()) the command , where 770 | # is the value of the INPUT_FILTER tag, and is the name of an 771 | # input file. Doxygen will then use the output that the filter program writes 772 | # to standard output. If FILTER_PATTERNS is specified, this tag will be 773 | # ignored. 774 | 775 | INPUT_FILTER = 776 | 777 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 778 | # basis. Doxygen will compare the file name with each pattern and apply the 779 | # filter if there is a match. The filters are a list of the form: 780 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 781 | # info on how filters are used. If FILTER_PATTERNS is empty or if 782 | # non of the patterns match the file name, INPUT_FILTER is applied. 783 | 784 | FILTER_PATTERNS = 785 | 786 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 787 | # INPUT_FILTER) will be used to filter the input files when producing source 788 | # files to browse (i.e. when SOURCE_BROWSER is set to YES). 789 | 790 | FILTER_SOURCE_FILES = NO 791 | 792 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 793 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) 794 | # and it is also possible to disable source filtering for a specific pattern 795 | # using *.ext= (so without naming a filter). This option only has effect when 796 | # FILTER_SOURCE_FILES is enabled. 797 | 798 | FILTER_SOURCE_PATTERNS = 799 | 800 | # If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that 801 | # is part of the input, its contents will be placed on the main page (index.html). 802 | # This can be useful if you have a project on for instance GitHub and want reuse 803 | # the introduction page also for the doxygen output. 804 | 805 | USE_MDFILE_AS_MAINPAGE = 806 | 807 | #--------------------------------------------------------------------------- 808 | # configuration options related to source browsing 809 | #--------------------------------------------------------------------------- 810 | 811 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will 812 | # be generated. Documented entities will be cross-referenced with these sources. 813 | # Note: To get rid of all source code in the generated output, make sure also 814 | # VERBATIM_HEADERS is set to NO. 815 | 816 | SOURCE_BROWSER = YES 817 | 818 | # Setting the INLINE_SOURCES tag to YES will include the body 819 | # of functions and classes directly in the documentation. 820 | 821 | INLINE_SOURCES = NO 822 | 823 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 824 | # doxygen to hide any special comment blocks from generated source code 825 | # fragments. Normal C, C++ and Fortran comments will always remain visible. 826 | 827 | STRIP_CODE_COMMENTS = NO 828 | 829 | # If the REFERENCED_BY_RELATION tag is set to YES 830 | # then for each documented function all documented 831 | # functions referencing it will be listed. 832 | 833 | REFERENCED_BY_RELATION = NO 834 | 835 | # If the REFERENCES_RELATION tag is set to YES 836 | # then for each documented function all documented entities 837 | # called/used by that function will be listed. 838 | 839 | REFERENCES_RELATION = NO 840 | 841 | # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 842 | # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 843 | # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 844 | # link to the source code. Otherwise they will link to the documentation. 845 | 846 | REFERENCES_LINK_SOURCE = YES 847 | 848 | # If the USE_HTAGS tag is set to YES then the references to source code 849 | # will point to the HTML generated by the htags(1) tool instead of doxygen 850 | # built-in source browser. The htags tool is part of GNU's global source 851 | # tagging system (see http://www.gnu.org/software/global/global.html). You 852 | # will need version 4.8.6 or higher. 853 | 854 | USE_HTAGS = NO 855 | 856 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 857 | # will generate a verbatim copy of the header file for each class for 858 | # which an include is specified. Set to NO to disable this. 859 | 860 | VERBATIM_HEADERS = YES 861 | 862 | #--------------------------------------------------------------------------- 863 | # configuration options related to the alphabetical class index 864 | #--------------------------------------------------------------------------- 865 | 866 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 867 | # of all compounds will be generated. Enable this if the project 868 | # contains a lot of classes, structs, unions or interfaces. 869 | 870 | ALPHABETICAL_INDEX = YES 871 | 872 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 873 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 874 | # in which this list will be split (can be a number in the range [1..20]) 875 | 876 | COLS_IN_ALPHA_INDEX = 5 877 | 878 | # In case all classes in a project start with a common prefix, all 879 | # classes will be put under the same header in the alphabetical index. 880 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 881 | # should be ignored while generating the index headers. 882 | 883 | IGNORE_PREFIX = 884 | 885 | #--------------------------------------------------------------------------- 886 | # configuration options related to the HTML output 887 | #--------------------------------------------------------------------------- 888 | 889 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 890 | # generate HTML output. 891 | 892 | GENERATE_HTML = YES 893 | 894 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 895 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 896 | # put in front of it. If left blank `html' will be used as the default path. 897 | 898 | HTML_OUTPUT = html 899 | 900 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 901 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 902 | # doxygen will generate files with .html extension. 903 | 904 | HTML_FILE_EXTENSION = .html 905 | 906 | # The HTML_HEADER tag can be used to specify a personal HTML header for 907 | # each generated HTML page. If it is left blank doxygen will generate a 908 | # standard header. Note that when using a custom header you are responsible 909 | # for the proper inclusion of any scripts and style sheets that doxygen 910 | # needs, which is dependent on the configuration options used. 911 | # It is advised to generate a default header using "doxygen -w html 912 | # header.html footer.html stylesheet.css YourConfigFile" and then modify 913 | # that header. Note that the header is subject to change so you typically 914 | # have to redo this when upgrading to a newer version of doxygen or when 915 | # changing the value of configuration settings such as GENERATE_TREEVIEW! 916 | 917 | HTML_HEADER = 918 | 919 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for 920 | # each generated HTML page. If it is left blank doxygen will generate a 921 | # standard footer. 922 | 923 | HTML_FOOTER = 924 | 925 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 926 | # style sheet that is used by each HTML page. It can be used to 927 | # fine-tune the look of the HTML output. If left blank doxygen will 928 | # generate a default style sheet. Note that it is recommended to use 929 | # HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 930 | # tag will in the future become obsolete. 931 | 932 | HTML_STYLESHEET = 933 | 934 | # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 935 | # user-defined cascading style sheet that is included after the standard 936 | # style sheets created by doxygen. Using this option one can overrule 937 | # certain style aspects. This is preferred over using HTML_STYLESHEET 938 | # since it does not replace the standard style sheet and is therefor more 939 | # robust against future updates. Doxygen will copy the style sheet file to 940 | # the output directory. 941 | 942 | HTML_EXTRA_STYLESHEET = 943 | 944 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 945 | # other source files which should be copied to the HTML output directory. Note 946 | # that these files will be copied to the base HTML output directory. Use the 947 | # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 948 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that 949 | # the files will be copied as-is; there are no commands or markers available. 950 | 951 | HTML_EXTRA_FILES = 952 | 953 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 954 | # Doxygen will adjust the colors in the style sheet and background images 955 | # according to this color. Hue is specified as an angle on a colorwheel, 956 | # see http://en.wikipedia.org/wiki/Hue for more information. 957 | # For instance the value 0 represents red, 60 is yellow, 120 is green, 958 | # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 959 | # The allowed range is 0 to 359. 960 | 961 | HTML_COLORSTYLE_HUE = 220 962 | 963 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 964 | # the colors in the HTML output. For a value of 0 the output will use 965 | # grayscales only. A value of 255 will produce the most vivid colors. 966 | 967 | HTML_COLORSTYLE_SAT = 100 968 | 969 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 970 | # the luminance component of the colors in the HTML output. Values below 971 | # 100 gradually make the output lighter, whereas values above 100 make 972 | # the output darker. The value divided by 100 is the actual gamma applied, 973 | # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 974 | # and 100 does not change the gamma. 975 | 976 | HTML_COLORSTYLE_GAMMA = 80 977 | 978 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 979 | # page will contain the date and time when the page was generated. Setting 980 | # this to NO can help when comparing the output of multiple runs. 981 | 982 | HTML_TIMESTAMP = YES 983 | 984 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 985 | # documentation will contain sections that can be hidden and shown after the 986 | # page has loaded. 987 | 988 | HTML_DYNAMIC_SECTIONS = NO 989 | 990 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 991 | # entries shown in the various tree structured indices initially; the user 992 | # can expand and collapse entries dynamically later on. Doxygen will expand 993 | # the tree to such a level that at most the specified number of entries are 994 | # visible (unless a fully collapsed tree already exceeds this amount). 995 | # So setting the number of entries 1 will produce a full collapsed tree by 996 | # default. 0 is a special value representing an infinite number of entries 997 | # and will result in a full expanded tree by default. 998 | 999 | HTML_INDEX_NUM_ENTRIES = 100 1000 | 1001 | # If the GENERATE_DOCSET tag is set to YES, additional index files 1002 | # will be generated that can be used as input for Apple's Xcode 3 1003 | # integrated development environment, introduced with OSX 10.5 (Leopard). 1004 | # To create a documentation set, doxygen will generate a Makefile in the 1005 | # HTML output directory. Running make will produce the docset in that 1006 | # directory and running "make install" will install the docset in 1007 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 1008 | # it at startup. 1009 | # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1010 | # for more information. 1011 | 1012 | GENERATE_DOCSET = NO 1013 | 1014 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 1015 | # feed. A documentation feed provides an umbrella under which multiple 1016 | # documentation sets from a single provider (such as a company or product suite) 1017 | # can be grouped. 1018 | 1019 | DOCSET_FEEDNAME = "Doxygen generated docs" 1020 | 1021 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 1022 | # should uniquely identify the documentation set bundle. This should be a 1023 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 1024 | # will append .docset to the name. 1025 | 1026 | DOCSET_BUNDLE_ID = org.doxygen.Project 1027 | 1028 | # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely 1029 | # identify the documentation publisher. This should be a reverse domain-name 1030 | # style string, e.g. com.mycompany.MyDocSet.documentation. 1031 | 1032 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1033 | 1034 | # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1035 | 1036 | DOCSET_PUBLISHER_NAME = Publisher 1037 | 1038 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files 1039 | # will be generated that can be used as input for tools like the 1040 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 1041 | # of the generated HTML documentation. 1042 | 1043 | GENERATE_HTMLHELP = NO 1044 | 1045 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1046 | # be used to specify the file name of the resulting .chm file. You 1047 | # can add a path in front of the file if the result should not be 1048 | # written to the html output directory. 1049 | 1050 | CHM_FILE = 1051 | 1052 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1053 | # be used to specify the location (absolute path including file name) of 1054 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1055 | # the HTML help compiler on the generated index.hhp. 1056 | 1057 | HHC_LOCATION = 1058 | 1059 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1060 | # controls if a separate .chi index file is generated (YES) or that 1061 | # it should be included in the master .chm file (NO). 1062 | 1063 | GENERATE_CHI = NO 1064 | 1065 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1066 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file 1067 | # content. 1068 | 1069 | CHM_INDEX_ENCODING = 1070 | 1071 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1072 | # controls whether a binary table of contents is generated (YES) or a 1073 | # normal table of contents (NO) in the .chm file. 1074 | 1075 | BINARY_TOC = NO 1076 | 1077 | # The TOC_EXPAND flag can be set to YES to add extra items for group members 1078 | # to the contents of the HTML help documentation and to the tree view. 1079 | 1080 | TOC_EXPAND = NO 1081 | 1082 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1083 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1084 | # that can be used as input for Qt's qhelpgenerator to generate a 1085 | # Qt Compressed Help (.qch) of the generated HTML documentation. 1086 | 1087 | GENERATE_QHP = NO 1088 | 1089 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1090 | # be used to specify the file name of the resulting .qch file. 1091 | # The path specified is relative to the HTML output folder. 1092 | 1093 | QCH_FILE = 1094 | 1095 | # The QHP_NAMESPACE tag specifies the namespace to use when generating 1096 | # Qt Help Project output. For more information please see 1097 | # http://doc.trolltech.com/qthelpproject.html#namespace 1098 | 1099 | QHP_NAMESPACE = org.doxygen.Project 1100 | 1101 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1102 | # Qt Help Project output. For more information please see 1103 | # http://doc.trolltech.com/qthelpproject.html#virtual-folders 1104 | 1105 | QHP_VIRTUAL_FOLDER = doc 1106 | 1107 | # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1108 | # add. For more information please see 1109 | # http://doc.trolltech.com/qthelpproject.html#custom-filters 1110 | 1111 | QHP_CUST_FILTER_NAME = 1112 | 1113 | # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1114 | # custom filter to add. For more information please see 1115 | # 1116 | # Qt Help Project / Custom Filters. 1117 | 1118 | QHP_CUST_FILTER_ATTRS = 1119 | 1120 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1121 | # project's 1122 | # filter section matches. 1123 | # 1124 | # Qt Help Project / Filter Attributes. 1125 | 1126 | QHP_SECT_FILTER_ATTRS = 1127 | 1128 | # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1129 | # be used to specify the location of Qt's qhelpgenerator. 1130 | # If non-empty doxygen will try to run qhelpgenerator on the generated 1131 | # .qhp file. 1132 | 1133 | QHG_LOCATION = 1134 | 1135 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1136 | # will be generated, which together with the HTML files, form an Eclipse help 1137 | # plugin. To install this plugin and make it available under the help contents 1138 | # menu in Eclipse, the contents of the directory containing the HTML and XML 1139 | # files needs to be copied into the plugins directory of eclipse. The name of 1140 | # the directory within the plugins directory should be the same as 1141 | # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1142 | # the help appears. 1143 | 1144 | GENERATE_ECLIPSEHELP = NO 1145 | 1146 | # A unique identifier for the eclipse help plugin. When installing the plugin 1147 | # the directory name containing the HTML and XML files should also have 1148 | # this name. 1149 | 1150 | ECLIPSE_DOC_ID = org.doxygen.Project 1151 | 1152 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1153 | # at top of each HTML page. The value NO (the default) enables the index and 1154 | # the value YES disables it. Since the tabs have the same information as the 1155 | # navigation tree you can set this option to NO if you already set 1156 | # GENERATE_TREEVIEW to YES. 1157 | 1158 | DISABLE_INDEX = NO 1159 | 1160 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1161 | # structure should be generated to display hierarchical information. 1162 | # If the tag value is set to YES, a side panel will be generated 1163 | # containing a tree-like index structure (just like the one that 1164 | # is generated for HTML Help). For this to work a browser that supports 1165 | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1166 | # Windows users are probably better off using the HTML help feature. 1167 | # Since the tree basically has the same information as the tab index you 1168 | # could consider to set DISABLE_INDEX to NO when enabling this option. 1169 | 1170 | GENERATE_TREEVIEW = YES 1171 | 1172 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1173 | # (range [0,1..20]) that doxygen will group on one line in the generated HTML 1174 | # documentation. Note that a value of 0 will completely suppress the enum 1175 | # values from appearing in the overview section. 1176 | 1177 | ENUM_VALUES_PER_LINE = 4 1178 | 1179 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1180 | # used to set the initial width (in pixels) of the frame in which the tree 1181 | # is shown. 1182 | 1183 | TREEVIEW_WIDTH = 250 1184 | 1185 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1186 | # links to external symbols imported via tag files in a separate window. 1187 | 1188 | EXT_LINKS_IN_WINDOW = NO 1189 | 1190 | # Use this tag to change the font size of Latex formulas included 1191 | # as images in the HTML documentation. The default is 10. Note that 1192 | # when you change the font size after a successful doxygen run you need 1193 | # to manually remove any form_*.png images from the HTML output directory 1194 | # to force them to be regenerated. 1195 | 1196 | FORMULA_FONTSIZE = 10 1197 | 1198 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1199 | # generated for formulas are transparent PNGs. Transparent PNGs are 1200 | # not supported properly for IE 6.0, but are supported on all modern browsers. 1201 | # Note that when changing this option you need to delete any form_*.png files 1202 | # in the HTML output before the changes have effect. 1203 | 1204 | FORMULA_TRANSPARENT = YES 1205 | 1206 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1207 | # (see http://www.mathjax.org) which uses client side Javascript for the 1208 | # rendering instead of using prerendered bitmaps. Use this if you do not 1209 | # have LaTeX installed or if you want to formulas look prettier in the HTML 1210 | # output. When enabled you may also need to install MathJax separately and 1211 | # configure the path to it using the MATHJAX_RELPATH option. 1212 | 1213 | USE_MATHJAX = NO 1214 | 1215 | # When MathJax is enabled you can set the default output format to be used for 1216 | # thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and 1217 | # SVG. The default value is HTML-CSS, which is slower, but has the best 1218 | # compatibility. 1219 | 1220 | MATHJAX_FORMAT = HTML-CSS 1221 | 1222 | # When MathJax is enabled you need to specify the location relative to the 1223 | # HTML output directory using the MATHJAX_RELPATH option. The destination 1224 | # directory should contain the MathJax.js script. For instance, if the mathjax 1225 | # directory is located at the same level as the HTML output directory, then 1226 | # MATHJAX_RELPATH should be ../mathjax. The default value points to 1227 | # the MathJax Content Delivery Network so you can quickly see the result without 1228 | # installing MathJax. However, it is strongly recommended to install a local 1229 | # copy of MathJax from http://www.mathjax.org before deployment. 1230 | 1231 | MATHJAX_RELPATH = http://www.mathjax.org/mathjax 1232 | 1233 | # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1234 | # names that should be enabled during MathJax rendering. 1235 | 1236 | MATHJAX_EXTENSIONS = 1237 | 1238 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box 1239 | # for the HTML output. The underlying search engine uses javascript 1240 | # and DHTML and should work on any modern browser. Note that when using 1241 | # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1242 | # (GENERATE_DOCSET) there is already a search function so this one should 1243 | # typically be disabled. For large projects the javascript based search engine 1244 | # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1245 | 1246 | SEARCHENGINE = YES 1247 | 1248 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1249 | # implemented using a web server instead of a web client using Javascript. 1250 | # There are two flavours of web server based search depending on the 1251 | # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for 1252 | # searching and an index file used by the script. When EXTERNAL_SEARCH is 1253 | # enabled the indexing and searching needs to be provided by external tools. 1254 | # See the manual for details. 1255 | 1256 | SERVER_BASED_SEARCH = NO 1257 | 1258 | # When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP 1259 | # script for searching. Instead the search results are written to an XML file 1260 | # which needs to be processed by an external indexer. Doxygen will invoke an 1261 | # external search engine pointed to by the SEARCHENGINE_URL option to obtain 1262 | # the search results. Doxygen ships with an example indexer (doxyindexer) and 1263 | # search engine (doxysearch.cgi) which are based on the open source search engine 1264 | # library Xapian. See the manual for configuration details. 1265 | 1266 | EXTERNAL_SEARCH = NO 1267 | 1268 | # The SEARCHENGINE_URL should point to a search engine hosted by a web server 1269 | # which will returned the search results when EXTERNAL_SEARCH is enabled. 1270 | # Doxygen ships with an example search engine (doxysearch) which is based on 1271 | # the open source search engine library Xapian. See the manual for configuration 1272 | # details. 1273 | 1274 | SEARCHENGINE_URL = 1275 | 1276 | # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1277 | # search data is written to a file for indexing by an external tool. With the 1278 | # SEARCHDATA_FILE tag the name of this file can be specified. 1279 | 1280 | SEARCHDATA_FILE = searchdata.xml 1281 | 1282 | # When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the 1283 | # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1284 | # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1285 | # projects and redirect the results back to the right project. 1286 | 1287 | EXTERNAL_SEARCH_ID = 1288 | 1289 | # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1290 | # projects other than the one defined by this configuration file, but that are 1291 | # all added to the same external search index. Each project needs to have a 1292 | # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id 1293 | # of to a relative location where the documentation can be found. 1294 | # The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... 1295 | 1296 | EXTRA_SEARCH_MAPPINGS = 1297 | 1298 | #--------------------------------------------------------------------------- 1299 | # configuration options related to the LaTeX output 1300 | #--------------------------------------------------------------------------- 1301 | 1302 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1303 | # generate Latex output. 1304 | 1305 | GENERATE_LATEX = NO 1306 | 1307 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1308 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1309 | # put in front of it. If left blank `latex' will be used as the default path. 1310 | 1311 | LATEX_OUTPUT = latex 1312 | 1313 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1314 | # invoked. If left blank `latex' will be used as the default command name. 1315 | # Note that when enabling USE_PDFLATEX this option is only used for 1316 | # generating bitmaps for formulas in the HTML output, but not in the 1317 | # Makefile that is written to the output directory. 1318 | 1319 | LATEX_CMD_NAME = latex 1320 | 1321 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1322 | # generate index for LaTeX. If left blank `makeindex' will be used as the 1323 | # default command name. 1324 | 1325 | MAKEINDEX_CMD_NAME = makeindex 1326 | 1327 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1328 | # LaTeX documents. This may be useful for small projects and may help to 1329 | # save some trees in general. 1330 | 1331 | COMPACT_LATEX = NO 1332 | 1333 | # The PAPER_TYPE tag can be used to set the paper type that is used 1334 | # by the printer. Possible values are: a4, letter, legal and 1335 | # executive. If left blank a4wide will be used. 1336 | 1337 | PAPER_TYPE = a4 1338 | 1339 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1340 | # packages that should be included in the LaTeX output. 1341 | 1342 | EXTRA_PACKAGES = 1343 | 1344 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1345 | # the generated latex document. The header should contain everything until 1346 | # the first chapter. If it is left blank doxygen will generate a 1347 | # standard header. Notice: only use this tag if you know what you are doing! 1348 | 1349 | LATEX_HEADER = 1350 | 1351 | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1352 | # the generated latex document. The footer should contain everything after 1353 | # the last chapter. If it is left blank doxygen will generate a 1354 | # standard footer. Notice: only use this tag if you know what you are doing! 1355 | 1356 | LATEX_FOOTER = 1357 | 1358 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1359 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will 1360 | # contain links (just like the HTML output) instead of page references 1361 | # This makes the output suitable for online browsing using a pdf viewer. 1362 | 1363 | PDF_HYPERLINKS = YES 1364 | 1365 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1366 | # plain latex in the generated Makefile. Set this option to YES to get a 1367 | # higher quality PDF documentation. 1368 | 1369 | USE_PDFLATEX = YES 1370 | 1371 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1372 | # command to the generated LaTeX files. This will instruct LaTeX to keep 1373 | # running if errors occur, instead of asking the user for help. 1374 | # This option is also used when generating formulas in HTML. 1375 | 1376 | LATEX_BATCHMODE = NO 1377 | 1378 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not 1379 | # include the index chapters (such as File Index, Compound Index, etc.) 1380 | # in the output. 1381 | 1382 | LATEX_HIDE_INDICES = NO 1383 | 1384 | # If LATEX_SOURCE_CODE is set to YES then doxygen will include 1385 | # source code with syntax highlighting in the LaTeX output. 1386 | # Note that which sources are shown also depends on other settings 1387 | # such as SOURCE_BROWSER. 1388 | 1389 | LATEX_SOURCE_CODE = NO 1390 | 1391 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1392 | # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1393 | # http://en.wikipedia.org/wiki/BibTeX for more info. 1394 | 1395 | LATEX_BIB_STYLE = plain 1396 | 1397 | #--------------------------------------------------------------------------- 1398 | # configuration options related to the RTF output 1399 | #--------------------------------------------------------------------------- 1400 | 1401 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1402 | # The RTF output is optimized for Word 97 and may not look very pretty with 1403 | # other RTF readers or editors. 1404 | 1405 | GENERATE_RTF = NO 1406 | 1407 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1408 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1409 | # put in front of it. If left blank `rtf' will be used as the default path. 1410 | 1411 | RTF_OUTPUT = rtf 1412 | 1413 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1414 | # RTF documents. This may be useful for small projects and may help to 1415 | # save some trees in general. 1416 | 1417 | COMPACT_RTF = NO 1418 | 1419 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1420 | # will contain hyperlink fields. The RTF file will 1421 | # contain links (just like the HTML output) instead of page references. 1422 | # This makes the output suitable for online browsing using WORD or other 1423 | # programs which support those fields. 1424 | # Note: wordpad (write) and others do not support links. 1425 | 1426 | RTF_HYPERLINKS = NO 1427 | 1428 | # Load style sheet definitions from file. Syntax is similar to doxygen's 1429 | # config file, i.e. a series of assignments. You only have to provide 1430 | # replacements, missing definitions are set to their default value. 1431 | 1432 | RTF_STYLESHEET_FILE = 1433 | 1434 | # Set optional variables used in the generation of an rtf document. 1435 | # Syntax is similar to doxygen's config file. 1436 | 1437 | RTF_EXTENSIONS_FILE = 1438 | 1439 | #--------------------------------------------------------------------------- 1440 | # configuration options related to the man page output 1441 | #--------------------------------------------------------------------------- 1442 | 1443 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1444 | # generate man pages 1445 | 1446 | GENERATE_MAN = NO 1447 | 1448 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. 1449 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1450 | # put in front of it. If left blank `man' will be used as the default path. 1451 | 1452 | MAN_OUTPUT = man 1453 | 1454 | # The MAN_EXTENSION tag determines the extension that is added to 1455 | # the generated man pages (default is the subroutine's section .3) 1456 | 1457 | MAN_EXTENSION = .3 1458 | 1459 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1460 | # then it will generate one additional man file for each entity 1461 | # documented in the real man page(s). These additional files 1462 | # only source the real man page, but without them the man command 1463 | # would be unable to find the correct page. The default is NO. 1464 | 1465 | MAN_LINKS = NO 1466 | 1467 | #--------------------------------------------------------------------------- 1468 | # configuration options related to the XML output 1469 | #--------------------------------------------------------------------------- 1470 | 1471 | # If the GENERATE_XML tag is set to YES Doxygen will 1472 | # generate an XML file that captures the structure of 1473 | # the code including all documentation. 1474 | 1475 | GENERATE_XML = NO 1476 | 1477 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. 1478 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1479 | # put in front of it. If left blank `xml' will be used as the default path. 1480 | 1481 | XML_OUTPUT = xml 1482 | 1483 | # The XML_SCHEMA tag can be used to specify an XML schema, 1484 | # which can be used by a validating XML parser to check the 1485 | # syntax of the XML files. 1486 | 1487 | XML_SCHEMA = 1488 | 1489 | # The XML_DTD tag can be used to specify an XML DTD, 1490 | # which can be used by a validating XML parser to check the 1491 | # syntax of the XML files. 1492 | 1493 | XML_DTD = 1494 | 1495 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1496 | # dump the program listings (including syntax highlighting 1497 | # and cross-referencing information) to the XML output. Note that 1498 | # enabling this will significantly increase the size of the XML output. 1499 | 1500 | XML_PROGRAMLISTING = YES 1501 | 1502 | #--------------------------------------------------------------------------- 1503 | # configuration options for the AutoGen Definitions output 1504 | #--------------------------------------------------------------------------- 1505 | 1506 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1507 | # generate an AutoGen Definitions (see autogen.sf.net) file 1508 | # that captures the structure of the code including all 1509 | # documentation. Note that this feature is still experimental 1510 | # and incomplete at the moment. 1511 | 1512 | GENERATE_AUTOGEN_DEF = NO 1513 | 1514 | #--------------------------------------------------------------------------- 1515 | # configuration options related to the Perl module output 1516 | #--------------------------------------------------------------------------- 1517 | 1518 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will 1519 | # generate a Perl module file that captures the structure of 1520 | # the code including all documentation. Note that this 1521 | # feature is still experimental and incomplete at the 1522 | # moment. 1523 | 1524 | GENERATE_PERLMOD = NO 1525 | 1526 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1527 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able 1528 | # to generate PDF and DVI output from the Perl module output. 1529 | 1530 | PERLMOD_LATEX = NO 1531 | 1532 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1533 | # nicely formatted so it can be parsed by a human reader. This is useful 1534 | # if you want to understand what is going on. On the other hand, if this 1535 | # tag is set to NO the size of the Perl module output will be much smaller 1536 | # and Perl will parse it just the same. 1537 | 1538 | PERLMOD_PRETTY = YES 1539 | 1540 | # The names of the make variables in the generated doxyrules.make file 1541 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1542 | # This is useful so different doxyrules.make files included by the same 1543 | # Makefile don't overwrite each other's variables. 1544 | 1545 | PERLMOD_MAKEVAR_PREFIX = 1546 | 1547 | #--------------------------------------------------------------------------- 1548 | # Configuration options related to the preprocessor 1549 | #--------------------------------------------------------------------------- 1550 | 1551 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1552 | # evaluate all C-preprocessor directives found in the sources and include 1553 | # files. 1554 | 1555 | ENABLE_PREPROCESSING = YES 1556 | 1557 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1558 | # names in the source code. If set to NO (the default) only conditional 1559 | # compilation will be performed. Macro expansion can be done in a controlled 1560 | # way by setting EXPAND_ONLY_PREDEF to YES. 1561 | 1562 | MACRO_EXPANSION = NO 1563 | 1564 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1565 | # then the macro expansion is limited to the macros specified with the 1566 | # PREDEFINED and EXPAND_AS_DEFINED tags. 1567 | 1568 | EXPAND_ONLY_PREDEF = NO 1569 | 1570 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1571 | # pointed to by INCLUDE_PATH will be searched when a #include is found. 1572 | 1573 | SEARCH_INCLUDES = YES 1574 | 1575 | # The INCLUDE_PATH tag can be used to specify one or more directories that 1576 | # contain include files that are not input files but should be processed by 1577 | # the preprocessor. 1578 | 1579 | INCLUDE_PATH = 1580 | 1581 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1582 | # patterns (like *.h and *.hpp) to filter out the header-files in the 1583 | # directories. If left blank, the patterns specified with FILE_PATTERNS will 1584 | # be used. 1585 | 1586 | INCLUDE_FILE_PATTERNS = 1587 | 1588 | # The PREDEFINED tag can be used to specify one or more macro names that 1589 | # are defined before the preprocessor is started (similar to the -D option of 1590 | # gcc). The argument of the tag is a list of macros of the form: name 1591 | # or name=definition (no spaces). If the definition and the = are 1592 | # omitted =1 is assumed. To prevent a macro definition from being 1593 | # undefined via #undef or recursively expanded use the := operator 1594 | # instead of the = operator. 1595 | 1596 | PREDEFINED = 1597 | 1598 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1599 | # this tag can be used to specify a list of macro names that should be expanded. 1600 | # The macro definition that is found in the sources will be used. 1601 | # Use the PREDEFINED tag if you want to use a different macro definition that 1602 | # overrules the definition found in the source code. 1603 | 1604 | EXPAND_AS_DEFINED = 1605 | 1606 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1607 | # doxygen's preprocessor will remove all references to function-like macros 1608 | # that are alone on a line, have an all uppercase name, and do not end with a 1609 | # semicolon, because these will confuse the parser if not removed. 1610 | 1611 | SKIP_FUNCTION_MACROS = YES 1612 | 1613 | #--------------------------------------------------------------------------- 1614 | # Configuration::additions related to external references 1615 | #--------------------------------------------------------------------------- 1616 | 1617 | # The TAGFILES option can be used to specify one or more tagfiles. For each 1618 | # tag file the location of the external documentation should be added. The 1619 | # format of a tag file without this location is as follows: 1620 | # TAGFILES = file1 file2 ... 1621 | # Adding location for the tag files is done as follows: 1622 | # TAGFILES = file1=loc1 "file2 = loc2" ... 1623 | # where "loc1" and "loc2" can be relative or absolute paths 1624 | # or URLs. Note that each tag file must have a unique name (where the name does 1625 | # NOT include the path). If a tag file is not located in the directory in which 1626 | # doxygen is run, you must also specify the path to the tagfile here. 1627 | 1628 | TAGFILES = 1629 | 1630 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1631 | # a tag file that is based on the input files it reads. 1632 | 1633 | GENERATE_TAGFILE = 1634 | 1635 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1636 | # in the class index. If set to NO only the inherited external classes 1637 | # will be listed. 1638 | 1639 | ALLEXTERNALS = NO 1640 | 1641 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1642 | # in the modules index. If set to NO, only the current project's groups will 1643 | # be listed. 1644 | 1645 | EXTERNAL_GROUPS = YES 1646 | 1647 | # The PERL_PATH should be the absolute path and name of the perl script 1648 | # interpreter (i.e. the result of `which perl'). 1649 | 1650 | PERL_PATH = /usr/bin/perl 1651 | 1652 | #--------------------------------------------------------------------------- 1653 | # Configuration options related to the dot tool 1654 | #--------------------------------------------------------------------------- 1655 | 1656 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1657 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1658 | # or super classes. Setting the tag to NO turns the diagrams off. Note that 1659 | # this option also works with HAVE_DOT disabled, but it is recommended to 1660 | # install and use dot, since it yields more powerful graphs. 1661 | 1662 | CLASS_DIAGRAMS = YES 1663 | 1664 | # You can define message sequence charts within doxygen comments using the \msc 1665 | # command. Doxygen will then run the mscgen tool (see 1666 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1667 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1668 | # the mscgen tool resides. If left empty the tool is assumed to be found in the 1669 | # default search path. 1670 | 1671 | MSCGEN_PATH = 1672 | 1673 | # If set to YES, the inheritance and collaboration graphs will hide 1674 | # inheritance and usage relations if the target is undocumented 1675 | # or is not a class. 1676 | 1677 | HIDE_UNDOC_RELATIONS = YES 1678 | 1679 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1680 | # available from the path. This tool is part of Graphviz, a graph visualization 1681 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1682 | # have no effect if this option is set to NO (the default) 1683 | 1684 | HAVE_DOT = YES 1685 | 1686 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1687 | # allowed to run in parallel. When set to 0 (the default) doxygen will 1688 | # base this on the number of processors available in the system. You can set it 1689 | # explicitly to a value larger than 0 to get control over the balance 1690 | # between CPU load and processing speed. 1691 | 1692 | DOT_NUM_THREADS = 0 1693 | 1694 | # By default doxygen will use the Helvetica font for all dot files that 1695 | # doxygen generates. When you want a differently looking font you can specify 1696 | # the font name using DOT_FONTNAME. You need to make sure dot is able to find 1697 | # the font, which can be done by putting it in a standard location or by setting 1698 | # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1699 | # directory containing the font. 1700 | 1701 | DOT_FONTNAME = Helvetica 1702 | 1703 | # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1704 | # The default size is 10pt. 1705 | 1706 | DOT_FONTSIZE = 10 1707 | 1708 | # By default doxygen will tell dot to use the Helvetica font. 1709 | # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1710 | # set the path where dot can find it. 1711 | 1712 | DOT_FONTPATH = 1713 | 1714 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1715 | # will generate a graph for each documented class showing the direct and 1716 | # indirect inheritance relations. Setting this tag to YES will force the 1717 | # CLASS_DIAGRAMS tag to NO. 1718 | 1719 | CLASS_GRAPH = YES 1720 | 1721 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1722 | # will generate a graph for each documented class showing the direct and 1723 | # indirect implementation dependencies (inheritance, containment, and 1724 | # class references variables) of the class with other documented classes. 1725 | 1726 | COLLABORATION_GRAPH = YES 1727 | 1728 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1729 | # will generate a graph for groups, showing the direct groups dependencies 1730 | 1731 | GROUP_GRAPHS = YES 1732 | 1733 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1734 | # collaboration diagrams in a style similar to the OMG's Unified Modeling 1735 | # Language. 1736 | 1737 | UML_LOOK = NO 1738 | 1739 | # If the UML_LOOK tag is enabled, the fields and methods are shown inside 1740 | # the class node. If there are many fields or methods and many nodes the 1741 | # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 1742 | # threshold limits the number of items for each type to make the size more 1743 | # managable. Set this to 0 for no limit. Note that the threshold may be 1744 | # exceeded by 50% before the limit is enforced. 1745 | 1746 | UML_LIMIT_NUM_FIELDS = 10 1747 | 1748 | # If set to YES, the inheritance and collaboration graphs will show the 1749 | # relations between templates and their instances. 1750 | 1751 | TEMPLATE_RELATIONS = NO 1752 | 1753 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1754 | # tags are set to YES then doxygen will generate a graph for each documented 1755 | # file showing the direct and indirect include dependencies of the file with 1756 | # other documented files. 1757 | 1758 | INCLUDE_GRAPH = YES 1759 | 1760 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1761 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1762 | # documented header file showing the documented files that directly or 1763 | # indirectly include this file. 1764 | 1765 | INCLUDED_BY_GRAPH = YES 1766 | 1767 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then 1768 | # doxygen will generate a call dependency graph for every global function 1769 | # or class method. Note that enabling this option will significantly increase 1770 | # the time of a run. So in most cases it will be better to enable call graphs 1771 | # for selected functions only using the \callgraph command. 1772 | 1773 | CALL_GRAPH = YES 1774 | 1775 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1776 | # doxygen will generate a caller dependency graph for every global function 1777 | # or class method. Note that enabling this option will significantly increase 1778 | # the time of a run. So in most cases it will be better to enable caller 1779 | # graphs for selected functions only using the \callergraph command. 1780 | 1781 | CALLER_GRAPH = YES 1782 | 1783 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1784 | # will generate a graphical hierarchy of all classes instead of a textual one. 1785 | 1786 | GRAPHICAL_HIERARCHY = YES 1787 | 1788 | # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 1789 | # then doxygen will show the dependencies a directory has on other directories 1790 | # in a graphical way. The dependency relations are determined by the #include 1791 | # relations between the files in the directories. 1792 | 1793 | DIRECTORY_GRAPH = YES 1794 | 1795 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1796 | # generated by dot. Possible values are svg, png, jpg, or gif. 1797 | # If left blank png will be used. If you choose svg you need to set 1798 | # HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1799 | # visible in IE 9+ (other browsers do not have this requirement). 1800 | 1801 | DOT_IMAGE_FORMAT = png 1802 | 1803 | # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1804 | # enable generation of interactive SVG images that allow zooming and panning. 1805 | # Note that this requires a modern browser other than Internet Explorer. 1806 | # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1807 | # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1808 | # visible. Older versions of IE do not have SVG support. 1809 | 1810 | INTERACTIVE_SVG = NO 1811 | 1812 | # The tag DOT_PATH can be used to specify the path where the dot tool can be 1813 | # found. If left blank, it is assumed the dot tool can be found in the path. 1814 | 1815 | DOT_PATH = 1816 | 1817 | # The DOTFILE_DIRS tag can be used to specify one or more directories that 1818 | # contain dot files that are included in the documentation (see the 1819 | # \dotfile command). 1820 | 1821 | DOTFILE_DIRS = 1822 | 1823 | # The MSCFILE_DIRS tag can be used to specify one or more directories that 1824 | # contain msc files that are included in the documentation (see the 1825 | # \mscfile command). 1826 | 1827 | MSCFILE_DIRS = 1828 | 1829 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1830 | # nodes that will be shown in the graph. If the number of nodes in a graph 1831 | # becomes larger than this value, doxygen will truncate the graph, which is 1832 | # visualized by representing a node as a red box. Note that doxygen if the 1833 | # number of direct children of the root node in a graph is already larger than 1834 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1835 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1836 | 1837 | DOT_GRAPH_MAX_NODES = 50 1838 | 1839 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1840 | # graphs generated by dot. A depth value of 3 means that only nodes reachable 1841 | # from the root by following a path via at most 3 edges will be shown. Nodes 1842 | # that lay further from the root node will be omitted. Note that setting this 1843 | # option to 1 or 2 may greatly reduce the computation time needed for large 1844 | # code bases. Also note that the size of a graph can be further restricted by 1845 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1846 | 1847 | MAX_DOT_GRAPH_DEPTH = 0 1848 | 1849 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1850 | # background. This is disabled by default, because dot on Windows does not 1851 | # seem to support this out of the box. Warning: Depending on the platform used, 1852 | # enabling this option may lead to badly anti-aliased labels on the edges of 1853 | # a graph (i.e. they become hard to read). 1854 | 1855 | DOT_TRANSPARENT = NO 1856 | 1857 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1858 | # files in one run (i.e. multiple -o and -T options on the command line). This 1859 | # makes dot run faster, but since only newer versions of dot (>1.8.10) 1860 | # support this, this feature is disabled by default. 1861 | 1862 | DOT_MULTI_TARGETS = NO 1863 | 1864 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1865 | # generate a legend page explaining the meaning of the various boxes and 1866 | # arrows in the dot generated graphs. 1867 | 1868 | GENERATE_LEGEND = YES 1869 | 1870 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1871 | # remove the intermediate dot files that are used to generate 1872 | # the various graphs. 1873 | 1874 | DOT_CLEANUP = YES 1875 | --------------------------------------------------------------------------------