From afdcb1d82714175a68c587e66f27bba8e5b1958a Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Thu, 17 Nov 2016 04:27:01 +0300 Subject: improved MSVC x64 support (Pull Request #58 upstream) improved MSVC x64 support suggested by robertolarcher (Pull Request #58), README.win32 adjustments, added (Linux only) Travis test yml as well as other tiny fixes. --- .gitignore | 1 + .travis.yml | 19 +++++++++ BUILD-FROM-GIT.txt | 18 ++++++++- README.txt | 2 +- libnet/README.win32 | 16 +++++--- libnet/msvcbuild.bat | 106 +++++++++++++++++++++++++++++++++++++++++++++++++-- 6 files changed, 150 insertions(+), 12 deletions(-) create mode 100644 .travis.yml diff --git a/.gitignore b/.gitignore index 647e93b..c2f1227 100644 --- a/.gitignore +++ b/.gitignore @@ -30,6 +30,7 @@ libnet*.deb libnet-1.? libnet-1.?.? libnet-1.?.?.tar.gz +libnet-*.tar.gz libnet-1.?.tar.gz libnet-config libnet/*-stamp diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..e02928e --- /dev/null +++ b/.travis.yml @@ -0,0 +1,19 @@ +language: c +branches: + only: + - master +compiler: + - gcc + - clang +os: + - linux +# I "sadly" don't have Mac. Not sure what dependencies are necessary to build libnet there. Uncomment and adjust line 14 if you do. +# - osx +before_install: + - if [ ${TRAVIS_OS_NAME} = "linux" ]; then sudo apt-get update -qq; sudo apt-get install build-essential autoconf libtool libpcap-dev doxygen; fi +# - if [ ${TRAVIS_OS_NAME} = "osx" ]; then brew update; brew install libpcap; fi +install: cd libnet && ../Prepare && ../Build +#add email if you want to get notified +#notifications: +# email: + diff --git a/BUILD-FROM-GIT.txt b/BUILD-FROM-GIT.txt index ae0916a..c3cc151 100644 --- a/BUILD-FROM-GIT.txt +++ b/BUILD-FROM-GIT.txt @@ -1,4 +1,20 @@ -I build from git using some top-level scripts. General procedure is +I build from git using some top-level scripts. + +Minimum dependencies are: + + build-essential (obviously) + autoconf + libtool + libpcap-dev + doxygen + +To create Debian package you also need: + + debhelper + sharutils + quilt + +General procedure is: git clone .../libnet.git cd libnet/libnet diff --git a/README.txt b/README.txt index 716532b..6f52fbf 100644 --- a/README.txt +++ b/README.txt @@ -9,7 +9,7 @@ libnet provides a fairly portable framework for network packet construction an injection. -It is widely used, but had become unmaintained at packetfactory.net, and it's +It is widely used, but had become unmaintained at packetfactory.net, and its author is unreachable. This version was forked from the 1.1.3 release candidate, then bug fixed, diff --git a/libnet/README.win32 b/libnet/README.win32 index 52be775..1faa7d3 100644 --- a/libnet/README.win32 +++ b/libnet/README.win32 @@ -1,17 +1,21 @@ Run msvcbuild.bat to build for Win32 with MSVC. -The batch file depends on the MSVC build environment being set (PATH, etc.), -this can be done with Visual Studio's vsvars32.bat, or by starting a Visual -Studio shell. +The batch file takes arguments and sets the appropriate path +and environment for the desired built by running either vsvars32.bat (for x86), +vcvars64.bat (for x64) or vcvarsall.bat (for Cross development). Type "msvcbuild.bat help" +for a decription and all available options. If no argument is specified, x86 is assumed. -The batch file copies pre-prepared headers out of win32/, avoiding the -requirement for a gnu (cygwin or mingw) build environment. +The batch file copies pre-prepared headers out of win32/, avoiding the requirement for a gnu +(cygwin or mingw) build environment. The batch file hard-codes the location of the WinPcap developer's tools, you may have to modify it for your environment, or install the developer's pack in the expected location. +Make sure this script is executed from a Visual Studio Command Prompt. + For Visual Studio 2010, the shell can be found at: Program Files >> Microsoft Visual Studio 2010 >> Visual Studio Tools >> Visual Studio Command Prompt - + +After building, libnet libraries and .obj files are found in newly created win32/win64 folders in libnet's root directory. \ No newline at end of file diff --git a/libnet/msvcbuild.bat b/libnet/msvcbuild.bat index 5284e64..0c0602c 100644 --- a/libnet/msvcbuild.bat +++ b/libnet/msvcbuild.bat @@ -1,15 +1,72 @@ -@rem Script to build libnet under "Visual Studio .NET Command Prompt". +@echo off + +@rem Script to build libnet under "VS2013 x64 Cross Tools Command Prompt" or "VS2013 x64 Native Tools Command Prompt @rem Dependencies are: -@rem winpcap, specifically, the winpcap developer pack +@rem winpcap, specifically, the winpcap developer pack +@rem We assume WpdPack\ and libnet-master\ to have the same path, and that this script is executed from a VS Developer Command Prompt + +@if "%1" == "" goto x86 +@setlocal +@set userinput=%1 +@if not "%1"=="x86" @if not "%1"=="x64" @if not "%1"=="x86_x64" goto usage +@if "%1"=="x86" goto x86 +@if "%1"=="x64" goto x64 +@if "%1"=="x86_x64" goto x86_x64 +@endlocal + +:x86 +if not exist "%VCINSTALLDIR%bin\vcvars32.bat" goto missing32 +call "%VCINSTALLDIR%bin\vcvars32.bat" +goto msvcbuild32 + +:x64 +if not exist "%VCINSTALLDIR%bin\amd64\vcvars64.bat" goto missing64 +call "%VCINSTALLDIR%bin\amd64\vcvars64.bat" +goto msvcbuild64 + +:x86_x64 +if not exist "%VCINSTALLDIR%vcvarsall.bat" goto missingCross +call "%VCINSTALLDIR%vcvarsall.bat" x86_amd64 +goto msvcbuild64 + +:msvcbuild32 +@echo on +@setlocal +@set MYCOMPILE=cl /nologo /MD /O2 /W3 /c /D_CRT_SECURE_NO_DEPRECATE /Fo..\..\win32\ +@set MYLINK=link /nologo +@set MYMT=mt /nologo + +@rem relative to C code in src/ +@set WINPCAP=..\..\..\WpdPack + +if not exist "..\win32\" mkdir "..\win32\" + +copy win32\libnet.h include\ +copy win32\stdint.h include\libnet\ +copy win32\config.h include\ +copy win32\getopt.h include\ + +cd src +%MYCOMPILE% /I..\include /I%WINPCAP%\Include libnet_a*.c libnet_build_*.c libnet_c*.c libnet_dll.c libnet_error.c libnet_i*.c libnet_link_win32.c libnet_p*.c libnet_raw.c libnet_resolve.c libnet_version.c libnet_write.c +%MYLINK% /DLL /libpath:%WINPCAP%\Lib /out:..\..\win32\libnet.dll ..\..\win32\*.obj Advapi32.lib +if exist libnet.dll.manifest^ + %MYMT% -manifest libnet.dll.manifest -outputresource:libnet.dll;2 +cd .. + +exit /b %errorlevel% +:msvcbuild64 +@echo on @setlocal -@set MYCOMPILE=cl /nologo /MD /O2 /W3 /c /D_CRT_SECURE_NO_DEPRECATE +@set MYCOMPILE=cl /nologo /MD /O2 /W3 /c /D_CRT_SECURE_NO_DEPRECATE /Fo..\..\win64\ @set MYLINK=link /nologo @set MYMT=mt /nologo @rem relative to C code in src/ @set WINPCAP=..\..\..\WpdPack +if not exist "..\win64\" mkdir "..\win64\" + copy win32\libnet.h include\ copy win32\stdint.h include\libnet\ copy win32\config.h include\ @@ -17,10 +74,51 @@ copy win32\getopt.h include\ cd src %MYCOMPILE% /I..\include /I%WINPCAP%\Include libnet_a*.c libnet_build_*.c libnet_c*.c libnet_dll.c libnet_error.c libnet_i*.c libnet_link_win32.c libnet_p*.c libnet_raw.c libnet_resolve.c libnet_version.c libnet_write.c -%MYLINK% /DLL /libpath:%WINPCAP%\Lib /out:libnet.dll *.obj Advapi32.lib +%MYLINK% /DLL /libpath:%WINPCAP%\Lib\x64 /out:..\..\win64\libnet.dll ..\..\win64\*.obj Advapi32.lib if exist libnet.dll.manifest^ %MYMT% -manifest libnet.dll.manifest -outputresource:libnet.dll;2 cd .. exit /b %errorlevel% +:usage +echo Invalid option "%*". The correct usage is: +echo %0 [option] +echo : +echo where [option] is: x86 ^| x64 ^| x86_x64 +echo : +echo The script will verify and set the appropriate environment variables. +echo If no options are provided, x86 is assumed. +echo : +echo Usage examples: +echo %0 x86 +echo %0 x64 +echo %0 x86_x64 +echo : +echo If your build computer is 32-bit and you want to build for 64-bit +echo (aka Cross), choose "x86_x64" +echo : +echo Please make sure Visual Studio or the C++ Build SKU is installed, +echo and that this script is executed from a Developer Command Prompt. +echo : +goto end + +:missing32 +echo Could not find vcvars32.bat. +echo Either Visual Studio or the C++ Build SKU is not installed, +echo or this script is not executed from a Developer Command Prompt. +goto end + +:missing64 +echo Could not find vcvars64.bat. +echo Either Visual Studio or the C++ Build SKU is not installed, +echo or this script is not executed from a Developer Command Prompt. +goto end + +:missingCross +echo Could not find vcvarsall.bat. +echo Either Visual Studio or the C++ Build SKU is not installed, +echo or this script is not executed from a Developer Command Prompt. +goto end + +:end \ No newline at end of file -- cgit v1.2.1 From a3350be6ff985e564b85fd18368eb394672455b0 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Thu, 17 Nov 2016 17:54:27 +0300 Subject: fixed .travis.yml --- .gitignore | 1 + .travis.yml | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index c2f1227..933bcca 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,7 @@ Makefile Makefile.in aclocal.m4 autom4te.cache +compile config.guess config.h.in config.log diff --git a/.travis.yml b/.travis.yml index e02928e..896811a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,6 @@ language: c +script: + sudo make install branches: only: - master @@ -10,7 +12,7 @@ os: # I "sadly" don't have Mac. Not sure what dependencies are necessary to build libnet there. Uncomment and adjust line 14 if you do. # - osx before_install: - - if [ ${TRAVIS_OS_NAME} = "linux" ]; then sudo apt-get update -qq; sudo apt-get install build-essential autoconf libtool libpcap-dev doxygen; fi + - if [ ${TRAVIS_OS_NAME} = "linux" ]; then sudo apt-get update -qq; sudo apt-get install doxygen libpcap-dev; fi # - if [ ${TRAVIS_OS_NAME} = "osx" ]; then brew update; brew install libpcap; fi install: cd libnet && ../Prepare && ../Build #add email if you want to get notified -- cgit v1.2.1 From b775817be37548cf16b9b9513e011a72e085b2c5 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Fri, 18 Nov 2016 00:11:02 +0300 Subject: .travis.yml OSX #1 --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 896811a..fcc67ab 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,7 +10,7 @@ compiler: os: - linux # I "sadly" don't have Mac. Not sure what dependencies are necessary to build libnet there. Uncomment and adjust line 14 if you do. -# - osx + - osx before_install: - if [ ${TRAVIS_OS_NAME} = "linux" ]; then sudo apt-get update -qq; sudo apt-get install doxygen libpcap-dev; fi # - if [ ${TRAVIS_OS_NAME} = "osx" ]; then brew update; brew install libpcap; fi -- cgit v1.2.1 From 6f0f6b2ac45cdace3b4418346aaa086ccc6788b0 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Fri, 18 Nov 2016 02:22:13 +0300 Subject: appveyor.yml test #1 --- BUILD-FROM-GIT.txt | 1 + appveyor.yml | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 appveyor.yml diff --git a/BUILD-FROM-GIT.txt b/BUILD-FROM-GIT.txt index c3cc151..359bb2d 100644 --- a/BUILD-FROM-GIT.txt +++ b/BUILD-FROM-GIT.txt @@ -1,4 +1,5 @@ I build from git using some top-level scripts. +Refer to libnet/README.win32 if you're building for windows. Minimum dependencies are: diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..aff4a3d --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,11 @@ + +install: +- appveyor DownloadFile http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip +- 7z x .\WpdPack_4_1_2.zip -o.. + +before_build: +- cd C:\projects\libnet\libnet + +build_script: +- msvcbuild.bat +- msvcbuild.bat x64 -- cgit v1.2.1 From e59a1163f4d1ef949d0a1cd96d789c684cd8f28e Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Fri, 18 Nov 2016 03:47:12 +0300 Subject: another appveyor fix --- .travis.yml | 2 +- appveyor.yml | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index fcc67ab..4df619a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,7 +13,7 @@ os: - osx before_install: - if [ ${TRAVIS_OS_NAME} = "linux" ]; then sudo apt-get update -qq; sudo apt-get install doxygen libpcap-dev; fi -# - if [ ${TRAVIS_OS_NAME} = "osx" ]; then brew update; brew install libpcap; fi + - if [ ${TRAVIS_OS_NAME} = "osx" ]; then brew update; brew install doxygen; fi install: cd libnet && ../Prepare && ../Build #add email if you want to get notified #notifications: diff --git a/appveyor.yml b/appveyor.yml index aff4a3d..28527b4 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -7,5 +7,6 @@ before_build: - cd C:\projects\libnet\libnet build_script: +- cmd: \"C:\\Program Files (x86)\\Microsoft Visual Studio 14.0\\Common7\\Tools\\VsDevCmd.bat\" - msvcbuild.bat -- msvcbuild.bat x64 +- msvcbuild.bat x64 \ No newline at end of file -- cgit v1.2.1 From e254945893337f8cf5586d534e100949302da2b7 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Fri, 18 Nov 2016 04:00:01 +0300 Subject: appveyor test #12? --- appveyor.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/appveyor.yml b/appveyor.yml index 28527b4..16eb471 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -3,10 +3,13 @@ install: - appveyor DownloadFile http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip - 7z x .\WpdPack_4_1_2.zip -o.. +environment: + VsDevCmd.bat= "C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\\Tools\VsDevCmd.bat" + before_build: - cd C:\projects\libnet\libnet build_script: -- cmd: \"C:\\Program Files (x86)\\Microsoft Visual Studio 14.0\\Common7\\Tools\\VsDevCmd.bat\" +- VsDevCmd.bat - msvcbuild.bat - msvcbuild.bat x64 \ No newline at end of file -- cgit v1.2.1 From 409a9e6510a73b1262597d97644afcd2d27d2f00 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Fri, 18 Nov 2016 04:18:20 +0300 Subject: appveyor test #13 last chance, appveyor1 --- appveyor.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/appveyor.yml b/appveyor.yml index 16eb471..9870502 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -3,13 +3,11 @@ install: - appveyor DownloadFile http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip - 7z x .\WpdPack_4_1_2.zip -o.. -environment: - VsDevCmd.bat= "C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\\Tools\VsDevCmd.bat" - before_build: - cd C:\projects\libnet\libnet build_script: +- set PATH=%PATH%;C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\Tools\ - VsDevCmd.bat - msvcbuild.bat - msvcbuild.bat x64 \ No newline at end of file -- cgit v1.2.1 From cd1e8bae1586c12f2876e983a9c3b18393e50c75 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Fri, 18 Nov 2016 15:05:52 +0300 Subject: msvcbuild.bat enhancements msvcbuild.bat now builds libnet from ANY cmd/powershell not just the Developer Command Prompt --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ README.txt | 46 ---------------------------------------------- appveyor.yml | 2 -- libnet/README.win32 | 8 ++++---- libnet/msvcbuild.bat | 31 ++++++++++++------------------- 5 files changed, 64 insertions(+), 71 deletions(-) create mode 100644 README.md delete mode 100644 README.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..b063e3b --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +[![Build status](https://ci.appveyor.com/api/projects/status/9ic7kmwektgornlg?svg=true)](https://ci.appveyor.com/project/sgeto/libnet) [![Build Status](https://travis-ci.org/sgeto/libnet.svg?branch=master)](https://travis-ci.org/sgeto/libnet) + +=============================================================================== + LIBNET 1.1 (c) 1998 - 2004 Mike D. Schiffman + http://www.packetfactory.net/libnet + + LIBNET 1.1.3 and later (c) 2009 - 2013 Sam Roberts + http://github.com/sam-github/libnet +=============================================================================== + +libnet provides a fairly portable framework for network packet construction +an injection. + +It is widely used, but had become unmaintained at packetfactory.net, and its +author is unreachable. + +This version was forked from the 1.1.3 release candidate, then bug fixed, +actively maintained, and rereleased. + +Contact Sam Roberts if you have patches, find bugs, or +have issues porting or building against it. + +Newest code is at: + + http://github.com/sam-github/libnet + +Releases are at: + + http://sourceforge.net/projects/libnet-dev/ + +Some old docs are at: + + http://packetfactory.openwall.net/projects/libnet/index.html + + A C library for portable packet creation and injection. + + Libnet is an API to help with the construction and handling of network + packets. It provides a portable framework for low-level network + packet writing and handling (use libnet in conjunction with libpcap and + you can write some really cool stuff). Libnet includes packet creation + at the IP layer and at the link layer as well as a host of supplementary + and complementary functionality. Libnet is very handy with which to + write network tools and network test code. See the manpage and sample + test code for more detailed information. + + Your old code (circa libnet-1.0.x) WILL NOT WORK with libnet-1.1.x. + Read doc/MIGRATION for easy steps on porting your old code. + diff --git a/README.txt b/README.txt deleted file mode 100644 index 6f52fbf..0000000 --- a/README.txt +++ /dev/null @@ -1,46 +0,0 @@ -=============================================================================== - LIBNET 1.1 (c) 1998 - 2004 Mike D. Schiffman - http://www.packetfactory.net/libnet - - LIBNET 1.1.3 and later (c) 2009 - 2013 Sam Roberts - http://github.com/sam-github/libnet -=============================================================================== - -libnet provides a fairly portable framework for network packet construction -an injection. - -It is widely used, but had become unmaintained at packetfactory.net, and its -author is unreachable. - -This version was forked from the 1.1.3 release candidate, then bug fixed, -actively maintained, and rereleased. - -Contact Sam Roberts if you have patches, find bugs, or -have issues porting or building against it. - -Newest code is at: - - http://github.com/sam-github/libnet - -Releases are at: - - http://sourceforge.net/projects/libnet-dev/ - -Some old docs are at: - - http://packetfactory.openwall.net/projects/libnet/index.html - - A C library for portable packet creation and injection. - - Libnet is an API to help with the construction and handling of network - packets. It provides a portable framework for low-level network - packet writing and handling (use libnet in conjunction with libpcap and - you can write some really cool stuff). Libnet includes packet creation - at the IP layer and at the link layer as well as a host of supplementary - and complementary functionality. Libnet is very handy with which to - write network tools and network test code. See the manpage and sample - test code for more detailed information. - - Your old code (circa libnet-1.0.x) WILL NOT WORK with libnet-1.1.x. - Read doc/MIGRATION for easy steps on porting your old code. - diff --git a/appveyor.yml b/appveyor.yml index 9870502..3f963f0 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -7,7 +7,5 @@ before_build: - cd C:\projects\libnet\libnet build_script: -- set PATH=%PATH%;C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\Tools\ -- VsDevCmd.bat - msvcbuild.bat - msvcbuild.bat x64 \ No newline at end of file diff --git a/libnet/README.win32 b/libnet/README.win32 index 1faa7d3..3f01c22 100644 --- a/libnet/README.win32 +++ b/libnet/README.win32 @@ -1,6 +1,6 @@ Run msvcbuild.bat to build for Win32 with MSVC. -The batch file takes arguments and sets the appropriate path +The batch file takes arguments and sets the appropriate path and environment for the desired built by running either vsvars32.bat (for x86), vcvars64.bat (for x64) or vcvarsall.bat (for Cross development). Type "msvcbuild.bat help" for a decription and all available options. If no argument is specified, x86 is assumed. @@ -12,10 +12,10 @@ The batch file hard-codes the location of the WinPcap developer's tools, you may have to modify it for your environment, or install the developer's pack in the expected location. -Make sure this script is executed from a Visual Studio Command Prompt. +Although not required, it is advisable to executed the batch from a VS2015 Developer Command Prompt. -For Visual Studio 2010, the shell can be found at: +For Visual Studio 2015, the shell can be found at: - Program Files >> Microsoft Visual Studio 2010 >> Visual Studio Tools >> Visual Studio Command Prompt + Program Files (x86) >> Microsoft Visual Studio 14.0 >> Common7 >> Tools >> VsDevCmd.bat After building, libnet libraries and .obj files are found in newly created win32/win64 folders in libnet's root directory. \ No newline at end of file diff --git a/libnet/msvcbuild.bat b/libnet/msvcbuild.bat index 0c0602c..53e966c 100644 --- a/libnet/msvcbuild.bat +++ b/libnet/msvcbuild.bat @@ -1,9 +1,9 @@ @echo off -@rem Script to build libnet under "VS2013 x64 Cross Tools Command Prompt" or "VS2013 x64 Native Tools Command Prompt +@rem Script to build libnet under VS2015 Developer Command Prompt @rem Dependencies are: @rem winpcap, specifically, the winpcap developer pack -@rem We assume WpdPack\ and libnet-master\ to have the same path, and that this script is executed from a VS Developer Command Prompt +@rem We assume WpdPack\ and libnet-master\ to have the same path, and that this script is executed from a VS2015 Developer Command Prompt @if "%1" == "" goto x86 @setlocal @@ -15,12 +15,12 @@ @endlocal :x86 -if not exist "%VCINSTALLDIR%bin\vcvars32.bat" goto missing32 +if not exist "%VCINSTALLDIR%bin\vcvars32.bat" goto path call "%VCINSTALLDIR%bin\vcvars32.bat" goto msvcbuild32 :x64 -if not exist "%VCINSTALLDIR%bin\amd64\vcvars64.bat" goto missing64 +if not exist "%VCINSTALLDIR%bin\amd64\vcvars64.bat" goto path call "%VCINSTALLDIR%bin\amd64\vcvars64.bat" goto msvcbuild64 @@ -103,22 +103,15 @@ echo and that this script is executed from a Developer Command Prompt. echo : goto end -:missing32 -echo Could not find vcvars32.bat. -echo Either Visual Studio or the C++ Build SKU is not installed, -echo or this script is not executed from a Developer Command Prompt. -goto end - -:missing64 -echo Could not find vcvars64.bat. -echo Either Visual Studio or the C++ Build SKU is not installed, -echo or this script is not executed from a Developer Command Prompt. -goto end +:path +call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\Tools\VsDevCmd.bat" +if not exist "C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\Tools\VsDevCmd.bat" goto fail +goto %1 -:missingCross -echo Could not find vcvarsall.bat. -echo Either Visual Studio or the C++ Build SKU is not installed, -echo or this script is not executed from a Developer Command Prompt. +:fail +echo Visual Studio or the C++ Build SKU do not seem to be installed. +echo Please Install either of them or try to executed this script +echo from a Developer Command Prompt. goto end :end \ No newline at end of file -- cgit v1.2.1 From 736829daeb3f6424a751f5d846220c4ec07fcd11 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Fri, 18 Nov 2016 15:49:59 +0300 Subject: patched msvcbuilt.bat goto %1 didn't apply anymore... --- libnet/msvcbuild.bat | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/libnet/msvcbuild.bat b/libnet/msvcbuild.bat index 53e966c..2e25303 100644 --- a/libnet/msvcbuild.bat +++ b/libnet/msvcbuild.bat @@ -1,10 +1,13 @@ -@echo off +@echo on @rem Script to build libnet under VS2015 Developer Command Prompt @rem Dependencies are: @rem winpcap, specifically, the winpcap developer pack -@rem We assume WpdPack\ and libnet-master\ to have the same path, and that this script is executed from a VS2015 Developer Command Prompt +@rem We assume WpdPack\ and libnet-master\ to have the same path, +@rem and that this script is executed from either a VS2015 Developer Command Prompt +@rem or an elevated Command Prompt +:start @if "%1" == "" goto x86 @setlocal @set userinput=%1 @@ -106,7 +109,7 @@ goto end :path call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\Tools\VsDevCmd.bat" if not exist "C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\Tools\VsDevCmd.bat" goto fail -goto %1 +goto start :fail echo Visual Studio or the C++ Build SKU do not seem to be installed. -- cgit v1.2.1 From d9e990a8af831bbc5f42f40e7b5606fb4b590c70 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Tue, 22 Nov 2016 02:24:54 +0300 Subject: changed output folders again (msvc) batch file now creates "lib" folder, libs have version number and other minor changes; lua bindings doesn't work (yet) --- README.md | 30 +++++++++++------------------- libnet/README | 4 ++-- libnet/README.win32 | 4 ++-- libnet/msvcbuild.bat | 28 +++++++++++++++++----------- lua/msvcbuild.bat | 4 ++-- 5 files changed, 34 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index b063e3b..7dba0fb 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,8 @@ [![Build status](https://ci.appveyor.com/api/projects/status/9ic7kmwektgornlg?svg=true)](https://ci.appveyor.com/project/sgeto/libnet) [![Build Status](https://travis-ci.org/sgeto/libnet.svg?branch=master)](https://travis-ci.org/sgeto/libnet) -=============================================================================== - LIBNET 1.1 (c) 1998 - 2004 Mike D. Schiffman - http://www.packetfactory.net/libnet +# Libnet # - LIBNET 1.1.3 and later (c) 2009 - 2013 Sam Roberts - http://github.com/sam-github/libnet -=============================================================================== - -libnet provides a fairly portable framework for network packet construction +Libnet provides a fairly portable framework for network packet construction an injection. It is widely used, but had become unmaintained at packetfactory.net, and its @@ -32,17 +26,15 @@ Some old docs are at: http://packetfactory.openwall.net/projects/libnet/index.html - A C library for portable packet creation and injection. +**A C library for portable packet creation and injection** - Libnet is an API to help with the construction and handling of network - packets. It provides a portable framework for low-level network - packet writing and handling (use libnet in conjunction with libpcap and - you can write some really cool stuff). Libnet includes packet creation - at the IP layer and at the link layer as well as a host of supplementary - and complementary functionality. Libnet is very handy with which to - write network tools and network test code. See the manpage and sample - test code for more detailed information. +Libnet is an API to help with the construction and handling of network packets. It provides a portable framework for low-level network packet writing and handling (use libnet in conjunction with libpcap and you can write some really cool stuff). Libnet includes packet creation at the IP layer and at the link layer as well as a host of supplementary and complementary functionality. Libnet is very handy with which to write network tools and network test code. See the manpage and sample test code for more detailed information. - Your old code (circa libnet-1.0.x) WILL NOT WORK with libnet-1.1.x. - Read doc/MIGRATION for easy steps on porting your old code. +Your old code (circa *libnet-1.0.x*) WILL NOT WORK with *libnet-1.1.x*. +Read *doc/MIGRATION* for easy steps on porting your old code. + +**LIBNET 1.1 (c) 1998 - 2004 Mike D. Schiffman ** +http://www.packetfactory.net/libnet +**LIBNET 1.1.3 and later (c) 2009 - 2013 Sam Roberts ** +http://github.com/sam-github/libnet \ No newline at end of file diff --git a/libnet/README b/libnet/README index 716532b..7c8efa3 100644 --- a/libnet/README +++ b/libnet/README @@ -6,10 +6,10 @@ http://github.com/sam-github/libnet =============================================================================== -libnet provides a fairly portable framework for network packet construction +Libnet provides a fairly portable framework for network packet construction an injection. -It is widely used, but had become unmaintained at packetfactory.net, and it's +It is widely used, but had become unmaintained at packetfactory.net, and its author is unreachable. This version was forked from the 1.1.3 release candidate, then bug fixed, diff --git a/libnet/README.win32 b/libnet/README.win32 index 3f01c22..788434b 100644 --- a/libnet/README.win32 +++ b/libnet/README.win32 @@ -1,7 +1,7 @@ Run msvcbuild.bat to build for Win32 with MSVC. The batch file takes arguments and sets the appropriate path -and environment for the desired built by running either vsvars32.bat (for x86), +and environment variables for the desired built by running either vsvars32.bat (for x86), vcvars64.bat (for x64) or vcvarsall.bat (for Cross development). Type "msvcbuild.bat help" for a decription and all available options. If no argument is specified, x86 is assumed. @@ -18,4 +18,4 @@ For Visual Studio 2015, the shell can be found at: Program Files (x86) >> Microsoft Visual Studio 14.0 >> Common7 >> Tools >> VsDevCmd.bat -After building, libnet libraries and .obj files are found in newly created win32/win64 folders in libnet's root directory. \ No newline at end of file +After building, libnet libraries and .obj files are found in newly created "\libnet\src\[Win32|Win64]\" "\libnet\lib\[x86|x64]\" respectively. \ No newline at end of file diff --git a/libnet/msvcbuild.bat b/libnet/msvcbuild.bat index 2e25303..2a5ee3d 100644 --- a/libnet/msvcbuild.bat +++ b/libnet/msvcbuild.bat @@ -1,11 +1,11 @@ -@echo on +@echo off -@rem Script to build libnet under VS2015 Developer Command Prompt +@rem Script to build libnet with MSVC. @rem Dependencies are: @rem winpcap, specifically, the winpcap developer pack -@rem We assume WpdPack\ and libnet-master\ to have the same path, +@rem We assume WpdPack\ and libnet-master\ to have the same path, @rem and that this script is executed from either a VS2015 Developer Command Prompt -@rem or an elevated Command Prompt +@rem or an elevated Command Prompt. :start @if "%1" == "" goto x86 @@ -28,21 +28,24 @@ call "%VCINSTALLDIR%bin\amd64\vcvars64.bat" goto msvcbuild64 :x86_x64 -if not exist "%VCINSTALLDIR%vcvarsall.bat" goto missingCross +if not exist "%VCINSTALLDIR%vcvarsall.bat" goto path call "%VCINSTALLDIR%vcvarsall.bat" x86_amd64 goto msvcbuild64 :msvcbuild32 @echo on @setlocal -@set MYCOMPILE=cl /nologo /MD /O2 /W3 /c /D_CRT_SECURE_NO_DEPRECATE /Fo..\..\win32\ +@set MYCOMPILE=cl /nologo /MD /O2 /W4 /c /D_CRT_SECURE_NO_DEPRECATE /Fowin32\ @set MYLINK=link /nologo @set MYMT=mt /nologo +@set VERSION=1.2 @rem relative to C code in src/ @set WINPCAP=..\..\..\WpdPack -if not exist "..\win32\" mkdir "..\win32\" +if not exist "src\win32\" mkdir "src\win32\" + +if not exist "lib\x86\" mkdir "lib\x86\" copy win32\libnet.h include\ copy win32\stdint.h include\libnet\ @@ -51,7 +54,7 @@ copy win32\getopt.h include\ cd src %MYCOMPILE% /I..\include /I%WINPCAP%\Include libnet_a*.c libnet_build_*.c libnet_c*.c libnet_dll.c libnet_error.c libnet_i*.c libnet_link_win32.c libnet_p*.c libnet_raw.c libnet_resolve.c libnet_version.c libnet_write.c -%MYLINK% /DLL /libpath:%WINPCAP%\Lib /out:..\..\win32\libnet.dll ..\..\win32\*.obj Advapi32.lib +%MYLINK% /DLL /libpath:%WINPCAP%\Lib /out:..\lib\x86\libnet%VERSION%.dll win32\*.obj Advapi32.lib if exist libnet.dll.manifest^ %MYMT% -manifest libnet.dll.manifest -outputresource:libnet.dll;2 cd .. @@ -61,14 +64,17 @@ exit /b %errorlevel% :msvcbuild64 @echo on @setlocal -@set MYCOMPILE=cl /nologo /MD /O2 /W3 /c /D_CRT_SECURE_NO_DEPRECATE /Fo..\..\win64\ +@set MYCOMPILE=cl /nologo /MD /O2 /W4 /c /D_CRT_SECURE_NO_DEPRECATE /Fowin64\ @set MYLINK=link /nologo @set MYMT=mt /nologo +@set VERSION=1.2 @rem relative to C code in src/ @set WINPCAP=..\..\..\WpdPack -if not exist "..\win64\" mkdir "..\win64\" +if not exist "src\win64\" mkdir "src\win64\" + +if not exist "lib\x64\" mkdir "lib\x64\" copy win32\libnet.h include\ copy win32\stdint.h include\libnet\ @@ -77,7 +83,7 @@ copy win32\getopt.h include\ cd src %MYCOMPILE% /I..\include /I%WINPCAP%\Include libnet_a*.c libnet_build_*.c libnet_c*.c libnet_dll.c libnet_error.c libnet_i*.c libnet_link_win32.c libnet_p*.c libnet_raw.c libnet_resolve.c libnet_version.c libnet_write.c -%MYLINK% /DLL /libpath:%WINPCAP%\Lib\x64 /out:..\..\win64\libnet.dll ..\..\win64\*.obj Advapi32.lib +%MYLINK% /DLL /libpath:%WINPCAP%\Lib\x64 /out:..\lib\x64\libnet%VERSION%.dll win64\*.obj Advapi32.lib if exist libnet.dll.manifest^ %MYMT% -manifest libnet.dll.manifest -outputresource:libnet.dll;2 cd .. diff --git a/lua/msvcbuild.bat b/lua/msvcbuild.bat index 0206ecf..e45c6f3 100644 --- a/lua/msvcbuild.bat +++ b/lua/msvcbuild.bat @@ -9,13 +9,13 @@ @set MYLINK=link /nologo @set MYMT=mt /nologo -@set LUA=..\..\lua\src +@set LUA=..\..\lua\5.3 @set WINPCAP=..\..\WpdPack @set DNET=..\..\libdnet copy dnet.h.win32 dnet.h %MYCOMPILE% /I..\libnet\include /I%LUA% /I%WINPCAP%\Include /I%DNET%\include *.c -%MYLINK% /DLL /export:luaopen_net /libpath:%WINPCAP%\Lib /out:net.dll *.obj %LUA%\lua51.lib ..\libnet\src\libnet.lib %DNET%\lib\dnet.lib +%MYLINK% /DLL /export:luaopen_net /libpath:%WINPCAP%\Lib /out:net.dll *.obj %LUA%\lib\lua5.3.lib ..\libnet\lib\x86\libnet1.2.lib %DNET%\lib\dnet.lib if exist net.dll.manifest^ %MYMT% -manifest net.dll.manifest -outputresource:net.dll;2 -- cgit v1.2.1 From cd807ffd04701c418b144e60d87d740b2199cc17 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Mon, 26 Dec 2016 06:22:03 +0300 Subject: Some MinGW specific tryouts Samples are in need of additional linking (-lws2_32, -lpcap) and are complaining about code in libnet_resolve.c, libnet_write.c and libnet_raw.c. Not sure how concerning that is... I better get my pcap manual :-D --- .gitignore | 1 + libnet/include/libnet/libnet-headers.h | 6 +++++- libnet/include/libnet/libnet-structures.h | 1 + libnet/src/common.h | 15 +++++++++++++-- 4 files changed, 20 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 933bcca..a8bd057 100644 --- a/.gitignore +++ b/.gitignore @@ -36,6 +36,7 @@ libnet-1.?.tar.gz libnet-config libnet/*-stamp libnet/debian +libnet/doc/*.db libnet/doc/html/*.css libnet/doc/html/*.gif libnet/doc/html/*.html diff --git a/libnet/include/libnet/libnet-headers.h b/libnet/include/libnet/libnet-headers.h index e1076e9..ae330e0 100644 --- a/libnet/include/libnet/libnet-headers.h +++ b/libnet/include/libnet/libnet-headers.h @@ -1,5 +1,4 @@ /* - * $Id: libnet-headers.h,v 1.15 2004/11/09 07:05:07 mike Exp $ * * libnet-headers.h - Network routine library headers header file * @@ -113,6 +112,11 @@ #define LIBNET_VRRP_H 0x08 /**< VRRP header: 8 bytes */ #define LIBNET_HSRP_H 0x14 /**< HSRP header: 8 bytes */ +/* we seems to need things from stdint.h on mingw */ +#ifdef __MINGW32__ +#include +#endif + /* * IEEE 802.1Q (Virtual Local Area Network) VLAN header, static header * size: 18 bytes diff --git a/libnet/include/libnet/libnet-structures.h b/libnet/include/libnet/libnet-structures.h index bd7b55b..8a35269 100644 --- a/libnet/include/libnet/libnet-structures.h +++ b/libnet/include/libnet/libnet-structures.h @@ -33,6 +33,7 @@ #define __LIBNET_STRUCTURES_H #if ((__WIN32__) && !(__CYGWIN__)) +#include #include "Packet32.h" #endif diff --git a/libnet/src/common.h b/libnet/src/common.h index 358db77..ed7416d 100644 --- a/libnet/src/common.h +++ b/libnet/src/common.h @@ -29,8 +29,18 @@ #if (_WIN32) || (__CYGWIN__) -/* MSVC warns about snprintf */ -#define _CRT_SECURE_NO_WARNINGS + /* MSVC warns about snprintf */ + #define _CRT_SECURE_NO_WARNINGS + + #include + #include + #include /* alloca() */ + +#ifdef __MINGW32__ + #include +#else + #include +#endif #else @@ -40,6 +50,7 @@ #include + /* TODO - should ../include/gnuc.h be included here? */ /* TODO - HAVE_OS_PROTO_H is never defined, but used in some files, delete it */ -- cgit v1.2.1 From d58fec2083ee3e447ac03e0824e5ec58bed1ebfe Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Fri, 6 Jan 2017 05:21:13 +0300 Subject: MinGW ready! Libnet now builds gracefully with MinGW (including samples). There's a lot of fine tuning to be done and it needs testing on my other MinGW distros (including cross). This push is therefore just to see if Linux, Mac and Windows (MSVC) are still happy. --- .gitignore | 1 + libnet/configure.ac | 14 +++++++++----- libnet/sample/libnet_test.h | 9 +++++++-- libnet/sample/test_ipv6_icmpv4.c | 5 ++++- libnet/src/libnet_link_win32.c | 2 +- libnet/src/libnet_write.c | 4 ++-- 6 files changed, 24 insertions(+), 11 deletions(-) diff --git a/.gitignore b/.gitignore index a8bd057..8843ef7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ *.a *.dll +*.exe *.exp *.la *.lib diff --git a/libnet/configure.ac b/libnet/configure.ac index 4751f62..721dc74 100644 --- a/libnet/configure.ac +++ b/libnet/configure.ac @@ -127,7 +127,7 @@ elif test "$target_os" = "cygwin" ; then AC_LIBOBJ([libnet_link_win32]) AC_MSG_RESULT(found link layer win32 wpcap) else - AC_LIBOBJ([libnet_link_none]) + AC_LIBOBJ([libnet_link_win32]) AC_MSG_WARN(could not find a link-layer packet interface) AC_MSG_WARN(link-layer packet injection will not be available) fi @@ -296,10 +296,14 @@ dnl ;; *) - AC_MSG_WARN(apparently your OS is not officially supported yet) - AC_MSG_WARN(this may not work) - AC_MSG_RESULT(please send diffs to vieuxtech@gmail.com) - ;; + AC_MSG_WARN(apparently your OS is not officially supported yet) + AC_MSG_WARN(this may not work) + AC_MSG_RESULT(please send diffs to vieuxtech@gmail.com) + AC_CHECK_LIB(Packet, PacketSetMode, ,AC_MSG_ERROR(packet lib not found.)) + AC_CHECK_LIB(wpcap, pcap_setmode, ,AC_MSG_ERROR(pcap lib not found.)) + LIBS="$LIBS -lws2_32 -liphlpapi" + CFLAGS="$CFLAGS -mwin32 -W -Wall -Wextra -fno-common -Wcast-align -Wredundant-decls -Wbad-function-cast -Wwrite-strings -Waggregate-return -Wstrict-prototypes -Wmissing-prototypes" + ;; esac diff --git a/libnet/sample/libnet_test.h b/libnet/sample/libnet_test.h index 00e6c54..4b531dc 100644 --- a/libnet/sample/libnet_test.h +++ b/libnet/sample/libnet_test.h @@ -50,11 +50,16 @@ void usage(char *); #ifndef _WIN32 #include #endif +/* The whole file is a mess, but everything starting from here is a real + mess and is breaking sample building. + These external symbols here make MinGW think that the actual functions will be + placed in a dynamic library when they aren't. Maybe they were. + Maybe it's a cygwin thing. For now, they're just causing trouble. */ #if defined(__GNUC__) /* mingw compiler */ -extern __attribute__((dllimport)) char *optarg; +//extern __attribute__((dllimport)) char *optarg; #else /* assume msvc */ #ifndef _WIN32 -extern __dllspec(dllimport) char *optarg; +//extern __dllspec(dllimport) char *optarg; #endif #endif #endif /* __WIN32__ */ diff --git a/libnet/sample/test_ipv6_icmpv4.c b/libnet/sample/test_ipv6_icmpv4.c index 704c5ac..03c2222 100644 --- a/libnet/sample/test_ipv6_icmpv4.c +++ b/libnet/sample/test_ipv6_icmpv4.c @@ -33,8 +33,11 @@ #include "./libnet_test.h" #include - +#ifdef _WIN32 +#include +#else #include +#endif static void print_pblocks(libnet_t* l) { diff --git a/libnet/src/libnet_link_win32.c b/libnet/src/libnet_link_win32.c index ab68d71..de7cdcb 100644 --- a/libnet/src/libnet_link_win32.c +++ b/libnet/src/libnet_link_win32.c @@ -45,7 +45,7 @@ #include #include #include -#include +#include #include "iprtrmib.h" int diff --git a/libnet/src/libnet_write.c b/libnet/src/libnet_write.c index 5c8717c..b11820f 100644 --- a/libnet/src/libnet_write.c +++ b/libnet/src/libnet_write.c @@ -35,8 +35,8 @@ #include "common.h" #if (_WIN32) || (__CYGWIN__) -#include "packet32.h" -#include "Ntddndis.h" +#include "Packet32.h" +#include "ntddndis.h" #endif int -- cgit v1.2.1 From bafed8aba984921dbc649f891528ea0a2714a15a Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Sat, 7 Jan 2017 04:12:00 +0300 Subject: Various fixes. Mostly by gvanem (PR no. #50) https://github.com/sam-github/libnet/pull/50 --- .travis.yml | 61 +++++++++--- Clean | 2 +- Package | 1 + libnet/configure.ac | 13 ++- libnet/include/libnet.h.in | 39 +++++--- libnet/include/libnet/libnet-functions.h | 3 +- libnet/include/libnet/libnet-structures.h | 4 +- libnet/sample/libnet_test.h | 32 ++----- libnet/src/common.h | 5 +- libnet/src/libnet_link_win32.c | 115 ++++++++-------------- libnet/src/libnet_prand.c | 50 ++++++---- libnet/src/libnet_resolve.c | 2 - libnet/src/libnet_write.c | 152 ++++++++---------------------- 13 files changed, 205 insertions(+), 274 deletions(-) diff --git a/.travis.yml b/.travis.yml index 4df619a..b5be10d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,21 +1,56 @@ language: c -script: - sudo make install +env: + global: + - secure: "Bi5J+Q+an9tX2mG+DnpQ6sSZOS1fgU95g68b6jHzzuELtdCcT+mI4b3muOeIWsw3pGfQ1XE2AbCWzH3YqC9m8zOgLxGG/S4KjnQwXSUJEXfHJv2+GUbNZ3XlqKkAedQRsJ8CCcawZu0lNLDoKaTG3ogczFxHfD5CptKgQsBt2j+OYwBWTFPxcywAKYWtYfN+mA26SXsZ5sj87xvb+74dPCsSzkU7yUs/LkOh7q+/SocV27Itx0zdLDKo6tmVIT2NzkHC0/JzwQG/lK4uhk85xP5QC3vxYnh8P8OL73oYBuxYZ0DUOxwuQFOd1vKx1db7EIy/0HBXICtmIofr4SDb1LjE5bdAyaCdNgrKKWn1vit5/T+a3k/w2Wre4tkargAlAYZ72mviIAraKcAbNL6NUpD00FvNoilV4bRTXZRguvrQ+rW/DJTnIxhzzGyyM4UM+qv3GlO1r/oDjOLygoZpTxCEst3UXdhobIc+v9k0w3/YXySmmeDOroTUB/lLMaLbETVJ6HFyihzVEQhWrNSAsyJv8QUIMkV5Dy7kNM5ai4cJal8fQrHbuJAhz9Z+r2LlF9OYxYYRdVg8+oyDCDI7sxa/mcpNHQgS1WjgJzaKwXuiE3rn1aPMoZFl+kG8ttJehubCxjLz/LZNc0pG4US4qGW5rvRF+IWtk64ABZ0IfJQ=" +script: if [ "${COVERITY_SCAN_BRANCH}" != 1 ]; then sudo make install ; fi branches: only: - master -compiler: - - gcc - - clang -os: - - linux -# I "sadly" don't have Mac. Not sure what dependencies are necessary to build libnet there. Uncomment and adjust line 14 if you do. - - osx +matrix: + include: + - compiler: clang + - compiler: gcc + - env: TARGET=win WIN_TOOL=i686-w64-mingw32 + - env: TARGET=win WIN_TOOL=x86_64-w64-mingw32 + allow_failures: + - env: TARGET=win WIN_TOOL=i686-w64-mingw32 + - env: TARGET=win WIN_TOOL=x86_64-w64-mingw32 before_install: - - if [ ${TRAVIS_OS_NAME} = "linux" ]; then sudo apt-get update -qq; sudo apt-get install doxygen libpcap-dev; fi - - if [ ${TRAVIS_OS_NAME} = "osx" ]; then brew update; brew install doxygen; fi -install: cd libnet && ../Prepare && ../Build + - if [ ${TRAVIS_OS_NAME} = linux ]; then sudo apt-get update -qq; sudo apt-get install doxygen libpcap-dev; fi + - if [ ${TRAVIS_OS_NAME} = osx ]; then brew update; brew install doxygen; fi + - if [ "${WIN_TOOL}" == i686-w64-mingw32 ]; then sudo apt-get -qq install mingw-w64 mingw-w64-tools binutils-mingw-w64-i686 gcc-mingw-w64-i686 doxygen; fi + - if [ "${WIN_TOOL}" == x86_64-w64-mingw32 ]; then sudo apt-get -qq install mingw-w64 mingw-w64-tools binutils-mingw-w64-i686 gcc-mingw-w64-i686 doxygen; fi +install: + - date + - if [ $TRAVIS_OS_NAME == linux ]; then cd libnet && ../Prepare && ../Build; fi + - if [ $TRAVIS_OS_NAME == osx ]; then cd libnet && ../Prepare && ../Build; fi + - if [ "${WIN_TOOL}" == i686-w64-mingw32 ]; then + wget http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip; + unzip WpdPack_4_1_2.zip; + cp WpdPack/Lib/wpcap.lib /usr/i686-w64-mingw32/lib; + cp WpdPack/Lib/Packet.lib /usr/i686-w64-mingw32/lib; + cd libnet && ./autogen.sh && ./configure --host=i686-w64-mingw32 --prefix=/usr/i686-w64-mingw32/ && make -C doc doc && make; + fi + -if [ "${WIN_TOOL}" == x86_64-w64-mingw32 ]; then + wget http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip; + unzip WpdPack_4_1_2.zip; + cp WpdPack/Lib/x64/Packet.lib /usr/x86_64-w64-mingw32/lib + cp WpdPack/Lib/x64/wpcap.lib /usr/x86_64-w64-mingw32/lib + cd libnet && ./autogen.sh && ./configure --host=x86_64-w64-mingw32 --prefix=/usr/x86_64-w64-mingw32/ && make -C doc doc && make; + fi + +addons: + coverity_scan: + project: + name: "sgeto/libnet" + version: 1.2-rc3 + description: "Portable low-level network packet construction API" + notification_email: autostart.ini@gmail.com + build_command_prepend: cd libnet && ../Prepare + build_command: cd libnet && ../Build + branch_pattern: master #add email if you want to get notified #notifications: # email: - +# on_success: change +# on_failure: change \ No newline at end of file diff --git a/Clean b/Clean index 39eff15..68f75bb 100755 --- a/Clean +++ b/Clean @@ -2,7 +2,7 @@ set -x -git clean -x -d +git clean -x -d -f (cd /usr/local/stow && sudo stow -D libnet) diff --git a/Package b/Package index babd2be..79ec4bd 100755 --- a/Package +++ b/Package @@ -1,3 +1,4 @@ +#!/bin/sh set -x diff --git a/libnet/configure.ac b/libnet/configure.ac index 721dc74..29b623b 100644 --- a/libnet/configure.ac +++ b/libnet/configure.ac @@ -77,7 +77,12 @@ AC_ARG_WITH( AC_CHECK_HEADERS([net/pfilt.h sys/net/nit.h net/raw.h sys/dlpi.h linux/socket.h]) AC_MSG_CHECKING(link-layer packet interface type) - +dnl +dnl If no suitable link-layer packet interface is found, +dnl we will fall back to libnet_link_win32 instead of libnet_link_none. +dnl With libnet_link_none the build wouldn't succeed anyway because +dnl the samples need a working link-layer packet interface. +dnl if test -n "${with_link_layer}"; then case "${with_link_layer}" in bpf) AC_LIBOBJ([libnet_link_bpf]) ;; @@ -128,8 +133,8 @@ elif test "$target_os" = "cygwin" ; then AC_MSG_RESULT(found link layer win32 wpcap) else AC_LIBOBJ([libnet_link_win32]) - AC_MSG_WARN(could not find a link-layer packet interface) - AC_MSG_WARN(link-layer packet injection will not be available) + AC_MSG_WARN(could not find a suitable link-layer packet interface) + AC_MSG_WARN(unless you're building with MinGW, link-layer packet injection will not be available) fi dnl This is necessary so that .o files in LIBOBJS are also built via @@ -296,7 +301,7 @@ dnl ;; *) - AC_MSG_WARN(apparently your OS is not officially supported yet) + AC_MSG_WARN(apparently your OS is not fully supported yet) AC_MSG_WARN(this may not work) AC_MSG_RESULT(please send diffs to vieuxtech@gmail.com) AC_CHECK_LIB(Packet, PacketSetMode, ,AC_MSG_ERROR(packet lib not found.)) diff --git a/libnet/include/libnet.h.in b/libnet/include/libnet.h.in index a063cc6..1b9af9b 100644 --- a/libnet/include/libnet.h.in +++ b/libnet/include/libnet.h.in @@ -1,6 +1,5 @@ /* - * $Id: libnet.h.in,v 1.5 2004/01/17 07:51:19 mike Exp $ - * + * libnet * libnet.h - Network routine library header file * * Copyright (c) 1998 - 2004 Mike D. Schiffman @@ -36,24 +35,24 @@ * @brief toplevel libnet header file */ -/** +/** * @mainpage Libnet Packet Assembly Library * * @section intro Overview * - * Libnet is a high-level API (toolkit) allowing the application programmer to - * construct and inject network packets. It provides a portable and simplified - * interface for low-level network packet shaping, handling and injection. - * Libnet hides much of the tedium of packet creation from the application - * programmer such as multiplexing, buffer management, arcane packet header - * information, byte-ordering, OS-dependent issues, and much more. Libnet + * Libnet is a high-level API (toolkit) allowing the application programmer to + * construct and inject network packets. It provides a portable and simplified + * interface for low-level network packet shaping, handling and injection. + * Libnet hides much of the tedium of packet creation from the application + * programmer such as multiplexing, buffer management, arcane packet header + * information, byte-ordering, OS-dependent issues, and much more. Libnet * features portable packet creation interfaces at the IP layer and link layer, - * as well as a host of supplementary and complementary functionality. Using + * as well as a host of supplementary and complementary functionality. Using * libnet, quick and simple packet assembly applications can be whipped up with - * little effort. With a bit more time, more complex programs can be written - * (Traceroute and ping were easily rewritten using libnet and + * little effort. With a bit more time, more complex programs can be written + * (Traceroute and ping were easily rewritten using libnet and * libpcap). - */ + */ #ifdef __cplusplus extern "C" { @@ -61,11 +60,14 @@ extern "C" { #include #include -#include #include #include #include +#if !defined(_MSC_VER) +# include +#endif + #if !defined(__WIN32__) # include #endif /* __WIN32__ */ @@ -114,6 +116,13 @@ extern "C" { #define LIBNET_API #endif +/* This must be copied from "libnet/win32/stdint.h" to "libnet/include/libnet/stdint.h" + * at build time. Yikes! + */ +#if defined(_MSC_VER) +# include "./libnet/stdint.h" +#endif + #include "./libnet/libnet-types.h" #include "./libnet/libnet-macros.h" #include "./libnet/libnet-headers.h" @@ -127,4 +136,4 @@ extern "C" { #endif /* __LIBNET_H */ -/* EOF */ +/* EOF */ \ No newline at end of file diff --git a/libnet/include/libnet/libnet-functions.h b/libnet/include/libnet/libnet-functions.h index 631fc40..42f27f5 100644 --- a/libnet/include/libnet/libnet-functions.h +++ b/libnet/include/libnet/libnet-functions.h @@ -1,6 +1,5 @@ /* - * $Id: libnet-functions.h,v 1.43 2004/11/09 07:05:07 mike Exp $ - * + * libnet * libnet-functions.h - function prototypes * * Copyright (c) 1998 - 2004 Mike D. Schiffman diff --git a/libnet/include/libnet/libnet-structures.h b/libnet/include/libnet/libnet-structures.h index 8a35269..948ec44 100644 --- a/libnet/include/libnet/libnet-structures.h +++ b/libnet/include/libnet/libnet-structures.h @@ -1,6 +1,4 @@ /* - * $Id: libnet-structures.h,v 1.19 2004/11/09 07:05:07 mike Exp $ - * * libnet-structures.h - Network routine library structures header file * * Copyright (c) 1998 - 2004 Mike D. Schiffman @@ -258,4 +256,4 @@ typedef struct _libnet_context_queue_descriptor libnet_cqd_t; #endif /* __LIBNET_STRUCTURES_H */ -/* EOF */ +/* EOF */ \ No newline at end of file diff --git a/libnet/sample/libnet_test.h b/libnet/sample/libnet_test.h index 4b531dc..cd7ab94 100644 --- a/libnet/sample/libnet_test.h +++ b/libnet/sample/libnet_test.h @@ -1,6 +1,4 @@ /* - * $Id: libnet_test.h,v 1.3 2004/01/29 21:17:16 mike Exp $ - * * libnet_test.h * * Copyright (c) 1998 - 2001 Mike D. Schiffman @@ -15,8 +13,7 @@ #include "../include/libnet.h" -#if (_WIN32) || (__CYGWIN__) -#else +#if !defined(__WIN32__) # include #endif @@ -44,26 +41,15 @@ u_char org_code[3] = {0x00, 0x00, 0x00}; void usage(char *); #if defined(__WIN32__) -#include -#include -#include -#ifndef _WIN32 -#include -#endif -/* The whole file is a mess, but everything starting from here is a real - mess and is breaking sample building. - These external symbols here make MinGW think that the actual functions will be - placed in a dynamic library when they aren't. Maybe they were. - Maybe it's a cygwin thing. For now, they're just causing trouble. */ -#if defined(__GNUC__) /* mingw compiler */ -//extern __attribute__((dllimport)) char *optarg; -#else /* assume msvc */ -#ifndef _WIN32 -//extern __dllspec(dllimport) char *optarg; -#endif -#endif + #include /* For non-MingW, this is a local libnet/win32/getopt.h */ + #include + #include + + #ifndef _MSC_VER + #include + #endif #endif /* __WIN32__ */ #endif /* __LIBNET_TEST_H */ -/* EOF */ +/* EOF */ \ No newline at end of file diff --git a/libnet/src/common.h b/libnet/src/common.h index ed7416d..2787df1 100644 --- a/libnet/src/common.h +++ b/libnet/src/common.h @@ -45,12 +45,9 @@ #else #include - #include - #include - /* TODO - should ../include/gnuc.h be included here? */ /* TODO - HAVE_OS_PROTO_H is never defined, but used in some files, delete it */ @@ -66,4 +63,4 @@ */ #ifndef IPPROTO_MH #define IPPROTO_MH 135 /* IPv6 mobility header */ -#endif +#endif \ No newline at end of file diff --git a/libnet/src/libnet_link_win32.c b/libnet/src/libnet_link_win32.c index de7cdcb..1368bac 100644 --- a/libnet/src/libnet_link_win32.c +++ b/libnet/src/libnet_link_win32.c @@ -1,6 +1,4 @@ /* - * $Id: libnet_link_win32.c,v 1.16 2004/02/18 18:19:00 mike Exp $ - * * libnet * libnet_link_win32.c - low-level win32 libwpcap routines * @@ -32,22 +30,16 @@ * */ -/* MSVC warns about snprintf. This needs to be defined before the declaration of _snprintf is seen. */ -#define _CRT_SECURE_NO_WARNINGS - /* Libnet's unnamespaced ICMP6_ macros stomp on the enumerated versions of these names in the MS headers, so pre-include this header. */ + #include #include /* From the Microsoft Platform SDK */ +#include +#include #include "common.h" -#include -#include -#include -#include -#include "iprtrmib.h" - int libnet_open_link(libnet_t *l) { @@ -55,9 +47,9 @@ libnet_open_link(libnet_t *l) NetType IFType; if (l == NULL) - { + { return (-1); - } + } if (l->device == NULL) { @@ -75,10 +67,10 @@ libnet_open_link(libnet_t *l) dwErrorCode=GetLastError(); snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, "%s(): unable to open the driver, error Code : %lx", - __func__, dwErrorCode); + __func__, dwErrorCode); return (-1); } - + /* increase the send buffer */ PacketSetBuff(l->lpAdapter, 512000); @@ -144,29 +136,18 @@ libnet_close_link_interface(libnet_t *l) } int -libnet_write_link(libnet_t *l, const uint8_t *packet, uint32_t size) +libnet_write_link(libnet_t *l, const uint8_t *data, uint32_t size) { - LPPACKET lpPacket; - DWORD BytesTransfered; + PACKET pkt; + DWORD BytesTransfered = -1; - BytesTransfered = -1; + /* Packet* arguments aren't const, but aren't actually modified. + */ + PacketInitPacket(&pkt, (PVOID)data, size); - if ((lpPacket = PacketAllocatePacket()) == NULL) - { - snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, - "%s(): failed to allocate the LPPACKET structure", __func__); - return (-1); - } - /* FIXME Packet* arguments aren't const, are they actually modified? That would be a problem, we can't modify our input */ - PacketInitPacket(lpPacket, packet, size); + if (PacketSendPacket(l->lpAdapter, &pkt, TRUE)) + BytesTransfered = size; - /* PacketSendPacket returns a BOOLEAN */ - if(PacketSendPacket(l->lpAdapter, lpPacket, TRUE)) - { - BytesTransfered = size; - } - - PacketFreePacket(lpPacket); return (BytesTransfered); } @@ -175,21 +156,21 @@ libnet_get_hwaddr(libnet_t *l) { /* This implementation is not-reentrant. */ static struct libnet_ether_addr *mac; - + ULONG IoCtlBufferLength = (sizeof(PACKET_OID_DATA) + sizeof(ULONG) - 1); PPACKET_OID_DATA OidData; - + int i = 0; if (l == NULL) - { + { return (NULL); - } + } if (l->device == NULL) - { + { if (libnet_select_device(l) == -1) - { + { snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, "%s(): can't figure out a device to use", __func__); return (NULL); @@ -205,7 +186,7 @@ libnet_get_hwaddr(libnet_t *l) } OidData = (struct _PACKET_OID_DATA *) malloc(IoCtlBufferLength); - + if (OidData == NULL) { snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, @@ -215,13 +196,13 @@ libnet_get_hwaddr(libnet_t *l) if (l->link_type == DLT_IEEE802) { - OidData->Oid = OID_802_5_CURRENT_ADDRESS; + OidData->Oid = OID_802_5_CURRENT_ADDRESS; } else { - OidData->Oid = OID_802_3_CURRENT_ADDRESS; + OidData->Oid = OID_802_3_CURRENT_ADDRESS; } - + OidData->Length = 6; if((PacketRequest(l->lpAdapter, FALSE, OidData)) == FALSE) { @@ -252,12 +233,12 @@ libnet_win32_get_remote_mac(libnet_t *l, DWORD DestIP) static BYTE bcastmac[]= {0xFF,0xFF,0xFF,0xFF,0xFF,0xFF}; BYTE *MAC = libnet_win32_read_arp_table(DestIP); - + if (MAC==NULL) { memset(pulMac, 0xff, sizeof (pulMac)); memset(&sin, 0, sizeof(sin)); - + if((hr = SendARP (DestIP, 0, pulMac, &ulLen)) != NO_ERROR) { *(int32_t *)&sin.sin_addr = DestIP; @@ -281,7 +262,7 @@ libnet_win32_get_remote_mac(libnet_t *l, DWORD DestIP) return(bcastmac); /* ff:ff:ff:ff:ff:ff */ } } - + pbHexMac = (PBYTE) pulMac; return (pbHexMac); @@ -295,26 +276,23 @@ libnet_win32_get_remote_mac(libnet_t *l, DWORD DestIP) BYTE * libnet_win32_read_arp_table(DWORD DestIP) { static BYTE buffMAC[6]; - BOOL fOrder=TRUE; - BYTE *MAC=NULL; - DWORD status, i, ci; - - PMIB_IPNETTABLE pIpNetTable = NULL; + BOOL fOrder = TRUE; + DWORD status; + + MIB_IPNETTABLE *pIpNetTable = NULL; DWORD Size = 0; - - memset(buffMAC, 0, sizeof(buffMAC)); - if((status = GetIpNetTable(pIpNetTable, &Size, fOrder)) == ERROR_INSUFFICIENT_BUFFER) + memset(buffMAC, 0, sizeof(buffMAC)); + status = GetIpNetTable(NULL, &Size, fOrder); + if (status == ERROR_INSUFFICIENT_BUFFER) { - pIpNetTable = (PMIB_IPNETTABLE) malloc(Size); - assert(pIpNetTable); + pIpNetTable = alloca(Size); status = GetIpNetTable(pIpNetTable, &Size, fOrder); } - if(status == NO_ERROR) + if (status == NO_ERROR) { - /* set current interface */ - ci = pIpNetTable->table[0].dwIndex; + DWORD i, ci = pIpNetTable->table[0].dwIndex; /* set current interface */ for (i = 0; i < pIpNetTable->dwNumEntries; ++i) { @@ -324,24 +302,11 @@ BYTE * libnet_win32_read_arp_table(DWORD DestIP) if(pIpNetTable->table[i].dwAddr == DestIP) /* found IP in arp cache */ { memcpy(buffMAC, pIpNetTable->table[i].bPhysAddr, sizeof(buffMAC)); - free(pIpNetTable); return buffMAC; - } + } } - - if (pIpNetTable) - free (pIpNetTable); - return(NULL); } - else - { - if (pIpNetTable) - { - free (pIpNetTable); - } - MAC=NULL; - } return(NULL); } -/* EOF */ +/* EOF */ \ No newline at end of file diff --git a/libnet/src/libnet_prand.c b/libnet/src/libnet_prand.c index f37c435..46c65dd 100644 --- a/libnet/src/libnet_prand.c +++ b/libnet/src/libnet_prand.c @@ -1,6 +1,4 @@ /* - * $Id: libnet_prand.c,v 1.7 2004/01/28 19:45:00 mike Exp $ - * * libnet * libnet_prand.c - pseudo-random number generation * @@ -29,24 +27,37 @@ * SUCH DAMAGE. * */ - + +/*random() and srandom() are not standard functions.*/ +#define random rand +#define srandom srand + #include "common.h" +#ifdef __WIN32__ +#include +#endif + +#ifndef _MSC_VER +#include /* gettimeofday() */ +#endif + + int libnet_seed_prand(libnet_t *l) { - #if !(__WIN32__) +#ifndef _MSC_VER struct timeval seed; - #endif +#endif if (l == NULL) - { + { return (-1); - } + } - #if __WIN32__ +#ifdef _MSC_VER srand((unsigned)time(NULL)); - #else +#else if (gettimeofday(&seed, NULL) == -1) { snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, @@ -58,7 +69,7 @@ libnet_seed_prand(libnet_t *l) * More entropy then just seeding with time(2). */ srandom((unsigned)(seed.tv_sec ^ seed.tv_usec)); - #endif +#endif return (1); } @@ -71,17 +82,16 @@ uint32_t libnet_get_prand(int mod) { uint32_t n; /* 0 to 4,294,967,295 */ -#ifndef _WIN32 +#ifndef __WIN32__ n = random(); #else - HCRYPTPROV hProv = 0; - CryptAcquireContext(&hProv, - 0, 0, PROV_RSA_FULL, - CRYPT_VERIFYCONTEXT); - - CryptGenRandom(hProv, - sizeof(n), (BYTE*)&n); - CryptReleaseContext(hProv, 0); + HCRYPTPROV hProv = 0; + + CryptAcquireContext(&hProv, + 0, 0, PROV_RSA_FULL, CRYPT_VERIFYCONTEXT); + + CryptGenRandom(hProv, sizeof(n), (BYTE*)&n); + CryptReleaseContext(hProv, 0); #endif switch (mod) { @@ -101,4 +111,4 @@ libnet_get_prand(int mod) return (0); /* NOTTREACHED */ } -/* EOF */ +/* EOF */ \ No newline at end of file diff --git a/libnet/src/libnet_resolve.c b/libnet/src/libnet_resolve.c index 948f3a3..6f66959 100644 --- a/libnet/src/libnet_resolve.c +++ b/libnet/src/libnet_resolve.c @@ -1,6 +1,4 @@ /* - * $Id: libnet_resolve.c,v 1.21 2004/11/09 07:05:07 mike Exp $ - * * libnet * libnet_resolve.c - various name resolution type routines * diff --git a/libnet/src/libnet_write.c b/libnet/src/libnet_write.c index b11820f..31ee93d 100644 --- a/libnet/src/libnet_write.c +++ b/libnet/src/libnet_write.c @@ -1,12 +1,10 @@ /* - * $Id: libnet_write.c,v 1.14 2004/11/09 07:05:07 mike Exp $ - * * libnet * libnet_write.c - writes a prebuilt packet to the network * * Copyright (c) 1998 - 2004 Mike D. Schiffman * All rights reserved. - * win32 specific code + * win32 specific code * Copyright (c) 2002 - 2003 Roberto Larcher * * Redistribution and use in source and binary forms, with or without @@ -34,11 +32,6 @@ #include "common.h" -#if (_WIN32) || (__CYGWIN__) -#include "Packet32.h" -#include "ntddndis.h" -#endif - int libnet_write(libnet_t *l) { @@ -47,7 +40,7 @@ libnet_write(libnet_t *l) uint8_t *packet = NULL; if (l == NULL) - { + { return (-1); } @@ -120,9 +113,9 @@ done: #if defined (__WIN32__) libnet_ptag_t -libnet_win32_build_fake_ethernet(uint8_t *dst, uint8_t *src, uint16_t type, -const uint8_t *payload, uint32_t payload_s, uint8_t *packet, libnet_t *l, -libnet_ptag_t ptag) +libnet_win32_build_fake_ethernet (uint8_t *dst, uint8_t *src, uint16_t type, + const uint8_t *payload, uint32_t payload_s, + uint8_t *packet, libnet_t *l, libnet_ptag_t ptag) { struct libnet_ethernet_hdr eth_hdr; @@ -131,7 +124,7 @@ libnet_ptag_t ptag) return (-1); } - memset(ð_hdr, 0, sizeof(eth_hdr)); + memset(ð_hdr, 0, sizeof(eth_hdr)); eth_hdr.ether_type = htons(type); memcpy(eth_hdr.ether_dhost, dst, ETHER_ADDR_LEN); /* destination address */ memcpy(eth_hdr.ether_shost, src, ETHER_ADDR_LEN); /* source address */ @@ -149,28 +142,28 @@ libnet_ptag_t ptag) } libnet_ptag_t -libnet_win32_build_fake_token(uint8_t *dst, uint8_t *src, uint16_t type, -const uint8_t *payload, uint32_t payload_s, uint8_t *packet, libnet_t *l, -libnet_ptag_t ptag) +libnet_win32_build_fake_token (uint8_t *dst, uint8_t *src, uint16_t type, + const uint8_t *payload, uint32_t payload_s, + uint8_t *packet, libnet_t *l, libnet_ptag_t ptag) { struct libnet_token_ring_hdr token_ring_hdr; - + if (!packet) { return (-1); } - memset(&token_ring_hdr, 0, sizeof(token_ring_hdr)); + memset(&token_ring_hdr, 0, sizeof(token_ring_hdr)); token_ring_hdr.token_ring_access_control = 0x10; token_ring_hdr.token_ring_frame_control = 0x40; token_ring_hdr.token_ring_llc_dsap = 0xaa; token_ring_hdr.token_ring_llc_ssap = 0xaa; token_ring_hdr.token_ring_llc_control_field = 0x03; token_ring_hdr.token_ring_type = htons(type); - memcpy(token_ring_hdr.token_ring_dhost, dst, ETHER_ADDR_LEN); - memcpy(token_ring_hdr.token_ring_shost, libnet_get_hwaddr(l), - ETHER_ADDR_LEN); - + memcpy(token_ring_hdr.token_ring_dhost, dst, ETHER_ADDR_LEN); + memcpy(token_ring_hdr.token_ring_shost, libnet_get_hwaddr(l), + ETHER_ADDR_LEN); + if (payload && payload_s) { /* @@ -185,45 +178,38 @@ libnet_ptag_t ptag) int libnet_win32_write_raw_ipv4(libnet_t *l, const uint8_t *payload, uint32_t payload_s) -{ +{ static BYTE dst[ETHER_ADDR_LEN]; static BYTE src[ETHER_ADDR_LEN]; - - uint8_t *packet = NULL; + + uint8_t *packet; uint32_t packet_s; - LPPACKET lpPacket = NULL; - DWORD remoteip = 0; - DWORD BytesTransfered; + DWORD remoteip = 0; NetType type; struct libnet_ipv4_hdr *ip_hdr = NULL; - + memset(dst, 0, sizeof(dst)); memset(src, 0, sizeof(src)); packet_s = payload_s + l->link_offset; - packet = (uint8_t *)malloc(packet_s); - if (packet == NULL) - { - snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, - "%s(): failed to allocate packet", __func__); - return (-1); - } - /* FIXME all the return paths below, except the last, leak 'packet' */ + packet = (uint8_t*) alloca(packet_s); - /* we have to do the IP checksum */ - /* FIXME MSVC warning is correct, checksum modifies its input. Fix is to build checksum inside the allocated 'packet' */ - if (libnet_inet_checksum(l, payload, IPPROTO_IP, LIBNET_IPV4_H, payload, payload+payload_s) == -1) + /* we have to do the IP checksum + * FIXME: warning is correct, checksum modifies its input. + * Fix is to build checksum inside the allocated 'packet' + */ + if (libnet_inet_checksum(l, (uint8_t*)payload, IPPROTO_IP, LIBNET_IPV4_H, payload, payload+payload_s) == -1) { /* error msg set in libnet_do_checksum */ return (-1); - } + } /* MACs, IPs and other stuff... */ ip_hdr = (struct libnet_ipv4_hdr *)payload; memcpy(src, libnet_get_hwaddr(l), sizeof(src)); remoteip = ip_hdr->ip_dst.S_un.S_addr; - + /* check if the remote station is the local station */ if (remoteip == libnet_get_ipaddr4(l)) { @@ -235,7 +221,7 @@ libnet_win32_write_raw_ipv4(libnet_t *l, const uint8_t *payload, uint32_t payloa } PacketGetNetType(l->lpAdapter, &type); - + switch(type.LinkType) { case NdisMedium802_3: @@ -256,29 +242,8 @@ libnet_win32_write_raw_ipv4(libnet_t *l, const uint8_t *payload, uint32_t payloa "%s(): network type (%d) is not supported", __func__, type.LinkType); return (-1); - break; - } - - BytesTransfered = -1; - if ((lpPacket = PacketAllocatePacket()) == NULL) - { - snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, - "%s(): failed to allocate the LPPACKET structure", __func__); - return (-1); - } - - PacketInitPacket(lpPacket, packet, packet_s); - - /* PacketSendPacket returns a BOOLEAN */ - if (PacketSendPacket(l->lpAdapter, lpPacket, TRUE)) - { - BytesTransfered = packet_s; } - - PacketFreePacket(lpPacket); - free(packet); - - return (BytesTransfered); + return libnet_write_link (l, packet, packet_s); } int @@ -304,9 +269,9 @@ libnet_write_raw_ipv4(libnet_t *l, const uint8_t *packet, uint32_t size) struct libnet_ipv4_hdr *ip_hdr; if (l == NULL) - { + { return (-1); - } + } ip_hdr = (struct libnet_ipv4_hdr *)packet; @@ -324,30 +289,6 @@ libnet_write_raw_ipv4(libnet_t *l, const uint8_t *packet, uint32_t size) memset(&sin, 0, sizeof(sin)); sin.sin_family = AF_INET; sin.sin_addr.s_addr = ip_hdr->ip_dst.s_addr; -#if (__WIN32__) - /* set port for TCP */ - /* - * XXX - should first check to see if there's a pblock for a TCP - * header, if not we can use a dummy value for the port. - */ - if (ip_hdr->ip_p == 6) - { - struct libnet_tcp_hdr *tcph_p = - (struct libnet_tcp_hdr *)(packet + (ip_hdr->ip_hl << 2)); - sin.sin_port = tcph_p->th_dport; - } - /* set port for UDP */ - /* - * XXX - should first check to see if there's a pblock for a UDP - * header, if not we can use a dummy value for the port. - */ - else if (ip_hdr->ip_p == 17) - { - struct libnet_udp_hdr *udph_p = - (struct libnet_udp_hdr *)(packet + (ip_hdr->ip_hl << 2)); - sin.sin_port = udph_p->uh_dport; - } -#endif /* __WIN32__ */ c = sendto(l->fd, packet, size, 0, (struct sockaddr *)&sin, sizeof(sin)); @@ -359,15 +300,9 @@ libnet_write_raw_ipv4(libnet_t *l, const uint8_t *packet, uint32_t size) if (c != size) { -#if !(__WIN32__) snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, "%s(): %d bytes written (%s)", __func__, c, strerror(errno)); -#else /* __WIN32__ */ - snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, - "%s(): %d bytes written (%d)", __func__, c, - WSAGetLastError()); -#endif /* !__WIN32__ */ } return (c); } @@ -375,20 +310,19 @@ libnet_write_raw_ipv4(libnet_t *l, const uint8_t *packet, uint32_t size) int libnet_write_raw_ipv6(libnet_t *l, const uint8_t *packet, uint32_t size) { + int c = -1; + #if defined HAVE_SOLARIS && !defined HAVE_SOLARIS_IPV6 snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, "%s(): no IPv6 support", __func__, strerror(errno)); - return (-1); -} #else - int c; struct sockaddr_in6 sin; struct libnet_ipv6_hdr *ip_hdr; if (l == NULL) - { + { return (-1); - } + } ip_hdr = (struct libnet_ipv6_hdr *)packet; @@ -396,22 +330,16 @@ libnet_write_raw_ipv6(libnet_t *l, const uint8_t *packet, uint32_t size) sin.sin6_family = AF_INET6; memcpy(sin.sin6_addr.s6_addr, ip_hdr->ip_dst.libnet_s6_addr, sizeof(ip_hdr->ip_dst.libnet_s6_addr)); - + c = sendto(l->fd, packet, size, 0, (struct sockaddr *)&sin, sizeof(sin)); if (c != size) { -#if !(__WIN32__) snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, "%s(): %d bytes written (%s)", __func__, c, strerror(errno)); -#else /* __WIN32__ */ - snprintf(l->err_buf, LIBNET_ERRBUF_SIZE, - "%s(): %d bytes written (%d)", __func__, c, - WSAGetLastError()); -#endif /* !__WIN32__ */ } +#endif /* HAVE_SOLARIS && !HAVE_SOLARIS_IPV6 */ return (c); } -#endif -#endif -/* EOF */ +#endif /* __WIN32__ */ +/* EOF */ \ No newline at end of file -- cgit v1.2.1 From 2199adae9289df279c48544259694aa104e222be Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Sat, 7 Jan 2017 05:31:54 +0300 Subject: omg travis.yml #2 --- .travis.yml | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/.travis.yml b/.travis.yml index b5be10d..030f700 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,8 +1,5 @@ language: c -env: - global: - - secure: "Bi5J+Q+an9tX2mG+DnpQ6sSZOS1fgU95g68b6jHzzuELtdCcT+mI4b3muOeIWsw3pGfQ1XE2AbCWzH3YqC9m8zOgLxGG/S4KjnQwXSUJEXfHJv2+GUbNZ3XlqKkAedQRsJ8CCcawZu0lNLDoKaTG3ogczFxHfD5CptKgQsBt2j+OYwBWTFPxcywAKYWtYfN+mA26SXsZ5sj87xvb+74dPCsSzkU7yUs/LkOh7q+/SocV27Itx0zdLDKo6tmVIT2NzkHC0/JzwQG/lK4uhk85xP5QC3vxYnh8P8OL73oYBuxYZ0DUOxwuQFOd1vKx1db7EIy/0HBXICtmIofr4SDb1LjE5bdAyaCdNgrKKWn1vit5/T+a3k/w2Wre4tkargAlAYZ72mviIAraKcAbNL6NUpD00FvNoilV4bRTXZRguvrQ+rW/DJTnIxhzzGyyM4UM+qv3GlO1r/oDjOLygoZpTxCEst3UXdhobIc+v9k0w3/YXySmmeDOroTUB/lLMaLbETVJ6HFyihzVEQhWrNSAsyJv8QUIMkV5Dy7kNM5ai4cJal8fQrHbuJAhz9Z+r2LlF9OYxYYRdVg8+oyDCDI7sxa/mcpNHQgS1WjgJzaKwXuiE3rn1aPMoZFl+kG8ttJehubCxjLz/LZNc0pG4US4qGW5rvRF+IWtk64ABZ0IfJQ=" -script: if [ "${COVERITY_SCAN_BRANCH}" != 1 ]; then sudo make install ; fi +script: sudo make install branches: only: - master @@ -21,7 +18,6 @@ before_install: - if [ "${WIN_TOOL}" == i686-w64-mingw32 ]; then sudo apt-get -qq install mingw-w64 mingw-w64-tools binutils-mingw-w64-i686 gcc-mingw-w64-i686 doxygen; fi - if [ "${WIN_TOOL}" == x86_64-w64-mingw32 ]; then sudo apt-get -qq install mingw-w64 mingw-w64-tools binutils-mingw-w64-i686 gcc-mingw-w64-i686 doxygen; fi install: - - date - if [ $TRAVIS_OS_NAME == linux ]; then cd libnet && ../Prepare && ../Build; fi - if [ $TRAVIS_OS_NAME == osx ]; then cd libnet && ../Prepare && ../Build; fi - if [ "${WIN_TOOL}" == i686-w64-mingw32 ]; then @@ -29,26 +25,13 @@ install: unzip WpdPack_4_1_2.zip; cp WpdPack/Lib/wpcap.lib /usr/i686-w64-mingw32/lib; cp WpdPack/Lib/Packet.lib /usr/i686-w64-mingw32/lib; - cd libnet && ./autogen.sh && ./configure --host=i686-w64-mingw32 --prefix=/usr/i686-w64-mingw32/ && make -C doc doc && make; - fi - -if [ "${WIN_TOOL}" == x86_64-w64-mingw32 ]; then + cd libnet && ./autogen.sh && ./configure --host=i686-w64-mingw32 --prefix=/usr/i686-w64-mingw32/ && make -C doc doc && make; fi + - if [ "${WIN_TOOL}" == x86_64-w64-mingw32 ]; then wget http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip; unzip WpdPack_4_1_2.zip; cp WpdPack/Lib/x64/Packet.lib /usr/x86_64-w64-mingw32/lib cp WpdPack/Lib/x64/wpcap.lib /usr/x86_64-w64-mingw32/lib - cd libnet && ./autogen.sh && ./configure --host=x86_64-w64-mingw32 --prefix=/usr/x86_64-w64-mingw32/ && make -C doc doc && make; - fi - -addons: - coverity_scan: - project: - name: "sgeto/libnet" - version: 1.2-rc3 - description: "Portable low-level network packet construction API" - notification_email: autostart.ini@gmail.com - build_command_prepend: cd libnet && ../Prepare - build_command: cd libnet && ../Build - branch_pattern: master + cd libnet && ./autogen.sh && ./configure --host=x86_64-w64-mingw32 --prefix=/usr/x86_64-w64-mingw32/ && make -C doc doc && make; fi #add email if you want to get notified #notifications: # email: -- cgit v1.2.1 From ba783f923ba0cbc1e1fa5e89dd35e3a866469dc3 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Sat, 7 Jan 2017 06:04:24 +0300 Subject: fixed conflicting types for 'rand' ans 'srand' on linux --- .travis.yml | 3 +++ libnet/src/libnet_prand.c | 8 ++++---- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.travis.yml b/.travis.yml index 030f700..3665fe4 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,6 +3,9 @@ script: sudo make install branches: only: - master +os: + - linux + - osx matrix: include: - compiler: clang diff --git a/libnet/src/libnet_prand.c b/libnet/src/libnet_prand.c index 46c65dd..d0bac82 100644 --- a/libnet/src/libnet_prand.c +++ b/libnet/src/libnet_prand.c @@ -28,16 +28,16 @@ * */ + +#ifdef __WIN32__ /*random() and srandom() are not standard functions.*/ #define random rand #define srandom srand - -#include "common.h" - -#ifdef __WIN32__ #include #endif +#include "common.h" + #ifndef _MSC_VER #include /* gettimeofday() */ #endif -- cgit v1.2.1 From 2c3fc99ff984a4128bc26a83a97de02c1fd4ad62 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Sat, 7 Jan 2017 08:26:57 +0300 Subject: omg travis.yml #5 --- .travis.yml | 63 ++++++++++++++++++++++++++++------------------- libnet/src/libnet_prand.c | 4 ++- 2 files changed, 40 insertions(+), 27 deletions(-) diff --git a/.travis.yml b/.travis.yml index 3665fe4..9bc0346 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,40 +1,51 @@ language: c -script: sudo make install branches: only: - master os: - linux - osx +compiler: + - gcc + - clang +addons: + apt: + packages: + - binutils-mingw-w64 + - gcc-mingw-w64 +before_install: + - if [ "$TRAVIS_OS_NAME" == "linux" ]; then sudo apt-get update -qq; sudo apt-get install doxygen libpcap-dev; fi + - if [ "$TRAVIS_OS_NAME" == "osx" ]; then brew update; brew install doxygen; fi + - if [ "$CC" == i686-w64-mingw32-gcc ]; then wget http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip; unzip WpdPack_4_1_2.zip; sudo cp WpdPack/Lib/wpcap.lib /usr/i686-w64-mingw32/lib; sudo cp WpdPack/Lib/Packet.lib /usr/i686-w64-mingw32/lib; cd libnet; ./autogen.sh; ./configure --host=i686-w64-mingw32 --prefix=/usr/i686-w64-mingw32/; make -C doc doc; fi + - if [ "$CC" == x86_64-w64-mingw32-gcc ]; then wget http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip; unzip WpdPack_4_1_2.zip; sudo cp WpdPack/Lib/x64/Packet.lib /usr/x86_64-w64-mingw32/lib; sudo cp WpdPack/Lib/x64/wpcap.lib /usr/x86_64-w64-mingw32/lib; cd libnet; ./autogen.sh; ./configure --host=x86_64-w64-mingw32 --prefix=/usr/x86_64-w64-mingw32/; make -C doc doc; fi matrix: - include: - - compiler: clang - - compiler: gcc - - env: TARGET=win WIN_TOOL=i686-w64-mingw32 - - env: TARGET=win WIN_TOOL=x86_64-w64-mingw32 - allow_failures: - - env: TARGET=win WIN_TOOL=i686-w64-mingw32 - - env: TARGET=win WIN_TOOL=x86_64-w64-mingw32 -before_install: - - if [ ${TRAVIS_OS_NAME} = linux ]; then sudo apt-get update -qq; sudo apt-get install doxygen libpcap-dev; fi - - if [ ${TRAVIS_OS_NAME} = osx ]; then brew update; brew install doxygen; fi - - if [ "${WIN_TOOL}" == i686-w64-mingw32 ]; then sudo apt-get -qq install mingw-w64 mingw-w64-tools binutils-mingw-w64-i686 gcc-mingw-w64-i686 doxygen; fi - - if [ "${WIN_TOOL}" == x86_64-w64-mingw32 ]; then sudo apt-get -qq install mingw-w64 mingw-w64-tools binutils-mingw-w64-i686 gcc-mingw-w64-i686 doxygen; fi + include: + - os: linux + compiler: gcc + - os: linux + compiler: clang + - os: osx + compiler: gcc + - os: osx + compiler: clang + - os: linux + compiler: i686-w64-mingw32-gcc + - os: linux + compiler: x86_64-w64-mingw32-gcc + allow_failures: + - os: linux + compiler: i686-w64-mingw32-gcc + - os: linux + compiler: x86_64-w64-mingw32-gcc install: - if [ $TRAVIS_OS_NAME == linux ]; then cd libnet && ../Prepare && ../Build; fi - if [ $TRAVIS_OS_NAME == osx ]; then cd libnet && ../Prepare && ../Build; fi - - if [ "${WIN_TOOL}" == i686-w64-mingw32 ]; then - wget http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip; - unzip WpdPack_4_1_2.zip; - cp WpdPack/Lib/wpcap.lib /usr/i686-w64-mingw32/lib; - cp WpdPack/Lib/Packet.lib /usr/i686-w64-mingw32/lib; - cd libnet && ./autogen.sh && ./configure --host=i686-w64-mingw32 --prefix=/usr/i686-w64-mingw32/ && make -C doc doc && make; fi - - if [ "${WIN_TOOL}" == x86_64-w64-mingw32 ]; then - wget http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip; - unzip WpdPack_4_1_2.zip; - cp WpdPack/Lib/x64/Packet.lib /usr/x86_64-w64-mingw32/lib - cp WpdPack/Lib/x64/wpcap.lib /usr/x86_64-w64-mingw32/lib - cd libnet && ./autogen.sh && ./configure --host=x86_64-w64-mingw32 --prefix=/usr/x86_64-w64-mingw32/ && make -C doc doc && make; fi + - if [ "$CC" == i686-w64-mingw32-gcc ]; then make; fi + - if [ "$CC" == x86_64-w64-mingw32-gcc ]; then make; fi +script: sudo make install +# coming soon? +# after_success: +# - if [ "$TRAVIS_OS_NAME" == "linux" ]; then bash <(curl -s https://example.com/example) ; fi #add email if you want to get notified #notifications: # email: diff --git a/libnet/src/libnet_prand.c b/libnet/src/libnet_prand.c index d0bac82..47c1653 100644 --- a/libnet/src/libnet_prand.c +++ b/libnet/src/libnet_prand.c @@ -30,9 +30,11 @@ #ifdef __WIN32__ -/*random() and srandom() are not standard functions.*/ +/* random() and srandom() are not standard functions. */ #define random rand #define srandom srand +//#include +/* Msys2 on Windows hate this (use above instead until I have time to fix) */ #include #endif -- cgit v1.2.1 From 5d32fe6851fb40aefcab6860ca8d89704efa1143 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Tue, 10 Jan 2017 04:39:29 +0300 Subject: added windows.h to libnet_prand.c to make wincrypt.h happy --- TODO | 23 +++++++++++++++++++++++ libnet/src/libnet_prand.c | 4 ++-- 2 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 TODO diff --git a/TODO b/TODO new file mode 100644 index 0000000..c9c296b --- /dev/null +++ b/TODO @@ -0,0 +1,23 @@ +short term goals: + +greatly improve documentation + +documentation is weird esp. libnet/doc/*.db +it needs to be build first or the make all will fail + +fix "broken" samples on win32 + +make mingw produce a dll's as well +libtool: warning: undefined symbols not allowed in x86_64-w64-mingw32 shared libraries; building static only + +fix MSVC/Mingw collision + +fix configure link-layer warning or implement win32 detection + +increase warning level on all OS's when using "Build" top level script + +make "Build" top level script + +long term goals: + +improve LUA bindings \ No newline at end of file diff --git a/libnet/src/libnet_prand.c b/libnet/src/libnet_prand.c index 47c1653..4f01d52 100644 --- a/libnet/src/libnet_prand.c +++ b/libnet/src/libnet_prand.c @@ -33,8 +33,8 @@ /* random() and srandom() are not standard functions. */ #define random rand #define srandom srand -//#include -/* Msys2 on Windows hate this (use above instead until I have time to fix) */ + +#include #include #endif -- cgit v1.2.1 From 3cbf43d0d63f594c209e1cf9569a4c74d391a742 Mon Sep 17 00:00:00 2001 From: Ali Abdulkadir Date: Thu, 26 Jan 2017 23:44:03 +0300 Subject: Finalized MinGW port + first wave of autotools enhancements --- .gitignore | 2 + .travis.yml | 53 +- Build | 4 +- CI | 22 + OBuild | 78 + Prebuilt | 16 + README.md | 2 +- TODO | 39 +- libnet/Makefile.am | 12 +- libnet/Makefile.am.common | 3 - libnet/configure.ac | 250 ++- libnet/doc/libnet.doxygen.conf | 2438 ++++++++++++++--------- libnet/doc/libnet.doxygen.conf.bak | 1777 +++++++++++++++++ libnet/include/libnet/libnet-headers.h | 2 +- libnet/sample/Makefile.am | 5 +- libnet/sample/dns.c | 2 +- libnet/sample/libnet_test.h | 8 + libnet/src/Makefile.am | 12 +- libnet/src/libnet-9.def | 176 ++ libnet/src/libnet_dll_info.rc | 58 + libnet/src/libnet_link_none.c | 2 +- libnet/src/libnet_prand.c | 2 +- libnet/src/libnet_write.c | 2 +- libnet/win32/Makefile.am | 2 +- libnet/win32/libnet.h | 2 +- libnet/win32/wpdpack/Include/Packet32.h | 359 ++++ libnet/win32/wpdpack/Include/Win32-Extensions.h | 113 ++ libnet/win32/wpdpack/Include/bittypes.h | 137 ++ libnet/win32/wpdpack/Include/ip6_misc.h | 163 ++ libnet/win32/wpdpack/Include/pcap-bpf.h | 47 + libnet/win32/wpdpack/Include/pcap-namedb.h | 42 + libnet/win32/wpdpack/Include/pcap-stdinc.h | 93 + libnet/win32/wpdpack/Include/pcap.h | 45 + libnet/win32/wpdpack/Include/pcap/bluetooth.h | 48 + libnet/win32/wpdpack/Include/pcap/bpf.h | 934 +++++++++ libnet/win32/wpdpack/Include/pcap/namedb.h | 89 + libnet/win32/wpdpack/Include/pcap/pcap.h | 407 ++++ libnet/win32/wpdpack/Include/pcap/sll.h | 129 ++ libnet/win32/wpdpack/Include/pcap/usb.h | 90 + libnet/win32/wpdpack/Include/pcap/vlan.h | 46 + libnet/win32/wpdpack/Include/remote-ext.h | 444 +++++ libnet/win32/wpdpack/README | 7 + libnet/win32/wpdpack/license.txt | 78 + 43 files changed, 7209 insertions(+), 1031 deletions(-) create mode 100644 CI create mode 100644 OBuild create mode 100644 Prebuilt create mode 100644 libnet/doc/libnet.doxygen.conf.bak create mode 100644 libnet/src/libnet-9.def create mode 100644 libnet/src/libnet_dll_info.rc create mode 100644 libnet/win32/wpdpack/Include/Packet32.h create mode 100644 libnet/win32/wpdpack/Include/Win32-Extensions.h create mode 100644 libnet/win32/wpdpack/Include/bittypes.h create mode 100644 libnet/win32/wpdpack/Include/ip6_misc.h create mode 100644 libnet/win32/wpdpack/Include/pcap-bpf.h create mode 100644 libnet/win32/wpdpack/Include/pcap-namedb.h create mode 100644 libnet/win32/wpdpack/Include/pcap-stdinc.h create mode 100644 libnet/win32/wpdpack/Include/pcap.h create mode 100644 libnet/win32/wpdpack/Include/pcap/bluetooth.h create mode 100644 libnet/win32/wpdpack/Include/pcap/bpf.h create mode 100644 libnet/win32/wpdpack/Include/pcap/namedb.h create mode 100644 libnet/win32/wpdpack/Include/pcap/pcap.h create mode 100644 libnet/win32/wpdpack/Include/pcap/sll.h create mode 100644 libnet/win32/wpdpack/Include/pcap/usb.h create mode 100644 libnet/win32/wpdpack/Include/pcap/vlan.h create mode 100644 libnet/win32/wpdpack/Include/remote-ext.h create mode 100644 libnet/win32/wpdpack/README create mode 100644 libnet/win32/wpdpack/license.txt diff --git a/.gitignore b/.gitignore index 8843ef7..d001602 100644 --- a/.gitignore +++ b/.gitignore @@ -18,6 +18,7 @@ Makefile.in aclocal.m4 autom4te.cache compile +config.cache config.guess config.h.in config.log @@ -34,6 +35,7 @@ libnet-1.?.? libnet-1.?.?.tar.gz libnet-*.tar.gz libnet-1.?.tar.gz +libnet-*.tar.bz2 libnet-config libnet/*-stamp libnet/debian diff --git a/.travis.yml b/.travis.yml index 9bc0346..796b847 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,52 +2,19 @@ language: c branches: only: - master -os: - - linux - - osx compiler: - gcc - clang -addons: - apt: - packages: - - binutils-mingw-w64 - - gcc-mingw-w64 -before_install: +os: + - linux + - osx +before_install: - if [ "$TRAVIS_OS_NAME" == "linux" ]; then sudo apt-get update -qq; sudo apt-get install doxygen libpcap-dev; fi - if [ "$TRAVIS_OS_NAME" == "osx" ]; then brew update; brew install doxygen; fi - - if [ "$CC" == i686-w64-mingw32-gcc ]; then wget http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip; unzip WpdPack_4_1_2.zip; sudo cp WpdPack/Lib/wpcap.lib /usr/i686-w64-mingw32/lib; sudo cp WpdPack/Lib/Packet.lib /usr/i686-w64-mingw32/lib; cd libnet; ./autogen.sh; ./configure --host=i686-w64-mingw32 --prefix=/usr/i686-w64-mingw32/; make -C doc doc; fi - - if [ "$CC" == x86_64-w64-mingw32-gcc ]; then wget http://www.winpcap.org/install/bin/WpdPack_4_1_2.zip; unzip WpdPack_4_1_2.zip; sudo cp WpdPack/Lib/x64/Packet.lib /usr/x86_64-w64-mingw32/lib; sudo cp WpdPack/Lib/x64/wpcap.lib /usr/x86_64-w64-mingw32/lib; cd libnet; ./autogen.sh; ./configure --host=x86_64-w64-mingw32 --prefix=/usr/x86_64-w64-mingw32/; make -C doc doc; fi -matrix: - include: - - os: linux - compiler: gcc - - os: linux - compiler: clang - - os: osx - compiler: gcc - - os: osx - compiler: clang - - os: linux - compiler: i686-w64-mingw32-gcc - - os: linux - compiler: x86_64-w64-mingw32-gcc - allow_failures: - - os: linux - compiler: i686-w64-mingw32-gcc - - os: linux - compiler: x86_64-w64-mingw32-gcc -install: - - if [ $TRAVIS_OS_NAME == linux ]; then cd libnet && ../Prepare && ../Build; fi - - if [ $TRAVIS_OS_NAME == osx ]; then cd libnet && ../Prepare && ../Build; fi - - if [ "$CC" == i686-w64-mingw32-gcc ]; then make; fi - - if [ "$CC" == x86_64-w64-mingw32-gcc ]; then make; fi +install: cd libnet && ../Prepare && ../Build script: sudo make install -# coming soon? -# after_success: -# - if [ "$TRAVIS_OS_NAME" == "linux" ]; then bash <(curl -s https://example.com/example) ; fi -#add email if you want to get notified -#notifications: -# email: -# on_success: change -# on_failure: change \ No newline at end of file +after_success: + - bash <(curl -s https://codecov.io/bash) +notifications: + email: autostart.ini@gmail.com + diff --git a/Build b/Build index 8d3eb22..efd4de2 100755 --- a/Build +++ b/Build @@ -4,5 +4,5 @@ set -e make -C doc doc make -make dist && mv libnet-1*.tar.gz .. - +make dist && mv libnet-1*.tar.gz libnet-1*.tar.bz2 .. +make -C../lua diff --git a/CI b/CI new file mode 100644 index 0000000..c6dd20e --- /dev/null +++ b/CI @@ -0,0 +1,22 @@ +#!/bin/bash + +#Scrip for everything Travis CI + +set -o nounset +set -o xtrace + + +CFLAGS="-O0 -Wall -Wextra --coverage" ./configure --with-pic + +make -C doc doc +make + + + +# NOTES: + +# Coverage data matches the source files more closely if you do not optimize. + +# --coverage +# This option is used to compile and link code instrumented for coverage analysis. The option is +# a synonym for -fprofile-arcs -ftest-coverage (when compiling) and -lgcov (when linking). \ No newline at end of file diff --git a/OBuild b/OBuild new file mode 100644 index 0000000..55f3906 --- /dev/null +++ b/OBuild @@ -0,0 +1,78 @@ +#!/bin/bash + +# This is a test script for the new --enable-fast configure script option. +# The flags that work well together and/or turned out to be useful here, will eventually +# be added to configure.ac's --enable-fast section. + +# All types of optimization interfere with debugging. +# You can't have it all! +disable debugging alltogether!! +set -o nounset +set -o xtrace + +mkdir -p ../prebuilt.w32 + +CFLAGS="-g0 -Ofast -Wall -Wextra -Wdisabled-optimization -Wunsafe-loop-optimizations -Wno-aggressive-loop-optimizations -Wnull-dereference -funsafe-loop-optimizations -funsafe-math-optimizations -fgcse-sm -fgcse-las" ./configure --with-pic + +make LDFLAGS="-Wl,--strip-all -Wl,--relax -Wl,--warn-common" + + + # -Ofast +# Disregard strict standards compliance. -Ofast enables all -O3 optimizations: + +# -fauto-inc-dec -fbranch-count-reg -fcombine-stack-adjustments -fcompare-elim -fcprop-registers +# -fdce -fdefer-pop -fdelayed-branch -fdse -fforward-propagate -fguess-branch-probability +# -fif-conversion2 -fif-conversion -finline-functions-called-once -fipa-pure-const -fipa-profile +# -fipa-reference -fmerge-constants -fmove-loop-invariants -freorder-blocks -fshrink-wrap +# -fsplit-wide-types -fssa-backprop -fssa-phiopt -ftree-bit-ccp -ftree-ccp -ftree-ch +# -ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts -ftree-dse +# -ftree-forwprop -ftree-fre -ftree-phiprop -ftree-sink -ftree-slsr -ftree-sra -ftree-pta +# -ftree-ter -funit-at-a-time + +# -fthread-jumps -falign-functions -falign-jumps -falign-loops -falign-labels -fcaller-saves +# -fcrossjumping -fcse-follow-jumps -fcse-skip-blocks -fdelete-null-pointer-checks -fdevirtualize +# -fdevirtualize-speculatively -fexpensive-optimizations -fgcse -fgcse-lm -fhoist-adjacent-loads +# -finline-small-functions -findirect-inlining -fipa-cp -fipa-cp-alignment -fipa-sra -fipa-icf +# -fisolate-erroneous-paths-dereference -flra-remat -foptimize-sibling-calls -foptimize-strlen +# -fpartial-inlining -fpeephole2 -freorder-blocks-algorithm=stc -freorder-blocks-and-partition +# -freorder-functions -frerun-cse-after-loop -fsched-interblock -fsched-spec -fschedule-insns +# -fschedule-insns2 -fstrict-aliasing -fstrict-overflow -ftree-builtin-call-dce +# -ftree-switch-conversion -ftree-tail-merge -ftree-pre -ftree-vrp -fipa-ra + +# -finline-functions, -funswitch-loops, -fpredictive-commoning, -fgcse-after-reload, +# -ftree-loop-vectorize, -ftree-loop-distribute-patterns, -fsplit-paths -ftree-slp-vectorize, +# -fvect-cost-model, -ftree-partial-pre and -fipa-cp-clone + +# Please note the warning under -fgcse about invoking -O2 on programs that use computed gotos. +# also turns on -fomit-frame-pointer on machines where doing so does not interfere with +# debugging. + +# -Ofast also enables optimizations that are not valid for all standard-compliant programs. +# It turns on -ffast-math and the Fortran-specific -fno-protect-parens and -fstack-arrays. + +# Options of the form -fflag specify machine-independent flags. Most flags have both positive and +# negative forms; the negative form of -ffoo is -fno-foo. In the table below, only one of the forms +# is listed---the one you typically use. You can figure out the other form by either removing no- or +# adding it. + + # -Wdisabled-optimization +# Warn if a requested optimization pass is disabled. This warning does not generally indicate +# that there is anything wrong with your code; it merely indicates that GCC's optimizers are +# unable to handle the code effectively. Often, the problem is that your code is too big or too +# complex; GCC refuses to optimize programs when the optimization itself is likely to take +# inordinate amounts of time. + + # -Wunsafe-loop-optimizations +# Warn if the loop cannot be optimized because the compiler cannot assume anything on the bounds +# of the loop indices. With -funsafe-loop-optimizations warn if the compiler makes such +# assumptions. + + # -funsafe-loop-optimizations +# This option tells the loop optimizer to assume that loop indices do not overflow, and that loops +# with nontrivial exit condition are not infinite. This enables a wider range of loop +# optimizations even if the loop optimizer itself cannot prove that these assumptions are valid. +# If you use -Wunsafe-loop-optimizations, the compiler warns you if it finds this kind of loop. + + # -Wno-aggressive-loop-optimizations +# Warn if in a loop with constant number of iterations the compiler detects undefined behavior in +# some statement during one or more of the iterations. \ No newline at end of file diff --git a/Prebuilt b/Prebuilt new file mode 100644 index 0000000..ff40a75 --- /dev/null +++ b/Prebuilt @@ -0,0 +1,16 @@ +#!/bin/sh + +set -x +set -e + +mkdir -p ../prebuilt.w32 + +CFLAGS="-Os" ./configure --with-pic --disable-samples --prefix=/c/Users/Ali/projects/libnet/prebuilt.w32/ + +make clean + +make -j4 + +make install + +cp src/libnet-9.def ../prebuilt.w32/lib/ \ No newline at end of file diff --git a/README.md b/README.md index 7dba0fb..ac98cc0 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Some old docs are at: **A C library for portable packet creation and injection** -Libnet is an API to help with the construction and handling of network packets. It provides a portable framework for low-level network packet writing and handling (use libnet in conjunction with libpcap and you can write some really cool stuff). Libnet includes packet creation at the IP layer and at the link layer as well as a host of supplementary and complementary functionality. Libnet is very handy with which to write network tools and network test code. See the manpage and sample test code for more detailed information. +Libnet is an API to help with the construction and handling of network packets. It provides a portable framework for low-level network packet writing and handling (use libnet in conjunction with libpcap and you can write some really cool stuff). Libnet includes packet creation at the IP layer and at the link layer as well as a host of supplementary and complementary functionality. Libnet is very handy with which to write network tools and network test code. See the manpage and sample test code for more detailed information. Your old code (circa *libnet-1.0.x*) WILL NOT WORK with *libnet-1.1.x*. Read *doc/MIGRATION* for easy steps on porting your old code. diff --git a/TODO b/TODO index c9c296b..0da945d 100644 --- a/TODO +++ b/TODO @@ -1,14 +1,33 @@ +This file complements the TODO in doc/TODO + + +Roadmap: + +the --enable-samples option in configure never worked. And no one noticed... :( + +add INSTALL and edit README in libnet/README + +Is it "libnet" or "Libnet"? Can we please agree on one? All Uppercase or all lowercase!! +LIBNET or libnet + short term goals: -greatly improve documentation +I'm afraid the build system needs a complete overhaul. +Recursive "make" +ACLOCAL_AMFLAGS=-I m4 in Makefile.am.common is not considered + +improve documentation +- FAQ +- Examples +- add RFCs documentation is weird esp. libnet/doc/*.db -it needs to be build first or the make all will fail +it needs to be build first or "make" will fail -fix "broken" samples on win32 +fix "broken" samples (on win32?) make mingw produce a dll's as well -libtool: warning: undefined symbols not allowed in x86_64-w64-mingw32 shared libraries; building static only +libtool: warning: undefined symbols not allowed No Shared libraries support not available with x86_64-w64-mingw32; building static only fix MSVC/Mingw collision @@ -18,6 +37,16 @@ increase warning level on all OS's when using "Build" top level script make "Build" top level script +add link_layer_none.c and make sample building more link_layer_none friendly + long term goals: -improve LUA bindings \ No newline at end of file +come after as many reasonable issues in https://github.com/sam-github/libnet/issues/ and http://stackoverflow.com/questions/tagged/libnet# as possible + +Somethings not right with checksums... + +improve LUA bindings + +test and verify everything IPv6 + +Dynamic loading \ No newline at end of file diff --git a/libnet/Makefile.am b/libnet/Makefile.am index e03c886..ccb1268 100644 --- a/libnet/Makefile.am +++ b/libnet/Makefile.am @@ -1,4 +1,3 @@ -# $Id: Makefile.am,v 1.7 2004/03/01 20:26:11 mike Exp $ # # Libnet automake information file # Copyright (c) 1998 - 2004 Mike D. Schiffman @@ -6,10 +5,17 @@ # # Process this file with automake to produce a Makefile.in script. +ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS} + include $(top_srcdir)/Makefile.am.common -SUBDIRS = include src sample doc win32 +SUBDIRS = include src doc win32 + +if ENABLE_SAMPLES +SUBDIRS += sample +endif -EXTRA_DIST = Makefile.am.common msvcbuild.bat +EXTRA_DIST = Makefile.am.common msvcbuild.bat # m4/NOTES bin_SCRIPTS = libnet-config + diff --git a/libnet/Makefile.am.common b/libnet/Makefile.am.common index 4ca3e7d..59725ef 100644 --- a/libnet/Makefile.am.common +++ b/libnet/Makefile.am.common @@ -4,12 +4,9 @@ # Copyright (c) 1998 - 2004 Mike D. Schiffman # All rights reserved. # - AUTOMAKE_OPTIONS = foreign no-dependencies DISTCLEANFILES = *~ -ACLOCAL_AMFLAGS=-I m4 - AM_CPPFLAGS = -I$(top_srcdir)/include diff --git a/libnet/configure.ac b/libnet/configure.ac index 29b623b..3e90e80 100644 --- a/libnet/configure.ac +++ b/libnet/configure.ac @@ -1,27 +1,43 @@ +dnl dnl Libnet autoconfiguration information file dnl Copyright (c) 1998 - 2002 Mike D. Schiffman +dnl Modified by Ali Abdulkadir dnl All rights reserved. dnl dnl Process this file with autoconf to produce a configure script. -AC_INIT([libnet],[1.2-rc3]) +AC_INIT([libnet],[1.2-rc3],[autostart.ini@gmail.com],[libnet],[https://github.com/sgeto/libnet]) +dnl the autotools and libtool should be at least these versions +dnl (default on UBUNTU & Co) +AC_PREREQ([2.69]) +LT_PREREQ([2.4.2]) +AC_COPYRIGHT echo "Copyright @{:@c@:}@ 2017 The libnet Developer Community" AC_MSG_RESULT(beginning autoconfiguration process for libnet-${PACKAGE_VERSION} ...) AC_CANONICAL_TARGET AC_CONFIG_SRCDIR([src/libnet_build_ip.c]) AC_CONFIG_MACRO_DIR([m4]) -AM_INIT_AUTOMAKE +AM_INIT_AUTOMAKE([1.14.1 dist-bzip2]) AC_CONFIG_HEADERS([include/config.h]) +dnl people do not like you. And I do not need you... AM_MAINTAINER_MODE -dnl +dnl the default compiler flags are "-O2 -g" if the user does not set anything. +dnl IMO O2 optimizations are fine, but debugging should be completely up to the +dnl user. The following test does just that. (Do not move these lines +dnl below "AC_PROG_CC"!!) +if test -z $CFLAGS; then + CFLAGS="-O2" +fi + dnl Check for the usual programs -dnl AC_PROG_CC AC_PROG_INSTALL AC_USE_SYSTEM_EXTENSIONS -dnl disable shared libraries (for now) -dnl AC_DISABLE_SHARED -LT_INIT + +LT_INIT([win32-dll]) +dnl LT_PROG_RC +LT_LANG([Windows Resource]) + AC_CHECK_HEADERS(sys/sockio.h) AC_CHECK_FUNCS([gethostbyname2]) @@ -31,13 +47,10 @@ AC_TYPE_UINT32_T AC_TYPE_UINT64_T AC_MSG_CHECKING(for socklen_t) -AC_TRY_COMPILE([ +AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[ #include #include - ], - [ socklen_t x; ], - have_socklen_t=yes, - have_socklen_t=no) + ]], [[ socklen_t x; ]])],[have_socklen_t=yes],[have_socklen_t=no]) if test "x$have_socklen_t" = "xyes"; then AC_DEFINE(HAVE_SOCKLEN_T, 1, [define if socklen_t is defined]) fi @@ -66,9 +79,7 @@ dnl if test "$prefix" = "NONE"; then dnl prefix="/usr" dnl fi -dnl dnl Get link-layer interface type -dnl AC_ARG_WITH( [link-layer], [AS_HELP_STRING([--with-link-layer],[when cross-compiling, one of * from libnet_link_*.c @<:@autodetect@:>@])] @@ -77,12 +88,7 @@ AC_ARG_WITH( AC_CHECK_HEADERS([net/pfilt.h sys/net/nit.h net/raw.h sys/dlpi.h linux/socket.h]) AC_MSG_CHECKING(link-layer packet interface type) -dnl -dnl If no suitable link-layer packet interface is found, -dnl we will fall back to libnet_link_win32 instead of libnet_link_none. -dnl With libnet_link_none the build wouldn't succeed anyway because -dnl the samples need a working link-layer packet interface. -dnl + if test -n "${with_link_layer}"; then case "${with_link_layer}" in bpf) AC_LIBOBJ([libnet_link_bpf]) ;; @@ -91,9 +97,11 @@ if test -n "${with_link_layer}"; then nit) AC_LIBOBJ([libnet_link_nit]) ;; snoop) AC_LIBOBJ([libnet_link_snoop]) ;; dlpi) AC_LIBOBJ([libnet_link_dlpi]) ;; + win32) AC_LIBOBJ([libnet_link_win32]) ;; + none) AC_LIBOBJ([libnet_link_none]) ;; linux) AC_LIBOBJ([libnet_link_linux]) - AC_LIBNET_CHECK_PF_PACKET - AC_LIBNET_LINUX_PROCFS ;; + AC_LIBNET_CHECK_PF_PACKET + AC_LIBNET_LINUX_PROCFS ;; none) AC_LIBOBJ([libnet_link_none]) ;; *) AC_MSG_ERROR([Invalid link type "${with_link_layer}"]) ;; esac @@ -131,10 +139,13 @@ elif test "${cross_compiling}" != "yes" -a -c /dev/nit ; then # check elif test "$target_os" = "cygwin" ; then AC_LIBOBJ([libnet_link_win32]) AC_MSG_RESULT(found link layer win32 wpcap) -else +elif test "$host" = "i686-w64-mingw32" -o "x86_64-w64-mingw32" -o "x86_64-pc-mingw64"; then AC_LIBOBJ([libnet_link_win32]) - AC_MSG_WARN(could not find a suitable link-layer packet interface) - AC_MSG_WARN(unless you're building with MinGW, link-layer packet injection will not be available) + AC_MSG_RESULT(found link layer windows @<:@WinPcap@:>@) +else + AC_LIBOBJ([libnet_link_none]) + AC_MSG_WARN(could not find a link-layer packet interface) + AC_MSG_WARN(link-layer packet injection will not be available) fi dnl This is necessary so that .o files in LIBOBJS are also built via @@ -144,21 +155,66 @@ LIB@&t@OBJS=`echo "$LIB@&t@OBJS" | LTLIBOBJS=`echo "$LIB@&t@OBJS" | sed 's,\.[[^.]]* ,.lo ,g;s,\.[[^.]]*$,.lo,'` - - -dnl dnl Inform user about the packet builders we've got -dnl echo -n "scanning available packet construction modules: " for dir in src/*build*c ; do echo $dir | sed -e /src\\/libnet_build_/s/// | sed -e /\\.c/s/// | tr \\n \\040 done echo "" -dnl -dnl Check and set OS specific parameters -dnl +dnl Check for sample building +AC_MSG_CHECKING([whether to build sample programs]) +AC_ARG_ENABLE([samples], + [AS_HELP_STRING([--disable-samples],[do not build sample programs @<:@default=no@:>@])], + [enable_samples=$enableval], + [enable_samples=yes] +) +AC_MSG_RESULT([$enable_samples]) + +AM_CONDITIONAL([ENABLE_SAMPLES], [test "$enable_samples" = "yes"]) + + +dnl Check for debug +dnl FIXME make it do any actual debuging +AC_MSG_CHECKING([whether to compile in debug mode]) +AC_ARG_ENABLE([debug], + [AS_HELP_STRING([--enable-debug],[compile with extra debugging output @<:@default=no@:>@])], + [use_debug=$enableval], + [use_debug=no] +) +AC_MSG_RESULT([$use_debug]) + +dnl Check for max speed +dnl FIXME add more flags +AC_MSG_CHECKING([whether to enable optimizations]) +AC_ARG_ENABLE([fast], + [AS_HELP_STRING([--enable-fast],[compile with optimizations @<:@default=no@:>@])], + [use_fast=$enableval], + [use_fast=no] +) +AC_MSG_RESULT([$use_fast]) + +if test "x${use_fast}" != "xno" +then + if test "x${use_debug}" != "xno" + then + AC_MSG_ERROR([Cannot specify --enable-fast and --enable-debug at the same time.]) + fi +fi + +if test "x$use_fast" = "xyes" +then + OPT_FLAGS="-O2 -g -fno-strict-aliasing" +else + OPT_FLAGS="-O0 -ggdb" + AM_CFLAGS="${AM_CFLAGS} -fkeep-inline-functions" + if test "x$use_debug" = "xyes" + then + AM_CPPFLAGS="${AM_CPPFLAGS} -DDEBUG -DTRACE" + fi +fi +dnl Check and set OS specific parameters case "$target_os" in *linux*) @@ -274,7 +330,7 @@ dnl esac - ADDITIONAL_LIBS='-lresolv -lsocket -lnsl' + ADDITIONAL_LIBS="-lresolv -lsocket -lnsl" LIBNET_CONFIG_LIBS="$LIBNET_CONFIG_LIBS -lresolv -lsocket -lnsl" ;; @@ -285,38 +341,66 @@ dnl ;; *cygwin*) - AC_DEFINE(LIBNET_BSDISH_OS, 1, - [Define if our build OS supports the BSD APIs]) - AC_DEFINE(NO_SNPRINTF, 1, - [Define if snprintf() is unavailable on our system.]) - LIBNET_CONFIG_DEFINES="-DLIBNET_BSDISH_OS -DNO_SNPRINTF" - CFLAGS="$CFLAGS -mno-cygwin -O0 -fnative-struct -DNO_SNPRINTF -I/usr/include/pcap" - AC_CHECK_LIB(packet, PacketSetMode, ,AC_MSG_ERROR(packet lib not found.)) - AC_CHECK_LIB(wpcap, pcap_setmode, ,AC_MSG_ERROR(pcap lib not found.)) - LIBS="$LIBS -lws2_32" - ;; +dnl FIXME I should probably get rid of this... + AC_DEFINE(LIBNET_BSDISH_OS, 1, + [Define if our build OS supports the BSD APIs]) + AC_DEFINE(NO_SNPRINTF, 1, + [Define if snprintf() is unavailable on our system.]) + LIBNET_CONFIG_DEFINES="-DLIBNET_BSDISH_OS -DNO_SNPRINTF" + CFLAGS="$CFLAGS -mno-cygwin -O0 -fnative-struct -DNO_SNPRINTF -I/usr/include/pcap" + AC_CHECK_LIB(packet, PacketSetMode, ,AC_MSG_ERROR(packet lib not found.)) + AC_CHECK_LIB(wpcap, pcap_setmode, ,AC_MSG_ERROR(pcap lib not found.)) + LIBS="$LIBS -lws2_32" + ;; + +*mingw*) + WIN32="yes" + AC_SUBST(WIN32) + AC_CHECK_TOOL([WINDRES], [windres], AC_MSG_ERROR([windres not found])) + AC_SUBST(WINDRES) + if test "${cross_compiling}" = "yes" ; then + if test "$host" = "i686-w64-mingw32" ; then + AC_CHECK_LIB(packet, PacketSetMode, ,AC_MSG_ERROR(libpacket.a not found.)) + AC_CHECK_LIB(wpcap, pcap_setmode, ,AC_MSG_ERROR(libwpcap.a not found.)) + LIBS="$LIBS -lws2_32 -liphlpapi" + CFLAGS="$CFLAGS -static-libgcc -march=i686 -mwin32 -DWIN32_LEAN_AND_MEAN" + else + AC_CHECK_LIB(packet, PacketSetMode, ,AC_MSG_ERROR(libpacket.a not found. See README.win32 for more information)) + AC_CHECK_LIB(wpcap, pcap_setmode, ,AC_MSG_ERROR(libwpcap.a not found. See README.win32 for more information)) + LIBS="$LIBS -lws2_32 -liphlpapi" + CFLAGS="$CFLAGS -static-libgcc -mwin32" + LDFLAGS="$LDFLAGS -Wl,--high-entropy-va" + fi + else + if test "$host" = "i686-w64-mingw32" ; then + AC_CHECK_LIB(packet, PacketSetMode, ,AC_MSG_ERROR(libpacket.a not found.)) + AC_CHECK_LIB(wpcap, pcap_setmode, ,AC_MSG_ERROR(libwpcap.a not found.)) + LIBS="$LIBS -lws2_32 -liphlpapi" + CFLAGS="$CFLAGS -march=i686 -mwin32 -DWIN32_LEAN_AND_MEAN" + else + AC_CHECK_LIB(packet, PacketSetMode, ,AC_MSG_ERROR(libpacket.a not found. See README.win32 for more information)) + AC_CHECK_LIB(wpcap, pcap_setmode, ,AC_MSG_ERROR(libwpcap.a not found. See README.win32 for more information)) + LIBS="$LIBS -lws2_32 -liphlpapi" + CFLAGS="$CFLAGS -mwin32 -DWIN32_LEAN_AND_MEAN" + LDFLAGS="$LDFLAGS -Wl,--high-entropy-va" + fi + fi + ;; *irix*) CFLAGS="$CFLAGS -DINET6=1" ;; *) - AC_MSG_WARN(apparently your OS is not fully supported yet) - AC_MSG_WARN(this may not work) - AC_MSG_RESULT(please send diffs to vieuxtech@gmail.com) - AC_CHECK_LIB(Packet, PacketSetMode, ,AC_MSG_ERROR(packet lib not found.)) - AC_CHECK_LIB(wpcap, pcap_setmode, ,AC_MSG_ERROR(pcap lib not found.)) - LIBS="$LIBS -lws2_32 -liphlpapi" - CFLAGS="$CFLAGS -mwin32 -W -Wall -Wextra -fno-common -Wcast-align -Wredundant-decls -Wbad-function-cast -Wwrite-strings -Waggregate-return -Wstrict-prototypes -Wmissing-prototypes" - ;; + AC_MSG_WARN(apparently your OS is not officially supported yet) + AC_MSG_WARN(this may not work) + AC_MSG_RESULT(please send diffs to autostart.ini@gmail.com) + ;; esac - -AC_ARG_ENABLE([samples], - [AS_HELP_STRING([--enable-samples],[install the sample programs @<:@default=no@:>@])]) - -AM_CONDITIONAL([INSTALL_SAMPLES], [test x"$enable_samples" = xyes]) +dnl this should only matter if we are building for Windows... +AM_CONDITIONAL([WIN32], [test "${WIN32}" = "yes"]) AC_CONFIG_FILES([Makefile src/Makefile \ include/Makefile \ @@ -325,4 +409,58 @@ AC_CONFIG_FILES([Makefile src/Makefile \ doc/man/Makefile doc/man/man3/Makefile doc/html/Makefile \ include/libnet.h libnet-config]) AC_OUTPUT + +AC_MSG_RESULT([ +-=-=-=-=-=-=-=-=-=-= $PACKAGE Configuration Complete =-=-=-=-=-=-=-=-=-=-=- + + +Configuration Summary + + Version : ..................... ${VERSION} + Protocols: .................... 32 + + Host : ........................ ${host} + Operating System: ............. ${host_os} + Host CPU : .................... ${host_cpu} + Host Vendor : ................. ${host_vendor} + Host OS : ..................... ${host_os} + prefix: ....................... ${prefix} + +Compilation Environment + + Cross-compiling: .............. ${cross_compiling} + Compiler is GCC: .............. ${ac_cv_c_compiler_gnu} + CC: ........................... ${CC} + CFLAGS:........................ ${CFLAGS} + LD: ........................... ${LD} + LDFLAGS: ......................${LDFLAGS} + LIBS: ......................... ${LIBS} + +Features and Examples + + Link Layer: ...................${LTLIBOBJS} + Shared Libraries: ............. ${enable_shared} + Static Libraries: ............. ${enable_static} + PIC ........................... ${pic_mode} / ${with-pic} + Debugging: .................... ${use_debug} + Additional Optimizations: ..... ${use_fast} + Build Sample Programs: ........ ${enable_samples} + +To override options, see ./configure --help +]) + +case "$target_os" in + +*mingw*) + AC_MSG_WARN([To compile shared libaries on mingw, use the WinPcap libaries in $(pwd)/win32/. +GNU ld is NOT able to produce x64 compatible images using the official WinPcap Developer Pack. +See README.win32 for more information.]) + ;; + +*) + AC_MSG_RESULT([Report bugs to https://github.com/sgeto/libnet/issues]) + ;; + +esac + dnl EOF diff --git a/libnet/doc/libnet.doxygen.conf b/libnet/doc/libnet.doxygen.conf index e127a64..593c4c5 100644 --- a/libnet/doc/libnet.doxygen.conf +++ b/libnet/doc/libnet.doxygen.conf @@ -1,110 +1,129 @@ -# Doxyfile 1.8.1.2 +# Doxyfile 1.8.11 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored. +# 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 (" "). +# 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. +# 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 sequence of words) that should -# identify the project. Note that if you do not use Doxywizard you need -# to put quotes around the project name if it contains spaces. +# 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 = "libnet" -# 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. +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. PROJECT_NUMBER = "1.1" # 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. +# 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 an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. -# Doxygen will copy the logo to the output directory. +# 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) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. +# 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 = "doc" -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. +# 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. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. +# 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 (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. +# 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 (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# 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" "the" +# 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 +# doxygen will generate a detailed section even if there is only a brief # description. +# The default value is: NO. ALWAYS_DETAILED_SEC = NO @@ -112,221 +131,276 @@ ALWAYS_DETAILED_SEC = NO # 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 then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. FULL_PATH_NAMES = NO -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. +# 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 include paths that -# are normally passed to the compiler using the -I flag. +# 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 if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. +# 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 -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) +# 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 comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# 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 behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. +# 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 (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. +# 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. +# 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. +# 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 acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. +# 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. +# 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. +# 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 -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. +# 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 only. Doxygen will then generate output that is more tailored for -# 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. +# 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, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. +# 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 MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all -# comments according to the Markdown format, which allows for more readable +# 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 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); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration +# 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 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. +# 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 (the default) -# will make doxygen 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. +# 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 +# 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 (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. SUBGROUPING = YES -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and -# unions are shown inside the group in which they are included (e.g. using -# @ingroup) instead of on a separate page (for HTML and Man pages) or -# section (for LaTeX and RTF). +# 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 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 (the default), -# structs, classes, and unions are shown on a separate page (for HTML and Man -# pages) or section (for LaTeX and RTF). +# 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 is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So +# 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 +# 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 -# Similar to the SYMBOL_CACHE_SIZE 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 appear 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. +# 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 @@ -334,341 +408,407 @@ 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 and EXTRACT_STATIC tags are set to YES +# 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. +# 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. +# 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. +# 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. +# 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 = NO -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. +# 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 namespaces are hidden. +# '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 of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_MEMBERS = YES -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. +# 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 = YES -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. +# 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 (the default) these blocks will be appended to the -# function's detailed documentation block. +# 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 (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# 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 +# 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 (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. SHOW_INCLUDE_FILES = YES -# If the 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. +# 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 (the default) then a tag [inline] -# is inserted in the documentation for inline members. +# 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 (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. +# 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 documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. +# 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 default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. +# 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 default) -# the group names will appear in their defined order. +# 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 default), the class list will be sorted only by class name, -# not including the namespace part. +# 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. +# 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. +# 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 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 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 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 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 sectionname ... \endif. +# 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 -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. +# 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 +# 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 is 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 is 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 , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. +# 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. +# 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 references data. This must be a list of .bib files. The -# .bib extension is automatically appended if omitted. Using this command -# 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. +# 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 +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. +# 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 WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. WARN_IF_UNDOCUMENTED = NO -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. +# 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 -# The 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 (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. +# 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 = YES -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text " -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. +# 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 +# Configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. INPUT = include/libnet \ include/libnet.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, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. +# 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 pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.for *.vhd *.vhdl +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# 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, *.pyw, *.f90, *.f, *.for, *.tcl, +# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. FILE_PATTERNS = *.h -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. +# # Note that relative paths are relative to the directory from which doxygen is # run. @@ -677,14 +817,16 @@ EXCLUDE = include/libnet/libnet-headers.h # 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/* +# 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 = */sample/* @@ -693,755 +835,1130 @@ EXCLUDE_PATTERNS = */sample/* # 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). +# 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 tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. +# 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 image that are included in the documentation (see -# the \image command). +# 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. +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). +# 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 option only has effect when -# FILTER_SOURCE_FILES is enabled. +# 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 +# Configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. +# 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 and classes directly in the documentation. +# 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 (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C, C++ and Fortran comments will always remain visible. +# 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. +# 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. +# 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 (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. -# Otherwise they will link to the documentation. +# 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 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. +# 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 to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# 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. +# 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 = NO -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) +# 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 one or more prefixes that -# should be ignored while generating the index headers. +# 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 +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. +# 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). If it is left blank -# doxygen will generate files with .html extension. +# 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 personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. Note that when using a custom header you are responsible -# for the proper inclusion of any scripts and style sheets that doxygen -# needs, which is dependent on the configuration options used. -# It is advised to generate a default header using "doxygen -w html -# header.html footer.html stylesheet.css YourConfigFile" and then modify -# that header. Note that the header is subject to change so you typically -# have to redo this when upgrading to a newer version of doxygen or when -# changing the value of configuration settings such as GENERATE_TREEVIEW! +# 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 personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. +# 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 the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# style sheet in the HTML output directory as well, or it will be erased! +# 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. +# $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. -# The allowed range is 0 to 359. +# 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. +# 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. +# 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. +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = 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. +# 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, 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 +# 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 -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. +# 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" -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. +# 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 -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# 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 GENERATE_PUBLISHER_NAME tag identifies the documentation 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, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# 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 -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# 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 = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. +# 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 = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). +# 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 -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. +# 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 = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. +# 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 contents of the HTML help documentation and to the tree view. +# 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. +# 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. +# 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 -# http://doc.trolltech.com/qthelpproject.html#namespace +# 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 -# http://doc.trolltech.com/qthelpproject.html#virtual-folders +# 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 QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters +# 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_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. +# 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. +# 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 = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. +# 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, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. +# 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. +# 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 -# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) -# at top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. Since the tabs have the same information as the -# navigation tree you can set this option to NO if you already set -# GENERATE_TREEVIEW to YES. +# 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. -# Since the tree basically has the same information as the tab index you -# could consider to set DISABLE_INDEX to NO when enabling this option. +# 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 -# (range [0,1..20]) 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. +# 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. +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. +# 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. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. +# 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 before the changes have effect. +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you may also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. +# 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 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. +# 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://www.mathjax.org/mathjax -# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension -# names that should be enabled during MathJax rendering. +# 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 = -# 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. +# 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 +# , /