pax_global_header00006660000000000000000000000064130173605440014515gustar00rootroot0000000000000052 comment=68d0793c53cd8b3a0456d8af0489469f8f072f9e SoapySDR-soapy-sdr-0.5.4/000077500000000000000000000000001301736054400151065ustar00rootroot00000000000000SoapySDR-soapy-sdr-0.5.4/.travis.yml000066400000000000000000000055451301736054400172300ustar00rootroot00000000000000######################################################################## ## Travis CI config for SoapySDR ## ## * matrix tests compilers and build types ## * python bindings built and installed ## * python3 bindings built and installed ## * minimal testing for command line util ## * minimal testing for python bindings ######################################################################## sudo: required dist: trusty language: cpp compiler: gcc env: global: - INSTALL_PREFIX=/usr/local - PYTHON_EXECUTABLE=/usr/bin/python - PYTHON_INSTALL_DIR=lib/python2.7/dist-packages - PYTHON3_EXECUTABLE=/usr/bin/python3 - PYTHON3_INSTALL_DIR=lib/python3/dist-packages matrix: - BUILD_TYPE=Debug - BUILD_TYPE=Release # whitelist branches: only: - master - maint before_install: # regular ubuntu packages - sudo add-apt-repository main - sudo add-apt-repository universe # update after package changes - sudo apt-get update install: # install python support dependencies - sudo apt-get install -qq python python-dev python-numpy swig # install python3 support dependencies - sudo apt-get install -qq python3 python3-dev python3-numpy swig script: - mkdir build - cd build - cmake ../ -DCMAKE_INSTALL_PREFIX=${INSTALL_PREFIX} -DCMAKE_BUILD_TYPE=${BUILD_TYPE} -DPYTHON_EXECUTABLE=${PYTHON_EXECUTABLE} -DPYTHON3_EXECUTABLE=${PYTHON3_EXECUTABLE} - make - sudo make install # setup environment paths - export LD_LIBRARY_PATH=${INSTALL_PREFIX}/lib:${LD_LIBRARY_PATH} - export PATH=${INSTALL_PREFIX}/bin:${PATH} # basic test for command line utility - SoapySDRUtil --info - SoapySDRUtil --check=null - SoapySDRUtil --make="driver=null" # basic test for python bindings - export PYTHONPATH=${INSTALL_PREFIX}/${PYTHON_INSTALL_DIR}:/usr/${PYTHON_INSTALL_DIR} - echo ${PYTHONPATH} - ${PYTHON_EXECUTABLE} -c "import SoapySDR; print(SoapySDR.getAPIVersion())" - ${PYTHON_EXECUTABLE} -c "from SoapySDR import *; print(SOAPY_SDR_ABI_VERSION)" - ${PYTHON_EXECUTABLE} -c "from SoapySDR import *; print(SOAPY_SDR_TIMEOUT)" - ${PYTHON_EXECUTABLE} -c "import SoapySDR; print(SoapySDR.errToStr(SoapySDR.SOAPY_SDR_TIMEOUT))" - ${PYTHON_EXECUTABLE} -c "import SoapySDR; print(SoapySDR.Device.make('driver=null'))" # basic test for python3 bindings - export PYTHONPATH=${INSTALL_PREFIX}/${PYTHON3_INSTALL_DIR}:/usr/${PYTHON3_INSTALL_DIR} - echo ${PYTHONPATH} - ${PYTHON3_EXECUTABLE} -c "import SoapySDR; print(SoapySDR.getAPIVersion())" - ${PYTHON3_EXECUTABLE} -c "from SoapySDR import *; print(SOAPY_SDR_ABI_VERSION)" - ${PYTHON3_EXECUTABLE} -c "from SoapySDR import *; print(SOAPY_SDR_TIMEOUT)" - ${PYTHON3_EXECUTABLE} -c "import SoapySDR; print(SoapySDR.errToStr(SoapySDR.SOAPY_SDR_TIMEOUT))" - ${PYTHON3_EXECUTABLE} -c "import SoapySDR; print(SoapySDR.Device.make('driver=null'))" # run unit tests - make test SoapySDR-soapy-sdr-0.5.4/CMakeLists.txt000066400000000000000000000157211301736054400176540ustar00rootroot00000000000000######################################################################## # Project setup ######################################################################## cmake_minimum_required(VERSION 2.8.7) project(SoapySDR) enable_language(CXX) enable_testing() ######################################################################## # gather version information # packagers may specify -DSOAPY_SDR_EXTVER="foo" to replace the git hash ######################################################################## set(SOAPY_SDR_LIBVER "0.5.4") if (NOT SOAPY_SDR_EXTVER) include(${PROJECT_SOURCE_DIR}/cmake/GetGitRevisionDescription.cmake) get_git_head_revision(GITREFSPEC GITHASH) if (GITHASH) string(SUBSTRING "${GITHASH}" 0 8 GITHASH) set(SOAPY_SDR_EXTVER "g${GITHASH}") else (GITHASH) set(SOAPY_SDR_EXTVER "unknown") endif (GITHASH) endif() set(SOAPY_SDR_VERSION "${SOAPY_SDR_LIBVER}-${SOAPY_SDR_EXTVER}") #SOAPY_SDR_ROOT is compiled into the library to locate the install base. #By default, the SOAPY_SDR_ROOT is set to the CMAKE_INSTALL_PREFIX. #However users may overload this by specifying -DSOAPY_SDR_ROOT=. set(SOAPY_SDR_ROOT "${CMAKE_INSTALL_PREFIX}" CACHE PATH "Installation root for SoapySDR::getRootPath()") file(TO_CMAKE_PATH "${SOAPY_SDR_ROOT}" SOAPY_SDR_ROOT) #SOAPY_SDR_ROOT_ENV is the name of the environment variable #which tells SoapySDR where to find the root installation. #By default, the environment variable SOAPY_SDR_ROOT is used. #Example: set -DSOAPY_SDR_ROOT_ENV=SNAP for snappy packages. set(SOAPY_SDR_ROOT_ENV "SOAPY_SDR_ROOT" CACHE STRING "Environment variable for SoapySDR::getRootPath()") ######################################################################## # select the release build type by default to get optimization flags ######################################################################## if(NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE "Release") message(STATUS "Build type not specified: defaulting to release.") endif(NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} CACHE STRING "") ######################################################################## # rpath setup - http://www.cmake.org/Wiki/CMake_RPATH_handling ######################################################################## # use, i.e. don't skip the full RPATH for the build tree option(CMAKE_SKIP_BUILD_RPATH "skip rpath build" FALSE) # when building, don't use the install RPATH already # (but later on when installing) option(CMAKE_BUILD_WITH_INSTALL_RPATH "build with install rpath" FALSE) # the RPATH to be used when installing, but only if it's not a system directory option(CMAKE_AUTOSET_INSTALL_RPATH TRUE) if(CMAKE_AUTOSET_INSTALL_RPATH) LIST(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/lib${LIB_SUFFIX}" isSystemDir) IF("${isSystemDir}" STREQUAL "-1") SET(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib${LIB_SUFFIX}") ENDIF("${isSystemDir}" STREQUAL "-1") endif(CMAKE_AUTOSET_INSTALL_RPATH) # add the automatically determined parts of the RPATH # which point to directories outside the build tree to the install RPATH option(CMAKE_INSTALL_RPATH_USE_LINK_PATH "build with automatic rpath" TRUE) if(APPLE) set(CMAKE_MACOSX_RPATH ON) endif() ######################################################################## # Allows in-tree module util ######################################################################## set(SoapySDR_DIR ${PROJECT_SOURCE_DIR}/cmake) set(SOAPY_SDR_IN_TREE_SOURCE_DIR ${PROJECT_SOURCE_DIR}) find_package(SoapySDR NO_MODULE REQUIRED) include_directories(${SoapySDR_INCLUDE_DIRS}) #local include precedence ######################################################################## # Install cmake helper modules ######################################################################## configure_file( ${PROJECT_SOURCE_DIR}/cmake/SoapySDRConfigVersion.in.cmake ${PROJECT_BINARY_DIR}/SoapySDRConfigVersion.cmake @ONLY) set(cmake_files ${PROJECT_SOURCE_DIR}/cmake/SoapySDRConfig.cmake ${PROJECT_SOURCE_DIR}/cmake/SoapySDRUtil.cmake ${PROJECT_BINARY_DIR}/SoapySDRConfigVersion.cmake) if (UNIX) install(FILES ${cmake_files} DESTINATION share/cmake/${PROJECT_NAME}) elseif (WIN32) install(FILES ${cmake_files} DESTINATION cmake) endif () ######################################################################## # Install headers ######################################################################## install(DIRECTORY include/SoapySDR DESTINATION include) ######################################################################## # Build subdirs ######################################################################## add_subdirectory(lib) add_subdirectory(apps) add_subdirectory(tests) add_subdirectory(docs) ######################################################################## # Python support (optional) ######################################################################## option(ENABLE_PYTHON "enable python bindings" ON) if (ENABLE_PYTHON) message(STATUS "") message(STATUS "#############################################") message(STATUS "## Begin configuration for Python support...") message(STATUS "#############################################") message(STATUS "Enabling optional Python bindings if possible...") add_subdirectory(python) if(BUILD_PYTHON3) message(STATUS "") message(STATUS "#############################################") message(STATUS "## Begin configuration for Python3 support...") message(STATUS "#############################################") message(STATUS "Enabling optional Python3 bindings if possible...") add_subdirectory(python3) endif(BUILD_PYTHON3) endif (ENABLE_PYTHON) ######################################################################## # uninstall target ######################################################################## configure_file( "${CMAKE_CURRENT_SOURCE_DIR}/cmake_uninstall.cmake.in" "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake" IMMEDIATE @ONLY) #only add uninstall target if this is the top project if(${CMAKE_PROJECT_NAME} STREQUAL ${PROJECT_NAME}) add_custom_target(uninstall COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake) endif() ######################################################################### # summary ######################################################################### include(FeatureSummary) message(STATUS "") message(STATUS "######################################################") message(STATUS "## ${PROJECT_NAME} enabled features") message(STATUS "######################################################") feature_summary(WHAT ENABLED_FEATURES) message(STATUS "######################################################") message(STATUS "## ${PROJECT_NAME} disabled features") message(STATUS "######################################################") feature_summary(WHAT DISABLED_FEATURES) message(STATUS "SoapySDR version: v${SOAPY_SDR_VERSION}") message(STATUS "ABI/so version: v${SOAPY_SDR_ABI_VERSION}") message(STATUS "Install prefix: ${CMAKE_INSTALL_PREFIX}") SoapySDR-soapy-sdr-0.5.4/Changelog.txt000066400000000000000000000123221301736054400175360ustar00rootroot00000000000000This this the changelog file for the SoapySDR project. Release 0.5.4 (2016-11-29) ========================== - Added man page for SoapySDRUtil executable - Dynamic root environment variable to support snappy packages - Windows: disable graphical error pop-ups when DLLs are not found - Debian: replaced recommends with soapysdr-modules-all metapackage Release 0.5.3 (2016-09-01) ========================== - Additional try/catch blocks for C API wrapper safety Release 0.5.2 (2016-08-18) ========================== - Fixes for Doxygen warnings and Doxyfile version upgrade - Additional build helpers for python development config Release 0.5.1 (2016-08-02) ========================== - Added SoapySDR_getLibVersion() and SOAPY_SDR_API_VERSION - debian allow any swig >= 2.0.0 using the swig meta-package - Only use stderr in the default logger for command line tools - ABI-specific modules directory for multi-version install Release 0.5.0 (2016-07-10) ========================== Deprecated Device API calls: - Deprecated setCommandTime, use setHardwareTime - Deprecated listBandwidths, use getBandwidthRange - Deprecated unnamed read/writeRegister, use named General additions and changes: - Created wait trigger flag for trigger-based streaming - Added device factory lock to the python enumerate wrapper - Added named register API for multiple register interfaces - Added channel info API call for channel-specific info - Setup CMake rpath handling to be enabled by default - Moved time source calls to time API section - C bindings return status code and stash the error message - Added getBandwidthRange() API call for continuous ranges - Use current DLL path to determine the system install root - Implemented channel-specific settings API Release 0.4.4 (2016-07-10) ========================== - Add known python version 3.5 to FindPython3Libs.cmake - Fix FindPython3Libs.cmake use of python3-config --includes Release 0.4.3 (2016-04-21) ========================== - CMake SOAPY_SDR_SOVER variable cache fix use INTERNAL type - Added missing memset for internal use of SoapySDRKwargs type - Fix SoapySDRDevice declarations for use in a C only compiler Release 0.4.2 (2016-03-02) ========================== - Fixes for SOAPY_SDR_MODULE_UTIL destination and install prefix - CMake override for PYTHON_INSTALL_DIR and PYTHON3_INSTALL_DIR Release 0.4.1 (2016-01-27) ========================== - Added readStreamStatus() to python bindings - Notes on stream timeouts for client code compatibility - Fix debian upstream changelog and license install - Added official modules to debian Recommends Release 0.4.0 (2015-12-10) ========================== - Added check for driver present to util app - Workaround for multiple null module load - Added defines for common stream formats - Support dual build of python2 and python3 - Improved module loader API and results query - New query information for SoapySDRUtil --probe - Added setLogLevel() and default log threshold - Added API to query native stream format - Added C++ typedef for list of Kwargs - Added API to query tune argument info - Added API to query sensors meta info - Added API to query setting argument info - Added API to query stream argument info - CMAKE_BUILD_TYPE automatically defaults to Release - Added API to query AGC mode availability - Added API to query available clock rates - Set library SOVERSION using SOAPY_SDR_ABI_VERSION Release 0.3.1 (2015-10-11) ========================== - Fixed missing python bindings for Errors.hpp - Added -DSOAPY_SDR_ROOT= option to build Release 0.3.0 (2015-10-10) ========================== - Util --probe option for detailed info summary - Added corrections API to check for availability - Added API to convert error codes to string - Added per-channel API to query readback sensors - Added GPIO API data direction modification mask - Removed SoapyUHD and SoapyOsmo submodules Release 0.2.3 (2015-10-08) ========================== - Append to linker flags to avoid overwriting them - Link with -flat_namespace for OSX application bundle - GCC link with -pthread for threaded client support Release 0.2.2 (2015-08-15) ========================== - Fixed vector in python swig bindings - Support CMake 2.8.7 builds (ubuntu 12.04 lts) Release 0.2.1 (2015-07-09) ========================== - Fixed Device::make() factory argument forwarding - Added Time.h/Time.hpp time conversion API calls - Implement SoapySDRConfigVersion.cmake version check Release 0.2.0 (2015-06-15) ========================== - Support /usr/local module installs when root is /usr - Support SOAPY_SDR_PLUGIN_PATH environment variable - Added logger support for stream status indicator - Frequency component API and tune distribution algorithm - Added direct buffer access API for read and write streams - Automatic gain distribution and overall range calculations - Added read stream status Device API call - Added additional error codes and status flags Release 0.1.1 (2015-06-14) ========================== - Fix path issues for listModules() implementation under MSVC - Support openSuSE for automatic LIB_SUFFIX detection logic - patch for missing add_compile_options in older CMake Release 0.1.0 (2015-01-31) ========================== This is the first public release of the SoapySDR project. SoapySDR-soapy-sdr-0.5.4/ExampleDriver/000077500000000000000000000000001301736054400176555ustar00rootroot00000000000000SoapySDR-soapy-sdr-0.5.4/ExampleDriver/CMakeLists.txt000066400000000000000000000027231301736054400224210ustar00rootroot00000000000000######################################################################## # Project setup -- only needed if device support is a stand-alone build # We recommend that the support module be built in-tree with the driver. ######################################################################## cmake_minimum_required(VERSION 2.6) project(SoapySDRMyDevice CXX) enable_testing() #select the release build type by default to get optimization flags if(NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE "Release") message(STATUS "Build type not specified: defaulting to release.") endif(NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} CACHE STRING "") ######################################################################## # Header and library resources needed to communicate with the device. # These may be found within the build tree or in an external project. ######################################################################## set(MY_DEVICE_INCLUDE_DIRS ...) set(MY_DEVICE_LIBRARIES ...) ######################################################################## # build the module ######################################################################## find_package(SoapySDR CONFIG) if (NOT SoapySDR_FOUND) message(WARNING "SoapySDR development files not found - skipping support") return() endif () include_directories(${MY_DEVICE_INCLUDE_DIRS}) SOAPY_SDR_MODULE_UTIL( TARGET MyDevice SOURCES MyDeviceSupport.cpp LIBRARIES ${MY_DEVICE_LIBRARIES} ) SoapySDR-soapy-sdr-0.5.4/ExampleDriver/MyDeviceSupport.cpp000066400000000000000000000026431301736054400234700ustar00rootroot00000000000000#include #include /*********************************************************************** * Device interface **********************************************************************/ class MyDevice : public SoapySDR::Device { //Implement constructor with device specific arguments... //Implement all applicable virtual methods from SoapySDR::Device }; /*********************************************************************** * Find available devices **********************************************************************/ SoapySDR::KwargsList findMyDevice(const SoapySDR::Kwargs &args) { //locate the device on the system... //return a list of 0, 1, or more argument maps that each identify a device } /*********************************************************************** * Make device instance **********************************************************************/ SoapySDR::Device *makeMyDevice(const SoapySDR::Kwargs &args) { //create an instance of the device object given the args //here we will translate args into something used in the constructor return new MyDevice(...); } /*********************************************************************** * Registration **********************************************************************/ static SoapySDR::Registry registerMyDevice("my_device", &findMyDevice, &makeMyDevice, SOAPY_SDR_ABI_VERSION); SoapySDR-soapy-sdr-0.5.4/ExampleDriver/README.md000066400000000000000000000005451301736054400211400ustar00rootroot00000000000000# Example module build for SoapySDR device support Copy this example wholesale either as a new cmake build project, or copy it into a subdirectory of an existing driver build system. Customize the CMakeLists.txt for your driver dependencies, and customize MyDeviceSupport.cpp to make calls into the low-level device driver for streaming and configuration. SoapySDR-soapy-sdr-0.5.4/LICENSE_1_0.txt000066400000000000000000000024721301736054400173750ustar00rootroot00000000000000Boost Software License - Version 1.0 - August 17th, 2003 Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following: The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. SoapySDR-soapy-sdr-0.5.4/README.md000066400000000000000000000012051301736054400163630ustar00rootroot00000000000000# Soapy SDR - vendor and platform neutral SDR support library. ##Build Status - Travis: [![Travis Build Status](https://travis-ci.org/pothosware/SoapySDR.svg?branch=master)](https://travis-ci.org/pothosware/SoapySDR) - AppVeyor: [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/6chajdpy7uk5ax89)](https://ci.appveyor.com/project/guruofquality/soapysdr) ##Documentation * https://github.com/pothosware/SoapySDR/wiki ## Licensing information Use, modification and distribution is subject to the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) SoapySDR-soapy-sdr-0.5.4/apps/000077500000000000000000000000001301736054400160515ustar00rootroot00000000000000SoapySDR-soapy-sdr-0.5.4/apps/CMakeLists.txt000066400000000000000000000011741301736054400206140ustar00rootroot00000000000000######################################################################## # Build utility executable ######################################################################## set(SOAPY_SDR_UTIL_SOURCES SoapySDRUtil.cpp SoapySDRProbe.cpp ) include_directories(${CMAKE_CURRENT_SOURCE_DIR}/../include) if (MSVC) include_directories(${CMAKE_CURRENT_SOURCE_DIR}/msvc) endif () add_executable(SoapySDRUtil ${SOAPY_SDR_UTIL_SOURCES}) target_link_libraries(SoapySDRUtil SoapySDR) install(TARGETS SoapySDRUtil DESTINATION bin) #install man pages for the application executable install(FILES SoapySDRUtil.1 DESTINATION share/man/man1) SoapySDR-soapy-sdr-0.5.4/apps/SoapySDRProbe.cpp000066400000000000000000000226701301736054400212200ustar00rootroot00000000000000// Copyright (c) 2015-2016 Josh Blum // Copyright (c) 2016-2016 Bastille Networks // SPDX-License-Identifier: BSL-1.0 #include #include template std::string toString(const std::vector &options) { std::stringstream ss; if (options.empty()) return ""; for (size_t i = 0; i < options.size(); i++) { if (not ss.str().empty()) ss << ", "; ss << options[i]; } return ss.str(); } std::string toString(const SoapySDR::Range &range) { std::stringstream ss; ss << "[" << range.minimum() << ", " << range.maximum() << "]"; return ss.str(); } std::string toString(const SoapySDR::RangeList &range, const double scale) { std::stringstream ss; for (size_t i = 0; i < range.size(); i++) { if (not ss.str().empty()) ss << ", "; ss << "[" << (range[i].minimum()/scale) << ", " << (range[i].maximum()/scale) << "]"; } return ss.str(); } std::string toString(const std::vector &nums, const double scale) { std::stringstream ss; if (nums.size() > 3) { ss << "[" << (nums.front()/scale) << ", " << (nums.back()/scale) << "]"; return ss.str(); } for (size_t i = 0; i < nums.size(); i++) { if (not ss.str().empty()) ss << ", "; ss << (nums[i]/scale); } return "[" + ss.str() + "]"; } std::string toString(const SoapySDR::ArgInfo &argInfo, const std::string indent = " ") { std::stringstream ss; //name, or use key if missing std::string name = argInfo.name; if (argInfo.name.empty()) name = argInfo.key; ss << indent << " * " << name; //optional description std::string desc = argInfo.description; const std::string replace("\n"+indent+" "); for (size_t pos = 0; (pos=desc.find("\n", pos)) != std::string::npos; pos+=replace.size()) { desc.replace(pos, 1, replace); } if (not desc.empty()) ss << " - " << desc << std::endl << indent << " "; //other fields ss << " [key=" << argInfo.key; if (not argInfo.units.empty()) ss << ", units=" << argInfo.units; if (not argInfo.value.empty()) ss << ", default=" << argInfo.value; //type switch (argInfo.type) { case SoapySDR::ArgInfo::BOOL: ss << ", type=bool"; break; case SoapySDR::ArgInfo::INT: ss << ", type=int"; break; case SoapySDR::ArgInfo::FLOAT: ss << ", type=float"; break; case SoapySDR::ArgInfo::STRING: ss << ", type=string"; break; } //optional range/enumeration if (argInfo.range.minimum() < argInfo.range.maximum()) ss << ", range=" << toString(argInfo.range); if (not argInfo.options.empty()) ss << ", options=(" << toString(argInfo.options) << ")"; ss << "]"; return ss.str(); } std::string toString(const SoapySDR::ArgInfoList &argInfos) { std::stringstream ss; for (size_t i = 0; i < argInfos.size(); i++) { ss << toString(argInfos[i]) << std::endl; } return ss.str(); } static std::string probeChannel(SoapySDR::Device *device, const int dir, const size_t chan) { std::stringstream ss; std::string dirName = (dir==SOAPY_SDR_TX)?"TX":"RX"; ss << std::endl; ss << "----------------------------------------------------" << std::endl; ss << "-- " << dirName << " Channel " << chan << std::endl; ss << "----------------------------------------------------" << std::endl; // info const auto info = device->getChannelInfo(dir, chan); if (info.size() > 0) { ss << " Channel Information:" << std::endl; for (const auto &it : info) { ss << " " << it.first << "=" << it.second << std::endl; } } ss << " Full-duplex: " << (device->getFullDuplex(dir, chan)?"YES":"NO") << std::endl; ss << " Supports AGC: " << (device->hasGainMode(dir, chan)?"YES":"NO") << std::endl; //formats std::string formats = toString(device->getStreamFormats(dir, chan)); if (not formats.empty()) ss << " Stream formats: " << formats << std::endl; //native double fullScale = 0.0; std::string native = device->getNativeStreamFormat(dir, chan, fullScale); ss << " Native format: " << native << " [full-scale=" << fullScale << "]" << std::endl; //stream args std::string streamArgs = toString(device->getStreamArgsInfo(dir, chan)); if (not streamArgs.empty()) ss << " Stream args:" << std::endl << streamArgs; //antennas std::string antennas = toString(device->listAntennas(dir, chan)); if (not antennas.empty()) ss << " Antennas: " << antennas << std::endl; //corrections std::vector correctionsList; if (device->hasDCOffsetMode(dir, chan)) correctionsList.push_back("DC removal"); if (device->hasDCOffset(dir, chan)) correctionsList.push_back("DC offset"); if (device->hasIQBalance(dir, chan)) correctionsList.push_back("IQ balance"); std::string corrections = toString(correctionsList); if (not corrections.empty()) ss << " Corrections: " << corrections << std::endl; //gains ss << " Full gain range: " << toString(device->getGainRange(dir, chan)) << " dB" << std::endl; std::vector gainsList = device->listGains(dir, chan); for (size_t i = 0; i < gainsList.size(); i++) { const std::string name = gainsList[i]; ss << " " << name << " gain range: " << toString(device->getGainRange(dir, chan, name)) << " dB" << std::endl; } //frequencies ss << " Full freq range: " << toString(device->getFrequencyRange(dir, chan), 1e6) << " MHz" << std::endl; std::vector freqsList = device->listFrequencies(dir, chan); for (size_t i = 0; i < freqsList.size(); i++) { const std::string name = freqsList[i]; ss << " " << name << " freq range: " << toString(device->getFrequencyRange(dir, chan, name), 1e6) << " MHz" << std::endl; } //freq args std::string freqArgs = toString(device->getFrequencyArgsInfo(dir, chan)); if (not freqArgs.empty()) ss << " Tune args:" << std::endl << freqArgs; //rates ss << " Sample rates: " << toString(device->listSampleRates(dir, chan), 1e6) << " MHz" << std::endl; //bandwidths const std::vector bws = device->listBandwidths(dir, chan); if (not bws.empty()) ss << " Filter bandwidths: " << toString(bws, 1e6) << " MHz" << std::endl; //sensors std::string sensors = toString(device->listSensors(dir, chan)); if (not sensors.empty()) ss << " Sensors: " << sensors << std::endl; //settings std::string settings = toString(device->getSettingInfo(dir, chan)); if (not settings.empty()) ss << " Other Settings:" << std::endl << settings; return ss.str(); } std::string SoapySDRDeviceProbe(SoapySDR::Device *device) { std::stringstream ss; /******************************************************************* * Identification info ******************************************************************/ ss << std::endl; ss << "----------------------------------------------------" << std::endl; ss << "-- Device identification" << std::endl; ss << "----------------------------------------------------" << std::endl; ss << " driver=" << device->getDriverKey() << std::endl; ss << " hardware=" << device->getHardwareKey() << std::endl; for (const auto &it : device->getHardwareInfo()) { ss << " " << it.first << "=" << it.second << std::endl; } /******************************************************************* * Available peripherals ******************************************************************/ ss << std::endl; ss << "----------------------------------------------------" << std::endl; ss << "-- Peripheral summary" << std::endl; ss << "----------------------------------------------------" << std::endl; size_t numRxChans = device->getNumChannels(SOAPY_SDR_RX); size_t numTxChans = device->getNumChannels(SOAPY_SDR_TX); ss << " Channels: " << numRxChans << " Rx, " << numTxChans << " Tx" << std::endl; ss << " Timestamps: " << (device->hasHardwareTime()?"YES":"NO") << std::endl; std::string clockSources = toString(device->listClockSources()); if (not clockSources.empty()) ss << " Clock sources: " << clockSources << std::endl; std::string timeSources = toString(device->listTimeSources()); if (not timeSources.empty()) ss << " Time sources: " << timeSources << std::endl; std::string sensors = toString(device->listSensors()); if (not sensors.empty()) ss << " Sensors: " << sensors << std::endl; std::string registers = toString(device->listRegisterInterfaces()); if (not registers.empty()) ss << " Registers: " << registers << std::endl; std::string settings = toString(device->getSettingInfo()); if (not settings.empty()) ss << " Other Settings:" << std::endl << settings; std::string gpios = toString(device->listGPIOBanks()); if (not gpios.empty()) ss << " GPIOs: " << gpios << std::endl; std::string uarts = toString(device->listUARTs()); if (not uarts.empty()) ss << " UARTs: " << uarts << std::endl; /******************************************************************* * Per-channel info ******************************************************************/ for (size_t chan = 0; chan < numRxChans; chan++) { ss << probeChannel(device, SOAPY_SDR_RX, chan); } for (size_t chan = 0; chan < numTxChans; chan++) { ss << probeChannel(device, SOAPY_SDR_TX, chan); } return ss.str(); } SoapySDR-soapy-sdr-0.5.4/apps/SoapySDRUtil.1000066400000000000000000000036361301736054400204450ustar00rootroot00000000000000.\" SoapySDRUtil.1 - manpage for SoapySDRUtil .\" .\" .TH SOAPYSDRUTIL 1 2016\-10\-28 "SoapySDR 0.5.4" .SH NAME \fBSoapySDRUtil\fR \- query and change module information of SoapySDR .\" ---------------------------------------------------------------------------- .SH SYNOPSIS \fBSoapySDRUtil\fR [\fIOPTIONS\fR] .\" ---------------------------------------------------------------------------- .SH DESCRIPTION SoapySDRUtil is a command line application that provides basic diagnostic utility for SoapySDR by printing installation information, available modules, discovered devices, and tests on instantiated devices. .\" ---------------------------------------------------------------------------- .SH OPTIONS .TP \fB\-\-info\fR Print general information on the library, list all found hardware support modules and available factories. .TP \fB\-\-find\fR[="\fISPEC\fR"] Discover available devices, restricted to those matching the \fISPEC\fR if given. If no matching devices are found it will exit with exit status 1. .TP \fB\-\-make\fR[="\fISPEC\fR"] Open and close device matching \fISPEC\fR if possible. If \fISPEC\fR is not given, the first discovered device is opened. .TP \fB\-\-probe\fR[="\fISPEC\fR"] Show detailed information on all devices or the devices matching \fISPEC\fR if given. .TP \fB\-\-check\fR=\fINAME\fR Check and print if driver module named \fINAME\fR is present. If it is not found it will exit with exit status 1. .\" ---------------------------------------------------------------------------- .SH HOMEPAGE SoapySDRUtil is part of the .UR https://github.com/pothosware/SoapySDR/wiki SoapySDR project .UE . .\" ---------------------------------------------------------------------------- .SH AUTHORS The SoapySDR library, including SoapySDRUtil, was written mostly by .MT josh@pothosware.com Josh Blum .ME . .\" .\"This man page was originally written for the Debian project by .\".MT aeb@debian.org .\"Andreas Bombe .\".ME . SoapySDR-soapy-sdr-0.5.4/apps/SoapySDRUtil.cpp000066400000000000000000000160451301736054400210650ustar00rootroot00000000000000// Copyright (c) 2014-2016 Josh Blum // SPDX-License-Identifier: BSL-1.0 #include #include #include #include #include #include #include #include std::string SoapySDRDeviceProbe(SoapySDR::Device *); /*********************************************************************** * Print help message **********************************************************************/ static int printHelp(void) { std::cout << "Usage SoapySDRUtil [options]" << std::endl; std::cout << " Options summary:" << std::endl; std::cout << " --help \t\t\t\t Print this help message" << std::endl; std::cout << " --info \t\t\t\t Print module information" << std::endl; std::cout << " --find[=\"driver=foo,type=bar\"] \t Discover available devices" << std::endl; std::cout << " --make[=\"driver=foo,type=bar\"] \t Create a device instance" << std::endl; std::cout << " --probe[=\"driver=foo,type=bar\"] \t Print detailed information" << std::endl; std::cout << " --check[=driverName] \t\t Check if driver is present" << std::endl; std::cout << std::endl; return EXIT_SUCCESS; } /*********************************************************************** * Print version and module info **********************************************************************/ static int printInfo(void) { std::cout << "Lib Version: v" << SoapySDR::getLibVersion() << std::endl; std::cout << "API Version: v" << SoapySDR::getAPIVersion() << std::endl; std::cout << "ABI Version: v" << SoapySDR::getABIVersion() << std::endl; std::cout << "Install root: " << SoapySDR::getRootPath() << std::endl; const auto modules = SoapySDR::listModules(); for (const auto &mod : modules) std::cout << "Module found: " << mod << std::endl; if (modules.empty()) std::cout << "No modules found!" << std::endl; std::cout << "Loading modules... " << std::flush; SoapySDR::loadModules(); std::cout << "done" << std::endl; std::cout << "Available factories..."; const auto factories = SoapySDR::Registry::listFindFunctions(); for (const auto &it : factories) std::cout << it.first << ", "; if (factories.empty()) std::cout << "No factories found!" << std::endl; std::cout << std::endl; return EXIT_SUCCESS; } /*********************************************************************** * Find devices and print args **********************************************************************/ static int findDevices(void) { std::string argStr; if (optarg != NULL) argStr = optarg; const auto results = SoapySDR::Device::enumerate(argStr); for (size_t i = 0; i < results.size(); i++) { std::cout << "Found device " << i << std::endl; for (const auto &it : results[i]) { std::cout << " " << it.first << " = " << it.second << std::endl; } std::cout << std::endl; } if (results.empty()) { std::cerr << "No devices found!" << std::endl; return EXIT_FAILURE; } std::cout << std::endl; return EXIT_SUCCESS; } /*********************************************************************** * Make device and print hardware info **********************************************************************/ static int makeDevice(void) { std::string argStr; if (optarg != NULL) argStr = optarg; std::cout << "Make device " << argStr << std::endl; try { auto device = SoapySDR::Device::make(argStr); std::cout << " driver=" << device->getDriverKey() << std::endl; std::cout << " hardware=" << device->getHardwareKey() << std::endl; for (const auto &it : device->getHardwareInfo()) { std::cout << " " << it.first << "=" << it.second << std::endl; } SoapySDR::Device::unmake(device); } catch (const std::exception &ex) { std::cerr << "Error making device: " << ex.what() << std::endl; return EXIT_FAILURE; } std::cout << std::endl; return EXIT_SUCCESS; } /*********************************************************************** * Make device and print detailed info **********************************************************************/ static int probeDevice(void) { std::string argStr; if (optarg != NULL) argStr = optarg; std::cout << "Probe device " << argStr << std::endl; try { auto device = SoapySDR::Device::make(argStr); std::cout << SoapySDRDeviceProbe(device) << std::endl; SoapySDR::Device::unmake(device); } catch (const std::exception &ex) { std::cerr << "Error probing device: " << ex.what() << std::endl; return EXIT_FAILURE; } std::cout << std::endl; return EXIT_SUCCESS; } /*********************************************************************** * Check the registry for a specific driver **********************************************************************/ static int checkDriver(void) { std::string driverName; if (optarg != NULL) driverName = optarg; std::cout << "Loading modules... " << std::flush; SoapySDR::loadModules(); std::cout << "done" << std::endl; std::cout << "Checking driver '" << driverName << "'... " << std::flush; const auto factories = SoapySDR::Registry::listFindFunctions(); if (factories.find(driverName) == factories.end()) { std::cout << "MISSING!" << std::endl; return EXIT_FAILURE; } else { std::cout << "PRESENT" << std::endl; return EXIT_SUCCESS; } } /*********************************************************************** * main utility entry point **********************************************************************/ int main(int argc, char *argv[]) { std::cout << "######################################################" << std::endl; std::cout << "## Soapy SDR -- the SDR abstraction library" << std::endl; std::cout << "######################################################" << std::endl; std::cout << std::endl; /******************************************************************* * parse command line options ******************************************************************/ static struct option long_options[] = { {"help", no_argument, 0, 'h'}, {"find", optional_argument, 0, 'f'}, {"make", optional_argument, 0, 'm'}, {"info", optional_argument, 0, 'i'}, {"probe", optional_argument, 0, 'p'}, {"check", optional_argument, 0, 'c'}, {0, 0, 0, 0} }; int long_index = 0; int option = 0; while ((option = getopt_long_only(argc, argv, "", long_options, &long_index)) != -1) { switch (option) { case 'h': return printHelp(); case 'i': return printInfo(); case 'f': return findDevices(); case 'm': return makeDevice(); case 'p': return probeDevice(); case 'c': return checkDriver(); } } //unknown or unspecified options, do help... return printHelp(); } SoapySDR-soapy-sdr-0.5.4/apps/msvc/000077500000000000000000000000001301736054400170215ustar00rootroot00000000000000SoapySDR-soapy-sdr-0.5.4/apps/msvc/getopt.h000066400000000000000000000373021301736054400205010ustar00rootroot00000000000000#ifndef __GETOPT_H__ /** * DISCLAIMER * This file has no copyright assigned and is placed in the Public Domain. * This file is part of the mingw-w64 runtime package. * * The mingw-w64 runtime package and its code is distributed in the hope that it * will be useful but WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESSED OR * IMPLIED ARE HEREBY DISCLAIMED. This includes but is not limited to * warranties of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. */ #pragma warning(disable:4996) #define __GETOPT_H__ /* All the headers include this file. */ #include #include #include #include #include #include #include #ifdef __cplusplus extern "C" { #endif #define REPLACE_GETOPT /* use this getopt as the system getopt(3) */ #ifdef REPLACE_GETOPT int opterr = 1; /* if error message should be printed */ int optind = 1; /* index into parent argv vector */ int optopt = '?'; /* character checked for validity */ #undef optreset /* see getopt.h */ #define optreset __mingw_optreset int optreset; /* reset getopt */ char *optarg; /* argument associated with option */ #endif //extern int optind; /* index of first non-option in argv */ //extern int optopt; /* single option character, as parsed */ //extern int opterr; /* flag to enable built-in diagnostics... */ // /* (user may set to zero, to suppress) */ // //extern char *optarg; /* pointer to argument of current option */ #define PRINT_ERROR ((opterr) && (*options != ':')) #define FLAG_PERMUTE 0x01 /* permute non-options to the end of argv */ #define FLAG_ALLARGS 0x02 /* treat non-options as args to option "-1" */ #define FLAG_LONGONLY 0x04 /* operate as getopt_long_only */ /* return values */ #define BADCH (int)'?' #define BADARG ((*options == ':') ? (int)':' : (int)'?') #define INORDER (int)1 #ifndef __CYGWIN__ #define __progname __argv[0] #else extern char __declspec(dllimport) *__progname; #endif #ifdef __CYGWIN__ static char EMSG[] = ""; #else #define EMSG "" #endif static int getopt_internal(int, char * const *, const char *, const struct option *, int *, int); static int parse_long_options(char * const *, const char *, const struct option *, int *, int); static int gcd(int, int); static void permute_args(int, int, int, char * const *); static char *place = EMSG; /* option letter processing */ /* XXX: set optreset to 1 rather than these two */ static int nonopt_start = -1; /* first non option argument (for permute) */ static int nonopt_end = -1; /* first option after non options (for permute) */ /* Error messages */ static const char recargchar[] = "option requires an argument -- %c"; static const char recargstring[] = "option requires an argument -- %s"; static const char ambig[] = "ambiguous option -- %.*s"; static const char noarg[] = "option doesn't take an argument -- %.*s"; static const char illoptchar[] = "unknown option -- %c"; static const char illoptstring[] = "unknown option -- %s"; static void _vwarnx(const char *fmt,va_list ap) { (void)fprintf(stderr,"%s: ",__progname); if (fmt != NULL) (void)vfprintf(stderr,fmt,ap); (void)fprintf(stderr,"\n"); } static void warnx(const char *fmt,...) { va_list ap; va_start(ap,fmt); _vwarnx(fmt,ap); va_end(ap); } /* * Compute the greatest common divisor of a and b. */ static int gcd(int a, int b) { int c; c = a % b; while (c != 0) { a = b; b = c; c = a % b; } return (b); } /* * Exchange the block from nonopt_start to nonopt_end with the block * from nonopt_end to opt_end (keeping the same order of arguments * in each block). */ static void permute_args(int panonopt_start, int panonopt_end, int opt_end, char * const *nargv) { int cstart, cyclelen, i, j, ncycle, nnonopts, nopts, pos; char *swap; /* * compute lengths of blocks and number and size of cycles */ nnonopts = panonopt_end - panonopt_start; nopts = opt_end - panonopt_end; ncycle = gcd(nnonopts, nopts); cyclelen = (opt_end - panonopt_start) / ncycle; for (i = 0; i < ncycle; i++) { cstart = panonopt_end+i; pos = cstart; for (j = 0; j < cyclelen; j++) { if (pos >= panonopt_end) pos -= nnonopts; else pos += nopts; swap = nargv[pos]; /* LINTED const cast */ ((char **) nargv)[pos] = nargv[cstart]; /* LINTED const cast */ ((char **)nargv)[cstart] = swap; } } } #ifdef REPLACE_GETOPT /* * getopt -- * Parse argc/argv argument vector. * * [eventually this will replace the BSD getopt] */ int getopt(int nargc, char * const *nargv, const char *options) { /* * We don't pass FLAG_PERMUTE to getopt_internal() since * the BSD getopt(3) (unlike GNU) has never done this. * * Furthermore, since many privileged programs call getopt() * before dropping privileges it makes sense to keep things * as simple (and bug-free) as possible. */ return (getopt_internal(nargc, nargv, options, NULL, NULL, 0)); } #endif /* REPLACE_GETOPT */ //extern int getopt(int nargc, char * const *nargv, const char *options); #ifdef _BSD_SOURCE /* * BSD adds the non-standard `optreset' feature, for reinitialisation * of `getopt' parsing. We support this feature, for applications which * proclaim their BSD heritage, before including this header; however, * to maintain portability, developers are advised to avoid it. */ # define optreset __mingw_optreset extern int optreset; #endif #ifdef __cplusplus } #endif /* * POSIX requires the `getopt' API to be specified in `unistd.h'; * thus, `unistd.h' includes this header. However, we do not want * to expose the `getopt_long' or `getopt_long_only' APIs, when * included in this manner. Thus, close the standard __GETOPT_H__ * declarations block, and open an additional __GETOPT_LONG_H__ * specific block, only when *not* __UNISTD_H_SOURCED__, in which * to declare the extended API. */ #endif /* !defined(__GETOPT_H__) */ #if !defined(__UNISTD_H_SOURCED__) && !defined(__GETOPT_LONG_H__) #define __GETOPT_LONG_H__ #ifdef __cplusplus extern "C" { #endif struct option /* specification for a long form option... */ { const char *name; /* option name, without leading hyphens */ int has_arg; /* does it take an argument? */ int *flag; /* where to save its status, or NULL */ int val; /* its associated status value */ }; enum /* permitted values for its `has_arg' field... */ { no_argument = 0, /* option never takes an argument */ required_argument, /* option always requires an argument */ optional_argument /* option may take an argument */ }; /* * parse_long_options -- * Parse long options in argc/argv argument vector. * Returns -1 if short_too is set and the option does not match long_options. */ static int parse_long_options(char * const *nargv, const char *options, const struct option *long_options, int *idx, int short_too) { char *current_argv, *has_equal; size_t current_argv_len; int i, ambiguous, match; #define IDENTICAL_INTERPRETATION(_x, _y) \ (long_options[(_x)].has_arg == long_options[(_y)].has_arg && \ long_options[(_x)].flag == long_options[(_y)].flag && \ long_options[(_x)].val == long_options[(_y)].val) current_argv = place; match = -1; ambiguous = 0; optind++; if ((has_equal = strchr(current_argv, '=')) != NULL) { /* argument found (--option=arg) */ current_argv_len = has_equal - current_argv; has_equal++; } else current_argv_len = strlen(current_argv); for (i = 0; long_options[i].name; i++) { /* find matching long option */ if (strncmp(current_argv, long_options[i].name, current_argv_len)) continue; if (strlen(long_options[i].name) == current_argv_len) { /* exact match */ match = i; ambiguous = 0; break; } /* * If this is a known short option, don't allow * a partial match of a single character. */ if (short_too && current_argv_len == 1) continue; if (match == -1) /* partial match */ match = i; else if (!IDENTICAL_INTERPRETATION(i, match)) ambiguous = 1; } if (ambiguous) { /* ambiguous abbreviation */ if (PRINT_ERROR) warnx(ambig, (int)current_argv_len, current_argv); optopt = 0; return (BADCH); } if (match != -1) { /* option found */ if (long_options[match].has_arg == no_argument && has_equal) { if (PRINT_ERROR) warnx(noarg, (int)current_argv_len, current_argv); /* * XXX: GNU sets optopt to val regardless of flag */ if (long_options[match].flag == NULL) optopt = long_options[match].val; else optopt = 0; return (BADARG); } if (long_options[match].has_arg == required_argument || long_options[match].has_arg == optional_argument) { if (has_equal) optarg = has_equal; else if (long_options[match].has_arg == required_argument) { /* * optional argument doesn't use next nargv */ optarg = nargv[optind++]; } } if ((long_options[match].has_arg == required_argument) && (optarg == NULL)) { /* * Missing argument; leading ':' indicates no error * should be generated. */ if (PRINT_ERROR) warnx(recargstring, current_argv); /* * XXX: GNU sets optopt to val regardless of flag */ if (long_options[match].flag == NULL) optopt = long_options[match].val; else optopt = 0; --optind; return (BADARG); } } else { /* unknown option */ if (short_too) { --optind; return (-1); } if (PRINT_ERROR) warnx(illoptstring, current_argv); optopt = 0; return (BADCH); } if (idx) *idx = match; if (long_options[match].flag) { *long_options[match].flag = long_options[match].val; return (0); } else return (long_options[match].val); #undef IDENTICAL_INTERPRETATION } /* * getopt_internal -- * Parse argc/argv argument vector. Called by user level routines. */ static int getopt_internal(int nargc, char * const *nargv, const char *options, const struct option *long_options, int *idx, int flags) { char *oli; /* option letter list index */ int optchar, short_too; static int posixly_correct = -1; if (options == NULL) return (-1); /* * XXX Some GNU programs (like cvs) set optind to 0 instead of * XXX using optreset. Work around this braindamage. */ if (optind == 0) optind = optreset = 1; /* * Disable GNU extensions if POSIXLY_CORRECT is set or options * string begins with a '+'. * * CV, 2009-12-14: Check POSIXLY_CORRECT anew if optind == 0 or * optreset != 0 for GNU compatibility. */ if (posixly_correct == -1 || optreset != 0) posixly_correct = (getenv("POSIXLY_CORRECT") != NULL); if (*options == '-') flags |= FLAG_ALLARGS; else if (posixly_correct || *options == '+') flags &= ~FLAG_PERMUTE; if (*options == '+' || *options == '-') options++; optarg = NULL; if (optreset) nonopt_start = nonopt_end = -1; start: if (optreset || !*place) { /* update scanning pointer */ optreset = 0; if (optind >= nargc) { /* end of argument vector */ place = EMSG; if (nonopt_end != -1) { /* do permutation, if we have to */ permute_args(nonopt_start, nonopt_end, optind, nargv); optind -= nonopt_end - nonopt_start; } else if (nonopt_start != -1) { /* * If we skipped non-options, set optind * to the first of them. */ optind = nonopt_start; } nonopt_start = nonopt_end = -1; return (-1); } if (*(place = nargv[optind]) != '-' || (place[1] == '\0' && strchr(options, '-') == NULL)) { place = EMSG; /* found non-option */ if (flags & FLAG_ALLARGS) { /* * GNU extension: * return non-option as argument to option 1 */ optarg = nargv[optind++]; return (INORDER); } if (!(flags & FLAG_PERMUTE)) { /* * If no permutation wanted, stop parsing * at first non-option. */ return (-1); } /* do permutation */ if (nonopt_start == -1) nonopt_start = optind; else if (nonopt_end != -1) { permute_args(nonopt_start, nonopt_end, optind, nargv); nonopt_start = optind - (nonopt_end - nonopt_start); nonopt_end = -1; } optind++; /* process next argument */ goto start; } if (nonopt_start != -1 && nonopt_end == -1) nonopt_end = optind; /* * If we have "-" do nothing, if "--" we are done. */ if (place[1] != '\0' && *++place == '-' && place[1] == '\0') { optind++; place = EMSG; /* * We found an option (--), so if we skipped * non-options, we have to permute. */ if (nonopt_end != -1) { permute_args(nonopt_start, nonopt_end, optind, nargv); optind -= nonopt_end - nonopt_start; } nonopt_start = nonopt_end = -1; return (-1); } } /* * Check long options if: * 1) we were passed some * 2) the arg is not just "-" * 3) either the arg starts with -- we are getopt_long_only() */ if (long_options != NULL && place != nargv[optind] && (*place == '-' || (flags & FLAG_LONGONLY))) { short_too = 0; if (*place == '-') place++; /* --foo long option */ else if (*place != ':' && strchr(options, *place) != NULL) short_too = 1; /* could be short option too */ optchar = parse_long_options(nargv, options, long_options, idx, short_too); if (optchar != -1) { place = EMSG; return (optchar); } } if ((optchar = (int)*place++) == (int)':' || (optchar == (int)'-' && *place != '\0') || (oli = (char*)strchr(options, optchar)) == NULL) { /* * If the user specified "-" and '-' isn't listed in * options, return -1 (non-option) as per POSIX. * Otherwise, it is an unknown option character (or ':'). */ if (optchar == (int)'-' && *place == '\0') return (-1); if (!*place) ++optind; if (PRINT_ERROR) warnx(illoptchar, optchar); optopt = optchar; return (BADCH); } if (long_options != NULL && optchar == 'W' && oli[1] == ';') { /* -W long-option */ if (*place) /* no space */ /* NOTHING */; else if (++optind >= nargc) { /* no arg */ place = EMSG; if (PRINT_ERROR) warnx(recargchar, optchar); optopt = optchar; return (BADARG); } else /* white space */ place = nargv[optind]; optchar = parse_long_options(nargv, options, long_options, idx, 0); place = EMSG; return (optchar); } if (*++oli != ':') { /* doesn't take argument */ if (!*place) ++optind; } else { /* takes (optional) argument */ optarg = NULL; if (*place) /* no white space */ optarg = place; else if (oli[1] != ':') { /* arg not optional */ if (++optind >= nargc) { /* no arg */ place = EMSG; if (PRINT_ERROR) warnx(recargchar, optchar); optopt = optchar; return (BADARG); } else optarg = nargv[optind]; } place = EMSG; ++optind; } /* dump back option letter */ return (optchar); } /* * getopt_long -- * Parse argc/argv argument vector. */ int getopt_long(int nargc, char * const *nargv, const char *options, const struct option *long_options, int *idx) { return (getopt_internal(nargc, nargv, options, long_options, idx, FLAG_PERMUTE)); } /* * getopt_long_only -- * Parse argc/argv argument vector. */ int getopt_long_only(int nargc, char * const *nargv, const char *options, const struct option *long_options, int *idx) { return (getopt_internal(nargc, nargv, options, long_options, idx, FLAG_PERMUTE|FLAG_LONGONLY)); } //extern int getopt_long(int nargc, char * const *nargv, const char *options, // const struct option *long_options, int *idx); //extern int getopt_long_only(int nargc, char * const *nargv, const char *options, // const struct option *long_options, int *idx); /* * Previous MinGW implementation had... */ #ifndef HAVE_DECL_GETOPT /* * ...for the long form API only; keep this for compatibility. */ # define HAVE_DECL_GETOPT 1 #endif #ifdef __cplusplus } #endif #endif /* !defined(__UNISTD_H_SOURCED__) && !defined(__GETOPT_LONG_H__) */ SoapySDR-soapy-sdr-0.5.4/appveyor.yml000066400000000000000000000024511301736054400175000ustar00rootroot00000000000000######################################################################## ## AppVeyor config for SoapySDR ## ## * build only on a 64-bit environment ## * the matrix builds Release and Debug ## * minimal testing for command line util ######################################################################## version: '{build}' platform: x64 configuration: - Debug - Release environment: global: INSTALL_PREFIX: C:/Program Files/SoapySDR # Operating system (build VM template) os: Windows Server 2012 R2 # branches to build branches: # whitelist only: - master - maint # dependencies for python bindings # disabled because of link issues on VM #install: # - choco install swig # configure and build build_script: - mkdir build - cd build - cmake ../ -G "Visual Studio 12 Win64" -DCMAKE_INSTALL_PREFIX="%INSTALL_PREFIX%" -DCMAKE_BUILD_TYPE=%CONFIGURATION% - cmake --build . --config %CONFIGURATION% - cmake --build . --config %CONFIGURATION% --target install # setup environment paths before_test: - set PATH=%INSTALL_PREFIX%/bin;%PATH% - set PYTHONPATH=%INSTALL_PREFIX%/Lib/site-packages;%PYTHONPATH% # basic test for command line utility test_script: - SoapySDRUtil --info - SoapySDRUtil --check=null - SoapySDRUtil --make="driver=null" # run the unit tests - ctest SoapySDR-soapy-sdr-0.5.4/buildkite/000077500000000000000000000000001301736054400170625ustar00rootroot00000000000000SoapySDR-soapy-sdr-0.5.4/buildkite/build.sh000077500000000000000000000014731301736054400205250ustar00rootroot00000000000000#!/bin/bash # # See: https://buildkite.com/docs/guides/writing-build-scripts # # TL;DR # # # You can group your build output by echoing "--- group name" in your build output. # # echo "--- build group here" # # If you want to have the group open by default, use +++ instead of ---: # # echo "+++ build group here" # # You can even include colors and emojis! # # echo -e "--- Running \033[33mspecs\033[0m \:cow:\:bell:" # # # Add a buildkite format comment with each new item added. # This script is run from the top directory of the FPGA repo. # set -eo pipefail echo "--- Enviroment." env # # Add hook(s) to build commands/script here. # echo "--- Build SoapySDR" rm -rf build mkdir build cd build cmake ../ make -j4 # Got to the end, all is good, close out last buildkite output group. echo "--- BUILD SUCCEEDED" exit 0 SoapySDR-soapy-sdr-0.5.4/cmake/000077500000000000000000000000001301736054400161665ustar00rootroot00000000000000SoapySDR-soapy-sdr-0.5.4/cmake/GetGitRevisionDescription.cmake000066400000000000000000000100261301736054400242750ustar00rootroot00000000000000# - Returns a version string from Git # # These functions force a re-configure on each git commit so that you can # trust the values of the variables in your build system. # # get_git_head_revision( [ ...]) # # Returns the refspec and sha hash of the current head revision # # git_describe( [ ...]) # # Returns the results of git describe on the source tree, and adjusting # the output so that it tests false if an error occurs. # # git_get_exact_tag( [ ...]) # # Returns the results of git describe --exact-match on the source tree, # and adjusting the output so that it tests false if there was no exact # matching tag. # # Requires CMake 2.6 or newer (uses the 'function' command) # # Original Author: # 2009-2010 Ryan Pavlik # http://academic.cleardefinition.com # Iowa State University HCI Graduate Program/VRAC # # Copyright Iowa State University 2009-2010. # Distributed under the Boost Software License, Version 1.0. # (See accompanying file LICENSE_1_0.txt or copy at # http://www.boost.org/LICENSE_1_0.txt) if(__get_git_revision_description) return() endif() set(__get_git_revision_description YES) # We must run the following at "include" time, not at function call time, # to find the path to this module rather than the path to a calling list file get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH) function(get_git_head_revision _refspecvar _hashvar) set(GIT_PARENT_DIR "${CMAKE_CURRENT_SOURCE_DIR}") set(GIT_DIR "${GIT_PARENT_DIR}/.git") while(NOT EXISTS "${GIT_DIR}") # .git dir not found, search parent directories set(GIT_PREVIOUS_PARENT "${GIT_PARENT_DIR}") get_filename_component(GIT_PARENT_DIR ${GIT_PARENT_DIR} PATH) if(GIT_PARENT_DIR STREQUAL GIT_PREVIOUS_PARENT) # We have reached the root directory, we are not in git set(${_refspecvar} "GITDIR-NOTFOUND" PARENT_SCOPE) set(${_hashvar} "GITDIR-NOTFOUND" PARENT_SCOPE) return() endif() set(GIT_DIR "${GIT_PARENT_DIR}/.git") endwhile() # check if this is a submodule if(NOT IS_DIRECTORY ${GIT_DIR}) file(READ ${GIT_DIR} submodule) string(REGEX REPLACE "gitdir: (.*)\n$" "\\1" GIT_DIR_RELATIVE ${submodule}) get_filename_component(SUBMODULE_DIR ${GIT_DIR} PATH) get_filename_component(GIT_DIR ${SUBMODULE_DIR}/${GIT_DIR_RELATIVE} ABSOLUTE) endif() set(GIT_DATA "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/git-data") if(NOT EXISTS "${GIT_DATA}") file(MAKE_DIRECTORY "${GIT_DATA}") endif() if(NOT EXISTS "${GIT_DIR}/HEAD") return() endif() set(HEAD_FILE "${GIT_DATA}/HEAD") configure_file("${GIT_DIR}/HEAD" "${HEAD_FILE}" COPYONLY) configure_file("${_gitdescmoddir}/GetGitRevisionDescription.cmake.in" "${GIT_DATA}/grabRef.cmake" @ONLY) include("${GIT_DATA}/grabRef.cmake") set(${_refspecvar} "${HEAD_REF}" PARENT_SCOPE) set(${_hashvar} "${HEAD_HASH}" PARENT_SCOPE) endfunction() function(git_describe _var) if(NOT GIT_FOUND) find_package(Git QUIET) endif() get_git_head_revision(refspec hash) if(NOT GIT_FOUND) set(${_var} "GIT-NOTFOUND" PARENT_SCOPE) return() endif() if(NOT hash) set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE) return() endif() # TODO sanitize #if((${ARGN}" MATCHES "&&") OR # (ARGN MATCHES "||") OR # (ARGN MATCHES "\\;")) # message("Please report the following error to the project!") # message(FATAL_ERROR "Looks like someone's doing something nefarious with git_describe! Passed arguments ${ARGN}") #endif() #message(STATUS "Arguments to execute_process: ${ARGN}") execute_process(COMMAND "${GIT_EXECUTABLE}" describe ${hash} ${ARGN} WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}" RESULT_VARIABLE res OUTPUT_VARIABLE out ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE) if(NOT res EQUAL 0) set(out "${out}-${res}-NOTFOUND") endif() set(${_var} "${out}" PARENT_SCOPE) endfunction() function(git_get_exact_tag _var) git_describe(out --exact-match ${ARGN}) set(${_var} "${out}" PARENT_SCOPE) endfunction() SoapySDR-soapy-sdr-0.5.4/cmake/GetGitRevisionDescription.cmake.in000066400000000000000000000022621301736054400247050ustar00rootroot00000000000000# # Internal file for GetGitRevisionDescription.cmake # # Requires CMake 2.6 or newer (uses the 'function' command) # # Original Author: # 2009-2010 Ryan Pavlik # http://academic.cleardefinition.com # Iowa State University HCI Graduate Program/VRAC # # Copyright Iowa State University 2009-2010. # Distributed under the Boost Software License, Version 1.0. # (See accompanying file LICENSE_1_0.txt or copy at # http://www.boost.org/LICENSE_1_0.txt) set(HEAD_HASH) file(READ "@HEAD_FILE@" HEAD_CONTENTS LIMIT 1024) string(STRIP "${HEAD_CONTENTS}" HEAD_CONTENTS) if(HEAD_CONTENTS MATCHES "ref") # named branch string(REPLACE "ref: " "" HEAD_REF "${HEAD_CONTENTS}") if(EXISTS "@GIT_DIR@/${HEAD_REF}") configure_file("@GIT_DIR@/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY) elseif(EXISTS "@GIT_DIR@/logs/${HEAD_REF}") configure_file("@GIT_DIR@/logs/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY) set(HEAD_HASH "${HEAD_REF}") endif() else() # detached HEAD configure_file("@GIT_DIR@/HEAD" "@GIT_DATA@/head-ref" COPYONLY) endif() if(NOT HEAD_HASH) file(READ "@GIT_DATA@/head-ref" HEAD_HASH LIMIT 1024) string(STRIP "${HEAD_HASH}" HEAD_HASH) endif() SoapySDR-soapy-sdr-0.5.4/cmake/SoapySDRConfig.cmake000066400000000000000000000155231301736054400217700ustar00rootroot00000000000000if(DEFINED INCLUDED_SOAPY_SDR_CONFIG_CMAKE) return() endif() set(INCLUDED_SOAPY_SDR_CONFIG_CMAKE TRUE) ######################################################################## # SoapySDRConfig - cmake project configuration for client clibraries # # The following will be set after find_package(SoapySDR): # SOAPY_SDR_MODULE_UTIL() - utility function to build modules # SoapySDR_LIBRARIES - SoapySDR development libraries # SoapySDR_INCLUDE_DIRS - SoapySDR development includes ######################################################################## list(INSERT CMAKE_MODULE_PATH 0 ${CMAKE_CURRENT_LIST_DIR}) include(SoapySDRUtil) ######################################################################## # select the release build type by default to get optimization flags ######################################################################## if(NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE "Release") message(STATUS "Build type not specified: defaulting to release.") endif(NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} CACHE STRING "") ######################################################################## # Automatic LIB_SUFFIX detection + configuration option ######################################################################## if(CMAKE_SYSTEM_NAME STREQUAL "Linux") set(LINUX TRUE) endif() if(LINUX AND EXISTS "/etc/debian_version") set(DEBIAN TRUE) endif() if(LINUX AND EXISTS "/etc/redhat-release") set(REDHAT TRUE) endif() if(LINUX AND EXISTS "/etc/SuSE-release") set(SUSE TRUE) endif() if(LINUX AND EXISTS "/etc/slackware-version") set(SLACKWARE TRUE) endif() if(NOT DEFINED LIB_SUFFIX AND (REDHAT OR SUSE OR SLACKWARE) AND CMAKE_SYSTEM_PROCESSOR MATCHES "64$") SET(LIB_SUFFIX 64) endif() set(LIB_SUFFIX ${LIB_SUFFIX} CACHE STRING "lib directory suffix") ######################################################################## # Provide add_compile_options() when not available ######################################################################## if(CMAKE_VERSION VERSION_LESS "2.8.12") function(add_compile_options) add_definitions(${ARGN}) endfunction(add_compile_options) endif() ######################################################################## # Helpful compiler flags ######################################################################## #C++11 is a required language feature for this project set(CMAKE_CXX_STANDARD 11) if(CMAKE_COMPILER_IS_GNUCXX) #enable C++11 on older versions of cmake if (CMAKE_VERSION VERSION_LESS "3.1") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x") endif() #force a compile-time error when symbols are missing set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--no-undefined") set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -Wl,--no-undefined") #common warnings to help encourage good coding practices add_compile_options(-Wall) add_compile_options(-Wextra) #symbols are only exported from libraries/modules explicitly add_compile_options(-fvisibility=hidden) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fvisibility-inlines-hidden") endif() if(APPLE) #fixes issue with duplicate module registry when using application bundle set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -flat_namespace") set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -flat_namespace") endif() if(MSVC) #C++11 is a required language feature for this project if (${MSVC_VERSION} LESS 1700) message(FATAL_ERROR "the build requires MSVC 2012 or newer for C++11 support") endif() #we always want to use multiple cores for compilation add_compile_options(/MP) #suppress the following warnings which are commonly caused by project headers add_compile_options(/wd4251) #disable 'identifier' : class 'type' needs to have dll-interface to be used by clients of class 'type2' add_compile_options(/wd4503) #'identifier' : decorated name length exceeded, name was truncated #projects should be cross-platform and standard stl functions should work add_definitions(-DNOMINMAX) #enables std::min and std::max endif() if ("${CMAKE_SYSTEM_NAME}" STREQUAL "FreeBSD") add_compile_options(-stdlib=libc++) endif() ######################################################################## # extract the ABI version string from the Version.h header ######################################################################## function(_SOAPY_SDR_GET_ABI_VERSION VERSION SOAPY_SDR_INCLUDE_DIR) file(READ "${SOAPY_SDR_INCLUDE_DIR}/SoapySDR/Version.h" version_h) string(REGEX MATCH "\\#define SOAPY_SDR_ABI_VERSION \"([0-9]+\\.[0-9]+-[0-9]+)\"" SOAPY_SDR_ABI_VERSION_MATCHES "${version_h}") if(NOT SOAPY_SDR_ABI_VERSION_MATCHES) message(FATAL_ERROR "Failed to extract version number from Version.h") endif(NOT SOAPY_SDR_ABI_VERSION_MATCHES) set(${VERSION} "${CMAKE_MATCH_1}" PARENT_SCOPE) endfunction(_SOAPY_SDR_GET_ABI_VERSION) ######################################################################## # In-tree settings ######################################################################## if (SOAPY_SDR_IN_TREE_SOURCE_DIR) if(NOT SOAPY_SDR_ROOT) set(SOAPY_SDR_ROOT ${CMAKE_INSTALL_PREFIX}) endif(NOT SOAPY_SDR_ROOT) set(SoapySDR_INCLUDE_DIRS ${SOAPY_SDR_IN_TREE_SOURCE_DIR}/include) set(SoapySDR_LIBRARIES SoapySDR) _SOAPY_SDR_GET_ABI_VERSION(SOAPY_SDR_ABI_VERSION ${SoapySDR_INCLUDE_DIRS}) return() endif (SOAPY_SDR_IN_TREE_SOURCE_DIR) ######################################################################## ## installation root ######################################################################## if (UNIX) get_filename_component(SOAPY_SDR_ROOT "${CMAKE_CURRENT_LIST_DIR}/../../.." ABSOLUTE) elseif (WIN32) get_filename_component(SOAPY_SDR_ROOT "${CMAKE_CURRENT_LIST_DIR}/.." ABSOLUTE) endif () ######################################################################## ## locate the library ######################################################################## find_library( SOAPY_SDR_LIBRARY SoapySDR SoapySDRd PATHS ${SOAPY_SDR_ROOT}/lib${LIB_SUFFIX} PATH_SUFFIXES ${CMAKE_LIBRARY_ARCHITECTURE} NO_DEFAULT_PATH ) if(NOT SOAPY_SDR_LIBRARY) message(FATAL_ERROR "cannot find SoapySDR library in ${SOAPY_SDR_ROOT}/lib${LIB_SUFFIX}") endif() set(SoapySDR_LIBRARIES ${SOAPY_SDR_LIBRARY}) ######################################################################## ## locate the includes ######################################################################## find_path( SOAPY_SDR_INCLUDE_DIR SoapySDR/Config.hpp PATHS ${SOAPY_SDR_ROOT}/include NO_DEFAULT_PATH ) if(NOT SOAPY_SDR_INCLUDE_DIR) message(FATAL_ERROR "cannot find SoapySDR includes in ${SOAPY_SDR_ROOT}/include") endif() set(SoapySDR_INCLUDE_DIRS ${SOAPY_SDR_INCLUDE_DIR}) _SOAPY_SDR_GET_ABI_VERSION(SOAPY_SDR_ABI_VERSION ${SoapySDR_INCLUDE_DIRS}) SoapySDR-soapy-sdr-0.5.4/cmake/SoapySDRConfigVersion.in.cmake000066400000000000000000000006451301736054400237420ustar00rootroot00000000000000set(PACKAGE_FIND_NAME "@PROJECT_NAME@") set(PACKAGE_VERSION "@SOAPY_SDR_VERSION@") # Check whether the requested PACKAGE_FIND_VERSION is compatible if("${PACKAGE_VERSION}" VERSION_LESS "${PACKAGE_FIND_VERSION}") set(PACKAGE_VERSION_COMPATIBLE FALSE) else() set(PACKAGE_VERSION_COMPATIBLE TRUE) if ("${PACKAGE_VERSION}" VERSION_EQUAL "${PACKAGE_FIND_VERSION}") set(PACKAGE_VERSION_EXACT TRUE) endif() endif() SoapySDR-soapy-sdr-0.5.4/cmake/SoapySDRUtil.cmake000066400000000000000000000035551301736054400215020ustar00rootroot00000000000000if(DEFINED INCLUDED_SOAPY_SDR_UTIL_CMAKE) return() endif() set(INCLUDED_SOAPY_SDR_UTIL_CMAKE TRUE) ######################################################################## ## SOAPY_SDR_MODULE_UTIL - build and install modules for Soapy SDR ## ## This utility can handle the build and installation operations. ## ## Arguments: ## ## TARGET - the name of the module to build ## ## SOURCES - a list of c++ source files ## ## LIBRARIES - a list of libraries to link the module to ## The module will automatically link to SoapySDR library. ## ## DESTINATION - override the default install path when specified ## The default destination is a relative path (/SoapySDR/modules). ## This argument specifies an alternative relative or absolute path, ## and can be used standalone or in conjunction with PREFIX. ## ## PREFIX - override the default install prefix when specified ## The prefix modifies the destination with an absolute path ## to replace the typical CMAKE_INSTALL_PREFIX install rules. ## ######################################################################## function(SOAPY_SDR_MODULE_UTIL) include(CMakeParseArguments) CMAKE_PARSE_ARGUMENTS(MODULE "" "TARGET;DESTINATION;PREFIX" "SOURCES;LIBRARIES" ${ARGN}) include_directories(${SoapySDR_INCLUDE_DIRS}) add_library(${MODULE_TARGET} MODULE ${MODULE_SOURCES}) target_link_libraries(${MODULE_TARGET} ${MODULE_LIBRARIES} ${SoapySDR_LIBRARIES}) set_target_properties(${MODULE_TARGET} PROPERTIES DEBUG_POSTFIX "") #same name in debug mode if (NOT MODULE_DESTINATION) set(MODULE_DESTINATION lib${LIB_SUFFIX}/SoapySDR/modules${SOAPY_SDR_ABI_VERSION}/) endif() if (MODULE_PREFIX) set(MODULE_DESTINATION ${MODULE_PREFIX}/${MODULE_DESTINATION}) endif() install( TARGETS ${MODULE_TARGET} DESTINATION ${MODULE_DESTINATION} ) endfunction(SOAPY_SDR_MODULE_UTIL) SoapySDR-soapy-sdr-0.5.4/cmake_uninstall.cmake.in000066400000000000000000000020131301736054400216620ustar00rootroot00000000000000if(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") message(FATAL_ERROR "Cannot find install manifest: @CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") endif(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt") file(READ "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt" files) string(REGEX REPLACE "\n" ";" files "${files}") foreach(file ${files}) message(STATUS "Uninstalling $ENV{DESTDIR}${file}") if(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") exec_program( "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\"" OUTPUT_VARIABLE rm_out RETURN_VALUE rm_retval ) if(NOT "${rm_retval}" STREQUAL 0) message(FATAL_ERROR "Problem when removing $ENV{DESTDIR}${file}") endif(NOT "${rm_retval}" STREQUAL 0) else(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") message(STATUS "File $ENV{DESTDIR}${file} does not exist.") endif(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}") endforeach(file) SoapySDR-soapy-sdr-0.5.4/debian/000077500000000000000000000000001301736054400163305ustar00rootroot00000000000000SoapySDR-soapy-sdr-0.5.4/debian/changelog000066400000000000000000000043441301736054400202070ustar00rootroot00000000000000soapysdr (0.5.4-ppa1) unstable; urgency=low * Release 0.5.4 (2016-11-29) -- Josh Blum Tue, 29 Nov 2016 15:12:11 -0500 soapysdr (0.5.3) unstable; urgency=low * Release 0.5.3 (2016-09-01) -- Josh Blum Thu, 01 Sep 2016 00:32:47 -0700 soapysdr (0.5.2) unstable; urgency=low * Release 0.5.2 (2016-08-18) -- Josh Blum Thu, 18 Aug 2016 22:50:48 -0700 soapysdr (0.5.1) unstable; urgency=low * Release 0.5.1 (2016-08-02) -- Josh Blum Tue, 02 Aug 2016 14:55:15 -0700 soapysdr (0.5.0) unstable; urgency=low * Release 0.5.0 (2016-07-10) -- Josh Blum Sun, 10 Jul 2016 16:59:08 -0700 soapysdr (0.4.4) unstable; urgency=low * Release 0.4.4 (2016-07-10) -- Josh Blum Sun, 10 Jul 2016 16:55:33 -0700 soapysdr (0.4.3) unstable; urgency=low * Release 0.4.3 (2016-04-21) -- Josh Blum Thu, 21 Apr 2016 14:42:02 -0400 soapysdr (0.4.2) unstable; urgency=low * Release 0.4.2 (2016-03-02) -- Josh Blum Wed, 02 Mar 2016 22:36:12 -0800 soapysdr (0.4.1) unstable; urgency=low * Release 0.4.1 (2016-01-27) -- Josh Blum Wed, 27 Jan 2016 21:55:26 -0800 soapysdr (0.4.0) unstable; urgency=low * Release 0.4.0 (2015-12-10) -- Josh Blum Thu, 10 Dec 2015 17:15:50 -0800 soapysdr (0.3.1) unstable; urgency=low * Release 0.3.1 (2015-10-11) -- Josh Blum Sun, 11 Oct 2015 11:25:09 -0700 soapysdr (0.3.0) unstable; urgency=low * Release 0.3.0 (2015-10-10) -- Josh Blum Sat, 10 Oct 2015 10:59:43 -0700 soapysdr (0.2.3) unstable; urgency=low * Release 0.2.3 (2015-10-08) -- Josh Blum Thu, 08 Oct 2015 13:10:53 -0700 soapysdr (0.2.2) unstable; urgency=low * Release 0.2.2 (2015-08-15) -- Josh Blum Sat, 15 Aug 2015 11:37:07 -0700 soapysdr (0.2.1) unstable; urgency=low * Release 0.2.1 (2015-07-09) -- Josh Blum Thu, 09 Jul 2015 18:44:05 -0700 soapysdr (0.2.0) unstable; urgency=low * Release 0.2.0 (2015-06-15) -- Josh Blum Mon, 15 Jun 2015 01:11:14 -0400 SoapySDR-soapy-sdr-0.5.4/debian/compat000066400000000000000000000000021301736054400175260ustar00rootroot000000000000009 SoapySDR-soapy-sdr-0.5.4/debian/control000066400000000000000000000063311301736054400177360ustar00rootroot00000000000000Source: soapysdr Section: comm Priority: optional Maintainer: Josh Blum Build-Depends: debhelper (>= 9.0.0), cmake (>= 2.8.7), swig (>= 2.0.0), python, python-dev, python3, python3-dev Standards-Version: 3.9.8 Homepage: https://github.com/pothosware/SoapySDR/wiki Vcs-Git: https://github.com/pothosware/SoapySDR.git Vcs-Browser: https://github.com/pothosware/SoapySDR Package: libsoapysdr0.5-2 Section: libs Architecture: any Multi-Arch: same Pre-Depends: ${misc:Pre-Depends} Depends: ${shlibs:Depends}, ${misc:Depends} Description: software defined radio interface library SoapySDR is a library providing a common interface to SDR (software defined radio) hardware. Support for different hardware is added through external modules. . This package contains the shared library. Package: libsoapysdr-dev Section: libdevel Architecture: any Depends: libsoapysdr0.5-2 (= ${binary:Version}), ${misc:Depends} Description: SoapySDR library development files SoapySDR is a library providing a common interface to SDR (software defined radio) hardware. Support for different hardware is added through external modules. . This package contains the development files for the library. Package: soapysdr Architecture: any Depends: libsoapysdr0.5-2 (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends} Description: software defined radio interface library tools SoapySDR is a library providing a common interface to SDR (software defined radio) hardware. Support for different hardware is added through external modules. . This package contains the SoapySDRUtil command line utility which can list available modules and hardware. Package: python-soapysdr Section: python Architecture: any Depends: libsoapysdr0.5-2 (= ${binary:Version}), python, ${shlibs:Depends}, ${misc:Depends} Recommends: python-numpy Description: SoapySDR Python 2 bindings SoapySDR is a library providing a common interface to SDR (software defined radio) hardware. Support for different hardware is added through external modules. . This package contains the Python 2 bindings for the library. Package: python3-soapysdr Section: python Architecture: any Depends: libsoapysdr0.5-2 (= ${binary:Version}), python3, ${shlibs:Depends}, ${misc:Depends} Recommends: python3-numpy Description: SoapySDR Python 3 bindings SoapySDR is a library providing a common interface to SDR (software defined radio) hardware. Support for different hardware is added through external modules. . This package contains the Python 3 bindings for the library. Package: soapysdr-modules-all Architecture: all Depends: soapysdr-module-airspy, soapysdr-module-bladerf, soapysdr-module-hackrf, soapysdr-module-redpitaya, soapysdr-module-remote, soapysdr-module-rtlsdr, soapysdr-module-rfspace, soapysdr-module-osmosdr, soapysdr-module-mirisdr, soapysdr-module-uhd, ${misc:Depends} Description: software defined radio hardware support modules SoapySDR is a library providing a common interface to SDR (software defined radio) hardware. Support for different hardware is added through external modules. . This is a metapackage for several common hardware support modules. SoapySDR-soapy-sdr-0.5.4/debian/copyright000066400000000000000000000031721301736054400202660ustar00rootroot00000000000000Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: soapysdr Source: https://github.com/pothosware/SoapySDR/wiki Files: * Copyright: Copyright (c) 2014-2016 Josh Blum Copyright (c) 2016-2016 Bastille Networks License: BSL-1.0 Boost Software License - Version 1.0 - August 17th, 2003 . Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following: . The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor. . THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. SoapySDR-soapy-sdr-0.5.4/debian/docs000066400000000000000000000000121301736054400171740ustar00rootroot00000000000000README.md SoapySDR-soapy-sdr-0.5.4/debian/libsoapysdr-dev.install000066400000000000000000000001141301736054400230230ustar00rootroot00000000000000usr/include/ usr/share/cmake/ usr/lib/*/pkgconfig/ usr/lib/*/libSoapySDR.so SoapySDR-soapy-sdr-0.5.4/debian/libsoapysdr0.5-2.install000066400000000000000000000000331301736054400226310ustar00rootroot00000000000000usr/lib/*/libSoapySDR.so.* SoapySDR-soapy-sdr-0.5.4/debian/python-soapysdr.install000066400000000000000000000000221301736054400230750ustar00rootroot00000000000000usr/lib/python2*/ SoapySDR-soapy-sdr-0.5.4/debian/python3-soapysdr.install000066400000000000000000000000221301736054400231600ustar00rootroot00000000000000usr/lib/python3*/ SoapySDR-soapy-sdr-0.5.4/debian/rules000077500000000000000000000011671301736054400174150ustar00rootroot00000000000000#!/usr/bin/make -f # -*- makefile -*- # extract the architecture for setting the library path suffix DEB_HOST_MULTIARCH ?= $(shell dpkg-architecture -qDEB_HOST_MULTIARCH) # extract the last section of the changelog version for extra info DEB_VERSION ?= $(shell dpkg-parsechangelog -S Version) # Uncomment this to turn on verbose mode. #export DH_VERBOSE=1 %: dh $@ --buildsystem=cmake override_dh_auto_configure: dh_auto_configure -- \ -DCMAKE_AUTOSET_INSTALL_RPATH=FALSE \ -DLIB_SUFFIX="/$(DEB_HOST_MULTIARCH)" \ -DSOAPY_SDR_EXTVER="$(DEB_VERSION)" override_dh_installchangelogs: dh_installchangelogs Changelog.txt SoapySDR-soapy-sdr-0.5.4/debian/soapysdr.install000066400000000000000000000000111301736054400215540ustar00rootroot00000000000000usr/bin/ SoapySDR-soapy-sdr-0.5.4/debian/soapysdr.manpages000066400000000000000000000000241301736054400217050ustar00rootroot00000000000000apps/SoapySDRUtil.1 SoapySDR-soapy-sdr-0.5.4/debian/source/000077500000000000000000000000001301736054400176305ustar00rootroot00000000000000SoapySDR-soapy-sdr-0.5.4/debian/source/format000066400000000000000000000000141301736054400210360ustar00rootroot000000000000003.0 (quilt) SoapySDR-soapy-sdr-0.5.4/docs/000077500000000000000000000000001301736054400160365ustar00rootroot00000000000000SoapySDR-soapy-sdr-0.5.4/docs/CMakeLists.txt000066400000000000000000000027731301736054400206070ustar00rootroot00000000000000######################################################################## # Optional doxygen generation ######################################################################## find_package(Doxygen) if(DOXYGEN_DOT_FOUND) set(HAVE_DOT YES) else() set(HAVE_DOT NO) endif() ######################################################################## ## Feature registration ######################################################################## include(FeatureSummary) include(CMakeDependentOption) cmake_dependent_option(ENABLE_DOCS "Enable doxygen documentation" ON "DOXYGEN_FOUND" OFF) add_feature_info(Docs ENABLE_DOCS "doxygen documentation") if (NOT ENABLE_DOCS) return() endif() #where to look for headers set(SOAPY_SDR_INCLUDE_ROOT ${PROJECT_SOURCE_DIR}/include/SoapySDR) #header sources used in the generate rule file(GLOB SOAPY_INCLUDES ${SOAPY_SDR_INCLUDE_ROOT}/*.h*) #Configure doxygen config file configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) #Create doxygen generation build rules if (DOXYGEN_FOUND) set(CMAKE_CURRENT_BINARY_DIR_DOXYGEN ${CMAKE_CURRENT_BINARY_DIR}/html) add_custom_command( OUTPUT ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN} DEPENDS ${SOAPY_INCLUDES} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile COMMENT "Generating documentation with doxygen" ) add_custom_target(docs ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR_DOXYGEN}) endif() SoapySDR-soapy-sdr-0.5.4/docs/Doxyfile.in000066400000000000000000003177021301736054400201630ustar00rootroot00000000000000# 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 double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv # for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = "SoapySDR" # 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 = "@SOAPY_SDR_VERSION@" # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "Vendor and platform neutral SDR interface library" # 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 = "@CMAKE_CURRENT_SOURCE_DIR@/soapy_sdr_logo.png" # 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 = "@CMAKE_CURRENT_BINARY_DIR@" # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = "@SOAPY_SDR_INCLUDE_ROOT@" # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. For # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO # 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 standard # error (stderr). WARN_LOGFILE = "@CMAKE_CURRENT_BINARY_DIR@/warn.log" #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = @SOAPY_SDR_INCLUDE_ROOT@ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # 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 = # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see http://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the # cost of reduced performance. This can be particularly helpful with template # rich C++ code for which doxygen's built-in parser lacks the necessary type # information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse-libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_OPTIONS = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to 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. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: http://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /