From 44ce8dd162f1139bcb8e97c3ff1614cd0891a50e Mon Sep 17 00:00:00 2001 From: lanserge Date: Thu, 2 Nov 2023 14:09:33 +0000 Subject: [PATCH 01/58] Added Verilog driver for netlist export (#80) CRL.Verilog.save(cell, 0) -> exports cell into Verilog netlist file Co-authored-by: Serge Rabyking --- crlcore/src/ccore/CMakeLists.txt | 3 + crlcore/src/ccore/crlcore/Verilog.h | 37 ++ crlcore/src/ccore/meson.build | 2 + crlcore/src/ccore/verilog/VerilogDriver.cpp | 371 ++++++++++++++++++++ crlcore/src/pyCRL/CMakeLists.txt | 2 + crlcore/src/pyCRL/PyCRL.cpp | 6 + crlcore/src/pyCRL/PyVerilog.cpp | 163 +++++++++ crlcore/src/pyCRL/crlcore/PyVerilog.h | 50 +++ crlcore/src/pyCRL/meson.build | 1 + 9 files changed, 635 insertions(+) create mode 100644 crlcore/src/ccore/crlcore/Verilog.h create mode 100644 crlcore/src/ccore/verilog/VerilogDriver.cpp create mode 100644 crlcore/src/pyCRL/PyVerilog.cpp create mode 100644 crlcore/src/pyCRL/crlcore/PyVerilog.h diff --git a/crlcore/src/ccore/CMakeLists.txt b/crlcore/src/ccore/CMakeLists.txt index 4c05f2b43..edc8ab45e 100644 --- a/crlcore/src/ccore/CMakeLists.txt +++ b/crlcore/src/ccore/CMakeLists.txt @@ -106,6 +106,8 @@ spice/SpiceParser.cpp spice/SpiceDriver.cpp ) + set ( verilog_cpps verilog/VerilogDriver.cpp + ) set ( bookshelf_cpps bookshelf/BookshelfParser.cpp bookshelf/BookshelfDriver.cpp ) @@ -299,6 +301,7 @@ ${ispd05_cpps} ${blif_cpps} ${spice_cpps} + ${verilog_cpps} ${lefdef_cpps} ${openaccess_cpps} ) diff --git a/crlcore/src/ccore/crlcore/Verilog.h b/crlcore/src/ccore/crlcore/Verilog.h new file mode 100644 index 000000000..3705fe802 --- /dev/null +++ b/crlcore/src/ccore/crlcore/Verilog.h @@ -0,0 +1,37 @@ +// -*- C++ -*- +// +// This file is part of the Coriolis Software. +// Copyright (c) SU/LIP6 2021-2023, All Rights Reserved +// +// +-----------------------------------------------------------------+ +// | C O R I O L I S | +// | Verilog / Hurricane Interface | +// | | +// | Authors : Jean-Paul CHAPUT, Serge Rabyking | +// | E-mail : Jean-Paul.Chaput@lip6.fr | +// | =============================================================== | +// | C++ Header : "./crlcore/Verilog.h" | +// +-----------------------------------------------------------------+ + + +#pragma once +#include + +namespace Hurricane { + class Cell; + class Library; +} + +namespace CRL { + + using Hurricane::Cell; + using Hurricane::Library; + + class Verilog { + public: + static const uint64_t TopCell = (1 << 0); + public: + static bool save ( Cell*, uint64_t flags ); + }; + +} // CRL namespace. diff --git a/crlcore/src/ccore/meson.build b/crlcore/src/ccore/meson.build index dcd001ed7..4a0ee7c20 100644 --- a/crlcore/src/ccore/meson.build +++ b/crlcore/src/ccore/meson.build @@ -3,6 +3,7 @@ crlcore_includes = include_directories( 'acmsigda', 'iccad04', 'spice', + 'verilog', 'lefdef', 'blif', 'alliance/ap', @@ -85,6 +86,7 @@ crlcore = shared_library( 'spice/SpiceEntity.cpp', 'spice/SpiceParser.cpp', 'spice/SpiceDriver.cpp', + 'verilog/VerilogDriver.cpp', 'alliance/ap/ApParser.cpp', 'alliance/ap/ApDriver.cpp', 'gds/GdsDriver.cpp', diff --git a/crlcore/src/ccore/verilog/VerilogDriver.cpp b/crlcore/src/ccore/verilog/VerilogDriver.cpp new file mode 100644 index 000000000..c44da8da3 --- /dev/null +++ b/crlcore/src/ccore/verilog/VerilogDriver.cpp @@ -0,0 +1,371 @@ + +// -*- C++ -*- +// +// This file is part of the Coriolis Software. +// Copyright (c) SU 2021-2023, All Rights Reserved +// +// +-----------------------------------------------------------------+ +// | C O R I O L I S | +// | Verilog / Hurricane Interface | +// | | +// | Authors : Jean-Paul CHAPUT, Serge Rabyking | +// | E-mail : Jean-Paul.Chaput@lip6.fr | +// | =============================================================== | +// | C++ Module : "./verilog/VerilogDriver.cpp" | +// +-----------------------------------------------------------------+ + + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +using namespace std; + +#include "hurricane/configuration/Configuration.h" +#include "hurricane/Warning.h" +#include "hurricane/DataBase.h" +#include "hurricane/BasicLayer.h" +#include "hurricane/Technology.h" +#include "hurricane/Horizontal.h" +#include "hurricane/Vertical.h" +#include "hurricane/Diagonal.h" +#include "hurricane/Rectilinear.h" +#include "hurricane/Polygon.h" +#include "hurricane/Pad.h" +#include "hurricane/Net.h" +#include "hurricane/NetExternalComponents.h" +#include "hurricane/Cell.h" +#include "hurricane/Plug.h" +#include "hurricane/Instance.h" +using namespace Hurricane; + +#include "crlcore/Utilities.h" +#include "crlcore/NetExtension.h" +#include "crlcore/ToolBox.h" +#include "crlcore/Verilog.h" +//#include "crlcore/VerilogBit.h" +//#include "crlcore/VerilogEntity.h" + +using namespace CRL; + +namespace CRL { + + static void _write_hdr(ofstream &out) + { + time_t clock = time( nullptr ); + tm tm = *localtime( &clock ); + char stamp[1024]; + strftime( stamp, 1024, "%b %d, %Y, %H:%M", &tm ); + + out << "/* Coriolis Verilog Driver */" << std::endl; + out << "/* Generated on " << stamp << " */" << std::endl; + } + + static void _populate_non_terminal_cells(Cell* cell, std::set &cells) + { + if(!cells.insert(cell).second) + { + // insertion not happend because it was there already + return; + } + for(Occurrence occurrence: cell->getNonTerminalNetlistInstanceOccurrences()) + { + Cell* mod = static_cast( occurrence.getEntity() )->getMasterCell(); + // recursively find all related Non-terminal cells (part of the user's design hierarchy) + _populate_non_terminal_cells(mod, cells); + } + } + + std::pair _wire2bus(std::string name) + { + std::pair bus(name, -1); + int i = name.size() - 1; + while (std::isspace(name[i])) --i;// remove trailing spaces just in case + if(name[i] == ')') // name ends with bracket so is in the form "some_wire_name(index)" + { + for(int j = i;;) + { + if(--j < 0) + { + // didn't find starting bracket + // this should never happen + std::cerr << "Wrongly formatted net name: " << name << std::endl; + assert(false); + } + if(name[j] == '(') // find starting bracket + { + bus.second = std::stoi(name.substr(j+1, i-j-1)); // get index + while (std::isspace(name[j-1])) --j; // ignore spaces before starting bracket + bus.first.erase(j); // trim name to not include index part with brackets + break; + } + } + } + return bus; + } + + static void _write_cell(ofstream &out, Cell* cell) + { + out << std::endl; + std::set nets; + std::vector ports, wires; + for(Instance* instance: cell->getInstances()) // go through all cells instances that form our cell + { + for(Plug* plug: instance->getPlugs()) // plugs are connect points of the cells + { + Net* net = plug->getMasterNet(); + if(net->isPower() || net->isGround()) // VDD and VSS are not part of Verilog netlist + { + continue; + } + net = plug->getNet(); + if(net->isExternal()) // propogates through ports + { + ports.push_back(net); + nets.insert(net); // collect all nets we use + } + else + { + if(!nets.insert(net).second) // the insertion not happend as it was already there + { + // this net was already enumerated in some other cell + // so this wire used at least between two cells and need to be declared + wires.push_back(net); + } + } + } + } + std::map > net2bus; + for(Net *net: nets) + { + net2bus.insert(std::make_pair(net, _wire2bus(getString(net->getName())))); + } + std::vector names; + // collect all port names without indexes in ordered way + for(Net *net: ports) + { + std::string &name = net2bus[net].first; + auto it = std::lower_bound(names.begin(), names.end(), name); + if(it == names.end() || (*it) != name) // name not in the list yet + { + names.insert(it, name); + } + } + // declare Verilog module with ports names + out << "module " << getString(cell->getName()) << "("; + for ( auto it = names.begin(); it != names.end(); ++it) + { + out << (*it); + if (it + 1 != names.end()) + { + out << ", "; + } + } + out << ");\n"; + // now individually declare each port with direction and width + for (auto &name: names) + { + int idx_min = -1, idx_max; + Net::Direction dir; + for (auto it: net2bus) + { + if (it.second.first == name) // find net with name + { + int idx = it.second.second; + if (idx < 0) + { + if (idx_min >= 0) + { + std::cerr << "Net name \"" << name << "\" used with index " << idx_min + << " and without index" << std::endl; + assert(false); + } + dir = it.first->getDirection(); + break; + } + if (idx_min < 0) + { + idx_min = idx_max = idx; + dir = it.first->getDirection(); + } + else + { + if (idx < idx_min) + { + idx_min = idx; + } + if (idx > idx_max) + { + idx_max = idx; + } + if (dir != it.first->getDirection()) + { + int other = (idx == idx_min)?idx_max:idx_min; + std::cerr << "Net \"" << name << "\" with index " << idx << " and " << other + << " has different directions" << std::endl; + assert(false); + } + } + } + } + if (dir == Net::Direction::IN) + { + out << " input "; + } + else if (dir == Net::Direction::INOUT) + { + out << " inout "; + } + else if (dir == Net::Direction::OUT) + { + out << " output "; + } + else + { + std::cerr << "Undetermined direction " << dir << " for the net \"" << name << "\"" << std::endl; + assert(false); + } + if (idx_min >= 0) + { + out << "[" << idx_max << ":" << idx_min << "] "; + } + out << name << ";" << std::endl; + } + // collect all wires (and not ports) names without indexes in ordered way + names.clear(); + for(Net *net: wires) + { + std::string &name = net2bus[net].first; + auto it = std::lower_bound(names.begin(), names.end(), name); + if(it == names.end() || (*it) != name) // name not in the list yet + { + names.insert(it, name); + } + } + // now individually declare each wire with width + for (auto &name: names) + { + int idx_min = -1, idx_max = -1; + for (auto it: net2bus) + { + if (it.second.first == name) // find all nets by name + { + int idx = it.second.second; + if (idx < 0) // without index + { + if (idx_min >= 0) + { + std::cerr << "Net name \"" << name << "\" used with index " << idx_min + << " and without index" << std::endl; + assert(false); + } + break; + } + if (idx_min < 0) // first time encountered + { + idx_min = idx_max = idx; + } + else + { + if (idx < idx_min) + { + idx_min = idx; + } + if (idx > idx_max) + { + idx_max = idx; + } + } + } + } + out << " wire "; + if (idx_min >= 0) + { + out << "[" << idx_max << ":" << idx_min << "] "; + } + out << name << ";" << std::endl; + } + // free not needed resources + names.clear(); + ports.clear(); + wires.clear(); + nets.clear(); + // declare instancies with connections + for(Instance* instance: cell->getInstances()) // go through all cells instances that form our cell + { + std::vector conns; + for(Plug* plug: instance->getPlugs()) // plugs are connect points of the cells + { + Net* net = plug->getMasterNet(); + if(net->isPower() || net->isGround()) // VDD and VSS are not part of Verilog netlist + { + continue; + } + // insert in sorted order + auto it = std::lower_bound(conns.begin(), conns.end(), plug, + [](Plug* lhs, Plug* rhs) -> bool + { return getString(lhs->getMasterNet()->getName()) < + getString(rhs->getMasterNet()->getName()); }); + conns.insert(it, plug); + } + if (conns.empty()) // instance has no connections apart from VSS&VDD + { + continue; + } + // declare instance + out << " " << getString(instance->getMasterCell()->getName()) << " " + << getString(instance->getName()) << " (" << std::endl; + // declare connections + for (auto it = conns.begin(); it != conns.end(); ++it) + { + auto &info = net2bus[(*it)->getNet()]; + out << " ." << getString((*it)->getMasterNet()->getName()) << "(" << info.first; + if (info.second >= 0) // indexed wire + { + out << "[" << info.second << "]"; + } + out << ")"; + if ( it+1 != conns.end()) // not last, so need comma + { + out << ","; + } + out << std::endl; + } + out << " );" << std::endl; + } + out << "endmodule" << std::endl; + } + +// ------------------------------------------------------------------- +// Class : "CRL::Verilog". + + bool Verilog::save ( Cell* cell, uint64_t flags ) + { + ofstream out(getString(cell->getName()) + ".v"); + _write_hdr(out); + if (flags & TopCell) + { + _write_cell(out, cell); + } + else + { + std::set cells; + _populate_non_terminal_cells(cell, cells); + for (auto &it: cells) + { + _write_cell(out, it); + } + } + out.close(); + return true; + } + +} // CRL namespace. diff --git a/crlcore/src/pyCRL/CMakeLists.txt b/crlcore/src/pyCRL/CMakeLists.txt index f66dc190d..23c3dd135 100644 --- a/crlcore/src/pyCRL/CMakeLists.txt +++ b/crlcore/src/pyCRL/CMakeLists.txt @@ -56,6 +56,7 @@ PyAcmSigda.cpp #PyIspd05.cpp PySpice.cpp + PyVerilog.cpp PyBlif.cpp PyGds.cpp PyLefImport.cpp @@ -80,6 +81,7 @@ crlcore/PyAcmSigda.h #crlcore/PyIspd05.h crlcore/PySpice.h + crlcore/PyVerilog.h crlcore/PyBlif.h crlcore/PyGds.h crlcore/PyLefImport.h diff --git a/crlcore/src/pyCRL/PyCRL.cpp b/crlcore/src/pyCRL/PyCRL.cpp index 9a405f1e8..6c5ea9bff 100644 --- a/crlcore/src/pyCRL/PyCRL.cpp +++ b/crlcore/src/pyCRL/PyCRL.cpp @@ -34,6 +34,7 @@ #include "crlcore/PyAcmSigda.h" // #include "crlcore/PyIspd05.h" #include "crlcore/PySpice.h" +#include "crlcore/PyVerilog.h" #include "crlcore/PyBlif.h" #include "crlcore/PyGds.h" #include "crlcore/PyLefImport.h" @@ -129,6 +130,7 @@ extern "C" { PyAcmSigda_LinkPyType (); // PyIspd05_LinkPyType (); PySpice_LinkPyType (); + PyVerilog_LinkPyType (); PyBlif_LinkPyType (); PyGds_LinkPyType (); PyLefImport_LinkPyType (); @@ -154,6 +156,7 @@ extern "C" { PYTYPE_READY_NEW ( AcmSigda ); // PYTYPE_READY_NEW ( Ispd05 ); PYTYPE_READY_NEW ( Spice ); + PYTYPE_READY_NEW ( Verilog ); PYTYPE_READY_NEW ( Blif ); PYTYPE_READY_NEW ( Gds ); PYTYPE_READY_NEW ( LefImport ); @@ -205,6 +208,8 @@ extern "C" { // PyModule_AddObject ( module, "Ispd05", (PyObject*)&PyTypeIspd05 ); Py_INCREF ( &PyTypeSpice ); PyModule_AddObject ( module, "Spice", (PyObject*)&PyTypeSpice ); + Py_INCREF ( &PyTypeVerilog ); + PyModule_AddObject ( module, "Verilog", (PyObject*)&PyTypeVerilog ); Py_INCREF ( &PyTypeBlif ); PyModule_AddObject ( module, "Blif", (PyObject*)&PyTypeBlif ); Py_INCREF ( &PyTypeGds ); @@ -224,6 +229,7 @@ extern "C" { PyRoutingLayerGauge_postModuleInit (); PyAllianceFramework_postModuleInit (); PySpice_postModuleInit (); + PyVerilog_postModuleInit (); PyGds_postModuleInit (); PyDefExport_postModuleInit (); diff --git a/crlcore/src/pyCRL/PyVerilog.cpp b/crlcore/src/pyCRL/PyVerilog.cpp new file mode 100644 index 000000000..7610468ad --- /dev/null +++ b/crlcore/src/pyCRL/PyVerilog.cpp @@ -0,0 +1,163 @@ +// -*- C++ -*- +// +// This file is part of the Coriolis Software. +// Copyright (c) SU 2021-2021, All Rights Reserved +// +// +-----------------------------------------------------------------+ +// | C O R I O L I S | +// | Verilog / Hurricane Interface | +// | | +// | Authors : Jean-Paul CHAPUT, Serge Rabyking | +// | E-mail : Jean-Paul.Chaput@lip6.fr | +// | =============================================================== | +// | C++ Module : "./PyVerilog.cpp" | +// +-----------------------------------------------------------------+ + + +#include "crlcore/PyVerilog.h" +#include "hurricane/isobar/PyCell.h" +#include "hurricane/isobar/PyLibrary.h" +//#include "crlcore/VerilogEntity.h" +#include +#include + +namespace CRL { + + using std::cerr; + using std::endl; + using std::hex; + using std::string; + using std::ostringstream; + using Hurricane::tab; + using Hurricane::Exception; + using Hurricane::Bug; + using Hurricane::Error; + using Hurricane::Warning; + using Isobar::ProxyProperty; + using Isobar::ProxyError; + using Isobar::ConstructorError; + using Isobar::HurricaneError; + using Isobar::HurricaneWarning; + using Isobar::getPyHash; + using Isobar::ParseOneArg; + using Isobar::ParseTwoArg; + using Isobar::__cs; + using Isobar::PyCell; + using Isobar::PyTypeCell; + using Isobar::PyCell_Link; + using Isobar::PyLibrary; + using Isobar::PyTypeLibrary; + using Isobar::PyLibrary_Link; + +extern "C" { + +#if defined(__PYTHON_MODULE__) + +// +=================================================================+ +// | "PyVerilog" Python Module Code Part | +// +=================================================================+ + + + static PyObject* PyVerilog_save ( PyObject*, PyObject* args ) + { + cdebug_log(30,0) << "PyVerilog_save()" << endl; + + HTRY + long flags = 0; + PyObject* pyCell = NULL; + if (PyArg_ParseTuple( args, "Ol:Verilog.save", &pyCell, &flags )) { + if (IsPyCell(pyCell)) { + Verilog::save( PYCELL_O(pyCell), flags ); + } else { + PyErr_SetString( ConstructorError, "Verilog.save(): Bad parameter type (not a Cell)." ); + return NULL; + } + } else { + std::cout << ConstructorError << std::endl; + PyErr_SetString( ConstructorError, "Verilog.save(): Bad number of parameters." ); + return NULL; + } + HCATCH + + Py_RETURN_NONE; + } + + +// static PyObject* PyVerilog_load ( PyObject*, PyObject* args ) +// { +// cdebug_log(30,0) << "PyVerilog_load()" << endl; + + +// HTRY +// unsigned long mode = 0; +// char* path = NULL; +// PyObject* pyLibrary = NULL; +// if (PyArg_ParseTuple( args, "Osk:Verilog.load", &pyLibrary, &path, &mode )) { +// if (IsPyLibrary(pyLibrary)) { +// Verilog::load( PYLIBRARY_O(pyLibrary), string(path), (uint64_t)mode ); +// } else { +// PyErr_SetString( ConstructorError, "Verilog.load(): Bad parameter type (not a Library)." ); +// return NULL; +// } +// } else { +// PyErr_SetString( ConstructorError, "Verilog.load(): Bad number of parameters." ); +// return NULL; +// } +// HCATCH + +// Py_RETURN_NONE; +// } + + +// static PyObject* PyVerilog_clearProperties ( PyObject* ) +// { +// cdebug_log(30,0) << "PyVerilog_clearProperties()" << endl; +// HTRY +// Verilog::clearProperties(); +// HCATCH +// Py_RETURN_NONE; +// } + + + // Standart Destroy (Attribute). + + + PyMethodDef PyVerilog_Methods[] = + { { "save" , (PyCFunction)PyVerilog_save , METH_VARARGS|METH_STATIC + , "Save a complete Verilog design." } + // , { "load" , (PyCFunction)PyVerilog_load , METH_VARARGS|METH_STATIC + // , "Load a Verilog layout inside a Cell (cumulative)." } + // , { "clearProperties" , (PyCFunction)PyVerilog_clearProperties, METH_NOARGS|METH_STATIC + // , "Remove all Verilog related properties from the Cells." } + , {NULL, NULL, 0, NULL} /* sentinel */ + }; + + + NoObjectDeleteMethod(Verilog) + PyTypeObjectLinkPyTypeWithoutObject(Verilog,Verilog) + + +#else // End of Python Module Code Part. + + +// +=================================================================+ +// | "PyVerilog" Shared Library Code Part | +// +=================================================================+ + + // Type Definition. + PyTypeObjectDefinitionsOfModule(CRL,Verilog) + + + extern void PyVerilog_postModuleInit () + { + PyObject* constant; + + LoadObjectConstant(PyTypeVerilog.tp_dict,::CRL::Verilog::TopCell ,"TopCell"); + } + + +#endif // End of Shared Library Code Part. + +} // extern "C". + +} // CRL namespace. diff --git a/crlcore/src/pyCRL/crlcore/PyVerilog.h b/crlcore/src/pyCRL/crlcore/PyVerilog.h new file mode 100644 index 000000000..165fcc82a --- /dev/null +++ b/crlcore/src/pyCRL/crlcore/PyVerilog.h @@ -0,0 +1,50 @@ + +// -*- C++ -*- +// +// This file is part of the Coriolis Software. +// Copyright (c) SU 2021-2023, All Rights Reserved +// +// +-----------------------------------------------------------------+ +// | C O R I O L I S | +// | Verilog / Hurricane Interface | +// | | +// | Authors : Jean-Paul CHAPUT, Serge Rabyking | +// | E-mail : Jean-Paul.Chaput@lip6.fr | +// | =============================================================== | +// | C++ Header : "./crlcore/PyVerilog.h" | +// +-----------------------------------------------------------------+ + + +#pragma once +#include "hurricane/isobar/PyHurricane.h" +#include "crlcore/Verilog.h" + + +namespace CRL { + +extern "C" { + + +// ------------------------------------------------------------------- +// Python Object : "PyVerilog". + + typedef struct { + PyObject_HEAD + } PyVerilog; + + +// ------------------------------------------------------------------- +// Functions & Types exported to "PyCRL.ccp". + + extern PyTypeObject PyTypeVerilog; + extern PyMethodDef PyVerilog_Methods[]; + + extern void PyVerilog_LinkPyType (); + extern void PyVerilog_postModuleInit (); + +#define IsPyVerilog(v) ( (v)->ob_type == &PyTypeVerilog ) +#define PY_VERILOG(v) ( (PyVerilog*)(v) ) + +} // extern "C". + +} // Hurricane namespace. diff --git a/crlcore/src/pyCRL/meson.build b/crlcore/src/pyCRL/meson.build index 41bdaa1f9..7c05f2fb8 100644 --- a/crlcore/src/pyCRL/meson.build +++ b/crlcore/src/pyCRL/meson.build @@ -18,6 +18,7 @@ pyCRL_files = files([ 'PyGraphicToolEngine.cpp', 'PyAcmSigda.cpp', 'PySpice.cpp', + 'PyVerilog.cpp', 'PyBlif.cpp', 'PyGds.cpp', 'PyLefImport.cpp', From d27cc8b956998f3e90eb4bc8ae08199726e0e8e5 Mon Sep 17 00:00:00 2001 From: Gabriel Gouvine Date: Thu, 2 Nov 2023 19:58:35 +0100 Subject: [PATCH 02/58] Split callback in Etesian to allow for derived placer classes --- etesian/src/EtesianEngine.cpp | 20 +++++++++++++------- etesian/src/PyEtesian.cpp | 2 +- etesian/src/etesian/EtesianEngine.h | 6 +++++- 3 files changed, 19 insertions(+), 9 deletions(-) diff --git a/etesian/src/EtesianEngine.cpp b/etesian/src/EtesianEngine.cpp index 0947ce285..9845bcb33 100644 --- a/etesian/src/EtesianEngine.cpp +++ b/etesian/src/EtesianEngine.cpp @@ -1080,6 +1080,18 @@ namespace Etesian { } void EtesianEngine::_coloquinteCallback(coloquinte::PlacementStep step) { + + // Graphical update + GraphicUpdate conf = getUpdateConf(); + bool updatePlacement = conf == GraphicUpdate::UpdateAll; + if (conf == GraphicUpdate::LowerBound && + step == coloquinte::PlacementStep::LowerBound) { + updatePlacement = true; + } + _coloquinteCallbackCore(step, updatePlacement); + } + + void EtesianEngine::_coloquinteCallbackCore(coloquinte::PlacementStep step, bool updatePlacement) { auto placement = _circuit->solution(); if (step == coloquinte::PlacementStep::LowerBound) { *_placementLB = placement; @@ -1088,13 +1100,7 @@ namespace Etesian { *_placementUB = placement; } - // Graphical update - GraphicUpdate conf = getUpdateConf(); - if (conf == GraphicUpdate::UpdateAll) { - _updatePlacement(&placement); - } - else if (conf == GraphicUpdate::LowerBound && - step == coloquinte::PlacementStep::LowerBound) { + if (updatePlacement) { _updatePlacement(&placement); } } diff --git a/etesian/src/PyEtesian.cpp b/etesian/src/PyEtesian.cpp index 7edb0c9e8..d631b5010 100644 --- a/etesian/src/PyEtesian.cpp +++ b/etesian/src/PyEtesian.cpp @@ -63,7 +63,7 @@ extern "C" { static PyModuleDef PyEtesian_ModuleDef = { PyModuleDef_HEAD_INIT , "Etesian" /* m_name */ - , "Standard cell analytical placer (based on SimPL)." + , "Standard cell analytical placer." /* m_doc */ , -1 /* m_size */ , PyEtesian_Methods /* m_methods */ diff --git a/etesian/src/etesian/EtesianEngine.h b/etesian/src/etesian/EtesianEngine.h index 03af530af..eb614253f 100644 --- a/etesian/src/etesian/EtesianEngine.h +++ b/etesian/src/etesian/EtesianEngine.h @@ -185,11 +185,15 @@ namespace Etesian { private: EtesianEngine ( const EtesianEngine& ); EtesianEngine& operator= ( const EtesianEngine& ); + + protected: + virtual void _coloquinteCallback(coloquinte::PlacementStep step); + void _coloquinteCallbackCore(coloquinte::PlacementStep step, bool updatePlacement); + private: inline uint32_t _getNewDiodeId (); Instance* _createDiode ( Cell* ); void _updatePlacement ( const coloquinte::PlacementSolution* ); - void _coloquinteCallback(coloquinte::PlacementStep step); void _checkNotAFeed ( Occurrence occurrence ) const; }; From 339ed4f9ffa0d90d84a41c4680def1357374bc02 Mon Sep 17 00:00:00 2001 From: Gabriel Gouvine Date: Thu, 2 Nov 2023 20:02:43 +0100 Subject: [PATCH 03/58] Introduce flags for placement callbacks in Etesian --- katana/src/Constants.cpp | 1 + katana/src/GlobalRoute.cpp | 23 +++++++++++++++++++---- katana/src/KatanaEngine.cpp | 15 ++++++++------- katana/src/PyKatanaEngine.cpp | 22 ++++++++++++++-------- katana/src/katana/Constants.h | 1 + katana/src/katana/KatanaEngine.h | 4 ++-- 6 files changed, 45 insertions(+), 21 deletions(-) diff --git a/katana/src/Constants.cpp b/katana/src/Constants.cpp index 694f5a6d4..47d1ae502 100644 --- a/katana/src/Constants.cpp +++ b/katana/src/Constants.cpp @@ -40,6 +40,7 @@ namespace Katana { const Hurricane::BaseFlags Flags::ShowOverloadedGCells = (1L << 36); const Hurricane::BaseFlags Flags::ShowBloatedInstances = (1L << 37); const Hurricane::BaseFlags Flags::ProtectSelf = (1L << 38); + const Hurricane::BaseFlags Flags::PlacementCallback = (1L << 39); } // Anabatic namespace. diff --git a/katana/src/GlobalRoute.cpp b/katana/src/GlobalRoute.cpp index 66703b451..262e1914b 100644 --- a/katana/src/GlobalRoute.cpp +++ b/katana/src/GlobalRoute.cpp @@ -380,12 +380,15 @@ namespace Katana { } - void KatanaEngine::setupGlobalGraph ( uint32_t mode ) + void KatanaEngine::setupGlobalGraph ( Flags flags ) { Cell* cell = getCell(); cell->flattenNets( Cell::Flags::BuildRings|Cell::Flags::WarnOnUnplacedInstances ); - cell->createRoutingPadRings( Cell::Flags::BuildRings ); + + if (!(flags & Flags::PlacementCallback)) { + cell->createRoutingPadRings( Cell::Flags::BuildRings ); + } startMeasures(); @@ -500,6 +503,15 @@ namespace Katana { if (flags & Flags::ShowBloatedInstances) selectBloatedInstances( this ); Breakpoint::stop( 100, "Bloated cells from previous placement iteration." ); + if (not isChannelStyle()) { + if (!(flags & Flags::PlacementCallback)) { + setupPowerRails(); + Flags protectFlags = (getConfiguration()->getNetBuilderStyle() == "VH,2RL") + ? Flags::ProtectSelf : Flags::NoFlags; + protectRoutingPads( protectFlags ); + } + } + startMeasures(); cmess1 << " o Running global routing." << endl; @@ -708,8 +720,11 @@ namespace Katana { Session::close(); if (isChannelStyle()) { setupRoutingPlanes(); - setupPowerRails(); - protectRoutingPads(); + + if (!(flags & Flags::PlacementCallback)) { + setupPowerRails(); + protectRoutingPads(); + } } setState( EngineState::EngineGlobalLoaded ); diff --git a/katana/src/KatanaEngine.cpp b/katana/src/KatanaEngine.cpp index 31ee4ca06..9b000743a 100644 --- a/katana/src/KatanaEngine.cpp +++ b/katana/src/KatanaEngine.cpp @@ -240,7 +240,7 @@ namespace Katana { } - void KatanaEngine::digitalInit () + void KatanaEngine::digitalInit ( Flags flags ) { cdebug_log(155,1) << "KatanaEngine::_initDataBase()" << endl; _runKatanaInit(); @@ -250,7 +250,7 @@ namespace Katana { Super::chipPrep(); setupChannelMode(); - setupGlobalGraph( 0 ); + setupGlobalGraph( flags ); if (not isChannelStyle()) { setupRoutingPlanes(); } @@ -258,15 +258,16 @@ namespace Katana { if (not setupPreRouteds()) { setState( Anabatic::EngineDriving ); throw Error( "KatanaEngine::digitalInit(): All nets are already routed, doing nothing." ); - } else { - if (not isChannelStyle()) { + } + + if (not isChannelStyle()) { + if (!(flags & Flags::PlacementCallback)) { setupPowerRails(); - Flags flags = (getConfiguration()->getNetBuilderStyle() == "VH,2RL") + Flags protectFlags = (getConfiguration()->getNetBuilderStyle() == "VH,2RL") ? Flags::ProtectSelf : Flags::NoFlags; - protectRoutingPads( flags ); + protectRoutingPads( protectFlags ); } } - cdebug_tabw(155,-1); } diff --git a/katana/src/PyKatanaEngine.cpp b/katana/src/PyKatanaEngine.cpp index aa0120ba5..870a580bb 100644 --- a/katana/src/PyKatanaEngine.cpp +++ b/katana/src/PyKatanaEngine.cpp @@ -153,19 +153,25 @@ extern "C" { } - PyObject* PyKatanaEngine_digitalInit ( PyKatanaEngine* self ) + PyObject* PyKatanaEngine_digitalInit ( PyKatanaEngine* self, PyObject* args ) { cdebug_log(40,0) << "PyKatanaEngine_digitalInit()" << endl; HTRY METHOD_HEAD("KatanaEngine.digitalInit()") - if (katana->getViewer()) { - if (ExceptionWidget::catchAllWrapper( std::bind(&KatanaEngine::digitalInit,katana) )) { - PyErr_SetString( HurricaneError, "KatanaEngine::digitalInit() has thrown an exception (C++)." ); - return NULL; + uint64_t flags = 0; + if (PyArg_ParseTuple(args,"|L:KatanaEngine.digitalInit", &flags)) { + if (katana->getViewer()) { + if (ExceptionWidget::catchAllWrapper( std::bind(&KatanaEngine::digitalInit,katana, flags) )) { + PyErr_SetString( HurricaneError, "KatanaEngine::digitalInit() has thrown an exception (C++)." ); + return NULL; + } + } else { + katana->digitalInit( flags ); } } else { - katana->digitalInit(); + PyErr_SetString(ConstructorError, "KatanaEngine.digitalInit(): Invalid number/bad type of parameter."); + return NULL; } HCATCH @@ -203,7 +209,7 @@ extern "C" { HTRY METHOD_HEAD("KatanaEngine.runGlobalRouter()") uint64_t flags = 0; - if (PyArg_ParseTuple(args,"L:KatanaEngine.runGlobalRouter", &flags)) { + if (PyArg_ParseTuple(args,"|L:KatanaEngine.runGlobalRouter", &flags)) { if (katana->getViewer()) { if (ExceptionWidget::catchAllWrapper( std::bind(&KatanaEngine::runGlobalRouter,katana,flags) )) { PyErr_SetString( HurricaneError, "KatanaEngine::runGlobalrouter() has thrown an exception (C++)." ); @@ -344,7 +350,7 @@ extern "C" { , "Create a Katana engine on this cell." } , { "setViewer" , (PyCFunction)PyKatanaEngine_setViewer , METH_VARARGS , "Associate a Viewer to this KatanaEngine." } - , { "digitalInit" , (PyCFunction)PyKatanaEngine_digitalInit , METH_NOARGS + , { "digitalInit" , (PyCFunction)PyKatanaEngine_digitalInit , METH_VARARGS , "Setup Katana for digital routing." } , { "exclude" , (PyCFunction)PyKatanaEngine_exclude , METH_VARARGS , "Exclude a net from routing." } diff --git a/katana/src/katana/Constants.h b/katana/src/katana/Constants.h index a16e5bbd2..fe591f7d2 100644 --- a/katana/src/katana/Constants.h +++ b/katana/src/katana/Constants.h @@ -49,6 +49,7 @@ namespace Katana { static const Hurricane::BaseFlags ShowOverloadedGCells; static const Hurricane::BaseFlags ShowBloatedInstances; static const Hurricane::BaseFlags ProtectSelf; + static const Hurricane::BaseFlags PlacementCallback; public: inline Flags ( uint64_t ); inline Flags ( const Super& ); diff --git a/katana/src/katana/KatanaEngine.h b/katana/src/katana/KatanaEngine.h index ba99c207f..b89d7e54f 100644 --- a/katana/src/katana/KatanaEngine.h +++ b/katana/src/katana/KatanaEngine.h @@ -126,10 +126,10 @@ namespace Katana { void setInterrupt ( bool ); void createChannels (); void setupRoutingPlanes (); - void setupGlobalGraph ( uint32_t mode ); + void setupGlobalGraph ( Flags flags=Flags::NoFlags ); void annotateGlobalGraph (); void setFixedPreRouted (); - void digitalInit (); + void digitalInit ( Flags flags=Flags::NoFlags ); void analogInit (); void pairSymmetrics (); void updateEstimateDensity ( NetData*, double weight ); From 3757f64830cf09c6a31698a89fb9eba70cc758a7 Mon Sep 17 00:00:00 2001 From: Gabriel Gouvine Date: Thu, 2 Nov 2023 20:05:09 +0100 Subject: [PATCH 04/58] Introduce complete ripup functions for the router --- anabatic/src/AnabaticEngine.cpp | 51 ++++++++++++++++++++++++++ anabatic/src/Edge.cpp | 19 ++++++++++ anabatic/src/anabatic/AnabaticEngine.h | 1 + anabatic/src/anabatic/Edge.h | 1 + 4 files changed, 72 insertions(+) diff --git a/anabatic/src/AnabaticEngine.cpp b/anabatic/src/AnabaticEngine.cpp index 004e95092..b0bbf16c1 100644 --- a/anabatic/src/AnabaticEngine.cpp +++ b/anabatic/src/AnabaticEngine.cpp @@ -1091,6 +1091,57 @@ namespace Anabatic { } + void AnabaticEngine::ripupAll () + { + openSession(); + for ( GCell* cell : getGCells() ) { + if (not cell->isMatrix()) continue; + for ( Edge* edge : cell->getEdges() ) { + if (not edge) continue; + edge->ripupAll(); + } + } + _ovEdges.clear(); + + // Explicitly destroy what remains + for ( Net* net : getCell()->getNets() ) { + if (net == _blockageNet) continue; + if (net->getType() == Net::Type::POWER ) continue; + if (net->getType() == Net::Type::GROUND) continue; + + std::vector segments; + for( Segment* segment : net->getSegments() ) { + if (!Session::isGLayer(segment->getLayer())) { + continue; + } + segment->getSourceHook()->detach(); + segment->getTargetHook()->detach(); + segments.push_back(segment); + } + for (Segment *segment : segments) { + segment->destroy(); + } + + std::vector contacts; + for( Contact* contact : net->getContacts() ) { + if (!Session::isGLayer(contact->getLayer())) { + continue; + } + contacts.push_back(contact); + } + for (Contact *contact : contacts) { + contact->destroy(); + } + + for( RoutingPad* rp : net->getRoutingPads() ) { + rp->getBodyHook()->detach(); + } + } + + Session::close(); + } + + void AnabaticEngine::cleanupGlobal () { UpdateSession::open(); diff --git a/anabatic/src/Edge.cpp b/anabatic/src/Edge.cpp index 6f11d8ce9..81381ebf5 100644 --- a/anabatic/src/Edge.cpp +++ b/anabatic/src/Edge.cpp @@ -411,6 +411,25 @@ namespace Anabatic { } + size_t Edge::ripupAll () + { + AnabaticEngine* anabatic = getAnabatic(); + size_t netCount = 0; + + sort( _segments.begin(), _segments.end(), SortSegmentByLength(anabatic) ); + for ( size_t i=0 ; i<_segments.size() ; ) { + if ((not _segments[i]) or isEnding(_segments[i])) { + ++i; continue; + } + NetData* netData = anabatic->getNetData( _segments[i]->getNet() ); + if (netData->isGlobalFixed ()) continue; + if (netData->isGlobalRouted()) ++netCount; + anabatic->ripup( _segments[i], Flags::Propagate ); + } + return netCount; + } + + void Edge::_setSource ( GCell* source ) { if (source == _target) diff --git a/anabatic/src/anabatic/AnabaticEngine.h b/anabatic/src/anabatic/AnabaticEngine.h index 9cc621aab..d54cccddf 100644 --- a/anabatic/src/anabatic/AnabaticEngine.h +++ b/anabatic/src/anabatic/AnabaticEngine.h @@ -254,6 +254,7 @@ namespace Anabatic { inline int incStamp (); Contact* breakAt ( Segment*, GCell* ); void ripup ( Segment*, Flags ); + void ripupAll (); bool unify ( Contact* ); // Global routing related functions. void globalRoute (); diff --git a/anabatic/src/anabatic/Edge.h b/anabatic/src/anabatic/Edge.h index bdbb813ad..fcb928e66 100644 --- a/anabatic/src/anabatic/Edge.h +++ b/anabatic/src/anabatic/Edge.h @@ -88,6 +88,7 @@ namespace Anabatic { void remove ( Segment* ); void replace ( Segment* orig, Segment* repl ); size_t ripup (); + size_t ripupAll (); inline const Flags& flags () const; inline Flags& flags (); inline void revalidate () const; From 97124f582fe8eec3afc22a5a46a893254732b602 Mon Sep 17 00:00:00 2001 From: Gabriel Gouvine Date: Tue, 10 Oct 2023 17:43:14 +0200 Subject: [PATCH 05/58] Simple clang format file --- .clang-format | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 .clang-format diff --git a/.clang-format b/.clang-format new file mode 100644 index 000000000..63e1fda03 --- /dev/null +++ b/.clang-format @@ -0,0 +1,86 @@ +Language: Cpp +BasedOnStyle: WebKit +AccessModifierOffset: 0 +AlignAfterOpenBracket: Align +AlignArrayOfStructures: Right +AlignConsecutiveAssignments: AcrossComments +AlignConsecutiveBitFields: Consecutive +AlignConsecutiveDeclarations: AcrossComments +AlignConsecutiveMacros: Consecutive +AlignEscapedNewlines: Left +AlignOperands: Align +AllowShortCaseLabelsOnASingleLine: true +AllowShortEnumsOnASingleLine: true +AllowShortFunctionsOnASingleLine: All +AllowShortIfStatementsOnASingleLine: OnlyFirstIf +AllowShortLoopsOnASingleLine: true +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +BinPackArguments: false +BitFieldColonSpacing: Both +BreakBeforeBraces: Custom +BraceWrapping: + AfterCaseLabel: false + AfterClass: false + AfterControlStatement: MultiLine + AfterEnum: false + AfterFunction: true + AfterNamespace: false + AfterStruct: false + AfterExternBlock: false + BeforeElse: false + BeforeWhile: false + IndentBraces: false +BreakBeforeBinaryOperators: All +BreakBeforeTernaryOperators: true +BreakConstructorInitializers: BeforeComma +ColumnLimit: 0 +ConstructorInitializerIndentWidth: 2 +ContinuationIndentWidth: 0 +Cpp11BracedListStyle: true +EmptyLineAfterAccessModifier: Never +EmptyLineBeforeAccessModifier: Leave +FixNamespaceComments: true +IncludeBlocks: Preserve +IndentAccessModifiers: true +IndentCaseBlocks: false +IndentCaseLabels: false +IndentExternBlock: AfterExternBlock +IndentPPDirectives: None +IndentWidth: 2 +KeepEmptyLinesAtTheStartOfBlocks: true +MaxEmptyLinesToKeep: 4 +NamespaceIndentation: All +PackConstructorInitializers: NextLine +PointerAlignment: Left +QualifierAlignment: Leave +ReferenceAlignment: Pointer +RemoveBracesLLVM: false +ReflowComments: false +SeparateDefinitionBlocks: Leave +SortIncludes: Never +SortUsingDeclarations: true +SpaceAfterCStyleCast: false +SpaceAfterLogicalNot: true +SpaceBeforeAssignmentOperators: true +SpaceBeforeCaseColon: false +SpaceBeforeCpp11BracedList: true +SpaceBeforeInheritanceColon: true +SpaceBeforeParens: Custom +SpaceBeforeParensOptions: + AfterControlStatements: true + AfterFunctionDeclarationName: true + AfterFunctionDefinitionName: true + AfterOverloadedOperator: true + BeforeNonEmptyParentheses: false +SpaceBeforeRangeBasedForLoopColon: true +SpaceBeforeSquareBrackets: false +SpaceInEmptyBlock: true +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 2 +SpacesInAngles: Leave +SpacesInCStyleCastParentheses: false +SpacesInConditionalStatement: false +SpacesInParentheses: false +UseTab: Never From c00dbe810cdf69b96193d16869dff82b3a0ab11d Mon Sep 17 00:00:00 2001 From: Gabriel Gouvine Date: Thu, 2 Nov 2023 20:11:46 +0100 Subject: [PATCH 06/58] Update coloquinte version for slightly better results and easier debugging --- subprojects/coloquinte | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subprojects/coloquinte b/subprojects/coloquinte index 5bfeb63bd..655ba6f72 160000 --- a/subprojects/coloquinte +++ b/subprojects/coloquinte @@ -1 +1 @@ -Subproject commit 5bfeb63bd26e785bdb941809ae19e86d7c63aa59 +Subproject commit 655ba6f72a2e68d373b08f3e6a417bc2044ddcc3 From 7a0602fcbd2454a4bcc3246aa195886cfaba1f4b Mon Sep 17 00:00:00 2001 From: Gabriel Gouvine Date: Thu, 2 Nov 2023 20:12:03 +0100 Subject: [PATCH 07/58] Extend .gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index f6d1b6be2..2e3fcedb5 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ GPATH GRTAGS .dir-locals.el .projectile +.vscode lefdef/src/lef/lef/lef.tab.h lefdef/src/def/def/def.tab.h @@ -22,6 +23,7 @@ latex/ build/ venv/ coriolis.egg-info/ +.pdm-python bootstrap/coriolis2.spec From 8e5db42aff5dd78bf34d13372816746d0d7e8429 Mon Sep 17 00:00:00 2001 From: Gabriel Gouvine Date: Tue, 7 Nov 2023 09:48:25 +0100 Subject: [PATCH 08/58] Update Coloquinte version to 0.4.1 (bug fixes + area update infrastructure) --- subprojects/coloquinte | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/subprojects/coloquinte b/subprojects/coloquinte index 655ba6f72..a54c3dfc5 160000 --- a/subprojects/coloquinte +++ b/subprojects/coloquinte @@ -1 +1 @@ -Subproject commit 655ba6f72a2e68d373b08f3e6a417bc2044ddcc3 +Subproject commit a54c3dfc58c668dc4f0803c4648283c9e0f75d4c From 500d4446c2a71a79b8e110166f37290220142186 Mon Sep 17 00:00:00 2001 From: lanserge Date: Fri, 10 Nov 2023 13:56:58 +0000 Subject: [PATCH 09/58] Filter out redundant plugs that have no connection inside cell while export Verilog netlist. (#84) Co-authored-by: Serge Rabyking --- crlcore/src/ccore/verilog/VerilogDriver.cpp | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/crlcore/src/ccore/verilog/VerilogDriver.cpp b/crlcore/src/ccore/verilog/VerilogDriver.cpp index c44da8da3..58442f8f7 100644 --- a/crlcore/src/ccore/verilog/VerilogDriver.cpp +++ b/crlcore/src/ccore/verilog/VerilogDriver.cpp @@ -112,6 +112,21 @@ namespace CRL { return bus; } + static bool _cellHasNetPlug(Cell* cell, Net* net) + { + for(Instance* instance: cell->getInstances()) // go through all cells instances that form our cell + { + for(Plug* plug: instance->getPlugs()) // plugs are connect points of the cells + { + if (plug->getNet() == net) + { + return true; + } + } + } + return false; + } + static void _write_cell(ofstream &out, Cell* cell) { out << std::endl; @@ -309,6 +324,12 @@ namespace CRL { { continue; } + if (!instance->isTerminalNetlist()&& + !_cellHasNetPlug(instance->getMasterCell(), net)) + { + // the plug is redundant and actually has no connection inside cell + continue; + } // insert in sorted order auto it = std::lower_bound(conns.begin(), conns.end(), plug, [](Plug* lhs, Plug* rhs) -> bool From 8bcc10ed02283ea0fb322ee9ef90d6d703529f53 Mon Sep 17 00:00:00 2001 From: Ross Motley Date: Tue, 14 Nov 2023 11:09:51 +0000 Subject: [PATCH 10/58] Fix _PDM link in README --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index eec3284a1..bc162629e 100644 --- a/README.rst +++ b/README.rst @@ -197,6 +197,7 @@ For more configuration and install options, see: .. _venv: https://www.dataquest.io/blog/a-complete-guide-to-python-virtual-environments/#how-to-use-python-environments .. _shell completion: https://pdm.fming.dev/latest/#shell-completion .. _using pdm with virtual environments: https://pdm.fming.dev/latest/usage/venv/ +.. _PDM: https://pdm-project.org/ Other operating systems ======================= From 885b4b1a359bbd2ff0a7770123fff6ea5ad10deb Mon Sep 17 00:00:00 2001 From: Ross Motley Date: Tue, 14 Nov 2023 12:04:46 +0000 Subject: [PATCH 11/58] Fix meson README link --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index bc162629e..b4edf7d6c 100644 --- a/README.rst +++ b/README.rst @@ -164,7 +164,7 @@ First we set up our pdm virtual environment: pdm install --no-self -d --plugins -Below we are just using a local directory call builddir for our meson_ build directory, but you can put it wherever you like. +Below we are just using a local directory call builddir for our _meson build directory, but you can put it wherever you like. .. code-block:: bash @@ -198,6 +198,7 @@ For more configuration and install options, see: .. _shell completion: https://pdm.fming.dev/latest/#shell-completion .. _using pdm with virtual environments: https://pdm.fming.dev/latest/usage/venv/ .. _PDM: https://pdm-project.org/ +.. _meson: https://mesonbuild.com/ Other operating systems ======================= From b2f7aa7aab95b3d1362b342a8b0644e6d3675b25 Mon Sep 17 00:00:00 2001 From: Ross Motley Date: Tue, 14 Nov 2023 15:15:35 +0000 Subject: [PATCH 12/58] Failures in PyPi uploads should fail workflows --- .github/workflows/wheels.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/wheels.yml b/.github/workflows/wheels.yml index 34ed914e8..432e9ff60 100644 --- a/.github/workflows/wheels.yml +++ b/.github/workflows/wheels.yml @@ -193,7 +193,6 @@ jobs: with: password: ${{ secrets.TEST_PYPI_API_TOKEN }} repository_url: https://test.pypi.org/legacy/ - continue-on-error: true upload_pypi: # TODO: create an sdist that can build without a custom environment @@ -227,7 +226,6 @@ jobs: - uses: pypa/gh-action-pypi-publish@release/v1 with: password: ${{ secrets.PYPI_API_TOKEN }} - continue-on-error: true # build_sdist: # name: Build sdist From fc93118fd397ce59910324738d7fd6c07c0bd8b9 Mon Sep 17 00:00:00 2001 From: Rob Taylor Date: Fri, 20 Oct 2023 16:08:41 +0100 Subject: [PATCH 13/58] Update doxyfiles to latest doxygen --- Seabreeze/doc/doxyfile | 2859 +++++++++++++++++++++++++-- crlcore/doc/crlcore/doxyfile | 3102 +++++++++++++++++++++--------- hurricane/doc/analog/doxyfile | 3101 ++++++++++++++++++++--------- hurricane/doc/hurricane/doxyfile | 3099 ++++++++++++++++++++--------- hurricane/doc/viewer/doxyfile | 2677 +++++++++++++++++++++++++- oroshi/doc/doxyfile | 2878 +++++++++++++++++++++++++-- unicorn/doc/unicorn/doxyfile | 3100 ++++++++++++++++++++--------- 7 files changed, 16790 insertions(+), 4026 deletions(-) diff --git a/Seabreeze/doc/doxyfile b/Seabreeze/doc/doxyfile index 3f922e245..12348208d 100644 --- a/Seabreeze/doc/doxyfile +++ b/Seabreeze/doc/doxyfile @@ -1,276 +1,2827 @@ -# -*- explicit-buffer-name: "doxyfile" -*- -# Doxyfile 1.3.4 +# Doxyfile 1.9.8 -# -------------------------------------------------------------------- +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- # Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. PROJECT_NAME = "Seabreeze - Routing Toolbox" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + PROJECT_NUMBER = 1.0 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + OUTPUT_DIRECTORY = . + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + OUTPUT_LANGUAGE = English -MARKDOWN_SUPPORT = NO -#USE_WINDOWS_ENCODING = NO -LAYOUT_FILE = DoxygenLayout.xml + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + MULTILINE_CPP_IS_BRIEF = NO -#DETAILS_AT_TOP = YES + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + INHERIT_DOCS = YES -DISTRIBUTE_GROUP_DOC = NO + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + TAB_SIZE = 2 -ALIASES = "function=\fn"\ - "important=\par Important:\n"\ - "remark=\par Remark:\n"\ - "sreturn=\b Returns:"\ - "True=\b True"\ - "true=\b true"\ - "False=\b False"\ - "false=\b false"\ - "VERTICAL=\b VERTICAL"\ - "HORIZONTAL=\b HORIZONTAL"\ - "NULL=\c NULL"\ - "vector=\c vector"\ - "Collection=\c Collection"\ - "Collections=\c Collections"\ - "Box=\c Box"\ - "box=\c box"\ - "Layer=\c Layer"\ - "Layers=\c Layers"\ - "Net=\c Net"\ - "Nets=\c Nets"\ - "Pin=\c Pin"\ - "Pins=\c Pins"\ - "Plug=\c Plug"\ - "Plugs=\c Plugs"\ - "RoutingPad=\c RoutingPad"\ - "RoutingPads=\c RoutingPads"\ - "Cell=\c Cell"\ - "Cells=\c Cells"\ - "ToolEngine=\c ToolEngine"\ - "ToolEngines=\c ToolEngines"\ - "GCell=\c GCell"\ - "GCells=\c GCells"\ - "Splitter=\c Splitter"\ - "Splitters=\c Splitters"\ - "SplitterContact=\c SplitterContact"\ - "SplitterContacts=\c SplitterContacts"\ - "Hurricane=Hurricane"\ - "STL=STL"\ + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = "function=\fn" \ + "important=\par Important:\n" \ + "remark=\par Remark:\n" \ + "sreturn=\b Returns:" \ + "True=\b True" \ + "true=\b true" \ + "False=\b False" \ + "false=\b false" \ + "VERTICAL=\b VERTICAL" \ + "HORIZONTAL=\b HORIZONTAL" \ + "NULL=\c NULL" \ + "vector=\c vector" \ + "Collection=\c Collection" \ + "Collections=\c Collections" \ + "Box=\c Box" \ + "box=\c box" \ + "Layer=\c Layer" \ + "Layers=\c Layers" \ + "Net=\c Net" \ + "Nets=\c Nets" \ + "Pin=\c Pin" \ + "Pins=\c Pins" \ + "Plug=\c Plug" \ + "Plugs=\c Plugs" \ + "RoutingPad=\c RoutingPad" \ + "RoutingPads=\c RoutingPads" \ + "Cell=\c Cell" \ + "Cells=\c Cells" \ + "ToolEngine=\c ToolEngine" \ + "ToolEngines=\c ToolEngines" \ + "GCell=\c GCell" \ + "GCells=\c GCells" \ + "Splitter=\c Splitter" \ + "Splitters=\c Splitters" \ + "SplitterContact=\c SplitterContact" \ + "SplitterContacts=\c SplitterContacts" \ + "Hurricane=Hurricane" \ + "STL=STL" \ "red{1}=\1" + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = NO + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + SUBGROUPING = YES -# -------------------------------------------------------------------- -# Build related configuration options +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = YES + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = YES + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 1 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = DoxygenLayout.xml + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = NO + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = Seabreeze.dox \ + ../src/Seabreeze/Node.h \ + ../src/Node.cpp \ + Node.dox \ + ../src/Seabreeze/Tree.h \ + ../src/Tree.cpp \ + Tree.dox \ + ../src/Seabreeze/Seabreeze.h \ + ../src/Seabreeze.cpp \ + Seabreeze.dox \ + ../src/katabatic/SeabreezeEngine.h \ + ../src/SeabreezeEngine.cpp \ + SeabreezeEngine.dox + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, +# *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php, +# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be +# provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.h \ + *.cpp \ + *.dox + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = . + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = images + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = YES + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = header.html + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = footer.html + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = SoC.css + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 1 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = -EXTRACT_ALL = NO -EXTRACT_PRIVATE = YES -EXTRACT_STATIC = YES -EXTRACT_LOCAL_CLASSES = YES -EXTRACT_ANON_NSPACES = YES -HIDE_UNDOC_MEMBERS = YES -HIDE_UNDOC_CLASSES = YES -HIDE_FRIEND_COMPOUNDS = NO -HIDE_IN_BODY_DOCS = NO -INTERNAL_DOCS = NO -CASE_SENSE_NAMES = YES -HIDE_SCOPE_NAMES = YES -SHOW_INCLUDE_FILES = YES -INLINE_INFO = YES -SORT_MEMBER_DOCS = NO -GENERATE_TODOLIST = YES -GENERATE_TESTLIST = YES -GENERATE_BUGLIST = YES -GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = -MAX_INITIALIZER_LINES = 1 -SHOW_USED_FILES = YES +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. -# -------------------------------------------------------------------- -# Configuration options related to warning and progress messages +MATHJAX_EXTENSIONS = -QUIET = YES -WARNINGS = YES -WARN_IF_UNDOCUMENTED = NO -WARN_IF_DOC_ERROR = YES -WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. -# -------------------------------------------------------------------- -# Configuration options related to the input files +MATHJAX_CODEFILE = -INPUT = \ - Seabreeze.dox \ - ../src/Seabreeze/Node.h ../src/Node.cpp Node.dox \ - ../src/Seabreeze/Tree.h ../src/Tree.cpp Tree.dox \ - ../src/Seabreeze/Seabreeze.h ../src/Seabreeze.cpp Seabreeze.dox \ - ../src/katabatic/SeabreezeEngine.h ../src/SeabreezeEngine.cpp SeabreezeEngine.dox +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /