From a10b35440a49700d3c553c56cdbb08ecd7e21b40 Mon Sep 17 00:00:00 2001 From: q3aql Date: Sat, 3 Dec 2022 17:19:55 +0100 Subject: [PATCH] Dotfiles config update (2022-12-03) --- .config/bemenu/GNUmakefile | 185 ++ .config/bemenu/LICENSE-CLIENT | 674 +++++ .config/bemenu/LICENSE-LIB | 165 ++ .config/bemenu/README.md | 215 ++ .config/bemenu/VERSION | 1 + .config/bemenu/bemenu.pc.in | 9 + .config/bemenu/build-install.sh | 10 + .config/bemenu/client/bemenu-run.c | 192 ++ .config/bemenu/client/bemenu.c | 84 + .config/bemenu/client/common/common.c | 636 +++++ .config/bemenu/client/common/common.h | 51 + .config/bemenu/darwin.nix | 38 + .config/bemenu/doxygen/Doxyfile | 2305 +++++++++++++++++ .config/bemenu/doxygen/Mainpage.dox | 23 + .../doxygen/doxygen-qmi-style/README.md | 41 + .../doxygen/doxygen-qmi-style/footer.html | 20 + .../doxygen/doxygen-qmi-style/header.html | 55 + .../navtree/ftv2mlastnode.png | Bin 0 -> 285 bytes .../doxygen-qmi-style/navtree/ftv2mnode.png | Bin 0 -> 285 bytes .../navtree/ftv2plastnode.png | Bin 0 -> 277 bytes .../doxygen-qmi-style/navtree/ftv2pnode.png | Bin 0 -> 282 bytes .../doxygen-qmi-style/navtree/navtree.css | 117 + .../bemenu/doxygen/doxygen-qmi-style/qmi.css | 1033 ++++++++ .../doxygen-qmi-style/search/search.css | 238 ++ .config/bemenu/lib/3rdparty/cdl.c | 96 + .config/bemenu/lib/3rdparty/cdl.h | 10 + .config/bemenu/lib/bemenu.h | 1119 ++++++++ .config/bemenu/lib/filter.c | 182 ++ .config/bemenu/lib/internal.h | 470 ++++ .config/bemenu/lib/item.c | 60 + .config/bemenu/lib/library.c | 190 ++ .config/bemenu/lib/list.c | 147 ++ .config/bemenu/lib/menu.c | 1378 ++++++++++ .config/bemenu/lib/renderers/cairo_renderer.h | 482 ++++ .config/bemenu/lib/renderers/curses/curses.c | 448 ++++ .../bemenu/lib/renderers/wayland/registry.c | 701 +++++ .../bemenu/lib/renderers/wayland/wayland.c | 609 +++++ .../bemenu/lib/renderers/wayland/wayland.h | 180 ++ .config/bemenu/lib/renderers/wayland/window.c | 395 +++ .../wayland/wlr-layer-shell-unstable-v1.xml | 390 +++ .../wayland/xdg-output-unstable-v1.c | 78 + .../wayland/xdg-output-unstable-v1.h | 411 +++ .../wayland/xdg-output-unstable-v1.xml | 220 ++ .config/bemenu/lib/renderers/x11/window.c | 299 +++ .config/bemenu/lib/renderers/x11/x11.c | 312 +++ .config/bemenu/lib/renderers/x11/x11.h | 64 + .../bemenu/lib/renderers/x11/xkb_unicode.c | 857 ++++++ .../bemenu/lib/renderers/x11/xkb_unicode.h | 8 + .config/bemenu/lib/util.c | 415 +++ .config/bemenu/lib/vim.c | 368 +++ .config/bemenu/lib/vim.h | 14 + .config/bemenu/man/bemenu.1.scd.in | 283 ++ .config/bemenu/pw.cloudef.bemenu-run.yml | 20 + .config/bemenu/pw.cloudef.bemenu.yml | 19 + .config/bemenu/scripts/bemenu | 9 + .config/bemenu/scripts/bemenu_close | 91 + .config/bemenu/scripts/bemenu_cmd | 44 + .config/bemenu/scripts/bemenu_drun | 117 + .config/bemenu/scripts/bemenu_fbrun | 93 + .config/bemenu/scripts/bemenu_run | 71 + .config/bemenu/scripts/bemenu_themes | 220 ++ .config/bemenu/scripts/check-symbols.sh | 42 + 62 files changed, 17004 insertions(+) create mode 100644 .config/bemenu/GNUmakefile create mode 100644 .config/bemenu/LICENSE-CLIENT create mode 100644 .config/bemenu/LICENSE-LIB create mode 100644 .config/bemenu/README.md create mode 100644 .config/bemenu/VERSION create mode 100644 .config/bemenu/bemenu.pc.in create mode 100755 .config/bemenu/build-install.sh create mode 100644 .config/bemenu/client/bemenu-run.c create mode 100644 .config/bemenu/client/bemenu.c create mode 100644 .config/bemenu/client/common/common.c create mode 100644 .config/bemenu/client/common/common.h create mode 100644 .config/bemenu/darwin.nix create mode 100644 .config/bemenu/doxygen/Doxyfile create mode 100644 .config/bemenu/doxygen/Mainpage.dox create mode 100644 .config/bemenu/doxygen/doxygen-qmi-style/README.md create mode 100644 .config/bemenu/doxygen/doxygen-qmi-style/footer.html create mode 100644 .config/bemenu/doxygen/doxygen-qmi-style/header.html create mode 100644 .config/bemenu/doxygen/doxygen-qmi-style/navtree/ftv2mlastnode.png create mode 100644 .config/bemenu/doxygen/doxygen-qmi-style/navtree/ftv2mnode.png create mode 100644 .config/bemenu/doxygen/doxygen-qmi-style/navtree/ftv2plastnode.png create mode 100644 .config/bemenu/doxygen/doxygen-qmi-style/navtree/ftv2pnode.png create mode 100644 .config/bemenu/doxygen/doxygen-qmi-style/navtree/navtree.css create mode 100644 .config/bemenu/doxygen/doxygen-qmi-style/qmi.css create mode 100644 .config/bemenu/doxygen/doxygen-qmi-style/search/search.css create mode 100644 .config/bemenu/lib/3rdparty/cdl.c create mode 100644 .config/bemenu/lib/3rdparty/cdl.h create mode 100644 .config/bemenu/lib/bemenu.h create mode 100644 .config/bemenu/lib/filter.c create mode 100644 .config/bemenu/lib/internal.h create mode 100644 .config/bemenu/lib/item.c create mode 100644 .config/bemenu/lib/library.c create mode 100644 .config/bemenu/lib/list.c create mode 100644 .config/bemenu/lib/menu.c create mode 100644 .config/bemenu/lib/renderers/cairo_renderer.h create mode 100644 .config/bemenu/lib/renderers/curses/curses.c create mode 100644 .config/bemenu/lib/renderers/wayland/registry.c create mode 100644 .config/bemenu/lib/renderers/wayland/wayland.c create mode 100644 .config/bemenu/lib/renderers/wayland/wayland.h create mode 100644 .config/bemenu/lib/renderers/wayland/window.c create mode 100644 .config/bemenu/lib/renderers/wayland/wlr-layer-shell-unstable-v1.xml create mode 100644 .config/bemenu/lib/renderers/wayland/xdg-output-unstable-v1.c create mode 100644 .config/bemenu/lib/renderers/wayland/xdg-output-unstable-v1.h create mode 100644 .config/bemenu/lib/renderers/wayland/xdg-output-unstable-v1.xml create mode 100644 .config/bemenu/lib/renderers/x11/window.c create mode 100644 .config/bemenu/lib/renderers/x11/x11.c create mode 100644 .config/bemenu/lib/renderers/x11/x11.h create mode 100644 .config/bemenu/lib/renderers/x11/xkb_unicode.c create mode 100644 .config/bemenu/lib/renderers/x11/xkb_unicode.h create mode 100644 .config/bemenu/lib/util.c create mode 100644 .config/bemenu/lib/vim.c create mode 100644 .config/bemenu/lib/vim.h create mode 100644 .config/bemenu/man/bemenu.1.scd.in create mode 100644 .config/bemenu/pw.cloudef.bemenu-run.yml create mode 100644 .config/bemenu/pw.cloudef.bemenu.yml create mode 100755 .config/bemenu/scripts/bemenu create mode 100755 .config/bemenu/scripts/bemenu_close create mode 100755 .config/bemenu/scripts/bemenu_cmd create mode 100755 .config/bemenu/scripts/bemenu_drun create mode 100755 .config/bemenu/scripts/bemenu_fbrun create mode 100755 .config/bemenu/scripts/bemenu_run create mode 100755 .config/bemenu/scripts/bemenu_themes create mode 100644 .config/bemenu/scripts/check-symbols.sh diff --git a/.config/bemenu/GNUmakefile b/.config/bemenu/GNUmakefile new file mode 100644 index 0000000..edeeb8a --- /dev/null +++ b/.config/bemenu/GNUmakefile @@ -0,0 +1,185 @@ +VERSION ?= $(shell cat VERSION) +PREFIX ?= /usr/local +includedir ?= /include +bindir ?= /bin +libdir ?= /lib +mandir ?= /share/man/man1 +PKG_CONFIG ?= pkg-config + +GIT_SHA1 = $(shell git rev-parse HEAD 2>/dev/null || printf 'nogit') +GIT_TAG = $(shell git tag --points-at HEAD 2>/dev/null || cat VERSION) +MAKEFLAGS += --no-builtin-rules + +WARNINGS = -Wall -Wextra -Wpedantic -Wformat=2 -Wstrict-aliasing=3 -Wstrict-overflow=5 -Wstack-usage=12500 \ + -Wcast-align -Wpointer-arith -Wchar-subscripts -Warray-bounds=2 -Wno-unknown-warning-option +VISIBILITY ?= -fvisibility=hidden + +override CFLAGS ?= -g -O2 $(WARNINGS) $(EXTRA_WARNINGS) +override CFLAGS += -std=c99 $(VISIBILITY) +override CPPFLAGS ?= -D_FORTIFY_SOURCE=2 +override CPPFLAGS += -DBM_VERSION=\"$(VERSION)\" -DBM_PLUGIN_VERSION=\"$(VERSION)-$(GIT_SHA1)\" -DINSTALL_LIBDIR=\"$(PREFIX)$(libdir)\" +override CPPFLAGS += -D_DEFAULT_SOURCE -Ilib + +libs = libbemenu.so +pkgconfigs = bemenu.pc +bins = bemenu bemenu-run +mans = bemenu.1 +renderers = bemenu-renderer-x11.so bemenu-renderer-curses.so bemenu-renderer-wayland.so +all: $(bins) $(renderers) $(mans) +clients: $(bins) +curses: bemenu-renderer-curses.so +x11: bemenu-renderer-x11.so +wayland: bemenu-renderer-wayland.so + +# support non git builds +.git/index: + mkdir -p .git + touch .git/index + +%.a: + $(LINK.c) -c $(filter %.c,$^) $(LDLIBS) -o $@ + +$(libs): private override full=$(addsuffix .$(VERSION), $@) +$(libs): private override major=$(addsuffix .$(firstword $(subst ., ,$(VERSION))), $@) +$(libs): %: VERSION .git/index + $(LINK.c) -shared -fPIC $(filter %.c %.a,$^) $(LDLIBS) -o $(full) -Wl,-soname,$(major) + ln -fs $(full) $(major) + ln -fs $(full) $@ + +$(pkgconfigs): %: VERSION %.in + sed "s/@VERSION@/$(VERSION)/;s,@PREFIX@,$(PREFIX),;s,@LIBDIR@,$(libdir),;s,@INCLUDEDIR@,$(includedir)," $(addsuffix .in, $@) > $@ + +bemenu.1: man/bemenu.1.scd.in + -sed 's,@LIBDIR@,$(PREFIX)$(libdir),' $< | scdoc > $@ + +$(renderers): %: VERSION .git/index | $(libs) + $(LINK.c) -shared -fPIC $(filter %.c %.a,$^) $(LDLIBS) -L. -lbemenu -o $@ + +$(bins): %: | $(libs) + $(LINK.c) $(filter %.c %.a,$^) $(LDLIBS) -L. -lbemenu -o $@ + +cdl.a: private override LDFLAGS += -fPIC +cdl.a: lib/3rdparty/cdl.c lib/3rdparty/cdl.h + +util.a: private override LDFLAGS += -fPIC +util.a: lib/util.c lib/internal.h + +libbemenu.so: private override LDLIBS += -ldl +libbemenu.so: lib/bemenu.h lib/internal.h lib/filter.c lib/item.c lib/library.c lib/list.c lib/menu.c lib/vim.c util.a cdl.a + +bemenu-renderer-curses.so: private override LDLIBS += $(shell $(PKG_CONFIG) --libs ncursesw) -lm +bemenu-renderer-curses.so: private override CPPFLAGS += $(shell $(PKG_CONFIG) --cflags-only-I ncursesw) +bemenu-renderer-curses.so: lib/renderers/curses/curses.c util.a + +bemenu-renderer-x11.so: private override LDLIBS += $(shell $(PKG_CONFIG) --libs x11 xinerama cairo pango pangocairo) +bemenu-renderer-x11.so: private override CPPFLAGS += $(shell $(PKG_CONFIG) --cflags-only-I x11 xinerama cairo pango pangocairo) +bemenu-renderer-x11.so: lib/renderers/cairo_renderer.h lib/renderers/x11/x11.c lib/renderers/x11/x11.h lib/renderers/x11/window.c lib/renderers/x11/xkb_unicode.c lib/renderers/x11/xkb_unicode.h util.a + +lib/renderers/wayland/xdg-shell.c: + wayland-scanner private-code < "$$($(PKG_CONFIG) --variable=pkgdatadir wayland-protocols)/stable/xdg-shell/xdg-shell.xml" > $@ + +lib/renderers/wayland/wlr-layer-shell-unstable-v1.h: lib/renderers/wayland/wlr-layer-shell-unstable-v1.xml + wayland-scanner client-header < $^ > $@ + +lib/renderers/wayland/wlr-layer-shell-unstable-v1.c: lib/renderers/wayland/wlr-layer-shell-unstable-v1.xml + wayland-scanner private-code < $^ > $@ + +lib/renderers/wayland/xdg-output-unstable-v1.h: lib/renderers/wayland/xdg-output-unstable-v1.xml + wayland-scanner client-header < $^ > $@ + +lib/renderers/wayland/xdg-output-unstable-v1.c: lib/renderers/wayland/xdg-output-unstable-v1.xml + wayland-scanner private-code < $^ > $@ + +xdg-shell.a: private override LDFLAGS += -fPIC +xdg-shell.a: private override CPPFLAGS += $(shell $(PKG_CONFIG) --cflags-only-I wayland-client) +xdg-shell.a: lib/renderers/wayland/xdg-shell.c +wlr-layer-shell.a: private override LDFLAGS += -fPIC +wlr-layer-shell.a: private override CPPFLAGS += $(shell $(PKG_CONFIG) --cflags-only-I wayland-client) +wlr-layer-shell.a: lib/renderers/wayland/wlr-layer-shell-unstable-v1.c lib/renderers/wayland/wlr-layer-shell-unstable-v1.h +xdg-output.a: private override LDFLAGS += -fPIC +xdg-output.a: private override CPPFLAGS += $(shell $(PKG_CONFIG) --cflags-only-I wayland-client) +xdg-output.a: lib/renderers/wayland/xdg-output-unstable-v1.c lib/renderers/wayland/xdg-output-unstable-v1.h +bemenu-renderer-wayland.so: private override LDLIBS += $(shell $(PKG_CONFIG) --libs wayland-client cairo pango pangocairo xkbcommon) +bemenu-renderer-wayland.so: private override CPPFLAGS += $(shell $(PKG_CONFIG) --cflags-only-I wayland-client cairo pango pangocairo xkbcommon) +bemenu-renderer-wayland.so: lib/renderers/cairo_renderer.h lib/renderers/wayland/wayland.c lib/renderers/wayland/wayland.h lib/renderers/wayland/registry.c lib/renderers/wayland/window.c xdg-shell.a wlr-layer-shell.a xdg-output.a util.a + +common.a: client/common/common.c client/common/common.h +bemenu: common.a client/bemenu.c +bemenu-run: common.a client/bemenu-run.c + +install-pkgconfig: $(pkgconfigs) + mkdir -p "$(DESTDIR)$(PREFIX)$(libdir)/pkgconfig" + cp $^ "$(DESTDIR)$(PREFIX)$(libdir)/pkgconfig" + +install-include: lib/bemenu.h + mkdir -p "$(DESTDIR)$(PREFIX)$(includedir)" + cp $^ "$(DESTDIR)$(PREFIX)$(includedir)" + +install-libs: $(libs) + mkdir -p "$(DESTDIR)$(PREFIX)$(libdir)" + cp $(addsuffix .$(VERSION), $^) "$(DESTDIR)$(PREFIX)$(libdir)" + +install-lib-symlinks: $(libs) | install-libs + cp -RP $^ $(addsuffix .$(firstword $(subst ., ,$(VERSION))), $^) "$(DESTDIR)$(PREFIX)$(libdir)" + +install-bins: + mkdir -p "$(DESTDIR)$(PREFIX)$(bindir)" + -cp $(bins) "$(DESTDIR)$(PREFIX)$(bindir)" + -chmod 0755 $(addprefix "$(DESTDIR)$(PREFIX)$(bindir)"/,$(bins)) + +install-man: bemenu.1 + -hash scdoc && mkdir -p "$(DESTDIR)$(PREFIX)$(mandir)" + -hash scdoc && cp $< "$(DESTDIR)$(PREFIX)$(mandir)" + +install-renderers: install-curses install-wayland install-x11 + +install-curses: + mkdir -p "$(DESTDIR)$(PREFIX)$(libdir)/bemenu" + -cp bemenu-renderer-curses.so "$(DESTDIR)$(PREFIX)$(libdir)/bemenu" + +install-wayland: + mkdir -p "$(DESTDIR)$(PREFIX)$(libdir)/bemenu" + -cp bemenu-renderer-wayland.so "$(DESTDIR)$(PREFIX)$(libdir)/bemenu" + +install-x11: + mkdir -p "$(DESTDIR)$(PREFIX)$(libdir)/bemenu" + -cp bemenu-renderer-x11.so "$(DESTDIR)$(PREFIX)$(libdir)/bemenu" + +install-docs: install-man + +install-base: install-pkgconfig install-include install-lib-symlinks install-bins + +install: install-base install-renderers install-docs + @echo "Install OK!" + +doxygen: + BM_VERSION=$(VERSION) doxygen doxygen/Doxyfile + cp -R doxygen/doxygen-qmi-style/navtree html + cp -R doxygen/doxygen-qmi-style/search html/search + +sign: + test "x$(GIT_TAG)" = "x$(VERSION)" + git archive --prefix="bemenu-$(VERSION)/" -o "bemenu-$(VERSION).tar.gz" "$(GIT_TAG)" + gpg --default-key "$(GPG_KEY_ID)" --armor --detach-sign "bemenu-$(VERSION).tar.gz" + +check-symbols: libbemenu.so lib/bemenu.h + sh scripts/check-symbols.sh $^ bemenu-renderer-*.so + +clean: + $(RM) -r *.dSYM # OSX generates .dSYM dirs with -g ... + $(RM) $(pkgconfigs) $(libs) $(bins) $(renderers) $(mans) *.a *.so.* + $(RM) lib/renderers/wayland/wlr-*.h lib/renderers/wayland/wlr-*.c lib/renderers/wayland/xdg-shell.c + $(RM) -r html + +uninstall: + $(RM) -r "$(DESTDIR)$(PREFIX)$(libdir)/bemenu" + $(RM) "$(DESTDIR)$(PREFIX)$(mandir)/bemenu.1" + $(RM) "$(DESTDIR)$(PREFIX)$(bindir)/bemenu" + $(RM) "$(DESTDIR)$(PREFIX)$(bindir)/bemenu-run" + $(RM) "$(DESTDIR)$(PREFIX)$(libdir)"/libbemenu.so* + $(RM) "$(DESTDIR)$(PREFIX)$(includedir)/bemenu.h" + +.DELETE_ON_ERROR: +.PHONY: all clean uninstall install install-base install-pkgconfig install-include install-libs install-lib-symlinks \ + install-man install-bins install-docs install-renderers install-curses install-wayland install-x11 \ + doxygen sign check-symbols clients curses x11 wayland diff --git a/.config/bemenu/LICENSE-CLIENT b/.config/bemenu/LICENSE-CLIENT new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/.config/bemenu/LICENSE-CLIENT @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/.config/bemenu/LICENSE-LIB b/.config/bemenu/LICENSE-LIB new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/.config/bemenu/LICENSE-LIB @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/.config/bemenu/README.md b/.config/bemenu/README.md new file mode 100644 index 0000000..48f4901 --- /dev/null +++ b/.config/bemenu/README.md @@ -0,0 +1,215 @@ +bemenu +====== + +Dynamic menu library and client program inspired by dmenu + +![preview](.github/preview.svg) + +## Releases + +Releases are signed with [29317348D687B86B](http://pgp.mit.edu/pks/lookup?op=vindex&search=0x29317348D687B86B) and published [on GitHub](https://github.com/Cloudef/bemenu/releases). + +## Building + +```sh +# Build everything +make + +# To build only certain features, pass the targets which you are interested into +# +# You can also use the following meta-targets for common features: +# - clients (bemenu, bemenu-run) +# - x11 +# - wayland +# - curses +# +# For example this would build the bemenu and bemenu-run binaries and the x11 backend: +make clients x11 + +# To install the built features, simply run: +make install + +# NOTE: You may get errors during install when not building all the features. +# These errors are free to ignore if `Install OK!` is printed. + +# By default that will install to /usr/local, but you can change this with PREFIX +make install PREFIX=/usr + +# Other usual variables are available for modifying such as DESTDIR, bindir, libdir and mandir +# Note that if you want a custom PREFIX or libdir, you should pass those during build as well, +# since they will be used compile-time to figure out where to load backends from! + +# HTML API documentation (requires doxygen installed): +make doxygen + +# To test from source, you have to point the LD_LIBRARY_PATH and BEMENU_RENDERERS variables: +LD_LIBRARY_PATH=. BEMENU_RENDERERS=. ./bemenu-run +``` + +## OSX + +### Homebrew + +```sh +# Make sure you have GNU Make and pkg-config installed +brew install make pkg-config + +# You may need to setup your pkg-config to point to the brew version of the libraries +# For example to build curses backend, you'd do: +PKG_CONFIG_PATH="/usr/local/opt/ncurses/lib/pkgconfig" sh build-osx.sh curses + +# Other than that, follow the normal build steps, but use `build-osx.sh` instead of make +``` + +### Nix + +There is darwin.nix provided in this repo, you can install bemenu with it by running +```sh +nix-env -i -f darwin.nix +``` + +This installs only the curses backend. + +## Dependencies + +- C compiler +- scdoc to generate manpage + +### Backend-specific + +All dependencies below are searched with `pkg-config` + +| Backend | Dependencies | +|----------|------------------------------------------------------------------------| +| curses | ncursesw | +| x11 | x11, xinerama, cairo, pango, pangocairo | +| Wayland | wayland-client, wayland-protocols, cairo, pango, pangocairo, xkbcommon | + +Currently, pasting from clipboard is done at runtime with `wl-paste -t text/plain` and `xclip -t text/plain -out`, attempted in that order. + +### Installing the dependencies + +#### Ubuntu 20.04 + +```sh +sudo apt install scdoc wayland-protocols libcairo-dev libpango1.0-dev libxkbcommon-dev libwayland-dev +``` + +## Environment variables + +| Variable | Description | Value | +|------------------|-----------------------------------------|----------------------| +| BEMENU_OPTS | Options for bemenu, bemenu-run from env | Any cli argument | +| BEMENU_BACKEND | Force backend by name | x11, wayland, curses | +| BEMENU_RENDERER | Force backend by loading a .so file | Path to the .so file | +| BEMENU_RENDERERS | Override the backend search path | Path to a directory | +| BEMENU_SCALE | Override the rendering scale factor | Float value | + +## About Wayland support + +Wayland is only supported by compositors that implement the [wlr-layer-shell](https://github.com/swaywm/wlr-protocols/tree/master/unstable) protocol. +Typically [wlroots](https://github.com/swaywm/wlroots)-based compositors. + +## Keybindings + +### Default Bindings +| Key | Binding | +|---------------------|----------------------------------------------------------------| +| Left Arrow | Move cursor left | +| Right Arrow | Move cursor right | +| Up Arrow | Move to previous item | +| Down Arrow | Move to next item | +| Shift + Left Arrow | Select previous item | +| Shift + Right Arrow | Select next item | +| Shift + Alt + < | Select first item in actual list | +| Shift + Alt + > | Select last item in actual list | +| Shift + Page Up | Select first item in actual list | +| Shift + Page Down | Select last item in actual list | +| Page Up | Select first item in displayed list | +| Page Down | Select last item in displayed list | +| Tab | Move to next item | +| Shift + Tab | Select item and place it in filter | +| Esc | Exit bemenu | +| Insert | Return filter text or selected items if multi selection | +| Shift + Return | Return filter text or selected items if multi selection | +| Return | Execute selected item | +| Home | Curses cursor set to 0 | +| End | Cursor set to end of filter text | +| Backspace | Delete character at cursor | +| Delete | Delete character at cursor | +| Delete Left | Delete text before cursor | +| Delete Right | Delete text after cursor | +| Word Delete | Delete all text in filter | +| Alt + v | Select last item in displayed list | +| Alt + j | Select next item | +| Alt + d | Select last item in display list | +| Alt + l | Select previous item | +| Alt + f | Select next item | +| Alt + 0-9 | Execute selected item with custom exit code | +| Ctrl + Return | Select item but don't quit to select multiple items | +| Ctrl + g | Exit bemenu | +| Ctrl + n | Select next item | +| Ctrl + p | Select previous item | +| Ctrl + a | Move cursor to beginning of text in filter | +| Ctrl + e | Move cursor to end of text in filter | +| Ctrl + h | Delete character at cursor | +| Ctrl + u | Kill text behind cursor | +| Ctrl + k | Kill text after cursor | +| Ctrl + w | Kill all text in filter | +| Ctrl + m | Execute selected item | +| Ctrl + y | Paste clipboard | + +### Vim Bindings +Vim bindings can be activated via the `--binding vim` option. All bindings are in vim +`normal` mode. When bemenu is started with vim bindings it will be in `insert` mode. By +pressing `escape`, `normal` mode can be activated. + +**Note**: The default bindings can still be used for actions that do not have a separate +vim binding such as launching a program or pasting. + +| Key | Binding | +|-------|-----------------------------------------------| +| j/n | Goto next item | +| k/p | Goto previous item | +| h | Move cursor left | +| l | Move cursor right | +| q | Quit bemenu | +| v | Toggle item selection | +| i | Enter insert mode | +| I | Move to line start and enter insert mode | +| a | Move to the right and enter insert mode | +| A | Move to line end and enter insert mode | +| w | Move a word | +| b | Move a word backwards | +| e | Move to end of word | +| x | Delete a character | +| X | Delete a character before the cursor | +| 0 | Move to line start | +| $ | Move to line end | +| gg | Goto first item | +| G | Goto last item | +| H | Goto first item in view | +| M | Goto middle item in view | +| L | Goto last item in view | +| F | Scroll one page of items down | +| B | Scroll one page of items up | +| dd | Delete the whole line | +| dw | Delete a word | +| db | Delete a word backwards | +| d0 | Delete to start of line | +| d$ | Delete to end of line | +| cc | Change the whole line | +| cw | Change a word | +| cb | Change a word backwards | +| c0 | Change to start of line | +| c$ | Change to end of line | + +## Projects using bemenu + +* [pinentry-bemenu](https://github.com/t-8ch/pinentry-bemenu) + +## License + +* [GNU GPLv3 (or any later version)](LICENSE-CLIENT) for client program[s] and + other sources except library and bindings +* [GNU LGPLv3 (or any later version)](LICENSE-LIB) for library and bindings diff --git a/.config/bemenu/VERSION b/.config/bemenu/VERSION new file mode 100644 index 0000000..e196726 --- /dev/null +++ b/.config/bemenu/VERSION @@ -0,0 +1 @@ +0.6.13 diff --git a/.config/bemenu/bemenu.pc.in b/.config/bemenu/bemenu.pc.in new file mode 100644 index 0000000..c205ce0 --- /dev/null +++ b/.config/bemenu/bemenu.pc.in @@ -0,0 +1,9 @@ +prefix=@PREFIX@ +libdir=${prefix}@LIBDIR@ +includedir=${prefix}@INCLUDEDIR@ + +Name: bemenu +Description: Dynamic menu library +Version: @VERSION@ +Libs: -L${libdir} -lbemenu +Cflags: -I${includedir} diff --git a/.config/bemenu/build-install.sh b/.config/bemenu/build-install.sh new file mode 100755 index 0000000..2944675 --- /dev/null +++ b/.config/bemenu/build-install.sh @@ -0,0 +1,10 @@ +#!/bin/bash + +make clients x11 wayland curses +mv -v bemenu bemenu-renderer +cp -rf scripts/bemenu bemenu +make install PREFIX=/usr +cp -rfv bemenu-renderer /usr/bin +rm -rfv bemenu-renderer +make clean +cp -rfv scripts/bemenu_* /usr/bin/ diff --git a/.config/bemenu/client/bemenu-run.c b/.config/bemenu/client/bemenu-run.c new file mode 100644 index 0000000..6b8178b --- /dev/null +++ b/.config/bemenu/client/bemenu-run.c @@ -0,0 +1,192 @@ +#include +#include +#include +#include +#include +#include +#include +#include "common/common.h" + +static struct client client = { + .filter_mode = BM_FILTER_MODE_DMENU, + .title = "bemenu-run", + .monitor = -1, +}; + +struct paths { + char *path; + char *paths; +}; + +static char* +c_strdup(const char *str) +{ + return cstrcopy(str, strlen(str)); +} + +static char* +strip_slash(char *str) +{ + size_t size = strlen(str); + if (size > 0) + for (char *s = str + size - 1; *s == '/'; --s) + *s = 0; + return str; +} + +static const char* +get_paths(const char *env, const char *default_paths, struct paths *state) +{ + if (state->path && !*state->path) { + free(state->paths); + return NULL; + } + + if (!state->paths) { + const char *paths; + if (!(paths = getenv(env)) || !paths[0]) + paths = default_paths; + + state->path = state->paths = c_strdup(paths); + } + + if (!state->path || !state->paths) + return NULL; + + char *path; + do { + size_t f; + path = state->path; + if ((f = strcspn(state->path, ":")) > 0) { + state->path += f + (path[f] ? 1 : 0); + path[f] = 0; + } else { + state->path += 1; + } + + if (!*path) { + free(state->paths); + return NULL; + } + } while (path[0] != '/'); + + return strip_slash(path); +} + +static int +compare(const void *a, const void *b) +{ + const struct bm_item *ia = *(struct bm_item**)a, *ib = *(struct bm_item**)b; + return strcmp(bm_item_get_text(ia), bm_item_get_text(ib)); +} + +static void +read_items_to_menu_from_dir(struct bm_menu *menu, const char *path) +{ + assert(menu && path); + + DIR *dir; + if (!(dir = opendir(path))) + return; + + struct dirent *file; + while ((file = readdir(dir))) { + if (file->d_type != DT_DIR && strlen(file->d_name) && file->d_name[0] != '.') { + struct bm_item *item; + if (!(item = bm_item_new(file->d_name))) + break; + + bm_menu_add_item(menu, item); + } + } + + closedir(dir); + + uint32_t count; + struct bm_item **items = bm_menu_get_items(menu, &count); + qsort(items, count, sizeof(struct bm_item*), compare); + + bool unique = true; + for (uint32_t i = 0; i + 1 < count; i += unique) { + if (!(unique = strcmp(bm_item_get_text(items[i]), bm_item_get_text(items[i + 1])))) { + bm_item_free(items[i]); + bm_menu_remove_item_at(menu, i); + items = bm_menu_get_items(menu, &count); + } + } +} + +static void +read_items_to_menu_from_path(struct bm_menu *menu) +{ + assert(menu); + + const char *path; + struct paths state; + memset(&state, 0, sizeof(state)); + while ((path = get_paths("PATH", "/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/bin:/sbin", &state))) + read_items_to_menu_from_dir(menu, path); +} + +static inline void ignore_ret(int useless, ...) { (void)useless; } + +static void +launch(const struct client *client, const char *bin) +{ + if (!bin) + return; + + if (!client->fork || fork() == 0) { + if (client->fork) { + setsid(); + ignore_ret(0, freopen("/dev/null", "w", stdout)); + ignore_ret(0, freopen("/dev/null", "w", stderr)); + } + + char **tokens; + if (!(tokens = tokenize_quoted_to_argv(bin, NULL, NULL))) + _exit(EXIT_FAILURE); + + execvp(tokens[0], tokens); + _exit(EXIT_SUCCESS); + } +} + +static void +item_cb(const struct client *client, struct bm_item *item) +{ + if (client->no_exec) { + const char *text = bm_item_get_text(item); + printf("%s\n", (text ? text : "")); + } else { + launch(client, bm_item_get_text(item)); + } +} + +int +main(int argc, char **argv) +{ + struct sigaction action = { + .sa_handler = SIG_DFL, + .sa_flags = SA_NOCLDWAIT + }; + + // do not care about childs + sigaction(SIGCHLD, &action, NULL); + + if (!bm_init()) + return EXIT_FAILURE; + + parse_args(&client, &argc, &argv); + + struct bm_menu *menu; + if (!(menu = menu_with_options(&client))) + return EXIT_FAILURE; + + read_items_to_menu_from_path(menu); + const enum bm_run_result status = run_menu(&client, menu, item_cb); + bm_menu_free(menu); + return (status == BM_RUN_RESULT_SELECTED ? EXIT_SUCCESS : EXIT_FAILURE); +} + +/* vim: set ts=8 sw=4 tw=0 :*/ diff --git a/.config/bemenu/client/bemenu.c b/.config/bemenu/client/bemenu.c new file mode 100644 index 0000000..ef893b3 --- /dev/null +++ b/.config/bemenu/client/bemenu.c @@ -0,0 +1,84 @@ +#include +#include +#include +#include +#include "common/common.h" + +static struct client client = { + .filter_mode = BM_FILTER_MODE_DMENU, + .title = "bemenu", + .monitor = -1, +}; + +static void +read_items_to_menu_from_stdin(struct bm_menu *menu) +{ + assert(menu); + + ssize_t n; + size_t llen = 0; + char *line = NULL; + + while ((n = getline(&line, &llen, stdin)) > 0) { + // Remove trailing newline (if any) + if (line[n - 1] == '\n') + line[n - 1] = '\0'; + + struct bm_item *item; + if (!(item = bm_item_new(line))) + break; + + bm_menu_add_item(menu, item); + } + free(line); + + if (ferror(stdin)) { + fprintf(stderr, "getline failed"); + return; + } +} + +static void +item_cb(const struct client *client, struct bm_item *item) +{ + (void)client; + const char *text = bm_item_get_text(item); + printf("%s\n", (text ? text : "")); +} + +int +main(int argc, char **argv) +{ + if (!bm_init()) + return EXIT_FAILURE; + + parse_args(&client, &argc, &argv); + + struct bm_menu *menu; + if (!(menu = menu_with_options(&client))) + return EXIT_FAILURE; + + read_items_to_menu_from_stdin(menu); + const enum bm_run_result status = run_menu(&client, menu, item_cb); + bm_menu_free(menu); + switch (status) { + case BM_RUN_RESULT_SELECTED: + return EXIT_SUCCESS; + + case BM_RUN_RESULT_CUSTOM_1: return 10; + case BM_RUN_RESULT_CUSTOM_2: return 11; + case BM_RUN_RESULT_CUSTOM_3: return 12; + case BM_RUN_RESULT_CUSTOM_4: return 13; + case BM_RUN_RESULT_CUSTOM_5: return 14; + case BM_RUN_RESULT_CUSTOM_6: return 15; + case BM_RUN_RESULT_CUSTOM_7: return 16; + case BM_RUN_RESULT_CUSTOM_8: return 17; + case BM_RUN_RESULT_CUSTOM_9: return 18; + case BM_RUN_RESULT_CUSTOM_10: return 19; + + default: + return EXIT_FAILURE; + } +} + +/* vim: set ts=8 sw=4 tw=0 :*/ diff --git a/.config/bemenu/client/common/common.c b/.config/bemenu/client/common/common.c new file mode 100644 index 0000000..8eacfd3 --- /dev/null +++ b/.config/bemenu/client/common/common.c @@ -0,0 +1,636 @@ +#include "internal.h" + +#include "common.h" +#include +#include +#include +#include +#include +#include +#include + +static void +disco_trap(int sig) +{ + (void)sig; + fprintf(stderr, "\x1B[?25h"); + fflush(stderr); + exit(EXIT_FAILURE); +} + +static void +disco(void) +{ + struct sigaction action; + memset(&action, 0, sizeof(struct sigaction)); + action.sa_handler = disco_trap; + sigaction(SIGABRT, &action, NULL); + sigaction(SIGSEGV, &action, NULL); + sigaction(SIGTRAP, &action, NULL); + sigaction(SIGINT, &action, NULL); + + uint32_t cc, c = 80; + fprintf(stderr, "\x1B[?25l"); + while (1) { + for (uint32_t i = 1; i < c - 1; ++i) { + fprintf(stderr, "\r %*s%s %s %s ", (i > c / 2 ? c - i : i), " ", ((i % 2) ? ""), ((i % 4) ? "DISCO" : " "), ((i %2) ? "\\o>" : ""), ((i % 2) ? "*" : "•")); + for (cc = 2; cc < (i > c / 2 ? c - i : i); ++cc) fprintf(stderr, ((i % 2) ? "^" : "'")); + fflush(stderr); + usleep(140 * 1000); + } + } + fprintf(stderr, "\x1B[?25h"); + exit(EXIT_SUCCESS); +} + +#define WHITESPACE " \t\n\r" + +static const char* +tokenize(const char *cstr, size_t *out_len, const char *separator, bool skip_whitespace, const char **state) +{ + assert(out_len && separator && state); + const char *current = (state && *state ? *state : cstr); + + if (!current || !*current || !cstr || !*cstr) + return NULL; + + current += strspn(current, separator); + + if (skip_whitespace) + current += strspn(current, WHITESPACE); + + *out_len = strcspn(current, separator); + *state = current + *out_len; + + if (skip_whitespace) { + const size_t ws = strcspn(current, WHITESPACE); + *out_len -= (ws < *out_len ? *out_len - ws : 0); + } + + return current; +} + +static const char* +tokenize_quoted(const char *cstr, size_t *out_len, const char *separator, const char *quotes, const char **state) +{ + assert(out_len && separator && quotes && state); + const char *e, *current = tokenize(cstr, out_len, separator, true, state); + + if (!current) + return NULL; + + for (const char *q = quotes; *q; ++q) { + if (*current != *q) + continue; + + bool escaped = false; + for (e = ++current; *e; ++e) { + if (escaped) + escaped = false; + else if (*e == '\\') + escaped = true; + else if (*e == *q) + break; + } + + *out_len = e - current; + e = (!*e ? e : e + 1); + + if (*e) { + size_t tmp; + const char *state2 = NULL; + *state = tokenize(e, &tmp, separator, true, &state2); + } else { + *state = e; + } + + break; + } + + return current; +} + +char* +cstrcopy(const char *str, size_t size) +{ + char *cpy = calloc(1, size + 1); + return (cpy ? memcpy(cpy, str, size) : NULL); +} + +char** +tokenize_quoted_to_argv(const char *str, char *argv0, int *out_argc) +{ + if (out_argc) *out_argc = 0; + + size_t count = !!argv0; + { + size_t len; + const char *state = NULL; + while (tokenize_quoted(str, &len, " ", "\"'", &state)) + ++count; + } + + char **tokens; + if (!count || !(tokens = calloc(count + 1, sizeof(char*)))) + return NULL; + + { + tokens[0] = argv0; + size_t i = !!argv0, len; + const char *t, *state = NULL; + while (i < count && (t = tokenize_quoted(str, &len, " ", "\"'", &state))) { + if (!(tokens[i++] = cstrcopy(t, len))) + return NULL; + } + } + + if (out_argc) *out_argc = count; + return tokens; +} + +static void +version(const char *name) +{ + assert(name); + char *base = strrchr(name, '/'); + printf("%s v%s\n", (base ? base + 1 : name), bm_version()); + exit(EXIT_SUCCESS); +} + +static void +usage(FILE *out, const char *name) +{ + assert(out && name); + + char *base = strrchr(name, '/'); + fprintf(out, "usage: %s [options]\n", (base ? base + 1 : name)); + fputs("Options\n" + " -h, --help display this help and exit.\n" + " -v, --version display version.\n" + " -i, --ignorecase match items case insensitively.\n" + " -F, --filter filter entries for a given string.\n" + " -w, --wrap wraps cursor selection.\n" + " -l, --list list items vertically with the given number of lines.\n" + " -p, --prompt defines the prompt text to be displayed.\n" + " -P, --prefix text to show before highlighted item.\n" + " -I, --index select item at index automatically.\n" + " -x, --password hide input.\n" + " -s, --no-spacing disable the title spacing on entries.\n" + " -C, --no-cursor ignore cursor events.\n" + " -T, --no-touch ignore touch events.\n" + " -K, --no-keyboard ignore keyboard events.\n" + " --binding use alternative key bindings. Available options: vim\n" + " --scrollbar display scrollbar. (none (default), always, autohide)\n" + " --accept-single immediately return if there is only one item.\n" + " --ifne only display menu if there are items.\n" + " --fork always fork. (bemenu-run)\n" + " --no-exec do not execute command. (bemenu-run)\n\n" + + "Use BEMENU_BACKEND env variable to force backend:\n" + " curses ncurses based terminal backend\n" + " wayland wayland backend\n" + " x11 x11 backend\n\n" + + "If BEMENU_BACKEND is empty, one of the GUI backends is selected automatically.\n\n" + + "Backend specific options\n" + " c = ncurses, w == wayland, x == x11\n" + " (...) At end of help indicates the backend support for option.\n\n" + + " -b, --bottom appears at the bottom of the screen. (wx)\n" + " -c, --center appears at the center of the screen. (wx)\n" + " -f, --grab show the menu before reading stdin. (wx)\n" + " -n, --no-overlap adjust geometry to not overlap with panels. (w)\n" + " -m, --monitor index of monitor where menu will appear. (wx)\n" + " -H, --line-height defines the height to make each menu line (0 = default height). (wx)\n" + " -M, --margin defines the empty space on either side of the menu. (wx)\n" + " -W, --width-factor defines the relative width factor of the menu (from 0 to 1). (wx)\n" + " -B, --border defines the width of the border in pixels around the menu. (wx)\n" + " --ch defines the height of the cursor (0 = scales with line height). (wx)\n" + " --cw defines the width of the cursor. (wx)\n" + " --hp defines the horizontal padding for the entries in single line mode. (wx)\n" + " --fn defines the font to be used ('name [size]'). (wx)\n" + " --tb defines the title background color. (wx)\n" + " --tf defines the title foreground color. (wx)\n" + " --fb defines the filter background color. (wx)\n" + " --ff defines the filter foreground color. (wx)\n" + " --nb defines the normal background color. (wx)\n" + " --nf defines the normal foreground color. (wx)\n" + " --hb defines the highlighted background color. (wx)\n" + " --hf defines the highlighted foreground color. (wx)\n" + " --fbb defines the feedback background color. (wx)\n" + " --fbf defines the feedback foreground color. (wx)\n" + " --sb defines the selected background color. (wx)\n" + " --sf defines the selected foreground color. (wx)\n" + " --ab defines the alternating background color. (wx)\n" + " --af defines the alternating foreground color. (wx)\n" + " --scb defines the scrollbar background color. (wx)\n" + " --scf defines the scrollbar foreground color. (wx)\n" + " --bdr defines the border color. (wx)\n", out); + + exit((out == stderr ? EXIT_FAILURE : EXIT_SUCCESS)); +} + +static void +set_monitor(struct client *client, char *arg) +{ + char *endptr = NULL; + long num = strtol(arg, &endptr, 10); + if (arg == endptr) { // No digits found + if (!strcmp(arg, "focused")) { + client->monitor = -1; + } else if (!strcmp(arg, "all")) { + client->monitor = -2; + } else { + client->monitor_name = arg; + } + } else { + client->monitor = num; + } +} + +static void +do_getopt(struct client *client, int *argc, char **argv[]) +{ + assert(client && argc && argv); + + static const struct option opts[] = { + { "help", no_argument, 0, 'h' }, + { "version", no_argument, 0, 'v' }, + + { "ignorecase", no_argument, 0, 'i' }, + { "filter", required_argument, 0, 'F' }, + { "wrap", no_argument, 0, 'w' }, + { "list", required_argument, 0, 'l' }, + { "center", no_argument, 0, 'c' }, + { "prompt", required_argument, 0, 'p' }, + { "index", required_argument, 0, 'I' }, + { "prefix", required_argument, 0, 'P' }, + { "password", no_argument, 0, 'x' }, + { "scrollbar", required_argument, 0, 0x100 }, + { "accept-single",no_argument, 0, 0x11a }, + { "ifne", no_argument, 0, 0x117 }, + { "fork", no_argument, 0, 0x118 }, + { "no-exec", no_argument, 0, 0x119 }, + { "bottom", no_argument, 0, 'b' }, + { "grab", no_argument, 0, 'f' }, + { "no-overlap", no_argument, 0, 'n' }, + { "no-spacing", no_argument, 0, 's' }, + { "no-cursor", no_argument, 0, 'C' }, + { "no-touch", no_argument, 0, 'T' }, + { "no-keyboard", no_argument, 0, 'K' }, + { "monitor", required_argument, 0, 'm' }, + { "line-height", required_argument, 0, 'H' }, + { "margin", required_argument, 0, 'M' }, + { "width-factor", required_argument, 0, 'W' }, + { "border", required_argument, 0, 'B' }, + { "ch", required_argument, 0, 0x120 }, + { "cw", required_argument, 0, 0x125 }, + { "hp", required_argument, 0, 0x122 }, + { "fn", required_argument, 0, 0x101 }, + { "tb", required_argument, 0, 0x102 }, + { "tf", required_argument, 0, 0x103 }, + { "fb", required_argument, 0, 0x104 }, + { "ff", required_argument, 0, 0x105 }, + { "cb", required_argument, 0, 0x126 }, + { "cf", required_argument, 0, 0x127 }, + { "nb", required_argument, 0, 0x106 }, + { "nf", required_argument, 0, 0x107 }, + { "hb", required_argument, 0, 0x108 }, + { "hf", required_argument, 0, 0x109 }, + { "fbb", required_argument, 0, 0x110 }, + { "fbf", required_argument, 0, 0x111 }, + { "sb", required_argument, 0, 0x112 }, + { "sf", required_argument, 0, 0x113 }, + { "ab", required_argument, 0, 0x123 }, + { "af", required_argument, 0, 0x124 }, + { "scb", required_argument, 0, 0x114 }, + { "scf", required_argument, 0, 0x115 }, + { "bdr", required_argument, 0, 0x121 }, + { "binding", required_argument, 0, 0x128 }, + + { "disco", no_argument, 0, 0x116 }, + { 0, 0, 0, 0 } + }; + + /* TODO: getopt does not support -sf, -sb etc.. + * Either break the interface and make them --sf, --sb (like they are now), + * or parse them before running getopt.. */ + + for (optind = 0;;) { + int32_t opt; + + if ((opt = getopt_long(*argc, *argv, "hviwxcl:I:p:P:I:bfm:H:M:W:B:nsCTK", opts, NULL)) < 0) + break; + + switch (opt) { + case 'h': + usage(stdout, *argv[0]); + break; + case 'v': + version(*argv[0]); + break; + + case 'i': + client->filter_mode = BM_FILTER_MODE_DMENU_CASE_INSENSITIVE; + break; + case 'F': + client->initial_filter = optarg; + break; + case 'w': + client->wrap = true; + break; + case 'l': + client->lines = strtol(optarg, NULL, 10); + break; + case 'c': + client->center = true; + break; + case 'p': + client->title = optarg; + break; + case 'P': + client->prefix = optarg; + break; + case 'I': + client->selected = strtol(optarg, NULL, 10); + break; + case 0x100: + client->scrollbar = (!strcmp(optarg, "none") ? BM_SCROLLBAR_NONE : (!strcmp(optarg, "always") ? BM_SCROLLBAR_ALWAYS : (!strcmp(optarg, "autohide") ? BM_SCROLLBAR_AUTOHIDE : BM_SCROLLBAR_NONE))); + break; + case 0x11a: + client->accept_single = true; + break; + case 0x117: + client->ifne = true; + break; + case 0x118: + client->force_fork = true; + break; + case 0x119: + client->no_exec = true; + break; + case 'x': + client->password = true; + break; + + case 'b': + client->bottom = true; + break; + case 'f': + client->grab = true; + break; + case 'm': + set_monitor(client, optarg); + break; + case 'n': + client->no_overlap = true; + break; + case 's': + client->no_spacing = true; + break; + case 'C': + client->no_cursor = true; + break; + case 'T': + client->no_touch = true; + break; + case 'K': + client->no_keyboard = true; + break; + case 'H': + client->line_height = strtol(optarg, NULL, 10); + break; + case 'M': + client->hmargin_size = strtol(optarg, NULL, 10); + break; + case 'W': + client->width_factor = strtof(optarg, NULL); + break; + case 'B': + client->border_size = strtol(optarg, NULL, 10); + break; + case 0x120: + client->cursor_height = strtol(optarg, NULL, 10); + break; + case 0x125: + client->cursor_width = strtol(optarg, NULL, 10); + break; + case 0x122: + client->hpadding = strtol(optarg, NULL, 10); + break; + case 0x101: + client->font = optarg; + break; + case 0x102: + client->colors[BM_COLOR_TITLE_BG] = optarg; + break; + case 0x103: + client->colors[BM_COLOR_TITLE_FG] = optarg; + break; + case 0x104: + client->colors[BM_COLOR_FILTER_BG] = optarg; + break; + case 0x105: + client->colors[BM_COLOR_FILTER_FG] = optarg; + break; + case 0x126: + client->colors[BM_COLOR_CURSOR_BG] = optarg; + break; + case 0x127: + client->colors[BM_COLOR_CURSOR_FG] = optarg; + break; + case 0x106: + client->colors[BM_COLOR_ITEM_BG] = optarg; + break; + case 0x107: + client->colors[BM_COLOR_ITEM_FG] = optarg; + break; + case 0x108: + client->colors[BM_COLOR_HIGHLIGHTED_BG] = optarg; + break; + case 0x109: + client->colors[BM_COLOR_HIGHLIGHTED_FG] = optarg; + break; + case 0x110: + client->colors[BM_COLOR_FEEDBACK_BG] = optarg; + break; + case 0x111: + client->colors[BM_COLOR_FEEDBACK_FG] = optarg; + break; + case 0x112: + client->colors[BM_COLOR_SELECTED_BG] = optarg; + break; + case 0x113: + client->colors[BM_COLOR_SELECTED_FG] = optarg; + break; + case 0x123: + client->colors[BM_COLOR_ALTERNATE_BG] = optarg; + break; + case 0x124: + client->colors[BM_COLOR_ALTERNATE_FG] = optarg; + break; + case 0x114: + client->colors[BM_COLOR_SCROLLBAR_BG] = optarg; + break; + case 0x115: + client->colors[BM_COLOR_SCROLLBAR_FG] = optarg; + break; + case 0x121: + client->colors[BM_COLOR_BORDER] = optarg; + break; + case 0x128: + if(strcmp(optarg, "vim") == 0){ + client->key_binding = BM_KEY_BINDING_VIM; + } else { + client->key_binding = BM_KEY_BINDING_DEFAULT; + } + break; + + case 0x116: + disco(); + break; + + case ':': + case '?': + fputs("\n", stderr); + usage(stderr, *argv[0]); + break; + } + } + + *argc -= optind; + *argv += optind; +} + +void +parse_args(struct client *client, int *argc, char **argv[]) +{ + int num_opts; + char **opts; + const char *env; + if ((env = getenv("BEMENU_OPTS")) && (opts = tokenize_quoted_to_argv(env, (*argv)[0], &num_opts))) + do_getopt(client, &num_opts, &opts); + do_getopt(client, argc, argv); +} + +struct bm_menu* +menu_with_options(struct client *client) +{ + struct bm_menu *menu; + if (!(menu = bm_menu_new(NULL))) + return NULL; + + client->fork = (client->force_fork || (bm_renderer_get_priorty(bm_menu_get_renderer(menu)) != BM_PRIO_TERMINAL)); + + bm_menu_set_font(menu, client->font); + bm_menu_set_line_height(menu, client->line_height); + bm_menu_set_cursor_height(menu, client->cursor_height); + bm_menu_set_cursor_width(menu, client->cursor_width); + bm_menu_set_hpadding(menu, client->hpadding); + bm_menu_set_title(menu, client->title); + bm_menu_set_prefix(menu, client->prefix); + bm_menu_set_filter_mode(menu, client->filter_mode); + bm_menu_set_lines(menu, client->lines); + bm_menu_set_wrap(menu, client->wrap); + bm_menu_set_monitor(menu, client->monitor); + bm_menu_set_monitor_name(menu, client->monitor_name); + bm_menu_set_scrollbar(menu, client->scrollbar); + bm_menu_set_panel_overlap(menu, !client->no_overlap); + bm_menu_set_spacing(menu, !client->no_spacing); + bm_menu_set_password(menu, client->password); + bm_menu_set_width(menu, client->hmargin_size, client->width_factor); + bm_menu_set_border_size(menu, client->border_size); + bm_menu_set_key_binding(menu, client->key_binding); + + if (client->center) { + bm_menu_set_align(menu, BM_ALIGN_CENTER); + } else if (client->bottom) { + bm_menu_set_align(menu, BM_ALIGN_BOTTOM); + } else { + bm_menu_set_align(menu, BM_ALIGN_TOP); + } + + for (uint32_t i = 0; i < BM_COLOR_LAST; ++i) + bm_menu_set_color(menu, i, client->colors[i]); + + if (client->grab) { + bm_menu_set_filter(menu, "Loading..."); + // bm_menu_grab_keyboard(menu, true); + bm_menu_render(menu); + bm_menu_set_filter(menu, NULL); + } + + return menu; +} + +enum bm_run_result +run_menu(const struct client *client, struct bm_menu *menu, void (*item_cb)(const struct client *client, struct bm_item *item)) +{ + { + uint32_t total_item_count; + struct bm_item **items = bm_menu_get_items(menu, &total_item_count); + + if (client->ifne && total_item_count == 0) { + return BM_RUN_RESULT_CANCEL; + } + + if (client->accept_single && total_item_count == 1) { + item_cb(client, *items); + return BM_RUN_RESULT_SELECTED; + } + + } + + bm_menu_set_highlighted_index(menu, client->selected); + bm_menu_grab_keyboard(menu, true); + bm_menu_set_filter(menu, client->initial_filter); + + uint32_t unicode; + enum bm_key key = BM_KEY_NONE; + struct bm_pointer pointer; + struct bm_touch touch; + enum bm_run_result status = BM_RUN_RESULT_RUNNING; + do { + if (!bm_menu_render(menu)) { + status = BM_RUN_RESULT_CANCEL; + break; + } + if (!client->no_keyboard) { + key = bm_menu_poll_key(menu, &unicode); + } + if (!client->no_cursor) { + pointer = bm_menu_poll_pointer(menu); + } + if (!client->no_touch) { + touch = bm_menu_poll_touch(menu); + } + } while ((status = bm_menu_run_with_events(menu, key, pointer, touch, unicode)) == BM_RUN_RESULT_RUNNING); + + switch (status) { + case BM_RUN_RESULT_SELECTED: + case BM_RUN_RESULT_CUSTOM_1: + case BM_RUN_RESULT_CUSTOM_2: + case BM_RUN_RESULT_CUSTOM_3: + case BM_RUN_RESULT_CUSTOM_4: + case BM_RUN_RESULT_CUSTOM_5: + case BM_RUN_RESULT_CUSTOM_6: + case BM_RUN_RESULT_CUSTOM_7: + case BM_RUN_RESULT_CUSTOM_8: + case BM_RUN_RESULT_CUSTOM_9: + case BM_RUN_RESULT_CUSTOM_10: + { + uint32_t i, count; + struct bm_item **items = bm_menu_get_selected_items(menu, &count); + for (i = 0; i < count; ++i) item_cb(client, items[i]); + } + break; + default: break; + } + + return status; +} + +/* vim: set ts=8 sw=4 tw=0 :*/ diff --git a/.config/bemenu/client/common/common.h b/.config/bemenu/client/common/common.h new file mode 100644 index 0000000..80e5531 --- /dev/null +++ b/.config/bemenu/client/common/common.h @@ -0,0 +1,51 @@ +#ifndef _BM_COMMON_H_ +#define _BM_COMMON_H_ + +#include +#include + +struct client { + enum bm_filter_mode filter_mode; + enum bm_scrollbar_mode scrollbar; + const char *colors[BM_COLOR_LAST]; + const char *title; + const char *prefix; + const char *font; + const char *initial_filter; + uint32_t line_height; + uint32_t cursor_height; + uint32_t cursor_width; + uint32_t hpadding; + uint32_t lines; + uint32_t selected; + uint32_t monitor; + uint32_t hmargin_size; + uint32_t border_size; + float width_factor; + bool bottom; + bool center; + bool grab; + bool wrap; + bool accept_single; + bool ifne; + bool no_overlap; + bool no_spacing; + bool no_cursor; + bool no_touch; + bool no_keyboard; + bool force_fork, fork; + bool no_exec; + bool password; + enum bm_key_binding key_binding; + char *monitor_name; +}; + +char* cstrcopy(const char *str, size_t size); +char** tokenize_quoted_to_argv(const char *str, char *argv0, int *out_argc); +void parse_args(struct client *client, int *argc, char **argv[]); +struct bm_menu* menu_with_options(struct client *client); +enum bm_run_result run_menu(const struct client *client, struct bm_menu *menu, void (*item_cb)(const struct client *client, struct bm_item *item)); + +#endif /* _BM_COMMON_H_ */ + +/* vim: set ts=8 sw=4 tw=0 :*/ diff --git a/.config/bemenu/darwin.nix b/.config/bemenu/darwin.nix new file mode 100644 index 0000000..9b1f283 --- /dev/null +++ b/.config/bemenu/darwin.nix @@ -0,0 +1,38 @@ +{ pkgs ? import {} }: + +let + src = pkgs.copyPathToStore ./.; + semver = builtins.readFile "${src}/VERSION"; + revision = builtins.readFile (pkgs.runCommand "get-rev" { + nativeBuildInputs = with pkgs; [ git ]; + } "GIT_DIR=${src}/.git git rev-parse --short HEAD | tr -d '\n' > $out"); +in pkgs.stdenv.mkDerivation rec { + inherit src; + pname = "bemenu"; + version = "${semver}${revision}"; + nativeBuildInputs = with pkgs; [ pkg-config scdoc ]; + buildInputs = with pkgs; [ ncurses ]; + + postPatch = '' + substituteInPlace GNUmakefile --replace '-soname' '-install_name' + ''; + + makeFlags = ["PREFIX=$(out)"]; + buildFlags = ["PREFIX=$(out)" "clients" "curses"]; + + # https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/setup-hooks/fix-darwin-dylib-names.sh + # ^ does not handle .so files + postInstall = '' + so="$(find "$out/lib" -name "libbemenu.so.[0-9]" -print -quit)" + for f in "$out/bin/"*; do + install_name_tool -change "$(basename $so)" "$so" $f + done + ''; + + meta = with pkgs.lib; { + homepage = "https://github.com/Cloudef/bemenu"; + description = "Dynamic menu library and client program inspired by dmenu"; + license = licenses.gpl3Plus; + platforms = with platforms; darwin; + }; +} diff --git a/.config/bemenu/doxygen/Doxyfile b/.config/bemenu/doxygen/Doxyfile new file mode 100644 index 0000000..fe1f79e --- /dev/null +++ b/.config/bemenu/doxygen/Doxyfile @@ -0,0 +1,2305 @@ +# Doxyfile 1.8.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "bemenu" + +# 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 = "$(BM_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 = "Dynamic menu library and client program inspired by dmenu" + +# With the PROJECT_LOGO tag one can specify an logo or 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 + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = 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 + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# 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 = YES + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# 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. +# Note: If this tag is empty the current directory is searched. + +INPUT = "doxygen/Mainpage.dox" \ + "doxygen/../lib" \ + "doxygen/../client" + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.h *.dox + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = internal.h + +# 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. + +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. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = "doxygen/doxygen-qmi-style/header.html" + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = "doxygen/doxygen-qmi-style/footer.html" + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = "doxygen/doxygen-qmi-style/qmi.css" + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is 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 therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. 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 stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 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 NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = 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: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (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 = YES + +# 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 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /