pax_global_header00006660000000000000000000000064145107550510014515gustar00rootroot0000000000000052 comment=622fc6dde99ee172ebaa9c8628d85a7a1995a21d libzmq-4.3.5/000077500000000000000000000000001451075505100130245ustar00rootroot00000000000000libzmq-4.3.5/.clang-format000066400000000000000000000026061451075505100154030ustar00rootroot00000000000000BasedOnStyle: LLVM IndentWidth: 4 UseTab: Never BreakBeforeBraces: Custom BraceWrapping: AfterClass: true AfterControlStatement: false AfterEnum: true AfterFunction: true AfterNamespace: true AfterObjCDeclaration: true AfterStruct: true AfterUnion: true BeforeCatch: true BeforeElse: false IndentBraces: false AlignConsecutiveAssignments: false AlignConsecutiveDeclarations: false AllowShortIfStatementsOnASingleLine: false IndentCaseLabels: true BinPackArguments: true BinPackParameters: false AlignTrailingComments: true AllowShortBlocksOnASingleLine: false AllowAllParametersOfDeclarationOnNextLine: true AllowShortFunctionsOnASingleLine: InlineOnly AlwaysBreakTemplateDeclarations: false ColumnLimit: 80 MaxEmptyLinesToKeep: 2 KeepEmptyLinesAtTheStartOfBlocks: false ContinuationIndentWidth: 2 PointerAlignment: Right ReflowComments: false SpaceBeforeAssignmentOperators: true SpaceBeforeParens: Always SpaceInEmptyParentheses: false SpacesInAngles: false SpacesInParentheses: false SpacesInSquareBrackets: false Standard: Cpp03 SortIncludes: false FixNamespaceComments: false BreakBeforeBinaryOperators: NonAssignment SpaceAfterTemplateKeyword: true AlignAfterOpenBracket: Align AlignOperands: true BreakConstructorInitializers: AfterColon ConstructorInitializerAllOnOneLineOrOnePerLine: true SpaceAfterCStyleCast: true BreakBeforeTernaryOperators: true libzmq-4.3.5/.clang-tidy000077500000000000000000000476331451075505100151000ustar00rootroot00000000000000Checks: "*,\ # not currently a coding convention, but conceivable,\ -llvm-include-order,\ # currently the coding convention deliberately produces violations of these,\ # rules, but it may make sense to reconsider,\ -readability-implicit-bool-conversion,\ -readability-braces-around-statements,\ -readability-named-parameter,\ -fuchsia-default-arguments,\ -google-readability-todo,\ -google-runtime-int,\ -cppcoreguidelines-avoid-goto,\ -hicpp-avoid-goto, \ -cppcoreguidelines-pro-type-member-init,\ -cppcoreguidelines-pro-type-static-cast-downcast,\ -readability-identifier-naming,\ # not applicable,\ -fuchsia-default-arguments-calls,\ -fuchsia-overloaded-operator,\ -fuchsia-statically-constructed-objects,\ # not currently a coding convention, C++11-specific, but conceivable,\ -modernize-use-nullptr,\ -modernize-use-equals-default,\ -modernize-deprecated-headers,\ # not currently a coding convention, C++11-specific and hard to implement,\ -hicpp-no-malloc,\ -hicpp-avoid-c-arrays,\ -modernize-avoid-c-arrays,\ -modernize-pass-by-value,\ -modernize-loop-convert,\ -modernize-use-auto,\ -modernize-use-trailing-return-type,\ -modernize-use-using,\ -modernize-return-braced-init-list,\ -cppcoreguidelines-avoid-c-arrays,\ -cppcoreguidelines-no-malloc,\ -cppcoreguidelines-owning-memory,\ -cppcoreguidelines-pro-type-union-access,\ -cppcoreguidelines-pro-bounds-array-to-pointer-decay,\ -cppcoreguidelines-pro-bounds-constant-array-index,\ -cppcoreguidelines-pro-bounds-pointer-arithmetic,\ # not easily possible to implement (maybe replace by specific exclusions),\ -cppcoreguidelines-pro-type-vararg,\ -cppcoreguidelines-pro-type-reinterpret-cast,\ -hicpp-signed-bitwise,\ # duplicates,\ -google-readability-braces-around-statements,\ -cppcoreguidelines-pro-type-cstyle-cast,\ -cppcoreguidelines-avoid-magic-numbers,\ -readability-magic-numbers,\ -hicpp-braces-around-statements,\ -hicpp-use-equals-default,\ -hicpp-deprecated-headers,\ -hicpp-no-assembler,\ -hicpp-vararg,\ -hicpp-use-auto,\ -hicpp-use-nullptr,\ -hicpp-no-array-decay,\ -hicpp-member-init" WarningsAsErrors: '' HeaderFilterRegex: '' # AnalyzeTemporaryDtors: false CheckOptions: # - key: cert-dcl59-cpp.HeaderFileExtensions # value: h,hh,hpp,hxx # - key: cert-err61-cpp.CheckThrowTemporaries # value: '1' # - key: cert-oop11-cpp.IncludeStyle # value: llvm # - key: cert-oop11-cpp.UseCERTSemantics # value: '1' # - key: cppcoreguidelines-pro-bounds-constant-array-index.GslHeader # value: '' # - key: cppcoreguidelines-pro-bounds-constant-array-index.IncludeStyle # value: '0' # - key: cppcoreguidelines-pro-type-member-init.IgnoreArrays # value: '0' # - key: google-build-namespaces.HeaderFileExtensions # value: h,hh,hpp,hxx # - key: google-global-names-in-headers.HeaderFileExtensions # value: h # - key: google-readability-braces-around-statements.ShortStatementLines # value: '1' # - key: google-readability-function-size.BranchThreshold # value: '4294967295' # - key: google-readability-function-size.LineThreshold # value: '4294967295' # - key: google-readability-function-size.StatementThreshold # value: '800' # - key: google-readability-namespace-comments.ShortNamespaceLines # value: '10' # - key: google-readability-namespace-comments.SpacesBeforeComments # value: '2' # - key: google-runtime-int.SignedTypePrefix # value: int # - key: google-runtime-int.TypeSuffix # value: '' # - key: google-runtime-int.UnsignedTypePrefix # value: uint # - key: llvm-namespace-comment.ShortNamespaceLines # value: '1' # - key: llvm-namespace-comment.SpacesBeforeComments # value: '1' # - key: misc-assert-side-effect.AssertMacros # value: assert # - key: misc-assert-side-effect.CheckFunctionCalls # value: '0' # - key: misc-dangling-handle.HandleClasses # value: 'std::basic_string_view;std::experimental::basic_string_view' # - key: misc-definitions-in-headers.HeaderFileExtensions # value: ',h,hh,hpp,hxx' # - key: misc-definitions-in-headers.UseHeaderFileExtension # value: '1' # - key: misc-misplaced-widening-cast.CheckImplicitCasts # value: '1' # - key: misc-move-constructor-init.IncludeStyle # value: llvm # - key: misc-move-constructor-init.UseCERTSemantics # value: '0' # - key: misc-sizeof-expression.WarnOnSizeOfCompareToConstant # value: '1' # - key: misc-sizeof-expression.WarnOnSizeOfConstant # value: '1' # - key: misc-sizeof-expression.WarnOnSizeOfThis # value: '1' # - key: misc-string-constructor.LargeLengthThreshold # value: '8388608' # - key: misc-string-constructor.WarnOnLargeLength # value: '1' # - key: misc-suspicious-missing-comma.MaxConcatenatedTokens # value: '5' # - key: misc-suspicious-missing-comma.RatioThreshold # value: '0.200000' # - key: misc-suspicious-missing-comma.SizeThreshold # value: '5' # - key: misc-suspicious-string-compare.StringCompareLikeFunctions # value: '' # - key: misc-suspicious-string-compare.WarnOnImplicitComparison # value: '1' # - key: misc-suspicious-string-compare.WarnOnLogicalNotComparison # value: '0' # - key: misc-throw-by-value-catch-by-reference.CheckThrowTemporaries # value: '1' # - key: modernize-loop-convert.MaxCopySize # value: '16' # - key: modernize-loop-convert.MinConfidence # value: reasonable # - key: modernize-loop-convert.NamingStyle # value: CamelCase # - key: modernize-pass-by-value.IncludeStyle # value: llvm # - key: modernize-replace-auto-ptr.IncludeStyle # value: llvm # - key: modernize-use-nullptr.NullMacros # value: 'NULL' # - key: performance-faster-string-find.StringLikeClasses # value: 'std::basic_string' # - key: performance-for-range-copy.WarnOnAllAutoCopies # value: '0' # - key: readability-braces-around-statements.ShortStatementLines # value: '1' # - key: readability-function-size.BranchThreshold # value: '4294967295' # - key: readability-function-size.LineThreshold # value: '4294967295' # - key: readability-function-size.StatementThreshold # value: '800' # - key: readability-identifier-naming.AbstractClassCase # value: aNy_CasE # - key: readability-identifier-naming.AbstractClassPrefix # value: '' # - key: readability-identifier-naming.AbstractClassSuffix # value: '' # - key: readability-identifier-naming.ClassCase # value: aNy_CasE # - key: readability-identifier-naming.ClassConstantCase # value: aNy_CasE # - key: readability-identifier-naming.ClassConstantPrefix # value: '' # - key: readability-identifier-naming.ClassConstantSuffix # value: '' # - key: readability-identifier-naming.ClassMemberCase # value: aNy_CasE # - key: readability-identifier-naming.ClassMemberPrefix # value: '' # - key: readability-identifier-naming.ClassMemberSuffix # value: '' # - key: readability-identifier-naming.ClassMethodCase # value: aNy_CasE # - key: readability-identifier-naming.ClassMethodPrefix # value: '' # - key: readability-identifier-naming.ClassMethodSuffix # value: '' # - key: readability-identifier-naming.ClassPrefix # value: '' # - key: readability-identifier-naming.ClassSuffix # value: '' # - key: readability-identifier-naming.ConstantCase # value: aNy_CasE # - key: readability-identifier-naming.ConstantMemberCase # value: aNy_CasE # - key: readability-identifier-naming.ConstantMemberPrefix # value: '' # - key: readability-identifier-naming.ConstantMemberSuffix # value: '' # - key: readability-identifier-naming.ConstantParameterCase # value: aNy_CasE # - key: readability-identifier-naming.ConstantParameterPrefix # value: '' # - key: readability-identifier-naming.ConstantParameterSuffix # value: '' # - key: readability-identifier-naming.ConstantPrefix # value: '' # - key: readability-identifier-naming.ConstantSuffix # value: '' # - key: readability-identifier-naming.ConstexprFunctionCase # value: aNy_CasE # - key: readability-identifier-naming.ConstexprFunctionPrefix # value: '' # - key: readability-identifier-naming.ConstexprFunctionSuffix # value: '' # - key: readability-identifier-naming.ConstexprMethodCase # value: aNy_CasE # - key: readability-identifier-naming.ConstexprMethodPrefix # value: '' # - key: readability-identifier-naming.ConstexprMethodSuffix # value: '' # - key: readability-identifier-naming.ConstexprVariableCase # value: aNy_CasE # - key: readability-identifier-naming.ConstexprVariablePrefix # value: '' # - key: readability-identifier-naming.ConstexprVariableSuffix # value: '' # - key: readability-identifier-naming.EnumCase # value: aNy_CasE # - key: readability-identifier-naming.EnumConstantCase # value: aNy_CasE # - key: readability-identifier-naming.EnumConstantPrefix # value: '' # - key: readability-identifier-naming.EnumConstantSuffix # value: '' # - key: readability-identifier-naming.EnumPrefix # value: '' # - key: readability-identifier-naming.EnumSuffix # value: '' # - key: readability-identifier-naming.FunctionCase # value: aNy_CasE # - key: readability-identifier-naming.FunctionPrefix # value: '' # - key: readability-identifier-naming.FunctionSuffix # value: '' # - key: readability-identifier-naming.GlobalConstantCase # value: aNy_CasE # - key: readability-identifier-naming.GlobalConstantPrefix # value: '' # - key: readability-identifier-naming.GlobalConstantSuffix # value: '' # - key: readability-identifier-naming.GlobalFunctionCase # value: aNy_CasE # - key: readability-identifier-naming.GlobalFunctionPrefix # value: '' # - key: readability-identifier-naming.GlobalFunctionSuffix # value: '' # - key: readability-identifier-naming.GlobalVariableCase # value: aNy_CasE # - key: readability-identifier-naming.GlobalVariablePrefix # value: '' # - key: readability-identifier-naming.GlobalVariableSuffix # value: '' # - key: readability-identifier-naming.IgnoreFailedSplit # value: '0' # - key: readability-identifier-naming.InlineNamespaceCase # value: aNy_CasE # - key: readability-identifier-naming.InlineNamespacePrefix # value: '' # - key: readability-identifier-naming.InlineNamespaceSuffix # value: '' - key: readability-identifier-naming.LocalConstantCase value: lower_case - key: readability-identifier-naming.LocalConstantPrefix value: '' - key: readability-identifier-naming.LocalConstantSuffix value: '' - key: readability-identifier-naming.LocalVariableCase value: lower_case - key: readability-identifier-naming.LocalVariablePrefix value: '' - key: readability-identifier-naming.LocalVariableSuffix value: '' # - key: readability-identifier-naming.MemberCase # value: lower_case # - key: readability-identifier-naming.MemberPrefix # value: '_' # - key: readability-identifier-naming.MemberSuffix # value: '' # - key: readability-identifier-naming.MethodCase # value: aNy_CasE # - key: readability-identifier-naming.MethodPrefix # value: '' # - key: readability-identifier-naming.MethodSuffix # value: '' # - key: readability-identifier-naming.NamespaceCase # value: aNy_CasE # - key: readability-identifier-naming.NamespacePrefix # value: '' # - key: readability-identifier-naming.NamespaceSuffix # value: '' - key: readability-identifier-naming.ParameterCase value: lower_case # - key: readability-identifier-naming.ParameterPackCase # value: aNy_CasE # - key: readability-identifier-naming.ParameterPackPrefix # value: '' # - key: readability-identifier-naming.ParameterPackSuffix # value: '' # - key: readability-identifier-naming.ParameterPrefix # value: '' - key: readability-identifier-naming.ParameterSuffix value: '_' - key: readability-identifier-naming.PrivateMemberCase value: lower_case - key: readability-identifier-naming.PrivateMemberPrefix value: '_' - key: readability-identifier-naming.PrivateMemberSuffix value: '' # - key: readability-identifier-naming.PrivateMethodCase # value: aNy_CasE # - key: readability-identifier-naming.PrivateMethodPrefix # value: '' # - key: readability-identifier-naming.PrivateMethodSuffix # value: '' # - key: readability-identifier-naming.ProtectedMemberCase # value: aNy_CasE # - key: readability-identifier-naming.ProtectedMemberPrefix # value: '' # - key: readability-identifier-naming.ProtectedMemberSuffix # value: '' # - key: readability-identifier-naming.ProtectedMethodCase # value: aNy_CasE # - key: readability-identifier-naming.ProtectedMethodPrefix # value: '' # - key: readability-identifier-naming.ProtectedMethodSuffix # value: '' # - key: readability-identifier-naming.PublicMemberCase # value: aNy_CasE # - key: readability-identifier-naming.PublicMemberPrefix # value: '' # - key: readability-identifier-naming.PublicMemberSuffix # value: '' # - key: readability-identifier-naming.PublicMethodCase # value: aNy_CasE # - key: readability-identifier-naming.PublicMethodPrefix # value: '' # - key: readability-identifier-naming.PublicMethodSuffix # value: '' # - key: readability-identifier-naming.StaticConstantCase # value: aNy_CasE # - key: readability-identifier-naming.StaticConstantPrefix # value: '' # - key: readability-identifier-naming.StaticConstantSuffix # value: '' # - key: readability-identifier-naming.StaticVariableCase # value: aNy_CasE # - key: readability-identifier-naming.StaticVariablePrefix # value: '' # - key: readability-identifier-naming.StaticVariableSuffix # value: '' # - key: readability-identifier-naming.StructCase # value: aNy_CasE # - key: readability-identifier-naming.StructPrefix # value: '' # - key: readability-identifier-naming.StructSuffix # value: '' # - key: readability-identifier-naming.TemplateParameterCase # value: aNy_CasE # - key: readability-identifier-naming.TemplateParameterPrefix # value: '' # - key: readability-identifier-naming.TemplateParameterSuffix # value: '' # - key: readability-identifier-naming.TemplateTemplateParameterCase # value: aNy_CasE # - key: readability-identifier-naming.TemplateTemplateParameterPrefix # value: '' # - key: readability-identifier-naming.TemplateTemplateParameterSuffix # value: '' # - key: readability-identifier-naming.TypeTemplateParameterCase # value: aNy_CasE # - key: readability-identifier-naming.TypeTemplateParameterPrefix # value: '' # - key: readability-identifier-naming.TypeTemplateParameterSuffix # value: '' # - key: readability-identifier-naming.TypedefCase # value: aNy_CasE # - key: readability-identifier-naming.TypedefPrefix # value: '' # - key: readability-identifier-naming.TypedefSuffix # value: '' # - key: readability-identifier-naming.UnionCase # value: aNy_CasE # - key: readability-identifier-naming.UnionPrefix # value: '' # - key: readability-identifier-naming.UnionSuffix # value: '' # - key: readability-identifier-naming.ValueTemplateParameterCase # value: aNy_CasE # - key: readability-identifier-naming.ValueTemplateParameterPrefix # value: '' # - key: readability-identifier-naming.ValueTemplateParameterSuffix # value: '' # - key: readability-identifier-naming.VariableCase # value: aNy_CasE # - key: readability-identifier-naming.VariablePrefix # value: '' # - key: readability-identifier-naming.VariableSuffix # value: '' # - key: readability-identifier-naming.VirtualMethodCase # value: aNy_CasE # - key: readability-identifier-naming.VirtualMethodPrefix # value: '' # - key: readability-identifier-naming.VirtualMethodSuffix # value: '' # - key: readability-simplify-boolean-expr.ChainedConditionalAssignment # value: '0' # - key: readability-simplify-boolean-expr.ChainedConditionalReturn # value: '0' - key: modernize-use-override.OverrideSpelling value: 'ZMQ_OVERRIDE' - key: modernize-use-override.FinalSpelling value: 'ZMQ_FINAL' libzmq-4.3.5/.git-blame-ignore-revs000066400000000000000000000001021451075505100171150ustar00rootroot00000000000000# tree-wide clang format 41f459e1dc6f7cdedd1268298153c970e290b2ce libzmq-4.3.5/.github/000077500000000000000000000000001451075505100143645ustar00rootroot00000000000000libzmq-4.3.5/.github/CONTRIBUTING.md000066400000000000000000000031301451075505100166120ustar00rootroot00000000000000# Pull Request Notice Before sending a pull request make sure each commit solves one clear, minimal, plausible problem. Further each commit should have the following format: ``` Problem: X is broken Solution: do Y and Z to fix X ``` Please try to have the code changes conform to our coding style. For your convenience, you can install clang-format (at least version 5.0) and then run ```make clang-format-check```. Don't fix existing issues, if any - just make sure your changes are compliant. ```make clang-format-diff``` will automatically apply the required changes. To set a specific clang-format binary with autotools, you can for example run: ```./configure CLANG_FORMAT=clang-format-5.0``` Please avoid sending a pull request with recursive merge nodes, as they are impossible to fix once merged. Please rebase your branch on zeromq/libzmq master instead of merging it. ``` git remote add upstream git@github.com:zeromq/libzmq.git git fetch upstream git rebase upstream/master git push -f ``` In case you already merged instead of rebasing you can drop the merge commit. ``` git rebase -i HEAD~10 ``` Now, find your merge commit and mark it as drop and save. Finally rebase! If you are a new contributor please have a look at our contributing guidelines: [CONTRIBUTING](http://zeromq.org/docs:contributing) # FIRST TIME CONTRIBUTORS PLEASE NOTE Please add an additional commit with a relicensing grant. [Example](https://github.com/zeromq/libzmq/commit/fecbd42dbe45455fff3b6456350ceca047b82050) [More information on RELICENSING effort](https://github.com/zeromq/libzmq/tree/master/RELICENSE/README.md) libzmq-4.3.5/.github/issue_template.md000066400000000000000000000005341451075505100177330ustar00rootroot00000000000000*Please use this template for reporting suspected bugs or requests for help.* # Issue description # Environment * libzmq version (commit hash if unreleased): * OS: # Minimal test code / Steps to reproduce the issue 1. # What's the actual result? (include assertion message & call stack if applicable) # What's the expected result? libzmq-4.3.5/.github/stale.yml000066400000000000000000000013701451075505100162200ustar00rootroot00000000000000# Number of days of inactivity before an issue becomes stale daysUntilStale: 365 # Number of days of inactivity before a stale issue is closed daysUntilClose: 56 # Issues with these labels will never be considered stale exemptLabels: - "Help Request" - "Feature Request" - "Problem reproduced" - Critical # Label to use when marking an issue as stale staleLabel: stale # Comment to post when marking an issue as stale. Set to `false` to disable markComment: > This issue has been automatically marked as stale because it has not had activity for 365 days. It will be closed if no further activity occurs within 56 days. Thank you for your contributions. # Comment to post when closing a stale issue. Set to `false` to disable closeComment: false libzmq-4.3.5/.github/workflows/000077500000000000000000000000001451075505100164215ustar00rootroot00000000000000libzmq-4.3.5/.github/workflows/CI.yaml000066400000000000000000000201461451075505100176030ustar00rootroot00000000000000name: CI on: push: pull_request: schedule: - cron: "0 9 * * 5" jobs: build: if: github.event_name == 'pull_request' || github.event_name == 'push' runs-on: ${{ matrix.os }} strategy: fail-fast: false matrix: include: - platform: x64 configuration: release os: windows-2019 WITH_LIBSODIUM: ON ENABLE_CURVE: ON CMAKE_GENERATOR: Visual Studio 16 2019 MSVCVERSION: v142 MSVCYEAR: vs2019 ARTIFACT_NAME: v142-x64 ENABLE_DRAFTS: ON - os: ubuntu-latest BUILD_TYPE: default PACKAGES: asciidoc xmlto DRAFT: disabled POLLER: select - os: ubuntu-latest BUILD_TYPE: default DRAFT: disabled POLLER: poll - os: ubuntu-latest BUILD_TYPE: android DRAFT: disabled - os: ubuntu-latest BUILD_TYPE: coverage PACKAGES: libkrb5-dev libnorm-dev libpgm-dev libgnutls28-dev lcov DRAFT: enabled GSSAPI: enabled PGM: enabled NORM: enabled TIPC: enabled TLS: enabled VMCI: enabled - os: ubuntu-latest BUILD_TYPE: valgrind PACKAGES: valgrind libgnutls28-dev DRAFT: enabled - os: ubuntu-latest BUILD_TYPE: cmake CURVE: libsodium DRAFT: enabled PACKAGES: cmake libsodium-dev TLS: enabled - os: ubuntu-latest BUILD_TYPE: cmake DRAFT: enabled PACKAGES: cmake clang-format-11 DO_CLANG_FORMAT_CHECK: 1 - os: ubuntu-latest BUILD_TYPE: default PACKAGES: libkrb5-dev libnorm-dev libpgm-dev libgnutls28-dev libsodium-dev libnss3-dev libbsd-dev CURVE: libsodium ADDRESS_SANITIZER: enabled DRAFT: enabled - os: ubuntu-latest BUILD_TYPE: default PACKAGES: libkrb5-dev libnorm-dev libpgm-dev libgnutls28-dev libsodium-dev libnss3-dev libbsd-dev CURVE: libsodium GSSAPI: enabled PGM: enabled NORM: enabled TIPC: enabled IPv6: ON TLS: enabled USE_NSS: yes VMCI: enabled DRAFT: enabled - os: ubuntu-latest BUILD_TYPE: default PACKAGES: libkrb5-dev libnorm-dev libpgm-dev libgnutls28-dev libsodium-dev libnss3-dev CURVE: libsodium GSSAPI: enabled PGM: enabled NORM: enabled TIPC: enabled IPv6: ON TLS: enabled USE_NSS: yes VMCI: enabled DRAFT: enabled FORCE_98: enabled CXX: clang++ - os: ubuntu-latest BUILD_TYPE: abi-compliance-checker PACKAGES: abi-dumper abi-compliance-checker DRAFT: disabled - os: ubuntu-latest BUILD_TYPE: cmake PACKAGES: clang-tidy clang-tools DRAFT: enabled CXX: clang++ - os: macos-latest BUILD_TYPE: default PACKAGES: automake autoconf DRAFT: enabled - os: macos-latest BUILD_TYPE: default PACKAGES: automake autoconf libsodium CURVE: libsodium DRAFT: disabled env: platform: ${{ matrix.platform }} configuration: ${{ matrix.configuration }} WITH_LIBSODIUM: ${{ matrix.WITH_LIBSODIUM }} ENABLE_CURVE: ${{ matrix.ENABLE_CURVE }} CMAKE_GENERATOR: ${{ matrix.CMAKE_GENERATOR }} MSVCVERSION: ${{ matrix.MSVCVERSION }} MSVCYEAR: ${{ matrix.MSVCYEAR }} ARTIFACT_NAME: ${{ matrix.ARTIFACT_NAME }} ENABLE_DRAFTS: ${{ matrix.ENABLE_DRAFTS }} SODIUM_INCLUDE_DIR: ${{ github.workspace }}\libsodium\src\libsodium\include" SODIUM_LIBRARY_DIR: ${{ github.workspace }}\libsodium\bin\${{ matrix.platform }}\${{ matrix.configuration }}\${{ matrix.MSVCVERSION }}\dynamic" LIBZMQ_SRCDIR: ${{ github.workspace }}\libzmq BUILD_TYPE: ${{ matrix.BUILD_TYPE }} CURVE: ${{ matrix.CURVE }} DRAFT: ${{ matrix.DRAFT }} ADDRESS_SANITIZER: ${{ matrix.ADDRESS_SANITIZER }} DO_CLANG_FORMAT_CHECK: ${{ matrix.DO_CLANG_FORMAT_CHECK }} FORCE_98: ${{ matrix.FORCE_98 }} CXX: ${{ matrix.CXX }} GSSAPI: ${{ matrix.GSSAPI }} PGM: ${{ matrix.PGM }} NORM: ${{ matrix.NORM }} TIPC: ${{ matrix.TIPC }} IPv6: ${{ matrix.IPv6 }} TLS: ${{ matrix.TLS }} USE_NSS: ${{ matrix.USE_NSS }} VMCI: ${{ matrix.VMCI }} POLLER: ${{ matrix.POLLER }} steps: - name: Add msbuild to PATH uses: microsoft/setup-msbuild@v1.0.2 if: matrix.os == 'windows-2019' - uses: actions/checkout@v2 if: matrix.WITH_LIBSODIUM == 'ON' with: repository: jedisct1/libsodium ref: stable path: libsodium - name: Compile libsodium if: matrix.WITH_LIBSODIUM == 'ON' && matrix.os == 'windows-2019' shell: cmd working-directory: libsodium run: msbuild /v:minimal /p:Configuration=%Configuration%DLL builds\msvc\%MSVCYEAR%\libsodium\libsodium.vcxproj - name: Copy libsodium if: matrix.WITH_LIBSODIUM == 'ON' && matrix.os == 'windows-2019' shell: powershell working-directory: libsodium run: Copy-Item "bin\${env:Platform}\${env:Configuration}\${env:MSVCVERSION}\dynamic\libsodium.lib" -Destination "bin\${env:Platform}\${env:Configuration}\${env:MSVCVERSION}\dynamic\sodium.lib" - uses: actions/checkout@v2 with: path: libzmq - run: md build_libzmq shell: cmd if: matrix.os == 'windows-2019' - name: build-win if: matrix.os == 'windows-2019' shell: cmd working-directory: build_libzmq run: | cmake -D CMAKE_INCLUDE_PATH="%SODIUM_INCLUDE_DIR%" -D CMAKE_LIBRARY_PATH="%SODIUM_LIBRARY_DIR%" -D WITH_LIBSODIUM="%WITH_LIBSODIUM%" -D ENABLE_DRAFTS="%ENABLE_DRAFTS%" -D ENABLE_ANALYSIS="%ENABLE_ANALYSIS%" -D ENABLE_CURVE="%ENABLE_CURVE%" -D API_POLLER="%API_POLLER%" -D POLLER="%POLLER%" %EXTRA_FLAGS% -D WITH_LIBSODIUM="%WITH_LIBSODIUM%" -D LIBZMQ_WERROR="%LIBZMQ_WERROR%" -G "%CMAKE_GENERATOR%" "%LIBZMQ_SRCDIR%" cmake --build . --config %configuration% --target install -- -verbosity:Minimal -maxcpucount - name: test if: matrix.os == 'windows-2019' shell: cmd working-directory: build_libzmq run: ctest -C "%Configuration%" - name: Add debian packages if: matrix.os == 'ubuntu-latest' && (matrix.BUILD_TYPE != 'coverage' || github.repository == 'zeromq/libzmq') uses: myci-actions/add-deb-repo@10 with: repo-name: obs repo: deb http://download.opensuse.org/repositories/network:/messaging:/zeromq:/git-stable/xUbuntu_20.04/ ./ keys-asc: https://download.opensuse.org/repositories/network:/messaging:/zeromq:/git-stable/xUbuntu_20.04/Release.key install: ${{ matrix.PACKAGES }} - name: Add brew packages if: matrix.os == 'macos-latest' shell: bash run: brew install ${{ matrix.PACKAGES }} - name: build if: (matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest') && (matrix.BUILD_TYPE != 'coverage' || github.repository == 'zeromq/libzmq') shell: bash working-directory: libzmq run: ./ci_build.sh - name: coveralls if: matrix.BUILD_TYPE == 'coverage' && github.repository == 'zeromq/libzmq' uses: coverallsapp/github-action@master with: github-token: ${{ secrets.GITHUB_TOKEN }} path-to-lcov: /home/runner/work/libzmq/libzmq/libzmq/lcov.info cron: runs-on: ubuntu-latest if: github.event_name == 'schedule' strategy: fail-fast: false env: BUILD_TYPE: cmake CXX: clang++ CLANG_TIDY: clang-tidy steps: - name: Add debian packages run: apt-get install --yes clang-tidy clang-tools - name: build shell: bash working-directory: libzmq run: ./ci_build.sh libzmq-4.3.5/.github/workflows/Fuzzers.yaml000066400000000000000000000016471451075505100207650ustar00rootroot00000000000000name: Fuzzers on: push: branches: - master pull_request: paths: - '.github/workflows/Fuzzers.yaml' - 'src/*' - 'tests/*fuzzer.cpp' jobs: Fuzzing: runs-on: ubuntu-latest if: github.repository == 'zeromq/libzmq' strategy: matrix: san: [address, memory, undefined] steps: - name: Build Fuzzers (${{ matrix.san }}) id: build uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master with: sanitizer: ${{ matrix.san }} oss-fuzz-project-name: 'libzmq' allowed-broken-targets-percentage: 0 dry-run: false - name: Run Fuzzers (${{ matrix.san }}) id: run uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master with: sanitizer: ${{ matrix.san }} oss-fuzz-project-name: 'libzmq' allowed-broken-targets-percentage: 0 dry-run: false fuzz-seconds: 300 libzmq-4.3.5/.gitignore000066400000000000000000000040151451075505100150140ustar00rootroot00000000000000syntax: glob # for hg-git users # Generated build scripts and IDE generating files ## autotools /Makefile builds/Makefile builds/deprecated-msvc/Makefile doc/Makefile libtool ### automake Makefile.in .deps/ .dirstamp ### autoconf autom4te.cache aclocal.m4 config config.status config.log configure stamp-h1 ## CMake cmake-build-debug/ build/ ## Android builds/android/prefix ## IntelliJ .idea/ ## Visual Code .vscode/ ## other results-like folders bin/ lib/ obj/ ## Doxygen doxygen/ ## Packaging packaging/nuget/*.nupkg # Test related build files libtestutil.a libunity.a # Some build outputs and temporal files *.o *.gcno *.gcda *.gcov *.ncb *.lo *.loT *.la *.exe *.html *.pdf *.ps *~ .*~ .libs # /src ## Ignore generated files in configuration process src/platform.hpp* src/libzmq.pc # /tools ## Executable binaries are ignored tools/curve_keygen ## Executable source files must be tracked !tools/*.[ch] !tools/*.[ch]pp # /tests ## Test binaries and logs are ignored tests/test* tests/test*.log tests/test*.trs ## Test source files must be tracked !tests/test*.[ch] !tests/test*.[ch]pp ## Build script and documentations must be tracked !tests/CMakeLists.txt !tests/README.md # /unittests ## Unit test binaries and logs are ignored unittests/unittest_* unittests/unittest*.log unittests/unittest*.trs ## Unit test source files must be tracked !unittests/unittest*.[ch] !unittests/unittest*.[ch]pp ## Build script and documentations must be tracked !unittests/CMakeLists.txt !unittests/README.md # check test log files test-suite*.log # /perf ## Benchmarking binaries and result files are ignored perf/*_lat perf/*_thr perf/benchmark_* perf/results ## Benchmarking source files must be tracked !perf/*.[ch] !perf/*.[ch]pp ## Benchmarking tool scripts must be tracked !perf/*.py !perf/*.sh # /doc ## Generated document files doc/*.[137] doc/*.html doc/*.xml # external libraries and release archive files foreign/openpgm/* !foreign/openpgm/*.tar.bz2 !foreign/openpgm/*.tar.gz !foreign/openpgm/Makefile.am zeromq-*.tar.gz zeromq-*.zip core mybuild libzmq-4.3.5/.hgeol000066400000000000000000000000271451075505100141220ustar00rootroot00000000000000[patterns] ** = native libzmq-4.3.5/.mailmap000066400000000000000000000133051451075505100144470ustar00rootroot00000000000000Ahmet Kakici ahmet Andrey Sibiryov Kobolog Brian Knox taotetek Chernyshev Vyacheslav Astellar Chris Laws Chris Laws Chris Staite Chris Christoph Zach czach Chuck Remes Chuck Remes Chuck Remes Chuck Remes Constantin Rack Constantin Rack Constantin Rack Constantin Rack Daniel Krikun danielkr Daiyu Hurst DaiyuHurst Diego Rodriguez-Losada Diego Dongmin Yu Min(Dongmin Yu) Doron Somech somdoron Elliot Saba staticfloat Eric Voskuil evoskuil Eric Voskuil anonymous Felipe Farinon psl-felipefarinon Frank Hartmann Frank Gian Lorenzo Meocci meox Hardeep Singh Hardeep Henrik Feldt Henrik Huang Xin chrox Ian Barber Ian Barber Jens Auer Jens Auer Jens Auer Jens Auer Joe Eli McIlvain Joe McIlvain Jos Decoster jdc8 Jos Decoster Jos Decoster Joshua Gao Josh Gao Jörg Kreuzberger kreuzberger Arnaud Kapp Kapp Arnaud Arnaud Kapp KAPP Arnaud Arnaud Kapp KAPP Arnaud Kenneth Wilke KennethWilke Kevin Sapper sappo Kevin Sapper Kevin Sapper Leonard Michelet leonarf Martijn Jasperse mjasperse Martin Hurton Martin Hurtoň Martin Lucina Martin Lucina Martin Sustrik Martin Sustrik Martin Sustrik Martin Sustrik Martin Sustrik sustrik Martin Sustrik Martin Sustrik Martin Sustrik unknown Martin Sustrik Martin Sustrik Maurice Barnum maurice barnum Maurizio Melato unknown Max Skaller skaller Michael Fox <415fox@gmail.com> m <415fox@gmail.com> Michael Hand Mipa Michel Zou xantares Mikael Helbo Kjaer Mikael Helbo Kjær Mike Gatny Mike Gatny Mikko Koppanen Mikko Koppanen Mikko Koppanen Mikko Koppanen Mikko Koppanen Mikko Koppanen Min RK MinRK Min RK Min Ragan-Kelley Montoya Edu montoyaedu Nikita Kozlov nikita kozlov Pavol Malosek malosek Pieter Hintjens Pieter Hintjens Reza Ebrahimi reza.ebrahimi Ricardo Catalinas Jiménez Ricardo Catalinas Jiménez Rohan Bedarkar rohanbedarkar Rohan Bedarkar Rohan Sergey KHripchenko root Sergey KHripchenko shripchenko Sergey M. Sergey M․ Steven McCoy Steve-o Tamara Kustarova tamara Timothee Besset Timothee "TTimo" Besset Timothy Mossbarger Tim M Trevor Bernard Trevor Bernard Trevor Bernard Trevor Bernard Volodymyr Korniichuk Volodymyr Korniichuk <9173519@gmail.com> lysyloren lysyloren libzmq-4.3.5/.obs/000077500000000000000000000000001451075505100136655ustar00rootroot00000000000000libzmq-4.3.5/.obs/workflows.yml000066400000000000000000000012571451075505100164520ustar00rootroot00000000000000workflow: steps: - branch_package: source_project: network:messaging:zeromq:git-draft source_package: libzmq target_project: network:messaging:zeromq:ci rebuild: steps: - trigger_services: project: network:messaging:zeromq:git-stable package: libzmq - trigger_services: project: network:messaging:zeromq:git-draft package: libzmq filters: event: push release: steps: - trigger_services: project: network:messaging:zeromq:release-stable package: libzmq - trigger_services: project: network:messaging:zeromq:release-draft package: libzmq filters: event: tag_push libzmq-4.3.5/.travis.yml000066400000000000000000000036221451075505100151400ustar00rootroot00000000000000# Travis CI script language: c os: - linux dist: bionic cache: ccache env: matrix: - BUILD_TYPE=default # tokens to deploy releases on OBS and create/delete temporary branch on Github. # 1) Create a token on https://github.com/settings/tokens/new with "public_repo" # capability and encrypt it with travis encrypt --org -r zeromq/libzmq GH_TOKEN="" # 2) Create 2 OBS tokens with osc token --create network:messaging:zeromq:release- libzmq # encrypt them with travis encrypt --org -r zeromq/libzmq OBS__TOKEN="" global: - secure: aaIs9Y44FYp9VFCqa6LLD4illBH4aUfbS0zzzbAQ5xJvD6NfBsMiKEIhf/kRNCHAtP+1VfQVOejTD6/i08ALsVr3cZD9oB/t7874tz2/jeZUIhRNo+1KwyaVqNg0yUSV6ASIoq4aOfuGnjBlezNQ8LQ2bjQB2m4Enl5wxoYcYdA= - secure: YFrcedBIKe0NR1WC6qQi9phZgtnzOiBIXm40TirvCtstV4eVnSouKgtQfLLArZ4o2tjflq4grQQNo1rJatvyi5YPOXsMcndsni18S+4Ffu8qbECdtPrK52vBweuf7q9oV9Ydax0Fm4bEqEMOZ2/mRBy3nK+mgsE3upeMwyWR0Zw= - secure: lbZSzmqN39QdJwewKOZgq/1ijPKuyx9MFrGzMqXj2+eOSlaZS/tNavHMdKJOev+qJGK9wxmwzxOxS10AiH+AvN7WBacXX4ZtudjScz2HKJRDWTKyzMbzyScq51afniItzrsm+Vo8NHkenNFkux0sSbh0aHlpkLwrGQu+WZWcDN4= - secure: "ZFL7hLJlGwYix8fF835OnQYakBt/o5iS7IfSW7el44ejEvGAOM9O5/ufxCcqSqn8Np7nOaM3RriAVTqWPZD6S7tMeflGTSGYHPYwWUc83z4rUPyG2FWVKXdB8ufpebAwu3hCgLiSmVeoQG47dl6xNk1oKCd+3UIjgz33u1Ecfps=" # Build and check this project according to the BUILD_TYPE script: ./ci_build.sh # Deploy tags before_deploy: - . ./ci_deploy.sh deploy: provider: releases api_key: secure: vGB5E+A8wxm2J1GJZzmIgT9PrjEzvd9gE8iui8FyxSbxAsW9vFZFGZC/21sTtpVcmRarwQCHH1UEbtg+nJwN2iD9YzMRnSVks8xqP+b709YW+VXaMuhZgTzWa74IorQku7NuvLibvQk72/OSgdwPGaNJ6f5AX9pnWVWbEoW1svE= file_glob: true file: ${LIBZMQ_DEPLOYMENT} skip_cleanup: true on: repo: zeromq/libzmq branch: master tags: true condition: "$TRAVIS_OS_NAME =~ (linux) && $BUILD_TYPE =~ (default) && $CURVE =~ (libsodium) && -z $DRAFT" libzmq-4.3.5/AUTHORS000066400000000000000000000044561451075505100141050ustar00rootroot00000000000000Corporate Contributors ====================== Copyright (c) 2007-2014 iMatix Corporation Copyright (c) 2009-2011 250bpm s.r.o. Copyright (c) 2010-2011 Miru Limited Copyright (c) 2011 VMware, Inc. Copyright (c) 2012 Spotify AB Copyright (c) 2013 Ericsson AB Copyright (c) 2014 AppDynamics Inc. Copyright (c) 2015 Google, Inc. Copyright (c) 2015-2016 Brocade Communications Systems Inc. Individual Contributors ======================= AJ Lewis Alexej Lotz Andrew Thompson André Caron Asko Kauppi Attila Mark Barak Amar Ben Gray Bernd Melchers Bernd Prager Bob Beaty Brandon Carpenter Brett Cameron Brett Viren Brian Buchanan Burak Arslan Carl Clemens Chia-liang Kao Chris Busbey Chris Rempel Chris Wong Christian Gudrian Christian Kamm Chuck Remes Conrad D. Steenberg Constantin Rack Daniel J. Bernstein Dhammika Pathirana Dhruva Krishnamurthy Dirk O. Kaar Doron Somech Douglas Creager Drew Crawford Erich Heine Erik Hugne Erik Rigtorp Fabien Ninoles Frank Denis George Neill Gerard Toonstra Ghislain Putois Gonzalo Diethelm Guido Goldstein Harald Achitz Hardeep Singh Hiten Pandya Ian Barber Ilja Golshtein Ilya Kulakov Ivo Danihelka Jacob Rideout Joe Thornber Jon Dyte Kamil Shakirov Ken Steele Kouhei Sutou Leonardo J. Consoni Lionel Flandrin Lourens Naudé Luca Boccassi Marc Rossi Mark Barbisan Martin Hurton Martin Lucina Martin Pales Martin Sustrik Matus Hamorsky Max Wolf McClain Looney Michael Compton Mika Fischer Mikael Helbo Kjaer Mike Gatny Mikko Koppanen Min Ragan-Kelley Neale Ferguson Nir Soffer Osiris Pedroso Paul Betts Paul Colomiets Pavel Gushcha Pavol Malosek Perry Kundert Peter Bourgon Philip Kovacs Pieter Hintjens Piotr Trojanek Reza Ebrahimi Richard Newton Rik van der Heijden Robert G. Jakabosky Sebastian Otaegui Stefan Radomski Steven McCoy Stuart Webster Tamara Kustarova Taras Shpot Tero Marttila Terry Wilson Thijs Terlouw Thomas Rodgers Tim Mossbarger Toralf Wittner Tore Halvorsen Trevor Bernard Vitaly Mayatskikh Credits ======= Aamir Mohammad Adrian von Bidder Aleksey Yeschenko Alessio Spadaro Alexander Majorov Anh Vu Bernd Schumacher Brian Granger Carsten Dinkelmann David Bahi Dirk Eddelbuettel Evgueny Khartchenko Frank Vanden Berghen Ian Barber John Apps Markus Fischer Matt Muggeridge Michael Santy Oleg Sevostyanov Paulo Henrique Silva Peter Busser Peter Lemenkov Robert Zhang Toralf Wittner Zed Shaw libzmq-4.3.5/CMakeLists.txt000066400000000000000000001731111451075505100155700ustar00rootroot00000000000000# CMake build script for ZeroMQ project(ZeroMQ) if(${CMAKE_SYSTEM_NAME} STREQUAL Darwin) cmake_minimum_required(VERSION 3.0.2) else() cmake_minimum_required(VERSION 2.8.12) endif() include(CheckIncludeFiles) include(CheckCCompilerFlag) include(CheckCXXCompilerFlag) include(CheckLibraryExists) include(CheckCSourceCompiles) include(CheckCSourceRuns) include(CMakeDependentOption) include(CheckCXXSymbolExists) include(CheckStructHasMember) include(CheckTypeSize) include(FindThreads) include(GNUInstallDirs) include(CheckTypeSize) include(CMakePackageConfigHelpers) list(INSERT CMAKE_MODULE_PATH 0 "${CMAKE_CURRENT_SOURCE_DIR}") set(ZMQ_CMAKE_MODULES_DIR ${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/Modules) list(APPEND CMAKE_MODULE_PATH ${ZMQ_CMAKE_MODULES_DIR}) include(TestZMQVersion) include(ZMQSourceRunChecks) include(ZMQSupportMacros) find_package(PkgConfig) # Set lists to empty beforehand as to not accidentally take values from parent set(sources) set(cxx-sources) set(html-docs) set(target_outputs) option(ENABLE_ASAN "Build with address sanitizer" OFF) if(ENABLE_ASAN) message(STATUS "Instrumenting with Address Sanitizer") set(CMAKE_BUILD_TYPE "RelWithDebInfo") set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address -fsanitize-address-use-after-scope -fno-omit-frame-pointer") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address -fsanitize-address-use-after-scope -fno-omit-frame-pointer") set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -fsanitize=address -fsanitize-address-use-after-scope") set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=address -fsanitize-address-use-after-scope") endif() # NOTE: Running libzmq under TSAN doesn't make much sense -- synchronization in libzmq is to some extent # handled by the code "knowing" what threads are allowed to do, rather than by enforcing those # restrictions, so TSAN generates a lot of (presumably) false positives from libzmq. # The settings below are intended to enable libzmq to be built with minimal support for TSAN # such that it can be used along with other code that is also built with TSAN. option(ENABLE_TSAN "Build with thread sanitizer" OFF) if(ENABLE_TSAN) message(STATUS "Instrumenting with Thread Sanitizer") set(CMAKE_BUILD_TYPE "RelWithDebInfo") set(TSAN_FLAGS "-fno-omit-frame-pointer -fsanitize=thread") set(TSAN_CCFLAGS "${TSAN_CCFLAGS} -mllvm -tsan-instrument-memory-accesses=0") set(TSAN_CCFLAGS "${TSAN_CCFLAGS} -mllvm -tsan-instrument-atomics=0") set(TSAN_CCFLAGS "${TSAN_CCFLAGS} -mllvm -tsan-instrument-func-entry-exit=1") set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${TSAN_FLAGS} ${TSAN_CCFLAGS} -fPIE") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${TSAN_FLAGS} ${TSAN_CCFLAGS} -fPIE") set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${TSAN_FLAGS} -pie -Qunused-arguments") set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${TSAN_FLAGS} -pie -Qunused-arguments") endif() option(ENABLE_UBSAN "Build with undefined behavior sanitizer" OFF) if(ENABLE_UBSAN) message(STATUS "Instrumenting with Undefined Behavior Sanitizer") set(CMAKE_BUILD_TYPE "Debug") set(UBSAN_FLAGS "${UBSAN_FLAGS} -fno-omit-frame-pointer") set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=undefined") set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=implicit-conversion") set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=implicit-integer-truncation") set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=integer") set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=nullability") set(UBSAN_FLAGS "${UBSAN_FLAGS} -fsanitize=vptr") set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${UBSAN_FLAGS}") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${UBSAN_FLAGS}") set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${UBSAN_FLAGS}") set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${UBSAN_FLAGS}") endif() option(ENABLE_INTRINSICS "Build using compiler intrinsics for atomic ops" OFF) if(ENABLE_INTRINSICS) message(STATUS "Using compiler intrinsics for atomic ops") add_definitions(-DZMQ_HAVE_ATOMIC_INTRINSICS) endif() set(ZMQ_OUTPUT_BASENAME "zmq" CACHE STRING "Output zmq library base name") if(${CMAKE_SYSTEM_NAME} STREQUAL Darwin) # Find more information: https://cmake.org/Wiki/CMake_RPATH_handling # Apply CMP0042: MACOSX_RPATH is enabled by default cmake_policy(SET CMP0042 NEW) # Add an install rpath if it is not a system directory list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}" isSystemDir) if("${isSystemDir}" STREQUAL "-1") set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}") endif() # Add linker search paths pointing to external dependencies set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE) endif() if (NOT MSVC) if(NOT CMAKE_CXX_FLAGS MATCHES "-std=" AND NOT CXX_STANDARD AND NOT CMAKE_CXX_STANDARD) # use C++11 by default if supported check_cxx_compiler_flag("-std=c++11" COMPILER_SUPPORTS_CXX11) if(COMPILER_SUPPORTS_CXX11) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11") endif() endif() if(NOT CMAKE_C_FLAGS MATCHES "-std=" AND NOT C_STANDARD AND NOT CMAKE_C_STANDARD) check_c_compiler_flag("-std=c11" COMPILER_SUPPORTS_C11) if(COMPILER_SUPPORTS_C11) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=c11") else() set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu99") endif() endif() # clang 6 has a warning that does not make sense on multi-platform code check_cxx_compiler_flag("-Wno-tautological-constant-compare" CXX_HAS_TAUT_WARNING) if(CXX_HAS_TAUT_WARNING) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-tautological-constant-compare") endif() check_c_compiler_flag("-Wno-tautological-constant-compare" CC_HAS_TAUT_WARNING) if(CC_HAS_TAUT_WARNING) set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-tautological-constant-compare") endif() endif() # Will be used to add flags to pkg-config useful when apps want to statically link set(pkg_config_libs_private "") set(pkg_config_names_private "") set(pkg_config_defines "") option(WITH_OPENPGM "Build with support for OpenPGM" OFF) option(WITH_NORM "Build with support for NORM" OFF) option(WITH_VMCI "Build with support for VMware VMCI socket" OFF) if(APPLE) option(ZMQ_BUILD_FRAMEWORK "Build as OS X framework" OFF) endif() if(EXISTS "${CMAKE_SOURCE_DIR}/.git") option(ENABLE_DRAFTS "Build and install draft classes and methods" ON) else() option(ENABLE_DRAFTS "Build and install draft classes and methods" OFF) endif() # Enable WebSocket transport and RadixTree if(ENABLE_DRAFTS) message(STATUS "Building draft classes and methods") option(ENABLE_WS "Enable WebSocket transport" ON) option(ENABLE_RADIX_TREE "Use radix tree implementation to manage subscriptions" ON) set(pkg_config_defines "-DZMQ_BUILD_DRAFT_API=1") else() message(STATUS "Not building draft classes and methods") option(ENABLE_WS "Enable WebSocket transport" OFF) option(ENABLE_RADIX_TREE "Use radix tree implementation to manage subscriptions" OFF) endif() if(ENABLE_RADIX_TREE) message(STATUS "Using radix tree implementation to manage subscriptions") set(ZMQ_USE_RADIX_TREE 1) endif() if(ENABLE_WS) list( APPEND sources ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_address.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_connecter.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_decoder.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_encoder.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_engine.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_listener.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_address.hpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_connecter.hpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_decoder.hpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_encoder.hpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_engine.hpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_listener.hpp ${CMAKE_CURRENT_SOURCE_DIR}/src/ws_protocol.hpp) set(ZMQ_HAVE_WS 1) message(STATUS "Enable WebSocket transport") option(WITH_TLS "Use TLS for WSS support" ON) option(WITH_NSS "Use NSS instead of builtin sha1" OFF) if(WITH_TLS) find_package("GnuTLS" 3.6.7) if(GNUTLS_FOUND) set(pkg_config_names_private "${pkg_config_names_private} gnutls") list(APPEND sources ${CMAKE_CURRENT_SOURCE_DIR}/src/wss_address.hpp ${CMAKE_CURRENT_SOURCE_DIR}/src/wss_address.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/wss_engine.hpp ${CMAKE_CURRENT_SOURCE_DIR}/src/wss_engine.cpp) message(STATUS "Enable WSS transport") set(ZMQ_USE_GNUTLS 1) set(ZMQ_HAVE_WSS 1) else() message(WARNING "No WSS support, you may want to install GnuTLS and run cmake again") endif() endif() endif() if(NOT ZMQ_USE_GNUTLS) if(WITH_NSS) pkg_check_modules(NSS3 "nss") if(NSS3_FOUND) set(pkg_config_names_private "${pkg_config_names_private} nss") message(STATUS "Using NSS") set(ZMQ_USE_NSS 1) else() find_package("NSS3") if(NSS3_FOUND) set(pkg_config_libs_private "${pkg_config_libs_private} -lnss3") message(STATUS "Using NSS") set(ZMQ_USE_NSS 1) else() message(WARNING "No nss installed, if you don't want builtin SHA1, install NSS or GnuTLS") endif() endif() endif() if(NOT ZMQ_USE_NSS) list(APPEND sources ${CMAKE_CURRENT_SOURCE_DIR}/external/sha1/sha1.c ${CMAKE_CURRENT_SOURCE_DIR}/external/sha1/sha1.h) message(STATUS "Using builtin sha1") set(ZMQ_USE_BUILTIN_SHA1 1) endif() endif() if(NOT MSVC) option(WITH_LIBBSD "Use libbsd instead of builtin strlcpy" ON) if(WITH_LIBBSD) pkg_check_modules(LIBBSD "libbsd") if(LIBBSD_FOUND) message(STATUS "Using libbsd") set(pkg_config_names_private "${pkg_config_names_private} libbsd") set(ZMQ_HAVE_LIBBSD 1) endif() endif() check_cxx_symbol_exists(strlcpy string.h ZMQ_HAVE_STRLCPY) endif() # Select curve encryption library, defaults to disabled To use libsodium instead, use --with-libsodium(must be # installed) To disable curve, use --disable-curve option(WITH_LIBSODIUM "Use libsodium" OFF) option(WITH_LIBSODIUM_STATIC "Use static libsodium library" OFF) option(ENABLE_LIBSODIUM_RANDOMBYTES_CLOSE "Automatically close libsodium randombytes. Not threadsafe without getrandom()" ON) option(ENABLE_CURVE "Enable CURVE security" OFF) if(ENABLE_CURVE) if(WITH_LIBSODIUM) find_package("sodium") if(SODIUM_FOUND) message(STATUS "Using libsodium for CURVE security") include_directories(${SODIUM_INCLUDE_DIRS}) link_directories(${SODIUM_LIBRARY_DIRS}) if(WITH_LIBSODIUM_STATIC) add_compile_definitions(SODIUM_STATIC) endif() set(ZMQ_USE_LIBSODIUM 1) set(ZMQ_HAVE_CURVE 1) if (ENABLE_LIBSODIUM_RANDOMBYTES_CLOSE) set(ZMQ_LIBSODIUM_RANDOMBYTES_CLOSE 1) endif() else() message( ERROR "libsodium not installed, you may want to install libsodium and run cmake again" ) endif() endif() else() message(STATUS "CURVE security is disabled") endif() set(SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}") option(WITH_MILITANT "Enable militant assertions" OFF) if(WITH_MILITANT) add_definitions(-DZMQ_ACT_MILITANT) endif() set(API_POLLER "" CACHE STRING "Choose polling system for zmq_poll(er)_*. valid values are poll or select [default=poll unless POLLER=select]") set(POLLER "" CACHE STRING "Choose polling system for I/O threads. valid values are kqueue, epoll, devpoll, pollset, poll or select [default=autodetect]") if(WIN32) if(CMAKE_SYSTEM_NAME STREQUAL "WindowsStore" AND CMAKE_SYSTEM_VERSION MATCHES "^10.0") set(ZMQ_HAVE_WINDOWS_UWP ON) set(ZMQ_HAVE_IPC OFF) # to remove compile warninging "D9002 ignoring unknown option" string(REPLACE "/Zi" "" CMAKE_CXX_FLAGS_DEBUG ${CMAKE_CXX_FLAGS_DEBUG}) set(CMAKE_CXX_FLAGS_DEBUG ${CMAKE_CXX_FLAGS_DEBUG} CACHE STRING "" FORCE) string(REPLACE "/Zi" "" CMAKE_CXX_FLAGS_RELWITHDEBINFO ${CMAKE_CXX_FLAGS_RELWITHDEBINFO}) set(CMAKE_CXX_FLAGS_RELWITHDEBINFO ${CMAKE_CXX_FLAGS_RELWITHDEBINFO} CACHE STRING "" FORCE) string(REPLACE "/Zi" "" CMAKE_CXX_FLAGS_DEBUG ${CMAKE_CXX_FLAGS_DEBUG}) endif() # from https://stackoverflow.com/a/40217291/2019765 macro(get_WIN32_WINNT version) if(CMAKE_SYSTEM_VERSION) set(ver ${CMAKE_SYSTEM_VERSION}) string(REGEX MATCH "^([0-9]+).([0-9])" ver ${ver}) string(REGEX MATCH "^([0-9]+)" verMajor ${ver}) # Check for Windows 10, b/c we'll need to convert to hex 'A'. if("${verMajor}" MATCHES "10") set(verMajor "A") string(REGEX REPLACE "^([0-9]+)" ${verMajor} ver ${ver}) endif("${verMajor}" MATCHES "10") # Remove all remaining '.' characters. string(REPLACE "." "" ver ${ver}) # Prepend each digit with a zero. string(REGEX REPLACE "([0-9A-Z])" "0\\1" ver ${ver}) set(${version} "0x${ver}") endif(CMAKE_SYSTEM_VERSION) endmacro(get_WIN32_WINNT) get_win32_winnt(ZMQ_WIN32_WINNT_DEFAULT) message(STATUS "Detected _WIN32_WINNT from CMAKE_SYSTEM_VERSION: ${ZMQ_WIN32_WINNT_DEFAULT}") # TODO limit _WIN32_WINNT to the actual Windows SDK version, which might be different from the default version # installed with Visual Studio if(MSVC_VERSION STREQUAL "1500" AND CMAKE_SYSTEM_VERSION VERSION_GREATER "6.0") set(ZMQ_WIN32_WINNT_LIMIT "0x0600") elseif(MSVC_VERSION STREQUAL "1600" AND CMAKE_SYSTEM_VERSION VERSION_GREATER "6.1") set(ZMQ_WIN32_WINNT_LIMIT "0x0601") elseif(MSVC_VERSION STREQUAL "1700" AND CMAKE_SYSTEM_VERSION VERSION_GREATER "6.1") set(ZMQ_WIN32_WINNT_LIMIT "0x0601") elseif(MSVC_VERSION STREQUAL "1800" AND CMAKE_SYSTEM_VERSION VERSION_GREATER "6.2") set(ZMQ_WIN32_WINNT_LIMIT "0x0602") endif() if(ZMQ_WIN32_WINNT_LIMIT) message( STATUS "Mismatch of Visual Studio Version (${MSVC_VERSION}) and CMAKE_SYSTEM_VERSION (${CMAKE_SYSTEM_VERSION}), limiting _WIN32_WINNT to ${ZMQ_WIN32_WINNT_LIMIT}, you may override this by setting ZMQ_WIN32_WINNT" ) set(ZMQ_WIN32_WINNT_DEFAULT "${ZMQ_WIN32_WINNT_LIMIT}") endif() set(ZMQ_WIN32_WINNT "${ZMQ_WIN32_WINNT_DEFAULT}" CACHE STRING "Value to set _WIN32_WINNT to for building [default=autodetect from build environment]") # On Windows Vista or greater, with MSVC 2013 or greater, default to epoll (which is required on Win 10 for ipc # support) if(ZMQ_WIN32_WINNT GREATER "0x05FF" AND MSVC_VERSION GREATER 1799 AND POLLER STREQUAL "" AND NOT ZMQ_HAVE_WINDOWS_UWP) set(POLLER "epoll") endif() add_definitions(-D_WIN32_WINNT=${ZMQ_WIN32_WINNT}) endif(WIN32) if(NOT MSVC) if(POLLER STREQUAL "") check_cxx_symbol_exists(kqueue sys/event.h HAVE_KQUEUE) if(HAVE_KQUEUE) set(POLLER "kqueue") endif() endif() if(POLLER STREQUAL "") check_cxx_symbol_exists(epoll_create sys/epoll.h HAVE_EPOLL) if(HAVE_EPOLL) set(POLLER "epoll") check_cxx_symbol_exists(epoll_create1 sys/epoll.h HAVE_EPOLL_CLOEXEC) if(HAVE_EPOLL_CLOEXEC) set(ZMQ_IOTHREAD_POLLER_USE_EPOLL_CLOEXEC 1) endif() endif() endif() if(POLLER STREQUAL "") check_include_files("sys/devpoll.h" HAVE_DEVPOLL) if(HAVE_DEVPOLL) set(POLLER "devpoll") endif() endif() if(POLLER STREQUAL "") check_cxx_symbol_exists(pollset_create sys/pollset.h HAVE_POLLSET) if(HAVE_POLLSET) set(POLLER "pollset") endif() endif() if(POLLER STREQUAL "") check_cxx_symbol_exists(poll poll.h HAVE_POLL) if(HAVE_POLL) set(POLLER "poll") endif() endif() endif() if(POLLER STREQUAL "") if(WIN32) set(HAVE_SELECT 1) else() check_cxx_symbol_exists(select sys/select.h HAVE_SELECT) endif() if(HAVE_SELECT) set(POLLER "select") else() message(FATAL_ERROR "Could not autodetect polling method") endif() endif() if(POLLER STREQUAL "kqueue" OR POLLER STREQUAL "epoll" OR POLLER STREQUAL "devpoll" OR POLLER STREQUAL "pollset" OR POLLER STREQUAL "poll" OR POLLER STREQUAL "select") message(STATUS "Using polling method in I/O threads: ${POLLER}") string(TOUPPER ${POLLER} UPPER_POLLER) set(ZMQ_IOTHREAD_POLLER_USE_${UPPER_POLLER} 1) else() message(FATAL_ERROR "Invalid polling method") endif() if(POLLER STREQUAL "epoll" AND WIN32) message(STATUS "Including wepoll") list(APPEND sources ${CMAKE_CURRENT_SOURCE_DIR}/external/wepoll/wepoll.c ${CMAKE_CURRENT_SOURCE_DIR}/external/wepoll/wepoll.h) endif() if(API_POLLER STREQUAL "") if(POLLER STREQUAL "select") set(API_POLLER "select") else() set(API_POLLER "poll") endif() endif() message(STATUS "Using polling method in zmq_poll(er)_* API: ${API_POLLER}") string(TOUPPER ${API_POLLER} UPPER_API_POLLER) set(ZMQ_POLL_BASED_ON_${UPPER_API_POLLER} 1) check_cxx_symbol_exists(pselect sys/select.h HAVE_PSELECT) if (NOT WIN32 AND HAVE_PSELECT) set(ZMQ_HAVE_PPOLL 1) endif() # special alignment settings execute_process( COMMAND getconf LEVEL1_DCACHE_LINESIZE OUTPUT_VARIABLE CACHELINE_SIZE ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE) if(CACHELINE_SIZE STREQUAL "" OR CACHELINE_SIZE EQUAL 0 OR CACHELINE_SIZE EQUAL -1 OR CACHELINE_SIZE EQUAL "undefined") set(ZMQ_CACHELINE_SIZE 64) else() set(ZMQ_CACHELINE_SIZE ${CACHELINE_SIZE}) endif() message(STATUS "Using ${ZMQ_CACHELINE_SIZE} bytes alignment for lock-free data structures") check_cxx_symbol_exists(posix_memalign stdlib.h HAVE_POSIX_MEMALIGN) if(NOT CYGWIN) # TODO cannot we simply do 'if(WIN32) set(ZMQ_HAVE_WINDOWS ON)' or similar? check_include_files(windows.h ZMQ_HAVE_WINDOWS) endif() if(NOT WIN32) set(ZMQ_HAVE_IPC 1) set(ZMQ_HAVE_STRUCT_SOCKADDR_UN 1) else() check_include_files("winsock2.h;afunix.h" ZMQ_HAVE_IPC) if(ZMQ_HAVE_IPC) check_struct_has_member("struct sockaddr_un" sun_path "winsock2.h;afunix.h" ZMQ_HAVE_STRUCT_SOCKADDR_UN) endif() endif() # ##################### BEGIN condition_variable_t selection if(NOT ZMQ_CV_IMPL) # prefer C++11 STL std::condition_variable implementation, if available check_include_files(condition_variable ZMQ_HAVE_STL_CONDITION_VARIABLE LANGUAGE CXX) if(ZMQ_HAVE_STL_CONDITION_VARIABLE) set(ZMQ_CV_IMPL_DEFAULT "stl11") else() if(WIN32 AND NOT CMAKE_SYSTEM_VERSION VERSION_LESS "6.0") # Win32API CONDITION_VARIABLE is supported from Windows Vista only set(ZMQ_CV_IMPL_DEFAULT "win32api") elseif(CMAKE_USE_PTHREADS_INIT) set(ZMQ_CV_IMPL_DEFAULT "pthreads") else() set(ZMQ_CV_IMPL_DEFAULT "none") endif() endif() # TODO a vxworks implementation also exists, but vxworks is not currently supported with cmake at all set(ZMQ_CV_IMPL "${ZMQ_CV_IMPL_DEFAULT}" CACHE STRING "Choose condition_variable_t implementation. Valid values are stl11, win32api, pthreads, none [default=autodetect]") endif() message(STATUS "Using condition_variable_t implementation: ${ZMQ_CV_IMPL}") if(ZMQ_CV_IMPL STREQUAL "stl11") set(ZMQ_USE_CV_IMPL_STL11 1) elseif(ZMQ_CV_IMPL STREQUAL "win32api") set(ZMQ_USE_CV_IMPL_WIN32API 1) elseif(ZMQ_CV_IMPL STREQUAL "pthreads") set(ZMQ_USE_CV_IMPL_PTHREADS 1) elseif(ZMQ_CV_IMPL STREQUAL "none") set(ZMQ_USE_CV_IMPL_NONE 1) else() message(ERROR "Unknown value for ZMQ_CV_IMPL: ${ZMQ_CV_IMPL}") endif() # ##################### END condition_variable_t selection if(NOT MSVC) check_include_files(ifaddrs.h ZMQ_HAVE_IFADDRS) check_include_files(sys/uio.h ZMQ_HAVE_UIO) check_include_files(sys/eventfd.h ZMQ_HAVE_EVENTFD) if(ZMQ_HAVE_EVENTFD AND NOT CMAKE_CROSSCOMPILING) zmq_check_efd_cloexec() endif() endif() if(ZMQ_HAVE_WINDOWS) # Cannot use check_library_exists because the symbol is always declared as char(*)(void) set(CMAKE_REQUIRED_LIBRARIES "ws2_32.lib") check_cxx_symbol_exists(WSAStartup "winsock2.h" HAVE_WS2_32) set(CMAKE_REQUIRED_LIBRARIES "rpcrt4.lib") check_cxx_symbol_exists(UuidCreateSequential "rpc.h" HAVE_RPCRT4) set(CMAKE_REQUIRED_LIBRARIES "iphlpapi.lib") check_cxx_symbol_exists(GetAdaptersAddresses "winsock2.h;iphlpapi.h" HAVE_IPHLAPI) check_cxx_symbol_exists(if_nametoindex "iphlpapi.h" HAVE_IF_NAMETOINDEX) set(CMAKE_REQUIRED_LIBRARIES "") # TODO: This not the symbol we're looking for. What is the symbol? check_library_exists(ws2 fopen "" HAVE_WS2) else() check_cxx_symbol_exists(if_nametoindex net/if.h HAVE_IF_NAMETOINDEX) check_cxx_symbol_exists(SO_PEERCRED sys/socket.h ZMQ_HAVE_SO_PEERCRED) check_cxx_symbol_exists(LOCAL_PEERCRED sys/socket.h ZMQ_HAVE_LOCAL_PEERCRED) check_cxx_symbol_exists(SO_BUSY_POLL sys/socket.h ZMQ_HAVE_BUSY_POLL) endif() if(NOT MINGW) find_library(RT_LIBRARY rt) if(RT_LIBRARY) set(pkg_config_libs_private "${pkg_config_libs_private} -lrt") endif() endif() find_package(Threads) if(WIN32 AND NOT CYGWIN) if(NOT HAVE_WS2_32 AND NOT HAVE_WS2) message(FATAL_ERROR "Cannot link to ws2_32 or ws2") endif() if(NOT HAVE_RPCRT4) message(FATAL_ERROR "Cannot link to rpcrt4") endif() if(NOT HAVE_IPHLAPI) message(FATAL_ERROR "Cannot link to iphlapi") endif() endif() if(NOT MSVC) set(CMAKE_REQUIRED_LIBRARIES rt) check_cxx_symbol_exists(clock_gettime time.h HAVE_CLOCK_GETTIME) set(CMAKE_REQUIRED_LIBRARIES) check_cxx_symbol_exists(fork unistd.h HAVE_FORK) check_cxx_symbol_exists(gethrtime sys/time.h HAVE_GETHRTIME) check_cxx_symbol_exists(mkdtemp stdlib.h HAVE_MKDTEMP) check_cxx_symbol_exists(accept4 sys/socket.h HAVE_ACCEPT4) check_cxx_symbol_exists(strnlen string.h HAVE_STRNLEN) else() set(HAVE_STRNLEN 1) endif() add_definitions(-D_REENTRANT -D_THREAD_SAFE) add_definitions(-DZMQ_CUSTOM_PLATFORM_HPP) option(ENABLE_EVENTFD "Enable/disable eventfd" ZMQ_HAVE_EVENTFD) macro(zmq_check_cxx_flag_prepend flag) check_cxx_compiler_flag("${flag}" HAVE_FLAG_${flag}) if(HAVE_FLAG_${flag}) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${flag}") endif() endmacro() option(ENABLE_ANALYSIS "Build with static analysis(make take very long)" OFF) if(MSVC) if(ENABLE_ANALYSIS) zmq_check_cxx_flag_prepend("/W4") zmq_check_cxx_flag_prepend("/analyze") # C++11/14/17-specific, but maybe possible via conditional defines zmq_check_cxx_flag_prepend("/wd26440") # Function '...' can be declared 'noexcept' zmq_check_cxx_flag_prepend("/wd26432") # If you define or delete any default operation in the type '...', define or # delete them all zmq_check_cxx_flag_prepend("/wd26439") # This kind of function may not throw. Declare it 'noexcept' zmq_check_cxx_flag_prepend("/wd26447") # The function is declared 'noexcept' but calls function '...' which may # throw exceptions zmq_check_cxx_flag_prepend("/wd26433") # Function '...' should be marked with 'override' zmq_check_cxx_flag_prepend("/wd26409") # Avoid calling new and delete explicitly, use std::make_unique instead # Requires GSL zmq_check_cxx_flag_prepend("/wd26429") # Symbol '...' is never tested for nullness, it can be marked as not_null zmq_check_cxx_flag_prepend("/wd26446") # Prefer to use gsl::at() zmq_check_cxx_flag_prepend("/wd26481") # Don't use pointer arithmetic. Use span instead zmq_check_cxx_flag_prepend("/wd26472") # Don't use a static_cast for arithmetic conversions. Use brace # initialization, gsl::narrow_cast or gsl::narow zmq_check_cxx_flag_prepend("/wd26448") # Consider using gsl::finally if final action is intended zmq_check_cxx_flag_prepend("/wd26400") # Do not assign the result of an allocation or a function call with an # owner return value to a raw pointer, use owner instead zmq_check_cxx_flag_prepend("/wd26485") # Expression '...': No array to pointer decay(bounds.3) else() zmq_check_cxx_flag_prepend("/W3") endif() if(MSVC_IDE) set(MSVC_TOOLSET "-${CMAKE_VS_PLATFORM_TOOLSET}") else() set(MSVC_TOOLSET "") endif() else() zmq_check_cxx_flag_prepend("-Wall") endif() if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang") zmq_check_cxx_flag_prepend("-Wextra") endif() option(LIBZMQ_PEDANTIC "" ON) option(LIBZMQ_WERROR "" OFF) # TODO: why is -Wno-long-long defined differently than in configure.ac? if(NOT MSVC) zmq_check_cxx_flag_prepend("-Wno-long-long") zmq_check_cxx_flag_prepend("-Wno-uninitialized") if(LIBZMQ_PEDANTIC) zmq_check_cxx_flag_prepend("-pedantic") if(${CMAKE_CXX_COMPILER_ID} MATCHES "Intel") zmq_check_cxx_flag_prepend("-strict-ansi") endif() if(${CMAKE_CXX_COMPILER_ID} MATCHES "SunPro") zmq_check_cxx_flag_prepend("-compat=5") endif() endif() endif() if(LIBZMQ_WERROR) if(MSVC) zmq_check_cxx_flag_prepend("/WX") else() zmq_check_cxx_flag_prepend("-Werror") if(NOT "${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") zmq_check_cxx_flag_prepend("-errwarn=%all") endif() endif() endif() if(CMAKE_SYSTEM_PROCESSOR MATCHES "^sparc") zmq_check_cxx_flag_prepend("-mcpu=v9") endif() if(${CMAKE_CXX_COMPILER_ID} MATCHES "SunPro") zmq_check_cxx_flag_prepend("-features=zla") endif() if(CMAKE_SYSTEM_NAME MATCHES "SunOS" OR CMAKE_SYSTEM_NAME MATCHES "NetBSD" OR CMAKE_SYSTEM_NAME MATCHES "QNX") message(STATUS "Checking whether atomic operations can be used") check_c_source_compiles( "\ #include \ \ int main() \ { \ uint32_t value; \ atomic_cas_32(&value, 0, 0); \ return 0; \ } \ " HAVE_ATOMIC_H) if(NOT HAVE_ATOMIC_H) set(ZMQ_FORCE_MUTEXES 1) endif() endif() if(NOT ANDROID) zmq_check_noexcept() endif() # ----------------------------------------------------------------------------- if (NOT MSVC) # Compilation checks zmq_check_pthread_setname() zmq_check_pthread_setaffinity() # Execution checks if(NOT CMAKE_CROSSCOMPILING) zmq_check_sock_cloexec() zmq_check_o_cloexec() zmq_check_so_bindtodevice() zmq_check_so_keepalive() zmq_check_so_priority() zmq_check_tcp_keepcnt() zmq_check_tcp_keepidle() zmq_check_tcp_keepintvl() zmq_check_tcp_keepalive() zmq_check_tcp_tipc() zmq_check_getrandom() endif() endif() if(CMAKE_SYSTEM_NAME MATCHES "Linux" OR CMAKE_SYSTEM_NAME MATCHES "GNU/kFreeBSD" OR CMAKE_SYSTEM_NAME MATCHES "GNU/Hurd" OR CYGWIN) add_definitions(-D_GNU_SOURCE) elseif(CMAKE_SYSTEM_NAME MATCHES "FreeBSD") add_definitions(-D__BSD_VISIBLE) elseif(CMAKE_SYSTEM_NAME MATCHES "NetBSD") add_definitions(-D_NETBSD_SOURCE) elseif(CMAKE_SYSTEM_NAME MATCHES "OpenBSD") add_definitions(-D_OPENBSD_SOURCE) elseif(CMAKE_SYSTEM_NAME MATCHES "SunOS") add_definitions(-D_PTHREADS) elseif(CMAKE_SYSTEM_NAME MATCHES "HP-UX") add_definitions(-D_POSIX_C_SOURCE=200112L) zmq_check_cxx_flag_prepend(-Ae) elseif(CMAKE_SYSTEM_NAME MATCHES "Darwin") add_definitions(-D_DARWIN_C_SOURCE) endif() find_package(AsciiDoc) cmake_dependent_option(WITH_DOC "Build Reference Guide documentation(requires DocBook)" ON "ASCIIDOC_FOUND;NOT WIN32" OFF) # Do not build docs on Windows due to issues with symlinks if(MSVC) if(WITH_OPENPGM) # set(OPENPGM_ROOT "" CACHE PATH "Location of OpenPGM") set(OPENPGM_VERSION_MAJOR 5) set(OPENPGM_VERSION_MINOR 2) set(OPENPGM_VERSION_MICRO 122) if(CMAKE_CL_64) find_path( OPENPGM_ROOT include/pgm/pgm.h PATHS "[HKEY_LOCAL_MACHINE\\SOFTWARE\\Miru\\OpenPGM ${OPENPGM_VERSION_MAJOR}.${OPENPGM_VERSION_MINOR}.${OPENPGM_VERSION_MICRO}]" NO_DEFAULT_PATH) message(STATUS "OpenPGM x64 detected - ${OPENPGM_ROOT}") else() find_path( OPENPGM_ROOT include/pgm/pgm.h PATHS "[HKEY_LOCAL_MACHINE\\SOFTWARE\\Wow6432Node\\Miru\\OpenPGM ${OPENPGM_VERSION_MAJOR}.${OPENPGM_VERSION_MINOR}.${OPENPGM_VERSION_MICRO}]" "[HKEY_LOCAL_MACHINE\\SOFTWARE\\Miru\\OpenPGM ${OPENPGM_VERSION_MAJOR}.${OPENPGM_VERSION_MINOR}.${OPENPGM_VERSION_MICRO}]" NO_DEFAULT_PATH) message(STATUS "OpenPGM x86 detected - ${OPENPGM_ROOT}") endif() set(OPENPGM_INCLUDE_DIRS ${OPENPGM_ROOT}/include) set(OPENPGM_LIBRARY_DIRS ${OPENPGM_ROOT}/lib) set(OPENPGM_LIBRARIES optimized libpgm${MSVC_TOOLSET}-mt-${OPENPGM_VERSION_MAJOR}_${OPENPGM_VERSION_MINOR}_${OPENPGM_VERSION_MICRO}.lib debug libpgm${MSVC_TOOLSET}-mt-gd-${OPENPGM_VERSION_MAJOR}_${OPENPGM_VERSION_MINOR}_${OPENPGM_VERSION_MICRO}.lib) endif() else() if(WITH_OPENPGM) # message(FATAL_ERROR "WITH_OPENPGM not implemented") if(NOT OPENPGM_PKGCONFIG_NAME) set(OPENPGM_PKGCONFIG_NAME "openpgm-5.2") endif() set(OPENPGM_PKGCONFIG_NAME ${OPENPGM_PKGCONFIG_NAME} CACHE STRING "Name pkg-config shall use to find openpgm libraries and include paths" FORCE) pkg_check_modules(OPENPGM ${OPENPGM_PKGCONFIG_NAME}) if(OPENPGM_FOUND) message(STATUS ${OPENPGM_PKGCONFIG_NAME}" found") set(pkg_config_names_private "${pkg_config_names_private} ${OPENPGM_PKGCONFIG_NAME}") else() message( FATAL_ERROR ${OPENPGM_PKGCONFIG_NAME}" not found. openpgm is searchd via `pkg-config ${OPENPGM_PKGCONFIG_NAME}`. Consider providing a valid OPENPGM_PKGCONFIG_NAME" ) endif() # DSO symbol visibility for openpgm if(HAVE_FLAG_VISIBILITY_HIDDEN) elseif(HAVE_FLAG_LDSCOPE_HIDDEN) endif() endif() endif() # ----------------------------------------------------------------------------- # force off-tree build if(${CMAKE_CURRENT_SOURCE_DIR} STREQUAL ${CMAKE_CURRENT_BINARY_DIR}) message( FATAL_ERROR "CMake generation is not allowed within the source directory! \ Remove the CMakeCache.txt file and try again from another folder, e.g.: \ \ rm CMakeCache.txt \ mkdir cmake-make \ cd cmake-make \ cmake ..") endif() # ----------------------------------------------------------------------------- # default to Release build if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) # CMAKE_BUILD_TYPE is not used for multi-configuration generators like Visual Studio/XCode which instead use # CMAKE_CONFIGURATION_TYPES set(CMAKE_BUILD_TYPE Release CACHE STRING "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel." FORCE) endif() # ----------------------------------------------------------------------------- # output directories zmq_set_with_default(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${ZeroMQ_BINARY_DIR}/bin") if(UNIX) set(zmq_library_directory "lib") else() set(zmq_library_directory "bin") endif() zmq_set_with_default(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${ZeroMQ_BINARY_DIR}/${zmq_library_directory}") zmq_set_with_default(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${ZeroMQ_BINARY_DIR}/lib") # ----------------------------------------------------------------------------- # platform specifics if(WIN32) # Socket limit is 16K(can be raised arbitrarily) add_definitions(-DFD_SETSIZE=16384) add_definitions(-D_CRT_SECURE_NO_WARNINGS) add_definitions(-D_WINSOCK_DEPRECATED_NO_WARNINGS) endif() if(MSVC) # Parallel make. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /MP") set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /MP") # Compile the static lib with debug information included note: we assume here that the default flags contain some /Z # flag string(REGEX REPLACE "/Z.[^:]" "/Z7 " CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}") string(REGEX REPLACE "/Z.[^:]" "/Z7 " CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO}") endif() # ----------------------------------------------------------------------------- # source files set(cxx-sources precompiled.cpp address.cpp channel.cpp client.cpp clock.cpp ctx.cpp curve_mechanism_base.cpp curve_client.cpp curve_server.cpp dealer.cpp devpoll.cpp dgram.cpp dist.cpp endpoint.cpp epoll.cpp err.cpp fq.cpp io_object.cpp io_thread.cpp ip.cpp ipc_address.cpp ipc_connecter.cpp ipc_listener.cpp kqueue.cpp lb.cpp mailbox.cpp mailbox_safe.cpp mechanism.cpp mechanism_base.cpp metadata.cpp msg.cpp mtrie.cpp norm_engine.cpp object.cpp options.cpp own.cpp null_mechanism.cpp pair.cpp peer.cpp pgm_receiver.cpp pgm_sender.cpp pgm_socket.cpp pipe.cpp plain_client.cpp plain_server.cpp poll.cpp poller_base.cpp polling_util.cpp pollset.cpp proxy.cpp pub.cpp pull.cpp push.cpp random.cpp raw_encoder.cpp raw_decoder.cpp raw_engine.cpp reaper.cpp rep.cpp req.cpp router.cpp select.cpp server.cpp session_base.cpp signaler.cpp socket_base.cpp socks.cpp socks_connecter.cpp stream.cpp stream_engine_base.cpp sub.cpp tcp.cpp tcp_address.cpp tcp_connecter.cpp tcp_listener.cpp thread.cpp trie.cpp radix_tree.cpp v1_decoder.cpp v1_encoder.cpp v2_decoder.cpp v2_encoder.cpp v3_1_encoder.cpp xpub.cpp xsub.cpp zmq.cpp zmq_utils.cpp decoder_allocators.cpp socket_poller.cpp timers.cpp config.hpp radio.cpp dish.cpp udp_engine.cpp udp_address.cpp scatter.cpp gather.cpp ip_resolver.cpp zap_client.cpp zmtp_engine.cpp # at least for VS, the header files must also be listed address.hpp array.hpp atomic_counter.hpp atomic_ptr.hpp blob.hpp channel.hpp client.hpp clock.hpp command.hpp compat.hpp condition_variable.hpp config.hpp ctx.hpp curve_client.hpp curve_client_tools.hpp curve_mechanism_base.hpp curve_server.hpp dbuffer.hpp dealer.hpp decoder.hpp decoder_allocators.hpp devpoll.hpp dgram.hpp dish.hpp dist.hpp encoder.hpp endpoint.hpp epoll.hpp err.hpp fd.hpp fq.hpp gather.hpp generic_mtrie.hpp generic_mtrie_impl.hpp gssapi_client.hpp gssapi_mechanism_base.hpp gssapi_server.hpp i_decoder.hpp i_encoder.hpp i_engine.hpp i_mailbox.hpp i_poll_events.hpp io_object.hpp io_thread.hpp ip.hpp ipc_address.hpp ipc_connecter.hpp ipc_listener.hpp kqueue.hpp lb.hpp likely.hpp macros.hpp mailbox.hpp mailbox_safe.hpp mechanism.hpp mechanism_base.hpp metadata.hpp msg.hpp mtrie.hpp mutex.hpp norm_engine.hpp null_mechanism.hpp object.hpp options.hpp own.hpp pair.hpp peer.hpp pgm_receiver.hpp pgm_sender.hpp pgm_socket.hpp pipe.hpp plain_client.hpp plain_common.hpp plain_server.hpp poll.hpp poller.hpp poller_base.hpp polling_util.hpp pollset.hpp precompiled.hpp proxy.hpp pub.hpp pull.hpp push.hpp radio.hpp random.hpp raw_decoder.hpp raw_encoder.hpp raw_engine.hpp reaper.hpp rep.hpp req.hpp router.hpp scatter.hpp secure_allocator.hpp select.hpp server.hpp session_base.hpp signaler.hpp socket_base.hpp socket_poller.hpp socks.hpp socks_connecter.hpp stdint.hpp stream.hpp stream_engine_base.hpp stream_connecter_base.hpp stream_connecter_base.cpp stream_listener_base.hpp stream_listener_base.cpp sub.hpp tcp.hpp tcp_address.hpp tcp_connecter.hpp tcp_listener.hpp thread.hpp timers.hpp tipc_address.hpp tipc_connecter.hpp tipc_listener.hpp trie.hpp udp_address.hpp udp_engine.hpp v1_decoder.hpp v1_encoder.hpp v2_decoder.hpp v2_encoder.hpp v3_1_encoder.hpp v2_protocol.hpp vmci.hpp vmci_address.hpp vmci_connecter.hpp vmci_listener.hpp windows.hpp wire.hpp xpub.hpp xsub.hpp ypipe.hpp ypipe_base.hpp ypipe_conflate.hpp yqueue.hpp zap_client.hpp zmtp_engine.hpp) if(MINGW) # Generate the right type when using -m32 or -m64 macro(set_rc_arch rc_target) set(CMAKE_RC_COMPILER_INIT windres) enable_language(RC) set(CMAKE_RC_COMPILE_OBJECT " -O coff --target=${rc_target} -i -o ") endmacro() if(NOT CMAKE_SYSTEM_PROCESSOR) set(CMAKE_SYSTEM_PROCESSOR ${CMAKE_HOST_SYSTEM_PROCESSOR}) endif() # Also happens on x86_64 systems...what a worthless variable if(CMAKE_SYSTEM_PROCESSOR MATCHES "i386" OR CMAKE_SYSTEM_PROCESSOR MATCHES "i486" OR CMAKE_SYSTEM_PROCESSOR MATCHES "i586" OR CMAKE_SYSTEM_PROCESSOR MATCHES "i686" OR CMAKE_SYSTEM_PROCESSOR MATCHES "x86" OR CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64" OR CMAKE_SYSTEM_PROCESSOR MATCHES "amd64") if(CMAKE_SIZEOF_VOID_P EQUAL 8) set_rc_arch("pe-x86-64") else() set_rc_arch("pe-i386") endif() endif() endif() set(public_headers include/zmq.h include/zmq_utils.h) set(readme-docs AUTHORS LICENSE NEWS) # ----------------------------------------------------------------------------- # optional modules if(WITH_OPENPGM) message(STATUS "Building with OpenPGM") set(ZMQ_HAVE_OPENPGM 1) include_directories(${OPENPGM_INCLUDE_DIRS}) link_directories(${OPENPGM_LIBRARY_DIRS}) set(OPTIONAL_LIBRARIES ${OPENPGM_LIBRARIES}) endif() if(WITH_NORM) find_package(norm) if(norm_FOUND) message(STATUS "Building with NORM") set(ZMQ_HAVE_NORM 1) else() message(FATAL_ERROR "NORM not found") endif() endif() if(WITH_VMCI) message(STATUS "Building with VMCI") set(ZMQ_HAVE_VMCI 1) include_directories(${VMCI_INCLUDE_DIRS}) list(APPEND cxx-sources vmci_address.cpp vmci_connecter.cpp vmci_listener.cpp vmci.cpp) endif() if(ZMQ_HAVE_TIPC) list(APPEND cxx-sources tipc_address.cpp tipc_connecter.cpp tipc_listener.cpp) endif() # ----------------------------------------------------------------------------- # source generators foreach(source ${cxx-sources}) list(APPEND sources ${CMAKE_CURRENT_SOURCE_DIR}/src/${source}) endforeach() configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/version.rc.in ${CMAKE_CURRENT_BINARY_DIR}/version.rc) # Delete any src/platform.hpp left by configure file(REMOVE ${CMAKE_CURRENT_SOURCE_DIR}/src/platform.hpp) configure_file(${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/platform.hpp.in ${CMAKE_CURRENT_BINARY_DIR}/platform.hpp) list(APPEND sources ${CMAKE_CURRENT_BINARY_DIR}/platform.hpp) set(prefix ${CMAKE_INSTALL_PREFIX}) set(exec_prefix ${prefix}) set(libdir ${prefix}/${CMAKE_INSTALL_LIBDIR}) set(includedir ${prefix}/${CMAKE_INSTALL_INCLUDEDIR}) set(VERSION ${ZMQ_VERSION_MAJOR}.${ZMQ_VERSION_MINOR}.${ZMQ_VERSION_PATCH}) configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/libzmq.pc.in ${CMAKE_CURRENT_BINARY_DIR}/libzmq.pc @ONLY) set(zmq-pkgconfig ${CMAKE_CURRENT_BINARY_DIR}/libzmq.pc) if(NOT ZMQ_BUILD_FRAMEWORK) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/libzmq.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig) endif() if(MSVC) if(CMAKE_CL_64) set(nsis-template ${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/NSIS.template64.in) else() set(nsis-template ${CMAKE_CURRENT_SOURCE_DIR}/builds/cmake/NSIS.template32.in) endif() add_custom_command( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/NSIS.template.in COMMAND ${CMAKE_COMMAND} ARGS -E copy ${nsis-template} ${CMAKE_CURRENT_BINARY_DIR}/NSIS.template.in DEPENDS ${nsis-template}) endif() option(WITH_DOCS "Build html docs" ON) if(WITH_DOCS) file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc) file( GLOB docs RELATIVE ${CMAKE_CURRENT_BINARY_DIR}/ "${CMAKE_CURRENT_SOURCE_DIR}/doc/*.txt") set(html-docs) foreach(txt ${docs}) string(REGEX REPLACE ".*/(.*)\\.txt" "\\1.html" html ${txt}) set(src ${txt}) set(dst doc/${html}) if(WITH_DOC) add_custom_command( OUTPUT ${dst} COMMAND ${ASCIIDOC_EXECUTABLE} -d manpage -b xhtml11 -f ${CMAKE_CURRENT_SOURCE_DIR}/doc/asciidoc.conf -azmq_version=${ZMQ_VERSION} -o ${dst} ${src} DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${src} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating ${html}") list(APPEND html-docs ${CMAKE_CURRENT_BINARY_DIR}/${dst}) endif() endforeach() endif() if(ZMQ_BUILD_FRAMEWORK) add_custom_command( TARGET libzmq POST_BUILD COMMAND ${CMAKE_COMMAND} ARGS -E make_directory "${CMAKE_LIBRARY_OUTPUT_PATH}/ZeroMQ.framework/Versions/${ZMQ_VERSION}/MacOS" COMMENT "Perf tools") endif() option(ENABLE_PRECOMPILED "Enable precompiled headers, if possible" ON) if(MSVC AND ENABLE_PRECOMPILED) # default for all sources is to use precompiled headers foreach(source ${sources}) # C and C++ can not use the same precompiled header if(${source} MATCHES ".cpp$" AND NOT ${source} STREQUAL "${CMAKE_CURRENT_SOURCE_DIR}/src/precompiled.cpp") set_source_files_properties(${source} PROPERTIES COMPILE_FLAGS "/Yuprecompiled.hpp" OBJECT_DEPENDS precompiled.hpp) endif() endforeach() # create precompiled header set_source_files_properties(${CMAKE_CURRENT_SOURCE_DIR}/src/precompiled.cpp PROPERTIES COMPILE_FLAGS "/Ycprecompiled.hpp" OBJECT_OUTPUTS precompiled.hpp) endif() # ----------------------------------------------------------------------------- # output option(BUILD_SHARED "Whether or not to build the shared object" ON) option(BUILD_STATIC "Whether or not to build the static archive" ON) if(MSVC) # Suppress linker warnings caused by #ifdef omission of file content. set(CMAKE_STATIC_LINKER_FLAGS "${CMAKE_STATIC_LINKER_FLAGS} /ignore:4221") set(PDB_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/bin") set(PDB_NAME "lib${ZMQ_OUTPUT_BASENAME}${MSVC_TOOLSET}-mt-gd-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}") function(enable_vs_guideline_checker target) set_target_properties( ${target} PROPERTIES VS_GLOBAL_EnableCppCoreCheck true VS_GLOBAL_CodeAnalysisRuleSet CppCoreCheckRules.ruleset VS_GLOBAL_RunCodeAnalysis true) endfunction() if(BUILD_SHARED) # Whole Program Optimization flags. http://msdn.microsoft.com/en-us/magazine/cc301698.aspx # # "Finally, there's the subject of libraries. It's possible to create .LIB # files with code in its IL form. The linker will happily work with these # .LIB files. Be aware that these libraries will be tied to a specific # version of the compiler and linker. If you distribute these libraries, # you'll need to update them if Microsoft changes the format of IL in a # future release." # # /GL and /LTCG can cause problems when libraries built with different # versions of compiler are later linked into an executable while /LTCG is active. # https://social.msdn.microsoft.com/Forums/vstudio/en-US/5c102025-c254-4f02-9a51-c775c6cc9f4b/problem-with-ltcg-when-building-a-static-library-in-vs2005?forum=vcgeneral # # For this reason, enable only when building a "Release" (e.g. non-DEBUG) DLL. if(NOT ${CMAKE_BUILD_TYPE} MATCHES "Debug") set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /GL") set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} /LTCG") set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} /LTCG") set(CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} /LTCG") endif() add_library(libzmq SHARED ${sources} ${public_headers} ${html-docs} ${readme-docs} ${CMAKE_CURRENT_BINARY_DIR}/NSIS.template.in ${CMAKE_CURRENT_BINARY_DIR}/version.rc) if(ENABLE_ANALYSIS) enable_vs_guideline_checker(libzmq) endif() set_target_properties( libzmq PROPERTIES PUBLIC_HEADER "${public_headers}" RELEASE_POSTFIX "${MSVC_TOOLSET}-mt-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" RELWITHDEBINFO_POSTFIX "${MSVC_TOOLSET}-mt-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" MINSIZEREL_POSTFIX "${MSVC_TOOLSET}-mt-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" DEBUG_POSTFIX "${MSVC_TOOLSET}-mt-gd-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" RUNTIME_OUTPUT_DIRECTORY "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}" COMPILE_DEFINITIONS "DLL_EXPORT" OUTPUT_NAME "lib${ZMQ_OUTPUT_BASENAME}") if(ZMQ_HAVE_WINDOWS_UWP) set_target_properties(libzmq PROPERTIES LINK_FLAGS_DEBUG "/OPT:NOICF /OPT:NOREF") endif() endif() if(BUILD_STATIC) add_library(libzmq-static STATIC ${sources} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) set_target_properties( libzmq-static PROPERTIES PUBLIC_HEADER "${public_headers}" RELEASE_POSTFIX "${MSVC_TOOLSET}-mt-s-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" RELWITHDEBINFO_POSTFIX "${MSVC_TOOLSET}-mt-s-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" MINSIZEREL_POSTFIX "${MSVC_TOOLSET}-mt-s-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" DEBUG_POSTFIX "${MSVC_TOOLSET}-mt-sgd-${ZMQ_VERSION_MAJOR}_${ZMQ_VERSION_MINOR}_${ZMQ_VERSION_PATCH}" COMPILE_FLAGS "/DZMQ_STATIC" OUTPUT_NAME "lib${ZMQ_OUTPUT_BASENAME}") endif() else() # avoid building everything twice for shared + static only on *nix, as Windows needs different preprocessor defines in # static builds if(NOT MINGW) add_library(objects OBJECT ${sources}) set_property(TARGET objects PROPERTY POSITION_INDEPENDENT_CODE ON) if(GNUTLS_FOUND) target_include_directories(objects PRIVATE "${GNUTLS_INCLUDE_DIR}") endif() endif() if(BUILD_SHARED) if(MINGW) add_library(libzmq SHARED ${sources} ${public_headers} ${html-docs} ${readme-docs} ${zmq-pkgconfig} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) else() if (CMAKE_GENERATOR STREQUAL "Xcode") add_library(libzmq SHARED ${sources} ${public_headers} ${html-docs} ${readme-docs} ${zmq-pkgconfig} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) else() add_library(libzmq SHARED $ ${public_headers} ${html-docs} ${readme-docs} ${zmq-pkgconfig} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) endif() endif() # NOTE: the SOVERSION and VERSION MUST be the same as the one generated by libtool! It is NOT the same as the # version of the package. set_target_properties( libzmq PROPERTIES COMPILE_DEFINITIONS "DLL_EXPORT" PUBLIC_HEADER "${public_headers}" VERSION "5.2.5" SOVERSION "5" OUTPUT_NAME "${ZMQ_OUTPUT_BASENAME}" PREFIX "lib") if(ZMQ_BUILD_FRAMEWORK) set_target_properties( libzmq PROPERTIES FRAMEWORK TRUE MACOSX_FRAMEWORK_IDENTIFIER "org.zeromq.libzmq" MACOSX_FRAMEWORK_SHORT_VERSION_STRING ${ZMQ_VERSION} MACOSX_FRAMEWORK_BUNDLE_VERSION ${ZMQ_VERSION}) set_source_files_properties(${html-docs} PROPERTIES MACOSX_PACKAGE_LOCATION doc) set_source_files_properties(${readme-docs} PROPERTIES MACOSX_PACKAGE_LOCATION etc) set_source_files_properties(${zmq-pkgconfig} PROPERTIES MACOSX_PACKAGE_LOCATION lib/pkgconfig) endif() endif() if(BUILD_STATIC) if(MINGW) add_library(libzmq-static STATIC ${sources} ${public_headers} ${html-docs} ${readme-docs} ${zmq-pkgconfig} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) else() if (CMAKE_GENERATOR STREQUAL "Xcode") add_library(libzmq-static STATIC ${sources} ${public_headers} ${html-docs} ${readme-docs} ${zmq-pkgconfig} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) else() add_library(libzmq-static STATIC $ ${public_headers} ${html-docs} ${readme-docs} ${zmq-pkgconfig} ${CMAKE_CURRENT_BINARY_DIR}/version.rc) endif() endif() if(CMAKE_SYSTEM_NAME MATCHES "QNX") target_link_libraries(libzmq-static m) endif() set_target_properties( libzmq-static PROPERTIES PUBLIC_HEADER "${public_headers}" OUTPUT_NAME "${ZMQ_OUTPUT_BASENAME}" PREFIX "lib") endif() endif() if(BUILD_STATIC) target_compile_definitions(libzmq-static PUBLIC ZMQ_STATIC) endif() list(APPEND target_outputs "") if(BUILD_SHARED) list(APPEND target_outputs "libzmq") endif() if(BUILD_STATIC) list(APPEND target_outputs "libzmq-static") endif() set(build_targets ${target_outputs}) if(TARGET objects) list(APPEND build_targets "objects") endif() foreach(target ${build_targets}) target_include_directories( ${target} PUBLIC $ $ $) if(ENABLE_DRAFTS) target_compile_definitions(${target} PUBLIC ZMQ_BUILD_DRAFT_API) endif() endforeach() if(BUILD_SHARED) target_link_libraries(libzmq ${CMAKE_THREAD_LIBS_INIT}) if(QNX) target_link_libraries(libzmq -lsocket) endif() if(GNUTLS_FOUND) target_link_libraries(libzmq ${GNUTLS_LIBRARIES}) target_include_directories(libzmq PRIVATE "${GNUTLS_INCLUDE_DIR}") endif() if(NSS3_FOUND) target_link_libraries(libzmq ${NSS3_LIBRARIES}) endif() if(LIBBSD_FOUND) target_link_libraries(libzmq ${LIBBSD_LIBRARIES}) endif() if(SODIUM_FOUND) target_link_libraries(libzmq ${SODIUM_LIBRARIES}) # On Solaris, libsodium depends on libssp if(${CMAKE_SYSTEM_NAME} MATCHES "SunOS") target_link_libraries(libzmq ssp) endif() endif() if(HAVE_WS2_32) target_link_libraries(libzmq ws2_32) elseif(HAVE_WS2) target_link_libraries(libzmq ws2) endif() if(HAVE_RPCRT4) target_link_libraries(libzmq rpcrt4) endif() if(HAVE_IPHLAPI) target_link_libraries(libzmq iphlpapi) endif() if(RT_LIBRARY) target_link_libraries(libzmq -lrt) endif() if(norm_FOUND) target_link_libraries(libzmq norm::norm) endif() if(OPENPGM_FOUND) target_link_libraries(libzmq ${OPENPGM_LIBRARIES}) endif() endif() if(BUILD_STATIC) target_link_libraries(libzmq-static ${CMAKE_THREAD_LIBS_INIT}) if(GNUTLS_FOUND) target_link_libraries(libzmq-static ${GNUTLS_LIBRARIES}) target_include_directories(libzmq-static PRIVATE "${GNUTLS_INCLUDE_DIR}") endif() if(LIBBSD_FOUND) target_link_libraries(libzmq-static ${LIBBSD_LIBRARIES}) endif() if(NSS3_FOUND) target_link_libraries(libzmq-static ${NSS3_LIBRARIES}) endif() if(SODIUM_FOUND) target_link_libraries(libzmq-static ${SODIUM_LIBRARIES}) # On Solaris, libsodium depends on libssp if(${CMAKE_SYSTEM_NAME} MATCHES "SunOS") target_link_libraries(libzmq-static ssp) endif() endif() if(HAVE_WS2_32) target_link_libraries(libzmq-static ws2_32) elseif(HAVE_WS2) target_link_libraries(libzmq-static ws2) endif() if(HAVE_RPCRT4) target_link_libraries(libzmq-static rpcrt4) endif() if(HAVE_IPHLAPI) target_link_libraries(libzmq-static iphlpapi) endif() if(RT_LIBRARY) target_link_libraries(libzmq-static -lrt) endif() if(CMAKE_SYSTEM_NAME MATCHES "QNX") add_definitions(-DUNITY_EXCLUDE_MATH_H) endif() if(norm_FOUND) target_link_libraries(libzmq-static norm::norm) endif() if(OPENPGM_FOUND) target_link_libraries(libzmq-static ${OPENPGM_LIBRARIES}) endif() endif() if(BUILD_SHARED) set(perf-tools local_lat remote_lat local_thr remote_thr inproc_lat inproc_thr proxy_thr) if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug") # Why? option(WITH_PERF_TOOL "Build with perf-tools" ON) else() option(WITH_PERF_TOOL "Build with perf-tools" OFF) endif() if(WITH_PERF_TOOL) foreach(perf-tool ${perf-tools}) add_executable(${perf-tool} perf/${perf-tool}.cpp) target_link_libraries(${perf-tool} libzmq) if(GNUTLS_FOUND) target_link_libraries(${perf-tool} ${GNUTLS_LIBRARIES}) target_include_directories(${perf-tool} PRIVATE "${GNUTLS_INCLUDE_DIR}") endif() if(LIBBSD_FOUND) target_link_libraries(${perf-tool} ${LIBBSD_LIBRARIES}) endif() if(NSS3_FOUND) target_link_libraries(${perf-tool} ${NSS3_LIBRARIES}) endif() if(SODIUM_FOUND) target_link_libraries(${perf-tool} ${SODIUM_LIBRARIES}) endif() if(ZMQ_BUILD_FRAMEWORK) # Copy perf-tools binaries into Framework add_custom_command( TARGET libzmq ${perf-tool} POST_BUILD COMMAND ${CMAKE_COMMAND} ARGS -E copy "$" "${LIBRARY_OUTPUT_PATH}/ZeroMQ.framework/Versions/${ZMQ_VERSION_STRING}/MacOS/${perf-tool}" VERBATIM COMMENT "Perf tools") else() install(TARGETS ${perf-tool} RUNTIME DESTINATION bin COMPONENT PerfTools) endif() if(ZMQ_HAVE_WINDOWS_UWP) set_target_properties(${perf-tool} PROPERTIES LINK_FLAGS_DEBUG "/OPT:NOICF /OPT:NOREF") endif() endforeach() if(BUILD_STATIC) add_executable(benchmark_radix_tree perf/benchmark_radix_tree.cpp) target_link_libraries(benchmark_radix_tree libzmq-static) target_include_directories(benchmark_radix_tree PUBLIC "${CMAKE_CURRENT_LIST_DIR}/src") if(ZMQ_HAVE_WINDOWS_UWP) set_target_properties(benchmark_radix_tree PROPERTIES LINK_FLAGS_DEBUG "/OPT:NOICF /OPT:NOREF") endif() endif() elseif(WITH_PERF_TOOL) message(FATAL_ERROR "Shared library disabled - perf-tools unavailable.") endif() endif() # ----------------------------------------------------------------------------- # tests if(${CMAKE_VERSION} VERSION_LESS 3.12.3) option(BUILD_TESTS "Whether or not to build the tests" OFF) else() option(BUILD_TESTS "Whether or not to build the tests" ON) endif() set(ZMQ_BUILD_TESTS ${BUILD_TESTS} CACHE BOOL "Build the tests for ZeroMQ") if(ZMQ_BUILD_TESTS) enable_testing() # Enable testing only works in root scope add_subdirectory(tests) if(BUILD_STATIC) add_subdirectory(unittests) else() message(WARNING "Not building unit tests, since BUILD_STATIC is not enabled") endif() endif() # ----------------------------------------------------------------------------- # installer if(MSVC AND (BUILD_SHARED OR BUILD_STATIC)) install( TARGETS ${target_outputs} EXPORT ${PROJECT_NAME}-targets ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} COMPONENT SDK) if(MSVC_IDE) install( FILES ${PDB_OUTPUT_DIRECTORY}/\${CMAKE_INSTALL_CONFIG_NAME}/${PDB_NAME}.pdb DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT SDK OPTIONAL) else() install( FILES ${PDB_OUTPUT_DIRECTORY}/${PDB_NAME}.pdb DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT SDK OPTIONAL) endif() if(BUILD_SHARED) install( TARGETS libzmq RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} COMPONENT Runtime) endif() elseif(BUILD_SHARED OR BUILD_STATIC) install( TARGETS ${target_outputs} EXPORT ${PROJECT_NAME}-targets RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} FRAMEWORK DESTINATION "Library/Frameworks" PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) endif() foreach(readme ${readme-docs}) configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${readme} ${CMAKE_CURRENT_BINARY_DIR}/${readme}.txt) if(NOT ZMQ_BUILD_FRAMEWORK) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${readme}.txt DESTINATION share/zmq) endif() endforeach() if(WITH_DOC) if(NOT ZMQ_BUILD_FRAMEWORK) install( FILES ${html-docs} DESTINATION doc/zmq COMPONENT RefGuide) endif() endif() if(WIN32) set(ZEROMQ_CMAKECONFIG_INSTALL_DIR "CMake" CACHE STRING "install path for ZeroMQConfig.cmake") else() # CMake search path wants either "share" (AKA GNUInstallDirs DATAROOTDIR) for arch-independent, or LIBDIR for arch- # dependent, plus "cmake" as prefix set(ZEROMQ_CMAKECONFIG_INSTALL_DIR "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}" CACHE STRING "install path for ZeroMQConfig.cmake") endif() if((NOT CMAKE_VERSION VERSION_LESS 3.0) AND (BUILD_SHARED OR BUILD_STATIC)) export(EXPORT ${PROJECT_NAME}-targets FILE "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Targets.cmake") endif() configure_package_config_file( builds/cmake/${PROJECT_NAME}Config.cmake.in "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake" INSTALL_DESTINATION ${ZEROMQ_CMAKECONFIG_INSTALL_DIR}) write_basic_package_version_file( ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake VERSION ${ZMQ_VERSION_MAJOR}.${ZMQ_VERSION_MINOR}.${ZMQ_VERSION_PATCH} COMPATIBILITY AnyNewerVersion) if(BUILD_SHARED OR BUILD_STATIC) install( EXPORT ${PROJECT_NAME}-targets FILE ${PROJECT_NAME}Targets.cmake DESTINATION ${ZEROMQ_CMAKECONFIG_INSTALL_DIR}) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake DESTINATION ${ZEROMQ_CMAKECONFIG_INSTALL_DIR}) endif() option(ENABLE_CPACK "Enables cpack rules" ON) if(MSVC AND ENABLE_CPACK) if(${CMAKE_BUILD_TYPE} MATCHES "Debug") set(CMAKE_INSTALL_DEBUG_LIBRARIES_ONLY TRUE) set(CMAKE_INSTALL_DEBUG_LIBRARIES TRUE) set(CMAKE_INSTALL_UCRT_LIBRARIES TRUE) endif() include(InstallRequiredSystemLibraries) if(CMAKE_CL_64) set(arch_name "x64") else() set(arch_name "x86") endif() set(CPACK_NSIS_DISPLAY_NAME "ZeroMQ ${ZMQ_VERSION_MAJOR}.${ZMQ_VERSION_MINOR}.${ZMQ_VERSION_PATCH}(${arch_name})") set(CPACK_PACKAGE_FILE_NAME "ZeroMQ-${ZMQ_VERSION_MAJOR}.${ZMQ_VERSION_MINOR}.${ZMQ_VERSION_PATCH}-${arch_name}") # TODO: I think this part was intended to be used when running cpack separately from cmake but I don't know how that # works. # # macro(add_crt_version version) set(rel_dir # "${CMAKE_CURRENT_BINARY_DIR}/build/${arch_name}/${version};ZeroMQ;ALL;/") # set(debug_dir # "${CMAKE_CURRENT_BINARY_DIR}/debug/${arch_name}/${version};ZeroMQ;ALL;/") # if(EXISTS ${rel_dir}) list(APPEND CPACK_INSTALL_CMAKE_PROJECTS ${rel_dir}) endif() # if(EXISTS ${debug_dir}) list(APPEND CPACK_INSTALL_CMAKE_PROJECTS ${rel_dir}) endmacro() endmacro() # add_crt_version(v110) add_crt_version(v100) add_crt_version(v90) list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_BINARY_DIR}) set(CPACK_GENERATOR "NSIS") set(CPACK_PACKAGE_NAME "ZeroMQ") set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "ZeroMQ lightweight messaging kernel") set(CPACK_PACKAGE_VENDOR "Miru") set(CPACK_NSIS_CONTACT "Steven McCoy ") set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_BINARY_DIR}\\\\LICENSE.txt") # set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_BINARY_DIR}\\\\README.txt") set(CPACK_RESOURCE_FILE_WELCOME # "${CMAKE_CURRENT_BINARY_DIR}\\\\WELCOME.txt") There is a bug in NSI that does not handle full unix paths properly. # Make sure there is at least one set of four(4) backslashes. set(CPACK_NSIS_MUI_ICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\installer.ico") set(CPACK_NSIS_MUI_UNIICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\installer.ico") set(CPACK_PACKAGE_ICON "${CMAKE_CURRENT_SOURCE_DIR}\\\\branding.bmp") set(CPACK_NSIS_COMPRESSOR "/SOLID lzma") set(CPACK_PACKAGE_VERSION ${ZMQ_VERSION}) set(CPACK_PACKAGE_VERSION_MAJOR ${ZMQ_VERSION_MAJOR}) set(CPACK_PACKAGE_VERSION_MINOR ${ZMQ_VERSION_MINOR}) set(CPACK_PACKAGE_VERSION_PATCH ${ZMQ_VERSION_PATCH}) # set(CPACK_PACKAGE_INSTALL_DIRECTORY "ZMQ Install Directory") set(CPACK_TEMPORARY_DIRECTORY "ZMQ Temporary CPack # Directory") include(CPack) cpack_add_component_group(Development DISPLAY_NAME "ZeroMQ software development kit" EXPANDED) cpack_add_component(PerfTools DISPLAY_NAME "ZeroMQ performance tools" INSTALL_TYPES FullInstall DevInstall) cpack_add_component(SourceCode DISPLAY_NAME "ZeroMQ source code" DISABLED INSTALL_TYPES FullInstall) cpack_add_component( SDK DISPLAY_NAME "ZeroMQ headers and libraries" INSTALL_TYPES FullInstall DevInstall GROUP Development) if(WITH_DOC) cpack_add_component( RefGuide DISPLAY_NAME "ZeroMQ reference guide" INSTALL_TYPES FullInstall DevInstall GROUP Development) endif() cpack_add_component( Runtime DISPLAY_NAME "ZeroMQ runtime files" REQUIRED INSTALL_TYPES FullInstall DevInstall MinInstall) cpack_add_install_type(FullInstall DISPLAY_NAME "Full install, including source code") cpack_add_install_type(DevInstall DISPLAY_NAME "Developer install, headers and libraries") cpack_add_install_type(MinInstall DISPLAY_NAME "Minimal install, runtime only") endif() # Export this for library to help build this as a sub-project set(ZEROMQ_LIBRARY libzmq CACHE STRING "ZeroMQ library") # Workaround for MSVS10 to avoid the Dialog Hell FIXME: This could be removed with future version of CMake. if(MSVC_VERSION EQUAL 1600) set(ZMQ_SLN_FILENAME "${CMAKE_CURRENT_BINARY_DIR}/ZeroMQ.sln") if(EXISTS "${ZMQ_SLN_FILENAME}") file(APPEND "${ZMQ_SLN_FILENAME}" "\n# This should be regenerated!\n") endif() endif() # this cannot be moved, as it does not only contain function/macro definitions option(ENABLE_CLANG "Include Clang" ON) if (ENABLE_CLANG) include(ClangFormat) endif() # fixes https://github.com/zeromq/libzmq/issues/3776 The problem is, both libzmq-static libzmq try to use/generate # precompiled.pch at the same time Add a dependency, so they run in order and so they dont get in each others way TODO # still generates warning "build\x64-Debug\ninja : warning : multiple rules generate precompiled.hpp. builds involving # this target will not be correct; continuing anyway [-w dupbuild=warn]" if(MSVC AND ENABLE_PRECOMPILED AND BUILD_SHARED AND BUILD_STATIC) add_dependencies(libzmq-static libzmq) endif() option(ENABLE_NO_EXPORT "Build with empty ZMQ_EXPORT macro, bypassing platform-based automated detection" OFF) if(ENABLE_NO_EXPORT) message(STATUS "Building with empty ZMQ_EXPORT macro") add_definitions(-DZMQ_NO_EXPORT) endif() libzmq-4.3.5/Dockerfile000066400000000000000000000016651451075505100150260ustar00rootroot00000000000000FROM debian:buster-slim AS builder LABEL maintainer="ZeroMQ Project " ARG DEBIAN_FRONTEND=noninteractive RUN apt-get update -qq \ && apt-get install -qq --yes --no-install-recommends \ autoconf \ automake \ build-essential \ git \ libkrb5-dev \ libsodium-dev \ libtool \ pkg-config \ && rm -rf /var/lib/apt/lists/* WORKDIR /opt/libzmq COPY . . RUN ./autogen.sh \ && ./configure --prefix=/usr/local --with-libsodium --with-libgssapi_krb5 \ && make \ && make check \ && make install FROM debian:buster-slim LABEL maintainer="ZeroMQ Project " ARG DEBIAN_FRONTEND=noninteractive RUN apt-get update -qq \ && apt-get install -qq --yes --no-install-recommends \ libkrb5-dev \ libsodium23 \ && rm -rf /var/lib/apt/lists/* COPY --from=builder /usr/local /usr/local RUN ldconfig && ldconfig -p | grep libzmq libzmq-4.3.5/Doxygen.cfg000066400000000000000000003055721451075505100151360ustar00rootroot00000000000000# Doxyfile 1.8.11 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv # for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = libzmq # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = master # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "ZeroMQ C++ Core Engine (LIBZMQ)" PROJECT_LOGO = branding.bmp # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = doxygen # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = YES # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = NO # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = ../.. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO JAVADOC_AUTOBRIEF = NO QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = YES # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = YES # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = YES # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = YES # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = NO # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = NO # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = include \ src \ tests \ perf \ README.doxygen.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. FILE_PATTERNS = *.c \ *.cpp \ *.h \ *.hpp # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = tests perf # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = YES # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = README.doxygen.md #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = NO # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = YES # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see http://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 4 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. # HTML_HEADER = doxygen.header # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. # HTML_FOOTER = doxygen.footer # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. # HTML_STYLESHEET = doxygen.css # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. # HTML_COLORSTYLE_HUE = 240 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. #HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. #HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: http://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 200 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /