commit 904e436f11ed1197a1192b421ab7278975dce169 Author: Matthew Barr Date: Tue Oct 20 09:13:35 2015 +1100 Initial commit of Hyperscan diff --git a/.clang-format b/.clang-format new file mode 100644 index 00000000..d3af8100 --- /dev/null +++ b/.clang-format @@ -0,0 +1,6 @@ +BasedOnStyle: LLVM +IndentWidth: 4 +UseTab: false +AllowShortIfStatementsOnASingleLine: false +IndentCaseLabels: false +AccessModifierOffset: -4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..6e50ce45 --- /dev/null +++ b/.gitignore @@ -0,0 +1,103 @@ +## +## There are some more .gitignore files in subdirs, but this is the main place +## to add new entries. These are mostly for the common case when ue2 is built +## in place +## + +# Autogenerated stuff that we don't want to know about +.deps +autom4te.cache +autojunk +.dirstamp + +# Temp and swap files +*~ +.*.swp +.sw? + +# compiler output and binaries +*.a +*.o +*.lo +*.la +*.so +*.pyc +.libs +bin + +# Merge files created by git. +*.orig + +# sigs dir is handled externally +signatures + +# ignore pcre symlink if it exists +pcre +# but not pcre subdirs! +!pcre/ + +# ignore boost symlink if it exists +include/boost + +# ignore sqlite3 symlink if it exists +sqlite3 + +# Generated files +src/config.h +src/config.h.in +src/hs_version.h +src/fdr/fdr_autogen.c +src/fdr/fdr_autogen_compiler.cpp +src/fdr/teddy_autogen.c +src/fdr/teddy_autogen_compiler.cpp +src/parser/Parser.cpp + +# Generated PCRE files +pcre/pcre_chartables.c +pcre/pcregrep +pcre/pcretest + +# Autoconf/automake/libtool noise +Makefile +Makefile.in +aclocal.m4 +config.cache +config.log +config.status +configure +libhs.pc +libtool +m4/libtool.m4 +m4/ltoptions.m4 +m4/ltsugar.m4 +m4/ltversion.m4 +m4/lt~obsolete.m4 +src/stamp-h1 + +# Docs +!doc/dev-reference/Makefile # not generated +doc/dev-reference/doxygen_sqlite3.db +doc/dev-reference/doxygen_xml/ +doc/dev-reference/_build/ + +# Autotools noise in pcre +pcre/INSTALL +pcre/Makefile +pcre/Makefile.in +pcre/aclocal.m4 +pcre/ar-lib +pcre/compile +pcre/config.* +pcre/configure +pcre/depcomp +pcre/install-sh +pcre/*.pc +pcre/libtool +pcre/ltmain.sh +pcre/missing +pcre/pcre-config +pcre/pcre.h +pcre/pcre_stringpiece.h +pcre/pcrecpparg.h +pcre/stamp-h1 +pcre/test-driver diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 00000000..0dd02942 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,944 @@ +cmake_minimum_required (VERSION 2.8) +project (Hyperscan C CXX) + +set (HS_MAJOR_VERSION 4) +set (HS_MINOR_VERSION 0) +set (HS_PATCH_VERSION 0) +set (HS_VERSION ${HS_MAJOR_VERSION}.${HS_MINOR_VERSION}.${HS_PATCH_VERSION}) + +string (TIMESTAMP BUILD_DATE "%Y-%m-%d") + +set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake) +include(CheckCCompilerFlag) +include(CheckCXXCompilerFlag) +INCLUDE (CheckFunctionExists) +INCLUDE (CheckIncludeFiles) +INCLUDE (CheckIncludeFileCXX) +INCLUDE (CheckLibraryExists) +INCLUDE (CheckSymbolExists) +include (CMakeDependentOption) +include (${CMAKE_MODULE_PATH}/platform.cmake) +include (${CMAKE_MODULE_PATH}/ragel.cmake) + +find_package(PkgConfig QUIET) + +if (NOT CMAKE_BUILD_TYPE) + message(STATUS "Default build type 'Release with debug info'") + set(CMAKE_BUILD_TYPE "RELWITHDEBINFO") +else() + string(TOUPPER ${CMAKE_BUILD_TYPE} CMAKE_BUILD_TYPE) + message(STATUS "Build type ${CMAKE_BUILD_TYPE}") +endif() + +if(CMAKE_BUILD_TYPE MATCHES RELEASE|RELWITHDEBINFO) + set(RELEASE_BUILD TRUE) +else() + set(RELEASE_BUILD FALSE) +endif() + +set(BINDIR ${PROJECT_BINARY_DIR}/bin) +set(LIBDIR ${PROJECT_BINARY_DIR}/lib) + +# First for the generic no-config case +set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${BINDIR}) +set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${LIBDIR}) +set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${LIBDIR}) +# Second, for multi-config builds (e.g. msvc) +foreach (OUTPUTCONFIG ${CMAKE_CONFIGURATION_TYPES}) + string (TOUPPER ${OUTPUTCONFIG} OUTPUTCONFIG) + set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_${OUTPUTCONFIG} ${BINDIR}) + set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_${OUTPUTCONFIG} ${LIBDIR}) + set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_${OUTPUTCONFIG} ${LIBDIR}) +endforeach (OUTPUTCONFIG CMAKE_CONFIGURATION_TYPES) + + +if(CMAKE_GENERATOR STREQUAL Xcode) + set(XCODE TRUE) +endif() + +include_directories(src .) +include_directories(${CMAKE_BINARY_DIR}) +include_directories(SYSTEM include) + +set(BOOST_USE_STATIC_LIBS OFF) +set(BOOST_USE_MULTITHREADED OFF) +set(BOOST_USE_STATIC_RUNTIME OFF) +set(BOOST_MINVERSION 1.57.0) +set(BOOST_NO_BOOST_CMAKE ON) + +# first check for Boost installed on the system +find_package(Boost ${BOOST_MINVERSION}) +if(NOT Boost_FOUND) + # we might have boost in tree, so provide a hint and try again + message(STATUS "trying include dir for boost") + set(BOOST_INCLUDEDIR ${CMAKE_SOURCE_DIR}/include) + find_package(Boost ${BOOST_MINVERSION}) + if(NOT Boost_FOUND) + message(FATAL_ERROR "Boost ${BOOST_MINVERSION} or later not found. Either install system pacakges if available or extract Boost headers to ${CMAKE_SOURCE_DIR}/include") + endif() +endif() + +# -- make this work? set(python_ADDITIONAL_VERSIONS 2.7 2.6) +find_package(PythonInterp) +find_program(RAGEL ragel) + +if(PYTHONINTERP_FOUND) + set(PYTHON ${PYTHON_EXECUTABLE}) +else() + message(FATAL_ERROR "No python interpreter found") +endif() + +option(OPTIMISE "Turns off compiler optimizations (on by default unless debug output enabled or coverage testing)" TRUE) + +option(DEBUG_OUTPUT "Enable debug output (warning: very verbose)" FALSE) + +if(DEBUG_OUTPUT) + add_definitions(-DDEBUG) + set(OPTIMISE FALSE) +endif(DEBUG_OUTPUT) + +option(BUILD_SHARED_LIBS "Build shared libs instead of static" OFF) +option(BUILD_STATIC_AND_SHARED "Build shared libs as well as static" OFF) + +if (BUILD_STATIC_AND_SHARED OR BUILD_SHARED_LIBS) + if (WIN32) + message(FATAL_ERROR "Windows DLLs currently not supported") + else() + message(STATUS "Building shared libraries") + endif() +endif() + +#for config +set(HS_OPTIMIZE OPTIMISE) + +CMAKE_DEPENDENT_OPTION(DUMP_SUPPORT "Dump code support; normally on, except in release builds" ON "NOT RELEASE_BUILD" OFF) + +option(DISABLE_ASSERTS "Disable assert(); enabled in debug builds, disabled in release builds" FALSE) + +if (DISABLE_ASSERTS) + if (CMAKE_BUILD_TYPE STREQUAL "DEBUG") + add_definitions(-DNDEBUG) + endif() +endif() + +option(WINDOWS_ICC "Use Intel C++ Compiler on Windows, default off, requires ICC to be set in project" OFF) + +# TODO: per platform config files? + +# TODO: windows generator on cmake always uses msvc, even if we plan to build with icc +if(MSVC OR MSVC_IDE) + message(STATUS "Building for Windows") + if (MSVC_VERSION LESS 1700) + message(FATAL_ERROR "The project requires C++11 features.") + else() + if (WINDOWS_ICC) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /Qstd=c99 /Qrestrict /QxHost /O3 /wd4267 /Qdiag-disable:remark") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Qstd=c++11 /Qrestrict /QxHost /O2 /wd4267 /wd4800 /Qdiag-disable:remark -DBOOST_DETAIL_NO_CONTAINER_FWD -D_SCL_SECURE_NO_WARNINGS") + else() + #TODO: don't hardcode arch + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /arch:AVX /O2 /wd4267") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /arch:AVX /O2 /wd4244 /wd4267 /wd4800 /wd2586 /wd1170 -DBOOST_DETAIL_NO_CONTAINER_FWD -D_SCL_SECURE_NO_WARNINGS") + endif() + string(REGEX REPLACE "/RTC1" "" + CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}" ) + string(REGEX REPLACE "/RTC1" "" + CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG}" ) + + endif() + +else() + + # compiler version checks TODO: test more compilers + if (CMAKE_COMPILER_IS_GNUCXX) + set (GNUCXX_MINVER "4.8.1") + exec_program(${CMAKE_CXX_COMPILER} + ARGS ${CMAKE_CXX_COMPILER_ARG1} --version + OUTPUT_VARIABLE _GXX_OUTPUT) + # is the following too fragile? + string(REGEX REPLACE ".* ([0-9]\\.[0-9](\\.[0-9])?)( |\n).*" "\\1" + GNUCXX_VERSION "${_GXX_OUTPUT}") + message(STATUS "g++ version ${GNUCXX_VERSION}") + if (GNUCXX_VERSION VERSION_LESS ${GNUCXX_MINVER}) + message(FATAL_ERROR "A minimum of g++ ${GNUCXX_MINVER} is required for C++11 support") + endif() + unset(_GXX_OUTPUT) + endif() + + # set compiler flags - more are tested and added later + set(EXTRA_C_FLAGS "-std=c99 -Wall -Wextra -Wshadow -Wcast-qual -Werror") + set(EXTRA_CXX_FLAGS "-std=c++11 -Wall -Wextra -Werror -Wno-shadow -Wswitch -Wreturn-type -Wcast-qual -Wno-deprecated -Wnon-virtual-dtor") + + if (NOT CMAKE_C_FLAGS MATCHES .*march.*) + message(STATUS "Building for current host CPU") + set(EXTRA_C_FLAGS "${EXTRA_C_FLAGS} -march=native -mtune=native") + endif() + if (NOT CMAKE_CXX_FLAGS MATCHES .*march.*) + set(EXTRA_CXX_FLAGS "${EXTRA_CXX_FLAGS} -march=native -mtune=native") + endif() + + if(CMAKE_COMPILER_IS_GNUCC) + # spurious warnings? + set(EXTRA_C_FLAGS "${EXTRA_C_FLAGS} -Wno-array-bounds -Wno-maybe-uninitialized") + endif() + + if(CMAKE_COMPILER_IS_GNUCXX) + set(EXTRA_CXX_FLAGS "${EXTRA_CXX_FLAGS} -fabi-version=0 -Wno-unused-local-typedefs -Wno-maybe-uninitialized") + endif() + + if(OPTIMISE) + set(EXTRA_C_FLAGS "-O3 ${EXTRA_C_FLAGS}") + set(EXTRA_CXX_FLAGS "-O2 ${EXTRA_CXX_FLAGS}") + else() + set(EXTRA_C_FLAGS "-O0 ${EXTRA_C_FLAGS}") + set(EXTRA_CXX_FLAGS "-O0 ${EXTRA_CXX_FLAGS}") + endif(OPTIMISE) + + if(NOT RELEASE_BUILD) + set(EXTRA_C_FLAGS "${EXTRA_C_FLAGS} -fno-omit-frame-pointer") + set(EXTRA_CXX_FLAGS "${EXTRA_CXX_FLAGS} -fno-omit-frame-pointer") + endif() + +endif() + +CHECK_INCLUDE_FILES(unistd.h HAVE_UNISTD_H) +CHECK_INCLUDE_FILES(intrin.h HAVE_C_INTRIN_H) +CHECK_INCLUDE_FILE_CXX(intrin.h HAVE_CXX_INTRIN_H) +CHECK_INCLUDE_FILES(tmmintrin.h HAVE_TMMINTRIN_H) +CHECK_INCLUDE_FILES(x86intrin.h HAVE_C_X86INTRIN_H) +CHECK_INCLUDE_FILE_CXX(x86intrin.h HAVE_CXX_X86INTRIN_H) + +CHECK_FUNCTION_EXISTS(posix_memalign HAVE_POSIX_MEMALIGN) +CHECK_FUNCTION_EXISTS(_aligned_malloc HAVE__ALIGNED_MALLOC) + +# these end up in the config file +CHECK_C_COMPILER_FLAG(-fvisibility=hidden HAS_C_HIDDEN) +CHECK_CXX_COMPILER_FLAG(-fvisibility=hidden HAS_CXX_HIDDEN) + +# testing a builtin takes a little more work +CHECK_C_SOURCE_COMPILES("void *aa_test(void *x) { return __builtin_assume_aligned(x, 16);}\nint main(void) { return 0; }" HAVE_CC_BUILTIN_ASSUME_ALIGNED) +CHECK_CXX_SOURCE_COMPILES("void *aa_test(void *x) { return __builtin_assume_aligned(x, 16);}\nint main(void) { return 0; }" HAVE_CXX_BUILTIN_ASSUME_ALIGNED) + +if (NOT WIN32) +set(C_FLAGS_TO_CHECK +# Variable length arrays are way bad, most especially at run time +"-Wvla" +# Pointer arith on void pointers is doing it wong. + "-Wpointer-arith" +# Build our C code with -Wstrict-prototypes -Wmissing-prototypes + "-Wstrict-prototypes" + "-Wmissing-prototypes" +) +foreach (FLAG ${C_FLAGS_TO_CHECK}) + # munge the name so it doesn't break things + string(REPLACE "-" "_" FNAME C_FLAG${FLAG}) + CHECK_C_COMPILER_FLAG("${FLAG}" ${FNAME}) + if (${FNAME}) + set(EXTRA_C_FLAGS "${EXTRA_C_FLAGS} ${FLAG}") + endif() +endforeach() + +set(CXX_FLAGS_TO_CHECK +"-Wvla" +"-Wpointer-arith" +) +foreach (FLAG ${CXX_FLAGS_TO_CHECK}) + string(REPLACE "-" "_" FNAME CXX_FLAG${FLAG}) + CHECK_CXX_COMPILER_FLAG("${FLAG}" ${FNAME}) + if (${FNAME}) + set(EXTRA_CXX_FLAGS "${EXTRA_CXX_FLAGS} ${FLAG}") + endif() +endforeach() + +# self-assign should be thrown away, but clang whinges +CHECK_C_COMPILER_FLAG("-Wself-assign" CC_SELF_ASSIGN) +if (CC_SELF_ASSIGN) + set(EXTRA_C_FLAGS "${EXTRA_C_FLAGS} -Wno-self-assign") +endif() +CHECK_CXX_COMPILER_FLAG("-Wself-assign" CXX_SELF_ASSIGN) +if (CXX_SELF_ASSIGN) + set(EXTRA_CXX_FLAGS "${EXTRA_CXX_FLAGS} -Wno-self-assign") +endif() + +# clang gets up in our face for going paren crazy with macros +CHECK_C_COMPILER_FLAG("-Wparentheses-equality" CC_PAREN_EQUALITY) +if (CC_PAREN_EQUALITY) + set(EXTRA_C_FLAGS "${EXTRA_C_FLAGS} -Wno-parentheses-equality") +endif() + +# clang compains about unused const vars in our Ragel-generated code. +CHECK_CXX_COMPILER_FLAG("-Wunused-const-variable" CXX_UNUSED_CONST_VAR) +if (CXX_UNUSED_CONST_VAR) + set(EXTRA_CXX_FLAGS "${EXTRA_CXX_FLAGS} -Wno-unused-const-variable") +endif() + + +# note this for later +# g++ doesn't have this flag but clang does +CHECK_CXX_COMPILER_FLAG("-Wweak-vtables" CXX_WEAK_VTABLES) +if (CXX_WEAK_VTABLES) + set(EXTRA_CXX_FLAGS "${EXTRA_CXX_FLAGS} -Wweak-vtables") +endif() + +CHECK_CXX_COMPILER_FLAG("-Wmissing-declarations" CXX_MISSING_DECLARATIONS) +if (CXX_MISSING_DECLARATIONS) + set(EXTRA_CXX_FLAGS "${EXTRA_CXX_FLAGS} -Wmissing-declarations") +endif() + +# gcc5 complains about this +CHECK_CXX_COMPILER_FLAG("-Wunused-variable" CXX_WUNUSED_VARIABLE) + +endif() + +if (NOT XCODE) + include_directories(SYSTEM ${Boost_INCLUDE_DIR}) +else() + # cmake doesn't think Xcode supports isystem + set(EXTRA_CXX_FLAGS "${EXTRA_CXX_FLAGS} -isystem ${Boost_INCLUDE_DIR}") +endif() + + +if(CMAKE_SYSTEM_NAME MATCHES "Linux") + set(LINUX TRUE) +endif(CMAKE_SYSTEM_NAME MATCHES "Linux") + +if(CMAKE_SYSTEM_NAME MATCHES "FreeBSD") + set(FREEBSD true) +endif(CMAKE_SYSTEM_NAME MATCHES "FreeBSD") + +if(NOT WIN32) +if(CMAKE_C_COMPILER_ID MATCHES "Intel") + SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -diag-error 10006 -diag-disable 177 -diag-disable 2304 -diag-disable 2305 -diag-disable 2338 -diag-disable 1418 -diag-disable=remark") +endif() +if(CMAKE_CXX_COMPILER_ID MATCHES "Intel") + SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -diag-error 10006 -diag-disable 177 -diag-disable 2304 -diag-disable 2305 -diag-disable 2338 -diag-disable 1418 -diag-disable 1170 -diag-disable 3373 -diag-disable=remark") +endif() +endif() + +add_subdirectory(util) +add_subdirectory(unit) +add_subdirectory(doc/dev-reference) +if (EXISTS ${CMAKE_SOURCE_DIR}/tools) + add_subdirectory(tools) +endif() + +# do substitutions +configure_file(${CMAKE_MODULE_PATH}/config.h.in ${CMAKE_BINARY_DIR}/config.h) +configure_file(src/hs_version.h.in hs_version.h) + +if (PKG_CONFIG_FOUND) + # we really only need to do this if we have pkg-config + configure_file(libhs.pc.in libhs.pc @ONLY) # only replace @ quoted vars + install(FILES ${CMAKE_BINARY_DIR}/libhs.pc + DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/pkgconfig") +endif() + +# only set these after all tests are done +set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${EXTRA_C_FLAGS}") +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${EXTRA_CXX_FLAGS}") + + +# include the autogen targets +add_subdirectory(src/fdr) + +include_directories(${CMAKE_BINARY_DIR}/src/fdr) + +if(NOT WIN32) +set(RAGEL_C_FLAGS "-Wno-unused") +endif() + +set_source_files_properties( + ${CMAKE_BINARY_DIR}/src/parser/Parser.cpp + PROPERTIES + COMPILE_FLAGS "${RAGEL_C_FLAGS}") + +ragelmaker(src/parser/Parser.rl) + +SET(hs_HEADERS + src/hs.h + src/hs_common.h + src/hs_compile.h + src/hs_runtime.h +) +install(FILES ${hs_HEADERS} DESTINATION include/hs) + +set(fdr_autogen_targets autogen_runtime autogen_teddy_runtime) + +set (hs_exec_SRCS + ${hs_HEADERS} + src/hs_version.h + src/ue2common.h + src/alloc.c + src/allocator.h + src/runtime.c + src/fdr/fdr.c + src/fdr/fdr.h + src/fdr/fdr_internal.h + src/fdr/fdr_confirm.h + src/fdr/fdr_confirm_runtime.h + src/fdr/fdr_streaming_runtime.h + src/fdr/flood_runtime.h + src/fdr/fdr_loadval.h + src/fdr/teddy.c + src/fdr/teddy_internal.h + src/hwlm/hwlm.c + src/hwlm/hwlm.h + src/hwlm/hwlm_internal.h + src/hwlm/noodle_engine.c + src/hwlm/noodle_engine.h + src/hwlm/noodle_internal.h + src/nfa/accel.c + src/nfa/accel.h + src/nfa/castle.c + src/nfa/castle.h + src/nfa/castle_internal.h + src/nfa/gough.c + src/nfa/gough_internal.h + src/nfa/lbr.c + src/nfa/lbr.h + src/nfa/lbr_common_impl.h + src/nfa/lbr_internal.h + src/nfa/mcclellan.c + src/nfa/mcclellan.h + src/nfa/mcclellan_common_impl.h + src/nfa/mcclellan_internal.h + src/nfa/limex_accel.c + src/nfa/limex_accel.h + src/nfa/limex_exceptional.h + src/nfa/limex_native.c + src/nfa/limex_ring.h + src/nfa/limex_simd128.c + src/nfa/limex_simd256.c + src/nfa/limex_simd384.c + src/nfa/limex_simd512a.c + src/nfa/limex_simd512b.c + src/nfa/limex_simd512c.c + src/nfa/limex.h + src/nfa/limex_common_impl.h + src/nfa/limex_context.h + src/nfa/limex_internal.h + src/nfa/limex_runtime.h + src/nfa/limex_runtime_impl.h + src/nfa/limex_state_impl.h + src/nfa/mpv.h + src/nfa/mpv.c + src/nfa/mpv_internal.h + src/nfa/nfa_api.h + src/nfa/nfa_api_dispatch.c + src/nfa/nfa_internal.h + src/nfa/nfa_rev_api.h + src/nfa/repeat.c + src/nfa/repeat.h + src/nfa/repeat_internal.h + src/nfa/shufti.c + src/nfa/shufti.h + src/nfa/truffle.c + src/nfa/truffle.h + src/nfa/vermicelli.h + src/nfa/vermicelli_run.h + src/nfa/vermicelli_sse.h + src/sidecar/sidecar.c + src/sidecar/sidecar.h + src/sidecar/sidecar_generic.h + src/sidecar/sidecar_internal.h + src/sidecar/sidecar_shufti.c + src/sidecar/sidecar_shufti.h + src/som/som.h + src/som/som_runtime.h + src/som/som_runtime.c + src/som/som_stream.c + src/som/som_stream.h + src/rose/block.c + src/rose/catchup.h + src/rose/catchup.c + src/rose/eod.c + src/rose/infix.h + src/rose/init.h + src/rose/init.c + src/rose/stream.c + src/rose/match.h + src/rose/match.c + src/rose/miracle.h + src/rose/runtime.h + src/rose/rose_sidecar_runtime.h + src/rose/rose.h + src/rose/rose_internal.h + src/rose/rose_types.h + src/rose/rose_common.h + src/util/bitutils.h + src/util/exhaust.h + src/util/fatbit.h + src/util/fatbit.c + src/util/join.h + src/util/masked_move.c + src/util/masked_move.h + src/util/multibit.h + src/util/multibit_internal.h + src/util/multibit.c + src/util/pack_bits.h + src/util/popcount.h + src/util/pqueue.h + src/util/scatter.h + src/util/scatter_runtime.h + src/util/shuffle.h + src/util/shuffle_ssse3.h + src/util/simd_utils.h + src/util/simd_utils_ssse3.h + src/util/state_compress.h + src/util/state_compress.c + src/util/unaligned.h + src/util/uniform_ops.h + src/scratch.h + src/scratch.c + src/crc32.c + src/crc32.h + src/database.c + src/database.h +) + + +SET (hs_SRCS + ${hs_HEADERS} + src/crc32.h + src/database.h + src/grey.cpp + src/grey.h + src/hs.cpp + src/hs_internal.h + src/hs_version.c + src/hs_version.h + src/scratch.h + src/state.h + src/ue2common.h + src/compiler/asserts.cpp + src/compiler/asserts.h + src/compiler/compiler.cpp + src/compiler/compiler.h + src/compiler/error.cpp + src/compiler/error.h + src/fdr/engine_description.cpp + src/fdr/engine_description.h + src/fdr/fdr_compile.cpp + src/fdr/fdr_compile.h + src/fdr/fdr_compile_internal.h + src/fdr/fdr_compile_util.cpp + src/fdr/fdr_confirm_compile.cpp + src/fdr/fdr_confirm.h + src/fdr/fdr_engine_description.cpp + src/fdr/fdr_engine_description.h + src/fdr/fdr_internal.h + src/fdr/fdr_streaming_compile.cpp + src/fdr/fdr_streaming_internal.h + src/fdr/flood_compile.cpp + src/fdr/teddy_compile.cpp + src/fdr/teddy_compile.h + src/fdr/teddy_engine_description.cpp + src/fdr/teddy_engine_description.h + src/fdr/teddy_internal.h + src/hwlm/hwlm_build.cpp + src/hwlm/hwlm_build.h + src/hwlm/hwlm_internal.h + src/hwlm/hwlm_literal.cpp + src/hwlm/hwlm_literal.h + src/hwlm/noodle_build.cpp + src/hwlm/noodle_build.h + src/hwlm/noodle_internal.h + src/nfa/accel.h + src/nfa/accelcompile.cpp + src/nfa/accelcompile.h + src/nfa/callback.h + src/nfa/castlecompile.cpp + src/nfa/castlecompile.h + src/nfa/dfa_min.cpp + src/nfa/dfa_min.h + src/nfa/goughcompile.cpp + src/nfa/goughcompile.h + src/nfa/goughcompile_accel.cpp + src/nfa/goughcompile_internal.h + src/nfa/goughcompile_reg.cpp + src/nfa/mcclellan.h + src/nfa/mcclellan_internal.h + src/nfa/mcclellancompile.cpp + src/nfa/mcclellancompile.h + src/nfa/mcclellancompile_util.cpp + src/nfa/mcclellancompile_util.h + src/nfa/limex_compile.cpp + src/nfa/limex_compile.h + src/nfa/limex_accel.h + src/nfa/limex_internal.h + src/nfa/mpv_internal.h + src/nfa/mpvcompile.cpp + src/nfa/mpvcompile.h + src/nfa/nfa_api.h + src/nfa/nfa_api_queue.h + src/nfa/nfa_api_util.h + src/nfa/nfa_build_util.cpp + src/nfa/nfa_build_util.h + src/nfa/nfa_internal.h + src/nfa/nfa_kind.h + src/nfa/rdfa.h + src/nfa/rdfa_merge.cpp + src/nfa/rdfa_merge.h + src/nfa/repeat_internal.h + src/nfa/repeatcompile.cpp + src/nfa/repeatcompile.h + src/nfa/shufticompile.cpp + src/nfa/shufticompile.h + src/nfa/trufflecompile.cpp + src/nfa/trufflecompile.h + src/nfagraph/ng.cpp + src/nfagraph/ng.h + src/nfagraph/ng_anchored_acyclic.cpp + src/nfagraph/ng_anchored_acyclic.h + src/nfagraph/ng_anchored_dots.cpp + src/nfagraph/ng_anchored_dots.h + src/nfagraph/ng_asserts.cpp + src/nfagraph/ng_asserts.h + src/nfagraph/ng_builder.cpp + src/nfagraph/ng_builder.h + src/nfagraph/ng_calc_components.cpp + src/nfagraph/ng_calc_components.h + src/nfagraph/ng_cyclic_redundancy.cpp + src/nfagraph/ng_cyclic_redundancy.h + src/nfagraph/ng_depth.cpp + src/nfagraph/ng_depth.h + src/nfagraph/ng_dominators.cpp + src/nfagraph/ng_dominators.h + src/nfagraph/ng_edge_redundancy.cpp + src/nfagraph/ng_edge_redundancy.h + src/nfagraph/ng_equivalence.cpp + src/nfagraph/ng_equivalence.h + src/nfagraph/ng_execute.cpp + src/nfagraph/ng_execute.h + src/nfagraph/ng_expr_info.cpp + src/nfagraph/ng_expr_info.h + src/nfagraph/ng_extparam.cpp + src/nfagraph/ng_extparam.h + src/nfagraph/ng_fixed_width.cpp + src/nfagraph/ng_fixed_width.h + src/nfagraph/ng_graph.h + src/nfagraph/ng_haig.cpp + src/nfagraph/ng_haig.h + src/nfagraph/ng_holder.cpp + src/nfagraph/ng_holder.h + src/nfagraph/ng_is_equal.cpp + src/nfagraph/ng_is_equal.h + src/nfagraph/ng_lbr.cpp + src/nfagraph/ng_lbr.h + src/nfagraph/ng_literal_analysis.cpp + src/nfagraph/ng_literal_analysis.h + src/nfagraph/ng_literal_component.cpp + src/nfagraph/ng_literal_component.h + src/nfagraph/ng_literal_decorated.cpp + src/nfagraph/ng_literal_decorated.h + src/nfagraph/ng_mcclellan.cpp + src/nfagraph/ng_mcclellan.h + src/nfagraph/ng_mcclellan_internal.h + src/nfagraph/ng_limex.cpp + src/nfagraph/ng_limex.h + src/nfagraph/ng_limex_accel.cpp + src/nfagraph/ng_limex_accel.h + src/nfagraph/ng_misc_opt.cpp + src/nfagraph/ng_misc_opt.h + src/nfagraph/ng_netflow.cpp + src/nfagraph/ng_netflow.h + src/nfagraph/ng_prefilter.cpp + src/nfagraph/ng_prefilter.h + src/nfagraph/ng_prune.cpp + src/nfagraph/ng_prune.h + src/nfagraph/ng_puff.cpp + src/nfagraph/ng_puff.h + src/nfagraph/ng_redundancy.cpp + src/nfagraph/ng_redundancy.h + src/nfagraph/ng_region.cpp + src/nfagraph/ng_region.h + src/nfagraph/ng_region_redundancy.cpp + src/nfagraph/ng_region_redundancy.h + src/nfagraph/ng_repeat.cpp + src/nfagraph/ng_repeat.h + src/nfagraph/ng_reports.cpp + src/nfagraph/ng_reports.h + src/nfagraph/ng_restructuring.cpp + src/nfagraph/ng_restructuring.h + src/nfagraph/ng_revacc.cpp + src/nfagraph/ng_revacc.h + src/nfagraph/ng_rose.cpp + src/nfagraph/ng_rose.h + src/nfagraph/ng_sep.cpp + src/nfagraph/ng_sep.h + src/nfagraph/ng_small_literal_set.cpp + src/nfagraph/ng_small_literal_set.h + src/nfagraph/ng_som.cpp + src/nfagraph/ng_som.h + src/nfagraph/ng_som_add_redundancy.cpp + src/nfagraph/ng_som_add_redundancy.h + src/nfagraph/ng_som_util.cpp + src/nfagraph/ng_som_util.h + src/nfagraph/ng_split.cpp + src/nfagraph/ng_split.h + src/nfagraph/ng_squash.cpp + src/nfagraph/ng_squash.h + src/nfagraph/ng_stop.cpp + src/nfagraph/ng_stop.h + src/nfagraph/ng_uncalc_components.cpp + src/nfagraph/ng_uncalc_components.h + src/nfagraph/ng_undirected.h + src/nfagraph/ng_utf8.cpp + src/nfagraph/ng_utf8.h + src/nfagraph/ng_util.cpp + src/nfagraph/ng_util.h + src/nfagraph/ng_vacuous.cpp + src/nfagraph/ng_vacuous.h + src/nfagraph/ng_width.cpp + src/nfagraph/ng_width.h + src/parser/AsciiComponentClass.cpp + src/parser/AsciiComponentClass.h + src/parser/Component.cpp + src/parser/Component.h + src/parser/ComponentAlternation.cpp + src/parser/ComponentAlternation.h + src/parser/ComponentAssertion.cpp + src/parser/ComponentAssertion.h + src/parser/ComponentAtomicGroup.cpp + src/parser/ComponentAtomicGroup.h + src/parser/ComponentBackReference.cpp + src/parser/ComponentBackReference.h + src/parser/ComponentBoundary.cpp + src/parser/ComponentBoundary.h + src/parser/ComponentByte.cpp + src/parser/ComponentByte.h + src/parser/ComponentClass.cpp + src/parser/ComponentClass.h + src/parser/ComponentCondReference.cpp + src/parser/ComponentCondReference.h + src/parser/ComponentEUS.cpp + src/parser/ComponentEUS.h + src/parser/ComponentEmpty.cpp + src/parser/ComponentEmpty.h + src/parser/ComponentRepeat.cpp + src/parser/ComponentRepeat.h + src/parser/ComponentSequence.cpp + src/parser/ComponentSequence.h + src/parser/ComponentVisitor.cpp + src/parser/ComponentVisitor.h + src/parser/ComponentWordBoundary.cpp + src/parser/ComponentWordBoundary.h + src/parser/ConstComponentVisitor.cpp + src/parser/ConstComponentVisitor.h + src/parser/Parser.cpp + src/parser/Parser.h + src/parser/Utf8ComponentClass.cpp + src/parser/Utf8ComponentClass.h + src/parser/buildstate.cpp + src/parser/buildstate.h + src/parser/check_refs.cpp + src/parser/check_refs.h + src/parser/parse_error.cpp + src/parser/parse_error.h + src/parser/parser_util.cpp + src/parser/position.h + src/parser/position_info.h + src/parser/prefilter.cpp + src/parser/prefilter.h + src/parser/shortcut_literal.cpp + src/parser/shortcut_literal.h + src/parser/ucp_table.cpp + src/parser/ucp_table.h + src/parser/unsupported.cpp + src/parser/unsupported.h + src/parser/utf8_validate.h + src/parser/utf8_validate.cpp + src/sidecar/sidecar_compile.cpp + src/sidecar/sidecar_compile.h + src/smallwrite/smallwrite_build.cpp + src/smallwrite/smallwrite_build.h + src/smallwrite/smallwrite_internal.h + src/som/slot_manager.cpp + src/som/slot_manager.h + src/som/slot_manager_internal.h + src/som/som.h + src/rose/rose_build.h + src/rose/rose_build_add.cpp + src/rose/rose_build_add_internal.h + src/rose/rose_build_add_mask.cpp + src/rose/rose_build_anchored.cpp + src/rose/rose_build_anchored.h + src/rose/rose_build_bytecode.cpp + src/rose/rose_build_compile.cpp + src/rose/rose_build_convert.cpp + src/rose/rose_build_convert.h + src/rose/rose_build_impl.h + src/rose/rose_build_infix.cpp + src/rose/rose_build_infix.h + src/rose/rose_build_lookaround.cpp + src/rose/rose_build_lookaround.h + src/rose/rose_build_merge.cpp + src/rose/rose_build_merge.h + src/rose/rose_build_misc.cpp + src/rose/rose_build_role_aliasing.cpp + src/rose/rose_build_scatter.cpp + src/rose/rose_build_scatter.h + src/rose/rose_build_util.h + src/rose/rose_build_width.cpp + src/rose/rose_build_width.h + src/rose/rose_graph.h + src/rose/rose_in_graph.h + src/rose/rose_in_util.cpp + src/rose/rose_in_util.h + src/util/alloc.cpp + src/util/alloc.h + src/util/bitfield.h + src/util/boundary_reports.h + src/util/charreach.cpp + src/util/charreach.h + src/util/charreach_util.h + src/util/compare.h + src/util/compile_context.cpp + src/util/compile_context.h + src/util/compile_error.cpp + src/util/compile_error.h + src/util/container.h + src/util/cpuid_flags.c + src/util/cpuid_flags.h + src/util/depth.cpp + src/util/depth.h + src/util/determinise.h + src/util/dump_mask.cpp + src/util/dump_mask.h + src/util/graph.h + src/util/internal_report.h + src/util/multibit_build.cpp + src/util/multibit_build.h + src/util/order_check.h + src/util/partial_store.h + src/util/partitioned_set.h + src/util/popcount.h + src/util/queue_index_factory.h + src/util/report.cpp + src/util/report.h + src/util/report_manager.cpp + src/util/report_manager.h + src/util/simd_utils.h + src/util/simd_utils_ssse3.h + src/util/target_info.cpp + src/util/target_info.h + src/util/ue2_containers.h + src/util/ue2string.cpp + src/util/ue2string.h + src/util/unaligned.h + src/util/unicode_def.h + src/util/unicode_set.h + src/util/uniform_ops.h + src/util/verify_types.h +) + +set(hs_dump_SRCS + src/scratch_dump.cpp + src/scratch_dump.h + src/fdr/fdr_dump.cpp + src/hwlm/hwlm_dump.cpp + src/hwlm/hwlm_dump.h + src/nfa/accel_dump.cpp + src/nfa/accel_dump.h + src/nfa/castle_dump.cpp + src/nfa/castle_dump.h + src/nfagraph/ng_dump.cpp + src/nfagraph/ng_dump.h + src/nfa/goughcompile_dump.cpp + src/nfa/goughcompile_dump.h + src/nfa/goughdump.cpp + src/nfa/goughdump.h + src/nfa/lbr_dump.cpp + src/nfa/limex_dump.cpp + src/nfa/mcclellandump.cpp + src/nfa/mcclellandump.h + src/nfa/mpv_dump.cpp + src/nfa/nfa_dump_api.h + src/nfa/nfa_dump_dispatch.cpp + src/nfa/nfa_dump_internal.cpp + src/nfa/nfa_dump_internal.h + src/parser/dump.cpp + src/parser/dump.h + src/parser/position_dump.h + src/sidecar/sidecar_dump.cpp + src/sidecar/sidecar_dump.h + src/smallwrite/smallwrite_dump.cpp + src/smallwrite/smallwrite_dump.h + src/som/slot_manager_dump.cpp + src/som/slot_manager_dump.h + src/rose/rose_build_dump.cpp + src/rose/rose_build_dump.h + src/rose/rose_in_dump.cpp + src/rose/rose_in_dump.h + src/rose/rose_dump.cpp + src/rose/rose_dump.h + src/util/dump_charclass.cpp + src/util/dump_charclass.h +) + +if (DUMP_SUPPORT) + set(hs_SRCS ${hs_SRCS} ${hs_dump_SRCS}) +endif() + +# we group things by sublibraries, specifying shared and static and then +# choose which ones to build + +set (LIB_VERSION ${HS_VERSION}) +set (LIB_SOVERSION ${HS_MAJOR_VERSION}.${HS_MINOR_VERSION}) + +add_library(hs_exec OBJECT ${hs_exec_SRCS}) +add_dependencies(hs_exec ${fdr_autogen_targets}) + +if (BUILD_STATIC_AND_SHARED OR BUILD_SHARED_LIBS) +add_library(hs_exec_shared OBJECT ${hs_exec_SRCS}) +add_dependencies(hs_exec_shared ${fdr_autogen_targets}) +set_target_properties(hs_exec_shared PROPERTIES + POSITION_INDEPENDENT_CODE TRUE) +endif() + +# hs_version.c is added explicitly to avoid some build systems that refuse to +# create a lib without any src (I'm looking at you Xcode) + +add_library(hs_runtime STATIC src/hs_version.c $) + +set_target_properties(hs_runtime PROPERTIES + LINKER_LANGUAGE C) +if (NOT BUILD_SHARED_LIBS) + install(TARGETS hs_runtime DESTINATION lib) +endif() + +if (BUILD_STATIC_AND_SHARED OR BUILD_SHARED_LIBS) + add_library(hs_runtime_shared SHARED src/hs_version.c $) + set_target_properties(hs_runtime_shared PROPERTIES + VERSION ${LIB_VERSION} + SOVERSION ${LIB_SOVERSION} + OUTPUT_NAME hs_runtime + MACOSX_RPATH ON + LINKER_LANGUAGE C) + install(TARGETS hs_runtime_shared DESTINATION lib) +endif() + +# we want the static lib for testing +add_library(hs STATIC ${hs_SRCS} $) + +add_dependencies(hs ragel_Parser) +add_dependencies(hs autogen_compiler autogen_teddy_compiler) + +if (NOT BUILD_SHARED_LIBS) +install(TARGETS hs DESTINATION lib) +endif() + +if (BUILD_STATIC_AND_SHARED OR BUILD_SHARED_LIBS) + add_library(hs_shared SHARED ${hs_SRCS} $) + add_dependencies(hs_shared ragel_Parser) + add_dependencies(hs_shared autogen_compiler autogen_teddy_compiler) + set_target_properties(hs_shared PROPERTIES + OUTPUT_NAME hs + VERSION ${LIB_VERSION} + SOVERSION ${LIB_SOVERSION} + MACOSX_RPATH ON) +install(TARGETS hs_shared DESTINATION lib) +endif() + +if(NOT WIN32) + add_subdirectory(examples) +endif() diff --git a/COPYING b/COPYING new file mode 100644 index 00000000..ef9b24fb --- /dev/null +++ b/COPYING @@ -0,0 +1,26 @@ +Copyright (c) 2015, Intel Corporation + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of Intel Corporation nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..30c57a80 --- /dev/null +++ b/LICENSE @@ -0,0 +1,118 @@ +Hyperscan is licensed under the BSD License. + +Copyright (c) 2015, Intel Corporation + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of Intel Corporation nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +-------------------------------------------------------------------------------- + +This product also contains code from third parties, under the following +licenses: + +Intel's Slicing-by-8 CRC32 implementation +----------------------------------------- + +Copyright (c) 2004-2006, Intel Corporation +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +Boost C++ Headers Library +------------------------- + +Boost Software License - Version 1.0 - August 17th, 2003 + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by +this license (the "Software") to use, reproduce, display, distribute, +execute, and transmit the Software, and to prepare derivative works of the +Software, and to permit third-parties to whom the Software is furnished to +do so, all subject to the following: + +The copyright notices in the Software and this entire statement, including +the above license grant, this restriction and the following disclaimer, +must be included in all copies of the Software, in whole or in part, and +all derivative works of the Software, unless such copies or derivative +works are solely in the form of machine-executable object code generated by +a source language processor. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +The Google C++ Testing Framework (Google Test) +---------------------------------------------- + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google Inc. nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + diff --git a/README.md b/README.md new file mode 100644 index 00000000..37fc38ce --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Hyperscan + +Hyperscan is a high-performance multiple regex matching library. It follows the +regular expression syntax of the commonly-used libpcre library, but is a +standalone library with its own C API. + +Hyperscan uses hybrid automata techniques to allow simultaneous matching of +large numbers (up to tens of thousands) of regular expressions and for the +matching of regular expressions across streams of data. + +Hyperscan is typically used in a DPI library stack. + +# Documentation + +Information on building the Hyperscan library and using its API is available in +the [Developer Reference Guide](http://01org.github.io/hyperscan/dev-reference/). + +# License + +Hyperscan is licensed under the BSD License. See the LICENSE file in the +project repository. + diff --git a/cmake/backtrace.cmake b/cmake/backtrace.cmake new file mode 100644 index 00000000..b8ad79f6 --- /dev/null +++ b/cmake/backtrace.cmake @@ -0,0 +1,54 @@ +# The `backtrace' function is available on Linux via glibc, and on FreeBSD if +# the 'libexecinfo' package is installed. + +CHECK_C_SOURCE_COMPILES( + "#include \n#include \nint main () { backtrace(NULL, 0); }" + BACKTRACE_LIBC) + +if(BACKTRACE_LIBC) + set(HAVE_BACKTRACE TRUE) + set(BACKTRACE_CFLAGS "") + set(BACKTRACE_LDFLAGS "") +endif() + +if(NOT BACKTRACE_LIBC) + # FreeBSD 10 has backtrace but requires libexecinfo + list(INSERT CMAKE_REQUIRED_LIBRARIES 0 "-lexecinfo") + CHECK_C_SOURCE_COMPILES( + "#include \n#include \nint main () { backtrace(NULL, 0); }" + BACKTRACE_LIBEXECINFO) + list(REMOVE_ITEM CMAKE_REQUIRED_LIBRARIES "-lexecinfo") + + if(BACKTRACE_LIBEXECINFO) + set(HAVE_BACKTRACE TRUE) + set(BACKTRACE_CFLAGS "") + set(BACKTRACE_LDFLAGS "-lexecinfo") + else() + # older FreeBSD requires it from ports + list(INSERT CMAKE_REQUIRED_INCLUDES 0 "/usr/local/include") + list(INSERT CMAKE_REQUIRED_LIBRARIES 0 "-L/usr/local/lib -lexecinfo") + CHECK_C_SOURCE_COMPILES( + "#include \n#include \nint main () { backtrace(NULL, 0); }" + BACKTRACE_LIBEXECINFO_LOCAL) + list(REMOVE_ITEM CMAKE_REQUIRED_INCLUDES 0 "/usr/local/include") + list(REMOVE_ITEM CMAKE_REQUIRED_LIBRARIES "-L/usr/local/lib -lexecinfo") + if(BACKTRACE_LIBEXECINFO_LOCAL) + set(HAVE_BACKTRACE TRUE) + set(BACKTRACE_CFLAGS "-I/usr/local/include") + set(BACKTRACE_LDFLAGS "-L/usr/local/lib -lexecinfo") + endif() + endif() +endif() + +if(HAVE_BACKTRACE) + CHECK_C_COMPILER_FLAG(-rdynamic HAS_RDYNAMIC) + if(HAS_RDYNAMIC) + list(INSERT BACKTRACE_LDFLAGS 0 -rdynamic) + endif() + # cmake scope fun + set(HAVE_BACKTRACE ${HAVE_BACKTRACE} PARENT_SCOPE) +else() + set(BACKTRACE_CFLAGS "") + set(BACKTRACE_LDFLAGS "") +endif() + diff --git a/cmake/config.h.in b/cmake/config.h.in new file mode 100644 index 00000000..63e0afc2 --- /dev/null +++ b/cmake/config.h.in @@ -0,0 +1,101 @@ +/* used by cmake */ + +/* "Define if the build is 32 bit" */ +#cmakedefine ARCH_32_BIT + +/* "Define if the build is 64 bit" */ +#cmakedefine ARCH_64_BIT + +/* "Define if building for IA32" */ +#cmakedefine ARCH_IA32 + +/* "Define if building for EM64T" */ +#cmakedefine ARCH_X86_64 + +/* internal build, switch on dump support. */ +#cmakedefine DUMP_SUPPORT + +/* Build tools with threading support */ +#cmakedefine ENABLE_TOOLS_THREADS + +/* Define to 1 if `backtrace' works. */ +#cmakedefine HAVE_BACKTRACE + +/* C compiler has __builtin_assume_aligned */ +#cmakedefine HAVE_CC_BUILTIN_ASSUME_ALIGNED + +/* C++ compiler has __builtin_assume_aligned */ +#cmakedefine HAVE_CXX_BUILTIN_ASSUME_ALIGNED + +/* C++ compiler has x86intrin.h */ +#cmakedefine HAVE_CXX_X86INTRIN_H + +/* C compiler has x86intrin.h */ +#cmakedefine HAVE_C_X86INTRIN_H + +/* C++ compiler has intrin.h */ +#cmakedefine HAVE_CXX_INTRIN_H + +/* C compiler has intrin.h */ +#cmakedefine HAVE_C_INTRIN_H + +/* Define to 1 if you have the declaration of `pthread_barrier_init', and to 0 + if you don't. */ +#cmakedefine HAVE_DECL_PTHREAD_BARRIER_INIT + +/* Define to 1 if you have the declaration of `pthread_setaffinity_np', and to + 0 if you don't. */ +#cmakedefine HAVE_DECL_PTHREAD_SETAFFINITY_NP + +/* Define to 1 if you have the `malloc_info' function. */ +#cmakedefine HAVE_MALLOC_INFO + +/* Define to 1 if you have the `memmem' function. */ +#cmakedefine HAVE_MEMMEM + +/* Define to 1 if you have a working `mmap' system call. */ +#cmakedefine HAVE_MMAP + +/* Define to 1 if `posix_memalign' works. */ +#cmakedefine HAVE_POSIX_MEMALIGN + +/* Define to 1 if you have the header file. */ +#cmakedefine HAVE_PTHREAD_H + +/* Define to 1 if you have the `setrlimit' function. */ +#cmakedefine HAVE_SETRLIMIT + +/* Define to 1 if you have the `shmget' function. */ +#cmakedefine HAVE_SHMGET + +/* Define to 1 if you have the `sigaction' function. */ +#cmakedefine HAVE_SIGACTION + +/* Define to 1 if you have the `sigaltstack' function. */ +#cmakedefine HAVE_SIGALTSTACK + +/* Define if the sqlite3_open_v2 call is available */ +#cmakedefine HAVE_SQLITE3_OPEN_V2 + +/* Define to 1 if you have the header file. */ +#cmakedefine HAVE_TMMINTRIN_H + +/* Define to 1 if you have the header file. */ +#cmakedefine HAVE_UNISTD_H + +/* Define to 1 if you have the `_aligned_malloc' function. */ +#cmakedefine HAVE__ALIGNED_MALLOC + +/* Optimize, inline critical functions */ +#cmakedefine HS_OPTIMIZE + +#cmakedefine HS_VERSION +#cmakedefine HS_MAJOR_VERSION +#cmakedefine HS_MINOR_VERSION +#cmakedefine HS_PATCH_VERSION + +#cmakedefine BUILD_DATE + +/* define if this is a release build. */ +#cmakedefine RELEASE_BUILD + diff --git a/cmake/platform.cmake b/cmake/platform.cmake new file mode 100644 index 00000000..593c544b --- /dev/null +++ b/cmake/platform.cmake @@ -0,0 +1,9 @@ +# determine the target arch + +# really only interested in the preprocessor here +CHECK_C_SOURCE_COMPILES("#if !(defined(__x86_64__) || defined(_M_X64))\n#error not 64bit\n#endif\nint main(void) { return 0; }" ARCH_64_BIT) + +CHECK_C_SOURCE_COMPILES("#if !(defined(__i386__) || defined(_M_IX86))\n#error not 64bit\n#endif\nint main(void) { return 0; }" ARCH_32_BIT) + +set(ARCH_X86_64 ${ARCH_64_BIT}) +set(ARCH_IA32 ${ARCH_32_BIT}) diff --git a/cmake/ragel.cmake b/cmake/ragel.cmake new file mode 100644 index 00000000..d3f0b926 --- /dev/null +++ b/cmake/ragel.cmake @@ -0,0 +1,16 @@ +# function for doing all the dirty work in turning a .rl into C++ + +function(ragelmaker src_rl) + get_filename_component(src_dir ${src_rl} PATH) # old cmake needs PATH + get_filename_component(src_file ${src_rl} NAME_WE) + set(rl_out ${CMAKE_CURRENT_BINARY_DIR}/${src_dir}/${src_file}.cpp) + add_custom_command( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${src_dir}/${src_file}.cpp + COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/${src_dir} + COMMAND ${RAGEL} ${CMAKE_CURRENT_SOURCE_DIR}/${src_rl} -o ${rl_out} + DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${src_rl} + ) + add_custom_target(ragel_${src_file} DEPENDS ${rl_out}) + set_source_files_properties(${rl_out} PROPERTIES GENERATED TRUE) +endfunction(ragelmaker) + diff --git a/doc/dev-reference/CMakeLists.txt b/doc/dev-reference/CMakeLists.txt new file mode 100644 index 00000000..449589f6 --- /dev/null +++ b/doc/dev-reference/CMakeLists.txt @@ -0,0 +1,35 @@ +find_program(DOXYGEN doxygen) + +if (DOXYGEN STREQUAL DOXYGEN-NOTFOUND) + message(STATUS "Doxygen not found, unable to generate API reference") +else() +configure_file("${CMAKE_CURRENT_SOURCE_DIR}/hyperscan.doxyfile.in" + "${CMAKE_CURRENT_BINARY_DIR}/hyperscan.doxyfile" @ONLY) + +add_custom_target(dev-reference-doxygen + ${DOXYGEN} ${CMAKE_CURRENT_BINARY_DIR}/hyperscan.doxyfile + COMMENT "Building doxygen XML for API reference") +endif() + +find_program(SPHINX_BUILD sphinx-build) + +if (SPHINX_BUILD STREQUAL SPHINX_BUILD-NOTFOUND) + message(STATUS "Sphinx not found, unable to generate developer reference") +else() +set(SPHINX_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/_build") +set(SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees") +set(SPHINX_HTML_DIR "${CMAKE_CURRENT_BINARY_DIR}/html") + +configure_file("${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in" + "${CMAKE_CURRENT_BINARY_DIR}/conf.py" @ONLY) + +add_custom_target(dev-reference + ${SPHINX_BUILD} + -b html + -c "${CMAKE_CURRENT_BINARY_DIR}" + -d "${SPHINX_CACHE_DIR}" + "${CMAKE_CURRENT_SOURCE_DIR}" + "${SPHINX_HTML_DIR}" + DEPENDS dev-reference-doxygen + COMMENT "Building HTML dev reference with Sphinx") +endif() diff --git a/doc/dev-reference/_static/hyperscan.css b/doc/dev-reference/_static/hyperscan.css new file mode 100644 index 00000000..581314ac --- /dev/null +++ b/doc/dev-reference/_static/hyperscan.css @@ -0,0 +1,4 @@ +/* Differentiate the way we display regex fragments. */ +.regexp { + color: darkred !important; +} diff --git a/doc/dev-reference/api_constants.rst b/doc/dev-reference/api_constants.rst new file mode 100644 index 00000000..bbe229de --- /dev/null +++ b/doc/dev-reference/api_constants.rst @@ -0,0 +1,53 @@ +.. _api_constants: + +######################## +API Reference: Constants +######################## + +*********** +Error Codes +*********** + +.. doxygengroup:: HS_ERROR + :content-only: + :no-link: + +***************** +hs_expr_ext flags +***************** + +.. doxygengroup:: HS_EXT_FLAG + :content-only: + :no-link: + +************* +Pattern flags +************* + +.. doxygengroup:: HS_PATTERN_FLAG + :content-only: + :no-link: + +************************* +CPU feature support flags +************************* + +.. doxygengroup:: HS_CPU_FEATURES_FLAG + :content-only: + :no-link: + +**************** +CPU tuning flags +**************** + +.. doxygengroup:: HS_TUNE_FLAG + :content-only: + :no-link: + +****************** +Compile mode flags +****************** + +.. doxygengroup:: HS_MODE_FLAG + :content-only: + :no-link: diff --git a/doc/dev-reference/api_files.rst b/doc/dev-reference/api_files.rst new file mode 100644 index 00000000..dd76cf72 --- /dev/null +++ b/doc/dev-reference/api_files.rst @@ -0,0 +1,29 @@ +.. _api_files: + +#################### +API Reference: Files +#################### + +********** +File: hs.h +********** + +.. doxygenfile:: hs.h + +***************** +File: hs_common.h +***************** + +.. doxygenfile:: hs_common.h + +****************** +File: hs_compile.h +****************** + +.. doxygenfile:: hs_compile.h + +****************** +File: hs_runtime.h +****************** + +.. doxygenfile:: hs_runtime.h diff --git a/doc/dev-reference/compilation.rst b/doc/dev-reference/compilation.rst new file mode 100644 index 00000000..6e195f6a --- /dev/null +++ b/doc/dev-reference/compilation.rst @@ -0,0 +1,365 @@ +.. include:: +.. _compilation: + +################## +Compiling Patterns +################## + +******************* +Building a Database +******************* + +The Hyperscan compiler API accepts regular expressions and converts them into a +compiled pattern database that can then be used to scan data. + +The API provides three functions that compile regular expressions into +databases: + +#. :c:func:`hs_compile`: compiles a single expression into a pattern database. + +#. :c:func:`hs_compile_multi`: compiles an array of expressions into a pattern + database. All of the supplied patterns will be scanned for concurrently at + scan time, with user-supplied identifiers returned when they match. + +#. :c:func:`hs_compile_ext_multi`: compiles an array of expressions as above, + but allows :ref:`extparam` to be specified for each expression. + +Compilation allows the Hyperscan library to analyze the given pattern(s) and +pre-determine how to scan for these patterns in an optimized fashion that would +be far too expensive to compute at run-time. + +When compiling expressions, a decision needs to be made whether the resulting +compiled patterns are to be used in a streaming, block or vectored mode: + +- **Streaming mode**: the target data to be scanned is a continuous stream, not + all of which is available at once; blocks of data are scanned in sequence and + matches may span multiple blocks in a stream. In streaming mode, each stream + requires a block of memory to store its state between scan calls. + +- **Block mode**: the target data is a discrete, contiguous block which can be + scanned in one call and does not require state to be retained. + +- **Vectored mode**: the target data consists of a list of non-contiguous + blocks that are available all at once. As for block mode, no retention of + state is required. + +To compile patterns to be used in streaming mode, the ``mode`` parameter of +:c:func:`hs_compile` must be set to :c:member:`HS_MODE_STREAM`; similarly, +block mode requires the use of :c:member:`HS_MODE_BLOCK` and vectored mode +requires the use of :c:member:`HS_MODE_VECTORED`. A pattern database compiled +for one mode (streaming, block or vectored) can only be used in that mode. The +version of Hyperscan used to produce a compiled pattern database must match the +version of Hyperscan used to scan with it. + +Hyperscan provides support for targeting a database at a particular CPU +platform; see :ref:`instr_specialization` for details. + +*************** +Pattern Support +*************** + +Hyperscan supports the pattern syntax used by the PCRE library ("libpcre"), +described at . However, not all constructs available in +libpcre are supported. The use of unsupported constructs will result in +compilation errors. + +==================== +Supported Constructs +==================== + +The following regex constructs are supported by Hyperscan: + +* Literal characters and strings, with all libpcre quoting and character + escapes. + +* Character classes such as :regexp:`.` (dot), :regexp:`[abc]`, and + :regexp:`[^abc]`, as well as the predefined character classes :regexp:`\\s`, + :regexp:`\\d`, :regexp:`\\w`, :regexp:`\\v`, and :regexp:`\\h` and their + negated counterparts (:regexp:`\\S`, :regexp:`\\D`, :regexp:`\\W`, + :regexp:`\\V`, and :regexp:`\\H`). + +* The POSIX named character classes :regexp:`[[:xxx:]]` and negated named + character classes :regexp:`[[:^xxx:]]`. + +* Unicode character properties, such as :regexp:`\\p{L}`, :regexp:`\\P{Sc}`, + :regexp:`\\p{Greek}`. + +* Quantifiers: + + * Quantifiers such as :regexp:`?`, :regexp:`*` and :regexp:`+` are supported + when applied to arbitrary supported sub-expressions. + + * Bounded repeat qualifiers such as :regexp:`{n}`, :regexp:`{m,n}`, + :regexp:`{n,}` are supported with limitations. + + * For arbitrary repeated sub-patterns: *n* and *m* should be either small + or infinite, e.g. :regexp:`(a|b}{4}`, :regexp:`(ab?c?d){4,10}` or + :regexp:`(ab(cd)*){6,}`. + + * For single-character width sub-patterns such as :regexp:`[^\\a]` or + :regexp:`.` or :regexp:`x`, nearly all repeat counts are supported, except + where repeats are extremely large (maximum bound greater than 32767). + Stream states may be very large for large bounded repeats, e.g. + :regexp:`a.{2000}b`. Note: such sub-patterns may be considerably + cheaper if at the beginning or end of patterns and especially if the + :c:member:`HS_FLAG_SINGLEMATCH` flag is on for that pattern. + + * Lazy modifiers (:regexp:`?` appended to another quantifier, e.g. + :regexp:`\\w+?`) are supported but ignored (as Hyperscan reports all + matches). + +* Parenthesization, including the named and unnamed capturing and + non-capturing forms. However, capturing is ignored. + +* Alternation with the :regexp:`|` symbol, as in :regexp:`foo|bar`. + +* The anchors :regexp:`^`, :regexp:`$`, :regexp:`\\A`, :regexp:`\\Z` and + :regexp:`\\z`. + +* Option modifiers for: + + * Case-sensitivity: :regexp:`(?i)` and :regexp:`(?-i)` + * Multi-line: :regexp:`(?m)` and :regexp:`(?-m)` + * Dot-all: :regexp:`(?s)` and :regexp:`(?-s)` + * Extended syntax: :regexp:`(?s)` and :regexp:`(?-s)` + +* The :regexp:`\\b` and :regexp:`\\B` zero-width assertions (word boundary and + 'not word boundary', respectively). + +* Comments in :regexp:`(?# comment)` syntax. + +* The :regexp:`(*UTF8)` and :regexp:`(*UCP)` control verbs at the beginning of a + pattern, used to enable UTF-8 and UCP mode. + +.. note:: Bounded-repeat quantifiers with large repeat counts of arbitrary + expressions (e.g. :regexp:`([a-z]|bc*d|xy?z){1000,5000}`) will result in a + "Pattern too large" error at pattern compile time. + +.. note:: At this time, not all patterns can be successfully compiled with the + :c:member:`HS_FLAG_SOM_LEFTMOST` flag, which enables per-pattern support for + :ref:`som`. The patterns that support this flag are a subset of patterns that + can be successfully compiled with Hyperscan; notably, many bounded repeat + forms that can be compiled with Hyperscan without the Start of Match flag + enabled cannot be compiled with the flag enabled. + +====================== +Unsupported Constructs +====================== + +The following regex constructs are not supported by Hyperscan: + +* Backreferences and capturing sub-expressions. +* Arbitrary zero-width assertions. +* Subroutine references and recursive patterns. +* Conditional patterns. +* Backtracking control verbs. +* The :regexp:`\\C` "single-byte" directive (which breaks UTF-8 sequences). +* The :regexp:`\\R` newline match. +* The :regexp:`\\K` start of match reset directive. +* Callouts and embedded code. +* Atomic grouping and possessive quantifiers. + +********* +Semantics +********* + +While Hyperscan follows libpcre syntax, it provides different semantics. The +major departures from libpcre semantics are motivated by the requirements of +streaming and multiple simultaneous pattern matching. + +The major departures from libpcre semantics are: + +#. **Multiple pattern matching**: Hyperscan allows matches to be reported for + several patterns simultaneously. This is not equivalent to separating the + patterns by :regexp:`|` in libpcre, which evaluates alternations + left-to-right. + +#. **Lack of ordering**: the multiple matches that Hyperscan produces are not + guaranteed to be ordered, although they will always fall within the bounds of + the current scan. + +#. **End offsets only**: Hyperscan's default behaviour is only to report the end + offset of a match. Reporting of the start offset can be enabled with + per-expression flags at pattern compile time. See :ref:`som` for details. + +#. **"All matches" reported**: scanning :regexp:`/foo.*bar/` against + ``fooxyzbarbar`` will return two matches from Hyperscan -- at the points + corresponding to the ends of ``fooxyzbar`` and ``fooxyzbarbar``. In contrast, + libpcre semantics by default would report only one match at ``fooxyzbarbar`` + (greedy semantics) or, if non-greedy semantics were switched on, one match at + ``fooxyzbar``. This means that switching between greedy and non-greedy + semantics is a no-op in Hyperscan. + +To support libpcre quantifier semantics while accurately reporting streaming +matches at the time they occur is impossible. For example, consider the pattern +above, :regexp:`/foo.*bar/`, in streaming mode, against the following +stream (three blocks scanned in sequence): + + ============= ======= ======== + block 1 block 2 block 3 + ============= ======= ======== + ``fooxyzbar`` ``baz`` ``qbar`` + ============= ======= ======== + +Since the :regexp:`.*` repeat in the pattern is a *greedy* repeat in libpcre, it +must match as much as possible without causing the rest of the pattern to fail. +However, in streaming mode, this would require knowledge of data in the stream +beyond the current block being scanned. + +In this example, the match at offset 9 in the first block is only the correct +match (under libpcre semantics) if there is no ``bar`` in a subsequent block -- +as in block 3 -- which would constitute a better match for the pattern. + +.. _som: + +============== +Start of Match +============== + +In standard operation, Hyperscan will only provide the end offset of a match +when the match callback is called. If the :c:member:`HS_FLAG_SOM_LEFTMOST` flag +is specified for a particular pattern, then the same set of matches is +returned, but each match will also provide the leftmost possible start offset +corresponding to its end offset. + +Using the SOM flag entails a number of trade-offs and limitations: + +* Reduced pattern support: For many patterns, tracking SOM is complex and can + result in Hyperscan failing to compile a pattern with a "Pattern too + large" error, even if the pattern is supported in normal operation. +* Increased stream state: At scan time, state space is required to track + potential SOM offsets, and this must be stored in persistent stream state in + streaming mode. Accordingly, SOM will generally increase the stream state + required to match a pattern. +* Performance overhead: Similarly, there is generally a performance cost + associated with tracking SOM. +* Incompatible features: Some other Hyperscan pattern flags (such as + :c:member:`HS_FLAG_SINGLEMATCH` and :c:member:`HS_FLAG_PREFILTER`) can not be + used in combination with SOM. Specifying them together with + :c:member:`HS_FLAG_SOM_LEFTMOST` will result in a compilation error. + +In streaming mode, the amount of precision delivered by SOM can be controlled +with the SOM horizon flags. These instruct Hyperscan to deliver accurate SOM +information within a certain distance of the end offset, and return a special +start offset of :c:member:`HS_OFFSET_PAST_HORIZON` otherwise. Specifying a +small or medium SOM horizon will usually reduce the stream state required for a +given database. + +.. note:: In streaming mode, the start offset returned for a match may refer to + a point in the stream *before* the current block being scanned. Hyperscan + provides no facility for accessing earlier blocks; if the calling application + needs to inspect historical data, then it must store it itself. + +.. _extparam: + +=================== +Extended Parameters +=================== + +In some circumstances, more control over the matching behaviour of a pattern is +required than can be specified easily using regular expression syntax. For +these scenarios, Hyperscan provides the :c:func:`hs_compile_ext_multi` function +that allows a set of "extended parameters" to be set on a per-pattern basis. + +Extended parameters are specified using an :c:type:`hs_expr_ext_t` structure, +which provides the following fields: + +* ``flags``: Flags governing which of the other fields in the structure are + used. +* ``min_offset``: The minimum end offset in the data stream at which this + expression should match successfully. +* ``max_offset``: The maximum end offset in the data stream at which this + expression should match successfully. +* ``min_length``: The minimum match length (from start to end) required to + successfully match this expression. + +These parameters allow the set of matches produced by a pattern to be +constrained at compile time, rather than relying on the application to process +unwanted matches at runtime. + +For example, the pattern :regexp:`/foo.*bar/` when given a ``min_offset`` of 10 +and a ``max_offset`` of 15 will not produce matches when scanned against +``foobar`` or ``foo0123456789bar`` but will produce a match against the data +streams ``foo0123bar`` or ``foo0123456bar``. + +================= +Prefiltering Mode +================= + +Hyperscan provides a per-pattern flag, :c:member:`HS_FLAG_PREFILTER`, which can +be used to implement a prefilter for a pattern than Hyperscan would not +ordinarily support. + +This flag instructs Hyperscan to compile an "approximate" version of this +pattern for use in a prefiltering application, even if Hyperscan does not +support the pattern in normal operation. + +The set of matches returned when this flag is used is guaranteed to be a +superset of the matches specified by the non-prefiltering expression. + +If the pattern contains pattern constructs not supported by Hyperscan (such as +zero-width assertions, back-references or conditional references) these +constructs will be replaced internally with broader constructs that may match +more often. + +For example, the pattern :regexp:`/(\\w+) again \\1/` contains the +back-reference :regexp:`\\1`. In prefiltering mode, this pattern might be +approximated by having its back-reference replaced with its referent, forming +:regexp:`/\\w+ again \\w+/`. + +Furthermore, in prefiltering mode Hyperscan may simplify a pattern that would +otherwise return a "Pattern too large" error at compile time, or for performance +reasons (subject to the matching guarantee above). + +It is generally expected that the application will subsequently confirm +prefilter matches with another regular expression matcher that can provide exact +matches for the pattern. + +.. note:: The use of this flag in combination with Start of Match mode (using + the :c:member:`HS_FLAG_SOM_LEFTMOST` flag) is not currently supported and + will result in a pattern compilation error. + +.. _instr_specialization: + +****************************** +Instruction Set Specialization +****************************** + +Hyperscan is able to make use of several modern instruction set features found +on x86 processors to provide improvements in scanning performance. + +Some of these features are selected when the library is built; for example, +Hyperscan will use the native ``POPCNT`` instruction on processors where it is +available and the library has been optimized for the host architecture. + +.. note:: By default, the Hyperscan runtime is built with the ``-march=native`` + compiler flag and (where possible) will make use of all instructions known by + the host's C compiler. + +To use some instruction set features, however, Hyperscan must build a +specialized database to support them. This means that the target platform must +be specified at pattern compile time. + +The Hyperscan compiler API functions all accept an optional +:c:type:`hs_platform_info_t` argument, which describes the target platform +for the database to be built. If this argument is NULL, the database will be +targeted at the current host platform. + +The :c:type:`hs_platform_info_t` structure has two fields: + +#. ``tune``: This allows the application to specify information about the target + platform which may be used to guide the optimisation process of the compile. + Use of this field does not limit the processors that the resulting database + can run on, but may impact the performance of the resulting database. + +#. ``cpu_features``: This allows the application to specify a mask of CPU + features that may be used on the target platform. For example, + :c:member:`HS_CPU_FEATURES_AVX2` can be specified for Intel\ |reg| Advanced + Vector Extensions +2 (Intel\ |reg| AVX2) instruction set support. If a flag + for a particular CPU feature is specified, the database will not be usable on + a CPU without that feature. + +An :c:type:`hs_platform_info_t` structure targeted at the current host can be +built with the :c:func:`hs_populate_platform` function. + +See :ref:`api_constants` for the full list of CPU tuning and feature flags. diff --git a/doc/dev-reference/conf.py.in b/doc/dev-reference/conf.py.in new file mode 100644 index 00000000..169568f4 --- /dev/null +++ b/doc/dev-reference/conf.py.in @@ -0,0 +1,275 @@ +# -*- coding: utf-8 -*- +# +# Hyperscan documentation build configuration file, created by +# sphinx-quickstart on Tue Sep 29 15:59:19 2015. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['breathe'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Hyperscan' +copyright = u'2015, Intel Corporation' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '@HS_MAJOR_VERSION@.@HS_MINOR_VERSION@' +# The full version, including alpha/beta/rc tags. +release = '@HS_VERSION@' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + # Change some style colors; these are used for admonitions + 'pink_1' : '#e0f8ff', + 'pink_2' : '#e0f8ff' +} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +html_sidebars = { + '**': ['globaltoc.html', 'searchbox.html'] +} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +html_show_sourcelink = False + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Hyperscandoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'Hyperscan.tex', u'Hyperscan Documentation', + u'Intel Corporation', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'hyperscan', u'Hyperscan Documentation', + [u'Intel Corporation'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'Hyperscan', u'Hyperscan Documentation', + u'Intel Corporation', 'Hyperscan', 'High-performance regular expression matcher.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + +# -- Options for Breathe doxygen import ----------------------------------- + +breathe_projects = { "hyperscan": "doxygen_xml" } +breathe_default_project = "hyperscan" +breathe_domain_by_extension = {"h" : "c"} + +# -- Add some customisation ----------------------------------------------- + +def setup(app): + app.add_stylesheet("hyperscan.css") # Custom stylesheet for e.g. :regex: diff --git a/doc/dev-reference/copyright.rst b/doc/dev-reference/copyright.rst new file mode 100644 index 00000000..88be1adc --- /dev/null +++ b/doc/dev-reference/copyright.rst @@ -0,0 +1,33 @@ +.. include:: + +######### +Copyright +######### + +No license (express or implied, by estoppel or otherwise) to any intellectual +property rights is granted by this document. + +Intel disclaims all express and implied warranties, including without +limitation, the implied warranties of merchantability, fitness for a particular +purpose, and non-infringement, as well as any warranty arising from course of +performance, course of dealing, or usage in trade. + +This document contains information on products, services and/or processes in +development. All information provided here is subject to change without +notice. Contact your Intel representative to obtain the latest forecast, +schedule, specifications and roadmaps. + +The products and services described may contain defects or errors known as +errata which may cause deviations from published specifications. Current +characterized errata are available on request. + +Copies of documents which have an order number and are referenced in this +document, or other Intel literature, may be obtained by calling 1-800-548-4725, +or go to: . + +Intel, and the Intel logo, are trademarks of Intel Corporation in the U.S. +and/or other countries. + +\*Other names and brands may be claimed as the property of others. + +Copyright |copy| 2015, Intel Corporation. All rights reserved. diff --git a/doc/dev-reference/getting_started.rst b/doc/dev-reference/getting_started.rst new file mode 100644 index 00000000..7e43d10a --- /dev/null +++ b/doc/dev-reference/getting_started.rst @@ -0,0 +1,211 @@ +.. include:: + +############### +Getting Started +############### + +Very Quick Start +**************** + +#. Clone Hyperscan :: + + cd + git clone git://github/01org/hyperscan + +#. Configure Hyperscan + + Ensure that you have the correct :ref:`dependencies ` present, + and then: + + :: + + cd + mkdir + cd + cmake [-G ] [options] + + Known working generators: + * ``Unix Makefiles`` --- make-compatible makefiles (default on Linux/FreeBSD/Mac OS X) + * ``Ninja`` --- `Ninja `_ build files. + + Generators that might work include: + * ``Xcode`` --- OS X Xcode projects. + * ``Visual Studio`` --- Visual Studio projects - very experimental + +#. Build Hyperscan + + Depending on the generator used: + * ``cmake --build .`` --- will build everything + * ``make -j`` --- use makefiles in parallel + * ``ninja`` --- use Ninja build + * etc. + +#. Check Hyperscan + + Run the Hyperscan unit tests: :: + + bin/unit-hyperscan + +Requirements +************ + +Hardware +======== + +Hyperscan will run on x86 processors in 64-bit (Intel\ |reg| 64 Architecture) and +32-bit (IA-32 Architecture) modes. + +Hyperscan is a high performance software library that takes advantage of recent +Intel architecture advances. At a minimum, support for Supplemental Streaming +SIMD Extensions 3 (SSSE3) is required, which should be available on any modern +x86 processor. + +Additionally, Hyperscan can make use of: + + * Intel Streaming SIMD Extensions 4.2 (SSE4.2) + * the POPCNT instruction + * Bit Manipulation Instructions (BMI, BMI2) + * Intel Advanced Vector Extensions 2 (Intel AVX2) + +if present. + +These can be determined at library compile time, see :ref:`target_arch`. + +.. _software: + +Software +======== + +As a software library, Hyperscan doesn't impose any particular runtime +software requirements, however to build the Hyperscan library we require a +modern C and C++ compiler -- in particular, Hyperscan requires C99 and C++11 +compiler support. The supported compilers are: + + * GCC, v4.8.1 or higher + * Clang, v3.4 or higher (with libstdc++ or libc++) + * Intel C++ Compiler v15 or higher + +Examples of operating systems that Hyperscan is known to work on include: + +Linux: + +* Ubuntu 14.04 LTS or newer +* RedHat/CentOS 7 or newer + +FreeBSD: + +* 10.0 or newer + +Mac OS X: + +* 10.8 or newer, using XCode/Clang + +Hyperscan *may* compile and run on other platforms, but there is no guarantee. +We currently have experimental support for Windows using Intel C++ Compiler +or Visual Studio 2015. + +In addition, the following software is required for compiling the Hyperscan library: + +======================================================= =========== ====================================== +Dependency Version Notes +======================================================= =========== ====================================== +`CMake `_ >=2.8.11 +`Ragel `_ 6.9 +`Python `_ 2.7 +`Boost `_ >=1.57 Boost headers required +`Pcap `_ >=0.8 Optional: needed for example code only +======================================================= =========== ====================================== + +Most of these dependencies can be provided by the package manager on the build +system (e.g. Debian/Ubuntu/RedHat packages, FreeBSD ports, etc). However, +ensure that the correct version is present. + +Boost Headers +------------- + +Compiling Hyperscan depends on a recent version of the Boost C++ header +library. If the Boost libraries are installed on the build machine in the +usual paths, CMake will find them. An alternative is to put a copy of (or a +symlink to) the boost subdirectory in ``/include/boost``. + +For example: for the Boost-1.59.0 release: :: + + ln -s boost_1_59_0/boost /include/boost + +As Hyperscan uses the header-only parts of Boost, it is not necessary to +compile the Boost libraries. + +CMake Configuration +=================== + +When CMake is invoked, it generates build files using the given options. +Options are passed to CMake in the form ``-D=``. +Common options for CMake include: + ++------------------------+----------------------------------------------------+ +| Variable | Description | ++========================+====================================================+ +| CMAKE_C_COMPILER | C compiler to use. Default is /usr/bin/cc. | ++------------------------+----------------------------------------------------+ +| CMAKE_CXX_COMPILER | C++ compiler to use. Default is /usr/bin/c++. | ++------------------------+----------------------------------------------------+ +| CMAKE_INSTALL_PREFIX | Install directory for ``install`` target | ++------------------------+----------------------------------------------------+ +| CMAKE_BUILD_TYPE | Define which kind of build to generate. | +| | Valid options are Debug, Release, RelWithDebInfo, | +| | and MinSizeRel. Default is RelWithDebInfo. | ++------------------------+----------------------------------------------------+ +| BUILD_SHARED_LIBS | Build Hyperscan as a shared library instead of | +| | the default static library. | ++------------------------+----------------------------------------------------+ +| BUILD_STATIC_AND_SHARED| Build both static and shared Hyperscan libs. | +| | Default off. | ++------------------------+----------------------------------------------------+ +| DEBUG_OUTPUT | Enable very verbose debug output. Default off. | ++------------------------+----------------------------------------------------+ + +For example, to generate a ``Debug`` build: :: + + cd + cmake -DCMAKE_BUILD_TYPE=Debug + + + +Build Type +---------- + +CMake determines a number of features for a build based on the Build Type. +Hyperscan defaults to ``RelWithDebInfo``, i.e. "release with debugging +information". This is a performance optimized build without runtime assertions +but with debug symbols enabled. + +The other types of builds are: + + * ``Release``: as above, but without debug symbols + * ``MinSizeRel``: a stripped release build + * ``Debug``: used when developing Hyperscan. Includes runtime assertions + (which has a large impact on runtime performance), and will also enable + some other build features like building internal unit + tests. + +.. _target_arch: + +Target Architecture +------------------- + +By default, Hyperscan will be compiled to target the instruction set of the +processor of the machine that being used for compilation. This is done via +the use of ``-march=native``. The result of this means that a library built on +one machine may not work on a different machine if they differ in supported +instruction subsets. + +To override the use of ``-march=native``, set appropriate flags for the +compiler in ``CFLAGS`` and ``CXXFLAGS`` environment variables before invoking +CMake, or ``CMAKE_C_FLAGS`` and ``CMAKE_CXX_FLAGS`` on the CMake command line. For +example, to set the instruction subsets up to ``SSE4.2`` using GCC 4.8: :: + + cmake -DCMAKE_C_FLAGS="-march=corei7" \ + -DCMAKE_CXX_FLAGS="-march=corei7" + +For more information, refer to :ref:`instr_specialization`. + diff --git a/doc/dev-reference/hyperscan.doxyfile.in b/doc/dev-reference/hyperscan.doxyfile.in new file mode 100644 index 00000000..9b478169 --- /dev/null +++ b/doc/dev-reference/hyperscan.doxyfile.in @@ -0,0 +1,2383 @@ +# Doxyfile 1.8.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Hyperscan" + +# 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 = "@HS_VERSION@" + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = NO + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = @CMAKE_SOURCE_DIR@/src/hs.h @CMAKE_SOURCE_DIR@/src/hs_common.h @CMAKE_SOURCE_DIR@/src/hs_compile.h @CMAKE_SOURCE_DIR@/src/hs_runtime.h + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = NO + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /