pax_global_header00006660000000000000000000000064122575372310014521gustar00rootroot0000000000000052 comment=80c4af4f31289daed6f20ee96a605948e3681fc8 gr-osmosdr-0.1.0.55.80c4af/000077500000000000000000000000001225753723100150275ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/AUTHORS000066400000000000000000000001631225753723100160770ustar00rootroot00000000000000Dimitri Stolnikov Steve Markgraf Hoernchen Nuand LLC folks gr-osmosdr-0.1.0.55.80c4af/CMakeLists.txt000066400000000000000000000232131225753723100175700ustar00rootroot00000000000000# Copyright 2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # Project setup ######################################################################## cmake_minimum_required(VERSION 2.6) project(gr-osmosdr CXX C) enable_testing() list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/Modules) #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 "") # Set the version information here set(VERSION_INFO_MAJOR_VERSION 0) set(VERSION_INFO_API_COMPAT 1) set(VERSION_INFO_MINOR_VERSION 1) set(VERSION_INFO_MAINT_VERSION git) include(GrVersion) #setup version info ######################################################################## # Compiler specific setup ######################################################################## IF(CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|AMD64|x86") SET(USE_SIMD "SSE2" CACHE STRING "Use SIMD instructions") ELSE() SET(USE_SIMD "no" CACHE STRING "Use SIMD instructions") ENDIF() SET(USE_SIMD_VALUES "no" "SSE2" "AVX") SET_PROPERTY(CACHE USE_SIMD PROPERTY STRINGS ${USE_SIMD_VALUES}) LIST(FIND USE_SIMD_VALUES ${USE_SIMD} USE_SIMD_INDEX) IF(${USE_SIMD_INDEX} EQUAL -1) message(FATAL_ERROR "Option ${USE_SIMD} not supported, valid entries are ${USE_SIMD_VALUES}") ENDIF() IF(CMAKE_CXX_COMPILER MATCHES ".*clang") SET(CMAKE_COMPILER_IS_CLANGXX 1) ENDIF() IF(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_COMPILER_IS_CLANGXX) ADD_DEFINITIONS(-Wall) ADD_DEFINITIONS(-Wextra) ADD_DEFINITIONS(-Wno-unused-parameter) ADD_DEFINITIONS(-Wsign-compare) #ADD_DEFINITIONS(-Wconversion) #ADD_DEFINITIONS(-pedantic) #ADD_DEFINITIONS(-ansi) IF(NOT WIN32) #only export symbols that are declared to be part of the api (non dll platforms) ADD_DEFINITIONS(-fvisibility=hidden) ADD_DEFINITIONS(-fvisibility-inlines-hidden) ENDIF(NOT WIN32) IF(USE_SIMD MATCHES SSE2) ADD_DEFINITIONS(-msse2) ADD_DEFINITIONS(-DUSE_SSE2) ENDIF() IF(USE_SIMD MATCHES AVX) ADD_DEFINITIONS(-march=native) ADD_DEFINITIONS(-DUSE_AVX) ENDIF() ELSEIF(MSVC) IF(USE_SIMD MATCHES SSE2) ADD_DEFINITIONS(/arch:SSE2) ADD_DEFINITIONS(-DUSE_SSE2) ENDIF() IF(USE_SIMD MATCHES AVX) ADD_DEFINITIONS(/arch:AVX) ADD_DEFINITIONS(-DUSE_AVX) ENDIF() ENDIF() ######################################################################## # Setup boost ######################################################################## MESSAGE(STATUS "Configuring Boost C++ Libraries...") # Although not required on my system, some users have linking issues without SET(BOOST_REQUIRED_COMPONENTS thread system ) if(UNIX AND NOT BOOST_ROOT AND EXISTS "/usr/lib64") list(APPEND BOOST_LIBRARYDIR "/usr/lib64") #fedora 64-bit fix endif(UNIX AND NOT BOOST_ROOT AND EXISTS "/usr/lib64") set(Boost_ADDITIONAL_VERSIONS "1.35.0" "1.35" "1.36.0" "1.36" "1.37.0" "1.37" "1.38.0" "1.38" "1.39.0" "1.39" "1.40.0" "1.40" "1.41.0" "1.41" "1.42.0" "1.42" "1.43.0" "1.43" "1.44.0" "1.44" "1.45.0" "1.45" "1.46.0" "1.46" "1.47.0" "1.47" "1.48.0" "1.48" "1.49.0" "1.49" "1.50.0" "1.50" "1.51.0" "1.51" "1.52.0" "1.52" "1.53.0" "1.53" "1.54.0" "1.54" "1.55.0" "1.55" "1.56.0" "1.56" "1.57.0" "1.57" "1.58.0" "1.58" "1.59.0" "1.59" "1.60.0" "1.60" "1.61.0" "1.61" "1.62.0" "1.62" "1.63.0" "1.63" "1.64.0" "1.64" "1.65.0" "1.65" "1.66.0" "1.66" "1.67.0" "1.67" "1.68.0" "1.68" "1.69.0" "1.69" ) find_package(Boost COMPONENTS ${BOOST_REQUIRED_COMPONENTS}) if(NOT Boost_FOUND) message(FATAL_ERROR "Boost required to build " ${CMAKE_PROJECT_NAME}) endif() ADD_DEFINITIONS(-DBOOST_ALL_DYN_LINK) ######################################################################## # Install directories ######################################################################## include(GrPlatform) #define LIB_SUFFIX set(GR_RUNTIME_DIR bin) set(GR_LIBRARY_DIR lib${LIB_SUFFIX}) set(GR_INCLUDE_DIR include) set(GR_DATA_DIR share) set(GR_PKG_DATA_DIR ${GR_DATA_DIR}/${CMAKE_PROJECT_NAME}) set(GR_DOC_DIR ${GR_DATA_DIR}/doc) if (NOT GR_PKG_DOC_DIR) set(GR_PKG_DOC_DIR ${GR_DOC_DIR}/${CMAKE_PROJECT_NAME}) endif() set(GR_CONF_DIR etc) set(GR_PKG_CONF_DIR ${GR_CONF_DIR}/${CMAKE_PROJECT_NAME}/conf.d) set(GR_LIBEXEC_DIR libexec) set(GR_PKG_LIBEXEC_DIR ${GR_LIBEXEC_DIR}/${CMAKE_PROJECT_NAME}) set(GRC_BLOCKS_DIR ${GR_PKG_DATA_DIR}/grc/blocks) ######################################################################## # Find build dependencies ######################################################################## set(GR_REQUIRED_COMPONENTS RUNTIME PMT BLOCKS) find_package(Gnuradio "3.7.0") find_package(GnuradioIQBalance) find_package(UHD) find_package(GnuradioUHD) find_package(GnuradioFCD) find_package(GnuradioFCDPP) find_package(LibOsmoSDR) find_package(LibRTLSDR) find_package(LibMiriSDR) find_package(LibHackRF) find_package(LibbladeRF) find_package(Doxygen) if(NOT GNURADIO_RUNTIME_FOUND) message(FATAL_ERROR "GnuRadio Runtime required to build " ${CMAKE_PROJECT_NAME}) endif() ######################################################################## # Setup the include and linker paths ######################################################################## include_directories( ${CMAKE_SOURCE_DIR}/include ${CMAKE_SOURCE_DIR}/lib ${Boost_INCLUDE_DIRS} ${GNURADIO_RUNTIME_INCLUDE_DIRS} ${GNURADIO_PMT_INCLUDE_DIRS} ${GNURADIO_BLOCKS_INCLUDE_DIRS} ) link_directories( ${Boost_LIBRARY_DIRS} ${GNURADIO_RUNTIME_LIBRARY_DIRS} ${GNURADIO_PMT_LIBRARY_DIRS} ${GNURADIO_BLOCKS_LIBRARY_DIRS} ) # Set component parameters set(GR_OSMOSDR_INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/include CACHE INTERNAL "" FORCE) set(GR_OSMOSDR_SWIG_INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/swig CACHE INTERNAL "" FORCE) ######################################################################## # Create uninstall target ######################################################################## configure_file( ${CMAKE_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake @ONLY) add_custom_target(uninstall ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake ) ######################################################################## # Enable python component ######################################################################## find_package(PythonLibs 2) find_package(SWIG) if(SWIG_FOUND) message(STATUS "Minimum SWIG version required is 1.3.31") set(SWIG_VERSION_CHECK FALSE) if("${SWIG_VERSION}" VERSION_GREATER "1.3.30") set(SWIG_VERSION_CHECK TRUE) endif() endif(SWIG_FOUND) include(GrComponent) GR_REGISTER_COMPONENT("Python support" ENABLE_PYTHON PYTHONLIBS_FOUND SWIG_FOUND SWIG_VERSION_CHECK ) ######################################################################## # Add subdirectories ######################################################################## add_subdirectory(include/osmosdr) add_subdirectory(lib) if(ENABLE_PYTHON) add_subdirectory(swig) add_subdirectory(python) add_subdirectory(grc) add_subdirectory(apps) endif(ENABLE_PYTHON) add_subdirectory(docs) ######################################################################## # Create Pkg Config File ######################################################################## FOREACH(inc ${Boost_INCLUDE_DIRS}) LIST(APPEND GR_OSMOSDR_PC_CFLAGS "-I${inc}") ENDFOREACH(inc) FOREACH(lib ${Boost_LIBRARY_DIRS}) LIST(APPEND GR_OSMOSDR_PC_LIBS "-L${lib}") ENDFOREACH(lib) # use space-separation format for the pc file STRING(REPLACE ";" " " GR_OSMOSDR_PC_REQUIRES "${GR_OSMOSDR_PC_REQUIRES}") STRING(REPLACE ";" " " GR_OSMOSDR_PC_CFLAGS "${GR_OSMOSDR_PC_CFLAGS}") STRING(REPLACE ";" " " GR_OSMOSDR_PC_LIBS "${GR_OSMOSDR_PC_LIBS}") # unset these vars to avoid hard-coded paths to cross environment IF(CMAKE_CROSSCOMPILING) UNSET(GR_OSMOSDR_PC_CFLAGS) UNSET(GR_OSMOSDR_PC_LIBS) ENDIF(CMAKE_CROSSCOMPILING) # fake gnuradio cpack behavior as long as we don't use it directly set(CPACK_PACKAGE_NAME "gnuradio-osmosdr") set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "GNU Radio block for various radio hardware") set(CPACK_PACKAGE_VERSION ${VERSION}) CONFIGURE_FILE( ${CMAKE_CURRENT_SOURCE_DIR}/gnuradio-osmosdr.pc.in ${CMAKE_CURRENT_BINARY_DIR}/gnuradio-osmosdr.pc @ONLY) INSTALL( FILES ${CMAKE_CURRENT_BINARY_DIR}/gnuradio-osmosdr.pc DESTINATION ${GR_LIBRARY_DIR}/pkgconfig ) ######################################################################## # Print Summary ######################################################################## GR_PRINT_COMPONENT_SUMMARY() MESSAGE(STATUS "Building for version: ${VERSION} / ${LIBVER}") MESSAGE(STATUS "Using install prefix: ${CMAKE_INSTALL_PREFIX}") gr-osmosdr-0.1.0.55.80c4af/COPYING000066400000000000000000001045131225753723100160660ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . gr-osmosdr-0.1.0.55.80c4af/README000066400000000000000000000032571225753723100157160ustar00rootroot00000000000000While primarily being developed for the OsmoSDR hardware, this block as well supports: * FUNcube Dongle through libgnuradio-fcd * FUNcube Dongle Pro+ through gr-fcdproplus * sysmocom OsmoSDR Devices through libosmosdr * RTL2832U based DVB-T dongles through librtlsdr * RTL-TCP spectrum server (see librtlsdr project) * MSi2500 based DVB-T dongles through libmirisdr * gnuradio .cfile input through libgnuradio-blocks * RFSPACE SDR-IQ, SDR-IP, NetSDR (incl. X2 option) * Great Scott Gadgets HackRF through libhackrf * Nuand LLC bladeRF through libbladeRF library * Ettus USRP Devices through Ettus UHD library * Fairwaves UmTRX through Fairwaves' fork of UHD By using the OsmoSDR block you can take advantage of a common software api in your application(s) independent of the underlying radio hardware. For installation and usage guidelines please read the documentation available at http://sdr.osmocom.org/trac/wiki/GrOsmoSDR For the impatient :) a short excerpt: The Gnu Radio block requires a recent gnuradio (>= v3.7) to be installed. Before building the block you have to make sure that all the dependencies (see list of supported devices above) you are intend to work with are properly installed. The build system of gr-osmosdr will recognize them and enable specific source/sink components thereafter. Please note: prior pulling a new version from git and compiling it, please do a "make uninstall" first to properly remove the previous version. Building with cmake: git clone git://git.osmocom.org/gr-osmosdr cd gr-osmosdr/ mkdir build cd build/ cmake ../ make sudo make install sudo ldconfig NOTE: The osmocom blocks will appear under 'Sources' and 'Sinks' categories in GRC menu. gr-osmosdr-0.1.0.55.80c4af/apps/000077500000000000000000000000001225753723100157725ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/apps/CMakeLists.txt000066400000000000000000000020351225753723100205320ustar00rootroot00000000000000# Copyright 2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. include(GrPython) GR_PYTHON_INSTALL( FILES osmocom_siggen_base.py DESTINATION ${GR_PYTHON_DIR}/osmosdr ) GR_PYTHON_INSTALL( PROGRAMS osmocom_fft osmocom_siggen osmocom_siggen_nogui osmocom_spectrum_sense DESTINATION ${GR_RUNTIME_DIR} ) gr-osmosdr-0.1.0.55.80c4af/apps/osmocom_fft000077500000000000000000000663271225753723100202510ustar00rootroot00000000000000#!/usr/bin/env python # # Copyright 2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. # SAMP_RANGE_KEY = 'samp_range' SAMP_RATE_KEY = 'samp_rate' GAIN_KEY = lambda x: 'gain:'+x BWIDTH_KEY = 'bwidth' CENTER_FREQ_KEY = 'center_freq' FREQ_CORR_KEY = 'freq_corr' FREQ_RANGE_KEY = 'freq_range' GAIN_RANGE_KEY = lambda x: 'gain_range:'+x BWIDTH_RANGE_KEY = 'bwidth_range' import osmosdr from gnuradio import gr, gru from gnuradio import eng_notation from gnuradio.gr.pubsub import pubsub from gnuradio.eng_option import eng_option from optparse import OptionParser import sys import numpy try: from gnuradio.wxgui import stdgui2, form, slider from gnuradio.wxgui import forms from gnuradio.wxgui import fftsink2, waterfallsink2, scopesink2 import wx except ImportError: sys.stderr.write("Error importing GNU Radio's wxgui. Please make sure gr-wxgui is installed.\n") sys.exit(1) class app_top_block(stdgui2.std_top_block, pubsub): def __init__(self, frame, panel, vbox, argv): stdgui2.std_top_block.__init__(self, frame, panel, vbox, argv) pubsub.__init__(self) self.frame = frame self.panel = panel parser = OptionParser(option_class=eng_option) parser.add_option("-a", "--args", type="string", default="", help="Device args, [default=%default]") parser.add_option("-A", "--antenna", type="string", default=None, help="Select RX antenna where appropriate") parser.add_option("-s", "--samp-rate", type="eng_float", default=None, help="Set sample rate (bandwidth), minimum by default") parser.add_option("-f", "--center-freq", type="eng_float", default=None, help="Set frequency to FREQ", metavar="FREQ") parser.add_option("-c", "--freq-corr", type="eng_float", default=None, help="Set frequency correction (ppm)") parser.add_option("-g", "--gain", type="eng_float", default=None, help="Set gain in dB (default is midpoint)") parser.add_option("", "--dc-offset-mode", type="int", default=None, help="Set the RX frontend DC offset correction mode") parser.add_option("", "--iq-balance-mode", type="int", default=None, help="Set the RX frontend IQ imbalance correction mode") parser.add_option("-W", "--waterfall", action="store_true", default=False, help="Enable waterfall display") parser.add_option("-F", "--fosphor", action="store_true", default=False, help="Enable fosphor display") parser.add_option("-S", "--oscilloscope", action="store_true", default=False, help="Enable oscilloscope display") parser.add_option("", "--avg-alpha", type="eng_float", default=1e-1, help="Set fftsink averaging factor, default=[%default]") parser.add_option("", "--averaging", action="store_true", default=False, help="Enable fftsink averaging, default=[%default]") parser.add_option("", "--ref-scale", type="eng_float", default=1.0, help="Set dBFS=0dB input value, default=[%default]") parser.add_option("", "--fft-size", type="int", default=1024, help="Set number of FFT bins [default=%default]") parser.add_option("", "--fft-rate", type="int", default=30, help="Set FFT update rate, [default=%default]") parser.add_option("-v", "--verbose", action="store_true", default=False, help="Use verbose console output [default=%default]") (options, args) = parser.parse_args() if len(args) != 0: parser.print_help() sys.exit(1) self.options = options self._verbose = options.verbose self.src = osmosdr.source(options.args) try: self.src.get_sample_rates().start() except RuntimeError: print "Source has no sample rates (wrong device arguments?)." sys.exit(1) # Set the antenna if(options.antenna): self.src.set_antenna(options.antenna) if options.samp_rate is None: options.samp_rate = self.src.get_sample_rates().start() if options.gain is None: gain = self.src.get_gain() if gain is None: # if no gain was specified, use the mid-point in dB r = self.src.get_gain_range() try: # empty gain range returned in file= mode options.gain = float(r.start()+r.stop())/2 except RuntimeError: options.gain = 0 pass else: options.gain = gain if options.center_freq is None: freq = self.src.get_center_freq() if freq != 0: options.center_freq = freq else: # if no freq was specified, use the mid-point in Hz r = self.src.get_freq_range() options.center_freq = float(r.start()+r.stop())/2 input_rate = self.src.set_sample_rate(options.samp_rate) self.src.set_bandwidth(input_rate) self.src.set_gain(options.gain) self.publish(SAMP_RANGE_KEY, self.src.get_sample_rates) self.publish(FREQ_RANGE_KEY, self.src.get_freq_range) for name in self.get_gain_names(): self.publish(GAIN_RANGE_KEY(name), (lambda self=self,name=name: self.src.get_gain_range(name))) self.publish(BWIDTH_RANGE_KEY, self.src.get_bandwidth_range) for name in self.get_gain_names(): self.publish(GAIN_KEY(name), (lambda self=self,name=name: self.src.get_gain(name))) self.publish(BWIDTH_KEY, self.src.get_bandwidth) #initialize values from options self[SAMP_RANGE_KEY] = self.src.get_sample_rates() self[SAMP_RATE_KEY] = options.samp_rate self[CENTER_FREQ_KEY] = options.center_freq self[FREQ_CORR_KEY] = options.freq_corr self.dc_offset_mode = options.dc_offset_mode self.iq_balance_mode = options.iq_balance_mode # initialize reasonable defaults for DC / IQ correction self['dc_offset_real'] = 0 self['dc_offset_imag'] = 0 self['iq_balance_mag'] = 0 self['iq_balance_pha'] = 0 #subscribe set methods self.subscribe(SAMP_RATE_KEY, self.set_sample_rate) for name in self.get_gain_names(): self.subscribe(GAIN_KEY(name), (lambda gain,self=self,name=name: self.set_named_gain(gain, name))) self.subscribe(BWIDTH_KEY, self.set_bandwidth) self.subscribe(CENTER_FREQ_KEY, self.set_freq) self.subscribe(FREQ_CORR_KEY, self.set_freq_corr) self.subscribe('dc_offset_real', self.set_dc_offset) self.subscribe('dc_offset_imag', self.set_dc_offset) self.subscribe('iq_balance_mag', self.set_iq_balance) self.subscribe('iq_balance_pha', self.set_iq_balance) #force update on pubsub keys #for key in (SAMP_RATE_KEY, BWIDTH_KEY, CENTER_FREQ_KEY, FREQ_CORR_KEY): #print key, "=", self[key] #self[key] = self[key] if options.fosphor: from gnuradio import fosphor self.scope = fosphor.wx_sink_c(panel, size=(800,300)) self.scope.set_sample_rate(input_rate) self.frame.SetMinSize((800,600)) elif options.waterfall: self.scope = waterfallsink2.waterfall_sink_c (panel, fft_size=options.fft_size, sample_rate=input_rate, ref_scale=options.ref_scale, ref_level=20.0, y_divs = 12) self.scope.set_callback(self.wxsink_callback) self.frame.SetMinSize((800, 420)) elif options.oscilloscope: self.scope = scopesink2.scope_sink_c(panel, sample_rate=input_rate) self.frame.SetMinSize((800, 600)) else: self.scope = fftsink2.fft_sink_c (panel, fft_size=options.fft_size, sample_rate=input_rate, ref_scale=options.ref_scale, ref_level=20.0, y_divs = 12, average=options.averaging, avg_alpha=options.avg_alpha, fft_rate=options.fft_rate) self.scope.set_callback(self.wxsink_callback) self.frame.SetMinSize((800, 420)) self.connect(self.src, self.scope) self._build_gui(vbox) if self.dc_offset_mode != None: self.set_dc_offset_mode(self.dc_offset_mode) if self.iq_balance_mode != None: self.set_iq_balance_mode(self.iq_balance_mode) # set initial values if not(self.set_freq(options.center_freq)): self._set_status_msg("Failed to set initial frequency") def wxsink_callback(self, x, y): self.set_freq_from_callback(x) def _set_status_msg(self, msg): self.frame.GetStatusBar().SetStatusText(msg, 0) def _build_gui(self, vbox): if hasattr(self.scope, 'win'): vbox.Add(self.scope.win, 1, wx.EXPAND) vbox.AddSpacer(3) # add control area at the bottom self.myform = myform = form.form() ################################################## # Frequency controls ################################################## fc_vbox = forms.static_box_sizer(parent=self.panel, label="Center Frequency", orient=wx.VERTICAL, bold=True) fc_vbox.AddSpacer(3) # First row of frequency controls (center frequency) freq_hbox = wx.BoxSizer(wx.HORIZONTAL) fc_vbox.Add(freq_hbox, 0, wx.EXPAND) fc_vbox.AddSpacer(5) # Second row of frequency controls (freq. correction) corr_hbox = wx.BoxSizer(wx.HORIZONTAL) fc_vbox.Add(corr_hbox, 0, wx.EXPAND) fc_vbox.AddSpacer(3) # Add frequency controls to top window sizer vbox.Add(fc_vbox, 0, wx.EXPAND) vbox.AddSpacer(5) freq_hbox.AddSpacer(3) forms.text_box( parent=self.panel, sizer=freq_hbox, label='Center Frequency (Hz)', proportion=1, converter=forms.float_converter(), ps=self, key=CENTER_FREQ_KEY, ) freq_hbox.AddSpacer(5) try: # range.start() == range.stop() in file= mode forms.slider( parent=self.panel, sizer=freq_hbox, proportion=3, ps=self, key=CENTER_FREQ_KEY, minimum=self[FREQ_RANGE_KEY].start(), maximum=self[FREQ_RANGE_KEY].stop(), num_steps=1000, ) freq_hbox.AddSpacer(3) except AssertionError: pass if self[FREQ_CORR_KEY] != None: # show frequency correction scrollbar corr_hbox.AddSpacer(3) forms.text_box( parent=self.panel, sizer=corr_hbox, label='Freq. Correction (ppm)', proportion=1, converter=forms.float_converter(), ps=self, key=FREQ_CORR_KEY, ) corr_hbox.AddSpacer(5) forms.slider( parent=self.panel, sizer=corr_hbox, proportion=3, ps=self, key=FREQ_CORR_KEY, minimum=-100, maximum=+100, num_steps=2010, step_size=0.1, ) corr_hbox.AddSpacer(3) ################################################## # Gain controls ################################################## gc_vbox = forms.static_box_sizer(parent=self.panel, label="Gain Settings", orient=wx.VERTICAL, bold=True) gc_vbox.AddSpacer(3) # Add gain controls to top window sizer vbox.Add(gc_vbox, 0, wx.EXPAND) vbox.AddSpacer(5) for gain_name in self.get_gain_names(): range = self[GAIN_RANGE_KEY(gain_name)] gain = self[GAIN_KEY(gain_name)] #print gain_name, gain, range.to_pp_string() if range.start() < range.stop(): gain_hbox = wx.BoxSizer(wx.HORIZONTAL) gc_vbox.Add(gain_hbox, 0, wx.EXPAND) gc_vbox.AddSpacer(3) gain_hbox.AddSpacer(3) forms.text_box( parent=self.panel, sizer=gain_hbox, proportion=1, converter=forms.float_converter(), ps=self, key=GAIN_KEY(gain_name), label=gain_name + " Gain (dB)", ) gain_hbox.AddSpacer(5) forms.slider( parent=self.panel, sizer=gain_hbox, proportion=3, ps=self, key=GAIN_KEY(gain_name), minimum=range.start(), maximum=range.stop(), step_size=range.step() or (range.stop() - range.start())/10, ) gain_hbox.AddSpacer(3) ################################################## # Bandwidth controls ################################################## try: bw_range = self[BWIDTH_RANGE_KEY] #print bw_range.to_pp_string() if bw_range.start() < bw_range.stop(): bwidth_vbox = forms.static_box_sizer(parent=self.panel, label="Bandwidth", orient=wx.VERTICAL, bold=True) bwidth_vbox.AddSpacer(3) bwidth_hbox = wx.BoxSizer(wx.HORIZONTAL) bwidth_vbox.Add(bwidth_hbox, 0, wx.EXPAND) bwidth_vbox.AddSpacer(3) vbox.Add(bwidth_vbox, 0, wx.EXPAND) vbox.AddSpacer(5) bwidth_hbox.AddSpacer(3) forms.text_box( parent=self.panel, sizer=bwidth_hbox, proportion=1, converter=forms.float_converter(), ps=self, key=BWIDTH_KEY, label="Bandwidth (Hz)", ) bwidth_hbox.AddSpacer(5) forms.slider( parent=self.panel, sizer=bwidth_hbox, proportion=3, ps=self, key=BWIDTH_KEY, minimum=bw_range.start(), maximum=bw_range.stop(), step_size=bw_range.step() or (bw_range.stop() - bw_range.start())/100, ) bwidth_hbox.AddSpacer(3) except RuntimeError: pass ################################################## # Sample rate controls ################################################## sr_vbox = forms.static_box_sizer(parent=self.panel, label="Sample Rate", orient=wx.VERTICAL, bold=True) sr_vbox.AddSpacer(3) # First row of sample rate controls sr_hbox = wx.BoxSizer(wx.HORIZONTAL) sr_vbox.Add(sr_hbox, 0, wx.EXPAND) sr_vbox.AddSpacer(5) # Add frequency controls to top window sizer vbox.Add(sr_vbox, 0, wx.EXPAND) vbox.AddSpacer(5) sr_hbox.AddSpacer(3) forms.text_box( parent=self.panel, sizer=sr_hbox, label='Sample Rate (Hz)', proportion=1, converter=forms.float_converter(), ps=self, key=SAMP_RATE_KEY, ) sr_hbox.AddSpacer(5) #forms.slider( # parent=self.panel, sizer=sr_hbox, # proportion=3, # ps=self, # key=SAMP_RATE_KEY, # minimum=self[SAMP_RANGE_KEY].start(), # maximum=self[SAMP_RANGE_KEY].stop(), # step_size=self[SAMP_RANGE_KEY].step(), #) #sr_hbox.AddSpacer(3) ################################################## # DC Offset controls ################################################## if self.dc_offset_mode != None: dc_offset_vbox = forms.static_box_sizer(parent=self.panel, label="DC Offset Correction", orient=wx.VERTICAL, bold=True) dc_offset_vbox.AddSpacer(3) # First row of sample rate controls dc_offset_hbox = wx.BoxSizer(wx.HORIZONTAL) dc_offset_vbox.Add(dc_offset_hbox, 0, wx.EXPAND) dc_offset_vbox.AddSpacer(3) # Add frequency controls to top window sizer vbox.Add(dc_offset_vbox, 0, wx.EXPAND) vbox.AddSpacer(3) self.dc_offset_mode_chooser = forms.radio_buttons( parent=self.panel, value=self.dc_offset_mode, callback=self.set_dc_offset_mode, label='', choices=[0, 1, 2], labels=["Off", "Manual", "Auto"], style=wx.RA_HORIZONTAL, ) dc_offset_hbox.Add(self.dc_offset_mode_chooser) dc_offset_hbox.AddSpacer(3) dc_offset_hbox.AddSpacer(3) self.dc_offset_real_text = forms.text_box( parent=self.panel, sizer=dc_offset_hbox, label='Real', proportion=1, converter=forms.float_converter(), ps=self, key='dc_offset_real', ) dc_offset_hbox.AddSpacer(3) self.dc_offset_real_slider = forms.slider( parent=self.panel, sizer=dc_offset_hbox, proportion=3, minimum=-1, maximum=+1, step_size=0.001, ps=self, key='dc_offset_real', ) dc_offset_hbox.AddSpacer(3) dc_offset_hbox.AddSpacer(3) self.dc_offset_imag_text = forms.text_box( parent=self.panel, sizer=dc_offset_hbox, label='Imag', proportion=1, converter=forms.float_converter(), ps=self, key='dc_offset_imag', ) dc_offset_hbox.AddSpacer(3) self.dc_offset_imag_slider = forms.slider( parent=self.panel, sizer=dc_offset_hbox, proportion=3, minimum=-1, maximum=+1, step_size=0.001, ps=self, key='dc_offset_imag', ) dc_offset_hbox.AddSpacer(3) ################################################## # IQ Imbalance controls ################################################## if self.iq_balance_mode != None: iq_balance_vbox = forms.static_box_sizer(parent=self.panel, label="IQ Imbalance Correction", orient=wx.VERTICAL, bold=True) iq_balance_vbox.AddSpacer(3) # First row of sample rate controls iq_balance_hbox = wx.BoxSizer(wx.HORIZONTAL) iq_balance_vbox.Add(iq_balance_hbox, 0, wx.EXPAND) iq_balance_vbox.AddSpacer(3) # Add frequency controls to top window sizer vbox.Add(iq_balance_vbox, 0, wx.EXPAND) vbox.AddSpacer(3) self.iq_balance_mode_chooser = forms.radio_buttons( parent=self.panel, value=self.iq_balance_mode, callback=self.set_iq_balance_mode, label='', choices=[0, 1, 2], labels=["Off", "Manual", "Auto"], style=wx.RA_HORIZONTAL, ) iq_balance_hbox.Add(self.iq_balance_mode_chooser) iq_balance_hbox.AddSpacer(3) iq_balance_hbox.AddSpacer(3) self.iq_balance_mag_text = forms.text_box( parent=self.panel, sizer=iq_balance_hbox, label='Mag', proportion=1, converter=forms.float_converter(), ps=self, key='iq_balance_mag', ) iq_balance_hbox.AddSpacer(3) self.iq_balance_mag_slider = forms.slider( parent=self.panel, sizer=iq_balance_hbox, proportion=3, minimum=-1, maximum=+1, step_size=0.001, ps=self, key='iq_balance_mag', ) iq_balance_hbox.AddSpacer(3) iq_balance_hbox.AddSpacer(3) self.iq_balance_pha_text = forms.text_box( parent=self.panel, sizer=iq_balance_hbox, label='Phase', proportion=1, converter=forms.float_converter(), ps=self, key='iq_balance_pha', ) iq_balance_hbox.AddSpacer(3) self.iq_balance_pha_slider = forms.slider( parent=self.panel, sizer=iq_balance_hbox, proportion=3, minimum=-1, maximum=+1, step_size=0.001, ps=self, key='iq_balance_pha', ) iq_balance_hbox.AddSpacer(3) def set_dc_offset_mode(self, dc_offset_mode): if dc_offset_mode == 1: self.dc_offset_real_text.Enable() self.dc_offset_real_slider.Enable() self.dc_offset_imag_text.Enable() self.dc_offset_imag_slider.Enable() self.set_dc_offset(0) else: self.dc_offset_real_text.Disable() self.dc_offset_real_slider.Disable() self.dc_offset_imag_text.Disable() self.dc_offset_imag_slider.Disable() self.dc_offset_mode = dc_offset_mode self.src.set_dc_offset_mode(dc_offset_mode) self.dc_offset_mode_chooser.set_value(self.dc_offset_mode) def set_dc_offset(self, value): correction = complex( self['dc_offset_real'], self['dc_offset_imag'] ) if self._verbose: print "Set DC offset to", correction self.src.set_dc_offset( correction ) def set_iq_balance_mode(self, iq_balance_mode): if iq_balance_mode == 1: self.iq_balance_mag_text.Enable() self.iq_balance_mag_slider.Enable() self.iq_balance_pha_text.Enable() self.iq_balance_pha_slider.Enable() self.set_iq_balance(0) else: self.iq_balance_mag_text.Disable() self.iq_balance_mag_slider.Disable() self.iq_balance_pha_text.Disable() self.iq_balance_pha_slider.Disable() self.iq_balance_mode = iq_balance_mode self.src.set_iq_balance_mode(iq_balance_mode) self.iq_balance_mode_chooser.set_value(self.iq_balance_mode) def set_iq_balance(self, value): correction = complex( self['iq_balance_mag'], self['iq_balance_pha'] ) if self._verbose: print "Set IQ balance to", correction self.src.set_iq_balance( correction ) def set_sample_rate(self, samp_rate): samp_rate = self.src.set_sample_rate(samp_rate) if hasattr(self.scope, 'set_sample_rate'): self.scope.set_sample_rate(samp_rate) if self._verbose: print "Set sample rate to:", samp_rate try: self[BWIDTH_KEY] = self.set_bandwidth(samp_rate) except RuntimeError: pass return samp_rate def get_gain_names(self): return self.src.get_gain_names() def set_named_gain(self, gain, name): if gain is None: g = self[GAIN_RANGE_KEY(name)] gain = float(g.start()+g.stop())/2 if self._verbose: print "Using auto-calculated mid-point gain" self[GAIN_KEY(name)] = gain return gain = self.src.set_gain(gain, name) if self._verbose: print "Set " + name + " gain to:", gain def set_bandwidth(self, bw): clipped_bw = self[BWIDTH_RANGE_KEY].clip(bw) if self.src.get_bandwidth() != clipped_bw: bw = self.src.set_bandwidth(clipped_bw) if self._verbose: print "Set bandwidth to:", bw return bw def set_freq_from_callback(self, freq): freq = self.src.set_center_freq(freq) self[CENTER_FREQ_KEY] = freq; def set_freq(self, freq): if freq is None: f = self[FREQ_RANGE_KEY] freq = float(f.start()+f.stop())/2.0 if self._verbose: print "Using auto-calculated mid-point frequency" self[CENTER_FREQ_KEY] = freq return freq = self.src.set_center_freq(freq) if hasattr(self.scope, 'set_baseband_freq'): self.scope.set_baseband_freq(freq) if freq is not None: if self._verbose: print "Set center frequency to", freq elif self._verbose: print "Failed to set freq." return freq def set_freq_corr(self, ppm): if ppm is None: ppm = 0.0 if self._verbose: print "Using frequency corrrection of", ppm self[FREQ_CORR_KEY] = ppm return ppm = self.src.set_freq_corr(ppm) if self._verbose: print "Set frequency correction to:", ppm def main (): app = stdgui2.stdapp(app_top_block, "osmocom Spectrum Browser", nstatus=1) app.MainLoop() if __name__ == '__main__': main () gr-osmosdr-0.1.0.55.80c4af/apps/osmocom_siggen000077500000000000000000000327361225753723100207430ustar00rootroot00000000000000#!/usr/bin/env python # # Copyright 2009,2011,2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. # from gnuradio import gr from gnuradio import analog from gnuradio.gr.pubsub import pubsub from osmosdr import osmocom_siggen_base as osmocom_siggen import sys, math try: from gnuradio.wxgui import gui, forms import wx except ImportError: sys.stderr.write("Error importing GNU Radio's wxgui. Please make sure gr-wxgui is installed.\n") sys.exit(1) class app_gui(pubsub): def __init__(self, frame, panel, vbox, top_block, options, args): pubsub.__init__(self) self.frame = frame # Use for top-level application window frame self.panel = panel # Use as parent class for created windows self.vbox = vbox # Use as sizer for created windows self.tb = top_block # GUI-unaware flowgraph class self.options = options # Supplied command-line options self.args = args # Supplied command-line arguments self.build_gui() # Event response handlers def evt_set_status_msg(self, msg): self.frame.SetStatusText(msg, 0) # GUI construction def build_gui(self): self.vbox.AddSpacer(3) self.vbox.AddStretchSpacer() ################################################## # Baseband controls ################################################## bb_vbox = forms.static_box_sizer(parent=self.panel, label="Baseband Modulation", orient=wx.VERTICAL, bold=True) self.vbox.Add(bb_vbox, 0, wx.EXPAND) sine_bb_hbox = wx.BoxSizer(wx.HORIZONTAL) sweep_bb_hbox = wx.BoxSizer(wx.HORIZONTAL) tone_bb_hbox = wx.BoxSizer(wx.HORIZONTAL) self.vbox.AddSpacer(5) self.vbox.AddStretchSpacer() #callback to show/hide forms def set_type(type): sine_bb_hbox.ShowItems(type == analog.GR_SIN_WAVE) sweep_bb_hbox.ShowItems(type == 'sweep') tone_bb_hbox.ShowItems(type == '2tone') self.vbox.Layout() self.tb.subscribe(osmocom_siggen.TYPE_KEY, set_type) #create sine forms sine_bb_hbox.AddSpacer(5) forms.text_box( parent=self.panel, sizer=sine_bb_hbox, label='Frequency (Hz)', ps=self.tb, key=osmocom_siggen.WAVEFORM_FREQ_KEY, converter=forms.float_converter(), ) sine_bb_hbox.AddStretchSpacer() #create sweep forms sweep_bb_hbox.AddSpacer(5) forms.text_box( parent=self.panel, sizer=sweep_bb_hbox, label='Sweep Width (Hz)', ps=self.tb, key=osmocom_siggen.WAVEFORM_FREQ_KEY, converter=forms.float_converter(), ) sweep_bb_hbox.AddStretchSpacer() forms.text_box( parent=self.panel, sizer=sweep_bb_hbox, label='Sweep Rate (Hz)', ps=self.tb, key=osmocom_siggen.WAVEFORM2_FREQ_KEY, converter=forms.float_converter(), ) sweep_bb_hbox.AddStretchSpacer() #create 2tone forms tone_bb_hbox.AddSpacer(5) forms.text_box( parent=self.panel, sizer=tone_bb_hbox, label='Tone 1 (Hz)', ps=self.tb, key=osmocom_siggen.WAVEFORM_FREQ_KEY, converter=forms.float_converter(), ) tone_bb_hbox.AddStretchSpacer() forms.text_box( parent=self.panel, sizer=tone_bb_hbox, label='Tone 2 (Hz)', ps=self.tb, key=osmocom_siggen.WAVEFORM2_FREQ_KEY, converter=forms.float_converter(), ) tone_bb_hbox.AddStretchSpacer() forms.radio_buttons( parent=self.panel, sizer=bb_vbox, choices=osmocom_siggen.waveforms.keys(), labels=osmocom_siggen.waveforms.values(), ps=self.tb, key=osmocom_siggen.TYPE_KEY, style=wx.NO_BORDER | wx.RA_HORIZONTAL, ) bb_vbox.AddSpacer(5) bb_vbox.Add(sine_bb_hbox, 0, wx.EXPAND) bb_vbox.Add(sweep_bb_hbox, 0, wx.EXPAND) bb_vbox.Add(tone_bb_hbox, 0, wx.EXPAND) set_type(self.tb[osmocom_siggen.TYPE_KEY]) ################################################## # Frequency controls ################################################## fc_vbox = forms.static_box_sizer(parent=self.panel, label="Center Frequency", orient=wx.VERTICAL, bold=True) fc_vbox.AddSpacer(3) # First row of frequency controls (center frequency) freq_hbox = wx.BoxSizer(wx.HORIZONTAL) fc_vbox.Add(freq_hbox, 0, wx.EXPAND) fc_vbox.AddSpacer(5) # Second row of frequency controls (freq. correction) corr_hbox = wx.BoxSizer(wx.HORIZONTAL) fc_vbox.Add(corr_hbox, 0, wx.EXPAND) fc_vbox.AddSpacer(3) # Add frequency controls to top window sizer self.vbox.Add(fc_vbox, 0, wx.EXPAND) self.vbox.AddSpacer(5) self.vbox.AddStretchSpacer() freq_hbox.AddSpacer(3) forms.text_box( parent=self.panel, sizer=freq_hbox, label='Center Frequency (Hz)', proportion=1, converter=forms.float_converter(), ps=self.tb, key=osmocom_siggen.TX_FREQ_KEY, ) freq_hbox.AddSpacer(5) forms.slider( parent=self.panel, sizer=freq_hbox, proportion=2, ps=self.tb, key=osmocom_siggen.TX_FREQ_KEY, minimum=self.tb[osmocom_siggen.FREQ_RANGE_KEY].start(), maximum=self.tb[osmocom_siggen.FREQ_RANGE_KEY].stop(), num_steps=101, ) freq_hbox.AddSpacer(3) corr_hbox.AddSpacer(3) forms.text_box( parent=self.panel, sizer=corr_hbox, label='Freq. Correction (ppm)', proportion=1, converter=forms.float_converter(), ps=self.tb, key=osmocom_siggen.FREQ_CORR_KEY, ) corr_hbox.AddSpacer(5) forms.slider( parent=self.panel, sizer=corr_hbox, proportion=2, ps=self.tb, key=osmocom_siggen.FREQ_CORR_KEY, minimum=-100, maximum=+100, num_steps=2010, step_size=0.1, ) corr_hbox.AddSpacer(3) ################################################## # Amplitude controls ################################################## amp_vbox = forms.static_box_sizer(parent=self.panel, label="Amplitude", orient=wx.VERTICAL, bold=True) amp_vbox.AddSpacer(3) # First row of amp controls (ampl) lvl_hbox = wx.BoxSizer(wx.HORIZONTAL) amp_vbox.Add(lvl_hbox, 0, wx.EXPAND) amp_vbox.AddSpacer(5) self.vbox.Add(amp_vbox, 0, wx.EXPAND) self.vbox.AddSpacer(5) self.vbox.AddStretchSpacer() lvl_hbox.AddSpacer(3) forms.text_box( parent=self.panel, sizer=lvl_hbox, proportion=1, converter=forms.float_converter(), ps=self.tb, key=osmocom_siggen.AMPLITUDE_KEY, label="Level (0.1-1.0)", ) lvl_hbox.AddSpacer(5) forms.log_slider( parent=self.panel, sizer=lvl_hbox, proportion=2, ps=self.tb, key=osmocom_siggen.AMPLITUDE_KEY, min_exp=-1, max_exp=0, base=10, num_steps=100, ) lvl_hbox.AddSpacer(3) for gain_name in self.tb.get_gain_names(): range = self.tb[osmocom_siggen.GAIN_RANGE_KEY(gain_name)] gain = self.tb[osmocom_siggen.GAIN_KEY(gain_name)] #print gain_name, gain, range.to_pp_string() if range.start() < range.stop(): gain_hbox = wx.BoxSizer(wx.HORIZONTAL) amp_vbox.Add(gain_hbox, 0, wx.EXPAND) amp_vbox.AddSpacer(3) gain_hbox.AddSpacer(3) forms.text_box( parent=self.panel, sizer=gain_hbox, proportion=1, converter=forms.float_converter(), ps=self.tb, key=osmocom_siggen.GAIN_KEY(gain_name), label=gain_name + " Gain (dB)", ) gain_hbox.AddSpacer(5) forms.slider( parent=self.panel, sizer=gain_hbox, proportion=2, ps=self.tb, key=osmocom_siggen.GAIN_KEY(gain_name), minimum=range.start(), maximum=range.stop(), step_size=range.step(), ) gain_hbox.AddSpacer(3) ################################################## # Bandwidth controls ################################################## try: bw_range = self.tb[osmocom_siggen.BWIDTH_RANGE_KEY] #print bw_range.to_pp_string() if bw_range.start() < bw_range.stop(): bwidth_vbox = forms.static_box_sizer(parent=self.panel, label="Bandwidth", orient=wx.VERTICAL, bold=True) bwidth_vbox.AddSpacer(3) bwidth_hbox = wx.BoxSizer(wx.HORIZONTAL) bwidth_vbox.Add(bwidth_hbox, 0, wx.EXPAND) bwidth_vbox.AddSpacer(3) self.vbox.Add(bwidth_vbox, 0, wx.EXPAND) self.vbox.AddSpacer(5) self.vbox.AddStretchSpacer() bwidth_hbox.AddSpacer(3) forms.text_box( parent=self.panel, sizer=bwidth_hbox, proportion=1, converter=forms.float_converter(), ps=self.tb, key=osmocom_siggen.BWIDTH_KEY, label="Bandwidth (Hz)", ) bwidth_hbox.AddSpacer(5) forms.slider( parent=self.panel, sizer=bwidth_hbox, proportion=2, ps=self.tb, key=osmocom_siggen.BWIDTH_KEY, minimum=bw_range.start(), maximum=bw_range.stop(), step_size=bw_range.step(), ) bwidth_hbox.AddSpacer(3) except RuntimeError: pass ################################################## # Sample Rate controls ################################################## sam_hbox = forms.static_box_sizer(parent=self.panel, label="Sample Rate", orient=wx.HORIZONTAL, bold=True) self.vbox.Add(sam_hbox, 0, wx.EXPAND) self.vbox.AddSpacer(5) self.vbox.AddStretchSpacer() sam_hbox.AddStretchSpacer(20) forms.static_text( parent=self.panel, sizer=sam_hbox, label='Sample Rate (sps)', ps=self.tb, key=osmocom_siggen.SAMP_RATE_KEY, converter=forms.float_converter(), ) sam_hbox.AddStretchSpacer(20) def main(): try: # Get command line parameters (options, args) = osmocom_siggen.get_options() # Create the top block using these tb = osmocom_siggen.top_block(options, args) # Create the GUI application app = gui.app(top_block=tb, # Constructed top block gui=app_gui, # User interface class options=options, # Command line options args=args, # Command line args title="osmocom Signal Generator", # Top window title nstatus=1, # Number of status lines start=True, # Whether to start flowgraph realtime=True) # Whether to set realtime priority # And run it app.MainLoop() except RuntimeError, e: print e sys.exit(1) # Make sure to create the top block (tb) within a function: That code # in main will allow tb to go out of scope on return, which will call # the decontructor on radio device and stop transmit. Whats odd is that # grc works fine with tb in the __main__, perhaps its because the # try/except clauses around tb. if __name__ == "__main__": main() gr-osmosdr-0.1.0.55.80c4af/apps/osmocom_siggen_base.py000066400000000000000000000452401225753723100223530ustar00rootroot00000000000000#!/usr/bin/env python # # Copyright 2008,2009,2011,2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. # SAMP_RATE_KEY = 'samp_rate' GAIN_KEY = lambda x: 'gain:'+x BWIDTH_KEY = 'bwidth' TX_FREQ_KEY = 'tx_freq' FREQ_CORR_KEY = 'freq_corr' AMPLITUDE_KEY = 'amplitude' AMPL_RANGE_KEY = 'ampl_range' WAVEFORM_FREQ_KEY = 'waveform_freq' WAVEFORM_OFFSET_KEY = 'waveform_offset' WAVEFORM2_FREQ_KEY = 'waveform2_freq' FREQ_RANGE_KEY = 'freq_range' GAIN_RANGE_KEY = lambda x: 'gain_range:'+x BWIDTH_RANGE_KEY = 'bwidth_range' TYPE_KEY = 'type' def setter(ps, key, val): ps[key] = val import osmosdr from gnuradio import blocks from gnuradio import filter from gnuradio import analog from gnuradio import digital from gnuradio import gr, gru, eng_notation from gnuradio.gr.pubsub import pubsub from gnuradio.eng_option import eng_option from optparse import OptionParser import sys import math import numpy import random n2s = eng_notation.num_to_str waveforms = { analog.GR_SIN_WAVE : "Sinusoid", analog.GR_CONST_WAVE : "Constant", analog.GR_GAUSSIAN : "Gaussian Noise", analog.GR_UNIFORM : "Uniform Noise", "2tone" : "Two Tone (IMD)", "sweep" : "Freq. Sweep", "gsm" : "GSM Bursts" } class gsm_source_c(gr.hier_block2): def __init__(self, sample_rate, amplitude): gr.hier_block2.__init__(self, "gsm_source_c", gr.io_signature(0, 0, 0), # Input signature gr.io_signature(1, 1, gr.sizeof_gr_complex)) # Output signature self._symb_rate = 13e6 / 48; self._samples_per_symbol = 2 self._data = blocks.vector_source_b(self.gen_gsm_seq(), True, 2) self._split = blocks.vector_to_streams(gr.sizeof_char*1, 2) self._pack = blocks.unpacked_to_packed_bb(1, gr.GR_MSB_FIRST) self._mod = digital.gmsk_mod(self._samples_per_symbol, bt=0.35) self._pwr_f = blocks.char_to_float(1, 1) self._pwr_c = blocks.float_to_complex(1) self._pwr_w = blocks.repeat(gr.sizeof_gr_complex*1, self._samples_per_symbol) self._mul = blocks.multiply_vcc(1) self._interpolate = filter.fractional_resampler_cc( 0, (self._symb_rate * self._samples_per_symbol) / sample_rate ) self._scale = blocks.multiply_const_cc(amplitude) self.connect(self._data, self._split) self.connect((self._split, 0), self._pack, self._mod, (self._mul, 0)) self.connect((self._split, 1), self._pwr_f, self._pwr_c, self._pwr_w, (self._mul, 1)) self.connect(self._mul, self._interpolate, self._scale, self) def set_amplitude(self, amplitude): self._scale.set_k(amplitude) def set_sampling_freq(self, sample_rate): self._interpolate.set_interp_ratio( (self._symb_rate * self._samples_per_symbol) / sample_rate ) def gen_gsm_burst(self, l): chunks = [ [0,0,0], list(numpy.random.randint(0, 2, 58)), [0,0,1,0,0,1,0,1,1,1,0,0,0,0,1,0,0,0,1,0,0,1,0,1,1,1], list(numpy.random.randint(0, 2, 58)), [0,0,0], ] burst = sum(chunks,[]) burst = sum(map(list, zip(burst, (1,) * len(burst))), []) burst += [1,0] * (l-148) return map(int, burst) def gen_gsm_frame(self): return \ self.gen_gsm_burst(158) + \ self.gen_gsm_burst(158) + \ self.gen_gsm_burst(158) + \ self.gen_gsm_burst(159) + \ self.gen_gsm_burst(158) + \ self.gen_gsm_burst(158) + \ self.gen_gsm_burst(158) + \ self.gen_gsm_burst(159) def gen_gsm_seq(self): return sum([self.gen_gsm_frame() for i in range(10)], []) # # GUI-unaware GNU Radio flowgraph. This may be used either with command # line applications or GUI applications. # class top_block(gr.top_block, pubsub): def __init__(self, options, args): gr.top_block.__init__(self) pubsub.__init__(self) self._verbose = options.verbose #initialize values from options self._setup_osmosdr(options) self[SAMP_RATE_KEY] = options.samp_rate self[TX_FREQ_KEY] = options.tx_freq self[FREQ_CORR_KEY] = options.freq_corr self[AMPLITUDE_KEY] = options.amplitude self[WAVEFORM_FREQ_KEY] = options.waveform_freq self[WAVEFORM_OFFSET_KEY] = options.offset self[WAVEFORM2_FREQ_KEY] = options.waveform2_freq #subscribe set methods self.subscribe(SAMP_RATE_KEY, self.set_samp_rate) for name in self.get_gain_names(): self.subscribe(GAIN_KEY(name), (lambda gain,self=self,name=name: self.set_named_gain(gain, name))) self.subscribe(BWIDTH_KEY, self.set_bandwidth) self.subscribe(TX_FREQ_KEY, self.set_freq) self.subscribe(FREQ_CORR_KEY, self.set_freq_corr) self.subscribe(AMPLITUDE_KEY, self.set_amplitude) self.subscribe(WAVEFORM_FREQ_KEY, self.set_waveform_freq) self.subscribe(WAVEFORM2_FREQ_KEY, self.set_waveform2_freq) self.subscribe(TYPE_KEY, self.set_waveform) #force update on pubsub keys for key in (SAMP_RATE_KEY, GAIN_KEY, BWIDTH_KEY, TX_FREQ_KEY, FREQ_CORR_KEY, AMPLITUDE_KEY, WAVEFORM_FREQ_KEY, WAVEFORM_OFFSET_KEY, WAVEFORM2_FREQ_KEY): #print key, "=", self[key] self[key] = self[key] self[TYPE_KEY] = options.type #set type last def _setup_osmosdr(self, options): self._sink = osmosdr.sink(options.args) try: self._sink.get_sample_rates().start() except RuntimeError: print "Sink has no sample rates (wrong device arguments?)." sys.exit(1) if options.samp_rate is None: options.samp_rate = self._sink.get_sample_rates().start() self.set_samp_rate(options.samp_rate) # Set the gain from options if(options.gain): gain = self._sink.set_gain(options.gain) if self._verbose: print "Set gain to:", gain # Set the antenna if(options.antenna): ant = self._sink.set_antenna(options.antenna, 0) if self._verbose: print "Set antenna to:", ant self.publish(FREQ_RANGE_KEY, self._sink.get_freq_range) for name in self.get_gain_names(): self.publish(GAIN_RANGE_KEY(name), (lambda self=self,name=name: self._sink.get_gain_range(name))) self.publish(BWIDTH_RANGE_KEY, self._sink.get_bandwidth_range) for name in self.get_gain_names(): self.publish(GAIN_KEY(name), (lambda self=self,name=name: self._sink.get_gain(name))) self.publish(BWIDTH_KEY, self._sink.get_bandwidth) def get_gain_names(self): return self._sink.get_gain_names() def set_samp_rate(self, sr): sr = self._sink.set_sample_rate(sr) if self[TYPE_KEY] in (analog.GR_SIN_WAVE, analog.GR_CONST_WAVE): self._src.set_sampling_freq(self[SAMP_RATE_KEY]) elif self[TYPE_KEY] == "2tone": self._src1.set_sampling_freq(self[SAMP_RATE_KEY]) self._src2.set_sampling_freq(self[SAMP_RATE_KEY]) elif self[TYPE_KEY] == "sweep": self._src1.set_sampling_freq(self[SAMP_RATE_KEY]) self._src2.set_sampling_freq(self[WAVEFORM_FREQ_KEY]*2*math.pi/self[SAMP_RATE_KEY]) elif self[TYPE_KEY] == "gsm": self._src.set_sampling_freq(self[SAMP_RATE_KEY]) else: return True # Waveform not yet set if self._verbose: print "Set sample rate to:", sr return True def set_named_gain(self, gain, name): if gain is None: g = self[GAIN_RANGE_KEY(name)] gain = float(g.start()+g.stop())/2 if self._verbose: print "Using auto-calculated mid-point gain" self[GAIN_KEY(name)] = gain return gain = self._sink.set_gain(gain, name) if self._verbose: print "Set " + name + " gain to:", gain def set_bandwidth(self, bw): clipped_bw = self[BWIDTH_RANGE_KEY].clip(bw) if self._sink.get_bandwidth() != clipped_bw: bw = self._sink.set_bandwidth(clipped_bw) if self._verbose: print "Set bandwidth to:", bw def set_freq(self, freq): if freq is None: f = self[FREQ_RANGE_KEY] freq = float(f.start()+f.stop())/2.0 if self._verbose: print "Using auto-calculated mid-point frequency" self[TX_FREQ_KEY] = freq return freq = self._sink.set_center_freq(freq) if freq is not None: self._freq = freq if self._verbose: print "Set center frequency to", freq elif self._verbose: print "Failed to set freq." return freq def set_freq_corr(self, ppm): if ppm is None: ppm = 0.0 if self._verbose: print "Using frequency corrrection of", ppm self[FREQ_CORR_KEY] = ppm return ppm = self._sink.set_freq_corr(ppm) if self._verbose: print "Set frequency correction to:", ppm def set_waveform_freq(self, freq): if self[TYPE_KEY] == analog.GR_SIN_WAVE: self._src.set_frequency(freq) elif self[TYPE_KEY] == "2tone": self._src1.set_frequency(freq) elif self[TYPE_KEY] == 'sweep': #there is no set sensitivity, redo fg self[TYPE_KEY] = self[TYPE_KEY] return True def set_waveform2_freq(self, freq): if freq is None: self[WAVEFORM2_FREQ_KEY] = -self[WAVEFORM_FREQ_KEY] return if self[TYPE_KEY] == "2tone": self._src2.set_frequency(freq) elif self[TYPE_KEY] == "sweep": self._src1.set_frequency(freq) return True def set_waveform(self, type): self.lock() self.disconnect_all() if type == analog.GR_SIN_WAVE or type == analog.GR_CONST_WAVE: self._src = analog.sig_source_c(self[SAMP_RATE_KEY], # Sample rate type, # Waveform type self[WAVEFORM_FREQ_KEY], # Waveform frequency self[AMPLITUDE_KEY], # Waveform amplitude self[WAVEFORM_OFFSET_KEY]) # Waveform offset elif type == analog.GR_GAUSSIAN or type == analog.GR_UNIFORM: self._src = analog.noise_source_c(type, self[AMPLITUDE_KEY]) elif type == "2tone": self._src1 = analog.sig_source_c(self[SAMP_RATE_KEY], analog.GR_SIN_WAVE, self[WAVEFORM_FREQ_KEY], self[AMPLITUDE_KEY]/2.0, 0) if(self[WAVEFORM2_FREQ_KEY] is None): self[WAVEFORM2_FREQ_KEY] = -self[WAVEFORM_FREQ_KEY] self._src2 = analog.sig_source_c(self[SAMP_RATE_KEY], analog.GR_SIN_WAVE, self[WAVEFORM2_FREQ_KEY], self[AMPLITUDE_KEY]/2.0, 0) self._src = blocks.add_cc() self.connect(self._src1,(self._src,0)) self.connect(self._src2,(self._src,1)) elif type == "sweep": # rf freq is center frequency # waveform_freq is total swept width # waveform2_freq is sweep rate # will sweep from (rf_freq-waveform_freq/2) to (rf_freq+waveform_freq/2) if self[WAVEFORM2_FREQ_KEY] is None: self[WAVEFORM2_FREQ_KEY] = 0.1 self._src1 = analog.sig_source_f(self[SAMP_RATE_KEY], analog.GR_TRI_WAVE, self[WAVEFORM2_FREQ_KEY], 1.0, -0.5) self._src2 = analog.frequency_modulator_fc(self[WAVEFORM_FREQ_KEY]*2*math.pi/self[SAMP_RATE_KEY]) self._src = blocks.multiply_const_cc(self[AMPLITUDE_KEY]) self.connect(self._src1,self._src2,self._src) elif type == "gsm": self._src = gsm_source_c(self[SAMP_RATE_KEY], self[AMPLITUDE_KEY]) else: raise RuntimeError("Unknown waveform type") self.connect(self._src, self._sink) self.unlock() if self._verbose: print "Set baseband modulation to:", waveforms[type] if type == analog.GR_SIN_WAVE: print "Modulation frequency: %sHz" % (n2s(self[WAVEFORM_FREQ_KEY]),) print "Initial phase:", self[WAVEFORM_OFFSET_KEY] elif type == "2tone": print "Tone 1: %sHz" % (n2s(self[WAVEFORM_FREQ_KEY]),) print "Tone 2: %sHz" % (n2s(self[WAVEFORM2_FREQ_KEY]),) elif type == "sweep": print "Sweeping across %sHz to %sHz" % (n2s(-self[WAVEFORM_FREQ_KEY]/2.0),n2s(self[WAVEFORM_FREQ_KEY]/2.0)) print "Sweep rate: %sHz" % (n2s(self[WAVEFORM2_FREQ_KEY]),) elif type == "gsm": print "GSM Burst Sequence" print "TX amplitude:", self[AMPLITUDE_KEY] def set_amplitude(self, amplitude): if amplitude < 0.0 or amplitude > 1.0: if self._verbose: print "Amplitude out of range:", amplitude return False if self[TYPE_KEY] in (analog.GR_SIN_WAVE, analog.GR_CONST_WAVE, analog.GR_GAUSSIAN, analog.GR_UNIFORM): self._src.set_amplitude(amplitude) elif self[TYPE_KEY] == "2tone": self._src1.set_amplitude(amplitude/2.0) self._src2.set_amplitude(amplitude/2.0) elif self[TYPE_KEY] == "sweep": self._src.set_k(amplitude) elif self[TYPE_KEY] == "gsm": self._src.set_amplitude(amplitude) else: return True # Waveform not yet set if self._verbose: print "Set amplitude to:", amplitude return True def get_options(): usage="%prog: [options]" parser = OptionParser(option_class=eng_option, usage=usage) parser.add_option("-a", "--args", type="string", default="", help="Device args, [default=%default]") parser.add_option("-A", "--antenna", type="string", default=None, help="Select Rx Antenna where appropriate") parser.add_option("-s", "--samp-rate", type="eng_float", default=None, help="Set sample rate (bandwidth), minimum by default") parser.add_option("-g", "--gain", type="eng_float", default=None, help="Set gain in dB (default is midpoint)") parser.add_option("-f", "--tx-freq", type="eng_float", default=None, help="Set carrier frequency to FREQ [default=mid-point]", metavar="FREQ") parser.add_option("-c", "--freq-corr", type="int", default=None, help="Set carrier frequency correction [default=0]") parser.add_option("-x", "--waveform-freq", type="eng_float", default=0, help="Set baseband waveform frequency to FREQ [default=%default]") parser.add_option("-y", "--waveform2-freq", type="eng_float", default=None, help="Set 2nd waveform frequency to FREQ [default=%default]") parser.add_option("--sine", dest="type", action="store_const", const=analog.GR_SIN_WAVE, help="Generate a carrier modulated by a complex sine wave", default=analog.GR_SIN_WAVE) parser.add_option("--const", dest="type", action="store_const", const=analog.GR_CONST_WAVE, help="Generate a constant carrier") parser.add_option("--offset", type="eng_float", default=0, help="Set waveform phase offset to OFFSET [default=%default]") parser.add_option("--gaussian", dest="type", action="store_const", const=analog.GR_GAUSSIAN, help="Generate Gaussian random output") parser.add_option("--uniform", dest="type", action="store_const", const=analog.GR_UNIFORM, help="Generate Uniform random output") parser.add_option("--2tone", dest="type", action="store_const", const="2tone", help="Generate Two Tone signal for IMD testing") parser.add_option("--sweep", dest="type", action="store_const", const="sweep", help="Generate a swept sine wave") parser.add_option("--gsm", dest="type", action="store_const", const="gsm", help="Generate GMSK modulated GSM Burst Sequence") parser.add_option("", "--amplitude", type="eng_float", default=0.3, help="Set output amplitude to AMPL (0.1-1.0) [default=%default]", metavar="AMPL") parser.add_option("-v", "--verbose", action="store_true", default=False, help="Use verbose console output [default=%default]") (options, args) = parser.parse_args() return (options, args) # If this script is executed, the following runs. If it is imported, # the below does not run. def test_main(): if gr.enable_realtime_scheduling() != gr.RT_OK: print "Note: failed to enable realtime scheduling, continuing" # Grab command line options and create top block try: (options, args) = get_options() tb = top_block(options, args) except RuntimeError, e: print e sys.exit(1) tb.start() raw_input('Press Enter to quit: ') tb.stop() tb.wait() # Make sure to create the top block (tb) within a function: # That code in main will allow tb to go out of scope on return, # which will call the decontructor on radio and stop transmit. # Whats odd is that grc works fine with tb in the __main__, # perhaps its because the try/except clauses around tb. if __name__ == "__main__": test_main() gr-osmosdr-0.1.0.55.80c4af/apps/osmocom_siggen_nogui000077500000000000000000000032551225753723100221360ustar00rootroot00000000000000#!/usr/bin/env python # # Copyright 2008,2009,2011,2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. # from gnuradio import gr from osmosdr import osmocom_siggen_base as osmocom_siggen import sys def main(): if gr.enable_realtime_scheduling() != gr.RT_OK: print "Note: failed to enable realtime scheduling, continuing" # Grab command line options and create top block try: (options, args) = osmocom_siggen.get_options() tb = osmocom_siggen.top_block(options, args) except RuntimeError, e: print e sys.exit(1) tb.start() raw_input('Press Enter to quit: ') tb.stop() tb.wait() # Make sure to create the top block (tb) within a function: # That code in main will allow tb to go out of scope on return, # which will call the decontructor on usrp and stop transmit. # Whats odd is that grc works fine with tb in the __main__, # perhaps its because the try/except clauses around tb. if __name__ == "__main__": main() gr-osmosdr-0.1.0.55.80c4af/apps/osmocom_spectrum_sense000077500000000000000000000256701225753723100225250ustar00rootroot00000000000000#!/usr/bin/env python # # Copyright 2005,2007,2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. # import osmosdr from gnuradio import gr, eng_notation from gnuradio import blocks from gnuradio import audio from gnuradio import filter from gnuradio import fft from gnuradio.eng_option import eng_option from optparse import OptionParser import sys import math import struct import threading from datetime import datetime sys.stderr.write("Warning: this may have issues on some machines+Python version combinations to seg fault due to the callback in bin_statitics.\n\n") class ThreadClass(threading.Thread): def run(self): return class tune(gr.feval_dd): """ This class allows C++ code to callback into python. """ def __init__(self, tb): gr.feval_dd.__init__(self) self.tb = tb def eval(self, ignore): """ This method is called from blocks.bin_statistics_f when it wants to change the center frequency. This method tunes the front end to the new center frequency, and returns the new frequency as its result. """ try: # We use this try block so that if something goes wrong # from here down, at least we'll have a prayer of knowing # what went wrong. Without this, you get a very # mysterious: # # terminate called after throwing an instance of # 'Swig::DirectorMethodException' Aborted # # message on stderr. Not exactly helpful ;) new_freq = self.tb.set_next_freq() # wait until msgq is empty before continuing while(self.tb.msgq.full_p()): #print "msgq full, holding.." time.sleep(0.1) return new_freq except Exception, e: print "tune: Exception: ", e class parse_msg(object): def __init__(self, msg): self.center_freq = msg.arg1() self.vlen = int(msg.arg2()) assert(msg.length() == self.vlen * gr.sizeof_float) # FIXME consider using NumPy array t = msg.to_string() self.raw_data = t self.data = struct.unpack('%df' % (self.vlen,), t) class my_top_block(gr.top_block): def __init__(self): gr.top_block.__init__(self) usage = "usage: %prog [options] min_freq max_freq" parser = OptionParser(option_class=eng_option, usage=usage) parser.add_option("-a", "--args", type="string", default="", help="Device args [default=%default]") parser.add_option("-A", "--antenna", type="string", default=None, help="Select antenna where appropriate") parser.add_option("-s", "--samp-rate", type="eng_float", default=None, help="Set sample rate (bandwidth), minimum by default") parser.add_option("-g", "--gain", type="eng_float", default=None, help="Set gain in dB (default is midpoint)") parser.add_option("", "--tune-delay", type="eng_float", default=0.25, metavar="SECS", help="Time to delay (in seconds) after changing frequency [default=%default]") parser.add_option("", "--dwell-delay", type="eng_float", default=0.25, metavar="SECS", help="Time to dwell (in seconds) at a given frequency [default=%default]") parser.add_option("-b", "--channel-bandwidth", type="eng_float", default=6.25e3, metavar="Hz", help="Channel bandwidth of fft bins in Hz [default=%default]") parser.add_option("-q", "--squelch-threshold", type="eng_float", default=None, metavar="dB", help="Squelch threshold in dB [default=%default]") parser.add_option("-F", "--fft-size", type="int", default=None, help="Specify number of FFT bins [default=samp_rate/channel_bw]") parser.add_option("", "--real-time", action="store_true", default=False, help="Attempt to enable real-time scheduling") (options, args) = parser.parse_args() if len(args) != 2: parser.print_help() sys.exit(1) self.channel_bandwidth = options.channel_bandwidth self.min_freq = eng_notation.str_to_num(args[0]) self.max_freq = eng_notation.str_to_num(args[1]) if self.min_freq > self.max_freq: # swap them self.min_freq, self.max_freq = self.max_freq, self.min_freq if not options.real_time: realtime = False else: # Attempt to enable realtime scheduling r = gr.enable_realtime_scheduling() if r == gr.RT_OK: realtime = True else: realtime = False print "Note: failed to enable realtime scheduling" # build graph self.u = osmosdr.source(options.args) try: self.u.get_sample_rates().start() except RuntimeError: print "Source has no sample rates (wrong device arguments?)." sys.exit(1) # Set the antenna if(options.antenna): self.u.set_antenna(options.antenna, 0) if options.samp_rate is None: options.samp_rate = self.u.get_sample_rates().start() self.u.set_sample_rate(options.samp_rate) self.usrp_rate = usrp_rate = self.u.get_sample_rate() if options.fft_size is None: self.fft_size = int(self.usrp_rate/self.channel_bandwidth) else: self.fft_size = options.fft_size self.squelch_threshold = options.squelch_threshold s2v = blocks.stream_to_vector(gr.sizeof_gr_complex, self.fft_size) mywindow = filter.window.blackmanharris(self.fft_size) ffter = fft.fft_vcc(self.fft_size, True, mywindow, True) power = 0 for tap in mywindow: power += tap*tap c2mag = blocks.complex_to_mag_squared(self.fft_size) # FIXME the log10 primitive is dog slow #log = blocks.nlog10_ff(10, self.fft_size, # -20*math.log10(self.fft_size)-10*math.log10(power/self.fft_size)) # Set the freq_step to 75% of the actual data throughput. # This allows us to discard the bins on both ends of the spectrum. self.freq_step = self.nearest_freq((0.75 * self.usrp_rate), self.channel_bandwidth) self.min_center_freq = self.min_freq + (self.freq_step/2) nsteps = math.ceil((self.max_freq - self.min_freq) / self.freq_step) self.max_center_freq = self.min_center_freq + (nsteps * self.freq_step) self.next_freq = self.min_center_freq tune_delay = max(0, int(round(options.tune_delay * usrp_rate / self.fft_size))) # in fft_frames dwell_delay = max(1, int(round(options.dwell_delay * usrp_rate / self.fft_size))) # in fft_frames self.msgq = gr.msg_queue(1) self._tune_callback = tune(self) # hang on to this to keep it from being GC'd stats = blocks.bin_statistics_f(self.fft_size, self.msgq, self._tune_callback, tune_delay, dwell_delay) # FIXME leave out the log10 until we speed it up #self.connect(self.u, s2v, ffter, c2mag, log, stats) self.connect(self.u, s2v, ffter, c2mag, stats) if options.gain is None: # if no gain was specified, use the mid-point in dB g = self.u.get_gain_range() options.gain = float(g.start()+g.stop())/2.0 self.set_gain(options.gain) print "gain =", options.gain def set_next_freq(self): target_freq = self.next_freq self.next_freq = self.next_freq + self.freq_step if self.next_freq >= self.max_center_freq: self.next_freq = self.min_center_freq if not self.set_freq(target_freq): print "Failed to set frequency to", target_freq sys.exit(1) return target_freq def set_freq(self, target_freq): """ Set the center frequency we're interested in. @param target_freq: frequency in Hz @rypte: bool """ r = self.u.set_center_freq(target_freq) if r: return True return False def set_gain(self, gain): self.u.set_gain(gain) def nearest_freq(self, freq, channel_bandwidth): freq = round(freq / channel_bandwidth, 0) * channel_bandwidth return freq def main_loop(tb): def bin_freq(i_bin, center_freq): #hz_per_bin = tb.usrp_rate / tb.fft_size freq = center_freq - (tb.usrp_rate / 2) + (tb.channel_bandwidth * i_bin) #print "freq original:",freq #freq = nearest_freq(freq, tb.channel_bandwidth) #print "freq rounded:",freq return freq bin_start = int(tb.fft_size * ((1 - 0.75) / 2)) bin_stop = int(tb.fft_size - bin_start) while 1: # Get the next message sent from the C++ code (blocking call). # It contains the center frequency and the mag squared of the fft m = parse_msg(tb.msgq.delete_head()) # m.center_freq is the center frequency at the time of capture # m.data are the mag_squared of the fft output # m.raw_data is a string that contains the binary floats. # You could write this as binary to a file. for i_bin in range(bin_start, bin_stop): center_freq = m.center_freq freq = bin_freq(i_bin, center_freq) #noise_floor_db = -174 + 10*math.log10(tb.channel_bandwidth) noise_floor_db = 10*math.log10(min(m.data)/tb.usrp_rate) power_db = 10*math.log10(m.data[i_bin]/tb.usrp_rate) - noise_floor_db if (power_db > tb.squelch_threshold) and (freq >= tb.min_freq) and (freq <= tb.max_freq): print datetime.now(), "center_freq", center_freq, "freq", freq, "power_db", power_db, "noise_floor_db", noise_floor_db if __name__ == '__main__': t = ThreadClass() t.start() tb = my_top_block() try: tb.start() main_loop(tb) except KeyboardInterrupt: pass gr-osmosdr-0.1.0.55.80c4af/cmake/000077500000000000000000000000001225753723100161075ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/000077500000000000000000000000001225753723100175175ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/CMakeParseArgumentsCopy.cmake000066400000000000000000000134031225753723100252160ustar00rootroot00000000000000# CMAKE_PARSE_ARGUMENTS( args...) # # CMAKE_PARSE_ARGUMENTS() is intended to be used in macros or functions for # parsing the arguments given to that macro or function. # It processes the arguments and defines a set of variables which hold the # values of the respective options. # # The argument contains all options for the respective macro, # i.e. keywords which can be used when calling the macro without any value # following, like e.g. the OPTIONAL keyword of the install() command. # # The argument contains all keywords for this macro # which are followed by one value, like e.g. DESTINATION keyword of the # install() command. # # The argument contains all keywords for this macro # which can be followed by more than one value, like e.g. the TARGETS or # FILES keywords of the install() command. # # When done, CMAKE_PARSE_ARGUMENTS() will have defined for each of the # keywords listed in , and # a variable composed of the given # followed by "_" and the name of the respective keyword. # These variables will then hold the respective value from the argument list. # For the keywords this will be TRUE or FALSE. # # All remaining arguments are collected in a variable # _UNPARSED_ARGUMENTS, this can be checked afterwards to see whether # your macro was called with unrecognized parameters. # # As an example here a my_install() macro, which takes similar arguments as the # real install() command: # # function(MY_INSTALL) # set(options OPTIONAL FAST) # set(oneValueArgs DESTINATION RENAME) # set(multiValueArgs TARGETS CONFIGURATIONS) # cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} ) # ... # # Assume my_install() has been called like this: # my_install(TARGETS foo bar DESTINATION bin OPTIONAL blub) # # After the cmake_parse_arguments() call the macro will have set the following # variables: # MY_INSTALL_OPTIONAL = TRUE # MY_INSTALL_FAST = FALSE (this option was not used when calling my_install() # MY_INSTALL_DESTINATION = "bin" # MY_INSTALL_RENAME = "" (was not used) # MY_INSTALL_TARGETS = "foo;bar" # MY_INSTALL_CONFIGURATIONS = "" (was not used) # MY_INSTALL_UNPARSED_ARGUMENTS = "blub" (no value expected after "OPTIONAL" # # You can the continue and process these variables. # # Keywords terminate lists of values, e.g. if directly after a one_value_keyword # another recognized keyword follows, this is interpreted as the beginning of # the new option. # E.g. my_install(TARGETS foo DESTINATION OPTIONAL) would result in # MY_INSTALL_DESTINATION set to "OPTIONAL", but MY_INSTALL_DESTINATION would # be empty and MY_INSTALL_OPTIONAL would be set to TRUE therefor. #============================================================================= # Copyright 2010 Alexander Neundorf # # Distributed under the OSI-approved BSD License (the "License"); # see accompanying file Copyright.txt for details. # # This software is distributed WITHOUT ANY WARRANTY; without even the # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. # See the License for more information. #============================================================================= # (To distribute this file outside of CMake, substitute the full # License text for the above reference.) if(__CMAKE_PARSE_ARGUMENTS_INCLUDED) return() endif() set(__CMAKE_PARSE_ARGUMENTS_INCLUDED TRUE) function(CMAKE_PARSE_ARGUMENTS prefix _optionNames _singleArgNames _multiArgNames) # first set all result variables to empty/FALSE foreach(arg_name ${_singleArgNames} ${_multiArgNames}) set(${prefix}_${arg_name}) endforeach(arg_name) foreach(option ${_optionNames}) set(${prefix}_${option} FALSE) endforeach(option) set(${prefix}_UNPARSED_ARGUMENTS) set(insideValues FALSE) set(currentArgName) # now iterate over all arguments and fill the result variables foreach(currentArg ${ARGN}) list(FIND _optionNames "${currentArg}" optionIndex) # ... then this marks the end of the arguments belonging to this keyword list(FIND _singleArgNames "${currentArg}" singleArgIndex) # ... then this marks the end of the arguments belonging to this keyword list(FIND _multiArgNames "${currentArg}" multiArgIndex) # ... then this marks the end of the arguments belonging to this keyword if(${optionIndex} EQUAL -1 AND ${singleArgIndex} EQUAL -1 AND ${multiArgIndex} EQUAL -1) if(insideValues) if("${insideValues}" STREQUAL "SINGLE") set(${prefix}_${currentArgName} ${currentArg}) set(insideValues FALSE) elseif("${insideValues}" STREQUAL "MULTI") list(APPEND ${prefix}_${currentArgName} ${currentArg}) endif() else(insideValues) list(APPEND ${prefix}_UNPARSED_ARGUMENTS ${currentArg}) endif(insideValues) else() if(NOT ${optionIndex} EQUAL -1) set(${prefix}_${currentArg} TRUE) set(insideValues FALSE) elseif(NOT ${singleArgIndex} EQUAL -1) set(currentArgName ${currentArg}) set(${prefix}_${currentArgName}) set(insideValues "SINGLE") elseif(NOT ${multiArgIndex} EQUAL -1) set(currentArgName ${currentArg}) set(${prefix}_${currentArgName}) set(insideValues "MULTI") endif() endif() endforeach(currentArg) # propagate the result variables to the caller: foreach(arg_name ${_singleArgNames} ${_multiArgNames} ${_optionNames}) set(${prefix}_${arg_name} ${${prefix}_${arg_name}} PARENT_SCOPE) endforeach(arg_name) set(${prefix}_UNPARSED_ARGUMENTS ${${prefix}_UNPARSED_ARGUMENTS} PARENT_SCOPE) endfunction(CMAKE_PARSE_ARGUMENTS _options _singleArgs _multiArgs) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/FindGnuradioFCD.cmake000066400000000000000000000022251225753723100234100ustar00rootroot00000000000000INCLUDE(FindPkgConfig) PKG_CHECK_MODULES(PC_GNURADIO_FCD gnuradio-fcd) FIND_PATH( GNURADIO_FCD_INCLUDE_DIRS NAMES gnuradio/fcd/api.h HINTS $ENV{GNURADIO_FCD_DIR}/include ${PC_GNURADIO_FCD_INCLUDEDIR} PATHS /usr/local/include /usr/include ) FIND_LIBRARY( GNURADIO_FCD_LIBRARIES NAMES gnuradio-fcd HINTS $ENV{GNURADIO_FCD_DIR}/lib ${PC_GNURADIO_FCD_LIBDIR} PATHS /usr/local/lib /usr/local/lib64 /usr/lib /usr/lib64 ) if(GNURADIO_FCD_INCLUDE_DIRS AND GNURADIO_FCD_LIBRARIES) set(GNURADIO_FCD_FOUND TRUE CACHE INTERNAL "gnuradio-fcd found") message(STATUS "Found gnuradio-fcd: ${GNURADIO_FCD_INCLUDE_DIRS}, ${GNURADIO_FCD_LIBRARIES}") else(GNURADIO_FCD_INCLUDE_DIRS AND GNURADIO_FCD_LIBRARIES) set(GNURADIO_FCD_FOUND FALSE CACHE INTERNAL "gnuradio-fcd found") message(STATUS "gnuradio-fcd not found.") endif(GNURADIO_FCD_INCLUDE_DIRS AND GNURADIO_FCD_LIBRARIES) INCLUDE(FindPackageHandleStandardArgs) FIND_PACKAGE_HANDLE_STANDARD_ARGS(GNURADIO_FCD DEFAULT_MSG GNURADIO_FCD_LIBRARIES GNURADIO_FCD_INCLUDE_DIRS) MARK_AS_ADVANCED(GNURADIO_FCD_LIBRARIES GNURADIO_FCD_INCLUDE_DIRS) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/FindGnuradioFCDPP.cmake000066400000000000000000000023511225753723100236500ustar00rootroot00000000000000INCLUDE(FindPkgConfig) PKG_CHECK_MODULES(PC_GNURADIO_FCDPP gnuradio-fcdproplus) FIND_PATH( GNURADIO_FCDPP_INCLUDE_DIRS NAMES fcdproplus/api.h HINTS $ENV{GNURADIO_FCDPP_DIR}/include ${PC_GNURADIO_FCDPP_INCLUDEDIR} PATHS /usr/local/include /usr/include ) FIND_LIBRARY( GNURADIO_FCDPP_LIBRARIES NAMES gnuradio-fcdproplus HINTS $ENV{GNURADIO_FCDPP_DIR}/lib ${PC_GNURADIO_FCDPP_LIBDIR} PATHS /usr/local/lib /usr/local/lib64 /usr/lib /usr/lib64 ) if(GNURADIO_FCDPP_INCLUDE_DIRS AND GNURADIO_FCDPP_LIBRARIES) set(GNURADIO_FCDPP_FOUND TRUE CACHE INTERNAL "gnuradio-fcdproplus found") message(STATUS "Found gnuradio-fcdproplus: ${GNURADIO_FCDPP_INCLUDE_DIRS}, ${GNURADIO_FCDPP_LIBRARIES}") else(GNURADIO_FCDPP_INCLUDE_DIRS AND GNURADIO_FCDPP_LIBRARIES) set(GNURADIO_FCDPP_FOUND FALSE CACHE INTERNAL "gnuradio-fcdproplus found") message(STATUS "gnuradio-fcdproplus not found.") endif(GNURADIO_FCDPP_INCLUDE_DIRS AND GNURADIO_FCDPP_LIBRARIES) INCLUDE(FindPackageHandleStandardArgs) FIND_PACKAGE_HANDLE_STANDARD_ARGS(GNURADIO_FCDPP DEFAULT_MSG GNURADIO_FCDPP_LIBRARIES GNURADIO_FCDPP_INCLUDE_DIRS) MARK_AS_ADVANCED(GNURADIO_FCDPP_LIBRARIES GNURADIO_FCDPP_INCLUDE_DIRS) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/FindGnuradioIQBalance.cmake000066400000000000000000000016351225753723100245770ustar00rootroot00000000000000INCLUDE(FindPkgConfig) PKG_CHECK_MODULES(PC_GNURADIO_IQBALANCE gnuradio-iqbalance) FIND_PATH( GNURADIO_IQBALANCE_INCLUDE_DIRS NAMES gnuradio/iqbalance/api.h HINTS $ENV{GNURADIO_IQBALANCE_DIR}/include ${PC_GNURADIO_IQBALANCE_INCLUDEDIR} ${CMAKE_INSTALL_PREFIX}/include PATHS /usr/local/include /usr/include ) FIND_LIBRARY( GNURADIO_IQBALANCE_LIBRARIES NAMES gnuradio-iqbalance HINTS $ENV{GNURADIO_IQBALANCE_DIR}/lib ${PC_GNURADIO_IQBALANCE_LIBDIR} ${CMAKE_INSTALL_PREFIX}/lib64 ${CMAKE_INSTALL_PREFIX}/lib PATHS /usr/local/lib /usr/local/lib64 /usr/lib /usr/lib64 ) INCLUDE(FindPackageHandleStandardArgs) FIND_PACKAGE_HANDLE_STANDARD_ARGS(GNURADIO_IQBALANCE DEFAULT_MSG GNURADIO_IQBALANCE_LIBRARIES GNURADIO_IQBALANCE_INCLUDE_DIRS) MARK_AS_ADVANCED(GNURADIO_IQBALANCE_LIBRARIES GNURADIO_IQBALANCE_INCLUDE_DIRS) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/FindGnuradioUHD.cmake000066400000000000000000000022251225753723100234340ustar00rootroot00000000000000INCLUDE(FindPkgConfig) PKG_CHECK_MODULES(PC_GNURADIO_UHD gnuradio-uhd) FIND_PATH( GNURADIO_UHD_INCLUDE_DIRS NAMES gnuradio/uhd/api.h HINTS $ENV{GNURADIO_UHD_DIR}/include ${PC_GNURADIO_UHD_INCLUDEDIR} PATHS /usr/local/include /usr/include ) FIND_LIBRARY( GNURADIO_UHD_LIBRARIES NAMES gnuradio-uhd HINTS $ENV{GNURADIO_UHD_DIR}/lib ${PC_GNURADIO_UHD_LIBDIR} PATHS /usr/local/lib /usr/local/lib64 /usr/lib /usr/lib64 ) if(GNURADIO_UHD_INCLUDE_DIRS AND GNURADIO_UHD_LIBRARIES) set(GNURADIO_UHD_FOUND TRUE CACHE INTERNAL "gnuradio-uhd found") message(STATUS "Found gnuradio-uhd: ${GNURADIO_UHD_INCLUDE_DIRS}, ${GNURADIO_UHD_LIBRARIES}") else(GNURADIO_UHD_INCLUDE_DIRS AND GNURADIO_UHD_LIBRARIES) set(GNURADIO_UHD_FOUND FALSE CACHE INTERNAL "gnuradio-uhd found") message(STATUS "gnuradio-uhd not found.") endif(GNURADIO_UHD_INCLUDE_DIRS AND GNURADIO_UHD_LIBRARIES) INCLUDE(FindPackageHandleStandardArgs) FIND_PACKAGE_HANDLE_STANDARD_ARGS(GNURADIO_UHD DEFAULT_MSG GNURADIO_UHD_LIBRARIES GNURADIO_UHD_INCLUDE_DIRS) MARK_AS_ADVANCED(GNURADIO_UHD_LIBRARIES GNURADIO_UHD_INCLUDE_DIRS) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/FindLibHackRF.cmake000066400000000000000000000011641225753723100230510ustar00rootroot00000000000000INCLUDE(FindPkgConfig) PKG_CHECK_MODULES(PC_LIBHACKRF libhackrf) FIND_PATH( LIBHACKRF_INCLUDE_DIRS NAMES libhackrf/hackrf.h HINTS $ENV{LIBHACKRF_DIR}/include ${PC_LIBHACKRF_INCLUDEDIR} PATHS /usr/local/include /usr/include ) FIND_LIBRARY( LIBHACKRF_LIBRARIES NAMES hackrf HINTS $ENV{LIBHACKRF_DIR}/lib ${PC_LIBHACKRF_LIBDIR} PATHS /usr/local/lib /usr/lib ) INCLUDE(FindPackageHandleStandardArgs) FIND_PACKAGE_HANDLE_STANDARD_ARGS(LIBHACKRF DEFAULT_MSG LIBHACKRF_LIBRARIES LIBHACKRF_INCLUDE_DIRS) MARK_AS_ADVANCED(LIBHACKRF_LIBRARIES LIBHACKRF_INCLUDE_DIRS) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/FindLibMiriSDR.cmake000066400000000000000000000015371225753723100232300ustar00rootroot00000000000000if(NOT LIBMIRISDR_FOUND) pkg_check_modules (LIBMIRISDR_PKG libmirisdr) find_path(LIBMIRISDR_INCLUDE_DIRS NAMES mirisdr.h PATHS ${LIBMIRISDR_PKG_INCLUDE_DIRS} /usr/include /usr/local/include ) find_library(LIBMIRISDR_LIBRARIES NAMES mirisdr PATHS ${LIBMIRISDR_PKG_LIBRARY_DIRS} /usr/lib /usr/local/lib ) if(LIBMIRISDR_INCLUDE_DIRS AND LIBMIRISDR_LIBRARIES) set(LIBMIRISDR_FOUND TRUE CACHE INTERNAL "libmirisdr found") message(STATUS "Found libmirisdr: ${LIBMIRISDR_INCLUDE_DIRS}, ${LIBMIRISDR_LIBRARIES}") else(LIBMIRISDR_INCLUDE_DIRS AND LIBMIRISDR_LIBRARIES) set(LIBMIRISDR_FOUND FALSE CACHE INTERNAL "libmirisdr found") message(STATUS "libmirisdr not found.") endif(LIBMIRISDR_INCLUDE_DIRS AND LIBMIRISDR_LIBRARIES) mark_as_advanced(LIBMIRISDR_LIBRARIES LIBMIRISDR_INCLUDE_DIRS) endif(NOT LIBMIRISDR_FOUND) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/FindLibOsmoSDR.cmake000066400000000000000000000015371225753723100232450ustar00rootroot00000000000000if(NOT LIBOSMOSDR_FOUND) pkg_check_modules (LIBOSMOSDR_PKG libosmosdr) find_path(LIBOSMOSDR_INCLUDE_DIRS NAMES osmosdr.h PATHS ${LIBOSMOSDR_PKG_INCLUDE_DIRS} /usr/include /usr/local/include ) find_library(LIBOSMOSDR_LIBRARIES NAMES osmosdr PATHS ${LIBOSMOSDR_PKG_LIBRARY_DIRS} /usr/lib /usr/local/lib ) if(LIBOSMOSDR_INCLUDE_DIRS AND LIBOSMOSDR_LIBRARIES) set(LIBOSMOSDR_FOUND TRUE CACHE INTERNAL "libosmosdr found") message(STATUS "Found libosmosdr: ${LIBOSMOSDR_INCLUDE_DIRS}, ${LIBOSMOSDR_LIBRARIES}") else(LIBOSMOSDR_INCLUDE_DIRS AND LIBOSMOSDR_LIBRARIES) set(LIBOSMOSDR_FOUND FALSE CACHE INTERNAL "libosmosdr found") message(STATUS "libosmosdr not found.") endif(LIBOSMOSDR_INCLUDE_DIRS AND LIBOSMOSDR_LIBRARIES) mark_as_advanced(LIBOSMOSDR_LIBRARIES LIBOSMOSDR_INCLUDE_DIRS) endif(NOT LIBOSMOSDR_FOUND) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/FindLibRTLSDR.cmake000066400000000000000000000015061225753723100227650ustar00rootroot00000000000000if(NOT LIBRTLSDR_FOUND) pkg_check_modules (LIBRTLSDR_PKG librtlsdr) find_path(LIBRTLSDR_INCLUDE_DIRS NAMES rtl-sdr.h PATHS ${LIBRTLSDR_PKG_INCLUDE_DIRS} /usr/include /usr/local/include ) find_library(LIBRTLSDR_LIBRARIES NAMES rtlsdr PATHS ${LIBRTLSDR_PKG_LIBRARY_DIRS} /usr/lib /usr/local/lib ) if(LIBRTLSDR_INCLUDE_DIRS AND LIBRTLSDR_LIBRARIES) set(LIBRTLSDR_FOUND TRUE CACHE INTERNAL "librtlsdr found") message(STATUS "Found librtlsdr: ${LIBRTLSDR_INCLUDE_DIRS}, ${LIBRTLSDR_LIBRARIES}") else(LIBRTLSDR_INCLUDE_DIRS AND LIBRTLSDR_LIBRARIES) set(LIBRTLSDR_FOUND FALSE CACHE INTERNAL "librtlsdr found") message(STATUS "librtlsdr not found.") endif(LIBRTLSDR_INCLUDE_DIRS AND LIBRTLSDR_LIBRARIES) mark_as_advanced(LIBRTLSDR_LIBRARIES LIBRTLSDR_INCLUDE_DIRS) endif(NOT LIBRTLSDR_FOUND) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/FindLibbladeRF.cmake000066400000000000000000000015421225753723100232520ustar00rootroot00000000000000if(NOT LIBBLADERF_FOUND) pkg_check_modules (LIBBLADERF_PKG libbladeRF) find_path(LIBBLADERF_INCLUDE_DIRS NAMES libbladeRF.h PATHS ${LIBBLADERF_PKG_INCLUDE_DIRS} /usr/include /usr/local/include ) find_library(LIBBLADERF_LIBRARIES NAMES bladeRF PATHS ${LIBBLADERF_PKG_LIBRARY_DIRS} /usr/lib /usr/local/lib ) if(LIBBLADERF_INCLUDE_DIRS AND LIBBLADERF_LIBRARIES) set(LIBBLADERF_FOUND TRUE CACHE INTERNAL "libbladeRF found") message(STATUS "Found libbladeRF: ${LIBBLADERF_INCLUDE_DIRS}, ${LIBBLADERF_LIBRARIES}") else(LIBBLADERF_INCLUDE_DIRS AND LIBBLADERF_LIBRARIES) set(LIBBLADERF_FOUND FALSE CACHE INTERNAL "libbladeRF found") message(STATUS "libbladeRF not found.") endif(LIBBLADERF_INCLUDE_DIRS AND LIBBLADERF_LIBRARIES) mark_as_advanced(LIBBLADERF_LIBRARIES LIBBLADERF_INCLUDE_DIRS) endif(NOT LIBBLADERF_FOUND) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/FindUHD.cmake000066400000000000000000000013421225753723100217420ustar00rootroot00000000000000######################################################################## # Find the library for the USRP Hardware Driver ######################################################################## INCLUDE(FindPkgConfig) PKG_CHECK_MODULES(PC_UHD uhd) FIND_PATH( UHD_INCLUDE_DIRS NAMES uhd/config.hpp HINTS $ENV{UHD_DIR}/include ${PC_UHD_INCLUDEDIR} PATHS /usr/local/include /usr/include ) FIND_LIBRARY( UHD_LIBRARIES NAMES uhd HINTS $ENV{UHD_DIR}/lib ${PC_UHD_LIBDIR} PATHS /usr/local/lib /usr/lib ) INCLUDE(FindPackageHandleStandardArgs) FIND_PACKAGE_HANDLE_STANDARD_ARGS(UHD DEFAULT_MSG UHD_LIBRARIES UHD_INCLUDE_DIRS) MARK_AS_ADVANCED(UHD_LIBRARIES UHD_INCLUDE_DIRS) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/GrComponent.cmake000066400000000000000000000107371225753723100227640ustar00rootroot00000000000000# Copyright 2010-2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. if(DEFINED __INCLUDED_GR_COMPONENT_CMAKE) return() endif() set(__INCLUDED_GR_COMPONENT_CMAKE TRUE) set(_gr_enabled_components "" CACHE INTERNAL "" FORCE) set(_gr_disabled_components "" CACHE INTERNAL "" FORCE) if(NOT DEFINED ENABLE_DEFAULT) set(ENABLE_DEFAULT ON) message(STATUS "") message(STATUS "The build system will automatically enable all components.") message(STATUS "Use -DENABLE_DEFAULT=OFF to disable components by default.") endif() ######################################################################## # Register a component into the system # - name: canonical component name # - var: variable for enabled status # - argn: list of dependencies ######################################################################## function(GR_REGISTER_COMPONENT name var) include(CMakeDependentOption) message(STATUS "") message(STATUS "Configuring ${name} support...") foreach(dep ${ARGN}) message(STATUS " Dependency ${dep} = ${${dep}}") endforeach(dep) #if the user set the var to force, we note this if("${${var}}" STREQUAL "FORCE") set(${var} ON) set(var_force TRUE) else() set(var_force FALSE) endif() #rewrite the dependency list so that deps that are also components use the cached version unset(comp_deps) foreach(dep ${ARGN}) list(FIND _gr_enabled_components ${dep} dep_enb_index) list(FIND _gr_disabled_components ${dep} dep_dis_index) if (${dep_enb_index} EQUAL -1 AND ${dep_dis_index} EQUAL -1) list(APPEND comp_deps ${dep}) else() list(APPEND comp_deps ${dep}_cached) #is a component, use cached version endif() endforeach(dep) #setup the dependent option for this component CMAKE_DEPENDENT_OPTION(${var} "enable ${name} support" ${ENABLE_DEFAULT} "${comp_deps}" OFF) set(${var} "${${var}}" PARENT_SCOPE) set(${var}_cached "${${var}}" CACHE INTERNAL "" FORCE) #force was specified, but the dependencies were not met if(NOT ${var} AND var_force) message(FATAL_ERROR "user force-enabled ${name} but configuration checked failed") endif() #append the component into one of the lists if(${var}) message(STATUS " Enabling ${name} support.") list(APPEND _gr_enabled_components ${name}) else(${var}) message(STATUS " Disabling ${name} support.") list(APPEND _gr_disabled_components ${name}) endif(${var}) message(STATUS " Override with -D${var}=ON/OFF") #make components lists into global variables set(_gr_enabled_components ${_gr_enabled_components} CACHE INTERNAL "" FORCE) set(_gr_disabled_components ${_gr_disabled_components} CACHE INTERNAL "" FORCE) endfunction(GR_REGISTER_COMPONENT) ######################################################################## # Print the registered component summary ######################################################################## function(GR_PRINT_COMPONENT_SUMMARY) message(STATUS "") message(STATUS "######################################################") message(STATUS "# gr-osmosdr enabled components ") message(STATUS "######################################################") foreach(comp ${_gr_enabled_components}) message(STATUS " * ${comp}") endforeach(comp) message(STATUS "") message(STATUS "######################################################") message(STATUS "# gr-osmosdr disabled components ") message(STATUS "######################################################") foreach(comp ${_gr_disabled_components}) message(STATUS " * ${comp}") endforeach(comp) message(STATUS "") endfunction(GR_PRINT_COMPONENT_SUMMARY) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/GrMiscUtils.cmake000066400000000000000000000320421225753723100227270ustar00rootroot00000000000000# Copyright 2010-2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. if(DEFINED __INCLUDED_GR_MISC_UTILS_CMAKE) return() endif() set(__INCLUDED_GR_MISC_UTILS_CMAKE TRUE) ######################################################################## # Set global variable macro. # Used for subdirectories to export settings. # Example: include and library paths. ######################################################################## function(GR_SET_GLOBAL var) set(${var} ${ARGN} CACHE INTERNAL "" FORCE) endfunction(GR_SET_GLOBAL) ######################################################################## # Set the pre-processor definition if the condition is true. # - def the pre-processor definition to set and condition name ######################################################################## function(GR_ADD_COND_DEF def) if(${def}) add_definitions(-D${def}) endif(${def}) endfunction(GR_ADD_COND_DEF) ######################################################################## # Check for a header and conditionally set a compile define. # - hdr the relative path to the header file # - def the pre-processor definition to set ######################################################################## function(GR_CHECK_HDR_N_DEF hdr def) include(CheckIncludeFileCXX) CHECK_INCLUDE_FILE_CXX(${hdr} ${def}) GR_ADD_COND_DEF(${def}) endfunction(GR_CHECK_HDR_N_DEF) ######################################################################## # Include subdirectory macro. # Sets the CMake directory variables, # includes the subdirectory CMakeLists.txt, # resets the CMake directory variables. # # This macro includes subdirectories rather than adding them # so that the subdirectory can affect variables in the level above. # This provides a work-around for the lack of convenience libraries. # This way a subdirectory can append to the list of library sources. ######################################################################## macro(GR_INCLUDE_SUBDIRECTORY subdir) #insert the current directories on the front of the list list(INSERT _cmake_source_dirs 0 ${CMAKE_CURRENT_SOURCE_DIR}) list(INSERT _cmake_binary_dirs 0 ${CMAKE_CURRENT_BINARY_DIR}) #set the current directories to the names of the subdirs set(CMAKE_CURRENT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/${subdir}) set(CMAKE_CURRENT_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/${subdir}) #include the subdirectory CMakeLists to run it file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}) include(${CMAKE_CURRENT_SOURCE_DIR}/CMakeLists.txt) #reset the value of the current directories list(GET _cmake_source_dirs 0 CMAKE_CURRENT_SOURCE_DIR) list(GET _cmake_binary_dirs 0 CMAKE_CURRENT_BINARY_DIR) #pop the subdir names of the front of the list list(REMOVE_AT _cmake_source_dirs 0) list(REMOVE_AT _cmake_binary_dirs 0) endmacro(GR_INCLUDE_SUBDIRECTORY) ######################################################################## # Check if a compiler flag works and conditionally set a compile define. # - flag the compiler flag to check for # - have the variable to set with result ######################################################################## macro(GR_ADD_CXX_COMPILER_FLAG_IF_AVAILABLE flag have) include(CheckCXXCompilerFlag) CHECK_CXX_COMPILER_FLAG(${flag} ${have}) if(${have}) add_definitions(${flag}) endif(${have}) endmacro(GR_ADD_CXX_COMPILER_FLAG_IF_AVAILABLE) ######################################################################## # Generates the .la libtool file # This appears to generate libtool files that cannot be used by auto*. # Usage GR_LIBTOOL(TARGET [target] DESTINATION [dest]) # Notice: there is not COMPONENT option, these will not get distributed. ######################################################################## function(GR_LIBTOOL) if(NOT DEFINED GENERATE_LIBTOOL) set(GENERATE_LIBTOOL OFF) #disabled by default endif() if(GENERATE_LIBTOOL) include(CMakeParseArgumentsCopy) CMAKE_PARSE_ARGUMENTS(GR_LIBTOOL "" "TARGET;DESTINATION" "" ${ARGN}) find_program(LIBTOOL libtool) if(LIBTOOL) include(CMakeMacroLibtoolFile) CREATE_LIBTOOL_FILE(${GR_LIBTOOL_TARGET} /${GR_LIBTOOL_DESTINATION}) endif(LIBTOOL) endif(GENERATE_LIBTOOL) endfunction(GR_LIBTOOL) ######################################################################## # Do standard things to the library target # - set target properties # - make install rules # Also handle gnuradio custom naming conventions w/ extras mode. ######################################################################## function(GR_LIBRARY_FOO target) #parse the arguments for component names include(CMakeParseArgumentsCopy) CMAKE_PARSE_ARGUMENTS(GR_LIBRARY "" "RUNTIME_COMPONENT;DEVEL_COMPONENT" "" ${ARGN}) #set additional target properties set_target_properties(${target} PROPERTIES SOVERSION ${LIBVER}) #install the generated files like so... install(TARGETS ${target} LIBRARY DESTINATION ${GR_LIBRARY_DIR} COMPONENT ${GR_LIBRARY_RUNTIME_COMPONENT} # .so/.dylib file ARCHIVE DESTINATION ${GR_LIBRARY_DIR} COMPONENT ${GR_LIBRARY_DEVEL_COMPONENT} # .lib file RUNTIME DESTINATION ${GR_RUNTIME_DIR} COMPONENT ${GR_LIBRARY_RUNTIME_COMPONENT} # .dll file ) #extras mode enabled automatically on linux if(NOT DEFINED LIBRARY_EXTRAS) set(LIBRARY_EXTRAS ${LINUX}) endif() #special extras mode to enable alternative naming conventions if(LIBRARY_EXTRAS) #create .la file before changing props GR_LIBTOOL(TARGET ${target} DESTINATION ${GR_LIBRARY_DIR}) #give the library a special name with ultra-zero soversion set_target_properties(${target} PROPERTIES OUTPUT_NAME ${target}-${LIBVER} SOVERSION "0.0.0") set(target_name lib${target}-${LIBVER}.so.0.0.0) #custom command to generate symlinks add_custom_command( TARGET ${target} POST_BUILD COMMAND ${CMAKE_COMMAND} -E create_symlink ${target_name} ${CMAKE_CURRENT_BINARY_DIR}/lib${target}.so COMMAND ${CMAKE_COMMAND} -E create_symlink ${target_name} ${CMAKE_CURRENT_BINARY_DIR}/lib${target}-${LIBVER}.so.0 COMMAND ${CMAKE_COMMAND} -E touch ${target_name} #so the symlinks point to something valid so cmake 2.6 will install ) #and install the extra symlinks install( FILES ${CMAKE_CURRENT_BINARY_DIR}/lib${target}.so ${CMAKE_CURRENT_BINARY_DIR}/lib${target}-${LIBVER}.so.0 DESTINATION ${GR_LIBRARY_DIR} COMPONENT ${GR_LIBRARY_RUNTIME_COMPONENT} ) endif(LIBRARY_EXTRAS) endfunction(GR_LIBRARY_FOO) ######################################################################## # Create a dummy custom command that depends on other targets. # Usage: # GR_GEN_TARGET_DEPS(unique_name target_deps ...) # ADD_CUSTOM_COMMAND( ${target_deps}) # # Custom command cant depend on targets, but can depend on executables, # and executables can depend on targets. So this is the process: ######################################################################## function(GR_GEN_TARGET_DEPS name var) file( WRITE ${CMAKE_CURRENT_BINARY_DIR}/${name}.cpp.in "int main(void){return 0;}\n" ) execute_process( COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_BINARY_DIR}/${name}.cpp.in ${CMAKE_CURRENT_BINARY_DIR}/${name}.cpp ) add_executable(${name} ${CMAKE_CURRENT_BINARY_DIR}/${name}.cpp) if(ARGN) add_dependencies(${name} ${ARGN}) endif(ARGN) if(CMAKE_CROSSCOMPILING) set(${var} "DEPENDS;${name}" PARENT_SCOPE) #cant call command when cross else() set(${var} "DEPENDS;${name};COMMAND;${name}" PARENT_SCOPE) endif() endfunction(GR_GEN_TARGET_DEPS) ######################################################################## # Control use of gr_logger # Usage: # GR_LOGGING() # # Will set ENABLE_GR_LOG to 1 by default. # Can manually set with -DENABLE_GR_LOG=0|1 ######################################################################## function(GR_LOGGING) find_package(Log4cpp) OPTION(ENABLE_GR_LOG "Use gr_logger" ON) if(ENABLE_GR_LOG) # If gr_logger is enabled, make it usable add_definitions( -DENABLE_GR_LOG ) # also test LOG4CPP; if we have it, use this version of the logger # otherwise, default to the stdout/stderr model. if(LOG4CPP_FOUND) SET(HAVE_LOG4CPP True CACHE INTERNAL "" FORCE) add_definitions( -DHAVE_LOG4CPP ) else(not LOG4CPP_FOUND) SET(HAVE_LOG4CPP False CACHE INTERNAL "" FORCE) SET(LOG4CPP_INCLUDE_DIRS "" CACHE INTERNAL "" FORCE) SET(LOG4CPP_LIBRARY_DIRS "" CACHE INTERNAL "" FORCE) SET(LOG4CPP_LIBRARIES "" CACHE INTERNAL "" FORCE) endif(LOG4CPP_FOUND) SET(ENABLE_GR_LOG ${ENABLE_GR_LOG} CACHE INTERNAL "" FORCE) else(ENABLE_GR_LOG) SET(HAVE_LOG4CPP False CACHE INTERNAL "" FORCE) SET(LOG4CPP_INCLUDE_DIRS "" CACHE INTERNAL "" FORCE) SET(LOG4CPP_LIBRARY_DIRS "" CACHE INTERNAL "" FORCE) SET(LOG4CPP_LIBRARIES "" CACHE INTERNAL "" FORCE) endif(ENABLE_GR_LOG) message(STATUS "ENABLE_GR_LOG set to ${ENABLE_GR_LOG}.") message(STATUS "HAVE_LOG4CPP set to ${HAVE_LOG4CPP}.") message(STATUS "LOG4CPP_LIBRARIES set to ${LOG4CPP_LIBRARIES}.") endfunction(GR_LOGGING) ######################################################################## # Run GRCC to compile .grc files into .py files. # # Usage: GRCC(filename, directory) # - filenames: List of file name of .grc file # - directory: directory of built .py file - usually in # ${CMAKE_CURRENT_BINARY_DIR} # - Sets PYFILES: output converted GRC file names to Python files. ######################################################################## function(GRCC) # Extract directory from list of args, remove it for the list of filenames. list(GET ARGV -1 directory) list(REMOVE_AT ARGV -1) set(filenames ${ARGV}) file(MAKE_DIRECTORY ${directory}) SET(GRCC_COMMAND ${CMAKE_SOURCE_DIR}/gr-utils/python/grcc) # GRCC uses some stuff in grc and gnuradio-runtime, so we force # the known paths here list(APPEND PYTHONPATHS ${CMAKE_SOURCE_DIR} ${CMAKE_SOURCE_DIR}/gnuradio-runtime/python ${CMAKE_SOURCE_DIR}/gnuradio-runtime/lib/swig ${CMAKE_BINARY_DIR}/gnuradio-runtime/lib/swig ) if(WIN32) #SWIG generates the python library files into a subdirectory. #Therefore, we must append this subdirectory into PYTHONPATH. #Only do this for the python directories matching the following: foreach(pydir ${PYTHONPATHS}) get_filename_component(name ${pydir} NAME) if(name MATCHES "^(swig|lib|src)$") list(APPEND PYTHONPATHS ${pydir}/${CMAKE_BUILD_TYPE}) endif() endforeach(pydir) endif(WIN32) file(TO_NATIVE_PATH "${PYTHONPATHS}" pypath) if(UNIX) list(APPEND pypath "$PYTHONPATH") string(REPLACE ";" ":" pypath "${pypath}") set(ENV{PYTHONPATH} ${pypath}) endif(UNIX) if(WIN32) list(APPEND pypath "%PYTHONPATH%") string(REPLACE ";" "\\;" pypath "${pypath}") #list(APPEND environs "PYTHONPATH=${pypath}") set(ENV{PYTHONPATH} ${pypath}) endif(WIN32) foreach(f ${filenames}) execute_process( COMMAND ${GRCC_COMMAND} -d ${directory} ${f} ) string(REPLACE ".grc" ".py" pyfile "${f}") string(REPLACE "${CMAKE_CURRENT_SOURCE_DIR}" "${CMAKE_CURRENT_BINARY_DIR}" pyfile "${pyfile}") list(APPEND pyfiles ${pyfile}) endforeach(f) set(PYFILES ${pyfiles} PARENT_SCOPE) endfunction(GRCC) ######################################################################## # Check if HAVE_PTHREAD_SETSCHEDPARAM and HAVE_SCHED_SETSCHEDULER # should be defined ######################################################################## macro(GR_CHECK_LINUX_SCHED_AVAIL) set(CMAKE_REQUIRED_LIBRARIES -lpthread) CHECK_CXX_SOURCE_COMPILES(" #include int main(){ pthread_t pthread; pthread_setschedparam(pthread, 0, 0); return 0; } " HAVE_PTHREAD_SETSCHEDPARAM ) GR_ADD_COND_DEF(HAVE_PTHREAD_SETSCHEDPARAM) CHECK_CXX_SOURCE_COMPILES(" #include int main(){ pid_t pid; sched_setscheduler(pid, 0, 0); return 0; } " HAVE_SCHED_SETSCHEDULER ) GR_ADD_COND_DEF(HAVE_SCHED_SETSCHEDULER) endmacro(GR_CHECK_LINUX_SCHED_AVAIL) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/GrPlatform.cmake000066400000000000000000000034451225753723100226040ustar00rootroot00000000000000# Copyright 2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. if(DEFINED __INCLUDED_GR_PLATFORM_CMAKE) return() endif() set(__INCLUDED_GR_PLATFORM_CMAKE TRUE) ######################################################################## # Setup additional defines for OS types ######################################################################## 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/slackware-version") set(SLACKWARE TRUE) endif() ######################################################################## # when the library suffix should be 64 (applies to redhat linux family) ######################################################################## if (REDHAT OR SLACKWARE) set(LIB64_CONVENTION TRUE) endif() if(NOT DEFINED LIB_SUFFIX AND LIB64_CONVENTION AND CMAKE_SYSTEM_PROCESSOR MATCHES "64$") set(LIB_SUFFIX 64) endif() set(LIB_SUFFIX ${LIB_SUFFIX} CACHE STRING "lib directory suffix") gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/GrPython.cmake000066400000000000000000000226311225753723100222770ustar00rootroot00000000000000# Copyright 2010-2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. if(DEFINED __INCLUDED_GR_PYTHON_CMAKE) return() endif() set(__INCLUDED_GR_PYTHON_CMAKE TRUE) ######################################################################## # Setup the python interpreter: # This allows the user to specify a specific interpreter, # or finds the interpreter via the built-in cmake module. ######################################################################## #this allows the user to override PYTHON_EXECUTABLE if(PYTHON_EXECUTABLE) set(PYTHONINTERP_FOUND TRUE) #otherwise if not set, try to automatically find it else(PYTHON_EXECUTABLE) #use the built-in find script find_package(PythonInterp 2) #and if that fails use the find program routine if(NOT PYTHONINTERP_FOUND) find_program(PYTHON_EXECUTABLE NAMES python python2 python2.7 python2.6 python2.5) if(PYTHON_EXECUTABLE) set(PYTHONINTERP_FOUND TRUE) endif(PYTHON_EXECUTABLE) endif(NOT PYTHONINTERP_FOUND) endif(PYTHON_EXECUTABLE) if (CMAKE_CROSSCOMPILING) set(QA_PYTHON_EXECUTABLE "/usr/bin/python") else (CMAKE_CROSSCOMPILING) set(QA_PYTHON_EXECUTABLE ${PYTHON_EXECUTABLE}) endif(CMAKE_CROSSCOMPILING) #make the path to the executable appear in the cmake gui set(PYTHON_EXECUTABLE ${PYTHON_EXECUTABLE} CACHE FILEPATH "python interpreter") set(QA_PYTHON_EXECUTABLE ${QA_PYTHON_EXECUTABLE} CACHE FILEPATH "python interpreter for QA tests") #make sure we can use -B with python (introduced in 2.6) if(PYTHON_EXECUTABLE) execute_process( COMMAND ${PYTHON_EXECUTABLE} -B -c "" OUTPUT_QUIET ERROR_QUIET RESULT_VARIABLE PYTHON_HAS_DASH_B_RESULT ) if(PYTHON_HAS_DASH_B_RESULT EQUAL 0) set(PYTHON_DASH_B "-B") endif() endif(PYTHON_EXECUTABLE) ######################################################################## # Check for the existence of a python module: # - desc a string description of the check # - mod the name of the module to import # - cmd an additional command to run # - have the result variable to set ######################################################################## macro(GR_PYTHON_CHECK_MODULE desc mod cmd have) message(STATUS "") message(STATUS "Python checking for ${desc}") execute_process( COMMAND ${PYTHON_EXECUTABLE} -c " ######################################### try: import ${mod} assert ${cmd} except ImportError, AssertionError: exit(-1) except: pass #########################################" RESULT_VARIABLE ${have} ) if(${have} EQUAL 0) message(STATUS "Python checking for ${desc} - found") set(${have} TRUE) else(${have} EQUAL 0) message(STATUS "Python checking for ${desc} - not found") set(${have} FALSE) endif(${have} EQUAL 0) endmacro(GR_PYTHON_CHECK_MODULE) ######################################################################## # Sets the python installation directory GR_PYTHON_DIR ######################################################################## if(NOT DEFINED GR_PYTHON_DIR) execute_process(COMMAND ${PYTHON_EXECUTABLE} -c " from distutils import sysconfig print sysconfig.get_python_lib(plat_specific=True, prefix='') " OUTPUT_VARIABLE GR_PYTHON_DIR OUTPUT_STRIP_TRAILING_WHITESPACE ) endif() file(TO_CMAKE_PATH ${GR_PYTHON_DIR} GR_PYTHON_DIR) ######################################################################## # Create an always-built target with a unique name # Usage: GR_UNIQUE_TARGET( ) ######################################################################## function(GR_UNIQUE_TARGET desc) file(RELATIVE_PATH reldir ${CMAKE_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}) execute_process(COMMAND ${PYTHON_EXECUTABLE} -c "import re, hashlib unique = hashlib.md5('${reldir}${ARGN}').hexdigest()[:5] print(re.sub('\\W', '_', '${desc} ${reldir} ' + unique))" OUTPUT_VARIABLE _target OUTPUT_STRIP_TRAILING_WHITESPACE) add_custom_target(${_target} ALL DEPENDS ${ARGN}) endfunction(GR_UNIQUE_TARGET) ######################################################################## # Install python sources (also builds and installs byte-compiled python) ######################################################################## function(GR_PYTHON_INSTALL) include(CMakeParseArgumentsCopy) CMAKE_PARSE_ARGUMENTS(GR_PYTHON_INSTALL "" "DESTINATION;COMPONENT" "FILES;PROGRAMS" ${ARGN}) #################################################################### if(GR_PYTHON_INSTALL_FILES) #################################################################### install(${ARGN}) #installs regular python files #create a list of all generated files unset(pysrcfiles) unset(pycfiles) unset(pyofiles) foreach(pyfile ${GR_PYTHON_INSTALL_FILES}) get_filename_component(pyfile ${pyfile} ABSOLUTE) list(APPEND pysrcfiles ${pyfile}) #determine if this file is in the source or binary directory file(RELATIVE_PATH source_rel_path ${CMAKE_CURRENT_SOURCE_DIR} ${pyfile}) string(LENGTH "${source_rel_path}" source_rel_path_len) file(RELATIVE_PATH binary_rel_path ${CMAKE_CURRENT_BINARY_DIR} ${pyfile}) string(LENGTH "${binary_rel_path}" binary_rel_path_len) #and set the generated path appropriately if(${source_rel_path_len} GREATER ${binary_rel_path_len}) set(pygenfile ${CMAKE_CURRENT_BINARY_DIR}/${binary_rel_path}) else() set(pygenfile ${CMAKE_CURRENT_BINARY_DIR}/${source_rel_path}) endif() list(APPEND pycfiles ${pygenfile}c) list(APPEND pyofiles ${pygenfile}o) #ensure generation path exists get_filename_component(pygen_path ${pygenfile} PATH) file(MAKE_DIRECTORY ${pygen_path}) endforeach(pyfile) #the command to generate the pyc files add_custom_command( DEPENDS ${pysrcfiles} OUTPUT ${pycfiles} COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_BINARY_DIR}/python_compile_helper.py ${pysrcfiles} ${pycfiles} ) #the command to generate the pyo files add_custom_command( DEPENDS ${pysrcfiles} OUTPUT ${pyofiles} COMMAND ${PYTHON_EXECUTABLE} -O ${CMAKE_BINARY_DIR}/python_compile_helper.py ${pysrcfiles} ${pyofiles} ) #create install rule and add generated files to target list set(python_install_gen_targets ${pycfiles} ${pyofiles}) install(FILES ${python_install_gen_targets} DESTINATION ${GR_PYTHON_INSTALL_DESTINATION} COMPONENT ${GR_PYTHON_INSTALL_COMPONENT} ) #################################################################### elseif(GR_PYTHON_INSTALL_PROGRAMS) #################################################################### file(TO_NATIVE_PATH ${PYTHON_EXECUTABLE} pyexe_native) if (CMAKE_CROSSCOMPILING) set(pyexe_native /usr/bin/env python) endif() foreach(pyfile ${GR_PYTHON_INSTALL_PROGRAMS}) get_filename_component(pyfile_name ${pyfile} NAME) get_filename_component(pyfile ${pyfile} ABSOLUTE) string(REPLACE "${CMAKE_SOURCE_DIR}" "${CMAKE_BINARY_DIR}" pyexefile "${pyfile}.exe") list(APPEND python_install_gen_targets ${pyexefile}) get_filename_component(pyexefile_path ${pyexefile} PATH) file(MAKE_DIRECTORY ${pyexefile_path}) add_custom_command( OUTPUT ${pyexefile} DEPENDS ${pyfile} COMMAND ${PYTHON_EXECUTABLE} -c \"open('${pyexefile}', 'w').write('\#!${pyexe_native}\\n'+open('${pyfile}').read())\" COMMENT "Shebangin ${pyfile_name}" ) #on windows, python files need an extension to execute get_filename_component(pyfile_ext ${pyfile} EXT) if(WIN32 AND NOT pyfile_ext) set(pyfile_name "${pyfile_name}.py") endif() install(PROGRAMS ${pyexefile} RENAME ${pyfile_name} DESTINATION ${GR_PYTHON_INSTALL_DESTINATION} COMPONENT ${GR_PYTHON_INSTALL_COMPONENT} ) endforeach(pyfile) endif() GR_UNIQUE_TARGET("pygen" ${python_install_gen_targets}) endfunction(GR_PYTHON_INSTALL) ######################################################################## # Write the python helper script that generates byte code files ######################################################################## file(WRITE ${CMAKE_BINARY_DIR}/python_compile_helper.py " import sys, py_compile files = sys.argv[1:] srcs, gens = files[:len(files)/2], files[len(files)/2:] for src, gen in zip(srcs, gens): py_compile.compile(file=src, cfile=gen, doraise=True) ") gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/GrSwig.cmake000066400000000000000000000227771225753723100217420ustar00rootroot00000000000000# Copyright 2010-2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. if(DEFINED __INCLUDED_GR_SWIG_CMAKE) return() endif() set(__INCLUDED_GR_SWIG_CMAKE TRUE) include(GrPython) ######################################################################## # Builds a swig documentation file to be generated into python docstrings # Usage: GR_SWIG_MAKE_DOCS(output_file input_path input_path....) # # Set the following variable to specify extra dependent targets: # - GR_SWIG_DOCS_SOURCE_DEPS # - GR_SWIG_DOCS_TARGET_DEPS ######################################################################## function(GR_SWIG_MAKE_DOCS output_file) if(ENABLE_DOXYGEN) #setup the input files variable list, quote formated set(input_files) unset(INPUT_PATHS) foreach(input_path ${ARGN}) if (IS_DIRECTORY ${input_path}) #when input path is a directory file(GLOB input_path_h_files ${input_path}/*.h) else() #otherwise its just a file, no glob set(input_path_h_files ${input_path}) endif() list(APPEND input_files ${input_path_h_files}) set(INPUT_PATHS "${INPUT_PATHS} \"${input_path}\"") endforeach(input_path) #determine the output directory get_filename_component(name ${output_file} NAME_WE) get_filename_component(OUTPUT_DIRECTORY ${output_file} PATH) set(OUTPUT_DIRECTORY ${OUTPUT_DIRECTORY}/${name}_swig_docs) make_directory(${OUTPUT_DIRECTORY}) #generate the Doxyfile used by doxygen configure_file( ${CMAKE_SOURCE_DIR}/docs/doxygen/Doxyfile.swig_doc.in ${OUTPUT_DIRECTORY}/Doxyfile @ONLY) #Create a dummy custom command that depends on other targets include(GrMiscUtils) GR_GEN_TARGET_DEPS(_${name}_tag tag_deps ${GR_SWIG_DOCS_TARGET_DEPS}) #call doxygen on the Doxyfile + input headers add_custom_command( OUTPUT ${OUTPUT_DIRECTORY}/xml/index.xml DEPENDS ${input_files} ${GR_SWIG_DOCS_SOURCE_DEPS} ${tag_deps} COMMAND ${DOXYGEN_EXECUTABLE} ${OUTPUT_DIRECTORY}/Doxyfile COMMENT "Generating doxygen xml for ${name} docs" ) #call the swig_doc script on the xml files add_custom_command( OUTPUT ${output_file} DEPENDS ${input_files} ${stamp-file} ${OUTPUT_DIRECTORY}/xml/index.xml COMMAND ${PYTHON_EXECUTABLE} ${PYTHON_DASH_B} ${CMAKE_SOURCE_DIR}/docs/doxygen/swig_doc.py ${OUTPUT_DIRECTORY}/xml ${output_file} COMMENT "Generating python docstrings for ${name}" WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/docs/doxygen ) else(ENABLE_DOXYGEN) file(WRITE ${output_file} "\n") #no doxygen -> empty file endif(ENABLE_DOXYGEN) endfunction(GR_SWIG_MAKE_DOCS) ######################################################################## # Build a swig target for the common gnuradio use case. Usage: # GR_SWIG_MAKE(target ifile ifile ifile...) # # Set the following variables before calling: # - GR_SWIG_FLAGS # - GR_SWIG_INCLUDE_DIRS # - GR_SWIG_LIBRARIES # - GR_SWIG_SOURCE_DEPS # - GR_SWIG_TARGET_DEPS # - GR_SWIG_DOC_FILE # - GR_SWIG_DOC_DIRS ######################################################################## macro(GR_SWIG_MAKE name) set(ifiles ${ARGN}) # Shimming this in here to take care of a SWIG bug with handling # vector and vector (on 32-bit machines) and # vector (on 64-bit machines). Use this to test # the size of size_t, then set SIZE_T_32 if it's a 32-bit machine # or not if it's 64-bit. The logic in gr_type.i handles the rest. INCLUDE (CheckTypeSize) CHECK_TYPE_SIZE("size_t" SIZEOF_SIZE_T) CHECK_TYPE_SIZE("unsigned int" SIZEOF_UINT) if(${SIZEOF_SIZE_T} EQUAL ${SIZEOF_UINT}) list(APPEND GR_SWIG_FLAGS -DSIZE_T_32) endif(${SIZEOF_SIZE_T} EQUAL ${SIZEOF_UINT}) #do swig doc generation if specified if (GR_SWIG_DOC_FILE) set(GR_SWIG_DOCS_SOURCE_DEPS ${GR_SWIG_SOURCE_DEPS}) list(APPEND GR_SWIG_DOCS_TARGET_DEPS ${GR_SWIG_TARGET_DEPS}) GR_SWIG_MAKE_DOCS(${GR_SWIG_DOC_FILE} ${GR_SWIG_DOC_DIRS}) add_custom_target(${name}_swig_doc DEPENDS ${GR_SWIG_DOC_FILE}) list(APPEND GR_SWIG_TARGET_DEPS ${name}_swig_doc ${GR_RUNTIME_SWIG_DOC_FILE}) endif() #append additional include directories find_package(PythonLibs 2) list(APPEND GR_SWIG_INCLUDE_DIRS ${PYTHON_INCLUDE_PATH}) #deprecated name (now dirs) list(APPEND GR_SWIG_INCLUDE_DIRS ${PYTHON_INCLUDE_DIRS}) #prepend local swig directories list(INSERT GR_SWIG_INCLUDE_DIRS 0 ${CMAKE_CURRENT_SOURCE_DIR}) list(INSERT GR_SWIG_INCLUDE_DIRS 0 ${CMAKE_CURRENT_BINARY_DIR}) #determine include dependencies for swig file execute_process( COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_BINARY_DIR}/get_swig_deps.py "${ifiles}" "${GR_SWIG_INCLUDE_DIRS}" OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE SWIG_MODULE_${name}_EXTRA_DEPS WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} ) #Create a dummy custom command that depends on other targets include(GrMiscUtils) GR_GEN_TARGET_DEPS(_${name}_swig_tag tag_deps ${GR_SWIG_TARGET_DEPS}) set(tag_file ${CMAKE_CURRENT_BINARY_DIR}/${name}.tag) add_custom_command( OUTPUT ${tag_file} DEPENDS ${GR_SWIG_SOURCE_DEPS} ${tag_deps} COMMAND ${CMAKE_COMMAND} -E touch ${tag_file} ) #append the specified include directories include_directories(${GR_SWIG_INCLUDE_DIRS}) list(APPEND SWIG_MODULE_${name}_EXTRA_DEPS ${tag_file}) #setup the swig flags with flags and include directories set(CMAKE_SWIG_FLAGS -fvirtual -modern -keyword -w511 -module ${name} ${GR_SWIG_FLAGS}) foreach(dir ${GR_SWIG_INCLUDE_DIRS}) list(APPEND CMAKE_SWIG_FLAGS "-I${dir}") endforeach(dir) #set the C++ property on the swig .i file so it builds set_source_files_properties(${ifiles} PROPERTIES CPLUSPLUS ON) #setup the actual swig library target to be built include(UseSWIG) SWIG_ADD_MODULE(${name} python ${ifiles}) SWIG_LINK_LIBRARIES(${name} ${PYTHON_LIBRARIES} ${GR_SWIG_LIBRARIES}) endmacro(GR_SWIG_MAKE) ######################################################################## # Install swig targets generated by GR_SWIG_MAKE. Usage: # GR_SWIG_INSTALL( # TARGETS target target target... # [DESTINATION destination] # [COMPONENT component] # ) ######################################################################## macro(GR_SWIG_INSTALL) include(CMakeParseArgumentsCopy) CMAKE_PARSE_ARGUMENTS(GR_SWIG_INSTALL "" "DESTINATION;COMPONENT" "TARGETS" ${ARGN}) foreach(name ${GR_SWIG_INSTALL_TARGETS}) install(TARGETS ${SWIG_MODULE_${name}_REAL_NAME} DESTINATION ${GR_SWIG_INSTALL_DESTINATION} COMPONENT ${GR_SWIG_INSTALL_COMPONENT} ) include(GrPython) GR_PYTHON_INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/${name}.py DESTINATION ${GR_SWIG_INSTALL_DESTINATION} COMPONENT ${GR_SWIG_INSTALL_COMPONENT} ) GR_LIBTOOL( TARGET ${SWIG_MODULE_${name}_REAL_NAME} DESTINATION ${GR_SWIG_INSTALL_DESTINATION} ) endforeach(name) endmacro(GR_SWIG_INSTALL) ######################################################################## # Generate a python file that can determine swig dependencies. # Used by the make macro above to determine extra dependencies. # When you build C++, CMake figures out the header dependencies. # This code essentially performs that logic for swig includes. ######################################################################## file(WRITE ${CMAKE_BINARY_DIR}/get_swig_deps.py " import os, sys, re i_include_matcher = re.compile('%(include|import)\\s*[<|\"](.*)[>|\"]') h_include_matcher = re.compile('#(include)\\s*[<|\"](.*)[>|\"]') include_dirs = sys.argv[2].split(';') def get_swig_incs(file_path): if file_path.endswith('.i'): matcher = i_include_matcher else: matcher = h_include_matcher file_contents = open(file_path, 'r').read() return matcher.findall(file_contents, re.MULTILINE) def get_swig_deps(file_path, level): deps = [file_path] if level == 0: return deps for keyword, inc_file in get_swig_incs(file_path): for inc_dir in include_dirs: inc_path = os.path.join(inc_dir, inc_file) if not os.path.exists(inc_path): continue deps.extend(get_swig_deps(inc_path, level-1)) break #found, we dont search in lower prio inc dirs return deps if __name__ == '__main__': ifiles = sys.argv[1].split(';') deps = sum([get_swig_deps(ifile, 3) for ifile in ifiles], []) #sys.stderr.write(';'.join(set(deps)) + '\\n\\n') print(';'.join(set(deps))) ") gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/GrTest.cmake000066400000000000000000000132641225753723100217370ustar00rootroot00000000000000# Copyright 2010-2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. if(DEFINED __INCLUDED_GR_TEST_CMAKE) return() endif() set(__INCLUDED_GR_TEST_CMAKE TRUE) ######################################################################## # Add a unit test and setup the environment for a unit test. # Takes the same arguments as the ADD_TEST function. # # Before calling set the following variables: # GR_TEST_TARGET_DEPS - built targets for the library path # GR_TEST_LIBRARY_DIRS - directories for the library path # GR_TEST_PYTHON_DIRS - directories for the python path # GR_TEST_ENVIRONS - other environment key/value pairs ######################################################################## function(GR_ADD_TEST test_name) #Ensure that the build exe also appears in the PATH. list(APPEND GR_TEST_TARGET_DEPS ${ARGN}) #In the land of windows, all libraries must be in the PATH. #Since the dependent libraries are not yet installed, #we must manually set them in the PATH to run tests. #The following appends the path of a target dependency. foreach(target ${GR_TEST_TARGET_DEPS}) get_target_property(location ${target} LOCATION) if(location) get_filename_component(path ${location} PATH) string(REGEX REPLACE "\\$\\(.*\\)" ${CMAKE_BUILD_TYPE} path ${path}) list(APPEND GR_TEST_LIBRARY_DIRS ${path}) endif(location) endforeach(target) if(WIN32) #SWIG generates the python library files into a subdirectory. #Therefore, we must append this subdirectory into PYTHONPATH. #Only do this for the python directories matching the following: foreach(pydir ${GR_TEST_PYTHON_DIRS}) get_filename_component(name ${pydir} NAME) if(name MATCHES "^(swig|lib|src)$") list(APPEND GR_TEST_PYTHON_DIRS ${pydir}/${CMAKE_BUILD_TYPE}) endif() endforeach(pydir) endif(WIN32) file(TO_NATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR} srcdir) file(TO_NATIVE_PATH "${GR_TEST_LIBRARY_DIRS}" libpath) #ok to use on dir list? file(TO_NATIVE_PATH "${GR_TEST_PYTHON_DIRS}" pypath) #ok to use on dir list? set(environs "GR_DONT_LOAD_PREFS=1" "srcdir=${srcdir}") list(APPEND environs ${GR_TEST_ENVIRONS}) #http://www.cmake.org/pipermail/cmake/2009-May/029464.html #Replaced this add test + set environs code with the shell script generation. #Its nicer to be able to manually run the shell script to diagnose problems. #ADD_TEST(${ARGV}) #SET_TESTS_PROPERTIES(${test_name} PROPERTIES ENVIRONMENT "${environs}") if(UNIX) set(LD_PATH_VAR "LD_LIBRARY_PATH") if(APPLE) set(LD_PATH_VAR "DYLD_LIBRARY_PATH") endif() set(binpath "${CMAKE_CURRENT_BINARY_DIR}:$PATH") list(APPEND libpath "$${LD_PATH_VAR}") list(APPEND pypath "$PYTHONPATH") #replace list separator with the path separator string(REPLACE ";" ":" libpath "${libpath}") string(REPLACE ";" ":" pypath "${pypath}") list(APPEND environs "PATH=${binpath}" "${LD_PATH_VAR}=${libpath}" "PYTHONPATH=${pypath}") #generate a bat file that sets the environment and runs the test if (CMAKE_CROSSCOMPILING) set(SHELL "/bin/sh") else(CMAKE_CROSSCOMPILING) find_program(SHELL sh) endif(CMAKE_CROSSCOMPILING) set(sh_file ${CMAKE_CURRENT_BINARY_DIR}/${test_name}_test.sh) file(WRITE ${sh_file} "#!${SHELL}\n") #each line sets an environment variable foreach(environ ${environs}) file(APPEND ${sh_file} "export ${environ}\n") endforeach(environ) #load the command to run with its arguments foreach(arg ${ARGN}) file(APPEND ${sh_file} "${arg} ") endforeach(arg) file(APPEND ${sh_file} "\n") #make the shell file executable execute_process(COMMAND chmod +x ${sh_file}) add_test(${test_name} ${SHELL} ${sh_file}) endif(UNIX) if(WIN32) list(APPEND libpath ${DLL_PATHS} "%PATH%") list(APPEND pypath "%PYTHONPATH%") #replace list separator with the path separator (escaped) string(REPLACE ";" "\\;" libpath "${libpath}") string(REPLACE ";" "\\;" pypath "${pypath}") list(APPEND environs "PATH=${libpath}" "PYTHONPATH=${pypath}") #generate a bat file that sets the environment and runs the test set(bat_file ${CMAKE_CURRENT_BINARY_DIR}/${test_name}_test.bat) file(WRITE ${bat_file} "@echo off\n") #each line sets an environment variable foreach(environ ${environs}) file(APPEND ${bat_file} "SET ${environ}\n") endforeach(environ) #load the command to run with its arguments foreach(arg ${ARGN}) file(APPEND ${bat_file} "${arg} ") endforeach(arg) file(APPEND ${bat_file} "\n") add_test(${test_name} ${bat_file}) endif(WIN32) endfunction(GR_ADD_TEST) gr-osmosdr-0.1.0.55.80c4af/cmake/Modules/GrVersion.cmake000066400000000000000000000062311225753723100224410ustar00rootroot00000000000000# Copyright 2011,2013 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. if(DEFINED __INCLUDED_GR_VERSION_CMAKE) return() endif() set(__INCLUDED_GR_VERSION_CMAKE TRUE) #eventually, replace version.sh and fill in the variables below set(MAJOR_VERSION ${VERSION_INFO_MAJOR_VERSION}) set(API_COMPAT ${VERSION_INFO_API_COMPAT}) set(MINOR_VERSION ${VERSION_INFO_MINOR_VERSION}) set(MAINT_VERSION ${VERSION_INFO_MAINT_VERSION}) ######################################################################## # Extract the version string from git describe. ######################################################################## find_package(Git) if(GIT_FOUND AND EXISTS ${CMAKE_SOURCE_DIR}/.git) message(STATUS "Extracting version information from git describe...") execute_process( COMMAND ${GIT_EXECUTABLE} describe --always --abbrev=8 --long OUTPUT_VARIABLE GIT_DESCRIBE OUTPUT_STRIP_TRAILING_WHITESPACE WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} ) else() set(GIT_DESCRIBE "v${MAJOR_VERSION}.${API_COMPAT}.x-xxx-xunknown") endif() ######################################################################## # Use the logic below to set the version constants ######################################################################## if("${MINOR_VERSION}" STREQUAL "git") # VERSION: 3.3git-xxx-gxxxxxxxx # DOCVER: 3.3git # LIBVER: 3.3git set(VERSION "${GIT_DESCRIBE}") set(DOCVER "${MAJOR_VERSION}.${API_COMPAT}${MINOR_VERSION}") set(LIBVER "${MAJOR_VERSION}.${API_COMPAT}${MINOR_VERSION}") set(RC_MINOR_VERSION "0") set(RC_MAINT_VERSION "0") elseif("${MAINT_VERSION}" STREQUAL "git") # VERSION: 3.3.1git-xxx-gxxxxxxxx # DOCVER: 3.3.1git # LIBVER: 3.3.1git set(VERSION "${GIT_DESCRIBE}") set(DOCVER "${MAJOR_VERSION}.${API_COMPAT}.${MINOR_VERSION}${MAINT_VERSION}") set(LIBVER "${MAJOR_VERSION}.${API_COMPAT}.${MINOR_VERSION}${MAINT_VERSION}") math(EXPR RC_MINOR_VERSION "${MINOR_VERSION} - 1") set(RC_MAINT_VERSION "0") else() # This is a numbered release. # VERSION: 3.3.1{.x} # DOCVER: 3.3.1{.x} # LIBVER: 3.3.1{.x} if("${MAINT_VERSION}" STREQUAL "0") set(VERSION "${MAJOR_VERSION}.${API_COMPAT}.${MINOR_VERSION}") else() set(VERSION "${MAJOR_VERSION}.${API_COMPAT}.${MINOR_VERSION}.${MAINT_VERSION}") endif() set(DOCVER "${VERSION}") set(LIBVER "${VERSION}") set(RC_MINOR_VERSION ${MINOR_VERSION}) set(RC_MAINT_VERSION ${MAINT_VERSION}) endif() gr-osmosdr-0.1.0.55.80c4af/cmake/cmake_uninstall.cmake.in000066400000000000000000000025321225753723100226710ustar00rootroot00000000000000# http://www.vtk.org/Wiki/CMake_FAQ#Can_I_do_.22make_uninstall.22_with_CMake.3F IF(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(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) ELSEIF(IS_SYMLINK "$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(EXISTS "$ENV{DESTDIR}${file}") MESSAGE(STATUS "File \"$ENV{DESTDIR}${file}\" does not exist.") ENDIF(EXISTS "$ENV{DESTDIR}${file}") ENDFOREACH(file) gr-osmosdr-0.1.0.55.80c4af/docs/000077500000000000000000000000001225753723100157575ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/docs/CMakeLists.txt000066400000000000000000000022531225753723100205210ustar00rootroot00000000000000# Copyright 2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # Begin conditional configuration ######################################################################## if(ENABLE_DOXYGEN) ######################################################################## # Add subdirectories ######################################################################## add_subdirectory(doxygen) endif(ENABLE_DOXYGEN) gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/000077500000000000000000000000001225753723100174345ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/CMakeLists.txt000066400000000000000000000037351225753723100222040ustar00rootroot00000000000000# Copyright 2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # Create the doxygen configuration file ######################################################################## file(TO_NATIVE_PATH ${CMAKE_SOURCE_DIR} top_srcdir) file(TO_NATIVE_PATH ${CMAKE_BINARY_DIR} top_builddir) file(TO_NATIVE_PATH ${CMAKE_SOURCE_DIR} abs_top_srcdir) file(TO_NATIVE_PATH ${CMAKE_BINARY_DIR} abs_top_builddir) set(HAVE_DOT ${DOXYGEN_DOT_FOUND}) set(enable_html_docs YES) set(enable_latex_docs NO) set(enable_xml_docs YES) configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) set(BUILT_DIRS ${CMAKE_CURRENT_BINARY_DIR}/xml ${CMAKE_CURRENT_BINARY_DIR}/html) ######################################################################## # Make and install doxygen docs ######################################################################## add_custom_command( OUTPUT ${BUILT_DIRS} COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating documentation with doxygen" ) add_custom_target(doxygen_target ALL DEPENDS ${BUILT_DIRS}) install(DIRECTORY ${BUILT_DIRS} DESTINATION ${GR_PKG_DOC_DIR}) gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/Doxyfile.in000066400000000000000000001730171225753723100215600ustar00rootroot00000000000000# Doxyfile 1.5.7.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # # All text after a hash (#) is considered a comment and will be ignored # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = "GNU Radio's OsmoSDR Package" # 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 = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output # format and will distribute the generated files over these directories. # Enabling this option can be useful when feeding doxygen a huge amount of # source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, # Spanish, Swedish, and Ukrainian. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string # in this list, if found as the leading text of the brief description, will be # stripped from the text and the result after processing the whole list, is # used as the annotated text. Otherwise, the brief description is used as-is. # If left blank, the following values are used ("$name" is automatically # replaced with the name of the entity): "The $name class" "The $name widget" # "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = YES # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the # path to strip. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells # the reader which header file to include in order to use a class. # If left blank only the name of the header file containing the class # definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style # comment as the brief description. If set to NO, the comments # will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. # The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = YES # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 8 # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". # For example adding "sideeffect=\par Side Effects:\n" will allow you to # put the command \sideeffect (or @sideeffect) in the documentation, which # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. ALIASES = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for # Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. # Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate getter # and setter methods for a property. Setting this option to YES (the default) # will make doxygen to replace the get and set methods by a property in the # documentation. This will only work if the methods are indeed getting or # setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to # NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically # be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # determine which symbols to keep in memory and which to flush to disk. # When the cache is full, less often used symbols will be written to disk. # For small to medium size projects (<1000 input files) the default value is # probably good enough. For larger projects a too small cache size can cause # doxygen to be busy swapping symbols to and from disk most of the time # causing a significant performance penality. # If the system has enough physical memory increasing the cache will improve the # performance by keeping more symbols in memory. Note that the value works on # a logarithmic scale so increasing the size by one will rougly double the # memory usage. The cache size is given by this formula: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # corresponding to a cache size of 2^16 = 65536 symbols SYMBOL_CACHE_SIZE = 4 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in # the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = 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. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # will sort the (detailed) documentation of file and class members # alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically # by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, # not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = NO # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = NO # The GENERATE_BUGLIST tag can be used to enable (YES) or # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = NO # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= NO # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES # If the sources in your project are distributed over multiple directories # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. SHOW_DIRECTORIES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Namespaces page. This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = NO # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by # doxygen. The layout file controls the global structure of the generated output files # in an output format independent way. The create the layout file that represents # doxygen's defaults, run doxygen with the -l option. You can optionally specify a # file name after the option, if omitted DoxygenLayout.xml will be used as the name # of the layout file. LAYOUT_FILE = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be abled to get warnings for # functions that are documented, but have no documentation for their parameters # or return value. If set to NO (the default) doxygen will only warn about # wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = 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) WARN_FORMAT = "$file:$line: $text " # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be used to specify the files and/or directories that contain # documented source files. You may enter file names like "myfile.cpp" or # directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = @top_srcdir@ @top_builddir@ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # also the default input encoding. Doxygen uses libiconv (or the iconv built # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = *.h \ *.dox # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = @abs_top_builddir@/docs/doxygen/html \ @abs_top_builddir@/docs/doxygen/xml \ @abs_top_builddir@/docs/doxygen/other/doxypy.py \ @abs_top_builddir@/_CPack_Packages \ @abs_top_srcdir@/cmake # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. Note that the wildcards are matched # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = */.deps/* \ */.libs/* \ */.svn/* \ */CVS/* \ */__init__.py \ */qa_*.cc \ */qa_*.h \ */qa_*.py # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = ad9862 \ numpy \ *swig* \ *Swig* \ *my_top_block* \ *my_graph* \ *app_top_block* \ *am_rx_graph* \ *_queue_watcher_thread* \ *parse* \ *MyFrame* \ *MyApp* \ *PyObject* \ *wfm_rx_block* \ *_sptr* \ *debug* \ *wfm_rx_sca_block* \ *tv_rx_block* \ *wxapt_rx_block* \ *example_signal* # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command , 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. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. FILTER_PATTERNS = *.py=@top_srcdir@/gnuradio-runtime/doc/other/doxypy.py # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = NO # If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES # If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # link to the source code. Otherwise they will link to the documentstion. REFERENCES_LINK_SOURCE = YES # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen # built-in source browser. The htags tool is part of GNU's global source # tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = YES # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all # classes will be put under the same header in the alphabetical index. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = @enable_html_docs@ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a # standard header. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to # fine-tune the look of the HTML output. If the tag is left blank doxygen # will generate a default style sheet. Note that doxygen will try to copy # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. HTML_ALIGN_MEMBERS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). HTML_DYNAMIC_SECTIONS = NO # If the GENERATE_DOCSET tag is set to YES, additional index files # will be generated that can be used as input for Apple's Xcode 3 # integrated development environment, introduced with OSX 10.5 (Leopard). # To create a documentation set, doxygen will generate a Makefile in the # HTML output directory. Running make will produce the docset in that # directory and running "make install" will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # it at startup. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. GENERATE_DOCSET = NO # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the # feed. A documentation feed provides an umbrella under which multiple # documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that # should uniquely identify the documentation set bundle. This should be a # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be # written to the html output directory. CHM_FILE = # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # be used to specify the location (absolute path including file name) of # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. HHC_LOCATION = # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. CHM_INDEX_ENCODING = # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = YES # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER # are set, an additional index file will be generated that can be used as input for # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated # HTML documentation. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can # be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # Qt Help Project / Namespace. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # Qt Help Project / Virtual Folders. QHP_VIRTUAL_FOLDER = doc # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can # be used to specify the location of Qt's qhelpgenerator. # If non-empty doxygen will try to run qhelpgenerator on the generated # .qhp file . QHG_LOCATION = # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = YES # This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. # If the tag value is set to FRAME, 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 (for instance Mozilla 1.0+, # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are # probably better off using the HTML help feature. Other possible values # for this tag are: HIERARCHIES, which will generate the Groups, Directories, # and Class Hierarchy pages using a tree view instead of an ordered list; # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which # disables this behavior completely. For backwards compatibility with previous # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE # respectively. GENERATE_TREEVIEW = YES # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 180 # Use this tag to change the font size of Latex formulas included # as images in the HTML documentation. The default is 10. Note that # when you change the font size after a successful doxygen run you need # to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = @enable_latex_docs@ # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO # The PAPER_TYPE tag can be used to set the paper type that is used # by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = letter # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until # the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! LATEX_HEADER = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # is prepared for conversion to pdf (using ps2pdf). The pdf file will # contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = YES # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = NO # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # command to the generated LaTeX files. This will instruct LaTeX to keep # running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO # If LATEX_HIDE_INDICES is set to YES then doxygen will not # include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output # The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf # If the COMPACT_RTF tag is set to YES Doxygen generates more compact # RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # will contain hyperlink fields. The RTF file will # contain links (just like the HTML output) instead of page references. # This makes the output suitable for online browsing using WORD or other # programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's # config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO # The MAN_OUTPUT tag is used to specify where the man pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, # then it will generate one additional man file for each entity # documented in the real man page(s). These additional files # only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- # If the GENERATE_XML tag is set to YES Doxygen will # generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = @enable_xml_docs@ # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml # The XML_SCHEMA tag can be used to specify an XML schema, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_SCHEMA = # The XML_DTD tag can be used to specify an XML DTD, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_DTD = # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = NO #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will # generate an AutoGen Definitions (see autogen.sf.net) file # that captures the structure of the code including all # documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- # If the GENERATE_PERLMOD tag is set to YES Doxygen will # generate a Perl module file that captures the structure of # the code including all documentation. Note that this # feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO # If the PERLMOD_LATEX tag is set to YES Doxygen will generate # the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # nicely formatted so it can be parsed by a human reader. This is useful # if you want to understand what is going on. On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES # The names of the make variables in the generated doxyrules.make file # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = NO # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = NO # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by # the preprocessor. INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. INCLUDE_FILE_PATTERNS = # The PREDEFINED tag can be used to specify one or more macro names that # are defined before the preprocessor is started (similar to the -D option of # gcc). The argument of the tag is a list of macros of the form: name # or name=definition (no spaces). If the definition and the = are # omitted =1 is assumed. To prevent a macro definition from being # undefined via #undef or recursively expanded use the := operator # instead of the = operator. PREDEFINED = # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all function-like macros that are alone # on a line, have an all uppercase name, and do not end with a semicolon. Such # function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: # TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed # in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base # or super classes. Setting the tag to NO turns the diagrams off. Note that # this option is superseded by the HAVE_DOT option below. This is only a # fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the # documentation. The MSCGEN_PATH tag allows you to specify the directory where # the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. MSCGEN_PATH = # If set to YES, the inheritance and collaboration graphs will hide # inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = @HAVE_DOT@ # By default doxygen will write a font called FreeSans.ttf to the output # directory and reference it in all dot files that doxygen generates. This # font does not include all possible unicode characters however, so when you need # these (or just want a differently looking font) you can specify the font name # using DOT_FONTNAME. You need need to make sure dot is able to find the font, # which can be done by putting it in a standard location or by setting the # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory # containing the font. DOT_FONTNAME = FreeSans # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. DOT_FONTSIZE = 10 # By default doxygen will tell dot to use the output directory to look for the # FreeSans.ttf font (which doxygen will put there itself). If you specify a # different font using DOT_FONTNAME you can set the path where dot # can find it using this tag. DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = NO # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented # file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # HAVE_DOT tags are set to YES then doxygen will generate a graph for each # documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES # If the CALL_GRAPH and HAVE_DOT options are set to YES then # doxygen will generate a call dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = NO # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the # \dotfile command). DOTFILE_DIRS = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is # visualized by representing a node as a red box. Note that doxygen if the # number of direct children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable # from the root by following a path via at most 3 edges will be shown. Nodes # that lay further from the root node will be omitted. Note that setting this # option to 1 or 2 may greatly reduce the computation time needed for large # code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 0 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # background. This is disabled by default, because dot on Windows does not # seem to support this out of the box. Warning: Depending on the platform used, # enabling this option may lead to badly anti-aliased labels on the edges of # a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = YES # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES #--------------------------------------------------------------------------- # Configuration::additions related to the search engine #--------------------------------------------------------------------------- # The SEARCHENGINE tag specifies whether or not a search engine should be # used. If set to NO the values of all tags below this one will be ignored. SEARCHENGINE = NO gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/Doxyfile.swig_doc.in000066400000000000000000001736171225753723100233630ustar00rootroot00000000000000# Doxyfile 1.6.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # # All text after a hash (#) is considered a comment and will be ignored # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = @CPACK_PACKAGE_NAME@ # 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 = @CPACK_PACKAGE_VERSION@ # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = @OUTPUT_DIRECTORY@ # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output # format and will distribute the generated files over these directories. # Enabling this option can be useful when feeding doxygen a huge amount of # source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string # in this list, if found as the leading text of the brief description, will be # stripped from the text and the result after processing the whole list, is # used as the annotated text. Otherwise, the brief description is used as-is. # If left blank, the following values are used ("$name" is automatically # replaced with the name of the entity): "The $name class" "The $name widget" # "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = YES # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the # path to strip. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells # the reader which header file to include in order to use a class. # If left blank only the name of the header file containing the class # definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style # comment as the brief description. If set to NO, the comments # will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. # The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 8 # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". # For example adding "sideeffect=\par Side Effects:\n" will allow you to # put the command \sideeffect (or @sideeffect) in the documentation, which # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. ALIASES = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for # Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it parses. # With this tag you can assign which parser to use for a given extension. # Doxygen has a built-in mapping, but you can override or extend it using this tag. # The format is ext=language, where ext is a file extension, and language is one of # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. EXTENSION_MAPPING = # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. # Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate getter # and setter methods for a property. Setting this option to YES (the default) # will make doxygen to replace the get and set methods by a property in the # documentation. This will only work if the methods are indeed getting or # setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to # NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically # be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # determine which symbols to keep in memory and which to flush to disk. # When the cache is full, less often used symbols will be written to disk. # For small to medium size projects (<1000 input files) the default value is # probably good enough. For larger projects a too small cache size can cause # doxygen to be busy swapping symbols to and from disk most of the time # causing a significant performance penality. # If the system has enough physical memory increasing the cache will improve the # performance by keeping more symbols in memory. Note that the value works on # a logarithmic scale so increasing the size by one will rougly double the # memory usage. The cache size is given by this formula: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # corresponding to a cache size of 2^16 = 65536 symbols SYMBOL_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in # the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = 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. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # will sort the (detailed) documentation of file and class members # alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically # by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, # not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES # If the sources in your project are distributed over multiple directories # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. SHOW_DIRECTORIES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Namespaces page. # This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by # doxygen. The layout file controls the global structure of the generated output files # in an output format independent way. The create the layout file that represents # doxygen's defaults, run doxygen with the -l option. You can optionally specify a # file name after the option, if omitted DoxygenLayout.xml will be used as the name # of the layout file. LAYOUT_FILE = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be abled to get warnings for # functions that are documented, but have no documentation for their parameters # or return value. If set to NO (the default) doxygen will only warn about # wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = 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) WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be used to specify the files and/or directories that contain # documented source files. You may enter file names like "myfile.cpp" or # directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = @INPUT_PATHS@ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # also the default input encoding. Doxygen uses libiconv (or the iconv built # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = *.h # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. Note that the wildcards are matched # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command , 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. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. # Doxygen will compare the file name with each pattern and apply the # filter if there is a match. # The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = 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. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # link to the source code. # Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen # built-in source browser. The htags tool is part of GNU's global source # tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = NO # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all # classes will be put under the same header in the alphabetical index. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = NO # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a # standard header. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to # fine-tune the look of the HTML output. If the tag is left blank doxygen # will generate a default style sheet. Note that doxygen will try to copy # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. HTML_ALIGN_MEMBERS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). HTML_DYNAMIC_SECTIONS = NO # If the GENERATE_DOCSET tag is set to YES, additional index files # will be generated that can be used as input for Apple's Xcode 3 # integrated development environment, introduced with OSX 10.5 (Leopard). # To create a documentation set, doxygen will generate a Makefile in the # HTML output directory. Running make will produce the docset in that # directory and running "make install" will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # it at startup. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. GENERATE_DOCSET = NO # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the # feed. A documentation feed provides an umbrella under which multiple # documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that # should uniquely identify the documentation set bundle. This should be a # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be # written to the html output directory. CHM_FILE = # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # be used to specify the location (absolute path including file name) of # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. HHC_LOCATION = # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. CHM_INDEX_ENCODING = # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = 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. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can # be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace QHP_NAMESPACE = # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#virtual-folders QHP_VIRTUAL_FOLDER = doc # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. # For more information please see # http://doc.trolltech.com/qthelpproject.html#custom-filters QHP_CUST_FILTER_NAME = # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see # Qt Help Project / Custom Filters. 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. QHP_SECT_FILTER_ATTRS = # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can # be used to specify the location of Qt's qhelpgenerator. # If non-empty doxygen will try to run qhelpgenerator on the generated # .qhp file. QHG_LOCATION = # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO # This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. # If the tag value is set to YES, a side panel will be generated # containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). # Windows users are probably better off using the HTML help feature. GENERATE_TREEVIEW = NO # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, # and Class Hierarchy pages using a tree view instead of an ordered list. USE_INLINE_TREES = NO # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 # Use this tag to change the font size of Latex formulas included # as images in the HTML documentation. The default is 10. Note that # when you change the font size after a successful doxygen run you need # to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 # When the SEARCHENGINE tag is enable 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) or Qt help (GENERATE_QHP) # there is already a search function so this one should typically # be disabled. SEARCHENGINE = YES #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO # The PAPER_TYPE tag can be used to set the paper type that is used # by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until # the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! LATEX_HEADER = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # is prepared for conversion to pdf (using ps2pdf). The pdf file will # contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = YES # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = YES # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # command to the generated LaTeX files. This will instruct LaTeX to keep # running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO # If LATEX_HIDE_INDICES is set to YES then doxygen will not # include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. LATEX_SOURCE_CODE = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output # The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf # If the COMPACT_RTF tag is set to YES Doxygen generates more compact # RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # will contain hyperlink fields. The RTF file will # contain links (just like the HTML output) instead of page references. # This makes the output suitable for online browsing using WORD or other # programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's # config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO # The MAN_OUTPUT tag is used to specify where the man pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, # then it will generate one additional man file for each entity # documented in the real man page(s). These additional files # only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- # If the GENERATE_XML tag is set to YES Doxygen will # generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = YES # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml # The XML_SCHEMA tag can be used to specify an XML schema, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_SCHEMA = # The XML_DTD tag can be used to specify an XML DTD, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_DTD = # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will # generate an AutoGen Definitions (see autogen.sf.net) file # that captures the structure of the code including all # documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- # If the GENERATE_PERLMOD tag is set to YES Doxygen will # generate a Perl module file that captures the structure of # the code including all documentation. Note that this # feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO # If the PERLMOD_LATEX tag is set to YES Doxygen will generate # the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # nicely formatted so it can be parsed by a human reader. # This is useful # if you want to understand what is going on. # On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES # The names of the make variables in the generated doxyrules.make file # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = NO # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by # the preprocessor. INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. INCLUDE_FILE_PATTERNS = # The PREDEFINED tag can be used to specify one or more macro names that # are defined before the preprocessor is started (similar to the -D option of # gcc). The argument of the tag is a list of macros of the form: name # or name=definition (no spaces). If the definition and the = are # omitted =1 is assumed. To prevent a macro definition from being # undefined via #undef or recursively expanded use the := operator # instead of the = operator. PREDEFINED = # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all function-like macros that are alone # on a line, have an all uppercase name, and do not end with a semicolon. Such # function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: # # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: # # TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed # in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base # or super classes. Setting the tag to NO turns the diagrams off. Note that # this option is superseded by the HAVE_DOT option below. This is only a # fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the # documentation. The MSCGEN_PATH tag allows you to specify the directory where # the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. MSCGEN_PATH = # If set to YES, the inheritance and collaboration graphs will hide # inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = NO # By default doxygen will write a font called FreeSans.ttf to the output # directory and reference it in all dot files that doxygen generates. This # font does not include all possible unicode characters however, so when you need # these (or just want a differently looking font) you can specify the font name # using DOT_FONTNAME. You need need to make sure dot is able to find the font, # which can be done by putting it in a standard location or by setting the # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory # containing the font. DOT_FONTNAME = FreeSans # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. DOT_FONTSIZE = 10 # By default doxygen will tell dot to use the output directory to look for the # FreeSans.ttf font (which doxygen will put there itself). If you specify a # different font using DOT_FONTNAME you can set the path where dot # can find it using this tag. DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented # file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # HAVE_DOT tags are set to YES then doxygen will generate a graph for each # documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES # If the CALL_GRAPH and HAVE_DOT options are set to YES then # doxygen will generate a call dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = NO # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the # \dotfile command). DOTFILE_DIRS = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is # visualized by representing a node as a red box. Note that doxygen if the # number of direct children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable # from the root by following a path via at most 3 edges will be shown. Nodes # that lay further from the root node will be omitted. Note that setting this # option to 1 or 2 may greatly reduce the computation time needed for large # code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 0 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # background. This is disabled by default, because dot on Windows does not # seem to support this out of the box. Warning: Depending on the platform used, # enabling this option may lead to badly anti-aliased labels on the edges of # a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = YES # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/000077500000000000000000000000001225753723100211405ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/__init__.py000066400000000000000000000046521225753723100232600ustar00rootroot00000000000000# # Copyright 2010 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. # """ Python interface to contents of doxygen xml documentation. Example use: See the contents of the example folder for the C++ and doxygen-generated xml used in this example. >>> # Parse the doxygen docs. >>> import os >>> this_dir = os.path.dirname(globals()['__file__']) >>> xml_path = this_dir + "/example/xml/" >>> di = DoxyIndex(xml_path) Get a list of all top-level objects. >>> print([mem.name() for mem in di.members()]) [u'Aadvark', u'aadvarky_enough', u'main'] Get all functions. >>> print([mem.name() for mem in di.in_category(DoxyFunction)]) [u'aadvarky_enough', u'main'] Check if an object is present. >>> di.has_member(u'Aadvark') True >>> di.has_member(u'Fish') False Get an item by name and check its properties. >>> aad = di.get_member(u'Aadvark') >>> print(aad.brief_description) Models the mammal Aadvark. >>> print(aad.detailed_description) Sadly the model is incomplete and cannot capture all aspects of an aadvark yet. This line is uninformative and is only to test line breaks in the comments. >>> [mem.name() for mem in aad.members()] [u'aadvarkness', u'print', u'Aadvark', u'get_aadvarkness'] >>> aad.get_member(u'print').brief_description u'Outputs the vital aadvark statistics.' """ from doxyindex import DoxyIndex, DoxyFunction, DoxyParam, DoxyClass, DoxyFile, DoxyNamespace, DoxyGroup, DoxyFriend, DoxyOther def _test(): import os this_dir = os.path.dirname(globals()['__file__']) xml_path = this_dir + "/example/xml/" di = DoxyIndex(xml_path) # Get the Aadvark class aad = di.get_member('Aadvark') aad.brief_description import doctest return doctest.testmod() if __name__ == "__main__": _test() gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/base.py000066400000000000000000000152121225753723100224250ustar00rootroot00000000000000# # Copyright 2010 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. # """ A base class is created. Classes based upon this are used to make more user-friendly interfaces to the doxygen xml docs than the generated classes provide. """ import os import pdb from xml.parsers.expat import ExpatError from generated import compound class Base(object): class Duplicate(StandardError): pass class NoSuchMember(StandardError): pass class ParsingError(StandardError): pass def __init__(self, parse_data, top=None): self._parsed = False self._error = False self._parse_data = parse_data self._members = [] self._dict_members = {} self._in_category = {} self._data = {} if top is not None: self._xml_path = top._xml_path # Set up holder of references else: top = self self._refs = {} self._xml_path = parse_data self.top = top @classmethod def from_refid(cls, refid, top=None): """ Instantiate class from a refid rather than parsing object. """ # First check to see if its already been instantiated. if top is not None and refid in top._refs: return top._refs[refid] # Otherwise create a new instance and set refid. inst = cls(None, top=top) inst.refid = refid inst.add_ref(inst) return inst @classmethod def from_parse_data(cls, parse_data, top=None): refid = getattr(parse_data, 'refid', None) if refid is not None and top is not None and refid in top._refs: return top._refs[refid] inst = cls(parse_data, top=top) if refid is not None: inst.refid = refid inst.add_ref(inst) return inst def add_ref(self, obj): if hasattr(obj, 'refid'): self.top._refs[obj.refid] = obj mem_classes = [] def get_cls(self, mem): for cls in self.mem_classes: if cls.can_parse(mem): return cls raise StandardError(("Did not find a class for object '%s'." \ % (mem.get_name()))) def convert_mem(self, mem): try: cls = self.get_cls(mem) converted = cls.from_parse_data(mem, self.top) if converted is None: raise StandardError('No class matched this object.') self.add_ref(converted) return converted except StandardError, e: print e @classmethod def includes(cls, inst): return isinstance(inst, cls) @classmethod def can_parse(cls, obj): return False def _parse(self): self._parsed = True def _get_dict_members(self, cat=None): """ For given category a dictionary is returned mapping member names to members of that category. For names that are duplicated the name is mapped to None. """ self.confirm_no_error() if cat not in self._dict_members: new_dict = {} for mem in self.in_category(cat): if mem.name() not in new_dict: new_dict[mem.name()] = mem else: new_dict[mem.name()] = self.Duplicate self._dict_members[cat] = new_dict return self._dict_members[cat] def in_category(self, cat): self.confirm_no_error() if cat is None: return self._members if cat not in self._in_category: self._in_category[cat] = [mem for mem in self._members if cat.includes(mem)] return self._in_category[cat] def get_member(self, name, cat=None): self.confirm_no_error() # Check if it's in a namespace or class. bits = name.split('::') first = bits[0] rest = '::'.join(bits[1:]) member = self._get_dict_members(cat).get(first, self.NoSuchMember) # Raise any errors that are returned. if member in set([self.NoSuchMember, self.Duplicate]): raise member() if rest: return member.get_member(rest, cat=cat) return member def has_member(self, name, cat=None): try: mem = self.get_member(name, cat=cat) return True except self.NoSuchMember: return False def data(self): self.confirm_no_error() return self._data def members(self): self.confirm_no_error() return self._members def process_memberdefs(self): mdtss = [] for sec in self._retrieved_data.compounddef.sectiondef: mdtss += sec.memberdef # At the moment we lose all information associated with sections. # Sometimes a memberdef is in several sectiondef. # We make sure we don't get duplicates here. uniques = set([]) for mem in mdtss: converted = self.convert_mem(mem) pair = (mem.name, mem.__class__) if pair not in uniques: uniques.add(pair) self._members.append(converted) def retrieve_data(self): filename = os.path.join(self._xml_path, self.refid + '.xml') try: self._retrieved_data = compound.parse(filename) except ExpatError: print('Error in xml in file %s' % filename) self._error = True self._retrieved_data = None def check_parsed(self): if not self._parsed: self._parse() def confirm_no_error(self): self.check_parsed() if self._error: raise self.ParsingError() def error(self): self.check_parsed() return self._error def name(self): # first see if we can do it without processing. if self._parse_data is not None: return self._parse_data.name self.check_parsed() return self._retrieved_data.compounddef.name gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/doxyindex.py000066400000000000000000000146271225753723100235370ustar00rootroot00000000000000# # Copyright 2010 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. # """ Classes providing more user-friendly interfaces to the doxygen xml docs than the generated classes provide. """ import os from generated import index from base import Base from text import description class DoxyIndex(Base): """ Parses a doxygen xml directory. """ __module__ = "gnuradio.utils.doxyxml" def _parse(self): if self._parsed: return super(DoxyIndex, self)._parse() self._root = index.parse(os.path.join(self._xml_path, 'index.xml')) for mem in self._root.compound: converted = self.convert_mem(mem) # For files we want the contents to be accessible directly # from the parent rather than having to go through the file # object. if self.get_cls(mem) == DoxyFile: if mem.name.endswith('.h'): self._members += converted.members() self._members.append(converted) else: self._members.append(converted) def generate_swig_doc_i(self): """ %feature("docstring") gr_make_align_on_samplenumbers_ss::align_state " Wraps the C++: gr_align_on_samplenumbers_ss::align_state"; """ pass class DoxyCompMem(Base): kind = None def __init__(self, *args, **kwargs): super(DoxyCompMem, self).__init__(*args, **kwargs) @classmethod def can_parse(cls, obj): return obj.kind == cls.kind def set_descriptions(self, parse_data): bd = description(getattr(parse_data, 'briefdescription', None)) dd = description(getattr(parse_data, 'detaileddescription', None)) self._data['brief_description'] = bd self._data['detailed_description'] = dd class DoxyCompound(DoxyCompMem): pass class DoxyMember(DoxyCompMem): pass class DoxyFunction(DoxyMember): __module__ = "gnuradio.utils.doxyxml" kind = 'function' def _parse(self): if self._parsed: return super(DoxyFunction, self)._parse() self.set_descriptions(self._parse_data) self._data['params'] = [] prms = self._parse_data.param for prm in prms: self._data['params'].append(DoxyParam(prm)) brief_description = property(lambda self: self.data()['brief_description']) detailed_description = property(lambda self: self.data()['detailed_description']) params = property(lambda self: self.data()['params']) Base.mem_classes.append(DoxyFunction) class DoxyParam(DoxyMember): __module__ = "gnuradio.utils.doxyxml" def _parse(self): if self._parsed: return super(DoxyParam, self)._parse() self.set_descriptions(self._parse_data) self._data['declname'] = self._parse_data.declname brief_description = property(lambda self: self.data()['brief_description']) detailed_description = property(lambda self: self.data()['detailed_description']) declname = property(lambda self: self.data()['declname']) class DoxyClass(DoxyCompound): __module__ = "gnuradio.utils.doxyxml" kind = 'class' def _parse(self): if self._parsed: return super(DoxyClass, self)._parse() self.retrieve_data() if self._error: return self.set_descriptions(self._retrieved_data.compounddef) # Sectiondef.kind tells about whether private or public. # We just ignore this for now. self.process_memberdefs() brief_description = property(lambda self: self.data()['brief_description']) detailed_description = property(lambda self: self.data()['detailed_description']) Base.mem_classes.append(DoxyClass) class DoxyFile(DoxyCompound): __module__ = "gnuradio.utils.doxyxml" kind = 'file' def _parse(self): if self._parsed: return super(DoxyFile, self)._parse() self.retrieve_data() self.set_descriptions(self._retrieved_data.compounddef) if self._error: return self.process_memberdefs() brief_description = property(lambda self: self.data()['brief_description']) detailed_description = property(lambda self: self.data()['detailed_description']) Base.mem_classes.append(DoxyFile) class DoxyNamespace(DoxyCompound): __module__ = "gnuradio.utils.doxyxml" kind = 'namespace' Base.mem_classes.append(DoxyNamespace) class DoxyGroup(DoxyCompound): __module__ = "gnuradio.utils.doxyxml" kind = 'group' def _parse(self): if self._parsed: return super(DoxyGroup, self)._parse() self.retrieve_data() if self._error: return cdef = self._retrieved_data.compounddef self._data['title'] = description(cdef.title) # Process inner groups grps = cdef.innergroup for grp in grps: converted = DoxyGroup.from_refid(grp.refid, top=self.top) self._members.append(converted) # Process inner classes klasses = cdef.innerclass for kls in klasses: converted = DoxyClass.from_refid(kls.refid, top=self.top) self._members.append(converted) # Process normal members self.process_memberdefs() title = property(lambda self: self.data()['title']) Base.mem_classes.append(DoxyGroup) class DoxyFriend(DoxyMember): __module__ = "gnuradio.utils.doxyxml" kind = 'friend' Base.mem_classes.append(DoxyFriend) class DoxyOther(Base): __module__ = "gnuradio.utils.doxyxml" kinds = set(['variable', 'struct', 'union', 'define', 'typedef', 'enum', 'dir', 'page']) @classmethod def can_parse(cls, obj): return obj.kind in cls.kinds Base.mem_classes.append(DoxyOther) gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/000077500000000000000000000000001225753723100225735ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/Doxyfile000066400000000000000000001775601225753723100243210ustar00rootroot00000000000000# Doxyfile 1.6.3 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # # All text after a hash (#) is considered a comment and will be ignored # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = # 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 = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output # format and will distribute the generated files over these directories. # Enabling this option can be useful when feeding doxygen a huge amount of # source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string # in this list, if found as the leading text of the brief description, will be # stripped from the text and the result after processing the whole list, is # used as the annotated text. Otherwise, the brief description is used as-is. # If left blank, the following values are used ("$name" is automatically # replaced with the name of the entity): "The $name class" "The $name widget" # "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = YES # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the # path to strip. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells # the reader which header file to include in order to use a class. # If left blank only the name of the header file containing the class # definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style # comment as the brief description. If set to NO, the comments # will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. # The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 8 # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". # For example adding "sideeffect=\par Side Effects:\n" will allow you to # put the command \sideeffect (or @sideeffect) in the documentation, which # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. ALIASES = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for # Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it parses. # With this tag you can assign which parser to use for a given extension. # Doxygen has a built-in mapping, but you can override or extend it using this tag. # The format is ext=language, where ext is a file extension, and language is one of # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. EXTENSION_MAPPING = # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. # Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate getter # and setter methods for a property. Setting this option to YES (the default) # will make doxygen to replace the get and set methods by a property in the # documentation. This will only work if the methods are indeed getting or # setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to # NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically # be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # determine which symbols to keep in memory and which to flush to disk. # When the cache is full, less often used symbols will be written to disk. # For small to medium size projects (<1000 input files) the default value is # probably good enough. For larger projects a too small cache size can cause # doxygen to be busy swapping symbols to and from disk most of the time # causing a significant performance penality. # If the system has enough physical memory increasing the cache will improve the # performance by keeping more symbols in memory. Note that the value works on # a logarithmic scale so increasing the size by one will rougly double the # memory usage. The cache size is given by this formula: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # corresponding to a cache size of 2^16 = 65536 symbols SYMBOL_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in # the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = 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. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen # will list include files with double quotes in the documentation # rather than with sharp brackets. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # will sort the (detailed) documentation of file and class members # alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically # by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, # not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES # If the sources in your project are distributed over multiple directories # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. SHOW_DIRECTORIES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Namespaces page. # This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by # doxygen. The layout file controls the global structure of the generated output files # in an output format independent way. The create the layout file that represents # doxygen's defaults, run doxygen with the -l option. You can optionally specify a # file name after the option, if omitted DoxygenLayout.xml will be used as the name # of the layout file. LAYOUT_FILE = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be abled to get warnings for # functions that are documented, but have no documentation for their parameters # or return value. If set to NO (the default) doxygen will only warn about # wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = 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) WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be used to specify the files and/or directories that contain # documented source files. You may enter file names like "myfile.cpp" or # directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # also the default input encoding. Doxygen uses libiconv (or the iconv built # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. Note that the wildcards are matched # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command , 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. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. # Doxygen will compare the file name with each pattern and apply the # filter if there is a match. # The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = 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. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # link to the source code. # Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen # built-in source browser. The htags tool is part of GNU's global source # tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = NO # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all # classes will be put under the same header in the alphabetical index. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a # standard header. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to # fine-tune the look of the HTML output. If the tag is left blank doxygen # will generate a default style sheet. Note that doxygen will try to copy # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting # this to NO can help when comparing the output of multiple runs. HTML_TIMESTAMP = YES # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. HTML_ALIGN_MEMBERS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). HTML_DYNAMIC_SECTIONS = NO # If the GENERATE_DOCSET tag is set to YES, additional index files # will be generated that can be used as input for Apple's Xcode 3 # integrated development environment, introduced with OSX 10.5 (Leopard). # To create a documentation set, doxygen will generate a Makefile in the # HTML output directory. Running make will produce the docset in that # directory and running "make install" will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # it at startup. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. GENERATE_DOCSET = NO # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the # feed. A documentation feed provides an umbrella under which multiple # documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that # should uniquely identify the documentation set bundle. This should be a # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be # written to the html output directory. CHM_FILE = # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # be used to specify the location (absolute path including file name) of # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. HHC_LOCATION = # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. CHM_INDEX_ENCODING = # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = 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. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can # be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#virtual-folders QHP_VIRTUAL_FOLDER = doc # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. # For more information please see # http://doc.trolltech.com/qthelpproject.html#custom-filters QHP_CUST_FILTER_NAME = # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see # Qt Help Project / Custom Filters. 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. QHP_SECT_FILTER_ATTRS = # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can # be used to specify the location of Qt's qhelpgenerator. # If non-empty doxygen will try to run qhelpgenerator on the generated # .qhp file. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files # will be generated, which together with the HTML files, form an Eclipse help # plugin. To install this plugin and make it available under the help contents # menu in Eclipse, the contents of the directory containing the HTML and XML # files needs to be copied into the plugins directory of eclipse. The name of # the directory within the plugins directory should be the same as # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears. GENERATE_ECLIPSEHELP = NO # A unique identifier for the eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have # this name. ECLIPSE_DOC_ID = org.doxygen.Project # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO # This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. # If the tag value is set to YES, a side panel will be generated # containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). # Windows users are probably better off using the HTML help feature. GENERATE_TREEVIEW = NO # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, # and Class Hierarchy pages using a tree view instead of an ordered list. USE_INLINE_TREES = NO # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 # Use this tag to change the font size of Latex formulas included # as images in the HTML documentation. The default is 10. Note that # when you change the font size after a successful doxygen run you need # to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should # typically be disabled. For large projects the javascript based search engine # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index # file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup # and does not have live searching capabilities. SERVER_BASED_SEARCH = NO #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = YES # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. # Note that when enabling USE_PDFLATEX this option is only used for # generating bitmaps for formulas in the HTML output, but not in the # Makefile that is written to the output directory. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO # The PAPER_TYPE tag can be used to set the paper type that is used # by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until # the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! LATEX_HEADER = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # is prepared for conversion to pdf (using ps2pdf). The pdf file will # contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = YES # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = YES # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # command to the generated LaTeX files. This will instruct LaTeX to keep # running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO # If LATEX_HIDE_INDICES is set to YES then doxygen will not # include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. LATEX_SOURCE_CODE = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output # The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf # If the COMPACT_RTF tag is set to YES Doxygen generates more compact # RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # will contain hyperlink fields. The RTF file will # contain links (just like the HTML output) instead of page references. # This makes the output suitable for online browsing using WORD or other # programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's # config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO # The MAN_OUTPUT tag is used to specify where the man pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, # then it will generate one additional man file for each entity # documented in the real man page(s). These additional files # only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- # If the GENERATE_XML tag is set to YES Doxygen will # generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = YES # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml # The XML_SCHEMA tag can be used to specify an XML schema, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_SCHEMA = # The XML_DTD tag can be used to specify an XML DTD, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_DTD = # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will # generate an AutoGen Definitions (see autogen.sf.net) file # that captures the structure of the code including all # documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- # If the GENERATE_PERLMOD tag is set to YES Doxygen will # generate a Perl module file that captures the structure of # the code including all documentation. Note that this # feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO # If the PERLMOD_LATEX tag is set to YES Doxygen will generate # the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # nicely formatted so it can be parsed by a human reader. # This is useful # if you want to understand what is going on. # On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES # The names of the make variables in the generated doxyrules.make file # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = NO # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = NO # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by # the preprocessor. INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. INCLUDE_FILE_PATTERNS = # The PREDEFINED tag can be used to specify one or more macro names that # are defined before the preprocessor is started (similar to the -D option of # gcc). The argument of the tag is a list of macros of the form: name # or name=definition (no spaces). If the definition and the = are # omitted =1 is assumed. To prevent a macro definition from being # undefined via #undef or recursively expanded use the := operator # instead of the = operator. PREDEFINED = # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all function-like macros that are alone # on a line, have an all uppercase name, and do not end with a semicolon. Such # function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: # # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: # # TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed # in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base # or super classes. Setting the tag to NO turns the diagrams off. Note that # this option is superseded by the HAVE_DOT option below. This is only a # fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the # documentation. The MSCGEN_PATH tag allows you to specify the directory where # the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. MSCGEN_PATH = # If set to YES, the inheritance and collaboration graphs will hide # inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = NO # By default doxygen will write a font called FreeSans.ttf to the output # directory and reference it in all dot files that doxygen generates. This # font does not include all possible unicode characters however, so when you need # these (or just want a differently looking font) you can specify the font name # using DOT_FONTNAME. You need need to make sure dot is able to find the font, # which can be done by putting it in a standard location or by setting the # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory # containing the font. DOT_FONTNAME = FreeSans # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. DOT_FONTSIZE = 10 # By default doxygen will tell dot to use the output directory to look for the # FreeSans.ttf font (which doxygen will put there itself). If you specify a # different font using DOT_FONTNAME you can set the path where dot # can find it using this tag. DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented # file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # HAVE_DOT tags are set to YES then doxygen will generate a graph for each # documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES # If the CALL_GRAPH and HAVE_DOT options are set to YES then # doxygen will generate a call dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = NO # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the # \dotfile command). DOTFILE_DIRS = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is # visualized by representing a node as a red box. Note that doxygen if the # number of direct children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable # from the root by following a path via at most 3 edges will be shown. Nodes # that lay further from the root node will be omitted. Note that setting this # option to 1 or 2 may greatly reduce the computation time needed for large # code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 0 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # background. This is disabled by default, because dot on Windows does not # seem to support this out of the box. Warning: Depending on the platform used, # enabling this option may lead to badly anti-aliased labels on the edges of # a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = YES # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/aadvark.cc000066400000000000000000000025761225753723100245250ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2010 Free Software Foundation, Inc. * * This file is part of GNU Radio * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #include #include "aadvark.h" void Aadvark::print() { std::cout << "aadvark is " << aadvarkness << "/10 aadvarky" << std::endl; } Aadvark::Aadvark(int aaness): aadvarkness(aaness) {} bool aadvarky_enough(Aadvark aad) { if (aad.get_aadvarkness() > 6) return true; else return false; } int Aadvark::get_aadvarkness() { return aadvarkness; } int main() { Aadvark arold = Aadvark(6); arold.print(); if (aadvarky_enough(arold)) std::cout << "He is aadvarky enough" << std::endl; else std::cout << "He is not aadvarky enough" << std::endl; } gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/aadvark.h000066400000000000000000000025201225753723100243540ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2010 Free Software Foundation, Inc. * * This file is part of GNU Radio * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #include /*! * \brief Models the mammal Aadvark. * * Sadly the model is incomplete and cannot capture all aspects of an aadvark yet. * * This line is uninformative and is only to test line breaks in the comments. */ class Aadvark { public: //! \brief Outputs the vital aadvark statistics. void print(); //! \param aaness The aadvarkness of an aadvark is a measure of how aadvarky it is. Aadvark(int aaness); int get_aadvarkness(); private: int aadvarkness; }; bool aadvarky_enough(Aadvark aad); int main(); gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/xml/000077500000000000000000000000001225753723100233735ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/xml/aadvark_8cc.xml000066400000000000000000000174611225753723100262740ustar00rootroot00000000000000 aadvark.cc iostream aadvark.h aadvark.cc bool bool aadvarky_enough (Aadvark aad) aadvarky_enough Aadvark aad int int main () main #include<iostream> #include"aadvark.h" voidAadvark::print(){ std::cout<<"aadvarkis"<<aadvarkness<<"/10aadvarky"<<std::endl; } Aadvark::Aadvark(intaaness):aadvarkness(aaness){} boolaadvarky_enough(Aadvarkaad){ if(aad.get_aadvarkness()>6) returntrue; else returnfalse; } intAadvark::get_aadvarkness(){ returnaadvarkness; } intmain(){ Aadvarkarold=Aadvark(6); arold.print(); if(aadvarky_enough(arold)) std::cout<<"Heisaadvarkyenough"<<std::endl; else std::cout<<"Heisnotaadvarkyenough"<<std::endl; } gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/xml/aadvark_8h.xml000066400000000000000000000117011225753723100261250ustar00rootroot00000000000000 aadvark.h iostream Aadvark bool bool aadvarky_enough (Aadvark aad) aadvarky_enough Aadvark aad int int main () main #include<iostream> classAadvark{ public: voidprint(); Aadvark(intaaness); intget_aadvarkness(); private: intaadvarkness; }; boolaadvarky_enough(Aadvarkaad); intmain(); gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/xml/classAadvark.xml000066400000000000000000000121371225753723100265200ustar00rootroot00000000000000 Aadvark aadvark.h int int Aadvark::aadvarkness aadvarkness void void Aadvark::print () print Outputs the vital aadvark statistics. Aadvark::Aadvark (int aaness) Aadvark int aaness aaness The aadvarkness of an aadvark is a measure of how aadvarky it is. int int Aadvark::get_aadvarkness () get_aadvarkness Models the mammal Aadvark. Sadly the model is incomplete and cannot capture all aspects of an aadvark yet.This line is uninformative and is only to test line breaks in the comments. AadvarkAadvark Aadvarkaadvarkness Aadvarkget_aadvarkness Aadvarkprint gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/xml/combine.xslt000066400000000000000000000012051225753723100257210ustar00rootroot00000000000000 gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/xml/compound.xsd000066400000000000000000001020161225753723100257370ustar00rootroot00000000000000 gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/xml/index.xml000066400000000000000000000025271225753723100252320ustar00rootroot00000000000000 Aadvark aadvarkness print Aadvark get_aadvarkness aadvark.cc aadvarky_enough main aadvark.h aadvarky_enough main gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/example/xml/index.xsd000066400000000000000000000045211225753723100252240ustar00rootroot00000000000000 gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/generated/000077500000000000000000000000001225753723100230765ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/generated/__init__.py000066400000000000000000000003531225753723100252100ustar00rootroot00000000000000""" Contains generated files produced by generateDS.py. These do the real work of parsing the doxygen xml files but the resultant classes are not very friendly to navigate so the rest of the doxyxml module processes them further. """ gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/generated/compound.py000066400000000000000000000475101225753723100253030ustar00rootroot00000000000000#!/usr/bin/env python """ Generated Mon Feb 9 19:08:05 2009 by generateDS.py. """ from string import lower as str_lower from xml.dom import minidom from xml.dom import Node import sys import compoundsuper as supermod from compoundsuper import MixedContainer class DoxygenTypeSub(supermod.DoxygenType): def __init__(self, version=None, compounddef=None): supermod.DoxygenType.__init__(self, version, compounddef) def find(self, details): return self.compounddef.find(details) supermod.DoxygenType.subclass = DoxygenTypeSub # end class DoxygenTypeSub class compounddefTypeSub(supermod.compounddefType): def __init__(self, kind=None, prot=None, id=None, compoundname='', title='', basecompoundref=None, derivedcompoundref=None, includes=None, includedby=None, incdepgraph=None, invincdepgraph=None, innerdir=None, innerfile=None, innerclass=None, innernamespace=None, innerpage=None, innergroup=None, templateparamlist=None, sectiondef=None, briefdescription=None, detaileddescription=None, inheritancegraph=None, collaborationgraph=None, programlisting=None, location=None, listofallmembers=None): supermod.compounddefType.__init__(self, kind, prot, id, compoundname, title, basecompoundref, derivedcompoundref, includes, includedby, incdepgraph, invincdepgraph, innerdir, innerfile, innerclass, innernamespace, innerpage, innergroup, templateparamlist, sectiondef, briefdescription, detaileddescription, inheritancegraph, collaborationgraph, programlisting, location, listofallmembers) def find(self, details): if self.id == details.refid: return self for sectiondef in self.sectiondef: result = sectiondef.find(details) if result: return result supermod.compounddefType.subclass = compounddefTypeSub # end class compounddefTypeSub class listofallmembersTypeSub(supermod.listofallmembersType): def __init__(self, member=None): supermod.listofallmembersType.__init__(self, member) supermod.listofallmembersType.subclass = listofallmembersTypeSub # end class listofallmembersTypeSub class memberRefTypeSub(supermod.memberRefType): def __init__(self, virt=None, prot=None, refid=None, ambiguityscope=None, scope='', name=''): supermod.memberRefType.__init__(self, virt, prot, refid, ambiguityscope, scope, name) supermod.memberRefType.subclass = memberRefTypeSub # end class memberRefTypeSub class compoundRefTypeSub(supermod.compoundRefType): def __init__(self, virt=None, prot=None, refid=None, valueOf_='', mixedclass_=None, content_=None): supermod.compoundRefType.__init__(self, mixedclass_, content_) supermod.compoundRefType.subclass = compoundRefTypeSub # end class compoundRefTypeSub class reimplementTypeSub(supermod.reimplementType): def __init__(self, refid=None, valueOf_='', mixedclass_=None, content_=None): supermod.reimplementType.__init__(self, mixedclass_, content_) supermod.reimplementType.subclass = reimplementTypeSub # end class reimplementTypeSub class incTypeSub(supermod.incType): def __init__(self, local=None, refid=None, valueOf_='', mixedclass_=None, content_=None): supermod.incType.__init__(self, mixedclass_, content_) supermod.incType.subclass = incTypeSub # end class incTypeSub class refTypeSub(supermod.refType): def __init__(self, prot=None, refid=None, valueOf_='', mixedclass_=None, content_=None): supermod.refType.__init__(self, mixedclass_, content_) supermod.refType.subclass = refTypeSub # end class refTypeSub class refTextTypeSub(supermod.refTextType): def __init__(self, refid=None, kindref=None, external=None, valueOf_='', mixedclass_=None, content_=None): supermod.refTextType.__init__(self, mixedclass_, content_) supermod.refTextType.subclass = refTextTypeSub # end class refTextTypeSub class sectiondefTypeSub(supermod.sectiondefType): def __init__(self, kind=None, header='', description=None, memberdef=None): supermod.sectiondefType.__init__(self, kind, header, description, memberdef) def find(self, details): for memberdef in self.memberdef: if memberdef.id == details.refid: return memberdef return None supermod.sectiondefType.subclass = sectiondefTypeSub # end class sectiondefTypeSub class memberdefTypeSub(supermod.memberdefType): def __init__(self, initonly=None, kind=None, volatile=None, const=None, raise_=None, virt=None, readable=None, prot=None, explicit=None, new=None, final=None, writable=None, add=None, static=None, remove=None, sealed=None, mutable=None, gettable=None, inline=None, settable=None, id=None, templateparamlist=None, type_=None, definition='', argsstring='', name='', read='', write='', bitfield='', reimplements=None, reimplementedby=None, param=None, enumvalue=None, initializer=None, exceptions=None, briefdescription=None, detaileddescription=None, inbodydescription=None, location=None, references=None, referencedby=None): supermod.memberdefType.__init__(self, initonly, kind, volatile, const, raise_, virt, readable, prot, explicit, new, final, writable, add, static, remove, sealed, mutable, gettable, inline, settable, id, templateparamlist, type_, definition, argsstring, name, read, write, bitfield, reimplements, reimplementedby, param, enumvalue, initializer, exceptions, briefdescription, detaileddescription, inbodydescription, location, references, referencedby) supermod.memberdefType.subclass = memberdefTypeSub # end class memberdefTypeSub class descriptionTypeSub(supermod.descriptionType): def __init__(self, title='', para=None, sect1=None, internal=None, mixedclass_=None, content_=None): supermod.descriptionType.__init__(self, mixedclass_, content_) supermod.descriptionType.subclass = descriptionTypeSub # end class descriptionTypeSub class enumvalueTypeSub(supermod.enumvalueType): def __init__(self, prot=None, id=None, name='', initializer=None, briefdescription=None, detaileddescription=None, mixedclass_=None, content_=None): supermod.enumvalueType.__init__(self, mixedclass_, content_) supermod.enumvalueType.subclass = enumvalueTypeSub # end class enumvalueTypeSub class templateparamlistTypeSub(supermod.templateparamlistType): def __init__(self, param=None): supermod.templateparamlistType.__init__(self, param) supermod.templateparamlistType.subclass = templateparamlistTypeSub # end class templateparamlistTypeSub class paramTypeSub(supermod.paramType): def __init__(self, type_=None, declname='', defname='', array='', defval=None, briefdescription=None): supermod.paramType.__init__(self, type_, declname, defname, array, defval, briefdescription) supermod.paramType.subclass = paramTypeSub # end class paramTypeSub class linkedTextTypeSub(supermod.linkedTextType): def __init__(self, ref=None, mixedclass_=None, content_=None): supermod.linkedTextType.__init__(self, mixedclass_, content_) supermod.linkedTextType.subclass = linkedTextTypeSub # end class linkedTextTypeSub class graphTypeSub(supermod.graphType): def __init__(self, node=None): supermod.graphType.__init__(self, node) supermod.graphType.subclass = graphTypeSub # end class graphTypeSub class nodeTypeSub(supermod.nodeType): def __init__(self, id=None, label='', link=None, childnode=None): supermod.nodeType.__init__(self, id, label, link, childnode) supermod.nodeType.subclass = nodeTypeSub # end class nodeTypeSub class childnodeTypeSub(supermod.childnodeType): def __init__(self, relation=None, refid=None, edgelabel=None): supermod.childnodeType.__init__(self, relation, refid, edgelabel) supermod.childnodeType.subclass = childnodeTypeSub # end class childnodeTypeSub class linkTypeSub(supermod.linkType): def __init__(self, refid=None, external=None, valueOf_=''): supermod.linkType.__init__(self, refid, external) supermod.linkType.subclass = linkTypeSub # end class linkTypeSub class listingTypeSub(supermod.listingType): def __init__(self, codeline=None): supermod.listingType.__init__(self, codeline) supermod.listingType.subclass = listingTypeSub # end class listingTypeSub class codelineTypeSub(supermod.codelineType): def __init__(self, external=None, lineno=None, refkind=None, refid=None, highlight=None): supermod.codelineType.__init__(self, external, lineno, refkind, refid, highlight) supermod.codelineType.subclass = codelineTypeSub # end class codelineTypeSub class highlightTypeSub(supermod.highlightType): def __init__(self, class_=None, sp=None, ref=None, mixedclass_=None, content_=None): supermod.highlightType.__init__(self, mixedclass_, content_) supermod.highlightType.subclass = highlightTypeSub # end class highlightTypeSub class referenceTypeSub(supermod.referenceType): def __init__(self, endline=None, startline=None, refid=None, compoundref=None, valueOf_='', mixedclass_=None, content_=None): supermod.referenceType.__init__(self, mixedclass_, content_) supermod.referenceType.subclass = referenceTypeSub # end class referenceTypeSub class locationTypeSub(supermod.locationType): def __init__(self, bodystart=None, line=None, bodyend=None, bodyfile=None, file=None, valueOf_=''): supermod.locationType.__init__(self, bodystart, line, bodyend, bodyfile, file) supermod.locationType.subclass = locationTypeSub # end class locationTypeSub class docSect1TypeSub(supermod.docSect1Type): def __init__(self, id=None, title='', para=None, sect2=None, internal=None, mixedclass_=None, content_=None): supermod.docSect1Type.__init__(self, mixedclass_, content_) supermod.docSect1Type.subclass = docSect1TypeSub # end class docSect1TypeSub class docSect2TypeSub(supermod.docSect2Type): def __init__(self, id=None, title='', para=None, sect3=None, internal=None, mixedclass_=None, content_=None): supermod.docSect2Type.__init__(self, mixedclass_, content_) supermod.docSect2Type.subclass = docSect2TypeSub # end class docSect2TypeSub class docSect3TypeSub(supermod.docSect3Type): def __init__(self, id=None, title='', para=None, sect4=None, internal=None, mixedclass_=None, content_=None): supermod.docSect3Type.__init__(self, mixedclass_, content_) supermod.docSect3Type.subclass = docSect3TypeSub # end class docSect3TypeSub class docSect4TypeSub(supermod.docSect4Type): def __init__(self, id=None, title='', para=None, internal=None, mixedclass_=None, content_=None): supermod.docSect4Type.__init__(self, mixedclass_, content_) supermod.docSect4Type.subclass = docSect4TypeSub # end class docSect4TypeSub class docInternalTypeSub(supermod.docInternalType): def __init__(self, para=None, sect1=None, mixedclass_=None, content_=None): supermod.docInternalType.__init__(self, mixedclass_, content_) supermod.docInternalType.subclass = docInternalTypeSub # end class docInternalTypeSub class docInternalS1TypeSub(supermod.docInternalS1Type): def __init__(self, para=None, sect2=None, mixedclass_=None, content_=None): supermod.docInternalS1Type.__init__(self, mixedclass_, content_) supermod.docInternalS1Type.subclass = docInternalS1TypeSub # end class docInternalS1TypeSub class docInternalS2TypeSub(supermod.docInternalS2Type): def __init__(self, para=None, sect3=None, mixedclass_=None, content_=None): supermod.docInternalS2Type.__init__(self, mixedclass_, content_) supermod.docInternalS2Type.subclass = docInternalS2TypeSub # end class docInternalS2TypeSub class docInternalS3TypeSub(supermod.docInternalS3Type): def __init__(self, para=None, sect3=None, mixedclass_=None, content_=None): supermod.docInternalS3Type.__init__(self, mixedclass_, content_) supermod.docInternalS3Type.subclass = docInternalS3TypeSub # end class docInternalS3TypeSub class docInternalS4TypeSub(supermod.docInternalS4Type): def __init__(self, para=None, mixedclass_=None, content_=None): supermod.docInternalS4Type.__init__(self, mixedclass_, content_) supermod.docInternalS4Type.subclass = docInternalS4TypeSub # end class docInternalS4TypeSub class docURLLinkSub(supermod.docURLLink): def __init__(self, url=None, valueOf_='', mixedclass_=None, content_=None): supermod.docURLLink.__init__(self, mixedclass_, content_) supermod.docURLLink.subclass = docURLLinkSub # end class docURLLinkSub class docAnchorTypeSub(supermod.docAnchorType): def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=None): supermod.docAnchorType.__init__(self, mixedclass_, content_) supermod.docAnchorType.subclass = docAnchorTypeSub # end class docAnchorTypeSub class docFormulaTypeSub(supermod.docFormulaType): def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=None): supermod.docFormulaType.__init__(self, mixedclass_, content_) supermod.docFormulaType.subclass = docFormulaTypeSub # end class docFormulaTypeSub class docIndexEntryTypeSub(supermod.docIndexEntryType): def __init__(self, primaryie='', secondaryie=''): supermod.docIndexEntryType.__init__(self, primaryie, secondaryie) supermod.docIndexEntryType.subclass = docIndexEntryTypeSub # end class docIndexEntryTypeSub class docListTypeSub(supermod.docListType): def __init__(self, listitem=None): supermod.docListType.__init__(self, listitem) supermod.docListType.subclass = docListTypeSub # end class docListTypeSub class docListItemTypeSub(supermod.docListItemType): def __init__(self, para=None): supermod.docListItemType.__init__(self, para) supermod.docListItemType.subclass = docListItemTypeSub # end class docListItemTypeSub class docSimpleSectTypeSub(supermod.docSimpleSectType): def __init__(self, kind=None, title=None, para=None): supermod.docSimpleSectType.__init__(self, kind, title, para) supermod.docSimpleSectType.subclass = docSimpleSectTypeSub # end class docSimpleSectTypeSub class docVarListEntryTypeSub(supermod.docVarListEntryType): def __init__(self, term=None): supermod.docVarListEntryType.__init__(self, term) supermod.docVarListEntryType.subclass = docVarListEntryTypeSub # end class docVarListEntryTypeSub class docRefTextTypeSub(supermod.docRefTextType): def __init__(self, refid=None, kindref=None, external=None, valueOf_='', mixedclass_=None, content_=None): supermod.docRefTextType.__init__(self, mixedclass_, content_) supermod.docRefTextType.subclass = docRefTextTypeSub # end class docRefTextTypeSub class docTableTypeSub(supermod.docTableType): def __init__(self, rows=None, cols=None, row=None, caption=None): supermod.docTableType.__init__(self, rows, cols, row, caption) supermod.docTableType.subclass = docTableTypeSub # end class docTableTypeSub class docRowTypeSub(supermod.docRowType): def __init__(self, entry=None): supermod.docRowType.__init__(self, entry) supermod.docRowType.subclass = docRowTypeSub # end class docRowTypeSub class docEntryTypeSub(supermod.docEntryType): def __init__(self, thead=None, para=None): supermod.docEntryType.__init__(self, thead, para) supermod.docEntryType.subclass = docEntryTypeSub # end class docEntryTypeSub class docHeadingTypeSub(supermod.docHeadingType): def __init__(self, level=None, valueOf_='', mixedclass_=None, content_=None): supermod.docHeadingType.__init__(self, mixedclass_, content_) supermod.docHeadingType.subclass = docHeadingTypeSub # end class docHeadingTypeSub class docImageTypeSub(supermod.docImageType): def __init__(self, width=None, type_=None, name=None, height=None, valueOf_='', mixedclass_=None, content_=None): supermod.docImageType.__init__(self, mixedclass_, content_) supermod.docImageType.subclass = docImageTypeSub # end class docImageTypeSub class docDotFileTypeSub(supermod.docDotFileType): def __init__(self, name=None, valueOf_='', mixedclass_=None, content_=None): supermod.docDotFileType.__init__(self, mixedclass_, content_) supermod.docDotFileType.subclass = docDotFileTypeSub # end class docDotFileTypeSub class docTocItemTypeSub(supermod.docTocItemType): def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=None): supermod.docTocItemType.__init__(self, mixedclass_, content_) supermod.docTocItemType.subclass = docTocItemTypeSub # end class docTocItemTypeSub class docTocListTypeSub(supermod.docTocListType): def __init__(self, tocitem=None): supermod.docTocListType.__init__(self, tocitem) supermod.docTocListType.subclass = docTocListTypeSub # end class docTocListTypeSub class docLanguageTypeSub(supermod.docLanguageType): def __init__(self, langid=None, para=None): supermod.docLanguageType.__init__(self, langid, para) supermod.docLanguageType.subclass = docLanguageTypeSub # end class docLanguageTypeSub class docParamListTypeSub(supermod.docParamListType): def __init__(self, kind=None, parameteritem=None): supermod.docParamListType.__init__(self, kind, parameteritem) supermod.docParamListType.subclass = docParamListTypeSub # end class docParamListTypeSub class docParamListItemSub(supermod.docParamListItem): def __init__(self, parameternamelist=None, parameterdescription=None): supermod.docParamListItem.__init__(self, parameternamelist, parameterdescription) supermod.docParamListItem.subclass = docParamListItemSub # end class docParamListItemSub class docParamNameListSub(supermod.docParamNameList): def __init__(self, parametername=None): supermod.docParamNameList.__init__(self, parametername) supermod.docParamNameList.subclass = docParamNameListSub # end class docParamNameListSub class docParamNameSub(supermod.docParamName): def __init__(self, direction=None, ref=None, mixedclass_=None, content_=None): supermod.docParamName.__init__(self, mixedclass_, content_) supermod.docParamName.subclass = docParamNameSub # end class docParamNameSub class docXRefSectTypeSub(supermod.docXRefSectType): def __init__(self, id=None, xreftitle=None, xrefdescription=None): supermod.docXRefSectType.__init__(self, id, xreftitle, xrefdescription) supermod.docXRefSectType.subclass = docXRefSectTypeSub # end class docXRefSectTypeSub class docCopyTypeSub(supermod.docCopyType): def __init__(self, link=None, para=None, sect1=None, internal=None): supermod.docCopyType.__init__(self, link, para, sect1, internal) supermod.docCopyType.subclass = docCopyTypeSub # end class docCopyTypeSub class docCharTypeSub(supermod.docCharType): def __init__(self, char=None, valueOf_=''): supermod.docCharType.__init__(self, char) supermod.docCharType.subclass = docCharTypeSub # end class docCharTypeSub class docParaTypeSub(supermod.docParaType): def __init__(self, char=None, valueOf_=''): supermod.docParaType.__init__(self, char) self.parameterlist = [] self.simplesects = [] self.content = [] def buildChildren(self, child_, nodeName_): supermod.docParaType.buildChildren(self, child_, nodeName_) if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == "ref": obj_ = supermod.docRefTextType.factory() obj_.build(child_) self.content.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'parameterlist': obj_ = supermod.docParamListType.factory() obj_.build(child_) self.parameterlist.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'simplesect': obj_ = supermod.docSimpleSectType.factory() obj_.build(child_) self.simplesects.append(obj_) supermod.docParaType.subclass = docParaTypeSub # end class docParaTypeSub def parse(inFilename): doc = minidom.parse(inFilename) rootNode = doc.documentElement rootObj = supermod.DoxygenType.factory() rootObj.build(rootNode) return rootObj gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/generated/compoundsuper.py000066400000000000000000012770141225753723100263670ustar00rootroot00000000000000#!/usr/bin/env python # # Generated Thu Jun 11 18:44:25 2009 by generateDS.py. # import sys import getopt from string import lower as str_lower from xml.dom import minidom from xml.dom import Node # # User methods # # Calls to the methods in these classes are generated by generateDS.py. # You can replace these methods by re-implementing the following class # in a module named generatedssuper.py. try: from generatedssuper import GeneratedsSuper except ImportError, exp: class GeneratedsSuper: def format_string(self, input_data, input_name=''): return input_data def format_integer(self, input_data, input_name=''): return '%d' % input_data def format_float(self, input_data, input_name=''): return '%f' % input_data def format_double(self, input_data, input_name=''): return '%e' % input_data def format_boolean(self, input_data, input_name=''): return '%s' % input_data # # If you have installed IPython you can uncomment and use the following. # IPython is available from http://ipython.scipy.org/. # ## from IPython.Shell import IPShellEmbed ## args = '' ## ipshell = IPShellEmbed(args, ## banner = 'Dropping into IPython', ## exit_msg = 'Leaving Interpreter, back to program.') # Then use the following line where and when you want to drop into the # IPython shell: # ipshell(' -- Entering ipshell.\nHit Ctrl-D to exit') # # Globals # ExternalEncoding = 'ascii' # # Support/utility functions. # def showIndent(outfile, level): for idx in range(level): outfile.write(' ') def quote_xml(inStr): s1 = (isinstance(inStr, basestring) and inStr or '%s' % inStr) s1 = s1.replace('&', '&') s1 = s1.replace('<', '<') s1 = s1.replace('>', '>') return s1 def quote_attrib(inStr): s1 = (isinstance(inStr, basestring) and inStr or '%s' % inStr) s1 = s1.replace('&', '&') s1 = s1.replace('<', '<') s1 = s1.replace('>', '>') if '"' in s1: if "'" in s1: s1 = '"%s"' % s1.replace('"', """) else: s1 = "'%s'" % s1 else: s1 = '"%s"' % s1 return s1 def quote_python(inStr): s1 = inStr if s1.find("'") == -1: if s1.find('\n') == -1: return "'%s'" % s1 else: return "'''%s'''" % s1 else: if s1.find('"') != -1: s1 = s1.replace('"', '\\"') if s1.find('\n') == -1: return '"%s"' % s1 else: return '"""%s"""' % s1 class MixedContainer: # Constants for category: CategoryNone = 0 CategoryText = 1 CategorySimple = 2 CategoryComplex = 3 # Constants for content_type: TypeNone = 0 TypeText = 1 TypeString = 2 TypeInteger = 3 TypeFloat = 4 TypeDecimal = 5 TypeDouble = 6 TypeBoolean = 7 def __init__(self, category, content_type, name, value): self.category = category self.content_type = content_type self.name = name self.value = value def getCategory(self): return self.category def getContenttype(self, content_type): return self.content_type def getValue(self): return self.value def getName(self): return self.name def export(self, outfile, level, name, namespace): if self.category == MixedContainer.CategoryText: outfile.write(self.value) elif self.category == MixedContainer.CategorySimple: self.exportSimple(outfile, level, name) else: # category == MixedContainer.CategoryComplex self.value.export(outfile, level, namespace,name) def exportSimple(self, outfile, level, name): if self.content_type == MixedContainer.TypeString: outfile.write('<%s>%s' % (self.name, self.value, self.name)) elif self.content_type == MixedContainer.TypeInteger or \ self.content_type == MixedContainer.TypeBoolean: outfile.write('<%s>%d' % (self.name, self.value, self.name)) elif self.content_type == MixedContainer.TypeFloat or \ self.content_type == MixedContainer.TypeDecimal: outfile.write('<%s>%f' % (self.name, self.value, self.name)) elif self.content_type == MixedContainer.TypeDouble: outfile.write('<%s>%g' % (self.name, self.value, self.name)) def exportLiteral(self, outfile, level, name): if self.category == MixedContainer.CategoryText: showIndent(outfile, level) outfile.write('MixedContainer(%d, %d, "%s", "%s"),\n' % \ (self.category, self.content_type, self.name, self.value)) elif self.category == MixedContainer.CategorySimple: showIndent(outfile, level) outfile.write('MixedContainer(%d, %d, "%s", "%s"),\n' % \ (self.category, self.content_type, self.name, self.value)) else: # category == MixedContainer.CategoryComplex showIndent(outfile, level) outfile.write('MixedContainer(%d, %d, "%s",\n' % \ (self.category, self.content_type, self.name,)) self.value.exportLiteral(outfile, level + 1) showIndent(outfile, level) outfile.write(')\n') class _MemberSpec(object): def __init__(self, name='', data_type='', container=0): self.name = name self.data_type = data_type self.container = container def set_name(self, name): self.name = name def get_name(self): return self.name def set_data_type(self, data_type): self.data_type = data_type def get_data_type(self): return self.data_type def set_container(self, container): self.container = container def get_container(self): return self.container # # Data representation classes. # class DoxygenType(GeneratedsSuper): subclass = None superclass = None def __init__(self, version=None, compounddef=None): self.version = version self.compounddef = compounddef def factory(*args_, **kwargs_): if DoxygenType.subclass: return DoxygenType.subclass(*args_, **kwargs_) else: return DoxygenType(*args_, **kwargs_) factory = staticmethod(factory) def get_compounddef(self): return self.compounddef def set_compounddef(self, compounddef): self.compounddef = compounddef def get_version(self): return self.version def set_version(self, version): self.version = version def export(self, outfile, level, namespace_='', name_='DoxygenType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='DoxygenType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='DoxygenType'): outfile.write(' version=%s' % (quote_attrib(self.version), )) def exportChildren(self, outfile, level, namespace_='', name_='DoxygenType'): if self.compounddef: self.compounddef.export(outfile, level, namespace_, name_='compounddef') def hasContent_(self): if ( self.compounddef is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='DoxygenType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.version is not None: showIndent(outfile, level) outfile.write('version = "%s",\n' % (self.version,)) def exportLiteralChildren(self, outfile, level, name_): if self.compounddef: showIndent(outfile, level) outfile.write('compounddef=model_.compounddefType(\n') self.compounddef.exportLiteral(outfile, level, name_='compounddef') showIndent(outfile, level) outfile.write('),\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('version'): self.version = attrs.get('version').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'compounddef': obj_ = compounddefType.factory() obj_.build(child_) self.set_compounddef(obj_) # end class DoxygenType class compounddefType(GeneratedsSuper): subclass = None superclass = None def __init__(self, kind=None, prot=None, id=None, compoundname=None, title=None, basecompoundref=None, derivedcompoundref=None, includes=None, includedby=None, incdepgraph=None, invincdepgraph=None, innerdir=None, innerfile=None, innerclass=None, innernamespace=None, innerpage=None, innergroup=None, templateparamlist=None, sectiondef=None, briefdescription=None, detaileddescription=None, inheritancegraph=None, collaborationgraph=None, programlisting=None, location=None, listofallmembers=None): self.kind = kind self.prot = prot self.id = id self.compoundname = compoundname self.title = title if basecompoundref is None: self.basecompoundref = [] else: self.basecompoundref = basecompoundref if derivedcompoundref is None: self.derivedcompoundref = [] else: self.derivedcompoundref = derivedcompoundref if includes is None: self.includes = [] else: self.includes = includes if includedby is None: self.includedby = [] else: self.includedby = includedby self.incdepgraph = incdepgraph self.invincdepgraph = invincdepgraph if innerdir is None: self.innerdir = [] else: self.innerdir = innerdir if innerfile is None: self.innerfile = [] else: self.innerfile = innerfile if innerclass is None: self.innerclass = [] else: self.innerclass = innerclass if innernamespace is None: self.innernamespace = [] else: self.innernamespace = innernamespace if innerpage is None: self.innerpage = [] else: self.innerpage = innerpage if innergroup is None: self.innergroup = [] else: self.innergroup = innergroup self.templateparamlist = templateparamlist if sectiondef is None: self.sectiondef = [] else: self.sectiondef = sectiondef self.briefdescription = briefdescription self.detaileddescription = detaileddescription self.inheritancegraph = inheritancegraph self.collaborationgraph = collaborationgraph self.programlisting = programlisting self.location = location self.listofallmembers = listofallmembers def factory(*args_, **kwargs_): if compounddefType.subclass: return compounddefType.subclass(*args_, **kwargs_) else: return compounddefType(*args_, **kwargs_) factory = staticmethod(factory) def get_compoundname(self): return self.compoundname def set_compoundname(self, compoundname): self.compoundname = compoundname def get_title(self): return self.title def set_title(self, title): self.title = title def get_basecompoundref(self): return self.basecompoundref def set_basecompoundref(self, basecompoundref): self.basecompoundref = basecompoundref def add_basecompoundref(self, value): self.basecompoundref.append(value) def insert_basecompoundref(self, index, value): self.basecompoundref[index] = value def get_derivedcompoundref(self): return self.derivedcompoundref def set_derivedcompoundref(self, derivedcompoundref): self.derivedcompoundref = derivedcompoundref def add_derivedcompoundref(self, value): self.derivedcompoundref.append(value) def insert_derivedcompoundref(self, index, value): self.derivedcompoundref[index] = value def get_includes(self): return self.includes def set_includes(self, includes): self.includes = includes def add_includes(self, value): self.includes.append(value) def insert_includes(self, index, value): self.includes[index] = value def get_includedby(self): return self.includedby def set_includedby(self, includedby): self.includedby = includedby def add_includedby(self, value): self.includedby.append(value) def insert_includedby(self, index, value): self.includedby[index] = value def get_incdepgraph(self): return self.incdepgraph def set_incdepgraph(self, incdepgraph): self.incdepgraph = incdepgraph def get_invincdepgraph(self): return self.invincdepgraph def set_invincdepgraph(self, invincdepgraph): self.invincdepgraph = invincdepgraph def get_innerdir(self): return self.innerdir def set_innerdir(self, innerdir): self.innerdir = innerdir def add_innerdir(self, value): self.innerdir.append(value) def insert_innerdir(self, index, value): self.innerdir[index] = value def get_innerfile(self): return self.innerfile def set_innerfile(self, innerfile): self.innerfile = innerfile def add_innerfile(self, value): self.innerfile.append(value) def insert_innerfile(self, index, value): self.innerfile[index] = value def get_innerclass(self): return self.innerclass def set_innerclass(self, innerclass): self.innerclass = innerclass def add_innerclass(self, value): self.innerclass.append(value) def insert_innerclass(self, index, value): self.innerclass[index] = value def get_innernamespace(self): return self.innernamespace def set_innernamespace(self, innernamespace): self.innernamespace = innernamespace def add_innernamespace(self, value): self.innernamespace.append(value) def insert_innernamespace(self, index, value): self.innernamespace[index] = value def get_innerpage(self): return self.innerpage def set_innerpage(self, innerpage): self.innerpage = innerpage def add_innerpage(self, value): self.innerpage.append(value) def insert_innerpage(self, index, value): self.innerpage[index] = value def get_innergroup(self): return self.innergroup def set_innergroup(self, innergroup): self.innergroup = innergroup def add_innergroup(self, value): self.innergroup.append(value) def insert_innergroup(self, index, value): self.innergroup[index] = value def get_templateparamlist(self): return self.templateparamlist def set_templateparamlist(self, templateparamlist): self.templateparamlist = templateparamlist def get_sectiondef(self): return self.sectiondef def set_sectiondef(self, sectiondef): self.sectiondef = sectiondef def add_sectiondef(self, value): self.sectiondef.append(value) def insert_sectiondef(self, index, value): self.sectiondef[index] = value def get_briefdescription(self): return self.briefdescription def set_briefdescription(self, briefdescription): self.briefdescription = briefdescription def get_detaileddescription(self): return self.detaileddescription def set_detaileddescription(self, detaileddescription): self.detaileddescription = detaileddescription def get_inheritancegraph(self): return self.inheritancegraph def set_inheritancegraph(self, inheritancegraph): self.inheritancegraph = inheritancegraph def get_collaborationgraph(self): return self.collaborationgraph def set_collaborationgraph(self, collaborationgraph): self.collaborationgraph = collaborationgraph def get_programlisting(self): return self.programlisting def set_programlisting(self, programlisting): self.programlisting = programlisting def get_location(self): return self.location def set_location(self, location): self.location = location def get_listofallmembers(self): return self.listofallmembers def set_listofallmembers(self, listofallmembers): self.listofallmembers = listofallmembers def get_kind(self): return self.kind def set_kind(self, kind): self.kind = kind def get_prot(self): return self.prot def set_prot(self, prot): self.prot = prot def get_id(self): return self.id def set_id(self, id): self.id = id def export(self, outfile, level, namespace_='', name_='compounddefType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='compounddefType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='compounddefType'): if self.kind is not None: outfile.write(' kind=%s' % (quote_attrib(self.kind), )) if self.prot is not None: outfile.write(' prot=%s' % (quote_attrib(self.prot), )) if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='compounddefType'): if self.compoundname is not None: showIndent(outfile, level) outfile.write('<%scompoundname>%s\n' % (namespace_, self.format_string(quote_xml(self.compoundname).encode(ExternalEncoding), input_name='compoundname'), namespace_)) if self.title is not None: showIndent(outfile, level) outfile.write('<%stitle>%s\n' % (namespace_, self.format_string(quote_xml(self.title).encode(ExternalEncoding), input_name='title'), namespace_)) for basecompoundref_ in self.basecompoundref: basecompoundref_.export(outfile, level, namespace_, name_='basecompoundref') for derivedcompoundref_ in self.derivedcompoundref: derivedcompoundref_.export(outfile, level, namespace_, name_='derivedcompoundref') for includes_ in self.includes: includes_.export(outfile, level, namespace_, name_='includes') for includedby_ in self.includedby: includedby_.export(outfile, level, namespace_, name_='includedby') if self.incdepgraph: self.incdepgraph.export(outfile, level, namespace_, name_='incdepgraph') if self.invincdepgraph: self.invincdepgraph.export(outfile, level, namespace_, name_='invincdepgraph') for innerdir_ in self.innerdir: innerdir_.export(outfile, level, namespace_, name_='innerdir') for innerfile_ in self.innerfile: innerfile_.export(outfile, level, namespace_, name_='innerfile') for innerclass_ in self.innerclass: innerclass_.export(outfile, level, namespace_, name_='innerclass') for innernamespace_ in self.innernamespace: innernamespace_.export(outfile, level, namespace_, name_='innernamespace') for innerpage_ in self.innerpage: innerpage_.export(outfile, level, namespace_, name_='innerpage') for innergroup_ in self.innergroup: innergroup_.export(outfile, level, namespace_, name_='innergroup') if self.templateparamlist: self.templateparamlist.export(outfile, level, namespace_, name_='templateparamlist') for sectiondef_ in self.sectiondef: sectiondef_.export(outfile, level, namespace_, name_='sectiondef') if self.briefdescription: self.briefdescription.export(outfile, level, namespace_, name_='briefdescription') if self.detaileddescription: self.detaileddescription.export(outfile, level, namespace_, name_='detaileddescription') if self.inheritancegraph: self.inheritancegraph.export(outfile, level, namespace_, name_='inheritancegraph') if self.collaborationgraph: self.collaborationgraph.export(outfile, level, namespace_, name_='collaborationgraph') if self.programlisting: self.programlisting.export(outfile, level, namespace_, name_='programlisting') if self.location: self.location.export(outfile, level, namespace_, name_='location') if self.listofallmembers: self.listofallmembers.export(outfile, level, namespace_, name_='listofallmembers') def hasContent_(self): if ( self.compoundname is not None or self.title is not None or self.basecompoundref is not None or self.derivedcompoundref is not None or self.includes is not None or self.includedby is not None or self.incdepgraph is not None or self.invincdepgraph is not None or self.innerdir is not None or self.innerfile is not None or self.innerclass is not None or self.innernamespace is not None or self.innerpage is not None or self.innergroup is not None or self.templateparamlist is not None or self.sectiondef is not None or self.briefdescription is not None or self.detaileddescription is not None or self.inheritancegraph is not None or self.collaborationgraph is not None or self.programlisting is not None or self.location is not None or self.listofallmembers is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='compounddefType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.kind is not None: showIndent(outfile, level) outfile.write('kind = "%s",\n' % (self.kind,)) if self.prot is not None: showIndent(outfile, level) outfile.write('prot = "%s",\n' % (self.prot,)) if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('compoundname=%s,\n' % quote_python(self.compoundname).encode(ExternalEncoding)) if self.title: showIndent(outfile, level) outfile.write('title=model_.xsd_string(\n') self.title.exportLiteral(outfile, level, name_='title') showIndent(outfile, level) outfile.write('),\n') showIndent(outfile, level) outfile.write('basecompoundref=[\n') level += 1 for basecompoundref in self.basecompoundref: showIndent(outfile, level) outfile.write('model_.basecompoundref(\n') basecompoundref.exportLiteral(outfile, level, name_='basecompoundref') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('derivedcompoundref=[\n') level += 1 for derivedcompoundref in self.derivedcompoundref: showIndent(outfile, level) outfile.write('model_.derivedcompoundref(\n') derivedcompoundref.exportLiteral(outfile, level, name_='derivedcompoundref') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('includes=[\n') level += 1 for includes in self.includes: showIndent(outfile, level) outfile.write('model_.includes(\n') includes.exportLiteral(outfile, level, name_='includes') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('includedby=[\n') level += 1 for includedby in self.includedby: showIndent(outfile, level) outfile.write('model_.includedby(\n') includedby.exportLiteral(outfile, level, name_='includedby') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') if self.incdepgraph: showIndent(outfile, level) outfile.write('incdepgraph=model_.graphType(\n') self.incdepgraph.exportLiteral(outfile, level, name_='incdepgraph') showIndent(outfile, level) outfile.write('),\n') if self.invincdepgraph: showIndent(outfile, level) outfile.write('invincdepgraph=model_.graphType(\n') self.invincdepgraph.exportLiteral(outfile, level, name_='invincdepgraph') showIndent(outfile, level) outfile.write('),\n') showIndent(outfile, level) outfile.write('innerdir=[\n') level += 1 for innerdir in self.innerdir: showIndent(outfile, level) outfile.write('model_.innerdir(\n') innerdir.exportLiteral(outfile, level, name_='innerdir') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('innerfile=[\n') level += 1 for innerfile in self.innerfile: showIndent(outfile, level) outfile.write('model_.innerfile(\n') innerfile.exportLiteral(outfile, level, name_='innerfile') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('innerclass=[\n') level += 1 for innerclass in self.innerclass: showIndent(outfile, level) outfile.write('model_.innerclass(\n') innerclass.exportLiteral(outfile, level, name_='innerclass') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('innernamespace=[\n') level += 1 for innernamespace in self.innernamespace: showIndent(outfile, level) outfile.write('model_.innernamespace(\n') innernamespace.exportLiteral(outfile, level, name_='innernamespace') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('innerpage=[\n') level += 1 for innerpage in self.innerpage: showIndent(outfile, level) outfile.write('model_.innerpage(\n') innerpage.exportLiteral(outfile, level, name_='innerpage') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('innergroup=[\n') level += 1 for innergroup in self.innergroup: showIndent(outfile, level) outfile.write('model_.innergroup(\n') innergroup.exportLiteral(outfile, level, name_='innergroup') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') if self.templateparamlist: showIndent(outfile, level) outfile.write('templateparamlist=model_.templateparamlistType(\n') self.templateparamlist.exportLiteral(outfile, level, name_='templateparamlist') showIndent(outfile, level) outfile.write('),\n') showIndent(outfile, level) outfile.write('sectiondef=[\n') level += 1 for sectiondef in self.sectiondef: showIndent(outfile, level) outfile.write('model_.sectiondef(\n') sectiondef.exportLiteral(outfile, level, name_='sectiondef') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') if self.briefdescription: showIndent(outfile, level) outfile.write('briefdescription=model_.descriptionType(\n') self.briefdescription.exportLiteral(outfile, level, name_='briefdescription') showIndent(outfile, level) outfile.write('),\n') if self.detaileddescription: showIndent(outfile, level) outfile.write('detaileddescription=model_.descriptionType(\n') self.detaileddescription.exportLiteral(outfile, level, name_='detaileddescription') showIndent(outfile, level) outfile.write('),\n') if self.inheritancegraph: showIndent(outfile, level) outfile.write('inheritancegraph=model_.graphType(\n') self.inheritancegraph.exportLiteral(outfile, level, name_='inheritancegraph') showIndent(outfile, level) outfile.write('),\n') if self.collaborationgraph: showIndent(outfile, level) outfile.write('collaborationgraph=model_.graphType(\n') self.collaborationgraph.exportLiteral(outfile, level, name_='collaborationgraph') showIndent(outfile, level) outfile.write('),\n') if self.programlisting: showIndent(outfile, level) outfile.write('programlisting=model_.listingType(\n') self.programlisting.exportLiteral(outfile, level, name_='programlisting') showIndent(outfile, level) outfile.write('),\n') if self.location: showIndent(outfile, level) outfile.write('location=model_.locationType(\n') self.location.exportLiteral(outfile, level, name_='location') showIndent(outfile, level) outfile.write('),\n') if self.listofallmembers: showIndent(outfile, level) outfile.write('listofallmembers=model_.listofallmembersType(\n') self.listofallmembers.exportLiteral(outfile, level, name_='listofallmembers') showIndent(outfile, level) outfile.write('),\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('kind'): self.kind = attrs.get('kind').value if attrs.get('prot'): self.prot = attrs.get('prot').value if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'compoundname': compoundname_ = '' for text__content_ in child_.childNodes: compoundname_ += text__content_.nodeValue self.compoundname = compoundname_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'title': obj_ = docTitleType.factory() obj_.build(child_) self.set_title(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'basecompoundref': obj_ = compoundRefType.factory() obj_.build(child_) self.basecompoundref.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'derivedcompoundref': obj_ = compoundRefType.factory() obj_.build(child_) self.derivedcompoundref.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'includes': obj_ = incType.factory() obj_.build(child_) self.includes.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'includedby': obj_ = incType.factory() obj_.build(child_) self.includedby.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'incdepgraph': obj_ = graphType.factory() obj_.build(child_) self.set_incdepgraph(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'invincdepgraph': obj_ = graphType.factory() obj_.build(child_) self.set_invincdepgraph(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'innerdir': obj_ = refType.factory() obj_.build(child_) self.innerdir.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'innerfile': obj_ = refType.factory() obj_.build(child_) self.innerfile.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'innerclass': obj_ = refType.factory() obj_.build(child_) self.innerclass.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'innernamespace': obj_ = refType.factory() obj_.build(child_) self.innernamespace.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'innerpage': obj_ = refType.factory() obj_.build(child_) self.innerpage.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'innergroup': obj_ = refType.factory() obj_.build(child_) self.innergroup.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'templateparamlist': obj_ = templateparamlistType.factory() obj_.build(child_) self.set_templateparamlist(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'sectiondef': obj_ = sectiondefType.factory() obj_.build(child_) self.sectiondef.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'briefdescription': obj_ = descriptionType.factory() obj_.build(child_) self.set_briefdescription(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'detaileddescription': obj_ = descriptionType.factory() obj_.build(child_) self.set_detaileddescription(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'inheritancegraph': obj_ = graphType.factory() obj_.build(child_) self.set_inheritancegraph(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'collaborationgraph': obj_ = graphType.factory() obj_.build(child_) self.set_collaborationgraph(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'programlisting': obj_ = listingType.factory() obj_.build(child_) self.set_programlisting(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'location': obj_ = locationType.factory() obj_.build(child_) self.set_location(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'listofallmembers': obj_ = listofallmembersType.factory() obj_.build(child_) self.set_listofallmembers(obj_) # end class compounddefType class listofallmembersType(GeneratedsSuper): subclass = None superclass = None def __init__(self, member=None): if member is None: self.member = [] else: self.member = member def factory(*args_, **kwargs_): if listofallmembersType.subclass: return listofallmembersType.subclass(*args_, **kwargs_) else: return listofallmembersType(*args_, **kwargs_) factory = staticmethod(factory) def get_member(self): return self.member def set_member(self, member): self.member = member def add_member(self, value): self.member.append(value) def insert_member(self, index, value): self.member[index] = value def export(self, outfile, level, namespace_='', name_='listofallmembersType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='listofallmembersType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='listofallmembersType'): pass def exportChildren(self, outfile, level, namespace_='', name_='listofallmembersType'): for member_ in self.member: member_.export(outfile, level, namespace_, name_='member') def hasContent_(self): if ( self.member is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='listofallmembersType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('member=[\n') level += 1 for member in self.member: showIndent(outfile, level) outfile.write('model_.member(\n') member.exportLiteral(outfile, level, name_='member') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'member': obj_ = memberRefType.factory() obj_.build(child_) self.member.append(obj_) # end class listofallmembersType class memberRefType(GeneratedsSuper): subclass = None superclass = None def __init__(self, virt=None, prot=None, refid=None, ambiguityscope=None, scope=None, name=None): self.virt = virt self.prot = prot self.refid = refid self.ambiguityscope = ambiguityscope self.scope = scope self.name = name def factory(*args_, **kwargs_): if memberRefType.subclass: return memberRefType.subclass(*args_, **kwargs_) else: return memberRefType(*args_, **kwargs_) factory = staticmethod(factory) def get_scope(self): return self.scope def set_scope(self, scope): self.scope = scope def get_name(self): return self.name def set_name(self, name): self.name = name def get_virt(self): return self.virt def set_virt(self, virt): self.virt = virt def get_prot(self): return self.prot def set_prot(self, prot): self.prot = prot def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def get_ambiguityscope(self): return self.ambiguityscope def set_ambiguityscope(self, ambiguityscope): self.ambiguityscope = ambiguityscope def export(self, outfile, level, namespace_='', name_='memberRefType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='memberRefType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='memberRefType'): if self.virt is not None: outfile.write(' virt=%s' % (quote_attrib(self.virt), )) if self.prot is not None: outfile.write(' prot=%s' % (quote_attrib(self.prot), )) if self.refid is not None: outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) if self.ambiguityscope is not None: outfile.write(' ambiguityscope=%s' % (self.format_string(quote_attrib(self.ambiguityscope).encode(ExternalEncoding), input_name='ambiguityscope'), )) def exportChildren(self, outfile, level, namespace_='', name_='memberRefType'): if self.scope is not None: showIndent(outfile, level) outfile.write('<%sscope>%s\n' % (namespace_, self.format_string(quote_xml(self.scope).encode(ExternalEncoding), input_name='scope'), namespace_)) if self.name is not None: showIndent(outfile, level) outfile.write('<%sname>%s\n' % (namespace_, self.format_string(quote_xml(self.name).encode(ExternalEncoding), input_name='name'), namespace_)) def hasContent_(self): if ( self.scope is not None or self.name is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='memberRefType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.virt is not None: showIndent(outfile, level) outfile.write('virt = "%s",\n' % (self.virt,)) if self.prot is not None: showIndent(outfile, level) outfile.write('prot = "%s",\n' % (self.prot,)) if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) if self.ambiguityscope is not None: showIndent(outfile, level) outfile.write('ambiguityscope = %s,\n' % (self.ambiguityscope,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('scope=%s,\n' % quote_python(self.scope).encode(ExternalEncoding)) showIndent(outfile, level) outfile.write('name=%s,\n' % quote_python(self.name).encode(ExternalEncoding)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('virt'): self.virt = attrs.get('virt').value if attrs.get('prot'): self.prot = attrs.get('prot').value if attrs.get('refid'): self.refid = attrs.get('refid').value if attrs.get('ambiguityscope'): self.ambiguityscope = attrs.get('ambiguityscope').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'scope': scope_ = '' for text__content_ in child_.childNodes: scope_ += text__content_.nodeValue self.scope = scope_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'name': name_ = '' for text__content_ in child_.childNodes: name_ += text__content_.nodeValue self.name = name_ # end class memberRefType class scope(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if scope.subclass: return scope.subclass(*args_, **kwargs_) else: return scope(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='scope', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='scope') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='scope'): pass def exportChildren(self, outfile, level, namespace_='', name_='scope'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='scope'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class scope class name(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if name.subclass: return name.subclass(*args_, **kwargs_) else: return name(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='name', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='name') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='name'): pass def exportChildren(self, outfile, level, namespace_='', name_='name'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='name'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class name class compoundRefType(GeneratedsSuper): subclass = None superclass = None def __init__(self, virt=None, prot=None, refid=None, valueOf_='', mixedclass_=None, content_=None): self.virt = virt self.prot = prot self.refid = refid if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if compoundRefType.subclass: return compoundRefType.subclass(*args_, **kwargs_) else: return compoundRefType(*args_, **kwargs_) factory = staticmethod(factory) def get_virt(self): return self.virt def set_virt(self, virt): self.virt = virt def get_prot(self): return self.prot def set_prot(self, prot): self.prot = prot def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='compoundRefType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='compoundRefType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='compoundRefType'): if self.virt is not None: outfile.write(' virt=%s' % (quote_attrib(self.virt), )) if self.prot is not None: outfile.write(' prot=%s' % (quote_attrib(self.prot), )) if self.refid is not None: outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) def exportChildren(self, outfile, level, namespace_='', name_='compoundRefType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='compoundRefType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.virt is not None: showIndent(outfile, level) outfile.write('virt = "%s",\n' % (self.virt,)) if self.prot is not None: showIndent(outfile, level) outfile.write('prot = "%s",\n' % (self.prot,)) if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('virt'): self.virt = attrs.get('virt').value if attrs.get('prot'): self.prot = attrs.get('prot').value if attrs.get('refid'): self.refid = attrs.get('refid').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class compoundRefType class reimplementType(GeneratedsSuper): subclass = None superclass = None def __init__(self, refid=None, valueOf_='', mixedclass_=None, content_=None): self.refid = refid if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if reimplementType.subclass: return reimplementType.subclass(*args_, **kwargs_) else: return reimplementType(*args_, **kwargs_) factory = staticmethod(factory) def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='reimplementType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='reimplementType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='reimplementType'): if self.refid is not None: outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) def exportChildren(self, outfile, level, namespace_='', name_='reimplementType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='reimplementType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('refid'): self.refid = attrs.get('refid').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class reimplementType class incType(GeneratedsSuper): subclass = None superclass = None def __init__(self, local=None, refid=None, valueOf_='', mixedclass_=None, content_=None): self.local = local self.refid = refid if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if incType.subclass: return incType.subclass(*args_, **kwargs_) else: return incType(*args_, **kwargs_) factory = staticmethod(factory) def get_local(self): return self.local def set_local(self, local): self.local = local def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='incType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='incType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='incType'): if self.local is not None: outfile.write(' local=%s' % (quote_attrib(self.local), )) if self.refid is not None: outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) def exportChildren(self, outfile, level, namespace_='', name_='incType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='incType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.local is not None: showIndent(outfile, level) outfile.write('local = "%s",\n' % (self.local,)) if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('local'): self.local = attrs.get('local').value if attrs.get('refid'): self.refid = attrs.get('refid').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class incType class refType(GeneratedsSuper): subclass = None superclass = None def __init__(self, prot=None, refid=None, valueOf_='', mixedclass_=None, content_=None): self.prot = prot self.refid = refid if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if refType.subclass: return refType.subclass(*args_, **kwargs_) else: return refType(*args_, **kwargs_) factory = staticmethod(factory) def get_prot(self): return self.prot def set_prot(self, prot): self.prot = prot def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='refType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='refType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='refType'): if self.prot is not None: outfile.write(' prot=%s' % (quote_attrib(self.prot), )) if self.refid is not None: outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) def exportChildren(self, outfile, level, namespace_='', name_='refType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='refType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.prot is not None: showIndent(outfile, level) outfile.write('prot = "%s",\n' % (self.prot,)) if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('prot'): self.prot = attrs.get('prot').value if attrs.get('refid'): self.refid = attrs.get('refid').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class refType class refTextType(GeneratedsSuper): subclass = None superclass = None def __init__(self, refid=None, kindref=None, external=None, valueOf_='', mixedclass_=None, content_=None): self.refid = refid self.kindref = kindref self.external = external if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if refTextType.subclass: return refTextType.subclass(*args_, **kwargs_) else: return refTextType(*args_, **kwargs_) factory = staticmethod(factory) def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def get_kindref(self): return self.kindref def set_kindref(self, kindref): self.kindref = kindref def get_external(self): return self.external def set_external(self, external): self.external = external def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='refTextType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='refTextType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='refTextType'): if self.refid is not None: outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) if self.kindref is not None: outfile.write(' kindref=%s' % (quote_attrib(self.kindref), )) if self.external is not None: outfile.write(' external=%s' % (self.format_string(quote_attrib(self.external).encode(ExternalEncoding), input_name='external'), )) def exportChildren(self, outfile, level, namespace_='', name_='refTextType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='refTextType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) if self.kindref is not None: showIndent(outfile, level) outfile.write('kindref = "%s",\n' % (self.kindref,)) if self.external is not None: showIndent(outfile, level) outfile.write('external = %s,\n' % (self.external,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('refid'): self.refid = attrs.get('refid').value if attrs.get('kindref'): self.kindref = attrs.get('kindref').value if attrs.get('external'): self.external = attrs.get('external').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class refTextType class sectiondefType(GeneratedsSuper): subclass = None superclass = None def __init__(self, kind=None, header=None, description=None, memberdef=None): self.kind = kind self.header = header self.description = description if memberdef is None: self.memberdef = [] else: self.memberdef = memberdef def factory(*args_, **kwargs_): if sectiondefType.subclass: return sectiondefType.subclass(*args_, **kwargs_) else: return sectiondefType(*args_, **kwargs_) factory = staticmethod(factory) def get_header(self): return self.header def set_header(self, header): self.header = header def get_description(self): return self.description def set_description(self, description): self.description = description def get_memberdef(self): return self.memberdef def set_memberdef(self, memberdef): self.memberdef = memberdef def add_memberdef(self, value): self.memberdef.append(value) def insert_memberdef(self, index, value): self.memberdef[index] = value def get_kind(self): return self.kind def set_kind(self, kind): self.kind = kind def export(self, outfile, level, namespace_='', name_='sectiondefType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='sectiondefType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='sectiondefType'): if self.kind is not None: outfile.write(' kind=%s' % (quote_attrib(self.kind), )) def exportChildren(self, outfile, level, namespace_='', name_='sectiondefType'): if self.header is not None: showIndent(outfile, level) outfile.write('<%sheader>%s\n' % (namespace_, self.format_string(quote_xml(self.header).encode(ExternalEncoding), input_name='header'), namespace_)) if self.description: self.description.export(outfile, level, namespace_, name_='description') for memberdef_ in self.memberdef: memberdef_.export(outfile, level, namespace_, name_='memberdef') def hasContent_(self): if ( self.header is not None or self.description is not None or self.memberdef is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='sectiondefType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.kind is not None: showIndent(outfile, level) outfile.write('kind = "%s",\n' % (self.kind,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('header=%s,\n' % quote_python(self.header).encode(ExternalEncoding)) if self.description: showIndent(outfile, level) outfile.write('description=model_.descriptionType(\n') self.description.exportLiteral(outfile, level, name_='description') showIndent(outfile, level) outfile.write('),\n') showIndent(outfile, level) outfile.write('memberdef=[\n') level += 1 for memberdef in self.memberdef: showIndent(outfile, level) outfile.write('model_.memberdef(\n') memberdef.exportLiteral(outfile, level, name_='memberdef') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('kind'): self.kind = attrs.get('kind').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'header': header_ = '' for text__content_ in child_.childNodes: header_ += text__content_.nodeValue self.header = header_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'description': obj_ = descriptionType.factory() obj_.build(child_) self.set_description(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'memberdef': obj_ = memberdefType.factory() obj_.build(child_) self.memberdef.append(obj_) # end class sectiondefType class memberdefType(GeneratedsSuper): subclass = None superclass = None def __init__(self, initonly=None, kind=None, volatile=None, const=None, raisexx=None, virt=None, readable=None, prot=None, explicit=None, new=None, final=None, writable=None, add=None, static=None, remove=None, sealed=None, mutable=None, gettable=None, inline=None, settable=None, id=None, templateparamlist=None, type_=None, definition=None, argsstring=None, name=None, read=None, write=None, bitfield=None, reimplements=None, reimplementedby=None, param=None, enumvalue=None, initializer=None, exceptions=None, briefdescription=None, detaileddescription=None, inbodydescription=None, location=None, references=None, referencedby=None): self.initonly = initonly self.kind = kind self.volatile = volatile self.const = const self.raisexx = raisexx self.virt = virt self.readable = readable self.prot = prot self.explicit = explicit self.new = new self.final = final self.writable = writable self.add = add self.static = static self.remove = remove self.sealed = sealed self.mutable = mutable self.gettable = gettable self.inline = inline self.settable = settable self.id = id self.templateparamlist = templateparamlist self.type_ = type_ self.definition = definition self.argsstring = argsstring self.name = name self.read = read self.write = write self.bitfield = bitfield if reimplements is None: self.reimplements = [] else: self.reimplements = reimplements if reimplementedby is None: self.reimplementedby = [] else: self.reimplementedby = reimplementedby if param is None: self.param = [] else: self.param = param if enumvalue is None: self.enumvalue = [] else: self.enumvalue = enumvalue self.initializer = initializer self.exceptions = exceptions self.briefdescription = briefdescription self.detaileddescription = detaileddescription self.inbodydescription = inbodydescription self.location = location if references is None: self.references = [] else: self.references = references if referencedby is None: self.referencedby = [] else: self.referencedby = referencedby def factory(*args_, **kwargs_): if memberdefType.subclass: return memberdefType.subclass(*args_, **kwargs_) else: return memberdefType(*args_, **kwargs_) factory = staticmethod(factory) def get_templateparamlist(self): return self.templateparamlist def set_templateparamlist(self, templateparamlist): self.templateparamlist = templateparamlist def get_type(self): return self.type_ def set_type(self, type_): self.type_ = type_ def get_definition(self): return self.definition def set_definition(self, definition): self.definition = definition def get_argsstring(self): return self.argsstring def set_argsstring(self, argsstring): self.argsstring = argsstring def get_name(self): return self.name def set_name(self, name): self.name = name def get_read(self): return self.read def set_read(self, read): self.read = read def get_write(self): return self.write def set_write(self, write): self.write = write def get_bitfield(self): return self.bitfield def set_bitfield(self, bitfield): self.bitfield = bitfield def get_reimplements(self): return self.reimplements def set_reimplements(self, reimplements): self.reimplements = reimplements def add_reimplements(self, value): self.reimplements.append(value) def insert_reimplements(self, index, value): self.reimplements[index] = value def get_reimplementedby(self): return self.reimplementedby def set_reimplementedby(self, reimplementedby): self.reimplementedby = reimplementedby def add_reimplementedby(self, value): self.reimplementedby.append(value) def insert_reimplementedby(self, index, value): self.reimplementedby[index] = value def get_param(self): return self.param def set_param(self, param): self.param = param def add_param(self, value): self.param.append(value) def insert_param(self, index, value): self.param[index] = value def get_enumvalue(self): return self.enumvalue def set_enumvalue(self, enumvalue): self.enumvalue = enumvalue def add_enumvalue(self, value): self.enumvalue.append(value) def insert_enumvalue(self, index, value): self.enumvalue[index] = value def get_initializer(self): return self.initializer def set_initializer(self, initializer): self.initializer = initializer def get_exceptions(self): return self.exceptions def set_exceptions(self, exceptions): self.exceptions = exceptions def get_briefdescription(self): return self.briefdescription def set_briefdescription(self, briefdescription): self.briefdescription = briefdescription def get_detaileddescription(self): return self.detaileddescription def set_detaileddescription(self, detaileddescription): self.detaileddescription = detaileddescription def get_inbodydescription(self): return self.inbodydescription def set_inbodydescription(self, inbodydescription): self.inbodydescription = inbodydescription def get_location(self): return self.location def set_location(self, location): self.location = location def get_references(self): return self.references def set_references(self, references): self.references = references def add_references(self, value): self.references.append(value) def insert_references(self, index, value): self.references[index] = value def get_referencedby(self): return self.referencedby def set_referencedby(self, referencedby): self.referencedby = referencedby def add_referencedby(self, value): self.referencedby.append(value) def insert_referencedby(self, index, value): self.referencedby[index] = value def get_initonly(self): return self.initonly def set_initonly(self, initonly): self.initonly = initonly def get_kind(self): return self.kind def set_kind(self, kind): self.kind = kind def get_volatile(self): return self.volatile def set_volatile(self, volatile): self.volatile = volatile def get_const(self): return self.const def set_const(self, const): self.const = const def get_raise(self): return self.raisexx def set_raise(self, raisexx): self.raisexx = raisexx def get_virt(self): return self.virt def set_virt(self, virt): self.virt = virt def get_readable(self): return self.readable def set_readable(self, readable): self.readable = readable def get_prot(self): return self.prot def set_prot(self, prot): self.prot = prot def get_explicit(self): return self.explicit def set_explicit(self, explicit): self.explicit = explicit def get_new(self): return self.new def set_new(self, new): self.new = new def get_final(self): return self.final def set_final(self, final): self.final = final def get_writable(self): return self.writable def set_writable(self, writable): self.writable = writable def get_add(self): return self.add def set_add(self, add): self.add = add def get_static(self): return self.static def set_static(self, static): self.static = static def get_remove(self): return self.remove def set_remove(self, remove): self.remove = remove def get_sealed(self): return self.sealed def set_sealed(self, sealed): self.sealed = sealed def get_mutable(self): return self.mutable def set_mutable(self, mutable): self.mutable = mutable def get_gettable(self): return self.gettable def set_gettable(self, gettable): self.gettable = gettable def get_inline(self): return self.inline def set_inline(self, inline): self.inline = inline def get_settable(self): return self.settable def set_settable(self, settable): self.settable = settable def get_id(self): return self.id def set_id(self, id): self.id = id def export(self, outfile, level, namespace_='', name_='memberdefType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='memberdefType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='memberdefType'): if self.initonly is not None: outfile.write(' initonly=%s' % (quote_attrib(self.initonly), )) if self.kind is not None: outfile.write(' kind=%s' % (quote_attrib(self.kind), )) if self.volatile is not None: outfile.write(' volatile=%s' % (quote_attrib(self.volatile), )) if self.const is not None: outfile.write(' const=%s' % (quote_attrib(self.const), )) if self.raisexx is not None: outfile.write(' raise=%s' % (quote_attrib(self.raisexx), )) if self.virt is not None: outfile.write(' virt=%s' % (quote_attrib(self.virt), )) if self.readable is not None: outfile.write(' readable=%s' % (quote_attrib(self.readable), )) if self.prot is not None: outfile.write(' prot=%s' % (quote_attrib(self.prot), )) if self.explicit is not None: outfile.write(' explicit=%s' % (quote_attrib(self.explicit), )) if self.new is not None: outfile.write(' new=%s' % (quote_attrib(self.new), )) if self.final is not None: outfile.write(' final=%s' % (quote_attrib(self.final), )) if self.writable is not None: outfile.write(' writable=%s' % (quote_attrib(self.writable), )) if self.add is not None: outfile.write(' add=%s' % (quote_attrib(self.add), )) if self.static is not None: outfile.write(' static=%s' % (quote_attrib(self.static), )) if self.remove is not None: outfile.write(' remove=%s' % (quote_attrib(self.remove), )) if self.sealed is not None: outfile.write(' sealed=%s' % (quote_attrib(self.sealed), )) if self.mutable is not None: outfile.write(' mutable=%s' % (quote_attrib(self.mutable), )) if self.gettable is not None: outfile.write(' gettable=%s' % (quote_attrib(self.gettable), )) if self.inline is not None: outfile.write(' inline=%s' % (quote_attrib(self.inline), )) if self.settable is not None: outfile.write(' settable=%s' % (quote_attrib(self.settable), )) if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='memberdefType'): if self.templateparamlist: self.templateparamlist.export(outfile, level, namespace_, name_='templateparamlist') if self.type_: self.type_.export(outfile, level, namespace_, name_='type') if self.definition is not None: showIndent(outfile, level) outfile.write('<%sdefinition>%s\n' % (namespace_, self.format_string(quote_xml(self.definition).encode(ExternalEncoding), input_name='definition'), namespace_)) if self.argsstring is not None: showIndent(outfile, level) outfile.write('<%sargsstring>%s\n' % (namespace_, self.format_string(quote_xml(self.argsstring).encode(ExternalEncoding), input_name='argsstring'), namespace_)) if self.name is not None: showIndent(outfile, level) outfile.write('<%sname>%s\n' % (namespace_, self.format_string(quote_xml(self.name).encode(ExternalEncoding), input_name='name'), namespace_)) if self.read is not None: showIndent(outfile, level) outfile.write('<%sread>%s\n' % (namespace_, self.format_string(quote_xml(self.read).encode(ExternalEncoding), input_name='read'), namespace_)) if self.write is not None: showIndent(outfile, level) outfile.write('<%swrite>%s\n' % (namespace_, self.format_string(quote_xml(self.write).encode(ExternalEncoding), input_name='write'), namespace_)) if self.bitfield is not None: showIndent(outfile, level) outfile.write('<%sbitfield>%s\n' % (namespace_, self.format_string(quote_xml(self.bitfield).encode(ExternalEncoding), input_name='bitfield'), namespace_)) for reimplements_ in self.reimplements: reimplements_.export(outfile, level, namespace_, name_='reimplements') for reimplementedby_ in self.reimplementedby: reimplementedby_.export(outfile, level, namespace_, name_='reimplementedby') for param_ in self.param: param_.export(outfile, level, namespace_, name_='param') for enumvalue_ in self.enumvalue: enumvalue_.export(outfile, level, namespace_, name_='enumvalue') if self.initializer: self.initializer.export(outfile, level, namespace_, name_='initializer') if self.exceptions: self.exceptions.export(outfile, level, namespace_, name_='exceptions') if self.briefdescription: self.briefdescription.export(outfile, level, namespace_, name_='briefdescription') if self.detaileddescription: self.detaileddescription.export(outfile, level, namespace_, name_='detaileddescription') if self.inbodydescription: self.inbodydescription.export(outfile, level, namespace_, name_='inbodydescription') if self.location: self.location.export(outfile, level, namespace_, name_='location', ) for references_ in self.references: references_.export(outfile, level, namespace_, name_='references') for referencedby_ in self.referencedby: referencedby_.export(outfile, level, namespace_, name_='referencedby') def hasContent_(self): if ( self.templateparamlist is not None or self.type_ is not None or self.definition is not None or self.argsstring is not None or self.name is not None or self.read is not None or self.write is not None or self.bitfield is not None or self.reimplements is not None or self.reimplementedby is not None or self.param is not None or self.enumvalue is not None or self.initializer is not None or self.exceptions is not None or self.briefdescription is not None or self.detaileddescription is not None or self.inbodydescription is not None or self.location is not None or self.references is not None or self.referencedby is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='memberdefType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.initonly is not None: showIndent(outfile, level) outfile.write('initonly = "%s",\n' % (self.initonly,)) if self.kind is not None: showIndent(outfile, level) outfile.write('kind = "%s",\n' % (self.kind,)) if self.volatile is not None: showIndent(outfile, level) outfile.write('volatile = "%s",\n' % (self.volatile,)) if self.const is not None: showIndent(outfile, level) outfile.write('const = "%s",\n' % (self.const,)) if self.raisexx is not None: showIndent(outfile, level) outfile.write('raisexx = "%s",\n' % (self.raisexx,)) if self.virt is not None: showIndent(outfile, level) outfile.write('virt = "%s",\n' % (self.virt,)) if self.readable is not None: showIndent(outfile, level) outfile.write('readable = "%s",\n' % (self.readable,)) if self.prot is not None: showIndent(outfile, level) outfile.write('prot = "%s",\n' % (self.prot,)) if self.explicit is not None: showIndent(outfile, level) outfile.write('explicit = "%s",\n' % (self.explicit,)) if self.new is not None: showIndent(outfile, level) outfile.write('new = "%s",\n' % (self.new,)) if self.final is not None: showIndent(outfile, level) outfile.write('final = "%s",\n' % (self.final,)) if self.writable is not None: showIndent(outfile, level) outfile.write('writable = "%s",\n' % (self.writable,)) if self.add is not None: showIndent(outfile, level) outfile.write('add = "%s",\n' % (self.add,)) if self.static is not None: showIndent(outfile, level) outfile.write('static = "%s",\n' % (self.static,)) if self.remove is not None: showIndent(outfile, level) outfile.write('remove = "%s",\n' % (self.remove,)) if self.sealed is not None: showIndent(outfile, level) outfile.write('sealed = "%s",\n' % (self.sealed,)) if self.mutable is not None: showIndent(outfile, level) outfile.write('mutable = "%s",\n' % (self.mutable,)) if self.gettable is not None: showIndent(outfile, level) outfile.write('gettable = "%s",\n' % (self.gettable,)) if self.inline is not None: showIndent(outfile, level) outfile.write('inline = "%s",\n' % (self.inline,)) if self.settable is not None: showIndent(outfile, level) outfile.write('settable = "%s",\n' % (self.settable,)) if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): if self.templateparamlist: showIndent(outfile, level) outfile.write('templateparamlist=model_.templateparamlistType(\n') self.templateparamlist.exportLiteral(outfile, level, name_='templateparamlist') showIndent(outfile, level) outfile.write('),\n') if self.type_: showIndent(outfile, level) outfile.write('type_=model_.linkedTextType(\n') self.type_.exportLiteral(outfile, level, name_='type') showIndent(outfile, level) outfile.write('),\n') showIndent(outfile, level) outfile.write('definition=%s,\n' % quote_python(self.definition).encode(ExternalEncoding)) showIndent(outfile, level) outfile.write('argsstring=%s,\n' % quote_python(self.argsstring).encode(ExternalEncoding)) showIndent(outfile, level) outfile.write('name=%s,\n' % quote_python(self.name).encode(ExternalEncoding)) showIndent(outfile, level) outfile.write('read=%s,\n' % quote_python(self.read).encode(ExternalEncoding)) showIndent(outfile, level) outfile.write('write=%s,\n' % quote_python(self.write).encode(ExternalEncoding)) showIndent(outfile, level) outfile.write('bitfield=%s,\n' % quote_python(self.bitfield).encode(ExternalEncoding)) showIndent(outfile, level) outfile.write('reimplements=[\n') level += 1 for reimplements in self.reimplements: showIndent(outfile, level) outfile.write('model_.reimplements(\n') reimplements.exportLiteral(outfile, level, name_='reimplements') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('reimplementedby=[\n') level += 1 for reimplementedby in self.reimplementedby: showIndent(outfile, level) outfile.write('model_.reimplementedby(\n') reimplementedby.exportLiteral(outfile, level, name_='reimplementedby') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('param=[\n') level += 1 for param in self.param: showIndent(outfile, level) outfile.write('model_.param(\n') param.exportLiteral(outfile, level, name_='param') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('enumvalue=[\n') level += 1 for enumvalue in self.enumvalue: showIndent(outfile, level) outfile.write('model_.enumvalue(\n') enumvalue.exportLiteral(outfile, level, name_='enumvalue') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') if self.initializer: showIndent(outfile, level) outfile.write('initializer=model_.linkedTextType(\n') self.initializer.exportLiteral(outfile, level, name_='initializer') showIndent(outfile, level) outfile.write('),\n') if self.exceptions: showIndent(outfile, level) outfile.write('exceptions=model_.linkedTextType(\n') self.exceptions.exportLiteral(outfile, level, name_='exceptions') showIndent(outfile, level) outfile.write('),\n') if self.briefdescription: showIndent(outfile, level) outfile.write('briefdescription=model_.descriptionType(\n') self.briefdescription.exportLiteral(outfile, level, name_='briefdescription') showIndent(outfile, level) outfile.write('),\n') if self.detaileddescription: showIndent(outfile, level) outfile.write('detaileddescription=model_.descriptionType(\n') self.detaileddescription.exportLiteral(outfile, level, name_='detaileddescription') showIndent(outfile, level) outfile.write('),\n') if self.inbodydescription: showIndent(outfile, level) outfile.write('inbodydescription=model_.descriptionType(\n') self.inbodydescription.exportLiteral(outfile, level, name_='inbodydescription') showIndent(outfile, level) outfile.write('),\n') if self.location: showIndent(outfile, level) outfile.write('location=model_.locationType(\n') self.location.exportLiteral(outfile, level, name_='location') showIndent(outfile, level) outfile.write('),\n') showIndent(outfile, level) outfile.write('references=[\n') level += 1 for references in self.references: showIndent(outfile, level) outfile.write('model_.references(\n') references.exportLiteral(outfile, level, name_='references') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('referencedby=[\n') level += 1 for referencedby in self.referencedby: showIndent(outfile, level) outfile.write('model_.referencedby(\n') referencedby.exportLiteral(outfile, level, name_='referencedby') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('initonly'): self.initonly = attrs.get('initonly').value if attrs.get('kind'): self.kind = attrs.get('kind').value if attrs.get('volatile'): self.volatile = attrs.get('volatile').value if attrs.get('const'): self.const = attrs.get('const').value if attrs.get('raise'): self.raisexx = attrs.get('raise').value if attrs.get('virt'): self.virt = attrs.get('virt').value if attrs.get('readable'): self.readable = attrs.get('readable').value if attrs.get('prot'): self.prot = attrs.get('prot').value if attrs.get('explicit'): self.explicit = attrs.get('explicit').value if attrs.get('new'): self.new = attrs.get('new').value if attrs.get('final'): self.final = attrs.get('final').value if attrs.get('writable'): self.writable = attrs.get('writable').value if attrs.get('add'): self.add = attrs.get('add').value if attrs.get('static'): self.static = attrs.get('static').value if attrs.get('remove'): self.remove = attrs.get('remove').value if attrs.get('sealed'): self.sealed = attrs.get('sealed').value if attrs.get('mutable'): self.mutable = attrs.get('mutable').value if attrs.get('gettable'): self.gettable = attrs.get('gettable').value if attrs.get('inline'): self.inline = attrs.get('inline').value if attrs.get('settable'): self.settable = attrs.get('settable').value if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'templateparamlist': obj_ = templateparamlistType.factory() obj_.build(child_) self.set_templateparamlist(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'type': obj_ = linkedTextType.factory() obj_.build(child_) self.set_type(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'definition': definition_ = '' for text__content_ in child_.childNodes: definition_ += text__content_.nodeValue self.definition = definition_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'argsstring': argsstring_ = '' for text__content_ in child_.childNodes: argsstring_ += text__content_.nodeValue self.argsstring = argsstring_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'name': name_ = '' for text__content_ in child_.childNodes: name_ += text__content_.nodeValue self.name = name_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'read': read_ = '' for text__content_ in child_.childNodes: read_ += text__content_.nodeValue self.read = read_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'write': write_ = '' for text__content_ in child_.childNodes: write_ += text__content_.nodeValue self.write = write_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'bitfield': bitfield_ = '' for text__content_ in child_.childNodes: bitfield_ += text__content_.nodeValue self.bitfield = bitfield_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'reimplements': obj_ = reimplementType.factory() obj_.build(child_) self.reimplements.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'reimplementedby': obj_ = reimplementType.factory() obj_.build(child_) self.reimplementedby.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'param': obj_ = paramType.factory() obj_.build(child_) self.param.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'enumvalue': obj_ = enumvalueType.factory() obj_.build(child_) self.enumvalue.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'initializer': obj_ = linkedTextType.factory() obj_.build(child_) self.set_initializer(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'exceptions': obj_ = linkedTextType.factory() obj_.build(child_) self.set_exceptions(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'briefdescription': obj_ = descriptionType.factory() obj_.build(child_) self.set_briefdescription(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'detaileddescription': obj_ = descriptionType.factory() obj_.build(child_) self.set_detaileddescription(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'inbodydescription': obj_ = descriptionType.factory() obj_.build(child_) self.set_inbodydescription(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'location': obj_ = locationType.factory() obj_.build(child_) self.set_location(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'references': obj_ = referenceType.factory() obj_.build(child_) self.references.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'referencedby': obj_ = referenceType.factory() obj_.build(child_) self.referencedby.append(obj_) # end class memberdefType class definition(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if definition.subclass: return definition.subclass(*args_, **kwargs_) else: return definition(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='definition', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='definition') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='definition'): pass def exportChildren(self, outfile, level, namespace_='', name_='definition'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='definition'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class definition class argsstring(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if argsstring.subclass: return argsstring.subclass(*args_, **kwargs_) else: return argsstring(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='argsstring', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='argsstring') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='argsstring'): pass def exportChildren(self, outfile, level, namespace_='', name_='argsstring'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='argsstring'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class argsstring class read(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if read.subclass: return read.subclass(*args_, **kwargs_) else: return read(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='read', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='read') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='read'): pass def exportChildren(self, outfile, level, namespace_='', name_='read'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='read'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class read class write(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if write.subclass: return write.subclass(*args_, **kwargs_) else: return write(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='write', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='write') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='write'): pass def exportChildren(self, outfile, level, namespace_='', name_='write'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='write'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class write class bitfield(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if bitfield.subclass: return bitfield.subclass(*args_, **kwargs_) else: return bitfield(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='bitfield', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='bitfield') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='bitfield'): pass def exportChildren(self, outfile, level, namespace_='', name_='bitfield'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='bitfield'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class bitfield class descriptionType(GeneratedsSuper): subclass = None superclass = None def __init__(self, title=None, para=None, sect1=None, internal=None, mixedclass_=None, content_=None): if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if descriptionType.subclass: return descriptionType.subclass(*args_, **kwargs_) else: return descriptionType(*args_, **kwargs_) factory = staticmethod(factory) def get_title(self): return self.title def set_title(self, title): self.title = title def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_sect1(self): return self.sect1 def set_sect1(self, sect1): self.sect1 = sect1 def add_sect1(self, value): self.sect1.append(value) def insert_sect1(self, index, value): self.sect1[index] = value def get_internal(self): return self.internal def set_internal(self, internal): self.internal = internal def export(self, outfile, level, namespace_='', name_='descriptionType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='descriptionType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='descriptionType'): pass def exportChildren(self, outfile, level, namespace_='', name_='descriptionType'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.title is not None or self.para is not None or self.sect1 is not None or self.internal is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='descriptionType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'title': childobj_ = docTitleType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'title', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': childobj_ = docParaType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'para', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'sect1': childobj_ = docSect1Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'sect1', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'internal': childobj_ = docInternalType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'internal', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class descriptionType class enumvalueType(GeneratedsSuper): subclass = None superclass = None def __init__(self, prot=None, id=None, name=None, initializer=None, briefdescription=None, detaileddescription=None, mixedclass_=None, content_=None): self.prot = prot self.id = id if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if enumvalueType.subclass: return enumvalueType.subclass(*args_, **kwargs_) else: return enumvalueType(*args_, **kwargs_) factory = staticmethod(factory) def get_name(self): return self.name def set_name(self, name): self.name = name def get_initializer(self): return self.initializer def set_initializer(self, initializer): self.initializer = initializer def get_briefdescription(self): return self.briefdescription def set_briefdescription(self, briefdescription): self.briefdescription = briefdescription def get_detaileddescription(self): return self.detaileddescription def set_detaileddescription(self, detaileddescription): self.detaileddescription = detaileddescription def get_prot(self): return self.prot def set_prot(self, prot): self.prot = prot def get_id(self): return self.id def set_id(self, id): self.id = id def export(self, outfile, level, namespace_='', name_='enumvalueType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='enumvalueType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='enumvalueType'): if self.prot is not None: outfile.write(' prot=%s' % (quote_attrib(self.prot), )) if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='enumvalueType'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.name is not None or self.initializer is not None or self.briefdescription is not None or self.detaileddescription is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='enumvalueType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.prot is not None: showIndent(outfile, level) outfile.write('prot = "%s",\n' % (self.prot,)) if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('prot'): self.prot = attrs.get('prot').value if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'name': value_ = [] for text_ in child_.childNodes: value_.append(text_.nodeValue) valuestr_ = ''.join(value_) obj_ = self.mixedclass_(MixedContainer.CategorySimple, MixedContainer.TypeString, 'name', valuestr_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'initializer': childobj_ = linkedTextType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'initializer', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'briefdescription': childobj_ = descriptionType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'briefdescription', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'detaileddescription': childobj_ = descriptionType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'detaileddescription', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class enumvalueType class templateparamlistType(GeneratedsSuper): subclass = None superclass = None def __init__(self, param=None): if param is None: self.param = [] else: self.param = param def factory(*args_, **kwargs_): if templateparamlistType.subclass: return templateparamlistType.subclass(*args_, **kwargs_) else: return templateparamlistType(*args_, **kwargs_) factory = staticmethod(factory) def get_param(self): return self.param def set_param(self, param): self.param = param def add_param(self, value): self.param.append(value) def insert_param(self, index, value): self.param[index] = value def export(self, outfile, level, namespace_='', name_='templateparamlistType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='templateparamlistType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='templateparamlistType'): pass def exportChildren(self, outfile, level, namespace_='', name_='templateparamlistType'): for param_ in self.param: param_.export(outfile, level, namespace_, name_='param') def hasContent_(self): if ( self.param is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='templateparamlistType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('param=[\n') level += 1 for param in self.param: showIndent(outfile, level) outfile.write('model_.param(\n') param.exportLiteral(outfile, level, name_='param') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'param': obj_ = paramType.factory() obj_.build(child_) self.param.append(obj_) # end class templateparamlistType class paramType(GeneratedsSuper): subclass = None superclass = None def __init__(self, type_=None, declname=None, defname=None, array=None, defval=None, briefdescription=None): self.type_ = type_ self.declname = declname self.defname = defname self.array = array self.defval = defval self.briefdescription = briefdescription def factory(*args_, **kwargs_): if paramType.subclass: return paramType.subclass(*args_, **kwargs_) else: return paramType(*args_, **kwargs_) factory = staticmethod(factory) def get_type(self): return self.type_ def set_type(self, type_): self.type_ = type_ def get_declname(self): return self.declname def set_declname(self, declname): self.declname = declname def get_defname(self): return self.defname def set_defname(self, defname): self.defname = defname def get_array(self): return self.array def set_array(self, array): self.array = array def get_defval(self): return self.defval def set_defval(self, defval): self.defval = defval def get_briefdescription(self): return self.briefdescription def set_briefdescription(self, briefdescription): self.briefdescription = briefdescription def export(self, outfile, level, namespace_='', name_='paramType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='paramType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='paramType'): pass def exportChildren(self, outfile, level, namespace_='', name_='paramType'): if self.type_: self.type_.export(outfile, level, namespace_, name_='type') if self.declname is not None: showIndent(outfile, level) outfile.write('<%sdeclname>%s\n' % (namespace_, self.format_string(quote_xml(self.declname).encode(ExternalEncoding), input_name='declname'), namespace_)) if self.defname is not None: showIndent(outfile, level) outfile.write('<%sdefname>%s\n' % (namespace_, self.format_string(quote_xml(self.defname).encode(ExternalEncoding), input_name='defname'), namespace_)) if self.array is not None: showIndent(outfile, level) outfile.write('<%sarray>%s\n' % (namespace_, self.format_string(quote_xml(self.array).encode(ExternalEncoding), input_name='array'), namespace_)) if self.defval: self.defval.export(outfile, level, namespace_, name_='defval') if self.briefdescription: self.briefdescription.export(outfile, level, namespace_, name_='briefdescription') def hasContent_(self): if ( self.type_ is not None or self.declname is not None or self.defname is not None or self.array is not None or self.defval is not None or self.briefdescription is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='paramType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): if self.type_: showIndent(outfile, level) outfile.write('type_=model_.linkedTextType(\n') self.type_.exportLiteral(outfile, level, name_='type') showIndent(outfile, level) outfile.write('),\n') showIndent(outfile, level) outfile.write('declname=%s,\n' % quote_python(self.declname).encode(ExternalEncoding)) showIndent(outfile, level) outfile.write('defname=%s,\n' % quote_python(self.defname).encode(ExternalEncoding)) showIndent(outfile, level) outfile.write('array=%s,\n' % quote_python(self.array).encode(ExternalEncoding)) if self.defval: showIndent(outfile, level) outfile.write('defval=model_.linkedTextType(\n') self.defval.exportLiteral(outfile, level, name_='defval') showIndent(outfile, level) outfile.write('),\n') if self.briefdescription: showIndent(outfile, level) outfile.write('briefdescription=model_.descriptionType(\n') self.briefdescription.exportLiteral(outfile, level, name_='briefdescription') showIndent(outfile, level) outfile.write('),\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'type': obj_ = linkedTextType.factory() obj_.build(child_) self.set_type(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'declname': declname_ = '' for text__content_ in child_.childNodes: declname_ += text__content_.nodeValue self.declname = declname_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'defname': defname_ = '' for text__content_ in child_.childNodes: defname_ += text__content_.nodeValue self.defname = defname_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'array': array_ = '' for text__content_ in child_.childNodes: array_ += text__content_.nodeValue self.array = array_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'defval': obj_ = linkedTextType.factory() obj_.build(child_) self.set_defval(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'briefdescription': obj_ = descriptionType.factory() obj_.build(child_) self.set_briefdescription(obj_) # end class paramType class declname(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if declname.subclass: return declname.subclass(*args_, **kwargs_) else: return declname(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='declname', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='declname') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='declname'): pass def exportChildren(self, outfile, level, namespace_='', name_='declname'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='declname'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class declname class defname(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if defname.subclass: return defname.subclass(*args_, **kwargs_) else: return defname(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='defname', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='defname') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='defname'): pass def exportChildren(self, outfile, level, namespace_='', name_='defname'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='defname'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class defname class array(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if array.subclass: return array.subclass(*args_, **kwargs_) else: return array(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='array', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='array') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='array'): pass def exportChildren(self, outfile, level, namespace_='', name_='array'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='array'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class array class linkedTextType(GeneratedsSuper): subclass = None superclass = None def __init__(self, ref=None, mixedclass_=None, content_=None): if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if linkedTextType.subclass: return linkedTextType.subclass(*args_, **kwargs_) else: return linkedTextType(*args_, **kwargs_) factory = staticmethod(factory) def get_ref(self): return self.ref def set_ref(self, ref): self.ref = ref def add_ref(self, value): self.ref.append(value) def insert_ref(self, index, value): self.ref[index] = value def export(self, outfile, level, namespace_='', name_='linkedTextType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='linkedTextType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='linkedTextType'): pass def exportChildren(self, outfile, level, namespace_='', name_='linkedTextType'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.ref is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='linkedTextType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'ref': childobj_ = docRefTextType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'ref', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class linkedTextType class graphType(GeneratedsSuper): subclass = None superclass = None def __init__(self, node=None): if node is None: self.node = [] else: self.node = node def factory(*args_, **kwargs_): if graphType.subclass: return graphType.subclass(*args_, **kwargs_) else: return graphType(*args_, **kwargs_) factory = staticmethod(factory) def get_node(self): return self.node def set_node(self, node): self.node = node def add_node(self, value): self.node.append(value) def insert_node(self, index, value): self.node[index] = value def export(self, outfile, level, namespace_='', name_='graphType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='graphType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='graphType'): pass def exportChildren(self, outfile, level, namespace_='', name_='graphType'): for node_ in self.node: node_.export(outfile, level, namespace_, name_='node') def hasContent_(self): if ( self.node is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='graphType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('node=[\n') level += 1 for node in self.node: showIndent(outfile, level) outfile.write('model_.node(\n') node.exportLiteral(outfile, level, name_='node') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'node': obj_ = nodeType.factory() obj_.build(child_) self.node.append(obj_) # end class graphType class nodeType(GeneratedsSuper): subclass = None superclass = None def __init__(self, id=None, label=None, link=None, childnode=None): self.id = id self.label = label self.link = link if childnode is None: self.childnode = [] else: self.childnode = childnode def factory(*args_, **kwargs_): if nodeType.subclass: return nodeType.subclass(*args_, **kwargs_) else: return nodeType(*args_, **kwargs_) factory = staticmethod(factory) def get_label(self): return self.label def set_label(self, label): self.label = label def get_link(self): return self.link def set_link(self, link): self.link = link def get_childnode(self): return self.childnode def set_childnode(self, childnode): self.childnode = childnode def add_childnode(self, value): self.childnode.append(value) def insert_childnode(self, index, value): self.childnode[index] = value def get_id(self): return self.id def set_id(self, id): self.id = id def export(self, outfile, level, namespace_='', name_='nodeType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='nodeType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='nodeType'): if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='nodeType'): if self.label is not None: showIndent(outfile, level) outfile.write('<%slabel>%s\n' % (namespace_, self.format_string(quote_xml(self.label).encode(ExternalEncoding), input_name='label'), namespace_)) if self.link: self.link.export(outfile, level, namespace_, name_='link') for childnode_ in self.childnode: childnode_.export(outfile, level, namespace_, name_='childnode') def hasContent_(self): if ( self.label is not None or self.link is not None or self.childnode is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='nodeType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('label=%s,\n' % quote_python(self.label).encode(ExternalEncoding)) if self.link: showIndent(outfile, level) outfile.write('link=model_.linkType(\n') self.link.exportLiteral(outfile, level, name_='link') showIndent(outfile, level) outfile.write('),\n') showIndent(outfile, level) outfile.write('childnode=[\n') level += 1 for childnode in self.childnode: showIndent(outfile, level) outfile.write('model_.childnode(\n') childnode.exportLiteral(outfile, level, name_='childnode') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'label': label_ = '' for text__content_ in child_.childNodes: label_ += text__content_.nodeValue self.label = label_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'link': obj_ = linkType.factory() obj_.build(child_) self.set_link(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'childnode': obj_ = childnodeType.factory() obj_.build(child_) self.childnode.append(obj_) # end class nodeType class label(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if label.subclass: return label.subclass(*args_, **kwargs_) else: return label(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='label', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='label') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='label'): pass def exportChildren(self, outfile, level, namespace_='', name_='label'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='label'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class label class childnodeType(GeneratedsSuper): subclass = None superclass = None def __init__(self, relation=None, refid=None, edgelabel=None): self.relation = relation self.refid = refid if edgelabel is None: self.edgelabel = [] else: self.edgelabel = edgelabel def factory(*args_, **kwargs_): if childnodeType.subclass: return childnodeType.subclass(*args_, **kwargs_) else: return childnodeType(*args_, **kwargs_) factory = staticmethod(factory) def get_edgelabel(self): return self.edgelabel def set_edgelabel(self, edgelabel): self.edgelabel = edgelabel def add_edgelabel(self, value): self.edgelabel.append(value) def insert_edgelabel(self, index, value): self.edgelabel[index] = value def get_relation(self): return self.relation def set_relation(self, relation): self.relation = relation def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def export(self, outfile, level, namespace_='', name_='childnodeType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='childnodeType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='childnodeType'): if self.relation is not None: outfile.write(' relation=%s' % (quote_attrib(self.relation), )) if self.refid is not None: outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) def exportChildren(self, outfile, level, namespace_='', name_='childnodeType'): for edgelabel_ in self.edgelabel: showIndent(outfile, level) outfile.write('<%sedgelabel>%s\n' % (namespace_, self.format_string(quote_xml(edgelabel_).encode(ExternalEncoding), input_name='edgelabel'), namespace_)) def hasContent_(self): if ( self.edgelabel is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='childnodeType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.relation is not None: showIndent(outfile, level) outfile.write('relation = "%s",\n' % (self.relation,)) if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('edgelabel=[\n') level += 1 for edgelabel in self.edgelabel: showIndent(outfile, level) outfile.write('%s,\n' % quote_python(edgelabel).encode(ExternalEncoding)) level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('relation'): self.relation = attrs.get('relation').value if attrs.get('refid'): self.refid = attrs.get('refid').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'edgelabel': edgelabel_ = '' for text__content_ in child_.childNodes: edgelabel_ += text__content_.nodeValue self.edgelabel.append(edgelabel_) # end class childnodeType class edgelabel(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if edgelabel.subclass: return edgelabel.subclass(*args_, **kwargs_) else: return edgelabel(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='edgelabel', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='edgelabel') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='edgelabel'): pass def exportChildren(self, outfile, level, namespace_='', name_='edgelabel'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='edgelabel'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class edgelabel class linkType(GeneratedsSuper): subclass = None superclass = None def __init__(self, refid=None, external=None, valueOf_=''): self.refid = refid self.external = external self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if linkType.subclass: return linkType.subclass(*args_, **kwargs_) else: return linkType(*args_, **kwargs_) factory = staticmethod(factory) def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def get_external(self): return self.external def set_external(self, external): self.external = external def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='linkType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='linkType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='linkType'): if self.refid is not None: outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) if self.external is not None: outfile.write(' external=%s' % (self.format_string(quote_attrib(self.external).encode(ExternalEncoding), input_name='external'), )) def exportChildren(self, outfile, level, namespace_='', name_='linkType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='linkType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) if self.external is not None: showIndent(outfile, level) outfile.write('external = %s,\n' % (self.external,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('refid'): self.refid = attrs.get('refid').value if attrs.get('external'): self.external = attrs.get('external').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class linkType class listingType(GeneratedsSuper): subclass = None superclass = None def __init__(self, codeline=None): if codeline is None: self.codeline = [] else: self.codeline = codeline def factory(*args_, **kwargs_): if listingType.subclass: return listingType.subclass(*args_, **kwargs_) else: return listingType(*args_, **kwargs_) factory = staticmethod(factory) def get_codeline(self): return self.codeline def set_codeline(self, codeline): self.codeline = codeline def add_codeline(self, value): self.codeline.append(value) def insert_codeline(self, index, value): self.codeline[index] = value def export(self, outfile, level, namespace_='', name_='listingType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='listingType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='listingType'): pass def exportChildren(self, outfile, level, namespace_='', name_='listingType'): for codeline_ in self.codeline: codeline_.export(outfile, level, namespace_, name_='codeline') def hasContent_(self): if ( self.codeline is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='listingType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('codeline=[\n') level += 1 for codeline in self.codeline: showIndent(outfile, level) outfile.write('model_.codeline(\n') codeline.exportLiteral(outfile, level, name_='codeline') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'codeline': obj_ = codelineType.factory() obj_.build(child_) self.codeline.append(obj_) # end class listingType class codelineType(GeneratedsSuper): subclass = None superclass = None def __init__(self, external=None, lineno=None, refkind=None, refid=None, highlight=None): self.external = external self.lineno = lineno self.refkind = refkind self.refid = refid if highlight is None: self.highlight = [] else: self.highlight = highlight def factory(*args_, **kwargs_): if codelineType.subclass: return codelineType.subclass(*args_, **kwargs_) else: return codelineType(*args_, **kwargs_) factory = staticmethod(factory) def get_highlight(self): return self.highlight def set_highlight(self, highlight): self.highlight = highlight def add_highlight(self, value): self.highlight.append(value) def insert_highlight(self, index, value): self.highlight[index] = value def get_external(self): return self.external def set_external(self, external): self.external = external def get_lineno(self): return self.lineno def set_lineno(self, lineno): self.lineno = lineno def get_refkind(self): return self.refkind def set_refkind(self, refkind): self.refkind = refkind def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def export(self, outfile, level, namespace_='', name_='codelineType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='codelineType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='codelineType'): if self.external is not None: outfile.write(' external=%s' % (quote_attrib(self.external), )) if self.lineno is not None: outfile.write(' lineno="%s"' % self.format_integer(self.lineno, input_name='lineno')) if self.refkind is not None: outfile.write(' refkind=%s' % (quote_attrib(self.refkind), )) if self.refid is not None: outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) def exportChildren(self, outfile, level, namespace_='', name_='codelineType'): for highlight_ in self.highlight: highlight_.export(outfile, level, namespace_, name_='highlight') def hasContent_(self): if ( self.highlight is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='codelineType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.external is not None: showIndent(outfile, level) outfile.write('external = "%s",\n' % (self.external,)) if self.lineno is not None: showIndent(outfile, level) outfile.write('lineno = %s,\n' % (self.lineno,)) if self.refkind is not None: showIndent(outfile, level) outfile.write('refkind = "%s",\n' % (self.refkind,)) if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('highlight=[\n') level += 1 for highlight in self.highlight: showIndent(outfile, level) outfile.write('model_.highlight(\n') highlight.exportLiteral(outfile, level, name_='highlight') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('external'): self.external = attrs.get('external').value if attrs.get('lineno'): try: self.lineno = int(attrs.get('lineno').value) except ValueError, exp: raise ValueError('Bad integer attribute (lineno): %s' % exp) if attrs.get('refkind'): self.refkind = attrs.get('refkind').value if attrs.get('refid'): self.refid = attrs.get('refid').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'highlight': obj_ = highlightType.factory() obj_.build(child_) self.highlight.append(obj_) # end class codelineType class highlightType(GeneratedsSuper): subclass = None superclass = None def __init__(self, classxx=None, sp=None, ref=None, mixedclass_=None, content_=None): self.classxx = classxx if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if highlightType.subclass: return highlightType.subclass(*args_, **kwargs_) else: return highlightType(*args_, **kwargs_) factory = staticmethod(factory) def get_sp(self): return self.sp def set_sp(self, sp): self.sp = sp def add_sp(self, value): self.sp.append(value) def insert_sp(self, index, value): self.sp[index] = value def get_ref(self): return self.ref def set_ref(self, ref): self.ref = ref def add_ref(self, value): self.ref.append(value) def insert_ref(self, index, value): self.ref[index] = value def get_class(self): return self.classxx def set_class(self, classxx): self.classxx = classxx def export(self, outfile, level, namespace_='', name_='highlightType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='highlightType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='highlightType'): if self.classxx is not None: outfile.write(' class=%s' % (quote_attrib(self.classxx), )) def exportChildren(self, outfile, level, namespace_='', name_='highlightType'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.sp is not None or self.ref is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='highlightType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.classxx is not None: showIndent(outfile, level) outfile.write('classxx = "%s",\n' % (self.classxx,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('class'): self.classxx = attrs.get('class').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'sp': value_ = [] for text_ in child_.childNodes: value_.append(text_.nodeValue) valuestr_ = ''.join(value_) obj_ = self.mixedclass_(MixedContainer.CategorySimple, MixedContainer.TypeString, 'sp', valuestr_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'ref': childobj_ = docRefTextType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'ref', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class highlightType class sp(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if sp.subclass: return sp.subclass(*args_, **kwargs_) else: return sp(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='sp', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='sp') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='sp'): pass def exportChildren(self, outfile, level, namespace_='', name_='sp'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='sp'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class sp class referenceType(GeneratedsSuper): subclass = None superclass = None def __init__(self, endline=None, startline=None, refid=None, compoundref=None, valueOf_='', mixedclass_=None, content_=None): self.endline = endline self.startline = startline self.refid = refid self.compoundref = compoundref if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if referenceType.subclass: return referenceType.subclass(*args_, **kwargs_) else: return referenceType(*args_, **kwargs_) factory = staticmethod(factory) def get_endline(self): return self.endline def set_endline(self, endline): self.endline = endline def get_startline(self): return self.startline def set_startline(self, startline): self.startline = startline def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def get_compoundref(self): return self.compoundref def set_compoundref(self, compoundref): self.compoundref = compoundref def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='referenceType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='referenceType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='referenceType'): if self.endline is not None: outfile.write(' endline="%s"' % self.format_integer(self.endline, input_name='endline')) if self.startline is not None: outfile.write(' startline="%s"' % self.format_integer(self.startline, input_name='startline')) if self.refid is not None: outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) if self.compoundref is not None: outfile.write(' compoundref=%s' % (self.format_string(quote_attrib(self.compoundref).encode(ExternalEncoding), input_name='compoundref'), )) def exportChildren(self, outfile, level, namespace_='', name_='referenceType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='referenceType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.endline is not None: showIndent(outfile, level) outfile.write('endline = %s,\n' % (self.endline,)) if self.startline is not None: showIndent(outfile, level) outfile.write('startline = %s,\n' % (self.startline,)) if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) if self.compoundref is not None: showIndent(outfile, level) outfile.write('compoundref = %s,\n' % (self.compoundref,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('endline'): try: self.endline = int(attrs.get('endline').value) except ValueError, exp: raise ValueError('Bad integer attribute (endline): %s' % exp) if attrs.get('startline'): try: self.startline = int(attrs.get('startline').value) except ValueError, exp: raise ValueError('Bad integer attribute (startline): %s' % exp) if attrs.get('refid'): self.refid = attrs.get('refid').value if attrs.get('compoundref'): self.compoundref = attrs.get('compoundref').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class referenceType class locationType(GeneratedsSuper): subclass = None superclass = None def __init__(self, bodystart=None, line=None, bodyend=None, bodyfile=None, file=None, valueOf_=''): self.bodystart = bodystart self.line = line self.bodyend = bodyend self.bodyfile = bodyfile self.file = file self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if locationType.subclass: return locationType.subclass(*args_, **kwargs_) else: return locationType(*args_, **kwargs_) factory = staticmethod(factory) def get_bodystart(self): return self.bodystart def set_bodystart(self, bodystart): self.bodystart = bodystart def get_line(self): return self.line def set_line(self, line): self.line = line def get_bodyend(self): return self.bodyend def set_bodyend(self, bodyend): self.bodyend = bodyend def get_bodyfile(self): return self.bodyfile def set_bodyfile(self, bodyfile): self.bodyfile = bodyfile def get_file(self): return self.file def set_file(self, file): self.file = file def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='locationType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='locationType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='locationType'): if self.bodystart is not None: outfile.write(' bodystart="%s"' % self.format_integer(self.bodystart, input_name='bodystart')) if self.line is not None: outfile.write(' line="%s"' % self.format_integer(self.line, input_name='line')) if self.bodyend is not None: outfile.write(' bodyend="%s"' % self.format_integer(self.bodyend, input_name='bodyend')) if self.bodyfile is not None: outfile.write(' bodyfile=%s' % (self.format_string(quote_attrib(self.bodyfile).encode(ExternalEncoding), input_name='bodyfile'), )) if self.file is not None: outfile.write(' file=%s' % (self.format_string(quote_attrib(self.file).encode(ExternalEncoding), input_name='file'), )) def exportChildren(self, outfile, level, namespace_='', name_='locationType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='locationType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.bodystart is not None: showIndent(outfile, level) outfile.write('bodystart = %s,\n' % (self.bodystart,)) if self.line is not None: showIndent(outfile, level) outfile.write('line = %s,\n' % (self.line,)) if self.bodyend is not None: showIndent(outfile, level) outfile.write('bodyend = %s,\n' % (self.bodyend,)) if self.bodyfile is not None: showIndent(outfile, level) outfile.write('bodyfile = %s,\n' % (self.bodyfile,)) if self.file is not None: showIndent(outfile, level) outfile.write('file = %s,\n' % (self.file,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('bodystart'): try: self.bodystart = int(attrs.get('bodystart').value) except ValueError, exp: raise ValueError('Bad integer attribute (bodystart): %s' % exp) if attrs.get('line'): try: self.line = int(attrs.get('line').value) except ValueError, exp: raise ValueError('Bad integer attribute (line): %s' % exp) if attrs.get('bodyend'): try: self.bodyend = int(attrs.get('bodyend').value) except ValueError, exp: raise ValueError('Bad integer attribute (bodyend): %s' % exp) if attrs.get('bodyfile'): self.bodyfile = attrs.get('bodyfile').value if attrs.get('file'): self.file = attrs.get('file').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class locationType class docSect1Type(GeneratedsSuper): subclass = None superclass = None def __init__(self, id=None, title=None, para=None, sect2=None, internal=None, mixedclass_=None, content_=None): self.id = id if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docSect1Type.subclass: return docSect1Type.subclass(*args_, **kwargs_) else: return docSect1Type(*args_, **kwargs_) factory = staticmethod(factory) def get_title(self): return self.title def set_title(self, title): self.title = title def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_sect2(self): return self.sect2 def set_sect2(self, sect2): self.sect2 = sect2 def add_sect2(self, value): self.sect2.append(value) def insert_sect2(self, index, value): self.sect2[index] = value def get_internal(self): return self.internal def set_internal(self, internal): self.internal = internal def get_id(self): return self.id def set_id(self, id): self.id = id def export(self, outfile, level, namespace_='', name_='docSect1Type', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docSect1Type') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docSect1Type'): if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='docSect1Type'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.title is not None or self.para is not None or self.sect2 is not None or self.internal is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docSect1Type'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'title': childobj_ = docTitleType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'title', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': childobj_ = docParaType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'para', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'sect2': childobj_ = docSect2Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'sect2', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'internal': childobj_ = docInternalS1Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'internal', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class docSect1Type class docSect2Type(GeneratedsSuper): subclass = None superclass = None def __init__(self, id=None, title=None, para=None, sect3=None, internal=None, mixedclass_=None, content_=None): self.id = id if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docSect2Type.subclass: return docSect2Type.subclass(*args_, **kwargs_) else: return docSect2Type(*args_, **kwargs_) factory = staticmethod(factory) def get_title(self): return self.title def set_title(self, title): self.title = title def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_sect3(self): return self.sect3 def set_sect3(self, sect3): self.sect3 = sect3 def add_sect3(self, value): self.sect3.append(value) def insert_sect3(self, index, value): self.sect3[index] = value def get_internal(self): return self.internal def set_internal(self, internal): self.internal = internal def get_id(self): return self.id def set_id(self, id): self.id = id def export(self, outfile, level, namespace_='', name_='docSect2Type', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docSect2Type') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docSect2Type'): if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='docSect2Type'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.title is not None or self.para is not None or self.sect3 is not None or self.internal is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docSect2Type'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'title': childobj_ = docTitleType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'title', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': childobj_ = docParaType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'para', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'sect3': childobj_ = docSect3Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'sect3', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'internal': childobj_ = docInternalS2Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'internal', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class docSect2Type class docSect3Type(GeneratedsSuper): subclass = None superclass = None def __init__(self, id=None, title=None, para=None, sect4=None, internal=None, mixedclass_=None, content_=None): self.id = id if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docSect3Type.subclass: return docSect3Type.subclass(*args_, **kwargs_) else: return docSect3Type(*args_, **kwargs_) factory = staticmethod(factory) def get_title(self): return self.title def set_title(self, title): self.title = title def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_sect4(self): return self.sect4 def set_sect4(self, sect4): self.sect4 = sect4 def add_sect4(self, value): self.sect4.append(value) def insert_sect4(self, index, value): self.sect4[index] = value def get_internal(self): return self.internal def set_internal(self, internal): self.internal = internal def get_id(self): return self.id def set_id(self, id): self.id = id def export(self, outfile, level, namespace_='', name_='docSect3Type', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docSect3Type') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docSect3Type'): if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='docSect3Type'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.title is not None or self.para is not None or self.sect4 is not None or self.internal is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docSect3Type'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'title': childobj_ = docTitleType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'title', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': childobj_ = docParaType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'para', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'sect4': childobj_ = docSect4Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'sect4', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'internal': childobj_ = docInternalS3Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'internal', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class docSect3Type class docSect4Type(GeneratedsSuper): subclass = None superclass = None def __init__(self, id=None, title=None, para=None, internal=None, mixedclass_=None, content_=None): self.id = id if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docSect4Type.subclass: return docSect4Type.subclass(*args_, **kwargs_) else: return docSect4Type(*args_, **kwargs_) factory = staticmethod(factory) def get_title(self): return self.title def set_title(self, title): self.title = title def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_internal(self): return self.internal def set_internal(self, internal): self.internal = internal def get_id(self): return self.id def set_id(self, id): self.id = id def export(self, outfile, level, namespace_='', name_='docSect4Type', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docSect4Type') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docSect4Type'): if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='docSect4Type'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.title is not None or self.para is not None or self.internal is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docSect4Type'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'title': childobj_ = docTitleType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'title', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': childobj_ = docParaType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'para', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'internal': childobj_ = docInternalS4Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'internal', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class docSect4Type class docInternalType(GeneratedsSuper): subclass = None superclass = None def __init__(self, para=None, sect1=None, mixedclass_=None, content_=None): if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docInternalType.subclass: return docInternalType.subclass(*args_, **kwargs_) else: return docInternalType(*args_, **kwargs_) factory = staticmethod(factory) def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_sect1(self): return self.sect1 def set_sect1(self, sect1): self.sect1 = sect1 def add_sect1(self, value): self.sect1.append(value) def insert_sect1(self, index, value): self.sect1[index] = value def export(self, outfile, level, namespace_='', name_='docInternalType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docInternalType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docInternalType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docInternalType'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.para is not None or self.sect1 is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docInternalType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': childobj_ = docParaType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'para', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'sect1': childobj_ = docSect1Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'sect1', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class docInternalType class docInternalS1Type(GeneratedsSuper): subclass = None superclass = None def __init__(self, para=None, sect2=None, mixedclass_=None, content_=None): if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docInternalS1Type.subclass: return docInternalS1Type.subclass(*args_, **kwargs_) else: return docInternalS1Type(*args_, **kwargs_) factory = staticmethod(factory) def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_sect2(self): return self.sect2 def set_sect2(self, sect2): self.sect2 = sect2 def add_sect2(self, value): self.sect2.append(value) def insert_sect2(self, index, value): self.sect2[index] = value def export(self, outfile, level, namespace_='', name_='docInternalS1Type', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docInternalS1Type') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docInternalS1Type'): pass def exportChildren(self, outfile, level, namespace_='', name_='docInternalS1Type'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.para is not None or self.sect2 is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docInternalS1Type'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': childobj_ = docParaType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'para', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'sect2': childobj_ = docSect2Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'sect2', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class docInternalS1Type class docInternalS2Type(GeneratedsSuper): subclass = None superclass = None def __init__(self, para=None, sect3=None, mixedclass_=None, content_=None): if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docInternalS2Type.subclass: return docInternalS2Type.subclass(*args_, **kwargs_) else: return docInternalS2Type(*args_, **kwargs_) factory = staticmethod(factory) def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_sect3(self): return self.sect3 def set_sect3(self, sect3): self.sect3 = sect3 def add_sect3(self, value): self.sect3.append(value) def insert_sect3(self, index, value): self.sect3[index] = value def export(self, outfile, level, namespace_='', name_='docInternalS2Type', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docInternalS2Type') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docInternalS2Type'): pass def exportChildren(self, outfile, level, namespace_='', name_='docInternalS2Type'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.para is not None or self.sect3 is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docInternalS2Type'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': childobj_ = docParaType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'para', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'sect3': childobj_ = docSect3Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'sect3', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class docInternalS2Type class docInternalS3Type(GeneratedsSuper): subclass = None superclass = None def __init__(self, para=None, sect3=None, mixedclass_=None, content_=None): if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docInternalS3Type.subclass: return docInternalS3Type.subclass(*args_, **kwargs_) else: return docInternalS3Type(*args_, **kwargs_) factory = staticmethod(factory) def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_sect3(self): return self.sect3 def set_sect3(self, sect3): self.sect3 = sect3 def add_sect3(self, value): self.sect3.append(value) def insert_sect3(self, index, value): self.sect3[index] = value def export(self, outfile, level, namespace_='', name_='docInternalS3Type', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docInternalS3Type') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docInternalS3Type'): pass def exportChildren(self, outfile, level, namespace_='', name_='docInternalS3Type'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.para is not None or self.sect3 is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docInternalS3Type'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': childobj_ = docParaType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'para', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'sect3': childobj_ = docSect4Type.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'sect3', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class docInternalS3Type class docInternalS4Type(GeneratedsSuper): subclass = None superclass = None def __init__(self, para=None, mixedclass_=None, content_=None): if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docInternalS4Type.subclass: return docInternalS4Type.subclass(*args_, **kwargs_) else: return docInternalS4Type(*args_, **kwargs_) factory = staticmethod(factory) def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def export(self, outfile, level, namespace_='', name_='docInternalS4Type', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docInternalS4Type') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docInternalS4Type'): pass def exportChildren(self, outfile, level, namespace_='', name_='docInternalS4Type'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.para is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docInternalS4Type'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': childobj_ = docParaType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'para', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class docInternalS4Type class docTitleType(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_='', mixedclass_=None, content_=None): if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docTitleType.subclass: return docTitleType.subclass(*args_, **kwargs_) else: return docTitleType(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docTitleType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docTitleType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docTitleType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docTitleType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docTitleType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docTitleType class docParaType(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_='', mixedclass_=None, content_=None): if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docParaType.subclass: return docParaType.subclass(*args_, **kwargs_) else: return docParaType(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docParaType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docParaType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docParaType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docParaType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docParaType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docParaType class docMarkupType(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_='', mixedclass_=None, content_=None): if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docMarkupType.subclass: return docMarkupType.subclass(*args_, **kwargs_) else: return docMarkupType(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docMarkupType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docMarkupType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docMarkupType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docMarkupType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docMarkupType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docMarkupType class docURLLink(GeneratedsSuper): subclass = None superclass = None def __init__(self, url=None, valueOf_='', mixedclass_=None, content_=None): self.url = url if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docURLLink.subclass: return docURLLink.subclass(*args_, **kwargs_) else: return docURLLink(*args_, **kwargs_) factory = staticmethod(factory) def get_url(self): return self.url def set_url(self, url): self.url = url def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docURLLink', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docURLLink') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docURLLink'): if self.url is not None: outfile.write(' url=%s' % (self.format_string(quote_attrib(self.url).encode(ExternalEncoding), input_name='url'), )) def exportChildren(self, outfile, level, namespace_='', name_='docURLLink'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docURLLink'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.url is not None: showIndent(outfile, level) outfile.write('url = %s,\n' % (self.url,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('url'): self.url = attrs.get('url').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docURLLink class docAnchorType(GeneratedsSuper): subclass = None superclass = None def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=None): self.id = id if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docAnchorType.subclass: return docAnchorType.subclass(*args_, **kwargs_) else: return docAnchorType(*args_, **kwargs_) factory = staticmethod(factory) def get_id(self): return self.id def set_id(self, id): self.id = id def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docAnchorType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docAnchorType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docAnchorType'): if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='docAnchorType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docAnchorType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docAnchorType class docFormulaType(GeneratedsSuper): subclass = None superclass = None def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=None): self.id = id if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docFormulaType.subclass: return docFormulaType.subclass(*args_, **kwargs_) else: return docFormulaType(*args_, **kwargs_) factory = staticmethod(factory) def get_id(self): return self.id def set_id(self, id): self.id = id def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docFormulaType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docFormulaType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docFormulaType'): if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='docFormulaType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docFormulaType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docFormulaType class docIndexEntryType(GeneratedsSuper): subclass = None superclass = None def __init__(self, primaryie=None, secondaryie=None): self.primaryie = primaryie self.secondaryie = secondaryie def factory(*args_, **kwargs_): if docIndexEntryType.subclass: return docIndexEntryType.subclass(*args_, **kwargs_) else: return docIndexEntryType(*args_, **kwargs_) factory = staticmethod(factory) def get_primaryie(self): return self.primaryie def set_primaryie(self, primaryie): self.primaryie = primaryie def get_secondaryie(self): return self.secondaryie def set_secondaryie(self, secondaryie): self.secondaryie = secondaryie def export(self, outfile, level, namespace_='', name_='docIndexEntryType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docIndexEntryType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docIndexEntryType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docIndexEntryType'): if self.primaryie is not None: showIndent(outfile, level) outfile.write('<%sprimaryie>%s\n' % (namespace_, self.format_string(quote_xml(self.primaryie).encode(ExternalEncoding), input_name='primaryie'), namespace_)) if self.secondaryie is not None: showIndent(outfile, level) outfile.write('<%ssecondaryie>%s\n' % (namespace_, self.format_string(quote_xml(self.secondaryie).encode(ExternalEncoding), input_name='secondaryie'), namespace_)) def hasContent_(self): if ( self.primaryie is not None or self.secondaryie is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docIndexEntryType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('primaryie=%s,\n' % quote_python(self.primaryie).encode(ExternalEncoding)) showIndent(outfile, level) outfile.write('secondaryie=%s,\n' % quote_python(self.secondaryie).encode(ExternalEncoding)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'primaryie': primaryie_ = '' for text__content_ in child_.childNodes: primaryie_ += text__content_.nodeValue self.primaryie = primaryie_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'secondaryie': secondaryie_ = '' for text__content_ in child_.childNodes: secondaryie_ += text__content_.nodeValue self.secondaryie = secondaryie_ # end class docIndexEntryType class docListType(GeneratedsSuper): subclass = None superclass = None def __init__(self, listitem=None): if listitem is None: self.listitem = [] else: self.listitem = listitem def factory(*args_, **kwargs_): if docListType.subclass: return docListType.subclass(*args_, **kwargs_) else: return docListType(*args_, **kwargs_) factory = staticmethod(factory) def get_listitem(self): return self.listitem def set_listitem(self, listitem): self.listitem = listitem def add_listitem(self, value): self.listitem.append(value) def insert_listitem(self, index, value): self.listitem[index] = value def export(self, outfile, level, namespace_='', name_='docListType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docListType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docListType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docListType'): for listitem_ in self.listitem: listitem_.export(outfile, level, namespace_, name_='listitem') def hasContent_(self): if ( self.listitem is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docListType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('listitem=[\n') level += 1 for listitem in self.listitem: showIndent(outfile, level) outfile.write('model_.listitem(\n') listitem.exportLiteral(outfile, level, name_='listitem') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'listitem': obj_ = docListItemType.factory() obj_.build(child_) self.listitem.append(obj_) # end class docListType class docListItemType(GeneratedsSuper): subclass = None superclass = None def __init__(self, para=None): if para is None: self.para = [] else: self.para = para def factory(*args_, **kwargs_): if docListItemType.subclass: return docListItemType.subclass(*args_, **kwargs_) else: return docListItemType(*args_, **kwargs_) factory = staticmethod(factory) def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def export(self, outfile, level, namespace_='', name_='docListItemType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docListItemType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docListItemType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docListItemType'): for para_ in self.para: para_.export(outfile, level, namespace_, name_='para') def hasContent_(self): if ( self.para is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docListItemType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('para=[\n') level += 1 for para in self.para: showIndent(outfile, level) outfile.write('model_.para(\n') para.exportLiteral(outfile, level, name_='para') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': obj_ = docParaType.factory() obj_.build(child_) self.para.append(obj_) # end class docListItemType class docSimpleSectType(GeneratedsSuper): subclass = None superclass = None def __init__(self, kind=None, title=None, para=None): self.kind = kind self.title = title if para is None: self.para = [] else: self.para = para def factory(*args_, **kwargs_): if docSimpleSectType.subclass: return docSimpleSectType.subclass(*args_, **kwargs_) else: return docSimpleSectType(*args_, **kwargs_) factory = staticmethod(factory) def get_title(self): return self.title def set_title(self, title): self.title = title def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_kind(self): return self.kind def set_kind(self, kind): self.kind = kind def export(self, outfile, level, namespace_='', name_='docSimpleSectType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docSimpleSectType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docSimpleSectType'): if self.kind is not None: outfile.write(' kind=%s' % (quote_attrib(self.kind), )) def exportChildren(self, outfile, level, namespace_='', name_='docSimpleSectType'): if self.title: self.title.export(outfile, level, namespace_, name_='title') for para_ in self.para: para_.export(outfile, level, namespace_, name_='para') def hasContent_(self): if ( self.title is not None or self.para is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docSimpleSectType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.kind is not None: showIndent(outfile, level) outfile.write('kind = "%s",\n' % (self.kind,)) def exportLiteralChildren(self, outfile, level, name_): if self.title: showIndent(outfile, level) outfile.write('title=model_.docTitleType(\n') self.title.exportLiteral(outfile, level, name_='title') showIndent(outfile, level) outfile.write('),\n') showIndent(outfile, level) outfile.write('para=[\n') level += 1 for para in self.para: showIndent(outfile, level) outfile.write('model_.para(\n') para.exportLiteral(outfile, level, name_='para') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('kind'): self.kind = attrs.get('kind').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'title': obj_ = docTitleType.factory() obj_.build(child_) self.set_title(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': obj_ = docParaType.factory() obj_.build(child_) self.para.append(obj_) # end class docSimpleSectType class docVarListEntryType(GeneratedsSuper): subclass = None superclass = None def __init__(self, term=None): self.term = term def factory(*args_, **kwargs_): if docVarListEntryType.subclass: return docVarListEntryType.subclass(*args_, **kwargs_) else: return docVarListEntryType(*args_, **kwargs_) factory = staticmethod(factory) def get_term(self): return self.term def set_term(self, term): self.term = term def export(self, outfile, level, namespace_='', name_='docVarListEntryType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docVarListEntryType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docVarListEntryType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docVarListEntryType'): if self.term: self.term.export(outfile, level, namespace_, name_='term', ) def hasContent_(self): if ( self.term is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docVarListEntryType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): if self.term: showIndent(outfile, level) outfile.write('term=model_.docTitleType(\n') self.term.exportLiteral(outfile, level, name_='term') showIndent(outfile, level) outfile.write('),\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'term': obj_ = docTitleType.factory() obj_.build(child_) self.set_term(obj_) # end class docVarListEntryType class docVariableListType(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if docVariableListType.subclass: return docVariableListType.subclass(*args_, **kwargs_) else: return docVariableListType(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docVariableListType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docVariableListType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docVariableListType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docVariableListType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docVariableListType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docVariableListType class docRefTextType(GeneratedsSuper): subclass = None superclass = None def __init__(self, refid=None, kindref=None, external=None, valueOf_='', mixedclass_=None, content_=None): self.refid = refid self.kindref = kindref self.external = external if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docRefTextType.subclass: return docRefTextType.subclass(*args_, **kwargs_) else: return docRefTextType(*args_, **kwargs_) factory = staticmethod(factory) def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def get_kindref(self): return self.kindref def set_kindref(self, kindref): self.kindref = kindref def get_external(self): return self.external def set_external(self, external): self.external = external def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docRefTextType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docRefTextType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docRefTextType'): if self.refid is not None: outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) if self.kindref is not None: outfile.write(' kindref=%s' % (quote_attrib(self.kindref), )) if self.external is not None: outfile.write(' external=%s' % (self.format_string(quote_attrib(self.external).encode(ExternalEncoding), input_name='external'), )) def exportChildren(self, outfile, level, namespace_='', name_='docRefTextType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docRefTextType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) if self.kindref is not None: showIndent(outfile, level) outfile.write('kindref = "%s",\n' % (self.kindref,)) if self.external is not None: showIndent(outfile, level) outfile.write('external = %s,\n' % (self.external,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('refid'): self.refid = attrs.get('refid').value if attrs.get('kindref'): self.kindref = attrs.get('kindref').value if attrs.get('external'): self.external = attrs.get('external').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docRefTextType class docTableType(GeneratedsSuper): subclass = None superclass = None def __init__(self, rows=None, cols=None, row=None, caption=None): self.rows = rows self.cols = cols if row is None: self.row = [] else: self.row = row self.caption = caption def factory(*args_, **kwargs_): if docTableType.subclass: return docTableType.subclass(*args_, **kwargs_) else: return docTableType(*args_, **kwargs_) factory = staticmethod(factory) def get_row(self): return self.row def set_row(self, row): self.row = row def add_row(self, value): self.row.append(value) def insert_row(self, index, value): self.row[index] = value def get_caption(self): return self.caption def set_caption(self, caption): self.caption = caption def get_rows(self): return self.rows def set_rows(self, rows): self.rows = rows def get_cols(self): return self.cols def set_cols(self, cols): self.cols = cols def export(self, outfile, level, namespace_='', name_='docTableType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docTableType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docTableType'): if self.rows is not None: outfile.write(' rows="%s"' % self.format_integer(self.rows, input_name='rows')) if self.cols is not None: outfile.write(' cols="%s"' % self.format_integer(self.cols, input_name='cols')) def exportChildren(self, outfile, level, namespace_='', name_='docTableType'): for row_ in self.row: row_.export(outfile, level, namespace_, name_='row') if self.caption: self.caption.export(outfile, level, namespace_, name_='caption') def hasContent_(self): if ( self.row is not None or self.caption is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docTableType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.rows is not None: showIndent(outfile, level) outfile.write('rows = %s,\n' % (self.rows,)) if self.cols is not None: showIndent(outfile, level) outfile.write('cols = %s,\n' % (self.cols,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('row=[\n') level += 1 for row in self.row: showIndent(outfile, level) outfile.write('model_.row(\n') row.exportLiteral(outfile, level, name_='row') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') if self.caption: showIndent(outfile, level) outfile.write('caption=model_.docCaptionType(\n') self.caption.exportLiteral(outfile, level, name_='caption') showIndent(outfile, level) outfile.write('),\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('rows'): try: self.rows = int(attrs.get('rows').value) except ValueError, exp: raise ValueError('Bad integer attribute (rows): %s' % exp) if attrs.get('cols'): try: self.cols = int(attrs.get('cols').value) except ValueError, exp: raise ValueError('Bad integer attribute (cols): %s' % exp) def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'row': obj_ = docRowType.factory() obj_.build(child_) self.row.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'caption': obj_ = docCaptionType.factory() obj_.build(child_) self.set_caption(obj_) # end class docTableType class docRowType(GeneratedsSuper): subclass = None superclass = None def __init__(self, entry=None): if entry is None: self.entry = [] else: self.entry = entry def factory(*args_, **kwargs_): if docRowType.subclass: return docRowType.subclass(*args_, **kwargs_) else: return docRowType(*args_, **kwargs_) factory = staticmethod(factory) def get_entry(self): return self.entry def set_entry(self, entry): self.entry = entry def add_entry(self, value): self.entry.append(value) def insert_entry(self, index, value): self.entry[index] = value def export(self, outfile, level, namespace_='', name_='docRowType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docRowType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docRowType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docRowType'): for entry_ in self.entry: entry_.export(outfile, level, namespace_, name_='entry') def hasContent_(self): if ( self.entry is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docRowType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('entry=[\n') level += 1 for entry in self.entry: showIndent(outfile, level) outfile.write('model_.entry(\n') entry.exportLiteral(outfile, level, name_='entry') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'entry': obj_ = docEntryType.factory() obj_.build(child_) self.entry.append(obj_) # end class docRowType class docEntryType(GeneratedsSuper): subclass = None superclass = None def __init__(self, thead=None, para=None): self.thead = thead if para is None: self.para = [] else: self.para = para def factory(*args_, **kwargs_): if docEntryType.subclass: return docEntryType.subclass(*args_, **kwargs_) else: return docEntryType(*args_, **kwargs_) factory = staticmethod(factory) def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_thead(self): return self.thead def set_thead(self, thead): self.thead = thead def export(self, outfile, level, namespace_='', name_='docEntryType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docEntryType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docEntryType'): if self.thead is not None: outfile.write(' thead=%s' % (quote_attrib(self.thead), )) def exportChildren(self, outfile, level, namespace_='', name_='docEntryType'): for para_ in self.para: para_.export(outfile, level, namespace_, name_='para') def hasContent_(self): if ( self.para is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docEntryType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.thead is not None: showIndent(outfile, level) outfile.write('thead = "%s",\n' % (self.thead,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('para=[\n') level += 1 for para in self.para: showIndent(outfile, level) outfile.write('model_.para(\n') para.exportLiteral(outfile, level, name_='para') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('thead'): self.thead = attrs.get('thead').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': obj_ = docParaType.factory() obj_.build(child_) self.para.append(obj_) # end class docEntryType class docCaptionType(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_='', mixedclass_=None, content_=None): if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docCaptionType.subclass: return docCaptionType.subclass(*args_, **kwargs_) else: return docCaptionType(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docCaptionType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docCaptionType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docCaptionType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docCaptionType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docCaptionType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docCaptionType class docHeadingType(GeneratedsSuper): subclass = None superclass = None def __init__(self, level=None, valueOf_='', mixedclass_=None, content_=None): self.level = level if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docHeadingType.subclass: return docHeadingType.subclass(*args_, **kwargs_) else: return docHeadingType(*args_, **kwargs_) factory = staticmethod(factory) def get_level(self): return self.level def set_level(self, level): self.level = level def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docHeadingType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docHeadingType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docHeadingType'): if self.level is not None: outfile.write(' level="%s"' % self.format_integer(self.level, input_name='level')) def exportChildren(self, outfile, level, namespace_='', name_='docHeadingType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docHeadingType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.level is not None: showIndent(outfile, level) outfile.write('level = %s,\n' % (self.level,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('level'): try: self.level = int(attrs.get('level').value) except ValueError, exp: raise ValueError('Bad integer attribute (level): %s' % exp) def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docHeadingType class docImageType(GeneratedsSuper): subclass = None superclass = None def __init__(self, width=None, type_=None, name=None, height=None, valueOf_='', mixedclass_=None, content_=None): self.width = width self.type_ = type_ self.name = name self.height = height if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docImageType.subclass: return docImageType.subclass(*args_, **kwargs_) else: return docImageType(*args_, **kwargs_) factory = staticmethod(factory) def get_width(self): return self.width def set_width(self, width): self.width = width def get_type(self): return self.type_ def set_type(self, type_): self.type_ = type_ def get_name(self): return self.name def set_name(self, name): self.name = name def get_height(self): return self.height def set_height(self, height): self.height = height def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docImageType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docImageType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docImageType'): if self.width is not None: outfile.write(' width=%s' % (self.format_string(quote_attrib(self.width).encode(ExternalEncoding), input_name='width'), )) if self.type_ is not None: outfile.write(' type=%s' % (quote_attrib(self.type_), )) if self.name is not None: outfile.write(' name=%s' % (self.format_string(quote_attrib(self.name).encode(ExternalEncoding), input_name='name'), )) if self.height is not None: outfile.write(' height=%s' % (self.format_string(quote_attrib(self.height).encode(ExternalEncoding), input_name='height'), )) def exportChildren(self, outfile, level, namespace_='', name_='docImageType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docImageType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.width is not None: showIndent(outfile, level) outfile.write('width = %s,\n' % (self.width,)) if self.type_ is not None: showIndent(outfile, level) outfile.write('type_ = "%s",\n' % (self.type_,)) if self.name is not None: showIndent(outfile, level) outfile.write('name = %s,\n' % (self.name,)) if self.height is not None: showIndent(outfile, level) outfile.write('height = %s,\n' % (self.height,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('width'): self.width = attrs.get('width').value if attrs.get('type'): self.type_ = attrs.get('type').value if attrs.get('name'): self.name = attrs.get('name').value if attrs.get('height'): self.height = attrs.get('height').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docImageType class docDotFileType(GeneratedsSuper): subclass = None superclass = None def __init__(self, name=None, valueOf_='', mixedclass_=None, content_=None): self.name = name if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docDotFileType.subclass: return docDotFileType.subclass(*args_, **kwargs_) else: return docDotFileType(*args_, **kwargs_) factory = staticmethod(factory) def get_name(self): return self.name def set_name(self, name): self.name = name def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docDotFileType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docDotFileType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docDotFileType'): if self.name is not None: outfile.write(' name=%s' % (self.format_string(quote_attrib(self.name).encode(ExternalEncoding), input_name='name'), )) def exportChildren(self, outfile, level, namespace_='', name_='docDotFileType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docDotFileType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.name is not None: showIndent(outfile, level) outfile.write('name = %s,\n' % (self.name,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('name'): self.name = attrs.get('name').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docDotFileType class docTocItemType(GeneratedsSuper): subclass = None superclass = None def __init__(self, id=None, valueOf_='', mixedclass_=None, content_=None): self.id = id if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docTocItemType.subclass: return docTocItemType.subclass(*args_, **kwargs_) else: return docTocItemType(*args_, **kwargs_) factory = staticmethod(factory) def get_id(self): return self.id def set_id(self, id): self.id = id def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docTocItemType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docTocItemType') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docTocItemType'): if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='docTocItemType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docTocItemType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docTocItemType class docTocListType(GeneratedsSuper): subclass = None superclass = None def __init__(self, tocitem=None): if tocitem is None: self.tocitem = [] else: self.tocitem = tocitem def factory(*args_, **kwargs_): if docTocListType.subclass: return docTocListType.subclass(*args_, **kwargs_) else: return docTocListType(*args_, **kwargs_) factory = staticmethod(factory) def get_tocitem(self): return self.tocitem def set_tocitem(self, tocitem): self.tocitem = tocitem def add_tocitem(self, value): self.tocitem.append(value) def insert_tocitem(self, index, value): self.tocitem[index] = value def export(self, outfile, level, namespace_='', name_='docTocListType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docTocListType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docTocListType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docTocListType'): for tocitem_ in self.tocitem: tocitem_.export(outfile, level, namespace_, name_='tocitem') def hasContent_(self): if ( self.tocitem is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docTocListType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('tocitem=[\n') level += 1 for tocitem in self.tocitem: showIndent(outfile, level) outfile.write('model_.tocitem(\n') tocitem.exportLiteral(outfile, level, name_='tocitem') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'tocitem': obj_ = docTocItemType.factory() obj_.build(child_) self.tocitem.append(obj_) # end class docTocListType class docLanguageType(GeneratedsSuper): subclass = None superclass = None def __init__(self, langid=None, para=None): self.langid = langid if para is None: self.para = [] else: self.para = para def factory(*args_, **kwargs_): if docLanguageType.subclass: return docLanguageType.subclass(*args_, **kwargs_) else: return docLanguageType(*args_, **kwargs_) factory = staticmethod(factory) def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_langid(self): return self.langid def set_langid(self, langid): self.langid = langid def export(self, outfile, level, namespace_='', name_='docLanguageType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docLanguageType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docLanguageType'): if self.langid is not None: outfile.write(' langid=%s' % (self.format_string(quote_attrib(self.langid).encode(ExternalEncoding), input_name='langid'), )) def exportChildren(self, outfile, level, namespace_='', name_='docLanguageType'): for para_ in self.para: para_.export(outfile, level, namespace_, name_='para') def hasContent_(self): if ( self.para is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docLanguageType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.langid is not None: showIndent(outfile, level) outfile.write('langid = %s,\n' % (self.langid,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('para=[\n') level += 1 for para in self.para: showIndent(outfile, level) outfile.write('model_.para(\n') para.exportLiteral(outfile, level, name_='para') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('langid'): self.langid = attrs.get('langid').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': obj_ = docParaType.factory() obj_.build(child_) self.para.append(obj_) # end class docLanguageType class docParamListType(GeneratedsSuper): subclass = None superclass = None def __init__(self, kind=None, parameteritem=None): self.kind = kind if parameteritem is None: self.parameteritem = [] else: self.parameteritem = parameteritem def factory(*args_, **kwargs_): if docParamListType.subclass: return docParamListType.subclass(*args_, **kwargs_) else: return docParamListType(*args_, **kwargs_) factory = staticmethod(factory) def get_parameteritem(self): return self.parameteritem def set_parameteritem(self, parameteritem): self.parameteritem = parameteritem def add_parameteritem(self, value): self.parameteritem.append(value) def insert_parameteritem(self, index, value): self.parameteritem[index] = value def get_kind(self): return self.kind def set_kind(self, kind): self.kind = kind def export(self, outfile, level, namespace_='', name_='docParamListType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docParamListType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docParamListType'): if self.kind is not None: outfile.write(' kind=%s' % (quote_attrib(self.kind), )) def exportChildren(self, outfile, level, namespace_='', name_='docParamListType'): for parameteritem_ in self.parameteritem: parameteritem_.export(outfile, level, namespace_, name_='parameteritem') def hasContent_(self): if ( self.parameteritem is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docParamListType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.kind is not None: showIndent(outfile, level) outfile.write('kind = "%s",\n' % (self.kind,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('parameteritem=[\n') level += 1 for parameteritem in self.parameteritem: showIndent(outfile, level) outfile.write('model_.parameteritem(\n') parameteritem.exportLiteral(outfile, level, name_='parameteritem') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('kind'): self.kind = attrs.get('kind').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'parameteritem': obj_ = docParamListItem.factory() obj_.build(child_) self.parameteritem.append(obj_) # end class docParamListType class docParamListItem(GeneratedsSuper): subclass = None superclass = None def __init__(self, parameternamelist=None, parameterdescription=None): if parameternamelist is None: self.parameternamelist = [] else: self.parameternamelist = parameternamelist self.parameterdescription = parameterdescription def factory(*args_, **kwargs_): if docParamListItem.subclass: return docParamListItem.subclass(*args_, **kwargs_) else: return docParamListItem(*args_, **kwargs_) factory = staticmethod(factory) def get_parameternamelist(self): return self.parameternamelist def set_parameternamelist(self, parameternamelist): self.parameternamelist = parameternamelist def add_parameternamelist(self, value): self.parameternamelist.append(value) def insert_parameternamelist(self, index, value): self.parameternamelist[index] = value def get_parameterdescription(self): return self.parameterdescription def set_parameterdescription(self, parameterdescription): self.parameterdescription = parameterdescription def export(self, outfile, level, namespace_='', name_='docParamListItem', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docParamListItem') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docParamListItem'): pass def exportChildren(self, outfile, level, namespace_='', name_='docParamListItem'): for parameternamelist_ in self.parameternamelist: parameternamelist_.export(outfile, level, namespace_, name_='parameternamelist') if self.parameterdescription: self.parameterdescription.export(outfile, level, namespace_, name_='parameterdescription', ) def hasContent_(self): if ( self.parameternamelist is not None or self.parameterdescription is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docParamListItem'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('parameternamelist=[\n') level += 1 for parameternamelist in self.parameternamelist: showIndent(outfile, level) outfile.write('model_.parameternamelist(\n') parameternamelist.exportLiteral(outfile, level, name_='parameternamelist') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') if self.parameterdescription: showIndent(outfile, level) outfile.write('parameterdescription=model_.descriptionType(\n') self.parameterdescription.exportLiteral(outfile, level, name_='parameterdescription') showIndent(outfile, level) outfile.write('),\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'parameternamelist': obj_ = docParamNameList.factory() obj_.build(child_) self.parameternamelist.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'parameterdescription': obj_ = descriptionType.factory() obj_.build(child_) self.set_parameterdescription(obj_) # end class docParamListItem class docParamNameList(GeneratedsSuper): subclass = None superclass = None def __init__(self, parametername=None): if parametername is None: self.parametername = [] else: self.parametername = parametername def factory(*args_, **kwargs_): if docParamNameList.subclass: return docParamNameList.subclass(*args_, **kwargs_) else: return docParamNameList(*args_, **kwargs_) factory = staticmethod(factory) def get_parametername(self): return self.parametername def set_parametername(self, parametername): self.parametername = parametername def add_parametername(self, value): self.parametername.append(value) def insert_parametername(self, index, value): self.parametername[index] = value def export(self, outfile, level, namespace_='', name_='docParamNameList', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docParamNameList') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docParamNameList'): pass def exportChildren(self, outfile, level, namespace_='', name_='docParamNameList'): for parametername_ in self.parametername: parametername_.export(outfile, level, namespace_, name_='parametername') def hasContent_(self): if ( self.parametername is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docParamNameList'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('parametername=[\n') level += 1 for parametername in self.parametername: showIndent(outfile, level) outfile.write('model_.parametername(\n') parametername.exportLiteral(outfile, level, name_='parametername') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'parametername': obj_ = docParamName.factory() obj_.build(child_) self.parametername.append(obj_) # end class docParamNameList class docParamName(GeneratedsSuper): subclass = None superclass = None def __init__(self, direction=None, ref=None, mixedclass_=None, content_=None): self.direction = direction if mixedclass_ is None: self.mixedclass_ = MixedContainer else: self.mixedclass_ = mixedclass_ if content_ is None: self.content_ = [] else: self.content_ = content_ def factory(*args_, **kwargs_): if docParamName.subclass: return docParamName.subclass(*args_, **kwargs_) else: return docParamName(*args_, **kwargs_) factory = staticmethod(factory) def get_ref(self): return self.ref def set_ref(self, ref): self.ref = ref def get_direction(self): return self.direction def set_direction(self, direction): self.direction = direction def export(self, outfile, level, namespace_='', name_='docParamName', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docParamName') outfile.write('>') self.exportChildren(outfile, level + 1, namespace_, name_) outfile.write('\n' % (namespace_, name_)) def exportAttributes(self, outfile, level, namespace_='', name_='docParamName'): if self.direction is not None: outfile.write(' direction=%s' % (quote_attrib(self.direction), )) def exportChildren(self, outfile, level, namespace_='', name_='docParamName'): for item_ in self.content_: item_.export(outfile, level, item_.name, namespace_) def hasContent_(self): if ( self.ref is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docParamName'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.direction is not None: showIndent(outfile, level) outfile.write('direction = "%s",\n' % (self.direction,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('content_ = [\n') for item_ in self.content_: item_.exportLiteral(outfile, level, name_) showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('direction'): self.direction = attrs.get('direction').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'ref': childobj_ = docRefTextType.factory() childobj_.build(child_) obj_ = self.mixedclass_(MixedContainer.CategoryComplex, MixedContainer.TypeNone, 'ref', childobj_) self.content_.append(obj_) elif child_.nodeType == Node.TEXT_NODE: obj_ = self.mixedclass_(MixedContainer.CategoryText, MixedContainer.TypeNone, '', child_.nodeValue) self.content_.append(obj_) # end class docParamName class docXRefSectType(GeneratedsSuper): subclass = None superclass = None def __init__(self, id=None, xreftitle=None, xrefdescription=None): self.id = id if xreftitle is None: self.xreftitle = [] else: self.xreftitle = xreftitle self.xrefdescription = xrefdescription def factory(*args_, **kwargs_): if docXRefSectType.subclass: return docXRefSectType.subclass(*args_, **kwargs_) else: return docXRefSectType(*args_, **kwargs_) factory = staticmethod(factory) def get_xreftitle(self): return self.xreftitle def set_xreftitle(self, xreftitle): self.xreftitle = xreftitle def add_xreftitle(self, value): self.xreftitle.append(value) def insert_xreftitle(self, index, value): self.xreftitle[index] = value def get_xrefdescription(self): return self.xrefdescription def set_xrefdescription(self, xrefdescription): self.xrefdescription = xrefdescription def get_id(self): return self.id def set_id(self, id): self.id = id def export(self, outfile, level, namespace_='', name_='docXRefSectType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docXRefSectType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docXRefSectType'): if self.id is not None: outfile.write(' id=%s' % (self.format_string(quote_attrib(self.id).encode(ExternalEncoding), input_name='id'), )) def exportChildren(self, outfile, level, namespace_='', name_='docXRefSectType'): for xreftitle_ in self.xreftitle: showIndent(outfile, level) outfile.write('<%sxreftitle>%s\n' % (namespace_, self.format_string(quote_xml(xreftitle_).encode(ExternalEncoding), input_name='xreftitle'), namespace_)) if self.xrefdescription: self.xrefdescription.export(outfile, level, namespace_, name_='xrefdescription', ) def hasContent_(self): if ( self.xreftitle is not None or self.xrefdescription is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docXRefSectType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.id is not None: showIndent(outfile, level) outfile.write('id = %s,\n' % (self.id,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('xreftitle=[\n') level += 1 for xreftitle in self.xreftitle: showIndent(outfile, level) outfile.write('%s,\n' % quote_python(xreftitle).encode(ExternalEncoding)) level -= 1 showIndent(outfile, level) outfile.write('],\n') if self.xrefdescription: showIndent(outfile, level) outfile.write('xrefdescription=model_.descriptionType(\n') self.xrefdescription.exportLiteral(outfile, level, name_='xrefdescription') showIndent(outfile, level) outfile.write('),\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('id'): self.id = attrs.get('id').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'xreftitle': xreftitle_ = '' for text__content_ in child_.childNodes: xreftitle_ += text__content_.nodeValue self.xreftitle.append(xreftitle_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'xrefdescription': obj_ = descriptionType.factory() obj_.build(child_) self.set_xrefdescription(obj_) # end class docXRefSectType class docCopyType(GeneratedsSuper): subclass = None superclass = None def __init__(self, link=None, para=None, sect1=None, internal=None): self.link = link if para is None: self.para = [] else: self.para = para if sect1 is None: self.sect1 = [] else: self.sect1 = sect1 self.internal = internal def factory(*args_, **kwargs_): if docCopyType.subclass: return docCopyType.subclass(*args_, **kwargs_) else: return docCopyType(*args_, **kwargs_) factory = staticmethod(factory) def get_para(self): return self.para def set_para(self, para): self.para = para def add_para(self, value): self.para.append(value) def insert_para(self, index, value): self.para[index] = value def get_sect1(self): return self.sect1 def set_sect1(self, sect1): self.sect1 = sect1 def add_sect1(self, value): self.sect1.append(value) def insert_sect1(self, index, value): self.sect1[index] = value def get_internal(self): return self.internal def set_internal(self, internal): self.internal = internal def get_link(self): return self.link def set_link(self, link): self.link = link def export(self, outfile, level, namespace_='', name_='docCopyType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docCopyType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docCopyType'): if self.link is not None: outfile.write(' link=%s' % (self.format_string(quote_attrib(self.link).encode(ExternalEncoding), input_name='link'), )) def exportChildren(self, outfile, level, namespace_='', name_='docCopyType'): for para_ in self.para: para_.export(outfile, level, namespace_, name_='para') for sect1_ in self.sect1: sect1_.export(outfile, level, namespace_, name_='sect1') if self.internal: self.internal.export(outfile, level, namespace_, name_='internal') def hasContent_(self): if ( self.para is not None or self.sect1 is not None or self.internal is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docCopyType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.link is not None: showIndent(outfile, level) outfile.write('link = %s,\n' % (self.link,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('para=[\n') level += 1 for para in self.para: showIndent(outfile, level) outfile.write('model_.para(\n') para.exportLiteral(outfile, level, name_='para') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') showIndent(outfile, level) outfile.write('sect1=[\n') level += 1 for sect1 in self.sect1: showIndent(outfile, level) outfile.write('model_.sect1(\n') sect1.exportLiteral(outfile, level, name_='sect1') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') if self.internal: showIndent(outfile, level) outfile.write('internal=model_.docInternalType(\n') self.internal.exportLiteral(outfile, level, name_='internal') showIndent(outfile, level) outfile.write('),\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('link'): self.link = attrs.get('link').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'para': obj_ = docParaType.factory() obj_.build(child_) self.para.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'sect1': obj_ = docSect1Type.factory() obj_.build(child_) self.sect1.append(obj_) elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'internal': obj_ = docInternalType.factory() obj_.build(child_) self.set_internal(obj_) # end class docCopyType class docCharType(GeneratedsSuper): subclass = None superclass = None def __init__(self, char=None, valueOf_=''): self.char = char self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if docCharType.subclass: return docCharType.subclass(*args_, **kwargs_) else: return docCharType(*args_, **kwargs_) factory = staticmethod(factory) def get_char(self): return self.char def set_char(self, char): self.char = char def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docCharType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docCharType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docCharType'): if self.char is not None: outfile.write(' char=%s' % (quote_attrib(self.char), )) def exportChildren(self, outfile, level, namespace_='', name_='docCharType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docCharType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.char is not None: showIndent(outfile, level) outfile.write('char = "%s",\n' % (self.char,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('char'): self.char = attrs.get('char').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docCharType class docEmptyType(GeneratedsSuper): subclass = None superclass = None def __init__(self, valueOf_=''): self.valueOf_ = valueOf_ def factory(*args_, **kwargs_): if docEmptyType.subclass: return docEmptyType.subclass(*args_, **kwargs_) else: return docEmptyType(*args_, **kwargs_) factory = staticmethod(factory) def getValueOf_(self): return self.valueOf_ def setValueOf_(self, valueOf_): self.valueOf_ = valueOf_ def export(self, outfile, level, namespace_='', name_='docEmptyType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='docEmptyType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='docEmptyType'): pass def exportChildren(self, outfile, level, namespace_='', name_='docEmptyType'): if self.valueOf_.find('![CDATA')>-1: value=quote_xml('%s' % self.valueOf_) value=value.replace('![CDATA','') outfile.write(value) else: outfile.write(quote_xml('%s' % self.valueOf_)) def hasContent_(self): if ( self.valueOf_ is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='docEmptyType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): pass def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('valueOf_ = "%s",\n' % (self.valueOf_,)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) self.valueOf_ = '' for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): pass def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.TEXT_NODE: self.valueOf_ += child_.nodeValue elif child_.nodeType == Node.CDATA_SECTION_NODE: self.valueOf_ += '![CDATA['+child_.nodeValue+']]' # end class docEmptyType USAGE_TEXT = """ Usage: python .py [ -s ] Options: -s Use the SAX parser, not the minidom parser. """ def usage(): print USAGE_TEXT sys.exit(1) def parse(inFileName): doc = minidom.parse(inFileName) rootNode = doc.documentElement rootObj = DoxygenType.factory() rootObj.build(rootNode) # Enable Python to collect the space used by the DOM. doc = None sys.stdout.write('\n') rootObj.export(sys.stdout, 0, name_="doxygen", namespacedef_='') return rootObj def parseString(inString): doc = minidom.parseString(inString) rootNode = doc.documentElement rootObj = DoxygenType.factory() rootObj.build(rootNode) # Enable Python to collect the space used by the DOM. doc = None sys.stdout.write('\n') rootObj.export(sys.stdout, 0, name_="doxygen", namespacedef_='') return rootObj def parseLiteral(inFileName): doc = minidom.parse(inFileName) rootNode = doc.documentElement rootObj = DoxygenType.factory() rootObj.build(rootNode) # Enable Python to collect the space used by the DOM. doc = None sys.stdout.write('from compound import *\n\n') sys.stdout.write('rootObj = doxygen(\n') rootObj.exportLiteral(sys.stdout, 0, name_="doxygen") sys.stdout.write(')\n') return rootObj def main(): args = sys.argv[1:] if len(args) == 1: parse(args[0]) else: usage() if __name__ == '__main__': main() #import pdb #pdb.run('main()') gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/generated/index.py000066400000000000000000000035171225753723100245650ustar00rootroot00000000000000#!/usr/bin/env python """ Generated Mon Feb 9 19:08:05 2009 by generateDS.py. """ from xml.dom import minidom import os import sys import compound import indexsuper as supermod class DoxygenTypeSub(supermod.DoxygenType): def __init__(self, version=None, compound=None): supermod.DoxygenType.__init__(self, version, compound) def find_compounds_and_members(self, details): """ Returns a list of all compounds and their members which match details """ results = [] for compound in self.compound: members = compound.find_members(details) if members: results.append([compound, members]) else: if details.match(compound): results.append([compound, []]) return results supermod.DoxygenType.subclass = DoxygenTypeSub # end class DoxygenTypeSub class CompoundTypeSub(supermod.CompoundType): def __init__(self, kind=None, refid=None, name='', member=None): supermod.CompoundType.__init__(self, kind, refid, name, member) def find_members(self, details): """ Returns a list of all members which match details """ results = [] for member in self.member: if details.match(member): results.append(member) return results supermod.CompoundType.subclass = CompoundTypeSub # end class CompoundTypeSub class MemberTypeSub(supermod.MemberType): def __init__(self, kind=None, refid=None, name=''): supermod.MemberType.__init__(self, kind, refid, name) supermod.MemberType.subclass = MemberTypeSub # end class MemberTypeSub def parse(inFilename): doc = minidom.parse(inFilename) rootNode = doc.documentElement rootObj = supermod.DoxygenType.factory() rootObj.build(rootNode) return rootObj gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/generated/indexsuper.py000066400000000000000000000455261225753723100256520ustar00rootroot00000000000000#!/usr/bin/env python # # Generated Thu Jun 11 18:43:54 2009 by generateDS.py. # import sys import getopt from string import lower as str_lower from xml.dom import minidom from xml.dom import Node # # User methods # # Calls to the methods in these classes are generated by generateDS.py. # You can replace these methods by re-implementing the following class # in a module named generatedssuper.py. try: from generatedssuper import GeneratedsSuper except ImportError, exp: class GeneratedsSuper: def format_string(self, input_data, input_name=''): return input_data def format_integer(self, input_data, input_name=''): return '%d' % input_data def format_float(self, input_data, input_name=''): return '%f' % input_data def format_double(self, input_data, input_name=''): return '%e' % input_data def format_boolean(self, input_data, input_name=''): return '%s' % input_data # # If you have installed IPython you can uncomment and use the following. # IPython is available from http://ipython.scipy.org/. # ## from IPython.Shell import IPShellEmbed ## args = '' ## ipshell = IPShellEmbed(args, ## banner = 'Dropping into IPython', ## exit_msg = 'Leaving Interpreter, back to program.') # Then use the following line where and when you want to drop into the # IPython shell: # ipshell(' -- Entering ipshell.\nHit Ctrl-D to exit') # # Globals # ExternalEncoding = 'ascii' # # Support/utility functions. # def showIndent(outfile, level): for idx in range(level): outfile.write(' ') def quote_xml(inStr): s1 = (isinstance(inStr, basestring) and inStr or '%s' % inStr) s1 = s1.replace('&', '&') s1 = s1.replace('<', '<') s1 = s1.replace('>', '>') return s1 def quote_attrib(inStr): s1 = (isinstance(inStr, basestring) and inStr or '%s' % inStr) s1 = s1.replace('&', '&') s1 = s1.replace('<', '<') s1 = s1.replace('>', '>') if '"' in s1: if "'" in s1: s1 = '"%s"' % s1.replace('"', """) else: s1 = "'%s'" % s1 else: s1 = '"%s"' % s1 return s1 def quote_python(inStr): s1 = inStr if s1.find("'") == -1: if s1.find('\n') == -1: return "'%s'" % s1 else: return "'''%s'''" % s1 else: if s1.find('"') != -1: s1 = s1.replace('"', '\\"') if s1.find('\n') == -1: return '"%s"' % s1 else: return '"""%s"""' % s1 class MixedContainer: # Constants for category: CategoryNone = 0 CategoryText = 1 CategorySimple = 2 CategoryComplex = 3 # Constants for content_type: TypeNone = 0 TypeText = 1 TypeString = 2 TypeInteger = 3 TypeFloat = 4 TypeDecimal = 5 TypeDouble = 6 TypeBoolean = 7 def __init__(self, category, content_type, name, value): self.category = category self.content_type = content_type self.name = name self.value = value def getCategory(self): return self.category def getContenttype(self, content_type): return self.content_type def getValue(self): return self.value def getName(self): return self.name def export(self, outfile, level, name, namespace): if self.category == MixedContainer.CategoryText: outfile.write(self.value) elif self.category == MixedContainer.CategorySimple: self.exportSimple(outfile, level, name) else: # category == MixedContainer.CategoryComplex self.value.export(outfile, level, namespace,name) def exportSimple(self, outfile, level, name): if self.content_type == MixedContainer.TypeString: outfile.write('<%s>%s' % (self.name, self.value, self.name)) elif self.content_type == MixedContainer.TypeInteger or \ self.content_type == MixedContainer.TypeBoolean: outfile.write('<%s>%d' % (self.name, self.value, self.name)) elif self.content_type == MixedContainer.TypeFloat or \ self.content_type == MixedContainer.TypeDecimal: outfile.write('<%s>%f' % (self.name, self.value, self.name)) elif self.content_type == MixedContainer.TypeDouble: outfile.write('<%s>%g' % (self.name, self.value, self.name)) def exportLiteral(self, outfile, level, name): if self.category == MixedContainer.CategoryText: showIndent(outfile, level) outfile.write('MixedContainer(%d, %d, "%s", "%s"),\n' % \ (self.category, self.content_type, self.name, self.value)) elif self.category == MixedContainer.CategorySimple: showIndent(outfile, level) outfile.write('MixedContainer(%d, %d, "%s", "%s"),\n' % \ (self.category, self.content_type, self.name, self.value)) else: # category == MixedContainer.CategoryComplex showIndent(outfile, level) outfile.write('MixedContainer(%d, %d, "%s",\n' % \ (self.category, self.content_type, self.name,)) self.value.exportLiteral(outfile, level + 1) showIndent(outfile, level) outfile.write(')\n') class _MemberSpec(object): def __init__(self, name='', data_type='', container=0): self.name = name self.data_type = data_type self.container = container def set_name(self, name): self.name = name def get_name(self): return self.name def set_data_type(self, data_type): self.data_type = data_type def get_data_type(self): return self.data_type def set_container(self, container): self.container = container def get_container(self): return self.container # # Data representation classes. # class DoxygenType(GeneratedsSuper): subclass = None superclass = None def __init__(self, version=None, compound=None): self.version = version if compound is None: self.compound = [] else: self.compound = compound def factory(*args_, **kwargs_): if DoxygenType.subclass: return DoxygenType.subclass(*args_, **kwargs_) else: return DoxygenType(*args_, **kwargs_) factory = staticmethod(factory) def get_compound(self): return self.compound def set_compound(self, compound): self.compound = compound def add_compound(self, value): self.compound.append(value) def insert_compound(self, index, value): self.compound[index] = value def get_version(self): return self.version def set_version(self, version): self.version = version def export(self, outfile, level, namespace_='', name_='DoxygenType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='DoxygenType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='DoxygenType'): outfile.write(' version=%s' % (self.format_string(quote_attrib(self.version).encode(ExternalEncoding), input_name='version'), )) def exportChildren(self, outfile, level, namespace_='', name_='DoxygenType'): for compound_ in self.compound: compound_.export(outfile, level, namespace_, name_='compound') def hasContent_(self): if ( self.compound is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='DoxygenType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.version is not None: showIndent(outfile, level) outfile.write('version = %s,\n' % (self.version,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('compound=[\n') level += 1 for compound in self.compound: showIndent(outfile, level) outfile.write('model_.compound(\n') compound.exportLiteral(outfile, level, name_='compound') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('version'): self.version = attrs.get('version').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'compound': obj_ = CompoundType.factory() obj_.build(child_) self.compound.append(obj_) # end class DoxygenType class CompoundType(GeneratedsSuper): subclass = None superclass = None def __init__(self, kind=None, refid=None, name=None, member=None): self.kind = kind self.refid = refid self.name = name if member is None: self.member = [] else: self.member = member def factory(*args_, **kwargs_): if CompoundType.subclass: return CompoundType.subclass(*args_, **kwargs_) else: return CompoundType(*args_, **kwargs_) factory = staticmethod(factory) def get_name(self): return self.name def set_name(self, name): self.name = name def get_member(self): return self.member def set_member(self, member): self.member = member def add_member(self, value): self.member.append(value) def insert_member(self, index, value): self.member[index] = value def get_kind(self): return self.kind def set_kind(self, kind): self.kind = kind def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def export(self, outfile, level, namespace_='', name_='CompoundType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='CompoundType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='CompoundType'): outfile.write(' kind=%s' % (quote_attrib(self.kind), )) outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) def exportChildren(self, outfile, level, namespace_='', name_='CompoundType'): if self.name is not None: showIndent(outfile, level) outfile.write('<%sname>%s\n' % (namespace_, self.format_string(quote_xml(self.name).encode(ExternalEncoding), input_name='name'), namespace_)) for member_ in self.member: member_.export(outfile, level, namespace_, name_='member') def hasContent_(self): if ( self.name is not None or self.member is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='CompoundType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.kind is not None: showIndent(outfile, level) outfile.write('kind = "%s",\n' % (self.kind,)) if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('name=%s,\n' % quote_python(self.name).encode(ExternalEncoding)) showIndent(outfile, level) outfile.write('member=[\n') level += 1 for member in self.member: showIndent(outfile, level) outfile.write('model_.member(\n') member.exportLiteral(outfile, level, name_='member') showIndent(outfile, level) outfile.write('),\n') level -= 1 showIndent(outfile, level) outfile.write('],\n') def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('kind'): self.kind = attrs.get('kind').value if attrs.get('refid'): self.refid = attrs.get('refid').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'name': name_ = '' for text__content_ in child_.childNodes: name_ += text__content_.nodeValue self.name = name_ elif child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'member': obj_ = MemberType.factory() obj_.build(child_) self.member.append(obj_) # end class CompoundType class MemberType(GeneratedsSuper): subclass = None superclass = None def __init__(self, kind=None, refid=None, name=None): self.kind = kind self.refid = refid self.name = name def factory(*args_, **kwargs_): if MemberType.subclass: return MemberType.subclass(*args_, **kwargs_) else: return MemberType(*args_, **kwargs_) factory = staticmethod(factory) def get_name(self): return self.name def set_name(self, name): self.name = name def get_kind(self): return self.kind def set_kind(self, kind): self.kind = kind def get_refid(self): return self.refid def set_refid(self, refid): self.refid = refid def export(self, outfile, level, namespace_='', name_='MemberType', namespacedef_=''): showIndent(outfile, level) outfile.write('<%s%s %s' % (namespace_, name_, namespacedef_, )) self.exportAttributes(outfile, level, namespace_, name_='MemberType') if self.hasContent_(): outfile.write('>\n') self.exportChildren(outfile, level + 1, namespace_, name_) showIndent(outfile, level) outfile.write('\n' % (namespace_, name_)) else: outfile.write(' />\n') def exportAttributes(self, outfile, level, namespace_='', name_='MemberType'): outfile.write(' kind=%s' % (quote_attrib(self.kind), )) outfile.write(' refid=%s' % (self.format_string(quote_attrib(self.refid).encode(ExternalEncoding), input_name='refid'), )) def exportChildren(self, outfile, level, namespace_='', name_='MemberType'): if self.name is not None: showIndent(outfile, level) outfile.write('<%sname>%s\n' % (namespace_, self.format_string(quote_xml(self.name).encode(ExternalEncoding), input_name='name'), namespace_)) def hasContent_(self): if ( self.name is not None ): return True else: return False def exportLiteral(self, outfile, level, name_='MemberType'): level += 1 self.exportLiteralAttributes(outfile, level, name_) if self.hasContent_(): self.exportLiteralChildren(outfile, level, name_) def exportLiteralAttributes(self, outfile, level, name_): if self.kind is not None: showIndent(outfile, level) outfile.write('kind = "%s",\n' % (self.kind,)) if self.refid is not None: showIndent(outfile, level) outfile.write('refid = %s,\n' % (self.refid,)) def exportLiteralChildren(self, outfile, level, name_): showIndent(outfile, level) outfile.write('name=%s,\n' % quote_python(self.name).encode(ExternalEncoding)) def build(self, node_): attrs = node_.attributes self.buildAttributes(attrs) for child_ in node_.childNodes: nodeName_ = child_.nodeName.split(':')[-1] self.buildChildren(child_, nodeName_) def buildAttributes(self, attrs): if attrs.get('kind'): self.kind = attrs.get('kind').value if attrs.get('refid'): self.refid = attrs.get('refid').value def buildChildren(self, child_, nodeName_): if child_.nodeType == Node.ELEMENT_NODE and \ nodeName_ == 'name': name_ = '' for text__content_ in child_.childNodes: name_ += text__content_.nodeValue self.name = name_ # end class MemberType USAGE_TEXT = """ Usage: python .py [ -s ] Options: -s Use the SAX parser, not the minidom parser. """ def usage(): print USAGE_TEXT sys.exit(1) def parse(inFileName): doc = minidom.parse(inFileName) rootNode = doc.documentElement rootObj = DoxygenType.factory() rootObj.build(rootNode) # Enable Python to collect the space used by the DOM. doc = None sys.stdout.write('\n') rootObj.export(sys.stdout, 0, name_="doxygenindex", namespacedef_='') return rootObj def parseString(inString): doc = minidom.parseString(inString) rootNode = doc.documentElement rootObj = DoxygenType.factory() rootObj.build(rootNode) # Enable Python to collect the space used by the DOM. doc = None sys.stdout.write('\n') rootObj.export(sys.stdout, 0, name_="doxygenindex", namespacedef_='') return rootObj def parseLiteral(inFileName): doc = minidom.parse(inFileName) rootNode = doc.documentElement rootObj = DoxygenType.factory() rootObj.build(rootNode) # Enable Python to collect the space used by the DOM. doc = None sys.stdout.write('from index import *\n\n') sys.stdout.write('rootObj = doxygenindex(\n') rootObj.exportLiteral(sys.stdout, 0, name_="doxygenindex") sys.stdout.write(')\n') return rootObj def main(): args = sys.argv[1:] if len(args) == 1: parse(args[0]) else: usage() if __name__ == '__main__': main() #import pdb #pdb.run('main()') gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/doxyxml/text.py000066400000000000000000000034501225753723100225000ustar00rootroot00000000000000# # Copyright 2010 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. # """ Utilities for extracting text from generated classes. """ def is_string(txt): if isinstance(txt, str): return True try: if isinstance(txt, unicode): return True except NameError: pass return False def description(obj): if obj is None: return None return description_bit(obj).strip() def description_bit(obj): if hasattr(obj, 'content'): contents = [description_bit(item) for item in obj.content] result = ''.join(contents) elif hasattr(obj, 'content_'): contents = [description_bit(item) for item in obj.content_] result = ''.join(contents) elif hasattr(obj, 'value'): result = description_bit(obj.value) elif is_string(obj): return obj else: raise StandardError('Expecting a string or something with content, content_ or value attribute') # If this bit is a paragraph then add one some line breaks. if hasattr(obj, 'name') and obj.name == 'para': result += "\n\n" return result gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/other/000077500000000000000000000000001225753723100205555ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/other/group_defs.dox000066400000000000000000000003221225753723100234230ustar00rootroot00000000000000/*! * \defgroup block GNU Radio OsmoSDR C++ Signal Processing Blocks * \brief All C++ blocks that can be used from the OsmoSDR GNU Radio * module are listed here or in the subcategories below. * */ gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/other/main_page.dox000066400000000000000000000000721225753723100232100ustar00rootroot00000000000000/*! \mainpage Welcome to the OsmoSDR GNUradio blocks */ gr-osmosdr-0.1.0.55.80c4af/docs/doxygen/swig_doc.py000066400000000000000000000207211225753723100216060ustar00rootroot00000000000000# # Copyright 2010,2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. # """ Creates the swig_doc.i SWIG interface file. Execute using: python swig_doc.py xml_path outputfilename The file instructs SWIG to transfer the doxygen comments into the python docstrings. """ import sys try: from doxyxml import DoxyIndex, DoxyClass, DoxyFriend, DoxyFunction, DoxyFile, base except ImportError: from gnuradio.doxyxml import DoxyIndex, DoxyClass, DoxyFriend, DoxyFunction, DoxyFile, base def py_name(name): bits = name.split('_') return '_'.join(bits[1:]) def make_name(name): bits = name.split('_') return bits[0] + '_make_' + '_'.join(bits[1:]) class Block(object): """ Checks if doxyxml produced objects correspond to a gnuradio block. """ @classmethod def includes(cls, item): if not isinstance(item, DoxyClass): return False # Check for a parsing error. if item.error(): return False return item.has_member(make_name(item.name()), DoxyFriend) def utoascii(text): """ Convert unicode text into ascii and escape quotes. """ if text is None: return '' out = text.encode('ascii', 'replace') out = out.replace('"', '\\"') return out def combine_descriptions(obj): """ Combines the brief and detailed descriptions of an object together. """ description = [] bd = obj.brief_description.strip() dd = obj.detailed_description.strip() if bd: description.append(bd) if dd: description.append(dd) return utoascii('\n\n'.join(description)).strip() entry_templ = '%feature("docstring") {name} "{docstring}"' def make_entry(obj, name=None, templ="{description}", description=None): """ Create a docstring entry for a swig interface file. obj - a doxyxml object from which documentation will be extracted. name - the name of the C object (defaults to obj.name()) templ - an optional template for the docstring containing only one variable named 'description'. description - if this optional variable is set then it's value is used as the description instead of extracting it from obj. """ if name is None: name=obj.name() if "operator " in name: return '' if description is None: description = combine_descriptions(obj) docstring = templ.format(description=description) if not docstring: return '' return entry_templ.format( name=name, docstring=docstring, ) def make_func_entry(func, name=None, description=None, params=None): """ Create a function docstring entry for a swig interface file. func - a doxyxml object from which documentation will be extracted. name - the name of the C object (defaults to func.name()) description - if this optional variable is set then it's value is used as the description instead of extracting it from func. params - a parameter list that overrides using func.params. """ if params is None: params = func.params params = [prm.declname for prm in params] if params: sig = "Params: (%s)" % ", ".join(params) else: sig = "Params: (NONE)" templ = "{description}\n\n" + sig return make_entry(func, name=name, templ=utoascii(templ), description=description) def make_class_entry(klass, description=None): """ Create a class docstring for a swig interface file. """ output = [] output.append(make_entry(klass, description=description)) for func in klass.in_category(DoxyFunction): name = klass.name() + '::' + func.name() output.append(make_func_entry(func, name=name)) return "\n\n".join(output) def make_block_entry(di, block): """ Create class and function docstrings of a gnuradio block for a swig interface file. """ descriptions = [] # Get the documentation associated with the class. class_desc = combine_descriptions(block) if class_desc: descriptions.append(class_desc) # Get the documentation associated with the make function make_func = di.get_member(make_name(block.name()), DoxyFunction) make_func_desc = combine_descriptions(make_func) if make_func_desc: descriptions.append(make_func_desc) # Get the documentation associated with the file try: block_file = di.get_member(block.name() + ".h", DoxyFile) file_desc = combine_descriptions(block_file) if file_desc: descriptions.append(file_desc) except base.Base.NoSuchMember: # Don't worry if we can't find a matching file. pass # And join them all together to make a super duper description. super_description = "\n\n".join(descriptions) # Associate the combined description with the class and # the make function. output = [] output.append(make_class_entry(block, description=super_description)) creator = block.get_member(block.name(), DoxyFunction) output.append(make_func_entry(make_func, description=super_description, params=creator.params)) return "\n\n".join(output) def make_swig_interface_file(di, swigdocfilename, custom_output=None): output = [""" /* * This file was automatically generated using swig_doc.py. * * Any changes to it will be lost next time it is regenerated. */ """] if custom_output is not None: output.append(custom_output) # Create docstrings for the blocks. blocks = di.in_category(Block) make_funcs = set([]) for block in blocks: try: make_func = di.get_member(make_name(block.name()), DoxyFunction) make_funcs.add(make_func.name()) output.append(make_block_entry(di, block)) except block.ParsingError: print('Parsing error for block %s' % block.name()) # Create docstrings for functions # Don't include the make functions since they have already been dealt with. funcs = [f for f in di.in_category(DoxyFunction) if f.name() not in make_funcs] for f in funcs: try: output.append(make_func_entry(f)) except f.ParsingError: print('Parsing error for function %s' % f.name()) # Create docstrings for classes block_names = [block.name() for block in blocks] klasses = [k for k in di.in_category(DoxyClass) if k.name() not in block_names] for k in klasses: try: output.append(make_class_entry(k)) except k.ParsingError: print('Parsing error for class %s' % k.name()) # Docstrings are not created for anything that is not a function or a class. # If this excludes anything important please add it here. output = "\n\n".join(output) swig_doc = file(swigdocfilename, 'w') swig_doc.write(output) swig_doc.close() if __name__ == "__main__": # Parse command line options and set up doxyxml. err_msg = "Execute using: python swig_doc.py xml_path outputfilename" if len(sys.argv) != 3: raise StandardError(err_msg) xml_path = sys.argv[1] swigdocfilename = sys.argv[2] di = DoxyIndex(xml_path) # gnuradio.gr.msq_queue.insert_tail and delete_head create errors unless docstrings are defined! # This is presumably a bug in SWIG. #msg_q = di.get_member(u'gr_msg_queue', DoxyClass) #insert_tail = msg_q.get_member(u'insert_tail', DoxyFunction) #delete_head = msg_q.get_member(u'delete_head', DoxyFunction) output = [] #output.append(make_func_entry(insert_tail, name='gr_py_msg_queue__insert_tail')) #output.append(make_func_entry(delete_head, name='gr_py_msg_queue__delete_head')) custom_output = "\n\n".join(output) # Generate the docstrings interface file. make_swig_interface_file(di, swigdocfilename, custom_output=custom_output) gr-osmosdr-0.1.0.55.80c4af/gnuradio-osmosdr.pc.in000066400000000000000000000007671225753723100212660ustar00rootroot00000000000000prefix=@CMAKE_INSTALL_PREFIX@ exec_prefix=${prefix} libdir=${exec_prefix}/@GR_LIBRARY_DIR@ includedir=${prefix}/@GR_INCLUDE_DIR@ Name: @CPACK_PACKAGE_NAME@ Description: @CPACK_PACKAGE_DESCRIPTION_SUMMARY@ URL: http://sdr.osmocom.org/trac/wiki/GrOsmoSDR Version: @CPACK_PACKAGE_VERSION@ Requires: gnuradio-runtime gnuradio-blocks Requires.private: @GR_OSMOSDR_PC_REQUIRES@ Conflicts: Cflags: -I${includedir} @GR_OSMOSDR_PC_CFLAGS@ Libs: -L${libdir} -lgnuradio-osmosdr Libs.private: @GR_OSMOSDR_PC_LIBS@ gr-osmosdr-0.1.0.55.80c4af/grc/000077500000000000000000000000001225753723100156025ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/grc/CMakeLists.txt000066400000000000000000000033001225753723100203360ustar00rootroot00000000000000# Copyright 2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # Rules for generating the source and sink xml wrappers ######################################################################## include(GrPython) macro(GEN_BLOCK_XML _generator _xml_block) set(generator ${CMAKE_CURRENT_SOURCE_DIR}/${_generator}) set(xml_block ${CMAKE_CURRENT_BINARY_DIR}/${_xml_block}) list(APPEND xml_blocks ${xml_block}) add_custom_command( DEPENDS ${generator} OUTPUT ${xml_block} COMMAND ${PYTHON_EXECUTABLE} ${generator} ${xml_block} ) endmacro(GEN_BLOCK_XML) GEN_BLOCK_XML(gen_osmosdr_blocks.py rtlsdr_source.xml) GEN_BLOCK_XML(gen_osmosdr_blocks.py osmosdr_source.xml) GEN_BLOCK_XML(gen_osmosdr_blocks.py osmosdr_sink.xml) add_custom_target(osmosdr_grc_xml_blocks ALL DEPENDS ${xml_blocks}) install(FILES ${xml_blocks} # DESTINATION ${GRC_BLOCKS_DIR} DESTINATION share/gnuradio/grc/blocks ) gr-osmosdr-0.1.0.55.80c4af/grc/gen_osmosdr_blocks.py000066400000000000000000000271101225753723100220310ustar00rootroot00000000000000""" Copyright 2012 Free Software Foundation, Inc. This file is part of GNU Radio GNU Radio Companion is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. GNU Radio Companion is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA """ MAIN_TMPL = """\ $(title) $sourk.title() $(prefix)_$(sourk) $($sourk.title())s 1 import osmosdr osmosdr.$(sourk)( args="numchan=" + str(\$nchan) + " " + \$args ) self.\$(id).set_sample_rate(\$sample_rate) #for $n in range($max_nchan) \#if \$nchan() > $n self.\$(id).set_center_freq(\$freq$(n), $n) self.\$(id).set_freq_corr(\$corr$(n), $n) #if $sourk == 'source': self.\$(id).set_dc_offset_mode(\$dc_offset_mode$(n), $n) self.\$(id).set_iq_balance_mode(\$iq_balance_mode$(n), $n) self.\$(id).set_gain_mode(\$gain_mode$(n), $n) #end if self.\$(id).set_gain(\$gain$(n), $n) self.\$(id).set_if_gain(\$if_gain$(n), $n) self.\$(id).set_bb_gain(\$bb_gain$(n), $n) self.\$(id).set_antenna(\$ant$(n), $n) self.\$(id).set_bandwidth(\$bw$(n), $n) \#end if #end for set_sample_rate(\$sample_rate) #for $n in range($max_nchan) set_center_freq(\$freq$(n), $n) set_freq_corr(\$corr$(n), $n) #if $sourk == 'source': set_dc_offset_mode(\$dc_offset_mode$(n), $n) set_iq_balance_mode(\$iq_balance_mode$(n), $n) set_gain_mode(\$gain_mode$(n), $n) #end if set_gain(\$gain$(n), $n) set_if_gain(\$if_gain$(n), $n) set_bb_gain(\$bb_gain$(n), $n) set_antenna(\$ant$(n), $n) set_bandwidth(\$bw$(n), $n) #end for $(dir.title())put Type type enum Device Arguments args string \#if \$args() none \#else part \#end if Num Channels nchan 1 int #for $n in range(1, $max_nchan+1) #end for Sample Rate (sps) sample_rate samp_rate real $params $max_nchan >= \$nchan \$nchan > 0 <$sourk> $dir \$type.type \$nchan The osmocom $sourk block: While primarily being developed for the OsmoSDR hardware, this block as well supports: #if $sourk == 'source': * FUNcube Dongle through libgnuradio-fcd * FUNcube Dongle Pro+ through gr-fcdproplus * sysmocom OsmoSDR Devices through libosmosdr * RTL2832U based DVB-T dongles through librtlsdr * RTL-TCP spectrum server (see librtlsdr project) * MSi2500 based DVB-T dongles through libmirisdr * gnuradio .cfile input through libgnuradio-blocks * RFSPACE SDR-IQ, SDR-IP, NetSDR (incl. X2 option) #end if * Great Scott Gadgets HackRF through libhackrf * Nuand LLC bladeRF through libbladeRF library * Ettus USRP Devices through Ettus UHD library * Fairwaves UmTRX through Fairwaves' fork of UHD By using the osmocom $sourk block you can take advantage of a common software api in your application(s) independent of the underlying radio hardware. Output Type: This parameter controls the data type of the stream in gnuradio. Only complex float32 samples are supported at the moment. Device Arguments: The device argument is a comma delimited string used to locate devices on your system. Device arguments for multiple devices may be given by separating them with a space. Use the device id or name/serial (if applicable) to specify a certain device or list of devices. If left blank, the first device found will be used. Examples: Optional arguments are placed into [] brackets, remove the brackets before using them! Specific variable values are separated with a |, choose one of them. Variable values containing spaces shall be enclosed in '' as demonstrated in examples section below. Lines ending with ... mean it's possible to bind devices together by specifying multiple device arguments separated with a space. #if $sourk == 'source': fcd=0[,device=hw:2][,type=2] miri=0[,buffers=32] ... rtl=serial_number ... rtl=0[,rtl_xtal=28.8e6][,tuner_xtal=28.8e6] ... rtl=1[,buffers=32][,buflen=N*512] ... rtl=2[,direct_samp=0|1|2][,offset_tune=0|1] ... rtl_tcp=127.0.0.1:1234[,psize=16384][,direct_samp=0|1|2][,offset_tune=0|1] ... osmosdr=0[,buffers=32][,buflen=N*512] ... file='/path/to/your file',rate=1e6[,freq=100e6][,repeat=true][,throttle=true] ... netsdr=127.0.0.1[:50000][,nchan=2] sdr-ip=127.0.0.1[:50000] sdr-iq=/dev/ttyUSB0 #end if hackrf=0[,buffers=32] bladerf=0[,fpga='/path/to/the/bitstream.rbf'] uhd[,serial=...][,lo_offset=0][,mcr=52e6][,nchan=2][,subdev='\\\\'B:0 A:0\\\\''] ... Num Channels: Selects the total number of channels in this multi-device configuration. Required when specifying multiple device arguments. Sample Rate: The sample rate is the number of samples per second output by this block on each channel. Frequency: The center frequency is the frequency the RF chain is tuned to. Freq. Corr.: The frequency correction factor in parts per million (ppm). Set to 0 if unknown. #if $sourk == 'source': DC Offset Mode: Controls the behavior of hardware DC offset corrrection. Off: Disable correction algorithm (pass through). Manual: Keep last estimated correction when switched from Automatic to Manual. Automatic: Periodicallly find the best solution to compensate for DC offset. This functionality is available for USRP devices only. IQ Balance Mode: Controls the behavior of software IQ imbalance corrrection. Off: Disable correction algorithm (pass through). Manual: Keep last estimated correction when switched from Automatic to Manual. Automatic: Periodicallly find the best solution to compensate for image signals. This functionality depends on http://cgit.osmocom.org/cgit/gr-iqbal/ Gain Mode: Chooses between the manual (default) and automatic gain mode where appropriate. To allow manual control of RF/IF/BB gain stages, manual gain mode must be configured. Currently, only RTL-SDR devices support automatic gain mode. #end if RF Gain: Overall RF gain of the device. IF Gain: Overall intermediate frequency gain of the device. This setting is available for RTL-SDR and OsmoSDR devices with E4000 tuners and HackRF Jawbreaker in receive and transmit mode. Observations lead to a reasonable gain range from 15 to 30dB. BB Gain: Overall baseband gain of the device. This setting is available for HackRF Jawbreaker in receive mode. Observations lead to a reasonable gain range from 15 to 30dB. Antenna: For devices with only one antenna, this may be left blank. Otherwise, the user should specify one of the possible antenna choices. Bandwidth: Set the bandpass filter on the radio frontend. To use the default (automatic) bandwidth filter setting, this should be zero. See the OsmoSDR project page for more detailed documentation: http://sdr.osmocom.org/trac/wiki/GrOsmoSDR http://sdr.osmocom.org/trac/wiki/rtl-sdr http://sdr.osmocom.org/trac/ """ PARAMS_TMPL = """ Ch$(n): Frequency (Hz) freq$(n) 100e6 real \#if \$nchan() > $n then 'none' else 'all'# Ch$(n): Freq. Corr. (ppm) corr$(n) 0 real \#if \$nchan() > $n then 'none' else 'all'# #if $sourk == 'source': Ch$(n): DC Offset Mode dc_offset_mode$(n) 0 int \#if \$nchan() > $n then 'none' else 'all'# Ch$(n): IQ Balance Mode iq_balance_mode$(n) 0 int \#if \$nchan() > $n then 'none' else 'all'# Ch$(n): Gain Mode gain_mode$(n) 0 int \#if \$nchan() > $n then 'none' else 'all'# #end if Ch$(n): RF Gain (dB) gain$(n) 10 real \#if \$nchan() > $n then 'none' else 'all'# Ch$(n): IF Gain (dB) if_gain$(n) 20 real \#if \$nchan() > $n then 'none' else 'all'# Ch$(n): BB Gain (dB) bb_gain$(n) 20 real \#if \$nchan() > $n then 'none' else 'all'# Ch$(n): Antenna ant$(n) string \#if not \$nchan() > $n all \#elif \$ant$(n)() none \#else part \#end if Ch$(n): Bandwidth (Hz) bw$(n) 0 real \#if not \$nchan() > $n all \#elif \$bw$(n)() none \#else part \#end if """ def parse_tmpl(_tmpl, **kwargs): from Cheetah import Template return str(Template.Template(_tmpl, kwargs)) max_num_channels = 5 import os.path if __name__ == '__main__': import sys for file in sys.argv[1:]: head, tail = os.path.split(file) if tail.startswith('rtlsdr'): title = 'RTL-SDR' prefix = 'rtlsdr' elif tail.startswith('osmosdr'): title = 'osmocom' prefix = 'osmosdr' else: raise Exception, 'file %s has wrong syntax!'%tail if tail.endswith ('source.xml'): sourk = 'source' dir = 'out' elif tail.endswith ('sink.xml'): sourk = 'sink' dir = 'in' else: raise Exception, 'is %s a source or sink?'%file params = ''.join([parse_tmpl(PARAMS_TMPL, n=n, sourk=sourk) for n in range(max_num_channels)]) open(file, 'w').write(parse_tmpl(MAIN_TMPL, max_nchan=max_num_channels, params=params, title=title, prefix=prefix, sourk=sourk, dir=dir, )) gr-osmosdr-0.1.0.55.80c4af/include/000077500000000000000000000000001225753723100164525ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/include/osmosdr/000077500000000000000000000000001225753723100201405ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/include/osmosdr/CMakeLists.txt000066400000000000000000000020631225753723100227010ustar00rootroot00000000000000# Copyright 2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # Install public header files ######################################################################## install(FILES api.h pimpl.h ranges.h device.h source.h sink.h DESTINATION include/osmosdr ) gr-osmosdr-0.1.0.55.80c4af/include/osmosdr/api.h000066400000000000000000000020451225753723100210630ustar00rootroot00000000000000/* * Copyright 2011 Free Software Foundation, Inc. * * This file is part of GNU Radio * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_OSMOSDR_API_H #define INCLUDED_OSMOSDR_API_H #include #ifdef gnuradio_osmosdr_EXPORTS # define OSMOSDR_API __GR_ATTR_EXPORT #else # define OSMOSDR_API __GR_ATTR_IMPORT #endif #endif /* INCLUDED_OSMOSDR_API_H */ gr-osmosdr-0.1.0.55.80c4af/include/osmosdr/device.h000066400000000000000000000073471225753723100215630ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_OSMOSDR_DEVICE_H #define INCLUDED_OSMOSDR_DEVICE_H #include #include #include #include #include #include #include #include typedef std::map string_string_dict_t; namespace osmosdr { /*! * Mapping of key/value pairs for locating devices on the system. * When left empty, the device discovery routines will search * all available transports on the system (ethernet, usb...). * * The logical device can also be used to pass arguments into * the transport layer control to set (for example) buffer sizes. * * An arguments string, is a way to represent a device address * using a single string with delimiter characters. */ class OSMOSDR_API device_t : public string_string_dict_t { public: /*! * Create a logical device from an args string. * \param args the arguments string */ device_t(const std::string &args = ""); /*! * Convert a logical device into a pretty print string. * \return a printable string representing the device */ std::string to_pp_string(void) const; /*! * Convert the logical device into an args string. * The args string contains delimiter symbols. * \return a string with delimiter markup */ std::string to_string(void) const; /*! * Lexically cast a parameter to the specified type, * or use the default value if the key is not found. * \param key the key as one of the parameters * \param def the value to use when key is not present * \return the casted value as type T or the default * \throw error when the parameter cannot be casted */ template T cast(const std::string &key, const T &def) const { if (!this->count(key)) return def; try { return boost::lexical_cast(this->at(key)); } catch(const boost::bad_lexical_cast &) { throw std::runtime_error("cannot cast " + key + " = " + this->at(key)); } } }; //! A typedef for a vector of logical devices typedef std::vector devices_t; /*! * The device interface represents the underyling hardware. * The api allows for discovery, configuration, and streaming. */ class OSMOSDR_API device : boost::noncopyable { public: /*! * \brief Find logical radio devices attached to the host. * * The device hint should be used to narrow down the search * to particular transport types and/or transport arguments. * * The device hint "nofake" switches off dummy devices created * by "file" (and other) implementations. * * \param hint a partially (or fully) filled in logical device * \return a vector of logical devices for all radios on the system */ static devices_t find(const device_t &hint = osmosdr::device_t()); }; } //namespace osmosdr #endif /* INCLUDED_OSMOSDR_DEVICE_H */ gr-osmosdr-0.1.0.55.80c4af/include/osmosdr/pimpl.h000066400000000000000000000035551225753723100214420ustar00rootroot00000000000000// // Copyright 2010 Ettus Research LLC // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see . // #ifndef INCLUDED_OSMOSDR_PIMPL_H #define INCLUDED_OSMOSDR_PIMPL_H #include /*! \file pimpl.h * "Pimpl idiom" (pointer to implementation idiom). * The OSMOSDR_PIMPL_* macros simplify code overhead for declaring and making pimpls. * * Each pimpl is implemented as a shared pointer to the implementation: * - The container class will not have to deallocate the pimpl. * - The container class will use the pimpl as a regular pointer. * - Usage: _impl->method(arg0, arg1) * - Usage: _impl->member = value; * * \see http://en.wikipedia.org/wiki/Opaque_pointer */ /*! * Make a declaration for a pimpl in a header file. * - Usage: OSMOSDR_PIMPL_DECL(impl) _impl; * \param _name the name of the pimpl class */ #define OSMOSDR_PIMPL_DECL(_name) \ struct _name; boost::shared_ptr<_name> /*! * Make an instance of a pimpl in a source file. * - Usage: _impl = OSMOSDR_PIMPL_MAKE(impl, ()); * - Usage: _impl = OSMOSDR_PIMPL_MAKE(impl, (a0, a1)); * \param _name the name of the pimpl class * \param _args the constructor args for the pimpl */ #define OSMOSDR_PIMPL_MAKE(_name, _args) \ boost::shared_ptr<_name>(new _name _args) #endif /* INCLUDED_OSMOSDR_PIMPL_H */ gr-osmosdr-0.1.0.55.80c4af/include/osmosdr/ranges.h000066400000000000000000000076441225753723100216030ustar00rootroot00000000000000// // Copyright 2010-2011 Ettus Research LLC // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see . // #ifndef INCLUDED_OSMOSDR_RANGES_H #define INCLUDED_OSMOSDR_RANGES_H #include #include #include #include namespace osmosdr{ /*! * A range object describes a set of discrete values of the form: * y = start + step*n, where n is an integer between 0 and (stop - start)/step */ class OSMOSDR_API range_t{ public: /*! * Create a range from a single value. * The step size will be taken as zero. * \param value the only possible value in this range */ range_t(double value = 0); /*! * Create a range from a full set of values. * A step size of zero implies infinite precision. * \param start the minimum value for this range * \param stop the maximum value for this range * \param step the step size for this range */ range_t(double start, double stop, double step = 0); //! Get the start value for this range. double start(void) const; //! Get the stop value for this range. double stop(void) const; //! Get the step value for this range. double step(void) const; //! Convert this range to a printable string const std::string to_pp_string(void) const; private: OSMOSDR_PIMPL_DECL(impl) _impl; }; /*! * A meta-range object holds a list of individual ranges. */ struct OSMOSDR_API meta_range_t : std::vector{ //! A default constructor for an empty meta-range meta_range_t(void); /*! * Input iterator constructor: * Makes boost::assign::list_of work. * \param first the begin iterator * \param last the end iterator */ template meta_range_t(InputIterator first, InputIterator last): std::vector(first, last){ /* NOP */ } /*! * A convenience constructor for a single range. * A step size of zero implies infinite precision. * \param start the minimum value for this range * \param stop the maximum value for this range * \param step the step size for this range */ meta_range_t(double start, double stop, double step = 0); //! Get the overall start value for this meta-range. double start(void) const; //! Get the overall stop value for this meta-range. double stop(void) const; //! Get the overall step value for this meta-range. double step(void) const; /*! * Clip the target value to a possible range value. * \param value the value to clip to this range * \param clip_step if true, clip to steps as well * \return a value that is in one of the ranges */ double clip(double value, bool clip_step = false) const; /*! return a vector containing all values of the range */ std::vector values() const; //! Convert this meta-range to a printable string const std::string to_pp_string(void) const; }; typedef meta_range_t gain_range_t; typedef meta_range_t freq_range_t; } //namespace osmosdr #endif /* INCLUDED_OSMOSDR_RANGES_H */ gr-osmosdr-0.1.0.55.80c4af/include/osmosdr/sink.h000066400000000000000000000225521225753723100212630ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_OSMOSDR_SINK_H #define INCLUDED_OSMOSDR_SINK_H #include #include #include namespace osmosdr { class sink; /*! * \brief Takes a stream of complex samples. * \ingroup block * * This uses the preferred technique: subclassing gr::hier_block2. */ class OSMOSDR_API sink : virtual public gr::hier_block2 { public: typedef boost::shared_ptr< sink > sptr; /*! * \brief Return a shared_ptr to a new instance of sink. * * To avoid accidental use of raw pointers, sink's * constructor is private. osmosdr::sink::make is the public * interface for creating new instances. * * \param args the address to identify the hardware * \return a new osmosdr sink block object */ static sptr make( const std::string & args = "" ); /*! * Get the number of channels the underlying radio hardware offers. * \return the number of available channels */ virtual size_t get_num_channels( void ) = 0; /*! * Get the possible sample rates for the underlying radio hardware. * \return a range of rates in Sps */ virtual osmosdr::meta_range_t get_sample_rates( void ) = 0; /*! * Set the sample rate for the underlying radio hardware. * This also will select the appropriate IF bandpass, if applicable. * \param rate a new rate in Sps */ virtual double set_sample_rate( double rate ) = 0; /*! * Get the sample rate for the underlying radio hardware. * This is the actual sample rate and may differ from the rate set. * \return the actual rate in Sps */ virtual double get_sample_rate( void ) = 0; /*! * Get the tunable frequency range for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the frequency range in Hz */ virtual osmosdr::freq_range_t get_freq_range( size_t chan = 0 ) = 0; /*! * Tune the underlying radio hardware to the desired center frequency. * This also will select the appropriate RF bandpass. * \param freq the desired frequency in Hz * \param chan the channel index 0 to N-1 * \return the actual frequency in Hz */ virtual double set_center_freq( double freq, size_t chan = 0 ) = 0; /*! * Get the center frequency the underlying radio hardware is tuned to. * This is the actual frequency and may differ from the frequency set. * \param chan the channel index 0 to N-1 * \return the frequency in Hz */ virtual double get_center_freq( size_t chan = 0 ) = 0; /*! * Set the frequency correction value in parts per million. * \param ppm the desired correction value in parts per million * \param chan the channel index 0 to N-1 * \return correction value in parts per million */ virtual double set_freq_corr( double ppm, size_t chan = 0 ) = 0; /*! * Get the frequency correction value. * \param chan the channel index 0 to N-1 * \return correction value in parts per million */ virtual double get_freq_corr( size_t chan = 0 ) = 0; /*! * Get the gain stage names of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return a vector of strings containing the names of gain stages */ virtual std::vector get_gain_names( size_t chan = 0 ) = 0; /*! * Get the settable overall gain range for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the gain range in dB */ virtual osmosdr::gain_range_t get_gain_range( size_t chan = 0 ) = 0; /*! * Get the settable gain range for a specific gain stage. * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the gain range in dB */ virtual osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ) = 0; /*! * Set the gain mode for the underlying radio hardware. * This might be supported only for certain hardware types. * \param automatic the gain mode (true means automatic gain mode) * \param chan the channel index 0 to N-1 * \return the actual gain mode */ virtual bool set_gain_mode( bool automatic, size_t chan = 0 ) = 0; /*! * Get the gain mode selected for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the actual gain mode (true means automatic gain mode) */ virtual bool get_gain_mode( size_t chan = 0 ) = 0; /*! * Set the gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_gain( double gain, size_t chan = 0 ) = 0; /*! * Set the named gain on the underlying radio hardware. * \param gain the gain in dB * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_gain( double gain, const std::string & name, size_t chan = 0 ) = 0; /*! * Get the actual gain setting of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double get_gain( size_t chan = 0 ) = 0; /*! * Get the actual gain setting of a named stage. * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double get_gain( const std::string & name, size_t chan = 0 ) = 0; /*! * Set the IF gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available IF gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_if_gain( double gain, size_t chan = 0 ) = 0; /*! * Set the BB gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available BB gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_bb_gain( double gain, size_t chan = 0 ) = 0; /*! * Get the available antennas of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return a vector of strings containing the names of available antennas */ virtual std::vector< std::string > get_antennas( size_t chan = 0 ) = 0; /*! * Select the active antenna of the underlying radio hardware. * \param antenna name of the antenna to be selected * \param chan the channel index 0 to N-1 * \return the actual antenna's name */ virtual std::string set_antenna( const std::string & antenna, size_t chan = 0 ) = 0; /*! * Get the actual underlying radio hardware antenna setting. * \param chan the channel index 0 to N-1 * \return the actual antenna's name */ virtual std::string get_antenna( size_t chan = 0 ) = 0; /*! * Set the TX frontend DC offset value. * The value is complex to control both I and Q. * * \param offset the dc offset (1.0 is full-scale) * \param chan the channel index 0 to N-1 */ virtual void set_dc_offset( const std::complex &offset, size_t chan = 0 ) = 0; /*! * Set the TX frontend IQ balance correction. * Use this to adjust the magnitude and phase of I and Q. * * \param balance the complex correction value * \param chan the channel index 0 to N-1 */ virtual void set_iq_balance( const std::complex &balance, size_t chan = 0 ) = 0; /*! * Set the bandpass filter on the radio frontend. * \param bandwidth the filter bandwidth in Hz, set to 0 for automatic selection * \param chan the channel index 0 to N-1 * \return the actual filter bandwidth in Hz */ virtual double set_bandwidth( double bandwidth, size_t chan = 0 ) = 0; /*! * Get the actual bandpass filter setting on the radio frontend. * \param chan the channel index 0 to N-1 * \return the actual filter bandwidth in Hz */ virtual double get_bandwidth( size_t chan = 0 ) = 0; /*! * Get the possible bandpass filter settings on the radio frontend. * \param chan the channel index 0 to N-1 * \return a range of bandwidths in Hz */ virtual osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ) = 0; }; } /* namespace osmosdr */ #endif /* INCLUDED_OSMOSDR_SINK_H */ gr-osmosdr-0.1.0.55.80c4af/include/osmosdr/source.h000066400000000000000000000246511225753723100216210ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_OSMOSDR_SOURCE_H #define INCLUDED_OSMOSDR_SOURCE_H #include #include #include namespace osmosdr { class source; /*! * \brief Provides a stream of complex samples. * \ingroup block * * This uses the preferred technique: subclassing gr::hier_block2. */ class OSMOSDR_API source : virtual public gr::hier_block2 { public: typedef boost::shared_ptr< source > sptr; /*! * \brief Return a shared_ptr to a new instance of source. * * To avoid accidental use of raw pointers, source's * constructor is private. osmosdr::source::make is the public * interface for creating new instances. * * \param args the address to identify the hardware * \return a new osmosdr source block object */ static sptr make( const std::string & args = "" ); /*! * Get the number of channels the underlying radio hardware offers. * \return the number of available channels */ virtual size_t get_num_channels( void ) = 0; /*! * Get the possible sample rates for the underlying radio hardware. * \return a range of rates in Sps */ virtual osmosdr::meta_range_t get_sample_rates( void ) = 0; /*! * Set the sample rate for the underlying radio hardware. * This also will select the appropriate IF bandpass, if applicable. * \param rate a new rate in Sps */ virtual double set_sample_rate( double rate ) = 0; /*! * Get the sample rate for the underlying radio hardware. * This is the actual sample rate and may differ from the rate set. * \return the actual rate in Sps */ virtual double get_sample_rate( void ) = 0; /*! * Get the tunable frequency range for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the frequency range in Hz */ virtual osmosdr::freq_range_t get_freq_range( size_t chan = 0 ) = 0; /*! * Tune the underlying radio hardware to the desired center frequency. * This also will select the appropriate RF bandpass. * \param freq the desired frequency in Hz * \param chan the channel index 0 to N-1 * \return the actual frequency in Hz */ virtual double set_center_freq( double freq, size_t chan = 0 ) = 0; /*! * Get the center frequency the underlying radio hardware is tuned to. * This is the actual frequency and may differ from the frequency set. * \param chan the channel index 0 to N-1 * \return the frequency in Hz */ virtual double get_center_freq( size_t chan = 0 ) = 0; /*! * Set the frequency correction value in parts per million. * \param ppm the desired correction value in parts per million * \param chan the channel index 0 to N-1 * \return correction value in parts per million */ virtual double set_freq_corr( double ppm, size_t chan = 0 ) = 0; /*! * Get the frequency correction value. * \param chan the channel index 0 to N-1 * \return correction value in parts per million */ virtual double get_freq_corr( size_t chan = 0 ) = 0; /*! * Get the gain stage names of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return a vector of strings containing the names of gain stages */ virtual std::vector get_gain_names( size_t chan = 0 ) = 0; /*! * Get the settable overall gain range for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the gain range in dB */ virtual osmosdr::gain_range_t get_gain_range( size_t chan = 0 ) = 0; /*! * Get the settable gain range for a specific gain stage. * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the gain range in dB */ virtual osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ) = 0; /*! * Set the gain mode for the underlying radio hardware. * This might be supported only for certain hardware types. * \param automatic the gain mode (true means automatic gain mode) * \param chan the channel index 0 to N-1 * \return the actual gain mode */ virtual bool set_gain_mode( bool automatic, size_t chan = 0 ) = 0; /*! * Get the gain mode selected for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the actual gain mode (true means automatic gain mode) */ virtual bool get_gain_mode( size_t chan = 0 ) = 0; /*! * Set the gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_gain( double gain, size_t chan = 0 ) = 0; /*! * Set the named gain on the underlying radio hardware. * \param gain the gain in dB * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_gain( double gain, const std::string & name, size_t chan = 0 ) = 0; /*! * Get the actual gain setting of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double get_gain( size_t chan = 0 ) = 0; /*! * Get the actual gain setting of a named stage. * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double get_gain( const std::string & name, size_t chan = 0 ) = 0; /*! * Set the IF gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available IF gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_if_gain( double gain, size_t chan = 0 ) = 0; /*! * Set the BB gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available BB gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_bb_gain( double gain, size_t chan = 0 ) = 0; /*! * Get the available antennas of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return a vector of strings containing the names of available antennas */ virtual std::vector< std::string > get_antennas( size_t chan = 0 ) = 0; /*! * Select the active antenna of the underlying radio hardware. * \param antenna name of the antenna to be selected * \param chan the channel index 0 to N-1 * \return the actual antenna's name */ virtual std::string set_antenna( const std::string & antenna, size_t chan = 0 ) = 0; /*! * Get the actual underlying radio hardware antenna setting. * \param chan the channel index 0 to N-1 * \return the actual antenna's name */ virtual std::string get_antenna( size_t chan = 0 ) = 0; enum DCOffsetMode { DCOffsetOff = 0, DCOffsetManual, DCOffsetAutomatic }; /*! * Set the RX frontend DC correction mode. * The automatic correction subtracts out the long-run average. * * When disabled, the averaging option operation is reset. * Once in Manual mode, the average value will be held constant until * the user re-enables the automatic correction or overrides the * value by manually setting the offset. * * \param mode dc offset correction mode: 0 = Off, 1 = Manual, 2 = Automatic * \param chan the channel index 0 to N-1 */ virtual void set_dc_offset_mode( int mode, size_t chan = 0) = 0; /*! * Set the RX frontend DC offset value. * The value is complex to control both I and Q. * Only set this when automatic correction is disabled. * * \param offset the dc offset (1.0 is full-scale) * \param chan the channel index 0 to N-1 */ virtual void set_dc_offset( const std::complex &offset, size_t chan = 0 ) = 0; enum IQBalanceMode { IQBalanceOff = 0, IQBalanceManual, IQBalanceAutomatic }; /*! * Set the RX frontend IQ balance mode. * * \param mode iq balance correction mode: 0 = Off, 1 = Manual, 2 = Automatic * \param chan the channel index 0 to N-1 */ virtual void set_iq_balance_mode( int mode, size_t chan = 0 ) = 0; /*! * Set the RX frontend IQ balance correction. * Use this to adjust the magnitude and phase of I and Q. * * \param balance the complex correction value * \param chan the channel index 0 to N-1 */ virtual void set_iq_balance( const std::complex &balance, size_t chan = 0 ) = 0; /*! * Set the bandpass filter on the radio frontend. * \param bandwidth the filter bandwidth in Hz, set to 0 for automatic selection * \param chan the channel index 0 to N-1 * \return the actual filter bandwidth in Hz */ virtual double set_bandwidth( double bandwidth, size_t chan = 0 ) = 0; /*! * Get the actual bandpass filter setting on the radio frontend. * \param chan the channel index 0 to N-1 * \return the actual filter bandwidth in Hz */ virtual double get_bandwidth( size_t chan = 0 ) = 0; /*! * Get the possible bandpass filter settings on the radio frontend. * \param chan the channel index 0 to N-1 * \return a range of bandwidths in Hz */ virtual osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ) = 0; }; } /* namespace osmosdr */ #endif /* INCLUDED_OSMOSDR_SOURCE_H */ gr-osmosdr-0.1.0.55.80c4af/lib/000077500000000000000000000000001225753723100155755ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/lib/CMakeLists.txt000066400000000000000000000151341225753723100203410ustar00rootroot00000000000000# Copyright 2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # Setup library ######################################################################## INCLUDE(GrPlatform) #define LIB_SUFFIX INCLUDE(GrMiscUtils) INCLUDE(GrComponent) ######################################################################## # Helpful Macros ######################################################################## MACRO(GR_OSMOSDR_APPEND_SRCS) LIST(APPEND gr_osmosdr_srcs ${ARGV}) ENDMACRO(GR_OSMOSDR_APPEND_SRCS) MACRO(GR_OSMOSDR_APPEND_LIBS) LIST(APPEND gr_osmosdr_libs ${ARGV}) ENDMACRO(GR_OSMOSDR_APPEND_LIBS) GR_OSMOSDR_APPEND_SRCS( source_impl.cc sink_impl.cc ranges.cc device.cc ) GR_OSMOSDR_APPEND_LIBS( ${Boost_LIBRARIES} ${GNURADIO_RUNTIME_LIBRARIES} ${GNURADIO_PMT_LIBRARIES} ${GNURADIO_BLOCKS_LIBRARIES} ) ######################################################################## # Setup IQBalance component ######################################################################## GR_REGISTER_COMPONENT("Osmocom IQ Imbalance Correction" ENABLE_IQBALANCE GNURADIO_IQBALANCE_FOUND) if(ENABLE_IQBALANCE) add_definitions(-DHAVE_IQBALANCE=1) include_directories(${GNURADIO_IQBALANCE_INCLUDE_DIRS}) GR_OSMOSDR_APPEND_LIBS(${GNURADIO_IQBALANCE_LIBRARIES}) endif(ENABLE_IQBALANCE) ######################################################################## # Setup OsmoSDR component ######################################################################## GR_REGISTER_COMPONENT("sysmocom OsmoSDR" ENABLE_OSMOSDR LIBOSMOSDR_FOUND) if(ENABLE_OSMOSDR) GR_INCLUDE_SUBDIRECTORY(osmosdr) endif(ENABLE_OSMOSDR) ######################################################################## # Setup FCD component ######################################################################## GR_REGISTER_COMPONENT("FUNcube Dongle" ENABLE_FCD GNURADIO_FCD_FOUND) GR_REGISTER_COMPONENT("FUNcube Dongle Pro+" ENABLE_FCDPP GNURADIO_FCDPP_FOUND) if(ENABLE_FCD) add_definitions(-DHAVE_FCD=1) endif(ENABLE_FCD) if(ENABLE_FCDPP) add_definitions(-DHAVE_FCDPP=1) endif(ENABLE_FCDPP) if(ENABLE_FCD OR ENABLE_FCDPP) GR_INCLUDE_SUBDIRECTORY(fcd) endif(ENABLE_FCD OR ENABLE_FCDPP) ######################################################################## # Setup File component ######################################################################## GR_REGISTER_COMPONENT("IQ File Source" ENABLE_FILE GNURADIO_BLOCKS_FOUND) if(ENABLE_FILE) GR_INCLUDE_SUBDIRECTORY(file) endif(ENABLE_FILE) ######################################################################## # Setup RTL component ######################################################################## GR_REGISTER_COMPONENT("Osmocom RTLSDR" ENABLE_RTL LIBRTLSDR_FOUND) if(ENABLE_RTL) GR_INCLUDE_SUBDIRECTORY(rtl) endif(ENABLE_RTL) ######################################################################## # Setup RTL_TCP component ######################################################################## GR_REGISTER_COMPONENT("RTLSDR TCP Client" ENABLE_RTL_TCP GNURADIO_BLOCKS_FOUND) if(ENABLE_RTL_TCP) GR_INCLUDE_SUBDIRECTORY(rtl_tcp) endif(ENABLE_RTL_TCP) ######################################################################## # Setup UHD component ######################################################################## GR_REGISTER_COMPONENT("Ettus USRP Devices" ENABLE_UHD UHD_FOUND GNURADIO_UHD_FOUND) if(ENABLE_UHD) GR_INCLUDE_SUBDIRECTORY(uhd) endif(ENABLE_UHD) ######################################################################## # Setup MiriSDR component ######################################################################## GR_REGISTER_COMPONENT("Osmocom MiriSDR" ENABLE_MIRI LIBMIRISDR_FOUND) if(ENABLE_MIRI) GR_INCLUDE_SUBDIRECTORY(miri) endif(ENABLE_MIRI) ######################################################################## # Setup HackRF component ######################################################################## GR_REGISTER_COMPONENT("HackRF Jawbreaker" ENABLE_HACKRF LIBHACKRF_FOUND) if(ENABLE_HACKRF) GR_INCLUDE_SUBDIRECTORY(hackrf) endif(ENABLE_HACKRF) ######################################################################## # Setup bladeRF component ######################################################################## GR_REGISTER_COMPONENT("nuand bladeRF" ENABLE_BLADERF LIBBLADERF_FOUND) if(ENABLE_BLADERF) GR_INCLUDE_SUBDIRECTORY(bladerf) endif(ENABLE_BLADERF) ######################################################################## # Setup RFSPACE component ######################################################################## GR_REGISTER_COMPONENT("RFSPACE Receivers" ENABLE_RFSPACE) if(ENABLE_RFSPACE) GR_INCLUDE_SUBDIRECTORY(rfspace) endif(ENABLE_RFSPACE) ######################################################################## # Setup configuration file ######################################################################## ADD_DEFINITIONS(-DHAVE_CONFIG_H=1) include_directories(BEFORE ${CMAKE_CURRENT_BINARY_DIR}) CONFIGURE_FILE( ${CMAKE_CURRENT_SOURCE_DIR}/config.h.in ${CMAKE_CURRENT_BINARY_DIR}/config.h @ONLY) ######################################################################## # Set up Windows DLL resource files ######################################################################## IF(MSVC) include(${CMAKE_SOURCE_DIR}/cmake/Modules/GrVersion.cmake) configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/gnuradio-osmosdr.rc.in ${CMAKE_CURRENT_BINARY_DIR}/gnuradio-osmosdr.rc @ONLY) GR_OSMOSDR_APPEND_SRCS(${CMAKE_CURRENT_BINARY_DIR}/gnuradio-osmosdr.rc) ENDIF(MSVC) ######################################################################## # Setup libgnuradio-osmosdr library ######################################################################## ADD_LIBRARY(gnuradio-osmosdr SHARED ${gr_osmosdr_srcs}) TARGET_LINK_LIBRARIES(gnuradio-osmosdr ${gr_osmosdr_libs}) SET_TARGET_PROPERTIES(gnuradio-osmosdr PROPERTIES DEFINE_SYMBOL "gnuradio_osmosdr_EXPORTS") GR_LIBRARY_FOO(gnuradio-osmosdr) gr-osmosdr-0.1.0.55.80c4af/lib/arg_helpers.h000066400000000000000000000102451225753723100202430ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef OSMOSDR_ARG_HELPERS_H #define OSMOSDR_ARG_HELPERS_H #include #include #include #include #include #include #include typedef std::map< std::string, std::string > dict_t; typedef std::pair< std::string, std::string > pair_t; inline std::vector< std::string > args_to_vector( const std::string &args ) { std::vector< std::string > result; boost::escaped_list_separator separator("\\", " ", "'"); typedef boost::tokenizer< boost::escaped_list_separator > tokenizer_t; tokenizer_t tokens(args, separator); BOOST_FOREACH(std::string token, tokens) result.push_back(token); return result; } inline std::vector< std::string > params_to_vector( const std::string ¶ms ) { std::vector< std::string > result; boost::escaped_list_separator separator("\\", ",", "'"); typedef boost::tokenizer< boost::escaped_list_separator > tokenizer_t; tokenizer_t tokens(params, separator); BOOST_FOREACH(std::string token, tokens) result.push_back(token); return result; } inline pair_t param_to_pair( const std::string ¶m ) { pair_t result; std::size_t pos = param.find('='); if(pos != std::string::npos) { result.first = param.substr(0, pos); result.second = param.substr(pos + 1); } else { result.first = param; result.second = ""; } return result; } inline dict_t params_to_dict( const std::string ¶ms ) { dict_t result; std::vector< std::string > param_list = params_to_vector( params ); BOOST_FOREACH(std::string param, param_list) { pair_t pair = param_to_pair( param ); std::string value = pair.second; if (value.length() && value[0] == '\'' && value[ value.length() - 1 ] == '\'') value = value.substr(1, value.length() - 1); result[ pair.first ] = value; } return result; } struct is_nchan_argument { bool operator ()(const std::string &str) { return str.find("numchan=") == 0; } }; inline gr::io_signature::sptr args_to_io_signature( const std::string &args ) { size_t max_nchan = 0; size_t dev_nchan = 0; std::vector< std::string > arg_list = args_to_vector( args ); BOOST_FOREACH( std::string arg, arg_list ) { if ( arg.find( "numchan=" ) == 0 ) // try to parse global nchan value { pair_t pair = param_to_pair( arg ); max_nchan = boost::lexical_cast( pair.second ); } } arg_list.erase( std::remove_if( // remove any global nchan tokens arg_list.begin(), arg_list.end(), is_nchan_argument() ), arg_list.end() ); // try to parse device specific nchan values, assume 1 channel if none given BOOST_FOREACH( std::string arg, arg_list ) { dict_t dict = params_to_dict(arg); if (dict.count("nchan")) { dev_nchan += boost::lexical_cast( dict["nchan"] ); } else // no channels given via args { dev_nchan++; // assume one channel } } // if at least one nchan was given, perform a sanity check if ( max_nchan && dev_nchan && max_nchan != dev_nchan ) throw std::runtime_error("Wrong device arguments specified. Missing nchan?"); const size_t nchan = std::max(dev_nchan, 1); // assume at least one return gr::io_signature::make(nchan, nchan, sizeof(gr_complex)); } #endif // OSMOSDR_ARG_HELPERS_H gr-osmosdr-0.1.0.55.80c4af/lib/bladerf/000077500000000000000000000000001225753723100171745ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/lib/bladerf/CMakeLists.txt000066400000000000000000000027631225753723100217440ustar00rootroot00000000000000# Copyright 2013 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # This file included, use CMake directory variables ######################################################################## include_directories( ${CMAKE_CURRENT_SOURCE_DIR} ${LIBBLADERF_INCLUDE_DIRS} ) set(bladerf_srcs ${CMAKE_CURRENT_SOURCE_DIR}/bladerf_source_c.cc ${CMAKE_CURRENT_SOURCE_DIR}/bladerf_sink_c.cc ${CMAKE_CURRENT_SOURCE_DIR}/bladerf_common.cc ) ######################################################################## # Append gnuradio-osmosdr library sources ######################################################################## list(APPEND gr_osmosdr_srcs ${bladerf_srcs}) list(APPEND gr_osmosdr_libs ${LIBBLADERF_LIBRARIES}) gr-osmosdr-0.1.0.55.80c4af/lib/bladerf/bladerf_common.cc000066400000000000000000000212001225753723100224450ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Nuand LLC * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ /* * config.h is generated by configure. It contains the results * of probing for features, options etc. It should be the first * file included in your .cc file. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include #include #include #include #include #include #include #include #include "bladerf_common.h" #define NUM_BUFFERS 32 #define NUM_SAMPLES_PER_BUFFER (4 * 1024) using namespace boost::assign; boost::mutex bladerf_common::_devs_mutex; std::list > bladerf_common::_devs; bladerf_common::bladerf_common() : _is_running(false) {} bladerf_common::~bladerf_common() {} bladerf_sptr bladerf_common:: get_cached_device(struct bladerf_devinfo devinfo) { /* Lock to _devs must be aquired by caller */ BOOST_FOREACH( boost::weak_ptr dev, _devs ) { struct bladerf_devinfo other_devinfo; int rv = bladerf_get_devinfo(bladerf_sptr(dev).get(), &other_devinfo); if (rv < 0) throw std::runtime_error(std::string(__FUNCTION__) + " " + "Failed to get devinfo for cached device."); if (bladerf_devinfo_matches(&devinfo, &other_devinfo)) { return bladerf_sptr(dev); } } return bladerf_sptr(); } void bladerf_common::close(void* dev) { boost::unique_lock lock(_devs_mutex); std::list >::iterator it; for (it = _devs.begin(); it != _devs.end(); ++it) if ( (*it).expired() == 0 ) _devs.erase(it); bladerf_close((struct bladerf *)dev); } bladerf_sptr bladerf_common::open(const std::string &device_name) { int rv; struct bladerf *raw_dev; struct bladerf_devinfo devinfo; boost::unique_lock lock(_devs_mutex); rv = bladerf_get_devinfo_from_str(device_name.c_str(), &devinfo); if (rv < 0) throw std::runtime_error(std::string(__FUNCTION__) + " " + "Failed to get devinfo for '" + device_name + "'"); bladerf_sptr cached_dev = get_cached_device(devinfo); if (cached_dev) return cached_dev; rv = bladerf_open_with_devinfo(&raw_dev, &devinfo); if (rv < 0) throw std::runtime_error(std::string(__FUNCTION__) + " " + "Failed to open device for '" + device_name + "'"); bladerf_sptr dev = bladerf_sptr(raw_dev, bladerf_common::close); _devs.push_back(boost::weak_ptr(dev)); return dev; } void bladerf_common::init(dict_t &dict, const char *type) { int ret; unsigned int device_number = 0; std::string device_name; struct bladerf_version ver; char serial[BLADERF_SERIAL_LENGTH]; _pfx = std::string("[bladeRF ") + std::string(type) + std::string("] "); if (dict.count("bladerf")) { std::string value = dict["bladerf"]; if ( value.length() ) { try { device_number = boost::lexical_cast< unsigned int >( value ); } catch ( std::exception &ex ) { throw std::runtime_error( _pfx + "Failed to use '" + value + "' as device number: " + ex.what()); } } } device_name = boost::str(boost::format( "libusb:instance=%d" ) % device_number); try { _dev = open(device_name); } catch(...) { throw std::runtime_error( _pfx + "Failed to open bladeRF device " + device_name ); } /* Load an FPGA */ if ( dict.count("fpga") ) { if ( dict.count("fpga-reload") == 0 && bladerf_is_fpga_configured( _dev.get() ) == 1 ) { std::cerr << _pfx << "FPGA is already loaded. Set fpga-reload=1 " << "to force a reload." << std::endl; } else { std::string fpga = dict["fpga"]; std::cerr << _pfx << "Loading FPGA bitstream " << fpga << "..." << std::endl; ret = bladerf_load_fpga( _dev.get(), fpga.c_str() ); if ( ret != 0 ) std::cerr << _pfx << "bladerf_load_fpga has failed with " << ret << std::endl; else std::cerr << _pfx << "The FPGA bitstream has been successfully loaded." << std::endl; } } if ( bladerf_is_fpga_configured( _dev.get() ) != 1 ) { std::ostringstream oss; oss << _pfx << "The FPGA is not configured! " << "Provide device argument fpga=/path/to/the/bitstream.rbf to load it."; throw std::runtime_error( oss.str() ); } /* Show some info about the device we've opened */ std::cerr << _pfx << "Using nuand LLC bladeRF #" << device_number; if ( bladerf_get_serial( _dev.get(), serial ) == 0 ) std::cerr << " SN " << serial; if ( bladerf_fw_version( _dev.get(), &ver ) == 0 ) std::cerr << " FW v" << ver.major << "." << ver.minor << "." << ver.patch; if ( bladerf_fpga_version( _dev.get(), &ver ) == 0 ) std::cerr << " FPGA v" << ver.major << "." << ver.minor << "." << ver.patch; std::cerr << std::endl; /* Initialize buffer and sample configuration */ _num_buffers = 0; if (dict.count("buffers")) { _num_buffers = boost::lexical_cast< size_t >( dict["buffers"] ); } _samples_per_buffer = 0; if (dict.count("buflen")) { _samples_per_buffer = boost::lexical_cast< size_t >( dict["buflen"] ); } _num_transfers = 0; if (dict.count("transfers")) { _num_transfers = boost::lexical_cast< size_t >( dict["transfers"] ); } /* Require value to be >= 2 so we can ensure we have twice as many * buffers as transfers */ if (_num_buffers <= 1) { _num_buffers = NUM_BUFFERS; } if (0 == _samples_per_buffer) { _samples_per_buffer = NUM_SAMPLES_PER_BUFFER; } else { if (_samples_per_buffer < 1024 || _samples_per_buffer % 1024 != 0) { /* 0 likely implies the user did not specify this, so don't warn */ if (_samples_per_buffer != 0 ) { std::cerr << _pfx << "Invalid \"buflen\" value. " << "A multiple of 1024 is required. Defaulting to " << NUM_SAMPLES_PER_BUFFER << std::endl; } _samples_per_buffer = NUM_SAMPLES_PER_BUFFER; } } if (_num_transfers == 0 || _num_transfers > (_num_buffers / 2)) { _num_transfers = _num_buffers / 2; } } osmosdr::freq_range_t bladerf_common::freq_range() { /* assuming the same for RX & TX */ return osmosdr::freq_range_t( 300e6, 3.8e9 ); } osmosdr::meta_range_t bladerf_common::sample_rates() { osmosdr::meta_range_t sample_rates; /* assuming the same for RX & TX */ sample_rates += osmosdr::range_t( 160e3, 200e3, 40e3 ); sample_rates += osmosdr::range_t( 300e3, 900e3, 100e3 ); sample_rates += osmosdr::range_t( 1e6, 40e6, 1e6 ); return sample_rates; } osmosdr::freq_range_t bladerf_common::filter_bandwidths() { /* the same for RX & TX according to the datasheet */ osmosdr::freq_range_t bandwidths; std::vector half_bandwidths; /* in MHz */ half_bandwidths += \ 0.75, 0.875, 1.25, 1.375, 1.5, 1.92, 2.5, 2.75, 3, 3.5, 4.375, 5, 6, 7, 10, 14; BOOST_FOREACH( double half_bw, half_bandwidths ) bandwidths += osmosdr::range_t( half_bw * 2e6 ); return bandwidths; } std::vector< std::string > bladerf_common::devices() { struct bladerf_devinfo *devices; ssize_t n_devices; std::vector< std::string > ret; n_devices = bladerf_get_device_list(&devices); if (n_devices > 0) { for (ssize_t i = 0; i < n_devices; i++) { std::stringstream s; std::string serial(devices[i].serial); s << "bladerf=" << devices[i].instance << "," << "label='nuand bladeRF"; if ( serial.length() ) s << " SN " << serial; s << "'"; ret.push_back(s.str()); } bladerf_free_device_list(devices); } return ret; } bool bladerf_common::is_running() { boost::shared_lock lock(_state_lock); return _is_running; } void bladerf_common::set_running( bool is_running ) { boost::unique_lock lock(_state_lock); _is_running = is_running; } gr-osmosdr-0.1.0.55.80c4af/lib/bladerf/bladerf_common.h000066400000000000000000000050461225753723100223210ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Nuand LLC * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_BLADERF_COMMON_H #define INCLUDED_BLADERF_COMMON_H #include #include #include #include #include #include #include #include #include #include #include #include #include "osmosdr/ranges.h" #include "arg_helpers.h" /* We currently read/write 1024 samples (pairs of 16-bit signed ints) */ #define BLADERF_SAMPLE_BLOCK_SIZE (1024) typedef boost::shared_ptr bladerf_sptr; class bladerf_common { public: bladerf_common(); virtual ~bladerf_common(); protected: /* Handle initialized and parameters common to both source & sink */ void init(dict_t &dict, const char *type); osmosdr::freq_range_t freq_range(); osmosdr::meta_range_t sample_rates(); osmosdr::freq_range_t filter_bandwidths(); static std::vector< std::string > devices(); bool is_running(); void set_running(bool is_running); bladerf_sptr _dev; void **_buffers; struct bladerf_stream *_stream; size_t _num_buffers; size_t _buf_index; size_t _samples_per_buffer; size_t _num_transfers; gr::thread::thread _thread; osmosdr::gain_range_t _vga1_range; osmosdr::gain_range_t _vga2_range; std::string _pfx; private: bladerf_sptr open(const std::string &device_name); bool _is_running; boost::shared_mutex _state_lock; static boost::mutex _devs_mutex; static std::list > _devs; static bladerf_sptr get_cached_device(struct bladerf_devinfo devinfo); static void close(void *dev); /* called by shared_ptr */ }; #endif gr-osmosdr-0.1.0.55.80c4af/lib/bladerf/bladerf_sink_c.cc000066400000000000000000000373261225753723100224430ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Nuand LLC * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ /* * config.h is generated by configure. It contains the results * of probing for features, options etc. It should be the first * file included in your .cc file. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include #include #include #include #include #include "arg_helpers.h" #include "bladerf_sink_c.h" using namespace boost::assign; /* * Create a new instance of bladerf_source_c and return * a boost shared_ptr. This is effectively the public constructor. */ bladerf_sink_c_sptr make_bladerf_sink_c (const std::string &args) { return gnuradio::get_initial_sptr(new bladerf_sink_c (args)); } /* * Specify constraints on number of input and output streams. * This info is used to construct the input and output signatures * (2nd & 3rd args to gr_block's constructor). The input and * output signatures are used by the runtime system to * check that a valid number and type of inputs and outputs * are connected to this block. In this case, we accept * only 0 input and 1 output. */ static const int MIN_IN = 1; // mininum number of input streams static const int MAX_IN = 1; // maximum number of input streams static const int MIN_OUT = 0; // minimum number of output streams static const int MAX_OUT = 0; // maximum number of output streams /* * The private constructor */ bladerf_sink_c::bladerf_sink_c (const std::string &args) : gr::sync_block ("bladerf_sink_c", gr::io_signature::make (MIN_IN, MAX_IN, sizeof (gr_complex)), gr::io_signature::make (MIN_OUT, MAX_OUT, sizeof (gr_complex))) { int ret; dict_t dict = params_to_dict(args); /* Perform src/sink agnostic initializations */ init(dict, "source"); /* Set the range of VGA1, VGA1GAINT[7:0] */ _vga1_range = osmosdr::gain_range_t( -35, -4, 1 ); /* Set the range of VGA2, VGA2GAIN[4:0] */ _vga2_range = osmosdr::gain_range_t( 0, 25, 1 ); /* Initialize the stream */ ret = bladerf_init_stream( &_stream, _dev.get(), stream_callback, &_buffers, _num_buffers, BLADERF_FORMAT_SC16_Q12, _samples_per_buffer, _num_transfers, this ); if ( ret != 0 ) std::cerr << _pfx << "bladerf_init_stream failed:" << bladerf_strerror(ret) << std::endl; /* Initialize buffer management */ _buf_index = _next_to_tx = 0; _next_value = static_cast(_buffers[0]); _samples_left = _samples_per_buffer; _filled = new bool[_num_buffers]; if (!_filled) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Failed to allocate _filled[]" ); } for (size_t i = 0; i < _num_buffers; ++i) { _filled[i] = false; } ret = bladerf_enable_module( _dev.get(), BLADERF_MODULE_TX, true ); if ( ret != 0 ) std::cerr << _pfx << "bladerf_enable_module has failed:" << bladerf_strerror(ret) << std::endl; set_running( true ); _thread = gr::thread::thread( boost::bind(&bladerf_sink_c::write_task, this) ); } /* * Our virtual destructor. */ bladerf_sink_c::~bladerf_sink_c () { int ret; set_running(false); /* Ensure work() or callbacks return from wait() calls */ _buf_status_lock.lock(); _buffer_filled.notify_all(); _buffer_emptied.notify_all(); _buf_status_lock.unlock(); _thread.join(); ret = bladerf_enable_module( _dev.get(), BLADERF_MODULE_TX, false ); if ( ret != 0 ) std::cerr << _pfx << "bladerf_enable_module failed:" << bladerf_strerror(ret) << std::endl; /* Release stream resources */ bladerf_deinit_stream(_stream); delete[] _filled; } void *bladerf_sink_c::stream_callback( struct bladerf *dev, struct bladerf_stream *stream, struct bladerf_metadata *metadata, void *samples, size_t num_samples, void *user_data ) { bladerf_sink_c *obj = (bladerf_sink_c *) user_data; return obj->get_next_buffer( samples, num_samples ); } static size_t buffer2index(void **buffers, void *current, size_t num_buffers) { for (size_t i = 0; i < num_buffers; ++i) { if (static_cast(current) == static_cast(buffers[i])) return i; } throw std::runtime_error( std::string(__FUNCTION__) + " " + "Has hit unexpected condition"); } /* Fetch the next full buffer to pass down to the device */ void *bladerf_sink_c::get_next_buffer( void *samples, size_t num_samples) { void *ret; bool running; { boost::unique_lock lock(_buf_status_lock); /* Mark the incoming buffer empty and notify work() */ if (samples) { size_t buffer_emptied_index = buffer2index(_buffers, samples, _num_buffers); _filled[buffer_emptied_index] = false; _buffer_emptied.notify_one(); } /* Wait for our next buffer to become filled */ while ((running = is_running()) && !_filled[_next_to_tx]) { _buffer_filled.wait(lock); } if (running) { ret = _buffers[_next_to_tx]; _next_to_tx = (_next_to_tx + 1) % _num_buffers; } else { ret = NULL; } } return ret; } void bladerf_sink_c::write_task() { int status; /* Start stream and stay there until we kill the stream */ status = bladerf_stream(_stream, BLADERF_MODULE_TX); if ( status < 0 ) { std::cerr << _pfx << "Sink stream error: " << bladerf_strerror(status) << std::endl; if ( status == BLADERF_ERR_TIMEOUT ) { std::cerr << _pfx << "Try adjusting your sample rate or the " << "\"buffers\", \"buflen\", and \"transfers\" parameters. " << std::endl; } } set_running( false ); } int bladerf_sink_c::work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ) { const gr_complex *in = (const gr_complex *) input_items[0]; int num_samples; bool running = is_running(); /* Total samples we want to process */ num_samples = noutput_items; /* While there are still samples to copy out ... */ while (running && num_samples > 0) { while (_samples_left && num_samples) { /* Scale and sign extend I and then Q */ *_next_value = (int16_t)(real(*in) * 2000); _next_value++; *_next_value = (int16_t)(imag(*in) * 2000); _next_value++; /* Advance to next sample */ in++; num_samples--; _samples_left--; } /* Advance to the next buffer if the current one is filled */ if (_samples_left == 0) { { boost::unique_lock lock(_buf_status_lock); _filled[_buf_index] = true; _buf_index = (_buf_index + 1) % _num_buffers; _next_value = static_cast(_buffers[_buf_index]); _samples_left = _samples_per_buffer; /* Signal that we have filled a buffer */ _buffer_filled.notify_one(); /* Wait here if the next buffer isn't full. The callback will * signal us when it has freed up a buffer */ while (_filled[_buf_index] && running) { _buffer_emptied.wait(lock); running = is_running(); } } } } return running ? noutput_items : 0; } std::vector bladerf_sink_c::get_devices() { return bladerf_common::devices(); } size_t bladerf_sink_c::get_num_channels() { /* We only support a single channel for each bladeRF */ return 1; } osmosdr::meta_range_t bladerf_sink_c::get_sample_rates() { return sample_rates(); } double bladerf_sink_c::set_sample_rate(double rate) { int ret; uint32_t actual; /* Set the Si5338 to be 2x this sample rate */ /* Check to see if the sample rate is an integer */ if( (uint32_t)round(rate) == (uint32_t)rate ) { ret = bladerf_set_sample_rate( _dev.get(), BLADERF_MODULE_TX, (uint32_t)rate, &actual ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Failed to set integer rate:" + std::string(bladerf_strerror(ret))); } } else { /* TODO: Fractional sample rate */ ret = bladerf_set_sample_rate( _dev.get(), BLADERF_MODULE_TX, (uint32_t)rate, &actual ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Failed to set fractional rate: " + std::string(bladerf_strerror(ret))); } } return get_sample_rate(); } double bladerf_sink_c::get_sample_rate() { int ret; unsigned int rate = 0; ret = bladerf_get_sample_rate( _dev.get(), BLADERF_MODULE_TX, &rate ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + "Failed to get sample rate:" + std::string(bladerf_strerror(ret))); } return (double)rate; } osmosdr::freq_range_t bladerf_sink_c::get_freq_range( size_t chan ) { return freq_range(); } double bladerf_sink_c::set_center_freq( double freq, size_t chan ) { int ret; /* Check frequency range */ if( freq < get_freq_range( chan ).start() || freq > get_freq_range( chan ).stop() ) { std::cerr << "Failed to set out of bound frequency: " << freq << std::endl; } else { ret = bladerf_set_frequency( _dev.get(), BLADERF_MODULE_TX, (uint32_t)freq ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Failed to set center frequency " + boost::lexical_cast(freq) + ":" + std::string(bladerf_strerror(ret))); } } return get_center_freq( chan ); } double bladerf_sink_c::get_center_freq( size_t chan ) { uint32_t freq; int ret; ret = bladerf_get_frequency( _dev.get(), BLADERF_MODULE_TX, &freq ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Failed to get center frequency:" + std::string(bladerf_strerror(ret))); } return (double)freq; } double bladerf_sink_c::set_freq_corr( double ppm, size_t chan ) { /* TODO: Write the VCTCXO with a correction value (also changes RX ppm value!) */ return get_freq_corr( chan ); } double bladerf_sink_c::get_freq_corr( size_t chan ) { /* TODO: Return back the frequency correction in ppm */ return 0; } std::vector bladerf_sink_c::get_gain_names( size_t chan ) { std::vector< std::string > names; names += "VGA1", "VGA2"; return names; } osmosdr::gain_range_t bladerf_sink_c::get_gain_range( size_t chan ) { /* TODO: This is an overall system gain range. Given the VGA1 and VGA2 how much total gain can we have in the system */ return get_gain_range( "VGA2", chan ); /* we use only VGA2 here for now */ } osmosdr::gain_range_t bladerf_sink_c::get_gain_range( const std::string & name, size_t chan ) { osmosdr::gain_range_t range; if( name == "VGA1" ) { range = _vga1_range; } else if( name == "VGA2" ) { range = _vga2_range; } else { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Requested an invalid gain element " + name ); } return range; } bool bladerf_sink_c::set_gain_mode( bool automatic, size_t chan ) { return false; } bool bladerf_sink_c::get_gain_mode( size_t chan ) { return false; } double bladerf_sink_c::set_gain( double gain, size_t chan ) { return set_gain( gain, "VGA2", chan ); /* we use only VGA2 here for now */ } double bladerf_sink_c::set_gain( double gain, const std::string & name, size_t chan) { int ret = 0; if( name == "VGA1" ) { ret = bladerf_set_txvga1( _dev.get(), (int)gain ); } else if( name == "VGA2" ) { ret = bladerf_set_txvga2( _dev.get(), (int)gain ); } else { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Requested to set the gain " + "of an unknown gain element " + name ); } /* Check for errors */ if( ret ) { throw std::runtime_error(std::string(__FUNCTION__) + " " + "Could not set " + name + " gain, error " + std::string(bladerf_strerror(ret))); } return get_gain( name, chan ); } double bladerf_sink_c::get_gain( size_t chan ) { return get_gain( "VGA2", chan ); /* we use only VGA2 here for now */ } double bladerf_sink_c::get_gain( const std::string & name, size_t chan ) { int g; int ret = 0; if( name == "VGA1" ) { ret = bladerf_get_txvga1( _dev.get(), &g ); } else if( name == "VGA2" ) { ret = bladerf_get_txvga2( _dev.get(), &g ); } else { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Requested to get the gain " + "of an unknown gain element " + name ); } /* Check for errors */ if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Could not get " + name + " gain, error " + std::string(bladerf_strerror(ret))); } return (double)g; } double bladerf_sink_c::set_bb_gain( double gain, size_t chan ) { /* for TX, only VGA1 is in the BB path */ osmosdr::gain_range_t bb_gains = get_gain_range( "VGA1", chan ); double clip_gain = bb_gains.clip( gain, true ); gain = set_gain( clip_gain, "VGA1", chan ); return gain; } std::vector< std::string > bladerf_sink_c::get_antennas( size_t chan ) { std::vector< std::string > antennas; antennas += get_antenna( chan ); return antennas; } std::string bladerf_sink_c::set_antenna( const std::string & antenna, size_t chan ) { return get_antenna( chan ); } std::string bladerf_sink_c::get_antenna( size_t chan ) { /* We only have a single transmit antenna here */ return "TX"; } double bladerf_sink_c::set_bandwidth( double bandwidth, size_t chan ) { int ret; uint32_t actual; if ( bandwidth == 0.0 ) /* bandwidth of 0 means automatic filter selection */ bandwidth = get_sample_rate() * 0.75; /* select narrower filters to prevent aliasing */ ret = bladerf_set_bandwidth( _dev.get(), BLADERF_MODULE_TX, (uint32_t)bandwidth, &actual ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Could not set bandwidth, error " + boost::lexical_cast(ret) ); } return get_bandwidth(); } double bladerf_sink_c::get_bandwidth( size_t chan ) { uint32_t bandwidth; int ret; ret = bladerf_get_bandwidth( _dev.get(), BLADERF_MODULE_TX, &bandwidth ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Could not get bandwidth, error " + boost::lexical_cast(ret) ); } return (double)bandwidth; } osmosdr::freq_range_t bladerf_sink_c::get_bandwidth_range( size_t chan ) { return filter_bandwidths(); } gr-osmosdr-0.1.0.55.80c4af/lib/bladerf/bladerf_sink_c.h000066400000000000000000000123521225753723100222750ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Nuand LLC * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_BLADERF_SINK_C_H #define INCLUDED_BLADERF_SINK_C_H #include #include #include #include "osmosdr/ranges.h" #include "sink_iface.h" #include "bladerf_common.h" class bladerf_sink_c; /* * We use boost::shared_ptr's instead of raw pointers for all access * to gr_blocks (and many other data structures). The shared_ptr gets * us transparent reference counting, which greatly simplifies storage * management issues. This is especially helpful in our hybrid * C++ / Python system. * * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm * * As a convention, the _sptr suffix indicates a boost::shared_ptr */ typedef boost::shared_ptr bladerf_sink_c_sptr; /*! * \brief Return a shared_ptr to a new instance of bladerf_sink_c. * * To avoid accidental use of raw pointers, bladerf_sink_c's * constructor is private. make_bladerf_sink_c is the public * interface for creating new instances. */ bladerf_sink_c_sptr make_bladerf_sink_c (const std::string & args = ""); class bladerf_sink_c : public gr::sync_block, public sink_iface, protected bladerf_common { private: // The friend declaration allows bladerf_make_sink_c to // access the private constructor. friend bladerf_sink_c_sptr make_bladerf_sink_c (const std::string & args); bladerf_sink_c (const std::string & args); // private constructor public: ~bladerf_sink_c (); // public destructor int work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ); static std::vector< std::string > get_devices(); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); bool set_gain_mode( bool automatic, size_t chan = 0 ); bool get_gain_mode( size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); double set_bb_gain( double gain, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); double set_bandwidth( double bandwidth, size_t chan = 0 ); double get_bandwidth( size_t chan = 0 ); osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ); private: /* functions */ static void *stream_callback( struct bladerf *_dev, struct bladerf_stream *stream, struct bladerf_metadata *metadata, void *samples, size_t num_samples, void *user_data ); void *get_next_buffer(void *samples, size_t num_samples); void write_task(); private: /* members */ /* Array denoting whether each buffer is filled with data and ready to TX */ bool *_filled; /* Acquire while updating _filled, and signalling/waiting on * _buffer_emptied and _buffer_filled */ boost::mutex _buf_status_lock; /* work() may block waiting for the stream callback to empty (consume) a * buffer. The callback uses this to signal when it has emptied a buffer. */ boost::condition_variable _buffer_emptied; /* The stream callback may block waiting for work() to fill (produce) a * buffer. work() uses this to signal that it has filled a buffer. */ boost::condition_variable _buffer_filled; /* These values are only to be updated and accessed from within work() */ int16_t *_next_value; /* I/Q value insertion point in current buffer */ size_t _samples_left; /* # of samples left to fill in our current buffer */ /* This should only be accessed and updated from TX callbacks */ size_t _next_to_tx; /* Next buffer to transmit */ }; #endif /* INCLUDED_BLADERF_SINK_C_H */ gr-osmosdr-0.1.0.55.80c4af/lib/bladerf/bladerf_source_c.cc000066400000000000000000000456421225753723100227770ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Nuand LLC * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ /* * config.h is generated by configure. It contains the results * of probing for features, options etc. It should be the first * file included in your .cc file. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include #include #include #include #include #include "arg_helpers.h" #include "bladerf_source_c.h" #include "osmosdr/source.h" /* * Default size of sample FIFO, in entries. */ #define BLADERF_SAMPLE_FIFO_SIZE (2 * 1024 * 1024) #define BLADERF_SAMPLE_FIFO_MIN_SIZE (3 * BLADERF_SAMPLE_BLOCK_SIZE) using namespace boost::assign; /* * Create a new instance of bladerf_source_c and return * a boost shared_ptr. This is effectively the public constructor. */ bladerf_source_c_sptr make_bladerf_source_c (const std::string &args) { return gnuradio::get_initial_sptr(new bladerf_source_c (args)); } /* * Specify constraints on number of input and output streams. * This info is used to construct the input and output signatures * (2nd & 3rd args to gr_block's constructor). The input and * output signatures are used by the runtime system to * check that a valid number and type of inputs and outputs * are connected to this block. In this case, we accept * only 0 input and 1 output. */ static const int MIN_IN = 0; // mininum number of input streams static const int MAX_IN = 0; // maximum number of input streams static const int MIN_OUT = 1; // minimum number of output streams static const int MAX_OUT = 1; // maximum number of output streams /* * The private constructor */ bladerf_source_c::bladerf_source_c (const std::string &args) : gr::sync_block ("bladerf_source_c", gr::io_signature::make (MIN_IN, MAX_IN, sizeof (gr_complex)), gr::io_signature::make (MIN_OUT, MAX_OUT, sizeof (gr_complex))) { int ret; size_t fifo_size; std::string device_name; dict_t dict = params_to_dict(args); init(dict, "source"); fifo_size = BLADERF_SAMPLE_FIFO_SIZE; if (dict.count("fifo")) { try { fifo_size = boost::lexical_cast(dict["fifo"]); } catch (const boost::bad_lexical_cast &e) { std::cerr << _pfx << "Warning: \"fifo\" value is invalid. Defaulting to " << fifo_size; } if (fifo_size < BLADERF_SAMPLE_FIFO_MIN_SIZE) { fifo_size = BLADERF_SAMPLE_FIFO_MIN_SIZE; std::cerr << _pfx << "Warning: \"fifo\" value is too small. Defaulting to " << BLADERF_SAMPLE_FIFO_MIN_SIZE; } } _fifo = new boost::circular_buffer(fifo_size); if (!_fifo) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "Failed to allocate a sample FIFO!" ); } if (dict.count("sampling")) { std::string sampling = dict["sampling"]; std::cerr << _pfx << "Setting bladerf sampling to " << sampling << std::endl; if( sampling == "internal") { ret = bladerf_set_sampling( _dev.get(), BLADERF_SAMPLING_INTERNAL ); if ( ret != 0 ) std::cerr << _pfx << "Problem while setting sampling mode:" << bladerf_strerror(ret) << std::endl; } else if( sampling == "external" ) { ret = bladerf_set_sampling( _dev.get(), BLADERF_SAMPLING_EXTERNAL ); if ( ret != 0 ) std::cerr << _pfx << "Problem while setting sampling mode:" << bladerf_strerror(ret) << std::endl; } else { std::cerr << _pfx << "Invalid sampling mode " << sampling << std::endl; } } /* Set the range of LNA, G_LNA_RXFE[1:0] */ _lna_range = osmosdr::gain_range_t( 0, 6, 3 ); /* Set the range of VGA1, RFB_TIA_RXFE[6:0], nonlinear mapping done inside the lib */ _vga1_range = osmosdr::gain_range_t( 5, 30, 1 ); /* Set the range of VGA2 VGA2GAIN[4:0], not recommended to be used above 30dB */ _vga2_range = osmosdr::gain_range_t( 0, 60, 3 ); /* Initialize the stream */ _buf_index = 0; ret = bladerf_init_stream( &_stream, _dev.get(), stream_callback, &_buffers, _num_buffers, BLADERF_FORMAT_SC16_Q12, _samples_per_buffer, _num_buffers, this ); if ( ret != 0 ) std::cerr << _pfx << "bladerf_init_stream failed: " << bladerf_strerror(ret) << std::endl; ret = bladerf_enable_module( _dev.get(), BLADERF_MODULE_RX, true ); if ( ret != 0 ) std::cerr << _pfx << "bladerf_enable_module failed:" << bladerf_strerror(ret) << std::endl; _thread = gr::thread::thread( boost::bind(&bladerf_source_c::read_task, this) ); } /* * Our virtual destructor. */ bladerf_source_c::~bladerf_source_c () { int ret; set_running(false); _thread.join(); ret = bladerf_enable_module( _dev.get(), BLADERF_MODULE_RX, false ); if ( ret != 0 ) std::cerr << _pfx << "bladerf_enable_module failed: " << bladerf_strerror(ret) << std::endl; /* Release stream resources */ bladerf_deinit_stream(_stream); delete _fifo; } void *bladerf_source_c::stream_callback( struct bladerf *dev, struct bladerf_stream *stream, struct bladerf_metadata *metadata, void *samples, size_t num_samples, void *user_data ) { bladerf_source_c *obj = (bladerf_source_c *) user_data; if ( ! obj->is_running() ) return NULL; return obj->stream_task( samples, num_samples ); } /* Convert & push samples to the sample fifo */ void *bladerf_source_c::stream_task( void *samples, size_t num_samples ) { size_t i, n_avail, to_copy; int16_t *sample = (int16_t *)samples; void *ret; ret = _buffers[_buf_index]; _buf_index = (_buf_index + 1) % _num_buffers; _fifo_lock.lock(); n_avail = _fifo->capacity() - _fifo->size(); to_copy = (n_avail < num_samples ? n_avail : num_samples); for(i = 0; i < to_copy; i++ ) { /* Mask valid bits only */ *(sample) &= 0xfff; *(sample+1) &= 0xfff; /* Sign extend the 12-bit IQ values, if needed */ if( (*sample) & 0x800 ) *(sample) |= 0xf000; if( *(sample+1) & 0x800 ) *(sample+1) |= 0xf000; /* Push sample to the fifo */ _fifo->push_back( gr_complex( *sample * (1.0f/2048.0f), *(sample+1) * (1.0f/2048.0f) ) ); /* offset to the next I+Q sample */ sample += 2; } _fifo_lock.unlock(); /* We have made some new samples available to the consumer in work() */ if (to_copy) { //std::cerr << "+" << std::flush; _samp_avail.notify_one(); } /* Indicate overrun, if neccesary */ if (to_copy < num_samples) std::cerr << "O" << std::flush; return ret; } void bladerf_source_c::read_task() { int status; set_running( true ); /* Start stream and stay there until we kill the stream */ status = bladerf_stream(_stream, BLADERF_MODULE_RX); if ( status < 0 ) { std::cerr << "Source stream error: " << bladerf_strerror(status) << std::endl; if ( status == BLADERF_ERR_TIMEOUT ) { std::cerr << _pfx << "Try adjusting your sample rate or the " << "\"buffers\", \"buflen\", and \"transfers\" parameters. " << std::endl; } } set_running( false ); } /* Main work function, pull samples from the sample fifo */ int bladerf_source_c::work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ) { if ( ! is_running() ) return WORK_DONE; if( noutput_items > 0 ) { gr_complex *out = (gr_complex *)output_items[0]; boost::unique_lock lock(_fifo_lock); /* Wait until we have the requested number of samples */ int n_samples_avail = _fifo->size(); while (n_samples_avail < noutput_items) { _samp_avail.wait(lock); n_samples_avail = _fifo->size(); } for(int i = 0; i < noutput_items; ++i) { out[i] = _fifo->at(0); _fifo->pop_front(); } //std::cerr << "-" << std::flush; } return noutput_items; } std::vector bladerf_source_c::get_devices() { return bladerf_common::devices(); } size_t bladerf_source_c::get_num_channels() { /* We only support a single channel for each bladeRF */ return 1; } osmosdr::meta_range_t bladerf_source_c::get_sample_rates() { return sample_rates(); } double bladerf_source_c::set_sample_rate( double rate ) { int ret; uint32_t actual; /* Set the Si5338 to be 2x this sample rate */ /* Check to see if the sample rate is an integer */ if( (uint32_t)round(rate) == (uint32_t)rate ) { ret = bladerf_set_sample_rate( _dev.get(), BLADERF_MODULE_RX, (uint32_t)rate, &actual ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "has failed to set integer rate: " + std::string(bladerf_strerror(ret)) ); } } else { /* TODO: Fractional sample rate */ ret = bladerf_set_sample_rate( _dev.get(), BLADERF_MODULE_RX, (uint32_t)rate, &actual ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "has failed to set fractional rate: " + std::string(bladerf_strerror(ret)) ); } } return get_sample_rate(); } double bladerf_source_c::get_sample_rate() { int ret; unsigned int rate = 0; ret = bladerf_get_sample_rate( _dev.get(), BLADERF_MODULE_RX, &rate ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "has failed to get sample rate, error " + std::string(bladerf_strerror(ret)) ); } return (double)rate; } osmosdr::freq_range_t bladerf_source_c::get_freq_range( size_t chan ) { return freq_range(); } double bladerf_source_c::set_center_freq( double freq, size_t chan ) { int ret; /* Check frequency range */ if( freq < get_freq_range( chan ).start() || freq > get_freq_range( chan ).stop() ) { std::cerr << "Failed to set out of bound frequency: " << freq << std::endl; } else { ret = bladerf_set_frequency( _dev.get(), BLADERF_MODULE_RX, (uint32_t)freq ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "failed to set center frequency " + boost::lexical_cast(freq) + ": " + std::string(bladerf_strerror(ret)) ); } } return get_center_freq( chan ); } double bladerf_source_c::get_center_freq( size_t chan ) { uint32_t freq; int ret; ret = bladerf_get_frequency( _dev.get(), BLADERF_MODULE_RX, &freq ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "failed to get center frequency: " + std::string(bladerf_strerror(ret)) ); } return (double)freq; } double bladerf_source_c::set_freq_corr( double ppm, size_t chan ) { /* TODO: Write the VCTCXO with a correction value (also changes TX ppm value!) */ return get_freq_corr( chan ); } double bladerf_source_c::get_freq_corr( size_t chan ) { /* TODO: Return back the frequency correction in ppm */ return 0; } std::vector bladerf_source_c::get_gain_names( size_t chan ) { std::vector< std::string > names; names += "LNA", "VGA1", "VGA2"; return names; } osmosdr::gain_range_t bladerf_source_c::get_gain_range( size_t chan ) { /* TODO: This is an overall system gain range. Given the LNA, VGA1 and VGA2 how much total gain can we have in the system */ return get_gain_range( "LNA", chan ); /* we use only LNA here for now */ } osmosdr::gain_range_t bladerf_source_c::get_gain_range( const std::string & name, size_t chan ) { osmosdr::gain_range_t range; if( name == "LNA" ) { range = _lna_range; } else if( name == "VGA1" ) { range = _vga1_range; } else if( name == "VGA2" ) { range = _vga2_range; } else { throw std::runtime_error( std::string(__FUNCTION__) + " " + "requested an invalid gain element " + name ); } return range; } bool bladerf_source_c::set_gain_mode( bool automatic, size_t chan ) { /* TODO: Implement AGC in the FPGA */ return false; } bool bladerf_source_c::get_gain_mode( size_t chan ) { /* TODO: Read back AGC mode */ return false; } double bladerf_source_c::set_gain( double gain, size_t chan ) { /* TODO: This is an overall system gain that has to be set */ return set_gain( gain, "LNA", chan ); /* we use only LNA here for now */ } double bladerf_source_c::set_gain( double gain, const std::string & name, size_t chan ) { int ret = 0; if( name == "LNA" ) { bladerf_lna_gain g; if ( gain >= 6.0f ) g = BLADERF_LNA_GAIN_MAX; else if ( gain >= 3.0f ) g = BLADERF_LNA_GAIN_MID; else /* gain < 3.0f */ g = BLADERF_LNA_GAIN_BYPASS; ret = bladerf_set_lna_gain( _dev.get(), g ); } else if( name == "VGA1" ) { ret = bladerf_set_rxvga1( _dev.get(), (int)gain ); } else if( name == "VGA2" ) { ret = bladerf_set_rxvga2( _dev.get(), (int)gain ); } else { throw std::runtime_error( std::string(__FUNCTION__) + " " + "requested to set the gain " "of an unknown gain element " + name ); } /* Check for errors */ if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "could not set " + name + " gain: " + std::string(bladerf_strerror(ret)) ); } return get_gain( name, chan ); } double bladerf_source_c::get_gain( size_t chan ) { /* TODO: This is an overall system gain that has to be set */ return get_gain( "LNA", chan ); /* we use only LNA here for now */ } double bladerf_source_c::get_gain( const std::string & name, size_t chan ) { int g; int ret = 0; if( name == "LNA" ) { bladerf_lna_gain lna_g; ret = bladerf_get_lna_gain( _dev.get(), &lna_g ); g = lna_g == BLADERF_LNA_GAIN_BYPASS ? 0 : lna_g == BLADERF_LNA_GAIN_MID ? 3 : 6; } else if( name == "VGA1" ) { ret = bladerf_get_rxvga1( _dev.get(), &g ); } else if( name == "VGA2" ) { ret = bladerf_get_rxvga2( _dev.get(), &g ); } else { throw std::runtime_error( std::string(__FUNCTION__) + " " + "requested to get the gain " "of an unknown gain element " + name ); } /* Check for errors */ if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "could not get " + name + " gain: " + std::string(bladerf_strerror(ret)) ); } return (double)g; } double bladerf_source_c::set_bb_gain( double gain, size_t chan ) { /* TODO: for RX, we should combine VGA1 & VGA2 which both are in BB path */ osmosdr::gain_range_t bb_gains = get_gain_range( "VGA2", chan ); double clip_gain = bb_gains.clip( gain, true ); gain = set_gain( clip_gain, "VGA2", chan ); return gain; } std::vector< std::string > bladerf_source_c::get_antennas( size_t chan ) { std::vector< std::string > antennas; antennas += get_antenna( chan ); return antennas; } std::string bladerf_source_c::set_antenna( const std::string & antenna, size_t chan ) { return get_antenna( chan ); } std::string bladerf_source_c::get_antenna( size_t chan ) { /* We only have a single receive antenna here */ return "RX"; } void bladerf_source_c::set_dc_offset_mode( int mode, size_t chan ) { std::cerr << __FUNCTION__ << " mode: " << mode << std::endl; /* TODO: remove */ if ( osmosdr::source::DCOffsetOff == mode ) { //_src->set_auto_dc_offset( false, chan ); //_src->set_dc_offset( std::complex(0.0, 0.0), chan ); /* TODO: reset to default for off-state */ } else if ( osmosdr::source::DCOffsetManual == mode ) { //_src->set_auto_dc_offset( false, chan ); /* disable auto mode, but keep correcting with last known values */ } else if ( osmosdr::source::DCOffsetAutomatic == mode ) { //_src->set_auto_dc_offset( true, chan ); } } void bladerf_source_c::set_dc_offset( const std::complex &offset, size_t chan ) { std::cerr << __FUNCTION__ << " offset: " << offset.real() << " " << offset.imag() << std::endl; /* TODO: remove */ } void bladerf_source_c::set_iq_balance_mode( int mode, size_t chan ) { std::cerr << __FUNCTION__ << " mode: " << mode << std::endl; /* TODO: remove */ if ( osmosdr::source::IQBalanceOff == mode ) { //_src->set_auto_iq_balance( false, chan ); //_src->set_iq_balance( std::complex(0.0, 0.0), chan ); /* TODO: reset to default for off-state */ } else if ( osmosdr::source::IQBalanceManual == mode ) { //_src->set_auto_iq_balance( false, chan ); /* disable auto mode, but keep correcting with last known values */ } else if ( osmosdr::source::IQBalanceAutomatic == mode ) { //_src->set_auto_iq_balance( true, chan ); } } void bladerf_source_c::set_iq_balance( const std::complex &balance, size_t chan ) { std::cerr << __FUNCTION__ << " balance: " << balance.real() << " " << balance.imag() << std::endl; /* TODO: remove */ } double bladerf_source_c::set_bandwidth( double bandwidth, size_t chan ) { int ret; uint32_t actual; if ( bandwidth == 0.0 ) /* bandwidth of 0 means automatic filter selection */ bandwidth = get_sample_rate() * 0.75; /* select narrower filters to prevent aliasing */ ret = bladerf_set_bandwidth( _dev.get(), BLADERF_MODULE_RX, (uint32_t)bandwidth, &actual ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "could not set bandwidth: " + std::string(bladerf_strerror(ret)) ); } return get_bandwidth(); } double bladerf_source_c::get_bandwidth( size_t chan ) { uint32_t bandwidth; int ret; ret = bladerf_get_bandwidth( _dev.get(), BLADERF_MODULE_RX, &bandwidth ); if( ret ) { throw std::runtime_error( std::string(__FUNCTION__) + " " + "could not get bandwidth:" + std::string(bladerf_strerror(ret)) ); } return (double)bandwidth; } osmosdr::freq_range_t bladerf_source_c::get_bandwidth_range( size_t chan ) { return filter_bandwidths(); } gr-osmosdr-0.1.0.55.80c4af/lib/bladerf/bladerf_source_c.h000066400000000000000000000120501225753723100226240ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Nuand LLC * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_BLADERF_SOURCE_C_H #define INCLUDED_BLADERF_SOURCE_C_H #include #include #include #include "osmosdr/ranges.h" #include "source_iface.h" #include "bladerf_common.h" class bladerf_source_c; /* * We use boost::shared_ptr's instead of raw pointers for all access * to gr_blocks (and many other data structures). The shared_ptr gets * us transparent reference counting, which greatly simplifies storage * management issues. This is especially helpful in our hybrid * C++ / Python system. * * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm * * As a convention, the _sptr suffix indicates a boost::shared_ptr */ typedef boost::shared_ptr bladerf_source_c_sptr; /*! * \brief Return a shared_ptr to a new instance of bladerf_source_c. * * To avoid accidental use of raw pointers, bladerf_source_c's * constructor is private. bladerf_make_source_c is the public * interface for creating new instances. */ bladerf_source_c_sptr make_bladerf_source_c (const std::string & args = ""); class bladerf_source_c : public gr::sync_block, public source_iface, protected bladerf_common { private: // The friend declaration allows bladerf_make_source_c to // access the private constructor. friend bladerf_source_c_sptr make_bladerf_source_c (const std::string & args); bladerf_source_c (const std::string & args); // private constructor public: ~bladerf_source_c (); // public destructor int work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ); static std::vector< std::string > get_devices(); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); bool set_gain_mode( bool automatic, size_t chan = 0 ); bool get_gain_mode( size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); double set_bb_gain( double gain, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); void set_dc_offset_mode( int mode, size_t chan = 0 ); void set_dc_offset( const std::complex &offset, size_t chan = 0 ); void set_iq_balance_mode( int mode, size_t chan = 0 ); void set_iq_balance( const std::complex &balance, size_t chan = 0 ); double set_bandwidth( double bandwidth, size_t chan = 0 ); double get_bandwidth( size_t chan = 0 ); osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ); private: /* functions */ static void *stream_callback( struct bladerf *_dev, struct bladerf_stream *stream, struct bladerf_metadata *metadata, void *samples, size_t num_samples, void *user_data ); void *stream_task(void *samples, size_t num_samples); void read_task(); private: /* members */ osmosdr::gain_range_t _lna_range; /* The stream callback converts SC16Q12 samples from the bladeRF to gr_complex * values, and adds them to this FIFO. work() fetches the gr_complex values * from this queue */ boost::circular_buffer *_fifo; boost::mutex _fifo_lock; /* work() will block if the stream callback hasn't produced samples. The * callback uses this to notify work of the availability of samples */ boost::condition_variable _samp_avail; }; #endif /* INCLUDED_BLADERF_SOURCE_C_H */ gr-osmosdr-0.1.0.55.80c4af/lib/config.h.in000066400000000000000000000006221225753723100176200ustar00rootroot00000000000000#ifndef CONFIG_H_IN #define CONFIG_H_IN #define GR_OSMOSDR_VERSION "@VERSION@" #define GR_OSMOSDR_LIBVER "@LIBVER@" #cmakedefine ENABLE_OSMOSDR #cmakedefine ENABLE_FCD #cmakedefine ENABLE_FILE #cmakedefine ENABLE_RTL #cmakedefine ENABLE_RTL_TCP #cmakedefine ENABLE_UHD #cmakedefine ENABLE_MIRI #cmakedefine ENABLE_HACKRF #cmakedefine ENABLE_BLADERF #cmakedefine ENABLE_RFSPACE #endif // CONFIG_H_IN gr-osmosdr-0.1.0.55.80c4af/lib/device.cc000066400000000000000000000105351225753723100173470ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #include #include #include #include #include #include #include #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifdef ENABLE_OSMOSDR #include #endif #ifdef ENABLE_FCD #include #endif #ifdef ENABLE_FILE #include #endif #ifdef ENABLE_RTL #include #endif #ifdef ENABLE_RTL_TCP #include #endif #ifdef ENABLE_UHD #include #endif #ifdef ENABLE_MIRI #include #endif #ifdef ENABLE_HACKRF #include #endif #ifdef ENABLE_BLADERF #include #endif #ifdef ENABLE_RFSPACE #include #endif #include "arg_helpers.h" using namespace osmosdr; static const std::string args_delim = " "; static const std::string pairs_delim = ","; static const std::string pair_delim = "="; static boost::mutex _device_mutex; device_t::device_t(const std::string &args) { dict_t dict = params_to_dict(args); BOOST_FOREACH( dict_t::value_type &entry, dict ) (*this)[entry.first] = entry.second; } std::string device_t::to_pp_string(void) const { if (this->size() == 0) return "Empty Device Address"; std::stringstream ss; ss << "Device Address:" << std::endl; BOOST_FOREACH(const device_t::value_type &entry, *this) { ss << boost::format(" %s: %s") % entry.first % entry.second << std::endl; } return ss.str(); } std::string device_t::to_string(void) const { std::stringstream ss; size_t count = 0; BOOST_FOREACH(const device_t::value_type &entry, *this) { std::string value = entry.second; if (value.find(" ") != std::string::npos) value = "'" + value + "'"; ss << ((count++) ? pairs_delim : "") + entry.first; if (value.length()) ss << pair_delim + value; } return ss.str(); } devices_t device::find(const device_t &hint) { boost::mutex::scoped_lock lock(_device_mutex); bool fake = true; if ( hint.count("nofake") ) fake = false; devices_t devices; #ifdef ENABLE_OSMOSDR BOOST_FOREACH( std::string dev, osmosdr_src_c::get_devices() ) devices.push_back( device_t(dev) ); #endif #ifdef ENABLE_FCD BOOST_FOREACH( std::string dev, fcd_source_c::get_devices() ) devices.push_back( device_t(dev) ); #endif #ifdef ENABLE_RTL BOOST_FOREACH( std::string dev, rtl_source_c::get_devices() ) devices.push_back( device_t(dev) ); #endif #ifdef ENABLE_UHD BOOST_FOREACH( std::string dev, uhd_source_c::get_devices() ) devices.push_back( device_t(dev) ); #endif #ifdef ENABLE_MIRI BOOST_FOREACH( std::string dev, miri_source_c::get_devices() ) devices.push_back( device_t(dev) ); #endif #ifdef ENABLE_BLADERF BOOST_FOREACH( std::string dev, bladerf_source_c::get_devices() ) devices.push_back( device_t(dev) ); #endif #ifdef ENABLE_HACKRF BOOST_FOREACH( std::string dev, hackrf_source_c::get_devices() ) devices.push_back( device_t(dev) ); #endif #ifdef ENABLE_RFSPACE BOOST_FOREACH( std::string dev, rfspace_source_c::get_devices( fake ) ) devices.push_back( device_t(dev) ); #endif /* software-only sources should be appended at the very end, * hopefully resulting in hardware sources to be shown first * in a graphical interface etc... */ #ifdef ENABLE_RTL_TCP BOOST_FOREACH( std::string dev, rtl_tcp_source_c::get_devices( fake ) ) devices.push_back( device_t(dev) ); #endif #ifdef ENABLE_FILE BOOST_FOREACH( std::string dev, file_source_c::get_devices( fake ) ) devices.push_back( device_t(dev) ); #endif return devices; } gr-osmosdr-0.1.0.55.80c4af/lib/fcd/000077500000000000000000000000001225753723100163315ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/lib/fcd/CMakeLists.txt000066400000000000000000000032171225753723100210740ustar00rootroot00000000000000# Copyright 2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # This file included, use CMake directory variables ######################################################################## include_directories(${CMAKE_CURRENT_SOURCE_DIR}) if(ENABLE_FCD) include_directories(${GNURADIO_FCD_INCLUDE_DIRS}) endif(ENABLE_FCD) if(ENABLE_FCDPP) include_directories(${GNURADIO_FCDPP_INCLUDE_DIRS}) endif(ENABLE_FCDPP) set(fcd_srcs ${CMAKE_CURRENT_SOURCE_DIR}/fcd_source_c.cc ) ######################################################################## # Append gnuradio-osmosdr library sources ######################################################################## list(APPEND gr_osmosdr_srcs ${fcd_srcs}) if(ENABLE_FCD) list(APPEND gr_osmosdr_libs ${GNURADIO_FCD_LIBRARIES}) endif(ENABLE_FCD) if(ENABLE_FCDPP) list(APPEND gr_osmosdr_libs ${GNURADIO_FCDPP_LIBRARIES}) endif(ENABLE_FCDPP) gr-osmosdr-0.1.0.55.80c4af/lib/fcd/fcd_source_c.cc000066400000000000000000000226141225753723100212630ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #include #include #include #include #include #include #include "fcd_source_c.h" #include "arg_helpers.h" using namespace boost::assign; fcd_source_c_sptr make_fcd_source_c(const std::string &args) { return gnuradio::get_initial_sptr(new fcd_source_c(args)); } /* 2 [V10 ]: USB-Audio - FUNcube Dongle V1.0 Hanlincrest Ltd. FUNcube Dongle V1.0 at usb-0000:00:1d.0-2, full speed */ /* 2 [V20 ]: USB-Audio - FUNcube Dongle V2.0 Hanlincrest Ltd. FUNcube Dongle V2.0 at usb-0000:00:1d.0-2, full speed */ typedef std::pair< fcd_source_c::dongle_type, std::string > device_t; typedef std::vector< device_t > devices_t; static devices_t _get_devices() /* FIXME: non-portable way to discover dongles */ { devices_t devices; std::string line; std::ifstream cards( "/proc/asound/cards" ); if ( cards.is_open() ) { while ( cards.good() ) { getline (cards, line); fcd_source_c::dongle_type type = fcd_source_c::FUNCUBE_UNKNOWN; if ( line.find( "USB-Audio - FUNcube Dongle V1.0" ) != std::string::npos ) type = fcd_source_c::FUNCUBE_V1; if ( line.find( "USB-Audio - FUNcube Dongle V2.0" ) != std::string::npos ) type = fcd_source_c::FUNCUBE_V2; if ( type != fcd_source_c::FUNCUBE_UNKNOWN ) { int id; std::istringstream( line ) >> id; std::ostringstream hw_id; hw_id << "hw:" << id; /* build alsa identifier */ devices += device_t( type, hw_id.str() ); } } cards.close(); } return devices; } fcd_source_c::fcd_source_c(const std::string &args) : gr::hier_block2("fcd_source_c", gr::io_signature::make(0, 0, 0), gr::io_signature::make(1, 1, sizeof (gr_complex))), _type( FUNCUBE_UNKNOWN ) { std::string dev_name; unsigned int dev_index = 0; dict_t dict = params_to_dict(args); if (dict.count("fcd")) { std::string value = dict["fcd"]; if ( value.length() ) { try { dev_index = boost::lexical_cast< unsigned int >( value ); } catch ( std::exception &ex ) { throw std::runtime_error( "Failed to use '" + value + "' as index: " + ex.what()); } } } if (dict.count("device")) { dev_name = dict["device"]; _type = FUNCUBE_V1; } if (dict.count("type")) { _type = (dongle_type) boost::lexical_cast< int >( dict["type"] ); if ( FUNCUBE_V1 != _type && FUNCUBE_V2 != _type ) throw std::runtime_error("FUNcube Dongle type must be 1 or 2."); } devices_t devices = _get_devices(); if ( devices.size() ) { if ( FUNCUBE_UNKNOWN == _type ) _type = devices[dev_index].first; if ( dev_name.length() == 0 ) dev_name = devices[dev_index].second; } else if ( dev_name.length() == 0 ) throw std::runtime_error("No FUNcube Dongle found."); std::cerr << "Using " << name() << " (" << dev_name << ")" << std::endl; #ifdef HAVE_FCD if ( FUNCUBE_V1 == _type ) { _src_v1 = gr::fcd::source_c::make( dev_name ); connect( _src_v1, 0, self(), 0 ); set_gain( 20, "LNA" ); set_gain( 12, "MIX" ); } #endif #ifdef HAVE_FCDPP if ( FUNCUBE_V2 == _type ) { _src_v2 = gr::fcdproplus::fcdproplus::make( dev_name ); connect( _src_v2, 0, self(), 0 ); set_gain( 1, "LNA" ); set_gain( 1, "MIX" ); set_gain( 15, "BB" ); } #endif } fcd_source_c::~fcd_source_c() { } std::vector< std::string > fcd_source_c::get_devices() { int id = 0; std::vector< std::string > devices; BOOST_FOREACH( device_t dev, _get_devices() ) { std::string args = "fcd=" + boost::lexical_cast< std::string >( id++ ); if ( dev.first == fcd_source_c::FUNCUBE_V1 ) args += ",label='FUNcube Dongle V1.0'"; else if ( dev.first == fcd_source_c::FUNCUBE_V2 ) args += ",label='FUNcube Dongle V2.0'"; devices.push_back( args ); } return devices; } std::string fcd_source_c::name() { if ( FUNCUBE_V1 == _type ) return "FUNcube Dongle V1.0"; else if ( FUNCUBE_V2 == _type ) return "FUNcube Dongle V2.0"; return ""; } size_t fcd_source_c::get_num_channels( void ) { return 1; } osmosdr::meta_range_t fcd_source_c::get_sample_rates( void ) { osmosdr::meta_range_t range; range += osmosdr::range_t( get_sample_rate() ); return range; } double fcd_source_c::set_sample_rate( double rate ) { return get_sample_rate(); } double fcd_source_c::get_sample_rate( void ) { if ( FUNCUBE_V1 == _type ) return 96e3; else if ( FUNCUBE_V2 == _type ) return 192e3; return 0; } osmosdr::freq_range_t fcd_source_c::get_freq_range( size_t chan ) { if ( FUNCUBE_V1 == _type ) return osmosdr::freq_range_t( 52e6, 2.2e9 ); else if ( FUNCUBE_V2 == _type ) return osmosdr::freq_range_t( 150e3, 2.05e9 ); return osmosdr::freq_range_t(); } double fcd_source_c::set_center_freq( double freq, size_t chan ) { #ifdef HAVE_FCD if ( FUNCUBE_V1 == _type ) _src_v1->set_freq( float(freq) ); #endif #ifdef HAVE_FCDPP if ( FUNCUBE_V2 == _type ) _src_v2->set_freq( float(freq) ); #endif _freq = freq; return get_center_freq(chan); } double fcd_source_c::get_center_freq( size_t chan ) { return _freq; } double fcd_source_c::set_freq_corr( double ppm, size_t chan ) { #ifdef HAVE_FCD if ( FUNCUBE_V1 == _type ) _src_v1->set_freq_corr( ppm ); #endif #ifdef HAVE_FCDPP if ( FUNCUBE_V2 == _type ) _src_v2->set_freq_corr( ppm ); #endif _correct = ppm; return get_freq_corr( chan ); } double fcd_source_c::get_freq_corr( size_t chan ) { return _correct; } std::vector fcd_source_c::get_gain_names( size_t chan ) { std::vector< std::string > names; names += "LNA"; names += "MIX"; if ( FUNCUBE_V2 == _type ) names += "BB"; return names; } osmosdr::gain_range_t fcd_source_c::get_gain_range( size_t chan ) { std::string name = ""; if ( FUNCUBE_V1 == _type ) name = "LNA"; /* use LNA gain for V1 dongle */ else if ( FUNCUBE_V2 == _type ) name = "BB"; /* use BB gain for V2 dongle */ return get_gain_range( name, chan ); } osmosdr::gain_range_t fcd_source_c::get_gain_range( const std::string & name, size_t chan ) { if ( FUNCUBE_V1 == _type ) { if ( "LNA" == name ) return osmosdr::gain_range_t(-5, 30, 2.5); else if ( "MIX" == name ) return osmosdr::gain_range_t(4, 12, 8); } else if ( FUNCUBE_V2 == _type ) { if ( "LNA" == name ) return osmosdr::gain_range_t(0, 1, 1); else if ( "MIX" == name ) return osmosdr::gain_range_t(0, 1, 1); else if ( "BB" == name ) return osmosdr::gain_range_t(0, 59, 1); } return osmosdr::gain_range_t(); } double fcd_source_c::set_gain( double gain, size_t chan ) { if ( FUNCUBE_V1 == _type ) _lna_gain = set_gain( gain, "LNA" ); if ( FUNCUBE_V2 == _type ) _bb_gain = set_gain( gain, "BB" ); return get_gain(chan); } double fcd_source_c::set_gain( double gain, const std::string & name, size_t chan ) { #ifdef HAVE_FCD if ( FUNCUBE_V1 == _type ) { if ( "LNA" == name ) { _lna_gain = gain; _src_v1->set_lna_gain(_lna_gain); } else if ( "MIX" == name ) { _mix_gain = gain > 4 ? 12 : 4; _src_v1->set_mixer_gain(_mix_gain); } } #endif #ifdef HAVE_FCDPP if ( FUNCUBE_V2 == _type ) { if ( "LNA" == name ) { _lna_gain = gain > 0 ? 1 : 0; _src_v2->set_lna(_lna_gain); } else if ( "MIX" == name ) { _mix_gain = gain > 0 ? 1 : 0; _src_v2->set_mixer_gain(_mix_gain); } else if ( "BB" == name ) { _bb_gain = gain; _src_v2->set_if_gain(_bb_gain); } } #endif return get_gain( name, chan ); } double fcd_source_c::get_gain( size_t chan ) { if ( FUNCUBE_V1 == _type ) return get_gain( "LNA", chan ); else if ( FUNCUBE_V2 == _type ) return get_gain( "BB", chan ); return 0; } double fcd_source_c::get_gain( const std::string & name, size_t chan ) { if ( FUNCUBE_V1 == _type ) { if ( "LNA" == name ) return _lna_gain; else if ( "MIX" == name ) return _mix_gain; } else if ( FUNCUBE_V2 == _type ) { if ( "LNA" == name ) return _lna_gain; else if ( "MIX" == name ) return _mix_gain; else if ( "BB" == name ) return _bb_gain; } return 0; } std::vector< std::string > fcd_source_c::get_antennas( size_t chan ) { std::vector< std::string > antennas; antennas += get_antenna(chan); return antennas; } std::string fcd_source_c::set_antenna( const std::string & antenna, size_t chan ) { return get_antenna(chan); } std::string fcd_source_c::get_antenna( size_t chan ) { return "RX"; } gr-osmosdr-0.1.0.55.80c4af/lib/fcd/fcd_source_c.h000066400000000000000000000054361225753723100211300ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef FCD_SOURCE_C_H #define FCD_SOURCE_C_H #include #ifdef HAVE_FCD #include #endif #ifdef HAVE_FCDPP #include #endif #include "source_iface.h" class fcd_source_c; typedef boost::shared_ptr< fcd_source_c > fcd_source_c_sptr; fcd_source_c_sptr make_fcd_source_c( const std::string & args = "" ); class fcd_source_c : public gr::hier_block2, public source_iface { private: friend fcd_source_c_sptr make_fcd_source_c(const std::string &args); fcd_source_c(const std::string &args); public: ~fcd_source_c(); enum dongle_type { FUNCUBE_UNKNOWN, FUNCUBE_V1, FUNCUBE_V2 }; static std::vector< std::string > get_devices(); std::string name(); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); private: dongle_type _type; #ifdef HAVE_FCD gr::fcd::source_c::sptr _src_v1; #endif #ifdef HAVE_FCDPP gr::fcdproplus::fcdproplus::sptr _src_v2; #endif double _lna_gain, _mix_gain, _bb_gain, _freq; int _correct; }; #endif // FCD_SOURCE_C_H gr-osmosdr-0.1.0.55.80c4af/lib/file/000077500000000000000000000000001225753723100165145ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/lib/file/CMakeLists.txt000066400000000000000000000025551225753723100212630ustar00rootroot00000000000000# Copyright 2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # This file included, use CMake directory variables ######################################################################## include_directories( ${CMAKE_CURRENT_SOURCE_DIR} ) set(file_srcs ${CMAKE_CURRENT_SOURCE_DIR}/file_source_c.cc ) ######################################################################## # Append gnuradio-osmosdr library sources ######################################################################## list(APPEND gr_osmosdr_srcs ${file_srcs}) list(APPEND gr_osmosdr_libs ${GNURADIO_BLOCKS_LIBRARIES}) gr-osmosdr-0.1.0.55.80c4af/lib/file/file_source_c.cc000066400000000000000000000122241225753723100216250ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #include #include #include #include #include #include #include #include "file_source_c.h" #include "arg_helpers.h" using namespace boost::assign; file_source_c_sptr make_file_source_c(const std::string &args) { return gnuradio::get_initial_sptr(new file_source_c(args)); } file_source_c::file_source_c(const std::string &args) : gr::hier_block2("file_source_c", gr::io_signature::make(0, 0, 0), gr::io_signature::make(1, 1, sizeof (gr_complex))) { std::string filename; bool repeat = true; bool throttle = true; _freq = 0; _rate = 0; dict_t dict = params_to_dict(args); if (dict.count("file")) filename = dict["file"]; if (dict.count("freq")) _freq = boost::lexical_cast< double >( dict["freq"] ); if (dict.count("rate")) _rate = boost::lexical_cast< double >( dict["rate"] ); if (dict.count("repeat")) repeat = ("true" == dict["repeat"] ? true : false); if (dict.count("throttle")) throttle = ("true" == dict["throttle"] ? true : false); if (!filename.length()) throw std::runtime_error("No file name specified."); if (_freq < 0) throw std::runtime_error("Parameter 'freq' may not be negative."); if (0 == _rate && throttle) throw std::runtime_error("Parameter 'rate' is missing in arguments."); _file_rate = _rate; gr::blocks::file_source::sptr src = \ gr::blocks::file_source::make( sizeof(gr_complex), filename.c_str(), repeat ); _throttle = gr::blocks::throttle::make( sizeof(gr_complex), _file_rate ); if (throttle) { connect( src, 0, _throttle, 0 ); connect( _throttle, 0, self(), 0 ); } else { connect( src, 0, self(), 0 ); } } file_source_c::~file_source_c() { } std::string file_source_c::name() { return "IQ File Source"; } std::vector file_source_c::get_devices( bool fake ) { std::vector devices; if ( fake ) { std::string args = "file='/path/to/your/file'"; args += ",rate=1e6,freq=100e6,repeat=true,throttle=true"; args += ",label='Complex Sampled (IQ) File'"; devices.push_back( args ); } return devices; } size_t file_source_c::get_num_channels( void ) { return 1; } osmosdr::meta_range_t file_source_c::get_sample_rates( void ) { osmosdr::meta_range_t range; range += osmosdr::range_t( _file_rate ); /* always return file's original rate */ return range; } double file_source_c::set_sample_rate( double rate ) { if ( _file_rate != rate ) { std::cerr << boost::format("WARNING: Overriding original sample rate of %g with %g") % _file_rate % rate << std::endl; } _throttle->set_sample_rate( rate ); _rate = rate; return get_sample_rate(); } double file_source_c::get_sample_rate( void ) { return _rate; } osmosdr::freq_range_t file_source_c::get_freq_range( size_t chan ) { return osmosdr::freq_range_t(_freq, _freq); } double file_source_c::set_center_freq( double freq, size_t chan ) { return get_center_freq(chan); } double file_source_c::get_center_freq( size_t chan ) { return _freq; } double file_source_c::set_freq_corr( double ppm, size_t chan ) { return get_freq_corr( chan ); } double file_source_c::get_freq_corr( size_t chan ) { return 0; } std::vector file_source_c::get_gain_names( size_t chan ) { return std::vector< std::string >(); } osmosdr::gain_range_t file_source_c::get_gain_range( size_t chan ) { return osmosdr::gain_range_t(); } osmosdr::gain_range_t file_source_c::get_gain_range( const std::string & name, size_t chan ) { return get_gain_range( chan ); } double file_source_c::set_gain( double gain, size_t chan ) { return get_gain(chan); } double file_source_c::set_gain( double gain, const std::string & name, size_t chan ) { return set_gain(chan); } double file_source_c::get_gain( size_t chan ) { return 0; } double file_source_c::get_gain( const std::string & name, size_t chan ) { return get_gain(chan); } std::vector< std::string > file_source_c::get_antennas( size_t chan ) { return std::vector< std::string >(); } std::string file_source_c::set_antenna( const std::string & antenna, size_t chan ) { return get_antenna(chan); } std::string file_source_c::get_antenna( size_t chan ) { return ""; } gr-osmosdr-0.1.0.55.80c4af/lib/file/file_source_c.h000066400000000000000000000050351225753723100214710ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef FILE_SOURCE_C_H #define FILE_SOURCE_C_H #include #include #include "source_iface.h" class file_source_c; typedef boost::shared_ptr< file_source_c > file_source_c_sptr; file_source_c_sptr make_file_source_c( const std::string & args = "" ); class file_source_c : public gr::hier_block2, public source_iface { private: friend file_source_c_sptr make_file_source_c(const std::string &args); file_source_c(const std::string &args); public: ~file_source_c(); std::string name(); static std::vector< std::string > get_devices( bool fake = false ); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); private: gr::blocks::throttle::sptr _throttle; double _file_rate; double _freq, _rate; }; #endif // FILE_SOURCE_C_H gr-osmosdr-0.1.0.55.80c4af/lib/gnuradio-osmosdr.rc.in000066400000000000000000000033321225753723100220250ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Free Software Foundation, Inc. * * This file is part of GNU Radio * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #include VS_VERSION_INFO VERSIONINFO FILEVERSION @MAJOR_VERSION@,@API_COMPAT@,@RC_MINOR_VERSION@,@RC_MAINT_VERSION@ PRODUCTVERSION @MAJOR_VERSION@,@API_COMPAT@,@RC_MINOR_VERSION@,@RC_MAINT_VERSION@ FILEFLAGSMASK 0x3fL #ifndef NDEBUG FILEFLAGS 0x0L #else FILEFLAGS 0x1L #endif FILEOS VOS__WINDOWS32 FILETYPE VFT_DLL FILESUBTYPE VFT2_DRV_INSTALLABLE BEGIN BLOCK "StringFileInfo" BEGIN BLOCK "040904b0" BEGIN VALUE "FileDescription", "gnuradio-osmosdr" VALUE "FileVersion", "@VERSION@" VALUE "InternalName", "gnuradio-osmosdr.dll" VALUE "LegalCopyright", "Licensed under GPLv3 or any later version" VALUE "OriginalFilename", "gnuradio-osmosdr.dll" VALUE "ProductName", "gnuradio-osmosdr" VALUE "ProductVersion", "@VERSION@" END END BLOCK "VarFileInfo" BEGIN VALUE "Translation", 0x409, 1200 END END gr-osmosdr-0.1.0.55.80c4af/lib/hackrf/000077500000000000000000000000001225753723100170335ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/lib/hackrf/CMakeLists.txt000066400000000000000000000026731225753723100216030ustar00rootroot00000000000000# Copyright 2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # This file included, use CMake directory variables ######################################################################## include_directories( ${CMAKE_CURRENT_SOURCE_DIR} ${LIBHACKRF_INCLUDE_DIRS} ) set(hackrf_srcs ${CMAKE_CURRENT_SOURCE_DIR}/hackrf_source_c.cc ${CMAKE_CURRENT_SOURCE_DIR}/hackrf_sink_c.cc ) ######################################################################## # Append gnuradio-osmosdr library sources ######################################################################## list(APPEND gr_osmosdr_srcs ${hackrf_srcs}) list(APPEND gr_osmosdr_libs ${LIBHACKRF_LIBRARIES}) gr-osmosdr-0.1.0.55.80c4af/lib/hackrf/hackrf_sink_c.cc000066400000000000000000000470741225753723100221420ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ /* * config.h is generated by configure. It contains the results * of probing for features, options etc. It should be the first * file included in your .cc file. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include #include #include #ifdef USE_AVX #include #elif USE_SSE2 #include #endif #include #include #include #include #include #include #include "hackrf_sink_c.h" #include "arg_helpers.h" using namespace boost::assign; #define BUF_LEN (16 * 32 * 512) /* must be multiple of 512 */ #define BUF_NUM 32 #define BYTES_PER_SAMPLE 2 /* HackRF device consumes 8 bit unsigned IQ data */ #define HACKRF_THROW_ON_ERROR(ret, msg) \ if ( ret != HACKRF_SUCCESS ) \ throw std::runtime_error( boost::str( boost::format(msg " (%d) %s") \ % ret % hackrf_error_name((enum hackrf_error)ret) ) ); #define HACKRF_FUNC_STR(func, arg) \ boost::str(boost::format(func "(%d)") % arg) + " has failed" static inline bool cb_init(circular_buffer_t *cb, size_t capacity, size_t sz) { cb->buffer = malloc(capacity * sz); if(cb->buffer == NULL) return false; // handle error cb->buffer_end = (char *)cb->buffer + capacity * sz; cb->capacity = capacity; cb->count = 0; cb->sz = sz; cb->head = cb->buffer; cb->tail = cb->buffer; return true; } static inline void cb_free(circular_buffer_t *cb) { if (cb->buffer) { free(cb->buffer); cb->buffer = NULL; } // clear out other fields too, just to be safe cb->buffer_end = 0; cb->capacity = 0; cb->count = 0; cb->sz = 0; cb->head = 0; cb->tail = 0; } static inline bool cb_has_room(circular_buffer_t *cb) { if(cb->count == cb->capacity) return false; return true; } static inline bool cb_push_back(circular_buffer_t *cb, const void *item) { if(cb->count == cb->capacity) return false; // handle error memcpy(cb->head, item, cb->sz); cb->head = (char *)cb->head + cb->sz; if(cb->head == cb->buffer_end) cb->head = cb->buffer; cb->count++; return true; } static inline bool cb_pop_front(circular_buffer_t *cb, void *item) { if(cb->count == 0) return false; // handle error memcpy(item, cb->tail, cb->sz); cb->tail = (char *)cb->tail + cb->sz; if(cb->tail == cb->buffer_end) cb->tail = cb->buffer; cb->count--; return true; } int hackrf_sink_c::_usage = 0; boost::mutex hackrf_sink_c::_usage_mutex; hackrf_sink_c_sptr make_hackrf_sink_c (const std::string & args) { return gnuradio::get_initial_sptr(new hackrf_sink_c (args)); } /* * Specify constraints on number of input and output streams. * This info is used to construct the input and output signatures * (2nd & 3rd args to gr::block's constructor). The input and * output signatures are used by the runtime system to * check that a valid number and type of inputs and outputs * are connected to this block. In this case, we accept * only 0 input and 1 output. */ static const int MIN_IN = 1; // mininum number of input streams static const int MAX_IN = 1; // maximum number of input streams static const int MIN_OUT = 0; // minimum number of output streams static const int MAX_OUT = 0; // maximum number of output streams /* * The private constructor */ hackrf_sink_c::hackrf_sink_c (const std::string &args) : gr::sync_block ("hackrf_sink_c", gr::io_signature::make(MIN_IN, MAX_IN, sizeof (gr_complex)), gr::io_signature::make(MIN_OUT, MAX_OUT, sizeof (gr_complex))), _dev(NULL), _buf(NULL), _sample_rate(0), _center_freq(0), _freq_corr(0), _auto_gain(false), _amp_gain(0), _vga_gain(0), _bandwidth(0) { int ret; dict_t dict = params_to_dict(args); _buf_num = 0; if (dict.count("buffers")) _buf_num = boost::lexical_cast< unsigned int >( dict["buffers"] ); if (0 == _buf_num) _buf_num = BUF_NUM; { boost::mutex::scoped_lock lock( _usage_mutex ); if ( _usage == 0 ) hackrf_init(); /* call only once before the first open */ _usage++; } _dev = NULL; ret = hackrf_open( &_dev ); HACKRF_THROW_ON_ERROR(ret, "Failed to open HackRF device") uint8_t board_id; ret = hackrf_board_id_read( _dev, &board_id ); HACKRF_THROW_ON_ERROR(ret, "Failed to get HackRF board id") char version[40]; memset(version, 0, sizeof(version)); ret = hackrf_version_string_read( _dev, version, sizeof(version)); HACKRF_THROW_ON_ERROR(ret, "Failed to read version string") #if 0 read_partid_serialno_t serial_number; ret = hackrf_board_partid_serialno_read( _dev, &serial_number ); HACKRF_THROW_ON_ERROR(ret, "Failed to read serial number") #endif std::cerr << "Using " << hackrf_board_id_name(hackrf_board_id(board_id)) << " " << "with firmware " << version << " " << std::endl; if ( BUF_NUM != _buf_num ) { std::cerr << "Using " << _buf_num << " buffers of size " << BUF_LEN << "." << std::endl; } set_center_freq( (get_freq_range().start() + get_freq_range().stop()) / 2.0 ); set_sample_rate( get_sample_rates().start() ); set_bandwidth( 0 ); set_gain( 14 ); /* enable AMP gain stage by default */ set_if_gain( 16 ); /* preset to a reasonable default (non-GRC use case) */ _buf = (unsigned char *) malloc( BUF_LEN ); cb_init( &_cbuf, _buf_num, BUF_LEN ); // _thread = gr::thread::thread(_hackrf_wait, this); ret = hackrf_start_tx( _dev, _hackrf_tx_callback, (void *)this ); HACKRF_THROW_ON_ERROR(ret, "Failed to start TX streaming") } /* * Our virtual destructor. */ hackrf_sink_c::~hackrf_sink_c () { if (_dev) { // _thread.join(); int ret = hackrf_stop_tx( _dev ); HACKRF_THROW_ON_ERROR(ret, "Failed to stop TX streaming") ret = hackrf_close( _dev ); HACKRF_THROW_ON_ERROR(ret, "Failed to close HackRF") _dev = NULL; { boost::mutex::scoped_lock lock( _usage_mutex ); _usage--; if ( _usage == 0 ) hackrf_exit(); /* call only once after last close */ } } if (_buf) { free(_buf); _buf = NULL; } cb_free( &_cbuf ); } int hackrf_sink_c::_hackrf_tx_callback(hackrf_transfer *transfer) { hackrf_sink_c *obj = (hackrf_sink_c *)transfer->tx_ctx; return obj->hackrf_tx_callback(transfer->buffer, transfer->valid_length); } int hackrf_sink_c::hackrf_tx_callback(unsigned char *buffer, uint32_t length) { #if 0 for (unsigned int i = 0; i < length; ++i) /* simulate noise */ *buffer++ = rand() % 255; #else { boost::mutex::scoped_lock lock( _buf_mutex ); if ( ! cb_pop_front( &_cbuf, buffer ) ) { memset(buffer, 0, length); std::cerr << "U" << std::flush; } else { // std::cerr << "-" << std::flush; _buf_cond.notify_one(); } } #endif return 0; // TODO: return -1 on error/stop } void hackrf_sink_c::_hackrf_wait(hackrf_sink_c *obj) { obj->hackrf_wait(); } void hackrf_sink_c::hackrf_wait() { } bool hackrf_sink_c::start() { if ( ! _dev ) return false; _buf_used = 0; #if 0 int ret = hackrf_start_tx( _dev, _hackrf_tx_callback, (void *)this ); if ( ret != HACKRF_SUCCESS ) { std::cerr << "Failed to start TX streaming (" << ret << ")" << std::endl; return false; } #endif return true; } bool hackrf_sink_c::stop() { if ( ! _dev ) return false; #if 0 int ret = hackrf_stop_tx( _dev ); if ( ret != HACKRF_SUCCESS ) { std::cerr << "Failed to stop TX streaming (" << ret << ")" << std::endl; return false; } #endif return true; } #ifdef USE_AVX void convert_avx(const float* inbuf, unsigned char* outbuf,const unsigned int count) { __m256 mulme = _mm256_set_ps(127.0f, 127.0f, 127.0f, 127.0f, 127.0f, 127.0f, 127.0f, 127.0f); __m128i addme = _mm_set_epi16(127, 127, 127, 127, 127, 127, 127, 127); for(unsigned int i=0; i= remaining) { { boost::mutex::scoped_lock lock( _buf_mutex ); if ( ! cb_push_back( &_cbuf, _buf ) ) { _buf_used = prev_buf_used; items_consumed = 0; std::cerr << "O" << std::flush; } else { // std::cerr << "+" << std::flush; _buf_used = 0; } } } // Tell runtime system how many input items we consumed on // each input stream. consume_each(items_consumed); // Tell runtime system how many output items we produced. return 0; } std::vector hackrf_sink_c::get_devices() { std::vector devices; std::string label; #if 0 for (unsigned int i = 0; i < 1 /* TODO: missing libhackrf api */; i++) { std::string args = "hackrf=" + boost::lexical_cast< std::string >( i ); label.clear(); label = "HackRF Jawbreaker"; /* TODO: missing libhackrf api */ boost::algorithm::trim(label); args += ",label='" + label + "'"; devices.push_back( args ); } #else { boost::mutex::scoped_lock lock( _usage_mutex ); if ( _usage == 0 ) hackrf_init(); /* call only once before the first open */ _usage++; } int ret; hackrf_device *dev = NULL; ret = hackrf_open(&dev); if ( HACKRF_SUCCESS == ret ) { std::string args = "hackrf=0"; label = "HackRF"; uint8_t board_id; ret = hackrf_board_id_read( dev, &board_id ); if ( HACKRF_SUCCESS == ret ) { label += std::string(" ") + hackrf_board_id_name(hackrf_board_id(board_id)); } args += ",label='" + label + "'"; devices.push_back( args ); ret = hackrf_close(dev); } { boost::mutex::scoped_lock lock( _usage_mutex ); _usage--; if ( _usage == 0 ) hackrf_exit(); /* call only once after last close */ } #endif return devices; } size_t hackrf_sink_c::get_num_channels() { return 1; } osmosdr::meta_range_t hackrf_sink_c::get_sample_rates() { osmosdr::meta_range_t range; /* we only add integer rates here because of better phase noise performance. * the user is allowed to request arbitrary (fractional) rates within these * boundaries. */ range += osmosdr::range_t( 8e6 ); range += osmosdr::range_t( 10e6 ); range += osmosdr::range_t( 12.5e6 ); range += osmosdr::range_t( 16e6 ); range += osmosdr::range_t( 20e6 ); /* confirmed to work on fast machines */ return range; } double hackrf_sink_c::set_sample_rate( double rate ) { int ret; if (_dev) { ret = hackrf_set_sample_rate( _dev, rate ); if ( HACKRF_SUCCESS == ret ) { _sample_rate = rate; //set_bandwidth( 0.0 ); /* bandwidth of 0 means automatic filter selection */ } else { HACKRF_THROW_ON_ERROR( ret, HACKRF_FUNC_STR( "hackrf_set_sample_rate", rate ) ) } } return get_sample_rate(); } double hackrf_sink_c::get_sample_rate() { return _sample_rate; } osmosdr::freq_range_t hackrf_sink_c::get_freq_range( size_t chan ) { osmosdr::freq_range_t range; range += osmosdr::range_t( 30e6, 6e9 ); return range; } double hackrf_sink_c::set_center_freq( double freq, size_t chan ) { int ret; #define APPLY_PPM_CORR(val, ppm) ((val) * (1.0 + (ppm) * 0.000001)) if (_dev) { double corr_freq = APPLY_PPM_CORR( freq, _freq_corr ); ret = hackrf_set_freq( _dev, uint64_t(corr_freq) ); if ( HACKRF_SUCCESS == ret ) { _center_freq = freq; } else { HACKRF_THROW_ON_ERROR( ret, HACKRF_FUNC_STR( "hackrf_set_freq", corr_freq ) ) } } return get_center_freq( chan ); } double hackrf_sink_c::get_center_freq( size_t chan ) { return _center_freq; } double hackrf_sink_c::set_freq_corr( double ppm, size_t chan ) { _freq_corr = ppm; set_center_freq( _center_freq ); return get_freq_corr( chan ); } double hackrf_sink_c::get_freq_corr( size_t chan ) { return _freq_corr; } std::vector hackrf_sink_c::get_gain_names( size_t chan ) { std::vector< std::string > names; names += "RF"; names += "IF"; return names; } osmosdr::gain_range_t hackrf_sink_c::get_gain_range( size_t chan ) { return get_gain_range( "RF", chan ); } osmosdr::gain_range_t hackrf_sink_c::get_gain_range( const std::string & name, size_t chan ) { if ( "RF" == name ) { return osmosdr::gain_range_t( 0, 14, 14 ); } if ( "IF" == name ) { return osmosdr::gain_range_t( 0, 47, 1 ); } return osmosdr::gain_range_t(); } bool hackrf_sink_c::set_gain_mode( bool automatic, size_t chan ) { _auto_gain = automatic; return get_gain_mode(chan); } bool hackrf_sink_c::get_gain_mode( size_t chan ) { return _auto_gain; } double hackrf_sink_c::set_gain( double gain, size_t chan ) { int ret; osmosdr::gain_range_t rf_gains = get_gain_range( "RF", chan ); if (_dev) { double clip_gain = rf_gains.clip( gain, true ); uint8_t value = clip_gain == 14.0f ? 1 : 0; ret = hackrf_set_amp_enable( _dev, value ); if ( HACKRF_SUCCESS == ret ) { _amp_gain = clip_gain; } else { HACKRF_THROW_ON_ERROR( ret, HACKRF_FUNC_STR( "hackrf_set_amp_enable", value ) ) } } return _amp_gain; } double hackrf_sink_c::set_gain( double gain, const std::string & name, size_t chan) { if ( "RF" == name ) { return set_gain( gain, chan ); } if ( "IF" == name ) { return set_if_gain( gain, chan ); } return set_gain( gain, chan ); } double hackrf_sink_c::get_gain( size_t chan ) { return _amp_gain; } double hackrf_sink_c::get_gain( const std::string & name, size_t chan ) { if ( "RF" == name ) { return get_gain( chan ); } if ( "IF" == name ) { return _vga_gain; } return get_gain( chan ); } double hackrf_sink_c::set_if_gain( double gain, size_t chan ) { int ret; osmosdr::gain_range_t if_gains = get_gain_range( "IF", chan ); if (_dev) { double clip_gain = if_gains.clip( gain, true ); ret = hackrf_set_txvga_gain( _dev, uint32_t(clip_gain) ); if ( HACKRF_SUCCESS == ret ) { _vga_gain = clip_gain; } else { HACKRF_THROW_ON_ERROR( ret, HACKRF_FUNC_STR( "hackrf_set_txvga_gain", clip_gain ) ) } } return _vga_gain; } double hackrf_sink_c::set_bb_gain( double gain, size_t chan ) { return 0; } std::vector< std::string > hackrf_sink_c::get_antennas( size_t chan ) { std::vector< std::string > antennas; antennas += get_antenna( chan ); return antennas; } std::string hackrf_sink_c::set_antenna( const std::string & antenna, size_t chan ) { return get_antenna( chan ); } std::string hackrf_sink_c::get_antenna( size_t chan ) { return "TX/RX"; } double hackrf_sink_c::set_bandwidth( double bandwidth, size_t chan ) { int ret; // osmosdr::freq_range_t bandwidths = get_bandwidth_range( chan ); if ( bandwidth == 0.0 ) /* bandwidth of 0 means automatic filter selection */ bandwidth = _sample_rate * 0.75; /* select narrower filters to prevent aliasing */ if ( _dev ) { /* compute best default value depending on sample rate (auto filter) */ uint32_t bw = hackrf_compute_baseband_filter_bw( uint32_t(bandwidth) ); ret = hackrf_set_baseband_filter_bandwidth( _dev, bw ); if ( HACKRF_SUCCESS == ret ) { _bandwidth = bw; } else { HACKRF_THROW_ON_ERROR( ret, HACKRF_FUNC_STR( "hackrf_set_baseband_filter_bandwidth", bw ) ) } } return _bandwidth; } double hackrf_sink_c::get_bandwidth( size_t chan ) { return _bandwidth; } osmosdr::freq_range_t hackrf_sink_c::get_bandwidth_range( size_t chan ) { osmosdr::freq_range_t bandwidths; // TODO: read out from libhackrf when an API is available bandwidths += osmosdr::range_t( 1750000 ); bandwidths += osmosdr::range_t( 2500000 ); bandwidths += osmosdr::range_t( 3500000 ); bandwidths += osmosdr::range_t( 5000000 ); bandwidths += osmosdr::range_t( 5500000 ); bandwidths += osmosdr::range_t( 6000000 ); bandwidths += osmosdr::range_t( 7000000 ); bandwidths += osmosdr::range_t( 8000000 ); bandwidths += osmosdr::range_t( 9000000 ); bandwidths += osmosdr::range_t( 10000000 ); bandwidths += osmosdr::range_t( 12000000 ); bandwidths += osmosdr::range_t( 14000000 ); bandwidths += osmosdr::range_t( 15000000 ); bandwidths += osmosdr::range_t( 20000000 ); bandwidths += osmosdr::range_t( 24000000 ); bandwidths += osmosdr::range_t( 28000000 ); return bandwidths; } gr-osmosdr-0.1.0.55.80c4af/lib/hackrf/hackrf_sink_c.h000066400000000000000000000115441225753723100217750ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_HACKRF_SINK_C_H #define INCLUDED_HACKRF_SINK_C_H #include #include #include #include #include #include "sink_iface.h" class hackrf_sink_c; typedef struct circular_buffer { void *buffer; // data buffer void *buffer_end; // end of data buffer size_t capacity; // maximum number of items in the buffer size_t count; // number of items in the buffer size_t sz; // size of each item in the buffer void *head; // pointer to head void *tail; // pointer to tail } circular_buffer_t; /* * We use boost::shared_ptr's instead of raw pointers for all access * to gr::blocks (and many other data structures). The shared_ptr gets * us transparent reference counting, which greatly simplifies storage * management issues. This is especially helpful in our hybrid * C++ / Python system. * * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm * * As a convention, the _sptr suffix indicates a boost::shared_ptr */ typedef boost::shared_ptr hackrf_sink_c_sptr; /*! * \brief Return a shared_ptr to a new instance of hackrf_sink_c. * * To avoid accidental use of raw pointers, hackrf_sink_c's * constructor is private. make_hackrf_sink_c is the public * interface for creating new instances. */ hackrf_sink_c_sptr make_hackrf_sink_c (const std::string & args = ""); class hackrf_sink_c : public gr::sync_block, public sink_iface { private: // The friend declaration allows hackrf_make_sink_c to // access the private constructor. friend hackrf_sink_c_sptr make_hackrf_sink_c (const std::string & args); hackrf_sink_c (const std::string & args); // private constructor public: ~hackrf_sink_c (); // public destructor bool start(); bool stop(); int work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ); static std::vector< std::string > get_devices(); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); bool set_gain_mode( bool automatic, size_t chan = 0 ); bool get_gain_mode( size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); double set_if_gain( double gain, size_t chan = 0 ); double set_bb_gain( double gain, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); double set_bandwidth( double bandwidth, size_t chan = 0 ); double get_bandwidth( size_t chan = 0 ); osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ); private: static int _hackrf_tx_callback(hackrf_transfer* transfer); int hackrf_tx_callback(unsigned char *buffer, uint32_t length); static void _hackrf_wait(hackrf_sink_c *obj); void hackrf_wait(); static int _usage; static boost::mutex _usage_mutex; hackrf_device *_dev; // gr::thread::thread _thread; circular_buffer_t _cbuf; unsigned char *_buf; unsigned int _buf_num; unsigned int _buf_used; boost::mutex _buf_mutex; boost::condition_variable _buf_cond; double _sample_rate; double _center_freq; double _freq_corr; bool _auto_gain; double _amp_gain; double _vga_gain; double _bandwidth; }; #endif /* INCLUDED_HACKRF_SINK_C_H */ gr-osmosdr-0.1.0.55.80c4af/lib/hackrf/hackrf_source_c.cc000066400000000000000000000424211225753723100224650ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ /* * config.h is generated by configure. It contains the results * of probing for features, options etc. It should be the first * file included in your .cc file. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include #include #include #include #include #include #include #include #include "hackrf_source_c.h" #include "arg_helpers.h" using namespace boost::assign; #define BUF_LEN (16 * 32 * 512) /* must be multiple of 512 */ #define BUF_NUM 32 #define BYTES_PER_SAMPLE 2 /* HackRF device produces 8 bit unsigned IQ data */ #define HACKRF_THROW_ON_ERROR(ret, msg) \ if ( ret != HACKRF_SUCCESS ) \ throw std::runtime_error( boost::str( boost::format(msg " (%d) %s") \ % ret % hackrf_error_name((enum hackrf_error)ret) ) ); #define HACKRF_FUNC_STR(func, arg) \ boost::str(boost::format(func "(%d)") % arg) + " has failed" int hackrf_source_c::_usage = 0; boost::mutex hackrf_source_c::_usage_mutex; hackrf_source_c_sptr make_hackrf_source_c (const std::string & args) { return gnuradio::get_initial_sptr(new hackrf_source_c (args)); } /* * Specify constraints on number of input and output streams. * This info is used to construct the input and output signatures * (2nd & 3rd args to gr::block's constructor). The input and * output signatures are used by the runtime system to * check that a valid number and type of inputs and outputs * are connected to this block. In this case, we accept * only 0 input and 1 output. */ static const int MIN_IN = 0; // mininum number of input streams static const int MAX_IN = 0; // maximum number of input streams static const int MIN_OUT = 1; // minimum number of output streams static const int MAX_OUT = 1; // maximum number of output streams /* * The private constructor */ hackrf_source_c::hackrf_source_c (const std::string &args) : gr::sync_block ("hackrf_source_c", gr::io_signature::make(MIN_IN, MAX_IN, sizeof (gr_complex)), gr::io_signature::make(MIN_OUT, MAX_OUT, sizeof (gr_complex))), _dev(NULL), _buf(NULL), _sample_rate(0), _center_freq(0), _freq_corr(0), _auto_gain(false), _amp_gain(0), _lna_gain(0), _vga_gain(0), _bandwidth(0) { int ret; dict_t dict = params_to_dict(args); _buf_num = _buf_len = _buf_head = _buf_used = _buf_offset = 0; if (dict.count("buffers")) _buf_num = boost::lexical_cast< unsigned int >( dict["buffers"] ); // if (dict.count("buflen")) // _buf_len = boost::lexical_cast< unsigned int >( dict["buflen"] ); if (0 == _buf_num) _buf_num = BUF_NUM; if (0 == _buf_len || _buf_len % 512 != 0) /* len must be multiple of 512 */ _buf_len = BUF_LEN; _samp_avail = _buf_len / BYTES_PER_SAMPLE; // create a lookup table for gr_complex values for (unsigned int i = 0; i <= 0xffff; i++) { #ifdef BOOST_LITTLE_ENDIAN _lut.push_back( gr_complex( (float(i & 0xff) - 127.5f) * (1.0f/128.0f), (float(i >> 8) - 127.5f) * (1.0f/128.0f) ) ); #else // BOOST_BIG_ENDIAN _lut.push_back( gr_complex( (float(i >> 8) - 127.5f) * (1.0f/128.0f), (float(i & 0xff) - 127.5f) * (1.0f/128.0f) ) ); #endif } { boost::mutex::scoped_lock lock( _usage_mutex ); if ( _usage == 0 ) hackrf_init(); /* call only once before the first open */ _usage++; } _dev = NULL; ret = hackrf_open( &_dev ); HACKRF_THROW_ON_ERROR(ret, "Failed to open HackRF device") uint8_t board_id; ret = hackrf_board_id_read( _dev, &board_id ); HACKRF_THROW_ON_ERROR(ret, "Failed to get HackRF board id") char version[40]; memset(version, 0, sizeof(version)); ret = hackrf_version_string_read( _dev, version, sizeof(version)); HACKRF_THROW_ON_ERROR(ret, "Failed to read version string") #if 0 read_partid_serialno_t serial_number; ret = hackrf_board_partid_serialno_read( _dev, &serial_number ); HACKRF_THROW_ON_ERROR(ret, "Failed to read serial number") #endif std::cerr << "Using " << hackrf_board_id_name(hackrf_board_id(board_id)) << " " << "with firmware " << version << " " << std::endl; if ( BUF_NUM != _buf_num || BUF_LEN != _buf_len ) { std::cerr << "Using " << _buf_num << " buffers of size " << _buf_len << "." << std::endl; } set_center_freq( (get_freq_range().start() + get_freq_range().stop()) / 2.0 ); set_sample_rate( get_sample_rates().start() ); set_bandwidth( 0 ); set_gain( 14 ); /* enable AMP gain stage by default */ set_if_gain( 16 ); /* preset to a reasonable default (non-GRC use case) */ set_bb_gain( 20 ); /* preset to a reasonable default (non-GRC use case) */ _buf = (unsigned short **) malloc(_buf_num * sizeof(unsigned short *)); if (_buf) { for(unsigned int i = 0; i < _buf_num; ++i) _buf[i] = (unsigned short *) malloc(_buf_len); } // _thread = gr::thread::thread(_hackrf_wait, this); ret = hackrf_start_rx( _dev, _hackrf_rx_callback, (void *)this ); HACKRF_THROW_ON_ERROR(ret, "Failed to start RX streaming") } /* * Our virtual destructor. */ hackrf_source_c::~hackrf_source_c () { if (_dev) { // _thread.join(); int ret = hackrf_stop_rx( _dev ); HACKRF_THROW_ON_ERROR(ret, "Failed to stop RX streaming") ret = hackrf_close( _dev ); HACKRF_THROW_ON_ERROR(ret, "Failed to close HackRF") _dev = NULL; { boost::mutex::scoped_lock lock( _usage_mutex ); _usage--; if ( _usage == 0 ) hackrf_exit(); /* call only once after last close */ } } if (_buf) { for(unsigned int i = 0; i < _buf_num; ++i) { if (_buf[i]) free(_buf[i]); } free(_buf); _buf = NULL; } } int hackrf_source_c::_hackrf_rx_callback(hackrf_transfer *transfer) { hackrf_source_c *obj = (hackrf_source_c *)transfer->rx_ctx; return obj->hackrf_rx_callback(transfer->buffer, transfer->valid_length); } int hackrf_source_c::hackrf_rx_callback(unsigned char *buf, uint32_t len) { { boost::mutex::scoped_lock lock( _buf_mutex ); int buf_tail = (_buf_head + _buf_used) % _buf_num; memcpy(_buf[buf_tail], buf, len); if (_buf_used == _buf_num) { std::cerr << "O" << std::flush; _buf_head = (_buf_head + 1) % _buf_num; } else { _buf_used++; } } _buf_cond.notify_one(); return 0; // TODO: return -1 on error/stop } void hackrf_source_c::_hackrf_wait(hackrf_source_c *obj) { obj->hackrf_wait(); } void hackrf_source_c::hackrf_wait() { } bool hackrf_source_c::start() { if ( ! _dev ) return false; #if 0 int ret = hackrf_start_rx( _dev, _hackrf_rx_callback, (void *)this ); if ( ret != HACKRF_SUCCESS ) { std::cerr << "Failed to start RX streaming (" << ret << ")" << std::endl; return false; } #endif return true; } bool hackrf_source_c::stop() { if ( ! _dev ) return false; #if 0 int ret = hackrf_stop_rx( _dev ); if ( ret != HACKRF_SUCCESS ) { std::cerr << "Failed to stop RX streaming (" << ret << ")" << std::endl; return false; } #endif return true; } int hackrf_source_c::work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ) { gr_complex *out = (gr_complex *)output_items[0]; bool running = false; if ( _dev ) running = (hackrf_is_streaming( _dev ) == HACKRF_TRUE); { boost::mutex::scoped_lock lock( _buf_mutex ); while (_buf_used < 3 && running) // collect at least 3 buffers _buf_cond.wait( lock ); } if ( ! running ) return WORK_DONE; unsigned short *buf = _buf[_buf_head] + _buf_offset; if (noutput_items <= _samp_avail) { for (int i = 0; i < noutput_items; ++i) *out++ = _lut[ *(buf + i) ]; _buf_offset += noutput_items; _samp_avail -= noutput_items; } else { for (int i = 0; i < _samp_avail; ++i) *out++ = _lut[ *(buf + i) ]; { boost::mutex::scoped_lock lock( _buf_mutex ); _buf_head = (_buf_head + 1) % _buf_num; _buf_used--; } buf = _buf[_buf_head]; int remaining = noutput_items - _samp_avail; for (int i = 0; i < remaining; ++i) *out++ = _lut[ *(buf + i) ]; _buf_offset = remaining; _samp_avail = (_buf_len / BYTES_PER_SAMPLE) - remaining; } return noutput_items; } std::vector hackrf_source_c::get_devices() { std::vector devices; std::string label; #if 0 for (unsigned int i = 0; i < 1 /* TODO: missing libhackrf api */; i++) { std::string args = "hackrf=" + boost::lexical_cast< std::string >( i ); label.clear(); label = "HackRF Jawbreaker"; /* TODO: missing libhackrf api */ boost::algorithm::trim(label); args += ",label='" + label + "'"; devices.push_back( args ); } #else { boost::mutex::scoped_lock lock( _usage_mutex ); if ( _usage == 0 ) hackrf_init(); /* call only once before the first open */ _usage++; } int ret; hackrf_device *dev = NULL; ret = hackrf_open(&dev); if ( HACKRF_SUCCESS == ret ) { std::string args = "hackrf=0"; label = "HackRF"; uint8_t board_id; ret = hackrf_board_id_read( dev, &board_id ); if ( HACKRF_SUCCESS == ret ) { label += std::string(" ") + hackrf_board_id_name(hackrf_board_id(board_id)); } args += ",label='" + label + "'"; devices.push_back( args ); ret = hackrf_close(dev); } { boost::mutex::scoped_lock lock( _usage_mutex ); _usage--; if ( _usage == 0 ) hackrf_exit(); /* call only once after last close */ } #endif return devices; } size_t hackrf_source_c::get_num_channels() { return 1; } osmosdr::meta_range_t hackrf_source_c::get_sample_rates() { osmosdr::meta_range_t range; /* we only add integer rates here because of better phase noise performance. * the user is allowed to request arbitrary (fractional) rates within these * boundaries. */ range += osmosdr::range_t( 8e6 ); range += osmosdr::range_t( 10e6 ); range += osmosdr::range_t( 12.5e6 ); range += osmosdr::range_t( 16e6 ); range += osmosdr::range_t( 20e6 ); /* confirmed to work on fast machines */ return range; } double hackrf_source_c::set_sample_rate( double rate ) { int ret; if (_dev) { ret = hackrf_set_sample_rate( _dev, rate ); if ( HACKRF_SUCCESS == ret ) { _sample_rate = rate; //set_bandwidth( 0.0 ); /* bandwidth of 0 means automatic filter selection */ } else { HACKRF_THROW_ON_ERROR( ret, HACKRF_FUNC_STR( "hackrf_set_sample_rate", rate ) ) } } return get_sample_rate(); } double hackrf_source_c::get_sample_rate() { return _sample_rate; } osmosdr::freq_range_t hackrf_source_c::get_freq_range( size_t chan ) { osmosdr::freq_range_t range; range += osmosdr::range_t( 30e6, 6e9 ); return range; } double hackrf_source_c::set_center_freq( double freq, size_t chan ) { int ret; #define APPLY_PPM_CORR(val, ppm) ((val) * (1.0 + (ppm) * 0.000001)) if (_dev) { double corr_freq = APPLY_PPM_CORR( freq, _freq_corr ); ret = hackrf_set_freq( _dev, uint64_t(corr_freq) ); if ( HACKRF_SUCCESS == ret ) { _center_freq = freq; } else { HACKRF_THROW_ON_ERROR( ret, HACKRF_FUNC_STR( "hackrf_set_freq", corr_freq ) ) } } return get_center_freq( chan ); } double hackrf_source_c::get_center_freq( size_t chan ) { return _center_freq; } double hackrf_source_c::set_freq_corr( double ppm, size_t chan ) { _freq_corr = ppm; set_center_freq( _center_freq ); return get_freq_corr( chan ); } double hackrf_source_c::get_freq_corr( size_t chan ) { return _freq_corr; } std::vector hackrf_source_c::get_gain_names( size_t chan ) { std::vector< std::string > names; names += "RF"; names += "IF"; names += "BB"; return names; } osmosdr::gain_range_t hackrf_source_c::get_gain_range( size_t chan ) { return get_gain_range( "RF", chan ); } osmosdr::gain_range_t hackrf_source_c::get_gain_range( const std::string & name, size_t chan ) { if ( "RF" == name ) { return osmosdr::gain_range_t( 0, 14, 14 ); } if ( "IF" == name ) { return osmosdr::gain_range_t( 0, 40, 8 ); } if ( "BB" == name ) { return osmosdr::gain_range_t( 0, 62, 2 ); } return osmosdr::gain_range_t(); } bool hackrf_source_c::set_gain_mode( bool automatic, size_t chan ) { _auto_gain = automatic; return get_gain_mode(chan); } bool hackrf_source_c::get_gain_mode( size_t chan ) { return _auto_gain; } double hackrf_source_c::set_gain( double gain, size_t chan ) { int ret; osmosdr::gain_range_t rf_gains = get_gain_range( "RF", chan ); if (_dev) { double clip_gain = rf_gains.clip( gain, true ); uint8_t value = clip_gain == 14.0f ? 1 : 0; ret = hackrf_set_amp_enable( _dev, value ); if ( HACKRF_SUCCESS == ret ) { _amp_gain = clip_gain; } else { HACKRF_THROW_ON_ERROR( ret, HACKRF_FUNC_STR( "hackrf_set_amp_enable", value ) ) } } return _amp_gain; } double hackrf_source_c::set_gain( double gain, const std::string & name, size_t chan) { if ( "RF" == name ) { return set_gain( gain, chan ); } if ( "IF" == name ) { return set_if_gain( gain, chan ); } if ( "BB" == name ) { return set_bb_gain( gain, chan ); } return set_gain( gain, chan ); } double hackrf_source_c::get_gain( size_t chan ) { return _amp_gain; } double hackrf_source_c::get_gain( const std::string & name, size_t chan ) { if ( "RF" == name ) { return get_gain( chan ); } if ( "IF" == name ) { return _lna_gain; } if ( "BB" == name ) { return _vga_gain; } return get_gain( chan ); } double hackrf_source_c::set_if_gain(double gain, size_t chan) { int ret; osmosdr::gain_range_t rf_gains = get_gain_range( "IF", chan ); if (_dev) { double clip_gain = rf_gains.clip( gain, true ); ret = hackrf_set_lna_gain( _dev, uint32_t(clip_gain) ); if ( HACKRF_SUCCESS == ret ) { _lna_gain = clip_gain; } else { HACKRF_THROW_ON_ERROR( ret, HACKRF_FUNC_STR( "hackrf_set_lna_gain", clip_gain ) ) } } return _lna_gain; } double hackrf_source_c::set_bb_gain( double gain, size_t chan ) { int ret; osmosdr::gain_range_t if_gains = get_gain_range( "BB", chan ); if (_dev) { double clip_gain = if_gains.clip( gain, true ); ret = hackrf_set_vga_gain( _dev, uint32_t(clip_gain) ); if ( HACKRF_SUCCESS == ret ) { _vga_gain = clip_gain; } else { HACKRF_THROW_ON_ERROR( ret, HACKRF_FUNC_STR( "hackrf_set_vga_gain", clip_gain ) ) } } return _vga_gain; } std::vector< std::string > hackrf_source_c::get_antennas( size_t chan ) { std::vector< std::string > antennas; antennas += get_antenna( chan ); return antennas; } std::string hackrf_source_c::set_antenna( const std::string & antenna, size_t chan ) { return get_antenna( chan ); } std::string hackrf_source_c::get_antenna( size_t chan ) { return "TX/RX"; } double hackrf_source_c::set_bandwidth( double bandwidth, size_t chan ) { int ret; // osmosdr::freq_range_t bandwidths = get_bandwidth_range( chan ); if ( bandwidth == 0.0 ) /* bandwidth of 0 means automatic filter selection */ bandwidth = _sample_rate * 0.75; /* select narrower filters to prevent aliasing */ if ( _dev ) { /* compute best default value depending on sample rate (auto filter) */ uint32_t bw = hackrf_compute_baseband_filter_bw( uint32_t(bandwidth) ); ret = hackrf_set_baseband_filter_bandwidth( _dev, bw ); if ( HACKRF_SUCCESS == ret ) { _bandwidth = bw; } else { HACKRF_THROW_ON_ERROR( ret, HACKRF_FUNC_STR( "hackrf_set_baseband_filter_bandwidth", bw ) ) } } return _bandwidth; } double hackrf_source_c::get_bandwidth( size_t chan ) { return _bandwidth; } osmosdr::freq_range_t hackrf_source_c::get_bandwidth_range( size_t chan ) { osmosdr::freq_range_t bandwidths; // TODO: read out from libhackrf when an API is available bandwidths += osmosdr::range_t( 1750000 ); bandwidths += osmosdr::range_t( 2500000 ); bandwidths += osmosdr::range_t( 3500000 ); bandwidths += osmosdr::range_t( 5000000 ); bandwidths += osmosdr::range_t( 5500000 ); bandwidths += osmosdr::range_t( 6000000 ); bandwidths += osmosdr::range_t( 7000000 ); bandwidths += osmosdr::range_t( 8000000 ); bandwidths += osmosdr::range_t( 9000000 ); bandwidths += osmosdr::range_t( 10000000 ); bandwidths += osmosdr::range_t( 12000000 ); bandwidths += osmosdr::range_t( 14000000 ); bandwidths += osmosdr::range_t( 15000000 ); bandwidths += osmosdr::range_t( 20000000 ); bandwidths += osmosdr::range_t( 24000000 ); bandwidths += osmosdr::range_t( 28000000 ); return bandwidths; } gr-osmosdr-0.1.0.55.80c4af/lib/hackrf/hackrf_source_c.h000066400000000000000000000114651225753723100223330ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Dimitri Stolnikov * * This file is part of GNU Radio * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_HACKRF_SOURCE_C_H #define INCLUDED_HACKRF_SOURCE_C_H #include #include #include #include #include #include "source_iface.h" class hackrf_source_c; /* * We use boost::shared_ptr's instead of raw pointers for all access * to gr::blocks (and many other data structures). The shared_ptr gets * us transparent reference counting, which greatly simplifies storage * management issues. This is especially helpful in our hybrid * C++ / Python system. * * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm * * As a convention, the _sptr suffix indicates a boost::shared_ptr */ typedef boost::shared_ptr hackrf_source_c_sptr; /*! * \brief Return a shared_ptr to a new instance of hackrf_source_c. * * To avoid accidental use of raw pointers, hackrf_source_c's * constructor is private. make_hackrf_source_c is the public * interface for creating new instances. */ hackrf_source_c_sptr make_hackrf_source_c (const std::string & args = ""); /*! * \brief Provides a stream of complex samples. * \ingroup block */ class hackrf_source_c : public gr::sync_block, public source_iface { private: // The friend declaration allows make_hackrf_source_c to // access the private constructor. friend hackrf_source_c_sptr make_hackrf_source_c (const std::string & args); /*! * \brief Provides a stream of complex samples. */ hackrf_source_c (const std::string & args); // private constructor public: ~hackrf_source_c (); // public destructor bool start(); bool stop(); int work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ); static std::vector< std::string > get_devices(); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); bool set_gain_mode( bool automatic, size_t chan = 0 ); bool get_gain_mode( size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); double set_if_gain( double gain, size_t chan = 0 ); double set_bb_gain( double gain, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); double set_bandwidth( double bandwidth, size_t chan = 0 ); double get_bandwidth( size_t chan = 0 ); osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ); private: static int _hackrf_rx_callback(hackrf_transfer* transfer); int hackrf_rx_callback(unsigned char *buf, uint32_t len); static void _hackrf_wait(hackrf_source_c *obj); void hackrf_wait(); static int _usage; static boost::mutex _usage_mutex; std::vector _lut; hackrf_device *_dev; gr::thread::thread _thread; unsigned short **_buf; unsigned int _buf_num; unsigned int _buf_len; unsigned int _buf_head; unsigned int _buf_used; boost::mutex _buf_mutex; boost::condition_variable _buf_cond; unsigned int _buf_offset; int _samp_avail; double _sample_rate; double _center_freq; double _freq_corr; bool _auto_gain; double _amp_gain; double _lna_gain; double _vga_gain; double _bandwidth; }; #endif /* INCLUDED_HACKRF_SOURCE_C_H */ gr-osmosdr-0.1.0.55.80c4af/lib/miri/000077500000000000000000000000001225753723100165355ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/lib/miri/CMakeLists.txt000066400000000000000000000026141225753723100213000ustar00rootroot00000000000000# Copyright 2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # This file included, use CMake directory variables ######################################################################## include_directories( ${CMAKE_CURRENT_SOURCE_DIR} ${LIBMIRISDR_INCLUDE_DIRS} ) set(mirisdr_srcs ${CMAKE_CURRENT_SOURCE_DIR}/miri_source_c.cc ) ######################################################################## # Append gnuradio-mirisdr library sources ######################################################################## list(APPEND gr_osmosdr_srcs ${mirisdr_srcs}) list(APPEND gr_osmosdr_libs ${LIBMIRISDR_LIBRARIES}) gr-osmosdr-0.1.0.55.80c4af/lib/miri/miri_source_c.cc000066400000000000000000000261251225753723100216740ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * Copyright 2012 Steve Markgraf * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ /* * config.h is generated by configure. It contains the results * of probing for features, options etc. It should be the first * file included in your .cc file. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "miri_source_c.h" #include #include #include #include #include #include #include #include "arg_helpers.h" using namespace boost::assign; #define BUF_SIZE 2304 * 8 * 2 #define BUF_NUM 32 #define BUF_SKIP 1 // buffers to skip due to garbage #define BYTES_PER_SAMPLE 4 // mirisdr device delivers 16 bit signed IQ data // containing 12 bits of information /* * Create a new instance of miri_source_c and return * a boost shared_ptr. This is effectively the public constructor. */ miri_source_c_sptr make_miri_source_c (const std::string &args) { return gnuradio::get_initial_sptr(new miri_source_c (args)); } /* * Specify constraints on number of input and output streams. * This info is used to construct the input and output signatures * (2nd & 3rd args to gr::block's constructor). The input and * output signatures are used by the runtime system to * check that a valid number and type of inputs and outputs * are connected to this block. In this case, we accept * only 0 input and 1 output. */ static const int MIN_IN = 0; // mininum number of input streams static const int MAX_IN = 0; // maximum number of input streams static const int MIN_OUT = 1; // minimum number of output streams static const int MAX_OUT = 1; // maximum number of output streams /* * The private constructor */ miri_source_c::miri_source_c (const std::string &args) : gr::sync_block ("miri_source_c", gr::io_signature::make(MIN_IN, MAX_IN, sizeof (gr_complex)), gr::io_signature::make(MIN_OUT, MAX_OUT, sizeof (gr_complex))), _running(true), _auto_gain(false), _skipped(0) { int ret; unsigned int dev_index = 0; dict_t dict = params_to_dict(args); if (dict.count("miri")) dev_index = boost::lexical_cast< unsigned int >( dict["miri"] ); _buf_num = _buf_head = _buf_used = _buf_offset = 0; _samp_avail = BUF_SIZE / BYTES_PER_SAMPLE; if (dict.count("buffers")) _buf_num = boost::lexical_cast< unsigned int >( dict["buffers"] ); if (0 == _buf_num) _buf_num = BUF_NUM; if ( BUF_NUM != _buf_num ) { std::cerr << "Using " << _buf_num << " buffers of size " << BUF_SIZE << "." << std::endl; } if ( dev_index >= mirisdr_get_device_count() ) throw std::runtime_error("Wrong mirisdr device index given."); std::cerr << "Using device #" << dev_index << ": " << mirisdr_get_device_name(dev_index) << std::endl; _dev = NULL; ret = mirisdr_open( &_dev, dev_index ); if (ret < 0) throw std::runtime_error("Failed to open mirisdr device."); #if 0 ret = mirisdr_set_sample_rate( _dev, 500000 ); if (ret < 0) throw std::runtime_error("Failed to set default samplerate."); ret = mirisdr_set_tuner_gain_mode(_dev, int(!_auto_gain)); if (ret < 0) throw std::runtime_error("Failed to enable manual gain mode."); #endif ret = mirisdr_reset_buffer( _dev ); if (ret < 0) throw std::runtime_error("Failed to reset usb buffers."); _buf = (unsigned short **) malloc(_buf_num * sizeof(unsigned short *)); _buf_lens = (unsigned int *) malloc(_buf_num * sizeof(unsigned int)); if (_buf && _buf_lens) { for(unsigned int i = 0; i < _buf_num; ++i) _buf[i] = (unsigned short *) malloc(BUF_SIZE); } _thread = gr::thread::thread(_mirisdr_wait, this); } /* * Our virtual destructor. */ miri_source_c::~miri_source_c () { if (_dev) { _running = false; mirisdr_cancel_async( _dev ); _thread.join(); mirisdr_close( _dev ); _dev = NULL; } if (_buf) { for(unsigned int i = 0; i < _buf_num; ++i) { if (_buf[i]) free(_buf[i]); } free(_buf); _buf = NULL; free(_buf_lens); _buf_lens = NULL; } } void miri_source_c::_mirisdr_callback(unsigned char *buf, uint32_t len, void *ctx) { miri_source_c *obj = (miri_source_c *)ctx; obj->mirisdr_callback(buf, len); } void miri_source_c::mirisdr_callback(unsigned char *buf, uint32_t len) { if (_skipped < BUF_SKIP) { _skipped++; return; } { boost::mutex::scoped_lock lock( _buf_mutex ); if (len > BUF_SIZE) throw std::runtime_error("Buffer too small."); int buf_tail = (_buf_head + _buf_used) % _buf_num; memcpy(_buf[buf_tail], buf, len); _buf_lens[buf_tail] = len; if (_buf_used == _buf_num) { std::cerr << "O" << std::flush; _buf_head = (_buf_head + 1) % _buf_num; } else { _buf_used++; } } _buf_cond.notify_one(); } void miri_source_c::_mirisdr_wait(miri_source_c *obj) { obj->mirisdr_wait(); } void miri_source_c::mirisdr_wait() { int ret = mirisdr_read_async( _dev, _mirisdr_callback, (void *)this, 0, BUF_SIZE ); _running = false; if ( ret != 0 ) std::cerr << "mirisdr_read_async returned with " << ret << std::endl; _buf_cond.notify_one(); } int miri_source_c::work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ) { gr_complex *out = (gr_complex *)output_items[0]; { boost::mutex::scoped_lock lock( _buf_mutex ); while (_buf_used < 3 && _running) // collect at least 3 buffers _buf_cond.wait( lock ); } if (!_running) return WORK_DONE; short *buf = (short *)_buf[_buf_head] + _buf_offset; if (noutput_items <= _samp_avail) { for (int i = 0; i < noutput_items; i++) *out++ = gr_complex( float(*(buf + i * 2 + 0)) * (1.0f/4096.0f), float(*(buf + i * 2 + 1)) * (1.0f/4096.0f) ); _buf_offset += noutput_items * 2; _samp_avail -= noutput_items; } else { for (int i = 0; i < _samp_avail; i++) *out++ = gr_complex( float(*(buf + i * 2 + 0)) * (1.0f/4096.0f), float(*(buf + i * 2 + 1)) * (1.0f/4096.0f) ); { boost::mutex::scoped_lock lock( _buf_mutex ); _buf_head = (_buf_head + 1) % _buf_num; _buf_used--; } buf = (short *)_buf[_buf_head]; int remaining = noutput_items - _samp_avail; for (int i = 0; i < remaining; i++) *out++ = gr_complex( float(*(buf + i * 2 + 0)) * (1.0f/4096.0f), float(*(buf + i * 2 + 1)) * (1.0f/4096.0f) ); _buf_offset = remaining * 2; _samp_avail = (_buf_lens[_buf_head] / BYTES_PER_SAMPLE) - remaining; } return noutput_items; } std::vector miri_source_c::get_devices() { std::vector devices; for (unsigned int i = 0; i < mirisdr_get_device_count(); i++) { std::string args = "miri=" + boost::lexical_cast< std::string >( i ); args += ",label='" + std::string(mirisdr_get_device_name( i )) + "'"; devices.push_back( args ); } return devices; } size_t miri_source_c::get_num_channels() { return 1; } osmosdr::meta_range_t miri_source_c::get_sample_rates() { osmosdr::meta_range_t range; range += osmosdr::range_t( 8000000 ); // known to work return range; } double miri_source_c::set_sample_rate(double rate) { if (_dev) { mirisdr_set_sample_rate( _dev, (uint32_t)rate ); } return get_sample_rate(); } double miri_source_c::get_sample_rate() { if (_dev) return (double)mirisdr_get_sample_rate( _dev ); return 0; } osmosdr::freq_range_t miri_source_c::get_freq_range( size_t chan ) { osmosdr::freq_range_t range; range += osmosdr::range_t( 150e3, 30e6 ); /* LW/MW/SW (150 kHz - 30 MHz) */ range += osmosdr::range_t( 64e6, 108e6 ); /* VHF Band II (64 - 108 MHz) */ range += osmosdr::range_t( 162e6, 240e6 ); /* Band III (162 - 240 MHz) */ range += osmosdr::range_t( 470e6, 960e6 ); /* Band IV/V (470 - 960 MHz) */ range += osmosdr::range_t( 1450e6, 1675e6 ); /* L-Band (1450 - 1675 MHz) */ return range; } double miri_source_c::set_center_freq( double freq, size_t chan ) { if (_dev) mirisdr_set_center_freq( _dev, (uint32_t)freq ); return get_center_freq( chan ); } double miri_source_c::get_center_freq( size_t chan ) { if (_dev) return (double)mirisdr_get_center_freq( _dev ); return 0; } double miri_source_c::set_freq_corr( double ppm, size_t chan ) { return get_freq_corr( chan ); } double miri_source_c::get_freq_corr( size_t chan ) { return 0; } std::vector miri_source_c::get_gain_names( size_t chan ) { std::vector< std::string > gains; gains += "LNA"; return gains; } osmosdr::gain_range_t miri_source_c::get_gain_range( size_t chan ) { osmosdr::gain_range_t range; if (_dev) { int count = mirisdr_get_tuner_gains(_dev, NULL); if (count > 0) { int* gains = new int[ count ]; count = mirisdr_get_tuner_gains(_dev, gains); for (int i = 0; i < count; i++) range += osmosdr::range_t( gains[i] / 10.0 ); delete[] gains; } } return range; } osmosdr::gain_range_t miri_source_c::get_gain_range( const std::string & name, size_t chan ) { return get_gain_range( chan ); } bool miri_source_c::set_gain_mode( bool automatic, size_t chan ) { if (_dev) { if (!mirisdr_set_tuner_gain_mode(_dev, int(!automatic))) { _auto_gain = automatic; } } return get_gain_mode(chan); } bool miri_source_c::get_gain_mode( size_t chan ) { return _auto_gain; } double miri_source_c::set_gain( double gain, size_t chan ) { osmosdr::gain_range_t rf_gains = miri_source_c::get_gain_range( chan ); if (_dev) { mirisdr_set_tuner_gain( _dev, int(rf_gains.clip(gain) * 10.0) ); } return get_gain( chan ); } double miri_source_c::set_gain( double gain, const std::string & name, size_t chan) { return set_gain( gain, chan ); } double miri_source_c::get_gain( size_t chan ) { if ( _dev ) return ((double)mirisdr_get_tuner_gain( _dev )) / 10.0; return 0; } double miri_source_c::get_gain( const std::string & name, size_t chan ) { return get_gain( chan ); } std::vector< std::string > miri_source_c::get_antennas( size_t chan ) { std::vector< std::string > antennas; antennas += get_antenna( chan ); return antennas; } std::string miri_source_c::set_antenna( const std::string & antenna, size_t chan ) { return get_antenna( chan ); } std::string miri_source_c::get_antenna( size_t chan ) { return "RX"; } gr-osmosdr-0.1.0.55.80c4af/lib/miri/miri_source_c.h000066400000000000000000000104201225753723100215250ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_MIRI_SOURCE_C_H #define INCLUDED_MIRI_SOURCE_C_H #include #include #include #include #include "source_iface.h" class miri_source_c; typedef struct mirisdr_dev mirisdr_dev_t; /* * We use boost::shared_ptr's instead of raw pointers for all access * to gr::blocks (and many other data structures). The shared_ptr gets * us transparent reference counting, which greatly simplifies storage * management issues. This is especially helpful in our hybrid * C++ / Python system. * * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm * * As a convention, the _sptr suffix indicates a boost::shared_ptr */ typedef boost::shared_ptr miri_source_c_sptr; /*! * \brief Return a shared_ptr to a new instance of miri_source_c. * * To avoid accidental use of raw pointers, miri_source_c's * constructor is private. make_miri_source_c is the public * interface for creating new instances. */ miri_source_c_sptr make_miri_source_c (const std::string & args = ""); /*! * \brief Provides a stream of complex samples. * \ingroup block */ class miri_source_c : public gr::sync_block, public source_iface { private: // The friend declaration allows make_miri_source_c to // access the private constructor. friend miri_source_c_sptr make_miri_source_c (const std::string & args); /*! * \brief Provides a stream of complex samples. */ miri_source_c (const std::string & args); // private constructor public: ~miri_source_c (); // public destructor int work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ); static std::vector< std::string > get_devices(); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); bool set_gain_mode( bool automatic, size_t chan = 0 ); bool get_gain_mode( size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); private: static void _mirisdr_callback(unsigned char *buf, uint32_t len, void *ctx); void mirisdr_callback(unsigned char *buf, uint32_t len); static void _mirisdr_wait(miri_source_c *obj); void mirisdr_wait(); mirisdr_dev_t *_dev; gr::thread::thread _thread; unsigned short **_buf; unsigned int *_buf_lens; unsigned int _buf_num; unsigned int _buf_head; unsigned int _buf_used; boost::mutex _buf_mutex; boost::condition_variable _buf_cond; bool _running; unsigned int _buf_offset; int _samp_avail; bool _auto_gain; unsigned int _skipped; }; #endif /* INCLUDED_MIRI_SOURCE_C_H */ gr-osmosdr-0.1.0.55.80c4af/lib/osmosdr/000077500000000000000000000000001225753723100172635ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/lib/osmosdr/CMakeLists.txt000066400000000000000000000026141225753723100220260ustar00rootroot00000000000000# Copyright 2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # This file included, use CMake directory variables ######################################################################## include_directories( ${CMAKE_CURRENT_SOURCE_DIR} ${LIBOSMOSDR_INCLUDE_DIRS} ) set(osmosdr_srcs ${CMAKE_CURRENT_SOURCE_DIR}/osmosdr_src_c.cc ) ######################################################################## # Append gnuradio-osmosdr library sources ######################################################################## list(APPEND gr_osmosdr_srcs ${osmosdr_srcs}) list(APPEND gr_osmosdr_libs ${LIBOSMOSDR_LIBRARIES}) gr-osmosdr-0.1.0.55.80c4af/lib/osmosdr/osmosdr_src_c.cc000066400000000000000000000307111225753723100224330ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ /* * config.h is generated by configure. It contains the results * of probing for features, options etc. It should be the first * file included in your .cc file. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "osmosdr_src_c.h" #include #include #include #include #include #include #include #include "arg_helpers.h" using namespace boost::assign; #define BUF_LEN (16 * 32 * 512) /* must be multiple of 512 */ #define BUF_NUM 32 #define BUF_SKIP 1 // buffers to skip due to garbage #define BYTES_PER_SAMPLE 4 // osmosdr device delivers 16 bit signed IQ data /* * Create a new instance of osmosdr_src_c and return * a boost shared_ptr. This is effectively the public constructor. */ osmosdr_src_c_sptr osmosdr_make_src_c (const std::string &args) { return gnuradio::get_initial_sptr(new osmosdr_src_c (args)); } /* * The private constructor */ osmosdr_src_c::osmosdr_src_c (const std::string &args) : gr::sync_block ("osmosdr_src_c", gr::io_signature::make(0, 0, sizeof (gr_complex)), args_to_io_signature(args)), _dev(NULL), _buf(NULL), _running(true), _auto_gain(false), _if_gain(0), _skipped(0) { int ret; unsigned int dev_index = 0; dict_t dict = params_to_dict(args); if (dict.count("osmosdr")) dev_index = boost::lexical_cast< unsigned int >( dict["osmosdr"] ); _buf_num = _buf_len = _buf_head = _buf_used = _buf_offset = 0; if (dict.count("buffers")) _buf_num = boost::lexical_cast< unsigned int >( dict["buffers"] ); if (dict.count("buflen")) _buf_len = boost::lexical_cast< unsigned int >( dict["buflen"] ); if (0 == _buf_num) _buf_num = BUF_NUM; if (0 == _buf_len || _buf_len % 512 != 0) /* len must be multiple of 512 */ _buf_len = BUF_LEN; if ( BUF_NUM != _buf_num || BUF_LEN != _buf_len ) { std::cerr << "Using " << _buf_num << " buffers of size " << _buf_len << "." << std::endl; } _samp_avail = _buf_len / BYTES_PER_SAMPLE; if ( dev_index >= osmosdr_get_device_count() ) throw std::runtime_error("Wrong osmosdr device index given."); std::cerr << "Using device #" << dev_index << ": " << osmosdr_get_device_name(dev_index) << std::endl; _dev = NULL; ret = osmosdr_open( &_dev, dev_index ); if (ret < 0) throw std::runtime_error("Failed to open osmosdr device."); ret = osmosdr_set_fpga_iq_swap(_dev, 0); if (ret < 0) throw std::runtime_error("Failed to disable IQ swapping."); ret = osmosdr_set_sample_rate( _dev, 500000 ); if (ret < 0) throw std::runtime_error("Failed to set default samplerate."); ret = osmosdr_set_tuner_gain_mode(_dev, int(!_auto_gain)); if (ret < 0) throw std::runtime_error("Failed to enable manual gain mode."); ret = osmosdr_reset_buffer( _dev ); if (ret < 0) throw std::runtime_error("Failed to reset usb buffers."); set_if_gain( 24 ); /* preset to a reasonable default (non-GRC use case) */ _buf = (unsigned short **) malloc(_buf_num * sizeof(unsigned short *)); if (_buf) { for(unsigned int i = 0; i < _buf_num; ++i) _buf[i] = (unsigned short *) malloc(_buf_len); } _thread = gr::thread::thread(_osmosdr_wait, this); } /* * Our virtual destructor. */ osmosdr_src_c::~osmosdr_src_c () { if (_dev) { _running = false; osmosdr_cancel_async( _dev ); _thread.join(); osmosdr_close( _dev ); _dev = NULL; } if (_buf) { for(unsigned int i = 0; i < _buf_num; ++i) { if (_buf[i]) free(_buf[i]); } free(_buf); _buf = NULL; } } void osmosdr_src_c::_osmosdr_callback(unsigned char *buf, uint32_t len, void *ctx) { osmosdr_src_c *obj = (osmosdr_src_c *)ctx; obj->osmosdr_callback(buf, len); } void osmosdr_src_c::osmosdr_callback(unsigned char *buf, uint32_t len) { if (_skipped < BUF_SKIP) { _skipped++; return; } { boost::mutex::scoped_lock lock( _buf_mutex ); int buf_tail = (_buf_head + _buf_used) % _buf_num; memcpy(_buf[buf_tail], buf, len); if (_buf_used == _buf_num) { std::cerr << "O" << std::flush; _buf_head = (_buf_head + 1) % _buf_num; } else { _buf_used++; } } _buf_cond.notify_one(); } void osmosdr_src_c::_osmosdr_wait(osmosdr_src_c *obj) { obj->osmosdr_wait(); } void osmosdr_src_c::osmosdr_wait() { int ret = osmosdr_read_async( _dev, _osmosdr_callback, (void *)this, 0, _buf_len ); _running = false; if ( ret != 0 ) std::cerr << "osmosdr_read_async returned with " << ret << std::endl; _buf_cond.notify_one(); } int osmosdr_src_c::work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ) { gr_complex *out = (gr_complex *)output_items[0]; { boost::mutex::scoped_lock lock( _buf_mutex ); while (_buf_used < 3 && _running) // collect at least 3 buffers _buf_cond.wait( lock ); } if (!_running) return WORK_DONE; short *buf = (short *)_buf[_buf_head] + _buf_offset; if (noutput_items <= _samp_avail) { for (int i = 0; i < noutput_items; i++) *out++ = gr_complex( float(*(buf + i * 2 + 0)) * (1.0f/32767.5f), float(*(buf + i * 2 + 1)) * (1.0f/32767.5f) ); _buf_offset += noutput_items * 2; _samp_avail -= noutput_items; } else { for (int i = 0; i < _samp_avail; i++) *out++ = gr_complex( float(*(buf + i * 2 + 0)) * (1.0f/32767.5f), float(*(buf + i * 2 + 1)) * (1.0f/32767.5f) ); { boost::mutex::scoped_lock lock( _buf_mutex ); _buf_head = (_buf_head + 1) % _buf_num; _buf_used--; } buf = (short *)_buf[_buf_head]; int remaining = noutput_items - _samp_avail; for (int i = 0; i < remaining; i++) *out++ = gr_complex( float(*(buf + i * 2 + 0)) * (1.0f/32767.5f), float(*(buf + i * 2 + 1)) * (1.0f/32767.5f) ); _buf_offset = remaining * 2; _samp_avail = (_buf_len / BYTES_PER_SAMPLE) - remaining; } return noutput_items; } std::vector osmosdr_src_c::get_devices() { std::vector< std::string > devices; char buffer[256]; for (unsigned int i = 0; i < osmosdr_get_device_count(); i++) { std::string args = "osmosdr=" + boost::lexical_cast< std::string >( i ); std::string label = std::string(osmosdr_get_device_name( i )); memset(buffer, 0, sizeof(buffer)); osmosdr_get_device_usb_strings( i, NULL, NULL, buffer ); std::string serial = std::string(buffer); if (serial.length()) label += " " + serial; args += ",label='" + label + + "'"; devices.push_back( args ); } return devices; } size_t osmosdr_src_c::get_num_channels() { return 1; } osmosdr::meta_range_t osmosdr_src_c::get_sample_rates() { osmosdr::meta_range_t range; if (_dev) { int count = osmosdr_get_sample_rates(_dev, NULL); if (count > 0) { uint32_t* rates = new uint32_t[ count ]; count = osmosdr_get_sample_rates(_dev, rates); for (int i = 0; i < count; i++) range += osmosdr::range_t( rates[i] ); delete[] rates; } } return range; } double osmosdr_src_c::set_sample_rate(double rate) { if (_dev) { osmosdr_set_sample_rate( _dev, (uint32_t)rate ); } return get_sample_rate(); } double osmosdr_src_c::get_sample_rate() { if (_dev) return (double)osmosdr_get_sample_rate( _dev ); return 0; } osmosdr::freq_range_t osmosdr_src_c::get_freq_range( size_t chan ) { osmosdr::freq_range_t range; /* there is a (temperature dependent) gap between 1100 to 1250 MHz */ range += osmosdr::range_t( 52e6, 2.2e9 ); return range; } double osmosdr_src_c::set_center_freq( double freq, size_t chan ) { if (_dev) osmosdr_set_center_freq( _dev, (uint32_t)freq ); return get_center_freq( chan ); } double osmosdr_src_c::get_center_freq( size_t chan ) { if (_dev) return (double)osmosdr_get_center_freq( _dev ); return 0; } double osmosdr_src_c::set_freq_corr( double ppm, size_t chan ) { return get_freq_corr( chan ); } double osmosdr_src_c::get_freq_corr( size_t chan ) { return 0; } std::vector osmosdr_src_c::get_gain_names( size_t chan ) { std::vector< std::string > names; names += "LNA"; names += "IF"; return names; } osmosdr::gain_range_t osmosdr_src_c::get_gain_range( size_t chan ) { osmosdr::gain_range_t range; if (_dev) { int count = osmosdr_get_tuner_gains(_dev, NULL); if (count > 0) { int* gains = new int[ count ]; count = osmosdr_get_tuner_gains(_dev, gains); for (int i = 0; i < count; i++) range += osmosdr::range_t( gains[i] / 10.0 ); delete[] gains; } } return range; } osmosdr::gain_range_t osmosdr_src_c::get_gain_range( const std::string & name, size_t chan ) { if ( "IF" == name ) { return osmosdr::gain_range_t(3, 56, 1); } return get_gain_range( chan ); } bool osmosdr_src_c::set_gain_mode( bool automatic, size_t chan ) { if (_dev) { if (!osmosdr_set_tuner_gain_mode(_dev, int(!automatic))) { _auto_gain = automatic; } } return get_gain_mode(chan); } bool osmosdr_src_c::get_gain_mode( size_t chan ) { return _auto_gain; } double osmosdr_src_c::set_gain( double gain, size_t chan ) { osmosdr::gain_range_t rf_gains = osmosdr_src_c::get_gain_range( chan ); if (_dev) { osmosdr_set_tuner_gain( _dev, int(rf_gains.clip(gain) * 10.0) ); } return get_gain( chan ); } double osmosdr_src_c::set_gain( double gain, const std::string & name, size_t chan) { if ( "IF" == name ) { return set_if_gain( gain, chan ); } return set_gain( gain, chan ); } double osmosdr_src_c::get_gain( size_t chan ) { if ( _dev ) return ((double)osmosdr_get_tuner_gain( _dev )) / 10.0; return 0; } double osmosdr_src_c::get_gain( const std::string & name, size_t chan ) { if ( "IF" == name ) { return _if_gain; } return get_gain( chan ); } double osmosdr_src_c::set_if_gain(double gain, size_t chan) { std::vector< osmosdr::gain_range_t > if_gains; if_gains += osmosdr::gain_range_t(-3, 6, 9); if_gains += osmosdr::gain_range_t(0, 9, 3); if_gains += osmosdr::gain_range_t(0, 9, 3); if_gains += osmosdr::gain_range_t(0, 2, 1); if_gains += osmosdr::gain_range_t(3, 15, 3); if_gains += osmosdr::gain_range_t(3, 15, 3); std::map< int, double > gains; /* initialize with min gains */ for (unsigned int i = 0; i < if_gains.size(); i++) { gains[ i + 1 ] = if_gains[ i ].start(); } for (int i = if_gains.size() - 1; i >= 0; i--) { osmosdr::gain_range_t range = if_gains[ i ]; double error = gain; for( double g = range.start(); g <= range.stop(); g += range.step() ) { double sum = 0; for (int j = 0; j < int(gains.size()); j++) { if ( i == j ) sum += g; else sum += gains[ j + 1 ]; } double err = abs(gain - sum); if (err < error) { error = err; gains[ i + 1 ] = g; } } } #if 0 std::cerr << gain << " => "; double sum = 0; for (unsigned int i = 0; i < gains.size(); i++) { sum += gains[ i + 1 ]; std::cerr << gains[ i + 1 ] << " "; } std::cerr << " = " << sum << std::endl; #endif if (_dev) { for (unsigned int stage = 1; stage <= gains.size(); stage++) { osmosdr_set_tuner_if_gain( _dev, stage, int(gains[ stage ] * 10.0)); } } _if_gain = gain; return gain; } std::vector< std::string > osmosdr_src_c::get_antennas( size_t chan ) { std::vector< std::string > antennas; antennas += get_antenna( chan ); return antennas; } std::string osmosdr_src_c::set_antenna( const std::string & antenna, size_t chan ) { return get_antenna( chan ); } std::string osmosdr_src_c::get_antenna( size_t chan ) { return "RX"; } gr-osmosdr-0.1.0.55.80c4af/lib/osmosdr/osmosdr_src_c.h000066400000000000000000000106261225753723100223000ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_OSMOSDR_SRC_C_H #define INCLUDED_OSMOSDR_SRC_C_H #include #include #include #include #include "source_iface.h" class osmosdr_src_c; typedef struct osmosdr_dev osmosdr_dev_t; /* * We use boost::shared_ptr's instead of raw pointers for all access * to gr::blocks (and many other data structures). The shared_ptr gets * us transparent reference counting, which greatly simplifies storage * management issues. This is especially helpful in our hybrid * C++ / Python system. * * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm * * As a convention, the _sptr suffix indicates a boost::shared_ptr */ typedef boost::shared_ptr osmosdr_src_c_sptr; /*! * \brief Return a shared_ptr to a new instance of osmosdr_src_c. * * To avoid accidental use of raw pointers, osmosdr_src_c's * constructor is private. osmosdr_make_src_c is the public * interface for creating new instances. */ osmosdr_src_c_sptr osmosdr_make_src_c (const std::string & args = ""); /*! * \brief Provides a stream of complex samples. * \ingroup block * * \sa sink for a version that subclasses gr::hier_block2. */ class osmosdr_src_c : public gr::sync_block, public source_iface { private: // The friend declaration allows osmosdr_make_src_c to // access the private constructor. friend osmosdr_src_c_sptr osmosdr_make_src_c (const std::string & args); /*! * \brief Provides a stream of complex samples. */ osmosdr_src_c (const std::string & args); // private constructor public: ~osmosdr_src_c (); // public destructor int work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ); static std::vector< std::string > get_devices(); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); bool set_gain_mode( bool automatic, size_t chan = 0 ); bool get_gain_mode( size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); double set_if_gain( double gain, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); private: static void _osmosdr_callback(unsigned char *buf, uint32_t len, void *ctx); void osmosdr_callback(unsigned char *buf, uint32_t len); static void _osmosdr_wait(osmosdr_src_c *obj); void osmosdr_wait(); osmosdr_dev_t *_dev; gr::thread::thread _thread; unsigned short **_buf; unsigned int _buf_num; unsigned int _buf_len; unsigned int _buf_head; unsigned int _buf_used; boost::mutex _buf_mutex; boost::condition_variable _buf_cond; bool _running; unsigned int _buf_offset; int _samp_avail; bool _auto_gain; double _if_gain; unsigned int _skipped; }; #endif /* INCLUDED_OSMOSDR_SRC_C_H */ gr-osmosdr-0.1.0.55.80c4af/lib/ranges.cc000066400000000000000000000124451225753723100173710ustar00rootroot00000000000000// // Copyright 2011-2011 Ettus Research LLC // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see . // #include #include #include #include #include #include using namespace osmosdr; /*********************************************************************** * range_t implementation code **********************************************************************/ struct range_t::impl{ impl(double start, double stop, double step): start(start), stop(stop), step(step) { /* NOP */ } double start, stop, step; }; range_t::range_t(double value): _impl(OSMOSDR_PIMPL_MAKE(impl, (value, value, 0))) { /* NOP */ } range_t::range_t( double start, double stop, double step ): _impl(OSMOSDR_PIMPL_MAKE(impl, (start, stop, step))) { if (stop < start){ throw std::runtime_error("cannot make range where stop < start"); } } double range_t::start(void) const{ return _impl->start; } double range_t::stop(void) const{ return _impl->stop; } double range_t::step(void) const{ return _impl->step; } const std::string range_t::to_pp_string(void) const{ std::stringstream ss; ss << "(" << this->start(); if (this->start() != this->stop()) ss << ", " << this->stop(); if (this->step() != 0) ss << ", " << this->step(); ss << ")"; return ss.str(); } /*********************************************************************** * meta_range_t implementation code **********************************************************************/ void check_meta_range_monotonic(const meta_range_t &mr){ if (mr.empty()){ throw std::runtime_error("meta-range cannot be empty"); } for (size_t i = 1; i < mr.size(); i++){ if (mr.at(i).start() < mr.at(i-1).stop()){ throw std::runtime_error("meta-range is not monotonic"); } } } meta_range_t::meta_range_t(void){ /* NOP */ } meta_range_t::meta_range_t( double start, double stop, double step ): std::vector (1, range_t(start, stop, step)) { /* NOP */ } double meta_range_t::start(void) const{ check_meta_range_monotonic(*this); double min_start = this->front().start(); BOOST_FOREACH(const range_t &r, (*this)){ min_start = std::min(min_start, r.start()); } return min_start; } double meta_range_t::stop(void) const{ check_meta_range_monotonic(*this); double max_stop = this->front().stop(); BOOST_FOREACH(const range_t &r, (*this)){ max_stop = std::max(max_stop, r.stop()); } return max_stop; } double meta_range_t::step(void) const{ check_meta_range_monotonic(*this); std::vector non_zero_steps; range_t last = this->front(); BOOST_FOREACH(const range_t &r, (*this)){ //steps at each range if (r.step() > 0) non_zero_steps.push_back(r.step()); //and steps in-between ranges double ibtw_step = r.start() - last.stop(); if (ibtw_step > 0) non_zero_steps.push_back(ibtw_step); //store ref to last last = r; } if (non_zero_steps.empty()) return 0; //all zero steps, its zero... return *std::min_element(non_zero_steps.begin(), non_zero_steps.end()); } double meta_range_t::clip(double value, bool clip_step) const{ check_meta_range_monotonic(*this); double last_stop = this->front().stop(); BOOST_FOREACH(const range_t &r, (*this)){ //in-between ranges, clip to nearest if (value < r.start()){ return (std::abs(value - r.start()) < std::abs(value - last_stop))? r.start() : last_stop; } //in this range, clip here if (value <= r.stop()){ if (! clip_step || r.step() == 0) return value; return boost::math::round((value - r.start())/r.step())*r.step() + r.start(); } //continue on to the next range last_stop = r.stop(); } return last_stop; } std::vector meta_range_t::values() const { std::vector values; BOOST_FOREACH(const range_t &r, (*this)) { if (r.start() != r.stop()) { if ( r.step() == 0 ) { values.push_back( r.start() ); values.push_back( r.stop() ); } else { for ( double val = r.start(); val <= r.stop(); val += r.step() ) { values.push_back( val ); } } } else { values.push_back( r.start() ); } } return values; } const std::string meta_range_t::to_pp_string(void) const{ std::stringstream ss; BOOST_FOREACH(const range_t &r, (*this)){ ss << r.to_pp_string() << std::endl; } return ss.str(); } gr-osmosdr-0.1.0.55.80c4af/lib/rfspace/000077500000000000000000000000001225753723100172205ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/lib/rfspace/CMakeLists.txt000066400000000000000000000025361225753723100217660ustar00rootroot00000000000000# Copyright 2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # This file included, use CMake directory variables ######################################################################## include_directories( ${CMAKE_CURRENT_SOURCE_DIR} ) set(rfspace_srcs ${CMAKE_CURRENT_SOURCE_DIR}/rfspace_source_c.cc ) ######################################################################## # Append gnuradio-osmosdr library sources ######################################################################## list(APPEND gr_osmosdr_srcs ${rfspace_srcs}) #list(APPEND gr_osmosdr_libs ...) gr-osmosdr-0.1.0.55.80c4af/lib/rfspace/rfspace_source_c.cc000066400000000000000000001264051225753723100230440ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ /* * config.h is generated by configure. It contains the results * of probing for feature_t, options etc. It should be the first * file included in your .cc file. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #ifndef USE_ASIO #include #include #include #include #include #include #include #endif #include #include #include #include #include #include /* basename */ #include #include #include #include #include #include #include #include #include #ifdef USE_ASIO #include #endif #include #include "arg_helpers.h" #include "rfspace_source_c.h" using namespace boost::assign; #ifdef USE_ASIO using boost::asio::deadline_timer; #endif #define DEFAULT_HOST "127.0.0.1" /* We assume a running "siqs" from CuteSDR project */ #define DEFAULT_PORT 50000 /* * Create a new instance of rfspace_source_c and return * a boost shared_ptr. This is effectively the public constructor. */ rfspace_source_c_sptr make_rfspace_source_c (const std::string &args) { return gnuradio::get_initial_sptr(new rfspace_source_c (args)); } /* * Specify constraints on number of input and output streams. * This info is used to construct the input and output signatures * (2nd & 3rd args to gr_block's constructor). The input and * output signatures are used by the runtime system to * check that a valid number and type of inputs and outputs * are connected to this block. In this case, we accept * only 0 input and 1 output. */ static const int MIN_IN = 0; // mininum number of input streams static const int MAX_IN = 0; // maximum number of input streams static const int MIN_OUT = 1; // minimum number of output streams static const int MAX_OUT = 1; // maximum number of output streams /* * The private constructor */ rfspace_source_c::rfspace_source_c (const std::string &args) : gr::sync_block ("rfspace_source_c", gr::io_signature::make (MIN_IN, MAX_IN, sizeof (gr_complex)), gr::io_signature::make (MIN_OUT, MAX_OUT, sizeof (gr_complex))), _radio(RADIO_UNKNOWN), #ifdef USE_ASIO _io_service(), _resolver(_io_service), _t(_io_service), _u(_io_service), #else _tcp(-1), _udp(-1), #endif _usb(-1), _running(false), _keep_running(false), _sequence(0), _nchan(1), _sample_rate(NAN), _bandwidth(0.0f), _fifo(NULL) { std::string host = ""; unsigned short port = 0; dict_t dict = params_to_dict(args); if ( dict.count("sdr-iq") ) dict["rfspace"] = dict["sdr-iq"]; if ( dict.count("sdr-ip") ) dict["rfspace"] = dict["sdr-ip"]; if ( dict.count("netsdr") ) dict["rfspace"] = dict["netsdr"]; if ( dict.count("rfspace") ) { std::string value = dict["rfspace"]; if ( ! value.length() ) { std::vector< std::string > devices = get_devices(); if ( devices.size() ) { dict_t first = params_to_dict( devices[0] ); if ( first.count("sdr-iq") ) value = first["sdr-iq"]; if ( first.count("sdr-ip") ) value = first["sdr-ip"]; if ( first.count("netsdr") ) value = first["netsdr"]; dict["rfspace"] = value; dict["label"] = first["label"]; } } std::vector< std::string > tokens; boost::algorithm::split( tokens, value, boost::is_any_of(":") ); if ( tokens[0].length() && (tokens.size() == 1 || tokens.size() == 2 ) ) host = tokens[0]; if ( tokens.size() == 2 ) /* port given */ port = boost::lexical_cast< unsigned short >( tokens[1] ); } if (dict.count("nchan")) _nchan = boost::lexical_cast< size_t >( dict["nchan"] ); if ( _nchan < 1 || _nchan > 2 ) throw std::runtime_error("Number of channels (nchan) must be 1 or 2"); if ( ! host.length() ) host = DEFAULT_HOST; if (0 == port) port = DEFAULT_PORT; std::string port_str = boost::lexical_cast< std::string >( port ); std::string label = dict["label"]; if ( label.length() ) std::cerr << "Using " + label << " "; struct stat sb; bzero(&sb, sizeof(sb)); if ( stat(host.c_str(), &sb) == 0 && (sb.st_mode & S_IFMT) == S_IFCHR ) /* is character device */ { _usb = open( host.c_str(), O_RDWR | O_NOCTTY ); if ( _usb < 0 ) throw std::runtime_error("Could not open " + host + ": " + std::string(strerror(errno))); struct termios tios; bzero(&tios, sizeof(tios)); tios.c_cflag = CS8 | CLOCAL | CREAD; tios.c_iflag = IGNPAR; tios.c_oflag = 0; tios.c_lflag = 0; tios.c_cc[VTIME] = 2; /* in units of 0.1 seconds */ tios.c_cc[VMIN] = 0; cfsetispeed(&tios, B230400); cfsetospeed(&tios, B230400); tcflush(_usb, TCIFLUSH); tcsetattr(_usb, TCSANOW, &tios); unsigned char byte; while ( read(_usb, &byte, sizeof(byte)) > 0 ); /* flush serial */ _radio = RFSPACE_SDR_IQ; /* legitimate assumption */ _fifo = new boost::circular_buffer( 200000 ); if ( ! _fifo ) throw std::runtime_error( "Failed to allocate sample FIFO" ); _run_usb_read_task = true; _thread = gr::thread::thread( boost::bind(&rfspace_source_c::usb_read_task, this) ); } else /* assuming host & port */ { // TODO: make listener host & port dynamic: bind=[host][:port] /* SDR-IP 4.4.4 Data Output UDP IP and Port Address */ /* NETSDR 4.4.3 Data Output UDP IP and Port Address */ #ifdef USE_ASIO tcp::resolver::query query(tcp::v4(), host.c_str(), port_str.c_str()); tcp::resolver::iterator iterator = _resolver.resolve(query); boost::system::error_code ec; boost::asio::connect(_t, iterator, ec); if ( ec ) throw std::runtime_error(ec.message() + " (" + host + ":" + port_str + ")"); _u.open(udp::v4(), ec); if ( ec ) throw std::runtime_error(ec.message()); _u.bind(udp::endpoint(udp::v4(), DEFAULT_PORT), ec); if ( ec ) throw std::runtime_error(ec.message()); _u.set_option(udp::socket::reuse_address(true)); _t.set_option(udp::socket::reuse_address(true)); #else if ( (_tcp = socket(AF_INET, SOCK_STREAM, 0) ) < 0) { throw std::runtime_error("Could not create TCP socket"); } int sockoptval = 1; setsockopt(_tcp, SOL_SOCKET, SO_REUSEADDR, &sockoptval, sizeof(int)); sockoptval = 1; setsockopt(_tcp, IPPROTO_TCP, TCP_NODELAY, &sockoptval, sizeof(int)); /* don't wait when shutting down */ linger lngr; lngr.l_onoff = 1; lngr.l_linger = 0; setsockopt(_tcp, SOL_SOCKET, SO_LINGER, &lngr, sizeof(linger)); struct hostent *hp; /* host information */ struct sockaddr_in host_sa; /* local address */ struct sockaddr_in peer_sa; /* remote address */ /* look up the address of the server given its name */ hp = gethostbyname( host.c_str() ); if (!hp) { close(_tcp); throw std::runtime_error(std::string(hstrerror(h_errno)) + " (" + host + ")"); } /* fill in the hosts's address and data */ memset(&host_sa, 0, sizeof(host_sa)); host_sa.sin_family = AF_INET; host_sa.sin_addr.s_addr = htonl(INADDR_ANY); host_sa.sin_port = htons(0); if ( bind(_tcp, (struct sockaddr *)&host_sa, sizeof(host_sa)) < 0 ) { close(_tcp); throw std::runtime_error("Bind of TCP socket failed: " + std::string(strerror(errno))); } /* fill in the server's address and data */ memset(&peer_sa, 0, sizeof(peer_sa)); peer_sa.sin_family = AF_INET; peer_sa.sin_port = htons(port); /* put the host's address into the server address structure */ memcpy((void *)&peer_sa.sin_addr, hp->h_addr_list[0], hp->h_length); /* connect to server */ if ( connect(_tcp, (struct sockaddr *)&peer_sa, sizeof(peer_sa)) < 0 ) { close(_tcp); throw std::runtime_error(std::string(strerror(errno)) + " (" + host + ":" + port_str + ")"); } if ( (_udp = socket(AF_INET, SOCK_DGRAM, 0)) < 0 ) { close(_tcp); throw std::runtime_error("Could not create UDP socket"); } sockoptval = 1; setsockopt(_udp, SOL_SOCKET, SO_REUSEADDR, &sockoptval, sizeof(int)); /* fill in the hosts's address and data */ memset(&host_sa, 0, sizeof(host_sa)); host_sa.sin_family = AF_INET; host_sa.sin_addr.s_addr = htonl(INADDR_ANY); host_sa.sin_port = htons(DEFAULT_PORT); if ( bind(_udp, (struct sockaddr *)&host_sa, sizeof(host_sa)) < 0 ) { close(_tcp); close(_udp); throw std::runtime_error("Bind of UDP socket failed: " + std::string(strerror(errno))); } #endif } /* request & print device information */ std::vector< unsigned char > response; if ( ! label.length() ) /* label is empty, request name & serial from device */ { std::cerr << "Using "; unsigned char name[] = { 0x04, 0x20, 0x01, 0x00 }; /* NETSDR 4.1.1 Target Name */ if ( transaction( name, sizeof(name), response ) ) std::cerr << "RFSPACE " << &response[sizeof(name)] << " "; unsigned char sern[] = { 0x04, 0x20, 0x02, 0x00 }; /* NETSDR 4.1.2 Target Serial Number */ if ( transaction( sern, sizeof(sern), response ) ) std::cerr << "SN " << &response[sizeof(sern)] << " "; } unsigned char prod[] = { 0x04, 0x20, 0x09, 0x00 }; /* NETSDR 4.1.6 Product ID */ if ( transaction( prod, sizeof(prod), response ) ) { uint32_t product_id = htonl(*((uint32_t *)&response[sizeof(prod)])); // std::cerr << std::hex << product_id << std::dec << " "; if ( 0x5affa500 == product_id ) /* SDR-IQ 5.1.6 Product ID */ _radio = RFSPACE_SDR_IQ; else if ( 0x53445203 == product_id ) /* SDR-IP 4.1.6 Product ID */ _radio = RFSPACE_SDR_IP; else if ( 0x53445204 == product_id ) /* NETSDR 4.1.6 Product ID */ _radio = RFSPACE_NETSDR; else std::cerr << "UNKNOWN "; } bool has_X2_option = false; if ( RFSPACE_NETSDR == _radio ) { unsigned char opts[] = { 0x04, 0x20, 0x0A, 0x00 }; /* NETSDR 4.1.7 Options */ if ( transaction( opts, sizeof(opts), response ) ) { if ( response[sizeof(opts)] ) { has_X2_option = (response[sizeof(opts)] & 16 ? true : false); std::cerr << "option "; std::cerr << (response[sizeof(opts)] & 16 ? "2" : "-"); /* X2 board */ std::cerr << (response[sizeof(opts)] & 8 ? "U" : "-"); /* Up Converter */ std::cerr << (response[sizeof(opts)] & 4 ? "D" : "-"); /* Down Converter */ std::cerr << (response[sizeof(opts)] & 2 ? "R" : "-"); /* Reflock board */ std::cerr << (response[sizeof(opts)] & 1 ? "S" : "-"); /* Sound Enabled */ std::cerr << " "; } } } /* NETSDR 4.1.4 Hardware/Firmware Versions */ unsigned char bootver[] = { 0x05, 0x20, 0x04, 0x00, 0x00 }; if ( transaction( bootver, sizeof(bootver), response ) ) std::cerr << "BOOT " << *((uint16_t *)&response[sizeof(bootver)]) << " "; unsigned char firmver[] = { 0x05, 0x20, 0x04, 0x00, 0x01 }; if ( transaction( firmver, sizeof(firmver), response ) ) std::cerr << "FW " << *((uint16_t *)&response[sizeof(firmver)]) << " "; if ( RFSPACE_NETSDR == _radio || RFSPACE_SDR_IP == _radio ) { unsigned char hardver[] = { 0x05, 0x20, 0x04, 0x00, 0x02 }; if ( transaction( hardver, sizeof(hardver), response ) ) std::cerr << "HW " << *((uint16_t *)&response[sizeof(hardver)]) << " "; } if ( RFSPACE_NETSDR == _radio ) { unsigned char fpgaver[] = { 0x05, 0x20, 0x04, 0x00, 0x03 }; if ( transaction( fpgaver, sizeof(fpgaver), response ) ) std::cerr << "FPGA " << int(response[sizeof(fpgaver)]) << "/" << int(response[sizeof(fpgaver)+1]) << " "; } std::cerr << std::endl; if ( RFSPACE_NETSDR == _radio ) { /* NETSDR 4.2.2 Receiver Channel Setup */ unsigned char rxchan[] = { 0x05, 0x00, 0x19, 0x00, 0x00 }; unsigned char mode = 0; /* 0 = Single Channel Mode */ if ( 2 == _nchan ) { if ( has_X2_option ) mode = 6; /* Dual Channel with dual A/D RF Path (requires X2 option) */ else mode = 4; /* Dual Channel with single A/D RF Path using main A/D. */ set_output_signature( gr::io_signature::make (2, 2, sizeof (gr_complex)) ); } rxchan[sizeof(rxchan)-1] = mode; transaction( rxchan, sizeof(rxchan) ); } else { if ( 2 == _nchan ) std::cerr << "NetSDR receiver required for dual channel support." << std::endl; } /* preset reasonable defaults */ if ( RFSPACE_SDR_IQ == _radio ) { set_sample_rate( 196078 ); } else if ( RFSPACE_NETSDR == _radio || RFSPACE_SDR_IP == _radio ) { set_sample_rate( 200000 ); set_bandwidth( 0 ); /* switch to automatic filter selection by default */ } #if 0 std::cerr << "sample_rates: " << get_sample_rates().to_pp_string() << std::endl; std::cerr << "sample rate: " << (uint32_t)get_sample_rate() << std::endl; std::cerr << "freq range: " << get_freq_range().to_pp_string() << std::endl; std::cerr << "center freq: " << (uint32_t)get_center_freq() << std::endl; std::cerr << "gain range: " << get_gain_range().to_pp_string() << std::endl; std::cerr << "gain: " << (uint32_t)get_gain() << std::endl; std::cerr << "bw range: " << get_bandwidth_range().to_pp_string() << std::endl; #endif } /* * Our virtual destructor. */ rfspace_source_c::~rfspace_source_c () { #ifndef USE_ASIO close(_tcp); close(_udp); #endif if ( RFSPACE_SDR_IQ == _radio ) { _run_usb_read_task = false; _thread.join(); } close(_usb); if ( _fifo ) { delete _fifo; _fifo = NULL; } } void rfspace_source_c::apply_channel( unsigned char *cmd, size_t chan ) { unsigned char value = 0; if ( 0 == chan ) { value = 0; } else if ( 1 == chan ) { if ( _nchan < 2 ) throw std::runtime_error("Channel must be 0 only"); value = 2; } else throw std::runtime_error("Channel must be 0 or 1"); cmd[4] = value; } bool rfspace_source_c::transaction( const unsigned char *cmd, size_t size ) { std::vector< unsigned char > response; if ( ! transaction( cmd, size, response ) ) return false; /* comparing the contents is not really feasible due to protocol */ if ( response.size() == size ) /* check response size against request */ return true; return false; } //#define VERBOSE bool rfspace_source_c::transaction( const unsigned char *cmd, size_t size, std::vector< unsigned char > &response ) { size_t rx_bytes = 0; unsigned char data[1024*2]; response.clear(); #ifdef VERBOSE printf("< "); for (size_t i = 0; i < size; i++) printf("%02x ", (unsigned char) cmd[i]); printf("\n"); #endif if ( RFSPACE_SDR_IQ == _radio ) { if ( write(_usb, cmd, size) != (int)size ) return false; boost::unique_lock lock(_resp_lock); _resp_avail.wait(lock); rx_bytes = _resp.size(); memcpy( data, _resp.data(), rx_bytes ); } else { #ifdef USE_ASIO _t.write_some( boost::asio::buffer(cmd, size) ); rx_bytes = _t.read_some( boost::asio::buffer(data, sizeof(data)) ); #else if ( write(_tcp, cmd, size) != (int)size ) return false; int nbytes = read(_tcp, data, 2); /* read header */ if ( nbytes != 2 ) return false; int length = (data[1] & 0x1f) | data[0]; if ( (length < 2) || (length > (int)sizeof(data)) ) return false; length -= 2; /* subtract header size */ nbytes = read(_tcp, &data[2], length); /* read payload */ if ( nbytes != length ) return false; rx_bytes = 2 + length; /* header + payload */ #endif } response.resize( rx_bytes ); memcpy( response.data(), data, rx_bytes ); #ifdef VERBOSE printf("> "); for (size_t i = 0; i < rx_bytes; i++) printf("%02x ", (unsigned char) data[i]); printf("\n"); #endif return true; } static size_t read_bytes( int fd, char *data, size_t size, bool &run ) { size_t nbytes = 0; while ( nbytes < size && run ) { int nread = read( fd, &data[nbytes], 1 ); if ( nread == 0 ) continue; if ( nread < 0 ) break; nbytes++; } return nbytes; } void rfspace_source_c::usb_read_task() { char data[1024*10]; size_t n_avail, to_copy; if ( -1 == _usb ) return; while ( _run_usb_read_task ) { size_t nbytes = read_bytes( _usb, data, 2, _run_usb_read_task ); if ( nbytes != 2 ) continue; size_t length = ((data[1] << 8) | data[0]) & 0x1fff; if ( 0 == length ) /* SDR-IQ 5.4.1 Output Data Item 0 */ length = 1024*8 + 2; if ( length <= 2 ) continue; length -= 2; /* subtract header */ if ( length > sizeof(data) - 2 ) { _run_usb_read_task = false; continue; } nbytes = read_bytes( _usb, data + 2, length, _run_usb_read_task ); if ( nbytes != length ) continue; if ( 1024*8 == length ) { /* push samples into the fifo */ _fifo_lock.lock(); size_t num_samples = length / 4; n_avail = _fifo->capacity() - _fifo->size(); to_copy = (n_avail < num_samples ? n_avail : num_samples); #define SCALE_16 (1.0f/32768.0f) int16_t *sample = (int16_t *)(data + 2); for ( size_t i = 0; i < to_copy; i++ ) { /* Push sample to the fifo */ _fifo->push_back( gr_complex( *(sample+0) * SCALE_16, *(sample+1) * SCALE_16 ) ); /* offset to the next I+Q sample */ sample += 2; } #undef SCALE_16 _fifo_lock.unlock(); /* We have made some new samples available to the consumer in work() */ if (to_copy) { // std::cerr << "+" << std::flush; _samp_avail.notify_one(); } /* Indicate overrun, if neccesary */ if (to_copy < num_samples) std::cerr << "O" << std::flush; } else { /* copy response & signal transaction */ _resp_lock.lock(); _resp.clear(); _resp.resize( length + 2 ); memcpy( _resp.data(), data, length + 2 ); _resp_lock.unlock(); _resp_avail.notify_one(); } } } bool rfspace_source_c::start() { _sequence = 0; _running = true; _keep_running = false; /* SDR-IP 4.2.1 Receiver State */ /* NETSDR 4.2.1 Receiver State */ unsigned char start[] = { 0x08, 0x00, 0x18, 0x00, 0x80, 0x02, 0x00, 0x00 }; /* SDR-IQ 5.2.1 Receiver State */ if ( RFSPACE_SDR_IQ == _radio ) start[sizeof(start)-4] = 0x81; unsigned char mode = 0; /* 0 = 16 bit Contiguous Mode */ if ( 0 ) /* TODO: 24 bit Contiguous mode */ mode |= 0x80; if ( 0 ) /* TODO: Hardware Triggered Pulse mode */ mode |= 0x03; start[sizeof(start)-2] = mode; return transaction( start, sizeof(start) ); } bool rfspace_source_c::stop() { if ( ! _keep_running ) _running = false; _keep_running = false; if ( _fifo ) _fifo->clear(); /* SDR-IP 4.2.1 Receiver State */ /* NETSDR 4.2.1 Receiver State */ unsigned char stop[] = { 0x08, 0x00, 0x18, 0x00, 0x00, 0x01, 0x00, 0x00 }; /* SDR-IQ 5.2.1 Receiver State */ if ( RFSPACE_SDR_IQ == _radio ) stop[sizeof(stop)-4] = 0x81; return transaction( stop, sizeof(stop) ); } /* Main work function, pull samples from the socket */ int rfspace_source_c::work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ) { unsigned char data[1024*2]; if ( ! _running ) return WORK_DONE; if ( RFSPACE_SDR_IQ == _radio ) { if ( noutput_items > 0 ) { gr_complex *out = (gr_complex *)output_items[0]; boost::unique_lock lock(_fifo_lock); /* Wait until we have the requested number of samples */ int n_samples_avail = _fifo->size(); while ( n_samples_avail < noutput_items ) { _samp_avail.wait(lock); n_samples_avail = _fifo->size(); } for ( int i = 0; i < noutput_items; ++i ) { out[i] = _fifo->at(0); _fifo->pop_front(); } // std::cerr << "-" << std::flush; } return noutput_items; } #ifdef USE_ASIO udp::endpoint ep; size_t rx_bytes = _u.receive_from( boost::asio::buffer(data, sizeof(data)), ep ); #else struct sockaddr_in sa_in; /* remote address */ socklen_t addrlen = sizeof(sa_in); /* length of addresses */ ssize_t rx_bytes = recvfrom(_udp, data, sizeof(data), 0, (struct sockaddr *)&sa_in, &addrlen); if ( rx_bytes <= 0 ) { std::cerr << "recvfrom returned " << rx_bytes << std::endl; return WORK_DONE; } #endif #define HEADER_SIZE 2 #define SEQNUM_SIZE 2 // bool is_24_bit = false; // TODO: implement 24 bit sample format /* check header */ if ( (0x04 == data[0] && (0x84 == data[1] || 0x82 == data[1])) ) { // is_24_bit = false; } else if ( (0xA4 == data[0] && 0x85 == data[1]) || (0x84 == data[0] && 0x81 == data[1]) ) { // is_24_bit = true; return 0; } else return 0; uint16_t sequence = *((uint16_t *)(data + HEADER_SIZE)); uint16_t diff = sequence - _sequence; if ( diff > 1 ) { std::cerr << "Lost " << diff << " packets from " #ifdef USE_ASIO << ep #else << inet_ntoa(sa_in.sin_addr) << ":" << ntohs(sa_in.sin_port) #endif << std::endl; } _sequence = (0xffff == sequence) ? 0 : sequence; /* get pointer to samples */ int16_t *sample = (int16_t *)(data + HEADER_SIZE + SEQNUM_SIZE); size_t rx_samples = (rx_bytes - HEADER_SIZE - SEQNUM_SIZE) / (sizeof(int16_t) * 2); #define SCALE_16 (1.0f/32768.0f) if ( 1 == _nchan ) { gr_complex *out = (gr_complex *)output_items[0]; for ( size_t i = 0; i < rx_samples; i++ ) { out[i] = gr_complex( *(sample+0) * SCALE_16, *(sample+1) * SCALE_16 ); sample += 2; } } else if ( 2 == _nchan ) { rx_samples /= 2; gr_complex *out1 = (gr_complex *)output_items[0]; gr_complex *out2 = (gr_complex *)output_items[1]; for ( size_t i = 0; i < rx_samples; i++ ) { out1[i] = gr_complex( *(sample+0) * SCALE_16, *(sample+1) * SCALE_16 ); out2[i] = gr_complex( *(sample+2) * SCALE_16, *(sample+3) * SCALE_16 ); sample += 4; } } #undef SCALE_16 noutput_items = rx_samples; return noutput_items; } /* discovery protocol internals taken from CuteSDR project */ typedef struct __attribute__ ((__packed__)) { /* 56 fixed common byte fields */ unsigned char length[2]; /* length of total message in bytes (little endian byte order) */ unsigned char key[2]; /* fixed key key[0]==0x5A key[1]==0xA5 */ unsigned char op; /* 0 == Tx_msg(to device), 1 == Rx_msg(from device), 2 == Set(to device) */ char name[16]; /* Device name string null terminated */ char sn[16]; /* Serial number string null terminated */ unsigned char ipaddr[16]; /* device IP address (little endian byte order) */ unsigned char port[2]; /* device Port number (little endian byte order) */ unsigned char customfield; /* Specifies a custom data field for a particular device */ } discover_common_msg_t; /* UDP port numbers for discovery protocol */ #define DISCOVER_SERVER_PORT 48321 /* PC client Tx port, SDR Server Rx Port */ #define DISCOVER_CLIENT_PORT 48322 /* PC client Rx port, SDR Server Tx Port */ #define KEY0 0x5A #define KEY1 0xA5 #define MSG_REQ 0 #define MSG_RESP 1 #define MSG_SET 2 typedef struct { std::string name; std::string sn; std::string addr; uint16_t port; } unit_t; #ifdef USE_ASIO static void handle_receive( const boost::system::error_code& ec, std::size_t length, boost::system::error_code* out_ec, std::size_t* out_length ) { *out_ec = ec; *out_length = length; } static void handle_timer( const boost::system::error_code& ec, boost::system::error_code* out_ec ) { *out_ec = boost::asio::error::timed_out; } #endif static std::vector < unit_t > discover_netsdr() { std::vector < unit_t > units; #ifdef USE_ASIO boost::system::error_code ec; boost::asio::io_service ios; udp::socket socket(ios); deadline_timer timer(ios); timer.expires_at(boost::posix_time::pos_infin); socket.open(udp::v4(), ec); if ( ec ) return units; socket.bind(udp::endpoint(udp::v4(), DISCOVER_CLIENT_PORT), ec); if ( ec ) return units; socket.set_option(udp::socket::reuse_address(true)); socket.set_option(boost::asio::socket_base::broadcast(true)); #else int sock; if ( (sock = socket(AF_INET, SOCK_DGRAM, 0)) < 0 ) return units; int sockoptval = 1; setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &sockoptval, sizeof(int)); sockoptval = 1; setsockopt(sock, SOL_SOCKET, SO_BROADCAST, &sockoptval, sizeof(int)); struct sockaddr_in host_sa; /* local address */ struct sockaddr_in peer_sa; /* remote address */ /* fill in the server's address and data */ memset((char*)&peer_sa, 0, sizeof(peer_sa)); peer_sa.sin_family = AF_INET; peer_sa.sin_addr.s_addr = htonl(INADDR_BROADCAST); peer_sa.sin_port = htons(DISCOVER_SERVER_PORT); /* fill in the hosts's address and data */ memset(&host_sa, 0, sizeof(host_sa)); host_sa.sin_family = AF_INET; host_sa.sin_addr.s_addr = htonl(INADDR_ANY); host_sa.sin_port = htons(DISCOVER_CLIENT_PORT); if ( bind(sock, (struct sockaddr *)&host_sa, sizeof(host_sa)) < 0 ) { close(sock); return units; } struct timeval tv; tv.tv_sec = 0; tv.tv_usec = 100000; if ( setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv)) < 0 ) { close(sock); return units; } #endif discover_common_msg_t tx_msg; memset( (void *)&tx_msg, 0, sizeof(discover_common_msg_t) ); tx_msg.length[0] = sizeof(discover_common_msg_t); tx_msg.length[1] = sizeof(discover_common_msg_t) >> 8; tx_msg.key[0] = KEY0; tx_msg.key[1] = KEY1; tx_msg.op = MSG_REQ; #ifdef USE_ASIO udp::endpoint ep(boost::asio::ip::address_v4::broadcast(), DISCOVER_SERVER_PORT); socket.send_to(boost::asio::buffer(&tx_msg, sizeof(tx_msg)), ep); #else sendto(sock, &tx_msg, sizeof(tx_msg), 0, (struct sockaddr *)&peer_sa, sizeof(peer_sa)); #endif while ( true ) { std::size_t rx_bytes = 0; unsigned char data[1024*2]; #ifdef USE_ASIO // Set up the variables that receive the result of the asynchronous // operation. The error code is set to would_block to signal that the // operation is incomplete. Asio guarantees that its asynchronous // operations will never fail with would_block, so any other value in // ec indicates completion. ec = boost::asio::error::would_block; // Start the asynchronous receive operation. The handle_receive function // used as a callback will update the ec and rx_bytes variables. socket.async_receive( boost::asio::buffer(data, sizeof(data)), boost::bind(handle_receive, _1, _2, &ec, &rx_bytes) ); // Set a deadline for the asynchronous operation. timer.expires_from_now( boost::posix_time::milliseconds(10) ); // Start an asynchronous wait on the timer. The handle_timer function // used as a callback will update the ec variable. timer.async_wait( boost::bind(handle_timer, _1, &ec) ); // Reset the io_service in preparation for a subsequent run_one() invocation. ios.reset(); // Block until at least one asynchronous operation has completed. do ios.run_one(); while ( ec == boost::asio::error::would_block ); if ( boost::asio::error::timed_out == ec ) /* timer was first to complete */ { // Please note that cancel() has portability issues on some versions of // Microsoft Windows, and it may be necessary to use close() instead. // Consult the documentation for cancel() for further information. socket.cancel(); break; } else /* socket was first to complete */ { timer.cancel(); } #else socklen_t addrlen = sizeof(peer_sa); /* length of addresses */ int nbytes = recvfrom(sock, data, sizeof(data), 0, (struct sockaddr *)&peer_sa, &addrlen); if ( nbytes <= 0 ) break; rx_bytes = nbytes; #endif if ( rx_bytes >= sizeof(discover_common_msg_t) ) { discover_common_msg_t *rx_msg = (discover_common_msg_t *)data; if ( KEY0 == rx_msg->key[0] && KEY1 == rx_msg->key[1] && MSG_RESP == rx_msg->op ) { void *temp = rx_msg->port; uint16_t port = *((uint16_t *)temp); std::string addr = str(boost::format("%d.%d.%d.%d") % int(rx_msg->ipaddr[3]) % int(rx_msg->ipaddr[2]) % int(rx_msg->ipaddr[1]) % int(rx_msg->ipaddr[0])); unit_t unit; unit.name = rx_msg->name; unit.sn = rx_msg->sn; unit.addr = addr; unit.port = port; units.push_back( unit ); } } } #ifdef USE_ASIO socket.close(ec); #else close(sock); #endif return units; } static std::string read_file(const char *filename) { std::ifstream in(filename, std::ios::in | std::ios::binary); if (in) { std::string contents; in.seekg(0, std::ios::end); contents.resize(in.tellg()); in.seekg(0, std::ios::beg); in.read(&contents[0], contents.size()); in.close(); return contents; } throw(errno); } static std::vector < unit_t > discover_sdr_iq() { std::vector < unit_t > units; int n; struct dirent **namelist; char buffer[1024]; std::vector< std::string > ftdi_sio_devices; const char* sys_prefix = "/sys/class/tty/"; n = scandir( sys_prefix, &namelist, NULL, NULL ); if ( n > 0 ) { while ( n-- ) { if ( strcmp( namelist[n]->d_name, "." ) && strcmp( namelist[n]->d_name, ".." ) ) { struct stat st; std::string device = std::string(sys_prefix) + namelist[n]->d_name; std::string device_driver = device + "/device/driver"; if ( lstat( device_driver.c_str(), &st ) == 0 && S_ISLNK(st.st_mode) ) { memset(buffer, 0, sizeof(buffer)); if ( readlink( device_driver.c_str(), buffer, sizeof(buffer) ) > 0 ) { const char *base = basename(buffer); if ( base && strcmp( base, "ftdi_sio" ) == 0 ) { ftdi_sio_devices.push_back( device ); } } } } free( namelist[n] ); } free( namelist ); } for ( size_t i = 0; i < ftdi_sio_devices.size(); i++ ) { memset(buffer, 0, sizeof(buffer)); if ( readlink( ftdi_sio_devices[i].c_str(), buffer, sizeof(buffer) ) > 0 ) { std::string path(buffer); size_t sep_pos = path.size(); for ( size_t i = 0; i < 4; i++ ) { if ( sep_pos != std::string::npos ) sep_pos--; sep_pos = path.rfind("/", sep_pos); } path = path.substr( 0, sep_pos ); size_t dev_pos = path.find("/devices"); if ( dev_pos != std::string::npos ) path = path.substr( dev_pos ); path = "/sys" + path; std::string product = read_file( (path + "/product").c_str() ); size_t pos = product.find('\n'); if ( pos != std::string::npos ) product.erase( pos ); if ( "SDR-IQ" != product ) continue; std::string serial = read_file( (path + "/serial").c_str() ); pos = serial.find('\n'); if ( pos != std::string::npos ) serial.erase( pos ); std::string port = std::string("/dev/"); const char *base = basename(buffer); if ( base ) port += base; #if 0 std::cerr << product << std::endl; std::cerr << serial << std::endl; std::cerr << port << std::endl; #endif unit_t unit; unit.name = product; unit.sn = serial; unit.addr = port; unit.port = 0; units.push_back( unit ); } } return units; } std::vector rfspace_source_c::get_devices( bool fake ) { std::vector devices; std::vector < unit_t > units = discover_netsdr(); BOOST_FOREACH( unit_t u, units ) { // std::cerr << u.name << " " << u.sn << " " << u.addr << ":" << u.port // << std::endl; std::string type = u.name; std::transform(type.begin(), type.end(), type.begin(), ::tolower); devices += str(boost::format("%s=%s:%d,label='RFSPACE %s SN %s'") % type % u.addr % u.port % u.name % u.sn); } units = discover_sdr_iq(); BOOST_FOREACH( unit_t u, units ) { // std::cerr << u.name << " " << u.sn << " " << u.addr << ":" << u.port // << std::endl; std::string type = u.name; std::transform(type.begin(), type.end(), type.begin(), ::tolower); devices += str(boost::format("%s=%s,label='RFSPACE %s SN %s'") % type % u.addr % u.name % u.sn); } if ( devices.empty() && fake ) { devices += str(boost::format("sdr-iq=%s,label='RFSPACE SDR-IQ Receiver'") % "/dev/ttyUSB0"); devices += str(boost::format("sdr-ip=%s:%d,label='RFSPACE SDR-IP Receiver'") % DEFAULT_HOST % DEFAULT_PORT); devices += str(boost::format("netsdr=%s:%d,label='RFSPACE NetSDR Receiver'") % DEFAULT_HOST % DEFAULT_PORT); } return devices; } size_t rfspace_source_c::get_num_channels() { return _nchan; } #define NETSDR_MAX_RATE 2e6 /* same for SDR-IP & NETSDR */ #define NETSDR_ADC_CLOCK 80e6 /* same for SDR-IP & NETSDR */ #define SDR_IQ_ADC_CLOCK 66666667 /* SDR-IQ 5.2.4 I/Q Data Output Sample Rate */ osmosdr::meta_range_t rfspace_source_c::get_sample_rates() { osmosdr::meta_range_t range; if ( RFSPACE_SDR_IQ == _radio ) { /* Populate fixed sample rates as per SDR-IQ 5.2.4 I/Q Data Output Sample Rate */ range += osmosdr::range_t( 8138 ); range += osmosdr::range_t( 16276 ); range += osmosdr::range_t( 37793 ); range += osmosdr::range_t( 55556 ); range += osmosdr::range_t( 111111 ); range += osmosdr::range_t( 158730 ); range += osmosdr::range_t( 196078 ); } else if ( RFSPACE_SDR_IP == _radio ) { /* Calculate SDR-IP sample rates as per SDR-IP 4.2.8 DDC Output Sample Rate */ for ( size_t decimation = 2560; decimation >= 40; decimation -= 10 ) { double rate = NETSDR_ADC_CLOCK / decimation; if ( rate > (NETSDR_MAX_RATE / _nchan) ) break; if ( floor(rate) == rate ) range += osmosdr::range_t( rate ); } } else if ( RFSPACE_NETSDR == _radio ) { /* Calculate NetSDR sample rates as per NETSDR 4.2.9 I/Q Output Data Sample Rate */ for ( size_t decimation = 2500; decimation >= 40; decimation -= 4 ) { double rate = NETSDR_ADC_CLOCK / decimation; if ( rate > (NETSDR_MAX_RATE / _nchan) ) break; if ( floor(rate) == rate ) range += osmosdr::range_t( rate ); } } return range; } double rfspace_source_c::set_sample_rate( double rate ) { if ( RFSPACE_SDR_IQ == _radio ) { /* does not support arbitrary rates, pick closest from hardcoded values above */ double closest_rate = get_sample_rates().clip( rate, true ); if ( closest_rate != rate ) std::cerr << "Picked closest supported sample rate of " << (uint32_t)closest_rate << " Hz" << std::endl; rate = closest_rate; /* override */ } /* SDR-IQ 5.2.4 I/Q Data Output Sample Rate */ /* SDR-IP 4.2.8 DDC Output Sample Rate */ /* NETSDR 4.2.9 I/Q Output Data Sample Rate */ unsigned char samprate[] = { 0x09, 0x00, 0xB8, 0x00, 0x00, 0x20, 0xA1, 0x07, 0x00 }; uint32_t u32_rate = rate; samprate[sizeof(samprate)-4] = u32_rate >> 0; samprate[sizeof(samprate)-3] = u32_rate >> 8; samprate[sizeof(samprate)-2] = u32_rate >> 16; samprate[sizeof(samprate)-1] = u32_rate >> 24; std::vector< unsigned char > response; if ( _running ) { _keep_running = true; stop(); } if ( ! transaction( samprate, sizeof(samprate), response ) ) throw std::runtime_error("set_sample_rate failed"); if ( _running ) { start(); } u32_rate = 0; u32_rate |= response[sizeof(samprate)-4] << 0; u32_rate |= response[sizeof(samprate)-3] << 8; u32_rate |= response[sizeof(samprate)-2] << 16; u32_rate |= response[sizeof(samprate)-1] << 24; _sample_rate = u32_rate; if ( rate != _sample_rate ) std::cerr << "Radio reported a sample rate of " << (uint32_t)_sample_rate << " Hz" << std::endl; return get_sample_rate(); } double rfspace_source_c::get_sample_rate() { return _sample_rate; } osmosdr::freq_range_t rfspace_source_c::get_freq_range( size_t chan ) { osmosdr::freq_range_t range; if ( RFSPACE_SDR_IQ == _radio ) { /* does not support range query, use hardcoded values */ range += osmosdr::range_t(0, SDR_IQ_ADC_CLOCK / 2.0f); return range; } /* query freq range(s) of the radio */ /* SDR-IP 4.2.2 Receiver Frequency */ /* NETSDR 4.2.3 Receiver Frequency */ unsigned char frange[] = { 0x05, 0x40, 0x20, 0x00, 0x00 }; apply_channel( frange, chan ); std::vector< unsigned char > response; transaction( frange, sizeof(frange), response ); if ( response.size() >= sizeof(frange) + 1 ) { for ( size_t i = 0; i < response[sizeof(frange)]; i++ ) { uint32_t min = *((uint32_t *)&response[sizeof(frange)+1+i*15]); uint32_t max = *((uint32_t *)&response[sizeof(frange)+1+5+i*15]); //uint32_t vco = *((uint32_t *)&response[sizeof(frange)+1+10+i*15]); //std::cerr << min << " " << max << " " << vco << std::endl; range += osmosdr::range_t(min, max); /* must be monotonic */ } } if ( range.empty() ) /* assume reasonable default */ range += osmosdr::range_t(0, NETSDR_ADC_CLOCK / 2.0f); return range; } double rfspace_source_c::set_center_freq( double freq, size_t chan ) { uint32_t u32_freq = freq; /* SDR-IQ 5.2.2 Receiver Frequency */ /* SDR-IP 4.2.2 Receiver Frequency */ /* NETSDR 4.2.3 Receiver Frequency */ unsigned char tune[] = { 0x0A, 0x00, 0x20, 0x00, 0x00, 0xb0, 0x19, 0x6d, 0x00, 0x00 }; apply_channel( tune, chan ); tune[sizeof(tune)-5] = u32_freq >> 0; tune[sizeof(tune)-4] = u32_freq >> 8; tune[sizeof(tune)-3] = u32_freq >> 16; tune[sizeof(tune)-2] = u32_freq >> 24; tune[sizeof(tune)-1] = 0; transaction( tune, sizeof(tune) ); return get_center_freq( chan ); } double rfspace_source_c::get_center_freq( size_t chan ) { /* SDR-IQ 5.2.2 Receiver Frequency */ /* SDR-IP 4.2.2 Receiver Frequency */ /* NETSDR 4.2.3 Receiver Frequency */ unsigned char freq[] = { 0x05, 0x20, 0x20, 0x00, 0x00 }; apply_channel( freq, chan ); std::vector< unsigned char > response; if ( ! transaction( freq, sizeof(freq), response ) ) throw std::runtime_error("get_center_freq failed"); uint32_t frequency = 0; frequency |= response[response.size()-5] << 0; frequency |= response[response.size()-4] << 8; frequency |= response[response.size()-3] << 16; frequency |= response[response.size()-2] << 24; return frequency; } double rfspace_source_c::set_freq_corr( double ppm, size_t chan ) { return get_freq_corr( chan ); } double rfspace_source_c::get_freq_corr( size_t chan ) { return 0; } std::vector rfspace_source_c::get_gain_names( size_t chan ) { std::vector< std::string > names; names += "ATT"; return names; } osmosdr::gain_range_t rfspace_source_c::get_gain_range( size_t chan ) { if ( RFSPACE_SDR_IQ == _radio ) return osmosdr::gain_range_t(-20, 10, 10); else /* SDR-IP & NETSDR */ return osmosdr::gain_range_t(-30, 0, 10); } osmosdr::gain_range_t rfspace_source_c::get_gain_range( const std::string & name, size_t chan ) { return get_gain_range( chan ); } bool rfspace_source_c::set_gain_mode( bool automatic, size_t chan ) { return false; } bool rfspace_source_c::get_gain_mode( size_t chan ) { return false; } double rfspace_source_c::set_gain( double gain, size_t chan ) { /* SDR-IQ 5.2.5 RF Gain */ /* SDR-IP 4.2.3 RF Gain */ /* NETSDR 4.2.6 RF Gain */ unsigned char atten[] = { 0x06, 0x00, 0x38, 0x00, 0x00, 0x00 }; apply_channel( atten, chan ); if ( RFSPACE_SDR_IQ == _radio ) { if ( gain <= -20 ) atten[sizeof(atten)-1] = 0xE2; else if ( gain <= -10 ) atten[sizeof(atten)-1] = 0xEC; else if ( gain <= 0 ) atten[sizeof(atten)-1] = 0xF6; else /* +10 dB */ atten[sizeof(atten)-1] = 0x00; } else /* SDR-IP & NETSDR */ { if ( gain <= -30 ) atten[sizeof(atten)-1] = 0xE2; else if ( gain <= -20 ) atten[sizeof(atten)-1] = 0xEC; else if ( gain <= -10 ) atten[sizeof(atten)-1] = 0xF6; else /* 0 dB */ atten[sizeof(atten)-1] = 0x00; } transaction( atten, sizeof(atten) ); return get_gain( chan ); } double rfspace_source_c::set_gain( double gain, const std::string & name, size_t chan ) { return set_gain( gain, chan ); } double rfspace_source_c::get_gain( size_t chan ) { /* SDR-IQ 5.2.5 RF Gain */ /* SDR-IP 4.2.3 RF Gain */ /* NETSDR 4.2.6 RF Gain */ unsigned char atten[] = { 0x05, 0x20, 0x38, 0x00, 0x00 }; apply_channel( atten, chan ); std::vector< unsigned char > response; if ( ! transaction( atten, sizeof(atten), response ) ) throw std::runtime_error("get_gain failed"); unsigned char code = response[response.size()-1]; double gain = code; if( code & 0x80 ) gain = (code & 0x7f) - 0x80; if ( RFSPACE_SDR_IQ == _radio ) gain += 10; return gain; } double rfspace_source_c::get_gain( const std::string & name, size_t chan ) { return get_gain( chan ); } std::vector< std::string > rfspace_source_c::get_antennas( size_t chan ) { std::vector< std::string > antennas; antennas += get_antenna( chan ); return antennas; } std::string rfspace_source_c::set_antenna( const std::string & antenna, size_t chan ) { return get_antenna( chan ); } std::string rfspace_source_c::get_antenna( size_t chan ) { /* We only have a single receive antenna here */ return "RX"; } #define BANDWIDTH 34e6 double rfspace_source_c::set_bandwidth( double bandwidth, size_t chan ) { if ( RFSPACE_SDR_IQ == _radio ) /* not supported by SDR-IQ */ return 0.0f; /* SDR-IP 4.2.5 RF Filter Selection */ /* NETSDR 4.2.7 RF Filter Selection */ unsigned char filter[] = { 0x06, 0x00, 0x44, 0x00, 0x00, 0x00 }; apply_channel( filter, chan ); if ( 0.0f == bandwidth ) { _bandwidth = 0.0f; filter[sizeof(filter)-1] = 0x00; /* Select bandpass filter based on NCO frequency */ } else if ( BANDWIDTH == bandwidth ) { _bandwidth = BANDWIDTH; filter[sizeof(filter)-1] = 0x0B; /* Bypass bandpass filter, use only antialiasing */ } transaction( filter, sizeof(filter) ); return get_bandwidth(); } double rfspace_source_c::get_bandwidth( size_t chan ) { return _bandwidth; } osmosdr::freq_range_t rfspace_source_c::get_bandwidth_range( size_t chan ) { osmosdr::freq_range_t bandwidths; bandwidths += osmosdr::range_t( BANDWIDTH ); return bandwidths; } gr-osmosdr-0.1.0.55.80c4af/lib/rfspace/rfspace_source_c.h000066400000000000000000000121041225753723100226740ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_RFSPACE_SOURCE_C_H #define INCLUDED_RFSPACE_SOURCE_C_H //#define USE_ASIO #ifdef USE_ASIO #include #endif #include #include #include #include #include #include #include "osmosdr/ranges.h" #include "source_iface.h" #ifdef USE_ASIO using boost::asio::ip::tcp; using boost::asio::ip::udp; #endif class rfspace_source_c; #ifndef SOCKET #define SOCKET int #endif /* * We use boost::shared_ptr's instead of raw pointers for all access * to gr_blocks (and many other data structures). The shared_ptr gets * us transparent reference counting, which greatly simplifies storage * management issues. This is especially helpful in our hybrid * C++ / Python system. * * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm * * As a convention, the _sptr suffix indicates a boost::shared_ptr */ typedef boost::shared_ptr rfspace_source_c_sptr; /*! * \brief Return a shared_ptr to a new instance of rfspace_source_c. * * To avoid accidental use of raw pointers, rfspace_source_c's * constructor is private. rfspace_make_source_c is the public * interface for creating new instances. */ rfspace_source_c_sptr make_rfspace_source_c (const std::string & args = ""); class rfspace_source_c : public gr::sync_block, public source_iface { private: // The friend declaration allows rfspace_make_source_c to // access the private constructor. friend rfspace_source_c_sptr make_rfspace_source_c (const std::string & args); rfspace_source_c (const std::string & args); // private constructor public: ~rfspace_source_c (); // public destructor bool start(); bool stop(); int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ); static std::vector< std::string > get_devices( bool fake = false ); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); bool set_gain_mode( bool automatic, size_t chan = 0 ); bool get_gain_mode( size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); double set_bandwidth( double bandwidth, size_t chan = 0 ); double get_bandwidth( size_t chan = 0 ); osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ); private: /* functions */ void apply_channel( unsigned char *cmd, size_t chan = 0 ); bool transaction( const unsigned char *cmd, size_t size ); bool transaction( const unsigned char *cmd, size_t size, std::vector< unsigned char > &response ); void usb_read_task(); private: /* members */ enum radio_type { RADIO_UNKNOWN = 0, RFSPACE_SDR_IQ, RFSPACE_SDR_IP, RFSPACE_NETSDR }; radio_type _radio; #ifdef USE_ASIO boost::asio::io_service _io_service; tcp::resolver _resolver; tcp::socket _t; udp::socket _u; #else SOCKET _tcp; SOCKET _udp; #endif int _usb; bool _running; bool _keep_running; uint16_t _sequence; size_t _nchan; double _sample_rate; double _bandwidth; gr::thread::thread _thread; bool _run_usb_read_task; boost::circular_buffer *_fifo; boost::mutex _fifo_lock; boost::condition_variable _samp_avail; std::vector< unsigned char > _resp; boost::mutex _resp_lock; boost::condition_variable _resp_avail; }; #endif /* INCLUDED_RFSPACE_SOURCE_C_H */ gr-osmosdr-0.1.0.55.80c4af/lib/rtl/000077500000000000000000000000001225753723100163765ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/lib/rtl/CMakeLists.txt000066400000000000000000000026021225753723100211360ustar00rootroot00000000000000# Copyright 2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # This file included, use CMake directory variables ######################################################################## include_directories( ${CMAKE_CURRENT_SOURCE_DIR} ${LIBRTLSDR_INCLUDE_DIRS} ) set(rtl_srcs ${CMAKE_CURRENT_SOURCE_DIR}/rtl_source_c.cc ) ######################################################################## # Append gnuradio-osmosdr library sources ######################################################################## list(APPEND gr_osmosdr_srcs ${rtl_srcs}) list(APPEND gr_osmosdr_libs ${LIBRTLSDR_LIBRARIES}) gr-osmosdr-0.1.0.55.80c4af/lib/rtl/rtl_source_c.cc000066400000000000000000000431521225753723100213750ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ /* * config.h is generated by configure. It contains the results * of probing for features, options etc. It should be the first * file included in your .cc file. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "rtl_source_c.h" #include #include #include #include #include #include #include #include #include #include "arg_helpers.h" using namespace boost::assign; #define BUF_LEN (16 * 32 * 512) /* must be multiple of 512 */ #define BUF_NUM 32 #define BUF_SKIP 1 // buffers to skip due to initial garbage #define BYTES_PER_SAMPLE 2 // rtl device delivers 8 bit unsigned IQ data /* * Create a new instance of rtl_source_c and return * a boost shared_ptr. This is effectively the public constructor. */ rtl_source_c_sptr make_rtl_source_c (const std::string &args) { return gnuradio::get_initial_sptr(new rtl_source_c (args)); } /* * Specify constraints on number of input and output streams. * This info is used to construct the input and output signatures * (2nd & 3rd args to gr::block's constructor). The input and * output signatures are used by the runtime system to * check that a valid number and type of inputs and outputs * are connected to this block. In this case, we accept * only 0 input and 1 output. */ static const int MIN_IN = 0; // mininum number of input streams static const int MAX_IN = 0; // maximum number of input streams static const int MIN_OUT = 1; // minimum number of output streams static const int MAX_OUT = 1; // maximum number of output streams /* * The private constructor */ rtl_source_c::rtl_source_c (const std::string &args) : gr::sync_block ("rtl_source_c", gr::io_signature::make(MIN_IN, MAX_IN, sizeof (gr_complex)), gr::io_signature::make(MIN_OUT, MAX_OUT, sizeof (gr_complex))), _dev(NULL), _buf(NULL), _running(true), _no_tuner(false), _auto_gain(false), _if_gain(0), _skipped(0) { int ret; int index; unsigned int dev_index = 0, rtl_freq = 0, tuner_freq = 0, direct_samp = 0; unsigned int offset_tune = 0; char manufact[256]; char product[256]; char serial[256]; dict_t dict = params_to_dict(args); if (dict.count("rtl")) { std::string value = dict["rtl"]; if ( (index = rtlsdr_get_index_by_serial( value.c_str() )) >= 0 ) { dev_index = index; /* use the resolved index value */ } else { /* use the numeric value of the argument */ if ( value.length() ) { try { dev_index = boost::lexical_cast< unsigned int >( value ); } catch ( std::exception &ex ) { throw std::runtime_error( "Failed to use '" + value + "' as index: " + ex.what()); } } } } if ( dev_index >= rtlsdr_get_device_count() ) throw std::runtime_error("Wrong rtlsdr device index given."); std::cerr << "Using device #" << dev_index; memset(manufact, 0, sizeof(manufact)); memset(product, 0, sizeof(product)); memset(serial, 0, sizeof(serial)); if ( !rtlsdr_get_device_usb_strings( dev_index, manufact, product, serial ) ) { if (strlen(manufact)) std::cerr << " " << manufact; if (strlen(product)) std::cerr << " " << product; if (strlen(serial)) std::cerr << " SN: " << serial; } else { std::cerr << " " << rtlsdr_get_device_name(dev_index); } std::cerr << std::endl; if (dict.count("rtl_xtal")) rtl_freq = (unsigned int)boost::lexical_cast< double >( dict["rtl_xtal"] ); if (dict.count("tuner_xtal")) tuner_freq = (unsigned int)boost::lexical_cast< double >( dict["tuner_xtal"] ); if (dict.count("direct_samp")) direct_samp = boost::lexical_cast< unsigned int >( dict["direct_samp"] ); if (dict.count("offset_tune")) offset_tune = boost::lexical_cast< unsigned int >( dict["offset_tune"] ); _buf_num = _buf_len = _buf_head = _buf_used = _buf_offset = 0; if (dict.count("buffers")) _buf_num = boost::lexical_cast< unsigned int >( dict["buffers"] ); if (dict.count("buflen")) _buf_len = boost::lexical_cast< unsigned int >( dict["buflen"] ); if (0 == _buf_num) _buf_num = BUF_NUM; if (0 == _buf_len || _buf_len % 512 != 0) /* len must be multiple of 512 */ _buf_len = BUF_LEN; if ( BUF_NUM != _buf_num || BUF_LEN != _buf_len ) { std::cerr << "Using " << _buf_num << " buffers of size " << _buf_len << "." << std::endl; } _samp_avail = _buf_len / BYTES_PER_SAMPLE; // create a lookup table for gr_complex values for (unsigned int i = 0; i <= 0xffff; i++) { #ifdef BOOST_LITTLE_ENDIAN _lut.push_back( gr_complex( (float(i & 0xff) - 127.4f) * (1.0f/128.0f), (float(i >> 8) - 127.4f) * (1.0f/128.0f) ) ); #else // BOOST_BIG_ENDIAN _lut.push_back( gr_complex( (float(i >> 8) - 127.4f) * (1.0f/128.0f), (float(i & 0xff) - 127.4f) * (1.0f/128.0f) ) ); #endif } _dev = NULL; ret = rtlsdr_open( &_dev, dev_index ); if (ret < 0) throw std::runtime_error("Failed to open rtlsdr device."); if (rtl_freq > 0 || tuner_freq > 0) { if (rtl_freq) std::cerr << "Setting rtl clock to " << rtl_freq << " Hz." << std::endl; if (tuner_freq) std::cerr << "Setting tuner clock to " << tuner_freq << " Hz." << std::endl; ret = rtlsdr_set_xtal_freq( _dev, rtl_freq, tuner_freq ); if (ret < 0) throw std::runtime_error( str(boost::format("Failed to set xtal frequencies. Error %d.") % ret )); } ret = rtlsdr_set_sample_rate( _dev, 1024000 ); if (ret < 0) throw std::runtime_error("Failed to set default samplerate."); ret = rtlsdr_set_tuner_gain_mode(_dev, int(!_auto_gain)); if (ret < 0) throw std::runtime_error("Failed to set tuner gain mode."); ret = rtlsdr_set_agc_mode(_dev, int(_auto_gain)); if (ret < 0) throw std::runtime_error("Failed to set agc mode."); if (direct_samp) { ret = rtlsdr_set_direct_sampling(_dev, direct_samp); if (ret < 0) throw std::runtime_error("Failed to enable direct sampling."); _no_tuner = true; } if (offset_tune) { ret = rtlsdr_set_offset_tuning(_dev, offset_tune); if (ret < 0) throw std::runtime_error("Failed to enable offset tuning."); } ret = rtlsdr_reset_buffer( _dev ); if (ret < 0) throw std::runtime_error("Failed to reset usb buffers."); set_if_gain( 24 ); /* preset to a reasonable default (non-GRC use case) */ _buf = (unsigned short **) malloc(_buf_num * sizeof(unsigned short *)); if (_buf) { for(unsigned int i = 0; i < _buf_num; ++i) _buf[i] = (unsigned short *) malloc(_buf_len); } _thread = gr::thread::thread(_rtlsdr_wait, this); } /* * Our virtual destructor. */ rtl_source_c::~rtl_source_c () { if (_dev) { _running = false; rtlsdr_cancel_async( _dev ); _thread.join(); rtlsdr_close( _dev ); _dev = NULL; } if (_buf) { for(unsigned int i = 0; i < _buf_num; ++i) { if (_buf[i]) free(_buf[i]); } free(_buf); _buf = NULL; } } void rtl_source_c::_rtlsdr_callback(unsigned char *buf, uint32_t len, void *ctx) { rtl_source_c *obj = (rtl_source_c *)ctx; obj->rtlsdr_callback(buf, len); } void rtl_source_c::rtlsdr_callback(unsigned char *buf, uint32_t len) { if (_skipped < BUF_SKIP) { _skipped++; return; } { boost::mutex::scoped_lock lock( _buf_mutex ); int buf_tail = (_buf_head + _buf_used) % _buf_num; memcpy(_buf[buf_tail], buf, len); if (_buf_used == _buf_num) { std::cerr << "O" << std::flush; _buf_head = (_buf_head + 1) % _buf_num; } else { _buf_used++; } } _buf_cond.notify_one(); } void rtl_source_c::_rtlsdr_wait(rtl_source_c *obj) { obj->rtlsdr_wait(); } void rtl_source_c::rtlsdr_wait() { int ret = rtlsdr_read_async( _dev, _rtlsdr_callback, (void *)this, 0, _buf_len ); _running = false; if ( ret != 0 ) std::cerr << "rtlsdr_read_async returned with " << ret << std::endl; _buf_cond.notify_one(); } int rtl_source_c::work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ) { gr_complex *out = (gr_complex *)output_items[0]; { boost::mutex::scoped_lock lock( _buf_mutex ); while (_buf_used < 3 && _running) // collect at least 3 buffers _buf_cond.wait( lock ); } if (!_running) return WORK_DONE; unsigned short *buf = _buf[_buf_head] + _buf_offset; if (noutput_items <= _samp_avail) { for (int i = 0; i < noutput_items; ++i) *out++ = _lut[ *(buf + i) ]; _buf_offset += noutput_items; _samp_avail -= noutput_items; } else { for (int i = 0; i < _samp_avail; ++i) *out++ = _lut[ *(buf + i) ]; { boost::mutex::scoped_lock lock( _buf_mutex ); _buf_head = (_buf_head + 1) % _buf_num; _buf_used--; } buf = _buf[_buf_head]; int remaining = noutput_items - _samp_avail; for (int i = 0; i < remaining; ++i) *out++ = _lut[ *(buf + i) ]; _buf_offset = remaining; _samp_avail = (_buf_len / BYTES_PER_SAMPLE) - remaining; } return noutput_items; } std::vector rtl_source_c::get_devices() { std::vector devices; std::string label; char manufact[256]; char product[256]; char serial[256]; for (unsigned int i = 0; i < rtlsdr_get_device_count(); i++) { std::string args = "rtl=" + boost::lexical_cast< std::string >( i ); label.clear(); memset(manufact, 0, sizeof(manufact)); memset(product, 0, sizeof(product)); memset(serial, 0, sizeof(serial)); if ( !rtlsdr_get_device_usb_strings( i, manufact, product, serial ) ) { if (strlen(manufact)) label += std::string(manufact) + " "; if (strlen(product)) label += std::string(product) + " "; if (strlen(serial)) label += "SN: " + std::string(serial) + " "; } else { label = std::string(rtlsdr_get_device_name(i)); } boost::algorithm::trim(label); args += ",label='" + label + "'"; devices.push_back( args ); } return devices; } size_t rtl_source_c::get_num_channels() { return 1; } osmosdr::meta_range_t rtl_source_c::get_sample_rates() { osmosdr::meta_range_t range; range += osmosdr::range_t( 250000 ); // known to work range += osmosdr::range_t( 1000000 ); // known to work range += osmosdr::range_t( 1024000 ); // known to work range += osmosdr::range_t( 1800000 ); // known to work range += osmosdr::range_t( 1920000 ); // known to work range += osmosdr::range_t( 2000000 ); // known to work range += osmosdr::range_t( 2048000 ); // known to work range += osmosdr::range_t( 2400000 ); // known to work range += osmosdr::range_t( 2560000 ); // known to work // range += osmosdr::range_t( 2600000 ); // may work // range += osmosdr::range_t( 2800000 ); // may work // range += osmosdr::range_t( 3000000 ); // may work // range += osmosdr::range_t( 3200000 ); // max rate return range; } double rtl_source_c::set_sample_rate(double rate) { if (_dev) { rtlsdr_set_sample_rate( _dev, (uint32_t)rate ); } return get_sample_rate(); } double rtl_source_c::get_sample_rate() { if (_dev) return (double)rtlsdr_get_sample_rate( _dev ); return 0; } osmosdr::freq_range_t rtl_source_c::get_freq_range( size_t chan ) { osmosdr::freq_range_t range; if (_dev) { if (_no_tuner) { uint32_t rtl_freq; if ( !rtlsdr_get_xtal_freq( _dev, &rtl_freq, NULL ) ) range += osmosdr::range_t( 0, double(rtl_freq) ); return range; } enum rtlsdr_tuner tuner = rtlsdr_get_tuner_type(_dev); if ( tuner == RTLSDR_TUNER_E4000 ) { /* there is a (temperature dependent) gap between 1100 to 1250 MHz */ range += osmosdr::range_t( 52e6, 2.2e9 ); } else if ( tuner == RTLSDR_TUNER_FC0012 ) { range += osmosdr::range_t( 22e6, 948e6 ); } else if ( tuner == RTLSDR_TUNER_FC0013 ) { range += osmosdr::range_t( 22e6, 1.1e9 ); } else if ( tuner == RTLSDR_TUNER_FC2580 ) { range += osmosdr::range_t( 146e6, 308e6 ); range += osmosdr::range_t( 438e6, 924e6 ); } else if ( tuner == RTLSDR_TUNER_R820T ) { range += osmosdr::range_t( 24e6, 1766e6 ); } else if ( tuner == RTLSDR_TUNER_R828D ) { range += osmosdr::range_t( 24e6, 1766e6 ); } } return range; } double rtl_source_c::set_center_freq( double freq, size_t chan ) { if (_dev) rtlsdr_set_center_freq( _dev, (uint32_t)freq ); return get_center_freq( chan ); } double rtl_source_c::get_center_freq( size_t chan ) { if (_dev) return (double)rtlsdr_get_center_freq( _dev ); return 0; } double rtl_source_c::set_freq_corr( double ppm, size_t chan ) { if ( _dev ) rtlsdr_set_freq_correction( _dev, (int)ppm ); return get_freq_corr( chan ); } double rtl_source_c::get_freq_corr( size_t chan ) { if ( _dev ) return (double)rtlsdr_get_freq_correction( _dev ); return 0; } std::vector rtl_source_c::get_gain_names( size_t chan ) { std::vector< std::string > names; names += "LNA"; if ( _dev ) { if ( rtlsdr_get_tuner_type(_dev) == RTLSDR_TUNER_E4000 ) { names += "IF"; } } return names; } osmosdr::gain_range_t rtl_source_c::get_gain_range( size_t chan ) { osmosdr::gain_range_t range; if (_dev) { int count = rtlsdr_get_tuner_gains(_dev, NULL); if (count > 0) { int* gains = new int[ count ]; count = rtlsdr_get_tuner_gains(_dev, gains); for (int i = 0; i < count; i++) range += osmosdr::range_t( gains[i] / 10.0 ); delete[] gains; } } return range; } osmosdr::gain_range_t rtl_source_c::get_gain_range( const std::string & name, size_t chan ) { if ( "IF" == name ) { if ( _dev ) { if ( rtlsdr_get_tuner_type(_dev) == RTLSDR_TUNER_E4000 ) { return osmosdr::gain_range_t(3, 56, 1); } else { return osmosdr::gain_range_t(); } } } return get_gain_range( chan ); } bool rtl_source_c::set_gain_mode( bool automatic, size_t chan ) { if (_dev) { if (!rtlsdr_set_tuner_gain_mode(_dev, int(!automatic))) { _auto_gain = automatic; } rtlsdr_set_agc_mode(_dev, int(automatic)); } return get_gain_mode(chan); } bool rtl_source_c::get_gain_mode( size_t chan ) { return _auto_gain; } double rtl_source_c::set_gain( double gain, size_t chan ) { osmosdr::gain_range_t rf_gains = rtl_source_c::get_gain_range( chan ); if (_dev) { rtlsdr_set_tuner_gain( _dev, int(rf_gains.clip(gain) * 10.0) ); } return get_gain( chan ); } double rtl_source_c::set_gain( double gain, const std::string & name, size_t chan) { if ( "IF" == name ) { return set_if_gain( gain, chan ); } return set_gain( gain, chan ); } double rtl_source_c::get_gain( size_t chan ) { if ( _dev ) return ((double)rtlsdr_get_tuner_gain( _dev )) / 10.0; return 0; } double rtl_source_c::get_gain( const std::string & name, size_t chan ) { if ( "IF" == name ) { return _if_gain; } return get_gain( chan ); } double rtl_source_c::set_if_gain(double gain, size_t chan) { if ( _dev ) { if ( rtlsdr_get_tuner_type(_dev) != RTLSDR_TUNER_E4000 ) { _if_gain = 0; return _if_gain; } } std::vector< osmosdr::gain_range_t > if_gains; if_gains += osmosdr::gain_range_t(-3, 6, 9); if_gains += osmosdr::gain_range_t(0, 9, 3); if_gains += osmosdr::gain_range_t(0, 9, 3); if_gains += osmosdr::gain_range_t(0, 2, 1); if_gains += osmosdr::gain_range_t(3, 15, 3); if_gains += osmosdr::gain_range_t(3, 15, 3); std::map< int, double > gains; /* initialize with min gains */ for (unsigned int i = 0; i < if_gains.size(); i++) { gains[ i + 1 ] = if_gains[ i ].start(); } for (int i = if_gains.size() - 1; i >= 0; i--) { osmosdr::gain_range_t range = if_gains[ i ]; double error = gain; for( double g = range.start(); g <= range.stop(); g += range.step() ) { double sum = 0; for (int j = 0; j < int(gains.size()); j++) { if ( i == j ) sum += g; else sum += gains[ j + 1 ]; } double err = abs(gain - sum); if (err < error) { error = err; gains[ i + 1 ] = g; } } } #if 0 std::cerr << gain << " => "; double sum = 0; for (unsigned int i = 0; i < gains.size(); i++) { sum += gains[ i + 1 ]; std::cerr << gains[ i + 1 ] << " "; } std::cerr << " = " << sum << std::endl; #endif if (_dev) { for (unsigned int stage = 1; stage <= gains.size(); stage++) { rtlsdr_set_tuner_if_gain( _dev, stage, int(gains[ stage ] * 10.0)); } } _if_gain = gain; return gain; } std::vector< std::string > rtl_source_c::get_antennas( size_t chan ) { std::vector< std::string > antennas; antennas += get_antenna( chan ); return antennas; } std::string rtl_source_c::set_antenna( const std::string & antenna, size_t chan ) { return get_antenna( chan ); } std::string rtl_source_c::get_antenna( size_t chan ) { return "RX"; } gr-osmosdr-0.1.0.55.80c4af/lib/rtl/rtl_source_c.h000066400000000000000000000106411225753723100212340ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * This file is part of GNU Radio * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_RTLSDR_SOURCE_C_H #define INCLUDED_RTLSDR_SOURCE_C_H #include #include #include #include #include "source_iface.h" class rtl_source_c; typedef struct rtlsdr_dev rtlsdr_dev_t; /* * We use boost::shared_ptr's instead of raw pointers for all access * to gr::blocks (and many other data structures). The shared_ptr gets * us transparent reference counting, which greatly simplifies storage * management issues. This is especially helpful in our hybrid * C++ / Python system. * * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm * * As a convention, the _sptr suffix indicates a boost::shared_ptr */ typedef boost::shared_ptr rtl_source_c_sptr; /*! * \brief Return a shared_ptr to a new instance of rtl_source_c. * * To avoid accidental use of raw pointers, rtl_source_c's * constructor is private. make_rtl_source_c is the public * interface for creating new instances. */ rtl_source_c_sptr make_rtl_source_c (const std::string & args = ""); /*! * \brief Provides a stream of complex samples. * \ingroup block * */ class rtl_source_c : public gr::sync_block, public source_iface { private: // The friend declaration allows make_rtl_source_c to // access the private constructor. friend rtl_source_c_sptr make_rtl_source_c (const std::string & args); /*! * \brief Provides a stream of complex samples. */ rtl_source_c (const std::string & args); // private constructor public: ~rtl_source_c (); // public destructor int work( int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items ); static std::vector< std::string > get_devices(); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); bool set_gain_mode( bool automatic, size_t chan = 0 ); bool get_gain_mode( size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); double set_if_gain( double gain, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); private: static void _rtlsdr_callback(unsigned char *buf, uint32_t len, void *ctx); void rtlsdr_callback(unsigned char *buf, uint32_t len); static void _rtlsdr_wait(rtl_source_c *obj); void rtlsdr_wait(); std::vector _lut; rtlsdr_dev_t *_dev; gr::thread::thread _thread; unsigned short **_buf; unsigned int _buf_num; unsigned int _buf_len; unsigned int _buf_head; unsigned int _buf_used; boost::mutex _buf_mutex; boost::condition_variable _buf_cond; bool _running; unsigned int _buf_offset; int _samp_avail; bool _no_tuner; bool _auto_gain; double _if_gain; unsigned int _skipped; }; #endif /* INCLUDED_RTLSDR_SOURCE_C_H */ gr-osmosdr-0.1.0.55.80c4af/lib/rtl_tcp/000077500000000000000000000000001225753723100172445ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/lib/rtl_tcp/CMakeLists.txt000066400000000000000000000026521225753723100220110ustar00rootroot00000000000000# Copyright 2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # This file included, use CMake directory variables ######################################################################## include_directories( ${CMAKE_CURRENT_SOURCE_DIR} ) set(rtl_tcp_srcs ${CMAKE_CURRENT_SOURCE_DIR}/rtl_tcp_source_f.cc ${CMAKE_CURRENT_SOURCE_DIR}/rtl_tcp_source_c.cc ) ######################################################################## # Append gnuradio-osmosdr library sources ######################################################################## list(APPEND gr_osmosdr_srcs ${rtl_tcp_srcs}) list(APPEND gr_osmosdr_libs ${GNURADIO_BLOCKS_LIBRARIES}) gr-osmosdr-0.1.0.55.80c4af/lib/rtl_tcp/rtl_tcp_source_c.cc000066400000000000000000000301771225753723100231140ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #include #include #include #include #include #include #include #include #include "rtl_tcp_source_c.h" #include "arg_helpers.h" using namespace boost::assign; static std::string get_tuner_name( enum rtlsdr_tuner tuner_type ) { if ( RTLSDR_TUNER_E4000 == tuner_type ) return "E4000"; else if ( RTLSDR_TUNER_FC0012 == tuner_type ) return "FC0012"; else if ( RTLSDR_TUNER_FC0013 == tuner_type ) return "FC0013"; else if ( RTLSDR_TUNER_FC2580 == tuner_type ) return "FC2580"; else if ( RTLSDR_TUNER_R820T == tuner_type ) return "R820T"; else if ( RTLSDR_TUNER_R828D == tuner_type ) return "R828D"; else return "Unknown"; } rtl_tcp_source_c_sptr make_rtl_tcp_source_c(const std::string &args) { return gnuradio::get_initial_sptr(new rtl_tcp_source_c(args)); } rtl_tcp_source_c::rtl_tcp_source_c(const std::string &args) : gr::hier_block2("rtl_tcp_source_c", gr::io_signature::make(0, 0, 0), gr::io_signature::make(1, 1, sizeof (gr_complex))), _no_tuner(false), _auto_gain(false), _if_gain(0) { std::string host = "127.0.0.1"; unsigned short port = 1234; int payload_size = 16384; unsigned int direct_samp = 0, offset_tune = 0; _freq = 0; _rate = 0; _gain = 0; _corr = 0; dict_t dict = params_to_dict(args); if (dict.count("rtl_tcp")) { std::vector< std::string > tokens; boost::algorithm::split( tokens, dict["rtl_tcp"], boost::is_any_of(":") ); if ( tokens[0].length() && (tokens.size() == 1 || tokens.size() == 2 ) ) host = tokens[0]; if ( tokens.size() == 2 ) // port given port = boost::lexical_cast< unsigned short >( tokens[1] ); } if (dict.count("psize")) payload_size = boost::lexical_cast< int >( dict["psize"] ); if (dict.count("direct_samp")) direct_samp = boost::lexical_cast< unsigned int >( dict["direct_samp"] ); if (dict.count("offset_tune")) offset_tune = boost::lexical_cast< unsigned int >( dict["offset_tune"] ); if (!host.length()) host = "127.0.0.1"; if (0 == port) port = 1234; if (payload_size <= 0) payload_size = 16384; _src = make_rtl_tcp_source_f(sizeof(float), host.c_str(), port, payload_size); if ( _src->get_tuner_type() != RTLSDR_TUNER_UNKNOWN ) { std::cerr << "The RTL TCP server reports a " << get_tuner_name( _src->get_tuner_type() ) << " tuner with " << _src->get_tuner_gain_count() << " RF and " << _src->get_tuner_if_gain_count() << " IF gains." << std::endl; } set_gain_mode(false); /* enable manual gain mode by default */ _src->set_direct_sampling(direct_samp); if (direct_samp) { _no_tuner = true; } _src->set_offset_tuning(offset_tune); /* rtl tcp source provides a stream of interleaved IQ floats */ gr::blocks::deinterleave::sptr deinterleave = \ gr::blocks::deinterleave::make( sizeof(float) ); /* block to convert deinterleaved floats to a complex stream */ gr::blocks::float_to_complex::sptr f2c = \ gr::blocks::float_to_complex::make( 1 ); connect(_src, 0, deinterleave, 0); connect(deinterleave, 0, f2c, 0); /* I */ connect(deinterleave, 1, f2c, 1); /* Q */ connect(f2c, 0, self(), 0); } rtl_tcp_source_c::~rtl_tcp_source_c() { } std::string rtl_tcp_source_c::name() { return "RTL TCP Client"; } std::vector rtl_tcp_source_c::get_devices( bool fake ) { std::vector devices; if ( fake ) { std::string args = "rtl_tcp=localhost:1234"; args += ",label='RTL-SDR Spectrum Server'"; devices.push_back( args ); } return devices; } size_t rtl_tcp_source_c::get_num_channels( void ) { return 1; } osmosdr::meta_range_t rtl_tcp_source_c::get_sample_rates( void ) { osmosdr::meta_range_t range; range += osmosdr::range_t( 250000 ); // known to work range += osmosdr::range_t( 1000000 ); // known to work range += osmosdr::range_t( 1024000 ); // known to work range += osmosdr::range_t( 1800000 ); // known to work range += osmosdr::range_t( 1920000 ); // known to work range += osmosdr::range_t( 2000000 ); // known to work range += osmosdr::range_t( 2048000 ); // known to work range += osmosdr::range_t( 2400000 ); // known to work range += osmosdr::range_t( 2560000 ); // known to work // range += osmosdr::range_t( 2600000 ); // may work // range += osmosdr::range_t( 2800000 ); // may work // range += osmosdr::range_t( 3000000 ); // may work // range += osmosdr::range_t( 3200000 ); // max rate return range; } double rtl_tcp_source_c::set_sample_rate( double rate ) { _src->set_sample_rate( int(rate) ); _rate = rate; return get_sample_rate(); } double rtl_tcp_source_c::get_sample_rate( void ) { return _rate; } osmosdr::freq_range_t rtl_tcp_source_c::get_freq_range( size_t chan ) { osmosdr::freq_range_t range; if (_no_tuner) { range += osmosdr::range_t( 0, double(28.8e6) ); // as far as we know return range; } enum rtlsdr_tuner tuner = _src->get_tuner_type(); if ( tuner == RTLSDR_TUNER_E4000 ) { /* there is a (temperature dependent) gap between 1100 to 1250 MHz */ range += osmosdr::range_t( 52e6, 2.2e9 ); } else if ( tuner == RTLSDR_TUNER_FC0012 ) { range += osmosdr::range_t( 22e6, 948e6 ); } else if ( tuner == RTLSDR_TUNER_FC0013 ) { range += osmosdr::range_t( 22e6, 1.1e9 ); } else if ( tuner == RTLSDR_TUNER_FC2580 ) { range += osmosdr::range_t( 146e6, 308e6 ); range += osmosdr::range_t( 438e6, 924e6 ); } else if ( tuner == RTLSDR_TUNER_R820T ) { range += osmosdr::range_t( 24e6, 1766e6 ); } else if ( tuner == RTLSDR_TUNER_R828D ) { range += osmosdr::range_t( 24e6, 1766e6 ); } else { range += osmosdr::range_t( 52e6, 2.2e9 ); // assume E4000 tuner } return range; } double rtl_tcp_source_c::set_center_freq( double freq, size_t chan ) { _src->set_freq( int(freq) ); _freq = freq; return get_center_freq(chan); } double rtl_tcp_source_c::get_center_freq( size_t chan ) { return _freq; } double rtl_tcp_source_c::set_freq_corr( double ppm, size_t chan ) { _src->set_freq_corr( int(ppm) ); _corr = ppm; return get_freq_corr( chan ); } double rtl_tcp_source_c::get_freq_corr( size_t chan ) { return _corr; } std::vector rtl_tcp_source_c::get_gain_names( size_t chan ) { std::vector< std::string > names; names += "LNA"; if ( _src->get_tuner_type() == RTLSDR_TUNER_E4000 ) { names += "IF"; } return names; } osmosdr::gain_range_t rtl_tcp_source_c::get_gain_range( size_t chan ) { osmosdr::gain_range_t range; /* the following gain values have been copied from librtlsdr */ /* all gain values are expressed in tenths of a dB */ const int e4k_gains[] = { -10, 15, 40, 65, 90, 115, 140, 165, 190, 215, 240, 290, 340, 420 }; const int fc0012_gains[] = { -99, -40, 71, 179, 192 }; const int fc0013_gains[] = { -99, -73, -65, -63, -60, -58, -54, 58, 61, 63, 65, 67, 68, 70, 71, 179, 181, 182, 184, 186, 188, 191, 197 }; const int fc2580_gains[] = { 0 /* no gain values */ }; const int r820t_gains[] = { 0, 9, 14, 27, 37, 77, 87, 125, 144, 157, 166, 197, 207, 229, 254, 280, 297, 328, 338, 364, 372, 386, 402, 421, 434, 439, 445, 480, 496 }; const int unknown_gains[] = { 0 /* no gain values */ }; const int *ptr = NULL; int len = 0; switch (_src->get_tuner_type()) { case RTLSDR_TUNER_E4000: ptr = e4k_gains; len = sizeof(e4k_gains); break; case RTLSDR_TUNER_FC0012: ptr = fc0012_gains; len = sizeof(fc0012_gains); break; case RTLSDR_TUNER_FC0013: ptr = fc0013_gains; len = sizeof(fc0013_gains); break; case RTLSDR_TUNER_FC2580: ptr = fc2580_gains; len = sizeof(fc2580_gains); break; case RTLSDR_TUNER_R820T: ptr = r820t_gains; len = sizeof(r820t_gains); break; default: ptr = unknown_gains; len = sizeof(unknown_gains); break; } if ( ptr != NULL && len > 0 ) { for (int i = 0; i < int(len / sizeof(int)); i++) range += osmosdr::range_t( ptr[i] / 10.0f ); } return range; } osmosdr::gain_range_t rtl_tcp_source_c::get_gain_range( const std::string & name, size_t chan ) { if ( "IF" == name ) { if ( _src->get_tuner_type() == RTLSDR_TUNER_E4000 ) { return osmosdr::gain_range_t(3, 56, 1); } else { return osmosdr::gain_range_t(); } } return get_gain_range( chan ); } bool rtl_tcp_source_c::set_gain_mode( bool automatic, size_t chan ) { _src->set_gain_mode(int(!automatic)); _src->set_agc_mode(automatic); _auto_gain = automatic; return get_gain_mode(chan); } bool rtl_tcp_source_c::get_gain_mode( size_t chan ) { return _auto_gain; } double rtl_tcp_source_c::set_gain( double gain, size_t chan ) { osmosdr::gain_range_t gains = rtl_tcp_source_c::get_gain_range( chan ); _src->set_gain( int(gains.clip(gain) * 10.0) ); _gain = gain; return get_gain(chan); } double rtl_tcp_source_c::set_gain( double gain, const std::string & name, size_t chan ) { if ( "IF" == name ) { return set_if_gain( gain, chan ); } return set_gain( gain, chan ); } double rtl_tcp_source_c::get_gain( size_t chan ) { return 0; } double rtl_tcp_source_c::get_gain( const std::string & name, size_t chan ) { if ( "IF" == name ) { return _if_gain; } return get_gain( chan ); } double rtl_tcp_source_c::set_if_gain(double gain, size_t chan) { if ( _src->get_tuner_type() != RTLSDR_TUNER_E4000 ) { _if_gain = 0; return _if_gain; } std::vector< osmosdr::gain_range_t > if_gains; if_gains += osmosdr::gain_range_t(-3, 6, 9); if_gains += osmosdr::gain_range_t(0, 9, 3); if_gains += osmosdr::gain_range_t(0, 9, 3); if_gains += osmosdr::gain_range_t(0, 2, 1); if_gains += osmosdr::gain_range_t(3, 15, 3); if_gains += osmosdr::gain_range_t(3, 15, 3); std::map< int, double > gains; /* initialize with min gains */ for (unsigned int i = 0; i < if_gains.size(); i++) { gains[ i + 1 ] = if_gains[ i ].start(); } for (int i = if_gains.size() - 1; i >= 0; i--) { osmosdr::gain_range_t range = if_gains[ i ]; double error = gain; for( double g = range.start(); g <= range.stop(); g += range.step() ) { double sum = 0; for (int j = 0; j < int(gains.size()); j++) { if ( i == j ) sum += g; else sum += gains[ j + 1 ]; } double err = abs(gain - sum); if (err < error) { error = err; gains[ i + 1 ] = g; } } } #if 0 std::cerr << gain << " => "; double sum = 0; for (unsigned int i = 0; i < gains.size(); i++) { sum += gains[ i + 1 ]; std::cerr << gains[ i + 1 ] << " "; } std::cerr << " = " << sum << std::endl; #endif for (unsigned int stage = 1; stage <= gains.size(); stage++) { _src->set_if_gain(stage, int(gains[ stage ] * 10.0)); } _if_gain = gain; return gain; } std::vector< std::string > rtl_tcp_source_c::get_antennas( size_t chan ) { std::vector< std::string > antennas; antennas += get_antenna(chan); return antennas; } std::string rtl_tcp_source_c::set_antenna( const std::string & antenna, size_t chan ) { return get_antenna(chan); } std::string rtl_tcp_source_c::get_antenna( size_t chan ) { return "RX"; } gr-osmosdr-0.1.0.55.80c4af/lib/rtl_tcp/rtl_tcp_source_c.h000066400000000000000000000053751225753723100227600ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef RTL_TCP_SOURCE_C_H #define RTL_TCP_SOURCE_C_H #include #include "source_iface.h" #include "rtl_tcp_source_f.h" class rtl_tcp_source_c; typedef boost::shared_ptr< rtl_tcp_source_c > rtl_tcp_source_c_sptr; rtl_tcp_source_c_sptr make_rtl_tcp_source_c( const std::string & args = "" ); class rtl_tcp_source_c : public gr::hier_block2, public source_iface { private: friend rtl_tcp_source_c_sptr make_rtl_tcp_source_c(const std::string &args); rtl_tcp_source_c(const std::string &args); public: ~rtl_tcp_source_c(); std::string name(); static std::vector< std::string > get_devices( bool fake = false ); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); bool set_gain_mode( bool automatic, size_t chan = 0 ); bool get_gain_mode( size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); double set_if_gain( double gain, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); private: double _freq, _rate, _gain, _corr; bool _no_tuner; bool _auto_gain; double _if_gain; rtl_tcp_source_f_sptr _src; }; #endif // RTL_TCP_SOURCE_C_H gr-osmosdr-0.1.0.55.80c4af/lib/rtl_tcp/rtl_tcp_source_f.cc000066400000000000000000000232041225753723100231100ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Hoernchen * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ //#define HAVE_WINDOWS_H #include #include #include #include #include #include #ifndef _WIN32 #include #else #include #endif /* copied from rtl sdr code */ typedef struct { /* structure size must be multiple of 2 bytes */ char magic[4]; uint32_t tuner_type; uint32_t tuner_gain_count; } dongle_info_t; #define USE_SELECT 1 // non-blocking receive on all platforms #define USE_RCV_TIMEO 0 // non-blocking receive on all but Cygwin #define SRC_VERBOSE 0 #define SNK_VERBOSE 0 static int is_error( int perr ) { // Compare error to posix error code; return nonzero if match. #if defined(USING_WINSOCK) #define ENOPROTOOPT 109 // All codes to be checked for must be defined below int werr = WSAGetLastError(); switch( werr ) { case WSAETIMEDOUT: return( perr == EAGAIN ); case WSAENOPROTOOPT: return( perr == ENOPROTOOPT ); default: fprintf(stderr,"rtl_tcp_source_f: unknown error %d WS err %d \n", perr, werr ); throw std::runtime_error("internal error"); } return 0; #else return( perr == errno ); #endif } static void report_error( const char *msg1, const char *msg2 ) { // Deal with errors, both posix and winsock #if defined(USING_WINSOCK) int werr = WSAGetLastError(); fprintf(stderr, "%s: winsock error %d\n", msg1, werr ); #else perror(msg1); #endif if( msg2 != NULL ) throw std::runtime_error(msg2); return; } rtl_tcp_source_f::rtl_tcp_source_f(size_t itemsize, const char *host, unsigned short port, int payload_size, bool eof, bool wait) : gr::sync_block ("rtl_tcp_source_f", gr::io_signature::make(0, 0, 0), gr::io_signature::make(1, 1, sizeof(float))), d_itemsize(itemsize), d_payload_size(payload_size), d_eof(eof), d_wait(wait), d_socket(-1), d_temp_offset(0) { int ret = 0; #if defined(USING_WINSOCK) // for Windows (with MinGW) // initialize winsock DLL WSADATA wsaData; int iResult = WSAStartup( MAKEWORD(2,2), &wsaData ); if( iResult != NO_ERROR ) { report_error( "rtl_tcp_source_f WSAStartup", "can't open socket" ); } #endif // Set up the address stucture for the source address and port numbers // Get the source IP address from the host name struct addrinfo *ip_src; // store the source IP address to use struct addrinfo hints; memset( (void*)&hints, 0, sizeof(hints) ); hints.ai_family = AF_INET; hints.ai_socktype = SOCK_STREAM; hints.ai_protocol = IPPROTO_TCP; hints.ai_flags = AI_PASSIVE; char port_str[12]; sprintf( port_str, "%d", port ); // FIXME leaks if report_error throws below ret = getaddrinfo( host, port_str, &hints, &ip_src ); if( ret != 0 ) report_error("rtl_tcp_source_f/getaddrinfo", "can't initialize source socket" ); // FIXME leaks if report_error throws below d_temp_buff = new unsigned char[d_payload_size]; // allow it to hold up to payload_size bytes d_LUT= new float[0xff+1]; for(int i=0; i <=(0xff);++i){ d_LUT[i] = (((float)(i&0xff))-127.4f)*(1.0f/128.0f); } // create socket d_socket = socket(ip_src->ai_family, ip_src->ai_socktype, ip_src->ai_protocol); if(d_socket == -1) { report_error("socket open","can't open socket"); } // Turn on reuse address int opt_val = 1; if(setsockopt(d_socket, SOL_SOCKET, SO_REUSEADDR, (optval_t)&opt_val, sizeof(int)) == -1) { report_error("SO_REUSEADDR","can't set socket option SO_REUSEADDR"); } // Don't wait when shutting down linger lngr; lngr.l_onoff = 1; lngr.l_linger = 0; if(setsockopt(d_socket, SOL_SOCKET, SO_LINGER, (optval_t)&lngr, sizeof(linger)) == -1) { if( !is_error(ENOPROTOOPT) ) { // no SO_LINGER for SOCK_DGRAM on Windows report_error("SO_LINGER","can't set socket option SO_LINGER"); } } #if USE_RCV_TIMEO // Set a timeout on the receive function to not block indefinitely // This value can (and probably should) be changed // Ignored on Cygwin #if defined(USING_WINSOCK) DWORD timeout = 1000; // milliseconds #else timeval timeout; timeout.tv_sec = 1; timeout.tv_usec = 0; #endif if(setsockopt(d_socket, SOL_SOCKET, SO_RCVTIMEO, (optval_t)&timeout, sizeof(timeout)) == -1) { report_error("SO_RCVTIMEO","can't set socket option SO_RCVTIMEO"); } #endif // USE_RCV_TIMEO while(connect(d_socket, ip_src->ai_addr, ip_src->ai_addrlen) != 0); freeaddrinfo(ip_src); int flag = 1; setsockopt(d_socket, IPPROTO_TCP, TCP_NODELAY, (char *)&flag,sizeof(flag)); dongle_info_t dongle_info; ret = recv(d_socket, (char*)&dongle_info, sizeof(dongle_info), 0); if (sizeof(dongle_info) != ret) fprintf(stderr,"failed to read dongle info\n"); d_tuner_type = RTLSDR_TUNER_UNKNOWN; d_tuner_gain_count = 0; d_tuner_if_gain_count = 0; if (memcmp(dongle_info.magic, "RTL0", 4) == 0) { d_tuner_type = ntohl(dongle_info.tuner_type); d_tuner_gain_count = ntohl(dongle_info.tuner_gain_count); if ( RTLSDR_TUNER_E4000 == d_tuner_type ) d_tuner_if_gain_count = 53; } } rtl_tcp_source_f_sptr make_rtl_tcp_source_f (size_t itemsize, const char *ipaddr, unsigned short port, int payload_size, bool eof, bool wait) { return gnuradio::get_initial_sptr(new rtl_tcp_source_f ( itemsize, ipaddr, port, payload_size, eof, wait)); } rtl_tcp_source_f::~rtl_tcp_source_f () { delete [] d_temp_buff; if (d_socket != -1){ shutdown(d_socket, SHUT_RDWR); #if defined(USING_WINSOCK) closesocket(d_socket); #else ::close(d_socket); #endif d_socket = -1; } #if defined(USING_WINSOCK) // for Windows (with MinGW) // free winsock resources WSACleanup(); #endif } int rtl_tcp_source_f::work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items) { float *out = (float *) output_items[0]; ssize_t r = 0; int bytesleft = noutput_items; int index = 0; int receivedbytes = 0; while(bytesleft > 0) { receivedbytes = recv(d_socket, (char*)&d_temp_buff[index], bytesleft, 0); if(receivedbytes == -1 && !is_error(EAGAIN)){ fprintf(stderr, "socket error\n"); return -1; } bytesleft -= receivedbytes; index += receivedbytes; } r = noutput_items; for(int i=0; i * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef RTL_TCP_SOURCE_F_H #define RTL_TCP_SOURCE_F_H #include #include #if defined(_WIN32) // if not posix, assume winsock #pragma comment(lib, "ws2_32.lib") #define USING_WINSOCK #include #include #define SHUT_RDWR 2 typedef char* optval_t; #else #include #include #include #include #include #include typedef void* optval_t; #endif #define ssize_t int /* copied from rtl sdr */ enum rtlsdr_tuner { RTLSDR_TUNER_UNKNOWN = 0, RTLSDR_TUNER_E4000, RTLSDR_TUNER_FC0012, RTLSDR_TUNER_FC0013, RTLSDR_TUNER_FC2580, RTLSDR_TUNER_R820T, RTLSDR_TUNER_R828D }; class rtl_tcp_source_f; typedef boost::shared_ptr rtl_tcp_source_f_sptr; rtl_tcp_source_f_sptr make_rtl_tcp_source_f ( size_t itemsize, const char *host, unsigned short port, int payload_size, bool eof = false, bool wait = false); class rtl_tcp_source_f : public gr::sync_block { private: size_t d_itemsize; int d_payload_size; // maximum transmission unit (packet length) bool d_eof; // zero-length packet is EOF bool d_wait; // wait if data if not immediately available int d_socket; // handle to socket unsigned char *d_temp_buff; // hold buffer between calls size_t d_temp_offset; // point to temp buffer location offset float *d_LUT; unsigned int d_tuner_type; unsigned int d_tuner_gain_count; unsigned int d_tuner_if_gain_count; private: rtl_tcp_source_f(size_t itemsize, const char *host, unsigned short port, int payload_size, bool eof, bool wait); // The friend declaration allows make_source_c to // access the private constructor. friend rtl_tcp_source_f_sptr make_rtl_tcp_source_f ( size_t itemsize, const char *host, unsigned short port, int payload_size, bool eof, bool wait); public: ~rtl_tcp_source_f(); enum rtlsdr_tuner get_tuner_type() { return (enum rtlsdr_tuner) d_tuner_type; } unsigned int get_tuner_gain_count() { return d_tuner_gain_count; } unsigned int get_tuner_if_gain_count() { return d_tuner_if_gain_count; } int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items); void set_freq(int freq); void set_sample_rate(int sample_rate); void set_gain_mode(int manual); void set_gain(int gain); void set_freq_corr(int ppm); void set_if_gain(int stage, int gain); void set_agc_mode(int on); void set_direct_sampling(int on); void set_offset_tuning(int on); }; #endif /* RTL_TCP_SOURCE_F_H */ gr-osmosdr-0.1.0.55.80c4af/lib/sink_iface.h000066400000000000000000000213451225753723100200460ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef OSMOSDR_SINK_IFACE_H #define OSMOSDR_SINK_IFACE_H #include #include /*! * TODO: document * */ class sink_iface { public: /*! * Get the number of channels the underlying radio hardware offers. * \return the number of available channels */ virtual size_t get_num_channels( void ) = 0; /*! * Get the possible sample rates for the underlying radio hardware. * \return a range of rates in Sps */ virtual osmosdr::meta_range_t get_sample_rates( void ) = 0; /*! * Set the sample rate for the underlying radio hardware. * This also will select the appropriate IF bandpass, if applicable. * \param rate a new rate in Sps */ virtual double set_sample_rate( double rate ) = 0; /*! * Get the sample rate for the underlying radio hardware. * This is the actual sample rate and may differ from the rate set. * \return the actual rate in Sps */ virtual double get_sample_rate( void ) = 0; /*! * Get the tunable frequency range for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the frequency range in Hz */ virtual osmosdr::freq_range_t get_freq_range( size_t chan = 0 ) = 0; /*! * Tune the underlying radio hardware to the desired center frequency. * This also will select the appropriate RF bandpass. * \param freq the desired frequency in Hz * \param chan the channel index 0 to N-1 * \return the actual frequency in Hz */ virtual double set_center_freq( double freq, size_t chan = 0 ) = 0; /*! * Get the center frequency the underlying radio hardware is tuned to. * This is the actual frequency and may differ from the frequency set. * \param chan the channel index 0 to N-1 * \return the frequency in Hz */ virtual double get_center_freq( size_t chan = 0 ) = 0; /*! * Set the frequency correction value in parts per million. * \param ppm the desired correction value in parts per million * \param chan the channel index 0 to N-1 * \return correction value in parts per million */ virtual double set_freq_corr( double ppm, size_t chan = 0 ) = 0; /*! * Get the frequency correction value. * \param chan the channel index 0 to N-1 * \return correction value in parts per million */ virtual double get_freq_corr( size_t chan = 0 ) = 0; /*! * Get the gain stage names of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return a vector of strings containing the names of gain stages */ virtual std::vector get_gain_names( size_t chan = 0 ) = 0; /*! * Get the settable overall gain range for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the gain range in dB */ virtual osmosdr::gain_range_t get_gain_range( size_t chan = 0 ) = 0; /*! * Get the settable gain range for a specific gain stage. * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the gain range in dB */ virtual osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ) = 0; /*! * Set the gain mode for the underlying radio hardware. * This might be supported only for certain hardware types. * \param automatic the gain mode (true means automatic gain mode) * \param chan the channel index 0 to N-1 * \return the actual gain mode */ virtual bool set_gain_mode( bool automatic, size_t chan = 0 ) { return false; } /*! * Get the gain mode selected for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the actual gain mode (true means automatic gain mode) */ virtual bool get_gain_mode( size_t chan = 0 ) { return false; } /*! * Set the gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_gain( double gain, size_t chan = 0 ) = 0; /*! * Set the named gain on the underlying radio hardware. * \param gain the gain in dB * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_gain( double gain, const std::string & name, size_t chan = 0 ) = 0; /*! * Get the actual gain setting of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double get_gain( size_t chan = 0 ) = 0; /*! * Get the actual gain setting of a named stage. * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double get_gain( const std::string & name, size_t chan = 0 ) = 0; /*! * Set the IF gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available IF gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_if_gain( double gain, size_t chan = 0 ) { return 0; } /*! * Set the BB gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available BB gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_bb_gain( double gain, size_t chan = 0 ) { return 0; } /*! * Get the available antennas of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return a vector of strings containing the names of available antennas */ virtual std::vector< std::string > get_antennas( size_t chan = 0 ) = 0; /*! * Select the active antenna of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the actual antenna's name */ virtual std::string set_antenna( const std::string & antenna, size_t chan = 0 ) = 0; /*! * Get the actual underlying radio hardware antenna setting. * \param chan the channel index 0 to N-1 * \return the actual antenna's name */ virtual std::string get_antenna( size_t chan = 0 ) = 0; /*! * Set the TX frontend DC offset value. * The value is complex to control both I and Q. * * \param offset the dc offset (1.0 is full-scale) * \param chan the channel index 0 to N-1 */ virtual void set_dc_offset( const std::complex &offset, size_t chan = 0 ) { } /*! * Set the TX frontend IQ balance correction. * Use this to adjust the magnitude and phase of I and Q. * * \param balance the complex correction value * \param chan the channel index 0 to N-1 */ virtual void set_iq_balance( const std::complex &balance, size_t chan = 0 ) { } /*! * Set the bandpass filter on the radio frontend. * \param bandwidth the filter bandwidth in Hz, set to 0 for automatic selection * \param chan the channel index 0 to N-1 * \return the actual filter bandwidth in Hz */ virtual double set_bandwidth( double bandwidth, size_t chan = 0 ) { return 0; } /*! * Get the actual bandpass filter setting on the radio frontend. * \param chan the channel index 0 to N-1 * \return the actual filter bandwidth in Hz */ virtual double get_bandwidth( size_t chan = 0 ) { return 0; } /*! * Get the possible bandpass filter settings on the radio frontend. * \param chan the channel index 0 to N-1 * \return a range of bandwidths in Hz */ virtual osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ) { return osmosdr::freq_range_t(); } }; #endif // OSMOSDR_SINK_IFACE_H gr-osmosdr-0.1.0.55.80c4af/lib/sink_impl.cc000066400000000000000000000370231225753723100200760ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ /* * config.h is generated by configure. It contains the results * of probing for features, options etc. It should be the first * file included in your .cc file. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include #include #include #include #ifdef ENABLE_UHD #include "uhd_sink_c.h" #endif #ifdef ENABLE_HACKRF #include "hackrf_sink_c.h" #endif #ifdef ENABLE_BLADERF #include "bladerf_sink_c.h" #endif #include "arg_helpers.h" #include "sink_impl.h" /* This avoids throws in ctor of gr::hier_block2, as gnuradio is unable to deal with this behavior in a clean way. The GR maintainer Rondeau has been informed. */ #define WORKAROUND_GR_HIER_BLOCK2_BUG /* * Create a new instance of sink_impl and return * a boost shared_ptr. This is effectively the public constructor. */ osmosdr::sink::sptr osmosdr::sink::make( const std::string &args ) { return gnuradio::get_initial_sptr( new sink_impl(args) ); } /* * The private constructor */ sink_impl::sink_impl( const std::string &args ) : gr::hier_block2 ("sink_impl", args_to_io_signature(args), gr::io_signature::make(0, 0, 0)), _sample_rate(NAN) { size_t channel = 0; bool device_specified = false; std::vector< std::string > arg_list = args_to_vector(args); std::vector< std::string > dev_types; #ifdef ENABLE_UHD dev_types.push_back("uhd"); #endif #ifdef ENABLE_HACKRF dev_types.push_back("hackrf"); #endif #ifdef ENABLE_BLADERF dev_types.push_back("bladerf"); #endif std::cerr << "gr-osmosdr " << GR_OSMOSDR_VERSION << " (" << GR_OSMOSDR_LIBVER << ") " << "gnuradio " << gr::version() << std::endl; std::cerr << "built-in sink types: "; BOOST_FOREACH(std::string dev_type, dev_types) std::cerr << dev_type << " "; std::cerr << std::endl << std::flush; BOOST_FOREACH(std::string arg, arg_list) { dict_t dict = params_to_dict(arg); BOOST_FOREACH(std::string dev_type, dev_types) { if ( dict.count( dev_type ) ) { device_specified = true; break; } } } #ifdef WORKAROUND_GR_HIER_BLOCK2_BUG try { #endif std::vector< std::string > dev_list; #ifdef ENABLE_UHD BOOST_FOREACH( std::string dev, uhd_sink_c::get_devices() ) dev_list.push_back( dev ); #endif #ifdef ENABLE_BLADERF BOOST_FOREACH( std::string dev, bladerf_sink_c::get_devices() ) dev_list.push_back( dev ); #endif #ifdef ENABLE_HACKRF BOOST_FOREACH( std::string dev, hackrf_sink_c::get_devices() ) dev_list.push_back( dev ); #endif // std::cerr << std::endl; // BOOST_FOREACH( std::string dev, dev_list ) // std::cerr << "'" << dev << "'" << std::endl; if (!device_specified) { if ( dev_list.size() ) arg_list.push_back( dev_list.front() ); else throw std::runtime_error("No supported devices found to pick from."); } BOOST_FOREACH(std::string arg, arg_list) { dict_t dict = params_to_dict(arg); // std::cerr << std::endl; // BOOST_FOREACH( dict_t::value_type &entry, dict ) // std::cerr << "'" << entry.first << "' = '" << entry.second << "'" << std::endl; sink_iface *iface = NULL; gr::basic_block_sptr block; #ifdef ENABLE_UHD if ( dict.count("uhd") ) { uhd_sink_c_sptr sink = make_uhd_sink_c( arg ); block = sink; iface = sink.get(); } #endif #ifdef ENABLE_HACKRF if ( dict.count("hackrf") ) { hackrf_sink_c_sptr sink = make_hackrf_sink_c( arg ); block = sink; iface = sink.get(); } #endif #ifdef ENABLE_BLADERF if ( dict.count("bladerf") ) { bladerf_sink_c_sptr sink = make_bladerf_sink_c( arg ); block = sink; iface = sink.get(); } #endif if ( iface != NULL && long(block.get()) != 0 ) { _devs.push_back( iface ); for (size_t i = 0; i < iface->get_num_channels(); i++) { connect(self(), channel++, block, i); } } else if ( (iface != NULL) || (long(block.get()) != 0) ) throw std::runtime_error("Eitner iface or block are NULL."); } if (!_devs.size()) throw std::runtime_error("No devices specified via device arguments."); #ifdef WORKAROUND_GR_HIER_BLOCK2_BUG } catch ( std::exception &ex ) { std::cerr << std::endl << "FATAL: " << ex.what() << std::endl << std::endl; size_t missing_chans = 0; if ( input_signature()->max_streams() > 0 ) missing_chans = input_signature()->max_streams() - channel; std::cerr << "Trying to fill up " << missing_chans << " missing channel(s) with null sink(s).\n" << "This is being done to prevent the application from crashing\n" << "due to gnuradio bug #528.\n" << std::endl; for (size_t i = 0; i < missing_chans; i++) { /* we try to prevent the whole application from crashing by faking * the missing hardware (channels) with a null sink */ gr::blocks::null_sink::sptr null_sink = \ gr::blocks::null_sink::make( sizeof(gr_complex) ); gr::blocks::throttle::sptr throttle = \ gr::blocks::throttle::make( sizeof(gr_complex), 1e5 ); connect(self(), channel++, throttle, 0); connect(throttle, 0, null_sink, 0); } } #endif } size_t sink_impl::get_num_channels() { size_t channels = 0; BOOST_FOREACH( sink_iface *dev, _devs ) channels += dev->get_num_channels(); return channels; } #define NO_DEVICES_MSG "FATAL: No device(s) available to work with." osmosdr::meta_range_t sink_impl::get_sample_rates() { if ( ! _devs.empty() ) return _devs[0]->get_sample_rates(); // assume same devices used in the group #if 0 else throw std::runtime_error(NO_DEVICES_MSG); #endif return osmosdr::meta_range_t(); } double sink_impl::set_sample_rate(double rate) { double sample_rate = 0; if (_sample_rate != rate) { #if 0 if (_devs.empty()) throw std::runtime_error(NO_DEVICES_MSG); #endif BOOST_FOREACH( sink_iface *dev, _devs ) sample_rate = dev->set_sample_rate(rate); _sample_rate = sample_rate; } return sample_rate; } double sink_impl::get_sample_rate() { double sample_rate = 0; if (!_devs.empty()) sample_rate = _devs[0]->get_sample_rate(); // assume same devices used in the group #if 0 else throw std::runtime_error(NO_DEVICES_MSG); #endif return sample_rate; } osmosdr::freq_range_t sink_impl::get_freq_range( size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_freq_range( dev_chan ); return osmosdr::freq_range_t(); } double sink_impl::set_center_freq( double freq, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _center_freq[ chan ] != freq ) { _center_freq[ chan ] = freq; return dev->set_center_freq( freq, dev_chan ); } else { return _center_freq[ chan ]; } } return 0; } double sink_impl::get_center_freq( size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_center_freq( dev_chan ); return 0; } double sink_impl::set_freq_corr( double ppm, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _freq_corr[ chan ] != ppm ) { _freq_corr[ chan ] = ppm; return dev->set_freq_corr( ppm, dev_chan ); } else { return _freq_corr[ chan ]; } } return 0; } double sink_impl::get_freq_corr( size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_freq_corr( dev_chan ); return 0; } std::vector sink_impl::get_gain_names( size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain_names( dev_chan ); return std::vector< std::string >(); } osmosdr::gain_range_t sink_impl::get_gain_range( size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain_range( dev_chan ); return osmosdr::gain_range_t(); } osmosdr::gain_range_t sink_impl::get_gain_range( const std::string & name, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain_range( name, dev_chan ); return osmosdr::gain_range_t(); } bool sink_impl::set_gain_mode( bool automatic, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _gain_mode[ chan ] != automatic ) { _gain_mode[ chan ] = automatic; bool mode = dev->set_gain_mode( automatic, dev_chan ); if (!automatic) // reapply gain value when switched to manual mode dev->set_gain( _gain[ chan ], dev_chan ); return mode; } else { return _gain_mode[ chan ]; } } return false; } bool sink_impl::get_gain_mode( size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain_mode( dev_chan ); return false; } double sink_impl::set_gain( double gain, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _gain[ chan ] != gain ) { _gain[ chan ] = gain; return dev->set_gain( gain, dev_chan ); } else { return _gain[ chan ]; } } return 0; } double sink_impl::set_gain( double gain, const std::string & name, size_t chan) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->set_gain( gain, name, dev_chan ); return 0; } double sink_impl::get_gain( size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain( dev_chan ); return 0; } double sink_impl::get_gain( const std::string & name, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain( name, dev_chan ); return 0; } double sink_impl::set_if_gain( double gain, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _if_gain[ chan ] != gain ) { _if_gain[ chan ] = gain; return dev->set_if_gain( gain, dev_chan ); } else { return _if_gain[ chan ]; } } return 0; } double sink_impl::set_bb_gain( double gain, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _bb_gain[ chan ] != gain ) { _bb_gain[ chan ] = gain; return dev->set_bb_gain( gain, dev_chan ); } else { return _bb_gain[ chan ]; } } return 0; } std::vector< std::string > sink_impl::get_antennas( size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_antennas( dev_chan ); return std::vector< std::string >(); } std::string sink_impl::set_antenna( const std::string & antenna, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _antenna[ chan ] != antenna ) { _antenna[ chan ] = antenna; return dev->set_antenna( antenna, dev_chan ); } else { return _antenna[ chan ]; } } return ""; } std::string sink_impl::get_antenna( size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_antenna( dev_chan ); return ""; } void sink_impl::set_dc_offset( const std::complex &offset, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->set_dc_offset( offset, dev_chan ); } void sink_impl::set_iq_balance( const std::complex &balance, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->set_iq_balance( balance, dev_chan ); } double sink_impl::set_bandwidth( double bandwidth, size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _bandwidth[ chan ] != bandwidth || 0.0f == bandwidth ) { _bandwidth[ chan ] = bandwidth; return dev->set_bandwidth( bandwidth, dev_chan ); } else { return _bandwidth[ chan ]; } } return 0; } double sink_impl::get_bandwidth( size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_bandwidth( dev_chan ); return 0; } osmosdr::freq_range_t sink_impl::get_bandwidth_range( size_t chan ) { size_t channel = 0; BOOST_FOREACH( sink_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_bandwidth_range( dev_chan ); return osmosdr::freq_range_t(); } gr-osmosdr-0.1.0.55.80c4af/lib/sink_impl.h000066400000000000000000000060601225753723100177350ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2013 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_OSMOSDR_SINK_IMPL_H #define INCLUDED_OSMOSDR_SINK_IMPL_H #include "osmosdr/sink.h" #include "sink_iface.h" #include class sink_impl : public osmosdr::sink { public: sink_impl(const std::string & args); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); bool set_gain_mode( bool automatic, size_t chan = 0 ); bool get_gain_mode( size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); double set_if_gain( double gain, size_t chan = 0 ); double set_bb_gain( double gain, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); void set_dc_offset( const std::complex &offset, size_t chan = 0 ); void set_iq_balance( const std::complex &balance, size_t chan = 0 ); double set_bandwidth( double bandwidth, size_t chan = 0 ); double get_bandwidth( size_t chan = 0 ); osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ); private: std::vector< sink_iface * > _devs; /* cache to prevent multiple device calls with the same value coming from grc */ double _sample_rate; std::map< size_t, double > _center_freq; std::map< size_t, double > _freq_corr; std::map< size_t, bool > _gain_mode; std::map< size_t, double > _gain; std::map< size_t, double > _if_gain; std::map< size_t, double > _bb_gain; std::map< size_t, std::string > _antenna; std::map< size_t, double > _bandwidth; }; #endif /* INCLUDED_OSMOSDR_SINK_IMPL_H */ gr-osmosdr-0.1.0.55.80c4af/lib/source_iface.h000066400000000000000000000231251225753723100204000ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef OSMOSDR_SOURCE_IFACE_H #define OSMOSDR_SOURCE_IFACE_H #include #include /*! * TODO: document * */ class source_iface { public: /*! * Get the number of channels the underlying radio hardware offers. * \return the number of available channels */ virtual size_t get_num_channels( void ) = 0; /*! * Get the possible sample rates for the underlying radio hardware. * \return a range of rates in Sps */ virtual osmosdr::meta_range_t get_sample_rates( void ) = 0; /*! * Set the sample rate for the underlying radio hardware. * This also will select the appropriate IF bandpass, if applicable. * \param rate a new rate in Sps */ virtual double set_sample_rate( double rate ) = 0; /*! * Get the sample rate for the underlying radio hardware. * This is the actual sample rate and may differ from the rate set. * \return the actual rate in Sps */ virtual double get_sample_rate( void ) = 0; /*! * Get the tunable frequency range for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the frequency range in Hz */ virtual osmosdr::freq_range_t get_freq_range( size_t chan = 0 ) = 0; /*! * Tune the underlying radio hardware to the desired center frequency. * This also will select the appropriate RF bandpass. * \param freq the desired frequency in Hz * \param chan the channel index 0 to N-1 * \return the actual frequency in Hz */ virtual double set_center_freq( double freq, size_t chan = 0 ) = 0; /*! * Get the center frequency the underlying radio hardware is tuned to. * This is the actual frequency and may differ from the frequency set. * \param chan the channel index 0 to N-1 * \return the frequency in Hz */ virtual double get_center_freq( size_t chan = 0 ) = 0; /*! * Set the frequency correction value in parts per million. * \param ppm the desired correction value in parts per million * \param chan the channel index 0 to N-1 * \return correction value in parts per million */ virtual double set_freq_corr( double ppm, size_t chan = 0 ) = 0; /*! * Get the frequency correction value. * \param chan the channel index 0 to N-1 * \return correction value in parts per million */ virtual double get_freq_corr( size_t chan = 0 ) = 0; /*! * Get the gain stage names of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return a vector of strings containing the names of gain stages */ virtual std::vector get_gain_names( size_t chan = 0 ) = 0; /*! * Get the settable overall gain range for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the gain range in dB */ virtual osmosdr::gain_range_t get_gain_range( size_t chan = 0 ) = 0; /*! * Get the settable gain range for a specific gain stage. * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the gain range in dB */ virtual osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ) = 0; /*! * Set the gain mode for the underlying radio hardware. * This might be supported only for certain hardware types. * \param automatic the gain mode (true means automatic gain mode) * \param chan the channel index 0 to N-1 * \return the actual gain mode */ virtual bool set_gain_mode( bool automatic, size_t chan = 0 ) { return false; } /*! * Get the gain mode selected for the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the actual gain mode (true means automatic gain mode) */ virtual bool get_gain_mode( size_t chan = 0 ) { return false; } /*! * Set the gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_gain( double gain, size_t chan = 0 ) = 0; /*! * Set the named gain on the underlying radio hardware. * \param gain the gain in dB * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_gain( double gain, const std::string & name, size_t chan = 0 ) = 0; /*! * Get the actual gain setting of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double get_gain( size_t chan = 0 ) = 0; /*! * Get the actual gain setting of a named stage. * \param name the name of the gain stage * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double get_gain( const std::string & name, size_t chan = 0 ) = 0; /*! * Set the IF gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available IF gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_if_gain( double gain, size_t chan = 0 ) { return 0; } /*! * Set the BB gain for the underlying radio hardware. * This function will automatically distribute the desired gain value over * available BB gain stages in an appropriate way and return the actual value. * \param gain the gain in dB * \param chan the channel index 0 to N-1 * \return the actual gain in dB */ virtual double set_bb_gain( double gain, size_t chan = 0 ) { return 0; } /*! * Get the available antennas of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return a vector of strings containing the names of available antennas */ virtual std::vector< std::string > get_antennas( size_t chan = 0 ) = 0; /*! * Select the active antenna of the underlying radio hardware. * \param chan the channel index 0 to N-1 * \return the actual antenna's name */ virtual std::string set_antenna( const std::string & antenna, size_t chan = 0 ) = 0; /*! * Get the actual underlying radio hardware antenna setting. * \param chan the channel index 0 to N-1 * \return the actual antenna's name */ virtual std::string get_antenna( size_t chan = 0 ) = 0; /*! * Set the RX frontend DC correction mode. * The automatic correction subtracts out the long-run average. * * When disabled, the averaging option operation is reset. * Once in Manual mode, the average value will be held constant until * the user re-enables the automatic correction or overrides the * value by manually setting the offset. * * \param mode dc offset correction mode: 0 = Off, 1 = Manual, 2 = Automatic * \param chan the channel index 0 to N-1 */ virtual void set_dc_offset_mode( int mode, size_t chan = 0 ) { } /*! * Set a constant DC offset value. * The value is complex to control both I and Q. * Only set this when automatic correction is disabled. * * \param offset the dc offset (1.0 is full-scale) * \param chan the channel index 0 to N-1 */ virtual void set_dc_offset( const std::complex &offset, size_t chan = 0 ) { } /*! * Set the RX frontend IQ balance mode. * * \param mode iq balance correction mode: 0 = Off, 1 = Manual, 2 = Automatic * \param chan the channel index 0 to N-1 */ virtual void set_iq_balance_mode( int mode, size_t chan = 0 ) { } /*! * Set the RX frontend IQ balance correction. * Use this to adjust the magnitude and phase of I and Q. * * \param balance the complex correction value * \param chan the channel index 0 to N-1 */ virtual void set_iq_balance( const std::complex &balance, size_t chan = 0 ) { } /*! * Set the bandpass filter on the radio frontend. * \param bandwidth the filter bandwidth in Hz, set to 0 for automatic selection * \param chan the channel index 0 to N-1 * \return the actual filter bandwidth in Hz */ virtual double set_bandwidth( double bandwidth, size_t chan = 0 ) { return 0; } /*! * Get the actual bandpass filter setting on the radio frontend. * \param chan the channel index 0 to N-1 * \return the actual filter bandwidth in Hz */ virtual double get_bandwidth( size_t chan = 0 ) { return 0; } /*! * Get the possible bandpass filter settings on the radio frontend. * \param chan the channel index 0 to N-1 * \return a range of bandwidths in Hz */ virtual osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ) { return osmosdr::freq_range_t(); } }; #endif // OSMOSDR_SOURCE_IFACE_H gr-osmosdr-0.1.0.55.80c4af/lib/source_impl.cc000066400000000000000000000533451225753723100204370ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ /* * config.h is generated by configure. It contains the results * of probing for features, options etc. It should be the first * file included in your .cc file. */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include #include #include #include #ifdef ENABLE_OSMOSDR #include #endif #ifdef ENABLE_FCD #include #endif #ifdef ENABLE_FILE #include #endif #ifdef ENABLE_RTL #include #endif #ifdef ENABLE_RTL_TCP #include #endif #ifdef ENABLE_UHD #include #endif #ifdef ENABLE_MIRI #include #endif #ifdef ENABLE_HACKRF #include #endif #ifdef ENABLE_BLADERF #include #endif #ifdef ENABLE_RFSPACE #include #endif #include "arg_helpers.h" #include "source_impl.h" /* This avoids throws in ctor of gr::hier_block2, as gnuradio is unable to deal with this behavior in a clean way. The GR maintainer Rondeau has been informed. */ #define WORKAROUND_GR_HIER_BLOCK2_BUG /* * Create a new instance of source_impl and return * a boost shared_ptr. This is effectively the public constructor. */ osmosdr::source::sptr osmosdr::source::make( const std::string &args ) { return gnuradio::get_initial_sptr( new source_impl(args) ); } /* * The private constructor */ source_impl::source_impl( const std::string &args ) : gr::hier_block2 ("source_impl", gr::io_signature::make(0, 0, 0), args_to_io_signature(args)), _sample_rate(NAN) { size_t channel = 0; bool device_specified = false; std::vector< std::string > arg_list = args_to_vector(args); std::vector< std::string > dev_types; #ifdef ENABLE_FILE dev_types.push_back("file"); #endif #ifdef ENABLE_OSMOSDR dev_types.push_back("osmosdr"); #endif #ifdef ENABLE_FCD dev_types.push_back("fcd"); #endif #ifdef ENABLE_RTL dev_types.push_back("rtl"); #endif #ifdef ENABLE_RTL_TCP dev_types.push_back("rtl_tcp"); #endif #ifdef ENABLE_UHD dev_types.push_back("uhd"); #endif #ifdef ENABLE_MIRI dev_types.push_back("miri"); #endif #ifdef ENABLE_HACKRF dev_types.push_back("hackrf"); #endif #ifdef ENABLE_BLADERF dev_types.push_back("bladerf"); #endif #ifdef ENABLE_RFSPACE dev_types.push_back("rfspace"); #endif std::cerr << "gr-osmosdr " << GR_OSMOSDR_VERSION << " (" << GR_OSMOSDR_LIBVER << ") " << "gnuradio " << gr::version() << std::endl; std::cerr << "built-in source types: "; BOOST_FOREACH(std::string dev_type, dev_types) std::cerr << dev_type << " "; std::cerr << std::endl << std::flush; #ifdef ENABLE_RFSPACE dev_types.push_back("sdr-iq"); /* additional aliases for rfspace backend */ dev_types.push_back("sdr-ip"); dev_types.push_back("netsdr"); #endif BOOST_FOREACH(std::string arg, arg_list) { dict_t dict = params_to_dict(arg); BOOST_FOREACH(std::string dev_type, dev_types) { if ( dict.count( dev_type ) ) { device_specified = true; break; } } } #ifdef WORKAROUND_GR_HIER_BLOCK2_BUG try { #endif std::vector< std::string > dev_list; #ifdef ENABLE_OSMOSDR BOOST_FOREACH( std::string dev, osmosdr_src_c::get_devices() ) dev_list.push_back( dev ); #endif #ifdef ENABLE_FCD BOOST_FOREACH( std::string dev, fcd_source_c::get_devices() ) dev_list.push_back( dev ); #endif #ifdef ENABLE_RTL BOOST_FOREACH( std::string dev, rtl_source_c::get_devices() ) dev_list.push_back( dev ); #endif #ifdef ENABLE_UHD BOOST_FOREACH( std::string dev, uhd_source_c::get_devices() ) dev_list.push_back( dev ); #endif #ifdef ENABLE_MIRI BOOST_FOREACH( std::string dev, miri_source_c::get_devices() ) dev_list.push_back( dev ); #endif #ifdef ENABLE_BLADERF BOOST_FOREACH( std::string dev, bladerf_source_c::get_devices() ) dev_list.push_back( dev ); #endif #ifdef ENABLE_RFSPACE BOOST_FOREACH( std::string dev, rfspace_source_c::get_devices() ) dev_list.push_back( dev ); #endif #ifdef ENABLE_HACKRF BOOST_FOREACH( std::string dev, hackrf_source_c::get_devices() ) dev_list.push_back( dev ); #endif // std::cerr << std::endl; // BOOST_FOREACH( std::string dev, dev_list ) // std::cerr << "'" << dev << "'" << std::endl; if (!device_specified) { if ( dev_list.size() ) arg_list.push_back( dev_list.front() ); else throw std::runtime_error("No supported devices found to pick from."); } BOOST_FOREACH(std::string arg, arg_list) { dict_t dict = params_to_dict(arg); // std::cerr << std::endl; // BOOST_FOREACH( dict_t::value_type &entry, dict ) // std::cerr << "'" << entry.first << "' = '" << entry.second << "'" << std::endl; source_iface *iface = NULL; gr::basic_block_sptr block; #ifdef ENABLE_OSMOSDR if ( dict.count("osmosdr") ) { osmosdr_src_c_sptr src = osmosdr_make_src_c( arg ); block = src; iface = src.get(); } #endif #ifdef ENABLE_FCD if ( dict.count("fcd") ) { fcd_source_c_sptr src = make_fcd_source_c( arg ); block = src; iface = src.get(); } #endif #ifdef ENABLE_FILE if ( dict.count("file") ) { file_source_c_sptr src = make_file_source_c( arg ); block = src; iface = src.get(); } #endif #ifdef ENABLE_RTL if ( dict.count("rtl") ) { rtl_source_c_sptr src = make_rtl_source_c( arg ); block = src; iface = src.get(); } #endif #ifdef ENABLE_RTL_TCP if ( dict.count("rtl_tcp") ) { rtl_tcp_source_c_sptr src = make_rtl_tcp_source_c( arg ); block = src; iface = src.get(); } #endif #ifdef ENABLE_UHD if ( dict.count("uhd") ) { uhd_source_c_sptr src = make_uhd_source_c( arg ); block = src; iface = src.get(); } #endif #ifdef ENABLE_MIRI if ( dict.count("miri") ) { miri_source_c_sptr src = make_miri_source_c( arg ); block = src; iface = src.get(); } #endif #ifdef ENABLE_HACKRF if ( dict.count("hackrf") ) { hackrf_source_c_sptr src = make_hackrf_source_c( arg ); block = src; iface = src.get(); } #endif #ifdef ENABLE_BLADERF if ( dict.count("bladerf") ) { bladerf_source_c_sptr src = make_bladerf_source_c( arg ); block = src; iface = src.get(); } #endif #ifdef ENABLE_RFSPACE if ( dict.count("rfspace") || dict.count("sdr-iq") || dict.count("sdr-ip") || dict.count("netsdr") ) { rfspace_source_c_sptr src = make_rfspace_source_c( arg ); block = src; iface = src.get(); } #endif if ( iface != NULL && long(block.get()) != 0 ) { _devs.push_back( iface ); for (size_t i = 0; i < iface->get_num_channels(); i++) { #ifdef HAVE_IQBALANCE gr::iqbalance::optimize_c::sptr iq_opt = gr::iqbalance::optimize_c::make( 0 ); gr::iqbalance::fix_cc::sptr iq_fix = gr::iqbalance::fix_cc::make(); connect(block, i, iq_fix, 0); connect(iq_fix, 0, self(), channel++); connect(block, i, iq_opt, 0); msg_connect(iq_opt, "iqbal_corr", iq_fix, "iqbal_corr"); _iq_opt.push_back( iq_opt.get() ); _iq_fix.push_back( iq_fix.get() ); #else connect(block, i, self(), channel++); #endif } } else if ( (iface != NULL) || (long(block.get()) != 0) ) throw std::runtime_error("Eitner iface or block are NULL."); } if (!_devs.size()) throw std::runtime_error("No devices specified via device arguments."); #ifdef WORKAROUND_GR_HIER_BLOCK2_BUG } catch ( std::exception &ex ) { std::cerr << std::endl << "FATAL: " << ex.what() << std::endl << std::endl; /* we try to prevent the whole application from crashing by faking * the missing hardware (channels) with null sourc(e) */ gr::blocks::null_source::sptr null_source = \ gr::blocks::null_source::make( sizeof(gr_complex) ); gr::blocks::throttle::sptr throttle = \ gr::blocks::throttle::make( sizeof(gr_complex), 1e5 ); connect(null_source, 0, throttle, 0); size_t missing_chans = 0; if ( output_signature()->max_streams() > 0 ) missing_chans = output_signature()->max_streams() - channel; std::cerr << "Trying to fill up " << missing_chans << " missing channel(s) with null source(s).\n" << "This is being done to prevent the application from crashing\n" << "due to gnuradio bug #528.\n" << std::endl; for (size_t i = 0; i < missing_chans; i++) connect(throttle, 0, self(), channel++); } #endif } size_t source_impl::get_num_channels() { size_t channels = 0; BOOST_FOREACH( source_iface *dev, _devs ) channels += dev->get_num_channels(); return channels; } #define NO_DEVICES_MSG "FATAL: No device(s) available to work with." osmosdr::meta_range_t source_impl::get_sample_rates() { if ( ! _devs.empty() ) return _devs[0]->get_sample_rates(); // assume same devices used in the group #if 0 else throw std::runtime_error(NO_DEVICES_MSG); #endif return osmosdr::meta_range_t();; } double source_impl::set_sample_rate(double rate) { double sample_rate = 0; if (_sample_rate != rate) { #if 0 if (_devs.empty()) throw std::runtime_error(NO_DEVICES_MSG); #endif BOOST_FOREACH( source_iface *dev, _devs ) sample_rate = dev->set_sample_rate(rate); #ifdef HAVE_IQBALANCE size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) { for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) { if ( channel < _iq_opt.size() ) { gr::iqbalance::optimize_c *opt = _iq_opt[channel]; if ( opt->period() > 0 ) { /* optimize is enabled */ opt->set_period( dev->get_sample_rate() / 5 ); opt->reset(); } } channel++; } } #endif _sample_rate = sample_rate; } return sample_rate; } double source_impl::get_sample_rate() { double sample_rate = 0; if (!_devs.empty()) sample_rate = _devs[0]->get_sample_rate(); // assume same devices used in the group #if 0 else throw std::runtime_error(NO_DEVICES_MSG); #endif return sample_rate; } osmosdr::freq_range_t source_impl::get_freq_range( size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_freq_range( dev_chan ); return osmosdr::freq_range_t(); } double source_impl::set_center_freq( double freq, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _center_freq[ chan ] != freq ) { _center_freq[ chan ] = freq; return dev->set_center_freq( freq, dev_chan ); } else { return _center_freq[ chan ]; } } return 0; } double source_impl::get_center_freq( size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_center_freq( dev_chan ); return 0; } double source_impl::set_freq_corr( double ppm, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _freq_corr[ chan ] != ppm ) { _freq_corr[ chan ] = ppm; return dev->set_freq_corr( ppm, dev_chan ); } else { return _freq_corr[ chan ]; } } return 0; } double source_impl::get_freq_corr( size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_freq_corr( dev_chan ); return 0; } std::vector source_impl::get_gain_names( size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain_names( dev_chan ); return std::vector< std::string >(); } osmosdr::gain_range_t source_impl::get_gain_range( size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain_range( dev_chan ); return osmosdr::gain_range_t(); } osmosdr::gain_range_t source_impl::get_gain_range( const std::string & name, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain_range( name, dev_chan ); return osmosdr::gain_range_t(); } bool source_impl::set_gain_mode( bool automatic, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _gain_mode[ chan ] != automatic ) { _gain_mode[ chan ] = automatic; bool mode = dev->set_gain_mode( automatic, dev_chan ); if (!automatic) // reapply gain value when switched to manual mode dev->set_gain( _gain[ chan ], dev_chan ); return mode; } else { return _gain_mode[ chan ]; } } return false; } bool source_impl::get_gain_mode( size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain_mode( dev_chan ); return false; } double source_impl::set_gain( double gain, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _gain[ chan ] != gain ) { _gain[ chan ] = gain; return dev->set_gain( gain, dev_chan ); } else { return _gain[ chan ]; } } return 0; } double source_impl::set_gain( double gain, const std::string & name, size_t chan) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->set_gain( gain, name, dev_chan ); return 0; } double source_impl::get_gain( size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain( dev_chan ); return 0; } double source_impl::get_gain( const std::string & name, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_gain( name, dev_chan ); return 0; } double source_impl::set_if_gain( double gain, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _if_gain[ chan ] != gain ) { _if_gain[ chan ] = gain; return dev->set_if_gain( gain, dev_chan ); } else { return _if_gain[ chan ]; } } return 0; } double source_impl::set_bb_gain( double gain, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _bb_gain[ chan ] != gain ) { _bb_gain[ chan ] = gain; return dev->set_bb_gain( gain, dev_chan ); } else { return _bb_gain[ chan ]; } } return 0; } std::vector< std::string > source_impl::get_antennas( size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_antennas( dev_chan ); return std::vector< std::string >(); } std::string source_impl::set_antenna( const std::string & antenna, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _antenna[ chan ] != antenna ) { _antenna[ chan ] = antenna; return dev->set_antenna( antenna, dev_chan ); } else { return _antenna[ chan ]; } } return ""; } std::string source_impl::get_antenna( size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_antenna( dev_chan ); return ""; } void source_impl::set_dc_offset_mode( int mode, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->set_dc_offset_mode( mode, dev_chan ); } void source_impl::set_dc_offset( const std::complex &offset, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->set_dc_offset( offset, dev_chan ); } void source_impl::set_iq_balance_mode( int mode, size_t chan ) { size_t channel = 0; #ifdef HAVE_IQBALANCE BOOST_FOREACH( source_iface *dev, _devs ) { for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) { if ( chan == channel++ ) { if ( chan < _iq_opt.size() && chan < _iq_fix.size() ) { gr::iqbalance::optimize_c *opt = _iq_opt[chan]; gr::iqbalance::fix_cc *fix = _iq_fix[chan]; if ( IQBalanceOff == mode ) { opt->set_period( 0 ); /* store current values in order to be able to restore them later */ _vals[ chan ] = std::pair< float, float >( fix->mag(), fix->phase() ); fix->set_mag( 0.0f ); fix->set_phase( 0.0f ); } else if ( IQBalanceManual == mode ) { if ( opt->period() == 0 ) { /* transition from Off to Manual */ /* restore previous values */ std::pair< float, float > val = _vals[ chan ]; fix->set_mag( val.first ); fix->set_phase( val.second ); } opt->set_period( 0 ); } else if ( IQBalanceAutomatic == mode ) { opt->set_period( dev->get_sample_rate() / 5 ); opt->reset(); } } } } } #else BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->set_iq_balance_mode( mode, dev_chan ); #endif } void source_impl::set_iq_balance( const std::complex &balance, size_t chan ) { size_t channel = 0; #ifdef HAVE_IQBALANCE BOOST_FOREACH( source_iface *dev, _devs ) { for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) { if ( chan == channel++ ) { if ( chan < _iq_opt.size() && chan < _iq_fix.size() ) { gr::iqbalance::optimize_c *opt = _iq_opt[chan]; gr::iqbalance::fix_cc *fix = _iq_fix[chan]; if ( opt->period() == 0 ) { /* automatic optimization desabled */ fix->set_mag( balance.real() ); fix->set_phase( balance.imag() ); } } } } } #else BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->set_iq_balance( balance, dev_chan ); #endif } double source_impl::set_bandwidth( double bandwidth, size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) { if ( _bandwidth[ chan ] != bandwidth || 0.0f == bandwidth ) { _bandwidth[ chan ] = bandwidth; return dev->set_bandwidth( bandwidth, dev_chan ); } else { return _bandwidth[ chan ]; } } return 0; } double source_impl::get_bandwidth( size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_bandwidth( dev_chan ); return 0; } osmosdr::freq_range_t source_impl::get_bandwidth_range( size_t chan ) { size_t channel = 0; BOOST_FOREACH( source_iface *dev, _devs ) for (size_t dev_chan = 0; dev_chan < dev->get_num_channels(); dev_chan++) if ( chan == channel++ ) return dev->get_bandwidth_range( dev_chan ); return osmosdr::freq_range_t(); } gr-osmosdr-0.1.0.55.80c4af/lib/source_impl.h000066400000000000000000000067371225753723100203040ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef INCLUDED_OSMOSDR_SOURCE_IMPL_H #define INCLUDED_OSMOSDR_SOURCE_IMPL_H #include #ifdef HAVE_IQBALANCE #include #include #endif #include #include class source_impl : public osmosdr::source { public: source_impl( const std::string & args ); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); bool set_gain_mode( bool automatic, size_t chan = 0 ); bool get_gain_mode( size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); double set_if_gain( double gain, size_t chan = 0 ); double set_bb_gain( double gain, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); void set_dc_offset_mode( int mode, size_t chan = 0 ); void set_dc_offset( const std::complex &offset, size_t chan = 0 ); void set_iq_balance_mode( int mode, size_t chan = 0 ); void set_iq_balance( const std::complex &balance, size_t chan = 0 ); double set_bandwidth( double bandwidth, size_t chan = 0 ); double get_bandwidth( size_t chan = 0 ); osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ); private: std::vector< source_iface * > _devs; /* cache to prevent multiple device calls with the same value coming from grc */ double _sample_rate; std::map< size_t, double > _center_freq; std::map< size_t, double > _freq_corr; std::map< size_t, bool > _gain_mode; std::map< size_t, double > _gain; std::map< size_t, double > _if_gain; std::map< size_t, double > _bb_gain; std::map< size_t, std::string > _antenna; #ifdef HAVE_IQBALANCE std::vector< gr::iqbalance::fix_cc * > _iq_fix; std::vector< gr::iqbalance::optimize_c * > _iq_opt; std::map< size_t, std::pair > _vals; #endif std::map< size_t, double > _bandwidth; }; #endif /* INCLUDED_OSMOSDR_SOURCE_IMPL_H */ gr-osmosdr-0.1.0.55.80c4af/lib/uhd/000077500000000000000000000000001225753723100163555ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/lib/uhd/CMakeLists.txt000066400000000000000000000027361225753723100211250ustar00rootroot00000000000000# Copyright 2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # This file included, use CMake directory variables ######################################################################## include_directories( ${CMAKE_CURRENT_SOURCE_DIR} ${GNURADIO_UHD_INCLUDE_DIRS} ${UHD_INCLUDE_DIRS} ) set(uhd_srcs ${CMAKE_CURRENT_SOURCE_DIR}/uhd_sink_c.cc ${CMAKE_CURRENT_SOURCE_DIR}/uhd_source_c.cc ) ######################################################################## # Append gnuradio-osmosdr library sources ######################################################################## list(APPEND gr_osmosdr_srcs ${uhd_srcs}) list(APPEND gr_osmosdr_libs ${GNURADIO_UHD_LIBRARIES} ${UHD_LIBRARIES}) gr-osmosdr-0.1.0.55.80c4af/lib/uhd/uhd_sink_c.cc000066400000000000000000000166301225753723100210000ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #include #include #include //#include #include "arg_helpers.h" #include "uhd_sink_c.h" using namespace boost::assign; uhd_sink_c_sptr make_uhd_sink_c(const std::string &args) { return gnuradio::get_initial_sptr(new uhd_sink_c(args)); } uhd_sink_c::uhd_sink_c(const std::string &args) : gr::hier_block2("uhd_sink_c", args_to_io_signature(args), gr::io_signature::make(0, 0, 0)), _center_freq(0.0f), _freq_corr(0.0f), _lo_offset(0.0f) { size_t nchan = 1; dict_t dict = params_to_dict(args); if (dict.count("nchan")) nchan = boost::lexical_cast< size_t >( dict["nchan"] ); if (0 == nchan) nchan = 1; if (dict.count("lo_offset")) _lo_offset = boost::lexical_cast< double >( dict["lo_offset"] ); std::string arguments; // rebuild argument string without internal arguments BOOST_FOREACH( dict_t::value_type &entry, dict ) { if ( "uhd" != entry.first && "nchan" != entry.first && "subdev" != entry.first && "lo_offset" != entry.first ) { arguments += entry.first + "=" + entry.second + ","; } } _snk = gr::uhd::usrp_sink::make( arguments, uhd::io_type_t::COMPLEX_FLOAT32, nchan ); if (dict.count("subdev")) { _snk->set_subdev_spec( dict["subdev"] ); } std::cerr << "-- Using subdev spec '" << _snk->get_subdev_spec() << "'." << std::endl; if (0.0 != _lo_offset) std::cerr << "-- Using lo offset of " << _lo_offset << " Hz." << std::endl; for ( size_t i = 0; i < nchan; i++ ) connect( self(), i, _snk, i ); } uhd_sink_c::~uhd_sink_c() { } std::vector< std::string > uhd_sink_c::get_devices() { std::vector< std::string > devices; uhd::device_addr_t hint; BOOST_FOREACH(const uhd::device_addr_t &dev, uhd::device::find(hint)) { std::string args = "uhd," + dev.to_string(); std::string type = dev.cast< std::string >("type", "usrp"); std::string name = dev.cast< std::string >("name", ""); std::string serial = dev.cast< std::string >("serial", ""); std::string label = "Ettus"; if ( "umtrx" == type ) label = "Fairwaves"; if (type.length()) { boost::to_upper(type); label += " " + type; } if (name.length()) label += " (" + name + ")"; if (serial.length()) label += " " + serial; args += ",label='" + label + + "'"; devices.push_back( args ); } return devices; } std::string uhd_sink_c::name() { // uhd::property_tree::sptr prop_tree = _snk->get_device()->get_device()->get_tree(); // std::string dev_name = prop_tree->access("/name").get(); std::string mboard_name = _snk->get_device()->get_mboard_name(); // std::cerr << "'" << dev_name << "' '" << mboard_name << "'" << std::endl; // 'USRP1 Device' 'USRP1 (Classic)' // 'B-Series Device' 'B100 (B-Hundo)' return mboard_name; } size_t uhd_sink_c::get_num_channels() { return _snk->get_device()->get_rx_num_channels(); } osmosdr::meta_range_t uhd_sink_c::get_sample_rates( void ) { osmosdr::meta_range_t rates; BOOST_FOREACH( uhd::range_t rate, _snk->get_samp_rates() ) rates += osmosdr::range_t( rate.start(), rate.stop(), rate.step() ); return rates; } double uhd_sink_c::set_sample_rate( double rate ) { _snk->set_samp_rate( rate ); return get_sample_rate(); } double uhd_sink_c::get_sample_rate( void ) { return _snk->get_samp_rate(); } osmosdr::freq_range_t uhd_sink_c::get_freq_range( size_t chan ) { osmosdr::freq_range_t range; BOOST_FOREACH( uhd::range_t freq, _snk->get_freq_range(chan) ) range += osmosdr::range_t( freq.start(), freq.stop(), freq.step() ); return range; } double uhd_sink_c::set_center_freq( double freq, size_t chan ) { #define APPLY_PPM_CORR(val, ppm) ((val) * (1.0 + (ppm) * 0.000001)) double corr_freq = APPLY_PPM_CORR( freq, _freq_corr ); // advanced tuning with tune_request_t uhd::tune_request_t tune_req(corr_freq, _lo_offset); _snk->set_center_freq(tune_req, chan); _center_freq = freq; return get_center_freq(chan); } double uhd_sink_c::get_center_freq( size_t chan ) { return _snk->get_center_freq(chan); } double uhd_sink_c::set_freq_corr( double ppm, size_t chan ) { _freq_corr = ppm; set_center_freq( _center_freq ); return get_freq_corr(chan); } double uhd_sink_c::get_freq_corr( size_t chan ) { return _freq_corr; } std::vector uhd_sink_c::get_gain_names( size_t chan ) { return _snk->get_gain_names( chan ); } osmosdr::gain_range_t uhd_sink_c::get_gain_range( size_t chan ) { osmosdr::gain_range_t range; BOOST_FOREACH( uhd::range_t gain, _snk->get_gain_range(chan) ) range += osmosdr::range_t( gain.start(), gain.stop(), gain.step() ); return range; } osmosdr::gain_range_t uhd_sink_c::get_gain_range( const std::string & name, size_t chan ) { osmosdr::gain_range_t range; BOOST_FOREACH( uhd::range_t gain, _snk->get_gain_range(name, chan) ) range += osmosdr::range_t( gain.start(), gain.stop(), gain.step() ); return range; } double uhd_sink_c::set_gain( double gain, size_t chan ) { _snk->set_gain(gain, chan); return get_gain(chan); } double uhd_sink_c::set_gain( double gain, const std::string & name, size_t chan ) { _snk->set_gain(gain, name, chan); return get_gain(name, chan); } double uhd_sink_c::get_gain( size_t chan ) { return _snk->get_gain(chan); } double uhd_sink_c::get_gain( const std::string & name, size_t chan ) { return _snk->get_gain(name, chan); } std::vector< std::string > uhd_sink_c::get_antennas( size_t chan ) { return _snk->get_antennas(chan); } std::string uhd_sink_c::set_antenna( const std::string & antenna, size_t chan ) { _snk->set_antenna(antenna, chan); return _snk->get_antenna(chan); } std::string uhd_sink_c::get_antenna( size_t chan ) { return _snk->get_antenna(chan); } void uhd_sink_c::set_dc_offset( const std::complex &offset, size_t chan ) { _snk->set_dc_offset( offset, chan ); } void uhd_sink_c::set_iq_balance( const std::complex &balance, size_t chan ) { _snk->set_iq_balance( balance, chan ); } double uhd_sink_c::set_bandwidth( double bandwidth, size_t chan ) { _snk->set_bandwidth(bandwidth, chan); return _snk->get_bandwidth(chan); } double uhd_sink_c::get_bandwidth( size_t chan ) { return _snk->get_bandwidth(chan); } osmosdr::freq_range_t uhd_sink_c::get_bandwidth_range( size_t chan ) { osmosdr::freq_range_t bandwidths; BOOST_FOREACH( uhd::range_t bw, _snk->get_bandwidth_range(chan) ) bandwidths += osmosdr::range_t( bw.start(), bw.stop(), bw.step() ); return bandwidths; } gr-osmosdr-0.1.0.55.80c4af/lib/uhd/uhd_sink_c.h000066400000000000000000000054571225753723100206470ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef UHD_SINK_C_H #define UHD_SINK_C_H #include #include #include "sink_iface.h" class uhd_sink_c; typedef boost::shared_ptr< uhd_sink_c > uhd_sink_c_sptr; uhd_sink_c_sptr make_uhd_sink_c(const std::string &args = ""); class uhd_sink_c : public gr::hier_block2, public sink_iface { private: friend uhd_sink_c_sptr make_uhd_sink_c(const std::string &args); uhd_sink_c(const std::string &args); public: ~uhd_sink_c(); static std::vector< std::string > get_devices(); std::string name(); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); void set_dc_offset( const std::complex &offset, size_t chan = 0 ); void set_iq_balance( const std::complex &balance, size_t chan = 0 ); double set_bandwidth( double bandwidth, size_t chan = 0 ); double get_bandwidth( size_t chan = 0 ); osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ); private: double _center_freq; double _freq_corr; double _lo_offset; gr::uhd::usrp_sink::sptr _snk; }; #endif // UHD_SINK_C_H gr-osmosdr-0.1.0.55.80c4af/lib/uhd/uhd_source_c.cc000066400000000000000000000205741225753723100213360ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #include #include #include //#include #include "arg_helpers.h" #include "uhd_source_c.h" #include "osmosdr/source.h" using namespace boost::assign; uhd_source_c_sptr make_uhd_source_c(const std::string &args) { return gnuradio::get_initial_sptr(new uhd_source_c(args)); } uhd_source_c::uhd_source_c(const std::string &args) : gr::hier_block2("uhd_source_c", gr::io_signature::make(0, 0, 0), args_to_io_signature(args)), _center_freq(0.0f), _freq_corr(0.0f), _lo_offset(0.0f) { size_t nchan = 1; dict_t dict = params_to_dict(args); if (dict.count("nchan")) nchan = boost::lexical_cast< size_t >( dict["nchan"] ); if (0 == nchan) nchan = 1; if (dict.count("lo_offset")) _lo_offset = boost::lexical_cast< double >( dict["lo_offset"] ); std::string arguments; // rebuild argument string without internal arguments BOOST_FOREACH( dict_t::value_type &entry, dict ) { if ( "uhd" != entry.first && "nchan" != entry.first && "subdev" != entry.first && "lo_offset" != entry.first ) { arguments += entry.first + "=" + entry.second + ","; } } _src = gr::uhd::usrp_source::make( arguments, uhd::io_type_t::COMPLEX_FLOAT32, nchan ); if (dict.count("subdev")) { _src->set_subdev_spec( dict["subdev"] ); } std::cerr << "-- Using subdev spec '" << _src->get_subdev_spec() << "'." << std::endl; if (0.0 != _lo_offset) std::cerr << "-- Using lo offset of " << _lo_offset << " Hz." << std::endl; for ( size_t i = 0; i < nchan; i++ ) connect( _src, i, self(), i ); } uhd_source_c::~uhd_source_c() { } std::vector< std::string > uhd_source_c::get_devices() { std::vector< std::string > devices; uhd::device_addr_t hint; BOOST_FOREACH(const uhd::device_addr_t &dev, uhd::device::find(hint)) { std::string args = "uhd," + dev.to_string(); std::string type = dev.cast< std::string >("type", "usrp"); std::string name = dev.cast< std::string >("name", ""); std::string serial = dev.cast< std::string >("serial", ""); std::string label = "Ettus"; if ( "umtrx" == type ) label = "Fairwaves"; if (type.length()) { boost::to_upper(type); label += " " + type; } if (name.length()) label += " (" + name + ")"; if (serial.length()) label += " " + serial; args += ",label='" + label + + "'"; devices.push_back( args ); } return devices; } std::string uhd_source_c::name() { // uhd::property_tree::sptr prop_tree = _src->get_device()->get_device()->get_tree(); // std::string dev_name = prop_tree->access("/name").get(); std::string mboard_name = _src->get_device()->get_mboard_name(); // std::cerr << "'" << dev_name << "' '" << mboard_name << "'" << std::endl; // 'USRP1 Device' 'USRP1 (Classic)' // 'B-Series Device' 'B100 (B-Hundo)' return mboard_name; } size_t uhd_source_c::get_num_channels() { return _src->get_device()->get_rx_num_channels(); } osmosdr::meta_range_t uhd_source_c::get_sample_rates( void ) { osmosdr::meta_range_t rates; BOOST_FOREACH( uhd::range_t rate, _src->get_samp_rates() ) rates += osmosdr::range_t( rate.start(), rate.stop(), rate.step() ); return rates; } double uhd_source_c::set_sample_rate( double rate ) { _src->set_samp_rate( rate ); return get_sample_rate(); } double uhd_source_c::get_sample_rate( void ) { return _src->get_samp_rate(); } osmosdr::freq_range_t uhd_source_c::get_freq_range( size_t chan ) { osmosdr::freq_range_t range; BOOST_FOREACH( uhd::range_t freq, _src->get_freq_range(chan) ) range += osmosdr::range_t( freq.start(), freq.stop(), freq.step() ); return range; } double uhd_source_c::set_center_freq( double freq, size_t chan ) { #define APPLY_PPM_CORR(val, ppm) ((val) * (1.0 + (ppm) * 0.000001)) double corr_freq = APPLY_PPM_CORR( freq, _freq_corr ); // advanced tuning with tune_request_t uhd::tune_request_t tune_req(corr_freq, _lo_offset); _src->set_center_freq(tune_req, chan); _center_freq = freq; return get_center_freq(chan); } double uhd_source_c::get_center_freq( size_t chan ) { return _src->get_center_freq(chan); } double uhd_source_c::set_freq_corr( double ppm, size_t chan ) { _freq_corr = ppm; set_center_freq( _center_freq ); return get_freq_corr( chan ); } double uhd_source_c::get_freq_corr( size_t chan ) { return _freq_corr; } std::vector uhd_source_c::get_gain_names( size_t chan ) { return _src->get_gain_names( chan ); } osmosdr::gain_range_t uhd_source_c::get_gain_range( size_t chan ) { osmosdr::gain_range_t range; BOOST_FOREACH( uhd::range_t gain, _src->get_gain_range(chan) ) range += osmosdr::range_t( gain.start(), gain.stop(), gain.step() ); return range; } osmosdr::gain_range_t uhd_source_c::get_gain_range( const std::string & name, size_t chan ) { osmosdr::gain_range_t range; BOOST_FOREACH( uhd::range_t gain, _src->get_gain_range(name, chan) ) range += osmosdr::range_t( gain.start(), gain.stop(), gain.step() ); return range; } double uhd_source_c::set_gain( double gain, size_t chan ) { _src->set_gain(gain, chan); return get_gain(chan); } double uhd_source_c::set_gain( double gain, const std::string & name, size_t chan ) { _src->set_gain(gain, name, chan); return get_gain(name, chan); } double uhd_source_c::get_gain( size_t chan ) { return _src->get_gain(chan); } double uhd_source_c::get_gain( const std::string & name, size_t chan ) { return _src->get_gain(name, chan); } std::vector< std::string > uhd_source_c::get_antennas( size_t chan ) { return _src->get_antennas(chan); } std::string uhd_source_c::set_antenna( const std::string & antenna, size_t chan ) { _src->set_antenna(antenna, chan); return _src->get_antenna(chan); } std::string uhd_source_c::get_antenna( size_t chan ) { return _src->get_antenna(chan); } void uhd_source_c::set_dc_offset_mode( int mode, size_t chan ) { if ( osmosdr::source::DCOffsetOff == mode ) { _src->set_auto_dc_offset( false, chan ); _src->set_dc_offset( std::complex(0.0, 0.0), chan ); /* uhd default */ } else if ( osmosdr::source::DCOffsetManual == mode ) { _src->set_auto_dc_offset( false, chan ); } else if ( osmosdr::source::DCOffsetAutomatic == mode ) { _src->set_auto_dc_offset( true, chan ); } } void uhd_source_c::set_dc_offset( const std::complex &offset, size_t chan ) { _src->set_dc_offset( offset, chan ); } void uhd_source_c::set_iq_balance_mode( int mode, size_t chan ) { if ( osmosdr::source::IQBalanceOff == mode ) { _src->set_iq_balance( std::complex(0.0, 0.0), chan ); /* uhd default */ } else if ( osmosdr::source::IQBalanceManual == mode ) { /* nothing to do */ } else if ( osmosdr::source::IQBalanceAutomatic == mode ) { throw std::runtime_error("Automatic IQ imbalance correction not implemented"); } } void uhd_source_c::set_iq_balance( const std::complex &balance, size_t chan ) { _src->set_iq_balance( balance, chan ); } double uhd_source_c::set_bandwidth( double bandwidth, size_t chan ) { _src->set_bandwidth(bandwidth, chan); return _src->get_bandwidth(chan); } double uhd_source_c::get_bandwidth( size_t chan ) { return _src->get_bandwidth(chan); } osmosdr::freq_range_t uhd_source_c::get_bandwidth_range( size_t chan ) { osmosdr::freq_range_t bandwidths; BOOST_FOREACH( uhd::range_t bw, _src->get_bandwidth_range(chan) ) bandwidths += osmosdr::range_t( bw.start(), bw.stop(), bw.step() ); return bandwidths; } gr-osmosdr-0.1.0.55.80c4af/lib/uhd/uhd_source_c.h000066400000000000000000000057021225753723100211740ustar00rootroot00000000000000/* -*- c++ -*- */ /* * Copyright 2012 Dimitri Stolnikov * * GNU Radio is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3, or (at your option) * any later version. * * GNU Radio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GNU Radio; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 51 Franklin Street, * Boston, MA 02110-1301, USA. */ #ifndef UHD_SOURCE_C_H #define UHD_SOURCE_C_H #include #include #include "source_iface.h" class uhd_source_c; typedef boost::shared_ptr< uhd_source_c > uhd_source_c_sptr; uhd_source_c_sptr make_uhd_source_c(const std::string &args = ""); class uhd_source_c : public gr::hier_block2, public source_iface { private: friend uhd_source_c_sptr make_uhd_source_c(const std::string &args); uhd_source_c(const std::string &args); public: ~uhd_source_c(); static std::vector< std::string > get_devices(); std::string name(); size_t get_num_channels( void ); osmosdr::meta_range_t get_sample_rates( void ); double set_sample_rate( double rate ); double get_sample_rate( void ); osmosdr::freq_range_t get_freq_range( size_t chan = 0 ); double set_center_freq( double freq, size_t chan = 0 ); double get_center_freq( size_t chan = 0 ); double set_freq_corr( double ppm, size_t chan = 0 ); double get_freq_corr( size_t chan = 0 ); std::vector get_gain_names( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( size_t chan = 0 ); osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 ); double set_gain( double gain, size_t chan = 0 ); double set_gain( double gain, const std::string & name, size_t chan = 0 ); double get_gain( size_t chan = 0 ); double get_gain( const std::string & name, size_t chan = 0 ); std::vector< std::string > get_antennas( size_t chan = 0 ); std::string set_antenna( const std::string & antenna, size_t chan = 0 ); std::string get_antenna( size_t chan = 0 ); void set_dc_offset_mode( int mode, size_t chan = 0 ); void set_dc_offset( const std::complex &offset, size_t chan = 0 ); void set_iq_balance_mode( int mode, size_t chan = 0 ); void set_iq_balance( const std::complex &balance, size_t chan = 0 ); double set_bandwidth( double bandwidth, size_t chan = 0 ); double get_bandwidth( size_t chan = 0 ); osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 ); private: double _center_freq; double _freq_corr; double _lo_offset; gr::uhd::usrp_source::sptr _src; }; #endif // UHD_SOURCE_C_H gr-osmosdr-0.1.0.55.80c4af/python/000077500000000000000000000000001225753723100163505ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/python/CMakeLists.txt000066400000000000000000000030331225753723100211070ustar00rootroot00000000000000# Copyright 2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # Include python install macros ######################################################################## include(GrPython) if(NOT PYTHONINTERP_FOUND) return() endif() ######################################################################## # Install python sources ######################################################################## GR_PYTHON_INSTALL( FILES __init__.py DESTINATION ${GR_PYTHON_DIR}/osmosdr ) ######################################################################## # Handle the unit tests ######################################################################## include(GrTest) set(GR_TEST_TARGET_DEPS gnuradio-osmosdr) set(GR_TEST_PYTHON_DIRS ${CMAKE_BINARY_DIR}/swig) gr-osmosdr-0.1.0.55.80c4af/python/__init__.py000066400000000000000000000034261225753723100204660ustar00rootroot00000000000000# # Copyright 2008,2009 Free Software Foundation, Inc. # # This application is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # This application is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License along # with this program; if not, write to the Free Software Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. # # The presence of this file turns this directory into a Python package ''' This is the GNU Radio OsmoSDR module. Place your Python package description here (python/__init__.py). ''' # ---------------------------------------------------------------- # Temporary workaround for ticket:181 (swig+python problem) import sys _RTLD_GLOBAL = 0 try: from dl import RTLD_GLOBAL as _RTLD_GLOBAL except ImportError: try: from DLFCN import RTLD_GLOBAL as _RTLD_GLOBAL except ImportError: pass if _RTLD_GLOBAL != 0: _dlopenflags = sys.getdlopenflags() sys.setdlopenflags(_dlopenflags|_RTLD_GLOBAL) # ---------------------------------------------------------------- # import swig generated symbols into the osmosdr namespace from osmosdr_swig import * # import any pure python here # # ---------------------------------------------------------------- # Tail of workaround if _RTLD_GLOBAL != 0: sys.setdlopenflags(_dlopenflags) # Restore original flags # ---------------------------------------------------------------- gr-osmosdr-0.1.0.55.80c4af/swig/000077500000000000000000000000001225753723100160005ustar00rootroot00000000000000gr-osmosdr-0.1.0.55.80c4af/swig/CMakeLists.txt000066400000000000000000000044161225753723100205450ustar00rootroot00000000000000# Copyright 2011 Free Software Foundation, Inc. # # This file is part of GNU Radio # # GNU Radio is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. # # GNU Radio is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with GNU Radio; see the file COPYING. If not, write to # the Free Software Foundation, Inc., 51 Franklin Street, # Boston, MA 02110-1301, USA. ######################################################################## # Include swig generation macros ######################################################################## find_package(SWIG) find_package(PythonLibs 2) if(NOT SWIG_FOUND OR NOT PYTHONLIBS_FOUND) return() endif() include(GrSwig) include(GrPython) ######################################################################## # Setup swig generation ######################################################################## foreach(incdir ${GNURADIO_RUNTIME_INCLUDE_DIRS}) list(APPEND GR_SWIG_INCLUDE_DIRS ${incdir}/swig) endforeach(incdir) foreach(incdir ${GNURADIO_RUNTIME_INCLUDE_DIRS}) list(APPEND GR_SWIG_INCLUDE_DIRS ${incdir}/gnuradio/swig) endforeach(incdir) set(GR_SWIG_LIBRARIES gnuradio-osmosdr) set(GR_SWIG_DOC_FILE ${CMAKE_CURRENT_BINARY_DIR}/osmosdr_swig_doc.i) set(GR_SWIG_DOC_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/../include) GR_SWIG_MAKE(osmosdr_swig osmosdr_swig.i) ######################################################################## # Install the build swig module ######################################################################## GR_SWIG_INSTALL(TARGETS osmosdr_swig DESTINATION ${GR_PYTHON_DIR}/osmosdr) ######################################################################## # Install swig .i files for development ######################################################################## install( FILES osmosdr_swig.i ${CMAKE_CURRENT_BINARY_DIR}/osmosdr_swig_doc.i DESTINATION ${GR_INCLUDE_DIR}/osmosdr/swig ) gr-osmosdr-0.1.0.55.80c4af/swig/osmosdr_swig.i000066400000000000000000000027441225753723100207000ustar00rootroot00000000000000/* -*- c++ -*- */ #define OSMOSDR_API // suppress Warning 319: No access specifier given for base class 'boost::noncopyable' (ignored). #pragma SWIG nowarn=319 %include "gnuradio.i" // the common stuff //load generated python docstrings %include "osmosdr_swig_doc.i" %{ #include "osmosdr/device.h" #include "osmosdr/source.h" #include "osmosdr/sink.h" %} // Workaround for a SWIG 2.0.4 bug with templates. Probably needs to be looked in to. %{ #if PY_VERSION_HEX >= 0x03020000 # define SWIGPY_SLICE_ARG(obj) ((PyObject*) (obj)) #else # define SWIGPY_SLICE_ARG(obj) ((PySliceObject*) (obj)) #endif %} %template(string_vector_t) std::vector; //%template(size_vector_t) std::vector; %include %ignore osmosdr::device_t::operator[]; //ignore warnings about %extend %template(string_string_dict_t) std::map; //define before device %template(devices_t) std::vector; %include %template(range_vector_t) std::vector; //define before range %include %define OSMOSDR_SWIG_BLOCK_MAGIC2(PKG, BASE_NAME) %template(BASE_NAME ## _sptr) boost::shared_ptr; %pythoncode %{ BASE_NAME ## _sptr.__repr__ = lambda self: "" % (self.name(), self.unique_id()) BASE_NAME = BASE_NAME.make; %} %enddef %include "osmosdr/source.h" %include "osmosdr/sink.h" OSMOSDR_SWIG_BLOCK_MAGIC2(osmosdr,source); OSMOSDR_SWIG_BLOCK_MAGIC2(osmosdr,sink);