├── README.md ├── examples ├── subdomain-code │ ├── dep.dot │ ├── main.cpp │ └── code.h ├── hello │ ├── template_args_test.cpp │ ├── helloworld.cpp │ ├── not_keyword.cpp │ ├── or_keyword.cpp │ ├── and_keyword.cpp │ └── macro.cpp ├── bc-code │ ├── src │ │ ├── gateways │ │ │ └── gateway.cpp │ │ ├── interface │ │ │ └── cargo_api.cpp │ │ ├── repositories │ │ │ └── repository.cpp │ │ ├── services │ │ │ └── service.cpp │ │ └── domain │ │ │ └── model.cpp │ ├── test │ │ ├── test_main.cpp │ │ └── app_test.cpp │ ├── include │ │ ├── gateways │ │ │ ├── msg.h │ │ │ └── gateway.h │ │ ├── interface │ │ │ ├── msg.h │ │ │ └── api.h │ │ ├── repositories │ │ │ └── repository.h │ │ ├── domain │ │ │ └── model.h │ │ └── services │ │ │ └── service.h │ ├── CMakeLists.txt │ └── main.cpp ├── step3-code │ ├── main.cpp │ └── code.h ├── cpp-basic │ └── function-call │ │ ├── CMakeLists.txt │ │ ├── line.h │ │ ├── line.cpp │ │ └── function-call.cpp ├── inheritance-tree-code │ ├── main.cpp │ └── code.h ├── step2-code │ ├── main.cpp │ ├── code.h │ └── Doxyfile └── step1-code │ └── code.h ├── .gitignore ├── main.go ├── adapter ├── CPPCallApp.go └── CPPCallListener.go └── language └── cplus └── CPP14.g4 /README.md: -------------------------------------------------------------------------------- 1 | # coca-c 2 | -------------------------------------------------------------------------------- /examples/subdomain-code/dep.dot: -------------------------------------------------------------------------------- 1 | digraph G { 2 | 3 | } 4 | -------------------------------------------------------------------------------- /examples/hello/template_args_test.cpp: -------------------------------------------------------------------------------- 1 | void TemplateArgsTest(vector args, vector args2) 2 | { 3 | } 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | language/cplus/*.go 3 | language/cplus/*.tokens 4 | language/cplus/*.interp 5 | main 6 | **/cmake-build-debug/ 7 | -------------------------------------------------------------------------------- /examples/hello/helloworld.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | main() 4 | { 5 | cout << "Hello World!"; 6 | return 0; 7 | } 8 | 9 | -------------------------------------------------------------------------------- /examples/bc-code/src/gateways/gateway.cpp: -------------------------------------------------------------------------------- 1 | #include "gateways/gateway.h" 2 | 3 | using namespace gateways; 4 | 5 | void CargoProviderImpl::Confirm(Cargo *cargo) 6 | { 7 | 8 | } -------------------------------------------------------------------------------- /examples/bc-code/test/test_main.cpp: -------------------------------------------------------------------------------- 1 | #include "gtest/gtest.h" 2 | 3 | int main(int argc, char** argv) { 4 | ::testing::InitGoogleTest(&argc, argv); 5 | return RUN_ALL_TESTS(); 6 | } -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | . "./adapter" 5 | ) 6 | 7 | func main() { 8 | callApp := new(CPPCallApp) 9 | callApp.Analysis("examples/cpp-basic/function-call/") 10 | } 11 | -------------------------------------------------------------------------------- /examples/hello/not_keyword.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | using namespace std; 4 | 5 | int main() 6 | { 7 | if (not false) { 8 | cout << "Hello World!"; 9 | } 10 | return 0; 11 | } 12 | 13 | -------------------------------------------------------------------------------- /examples/hello/or_keyword.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | using namespace std; 4 | 5 | int main() 6 | { 7 | if (false or true) { 8 | cout << "Hello World!"; 9 | } 10 | return 0; 11 | } 12 | 13 | -------------------------------------------------------------------------------- /examples/hello/and_keyword.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | using namespace std; 4 | 5 | int main() 6 | { 7 | if (true and true) { 8 | cout << "Hello World!"; 9 | } 10 | return 0; 11 | } 12 | 13 | -------------------------------------------------------------------------------- /examples/bc-code/include/gateways/msg.h: -------------------------------------------------------------------------------- 1 | #ifndef BC_DEMO_GW_MSG_H 2 | #define BC_DEMO_GW_MSG_H 3 | 4 | namespace gateways { 5 | struct CargoCreatedMsg { 6 | int Id; 7 | }; 8 | } 9 | #endif //BC_DEMO_GW_MSG_H 10 | -------------------------------------------------------------------------------- /examples/bc-code/include/interface/msg.h: -------------------------------------------------------------------------------- 1 | #ifndef BC_DEMO_INTERFACE_MSG_H 2 | #define BC_DEMO_INTERFACE_MSG_H 3 | 4 | namespace api { 5 | struct CreateCargoMsg 6 | { 7 | int Id; 8 | int AfterDays; 9 | }; 10 | 11 | } 12 | #endif //BC_DEMO_INTERFACE_MSG_H 13 | -------------------------------------------------------------------------------- /examples/step3-code/main.cpp: -------------------------------------------------------------------------------- 1 | #include "code.h" 2 | 3 | using namespace Gateways; 4 | using namespace Repositories; 5 | 6 | int main(int argc, char const *argv[]) 7 | { 8 | router = new FakeRouter(); 9 | AggregateRootB* b = new AggregateRootB(); 10 | b->Init(); 11 | return 0; 12 | } -------------------------------------------------------------------------------- /examples/cpp-basic/function-call/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # CMake 最低版本号要求 2 | cmake_minimum_required(VERSION 3.15.0) 3 | 4 | # 项目名 5 | project(hello) 6 | 7 | # 查找当前目录下的所有源文件，并将名称保存到 SRC_LIST 变量 8 | aux_source_directory(. SRC_LIST) 9 | 10 | # 指定生成目标 11 | add_executable(hello ${SRC_LIST} line.h) 12 | -------------------------------------------------------------------------------- /examples/inheritance-tree-code/main.cpp: -------------------------------------------------------------------------------- 1 | #include "code.h" 2 | 3 | using namespace Gateways; 4 | using namespace Repositories; 5 | 6 | int main(int argc, char const *argv[]) 7 | { 8 | router = new FakeRouter(); 9 | AggregateRootB* b = new AggregateRootB(); 10 | b->Init(); 11 | return 0; 12 | } -------------------------------------------------------------------------------- /examples/subdomain-code/main.cpp: -------------------------------------------------------------------------------- 1 | #include "code.h" 2 | 3 | using namespace subdomain1::Gateways; 4 | using namespace subdomain1::Repositories; 5 | 6 | int main(int argc, char const *argv[]) 7 | { 8 | router = new FakeRouter(); 9 | AggregateRootA* a = new AggregateRootA(); 10 | a->Init(); 11 | return 0; 12 | } -------------------------------------------------------------------------------- /examples/bc-code/include/gateways/gateway.h: -------------------------------------------------------------------------------- 1 | #ifndef BC_DEMO_GATEWAY_H 2 | #define BC_DEMO_GATEWAY_H 3 | 4 | #include "services/service.h" 5 | 6 | namespace gateways { 7 | using namespace services; 8 | 9 | struct CargoProviderImpl: CargoProvider 10 | { 11 | virtual void Confirm(Cargo *cargo) override; 12 | }; 13 | } 14 | #endif //BC_DEMO_GATEWAY_H 15 | -------------------------------------------------------------------------------- /examples/cpp-basic/function-call/line.h: -------------------------------------------------------------------------------- 1 | // 2 | // Created by Fengda Huang on 2019/11/3. 3 | // 4 | 5 | #ifndef LINE_H 6 | #define LINE_H 7 | 8 | class Line { 9 | public: 10 | void setLength(double len); 11 | 12 | double getLength(void); 13 | 14 | Line(); // 这是构造函数 15 | 16 | private: 17 | double length; 18 | }; 19 | 20 | #endif LINE_H 21 | -------------------------------------------------------------------------------- /examples/step2-code/main.cpp: -------------------------------------------------------------------------------- 1 | #include "code.h" 2 | 3 | using namespace Gateways; 4 | using namespace Repositories; 5 | 6 | int main(int argc, char const *argv[]) 7 | { 8 | // routerFactory.setRouter(new FakeRouter()); 9 | router = new FakeRouter(); 10 | AggregateRootARepo *repo = new AggregateRootARepo(); 11 | repo->Save(new AggregateRootA()); 12 | return 0; 13 | } -------------------------------------------------------------------------------- /examples/cpp-basic/function-call/line.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "line.h" 3 | 4 | 5 | using namespace std; 6 | 7 | // 成员函数定义，包括构造函数 8 | Line::Line(void) { 9 | cout << "Object is being created" << endl; 10 | } 11 | 12 | void Line::setLength(double len) { 13 | length = len; 14 | } 15 | 16 | double Line::getLength(void) { 17 | return length; 18 | } 19 | 20 | -------------------------------------------------------------------------------- /examples/bc-code/include/repositories/repository.h: -------------------------------------------------------------------------------- 1 | #ifndef BC_DEMO__REPO_H__ 2 | #define BC_DEMO__REPO_H__ 3 | 4 | #include "domain/model.h" 5 | //#include 6 | 7 | namespace repositories { 8 | using namespace domain; 9 | 10 | struct Repository 11 | { 12 | 13 | }; 14 | 15 | struct CargoRepository: Repository 16 | { 17 | CargoRepository(); 18 | void Save(Cargo* cargo); 19 | Cargo* FindById(int id); 20 | }; 21 | 22 | } 23 | 24 | #endif -------------------------------------------------------------------------------- /examples/bc-code/include/interface/api.h: -------------------------------------------------------------------------------- 1 | #ifndef BC_DEMO_API_H 2 | #define BC_DEMO_API_H 3 | 4 | #include "services/service.h" 5 | #include "msg.h" 6 | 7 | namespace api { 8 | using namespace services; 9 | 10 | struct Api { 11 | Api(std::shared_ptr); 12 | void CreateCargo(CreateCargoMsg* msg); 13 | void Delay(int cargoId, int days); 14 | 15 | private: 16 | std::shared_ptr cargoService_; 17 | }; 18 | } 19 | #endif //BC_DEMO_API_H 20 | -------------------------------------------------------------------------------- /examples/bc-code/src/interface/cargo_api.cpp: -------------------------------------------------------------------------------- 1 | #include "interface/api.h" 2 | 3 | using namespace api; 4 | using namespace services; 5 | 6 | Api::Api(std::shared_ptr cargoService) 7 | :cargoService_(cargoService) 8 | { 9 | } 10 | 11 | void Api::CreateCargo(CreateCargoMsg * msg) 12 | { 13 | this->cargoService_->Create(msg->Id,msg->AfterDays); 14 | } 15 | 16 | void Api::Delay(int cargoId, int days) { 17 | this->cargoService_->Delay(cargoId,days); 18 | } 19 | -------------------------------------------------------------------------------- /examples/bc-code/src/repositories/repository.cpp: -------------------------------------------------------------------------------- 1 | #include "repositories/repository.h" 2 | 3 | using namespace repositories; 4 | 5 | std::vector cargo_list; 6 | 7 | CargoRepository::CargoRepository() 8 | { 9 | } 10 | 11 | void CargoRepository::Save(Cargo* cargo) 12 | { 13 | cargo_list.push_back(cargo); 14 | } 15 | 16 | Cargo* CargoRepository::FindById(int id) 17 | { 18 | for(Cargo* cargo : cargo_list){ 19 | if(cargo->getId() == id) { 20 | return cargo; 21 | } 22 | } 23 | 24 | return NULL; 25 | } 26 | -------------------------------------------------------------------------------- /examples/bc-code/src/services/service.cpp: -------------------------------------------------------------------------------- 1 | #include "services/service.h" 2 | 3 | using namespace services; 4 | 5 | 6 | void CargoService::Create(int id, int days) 7 | { 8 | Delivery* delivery = new Delivery(days); 9 | Cargo* cargo = new Cargo(delivery, id); 10 | cargo->AddProduct(1); 11 | this->cargoRepository_->Save(cargo); 12 | this->cargoProvider_->Confirm(cargo); 13 | } 14 | void CargoService::Delay(int id, int days) 15 | { 16 | Cargo* cargo = cargoRepository_->FindById(id); 17 | if(cargo != NULL) { 18 | cargo->Delay(days); 19 | cargoRepository_->Save(cargo); 20 | this->cargoProvider_->Confirm(cargo); 21 | } 22 | } 23 | 24 | -------------------------------------------------------------------------------- /examples/bc-code/src/domain/model.cpp: -------------------------------------------------------------------------------- 1 | #include "domain/model.h" 2 | 3 | using namespace domain; 4 | 5 | int Entity::getId() 6 | { 7 | return id; 8 | } 9 | Cargo::Cargo(Delivery* delivery, int id) 10 | :delivery(delivery) 11 | { 12 | this->id = id; 13 | } 14 | Cargo::~Cargo() 15 | { 16 | 17 | } 18 | void Cargo::Delay(int days) 19 | { 20 | int after = this->delivery->AfterDays; 21 | this->delivery = new Delivery(after + days); 22 | } 23 | 24 | void Cargo::AddProduct(int productId) 25 | { 26 | Product* product = new Product(productId); 27 | this->product_list.push_back(product); 28 | } 29 | 30 | int Cargo::afterDays() 31 | { 32 | return this->delivery->AfterDays; 33 | } 34 | 35 | Delivery::Delivery(int afterDays) 36 | :AfterDays(afterDays) 37 | { 38 | 39 | } 40 | 41 | Product::Product(int id) 42 | :productId(id) 43 | { 44 | } -------------------------------------------------------------------------------- /examples/bc-code/include/domain/model.h: -------------------------------------------------------------------------------- 1 | #ifndef BC_DEMO__MODEL_H__ 2 | #define BC_DEMO__MODEL_H__ 3 | 4 | #include 5 | 6 | namespace domain{ 7 | struct Entity 8 | { 9 | int getId(); 10 | protected: 11 | int id; 12 | }; 13 | 14 | struct AggregateRoot: Entity 15 | { 16 | 17 | }; 18 | 19 | struct ValueObject 20 | { 21 | 22 | }; 23 | 24 | struct Delivery: ValueObject 25 | { 26 | Delivery(int); 27 | int AfterDays; 28 | }; 29 | 30 | struct Product: ValueObject 31 | { 32 | Product(int id); 33 | private: 34 | int productId; 35 | }; 36 | 37 | struct Cargo: AggregateRoot 38 | { 39 | Cargo(Delivery*, int); 40 | ~Cargo(); 41 | void Delay(int); 42 | void AddProduct(int); 43 | int afterDays(); 44 | private: 45 | Delivery* delivery; 46 | std::vector product_list; 47 | }; 48 | 49 | struct CargoDelayed { 50 | int CargoId; 51 | }; 52 | } 53 | #endif -------------------------------------------------------------------------------- /examples/bc-code/include/services/service.h: -------------------------------------------------------------------------------- 1 | #ifndef BC_DEMO_SERVICE_H 2 | #define BC_DEMO_SERVICE_H 3 | 4 | #include "repositories/repository.h" 5 | 6 | namespace services { 7 | using namespace repositories; 8 | 9 | struct Provider 10 | { 11 | 12 | }; 13 | 14 | struct CargoProvider : Provider { 15 | virtual void Confirm(Cargo* cargo){}; 16 | }; 17 | 18 | struct CargoService { 19 | explicit CargoService(const std::shared_ptr cargoRepo, const std::shared_ptr cargoProvider) 20 | :cargoRepository_(cargoRepo) 21 | ,cargoProvider_(cargoProvider) 22 | { 23 | 24 | } 25 | void Create(int id, int days); 26 | void Delay(int id, int days); 27 | private: 28 | std::shared_ptr cargoRepository_; 29 | std::shared_ptr cargoProvider_; 30 | }; 31 | 32 | } 33 | #endif //BC_DEMO_SERVICE_H 34 | -------------------------------------------------------------------------------- /examples/hello/macro.cpp: -------------------------------------------------------------------------------- 1 | #define Verify(cond, msg) \ 2 | do \ 3 | { \ 4 | if (!(cond)) \ 5 | { \ 6 | verRaiseVerifyExceptionIfNeeded(INDEBUG(msg) DEBUGARG(__FILE__) DEBUGARG(__LINE__)); \ 7 | } \ 8 | } while (0) 9 | 10 | void f() { 11 | int b = 0; 12 | } 13 | 14 | -------------------------------------------------------------------------------- /examples/step1-code/code.h: -------------------------------------------------------------------------------- 1 | class Entity 2 | { 3 | public: 4 | Entity(){}; 5 | ~Entity(){}; 6 | int Id; 7 | }; 8 | 9 | class AggregateRoot: public Entity 10 | { 11 | public: 12 | AggregateRoot(){}; 13 | ~AggregateRoot(){}; 14 | void Init(){ 15 | 16 | } 17 | }; 18 | 19 | 20 | class ValueObject 21 | { 22 | public: 23 | ValueObject(){}; 24 | ~ValueObject(){}; 25 | 26 | }; 27 | 28 | class ValueObjectC: public ValueObject 29 | { 30 | public: 31 | ValueObjectC(){}; 32 | ~ValueObjectC(){}; 33 | 34 | }; 35 | 36 | class ValueObjectD: public ValueObject 37 | { 38 | public: 39 | ValueObjectD(){}; 40 | ~ValueObjectD(){}; 41 | 42 | }; 43 | 44 | class EntityB: public Entity 45 | { 46 | public: 47 | EntityB(){}; 48 | ~EntityB(){}; 49 | ValueObjectD* vo_d; 50 | 51 | }; 52 | 53 | class AggregateRootA: public AggregateRoot 54 | { 55 | public: 56 | AggregateRootA(){}; 57 | ~AggregateRootA(){}; 58 | EntityB* entity_b; 59 | ValueObjectC* vo_c; 60 | }; -------------------------------------------------------------------------------- /examples/cpp-basic/function-call/function-call.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "line.h" 3 | 4 | using namespace std; 5 | 6 | void swap(int, int); 7 | 8 | class Position { 9 | private: 10 | int x; 11 | private: 12 | int y; 13 | 14 | public: 15 | void setX(int x) { 16 | this->x = x; 17 | } 18 | 19 | void setY(int y) { 20 | this->y = y; 21 | } 22 | 23 | void setPosition(int x, int y) { 24 | this->setX(x); 25 | this->setY(y); 26 | } 27 | }; 28 | 29 | int main() { 30 | int a = 3, b = 4; 31 | cout << "a = " << a << ", b = " 32 | << b << endl; 33 | swap(a, b); 34 | cout << "a = " << a << ", b = " 35 | << b << endl; 36 | 37 | Position position; 38 | position.setX(0); 39 | 40 | Line line; 41 | line.setLength(2); 42 | double length = line.getLength(); 43 | 44 | cout << "length: " << length << endl; 45 | 46 | return 0; 47 | } 48 | 49 | void swap(int x, int y) { 50 | int t = x; 51 | x = y; 52 | y = t; 53 | } 54 | -------------------------------------------------------------------------------- /examples/bc-code/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # Set the minimum version of CMake that can be used 2 | # To find the cmake version run 3 | # $ cmake --version 4 | cmake_minimum_required(VERSION 3.0) 5 | 6 | # Set the project name 7 | project (bc_demo) 8 | 9 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11") 10 | 11 | # Create a sources variable with a link to all cpp files to compile 12 | file(GLOB_RECURSE SOURCES src/*.cpp) 13 | 14 | 15 | # Add an executable with the above sources 16 | add_executable(bc_demo ${SOURCES} main.cpp) 17 | 18 | # Set the direcoties that should be included in the build command for this target 19 | # when running g++ these will be included as -I/directory/path/ 20 | target_include_directories(bc_demo 21 | PRIVATE ${PROJECT_SOURCE_DIR}/include 22 | ) 23 | 24 | include_directories(${PROJECT_SOURCE_DIR}/include) 25 | 26 | enable_testing() 27 | find_package(GTest REQUIRED) 28 | include_directories(${GTEST_INCLUDE_DIRS}) 29 | 30 | file(GLOB TEST_SRC_FILES test/*.cpp) 31 | add_executable(bc_demo_test ${SOURCES} ${TEST_SRC_FILES}) 32 | target_link_libraries(bc_demo_test ${GTEST_LIBRARIES}) 33 | 34 | 35 | add_test(AllTests bc_demo_test) -------------------------------------------------------------------------------- /adapter/CPPCallApp.go: -------------------------------------------------------------------------------- 1 | package adapter 2 | 3 | import ( 4 | "fmt" 5 | "github.com/antlr/antlr4/runtime/Go/antlr" 6 | "os" 7 | "path/filepath" 8 | "strings" 9 | 10 | . "../language/cplus" 11 | ) 12 | 13 | type CPPCallApp struct { 14 | 15 | } 16 | 17 | func (j *CPPCallApp) Analysis(codeDir string) { 18 | files := (*CPPCallApp)(nil).getFiles(codeDir) 19 | for _, file := range files { 20 | fmt.Println(file) 21 | parser := (*CPPCallApp)(nil).processFile(file) 22 | context := parser.Translationunit() 23 | listener := NewCPPCallListener() 24 | 25 | antlr.NewParseTreeWalker().Walk(listener, context) 26 | } 27 | } 28 | 29 | func (j *CPPCallApp) getFiles(codeDir string) []string { 30 | files := make([]string, 0) 31 | _ = filepath.Walk(codeDir, func(path string, fi os.FileInfo, err error) error { 32 | if !strings.Contains(path, "cmake-build-debug") && (strings.HasSuffix(path, ".cpp") || strings.Contains(path, ".h")) { 33 | files = append(files, path) 34 | } 35 | return nil 36 | }) 37 | return files 38 | } 39 | 40 | 41 | func (j *CPPCallApp) processFile(path string) *CPP14Parser { 42 | is, _ := antlr.NewFileStream(path) 43 | lexer := NewCPP14Lexer(is) 44 | stream := antlr.NewCommonTokenStream(lexer, 0); 45 | parser := NewCPP14Parser(stream) 46 | return parser 47 | } 48 | -------------------------------------------------------------------------------- /examples/bc-code/main.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "repositories/repository.h" 3 | #include "services/service.h" 4 | #include "gateways/gateway.h" 5 | #include "interface/api.h" 6 | #include "Hypodermic/ContainerBuilder.h" 7 | 8 | using namespace repositories; 9 | using namespace services; 10 | using namespace gateways; 11 | using namespace Hypodermic; 12 | 13 | 14 | int main(int argc, char *argv[]) 15 | { 16 | ContainerBuilder builder; 17 | builder.registerType< CargoRepository >().singleInstance(); 18 | builder.registerType< CargoProviderImpl >().singleInstance().as< CargoProvider >(); 19 | builder.registerType< CargoService >().singleInstance(); 20 | builder.registerType().singleInstance(); 21 | 22 | auto container = builder.build(); 23 | 24 | std::shared_ptr api = container->resolve(); 25 | std::shared_ptr cargoRepo = container->resolve(); 26 | api::CreateCargoMsg* msg = new api::CreateCargoMsg(); 27 | msg->Id = 1; 28 | msg->AfterDays = 10; 29 | api->CreateCargo(msg); 30 | std::cout<< "hello" << "\n"; 31 | std::cout<< cargoRepo->FindById(1)->getId()<<"\n"; 32 | return 0; 33 | } 34 | 35 | // Add this code snippet just for doxygen... 36 | namespace std { template class shared_ptr { T *dummy_for_doxygen; }; } 37 | -------------------------------------------------------------------------------- /examples/inheritance-tree-code/code.h: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | namespace Domain { 4 | class Entity 5 | { 6 | public: 7 | int Id; 8 | }; 9 | 10 | class AggregateRoot: public Entity 11 | { 12 | }; 13 | 14 | 15 | class ValueObject 16 | { 17 | }; 18 | 19 | class Provider 20 | { 21 | 22 | }; 23 | 24 | class Router: public Provider 25 | { 26 | public: 27 | virtual int Selete() = 0; 28 | }; 29 | 30 | static Router* router; 31 | 32 | class ValueObjectC: public ValueObject 33 | { 34 | public: 35 | ValueObjectC(){}; 36 | ~ValueObjectC(){}; 37 | 38 | }; 39 | 40 | class ValueObjectD: public ValueObjectC 41 | { 42 | public: 43 | ValueObjectD(){}; 44 | ~ValueObjectD(){}; 45 | 46 | }; 47 | 48 | class EntityB: public Entity 49 | { 50 | public: 51 | EntityB(){}; 52 | ~EntityB(){}; 53 | ValueObjectD* vo_d; 54 | void init(){ 55 | vo_d = new ValueObjectD(); 56 | std::cout << "entity b init" << "\n"; 57 | }; 58 | }; 59 | 60 | class EntityC: public EntityB 61 | { 62 | public: 63 | EntityC(){}; 64 | ~EntityC(){}; 65 | void init(){ 66 | 67 | }; 68 | }; 69 | 70 | class AggregateRootA: public AggregateRoot 71 | { 72 | public: 73 | AggregateRootA(){}; 74 | ~AggregateRootA(){}; 75 | EntityB* entity_b; 76 | EntityC* entity_c; 77 | ValueObjectC* vo_c; 78 | void Init(){ 79 | entity_b = new EntityB(); 80 | entity_b->init(); 81 | router->Selete(); 82 | entity_c = new EntityC(); 83 | entity_c->init(); 84 | }; 85 | }; 86 | 87 | class AggregateRootB: public AggregateRootA 88 | { 89 | public: 90 | AggregateRootB(){}; 91 | ~AggregateRootB(){}; 92 | }; 93 | 94 | } -------------------------------------------------------------------------------- /adapter/CPPCallListener.go: -------------------------------------------------------------------------------- 1 | package adapter 2 | 3 | import ( 4 | . "../language/cplus" 5 | "fmt" 6 | ) 7 | 8 | func NewCPPCallListener() *CPPCallListener { 9 | return &CPPCallListener{} 10 | } 11 | 12 | type CPPCallListener struct { 13 | BaseCPP14Listener 14 | } 15 | 16 | func (s *CPPCallListener) EnterNamespacename(ctx *NamespacenameContext) { 17 | fmt.Println(ctx.GetText()) 18 | } 19 | 20 | func (s *CPPCallListener) EnterClassname(ctx *ClassnameContext) { 21 | fmt.Println(ctx.Identifier().GetText()) 22 | } 23 | 24 | func (s *CPPCallListener) EnterFunctiondefinition(ctx *FunctiondefinitionContext) { 25 | if ctx.Declspecifierseq() != nil { 26 | fmt.Println(ctx.Declspecifierseq().GetText()) 27 | } 28 | fmt.Println(ctx.Declarator().GetText()) 29 | } 30 | 31 | func (s *CPPCallListener) EnterFunctionbody(ctx *FunctionbodyContext) { 32 | 33 | } 34 | 35 | // swap(a,b) 36 | func (s *CPPCallListener) EnterAssignmentexpression(ctx *AssignmentexpressionContext) { 37 | //fmt.Println(ctx.GetText()) 38 | } 39 | 40 | func (s *CPPCallListener) EnterLogicalorexpression(ctx *LogicalorexpressionContext) { 41 | //fmt.Println(ctx.GetText()) 42 | } 43 | 44 | func (s *CPPCallListener) EnterUnaryexpression(ctx *UnaryexpressionContext) { 45 | //fmt.Println(ctx.GetText()) 46 | } 47 | 48 | func (s *CPPCallListener) EnterPostfixexpression(ctx *PostfixexpressionContext) { 49 | postfixExpression := ctx.Postfixexpression() 50 | expressionList := ctx.Expressionlist() 51 | 52 | if postfixExpression != nil && expressionList != nil { 53 | fmt.Println("postfixExpression: -> " + postfixExpression.GetText()) 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /examples/step2-code/code.h: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | namespace Domain { 4 | class Entity 5 | { 6 | public: 7 | int Id; 8 | }; 9 | 10 | class AggregateRoot: public Entity 11 | { 12 | }; 13 | 14 | 15 | class ValueObject 16 | { 17 | }; 18 | 19 | class Provider 20 | { 21 | 22 | }; 23 | 24 | class Router: public Provider 25 | { 26 | public: 27 | virtual int Selete() = 0; 28 | }; 29 | 30 | static Router* router; 31 | 32 | class ValueObjectC: public ValueObject 33 | { 34 | public: 35 | ValueObjectC(){}; 36 | ~ValueObjectC(){}; 37 | 38 | }; 39 | 40 | class ValueObjectD: public ValueObject 41 | { 42 | public: 43 | ValueObjectD(){}; 44 | ~ValueObjectD(){}; 45 | 46 | }; 47 | 48 | class EntityB: public Entity 49 | { 50 | public: 51 | EntityB(){}; 52 | ~EntityB(){}; 53 | ValueObjectD* vo_d; 54 | 55 | }; 56 | 57 | class AggregateRootA: public AggregateRoot 58 | { 59 | public: 60 | AggregateRootA(){}; 61 | ~AggregateRootA(){}; 62 | EntityB* entity_b; 63 | ValueObjectC* vo_c; 64 | void Init(){ 65 | router->Selete(); 66 | }; 67 | }; 68 | 69 | class AggregateRootB: public AggregateRoot 70 | { 71 | public: 72 | AggregateRootB(){}; 73 | ~AggregateRootB(){}; 74 | AggregateRootA* a; 75 | }; 76 | 77 | } 78 | 79 | namespace Repositories { 80 | using namespace Domain; 81 | 82 | class Repository{ 83 | }; 84 | 85 | class AggregateRootARepo: public Repository 86 | { 87 | public: 88 | AggregateRootARepo(){}; 89 | ~AggregateRootARepo(){}; 90 | void Save(AggregateRootA *a){ 91 | a->Init(); 92 | std::cout << "saved" << "\n"; 93 | }; 94 | private: 95 | std::vector ar_list; 96 | }; 97 | 98 | } 99 | 100 | namespace Gateways { 101 | using namespace Domain; 102 | 103 | class FakeRouter: public Router 104 | { 105 | public: 106 | FakeRouter(){}; 107 | ~FakeRouter(){}; 108 | int Selete(){ 109 | std::cout << "routed" << "\n"; 110 | return 1; 111 | } 112 | }; 113 | 114 | } -------------------------------------------------------------------------------- /examples/bc-code/test/app_test.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "../include/interface/api.h" 3 | #include "../include/services/service.h" 4 | #include "../include/repositories/repository.h" 5 | #include "Hypodermic/ContainerBuilder.h" 6 | 7 | using namespace Hypodermic; 8 | using namespace domain; 9 | using namespace repositories; 10 | using namespace services; 11 | 12 | struct StubCargoProvider : services::CargoProvider{ 13 | int cargo_id; 14 | int after_days; 15 | virtual void Confirm(Cargo *cargo) override; 16 | }; 17 | 18 | static const int ID = 1; 19 | static const int AFTER_DAYS = 10; 20 | 21 | //StubCargoProvider* provider = new StubCargoProvider(); 22 | auto provider = std::make_shared< StubCargoProvider >(); 23 | 24 | api::Api* createApi() { 25 | ContainerBuilder builder; 26 | builder.registerType< CargoRepository >().singleInstance(); 27 | builder.registerInstance(provider).as(); 28 | builder.registerType< CargoService >().singleInstance(); 29 | builder.registerType().singleInstance(); 30 | 31 | auto container = builder.build(); 32 | 33 | std::shared_ptr api = container->resolve(); 34 | 35 | return api.get(); 36 | } 37 | 38 | void createCargo(api::CreateCargoMsg* msg) { 39 | api::Api* api = createApi(); 40 | api->CreateCargo(msg); 41 | } 42 | 43 | TEST(bc_demo_test, create_cargo) 44 | { 45 | api::CreateCargoMsg* msg = new api::CreateCargoMsg(); 46 | msg->Id = ID; 47 | msg->AfterDays = AFTER_DAYS; 48 | createCargo(msg); 49 | EXPECT_EQ(msg->Id, provider->cargo_id); 50 | EXPECT_EQ(msg->AfterDays, provider->after_days); 51 | } 52 | 53 | TEST(bc_demo_test, delay_cargo) 54 | { 55 | api::Api* api = createApi(); 56 | api::CreateCargoMsg* msg = new api::CreateCargoMsg(); 57 | msg->Id = ID; 58 | msg->AfterDays = AFTER_DAYS; 59 | api->CreateCargo(msg); 60 | api->Delay(ID,2); 61 | EXPECT_EQ(ID, provider->cargo_id); 62 | EXPECT_EQ(12, provider->after_days); 63 | } 64 | 65 | 66 | void StubCargoProvider::Confirm(Cargo *cargo) { 67 | this->cargo_id = cargo->getId(); 68 | this->after_days = cargo->afterDays(); 69 | } 70 | -------------------------------------------------------------------------------- /examples/step3-code/code.h: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | namespace Domain { 4 | class Entity 5 | { 6 | public: 7 | int Id; 8 | }; 9 | 10 | class AggregateRoot: public Entity 11 | { 12 | }; 13 | 14 | 15 | class ValueObject 16 | { 17 | }; 18 | 19 | class Provider 20 | { 21 | 22 | }; 23 | 24 | class Router: public Provider 25 | { 26 | public: 27 | virtual int Selete() = 0; 28 | }; 29 | 30 | static Router* router; 31 | 32 | class ValueObjectC: public ValueObject 33 | { 34 | public: 35 | ValueObjectC(){}; 36 | ~ValueObjectC(){}; 37 | 38 | }; 39 | 40 | class ValueObjectD: public ValueObject 41 | { 42 | public: 43 | ValueObjectD(){}; 44 | ~ValueObjectD(){}; 45 | 46 | }; 47 | 48 | class EntityB: public Entity 49 | { 50 | public: 51 | EntityB(){}; 52 | ~EntityB(){}; 53 | ValueObjectD* vo_d; 54 | void init(){ 55 | vo_d = new ValueObjectD(); 56 | std::cout << "entity b init" << "\n"; 57 | }; 58 | }; 59 | 60 | class AggregateRootA: public AggregateRoot 61 | { 62 | public: 63 | AggregateRootA(){}; 64 | ~AggregateRootA(){}; 65 | EntityB* entity_b; 66 | ValueObjectC* vo_c; 67 | void Init(){ 68 | entity_b = new EntityB(); 69 | entity_b->init(); 70 | router->Selete(); 71 | }; 72 | }; 73 | 74 | class AggregateRootB: public AggregateRoot 75 | { 76 | public: 77 | AggregateRootB(){}; 78 | ~AggregateRootB(){}; 79 | EntityB* entity_b; 80 | AggregateRootA* a; 81 | void Init(){ 82 | a = new AggregateRootA(); 83 | a->Init(); 84 | a->entity_b->init(); 85 | }; 86 | }; 87 | 88 | } 89 | 90 | namespace Repositories { 91 | using namespace Domain; 92 | 93 | class Repository{ 94 | }; 95 | 96 | class AggregateRootARepo: public Repository 97 | { 98 | public: 99 | AggregateRootARepo(){}; 100 | ~AggregateRootARepo(){}; 101 | void Save(AggregateRootA *a){ 102 | a->Init(); 103 | std::cout << "saved" << "\n"; 104 | }; 105 | }; 106 | 107 | } 108 | 109 | namespace Gateways { 110 | using namespace Domain; 111 | 112 | class FakeRouter: public Router 113 | { 114 | public: 115 | FakeRouter(){}; 116 | ~FakeRouter(){}; 117 | int Selete(){ 118 | std::cout << "routed" << "\n"; 119 | return 1; 120 | } 121 | }; 122 | 123 | } -------------------------------------------------------------------------------- /examples/subdomain-code/code.h: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | namespace subdomain1{ 4 | namespace Domain { 5 | class Entity 6 | { 7 | public: 8 | int Id; 9 | }; 10 | 11 | class AggregateRoot: public Entity 12 | { 13 | }; 14 | 15 | 16 | class ValueObject 17 | { 18 | }; 19 | 20 | class Provider 21 | { 22 | 23 | }; 24 | 25 | class Router: public Provider 26 | { 27 | public: 28 | virtual int Selete() = 0; 29 | }; 30 | 31 | static Router* router; 32 | 33 | class ValueObjectC: public ValueObject 34 | { 35 | public: 36 | ValueObjectC(){}; 37 | ~ValueObjectC(){}; 38 | 39 | }; 40 | 41 | class ValueObjectD: public ValueObject 42 | { 43 | public: 44 | ValueObjectD(){}; 45 | ~ValueObjectD(){}; 46 | 47 | }; 48 | 49 | class EntityB: public Entity 50 | { 51 | public: 52 | EntityB(){}; 53 | ~EntityB(){}; 54 | ValueObjectD* vo_d; 55 | void init(){ 56 | vo_d = new ValueObjectD(); 57 | std::cout << "entity b init" << "\n"; 58 | }; 59 | }; 60 | 61 | class AggregateRootA: public AggregateRoot 62 | { 63 | public: 64 | AggregateRootA(){}; 65 | ~AggregateRootA(){}; 66 | EntityB* entity_b; 67 | ValueObjectC* vo_c; 68 | void Init(){ 69 | entity_b = new EntityB(); 70 | entity_b->init(); 71 | router->Selete(); 72 | }; 73 | }; 74 | 75 | class AggregateRootB: public AggregateRoot 76 | { 77 | public: 78 | AggregateRootB(){}; 79 | ~AggregateRootB(){}; 80 | AggregateRootA* a; 81 | }; 82 | 83 | 84 | } 85 | 86 | namespace Repositories { 87 | using namespace Domain; 88 | 89 | class Repository{ 90 | }; 91 | 92 | class AggregateRootARepo: public Repository 93 | { 94 | public: 95 | AggregateRootARepo(){}; 96 | ~AggregateRootARepo(){}; 97 | void Save(AggregateRootA *a){ 98 | a->Init(); 99 | std::cout << "saved" << "\n"; 100 | }; 101 | }; 102 | 103 | } 104 | 105 | namespace Gateways { 106 | using namespace Domain; 107 | 108 | class FakeRouter: public Router 109 | { 110 | public: 111 | FakeRouter(){}; 112 | ~FakeRouter(){}; 113 | int Selete(){ 114 | std::cout << "routed" << "\n"; 115 | return 1; 116 | } 117 | }; 118 | 119 | } 120 | } 121 | 122 | namespace subdomain2 { 123 | namespace Domain { 124 | class Entity 125 | { 126 | public: 127 | int Id; 128 | }; 129 | 130 | class AggregateRoot: public Entity 131 | { 132 | }; 133 | 134 | 135 | class ValueObject 136 | { 137 | }; 138 | class EntityC: public Entity 139 | { 140 | public: 141 | EntityC(){}; 142 | ~EntityC(){}; 143 | }; 144 | 145 | class AggregateRootC: public AggregateRoot 146 | { 147 | public: 148 | AggregateRootC(){}; 149 | ~AggregateRootC(){}; 150 | EntityC* entity_c; 151 | }; 152 | } 153 | } -------------------------------------------------------------------------------- /language/cplus/CPP14.g4: -------------------------------------------------------------------------------- 1 | /******************************************************************************* 2 | * The MIT License (MIT) 3 | * 4 | * Copyright (c) 2015 Camilo Sanchez (Camiloasc1) 5 | * 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy 7 | * of this software and associated documentation files (the "Software"), to deal 8 | * in the Software without restriction, including without limitation the rights 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | * copies of the Software, and to permit persons to whom the Software is 11 | * furnished to do so, subject to the following conditions: 12 | * 13 | * The above copyright notice and this permission notice shall be included in all 14 | * copies or substantial portions of the Software. 15 | * 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | * SOFTWARE. 23 | ******************************************************************************/ 24 | grammar CPP14; 25 | /*Basic concepts*/ 26 | 27 | 28 | translationunit 29 | : declarationseq? EOF 30 | ; 31 | /*Expressions*/ 32 | 33 | 34 | primaryexpression 35 | : literal 36 | | This 37 | | '(' expression ')' 38 | | idexpression 39 | | lambdaexpression 40 | ; 41 | 42 | idexpression 43 | : unqualifiedid 44 | | qualifiedid 45 | ; 46 | 47 | unqualifiedid 48 | : Identifier 49 | | operatorfunctionid 50 | | conversionfunctionid 51 | | literaloperatorid 52 | | '~' classname 53 | | '~' decltypespecifier 54 | | templateid 55 | ; 56 | 57 | qualifiedid 58 | : nestednamespecifier Template? unqualifiedid 59 | ; 60 | 61 | nestednamespecifier 62 | : '::' 63 | | thetypename '::' 64 | | namespacename '::' 65 | | decltypespecifier '::' 66 | | nestednamespecifier Identifier '::' 67 | | nestednamespecifier Template? simpletemplateid '::' 68 | ; 69 | 70 | lambdaexpression 71 | : lambdaintroducer lambdadeclarator? compoundstatement 72 | ; 73 | 74 | lambdaintroducer 75 | : '[' lambdacapture? ']' 76 | ; 77 | 78 | lambdacapture 79 | : capturedefault 80 | | capturelist 81 | | capturedefault ',' capturelist 82 | ; 83 | 84 | capturedefault 85 | : '&' 86 | | '=' 87 | ; 88 | 89 | capturelist 90 | : capture '...'? 91 | | capturelist ',' capture '...'? 92 | ; 93 | 94 | capture 95 | : simplecapture 96 | | initcapture 97 | ; 98 | 99 | simplecapture 100 | : Identifier 101 | | '&' Identifier 102 | | This 103 | ; 104 | 105 | initcapture 106 | : Identifier initializer 107 | | '&' Identifier initializer 108 | ; 109 | 110 | lambdadeclarator 111 | : '(' parameterdeclarationclause ')' Mutable? exceptionspecification? attributespecifierseq? trailingreturntype? 112 | ; 113 | 114 | postfixexpression 115 | : primaryexpression 116 | | postfixexpression '[' expression ']' 117 | | postfixexpression '[' bracedinitlist ']' 118 | | postfixexpression '(' expressionlist? ')' 119 | | simpletypespecifier '(' expressionlist? ')' 120 | | typenamespecifier '(' expressionlist? ')' 121 | | simpletypespecifier bracedinitlist 122 | | typenamespecifier bracedinitlist 123 | | postfixexpression '.' Template? idexpression 124 | | postfixexpression '->' Template? idexpression 125 | | postfixexpression '.' pseudodestructorname 126 | | postfixexpression '->' pseudodestructorname 127 | | postfixexpression '++' 128 | | postfixexpression '--' 129 | | Dynamic_cast '<' thetypeid '>' '(' expression ')' 130 | | Static_cast '<' thetypeid '>' '(' expression ')' 131 | | Reinterpret_cast '<' thetypeid '>' '(' expression ')' 132 | | Const_cast '<' thetypeid '>' '(' expression ')' 133 | | typeidofthetypeid '(' expression ')' 134 | | typeidofthetypeid '(' thetypeid ')' 135 | ; 136 | /* 137 | add a middle layer to eliminate duplicated function declarations 138 | */ 139 | 140 | 141 | typeidofexpr 142 | : Typeid_ 143 | ; 144 | 145 | typeidofthetypeid 146 | : Typeid_ 147 | ; 148 | 149 | expressionlist 150 | : initializerlist 151 | ; 152 | 153 | pseudodestructorname 154 | : nestednamespecifier? thetypename '::' '~' thetypename 155 | | nestednamespecifier Template simpletemplateid '::' '~' thetypename 156 | | nestednamespecifier? '~' thetypename 157 | | '~' decltypespecifier 158 | ; 159 | 160 | unaryexpression 161 | : postfixexpression 162 | | '++' castexpression 163 | | '--' castexpression 164 | | unaryoperator castexpression 165 | | Sizeof unaryexpression 166 | | Sizeof '(' thetypeid ')' 167 | | Sizeof '...' '(' Identifier ')' 168 | | Alignof '(' thetypeid ')' 169 | | noexceptexpression 170 | | newexpression 171 | | deleteexpression 172 | ; 173 | 174 | unaryoperator 175 | : '|' 176 | | '*' 177 | | '&' 178 | | '+' 179 | | '!' 180 | | '~' 181 | | '-' 182 | | 'not' 183 | ; 184 | 185 | newexpression 186 | : '::'? New newplacement? newtypeid newinitializer? 187 | | '::'? New newplacement? '(' thetypeid ')' newinitializer? 188 | ; 189 | 190 | newplacement 191 | : '(' expressionlist ')' 192 | ; 193 | 194 | newtypeid 195 | : typespecifierseq newdeclarator? 196 | ; 197 | 198 | newdeclarator 199 | : ptroperator newdeclarator? 200 | | noptrnewdeclarator 201 | ; 202 | 203 | noptrnewdeclarator 204 | : '[' expression ']' attributespecifierseq? 205 | | noptrnewdeclarator '[' constantexpression ']' attributespecifierseq? 206 | ; 207 | 208 | newinitializer 209 | : '(' expressionlist? ')' 210 | | bracedinitlist 211 | ; 212 | 213 | deleteexpression 214 | : '::'? Delete castexpression 215 | | '::'? Delete '[' ']' castexpression 216 | ; 217 | 218 | noexceptexpression 219 | : Noexcept '(' expression ')' 220 | ; 221 | 222 | castexpression 223 | : unaryexpression 224 | | '(' thetypeid ')' castexpression 225 | ; 226 | 227 | pmexpression 228 | : castexpression 229 | | pmexpression '.*' castexpression 230 | | pmexpression '->*' castexpression 231 | ; 232 | 233 | multiplicativeexpression 234 | : pmexpression 235 | | multiplicativeexpression '*' pmexpression 236 | | multiplicativeexpression '/' pmexpression 237 | | multiplicativeexpression '%' pmexpression 238 | ; 239 | 240 | additiveexpression 241 | : multiplicativeexpression 242 | | additiveexpression '+' multiplicativeexpression 243 | | additiveexpression '-' multiplicativeexpression 244 | ; 245 | 246 | shiftexpression 247 | : additiveexpression 248 | | shiftexpression shiftoperator additiveexpression 249 | ; 250 | 251 | shiftoperator 252 | : RightShift 253 | | LeftShift 254 | ; 255 | 256 | relationalexpression 257 | : shiftexpression 258 | | relationalexpression '<' shiftexpression 259 | | relationalexpression '>' shiftexpression 260 | | relationalexpression '<=' shiftexpression 261 | | relationalexpression '>=' shiftexpression 262 | ; 263 | 264 | equalityexpression 265 | : relationalexpression 266 | | equalityexpression '==' relationalexpression 267 | | equalityexpression '!=' relationalexpression 268 | ; 269 | 270 | andexpression 271 | : equalityexpression 272 | | andexpression '&' equalityexpression 273 | ; 274 | 275 | exclusiveorexpression 276 | : andexpression 277 | | exclusiveorexpression '^' andexpression 278 | ; 279 | 280 | inclusiveorexpression 281 | : exclusiveorexpression 282 | | inclusiveorexpression '|' exclusiveorexpression 283 | ; 284 | 285 | logicalandexpression 286 | : inclusiveorexpression 287 | | logicalandexpression '&&' inclusiveorexpression 288 | | logicalandexpression 'and' inclusiveorexpression 289 | ; 290 | 291 | logicalorexpression 292 | : logicalandexpression 293 | | logicalorexpression '||' logicalandexpression 294 | | logicalorexpression 'or' logicalandexpression 295 | ; 296 | 297 | conditionalexpression 298 | : logicalorexpression 299 | | logicalorexpression '?' expression ':' assignmentexpression 300 | ; 301 | 302 | assignmentexpression 303 | : conditionalexpression 304 | | logicalorexpression assignmentoperator initializerclause 305 | | throwexpression 306 | ; 307 | 308 | assignmentoperator 309 | : '=' 310 | | '*=' 311 | | '/=' 312 | | '%=' 313 | | '+=' 314 | | '-=' 315 | | RightShiftAssign 316 | | LeftShiftAssign 317 | | '&=' 318 | | '^=' 319 | | '|=' 320 | ; 321 | 322 | expression 323 | : assignmentexpression 324 | | expression ',' assignmentexpression 325 | ; 326 | 327 | constantexpression 328 | : conditionalexpression 329 | ; 330 | /*Statements*/ 331 | 332 | 333 | statement 334 | : labeledstatement 335 | | attributespecifierseq? expressionstatement 336 | | attributespecifierseq? compoundstatement 337 | | attributespecifierseq? selectionstatement 338 | | attributespecifierseq? iterationstatement 339 | | attributespecifierseq? jumpstatement 340 | | declarationstatement 341 | | attributespecifierseq? tryblock 342 | ; 343 | 344 | labeledstatement 345 | : attributespecifierseq? Identifier ':' statement 346 | | attributespecifierseq? Case constantexpression ':' statement 347 | | attributespecifierseq? Default ':' statement 348 | ; 349 | 350 | expressionstatement 351 | : expression? ';' 352 | ; 353 | 354 | compoundstatement 355 | : '{' statementseq? '}' 356 | ; 357 | 358 | statementseq 359 | : statement 360 | | statementseq statement 361 | ; 362 | 363 | selectionstatement 364 | : If '(' condition ')' statement 365 | | If '(' condition ')' statement Else statement 366 | | Switch '(' condition ')' statement 367 | ; 368 | 369 | condition 370 | : expression 371 | | attributespecifierseq? declspecifierseq declarator '=' initializerclause 372 | | attributespecifierseq? declspecifierseq declarator bracedinitlist 373 | ; 374 | 375 | iterationstatement 376 | : While '(' condition ')' statement 377 | | Do statement While '(' expression ')' ';' 378 | | For '(' forinitstatement condition? ';' expression? ')' statement 379 | | For '(' forrangedeclaration ':' forrangeinitializer ')' statement 380 | ; 381 | 382 | forinitstatement 383 | : expressionstatement 384 | | simpledeclaration 385 | ; 386 | 387 | forrangedeclaration 388 | : attributespecifierseq? declspecifierseq declarator 389 | ; 390 | 391 | forrangeinitializer 392 | : expression 393 | | bracedinitlist 394 | ; 395 | 396 | jumpstatement 397 | : Break ';' 398 | | Continue ';' 399 | | Return expression? ';' 400 | | Return bracedinitlist ';' 401 | | Goto Identifier ';' 402 | ; 403 | 404 | declarationstatement 405 | : blockdeclaration 406 | ; 407 | /*Declarations*/ 408 | 409 | 410 | declarationseq 411 | : declaration 412 | | declarationseq declaration 413 | ; 414 | 415 | declaration 416 | : blockdeclaration 417 | | functiondefinition 418 | | templatedeclaration 419 | | explicitinstantiation 420 | | explicitspecialization 421 | | linkagespecification 422 | | namespacedefinition 423 | | emptydeclaration 424 | | attributedeclaration 425 | ; 426 | 427 | blockdeclaration 428 | : simpledeclaration 429 | | asmdefinition 430 | | namespacealiasdefinition 431 | | usingdeclaration 432 | | usingdirective 433 | | static_assertdeclaration 434 | | aliasdeclaration 435 | | opaqueenumdeclaration 436 | ; 437 | 438 | aliasdeclaration 439 | : Using Identifier attributespecifierseq? '=' thetypeid ';' 440 | ; 441 | 442 | simpledeclaration 443 | : declspecifierseq? initdeclaratorlist? ';' 444 | | attributespecifierseq declspecifierseq? initdeclaratorlist ';' 445 | ; 446 | 447 | static_assertdeclaration 448 | : Static_assert '(' constantexpression ',' Stringliteral ')' ';' 449 | ; 450 | 451 | emptydeclaration 452 | : ';' 453 | ; 454 | 455 | attributedeclaration 456 | : attributespecifierseq ';' 457 | ; 458 | 459 | declspecifier 460 | : storageclassspecifier 461 | | typespecifier 462 | | functionspecifier 463 | | Friend 464 | | Typedef 465 | | Constexpr 466 | ; 467 | 468 | declspecifierseq 469 | : declspecifier attributespecifierseq? 470 | | declspecifier declspecifierseq 471 | ; 472 | 473 | storageclassspecifier 474 | : Register 475 | | Static 476 | | Thread_local 477 | | Extern 478 | | Mutable 479 | ; 480 | 481 | functionspecifier 482 | : Inline 483 | | Virtual 484 | | Explicit 485 | ; 486 | 487 | typedefname 488 | : Identifier 489 | ; 490 | 491 | typespecifier 492 | : trailingtypespecifier 493 | | classspecifier 494 | | enumspecifier 495 | ; 496 | 497 | trailingtypespecifier 498 | : simpletypespecifier 499 | | elaboratedtypespecifier 500 | | typenamespecifier 501 | | cvqualifier 502 | ; 503 | 504 | typespecifierseq 505 | : typespecifier attributespecifierseq? 506 | | typespecifier typespecifierseq 507 | ; 508 | 509 | trailingtypespecifierseq 510 | : trailingtypespecifier attributespecifierseq? 511 | | trailingtypespecifier trailingtypespecifierseq 512 | ; 513 | 514 | simpletypespecifier 515 | : nestednamespecifier? thetypename 516 | | nestednamespecifier Template simpletemplateid 517 | | Char 518 | | Char16 519 | | Char32 520 | | Wchar 521 | | Bool 522 | | Short 523 | | Int 524 | | Long 525 | | Signed 526 | | Unsigned 527 | | Float 528 | | Double 529 | | Void 530 | | Auto 531 | | decltypespecifier 532 | ; 533 | 534 | thetypename 535 | : classname 536 | | enumname 537 | | typedefname 538 | | simpletemplateid 539 | ; 540 | 541 | decltypespecifier 542 | : Decltype '(' expression ')' 543 | | Decltype '(' Auto ')' 544 | ; 545 | 546 | elaboratedtypespecifier 547 | : classkey attributespecifierseq? nestednamespecifier? Identifier 548 | | classkey simpletemplateid 549 | | classkey nestednamespecifier Template? simpletemplateid 550 | | Enum nestednamespecifier? Identifier 551 | ; 552 | 553 | enumname 554 | : Identifier 555 | ; 556 | 557 | enumspecifier 558 | : enumhead '{' enumeratorlist? '}' 559 | | enumhead '{' enumeratorlist ',' '}' 560 | ; 561 | 562 | enumhead 563 | : enumkey attributespecifierseq? Identifier? enumbase? 564 | | enumkey attributespecifierseq? nestednamespecifier Identifier enumbase? 565 | ; 566 | 567 | opaqueenumdeclaration 568 | : enumkey attributespecifierseq? Identifier enumbase? ';' 569 | ; 570 | 571 | enumkey 572 | : Enum 573 | | Enum Class 574 | | Enum Struct 575 | ; 576 | 577 | enumbase 578 | : ':' typespecifierseq 579 | ; 580 | 581 | enumeratorlist 582 | : enumeratordefinition 583 | | enumeratorlist ',' enumeratordefinition 584 | ; 585 | 586 | enumeratordefinition 587 | : enumerator 588 | | enumerator '=' constantexpression 589 | ; 590 | 591 | enumerator 592 | : Identifier 593 | ; 594 | 595 | namespacename 596 | : originalnamespacename 597 | | namespacealias 598 | ; 599 | 600 | originalnamespacename 601 | : Identifier 602 | ; 603 | 604 | namespacedefinition 605 | : namednamespacedefinition 606 | | unnamednamespacedefinition 607 | ; 608 | 609 | namednamespacedefinition 610 | : originalnamespacedefinition 611 | | extensionnamespacedefinition 612 | ; 613 | 614 | originalnamespacedefinition 615 | : Inline? Namespace Identifier '{' namespacebody '}' 616 | ; 617 | 618 | extensionnamespacedefinition 619 | : Inline? Namespace originalnamespacename '{' namespacebody '}' 620 | ; 621 | 622 | unnamednamespacedefinition 623 | : Inline? Namespace '{' namespacebody '}' 624 | ; 625 | 626 | namespacebody 627 | : declarationseq? 628 | ; 629 | 630 | namespacealias 631 | : Identifier 632 | ; 633 | 634 | namespacealiasdefinition 635 | : Namespace Identifier '=' qualifiednamespacespecifier ';' 636 | ; 637 | 638 | qualifiednamespacespecifier 639 | : nestednamespecifier? namespacename 640 | ; 641 | 642 | usingdeclaration 643 | : Using Typename_? nestednamespecifier unqualifiedid ';' 644 | | Using '::' unqualifiedid ';' 645 | ; 646 | 647 | usingdirective 648 | : attributespecifierseq? Using Namespace nestednamespecifier? namespacename ';' 649 | ; 650 | 651 | asmdefinition 652 | : Asm '(' Stringliteral ')' ';' 653 | ; 654 | 655 | linkagespecification 656 | : Extern Stringliteral '{' declarationseq? '}' 657 | | Extern Stringliteral declaration 658 | ; 659 | 660 | attributespecifierseq 661 | : attributespecifier 662 | | attributespecifierseq attributespecifier 663 | ; 664 | 665 | attributespecifier 666 | : '[' '[' attributelist ']' ']' 667 | | alignmentspecifier 668 | ; 669 | 670 | alignmentspecifier 671 | : Alignas '(' thetypeid '...'? ')' 672 | | Alignas '(' constantexpression '...'? ')' 673 | ; 674 | 675 | attributelist 676 | : attribute? 677 | | attributelist ',' attribute? 678 | | attribute '...' 679 | | attributelist ',' attribute '...' 680 | ; 681 | 682 | attribute 683 | : attributetoken attributeargumentclause? 684 | ; 685 | 686 | attributetoken 687 | : Identifier 688 | | attributescopedtoken 689 | ; 690 | 691 | attributescopedtoken 692 | : attributenamespace '::' Identifier 693 | ; 694 | 695 | attributenamespace 696 | : Identifier 697 | ; 698 | 699 | attributeargumentclause 700 | : '(' balancedtokenseq ')' 701 | ; 702 | 703 | balancedtokenseq 704 | : balancedtoken? 705 | | balancedtokenseq balancedtoken 706 | ; 707 | 708 | balancedtoken 709 | : '(' balancedtokenseq ')' 710 | | '[' balancedtokenseq ']' 711 | | '{' balancedtokenseq '}' 712 | ; 713 | /*Declarators*/ 714 | 715 | 716 | initdeclaratorlist 717 | : initdeclarator 718 | | initdeclaratorlist ',' initdeclarator 719 | ; 720 | 721 | initdeclarator 722 | : declarator initializer? 723 | ; 724 | 725 | declarator 726 | : ptrdeclarator 727 | | noptrdeclarator parametersandqualifiers trailingreturntype 728 | ; 729 | 730 | ptrdeclarator 731 | : noptrdeclarator 732 | | ptroperator ptrdeclarator 733 | ; 734 | 735 | noptrdeclarator 736 | : declaratorid attributespecifierseq? 737 | | noptrdeclarator parametersandqualifiers 738 | | noptrdeclarator '[' constantexpression? ']' attributespecifierseq? 739 | | '(' ptrdeclarator ')' 740 | ; 741 | 742 | parametersandqualifiers 743 | : '(' parameterdeclarationclause ')' cvqualifierseq? refqualifier? exceptionspecification? attributespecifierseq? 744 | ; 745 | 746 | trailingreturntype 747 | : '->' trailingtypespecifierseq abstractdeclarator? 748 | ; 749 | 750 | ptroperator 751 | : '*' attributespecifierseq? cvqualifierseq? 752 | | '&' attributespecifierseq? 753 | | '&&' attributespecifierseq? 754 | | nestednamespecifier '*' attributespecifierseq? cvqualifierseq? 755 | ; 756 | 757 | cvqualifierseq 758 | : cvqualifier cvqualifierseq? 759 | ; 760 | 761 | cvqualifier 762 | : Const 763 | | Volatile 764 | ; 765 | 766 | refqualifier 767 | : '&' 768 | | '&&' 769 | ; 770 | 771 | declaratorid 772 | : '...'? idexpression 773 | ; 774 | 775 | thetypeid 776 | : typespecifierseq abstractdeclarator? 777 | ; 778 | 779 | abstractdeclarator 780 | : ptrabstractdeclarator 781 | | noptrabstractdeclarator? parametersandqualifiers trailingreturntype 782 | | abstractpackdeclarator 783 | ; 784 | 785 | ptrabstractdeclarator 786 | : noptrabstractdeclarator 787 | | ptroperator ptrabstractdeclarator? 788 | ; 789 | 790 | noptrabstractdeclarator 791 | : noptrabstractdeclarator parametersandqualifiers 792 | | parametersandqualifiers 793 | | noptrabstractdeclarator '[' constantexpression? ']' attributespecifierseq? 794 | | '[' constantexpression? ']' attributespecifierseq? 795 | | '(' ptrabstractdeclarator ')' 796 | ; 797 | 798 | abstractpackdeclarator 799 | : noptrabstractpackdeclarator 800 | | ptroperator abstractpackdeclarator 801 | ; 802 | 803 | noptrabstractpackdeclarator 804 | : noptrabstractpackdeclarator parametersandqualifiers 805 | | noptrabstractpackdeclarator '[' constantexpression? ']' attributespecifierseq? 806 | | '...' 807 | ; 808 | 809 | parameterdeclarationclause 810 | : parameterdeclarationlist? '...'? 811 | | parameterdeclarationlist ',' '...' 812 | ; 813 | 814 | parameterdeclarationlist 815 | : parameterdeclaration 816 | | parameterdeclarationlist ',' parameterdeclaration 817 | ; 818 | 819 | parameterdeclaration 820 | : attributespecifierseq? declspecifierseq declarator 821 | | attributespecifierseq? declspecifierseq declarator '=' initializerclause 822 | | attributespecifierseq? declspecifierseq abstractdeclarator? 823 | | attributespecifierseq? declspecifierseq abstractdeclarator? '=' initializerclause 824 | ; 825 | 826 | functiondefinition 827 | : attributespecifierseq? declspecifierseq? declarator virtspecifierseq? functionbody 828 | ; 829 | 830 | functionbody 831 | : ctorinitializer? compoundstatement 832 | | functiontryblock 833 | | '=' Default ';' 834 | | '=' Delete ';' 835 | ; 836 | 837 | initializer 838 | : braceorequalinitializer 839 | | '(' expressionlist ')' 840 | ; 841 | 842 | braceorequalinitializer 843 | : '=' initializerclause 844 | | bracedinitlist 845 | ; 846 | 847 | initializerclause 848 | : assignmentexpression 849 | | bracedinitlist 850 | ; 851 | 852 | initializerlist 853 | : initializerclause '...'? 854 | | initializerlist ',' initializerclause '...'? 855 | ; 856 | 857 | bracedinitlist 858 | : '{' initializerlist ','? '}' 859 | | '{' '}' 860 | ; 861 | /*Classes*/ 862 | 863 | 864 | classname 865 | : Identifier 866 | | simpletemplateid 867 | ; 868 | 869 | classspecifier 870 | : classhead '{' memberspecification? '}' 871 | ; 872 | 873 | classhead 874 | : classkey attributespecifierseq? classheadname classvirtspecifier? baseclause? 875 | | classkey attributespecifierseq? baseclause? 876 | ; 877 | 878 | classheadname 879 | : nestednamespecifier? classname 880 | ; 881 | 882 | classvirtspecifier 883 | : Final 884 | ; 885 | 886 | classkey 887 | : Class 888 | | Struct 889 | | Union 890 | ; 891 | 892 | memberspecification 893 | : memberdeclaration memberspecification? 894 | | accessspecifier ':' memberspecification? 895 | ; 896 | 897 | memberdeclaration 898 | : attributespecifierseq? declspecifierseq? memberdeclaratorlist? ';' 899 | | functiondefinition 900 | | usingdeclaration 901 | | static_assertdeclaration 902 | | templatedeclaration 903 | | aliasdeclaration 904 | | emptydeclaration 905 | ; 906 | 907 | memberdeclaratorlist 908 | : memberdeclarator 909 | | memberdeclaratorlist ',' memberdeclarator 910 | ; 911 | 912 | memberdeclarator 913 | : declarator virtspecifierseq? purespecifier? 914 | | declarator braceorequalinitializer? 915 | | Identifier? attributespecifierseq? ':' constantexpression 916 | ; 917 | 918 | virtspecifierseq 919 | : virtspecifier 920 | | virtspecifierseq virtspecifier 921 | ; 922 | 923 | virtspecifier 924 | : Override 925 | | Final 926 | ; 927 | /* 928 | purespecifier: 929 | '=' '0'//Conflicts with the lexer 930 | ; 931 | */ 932 | 933 | 934 | purespecifier 935 | : Assign val = Octalliteral 936 | {if($val.text.compareTo("0")!=0) throw new InputMismatchException(this);} 937 | ; 938 | /*Derived classes*/ 939 | 940 | 941 | baseclause 942 | : ':' basespecifierlist 943 | ; 944 | 945 | basespecifierlist 946 | : basespecifier '...'? 947 | | basespecifierlist ',' basespecifier '...'? 948 | ; 949 | 950 | basespecifier 951 | : attributespecifierseq? basetypespecifier 952 | | attributespecifierseq? Virtual accessspecifier? basetypespecifier 953 | | attributespecifierseq? accessspecifier Virtual? basetypespecifier 954 | ; 955 | 956 | classordecltype 957 | : nestednamespecifier? classname 958 | | decltypespecifier 959 | ; 960 | 961 | basetypespecifier 962 | : classordecltype 963 | ; 964 | 965 | accessspecifier 966 | : Private 967 | | Protected 968 | | Public 969 | ; 970 | /*Special member functions*/ 971 | 972 | 973 | conversionfunctionid 974 | : Operator conversiontypeid 975 | ; 976 | 977 | conversiontypeid 978 | : typespecifierseq conversiondeclarator? 979 | ; 980 | 981 | conversiondeclarator 982 | : ptroperator conversiondeclarator? 983 | ; 984 | 985 | ctorinitializer 986 | : ':' meminitializerlist 987 | ; 988 | 989 | meminitializerlist 990 | : meminitializer '...'? 991 | | meminitializer '...'? ',' meminitializerlist 992 | ; 993 | 994 | meminitializer 995 | : meminitializerid '(' expressionlist? ')' 996 | | meminitializerid bracedinitlist 997 | ; 998 | 999 | meminitializerid 1000 | : classordecltype 1001 | | Identifier 1002 | ; 1003 | /*Overloading*/ 1004 | 1005 | 1006 | operatorfunctionid 1007 | : Operator theoperator 1008 | ; 1009 | 1010 | literaloperatorid 1011 | : Operator Stringliteral Identifier 1012 | | Operator Userdefinedstringliteral 1013 | ; 1014 | /*Templates*/ 1015 | 1016 | 1017 | templatedeclaration 1018 | : Template '<' templateparameterlist '>' declaration 1019 | ; 1020 | 1021 | templateparameterlist 1022 | : templateparameter 1023 | | templateparameterlist ',' templateparameter 1024 | ; 1025 | 1026 | templateparameter 1027 | : typeparameter 1028 | | parameterdeclaration 1029 | ; 1030 | 1031 | typeparameter 1032 | : Class '...'? Identifier? 1033 | | Class Identifier? '=' thetypeid 1034 | | Typename_ '...'? Identifier? 1035 | | Typename_ Identifier? '=' thetypeid 1036 | | Template '<' templateparameterlist '>' Class '...'? Identifier? 1037 | | Template '<' templateparameterlist '>' Class Identifier? '=' idexpression 1038 | ; 1039 | 1040 | simpletemplateid 1041 | : templatename '<' templateargumentlist? '>' 1042 | ; 1043 | 1044 | templateid 1045 | : simpletemplateid 1046 | | operatorfunctionid '<' templateargumentlist? '>' 1047 | | literaloperatorid '<' templateargumentlist? '>' 1048 | ; 1049 | 1050 | templatename 1051 | : Identifier 1052 | ; 1053 | 1054 | templateargumentlist 1055 | : templateargument '...'? 1056 | | templateargumentlist ',' templateargument '...'? 1057 | ; 1058 | 1059 | templateargument 1060 | : thetypeid 1061 | | constantexpression 1062 | | idexpression 1063 | ; 1064 | 1065 | typenamespecifier 1066 | : Typename_ nestednamespecifier Identifier 1067 | | Typename_ nestednamespecifier Template? simpletemplateid 1068 | ; 1069 | 1070 | explicitinstantiation 1071 | : Extern? Template declaration 1072 | ; 1073 | 1074 | explicitspecialization 1075 | : Template '<' '>' declaration 1076 | ; 1077 | /*Exception handling*/ 1078 | 1079 | 1080 | tryblock 1081 | : Try compoundstatement handlerseq 1082 | ; 1083 | 1084 | functiontryblock 1085 | : Try ctorinitializer? compoundstatement handlerseq 1086 | ; 1087 | 1088 | handlerseq 1089 | : handler handlerseq? 1090 | ; 1091 | 1092 | handler 1093 | : Catch '(' exceptiondeclaration ')' compoundstatement 1094 | ; 1095 | 1096 | exceptiondeclaration 1097 | : attributespecifierseq? typespecifierseq declarator 1098 | | attributespecifierseq? typespecifierseq abstractdeclarator? 1099 | | '...' 1100 | ; 1101 | 1102 | throwexpression 1103 | : Throw assignmentexpression? 1104 | ; 1105 | 1106 | exceptionspecification 1107 | : dynamicexceptionspecification 1108 | | noexceptspecification 1109 | ; 1110 | 1111 | dynamicexceptionspecification 1112 | : Throw '(' typeidlist? ')' 1113 | ; 1114 | 1115 | typeidlist 1116 | : thetypeid '...'? 1117 | | typeidlist ',' thetypeid '...'? 1118 | ; 1119 | 1120 | noexceptspecification 1121 | : Noexcept '(' constantexpression ')' 1122 | | Noexcept 1123 | ; 1124 | /*Preprocessing directives*/ 1125 | 1126 | 1127 | MultiLineMacro 1128 | : '#' (~ [\n]*? '\\' '\r'? '\n')+ ~ [\n]+ -> channel (HIDDEN) 1129 | ; 1130 | 1131 | Directive 1132 | : '#' ~ [\n]* -> channel (HIDDEN) 1133 | ; 1134 | /*Lexer*/ 1135 | 1136 | /*Keywords*/ 1137 | 1138 | 1139 | Alignas 1140 | : 'alignas' 1141 | ; 1142 | 1143 | Alignof 1144 | : 'alignof' 1145 | ; 1146 | 1147 | Asm 1148 | : 'asm' 1149 | ; 1150 | 1151 | Auto 1152 | : 'auto' 1153 | ; 1154 | 1155 | Bool 1156 | : 'bool' 1157 | ; 1158 | 1159 | Break 1160 | : 'break' 1161 | ; 1162 | 1163 | Case 1164 | : 'case' 1165 | ; 1166 | 1167 | Catch 1168 | : 'catch' 1169 | ; 1170 | 1171 | Char 1172 | : 'char' 1173 | ; 1174 | 1175 | Char16 1176 | : 'char16_t' 1177 | ; 1178 | 1179 | Char32 1180 | : 'char32_t' 1181 | ; 1182 | 1183 | Class 1184 | : 'class' 1185 | ; 1186 | 1187 | Const 1188 | : 'const' 1189 | ; 1190 | 1191 | Constexpr 1192 | : 'constexpr' 1193 | ; 1194 | 1195 | Const_cast 1196 | : 'const_cast' 1197 | ; 1198 | 1199 | Continue 1200 | : 'continue' 1201 | ; 1202 | 1203 | Decltype 1204 | : 'decltype' 1205 | ; 1206 | 1207 | Default 1208 | : 'default' 1209 | ; 1210 | 1211 | Delete 1212 | : 'delete' 1213 | ; 1214 | 1215 | Do 1216 | : 'do' 1217 | ; 1218 | 1219 | Double 1220 | : 'double' 1221 | ; 1222 | 1223 | Dynamic_cast 1224 | : 'dynamic_cast' 1225 | ; 1226 | 1227 | Else 1228 | : 'else' 1229 | ; 1230 | 1231 | Enum 1232 | : 'enum' 1233 | ; 1234 | 1235 | Explicit 1236 | : 'explicit' 1237 | ; 1238 | 1239 | Export 1240 | : 'export' 1241 | ; 1242 | 1243 | Extern 1244 | : 'extern' 1245 | ; 1246 | 1247 | False 1248 | : 'false' 1249 | ; 1250 | 1251 | Final 1252 | : 'final' 1253 | ; 1254 | 1255 | Float 1256 | : 'float' 1257 | ; 1258 | 1259 | For 1260 | : 'for' 1261 | ; 1262 | 1263 | Friend 1264 | : 'friend' 1265 | ; 1266 | 1267 | Goto 1268 | : 'goto' 1269 | ; 1270 | 1271 | If 1272 | : 'if' 1273 | ; 1274 | 1275 | Inline 1276 | : 'inline' 1277 | ; 1278 | 1279 | Int 1280 | : 'int' 1281 | ; 1282 | 1283 | Long 1284 | : 'long' 1285 | ; 1286 | 1287 | Mutable 1288 | : 'mutable' 1289 | ; 1290 | 1291 | Namespace 1292 | : 'namespace' 1293 | ; 1294 | 1295 | New 1296 | : 'new' 1297 | ; 1298 | 1299 | Noexcept 1300 | : 'noexcept' 1301 | ; 1302 | 1303 | Nullptr 1304 | : 'nullptr' 1305 | ; 1306 | 1307 | Operator 1308 | : 'operator' 1309 | ; 1310 | 1311 | Override 1312 | : 'override' 1313 | ; 1314 | 1315 | Private 1316 | : 'private' 1317 | ; 1318 | 1319 | Protected 1320 | : 'protected' 1321 | ; 1322 | 1323 | Public 1324 | : 'public' 1325 | ; 1326 | 1327 | Register 1328 | : 'register' 1329 | ; 1330 | 1331 | Reinterpret_cast 1332 | : 'reinterpret_cast' 1333 | ; 1334 | 1335 | Return 1336 | : 'return' 1337 | ; 1338 | 1339 | Short 1340 | : 'short' 1341 | ; 1342 | 1343 | Signed 1344 | : 'signed' 1345 | ; 1346 | 1347 | Sizeof 1348 | : 'sizeof' 1349 | ; 1350 | 1351 | Static 1352 | : 'static' 1353 | ; 1354 | 1355 | Static_assert 1356 | : 'static_assert' 1357 | ; 1358 | 1359 | Static_cast 1360 | : 'static_cast' 1361 | ; 1362 | 1363 | Struct 1364 | : 'struct' 1365 | ; 1366 | 1367 | Switch 1368 | : 'switch' 1369 | ; 1370 | 1371 | Template 1372 | : 'template' 1373 | ; 1374 | 1375 | This 1376 | : 'this' 1377 | ; 1378 | 1379 | Thread_local 1380 | : 'thread_local' 1381 | ; 1382 | 1383 | Throw 1384 | : 'throw' 1385 | ; 1386 | 1387 | True 1388 | : 'true' 1389 | ; 1390 | 1391 | Try 1392 | : 'try' 1393 | ; 1394 | 1395 | Typedef 1396 | : 'typedef' 1397 | ; 1398 | 1399 | Typeid_ 1400 | : 'typeid' 1401 | ; 1402 | 1403 | Typename_ 1404 | : 'typename' 1405 | ; 1406 | 1407 | Union 1408 | : 'union' 1409 | ; 1410 | 1411 | Unsigned 1412 | : 'unsigned' 1413 | ; 1414 | 1415 | Using 1416 | : 'using' 1417 | ; 1418 | 1419 | Virtual 1420 | : 'virtual' 1421 | ; 1422 | 1423 | Void 1424 | : 'void' 1425 | ; 1426 | 1427 | Volatile 1428 | : 'volatile' 1429 | ; 1430 | 1431 | Wchar 1432 | : 'wchar_t' 1433 | ; 1434 | 1435 | While 1436 | : 'while' 1437 | ; 1438 | /*Operators*/ 1439 | 1440 | 1441 | LeftParen 1442 | : '(' 1443 | ; 1444 | 1445 | RightParen 1446 | : ')' 1447 | ; 1448 | 1449 | LeftBracket 1450 | : '[' 1451 | ; 1452 | 1453 | RightBracket 1454 | : ']' 1455 | ; 1456 | 1457 | LeftBrace 1458 | : '{' 1459 | ; 1460 | 1461 | RightBrace 1462 | : '}' 1463 | ; 1464 | 1465 | Plus 1466 | : '+' 1467 | ; 1468 | 1469 | Minus 1470 | : '-' 1471 | ; 1472 | 1473 | Star 1474 | : '*' 1475 | ; 1476 | 1477 | Div 1478 | : '/' 1479 | ; 1480 | 1481 | Mod 1482 | : '%' 1483 | ; 1484 | 1485 | Caret 1486 | : '^' 1487 | ; 1488 | 1489 | And 1490 | : '&' 1491 | ; 1492 | 1493 | Or 1494 | : '|' 1495 | ; 1496 | 1497 | Tilde 1498 | : '~' 1499 | ; 1500 | 1501 | Not 1502 | : '!' 1503 | | 'not' 1504 | ; 1505 | 1506 | Assign 1507 | : '=' 1508 | ; 1509 | 1510 | Less 1511 | : '<' 1512 | ; 1513 | 1514 | Greater 1515 | : '>' 1516 | ; 1517 | 1518 | PlusAssign 1519 | : '+=' 1520 | ; 1521 | 1522 | MinusAssign 1523 | : '-=' 1524 | ; 1525 | 1526 | StarAssign 1527 | : '*=' 1528 | ; 1529 | 1530 | DivAssign 1531 | : '/=' 1532 | ; 1533 | 1534 | ModAssign 1535 | : '%=' 1536 | ; 1537 | 1538 | XorAssign 1539 | : '^=' 1540 | ; 1541 | 1542 | AndAssign 1543 | : '&=' 1544 | ; 1545 | 1546 | OrAssign 1547 | : '|=' 1548 | ; 1549 | 1550 | LeftShift 1551 | : '<<' 1552 | ; 1553 | 1554 | RightShift 1555 | : 1556 | '>>' 1557 | ; 1558 | 1559 | LeftShiftAssign 1560 | : '<<=' 1561 | ; 1562 | 1563 | RightShiftAssign 1564 | : 1565 | '>>=' 1566 | ; 1567 | 1568 | Equal 1569 | : '==' 1570 | ; 1571 | 1572 | NotEqual 1573 | : '!=' 1574 | ; 1575 | 1576 | LessEqual 1577 | : '<=' 1578 | ; 1579 | 1580 | GreaterEqual 1581 | : '>=' 1582 | ; 1583 | 1584 | AndAnd 1585 | : '&&' 1586 | | 'and' 1587 | ; 1588 | 1589 | OrOr 1590 | : '||' 1591 | | 'or' 1592 | ; 1593 | 1594 | PlusPlus 1595 | : '++' 1596 | ; 1597 | 1598 | MinusMinus 1599 | : '--' 1600 | ; 1601 | 1602 | Comma 1603 | : ',' 1604 | ; 1605 | 1606 | ArrowStar 1607 | : '->*' 1608 | ; 1609 | 1610 | Arrow 1611 | : '->' 1612 | ; 1613 | 1614 | Question 1615 | : '?' 1616 | ; 1617 | 1618 | Colon 1619 | : ':' 1620 | ; 1621 | 1622 | Doublecolon 1623 | : '::' 1624 | ; 1625 | 1626 | Semi 1627 | : ';' 1628 | ; 1629 | 1630 | Dot 1631 | : '.' 1632 | ; 1633 | 1634 | DotStar 1635 | : '.*' 1636 | ; 1637 | 1638 | Ellipsis 1639 | : '...' 1640 | ; 1641 | 1642 | theoperator 1643 | : New 1644 | | Delete 1645 | | New '[' ']' 1646 | | Delete '[' ']' 1647 | | '+' 1648 | | '-' 1649 | | '*' 1650 | | '/' 1651 | | '%' 1652 | | '^' 1653 | | '&' 1654 | | '|' 1655 | | '~' 1656 | | '!' 1657 | | 'not' 1658 | | '=' 1659 | | '<' 1660 | | '>' 1661 | | '+=' 1662 | | '-=' 1663 | | '*=' 1664 | | '/=' 1665 | | '%=' 1666 | | '^=' 1667 | | '&=' 1668 | | '|=' 1669 | | LeftShift 1670 | | RightShift 1671 | | RightShiftAssign 1672 | | LeftShiftAssign 1673 | | '==' 1674 | | '!=' 1675 | | '<=' 1676 | | '>=' 1677 | | '&&' 1678 | | 'and' 1679 | | '||' 1680 | | 'or' 1681 | | '++' 1682 | | '--' 1683 | | ',' 1684 | | '->*' 1685 | | '->' 1686 | | '(' ')' 1687 | | '[' ']' 1688 | ; 1689 | /*Lexer*/ 1690 | 1691 | 1692 | fragment Hexquad 1693 | : HEXADECIMALDIGIT HEXADECIMALDIGIT HEXADECIMALDIGIT HEXADECIMALDIGIT 1694 | ; 1695 | 1696 | fragment Universalcharactername 1697 | : '\\u' Hexquad 1698 | | '\\U' Hexquad Hexquad 1699 | ; 1700 | 1701 | Identifier 1702 | : 1703 | /* 1704 | Identifiernondigit 1705 | | Identifier Identifiernondigit 1706 | | Identifier DIGIT 1707 | */ 1708 | Identifiernondigit (Identifiernondigit | DIGIT)* 1709 | ; 1710 | 1711 | fragment Identifiernondigit 1712 | : NONDIGIT 1713 | | Universalcharactername 1714 | ; 1715 | 1716 | fragment NONDIGIT 1717 | : [a-zA-Z_] 1718 | ; 1719 | 1720 | fragment DIGIT 1721 | : [0-9] 1722 | ; 1723 | 1724 | literal 1725 | : Integerliteral 1726 | | Characterliteral 1727 | | Floatingliteral 1728 | | Stringliteral 1729 | | booleanliteral 1730 | | pointerliteral 1731 | | userdefinedliteral 1732 | ; 1733 | 1734 | Integerliteral 1735 | : Decimalliteral Integersuffix? 1736 | | Octalliteral Integersuffix? 1737 | | Hexadecimalliteral Integersuffix? 1738 | | Binaryliteral Integersuffix? 1739 | ; 1740 | 1741 | Decimalliteral 1742 | : NONZERODIGIT ('\''? DIGIT)* 1743 | ; 1744 | 1745 | Octalliteral 1746 | : '0' ('\''? OCTALDIGIT)* 1747 | ; 1748 | 1749 | Hexadecimalliteral 1750 | : ('0x' | '0X') HEXADECIMALDIGIT ('\''? HEXADECIMALDIGIT)* 1751 | ; 1752 | 1753 | Binaryliteral 1754 | : ('0b' | '0B') BINARYDIGIT ('\''? BINARYDIGIT)* 1755 | ; 1756 | 1757 | fragment NONZERODIGIT 1758 | : [1-9] 1759 | ; 1760 | 1761 | fragment OCTALDIGIT 1762 | : [0-7] 1763 | ; 1764 | 1765 | fragment HEXADECIMALDIGIT 1766 | : [0-9a-fA-F] 1767 | ; 1768 | 1769 | fragment BINARYDIGIT 1770 | : [01] 1771 | ; 1772 | 1773 | Integersuffix 1774 | : Unsignedsuffix Longsuffix? 1775 | | Unsignedsuffix Longlongsuffix? 1776 | | Longsuffix Unsignedsuffix? 1777 | | Longlongsuffix Unsignedsuffix? 1778 | ; 1779 | 1780 | fragment Unsignedsuffix 1781 | : [uU] 1782 | ; 1783 | 1784 | fragment Longsuffix 1785 | : [lL] 1786 | ; 1787 | 1788 | fragment Longlongsuffix 1789 | : 'll' 1790 | | 'LL' 1791 | ; 1792 | 1793 | Characterliteral 1794 | : '\'' Cchar+ '\'' 1795 | | 'u' '\'' Cchar+ '\'' 1796 | | 'U' '\'' Cchar+ '\'' 1797 | | 'L' '\'' Cchar+ '\'' 1798 | ; 1799 | 1800 | fragment Cchar 1801 | : ~ ['\\\r\n] 1802 | | Escapesequence 1803 | | Universalcharactername 1804 | ; 1805 | 1806 | fragment Escapesequence 1807 | : Simpleescapesequence 1808 | | Octalescapesequence 1809 | | Hexadecimalescapesequence 1810 | ; 1811 | 1812 | fragment Simpleescapesequence 1813 | : '\\\'' 1814 | | '\\"' 1815 | | '\\?' 1816 | | '\\\\' 1817 | | '\\a' 1818 | | '\\b' 1819 | | '\\f' 1820 | | '\\n' 1821 | | '\\r' 1822 | | '\\t' 1823 | | '\\v' 1824 | ; 1825 | 1826 | fragment Octalescapesequence 1827 | : '\\' OCTALDIGIT 1828 | | '\\' OCTALDIGIT OCTALDIGIT 1829 | | '\\' OCTALDIGIT OCTALDIGIT OCTALDIGIT 1830 | ; 1831 | 1832 | fragment Hexadecimalescapesequence 1833 | : '\\x' HEXADECIMALDIGIT+ 1834 | ; 1835 | 1836 | Floatingliteral 1837 | : Fractionalconstant Exponentpart? Floatingsuffix? 1838 | | Digitsequence Exponentpart Floatingsuffix? 1839 | ; 1840 | 1841 | fragment Fractionalconstant 1842 | : Digitsequence? '.' Digitsequence 1843 | | Digitsequence '.' 1844 | ; 1845 | 1846 | fragment Exponentpart 1847 | : 'e' SIGN? Digitsequence 1848 | | 'E' SIGN? Digitsequence 1849 | ; 1850 | 1851 | fragment SIGN 1852 | : [+-] 1853 | ; 1854 | 1855 | fragment Digitsequence 1856 | : DIGIT ('\''? DIGIT)* 1857 | ; 1858 | 1859 | fragment Floatingsuffix 1860 | : [flFL] 1861 | ; 1862 | 1863 | Stringliteral 1864 | : Encodingprefix? '"' Schar* '"' 1865 | | Encodingprefix? 'R' Rawstring 1866 | ; 1867 | 1868 | fragment Encodingprefix 1869 | : 'u8' 1870 | | 'u' 1871 | | 'U' 1872 | | 'L' 1873 | ; 1874 | 1875 | fragment Schar 1876 | : ~ ["\\\r\n] 1877 | | Escapesequence 1878 | | Universalcharactername 1879 | ; 1880 | 1881 | fragment Rawstring 1882 | : '"' .*? '(' .*? ')' .*? '"' 1883 | ; 1884 | 1885 | booleanliteral 1886 | : False 1887 | | True 1888 | ; 1889 | 1890 | pointerliteral 1891 | : Nullptr 1892 | ; 1893 | 1894 | userdefinedliteral 1895 | : Userdefinedintegerliteral 1896 | | Userdefinedfloatingliteral 1897 | | Userdefinedstringliteral 1898 | | Userdefinedcharacterliteral 1899 | ; 1900 | 1901 | Userdefinedintegerliteral 1902 | : Decimalliteral Udsuffix 1903 | | Octalliteral Udsuffix 1904 | | Hexadecimalliteral Udsuffix 1905 | | Binaryliteral Udsuffix 1906 | ; 1907 | 1908 | Userdefinedfloatingliteral 1909 | : Fractionalconstant Exponentpart? Udsuffix 1910 | | Digitsequence Exponentpart Udsuffix 1911 | ; 1912 | 1913 | Userdefinedstringliteral 1914 | : Stringliteral Udsuffix 1915 | ; 1916 | 1917 | Userdefinedcharacterliteral 1918 | : Characterliteral Udsuffix 1919 | ; 1920 | 1921 | fragment Udsuffix 1922 | : Identifier 1923 | ; 1924 | 1925 | Whitespace 1926 | : [ \t]+ -> skip 1927 | ; 1928 | 1929 | Newline 1930 | : ('\r' '\n'? | '\n') -> skip 1931 | ; 1932 | 1933 | BlockComment 1934 | : '/*' .*? '*/' -> skip 1935 | ; 1936 | 1937 | LineComment 1938 | : '//' ~ [\r\n]* -> skip 1939 | ; 1940 | -------------------------------------------------------------------------------- /examples/step2-code/Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.12 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 double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "My Project" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = examples/step2-code 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = "The $name class" \ 122 | "The $name widget" \ 123 | "The $name file" \ 124 | is \ 125 | provides \ 126 | specifies \ 127 | contains \ 128 | represents \ 129 | a \ 130 | an \ 131 | the 132 | 133 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134 | # doxygen will generate a detailed section even if there is only a brief 135 | # description. 136 | # The default value is: NO. 137 | 138 | ALWAYS_DETAILED_SEC = NO 139 | 140 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141 | # inherited members of a class in the documentation of that class as if those 142 | # members were ordinary class members. Constructors, destructors and assignment 143 | # operators of the base classes will not be shown. 144 | # The default value is: NO. 145 | 146 | INLINE_INHERITED_MEMB = NO 147 | 148 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 149 | # before files name in the file list and in the header files. If set to NO the 150 | # shortest path that makes the file name unique will be used 151 | # The default value is: YES. 152 | 153 | FULL_PATH_NAMES = YES 154 | 155 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156 | # Stripping is only done if one of the specified strings matches the left-hand 157 | # part of the path. The tag can be used to show relative paths in the file list. 158 | # If left blank the directory from which doxygen is run is used as the path to 159 | # strip. 160 | # 161 | # Note that you can specify absolute paths here, but also relative paths, which 162 | # will be relative from the directory where doxygen is started. 163 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 | 165 | STRIP_FROM_PATH = 166 | 167 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168 | # path mentioned in the documentation of a class, which tells the reader which 169 | # header file to include in order to use a class. If left blank only the name of 170 | # the header file containing the class definition is used. Otherwise one should 171 | # specify the list of include paths that are normally passed to the compiler 172 | # using the -I flag. 173 | 174 | STRIP_FROM_INC_PATH = 175 | 176 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177 | # less readable) file names. This can be useful is your file systems doesn't 178 | # support long names like on DOS, Mac, or CD-ROM. 179 | # The default value is: NO. 180 | 181 | SHORT_NAMES = NO 182 | 183 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184 | # first line (until the first dot) of a Javadoc-style comment as the brief 185 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 186 | # style comments (thus requiring an explicit @brief command for a brief 187 | # description.) 188 | # The default value is: NO. 189 | 190 | JAVADOC_AUTOBRIEF = NO 191 | 192 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193 | # line (until the first dot) of a Qt-style comment as the brief description. If 194 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195 | # requiring an explicit \brief command for a brief description.) 196 | # The default value is: NO. 197 | 198 | QT_AUTOBRIEF = NO 199 | 200 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202 | # a brief description. This used to be the default behavior. The new default is 203 | # to treat a multi-line C++ comment block as a detailed description. Set this 204 | # tag to YES if you prefer the old behavior instead. 205 | # 206 | # Note that setting this tag to YES also means that rational rose comments are 207 | # not recognized any more. 208 | # The default value is: NO. 209 | 210 | MULTILINE_CPP_IS_BRIEF = NO 211 | 212 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213 | # documentation from any documented member that it re-implements. 214 | # The default value is: YES. 215 | 216 | INHERIT_DOCS = YES 217 | 218 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 219 | # page for each member. If set to NO, the documentation of a member will be part 220 | # of the file/class/namespace that contains it. 221 | # The default value is: NO. 222 | 223 | SEPARATE_MEMBER_PAGES = NO 224 | 225 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226 | # uses this value to replace tabs by spaces in code fragments. 227 | # Minimum value: 1, maximum value: 16, default value: 4. 228 | 229 | TAB_SIZE = 4 230 | 231 | # This tag can be used to specify a number of aliases that act as commands in 232 | # the documentation. An alias has the form: 233 | # name=value 234 | # For example adding 235 | # "sideeffect=@par Side Effects:\n" 236 | # will allow you to put the command \sideeffect (or @sideeffect) in the 237 | # documentation, which will result in a user-defined paragraph with heading 238 | # "Side Effects:". You can put \n's in the value part of an alias to insert 239 | # newlines. 240 | 241 | ALIASES = 242 | 243 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 244 | # A mapping has the form "name=value". For example adding "class=itcl::class" 245 | # will allow you to use the command class in the itcl::class meaning. 246 | 247 | TCL_SUBST = 248 | 249 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250 | # only. Doxygen will then generate output that is more tailored for C. For 251 | # instance, some of the names that are used will be different. The list of all 252 | # members will be omitted, etc. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_FOR_C = NO 256 | 257 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258 | # Python sources only. Doxygen will then generate output that is more tailored 259 | # for that language. For instance, namespaces will be presented as packages, 260 | # qualified scopes will look different, etc. 261 | # The default value is: NO. 262 | 263 | OPTIMIZE_OUTPUT_JAVA = NO 264 | 265 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266 | # sources. Doxygen will then generate output that is tailored for Fortran. 267 | # The default value is: NO. 268 | 269 | OPTIMIZE_FOR_FORTRAN = NO 270 | 271 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272 | # sources. Doxygen will then generate output that is tailored for VHDL. 273 | # The default value is: NO. 274 | 275 | OPTIMIZE_OUTPUT_VHDL = NO 276 | 277 | # Doxygen selects the parser to use depending on the extension of the files it 278 | # parses. With this tag you can assign which parser to use for a given 279 | # extension. Doxygen has a built-in mapping, but you can override or extend it 280 | # using this tag. The format is ext=language, where ext is a file extension, and 281 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284 | # Fortran. In the later case the parser tries to guess whether the code is fixed 285 | # or free formatted code, this is the default for Fortran type files), VHDL. For 286 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 287 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 288 | # 289 | # Note: For files without extension you can use no_extension as a placeholder. 290 | # 291 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292 | # the files are not read by doxygen. 293 | 294 | EXTENSION_MAPPING = 295 | 296 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297 | # according to the Markdown format, which allows for more readable 298 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 299 | # The output of markdown processing is further processed by doxygen, so you can 300 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301 | # case of backward compatibilities issues. 302 | # The default value is: YES. 303 | 304 | MARKDOWN_SUPPORT = YES 305 | 306 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 307 | # to that level are automatically included in the table of contents, even if 308 | # they do not have an id attribute. 309 | # Note: This feature currently applies only to Markdown headings. 310 | # Minimum value: 0, maximum value: 99, default value: 0. 311 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 312 | 313 | TOC_INCLUDE_HEADINGS = 0 314 | 315 | # When enabled doxygen tries to link words that correspond to documented 316 | # classes, or namespaces to their corresponding documentation. Such a link can 317 | # be prevented in individual cases by putting a % sign in front of the word or 318 | # globally by setting AUTOLINK_SUPPORT to NO. 319 | # The default value is: YES. 320 | 321 | AUTOLINK_SUPPORT = YES 322 | 323 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 324 | # to include (a tag file for) the STL sources as input, then you should set this 325 | # tag to YES in order to let doxygen match functions declarations and 326 | # definitions whose arguments contain STL classes (e.g. func(std::string); 327 | # versus func(std::string) {}). This also make the inheritance and collaboration 328 | # diagrams that involve STL classes more complete and accurate. 329 | # The default value is: NO. 330 | 331 | BUILTIN_STL_SUPPORT = YES 332 | 333 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 334 | # enable parsing support. 335 | # The default value is: NO. 336 | 337 | CPP_CLI_SUPPORT = NO 338 | 339 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 340 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 341 | # will parse them like normal C++ but will assume all classes use public instead 342 | # of private inheritance when no explicit protection keyword is present. 343 | # The default value is: NO. 344 | 345 | SIP_SUPPORT = NO 346 | 347 | # For Microsoft's IDL there are propget and propput attributes to indicate 348 | # getter and setter methods for a property. Setting this option to YES will make 349 | # doxygen to replace the get and set methods by a property in the documentation. 350 | # This will only work if the methods are indeed getting or setting a simple 351 | # type. If this is not the case, or you want to show the methods anyway, you 352 | # should set this option to NO. 353 | # The default value is: YES. 354 | 355 | IDL_PROPERTY_SUPPORT = YES 356 | 357 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 358 | # tag is set to YES then doxygen will reuse the documentation of the first 359 | # member in the group (if any) for the other members of the group. By default 360 | # all members of a group must be documented explicitly. 361 | # The default value is: NO. 362 | 363 | DISTRIBUTE_GROUP_DOC = NO 364 | 365 | # If one adds a struct or class to a group and this option is enabled, then also 366 | # any nested class or struct is added to the same group. By default this option 367 | # is disabled and one has to add nested compounds explicitly via \ingroup. 368 | # The default value is: NO. 369 | 370 | GROUP_NESTED_COMPOUNDS = NO 371 | 372 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 373 | # (for instance a group of public functions) to be put as a subgroup of that 374 | # type (e.g. under the Public Functions section). Set it to NO to prevent 375 | # subgrouping. Alternatively, this can be done per class using the 376 | # \nosubgrouping command. 377 | # The default value is: YES. 378 | 379 | SUBGROUPING = YES 380 | 381 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 382 | # are shown inside the group in which they are included (e.g. using \ingroup) 383 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 384 | # and RTF). 385 | # 386 | # Note that this feature does not work in combination with 387 | # SEPARATE_MEMBER_PAGES. 388 | # The default value is: NO. 389 | 390 | INLINE_GROUPED_CLASSES = NO 391 | 392 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 393 | # with only public data fields or simple typedef fields will be shown inline in 394 | # the documentation of the scope in which they are defined (i.e. file, 395 | # namespace, or group documentation), provided this scope is documented. If set 396 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 397 | # Man pages) or section (for LaTeX and RTF). 398 | # The default value is: NO. 399 | 400 | INLINE_SIMPLE_STRUCTS = NO 401 | 402 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 403 | # enum is documented as struct, union, or enum with the name of the typedef. So 404 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 405 | # with name TypeT. When disabled the typedef will appear as a member of a file, 406 | # namespace, or class. And the struct will be named TypeS. This can typically be 407 | # useful for C code in case the coding convention dictates that all compound 408 | # types are typedef'ed and only the typedef is referenced, never the tag name. 409 | # The default value is: NO. 410 | 411 | TYPEDEF_HIDES_STRUCT = NO 412 | 413 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 414 | # cache is used to resolve symbols given their name and scope. Since this can be 415 | # an expensive process and often the same symbol appears multiple times in the 416 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 417 | # doxygen will become slower. If the cache is too large, memory is wasted. The 418 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 419 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 420 | # symbols. At the end of a run doxygen will report the cache usage and suggest 421 | # the optimal cache size from a speed point of view. 422 | # Minimum value: 0, maximum value: 9, default value: 0. 423 | 424 | LOOKUP_CACHE_SIZE = 0 425 | 426 | #--------------------------------------------------------------------------- 427 | # Build related configuration options 428 | #--------------------------------------------------------------------------- 429 | 430 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 431 | # documentation are documented, even if no documentation was available. Private 432 | # class members and static file members will be hidden unless the 433 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 434 | # Note: This will also disable the warnings about undocumented members that are 435 | # normally produced when WARNINGS is set to YES. 436 | # The default value is: NO. 437 | 438 | EXTRACT_ALL = YES 439 | 440 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 441 | # be included in the documentation. 442 | # The default value is: NO. 443 | 444 | EXTRACT_PRIVATE = YES 445 | 446 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 447 | # scope will be included in the documentation. 448 | # The default value is: NO. 449 | 450 | EXTRACT_PACKAGE = NO 451 | 452 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 453 | # included in the documentation. 454 | # The default value is: NO. 455 | 456 | EXTRACT_STATIC = YES 457 | 458 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 459 | # locally in source files will be included in the documentation. If set to NO, 460 | # only classes defined in header files are included. Does not have any effect 461 | # for Java sources. 462 | # The default value is: YES. 463 | 464 | EXTRACT_LOCAL_CLASSES = YES 465 | 466 | # This flag is only useful for Objective-C code. If set to YES, local methods, 467 | # which are defined in the implementation section but not in the interface are 468 | # included in the documentation. If set to NO, only methods in the interface are 469 | # included. 470 | # The default value is: NO. 471 | 472 | EXTRACT_LOCAL_METHODS = YES 473 | 474 | # If this flag is set to YES, the members of anonymous namespaces will be 475 | # extracted and appear in the documentation as a namespace called 476 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 477 | # the file that contains the anonymous namespace. By default anonymous namespace 478 | # are hidden. 479 | # The default value is: NO. 480 | 481 | EXTRACT_ANON_NSPACES = NO 482 | 483 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 484 | # undocumented members inside documented classes or files. If set to NO these 485 | # members will be included in the various overviews, but no documentation 486 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 487 | # The default value is: NO. 488 | 489 | HIDE_UNDOC_MEMBERS = NO 490 | 491 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 492 | # undocumented classes that are normally visible in the class hierarchy. If set 493 | # to NO, these classes will be included in the various overviews. This option 494 | # has no effect if EXTRACT_ALL is enabled. 495 | # The default value is: NO. 496 | 497 | HIDE_UNDOC_CLASSES = NO 498 | 499 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 500 | # (class|struct|union) declarations. If set to NO, these declarations will be 501 | # included in the documentation. 502 | # The default value is: NO. 503 | 504 | HIDE_FRIEND_COMPOUNDS = NO 505 | 506 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 507 | # documentation blocks found inside the body of a function. If set to NO, these 508 | # blocks will be appended to the function's detailed documentation block. 509 | # The default value is: NO. 510 | 511 | HIDE_IN_BODY_DOCS = NO 512 | 513 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 514 | # \internal command is included. If the tag is set to NO then the documentation 515 | # will be excluded. Set it to YES to include the internal documentation. 516 | # The default value is: NO. 517 | 518 | INTERNAL_DOCS = NO 519 | 520 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 521 | # names in lower-case letters. If set to YES, upper-case letters are also 522 | # allowed. This is useful if you have classes or files whose names only differ 523 | # in case and if your file system supports case sensitive file names. Windows 524 | # and Mac users are advised to set this option to NO. 525 | # The default value is: system dependent. 526 | 527 | CASE_SENSE_NAMES = NO 528 | 529 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 530 | # their full class and namespace scopes in the documentation. If set to YES, the 531 | # scope will be hidden. 532 | # The default value is: NO. 533 | 534 | HIDE_SCOPE_NAMES = NO 535 | 536 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 537 | # append additional text to a page's title, such as Class Reference. If set to 538 | # YES the compound reference will be hidden. 539 | # The default value is: NO. 540 | 541 | HIDE_COMPOUND_REFERENCE= NO 542 | 543 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 544 | # the files that are included by a file in the documentation of that file. 545 | # The default value is: YES. 546 | 547 | SHOW_INCLUDE_FILES = YES 548 | 549 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 550 | # grouped member an include statement to the documentation, telling the reader 551 | # which file to include in order to use the member. 552 | # The default value is: NO. 553 | 554 | SHOW_GROUPED_MEMB_INC = NO 555 | 556 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 557 | # files with double quotes in the documentation rather than with sharp brackets. 558 | # The default value is: NO. 559 | 560 | FORCE_LOCAL_INCLUDES = NO 561 | 562 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 563 | # documentation for inline members. 564 | # The default value is: YES. 565 | 566 | INLINE_INFO = YES 567 | 568 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 569 | # (detailed) documentation of file and class members alphabetically by member 570 | # name. If set to NO, the members will appear in declaration order. 571 | # The default value is: YES. 572 | 573 | SORT_MEMBER_DOCS = YES 574 | 575 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 576 | # descriptions of file, namespace and class members alphabetically by member 577 | # name. If set to NO, the members will appear in declaration order. Note that 578 | # this will also influence the order of the classes in the class list. 579 | # The default value is: NO. 580 | 581 | SORT_BRIEF_DOCS = NO 582 | 583 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 584 | # (brief and detailed) documentation of class members so that constructors and 585 | # destructors are listed first. If set to NO the constructors will appear in the 586 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 587 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 588 | # member documentation. 589 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 590 | # detailed member documentation. 591 | # The default value is: NO. 592 | 593 | SORT_MEMBERS_CTORS_1ST = NO 594 | 595 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 596 | # of group names into alphabetical order. If set to NO the group names will 597 | # appear in their defined order. 598 | # The default value is: NO. 599 | 600 | SORT_GROUP_NAMES = NO 601 | 602 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 603 | # fully-qualified names, including namespaces. If set to NO, the class list will 604 | # be sorted only by class name, not including the namespace part. 605 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 606 | # Note: This option applies only to the class list, not to the alphabetical 607 | # list. 608 | # The default value is: NO. 609 | 610 | SORT_BY_SCOPE_NAME = NO 611 | 612 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 613 | # type resolution of all parameters of a function it will reject a match between 614 | # the prototype and the implementation of a member function even if there is 615 | # only one candidate or it is obvious which candidate to choose by doing a 616 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 617 | # accept a match between prototype and implementation in such cases. 618 | # The default value is: NO. 619 | 620 | STRICT_PROTO_MATCHING = NO 621 | 622 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 623 | # list. This list is created by putting \todo commands in the documentation. 624 | # The default value is: YES. 625 | 626 | GENERATE_TODOLIST = YES 627 | 628 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 629 | # list. This list is created by putting \test commands in the documentation. 630 | # The default value is: YES. 631 | 632 | GENERATE_TESTLIST = YES 633 | 634 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 635 | # list. This list is created by putting \bug commands in the documentation. 636 | # The default value is: YES. 637 | 638 | GENERATE_BUGLIST = YES 639 | 640 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 641 | # the deprecated list. This list is created by putting \deprecated commands in 642 | # the documentation. 643 | # The default value is: YES. 644 | 645 | GENERATE_DEPRECATEDLIST= YES 646 | 647 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 648 | # sections, marked by \if ... \endif and \cond 649 | # ... \endcond blocks. 650 | 651 | ENABLED_SECTIONS = 652 | 653 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 654 | # initial value of a variable or macro / define can have for it to appear in the 655 | # documentation. If the initializer consists of more lines than specified here 656 | # it will be hidden. Use a value of 0 to hide initializers completely. The 657 | # appearance of the value of individual variables and macros / defines can be 658 | # controlled using \showinitializer or \hideinitializer command in the 659 | # documentation regardless of this setting. 660 | # Minimum value: 0, maximum value: 10000, default value: 30. 661 | 662 | MAX_INITIALIZER_LINES = 30 663 | 664 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 665 | # the bottom of the documentation of classes and structs. If set to YES, the 666 | # list will mention the files that were used to generate the documentation. 667 | # The default value is: YES. 668 | 669 | SHOW_USED_FILES = YES 670 | 671 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 672 | # will remove the Files entry from the Quick Index and from the Folder Tree View 673 | # (if specified). 674 | # The default value is: YES. 675 | 676 | SHOW_FILES = YES 677 | 678 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 679 | # page. This will remove the Namespaces entry from the Quick Index and from the 680 | # Folder Tree View (if specified). 681 | # The default value is: YES. 682 | 683 | SHOW_NAMESPACES = YES 684 | 685 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 686 | # doxygen should invoke to get the current version for each file (typically from 687 | # the version control system). Doxygen will invoke the program by executing (via 688 | # popen()) the command command input-file, where command is the value of the 689 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 690 | # by doxygen. Whatever the program writes to standard output is used as the file 691 | # version. For an example see the documentation. 692 | 693 | FILE_VERSION_FILTER = 694 | 695 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 696 | # by doxygen. The layout file controls the global structure of the generated 697 | # output files in an output format independent way. To create the layout file 698 | # that represents doxygen's defaults, run doxygen with the -l option. You can 699 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 700 | # will be used as the name of the layout file. 701 | # 702 | # Note that if you run doxygen from a directory containing a file called 703 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 704 | # tag is left empty. 705 | 706 | LAYOUT_FILE = 707 | 708 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 709 | # the reference definitions. This must be a list of .bib files. The .bib 710 | # extension is automatically appended if omitted. This requires the bibtex tool 711 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 712 | # For LaTeX the style of the bibliography can be controlled using 713 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 714 | # search path. See also \cite for info how to create references. 715 | 716 | CITE_BIB_FILES = 717 | 718 | #--------------------------------------------------------------------------- 719 | # Configuration options related to warning and progress messages 720 | #--------------------------------------------------------------------------- 721 | 722 | # The QUIET tag can be used to turn on/off the messages that are generated to 723 | # standard output by doxygen. If QUIET is set to YES this implies that the 724 | # messages are off. 725 | # The default value is: NO. 726 | 727 | QUIET = NO 728 | 729 | # The WARNINGS tag can be used to turn on/off the warning messages that are 730 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 731 | # this implies that the warnings are on. 732 | # 733 | # Tip: Turn warnings on while writing the documentation. 734 | # The default value is: YES. 735 | 736 | WARNINGS = YES 737 | 738 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 739 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 740 | # will automatically be disabled. 741 | # The default value is: YES. 742 | 743 | WARN_IF_UNDOCUMENTED = YES 744 | 745 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 746 | # potential errors in the documentation, such as not documenting some parameters 747 | # in a documented function, or documenting parameters that don't exist or using 748 | # markup commands wrongly. 749 | # The default value is: YES. 750 | 751 | WARN_IF_DOC_ERROR = YES 752 | 753 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 754 | # are documented, but have no documentation for their parameters or return 755 | # value. If set to NO, doxygen will only warn about wrong or incomplete 756 | # parameter documentation, but not about the absence of documentation. 757 | # The default value is: NO. 758 | 759 | WARN_NO_PARAMDOC = NO 760 | 761 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 762 | # a warning is encountered. 763 | # The default value is: NO. 764 | 765 | WARN_AS_ERROR = NO 766 | 767 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 768 | # can produce. The string should contain the $file, $line, and $text tags, which 769 | # will be replaced by the file and line number from which the warning originated 770 | # and the warning text. Optionally the format may contain $version, which will 771 | # be replaced by the version of the file (if it could be obtained via 772 | # FILE_VERSION_FILTER) 773 | # The default value is: $file:$line: $text. 774 | 775 | WARN_FORMAT = "$file:$line: $text" 776 | 777 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 778 | # messages should be written. If left blank the output is written to standard 779 | # error (stderr). 780 | 781 | WARN_LOGFILE = 782 | 783 | #--------------------------------------------------------------------------- 784 | # Configuration options related to the input files 785 | #--------------------------------------------------------------------------- 786 | 787 | # The INPUT tag is used to specify the files and/or directories that contain 788 | # documented source files. You may enter file names like myfile.cpp or 789 | # directories like /usr/src/myproject. Separate the files or directories with 790 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 791 | # Note: If this tag is empty the current directory is searched. 792 | 793 | INPUT = examples/step2-code 794 | 795 | # This tag can be used to specify the character encoding of the source files 796 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 797 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 798 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 799 | # possible encodings. 800 | # The default value is: UTF-8. 801 | 802 | INPUT_ENCODING = UTF-8 803 | 804 | # If the value of the INPUT tag contains directories, you can use the 805 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 806 | # *.h) to filter out the source-files in the directories. 807 | # 808 | # Note that for custom extensions or not directly supported extensions you also 809 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 810 | # read by doxygen. 811 | # 812 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 813 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 814 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 815 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 816 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 817 | 818 | FILE_PATTERNS = *.c \ 819 | *.cc \ 820 | *.cxx \ 821 | *.c++ \ 822 | *.java \ 823 | *.ii \ 824 | *.ixx \ 825 | *.ipp \ 826 | *.i++ \ 827 | *.inl \ 828 | *.idl \ 829 | *.ddl \ 830 | *.odl \ 831 | *.h \ 832 | *.hh \ 833 | *.hxx \ 834 | *.hpp \ 835 | *.h++ \ 836 | *.cs \ 837 | *.d \ 838 | *.php \ 839 | *.php4 \ 840 | *.php5 \ 841 | *.phtml \ 842 | *.inc \ 843 | *.m \ 844 | *.markdown \ 845 | *.md \ 846 | *.mm \ 847 | *.dox \ 848 | *.py \ 849 | *.pyw \ 850 | *.f90 \ 851 | *.f95 \ 852 | *.f03 \ 853 | *.f08 \ 854 | *.f \ 855 | *.for \ 856 | *.tcl \ 857 | *.vhd \ 858 | *.vhdl \ 859 | *.ucf \ 860 | *.qsf 861 | 862 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 863 | # be searched for input files as well. 864 | # The default value is: NO. 865 | 866 | RECURSIVE = YES 867 | 868 | # The EXCLUDE tag can be used to specify files and/or directories that should be 869 | # excluded from the INPUT source files. This way you can easily exclude a 870 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 871 | # 872 | # Note that relative paths are relative to the directory from which doxygen is 873 | # run. 874 | 875 | EXCLUDE = 876 | 877 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 878 | # directories that are symbolic links (a Unix file system feature) are excluded 879 | # from the input. 880 | # The default value is: NO. 881 | 882 | EXCLUDE_SYMLINKS = NO 883 | 884 | # If the value of the INPUT tag contains directories, you can use the 885 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 886 | # certain files from those directories. 887 | # 888 | # Note that the wildcards are matched against the file with absolute path, so to 889 | # exclude all test directories for example use the pattern */test/* 890 | 891 | EXCLUDE_PATTERNS = 892 | 893 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 894 | # (namespaces, classes, functions, etc.) that should be excluded from the 895 | # output. The symbol name can be a fully qualified name, a word, or if the 896 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 897 | # AClass::ANamespace, ANamespace::*Test 898 | # 899 | # Note that the wildcards are matched against the file with absolute path, so to 900 | # exclude all test directories use the pattern */test/* 901 | 902 | EXCLUDE_SYMBOLS = 903 | 904 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 905 | # that contain example code fragments that are included (see the \include 906 | # command). 907 | 908 | EXAMPLE_PATH = 909 | 910 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 911 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 912 | # *.h) to filter out the source-files in the directories. If left blank all 913 | # files are included. 914 | 915 | EXAMPLE_PATTERNS = * 916 | 917 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 918 | # searched for input files to be used with the \include or \dontinclude commands 919 | # irrespective of the value of the RECURSIVE tag. 920 | # The default value is: NO. 921 | 922 | EXAMPLE_RECURSIVE = NO 923 | 924 | # The IMAGE_PATH tag can be used to specify one or more files or directories 925 | # that contain images that are to be included in the documentation (see the 926 | # \image command). 927 | 928 | IMAGE_PATH = 929 | 930 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 931 | # invoke to filter for each input file. Doxygen will invoke the filter program 932 | # by executing (via popen()) the command: 933 | # 934 | # 935 | # 936 | # where is the value of the INPUT_FILTER tag, and is the 937 | # name of an input file. Doxygen will then use the output that the filter 938 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 939 | # will be ignored. 940 | # 941 | # Note that the filter must not add or remove lines; it is applied before the 942 | # code is scanned, but not when the output code is generated. If lines are added 943 | # or removed, the anchors will not be placed correctly. 944 | # 945 | # Note that for custom extensions or not directly supported extensions you also 946 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 947 | # properly processed by doxygen. 948 | 949 | INPUT_FILTER = 950 | 951 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 952 | # basis. Doxygen will compare the file name with each pattern and apply the 953 | # filter if there is a match. The filters are a list of the form: pattern=filter 954 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 955 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 956 | # patterns match the file name, INPUT_FILTER is applied. 957 | # 958 | # Note that for custom extensions or not directly supported extensions you also 959 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 960 | # properly processed by doxygen. 961 | 962 | FILTER_PATTERNS = 963 | 964 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 965 | # INPUT_FILTER) will also be used to filter the input files that are used for 966 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 967 | # The default value is: NO. 968 | 969 | FILTER_SOURCE_FILES = NO 970 | 971 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 972 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 973 | # it is also possible to disable source filtering for a specific pattern using 974 | # *.ext= (so without naming a filter). 975 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 976 | 977 | FILTER_SOURCE_PATTERNS = 978 | 979 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 980 | # is part of the input, its contents will be placed on the main page 981 | # (index.html). This can be useful if you have a project on for instance GitHub 982 | # and want to reuse the introduction page also for the doxygen output. 983 | 984 | USE_MDFILE_AS_MAINPAGE = 985 | 986 | #--------------------------------------------------------------------------- 987 | # Configuration options related to source browsing 988 | #--------------------------------------------------------------------------- 989 | 990 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 991 | # generated. Documented entities will be cross-referenced with these sources. 992 | # 993 | # Note: To get rid of all source code in the generated output, make sure that 994 | # also VERBATIM_HEADERS is set to NO. 995 | # The default value is: NO. 996 | 997 | SOURCE_BROWSER = NO 998 | 999 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1000 | # classes and enums directly into the documentation. 1001 | # The default value is: NO. 1002 | 1003 | INLINE_SOURCES = NO 1004 | 1005 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1006 | # special comment blocks from generated source code fragments. Normal C, C++ and 1007 | # Fortran comments will always remain visible. 1008 | # The default value is: YES. 1009 | 1010 | STRIP_CODE_COMMENTS = YES 1011 | 1012 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1013 | # function all documented functions referencing it will be listed. 1014 | # The default value is: NO. 1015 | 1016 | REFERENCED_BY_RELATION = NO 1017 | 1018 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1019 | # all documented entities called/used by that function will be listed. 1020 | # The default value is: NO. 1021 | 1022 | REFERENCES_RELATION = YES 1023 | 1024 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1025 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1026 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1027 | # link to the documentation. 1028 | # The default value is: YES. 1029 | 1030 | REFERENCES_LINK_SOURCE = YES 1031 | 1032 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1033 | # source code will show a tooltip with additional information such as prototype, 1034 | # brief description and links to the definition and documentation. Since this 1035 | # will make the HTML file larger and loading of large files a bit slower, you 1036 | # can opt to disable this feature. 1037 | # The default value is: YES. 1038 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1039 | 1040 | SOURCE_TOOLTIPS = YES 1041 | 1042 | # If the USE_HTAGS tag is set to YES then the references to source code will 1043 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1044 | # source browser. The htags tool is part of GNU's global source tagging system 1045 | # (see http://www.gnu.org/software/global/global.html). You will need version 1046 | # 4.8.6 or higher. 1047 | # 1048 | # To use it do the following: 1049 | # - Install the latest version of global 1050 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1051 | # - Make sure the INPUT points to the root of the source tree 1052 | # - Run doxygen as normal 1053 | # 1054 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1055 | # tools must be available from the command line (i.e. in the search path). 1056 | # 1057 | # The result: instead of the source browser generated by doxygen, the links to 1058 | # source code will now point to the output of htags. 1059 | # The default value is: NO. 1060 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1061 | 1062 | USE_HTAGS = NO 1063 | 1064 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1065 | # verbatim copy of the header file for each class for which an include is 1066 | # specified. Set to NO to disable this. 1067 | # See also: Section \class. 1068 | # The default value is: YES. 1069 | 1070 | VERBATIM_HEADERS = YES 1071 | 1072 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1073 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1074 | # cost of reduced performance. This can be particularly helpful with template 1075 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 1076 | # information. 1077 | # Note: The availability of this option depends on whether or not doxygen was 1078 | # generated with the -Duse-libclang=ON option for CMake. 1079 | # The default value is: NO. 1080 | 1081 | CLANG_ASSISTED_PARSING = NO 1082 | 1083 | # If clang assisted parsing is enabled you can provide the compiler with command 1084 | # line options that you would normally use when invoking the compiler. Note that 1085 | # the include paths will already be set by doxygen for the files and directories 1086 | # specified with INPUT and INCLUDE_PATH. 1087 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1088 | 1089 | CLANG_OPTIONS = 1090 | 1091 | #--------------------------------------------------------------------------- 1092 | # Configuration options related to the alphabetical class index 1093 | #--------------------------------------------------------------------------- 1094 | 1095 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1096 | # compounds will be generated. Enable this if the project contains a lot of 1097 | # classes, structs, unions or interfaces. 1098 | # The default value is: YES. 1099 | 1100 | ALPHABETICAL_INDEX = YES 1101 | 1102 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1103 | # which the alphabetical index list will be split. 1104 | # Minimum value: 1, maximum value: 20, default value: 5. 1105 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1106 | 1107 | COLS_IN_ALPHA_INDEX = 5 1108 | 1109 | # In case all classes in a project start with a common prefix, all classes will 1110 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1111 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1112 | # while generating the index headers. 1113 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1114 | 1115 | IGNORE_PREFIX = 1116 | 1117 | #--------------------------------------------------------------------------- 1118 | # Configuration options related to the HTML output 1119 | #--------------------------------------------------------------------------- 1120 | 1121 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1122 | # The default value is: YES. 1123 | 1124 | GENERATE_HTML = YES 1125 | 1126 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1127 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1128 | # it. 1129 | # The default directory is: html. 1130 | # This tag requires that the tag GENERATE_HTML is set to YES. 1131 | 1132 | HTML_OUTPUT = html 1133 | 1134 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1135 | # generated HTML page (for example: .htm, .php, .asp). 1136 | # The default value is: .html. 1137 | # This tag requires that the tag GENERATE_HTML is set to YES. 1138 | 1139 | HTML_FILE_EXTENSION = .html 1140 | 1141 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1142 | # each generated HTML page. If the tag is left blank doxygen will generate a 1143 | # standard header. 1144 | # 1145 | # To get valid HTML the header file that includes any scripts and style sheets 1146 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1147 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1148 | # default header using 1149 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1150 | # YourConfigFile 1151 | # and then modify the file new_header.html. See also section "Doxygen usage" 1152 | # for information on how to generate the default header that doxygen normally 1153 | # uses. 1154 | # Note: The header is subject to change so you typically have to regenerate the 1155 | # default header when upgrading to a newer version of doxygen. For a description 1156 | # of the possible markers and block names see the documentation. 1157 | # This tag requires that the tag GENERATE_HTML is set to YES. 1158 | 1159 | HTML_HEADER = 1160 | 1161 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1162 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1163 | # footer. See HTML_HEADER for more information on how to generate a default 1164 | # footer and what special commands can be used inside the footer. See also 1165 | # section "Doxygen usage" for information on how to generate the default footer 1166 | # that doxygen normally uses. 1167 | # This tag requires that the tag GENERATE_HTML is set to YES. 1168 | 1169 | HTML_FOOTER = 1170 | 1171 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1172 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1173 | # the HTML output. If left blank doxygen will generate a default style sheet. 1174 | # See also section "Doxygen usage" for information on how to generate the style 1175 | # sheet that doxygen normally uses. 1176 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1177 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1178 | # obsolete. 1179 | # This tag requires that the tag GENERATE_HTML is set to YES. 1180 | 1181 | HTML_STYLESHEET = 1182 | 1183 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1184 | # cascading style sheets that are included after the standard style sheets 1185 | # created by doxygen. Using this option one can overrule certain style aspects. 1186 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1187 | # standard style sheet and is therefore more robust against future updates. 1188 | # Doxygen will copy the style sheet files to the output directory. 1189 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1190 | # style sheet in the list overrules the setting of the previous ones in the 1191 | # list). For an example see the documentation. 1192 | # This tag requires that the tag GENERATE_HTML is set to YES. 1193 | 1194 | HTML_EXTRA_STYLESHEET = 1195 | 1196 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1197 | # other source files which should be copied to the HTML output directory. Note 1198 | # that these files will be copied to the base HTML output directory. Use the 1199 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1200 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1201 | # files will be copied as-is; there are no commands or markers available. 1202 | # This tag requires that the tag GENERATE_HTML is set to YES. 1203 | 1204 | HTML_EXTRA_FILES = 1205 | 1206 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1207 | # will adjust the colors in the style sheet and background images according to 1208 | # this color. Hue is specified as an angle on a colorwheel, see 1209 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1210 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1211 | # purple, and 360 is red again. 1212 | # Minimum value: 0, maximum value: 359, default value: 220. 1213 | # This tag requires that the tag GENERATE_HTML is set to YES. 1214 | 1215 | HTML_COLORSTYLE_HUE = 220 1216 | 1217 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1218 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1219 | # value of 255 will produce the most vivid colors. 1220 | # Minimum value: 0, maximum value: 255, default value: 100. 1221 | # This tag requires that the tag GENERATE_HTML is set to YES. 1222 | 1223 | HTML_COLORSTYLE_SAT = 100 1224 | 1225 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1226 | # luminance component of the colors in the HTML output. Values below 100 1227 | # gradually make the output lighter, whereas values above 100 make the output 1228 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1229 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1230 | # change the gamma. 1231 | # Minimum value: 40, maximum value: 240, default value: 80. 1232 | # This tag requires that the tag GENERATE_HTML is set to YES. 1233 | 1234 | HTML_COLORSTYLE_GAMMA = 80 1235 | 1236 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1237 | # page will contain the date and time when the page was generated. Setting this 1238 | # to YES can help to show when doxygen was last run and thus if the 1239 | # documentation is up to date. 1240 | # The default value is: NO. 1241 | # This tag requires that the tag GENERATE_HTML is set to YES. 1242 | 1243 | HTML_TIMESTAMP = NO 1244 | 1245 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1246 | # documentation will contain sections that can be hidden and shown after the 1247 | # page has loaded. 1248 | # The default value is: NO. 1249 | # This tag requires that the tag GENERATE_HTML is set to YES. 1250 | 1251 | HTML_DYNAMIC_SECTIONS = NO 1252 | 1253 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1254 | # shown in the various tree structured indices initially; the user can expand 1255 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1256 | # such a level that at most the specified number of entries are visible (unless 1257 | # a fully collapsed tree already exceeds this amount). So setting the number of 1258 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1259 | # representing an infinite number of entries and will result in a full expanded 1260 | # tree by default. 1261 | # Minimum value: 0, maximum value: 9999, default value: 100. 1262 | # This tag requires that the tag GENERATE_HTML is set to YES. 1263 | 1264 | HTML_INDEX_NUM_ENTRIES = 100 1265 | 1266 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1267 | # generated that can be used as input for Apple's Xcode 3 integrated development 1268 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1269 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1270 | # Makefile in the HTML output directory. Running make will produce the docset in 1271 | # that directory and running make install will install the docset in 1272 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1273 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1274 | # for more information. 1275 | # The default value is: NO. 1276 | # This tag requires that the tag GENERATE_HTML is set to YES. 1277 | 1278 | GENERATE_DOCSET = NO 1279 | 1280 | # This tag determines the name of the docset feed. A documentation feed provides 1281 | # an umbrella under which multiple documentation sets from a single provider 1282 | # (such as a company or product suite) can be grouped. 1283 | # The default value is: Doxygen generated docs. 1284 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1285 | 1286 | DOCSET_FEEDNAME = "Doxygen generated docs" 1287 | 1288 | # This tag specifies a string that should uniquely identify the documentation 1289 | # set bundle. This should be a reverse domain-name style string, e.g. 1290 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1291 | # The default value is: org.doxygen.Project. 1292 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1293 | 1294 | DOCSET_BUNDLE_ID = org.doxygen.Project 1295 | 1296 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1297 | # the documentation publisher. This should be a reverse domain-name style 1298 | # string, e.g. com.mycompany.MyDocSet.documentation. 1299 | # The default value is: org.doxygen.Publisher. 1300 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1301 | 1302 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1303 | 1304 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1305 | # The default value is: Publisher. 1306 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1307 | 1308 | DOCSET_PUBLISHER_NAME = Publisher 1309 | 1310 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1311 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1312 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1313 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1314 | # Windows. 1315 | # 1316 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1317 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1318 | # files are now used as the Windows 98 help format, and will replace the old 1319 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1320 | # HTML files also contain an index, a table of contents, and you can search for 1321 | # words in the documentation. The HTML workshop also contains a viewer for 1322 | # compressed HTML files. 1323 | # The default value is: NO. 1324 | # This tag requires that the tag GENERATE_HTML is set to YES. 1325 | 1326 | GENERATE_HTMLHELP = NO 1327 | 1328 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1329 | # file. You can add a path in front of the file if the result should not be 1330 | # written to the html output directory. 1331 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1332 | 1333 | CHM_FILE = 1334 | 1335 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1336 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1337 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1338 | # The file has to be specified with full path. 1339 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1340 | 1341 | HHC_LOCATION = 1342 | 1343 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1344 | # (YES) or that it should be included in the master .chm file (NO). 1345 | # The default value is: NO. 1346 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1347 | 1348 | GENERATE_CHI = NO 1349 | 1350 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1351 | # and project file content. 1352 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1353 | 1354 | CHM_INDEX_ENCODING = 1355 | 1356 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1357 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1358 | # enables the Previous and Next buttons. 1359 | # The default value is: NO. 1360 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1361 | 1362 | BINARY_TOC = NO 1363 | 1364 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1365 | # the table of contents of the HTML help documentation and to the tree view. 1366 | # The default value is: NO. 1367 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1368 | 1369 | TOC_EXPAND = NO 1370 | 1371 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1372 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1373 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1374 | # (.qch) of the generated HTML documentation. 1375 | # The default value is: NO. 1376 | # This tag requires that the tag GENERATE_HTML is set to YES. 1377 | 1378 | GENERATE_QHP = NO 1379 | 1380 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1381 | # the file name of the resulting .qch file. The path specified is relative to 1382 | # the HTML output folder. 1383 | # This tag requires that the tag GENERATE_QHP is set to YES. 1384 | 1385 | QCH_FILE = 1386 | 1387 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1388 | # Project output. For more information please see Qt Help Project / Namespace 1389 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1390 | # The default value is: org.doxygen.Project. 1391 | # This tag requires that the tag GENERATE_QHP is set to YES. 1392 | 1393 | QHP_NAMESPACE = org.doxygen.Project 1394 | 1395 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1396 | # Help Project output. For more information please see Qt Help Project / Virtual 1397 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1398 | # folders). 1399 | # The default value is: doc. 1400 | # This tag requires that the tag GENERATE_QHP is set to YES. 1401 | 1402 | QHP_VIRTUAL_FOLDER = doc 1403 | 1404 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1405 | # filter to add. For more information please see Qt Help Project / Custom 1406 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1407 | # filters). 1408 | # This tag requires that the tag GENERATE_QHP is set to YES. 1409 | 1410 | QHP_CUST_FILTER_NAME = 1411 | 1412 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1413 | # custom filter to add. For more information please see Qt Help Project / Custom 1414 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1415 | # filters). 1416 | # This tag requires that the tag GENERATE_QHP is set to YES. 1417 | 1418 | QHP_CUST_FILTER_ATTRS = 1419 | 1420 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1421 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1422 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1423 | # This tag requires that the tag GENERATE_QHP is set to YES. 1424 | 1425 | QHP_SECT_FILTER_ATTRS = 1426 | 1427 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1428 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1429 | # generated .qhp file. 1430 | # This tag requires that the tag GENERATE_QHP is set to YES. 1431 | 1432 | QHG_LOCATION = 1433 | 1434 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1435 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1436 | # install this plugin and make it available under the help contents menu in 1437 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1438 | # to be copied into the plugins directory of eclipse. The name of the directory 1439 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1440 | # After copying Eclipse needs to be restarted before the help appears. 1441 | # The default value is: NO. 1442 | # This tag requires that the tag GENERATE_HTML is set to YES. 1443 | 1444 | GENERATE_ECLIPSEHELP = NO 1445 | 1446 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1447 | # the directory name containing the HTML and XML files should also have this 1448 | # name. Each documentation set should have its own identifier. 1449 | # The default value is: org.doxygen.Project. 1450 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1451 | 1452 | ECLIPSE_DOC_ID = org.doxygen.Project 1453 | 1454 | # If you want full control over the layout of the generated HTML pages it might 1455 | # be necessary to disable the index and replace it with your own. The 1456 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1457 | # of each HTML page. A value of NO enables the index and the value YES disables 1458 | # it. Since the tabs in the index contain the same information as the navigation 1459 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1460 | # The default value is: NO. 1461 | # This tag requires that the tag GENERATE_HTML is set to YES. 1462 | 1463 | DISABLE_INDEX = NO 1464 | 1465 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1466 | # structure should be generated to display hierarchical information. If the tag 1467 | # value is set to YES, a side panel will be generated containing a tree-like 1468 | # index structure (just like the one that is generated for HTML Help). For this 1469 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1470 | # (i.e. any modern browser). Windows users are probably better off using the 1471 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1472 | # further fine-tune the look of the index. As an example, the default style 1473 | # sheet generated by doxygen has an example that shows how to put an image at 1474 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1475 | # the same information as the tab index, you could consider setting 1476 | # DISABLE_INDEX to YES when enabling this option. 1477 | # The default value is: NO. 1478 | # This tag requires that the tag GENERATE_HTML is set to YES. 1479 | 1480 | GENERATE_TREEVIEW = NO 1481 | 1482 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1483 | # doxygen will group on one line in the generated HTML documentation. 1484 | # 1485 | # Note that a value of 0 will completely suppress the enum values from appearing 1486 | # in the overview section. 1487 | # Minimum value: 0, maximum value: 20, default value: 4. 1488 | # This tag requires that the tag GENERATE_HTML is set to YES. 1489 | 1490 | ENUM_VALUES_PER_LINE = 4 1491 | 1492 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1493 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1494 | # Minimum value: 0, maximum value: 1500, default value: 250. 1495 | # This tag requires that the tag GENERATE_HTML is set to YES. 1496 | 1497 | TREEVIEW_WIDTH = 250 1498 | 1499 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1500 | # external symbols imported via tag files in a separate window. 1501 | # The default value is: NO. 1502 | # This tag requires that the tag GENERATE_HTML is set to YES. 1503 | 1504 | EXT_LINKS_IN_WINDOW = NO 1505 | 1506 | # Use this tag to change the font size of LaTeX formulas included as images in 1507 | # the HTML documentation. When you change the font size after a successful 1508 | # doxygen run you need to manually remove any form_*.png images from the HTML 1509 | # output directory to force them to be regenerated. 1510 | # Minimum value: 8, maximum value: 50, default value: 10. 1511 | # This tag requires that the tag GENERATE_HTML is set to YES. 1512 | 1513 | FORMULA_FONTSIZE = 10 1514 | 1515 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1516 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1517 | # supported properly for IE 6.0, but are supported on all modern browsers. 1518 | # 1519 | # Note that when changing this option you need to delete any form_*.png files in 1520 | # the HTML output directory before the changes have effect. 1521 | # The default value is: YES. 1522 | # This tag requires that the tag GENERATE_HTML is set to YES. 1523 | 1524 | FORMULA_TRANSPARENT = YES 1525 | 1526 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1527 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1528 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1529 | # installed or if you want to formulas look prettier in the HTML output. When 1530 | # enabled you may also need to install MathJax separately and configure the path 1531 | # to it using the MATHJAX_RELPATH option. 1532 | # The default value is: NO. 1533 | # This tag requires that the tag GENERATE_HTML is set to YES. 1534 | 1535 | USE_MATHJAX = NO 1536 | 1537 | # When MathJax is enabled you can set the default output format to be used for 1538 | # the MathJax output. See the MathJax site (see: 1539 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1540 | # Possible values are: HTML-CSS (which is slower, but has the best 1541 | # compatibility), NativeMML (i.e. MathML) and SVG. 1542 | # The default value is: HTML-CSS. 1543 | # This tag requires that the tag USE_MATHJAX is set to YES. 1544 | 1545 | MATHJAX_FORMAT = HTML-CSS 1546 | 1547 | # When MathJax is enabled you need to specify the location relative to the HTML 1548 | # output directory using the MATHJAX_RELPATH option. The destination directory 1549 | # should contain the MathJax.js script. For instance, if the mathjax directory 1550 | # is located at the same level as the HTML output directory, then 1551 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1552 | # Content Delivery Network so you can quickly see the result without installing 1553 | # MathJax. However, it is strongly recommended to install a local copy of 1554 | # MathJax from http://www.mathjax.org before deployment. 1555 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1556 | # This tag requires that the tag USE_MATHJAX is set to YES. 1557 | 1558 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1559 | 1560 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1561 | # extension names that should be enabled during MathJax rendering. For example 1562 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1563 | # This tag requires that the tag USE_MATHJAX is set to YES. 1564 | 1565 | MATHJAX_EXTENSIONS = 1566 | 1567 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1568 | # of code that will be used on startup of the MathJax code. See the MathJax site 1569 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1570 | # example see the documentation. 1571 | # This tag requires that the tag USE_MATHJAX is set to YES. 1572 | 1573 | MATHJAX_CODEFILE = 1574 | 1575 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1576 | # the HTML output. The underlying search engine uses javascript and DHTML and 1577 | # should work on any modern browser. Note that when using HTML help 1578 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1579 | # there is already a search function so this one should typically be disabled. 1580 | # For large projects the javascript based search engine can be slow, then 1581 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1582 | # search using the keyboard; to jump to the search box use + S 1583 | # (what the is depends on the OS and browser, but it is typically 1584 | # , /