PUD: add wireformat libraries
authorFerry Huberts <f.huberts@mindef.nl>
Tue, 16 Aug 2011 13:46:40 +0000 (15:46 +0200)
committerFerry Huberts <f.huberts@mindef.nl>
Tue, 18 Oct 2011 10:08:27 +0000 (12:08 +0200)
Signed-off-by: Ferry Huberts <ferry.huberts@pelagic.nl>
31 files changed:
lib/pud/wireformat-java/.cproject [new file with mode: 0644]
lib/pud/wireformat-java/.gitignore [new file with mode: 0644]
lib/pud/wireformat-java/.project [new file with mode: 0644]
lib/pud/wireformat-java/Makefile [new file with mode: 0644]
lib/pud/wireformat-java/Makefile.inc [new file with mode: 0644]
lib/pud/wireformat-java/doc/.gitignore [new file with mode: 0644]
lib/pud/wireformat-java/doc/Makefile [new file with mode: 0644]
lib/pud/wireformat-java/doc/doxygen.conf [new file with mode: 0644]
lib/pud/wireformat-java/resources/WireFormatConstants.java.h [new file with mode: 0644]
lib/pud/wireformat-java/resources/build.xml [new file with mode: 0644]
lib/pud/wireformat-java/src/main/c/org_olsr_plugin_pud_ClusterLeader.c [new file with mode: 0644]
lib/pud/wireformat-java/src/main/c/org_olsr_plugin_pud_PositionUpdate.c [new file with mode: 0644]
lib/pud/wireformat-java/src/main/c/org_olsr_plugin_pud_UplinkMessage.c [new file with mode: 0644]
lib/pud/wireformat-java/src/main/c/util.h [new file with mode: 0644]
lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/ClusterLeader.java [new file with mode: 0644]
lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/LibraryLoader.java [new file with mode: 0644]
lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/PositionUpdate.java [new file with mode: 0644]
lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/UplinkMessage.java [new file with mode: 0644]
lib/pud/wireformat/.cproject [new file with mode: 0644]
lib/pud/wireformat/.gitignore [new file with mode: 0644]
lib/pud/wireformat/.project [new file with mode: 0644]
lib/pud/wireformat/Makefile [new file with mode: 0644]
lib/pud/wireformat/Makefile.inc [new file with mode: 0644]
lib/pud/wireformat/doc/.gitignore [new file with mode: 0644]
lib/pud/wireformat/doc/Makefile [new file with mode: 0644]
lib/pud/wireformat/doc/doxygen.conf [new file with mode: 0644]
lib/pud/wireformat/include/OlsrdPudWireFormat/compiler.h [new file with mode: 0644]
lib/pud/wireformat/include/OlsrdPudWireFormat/nodeIdConversion.h [new file with mode: 0644]
lib/pud/wireformat/include/OlsrdPudWireFormat/wireFormat.h [new file with mode: 0644]
lib/pud/wireformat/src/nodeIdConversion.c [new file with mode: 0644]
lib/pud/wireformat/src/wireFormat.c [new file with mode: 0644]

diff --git a/lib/pud/wireformat-java/.cproject b/lib/pud/wireformat-java/.cproject
new file mode 100644 (file)
index 0000000..3e8e0d5
--- /dev/null
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<?fileVersion 4.0.0?>
+
+<cproject storage_type_id="org.eclipse.cdt.core.XmlProjectDescriptionStorage">
+       <storageModule moduleId="org.eclipse.cdt.core.settings">
+               <cconfiguration id="cdt.managedbuild.toolchain.gnu.base.1345163442">
+                       <storageModule buildSystemId="org.eclipse.cdt.managedbuilder.core.configurationDataProvider" id="cdt.managedbuild.toolchain.gnu.base.1345163442" moduleId="org.eclipse.cdt.core.settings" name="Default">
+                               <externalSettings/>
+                               <extensions>
+                                       <extension id="org.eclipse.cdt.core.ELF" point="org.eclipse.cdt.core.BinaryParser"/>
+                                       <extension id="org.eclipse.cdt.core.GmakeErrorParser" point="org.eclipse.cdt.core.ErrorParser"/>
+                                       <extension id="org.eclipse.cdt.core.CWDLocator" point="org.eclipse.cdt.core.ErrorParser"/>
+                                       <extension id="org.eclipse.cdt.core.GCCErrorParser" point="org.eclipse.cdt.core.ErrorParser"/>
+                                       <extension id="org.eclipse.cdt.core.GASErrorParser" point="org.eclipse.cdt.core.ErrorParser"/>
+                                       <extension id="org.eclipse.cdt.core.GLDErrorParser" point="org.eclipse.cdt.core.ErrorParser"/>
+                               </extensions>
+                       </storageModule>
+                       <storageModule moduleId="cdtBuildSystem" version="4.0.0">
+                               <configuration artifactName="olsrdPudWireFormatJava" buildProperties="" description="" id="cdt.managedbuild.toolchain.gnu.base.1345163442" name="Default" parent="org.eclipse.cdt.build.core.emptycfg">
+                                       <folderInfo id="cdt.managedbuild.toolchain.gnu.base.1345163442.1249471598" name="/" resourcePath="">
+                                               <toolChain id="cdt.managedbuild.toolchain.gnu.base.1159394278" name="cdt.managedbuild.toolchain.gnu.base" superClass="cdt.managedbuild.toolchain.gnu.base">
+                                                       <targetPlatform archList="all" binaryParser="org.eclipse.cdt.core.ELF" id="cdt.managedbuild.target.gnu.platform.base.1249464543" name="Debug Platform" osList="linux,hpux,aix,qnx" superClass="cdt.managedbuild.target.gnu.platform.base"/>
+                                                       <builder enableAutoBuild="false" id="cdt.managedbuild.target.gnu.builder.base.1107185273" keepEnvironmentInBuildfile="false" managedBuildOn="false" name="Gnu Make Builder" superClass="cdt.managedbuild.target.gnu.builder.base"/>
+                                                       <tool id="cdt.managedbuild.tool.gnu.archiver.base.326174000" name="GCC Archiver" superClass="cdt.managedbuild.tool.gnu.archiver.base"/>
+                                                       <tool id="cdt.managedbuild.tool.gnu.cpp.compiler.base.1217212171" name="GCC C++ Compiler" superClass="cdt.managedbuild.tool.gnu.cpp.compiler.base"/>
+                                                       <tool id="cdt.managedbuild.tool.gnu.c.compiler.base.337486796" name="GCC C Compiler" superClass="cdt.managedbuild.tool.gnu.c.compiler.base">
+                                                               <option id="gnu.c.compiler.option.include.paths.1373903940" name="Include paths (-I)" superClass="gnu.c.compiler.option.include.paths" valueType="includePath">
+                                                                       <listOptionValue builtIn="false" value="/usr/lib/jvm/java/include"/>
+                                                                       <listOptionValue builtIn="false" value="/usr/lib/jvm/java/include/linux"/>
+                                                                       <listOptionValue builtIn="false" value="&quot;${workspace_loc:/olsrdPudWireFormat/include}&quot;"/>
+                                                               </option>
+                                                               <inputType id="cdt.managedbuild.tool.gnu.c.compiler.input.666066058" superClass="cdt.managedbuild.tool.gnu.c.compiler.input"/>
+                                                       </tool>
+                                                       <tool id="cdt.managedbuild.tool.gnu.c.linker.base.961896584" name="GCC C Linker" superClass="cdt.managedbuild.tool.gnu.c.linker.base">
+                                                               <inputType id="cdt.managedbuild.tool.gnu.c.linker.input.997365984" superClass="cdt.managedbuild.tool.gnu.c.linker.input">
+                                                                       <additionalInput kind="additionalinputdependency" paths="$(USER_OBJS)"/>
+                                                                       <additionalInput kind="additionalinput" paths="$(LIBS)"/>
+                                                               </inputType>
+                                                       </tool>
+                                                       <tool id="cdt.managedbuild.tool.gnu.cpp.linker.base.208799179" name="GCC C++ Linker" superClass="cdt.managedbuild.tool.gnu.cpp.linker.base"/>
+                                                       <tool id="cdt.managedbuild.tool.gnu.assembler.base.777104547" name="GCC Assembler" superClass="cdt.managedbuild.tool.gnu.assembler.base">
+                                                               <inputType id="cdt.managedbuild.tool.gnu.assembler.input.946389676" superClass="cdt.managedbuild.tool.gnu.assembler.input"/>
+                                                       </tool>
+                                               </toolChain>
+                                       </folderInfo>
+                                       <sourceEntries>
+                                               <entry flags="VALUE_WORKSPACE_PATH" kind="sourcePath" name="src/main/java"/>
+                                               <entry flags="VALUE_WORKSPACE_PATH" kind="sourcePath" name="src/main/c"/>
+                                       </sourceEntries>
+                               </configuration>
+                       </storageModule>
+                       <storageModule moduleId="org.eclipse.cdt.core.externalSettings">
+                               <externalSettings containerId="olsrd;" factoryId="org.eclipse.cdt.core.cfg.export.settings.sipplier"/>
+                       </storageModule>
+               </cconfiguration>
+       </storageModule>
+       <storageModule moduleId="cdtBuildSystem" version="4.0.0">
+               <project id="wireformat.null.2001980068" name="wireformat"/>
+       </storageModule>
+       <storageModule moduleId="refreshScope" versionNumber="1">
+               <resource resourceType="PROJECT" workspacePath="/OlsrPudWireFormat"/>
+       </storageModule>
+       <storageModule moduleId="org.eclipse.cdt.make.core.buildtargets"/>
+       <storageModule moduleId="scannerConfiguration">
+               <autodiscovery enabled="true" problemReportingEnabled="true" selectedProfileId=""/>
+               <scannerConfigBuildInfo instanceId="cdt.managedbuild.toolchain.gnu.base.1345163442;cdt.managedbuild.toolchain.gnu.base.1345163442.1249471598;cdt.managedbuild.tool.gnu.c.compiler.base.337486796;cdt.managedbuild.tool.gnu.c.compiler.input.666066058">
+                       <autodiscovery enabled="true" problemReportingEnabled="true" selectedProfileId="org.eclipse.cdt.managedbuilder.core.GCCManagedMakePerProjectProfileC"/>
+               </scannerConfigBuildInfo>
+               <scannerConfigBuildInfo instanceId="cdt.managedbuild.toolchain.gnu.base.1345163442;cdt.managedbuild.toolchain.gnu.base.1345163442.1086566319;cdt.managedbuild.tool.gnu.c.compiler.base.1808125205;cdt.managedbuild.tool.gnu.c.compiler.input.1490340056">
+                       <autodiscovery enabled="true" problemReportingEnabled="true" selectedProfileId="org.eclipse.cdt.managedbuilder.core.GCCManagedMakePerProjectProfileC"/>
+               </scannerConfigBuildInfo>
+       </storageModule>
+</cproject>
diff --git a/lib/pud/wireformat-java/.gitignore b/lib/pud/wireformat-java/.gitignore
new file mode 100644 (file)
index 0000000..453dc61
--- /dev/null
@@ -0,0 +1,7 @@
+/build/
+/lib/
+/build.xml
+/src/main/c/org_olsr_plugin_pud_PositionUpdate.h
+/src/main/c/org_olsr_plugin_pud_ClusterLeader.h
+/src/main/c/org_olsr_plugin_pud_UplinkMessage.h
+/src/main/java/org/olsr/plugin/pud/WireFormatConstants.java
diff --git a/lib/pud/wireformat-java/.project b/lib/pud/wireformat-java/.project
new file mode 100644 (file)
index 0000000..dc80a0f
--- /dev/null
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+       <name>olsrdPudWireFormatJava</name>
+       <comment></comment>
+       <projects>
+               <project>olsrd</project>
+       </projects>
+       <buildSpec>
+               <buildCommand>
+                       <name>org.eclipse.cdt.managedbuilder.core.genmakebuilder</name>
+                       <triggers>clean,full,incremental,</triggers>
+                       <arguments>
+                               <dictionary>
+                                       <key>?name?</key>
+                                       <value></value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.append_environment</key>
+                                       <value>true</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.autoBuildTarget</key>
+                                       <value>all</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.buildArguments</key>
+                                       <value></value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.buildCommand</key>
+                                       <value>make</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.cleanBuildTarget</key>
+                                       <value>clean</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.contents</key>
+                                       <value>org.eclipse.cdt.make.core.activeConfigSettings</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.enableAutoBuild</key>
+                                       <value>false</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.enableCleanBuild</key>
+                                       <value>true</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.enableFullBuild</key>
+                                       <value>true</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.fullBuildTarget</key>
+                                       <value>all</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.stopOnError</key>
+                                       <value>true</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.useDefaultBuildCmd</key>
+                                       <value>true</value>
+                               </dictionary>
+                       </arguments>
+               </buildCommand>
+               <buildCommand>
+                       <name>org.eclipse.cdt.managedbuilder.core.ScannerConfigBuilder</name>
+                       <triggers>full,incremental,</triggers>
+                       <arguments>
+                       </arguments>
+               </buildCommand>
+       </buildSpec>
+       <natures>
+               <nature>org.eclipse.cdt.core.cnature</nature>
+               <nature>org.eclipse.cdt.managedbuilder.core.managedBuildNature</nature>
+               <nature>org.eclipse.cdt.managedbuilder.core.ScannerConfigNature</nature>
+       </natures>
+</projectDescription>
diff --git a/lib/pud/wireformat-java/Makefile b/lib/pud/wireformat-java/Makefile
new file mode 100644 (file)
index 0000000..47fd9ab
--- /dev/null
@@ -0,0 +1,256 @@
+include ../wireformat/Makefile.inc
+WIREFORMAT_PROJECT := $(PROJECT)
+
+include Makefile.inc
+
+include ../Makefile.inc
+OLSRD_PLUGIN = false
+
+TOPDIR = ../../..
+include $(TOPDIR)/Makefile.inc
+
+######################
+#
+# Settings
+#
+######################
+
+ifeq ($(DEBUG),1)
+DEBUGBOOLEAN = true
+else
+DEBUGBOOLEAN = false
+endif
+
+MACHINE=$(shell uname -m)
+ifeq ($(strip $(MACHINE)),x86_64)
+LIBDIR_INSTALL = usr/lib64
+ARCH=.$(MACHINE)
+else
+LIBDIR_INSTALL = usr/lib
+ARCH=
+endif
+
+
+RESOURCES_DIR = resources
+
+BUILD_DIR = build
+
+INC_DIR_WIREFORMAT = ../wireformat/include
+INC_DIR_WIREFORMAT_FULL = $(INC_DIR_WIREFORMAT)/$(WIREFORMAT_PROJECT)
+
+INC_DIR_JVM = /usr/lib/jvm/java-1.6.0-openjdk$(ARCH)/include
+INC_DIR_JVM_OS = $(INC_DIR_JVM)/$(OS)
+
+LIBDIR_BUILD = lib
+
+SRC_DIR_C = src/main/c
+
+INCLUDES = -I "$(INC_DIR_WIREFORMAT)" -I "$(INC_DIR_JVM)" -I "$(INC_DIR_JVM_OS)"
+LIBRARIES = -L ../wireformat/lib -l$(WIREFORMAT_PROJECT)
+
+DESTDIR ?=
+JAVA_DIR_INSTALL = usr/share/java/olsrd
+
+BUILD_DIR_JNI = $(BUILD_DIR)/jni
+
+JAVASRC = src/main/java
+JAVA_PKG = org.olsr.plugin.pud
+JAVA_PKG_DIR = $(subst .,/,$(JAVA_PKG))
+JAVA_PKG_UNDER = $(subst .,_,$(JAVA_PKG))
+
+
+ifneq ($(OS),linux)
+
+default_target install clean all:
+       @echo "*** only supported on Linux"
+
+else
+
+#
+# Targets
+#
+
+all: default_target
+
+default_target: prepare $(LIBDIR_BUILD)/$(SONAME) java
+
+$(LIBDIR_BUILD)/$(SONAME): $(BUILD_DIR)/$(JAVA_PKG_UNDER)_UplinkMessage.o \
+                           $(BUILD_DIR)/$(JAVA_PKG_UNDER)_ClusterLeader.o \
+                           $(BUILD_DIR)/$(JAVA_PKG_UNDER)_PositionUpdate.o
+       @echo "[LD] $@"
+       @$(CC) -shared -Wl,-soname=$(SONAME) $(LIBRARIES) -o "$@" \
+      $(BUILD_DIR)/$(JAVA_PKG_UNDER)_UplinkMessage.o \
+      $(BUILD_DIR)/$(JAVA_PKG_UNDER)_ClusterLeader.o \
+      $(BUILD_DIR)/$(JAVA_PKG_UNDER)_PositionUpdate.o
+
+# PositionUpdate
+$(BUILD_DIR)/$(JAVA_PKG_UNDER)_PositionUpdate.o: $(SRC_DIR_C)/$(JAVA_PKG_UNDER)_PositionUpdate.c \
+                                                 $(SRC_DIR_C)/$(JAVA_PKG_UNDER)_PositionUpdate.h \
+                                                 $(INC_DIR_WIREFORMAT_FULL)/wireFormat.h \
+                                                 $(INC_DIR_WIREFORMAT_FULL)/nodeIdConversion.h
+       @echo "[CC] $<"
+       @$(CC) $(CFLAGS) $(CPPFLAGS) $(INCLUDES) -c -o "$@" "$<"
+
+$(SRC_DIR_C)/$(JAVA_PKG_UNDER)_PositionUpdate.h: $(BUILD_DIR_JNI)/$(JAVA_PKG_DIR)/PositionUpdate.class
+       @echo "[JavaH] $<"
+       @rm -f "$@"
+       @javah -jni -classpath "$(BUILD_DIR_JNI)" -o "$@" "$(JAVA_PKG).PositionUpdate"
+
+$(BUILD_DIR_JNI)/$(JAVA_PKG_DIR)/PositionUpdate.class: $(JAVASRC)/$(JAVA_PKG_DIR)/PositionUpdate.java \
+                                                       $(JAVASRC)/$(JAVA_PKG_DIR)/LibraryLoader.java \
+                                                       $(JAVASRC)/$(JAVA_PKG_DIR)/WireFormatConstants.java
+       @echo "[JavaC] $<"
+       @javac -classpath $(JAVASRC) -source 1.6 -target 1.6 -Xlint -d "$(BUILD_DIR_JNI)" "$<"
+
+# ClusterLeader
+$(BUILD_DIR)/$(JAVA_PKG_UNDER)_ClusterLeader.o: $(SRC_DIR_C)/$(JAVA_PKG_UNDER)_ClusterLeader.c \
+                                                 $(SRC_DIR_C)/$(JAVA_PKG_UNDER)_ClusterLeader.h \
+                                                 $(INC_DIR_WIREFORMAT_FULL)/wireFormat.h \
+                                                 $(INC_DIR_WIREFORMAT_FULL)/nodeIdConversion.h
+       @echo "[CC] $<"
+       @$(CC) $(CFLAGS) $(CPPFLAGS) $(INCLUDES) -c -o "$@" "$<"
+
+$(SRC_DIR_C)/$(JAVA_PKG_UNDER)_ClusterLeader.h: $(BUILD_DIR_JNI)/$(JAVA_PKG_DIR)/ClusterLeader.class
+       @echo "[JavaH] $<"
+       @rm -f "$@"
+       @javah -jni -classpath "$(BUILD_DIR_JNI)" -o "$@" "$(JAVA_PKG).ClusterLeader"
+
+$(BUILD_DIR_JNI)/$(JAVA_PKG_DIR)/ClusterLeader.class: $(JAVASRC)/$(JAVA_PKG_DIR)/ClusterLeader.java \
+                                                      $(JAVASRC)/$(JAVA_PKG_DIR)/LibraryLoader.java \
+                                                      $(JAVASRC)/$(JAVA_PKG_DIR)/WireFormatConstants.java
+       @echo "[JavaC] $<"
+       @javac -classpath $(JAVASRC) -source 1.6 -target 1.6 -Xlint -d "$(BUILD_DIR_JNI)" "$<"
+
+# UplinkMessage
+$(BUILD_DIR)/$(JAVA_PKG_UNDER)_UplinkMessage.o: $(SRC_DIR_C)/$(JAVA_PKG_UNDER)_UplinkMessage.c \
+                                                 $(SRC_DIR_C)/$(JAVA_PKG_UNDER)_UplinkMessage.h \
+                                                 $(INC_DIR_WIREFORMAT_FULL)/wireFormat.h \
+                                                 $(INC_DIR_WIREFORMAT_FULL)/nodeIdConversion.h
+       @echo "[CC] $<"
+       @$(CC) $(CFLAGS) $(CPPFLAGS) $(INCLUDES) -c -o "$@" "$<"
+
+$(SRC_DIR_C)/$(JAVA_PKG_UNDER)_UplinkMessage.h: $(BUILD_DIR_JNI)/$(JAVA_PKG_DIR)/UplinkMessage.class
+       @echo "[JavaH] $<"
+       @rm -f "$@"
+       @javah -jni -classpath "$(BUILD_DIR_JNI)" -o "$@" "$(JAVA_PKG).UplinkMessage"
+
+$(BUILD_DIR_JNI)/$(JAVA_PKG_DIR)/UplinkMessage.class: $(JAVASRC)/$(JAVA_PKG_DIR)/UplinkMessage.java \
+                                                      $(JAVASRC)/$(JAVA_PKG_DIR)/LibraryLoader.java \
+                                                      $(JAVASRC)/$(JAVA_PKG_DIR)/WireFormatConstants.java
+       @echo "[JavaC] $<"
+       @javac -classpath $(JAVASRC) -source 1.6 -target 1.6 -Xlint -d "$(BUILD_DIR_JNI)" "$<"
+
+
+#
+# java
+#
+
+java: prepare \
+     build.xml \
+     $(JAVASRC)/$(JAVA_PKG_DIR)/PositionUpdate.java \
+     $(JAVASRC)/$(JAVA_PKG_DIR)/WireFormatConstants.java
+       @ant -f build.xml release
+
+build.xml: $(RESOURCES_DIR)/build.xml
+       @echo "[generate] $@"
+       @sed -r -e "s#PLUGIN_VER#$(PLUGIN_VER)#g" \
+               -e "s#PROJECT#$(PROJECT)#g" \
+               -e "s#BUILD_DIR#$(BUILD_DIR)#g" \
+               -e "s#LIBDIR_BUILD#$(LIBDIR_BUILD)#g" \
+               -e "s#JAVASRC#$(JAVASRC)#g" \
+               -e "s#DEBUG#$(DEBUGBOOLEAN)#g" \
+               "$<" > "$@"
+
+
+#
+# generate java classes
+#
+
+$(JAVASRC)/$(JAVA_PKG_DIR)/WireFormatConstants.java: \
+      $(RESOURCES_DIR)/WireFormatConstants.java.h \
+      $(BUILD_DIR_JNI)/c/library.h \
+      $(BUILD_DIR_JNI)/c/version.h \
+      $(BUILD_DIR_JNI)/c/wireFormat.h
+       @echo "[generate] $@"
+       @$(CPP) -I "$(BUILD_DIR_JNI)/c" "$<" | \
+         sed -r -e '/^[[:space:]]*#.*$$/ d' \
+                -e '/^[[:space:]]*$$/ d' \
+                > "$@"
+
+
+#
+# generate jni includes
+#
+
+$(BUILD_DIR_JNI)/c/library.h: Makefile.inc
+       @echo "[generate] $@"
+       @echo "#define PUD_WIRE_FORMAT_LIBRARYNAME \"$(PROJECT)\"" > "$@"
+
+$(BUILD_DIR_JNI)/c/version.h: ../scripts/makeVersionH
+       @echo "[generate] $@"
+       @"$<" "$@" "$(PLUGIN_VER)"
+
+$(BUILD_DIR_JNI)/c/wireFormat.h: $(INC_DIR_WIREFORMAT_FULL)/wireFormat.h
+       @echo "[generate] $@"
+       @grep -E '^[[:space:]]*#define[[:space:]]+' "$<" > "$@"
+
+
+#
+# Phony Targets
+#
+
+.PHONY: .gitignore prepare clean doc doc-clean install uninstall
+
+.gitignore:
+       @echo "[$@]"
+       @echo "/$(BUILD_DIR)/" > $@
+       @echo "/$(LIBDIR_BUILD)/" >> $@
+       @echo "/build.xml" >> $@
+       @echo "/$(SRC_DIR_C)/$(JAVA_PKG_UNDER)_PositionUpdate.h" >> $@
+       @echo "/$(SRC_DIR_C)/$(JAVA_PKG_UNDER)_ClusterLeader.h" >> $@
+       @echo "/$(SRC_DIR_C)/$(JAVA_PKG_UNDER)_UplinkMessage.h" >> $@
+       @echo "/$(JAVASRC)/$(JAVA_PKG_DIR)/WireFormatConstants.java" >> $@
+       @$(MAKE) -C doc $@
+
+prepare:
+       @mkdir -p "$(BUILD_DIR)" \
+                 "$(LIBDIR_BUILD)" \
+                 "$(BUILD_DIR_JNI)/c"
+
+
+clean: doc-clean
+       @echo "[$@]"
+       @rm -fr "$(BUILD_DIR)" "$(LIBDIR_BUILD)" \
+               build.xml \
+               "$(SRC_DIR_C)/$(JAVA_PKG_UNDER)_PositionUpdate.h" \
+               "$(JAVASRC)/$(JAVA_PKG_DIR)/WireFormatConstants.java"
+
+doc: build.xml
+       @$(MAKE) -C doc all
+       @ant -f build.xml javadoc
+
+doc-clean:
+       @$(MAKE) -C doc clean
+
+install: all
+       mkdir -v -p "$(DESTDIR)/$(LIBDIR_INSTALL)"
+       cp "$(LIBDIR_BUILD)/$(SONAME)" "$(DESTDIR)/$(LIBDIR_INSTALL)/$(SONAME).$(PLUGIN_VER)"
+       $(STRIP) "$(DESTDIR)/$(LIBDIR_INSTALL)/$(SONAME).$(PLUGIN_VER)"
+       ldconfig -n "$(DESTDIR)/$(LIBDIR_INSTALL)"
+       mkdir -v -p "$(DESTDIR)/$(JAVA_DIR_INSTALL)"
+       cp -t "$(DESTDIR)/$(JAVA_DIR_INSTALL)" \
+      "$(LIBDIR_BUILD)/$(PROJECT).jar" \
+      "$(LIBDIR_BUILD)/$(PROJECT)-src.zip" \
+      "$(LIBDIR_BUILD)/$(PROJECT)-doc.zip"
+
+uninstall:
+       rm -f "$(DESTDIR)/$(LIBDIR_INSTALL)/$(SONAME)" \
+             "$(DESTDIR)/$(LIBDIR_INSTALL)/$(SONAME).$(PLUGIN_VER)"
+       ldconfig -n "$(DESTDIR)/$(LIBDIR_INSTALL)"
+       rmdir -v -p --ignore-fail-on-non-empty "$(DESTDIR)/$(LIBDIR_INSTALL)"
+       rm -f "$(DESTDIR)/$(JAVA_DIR_INSTALL)/$(PROJECT).jar" \
+          "$(DESTDIR)/$(JAVA_DIR_INSTALL)/$(PROJECT)-src.zip" \
+          "$(DESTDIR)/$(JAVA_DIR_INSTALL)/$(PROJECT)-doc.zip"
+       rmdir -v -p --ignore-fail-on-non-empty "$(DESTDIR)/$(JAVA_DIR_INSTALL)"
+
+endif
diff --git a/lib/pud/wireformat-java/Makefile.inc b/lib/pud/wireformat-java/Makefile.inc
new file mode 100644 (file)
index 0000000..4ae9cee
--- /dev/null
@@ -0,0 +1,12 @@
+######################
+#
+# Highlevel configuration options for all
+#
+#
+
+PROJECT = OlsrdPudWireFormatJava
+LIBNAME = lib$(PROJECT)
+SONAME = $(LIBNAME).so
+
+# activate debugging with 1 or deactivate with 0
+DEBUG ?= 1
diff --git a/lib/pud/wireformat-java/doc/.gitignore b/lib/pud/wireformat-java/doc/.gitignore
new file mode 100644 (file)
index 0000000..aad74fa
--- /dev/null
@@ -0,0 +1,6 @@
+/javadoc/
+/html/
+/man/
+/latex/
+/doxygen.conf.temp
+/libOlsrdPudWireFormatJava.pdf
diff --git a/lib/pud/wireformat-java/doc/Makefile b/lib/pud/wireformat-java/doc/Makefile
new file mode 100644 (file)
index 0000000..14b68b5
--- /dev/null
@@ -0,0 +1,38 @@
+include ../Makefile.inc
+include ../../Makefile.inc
+
+JAVADOC_DIR = javadoc
+HTML_DIR = html
+MAN_DIR = man
+LATEX_DIR = latex
+PDF_NAME = $(LIBNAME).pdf
+DOX_FILE = doxygen.conf
+TMP_DOX_FILE = $(DOX_FILE).temp
+
+.PHONY: .gitignore all clean
+
+.gitignore:
+       @echo "[$@]"
+       @echo "/$(JAVADOC_DIR)/" > $@
+       @echo "/$(HTML_DIR)/" >> $@
+       @echo "/$(MAN_DIR)/" >> $@
+       @echo "/$(LATEX_DIR)/" >> $@
+       @echo "/$(TMP_DOX_FILE)" >> $@
+       @echo "/$(PDF_NAME)" >> $@
+
+all: clean $(DOX_FILE)
+       @echo "[$@]"
+       @sed \
+         -e "s/__PLUGIN_VER__/$(PLUGIN_VER)/" \
+         -e "s/__LIBNAME__/$(LIBNAME)/" \
+         "$(DOX_FILE)" > "$(TMP_DOX_FILE)"
+       @doxygen "$(TMP_DOX_FILE)"
+       @rm "$(TMP_DOX_FILE)"
+       @$(MAKE) -s -C $(LATEX_DIR) all > /dev/null 2>&1
+       @mv "$(LATEX_DIR)/refman.pdf" "$(PDF_NAME)"
+       @rm -fr "$(LATEX_DIR)"
+
+clean:
+       @echo "[$@]"
+       @rm -fr "$(JAVADOC_DIR)" "$(HTML_DIR)" "$(LATEX_DIR)" "$(MAN_DIR)" \
+               "$(TMP_DOX_FILE)" "$(PDF_NAME)"
diff --git a/lib/pud/wireformat-java/doc/doxygen.conf b/lib/pud/wireformat-java/doc/doxygen.conf
new file mode 100644 (file)
index 0000000..6825206
--- /dev/null
@@ -0,0 +1,1636 @@
+# Doxyfile 1.7.1
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a 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.
+
+DOXYFILE_ENCODING      = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME           = "__LIBNAME__"
+
+# 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         = "__PLUGIN_VER__"
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# 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 cause performance problems for the file system.
+
+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.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+
+OUTPUT_LANGUAGE        = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) 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.
+
+BRIEF_MEMBER_DESC      = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) 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.
+
+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" "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.
+
+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.
+
+INLINE_INHERITED_MEMB  = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then 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.
+
+FULL_PATH_NAMES        = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then 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.
+
+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 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.
+
+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
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF      = YES
+
+# 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 comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+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 behaviour.
+# 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 behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+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.
+
+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.
+
+TAB_SIZE               = 2
+
+# This tag can be used to specify a number of aliases that acts
+# 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                =
+
+# 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.
+
+OPTIMIZE_OUTPUT_FOR_C  = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA   = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+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.
+
+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, CSharp, C,
+# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. 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 that for custom extensions
+# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+
+EXTENSION_MAPPING      =
+
+# 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); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT    = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT        = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip 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.
+
+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 (the default)
+# 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.
+
+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.
+
+DISTRIBUTE_GROUP_DOC   = NO
+
+# Set the SUBGROUPING tag to YES (the default) 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.
+
+SUBGROUPING            = YES
+
+# When TYPEDEF_HIDES_STRUCT 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.
+
+TYPEDEF_HIDES_STRUCT   = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penality.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will rougly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols
+
+SYMBOL_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 and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL            = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE        = YES
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC         = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+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 (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS  = YES
+
+# 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.
+
+EXTRACT_ANON_NSPACES   = YES
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) 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.
+
+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 (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+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 (the default) these declarations will be included in the
+# documentation.
+
+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 (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+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 (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+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.
+
+CASE_SENSE_NAMES       = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES       = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES     = YES
+
+# 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.
+
+FORCE_LOCAL_INCLUDES   = NO
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO            = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) 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.
+
+SORT_MEMBER_DOCS       = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+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 default)
+# the constructors will appear in the respective orders defined by
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to 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 default)
+# the group names will appear in their defined order.
+
+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 default), 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.
+
+SORT_BY_SCOPE_NAME     = 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.
+
+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.
+
+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.
+
+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.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS       =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of 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 initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+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.
+
+SHOW_USED_FILES        = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES       = NO
+
+# 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 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 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. See the manual for examples.
+
+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. The 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.
+
+LAYOUT_FILE            =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET                  = YES
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS               = YES
+
+# If WARN_IF_UNDOCUMENTED 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.
+
+WARN_IF_UNDOCUMENTED   = YES
+
+# If WARN_IF_DOC_ERROR 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.
+
+WARN_IF_DOC_ERROR      = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC       = YES
+
+# 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)
+
+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 stderr.
+
+WARN_LOGFILE           =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be 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.
+
+INPUT                  = ../src
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. 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.
+
+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 pattern (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 *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+
+FILE_PATTERNS          = *.c *.h
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE              = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# 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.
+
+EXCLUDE                =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS       = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS       =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+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.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE      = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are 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 <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> 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.
+
+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
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS        =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES    = NO
+
+#---------------------------------------------------------------------------
+# 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 also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER         = YES
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES         = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS    = NO
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION    = YES
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# 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.
+
+REFERENCES_LINK_SOURCE = 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.
+
+USE_HTAGS              = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) 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.
+
+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.
+
+ALPHABETICAL_INDEX     = YES
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX    = 1
+
+# 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 one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX          =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+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. If left blank `html' will be used as the default path.
+
+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). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION    = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER            =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER            =
+
+# If the HTML_TIMESTAMP tag is set to YES then the generated HTML
+# documentation will contain the timesstamp.
+
+HTML_TIMESTAMP         = NO
+
+# 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 the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET        =
+
+# 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.
+# The allowed range is 0 to 359.
+
+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.
+
+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.
+
+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.
+
+HTML_TIMESTAMP         = YES
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS     = 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. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS  = NO
+
+# 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, 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.
+
+GENERATE_DOCSET        = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# 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.
+
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, 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.
+
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+
+# When GENERATE_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.
+
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
+
+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+
+DOCSET_PUBLISHER_NAME  = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP      = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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.
+
+CHM_FILE               = __LIBNAME__.chm
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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.
+
+HHC_LOCATION           =
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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).
+
+GENERATE_CHI           = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING     =
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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.
+
+BINARY_TOC             = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND             = YES
+
+# 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.
+
+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.
+
+QCH_FILE               =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#namespace
+
+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
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+
+QHP_VIRTUAL_FOLDER     = doc
+
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
+# add. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
+
+QHP_CUST_FILTER_NAME   =
+
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
+# Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS  =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
+# Qt Help Project / Filter Attributes</a>.
+
+QHP_SECT_FILTER_ATTRS  =
+
+# If the GENERATE_QHP tag is set to YES, 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.
+
+QHG_LOCATION           =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+#  will be generated, which together with the HTML files, 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.
+
+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.
+
+ECLIPSE_DOC_ID         = org.doxygen.Project
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX          = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE   = 4
+
+# 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.
+
+GENERATE_TREEVIEW      = YES
+
+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list.
+
+USE_INLINE_TREES       = NO
+
+# 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.
+
+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.
+
+EXT_LINKS_IN_WINDOW    = NO
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# 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.
+
+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 before the changes have effect.
+
+FORMULA_TRANSPARENT    = YES
+
+# 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.
+
+SEARCHENGINE           = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a PHP enabled web server instead of at the web client
+# using Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server
+# based approach is that it scales better to large projects and allows
+# full text search. The disadvances is that it is more difficult to setup
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH    = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX         = YES
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT           = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+LATEX_CMD_NAME         = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME     = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX          = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE             = a4
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES         =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER           =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS         = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX           = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE        = YES
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES     = NO
+
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include
+# source code with syntax highlighting in the LaTeX output.
+# Note that which sources are shown also depends on other settings
+# such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE      = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF           = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT             = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF            = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS         = YES
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE    =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE    =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN           = YES
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT             = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION          = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS              = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML           = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT             = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA             =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD                =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING     = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF   = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD       = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX          = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader.
+# This is useful
+# if you want to understand what is going on.
+# On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY         = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING   = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION        = YES
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF     = YES
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES        = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH           =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS  =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED             =
+PREDEFINED            += "__attribute__(x)="
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED      =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
+# the parser if not removed.
+
+SKIP_FUNCTION_MACROS   = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+#
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+#
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES               =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE       =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS           = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS        = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH              = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
+
+CLASS_DIAGRAMS         = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH            =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS   = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT               = YES
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
+# allowed to run in parallel. When set to 0 (the default) doxygen will
+# base this on the number of processors available in the system. You can set it
+# explicitly to a value larger than 0 to get control over the balance
+# between CPU load and processing speed.
+
+DOT_NUM_THREADS        = 0
+
+# By default doxygen will write a font called FreeSans.ttf to the output
+# directory and reference it in all dot files that doxygen generates. This
+# font does not include all possible unicode characters however, so when you need
+# these (or just want a differently looking font) you can specify the font name
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
+# which can be done by putting it in a standard location or by setting the
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
+# containing the font.
+
+DOT_FONTNAME           = FreeSans.ttf
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE           = 10
+
+# By default doxygen will tell dot to use the output directory to look for the
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
+# different font using DOT_FONTNAME you can set the path where dot
+# can find it using this tag.
+
+DOT_FONTPATH           =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH            = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH    = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS           = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK               = YES
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS     = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH          = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH      = YES
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH             = YES
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH           = YES
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY    = YES
+
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH        = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT       = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH               =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS           =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES    = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH    = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not
+# seem to support this out of the box. Warning: Depending on the platform used,
+# enabling this option may lead to badly anti-aliased labels on the edges of
+# a graph (i.e. they become hard to read).
+
+DOT_TRANSPARENT        = YES
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS      = YES
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND        = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP            = YES
diff --git a/lib/pud/wireformat-java/resources/WireFormatConstants.java.h b/lib/pud/wireformat-java/resources/WireFormatConstants.java.h
new file mode 100644 (file)
index 0000000..66d0594
--- /dev/null
@@ -0,0 +1,57 @@
+#include "library.h"
+#include "version.h"
+#include "wireFormat.h"
+#ifndef GIT_SHA
+  #define GIT_SHA ""
+#endif
+
+package org.olsr.plugin.pud;
+
+public class WireFormatConstants {
+       public static final String LibraryName = PUD_WIRE_FORMAT_LIBRARYNAME;
+
+       public static final String PLUGINVERSION = PLUGIN_VER;
+       public static final String GITSHA = GIT_SHA;
+
+       public static final int VERSION = PUD_WIRE_FORMAT_VERSION;
+
+       public static final int FLAGS_ID = PUD_FLAGS_ID;
+
+       public static final int TIME_BITS = PUD_TIME_BITS;
+
+       public static final int LATITUDE_BITS = PUD_LATITUDE_BITS;
+       public static final int TX_LATITUDE_DIGITS = PUD_TX_LATITUDE_DIGITS;
+       public static final String TX_LATITUDE_DECIMALS = PUD_TX_LATITUDE_DECIMALS;
+
+       public static final int LONGITUDE_BITS = PUD_LONGITUDE_BITS;
+       public static final int TX_LONGITUDE_DIGITS = PUD_TX_LONGITUDE_DIGITS;
+       public static final String TX_LONGITUDE_DECIMALS = PUD_TX_LONGITUDE_DECIMALS;
+       public static final int ALTITUDE_BITS = PUD_ALTITUDE_BITS;
+
+       public static final long ALTITUDE_MIN = PUD_ALTITUDE_MIN;
+       public static final long ALTITUDE_MAX = PUD_ALTITUDE_MAX;
+       public static final int TX_ALTITUDE_DIGITS = PUD_TX_ALTITUDE_DIGITS;
+
+       public static final int SPEED_BITS = PUD_SPEED_BITS;
+       public static final long SPEED_MAX = PUD_SPEED_MAX;
+       public static final int TX_SPEED_DIGITS = PUD_TX_SPEED_DIGITS;
+
+       public static final int TRACK_BITS = PUD_TRACK_BITS;
+       public static final int TX_TRACK_DIGITS = PUD_TX_TRACK_DIGITS;
+
+       public static final int HDOP_BITS = PUD_HDOP_BITS;
+       public static final double HDOP_RESOLUTION = PUD_HDOP_RESOLUTION;
+       public static final double HDOP_MAX = PUD_HDOP_MAX;
+       public static final int TX_HDOP_DIGITS = PUD_TX_HDOP_DIGITS;
+       public static final String TX_HDOP_DECIMALS = PUD_TX_HDOP_DECIMALS;
+
+       public static final int NODEIDTYPE_MAC_BYTES = PUD_NODEIDTYPE_MAC_BYTES;
+       public static final int NODEIDTYPE_MSISDN_BYTES = PUD_NODEIDTYPE_MSISDN_BYTES;
+       public static final int NODEIDTYPE_TETRA_BYTES = PUD_NODEIDTYPE_TETRA_BYTES;
+       public static final int NODEIDTYPE_192_BYTES = PUD_NODEIDTYPE_192_BYTES;
+       public static final int NODEIDTYPE_193_BYTES = PUD_NODEIDTYPE_193_BYTES;
+       public static final int NODEIDTYPE_194_BYTES = PUD_NODEIDTYPE_194_BYTES;
+       public static final int NODEIDTYPE_IPV4_BYTES = PUD_NODEIDTYPE_IPV4_BYTES;
+       public static final int NODEIDTYPE_IPV6_BYTES = PUD_NODEIDTYPE_IPV6_BYTES;
+       public static final int TX_NODEIDTYPE_DIGITS = PUD_TX_NODEIDTYPE_DIGITS;
+}
diff --git a/lib/pud/wireformat-java/resources/build.xml b/lib/pud/wireformat-java/resources/build.xml
new file mode 100644 (file)
index 0000000..d00e2b8
--- /dev/null
@@ -0,0 +1,95 @@
+<?xml version="1.0" standalone="yes" ?>
+<project name="PROJECT" basedir="." default="build">
+       <description>
+               Build file for distribution of Olsrd Pud Plugin Wireformat Library Java Bindings
+    </description>
+
+
+       <!-- Properties -->
+       <property name="fullname" value="Olsrd Pud Plugin Wireformat Library Java Bindings" />
+
+       <property name="name" value="PROJECT" />
+       <property name="version" value="PLUGIN_VER" />
+
+       <property name="debug" value="DEBUG" />
+       <property name="debug.flags" value="lines,vars,source" />
+       <property name="source.version" value="1.6" />
+       <property name="target.version" value="1.6" />
+
+       <property name="build.dir" location="${basedir}/BUILD_DIR/classes" />
+       <property name="src.dir" location="${basedir}/JAVASRC" />
+       <property name="lib.dir" location="${basedir}/LIBDIR_BUILD" />
+
+       <property name="jar.file" value="${lib.dir}/${name}.jar" />
+
+       <property name="javadoc.dir" location="${basedir}/doc/javadoc" />
+
+       <!--
+
+        Targets
+
+       -->
+
+       <target name="getgitcommit" description="Retrieve the Git Commit SHA1">
+               <exec dir="${basedir}" executable="git" outputproperty="git.commit.sha" failonerror="false" error="/dev/null">
+                       <arg value="rev-parse" />
+                       <arg value="HEAD" />
+               </exec>
+       </target>
+
+       <target name="init" description="initialisation build environment for ${name}">
+               <mkdir dir="${build.dir}" />
+       </target>
+
+       <target name="clean" description="clean build environment">
+               <delete dir="${build.dir}" />
+               <delete dir="${javadoc.dir}" />
+       </target>
+
+       <target name="build" description="Build plugin jar file" depends="clean,init,getgitcommit">
+               <echo message="Compiling Plugin classes. (debug: ${debug})" />
+               <javac srcdir="${src.dir}" destdir="${build.dir}" source="${source.version}" target="${target.version}" debug="${debug}" debuglevel="${debug.flags}" includeantruntime="false" />
+
+               <delete file="${jar.file}" />
+               <jar destfile="${jar.file}">
+                       <fileset dir="${build.dir}">
+                               <include name="**/*.class" />
+                       </fileset>
+                       <manifest>
+                               <attribute name="Class-Path" value="." />
+                               <attribute name="Version" value="${version}" />
+                               <attribute name="Git-SHA1" value="${git.commit.sha}" />
+                       </manifest>
+               </jar>
+       </target>
+
+       <target name="src-zip" depends="init">
+               <!-- make the zip file -->
+               <zip zipfile="${lib.dir}/${name}-src.zip">
+                       <zipfileset dir="${src.dir}" />
+               </zip>
+       </target>
+
+       <target name="release" description="Build plugin jar file" depends="clean, init, build, src-zip, javadoc-zip">
+       </target>
+
+       <!-- Generate JavaDoc -->
+       <target name="javadoc">
+               <delete dir="${javadoc.dir}" />
+               <mkdir dir="${javadoc.dir}" />
+               <javadoc destdir="${javadoc.dir}" windowtitle="${fullname}" use="yes" linksource="yes" splitindex="yes" access="private" author="true" nodeprecated="false" nodeprecatedlist="false" noindex="false" nonavbar="false" notree="false" version="true" source="${source.version}" sourcepath="${src.dir}" maxmemory="256M">
+                       <packageset dir="${src.dir}" defaultexcludes="yes">
+                               <include name="org/olsr/**" />
+                       </packageset>
+               </javadoc>
+       </target>
+
+       <!-- Create zip file containing the API HTML pages. -->
+       <target name="javadoc-zip" depends="init,javadoc">
+               <!-- make the zip file -->
+               <zip zipfile="${lib.dir}/${name}-doc.zip">
+                       <zipfileset dir="${javadoc.dir}" />
+               </zip>
+       </target>
+
+</project>
diff --git a/lib/pud/wireformat-java/src/main/c/org_olsr_plugin_pud_ClusterLeader.c b/lib/pud/wireformat-java/src/main/c/org_olsr_plugin_pud_ClusterLeader.c
new file mode 100644 (file)
index 0000000..c3ebe73
--- /dev/null
@@ -0,0 +1,98 @@
+#include "org_olsr_plugin_pud_ClusterLeader.h"
+#include "util.h"
+
+/*
+ * Class:     org_olsr_plugin_pud_ClusterLeader
+ * Method:    getClusterLeaderVersion
+ * Signature: ()I
+ */
+JNIEXPORT jint JNICALL Java_org_olsr_plugin_pud_ClusterLeader_getClusterLeaderVersion
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       uint8_t version = getClusterLeaderVersion(
+                       getClusterLeaderMessage(uplinkMessage));
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jint) version;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_ClusterLeader
+ * Method:    getClusterLeaderValidityTime
+ * Signature: ()J
+ */
+JNIEXPORT jlong JNICALL Java_org_olsr_plugin_pud_ClusterLeader_getClusterLeaderValidityTime
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       unsigned long validityTime = getValidityTime(
+                       &getClusterLeaderMessage(uplinkMessage)->validityTime);
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jlong) validityTime;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_ClusterLeader
+ * Method:    getClusterLeaderOriginator
+ * Signature: ()Ljava/net/InetAddress;
+ */
+JNIEXPORT jobject JNICALL Java_org_olsr_plugin_pud_ClusterLeader_getClusterLeaderOriginator
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       jobject object;
+       bool ipv4 = !getUplinkMessageIPv6(&uplinkMessage->header);
+
+       union olsr_ip_addr * addr;
+       if (ipv4) {
+               addr = (union olsr_ip_addr *) &uplinkMessage->msg.clusterLeader.leader.v4.originator;
+       } else {
+               addr = (union olsr_ip_addr *) &uplinkMessage->msg.clusterLeader.leader.v6.originator;
+       }
+       constructIPAddress(env, ipv4, addr, &object);
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return object;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_ClusterLeader
+ * Method:    getClusterLeaderClusterLeader
+ * Signature: ()Ljava/net/InetAddress;
+ */
+JNIEXPORT jobject JNICALL Java_org_olsr_plugin_pud_ClusterLeader_getClusterLeaderClusterLeader
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       jobject object;
+       bool ipv4 = !getUplinkMessageIPv6(&uplinkMessage->header);
+
+       union olsr_ip_addr * addr;
+       if (ipv4) {
+               addr = (union olsr_ip_addr *) &uplinkMessage->msg.clusterLeader.leader.v4.clusterLeader;
+       } else {
+               addr = (union olsr_ip_addr *) &uplinkMessage->msg.clusterLeader.leader.v6.clusterLeader;
+       }
+       constructIPAddress(env, ipv4, addr, &object);
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return object;
+}
diff --git a/lib/pud/wireformat-java/src/main/c/org_olsr_plugin_pud_PositionUpdate.c b/lib/pud/wireformat-java/src/main/c/org_olsr_plugin_pud_PositionUpdate.c
new file mode 100644 (file)
index 0000000..10c5776
--- /dev/null
@@ -0,0 +1,313 @@
+#include "org_olsr_plugin_pud_PositionUpdate.h"
+#include "util.h"
+
+#include <OlsrdPudWireFormat/wireFormat.h>
+#include <OlsrdPudWireFormat/nodeIdConversion.h>
+
+#include <stdio.h>
+#include <stddef.h>
+#include <string.h>
+#include <arpa/inet.h>
+
+/*
+ * OLSR header
+ */
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getOlsrMessageOriginator
+ * Signature: ()Ljava/net/InetAddress;
+ */
+JNIEXPORT jobject JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getOlsrMessageOriginator
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       jobject object;
+       bool ipv4 = !getUplinkMessageIPv6(&uplinkMessage->header);
+
+       union olsr_ip_addr * addr;
+       if (ipv4) {
+               addr = (union olsr_ip_addr *) &uplinkMessage->msg.olsrMessage.v4.originator;
+       } else {
+               addr = (union olsr_ip_addr *) &uplinkMessage->msg.olsrMessage.v6.originator;
+       }
+       constructIPAddress(env, ipv4, addr, &object);
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return object;
+}
+
+/*
+ * PudOlsrPositionUpdate
+ */
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateVersion
+ * Signature: ()I
+ */
+JNIEXPORT jint JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateVersion
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       uint8_t version = getPositionUpdateVersion(
+                       getPositionUpdateMessage(uplinkMessage));
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jint) version;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateValidityTime
+ * Signature: ()J
+ */
+JNIEXPORT jlong JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateValidityTime
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       unsigned long validityTime = getValidityTime(
+                       &getPositionUpdateMessage(uplinkMessage)->validityTime);
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jlong) validityTime;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateSMask
+ * Signature: ()I
+ */
+JNIEXPORT jint JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateSMask
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       uint8_t smask = getPositionUpdateSmask(
+                       getPositionUpdateMessage(uplinkMessage));
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jint) smask;
+}
+
+/*
+ * GpsInfo
+ */
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateTime
+ * Signature: (J)Ljava/util/Date;
+ */
+JNIEXPORT jobject JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateTime
+  (JNIEnv * env, jobject this, jlong baseDate) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       jlong baseDateSeconds = baseDate / 1000;
+       jlong baseDateMilliSeconds = baseDate % 1000;
+       struct tm timeStruct;
+       time_t updateTimeSeconds;
+       jlong updateTimeMilliSeconds;
+       jclass clazz;
+       jmethodID mid;
+
+       getPositionUpdateTime(getPositionUpdateMessage(uplinkMessage),
+                       baseDateSeconds, &timeStruct);
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       updateTimeSeconds = mktime(&timeStruct);
+       updateTimeMilliSeconds = (updateTimeSeconds * 1000) + baseDateMilliSeconds;
+
+       /* object = new Date(updateTimeMilliSeconds); */
+       clazz = (*env)->FindClass(env, "java/util/Date");
+       mid = (*env)->GetMethodID(env, clazz, "<init>", "(J)V");
+       return (*env)->NewObject(env, clazz, mid, updateTimeMilliSeconds);
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateLatitude
+ * Signature: ()D
+ */
+JNIEXPORT jdouble JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateLatitude
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       double lat = getPositionUpdateLatitude(
+                       getPositionUpdateMessage(uplinkMessage));
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jdouble) lat;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateLongitude
+ * Signature: ()D
+ */
+JNIEXPORT jdouble JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateLongitude
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       double lon = getPositionUpdateLongitude(
+                       getPositionUpdateMessage(uplinkMessage));
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jdouble) lon;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateAltitude
+ * Signature: ()J
+ */
+JNIEXPORT jlong JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateAltitude
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       long alt = getPositionUpdateAltitude(
+                       getPositionUpdateMessage(uplinkMessage));
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jlong) alt;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateSpeed
+ * Signature: ()J
+ */
+JNIEXPORT jlong JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateSpeed
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       unsigned long speed = getPositionUpdateSpeed(
+                       getPositionUpdateMessage(uplinkMessage));
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jlong) speed;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateTrack
+ * Signature: ()J
+ */
+JNIEXPORT jlong JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateTrack
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       unsigned long track = getPositionUpdateTrack(
+                       getPositionUpdateMessage(uplinkMessage));
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jlong) track;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateHdop
+ * Signature: ()D
+ */
+JNIEXPORT jdouble JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateHdop
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       double hdop = getPositionUpdateHdop(getPositionUpdateMessage(uplinkMessage));
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jdouble) hdop;
+}
+
+/*
+ * NodeInfo
+ */
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateNodeIdType
+ * Signature: ()I
+ */
+JNIEXPORT jint JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateNodeIdType
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+       NodeIdType nodeIdType = getPositionUpdateNodeIdType(
+                       !getUplinkMessageIPv6(&uplinkMessage->header) ? AF_INET : AF_INET6,
+                       getPositionUpdateMessage(uplinkMessage));
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (jint) nodeIdType;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_PositionUpdate
+ * Method:    getPositionUpdateNodeId
+ * Signature: ()Ljava/lang/String;
+ */
+JNIEXPORT jstring JNICALL Java_org_olsr_plugin_pud_PositionUpdate_getPositionUpdateNodeId
+  (JNIEnv * env, jobject this) {
+       jobject dataObject;
+       jboolean isCopy;
+       UplinkMessage * uplinkMessage = getUplinkMessage(env, this, &dataObject,
+                       &isCopy);
+
+    const char * nodeIdStr;
+    char nodeIdStrBuffer[PUD_TX_NODEID_BUFFERSIZE + 1];
+
+       getNodeIdStringFromOlsr (
+                       !getUplinkMessageIPv6(&uplinkMessage->header) ? AF_INET : AF_INET6,
+                       &uplinkMessage->msg.olsrMessage, &nodeIdStr,
+                       &nodeIdStrBuffer[0], sizeof(nodeIdStrBuffer));
+
+       releaseUplinkMessage(env, uplinkMessage, dataObject, isCopy, JNI_ABORT);
+
+       return (*env)->NewStringUTF(env, nodeIdStr);
+}
diff --git a/lib/pud/wireformat-java/src/main/c/org_olsr_plugin_pud_UplinkMessage.c b/lib/pud/wireformat-java/src/main/c/org_olsr_plugin_pud_UplinkMessage.c
new file mode 100644 (file)
index 0000000..13f5480
--- /dev/null
@@ -0,0 +1,36 @@
+#include "org_olsr_plugin_pud_UplinkMessage.h"
+#include <OlsrdPudWireFormat/wireFormat.h>
+
+/*
+ * Uplink Message Types
+ */
+
+/*
+ * Class:     org_olsr_plugin_pud_UplinkMessage
+ * Method:    getUplinkMessageTypePosition
+ * Signature: ()I
+ */
+JNIEXPORT jint JNICALL Java_org_olsr_plugin_pud_UplinkMessage_getUplinkMessageTypePosition
+  (JNIEnv * env __attribute__ ((unused)), jclass this __attribute__ ((unused))) {
+       return (jint) POSITION;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_UplinkMessage
+ * Method:    getUplinkMessageTypeClusterLeader
+ * Signature: ()I
+ */
+JNIEXPORT jint JNICALL Java_org_olsr_plugin_pud_UplinkMessage_getUplinkMessageTypeClusterLeader
+  (JNIEnv * env __attribute__ ((unused)), jclass this __attribute__ ((unused))) {
+       return (jint) CLUSTERLEADER;
+}
+
+/*
+ * Class:     org_olsr_plugin_pud_UplinkMessage
+ * Method:    getUplinkMessageHeaderLength
+ * Signature: ()I
+ */
+JNIEXPORT jint JNICALL Java_org_olsr_plugin_pud_UplinkMessage_getUplinkMessageHeaderLength
+  (JNIEnv * env __attribute__ ((unused)), jclass this __attribute__ ((unused))) {
+       return (jint)sizeof(UplinkHeader);
+}
diff --git a/lib/pud/wireformat-java/src/main/c/util.h b/lib/pud/wireformat-java/src/main/c/util.h
new file mode 100644 (file)
index 0000000..a7ed695
--- /dev/null
@@ -0,0 +1,100 @@
+#ifndef _Included_org_olsr_plugin_pud_UplinkMessage
+#define _Included_org_olsr_plugin_pud_UplinkMessage
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <jni.h>
+#include <OlsrdPudWireFormat/wireFormat.h>
+//#include <OlsrdPudWireFormat/nodeIdConversion.h>
+
+//#include <stdio.h>
+//#include <stddef.h>
+//#include <string.h>
+//#include <arpa/inet.h>
+
+/*
+ * Helpers
+ */
+
+/* get the uplink message (a byte array) from the java object */
+static inline UplinkMessage * getUplinkMessage(JNIEnv * env, jobject this,
+               jobject * dataObject, jboolean * isCopy) {
+       UplinkMessage * uplinkMessage;
+
+       jclass clazz = (*env)->GetObjectClass(env, this);
+       jfieldID fid = (*env)->GetFieldID(env, clazz, "data", "[B");
+       *dataObject = (*env)->GetObjectField(env, this, fid);
+       uplinkMessage = (UplinkMessage *) ((*env)->GetByteArrayElements(env,
+                       *dataObject, isCopy));
+
+       return uplinkMessage;
+}
+
+/* release (when it is a copy) the uplink message (a byte array) that was
+ * retrieved from the java object
+ *
+ * mode = 0 (copy back + free)
+ *        JNI_COMMIT (copy back + do not free)
+ *        JNI_ABORT (do not copy back + free) */
+static inline void releaseUplinkMessage(JNIEnv * env,
+               UplinkMessage * uplinkMessage, jobject dataObject, jboolean isCopy,
+               jint mode) {
+       if (isCopy == JNI_TRUE) {
+               (*env)->ReleaseByteArrayElements(env, dataObject,
+                               (jbyte *) uplinkMessage, mode);
+       }
+}
+
+static inline PudOlsrPositionUpdate * getPositionUpdateMessage(
+               UplinkMessage * uplinkMessage) {
+       return getOlsrMessagePayload(
+                       !getUplinkMessageIPv6(&uplinkMessage->header) ? AF_INET : AF_INET6,
+                       &uplinkMessage->msg.olsrMessage);
+}
+
+static inline UplinkClusterLeader * getClusterLeaderMessage(
+               UplinkMessage * uplinkMessage) {
+       return &uplinkMessage->msg.clusterLeader;
+}
+
+static inline void constructIPAddress(JNIEnv * env, bool ipv4,
+               union olsr_ip_addr * addr, jobject * object) {
+       if (ipv4) {
+               /* object = new Inet4Address(NULL, originator); */
+               jclass clazz = (*env)->FindClass(env, "java/net/Inet4Address");
+               jmethodID mid = (*env)->GetMethodID(env, clazz, "<init>",
+                               "(Ljava/lang/String;I)V");
+               *object = (*env)->NewObject(env, clazz, mid, NULL, ntohl(addr->v4.s_addr));
+       } else {
+               jboolean isCopy;
+               jfieldID fid;
+               jobject ipaddressObject;
+               jbyte * ipaddressByteArray;
+
+               /* object = new Inet6Address(); */
+               jclass clazz = (*env)->FindClass(env, "java/net/Inet6Address");
+               jmethodID mid = (*env)->GetMethodID(env, clazz, "<init>", "()V");
+               *object = (*env)->NewObject(env, clazz, mid);
+
+               /* ipaddressByteArray = &object->ipaddress[0] (might be a copy) */
+               fid = (*env)->GetFieldID(env, clazz, "ipaddress", "[B");
+               ipaddressObject = (*env)->GetObjectField(env, *object, fid);
+               ipaddressByteArray = ((*env)->GetByteArrayElements(env, ipaddressObject,
+                               &isCopy));
+
+               /* copy the IP address into the byte array */
+               memcpy(ipaddressByteArray, &addr->v6, sizeof(struct in6_addr));
+
+               /* commit when needed */
+               if (isCopy == JNI_TRUE) {
+                       (*env)->ReleaseByteArrayElements(env, ipaddressObject,
+                                       ipaddressByteArray, 0);
+               }
+       }
+}
+
+#ifdef __cplusplus
+}
+#endif
+#endif
diff --git a/lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/ClusterLeader.java b/lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/ClusterLeader.java
new file mode 100644 (file)
index 0000000..bce7bb7
--- /dev/null
@@ -0,0 +1,53 @@
+package org.olsr.plugin.pud;
+
+import java.net.InetAddress;
+
+/**
+ * This class represents an uplink message, type cluster leader.
+ */
+public class ClusterLeader extends UplinkMessage {
+       /**
+        * Default constructor
+        */
+       public ClusterLeader() {
+               super();
+       }
+
+       /**
+        * Constructor
+        * 
+        * @param data
+        *            the received message
+        * @param dataSize
+        *            the number of bytes in the received message
+        */
+       public ClusterLeader(byte[] data, int dataSize) {
+               super(data, dataSize);
+       }
+
+       /*
+        * UplinkClusterLeader
+        */
+
+       /**
+        * @return the version of the cluster leader message
+        */
+       public native int getClusterLeaderVersion();
+
+       /**
+        * @return the validity time (in seconds) the cluster leader message
+        */
+       public native long getClusterLeaderValidityTime();
+
+       /**
+        * @return the (OLSR main) IP address of the OLSR node that sent the cluster
+        *         leader message
+        */
+       public native InetAddress getClusterLeaderOriginator();
+
+       /**
+        * @return the (OLSR main) IP address of the OLSR node that is the cluster
+        *         leader for the OLSR node that sent the cluster leader message
+        */
+       public native InetAddress getClusterLeaderClusterLeader();
+}
diff --git a/lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/LibraryLoader.java b/lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/LibraryLoader.java
new file mode 100644 (file)
index 0000000..ddeb587
--- /dev/null
@@ -0,0 +1,17 @@
+package org.olsr.plugin.pud;
+
+public class LibraryLoader {
+       static private boolean loaded = false;
+
+       /* Load uplink message handling library */
+       static void load() {
+               if (!loaded) {
+                       try {
+                               System.loadLibrary(WireFormatConstants.LibraryName);
+                               loaded = true;
+                       } catch (Throwable e) {
+                               throw new ExceptionInInitializerError(e);
+                       }
+               }
+       }
+}
diff --git a/lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/PositionUpdate.java b/lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/PositionUpdate.java
new file mode 100644 (file)
index 0000000..38fbf13
--- /dev/null
@@ -0,0 +1,113 @@
+package org.olsr.plugin.pud;
+
+import java.net.InetAddress;
+import java.util.Date;
+
+/**
+ * This class represents an uplink message, type position update.
+ */
+public class PositionUpdate extends UplinkMessage {
+       /**
+        * Default constructor
+        */
+       public PositionUpdate() {
+               super();
+       }
+
+       /**
+        * Constructor
+        * 
+        * @param data
+        *            the received message
+        * @param dataSize
+        *            the number of bytes in the received message
+        */
+       public PositionUpdate(byte[] data, int dataSize) {
+               super(data, dataSize);
+       }
+
+       /*
+        * OLSR header
+        */
+
+       /**
+        * @return the (OLSR main) IP address of the OLSR node that sent the uplink
+        *         message
+        */
+       public native InetAddress getOlsrMessageOriginator();
+
+       /*
+        * PudOlsrPositionUpdate
+        */
+
+       /**
+        * @return the version of the position update message
+        */
+       public native int getPositionUpdateVersion();
+
+       /**
+        * @return the validity time (in seconds) the position update message
+        */
+       public native long getPositionUpdateValidityTime();
+
+       /**
+        * @return the content mask the position update message
+        */
+       public native int getPositionUpdateSMask();
+
+       /*
+        * GpsInfo
+        */
+
+       /**
+        * @param baseDate
+        *            the base date relative to which the time of the position
+        *            update message must be determined (milliseconds since Epoch)
+        * @return the time of the position update message
+        */
+       public native Date getPositionUpdateTime(long baseDate);
+
+       /**
+        * @return the latitude (in degrees) of the position update message
+        */
+       public native double getPositionUpdateLatitude();
+
+       /**
+        * @return the longitude (in degrees) of the position update message
+        */
+       public native double getPositionUpdateLongitude();
+
+       /**
+        * @return the altitude (in meters) of the position update message
+        */
+       public native long getPositionUpdateAltitude();
+
+       /**
+        * @return the speed (in kph) of the the position update message
+        */
+       public native long getPositionUpdateSpeed();
+
+       /**
+        * @return the track angle (in degrees) of the position update message
+        */
+       public native long getPositionUpdateTrack();
+
+       /**
+        * @return the HDOP of the position update message
+        */
+       public native double getPositionUpdateHdop();
+
+       /*
+        * NodeInfo
+        */
+
+       /**
+        * @return the nodeIdType of the position update message
+        */
+       public native int getPositionUpdateNodeIdType();
+
+       /**
+        * @return the nodeId of the position update message
+        */
+       public native String getPositionUpdateNodeId();
+}
diff --git a/lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/UplinkMessage.java b/lib/pud/wireformat-java/src/main/java/org/olsr/plugin/pud/UplinkMessage.java
new file mode 100644 (file)
index 0000000..ae61ceb
--- /dev/null
@@ -0,0 +1,144 @@
+package org.olsr.plugin.pud;
+
+/**
+ * This class represents an uplink message.
+ * 
+ * It stores the received uplink message in a byte array and provides access
+ * methods for all uplink header fields.
+ */
+public abstract class UplinkMessage {
+       static {
+               LibraryLoader.load();
+       }
+
+       /*
+        * Uplink Message Store
+        */
+
+       /** the uplink message */
+       protected byte[] data = null;
+
+       /** the number of bytes in the received message */
+       protected int dataSize = 0;
+
+       /**
+        * Default constructor
+        */
+       public UplinkMessage() {
+               super();
+       }
+
+       /**
+        * Constructor
+        * 
+        * @param data
+        *            the received message
+        * @param dataSize
+        *            the number of bytes in the received message
+        */
+       public UplinkMessage(byte[] data, int dataSize) {
+               super();
+               this.data = data;
+               this.dataSize = dataSize;
+       }
+
+       /*
+        * Getters
+        */
+
+       /**
+        * @return the received message
+        */
+       public final byte[] getData() {
+               return data;
+       }
+
+       /**
+        * @return the number of bytes in the received message
+        */
+       public final int getDataSize() {
+               return dataSize;
+       }
+
+       /*
+        * Uplink Message Types
+        */
+
+       /**
+        * @return the uplink message type for a position update
+        */
+       public static native int getUplinkMessageTypePosition();
+
+       /**
+        * @return the uplink message type for a cluster leader message
+        */
+       public static native int getUplinkMessageTypeClusterLeader();
+
+       /*
+        * UplinkHeader
+        */
+
+       /**
+        * @return the length of the uplink message header
+        */
+       public static native int getUplinkMessageHeaderLength();
+
+       /**
+        * @param data
+        *            the uplink message
+        * @param offset
+        *            the offset in the data where the uplink message begins
+        *
+        * @return the uplink message type
+        */
+       public static int getUplinkMessageType(byte[] data, int offset) {
+               return data[offset];
+       }
+
+       /**
+        * @param data
+        *            the uplink message
+        * @param offset
+        *            the offset in the data where the uplink message begins
+        *
+        * @return the number of bytes in the payload of the uplink message
+        */
+       public static int getUplinkMessageLength(byte[] data, int offset) {
+               return ((data[offset + 1] << 8) | data[offset + 2]);
+       }
+
+       /**
+        * @param data
+        *            the uplink message
+        * @param offset
+        *            the offset in the data where the uplink message begins
+        *
+        * @return true when the contained message is an IPv6 message, false
+        *         otherwise (IPv4)
+        */
+       public static boolean isUplinkMessageIPv6(byte[] data, int offset) {
+               return ((data[offset + 3] & 0x01) != 0);
+       }
+
+       /**
+        * @return the uplink message type
+        */
+       public int getUplinkMessageType() {
+               return UplinkMessage.getUplinkMessageType(data, 0);
+       }
+
+       /**
+        * @return the number of bytes in the payload of the uplink message
+        */
+       public int getUplinkMessageLength() {
+               return UplinkMessage.getUplinkMessageLength(data, 0);
+       }
+
+       /**
+        * @return true when the contained message is an IPv6 message, false
+        *         otherwise (IPv4)
+        */
+       public boolean isUplinkMessageIPv6() {
+               return UplinkMessage.isUplinkMessageIPv6(data, 0);
+       }
+}
diff --git a/lib/pud/wireformat/.cproject b/lib/pud/wireformat/.cproject
new file mode 100644 (file)
index 0000000..e8c6470
--- /dev/null
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<?fileVersion 4.0.0?>
+
+<cproject storage_type_id="org.eclipse.cdt.core.XmlProjectDescriptionStorage">
+       <storageModule moduleId="org.eclipse.cdt.core.settings">
+               <cconfiguration id="cdt.managedbuild.toolchain.gnu.base.1345163442">
+                       <storageModule buildSystemId="org.eclipse.cdt.managedbuilder.core.configurationDataProvider" id="cdt.managedbuild.toolchain.gnu.base.1345163442" moduleId="org.eclipse.cdt.core.settings" name="Default">
+                               <externalSettings/>
+                               <extensions>
+                                       <extension id="org.eclipse.cdt.core.ELF" point="org.eclipse.cdt.core.BinaryParser"/>
+                                       <extension id="org.eclipse.cdt.core.GmakeErrorParser" point="org.eclipse.cdt.core.ErrorParser"/>
+                                       <extension id="org.eclipse.cdt.core.CWDLocator" point="org.eclipse.cdt.core.ErrorParser"/>
+                                       <extension id="org.eclipse.cdt.core.GCCErrorParser" point="org.eclipse.cdt.core.ErrorParser"/>
+                                       <extension id="org.eclipse.cdt.core.GASErrorParser" point="org.eclipse.cdt.core.ErrorParser"/>
+                                       <extension id="org.eclipse.cdt.core.GLDErrorParser" point="org.eclipse.cdt.core.ErrorParser"/>
+                               </extensions>
+                       </storageModule>
+                       <storageModule moduleId="cdtBuildSystem" version="4.0.0">
+                               <configuration artifactName="olsrdPudWireFormat" buildProperties="" description="" id="cdt.managedbuild.toolchain.gnu.base.1345163442" name="Default" parent="org.eclipse.cdt.build.core.emptycfg">
+                                       <folderInfo id="cdt.managedbuild.toolchain.gnu.base.1345163442.1249471598" name="/" resourcePath="">
+                                               <toolChain id="cdt.managedbuild.toolchain.gnu.base.1159394278" name="cdt.managedbuild.toolchain.gnu.base" superClass="cdt.managedbuild.toolchain.gnu.base">
+                                                       <targetPlatform archList="all" binaryParser="org.eclipse.cdt.core.ELF" id="cdt.managedbuild.target.gnu.platform.base.1249464543" name="Debug Platform" osList="linux,hpux,aix,qnx" superClass="cdt.managedbuild.target.gnu.platform.base"/>
+                                                       <builder enableAutoBuild="false" id="cdt.managedbuild.target.gnu.builder.base.1107185273" keepEnvironmentInBuildfile="false" managedBuildOn="false" name="Gnu Make Builder" superClass="cdt.managedbuild.target.gnu.builder.base"/>
+                                                       <tool id="cdt.managedbuild.tool.gnu.archiver.base.326174000" name="GCC Archiver" superClass="cdt.managedbuild.tool.gnu.archiver.base"/>
+                                                       <tool id="cdt.managedbuild.tool.gnu.cpp.compiler.base.1217212171" name="GCC C++ Compiler" superClass="cdt.managedbuild.tool.gnu.cpp.compiler.base"/>
+                                                       <tool id="cdt.managedbuild.tool.gnu.c.compiler.base.337486796" name="GCC C Compiler" superClass="cdt.managedbuild.tool.gnu.c.compiler.base">
+                                                               <option id="gnu.c.compiler.option.include.paths.1373903940" name="Include paths (-I)" superClass="gnu.c.compiler.option.include.paths" valueType="includePath">
+                                                                       <listOptionValue builtIn="false" value="&quot;${workspace_loc:/olsrdPudWireFormat/include}&quot;"/>
+                                                                       <listOptionValue builtIn="false" value="&quot;${workspace_loc:/olsrd/src}&quot;"/>
+                                                               </option>
+                                                               <inputType id="cdt.managedbuild.tool.gnu.c.compiler.input.666066058" superClass="cdt.managedbuild.tool.gnu.c.compiler.input"/>
+                                                       </tool>
+                                                       <tool id="cdt.managedbuild.tool.gnu.c.linker.base.961896584" name="GCC C Linker" superClass="cdt.managedbuild.tool.gnu.c.linker.base">
+                                                               <inputType id="cdt.managedbuild.tool.gnu.c.linker.input.997365984" superClass="cdt.managedbuild.tool.gnu.c.linker.input">
+                                                                       <additionalInput kind="additionalinputdependency" paths="$(USER_OBJS)"/>
+                                                                       <additionalInput kind="additionalinput" paths="$(LIBS)"/>
+                                                               </inputType>
+                                                       </tool>
+                                                       <tool id="cdt.managedbuild.tool.gnu.cpp.linker.base.208799179" name="GCC C++ Linker" superClass="cdt.managedbuild.tool.gnu.cpp.linker.base"/>
+                                                       <tool id="cdt.managedbuild.tool.gnu.assembler.base.777104547" name="GCC Assembler" superClass="cdt.managedbuild.tool.gnu.assembler.base">
+                                                               <inputType id="cdt.managedbuild.tool.gnu.assembler.input.946389676" superClass="cdt.managedbuild.tool.gnu.assembler.input"/>
+                                                       </tool>
+                                               </toolChain>
+                                       </folderInfo>
+                               </configuration>
+                       </storageModule>
+                       <storageModule moduleId="org.eclipse.cdt.core.externalSettings">
+                               <externalSettings containerId="olsrd;" factoryId="org.eclipse.cdt.core.cfg.export.settings.sipplier"/>
+                       </storageModule>
+               </cconfiguration>
+       </storageModule>
+       <storageModule moduleId="cdtBuildSystem" version="4.0.0">
+               <project id="wireformat.null.2001980068" name="wireformat"/>
+       </storageModule>
+       <storageModule moduleId="refreshScope" versionNumber="1">
+               <resource resourceType="PROJECT" workspacePath="/OlsrPudWireFormat"/>
+       </storageModule>
+       <storageModule moduleId="scannerConfiguration">
+               <autodiscovery enabled="true" problemReportingEnabled="true" selectedProfileId=""/>
+               <scannerConfigBuildInfo instanceId="cdt.managedbuild.toolchain.gnu.base.1345163442;cdt.managedbuild.toolchain.gnu.base.1345163442.1249471598;cdt.managedbuild.tool.gnu.c.compiler.base.337486796;cdt.managedbuild.tool.gnu.c.compiler.input.666066058">
+                       <autodiscovery enabled="true" problemReportingEnabled="true" selectedProfileId="org.eclipse.cdt.managedbuilder.core.GCCManagedMakePerProjectProfileC"/>
+               </scannerConfigBuildInfo>
+       </storageModule>
+       <storageModule moduleId="org.eclipse.cdt.make.core.buildtargets"/>
+</cproject>
diff --git a/lib/pud/wireformat/.gitignore b/lib/pud/wireformat/.gitignore
new file mode 100644 (file)
index 0000000..8e0bc29
--- /dev/null
@@ -0,0 +1,2 @@
+/build/
+/lib/
diff --git a/lib/pud/wireformat/.project b/lib/pud/wireformat/.project
new file mode 100644 (file)
index 0000000..5548ebf
--- /dev/null
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+       <name>olsrdPudWireFormat</name>
+       <comment></comment>
+       <projects>
+               <project>olsrd</project>
+       </projects>
+       <buildSpec>
+               <buildCommand>
+                       <name>org.eclipse.cdt.managedbuilder.core.genmakebuilder</name>
+                       <triggers>clean,full,incremental,</triggers>
+                       <arguments>
+                               <dictionary>
+                                       <key>?name?</key>
+                                       <value></value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.append_environment</key>
+                                       <value>true</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.autoBuildTarget</key>
+                                       <value>all</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.buildArguments</key>
+                                       <value></value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.buildCommand</key>
+                                       <value>make</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.cleanBuildTarget</key>
+                                       <value>clean</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.contents</key>
+                                       <value>org.eclipse.cdt.make.core.activeConfigSettings</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.enableAutoBuild</key>
+                                       <value>false</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.enableCleanBuild</key>
+                                       <value>true</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.enableFullBuild</key>
+                                       <value>true</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.fullBuildTarget</key>
+                                       <value>all</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.stopOnError</key>
+                                       <value>true</value>
+                               </dictionary>
+                               <dictionary>
+                                       <key>org.eclipse.cdt.make.core.useDefaultBuildCmd</key>
+                                       <value>true</value>
+                               </dictionary>
+                       </arguments>
+               </buildCommand>
+               <buildCommand>
+                       <name>org.eclipse.cdt.managedbuilder.core.ScannerConfigBuilder</name>
+                       <triggers>full,incremental,</triggers>
+                       <arguments>
+                       </arguments>
+               </buildCommand>
+       </buildSpec>
+       <natures>
+               <nature>org.eclipse.cdt.core.cnature</nature>
+               <nature>org.eclipse.cdt.managedbuilder.core.managedBuildNature</nature>
+               <nature>org.eclipse.cdt.managedbuilder.core.ScannerConfigNature</nature>
+       </natures>
+</projectDescription>
diff --git a/lib/pud/wireformat/Makefile b/lib/pud/wireformat/Makefile
new file mode 100644 (file)
index 0000000..3cbdc7a
--- /dev/null
@@ -0,0 +1,109 @@
+include Makefile.inc
+
+include ../Makefile.inc
+OLSRD_PLUGIN = false
+
+TOPDIR = ../../..
+include $(TOPDIR)/Makefile.inc
+
+######################
+#
+# Settings
+#
+######################
+
+MACHINE=$(shell uname -m)
+ifeq ($(strip $(MACHINE)),x86_64)
+LIBDIR_INSTALL = usr/lib64
+else
+LIBDIR_INSTALL = usr/lib
+endif
+
+
+BUILD_DIR = build
+
+INC_DIR_BASE_C = include
+INC_DIR_C = $(INC_DIR_BASE_C)/$(PROJECT)
+INC_DIR_OLSRD = ../../../src
+
+LIBDIR_BUILD = lib
+
+MODULES = nodeIdConversion wireFormat
+
+SRC_DIR_C = src
+OBJECTS_C = $(MODULES:%=$(BUILD_DIR)/%.o)
+
+INCLUDES = -I "$(INC_DIR_BASE_C)" -I "$(INC_DIR_OLSRD)"
+LIBRARIES = -lm
+
+DESTDIR ?=
+INC_DIR_INSTALL = usr/$(INC_DIR_C)
+
+
+ifneq ($(OS),linux)
+
+default_target install clean all:
+       @echo "*** only supported on Linux"
+
+else
+
+#
+# Targets
+#
+
+all: default_target
+
+default_target: prepare $(LIBDIR_BUILD)/$(SONAME)
+
+$(LIBDIR_BUILD)/$(SONAME): $(OBJECTS_C)
+       @echo "[LD] $@"
+       @$(CC) -shared -Wl,-soname=$(SONAME) $(LIBRARIES) -o "$@" $(OBJECTS_C)
+
+$(BUILD_DIR)/%.o: $(SRC_DIR_C)/%.c $(INC_DIR_C)/compiler.h
+       @echo "[CC] $<"
+       @$(CC) $(CFLAGS) $(CPPFLAGS) $(INCLUDES) -c -o "$@" "$<"
+
+
+#
+# Phony Targets
+#
+
+.PHONY: .gitignore prepare clean doc doc-clean install uninstall java-clean java-doc java-install java-uninstall
+
+.gitignore:
+       @echo "[$@]"
+       @echo "/$(BUILD_DIR)/" > $@
+       @echo "/$(LIBDIR_BUILD)/" >> $@
+       @$(MAKE) -C doc $@
+
+prepare:
+       @mkdir -p "$(BUILD_DIR)" "$(LIBDIR_BUILD)"
+
+clean: doc-clean
+       @echo "[$@]"
+       @rm -fr "$(BUILD_DIR)" "$(LIBDIR_BUILD)" "$(SRC_DIR_C)/"*.d
+
+doc:
+       @$(MAKE) -C doc all
+
+doc-clean:
+       @$(MAKE) -C doc clean
+
+install: all
+       rm -fr "$(DESTDIR)/$(INC_DIR_INSTALL)"
+       mkdir -v -p "$(DESTDIR)/$(LIBDIR_INSTALL)" "$(DESTDIR)/$(INC_DIR_INSTALL)"
+       cp "$(LIBDIR_BUILD)/$(SONAME)" "$(DESTDIR)/$(LIBDIR_INSTALL)/$(SONAME).$(PLUGIN_VER)"
+       $(STRIP) "$(DESTDIR)/$(LIBDIR_INSTALL)/$(SONAME).$(PLUGIN_VER)"
+       ldconfig -n "$(DESTDIR)/$(LIBDIR_INSTALL)"
+       cp -t "$(DESTDIR)/$(INC_DIR_INSTALL)" $(INC_DIR_C)/*.h
+
+uninstall:
+       rm -fr "$(DESTDIR)/$(INC_DIR_INSTALL)/"*.h
+       rm -f "$(DESTDIR)/$(LIBDIR_INSTALL)/$(SONAME)" \
+             "$(DESTDIR)/$(LIBDIR_INSTALL)/$(SONAME).$(PLUGIN_VER)"
+       ldconfig -n "$(DESTDIR)/$(LIBDIR_INSTALL)"
+       rmdir -v -p --ignore-fail-on-non-empty \
+         "$(DESTDIR)/$(LIBDIR_INSTALL)" \
+         "$(DESTDIR)/$(INC_DIR_INSTALL)"
+
+endif
diff --git a/lib/pud/wireformat/Makefile.inc b/lib/pud/wireformat/Makefile.inc
new file mode 100644 (file)
index 0000000..1d2b429
--- /dev/null
@@ -0,0 +1,12 @@
+######################
+#
+# Highlevel configuration options for all
+#
+#
+
+PROJECT = OlsrdPudWireFormat
+LIBNAME = lib$(PROJECT)
+SONAME = $(LIBNAME).so
+
+# activate debugging with 1 or deactivate with 0
+DEBUG ?= 1
diff --git a/lib/pud/wireformat/doc/.gitignore b/lib/pud/wireformat/doc/.gitignore
new file mode 100644 (file)
index 0000000..723e259
--- /dev/null
@@ -0,0 +1,5 @@
+/html/
+/man/
+/latex/
+/doxygen.conf.temp
+/libOlsrdPudWireFormat.pdf
diff --git a/lib/pud/wireformat/doc/Makefile b/lib/pud/wireformat/doc/Makefile
new file mode 100644 (file)
index 0000000..50adf6c
--- /dev/null
@@ -0,0 +1,35 @@
+include ../Makefile.inc
+include ../../Makefile.inc
+
+HTML_DIR = html
+MAN_DIR = man
+LATEX_DIR = latex
+PDF_NAME = $(LIBNAME).pdf
+DOX_FILE = doxygen.conf
+TMP_DOX_FILE = $(DOX_FILE).temp
+
+.PHONY: .gitignore all clean
+
+.gitignore:
+       @echo "[$@]"
+       @echo "/$(HTML_DIR)/" > $@
+       @echo "/$(MAN_DIR)/" >> $@
+       @echo "/$(LATEX_DIR)/" >> $@
+       @echo "/$(TMP_DOX_FILE)" >> $@
+       @echo "/$(PDF_NAME)" >> $@
+
+all: clean $(DOX_FILE)
+       @echo "[$@]"
+       @sed \
+         -e "s/__PLUGIN_VER__/$(PLUGIN_VER)/" \
+         -e "s/__LIBNAME__/$(LIBNAME)/" \
+         "$(DOX_FILE)" > "$(TMP_DOX_FILE)"
+       @doxygen "$(TMP_DOX_FILE)"
+       @rm "$(TMP_DOX_FILE)"
+       @$(MAKE) -s -C $(LATEX_DIR) all > /dev/null 2>&1
+       @mv "$(LATEX_DIR)/refman.pdf" "$(PDF_NAME)"
+       @rm -fr "$(LATEX_DIR)"
+
+clean:
+       @echo "[$@]"
+       @rm -fr "$(HTML_DIR)" "$(LATEX_DIR)" "$(MAN_DIR)" "$(TMP_DOX_FILE)" "$(PDF_NAME)"
diff --git a/lib/pud/wireformat/doc/doxygen.conf b/lib/pud/wireformat/doc/doxygen.conf
new file mode 100644 (file)
index 0000000..f3ecc07
--- /dev/null
@@ -0,0 +1,1636 @@
+# Doxyfile 1.7.1
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a 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.
+
+DOXYFILE_ENCODING      = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME           = "__LIBNAME__"
+
+# 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         = "__PLUGIN_VER__"
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# 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 cause performance problems for the file system.
+
+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.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+
+OUTPUT_LANGUAGE        = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) 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.
+
+BRIEF_MEMBER_DESC      = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) 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.
+
+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" "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.
+
+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.
+
+INLINE_INHERITED_MEMB  = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then 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.
+
+FULL_PATH_NAMES        = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then 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.
+
+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 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.
+
+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
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF      = YES
+
+# 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 comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+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 behaviour.
+# 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 behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+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.
+
+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.
+
+TAB_SIZE               = 2
+
+# This tag can be used to specify a number of aliases that acts
+# 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                =
+
+# 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.
+
+OPTIMIZE_OUTPUT_FOR_C  = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA   = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+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.
+
+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, CSharp, C,
+# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. 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 that for custom extensions
+# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+
+EXTENSION_MAPPING      =
+
+# 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); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT    = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT        = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip 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.
+
+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 (the default)
+# 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.
+
+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.
+
+DISTRIBUTE_GROUP_DOC   = NO
+
+# Set the SUBGROUPING tag to YES (the default) 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.
+
+SUBGROUPING            = YES
+
+# When TYPEDEF_HIDES_STRUCT 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.
+
+TYPEDEF_HIDES_STRUCT   = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penality.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will rougly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols
+
+SYMBOL_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 and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL            = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE        = YES
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC         = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+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 (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS  = YES
+
+# 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.
+
+EXTRACT_ANON_NSPACES   = YES
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) 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.
+
+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 (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+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 (the default) these declarations will be included in the
+# documentation.
+
+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 (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+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 (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+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.
+
+CASE_SENSE_NAMES       = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES       = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES     = YES
+
+# 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.
+
+FORCE_LOCAL_INCLUDES   = NO
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO            = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) 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.
+
+SORT_MEMBER_DOCS       = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+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 default)
+# the constructors will appear in the respective orders defined by
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to 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 default)
+# the group names will appear in their defined order.
+
+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 default), 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.
+
+SORT_BY_SCOPE_NAME     = 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.
+
+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.
+
+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.
+
+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.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS       =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of 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 initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+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.
+
+SHOW_USED_FILES        = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES       = NO
+
+# 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 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 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. See the manual for examples.
+
+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. The 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.
+
+LAYOUT_FILE            =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET                  = YES
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS               = YES
+
+# If WARN_IF_UNDOCUMENTED 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.
+
+WARN_IF_UNDOCUMENTED   = YES
+
+# If WARN_IF_DOC_ERROR 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.
+
+WARN_IF_DOC_ERROR      = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC       = YES
+
+# 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)
+
+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 stderr.
+
+WARN_LOGFILE           =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be 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.
+
+INPUT                  = ../src
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. 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.
+
+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 pattern (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 *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+
+FILE_PATTERNS          = *.c *.h
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE              = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# 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.
+
+EXCLUDE                =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS       = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS       =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+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.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE      = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are 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 <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> 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.
+
+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
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS        =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES    = NO
+
+#---------------------------------------------------------------------------
+# 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 also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER         = YES
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES         = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS    = NO
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION    = YES
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# 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.
+
+REFERENCES_LINK_SOURCE = 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.
+
+USE_HTAGS              = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) 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.
+
+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.
+
+ALPHABETICAL_INDEX     = YES
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX    = 2
+
+# 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 one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX          =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+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. If left blank `html' will be used as the default path.
+
+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). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION    = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER            =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER            =
+
+# If the HTML_TIMESTAMP tag is set to YES then the generated HTML
+# documentation will contain the timesstamp.
+
+HTML_TIMESTAMP         = NO
+
+# 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 the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET        =
+
+# 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.
+# The allowed range is 0 to 359.
+
+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.
+
+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.
+
+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.
+
+HTML_TIMESTAMP         = YES
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS     = 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. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS  = NO
+
+# 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, 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.
+
+GENERATE_DOCSET        = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# 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.
+
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, 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.
+
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+
+# When GENERATE_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.
+
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
+
+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+
+DOCSET_PUBLISHER_NAME  = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP      = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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.
+
+CHM_FILE               = __LIBNAME__.chm
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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.
+
+HHC_LOCATION           =
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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).
+
+GENERATE_CHI           = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING     =
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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.
+
+BINARY_TOC             = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND             = YES
+
+# 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.
+
+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.
+
+QCH_FILE               =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#namespace
+
+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
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+
+QHP_VIRTUAL_FOLDER     = doc
+
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
+# add. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
+
+QHP_CUST_FILTER_NAME   =
+
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
+# Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS  =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
+# Qt Help Project / Filter Attributes</a>.
+
+QHP_SECT_FILTER_ATTRS  =
+
+# If the GENERATE_QHP tag is set to YES, 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.
+
+QHG_LOCATION           =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+#  will be generated, which together with the HTML files, 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.
+
+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.
+
+ECLIPSE_DOC_ID         = org.doxygen.Project
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX          = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE   = 4
+
+# 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.
+
+GENERATE_TREEVIEW      = YES
+
+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list.
+
+USE_INLINE_TREES       = NO
+
+# 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.
+
+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.
+
+EXT_LINKS_IN_WINDOW    = NO
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# 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.
+
+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 before the changes have effect.
+
+FORMULA_TRANSPARENT    = YES
+
+# 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.
+
+SEARCHENGINE           = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a PHP enabled web server instead of at the web client
+# using Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server
+# based approach is that it scales better to large projects and allows
+# full text search. The disadvances is that it is more difficult to setup
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH    = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX         = YES
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT           = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+LATEX_CMD_NAME         = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME     = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX          = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE             = a4
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES         =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER           =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS         = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX           = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE        = YES
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES     = NO
+
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include
+# source code with syntax highlighting in the LaTeX output.
+# Note that which sources are shown also depends on other settings
+# such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE      = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF           = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT             = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF            = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS         = YES
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE    =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE    =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN           = YES
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT             = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION          = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS              = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML           = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT             = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA             =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD                =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING     = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF   = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD       = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX          = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader.
+# This is useful
+# if you want to understand what is going on.
+# On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY         = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING   = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION        = YES
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF     = YES
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES        = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH           =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS  =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED             =
+PREDEFINED            += "__attribute__(x)="
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED      =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
+# the parser if not removed.
+
+SKIP_FUNCTION_MACROS   = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+#
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+#
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES               =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE       =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS           = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS        = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH              = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
+
+CLASS_DIAGRAMS         = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH            =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS   = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT               = YES
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
+# allowed to run in parallel. When set to 0 (the default) doxygen will
+# base this on the number of processors available in the system. You can set it
+# explicitly to a value larger than 0 to get control over the balance
+# between CPU load and processing speed.
+
+DOT_NUM_THREADS        = 0
+
+# By default doxygen will write a font called FreeSans.ttf to the output
+# directory and reference it in all dot files that doxygen generates. This
+# font does not include all possible unicode characters however, so when you need
+# these (or just want a differently looking font) you can specify the font name
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
+# which can be done by putting it in a standard location or by setting the
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
+# containing the font.
+
+DOT_FONTNAME           = FreeSans.ttf
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE           = 10
+
+# By default doxygen will tell dot to use the output directory to look for the
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
+# different font using DOT_FONTNAME you can set the path where dot
+# can find it using this tag.
+
+DOT_FONTPATH           =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH            = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH    = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS           = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK               = YES
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS     = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH          = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH      = YES
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH             = YES
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH           = YES
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY    = YES
+
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH        = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT       = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH               =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS           =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES    = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH    = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not
+# seem to support this out of the box. Warning: Depending on the platform used,
+# enabling this option may lead to badly anti-aliased labels on the edges of
+# a graph (i.e. they become hard to read).
+
+DOT_TRANSPARENT        = YES
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS      = YES
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND        = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP            = YES
diff --git a/lib/pud/wireformat/include/OlsrdPudWireFormat/compiler.h b/lib/pud/wireformat/include/OlsrdPudWireFormat/compiler.h
new file mode 100644 (file)
index 0000000..1b426be
--- /dev/null
@@ -0,0 +1,22 @@
+#ifndef _PUD_COMPILER_H_
+#define _PUD_COMPILER_H_
+
+/** Compiler hint to expect x */
+#ifndef likely
+# if defined(__GNUC__)
+#  define likely(x)                                    __builtin_expect((x),1)
+# else
+#  define likely(x)                                            (x)
+# endif
+#endif
+
+/** Compiler hint to not expect x */
+#ifndef unlikely
+# if defined(__GNUC__)
+#  define unlikely(x)                                  __builtin_expect((x),0)
+# else
+#  define unlikely(x)                                  (x)
+# endif
+#endif
+
+#endif /* _PUD_COMPILER_H_ */
diff --git a/lib/pud/wireformat/include/OlsrdPudWireFormat/nodeIdConversion.h b/lib/pud/wireformat/include/OlsrdPudWireFormat/nodeIdConversion.h
new file mode 100644 (file)
index 0000000..dac8a38
--- /dev/null
@@ -0,0 +1,17 @@
+#ifndef _PUD_NODEIDCONVERSION_H_
+#define _PUD_NODEIDCONVERSION_H_
+
+#include "olsr_protocol.h"
+
+#include <OlsrdPudWireFormat/wireFormat.h>
+#include <stddef.h>
+
+void getNodeTypeStringFromOlsr(int ipVersion,
+               PudOlsrPositionUpdate * olsrGpsMessage, char * nodeIdTypeBuffer,
+               int nodeIdTypeBufferSize);
+
+void getNodeIdStringFromOlsr(int ipVersion, union olsr_message *olsrMessage,
+               const char **nodeIdStr, char *nodeIdStrBuffer,
+               unsigned int nodeIdStrBufferSize);
+
+#endif /* _PUD_NODEIDCONVERSION_H_ */
diff --git a/lib/pud/wireformat/include/OlsrdPudWireFormat/wireFormat.h b/lib/pud/wireformat/include/OlsrdPudWireFormat/wireFormat.h
new file mode 100644 (file)
index 0000000..783b2a5
--- /dev/null
@@ -0,0 +1,913 @@
+#ifndef _PUD_WIREFORMAT_H_
+#define _PUD_WIREFORMAT_H_
+
+#include "olsr_protocol.h"
+
+#include <OlsrdPudWireFormat/compiler.h>
+#include <stdint.h>
+#include <stdbool.h>
+#include <time.h>
+#include <math.h>
+#include <sys/socket.h>
+#include <assert.h>
+
+/*
+ * Version
+ */
+
+/** The version of the wire format */
+#define PUD_WIRE_FORMAT_VERSION                0
+
+/*
+ * Flags
+ * We use the smask of nmeaINFO and the flags below on top of that
+ */
+
+/** Flags that the GPS information contains the nodeId */
+#define PUD_FLAGS_ID                           0x80
+
+/*
+ * Time
+ */
+
+/** The number of bits for the time field */
+#define PUD_TIME_BITS                          17
+
+/*
+ * Latitude
+ */
+
+/** The number of bits for the latitude field */
+#define PUD_LATITUDE_BITS                      28
+
+/** The maximum size of the string representation of the latitude
+ * sign [0,90] [0,59] dot [0,59] [0,999] */
+#define PUD_TX_LATITUDE_DIGITS         (1 + 2 + 2 + 1 + 2 + 3)
+
+/** The number of decimals of the latitude in the transmit sentence */
+#define PUD_TX_LATITUDE_DECIMALS       "5"
+
+/*
+ * Longitude
+ */
+
+/** The number of bits for the longitude field */
+#define PUD_LONGITUDE_BITS                     27
+
+/** The maximum size of the string representation of the longitude
+ * sign [0,180] [0,59] dot [0,59] [0,999] */
+#define PUD_TX_LONGITUDE_DIGITS                (1 + 3 + 2 + 1 + 2 + 3)
+
+/** The number of decimals of the longitude in the transmit sentence */
+#define PUD_TX_LONGITUDE_DECIMALS      "5"
+
+/*
+ * Altitude
+ */
+
+/** The number of bits for the altitude field */
+#define PUD_ALTITUDE_BITS                      16
+
+/** The minimum altitude */
+#define PUD_ALTITUDE_MIN                       (-400)
+
+/** The maximum altitude */
+#define PUD_ALTITUDE_MAX       (((1 << PUD_ALTITUDE_BITS) - 1) + PUD_ALTITUDE_MIN)
+
+/** The maximum size of the string representation of the altitude */
+#define PUD_TX_ALTITUDE_DIGITS         6
+
+/*
+ * Speed
+ */
+
+/** The number of bits for the speed field */
+#define PUD_SPEED_BITS                         12
+
+/** The maximum speed value */
+#define PUD_SPEED_MAX                          ((1 << PUD_SPEED_BITS) - 1)
+
+/** The maximum size of the string representation of the speed */
+#define PUD_TX_SPEED_DIGITS                    4
+
+/*
+ * Track
+ */
+
+/** The number of bits for the track angle field */
+#define PUD_TRACK_BITS                         9
+
+/** The maximum size of the string representation of the track angle */
+#define PUD_TX_TRACK_DIGITS                    3
+
+/*
+ * HDOP
+ */
+
+/** The number of bits for the HDOP field */
+#define PUD_HDOP_BITS                          11
+
+/** The HDOP resolution (in m) */
+#define PUD_HDOP_RESOLUTION                    (0.1)
+
+/** The maximum HDOP value (in m) */
+#define PUD_HDOP_MAX           (((1 << PUD_HDOP_BITS) - 1) * PUD_HDOP_RESOLUTION)
+
+/** The maximum size of the string representation of the HDOP */
+#define PUD_TX_HDOP_DIGITS                     5
+
+/** The number of decimals of the HDOP in the transmit sentence */
+#define PUD_TX_HDOP_DECIMALS           "3"
+
+/*
+ * Node ID Type
+ */
+
+/** nodeIdType legal values */
+typedef enum _NodeIdType {
+       /** MAC address, 48 bits, 6 bytes */
+       PUD_NODEIDTYPE_MAC = 0,
+
+       /** MSISDN number, 15 digits, 50 bits, 7 bytes */
+       PUD_NODEIDTYPE_MSISDN = 1,
+
+       /** TETRA number, 17 digits, 57 bits, 8 bytes */
+       PUD_NODEIDTYPE_TETRA = 2,
+
+       /** DNS name, variable length */
+       PUD_NODEIDTYPE_DNS = 3,
+
+       /** IPv4 address, 32 bits, 4 bytes */
+       PUD_NODEIDTYPE_IPV4 = 4,
+
+       /** IPv6 address, 128 bits, 16 bytes */
+       PUD_NODEIDTYPE_IPV6 = 6,
+
+       /** Brandweer number, 7 digits, 24 bits, 3 bytes */
+       PUD_NODEIDTYPE_192 = 192,
+
+       /** Ambulance number, 6 digits, 20 bits, 3 bytes */
+       PUD_NODEIDTYPE_193 = 193,
+
+       /** Number in the range [1, 8191], 4 digits, 13 bits, 2 bytes */
+       PUD_NODEIDTYPE_194 = 194
+} NodeIdType;
+
+/** the number of nodeId bytes for PUD_NODEIDTYPE_MAC (IFHWADDRLEN) */
+#define PUD_NODEIDTYPE_MAC_BYTES               6
+
+/** the number of nodeId bytes for PUD_NODEIDTYPE_MSISDN */
+#define PUD_NODEIDTYPE_MSISDN_BYTES            7
+
+/** the number of nodeId bytes for PUD_NODEIDTYPE_TETRA */
+#define PUD_NODEIDTYPE_TETRA_BYTES             8
+
+/** the number of nodeId bytes for PUD_NODEIDTYPE_192 */
+#define PUD_NODEIDTYPE_192_BYTES               3
+
+/** the number of nodeId bytes for PUD_NODEIDTYPE_193 */
+#define PUD_NODEIDTYPE_193_BYTES               3
+
+/** the number of nodeId bytes for PUD_NODEIDTYPE_194 */
+#define PUD_NODEIDTYPE_194_BYTES               2
+
+/** the number of nodeId bytes for PUD_NODEIDTYPE_IPV4 (sizeof(struct in_addr)) */
+#define PUD_NODEIDTYPE_IPV4_BYTES              4
+
+/** the number of nodeId bytes for PUD_NODEIDTYPE_IPV6 (sizeof(struct in6_addr)) */
+#define PUD_NODEIDTYPE_IPV6_BYTES              16
+
+/** The maximum size of the string representation of the nodeIdType */
+#define PUD_TX_NODEIDTYPE_DIGITS               3
+
+/*
+ * Node ID
+ */
+
+/** The maximum size of the string representation of the nodeId */
+#define PUD_TX_NODEID_BUFFERSIZE               1023
+
+/*
+ * Wire Format Structures
+ */
+
+/** Sub-format GPS information, 120 bits = 15 bytes */
+typedef struct _GpsInfo {
+       uint32_t time :PUD_TIME_BITS; /**< the number of seconds since midnight, ALWAYS present */
+       uint32_t lat :PUD_LATITUDE_BITS; /**< latitude */
+       uint32_t lon :PUD_LONGITUDE_BITS; /**< longitude */
+       uint32_t alt :PUD_ALTITUDE_BITS; /**< altitude */
+       uint32_t speed :PUD_SPEED_BITS; /**< speed */
+       uint32_t track :PUD_TRACK_BITS; /**< track angle */
+       uint32_t hdop :PUD_HDOP_BITS; /**< HDOP */
+}__attribute__((__packed__)) GpsInfo;
+
+/** Sub-format Node information, 8 + variable bits = 1 + variable bytes */
+typedef struct _NodeInfo {
+       uint8_t nodeIdType; /**< the nodeIdType */
+       unsigned char nodeId; /**< placeholder for variable length nodeId string */
+}__attribute__((__packed__)) NodeInfo;
+
+/** Complete format, 8+8+8+120+(8+variable) bits =  18+(1+variable) bytes*/
+typedef struct _PudOlsrPositionUpdate {
+       uint8_t version; /**< the version of the sentence */
+       uint8_t validityTime; /**< the validity time of the sentence */
+       uint8_t smask; /**< mask signaling the contents of the sentence */
+       GpsInfo gpsInfo; /**< the GPS information (MANDATORY) */
+       NodeInfo nodeInfo; /**< placeholder for node information (OPTIONAL) */
+}__attribute__((__packed__)) PudOlsrPositionUpdate;
+
+/** The size of the wire format, minus the size of the node information */
+#define PUD_OLSRWIREFORMATSIZE (sizeof(PudOlsrPositionUpdate) - sizeof(NodeInfo))
+
+/*
+ * Uplink
+ */
+
+/** the types of the uplink messages */
+typedef enum _UplinkMessageType {
+       POSITION = 0,
+       CLUSTERLEADER = 1
+} UplinkMessageType;
+
+/** cluster leader message, 10 bytes (IPv4), 34 bytes (IPv6) */
+typedef struct _UplinkClusterLeader {
+       uint8_t version; /**< the version of the message */
+       uint8_t validityTime; /**< the validity time of the sentence */
+       union _leader {
+               struct _v4 {
+                       struct in_addr originator;
+                       struct in_addr clusterLeader;
+               } v4;
+               struct _v6 {
+                       struct in6_addr originator;
+                       struct in6_addr clusterLeader;
+               } v6;
+       } leader;
+}__attribute__((__packed__)) UplinkClusterLeader;
+
+/** TLV header for uplink messages, 4 bytes */
+typedef struct _UplinkHeader {
+       uint8_t type; /**< stores a UplinkMessageType */
+       uint16_t length; /**< the length of the payload in txBuffer */
+       uint8_t ipv6 :1; /**< clear when IPv4, set when IPv6 */
+       uint8_t pad :7; /**< padding to align to 4 bytes */
+}__attribute__((__packed__)) UplinkHeader;
+
+/** uplink message */
+typedef struct _UplinkMessage {
+       UplinkHeader header; /**< the uplink TLV header */
+       union _msg {
+               /** an olsr message (position update) */
+               union olsr_message olsrMessage;
+
+               /** a cluster leader message */
+               UplinkClusterLeader clusterLeader;
+       } msg;
+}__attribute__((__packed__)) UplinkMessage;
+
+/* ************************************************************************
+ * FUNCTIONS
+ * ************************************************************************ */
+
+/*
+ * Validity Time
+ */
+
+/** Determine the validity time in seconds from the OLSR wire format value */
+#define PUD_VALIDITY_TIME_FROM_OLSR(msn, lsn) ((((lsn) + 16) * (1 << (msn))) - 16)
+
+/**
+ Get the validity time from a message
+
+ @param validityTimeField
+ A pointer to the validity time field
+
+ @return
+ The validity time in seconds
+ */
+static inline unsigned long getValidityTime(uint8_t * validityTimeField) {
+       return PUD_VALIDITY_TIME_FROM_OLSR(*validityTimeField >> 4, *validityTimeField % 16);
+}
+
+void setValidityTime(uint8_t * validityTimeField,
+               unsigned long long validityTime);
+
+/*
+ * UplinkHeader
+ */
+
+/**
+ Get the type of the uplink message
+
+ @param uplinkHeader
+ A pointer to the uplink message
+ @return
+ The type of the uplink message
+ */
+static inline uint8_t getUplinkMessageType(UplinkHeader * uplinkHeader) {
+       return uplinkHeader->type;
+}
+
+/**
+ Set the type of the uplink message
+
+ @param uplinkHeader
+ A pointer to the uplink message
+ @param type
+ The type of the uplink message
+ */
+static inline void setUplinkMessageType(UplinkHeader * uplinkHeader,
+               uint8_t type) {
+       uplinkHeader->type = type;
+}
+
+/**
+ Get the length of the uplink message
+
+ @param uplinkHeader
+ A pointer to the uplink message
+ @return
+ The length of the uplink message
+ */
+static inline uint16_t getUplinkMessageLength(UplinkHeader * uplinkHeader) {
+       return ntohs(uplinkHeader->length);
+}
+
+/**
+ Set the length of the uplink message
+
+ @param uplinkHeader
+ A pointer to the uplink message
+ @param length
+ The length of the uplink message
+ */
+static inline void setUplinkMessageLength(UplinkHeader * uplinkHeader,
+               uint16_t length) {
+       uplinkHeader->length = ntohs(length);
+}
+
+/**
+ Get the IPv6 status of the uplink message
+
+ @param uplinkHeader
+ A pointer to the uplink message
+ @return
+ true when the uplink message is sent from an olsrd stack in IPv6 mode, false
+ otherwise
+ */
+static inline bool getUplinkMessageIPv6(UplinkHeader * uplinkHeader) {
+       return (uplinkHeader->ipv6 == 1);
+}
+
+/**
+ Set the IPv6 status of the uplink message
+
+ @param uplinkHeader
+ A pointer to the uplink message
+ @param ipv6
+ The IPv6 status of the uplink message (true when the uplink message is sent
+ from olsrd stack in IPv6 mode, false otherwise)
+ */
+static inline void setUplinkMessageIPv6(UplinkHeader * uplinkHeader,
+               bool ipv6) {
+       uplinkHeader->ipv6 = ipv6 ? 1 : 0;
+}
+
+/**
+ Set the padding of the uplink message header
+
+ @param uplinkHeader
+ A pointer to the uplink message
+ @param pad
+ The padding of the uplink message header
+ */
+static inline void setUplinkMessagePadding(UplinkHeader * uplinkHeader,
+               uint8_t pad) {
+       uplinkHeader->pad = pad;
+}
+
+/*
+ * OLSR header
+ */
+
+/**
+ Get the originator of an OLSR message
+
+ @param ipVersion
+ The IP version (AF_INET or AF_INET6)
+ @param olsrMessage
+ A pointer to the OLSR message
+ @return
+ A pointer to the originator address
+ */
+static inline union olsr_ip_addr * getOlsrMessageOriginator(int ipVersion,
+               union olsr_message * olsrMessage) {
+       if (ipVersion == AF_INET) {
+               return (union olsr_ip_addr *) &olsrMessage->v4.originator;
+       }
+
+       return (union olsr_ip_addr *) &olsrMessage->v6.originator;
+}
+
+/**
+ Get the position update message in an OLSR message
+
+ @param ipVersion
+ The IP version (AF_INET or AF_INET6)
+ @param olsrMessage
+ A pointer to the OLSR message
+ @return
+ A pointer to the position update message
+ */
+static inline PudOlsrPositionUpdate * getOlsrMessagePayload(int ipVersion,
+               union olsr_message * olsrMessage) {
+       if (ipVersion == AF_INET) {
+               return (PudOlsrPositionUpdate *) &olsrMessage->v4.message;
+       }
+
+       return (PudOlsrPositionUpdate *) &olsrMessage->v6.message;
+}
+
+/*
+ * PudOlsrPositionUpdate
+ */
+
+/**
+ Get the version of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @return
+ The version of the position update message
+ */
+static inline uint8_t getPositionUpdateVersion(
+               PudOlsrPositionUpdate * olsrGpsMessage) {
+       return olsrGpsMessage->version;
+}
+
+/**
+ Set the version of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param version
+ The version of the position update message
+ */
+static inline void setPositionUpdateVersion(
+               PudOlsrPositionUpdate * olsrGpsMessage, uint8_t version) {
+       olsrGpsMessage->version = version;
+}
+
+/**
+ Get the smask of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @return
+ The smask of the position update message
+ */
+static inline uint8_t getPositionUpdateSmask(
+               PudOlsrPositionUpdate * olsrGpsMessage) {
+       return olsrGpsMessage->smask;
+}
+
+/**
+ Set the smask of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param smask
+ The smask of the position update message
+ */
+static inline void setPositionUpdateSmask(
+               PudOlsrPositionUpdate * olsrGpsMessage, uint8_t smask) {
+       olsrGpsMessage->smask = smask;
+}
+
+/*
+ * GpsInfo
+ */
+
+void getPositionUpdateTime(PudOlsrPositionUpdate * olsrGpsMessage,
+               time_t baseDate, struct tm *nowStruct);
+
+/**
+ Set the time of the position update message (the number of seconds after
+ midnight)
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param hour
+ The hours
+ @param min
+ The minutes
+ @param sec
+ The seconds
+ */
+static inline void setPositionUpdateTime(PudOlsrPositionUpdate * olsrGpsMessage,
+               int hour, int min, int sec) {
+       olsrGpsMessage->gpsInfo.time = ((hour * 60 * 60) + (min * 60) + sec);
+}
+
+/**
+ Get the latitude of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+
+ @return
+ The latitude converted to degrees: [-90, 90>
+ */
+static inline double getPositionUpdateLatitude(
+               PudOlsrPositionUpdate * olsrGpsMessage) {
+       uint32_t olsrLat = olsrGpsMessage->gpsInfo.lat;
+       double lat = (double) olsrLat;
+
+       /* lat is in [0, 2^LATITUDE_BITS> */
+
+       /* take half of the rounding error */
+       lat += 0.5;
+
+       lat /= (double) (1 << PUD_LATITUDE_BITS);
+       /* lat is now in [0, 1> */
+
+       lat -= 0.5;
+       /* lat is now in [-0.5, 0.5> */
+
+       lat *= 180.0;
+       /* lat is now in [-90, 90> */
+
+       return lat;
+}
+
+/**
+ Set the latitude of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param latitude
+ The latitude in degrees: [-90, 90]
+ */
+static inline void setPositionUpdateLatitude(
+               PudOlsrPositionUpdate * olsrGpsMessage, double latitude) {
+       double lat = latitude;
+
+       /* lat is in [-90, 90] */
+       assert(lat >= -90.0);
+       assert(lat <= 90.0);
+
+       lat /= 180.0;
+       /* lat is now in [-0.5, 0.5] */
+
+       lat += 0.5;
+       /* lat is now in [0, 1] */
+
+       lat *= (double) (1 << PUD_LATITUDE_BITS);
+       /* lat is now in [0, LATITUDE_BITS] */
+
+       /* clip max */
+       if (unlikely(lat > (double)((1 << PUD_LATITUDE_BITS) - 1))) {
+               lat = (double) ((1 << PUD_LATITUDE_BITS) - 1);
+       }
+       /* lat is now in [0, 2^LATITUDE_BITS> */
+
+       olsrGpsMessage->gpsInfo.lat = lrint(lat);
+}
+
+/**
+ Get the longitude of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+
+ @return
+ The longitude converted to degrees: [-180, 180>
+ */
+static inline double getPositionUpdateLongitude(
+               PudOlsrPositionUpdate * olsrGpsMessage) {
+       uint32_t olsrLon = olsrGpsMessage->gpsInfo.lon;
+       double lon = (double) olsrLon;
+
+       /* lon is in [0, 2^LONGITUDE_BITS> */
+
+       /* take half of the rounding error */
+       lon += 0.5;
+
+       lon /= (1 << PUD_LONGITUDE_BITS);
+       /* lon is now in [0, 1> */
+
+       lon -= 0.5;
+       /* lon is now in [-0.5, 0.5> */
+
+       lon *= 360.0;
+       /* lon is now in [-180, 180> */
+
+       return lon;
+}
+
+/**
+ Set the longitude of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param longitude
+ The longitude in degrees: [-90, 90]
+ */
+static inline void setPositionUpdateLongitude(
+               PudOlsrPositionUpdate * olsrGpsMessage, double longitude) {
+       double lon = longitude;
+
+       /* lon is in [-180, 180] */
+       assert(lon >= -180.0);
+       assert(lon <= 180.0);
+
+       lon /= 360.0;
+       /* lon is now in [-0.5, 0.5] */
+
+       lon += 0.5;
+       /* lon is now in [0, 1] */
+
+       lon *= (double) (1 << PUD_LONGITUDE_BITS);
+       /* lon is now in [0, LONGITUDE_BITS] */
+
+       /* clip max */
+       if (unlikely(lon > (double)((1 << PUD_LATITUDE_BITS) - 1))) {
+               lon = (double) ((1 << PUD_LATITUDE_BITS) - 1);
+       }
+
+       /* lon is now in [0, 2^LONGITUDE_BITS> */
+
+       olsrGpsMessage->gpsInfo.lon = lrint(lon);
+}
+
+/**
+ Get the altitude of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+
+ @return
+ The altitude in meters
+ */
+static inline long getPositionUpdateAltitude(
+               PudOlsrPositionUpdate * olsrGpsMessage) {
+       return ((long) olsrGpsMessage->gpsInfo.alt + PUD_ALTITUDE_MIN);
+}
+
+/**
+ Set the altitude of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param altitude
+ The altitude in meters
+ */
+static inline void setPositionUpdateAltitude(
+               PudOlsrPositionUpdate * olsrGpsMessage, double altitude) {
+       double alt = altitude;
+
+       if (unlikely(alt > PUD_ALTITUDE_MAX)) {
+               alt = PUD_ALTITUDE_MAX;
+       } else if (unlikely(alt < PUD_ALTITUDE_MIN)) {
+               alt = PUD_ALTITUDE_MIN;
+       }
+
+       alt -= PUD_ALTITUDE_MIN;
+
+       olsrGpsMessage->gpsInfo.alt = lrint(alt);
+}
+
+/**
+ Get the speed of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+
+ @return
+ The speed in kph
+ */
+static inline unsigned long getPositionUpdateSpeed(
+               PudOlsrPositionUpdate * olsrGpsMessage) {
+       return olsrGpsMessage->gpsInfo.speed;
+}
+
+/**
+ Set the speed of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param speed
+ The speed in kph
+ */
+static inline void setPositionUpdateSpeed(
+               PudOlsrPositionUpdate * olsrGpsMessage, double speed) {
+       double spd = speed;
+
+       if (unlikely(speed < 0)) {
+               spd = 0;
+       } else if (unlikely(speed > PUD_SPEED_MAX)) {
+               spd = PUD_SPEED_MAX;
+       }
+
+       olsrGpsMessage->gpsInfo.speed = lrint(spd);
+}
+
+/**
+ Get the track angle of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+
+ @return
+ The track angle in degrees
+ */
+static inline unsigned long getPositionUpdateTrack(
+               PudOlsrPositionUpdate * olsrGpsMessage) {
+       return olsrGpsMessage->gpsInfo.track;
+}
+
+/**
+ Set the track angle of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param track
+ The track angle in degrees
+ */
+static inline void setPositionUpdateTrack(
+               PudOlsrPositionUpdate * olsrGpsMessage, double track) {
+       olsrGpsMessage->gpsInfo.track = lrint(track);
+}
+
+/**
+ Get the HDOP of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+
+ @return
+ The HDOP
+ */
+static inline double getPositionUpdateHdop(
+               PudOlsrPositionUpdate * olsrGpsMessage) {
+       return (olsrGpsMessage->gpsInfo.hdop * PUD_HDOP_RESOLUTION);
+}
+
+/**
+ Set the HDOP of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param hdop
+ The HDOP
+ */
+static inline void setPositionUpdateHdop(PudOlsrPositionUpdate * olsrGpsMessage,
+               double hdop) {
+       double hdopInternal = hdop;
+
+       if (unlikely(hdopInternal > PUD_HDOP_MAX)) {
+               hdopInternal = PUD_HDOP_MAX;
+       }
+
+       olsrGpsMessage->gpsInfo.hdop = lrint(hdopInternal / PUD_HDOP_RESOLUTION);
+}
+
+/*
+ * NodeInfo
+ */
+
+bool setupNodeIdNumberForOlsrCache(/*const char * nodeIdParameterName,*/
+unsigned long long val, unsigned long long min, unsigned long long max,
+               unsigned int bytes);
+
+/**
+ Get the nodeIdType of the position update message
+
+ @param ipVersion
+ The IP version (AF_INET or AF_INET6)
+ @param olsrGpsMessage
+ A pointer to the position update message
+
+ @return
+ The nodeIdType
+ */
+static inline NodeIdType getPositionUpdateNodeIdType(int ipVersion,
+               PudOlsrPositionUpdate * olsrGpsMessage) {
+       if (getPositionUpdateSmask(olsrGpsMessage) & PUD_FLAGS_ID) {
+               return olsrGpsMessage->nodeInfo.nodeIdType;
+       }
+
+       return ((ipVersion == AF_INET) ? PUD_NODEIDTYPE_IPV4 : PUD_NODEIDTYPE_IPV6);
+}
+
+/**
+ Set the nodeIdType of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param nodeIdType
+ The nodeIdType
+ */
+static inline void setPositionUpdateNodeIdType(
+               PudOlsrPositionUpdate * olsrGpsMessage, NodeIdType nodeIdType) {
+       olsrGpsMessage->nodeInfo.nodeIdType = nodeIdType;
+}
+
+void getPositionUpdateNodeId(int ipVersion, union olsr_message * olsrMessage,
+               unsigned char ** nodeId, unsigned int * nodeIdSize);
+
+/**
+ Set the nodeId of the position update message
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param nodeId
+ The nodeId
+ @param nodeIdSize
+ The number of bytes in nodeId
+ @param padWithNullByte
+ When true then an extra '\0' byte will be added at the end
+ */
+static inline void setPositionUpdateNodeId(
+               PudOlsrPositionUpdate * olsrGpsMessage, unsigned char * nodeId,
+               unsigned int nodeIdSize, bool padWithNullByte) {
+       memcpy(&olsrGpsMessage->nodeInfo.nodeId, nodeId, nodeIdSize);
+       if (unlikely(padWithNullByte)) {
+               (&olsrGpsMessage->nodeInfo.nodeId)[nodeIdSize] = '\0';
+       }
+}
+
+size_t setPositionUpdateNodeInfo(int ipVersion,
+               PudOlsrPositionUpdate * olsrGpsMessage, unsigned int olsrMessageSize,
+               NodeIdType nodeIdType, unsigned char * nodeId, size_t nodeIdLength);
+
+/*
+ * UplinkClusterLeader
+ */
+
+/**
+ Get the version of the cluster leader message
+
+ @param clusterLeaderMessage
+ A pointer to the cluster leader message
+ @return
+ The version of the cluster leader message
+ */
+static inline uint8_t getClusterLeaderVersion(
+               UplinkClusterLeader * clusterLeaderMessage) {
+       return clusterLeaderMessage->version;
+}
+
+/**
+ Set the version of the cluster leader message
+
+ @param clusterLeaderMessage
+ A pointer to the cluster leader message
+ @param version
+ The version of the cluster leader message
+ */
+static inline void setClusterLeaderVersion(
+               UplinkClusterLeader * clusterLeaderMessage, uint8_t version) {
+       clusterLeaderMessage->version = version;
+}
+
+/**
+ Get the originator of a cluster leader message
+
+ @param ipVersion
+ The IP version (AF_INET or AF_INET6)
+ @param clusterLeaderMessage
+ A pointer to the cluster leader message
+ @return
+ A pointer to the originator address
+ */
+static inline union olsr_ip_addr * getClusterLeaderOriginator(int ipVersion,
+               UplinkClusterLeader * clusterLeaderMessage) {
+       if (ipVersion == AF_INET) {
+               return (union olsr_ip_addr *) &clusterLeaderMessage->leader.v4.originator;
+       }
+
+       return (union olsr_ip_addr *) &clusterLeaderMessage->leader.v6.originator;
+}
+
+/**
+ Get the cluster leader of a cluster leader message
+
+ @param ipVersion
+ The IP version (AF_INET or AF_INET6)
+ @param clusterLeaderMessage
+ A pointer to the cluster leader message
+ @return
+ A pointer to the clust leader address
+ */
+static inline union olsr_ip_addr * getClusterLeaderClusterLeader(int ipVersion,
+               UplinkClusterLeader * clusterLeaderMessage) {
+       if (ipVersion == AF_INET) {
+               return (union olsr_ip_addr *) &clusterLeaderMessage->leader.v4.clusterLeader;
+       }
+
+       return (union olsr_ip_addr *) &clusterLeaderMessage->leader.v6.clusterLeader;
+}
+
+#endif /* _PUD_WIREFORMAT_H_ */
diff --git a/lib/pud/wireformat/src/nodeIdConversion.c b/lib/pud/wireformat/src/nodeIdConversion.c
new file mode 100644 (file)
index 0000000..0f9d6d4
--- /dev/null
@@ -0,0 +1,170 @@
+#include <OlsrdPudWireFormat/nodeIdConversion.h>
+#include <OlsrdPudWireFormat/compiler.h>
+
+#include <assert.h>
+#include <arpa/inet.h>
+#include <net/if.h>
+
+/* ************************************************************************
+ * Node Information
+ * ************************************************************************ */
+
+/**
+ Convert the nodeIdType of an OLSR message into a string.
+
+ @param ipVersion
+ The ip version (AF_INET or AF_INET6)
+ @param olsrGpsMessage
+ A pointer to the position update message.
+ @param nodeIdTypeBuffer
+ A pointer to the buffer in which the nodeIdType string representation is
+ written (the buffer needs to be at least PUD_TX_NODEIDTYPE_DIGITS + 1 bytes).
+ When NULL then the nodeIdType string is not written.
+ @param nodeIdTypeBufferSize
+ The size of the nodeIdTypeBuffer. When zero then the nodeIdType string is not
+ written.
+ */
+void getNodeTypeStringFromOlsr(int ipVersion,
+               PudOlsrPositionUpdate * olsrGpsMessage, char * nodeIdTypeBuffer,
+               int nodeIdTypeBufferSize) {
+       int chars;
+
+       if (unlikely(!nodeIdTypeBuffer || (nodeIdTypeBufferSize == 0))) {
+               return;
+       }
+
+       assert(nodeIdTypeBufferSize >= (PUD_TX_NODEIDTYPE_DIGITS + 1));
+
+       /* message has NO nodeId information */
+       chars = snprintf(&nodeIdTypeBuffer[0], nodeIdTypeBufferSize, "%u",
+                       getPositionUpdateNodeIdType(ipVersion, olsrGpsMessage));
+       if (likely(chars < nodeIdTypeBufferSize)) {
+               nodeIdTypeBuffer[chars] = '\0';
+       } else {
+               nodeIdTypeBuffer[nodeIdTypeBufferSize] = '\0';
+       }
+
+       return;
+}
+
+/**
+ Get a nodeId number (in string representation), using a certain number of
+ bytes, from the message of an OLSR message.
+
+ @param buffer
+ A pointer to the buffer that holds the nodeId
+ @param bufferSize
+ The number of bytes used by the number in the buffer
+ @param nodeIdBuffer
+ The buffer in which to place the nodeId number in string representation
+ @param nodeIdBufferSize
+ The size of the nodeIdbuffer
+
+ @return
+ A pointer to the nodeId string representation (&nodeIdBuffer[0])
+ */
+static char *getNodeIdNumberFromOlsr(unsigned char * buffer,
+               unsigned int bufferSize, char *nodeIdBuffer, socklen_t nodeIdBufferSize) {
+       unsigned long long val = 0;
+       unsigned int i = 0;
+       int chars;
+
+       while (i < bufferSize) {
+               val <<= 8;
+               val += buffer[i];
+               i++;
+       }
+
+       chars = snprintf(nodeIdBuffer, nodeIdBufferSize, "%llu", val);
+       if (likely(chars < (int) nodeIdBufferSize)) {
+               nodeIdBuffer[chars] = '\0';
+       } else {
+               nodeIdBuffer[nodeIdBufferSize] = '\0';
+       }
+       return &nodeIdBuffer[0];
+}
+
+/**
+ Convert the nodeId of an OLSR message into a string.
+
+ @param ipVersion
+ The ip version (AF_INET or AF_INET6)
+ @param olsrMessage
+ A pointer to the OLSR message. Used to be able to retrieve the IP address of
+ the sender.
+ @param nodeIdStr
+ A pointer to a variable in which to store the pointer to the buffer in which
+ the nodeId string representation is written (the buffer needs to be at least
+ PUD_TX_NODEIDTYPE_DIGITS + 1 bytes). Not written to when nodeIdStrBuffer or
+ nodeIdStr is NULL or when nodeIdStrBufferSize is zero. Can point to
+ nodeIdStrBuffer or straight into the olsrMessage
+ @param nodeIdStrBuffer
+ A pointer to the buffer in which the nodeId string representation can be
+ written. Not written to when nodeIdStrBuffer or nodeIdStr is NULL or when
+ nodeIdStrBufferSize is zero.
+ @param nodeIdStrBufferSize
+ The size of the nodeIdStrBuffer. When zero then nodeIdStrBuffer and nodeIdStr
+ are not written to.
+ */
+void getNodeIdStringFromOlsr(int ipVersion, union olsr_message *olsrMessage,
+               const char **nodeIdStr, char *nodeIdStrBuffer,
+               unsigned int nodeIdStrBufferSize) {
+       PudOlsrPositionUpdate * olsrGpsMessage;
+       unsigned char * nodeId;
+       unsigned int nodeIdSize;
+
+       if (unlikely(!nodeIdStrBuffer || (nodeIdStrBufferSize == 0) || !nodeIdStr)) {
+               return;
+       }
+
+       assert(nodeIdStrBufferSize >= (PUD_TX_NODEID_BUFFERSIZE + 1));
+
+       olsrGpsMessage = getOlsrMessagePayload(ipVersion, olsrMessage);
+
+       getPositionUpdateNodeId(ipVersion, olsrMessage, &nodeId, &nodeIdSize);
+
+       switch (getPositionUpdateNodeIdType(ipVersion, olsrGpsMessage)) {
+       case PUD_NODEIDTYPE_MAC: /* hardware address */
+       {
+               int chars;
+
+               assert(nodeIdSize == 6);
+
+               chars = snprintf(nodeIdStrBuffer, nodeIdStrBufferSize,
+                               "%02x:%02x:%02x:%02x:%02x:%02x", nodeId[0], nodeId[1],
+                               nodeId[2], nodeId[3], nodeId[4], nodeId[5]);
+               if (likely(chars < (int) nodeIdStrBufferSize)) {
+                       nodeIdStrBuffer[chars] = '\0';
+               } else {
+                       nodeIdStrBuffer[nodeIdStrBufferSize - 1] = '\0';
+               }
+               *nodeIdStr = &nodeIdStrBuffer[0];
+       }
+               break;
+
+       case PUD_NODEIDTYPE_DNS: /* DNS name */
+               *nodeIdStr = (char *) nodeId;
+               break;
+
+       case PUD_NODEIDTYPE_MSISDN: /* an MSISDN number */
+       case PUD_NODEIDTYPE_TETRA: /* a Tetra number */
+       case PUD_NODEIDTYPE_192:
+       case PUD_NODEIDTYPE_193:
+       case PUD_NODEIDTYPE_194:
+               *nodeIdStr = getNodeIdNumberFromOlsr(nodeId, nodeIdSize,
+                               nodeIdStrBuffer, nodeIdStrBufferSize);
+               break;
+
+       case PUD_NODEIDTYPE_IPV4: /* IPv4 address */
+       case PUD_NODEIDTYPE_IPV6: /* IPv6 address */
+       default: /* unsupported */
+       {
+               void * addr = getOlsrMessageOriginator(ipVersion, olsrMessage);
+               *nodeIdStr = inet_ntop(ipVersion, addr, nodeIdStrBuffer,
+                               nodeIdStrBufferSize);
+       }
+               break;
+       }
+
+       return;
+}
diff --git a/lib/pud/wireformat/src/wireFormat.c b/lib/pud/wireformat/src/wireFormat.c
new file mode 100644 (file)
index 0000000..0a66dc9
--- /dev/null
@@ -0,0 +1,394 @@
+#include <OlsrdPudWireFormat/wireFormat.h>
+#include <OlsrdPudWireFormat/compiler.h>
+
+/* ************************************************************************
+ * VALIDITY TIME CACHE
+ * ************************************************************************ */
+
+static unsigned long long cachedValidityTimeMsn[16];
+
+static bool cachedValidityTimeMsnValid = false;
+
+/**
+ Setup of cache of calculated most significant nibble results of the validity
+ time calculation to speed up run-time calculations. This method has to be
+ called once upon first use of ValidityTime functions.
+ */
+static void setupCachedValidityTimeMsn(void) {
+       unsigned int msn;
+       for (msn = 0; msn < 16; msn++) {
+               cachedValidityTimeMsn[msn] = PUD_VALIDITY_TIME_FROM_OLSR(msn, 0);
+       }
+       cachedValidityTimeMsnValid = true;
+}
+
+/* ************************************************************************
+ * NODEID CACHE
+ * ************************************************************************ */
+
+/** The size of the cached nodeId buffer */
+#define PUD_CACHED_NODEID_BUFFER_SIZE 16
+
+/** The cached nodeId buffer: contains a pre-processed version of the nodeId
+ in order to improve performance. It is currently used for nodeIdTypes
+ PUD_NODEIDTYPE_MSISDN, PUD_NODEIDTYPE_TETRA, PUD_NODEIDTYPE_192,
+ PUD_NODEIDTYPE_193 (so basically for numbers that will not change) */
+static unsigned char cachedNodeIdBuffer[PUD_CACHED_NODEID_BUFFER_SIZE];
+
+/** The number of bytes stored in cachedNodeIdBuffer */
+static unsigned int cachedNodeIdBufferLength = 0;
+
+/**
+ @param nodeId
+ A pointer to the location in which to store a pointer to the nodeId cache
+ buffer
+ @param nodeIdSize
+ A pointer to the location in which to store the number of bytes in the buffer
+ */
+static inline void getNodeIdNumberForOlsrCache(unsigned char ** nodeId,
+               unsigned int * nodeIdSize) {
+       *nodeId = &cachedNodeIdBuffer[0];
+       *nodeIdSize = cachedNodeIdBufferLength;
+}
+
+/**
+ Check a nodeId number for validity and if valid set it up in the
+ cachedNodeIdBuffer. The valid range for the number is [min, max].
+
+ @param val
+ The value to setup in the cache
+ @param min
+ The lower bound for a valid number
+ @param max
+ The upper bound for a valid number
+ @param bytes
+ The number of bytes used by the number in the wire format
+
+ @return
+ - true when the number is valid
+ - false otherwise
+ */
+bool setupNodeIdNumberForOlsrCache(unsigned long long val,
+               unsigned long long min, unsigned long long max, unsigned int bytes) {
+       assert(bytes <= PUD_CACHED_NODEID_BUFFER_SIZE);
+
+       if ((val >= min) && (val <= max)) {
+               int i = bytes - 1;
+               while (i >= 0) {
+                       cachedNodeIdBuffer[i] = val & 0xff;
+                       val >>= 8;
+                       i--;
+               }
+
+               assert(val == 0);
+
+               cachedNodeIdBufferLength = bytes;
+               return true;
+       }
+
+       return false;
+}
+
+/* ************************************************************************
+ * Validity Time
+ * ************************************************************************ */
+
+/* inline getValidityTime */
+
+/**
+ Set the validity time of the position update message
+
+ @param validityTimeField
+ A pointer to the validity time field
+ @param validityTime
+ The validity time in seconds
+ */
+void setValidityTime(uint8_t * validityTimeField,
+               unsigned long long validityTime) {
+       unsigned int msn = 1;
+       unsigned long long lsn = 0;
+       unsigned long long upperBound;
+
+       if (!cachedValidityTimeMsnValid) {
+               setupCachedValidityTimeMsn();
+       }
+       upperBound = cachedValidityTimeMsn[msn];
+       while ((msn < 16) && (validityTime >= upperBound)) {
+               msn++;
+               upperBound = cachedValidityTimeMsn[msn];
+       }
+       msn--;
+
+       if (unlikely(validityTime >= upperBound)) {
+               lsn = 15;
+       } else {
+               unsigned long lowerBound = PUD_VALIDITY_TIME_FROM_OLSR(msn, 0);
+               unsigned long resolution = (1 << msn);
+               lsn = ((validityTime - lowerBound + (resolution >> 1)) / resolution);
+       }
+
+       assert(msn <= 15);
+       assert(lsn <= 15);
+
+       *validityTimeField = ((msn << 4) | lsn);
+}
+
+/* ************************************************************************
+ * UplinkPositionUpdate
+ * ************************************************************************ */
+
+/* inline uint8_t getUplinkMessageType */
+/* inline void setUplinkMessageType */
+
+/* inline uint16_t getUplinkMessageLength */
+/* inline void setUplinkMessageLength */
+
+/* inline bool getUplinkMessageIPv6 */
+/* inline void setUplinkMessageIPv6 */
+
+/* inline void setUplinkMessagePadding */
+
+/* ************************************************************************
+ * OLSR Header
+ * ************************************************************************ */
+
+/* inline union olsr_ip_addr * getOlsrMessageOriginator */
+
+/* inline PudOlsrPositionUpdate * getOlsrMessagePayload */
+
+/* ************************************************************************
+ * PudOlsrPositionUpdate
+ * ************************************************************************ */
+
+/* inline uint8_t getPositionUpdateVersion */
+/* inline void setPositionUpdateVersion */
+
+/* inline uint8_t getPositionUpdateSmask */
+/* inline void setPositionUpdateSmask */
+
+/* ************************************************************************
+ * GpsInfo
+ * ************************************************************************ */
+
+/* inline void setPositionUpdateTime */
+
+/**
+ Convert the time of an OLSR message (the number of seconds after midnight) to
+ a time structure, based on midnight of the current day.
+
+ @param olsrGpsMessage
+ A pointer to the position update message
+ @param baseDate
+ The base date from which to determine the time (number of seconds since Epoch)
+ @param nowStruct
+ A pointer to the time structure into which to put the converted time
+ */
+void getPositionUpdateTime(PudOlsrPositionUpdate * olsrGpsMessage,
+               time_t baseDate, struct tm *nowStruct) {
+       uint32_t olsrTime = olsrGpsMessage->gpsInfo.time;
+       unsigned int secNow;
+
+       time_t now = baseDate;
+       gmtime_r(&now, nowStruct);
+
+       secNow = ((nowStruct->tm_hour * 60 * 60) + (nowStruct->tm_min * 60)
+                       + nowStruct->tm_sec);
+
+       if (secNow <= (12 * 60 * 60)) {
+               /* we are now in the first 12h of the day */
+               if (unlikely(olsrTime > (secNow + (12 * 60 * 60)))) {
+                       /* the message was sent more than 12h later in time:
+                        the message was sent yesterday: adjust the date by -1 day */
+                       now -= (24 * 60 * 60);
+                       gmtime_r(&now, nowStruct);
+               }
+       } else {
+               /* we are now in the last 12h of the day */
+               if (unlikely(olsrTime < (secNow - (12 * 60 * 60)))) {
+                       /* the message was sent more than 12h earlier in time:
+                        the message was sent tomorrow: adjust the date by +1 day */
+                       now += (24 * 60 * 60);
+                       gmtime_r(&now, nowStruct);
+               }
+       }
+
+       nowStruct->tm_hour = ((olsrTime % (24 * 60 * 60)) / 3600);
+       nowStruct->tm_min = ((olsrTime % (60 * 60)) / 60);
+       nowStruct->tm_sec = (olsrTime % 60);
+}
+
+/* inline double getPositionUpdateLatitude */
+/* inline void setPositionUpdateLatitude */
+
+/* inline double getPositionUpdateLongitude */
+/* inline void setPositionUpdateLongitude */
+
+/* inline long getPositionUpdateAltitude */
+/* inline void setPositionUpdateAltitude */
+
+/* inline unsigned long getPositionUpdateSpeed */
+/* inline void setPositionUpdateSpeed */
+
+/* inline unsigned long getPositionUpdateTrack */
+/* inline void setPositionUpdateTrack */
+
+/* inline double getPositionUpdateHdop */
+/* inline void setPositionUpdateHdop */
+
+/* ************************************************************************
+ * NodeInfo
+ * ************************************************************************ */
+
+/* inline NodeIdType getPositionUpdateNodeIdType */
+/* inline void setPositionUpdateNodeIdType */
+
+/**
+ Get the nodeId and its size, accounting for nodeId presence
+
+ @param ipVersion
+ The IP version (AF_INET or AF_INET6)
+ @param olsrMessage
+ A pointer to the OLSR message
+ @param nodeId
+ A pointer to the location where a pointer to the nodeId (as contained in the
+ olsrMessage) can be stored
+ @param nodeIdSize
+ A pointer to the location where the number of bytes in the nodeId can be
+ stored
+ */
+void getPositionUpdateNodeId(int ipVersion, union olsr_message * olsrMessage,
+               unsigned char ** nodeId, unsigned int * nodeIdSize) {
+       PudOlsrPositionUpdate * olsrGpsMessage = getOlsrMessagePayload(ipVersion,
+                       olsrMessage);
+
+       *nodeId = &olsrGpsMessage->nodeInfo.nodeId;
+
+       switch (getPositionUpdateNodeIdType(ipVersion, olsrGpsMessage)) {
+       case PUD_NODEIDTYPE_MAC: /* hardware address */
+               *nodeIdSize = PUD_NODEIDTYPE_MAC_BYTES;
+               break;
+
+       case PUD_NODEIDTYPE_MSISDN: /* an MSISDN number */
+               *nodeIdSize = PUD_NODEIDTYPE_MSISDN_BYTES;
+               break;
+
+       case PUD_NODEIDTYPE_TETRA: /* a Tetra number */
+               *nodeIdSize = PUD_NODEIDTYPE_TETRA_BYTES;
+               break;
+
+       case PUD_NODEIDTYPE_DNS: /* DNS name */
+               *nodeIdSize = strlen((char *) *nodeId);
+               /* FIXME for no '\0' at the end, need to scan from the end until
+                * encountering a non-zero byte: end of string address and
+                * subtract the string start address */
+               break;
+
+       case PUD_NODEIDTYPE_192:
+               *nodeIdSize = PUD_NODEIDTYPE_192_BYTES;
+               break;
+
+       case PUD_NODEIDTYPE_193:
+               *nodeIdSize = PUD_NODEIDTYPE_193_BYTES;
+               break;
+
+       case PUD_NODEIDTYPE_194:
+               *nodeIdSize = PUD_NODEIDTYPE_194_BYTES;
+               break;
+
+       case PUD_NODEIDTYPE_IPV4: /* IPv4 address */
+       case PUD_NODEIDTYPE_IPV6: /* IPv6 address */
+       default: /* unsupported */
+       {
+               *nodeId = (unsigned char *) getOlsrMessageOriginator(ipVersion,
+                               olsrMessage);
+               *nodeIdSize =
+                               (ipVersion == AF_INET) ?
+                                               PUD_NODEIDTYPE_IPV4_BYTES : PUD_NODEIDTYPE_IPV6_BYTES;
+       }
+               break;
+       }
+
+       return;
+}
+
+/**
+ Convert the node information to the node information for an OLSR message and
+ put it in the PUD message in the OLSR message. Also updates the PUD message
+ smask.
+
+ @param ipVersion
+ The IP version (AF_INET or AF_INET6)
+ @param olsrGpsMessage
+ A pointer to the PUD message in the OLSR message
+ @param olsrMessageSize
+ The maximum number of bytes available for the olsrMessage
+ @param nodeIdType
+ The nodeIdType
+ @param nodeId
+ The (configured) nodeId
+ @param nodeIdLength
+ The number of bytes in the nodeId
+
+ @return
+ The number of bytes written in the PUD message in the OLSR message (for ALL
+ the node information)
+ */
+size_t setPositionUpdateNodeInfo(int ipVersion,
+               PudOlsrPositionUpdate * olsrGpsMessage, unsigned int olsrMessageSize,
+               NodeIdType nodeIdType, unsigned char * nodeId, size_t nodeIdLength) {
+       unsigned char * buffer;
+       unsigned int length = 0;
+
+       setPositionUpdateNodeIdType(olsrGpsMessage, nodeIdType);
+       switch (nodeIdType) {
+       case PUD_NODEIDTYPE_MAC: /* hardware address */
+               /* handled when the message is actually sent into OLSR, in the
+                * pre-transmit hook */
+               length = PUD_NODEIDTYPE_MAC_BYTES;
+               break;
+
+       case PUD_NODEIDTYPE_MSISDN: /* an MSISDN number */
+       case PUD_NODEIDTYPE_TETRA: /* a Tetra number */
+       case PUD_NODEIDTYPE_192:
+       case PUD_NODEIDTYPE_193:
+       case PUD_NODEIDTYPE_194:
+               getNodeIdNumberForOlsrCache(&buffer, &length);
+               setPositionUpdateNodeId(olsrGpsMessage, buffer, length, false);
+               break;
+
+       case PUD_NODEIDTYPE_DNS: /* DNS name */
+       {
+               long charsAvailable = olsrMessageSize
+                               - (PUD_OLSRWIREFORMATSIZE + sizeof(NodeInfo)
+                                               - sizeof(olsrGpsMessage->nodeInfo.nodeId)) - 1;
+
+               length = nodeIdLength + 1;
+               if (unlikely((long) length > charsAvailable)) {
+                       length = charsAvailable;
+               }
+
+               setPositionUpdateNodeId(olsrGpsMessage, nodeId, length, true);
+       }
+               break;
+
+       case PUD_NODEIDTYPE_IPV4: /* IPv4 address */
+       case PUD_NODEIDTYPE_IPV6: /* IPv6 address */
+               /* explicit return: no nodeId information in message */
+               return 0;
+
+       default: /* unsupported */
+               /* fallback to IP address */
+               setPositionUpdateNodeIdType(olsrGpsMessage,
+                               (ipVersion == AF_INET) ? PUD_NODEIDTYPE_IPV4 :
+                               PUD_NODEIDTYPE_IPV6);
+
+               /* explicit return: no nodeId information in message */
+               return 0;
+       }
+
+       setPositionUpdateSmask(olsrGpsMessage,
+                       getPositionUpdateSmask(olsrGpsMessage) | PUD_FLAGS_ID);
+       return ((sizeof(NodeInfo)
+                       - (sizeof(olsrGpsMessage->nodeInfo.nodeId) /* nodeId placeholder */))
+                       + length);
+}