pax_global_header00006660000000000000000000000064145174635210014522gustar00rootroot0000000000000052 comment=1f659e4165072905776c1005238428a975cbffcd libfiu-1.2/000077500000000000000000000000001451746352100126365ustar00rootroot00000000000000libfiu-1.2/.clang-format000066400000000000000000000002771451746352100152170ustar00rootroot00000000000000BasedOnStyle: LLVM IndentWidth: 8 UseTab: AlignWithSpaces BreakBeforeBraces: Linux AllowShortIfStatementsOnASingleLine: false AllowShortFunctionsOnASingleLine: false IndentCaseLabels: false libfiu-1.2/.gitignore000066400000000000000000000014341451746352100146300ustar00rootroot00000000000000bindings/python/build bindings/python/*.pyc bindings/python/*.pyo bindings/python/fiu_ctrl.py libfiu/*.o libfiu/libfiu.a libfiu/libfiu.pc libfiu/libfiu.so libfiu/libfiu.so.* libfiu/build-flags libfiu/doxygen/doc.internal libfiu/doxygen/doc.public libfiu/doxygen/Doxyfile.base preload/posix/*.o preload/posix/*.so preload/posix/build-flags preload/posix/build-libcsoname preload/posix/build-needlibdl preload/posix/build-env.h preload/posix/function_list preload/posix/modules/*.o preload/posix/modules/*.mod.c preload/posix/modules/*.mod.fl preload/run/*.o preload/run/*.so preload/run/fiu-run preload/run/build-flags preload/run/build-needlibdl tests/*.o tests/build-flags tests/test-? tests/small-cat tests/libs/ tests/generated/build-flags tests/generated/tests/*.[oc] .*.swp *.gcno *.gcda .* libfiu-1.2/.gitlab-ci.yml000066400000000000000000000004571451746352100153000ustar00rootroot00000000000000# Configuration for the GitLab CI. image: gcc stages: - test test: stage: test before_script: - apt update - apt -y install make coreutils python3-dev python3-setuptools script: - make all - make test artifacts: when: always expire_in: 1 hour paths: - ./ libfiu-1.2/LICENSE000066400000000000000000000022461451746352100136470ustar00rootroot00000000000000 I don't like licenses, because I don't like having to worry about all this legal stuff just for a simple piece of software I don't really mind anyone using. But I also believe that it's important that people share and give back; so I'm placing this work under the following license. BOLA - Buena Onda License Agreement (v1.1) ------------------------------------------ This work is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this work. To all effects and purposes, this work is to be considered Public Domain. However, if you want to be "buena onda", you should: 1. Not take credit for it, and give proper recognition to the authors. 2. Share your modifications, so everybody benefits from them. 3. Do something nice for the authors. 4. Help someone who needs it: sign up for some volunteer work or help your neighbour paint the house. 5. Don't waste. Anything, but specially energy that comes from natural non-renewable resources. Extra points if you discover or invent something to replace them. 6. Be tolerant. Everything that's good in nature comes from cooperation. libfiu-1.2/Makefile000066400000000000000000000034671451746352100143100ustar00rootroot00000000000000 default: all install: all_install uninstall: all_uninstall all: libfiu preload utils all_install: libfiu_install preload_install utils_install all_uninstall: libfiu_uninstall preload_uninstall utils_uninstall libfiu: $(MAKE) -C libfiu libfiu_clean: $(MAKE) -C libfiu clean libfiu_install: $(MAKE) -C libfiu install libfiu_uninstall: $(MAKE) -C libfiu uninstall preload: libfiu $(MAKE) -C preload preload_clean: $(MAKE) -C preload clean preload_install: preload $(MAKE) -C preload install preload_uninstall: $(MAKE) -C preload uninstall utils: $(MAKE) -C utils utils_clean: $(MAKE) -C utils clean utils_install: utils $(MAKE) -C utils install utils_uninstall: $(MAKE) -C utils uninstall tests: test test: libfiu bindings preload $(MAKE) -C tests test_clean: $(MAKE) -C tests clean bindings: python3 bindings_install: python3_install bindings_clean: python_clean python3: libfiu cd bindings/python && python3 setup.py build python3_install: python3 cd bindings/python && python3 setup.py install python_clean: cd bindings/python && rm -rf build/ fiu_ctrl.py clean: python_clean preload_clean libfiu_clean utils_clean test_clean # Auto-format code with an uniform style. # Most preload/posix files are not auto-formatted because of the crazy code # generation macros. format: clang-format -i \ `find bindings/ libfiu/ tests/ preload/run/ \ -iname '*.[ch]'` \ preload/posix/codegen.c black -q -l 79 bindings/python/*.py tests/*.py .PHONY: default all clean install all_install uninstall all_uninstall \ libfiu libfiu_clean libfiu_install libfiu_uninstall \ python3 python3_install python_clean \ bindings bindings_install bindings_clean \ preload preload_clean preload_install preload_uninstall \ utils utils_clean utils_install utils_uninstall \ test tests test_clean \ format libfiu-1.2/README.md000066400000000000000000000030541451746352100141170ustar00rootroot00000000000000 # libfiu - Fault injection in userspace [libfiu](https://blitiri.com.ar/p/libfiu) is a C library for fault injection. It provides functions to mark "points of failure" inside your code (the *core API*), and functions to enable/disable the failure of those points (the *control API*). It's in the public domain, see the LICENSE file for more information. The *core API* is used inside the code wanting to perform fault injection on. The *control API* is used inside the testing code, in order to control the injection of failures. Python bindings are available in the `bindings/` directory. [![Gitlab CI status](https://gitlab.com/albertito/libfiu/badges/master/pipeline.svg)](https://gitlab.com/albertito/libfiu/pipelines) ## Documentation You can find the user guide in the `doc/` directory, and a manpage in the `libfiu/` directory. The manpage will be installed along the library. Python bindings have embedded documentation, although it's not as complete. ## Building and installing Running `make` (or `gmake`) should be enough for building, and `make install` for installing. By default it installs into `/usr/local/`, but you can provide an alternative prefix by running `make PREFIX=/my/prefix install`. To build the Python 3 bindings, use `make python3`, to install them you can run `make python3_install`. ## Where to report bugs If you want to report bugs, or have any questions or comments, just let me know at `albertito@blitiri.com.ar`. For more information about the library, you can go to the [libfiu home page](https://blitiri.com.ar/p/libfiu). libfiu-1.2/bindings/000077500000000000000000000000001451746352100144335ustar00rootroot00000000000000libfiu-1.2/bindings/python/000077500000000000000000000000001451746352100157545ustar00rootroot00000000000000libfiu-1.2/bindings/python/fiu.py000066400000000000000000000064751451746352100171250ustar00rootroot00000000000000""" libfiu python wrapper This module is a wrapper for the libfiu, the fault injection C library. It provides an almost one-to-one mapping of the libfiu functions, although its primary use is to be able to test C code from within Python. For fault injection in Python, a native library would be more suitable. See libfiu's manpage for more detailed documentation. """ import fiu_ll as _ll def fail(name): "Returns the failure status of the given point of failure." return _ll.fail(name) def failinfo(): """Returns the information associated with the last failure. Use with care, can be fatal if the point of failure was not enabled via Python.""" return _ll.failinfo() class Flags: """Contains the valid flag constants. ONETIME: This point of failure is disabled immediately after failing once. """ ONETIME = _ll.FIU_ONETIME # To be sure failinfo doesn't dissapear from under our feet, we keep a # name -> failinfo table. See fiu_ll's comments for more details. _fi_table = {} def enable(name, failnum=1, failinfo=None, flags=0): "Enables the given point of failure." _fi_table[name] = failinfo r = _ll.enable(name, failnum, failinfo, flags) if r != 0: del _fi_table[name] raise RuntimeError(r) def enable_random(name, probability, failnum=1, failinfo=None, flags=0): "Enables the given point of failure, with the given probability." _fi_table[name] = failinfo r = _ll.enable_random(name, failnum, failinfo, flags, probability) if r != 0: del _fi_table[name] raise RuntimeError(r) def enable_external(name, cb, failnum=1, flags=0): """Enables the given point of failure, leaving the decision whether to fail or not to the given external function, which should return 0 if it is not to fail, or 1 otherwise. The cb parameter is a Python function that takes three parameters, name, failnum and flags, with the same values that we receive. For technical limitations, enable_external() cannot take failinfo.""" # in this case, use the table to prevent the function from # dissapearing _fi_table[name] = cb r = _ll.enable_external(name, failnum, flags, cb) if r != 0: del _fi_table[name] raise RuntimeError(r) def enable_stack_by_name( name, func_name, failnum=1, failinfo=None, flags=0, pos_in_stack=-1 ): """Enables the given point of failure, but only if 'func_name' is in the stack. 'func_name' is be the name of the C function to look for. """ _fi_table[name] = failinfo r = _ll.enable_stack_by_name( name, failnum, failinfo, flags, func_name, pos_in_stack ) if r != 0: del _fi_table[name] raise RuntimeError(r) def disable(name): """Disables the given point of failure, undoing the actions of the enable*() functions.""" if name in _fi_table: del _fi_table[name] r = _ll.disable(name) if r != 0: raise RuntimeError(r) def set_prng_seed(seed): """Sets the PRNG seed. Don't use this unless you know what you're doing.""" return _ll.set_prng_seed(seed) def rc_fifo(basename): """Enables remote control over a named pipe that begins with the given basename. The final path will be "basename-$PID".""" r = _ll.rc_fifo(basename) if r != 0: raise RuntimeError(r) libfiu-1.2/bindings/python/fiu_ctrl.in.py000066400000000000000000000145771451746352100205600ustar00rootroot00000000000000""" libfiu python module for remote control This module provides an easy way to run a command with libfiu enabled, and controlling the failure points dynamically. It provides similar functionality to the fiu-ctrl and fiu-run shell tools, but is useful for programmed tests. Note it assumes the preloading libraries are installed in @@PLIBPATH@@. """ import os import tempfile import subprocess import shutil import time # Default path to look for preloader libraries. PLIBPATH = "@@PLIBPATH@@" class CommandError(RuntimeError): """There was an error running the command.""" pass class Flags: """Contains the valid flag constants. ONETIME: This point of failure is disabled immediately after failing once. """ ONETIME = "onetime" class _ControlBase(object): """Base class for remote control objects.""" def run_raw_cmd(self, cmd, args): """Runs a new raw command. To be implemented by subclasses""" raise NotImplementedError def _basic_args(self, name, failnum, failinfo, flags): """Converts the common arguments to an args list for run_raw_cmd().""" args = ["name=%s" % name] if failnum: args.append("failnum=%s" % failnum) if failinfo: args.append("failinfo=%s" % failinfo) if flags: args.extend(flags) return args def enable(self, name, failnum=1, failinfo=None, flags=()): """Enables the given point of failure.""" args = self._basic_args(name, failnum, failinfo, flags) self.run_raw_cmd("enable", args) def enable_random( self, name, probability, failnum=1, failinfo=None, flags=() ): "Enables the given point of failure, with the given probability." args = self._basic_args(name, failnum, failinfo, flags) args.append("probability=%f" % probability) self.run_raw_cmd("enable_random", args) def enable_stack_by_name( self, name, func_name, failnum=1, failinfo=None, flags=(), pos_in_stack=-1, ): """Enables the given point of failure, but only if 'func_name' is in the stack. 'func_name' is be the name of the C function to look for. """ args = self._basic_args(name, failnum, failinfo, flags) args.append("func_name=%s" % func_name) if pos_in_stack >= 0: args.append("pos_in_stack=%d" % pos_in_stack) self.run_raw_cmd("enable_stack_by_name", args) def disable(self, name): """Disables the given point of failure.""" self.run_raw_cmd("disable", ["name=%s" % name]) def _open_with_timeout(path, mode, timeout=3): """Open a file, waiting if it doesn't exist yet.""" deadline = time.time() + timeout while not os.path.exists(path): time.sleep(0.01) if time.time() >= deadline: raise RuntimeError("Timeout waiting for file %r" % path) return open(path, mode) class PipeControl(_ControlBase): """Control pipe used to control a libfiu-instrumented process.""" def __init__(self, path_prefix): """Constructor. Args: path: Path to the control pipe. """ self.path_in = path_prefix + ".in" self.path_out = path_prefix + ".out" def _open_pipes(self): # Open the files, but wait if they are not there, as the child process # may not have created them yet. fd_in = _open_with_timeout(self.path_in, "w") fd_out = _open_with_timeout(self.path_out, "r") return fd_in, fd_out def run_raw_cmd(self, cmd, args): """Send a raw command over the pipe.""" # Note we open the pipe each time for simplicity, and also to simplify # external intervention that can be used for debugging. fd_in, fd_out = self._open_pipes() s = "%s %s\n" % (cmd, ",".join(args)) fd_in.write(s) fd_in.flush() r = int(fd_out.readline()) if r != 0: raise CommandError class EnvironmentControl(_ControlBase): """Pre-execution environment control.""" def __init__(self): self.env = "" def run_raw_cmd(self, cmd, args): """Add a raw command to the environment.""" self.env += "%s %s\n" % (cmd, ",".join(args)) class Subprocess(_ControlBase): """Wrapper for subprocess.Popen, but without immediate execution. This class provides a wrapper for subprocess.Popen, which can be used to run other processes under libfiu. However, the processes don't start straight away, allowing the user to pre-configure some failure points. The process can then be started with the start() method. After the process has been started, the failure points can be controlled remotely via the same functions. Processes can be started only once. Note that using shell=True is not recommended, as it makes the pid of the controlled process to be unknown. """ def __init__(self, *args, **kwargs): self.args = args self.kwargs = kwargs # Note this removes fiu_enable_posix from kwargs if it's there, that # way kwargs remains "clean" for passing to Popen. self.fiu_enable_posix = kwargs.pop("fiu_enable_posix", False) self._proc = None self.tmpdir = None # Initially, this is an EnvironmentControl so we can do preparation; # once we start the command, we will change this to be PipeControl. self.ctrl = EnvironmentControl() def run_raw_cmd(self, cmd, args): self.ctrl.run_raw_cmd(cmd, args) def start(self): self.tmpdir = tempfile.mkdtemp(prefix="fiu_ctrl-") env = os.environ env["LD_PRELOAD"] = env.get("LD_PRELOAD", "") if self.fiu_enable_posix: env["LD_PRELOAD"] += " " + PLIBPATH + "/fiu_posix_preload.so" env["LD_PRELOAD"] += " " + PLIBPATH + "/fiu_run_preload.so " env["FIU_CTRL_FIFO"] = self.tmpdir + "/ctrl-fifo" env["FIU_ENABLE"] = self.ctrl.env self._proc = subprocess.Popen(*self.args, **self.kwargs) fifo_path = "%s-%d" % (env["FIU_CTRL_FIFO"], self._proc.pid) self.ctrl = PipeControl(fifo_path) return self._proc def __del__(self): # Remove the temporary directory. # The "'fiu_ctrl-' in self.tmpdir" check is just a safeguard. if self.tmpdir and "fiu_ctrl-" in self.tmpdir: shutil.rmtree(self.tmpdir) libfiu-1.2/bindings/python/fiu_ll.c000066400000000000000000000140271451746352100173760ustar00rootroot00000000000000 /* * Python 3 bindings for libfiu * Alberto Bertogli (albertito@blitiri.com.ar) * * This is the low-level module, used by the python one to construct * friendlier objects. */ #include /* Unconditionally enable fiu, otherwise we get fake headers */ #define FIU_ENABLE 1 #include #include static PyObject *fail(PyObject *self, PyObject *args) { char *name; PyObject *rv, *err; if (!PyArg_ParseTuple(args, "s:fail", &name)) return NULL; rv = PyLong_FromLong(fiu_fail(name)); err = PyErr_Occurred(); if (rv == NULL || err != NULL) { Py_XDECREF(rv); return NULL; } return rv; } static PyObject *failinfo(PyObject *self, PyObject *args) { if (!PyArg_ParseTuple(args, ":failinfo")) return NULL; /* We assume failinfo is a python object; but the caller must be * careful because if it's not, it can get into trouble. */ PyObject *rv = fiu_failinfo(); Py_XINCREF(rv); return rv; } static PyObject *enable(PyObject *self, PyObject *args) { char *name; int failnum; PyObject *failinfo; unsigned int flags; if (!PyArg_ParseTuple(args, "siOI:enable", &name, &failnum, &failinfo, &flags)) return NULL; /* The caller will guarantee that failinfo doesn't dissapear from under * our feet. */ return PyLong_FromLong(fiu_enable(name, failnum, failinfo, flags)); } static PyObject *enable_random(PyObject *self, PyObject *args) { char *name; int failnum; PyObject *failinfo; unsigned int flags; double probability; if (!PyArg_ParseTuple(args, "siOId:enable_random", &name, &failnum, &failinfo, &flags, &probability)) return NULL; /* The caller will guarantee that failinfo doesn't dissapear from under * our feet. */ return PyLong_FromLong( fiu_enable_random(name, failnum, failinfo, flags, probability)); } static int external_callback(const char *name, int *failnum, void **failinfo, unsigned int *flags) { int rv; PyObject *cbrv; PyObject *args; PyGILState_STATE gil_state; /* We need to protect ourselves from the following case: * - fiu.enable_callback('x', cb) (where cb is obviously a Python * function) * - Later on, call a function p1() inside a python C module, that * runs a C function c1() inside * Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS * - c1() calls fiu_fail("x") * - fiu_fail("x") calls external_callback(), and it should run cb() * - BUT! It can't run cb(), because it's inside * Py_BEGIN_ALLOW_THREADS/Py_END_ALLOW_THREADS so it's not safe to * execute any Python code! * * The solution is to ensure we're safe to run Python code using * PyGILState_Ensure()/PyGILState_Release(). */ gil_state = PyGILState_Ensure(); args = Py_BuildValue("(siI)", name, *failnum, *flags); if (args == NULL) { PyGILState_Release(gil_state); return 0; } cbrv = PyObject_CallObject(*failinfo, args); Py_DECREF(args); if (cbrv == NULL) { PyGILState_Release(gil_state); return 0; } /* If PyLong_AsLong() causes an error, it will be handled by the * PyErr_Occurred() check in fail(), so we don't need to worry about * it now. */ rv = PyLong_AsLong(cbrv); Py_DECREF(cbrv); PyGILState_Release(gil_state); return rv; } static PyObject *enable_external(PyObject *self, PyObject *args) { char *name; int failnum; unsigned int flags; PyObject *py_external_cb; if (!PyArg_ParseTuple(args, "siIO:enable_external", &name, &failnum, &flags, &py_external_cb)) return NULL; if (!PyCallable_Check(py_external_cb)) { PyErr_SetString(PyExc_TypeError, "parameter must be callable"); return NULL; } /* We use failinfo to store Python's callback function. It'd be nice * if we could keep both, but it's not easy without keeping state * inside the C module. * * Similar to the way failinfo is handled, we DO NOT TOUCH THE RC OF * THE EXTERNAL CALLBACK, assuming the caller will take care of making * sure it doesn't dissapear from beneath us. */ return PyLong_FromLong(fiu_enable_external( name, failnum, py_external_cb, flags, external_callback)); } static PyObject *enable_stack_by_name(PyObject *self, PyObject *args) { char *name; int failnum; PyObject *failinfo; unsigned int flags; char *func_name; int pos_in_stack = -1; if (!PyArg_ParseTuple(args, "siOIs|i:enable_stack_by_name", &name, &failnum, &failinfo, &flags, &func_name, &pos_in_stack)) return NULL; return PyLong_FromLong(fiu_enable_stack_by_name( name, failnum, failinfo, flags, func_name, pos_in_stack)); } static PyObject *disable(PyObject *self, PyObject *args) { char *name; if (!PyArg_ParseTuple(args, "s:disable", &name)) return NULL; return PyLong_FromLong(fiu_disable(name)); } static PyObject *set_prng_seed(PyObject *self, PyObject *args) { int seed; if (!PyArg_ParseTuple(args, "i:set_prng_seed", &seed)) return NULL; fiu_set_prng_seed(seed); Py_RETURN_NONE; } static PyObject *rc_fifo(PyObject *self, PyObject *args) { char *basename; if (!PyArg_ParseTuple(args, "s:rc_fifo", &basename)) return NULL; return PyLong_FromLong(fiu_rc_fifo(basename)); } static PyMethodDef fiu_methods[] = { {"fail", (PyCFunction)fail, METH_VARARGS, NULL}, {"failinfo", (PyCFunction)failinfo, METH_VARARGS, NULL}, {"enable", (PyCFunction)enable, METH_VARARGS, NULL}, {"enable_random", (PyCFunction)enable_random, METH_VARARGS, NULL}, {"enable_external", (PyCFunction)enable_external, METH_VARARGS, NULL}, {"enable_stack_by_name", (PyCFunction)enable_stack_by_name, METH_VARARGS, NULL}, {"disable", (PyCFunction)disable, METH_VARARGS, NULL}, {"set_prng_seed", (PyCFunction)set_prng_seed, METH_VARARGS, NULL}, {"rc_fifo", (PyCFunction)rc_fifo, METH_VARARGS, NULL}, {NULL}}; static PyModuleDef fiu_module = { PyModuleDef_HEAD_INIT, .m_name = "libfiu", .m_size = -1, .m_methods = fiu_methods, }; PyMODINIT_FUNC PyInit_fiu_ll(void) { PyObject *m; m = PyModule_Create(&fiu_module); PyModule_AddIntConstant(m, "FIU_ONETIME", FIU_ONETIME); fiu_init(0); return m; } libfiu-1.2/bindings/python/setup.py000066400000000000000000000030361451746352100174700ustar00rootroot00000000000000import os import sys import tempfile from setuptools import setup, Extension from setuptools.command.build_py import build_py # We need to generate the fiu_ctrl.py file from fiu_ctrl.in.py, replacing some # environment variables in its contents. class generate_and_build_py(build_py): def run(self): if not self.dry_run: self.generate_fiu_ctrl() build_py.run(self) def generate_fiu_ctrl(self): prefix = os.environ.get("PREFIX", "/usr/local/") plibpath = os.environ.get("PLIBPATH", prefix + "/lib/") contents = open("fiu_ctrl.in.py", "rt").read() contents = contents.replace("@@PLIBPATH@@", plibpath) # Create/update the file atomically, we don't want to accidentally use # partially written files. out = tempfile.NamedTemporaryFile( mode="wt", delete=False, dir=".", prefix="tmp-fiu_ctrl.py" ) out.write(contents) out.close() os.rename(out.name, "fiu_ctrl.py") fiu_ll = Extension( "fiu_ll", sources=["fiu_ll.c"], libraries=["fiu"], # These two allow us to build without having libfiu installed, # assuming we're in the libfiu source tree include_dirs=["../../libfiu/"], library_dirs=["../../libfiu/"], ) setup( name="fiu", description="libfiu bindings", author="Alberto Bertogli", author_email="albertito@blitiri.com.ar", url="http://blitiri.com.ar/p/libfiu", py_modules=["fiu", "fiu_ctrl"], ext_modules=[fiu_ll], cmdclass={"build_py": generate_and_build_py}, ) libfiu-1.2/doc/000077500000000000000000000000001451746352100134035ustar00rootroot00000000000000libfiu-1.2/doc/guide.rst000066400000000000000000000142761451746352100152440ustar00rootroot00000000000000 libfiu - Fault injection in userspace ===================================== Introduction ------------ You, as a programmer, know many things can fail, and your software is often expected to be able to handle those failures. But how do you test your failure handling code, when it's not easy to make a failure appear in the first place? One way to do it is to perform *fault injection*. According to Wikipedia, "fault injection is a technique for improving the coverage of a test by introducing faults in order to test code paths, in particular error handling code paths, that might otherwise rarely be followed. It is often used with stress testing and is widely considered to be an important part of developing robust software". libfiu is a library that you can use to add fault injection to your code. It aims to be easy to use by means of a simple API, with minimal code impact and little runtime overhead when enabled. That means that the modifications you have to do to your code (and build system) in order to support libfiu should be as little intrusive as possible. Code overview ------------- Let's take a look to a small (fictitious) code sample to see what's the general idea behind libfiu. Assume that you have this code that checks if there's enough free space to store a given file:: size_t free_space() { [code to find out how much free space there is] return space; } bool file_fits(FILE *fd) { if (free_space() < file_size(fd)) { return false; } return true; } With current disk sizes, it's very unusual to run out of free space, which makes the scenario where *free_space()* returns 0 hard to test. With libfiu, you can do the following small addition:: size_t free_space() { fiu_return_on("no_free_space", 0); [code to find out how much free space there is] return space; } bool file_fits(FILE *fd) { if (free_space() < file_size(fd)) { return false; } return true; } The *fiu_return_on()* annotation is the only change you need to make to your code to create a *point of failure*, which is identified by the name **no_free_space**. When that point of failure is enabled, the function will return 0. In your testing code, you can now do this:: fiu_init(); fiu_enable("no_free_space", 1, NULL, 0); assert(file_fits("tmpfile") == false); The first line initializes the library, and the second *enables* the point of failure. When the point of failure is enabled, *free_space()* will return 0, so you can test how your code behaves under that condition, which was otherwise hard to trigger. libfiu's API has two "sides": a core API and a control API. The core API is used inside the code to be fault injected. The control API is used inside the testing code, in order to control the injection of failures. In the example above, *fiu_return_on()* is a part of the core API, and *fiu_enable()* is a part of the control API. Using libfiu in your project ---------------------------- To use libfiu in your project, there are three things to consider: the build system, the fault injection code, and the testing code. The build system ~~~~~~~~~~~~~~~~ The first thing to do is to enable your build system to use libfiu. Usually, you do not want to make libfiu a runtime or build-time dependency, because it's often only used for testing. To that end, you should copy *fiu-local.h* into your source tree, and then create an option to do a *fault injection build* that #defines the constant *FIU_ENABLE* (usually done by adding ``-DFIU_ENABLE=1`` to your compiler flags) and links against libfiu (usually done by adding ``-lfiu`` to your linker flags). That way, normal builds will not have a single trace of fault injection code, but it will be easy to create a binary that does, for testing purposes. The fault injection code ~~~~~~~~~~~~~~~~~~~~~~~~ Adding fault injection to your code means inserting points of failure in it, using the core API. First, you should ``#include "fiu-local.h"`` in the files you want to add points of failure to. That header allows you to avoid libfiu as a build-time dependency, as mentioned in the last section. Then, to insert points of failure, sprinkle your code with calls like ``fiu_return_on("name", -1)``, ``fiu_exit_on("name")``, or more complex code using ``fiu_fail("name")``. See the libfiu's manpage for the details on the API. It is recommended that you use meaningful names for your points of failure, to be able to easily identify their purpose. You can also name them hierarchically (for example, using names like *"io/write"*, *"io/read"*, and so on), to be able to enable entire groups of points of failure (like *"io/\*"*). To this end, any separator will do, the *'/'* is not special at all. The testing code ~~~~~~~~~~~~~~~~ Testing can be done in too many ways, so I won't get into specific details here. As a general approach, usually the idea with fault injection is to write tests similar in spirit to the one shown above: initialize the library, enable one or more failures using the control API, and then check if the code behaves as expected. Initially, all points of failure are disabled, which means your code should run as usual, with a very small performance impact. The points of failure can be enabled using different strategies: Unconditional (*fiu_enable()*) Enables the point of failure in an unconditional way, so it always fails. Random (*fiu_enable_random()*) Enables the point of failure in a non-deterministic way, which will fail with the given probability. External (*fiu_enable_external()*) Enables the point of failure using an external function, which will be called to determine whether the point of failure should fail or not. You can also use an asterisk *at the end* of a name to enable all the points of failure that begin with the given name (excluding the asterisk, of course). Check libfiu's manpage for more details about the API. If you prefer to avoid writing the test code in C, you can use the Python bindings, and/or the *fiu-run* and *fiu-ctrl* utilities. libfiu-1.2/doc/posix.rst000066400000000000000000000074171451746352100153100ustar00rootroot00000000000000 Simulating failures in the POSIX API ==================================== When developing robust software, developers often consider the cases when the classic POSIX functions return failure. Testing that fault-handling code is a problem because under normal conditions it's hard to make the POSIX functions fail, and generating abnormal conditions is usually difficult. For example, getting *malloc()* to fail can represent using up all your memory, and at that point your test case might not even work. Or getting I/O operations to fail might involve filling up the disk which is very undesirable, or generating a very special environment which is difficult to reproduce. libfiu comes with some tools that can be used to perform fault injection in the POSIX API (which includes the C standard library functions) *without* having to modify the application's source code, that can help to simulate scenarios like the ones described above in an easy and reproducible way. fiu-run ------- The first of those tools is an application called *fiu-run*. Suppose you want to run the classic program "fortune" (which some would definitely consider mission critical) and see how it behaves on the presence of *read()* errors. With *fiu-run*, you can do it like this:: $ fiu-run -x -c "enable_random name=posix/io/rw/read,probability=0.05" fortune That enables the failure point with the name *posix/io/rw/read* with 5% probability to fail *on each call*, and then runs fortune. The *-x* parameter tells *fiu-run* to enable fault injection in the POSIX API. Run it several times and you can see that sometimes it works, but sometimes it doesn't, reporting an error reading, which means a *read()* failed as expected. When fortune is run, every *read()* has a 5% chance to fail, selecting an *errno* at random from the list of the ones that read() is allowed to return. If you want to select a specific *errno*, you can do it by passing its numerical value using the *-i* parameter. The name of the failure points are fixed, and there is at least one for each function that libfiu supports injecting failures to. Not all POSIX functions are included, but most of the important pieces are, and it can be easily extended. See below for details. To see the list of supported functions and names, see the (automatically generated) *preload/posix/function_list* file that comes in the libfiu tarball. fiu-ctrl -------- Sometimes it is more interesting to simulate failures at a given point in time instead of from the beginning, as *fiu-run* does. To that end, you can combine *fiu-run* with the second tool, called *fiu-ctrl*. Let's suppose we want to see what the "top" program does when it can't open files. First, we run it with *fiu-run*:: $ fiu-run -x top Everything should look normal. Then, in another terminal, we make *open()* fail unconditionally:: $ fiu-ctrl -c "enable name=posix/io/oc/open" `pidof top` After that moment, the top display will probably be empty, because it can't read process information. Now let's disable that failure point, so *open()* works again:: $ fiu-ctrl -c "disable name=posix/io/oc/open" `pidof top` And everything should have gone back to normal. How does it work ---------------- libfiu comes with two preload libraries: *fiu_run_preload* and *fiu_posix_preload*. The first one is loaded using *LD_PRELOAD* (see *ld.so(8)* for more information) by *fiu-run*, and can enable failure points and start libfiu's remote control capabilities before the program begins to run. The second one is also loaded using *LD_PRELOAD* by *fiu-run* when the *-x* parameter is given, and provides libfiu-enabled wrappers for the POSIX functions, allowing the user to inject failures in them. *fiu-ctrl* communicates with the applications launched by *fiu-run* via the libfiu remote control capabilities. libfiu-1.2/doc/remote_control.rst000066400000000000000000000031001451746352100171620ustar00rootroot00000000000000 Remote control ============== The library has remote controlling capabilities, so external, unrelated processes can enable and disable failure points. It has a very simple request/reply protocol that can be performed over different transports. At the moment, the only transport available is named pipes. Remote control must be enabled by the controlled process using *fiu_rc_fifo()* (for named pipes). A set of utilities are provided to enable remote control without having to alter the application's source code, which can be useful for performing fault injection in libraries, see *fiu-run* and *fiu-ctrl* for more information. Remote control protocol ----------------------- It is a line based request/reply protocol. Lines end with a newline character (no carriage return). A request is composed of a command and 0 or more parameters, separated with a single space. The following commands are supported at the moment: - ``enable [flags]`` - ``enable_random [flags]`` - ``disable `` Where: - *name* is the name of the point of failure (which, at the moment, cannot have spaces inside). - *failnum* the same as the *failnum* parameter of *fiu_enable()* (see the manpage for more details). - failinfo the same as the *failinfo* parameter of *fiu_enable()* (see the manpage for more details). - *flags* can be either absent or ``one``, which has the same meaning as passing ``FIU_ONETIME`` in the *flags* parameter to *fiu_enable()*. The reply is always a number: 0 on success, < 0 on errors. libfiu-1.2/libfiu/000077500000000000000000000000001451746352100141105ustar00rootroot00000000000000libfiu-1.2/libfiu/Makefile000066400000000000000000000073111451746352100155520ustar00rootroot00000000000000 CFLAGS += -std=c99 -pedantic -Wall ALL_CFLAGS = -D_XOPEN_SOURCE=600 -fPIC -DFIU_ENABLE=1 \ $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) # Optimization CFLAGS, only used when doing a non-debug build. OPT_CFLAGS = -O3 ifdef DEBUG ALL_CFLAGS += -g else ifdef PROFILE ALL_CFLAGS += -g -pg -fprofile-arcs -ftest-coverage else ALL_CFLAGS += $(OPT_CFLAGS) endif endif ifdef TRACE ALL_CFLAGS += -DFIU_TRACE=1 endif # prefix for installing the binaries PREFIX=/usr/local # prefix for eventual location of binaries DESTDIR=$(PREFIX) # install utility, we assume it's GNU/BSD compatible INSTALL=install OBJS = fiu.o fiu-rc.o backtrace.o wtable.o hash.o ifneq ($(V), 1) NICE_CC = @echo " CC $@"; $(CC) else NICE_CC = $(CC) endif LIB_VER=1.2 LIB_SO_VER=0 # We attempt to detect if we have the extensions we use in backtrace.c by just # attempting to compile it normally, and fall back to the dummy version if # that fails. Not very sophisticated but should be safe. USE_DUMMY_BACKTRACE := $(shell $(CC) $(ALL_CFLAGS) -c backtrace.c \ -o backtrace-check.o || echo -DDUMMY_BACKTRACE) ifndef USE_DUMMY_BACKTRACE # The real backtrace needs linking against libdl. USE_LIBDL = -ldl endif default: all all: libs libfiu.pc libfiu.pc: build-flags libfiu.pc.in @echo "generating libfiu.pc" @cat libfiu.pc.in | \ sed 's@++DESTDIR++@$(DESTDIR)@g' | \ sed 's@++LIB_VER++@$(LIB_VER)@g' \ > libfiu.pc libs: libfiu.so libfiu.a libfiu.so: build-flags symbols.map fiu.h $(OBJS) $(NICE_CC) $(ALL_CFLAGS) -shared -fPIC \ -Wl,-soname,libfiu.so.$(LIB_SO_VER) \ -Wl,--version-script=symbols.map \ $(OBJS) -lpthread $(USE_LIBDL) -o libfiu.so.$(LIB_VER) ln -fs libfiu.so.$(LIB_VER) libfiu.so ln -fs libfiu.so.$(LIB_VER) libfiu.so.$(LIB_SO_VER) libfiu.a: build-flags fiu.h $(OBJS) $(AR) cr libfiu.a $(OBJS) install-lib: libs libfiu.pc $(INSTALL) -d $(PREFIX)/lib $(INSTALL) -m 0755 libfiu.so.$(LIB_VER) $(PREFIX)/lib ln -fs libfiu.so.$(LIB_VER) $(PREFIX)/lib/libfiu.so ln -fs libfiu.so.$(LIB_VER) $(PREFIX)/lib/libfiu.so.$(LIB_SO_VER) $(INSTALL) -m 0755 libfiu.a $(PREFIX)/lib $(INSTALL) -d $(PREFIX)/include $(INSTALL) -m 0644 fiu.h $(PREFIX)/include $(INSTALL) -m 0644 fiu-control.h $(PREFIX)/include $(INSTALL) -m 0644 fiu-local.h $(PREFIX)/include $(INSTALL) -d $(PREFIX)/lib/pkgconfig $(INSTALL) -m 644 libfiu.pc $(PREFIX)/lib/pkgconfig @echo @echo "Please run ldconfig to update your library cache" @echo install-man: $(INSTALL) -d $(PREFIX)/share/man/man3 $(INSTALL) -m 0644 libfiu.3 $(PREFIX)/share/man/man3/ install: install-lib install-man uninstall-lib: $(RM) $(PREFIX)/lib/libfiu.so $(RM) $(PREFIX)/lib/libfiu.so.$(LIB_VER) $(RM) $(PREFIX)/lib/libfiu.so.$(LIB_SO_VER) $(RM) $(PREFIX)/lib/libfiu.a $(RM) $(PREFIX)/include/fiu.h $(RM) $(PREFIX)/include/fiu-control.h $(RM) $(PREFIX)/include/fiu-local.h $(RM) $(PREFIX)/lib/pkgconfig/libfiu.pc uninstall-man: $(RM) $(PREFIX)/share/man/man3/libfiu.3 uninstall: uninstall-lib uninstall-man BF = $(ALL_CFLAGS) ~ $(PREFIX) build-flags: .force-build-flags @if [ x"$(BF)" != x"`cat build-flags 2>/dev/null`" ]; then \ if [ -f build-flags ]; then \ echo "build flags changed, rebuilding"; \ fi; \ echo "$(BF)" > build-flags; \ fi $(OBJS): build-flags .c.o: $(NICE_CC) $(ALL_CFLAGS) -c $< -o $@ backtrace.o: ALL_CFLAGS += $(USE_DUMMY_BACKTRACE) doxygen: $(MAKE) LIB_VER=$(LIB_VER) -C doxygen clean: rm -f libfiu.pc $(OBJS) backtrace-check.o rm -f libfiu.so libfiu.so.$(LIB_VER) libfiu.so.$(LIB_SO_VER) libfiu.a rm -f *.bb *.bbg *.da *.gcov *.gcda *.gcno gmon.out build-flags $(MAKE) -C doxygen $@ .PHONY: default all libs \ install-lib install-man install \ uninstall-lib uninstall-man uninstall \ doxygen clean \ .force-build-flags libfiu-1.2/libfiu/backtrace.c000066400000000000000000000053011451746352100161720ustar00rootroot00000000000000 /* Since our implementation relies on nonstandard functions and headers, we * provide a dummy one below for compatibility purposes. The dummy version can * be selected at build time using -DDUMMY_BACKTRACE. */ #ifndef DUMMY_BACKTRACE /* This is needed for some of the functions below. */ #define _GNU_SOURCE #include #include #include #include /* NULL */ #include int get_backtrace(void *buffer, int size) { return backtrace(buffer, size); } void *get_func_start(void *pc) { int r; Dl_info info; r = dladdr(pc, &info); if (r == 0) return NULL; return info.dli_saddr; } void *get_func_end(void *func) { int r; Dl_info dl_info; ElfW(Sym) * elf_info; r = dladdr1(func, &dl_info, (void **)&elf_info, RTLD_DL_SYMENT); if (r == 0) return NULL; if (elf_info == NULL) return NULL; if (dl_info.dli_saddr == NULL) return NULL; return ((unsigned char *)func) + elf_info->st_size; } void *get_func_addr(const char *func_name) { return dlsym(RTLD_DEFAULT, func_name); } #else /* Dummy versions */ #warning Using dummy versions of backtrace #include /* for NULL */ int get_backtrace(void *buffer, int size) { return 0; } void *get_func_end(void *pc) { return NULL; } void *get_func_start(void *pc) { return NULL; } void *get_func_addr(const char *func_name) { return NULL; } #endif // DUMMY_BACKTRACE /* Ugly but useful conversion from function pointer to void *. * This is not guaranteed by the standard, but has to work on all platforms * where we support backtrace(), because that function assumes it so. */ static void *fp_to_voidp(void (*funcp)()) { unsigned char **p; p = (unsigned char **)&funcp; return *p; } int backtrace_works(void (*caller)()) { /* We remember the result so we don't have to compute it over an over * again, we know it doesn't change. */ static int works = -1; void *start = NULL; void *end = NULL; void *bt_buffer[100]; void *pc; int nptrs, i; /* Return the result if we know it. */ if (works >= 0) return works; nptrs = get_backtrace(bt_buffer, 100); if (nptrs <= 0) { works = 0; return works; } /* We will detect if it works by looking for the caller in the * backtrace. */ start = get_func_start(fp_to_voidp(caller)); end = get_func_end(fp_to_voidp(caller)); if (start == NULL && end == NULL) { works = 0; return works; } for (i = 0; i < nptrs; i++) { pc = bt_buffer[i]; /* On some platforms, we have everything except * get_func_end(), and that's ok. */ if (end) { if (pc >= start && pc <= end) { works = 1; return works; } } else { if (get_func_start(pc) == start) { works = 1; return works; } } } works = 0; return works; } libfiu-1.2/libfiu/doxygen/000077500000000000000000000000001451746352100155655ustar00rootroot00000000000000libfiu-1.2/libfiu/doxygen/Doxyfile.base.in000066400000000000000000003404331451746352100206200ustar00rootroot00000000000000# Doxyfile 1.9.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the 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 = "libfiu" # 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 = "++VERSION++" # 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 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all generated output in the proper direction. # Possible values are: None, LTR, RTL and Context. # The default value is: None. OUTPUT_TEXT_DIRECTION = None # 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 = YES # 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 = YES # 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 # 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 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines (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 = # 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 = YES # 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++, 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 = YES # 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 # 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 # 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 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 efficively 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 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_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 = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If 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 = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # 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 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. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also 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 = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. If # EXTRACT_ALL is set to YES then this flag will automatically be disabled. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. 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. # Possible values are: NO, YES and FAIL_ON_WARNINGS. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = ../ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: # https://www.gnu.org/software/libiconv/) for the list of possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # 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, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, # *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.h \ # 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, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = YES # 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 = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see 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 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: # http://clang.llvm.org/) for more accurate parsing at the cost of reduced # performance. This can be particularly helpful with template rich C++ code for # which doxygen's built-in parser lacks the necessary type information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to # YES then doxygen will add the directory of each input to the include path. # The default value is: YES. CLANG_ADD_INC_PATHS = YES # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_OPTIONS = # If clang assisted parsing is enabled you can provide the clang parser with the # path to the directory containing a file called compile_commands.json. This # file is the compilation database (see: # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the # options used when the source files were built. This is equivalent to # specifying the -p option to a clang tool, such as clang-check. These options # will then be passed to the parser. Any options specified with CLANG_OPTIONS # will be added as well. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. CLANG_DATABASE_PATH = #--------------------------------------------------------------------------- # 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 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # 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 grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 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_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_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 # 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 specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: # https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the 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 # 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. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # 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 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # 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 # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from https://www.mathjax.org before deployment. # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: # http://docs.mathjax.org/en/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. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /