Compare commits
219 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 9dcb838a75 | |||
| ad0598e4a8 | |||
| a4822168b7 | |||
| f56251d471 | |||
| b327e06ac5 | |||
| 7e9c132dfb | |||
| ac55ae7ca1 | |||
| 32552e1f79 | |||
| 202f63bfa6 | |||
| bb646ed472 | |||
| 5c6cb3ff19 | |||
| ce7097384b | |||
| 27c8fdfe4a | |||
| c431137c71 | |||
| abed50bf7f | |||
| 965e2d474f | |||
| 1b88193094 | |||
| 83c02a1b66 | |||
| 3898a21350 | |||
| 08cdcf7a4e | |||
| 29ca2bde94 | |||
| fe725a1c6d | |||
| 56d8c5c19f | |||
| b3dc15a567 | |||
| 5e02723e67 | |||
| a0e81851b0 | |||
| 0c0fca8ec9 | |||
| dec30cbed4 | |||
| c19b0ad2b5 | |||
| ef5fd6c595 | |||
| cba532a33f | |||
| 586ba0a85e | |||
| ef14207914 | |||
| 983bf13b7f | |||
| afe85e2c71 | |||
| cd0bb1fafd | |||
| 6b5a8c1ddc | |||
| 4d1befbc05 | |||
| 24f72aaf08 | |||
| e620d48c81 | |||
| 4f069d6518 | |||
| 3d8a172acc | |||
| a2491b5474 | |||
| 5f7e102e3d | |||
| 6cd3b5bd10 | |||
| 4d12149cfb | |||
| 7e3107282a | |||
| 51f7d6b284 | |||
| 45fd47b6ec | |||
| 844424404d | |||
| 228d1b1bcc | |||
| 4a3f387d6d | |||
| 0b095e0ff7 | |||
| 8ca5dcedde | |||
| d8f45138a2 | |||
| e2a59771ed | |||
| 002df040ff | |||
| 0f659b4d50 | |||
| ae1286a727 | |||
| 7a2cbdb8d8 | |||
| d63adab8f1 | |||
| 99f1a4564f | |||
| c3e8688859 | |||
| 4f034c9722 | |||
| 763d55d9f2 | |||
| a17bd7bf3a | |||
| f66f1eea8a | |||
| 14d8dfcb5d | |||
| eea1ffa3bc | |||
| 30be96a165 | |||
| 9393abbf65 | |||
| 39861c37af | |||
| 8bffcf7faf | |||
| 358bb5ccaa | |||
| fee31310e5 | |||
| c80340df6e | |||
| 5c7879feaf | |||
| 4555253ab9 | |||
| 3ccf528a96 | |||
| b8b91a0c88 | |||
| f956d36ce4 | |||
| 3143469287 | |||
| 4cddc2b740 | |||
| d730126586 | |||
| b83d008fc8 | |||
| 08787e1ddb | |||
| 5827b77c19 | |||
| be0e79d41b | |||
| e8922f3e3a | |||
| 0d5c8c60c7 | |||
| e07d85547d | |||
| 2d3201c7a1 | |||
| 333999630d | |||
| 54ef06a167 | |||
| 1624842801 | |||
| 872b2dd0af | |||
| df0d480c59 | |||
| 26a0c2c87e | |||
| d90b28c55b | |||
| 6dc42c7f43 | |||
| fc429e7f17 | |||
| 44561c1578 | |||
| d1667da2d4 | |||
| 951d8fd547 | |||
| 7b119ba59e | |||
| 21bcc8b639 | |||
| 144cbbf796 | |||
| 691cf04a8f | |||
| 429647eff1 | |||
| 1dcdcce729 | |||
| 528536e3f2 | |||
| 9cf628359b | |||
| c6502ae022 | |||
| d96ffc6ec8 | |||
| 0f5215d921 | |||
| 22f761d7d0 | |||
| 4a1bd44033 | |||
| 65ec683d8e | |||
| f7365d081a | |||
| 5bed2d13e6 | |||
| 3523807c09 | |||
| 1ef58db9c6 | |||
| 84c9ff3e0d | |||
| 6f5faecabd | |||
| 285a0e2558 | |||
| c1d50c7ff2 | |||
| 0bd2e30f55 | |||
| 8530b92086 | |||
| 26514acfef | |||
| 95b4798c6b | |||
| 743504ccdd | |||
| fff13b2443 | |||
| 88e17d6176 | |||
| bef6e3d962 | |||
| da1b0eb713 | |||
| 23a195311a | |||
| 43abd875d9 | |||
| c1fde325a5 | |||
| baa5b07152 | |||
| f543a8598c | |||
| ba50c10a02 | |||
| 68158e14f7 | |||
| 58b3ffb94d | |||
| d16559b105 | |||
| c3195613ba | |||
| cc0a56e341 | |||
| 5ddba507e5 | |||
| 397e9faaaa | |||
| 30862c0ff8 | |||
| 0b833da040 | |||
| c05497dc19 | |||
| ece3cbf5bb | |||
| c3291917c8 | |||
| d1d33c90eb | |||
| 1ed08f6e9a | |||
| dd89949184 | |||
| 9ca1f310f5 | |||
| aa8d43508e | |||
| 052d5022b0 | |||
| 5a9846fa67 | |||
| 6bcf462aa5 | |||
| 325c0400d2 | |||
| 4c710aec25 | |||
| 7f95f47ec6 | |||
| f9aa4b5ec2 | |||
| 760fc86101 | |||
| 0f56254df3 | |||
| 74ae445143 | |||
| 3703abbbf1 | |||
| fb14006c4b | |||
| b16ac24359 | |||
| e815faa792 | |||
| 298d9823cc | |||
| 17abd32ca9 | |||
| 9d593483bf | |||
| 4a43c572b3 | |||
| 253c26c48f | |||
| ae168184bc | |||
| 566de26230 | |||
| 01d40ec00b | |||
| 0e11d51b01 | |||
| 77ed9e84c2 | |||
| 3ae290ec87 | |||
| 72d089d9cc | |||
| a47ae95ce5 | |||
| b781cea7eb | |||
| 81ff17ccd5 | |||
| 246c394658 | |||
| 676963604f | |||
| 3ba472ab7c | |||
| 2853ddaa00 | |||
| a42e59c5b9 | |||
| fd64759c5a | |||
| 39017c8b20 | |||
| a812150eac | |||
| 016616d915 | |||
| 9176a3d615 | |||
| 7e793f0d5b | |||
| 9b7c568868 | |||
| c0fab12da3 | |||
| 66ab958b6e | |||
| 940a1a1ccf | |||
| 39db4c91e8 | |||
| 06c2e09234 | |||
| 6148463e61 | |||
| 63dc634cc4 | |||
| 7eae9a9bf9 | |||
| 12f2b0e913 | |||
| d1d6ed6010 | |||
| 481d873f2e | |||
| 009490b8c9 | |||
| 33a75673b2 | |||
| 6fb8a97cfd | |||
| 1eb5ac46ef | |||
| 77548c73a9 | |||
| 9ba6e4af39 | |||
| 2841634b1c | |||
| b3442dad46 | |||
| 123628146e |
+104
@@ -0,0 +1,104 @@
|
|||||||
|
---
|
||||||
|
Language: Cpp
|
||||||
|
# BasedOnStyle: LLVM
|
||||||
|
AccessModifierOffset: -4
|
||||||
|
AlignAfterOpenBracket: Align
|
||||||
|
AlignConsecutiveAssignments: false
|
||||||
|
AlignConsecutiveDeclarations: false
|
||||||
|
AlignEscapedNewlinesLeft: true
|
||||||
|
AlignOperands: true
|
||||||
|
AlignTrailingComments: true
|
||||||
|
AllowAllParametersOfDeclarationOnNextLine: true
|
||||||
|
AllowShortBlocksOnASingleLine: false
|
||||||
|
AllowShortCaseLabelsOnASingleLine: false
|
||||||
|
AllowShortFunctionsOnASingleLine: All
|
||||||
|
AllowShortIfStatementsOnASingleLine: false
|
||||||
|
AllowShortLoopsOnASingleLine: false
|
||||||
|
AlwaysBreakAfterDefinitionReturnType: None
|
||||||
|
AlwaysBreakAfterReturnType: None
|
||||||
|
AlwaysBreakBeforeMultilineStrings: false
|
||||||
|
AlwaysBreakTemplateDeclarations: true
|
||||||
|
BinPackArguments: false
|
||||||
|
BinPackParameters: false
|
||||||
|
BreakBeforeBraces: Custom
|
||||||
|
BraceWrapping:
|
||||||
|
AfterClass: true
|
||||||
|
AfterControlStatement: false
|
||||||
|
AfterEnum: false
|
||||||
|
AfterFunction: true
|
||||||
|
AfterNamespace: false
|
||||||
|
AfterObjCDeclaration: false
|
||||||
|
AfterStruct: false
|
||||||
|
AfterUnion: false
|
||||||
|
BeforeCatch: false
|
||||||
|
BeforeElse: false
|
||||||
|
IndentBraces: false
|
||||||
|
BreakBeforeBinaryOperators: None
|
||||||
|
BreakBeforeTernaryOperators: true
|
||||||
|
BreakConstructorInitializersBeforeComma: false
|
||||||
|
BreakAfterJavaFieldAnnotations: false
|
||||||
|
BreakStringLiterals: true
|
||||||
|
ColumnLimit: 90
|
||||||
|
CommentPragmas: '^ IWYU pragma:'
|
||||||
|
ConstructorInitializerAllOnOneLineOrOnePerLine: true
|
||||||
|
ConstructorInitializerIndentWidth: 4
|
||||||
|
ContinuationIndentWidth: 4
|
||||||
|
Cpp11BracedListStyle: false
|
||||||
|
DerivePointerAlignment: false
|
||||||
|
DisableFormat: false
|
||||||
|
ExperimentalAutoDetectBinPacking: false
|
||||||
|
ForEachMacros:
|
||||||
|
- foreach
|
||||||
|
- Q_FOREACH
|
||||||
|
- BOOST_FOREACH
|
||||||
|
IncludeCategories:
|
||||||
|
- Regex: '^"(gnuradio)/'
|
||||||
|
Priority: 1
|
||||||
|
- Regex: '^<(gnuradio)/'
|
||||||
|
Priority: 2
|
||||||
|
- Regex: '^<(boost)/'
|
||||||
|
Priority: 98
|
||||||
|
- Regex: '^<[a-z]*>$'
|
||||||
|
Priority: 99
|
||||||
|
- Regex: '^".*"$'
|
||||||
|
Priority: 0
|
||||||
|
- Regex: '.*'
|
||||||
|
Priority: 10
|
||||||
|
|
||||||
|
IncludeIsMainRegex: '(Test)?$'
|
||||||
|
IndentCaseLabels: false
|
||||||
|
IndentWidth: 4
|
||||||
|
IndentWrappedFunctionNames: false
|
||||||
|
JavaScriptQuotes: Leave
|
||||||
|
JavaScriptWrapImports: true
|
||||||
|
KeepEmptyLinesAtTheStartOfBlocks: true
|
||||||
|
MacroBlockBegin: ''
|
||||||
|
MacroBlockEnd: ''
|
||||||
|
MaxEmptyLinesToKeep: 2
|
||||||
|
NamespaceIndentation: None
|
||||||
|
ObjCBlockIndentWidth: 2
|
||||||
|
ObjCSpaceAfterProperty: false
|
||||||
|
ObjCSpaceBeforeProtocolList: true
|
||||||
|
PenaltyBreakBeforeFirstCallParameter: 19
|
||||||
|
PenaltyBreakComment: 300
|
||||||
|
PenaltyBreakFirstLessLess: 120
|
||||||
|
PenaltyBreakString: 1000
|
||||||
|
PenaltyExcessCharacter: 1000000
|
||||||
|
PenaltyReturnTypeOnItsOwnLine: 60
|
||||||
|
PointerAlignment: Left
|
||||||
|
ReflowComments: true
|
||||||
|
SortIncludes: true
|
||||||
|
SpaceAfterCStyleCast: false
|
||||||
|
SpaceAfterTemplateKeyword: true
|
||||||
|
SpaceBeforeAssignmentOperators: true
|
||||||
|
SpaceBeforeParens: ControlStatements
|
||||||
|
SpaceInEmptyParentheses: false
|
||||||
|
SpacesBeforeTrailingComments: 1
|
||||||
|
SpacesInAngles: false
|
||||||
|
SpacesInContainerLiterals: true
|
||||||
|
SpacesInCStyleCastParentheses: false
|
||||||
|
SpacesInParentheses: false
|
||||||
|
SpacesInSquareBrackets: false
|
||||||
|
Standard: Cpp11
|
||||||
|
TabWidth: 8
|
||||||
|
UseTab: Never
|
||||||
@@ -0,0 +1,110 @@
|
|||||||
|
# gr-ieee802_11 conda recipe
|
||||||
|
|
||||||
|
This recipe is for creating a package that can be installed into a [conda](https://docs.conda.io/en/latest/) environment. See the [Conda GNU Radio Guide](https://wiki.gnuradio.org/index.php/CondaInstall) for more information on using GNU Radio with conda.
|
||||||
|
|
||||||
|
Packages for GNU Radio and some out-of-tree (OOT) modules are available through the [`conda-forge` channel](https://conda-forge.org/). If this OOT module is already available (search "gnuradio" on [anaconda.org](https://anaconda.org)), it is preferable to use that existing package rather than this recipe.
|
||||||
|
|
||||||
|
#### Users
|
||||||
|
|
||||||
|
- [Building the package](#building-the-package)
|
||||||
|
|
||||||
|
#### Developers
|
||||||
|
|
||||||
|
- [Modifying the recipe](#modifying-the-recipe)
|
||||||
|
- [Continuous integration](#continuous-integration)
|
||||||
|
|
||||||
|
|
||||||
|
## Building the package
|
||||||
|
|
||||||
|
(See the [Conda GNU Radio Guide](https://wiki.gnuradio.org/index.php/CondaInstall) if you are unfamiliar with how to use conda.)
|
||||||
|
|
||||||
|
1. Make sure that have `conda-build` and `conda-forge-pinning` installed and updated in your base environment:
|
||||||
|
|
||||||
|
conda activate base
|
||||||
|
conda install -n base conda-build conda-forge-pinning
|
||||||
|
conda upgrade -n base conda-build conda-forge-pinning
|
||||||
|
|
||||||
|
**Windows users only**: you will also need to have Microsoft's Visual C++ build tools installed. Usually you can do this by installing the [Community edition of Visual Studio](https://visualstudio.microsoft.com/free-developer-offers/) and then selecting a MSVC C++ x64/x86 build tools component under the list of "Individual Components". As of this writing, you will specifically need MSVC v141, i.e. the "MSVC v141 - VS2017 C++ x64/x86 build tools (v14.16)" component. If the build fails to find the version of MSVC it is looking for, try installing other (newer) versions.
|
||||||
|
|
||||||
|
2. Download the source code for this OOT module (which includes this recipe). Typically, this is done by using `git` and cloning the module's repository:
|
||||||
|
|
||||||
|
git clone <repository_url>
|
||||||
|
cd <repository_name>
|
||||||
|
|
||||||
|
3. Run `conda-build` on the recipe to create the package:
|
||||||
|
|
||||||
|
(Linux and macOS)
|
||||||
|
|
||||||
|
conda build .conda/recipe/ -m ${CONDA_PREFIX}/conda_build_config.yaml
|
||||||
|
|
||||||
|
(Windows)
|
||||||
|
|
||||||
|
conda build .conda\recipe\ -m %CONDA_PREFIX%\conda_build_config.yaml
|
||||||
|
|
||||||
|
If you plan on using this package within an existing environment which uses a specific version of Python, specify the version of Python using the `--python` flag. You must use a version string that matches one of the strings listed under `python` in the `${CONDA_PREFIX}/conda_build_config.yaml` file, e.g:
|
||||||
|
|
||||||
|
(Linux and macOS)
|
||||||
|
|
||||||
|
conda build .conda/recipe/ -m ${CONDA_PREFIX}/conda_build_config.yaml --python="3.9.* *_cpython"
|
||||||
|
|
||||||
|
(Windows)
|
||||||
|
|
||||||
|
conda build .conda\recipe\ -m %CONDA_PREFIX%\conda_build_config.yaml --python="3.9.* *_cpython"
|
||||||
|
|
||||||
|
If you encounter errors, consult with the OOT module maintainer or the maintainers of the [gnuradio feedstock](https://github.com/conda-forge/gnuradio-feedstock). It is possible that the recipe will need to be updated.
|
||||||
|
|
||||||
|
4. Install the package into an existing environment
|
||||||
|
|
||||||
|
conda install --use-local -n <environment_name> gnuradio-EXAMPLE
|
||||||
|
|
||||||
|
or create a new environment that includes the package:
|
||||||
|
|
||||||
|
conda create -n test_env gnuradio-EXAMPLE
|
||||||
|
|
||||||
|
|
||||||
|
## Modifying the recipe
|
||||||
|
|
||||||
|
This recipe is derived from a template, and so it is best to check it and make any necessary modifications. Likely changes include:
|
||||||
|
|
||||||
|
- Populating metadata near the bottom of the `recipe/meta.yaml` file
|
||||||
|
- Adding "host" (build-time) and "run" (run-time) dependencies specific to your module in `recipe/meta.yaml`
|
||||||
|
- Adding special configuration flags or steps are necessary to carry out the build to the build scripts (`recipe/build.sh` for Linux/macOS and `recipe/bld.bat` for Windows)
|
||||||
|
|
||||||
|
Specifying the versions of GNU Radio that your OOT is compatible with is one of the most important modifications. Following the instructions below, the module will be built against the conda-forge "pinned" version of GNU Radio, which is usually the latest version.
|
||||||
|
|
||||||
|
- To override the pinned version of GNU Radio (e.g. for a branch that builds against an older version), specify the `gnuradio_core` key as instructed in `recipe/conda_build_config.yaml`.
|
||||||
|
- If the module is compatible with multiple major versions of GNU Radio, and you want to build against multiple of them, you can also add extra versions to `recipe/conda_build_config.yaml` to expand the default build matrix.
|
||||||
|
|
||||||
|
See the [conda-build documentation](https://docs.conda.io/projects/conda-build/en/latest/index.html) for details on how to write a conda recipe.
|
||||||
|
|
||||||
|
|
||||||
|
## Continuous integration
|
||||||
|
|
||||||
|
Only a few steps are needed to use this recipe to build and test this OOT module using CI services. It can also be used to upload packages to [anaconda.org](https://anaconda.org) for others to download and use.
|
||||||
|
|
||||||
|
1. Make sure that have `conda-smithy` installed in your base conda environment:
|
||||||
|
|
||||||
|
conda activate base
|
||||||
|
conda install -n base conda-smithy
|
||||||
|
conda upgrade -n base conda-smithy
|
||||||
|
|
||||||
|
2. Make any changes to the recipe and `conda-forge.yml` that are necessary. For example, if you plan on uploading packages to your own [anaconda.org](https://anaconda.org) channel, specify the channel name and label as the `channel_targets` key in `recipe/conda_build_config.yaml`. Commit the changes to your repository:
|
||||||
|
|
||||||
|
git commit -a
|
||||||
|
|
||||||
|
3. "Re-render" the CI scripts by running conda-smithy from the root of your repository:
|
||||||
|
|
||||||
|
conda-smithy rerender --feedstock_config .conda/conda-forge.yml -c auto
|
||||||
|
|
||||||
|
This will create a commit that adds or updates the CI scripts that have been configured with `conda-forge.yml`. If you want to minimize extraneous files, you can remove some of the newly-created files that are not necessary outside of a typical conda-forge feedstock:
|
||||||
|
|
||||||
|
git rm -f .github/workflows/automerge.yml .github/workflows/webservices.yml .circleci/config.yml
|
||||||
|
git commit --amend -s
|
||||||
|
|
||||||
|
When the CI is executed (on a pull request or commit), it will run one job per configuration file in `.ci_support` to build packages for various platforms, Python versions, and optionally `gnuradio` versions (by adding to `gnuradio_extra_pin` in `recipe/conda_build_config.yaml`).
|
||||||
|
|
||||||
|
**You should repeat this step whenever the recipe is updated or when changes to the conda-forge infrastructure require all CI scripts to be updated.**
|
||||||
|
|
||||||
|
Since the newly created files will be rewritten whenever conda-smithy is run, you should not edit any of the automatically-generated files in e.g. `.ci_support`, `.scripts`, or `.github/workflows/conda-build.yml`.
|
||||||
|
|
||||||
|
4. (optional) If you want to enable uploads of the packages to [anaconda.org](https://anaconda.org) whenever the CI is run from a commit on the branch specified in `conda-forge.yml`, you need to set an Anaconda Cloud API token to the `BINSTAR_TOKEN` environment variable. To generate a token, follow the instructions [here](https://docs.anaconda.com/anacondaorg/user-guide/tasks/work-with-accounts/#creating-access-tokens). To populate the `BINSTAR_TOKEN` environment variable for CI jobs, add the token as a secret by following, for example, the [Github docs](https://docs.github.com/en/actions/reference/encrypted-secrets).
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
# See https://conda-forge.org/docs/maintainer/conda_forge_yml.html for
|
||||||
|
# documentation on possible keys and values.
|
||||||
|
|
||||||
|
# uncomment to enable cross-compiled osx-arm64 builds
|
||||||
|
build_platform:
|
||||||
|
linux_aarch64: linux_64
|
||||||
|
linux_ppc64le: linux_64
|
||||||
|
osx_arm64: osx_64
|
||||||
|
clone_depth: 0
|
||||||
|
conda_build:
|
||||||
|
pkg_format: '2'
|
||||||
|
github_actions:
|
||||||
|
store_build_artifacts: true
|
||||||
|
os_version:
|
||||||
|
linux_64: cos7
|
||||||
|
provider:
|
||||||
|
linux: github_actions
|
||||||
|
osx: github_actions
|
||||||
|
win: github_actions
|
||||||
|
# uncomment to enable additional linux platforms
|
||||||
|
#linux_aarch64: github_actions
|
||||||
|
#linux_ppc64le: github_actions
|
||||||
|
recipe_dir: .conda/recipe
|
||||||
|
# skip unnecessary files since this is not a full-fledged conda-forge feedstock
|
||||||
|
skip_render:
|
||||||
|
- README.md
|
||||||
|
- LICENSE.txt
|
||||||
|
- .gitattributes
|
||||||
|
- .gitignore
|
||||||
|
- build-locally.py
|
||||||
|
- LICENSE
|
||||||
|
test: native_and_emulated
|
||||||
|
# enable uploads to Anaconda Cloud from specified branches only
|
||||||
|
upload_on_branch: main
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
setlocal EnableDelayedExpansion
|
||||||
|
@echo on
|
||||||
|
|
||||||
|
:: Make a build folder and change to it
|
||||||
|
cmake -E make_directory buildconda
|
||||||
|
cd buildconda
|
||||||
|
|
||||||
|
:: configure
|
||||||
|
cmake -G "Ninja" ^
|
||||||
|
-DCMAKE_BUILD_TYPE:STRING=Release ^
|
||||||
|
-DCMAKE_INSTALL_PREFIX:PATH="%LIBRARY_PREFIX%" ^
|
||||||
|
-DCMAKE_PREFIX_PATH:PATH="%LIBRARY_PREFIX%" ^
|
||||||
|
-DGR_PYTHON_DIR:PATH="%SP_DIR%" ^
|
||||||
|
-DENABLE_DOXYGEN=OFF ^
|
||||||
|
-DENABLE_TESTING=ON ^
|
||||||
|
..
|
||||||
|
if errorlevel 1 exit 1
|
||||||
|
|
||||||
|
:: build
|
||||||
|
cmake --build . --config Release -- -j%CPU_COUNT%
|
||||||
|
if errorlevel 1 exit 1
|
||||||
|
|
||||||
|
:: install
|
||||||
|
cmake --build . --config Release --target install
|
||||||
|
if errorlevel 1 exit 1
|
||||||
|
|
||||||
|
:: test
|
||||||
|
ctest --build-config Release --output-on-failure --timeout 120 -j%CPU_COUNT%
|
||||||
|
if errorlevel 1 exit 1
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
set -ex
|
||||||
|
|
||||||
|
cmake -E make_directory buildconda
|
||||||
|
cd buildconda
|
||||||
|
|
||||||
|
cmake_config_args=(
|
||||||
|
-DCMAKE_BUILD_TYPE=Release
|
||||||
|
-DCMAKE_INSTALL_PREFIX=$PREFIX
|
||||||
|
-DLIB_SUFFIX=""
|
||||||
|
-DENABLE_DOXYGEN=OFF
|
||||||
|
-DENABLE_TESTING=ON
|
||||||
|
)
|
||||||
|
|
||||||
|
cmake ${CMAKE_ARGS} -G "Ninja" .. "${cmake_config_args[@]}"
|
||||||
|
cmake --build . --config Release -- -j${CPU_COUNT}
|
||||||
|
cmake --build . --config Release --target install
|
||||||
|
|
||||||
|
if [[ "${CONDA_BUILD_CROSS_COMPILATION:-}" != "1" || "${CROSSCOMPILING_EMULATOR}" != "" ]]; then
|
||||||
|
ctest --build-config Release --output-on-failure --timeout 120 -j${CPU_COUNT}
|
||||||
|
fi
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
channel_sources:
|
||||||
|
- conda-forge,ryanvolz
|
||||||
|
# this is the channel and label where packages will be uploaded to if enabled
|
||||||
|
# (see ../README.md)
|
||||||
|
channel_targets:
|
||||||
|
- gnuradio main
|
||||||
|
# override the conda-forge pin for gnuradio-core by uncommenting
|
||||||
|
# and specifying a different version here
|
||||||
|
#gnuradio_core:
|
||||||
|
#- "3.10.1"
|
||||||
|
gnuradio_extra_pin:
|
||||||
|
# always leave one entry with the empty string
|
||||||
|
- ""
|
||||||
|
# add version strings here like to get builds for versions other than
|
||||||
|
# the conda-forge-wide default or version specified above for gnuradio_core
|
||||||
|
#- "3.9.5"
|
||||||
@@ -0,0 +1,93 @@
|
|||||||
|
{% set oot_name = "ieee802_11" %}
|
||||||
|
{% set name = "gnuradio-" + oot_name %}
|
||||||
|
# Set package version from cleaned up git tags if possible,
|
||||||
|
# otherwise fall back to date-based version.
|
||||||
|
{% set tag_version = environ.get("GIT_DESCRIBE_TAG", "")|string|replace("-","_")|replace("v","")|replace("git","") %}
|
||||||
|
{% set post_commit = environ.get("GIT_DESCRIBE_NUMBER", 0)|string %}
|
||||||
|
{% set hash = environ.get("GIT_DESCRIBE_HASH", "local")|string %}
|
||||||
|
{% set fallback_version = "0.0.0.{0}.dev+g{1}".format(datetime.datetime.now().strftime("%Y%m%d"), environ.get("GIT_FULL_HASH", "local")[:9]) %}
|
||||||
|
{% set version = (tag_version if post_commit == "0" else "{0}.post{1}+{2}".format(tag_version, post_commit, hash)) if tag_version else fallback_version %}
|
||||||
|
|
||||||
|
package:
|
||||||
|
name: {{ name|lower }}
|
||||||
|
version: {{ version }}
|
||||||
|
|
||||||
|
source:
|
||||||
|
# use local path or git repository depending on if the build is local or done on CI
|
||||||
|
path: "../.." # [not os.environ.get("CI")]
|
||||||
|
git_url: {{ environ.get('FEEDSTOCK_ROOT', "../..") }} # [os.environ.get("CI")]
|
||||||
|
|
||||||
|
build:
|
||||||
|
number: 0
|
||||||
|
|
||||||
|
requirements:
|
||||||
|
build:
|
||||||
|
- {{ compiler("c") }}
|
||||||
|
- {{ compiler("cxx") }}
|
||||||
|
- cmake
|
||||||
|
- git
|
||||||
|
- ninja
|
||||||
|
- pkg-config
|
||||||
|
# cross-compilation requirements
|
||||||
|
- python # [build_platform != target_platform]
|
||||||
|
- cross-python_{{ target_platform }} # [build_platform != target_platform]
|
||||||
|
- numpy # [build_platform != target_platform]
|
||||||
|
- pybind11 # [build_platform != target_platform]
|
||||||
|
|
||||||
|
host:
|
||||||
|
- boost-cpp
|
||||||
|
- fmt
|
||||||
|
- gmp # [linux]
|
||||||
|
# the following two entries are for generating builds against specific GR versions
|
||||||
|
- gnuradio-core # [not gnuradio_extra_pin]
|
||||||
|
- gnuradio-core {{ gnuradio_extra_pin }}.* # [gnuradio_extra_pin]
|
||||||
|
- pip # [win]
|
||||||
|
- pybind11
|
||||||
|
- python
|
||||||
|
- numpy
|
||||||
|
- spdlog
|
||||||
|
- volk
|
||||||
|
|
||||||
|
run:
|
||||||
|
- gnuradio-foo
|
||||||
|
- numpy
|
||||||
|
- pyopengl
|
||||||
|
- python
|
||||||
|
|
||||||
|
test:
|
||||||
|
commands:
|
||||||
|
# verify that (some) headers get installed
|
||||||
|
- test -f $PREFIX/include/{{ oot_name }}/api.h # [not win]
|
||||||
|
- if not exist %PREFIX%\\Library\\include\\{{ oot_name }}\\api.h exit 1 # [win]
|
||||||
|
|
||||||
|
# verify that libraries get installed
|
||||||
|
- test -f $PREFIX/lib/lib{{ name }}${SHLIB_EXT} # [not win]
|
||||||
|
- if not exist %PREFIX%\\Library\\bin\\{{ name }}.dll exit 1 # [win]
|
||||||
|
- if not exist %PREFIX%\\Library\\lib\\{{ name }}.lib exit 1 # [win]
|
||||||
|
|
||||||
|
# verify that (some) GRC blocks get installed
|
||||||
|
{% set blocks = ["chunks_to_symbols", "decode_mac", "ether_encap", "extract_csi", "frame_equalizer", "mac", "mapper", "parse_mac", "sync_long", "sync_short"] %}
|
||||||
|
{% for block in blocks %}
|
||||||
|
- test -f $PREFIX/share/gnuradio/grc/blocks/{{ oot_name }}_{{ block }}.block.yml # [not win]
|
||||||
|
- if not exist %PREFIX%\\Library\\share\\gnuradio\\grc\\blocks\\{{ oot_name }}_{{ block }}.block.yml exit 1 # [win]
|
||||||
|
{% endfor %}
|
||||||
|
|
||||||
|
imports:
|
||||||
|
# verify that the python module imports
|
||||||
|
- {{ oot_name }}
|
||||||
|
|
||||||
|
about:
|
||||||
|
home: https://github.com/bastibl/gr-ieee802-11
|
||||||
|
license: GPL-3.0-or-later
|
||||||
|
license_file: LICENSE
|
||||||
|
summary: IEEE 802.11 a/g/p Transceiver for GNU Radio
|
||||||
|
description: >
|
||||||
|
This an IEEE 802.11 a/g/p transceiver for GNU Radio that is fitted for
|
||||||
|
operation with Ettus N210s and B210s. Interoperability was tested with many
|
||||||
|
off-the-shelf WiFi cards and IEEE 802.11p prototypes. The code can also be
|
||||||
|
used in simulations.
|
||||||
|
|
||||||
|
Example gnuradio-companion flowgraphs are installed with the package and
|
||||||
|
can be found in:
|
||||||
|
- (Linux/macOS) `$CONDA_PREFIX/share/gr-ieee802_11/examples`
|
||||||
|
- (Windows) `%CONDA_PREFIX%\share\gr-ieee802_11\examples`
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# In GNU Radio 3.9+, pybind11 compares hash values of headers and source
|
||||||
|
# files against knowns values. Conversion of values to CRLF on checkout
|
||||||
|
# break those checks so keep LF values when files are subject to said checks
|
||||||
|
#
|
||||||
|
*.h text eol=lf
|
||||||
|
*.c text eol=lf
|
||||||
|
*.cc text eol=lf
|
||||||
+6
-1
@@ -1,7 +1,12 @@
|
|||||||
build
|
|
||||||
examples/*.py
|
examples/*.py
|
||||||
.cproject
|
.cproject
|
||||||
.project
|
.project
|
||||||
.pydevproject
|
.pydevproject
|
||||||
.settings
|
.settings
|
||||||
|
**/.DS_Store
|
||||||
|
.clang_complete
|
||||||
|
*~
|
||||||
*.pyc
|
*.pyc
|
||||||
|
*.pyo
|
||||||
|
build*/
|
||||||
|
examples/grc/*.py
|
||||||
|
|||||||
+95
-95
@@ -1,108 +1,95 @@
|
|||||||
|
# Copyright 2011-2020 Free Software Foundation, Inc.
|
||||||
#
|
#
|
||||||
# Copyright 2013 Free Software Foundation, Inc.
|
# This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
# This file is a part of gr-ieee802_11
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
# 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 <http://www.gnu.org/licenses/>.
|
|
||||||
#
|
#
|
||||||
|
|
||||||
########################################################################
|
########################################################################
|
||||||
# Project setup
|
# Project setup
|
||||||
########################################################################
|
########################################################################
|
||||||
cmake_minimum_required(VERSION 2.6)
|
cmake_minimum_required(VERSION 3.8)
|
||||||
project(gr-ieee802-11 CXX C)
|
project(gr-ieee802_11 CXX C)
|
||||||
enable_testing()
|
enable_testing()
|
||||||
|
|
||||||
#select the release build type by default to get optimization flags
|
# Install to PyBOMBS target prefix if defined
|
||||||
|
if(DEFINED ENV{PYBOMBS_PREFIX})
|
||||||
|
set(CMAKE_INSTALL_PREFIX $ENV{PYBOMBS_PREFIX})
|
||||||
|
message(STATUS "PyBOMBS installed GNU Radio. Setting CMAKE_INSTALL_PREFIX to $ENV{PYBOMBS_PREFIX}")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
# Select the release build type by default to get optimization flags
|
||||||
if(NOT CMAKE_BUILD_TYPE)
|
if(NOT CMAKE_BUILD_TYPE)
|
||||||
set(CMAKE_BUILD_TYPE "Release")
|
set(CMAKE_BUILD_TYPE "Release")
|
||||||
message(STATUS "Build type not specified: defaulting to release.")
|
message(STATUS "Build type not specified: defaulting to release.")
|
||||||
endif(NOT CMAKE_BUILD_TYPE)
|
endif(NOT CMAKE_BUILD_TYPE)
|
||||||
set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} CACHE STRING "")
|
set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} CACHE STRING "")
|
||||||
|
|
||||||
|
# Make sure our local CMake Modules path comes first
|
||||||
list(INSERT CMAKE_MODULE_PATH 0 ${CMAKE_SOURCE_DIR}/cmake/Modules)
|
list(INSERT CMAKE_MODULE_PATH 0 ${CMAKE_SOURCE_DIR}/cmake/Modules)
|
||||||
|
|
||||||
|
# Set the version information here
|
||||||
|
set(VERSION_MAJOR 1)
|
||||||
|
set(VERSION_API 1)
|
||||||
|
set(VERSION_ABI 0)
|
||||||
|
set(VERSION_PATCH git)
|
||||||
|
|
||||||
|
cmake_policy(SET CMP0011 NEW)
|
||||||
|
|
||||||
|
# Enable generation of compile_commands.json for code completion engines
|
||||||
|
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
|
||||||
|
|
||||||
########################################################################
|
########################################################################
|
||||||
# Compiler specific setup
|
# Compiler specific setup
|
||||||
########################################################################
|
########################################################################
|
||||||
if(NOT WIN32)
|
if((CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR
|
||||||
|
CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
|
||||||
|
AND NOT WIN32)
|
||||||
#http://gcc.gnu.org/wiki/Visibility
|
#http://gcc.gnu.org/wiki/Visibility
|
||||||
add_definitions(-fvisibility=hidden)
|
add_definitions(-fvisibility=hidden)
|
||||||
add_definitions(-std=c++0x)
|
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
########################################################################
|
IF(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
|
||||||
# Find boost
|
SET(CMAKE_CXX_STANDARD 14)
|
||||||
########################################################################
|
ELSEIF(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
|
||||||
if(UNIX AND EXISTS "/usr/lib64")
|
SET(CMAKE_CXX_STANDARD 14)
|
||||||
list(APPEND BOOST_LIBRARYDIR "/usr/lib64") #fedora 64-bit fix
|
ELSEIF(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
|
||||||
endif(UNIX AND EXISTS "/usr/lib64")
|
SET(CMAKE_CXX_STANDARD 14)
|
||||||
set(Boost_ADDITIONAL_VERSIONS
|
ELSE()
|
||||||
"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"
|
message(WARNING "C++ standard could not be set because compiler is not GNU, Clang or MSVC.")
|
||||||
"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"
|
ENDIF()
|
||||||
"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 "1.35" COMPONENTS filesystem system)
|
|
||||||
|
|
||||||
if(NOT Boost_FOUND)
|
IF(CMAKE_C_COMPILER_ID STREQUAL "GNU")
|
||||||
message(FATAL_ERROR "Boost required to compile ieee802-11")
|
SET(CMAKE_C_STANDARD 11)
|
||||||
endif()
|
ELSEIF(CMAKE_C_COMPILER_ID MATCHES "Clang")
|
||||||
|
SET(CMAKE_C_STANDARD 11)
|
||||||
|
ELSEIF(CMAKE_C_COMPILER_ID STREQUAL "MSVC")
|
||||||
|
SET(CMAKE_C_STANDARD 11)
|
||||||
|
ELSE()
|
||||||
|
message(WARNING "C standard could not be set because compiler is not GNU, Clang or MSVC.")
|
||||||
|
ENDIF()
|
||||||
|
|
||||||
########################################################################
|
########################################################################
|
||||||
# Install directories
|
# Install directories
|
||||||
########################################################################
|
########################################################################
|
||||||
|
include(FindPkgConfig)
|
||||||
|
find_package(Volk)
|
||||||
|
find_package(Gnuradio "3.9" REQUIRED COMPONENTS filter fft digital analog blocks)
|
||||||
|
include(GrVersion)
|
||||||
|
|
||||||
include(GrPlatform) #define LIB_SUFFIX
|
include(GrPlatform) #define LIB_SUFFIX
|
||||||
set(GR_RUNTIME_DIR bin)
|
|
||||||
set(GR_LIBRARY_DIR lib${LIB_SUFFIX})
|
if(NOT CMAKE_MODULES_DIR)
|
||||||
set(GR_INCLUDE_DIR include/ieee802-11)
|
set(CMAKE_MODULES_DIR lib${LIB_SUFFIX}/cmake)
|
||||||
set(GR_DATA_DIR share)
|
endif(NOT CMAKE_MODULES_DIR)
|
||||||
|
|
||||||
|
set(GR_INCLUDE_DIR include/ieee802_11)
|
||||||
|
set(GR_CMAKE_DIR ${CMAKE_MODULES_DIR}/ieee802_11)
|
||||||
set(GR_PKG_DATA_DIR ${GR_DATA_DIR}/${CMAKE_PROJECT_NAME})
|
set(GR_PKG_DATA_DIR ${GR_DATA_DIR}/${CMAKE_PROJECT_NAME})
|
||||||
set(GR_DOC_DIR ${GR_DATA_DIR}/doc)
|
|
||||||
set(GR_PKG_DOC_DIR ${GR_DOC_DIR}/${CMAKE_PROJECT_NAME})
|
set(GR_PKG_DOC_DIR ${GR_DOC_DIR}/${CMAKE_PROJECT_NAME})
|
||||||
set(GR_CONF_DIR etc)
|
|
||||||
set(GR_PKG_CONF_DIR ${GR_CONF_DIR}/${CMAKE_PROJECT_NAME}/conf.d)
|
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(GR_PKG_LIBEXEC_DIR ${GR_LIBEXEC_DIR}/${CMAKE_PROJECT_NAME})
|
||||||
set(GRC_BLOCKS_DIR ${GR_PKG_DATA_DIR}/grc/blocks)
|
|
||||||
|
|
||||||
########################################################################
|
|
||||||
# Find gnuradio build dependencies
|
|
||||||
########################################################################
|
|
||||||
set(GR_REQUIRED_COMPONENTS RUNTIME FILTER FFT PMT DIGITAL)
|
|
||||||
find_package(Gnuradio)
|
|
||||||
find_package(CppUnit)
|
|
||||||
find_package(ITPP)
|
|
||||||
|
|
||||||
if(NOT GNURADIO_RUNTIME_FOUND)
|
|
||||||
message(FATAL_ERROR "GnuRadio Runtime required to compile ieee802-11")
|
|
||||||
endif()
|
|
||||||
|
|
||||||
if(NOT CPPUNIT_FOUND)
|
|
||||||
message(FATAL_ERROR "CppUnit required to compile ieee802-11")
|
|
||||||
endif()
|
|
||||||
|
|
||||||
if(NOT ITPP_FOUND)
|
|
||||||
message(FATAL_ERROR "ITPP required to compile ieee802-11")
|
|
||||||
endif()
|
|
||||||
|
|
||||||
########################################################################
|
|
||||||
# Setup logging options
|
|
||||||
########################################################################
|
|
||||||
|
|
||||||
include(GrMiscUtils)
|
|
||||||
GR_LOGGING()
|
|
||||||
|
|
||||||
########################################################################
|
########################################################################
|
||||||
# On Apple only, set install name and use rpath correctly, if not already set
|
# On Apple only, set install name and use rpath correctly, if not already set
|
||||||
@@ -114,7 +101,7 @@ if(APPLE)
|
|||||||
PATH "Library Install Name Destination Directory" FORCE)
|
PATH "Library Install Name Destination Directory" FORCE)
|
||||||
endif(NOT CMAKE_INSTALL_NAME_DIR)
|
endif(NOT CMAKE_INSTALL_NAME_DIR)
|
||||||
if(NOT CMAKE_INSTALL_RPATH)
|
if(NOT CMAKE_INSTALL_RPATH)
|
||||||
set(cmakE_INSTALL_RPATH
|
set(CMAKE_INSTALL_RPATH
|
||||||
${CMAKE_INSTALL_PREFIX}/${GR_LIBRARY_DIR} CACHE
|
${CMAKE_INSTALL_PREFIX}/${GR_LIBRARY_DIR} CACHE
|
||||||
PATH "Library Install RPath" FORCE)
|
PATH "Library Install RPath" FORCE)
|
||||||
endif(NOT CMAKE_INSTALL_RPATH)
|
endif(NOT CMAKE_INSTALL_RPATH)
|
||||||
@@ -125,25 +112,18 @@ if(APPLE)
|
|||||||
endif(APPLE)
|
endif(APPLE)
|
||||||
|
|
||||||
########################################################################
|
########################################################################
|
||||||
# Setup the include and linker paths
|
# Find gnuradio build dependencies
|
||||||
########################################################################
|
########################################################################
|
||||||
include_directories(
|
find_package(Doxygen)
|
||||||
${CMAKE_SOURCE_DIR}/include
|
|
||||||
${CMAKE_SOURCE_DIR}/lib
|
|
||||||
${CMAKE_BINARY_DIR}/include
|
|
||||||
${Boost_INCLUDE_DIRS}
|
|
||||||
${CPPUNIT_INCLUDE_DIRS}
|
|
||||||
${ITPP_INCLUDE_DIR}
|
|
||||||
${GNURADIO_RUNTIME_INCLUDE_DIRS}
|
|
||||||
${LOG4CPP_INCLUDE_DIRS}
|
|
||||||
)
|
|
||||||
|
|
||||||
link_directories(
|
########################################################################
|
||||||
${Boost_LIBRARY_DIRS}
|
# Setup doxygen option
|
||||||
${CPPUNIT_LIBRARY_DIRS}
|
########################################################################
|
||||||
${GNURADIO_RUNTIME_LIBRARY_DIRS}
|
if(DOXYGEN_FOUND)
|
||||||
${LOG4CPP_LIBRARY_DIRS}
|
option(ENABLE_DOXYGEN "Build docs using Doxygen" ON)
|
||||||
)
|
else(DOXYGEN_FOUND)
|
||||||
|
option(ENABLE_DOXYGEN "Build docs using Doxygen" OFF)
|
||||||
|
endif(DOXYGEN_FOUND)
|
||||||
|
|
||||||
########################################################################
|
########################################################################
|
||||||
# Create uninstall target
|
# Create uninstall target
|
||||||
@@ -155,13 +135,33 @@ configure_file(
|
|||||||
|
|
||||||
add_custom_target(uninstall
|
add_custom_target(uninstall
|
||||||
${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake
|
${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake
|
||||||
)
|
)
|
||||||
|
|
||||||
########################################################################
|
########################################################################
|
||||||
# Add subdirectories
|
# Add subdirectories
|
||||||
########################################################################
|
########################################################################
|
||||||
add_subdirectory(include/ieee802-11)
|
add_subdirectory(include/ieee802_11)
|
||||||
add_subdirectory(lib)
|
add_subdirectory(lib)
|
||||||
add_subdirectory(swig)
|
add_subdirectory(apps)
|
||||||
add_subdirectory(python)
|
add_subdirectory(docs)
|
||||||
add_subdirectory(grc)
|
add_subdirectory(examples)
|
||||||
|
# NOTE: manually update below to use GRC to generate C++ flowgraphs w/o python
|
||||||
|
if(ENABLE_PYTHON)
|
||||||
|
message(STATUS "PYTHON and GRC components are enabled")
|
||||||
|
add_subdirectory(python)
|
||||||
|
add_subdirectory(grc)
|
||||||
|
else(ENABLE_PYTHON)
|
||||||
|
message(STATUS "PYTHON and GRC components are disabled")
|
||||||
|
endif(ENABLE_PYTHON)
|
||||||
|
|
||||||
|
########################################################################
|
||||||
|
# Install cmake search helper for this library
|
||||||
|
########################################################################
|
||||||
|
|
||||||
|
install(FILES cmake/Modules/ieee802_11Config.cmake
|
||||||
|
DESTINATION ${CMAKE_MODULES_DIR}/ieee802_11
|
||||||
|
)
|
||||||
|
|
||||||
|
install(FILES MANIFEST.yml
|
||||||
|
RENAME MANIFEST-${VERSION_MAJOR}.${VERSION_API}.${VERSION_ABI}${VERSION_PATCH}.yml
|
||||||
|
DESTINATION share/gnuradio/manifests/ieee802_11)
|
||||||
|
|||||||
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
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.
|
||||||
|
|
||||||
|
{one line to give the program's name and a brief idea of what it does.}
|
||||||
|
Copyright (C) {year} {name of author}
|
||||||
|
|
||||||
|
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 <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
{project} Copyright (C) {year} {fullname}
|
||||||
|
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
|
||||||
|
<http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
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
|
||||||
|
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||||
+7
-8
@@ -1,17 +1,16 @@
|
|||||||
title: gr-ieee802-11
|
title: gr-ieee802-11
|
||||||
author:
|
brief: IEEE 802.11 a/g/p Transceiver
|
||||||
- Bastian Bloessl <bloessl@ccs-labs.org>
|
|
||||||
copyright_owner:
|
|
||||||
- Bastian Bloessl
|
|
||||||
dependencies:
|
|
||||||
- gnuradio (>= 3.7.4)
|
|
||||||
repo: https://github.com/bastibl/gr-ieee802-11.git
|
|
||||||
tags:
|
tags:
|
||||||
- IEEE 802.11
|
- IEEE 802.11
|
||||||
- WiFi
|
- WiFi
|
||||||
- OFDM
|
- OFDM
|
||||||
|
author:
|
||||||
|
- Bastian Bloessl <bloessl@ccs-labs.org>
|
||||||
|
copyright_owner:
|
||||||
|
- Bastian Bloessl
|
||||||
|
repo: https://github.com/bastibl/gr-ieee802-11.git
|
||||||
website: http://www.ccs-labs.org/projects/wime/
|
website: http://www.ccs-labs.org/projects/wime/
|
||||||
brief: IEEE 802.11 a/g/p Transceiver
|
|
||||||
icon: http://www.ccs-labs.org/projects/wime/wime.png
|
icon: http://www.ccs-labs.org/projects/wime/wime.png
|
||||||
|
gr_supported_version: v3.7, v3.8, v3.9
|
||||||
---
|
---
|
||||||
This an IEEE 802.11 a/g/p transceiver for GNU Radio v3.7. Over the air, I tested it with the Ettus USRP N210 with XCVR2450 and CBX daughterboards. For interoperability tests I use mainly an Atheros (ath5k) WiFi card. The code can also be used for packet error rate simulations.
|
This an IEEE 802.11 a/g/p transceiver for GNU Radio v3.7. Over the air, I tested it with the Ettus USRP N210 with XCVR2450 and CBX daughterboards. For interoperability tests I use mainly an Atheros (ath5k) WiFi card. The code can also be used for packet error rate simulations.
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
title: The IEEE801_11 OOT Module
|
||||||
|
version: 1.0
|
||||||
|
brief: IEEE 802.11 a/g/p Transceiver
|
||||||
|
tags: # Tags are arbitrary, but look at CGRAN what other authors are using
|
||||||
|
- IEEE 802.11
|
||||||
|
- WiFi
|
||||||
|
- OFDM
|
||||||
|
author:
|
||||||
|
- Bastian Bloessl <bloessl@ccs-labs.org>
|
||||||
|
copyright_owner:
|
||||||
|
- Bastian Bloessl
|
||||||
|
license: GPL-3.0-or-later
|
||||||
|
gr_supported_version:
|
||||||
|
- 3.7
|
||||||
|
- 3.8
|
||||||
|
- 3.9
|
||||||
|
- 3.10
|
||||||
|
repo: https://github.com/bastibl/gr-ieee802-11.git
|
||||||
|
website: http://www.ccs-labs.org/projects/wime/
|
||||||
|
icon: http://www.ccs-labs.org/projects/wime/wime.png
|
||||||
|
description: |-
|
||||||
|
This an IEEE 802.11 a/g/p transceiver for GNU Radio. Over the air, I tested it with the Ettus USRP N210 with XCVR2450 and CBX daughterboards. For interoperability tests I use mainly an Atheros (ath5k) WiFi card. The code can also be used for packet error rate simulations.
|
||||||
|
file_format: 1
|
||||||
@@ -1,47 +1,52 @@
|
|||||||
Hi,
|
Hi!
|
||||||
|
|
||||||
|
This an IEEE 802.11 a/g/p transceiver for GNU Radio that is fitted for operation
|
||||||
|
with Ettus N210s and B210s. Interoperability was tested with many off-the-shelf
|
||||||
|
WiFi cards and IEEE 802.11p prototypes. The code can also be used in
|
||||||
|
simulations.
|
||||||
|
|
||||||
|
# Table of Contents
|
||||||
|
1. [Development](#development)
|
||||||
|
|
||||||
|
1. [Installation](#installation)
|
||||||
|
|
||||||
|
1. [Usage](#usage)
|
||||||
|
|
||||||
|
1. [Troubleshooting](#troubleshooting)
|
||||||
|
|
||||||
|
1. [Further information](#further-information)
|
||||||
|
|
||||||
|
# Development
|
||||||
|
|
||||||
|
Like GNU Radio, this module uses *maint* branches for development.
|
||||||
|
These branches are supposed to be used with the corresponding GNU Radio
|
||||||
|
branches. This means: the *maint-3.7* branch is compatible with GNU Radio 3.7,
|
||||||
|
*maint-3.8* is compatible with GNU Radio 3.8, etc.
|
||||||
|
|
||||||
this an IEEE 802.11 a/g/p transceiver for GNU Radio v3.7. Over the air, I tested it with the Ettus USRP N210 with XCVR2450 and CBX daughterboards. For interoperability tests I use mainly an Atheros (ath5k) WiFi card. The code can also be used for packet error rate simulations.
|
|
||||||
|
|
||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
Please note that ```apt-get``` is the package manager of Debian/Ubuntu based systems, while ```port``` is one package manager for OSX. So use either (not both) according to your needs.
|
|
||||||
|
|
||||||
|
### GNU Radio
|
||||||
### log4cpp
|
|
||||||
|
|
||||||
I use the new [logging feature](http://gnuradio.org/doc/doxygen/page_logger.html) of GNU Radio which relies on log4cpp. This should be an optional dependency some day, but currently it is required. You can install it with
|
|
||||||
|
|
||||||
sudo apt-get install liblog4cpp5-dev
|
|
||||||
sudo port install log4cpp
|
|
||||||
|
|
||||||
|
|
||||||
### GNU Radio v3.7
|
|
||||||
|
|
||||||
You need at least version 3.7.3.
|
|
||||||
|
|
||||||
There are several ways to install GNU Radio. You can use
|
There are several ways to install GNU Radio. You can use
|
||||||
|
|
||||||
- [pybombs](http://gnuradio.org/redmine/projects/pybombs/wiki)
|
- [pybombs](http://gnuradio.org/redmine/projects/pybombs/wiki)
|
||||||
- [pre-combiled binaries](http://gnuradio.org/redmine/projects/gnuradio/wiki/BinaryPackages)
|
- [pre-compiled binaries](http://gnuradio.org/redmine/projects/gnuradio/wiki/BinaryPackages)
|
||||||
- [from source](http://gnuradio.org/redmine/projects/gnuradio/wiki/InstallingGRFromSource)
|
- [from source](http://gnuradio.org/redmine/projects/gnuradio/wiki/InstallingGRFromSource)
|
||||||
|
|
||||||
|
|
||||||
### IT++
|
|
||||||
|
|
||||||
I use the Viterbi decoder of IT++.
|
|
||||||
|
|
||||||
sudo apt-get install libitpp-dev
|
|
||||||
sudo port install itpp
|
|
||||||
|
|
||||||
|
|
||||||
### gr-foo
|
### gr-foo
|
||||||
|
|
||||||
I have some non project specific GNU Radio blocks in my gr-foo repo that are needed. For example the Wireshark connector. You can find these blocks at [https://github.com/bastibl/gr-foo](https://github.com/bastibl/gr-foo). They are installed with the typical command sequence:
|
I have some non project specific GNU Radio blocks in my gr-foo repo that are
|
||||||
|
needed. For example the Wireshark connector. You can find these blocks at
|
||||||
|
[https://github.com/bastibl/gr-foo](https://github.com/bastibl/gr-foo). They are
|
||||||
|
installed with the typical command sequence:
|
||||||
|
|
||||||
git clone https://github.com/bastibl/gr-foo.git
|
git clone https://github.com/bastibl/gr-foo
|
||||||
cd gr-foo
|
cd gr-foo
|
||||||
mkdir build
|
mkdir build
|
||||||
cd build
|
cd build
|
||||||
@@ -55,7 +60,7 @@ I have some non project specific GNU Radio blocks in my gr-foo repo that are nee
|
|||||||
|
|
||||||
To actually install the blocks do
|
To actually install the blocks do
|
||||||
|
|
||||||
git clone git://github.com/bastibl/gr-ieee802-11.git
|
git clone https://github.com/bastibl/gr-ieee802-11
|
||||||
cd gr-ieee802-11
|
cd gr-ieee802-11
|
||||||
mkdir build
|
mkdir build
|
||||||
cd build
|
cd build
|
||||||
@@ -65,48 +70,73 @@ To actually install the blocks do
|
|||||||
sudo ldconfig
|
sudo ldconfig
|
||||||
|
|
||||||
### Adjust Maximum Shared Memory
|
### Adjust Maximum Shared Memory
|
||||||
Since the transmitter is using the Tagged Stream blocks it has to store a complete frame in the buffer before processing it. The default maximum shared memory might not be enough on most Linux systems. It can be increased with
|
Since the transmitter is using the Tagged Stream blocks it has to store a
|
||||||
|
complete frame in the buffer before processing it. The default maximum shared
|
||||||
|
memory might not be enough on most Linux systems. It can be increased with
|
||||||
|
|
||||||
sudo sysctl -w kernel.shmmax=2147483648
|
sudo sysctl -w kernel.shmmax=2147483648
|
||||||
|
|
||||||
|
|
||||||
### OFDM PHY
|
### OFDM PHY
|
||||||
|
|
||||||
The physical layer is encapsulated in a hierarchical block to allow for a clearer transceiver structure in GNU Radio Companion. This hierarchical block is not included in the installation process. You have to open ```/examples/wifi_phy_hier.grc``` with GNU Radio Companion and build it. This will install the block in ```~/.grc_gnuradio/```.
|
The physical layer is encapsulated in a hierarchical block to allow for a
|
||||||
|
clearer transceiver structure in GNU Radio Companion. This hierarchical block is
|
||||||
|
not included in the installation process. You have to open
|
||||||
|
```/examples/wifi_phy_hier.grc``` with GNU Radio Companion and build it. This
|
||||||
|
will install the block in ```~/.grc_gnuradio/```.
|
||||||
|
|
||||||
|
|
||||||
### Check message port connections
|
### Check message port connections
|
||||||
|
|
||||||
Sometime the connections between the message ports (the gray ones in GNU Radio Companion) break. Therefore, please open the flow graphs and assert that everything is connected. It should be pretty obvious how the blocks are supposed to be wired. Actually this should not happen anymore, so if your ports are still unconnected please drop me a mail.
|
Sometime the connections between the message ports (the gray ones in GNU Radio
|
||||||
|
Companion) break. Therefore, please open the flow graphs and assert that
|
||||||
|
everything is connected. It should be pretty obvious how the blocks are supposed
|
||||||
|
to be wired. Actually this should not happen anymore, so if your ports are still
|
||||||
|
unconnected please drop me a mail.
|
||||||
|
|
||||||
|
|
||||||
### Python OpenGL
|
### Python OpenGL
|
||||||
|
|
||||||
If you want to run the receive demo (the one that plots the subcarrier constellations), please assert that you have python-opengl installed. The nongl version of the plot does not work for me.
|
If you want to run the receive demo (the one that plots the subcarrier
|
||||||
|
constellations), please assert that you have python-opengl installed. The nongl
|
||||||
|
version of the plot does not work for me.
|
||||||
|
|
||||||
|
|
||||||
### Run volk_profile
|
### Run volk_profile
|
||||||
|
|
||||||
volk_profile is part of GNU Radio. It benchmarks different SIMD implementations on your PC and creates a configuration file that stores the fastest version of every function. This can speed up the computation considerably and is required in order to deal with the high rate of incoming samples.
|
volk_profile is part of GNU Radio. It benchmarks different SIMD implementations
|
||||||
|
on your PC and creates a configuration file that stores the fastest version of
|
||||||
|
every function. This can speed up the computation considerably and is required
|
||||||
|
in order to deal with the high rate of incoming samples.
|
||||||
|
|
||||||
|
|
||||||
### Calibrate your daughterboard
|
### Calibrate your daughterboard
|
||||||
|
|
||||||
If you have a WBX, SBX, or CBX daughterboard you should calibrate it in order to minimize IQ imbalance and TX DC offsets. See the [application notes](http://files.ettus.com/uhd_docs/manual/html/calibration.html).
|
If you have a WBX, SBX, or CBX daughterboard you should calibrate it in order to
|
||||||
|
minimize IQ imbalance and TX DC offsets. See the [application
|
||||||
|
notes](http://files.ettus.com/manual/page_calibration.html).
|
||||||
|
|
||||||
|
|
||||||
|
# Checking your installation
|
||||||
|
|
||||||
# Checking you installation
|
As a first step I recommend to test the ```wifi_loopback.grc``` flow graph. This
|
||||||
|
flow graph does not need any hardware and allows you to ensure that the software
|
||||||
|
part is installed correctly. So open the flow graph and run it. If everything
|
||||||
|
works as intended you should see some decoded packets on the console.
|
||||||
|
|
||||||
As a first step I recommend to test the ```wifi_loopback.grc``` flow graph. This flow graph does not need any hardware and allows you to ensure that the software part is installed correctly. So open the flow graph and run it. If everything works as intended you should see some decoded 'Hello World' packets in the console.
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
If GRC complains that it can't find some blocks (other than performance counters and hierarchical blocks) like
|
If GRC complains that it can't find some blocks (other than performance counters
|
||||||
|
and hierarchical blocks) like
|
||||||
|
|
||||||
>>> Error: Block key "ieee802_11_ofdm_mac" not found in Platform - grc(GNU Radio Companion)
|
>>> Error: Block key "ieee802_11_ofdm_mac" not found in Platform - grc(GNU Radio Companion)
|
||||||
>>> Error: Block key "foo_packet_pad" not found in Platform - grc(GNU Radio Companion)
|
>>> Error: Block key "foo_packet_pad" not found in Platform - grc(GNU Radio Companion)
|
||||||
|
|
||||||
Most likely you used a different ```CMAKE_INSTALL_PREFIX``` for the module than for GNU Radio. Therefore, the blocks of the module ended up in a different directory and GRC can't find them. You have to tell GRC where these blocks are by creating/adding to your ```~/.gnuradio/config.conf``` something like
|
Most likely you used a different ```CMAKE_INSTALL_PREFIX``` for the module than
|
||||||
|
for GNU Radio. Therefore, the blocks of the module ended up in a different
|
||||||
|
directory and GRC can't find them. You have to tell GRC where these blocks are
|
||||||
|
by creating/adding to your ```~/.gnuradio/config.conf``` something like
|
||||||
|
|
||||||
[grc]
|
[grc]
|
||||||
global_blocks_path = /opt/local/share/gnuradio/grc/blocks
|
global_blocks_path = /opt/local/share/gnuradio/grc/blocks
|
||||||
@@ -120,71 +150,71 @@ But with the directories that match your installation.
|
|||||||
|
|
||||||
## Simulation
|
## Simulation
|
||||||
|
|
||||||
The loopback flow graph should give you an idea of how simulations can be conducted. To ease use, most blocks have debugging and logging capabilities that can generate traces of the simulation. You can read about the logging feature and how to use it on the [GNU Radio Wiki](http://gnuradio.org/doc/doxygen/page_logger.html).
|
The loopback flow graph should give you an idea of how simulations can be
|
||||||
|
conducted. To ease use, most blocks have debugging and logging capabilities that
|
||||||
|
can generate traces of the simulation. You can read about the logging feature
|
||||||
|
and how to use it on the [GNU Radio
|
||||||
|
Wiki](https://wiki.gnuradio.org/index.php/Logging).
|
||||||
|
|
||||||
|
|
||||||
## Unidirectional communication
|
## Unidirectional communication
|
||||||
|
|
||||||
As first over the air test I recommend to try ```wifi_rx.grc``` and ```wifi_tx.grc```. Just open the flow graphs in GNU Radio companion and execute them. If it does not work out of the box, try to play around with the gain. If everything works as intended you should see similar output as in the ```wifi_loopback.grc``` example.
|
As first over the air test I recommend to try ```wifi_rx.grc``` and
|
||||||
|
```wifi_tx.grc```. Just open the flow graphs in GNU Radio companion and execute
|
||||||
|
them. If it does not work out of the box, try to play around with the gain. If
|
||||||
## RX frames from a WiFi card
|
everything works as intended you should see similar output as in the
|
||||||
|
```wifi_loopback.grc``` example.
|
||||||
TBD
|
|
||||||
|
|
||||||
|
|
||||||
## TX frames to a WiFi card
|
|
||||||
|
|
||||||
TBD
|
|
||||||
|
|
||||||
|
|
||||||
## Transceiver (SDR <-> SDR)
|
|
||||||
|
|
||||||
TBD
|
|
||||||
|
|
||||||
|
|
||||||
## Ad Hoc Network with WiFi card
|
## Ad Hoc Network with WiFi card
|
||||||
|
|
||||||
- The transceiver is currently connected to a TAP device, i.e. is a virtual Ethernet interface. Therefore, we have no WiFi signaling like association requests and hence, the transceiver can not "join" an ad hoc network. You have to make some small changes to the kernel in order to convince you WiFi card to send to this hosts nevertheless.
|
- The transceiver is currently connected to a TAP device, i.e. is a virtual
|
||||||
- The transceiver can not respond to ACKs in time. This is kind of an architectural limitation of USRP + GNU Radio since Ethernet and computations on a normal CPU introduce some latency. You can set the number of ACK retries to zero and handle retransmits on higher layers (-> TCP).
|
Ethernet interface. Therefore, we have no WiFi signaling like association
|
||||||
- RTS/CTS is not working for the same reason. You can however just disable this mechanism.
|
requests and hence, the transceiver can not "join" an ad hoc network. You have
|
||||||
- Currently, there is no CSMA/CA mechanism, but this can be implemented on the FPGA.
|
to make some small changes to the kernel in order to convince you WiFi card to
|
||||||
|
send to this hosts nevertheless.
|
||||||
|
- The transceiver can not respond to ACKs in time. This is kind of an
|
||||||
|
architectural limitation of USRP + GNU Radio since Ethernet and computations
|
||||||
|
on a normal CPU introduce some latency. You can set the number of ACK retries
|
||||||
|
to zero and handle retransmits on higher layers (-> TCP).
|
||||||
|
- RTS/CTS is not working for the same reason. You can however just disable this
|
||||||
|
mechanism.
|
||||||
|
- Currently, there is no CSMA/CA mechanism, but this can be implemented on the
|
||||||
|
FPGA.
|
||||||
|
|
||||||
|
|
||||||
# Troubleshooting
|
# Troubleshooting
|
||||||
|
|
||||||
|
- Please check compile and installation logs. They might contain interesting
|
||||||
|
information.
|
||||||
- Did you calibrate your daughterboard?
|
- Did you calibrate your daughterboard?
|
||||||
- Did you run volk_profile?
|
- Did you run volk_profile?
|
||||||
- Did you try different gain settings?
|
- Did you try different gain settings?
|
||||||
- Did you close the case of the devices?
|
- Did you close the case of the devices?
|
||||||
- Did you try real-time priority?
|
- Did you try real-time priority?
|
||||||
- Did you compile GNU Radio and gr-ieee802-11 in release mode?
|
- Did you compile GNU Radio and gr-ieee802-11 in release mode?
|
||||||
- If you see warnings that ```blocks_ctrlport_monitor_performance``` is missing that means that you installed GNU Radio without control port or performance counters. These blocks allow you to monitor the performance of the transceiver while it is running, but are not required. You can just delete them from the flow graph.
|
- If you see warnings that ```blocks_ctrlport_monitor_performance``` is missing
|
||||||
|
that means that you installed GNU Radio without control port or performance
|
||||||
|
counters. These blocks allow you to monitor the performance of the transceiver
|
||||||
|
while it is running, but are not required. You can just delete them from the
|
||||||
|
flow graph.
|
||||||
- The message
|
- The message
|
||||||
|
|
||||||
You must now use ifconfig to set its IP address. E.g.,
|
You must now use ifconfig to set its IP address. E.g.,
|
||||||
$ sudo ifconfig tap0 192.168.200.1
|
$ sudo ifconfig tap0 192.168.200.1
|
||||||
|
|
||||||
is normal and is output by the TUN/Tap Block during startup. The configuration of the TUN/TAP interface is handled by the scripts in the ```apps``` folder.
|
is normal and is output by the TUN/Tap Block during startup. The configuration
|
||||||
- Did you try to tune the RF frequency out of the band of interest (i.e. used the LO offset menu of the flow graphs)?
|
of the TUN/TAP interface is handled by the scripts in the ```apps``` folder.
|
||||||
- If 'D's appear, it might be related to your Ethernet card. Assert that you made the sysconf changes recommended by Ettus. Did you try to connect you PC directly to the USRP without a switch in between?
|
- Did you try to tune the RF frequency out of the band of interest (i.e. used
|
||||||
|
the LO offset menu of the flow graphs)?
|
||||||
|
- If 'D's appear, it might be related to your Ethernet card. Assert that you
|
||||||
# Asking for help
|
made the sysconf changes recommended by Ettus. Did you try to connect you PC
|
||||||
|
directly to the USRP without a switch in between?
|
||||||
In order to help you it is crucial that you provide enough information about what is going wrong and what you are actually trying to do. So if you write me please include at least the following
|
|
||||||
|
|
||||||
- OS (Ubuntu, OSX...)
|
|
||||||
- hardware (SDR and daughterboard)
|
|
||||||
- GNU Radio version
|
|
||||||
- What are you trying to do
|
|
||||||
- What is you setup, i.e. are you transmitting between SDRs or with WiFi cards.
|
|
||||||
- Bandwidth and frequency
|
|
||||||
- What did you already do to debug?
|
|
||||||
- Where exactly does it break, i.e. is frame detection working? Is the signal field decoded correctly?).
|
|
||||||
|
|
||||||
|
|
||||||
# Further information
|
# Further information
|
||||||
|
|
||||||
For further information please checkout our project page
|
For further information please checkout our project page
|
||||||
[http://www.ccs-labs.org/projects/wime/](http://www.ccs-labs.org/projects/wime/)
|
[https://www.wime-project.net](https://www.wime-project.net)
|
||||||
|
|
||||||
|
For information and an implementation surrounding IEEE 802.11ah, please refer to [gr-ieee802-11ah](https://github.com/irongiant33/gr-ieee802-11ah).
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
# Copyright 2011 Free Software Foundation, Inc.
|
||||||
|
#
|
||||||
|
# This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
# This file is a part of gr-ieee802_11
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
#
|
||||||
|
|
||||||
|
include(GrPython)
|
||||||
|
|
||||||
|
GR_PYTHON_INSTALL(
|
||||||
|
PROGRAMS
|
||||||
|
DESTINATION bin
|
||||||
|
)
|
||||||
+3
-1
@@ -1,6 +1,8 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
FILE="/tmp/ofdm.pcap"
|
### Enable Wireshark Connector in wifi_rx flow graph
|
||||||
|
|
||||||
|
FILE="/tmp/wifi.pcap"
|
||||||
FLOWGRAPH="wifi_rx.py"
|
FLOWGRAPH="wifi_rx.py"
|
||||||
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||||
|
|
||||||
|
|||||||
@@ -58,7 +58,7 @@
|
|||||||
# the new option.
|
# the new option.
|
||||||
# E.g. my_install(TARGETS foo DESTINATION OPTIONAL) would result in
|
# E.g. my_install(TARGETS foo DESTINATION OPTIONAL) would result in
|
||||||
# MY_INSTALL_DESTINATION set to "OPTIONAL", but MY_INSTALL_DESTINATION would
|
# MY_INSTALL_DESTINATION set to "OPTIONAL", but MY_INSTALL_DESTINATION would
|
||||||
# be empty and MY_INSTALL_OPTIONAL would be set to TRUE therefor.
|
# be empty and MY_INSTALL_OPTIONAL would be set to TRUE therefore.
|
||||||
|
|
||||||
#=============================================================================
|
#=============================================================================
|
||||||
# Copyright 2010 Alexander Neundorf <neundorf@kde.org>
|
# Copyright 2010 Alexander Neundorf <neundorf@kde.org>
|
||||||
|
|||||||
@@ -1,36 +0,0 @@
|
|||||||
# http://www.cmake.org/pipermail/cmake/2006-October/011446.html
|
|
||||||
# Modified to use pkg config and use standard var names
|
|
||||||
|
|
||||||
#
|
|
||||||
# Find the CppUnit includes and library
|
|
||||||
#
|
|
||||||
# This module defines
|
|
||||||
# CPPUNIT_INCLUDE_DIR, where to find tiff.h, etc.
|
|
||||||
# CPPUNIT_LIBRARIES, the libraries to link against to use CppUnit.
|
|
||||||
# CPPUNIT_FOUND, If false, do not try to use CppUnit.
|
|
||||||
|
|
||||||
INCLUDE(FindPkgConfig)
|
|
||||||
PKG_CHECK_MODULES(PC_CPPUNIT "cppunit")
|
|
||||||
|
|
||||||
FIND_PATH(CPPUNIT_INCLUDE_DIRS
|
|
||||||
NAMES cppunit/TestCase.h
|
|
||||||
HINTS ${PC_CPPUNIT_INCLUDE_DIR}
|
|
||||||
PATHS
|
|
||||||
/usr/local/include
|
|
||||||
/usr/include
|
|
||||||
)
|
|
||||||
|
|
||||||
FIND_LIBRARY(CPPUNIT_LIBRARIES
|
|
||||||
NAMES cppunit
|
|
||||||
HINTS ${PC_CPPUNIT_LIBDIR}
|
|
||||||
PATHS
|
|
||||||
${CPPUNIT_INCLUDE_DIRS}/../lib
|
|
||||||
/usr/local/lib
|
|
||||||
/usr/lib
|
|
||||||
)
|
|
||||||
|
|
||||||
LIST(APPEND CPPUNIT_LIBRARIES ${CMAKE_DL_LIBS})
|
|
||||||
|
|
||||||
INCLUDE(FindPackageHandleStandardArgs)
|
|
||||||
FIND_PACKAGE_HANDLE_STANDARD_ARGS(CPPUNIT DEFAULT_MSG CPPUNIT_LIBRARIES CPPUNIT_INCLUDE_DIRS)
|
|
||||||
MARK_AS_ADVANCED(CPPUNIT_LIBRARIES CPPUNIT_INCLUDE_DIRS)
|
|
||||||
@@ -1,70 +0,0 @@
|
|||||||
# - Find ITPP
|
|
||||||
# Find the native ITPP includes and library
|
|
||||||
# This module defines
|
|
||||||
# ITPP_INCLUDE_DIR, where to find itpp/itbase.h, etc.
|
|
||||||
# ITPP_LIBRARIES, the libraries needed to use ITPP.
|
|
||||||
# ITPP_FOUND, If false, do not try to use ITPP.
|
|
||||||
# also defined, but not for general use are
|
|
||||||
# ITPP_LIBRARY, where to find the ITPP library.
|
|
||||||
|
|
||||||
include(FindPkgConfig)
|
|
||||||
pkg_check_modules(PC_ITPP itpp)
|
|
||||||
|
|
||||||
find_path(ITPP_INCLUDE_DIR
|
|
||||||
NAMES itpp/itbase.h
|
|
||||||
HINTS ${PC_ITPP_INCLUDEDIR}/include
|
|
||||||
${ITPP_DIR}/include
|
|
||||||
/usr/pkgs64/include
|
|
||||||
/usr/include
|
|
||||||
/usr/local/include
|
|
||||||
)
|
|
||||||
find_library(ITPP_LIBRARY_NORMAL
|
|
||||||
NAMES itpp
|
|
||||||
HINTS ${PC_ITPP_LIBDIR}
|
|
||||||
PATHS ${ITPP_DIR}/libs
|
|
||||||
"${ITPP_DIR}\\win32\\lib"
|
|
||||||
/usr/pkgs64/lib
|
|
||||||
/usr/lib64
|
|
||||||
/usr/lib
|
|
||||||
/usr/local/lib
|
|
||||||
)
|
|
||||||
find_library(ITPP_LIBRARY_DEBUG
|
|
||||||
NAMES itpp_debug
|
|
||||||
HINTS ${PC_ITPP_LIBDIR}
|
|
||||||
PATHS ${ITPP_DIR}/libs
|
|
||||||
"${ITPP_DIR}\\win32\\lib"
|
|
||||||
/usr/pkgs64/lib
|
|
||||||
/usr/lib64
|
|
||||||
/usr/lib
|
|
||||||
/usr/local/lib
|
|
||||||
)
|
|
||||||
|
|
||||||
if (ITPP_LIBRARY_NORMAL OR ITPP_LIBRARY_DEBUG)
|
|
||||||
if (CMAKE_BUILD_TYPE STREQUAL "Debug" AND ITPP_LIBRARY_DEBUG)
|
|
||||||
SET (ITPP_LIBRARY ${ITPP_LIBRARY_DEBUG})
|
|
||||||
else (CMAKE_BUILD_TYPE STREQUAL "Debug" AND ITPP_LIBRARY_DEBUG)
|
|
||||||
SET (ITPP_LIBRARY ${ITPP_LIBRARY_NORMAL})
|
|
||||||
endif (CMAKE_BUILD_TYPE STREQUAL "Debug" AND ITPP_LIBRARY_DEBUG)
|
|
||||||
endif (ITPP_LIBRARY_NORMAL OR ITPP_LIBRARY_DEBUG)
|
|
||||||
|
|
||||||
if (ITPP_LIBRARY AND ITPP_INCLUDE_DIR)
|
|
||||||
SET(ITPP_LIBRARIES ${ITPP_LIBRARY})
|
|
||||||
SET(ITPP_FOUND "YES")
|
|
||||||
else (ITPP_LIBRARY AND ITPP_INCLUDE_DIR)
|
|
||||||
SET(ITPP_FOUND "NO")
|
|
||||||
endif (ITPP_LIBRARY AND ITPP_INCLUDE_DIR)
|
|
||||||
|
|
||||||
if (ITPP_FOUND)
|
|
||||||
if (NOT ITPP_FIND_QUIETLY)
|
|
||||||
MESSAGE(STATUS "Found ITPP: ${ITPP_LIBRARIES}")
|
|
||||||
endif (NOT ITPP_FIND_QUIETLY)
|
|
||||||
else (ITPP_FOUND)
|
|
||||||
if (ITPP_FIND_REQUIRED)
|
|
||||||
MESSAGE(FATAL_ERROR "Could not find ITPP library")
|
|
||||||
endif (ITPP_FIND_REQUIRED)
|
|
||||||
endif (ITPP_FOUND)
|
|
||||||
|
|
||||||
mark_as_advanced(
|
|
||||||
ITPP_LIBRARY
|
|
||||||
ITPP_INCLUDE_DIR
|
|
||||||
)
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
# - Find Log4cpp
|
|
||||||
# Find the native LOG4CPP includes and library
|
|
||||||
#
|
|
||||||
# LOG4CPP_INCLUDE_DIR - where to find LOG4CPP.h, etc.
|
|
||||||
# LOG4CPP_LIBRARIES - List of libraries when using LOG4CPP.
|
|
||||||
# LOG4CPP_FOUND - True if LOG4CPP found.
|
|
||||||
|
|
||||||
|
|
||||||
if (LOG4CPP_INCLUDE_DIR)
|
|
||||||
# Already in cache, be silent
|
|
||||||
set(LOG4CPP_FIND_QUIETLY TRUE)
|
|
||||||
endif ()
|
|
||||||
|
|
||||||
find_path(LOG4CPP_INCLUDE_DIR log4cpp/Category.hh
|
|
||||||
/opt/local/include
|
|
||||||
/usr/local/include
|
|
||||||
/usr/include
|
|
||||||
)
|
|
||||||
|
|
||||||
set(LOG4CPP_NAMES log4cpp)
|
|
||||||
find_library(LOG4CPP_LIBRARY
|
|
||||||
NAMES ${LOG4CPP_NAMES}
|
|
||||||
PATHS /usr/lib /usr/local/lib /opt/local/lib
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
if (LOG4CPP_INCLUDE_DIR AND LOG4CPP_LIBRARY)
|
|
||||||
set(LOG4CPP_FOUND TRUE)
|
|
||||||
set(LOG4CPP_LIBRARIES ${LOG4CPP_LIBRARY} CACHE INTERNAL "" FORCE)
|
|
||||||
set(LOG4CPP_INCLUDE_DIRS ${LOG4CPP_INCLUDE_DIR} CACHE INTERNAL "" FORCE)
|
|
||||||
else ()
|
|
||||||
set(LOG4CPP_FOUND FALSE CACHE INTERNAL "" FORCE)
|
|
||||||
set(LOG4CPP_LIBRARY "" CACHE INTERNAL "" FORCE)
|
|
||||||
set(LOG4CPP_LIBRARIES "" CACHE INTERNAL "" FORCE)
|
|
||||||
set(LOG4CPP_INCLUDE_DIR "" CACHE INTERNAL "" FORCE)
|
|
||||||
set(LOG4CPP_INCLUDE_DIRS "" CACHE INTERNAL "" FORCE)
|
|
||||||
endif ()
|
|
||||||
|
|
||||||
if (LOG4CPP_FOUND)
|
|
||||||
if (NOT LOG4CPP_FIND_QUIETLY)
|
|
||||||
message(STATUS "Found LOG4CPP: ${LOG4CPP_LIBRARIES}")
|
|
||||||
endif ()
|
|
||||||
else ()
|
|
||||||
if (LOG4CPP_FIND_REQUIRED)
|
|
||||||
message(STATUS "Looked for LOG4CPP libraries named ${LOG4CPPS_NAMES}.")
|
|
||||||
message(FATAL_ERROR "Could NOT find LOG4CPP library")
|
|
||||||
endif ()
|
|
||||||
endif ()
|
|
||||||
|
|
||||||
mark_as_advanced(
|
|
||||||
LOG4CPP_LIBRARIES
|
|
||||||
LOG4CPP_INCLUDE_DIRS
|
|
||||||
)
|
|
||||||
@@ -1,114 +0,0 @@
|
|||||||
# 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 on, we note this
|
|
||||||
if("${${var}}" STREQUAL "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-fosphor enabled components ")
|
|
||||||
message(STATUS "######################################################")
|
|
||||||
foreach(comp ${_gr_enabled_components})
|
|
||||||
message(STATUS " * ${comp}")
|
|
||||||
endforeach(comp)
|
|
||||||
|
|
||||||
message(STATUS "")
|
|
||||||
message(STATUS "######################################################")
|
|
||||||
message(STATUS "# gr-fosphor disabled components ")
|
|
||||||
message(STATUS "######################################################")
|
|
||||||
foreach(comp ${_gr_disabled_components})
|
|
||||||
message(STATUS " * ${comp}")
|
|
||||||
endforeach(comp)
|
|
||||||
|
|
||||||
message(STATUS "")
|
|
||||||
endfunction(GR_PRINT_COMPONENT_SUMMARY)
|
|
||||||
@@ -1,519 +0,0 @@
|
|||||||
# Copyright 2010-2011,2014 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 <target1> <target2> ...)
|
|
||||||
# ADD_CUSTOM_COMMAND(<the usual args> ${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 <pthread.h>
|
|
||||||
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 <sched.h>
|
|
||||||
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)
|
|
||||||
|
|
||||||
########################################################################
|
|
||||||
# Macros to generate source and header files from template
|
|
||||||
########################################################################
|
|
||||||
macro(GR_EXPAND_X_H component root)
|
|
||||||
|
|
||||||
include(GrPython)
|
|
||||||
|
|
||||||
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py
|
|
||||||
"#!${PYTHON_EXECUTABLE}
|
|
||||||
|
|
||||||
import sys, os, re
|
|
||||||
sys.path.append('${GR_RUNTIME_PYTHONPATH}')
|
|
||||||
os.environ['srcdir'] = '${CMAKE_CURRENT_SOURCE_DIR}'
|
|
||||||
os.chdir('${CMAKE_CURRENT_BINARY_DIR}')
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
import build_utils
|
|
||||||
root, inp = sys.argv[1:3]
|
|
||||||
for sig in sys.argv[3:]:
|
|
||||||
name = re.sub ('X+', sig, root)
|
|
||||||
d = build_utils.standard_dict2(name, sig, '${component}')
|
|
||||||
build_utils.expand_template(d, inp)
|
|
||||||
")
|
|
||||||
|
|
||||||
#make a list of all the generated headers
|
|
||||||
unset(expanded_files_h)
|
|
||||||
foreach(sig ${ARGN})
|
|
||||||
string(REGEX REPLACE "X+" ${sig} name ${root})
|
|
||||||
list(APPEND expanded_files_h ${CMAKE_CURRENT_BINARY_DIR}/${name}.h)
|
|
||||||
endforeach(sig)
|
|
||||||
unset(name)
|
|
||||||
|
|
||||||
#create a command to generate the headers
|
|
||||||
add_custom_command(
|
|
||||||
OUTPUT ${expanded_files_h}
|
|
||||||
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${root}.h.t
|
|
||||||
COMMAND ${PYTHON_EXECUTABLE} ${PYTHON_DASH_B}
|
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py
|
|
||||||
${root} ${root}.h.t ${ARGN}
|
|
||||||
)
|
|
||||||
|
|
||||||
#install rules for the generated headers
|
|
||||||
list(APPEND generated_includes ${expanded_files_h})
|
|
||||||
|
|
||||||
endmacro(GR_EXPAND_X_H)
|
|
||||||
|
|
||||||
macro(GR_EXPAND_X_CC_H component root)
|
|
||||||
|
|
||||||
include(GrPython)
|
|
||||||
|
|
||||||
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py
|
|
||||||
"#!${PYTHON_EXECUTABLE}
|
|
||||||
|
|
||||||
import sys, os, re
|
|
||||||
sys.path.append('${GR_RUNTIME_PYTHONPATH}')
|
|
||||||
os.environ['srcdir'] = '${CMAKE_CURRENT_SOURCE_DIR}'
|
|
||||||
os.chdir('${CMAKE_CURRENT_BINARY_DIR}')
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
import build_utils
|
|
||||||
root, inp = sys.argv[1:3]
|
|
||||||
for sig in sys.argv[3:]:
|
|
||||||
name = re.sub ('X+', sig, root)
|
|
||||||
d = build_utils.standard_impl_dict2(name, sig, '${component}')
|
|
||||||
build_utils.expand_template(d, inp)
|
|
||||||
")
|
|
||||||
|
|
||||||
#make a list of all the generated files
|
|
||||||
unset(expanded_files_cc)
|
|
||||||
unset(expanded_files_h)
|
|
||||||
foreach(sig ${ARGN})
|
|
||||||
string(REGEX REPLACE "X+" ${sig} name ${root})
|
|
||||||
list(APPEND expanded_files_cc ${CMAKE_CURRENT_BINARY_DIR}/${name}.cc)
|
|
||||||
list(APPEND expanded_files_h ${CMAKE_CURRENT_BINARY_DIR}/${name}.h)
|
|
||||||
endforeach(sig)
|
|
||||||
unset(name)
|
|
||||||
|
|
||||||
#create a command to generate the source files
|
|
||||||
add_custom_command(
|
|
||||||
OUTPUT ${expanded_files_cc}
|
|
||||||
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${root}.cc.t
|
|
||||||
COMMAND ${PYTHON_EXECUTABLE} ${PYTHON_DASH_B}
|
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py
|
|
||||||
${root} ${root}.cc.t ${ARGN}
|
|
||||||
)
|
|
||||||
|
|
||||||
#create a command to generate the header files
|
|
||||||
add_custom_command(
|
|
||||||
OUTPUT ${expanded_files_h}
|
|
||||||
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${root}.h.t
|
|
||||||
COMMAND ${PYTHON_EXECUTABLE} ${PYTHON_DASH_B}
|
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py
|
|
||||||
${root} ${root}.h.t ${ARGN}
|
|
||||||
)
|
|
||||||
|
|
||||||
#make source files depends on headers to force generation
|
|
||||||
set_source_files_properties(${expanded_files_cc}
|
|
||||||
PROPERTIES OBJECT_DEPENDS "${expanded_files_h}"
|
|
||||||
)
|
|
||||||
|
|
||||||
#install rules for the generated files
|
|
||||||
list(APPEND generated_sources ${expanded_files_cc})
|
|
||||||
list(APPEND generated_headers ${expanded_files_h})
|
|
||||||
|
|
||||||
endmacro(GR_EXPAND_X_CC_H)
|
|
||||||
|
|
||||||
macro(GR_EXPAND_X_CC_H_IMPL component root)
|
|
||||||
|
|
||||||
include(GrPython)
|
|
||||||
|
|
||||||
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py
|
|
||||||
"#!${PYTHON_EXECUTABLE}
|
|
||||||
|
|
||||||
import sys, os, re
|
|
||||||
sys.path.append('${GR_RUNTIME_PYTHONPATH}')
|
|
||||||
os.environ['srcdir'] = '${CMAKE_CURRENT_SOURCE_DIR}'
|
|
||||||
os.chdir('${CMAKE_CURRENT_BINARY_DIR}')
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
import build_utils
|
|
||||||
root, inp = sys.argv[1:3]
|
|
||||||
for sig in sys.argv[3:]:
|
|
||||||
name = re.sub ('X+', sig, root)
|
|
||||||
d = build_utils.standard_dict(name, sig, '${component}')
|
|
||||||
build_utils.expand_template(d, inp, '_impl')
|
|
||||||
")
|
|
||||||
|
|
||||||
#make a list of all the generated files
|
|
||||||
unset(expanded_files_cc_impl)
|
|
||||||
unset(expanded_files_h_impl)
|
|
||||||
unset(expanded_files_h)
|
|
||||||
foreach(sig ${ARGN})
|
|
||||||
string(REGEX REPLACE "X+" ${sig} name ${root})
|
|
||||||
list(APPEND expanded_files_cc_impl ${CMAKE_CURRENT_BINARY_DIR}/${name}_impl.cc)
|
|
||||||
list(APPEND expanded_files_h_impl ${CMAKE_CURRENT_BINARY_DIR}/${name}_impl.h)
|
|
||||||
list(APPEND expanded_files_h ${CMAKE_CURRENT_BINARY_DIR}/../include/gnuradio/${component}/${name}.h)
|
|
||||||
endforeach(sig)
|
|
||||||
unset(name)
|
|
||||||
|
|
||||||
#create a command to generate the _impl.cc files
|
|
||||||
add_custom_command(
|
|
||||||
OUTPUT ${expanded_files_cc_impl}
|
|
||||||
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${root}_impl.cc.t
|
|
||||||
COMMAND ${PYTHON_EXECUTABLE} ${PYTHON_DASH_B}
|
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py
|
|
||||||
${root} ${root}_impl.cc.t ${ARGN}
|
|
||||||
)
|
|
||||||
|
|
||||||
#create a command to generate the _impl.h files
|
|
||||||
add_custom_command(
|
|
||||||
OUTPUT ${expanded_files_h_impl}
|
|
||||||
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${root}_impl.h.t
|
|
||||||
COMMAND ${PYTHON_EXECUTABLE} ${PYTHON_DASH_B}
|
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py
|
|
||||||
${root} ${root}_impl.h.t ${ARGN}
|
|
||||||
)
|
|
||||||
|
|
||||||
#make _impl.cc source files depend on _impl.h to force generation
|
|
||||||
set_source_files_properties(${expanded_files_cc_impl}
|
|
||||||
PROPERTIES OBJECT_DEPENDS "${expanded_files_h_impl}"
|
|
||||||
)
|
|
||||||
|
|
||||||
#make _impl.h source files depend on headers to force generation
|
|
||||||
set_source_files_properties(${expanded_files_h_impl}
|
|
||||||
PROPERTIES OBJECT_DEPENDS "${expanded_files_h}"
|
|
||||||
)
|
|
||||||
|
|
||||||
#install rules for the generated files
|
|
||||||
list(APPEND generated_sources ${expanded_files_cc_impl})
|
|
||||||
list(APPEND generated_headers ${expanded_files_h_impl})
|
|
||||||
|
|
||||||
endmacro(GR_EXPAND_X_CC_H_IMPL)
|
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
# 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")
|
|
||||||
@@ -1,242 +0,0 @@
|
|||||||
# 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(<description> <dependencies list>)
|
|
||||||
########################################################################
|
|
||||||
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}"
|
|
||||||
VERBATIM
|
|
||||||
)
|
|
||||||
|
|
||||||
#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)
|
|
||||||
")
|
|
||||||
@@ -1,248 +0,0 @@
|
|||||||
# 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<size_t> and vector<unsigned int> (on 32-bit machines) and
|
|
||||||
# vector<long unsigned int> (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)))
|
|
||||||
")
|
|
||||||
@@ -1,143 +0,0 @@
|
|||||||
# 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 "VOLK_GENERIC=1" "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)
|
|
||||||
@@ -1,82 +0,0 @@
|
|||||||
# 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()
|
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
if(NOT PKG_CONFIG_FOUND)
|
||||||
|
INCLUDE(FindPkgConfig)
|
||||||
|
endif()
|
||||||
|
PKG_CHECK_MODULES(PC_IEEE802_11 ieee802_11)
|
||||||
|
|
||||||
|
FIND_PATH(
|
||||||
|
IEEE802_11_INCLUDE_DIRS
|
||||||
|
NAMES ieee802_11/api.h
|
||||||
|
HINTS $ENV{IEEE802_11_DIR}/include
|
||||||
|
${PC_IEEE802_11_INCLUDEDIR}
|
||||||
|
PATHS ${CMAKE_INSTALL_PREFIX}/include
|
||||||
|
/usr/local/include
|
||||||
|
/usr/include
|
||||||
|
)
|
||||||
|
|
||||||
|
FIND_LIBRARY(
|
||||||
|
IEEE802_11_LIBRARIES
|
||||||
|
NAMES gnuradio-ieee802_11
|
||||||
|
HINTS $ENV{IEEE802_11_DIR}/lib
|
||||||
|
${PC_IEEE802_11_LIBDIR}
|
||||||
|
PATHS ${CMAKE_INSTALL_PREFIX}/lib
|
||||||
|
${CMAKE_INSTALL_PREFIX}/lib64
|
||||||
|
/usr/local/lib
|
||||||
|
/usr/local/lib64
|
||||||
|
/usr/lib
|
||||||
|
/usr/lib64
|
||||||
|
)
|
||||||
|
|
||||||
|
include("${CMAKE_CURRENT_LIST_DIR}/ieee802_11Target.cmake")
|
||||||
|
|
||||||
|
INCLUDE(FindPackageHandleStandardArgs)
|
||||||
|
FIND_PACKAGE_HANDLE_STANDARD_ARGS(IEEE802_11 DEFAULT_MSG IEEE802_11_LIBRARIES IEEE802_11_INCLUDE_DIRS)
|
||||||
|
MARK_AS_ADVANCED(IEEE802_11_LIBRARIES IEEE802_11_INCLUDE_DIRS)
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
# Copyright 2018 Free Software Foundation, Inc.
|
||||||
|
#
|
||||||
|
# This file is part of GNU Radio
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
#
|
||||||
|
|
||||||
|
include(CMakeFindDependencyMacro)
|
||||||
|
|
||||||
|
set(target_deps "@TARGET_DEPENDENCIES@")
|
||||||
|
foreach(dep IN LISTS target_deps)
|
||||||
|
find_dependency(${dep})
|
||||||
|
endforeach()
|
||||||
|
include("${CMAKE_CURRENT_LIST_DIR}/@TARGET@Targets.cmake")
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# Copyright 2011 Free Software Foundation, Inc.
|
||||||
|
#
|
||||||
|
# This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
# This file is a part of gr-ieee802_11
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
#
|
||||||
|
|
||||||
|
########################################################################
|
||||||
|
# Setup dependencies
|
||||||
|
########################################################################
|
||||||
|
find_package(Doxygen)
|
||||||
|
|
||||||
|
########################################################################
|
||||||
|
# Begin conditional configuration
|
||||||
|
########################################################################
|
||||||
|
if(ENABLE_DOXYGEN)
|
||||||
|
|
||||||
|
########################################################################
|
||||||
|
# Add subdirectories
|
||||||
|
########################################################################
|
||||||
|
add_subdirectory(doxygen)
|
||||||
|
|
||||||
|
endif(ENABLE_DOXYGEN)
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
This is the ieee802_11-write-a-block package meant as a guide to building
|
||||||
|
out-of-tree packages. To use the ieee802_11 blocks, the Python namespaces
|
||||||
|
is in 'ieee802_11', which is imported as:
|
||||||
|
|
||||||
|
import ieee802_11
|
||||||
|
|
||||||
|
See the Doxygen documentation for details about the blocks available
|
||||||
|
in this package. A quick listing of the details can be found in Python
|
||||||
|
after importing by using:
|
||||||
|
|
||||||
|
help(ieee802_11)
|
||||||
@@ -1,21 +1,10 @@
|
|||||||
# Copyright 2011 Free Software Foundation, Inc.
|
# Copyright 2011 Free Software Foundation, Inc.
|
||||||
#
|
#
|
||||||
# This file is part of GNU Radio
|
# This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
# This file is a part of gr-ieee802_11
|
||||||
#
|
#
|
||||||
# GNU Radio is free software; you can redistribute it and/or modify
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
# 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
|
# Create the doxygen configuration file
|
||||||
@@ -28,6 +17,7 @@ file(TO_NATIVE_PATH ${CMAKE_BINARY_DIR} abs_top_builddir)
|
|||||||
set(HAVE_DOT ${DOXYGEN_DOT_FOUND})
|
set(HAVE_DOT ${DOXYGEN_DOT_FOUND})
|
||||||
set(enable_html_docs YES)
|
set(enable_html_docs YES)
|
||||||
set(enable_latex_docs NO)
|
set(enable_latex_docs NO)
|
||||||
|
set(enable_mathjax NO)
|
||||||
set(enable_xml_docs YES)
|
set(enable_xml_docs YES)
|
||||||
|
|
||||||
configure_file(
|
configure_file(
|
||||||
|
|||||||
+567
-184
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,3 +0,0 @@
|
|||||||
/Makefile
|
|
||||||
/Makefile.in
|
|
||||||
|
|
||||||
@@ -1,52 +0,0 @@
|
|||||||
#
|
|
||||||
# Copyright 2007,2009,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 $(top_srcdir)/Makefile.common
|
|
||||||
|
|
||||||
EXTRA_DIST = \
|
|
||||||
example/aadvark.cc \
|
|
||||||
example/aadvark.h \
|
|
||||||
example/Doxyfile \
|
|
||||||
example/xml/aadvark_8cc.xml \
|
|
||||||
example/xml/aadvark_8h.xml \
|
|
||||||
example/xml/classAadvark.xml \
|
|
||||||
example/xml/combine.xslt \
|
|
||||||
example/xml/compound.xsd \
|
|
||||||
example/xml/index.xml \
|
|
||||||
example/xml/index.xsd
|
|
||||||
|
|
||||||
if PYTHON
|
|
||||||
utilspythondir = $(grpythondir)/doxyxml
|
|
||||||
|
|
||||||
TESTS = \
|
|
||||||
run_tests
|
|
||||||
|
|
||||||
nobase_utilspython_PYTHON = \
|
|
||||||
__init__.py \
|
|
||||||
base.py \
|
|
||||||
doxyindex.py \
|
|
||||||
text.py \
|
|
||||||
generated/__init__.py \
|
|
||||||
generated/index.py \
|
|
||||||
generated/indexsuper.py \
|
|
||||||
generated/compound.py \
|
|
||||||
generated/compoundsuper.py
|
|
||||||
endif
|
|
||||||
@@ -1,22 +1,11 @@
|
|||||||
#
|
#
|
||||||
# Copyright 2010 Free Software Foundation, Inc.
|
# Copyright 2010 Free Software Foundation, Inc.
|
||||||
#
|
#
|
||||||
# This file is part of GNU Radio
|
# This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
# This file is a part of gr-ieee802_11
|
||||||
#
|
#
|
||||||
# GNU Radio is free software; you can redistribute it and/or modify
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
# 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.
|
Python interface to contents of doxygen xml documentation.
|
||||||
@@ -64,7 +53,7 @@ u'Outputs the vital aadvark statistics.'
|
|||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from doxyindex import DoxyIndex, DoxyFunction, DoxyParam, DoxyClass, DoxyFile, DoxyNamespace, DoxyGroup, DoxyFriend, DoxyOther
|
from .doxyindex import DoxyIndex, DoxyFunction, DoxyParam, DoxyClass, DoxyFile, DoxyNamespace, DoxyGroup, DoxyFriend, DoxyOther
|
||||||
|
|
||||||
def _test():
|
def _test():
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -1,22 +1,11 @@
|
|||||||
#
|
#
|
||||||
# Copyright 2010 Free Software Foundation, Inc.
|
# Copyright 2010 Free Software Foundation, Inc.
|
||||||
#
|
#
|
||||||
# This file is part of GNU Radio
|
# This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
# This file is a part of gr-ieee802_11
|
||||||
#
|
#
|
||||||
# GNU Radio is free software; you can redistribute it and/or modify
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
# 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.
|
A base class is created.
|
||||||
@@ -30,18 +19,18 @@ import pdb
|
|||||||
|
|
||||||
from xml.parsers.expat import ExpatError
|
from xml.parsers.expat import ExpatError
|
||||||
|
|
||||||
from generated import compound
|
from .generated import compound
|
||||||
|
|
||||||
|
|
||||||
class Base(object):
|
class Base(object):
|
||||||
|
|
||||||
class Duplicate(StandardError):
|
class Duplicate(Exception):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
class NoSuchMember(StandardError):
|
class NoSuchMember(Exception):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
class ParsingError(StandardError):
|
class ParsingError(Exception):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
def __init__(self, parse_data, top=None):
|
def __init__(self, parse_data, top=None):
|
||||||
@@ -94,7 +83,7 @@ class Base(object):
|
|||||||
for cls in self.mem_classes:
|
for cls in self.mem_classes:
|
||||||
if cls.can_parse(mem):
|
if cls.can_parse(mem):
|
||||||
return cls
|
return cls
|
||||||
raise StandardError(("Did not find a class for object '%s'." \
|
raise Exception(("Did not find a class for object '%s'." \
|
||||||
% (mem.get_name())))
|
% (mem.get_name())))
|
||||||
|
|
||||||
def convert_mem(self, mem):
|
def convert_mem(self, mem):
|
||||||
@@ -102,11 +91,11 @@ class Base(object):
|
|||||||
cls = self.get_cls(mem)
|
cls = self.get_cls(mem)
|
||||||
converted = cls.from_parse_data(mem, self.top)
|
converted = cls.from_parse_data(mem, self.top)
|
||||||
if converted is None:
|
if converted is None:
|
||||||
raise StandardError('No class matched this object.')
|
raise Exception('No class matched this object.')
|
||||||
self.add_ref(converted)
|
self.add_ref(converted)
|
||||||
return converted
|
return converted
|
||||||
except StandardError, e:
|
except Exception as e:
|
||||||
print e
|
print(e)
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def includes(cls, inst):
|
def includes(cls, inst):
|
||||||
|
|||||||
@@ -1,22 +1,11 @@
|
|||||||
#
|
#
|
||||||
# Copyright 2010 Free Software Foundation, Inc.
|
# Copyright 2010 Free Software Foundation, Inc.
|
||||||
#
|
#
|
||||||
# This file is part of GNU Radio
|
# This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
# This file is a part of gr-ieee802_11
|
||||||
#
|
#
|
||||||
# GNU Radio is free software; you can redistribute it and/or modify
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
# 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
|
Classes providing more user-friendly interfaces to the doxygen xml
|
||||||
@@ -25,9 +14,9 @@ docs than the generated classes provide.
|
|||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
||||||
from generated import index
|
from .generated import index
|
||||||
from base import Base
|
from .base import Base
|
||||||
from text import description
|
from .text import description
|
||||||
|
|
||||||
class DoxyIndex(Base):
|
class DoxyIndex(Base):
|
||||||
"""
|
"""
|
||||||
@@ -43,25 +32,20 @@ class DoxyIndex(Base):
|
|||||||
self._root = index.parse(os.path.join(self._xml_path, 'index.xml'))
|
self._root = index.parse(os.path.join(self._xml_path, 'index.xml'))
|
||||||
for mem in self._root.compound:
|
for mem in self._root.compound:
|
||||||
converted = self.convert_mem(mem)
|
converted = self.convert_mem(mem)
|
||||||
# For files we want the contents to be accessible directly
|
# For files and namespaces we want the contents to be
|
||||||
# from the parent rather than having to go through the file
|
# accessible directly from the parent rather than having
|
||||||
# object.
|
# to go through the file object.
|
||||||
if self.get_cls(mem) == DoxyFile:
|
if self.get_cls(mem) == DoxyFile:
|
||||||
if mem.name.endswith('.h'):
|
if mem.name.endswith('.h'):
|
||||||
self._members += converted.members()
|
self._members += converted.members()
|
||||||
self._members.append(converted)
|
self._members.append(converted)
|
||||||
|
elif self.get_cls(mem) == DoxyNamespace:
|
||||||
|
self._members += converted.members()
|
||||||
|
self._members.append(converted)
|
||||||
else:
|
else:
|
||||||
self._members.append(converted)
|
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):
|
class DoxyCompMem(Base):
|
||||||
|
|
||||||
|
|
||||||
@@ -80,13 +64,29 @@ class DoxyCompMem(Base):
|
|||||||
self._data['brief_description'] = bd
|
self._data['brief_description'] = bd
|
||||||
self._data['detailed_description'] = dd
|
self._data['detailed_description'] = dd
|
||||||
|
|
||||||
|
def set_parameters(self, data):
|
||||||
|
vs = [ddc.value for ddc in data.detaileddescription.content_]
|
||||||
|
pls = []
|
||||||
|
for v in vs:
|
||||||
|
if hasattr(v, 'parameterlist'):
|
||||||
|
pls += v.parameterlist
|
||||||
|
pis = []
|
||||||
|
for pl in pls:
|
||||||
|
pis += pl.parameteritem
|
||||||
|
dpis = []
|
||||||
|
for pi in pis:
|
||||||
|
dpi = DoxyParameterItem(pi)
|
||||||
|
dpi._parse()
|
||||||
|
dpis.append(dpi)
|
||||||
|
self._data['params'] = dpis
|
||||||
|
|
||||||
|
|
||||||
class DoxyCompound(DoxyCompMem):
|
class DoxyCompound(DoxyCompMem):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
class DoxyMember(DoxyCompMem):
|
class DoxyMember(DoxyCompMem):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
class DoxyFunction(DoxyMember):
|
class DoxyFunction(DoxyMember):
|
||||||
|
|
||||||
__module__ = "gnuradio.utils.doxyxml"
|
__module__ = "gnuradio.utils.doxyxml"
|
||||||
@@ -98,6 +98,9 @@ class DoxyFunction(DoxyMember):
|
|||||||
return
|
return
|
||||||
super(DoxyFunction, self)._parse()
|
super(DoxyFunction, self)._parse()
|
||||||
self.set_descriptions(self._parse_data)
|
self.set_descriptions(self._parse_data)
|
||||||
|
self.set_parameters(self._parse_data)
|
||||||
|
if not self._data['params']:
|
||||||
|
# If the params weren't set by a comment then just grab the names.
|
||||||
self._data['params'] = []
|
self._data['params'] = []
|
||||||
prms = self._parse_data.param
|
prms = self._parse_data.param
|
||||||
for prm in prms:
|
for prm in prms:
|
||||||
@@ -121,9 +124,39 @@ class DoxyParam(DoxyMember):
|
|||||||
self.set_descriptions(self._parse_data)
|
self.set_descriptions(self._parse_data)
|
||||||
self._data['declname'] = self._parse_data.declname
|
self._data['declname'] = self._parse_data.declname
|
||||||
|
|
||||||
|
@property
|
||||||
|
def description(self):
|
||||||
|
descriptions = []
|
||||||
|
if self.brief_description:
|
||||||
|
descriptions.append(self.brief_description)
|
||||||
|
if self.detailed_description:
|
||||||
|
descriptions.append(self.detailed_description)
|
||||||
|
return '\n\n'.join(descriptions)
|
||||||
|
|
||||||
brief_description = property(lambda self: self.data()['brief_description'])
|
brief_description = property(lambda self: self.data()['brief_description'])
|
||||||
detailed_description = property(lambda self: self.data()['detailed_description'])
|
detailed_description = property(lambda self: self.data()['detailed_description'])
|
||||||
declname = property(lambda self: self.data()['declname'])
|
name = property(lambda self: self.data()['declname'])
|
||||||
|
|
||||||
|
class DoxyParameterItem(DoxyMember):
|
||||||
|
"""A different representation of a parameter in Doxygen."""
|
||||||
|
|
||||||
|
def _parse(self):
|
||||||
|
if self._parsed:
|
||||||
|
return
|
||||||
|
super(DoxyParameterItem, self)._parse()
|
||||||
|
names = []
|
||||||
|
for nl in self._parse_data.parameternamelist:
|
||||||
|
for pn in nl.parametername:
|
||||||
|
names.append(description(pn))
|
||||||
|
# Just take first name
|
||||||
|
self._data['name'] = names[0]
|
||||||
|
# Get description
|
||||||
|
pd = description(self._parse_data.get_parameterdescription())
|
||||||
|
self._data['description'] = pd
|
||||||
|
|
||||||
|
description = property(lambda self: self.data()['description'])
|
||||||
|
name = property(lambda self: self.data()['name'])
|
||||||
|
|
||||||
|
|
||||||
class DoxyClass(DoxyCompound):
|
class DoxyClass(DoxyCompound):
|
||||||
|
|
||||||
@@ -139,12 +172,14 @@ class DoxyClass(DoxyCompound):
|
|||||||
if self._error:
|
if self._error:
|
||||||
return
|
return
|
||||||
self.set_descriptions(self._retrieved_data.compounddef)
|
self.set_descriptions(self._retrieved_data.compounddef)
|
||||||
|
self.set_parameters(self._retrieved_data.compounddef)
|
||||||
# Sectiondef.kind tells about whether private or public.
|
# Sectiondef.kind tells about whether private or public.
|
||||||
# We just ignore this for now.
|
# We just ignore this for now.
|
||||||
self.process_memberdefs()
|
self.process_memberdefs()
|
||||||
|
|
||||||
brief_description = property(lambda self: self.data()['brief_description'])
|
brief_description = property(lambda self: self.data()['brief_description'])
|
||||||
detailed_description = property(lambda self: self.data()['detailed_description'])
|
detailed_description = property(lambda self: self.data()['detailed_description'])
|
||||||
|
params = property(lambda self: self.data()['params'])
|
||||||
|
|
||||||
Base.mem_classes.append(DoxyClass)
|
Base.mem_classes.append(DoxyClass)
|
||||||
|
|
||||||
@@ -177,6 +212,16 @@ class DoxyNamespace(DoxyCompound):
|
|||||||
|
|
||||||
kind = 'namespace'
|
kind = 'namespace'
|
||||||
|
|
||||||
|
def _parse(self):
|
||||||
|
if self._parsed:
|
||||||
|
return
|
||||||
|
super(DoxyNamespace, self)._parse()
|
||||||
|
self.retrieve_data()
|
||||||
|
self.set_descriptions(self._retrieved_data.compounddef)
|
||||||
|
if self._error:
|
||||||
|
return
|
||||||
|
self.process_memberdefs()
|
||||||
|
|
||||||
Base.mem_classes.append(DoxyNamespace)
|
Base.mem_classes.append(DoxyNamespace)
|
||||||
|
|
||||||
|
|
||||||
@@ -227,11 +272,11 @@ class DoxyOther(Base):
|
|||||||
|
|
||||||
__module__ = "gnuradio.utils.doxyxml"
|
__module__ = "gnuradio.utils.doxyxml"
|
||||||
|
|
||||||
kinds = set(['variable', 'struct', 'union', 'define', 'typedef', 'enum', 'dir', 'page'])
|
kinds = set(['variable', 'struct', 'union', 'define', 'typedef', 'enum',
|
||||||
|
'dir', 'page', 'signal', 'slot', 'property'])
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def can_parse(cls, obj):
|
def can_parse(cls, obj):
|
||||||
return obj.kind in cls.kinds
|
return obj.kind in cls.kinds
|
||||||
|
|
||||||
Base.mem_classes.append(DoxyOther)
|
Base.mem_classes.append(DoxyOther)
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,50 +0,0 @@
|
|||||||
/* -*- 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 <iostream>
|
|
||||||
#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;
|
|
||||||
}
|
|
||||||
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
/* -*- 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 <iostream>
|
|
||||||
|
|
||||||
/*!
|
|
||||||
* \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();
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
||||||
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.6.3">
|
|
||||||
<compounddef id="aadvark_8cc" kind="file">
|
|
||||||
<compoundname>aadvark.cc</compoundname>
|
|
||||||
<includes local="no">iostream</includes>
|
|
||||||
<includes refid="aadvark_8cc" local="yes">aadvark.h</includes>
|
|
||||||
<includedby refid="aadvark_8cc" local="yes">aadvark.cc</includedby>
|
|
||||||
<incdepgraph>
|
|
||||||
<node id="0">
|
|
||||||
<label>aadvark.cc</label>
|
|
||||||
<link refid="aadvark.cc"/>
|
|
||||||
<childnode refid="1" relation="include">
|
|
||||||
</childnode>
|
|
||||||
</node>
|
|
||||||
<node id="1">
|
|
||||||
<label>iostream</label>
|
|
||||||
</node>
|
|
||||||
</incdepgraph>
|
|
||||||
<sectiondef kind="func">
|
|
||||||
<memberdef kind="function" id="aadvark_8cc_1acb52858524210ec6dddc3e16d1e52946" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
||||||
<type>bool</type>
|
|
||||||
<definition>bool aadvarky_enough</definition>
|
|
||||||
<argsstring>(Aadvark aad)</argsstring>
|
|
||||||
<name>aadvarky_enough</name>
|
|
||||||
<param>
|
|
||||||
<type><ref refid="classAadvark" kindref="compound">Aadvark</ref></type>
|
|
||||||
<declname>aad</declname>
|
|
||||||
</param>
|
|
||||||
<briefdescription>
|
|
||||||
</briefdescription>
|
|
||||||
<detaileddescription>
|
|
||||||
</detaileddescription>
|
|
||||||
<inbodydescription>
|
|
||||||
</inbodydescription>
|
|
||||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" line="10" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="10" bodyend="15"/>
|
|
||||||
</memberdef>
|
|
||||||
<memberdef kind="function" id="aadvark_8cc_1ae66f6b31b5ad750f1fe042a706a4e3d4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
||||||
<type>int</type>
|
|
||||||
<definition>int main</definition>
|
|
||||||
<argsstring>()</argsstring>
|
|
||||||
<name>main</name>
|
|
||||||
<briefdescription>
|
|
||||||
</briefdescription>
|
|
||||||
<detaileddescription>
|
|
||||||
</detaileddescription>
|
|
||||||
<inbodydescription>
|
|
||||||
</inbodydescription>
|
|
||||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" line="21" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="21" bodyend="28"/>
|
|
||||||
</memberdef>
|
|
||||||
</sectiondef>
|
|
||||||
<briefdescription>
|
|
||||||
</briefdescription>
|
|
||||||
<detaileddescription>
|
|
||||||
</detaileddescription>
|
|
||||||
<programlisting>
|
|
||||||
<codeline lineno="1"><highlight class="preprocessor">#include<sp/><iostream></highlight><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="2"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>"aadvark.h"</highlight><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="3"><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="classAadvark_1abd061aa5f998002e72080a34f512a059" kindref="member" tooltip="Outputs the vital aadvark statistics.">Aadvark::print</ref>()<sp/>{</highlight></codeline>
|
|
||||||
<codeline lineno="5"><highlight class="normal"><sp/><sp/>std::cout<sp/><<<sp/></highlight><highlight class="stringliteral">"aadvark<sp/>is<sp/>"</highlight><highlight class="normal"><sp/><<<sp/>aadvarkness<sp/><<<sp/></highlight><highlight class="stringliteral">"/10<sp/>aadvarky"</highlight><highlight class="normal"><sp/><<<sp/>std::endl;</highlight></codeline>
|
|
||||||
<codeline lineno="6"><highlight class="normal">}</highlight></codeline>
|
|
||||||
<codeline lineno="7"><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="8"><highlight class="normal"><ref refid="classAadvark_1adf1a4b97a641411a74a04ab312484462" kindref="member">Aadvark::Aadvark</ref>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>aaness):<sp/>aadvarkness(aaness)<sp/>{}</highlight></codeline>
|
|
||||||
<codeline lineno="9"><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="10"><highlight class="normal"></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/>aadvarky_enough(<ref refid="classAadvark" kindref="compound" tooltip="Models the mammal Aadvark.">Aadvark</ref><sp/>aad)<sp/>{</highlight></codeline>
|
|
||||||
<codeline lineno="11"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(aad.get_aadvarkness()<sp/>><sp/>6)</highlight></codeline>
|
|
||||||
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">true</highlight><highlight class="normal">;</highlight></codeline>
|
|
||||||
<codeline lineno="13"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">else</highlight><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">false</highlight><highlight class="normal">;</highlight></codeline>
|
|
||||||
<codeline lineno="15"><highlight class="normal">}</highlight></codeline>
|
|
||||||
<codeline lineno="16"><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="17"><highlight class="normal"></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>Aadvark::get_aadvarkness()<sp/>{</highlight></codeline>
|
|
||||||
<codeline lineno="18"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>aadvarkness;</highlight></codeline>
|
|
||||||
<codeline lineno="19"><highlight class="normal">}</highlight></codeline>
|
|
||||||
<codeline lineno="20"><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="21"><highlight class="normal"></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>main()<sp/>{</highlight></codeline>
|
|
||||||
<codeline lineno="22"><highlight class="normal"><sp/><sp/><ref refid="classAadvark" kindref="compound" tooltip="Models the mammal Aadvark.">Aadvark</ref><sp/>arold<sp/>=<sp/><ref refid="classAadvark" kindref="compound" tooltip="Models the mammal Aadvark.">Aadvark</ref>(6);</highlight></codeline>
|
|
||||||
<codeline lineno="23"><highlight class="normal"><sp/><sp/>arold.<ref refid="classAadvark_1abd061aa5f998002e72080a34f512a059" kindref="member" tooltip="Outputs the vital aadvark statistics.">print</ref>();</highlight></codeline>
|
|
||||||
<codeline lineno="24"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(aadvarky_enough(arold))</highlight></codeline>
|
|
||||||
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/>std::cout<sp/><<<sp/></highlight><highlight class="stringliteral">"He<sp/>is<sp/>aadvarky<sp/>enough"</highlight><highlight class="normal"><sp/><<<sp/>std::endl;</highlight></codeline>
|
|
||||||
<codeline lineno="26"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordflow">else</highlight><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/>std::cout<sp/><<<sp/></highlight><highlight class="stringliteral">"He<sp/>is<sp/>not<sp/>aadvarky<sp/>enough"</highlight><highlight class="normal"><sp/><<<sp/>std::endl;</highlight></codeline>
|
|
||||||
<codeline lineno="28"><highlight class="normal">}</highlight></codeline>
|
|
||||||
<codeline lineno="29"><highlight class="normal"></highlight></codeline>
|
|
||||||
</programlisting>
|
|
||||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc"/>
|
|
||||||
</compounddef>
|
|
||||||
</doxygen>
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
||||||
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.6.3">
|
|
||||||
<compounddef id="aadvark_8h" kind="file">
|
|
||||||
<compoundname>aadvark.h</compoundname>
|
|
||||||
<includes local="no">iostream</includes>
|
|
||||||
<incdepgraph>
|
|
||||||
<node id="3">
|
|
||||||
<label>aadvark.h</label>
|
|
||||||
<link refid="aadvark.h"/>
|
|
||||||
<childnode refid="4" relation="include">
|
|
||||||
</childnode>
|
|
||||||
</node>
|
|
||||||
<node id="4">
|
|
||||||
<label>iostream</label>
|
|
||||||
</node>
|
|
||||||
</incdepgraph>
|
|
||||||
<innerclass refid="classAadvark" prot="public">Aadvark</innerclass>
|
|
||||||
<sectiondef kind="func">
|
|
||||||
<memberdef kind="function" id="aadvark_8h_1acb52858524210ec6dddc3e16d1e52946" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
||||||
<type>bool</type>
|
|
||||||
<definition>bool aadvarky_enough</definition>
|
|
||||||
<argsstring>(Aadvark aad)</argsstring>
|
|
||||||
<name>aadvarky_enough</name>
|
|
||||||
<param>
|
|
||||||
<type><ref refid="classAadvark" kindref="compound">Aadvark</ref></type>
|
|
||||||
<declname>aad</declname>
|
|
||||||
</param>
|
|
||||||
<briefdescription>
|
|
||||||
</briefdescription>
|
|
||||||
<detaileddescription>
|
|
||||||
</detaileddescription>
|
|
||||||
<inbodydescription>
|
|
||||||
</inbodydescription>
|
|
||||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="21" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="10" bodyend="15"/>
|
|
||||||
</memberdef>
|
|
||||||
<memberdef kind="function" id="aadvark_8h_1ae66f6b31b5ad750f1fe042a706a4e3d4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
||||||
<type>int</type>
|
|
||||||
<definition>int main</definition>
|
|
||||||
<argsstring>()</argsstring>
|
|
||||||
<name>main</name>
|
|
||||||
<briefdescription>
|
|
||||||
</briefdescription>
|
|
||||||
<detaileddescription>
|
|
||||||
</detaileddescription>
|
|
||||||
<inbodydescription>
|
|
||||||
</inbodydescription>
|
|
||||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="23" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="21" bodyend="28"/>
|
|
||||||
</memberdef>
|
|
||||||
</sectiondef>
|
|
||||||
<briefdescription>
|
|
||||||
</briefdescription>
|
|
||||||
<detaileddescription>
|
|
||||||
</detaileddescription>
|
|
||||||
<programlisting>
|
|
||||||
<codeline lineno="1"><highlight class="preprocessor">#include<sp/><iostream></highlight><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="2"><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="10" refid="classAadvark" refkind="compound"><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="classAadvark" kindref="compound" tooltip="Models the mammal Aadvark.">Aadvark</ref><sp/>{</highlight></codeline>
|
|
||||||
<codeline lineno="11"><highlight class="normal"></highlight><highlight class="keyword">public</highlight><highlight class="normal">:</highlight></codeline>
|
|
||||||
<codeline lineno="13"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="classAadvark_1abd061aa5f998002e72080a34f512a059" kindref="member" tooltip="Outputs the vital aadvark statistics.">print</ref>();</highlight></codeline>
|
|
||||||
<codeline lineno="15"><highlight class="normal"><sp/><sp/><ref refid="classAadvark_1adf1a4b97a641411a74a04ab312484462" kindref="member">Aadvark</ref>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>aaness);</highlight></codeline>
|
|
||||||
<codeline lineno="16"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>get_aadvarkness();</highlight></codeline>
|
|
||||||
<codeline lineno="17"><highlight class="normal"></highlight><highlight class="keyword">private</highlight><highlight class="normal">:</highlight></codeline>
|
|
||||||
<codeline lineno="18"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>aadvarkness;</highlight></codeline>
|
|
||||||
<codeline lineno="19"><highlight class="normal">};</highlight></codeline>
|
|
||||||
<codeline lineno="20"><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="21"><highlight class="normal"></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/>aadvarky_enough(<ref refid="classAadvark" kindref="compound" tooltip="Models the mammal Aadvark.">Aadvark</ref><sp/>aad);</highlight></codeline>
|
|
||||||
<codeline lineno="22"><highlight class="normal"></highlight></codeline>
|
|
||||||
<codeline lineno="23"><highlight class="normal"></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>main();</highlight></codeline>
|
|
||||||
</programlisting>
|
|
||||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h"/>
|
|
||||||
</compounddef>
|
|
||||||
</doxygen>
|
|
||||||
@@ -1,86 +0,0 @@
|
|||||||
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
||||||
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.6.3">
|
|
||||||
<compounddef id="classAadvark" kind="class" prot="public">
|
|
||||||
<compoundname>Aadvark</compoundname>
|
|
||||||
<includes refid="aadvark_8h" local="no">aadvark.h</includes>
|
|
||||||
<sectiondef kind="private-attrib">
|
|
||||||
<memberdef kind="variable" id="classAadvark_1ab79eb58d7bb9d5ddfa5d6f783836cab9" prot="private" static="no" mutable="no">
|
|
||||||
<type>int</type>
|
|
||||||
<definition>int Aadvark::aadvarkness</definition>
|
|
||||||
<argsstring></argsstring>
|
|
||||||
<name>aadvarkness</name>
|
|
||||||
<briefdescription>
|
|
||||||
</briefdescription>
|
|
||||||
<detaileddescription>
|
|
||||||
</detaileddescription>
|
|
||||||
<inbodydescription>
|
|
||||||
</inbodydescription>
|
|
||||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="18" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" bodystart="18" bodyend="-1"/>
|
|
||||||
</memberdef>
|
|
||||||
</sectiondef>
|
|
||||||
<sectiondef kind="public-func">
|
|
||||||
<memberdef kind="function" id="classAadvark_1abd061aa5f998002e72080a34f512a059" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
||||||
<type>void</type>
|
|
||||||
<definition>void Aadvark::print</definition>
|
|
||||||
<argsstring>()</argsstring>
|
|
||||||
<name>print</name>
|
|
||||||
<briefdescription>
|
|
||||||
<para>Outputs the vital aadvark statistics. </para> </briefdescription>
|
|
||||||
<detaileddescription>
|
|
||||||
</detaileddescription>
|
|
||||||
<inbodydescription>
|
|
||||||
</inbodydescription>
|
|
||||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="13" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="4" bodyend="6"/>
|
|
||||||
</memberdef>
|
|
||||||
<memberdef kind="function" id="classAadvark_1adf1a4b97a641411a74a04ab312484462" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
||||||
<type></type>
|
|
||||||
<definition>Aadvark::Aadvark</definition>
|
|
||||||
<argsstring>(int aaness)</argsstring>
|
|
||||||
<name>Aadvark</name>
|
|
||||||
<param>
|
|
||||||
<type>int</type>
|
|
||||||
<declname>aaness</declname>
|
|
||||||
</param>
|
|
||||||
<briefdescription>
|
|
||||||
</briefdescription>
|
|
||||||
<detaileddescription>
|
|
||||||
<para><parameterlist kind="param"><parameteritem>
|
|
||||||
<parameternamelist>
|
|
||||||
<parametername>aaness</parametername>
|
|
||||||
</parameternamelist>
|
|
||||||
<parameterdescription>
|
|
||||||
<para>The aadvarkness of an aadvark is a measure of how aadvarky it is. </para></parameterdescription>
|
|
||||||
</parameteritem>
|
|
||||||
</parameterlist>
|
|
||||||
</para> </detaileddescription>
|
|
||||||
<inbodydescription>
|
|
||||||
</inbodydescription>
|
|
||||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="15" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="8" bodyend="8"/>
|
|
||||||
</memberdef>
|
|
||||||
<memberdef kind="function" id="classAadvark_1affd2ada0a85807efcbe26615a848f53e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
||||||
<type>int</type>
|
|
||||||
<definition>int Aadvark::get_aadvarkness</definition>
|
|
||||||
<argsstring>()</argsstring>
|
|
||||||
<name>get_aadvarkness</name>
|
|
||||||
<briefdescription>
|
|
||||||
</briefdescription>
|
|
||||||
<detaileddescription>
|
|
||||||
</detaileddescription>
|
|
||||||
<inbodydescription>
|
|
||||||
</inbodydescription>
|
|
||||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="16" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.cc" bodystart="17" bodyend="19"/>
|
|
||||||
</memberdef>
|
|
||||||
</sectiondef>
|
|
||||||
<briefdescription>
|
|
||||||
<para>Models the mammal <ref refid="classAadvark" kindref="compound">Aadvark</ref>. </para> </briefdescription>
|
|
||||||
<detaileddescription>
|
|
||||||
<para>Sadly the model is incomplete and cannot capture all aspects of an aadvark yet.</para><para>This line is uninformative and is only to test line breaks in the comments. </para> </detaileddescription>
|
|
||||||
<location file="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" line="10" bodyfile="/home/ben/gnuradio/gnuradio-core/src/python/gnuradio/utils/doxyxml/example/aadvark.h" bodystart="10" bodyend="19"/>
|
|
||||||
<listofallmembers>
|
|
||||||
<member refid="classAadvark_1adf1a4b97a641411a74a04ab312484462" prot="public" virt="non-virtual"><scope>Aadvark</scope><name>Aadvark</name></member>
|
|
||||||
<member refid="classAadvark_1ab79eb58d7bb9d5ddfa5d6f783836cab9" prot="private" virt="non-virtual"><scope>Aadvark</scope><name>aadvarkness</name></member>
|
|
||||||
<member refid="classAadvark_1affd2ada0a85807efcbe26615a848f53e" prot="public" virt="non-virtual"><scope>Aadvark</scope><name>get_aadvarkness</name></member>
|
|
||||||
<member refid="classAadvark_1abd061aa5f998002e72080a34f512a059" prot="public" virt="non-virtual"><scope>Aadvark</scope><name>print</name></member>
|
|
||||||
</listofallmembers>
|
|
||||||
</compounddef>
|
|
||||||
</doxygen>
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
<!-- XSLT script to combine the generated output into a single file.
|
|
||||||
If you have xsltproc you could use:
|
|
||||||
xsltproc combine.xslt index.xml >all.xml
|
|
||||||
-->
|
|
||||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
|
||||||
<xsl:output method="xml" version="1.0" indent="yes" standalone="yes" />
|
|
||||||
<xsl:template match="/">
|
|
||||||
<doxygen version="{doxygenindex/@version}">
|
|
||||||
<!-- Load all doxgen generated xml files -->
|
|
||||||
<xsl:for-each select="doxygenindex/compound">
|
|
||||||
<xsl:copy-of select="document( concat( @refid, '.xml' ) )/doxygen/*" />
|
|
||||||
</xsl:for-each>
|
|
||||||
</doxygen>
|
|
||||||
</xsl:template>
|
|
||||||
</xsl:stylesheet>
|
|
||||||
@@ -1,814 +0,0 @@
|
|||||||
<?xml version='1.0' encoding='utf-8' ?>
|
|
||||||
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
|
|
||||||
<xsd:element name="doxygen" type="DoxygenType"/>
|
|
||||||
|
|
||||||
<!-- Complex types -->
|
|
||||||
|
|
||||||
<xsd:complexType name="DoxygenType">
|
|
||||||
<xsd:sequence maxOccurs="unbounded">
|
|
||||||
<xsd:element name="compounddef" type="compounddefType" minOccurs="0" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="version" type="DoxVersionNumber" use="required" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="compounddefType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="compoundname" type="xsd:string"/>
|
|
||||||
<xsd:element name="title" type="xsd:string" minOccurs="0" />
|
|
||||||
<xsd:element name="basecompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="derivedcompoundref" type="compoundRefType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="includes" type="incType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="includedby" type="incType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="incdepgraph" type="graphType" minOccurs="0" />
|
|
||||||
<xsd:element name="invincdepgraph" type="graphType" minOccurs="0" />
|
|
||||||
<xsd:element name="innerdir" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="innerfile" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="innerclass" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="innernamespace" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="innerpage" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="innergroup" type="refType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
|
|
||||||
<xsd:element name="sectiondef" type="sectiondefType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
|
|
||||||
<xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
|
|
||||||
<xsd:element name="inheritancegraph" type="graphType" minOccurs="0" />
|
|
||||||
<xsd:element name="collaborationgraph" type="graphType" minOccurs="0" />
|
|
||||||
<xsd:element name="programlisting" type="listingType" minOccurs="0" />
|
|
||||||
<xsd:element name="location" type="locationType" minOccurs="0" />
|
|
||||||
<xsd:element name="listofallmembers" type="listofallmembersType" minOccurs="0" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
<xsd:attribute name="kind" type="DoxCompoundKind" />
|
|
||||||
<xsd:attribute name="prot" type="DoxProtectionKind" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="listofallmembersType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="member" type="memberRefType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="memberRefType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="scope" />
|
|
||||||
<xsd:element name="name" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" />
|
|
||||||
<xsd:attribute name="prot" type="DoxProtectionKind" />
|
|
||||||
<xsd:attribute name="virt" type="DoxVirtualKind" />
|
|
||||||
<xsd:attribute name="ambiguityscope" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="compoundRefType" mixed="true">
|
|
||||||
<xsd:simpleContent>
|
|
||||||
<xsd:extension base="xsd:string">
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" use="optional" />
|
|
||||||
<xsd:attribute name="prot" type="DoxProtectionKind" />
|
|
||||||
<xsd:attribute name="virt" type="DoxVirtualKind" />
|
|
||||||
</xsd:extension>
|
|
||||||
</xsd:simpleContent>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="reimplementType" mixed="true">
|
|
||||||
<xsd:simpleContent>
|
|
||||||
<xsd:extension base="xsd:string">
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" />
|
|
||||||
</xsd:extension>
|
|
||||||
</xsd:simpleContent>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="incType" mixed="true">
|
|
||||||
<xsd:simpleContent>
|
|
||||||
<xsd:extension base="xsd:string">
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" />
|
|
||||||
<xsd:attribute name="local" type="DoxBool" />
|
|
||||||
</xsd:extension>
|
|
||||||
</xsd:simpleContent>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="refType" mixed="true">
|
|
||||||
<xsd:simpleContent>
|
|
||||||
<xsd:extension base="xsd:string">
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" />
|
|
||||||
<xsd:attribute name="prot" type="DoxProtectionKind" use="optional"/>
|
|
||||||
</xsd:extension>
|
|
||||||
</xsd:simpleContent>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="refTextType" mixed="true">
|
|
||||||
<xsd:simpleContent>
|
|
||||||
<xsd:extension base="xsd:string">
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" />
|
|
||||||
<xsd:attribute name="kindref" type="DoxRefKind" />
|
|
||||||
<xsd:attribute name="external" type="xsd:string" use="optional"/>
|
|
||||||
<xsd:attribute name="tooltip" type="xsd:string" use="optional"/>
|
|
||||||
</xsd:extension>
|
|
||||||
</xsd:simpleContent>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="sectiondefType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="header" type="xsd:string" minOccurs="0" />
|
|
||||||
<xsd:element name="description" type="descriptionType" minOccurs="0" />
|
|
||||||
<xsd:element name="memberdef" type="memberdefType" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="kind" type="DoxSectionKind" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="memberdefType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="templateparamlist" type="templateparamlistType" minOccurs="0" />
|
|
||||||
<xsd:element name="type" type="linkedTextType" minOccurs="0" />
|
|
||||||
<xsd:element name="definition" minOccurs="0" />
|
|
||||||
<xsd:element name="argsstring" minOccurs="0" />
|
|
||||||
<xsd:element name="name" />
|
|
||||||
<xsd:element name="read" minOccurs="0" />
|
|
||||||
<xsd:element name="write" minOccurs="0" />
|
|
||||||
<xsd:element name="bitfield" minOccurs="0" />
|
|
||||||
<xsd:element name="reimplements" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="reimplementedby" type="reimplementType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="enumvalue" type="enumvalueType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
|
|
||||||
<xsd:element name="exceptions" type="linkedTextType" minOccurs="0" />
|
|
||||||
<xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
|
|
||||||
<xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
|
|
||||||
<xsd:element name="inbodydescription" type="descriptionType" minOccurs="0" />
|
|
||||||
<xsd:element name="location" type="locationType" />
|
|
||||||
<xsd:element name="references" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="referencedby" type="referenceType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="kind" type="DoxMemberKind" />
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
<xsd:attribute name="prot" type="DoxProtectionKind" />
|
|
||||||
<xsd:attribute name="static" type="DoxBool" />
|
|
||||||
<xsd:attribute name="const" type="DoxBool" />
|
|
||||||
<xsd:attribute name="explicit" type="DoxBool" />
|
|
||||||
<xsd:attribute name="inline" type="DoxBool" />
|
|
||||||
<xsd:attribute name="virt" type="DoxVirtualKind" />
|
|
||||||
<xsd:attribute name="volatile" type="DoxBool" />
|
|
||||||
<xsd:attribute name="mutable" type="DoxBool" />
|
|
||||||
<!-- Qt property -->
|
|
||||||
<xsd:attribute name="readable" type="DoxBool" use="optional"/>
|
|
||||||
<xsd:attribute name="writable" type="DoxBool" use="optional"/>
|
|
||||||
<!-- C++/CLI variable -->
|
|
||||||
<xsd:attribute name="initonly" type="DoxBool" use="optional"/>
|
|
||||||
<!-- C++/CLI and C# property -->
|
|
||||||
<xsd:attribute name="settable" type="DoxBool" use="optional"/>
|
|
||||||
<xsd:attribute name="gettable" type="DoxBool" use="optional"/>
|
|
||||||
<!-- C++/CLI function -->
|
|
||||||
<xsd:attribute name="final" type="DoxBool" use="optional"/>
|
|
||||||
<xsd:attribute name="sealed" type="DoxBool" use="optional"/>
|
|
||||||
<xsd:attribute name="new" type="DoxBool" use="optional"/>
|
|
||||||
<!-- C++/CLI event -->
|
|
||||||
<xsd:attribute name="add" type="DoxBool" use="optional"/>
|
|
||||||
<xsd:attribute name="remove" type="DoxBool" use="optional"/>
|
|
||||||
<xsd:attribute name="raise" type="DoxBool" use="optional"/>
|
|
||||||
<!-- Objective-C 2.0 protocol method -->
|
|
||||||
<xsd:attribute name="optional" type="DoxBool" use="optional"/>
|
|
||||||
<xsd:attribute name="required" type="DoxBool" use="optional"/>
|
|
||||||
<!-- Objective-C 2.0 property accessor -->
|
|
||||||
<xsd:attribute name="accessor" type="DoxAccessor" use="optional"/>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="descriptionType" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="title" type="xsd:string" minOccurs="0"/>
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="internal" type="docInternalType" minOccurs="0" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="enumvalueType" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="name" />
|
|
||||||
<xsd:element name="initializer" type="linkedTextType" minOccurs="0" />
|
|
||||||
<xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
|
|
||||||
<xsd:element name="detaileddescription" type="descriptionType" minOccurs="0" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
<xsd:attribute name="prot" type="DoxProtectionKind" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="templateparamlistType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="param" type="paramType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="paramType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="type" type="linkedTextType" minOccurs="0" />
|
|
||||||
<xsd:element name="declname" minOccurs="0" />
|
|
||||||
<xsd:element name="defname" minOccurs="0" />
|
|
||||||
<xsd:element name="array" minOccurs="0" />
|
|
||||||
<xsd:element name="defval" type="linkedTextType" minOccurs="0" />
|
|
||||||
<xsd:element name="briefdescription" type="descriptionType" minOccurs="0" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="linkedTextType" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="graphType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="node" type="nodeType" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="nodeType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="label" />
|
|
||||||
<xsd:element name="link" type="linkType" minOccurs="0" />
|
|
||||||
<xsd:element name="childnode" type="childnodeType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="childnodeType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="edgelabel" minOccurs="0" maxOccurs="unbounded"/>
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" />
|
|
||||||
<xsd:attribute name="relation" type="DoxGraphRelation" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="linkType">
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" />
|
|
||||||
<xsd:attribute name="external" type="xsd:string" use="optional"/>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="listingType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="codeline" type="codelineType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="codelineType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="highlight" type="highlightType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="lineno" type="xsd:integer" />
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" />
|
|
||||||
<xsd:attribute name="refkind" type="DoxRefKind" />
|
|
||||||
<xsd:attribute name="external" type="DoxBool" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="highlightType" mixed="true">
|
|
||||||
<xsd:choice minOccurs="0" maxOccurs="unbounded">
|
|
||||||
<xsd:element name="sp" />
|
|
||||||
<xsd:element name="ref" type="refTextType" />
|
|
||||||
</xsd:choice>
|
|
||||||
<xsd:attribute name="class" type="DoxHighlightClass" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="referenceType" mixed="true">
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" />
|
|
||||||
<xsd:attribute name="compoundref" type="xsd:string" use="optional" />
|
|
||||||
<xsd:attribute name="startline" type="xsd:integer" />
|
|
||||||
<xsd:attribute name="endline" type="xsd:integer" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="locationType">
|
|
||||||
<xsd:attribute name="file" type="xsd:string" />
|
|
||||||
<xsd:attribute name="line" type="xsd:integer" />
|
|
||||||
<xsd:attribute name="bodyfile" type="xsd:string" />
|
|
||||||
<xsd:attribute name="bodystart" type="xsd:integer" />
|
|
||||||
<xsd:attribute name="bodyend" type="xsd:integer" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docSect1Type" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="title" type="xsd:string" />
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="internal" type="docInternalS1Type" minOccurs="0" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docSect2Type" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="title" type="xsd:string" />
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="internal" type="docInternalS2Type" minOccurs="0" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docSect3Type" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="title" type="xsd:string" />
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="sect4" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="internal" type="docInternalS3Type" minOccurs="0" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docSect4Type" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="title" type="xsd:string" />
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="internal" type="docInternalS4Type" minOccurs="0" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docInternalType" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docInternalS1Type" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="sect2" type="docSect2Type" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docInternalS2Type" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="sect3" type="docSect3Type" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docInternalS3Type" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="sect3" type="docSect4Type" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docInternalS4Type" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:group name="docTitleCmdGroup">
|
|
||||||
<xsd:choice>
|
|
||||||
<xsd:element name="ulink" type="docURLLink" />
|
|
||||||
<xsd:element name="bold" type="docMarkupType" />
|
|
||||||
<xsd:element name="emphasis" type="docMarkupType" />
|
|
||||||
<xsd:element name="computeroutput" type="docMarkupType" />
|
|
||||||
<xsd:element name="subscript" type="docMarkupType" />
|
|
||||||
<xsd:element name="superscript" type="docMarkupType" />
|
|
||||||
<xsd:element name="center" type="docMarkupType" />
|
|
||||||
<xsd:element name="small" type="docMarkupType" />
|
|
||||||
<xsd:element name="htmlonly" type="xsd:string" />
|
|
||||||
<xsd:element name="latexonly" type="xsd:string" />
|
|
||||||
<xsd:element name="dot" type="xsd:string" />
|
|
||||||
<xsd:element name="anchor" type="docAnchorType" />
|
|
||||||
<xsd:element name="formula" type="docFormulaType" />
|
|
||||||
<xsd:element name="ref" type="docRefTextType" />
|
|
||||||
<xsd:element name="copy" type="docEmptyType" />
|
|
||||||
<xsd:element name="trademark" type="docEmptyType" />
|
|
||||||
<xsd:element name="registered" type="docEmptyType" />
|
|
||||||
<xsd:element name="lsquo" type="docEmptyType" />
|
|
||||||
<xsd:element name="rsquo" type="docEmptyType" />
|
|
||||||
<xsd:element name="ldquo" type="docEmptyType" />
|
|
||||||
<xsd:element name="rdquo" type="docEmptyType" />
|
|
||||||
<xsd:element name="ndash" type="docEmptyType" />
|
|
||||||
<xsd:element name="mdash" type="docEmptyType" />
|
|
||||||
<xsd:element name="umlaut" type="docCharType" />
|
|
||||||
<xsd:element name="acute" type="docCharType" />
|
|
||||||
<xsd:element name="grave" type="docCharType" />
|
|
||||||
<xsd:element name="circ" type="docCharType" />
|
|
||||||
<xsd:element name="slash" type="docCharType" />
|
|
||||||
<xsd:element name="tilde" type="docCharType" />
|
|
||||||
<xsd:element name="cedil" type="docCharType" />
|
|
||||||
<xsd:element name="ring" type="docCharType" />
|
|
||||||
<xsd:element name="szlig" type="docEmptyType" />
|
|
||||||
<xsd:element name="nonbreakablespace" type="docEmptyType" />
|
|
||||||
</xsd:choice>
|
|
||||||
</xsd:group>
|
|
||||||
|
|
||||||
<xsd:complexType name="docTitleType" mixed="true">
|
|
||||||
<xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:group name="docCmdGroup">
|
|
||||||
<xsd:choice>
|
|
||||||
<xsd:group ref="docTitleCmdGroup"/>
|
|
||||||
<xsd:element name="linebreak" type="docEmptyType" />
|
|
||||||
<xsd:element name="hruler" type="docEmptyType" />
|
|
||||||
<xsd:element name="preformatted" type="docMarkupType" />
|
|
||||||
<xsd:element name="programlisting" type="listingType" />
|
|
||||||
<xsd:element name="verbatim" type="xsd:string" />
|
|
||||||
<xsd:element name="indexentry" type="docIndexEntryType" />
|
|
||||||
<xsd:element name="orderedlist" type="docListType" />
|
|
||||||
<xsd:element name="itemizedlist" type="docListType" />
|
|
||||||
<xsd:element name="simplesect" type="docSimpleSectType" />
|
|
||||||
<xsd:element name="title" type="docTitleType" />
|
|
||||||
<xsd:element name="variablelist" type="docVariableListType" />
|
|
||||||
<xsd:element name="table" type="docTableType" />
|
|
||||||
<xsd:element name="heading" type="docHeadingType" />
|
|
||||||
<xsd:element name="image" type="docImageType" />
|
|
||||||
<xsd:element name="dotfile" type="docDotFileType" />
|
|
||||||
<xsd:element name="toclist" type="docTocListType" />
|
|
||||||
<xsd:element name="language" type="docLanguageType" />
|
|
||||||
<xsd:element name="parameterlist" type="docParamListType" />
|
|
||||||
<xsd:element name="xrefsect" type="docXRefSectType" />
|
|
||||||
<xsd:element name="copydoc" type="docCopyType" />
|
|
||||||
</xsd:choice>
|
|
||||||
</xsd:group>
|
|
||||||
|
|
||||||
<xsd:complexType name="docParaType" mixed="true">
|
|
||||||
<xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docMarkupType" mixed="true">
|
|
||||||
<xsd:group ref="docCmdGroup" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docURLLink" mixed="true">
|
|
||||||
<xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:attribute name="url" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docAnchorType" mixed="true">
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docFormulaType" mixed="true">
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docIndexEntryType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="primaryie" type="xsd:string" />
|
|
||||||
<xsd:element name="secondaryie" type="xsd:string" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docListType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="listitem" type="docListItemType" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docListItemType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docSimpleSectType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="title" type="docTitleType" minOccurs="0" />
|
|
||||||
<xsd:sequence minOccurs="0" maxOccurs="unbounded">
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="1" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="simplesectsep" type="docEmptyType" minOccurs="0"/>
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="kind" type="DoxSimpleSectKind" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docVarListEntryType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="term" type="docTitleType" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:group name="docVariableListGroup">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="varlistentry" type="docVarListEntryType" />
|
|
||||||
<xsd:element name="listitem" type="docListItemType" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:group>
|
|
||||||
|
|
||||||
<xsd:complexType name="docVariableListType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:group ref="docVariableListGroup" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docRefTextType" mixed="true">
|
|
||||||
<xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" />
|
|
||||||
<xsd:attribute name="kindref" type="DoxRefKind" />
|
|
||||||
<xsd:attribute name="external" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docTableType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="row" type="docRowType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="caption" type="docCaptionType" minOccurs="0" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="rows" type="xsd:integer" />
|
|
||||||
<xsd:attribute name="cols" type="xsd:integer" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docRowType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="entry" type="docEntryType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docEntryType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="thead" type="DoxBool" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docCaptionType" mixed="true">
|
|
||||||
<xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docHeadingType" mixed="true">
|
|
||||||
<xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:attribute name="level" type="xsd:integer" /> <!-- todo: range 1-6 -->
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docImageType" mixed="true">
|
|
||||||
<xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:attribute name="type" type="DoxImageKind" />
|
|
||||||
<xsd:attribute name="name" type="xsd:string" />
|
|
||||||
<xsd:attribute name="width" type="xsd:string" />
|
|
||||||
<xsd:attribute name="height" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docDotFileType" mixed="true">
|
|
||||||
<xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:attribute name="name" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docTocItemType" mixed="true">
|
|
||||||
<xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docTocListType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="tocitem" type="docTocItemType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docLanguageType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="langid" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docParamListType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="parameteritem" type="docParamListItem" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="kind" type="DoxParamListKind" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docParamListItem">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="parameternamelist" type="docParamNameList" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="parameterdescription" type="descriptionType" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docParamNameList">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="parametername" type="docParamName" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
</xsd:sequence>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docParamName" mixed="true">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="direction" type="DoxParamDir" use="optional" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docXRefSectType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="xreftitle" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="xrefdescription" type="descriptionType" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="id" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docCopyType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="para" type="docParaType" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="sect1" type="docSect1Type" minOccurs="0" maxOccurs="unbounded" />
|
|
||||||
<xsd:element name="internal" type="docInternalType" minOccurs="0" />
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="link" type="xsd:string" />
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docCharType">
|
|
||||||
<xsd:attribute name="char" type="DoxCharRange"/>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="docEmptyType"/>
|
|
||||||
|
|
||||||
<!-- Simple types -->
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxBool">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="yes" />
|
|
||||||
<xsd:enumeration value="no" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxGraphRelation">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="include" />
|
|
||||||
<xsd:enumeration value="usage" />
|
|
||||||
<xsd:enumeration value="template-instance" />
|
|
||||||
<xsd:enumeration value="public-inheritance" />
|
|
||||||
<xsd:enumeration value="protected-inheritance" />
|
|
||||||
<xsd:enumeration value="private-inheritance" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxRefKind">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="compound" />
|
|
||||||
<xsd:enumeration value="member" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxMemberKind">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="define" />
|
|
||||||
<xsd:enumeration value="property" />
|
|
||||||
<xsd:enumeration value="event" />
|
|
||||||
<xsd:enumeration value="variable" />
|
|
||||||
<xsd:enumeration value="typedef" />
|
|
||||||
<xsd:enumeration value="enum" />
|
|
||||||
<xsd:enumeration value="function" />
|
|
||||||
<xsd:enumeration value="signal" />
|
|
||||||
<xsd:enumeration value="prototype" />
|
|
||||||
<xsd:enumeration value="friend" />
|
|
||||||
<xsd:enumeration value="dcop" />
|
|
||||||
<xsd:enumeration value="slot" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxProtectionKind">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="public" />
|
|
||||||
<xsd:enumeration value="protected" />
|
|
||||||
<xsd:enumeration value="private" />
|
|
||||||
<xsd:enumeration value="package" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxVirtualKind">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="non-virtual" />
|
|
||||||
<xsd:enumeration value="virtual" />
|
|
||||||
<xsd:enumeration value="pure-virtual" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxCompoundKind">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="class" />
|
|
||||||
<xsd:enumeration value="struct" />
|
|
||||||
<xsd:enumeration value="union" />
|
|
||||||
<xsd:enumeration value="interface" />
|
|
||||||
<xsd:enumeration value="protocol" />
|
|
||||||
<xsd:enumeration value="category" />
|
|
||||||
<xsd:enumeration value="exception" />
|
|
||||||
<xsd:enumeration value="file" />
|
|
||||||
<xsd:enumeration value="namespace" />
|
|
||||||
<xsd:enumeration value="group" />
|
|
||||||
<xsd:enumeration value="page" />
|
|
||||||
<xsd:enumeration value="example" />
|
|
||||||
<xsd:enumeration value="dir" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxSectionKind">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="user-defined" />
|
|
||||||
<xsd:enumeration value="public-type" />
|
|
||||||
<xsd:enumeration value="public-func" />
|
|
||||||
<xsd:enumeration value="public-attrib" />
|
|
||||||
<xsd:enumeration value="public-slot" />
|
|
||||||
<xsd:enumeration value="signal" />
|
|
||||||
<xsd:enumeration value="dcop-func" />
|
|
||||||
<xsd:enumeration value="property" />
|
|
||||||
<xsd:enumeration value="event" />
|
|
||||||
<xsd:enumeration value="public-static-func" />
|
|
||||||
<xsd:enumeration value="public-static-attrib" />
|
|
||||||
<xsd:enumeration value="protected-type" />
|
|
||||||
<xsd:enumeration value="protected-func" />
|
|
||||||
<xsd:enumeration value="protected-attrib" />
|
|
||||||
<xsd:enumeration value="protected-slot" />
|
|
||||||
<xsd:enumeration value="protected-static-func" />
|
|
||||||
<xsd:enumeration value="protected-static-attrib" />
|
|
||||||
<xsd:enumeration value="package-type" />
|
|
||||||
<xsd:enumeration value="package-func" />
|
|
||||||
<xsd:enumeration value="package-attrib" />
|
|
||||||
<xsd:enumeration value="package-static-func" />
|
|
||||||
<xsd:enumeration value="package-static-attrib" />
|
|
||||||
<xsd:enumeration value="private-type" />
|
|
||||||
<xsd:enumeration value="private-func" />
|
|
||||||
<xsd:enumeration value="private-attrib" />
|
|
||||||
<xsd:enumeration value="private-slot" />
|
|
||||||
<xsd:enumeration value="private-static-func" />
|
|
||||||
<xsd:enumeration value="private-static-attrib" />
|
|
||||||
<xsd:enumeration value="friend" />
|
|
||||||
<xsd:enumeration value="related" />
|
|
||||||
<xsd:enumeration value="define" />
|
|
||||||
<xsd:enumeration value="prototype" />
|
|
||||||
<xsd:enumeration value="typedef" />
|
|
||||||
<xsd:enumeration value="enum" />
|
|
||||||
<xsd:enumeration value="func" />
|
|
||||||
<xsd:enumeration value="var" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxHighlightClass">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="comment" />
|
|
||||||
<xsd:enumeration value="normal" />
|
|
||||||
<xsd:enumeration value="preprocessor" />
|
|
||||||
<xsd:enumeration value="keyword" />
|
|
||||||
<xsd:enumeration value="keywordtype" />
|
|
||||||
<xsd:enumeration value="keywordflow" />
|
|
||||||
<xsd:enumeration value="stringliteral" />
|
|
||||||
<xsd:enumeration value="charliteral" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxSimpleSectKind">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="see" />
|
|
||||||
<xsd:enumeration value="return" />
|
|
||||||
<xsd:enumeration value="author" />
|
|
||||||
<xsd:enumeration value="authors" />
|
|
||||||
<xsd:enumeration value="version" />
|
|
||||||
<xsd:enumeration value="since" />
|
|
||||||
<xsd:enumeration value="date" />
|
|
||||||
<xsd:enumeration value="note" />
|
|
||||||
<xsd:enumeration value="warning" />
|
|
||||||
<xsd:enumeration value="pre" />
|
|
||||||
<xsd:enumeration value="post" />
|
|
||||||
<xsd:enumeration value="invariant" />
|
|
||||||
<xsd:enumeration value="remark" />
|
|
||||||
<xsd:enumeration value="attention" />
|
|
||||||
<xsd:enumeration value="par" />
|
|
||||||
<xsd:enumeration value="rcs" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxVersionNumber">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:pattern value="\d+\.\d+.*" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxImageKind">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="html" />
|
|
||||||
<xsd:enumeration value="latex" />
|
|
||||||
<xsd:enumeration value="rtf" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxParamListKind">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="param" />
|
|
||||||
<xsd:enumeration value="retval" />
|
|
||||||
<xsd:enumeration value="exception" />
|
|
||||||
<xsd:enumeration value="templateparam" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxCharRange">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:pattern value="[aeiouncAEIOUNC]" />
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxParamDir">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="in"/>
|
|
||||||
<xsd:enumeration value="out"/>
|
|
||||||
<xsd:enumeration value="inout"/>
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="DoxAccessor">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="retain"/>
|
|
||||||
<xsd:enumeration value="copy"/>
|
|
||||||
<xsd:enumeration value="assign"/>
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
</xsd:schema>
|
|
||||||
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
||||||
<doxygenindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="index.xsd" version="1.6.3">
|
|
||||||
<compound refid="classAadvark" kind="class"><name>Aadvark</name>
|
|
||||||
<member refid="classAadvark_1ab79eb58d7bb9d5ddfa5d6f783836cab9" kind="variable"><name>aadvarkness</name></member>
|
|
||||||
<member refid="classAadvark_1abd061aa5f998002e72080a34f512a059" kind="function"><name>print</name></member>
|
|
||||||
<member refid="classAadvark_1adf1a4b97a641411a74a04ab312484462" kind="function"><name>Aadvark</name></member>
|
|
||||||
<member refid="classAadvark_1affd2ada0a85807efcbe26615a848f53e" kind="function"><name>get_aadvarkness</name></member>
|
|
||||||
</compound>
|
|
||||||
<compound refid="aadvark_8cc" kind="file"><name>aadvark.cc</name>
|
|
||||||
<member refid="aadvark_8cc_1acb52858524210ec6dddc3e16d1e52946" kind="function"><name>aadvarky_enough</name></member>
|
|
||||||
<member refid="aadvark_8cc_1ae66f6b31b5ad750f1fe042a706a4e3d4" kind="function"><name>main</name></member>
|
|
||||||
</compound>
|
|
||||||
<compound refid="aadvark_8h" kind="file"><name>aadvark.h</name>
|
|
||||||
<member refid="aadvark_8h_1acb52858524210ec6dddc3e16d1e52946" kind="function"><name>aadvarky_enough</name></member>
|
|
||||||
<member refid="aadvark_8h_1ae66f6b31b5ad750f1fe042a706a4e3d4" kind="function"><name>main</name></member>
|
|
||||||
</compound>
|
|
||||||
</doxygenindex>
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
<?xml version='1.0' encoding='utf-8' ?>
|
|
||||||
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
|
|
||||||
<xsd:element name="doxygenindex" type="DoxygenType"/>
|
|
||||||
|
|
||||||
<xsd:complexType name="DoxygenType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="compound" type="CompoundType" minOccurs="0" maxOccurs="unbounded"/>
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="version" type="xsd:string" use="required"/>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="CompoundType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="name" type="xsd:string"/>
|
|
||||||
<xsd:element name="member" type="MemberType" minOccurs="0" maxOccurs="unbounded"/>
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" use="required"/>
|
|
||||||
<xsd:attribute name="kind" type="CompoundKind" use="required"/>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:complexType name="MemberType">
|
|
||||||
<xsd:sequence>
|
|
||||||
<xsd:element name="name" type="xsd:string"/>
|
|
||||||
</xsd:sequence>
|
|
||||||
<xsd:attribute name="refid" type="xsd:string" use="required"/>
|
|
||||||
<xsd:attribute name="kind" type="MemberKind" use="required"/>
|
|
||||||
</xsd:complexType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="CompoundKind">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="class"/>
|
|
||||||
<xsd:enumeration value="struct"/>
|
|
||||||
<xsd:enumeration value="union"/>
|
|
||||||
<xsd:enumeration value="interface"/>
|
|
||||||
<xsd:enumeration value="protocol"/>
|
|
||||||
<xsd:enumeration value="category"/>
|
|
||||||
<xsd:enumeration value="exception"/>
|
|
||||||
<xsd:enumeration value="file"/>
|
|
||||||
<xsd:enumeration value="namespace"/>
|
|
||||||
<xsd:enumeration value="group"/>
|
|
||||||
<xsd:enumeration value="page"/>
|
|
||||||
<xsd:enumeration value="example"/>
|
|
||||||
<xsd:enumeration value="dir"/>
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
<xsd:simpleType name="MemberKind">
|
|
||||||
<xsd:restriction base="xsd:string">
|
|
||||||
<xsd:enumeration value="define"/>
|
|
||||||
<xsd:enumeration value="property"/>
|
|
||||||
<xsd:enumeration value="event"/>
|
|
||||||
<xsd:enumeration value="variable"/>
|
|
||||||
<xsd:enumeration value="typedef"/>
|
|
||||||
<xsd:enumeration value="enum"/>
|
|
||||||
<xsd:enumeration value="enumvalue"/>
|
|
||||||
<xsd:enumeration value="function"/>
|
|
||||||
<xsd:enumeration value="signal"/>
|
|
||||||
<xsd:enumeration value="prototype"/>
|
|
||||||
<xsd:enumeration value="friend"/>
|
|
||||||
<xsd:enumeration value="dcop"/>
|
|
||||||
<xsd:enumeration value="slot"/>
|
|
||||||
</xsd:restriction>
|
|
||||||
</xsd:simpleType>
|
|
||||||
|
|
||||||
</xsd:schema>
|
|
||||||
|
|
||||||
@@ -4,14 +4,14 @@
|
|||||||
Generated Mon Feb 9 19:08:05 2009 by generateDS.py.
|
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 minidom
|
||||||
from xml.dom import Node
|
from xml.dom import Node
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
import compoundsuper as supermod
|
from . import compoundsuper as supermod
|
||||||
from compoundsuper import MixedContainer
|
from .compoundsuper import MixedContainer
|
||||||
|
|
||||||
|
|
||||||
class DoxygenTypeSub(supermod.DoxygenType):
|
class DoxygenTypeSub(supermod.DoxygenType):
|
||||||
|
|||||||
@@ -4,9 +4,9 @@
|
|||||||
# Generated Thu Jun 11 18:44:25 2009 by generateDS.py.
|
# Generated Thu Jun 11 18:44:25 2009 by generateDS.py.
|
||||||
#
|
#
|
||||||
|
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
import getopt
|
|
||||||
from string import lower as str_lower
|
|
||||||
from xml.dom import minidom
|
from xml.dom import minidom
|
||||||
from xml.dom import Node
|
from xml.dom import Node
|
||||||
|
|
||||||
@@ -19,9 +19,9 @@ from xml.dom import Node
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
from generatedssuper import GeneratedsSuper
|
from generatedssuper import GeneratedsSuper
|
||||||
except ImportError, exp:
|
except ImportError as exp:
|
||||||
|
|
||||||
class GeneratedsSuper:
|
class GeneratedsSuper(object):
|
||||||
def format_string(self, input_data, input_name=''):
|
def format_string(self, input_data, input_name=''):
|
||||||
return input_data
|
return input_data
|
||||||
def format_integer(self, input_data, input_name=''):
|
def format_integer(self, input_data, input_name=''):
|
||||||
@@ -64,7 +64,7 @@ def showIndent(outfile, level):
|
|||||||
outfile.write(' ')
|
outfile.write(' ')
|
||||||
|
|
||||||
def quote_xml(inStr):
|
def quote_xml(inStr):
|
||||||
s1 = (isinstance(inStr, basestring) and inStr or
|
s1 = (isinstance(inStr, str) and inStr or
|
||||||
'%s' % inStr)
|
'%s' % inStr)
|
||||||
s1 = s1.replace('&', '&')
|
s1 = s1.replace('&', '&')
|
||||||
s1 = s1.replace('<', '<')
|
s1 = s1.replace('<', '<')
|
||||||
@@ -72,7 +72,7 @@ def quote_xml(inStr):
|
|||||||
return s1
|
return s1
|
||||||
|
|
||||||
def quote_attrib(inStr):
|
def quote_attrib(inStr):
|
||||||
s1 = (isinstance(inStr, basestring) and inStr or
|
s1 = (isinstance(inStr, str) and inStr or
|
||||||
'%s' % inStr)
|
'%s' % inStr)
|
||||||
s1 = s1.replace('&', '&')
|
s1 = s1.replace('&', '&')
|
||||||
s1 = s1.replace('<', '<')
|
s1 = s1.replace('<', '<')
|
||||||
@@ -102,7 +102,7 @@ def quote_python(inStr):
|
|||||||
return '"""%s"""' % s1
|
return '"""%s"""' % s1
|
||||||
|
|
||||||
|
|
||||||
class MixedContainer:
|
class MixedContainer(object):
|
||||||
# Constants for category:
|
# Constants for category:
|
||||||
CategoryNone = 0
|
CategoryNone = 0
|
||||||
CategoryText = 1
|
CategoryText = 1
|
||||||
@@ -4221,7 +4221,7 @@ class codelineType(GeneratedsSuper):
|
|||||||
if attrs.get('lineno'):
|
if attrs.get('lineno'):
|
||||||
try:
|
try:
|
||||||
self.lineno = int(attrs.get('lineno').value)
|
self.lineno = int(attrs.get('lineno').value)
|
||||||
except ValueError, exp:
|
except ValueError as exp:
|
||||||
raise ValueError('Bad integer attribute (lineno): %s' % exp)
|
raise ValueError('Bad integer attribute (lineno): %s' % exp)
|
||||||
if attrs.get('refkind'):
|
if attrs.get('refkind'):
|
||||||
self.refkind = attrs.get('refkind').value
|
self.refkind = attrs.get('refkind').value
|
||||||
@@ -4504,12 +4504,12 @@ class referenceType(GeneratedsSuper):
|
|||||||
if attrs.get('endline'):
|
if attrs.get('endline'):
|
||||||
try:
|
try:
|
||||||
self.endline = int(attrs.get('endline').value)
|
self.endline = int(attrs.get('endline').value)
|
||||||
except ValueError, exp:
|
except ValueError as exp:
|
||||||
raise ValueError('Bad integer attribute (endline): %s' % exp)
|
raise ValueError('Bad integer attribute (endline): %s' % exp)
|
||||||
if attrs.get('startline'):
|
if attrs.get('startline'):
|
||||||
try:
|
try:
|
||||||
self.startline = int(attrs.get('startline').value)
|
self.startline = int(attrs.get('startline').value)
|
||||||
except ValueError, exp:
|
except ValueError as exp:
|
||||||
raise ValueError('Bad integer attribute (startline): %s' % exp)
|
raise ValueError('Bad integer attribute (startline): %s' % exp)
|
||||||
if attrs.get('refid'):
|
if attrs.get('refid'):
|
||||||
self.refid = attrs.get('refid').value
|
self.refid = attrs.get('refid').value
|
||||||
@@ -4627,17 +4627,17 @@ class locationType(GeneratedsSuper):
|
|||||||
if attrs.get('bodystart'):
|
if attrs.get('bodystart'):
|
||||||
try:
|
try:
|
||||||
self.bodystart = int(attrs.get('bodystart').value)
|
self.bodystart = int(attrs.get('bodystart').value)
|
||||||
except ValueError, exp:
|
except ValueError as exp:
|
||||||
raise ValueError('Bad integer attribute (bodystart): %s' % exp)
|
raise ValueError('Bad integer attribute (bodystart): %s' % exp)
|
||||||
if attrs.get('line'):
|
if attrs.get('line'):
|
||||||
try:
|
try:
|
||||||
self.line = int(attrs.get('line').value)
|
self.line = int(attrs.get('line').value)
|
||||||
except ValueError, exp:
|
except ValueError as exp:
|
||||||
raise ValueError('Bad integer attribute (line): %s' % exp)
|
raise ValueError('Bad integer attribute (line): %s' % exp)
|
||||||
if attrs.get('bodyend'):
|
if attrs.get('bodyend'):
|
||||||
try:
|
try:
|
||||||
self.bodyend = int(attrs.get('bodyend').value)
|
self.bodyend = int(attrs.get('bodyend').value)
|
||||||
except ValueError, exp:
|
except ValueError as exp:
|
||||||
raise ValueError('Bad integer attribute (bodyend): %s' % exp)
|
raise ValueError('Bad integer attribute (bodyend): %s' % exp)
|
||||||
if attrs.get('bodyfile'):
|
if attrs.get('bodyfile'):
|
||||||
self.bodyfile = attrs.get('bodyfile').value
|
self.bodyfile = attrs.get('bodyfile').value
|
||||||
@@ -6778,12 +6778,12 @@ class docTableType(GeneratedsSuper):
|
|||||||
if attrs.get('rows'):
|
if attrs.get('rows'):
|
||||||
try:
|
try:
|
||||||
self.rows = int(attrs.get('rows').value)
|
self.rows = int(attrs.get('rows').value)
|
||||||
except ValueError, exp:
|
except ValueError as exp:
|
||||||
raise ValueError('Bad integer attribute (rows): %s' % exp)
|
raise ValueError('Bad integer attribute (rows): %s' % exp)
|
||||||
if attrs.get('cols'):
|
if attrs.get('cols'):
|
||||||
try:
|
try:
|
||||||
self.cols = int(attrs.get('cols').value)
|
self.cols = int(attrs.get('cols').value)
|
||||||
except ValueError, exp:
|
except ValueError as exp:
|
||||||
raise ValueError('Bad integer attribute (cols): %s' % exp)
|
raise ValueError('Bad integer attribute (cols): %s' % exp)
|
||||||
def buildChildren(self, child_, nodeName_):
|
def buildChildren(self, child_, nodeName_):
|
||||||
if child_.nodeType == Node.ELEMENT_NODE and \
|
if child_.nodeType == Node.ELEMENT_NODE and \
|
||||||
@@ -7108,7 +7108,7 @@ class docHeadingType(GeneratedsSuper):
|
|||||||
if attrs.get('level'):
|
if attrs.get('level'):
|
||||||
try:
|
try:
|
||||||
self.level = int(attrs.get('level').value)
|
self.level = int(attrs.get('level').value)
|
||||||
except ValueError, exp:
|
except ValueError as exp:
|
||||||
raise ValueError('Bad integer attribute (level): %s' % exp)
|
raise ValueError('Bad integer attribute (level): %s' % exp)
|
||||||
def buildChildren(self, child_, nodeName_):
|
def buildChildren(self, child_, nodeName_):
|
||||||
if child_.nodeType == Node.TEXT_NODE:
|
if child_.nodeType == Node.TEXT_NODE:
|
||||||
@@ -8283,7 +8283,7 @@ Options:
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
def usage():
|
def usage():
|
||||||
print USAGE_TEXT
|
print(USAGE_TEXT)
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
@@ -8339,4 +8339,3 @@ if __name__ == '__main__':
|
|||||||
main()
|
main()
|
||||||
#import pdb
|
#import pdb
|
||||||
#pdb.run('main()')
|
#pdb.run('main()')
|
||||||
|
|
||||||
|
|||||||
@@ -8,9 +8,9 @@ from xml.dom import minidom
|
|||||||
|
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
import compound
|
from . import compound
|
||||||
|
|
||||||
import indexsuper as supermod
|
from . import indexsuper as supermod
|
||||||
|
|
||||||
class DoxygenTypeSub(supermod.DoxygenType):
|
class DoxygenTypeSub(supermod.DoxygenType):
|
||||||
def __init__(self, version=None, compound=None):
|
def __init__(self, version=None, compound=None):
|
||||||
|
|||||||
@@ -4,9 +4,9 @@
|
|||||||
# Generated Thu Jun 11 18:43:54 2009 by generateDS.py.
|
# Generated Thu Jun 11 18:43:54 2009 by generateDS.py.
|
||||||
#
|
#
|
||||||
|
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
import getopt
|
|
||||||
from string import lower as str_lower
|
|
||||||
from xml.dom import minidom
|
from xml.dom import minidom
|
||||||
from xml.dom import Node
|
from xml.dom import Node
|
||||||
|
|
||||||
@@ -19,9 +19,9 @@ from xml.dom import Node
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
from generatedssuper import GeneratedsSuper
|
from generatedssuper import GeneratedsSuper
|
||||||
except ImportError, exp:
|
except ImportError as exp:
|
||||||
|
|
||||||
class GeneratedsSuper:
|
class GeneratedsSuper(object):
|
||||||
def format_string(self, input_data, input_name=''):
|
def format_string(self, input_data, input_name=''):
|
||||||
return input_data
|
return input_data
|
||||||
def format_integer(self, input_data, input_name=''):
|
def format_integer(self, input_data, input_name=''):
|
||||||
@@ -64,7 +64,7 @@ def showIndent(outfile, level):
|
|||||||
outfile.write(' ')
|
outfile.write(' ')
|
||||||
|
|
||||||
def quote_xml(inStr):
|
def quote_xml(inStr):
|
||||||
s1 = (isinstance(inStr, basestring) and inStr or
|
s1 = (isinstance(inStr, str) and inStr or
|
||||||
'%s' % inStr)
|
'%s' % inStr)
|
||||||
s1 = s1.replace('&', '&')
|
s1 = s1.replace('&', '&')
|
||||||
s1 = s1.replace('<', '<')
|
s1 = s1.replace('<', '<')
|
||||||
@@ -72,7 +72,7 @@ def quote_xml(inStr):
|
|||||||
return s1
|
return s1
|
||||||
|
|
||||||
def quote_attrib(inStr):
|
def quote_attrib(inStr):
|
||||||
s1 = (isinstance(inStr, basestring) and inStr or
|
s1 = (isinstance(inStr, str) and inStr or
|
||||||
'%s' % inStr)
|
'%s' % inStr)
|
||||||
s1 = s1.replace('&', '&')
|
s1 = s1.replace('&', '&')
|
||||||
s1 = s1.replace('<', '<')
|
s1 = s1.replace('<', '<')
|
||||||
@@ -102,7 +102,7 @@ def quote_python(inStr):
|
|||||||
return '"""%s"""' % s1
|
return '"""%s"""' % s1
|
||||||
|
|
||||||
|
|
||||||
class MixedContainer:
|
class MixedContainer(object):
|
||||||
# Constants for category:
|
# Constants for category:
|
||||||
CategoryNone = 0
|
CategoryNone = 0
|
||||||
CategoryText = 1
|
CategoryText = 1
|
||||||
@@ -462,7 +462,7 @@ Options:
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
def usage():
|
def usage():
|
||||||
print USAGE_TEXT
|
print(USAGE_TEXT)
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
@@ -520,4 +520,3 @@ if __name__ == '__main__':
|
|||||||
main()
|
main()
|
||||||
#import pdb
|
#import pdb
|
||||||
#pdb.run('main()')
|
#pdb.run('main()')
|
||||||
|
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
|
|
||||||
# 1st parameter is absolute path to component source directory
|
|
||||||
# 2nd parameter is absolute path to component build directory
|
|
||||||
# 3rd parameter is path to Python QA directory
|
|
||||||
|
|
||||||
# Note: calling master run_tests.sh in gnuradio core is not strictly
|
|
||||||
# correct, as it will result in a partially bogus PYTHONPATH, but it
|
|
||||||
# does make the correct paths in the second half so all is well.
|
|
||||||
|
|
||||||
@PYTHON@ @srcdir@/__init__.py
|
|
||||||
|
|
||||||
# @top_builddir@/run_tests.sh \
|
|
||||||
# @abs_top_srcdir@/gnuradio-core \
|
|
||||||
# @abs_top_builddir@/gnuradio-core \
|
|
||||||
# @srcdir@
|
|
||||||
@@ -1,22 +1,11 @@
|
|||||||
#
|
#
|
||||||
# Copyright 2010 Free Software Foundation, Inc.
|
# Copyright 2010 Free Software Foundation, Inc.
|
||||||
#
|
#
|
||||||
# This file is part of GNU Radio
|
# This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
# This file is a part of gr-ieee802_11
|
||||||
#
|
#
|
||||||
# GNU Radio is free software; you can redistribute it and/or modify
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
# 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.
|
Utilities for extracting text from generated classes.
|
||||||
@@ -26,7 +15,7 @@ def is_string(txt):
|
|||||||
if isinstance(txt, str):
|
if isinstance(txt, str):
|
||||||
return True
|
return True
|
||||||
try:
|
try:
|
||||||
if isinstance(txt, unicode):
|
if isinstance(txt, str):
|
||||||
return True
|
return True
|
||||||
except NameError:
|
except NameError:
|
||||||
pass
|
pass
|
||||||
@@ -49,7 +38,7 @@ def description_bit(obj):
|
|||||||
elif is_string(obj):
|
elif is_string(obj):
|
||||||
return obj
|
return obj
|
||||||
else:
|
else:
|
||||||
raise StandardError('Expecting a string or something with content, content_ or value attribute')
|
raise Exception('Expecting a string or something with content, content_ or value attribute')
|
||||||
# If this bit is a paragraph then add one some line breaks.
|
# If this bit is a paragraph then add one some line breaks.
|
||||||
if hasattr(obj, 'name') and obj.name == 'para':
|
if hasattr(obj, 'name') and obj.name == 'para':
|
||||||
result += "\n\n"
|
result += "\n\n"
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
/*!
|
/*!
|
||||||
* \defgroup block GNU Radio HOWTO C++ Signal Processing Blocks
|
* \defgroup block GNU Radio IEEE802_11 C++ Signal Processing Blocks
|
||||||
* \brief All C++ blocks that can be used from the HOWTO GNU Radio
|
* \brief All C++ blocks that can be used from the IEEE802_11 GNU Radio
|
||||||
* module are listed here or in the subcategories below.
|
* module are listed here or in the subcategories below.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
/*! \mainpage
|
/*! \mainpage
|
||||||
|
|
||||||
Welcome to the GNU Radio HOWTO Block
|
Welcome to the GNU Radio IEEE802_11 Block
|
||||||
|
|
||||||
This is the intro page for the Doxygen manual generated for the HOWTO
|
This is the intro page for the Doxygen manual generated for the IEEE802_11
|
||||||
block (docs/doxygen/other/main_page.dox). Edit it to add more detailed
|
block (docs/doxygen/other/main_page.dox). Edit it to add more detailed
|
||||||
documentation about the new GNU Radio modules contained in this
|
documentation about the new GNU Radio modules contained in this
|
||||||
project.
|
project.
|
||||||
|
|||||||
@@ -0,0 +1,19 @@
|
|||||||
|
#ifndef PYDOC_MACROS_H
|
||||||
|
#define PYDOC_MACROS_H
|
||||||
|
|
||||||
|
#define __EXPAND(x) x
|
||||||
|
#define __COUNT(_1, _2, _3, _4, _5, _6, _7, COUNT, ...) COUNT
|
||||||
|
#define __VA_SIZE(...) __EXPAND(__COUNT(__VA_ARGS__, 7, 6, 5, 4, 3, 2, 1))
|
||||||
|
#define __CAT1(a, b) a##b
|
||||||
|
#define __CAT2(a, b) __CAT1(a, b)
|
||||||
|
#define __DOC1(n1) __doc_##n1
|
||||||
|
#define __DOC2(n1, n2) __doc_##n1##_##n2
|
||||||
|
#define __DOC3(n1, n2, n3) __doc_##n1##_##n2##_##n3
|
||||||
|
#define __DOC4(n1, n2, n3, n4) __doc_##n1##_##n2##_##n3##_##n4
|
||||||
|
#define __DOC5(n1, n2, n3, n4, n5) __doc_##n1##_##n2##_##n3##_##n4##_##n5
|
||||||
|
#define __DOC6(n1, n2, n3, n4, n5, n6) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6
|
||||||
|
#define __DOC7(n1, n2, n3, n4, n5, n6, n7) \
|
||||||
|
__doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7
|
||||||
|
#define DOC(...) __EXPAND(__EXPAND(__CAT2(__DOC, __VA_SIZE(__VA_ARGS__)))(__VA_ARGS__))
|
||||||
|
|
||||||
|
#endif // PYDOC_MACROS_H
|
||||||
@@ -1,255 +0,0 @@
|
|||||||
#
|
|
||||||
# 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)
|
|
||||||
@@ -0,0 +1,346 @@
|
|||||||
|
#
|
||||||
|
# Copyright 2010-2012 Free Software Foundation, Inc.
|
||||||
|
#
|
||||||
|
# This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
# This file is a part of gnuradio
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
#
|
||||||
|
#
|
||||||
|
"""
|
||||||
|
Updates the *pydoc_h files for a module
|
||||||
|
Execute using: python update_pydoc.py xml_path outputfilename
|
||||||
|
|
||||||
|
The file instructs Pybind11 to transfer the doxygen comments into the
|
||||||
|
python docstrings.
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
import os, sys, time, glob, re, json
|
||||||
|
from argparse import ArgumentParser
|
||||||
|
|
||||||
|
from doxyxml import DoxyIndex, DoxyClass, DoxyFriend, DoxyFunction, DoxyFile
|
||||||
|
from doxyxml import DoxyOther, 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
|
||||||
|
friendname = make_name(item.name())
|
||||||
|
is_a_block = item.has_member(friendname, DoxyFriend)
|
||||||
|
# But now sometimes the make function isn't a friend so check again.
|
||||||
|
if not is_a_block:
|
||||||
|
is_a_block = di.has_member(friendname, DoxyFunction)
|
||||||
|
return is_a_block
|
||||||
|
|
||||||
|
class Block2(object):
|
||||||
|
"""
|
||||||
|
Checks if doxyxml produced objects correspond to a new style
|
||||||
|
gnuradio block.
|
||||||
|
"""
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def includes(cls, item):
|
||||||
|
if not isinstance(item, DoxyClass):
|
||||||
|
return False
|
||||||
|
# Check for a parsing error.
|
||||||
|
if item.error():
|
||||||
|
return False
|
||||||
|
is_a_block2 = item.has_member('make', DoxyFunction) and item.has_member('sptr', DoxyOther)
|
||||||
|
return is_a_block2
|
||||||
|
|
||||||
|
|
||||||
|
def utoascii(text):
|
||||||
|
"""
|
||||||
|
Convert unicode text into ascii and escape quotes and backslashes.
|
||||||
|
"""
|
||||||
|
if text is None:
|
||||||
|
return ''
|
||||||
|
out = text.encode('ascii', 'replace')
|
||||||
|
# swig will require us to replace blackslash with 4 backslashes
|
||||||
|
# TODO: evaluate what this should be for pybind11
|
||||||
|
out = out.replace(b'\\', b'\\\\\\\\')
|
||||||
|
out = out.replace(b'"', b'\\"').decode('ascii')
|
||||||
|
return str(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()
|
||||||
|
|
||||||
|
def format_params(parameteritems):
|
||||||
|
output = ['Args:']
|
||||||
|
template = ' {0} : {1}'
|
||||||
|
for pi in parameteritems:
|
||||||
|
output.append(template.format(pi.name, pi.description))
|
||||||
|
return '\n'.join(output)
|
||||||
|
|
||||||
|
entry_templ = '%feature("docstring") {name} "{docstring}"'
|
||||||
|
def make_entry(obj, name=None, templ="{description}", description=None, params=[]):
|
||||||
|
"""
|
||||||
|
Create a docstring key/value pair, where the key is the object name.
|
||||||
|
|
||||||
|
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 hasattr(obj,'_parse_data') and hasattr(obj._parse_data,'definition'):
|
||||||
|
name=obj._parse_data.definition.split(' ')[-1]
|
||||||
|
if "operator " in name:
|
||||||
|
return ''
|
||||||
|
if description is None:
|
||||||
|
description = combine_descriptions(obj)
|
||||||
|
if params:
|
||||||
|
description += '\n\n'
|
||||||
|
description += utoascii(format_params(params))
|
||||||
|
docstring = templ.format(description=description)
|
||||||
|
|
||||||
|
return {name: docstring}
|
||||||
|
|
||||||
|
|
||||||
|
def make_class_entry(klass, description=None, ignored_methods=[], params=None):
|
||||||
|
"""
|
||||||
|
Create a class docstring key/value pair.
|
||||||
|
"""
|
||||||
|
if params is None:
|
||||||
|
params = klass.params
|
||||||
|
output = {}
|
||||||
|
output.update(make_entry(klass, description=description, params=params))
|
||||||
|
for func in klass.in_category(DoxyFunction):
|
||||||
|
if func.name() not in ignored_methods:
|
||||||
|
name = klass.name() + '::' + func.name()
|
||||||
|
output.update(make_entry(func, name=name))
|
||||||
|
return output
|
||||||
|
|
||||||
|
|
||||||
|
def make_block_entry(di, block):
|
||||||
|
"""
|
||||||
|
Create class and function docstrings of a gnuradio block
|
||||||
|
"""
|
||||||
|
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.update(make_class_entry(block, description=super_description))
|
||||||
|
output.update(make_entry(make_func, description=super_description,
|
||||||
|
params=block.params))
|
||||||
|
return output
|
||||||
|
|
||||||
|
def make_block2_entry(di, block):
|
||||||
|
"""
|
||||||
|
Create class and function docstrings of a new style gnuradio block
|
||||||
|
"""
|
||||||
|
# For new style blocks all the relevant documentation should be
|
||||||
|
# associated with the 'make' method.
|
||||||
|
class_description = combine_descriptions(block)
|
||||||
|
make_func = block.get_member('make', DoxyFunction)
|
||||||
|
make_description = combine_descriptions(make_func)
|
||||||
|
description = class_description + "\n\nConstructor Specific Documentation:\n\n" + make_description
|
||||||
|
# Associate the combined description with the class and
|
||||||
|
# the make function.
|
||||||
|
output = {}
|
||||||
|
output.update(make_class_entry(
|
||||||
|
block, description=description,
|
||||||
|
ignored_methods=['make'], params=make_func.params))
|
||||||
|
makename = block.name() + '::make'
|
||||||
|
output.update(make_entry(
|
||||||
|
make_func, name=makename, description=description,
|
||||||
|
params=make_func.params))
|
||||||
|
return output
|
||||||
|
|
||||||
|
def get_docstrings_dict(di, custom_output=None):
|
||||||
|
|
||||||
|
output = {}
|
||||||
|
if custom_output:
|
||||||
|
output.update(custom_output)
|
||||||
|
|
||||||
|
# Create docstrings for the blocks.
|
||||||
|
blocks = di.in_category(Block)
|
||||||
|
blocks2 = di.in_category(Block2)
|
||||||
|
|
||||||
|
make_funcs = set([])
|
||||||
|
for block in blocks:
|
||||||
|
try:
|
||||||
|
make_func = di.get_member(make_name(block.name()), DoxyFunction)
|
||||||
|
# Don't want to risk writing to output twice.
|
||||||
|
if make_func.name() not in make_funcs:
|
||||||
|
make_funcs.add(make_func.name())
|
||||||
|
output.update(make_block_entry(di, block))
|
||||||
|
except block.ParsingError:
|
||||||
|
sys.stderr.write('Parsing error for block {0}\n'.format(block.name()))
|
||||||
|
raise
|
||||||
|
|
||||||
|
for block in blocks2:
|
||||||
|
try:
|
||||||
|
make_func = block.get_member('make', DoxyFunction)
|
||||||
|
make_func_name = block.name() +'::make'
|
||||||
|
# Don't want to risk writing to output twice.
|
||||||
|
if make_func_name not in make_funcs:
|
||||||
|
make_funcs.add(make_func_name)
|
||||||
|
output.update(make_block2_entry(di, block))
|
||||||
|
except block.ParsingError:
|
||||||
|
sys.stderr.write('Parsing error for block {0}\n'.format(block.name()))
|
||||||
|
raise
|
||||||
|
|
||||||
|
# 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 and not f.name().startswith('std::')]
|
||||||
|
for f in funcs:
|
||||||
|
try:
|
||||||
|
output.update(make_entry(f))
|
||||||
|
except f.ParsingError:
|
||||||
|
sys.stderr.write('Parsing error for function {0}\n'.format(f.name()))
|
||||||
|
|
||||||
|
# Create docstrings for classes
|
||||||
|
block_names = [block.name() for block in blocks]
|
||||||
|
block_names += [block.name() for block in blocks2]
|
||||||
|
klasses = [k for k in di.in_category(DoxyClass)
|
||||||
|
if k.name() not in block_names and not k.name().startswith('std::')]
|
||||||
|
for k in klasses:
|
||||||
|
try:
|
||||||
|
output.update(make_class_entry(k))
|
||||||
|
except k.ParsingError:
|
||||||
|
sys.stderr.write('Parsing error for class {0}\n'.format(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.
|
||||||
|
|
||||||
|
return output
|
||||||
|
|
||||||
|
def sub_docstring_in_pydoc_h(pydoc_files, docstrings_dict, output_dir, filter_str=None):
|
||||||
|
if filter_str:
|
||||||
|
docstrings_dict = {k: v for k, v in docstrings_dict.items() if k.startswith(filter_str)}
|
||||||
|
|
||||||
|
with open(os.path.join(output_dir,'docstring_status'),'w') as status_file:
|
||||||
|
|
||||||
|
for pydoc_file in pydoc_files:
|
||||||
|
if filter_str:
|
||||||
|
filter_str2 = "::".join((filter_str,os.path.split(pydoc_file)[-1].split('_pydoc_template.h')[0]))
|
||||||
|
docstrings_dict2 = {k: v for k, v in docstrings_dict.items() if k.startswith(filter_str2)}
|
||||||
|
else:
|
||||||
|
docstrings_dict2 = docstrings_dict
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
file_in = open(pydoc_file,'r').read()
|
||||||
|
for key, value in docstrings_dict2.items():
|
||||||
|
file_in_tmp = file_in
|
||||||
|
try:
|
||||||
|
doc_key = key.split("::")
|
||||||
|
# if 'gr' in doc_key:
|
||||||
|
# doc_key.remove('gr')
|
||||||
|
doc_key = '_'.join(doc_key)
|
||||||
|
regexp = r'(__doc_{} =\sR\"doc\()[^)]*(\)doc\")'.format(doc_key)
|
||||||
|
regexp = re.compile(regexp, re.MULTILINE)
|
||||||
|
|
||||||
|
(file_in, nsubs) = regexp.subn(r'\1'+value+r'\2', file_in, count=1)
|
||||||
|
if nsubs == 1:
|
||||||
|
status_file.write("PASS: " + pydoc_file + "\n")
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
raise KeyboardInterrupt
|
||||||
|
except: # be permissive, TODO log, but just leave the docstring blank
|
||||||
|
status_file.write("FAIL: " + pydoc_file + "\n")
|
||||||
|
file_in = file_in_tmp
|
||||||
|
|
||||||
|
output_pathname = os.path.join(output_dir, os.path.basename(pydoc_file).replace('_template.h','.h'))
|
||||||
|
# FIXME: Remove this debug print
|
||||||
|
print('output docstrings to {}'.format(output_pathname))
|
||||||
|
with open(output_pathname,'w') as file_out:
|
||||||
|
file_out.write(file_in)
|
||||||
|
|
||||||
|
def copy_docstring_templates(pydoc_files, output_dir):
|
||||||
|
with open(os.path.join(output_dir,'docstring_status'),'w') as status_file:
|
||||||
|
for pydoc_file in pydoc_files:
|
||||||
|
file_in = open(pydoc_file,'r').read()
|
||||||
|
output_pathname = os.path.join(output_dir, os.path.basename(pydoc_file).replace('_template.h','.h'))
|
||||||
|
# FIXME: Remove this debug print
|
||||||
|
print('copy docstrings to {}'.format(output_pathname))
|
||||||
|
with open(output_pathname,'w') as file_out:
|
||||||
|
file_out.write(file_in)
|
||||||
|
status_file.write("DONE")
|
||||||
|
|
||||||
|
def argParse():
|
||||||
|
"""Parses commandline args."""
|
||||||
|
desc='Scrape the doxygen generated xml for docstrings to insert into python bindings'
|
||||||
|
parser = ArgumentParser(description=desc)
|
||||||
|
|
||||||
|
parser.add_argument("function", help="Operation to perform on docstrings", choices=["scrape","sub","copy"])
|
||||||
|
|
||||||
|
parser.add_argument("--xml_path")
|
||||||
|
parser.add_argument("--bindings_dir")
|
||||||
|
parser.add_argument("--output_dir")
|
||||||
|
parser.add_argument("--json_path")
|
||||||
|
parser.add_argument("--filter", default=None)
|
||||||
|
|
||||||
|
return parser.parse_args()
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
# Parse command line options and set up doxyxml.
|
||||||
|
args = argParse()
|
||||||
|
if args.function.lower() == 'scrape':
|
||||||
|
di = DoxyIndex(args.xml_path)
|
||||||
|
docstrings_dict = get_docstrings_dict(di)
|
||||||
|
with open(args.json_path, 'w') as fp:
|
||||||
|
json.dump(docstrings_dict, fp)
|
||||||
|
elif args.function.lower() == 'sub':
|
||||||
|
with open(args.json_path, 'r') as fp:
|
||||||
|
docstrings_dict = json.load(fp)
|
||||||
|
pydoc_files = glob.glob(os.path.join(args.bindings_dir,'*_pydoc_template.h'))
|
||||||
|
sub_docstring_in_pydoc_h(pydoc_files, docstrings_dict, args.output_dir, args.filter)
|
||||||
|
elif args.function.lower() == 'copy':
|
||||||
|
pydoc_files = glob.glob(os.path.join(args.bindings_dir,'*_pydoc_template.h'))
|
||||||
|
copy_docstring_templates(pydoc_files, args.output_dir)
|
||||||
|
|
||||||
|
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
# Copyright 2023 Ryan Volz
|
||||||
|
#
|
||||||
|
# This file is part of gr-ieee802_11
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
#
|
||||||
|
|
||||||
|
install(
|
||||||
|
FILES wifi_loopback.grc
|
||||||
|
wifi_phy_hier.grc
|
||||||
|
wifi_rx.grc
|
||||||
|
wifi_transceiver.grc
|
||||||
|
wifi_tx.grc
|
||||||
|
DESTINATION share/gnuradio/examples/ieee802_11)
|
||||||
+689
-1270
File diff suppressed because it is too large
Load Diff
+771
-1980
File diff suppressed because it is too large
Load Diff
+1233
-2781
File diff suppressed because it is too large
Load Diff
+1264
-2675
File diff suppressed because it is too large
Load Diff
+947
-1911
File diff suppressed because it is too large
Load Diff
+20
-2
@@ -1,3 +1,21 @@
|
|||||||
file(GLOB xml_files "*.xml")
|
# Copyright 2011 Free Software Foundation, Inc.
|
||||||
|
#
|
||||||
|
# This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
# This file is a part of gr-ieee802_11
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
#
|
||||||
|
|
||||||
install(FILES ${xml_files} DESTINATION share/gnuradio/grc/blocks )
|
install(FILES
|
||||||
|
ieee802_11_chunks_to_symbols.block.yml
|
||||||
|
ieee802_11_decode_mac.block.yml
|
||||||
|
ieee802_11_ether_encap.block.yml
|
||||||
|
ieee802_11_extract_csi.block.yml
|
||||||
|
ieee802_11_frame_equalizer.block.yml
|
||||||
|
ieee802_11_mac.block.yml
|
||||||
|
ieee802_11_mapper.block.yml
|
||||||
|
ieee802_11_parse_mac.block.yml
|
||||||
|
ieee802_11_sync_long.block.yml
|
||||||
|
ieee802_11_sync_short.block.yml
|
||||||
|
ieee802_11_append_crc32.block.yml DESTINATION share/gnuradio/grc/blocks
|
||||||
|
)
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
id: ieee802_11_append_crc32
|
||||||
|
label: Append CRC32
|
||||||
|
category: '[IEEE802.11]'
|
||||||
|
|
||||||
|
parameters:
|
||||||
|
- id: append
|
||||||
|
label: Append
|
||||||
|
dtype: bool
|
||||||
|
default: 'True'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
- domain: message
|
||||||
|
id: in
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
- domain: message
|
||||||
|
id: out
|
||||||
|
optional: true
|
||||||
|
|
||||||
|
templates:
|
||||||
|
imports: import ieee802_11
|
||||||
|
make: ieee802_11.append_crc32(${append})
|
||||||
|
|
||||||
|
file_format: 1
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# auto-generated by grc.converter
|
||||||
|
|
||||||
|
id: ieee802_11_chunks_to_symbols_xx
|
||||||
|
label: Chunks to Symbols
|
||||||
|
category: '[IEEE802.11]'
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
- domain: stream
|
||||||
|
dtype: byte
|
||||||
|
multiplicity: '1'
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
- domain: stream
|
||||||
|
dtype: complex
|
||||||
|
multiplicity: '1'
|
||||||
|
|
||||||
|
templates:
|
||||||
|
imports: import ieee802_11
|
||||||
|
make: ieee802_11.chunks_to_symbols()
|
||||||
|
|
||||||
|
file_format: 1
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
<block>
|
|
||||||
<name>Chunks to Symbols</name>
|
|
||||||
<key>ieee802_11_chunks_to_symbols_xx</key>
|
|
||||||
<category>IEEE802.11</category>
|
|
||||||
<import>import ieee802_11</import>
|
|
||||||
<make>ieee802_11.chunks_to_symbols()</make>
|
|
||||||
<sink>
|
|
||||||
<name>in</name>
|
|
||||||
<type>byte</type>
|
|
||||||
<nports>1</nports>
|
|
||||||
</sink>
|
|
||||||
<source>
|
|
||||||
<name>out</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<nports>1</nports>
|
|
||||||
</source>
|
|
||||||
</block>
|
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
# auto-generated by grc.converter
|
||||||
|
|
||||||
|
id: ieee802_11_decode_mac
|
||||||
|
label: WiFi Decode MAC
|
||||||
|
category: '[IEEE802.11]'
|
||||||
|
|
||||||
|
parameters:
|
||||||
|
- id: log
|
||||||
|
label: Log
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
- id: debug
|
||||||
|
label: Debug
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
- domain: stream
|
||||||
|
dtype: byte
|
||||||
|
vlen: 48
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
- domain: message
|
||||||
|
id: out
|
||||||
|
optional: true
|
||||||
|
|
||||||
|
templates:
|
||||||
|
imports: import ieee802_11
|
||||||
|
make: ieee802_11.decode_mac(${log}, ${debug})
|
||||||
|
|
||||||
|
file_format: 1
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
# auto-generated by grc.converter
|
||||||
|
|
||||||
|
id: ieee802_11_ether_encap
|
||||||
|
label: Ethernet Encapsulation
|
||||||
|
category: '[IEEE802.11]'
|
||||||
|
|
||||||
|
parameters:
|
||||||
|
- id: debug
|
||||||
|
label: Debug
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
- domain: message
|
||||||
|
id: from tap
|
||||||
|
optional: true
|
||||||
|
- domain: message
|
||||||
|
id: from wifi
|
||||||
|
optional: true
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
- domain: message
|
||||||
|
id: to tap
|
||||||
|
optional: true
|
||||||
|
- domain: message
|
||||||
|
id: to wifi
|
||||||
|
optional: true
|
||||||
|
|
||||||
|
templates:
|
||||||
|
imports: import ieee802_11
|
||||||
|
make: ieee802_11.ether_encap(${debug})
|
||||||
|
|
||||||
|
file_format: 1
|
||||||
@@ -1,50 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<block>
|
|
||||||
<name>Ethernet Encapsulation</name>
|
|
||||||
<key>ieee802_11_ether_encap</key>
|
|
||||||
<category>IEEE802.11</category>
|
|
||||||
<import>import ieee802_11</import>
|
|
||||||
<make>ieee802_11.ether_encap($debug)</make>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Debug</name>
|
|
||||||
<key>debug</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>from tap</name>
|
|
||||||
<type>message</type>
|
|
||||||
<optional>1</optional>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>from wifi</name>
|
|
||||||
<type>message</type>
|
|
||||||
<optional>1</optional>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>to tap</name>
|
|
||||||
<type>message</type>
|
|
||||||
<optional>1</optional>
|
|
||||||
</source>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>to wifi</name>
|
|
||||||
<type>message</type>
|
|
||||||
<optional>1</optional>
|
|
||||||
</source>
|
|
||||||
</block>
|
|
||||||
|
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
id: ieee802_11_extract_csi
|
||||||
|
label: WiFi Extract CSI
|
||||||
|
category: '[IEEE802.11]'
|
||||||
|
|
||||||
|
templates:
|
||||||
|
imports: import ieee802_11
|
||||||
|
make: ieee802_11.extract_csi()
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
- label: pdu in
|
||||||
|
domain: message
|
||||||
|
optional: false
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
- label: csi out
|
||||||
|
domain: stream
|
||||||
|
dtype: complex
|
||||||
|
vlen: 52
|
||||||
|
optional: false
|
||||||
|
|
||||||
|
file_format: 1
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
# auto-generated by grc.converter
|
||||||
|
|
||||||
|
id: ieee802_11_frame_equalizer
|
||||||
|
label: WiFi Frame Equalizer
|
||||||
|
category: '[IEEE802.11]'
|
||||||
|
|
||||||
|
parameters:
|
||||||
|
- id: algo
|
||||||
|
label: Algorithm
|
||||||
|
dtype: raw
|
||||||
|
default: ieee802_11.LS
|
||||||
|
- id: freq
|
||||||
|
label: Frequency
|
||||||
|
dtype: real
|
||||||
|
default: 5.89e9
|
||||||
|
- id: bw
|
||||||
|
label: Bandwidth
|
||||||
|
dtype: real
|
||||||
|
default: 10e6
|
||||||
|
- id: log
|
||||||
|
label: Log
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
- id: debug
|
||||||
|
label: Debug
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
- domain: stream
|
||||||
|
dtype: complex
|
||||||
|
vlen: 64
|
||||||
|
multiplicity: '1'
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
- domain: stream
|
||||||
|
dtype: byte
|
||||||
|
vlen: 48
|
||||||
|
multiplicity: '1'
|
||||||
|
- domain: message
|
||||||
|
id: symbols
|
||||||
|
optional: true
|
||||||
|
|
||||||
|
templates:
|
||||||
|
imports: import ieee802_11
|
||||||
|
make: ieee802_11.frame_equalizer(${algo}, ${freq}, ${bw}, ${log}, ${debug})
|
||||||
|
callbacks:
|
||||||
|
- set_algorithm(${algo})
|
||||||
|
- set_frequency(${freq})
|
||||||
|
- set_bandwidth(${bw})
|
||||||
|
|
||||||
|
file_format: 1
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
# auto-generated by grc.converter
|
||||||
|
|
||||||
|
id: ieee802_11_mac
|
||||||
|
label: WiFi MAC
|
||||||
|
category: '[IEEE802.11]'
|
||||||
|
|
||||||
|
parameters:
|
||||||
|
- id: src_mac
|
||||||
|
label: SRC MAC
|
||||||
|
dtype: int_vector
|
||||||
|
default: '[0x23, 0x23, 0x23, 0x23, 0x23, 0x23]'
|
||||||
|
- id: dst_mac
|
||||||
|
label: DST MAC
|
||||||
|
dtype: int_vector
|
||||||
|
default: '[0x42, 0x42, 0x42, 0x42, 0x42, 0x42]'
|
||||||
|
- id: bss_mac
|
||||||
|
label: BSS MAC
|
||||||
|
dtype: int_vector
|
||||||
|
default: '[0xff, 0xff, 0xff, 0xff, 0xff, 0xff]'
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
- domain: message
|
||||||
|
id: app in
|
||||||
|
optional: true
|
||||||
|
- domain: message
|
||||||
|
id: phy in
|
||||||
|
optional: true
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
- domain: message
|
||||||
|
id: app out
|
||||||
|
optional: true
|
||||||
|
- domain: message
|
||||||
|
id: phy out
|
||||||
|
optional: true
|
||||||
|
asserts:
|
||||||
|
- ${ len(src_mac) == 6 }
|
||||||
|
- ${ len(dst_mac) == 6 }
|
||||||
|
- ${ len(bss_mac) == 6 }
|
||||||
|
- ${ all([x >= 0 and 255 >= x for x in src_mac]) }
|
||||||
|
- ${ all([x >= 0 and 255 >= x for x in dst_mac]) }
|
||||||
|
- ${ all([x >= 0 and 255 >= x for x in bss_mac]) }
|
||||||
|
|
||||||
|
templates:
|
||||||
|
imports: import ieee802_11
|
||||||
|
make: ieee802_11.mac(${src_mac}, ${dst_mac}, ${bss_mac})
|
||||||
|
|
||||||
|
file_format: 1
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
# auto-generated by grc.converter
|
||||||
|
|
||||||
|
id: ieee802_11_mapper
|
||||||
|
label: WiFi Mapper
|
||||||
|
category: '[IEEE802.11]'
|
||||||
|
|
||||||
|
parameters:
|
||||||
|
- id: encoding
|
||||||
|
label: Encoding
|
||||||
|
dtype: raw
|
||||||
|
default: ieee802_11.BPSK_1_2
|
||||||
|
- id: debug
|
||||||
|
label: Debug
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
- domain: message
|
||||||
|
id: in
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
- domain: stream
|
||||||
|
dtype: byte
|
||||||
|
multiplicity: '1'
|
||||||
|
|
||||||
|
templates:
|
||||||
|
imports: import ieee802_11
|
||||||
|
make: ieee802_11.mapper(${encoding}, ${debug})
|
||||||
|
callbacks:
|
||||||
|
- set_encoding(${encoding})
|
||||||
|
|
||||||
|
file_format: 1
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
<block>
|
|
||||||
<name>Moving Average</name>
|
|
||||||
<key>ieee802_11_moving_average_xx</key>
|
|
||||||
<category>IEEE802.11</category>
|
|
||||||
<import>import ieee802_11</import>
|
|
||||||
<make>ieee802_11.moving_average_$(type.fcn)($length)</make>
|
|
||||||
<callback>set_length($length)</callback>
|
|
||||||
<param>
|
|
||||||
<name>Type</name>
|
|
||||||
<key>type</key>
|
|
||||||
<type>enum</type>
|
|
||||||
<option>
|
|
||||||
<name>Complex</name>
|
|
||||||
<key>complex</key>
|
|
||||||
<opt>fcn:cc</opt>
|
|
||||||
<opt>scale:complex</opt>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Float</name>
|
|
||||||
<key>float</key>
|
|
||||||
<opt>fcn:ff</opt>
|
|
||||||
<opt>scale:real</opt>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Length</name>
|
|
||||||
<key>length</key>
|
|
||||||
<value>48</value>
|
|
||||||
<type>int</type>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>in</name>
|
|
||||||
<type>$type</type>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>out</name>
|
|
||||||
<type>$type</type>
|
|
||||||
</source>
|
|
||||||
</block>
|
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<block>
|
|
||||||
<name>OFDM Decode MAC</name>
|
|
||||||
<key>ieee802_11_ofdm_decode_mac</key>
|
|
||||||
<category>IEEE802.11</category>
|
|
||||||
<import>import ieee802_11</import>
|
|
||||||
<make>ieee802_11.ofdm_decode_mac($log, $debug)</make>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Log</name>
|
|
||||||
<key>log</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Debug</name>
|
|
||||||
<key>debug</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>in</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<vlen>48</vlen>
|
|
||||||
<nports>1</nports>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>out</name>
|
|
||||||
<type>message</type>
|
|
||||||
</source>
|
|
||||||
|
|
||||||
</block>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<block>
|
|
||||||
<name>OFDM Decode Signal</name>
|
|
||||||
<key>ieee802_11_ofdm_decode_signal</key>
|
|
||||||
<category>IEEE802.11</category>
|
|
||||||
<import>import ieee802_11</import>
|
|
||||||
<make>ieee802_11.ofdm_decode_signal($log, $debug)</make>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Log</name>
|
|
||||||
<key>log</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Debug</name>
|
|
||||||
<key>debug</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>in</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<vlen>48</vlen>
|
|
||||||
<nports>1</nports>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>out</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<vlen>48</vlen>
|
|
||||||
<nports>1</nports>
|
|
||||||
</source>
|
|
||||||
|
|
||||||
</block>
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<block>
|
|
||||||
<name>OFDM Equalize Symbols</name>
|
|
||||||
<key>ieee802_11_ofdm_equalize_symbols</key>
|
|
||||||
<category>IEEE802.11</category>
|
|
||||||
<import>import ieee802_11</import>
|
|
||||||
<make>ieee802_11.ofdm_equalize_symbols($algo, $debug)</make>
|
|
||||||
<callback>set_algorithm($algo)</callback>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Algorithm</name>
|
|
||||||
<key>algo</key>
|
|
||||||
<value>ieee802_11.LINEAR_COMB</value>
|
|
||||||
<type>int</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>LMS</name>
|
|
||||||
<key>ieee802_11.LMS</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>linear comb</name>
|
|
||||||
<key>ieee802_11.LINEAR_COMB</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Debug</name>
|
|
||||||
<key>debug</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>in</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<vlen>64</vlen>
|
|
||||||
<nports>1</nports>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>out</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<vlen>48</vlen>
|
|
||||||
<nports>1</nports>
|
|
||||||
</source>
|
|
||||||
|
|
||||||
</block>
|
|
||||||
|
|
||||||
@@ -1,61 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<block>
|
|
||||||
<name>OFDM MAC</name>
|
|
||||||
<key>ieee802_11_ofdm_mac</key>
|
|
||||||
<category>IEEE802.11</category>
|
|
||||||
<import>import ieee802_11</import>
|
|
||||||
<make>ieee802_11.ofdm_mac($src_mac, $dst_mac, $bss_mac)</make>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>SRC MAC</name>
|
|
||||||
<key>src_mac</key>
|
|
||||||
<value>[0x23, 0x23, 0x23, 0x23, 0x23, 0x23]</value>
|
|
||||||
<type>int_vector</type>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>DST MAC</name>
|
|
||||||
<key>dst_mac</key>
|
|
||||||
<value>[0x42, 0x42, 0x42, 0x42, 0x42, 0x42]</value>
|
|
||||||
<type>int_vector</type>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>BSS MAC</name>
|
|
||||||
<key>bss_mac</key>
|
|
||||||
<value>[0xff, 0xff, 0xff, 0xff, 0xff, 0xff]</value>
|
|
||||||
<type>int_vector</type>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<check>len($src_mac) == 6</check>
|
|
||||||
<check>len($dst_mac) == 6</check>
|
|
||||||
<check>len($bss_mac) == 6</check>
|
|
||||||
<check>all([x >= 0 and 255 >= x for x in $src_mac])</check>
|
|
||||||
<check>all([x >= 0 and 255 >= x for x in $dst_mac])</check>
|
|
||||||
<check>all([x >= 0 and 255 >= x for x in $bss_mac])</check>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>app in</name>
|
|
||||||
<type>message</type>
|
|
||||||
<optional>1</optional>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>phy in</name>
|
|
||||||
<type>message</type>
|
|
||||||
<optional>1</optional>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>app out</name>
|
|
||||||
<type>message</type>
|
|
||||||
<optional>1</optional>
|
|
||||||
</source>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>phy out</name>
|
|
||||||
<type>message</type>
|
|
||||||
<optional>1</optional>
|
|
||||||
</source>
|
|
||||||
</block>
|
|
||||||
@@ -1,80 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<block>
|
|
||||||
<name>OFDM Mapper</name>
|
|
||||||
<key>ieee802_11_ofdm_mapper</key>
|
|
||||||
<category>IEEE802.11</category>
|
|
||||||
<import>import ieee802_11</import>
|
|
||||||
<make>ieee802_11.ofdm_mapper($encoding, $debug)</make>
|
|
||||||
<callback>set_encoding($encoding)</callback>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Encoding</name>
|
|
||||||
<key>encoding</key>
|
|
||||||
<value>ieee802_11.BPSK_1_2</value>
|
|
||||||
<type>int</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>BPSK 1/2</name>
|
|
||||||
<key>ieee802_11.BPSK_1_2</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>BPSK 3/4</name>
|
|
||||||
<key>ieee802_11.BPSK_3_4</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>QPSK 1/2</name>
|
|
||||||
<key>ieee802_11.QPSK_1_2</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>QPSK 3/4</name>
|
|
||||||
<key>ieee802_11.QPSK_3_4</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>16QAM 1/2</name>
|
|
||||||
<key>ieee802_11.16QAM_1_2</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>16QAM 3/4</name>
|
|
||||||
<key>ieee802_11.16QAM_3_4</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>64QAM 2/3</name>
|
|
||||||
<key>ieee802_11.64QAM_2_3</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>64QAM 3/4</name>
|
|
||||||
<key>ieee802_11.64QAM_3_4</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Debug</name>
|
|
||||||
<key>debug</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<check>$encoding in range(8)</check>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>in</name>
|
|
||||||
<type>message</type>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>out</name>
|
|
||||||
<type>byte</type>
|
|
||||||
<nports>1</nports>
|
|
||||||
</source>
|
|
||||||
|
|
||||||
</block>
|
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<block>
|
|
||||||
<name>OFDM Parse MAC</name>
|
|
||||||
<key>ieee802_11_ofdm_parse_mac</key>
|
|
||||||
<category>IEEE802.11</category>
|
|
||||||
<import>import ieee802_11</import>
|
|
||||||
<make>ieee802_11.ofdm_parse_mac($log, $debug)</make>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Log</name>
|
|
||||||
<key>log</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Debug</name>
|
|
||||||
<key>debug</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>in</name>
|
|
||||||
<type>message</type>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>fer</name>
|
|
||||||
<type>message</type>
|
|
||||||
<optional>1</optional>
|
|
||||||
</source>
|
|
||||||
|
|
||||||
</block>
|
|
||||||
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<block>
|
|
||||||
<name>OFDM Sync Long</name>
|
|
||||||
<key>ieee802_11_ofdm_sync_long</key>
|
|
||||||
<category>IEEE802.11</category>
|
|
||||||
<import>import ieee802_11</import>
|
|
||||||
<make>ieee802_11.ofdm_sync_long($sync_length, $log, $debug)</make>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Log</name>
|
|
||||||
<key>log</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Debug</name>
|
|
||||||
<key>debug</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Sync Length</name>
|
|
||||||
<key>sync_length</key>
|
|
||||||
<value>240</value>
|
|
||||||
<type>int</type>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<check>$sync_length > 0</check>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>in</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<nports>1</nports>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>in delayed</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<nports>1</nports>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>out</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<nports>1</nports>
|
|
||||||
</source>
|
|
||||||
|
|
||||||
</block>
|
|
||||||
@@ -1,83 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<block>
|
|
||||||
<name>OFDM Sync Short</name>
|
|
||||||
<key>ieee802_11_ofdm_sync_short</key>
|
|
||||||
<category>IEEE802.11</category>
|
|
||||||
<import>import ieee802_11</import>
|
|
||||||
<make>ieee802_11.ofdm_sync_short($threshold, $min_plateau, $log, $debug)</make>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Log</name>
|
|
||||||
<key>log</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Debug</name>
|
|
||||||
<key>debug</key>
|
|
||||||
<value>False</value>
|
|
||||||
<type>bool</type>
|
|
||||||
|
|
||||||
<option>
|
|
||||||
<name>Enable</name>
|
|
||||||
<key>True</key>
|
|
||||||
</option>
|
|
||||||
<option>
|
|
||||||
<name>Disable</name>
|
|
||||||
<key>False</key>
|
|
||||||
</option>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Threshold</name>
|
|
||||||
<key>threshold</key>
|
|
||||||
<value>0.8</value>
|
|
||||||
<type>real</type>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<param>
|
|
||||||
<name>Min Plateau</name>
|
|
||||||
<key>min_plateau</key>
|
|
||||||
<value>2</value>
|
|
||||||
<type>int</type>
|
|
||||||
</param>
|
|
||||||
|
|
||||||
<check>$threshold > 0</check>
|
|
||||||
<check>$min_plateau > 0</check>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>in</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<nports>1</nports>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>abs</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<nports>1</nports>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<sink>
|
|
||||||
<name>cor</name>
|
|
||||||
<type>float</type>
|
|
||||||
<nports>1</nports>
|
|
||||||
</sink>
|
|
||||||
|
|
||||||
<source>
|
|
||||||
<name>out</name>
|
|
||||||
<type>complex</type>
|
|
||||||
<nports>1</nports>
|
|
||||||
</source>
|
|
||||||
|
|
||||||
</block>
|
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
# auto-generated by grc.converter
|
||||||
|
|
||||||
|
id: ieee802_11_parse_mac
|
||||||
|
label: WiFi Parse MAC
|
||||||
|
category: '[IEEE802.11]'
|
||||||
|
|
||||||
|
parameters:
|
||||||
|
- id: log
|
||||||
|
label: Log
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
- id: debug
|
||||||
|
label: Debug
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
- domain: message
|
||||||
|
id: in
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
- domain: message
|
||||||
|
id: out
|
||||||
|
optional: true
|
||||||
|
|
||||||
|
templates:
|
||||||
|
imports: import ieee802_11
|
||||||
|
make: ieee802_11.parse_mac(${log}, ${debug})
|
||||||
|
|
||||||
|
file_format: 1
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
# auto-generated by grc.converter
|
||||||
|
|
||||||
|
id: ieee802_11_sync_long
|
||||||
|
label: WiFi Sync Long
|
||||||
|
category: '[IEEE802.11]'
|
||||||
|
|
||||||
|
parameters:
|
||||||
|
- id: log
|
||||||
|
label: Log
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
- id: debug
|
||||||
|
label: Debug
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
- id: sync_length
|
||||||
|
label: Sync Length
|
||||||
|
dtype: int
|
||||||
|
default: '240'
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
- domain: stream
|
||||||
|
dtype: complex
|
||||||
|
multiplicity: '1'
|
||||||
|
- label: in delayed
|
||||||
|
domain: stream
|
||||||
|
dtype: complex
|
||||||
|
multiplicity: '1'
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
- domain: stream
|
||||||
|
dtype: complex
|
||||||
|
multiplicity: '1'
|
||||||
|
asserts:
|
||||||
|
- ${ sync_length > 0 }
|
||||||
|
|
||||||
|
templates:
|
||||||
|
imports: import ieee802_11
|
||||||
|
make: ieee802_11.sync_long(${sync_length}, ${log}, ${debug})
|
||||||
|
|
||||||
|
file_format: 1
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
# auto-generated by grc.converter
|
||||||
|
|
||||||
|
id: ieee802_11_sync_short
|
||||||
|
label: WiFi Sync Short
|
||||||
|
category: '[IEEE802.11]'
|
||||||
|
|
||||||
|
parameters:
|
||||||
|
- id: log
|
||||||
|
label: Log
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
- id: debug
|
||||||
|
label: Debug
|
||||||
|
dtype: bool
|
||||||
|
default: 'False'
|
||||||
|
options: ['True', 'False']
|
||||||
|
option_labels: [Enable, Disable]
|
||||||
|
- id: threshold
|
||||||
|
label: Threshold
|
||||||
|
dtype: real
|
||||||
|
default: '0.8'
|
||||||
|
- id: min_plateau
|
||||||
|
label: Min Plateau
|
||||||
|
dtype: int
|
||||||
|
default: '2'
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
- domain: stream
|
||||||
|
dtype: complex
|
||||||
|
multiplicity: '1'
|
||||||
|
- label: abs
|
||||||
|
domain: stream
|
||||||
|
dtype: complex
|
||||||
|
multiplicity: '1'
|
||||||
|
- label: cor
|
||||||
|
domain: stream
|
||||||
|
dtype: float
|
||||||
|
multiplicity: '1'
|
||||||
|
|
||||||
|
outputs:
|
||||||
|
- domain: stream
|
||||||
|
dtype: complex
|
||||||
|
multiplicity: '1'
|
||||||
|
asserts:
|
||||||
|
- ${ threshold > 0 }
|
||||||
|
- ${ min_plateau > 0 }
|
||||||
|
|
||||||
|
templates:
|
||||||
|
imports: import ieee802_11
|
||||||
|
make: ieee802_11.sync_short(${threshold}, ${min_plateau}, ${log}, ${debug})
|
||||||
|
|
||||||
|
file_format: 1
|
||||||
@@ -1,89 +0,0 @@
|
|||||||
#
|
|
||||||
# Copyright (C) 2013 Bastian Bloessl <bloessl@ccs-labs.org>
|
|
||||||
#
|
|
||||||
# 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 <http://www.gnu.org/licenses/>.
|
|
||||||
#
|
|
||||||
include(GrPython)
|
|
||||||
|
|
||||||
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py "
|
|
||||||
#!${PYTHON_EXECUTABLE}
|
|
||||||
|
|
||||||
import sys, os, re
|
|
||||||
sys.path.append('${GR_RUNTIME_PYTHONPATH}')
|
|
||||||
os.environ['srcdir'] = '${CMAKE_CURRENT_SOURCE_DIR}'
|
|
||||||
os.chdir('${CMAKE_CURRENT_BINARY_DIR}')
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
sys.path.append('${CMAKE_CURRENT_SOURCE_DIR}/../../python')
|
|
||||||
import build_utils
|
|
||||||
root, inp = sys.argv[1:3]
|
|
||||||
for sig in sys.argv[3:]:
|
|
||||||
name = re.sub ('X+', sig, root)
|
|
||||||
d = build_utils.standard_dict(name, sig, 'ieee802_11')
|
|
||||||
build_utils.expand_template(d, inp)
|
|
||||||
|
|
||||||
")
|
|
||||||
|
|
||||||
macro(expand_h root)
|
|
||||||
#make a list of all the generated files
|
|
||||||
unset(expanded_files_h)
|
|
||||||
foreach(sig ${ARGN})
|
|
||||||
string(REGEX REPLACE "X+" ${sig} name ${root})
|
|
||||||
list(APPEND expanded_files_h ${CMAKE_CURRENT_BINARY_DIR}/${name}.h)
|
|
||||||
endforeach(sig)
|
|
||||||
|
|
||||||
#create a command to generate the files
|
|
||||||
add_custom_command(
|
|
||||||
OUTPUT ${expanded_files_h}
|
|
||||||
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${root}.h.t
|
|
||||||
COMMAND ${PYTHON_EXECUTABLE} ${PYTHON_DASH_B}
|
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/generate_helper.py
|
|
||||||
${root} ${root}.h.t ${ARGN}
|
|
||||||
)
|
|
||||||
|
|
||||||
#install rules for the generated h files
|
|
||||||
list(APPEND generated_includes ${expanded_files_h})
|
|
||||||
endmacro(expand_h)
|
|
||||||
|
|
||||||
expand_h(moving_average_XX ff cc)
|
|
||||||
|
|
||||||
add_custom_target(ieee802_11_generated_includes DEPENDS
|
|
||||||
${generated_includes}
|
|
||||||
)
|
|
||||||
|
|
||||||
########################################################################
|
|
||||||
# Install public header files
|
|
||||||
########################################################################
|
|
||||||
|
|
||||||
list(APPEND include_sources
|
|
||||||
${generated_includes}
|
|
||||||
api.h
|
|
||||||
chunks_to_symbols.h
|
|
||||||
ether_encap.h
|
|
||||||
ofdm_decode_mac.h
|
|
||||||
ofdm_decode_signal.h
|
|
||||||
ofdm_equalize_symbols.h
|
|
||||||
ofdm_mac.h
|
|
||||||
ofdm_mapper.h
|
|
||||||
ofdm_parse_mac.h
|
|
||||||
ofdm_sync_long.h
|
|
||||||
ofdm_sync_short.h
|
|
||||||
wifi_signal_field.h
|
|
||||||
)
|
|
||||||
|
|
||||||
install(
|
|
||||||
FILES ${include_sources}
|
|
||||||
DESTINATION ${GR_INCLUDE_DIR}/gnuradio/ieee802_11
|
|
||||||
COMPONENT "ieee802_11_devel"
|
|
||||||
)
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (C) 2013 Bastian Bloessl <bloessl@ccs-labs.org>
|
|
||||||
*
|
|
||||||
* 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 <http://www.gnu.org/licenses/>.
|
|
||||||
*/
|
|
||||||
#ifndef INCLUDED_IEEE802_11_OFDM_SYNC_LONG_H
|
|
||||||
#define INCLUDED_IEEE802_11_OFDM_SYNC_LONG_H
|
|
||||||
|
|
||||||
#include <ieee802-11/api.h>
|
|
||||||
#include <gnuradio/block.h>
|
|
||||||
|
|
||||||
namespace gr {
|
|
||||||
namespace ieee802_11 {
|
|
||||||
|
|
||||||
class IEEE802_11_API ofdm_sync_long : virtual public block
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
|
|
||||||
typedef boost::shared_ptr<ofdm_sync_long> sptr;
|
|
||||||
static sptr make(unsigned int sync_length,
|
|
||||||
bool log = false, bool debug = false);
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
} // namespace ieee802_11
|
|
||||||
} // namespace gr
|
|
||||||
|
|
||||||
#endif /* INCLUDED_IEEE802_11_OFDM_SYNC_LONG_H */
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (C) 2013 Bastian Bloessl <bloessl@ccs-labs.org>
|
|
||||||
*
|
|
||||||
* 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 <http://www.gnu.org/licenses/>.
|
|
||||||
*/
|
|
||||||
#ifndef INCLUDED_IEEE802_11_OFDM_SYNC_SHORT_H
|
|
||||||
#define INCLUDED_IEEE802_11_OFDM_SYNC_SHORT_H
|
|
||||||
|
|
||||||
#include <ieee802-11/api.h>
|
|
||||||
#include <gnuradio/block.h>
|
|
||||||
|
|
||||||
namespace gr {
|
|
||||||
namespace ieee802_11 {
|
|
||||||
|
|
||||||
class IEEE802_11_API ofdm_sync_short : virtual public block
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
|
|
||||||
typedef boost::shared_ptr<ofdm_sync_short> sptr;
|
|
||||||
static sptr make(double threshold, unsigned int min_plateau, bool log = false, bool debug = false);
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
} // namespace ieee802_11
|
|
||||||
} // namespace gr
|
|
||||||
|
|
||||||
#endif /* INCLUDED_IEEE802_11_OFDM_SYNC_SHORT_H */
|
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
# Copyright 2011,2012 Free Software Foundation, Inc.
|
||||||
|
#
|
||||||
|
# This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
# This file is a part of gr-ieee802_11
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
#
|
||||||
|
|
||||||
|
########################################################################
|
||||||
|
# Install public header files
|
||||||
|
########################################################################
|
||||||
|
install(FILES
|
||||||
|
api.h
|
||||||
|
chunks_to_symbols.h
|
||||||
|
constellations.h
|
||||||
|
decode_mac.h
|
||||||
|
ether_encap.h
|
||||||
|
extract_csi.h
|
||||||
|
frame_equalizer.h
|
||||||
|
mac.h
|
||||||
|
mapper.h
|
||||||
|
parse_mac.h
|
||||||
|
signal_field.h
|
||||||
|
sync_long.h
|
||||||
|
sync_short.h
|
||||||
|
append_crc32.h DESTINATION include/ieee802_11
|
||||||
|
)
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2011 Free Software Foundation, Inc.
|
||||||
|
*
|
||||||
|
* This file was generated by gr_modtool, a tool from the GNU Radio framework
|
||||||
|
* This file is a part of gr-ieee802_11
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef INCLUDED_IEEE802_11_API_H
|
||||||
|
#define INCLUDED_IEEE802_11_API_H
|
||||||
|
|
||||||
|
#include <gnuradio/attributes.h>
|
||||||
|
|
||||||
|
#ifdef gnuradio_ieee802_11_EXPORTS
|
||||||
|
#define IEEE802_11_API __GR_ATTR_EXPORT
|
||||||
|
#else
|
||||||
|
#define IEEE802_11_API __GR_ATTR_IMPORT
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /* INCLUDED_IEEE802_11_API_H */
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (C) 2013 Bastian Bloessl <bloessl@ccs-labs.org>
|
* Copyright (C) 2025 Nicolas Guillaume <nicol@sguillau.me>
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* 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
|
* it under the terms of the GNU General Public License as published by
|
||||||
@@ -14,25 +14,23 @@
|
|||||||
* You should have received a copy of the GNU General Public License
|
* You should have received a copy of the GNU General Public License
|
||||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
#ifndef INCLUDED_IEEE802_11_OFDM_PARSE_MAC_H
|
#ifndef INCLUDED_IEEE802_11_APPEND_CRC32_H
|
||||||
#define INCLUDED_IEEE802_11_OFDM_PARSE_MAC_H
|
#define INCLUDED_IEEE802_11_APPEND_CRC32_H
|
||||||
|
|
||||||
#include <ieee802-11/api.h>
|
|
||||||
#include <gnuradio/block.h>
|
#include <gnuradio/block.h>
|
||||||
|
#include <ieee802_11/api.h>
|
||||||
|
|
||||||
namespace gr {
|
namespace gr {
|
||||||
namespace ieee802_11 {
|
namespace ieee802_11 {
|
||||||
|
|
||||||
class IEEE802_11_API ofdm_parse_mac : virtual public block
|
class IEEE802_11_API append_crc32 : virtual public block
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
typedef std::shared_ptr<append_crc32> sptr;
|
||||||
typedef boost::shared_ptr<ofdm_parse_mac> sptr;
|
static sptr make(bool append = true);
|
||||||
static sptr make(bool log = false, bool debug = false);
|
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace ieee802_11
|
}
|
||||||
} // namespace gr
|
}
|
||||||
|
|
||||||
#endif /* INCLUDED_IEEE802_11_OFDM_PARSE_MAC_H */
|
#endif
|
||||||
@@ -17,8 +17,8 @@
|
|||||||
#ifndef INCLUDED_IEEE802_11_CHUNKS_TO_SYMBOLS_H
|
#ifndef INCLUDED_IEEE802_11_CHUNKS_TO_SYMBOLS_H
|
||||||
#define INCLUDED_IEEE802_11_CHUNKS_TO_SYMBOLS_H
|
#define INCLUDED_IEEE802_11_CHUNKS_TO_SYMBOLS_H
|
||||||
|
|
||||||
#include <ieee802-11/api.h>
|
|
||||||
#include <gnuradio/tagged_stream_block.h>
|
#include <gnuradio/tagged_stream_block.h>
|
||||||
|
#include <ieee802_11/api.h>
|
||||||
|
|
||||||
namespace gr {
|
namespace gr {
|
||||||
namespace ieee802_11 {
|
namespace ieee802_11 {
|
||||||
@@ -26,7 +26,7 @@ namespace ieee802_11 {
|
|||||||
class IEEE802_11_API chunks_to_symbols : virtual public tagged_stream_block
|
class IEEE802_11_API chunks_to_symbols : virtual public tagged_stream_block
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
typedef boost::shared_ptr<chunks_to_symbols> sptr;
|
typedef std::shared_ptr<chunks_to_symbols> sptr;
|
||||||
static sptr make();
|
static sptr make();
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (C) 2016 Bastian Bloessl <bloessl@ccs-labs.org>
|
||||||
|
*
|
||||||
|
* 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 <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef INCLUDED_IEEE802_11_CONSTELLATIONS_H
|
||||||
|
#define INCLUDED_IEEE802_11_CONSTELLATIONS_H
|
||||||
|
|
||||||
|
#include <gnuradio/digital/constellation.h>
|
||||||
|
#include <ieee802_11/api.h>
|
||||||
|
|
||||||
|
namespace gr {
|
||||||
|
namespace ieee802_11 {
|
||||||
|
|
||||||
|
class IEEE802_11_API constellation_bpsk : virtual public digital::constellation
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
typedef std::shared_ptr<gr::ieee802_11::constellation_bpsk> sptr;
|
||||||
|
static sptr make();
|
||||||
|
sptr base() { return std::dynamic_pointer_cast<gr::ieee802_11::constellation_bpsk>(shared_from_this()); }
|
||||||
|
|
||||||
|
protected:
|
||||||
|
constellation_bpsk();
|
||||||
|
};
|
||||||
|
|
||||||
|
class IEEE802_11_API constellation_qpsk : virtual public digital::constellation
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
typedef std::shared_ptr<gr::ieee802_11::constellation_qpsk> sptr;
|
||||||
|
static sptr make();
|
||||||
|
sptr base() { return std::dynamic_pointer_cast<gr::ieee802_11::constellation_qpsk>(shared_from_this()); }
|
||||||
|
|
||||||
|
protected:
|
||||||
|
constellation_qpsk();
|
||||||
|
};
|
||||||
|
|
||||||
|
class IEEE802_11_API constellation_16qam : virtual public digital::constellation
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
typedef std::shared_ptr<gr::ieee802_11::constellation_16qam> sptr;
|
||||||
|
static sptr make();
|
||||||
|
sptr base() { return std::dynamic_pointer_cast<gr::ieee802_11::constellation_16qam>(shared_from_this()); }
|
||||||
|
|
||||||
|
protected:
|
||||||
|
constellation_16qam();
|
||||||
|
};
|
||||||
|
|
||||||
|
class IEEE802_11_API constellation_64qam : virtual public digital::constellation
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
typedef std::shared_ptr<gr::ieee802_11::constellation_64qam> sptr;
|
||||||
|
static sptr make();
|
||||||
|
sptr base() { return std::dynamic_pointer_cast<gr::ieee802_11::constellation_64qam>(shared_from_this()); }
|
||||||
|
|
||||||
|
protected:
|
||||||
|
constellation_64qam();
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace ieee802_11
|
||||||
|
} // namespace gr
|
||||||
|
|
||||||
|
#endif /* INCLUDED_IEEE802_11_CONSTELLATIONS_H */
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright (C) 2013 Bastian Bloessl <bloessl@ccs-labs.org>
|
* Copyright (C) 2013, 2016 Bastian Bloessl <bloessl@ccs-labs.org>
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* 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
|
* it under the terms of the GNU General Public License as published by
|
||||||
@@ -14,27 +14,23 @@
|
|||||||
* You should have received a copy of the GNU General Public License
|
* You should have received a copy of the GNU General Public License
|
||||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
#ifndef INCLUDED_IEEE802_11_OFDM_DECODE_MAC_H
|
#ifndef INCLUDED_IEEE802_11_DECODE_MAC_H
|
||||||
#define INCLUDED_IEEE802_11_OFDM_DECODE_MAC_H
|
#define INCLUDED_IEEE802_11_DECODE_MAC_H
|
||||||
|
|
||||||
#include <ieee802-11/api.h>
|
|
||||||
#include <gnuradio/block.h>
|
#include <gnuradio/block.h>
|
||||||
|
#include <ieee802_11/api.h>
|
||||||
|
|
||||||
namespace gr {
|
namespace gr {
|
||||||
namespace ieee802_11 {
|
namespace ieee802_11 {
|
||||||
|
|
||||||
class IEEE802_11_API ofdm_decode_mac : virtual public block
|
class IEEE802_11_API decode_mac : virtual public block
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
typedef std::shared_ptr<decode_mac> sptr;
|
||||||
typedef boost::shared_ptr<ofdm_decode_mac> sptr;
|
|
||||||
static sptr make(bool log = false, bool debug = false);
|
static sptr make(bool log = false, bool debug = false);
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace ieee802_11
|
} // namespace ieee802_11
|
||||||
} // namespace gr
|
} // namespace gr
|
||||||
|
|
||||||
#endif /* INCLUDED_IEEE802_11_OFDM_DECODE_MAC_H */
|
#endif /* INCLUDED_IEEE802_11_DECODE_MAC_H */
|
||||||
|
|
||||||
|
|
||||||
@@ -17,8 +17,8 @@
|
|||||||
#ifndef INCLUDED_IEEE802_11_ETHER_ENCAP_H
|
#ifndef INCLUDED_IEEE802_11_ETHER_ENCAP_H
|
||||||
#define INCLUDED_IEEE802_11_ETHER_ENCAP_H
|
#define INCLUDED_IEEE802_11_ETHER_ENCAP_H
|
||||||
|
|
||||||
#include <ieee802-11/api.h>
|
|
||||||
#include <gnuradio/block.h>
|
#include <gnuradio/block.h>
|
||||||
|
#include <ieee802_11/api.h>
|
||||||
|
|
||||||
namespace gr {
|
namespace gr {
|
||||||
namespace ieee802_11 {
|
namespace ieee802_11 {
|
||||||
@@ -26,10 +26,8 @@ namespace ieee802_11 {
|
|||||||
class IEEE802_11_API ether_encap : virtual public block
|
class IEEE802_11_API ether_encap : virtual public block
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
typedef std::shared_ptr<ether_encap> sptr;
|
||||||
typedef boost::shared_ptr<ether_encap> sptr;
|
|
||||||
static sptr make(bool debug);
|
static sptr make(bool debug);
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace ieee802_11
|
} // namespace ieee802_11
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
/* -*- c++ -*- */
|
||||||
|
/*
|
||||||
|
* Copyright 2021 Anton Ottosson.
|
||||||
|
*
|
||||||
|
* This 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 software 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 software; see the file COPYING. If not, write to
|
||||||
|
* the Free Software Foundation, Inc., 51 Franklin Street,
|
||||||
|
* Boston, MA 02110-1301, USA.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef INCLUDED_IEEE802_11_EXTRACT_CSI_H
|
||||||
|
#define INCLUDED_IEEE802_11_EXTRACT_CSI_H
|
||||||
|
|
||||||
|
#include <gnuradio/sync_block.h>
|
||||||
|
#include <ieee802_11/api.h>
|
||||||
|
|
||||||
|
namespace gr {
|
||||||
|
namespace ieee802_11 {
|
||||||
|
|
||||||
|
class IEEE802_11_API extract_csi : virtual public gr::sync_block
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
typedef std::shared_ptr<extract_csi> sptr;
|
||||||
|
static sptr make();
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace ieee802_11
|
||||||
|
} // namespace gr
|
||||||
|
|
||||||
|
#endif /* INCLUDED_IEEE802_11_EXTRACT_CSI_H */
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user