--- /dev/null
--- /dev/null
++julia (0.3.12-1) unstable; urgency=medium
++
++ Starting with this release, the dynamic library loader only
++ considers files with a .so extension when given a library name
++ without an extension. With previous releases, the loader would
++ fall back to files with a .so.VERSION extension, which could
++ result in undefined behaviour when multiple versions of the
++ same library were installed.
++
++ Before you install an external Julia package using Pkg.add() that
++ depends on a shared library, make sure to install the matching
++ lib*-dev package, which provides a symlink with a .so extension.
++
++ -- Peter Colberg <peter@colberg.org> Tue, 10 Nov 2015 23:52:57 -0500
--- /dev/null
--- /dev/null
++Starting Julia REPL
++-------------------
++
++ Simply type `julia' in a shell to launch an interactive Julia session.
++
++ Full documentation and examples are available in the julia-doc package.
++ /usr/share/doc/julia/html/en/index.html
++
++ An Emacs mode for editing Julia source files and managing interactive sessions
++ is available in the ess package.
++
++ -- Sébastien Villemot <sebastien@debian.org>, Wed, 16 Oct 2013 16:07:45 +0200
++
++
++Julia and Math Kernel Library (Intel-MKL)
++-----------------------------------------
++
++ There are two ways to switch the BLAS/LAPACK implementation to MKL.
++ 1. Switch the libblas.so.3 and liblapack.so.3 candidate with Debian's
++ alternatives system.
++ 2. Rebuild Julia against MKL.
++
++ Alternatives System
++ ^^^^^^^^^^^^^^^^^^^
++
++ You can switch e.g. libblas.so.3-x86_64-linux-gnu with galternatives.
++
++ $ sudo apt install galternatives
++
++ When not using OpenBLAS, you might encounter the following warning,
++ but it doesn't harm:
++
++ WARNING: Error during initialization of module LinearAlgebra:
++ ErrorException("could not load symbol "openblas_get_config":
++ /usr/bin/../lib/x86_64-linux-gnu/julia/libblas.so: undefined symbol: openblas_get_config")
++
++ Rebuild against MKL
++ ^^^^^^^^^^^^^^^^^^^
++
++ To rebuild Julia against MKL, set the variable CUSTOM_MKL as 1 in
++ debian/rules, and rebuild the package. Please make sure that you
++ have intel-mkl installed before doing the custom build.
++
++ Brief Instruction for doing custom build against MKL:
++
++ 0. Fetch the source package of julia and enter the source tree.
++
++ 1. Install the build dependencies and helper scripts
++
++ $ sudo apt install devscripts
++ $ sudo apt build-dep julia
++
++ 2. Modify debian/rules, setting CUSTOM_MKL to 1 .
++
++ 3. Build, check, and install.
++
++ $ debuild -j4
++ $ debc
++ $ sudo debi
++
++ Known Problems about MKL
++ ^^^^^^^^^^^^^^^^^^^^^^^^
++
++ 1. When MKL is installed in the build environment, this test failure
++ may appear: https://github.com/JuliaLang/julia/issues/23264
++
++ -- Mo Zhou <cdluminate@gmail.com> Thu, 22 Sept 2018 09:00:00 +0000
--- /dev/null
--- /dev/null
++Document: julia-manual-pdf
++Title: Julia Language Manual
++Abstract: Describes the Julia language and its standard library
++Section: Programming
++
++Format: PDF
++Files: /usr/share/doc/julia/TheJuliaLanguage.pdf.gz
--- /dev/null
--- /dev/null
++julia (1.3.0+dfsg-2) unstable; urgency=medium
++
++ * Mark two symbols as x86 only. (thanks to Graham Inggs)
++ * rules: Disable BLAS64 on arm64.
++ * Temporarily make autopkgtest fail-permissive.
++
++ -- Mo Zhou <cdluminate@gmail.com> Sat, 14 Dec 2019 10:21:17 +0800
++
++julia (1.3.0+dfsg-1) unstable; urgency=medium
++
++ * New upstream version 1.3.0+dfsg
++ * Patch Make.inc to fix openblas FTBFS on arm64
++ * Refresh patches.
++ * Update embedded libuv and Pkg.jl, as well as d/s/include-binaries.
++ * B-D on p7zip and set USE_SYSTEM_P7ZIP=1.
++ * Remove nonexisting files from julia.docs.
++ * Update symbols control file.
++ * B-D on zlib1g-dev and set USE_SYSTEM_ZLIB=1.
++ * Remove unused patch: llvm-armhf-baseline.patch
++ * Bump LLVM version to 8.
++ * Reflect symbol changes resulted by the LLVM version bump.
++ * Override two lintian warnings
++
++ -- Mo Zhou <cdluminate@gmail.com> Thu, 28 Nov 2019 19:26:55 +0800
++
++julia (1.2.0+dfsg-1) unstable; urgency=medium
++
++ * New upstream version 1.2.0+dfsg
++ * Rebase/Refresh patches. Remove make-unwind-logic-error.patch.
++ * Update the embedded Pkg.jl to 394e7c5d55d3722f5b2ab660ca0a694ea0041974
++ * Disable binary builders via USE_BINARYBUILDER=0 .
++ * Bump LLVM dependency to llvm-7-dev (Closes: #919593, #912792).
++ * Update installation control files.
++ * Refresh symbols list.
++ * Patch: mask some failing tests.
++ * Bundle OpenBLAS and SuiteSparse source tarballs. (USE_BLAS64 is enabled)
++ Bundled OpenBLAS is specially compiled with SONAME=libopenblas64_.so,
++ INTERFACE64=1 and all symbols suffixed by "64_". Bundled SuiteSparse
++ is built against the bundled OpenBLAS with -DSUN64 extra CFLAG.
++ (Closes: #910924, #930548)
++ * Patch the suitesparse checksum.
++ * Prevent Makefile from downloading openblas and suitesparse.
++ * Update list of included-binaries
++ * Remove OpenBLAS and SuiteSparse from B-D.
++ * Remove libopenblas-base from runtime Depends.
++ * shlibdeps.mk: Add several dependencies for openblas and suitesparse.
++ * rules: Remove the LIBBLAS/LIBLAPACK build flags.
++ * Update copyright information for embedded OpenBLAS, SuiteSparse.
++ * Update the embedded OpenBLAS to 0.3.7
++ * rules: Remove the if-clause that disables libunwind for s390x.
++ * Exclude some libraries during shlibdeps resolution and dh_install.
++ * Files-Excluded: exclude the whole contrib/windows directory.
++ * Make tests fail-permissive.
++
++ -- Mo Zhou <cdluminate@gmail.com> Tue, 29 Oct 2019 20:08:37 +0800
++
++julia (1.1.1+dfsg-1) unstable; urgency=medium
++
++ * New upstream version 1.1.1+dfsg
++ * Bump Standards-Version to 4.4.0 (no change).
++ * Add update-jl.sh script for managing embedded sources.
++ + Update embedded Pkg.jl to 40cbbe224d4a491503279dfc5b9aefe15412f007.
++ + Update embedded Documenter.jl to 0.23.0
++ + Update embedded JSON.jl to 0.21.0
++ + Update embedded DocStringExtensions.jl to 0.8.0
++ + Embed DocumenterlaTeX.jl 0.2.0
++ + Embed Parsers.jl 0.3.6
++ * Re-apply the privacy-breach.patch to the embedded .jl packages.
++ * Disable the flaky PDF build and remove the doc-base file.
++ * Apply wrap-and-sort.
++
++ -- Mo Zhou <cdluminate@gmail.com> Thu, 25 Jul 2019 14:12:44 +0000
++
++julia (1.1.0+dfsg-1) experimental; urgency=medium
++
++ [ Mo Zhou ]
++ * New upstream version 1.1.0+dfsg
++ * shlibdeps.mk: remove unused arpack part.
++ * B-D: Require llvm-6.0-dev (>= 1:6.0.1-11).
++ * Remove patches merged upstream and refresh patches:
++ - appstream.patch
++ - test-skip-i386-spec.patch
++ * Update the embedded source or source tarballs:
++ + libuv, Pkg.jl, Documenter.jl (= 0.22.1), DocumenterLatex.jl (= 0.2.0),
++ DocStringExtensions (= 0.7.0), JSON.jl (= 0.20.0).
++ * Refresh symbols list for libjulia1.
++ * Switch back to use system LLVM:
++ + Set USE_SYSTEM_LLVM=1.
++ + Add makefile options for system LLVM.
++ + Add DESTDIR argument to makefile options.
++ + Build-Depends on system LLVM-6.0.
++ - Remove the embedded LLVM-6.0.0 tarball and update include-binaries.
++ - Remove cmake and python3 from Build-Depends since they are for LLVM.
++ - Remove copyright paragraph for the embedded LLVM.
++ - Remove the LLVM installation hack from rules.
++ - Remove hacky patches for related to the embedded LLVM.
++ - install-embedded-llvm-hack.patch
++ - install-julia-hack.patch
++
++ [ Salsa Pipeline ]
++ * Update salsa CI pipeline
++
++ -- Mo Zhou <cdluminate@gmail.com> Thu, 04 Apr 2019 04:25:04 +0000
++
++julia (1.0.4+dfsg-1) unstable; urgency=medium
++
++ * New upstream version 1.0.4+dfsg
++ * Uscan: Monitor the 1.0.X series.
++ * Upgrade embedded Pkg.jl -> 1609a05aee5d5960670738d8d834d91235bd6b1e
++
++ -- Mo Zhou <cdluminate@gmail.com> Fri, 17 May 2019 09:01:01 +0000
++
++julia (1.0.3+dfsg-4) unstable; urgency=medium
++
++ [ Mo Zhou ]
++ * Set JULIA_CPU_TARGET="pwr8" for ppc64el architecture
++
++ [ Graham Inggs]
++ * Avoid baseline violation on armhf, thanks Adrian Bunk
++ (Closes: #919183)
++ * Build with GCC 8 on armhf again
++
++ -- Graham Inggs <ginggs@debian.org> Tue, 22 Jan 2019 20:19:55 +0000
++
++julia (1.0.3+dfsg-3) unstable; urgency=medium
++
++ * Switch to use embedded LLVM-6.0.0 with upstream patches.
++ + Embed llvm-6.0.0.src.tar.xz to debian/embedded.
++ + Register new tarball in source/include-binaries.
++ + Set USE_SYSTEM_LLVM=0 in rules.
++ + Add patch do-not-download-llvm.patch to redirect downloading.
++ + Add symlinks in debian/embedded to avoid "download" errors.
++ + Add cmake, python3 to B-D for the embedded LLVM.
++ + Update copyright for the embedded LLVM.
++ + Patch Makefile and update rules to amend installation.
++ + Install the embedded LLVM to Julia's private library directory.
++ + dh_makeshlibs: Don't track symbols for the private LLVM library.
++ - Drop B-D on Debian's LLVM 6.0
++ - Remove makefile options for system LLVM.
++ * Remove the DESTDIR definition from make flags. This definition
++ screws up installtion of embedded LLVM.
++ * Add hack for embedded LLVM to let it install shlibs correctly.
++ * Refresh patches (quilt push -a --refresh).
++ * Skip more DNS tests for Sockets.jl module.
++
++ -- Mo Zhou <cdluminate@gmail.com> Thu, 17 Jan 2019 15:27:52 +0000
++
++julia (1.0.3+dfsg-2) unstable; urgency=medium
++
++ [ Graham Inggs ]
++ * Skip DNS tests which fail on Ubuntu autopkgtest infrastructure
++
++ [ Mo Zhou ]
++ * Add d/gitlab-ci.yml for enabling Salsa CI pipeline.
++ * Delete the unused DEBIAN_FORCE_NONET env var from rules and autopkgtest.
++ * Update copyright for embedded .jl packages.
++ * Uscan: add dversionmangle option to append +dfsg postfix.
++ * Add headers for headless patches.
++ * Add patch (disabled by default) to append "@distro" to default LOAD_PATH.
++ * Bump Standards-Version to 4.3.0 (no change).
++ * Rollback embedded Documenter to 0.20.0, DocStringExtensions to 0.5.0 .
++ * Refresh the list of included-binaries.
++ * Bump B-D-I pygmentize to Py3 version.
++ + Append python3-pkg-resources to B-D-I to workaround #918401
++ * Add repacksuffix option to uscan.
++ * Add openssl to B-D (more test coverage) and Recommends.
++
++ -- Mo Zhou <cdluminate@gmail.com> Sun, 13 Jan 2019 10:53:28 +0000
++
++julia (1.0.3+dfsg-1) unstable; urgency=medium
++
++ * Users who want to use MKL as Julia's BLAS/LAPACK backend should
++ rebuild this package after turning on the CUSTOM_MKL flag in d/rules.
++ I temporarily reverted the use of alternatives mechanism because the
++ code of stdlib/LinearAlgebra is not ready for such a feature.
++
++ * DFSG: Exclude contrib/windows/7zS.sfx (Closes: #916957)
++ * Remove the aforementioned incremental patch since the
++ source tarball has been refreshed.
++ * Revert "Link libjulia.so.X against libblas.so.3 to take
++ advantage from alternatives." (Closes: #916991)
++
++ -- Mo Zhou <cdluminate@gmail.com> Fri, 21 Dec 2018 14:47:47 +0000
++
++julia (1.0.3-2) unstable; urgency=medium
++
++ * Cherry-pick incremental patch from upstream's force-pushed 1.0.3 tag.
++
++ -- Mo Zhou <cdluminate@gmail.com> Tue, 18 Dec 2018 06:25:16 +0000
++
++julia (1.0.3-1) unstable; urgency=medium
++
++ * New upstream version 1.0.3
++ * Strip shared object libjulia.so.1 , whilst sys.so is still unstripped.
++ * Update embedded tarball for Pkg.jl .
++ * Refresh and update patches, including patches for embedded source.
++ * Refresh doc-silent.patch on new embedded source.
++ * Upgrade embedded DocStringExtensions.jl to v0.6.0
++ * Upgrade embedded Documenter to v0.21.0
++ * Remove embedded Compat.jl, not used by Documenter.jl anymore.
++
++ -- Mo Zhou <cdluminate@gmail.com> Mon, 17 Dec 2018 10:15:03 +0000
++
++julia (1.0.2-1) unstable; urgency=medium
++
++ * New upstream version 1.0.2
++ * Remove test-precision.patch, merged upstream.
++ * Import Pkg.jl tarball to d/embedded directory.
++ Its sha512sum matches with the one provided by upstream.
++ + Register the Pkg.jl tarball in include-binaries.
++ + Patch makefile to avoid downloading Pkg.jl tarball.
++ * Remove LLVM_DISABLE_ABI_BREAKING_CHECKS_ENFORCING definition from rules.
++ * Refresh Patches.
++
++ -- Mo Zhou <cdluminate@gmail.com> Thu, 29 Nov 2018 06:50:23 +0000
++
++julia (1.0.1-2) unstable; urgency=medium
++
++ * Extend JULIA_CPU_TARGET to include optimized targets as well,
++ apart from the generic target. (Closes: #910784)
++
++ -- Mo Zhou <cdluminate@gmail.com> Sat, 13 Oct 2018 06:16:18 +0000
++
++julia (1.0.1-1) unstable; urgency=medium
++
++ * New upstream stable release 1.0.1 (Sept 2018)
++ * Remove hundreds of patches picked from WIP Julia 1.0.1 release.
++ * Elaborate on why debug info should not be stripped from sys.so in rules.
++ * Drop deps:openspecfun which is not used anymore since 0.7 release.
++ * Add CUSTOM_NATIVE variable in rules for custom builds.
++ * Drop test related patches, because they are not needed anymore:
++ - Drop test-add-envvar-for-skipping-network-tests.patch .
++ - Drop test-moredetail.patch, test-skip-ppc64el-spec.patch
++ - Drop test-remove-powermod.patch, test-aggressive-gc.patch .
++
++ -- Mo Zhou <cdluminate@gmail.com> Sun, 30 Sep 2018 15:22:20 +0000
++
++julia (1.0.0-3) unstable; urgency=medium
++
++ * Handle floating point precision issue during test. (test-precision.patch)
++ * Patch runtests.jl to let it print more detail. (test-moredetail.patch)
++ * Make Documenter.jl quiet. (pre-apply, doc-silent.patch)
++ * Autopkgtest: Skip network related tests for Ubuntu.
++ * Link libjulia.so.X against netlib LAPACK (libblas.so.3/liblapack.so.3)
++ in order to take advantage from alternatives system. (Closes: #905826)
++ * Shared object libjulia.so.X Depends on high performance BLAS/LAPACK
++ implementations when available, i.e. OpenBLAS | Atlas | Intel-MKL.
++ * Add 167 patches from work-in-progress Julia 1.0.1 release.
++ * Autopkgtest: Execute runtests.jl instead of calling Base.runtests()
++ * README.Debian: Julia's BLAS/LAPACK backend is switchable henceforth.
++ * Also remove the "net_on" guard in test/runtests.jl.
++ (update, test-add-envvar-for-skipping-network-tests.patch)
++ * Downgrade GCC version to 7 for armhf in order to circumvent FTBFS.
++
++ -- Mo Zhou <cdluminate@gmail.com> Sun, 23 Sep 2018 03:11:52 +0000
++
++julia (1.0.0-2) unstable; urgency=medium
++
++ * Run test on all architectures instead of only amd64 and i386,
++ but allow non-x86 tests to fail. (Closes: #906754)
++ * Binary package julia Suggests vim-julia. (Closes: #907050)
++ * Enable the build on s390x
++ - Disable libunwind on s390x (unsatisfiable dependency).
++ * shlibdeps.mk: don't link against libunwind on s390x architecture.
++ * Fix logic error in base/Makefile. (+ make-unwind-logic-error.patch)
++ * Skip some tests unconditionally or conditionally according to Sys.ARCH
++ * Skip "powermod" related tests on non-x86 architecture.
++ * Skip several tests specifically on i386. (+ test-skip-i386-spec.patch)
++ * Skip several tests on ppc64el. (+ test-skip-ppc64el-spec.patch)
++ * Add patch test-add-envvar-for-skipping-network-tests.patch.
++ + rules: Export DEBIAN_FORCE_NONET to skip network tests during build.
++ * Add patch test-aggressive-gc.patch: make garbage collection aggressive.
++ * Re-arrange patches and refresh them.
++ * Disable thumb instruction set for armhf by adding -marm to cflags.
++ * Bump Standards-Version to 4.2.1 (no change).
++ * rules: Don't install extra license files.
++ * Override false-positive lintian error: wrong-path-for-interpreter.
++ * Upload to unstable.
++
++ -- Mo Zhou <cdluminate@gmail.com> Fri, 14 Sep 2018 11:09:12 +0000
++
++julia (1.0.0-1) experimental; urgency=medium
++
++ * New upstream version 1.0.0
++ * Bump SOVERSION from 0.7.0 to 1.0.0, update debian directory accordingly.
++ * Package libjulia1.0 Breaks and Replaces libjulia0.7 .
++ * Refresh symbols list for libjulia.so.1.0 .
++ * Update the embedded Documenter:
++ + Documenter.jl to v0.19.4
++ + Compat.jl to v1.0.1 .
++ + DocStringExtensions.jl to v0.4.6 .
++ * Update debian/source/include-binaries accordingly.
++ * Update patch privacy-breach.patch and pre-apply the patch.
++ * Add patch doc-unicode-data-path.patch and update deb-make-doc.patch
++ to avoid UnicodeData.txt File-Not-Found during documentation build.
++ * Refresh debian/copyright.
++ * Also build the PDF documentation apart from the HTML doc.
++ + Add latex related Build-Depends-Indep packages for building PDF doc.
++ + Override dh_auto_build-indep to build both HTML and PDF document.
++ + Install the generated PDF doc doc/_build/pdf/en/TheJuliaLanguage.pdf
++ + Register the PDF documentation in doc-base.
++ * Remove source/local-options , not useful anymore.
++ * Update appstream.patch from upstream pull request #28020.
++
++ -- Mo Zhou <cdluminate@gmail.com> Thu, 16 Aug 2018 07:48:17 +0000
++
++julia (0.7.0-2) unstable; urgency=medium
++
++ [ Peter Colberg ]
++ * Drop Build-Depends on libfftw3-dev, Bindings to the FFTW library
++ have been removed from Base. (Closes: #905849)
++
++ [ Mo Zhou ]
++ * Replace Sys.CPU_CORES with Sys.CPU_THREADS in test script.
++ * Add patch test-skip-sigint.patch to temporarily avoid a random
++ test failure in test/stress.jl, which sometimes fail to catch SIGINT.
++
++ -- Mo Zhou <cdluminate@gmail.com> Sun, 12 Aug 2018 01:00:36 +0000
++
++julia (0.7.0-1) unstable; urgency=medium
++
++ * New upstream version 0.7.0
++ * Update embedded libuv tarball to ed3700c849289ed01fe04273a7bf865340b2bd7e.
++ * Refresh all the patches.
++ * Move privacy-breach.patch to quilt directory, and pre-apply the patch.
++ * Require libgit2-dev (>= 0.27.0~) as B-D.
++ * Bump Standards-Version to 4.2.0 (no change).
++ * Three new symbols for libjulia0.7 0.7.0 .
++ * Only traverse within debian directory when fixing shebang. (Avoid FTBFSx2)
++ * README.Debian: Add brief instructions for rebuilding Julia against MKL.
++ * Update file matching expressions in copyright.
++ * Require llvm-6.0-dev (>= 1:6.0.1-3) in the B-D field.
++
++ -- Mo Zhou <cdluminate@gmail.com> Thu, 09 Aug 2018 16:43:05 +0000
++
++julia (0.7.0~beta2-1) experimental; urgency=medium
++
++ * New upstream BETA version 0.7.0~beta2
++ * Changes related to embedded sources:
++ + Embed newer libuv tarball which is specified by upstream.
++ - Remove the old libuv-d8ab1c6a33e77bf155facb54215dd8798e13825d.tar.gz
++ + Embed libwhich-81e9723c0273d78493dc8c8ed570f68d9ce7e89e.tar.gz
++ - Remove embedded arpack tarball and corresponding b-d.
++ * Update binary file registration in source/include-binaries .
++ * Updates related to patch stack:
++ * Refresh patches for 0.7.0~beta2
++ + Add patch: do-not-download-libwhich.patch
++ + Update patch deb-make-doc.patch to fix document build failure.
++ + Update no-debug-version.patch to adapt to upstream Makefile change.
++ - Remove do-not-download-arpack.patch, not used anymore.
++ - Remove do-not-query-ldconfig.patch, due to upstream's commit:
++ github.com/JuliaLang/julia/commit/28f3c06f2d30dd1ae2c189cf8fb54d625ecc26ad
++ - Remove patch: unversioned-system-load-path.patch (not applied).
++ We don't need it anymore because it may result in confusing behaviour.
++ - Remove unused tests patch: test_libgit2.patch, unicode-test.patch,
++ test_replcompletions.patch. Nolonger needed since the tests don't fail.
++ * Control-related changes:
++ * Bump B-D llvm version to 6 (Closes: #873408)
++ * Bump SOVERSION, and update corresponding file names.
++ * Update .install files: install several new files.
++ * Update symbols control file.
++ * libjuila0.7 breaks and replaces libjulia0.6 .
++ * symbols: Mark jl_cpuidex as {amd64,i386}-only.
++ * Mark usr/share/doc/julia/html/* as not-installed to silent dh_missing.
++ * Build-related changes:
++ + Run dh_missing --list-missing during build.
++ + Suppress compiler warning by explicitly defining the following CXX flag:
++ -DLLVM_DISABLE_ABI_BREAKING_CHECKS_ENFORCING=0
++ * JULIA_CPU_CORES is deprecated in favor of JULIA_CORE_THREADS.
++ * Fix shebang and mode bits during dh_fixperms:
++ 's@#!/usr/bin/env julia@#!/usr/bin/julia@g'
++ * Delete the deprecated make flag USE_SYSTEM_ARPACK.
++ * Policy-related changes:
++ + Update SOVERSION in lintian overrides
++ * julia-common: Override one more lintian Info:
++ package-contains-documentation-outside-usr-share-doc
++ * Miscellaneous changes:
++ - Delete comment from the watch file.
++ + Install an example config which tweaks the default prompt string.
++ * Update copyright for Julia 0.7.X and embedded sources.
++ * autopkgtest: Remove the arpack-sanity test, because arpack was split out
++ from Julia 0.7.X by upstream.
++
++ -- Mo Zhou <cdluminate@gmail.com> Mon, 23 Jul 2018 08:52:51 +0000
++
++julia (0.6.4-2) unstable; urgency=medium
++
++ * Let julia depend on libjulia0.6 (= ${binary:Version})
++ * libjulia0.6 breaks julia (<< 0.5.0~) due to file overwrite.
++ This fixes stable->sid upgrade. (Closes: #903498)
++ * Remove unused patch version-git.patch since we have NO_GIT=1 in rules.
++ * Fill in patches' header with DEP-3 alike information.
++
++ -- Mo Zhou <cdluminate@gmail.com> Wed, 11 Jul 2018 09:23:52 +0000
++
++julia (0.6.4-1) unstable; urgency=medium
++
++ [ Mo Zhou ]
++ * New upstream version 0.6.4
++ * Refresh patches after importing 0.6.4 .
++ * Replace the placeholder in watch file, which was left unchanged by mistake.
++ * Import embedded copy of libuv (checksum identical to upstream's).
++ libuv-d8ab1c6a33e77bf155facb54215dd8798e13825d.tar.gz
++ + Register the new embedded tarball in source/include-binary
++ * Refresh copyright for the tarball.
++ * Deprecate the get-orig-tarball target in rules.
++ * Split the autopkgtest test command into individual script.
++ * Replace the old do-not-download-libuv.patch patch with a new one.
++ * Patch: Let jldownload be verbose and download from file:// URI.
++ + debian/patches/jldownload-verbose-fakedownload.patch
++ * rules: Don't install any .gitignore file!
++ * rules: Update the TAGGED_RELEASE_BANNER to avoid confusion.
++ * Update the matching pattern in lintian overrides.
++ * Patch: disable unversioned-system-load-path.patch .
++ * Autopkgtest: One more script to test arpack sanity.
++
++ [ Graham Inggs ]
++ * Disable unaligned access on armhf
++ * Enable ARM NEON extensions, since #842142 is fixed
++
++ -- Mo Zhou <cdluminate@gmail.com> Tue, 10 Jul 2018 16:08:48 +0000
++
++julia (0.6.3-6) unstable; urgency=medium
++
++ * Bump B-D on libutf8proc-dev to (>= 2.1.1) and enable
++ unicode/utf8proc test, since #902902 is fixed
++ * Drop libjulia0.6's explicit dependency on libgit2-26
++
++ -- Graham Inggs <ginggs@debian.org> Mon, 09 Jul 2018 20:29:42 +0000
++
++julia (0.6.3-5) unstable; urgency=medium
++
++ * Switch B-D LLVM version from 3.9 -> 4.0 .
++ * Skip more tests in test/libgit2.jl to avoid FTBFS.
++
++ -- Mo Zhou <cdluminate@gmail.com> Mon, 09 Jul 2018 12:29:34 +0000
++
++julia (0.6.3-4) unstable; urgency=medium
++
++ * Don't strip sys.so and libjulia.so as suggested upstream. This fixes
++ several tests that fail during autopkgtest but didn't fail during build.
++ https://github.com/JuliaLang/julia/issues/23115#issuecomment-320715030
++ * Override lintianE: libjulia0.6: unstripped-binary-or-object.
++ * Enable more tests from libgit2.jl and replcompletions.jl .
++ * Let libjulia0.6 depend on libgit2-27 (>= 0.27.0+dfsg.1-0.2) explicitly.
++ * Add missing symlinks to libmbedcrypto and libmbedx509 .
++ * Drop unneeded B-D libarpack2-dev, libjs-mathjax.
++ Drop libjs-underscore from julia-doc Depends.
++ * Revert "control: Stick to unicode-data version 11 to avoid surprise."
++ * Loosen libgit2 requirement to (>= 0.26.0+dfsg.1-1.1) .
++ * Explicitly Build-Depends on libmbedtls-dev.
++ * Upload to unstable.
++
++ -- Mo Zhou <cdluminate@gmail.com> Mon, 09 Jul 2018 09:08:35 +0000
++
++julia (0.6.3-3) experimental; urgency=medium
++
++ * rules: Wrap-and-sort the build flags.
++ * Fix a typo in shlibdeps.mk which could causes dh-link failure.
++ * Update shlibdeps.mk for libuv1 .
++ * rules: Comment that we cannot use the libuv1 provided in archive.
++ * Skip test "replcompletions" to avoid FTBFS.
++ See: https://github.com/JuliaLang/julia/issues/27958
++ * Bump Standards-Version to 4.1.5 (no change).
++ * Add the missing B-D libcurl4-gnutls-dev | libcurl-dev .
++
++ -- Mo Zhou <cdluminate@gmail.com> Sat, 07 Jul 2018 08:39:35 +0000
++
++julia (0.6.3-2) experimental; urgency=medium
++
++ * Deal with symlinks for embedded julia documenter in more graceful way.
++ * Remove unused symlinks shipped in julia-doc .
++ * Install upstream NEWS, HISTORY, DISTRIBUTING, etc to julia.
++ * Merge debian/NOTES into debian/README.Debian
++ * Clean up old/unused parts in rules.
++ * Stick to unicode-data version 11 to avoid surprise.
++ * Update shlibdeps.mk according to upstream Make.inc .
++ * Move all private shared object files to package libjulia0.6 .
++ * Don't generate symbols for the private libarpack.so .
++ * Add a custom option to enable building Julia with MKL.
++
++ -- Mo Zhou <cdluminate@gmail.com> Fri, 06 Jul 2018 11:18:49 +0000
++
++julia (0.6.3-1) experimental; urgency=medium
++
++ [ Peter Colberg ]
++ * Update Vcs-* fields for move to salsa.debian.org
++ * New upstream version 0.6.0
++ * Refresh patches
++ * Move manpages and examples back to julia package
++ * Add libjulia0.6 with runtime library
++ * Add libjulia-dev with runtime headers
++ * Build-Depends on llvm-3.9-dev
++ * Drop Build-Depends on python3-sphinx (Closes: #896622)
++ * Build-Depends on libgit2-dev (>= 0.23)
++ * Build-Depends on libutf8proc-dev (>= 2.1.0)
++ * Substitute deprecated parameters in autopkgtest command
++ * Update debian/copyright
++ * Drop embedded copy of Rmath from upstream tarball
++ * Drop embedded copy of juliadoc from upstream tarball
++
++ [ Mo Zhou ]
++ * Add myself to Uploaders.
++ * Refresh patch after rebasing Peter's work to master (0.4.7-7).
++ * New upstream version 0.6.3 (Closes: #839668)
++ * Refresh existing patches based on Julia 0.6.3 .
++ * Household changes:
++ * Bump Standards-Version to 4.1.4 .
++ * Change Priority from extra to optional. (4.0.0 -> 4.0.1)
++ * Bump debhelper compat level to 11 .
++ * Remove --parallel option in favor of debhelper compat 11.
++ * Embed several convenient code copies to debian/embedded/ :
++ * These embedded Julia package copies are used to build Julia doc.
++ + Compat.jl-0.69.0
++ + DocStringExtensions.jl-0.4.4
++ + Documenter.jl-0.18.0
++ * The embedded arpack source is used to avoid #902914.
++ + arpack-ng-3.3.0.tar.gz
++ * source: don't complain about binary files from embedded source.
++ * Patch upstream doc to avoid downloading anything.
++ + Build-Depends on unicode-data. (used during doc build)
++ + Prepare symlinks for embedded julia packages during dh_auto_configure.
++ + Patch upstream makefile to prevent it from downloading arpack source.
++ * Add upstream metadata including citation information.
++ * Upgrade watch file to uscan version 4.
++ * Move libjulia0.6 to libs section.
++ * Requires libgit2-dev >= 0.27.0+dfsg.1-0.5 for Build-Depends.
++ The specified version ships working TLS support.
++ * Add symbols control file for libjulia0.6 .
++ * rules: Don't use system Arpack. It causes "eigs(spdiagm(1:25))" failure.
++ * Patch upstream tester to skip utf8proc and libgit2 tests.
++ * Add missing Build-Depends for embedded arpack.
++ * Switch the default downloader dependency from wget to curl.
++ See https://github.com/JuliaLang/julia/issues/22783 . wget doesn't
++ throw the expected error, which would cause test failure.
++ * Patch embedded documenter code to prevent privacy-breach-generic .
++ + Replace google font css URL with customized css to avoid privacy breach.
++ + Use the "Incolsolata" font instead of "Roboto Mono".
++ + Document package depends on inconsolata font.
++ * Move AppStream xml file to new location /usr/share/metainfo .
++ * Patch upstream's outdated appstream xml file to prevent lintian Error.
++ * Update HTML documentation registration path in doc-base.
++ * Don't ship debug files e.g. libccalltest.so.debug .
++ * Don't trigger ldconfig for binary package "julia" because it ships libs
++ in private directory. This is accomplished by appending --no-scripts
++ option to dh_makeshlibs . An ldconfig trigger is manually added for
++ "libjulia0.6" package.
++ * Export HOME environt variable to really fix the mkdir permission issue.
++ * Mark symbol jl_cpuid as (amd64, i386)-only.
++ * Add NOTES to debian/ directory. (MKL is causing test failure)
++ * Note related to LLVM-4.0 : julia-0.6.3, built with llvm-4.0, is able to
++ pass the tests. However, llvm-3.9 is still preferred since upstream
++ sticks to llvm-3.9 .
++ * Update copyright for Julia 0.6.3 and embedded sources.
++ * Upload to experimental.
++
++ -- Mo Zhou <cdluminate@gmail.com> Thu, 05 Jul 2018 09:26:56 +0000
++
++julia (0.4.7-7) unstable; urgency=medium
++
++ * Add missing documentation option to fix build with Sphinx 1.5
++ * Switch to debhelper 10
++ * Use https in debian/control and debian/copyright
++ * Bump Standards-Version to 4.0.0
++ * Drop override_dh_strip-arch, ddeb migration is complete
++ * Fix more Lintian warnings spelling-error-in-binary
++ * Mark all binary packages Multi-Arch: foreign
++ * Enable all hardening flags
++
++ -- Graham Inggs <ginggs@debian.org> Wed, 12 Jul 2017 14:50:13 +0200
++
++julia (0.4.7-6) unstable; urgency=medium
++
++ * Use openlibm instead of libm on mips, mips64el and mipsel
++
++ -- Graham Inggs <ginggs@debian.org> Wed, 25 Jan 2017 07:39:32 +0200
++
++julia (0.4.7-5) unstable; urgency=medium
++
++ * Use openlibm instead of libm on armhf and ppc64
++ * Use openblas instead of blas and lapack on mips64el and ppc64
++ * Update debian/copyright
++ * Do not override ARM options in Make.inc
++ * Do not print warning if unable to determine host CPU name
++ * Add src/*.dwo to debian/clean
++ * Explicitly set USE_SYSTEM_LIBM where needed
++
++ -- Graham Inggs <ginggs@debian.org> Mon, 23 Jan 2017 08:29:33 +0200
++
++julia (0.4.7-4) unstable; urgency=medium
++
++ * Use DEB_VENDOR inplace of lsb_release -si
++
++ -- Peter Colberg <peter@colberg.org> Mon, 02 Jan 2017 22:28:51 -0500
++
++julia (0.4.7-3) unstable; urgency=medium
++
++ * Set TAGGED_RELEASE_BANNER to distribution and source package version
++ (Closes: #849815)
++
++ -- Peter Colberg <peter@colberg.org> Sat, 31 Dec 2016 13:43:20 -0500
++
++julia (0.4.7-2) unstable; urgency=medium
++
++ * Ensure JULIA_CPU_CORES >= 2 to respawn test workers reaching memory limit
++ (Closes: #848506)
++
++ -- Peter Colberg <peter@colberg.org> Tue, 20 Dec 2016 23:57:28 -0500
++
++julia (0.4.7-1) unstable; urgency=medium
++
++ * New upstream release
++ * Refresh patches
++ * Drop install-sh-exit-status.patch, applied upstream
++ * Drop verbose-build.patch since libuv is already built with V=1
++ * Drop do-not-use-home-directory-in-tests.patch in favour of setting HOME
++ * Drop disable-download-test.patch since wget is not actually invoked
++ * Remove unused lintian override configure-generated-file-in-source
++ * Add debian/gbp.conf for pristine-tar
++
++ -- Peter Colberg <peter@colberg.org> Sun, 18 Sep 2016 23:55:05 -0400
++
++julia (0.4.6-1) unstable; urgency=medium
++
++ [ Peter Colberg ]
++ * New upstream release
++ * Refresh patches
++ * Drop unneeded build dependency on libdouble-conversion-dev
++ * Bump Standards-Version to 3.9.8, no further changes
++
++ [ Graham Inggs ]
++ * Use libopenlibm instead of libm on arm64
++ * Fix inconsistent use of GNU_SOURCE in embedded libuv (Closes: #748573)
++ * Drop arm-rec_backtrace.patch, no longer needed since ARM ABI backport
++
++ -- Peter Colberg <peter@colberg.org> Thu, 23 Jun 2016 22:20:54 -0400
++
++julia (0.4.5-3) unstable; urgency=medium
++
++ * Disable ARM NEON extensions. (Closes: #820220)
++
++ -- Graham Inggs <ginggs@debian.org> Sun, 17 Apr 2016 13:35:42 +0200
++
++julia (0.4.5-2) unstable; urgency=medium
++
++ * Make rec_backtrace() always return 0 on ARM and PPC64,
++ this avoids a FTBFS on armhf with recent GCC.
++
++ -- Graham Inggs <ginggs@debian.org> Thu, 07 Apr 2016 14:32:28 +0200
++
++julia (0.4.5-1) unstable; urgency=medium
++
++ * New upstream release.
++ * Refresh patches, new fix-spelling-error-in-binary.patch.
++ * Use libopenlibm instead of libm on powerpc and ppc64el.
++
++ -- Graham Inggs <ginggs@debian.org> Wed, 30 Mar 2016 17:56:56 +0200
++
++julia (0.4.3-4) unstable; urgency=medium
++
++ * Drop versioned build dependency on llvm-3.8-dev and
++ build dependencies on libllvm3.x (no longer needed).
++ * Upload to unstable.
++
++ -- Graham Inggs <ginggs@debian.org> Sun, 13 Mar 2016 11:06:39 +0200
++
++julia (0.4.3-3) experimental; urgency=medium
++
++ * Build depend on libllvm3.x as well (experimental).
++
++ -- Graham Inggs <ginggs@debian.org> Mon, 08 Feb 2016 13:06:53 +0200
++
++julia (0.4.3-2) experimental; urgency=medium
++
++ * Optionally build depend on llvm-3.8-dev (>= 1:3.8~+rc1).
++ * Add debian/clean to fix FTBFSx2.
++ * Migrate from julia-dbg to ddebs, bump debhelper build-dependency.
++ * Bump Standards-Version to 3.9.7, no further changes.
++ * Enable tests on i386 again.
++ * Improve generated debug info to fix FTBFS on i386
++ (see upstream issue #13754).
++
++ -- Graham Inggs <ginggs@debian.org> Mon, 08 Feb 2016 10:02:00 +0200
++
++julia (0.4.3-1) unstable; urgency=medium
++
++ [ Graham Inggs ]
++ * Ensure pcre_h.jl and errno_h.jl are sorted reproducibly.
++
++ [ Peter Colberg ]
++ * Imported Upstream version 0.4.3
++ * Refresh patches.
++ * Drop patch fix-arm64-ftbfs.patch, no longer needed.
++ * Update Vcs-Git and Vcs-Browser fields.
++ * Fix lintian warning dh-exec-useless-usage.
++ * Fix lintian warning spelling-error-in-binary.
++
++ -- Peter Colberg <peter@colberg.org> Thu, 14 Jan 2016 07:56:18 -0500
++
++julia (0.4.2-3) unstable; urgency=medium
++
++ * Fix FTBFS on arm64 (thanks to Edmund Grimley Evans). (Closes: #807701)
++ * Disable tests on i386 until perfomance issue with LLVM >= 3.4
++ is resolved (see upstream issue #14191).
++
++ -- Graham Inggs <ginggs@debian.org> Sat, 12 Dec 2015 11:27:26 +0200
++
++julia (0.4.2-2) unstable; urgency=medium
++
++ * Set number of parallel workers for tests.
++ + Restart workers exceeding maximum resident memory size of 500 MiB.
++ * Drop build depends on llvm-3.8-dev to permit migration to testing.
++ (Closes: #803644)
++
++ -- Peter Colberg <peter@colberg.org> Thu, 10 Dec 2015 06:50:01 -0500
++
++julia (0.4.2-1) unstable; urgency=medium
++
++ * Imported Upstream version 0.4.2
++ * Refresh patches.
++ * Upload to unstable. (Closes: #803644)
++
++ -- Peter Colberg <peter@colberg.org> Mon, 07 Dec 2015 06:49:01 -0500
++
++julia (0.4.1-2) experimental; urgency=medium
++
++ * Build depend on libpcre2-dev >= 10.20-3~ to fix FTBFS on ppc64el.
++ * Optionally build depend on llvm-3.8-dev to reduce performance regression.
++ * Optionally build depend on llvm-3.6-dev to ease backporting.
++
++ -- Peter Colberg <peter@colberg.org> Wed, 02 Dec 2015 07:26:24 -0500
++
++julia (0.4.1-1) experimental; urgency=medium
++
++ * Imported Upstream version 0.4.1
++ * Refresh patches.
++ * Update debian/copyright.
++ * Build depend on libsuitesparse-dev >= 1:4.4.5
++ * Build depend on llvm-3.7-dev.
++ * Build depend on libpcre2-dev (thanks to Matthew Vernon).
++ * Disable libgit2 test to avoid dependency on libgit2.
++ * Disable download test to avoid dependency on curl or wget.
++ * Do not use home directory in tests.
++ * Fix backtrace test with MCJIT.
++ * Fix documentation spelling errors.
++ * Install examples to doc directory inplace of symlink.
++
++ -- Peter Colberg <peter@colberg.org> Wed, 25 Nov 2015 08:00:20 -0500
++
++julia (0.3.12-2) unstable; urgency=medium
++
++ [ Peter Colberg ]
++ * Fix automated package testing with autopkgtest.
++ * Test REPL in dumb mode.
++ * Build depend on libopenlibm-dev (>= 0.4.1+dfsg-4~) to fix FTBFS on i386.
++ * Fix arch-all-only build with dpkg-buildpackage -A.
++
++ [ Sébastien Villemot ]
++ * Remove myself from Uploaders.
++
++ -- Graham Inggs <ginggs@debian.org> Wed, 25 Nov 2015 10:46:18 +0200
++
++julia (0.3.12-1) unstable; urgency=medium
++
++ [ Peter Colberg ]
++ * Imported Upstream version 0.3.12
++ * Add julia-common package with standard library and test suite.
++ * Remove embedded libraries:
++ + Build depend on libdsfmt-dev.
++ + Build depend on libutf8proc-dev.
++ * Generate version_git.jl from upstream commit.
++ * Build documentation using python3-sphinx.
++ * Fix potential privacy breach in documentation:
++ + Use libjs-modernizr package inplace of external link.
++ + Strip external link to Google Fonts API.
++ * Query SSE2 extension on i386 using x86 CPUID opcode.
++ * Do not query ldconfig for library sonames.
++ * Generate package dependencies for dynamically loaded libraries.
++ * Symlink dynamically loaded libraries to private library path.
++ * Add missing examples test for Base.runtests().
++ * Fix hanging socket test for Base.runtests().
++ * Enable parallel test.
++
++ [ Graham Inggs ]
++ * Build in the multiarch lib directories as well,
++ so that patchelf is no longer required. (Closes: #799099)
++ * Build everywhere. (Closes: #802583)
++ + Use libopenlibm where available, libm elsewhere.
++ + Use libopenblas where available, libblas and liblapack elsewhere.
++ + Cherry-pick patches from upstream 0.4.0 for armhf and ppc64el.
++
++ -- Graham Inggs <ginggs@debian.org> Fri, 13 Nov 2015 15:56:34 +0200
++
++julia (0.3.11-1) unstable; urgency=medium
++
++ * Imported Upstream version 0.3.11
++ * d/p/mcjit-llvm-ftbfs.patch: dropped, applied upstream.
++
++ -- Sébastien Villemot <sebastien@debian.org> Sun, 06 Sep 2015 18:51:09 +0200
++
++julia (0.3.10-1) unstable; urgency=medium
++
++ * Imported Upstream version 0.3.10
++ * d/p/inject-ldflags.patch: drop patch, no longer needed.
++ * d/p/mcjit-llvm-ftbfs.patch: new patch, taken from upstream.
++
++ -- Sébastien Villemot <sebastien@debian.org> Fri, 17 Jul 2015 23:14:01 +0200
++
++julia (0.3.9-1) unstable; urgency=medium
++
++ * Imported Upstream version 0.3.9
++ * repl-test.patch: new patch, prevents a test failure.
++
++ -- Sébastien Villemot <sebastien@debian.org> Sun, 21 Jun 2015 14:57:41 +0200
++
++julia (0.3.8-1) unstable; urgency=medium
++
++ * Imported Upstream version 0.3.8.
++ For the time being, manually embed juliadoc python package.
++ In the longer run, a separate Debian package should be created.
++ * sphinx-build.patch: new patch, needed for building doc without virtualenv.
++ * unicode-test.patch: new patch to workaround a test failure in unicode.jl.
++ * Set a hard dependency on OpenBLAS. (Closes: #778912)
++ * Ship tests in main package, so that they can be run on the compiled binary.
++ * Add autopkgtest (DEP8) support.
++
++ -- Sébastien Villemot <sebastien@debian.org> Mon, 25 May 2015 15:48:34 +0200
++
++julia (0.3.5-1) experimental; urgency=low
++
++ * Imported Upstream version 0.3.5. (Closes: #776069)
++
++ -- Sébastien Villemot <sebastien@debian.org> Fri, 13 Feb 2015 23:31:19 +0100
++
++julia (0.3.2-1) unstable; urgency=medium
++
++ * Imported Upstream version 0.3.2
++ * Ship new desktop file, SVG icon and appdata file.
++
++ -- Sébastien Villemot <sebastien@debian.org> Wed, 22 Oct 2014 18:42:04 +0200
++
++julia (0.3.1-1) unstable; urgency=medium
++
++ * Imported Upstream version 0.3.1
++ * Fix get-orig-source rule with respect to embedded utf8proc.
++ * No longer embed sphinx-rtd-theme.
++ + Add build-dependency on python-sphinx-rtd-theme.
++ + Drop patch embed-sphinx-rtd-theme.patch.
++ * Bump Standards-Version to 3.9.6, no changes needed.
++ * No longer try the "parallel" test at build time.
++ It always fails in chroots.
++
++ -- Sébastien Villemot <sebastien@debian.org> Wed, 24 Sep 2014 11:56:26 +0200
++
++julia (0.3.0-1) unstable; urgency=medium
++
++ * New upstream release.
++ - no longer breaks on PCRE upgrades. (Closes: #755576)
++ - command-line option "-p" works as expected. (Closes: #758783)
++ * Rewrite get-orig-source in d/rules. In particular no longer embed openlibm,
++ since it is now a separate package.
++ * debian/copyright: reflect upstream changes.
++ * New patches:
++ + do-not-download-utf8proc.patch
++ + inject-ldflags.patch
++ + install-sh-exit-status.patch
++ * Dropped patches:
++ + do-not-download-patchelf.patch (instead build depend on patchelf)
++ + fix-cpu-detection.patch
++ + ld-library-path-for-testing.patch
++ + make-4.0.patch
++ + no-git.patch (instead use "make -C base version_git.jl.phony")
++ + readline-6.3.patch (Julia no longer uses readline)
++ + sysconfdir-install.patch (instead use new make variable)
++ + use-sonames-with-dlopen.patch (not really needed, too difficult to
++ maintain)
++ * Ship the cached binary system image (sys.so).
++ * Compile with MARCH=x86-64 on amd64, and with MARCH=pentium4. In particular,
++ this means that SSE2 is now required on i386, because x87 FPU computing is
++ not supported by upstream and is buggy. Abort nicely if the CPU does have
++ SSE2, and by the way activate SSE2 in dSFMT (require-sse2-on-i386.patch).
++ As a consequence, drop the now unneeded testsuite-i386.patch.
++ * Bump to LLVM 3.5. (Closes: #753971)
++ * Add libopenblas-base to Recommends. Having it first in the BLAS
++ dependency alternative is not enough to ensure that it is installed by
++ default.
++ * Use OpenBLAS for both BLAS and LAPACK, since the Debian package now ships
++ both.
++ * Documentation package (julia-doc):
++ + use dh_sphinxdoc
++ + use packaged Mathjax instead of online version (with
++ use_packaged_mathjax.patch, symbolic links in d/julia-doc.links and
++ appropriate logic in d/rules)
++ + use packaged awesome font
++ + embed sphinx-rtd-theme, since the corresponding package has not yet been
++ accepted in sid (embed-sphinx-rtd-theme.patch)
++
++ -- Sébastien Villemot <sebastien@debian.org> Wed, 20 Aug 2014 10:51:46 +0000
++
++julia (0.2.1+dfsg-3) unstable; urgency=medium
++
++ * make-4.0.patch: fix FTBFS against make 4.0.
++
++ -- Sébastien Villemot <sebastien@debian.org> Wed, 07 May 2014 15:17:37 +0200
++
++julia (0.2.1+dfsg-2) unstable; urgency=medium
++
++ * readline-6.3.patch: new patch, fixes FTBFS against readline 6.3.
++ (Closes: #741824)
++ * Restrict supported archs to amd64 and i386, it never compiled elsewhere.
++
++ -- Sébastien Villemot <sebastien@debian.org> Sun, 16 Mar 2014 16:25:21 +0100
++
++julia (0.2.1+dfsg-1) unstable; urgency=medium
++
++ * New upstream release.
++
++ -- Sébastien Villemot <sebastien@debian.org> Sat, 15 Feb 2014 21:31:41 +0100
++
++julia (0.2.0+dfsg-6) unstable; urgency=medium
++
++ * Transition to libunwind8-dev. (Closes: #730464)
++
++ -- Sébastien Villemot <sebastien@debian.org> Sat, 01 Feb 2014 10:18:04 +0100
++
++julia (0.2.0+dfsg-5) unstable; urgency=low
++
++ * Transition to suitesparse 4.2.1.
++
++ -- Sébastien Villemot <sebastien@debian.org> Mon, 02 Dec 2013 18:38:37 +0100
++
++julia (0.2.0+dfsg-4) unstable; urgency=low
++
++ * Make the parallel.jl test non-fatal.
++
++ -- Sébastien Villemot <sebastien@debian.org> Sun, 24 Nov 2013 15:14:50 +0100
++
++julia (0.2.0+dfsg-3) unstable; urgency=low
++
++ * testsuite-i386.patch: loosen the numerical precision for yet another test.
++
++ -- Sébastien Villemot <sebastien@debian.org> Sun, 17 Nov 2013 19:32:52 +0100
++
++julia (0.2.0+dfsg-2) unstable; urgency=low
++
++ * testsuite-i386.patch: new patches, fixes FTBFS on i386.
++
++ -- Sébastien Villemot <sebastien@debian.org> Sun, 17 Nov 2013 17:51:13 +0100
++
++julia (0.2.0+dfsg-1) unstable; urgency=low
++
++ * New upstream release.
++ * debian/copyright: reflect upstream changes
++ * Update patches:
++ + remove patches applied upstream:
++ - suitesparse-3.4.patch
++ - testsuite-i386.patch
++ + remove fhs.patch, and replace it by the SYSCONFDIR build option.
++ + sysconfdir-install.patch: new patch to make the SYSCONFDIR option work
++ for us.
++ + refresh other patches.
++ * Bump Standards-Version to 3.9.5, no changes needed.
++ * Dependency of julia-dbg on julia is now versioned.
++
++ -- Sébastien Villemot <sebastien@debian.org> Sun, 17 Nov 2013 12:10:10 +0100
++
++julia (0.2.0~rc2+dfsg-2) unstable; urgency=low
++
++ * Use (older) suitesparse 3.4.
++ + d/control: downgrade (build-)dependencies
++ + use-sonames-with-dlopen.patch: update sonames
++ + suitesparse-3.4.patch: new patch
++ * Downgrade build-dependency to libunwind7-dev (was libunwind8-dev).
++ libunwind8-dev is unlikely to merge to testing soon.
++ * unversioned-system-load-path.patch: new patch.
++ Drops version number from system load path. Versioning unnecessary since
++ this path is managed by dpkg/apt. Moreover, it would make transitions to
++ higher versions needlessly complicated.
++ * testsuite-i386.patch: new patch, fixes testsuite crash on i386.
++ * Use canonical URL for Vcs-* fields
++
++ -- Sébastien Villemot <sebastien@debian.org> Sun, 03 Nov 2013 16:00:08 +0100
++
++julia (0.2.0~rc2+dfsg-1) experimental; urgency=low
++
++ * New upstream release candidate
++ * Link dynamically against LLVM, this seems to now work correctly
++
++ -- Sébastien Villemot <sebastien@debian.org> Sat, 26 Oct 2013 04:33:44 +0000
++
++julia (0.2.0~rc1+dfsg-1) experimental; urgency=low
++
++ * New upstream release candidate
++ * Removed patches:
++ + do-not-download-jquery.patch
++ + fix-version.patch
++ + no-webrepl.patch
++ + suitesparse-3.4.patch
++ + use-system-double-conversion.patch
++ + zlib-1.2.8.patch
++ * Added patches:
++ + fhs.patch
++ + no-debug-version.patch
++ + verbose-build.patch
++ * Ship upstream manpage
++ * Ship NEWS.md
++ * Build depend on llvm-3.3-dev
++ * Build depend on libsuitesparse-dev >= 1:4.2.1
++ * Stop distributing PDF documentation, it currently does not build
++ * debian/copyright: reflect upstream changes
++
++ -- Sébastien Villemot <sebastien@debian.org> Wed, 16 Oct 2013 15:54:13 +0200
++
++julia (0.1.2+dfsg-3) unstable; urgency=low
++
++ * Bump the B-D on dpkg-dev.
++ Support for source:Package and source:Version fields was added in dpkg-dev
++ 1.16.2 (Closes: #706470)
++ * Add support for DEB_BUILD_OPTIONS=nocheck (Closes: #706472)
++ * Add julia-dbg package
++ * Fix FTBFS with zlib >= 1.2.8 (Closes: #707962)
++ - zlib-1.2.8.patch: new patch, fixes the gzip.jl test
++ - tighten B-D on zlib1g-dev to >= 1:1.2.8
++
++ -- Sébastien Villemot <sebastien@debian.org> Wed, 15 May 2013 12:44:14 +0200
++
++julia (0.1.2+dfsg-2) unstable; urgency=low
++
++ * Statically link against LLVM.
++ With dynamic linking, strange bugs appear when the runtime library is not
++ the same than the one used for building. At this stage it is not clear
++ whether it is a Julia or LLVM bug. Reported as Julia issue #2494.
++ - use-shared-llvm.patch: remove patch
++ - add Built-Using field for julia binary package
++ - keep a dependency of julia on libllvm3.2, since strpack.jl dlopen's it
++
++ -- Sébastien Villemot <sebastien@debian.org> Wed, 03 Apr 2013 17:03:39 +0200
++
++julia (0.1.2+dfsg-1) unstable; urgency=low
++
++ * Imported Upstream version 0.1.2+dfsg.
++ Contains hotfix for package manager.
++ * debian/patches/fix-version.patch: new patch
++ * Refresh other patches
++
++ -- Sébastien Villemot <sebastien@debian.org> Thu, 07 Mar 2013 20:50:18 +0100
++
++julia (0.1.1+dfsg-1) unstable; urgency=low
++
++ * Imported Upstream version 0.1.1+dfsg
++ * debian/copyright: reflect upstream changes
++ * Refresh patches
++ * Disable tk-wrapper, since it is no longer built upstream
++ * Update README.debian
++
++ -- Sébastien Villemot <sebastien@debian.org> Thu, 07 Mar 2013 12:14:59 +0100
++
++julia (0.1+dfsg-1) unstable; urgency=low
++
++ * First upstream release!
++ * debian/copyright: document how to recreate orig tarball
++ * Add a debian/watch file
++ * d/rules, d/p/no-git-patch: adapt for numbered releases.
++ In particular, add a COMMITSHA file in the orig tarball containing the
++ SHA of the release tag.
++ * Promote zlib1g and libarpack2 to Depends
++ * Fix typo in manpage
++
++ -- Sébastien Villemot <sebastien@debian.org> Thu, 14 Feb 2013 12:00:05 +0100
++
++julia (0.1~20130213.git4bc33bbc-1) unstable; urgency=low
++
++ * New upstream release candidate.
++ Hopefully obviates the need of ugly hacks in libuv in order to build on
++ build daemons.
++ * Remove obsolete patches:
++ + bump-version-0.1.patch
++ + disable-final-uv-loop.patch
++ + revert-stdin-file-iostream.patch
++ * Refresh other patches
++
++ -- Sébastien Villemot <sebastien@debian.org> Wed, 13 Feb 2013 10:58:23 +0100
++
++julia (0.1~20130212.gitf375d4bb-1) unstable; urgency=low
++
++ * New upstream snapshot.
++ * no-git.patch: simplify and improve patch
++ * gsvddense_blasint.patch: remove patch, applied upstream
++ * New patches:
++ + bump-version-0.1.patch
++ + disable-final-uv-loop.patch
++ + revert-stdin-file-iostream.patch
++ * Refresh other patches
++
++ -- Sébastien Villemot <sebastien@debian.org> Tue, 12 Feb 2013 12:02:24 +0100
++
++julia (0.1~20130211.git86fbe98d-1) unstable; urgency=low
++
++ * New upstream snapshot.
++ * debian/control:
++ + add git to Recommends (for Julia package manager)
++ + remove dependencies on libglpk-dev (it moved to its own package)
++ + add explicit dependency on libgmp10 (there is no more a wrapper)
++ * fix-clean-rules.patch: remove patch, applied upstream
++ * gsvddense_blasint.patch: new patch
++ * Refresh other patches
++
++ -- Sébastien Villemot <sebastien@debian.org> Mon, 11 Feb 2013 03:51:26 +0100
++
++julia (0.0.0+20130206.git32ff5759-1) unstable; urgency=low
++
++ * New upstream snapshot.
++ * debian/copyright: reflect upstream changes
++ * debian/rules: update get-orig-source to reflect upstream changes
++ + Don't ship nginx
++ + Adapt for new configure-random target in deps/Makefile
++ * Enable build of Tk wrapper.
++ + debian/control: add build dependency on tk-dev
++ + debian/rules: add tk rule to build-arch
++ * debian/julia.install: install VERSION and COMMIT files
++ * no-webrepl.patch: new patch
++ * Refresh other patches
++ * Add source override for config.status file under deps/random/
++
++ -- Sébastien Villemot <sebastien@debian.org> Wed, 06 Feb 2013 17:54:29 +0100
++
++julia (0.0.0+20130107.gitd9656f41-2) unstable; urgency=low
++
++ * fix-cpu-detection.patch: do not use -momit-leaf-frame-pointer on non-x86
++ archs
++ * Upgrade to LLVM 3.2.
++ + debian/control: bump build-dependency
++ + debian/rules: use llvm-config-3.2
++ + debian/patches/use-shared-llvm.patch
++ debian/patches/use-sonames-with-dlopen.patch: update patches
++
++ -- Sébastien Villemot <sebastien@debian.org> Sat, 19 Jan 2013 15:33:43 +0100
++
++julia (0.0.0+20130107.gitd9656f41-1) unstable; urgency=low
++
++ * New upstream snashot
++ * No longer try to rebuild helpdb.jl.
++ + debian/rules: remove helpdb.jl from build-arch rule
++ + debian/control: move back python-sphinx to Build-Depends-Indep
++ * debian/copyright: reflect upstream changes
++ * Add Build-Conflicts on libatlas3-base (makes linalg tests fail)
++ * debian/rules: replace obsolete USE_DEBIAN makeflag by a list of
++ USE_SYSTEM_* flags
++ * debian/rules: on non-x86 systems, use libm instead of openlibm
++ * dpkg-buildflags.patch: remove patch, applied upstream
++ * Refreshed other patches
++
++ -- Sébastien Villemot <sebastien@debian.org> Wed, 16 Jan 2013 12:29:42 +0100
++
++julia (0.0.0+20121214.gitdced1f7-1) unstable; urgency=low
++
++ * New upstream snapshot.
++ * debian/copyright: reflect upstream changes
++ * Embedded libuv no longer uses libc-ares and libev.
++ + debian/control: remove them from build-dependencies
++ + debian/rules: no longer strip them from upstream tarball
++ + use-system-{ev,c-ares}.patch: remove patches
++ * Remove other patches merged upstream or no longer necessary
++ + fhs-multiarch.patch
++ + linalg-test-tolerance.patch
++ + remove-rpath.patch
++ + verbose-build.patch
++ * New patches
++ + do-not-download-patchelf.patch
++ + ld-library-path-for-testing.patch
++ + dpkg-multiarch.patch
++ + libjulia-release-drop-soname.patch
++ * Refresh other patches
++ * debian/rules:
++ + compile with MULTIARCH_INSTALL=1
++ + build helpdb.jl as part of the build-arch rule
++ + abort on failures in extra tests
++ * debian/control: move python-sphinx to Build-Depends (now used in build-arch)
++
++ -- Sébastien Villemot <sebastien@debian.org> Tue, 18 Dec 2012 14:42:23 +0100
++
++julia (0.0.0+20121102.git63e93f2-1) unstable; urgency=low
++
++ * Initial release. (Closes: #691912)
++
++ -- Sébastien Villemot <sebastien@debian.org> Fri, 02 Nov 2012 16:29:29 +0100
--- /dev/null
--- /dev/null
++deps/libuv/Makefile
++deps/libuv/config.log
++deps/libuv/config.status
++deps/libuv/libtool
++deps/libuv/libuv.pc
++src/*.dwo
++base/version_git.jl
--- /dev/null
--- /dev/null
++11
--- /dev/null
--- /dev/null
++Source: julia
++Section: science
++Homepage: https://julialang.org
++Priority: optional
++Standards-Version: 4.4.0
++Vcs-Git: https://salsa.debian.org/julia-team/julia.git
++Vcs-Browser: https://salsa.debian.org/julia-team/julia
++Maintainer: Debian Julia Team <pkg-julia-devel@lists.alioth.debian.org>
++Uploaders: Peter Colberg <peter@colberg.org>,
++ Graham Inggs <ginggs@debian.org>,
++ Mo Zhou <cdluminate@gmail.com>
++Build-Depends: curl,
++ debhelper (>= 11~),
++ dpkg-dev (>= 1.16.2~),
++ libcurl4-gnutls-dev | libcurl-dev,
++ libdsfmt-dev (>= 2.2.3),
++ libgit2-dev (>= 0.27.0~),
++ libgmp-dev,
++ libmbedtls-dev,
++ libmpfr-dev,
++ libopenlibm-dev (>= 0.4.1+dfsg-4~) [any-i386 any-amd64 arm64 armhf mips mips64el mipsel powerpc ppc64 ppc64el],
++ libpcre2-dev (>= 10.20-3~),
++ libunwind8-dev [!s390x],
++ libutf8proc-dev (>= 2.1.1),
++ llvm-8-dev,
++ openssl,
++ p7zip,
++ unicode-data,
++ gfortran,
++ libblas-dev | libblas.so,
++ liblapack-dev | liblapack.so,
++ zlib1g-dev,
++Build-Depends-Indep: fonts-lato,
++ latexmk,
++ python3-pkg-resources,
++ python3-pygments,
++ texlive,
++ texlive-extra-utils,
++ texlive-fonts-extra,
++ texlive-latex-base,
++ texlive-latex-extra,
++ texlive-latex-recommended,
++ texlive-luatex,
++ texlive-plain-generic
++
++Package: julia
++Architecture: any
++Multi-Arch: foreign
++Pre-Depends: ${misc:Pre-Depends}
++Depends: julia-common (= ${source:Version}),
++ libjulia1 (= ${binary:Version}),
++ ${misc:Depends},
++ ${shlibs:Depends}
++Replaces: julia-common (<< 0.5.0~)
++Breaks: julia-common (<< 0.5.0~)
++Suggests: ess (>= 12.09-1~), julia-doc, vim-julia
++Recommends: git, openssl
++Description: high-performance programming language for technical computing
++ Julia is a high-level, high-performance dynamic programming language for
++ technical computing, with syntax that is familiar to users of other technical
++ computing environments. It provides a sophisticated compiler, distributed
++ parallel execution, numerical accuracy, and an extensive mathematical function
++ library. The library, mostly written in Julia itself, also integrates mature,
++ best-of-breed C and Fortran libraries for linear algebra, random number
++ generation, FFTs, and string processing. Julia programs are organized around
++ defining functions, and overloading them for different combinations of
++ argument types (which can also be user-defined).
++ .
++ This package provides a complete Julia installation (JIT compiler, standard
++ library, text-based user interface).
++
++Package: libjulia1
++Section: libs
++Architecture: any
++Pre-Depends: ${misc:Pre-Depends}
++Replaces: julia (<< 0.5.0~), libjulia0.6, libjulia0.7
++Breaks: julia (<< 0.5.0~), libjulia0.6, libjulia0.7
++Depends: ${misc:Depends},
++ ${shlibs:Depends}
++Description: high-performance programming language for technical computing (runtime library)
++ Julia is a high-level, high-performance dynamic programming language for
++ technical computing, with syntax that is familiar to users of other technical
++ computing environments. It provides a sophisticated compiler, distributed
++ parallel execution, numerical accuracy, and an extensive mathematical function
++ library. The library, mostly written in Julia itself, also integrates mature,
++ best-of-breed C and Fortran libraries for linear algebra, random number
++ generation, FFTs, and string processing. Julia programs are organized around
++ defining functions, and overloading them for different combinations of
++ argument types (which can also be user-defined).
++ .
++ This package provides the Julia runtime library.
++
++Package: julia-common
++Architecture: all
++Multi-Arch: foreign
++Depends: ${misc:Depends}
++Replaces: julia (<< 0.4.1-1~)
++Breaks: julia (<< 0.4.1-1~)
++Recommends: julia
++Description: high-performance programming language for technical computing (common files)
++ Julia is a high-level, high-performance dynamic programming language for
++ technical computing, with syntax that is familiar to users of other technical
++ computing environments. It provides a sophisticated compiler, distributed
++ parallel execution, numerical accuracy, and an extensive mathematical function
++ library. The library, mostly written in Julia itself, also integrates mature,
++ best-of-breed C and Fortran libraries for linear algebra, random number
++ generation, FFTs, and string processing. Julia programs are organized around
++ defining functions, and overloading them for different combinations of
++ argument types (which can also be user-defined).
++ .
++ This package contains the Julia standard library and test suite.
++
++Package: libjulia-dev
++Section: libdevel
++Architecture: any
++Depends: libjulia1 (= ${binary:Version}), ${misc:Depends}
++Description: high-performance programming language for technical computing (development)
++ Julia is a high-level, high-performance dynamic programming language for
++ technical computing, with syntax that is familiar to users of other technical
++ computing environments. It provides a sophisticated compiler, distributed
++ parallel execution, numerical accuracy, and an extensive mathematical function
++ library. The library, mostly written in Julia itself, also integrates mature,
++ best-of-breed C and Fortran libraries for linear algebra, random number
++ generation, FFTs, and string processing. Julia programs are organized around
++ defining functions, and overloading them for different combinations of
++ argument types (which can also be user-defined).
++ .
++ This package provides the Julia runtime headers.
++
++Package: julia-doc
++Architecture: all
++Multi-Arch: foreign
++Section: doc
++Depends: fonts-font-awesome,
++ fonts-inconsolata,
++ libjs-highlight.js,
++ libjs-jquery,
++ libjs-jquery-ui,
++ libjs-lodash,
++ libjs-mathjax,
++ libjs-requirejs,
++ node-highlight.js,
++ node-normalize.css,
++ ${misc:Depends}
++Suggests: julia
++Description: high-performance programming language for technical computing (documentation)
++ Julia is a high-level, high-performance dynamic programming language for
++ technical computing, with syntax that is familiar to users of other technical
++ computing environments. It provides a sophisticated compiler, distributed
++ parallel execution, numerical accuracy, and an extensive mathematical function
++ library. The library, mostly written in Julia itself, also integrates mature,
++ best-of-breed C and Fortran libraries for linear algebra, random number
++ generation, FFTs, and string processing. Julia programs are organized around
++ defining functions, and overloading them for different combinations of
++ argument types (which can also be user-defined).
++ .
++ This package contains the Julia manual, which describes the language and its
++ standard library. It also contains example Julia programs.
--- /dev/null
--- /dev/null
++Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
++Upstream-Name: Julia
++Source: https://julialang.org
++Files-Excluded:
++ contrib/windows/*
++
++Files: *
++Copyright: 2009-2016 Jeff Bezanson, Stefan Karpinski, Viral B. Shah
++ and other contributors: https://github.com/JuliaLang/julia/contributors
++License: Expat
++
++Files: base/grisu/bignum.jl
++ base/grisu/bignums.jl
++ base/grisu/fastfixed.jl
++ base/grisu/fastprecision.jl
++ base/grisu/fastshortest.jl
++ base/grisu/float.jl
++Copyright: 2006-2014, the V8 project authors.
++License: BSD-3-clause
++
++Files: base/special/exp.jl
++ base/special/hyperbolic.jl
++ base/special/rem_pio2.jl
++ base/special/trig.jl
++Copyright: 1993, 2004, Sun Microsystems, Inc.
++ 2009-2016 Jeff Bezanson, Stefan Karpinski, Viral B. Shah
++ and other contributors: https://github.com/JuliaLang/julia/contributors
++License: Expat
++
++Files: stdlib/REPL/src/TerminalMenus/*
++Copyright: 2017 Nick Paul
++License: Expat
++
++Files: stdlib/SHA/*
++Copyright: 2014 Elliot Saba
++License: Expat
++
++Files: contrib/julia.appdata.xml
++Copyright: 2014, Paul Lange <palango@gmx.de>
++License: CC-BY-SA-3.0
++
++Files: src/abi_llvm.cpp
++ src/abi_ppc64le.cpp
++ src/abi_win32.cpp
++ src/abi_win64.cpp
++ src/abi_x86.cpp
++ src/abi_x86_64.cpp
++Copyright: 2007-2012, LDC Team.
++License: BSD-3-clause
++
++Files: src/support/END.h
++ src/support/ENTRY.amd64.h
++ src/support/ENTRY.i387.h
++ src/support/_longjmp.win32.S
++ src/support/_setjmp.win32.S
++Copyright: 1990, The Regents of the University of California. / William Jolitz
++License: BSD-3-clause
++
++Files: src/support/MurmurHash3.c
++ src/support/MurmurHash3.h
++Copyright: none
++License: public-domain-murmurhash
++ MurmurHash3 was written by Austin Appleby, and is placed in the public
++ domain. The author hereby disclaims copyright to this source code.
++
++Files: src/support/asprintf.c
++Copyright: 1997 Todd C. Miller <Todd.Miller AT courtesan.com>
++ 2004 Darren Tucker
++License: ISC
++
++Files: src/flisp/flisp.c
++ src/flisp/system.lsp
++Copyright: 2009 Jeff Bezanson
++License: BSD-3-clause
++
++Files: src/support/dirname.c
++Copyright: 2012, 2013 MinGW.org project
++License: Expat
++
++Files: src/getopt.c
++ src/getopt.h
++Copyright: 2005-2014, Rich Felker, et al.
++License: Expat
++
++Files: src/support/strptime.c
++Copyright: 1997-1998, 2005, 2008, The NetBSD Foundation, Inc.
++License: BSD-2-clause
++
++Files: src/disasm.cpp
++Copyright: 2009-2016 Jeff Bezanson, Stefan Karpinski, Viral B. Shah
++License: Expat
++Comment: Original code comes from The LLVM Compiler Infrastructure.
++ Modified by Julia developers.
++
++Files: src/support/strtod.c
++Copyright: 2009-2016 Jeff Bezanson, Stefan Karpinski, Viral B. Shah
++License: Expat
++Comment: Portions derived from the Python function _PyOS_ascii_strtod
++ Copyright 2001-2014 Python Software Foundation
++
++Files: src/crc32c.c
++Copyright: 2013, Mark Adler <madler@alumni.caltech.edu>
++License: Zlib
++
++Files: src/support/tzfile.h
++Copyright: NONE
++License: public-domain-tzfile
++ This file is in the public domain,
++ so clarified as of 1996-06-05 by Arthur David Olson.
++
++Files: deps/gfortblas.c
++Copyright: 2013 JuliaLang Project / Jameson Nash
++License: Expat
++
++Files: deps/valgrind/valgrind.h
++Copyright: 2000-2013, Julian Seward.
++License: BSD-3-clause
++
++Files: deps/patches/llvm-D31524-sovers_4.0.patch
++Copyright: 2017 Rebecca N. Palmer <rebecca_palmer@zoho.com>
++ 2017 Lisandro Damían Nicanor Pérez Meyer <lisandro@debian.org>
++ 2017 Sylvestre Ledru <sylvestre@debian.org>
++License: U-OF-I-BSD-LIKE
++Comment: License copied from Sylvestre Ledru <sylvestre@debian.org>'s
++ copyright file from llvm-toolchain-4.0 source.
++
++Files: debian/*
++Copyright: 2012-2015 Sébastien Villemot <sebastien@debian.org>
++ 2015-2017 Graham Inggs <ginggs@debian.org>
++ 2015-2017 Peter Colberg <peter@colberg.org>
++ 2018 Mo Zhou <cdluminate@gmail.com>
++License: Expat
++
++Files: debian/embedded/Pkg*
++Copyright: 2017 Stefan Karpinski
++ 2017 SimonDanisch
++ 2016 Art Wild
++License: Expat
++
++Files: debian/embedded/DocStringExtensions.jl*/*
++Copyright: 2016 Michael Hatherly
++License: Expat
++
++Files: debian/embedded/Documenter.jl*/*
++Copyright: 2016 Michael Hatherly
++License: Expat
++Comment:
++ Files: debian/embedded/Documenter.jl*/assets/html/search.js
++ Copyright: Steven Levithan <stevenlevithan.com>
++ License: Expat
++
++# Just a tiny library written for Julia. Maybe no need to package separately.
++Files: debian/embedded/libwhich-81e9723c0273d78493dc8c8ed570f68d9ce7e89e.tar.gz
++Copyright: 2017 Jameson Nash
++License: Expat
++
++Files: debian/embedded/libuv-ed3700c849289ed01fe04273a7bf865340b2bd7e.tar.gz
++Copyright: Joyent, Inc. and other Node contributors
++ 2013 Ben Noordhuis <info@bnoordhuis.nl>
++ StrongLoop, Inc.
++License: Expat
++Comment: Copyright for files contained in this tarball
++ Files: docs/src/sphinx-plugins/manpage.py
++ Copyright: 2013, Dariusz Dwornikowski.
++ License: Apache-2.0
++ .
++ Files: config.guess
++ config.sub
++ Copyright: 1992-2014, Free Software Foundation, Inc.
++ License: GPL-3+
++ .
++ Files: include/pthread-fixes.h
++ src/unix/pthread-fixes.c
++ Copyright: 2012, Google Inc.
++ 2013, Sony Mobile Communications AB
++ License: BSD-3-clause
++ .
++ Files: Makefile.am
++ Makefile.mingw
++ autogen.sh
++ checksparse.sh
++ configure.ac
++ src/heap-inl.h
++ src/queue.h
++ src/unix/atomic-ops.h
++ src/unix/spinlock.h
++ test/test-loop-configure.c
++ test/test-pipe-set-non-blocking.c
++ Copyright: 2013-2015, Ben Noordhuis <info@bnoordhuis.nl>
++ License: ISC
++ .
++ Files: samples/socks5-proxy/Makefile
++ samples/socks5-proxy/build.gyp
++ samples/socks5-proxy/client.c
++ samples/socks5-proxy/defs.h
++ samples/socks5-proxy/main.c
++ samples/socks5-proxy/s5.c
++ samples/socks5-proxy/s5.h
++ samples/socks5-proxy/server.c
++ samples/socks5-proxy/util.c
++ Copyright: StrongLoop, Inc.
++ License: Expat
++ .
++ Files: test/test-pipe-connect-multiple.c
++ test/test-pipe-connect-prepare.c
++ test/test-pipe-pending-instances.c
++ test/test-tcp-create-socket-early.c
++ test/test-udp-create-socket-early.c
++ Copyright: 2015 Saúl Ibarra Corretgé <saghul@gmail.com>.
++ License: Expat
++ .
++ Files: ar-lib
++ compile
++ depcomp
++ ltmain.sh
++ missing
++ Copyright: 1996-2014, Free Software Foundation, Inc.
++ License: GPL-2+
++ .
++ Files: m4/ltoptions.m4
++ m4/ltsugar.m4
++ m4/lt~obsolete.m4
++ Copyright: 2004-2015, Free Software Foundation, Inc.
++ License: FSFULLR
++ .
++ Files: src/inet.c
++ Copyright: 2004 Internet Systems Consortium, Inc. ("ISC")
++ 1996-1999 Internet Software Consortium
++ License: ISC
++ .
++ Files: include/stdint-msvc2008.h
++ Copyright: 2006-2008 Alexander Chemeris
++ License: BSD-3-clause
++ .
++ Files: samples/socks5-proxy/getopt.c
++ Copyright: 1987, 1993, 1994 The Regents of the University of California / NetBSD
++ License: BSD-3-clause
++ .
++ Files: include/tree.h
++ Copyright: 2002 Niels Provos <provos@citi.umich.edu>
++ License: BSD-2-clause
++ .
++ Files: include/android-ifaddrs.h
++ src/unix/android-ifaddrs.c
++ Copyright: 1995, 1999 Berkeley Software Design, Inc.
++ 2013 Kenneth MacKay
++ 2014 Emergya (Cloud4all, FP7/2007-2013 grant agreement n° 289016)
++ License: BSD-2-clause
++
++Files: debian/embedded/openblas*
++Copyright: 2011-2018 The OpenBLAS Project
++ 2009-2010 The University of Texas at Austin
++ 2013 Martin Koehler, grisuthedragon@users.github.com
++License: BSD-3-clause
++Comment: Copied from /usr/share/doc/libopenblas-base/copyright
++ .
++ Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
++ Upstream-Name: OpenBLAS
++ Upstream-Contact: Zhang Xianyi <traits.zhang@gmail.com>
++ Source: https://github.com/xianyi/OpenBLAS
++ Files-Excluded: lapack-netlib/*
++ relapack/*
++ .
++ Files: *
++ Copyright: 2011-2018 The OpenBLAS Project
++ 2009-2010 The University of Texas at Austin
++ 2013 Martin Koehler, grisuthedragon@users.github.com
++ License: BSD-3-clause
++ Redistribution and use in source and binary forms, with or without
++ modification, are permitted provided that the following conditions are
++ met:
++ .
++ 1. Redistributions of source code must retain the above copyright
++ notice, this list of conditions and the following disclaimer.
++ .
++ 2. Redistributions in binary form must reproduce the above copyright
++ notice, this list of conditions and the following disclaimer in
++ the documentation and/or other materials provided with the
++ distribution.
++ 3. Neither the name of the OpenBLAS project nor the names of
++ its contributors may be used to endorse or promote products
++ derived from this software without specific prior written
++ permission.
++ .
++ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
++ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
++ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
++ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
++ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
++ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
++ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
++ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
++ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
++ USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
++ .
++ Files: benchmark/cholesky.c
++ benchmark/linpack.c
++ benchmark/geev.c
++ benchmark/getri.c
++ benchmark/gesv.c
++ benchmark/potrf.c
++ common.h
++ common_alpha.h
++ common_ia64.h
++ common_interface.h
++ common_lapack.h
++ common_level1.h
++ common_level2.h
++ common_level3.h
++ common_linux.h
++ common_macro.h
++ common_param.h
++ common_power.h
++ common_sparc.h
++ common_thread.h
++ common_x86.h
++ common_x86_64.h
++ cpuid.h
++ cpuid_alpha.c
++ cpuid_ia64.c
++ cpuid_power.c
++ cpuid_sparc.c
++ cpuid_x86.c
++ driver/level2/gbmv_k.c
++ driver/level2/gbmv_thread.c
++ driver/level2/gemv_thread.c
++ driver/level2/ger_thread.c
++ driver/level2/sbmv_k.c
++ driver/level2/sbmv_thread.c
++ driver/level2/spmv_k.c
++ driver/level2/spmv_thread.c
++ driver/level2/spr2_k.c
++ driver/level2/spr2_thread.c
++ driver/level2/spr_k.c
++ driver/level2/spr_thread.c
++ driver/level2/symv_thread.c
++ driver/level2/syr2_k.c
++ driver/level2/syr2_thread.c
++ driver/level2/syr_k.c
++ driver/level2/syr_thread.c
++ driver/level2/tbmv_L.c
++ driver/level2/tbmv_U.c
++ driver/level2/tbmv_thread.c
++ driver/level2/tbsv_L.c
++ driver/level2/tbsv_U.c
++ driver/level2/tpmv_L.c
++ driver/level2/tpmv_U.c
++ driver/level2/tpmv_thread.c
++ driver/level2/tpsv_L.c
++ driver/level2/tpsv_U.c
++ driver/level2/trmv_L.c
++ driver/level2/trmv_U.c
++ driver/level2/trmv_thread.c
++ driver/level2/trsv_L.c
++ driver/level2/trsv_U.c
++ driver/level2/zgbmv_k.c
++ driver/level2/zhbmv_k.c
++ driver/level2/zher2_k.c
++ driver/level2/zher_k.c
++ driver/level2/zhpmv_k.c
++ driver/level2/zhpr2_k.c
++ driver/level2/zhpr_k.c
++ driver/level2/zsbmv_k.c
++ driver/level2/zspmv_k.c
++ driver/level2/zspr2_k.c
++ driver/level2/zspr_k.c
++ driver/level2/zsyr2_k.c
++ driver/level2/zsyr_k.c
++ driver/level2/ztbmv_L.c
++ driver/level2/ztbmv_U.c
++ driver/level2/ztbsv_L.c
++ driver/level2/ztbsv_U.c
++ driver/level2/ztpmv_L.c
++ driver/level2/ztpmv_U.c
++ driver/level2/ztpsv_L.c
++ driver/level2/ztpsv_U.c
++ driver/level2/ztrmv_L.c
++ driver/level2/ztrmv_U.c
++ driver/level2/ztrsv_L.c
++ driver/level2/ztrsv_U.c
++ driver/level3/gemm.c
++ driver/level3/gemm3m.c
++ driver/level3/gemm_thread_m.c
++ driver/level3/gemm_thread_mn.c
++ driver/level3/gemm_thread_n.c
++ driver/level3/gemm_thread_variable.c
++ driver/level3/level3_gemm3m_thread.c
++ driver/level3/level3_syrk_threaded.c
++ driver/level3/level3_thread.c
++ driver/level3/symm_k.c
++ driver/level3/syr2k_k.c
++ driver/level3/syr2k_kernel.c
++ driver/level3/syrk_k.c
++ driver/level3/syrk_kernel.c
++ driver/level3/syrk_thread.c
++ driver/level3/trmm_L.c
++ driver/level3/trmm_R.c
++ driver/level3/trsm_L.c
++ driver/level3/trsm_R.c
++ driver/level3/zhemm_k.c
++ driver/level3/zher2k_k.c
++ driver/level3/zher2k_kernel.c
++ driver/level3/zherk_beta.c
++ driver/level3/zherk_k.c
++ driver/level3/zherk_kernel.c
++ driver/level3/zsyrk_beta.c
++ driver/mapper/mapper.c
++ driver/others/abs.c
++ driver/others/blas_l1_thread.c
++ driver/others/blas_server_omp.c
++ driver/others/blas_server_win32.c
++ driver/others/divtable.c
++ driver/others/dynamic.c
++ driver/others/dynamic_arm64.c
++ driver/others/lamc3.c
++ driver/others/lamch.c
++ driver/others/lsame.c
++ driver/others/memory_qalloc.c
++ driver/others/parameter.c
++ driver/others/profile.c
++ driver/others/xerbla.c
++ exports/dllinit.c
++ interface/asum.c
++ interface/axpy.c
++ interface/copy.c
++ interface/dot.c
++ interface/dsdot.c
++ interface/gbmv.c
++ interface/geadd.c
++ interface/gemm.c
++ interface/gemv.c
++ interface/ger.c
++ interface/imax.c
++ interface/lapack/gesv.c
++ interface/lapack/getf2.c
++ interface/lapack/getrf.c
++ interface/lapack/getrs.c
++ interface/lapack/laswp.c
++ interface/lapack/lauu2.c
++ interface/lapack/lauum.c
++ interface/lapack/potf2.c
++ interface/lapack/potrf.c
++ interface/lapack/potri.c
++ interface/lapack/trti2.c
++ interface/lapack/trtri.c
++ interface/lapack/zgetf2.c
++ interface/lapack/zgetrf.c
++ interface/lapack/zgetrs.c
++ interface/lapack/zlaswp.c
++ interface/lapack/zlauu2.c
++ interface/lapack/zlauum.c
++ interface/lapack/zpotf2.c
++ interface/lapack/zpotrf.c
++ interface/lapack/zpotri.c
++ interface/lapack/ztrti2.c
++ interface/lapack/ztrtri.c
++ interface/max.c
++ interface/nrm2.c
++ interface/rot.c
++ interface/sbmv.c
++ interface/scal.c
++ interface/sdsdot.c
++ interface/spmv.c
++ interface/spr.c
++ interface/spr2.c
++ interface/swap.c
++ interface/symm.c
++ interface/symv.c
++ interface/syr.c
++ interface/syr2.c
++ interface/syr2k.c
++ interface/syrk.c
++ interface/tbmv.c
++ interface/tbsv.c
++ interface/tpmv.c
++ interface/tpsv.c
++ interface/trmv.c
++ interface/trsm.c
++ interface/trsv.c
++ interface/zaxpy.c
++ interface/zdot.c
++ interface/zgbmv.c
++ interface/zgeadd.c
++ interface/zgemv.c
++ interface/zger.c
++ interface/zhbmv.c
++ interface/zhemv.c
++ interface/zher.c
++ interface/zher2.c
++ interface/zhpmv.c
++ interface/zhpr.c
++ interface/zhpr2.c
++ interface/zrot.c
++ interface/zsbmv.c
++ interface/zscal.c
++ interface/zspmv.c
++ interface/zspr.c
++ interface/zspr2.c
++ interface/zswap.c
++ interface/zsymv.c
++ interface/zsyr.c
++ interface/zsyr2.c
++ interface/ztbmv.c
++ interface/ztbsv.c
++ interface/ztpmv.c
++ interface/ztpsv.c
++ interface/ztrmv.c
++ interface/ztrsv.c
++ kernel/generic/cabs.c
++ kernel/generic/gemm_beta.c
++ kernel/generic/gemm_ncopy_1.c
++ kernel/generic/gemm_ncopy_16.c
++ kernel/generic/gemm_ncopy_2.c
++ kernel/generic/gemm_ncopy_4.c
++ kernel/generic/gemm_ncopy_6.c
++ kernel/generic/gemm_ncopy_8.c
++ kernel/generic/gemm_tcopy_1.c
++ kernel/generic/gemm_tcopy_16.c
++ kernel/generic/gemm_tcopy_2.c
++ kernel/generic/gemm_tcopy_4.c
++ kernel/generic/gemm_tcopy_6.c
++ kernel/generic/gemm_tcopy_8.c
++ kernel/generic/ger.c
++ kernel/generic/laswp_ncopy_1.c
++ kernel/generic/laswp_ncopy_2.c
++ kernel/generic/laswp_ncopy_4.c
++ kernel/generic/laswp_ncopy_8.c
++ kernel/generic/lsame.c
++ kernel/generic/neg_tcopy_1.c
++ kernel/generic/neg_tcopy_16.c
++ kernel/generic/neg_tcopy_2.c
++ kernel/generic/neg_tcopy_4.c
++ kernel/generic/neg_tcopy_8.c
++ kernel/generic/symm_lcopy_1.c
++ kernel/generic/symm_lcopy_16.c
++ kernel/generic/symm_lcopy_2.c
++ kernel/generic/symm_lcopy_4.c
++ kernel/generic/symm_lcopy_6.c
++ kernel/generic/symm_lcopy_8.c
++ kernel/generic/symm_ucopy_1.c
++ kernel/generic/symm_ucopy_16.c
++ kernel/generic/symm_ucopy_2.c
++ kernel/generic/symm_ucopy_4.c
++ kernel/generic/symm_ucopy_6.c
++ kernel/generic/symm_ucopy_8.c
++ kernel/generic/symv_k.c
++ kernel/generic/trmm_lncopy_1.c
++ kernel/generic/trmm_lncopy_16.c
++ kernel/generic/trmm_lncopy_2.c
++ kernel/generic/trmm_lncopy_4.c
++ kernel/generic/trmm_lncopy_6.c
++ kernel/generic/trmm_lncopy_8.c
++ kernel/generic/trmm_ltcopy_1.c
++ kernel/generic/trmm_ltcopy_16.c
++ kernel/generic/trmm_ltcopy_2.c
++ kernel/generic/trmm_ltcopy_4.c
++ kernel/generic/trmm_ltcopy_6.c
++ kernel/generic/trmm_ltcopy_8.c
++ kernel/generic/trmm_uncopy_1.c
++ kernel/generic/trmm_uncopy_16.c
++ kernel/generic/trmm_uncopy_2.c
++ kernel/generic/trmm_uncopy_4.c
++ kernel/generic/trmm_uncopy_6.c
++ kernel/generic/trmm_uncopy_8.c
++ kernel/generic/trmm_utcopy_1.c
++ kernel/generic/trmm_utcopy_16.c
++ kernel/generic/trmm_utcopy_2.c
++ kernel/generic/trmm_utcopy_4.c
++ kernel/generic/trmm_utcopy_6.c
++ kernel/generic/trmm_utcopy_8.c
++ kernel/generic/trsm_kernel_LN.c
++ kernel/generic/trsm_kernel_LT.c
++ kernel/generic/trsm_kernel_RN.c
++ kernel/generic/trsm_kernel_RT.c
++ kernel/generic/trsm_lncopy_1.c
++ kernel/generic/trsm_lncopy_16.c
++ kernel/generic/trsm_lncopy_2.c
++ kernel/generic/trsm_lncopy_4.c
++ kernel/generic/trsm_lncopy_6.c
++ kernel/generic/trsm_lncopy_8.c
++ kernel/generic/trsm_ltcopy_1.c
++ kernel/generic/trsm_ltcopy_16.c
++ kernel/generic/trsm_ltcopy_2.c
++ kernel/generic/trsm_ltcopy_4.c
++ kernel/generic/trsm_ltcopy_6.c
++ kernel/generic/trsm_ltcopy_8.c
++ kernel/generic/trsm_uncopy_1.c
++ kernel/generic/trsm_uncopy_16.c
++ kernel/generic/trsm_uncopy_2.c
++ kernel/generic/trsm_uncopy_4.c
++ kernel/generic/trsm_uncopy_6.c
++ kernel/generic/trsm_uncopy_8.c
++ kernel/generic/trsm_utcopy_1.c
++ kernel/generic/trsm_utcopy_16.c
++ kernel/generic/trsm_utcopy_2.c
++ kernel/generic/trsm_utcopy_4.c
++ kernel/generic/trsm_utcopy_6.c
++ kernel/generic/trsm_utcopy_8.c
++ kernel/generic/zgemm3m_ncopy_1.c
++ kernel/generic/zgemm3m_ncopy_2.c
++ kernel/generic/zgemm3m_ncopy_4.c
++ kernel/generic/zgemm3m_ncopy_8.c
++ kernel/generic/zgemm3m_tcopy_1.c
++ kernel/generic/zgemm3m_tcopy_2.c
++ kernel/generic/zgemm3m_tcopy_4.c
++ kernel/generic/zgemm3m_tcopy_8.c
++ kernel/generic/zgemm_beta.c
++ kernel/generic/zgemm_ncopy_1.c
++ kernel/generic/zgemm_ncopy_2.c
++ kernel/generic/zgemm_ncopy_4.c
++ kernel/generic/zgemm_ncopy_8.c
++ kernel/generic/zgemm_tcopy_1.c
++ kernel/generic/zgemm_tcopy_2.c
++ kernel/generic/zgemm_tcopy_4.c
++ kernel/generic/zgemm_tcopy_8.c
++ kernel/generic/zger.c
++ kernel/generic/zhemm3m_lcopy_1.c
++ kernel/generic/zhemm3m_lcopy_2.c
++ kernel/generic/zhemm3m_lcopy_4.c
++ kernel/generic/zhemm3m_lcopy_8.c
++ kernel/generic/zhemm3m_ucopy_1.c
++ kernel/generic/zhemm3m_ucopy_2.c
++ kernel/generic/zhemm3m_ucopy_4.c
++ kernel/generic/zhemm3m_ucopy_8.c
++ kernel/generic/zhemm_ltcopy_1.c
++ kernel/generic/zhemm_ltcopy_2.c
++ kernel/generic/zhemm_ltcopy_4.c
++ kernel/generic/zhemm_ltcopy_8.c
++ kernel/generic/zhemm_utcopy_1.c
++ kernel/generic/zhemm_utcopy_2.c
++ kernel/generic/zhemm_utcopy_4.c
++ kernel/generic/zhemm_utcopy_8.c
++ kernel/generic/zhemv_k.c
++ kernel/generic/zlaswp_ncopy_1.c
++ kernel/generic/zlaswp_ncopy_2.c
++ kernel/generic/zlaswp_ncopy_4.c
++ kernel/generic/zneg_tcopy_1.c
++ kernel/generic/zneg_tcopy_2.c
++ kernel/generic/zneg_tcopy_4.c
++ kernel/generic/zneg_tcopy_8.c
++ kernel/generic/zsymm3m_lcopy_1.c
++ kernel/generic/zsymm3m_lcopy_2.c
++ kernel/generic/zsymm3m_lcopy_4.c
++ kernel/generic/zsymm3m_lcopy_8.c
++ kernel/generic/zsymm3m_ucopy_1.c
++ kernel/generic/zsymm3m_ucopy_2.c
++ kernel/generic/zsymm3m_ucopy_4.c
++ kernel/generic/zsymm3m_ucopy_8.c
++ kernel/generic/zsymm_lcopy_1.c
++ kernel/generic/zsymm_lcopy_2.c
++ kernel/generic/zsymm_lcopy_4.c
++ kernel/generic/zsymm_lcopy_8.c
++ kernel/generic/zsymm_ucopy_1.c
++ kernel/generic/zsymm_ucopy_2.c
++ kernel/generic/zsymm_ucopy_4.c
++ kernel/generic/zsymm_ucopy_8.c
++ kernel/generic/zsymv_k.c
++ kernel/generic/ztrmm_lncopy_1.c
++ kernel/generic/ztrmm_lncopy_2.c
++ kernel/generic/ztrmm_lncopy_4.c
++ kernel/generic/ztrmm_lncopy_8.c
++ kernel/generic/ztrmm_ltcopy_1.c
++ kernel/generic/ztrmm_ltcopy_2.c
++ kernel/generic/ztrmm_ltcopy_4.c
++ kernel/generic/ztrmm_ltcopy_8.c
++ kernel/generic/ztrmm_uncopy_1.c
++ kernel/generic/ztrmm_uncopy_2.c
++ kernel/generic/ztrmm_uncopy_4.c
++ kernel/generic/ztrmm_uncopy_8.c
++ kernel/generic/ztrmm_utcopy_1.c
++ kernel/generic/ztrmm_utcopy_2.c
++ kernel/generic/ztrmm_utcopy_4.c
++ kernel/generic/ztrmm_utcopy_8.c
++ kernel/generic/ztrsm_lncopy_1.c
++ kernel/generic/ztrsm_lncopy_2.c
++ kernel/generic/ztrsm_lncopy_4.c
++ kernel/generic/ztrsm_lncopy_8.c
++ kernel/generic/ztrsm_ltcopy_1.c
++ kernel/generic/ztrsm_ltcopy_2.c
++ kernel/generic/ztrsm_ltcopy_4.c
++ kernel/generic/ztrsm_ltcopy_8.c
++ kernel/generic/ztrsm_uncopy_1.c
++ kernel/generic/ztrsm_uncopy_2.c
++ kernel/generic/ztrsm_uncopy_4.c
++ kernel/generic/ztrsm_uncopy_8.c
++ kernel/generic/ztrsm_utcopy_1.c
++ kernel/generic/ztrsm_utcopy_2.c
++ kernel/generic/ztrsm_utcopy_4.c
++ kernel/generic/ztrsm_utcopy_8.c
++ kernel/power/lock.c
++ kernel/setparam-ref.c
++ kernel/x86_64/dger.c
++ kernel/x86_64/sger.c
++ kernel/x86_64/ctrsm_kernel_LN_bulldozer.c
++ kernel/x86_64/ctrsm_kernel_LT_bulldozer.c
++ kernel/x86_64/ctrsm_kernel_RN_bulldozer.c
++ kernel/x86_64/ctrsm_kernel_RT_bulldozer.c
++ kernel/x86_64/dgemm_beta_skylakex.c
++ kernel/x86_64/dgemm_kernel_16x2_skylakex.S
++ kernel/x86_64/dgemm_ncopy_8_skylakex.c
++ kernel/x86_64/dgemm_tcopy_8_skylakex.c
++ kernel/x86_64/dtrsm_kernel_LN_bulldozer.c
++ kernel/x86_64/dtrsm_kernel_RN_haswell.c
++ kernel/x86_64/dtrsm_kernel_RT_bulldozer.c
++ kernel/x86_64/sgemm_beta_skylakex.c
++ kernel/x86_64/sgemm_ncopy_4_skylakex.c
++ kernel/x86_64/sgemm_tcopy_16_skylakex.c
++ kernel/x86_64/strsm_kernel_LN_bulldozer.c
++ kernel/x86_64/strsm_kernel_LT_bulldozer.c
++ kernel/x86_64/strsm_kernel_RN_bulldozer.c
++ kernel/x86_64/strsm_kernel_RT_bulldozer.c
++ kernel/x86_64/ztrsm_kernel_LN_bulldozer.c
++ kernel/x86_64/ztrsm_kernel_LT_bulldozer.c
++ kernel/x86_64/ztrsm_kernel_RN_bulldozer.c
++ kernel/x86_64/ztrsm_kernel_RT_bulldozer.c
++ lapack/getf2/getf2_k.c
++ lapack/getf2/zgetf2_k.c
++ lapack/getrf/getrf_parallel.c
++ lapack/getrf/getrf_parallel_omp.c
++ lapack/getrf/getrf_single.c
++ lapack/getrf/potrf_parallel.c
++ lapack/getrs/getrs_parallel.c
++ lapack/getrs/getrs_single.c
++ lapack/getrs/zgetrs_parallel.c
++ lapack/getrs/zgetrs_single.c
++ lapack/laswp/generic/laswp_k.c
++ lapack/laswp/generic/laswp_k_1.c
++ lapack/laswp/generic/laswp_k_2.c
++ lapack/laswp/generic/laswp_k_4.c
++ lapack/laswp/generic/laswp_k_8.c
++ lapack/laswp/generic/zlaswp_k.c
++ lapack/laswp/generic/zlaswp_k_1.c
++ lapack/laswp/generic/zlaswp_k_2.c
++ lapack/laswp/generic/zlaswp_k_4.c
++ lapack/lauu2/lauu2_L.c
++ lapack/lauu2/lauu2_U.c
++ lapack/lauu2/zlauu2_L.c
++ lapack/lauu2/zlauu2_U.c
++ lapack/lauum/lauum_L_parallel.c
++ lapack/lauum/lauum_L_single.c
++ lapack/lauum/lauum_U_parallel.c
++ lapack/lauum/lauum_U_single.c
++ lapack/potf2/potf2_L.c
++ lapack/potf2/potf2_U.c
++ lapack/potf2/zpotf2_L.c
++ lapack/potf2/zpotf2_U.c
++ lapack/potrf/potrf_L_parallel.c
++ lapack/potrf/potrf_L_single.c
++ lapack/potrf/potrf_U_parallel.c
++ lapack/potrf/potrf_U_single.c
++ lapack/potrf/potrf_parallel.c
++ lapack/trti2/trti2_L.c
++ lapack/trti2/trti2_U.c
++ lapack/trti2/ztrti2_L.c
++ lapack/trti2/ztrti2_U.c
++ lapack/trtri/trtri_L_parallel.c
++ lapack/trtri/trtri_U_parallel.c
++ symcopy.h
++ driver/level3/gemm3m_level3.c
++ driver/level3/hemm3m_k.c
++ driver/level3/symm3m_k.c
++ driver/level3/level3.c
++ driver/level3/level3_syrk.c
++ driver/level3/level3_syr2k.c
++ Copyright: 2009-2010 The University of Texas at Austin
++ License: BSD-2-clause-texas
++ 1. Redistributions of source code must retain the above
++ copyright notice, this list of conditions and the following
++ disclaimer.
++ .
++ 2. Redistributions in binary form must reproduce the above
++ copyright notice, this list of conditions and the following
++ disclaimer in the documentation and/or other materials
++ provided with the distribution.
++ .
++ THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY OF TEXAS AT
++ AUSTIN ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
++ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
++ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
++ DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OF TEXAS AT
++ AUSTIN OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
++ INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
++ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
++ GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
++ BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
++ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
++ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
++ OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
++ POSSIBILITY OF SUCH DAMAGE.
++ .
++ The views and conclusions contained in the software and
++ documentation are those of the authors and should not be
++ interpreted as representing official policies, either expressed
++ or implied, of The University of Texas at Austin.
++ .
++ Files: ctest/* reference/* test/*
++ Copyright: none
++ License: public-domain
++ These files come from netlib.org and are in the public domain.
++ .
++ Files: utest/ctest.h
++ Copyright: 2011-2016 Bas van den Berg
++ License: Apache-2.0
++ Licensed under the Apache License, Version 2.0 (the "License");
++ you may not use this file except in compliance with the License.
++ You may obtain a copy of the License at
++ .
++ http://www.apache.org/licenses/LICENSE-2.0
++ .
++ Unless required by applicable law or agreed to in writing, software
++ distributed under the License is distributed on an "AS IS" BASIS,
++ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
++ See the License for the specific language governing permissions and
++ limitations under the License.
++ .
++ On Debian systems, the complete text of the Apache License,
++ version 2.0, can be found in the file
++ `/usr/share/common-licenses/Apache-2.0'.
++
++Files: debian/embedded/SuiteSparse*
++Copyright: 1990-2017 Timothy A. Davis (http://www.suitesparse.com)
++ 2004-2018 University of Florida
++License: LGPL-2.1+
++Comment: The embedded tarball is gzip-compressed +dfsg.orig.tar.xz tarball.
++ Following information copied from
++ /usr/share/doc/libsuitesparseconfig5/copyright
++ .
++ Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
++ Upstream-Name: SuiteSparse
++ Upstream-Contact: Timothy A. Davis <davis@tamu.edu>
++ Source: http://www.suitesparse.com
++ Files-Excluded: GraphBLAS/Doc/GraphBLAS_API_C.pdf
++ Comment: GraphBLAS_API_C.pdf has been stripped out because its source code is
++ not provided. It is downloadable at http://graphblas.org, and contains the
++ API specification (version 1.1.0, Nov 17, 2017) that this version of GraphBLAS
++ conforms to.
++ .
++ Files: *
++ Copyright: 1990-2017 Timothy A. Davis (http://www.suitesparse.com)
++ 2004-2018 University of Florida
++ License: LGPL-2.1+
++ .
++ Files: AMD/*
++ Copyright: 1996-2015, Timothy A. Davis, Patrick R. Amestoy, and Iain S. Duff
++ License: BSD-3-clause
++ .
++ Files: CAMD/*
++ Copyright: 1994-2013 Timothy A. Davis, Yanqing Chen, Patrick R. Amestoy, and Iain S. Duff
++ License: BSD-3-clause
++ .
++ Files: CCOLAMD/*
++ Copyright: 2005-2016, Univ. of Florida
++ License: BSD-3-clause
++ .
++ Files: CHOLMOD/Supernodal/* CHOLMOD/Valgrind/* CHOLMOD/Demo/*
++ CHOLMOD/MATLAB/* CHOLMOD/MatrixOps/* CHOLMOD/Tcov/*
++ CHOLMOD/Modify/*
++ CHOLMOD/Include/cholmod_gpu.h
++ CHOLMOD/Include/cholmod_gpu_kernels.h
++ CHOLMOD/Include/cholmod_matrixops.h
++ CHOLMOD/Include/cholmod_modify.h
++ CHOLMOD/Include/cholmod_supernodal.h
++ Copyright: 2005-2015 Timothy A. Davis
++ 2005-2006 William W. Hager
++ License: GPL-2+
++ .
++ Files: CHOLMOD/Include/cholmod_function.h
++ Copyright: 2014 Timothy A. Davis
++ License: permissive
++ This specific file (CHOLMOD/Include/cholmod_function.h) has no license
++ restrictions at all. You may freely include this in your applications, and
++ modify it at will.
++ .
++ Files: COLAMD/*
++ Copyright: 1998-2016, Timothy A. Davis
++ License: BSD-3-clause
++ .
++ Files: CSparse/MATLAB/ssget/*
++ CXSparse/MATLAB/ssget/*
++ Copyright: 2009-2016 Timothy A. Davis
++ License: BSD-3-clause
++ .
++ Files: GraphBLAS/*
++ Copyright: 2017-2018 Timothy A. Davis
++ License: Apache-2.0
++ .
++ Files: GPUQREngine/*
++ Copyright: 2013 Timothy A. Davis, Sencer Nuri Yeralan, and Sanjay Ranka
++ License: GPL-2+
++ .
++ Files: MATLAB_Tools/*
++ Copyright: Timothy A. Davis
++ Les Foster
++ License: BSD-3-clause
++ .
++ Files: MATLAB_Tools/SSMULT/* MATLAB_Tools/SuiteSparseCollection/*
++ Copyright: 2007-2018 Timothy A. Davis, http://www.suitesparse.com.
++ License: GPL-2+
++ .
++ Files: MATLAB_Tools/SuiteSparseCollection/dsxy2figxy.m
++ Copyright: 2006-2007, The MathWorks, Inc
++ License: BSD-2-clause
++ Redistribution and use in source and binary forms, with or without
++ modification, are permitted provided that the following conditions are
++ met:
++ .
++ * Redistributions of source code must retain the above copyright
++ notice, this list of conditions and the following disclaimer.
++ * Redistributions in binary form must reproduce the above copyright
++ notice, this list of conditions and the following disclaimer in
++ the documentation and/or other materials provided with the distribution
++ .
++ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
++ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
++ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
++ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
++ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
++ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
++ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
++ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
++ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
++ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
++ POSSIBILITY OF SUCH DAMAGE.
++ Comment: http://www.mathworks.com/matlabcentral/fileexchange/30347-sigplot/content/sigplot/sigplot/BasicFunctions/dsxy2figxy.m
++ .
++ Files: Mongoose/*
++ Copyright: 2017-2018 Timothy A. Davis, Scott P. Kolodziej, William W. Hager, S. Nuri Yeralan
++ License: GPL-3+
++ .
++ Files: RBio/*
++ Copyright: 2006-2016 Timothy A. Davis, http://www.suitesparse.com
++ License: GPL-2+
++ .
++ Files: SPQR/*
++ Copyright: 2008-2016 Timothy A. Davis
++ 2013 Sencer Nuri Yeralan and Sanjay Ranka
++ License: GPL-2+
++ .
++ Files: SuiteSparse_GPURuntime/*
++ Copyright: 2013-2016 Timothy A. Davis, Sencer Nuri Yeralan, and Sanjay Ranka. http://www.suitesparse.com
++ License: GPL-2+
++ .
++ Files: SuiteSparse_config/* Mongoose/SuiteSparse_config/*
++ Copyright: 2012-2018 Timothy A. Davis
++ License: permissive-2
++ No licensing restrictions apply to this file or to the SuiteSparse_config
++ directory.
++ .
++ Files: ssget/*
++ Copyright: 2009-2016 Timothy A. Davis
++ License: BSD-3-clause
++ .
++ Files: UMFPACK/*
++ Copyright: 1995-2018 by Timothy A. Davis, http://www.suitesparse.com
++ License: GPL-2+
++ .
++ Files: metis-5.1.0/*
++ Copyright: 1995-2013, Regents of the University of Minnesota
++ License: Apache-2.0
++ .
++ Files: metis-5.1.0/GKlib/getopt.c
++ metis-5.1.0/GKlib/gk_mksort.h
++ metis-5.1.0/GKlib/gkregex.c
++ Copyright: 1987-2006 Free Software Foundation
++ License: LGPL-2.1+
++ .
++ Files: metis-5.1.0/GKlib/ms_inttypes.h
++ metis-5.1.0/GKlib/ms_stdint.h
++ Copyright: 2006 Alexander Chemeris
++ License: BSD-3-clause
++ .
++ Files: debian/*
++ Copyright: 2006-2015 Debian Science Team
++ 2013-2018 Sébastien Villemot <sebastien@debian.org>
++ License: GPL-3+
++ .
++ License: Apache-2.0
++ Licensed under the Apache License, Version 2.0 (the "License");
++ you may not use this file except in compliance with the License.
++ You may obtain a copy of the License at
++ .
++ http://www.apache.org/licenses/LICENSE-2.0
++ .
++ Unless required by applicable law or agreed to in writing, software
++ distributed under the License is distributed on an "AS IS" BASIS,
++ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
++ implied. See the License for the specific language governing
++ .
++ On Debian systems, the complete text of the Apache
++ License, version 2.0, can be found in the file
++ `/usr/share/common-licenses/Apache-2.0'.
++ .
++ License: BSD-3-clause
++ Redistribution and use in source and binary forms, with or without
++ modification, are permitted provided that the following conditions are met:
++ * Redistributions of source code must retain the above copyright
++ notice, this list of conditions and the following disclaimer.
++ * Redistributions in binary form must reproduce the above copyright
++ notice, this list of conditions and the following disclaimer in the
++ documentation and/or other materials provided with the distribution.
++ * Neither the name of the organizations to which the authors are
++ affiliated, nor the names of its contributors may be used to endorse
++ or promote products derived from this software without specific prior
++ written permission.
++ .
++ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
++ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
++ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
++ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
++ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
++ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
++ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
++ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
++ LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
++ OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
++ DAMAGE.
++ .
++ License: GPL-2+
++ This program is free software: you can redistribute it and/or
++ modify it under the terms of the GNU General Public License as
++ published by the Free Software Foundation, either version 2 of
++ the License, or (at your option) any later version.
++ .
++ This program is distributed in the hope that it will be useful,
++ but WITHOUT ANY WARRANTY; without even the implied warranty of
++ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
++ GNU General Public License for more details.
++ .
++ You should have received a copy of the GNU General Public License
++ along with this program. If not, see
++ <http://www.gnu.org/licenses/>.
++ .
++ On Debian systems, the complete text of the GNU General Public
++ License, version 2, can be found in the file
++ `/usr/share/common-licenses/GPL-2'.
++ .
++ License: GPL-3+
++ This program is free software: you can redistribute it and/or modify
++ it under the terms of the GNU General Public License as published by
++ the Free Software Foundation, either version 3 of the License, or
++ (at your option) any later version.
++ .
++ This program is distributed in the hope that it will be useful,
++ but WITHOUT ANY WARRANTY; without even the implied warranty of
++ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
++ GNU General Public License for more details.
++ .
++ You should have received a copy of the GNU General Public License
++ along with this program. If not, see <http://www.gnu.org/licenses/>.
++ .
++ On Debian systems, the complete text of the GNU General Public
++ License, version 3, can be found in the file
++ `/usr/share/common-licenses/GPL-3'.
++
++License: LGPL-2.1+
++ This library is free software; you can redistribute it and/or modify it
++ under the terms of the GNU Lesser General Public License as published by
++ the Free Software Foundation; either version 2.1 of the License, or (at
++ your option) any later version.
++ .
++ This library is distributed in the hope that it will be useful, but
++ WITHOUT ANY WARRANTY; without even the implied warranty of
++ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
++ General Public License for more details.
++ .
++ You should have received a copy of the GNU Lesser General Public License
++ along with this library. If not, see <http://www.gnu.org/licenses/>.
++ .
++ On Debian systems, the complete text of the GNU Lesser General Public
++ License, version 2.1, can be found in the file
++ `/usr/share/common-licenses/LGPL-2.1'.
++
++License: Expat
++ Permission is hereby granted, free of charge, to any person obtaining
++ a copy of this software and associated documentation files (the
++ "Software"), to deal in the Software without restriction, including
++ without limitation the rights to use, copy, modify, merge, publish,
++ distribute, sublicense, and/or sell copies of the Software, and to
++ permit persons to whom the Software is furnished to do so, subject to
++ the following conditions:
++ .
++ The above copyright notice and this permission notice shall be
++ included in all copies or substantial portions of the Software.
++ .
++ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
++ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
++ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
++ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
++ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
++ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
++ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
++
++License: BSD-2-clause
++ Redistribution and use in source and binary forms, with or without
++ modification, are permitted provided that the following conditions are
++ met:
++ * Redistributions of source code must retain the above copyright
++ notice, this list of conditions and the following disclaimer.
++ .
++ * Redistributions in binary form must reproduce the above
++ copyright notice, this list of conditions and the following
++ disclaimer in the documentation and/or other materials provided
++ with the distribution.
++ .
++ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
++ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
++ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
++ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
++ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
++ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
++ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
++ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
++ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
++ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
++
++License: BSD-3-clause
++ Redistribution and use in source and binary forms, with or without
++ modification, are permitted provided that the following conditions
++ are met:
++ 1. Redistributions of source code must retain the above copyright
++ notice, this list of conditions and the following disclaimer.
++ 2. Redistributions in binary form must reproduce the above copyright
++ notice, this list of conditions and the following disclaimer in the
++ documentation and/or other materials provided with the distribution.
++ 3. Neither the name of the author nor the names of any contributors
++ may be used to endorse or promote products derived from this software
++ without specific prior written permission.
++ .
++ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
++ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
++ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
++ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE
++ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
++ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
++ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
++ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
++ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
++ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
++
++License: ISC
++ Permission to use, copy, modify, and distribute this software for any
++ purpose with or without fee is hereby granted, provided that the above
++ copyright notice and this permission notice appear in all copies.
++ .
++ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
++ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
++ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
++ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
++ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
++ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
++ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
++
++License: FSFUL
++ This configure script is free software; the Free Software Foundation
++ gives unlimited permission to copy, distribute and modify it.
++
++License: FSFULLR
++ This file is free software; the Free Software Foundation gives
++ unlimited permission to copy and/or distribute it, with or without
++ modifications, as long as this notice is preserved.
++
++License: CC-BY-SA-3.0
++ CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL
++ SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT CREATE AN ATTORNEY-CLIENT
++ RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS"
++ BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE INFORMATION
++ PROVIDED, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS USE.
++ .
++ License
++ .
++ THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE
++ COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY
++ COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS
++ AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
++ .
++ BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO
++ BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE
++ CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED
++ HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
++ .
++ 1. Definitions
++ "Adaptation" means a work based upon the Work, or upon the Work and
++ other pre-existing works, such as a translation, adaptation, derivative
++ work, arrangement of music or other alterations of a literary or
++ artistic work, or phonogram or performance and includes cinematographic
++ adaptations or any other form in which the Work may be recast,
++ transformed, or adapted including in any form recognizably derived from
++ the original, except that a work that constitutes a Collection will not
++ be considered an Adaptation for the purpose of this License. For the
++ avoidance of doubt, where the Work is a musical work, performance or
++ phonogram, the synchronization of the Work in timed-relation with a
++ moving image ("synching") will be considered an Adaptation for the
++ purpose of this License.
++ "Collection" means a collection of literary or artistic works, such as
++ encyclopedias and anthologies, or performances, phonograms or
++ broadcasts, or other works or subject matter other than works listed in
++ Section 1(f) below, which, by reason of the selection and arrangement of
++ their contents, constitute intellectual creations, in which the Work is
++ included in its entirety in unmodified form along with one or more other
++ contributions, each constituting separate and independent works in
++ themselves, which together are assembled into a collective whole. A work
++ that constitutes a Collection will not be considered an Adaptation (as
++ defined below) for the purposes of this License.
++ "Creative Commons Compatible License" means a license that is listed at
++ http://creativecommons.org/compatiblelicenses that has been approved by
++ Creative Commons as being essentially equivalent to this License,
++ including, at a minimum, because that license: (i) contains terms that
++ have the same purpose, meaning and effect as the License Elements of
++ this License; and, (ii) explicitly permits the relicensing of
++ adaptations of works made available under that license under this
++ License or a Creative Commons jurisdiction license with the same License
++ Elements as this License.
++ "Distribute" means to make available to the public the original and
++ copies of the Work or Adaptation, as appropriate, through sale or other
++ transfer of ownership.
++ "License Elements" means the following high-level license attributes as
++ selected by Licensor and indicated in the title of this License:
++ Attribution, ShareAlike.
++ "Licensor" means the individual, individuals, entity or entities that
++ offer(s) the Work under the terms of this License.
++ "Original Author" means, in the case of a literary or artistic work, the
++ individual, individuals, entity or entities who created the Work or if
++ no individual or entity can be identified, the publisher; and in
++ addition (i) in the case of a performance the actors, singers,
++ musicians, dancers, and other persons who act, sing, deliver, declaim,
++ play in, interpret or otherwise perform literary or artistic works or
++ expressions of folklore; (ii) in the case of a phonogram the producer
++ being the person or legal entity who first fixes the sounds of a
++ performance or other sounds; and, (iii) in the case of broadcasts, the
++ organization that transmits the broadcast.
++ "Work" means the literary and/or artistic work offered under the terms
++ of this License including without limitation any production in the
++ literary, scientific and artistic domain, whatever may be the mode or
++ form of its expression including digital form, such as a book, pamphlet
++ and other writing; a lecture, address, sermon or other work of the same
++ nature; a dramatic or dramatico-musical work; a choreographic work or
++ entertainment in dumb show; a musical composition with or without words;
++ a cinematographic work to which are assimilated works expressed by a
++ process analogous to cinematography; a work of drawing, painting,
++ architecture, sculpture, engraving or lithography; a photographic work
++ to which are assimilated works expressed by a process analogous to
++ photography; a work of applied art; an illustration, map, plan, sketch
++ or three-dimensional work relative to geography, topography,
++ architecture or science; a performance; a broadcast; a phonogram; a
++ compilation of data to the extent it is protected as a copyrightable
++ work; or a work performed by a variety or circus performer to the extent
++ it is not otherwise considered a literary or artistic work.
++ "You" means an individual or entity exercising rights under this License
++ who has not previously violated the terms of this License with respect
++ to the Work, or who has received express permission from the Licensor to
++ exercise rights under this License despite a previous violation.
++ "Publicly Perform" means to perform public recitations of the Work and
++ to communicate to the public those public recitations, by any means or
++ process, including by wire or wireless means or public digital
++ performances; to make available to the public Works in such a way that
++ members of the public may access these Works from a place and at a place
++ individually chosen by them; to perform the Work to the public by any
++ means or process and the communication to the public of the performances
++ of the Work, including by public digital performance; to broadcast and
++ rebroadcast the Work by any means including signs, sounds or images.
++ "Reproduce" means to make copies of the Work by any means including
++ without limitation by sound or visual recordings and the right of
++ fixation and reproducing fixations of the Work, including storage of a
++ protected performance or phonogram in digital form or other electronic
++ medium.
++ .
++ 2. Fair Dealing Rights. Nothing in this License is intended to reduce,
++ limit, or restrict any uses free from copyright or rights arising from
++ limitations or exceptions that are provided for in connection with the
++ copyright protection under copyright law or other applicable laws.
++ .
++ 3. License Grant. Subject to the terms and conditions of this License,
++ Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
++ perpetual (for the duration of the applicable copyright) license to
++ exercise the rights in the Work as stated below:
++ .
++ to Reproduce the Work, to incorporate the Work into one or more
++ Collections, and to Reproduce the Work as incorporated in the
++ Collections;
++ to create and Reproduce Adaptations provided that any such Adaptation,
++ including any translation in any medium, takes reasonable steps to
++ clearly label, demarcate or otherwise identify that changes were made to
++ the original Work. For example, a translation could be marked "The
++ original work was translated from English to Spanish," or a modification
++ could indicate "The original work has been modified.";
++ to Distribute and Publicly Perform the Work including as incorporated in
++ Collections; and,
++ to Distribute and Publicly Perform Adaptations.
++ .
++ For the avoidance of doubt:
++ Non-waivable Compulsory License Schemes. In those jurisdictions in
++ which the right to collect royalties through any statutory or
++ compulsory licensing scheme cannot be waived, the Licensor reserves
++ the exclusive right to collect such royalties for any exercise by
++ You of the rights granted under this License;
++ Waivable Compulsory License Schemes. In those jurisdictions in which
++ the right to collect royalties through any statutory or compulsory
++ licensing scheme can be waived, the Licensor waives the exclusive
++ right to collect such royalties for any exercise by You of the
++ rights granted under this License; and,
++ Voluntary License Schemes. The Licensor waives the right to collect
++ royalties, whether individually or, in the event that the Licensor
++ is a member of a collecting society that administers voluntary
++ licensing schemes, via that society, from any exercise by You of the
++ rights granted under this License.
++ .
++ The above rights may be exercised in all media and formats whether now
++ known or hereafter devised. The above rights include the right to make such
++ modifications as are technically necessary to exercise the rights in other
++ media and formats. Subject to Section 8(f), all rights not expressly
++ granted by Licensor are hereby reserved.
++ .
++ 4. Restrictions. The license granted in Section 3 above is expressly made
++ subject to and limited by the following restrictions:
++ .
++ You may Distribute or Publicly Perform the Work only under the terms of
++ this License. You must include a copy of, or the Uniform Resource
++ Identifier (URI) for, this License with every copy of the Work You
++ Distribute or Publicly Perform. You may not offer or impose any terms on
++ the Work that restrict the terms of this License or the ability of the
++ recipient of the Work to exercise the rights granted to that recipient
++ under the terms of the License. You may not sublicense the Work. You
++ must keep intact all notices that refer to this License and to the
++ disclaimer of warranties with every copy of the Work You Distribute or
++ Publicly Perform. When You Distribute or Publicly Perform the Work, You
++ may not impose any effective technological measures on the Work that
++ restrict the ability of a recipient of the Work from You to exercise the
++ rights granted to that recipient under the terms of the License. This
++ Section 4(a) applies to the Work as incorporated in a Collection, but
++ this does not require the Collection apart from the Work itself to be
++ made subject to the terms of this License. If You create a Collection,
++ upon notice from any Licensor You must, to the extent practicable,
++ remove from the Collection any credit as required by Section 4(c), as
++ requested. If You create an Adaptation, upon notice from any Licensor
++ You must, to the extent practicable, remove from the Adaptation any
++ credit as required by Section 4(c), as requested.
++ You may Distribute or Publicly Perform an Adaptation only under the
++ terms of: (i) this License; (ii) a later version of this License with
++ the same License Elements as this License; (iii) a Creative Commons
++ jurisdiction license (either this or a later license version) that
++ contains the same License Elements as this License (e.g.,
++ Attribution-ShareAlike 3.0 US)); (iv) a Creative Commons Compatible
++ License. If you license the Adaptation under one of the licenses
++ mentioned in (iv), you must comply with the terms of that license. If
++ you license the Adaptation under the terms of any of the licenses
++ mentioned in (i), (ii) or (iii) (the "Applicable License"), you must
++ comply with the terms of the Applicable License generally and the
++ following provisions: (I) You must include a copy of, or the URI for,
++ the Applicable License with every copy of each Adaptation You Distribute
++ or Publicly Perform; (II) You may not offer or impose any terms on the
++ Adaptation that restrict the terms of the Applicable License or the
++ ability of the recipient of the Adaptation to exercise the rights
++ granted to that recipient under the terms of the Applicable License;
++ (III) You must keep intact all notices that refer to the Applicable
++ License and to the disclaimer of warranties with every copy of the Work
++ as included in the Adaptation You Distribute or Publicly Perform; (IV)
++ when You Distribute or Publicly Perform the Adaptation, You may not
++ impose any effective technological measures on the Adaptation that
++ restrict the ability of a recipient of the Adaptation from You to
++ exercise the rights granted to that recipient under the terms of the
++ Applicable License. This Section 4(b) applies to the Adaptation as
++ incorporated in a Collection, but this does not require the Collection
++ apart from the Adaptation itself to be made subject to the terms of the
++ Applicable License.
++ If You Distribute, or Publicly Perform the Work or any Adaptations or
++ Collections, You must, unless a request has been made pursuant to
++ Section 4(a), keep intact all copyright notices for the Work and
++ provide, reasonable to the medium or means You are utilizing: (i) the
++ name of the Original Author (or pseudonym, if applicable) if supplied,
++ and/or if the Original Author and/or Licensor designate another party or
++ parties (e.g., a sponsor institute, publishing entity, journal) for
++ attribution ("Attribution Parties") in Licensor's copyright notice,
++ terms of service or by other reasonable means, the name of such party or
++ parties; (ii) the title of the Work if supplied; (iii) to the extent
++ reasonably practicable, the URI, if any, that Licensor specifies to be
++ associated with the Work, unless such URI does not refer to the
++ copyright notice or licensing information for the Work; and (iv) ,
++ consistent with Ssection 3(b), in the case of an Adaptation, a credit
++ identifying the use of the Work in the Adaptation (e.g., "French
++ translation of the Work by Original Author," or "Screenplay based on
++ original Work by Original Author"). The credit required by this Section
++ 4(c) may be implemented in any reasonable manner; provided, however,
++ that in the case of a Adaptation or Collection, at a minimum such credit
++ will appear, if a credit for all contributing authors of the Adaptation
++ or Collection appears, then as part of these credits and in a manner at
++ least as prominent as the credits for the other contributing authors.
++ For the avoidance of doubt, You may only use the credit required by this
++ Section for the purpose of attribution in the manner set out above and,
++ by exercising Your rights under this License, You may not implicitly or
++ explicitly assert or imply any connection with, sponsorship or
++ endorsement by the Original Author, Licensor and/or Attribution Parties,
++ as appropriate, of You or Your use of the Work, without the separate,
++ express prior written permission of the Original Author, Licensor and/or
++ Attribution Parties.
++ Except as otherwise agreed in writing by the Licensor or as may be
++ otherwise permitted by applicable law, if You Reproduce, Distribute or
++ Publicly Perform the Work either by itself or as part of any Adaptations
++ or Collections, You must not distort, mutilate, modify or take other
++ derogatory action in relation to the Work which would be prejudicial to
++ the Original Author's honor or reputation. Licensor agrees that in those
++ jurisdictions (e.g. Japan), in which any exercise of the right granted
++ in Section 3(b) of this License (the right to make Adaptations) would be
++ deemed to be a distortion, mutilation, modification or other derogatory
++ action prejudicial to the Original Author's honor and reputation, the
++ Licensor will waive or not assert, as appropriate, this Section, to the
++ fullest extent permitted by the applicable national law, to enable You
++ to reasonably exercise Your right under Section 3(b) of this License
++ (right to make Adaptations) but not otherwise.
++ .
++ 5. Representations, Warranties and Disclaimer
++ .
++ UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR
++ OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY
++ KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE,
++ INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY,
++ FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT
++ OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER
++ OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF
++ IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
++ .
++ 6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE
++ LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY
++ SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING
++ OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN
++ ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
++ .
++ 7. Termination
++ .
++ This License and the rights granted hereunder will terminate
++ automatically upon any breach by You of the terms of this License.
++ Individuals or entities who have received Adaptations or Collections
++ from You under this License, however, will not have their licenses
++ terminated provided such individuals or entities remain in full
++ compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will
++ survive any termination of this License.
++ Subject to the above terms and conditions, the license granted here is
++ perpetual (for the duration of the applicable copyright in the Work).
++ Notwithstanding the above, Licensor reserves the right to release the
++ Work under different license terms or to stop distributing the Work at
++ any time; provided, however that any such election will not serve to
++ withdraw this License (or any other license that has been, or is
++ required to be, granted under the terms of this License), and this
++ License will continue in full force and effect unless terminated as
++ stated above.
++ .
++ 8. Miscellaneous
++ .
++ Each time You Distribute or Publicly Perform the Work or a Collection,
++ the Licensor offers to the recipient a license to the Work on the same
++ terms and conditions as the license granted to You under this License.
++ Each time You Distribute or Publicly Perform an Adaptation, Licensor
++ offers to the recipient a license to the original Work on the same terms
++ and conditions as the license granted to You under this License.
++ If any provision of this License is invalid or unenforceable under
++ applicable law, it shall not affect the validity or enforceability of
++ the remainder of the terms of this License, and without further action
++ by the parties to this agreement, such provision shall be reformed to
++ the minimum extent necessary to make such provision valid and
++ enforceable.
++ No term or provision of this License shall be deemed waived and no
++ breach consented to unless such waiver or consent shall be in writing
++ and signed by the party to be charged with such waiver or consent.
++ This License constitutes the entire agreement between the parties with
++ respect to the Work licensed here. There are no understandings,
++ agreements or representations with respect to the Work not specified
++ here. Licensor shall not be bound by any additional provisions that may
++ appear in any communication from You. This License may not be modified
++ without the mutual written agreement of the Licensor and You.
++ The rights granted under, and the subject matter referenced, in this
++ License were drafted utilizing the terminology of the Berne Convention
++ for the Protection of Literary and Artistic Works (as amended on
++ September 28, 1979), the Rome Convention of 1961, the WIPO Copyright
++ Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and
++ the Universal Copyright Convention (as revised on July 24, 1971). These
++ rights and subject matter take effect in the relevant jurisdiction in
++ which the License terms are sought to be enforced according to the
++ corresponding provisions of the implementation of those treaty
++ provisions in the applicable national law. If the standard suite of
++ rights granted under applicable copyright law includes additional rights
++ not granted under this License, such additional rights are deemed to be
++ included in the License; this License is not intended to restrict the
++ license of any rights under applicable law.
++
++License: Apache-2.0
++ Licensed under the Apache License, Version 2.0 (the "License");
++ you may not use this file except in compliance with the License.
++ You may obtain a copy of the License at
++ .
++ http://www.apache.org/licenses/LICENSE-2.0
++ .
++ Unless required by applicable law or agreed to in writing, software
++ distributed under the License is distributed on an "AS IS" BASIS,
++ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
++ See the License for the specific language governing permissions and
++ limitations under the License.
++ .
++ On Debian systems, the complete text of the Apache version 2.0 license
++ can be found in "/usr/share/common-licenses/Apache-2.0".
++
++License: GPL-2+
++ This package is free software; you can redistribute it and/or modify
++ it under the terms of the GNU General Public License as published by
++ the Free Software Foundation; either version 2 of the License, or
++ (at your option) any later version.
++ .
++ This package is distributed in the hope that it will be useful,
++ but WITHOUT ANY WARRANTY; without even the implied warranty of
++ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
++ GNU General Public License for more details.
++ .
++ You should have received a copy of the GNU General Public License
++ along with this program. If not, see <http://www.gnu.org/licenses/>
++ .
++ On Debian systems, the complete text of the GNU General
++ Public License version 2 can be found in "/usr/share/common-licenses/GPL-2".
++
++License: GPL-3+
++ This program is free software: you can redistribute it and/or modify
++ it under the terms of the GNU General Public License as published by
++ the Free Software Foundation, either version 3 of the License, or
++ (at your option) any later version.
++ .
++ This package is distributed in the hope that it will be useful,
++ but WITHOUT ANY WARRANTY; without even the implied warranty of
++ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
++ GNU General Public License for more details.
++ .
++ You should have received a copy of the GNU General Public License
++ along with this program. If not, see <http://www.gnu.org/licenses/>.
++ .
++ On Debian systems, the complete text of the GNU General
++ Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
++
++License: Zlib
++ This software is provided 'as-is', without any express or implied
++ warranty. In no event will the authors be held liable for any damages
++ arising from the use of this software.
++ .
++ Permission is granted to anyone to use this software for any purpose,
++ including commercial applications, and to alter it and redistribute it
++ freely, subject to the following restrictions:
++ .
++ 1. The origin of this software must not be misrepresented; you must not
++ claim that you wrote the original software. If you use this software
++ in a product, an acknowledgment in the product documentation would be
++ appreciated but is not required.
++ 2. Altered source versions must be plainly marked as such, and must not be
++ misrepresented as being the original software.
++ 3. This notice may not be removed or altered from any source distribution.
++
++License: U-OF-I-BSD-LIKE
++ ==============================================================================
++ LLVM Release License
++ ==============================================================================
++ University of Illinois/NCSA
++ Open Source License
++ .
++ Copyright (c) 2003-2017 University of Illinois at Urbana-Champaign.
++ All rights reserved.
++ .
++ Developed by:
++ .
++ LLVM Team
++ .
++ University of Illinois at Urbana-Champaign
++ .
++ http://llvm.org
++ .
++ Permission is hereby granted, free of charge, to any person obtaining a copy of
++ this software and associated documentation files (the "Software"), to deal with
++ the Software without restriction, including without limitation the rights to
++ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
++ of the Software, and to permit persons to whom the Software is furnished to do
++ so, subject to the following conditions:
++ .
++ * Redistributions of source code must retain the above copyright notice,
++ this list of conditions and the following disclaimers.
++ .
++ * Redistributions in binary form must reproduce the above copyright notice,
++ this list of conditions and the following disclaimers in the
++ documentation and/or other materials provided with the distribution.
++ .
++ * Neither the names of the LLVM Team, University of Illinois at
++ Urbana-Champaign, nor the names of its contributors may be used to
++ endorse or promote products derived from this Software without specific
++ prior written permission.
++ .
++ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
++ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
++ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
++ CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
++ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
++ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
++ SOFTWARE.
--- /dev/null
--- /dev/null
++openblas-6a79b36d1bf73584a513139806d226f9189d621e.tar.gz
--- /dev/null
--- /dev/null
++comment: false
--- /dev/null
--- /dev/null
++language: julia
++
++os:
++ - linux
++ - osx
++
++julia:
++ - 0.7
++ - 1.0
++ - nightly
++
++notifications:
++ email: false
++
++after_success:
++ - julia test/coverage.jl
++
++jobs:
++ include:
++ - stage: "Documentation"
++ julia: 1.0
++ os: linux
++ script:
++ - julia --project=docs/ -e 'using Pkg; Pkg.add(PackageSpec(path=pwd()));
++ Pkg.instantiate()'
++ - julia --project=docs/ docs/make.jl
++ after_success: skip
--- /dev/null
--- /dev/null
++The DocStringExtensions.jl package is licensed under the MIT "Expat" License:
++
++> Copyright (c) 2016: Michael Hatherly.
++>
++> Permission is hereby granted, free of charge, to any person obtaining a copy
++> of this software and associated documentation files (the "Software"), to deal
++> in the Software without restriction, including without limitation the rights
++> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
++> copies of the Software, and to permit persons to whom the Software is
++> furnished to do so, subject to the following conditions:
++>
++> The above copyright notice and this permission notice shall be included in all
++> copies or substantial portions of the Software.
++>
++> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
++> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
++> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
++> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
++> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
++> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
++> SOFTWARE.
++>
--- /dev/null
--- /dev/null
++name = "DocStringExtensions"
++uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
++version = "0.8.0"
++
++[deps]
++LibGit2 = "76f85450-5226-5b5a-8eaa-529ad045b433"
++Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
++Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
++Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
++
++[compat]
++julia = "0.7, 1"
--- /dev/null
--- /dev/null
++# DocStringExtensions
++
++*Extensions for Julia's docsystem.*
++
++| **Documentation** | **Build Status** |
++|:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
++| [![][docs-stable-img]][docs-stable-url] [![][docs-latest-img]][docs-latest-url] | [![][travis-img]][travis-url] [![][appveyor-img]][appveyor-url] [![][codecov-img]][codecov-url] |
++
++## Installation
++
++The package can be added using the Julia package manager. From the Julia REPL, type `]`
++to enter the Pkg REPL mode and run
++
++```
++pkg> add DocStringExtensions
++```
++
++## Documentation
++
++- [**STABLE**][docs-stable-url] — **most recently tagged version of the documentation.**
++- [**LATEST**][docs-latest-url] — *in-development version of the documentation.*
++
++## Project Status
++
++The package is tested and developed against Julia `0.7` and `1.0` on Linux, OS X, and Windows,
++but there are versions of the package that works on older versions of Julia.
++
++## Contributing and Questions
++
++Contributions are very welcome, as are feature requests and suggestions. Please open an [issue][issues-url] if you encounter any problems. If you have a question then feel free to ask for help in the [Gitter chat room][gitter-url].
++
++[gitter-url]: https://gitter.im/juliadocs/users
++
++[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
++[docs-latest-url]: https://juliadocs.github.io/DocStringExtensions.jl/latest
++
++[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
++[docs-stable-url]: https://juliadocs.github.io/DocStringExtensions.jl/stable
++
++[travis-img]: https://travis-ci.org/JuliaDocs/DocStringExtensions.jl.svg?branch=master
++[travis-url]: https://travis-ci.org/JuliaDocs/DocStringExtensions.jl
++
++[appveyor-img]: https://ci.appveyor.com/api/projects/status/7bixd69chxps91wx/branch/master?svg=true
++[appveyor-url]: https://ci.appveyor.com/project/JuliaDocs/docstringextensions-jl/branch/master
++
++[codecov-img]: https://codecov.io/gh/JuliaDocs/DocStringExtensions.jl/branch/master/graph/badge.svg
++[codecov-url]: https://codecov.io/gh/JuliaDocs/DocStringExtensions.jl
++
++[issues-url]: https://github.com/JuliaDocs/DocStringExtensions.jl/issues
--- /dev/null
--- /dev/null
++environment:
++ matrix:
++ - julia_version: 0.7
++ - julia_version: 1
++ - julia_version: nightly
++
++platform:
++ - x86 # 32-bit
++ - x64 # 64-bit
++
++# # Uncomment the following lines to allow failures on nightly julia
++# # (tests will run but not make your overall status red)
++# matrix:
++# allow_failures:
++# - julia_version: nightly
++
++branches:
++ only:
++ - master
++ - /release-.*/
++
++notifications:
++ - provider: Email
++ on_build_success: false
++ on_build_failure: false
++ on_build_status_changed: false
++
++install:
++ - ps: iex ((new-object net.webclient).DownloadString("https://raw.githubusercontent.com/JuliaCI/Appveyor.jl/version-1/bin/install.ps1"))
++
++build_script:
++ - echo "%JL_BUILD_SCRIPT%"
++ - C:\julia\bin\julia -e "%JL_BUILD_SCRIPT%"
++
++test_script:
++ - echo "%JL_TEST_SCRIPT%"
++ - C:\julia\bin\julia -e "%JL_TEST_SCRIPT%"
++
++# # Uncomment to support code coverage upload. Should only be enabled for packages
++# # which would have coverage gaps without running on Windows
++# on_success:
++# - echo "%JL_CODECOV_SCRIPT%"
++# - C:\julia\bin\julia -e "%JL_CODECOV_SCRIPT%"
--- /dev/null
--- /dev/null
++[deps]
++Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
++
++[compat]
++Documenter = "0.22"
--- /dev/null
--- /dev/null
++# Showcase.jl
++
++The demo library for DocStringExtensions.
--- /dev/null
--- /dev/null
++"""
++This docstring is attached to the [`Showcase`](@ref) module itself.
++
++The [`EXPORTS`](@ref) abbreviation creates a bulleted list of all the exported names:
++
++$(EXPORTS)
++
++Similarly, the [`IMPORTS`](@ref) abbreviation lists all the imported modules:
++
++$(IMPORTS)
++
++The [`README`](@ref) can be used to include the `README.md` file in a docstring. The content
++between the horizontal lines is spliced by the abbreviation:
++
++---
++
++$(README)
++
++---
++
++The [`LICENSE`](@ref) abbreviation can be used in the same way for the `LICENSE.md` file.
++"""
++module Showcase
++using DocStringExtensions
++
++"""
++This docstring is attached to an [empty function
++definitions](https://docs.julialang.org/en/v1/manual/methods/#Empty-generic-functions-1).
++The [`METHODLIST`](@ref) abbreviation allows you to list all the methods though:
++
++$(METHODLIST)
++"""
++function foo end
++
++"""
++This docstring is attached to a method that uses default values for some positional
++arguments: `foo(x::Int, y=3)`.
++
++As this effectively means that there are two different methods taking different numbers of
++arguments, the [`SIGNATURES`](@ref) abbreviation produces the following result:
++
++$(SIGNATURES)
++
++---
++
++The [`TYPEDSIGNATURES`](@ref) abbreviation can be used to also get the types of the
++variables in the function signature:
++
++$(TYPEDSIGNATURES)
++
++---
++
++The [`FUNCTIONNAME`](@ref) abbreviation can be used to directly include the name of the
++function in the docstring (e.g. here: $(FUNCTIONNAME)). This can be useful when writing your
++own type signatures:
++
++ $(FUNCTIONNAME)(x, ...)
++"""
++foo(x::Int, y=3) = nothing
++
++"""
++A different method for [`$(FUNCTIONNAME)`](@ref). [`SIGNATURES`](@ref) abbreviation:
++
++$(SIGNATURES)
++
++And the [`TYPEDSIGNATURES`](@ref) abbreviation:
++
++$(TYPEDSIGNATURES)
++"""
++foo(x::AbstractString) = nothing
++
++
++"""
++The [`TYPEDEF`](@ref) abbreviation includes the type signature:
++
++$(TYPEDEF)
++
++---
++
++The [`FIELDS`](@ref) abbreviation creates a list of all the fields of the type.
++If the fields has a docstring attached, that will also get included.
++
++$(FIELDS)
++
++---
++
++[`TYPEDFIELDS`](@ref) also adds in types for the fields:
++
++$(TYPEDFIELDS)
++"""
++struct Foobar{T <: AbstractString}
++ "Docstring for the `x` field."
++ x :: Nothing
++ y :: T # y is missing a docstring
++ "Docstring for the `z` field."
++ z :: Vector{T}
++end
++
++export foo, Foobar
++
++end
--- /dev/null
--- /dev/null
++# Add docs/lib to LOAD_PATH so that we could load the Showcase module like a library.
++let doclib = abspath(joinpath(@__DIR__, "Showcase", "src"))
++ doclib in LOAD_PATH || pushfirst!(LOAD_PATH, doclib)
++end
++
++using Documenter, DocStringExtensions
++import Showcase
++
++makedocs(
++ sitename = "DocStringExtensions.jl",
++ modules = [DocStringExtensions, Showcase],
++ clean = false,
++ pages = Any[
++ "Home" => "index.md",
++ "Showcase" => "showcase.md",
++ ],
++ format = Documenter.HTML(
++ assets = ["assets/favicon.ico"],
++ ),
++)
++
++deploydocs(
++ repo = "github.com/JuliaDocs/DocStringExtensions.jl.git",
++)
--- /dev/null
--- /dev/null
++<?xml version="1.0" encoding="UTF-8"?>
++<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="500pt" height="500pt" viewBox="0 0 500 500" version="1.1">
++<g id="surface763305">
++<path style=" stroke:none;fill-rule:nonzero;fill:rgb(79.6%,23.5%,20%);fill-opacity:1;" d="M 234.425781 352.5 C 234.425781 413.25 185.175781 462.5 124.425781 462.5 C 63.675781 462.5 14.425781 413.25 14.425781 352.5 C 14.425781 291.75 63.675781 242.5 124.425781 242.5 C 185.175781 242.5 234.425781 291.75 234.425781 352.5 "/>
++<path style="fill-rule:nonzero;fill:rgb(0%,0%,0%);fill-opacity:1;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(100%,100%,100%);stroke-opacity:1;stroke-miterlimit:10;" d="M 130.554688 379.886719 L 130.964844 372.671875 L 131.613281 365.949219 L 132.457031 359.671875 L 133.46875 353.8125 L 134.597656 348.316406 L 135.820312 343.15625 L 138.390625 333.683594 L 140.878906 325.066406 L 143.019531 317.015625 L 143.859375 313.097656 L 144.511719 309.210938 L 144.925781 305.304688 L 145.074219 301.347656 L 144.960938 298.058594 L 144.640625 294.980469 L 144.117188 292.101562 L 143.410156 289.4375 L 142.515625 286.96875 L 141.457031 284.714844 L 140.242188 282.664062 L 138.882812 280.832031 L 137.378906 279.203125 L 135.753906 277.785156 L 134.007812 276.585938 L 132.167969 275.605469 L 130.226562 274.832031 L 128.207031 274.285156 L 126.109375 273.953125 L 123.957031 273.847656 L 121.792969 273.953125 L 119.703125 274.285156 L 117.6875 274.835938 L 115.765625 275.609375 L 113.933594 276.59375 L 112.210938 277.800781 L 110.605469 279.21875 L 109.128906 280.859375 L 107.78125 282.707031 L 106.585938 284.769531 L 105.542969 287.042969 L 104.675781 289.53125 L 103.976562 292.226562 L 103.46875 295.132812 L 103.15625 298.242188 L 103.054688 301.570312 L 103.195312 305.488281 L 103.609375 309.363281 L 104.253906 313.222656 L 105.101562 317.113281 L 107.238281 325.128906 L 109.734375 333.714844 L 112.296875 343.171875 L 113.515625 348.324219 L 114.652344 353.816406 L 115.652344 359.671875 L 116.503906 365.949219 L 117.152344 372.671875 L 117.574219 379.886719 Z M 103.054688 413.546875 L 103.136719 415.476562 L 103.390625 417.390625 L 103.8125 419.265625 L 104.398438 421.101562 L 105.148438 422.863281 L 106.0625 424.558594 L 107.140625 426.15625 L 108.386719 427.652344 L 109.78125 429.019531 L 111.34375 430.253906 L 113.058594 431.339844 L 114.933594 432.261719 L 116.957031 433 L 119.140625 433.550781 L 121.46875 433.886719 L 123.957031 434.007812 L 126.441406 433.886719 L 128.785156 433.550781 L 130.980469 433 L 133.039062 432.261719 L 134.941406 431.339844 L 136.695312 430.253906 L 138.292969 429.019531 L 139.738281 427.652344 L 141.015625 426.15625 L 142.132812 424.558594 L 143.082031 422.863281 L 143.875 421.101562 L 144.488281 419.265625 L 144.9375 417.390625 L 145.203125 415.476562 L 145.296875 413.546875 L 145.203125 411.605469 L 144.9375 409.691406 L 144.488281 407.808594 L 143.875 405.984375 L 143.082031 404.210938 L 142.132812 402.523438 L 141.015625 400.921875 L 139.738281 399.4375 L 138.292969 398.0625 L 136.695312 396.828125 L 134.941406 395.742188 L 133.039062 394.828125 L 130.980469 394.085938 L 128.785156 393.539062 L 126.441406 393.203125 L 123.957031 393.089844 L 121.46875 393.203125 L 119.140625 393.539062 L 116.957031 394.085938 L 114.933594 394.828125 L 113.058594 395.742188 L 111.34375 396.828125 L 109.78125 398.0625 L 108.386719 399.4375 L 107.140625 400.921875 L 106.0625 402.523438 L 105.148438 404.210938 L 104.398438 405.984375 L 103.8125 407.808594 L 103.390625 409.691406 L 103.136719 411.605469 Z "/>
++<path style=" stroke:none;fill-rule:nonzero;fill:rgb(22%,59.6%,14.9%);fill-opacity:1;" d="M 360 135 C 360 195.75 310.75 245 250 245 C 189.25 245 140 195.75 140 135 C 140 74.25 189.25 25 250 25 C 310.75 25 360 74.25 360 135 "/>
++<path style=" stroke:none;fill-rule:nonzero;fill:rgb(58.4%,34.5%,69.8%);fill-opacity:1;" d="M 485.574219 352.5 C 485.574219 413.25 436.324219 462.5 375.574219 462.5 C 314.824219 462.5 265.574219 413.25 265.574219 352.5 C 265.574219 291.75 314.824219 242.5 375.574219 242.5 C 436.324219 242.5 485.574219 291.75 485.574219 352.5 "/>
++<path style="fill-rule:nonzero;fill:rgb(0%,0%,0%);fill-opacity:1;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(100%,100%,100%);stroke-opacity:1;stroke-miterlimit:10;" d="M 382.195312 366.027344 L 387.449219 365.816406 L 392.492188 365.285156 L 397.296875 364.421875 L 401.855469 363.242188 L 406.136719 361.738281 L 410.140625 359.917969 L 413.839844 357.777344 L 417.226562 355.328125 L 420.269531 352.554688 L 422.96875 349.484375 L 425.292969 346.097656 L 427.238281 342.417969 L 428.773438 338.425781 L 429.894531 334.136719 L 430.578125 329.546875 L 430.816406 324.667969 L 430.570312 319.921875 L 429.84375 315.214844 L 428.636719 310.574219 L 426.96875 306.046875 L 424.832031 301.660156 L 422.246094 297.460938 L 419.210938 293.480469 L 415.742188 289.765625 L 411.832031 286.335938 L 407.5 283.25 L 402.746094 280.53125 L 397.585938 278.226562 L 392.015625 276.363281 L 386.050781 274.992188 L 379.691406 274.136719 L 372.957031 273.847656 L 368.953125 273.929688 L 365.042969 274.191406 L 361.25 274.628906 L 357.601562 275.253906 L 354.105469 276.0625 L 350.804688 277.066406 L 347.707031 278.269531 L 344.847656 279.675781 L 342.226562 281.28125 L 339.890625 283.101562 L 337.847656 285.136719 L 336.132812 287.394531 L 334.753906 289.871094 L 333.746094 292.582031 L 333.121094 295.523438 L 332.914062 298.707031 L 333.199219 302.035156 L 334.03125 305.078125 L 335.34375 307.773438 L 337.09375 310.089844 L 339.207031 311.964844 L 341.636719 313.367188 L 344.320312 314.242188 L 345.742188 314.464844 L 347.214844 314.546875 L 348.875 314.46875 L 350.414062 314.257812 L 351.832031 313.914062 L 353.144531 313.457031 L 355.46875 312.207031 L 357.460938 310.589844 L 359.175781 308.671875 L 360.691406 306.535156 L 363.382812 301.898438 L 366.066406 297.25 L 367.578125 295.109375 L 369.296875 293.199219 L 371.28125 291.574219 L 373.613281 290.332031 L 374.921875 289.867188 L 376.34375 289.53125 L 377.882812 289.320312 L 379.554688 289.25 L 382.464844 289.382812 L 385.183594 289.78125 L 387.707031 290.417969 L 390.039062 291.289062 L 392.171875 292.363281 L 394.125 293.628906 L 395.882812 295.070312 L 397.457031 296.671875 L 398.832031 298.402344 L 400.027344 300.261719 L 401.035156 302.222656 L 401.859375 304.277344 L 402.492188 306.394531 L 402.949219 308.566406 L 403.222656 310.773438 L 403.316406 313.007812 L 403.144531 316.054688 L 402.65625 318.859375 L 401.851562 321.421875 L 400.75 323.757812 L 399.347656 325.863281 L 397.671875 327.753906 L 395.722656 329.429688 L 393.523438 330.90625 L 391.066406 332.175781 L 388.375 333.257812 L 385.460938 334.15625 L 382.332031 334.878906 L 378.996094 335.421875 L 375.472656 335.808594 L 371.765625 336.03125 L 367.894531 336.109375 L 367.894531 379.886719 L 381.316406 379.886719 Z M 353.59375 413.546875 L 353.675781 415.476562 L 353.929688 417.390625 L 354.351562 419.265625 L 354.941406 421.101562 L 355.691406 422.863281 L 356.617188 424.558594 L 357.699219 426.15625 L 358.953125 427.652344 L 360.359375 429.019531 L 361.933594 430.253906 L 363.664062 431.339844 L 365.5625 432.261719 L 367.613281 433 L 369.824219 433.550781 L 372.1875 433.886719 L 374.714844 434.007812 L 377.160156 433.886719 L 379.46875 433.550781 L 381.636719 433 L 383.671875 432.261719 L 385.550781 431.339844 L 387.289062 430.253906 L 388.871094 429.019531 L 390.304688 427.652344 L 391.574219 426.15625 L 392.6875 424.558594 L 393.632812 422.863281 L 394.417969 421.101562 L 395.027344 419.265625 L 395.476562 417.390625 L 395.742188 415.476562 L 395.835938 413.546875 L 395.742188 411.605469 L 395.476562 409.691406 L 395.027344 407.808594 L 394.417969 405.984375 L 393.632812 404.210938 L 392.6875 402.523438 L 391.574219 400.921875 L 390.304688 399.4375 L 388.871094 398.0625 L 387.289062 396.828125 L 385.550781 395.742188 L 383.671875 394.828125 L 381.636719 394.085938 L 379.46875 393.539062 L 377.160156 393.203125 L 374.714844 393.089844 L 372.1875 393.203125 L 369.824219 393.539062 L 367.613281 394.085938 L 365.5625 394.828125 L 363.664062 395.742188 L 361.933594 396.828125 L 360.359375 398.0625 L 358.953125 399.4375 L 357.699219 400.921875 L 356.617188 402.523438 L 355.691406 404.210938 L 354.941406 405.984375 L 354.351562 407.808594 L 353.929688 409.691406 L 353.675781 411.605469 Z "/>
++<path style="fill-rule:nonzero;fill:rgb(0%,0%,0%);fill-opacity:1;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(100%,100%,100%);stroke-opacity:1;stroke-miterlimit:10;" d="M 317.210938 94.707031 C 319.421875 98.039062 319.917969 101.8125 318.703125 106.027344 L 295.910156 185.535156 C 294.859375 189.277344 292.746094 192.421875 289.570312 194.96875 C 286.394531 197.511719 283.007812 198.785156 279.417969 198.785156 L 202.914062 198.785156 C 198.660156 198.785156 194.558594 197.21875 190.609375 194.089844 C 186.65625 190.960938 183.910156 187.113281 182.363281 182.550781 C 181.035156 178.628906 180.980469 174.914062 182.195312 171.40625 C 182.195312 171.171875 182.277344 170.378906 182.445312 169.035156 C 182.609375 167.691406 182.722656 166.605469 182.777344 165.789062 C 182.832031 165.320312 182.746094 164.691406 182.527344 163.902344 C 182.304688 163.113281 182.222656 162.542969 182.277344 162.191406 C 182.390625 161.546875 182.609375 160.933594 182.941406 160.347656 C 183.273438 159.761719 183.730469 159.074219 184.308594 158.285156 C 184.890625 157.496094 185.34375 156.808594 185.675781 156.222656 C 186.945312 154 188.191406 151.324219 189.40625 148.191406 C 190.621094 145.0625 191.453125 142.386719 191.894531 140.164062 C 192.058594 139.578125 192.074219 138.699219 191.933594 137.53125 C 191.796875 136.359375 191.78125 135.542969 191.894531 135.074219 C 192.058594 134.429688 192.527344 133.609375 193.300781 132.617188 C 194.074219 131.621094 194.542969 130.949219 194.710938 130.597656 C 195.871094 128.492188 197.03125 125.800781 198.191406 122.523438 C 199.351562 119.246094 200.042969 116.613281 200.265625 114.625 C 200.320312 114.097656 200.25 113.164062 200.058594 111.816406 C 199.863281 110.472656 199.875 109.652344 200.097656 109.359375 C 200.320312 108.601562 200.925781 107.707031 201.921875 106.683594 C 202.914062 105.660156 203.523438 105.003906 203.746094 104.710938 C 204.796875 103.1875 205.96875 100.71875 207.269531 97.292969 C 208.566406 93.871094 209.324219 91.046875 209.546875 88.824219 C 209.601562 88.359375 209.519531 87.613281 209.296875 86.589844 C 209.078125 85.5625 209.023438 84.789062 209.132812 84.261719 C 209.242188 83.792969 209.492188 83.269531 209.878906 82.683594 C 210.265625 82.097656 210.761719 81.425781 211.371094 80.664062 C 211.976562 79.902344 212.449219 79.289062 212.777344 78.820312 C 213.222656 78.121094 213.675781 77.226562 214.144531 76.144531 C 214.617188 75.0625 215.03125 74.039062 215.390625 73.074219 C 215.75 72.109375 216.191406 71.054688 216.714844 69.914062 C 217.242188 68.773438 217.78125 67.835938 218.332031 67.105469 C 218.886719 66.375 219.617188 65.6875 220.527344 65.042969 C 221.441406 64.398438 222.433594 64.0625 223.511719 64.035156 C 224.589844 64.003906 225.902344 64.167969 227.449219 64.519531 L 227.367188 64.78125 C 229.464844 64.253906 230.875 63.992188 231.59375 63.992188 L 294.667969 63.992188 C 298.757812 63.992188 301.90625 65.628906 304.117188 68.90625 C 306.328125 72.179688 306.824219 75.984375 305.609375 80.3125 L 282.898438 159.820312 C 280.910156 166.78125 278.933594 171.273438 276.972656 173.292969 C 275.011719 175.308594 271.460938 176.320312 266.320312 176.320312 L 194.296875 176.320312 C 192.804688 176.320312 191.753906 176.757812 191.148438 177.636719 C 190.539062 178.570312 190.511719 179.828125 191.0625 181.410156 C 192.390625 185.503906 196.367188 187.550781 203 187.550781 L 279.5 187.550781 C 281.101562 187.550781 282.648438 187.097656 284.140625 186.191406 C 285.632812 185.285156 286.601562 184.070312 287.042969 182.550781 L 311.90625 95.933594 C 312.292969 94.648438 312.433594 92.980469 312.320312 90.933594 C 314.421875 91.808594 316.050781 93.066406 317.210938 94.707031 M 229.023438 94.878906 C 228.804688 95.640625 228.859375 96.300781 229.191406 96.855469 C 229.523438 97.410156 230.074219 97.6875 230.847656 97.6875 L 281.238281 97.6875 C 281.957031 97.6875 282.664062 97.410156 283.355469 96.855469 C 284.042969 96.300781 284.5 95.640625 284.722656 94.878906 L 286.460938 89.265625 C 286.683594 88.503906 286.628906 87.84375 286.296875 87.289062 C 285.964844 86.734375 285.410156 86.457031 284.636719 86.457031 L 234.246094 86.457031 C 233.527344 86.457031 232.824219 86.734375 232.132812 87.289062 C 231.441406 87.84375 230.984375 88.503906 230.765625 89.265625 Z M 222.144531 117.347656 C 221.925781 118.105469 221.980469 118.765625 222.3125 119.320312 C 222.640625 119.875 223.195312 120.15625 223.96875 120.15625 L 274.359375 120.15625 C 275.078125 120.15625 275.785156 119.875 276.472656 119.320312 C 277.164062 118.765625 277.621094 118.105469 277.84375 117.347656 L 279.582031 111.730469 C 279.804688 110.96875 279.746094 110.3125 279.417969 109.757812 C 279.085938 109.199219 278.53125 108.921875 277.757812 108.921875 L 227.367188 108.921875 C 226.648438 108.921875 225.945312 109.199219 225.253906 109.757812 C 224.5625 110.3125 224.105469 110.96875 223.886719 111.730469 Z M 222.144531 117.347656 "/>
++</g>
++</svg>
--- /dev/null
--- /dev/null
++# DocStringExtensions
++
++```@docs
++DocStringExtensions
++```
++
++## Index
++
++```@index
++Modules = [DocStringExtensions]
++```
++
++## Reference
++
++```@autodocs
++Modules = [DocStringExtensions]
++Order = [:constant, :function, :macro, :type]
++```
++
--- /dev/null
--- /dev/null
++# Showcase
++
++```@meta
++CurrentModule = Showcase
++```
++
++This page shows how the various abbreviations look.
++The docstrings themselves can be found in `docs/Showcase/src/Showcase.jl`.
++
++## Modules
++
++```@docs
++Showcase
++```
++
++## Functions and methods
++
++```@docs
++foo
++foo(::Int)
++foo(::String)
++```
++
++## Types
++
++```@docs
++Foobar
++```
--- /dev/null
--- /dev/null
++__precompile__(true)
++
++"""
++*Extensions for the Julia docsystem.*
++
++# Introduction
++
++This package provides a collection of useful extensions for Julia's built-in docsystem.
++These are features that are still regarded as "experimental" and not yet mature enough to be
++considered for inclusion in `Base`, or that have sufficiently niche use cases that including
++them with the default Julia installation is not seen as valuable enough at this time.
++
++Currently `DocStringExtensions.jl` exports a collection of so-called "abbreviations", which
++can be used to add useful automatically generated information to docstrings. These include
++information such as:
++
++ * simplified method signatures;
++ * documentation for the individual fields of composite types;
++ * import and export lists for modules;
++ * and source-linked lists of methods applicable to a particular docstring.
++
++Users are most welcome to suggest additional abbreviation ideas, or implement and submit
++them themselves. Julia's strong support for program introspection makes this a reasonably
++straight forward process.
++
++Details of the currently available abbreviations can be viewed in their individual
++docstrings listed below in the "Exports" section.
++
++# Examples
++
++In simple terms an abbreviation can be used by simply interpolating it into a suitable
++docstring. For example:
++
++```julia
++using DocStringExtensions
++
++\"""
++A short summary of `func`...
++
++\$(SIGNATURES)
++
++where `x` and `y` should both be positive.
++
++# Details
++
++Some details about `func`...
++\"""
++func(x, y) = x + y
++```
++
++`\$(SIGNATURES)` will be replaced in the above docstring with
++
++````markdown
++# Signatures
++
++```julia
++func(x, y)
++```
++````
++
++The resulting generated content can be viewed via Julia's `?` mode or, if `Documenter.jl` is
++set up, the generated external documentation.
++
++The advantage of using [`SIGNATURES`](@ref) (and other abbreviations) is that docstrings are
++less likely to become out-of-sync with the surrounding code. Note though that references to
++the argument names `x` and `y` that have been manually embedded within the docstring are, of
++course, not updated automatically.
++
++# Exports
++$(EXPORTS)
++
++# Imports
++$(IMPORTS)
++
++"""
++module DocStringExtensions
++
++# Exports.
++
++export @template, FIELDS, TYPEDFIELDS, EXPORTS, METHODLIST, IMPORTS
++export SIGNATURES, TYPEDSIGNATURES, TYPEDEF, DOCSTRING, FUNCTIONNAME
++export README, LICENSE
++
++# Includes.
++
++include("utilities.jl")
++include("abbreviations.jl")
++include("templates.jl")
++
++#
++# Bootstrap abbreviations.
++#
++# Within the package itself we would like to be able to use the abbreviations that have been
++# implemented. To do this we need to delay evaluation of the interpolated abbreviations
++# until they have all been defined. We use `Symbol`s in place of the actual constants, such
++# as `METHODLIST` which is written as `:METHODLIST` instead.
++#
++# The docstring for the module itself, defined at the start of the file, does not need to
++# use `Symbol`s since with the way `@doc` works the module docstring gets inserted at the
++# end of the module definition and so has all the definitions already defined.
++#
++let λ = s -> isa(s, Symbol) ? getfield(DocStringExtensions, s) : s
++ for (binding, multidoc) in Docs.meta(DocStringExtensions)
++ for (typesig, docstr) in multidoc.docs
++ docstr.text = Core.svec(map(λ, docstr.text)...)
++ end
++ end
++end
++
++__init__() = (hook!(template_hook); nothing)
++
++end # module
--- /dev/null
--- /dev/null
++
++#
++# Abstract Interface.
++#
++
++"""
++Abbreviation objects are used to automatically generate context-dependent markdown content
++within documentation strings. Objects of this type interpolated into docstrings will be
++expanded automatically before parsing the text to markdown.
++
++$(:FIELDS)
++"""
++abstract type Abbreviation end
++
++"""
++$(:SIGNATURES)
++
++Expand the [`Abbreviation`](@ref) `abbr` in the context of the `DocStr` `doc` and write
++the resulting markdown-formatted text to the `IOBuffer` `buf`.
++"""
++format(abbr, buf, doc) = error("`format` not implemented for `$typeof(abbr)`.")
++
++# Only extend `formatdoc` once with our abstract type. Within the package use a different
++# `format` function instead to keep things decoupled from `Base` as much as possible.
++Docs.formatdoc(buf::IOBuffer, doc::Docs.DocStr, part::Abbreviation) = format(part, buf, doc)
++
++
++#
++# Implementations.
++#
++
++
++#
++# `TypeFields`
++#
++
++"""
++The type for [`FIELDS`](@ref) abbreviations.
++
++$(:FIELDS)
++"""
++struct TypeFields <: Abbreviation
++ types::Bool
++end
++
++"""
++An [`Abbreviation`](@ref) to include the names of the fields of a type as well as any
++documentation that may be attached to the fields.
++
++# Examples
++
++The generated markdown text should look similar to to following example where a
++type has three fields (`x`, `y`, and `z`) and the last two have documentation
++attached.
++
++```markdown
++
++ - `x`
++
++ - `y`
++
++ Unlike the `x` field this field has been documented.
++
++ - `z`
++
++ Another documented field.
++```
++"""
++const FIELDS = TypeFields(false)
++
++"""
++Identical to [`FIELDS`](@ref) except that it includes the field types.
++
++# Examples
++
++The generated markdown text should look similar to to following example where
++a type has three fields; `x` of type `String`, `y` of type `Int`, and `z` of
++type `Vector{Any}`.
++
++```markdown
++
++ - `x::String`
++
++ - `y::Int`
++
++ Unlike the `x` field this field has been documented.
++
++ - `z::Array{Any, 1}`
++
++ Another documented field.
++```
++"""
++const TYPEDFIELDS = TypeFields(true)
++
++function format(abbrv::TypeFields, buf, doc)
++ local docs = get(doc.data, :fields, Dict())
++ local binding = doc.data[:binding]
++ local object = Docs.resolve(binding)
++ # On 0.7 fieldnames() on an abstract type throws an error. We then explicitly return
++ # an empty vector to be consistent with the behaviour on v0.6.
++ local fields = isabstracttype(object) ? Symbol[] : fieldnames(object)
++ if !isempty(fields)
++ println(buf)
++ for field in fields
++ if abbrv.types
++ println(buf, " - `", field, "::", fieldtype(object, field), "`")
++ else
++ println(buf, " - `", field, "`")
++ end
++ # Print the field docs if they exist and aren't a `doc"..."` docstring.
++ if haskey(docs, field) && isa(docs[field], AbstractString)
++ println(buf)
++ for line in split(docs[field], "\n")
++ println(buf, isempty(line) ? "" : " ", rstrip(line))
++ end
++ end
++ println(buf)
++ end
++ println(buf)
++ end
++ return nothing
++end
++
++
++#
++# `ModuleExports`
++#
++
++"""
++The singleton type for [`EXPORTS`](@ref) abbreviations.
++
++$(:FIELDS)
++"""
++struct ModuleExports <: Abbreviation end
++
++"""
++An [`Abbreviation`](@ref) to include all the exported names of a module is a sorted list of
++`Documenter.jl`-style `@ref` links.
++
++!!! note
++
++ The names are sorted alphabetically and ignore leading `@` characters so that macros are
++ *not* sorted before other names.
++
++# Examples
++
++The markdown text generated by the `EXPORTS` abbreviation looks similar to the following:
++
++```markdown
++
++ - [`bar`](@ref)
++ - [`@baz`](@ref)
++ - [`foo`](@ref)
++
++```
++"""
++const EXPORTS = ModuleExports()
++
++function format(::ModuleExports, buf, doc)
++ local binding = doc.data[:binding]
++ local object = Docs.resolve(binding)
++ local exports = names(object)
++ if !isempty(exports)
++ println(buf)
++ # Sorting ignores the `@` in macro names and sorts them in with others.
++ for sym in sort(exports, by = s -> lstrip(string(s), '@'))
++ # Skip the module itself, since that's always exported.
++ sym === nameof(object) && continue
++ # We print linked names using Documenter.jl cross-reference syntax
++ # for ease of integration with that package.
++ println(buf, " - [`", sym, "`](@ref)")
++ end
++ println(buf)
++ end
++ return nothing
++end
++
++
++#
++# `ModuleImports`
++#
++
++"""
++The singleton type for [`IMPORTS`](@ref) abbreviations.
++
++$(:FIELDS)
++"""
++struct ModuleImports <: Abbreviation end
++
++"""
++An [`Abbreviation`](@ref) to include all the imported modules in a sorted list.
++
++# Examples
++
++The markdown text generated by the `IMPORTS` abbreviation looks similar to the following:
++
++```markdown
++
++ - `Foo`
++ - `Bar`
++ - `Baz`
++
++```
++"""
++const IMPORTS = ModuleImports()
++
++function format(::ModuleImports, buf, doc)
++ local binding = doc.data[:binding]
++ local object = Docs.resolve(binding)
++ local imports = unique(ccall(:jl_module_usings, Any, (Any,), object))
++ if !isempty(imports)
++ println(buf)
++ for mod in sort(imports, by = string)
++ println(buf, " - `", mod, "`")
++ end
++ println(buf)
++ end
++end
++
++
++#
++# `MethodList`
++#
++
++"""
++The singleton type for [`METHODLIST`](@ref) abbreviations.
++
++$(:FIELDS)
++"""
++struct MethodList <: Abbreviation end
++
++"""
++An [`Abbreviation`](@ref) for including a list of all the methods that match a documented
++`Method`, `Function`, or `DataType` within the current module.
++
++# Examples
++
++The generated markdown text will look similar to the following example where a function
++`f` defines two different methods (one that takes a number, and the other a string):
++
++````markdown
++```julia
++f(num)
++```
++
++defined at [`<path>:<line>`](<github-url>).
++
++```julia
++f(str)
++```
++
++defined at [`<path>:<line>`](<github-url>).
++````
++"""
++const METHODLIST = MethodList()
++
++function format(::MethodList, buf, doc)
++ local binding = doc.data[:binding]
++ local typesig = doc.data[:typesig]
++ local modname = doc.data[:module]
++ local func = Docs.resolve(binding)
++ local groups = methodgroups(func, typesig, modname; exact = false)
++ if !isempty(groups)
++ println(buf)
++ for group in groups
++ println(buf, "```julia")
++ for method in group
++ printmethod(buf, binding, func, method)
++ println(buf)
++ end
++ println(buf, "```\n")
++ if !isempty(group)
++ local method = group[1]
++ local file = string(method.file)
++ local line = method.line
++ local path = cleanpath(file)
++ local URL = url(method)
++ isempty(URL) || println(buf, "defined at [`$path:$line`]($URL).")
++ end
++ println(buf)
++ end
++ println(buf)
++ end
++ return nothing
++end
++
++
++#
++# `MethodSignatures`
++#
++
++"""
++The singleton type for [`SIGNATURES`](@ref) abbreviations.
++
++$(:FIELDS)
++"""
++struct MethodSignatures <: Abbreviation end
++
++"""
++An [`Abbreviation`](@ref) for including a simplified representation of all the method
++signatures that match the given docstring. See [`printmethod`](@ref) for details on
++the simplifications that are applied.
++
++# Examples
++
++The generated markdown text will look similar to the following example where a function `f`
++defines method taking two positional arguments, `x` and `y`, and two keywords, `a` and the `b`.
++
++````markdown
++```julia
++f(x, y; a, b...)
++```
++````
++"""
++const SIGNATURES = MethodSignatures()
++
++function format(::MethodSignatures, buf, doc)
++ local binding = doc.data[:binding]
++ local typesig = doc.data[:typesig]
++ local modname = doc.data[:module]
++ local func = Docs.resolve(binding)
++ local groups = methodgroups(func, typesig, modname)
++ if !isempty(groups)
++ println(buf)
++ println(buf, "```julia")
++ for group in groups
++ for method in group
++ printmethod(buf, binding, func, method)
++ println(buf)
++ end
++ end
++ println(buf, "\n```\n")
++ end
++end
++
++
++#
++# `TypedMethodSignatures`
++#
++
++"""
++The singleton type for [`TYPEDSIGNATURES`](@ref) abbreviations.
++
++$(:FIELDS)
++"""
++struct TypedMethodSignatures <: Abbreviation end
++
++"""
++An [`Abbreviation`](@ref) for including a simplified representation of all the method
++signatures with types that match the given docstring. See [`printmethod`](@ref) for details on
++the simplifications that are applied.
++
++# Examples
++
++The generated markdown text will look similar to the following example where a function `f`
++defines method taking two positional arguments, `x` and `y`, and two keywords, `a` and the `b`.
++
++````markdown
++```julia
++f(x::Int, y::Int; a, b...)
++```
++````
++"""
++const TYPEDSIGNATURES = TypedMethodSignatures()
++
++function format(::TypedMethodSignatures, buf, doc)
++ local binding = doc.data[:binding]
++ local typesig = doc.data[:typesig]
++ local modname = doc.data[:module]
++ local func = Docs.resolve(binding)
++ local groups = methodgroups(func, typesig, modname)
++ if !isempty(groups)
++ println(buf)
++ println(buf, "```julia")
++ for group in groups
++ if length(group) == 1
++ for method in group
++ printmethod(buf, binding, func, method, typesig)
++ println(buf)
++ end
++ else
++ for (i, method) in enumerate(group)
++ if i == length(group)
++ t = typesig
++ else
++ t = typesig.a
++ typesig = typesig.b
++ end
++ printmethod(buf, binding, func, method, t)
++ println(buf)
++ end
++ end
++ end
++ println(buf, "\n```\n")
++ end
++end
++
++#
++# `FunctionName`
++#
++
++"""
++The singleton type for [`FUNCTIONNAME`](@ref) abbreviations.
++
++$(:FIELDS)
++"""
++struct FunctionName <: Abbreviation end
++
++"""
++An [`Abbreviation`](@ref) for including the function name matching the method of
++the docstring.
++
++# Usage
++
++This is mostly useful for not repeating the function name in docstrings where
++the user wants to retain full control of the argument list, or the latter does
++not exist (eg generic functions).
++
++Note that the generated docstring snippet is not quoted, use indentation or
++explicit quoting.
++
++# Example
++
++```julia
++\"""
++ \$(FUNCTIONNAME)(d, θ)
++
++Calculate the logdensity `d` at `θ`.
++
++Users should define their own methods for `$(FUNCTIONNAME)`.
++\"""
++function logdensity end
++```
++"""
++const FUNCTIONNAME = FunctionName()
++
++format(::FunctionName, buf, doc) = print(buf, doc.data[:binding].var)
++
++#
++# `TypeSignature`
++#
++
++"""
++The singleton type for [`TYPEDEF`](@ref) abbreviations.
++"""
++struct TypeDefinition <: Abbreviation end
++
++"""
++An [`Abbreviation`](@ref) for including a summary of the signature of a type definition.
++Some of the following information may be included in the output:
++
++ * whether the object is an `abstract` type or a `bitstype`;
++ * mutability (either `type` or `struct` is printed);
++ * the unqualified name of the type;
++ * any type parameters;
++ * the supertype of the type if it is not `Any`.
++
++# Examples
++
++The generated output for a type definition such as:
++
++```julia
++\"""
++\$(TYPEDEF)
++\"""
++struct MyType{S, T <: Integer} <: AbstractArray
++ # ...
++end
++```
++
++will look similar to the following:
++
++````markdown
++```julia
++struct MyType{S, T<:Integer} <: AbstractArray
++```
++````
++
++!!! note
++
++ No information about the fields of the type is printed. Use the [`FIELDS`](@ref)
++ abbreviation to include information about the fields of a type.
++"""
++const TYPEDEF = TypeDefinition()
++
++function print_supertype(buf, object)
++ super = supertype(object)
++ super != Any && print(buf, " <: ", super)
++end
++
++function print_params(buf, object)
++ if !isempty(object.parameters)
++ print(buf, "{")
++ join(buf, object.parameters, ", ")
++ print(buf, "}")
++ end
++end
++
++function print_primitive_type(buf, object)
++ print(buf, "primitive type ", object.name.name)
++ print_supertype(buf, object)
++ print(buf, " ", sizeof(object) * 8)
++ println(buf)
++end
++
++function print_abstract_type(buf, object)
++ print(buf, "abstract type ", object.name.name)
++ print_supertype(buf, object)
++ println(buf)
++end
++
++function print_mutable_struct_or_struct(buf, object)
++ object.mutable && print(buf, "mutable ")
++ print(buf, "struct ", object.name.name)
++ print_params(buf, object)
++ print_supertype(buf, object)
++ println(buf)
++end
++
++@static if VERSION < v"0.7.0"
++ isprimitivetype(x) = isbitstype(x)
++end
++
++function format(::TypeDefinition, buf, doc)
++ local binding = doc.data[:binding]
++ local object = gettype(Docs.resolve(binding))
++ if isa(object, DataType)
++ println(buf, "\n```julia")
++ if isprimitivetype(object)
++ print_primitive_type(buf, object)
++ elseif isabstracttype(object)
++ print_abstract_type(buf, object)
++ else
++ print_mutable_struct_or_struct(buf, object)
++ end
++ println(buf, "```\n")
++ end
++end
++
++"""
++The singleton type for [`README`](@ref) abbreviations.
++"""
++struct Readme <: Abbreviation end
++"""
++ README
++
++An [`Abbreviation`](@ref) for including the package README.md.
++
++!!! note
++ The README.md file is interpreted as ["Julia flavored Markdown"]
++ (https://docs.julialang.org/en/v1/manual/documentation/#Markdown-syntax-1),
++ which has some differences compared to GitHub flavored markdown, and,
++ for example, [][] link shortcuts are not supported.
++"""
++const README = Readme()
++"""
++The singleton type for [`LICENSE`](@ref) abbreviations.
++"""
++struct License <: Abbreviation end
++"""
++ LICENSE
++
++An [`Abbreviation`](@ref) for including the package LICENSE.md.
++
++!!! note
++ The LICENSE.md file is interpreted as ["Julia flavored Markdown"]
++ (https://docs.julialang.org/en/v1/manual/documentation/#Markdown-syntax-1),
++ which has some differences compared to GitHub flavored markdown, and,
++ for example, [][] link shortcuts are not supported.
++"""
++const LICENSE = License()
++
++function format(::T, buf, doc) where T <: Union{Readme,License}
++ m = get(doc.data, :module, nothing)
++ m === nothing && return
++ path = pathof(m)
++ path === nothing && return
++ try # wrap in try/catch since we shouldn't error in case some IO operation goes wrong
++ r = T === Readme ? r"(?i)readme(?-i)" : r"(?i)license(?-i)"
++ # assume README/LICENSE is located in the root of the repo
++ root = normpath(joinpath(path, "..", ".."))
++ for file in readdir(root)
++ if occursin(r, file)
++ str = read(joinpath(root, file), String)
++ write(buf, str)
++ return
++ end
++ end
++ catch
++ end
++end
++
++
++#
++# `DocStringTemplate`
++#
++
++"""
++The singleton type for [`DOCSTRING`](@ref) abbreviations.
++"""
++struct DocStringTemplate <: Abbreviation end
++
++"""
++An [`Abbreviation`](@ref) used in [`@template`](@ref) definitions to represent the location
++of the docstring body that should be spliced into a template.
++
++!!! warning
++
++ This abbreviation must only ever be used in template strings; never normal docstrings.
++"""
++const DOCSTRING = DocStringTemplate()
++
++# NOTE: no `format` needed for this 'mock' abbreviation.
--- /dev/null
--- /dev/null
++const expander = Core.atdoc
++const setter! = Core.atdoc!
++
++"""
++$(:SIGNATURES)
++
++Set the docstring expander function to first call `func` before calling the default expander.
++
++To remove a hook that has been applied using this method call [`hook!()`](@ref).
++"""
++hook!(func) = setter!((args...) -> expander(func(args...)...))
++
++"""
++$(:SIGNATURES)
++
++Reset the docstring expander to only call the default expander function. This clears any
++'hook' that has been set using [`hook!(func)`](@ref).
++"""
++hook!() = setter!(expander)
++
++"""
++$(:SIGNATURES)
++
++Defines a docstring template that will be applied to all docstrings in a module that match
++the specified category or tuple of categories.
++
++# Examples
++
++```julia
++@template DEFAULT =
++ \"""
++ \$(SIGNATURES)
++ \$(DOCSTRING)
++ \"""
++```
++
++`DEFAULT` is the default template that is applied to a docstring if no other template
++definitions match the documented expression. The `DOCSTRING` abbreviation is used to mark
++the location in the template where the actual docstring body will be spliced into each
++docstring.
++
++```julia
++@template (FUNCTIONS, METHODS, MACROS) =
++ \"""
++ \$(SIGNATURES)
++ \$(DOCSTRING)
++ \$(METHODLIST)
++ \"""
++```
++
++A tuple of categories can be specified when a docstring template should be used for several
++different categories.
++
++```julia
++@template MODULES = ModName
++```
++
++The template definition above will define a template for module docstrings based on the
++template for modules found in module `ModName`.
++
++!!! note
++
++ Supported categories are `DEFAULT`, `FUNCTIONS`, `METHODS`, `MACROS`, `TYPES`,
++ `MODULES`, and `CONSTANTS`.
++
++"""
++macro template(ex)
++ # JuliaLang/julia#22064 introduced the __module__ variable and deprecated current_module()
++ @static if VERSION >= v"0.7.0-DEV.484"
++ template(__source__, __module__, ex)
++ else
++ template(LineNumberNode(0), current_module(), ex)
++ end
++end
++
++const TEMP_SYM = gensym("templates")
++
++function template(src::LineNumberNode, mod::Module, ex::Expr)
++ Meta.isexpr(ex, :(=), 2) || error("invalid `@template` syntax.")
++ template(src, mod, ex.args[1], ex.args[2])
++end
++
++function template(source::LineNumberNode, mod::Module, tuple::Expr, docstr::Union{Symbol, Expr})
++ Meta.isexpr(tuple, :tuple) || error("invalid `@template` syntax on LHS.")
++ isdefined(mod, TEMP_SYM) || Core.eval(mod, :(const $(TEMP_SYM) = $(Dict{Symbol, Vector}())))
++ local block = Expr(:block)
++ for category in tuple.args
++ local key = Meta.quot(category)
++ local vec = Meta.isexpr(docstr, :string) ?
++ Expr(:vect, docstr.args...) : :($(docstr).$(TEMP_SYM)[$(key)])
++ push!(block.args, :($(TEMP_SYM)[$(key)] = $(vec)))
++ end
++ push!(block.args, nothing)
++ return esc(block)
++end
++
++function template(src::LineNumberNode, mod::Module, sym::Symbol, docstr::Union{Symbol, Expr})
++ template(src, mod, Expr(:tuple, sym), docstr)
++end
++
++# The signature for the atdocs() calls changed in v0.7
++# On v0.6 and below it seems it was assumed to be (docstr::String, expr::Expr), but on v0.7
++# it is (source::LineNumberNode, mod::Module, docstr::String, expr::Expr)
++function template_hook(source::LineNumberNode, mod::Module, docstr, expr::Expr)
++ local docex = interp_string(docstr)
++ if isdefined(mod, TEMP_SYM) && Meta.isexpr(docex, :string)
++ local templates = getfield(mod, TEMP_SYM)
++ local template = get_template(templates, expression_type(expr))
++ local out = Expr(:string)
++ for t in template
++ t == DOCSTRING ? append!(out.args, docex.args) : push!(out.args, t)
++ end
++ return (source, mod, out, expr)
++ else
++ return (source, mod, docstr, expr)
++ end
++end
++
++function template_hook(docstr, expr::Expr)
++ source, mod, docstr, expr::Expr = template_hook(LineNumberNode(0), current_module(), docstr, expr)
++ docstr, expr
++end
++
++template_hook(args...) = args
++
++interp_string(str::AbstractString) = Expr(:string, str)
++interp_string(other) = other
++
++get_template(t::Dict, k::Symbol) = haskey(t, k) ? t[k] : get(t, :DEFAULT, Any[DOCSTRING])
++
++function expression_type(ex::Expr)
++ # Expression heads changed in JuliaLang/julia/pull/23157 to match the new keyword syntax.
++ if VERSION < v"0.7.0-DEV.1263" && Meta.isexpr(ex, [:type, :bitstype])
++ :TYPES
++ elseif Meta.isexpr(ex, :module)
++ :MODULES
++ elseif Meta.isexpr(ex, [:struct, :abstract, :typealias, :primitive])
++ :TYPES
++ elseif Meta.isexpr(ex, :macro)
++ :MACROS
++ elseif Meta.isexpr(ex, [:function, :(=)]) && Meta.isexpr(ex.args[1], :call) || (Meta.isexpr(ex.args[1], :where) && Meta.isexpr(ex.args[1].args[1], :call))
++ :METHODS
++ elseif Meta.isexpr(ex, :function)
++ :FUNCTIONS
++ elseif Meta.isexpr(ex, [:const, :(=)])
++ :CONSTANTS
++ else
++ :DEFAULT
++ end
++end
++expression_type(other) = :DEFAULT
--- /dev/null
--- /dev/null
++
++#
++# Utilities.
++#
++
++#
++# Method grouping.
++#
++
++"""
++$(:SIGNATURES)
++
++Group all methods of function `func` with type signatures `typesig` in module `modname`.
++Keyword argument `exact = true` matches signatures "exactly" with `==` rather than `<:`.
++
++# Examples
++
++```julia
++groups = methodgroups(f, Union{Tuple{Any}, Tuple{Any, Integer}}, Main; exact = false)
++```
++"""
++function methodgroups(func, typesig, modname; exact = true)
++ # Group methods by file and line number.
++ local methods = getmethods(func, typesig)
++ local groups = groupby(Tuple{Symbol, Int}, Vector{Method}, methods) do m
++ (m.file, m.line), m
++ end
++
++ # Filter out methods from other modules and with non-matching signatures.
++ local typesigs = alltypesigs(typesig)
++ local results = Vector{Method}[]
++ for (key, group) in groups
++ filter!(group) do m
++ local ismod = m.module == modname
++ exact ? (ismod && Base.rewrap_unionall(Base.tuple_type_tail(m.sig), m.sig) in typesigs) : ismod
++ end
++ isempty(group) || push!(results, group)
++ end
++
++ # Sort the groups by file and line.
++ sort!(results, lt = comparemethods, by = first)
++
++ return results
++end
++
++"""
++$(:SIGNATURES)
++
++Compare methods `a` and `b` by file and line number.
++"""
++function comparemethods(a::Method, b::Method)
++ comp = a.file < b.file ? -1 : a.file > b.file ? 1 : 0
++ comp == 0 ? a.line < b.line : comp < 0
++end
++
++if isdefined(Base, :UnionAll)
++ uniontypes(T) = uniontypes!(Any[], T)
++ function uniontypes!(out, T)
++ if isa(T, Union)
++ push!(out, T.a)
++ uniontypes!(out, T.b)
++ else
++ push!(out, T)
++ end
++ return out
++ end
++ gettype(T::UnionAll) = gettype(T.body)
++else
++ uniontypes(T) = collect(T.types)
++end
++gettype(other) = other
++
++"""
++$(:SIGNATURES)
++
++A helper method for [`getmethods`](@ref) that collects methods in `results`.
++"""
++function getmethods!(results, f, sig)
++ if sig == Union{}
++ append!(results, methods(f))
++ elseif isa(sig, Union)
++ for each in uniontypes(sig)
++ getmethods!(results, f, each)
++ end
++ elseif isa(sig, UnionAll)
++ getmethods!(results, f, Base.unwrap_unionall(sig))
++ else
++ append!(results, methods(f, sig))
++ end
++ return results
++end
++"""
++$(:SIGNATURES)
++
++Collect and return all methods of function `f` matching signature `sig`.
++
++This is similar to `methods(f, sig)`, but handles type signatures found in `DocStr` objects
++more consistently that `methods`.
++"""
++getmethods(f, sig) = unique(getmethods!(Method[], f, sig))
++
++
++"""
++$(:SIGNATURES)
++
++Is the type `t` a `bitstype`?
++"""
++isbitstype(@nospecialize(t)) = isconcretetype(t) && sizeof(t) > 0 && isbits(t)
++
++"""
++$(:SIGNATURES)
++
++Is the type `t` an `abstract` type?
++"""
++isabstracttype(@nospecialize(t)) = isa(t, DataType) && getfield(t, :abstract)
++
++
++"""
++$(:SIGNATURES)
++
++Returns a `Vector` of the `Tuple` types contained in `sig`.
++"""
++function alltypesigs(sig)::Vector{Any}
++ if sig == Union{}
++ Any[]
++ elseif isa(sig, Union)
++ uniontypes(sig)
++ elseif isa(sig, UnionAll)
++ Base.rewrap_unionall.(uniontypes(Base.unwrap_unionall(sig)), sig)
++ else
++ Any[sig]
++ end
++end
++
++"""
++$(:SIGNATURES)
++
++A helper method for [`groupby`](@ref) that uses a pre-allocated `groups` `Dict`.
++"""
++function groupby!(f, groups, data)
++ for each in data
++ key, value = f(each)
++ push!(get!(groups, key, []), value)
++ end
++ return sort!(collect(groups), by = first)
++end
++
++"""
++$(:SIGNATURES)
++
++Group `data` using function `f` where key type is specified by `K` and group type by `V`.
++
++The function `f` takes a single argument, an element of `data`, and should return a 2-tuple
++of `(computed_key, element)`. See the example below for details.
++
++# Examples
++
++```julia
++groupby(Int, Vector{Int}, collect(1:10)) do num
++ mod(num, 3), num
++end
++```
++"""
++groupby(f, K, V, data) = groupby!(f, Dict{K, V}(), data)
++
++"""
++$(:SIGNATURES)
++
++Remove the `Pkg.dir` part of a file `path` if it exists.
++"""
++function cleanpath(path::AbstractString)
++ for depot in DEPOT_PATH
++ pkgdir = joinpath(depot, "")
++ startswith(path, pkgdir) && return first(split(path, pkgdir, keepempty=false))
++ end
++ return path
++end
++
++"""
++$(:SIGNATURES)
++
++Parse all docstrings defined within a module `mod`.
++"""
++function parsedocs(mod::Module)
++ for (binding, multidoc) in Docs.meta(mod)
++ for (typesig, docstr) in multidoc.docs
++ Docs.parsedoc(docstr)
++ end
++ end
++end
++
++
++"""
++$(:SIGNATURES)
++
++Print a simplified representation of a method signature to `buffer`. Some of these
++simplifications include:
++
++ * no `TypeVar`s;
++ * no types;
++ * no keyword default values;
++ * `?` printed where `#unused#` arguments are found.
++
++# Examples
++
++```julia
++f(x; a = 1, b...) = x
++sig = printmethod(Docs.Binding(Main, :f), f, first(methods(f)))
++```
++"""
++function printmethod(buffer::IOBuffer, binding::Docs.Binding, func, method::Method)
++ # TODO: print qualified?
++ print(buffer, binding.var)
++ print(buffer, "(")
++ join(buffer, arguments(method), ", ")
++ local kws = keywords(func, method)
++ if !isempty(kws)
++ print(buffer, "; ")
++ join(buffer, kws, ", ")
++ end
++ print(buffer, ")")
++ return buffer
++end
++
++"""
++$(:TYPEDSIGNATURES)
++
++Print a simplified representation of a method signature to `buffer`. Some of these
++simplifications include:
++
++ * no `TypeVar`s;
++ * no types;
++ * no keyword default values;
++ * `?` printed where `#unused#` arguments are found.
++
++# Examples
++
++```julia
++f(x::Int; a = 1, b...) = x
++sig = printmethod(Docs.Binding(Main, :f), f, first(methods(f)))
++```
++"""
++function printmethod(buffer::IOBuffer, binding::Docs.Binding, func, method::Method, typesig)
++ # TODO: print qualified?
++ print(buffer, binding.var)
++ print(buffer, "(")
++ local args = arguments(method)
++ for (i, sym) in enumerate(args)
++ if typesig isa UnionAll
++ t = typesig.body.a.types[1]
++ else
++ t = typesig.types[i]
++ end
++ print(buffer, "$sym::$t")
++ if i != length(args)
++ print(buffer, ", ")
++ end
++ end
++ local kws = keywords(func, method)
++ if !isempty(kws)
++ print(buffer, "; ")
++ join(buffer, kws, ", ")
++ end
++ print(buffer, ")")
++ if typesig isa UnionAll
++ t = typesig.body.a
++ else
++ t = typesig
++ end
++ rt = Base.return_types(func, t)
++ if length(rt) >= 1 && rt[1] !== Nothing && rt[1] !== Union{}
++ print(buffer, " -> $(rt[1])")
++ end
++ return buffer
++end
++
++printmethod(b, f, m) = String(take!(printmethod(IOBuffer(), b, f, m)))
++
++get_method_source(m::Method) = Base.uncompressed_ast(m)
++nargs(m::Method) = m.nargs
++
++
++"""
++$(:SIGNATURES)
++
++Returns the list of keywords for a particular method `m` of a function `func`.
++
++# Examples
++
++```julia
++f(x; a = 1, b...) = x
++kws = keywords(f, first(methods(f)))
++```
++"""
++function keywords(func, m::Method)
++ local table = methods(func).mt
++ # table is a MethodTable object. For some reason, the :kwsorter field is not always
++ # defined. An undefined kwsorter seems to imply that there are no methods in the
++ # MethodTable with keyword arguments.
++ if isdefined(table, :kwsorter)
++ # Fetching method keywords stolen from base/replutil.jl:572-576 (commit 3b45cdc9aab0):
++ local kwargs = Base.kwarg_decl(m, typeof(table.kwsorter))
++ if isa(kwargs, Vector) && length(kwargs) > 0
++ filter!(arg -> !occursin("#", string(arg)), kwargs)
++ # Keywords *may* not be sorted correctly. We move the vararg one to the end.
++ local index = findfirst(arg -> endswith(string(arg), "..."), kwargs)
++ if index != nothing
++ kwargs[index], kwargs[end] = kwargs[end], kwargs[index]
++ end
++ return kwargs
++ end
++ end
++ return Symbol[]
++end
++
++
++"""
++$(:SIGNATURES)
++
++Returns the list of arguments for a particular method `m`.
++
++# Examples
++
++```julia
++f(x; a = 1, b...) = x
++args = arguments(first(methods(f)))
++```
++"""
++function arguments(m::Method)
++ local template = get_method_source(m)
++ if isdefined(template, :slotnames)
++ local args = map(template.slotnames[1:nargs(m)]) do arg
++ arg === Symbol("#unused#") ? "?" : arg
++ end
++ return filter(arg -> arg !== Symbol("#self#"), args)
++ end
++ return Symbol[]
++end
++
++#
++# Source URLs.
++#
++# Based on code from https://github.com/JuliaLang/julia/blob/master/base/methodshow.jl.
++#
++# Customised to handle URLs on travis since the directory is not a Git repo and we must
++# instead rely on `TRAVIS_REPO_SLUG` to get the remote repo.
++#
++
++"""
++$(:SIGNATURES)
++
++Get the URL (file and line number) where a method `m` is defined.
++
++Note that this is based on the implementation of `Base.url`, but handles URLs correctly
++on TravisCI as well.
++"""
++url(m::Method) = url(m.module, string(m.file), m.line)
++
++import LibGit2
++
++function url(mod::Module, file::AbstractString, line::Integer)
++ file = Sys.iswindows() ? replace(file, '\\' => '/') : file
++ if Base.inbase(mod) && !isabspath(file)
++ local base = "https://github.com/JuliaLang/julia/tree"
++ if isempty(Base.GIT_VERSION_INFO.commit)
++ return "$base/v$VERSION/base/$file#L$line"
++ else
++ local commit = Base.GIT_VERSION_INFO.commit
++ return "$base/$commit/base/$file#L$line"
++ end
++ else
++ if isfile(file)
++ local d = dirname(file)
++ try # might not be in a git repo
++ LibGit2.with(LibGit2.GitRepoExt(d)) do repo
++ LibGit2.with(LibGit2.GitConfig(repo)) do cfg
++ local u = LibGit2.get(cfg, "remote.origin.url", "")
++ local m = match(LibGit2.GITHUB_REGEX, u)
++ u = m === nothing ? get(ENV, "TRAVIS_REPO_SLUG", "") : m.captures[1]
++ local commit = string(LibGit2.head_oid(repo))
++ local root = LibGit2.path(repo)
++ if startswith(file, root) || startswith(realpath(file), root)
++ local base = "https://github.com/$u/tree"
++ local filename = file[(length(root) + 1):end]
++ return "$base/$commit/$filename#L$line"
++ else
++ return ""
++ end
++ end
++ end
++ catch err
++ isa(err, LibGit2.GitError) || rethrow()
++ return ""
++ end
++ else
++ return ""
++ end
++ end
++end
--- /dev/null
--- /dev/null
++module M
++
++export f
++
++f(x) = x
++
++g(x = 1, y = 2, z = 3; kwargs...) = x
++
++h(x::Int, y::Int = 2, z::Int = 3; kwargs...) = x
++
++const A{T} = Union{Vector{T}, Matrix{T}}
++
++h_1(x::A) = x
++h_2(x::A{Int}) = x
++h_3(x::A{T}) where {T} = x
++
++i_1(x; y = x) = x * y
++i_2(x::Int; y = x) = x * y
++i_3(x::T; y = x) where {T} = x * y
++i_4(x; y::T = zero(T), z::U = zero(U)) where {T, U} = x + y + z
++
++j_1(x, y) = x * y # two arguments, no keyword arguments
++j_1(x; y = x) = x * y # one argument, one keyword argument
++
++mutable struct T
++ a
++ b
++ c
++end
++
++struct K
++ K(; a = 1) = new()
++end
++
++
++abstract type AbstractType <: Integer end
++
++struct CustomType{S, T <: Integer} <: Integer
++end
++
++primitive type BitType8 8 end
++
++primitive type BitType32 <: Real 32 end
++
++end
--- /dev/null
--- /dev/null
++# Only run coverage from linux nightly build on travis.
++get(ENV, "TRAVIS_OS_NAME", "") == "linux" || exit()
++get(ENV, "TRAVIS_JULIA_VERSION", "") == "nightly" || exit()
++using Pkg
++Pkg.add("Coverage")
++using Coverage
++
++cd(joinpath(dirname(@__FILE__), "..")) do
++ Codecov.submit(Codecov.process_folder())
++end
--- /dev/null
--- /dev/null
++using DocStringExtensions
++using Test
++import Markdown
++import LibGit2
++
++include("tests.jl")
--- /dev/null
--- /dev/null
++module TemplateTests
++
++using DocStringExtensions
++
++@template DEFAULT =
++ """
++ (DEFAULT)
++
++ $(DOCSTRING)
++ """
++
++@template TYPES =
++ """
++ (TYPES)
++
++ $(TYPEDEF)
++
++ $(DOCSTRING)
++ """
++
++@template (METHODS, MACROS) =
++ """
++ (METHODS, MACROS)
++
++ $(SIGNATURES)
++
++ $(DOCSTRING)
++
++ $(METHODLIST)
++ """
++
++"constant `K`"
++const K = 1
++
++"mutable struct `T`"
++mutable struct T end
++
++"method `f`"
++f(x) = x
++
++"method `g`"
++g(::Type{T}) where {T} = T # Issue 32
++
++"macro `@m`"
++macro m(x) end
++
++module InnerModule
++
++ import ..TemplateTests
++
++ using DocStringExtensions
++
++ @template DEFAULT = TemplateTests
++
++ @template METHODS = TemplateTests
++
++ @template MACROS =
++ """
++ (MACROS)
++
++ $(DOCSTRING)
++
++ $(SIGNATURES)
++ """
++
++ "constant `K`"
++ const K = 1
++
++ "mutable struct `T`"
++ mutable struct T end
++
++ "method `f`"
++ f(x) = x
++
++ "macro `@m`"
++ macro m(x) end
++end
++
++module OtherModule
++
++ import ..TemplateTests
++
++ using DocStringExtensions
++
++ @template TYPES = TemplateTests
++ @template MACROS = TemplateTests.InnerModule
++
++ "mutable struct `T`"
++ mutable struct T end
++
++ "macro `@m`"
++ macro m(x) end
++
++ "method `f`"
++ f(x) = x
++end
++
++end
--- /dev/null
--- /dev/null
++const DSE = DocStringExtensions
++
++include("templates.jl")
++include("TestModule/M.jl")
++
++# initialize a test repo in test/TestModule which is needed for some tests
++function with_test_repo(f)
++ repo = LibGit2.init(joinpath(@__DIR__, "TestModule"))
++ LibGit2.add!(repo, "M.jl")
++ sig = LibGit2.Signature("zeptodoctor", "zeptodoctor@zeptodoctor.com", round(time()), 0)
++ LibGit2.commit(repo, "M.jl", committer = sig, author = sig)
++ LibGit2.GitRemote(repo, "origin", "https://github.com/JuliaDocs/NonExistent.jl.git")
++ try
++ f()
++ finally
++ rm(joinpath(@__DIR__, "TestModule", ".git"); force = true, recursive = true)
++ end
++end
++
++@testset "DocStringExtensions" begin
++ @testset "Base assumptions" begin
++ # The package heavily relies on type and docsystem-related methods and types from
++ # Base, which are generally undocumented and their behaviour might change at any
++ # time. This set of tests is tests and documents the assumptions the package makes
++ # about them.
++ #
++ # The testset is not comprehensive -- i.e. DocStringExtensions makes use of
++ # undocumented features that are not tested here. Should you come across anything
++ # like that, please add a test here.
++ #
++
++ # Getting keyword arguments of a method.
++ #
++ # Used in src/utilities.jl for the keywords() function.
++ #
++ # The methodology is based on a snippet in Base at base/replutil.jl:572-576
++ # (commit 3b45cdc9aab0). It uses the undocumented Base.kwarg_decl() function.
++ @test isdefined(Base, :kwarg_decl)
++ # Its signature is kwarg_decl(m::Method, kwtype::DataType). The second argument
++ # should be the type of the kwsorter from the corresponding MethodTable.
++ @test isa(methods(M.j_1), Base.MethodList)
++ @test isdefined(methods(M.j_1), :mt)
++ local mt = methods(M.j_1).mt
++ @test isa(mt, Core.MethodTable)
++ @test isdefined(mt, :kwsorter)
++ # .kwsorter is not always defined -- namely, it seems when none of the methods
++ # have keyword arguments:
++ @test isdefined(methods(M.f).mt, :kwsorter) === false
++ # M.j_1 has two methods. Fetch the single argument one..
++ local m = which(M.j_1, (Any,))
++ @test isa(m, Method)
++ # .. which should have a single keyword argument, :y
++ # Base.kwarg_decl returns a Vector{Any} of the keyword arguments.
++ local kwargs = Base.kwarg_decl(m, typeof(mt.kwsorter))
++ @test isa(kwargs, Vector{Any})
++ @test kwargs == [:y]
++ # Base.kwarg_decl will return a Tuple{} for some reason when called on a method
++ # that does not have any arguments
++ m = which(M.j_1, (Any,Any)) # fetch the no-keyword method
++ @test Base.kwarg_decl(m, typeof(methods(M.j_1).mt.kwsorter)) == Tuple{}()
++ end
++ @testset "format" begin
++ # Setup.
++ doc = Docs.DocStr(Core.svec(), nothing, Dict())
++ buf = IOBuffer()
++
++ # Errors.
++ @test_throws ErrorException DSE.format(nothing, buf, doc)
++
++ @testset "imports & exports" begin
++ # Module imports.
++ doc.data = Dict(
++ :binding => Docs.Binding(Main, :M),
++ :typesig => Union{},
++ )
++ DSE.format(IMPORTS, buf, doc)
++ str = String(take!(buf))
++ @test occursin("\n - `Base`\n", str)
++ @test occursin("\n - `Core`\n", str)
++
++ # Module exports.
++ DSE.format(EXPORTS, buf, doc)
++ str = String(take!(buf))
++ @test occursin("\n - [`f`](@ref)\n", str)
++ end
++
++ @testset "type fields" begin
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :T),
++ :fields => Dict(
++ :a => "one",
++ :b => "two",
++ ),
++ )
++ DSE.format(FIELDS, buf, doc)
++ str = String(take!(buf))
++ @test occursin(" - `a`", str)
++ @test occursin(" - `b`", str)
++ @test occursin(" - `c`", str)
++ @test occursin("one", str)
++ @test occursin("two", str)
++
++ DSE.format(TYPEDFIELDS, buf, doc)
++ str = String(take!(buf))
++ @test occursin(" - `a::Any`", str)
++ @test occursin(" - `b::Any`", str)
++ @test occursin(" - `c::Any`", str)
++ @test occursin("one", str)
++ @test occursin("two", str)
++ end
++
++ @testset "method lists" begin
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :f),
++ :typesig => Tuple{Any},
++ :module => M,
++ )
++ with_test_repo() do
++ DSE.format(METHODLIST, buf, doc)
++ end
++ str = String(take!(buf))
++ @test occursin("```julia", str)
++ @test occursin("f(x)", str)
++ @test occursin(joinpath("test", "TestModule", "M.jl"), str)
++ end
++
++ @testset "method signatures" begin
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :f),
++ :typesig => Tuple{Any},
++ :module => M,
++ )
++ DSE.format(SIGNATURES, buf, doc)
++ str = String(take!(buf))
++ @test occursin("\n```julia\n", str)
++ @test occursin("\nf(x)\n", str)
++ @test occursin("\n```\n", str)
++
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :g),
++ :typesig => Union{Tuple{}, Tuple{Any}},
++ :module => M,
++ )
++ DSE.format(SIGNATURES, buf, doc)
++ str = String(take!(buf))
++ @test occursin("\n```julia\n", str)
++ @test occursin("\ng()\n", str)
++ @test occursin("\ng(x)\n", str)
++ @test occursin("\n```\n", str)
++
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :g),
++ :typesig => Union{Tuple{}, Tuple{Any}, Tuple{Any, Any}, Tuple{Any, Any, Any}},
++ :module => M,
++ )
++ DSE.format(SIGNATURES, buf, doc)
++ str = String(take!(buf))
++ @test occursin("\n```julia\n", str)
++ @test occursin("\ng()\n", str)
++ @test occursin("\ng(x)\n", str)
++ @test occursin("\ng(x, y)\n", str)
++ @test occursin("\ng(x, y, z; kwargs...)\n", str)
++ @test occursin("\n```\n", str)
++ end
++
++ @testset "method signatures with types" begin
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :h_1),
++ :typesig => Tuple{M.A},
++ :module => M,
++ )
++ DSE.format(DSE.TYPEDSIGNATURES, buf, doc)
++ str = String(take!(buf))
++ @test occursin("\n```julia\n", str)
++ if Sys.iswindows()
++ @test occursin("h_1(x::Union{Array{T,2}, Array{T,1}} where T) -> Union{Array{T,2}, Array{T,1}} where T", str)
++ else
++ @test occursin("h_1(x::Union{Array{T,1}, Array{T,2}} where T) -> Union{Array{T,1}, Array{T,2}} where T", str)
++ end
++ @test occursin("\n```\n", str)
++
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :h),
++ :typesig => Tuple{Int, Int, Int},
++ :module => M,
++ )
++ DSE.format(DSE.TYPEDSIGNATURES, buf, doc)
++ str = String(take!(buf))
++ @test occursin("\n```julia\n", str)
++ if typeof(1) === Int64
++ @test occursin("\nh(x::Int64, y::Int64, z::Int64; kwargs...) -> Int64\n", str)
++ else
++ @test occursin("\nh(x::Int32, y::Int32, z::Int32; kwargs...) -> Int32\n", str)
++ end
++ @test occursin("\n```\n", str)
++
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :h),
++ :typesig => Tuple{Int},
++ :module => M,
++ )
++ DSE.format(DSE.TYPEDSIGNATURES, buf, doc)
++ str = String(take!(buf))
++ @test occursin("\n```julia\n", str)
++ if typeof(1) === Int64
++ @test occursin("\nh(x::Int64) -> Int64\n", str)
++ else
++ @test occursin("\nh(x::Int32) -> Int32\n", str)
++ end
++ @test occursin("\n```\n", str)
++ end
++
++ @testset "function names" begin
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :f),
++ :typesig => Tuple{Any},
++ :module => M,
++ )
++ DSE.format(FUNCTIONNAME, buf, doc)
++ str = String(take!(buf))
++ @test str == "f"
++ end
++
++ @testset "type definitions" begin
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :AbstractType),
++ :typesig => Union{},
++ :module => M,
++ )
++ DSE.format(TYPEDEF, buf, doc)
++ str = String(take!(buf))
++ @test str == "\n```julia\nabstract type AbstractType <: Integer\n```\n\n"
++
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :CustomType),
++ :typesig => Union{},
++ :module => M,
++ )
++ DSE.format(TYPEDEF, buf, doc)
++ str = String(take!(buf))
++ @test str == "\n```julia\nstruct CustomType{S, T<:Integer} <: Integer\n```\n\n"
++
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :BitType8),
++ :typesig => Union{},
++ :module => M,
++ )
++ DSE.format(TYPEDEF, buf, doc)
++ str = String(take!(buf))
++ @test str == "\n```julia\nprimitive type BitType8 8\n```\n\n"
++
++ doc.data = Dict(
++ :binding => Docs.Binding(M, :BitType32),
++ :typesig => Union{},
++ :module => M,
++ )
++ DSE.format(TYPEDEF, buf, doc)
++ str = String(take!(buf))
++ @test str == "\n```julia\nprimitive type BitType32 <: Real 32\n```\n\n"
++ end
++
++ @testset "README/LICENSE" begin
++ doc.data = Dict(:module => DocStringExtensions)
++ DSE.format(README, buf, doc)
++ str = String(take!(buf))
++ @test occursin("*Extensions for Julia's docsystem.*", str)
++ DSE.format(LICENSE, buf, doc)
++ str = String(take!(buf))
++ @test occursin("MIT \"Expat\" License", str)
++ end
++ end
++ @testset "templates" begin
++ let fmt = expr -> Markdown.plain(eval(:(@doc $expr)))
++ @test occursin("(DEFAULT)", fmt(:(TemplateTests.K)))
++ @test occursin("(TYPES)", fmt(:(TemplateTests.T)))
++ @test occursin("(METHODS, MACROS)", fmt(:(TemplateTests.f)))
++ @test occursin("(METHODS, MACROS)", fmt(:(TemplateTests.g)))
++ @test occursin("(METHODS, MACROS)", fmt(:(TemplateTests.@m)))
++
++ @test occursin("(DEFAULT)", fmt(:(TemplateTests.InnerModule.K)))
++ @test occursin("(DEFAULT)", fmt(:(TemplateTests.InnerModule.T)))
++ @test occursin("(METHODS, MACROS)", fmt(:(TemplateTests.InnerModule.f)))
++ @test occursin("(MACROS)", fmt(:(TemplateTests.InnerModule.@m)))
++
++ @test occursin("(TYPES)", fmt(:(TemplateTests.OtherModule.T)))
++ @test occursin("(MACROS)", fmt(:(TemplateTests.OtherModule.@m)))
++ @test fmt(:(TemplateTests.OtherModule.f)) == "method `f`\n"
++ end
++ end
++ @testset "utilities" begin
++ @testset "keywords" begin
++ @test DSE.keywords(M.T, first(methods(M.T))) == Symbol[]
++ @test DSE.keywords(M.K, first(methods(M.K))) == [:a]
++ @test DSE.keywords(M.f, first(methods(M.f))) == Symbol[]
++ let f = (() -> ()),
++ m = first(methods(f))
++ @test DSE.keywords(f, m) == Symbol[]
++ end
++ let f = ((a) -> ()),
++ m = first(methods(f))
++ @test DSE.keywords(f, m) == Symbol[]
++ end
++ let f = ((; a = 1) -> ()),
++ m = first(methods(f))
++ @test DSE.keywords(f, m) == [:a]
++ end
++ let f = ((; a = 1, b = 2) -> ()),
++ m = first(methods(f))
++ @test DSE.keywords(f, m) == [:a, :b]
++ end
++ let f = ((; a...) -> ()),
++ m = first(methods(f))
++ @test DSE.keywords(f, m) == [Symbol("a...")]
++ end
++ # Tests for #42
++ let f = M.i_1, m = first(methods(f))
++ @test DSE.keywords(f, m) == [:y]
++ end
++ let f = M.i_2, m = first(methods(f))
++ @test DSE.keywords(f, m) == [:y]
++ end
++ let f = M.i_3, m = first(methods(f))
++ @test DSE.keywords(f, m) == [:y]
++ end
++ let f = M.i_4, m = first(methods(f))
++ @test DSE.keywords(f, m) == [:y, :z]
++ end
++ end
++ @testset "arguments" begin
++ @test DSE.arguments(first(methods(M.T))) == [:a, :b, :c]
++ @test DSE.arguments(first(methods(M.K))) == Symbol[]
++ @test DSE.arguments(first(methods(M.f))) == [:x]
++ let m = first(methods(() -> ()))
++ @test DSE.arguments(m) == Symbol[]
++ end
++ let m = first(methods((a) -> ()))
++ @test DSE.arguments(m) == [:a]
++ end
++ let m = first(methods((; a = 1) -> ()))
++ @test DSE.arguments(m) == Symbol[]
++ end
++ let m = first(methods((x; a = 1, b = 2) -> ()))
++ @test DSE.arguments(m) == Symbol[:x]
++ end
++ let m = first(methods((; a...) -> ()))
++ @test DSE.arguments(m) == Symbol[]
++ end
++ end
++ @testset "printmethod" begin
++ let b = Docs.Binding(M, :T),
++ f = M.T,
++ m = first(methods(f))
++ @test DSE.printmethod(b, f, m) == "T(a, b, c)"
++ end
++ let b = Docs.Binding(M, :K),
++ f = M.K,
++ m = first(methods(f))
++ @test DSE.printmethod(b, f, m) == "K(; a)"
++ end
++ let b = Docs.Binding(M, :f),
++ f = M.f,
++ m = first(methods(f))
++ @test DSE.printmethod(b, f, m) == "f(x)"
++ end
++ let b = Docs.Binding(Main, :f),
++ f = () -> (),
++ m = first(methods(f))
++ @test DSE.printmethod(b, f, m) == "f()"
++ end
++ let b = Docs.Binding(Main, :f),
++ f = (a) -> (),
++ m = first(methods(f))
++ @test DSE.printmethod(b, f, m) == "f(a)"
++ end
++ let b = Docs.Binding(Main, :f),
++ f = (; a = 1) -> (),
++ m = first(methods(f))
++ @test DSE.printmethod(b, f, m) == "f(; a)"
++ end
++ let b = Docs.Binding(Main, :f),
++ f = (; a = 1, b = 2) -> (),
++ m = first(methods(f))
++ # Keywords are not ordered, so check for both combinations.
++ @test DSE.printmethod(b, f, m) in ("f(; a, b)", "f(; b, a)")
++ end
++ let b = Docs.Binding(Main, :f),
++ f = (; a...) -> (),
++ m = first(methods(f))
++ @test DSE.printmethod(b, f, m) == "f(; a...)"
++ end
++ let b = Docs.Binding(Main, :f),
++ f = (; a = 1, b = 2, c...) -> (),
++ m = first(methods(f))
++ # Keywords are not ordered, so check for both combinations.
++ @test DSE.printmethod(b, f, m) in ("f(; a, b, c...)", "f(; b, a, c...)")
++ end
++ end
++ @testset "getmethods" begin
++ @test length(DSE.getmethods(M.f, Union{})) == 1
++ @test length(DSE.getmethods(M.f, Tuple{})) == 0
++ @test length(DSE.getmethods(M.f, Union{Tuple{}, Tuple{Any}})) == 1
++ @test length(DSE.getmethods(M.h_3, Tuple{M.A{Int}})) == 1
++ @test length(DSE.getmethods(M.h_3, Tuple{Vector{Int}})) == 1
++ @test length(DSE.getmethods(M.h_3, Tuple{Array{Int, 3}})) == 0
++ end
++ @testset "methodgroups" begin
++ @test length(DSE.methodgroups(M.f, Tuple{Any}, M)) == 1
++ @test length(DSE.methodgroups(M.f, Tuple{Any}, M)[1]) == 1
++ @test length(DSE.methodgroups(M.h_1, Tuple{M.A}, M)) == 1
++ @test length(DSE.methodgroups(M.h_1, Tuple{M.A}, M)[1]) == 1
++ @test length(DSE.methodgroups(M.h_2, Tuple{M.A{Int}}, M)) == 1
++ @test length(DSE.methodgroups(M.h_2, Tuple{M.A{Int}}, M)[1]) == 1
++ @test length(DSE.methodgroups(M.h_3, Tuple{M.A}, M)[1]) == 1
++ end
++ @testset "alltypesigs" begin
++ @test DSE.alltypesigs(Union{}) == Any[]
++ @test DSE.alltypesigs(Union{Tuple{}}) == Any[Tuple{}]
++ @test DSE.alltypesigs(Tuple{}) == Any[Tuple{}]
++
++ # TODO: Clean me up
++ T = Type{T} where {T}
++ @test DSE.alltypesigs(T) ==
++ Base.rewrap_unionall.(DSE.uniontypes(Base.unwrap_unionall(T)), T)
++ end
++ @testset "groupby" begin
++ let groups = DSE.groupby(Int, Vector{Int}, collect(1:10)) do each
++ mod(each, 3), each
++ end
++ @test groups == Pair{Int, Vector{Int}}[
++ 0 => [3, 6, 9],
++ 1 => [1, 4, 7, 10],
++ 2 => [2, 5, 8],
++ ]
++ end
++ end
++ @testset "url" begin
++ @test !isempty(DSE.url(first(methods(sin))))
++ with_test_repo() do
++ @test occursin("github.com/JuliaDocs/NonExistent", DSE.url(first(methods(M.f))))
++ @test occursin("github.com/JuliaDocs/NonExistent", DSE.url(first(methods(M.K))))
++ end
++ end
++ @testset "comparemethods" begin
++ let f = first(methods(M.f)),
++ g = first(methods(M.g))
++ @test !DSE.comparemethods(f, f)
++ @test DSE.comparemethods(f, g)
++ @test !DSE.comparemethods(g, f)
++ end
++ end
++ end
++end
++
++DSE.parsedocs(DSE)
--- /dev/null
--- /dev/null
++environment:
++ matrix:
++ - julia_version: 1.0
++ - julia_version: 1.1
++ - julia_version: latest
++
++platform:
++ - x86 # 32-bit
++ - x64 # 64-bit
++
++## uncomment the following lines to allow failures on nightly julia
++## (tests will run but not make your overall status red)
++#matrix:
++# allow_failures:
++# - julia_version: latest
++
++branches:
++ only:
++ - master
++ - /release-.*/
++
++notifications:
++ - provider: Email
++ on_build_success: false
++ on_build_failure: false
++ on_build_status_changed: false
++
++install:
++ - ps: iex ((new-object net.webclient).DownloadString("https://raw.githubusercontent.com/JuliaCI/Appveyor.jl/version-1/bin/install.ps1"))
++
++build_script:
++ - echo "%JL_BUILD_SCRIPT%"
++ - C:\julia\bin\julia -e "%JL_BUILD_SCRIPT%"
++
++test_script:
++ - echo "%JL_TEST_SCRIPT%"
++ - C:\julia\bin\julia -e "%JL_TEST_SCRIPT%"
--- /dev/null
--- /dev/null
++custom: https://numfocus.org/donate-to-julia
--- /dev/null
--- /dev/null
++language: julia
++
++os:
++ - linux
++ - osx
++
++julia:
++ - 1.0
++ - 1.1
++ - nightly
++
++notifications:
++ email: false
++
++after_success:
++ - if [[ $TRAVIS_JULIA_VERSION = 1.1 ]] && [[ $TRAVIS_OS_NAME = linux ]]; then
++ julia --project=coverage/ -e 'using Pkg; Pkg.instantiate();
++ using Coverage; Codecov.submit(Codecov.process_folder())';
++ fi
++
++jobs:
++ include:
++ - stage: "Documentation"
++ julia: 1.0
++ os: linux
++ script:
++ - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
++ - julia --project=docs/ docs/make.jl
++ name: "HTML"
++ after_success: skip
++ - script:
++ - julia --project=docs/pdf/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
++ - julia --project=docs/pdf/ docs/pdf/make.jl
++ name: "PDF"
++ after_success: skip
++ services: docker
--- /dev/null
--- /dev/null
++# Documenter.jl changelog
++
++## Version `v0.23.0`
++
++* Documenter v0.23 requires Julia v1.0. ([#1015][github-1015])
++
++* ![BREAKING][badge-breaking] `DocTestSetup`s that are defined in `@meta` blocks no longer apply to doctests that are in docstrings. ([#774][github-774])
++
++ - Specifically, the pattern where `@docs` or `@autodocs` blocks were surrounded by `@meta` blocks, setting up a shared `DocTestSetup` for many docstrings, no longer works.
++
++ - Documenter now exports the `DocMeta` module, which provides an alternative way to add `DocTestSetup` to docstrings.
++
++ **For upgrading:** Use `DocMeta.setdocmeta!` in `make.jl` to set up a `DocTestSetup` that applies to all the docstrings in a particular module instead and, if applicable, remove the now redundant `@meta` blocks. See the ["Setup code" section under "Doctesting"](https://juliadocs.github.io/Documenter.jl/v0.23.0/man/doctests/#Setup-Code-1) in the manual for more information.
++
++* ![Feature][badge-feature] `makedocs` now accepts the `doctest = :only` keyword, which allows doctests to be run while most other build steps, such as rendering, are skipped. This makes it more feasible to run doctests as part of the test suite (see the manual for more information). ([#198][github-198], [#535][github-535], [#756][github-756], [#774][github-774])
++
++* ![Feature][badge-feature] Documenter now exports the `doctest` function, which verifies the doctests in all the docstrings of a given module. This can be used to verify docstring doctests as part of test suite, or to fix doctests right in the REPL. ([#198][github-198], [#535][github-535], [#756][github-756], [#774][github-774], [#1054][github-1054])
++
++* ![Feature][badge-feature] `makedocs` now accepts the `expandfirst` argument, which allows specifying a set of pages that should be evaluated before others. ([#1027][github-1027], [#1029][github-1029])
++
++* ![Enhancement][badge-enhancement] The evaluation order of pages is now fixed (unless customized with `expandfirst`). The pages are evaluated in the alphabetical order of their file paths. ([#1027][github-1027], [#1029][github-1029])
++
++* ![Enhancement][badge-enhancement] The logo image in the HTML output will now always point to the first page in the navigation menu (as opposed to `index.html`, which may or may not exist). When using pretty URLs, the `index.html` part now omitted from the logo link URL. ([#1005][github-1005])
++
++* ![Enhancement][badge-enhancement] Minor changes to how doctesting errors are printed. ([#1028][github-1028])
++
++* ![Enhancement][badge-enhancement] Videos can now be included in the HTML output using the image syntax (`![]()`) if the file extension matches a known format (`.webm`, `.mp4`, `.ogg`, `.ogm`, `.ogv`, `.avi`). ([#1034][github-1034])
++
++* ![Enhancement][badge-enhancement] The PDF output now uses the DejaVu Sans and DejaVu Sans Mono fonts to provide better Unicode coverage. ([#803][github-803], [#1066][github-1066])
++
++* ![Bugfix][badge-bugfix] The HTML output now outputs HTML files for pages that are not referenced in the `pages` keyword too (Documenter finds them according to their extension). But they do exists outside of the standard navigation hierarchy (as defined by `pages`). This fixes a bug where these pages could still be referenced by `@ref` links and `@contents` blocks, but in the HTML output, the links ended up being broken. ([#1031][github-1031], [#1047][github-1047])
++
++* ![Bugfix][badge-bugfix] `makedocs` now throws an error when the format objects (`Documenter.HTML`, `LaTeX`, `Markdown`) get passed positionally. The format types are no longer subtypes of `Documenter.Plugin`. ([#1046][github-1046], [#1061][github-1061])
++
++* ![Bugfix][badge-bugfix] Doctesting now also handles doctests that contain invalid syntax and throw parsing errors. ([#487][github-487], [#1062][github-1062])
++
++* ![Bugfix][badge-bugfix] Stacktraces in doctests that throw an error are now filtered more thoroughly, fixing an issue where too much of the stacktrace was included when `doctest` or `makedocs` was called from a more complicated context. ([#1062][github-1062])
++
++* ![Experimental][badge-experimental] ![Feature][badge-feature] The current working directory when evaluating `@repl` and `@example` blocks can now be set to a fixed directory by passing the `workdir` keyword to `makedocs`. _The new keyword and its behaviour are experimental and not part of the public API._ ([#1013][github-1013], [#1025][github-1025])
++
++## Version `v0.22.6`
++
++* ![Maintenance][badge-maintenance] Add DocStringExtensions 0.8 as an allowed dependency version. ([#1071][github-1071])
++
++## Version `v0.22.5`
++
++* ![Maintenance][badge-maintenance] Fix a test dependency problem revealed by a bugfix in Julia / Pkg. ([#1037][github-1037])
++
++## Version `v0.22.4`
++
++* ![Bugfix][badge-bugfix] Documenter no longer crashes if the build includes doctests from docstrings that are defined in files that do not exist on the file system (e.g. if a Julia Base docstring is included when running a non-source Julia build). ([#1002][github-1002])
++
++* ![Bugfix][badge-bugfix] URLs for files in the repository are now generated correctly when the repository is used as a Git submodule in another repository. ([#1000][github-1000], [#1004][github-1004])
++
++* ![Bugfix][badge-bugfix] When checking for omitted docstrings, Documenter no longer gives "`Package.Package` missing" type false positives. ([#1009][github-1009])
++
++* ![Bugfix][badge-bugfix] `makedocs` again exits with an error if `strict=true` and there is a doctest failure. ([#1003][github-1003], [#1014][github-1014])
++
++## Version `v0.22.3`
++
++* ![Bugfix][badge-bugfix] Fixed filepaths for images included in the .tex file for PDF output on Windows. ([#999][github-999])
++
++## Version `v0.22.2`
++
++* ![Bugfix][badge-bugfix] Error reporting for meta-blocks now handles missing files gracefully instead of throwing. ([#996][github-996])
++
++* ![Enhancement][badge-enhancement] The `sitename` keyword argument to `deploydocs`, which is required for the default HTML output, is now properly documented. ([#995][github-995])
++
++## Version `v0.22.1`
++
++* ![Bugfix][badge-bugfix] Fixed a world-age related bug in doctests. ([#994][github-994])
++
++## Version `v0.22.0`
++
++* ![Deprecation][badge-deprecation] ![Enhancement][badge-enhancement] The `assets` and `analytics` arguments to `makedocs` have been deprecated in favor of the corresponding arguments of the `Documenter.HTML` format plugin. ([#953][github-953])
++
++ **For upgrading:** pass the corresponding arguments with the `Documenter.HTML` plugin instead. E.g. instead of
++
++ ```
++ makedocs(
++ assets = ..., analytics = ...,
++ ...
++ )
++ ```
++
++ you should have
++
++ ```
++ makedocs(
++ format = Documenter.HTML(assets = ..., analytics = ...),
++ ...
++ )
++ ```
++
++ _**Note:** It is technically possible to specify the same argument twice with different values by passing both variants. In that case the value passed to `makedocs` takes precedence._
++
++* ![Enhancement][badge-enhancement] Documentation is no longer deployed on Travis CI cron jobs. ([#917][github-917])
++
++* ![Enhancement][badge-enhancement] Log messages from failed `@meta`, `@docs`, `@autodocs`,
++ `@eval`, `@example` and `@setup` blocks now include information about the source location
++ of the block. ([#929][github-929])
++
++* ![Enhancement][badge-enhancement] Docstrings from `@docs`-blocks are now included in the
++ rendered docs even if some part(s) of the block failed. ([#928][github-928], [#935][github-935])
++
++* ![Enhancement][badge-enhancement] The Markdown and LaTeX output writers can now handle multimedia
++ output, such as images, from `@example` blocks. All the writers now also handle `text/markdown`
++ output, which is preferred over `text/plain` if available. ([#938][github-938], [#948][github-948])
++
++* ![Enhancement][badge-enhancement] The HTML output now also supports SVG, WebP, GIF and JPEG logos. ([#953][github-953])
++
++* ![Enhancement][badge-enhancement] Reporting of failed doctests are now using the logging
++ system to be consistent with the rest of Documenter's output. ([#958][github-958])
++
++* ![Enhancement][badge-enhancement] The construction of the search index in the HTML output has been refactored to make it easier to use with other search backends in the future. The structure of the generated search index has also been modified, which can yield slightly different search results. Documenter now depends on the lightweight [JSON.jl][json-jl] package. ([#966][github-966])
++
++* ![Enhancement][badge-enhancement] Docstrings that begin with an indented code block (such as a function signature) now have that block highlighted as Julia code by default.
++ This behaviour can be disabled by passing `highlightsig=false` to `makedocs`. ([#980][github-980])
++
++* ![Bugfix][badge-bugfix] Paths in `include` calls in `@eval`, `@example`, `@repl` and `jldoctest`
++ blocks are now interpreted to be relative `pwd`, which is set to the output directory of the
++ resulting file. ([#941][github-941])
++
++* ![Bugfix][badge-bugfix] `deploydocs` and `git_push` now support non-github repos correctly and work when the `.ssh` directory does not already exist or the working directory contains spaces. ([#971][github-971])
++
++* ![Bugfix][badge-bugfix] Tables now honor column alignment in the HTML output. If a column does not explicitly specify its alignment, the parser defaults to it being right-aligned, whereas previously all cells were left-aligned. ([#511][github-511], [#989][github-989])
++
++* ![Bugfix][badge-bugfix] Code lines ending with `# hide` are now properly hidden for CRLF inputs. ([#991][github-991])
++
++## Version `v0.21.5`
++
++* ![Bugfix][badge-bugfix] Deprecation warnings for `format` now get printed correctly when multiple formats are passed as a `Vector`. ([#967][github-967])
++
++## Version `v0.21.4`
++
++* ![Bugfix][badge-bugfix] A bug in `jldoctest`-blocks that, in rare cases, resulted in
++ wrong output has been fixed. ([#959][github-959], [#960][github-960])
++
++## Version `v0.21.3`
++
++* ![Security][badge-security] The lunr.js and lodash JavaScript dependencies have been updated to their latest patch versions (from 2.3.1 to 2.3.5 and 4.17.4 to 4.17.11, respectively).
++ This is in response to a vulnerability in lodash <4.17.11 ([CVE-2018-16487](https://nvd.nist.gov/vuln/detail/CVE-2018-16487)). ([#946][github-946])
++
++## Version `v0.21.2`
++
++* ![Bugfix][badge-bugfix] `linkcheck` now handles servers that do not support `HEAD` requests
++ and properly checks for status codes of FTP responses. ([#934][github-934])
++
++## Version `v0.21.1`
++
++* ![Bugfix][badge-bugfix] `@repl` blocks now work correctly together with quoted
++ expressions. ([#923][github-923], [#926][github-926])
++
++* ![Bugfix][badge-bugfix] `@example`, `@repl` and `@eval` blocks now handle reserved words,
++ e.g. `try`/`catch`, correctly. ([#886][github-886], [#927][github-927])
++
++## Version `v0.21.0`
++
++* ![Deprecation][badge-deprecation] ![Enhancement][badge-enhancement] The symbol values to the `format` argument of `makedocs` (`:html`, `:markdown`, `:latex`) have been deprecated in favor of the `Documenter.HTML`, `Markdown` and `LaTeX`
++ objects. The `Markdown` and `LaTeX` types are exported from the [DocumenterMarkdown][documentermarkdown] and [DocumenterLaTeX][documenterlatex] packages,
++ respectively. HTML output is still the default. ([#891][github-891])
++
++ **For upgrading:** If you don't specify `format` (i.e. you rely on the default) you don't have to do anything.
++ Otherwise update calls to `makedocs` to use struct instances instead of symbols, e.g.
++
++ ```
++ makedocs(
++ format = :markdown
++ )
++ ```
++
++ should be changed to
++
++ ```
++ using DocumenterMarkdown
++ makedocs(
++ format = Markdown()
++ )
++ ```
++
++* ![Deprecation][badge-deprecation] ![Enhancement][badge-enhancement] The `html_prettyurls`, `html_canonical`, `html_disable_git` and `html_edit_branch` arguments to `makedocs` have been deprecated in favor of the corresponding arguments of the `Documenter.HTML` format plugin. ([#864][github-864], [#891][github-891])
++
++ **For upgrading:** pass the corresponding arguments with the `Documenter.HTML` plugin instead. E.g. instead of
++
++ ```
++ makedocs(
++ html_prettyurls = ..., html_canonical = ...,
++ ...
++ )
++ ```
++
++ you should have
++
++ ```
++ makedocs(
++ format = Documenter.HTML(prettyurls = ..., canonical = ...),
++ ...
++ )
++ ```
++
++ _**Note:** It is technically possible to specify the same argument twice with different values by passing both variants. In that case the value to the deprecated `html_*` variant takes precedence._
++
++* ![Feature][badge-feature] Packages extending Documenter can now define subtypes of `Documenter.Plugin`,
++ which can be passed to `makedocs` as positional arguments to pass options to the extensions. ([#864][github-864])
++
++* ![Feature][badge-feature] `@autodocs` blocks now support the `Filter` keyword, which allows passing a user-defined function that will filter the methods spliced in by the at-autodocs block. ([#885][github-885])
++
++* ![Enhancement][badge-enhancement] `linkcheck` now supports checking URLs using the FTP protocol. ([#879][github-879])
++
++* ![Enhancement][badge-enhancement] Build output logging has been improved and switched to the logging macros from `Base`. ([#876][github-876])
++
++* ![Enhancement][badge-enhancement] The default `documenter.sty` LaTeX preamble now include `\usepackage{graphicx}`. ([#898][github-898])
++
++* ![Enhancement][badge-enhancement] `deploydocs` is now more helpful when it fails to interpret `DOCUMENTER_KEY`. It now also uses the `BatchMode` SSH option and throws an error instead of asking for a passphrase and timing out the Travis build when `DOCUMENTER_KEY` is broken. ([#697][github-697], [#907][github-907])
++
++* ![Enhancement][badge-enhancement] `deploydocs` now have a `forcepush` keyword argument that can be used to
++ force-push the built documentation instead of adding a new commit. ([#905][github-905])
++
++## Version `v0.20.0`
++
++* Documenter v0.20 requires at least Julia v0.7. ([#795][github-795])
++
++* ![BREAKING][badge-breaking] Documentation deployment via the `deploydocs` function has changed considerably.
++
++ - The user-facing directories (URLs) of different versions and what gets displayed in the version selector have changed. By default, Documenter now creates the `stable/` directory (as before) and a directory for every minor version (`vX.Y/`). The `release-X.Y` directories are no longer created. ([#706][github-706], [#813][github-813], [#817][github-817])
++
++ Technically, Documenter now deploys actual files only to `dev/` and `vX.Y.Z/` directories. The directories (URLs) that change from version to version (e.g. `latest/`, `vX.Y`) are implemented as symlinks on the `gh-pages` branch.
++
++ The version selector will only display `vX.Y/`, `stable/` and `dev/` directories by default. This behavior can be customized with the `versions` keyword of `deploydocs`.
++
++ - Documentation from the development branch (e.g. `master`) now deploys to `dev/` by default (instead of `latest/`). This can be customized with the `devurl` keyword. ([#802][github-802])
++
++ - The `latest` keyword to `deploydocs` has been deprecated and renamed to `devbranch`. ([#802][github-802])
++
++ - The `julia` and `osname` keywords to `deploydocs` are now deprecated. ([#816][github-816])
++
++ - The default values of the `target`, `deps` and `make` keywords to `deploydocs` have been changed. See the default format change below for more information. ([#826][github-826])
++
++ **For upgrading:**
++
++ - If you are using the `latest` keyword, then just use `devbranch` with the same value instead.
++
++ - Update links that point to `latest/` to point to `dev/` instead (e.g. in the README).
++
++ - Remove any links to the `release-X.Y` branches and remove the directories from your `gh-pages` branch.
++
++ - The operating system and Julia version should be specified in the Travis build stage configuration (via `julia:` and `os:` options, see "Hosting Documentation" in the manual for more details) or by checking the `TRAVIS_JULIA_VERSION` and `TRAVIS_OS_NAME` environment variables in `make.jl` yourself.
++
++* ![BREAKING][badge-breaking] `makedocs` will now build Documenter's native HTML output by default and `deploydocs`' defaults now assume the HTML output. ([#826][github-826])
++
++ - The default value of the `format` keyword of `makedocs` has been changed to `:html`.
++
++ - The default value of the `target` keyword to `deploydocs` has been changed to `"build"`.
++
++ - The default value of the `make` and `deps` keywords to `deploydocs` have been changed to `nothing`.
++
++ **For upgrading:** If you are relying on the Markdown/MkDocs output, you now need to:
++
++ - In `makedocs`, explicitly set `format = :markdown`
++
++ - In `deploydocs`, explicitly set
++
++ ```julia
++ target = "site"
++ deps = Deps.pip("pygments", "mkdocs")
++ make = () -> run(`mkdocs build`)
++ ```
++
++ - Explicitly import `DocumenterMarkdown` in `make.jl`. See the `MarkdownWriter` deprecation below.
++
++ If you already specify any of the changed keywords, then you do not need to make any changes to those keywords you already set.
++
++ However, if you are setting any of the values to the new defaults (e.g. when you are already using the HTML output), you may now rely on the new defaults.
++
++* ![Deprecation][badge-deprecation] The Markdown/MkDocs (`format = :markdown`) and PDF/LaTeX (`format = :latex`) outputs now require an external package to be loaded ([DocumenterMarkdown](https://github.com/JuliaDocs/DocumenterMarkdown.jl) and [DocumenterLaTeX](https://github.com/JuliaDocs/DocumenterLaTeX.jl), respectively). ([#833][github-833])
++
++ **For upgrading:** Make sure that the respective extra package is installed and then just add `using DocumenterMarkdown` or `using DocumenterLaTeX` to `make.jl`.
++
++* ![BREAKING][badge-breaking] "Pretty URLs" are enabled by default now for the HTML output. The default value of the `html_prettyurls` has been changed to `true`.
++
++ For a page `foo/page.md` Documenter now generates `foo/page/index.html`, instead of `foo/page.html`.
++ On GitHub pages deployments it means that your URLs look like `foo/page/` instead of `foo/page.html`.
++
++ For local builds you should explicitly set `html_prettyurls = false`.
++
++ **For upgrading:** If you wish to retain the old behavior, set `html_prettyurls = false` in `makedocs`. If you already set `html_prettyurls`, you do not need to change anything.
++
++* ![BREAKING][badge-breaking] The `Travis.genkeys` and `Documenter.generate` functions have been moved to a separate [DocumenterTools.jl package](https://github.com/JuliaDocs/DocumenterTools.jl). ([#789][github-789])
++
++* ![Enhancement][badge-enhancement] If Documenter is not able to determine which Git hosting service is being used to host the source, the "Edit on XXX" links become "Edit source" with a generic icon. ([#804][github-804])
++
++* ![Enhancement][badge-enhancement] The at-blocks now support `MIME"text/html"` rendering of objects (e.g. for interactive plots). I.e. if a type has `show(io, ::MIME"text/html", x)` defined, Documenter now uses that when rendering the objects in the document. ([#764][github-764])
++
++* ![Enhancement][badge-enhancement] Enhancements to the sidebar. When loading a page, the sidebar will jump to the current page now. Also, the scrollbar in WebKit-based browsers look less intrusive now. ([#792][github-792], [#854][github-854], [#863][github-863])
++
++* ![Enhancement][badge-enhancement] Minor style enhancements to admonitions. ([#841][github-841])
++
++* ![Bugfix][badge-bugfix] The at-blocks that execute code can now handle `include` statements. ([#793][github-793], [#794][github-794])
++
++* ![Bugfix][badge-bugfix] At-docs blocks no longer give an error when containing empty lines. ([#823][github-823], [#824][github-824])
++
++[github-198]: https://github.com/JuliaDocs/Documenter.jl/issues/198
++[github-487]: https://github.com/JuliaDocs/Documenter.jl/issues/487
++[github-511]: https://github.com/JuliaDocs/Documenter.jl/pull/511
++[github-535]: https://github.com/JuliaDocs/Documenter.jl/issues/535
++[github-697]: https://github.com/JuliaDocs/Documenter.jl/pull/697
++[github-706]: https://github.com/JuliaDocs/Documenter.jl/pull/706
++[github-756]: https://github.com/JuliaDocs/Documenter.jl/issues/756
++[github-764]: https://github.com/JuliaDocs/Documenter.jl/pull/764
++[github-774]: https://github.com/JuliaDocs/Documenter.jl/pull/774
++[github-789]: https://github.com/JuliaDocs/Documenter.jl/pull/789
++[github-792]: https://github.com/JuliaDocs/Documenter.jl/pull/792
++[github-793]: https://github.com/JuliaDocs/Documenter.jl/pull/793
++[github-794]: https://github.com/JuliaDocs/Documenter.jl/pull/794
++[github-795]: https://github.com/JuliaDocs/Documenter.jl/pull/795
++[github-802]: https://github.com/JuliaDocs/Documenter.jl/pull/802
++[github-803]: https://github.com/JuliaDocs/Documenter.jl/issues/803
++[github-804]: https://github.com/JuliaDocs/Documenter.jl/pull/804
++[github-813]: https://github.com/JuliaDocs/Documenter.jl/pull/813
++[github-816]: https://github.com/JuliaDocs/Documenter.jl/pull/816
++[github-817]: https://github.com/JuliaDocs/Documenter.jl/pull/817
++[github-823]: https://github.com/JuliaDocs/Documenter.jl/pull/823
++[github-824]: https://github.com/JuliaDocs/Documenter.jl/pull/824
++[github-826]: https://github.com/JuliaDocs/Documenter.jl/pull/826
++[github-833]: https://github.com/JuliaDocs/Documenter.jl/pull/833
++[github-841]: https://github.com/JuliaDocs/Documenter.jl/pull/841
++[github-854]: https://github.com/JuliaDocs/Documenter.jl/pull/854
++[github-863]: https://github.com/JuliaDocs/Documenter.jl/pull/863
++[github-864]: https://github.com/JuliaDocs/Documenter.jl/pull/864
++[github-876]: https://github.com/JuliaDocs/Documenter.jl/pull/876
++[github-879]: https://github.com/JuliaDocs/Documenter.jl/pull/879
++[github-885]: https://github.com/JuliaDocs/Documenter.jl/pull/885
++[github-886]: https://github.com/JuliaDocs/Documenter.jl/pull/886
++[github-891]: https://github.com/JuliaDocs/Documenter.jl/pull/891
++[github-898]: https://github.com/JuliaDocs/Documenter.jl/pull/898
++[github-905]: https://github.com/JuliaDocs/Documenter.jl/pull/905
++[github-907]: https://github.com/JuliaDocs/Documenter.jl/pull/907
++[github-917]: https://github.com/JuliaDocs/Documenter.jl/pull/917
++[github-923]: https://github.com/JuliaDocs/Documenter.jl/pull/923
++[github-926]: https://github.com/JuliaDocs/Documenter.jl/pull/926
++[github-927]: https://github.com/JuliaDocs/Documenter.jl/pull/927
++[github-928]: https://github.com/JuliaDocs/Documenter.jl/pull/928
++[github-929]: https://github.com/JuliaDocs/Documenter.jl/pull/929
++[github-934]: https://github.com/JuliaDocs/Documenter.jl/pull/934
++[github-935]: https://github.com/JuliaDocs/Documenter.jl/pull/935
++[github-938]: https://github.com/JuliaDocs/Documenter.jl/pull/938
++[github-941]: https://github.com/JuliaDocs/Documenter.jl/pull/941
++[github-946]: https://github.com/JuliaDocs/Documenter.jl/pull/946
++[github-948]: https://github.com/JuliaDocs/Documenter.jl/pull/948
++[github-953]: https://github.com/JuliaDocs/Documenter.jl/pull/953
++[github-958]: https://github.com/JuliaDocs/Documenter.jl/pull/958
++[github-959]: https://github.com/JuliaDocs/Documenter.jl/pull/959
++[github-960]: https://github.com/JuliaDocs/Documenter.jl/pull/960
++[github-966]: https://github.com/JuliaDocs/Documenter.jl/pull/966
++[github-967]: https://github.com/JuliaDocs/Documenter.jl/pull/967
++[github-971]: https://github.com/JuliaDocs/Documenter.jl/pull/971
++[github-980]: https://github.com/JuliaDocs/Documenter.jl/pull/980
++[github-989]: https://github.com/JuliaDocs/Documenter.jl/pull/989
++[github-991]: https://github.com/JuliaDocs/Documenter.jl/pull/991
++[github-994]: https://github.com/JuliaDocs/Documenter.jl/pull/994
++[github-995]: https://github.com/JuliaDocs/Documenter.jl/pull/995
++[github-996]: https://github.com/JuliaDocs/Documenter.jl/pull/996
++[github-999]: https://github.com/JuliaDocs/Documenter.jl/pull/999
++[github-1005]: https://github.com/JuliaDocs/Documenter.jl/pull/1005
++[github-1000]: https://github.com/JuliaDocs/Documenter.jl/issues/1000
++[github-1002]: https://github.com/JuliaDocs/Documenter.jl/pull/1002
++[github-1003]: https://github.com/JuliaDocs/Documenter.jl/issues/1003
++[github-1004]: https://github.com/JuliaDocs/Documenter.jl/pull/1004
++[github-1009]: https://github.com/JuliaDocs/Documenter.jl/pull/1009
++[github-1013]: https://github.com/JuliaDocs/Documenter.jl/issues/1013
++[github-1014]: https://github.com/JuliaDocs/Documenter.jl/pull/1014
++[github-1015]: https://github.com/JuliaDocs/Documenter.jl/pull/1015
++[github-1025]: https://github.com/JuliaDocs/Documenter.jl/pull/1025
++[github-1027]: https://github.com/JuliaDocs/Documenter.jl/issues/1027
++[github-1028]: https://github.com/JuliaDocs/Documenter.jl/pull/1028
++[github-1029]: https://github.com/JuliaDocs/Documenter.jl/pull/1029
++[github-1031]: https://github.com/JuliaDocs/Documenter.jl/issues/1031
++[github-1034]: https://github.com/JuliaDocs/Documenter.jl/pull/1034
++[github-1037]: https://github.com/JuliaDocs/Documenter.jl/pull/1037
++[github-1046]: https://github.com/JuliaDocs/Documenter.jl/issues/1046
++[github-1047]: https://github.com/JuliaDocs/Documenter.jl/pull/1047
++[github-1054]: https://github.com/JuliaDocs/Documenter.jl/pull/1054
++[github-1061]: https://github.com/JuliaDocs/Documenter.jl/pull/1061
++[github-1062]: https://github.com/JuliaDocs/Documenter.jl/pull/1062
++[github-1066]: https://github.com/JuliaDocs/Documenter.jl/pull/1066
++[github-1071]: https://github.com/JuliaDocs/Documenter.jl/pull/1071
++
++[documenterlatex]: https://github.com/JuliaDocs/DocumenterLaTeX.jl
++[documentermarkdown]: https://github.com/JuliaDocs/DocumenterMarkdown.jl
++[json-jl]: https://github.com/JuliaIO/JSON.jl
++
++
++[badge-breaking]: https://img.shields.io/badge/BREAKING-red.svg
++[badge-deprecation]: https://img.shields.io/badge/deprecation-orange.svg
++[badge-feature]: https://img.shields.io/badge/feature-green.svg
++[badge-enhancement]: https://img.shields.io/badge/enhancement-blue.svg
++[badge-bugfix]: https://img.shields.io/badge/bugfix-purple.svg
++[badge-security]: https://img.shields.io/badge/security-black.svg
++[badge-experimental]: https://img.shields.io/badge/experimental-lightgrey.svg
++[badge-maintenance]: https://img.shields.io/badge/maintenance-gray.svg
++
++<!--
++# Badges
++
++![BREAKING][badge-breaking]
++![Deprecation][badge-deprecation]
++![Feature][badge-feature]
++![Enhancement][badge-enhancement]
++![Bugfix][badge-bugfix]
++![Security][badge-security]
++![Experimental][badge-experimental]
++![Maintenance][badge-maintenance]
++-->
--- /dev/null
--- /dev/null
++The Documenter.jl package is licensed under the MIT "Expat" License:
++
++> Copyright (c) 2016: Michael Hatherly.
++>
++> Permission is hereby granted, free of charge, to any person obtaining a copy
++> of this software and associated documentation files (the "Software"), to deal
++> in the Software without restriction, including without limitation the rights
++> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
++> copies of the Software, and to permit persons to whom the Software is
++> furnished to do so, subject to the following conditions:
++>
++> The above copyright notice and this permission notice shall be included in all
++> copies or substantial portions of the Software.
++>
++> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
++> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
++> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
++> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
++> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
++> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
++> SOFTWARE.
++>
--- /dev/null
--- /dev/null
++name = "Documenter"
++uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
++version = "0.23.0"
++
++[deps]
++Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
++DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
++InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
++JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
++LibGit2 = "76f85450-5226-5b5a-8eaa-529ad045b433"
++Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
++Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
++REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
++Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
++Unicode = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
++
++[compat]
++DocStringExtensions = "0.4, 0.5, 0.6, 0.7, 0.8"
++JSON = "0.19, 0.20, 0.21"
++julia = "1"
++
++[extras]
++DocumenterMarkdown = "997ab1e6-3595-5248-9280-8efb232c3433"
++DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
++Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
++
++[targets]
++test = ["Random", "DocumenterMarkdown", "DocumenterTools"]
--- /dev/null
--- /dev/null
++
++# Documenter
++
++*A documentation generator for Julia.*
++
++| **Documentation** | **Build Status** |
++|:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
++| [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url] | [![][travis-img]][travis-url] [![][appveyor-img]][appveyor-url] [![][codecov-img]][codecov-url] |
++
++
++## Installation
++
++The package can be installed with the Julia package manager.
++From the Julia REPL, type `]` to enter the Pkg REPL mode and run:
++
++```
++pkg> add Documenter
++```
++
++Or, equivalently, via the `Pkg` API:
++
++```julia
++julia> import Pkg; Pkg.add("Documenter")
++```
++
++## Documentation
++
++- [**STABLE**][docs-stable-url] — **documentation of the most recently tagged version.**
++- [**DEVEL**][docs-dev-url] — *documentation of the in-development version.*
++
++## Project Status
++
++The package is tested against, and being developed for, Julia `1.0` and above on Linux, macOS, and Windows.
++
++Support for Julia `0.4`, `0.5`, `0.6` and `0.7` has been dropped in the latest version, but older versions of Documenter may still work (Documenter versions `0.8`, `0.11`, `0.19`, and `0.22` respectively).
++
++## Questions and Contributions
++
++Usage questions can be posted on the [Julia Discourse forum][discourse-tag-url] under the `documenter` tag, in the #documentation channel of the [Julia Slack](https://julialang.org/community/) and/or in the [JuliaDocs Gitter chat room][gitter-url].
++
++Contributions are very welcome, as are feature requests and suggestions. Please open an [issue][issues-url] if you encounter any problems. The [contributing page][contrib-url] has a few guidelines that should be followed when opening pull requests and contributing code.
++
++[contrib-url]: https://juliadocs.github.io/Documenter.jl/latest/man/contributing/
++[discourse-tag-url]: https://discourse.julialang.org/tags/documenter
++[gitter-url]: https://gitter.im/juliadocs/users
++
++[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
++[docs-dev-url]: https://juliadocs.github.io/Documenter.jl/dev
++
++[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
++[docs-stable-url]: https://juliadocs.github.io/Documenter.jl/stable
++
++[travis-img]: https://travis-ci.org/JuliaDocs/Documenter.jl.svg?branch=master
++[travis-url]: https://travis-ci.org/JuliaDocs/Documenter.jl
++
++[appveyor-img]: https://ci.appveyor.com/api/projects/status/xx7nimfpnl1r4gx0?svg=true
++[appveyor-url]: https://ci.appveyor.com/project/JuliaDocs/documenter-jl
++
++[codecov-img]: https://codecov.io/gh/JuliaDocs/Documenter.jl/branch/master/graph/badge.svg
++[codecov-url]: https://codecov.io/gh/JuliaDocs/Documenter.jl
++
++[issues-url]: https://github.com/JuliaDocs/Documenter.jl/issues
--- /dev/null
--- /dev/null
++<?xml version="1.0" encoding="UTF-8" standalone="no"?>
++<!-- Created with Inkscape (http://www.inkscape.org/) -->
++
++<svg
++ xmlns:dc="http://purl.org/dc/elements/1.1/"
++ xmlns:cc="http://creativecommons.org/ns#"
++ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
++ xmlns:svg="http://www.w3.org/2000/svg"
++ xmlns="http://www.w3.org/2000/svg"
++ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
++ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
++ width="16.5mm"
++ height="8.6603003mm"
++ viewBox="0 0 58.464567 30.686103"
++ id="svg2"
++ version="1.1"
++ inkscape:version="0.91 r13725"
++ sodipodi:docname="arrow.svg">
++ <defs
++ id="defs4" />
++ <sodipodi:namedview
++ id="base"
++ pagecolor="#ffffff"
++ bordercolor="#666666"
++ borderopacity="1.0"
++ inkscape:pageopacity="0.0"
++ inkscape:pageshadow="2"
++ inkscape:zoom="11.2"
++ inkscape:cx="14.209234"
++ inkscape:cy="29.780479"
++ inkscape:document-units="px"
++ inkscape:current-layer="layer1"
++ showgrid="false"
++ inkscape:window-width="1920"
++ inkscape:window-height="1053"
++ inkscape:window-x="0"
++ inkscape:window-y="27"
++ inkscape:window-maximized="1" />
++ <metadata
++ id="metadata7">
++ <rdf:RDF>
++ <cc:Work
++ rdf:about="">
++ <dc:format>image/svg+xml</dc:format>
++ <dc:type
++ rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
++ <dc:title></dc:title>
++ </cc:Work>
++ </rdf:RDF>
++ </metadata>
++ <g
++ inkscape:label="Layer 1"
++ inkscape:groupmode="layer"
++ id="layer1"
++ transform="translate(0,-1021.6761)">
++ <path
++ style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
++ d="m 0,1021.6761 35.433071,0 -17.716536,30.6861 z"
++ id="path4140"
++ inkscape:connector-curvature="0"
++ sodipodi:nodetypes="cccc" />
++ </g>
++</svg>
--- /dev/null
--- /dev/null
++/*
++ * The default CSS style for Documenter.jl generated sites
++ *
++ * Heavily inspired by the Julia Sphinx theme
++ * https://github.com/JuliaLang/JuliaDoc
++ * which extends the sphinx_rtd_theme
++ * https://github.com/snide/sphinx_rtd_theme
++ *
++ * Part of Documenter.jl
++ * https://github.com/JuliaDocs/Documenter.jl
++ *
++ * License: MIT
++ */
++
++/* fonts */
++body, input {
++ font-family: 'Lato', 'Helvetica Neue', Arial, sans-serif;
++ font-size: 16px;
++ color: #222;
++ text-rendering: optimizeLegibility;
++}
++
++pre, code, kbd {
++ font-family: Inconsolata, Monaco, courier, monospace;
++ font-size: 0.90em;
++}
++
++pre code {
++ font-size: 1em;
++}
++
++a {
++ color: #2980b9;
++ text-decoration: none;
++}
++
++a:hover {
++ color: #3091d1;
++}
++
++a:visited {
++ color: #9b59b6;
++}
++
++body {
++ line-height: 1.5;
++}
++
++h1 {
++ font-size: 1.75em;
++}
++
++/* Unless the <h1> the is very first thing on the page (i.e. the second element
++ * in the <article>, * after the <header>, we add some additional styling to it
++ * to make it stand out a bit more. This way we get a reasonable fallback if CSS3
++ * selectors are not supported in the browser.
++ */
++article > h1:not(:nth-child(2)) {
++ margin: 2.5em 0 0;
++ padding-bottom: 0.30em;
++ border-bottom: 1px solid #e5e5e5;
++}
++h2 {
++ font-size: 1.50em;
++ margin: 2.3em 0 0;
++ padding-bottom: 0.25em;
++ border-bottom: 1px solid #e5e5e5;
++}
++h3 {
++ font-size: 1.25em;
++ margin: 2.0em 0 0;
++}
++h4 { font-size: 1.15em; }
++h5 { font-size: 1.10em; }
++h6 { font-size: 1em; }
++
++h4, h5, h6 {
++ margin-top: 1.5em;
++ margin-bottom: 1em;
++}
++
++img {
++ max-width: 100%;
++}
++
++video {
++ max-width: 100%;
++}
++
++table {
++ border-collapse: collapse;
++ margin: 1em 0;
++}
++
++th, td {
++ border: 1px solid #e1e4e5;
++ padding: 0.5em 1em;
++}
++
++th {
++ border-bottom-width: 2px;
++}
++
++tr:nth-child(even) {
++ background-color: #f3f6f6;
++}
++
++hr {
++ border: 0;
++ border-top: 1px solid #e5e5e5;
++}
++
++/* Inline code and code blocks */
++
++code {
++ padding: 0.1em;
++ background-color: rgba(0,0,0,.04);
++ border-radius: 3px;
++}
++
++pre {
++ background-color: #f5f5f5;
++ border: 1px solid #dddddd;
++ border-radius: 3px;
++ padding: 0.5em;
++ overflow: auto;
++}
++
++pre code {
++ padding: 0;
++ background-color: initial;
++}
++
++kbd {
++ font-size: 0.70em;
++ display: inline-block;
++ padding: 0.1em 0.5em 0.4em 0.5em;
++ line-height: 1.0em;
++ color: #444d56;
++ vertical-align: middle;
++ background-color: #fafbfc;
++ border: solid 1px #c6cbd1;
++ border-bottom-color: #959da5;
++ border-radius: 3px;
++ box-shadow: inset 0 -1px 0 #959da5;
++}
++
++/* Headers in admonitions and docstrings */
++.admonition h1,
++article section.docstring h1 {
++ font-size: 1.25em;
++}
++
++.admonition h2,
++article section.docstring h2 {
++ font-size: 1.10em;
++}
++
++.admonition h3,
++.admonition h4,
++.admonition h5,
++.admonition h6,
++article section.docstring h3,
++article section.docstring h4,
++article section.docstring h5,
++article section.docstring h6 {
++ font-size: 1em;
++}
++
++/* Navigation */
++nav.toc {
++ position: fixed;
++ top: 0;
++ left: 0;
++ bottom: 0;
++ width: 20em;
++ display: flex;
++ flex-flow: column nowrap;
++ overflow-y: auto;
++ padding: 1em 0 0 0;
++ background-color: #fcfcfc;
++ box-shadow: inset -14px 0px 5px -12px rgb(210,210,210);
++}
++
++nav.toc .logo {
++ margin: 0 auto;
++ display: block;
++ max-height: 6em;
++ max-width: 18em;
++}
++
++nav.toc h1 {
++ text-align: center;
++ margin-top: .57em;
++ margin-bottom: 0;
++}
++
++nav.toc select {
++ display: block;
++ height: 2em;
++ flex-shrink: 0;
++ padding: 0 1.6em 0 1em;
++ min-width: 7em;
++ max-width: 90%;
++ max-width: calc(100% - 5em);
++ margin: 0 auto;
++ font-size: .83em;
++ border: 1px solid #c9c9c9;
++ border-radius: 1em;
++
++ /* TODO: doesn't seem to be centered on Safari */
++ text-align: center;
++ text-align-last: center;
++
++ appearance: none;
++ -moz-appearance: none;
++ -webkit-appearance: none;
++
++ background: white url("arrow.svg");
++ background-size: 1.155em;
++ background-repeat: no-repeat;
++ background-position: right;
++}
++
++nav.toc select:hover {
++ border: 1px solid #a0a0a0;
++}
++
++nav.toc select option {
++ text-align: center;
++}
++
++nav.toc input {
++ display: block;
++ height: 2em;
++ width: 90%;
++ width: calc(100% - 5em);
++ margin: 1.2em auto;
++ padding: 0 1em;
++ border: 1px solid #c9c9c9;
++ border-radius: 1em;
++ font-size: .83em;
++}
++
++nav.toc > ul * {
++ margin: 0;
++}
++
++nav.toc > ul {
++ min-height: 2em;
++ overflow-y: auto;
++ margin: 0;
++}
++
++nav.toc > ul > li:last-child {
++ padding-bottom: 1em;
++}
++
++nav.toc ul {
++ color: #404040;
++ padding: 0;
++ list-style: none;
++}
++
++nav.toc ul .toctext {
++ color: inherit;
++ display: block;
++}
++
++nav.toc ul a:hover {
++ color: #fcfcfc;
++ background-color: #4e4a4a;
++}
++
++nav.toc ul.internal a {
++ color: inherit;
++ display: block;
++}
++
++nav.toc ul.internal a:hover {
++ background-color: #d6d6d6;
++}
++
++nav.toc ul.internal {
++ background-color: #e3e3e3;
++ box-shadow: inset -14px 0px 5px -12px rgb(210,210,210);
++ list-style: none;
++}
++
++nav.toc ul.internal li.toplevel {
++ border-top: 1px solid #909090;
++ font-weight: bold;
++}
++
++nav.toc ul.internal li.toplevel:first-child {
++ border-top: none;
++}
++
++nav.toc .toctext {
++ padding-top: 0.3em;
++ padding-bottom: 0.3em;
++ padding-right: 1em;
++}
++
++nav.toc ul .toctext {
++ padding-left: 1em;
++}
++
++nav.toc ul ul .toctext {
++ padding-left: 2em;
++}
++
++nav.toc ul ul ul .toctext {
++ padding-left: 3em;
++}
++
++nav.toc li.current > .toctext {
++ border-top: 1px solid #c9c9c9;
++ border-bottom: 1px solid #c9c9c9;
++ color: #404040;
++ font-weight: bold;
++ background-color: white;
++}
++
++nav.toc ul::-webkit-scrollbar {
++ width: .4em;
++ background: none;
++}
++
++nav.toc ul::-webkit-scrollbar-thumb {
++ border-radius: 5px;
++ background: #c9c9c9;
++}
++
++nav.toc ul::-webkit-scrollbar-thumb:hover {
++ border-radius: 5px;
++ background: #aaaaaa;
++}
++
++article {
++ margin-left: 20em;
++ min-width: 20em;
++ max-width: 48em;
++ padding: 2em;
++}
++
++article > header {}
++
++article > header div#topbar {
++ display: none;
++}
++
++article > header nav ul {
++ display: inline-block;
++ list-style: none;
++ margin: 0;
++ padding: 0;
++}
++
++article > header nav li {
++ display: inline-block;
++ padding-right: 0.2em;
++}
++
++article > header nav li:before {
++ content: "»";
++ padding-right: 0.2em;
++}
++
++article > header .edit-page {
++ float: right;
++}
++
++article > footer {}
++
++article > footer a.prev {
++ float: left;
++}
++article > footer a.next {
++ float: right;
++}
++
++article > footer a .direction:after {
++ content: ": ";
++}
++
++article hr {
++ margin: 1em 0;
++}
++
++article section.docstring {
++ border: 1px solid #ddd;
++ margin: 0.5em 0;
++ padding: 0.5em;
++ border-radius: 3px;
++}
++
++article section.docstring .docstring-header {
++ margin-bottom: 1em;
++}
++
++article section.docstring .docstring-binding {
++ color: #333;
++ font-weight: bold;
++}
++
++article section.docstring .docstring-category {
++ font-style: italic;
++}
++
++article section.docstring a.source-link {
++ display: block;
++ font-weight: bold;
++}
++
++.nav-anchor,
++.nav-anchor:hover,
++.nav-anchor:visited {
++ color: #333;
++}
++
++/*
++ * Admonitions
++ *
++ * Colors (title, body)
++ * warning: #f0b37e #ffedcc (orange)
++ * note: #6ab0de #e7f2fa (blue)
++ * tip: #1abc9c #dbfaf4 (green)
++*/
++.admonition {
++ border-radius: 3px;
++ background-color: #eeeeee;
++ margin: 1em 0;
++}
++
++.admonition-title {
++ border-radius: 3px 3px 0 0;
++ background-color: #9b9b9b;
++ padding: 0.15em 0.5em;
++}
++
++.admonition-text {
++ padding: 0.5em;
++}
++
++.admonition-text > :first-child {
++ margin-top: 0;
++}
++
++.admonition-text > :last-child {
++ margin-bottom: 0;
++}
++
++.admonition > .admonition-title:before {
++ font-family: "FontAwesome";
++ margin-right: 5px;
++ content: "\f06a";
++}
++
++.admonition.warning > .admonition-title {
++ background-color: #f0b37e;
++}
++
++.admonition.warning {
++ background-color: #ffedcc;
++}
++
++.admonition.note > .admonition-title {
++ background-color: #6ab0de;
++}
++
++.admonition.note {
++ background-color: #e7f2fa;
++}
++
++.admonition.tip > .admonition-title {
++ background-color: #1abc9c;
++}
++
++.admonition.tip {
++ background-color: #dbfaf4;
++}
++
++
++/* footnotes */
++.footnote {
++ padding-left: 0.8em;
++ border-left: 2px solid #ccc;
++}
++
++/* Search page */
++#search-results .category {
++ font-size: smaller;
++}
++
++/* Overriding the <code> block style of highligh.js.
++ * We have to override the padding and the background-color, since we style this
++ * part ourselves. Specifically, we style the <pre> surrounding the <code>, while
++ * highlight.js applies the .hljs style directly to the <code> tag.
++ */
++.hljs {
++ background-color: transparent;
++ padding: 0;
++}
++
++@media only screen and (max-width: 768px) {
++ nav.toc {
++ position: fixed;
++ width: 16em;
++ left: -16em;
++ -webkit-overflow-scrolling: touch;
++ -webkit-transition-property: left; /* Safari */
++ -webkit-transition-duration: 0.3s; /* Safari */
++ transition-property: left;
++ transition-duration: 0.3s;
++ -webkit-transition-timing-function: ease-out; /* Safari */
++ transition-timing-function: ease-out;
++ z-index: 2;
++ box-shadow: 5px 0px 5px 0px rgb(210,210,210);
++ }
++
++ nav.toc.show {
++ left: 0;
++ }
++
++ article {
++ margin-left: 0;
++ padding: 3em 0.9em 0 0.9em; /* top right bottom left */
++ overflow-wrap: break-word;
++ }
++
++ article > header {
++ position: fixed;
++ left: 0;
++ z-index: 1;
++ }
++
++ article > header nav, hr {
++ display: none;
++ }
++
++ article > header div#topbar {
++ display: block; /* is mobile */
++ position: fixed;
++ width: 100%;
++ height: 1.5em;
++ padding-top: 1em;
++ padding-bottom: 1em;
++ background-color: #fcfcfc;
++ box-shadow: 0 1px 3px rgba(0,0,0,.26);
++ top: 0;
++ -webkit-transition-property: top; /* Safari */
++ -webkit-transition-duration: 0.3s; /* Safari */
++ transition-property: top;
++ transition-duration: 0.3s;
++ }
++
++ article > header div#topbar.headroom--unpinned.headroom--not-top.headroom--not-bottom {
++ top: -4em;
++ -webkit-transition-property: top; /* Safari */
++ -webkit-transition-duration: 0.7s; /* Safari */
++ transition-property: top;
++ transition-duration: 0.7s;
++ }
++
++ article > header div#topbar span {
++ width: 80%;
++ height: 1.5em;
++ margin-top: -0.1em;
++ margin-left: 0.9em;
++ font-size: 1.2em;
++ overflow: hidden;
++ }
++
++ article > header div#topbar a.fa-bars {
++ float: right;
++ padding: 0.6em;
++ margin-top: -0.6em;
++ margin-right: 0.3em;
++ font-size: 1.5em;
++ }
++
++ article > header div#topbar a.fa-bars:visited {
++ color: #3091d1;
++ }
++
++ article table {
++ overflow-x: auto;
++ display: block;
++ }
++
++ article div.MathJax_Display {
++ overflow: scroll;
++ }
++
++ article span.MathJax {
++ overflow: hidden;
++ }
++}
++
++@media only screen and (max-width: 320px) {
++ body {
++ font-size: 15px;
++ }
++}
--- /dev/null
--- /dev/null
++/*
++ * Part of Documenter.jl
++ * https://github.com/JuliaDocs/Documenter.jl
++ *
++ * License: MIT
++ */
++
++requirejs.config({
++ paths: {
++ 'jquery': 'file:///usr/share/javascript/jquery/jquery.min.js',
++ 'jqueryui': 'file:///usr/share/javascript/jquery-ui/jquery-ui.min.js',
++ //'headroom': 'https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.3/headroom.min',
++ 'headroom': 'http://localhost',
++ 'mathjax': 'file:///usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS_HTML',
++ 'highlight': 'file:///usr/lib/nodejs/highlight.js/highlight.js',
++ 'highlight-julia': 'file:////usr/lib/nodejs/highlight.js/languages/julia.js',
++ 'highlight-julia-repl': 'file:////usr/lib/nodejs/highlight.js/languages/julia-repl.js',
++ },
++ shim: {
++ 'mathjax' : {
++ exports: "MathJax"
++ },
++ 'highlight-julia': ['highlight'],
++ 'highlight-julia-repl': ['highlight'],
++ }
++});
++
++// Load MathJax
++require(['mathjax'], function(MathJax) {
++ MathJax.Hub.Config({
++ "tex2jax": {
++ inlineMath: [['$','$'], ['\\(','\\)']],
++ processEscapes: true
++ }
++ });
++ MathJax.Hub.Config({
++ config: ["MMLorHTML.js"],
++ jax: [
++ "input/TeX",
++ "output/HTML-CSS",
++ "output/NativeMML"
++ ],
++ extensions: [
++ "MathMenu.js",
++ "MathZoom.js",
++ "TeX/AMSmath.js",
++ "TeX/AMSsymbols.js",
++ "TeX/autobold.js",
++ "TeX/autoload-all.js"
++ ]
++ });
++ MathJax.Hub.Config({
++ TeX: { equationNumbers: { autoNumber: "AMS" } }
++ });
++})
++
++require(['jquery', 'highlight', 'highlight-julia', 'highlight-julia-repl'], function($, hljs) {
++ $(document).ready(function() {
++ hljs.initHighlighting();
++ })
++
++})
++
++// update the version selector with info from the siteinfo.js and ../versions.js files
++require(['jquery'], function($) {
++ $(document).ready(function() {
++ var version_selector = $("#version-selector");
++
++ // add the current version to the selector based on siteinfo.js, but only if the selector is empty
++ if (typeof DOCUMENTER_CURRENT_VERSION !== 'undefined' && $('#version-selector > option').length == 0) {
++ var option = $("<option value='#' selected='selected'>" + DOCUMENTER_CURRENT_VERSION + "</option>");
++ version_selector.append(option);
++ }
++
++ if (typeof DOC_VERSIONS !== 'undefined') {
++ var existing_versions = $('#version-selector > option');
++ var existing_versions_texts = existing_versions.map(function(i,x){return x.text});
++ DOC_VERSIONS.forEach(function(each) {
++ var version_url = documenterBaseURL + "/../" + each;
++ var existing_id = $.inArray(each, existing_versions_texts);
++ // if not already in the version selector, add it as a new option,
++ // otherwise update the old option with the URL and enable it
++ if (existing_id == -1) {
++ var option = $("<option value='" + version_url + "'>" + each + "</option>");
++ version_selector.append(option);
++ } else {
++ var option = existing_versions[existing_id];
++ option.value = version_url;
++ option.disabled = false;
++ }
++ });
++ }
++
++ // only show the version selector if the selector has been populated
++ if ($('#version-selector > option').length > 0) {
++ version_selector.css("visibility", "visible");
++ }
++
++ // Scroll the navigation bar to the currently selected menu item
++ $("nav.toc > ul").get(0).scrollTop = $(".current").get(0).offsetTop - $("nav.toc > ul").get(0).offsetTop;
++ })
++
++})
++
++// mobile
++require(['jquery', 'headroom'], function($, Headroom) {
++ $(document).ready(function() {
++ var navtoc = $("nav.toc");
++ $("nav.toc li.current a.toctext").click(function() {
++ navtoc.toggleClass('show');
++ });
++ $("article > header div#topbar a.fa-bars").click(function(ev) {
++ ev.preventDefault();
++ navtoc.toggleClass('show');
++ if (navtoc.hasClass('show')) {
++ var title = $("article > header div#topbar span").text();
++ $("nav.toc ul li a:contains('" + title + "')").focus();
++ }
++ });
++ $("article#docs").bind('click', function(ev) {
++ if ($(ev.target).is('div#topbar a.fa-bars')) {
++ return;
++ }
++ if (navtoc.hasClass('show')) {
++ navtoc.removeClass('show');
++ }
++ });
++ if ($("article > header div#topbar").css('display') == 'block') {
++ var headroom = new Headroom(document.querySelector("article > header div#topbar"), {"tolerance": {"up": 10, "down": 10}});
++ headroom.init();
++ }
++ })
++})
--- /dev/null
--- /dev/null
++/*
++ * Part of Documenter.jl
++ * https://github.com/JuliaDocs/Documenter.jl
++ *
++ * License: MIT
++ */
++
++// parseUri 1.2.2
++// (c) Steven Levithan <stevenlevithan.com>
++// MIT License
++function parseUri (str) {
++ var o = parseUri.options,
++ m = o.parser[o.strictMode ? "strict" : "loose"].exec(str),
++ uri = {},
++ i = 14;
++
++ while (i--) uri[o.key[i]] = m[i] || "";
++
++ uri[o.q.name] = {};
++ uri[o.key[12]].replace(o.q.parser, function ($0, $1, $2) {
++ if ($1) uri[o.q.name][$1] = $2;
++ });
++
++ return uri;
++};
++parseUri.options = {
++ strictMode: false,
++ key: ["source","protocol","authority","userInfo","user","password","host","port","relative","path","directory","file","query","anchor"],
++ q: {
++ name: "queryKey",
++ parser: /(?:^|&)([^&=]*)=?([^&]*)/g
++ },
++ parser: {
++ strict: /^(?:([^:\/?#]+):)?(?:\/\/((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?))?((((?:[^?#\/]*\/)*)([^?#]*))(?:\?([^#]*))?(?:#(.*))?)/,
++ loose: /^(?:(?![^:@]+:[^:@\/]*@)([^:\/?#.]+):)?(?:\/\/)?((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?)(((\/(?:[^?#](?![^?#\/]*\.[^?#\/.]+(?:[?#]|$)))*\/?)?([^?#\/]*))(?:\?([^#]*))?(?:#(.*))?)/
++ }
++};
++
++requirejs.config({
++ paths: {
++ 'jquery': 'https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min',
++ 'lunr': 'https://cdnjs.cloudflare.com/ajax/libs/lunr.js/2.3.5/lunr.min',
++ 'lodash': 'https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.11/lodash.min',
++ }
++});
++
++var currentScript = document.currentScript;
++
++require(["jquery", "lunr", "lodash"], function($, lunr, _) {
++ $("#search-form").submit(function(e) {
++ e.preventDefault()
++ })
++
++ // list below is the lunr 2.1.3 list minus the intersect with names(Base)
++ // (all, any, get, in, is, which) and (do, else, for, let, where, while, with)
++ // ideally we'd just filter the original list but it's not available as a variable
++ lunr.stopWordFilter = lunr.generateStopWordFilter([
++ 'a',
++ 'able',
++ 'about',
++ 'across',
++ 'after',
++ 'almost',
++ 'also',
++ 'am',
++ 'among',
++ 'an',
++ 'and',
++ 'are',
++ 'as',
++ 'at',
++ 'be',
++ 'because',
++ 'been',
++ 'but',
++ 'by',
++ 'can',
++ 'cannot',
++ 'could',
++ 'dear',
++ 'did',
++ 'does',
++ 'either',
++ 'ever',
++ 'every',
++ 'from',
++ 'got',
++ 'had',
++ 'has',
++ 'have',
++ 'he',
++ 'her',
++ 'hers',
++ 'him',
++ 'his',
++ 'how',
++ 'however',
++ 'i',
++ 'if',
++ 'into',
++ 'it',
++ 'its',
++ 'just',
++ 'least',
++ 'like',
++ 'likely',
++ 'may',
++ 'me',
++ 'might',
++ 'most',
++ 'must',
++ 'my',
++ 'neither',
++ 'no',
++ 'nor',
++ 'not',
++ 'of',
++ 'off',
++ 'often',
++ 'on',
++ 'only',
++ 'or',
++ 'other',
++ 'our',
++ 'own',
++ 'rather',
++ 'said',
++ 'say',
++ 'says',
++ 'she',
++ 'should',
++ 'since',
++ 'so',
++ 'some',
++ 'than',
++ 'that',
++ 'the',
++ 'their',
++ 'them',
++ 'then',
++ 'there',
++ 'these',
++ 'they',
++ 'this',
++ 'tis',
++ 'to',
++ 'too',
++ 'twas',
++ 'us',
++ 'wants',
++ 'was',
++ 'we',
++ 'were',
++ 'what',
++ 'when',
++ 'who',
++ 'whom',
++ 'why',
++ 'will',
++ 'would',
++ 'yet',
++ 'you',
++ 'your'
++ ])
++
++ // add . as a separator, because otherwise "title": "Documenter.Anchors.add!"
++ // would not find anything if searching for "add!", only for the entire qualification
++ lunr.tokenizer.separator = /[\s\-\.]+/
++
++ // custom trimmer that doesn't strip @ and !, which are used in julia macro and function names
++ lunr.trimmer = function (token) {
++ return token.update(function (s) {
++ return s.replace(/^[^a-zA-Z0-9@!]+/, '').replace(/[^a-zA-Z0-9@!]+$/, '')
++ })
++ }
++
++ lunr.Pipeline.registerFunction(lunr.stopWordFilter, 'juliaStopWordFilter')
++ lunr.Pipeline.registerFunction(lunr.trimmer, 'juliaTrimmer')
++
++ var index = lunr(function () {
++ this.ref('location')
++ this.field('title')
++ this.field('text')
++ documenterSearchIndex['docs'].forEach(function(e) {
++ this.add(e)
++ }, this)
++ })
++ var store = {}
++
++ documenterSearchIndex['docs'].forEach(function(e) {
++ store[e.location] = {title: e.title, category: e.category}
++ })
++
++ $(function(){
++ function update_search(querystring) {
++ tokens = lunr.tokenizer(querystring)
++ results = index.query(function (q) {
++ tokens.forEach(function (t) {
++ q.term(t.toString(), {
++ fields: ["title"],
++ boost: 100,
++ usePipeline: false,
++ editDistance: 0,
++ wildcard: lunr.Query.wildcard.NONE
++ })
++ q.term(t.toString(), {
++ fields: ["title"],
++ boost: 10,
++ usePipeline: false,
++ editDistance: 2,
++ wildcard: lunr.Query.wildcard.NONE
++ })
++ q.term(t.toString(), {
++ fields: ["text"],
++ boost: 1,
++ usePipeline: true,
++ editDistance: 0,
++ wildcard: lunr.Query.wildcard.NONE
++ })
++ })
++ })
++ $('#search-info').text("Number of results: " + results.length)
++ $('#search-results').empty()
++ results.forEach(function(result) {
++ data = store[result.ref]
++ link = $('<a>')
++ link.text(data.title)
++ link.attr('href', documenterBaseURL+'/'+result.ref)
++ cat = $('<span class="category">('+data.category+')</span>')
++ li = $('<li>').append(link).append(" ").append(cat)
++ $('#search-results').append(li)
++ })
++ }
++
++ function update_search_box() {
++ querystring = $('#search-query').val()
++ update_search(querystring)
++ }
++
++ $('#search-query').keyup(_.debounce(update_search_box, 250))
++ $('#search-query').change(update_search_box)
++
++ search_query_uri = parseUri(window.location).queryKey["q"]
++ if(search_query_uri !== undefined) {
++ search_query = decodeURIComponent(search_query_uri.replace(/\+/g, '%20'))
++ $("#search-query").val(search_query)
++ }
++ update_search_box();
++ })
++})
--- /dev/null
--- /dev/null
--- /dev/null
--- /dev/null
++% font settings
++\usepackage{fontspec, newunicodechar, polyglossia}
++
++\setsansfont{DejaVu Sans}[Scale=MatchLowercase, Ligatures=TeX]
++\setmonofont{DejaVu Sans Mono}[Scale=MatchLowercase]
++\renewcommand{\familydefault}{\sfdefault}
++% DejaVu Sans Mono does not have the xor symbol. So we hack around that by replacing all
++% instances of it with calls to \unicodeveebar, which prints this single character as with
++% DejaVu Sans instead.
++\newfontfamily\unicodeveebarfont{DejaVu Sans}[Scale=MatchLowercase]
++\newcommand\unicodeveebar{{\unicodeveebarfont ⊻}}
++%
++
++% colours
++\usepackage{xcolor}
++
++\definecolor{light-blue}{HTML}{6b85dd}
++\definecolor{dark-blue}{HTML}{4266d5}
++\definecolor{light-red}{HTML}{d66661}
++\definecolor{dark-red}{HTML}{c93d39}
++\definecolor{light-green}{HTML}{6bab5b}
++\definecolor{dark-green}{HTML}{3b972e}
++\definecolor{light-purple}{HTML}{aa7dc0}
++\definecolor{dark-purple}{HTML}{945bb0}
++%
++
++% maths
++\usepackage{amsmath, amssymb}
++%
++
++% listings
++\usepackage{listings, minted}
++
++\lstset{
++ basicstyle = \small\ttfamily,
++ breaklines = true,
++ columns = fullflexible,
++ frame = leftline,
++ keepspaces = true,
++ showstringspaces = false,
++ xleftmargin = 3pt,
++}
++
++\setminted{
++ breaklines = true,
++ fontsize = \small,
++ frame = leftline,
++}
++%
++
++% tables
++\usepackage{tabulary}
++%
++
++% hyperref
++\usepackage{hyperref}
++\hypersetup{
++ pdfpagelabels,
++ bookmarks,
++ hyperindex,
++ unicode = true,
++ linkcolor = dark-blue,
++ urlcolor = dark-purple,
++ colorlinks = true,
++}
++%
++
++% table of contents
++\maxtocdepth{subsection}
++%
++
++% paragraphs
++\setlength{\parindent}{0pt}
++\nonzeroparskip
++%
++
++% adjust margins
++\setulmarginsandblock{1.5in}{1in}{*}
++\setlrmarginsandblock{1.5in}{1in}{*}
++\setheaderspaces{1in}{*}{*}
++\checkandfixthelayout
++%
++
++% images etc.
++\usepackage{graphicx}
++%
--- /dev/null
--- /dev/null
++div.wy-menu-vertical ul.current li.toctree-l3 a {
++ font-weight: bold;
++}
++
++a.documenter-source {
++ float: right;
++}
++
++.documenter-methodtable pre {
++ margin-left: 0px;
++ margin-right: 0px;
++ margin-top: 0px;
++ padding: 0px;
++}
++
++.documenter-methodtable pre.documenter-inline {
++ display: inline;
++}
--- /dev/null
--- /dev/null
++MathJax.Hub.Config({
++ "tex2jax": {
++ inlineMath: [['$','$'], ['\\(','\\)']],
++ processEscapes: true
++ }
++});
++MathJax.Hub.Config({
++ config: ["MMLorHTML.js"],
++ jax: [
++ "input/TeX",
++ "output/HTML-CSS",
++ "output/NativeMML"
++ ],
++ extensions: [
++ "MathMenu.js",
++ "MathZoom.js",
++ "TeX/AMSmath.js",
++ "TeX/AMSsymbols.js",
++ "TeX/autobold.js",
++ "TeX/autoload-all.js"
++ ]
++});
++MathJax.Hub.Config({
++ TeX: { equationNumbers: { autoNumber: "AMS" } }
++});
--- /dev/null
--- /dev/null
++comment: false
--- /dev/null
--- /dev/null
++[deps]
++Coverage = "a2441757-f6aa-5fb2-8edb-039e3f45d037"
--- /dev/null
--- /dev/null
++[deps]
++Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
++DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
--- /dev/null
--- /dev/null
++using Documenter, DocumenterTools
++
++# The DOCSARGS environment variable can be used to pass additional arguments to make.jl.
++# This is useful on CI, if you need to change the behavior of the build slightly but you
++# can not change the .travis.yml or make.jl scripts any more (e.g. for a tag build).
++if haskey(ENV, "DOCSARGS")
++ for arg in split(ENV["DOCSARGS"])
++ push!(ARGS, arg)
++ end
++end
++
++makedocs(
++ modules = [Documenter, DocumenterTools],
++ format = Documenter.HTML(
++ # Use clean URLs, unless built as a "local" build
++ prettyurls = !("local" in ARGS),
++ canonical = "https://juliadocs.github.io/Documenter.jl/stable/",
++ assets = ["assets/favicon.ico"],
++ analytics = "UA-136089579-2",
++ ),
++ clean = false,
++ sitename = "Documenter.jl",
++ authors = "Michael Hatherly, Morten Piibeleht, and contributors.",
++ linkcheck = !("skiplinks" in ARGS),
++ pages = [
++ "Home" => "index.md",
++ "Manual" => Any[
++ "Guide" => "man/guide.md",
++ "man/examples.md",
++ "man/syntax.md",
++ "man/doctests.md",
++ "man/latex.md",
++ hide("man/hosting.md", [
++ "man/hosting/walkthrough.md"
++ ]),
++ "man/other-formats.md",
++ ],
++ "Library" => Any[
++ "Public" => "lib/public.md",
++ hide("Internals" => "lib/internals.md", Any[
++ "lib/internals/anchors.md",
++ "lib/internals/builder.md",
++ "lib/internals/cross-references.md",
++ "lib/internals/docchecks.md",
++ "lib/internals/docmeta.md",
++ "lib/internals/docsystem.md",
++ "lib/internals/doctests.md",
++ "lib/internals/documenter.md",
++ "lib/internals/documentertools.md",
++ "lib/internals/documents.md",
++ "lib/internals/dom.md",
++ "lib/internals/expanders.md",
++ "lib/internals/markdown2.md",
++ "lib/internals/mdflatten.md",
++ "lib/internals/selectors.md",
++ "lib/internals/textdiff.md",
++ "lib/internals/utilities.md",
++ "lib/internals/writers.md",
++ ])
++ ],
++ "contributing.md",
++ ],
++ strict = !("strict=false" in ARGS),
++ doctest = ("doctest=only" in ARGS) ? :only : true,
++)
++
++deploydocs(
++ repo = "github.com/JuliaDocs/Documenter.jl.git",
++ target = "build",
++)
--- /dev/null
--- /dev/null
++[deps]
++Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
++DocumenterLaTeX = "cd674d7a-5f81-5cf3-af33-235ef1834b99"
++DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
++Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
--- /dev/null
--- /dev/null
++using Documenter, DocumenterTools, DocumenterLaTeX
++using Test
++
++const ROOT = joinpath(@__DIR__, "..")
++
++# Documenter package docs
++doc = makedocs(
++ debug = true,
++ root = ROOT,
++ build = "pdf/build",
++ modules = [Documenter, DocumenterTools],
++ clean = false,
++ format = LaTeX(platform = "docker"),
++ sitename = "Documenter.jl",
++ authors = "Michael Hatherly, Morten Piibeleht, and contributors.",
++ pages = [
++ "Home" => "index.md",
++ "Manual" => Any[
++ "Guide" => "man/guide.md",
++ "man/examples.md",
++ "man/syntax.md",
++ "man/doctests.md",
++ "man/latex.md",
++ hide("man/hosting.md", [
++ "man/hosting/walkthrough.md"
++ ]),
++ "man/other-formats.md",
++ ],
++ "Library" => Any[
++ "Public" => "lib/public.md",
++ hide("Internals" => "lib/internals.md", Any[
++ "lib/internals/anchors.md",
++ "lib/internals/builder.md",
++ "lib/internals/cross-references.md",
++ "lib/internals/docchecks.md",
++ "lib/internals/docsystem.md",
++ "lib/internals/doctests.md",
++ "lib/internals/documenter.md",
++ "lib/internals/documentertools.md",
++ "lib/internals/documents.md",
++ "lib/internals/dom.md",
++ "lib/internals/expanders.md",
++ "lib/internals/mdflatten.md",
++ "lib/internals/selectors.md",
++ "lib/internals/textdiff.md",
++ "lib/internals/utilities.md",
++ "lib/internals/writers.md",
++ ])
++ ],
++ "contributing.md",
++ ]
++);
++
++# hack to only deploy the actual pdf-file
++mkpath(joinpath(ROOT, "pdf", "build", "pdfdir"))
++let files = readdir(joinpath(ROOT, "pdf", "build"))
++ for f in files
++ if startswith(f, "Documenter.jl") && endswith(f, ".pdf")
++ mv(joinpath(ROOT, "pdf", "build", f),
++ joinpath(ROOT, "pdf", "build", "pdfdir", f))
++ end
++ end
++end
++
++
++deploydocs(
++ repo = "github.com/JuliaDocs/Documenter.jl.git",
++ root = ROOT,
++ target = "pdf/build/pdfdir",
++ branch = "gh-pages-pdf",
++ forcepush = true,
++)
--- /dev/null
--- /dev/null
++<?xml version="1.0" encoding="UTF-8"?>
++<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="500pt" height="500pt" viewBox="0 0 500 500" version="1.1">
++<g id="surface763305">
++<path style=" stroke:none;fill-rule:nonzero;fill:rgb(79.6%,23.5%,20%);fill-opacity:1;" d="M 234.425781 352.5 C 234.425781 413.25 185.175781 462.5 124.425781 462.5 C 63.675781 462.5 14.425781 413.25 14.425781 352.5 C 14.425781 291.75 63.675781 242.5 124.425781 242.5 C 185.175781 242.5 234.425781 291.75 234.425781 352.5 "/>
++<path style="fill-rule:nonzero;fill:rgb(0%,0%,0%);fill-opacity:1;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(100%,100%,100%);stroke-opacity:1;stroke-miterlimit:10;" d="M 130.554688 379.886719 L 130.964844 372.671875 L 131.613281 365.949219 L 132.457031 359.671875 L 133.46875 353.8125 L 134.597656 348.316406 L 135.820312 343.15625 L 138.390625 333.683594 L 140.878906 325.066406 L 143.019531 317.015625 L 143.859375 313.097656 L 144.511719 309.210938 L 144.925781 305.304688 L 145.074219 301.347656 L 144.960938 298.058594 L 144.640625 294.980469 L 144.117188 292.101562 L 143.410156 289.4375 L 142.515625 286.96875 L 141.457031 284.714844 L 140.242188 282.664062 L 138.882812 280.832031 L 137.378906 279.203125 L 135.753906 277.785156 L 134.007812 276.585938 L 132.167969 275.605469 L 130.226562 274.832031 L 128.207031 274.285156 L 126.109375 273.953125 L 123.957031 273.847656 L 121.792969 273.953125 L 119.703125 274.285156 L 117.6875 274.835938 L 115.765625 275.609375 L 113.933594 276.59375 L 112.210938 277.800781 L 110.605469 279.21875 L 109.128906 280.859375 L 107.78125 282.707031 L 106.585938 284.769531 L 105.542969 287.042969 L 104.675781 289.53125 L 103.976562 292.226562 L 103.46875 295.132812 L 103.15625 298.242188 L 103.054688 301.570312 L 103.195312 305.488281 L 103.609375 309.363281 L 104.253906 313.222656 L 105.101562 317.113281 L 107.238281 325.128906 L 109.734375 333.714844 L 112.296875 343.171875 L 113.515625 348.324219 L 114.652344 353.816406 L 115.652344 359.671875 L 116.503906 365.949219 L 117.152344 372.671875 L 117.574219 379.886719 Z M 103.054688 413.546875 L 103.136719 415.476562 L 103.390625 417.390625 L 103.8125 419.265625 L 104.398438 421.101562 L 105.148438 422.863281 L 106.0625 424.558594 L 107.140625 426.15625 L 108.386719 427.652344 L 109.78125 429.019531 L 111.34375 430.253906 L 113.058594 431.339844 L 114.933594 432.261719 L 116.957031 433 L 119.140625 433.550781 L 121.46875 433.886719 L 123.957031 434.007812 L 126.441406 433.886719 L 128.785156 433.550781 L 130.980469 433 L 133.039062 432.261719 L 134.941406 431.339844 L 136.695312 430.253906 L 138.292969 429.019531 L 139.738281 427.652344 L 141.015625 426.15625 L 142.132812 424.558594 L 143.082031 422.863281 L 143.875 421.101562 L 144.488281 419.265625 L 144.9375 417.390625 L 145.203125 415.476562 L 145.296875 413.546875 L 145.203125 411.605469 L 144.9375 409.691406 L 144.488281 407.808594 L 143.875 405.984375 L 143.082031 404.210938 L 142.132812 402.523438 L 141.015625 400.921875 L 139.738281 399.4375 L 138.292969 398.0625 L 136.695312 396.828125 L 134.941406 395.742188 L 133.039062 394.828125 L 130.980469 394.085938 L 128.785156 393.539062 L 126.441406 393.203125 L 123.957031 393.089844 L 121.46875 393.203125 L 119.140625 393.539062 L 116.957031 394.085938 L 114.933594 394.828125 L 113.058594 395.742188 L 111.34375 396.828125 L 109.78125 398.0625 L 108.386719 399.4375 L 107.140625 400.921875 L 106.0625 402.523438 L 105.148438 404.210938 L 104.398438 405.984375 L 103.8125 407.808594 L 103.390625 409.691406 L 103.136719 411.605469 Z "/>
++<path style=" stroke:none;fill-rule:nonzero;fill:rgb(22%,59.6%,14.9%);fill-opacity:1;" d="M 360 135 C 360 195.75 310.75 245 250 245 C 189.25 245 140 195.75 140 135 C 140 74.25 189.25 25 250 25 C 310.75 25 360 74.25 360 135 "/>
++<path style=" stroke:none;fill-rule:nonzero;fill:rgb(58.4%,34.5%,69.8%);fill-opacity:1;" d="M 485.574219 352.5 C 485.574219 413.25 436.324219 462.5 375.574219 462.5 C 314.824219 462.5 265.574219 413.25 265.574219 352.5 C 265.574219 291.75 314.824219 242.5 375.574219 242.5 C 436.324219 242.5 485.574219 291.75 485.574219 352.5 "/>
++<path style="fill-rule:nonzero;fill:rgb(0%,0%,0%);fill-opacity:1;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(100%,100%,100%);stroke-opacity:1;stroke-miterlimit:10;" d="M 382.195312 366.027344 L 387.449219 365.816406 L 392.492188 365.285156 L 397.296875 364.421875 L 401.855469 363.242188 L 406.136719 361.738281 L 410.140625 359.917969 L 413.839844 357.777344 L 417.226562 355.328125 L 420.269531 352.554688 L 422.96875 349.484375 L 425.292969 346.097656 L 427.238281 342.417969 L 428.773438 338.425781 L 429.894531 334.136719 L 430.578125 329.546875 L 430.816406 324.667969 L 430.570312 319.921875 L 429.84375 315.214844 L 428.636719 310.574219 L 426.96875 306.046875 L 424.832031 301.660156 L 422.246094 297.460938 L 419.210938 293.480469 L 415.742188 289.765625 L 411.832031 286.335938 L 407.5 283.25 L 402.746094 280.53125 L 397.585938 278.226562 L 392.015625 276.363281 L 386.050781 274.992188 L 379.691406 274.136719 L 372.957031 273.847656 L 368.953125 273.929688 L 365.042969 274.191406 L 361.25 274.628906 L 357.601562 275.253906 L 354.105469 276.0625 L 350.804688 277.066406 L 347.707031 278.269531 L 344.847656 279.675781 L 342.226562 281.28125 L 339.890625 283.101562 L 337.847656 285.136719 L 336.132812 287.394531 L 334.753906 289.871094 L 333.746094 292.582031 L 333.121094 295.523438 L 332.914062 298.707031 L 333.199219 302.035156 L 334.03125 305.078125 L 335.34375 307.773438 L 337.09375 310.089844 L 339.207031 311.964844 L 341.636719 313.367188 L 344.320312 314.242188 L 345.742188 314.464844 L 347.214844 314.546875 L 348.875 314.46875 L 350.414062 314.257812 L 351.832031 313.914062 L 353.144531 313.457031 L 355.46875 312.207031 L 357.460938 310.589844 L 359.175781 308.671875 L 360.691406 306.535156 L 363.382812 301.898438 L 366.066406 297.25 L 367.578125 295.109375 L 369.296875 293.199219 L 371.28125 291.574219 L 373.613281 290.332031 L 374.921875 289.867188 L 376.34375 289.53125 L 377.882812 289.320312 L 379.554688 289.25 L 382.464844 289.382812 L 385.183594 289.78125 L 387.707031 290.417969 L 390.039062 291.289062 L 392.171875 292.363281 L 394.125 293.628906 L 395.882812 295.070312 L 397.457031 296.671875 L 398.832031 298.402344 L 400.027344 300.261719 L 401.035156 302.222656 L 401.859375 304.277344 L 402.492188 306.394531 L 402.949219 308.566406 L 403.222656 310.773438 L 403.316406 313.007812 L 403.144531 316.054688 L 402.65625 318.859375 L 401.851562 321.421875 L 400.75 323.757812 L 399.347656 325.863281 L 397.671875 327.753906 L 395.722656 329.429688 L 393.523438 330.90625 L 391.066406 332.175781 L 388.375 333.257812 L 385.460938 334.15625 L 382.332031 334.878906 L 378.996094 335.421875 L 375.472656 335.808594 L 371.765625 336.03125 L 367.894531 336.109375 L 367.894531 379.886719 L 381.316406 379.886719 Z M 353.59375 413.546875 L 353.675781 415.476562 L 353.929688 417.390625 L 354.351562 419.265625 L 354.941406 421.101562 L 355.691406 422.863281 L 356.617188 424.558594 L 357.699219 426.15625 L 358.953125 427.652344 L 360.359375 429.019531 L 361.933594 430.253906 L 363.664062 431.339844 L 365.5625 432.261719 L 367.613281 433 L 369.824219 433.550781 L 372.1875 433.886719 L 374.714844 434.007812 L 377.160156 433.886719 L 379.46875 433.550781 L 381.636719 433 L 383.671875 432.261719 L 385.550781 431.339844 L 387.289062 430.253906 L 388.871094 429.019531 L 390.304688 427.652344 L 391.574219 426.15625 L 392.6875 424.558594 L 393.632812 422.863281 L 394.417969 421.101562 L 395.027344 419.265625 L 395.476562 417.390625 L 395.742188 415.476562 L 395.835938 413.546875 L 395.742188 411.605469 L 395.476562 409.691406 L 395.027344 407.808594 L 394.417969 405.984375 L 393.632812 404.210938 L 392.6875 402.523438 L 391.574219 400.921875 L 390.304688 399.4375 L 388.871094 398.0625 L 387.289062 396.828125 L 385.550781 395.742188 L 383.671875 394.828125 L 381.636719 394.085938 L 379.46875 393.539062 L 377.160156 393.203125 L 374.714844 393.089844 L 372.1875 393.203125 L 369.824219 393.539062 L 367.613281 394.085938 L 365.5625 394.828125 L 363.664062 395.742188 L 361.933594 396.828125 L 360.359375 398.0625 L 358.953125 399.4375 L 357.699219 400.921875 L 356.617188 402.523438 L 355.691406 404.210938 L 354.941406 405.984375 L 354.351562 407.808594 L 353.929688 409.691406 L 353.675781 411.605469 Z "/>
++<path style="fill-rule:nonzero;fill:rgb(0%,0%,0%);fill-opacity:1;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke:rgb(100%,100%,100%);stroke-opacity:1;stroke-miterlimit:10;" d="M 317.210938 94.707031 C 319.421875 98.039062 319.917969 101.8125 318.703125 106.027344 L 295.910156 185.535156 C 294.859375 189.277344 292.746094 192.421875 289.570312 194.96875 C 286.394531 197.511719 283.007812 198.785156 279.417969 198.785156 L 202.914062 198.785156 C 198.660156 198.785156 194.558594 197.21875 190.609375 194.089844 C 186.65625 190.960938 183.910156 187.113281 182.363281 182.550781 C 181.035156 178.628906 180.980469 174.914062 182.195312 171.40625 C 182.195312 171.171875 182.277344 170.378906 182.445312 169.035156 C 182.609375 167.691406 182.722656 166.605469 182.777344 165.789062 C 182.832031 165.320312 182.746094 164.691406 182.527344 163.902344 C 182.304688 163.113281 182.222656 162.542969 182.277344 162.191406 C 182.390625 161.546875 182.609375 160.933594 182.941406 160.347656 C 183.273438 159.761719 183.730469 159.074219 184.308594 158.285156 C 184.890625 157.496094 185.34375 156.808594 185.675781 156.222656 C 186.945312 154 188.191406 151.324219 189.40625 148.191406 C 190.621094 145.0625 191.453125 142.386719 191.894531 140.164062 C 192.058594 139.578125 192.074219 138.699219 191.933594 137.53125 C 191.796875 136.359375 191.78125 135.542969 191.894531 135.074219 C 192.058594 134.429688 192.527344 133.609375 193.300781 132.617188 C 194.074219 131.621094 194.542969 130.949219 194.710938 130.597656 C 195.871094 128.492188 197.03125 125.800781 198.191406 122.523438 C 199.351562 119.246094 200.042969 116.613281 200.265625 114.625 C 200.320312 114.097656 200.25 113.164062 200.058594 111.816406 C 199.863281 110.472656 199.875 109.652344 200.097656 109.359375 C 200.320312 108.601562 200.925781 107.707031 201.921875 106.683594 C 202.914062 105.660156 203.523438 105.003906 203.746094 104.710938 C 204.796875 103.1875 205.96875 100.71875 207.269531 97.292969 C 208.566406 93.871094 209.324219 91.046875 209.546875 88.824219 C 209.601562 88.359375 209.519531 87.613281 209.296875 86.589844 C 209.078125 85.5625 209.023438 84.789062 209.132812 84.261719 C 209.242188 83.792969 209.492188 83.269531 209.878906 82.683594 C 210.265625 82.097656 210.761719 81.425781 211.371094 80.664062 C 211.976562 79.902344 212.449219 79.289062 212.777344 78.820312 C 213.222656 78.121094 213.675781 77.226562 214.144531 76.144531 C 214.617188 75.0625 215.03125 74.039062 215.390625 73.074219 C 215.75 72.109375 216.191406 71.054688 216.714844 69.914062 C 217.242188 68.773438 217.78125 67.835938 218.332031 67.105469 C 218.886719 66.375 219.617188 65.6875 220.527344 65.042969 C 221.441406 64.398438 222.433594 64.0625 223.511719 64.035156 C 224.589844 64.003906 225.902344 64.167969 227.449219 64.519531 L 227.367188 64.78125 C 229.464844 64.253906 230.875 63.992188 231.59375 63.992188 L 294.667969 63.992188 C 298.757812 63.992188 301.90625 65.628906 304.117188 68.90625 C 306.328125 72.179688 306.824219 75.984375 305.609375 80.3125 L 282.898438 159.820312 C 280.910156 166.78125 278.933594 171.273438 276.972656 173.292969 C 275.011719 175.308594 271.460938 176.320312 266.320312 176.320312 L 194.296875 176.320312 C 192.804688 176.320312 191.753906 176.757812 191.148438 177.636719 C 190.539062 178.570312 190.511719 179.828125 191.0625 181.410156 C 192.390625 185.503906 196.367188 187.550781 203 187.550781 L 279.5 187.550781 C 281.101562 187.550781 282.648438 187.097656 284.140625 186.191406 C 285.632812 185.285156 286.601562 184.070312 287.042969 182.550781 L 311.90625 95.933594 C 312.292969 94.648438 312.433594 92.980469 312.320312 90.933594 C 314.421875 91.808594 316.050781 93.066406 317.210938 94.707031 M 229.023438 94.878906 C 228.804688 95.640625 228.859375 96.300781 229.191406 96.855469 C 229.523438 97.410156 230.074219 97.6875 230.847656 97.6875 L 281.238281 97.6875 C 281.957031 97.6875 282.664062 97.410156 283.355469 96.855469 C 284.042969 96.300781 284.5 95.640625 284.722656 94.878906 L 286.460938 89.265625 C 286.683594 88.503906 286.628906 87.84375 286.296875 87.289062 C 285.964844 86.734375 285.410156 86.457031 284.636719 86.457031 L 234.246094 86.457031 C 233.527344 86.457031 232.824219 86.734375 232.132812 87.289062 C 231.441406 87.84375 230.984375 88.503906 230.765625 89.265625 Z M 222.144531 117.347656 C 221.925781 118.105469 221.980469 118.765625 222.3125 119.320312 C 222.640625 119.875 223.195312 120.15625 223.96875 120.15625 L 274.359375 120.15625 C 275.078125 120.15625 275.785156 119.875 276.472656 119.320312 C 277.164062 118.765625 277.621094 118.105469 277.84375 117.347656 L 279.582031 111.730469 C 279.804688 110.96875 279.746094 110.3125 279.417969 109.757812 C 279.085938 109.199219 278.53125 108.921875 277.757812 108.921875 L 227.367188 108.921875 C 226.648438 108.921875 225.945312 109.199219 225.253906 109.757812 C 224.5625 110.3125 224.105469 110.96875 223.886719 111.730469 Z M 222.144531 117.347656 "/>
++</g>
++</svg>
--- /dev/null
--- /dev/null
++# Contributing
++
++This page details the some of the guidelines that should be followed when contributing to this package.
++
++
++## Branches
++
++From `Documenter` version `0.3` onwards `release-*` branches are used for tagged minor versions of this package. This follows the same approach used in the main Julia repository, albeit on a much more modest scale.
++
++Please open pull requests against the `master` branch rather than any of the `release-*` branches whenever possible.
++
++### Backports
++
++Bug fixes are backported to the `release-*` branches using `git cherry-pick -x` by a JuliaDocs member and will become available in point releases of that particular minor version of the package.
++
++Feel free to nominate commits that should be backported by opening an issue. Requests for new point releases to be tagged in `METADATA.jl` can also be made in the same way.
++
++### `release-*` branches
++
++ * Each new minor version `x.y.0` gets a branch called `release-x.y` (a [protected branch](https://help.github.com/en/articles/about-protected-branches)).
++ * New versions are usually tagged only from the `release-x.y` branches.
++ * For patch releases, changes get backported to the `release-x.y` branch via a single PR with the standard name "Backports for x.y.z" and label ["Type: Backport"](https://github.com/JuliaDocs/Documenter.jl/pulls?q=label%3A%22Type%3A+Backport%22). The PR message links to all the PRs that are providing commits to the backport. The PR gets merged as a merge commit (i.e. not squashed).
++ * The old `release-*` branches may be removed once they have outlived their usefulness.
++ * Patch version [milestones](https://github.com/JuliaDocs/Documenter.jl/milestones) are used to keep track of which PRs get backported etc.
++
++
++## Style Guide
++
++Follow the style of the surrounding text when making changes. When adding new features please try to stick to the following points whenever applicable.
++
++### Julia
++
++ * 4-space indentation;
++ * modules spanning entire files should not be indented, but modules that have surrounding code should;
++ * no blank lines at the start or end of files;
++ * do not manually align syntax such as `=` or `::` over adjacent lines;
++ * use `function ... end` when a method definition contains more than one toplevel expression;
++ * related short-form method definitions don't need a new line between them;
++ * unrelated or long-form method definitions must have a blank line separating each one;
++ * surround all binary operators with whitespace except for `::`, `^`, and `:`;
++ * files containing a single `module ... end` must be named after the module;
++ * method arguments should be ordered based on the amount of usage within the method body;
++ * methods extended from other modules must follow their inherited argument order, not the above rule;
++ * explicit `return` should be preferred except in short-form method definitions;
++ * avoid dense expressions where possible e.g. prefer nested `if`s over complex nested `?`s;
++ * include a trailing `,` in vectors, tuples, or method calls that span several lines;
++ * do not use multiline comments (`#=` and `=#`);
++ * wrap long lines as near to 92 characters as possible, this includes docstrings;
++ * follow the standard naming conventions used in `Base`.
++
++### Markdown
++
++ * Use unbalanced `#` headers, i.e. no `#` on the right hand side of the header text;
++ * include a single blank line between toplevel blocks;
++ * unordered lists must use `*` bullets with two preceding spaces;
++ * do *not* hard wrap lines;
++ * use emphasis (`*`) and bold (`**`) sparingly;
++ * always use fenced code blocks instead of indented blocks;
++ * follow the conventions outlined in the Julia documentation page on documentation.
--- /dev/null
--- /dev/null
++# Documenter.jl
++
++*A documentation generator for Julia.*
++
++A package for building documentation from docstrings and markdown files.
++
++!!! note
++
++ Please read through the
++ [Documentation](https://docs.julialang.org/en/v1/manual/documentation/) section
++ of the main Julia manual if this is your first time using Julia's documentation system.
++ Once you've read through how to write documentation for your code then come back here.
++
++## Package Features
++
++- Write all your documentation in [Markdown](https://en.wikipedia.org/wiki/Markdown).
++- Minimal configuration.
++- Supports Julia `0.7` and `1.0`.
++- Doctests Julia code blocks.
++- Cross references for docs and section headers.
++- [``\LaTeX`` syntax](@ref latex_syntax) support.
++- Checks for missing docstrings and incorrect cross references.
++- Generates tables of contents and docstring indexes.
++- Automatically builds and deploys docs from Travis to GitHub Pages.
++
++The [Package Guide](@ref) provides a tutorial explaining how to get started using Documenter.
++
++Some examples of packages using Documenter can be found on the [Examples](@ref) page.
++
++See the [Index](@ref main-index) for the complete list of documented functions and types.
++
++## Manual Outline
++
++```@contents
++Pages = [
++ "man/guide.md",
++ "man/examples.md",
++ "man/syntax.md",
++ "man/doctests.md",
++ "man/hosting.md",
++ "man/latex.md",
++ "man/contributing.md",
++]
++Depth = 1
++```
++
++## Library Outline
++
++```@contents
++Pages = ["lib/public.md", "lib/internals.md"]
++```
++
++### [Index](@id main-index)
++
++```@index
++Pages = ["lib/public.md"]
++```
--- /dev/null
--- /dev/null
++# Internal Documentation
++
++This page lists all the documented internals of the `Documenter` module and submodules.
++
++## Contents
++
++```@contents
++Pages = [joinpath("internals", f) for f in readdir("internals")]
++```
++
++## Index
++
++A list of all internal documentation sorted by module.
++
++```@index
++Pages = [joinpath("internals", f) for f in readdir("internals")]
++```
--- /dev/null
--- /dev/null
++# Anchors
++
++```@autodocs
++Modules = [Documenter.Anchors]
++```
--- /dev/null
--- /dev/null
++# Builder
++
++```@autodocs
++Modules = [Documenter.Builder]
++```
--- /dev/null
--- /dev/null
++# CrossReferences
++
++```@autodocs
++Modules = [Documenter.CrossReferences]
++```
--- /dev/null
--- /dev/null
++# DocChecks
++
++```@autodocs
++Modules = [Documenter.DocChecks]
++```
--- /dev/null
--- /dev/null
++# DocMeta
++
++```@docs
++DocMeta.initdocmeta!
++DocMeta.META
++DocMeta.METAMODULES
++DocMeta.METATYPE
++DocMeta.VALIDMETA
++```
--- /dev/null
--- /dev/null
++# DocSystem
++
++```@autodocs
++Modules = [Documenter.DocSystem]
++```
--- /dev/null
--- /dev/null
++# DocTests
++
++```@autodocs
++Modules = [Documenter.DocTests]
++```
--- /dev/null
--- /dev/null
++# Documenter
++
++```@docs
++Documenter.gitrm_copy
++Documenter.git_push
++```
--- /dev/null
--- /dev/null
++# DocumenterTools
++
++```@docs
++DocumenterTools.package_devpath
++```
++
++## Generator
++
++```@autodocs
++Modules = [DocumenterTools.Generator]
++```
--- /dev/null
--- /dev/null
++# Documents
++
++```@autodocs
++Modules = [Documenter.Documents]
++```
--- /dev/null
--- /dev/null
++# DOM
++
++```@autodocs
++Modules = [Documenter.Utilities.DOM]
++```
--- /dev/null
--- /dev/null
++# Expanders
++
++```@autodocs
++Modules = [Documenter.Expanders]
++```
--- /dev/null
--- /dev/null
++# Markdown2
++
++Documentation for the private [`Markdown2`](@ref Documenter.Utilities.Markdown2) module.
++
++## Index
++
++```@index
++Pages = ["markdown2.md"]
++```
++
++## Docstrings
++
++```@autodocs
++Modules = [Documenter.Utilities.Markdown2]
++```
--- /dev/null
--- /dev/null
++# MDFlatten
++
++```@autodocs
++Modules = [Documenter.Utilities.MDFlatten]
++```
--- /dev/null
--- /dev/null
++# Selectors
++
++```@autodocs
++Modules = [Documenter.Selectors]
++```
--- /dev/null
--- /dev/null
++# TextDiff
++
++```@autodocs
++Modules = [Documenter.Utilities.TextDiff]
++```
--- /dev/null
--- /dev/null
++# Utilities
++
++```@autodocs
++Modules = [Documenter.Utilities]
++```
--- /dev/null
--- /dev/null
++# Writers
++
++```@autodocs
++Modules = [
++ Documenter.Writers,
++ Documenter.Writers.MarkdownWriter,
++ Documenter.Writers.HTMLWriter,
++ Documenter.Writers.LaTeXWriter,
++]
++```
++```@docs
++Documenter.Plugin
++```
--- /dev/null
--- /dev/null
++# Public Documentation
++
++Documentation for `Documenter.jl`'s public interface.
++
++See [Internal Documentation](@ref) for internal package docs covering all submodules.
++
++## Contents
++
++```@contents
++Pages = ["public.md"]
++```
++
++## Index
++
++```@index
++Pages = ["public.md"]
++```
++
++## Public Interface
++
++```@docs
++Documenter
++makedocs
++hide
++deploydocs
++Deps
++Deps.pip
++doctest
++DocMeta
++DocMeta.getdocmeta
++DocMeta.setdocmeta!
++```
++
++## DocumenterTools
++
++```@docs
++DocumenterTools.generate
++DocumenterTools.Travis.genkeys
++DocumenterTools.Travis
++```
--- /dev/null
--- /dev/null
++# Doctests
++
++Documenter will, by default, run `jldoctest` code blocks that it finds and makes sure that
++the actual output matches what's in the doctest. This can help to avoid documentation
++examples from becoming outdated, incorrect, or misleading. It's recommended that as many of
++a package's examples be runnable by Documenter's doctest.
++
++This section of the manual outlines how to go about enabling doctests for code blocks in
++your package's documentation.
++
++## "Script" Examples
++
++The first, of two, types of doctests is the "script" code block. To make Documenter detect
++this kind of code block the following format must be used:
++
++````markdown
++```jldoctest
++a = 1
++b = 2
++a + b
++
++# output
++
++3
++```
++````
++
++The code block's "language" must be `jldoctest` and must include a line containing the text `#
++output`. The text before this line is the contents of the script which is run. The text that
++appears after `# output` is the textual representation that would be shown in the Julia REPL
++if the script had been `include`d.
++
++The actual output produced by running the "script" is compared to the expected result and
++any difference will result in [`makedocs`](@ref) throwing an error and terminating.
++
++Note that the amount of whitespace appearing above and below the `# output` line is not
++significant and can be increased or decreased if desired.
++
++It is possible to suppress the output from the doctest by setting the `output` keyword
++argument to `false`, for example
++
++````markdown
++```jldoctest; output = false
++a = 1
++b = 2
++a + b
++
++# output
++
++3
++```
++````
++
++Note that the output of the script will still be compared to the expected result,
++i.e. what is `# output` section, but the `# output` section will be suppressed in
++the rendered documentation.
++
++## REPL Examples
++
++The other kind of doctest is a simulated Julia REPL session. The following format is
++detected by Documenter as a REPL doctest:
++
++````markdown
++```jldoctest
++julia> a = 1
++1
++
++julia> b = 2;
++
++julia> c = 3; # comment
++
++julia> a + b + c
++6
++```
++````
++
++As with script doctests, the code block must have it's language set to `jldoctest`. When a code
++block contains one or more `julia> ` at the start of a line then it is assumed to be a REPL
++doctest. Semi-colons, `;`, at the end of a line works in the same way as in the Julia REPL
++and will suppress the output, although the line is still evaluated.
++
++Note that not all features of the REPL are supported such as shell and help modes.
++
++## Exceptions
++
++Doctests can also test for thrown exceptions and their stacktraces. Comparing of the actual
++and expected results is done by checking whether the expected result matches the start of
++the actual result. Hence, both of the following errors will match the actual result.
++
++````markdown
++```jldoctest
++julia> div(1, 0)
++ERROR: DivideError: integer division error
++ in div(::Int64, ::Int64) at ./int.jl:115
++
++julia> div(1, 0)
++ERROR: DivideError: integer division error
++```
++````
++
++If instead the first `div(1, 0)` error was written as
++
++````markdown
++```jldoctest
++julia> div(1, 0)
++ERROR: DivideError: integer division error
++ in div(::Int64, ::Int64) at ./int.jl:114
++```
++````
++
++where line `115` is replaced with `114` then the doctest will fail.
++
++In the second `div(1, 0)`, where no stacktrace is shown, it may appear to the reader that
++it is expected that no stacktrace will actually be displayed when they attempt to try to
++recreate the error themselves. To indicate to readers that the output result is truncated
++and does not display the entire (or any of) the stacktrace you may write `[...]` at the
++line where checking should stop, i.e.
++
++````markdown
++```jldoctest
++julia> div(1, 0)
++ERROR: DivideError: integer division error
++[...]
++```
++````
++
++## Preserving Definitions Between Blocks
++
++Every doctest block is evaluated inside its own `module`. This means that definitions
++(types, variables, functions etc.) from a block can *not* be used in the next block.
++For example:
++
++````markdown
++```jldoctest
++julia> foo = 42
++42
++```
++````
++
++The variable `foo` will not be defined in the next block:
++
++````markdown
++```jldoctest
++julia> println(foo)
++ERROR: UndefVarError: foo not defined
++```
++````
++
++To preserve definitions it is possible to label blocks in order to collect several blocks
++into the same module. All blocks with the same label (in the same file) will be evaluated
++in the same module, and hence share scope. This can be useful if the same definitions are
++used in more than one block, with for example text, or other doctest blocks, in between.
++Example:
++
++````markdown
++```jldoctest mylabel
++julia> foo = 42
++42
++```
++````
++
++Now, since the block below has the same label as the block above, the variable `foo` can
++be used:
++
++````markdown
++```jldoctest mylabel
++julia> println(foo)
++42
++```
++````
++
++!!! note
++
++ Labeled doctest blocks do not need to be consecutive (as in the example above) to be
++ included in the same module. They can be interspaced with unlabeled blocks or blocks
++ with another label.
++
++## Setup Code
++
++Doctests may require some setup code that must be evaluated prior to that of the actual
++example, but that should not be displayed in the final documentation. There are three ways
++to specify the setup code, each appropriate in a different situation.
++
++### `DocTestSetup` in `@meta` blocks
++
++For doctests in the Markdown source files, an `@meta` block containing a `DocTestSetup =
++...` value can be used. In the example below, the function `foo` is defined inside a `@meta`
++block. This block will be evaluated at the start of the following doctest blocks:
++
++````markdown
++```@meta
++DocTestSetup = quote
++ function foo(x)
++ return x^2
++ end
++end
++```
++
++```jldoctest
++julia> foo(2)
++4
++```
++
++```@meta
++DocTestSetup = nothing
++```
++````
++
++The `DocTestSetup = nothing` is not strictly necessary, but good practice nonetheless to
++help avoid unintentional definitions in following doctest blocks.
++
++While technically the `@meta` blocks also work within docstrings, their use there is
++discouraged since the `@meta` blocks will show up when querying docstrings in the REPL.
++
++!!! note "Historic note"
++ It used to be that `DocTestSetup`s in `@meta` blocks in Markdown files that included
++ docstrings also affected the doctests in the docstrings. Since Documenter 0.23 that is
++ no longer the case. You should use [Module-level metadata](@ref) or [Block-level setup
++ code](@ref) instead.
++
++### Module-level metadata
++
++For doctests that are in docstrings, the exported [`DocMeta`](@ref) module provides an API
++to attach metadata that applies to all the docstrings in a particular module. Setting up the
++`DocTestSetup` metadata should be done before the [`makedocs`](@ref) or [`doctest`](@ref)
++call:
++
++```julia
++using MyPackage, Documenter
++DocMeta.setdocmeta!(MyPackage, :DocTestSetup, :(using MyPackage); recursive=true)
++makedocs(modules=[MyPackage], ...)
++```
++
++### Block-level setup code
++
++Yet another option is to use the `setup` keyword argument to the `jldoctest` block, which is
++convenient for short definitions, and for setups needed in inline docstrings.
++
++````markdown
++```jldoctest; setup = :(foo(x) = x^2)
++julia> foo(2)
++4
++```
++````
++
++!!! note
++
++ The `DocTestSetup` and the `setup` values are **re-evaluated** at the start of *each* doctest block
++ and no state is shared between any code blocks.
++ To preserve definitions see [Preserving Definitions Between Blocks](@ref).
++
++## Filtering Doctests
++
++A part of the output of a doctest might be non-deterministic, e.g. pointer addresses and timings.
++It is therefore possible to filter a doctest so that the deterministic part can still be tested.
++
++A filter takes the form of a regular expression.
++In a doctest, each match in the expected output and the actual output is removed before the two outputs are compared.
++Filters are added globally, i.e. applied to all doctests in the documentation, by passing a list of regular expressions to
++`makedocs` with the keyword `doctestfilters`.
++
++For more fine grained control it is possible to define filters in `@meta` blocks by assigning them
++to the `DocTestFilters` variable, either as a single regular expression (`DocTestFilters = [r"foo"]`)
++or as a vector of several regex (`DocTestFilters = [r"foo", r"bar"]`).
++
++An example is given below where some of the non-deterministic output from `@time` is filtered.
++
++````markdown
++```@meta
++DocTestFilters = r"[0-9\.]+ seconds \(.*\)"
++```
++
++```jldoctest
++julia> @time [1,2,3,4]
++ 0.000003 seconds (5 allocations: 272 bytes)
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++
++```@meta
++DocTestFilters = nothing
++```
++````
++
++The `DocTestFilters = nothing` is not strictly necessary, but good practice nonetheless to
++help avoid unintentional filtering in following doctest blocks.
++
++Another option is to use the `filter` keyword argument. This defines a doctest-local filter
++which is only active for the specific doctest. Note that such filters are not shared between
++named doctests either. It is possible to define a filter by a single regex (filter = r"foo")
++or as a list of regex (filter = [r"foo", r"bar"]). Example:
++
++````markdown
++```jldoctest; filter = r"[0-9\.]+ seconds \(.*\)"
++julia> @time [1,2,3,4]
++ 0.000003 seconds (5 allocations: 272 bytes)
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++````
++
++!!! note
++
++ The global filters, filters defined in `@meta` blocks, and filters defined with the `filter`
++ keyword argument are all applied to each doctest.
++
++
++## Doctesting as Part of Testing
++
++Documenter provides the [`doctest`](@ref) function which can be used to verify all doctests
++independently of manual builds. It behaves like a `@testset`, so it will return a testset
++if all the tests pass or throw a `TestSetException` if it does not.
++
++For example, it can be used to verify doctests as part of the normal test suite by having
++e.g. the following in `runtests.jl`:
++
++```julia
++using Test, Documenter, MyPackage
++doctest(MyPackage)
++```
++
++By default, it will also attempt to verify all the doctests on manual `.md` files, which it
++assumes are located under `docs/src`. This can be configured or disabled with the `manual`
++keyword (see [`doctest`](@ref) for more information).
++
++It can also be included in another testset, in which case it gets incorporated into the
++parent testset. So, as another example, to test a package that does have separate manual
++pages, just docstrings, and also collects all the tests into a single testset, the
++`runtests.jl` might look as follows:
++
++```julia
++using Test, Documenter, MyPackage
++@testset "MyPackage" begin
++ ... # other tests & testsets
++ doctest(MyPackage; manual = false)
++ ... # other tests & testsets
++end
++```
++
++Note that you still need to make sure that all the necessary [Module-level metadata](@ref)
++for the doctests is set up before [`doctest`](@ref) is called. Also, you need to add
++Documenter and all the other packages you are loading in the doctests as test dependencies.
++
++
++## Fixing Outdated Doctests
++
++To fix outdated doctests, the [`doctest`](@ref) function can be called with `fix = true`.
++This will run the doctests, and overwrite the old results with the new output. This can be
++done just in the REPL:
++
++```julia-repl
++julia> using Documenter, MyPackage
++julia> doctest(MyPackage, fix=true)
++```
++
++Alternatively, you can also pass the `doctest = :fix` keyword to [`makedocs`](@ref).
++
++!!! note
++
++ * The `:fix` option currently only works for LF line endings (`'\n'`)
++
++ * It is recommended to `git commit` any code changes before running the doctest fixing.
++ That way it is simple to restore to the previous state if the fixing goes wrong.
++
++ * There are some corner cases where the fixing algorithm may replace the wrong code
++ snippet. It is therefore recommended to manually inspect the result of the fixing
++ before committing.
++
++
++## Skipping Doctests
++
++Doctesting can be disabled by setting the [`makedocs`](@ref) keyword `doctest = false`.
++This should only be done when initially laying out the structure of a package's
++documentation, after which it's encouraged to always run doctests when building docs.
--- /dev/null
--- /dev/null
++# Examples
++
++Sometimes the best way to learn how to use a new package is to look for
++examples of what others have already built with it.
++
++The following packages use Documenter to build their documentation and so
++should give a good overview of what this package is currently able to do.
++
++!!! note
++
++ Packages are listed alphabetically. If you have a package that uses Documenter then
++ please open a PR that adds it to the appropriate list below; a simple way to do so
++ is to navigate to
++ https://github.com/JuliaDocs/Documenter.jl/edit/master/docs/src/man/examples.md.
++
++ The `make.jl` file for all listed packages will be tested to check for potential
++ regressions prior to tagging new Documenter releases whenever possible.
++
++## Registered
++
++Packages that have tagged versions available in `METADATA.jl`.
++
++- [Augmentor.jl](https://evizero.github.io/Augmentor.jl/)
++- [BanditOpt.jl](https://v-i-s-h.github.io/BanditOpt.jl/stable/)
++- [BeaData.jl](https://stephenbnicar.github.io/BeaData.jl/stable/)
++- [Bio.jl](http://biojulia.net/Bio.jl/stable/)
++- [ControlSystems.jl](http://juliacontrol.github.io/ControlSystems.jl/stable/)
++- [DiscretePredictors.jl](https://github.com/v-i-s-h/DiscretePredictors.jl)
++- [Documenter.jl](https://juliadocs.github.io/Documenter.jl/stable/)
++- [EvolvingGraphs.jl](https://etymoio.github.io/EvolvingGraphs.jl/stable/)
++- [ExtractMacro.jl](https://carlobaldassi.github.io/ExtractMacro.jl/stable/)
++- [EzXML.jl](https://bicycle1885.github.io/EzXML.jl/stable/)
++- [FourierFlows.jl](https://FourierFlows.github.io/FourierFlows.jl/stable/)
++- [Gadfly.jl](http://gadflyjl.org/stable/)
++- [GeoStats.jl](http://juliohm.github.io/GeoStats.jl/stable/)
++- [Highlights.jl](https://juliadocs.github.io/Highlights.jl/stable/)
++- [IntervalConstraintProgramming.jl](https://juliaintervals.github.io/IntervalConstraintProgramming.jl/stable/)
++- [Luxor.jl](https://juliagraphics.github.io/Luxor.jl/stable/)
++- [MergedMethods.jl](https://michaelhatherly.github.io/MergedMethods.jl/stable/)
++- [Mimi.jl](https://www.mimiframework.org/Mimi.jl/stable/)
++- [NumericSuffixes.jl](https://michaelhatherly.github.io/NumericSuffixes.jl/stable/)
++- [NLOptControl.jl](https://huckl3b3rry87.github.io/MPCDocs.jl/stable/)
++- [OhMyREPL.jl](https://github.com/KristofferC/OhMyREPL.jl)
++- [OnlineStats.jl](https://joshday.github.io/OnlineStats.jl/stable/)
++- [POMDPs.jl](http://juliapomdp.github.io/POMDPs.jl/stable/)
++- [PhyloNetworks.jl](http://crsl4.github.io/PhyloNetworks.jl/stable/)
++- [PrivateModules.jl](https://michaelhatherly.github.io/PrivateModules.jl/stable/)
++- [Query.jl](http://www.queryverse.org/Query.jl/stable/)
++- [TaylorSeries.jl](http://www.juliadiff.org/TaylorSeries.jl/stable/)
++- [Weave.jl](http://weavejl.mpastell.com/stable/)
++
++## Documentation repositories
++
++Some projects or organizations maintain dedicated documentation repositories that are
++separate from specific packages.
++
++- [DifferentialEquations.jl](http://docs.juliadiffeq.org/latest/)
++- [JuliaDocs landing page](https://juliadocs.github.io/latest/)
++- [JuliaMusic](https://juliamusic.github.io/JuliaMusic_documentation.jl/latest/)
++- [Plots.jl](https://docs.juliaplots.org/latest/)
--- /dev/null
--- /dev/null
++# Package Guide
++
++Documenter is designed to do one thing -- combine markdown files and inline docstrings from
++Julia's docsystem into a single inter-linked document. What follows is a step-by-step guide
++to creating a simple document.
++
++
++## Installation
++
++Documenter can be installed using the Julia package manager.
++From the Julia REPL, type `]` to enter the Pkg REPL mode and run
++
++```
++pkg> add Documenter
++```
++
++
++## Setting up the Folder Structure
++
++!!! note
++ The function [`DocumenterTools.generate`](@ref) from the `DocumenterTools` package
++ can generate the basic structure that Documenter expects.
++
++Firstly, we need a Julia module to document. This could be a package generated via
++`PkgDev.generate` or a single `.jl` script accessible via Julia's `LOAD_PATH`. For this
++guide we'll be using a package called `Example.jl` that has the following directory layout:
++
++```
++Example/
++ src/
++ Example.jl
++ ...
++```
++
++Note that the `...` just represent unimportant files and folders.
++
++We must decide on a location where we'd like to store the documentation for this package.
++It's recommended to use a folder named `docs/` in the toplevel of the package, like so
++
++```
++Example/
++ docs/
++ ...
++ src/
++ Example.jl
++ ...
++```
++
++Inside the `docs/` folder we need to add two things. A source folder which will contain the
++markdown files that will be used to build the finished document and a Julia script that will
++be used to control the build process. The following names are recommended
++
++```
++docs/
++ src/
++ make.jl
++```
++
++
++## Building an Empty Document
++
++With our `docs/` directory now setup we're going to build our first document. It'll just be
++a single empty file at the moment, but we'll be adding to it later on.
++
++Add the following to your `make.jl` file
++
++```julia
++using Documenter, Example
++
++makedocs(sitename="My Documentation")
++```
++
++This assumes you've installed Documenter as discussed in [Installation](@ref) and that your
++`Example.jl` package can be found by Julia.
++
++!!! note
++
++ If your source directory is not accessible through Julia's LOAD_PATH, you might wish to
++ add the following line at the top of make.jl
++
++ ```julia
++ push!(LOAD_PATH,"../src/")
++ ```
++
++Now add an `index.md` file to the `src/` directory.
++
++!!! note
++ If you use Documenter's default HTML output the name `index.md` is mandatory.
++ This file will be the main page of the rendered HTML documentation.
++
++Leave the newly added file empty and then run the following command from the `docs/` directory
++
++```sh
++$ julia make.jl
++```
++
++Note that `$` just represents the prompt character. You don't need to type that.
++
++If you'd like to see the output from this command in color use
++
++```sh
++$ julia --color=yes make.jl
++```
++
++When you run that you should see the following output
++
++```
++Documenter: setting up build directory.
++Documenter: expanding markdown templates.
++Documenter: building cross-references.
++Documenter: running document checks.
++ > checking for missing docstrings.
++ > running doctests.
++ > checking footnote links.
++Documenter: populating indices.
++Documenter: rendering document.
++```
++
++The `docs/` folder should contain a new directory -- called `build/`. It's structure should
++look like the following
++
++```
++build/
++ assets/
++ arrow.svg
++ documenter.css
++ documenter.js
++ search.js
++ index.html
++ search/index.html
++ search_index.js
++```
++
++!!! note
++
++ By default, Documenter has pretty URLs enabled, which means that `src/foo.md` is turned
++ into `src/foo/index.html`, instead of simply `src/foo.html`, which is the preferred way
++ when creating a set of HTML to be hosted on a web server.
++
++ However, this can be a hindrance when browsing the documentation locally as browsers do
++ not resolve directory URLs like `foo/` to `foo/index.html` for local files. You have two
++ options:
++
++ 1. You can run a local web server out of the `docs/build` directory. If you have Python
++ installed, you can simple start one with `python3 -m http.server --bind localhost`
++ (or `python -m SimpleHTTPServer` with Python 2).
++
++ 2. You can disable the pretty URLs feature by passing `prettyurls = false` with the
++ [`Documenter.HTML`](@ref) plugin:
++
++ ```julia
++ makedocs(..., format = Documenter.HTML(prettyurls = false))
++ ```
++
++ Alternatively, if your goal is to eventually set up automatic documentation deployment
++ with Travis CI (see [Hosting Documentation](@ref)), you can also use their environment
++ variables to determine Documenter's behavior in `make.jl` on the fly:
++
++ ```julia
++ makedocs(...,
++ format = Documenter.HTML(
++ prettyurls = get(ENV, "CI", nothing) == "true"
++ )
++ )
++ ```
++
++!!! warning
++
++ **Never** `git commit` the contents of `build` (or any other content generated by
++ Documenter) to your repository's `master` branch. Always commit generated files to the
++ `gh-pages` branch of your repository. This helps to avoid including unnecessary changes
++ for anyone reviewing commits that happen to include documentation changes.
++
++ See the [Hosting Documentation](@ref) section for details regarding how you should go
++ about setting this up correctly.
++
++At this point `build/index.html` should be an empty page since `src/index.md` is empty. You
++can try adding some text to `src/index.md` and re-running the `make.jl` file to see the
++changes.
++
++
++## Adding Some Docstrings
++
++Next we'll splice a docstring defined in the `Example` module into the `index.md` file. To
++do this first document a function in that module:
++
++```julia
++module Example
++
++export func
++
++"""
++ func(x)
++
++Returns double the number `x` plus `1`.
++"""
++func(x) = 2x + 1
++
++end
++```
++
++Then in the `src/index.md` file add the following
++
++````markdown
++# Example.jl Documentation
++
++```@docs
++func(x)
++```
++````
++
++When we next run `make.jl` the docstring for `Example.func(x)` should appear in place of
++the `@docs` block in `build/index.md`. Note that *more than one* object can be referenced
++inside a `@docs` block -- just place each one on a separate line.
++
++Note that a `@docs` block is evaluated in the `Main` module. This means that each object
++listed in the block must be visible there. The module can be changed to something else on
++a per-page basis with a `@meta` block as in the following
++
++````markdown
++# Example.jl Documentation
++
++```@meta
++CurrentModule = Example
++```
++
++```@docs
++func(x)
++```
++````
++
++### Filtering included docstrings
++
++In some cases you may want to include a docstring for a `Method` that extends a
++`Function` from a different module -- such as `Base`. In the following example we extend
++`Base.length` with a new definition for the struct `T` and also add a docstring:
++
++```julia
++struct T
++ # ...
++end
++
++"""
++Custom `length` docs for `T`.
++"""
++Base.length(::T) = 1
++```
++
++When trying to include this docstring with
++
++````markdown
++```@docs
++length
++```
++````
++
++all the docs for `length` will be included -- even those from other modules. There are two
++ways to solve this problem. Either include the type in the signature with
++
++````markdown
++```@docs
++length(::T)
++```
++````
++
++or declare the specific modules that [`makedocs`](@ref) should include with
++
++```julia
++makedocs(
++ # options
++ modules = [MyModule]
++)
++```
++
++
++## Cross Referencing
++
++It may be necessary to refer to a particular docstring or section of your document from
++elsewhere in the document. To do this we can make use of Documenter's cross-referencing
++syntax which looks pretty similar to normal markdown link syntax. Replace the contents of
++`src/index.md` with the following
++
++````markdown
++# Example.jl Documentation
++
++```@docs
++func(x)
++```
++
++- link to [Example.jl Documentation](@ref)
++- link to [`func(x)`](@ref)
++````
++
++So we just have to replace each link's url with `@ref` and write the name of the thing we'd
++link to cross-reference. For document headers it's just plain text that matches the name of
++the header and for docstrings enclose the object in backticks.
++
++This also works across different pages in the same way. Note that these sections and
++docstrings must be unique within a document.
++
++
++## Navigation
++
++Documenter can auto-generate tables of contents and docstring indexes for your document with
++the following syntax. We'll illustrate these features using our `index.md` file from the
++previous sections. Add the following to that file
++
++````markdown
++# Example.jl Documentation
++
++```@contents
++```
++
++## Functions
++
++```@docs
++func(x)
++```
++
++## Index
++
++```@index
++```
++````
++
++The `@contents` block will generate a nested list of links to all the section headers in
++the document. By default it will gather all the level 1 and 2 headers from every page in the
++document, but this can be adjusted using `Pages` and `Depth` settings as in the following
++
++````markdown
++```@contents
++Pages = ["foo.md", "bar.md"]
++Depth = 3
++```
++````
++
++The `@index` block will generate a flat list of links to all the docs that that have been
++spliced into the document using `@docs` blocks. As with the `@contents` block the pages to
++be included can be set with a `Pages = [...]` line. Since the list is not nested `Depth` is
++not supported for `@index`.
++
++
++## Pages in the Sidebar
++
++By default all the pages (`.md` files) in your source directory get added to the sidebar,
++sorted by their filenames. However, in most cases you want to use the `pages` argument to
++[`makedocs`](@ref) to control how the sidebar looks like. The basic usage is as follows:
++
++```julia
++makedocs(
++ ...,
++ pages = [
++ "page.md",
++ "Page title" => "page2.md",
++ "Subsection" => [
++ ...
++ ]
++ ]
++)
++```
++
++Using the `pages` argument you can organize your pages into subsections and hide some pages
++from the sidebar with the help of the [`hide`](@ref) functions.
--- /dev/null
--- /dev/null
++# Hosting Documentation
++
++After going through the [Package Guide](@ref) and [Doctests](@ref) page you will need to
++host the generated documentation somewhere for potential users to read. This guide will
++describe how to setup automatic updates for your package docs using the Travis build service
++and GitHub Pages. This is the same approach used by this package to host its own docs --
++the docs you're currently reading.
++
++!!! note
++
++ Following this guide should be the *final* step you take after you are comfortable with
++ the syntax and build process used by `Documenter.jl`. It is recommended that you only
++ proceed with the steps outlined here once you have successfully managed to build your
++ documentation locally with Documenter.
++
++ This guide assumes that you already have [GitHub](https://github.com/) and
++ [Travis](https://travis-ci.com/) accounts setup. If not then go set those up first and
++ then return here.
++
++
++## Overview
++
++Once set up correctly, the following will happen each time you push new updates to your
++package repository:
++
++- Travis buildbots will start up and run your package tests in a "Test" stage.
++- After the Test stage completes, a single bot will run a new "Documentation" stage, which
++ will build the documentation.
++- If the documentation is built successfully, the bot will attempt to push the generated
++ HTML pages back to GitHub.
++
++Note that the hosted documentation does not update when you make pull requests; you see
++updates only when you merge to `master` or push new tags.
++
++The following sections outline how to enable this for your own package.
++
++
++## SSH Deploy Keys
++
++Deploy keys provide push access to a *single* repository, to allow secure deployment of
++generated documentation from Travis to GitHub. The SSH keys can be generated with the
++`Travis.genkeys` from the [DocumenterTools](https://github.com/JuliaDocs/DocumenterTools.jl)
++package.
++
++!!! note
++
++ You will need several command line programs (`which`, `git` and `ssh-keygen`) to be
++ installed for the following steps to work. If DocumenterTools fails, please see the the
++ [SSH Deploy Keys Walkthrough](@ref) section for instruction on how to generate the keys
++ manually (including in Windows).
++
++
++Install and load DocumenterTools with
++
++```
++pkg> add DocumenterTools
++```
++```julia-repl
++julia> using DocumenterTools
++```
++
++Then call the [`Travis.genkeys`](@ref) function as follows:
++
++```julia-repl
++julia> using MyPackage
++julia> Travis.genkeys(user="MyUser", repo="git@github.com:MyUser/MyPackage.jl.git")
++```
++
++where `MyPackage` is the name of the package you would like to create deploy keys for and `MyUser` is your GitHub username. Note that the keyword arguments are optional and can be omitted.
++
++If the package is checked out in development mode with `] dev MyPackage`, you can also use `Travis.genkeys` as follows:
++
++```julia-repl
++julia> using MyPackage
++julia> Travis.genkeys(MyPackage)
++```
++
++where `MyPackage` is the package you would like to create deploy keys for. The output will look similar to the text below:
++
++```
++INFO: add the public key below to https://github.com/USER/REPO/settings/keys
++ with read/write access:
++
++[SSH PUBLIC KEY HERE]
++
++INFO: add a secure environment variable named 'DOCUMENTER_KEY' to
++ https://travis-ci.com/USER/REPO/settings with value:
++
++[LONG BASE64 ENCODED PRIVATE KEY]
++```
++
++Follow the instructions that are printed out, namely:
++
++ 1. Add the public ssh key to your settings page for the GitHub repository that you are
++ setting up by following the `.../settings/key` link provided. Click on **`Add deploy
++ key`**, enter the name **`documenter`** as the title, and copy the public key into the
++ **`Key`** field. Check **`Allow write access`** to allow Documenter to commit the
++ generated documentation to the repo.
++
++ 2. Next add the long private key to the Travis settings page using the provided link. Again
++ note that you should include **no whitespace** when copying the key. In the **`Environment
++ Variables`** section add a key with the name `DOCUMENTER_KEY` and the value that was printed
++ out. **Do not** set the variable to be displayed in the build log. Then click **`Add`**.
++
++ !!! warning "Security warning"
++
++ To reiterate: make sure that the "Display value in build log" option is **OFF** for
++ the variable, so that it does not get printed when the tests run. This
++ base64-encoded string contains the *unencrypted* private key that gives full write
++ access to your repository, so it must be kept safe. Also, make sure that you never
++ expose this variable in your tests, nor merge any code that does. You can read more
++ about Travis environment variables in [Travis User Documentation](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings).
++
++!!! note
++
++ There are more explicit instructions for adding the keys to GitHub and Travis in the
++ [SSH Deploy Keys Walkthrough](@ref) section of the manual.
++
++## `.travis.yml` Configuration
++
++To tell Travis that we want a new build stage we can add the following to the `.travis.yml`
++file:
++
++```yaml
++jobs:
++ include:
++ - stage: "Documentation"
++ julia: 1.0
++ os: linux
++ script:
++ - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
++ Pkg.instantiate()'
++ - julia --project=docs/ docs/make.jl
++ after_success: skip
++```
++
++where the `julia:` and `os:` entries decide the worker from which the docs are built and
++deployed. In the example above we will thus build and deploy the documentation from a linux
++worker running Julia 1.0. For more information on how to setup a build stage, see the Travis
++manual for [Build Stages](https://docs.travis-ci.com/user/build-stages).
++
++The three lines in the `script:` section do the following:
++
++ 1. Instantiate the doc-building environment (i.e. `docs/Project.toml`, see below).
++ 2. Install your package in the doc-build environment.
++ 3. Run the docs/make.jl script, which builds and deploys the documentation.
++
++!!! note
++ If your package has a build script you should call
++ `Pkg.build("PackageName")` after the call to `Pkg.develop` to make
++ sure the package is built properly.
++
++The doc-build environment `docs/Project.toml` includes Documenter and other doc-build
++dependencies your package might have. If Documenter is the only dependency, then the
++`Project.toml` should include the following:
++
++````@eval
++import Documenter, Markdown
++m = match(r"^version = \"(\d+.\d+.\d+)\"$"m,
++ read(joinpath(dirname(dirname(pathof(Documenter))), "Project.toml"), String))
++v = VersionNumber(m.captures[1])
++Markdown.parse("""
++```toml
++[deps]
++Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
++
++[compat]
++Documenter = "~$(v.major).$(v.minor)"
++```
++""")
++````
++
++Note that it is recommended that you have a `[compat]` section, like the one above, in your
++`Project.toml` file, which would restrict Documenter's version that gets installed when the
++build runs. This is to make sure that your builds do not start failing suddenly due to a new
++major release of Documenter, which may include breaking changes. However, it also means that
++you will not get updates to Documenter automatically, and hence need to upgrade Documenter's
++major version yourself.
++
++
++## The `deploydocs` Function
++
++At the moment your `docs/make.jl` file probably only contains
++
++```julia
++using Documenter, PACKAGE_NAME
++
++makedocs()
++```
++
++We'll need to add an additional function call to this file after [`makedocs`](@ref) which
++would perform the deployment of the docs to the `gh-pages` branch.
++Add the following at the end of the file:
++
++```julia
++deploydocs(
++ repo = "github.com/USER_NAME/PACKAGE_NAME.jl.git",
++)
++```
++
++where `USER_NAME` and `PACKAGE_NAME` must be set to the appropriate names.
++Note that `repo` should not specify any protocol, i.e. it should not begin with `https://`
++or `git@`.
++
++See the [`deploydocs`](@ref) function documentation for more details.
++
++
++
++## `.gitignore`
++
++Add the following to your package's `.gitignore` file
++
++```
++docs/build/
++```
++
++These are needed to avoid committing generated content to your repository.
++
++## `gh-pages` Branch
++
++By default, Documenter pushes documentation to the `gh-pages` branch. If the branch does not
++exist it will be created automatically by [`deploydocs`](@ref). If does exist then
++Documenter simply adds an additional commit with the built documentation. You should be
++aware that Documenter may overwrite existing content without warning.
++
++If you wish to create the `gh-pages` branch manually the that can be done following
++[these instructions](https://coderwall.com/p/0n3soa/create-a-disconnected-git-branch).
++
++## Documentation Versions
++
++The documentation is deployed as follows:
++
++- Documentation built for a tag `vX.Y.Z` will be stored in a folder `vX.Y.Z`.
++
++- Documentation built from the `devbranch` branch (`master` by default) is stored a folder
++ determined by the `devurl` keyword to [`deploydocs`](@ref) (`dev` by default).
++
++Which versions that will show up in the version selector is determined by the
++`versions` argument to [`deploydocs`](@ref).
++
++Unless a custom domain is being used, the pages are found at:
++
++```
++https://USER_NAME.github.io/PACKAGE_NAME.jl/vX.Y.Z
++https://USER_NAME.github.io/PACKAGE_NAME.jl/dev
++```
++
++By default Documenter will create a link called `stable` that points to the latest release
++
++```
++https://USER_NAME.github.io/PACKAGE_NAME.jl/stable
++```
++
++It is recommended to use this link, rather then the versioned links, since it will be updated
++with new releases.
++
++Once your documentation has been pushed to the `gh-pages` branch you should add links to
++your `README.md` pointing to the `stable` (and perhaps `dev`) documentation URLs. It is common
++practice to make use of "badges" similar to those used for Travis and AppVeyor build
++statuses or code coverage. Adding the following to your package `README.md` should be all
++that is necessary:
++
++```markdown
++[](https://USER_NAME.github.io/PACKAGE_NAME.jl/stable)
++[](https://USER_NAME.github.io/PACKAGE_NAME.jl/dev)
++```
++
++`PACKAGE_NAME` and `USER_NAME` should be replaced with their appropriate values. The colour
++and text of the image can be changed by altering `docs-stable-blue` as described on
++[shields.io](https://shields.io), though it is recommended that package authors follow this
++standard to make it easier for potential users to find documentation links across multiple
++package README files.
++
++---
++
++**Final Remarks**
++
++That should be all that is needed to enable automatic documentation building. Pushing new
++commits to your `master` branch should trigger doc builds. **Note that other branches do not
++trigger these builds and neither do pull requests by potential contributors.**
++
++If you would like to see a more complete example of how this process is setup then take a
++look at this package's repository for some inspiration.
--- /dev/null
--- /dev/null
++# SSH Deploy Keys Walkthrough
++
++If the instructions in [SSH Deploy Keys](@ref) did not work for you (for example,
++`ssh-keygen` is not installed), don't worry! This walkthrough will guide you through the
++process. There are three main steps:
++
++1. [Generating an SSH Key](@ref)
++2. [Adding the Public Key to GitHub](@ref)
++3. [Adding the Private Key to Travis](@ref)
++
++## Generating an SSH Key
++
++The first step is to generate an SSH key. An SSH key is made up of two components: a
++*public* key, which can be shared publicly, and a *private* key, which you should ensure is
++**never** shared publicly.
++
++The public key usually looks something like this
++
++```
++ssh-rsa [base64-encoded-key] [optional-comment]
++```
++
++And the private key usually look something like this
++
++```
++-----BEGIN RSA PRIVATE KEY-----
++ ... base64-encoded key over several lines ...
++-----END RSA PRIVATE KEY-----
++```
++
++### If you have `ssh-keygen` installed
++
++If you have `ssh-keygen` installed, but `Travis.genkeys()` didn't work, you can generate an
++SSH key as follows. First, generate a key using `ssh-keygen` and save it to the file
++`privatekey`:
++
++```julia
++shell> ssh-keygen -N "" -f privatekey
++```
++
++Next, we need to encode the private key in Base64. Run the following command:
++
++```julia
++julia> using Base64
++
++julia> read("privatekey", String) |> base64encode |> println
++```
++
++Copy and paste the output somewhere. This is your *private key* and is required for the step
++[Adding the Private Key to Travis](@ref).
++
++Now we need to get the public key. Run the following command:
++
++```julia
++julia> read("privatekey.pub", String) |> println
++```
++
++Copy and paste the output somewhere. This is your *public key* and is required for the step
++[Adding the Public Key to GitHub](@ref).
++
++### If you do not have `ssh-keygen`
++
++If you're using Windows, you probably don't have `ssh-keygen` installed. Instead, we're
++going to use a program called PuTTY. The first step in the process to generate a new SSH key
++is to download PuTTY:
++
++* Download and install [PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/)
++
++PuTTY is actually a collection of a few different programs. We need to use PuTTYgen. Open
++it, and you should get a window that looks like:
++
++
++
++Now we need to generate a key.
++
++* Click the "Generate" button, then follow the instructions and move the mouse around to
++ create randomness.
++
++Once you've moved the mouse enough, the window should look like:
++
++
++
++Now we need to save the public key somewhere.
++
++* Copy the text in the box titled "Public key for pasting into OpenSSH authorized_keys file"
++ and paste it somewhere for later. This is your *public key* and is required for the step
++ [Adding the Public Key to GitHub](@ref)
++
++Finally, we need to save the private key somewhere.
++
++* Click the "Conversions" tab, and then click "Export OpenSSH key". Save that file
++ somewhere. That file is your *private key* and is required for the [Adding the Private Key
++ to Travis](@ref) step.
++
++ 
++
++ !!! note
++
++ Don't save your key via the "Save private key" button as this will save the key in the
++ wrong format.
++
++If you made it this far, congratulations! You now have the private and public keys needed to
++set up automatic deployment of your documentation. The next steps are to add the keys to
++GitHub and Travis.
++
++
++## Adding the Public Key to GitHub
++
++In this section, we explain how to upload a public SSH key to GitHub. By this point, you
++should have generated a public key and saved it to a file. If you haven't done this, go read
++[Generating an SSH Key](@ref).
++
++Go to `https://github.com/[YOUR_USER_NAME]/[YOUR_REPO_NAME]/settings/keys` and click "Add
++deploy key". You should get to a page that looks like:
++
++
++
++Now we need to fill in three pieces of information.
++
++1. Have "Title" be e.g. "Documenter".
++2. Copy and paste the *public key* that we generated in the [Generating an SSH Key](@ref)
++ step into the "Key" field.
++3. Make sure that the "Allow write access" box is checked.
++
++Once you're done, click "Add key". Congratulations! You've added the public key
++to GitHub. The next step is to add the private key to Travis.
++
++
++## Adding the Private Key to Travis
++
++In this section, we explain how to upload a private SSH key to Travis. By this point, you
++should have generated a private key and saved it to a file. If you haven't done this, go
++read [Generating an SSH Key](@ref).
++
++First, we need to Base64 encode the private key. Open Julia, and run the command
++
++```julia
++julia> read("path/to/private/key", String) |> base64encode |> println
++```
++
++Copy the resulting output.
++
++Next, go to `https://travis-ci.com/[YOUR_USER_NAME]/[YOUR_REPO_NAME]/settings`. Scroll down
++to the "Environment Variables" section. It should look like this:
++
++
++
++Now, add a new environment variable called `DOCUMENTER_KEY`, and set its value to the output
++from the Julia command above (make sure to remove the surrounding quotes).
++
++Finally, check that the "Display value in build log" is switched off and then click "Add".
++Congratulations! You've added the private key to Travis.
++
++!!! warning "Security warning"
++
++ To reiterate: make sure that the "Display value in build log" option is **OFF** for
++ the variable, so that it does not get printed when the tests run. This
++ base64-encoded string contains the *unencrypted* private key that gives full write
++ access to your repository, so it must be kept safe. Also, make sure that you never
++ expose this variable in your tests, nor merge any code that does. You can read more
++ about Travis environment variables in [Travis User Documentation](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings).
++
++---
++
++**Final Remarks**
++
++You should now be able to continue on with the [Hosting Documentation](@ref).
--- /dev/null
--- /dev/null
++# [``\LaTeX`` Syntax](@id latex_syntax)
++
++The following section describes how to add equations written using ``\LaTeX`` to your
++documentation.
++
++## Escaping Characters in Docstrings
++
++Since some characters used in ``\LaTeX`` syntax, such as `$` and `\`, are treated differently in docstrings. They
++need to be escaped using a `\` character as in the following example:
++
++```julia
++"""
++Here's some inline maths: ``\\sqrt[n]{1 + x + x^2 + \\ldots}``.
++
++Here's an equation:
++
++``\\frac{n!}{k!(n - k)!} = \\binom{n}{k}``
++
++This is the binomial coefficient.
++"""
++func(x) = # ...
++```
++
++Note that for equations on the manual pages (in `.md` files) the escaping is not necessary. So, when moving equations
++between the manual and docstrings, the escaping `\` characters have to the appropriately added or removed.
++
++To avoid needing to escape the special characters in docstrings the `raw""` string macro can be used, combined with `@doc`:
++
++```julia
++@doc raw"""
++Here's some inline maths: ``\sqrt[n]{1 + x + x^2 + \ldots}``.
++
++Here's an equation:
++
++``\frac{n!}{k!(n - k)!} = \binom{n}{k}``
++
++This is the binomial coefficient.
++"""
++func(x) = # ...
++```
++
++A related issue is how to add dollar signs to a docstring. They need to be
++double-escaped as follows:
++```julia
++"""
++The cost was \\\$1.
++"""
++```
++
++## Inline Equations
++
++```markdown
++Here's some inline maths: ``\sqrt[n]{1 + x + x^2 + \ldots}``.
++```
++
++which will be displayed as
++
++---
++
++Here's some inline maths: ``\sqrt[n]{1 + x + x^2 + \ldots}``.
++
++---
++
++## Display Equations
++
++````markdown
++Here's an equation:
++
++```math
++\frac{n!}{k!(n - k)!} = \binom{n}{k}
++```
++
++This is the binomial coefficient.
++````
++
++which will be displayed as
++
++---
++
++Here's an equation:
++
++```math
++\frac{n!}{k!(n - k)!} = \binom{n}{k}
++```
++
++This is the binomial coefficient.
--- /dev/null
--- /dev/null
++# Other Output Formats
++
++In addition to the default native HTML output, plugin packages enable Documenter to generate
++output in other formats. Once the corresponding package is loaded, the output format can be
++specified using the `format` option in [`makedocs`](@ref).
++
++
++## Markdown & MkDocs
++
++Markdown output requires the [`DocumenterMarkdown`](https://github.com/JuliaDocs/DocumenterMarkdown.jl)
++package to be available and loaded.
++For Travis setups, add the package to the `docs/Project.toml` environment as a dependency.
++You also need to import the package in `make.jl`:
++
++```
++using DocumenterMarkdown
++```
++
++When `DocumenterMarkdown` is loaded, you can specify `format = Markdown()` in [`makedocs`](@ref).
++Documenter will then output a set of Markdown files to the `build` directory that can then
++further be processed with [MkDocs](https://www.mkdocs.org/) into HTML pages.
++
++MkDocs, of course, is not the only option you have -- any markdown to HTML converter should
++work fine with some amount of setting up.
++
++!!! note
++
++ Markdown output used to be the default option (i.e. when leaving the `format` option
++ unspecified). The default now is the HTML output.
++
++### The MkDocs `mkdocs.yml` file
++
++A MkDocs build is controlled by the `mkdocs.yml` configuration file. Add the file with the
++following content to the `docs/` directory:
++
++```yaml
++site_name: PACKAGE_NAME.jl
++repo_url: https://github.com/USER_NAME/PACKAGE_NAME.jl
++site_description: Description...
++site_author: USER_NAME
++
++theme: readthedocs
++
++extra_css:
++ - assets/Documenter.css
++
++extra_javascript:
++ - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS_HTML
++ - assets/mathjaxhelper.js
++
++markdown_extensions:
++ - extra
++ - tables
++ - fenced_code
++ - mdx_math
++
++docs_dir: 'build'
++
++pages:
++ - Home: index.md
++```
++
++If you have run Documenter and it has generated a `build/` directory, you can now try running
++`mkdocs build` -- this should now generate the `site/` directory.
++You should also add the `docs/site/` directory into your `.gitignore` file, which should now
++look like:
++
++```
++docs/build/
++docs/site/
++```
++
++This is only a basic skeleton. Read through the MkDocs documentation if you would like to
++know more about the available settings.
++
++
++### Deployment with MkDocs
++
++To deploy MkDocs on Travis, you also need to provide additional keyword arguments to
++[`deploydocs`](@ref). Your [`deploydocs`](@ref) call should look something like
++
++```julia
++deploydocs(
++ repo = "github.com/USER_NAME/PACKAGE_NAME.jl.git",
++ deps = Deps.pip("mkdocs", "pygments", "python-markdown-math"),
++ make = () -> run(`mkdocs build`)
++ target = "site"
++)
++```
++
++* `deps` serves to provide the required Python dependencies to build the documentation
++* `make` specifies the function that calls `mkdocs` to perform the second build step
++* `target`, which specified which files get copied to `gh-pages`, needs to point to the
++ `site/` directory
++
++In the example above we include the dependencies [mkdocs](https://www.mkdocs.org)
++and [`python-markdown-math`](https://github.com/mitya57/python-markdown-math).
++The former makes sure that MkDocs is installed to deploy the documentation,
++and the latter provides the `mdx_math` markdown extension to exploit MathJax
++rendering of latex equations in markdown. Other dependencies should be
++included here.
++
++
++### ``\LaTeX``: MkDocs and MathJax
++
++To get MkDocs to display ``\LaTeX`` equations correctly we need to update several of this
++configuration files described in the [Package Guide](@ref).
++
++`docs/make.jl` should add the `python-markdown-math` dependency to allow for equations to
++be rendered correctly.
++
++```julia
++# ...
++
++deploydocs(
++ deps = Deps.pip("pygments", "mkdocs", "python-markdown-math"),
++ # ...
++)
++```
++
++This package should also be installed locally so that you can preview the generated
++documentation prior to pushing new commits to a repository.
++
++```sh
++$ pip install python-markdown-math
++```
++
++The `docs/mkdocs.yml` file must add the `python-markdown-math` extension, called `mdx_math`,
++as well as two MathJax JavaScript files:
++
++```yaml
++# ...
++markdown_extensions:
++ - mdx_math
++ # ...
++
++extra_javascript:
++ - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS_HTML
++ - assets/mathjaxhelper.js
++# ...
++```
++
++**Final Remarks**
++
++Following this guide and adding the necessary changes to the configuration files should
++enable properly rendered mathematical equations within your documentation both locally and
++when built and deployed using the Travis built service.
++
++
++## PDF Output via LaTeX
++
++LaTeX/PDF output requires the [`DocumenterLaTeX`](https://github.com/JuliaDocs/DocumenterLaTeX.jl)
++package to be available and loaded in `make.jl` with
++
++```
++using DocumenterLaTeX
++```
++
++When `DocumenterLaTeX` is loaded, you can set `format = LaTeX()` in [`makedocs`](@ref),
++and Documenter will generate a PDF version of the documentation using LaTeX.
++The `makedocs` argument `sitename` will be used for the `\\title` field in the tex document,
++and if the build is for a release tag (i.e. when the `"TRAVIS_TAG"` environment variable is set)
++the version number will be appended to the title.
++The `makedocs` argument `authors` should also be specified, it will be used for the
++`\\authors` field in the tex document.
++
++### Compiling using natively installed latex
++
++The following is required to build the documentation:
++
++* You need `pdflatex` command to be installed and available to Documenter.
++* You need the [minted](https://ctan.org/pkg/minted) LaTeX package and its backend source
++ highlighter [Pygments](http://pygments.org/) installed.
++* You need the [_DejaVu Sans_ and _DejaVu Sans Mono_](https://dejavu-fonts.github.io/) fonts installed.
++
++### Compiling using docker image
++
++It is also possible to use a prebuilt [docker image](https://hub.docker.com/r/juliadocs/documenter-latex/)
++to compile the `.tex` file. The image contains all of the required installs described in the section
++above. The only requirement for using the image is that `docker` is installed and available for
++the builder to call. You also need to tell Documenter to use the docker image, instead of natively
++installed tex which is the default. This is done with the `LaTeX` specifier:
++
++```
++using DocumenterLaTeX
++makedocs(
++ format = LaTeX(platform = "docker"),
++ ...
++)
++```
++
++If you build the documentation on Travis you need to add
++
++```
++services:
++ - docker
++```
++
++to your `.travis.yml` file.
--- /dev/null
--- /dev/null
++# Syntax
++
++This section of the manual describes the syntax used by Documenter to build documentation.
++For supported Markdown syntax, see the [documentation for the Markdown standard library in the Julia manual](https://docs.julialang.org/en/v1/stdlib/Markdown/).
++
++```@contents
++Pages = ["syntax.md"]
++```
++
++## `@docs` block
++
++Splice one or more docstrings into a document in place of the code block, i.e.
++
++````markdown
++```@docs
++Documenter
++makedocs
++deploydocs
++```
++````
++
++This block type is evaluated within the `CurrentModule` module if defined, otherwise within
++`Main`, and so each object listed in the block should be visible from that
++module. Undefined objects will raise warnings during documentation generation and cause the
++code block to be rendered in the final document unchanged.
++
++Objects may not be listed more than once within the document. When duplicate objects are
++detected an error will be raised and the build process will be terminated.
++
++To ensure that all docstrings from a module are included in the final document the `modules`
++keyword for [`makedocs`](@ref) can be set to the desired module or modules, i.e.
++
++```julia
++makedocs(
++ modules = [Documenter],
++)
++```
++
++which will cause any unlisted docstrings to raise warnings when [`makedocs`](@ref) is
++called. If `modules` is not defined then no warnings are printed, even if a document has
++missing docstrings.
++
++## `@autodocs` block
++
++Automatically splices all docstrings from the provided modules in place of the code block.
++This is equivalent to manually adding all the docstrings in a `@docs` block.
++
++````markdown
++```@autodocs
++Modules = [Foo, Bar]
++Order = [:function, :type]
++```
++````
++
++The above `@autodocs` block adds all the docstrings found in modules `Foo` and `Bar` that
++refer to functions or types to the document.
++
++Each module is added in order and so all docs from `Foo` will appear before those of `Bar`.
++Possible values for the `Order` vector are
++
++- `:module`
++- `:constant`
++- `:type`
++- `:function`
++- `:macro`
++
++If no `Order` is provided then the order listed above is used.
++
++When a potential docstring is found in one of the listed modules, but does not match any
++value from `Order` then it will be omitted from the document. Hence `Order` acts as a basic
++filter as well as sorter.
++
++In addition to `Order`, a `Pages` vector may be included in `@autodocs` to filter docstrings
++based on the source file in which they are defined:
++
++````markdown
++```@autodocs
++Modules = [Foo]
++Pages = ["a.jl", "b.jl"]
++```
++````
++
++In the above example docstrings from module `Foo` found in source files that end in `a.jl`
++and `b.jl` are included. The page order provided by `Pages` is also used to sort the
++docstrings. Note that page matching is done using the end of the provided strings and so
++`a.jl` will be matched by *any* source file that ends in `a.jl`, i.e. `src/a.jl` or
++`src/foo/a.jl`.
++
++To filter out certain docstrings by your own criteria, you can provide function with them
++`Filter` keyword:
++
++````markdown
++```@autodocs
++Modules = [Foo]
++Filter = t -> typeof(t) === DataType && t <: Foo.C
++```
++````
++
++In the given example, only the docstrings of the subtypes of `Foo.C` are shown. Instead
++of an [anonymous function](https://docs.julialang.org/en/v1/manual/functions/index.html#man-anonymous-functions-1)
++you can give the name of a function you defined beforehand, too:
++
++````markdown
++```@autodocs
++Modules = [Foo]
++Filter = myCustomFilterFunction
++```
++````
++
++To include only the exported names from the modules listed in `Modules` use `Private = false`.
++In a similar way `Public = false` can be used to only show the unexported names. By
++default both of these are set to `true` so that all names will be shown.
++
++````markdown
++Functions exported from `Foo`:
++
++```@autodocs
++Modules = [Foo]
++Private = false
++Order = [:function]
++```
++
++Private types in module `Foo`:
++
++```@autodocs
++Modules = [Foo]
++Public = false
++Order = [:type]
++```
++````
++
++!!! note
++
++ When more complex sorting is needed then use `@docs` to define it
++ explicitly.
++
++## `@ref` link
++
++Used in markdown links as the URL to tell Documenter to generate a cross-reference
++automatically. The text part of the link can be a docstring, header name, or GitHub PR/Issue
++number.
++
++````markdown
++# Syntax
++
++... [`makedocs`](@ref) ...
++
++# Functions
++
++```@docs
++makedocs
++```
++
++... [Syntax](@ref) ...
++
++... [#42](@ref) ...
++````
++
++Plain text in the "text" part of a link will either cross-reference a header, or, when it is
++a number preceded by a `#`, a GitHub issue/pull request. Text wrapped in backticks will
++cross-reference a docstring from a `@docs` block.
++
++`@ref`s may refer to docstrings or headers on different pages as well as the current page
++using the same syntax.
++
++Note that depending on what the `CurrentModule` is set to, a docstring `@ref` may need to
++be prefixed by the module which defines it.
++
++### Duplicate Headers
++
++In some cases a document may contain multiple headers with the same name, but on different
++pages or of different levels. To allow `@ref` to cross-reference a duplicate header it must
++be given a name as in the following example
++
++```markdown
++# [Header](@id my_custom_header_name)
++
++...
++
++## Header
++
++... [Custom Header](@ref my_custom_header_name) ...
++```
++
++The link that wraps the named header is removed in the final document. The text for a named
++`@ref ...` does not need to match the header that it references. Named `@ref ...`s may refer
++to headers on different pages in the same way as unnamed ones do.
++
++Duplicate docstring references do not occur since splicing the same docstring into a
++document more than once is disallowed.
++
++### Named doc `@ref`s
++
++Docstring `@ref`s can also be "named" in a similar way to headers as shown in the
++[Duplicate Headers](@ref) section above. For example
++
++```julia
++module Mod
++
++"""
++Both of the following references point to `g` found in module `Main.Other`:
++
++ * [`Main.Other.g`](@ref)
++ * [`g`](@ref Main.Other.g)
++
++"""
++f(args...) = # ...
++
++end
++```
++
++This can be useful to avoid having to write fully qualified names for references that
++are not imported into the current module, or when the text displayed in the link is
++used to add additional meaning to the surrounding text, such as
++
++```markdown
++Use [`for i = 1:10 ...`](@ref for) to loop over all the numbers from 1 to 10.
++```
++
++!!! note
++
++ Named doc `@ref`s should be used sparingly since writing unqualified names may, in some
++ cases, make it difficult to tell *which* function is being referred to in a particular
++ docstring if there happen to be several modules that provide definitions with the same
++ name.
++
++## `@meta` block
++
++This block type is used to define metadata key/value pairs that can be used elsewhere in the
++page. Currently recognised keys:
++- `CurrentModule`: module where Documenter evaluates, for example, [`@docs`-block](@ref)
++ and [`@ref`-link](@ref)s.
++- `DocTestSetup`: code to be evaluated before a doctest, see the [Setup Code](@ref)
++ section under [Doctests](@ref).
++- `DocTestFilters`: filters to deal with, for example, unpredictable output from doctests,
++ see the [Filtering Doctests](@ref) section under [Doctests](@ref).
++- `EditURL`: link to where the page can be edited. This defaults to the `.md` page itself,
++ but if the source is something else (for example if the `.md` page is generated as part of
++ the doc build) this can be set, either as a local link, or an absolute url.
++
++Example:
++
++````markdown
++```@meta
++CurrentModule = FooBar
++DocTestSetup = quote
++ using MyPackage
++end
++DocTestFilters = [r"Stacktrace:[\s\S]+"]
++EditURL = "link/to/source/file"
++```
++````
++
++Note that `@meta` blocks are always evaluated in `Main`.
++
++## `@index` block
++
++Generates a list of links to docstrings that have been spliced into a document. Valid
++settings are `Pages`, `Modules`, and `Order`. For example:
++
++````markdown
++```@index
++Pages = ["foo.md"]
++Modules = [Foo, Bar]
++Order = [:function, :type]
++```
++````
++
++When `Pages` or `Modules` are not provided then all pages or modules are included. `Order`
++defaults to
++
++```julia
++[:module, :constant, :type, :function, :macro]
++```
++
++if not specified. `Order` and `Modules` behave the same way as in [`@autodocs` block](@ref)s
++and filter out docstrings that do not match one of the modules or categories specified.
++
++Note that the values assigned to `Pages`, `Modules`, and `Order` may be any valid Julia code
++and thus can be something more complex that an array literal if required, i.e.
++
++````markdown
++```@index
++Pages = map(file -> joinpath("man", file), readdir("man"))
++```
++````
++
++It should be noted though that in this case `Pages` may not be sorted in the order that is
++expected by the user. Try to stick to array literals as much as possible.
++
++## `@contents` block
++
++Generates a nested list of links to document sections. Valid settings are `Pages` and `Depth`.
++
++````markdown
++```@contents
++Pages = ["foo.md"]
++Depth = 5
++```
++````
++
++As with `@index` if `Pages` is not provided then all pages are included. The default
++`Depth` value is `2`.
++
++## `@example` block
++
++Evaluates the code block and inserts the result into the final document along with the
++original source code.
++
++````markdown
++```@example
++a = 1
++b = 2
++a + b
++```
++````
++
++The above `@example` block will splice the following into the final document
++
++````markdown
++```julia
++a = 1
++b = 2
++a + b
++```
++
++```
++3
++```
++````
++
++Leading and trailing newlines are removed from the rendered code blocks. Trailing whitespace
++on each line is also removed.
++
++!!! note
++ The working directory, `pwd`, is set to the directory in `build` where the file
++ will be written to, and the paths in `include` calls are interpreted to be relative to
++ `pwd`. This can be customized with the `workdir` keyword of [`makedocs`](@ref).
++
++**Hiding Source Code**
++
++Code blocks may have some content that does not need to be displayed in the final document.
++`# hide` comments can be appended to lines that should not be rendered, i.e.
++
++````markdown
++```@example
++import Random # hide
++Random.seed!(1) # hide
++A = rand(3, 3)
++b = [1, 2, 3]
++A \ b
++```
++````
++
++Note that appending `# hide` to every line in an `@example` block will result in the block
++being hidden in the rendered document. The results block will still be rendered though.
++`@setup` blocks are a convenient shorthand for hiding an entire block, including the output.
++
++**`stdout` and `stderr`**
++
++The Julia output streams are redirected to the results block when evaluating `@example`
++blocks in the same way as when running doctest code blocks.
++
++**`nothing` Results**
++
++When the `@example` block evaluates to `nothing` then the second block is not displayed.
++Only the source code block will be shown in the rendered document. Note that if any output
++from either `stdout` or `stderr` is captured then the results block will be displayed even
++if `nothing` is returned.
++
++**Named `@example` Blocks**
++
++By default `@example` blocks are run in their own anonymous `Module`s to avoid side-effects
++between blocks. To share the same module between different blocks on a page the `@example`
++can be named with the following syntax
++
++````markdown
++```@example 1
++a = 1
++```
++
++```@example 1
++println(a)
++```
++````
++
++The name can be any text, not just integers as in the example above, i.e. `@example foo`.
++
++Named `@example` blocks can be useful when generating documentation that requires
++intermediate explanation or multimedia such as plots as illustrated in the following example
++
++````markdown
++First we define some functions
++
++```@example 1
++using PyPlot # hide
++f(x) = sin(2x) + 1
++g(x) = cos(x) - x
++```
++
++and then we plot `f` over the interval from ``-π`` to ``π``
++
++```@example 1
++x = linspace(-π, π)
++plot(x, f(x), color = "red")
++savefig("f-plot.svg"); nothing # hide
++```
++
++
++
++and then we do the same with `g`
++
++```@example 1
++plot(x, g(x), color = "blue")
++savefig("g-plot.svg"); nothing # hide
++```
++
++
++````
++
++Note that `@example` blocks are evaluated within the directory of `build` where the file
++will be rendered . This means than in the above example `savefig` will output the `.svg`
++files into that directory. This allows the images to be easily referenced without needing to
++worry about relative paths.
++
++`@example` blocks automatically define `ans` which, as in the Julia REPL, is bound to the
++value of the last evaluated expression. This can be useful in situations such as the
++following one where where binding the object returned by `plot` to a named variable would
++look out of place in the final rendered documentation:
++
++````markdown
++```@example
++using Gadfly # hide
++plot([sin, x -> 2sin(x) + x], -2π, 2π)
++draw(SVG("plot.svg", 6inch, 4inch), ans); nothing # hide
++```
++
++
++````
++
++**Delayed Execution of `@example` Blocks**
++
++`@example` blocks accept a keyword argument `continued` which can be set to `true` or `false`
++(defaults to `false`). When `continued = true` the execution of the code is delayed until the
++next `continued = false` `@example`-block. This is needed for example when the expression in
++a block is not complete. Example:
++
++````markdown
++```@example half-loop; continued = true
++for i in 1:3
++ j = i^2
++```
++Some text explaining what we should do with `j`
++```@example half-loop
++ println(j)
++end
++```
++````
++
++Here the first block is not complete -- the loop is missing the `end`. Thus, by setting
++`continued = true` here we delay the evaluation of the first block, until we reach the
++second block. A block with `continued = true` does not have any output.
++
++## `@repl` block
++
++These are similar to `@example` blocks, but adds a `julia> ` prompt before each toplevel
++expression. `;` and `# hide` syntax may be used in `@repl` blocks in the same way as in the
++Julia REPL and `@example` blocks.
++
++````markdown
++```@repl
++a = 1
++b = 2
++a + b
++```
++````
++
++will generate
++
++````markdown
++```julia
++julia> a = 1
++1
++
++julia> b = 2
++2
++
++julia> a + b
++3
++```
++````
++
++Named `@repl <name>` blocks behave in the same way as named `@example <name>` blocks.
++
++!!! note
++ The working directory, `pwd`, is set to the directory in `build` where the file
++ will be written to, and the paths in `include` calls are interpreted to be relative to
++ `pwd`. This can be customized with the `workdir` keyword of [`makedocs`](@ref).
++
++## `@setup <name>` block
++
++These are similar to `@example` blocks, but both the input and output are hidden from the
++final document. This can be convenient if there are several lines of setup code that need to be
++hidden.
++
++!!! note
++
++ Unlike `@example` and `@repl` blocks, `@setup` requires a `<name>` attribute to associate it
++ with downstream `@example <name>` and `@repl <name>` blocks.
++
++````markdown
++```@setup abc
++using RDatasets
++using DataFrames
++iris = dataset("datasets", "iris")
++```
++
++```@example abc
++println(iris)
++```
++````
++
++
++## `@eval` block
++
++Evaluates the contents of the block and inserts the resulting value into the final document.
++
++In the following example we use the PyPlot package to generate a plot and display it in the
++final document.
++
++````markdown
++```@eval
++using PyPlot
++
++x = linspace(-π, π)
++y = sin(x)
++
++plot(x, y, color = "red")
++savefig("plot.svg")
++
++nothing
++```
++
++
++````
++
++Another example is to generate markdown tables from machine readable data formats such as CSV or JSON.
++
++````markdown
++```@eval
++using CSV
++using Latexify
++df = CSV.read("table.csv")
++mdtable(df,latex=false)
++```
++````
++
++Which will generate a markdown version of the CSV file table.csv and render it in the output format.
++
++Note that each `@eval` block evaluates its contents within a separate module. When
++evaluating each block the present working directory, `pwd`, is set to the directory in
++`build` where the file will be written to, and the paths in `include` calls are interpreted
++to be relative to `pwd`.
++
++Also, instead of returning `nothing` in the example above we could have returned a new
++`Markdown.MD` object through `Markdown.parse`. This can be more appropriate when the
++filename is not known until evaluation of the block itself.
++
++!!! note
++
++ In most cases `@example` is preferred over `@eval`. Just like in normal Julia code where
++ `eval` should be only be considered as a last resort, `@eval` should be treated in the
++ same way.
++
++
++## `@raw <format>` block
++
++Allows code to be inserted into the final document verbatim. E.g. to insert custom HTML or
++LaTeX code into the output.
++
++The `format` argument is mandatory and Documenter uses it to determine whether a particular
++block should be copied over to the output or not. Currently supported formats are `html`
++and `latex`, used by the respective writers. A `@raw` block whose `format` is not
++recognized is usually ignored, so it is possible to have a raw block for each output format
++without the blocks being duplicated in the output.
++
++The following example shows how SVG code with custom styling can be included into documents
++using the `@raw` block.
++
++````markdown
++```@raw html
++<svg style="display: block; margin: 0 auto;" width="5em" heigth="5em">
++ <circle cx="2.5em" cy="2.5em" r="2em" stroke="black" stroke-width=".1em" fill="red" />
++</svg>
++```
++````
++
++It will show up as follows, with code having been copied over verbatim to the HTML file.
++
++```@raw html
++<svg style="display: block; margin: 0 auto;" width="5em" heigth="5em">
++ <circle cx="2.5em" cy="2.5em" r="2em" stroke="black" stroke-width=".1em" fill="red" />
++ (SVG)
++</svg>
++```
--- /dev/null
--- /dev/null
++# Hidden showcase page
++
++Currently exists just so that there would be doctests to run in manual pages of Documenter's
++manual. This page does not show up in navigation.
++
++```jldoctest
++julia> 2 + 2
++4
++```
++
++The following doctests needs doctestsetup:
++
++```jldoctest; setup=:(using Documenter)
++julia> Documenter.Utilities.splitexpr(:(Foo.Bar.baz))
++(:(Foo.Bar), :(:baz))
++```
++
++Let's also try `@meta` blocks:
++
++```@meta
++DocTestSetup = quote
++ f(x) = x^2
++end
++```
++
++```jldoctest
++julia> f(2)
++4
++```
++
++```@meta
++DocTestSetup = nothing
++```
--- /dev/null
--- /dev/null
++"""
++Defines the [`Anchor`](@ref) and [`AnchorMap`](@ref) types.
++
++`Anchor`s and `AnchorMap`s are used to represent links between objects within a document.
++"""
++module Anchors
++
++using DocStringExtensions
++
++# Types.
++# ------
++
++"""
++Stores an arbitrary object called `.object` and it's location within a document.
++
++**Fields**
++
++- `object` -- the stored object.
++- `order` -- ordering of `object` within the entire document.
++- `file` -- the destination file, in `build`, where the object will be written to.
++- `id` -- the generated "slug" identifying the object.
++- `nth` -- integer that unique-ifies anchors with the same `id`.
++"""
++mutable struct Anchor
++ object :: Any
++ order :: Int
++ file :: String
++ id :: String
++ nth :: Int
++ Anchor(object) = new(object, 0, "", "", 1)
++end
++
++"""
++Tree structure representating anchors in a document and their relationships with eachother.
++
++**Object Hierarchy**
++
++ id -> file -> anchors
++
++Each `id` maps to a `file` which in turn maps to a vector of `Anchor` objects.
++"""
++mutable struct AnchorMap
++ map :: Dict{String, Dict{String, Vector{Anchor}}}
++ count :: Int
++ AnchorMap() = new(Dict(), 0)
++end
++
++# Add anchor.
++# -----------
++
++"""
++$(SIGNATURES)
++
++Adds a new [`Anchor`](@ref) to the [`AnchorMap`](@ref) for a given `id` and `file`.
++
++Either an actual [`Anchor`](@ref) object may be provided or any other object which is
++automatically wrapped in an [`Anchor`](@ref) before being added to the [`AnchorMap`](@ref).
++"""
++function add!(m::AnchorMap, anchor::Anchor, id, file)
++ filemap = get!(m.map, id, Dict{String, Vector{Anchor}}())
++ anchors = get!(filemap, file, Anchor[])
++ push!(anchors, anchor)
++ anchor.order = m.count += 1
++ anchor.file = file
++ anchor.id = id
++ anchor.nth = length(anchors)
++ anchor
++end
++add!(m::AnchorMap, object, id, file) = add!(m, Anchor(object), id, file)
++
++# Anchor existance.
++# -----------------
++
++"""
++$(SIGNATURES)
++
++Does the given `id` exist within the [`AnchorMap`](@ref)? A `file` and integer `n` may also
++be provided to narrow the search for existance.
++"""
++exists(m::AnchorMap, id, file, n) = exists(m, id, file) && 1 ≤ n ≤ length(m.map[id][file])
++exists(m::AnchorMap, id, file) = exists(m, id) && haskey(m.map[id], file)
++exists(m::AnchorMap, id) = haskey(m.map, id)
++
++# Anchor uniqueness.
++# ------------------
++
++"""
++$(SIGNATURES)
++
++Is the `id` unique within the given [`AnchorMap`](@ref)? May also specify the `file`.
++"""
++function isunique(m::AnchorMap, id)
++ exists(m, id) &&
++ length(m.map[id]) === 1 &&
++ isunique(m, id, first(first(m.map[id])))
++end
++function isunique(m::AnchorMap, id, file)
++ exists(m, id, file) &&
++ length(m.map[id][file]) === 1
++end
++
++# Get anchor.
++# -----------
++
++"""
++$(SIGNATURES)
++
++Returns the [`Anchor`](@ref) object matching `id`. `file` and `n` may also be provided. An
++`Anchor` is returned, or `nothing` in case of no match.
++"""
++function anchor(m::AnchorMap, id)
++ isunique(m, id) ?
++ anchor(m, id, first(first(m.map[id])), 1) :
++ nothing
++end
++function anchor(m::AnchorMap, id, file)
++ isunique(m, id, file) ?
++ anchor(m, id, file, 1) :
++ nothing
++end
++function anchor(m::AnchorMap, id, file, n)
++ exists(m, id, file, n) ?
++ m.map[id][file][n] :
++ nothing
++end
++
++end
--- /dev/null
--- /dev/null
++"""
++Defines the `Documenter.jl` build "pipeline" named [`DocumentPipeline`](@ref).
++
++Each stage of the pipeline performs an action on a [`Documents.Document`](@ref) object.
++These actions may involve creating directory structures, expanding templates, running
++doctests, etc.
++"""
++module Builder
++
++import ..Documenter:
++ Anchors,
++ DocTests,
++ Documents,
++ Documenter,
++ Utilities
++
++import .Utilities: Selectors
++
++using DocStringExtensions
++
++# Document Pipeline.
++# ------------------
++
++"""
++The default document processing "pipeline", which consists of the following actions:
++
++- [`SetupBuildDirectory`](@ref)
++- [`Doctest`](@ref)
++- [`ExpandTemplates`](@ref)
++- [`CrossReferences`](@ref)
++- [`CheckDocument`](@ref)
++- [`Populate`](@ref)
++- [`RenderDocument`](@ref)
++
++"""
++abstract type DocumentPipeline <: Selectors.AbstractSelector end
++
++"""
++Creates the correct directory layout within the `build` folder and parses markdown files.
++"""
++abstract type SetupBuildDirectory <: DocumentPipeline end
++
++"""
++Runs all the doctests in all docstrings and Markdown files.
++"""
++abstract type Doctest <: DocumentPipeline end
++
++"""
++Executes a sequence of actions on each node of the parsed markdown files in turn.
++"""
++abstract type ExpandTemplates <: DocumentPipeline end
++
++"""
++Finds and sets URLs for each `@ref` link in the document to the correct destinations.
++"""
++abstract type CrossReferences <: DocumentPipeline end
++
++"""
++Checks that all documented objects are included in the document and runs doctests on all
++valid Julia code blocks.
++"""
++abstract type CheckDocument <: DocumentPipeline end
++
++"""
++Populates the `ContentsNode`s and `IndexNode`s with links.
++"""
++abstract type Populate <: DocumentPipeline end
++
++"""
++Writes the document tree to the `build` directory.
++"""
++abstract type RenderDocument <: DocumentPipeline end
++
++Selectors.order(::Type{SetupBuildDirectory}) = 1.0
++Selectors.order(::Type{Doctest}) = 1.1
++Selectors.order(::Type{ExpandTemplates}) = 2.0
++Selectors.order(::Type{CrossReferences}) = 3.0
++Selectors.order(::Type{CheckDocument}) = 4.0
++Selectors.order(::Type{Populate}) = 5.0
++Selectors.order(::Type{RenderDocument}) = 6.0
++
++Selectors.matcher(::Type{T}, doc::Documents.Document) where {T <: DocumentPipeline} = true
++
++Selectors.strict(::Type{T}) where {T <: DocumentPipeline} = false
++
++function Selectors.runner(::Type{SetupBuildDirectory}, doc::Documents.Document)
++ @info "SetupBuildDirectory: setting up build directory."
++
++ # Frequently used fields.
++ build = doc.user.build
++ source = doc.user.source
++ workdir = doc.user.workdir
++
++
++ # The .user.source directory must exist.
++ isdir(source) || error("source directory '$(abspath(source))' is missing.")
++
++ # We create the .user.build directory.
++ # If .user.clean is set, we first clean the existing directory.
++ doc.user.clean && isdir(build) && rm(build; recursive = true)
++ isdir(build) || mkpath(build)
++
++ # We'll walk over all the files in the .user.source directory.
++ # The directory structure is copied over to .user.build. All files, with
++ # the exception of markdown files (identified by the extension) are copied
++ # over as well, since they're assumed to be images, data files etc.
++ # Markdown files, however, get added to the document and also stored into
++ # `mdpages`, to be used later.
++ mdpages = String[]
++ for (root, dirs, files) in walkdir(source)
++ for dir in dirs
++ d = normpath(joinpath(build, relpath(root, source), dir))
++ isdir(d) || mkdir(d)
++ end
++ for file in files
++ src = normpath(joinpath(root, file))
++ dst = normpath(joinpath(build, relpath(root, source), file))
++
++ if workdir == :build
++ # set working directory to be the same as `build`
++ wd = normpath(joinpath(build, relpath(root, source)))
++ elseif workdir isa Symbol
++ # Maybe allow `:src` and `:root` as well?
++ throw(ArgumentError("Unrecognized working directory option '$workdir'"))
++ else
++ wd = normpath(joinpath(doc.user.root, workdir))
++ end
++
++ if endswith(file, ".md")
++ push!(mdpages, Utilities.srcpath(source, root, file))
++ Documents.addpage!(doc, src, dst, wd)
++ else
++ cp(src, dst; force = true)
++ end
++ end
++ end
++
++ # If the user hasn't specified the page list, then we'll just default to a
++ # flat list of all the markdown files we found, sorted by the filesystem
++ # path (it will group them by subdirectory, among others).
++ userpages = isempty(doc.user.pages) ? sort(mdpages) : doc.user.pages
++
++ # Populating the .navtree and .navlist.
++ # We need the for loop because we can't assign to the fields of the immutable
++ # doc.internal.
++ for navnode in walk_navpages(userpages, nothing, doc)
++ push!(doc.internal.navtree, navnode)
++ end
++
++ # Finally we populate the .next and .prev fields of the navnodes that point
++ # to actual pages.
++ local prev::Union{Documents.NavNode, Nothing} = nothing
++ for navnode in doc.internal.navlist
++ navnode.prev = prev
++ if prev !== nothing
++ prev.next = navnode
++ end
++ prev = navnode
++ end
++end
++
++"""
++$(SIGNATURES)
++
++Recursively walks through the [`Documents.Document`](@ref)'s `.user.pages` field,
++generating [`Documents.NavNode`](@ref)s and related data structures in the
++process.
++
++This implementation is the de facto specification for the `.user.pages` field.
++"""
++function walk_navpages(visible, title, src, children, parent, doc)
++ # parent can also be nothing (for top-level elements)
++ parent_visible = (parent === nothing) || parent.visible
++ if src !== nothing
++ src = normpath(src)
++ src in keys(doc.blueprint.pages) || error("'$src' is not an existing page!")
++ end
++ nn = Documents.NavNode(src, title, parent)
++ (src === nothing) || push!(doc.internal.navlist, nn)
++ nn.visible = parent_visible && visible
++ nn.children = walk_navpages(children, nn, doc)
++ nn
++end
++
++function walk_navpages(hps::Tuple, parent, doc)
++ @assert length(hps) == 4
++ walk_navpages(hps..., parent, doc)
++end
++
++walk_navpages(title::String, children::Vector, parent, doc) = walk_navpages(true, title, nothing, children, parent, doc)
++walk_navpages(title::String, page, parent, doc) = walk_navpages(true, title, page, [], parent, doc)
++
++walk_navpages(p::Pair, parent, doc) = walk_navpages(p.first, p.second, parent, doc)
++walk_navpages(ps::Vector, parent, doc) = [walk_navpages(p, parent, doc)::Documents.NavNode for p in ps]
++walk_navpages(src::String, parent, doc) = walk_navpages(true, nothing, src, [], parent, doc)
++
++
++function Selectors.runner(::Type{Doctest}, doc::Documents.Document)
++ if doc.user.doctest in [:fix, :only, true]
++ @info "Doctest: running doctests."
++ DocTests.doctest(doc.blueprint, doc)
++ num_errors = length(doc.internal.errors)
++ if (doc.user.doctest === :only || doc.user.strict) && num_errors > 0
++ error("`makedocs` encountered $(num_errors > 1 ? "$(num_errors) doctest errors" : "a doctest error"). Terminating build")
++ end
++ else
++ @info "Doctest: skipped."
++ end
++end
++
++function Selectors.runner(::Type{ExpandTemplates}, doc::Documents.Document)
++ is_doctest_only(doc, "ExpandTemplates") && return
++ @info "ExpandTemplates: expanding markdown templates."
++ Documenter.Expanders.expand(doc)
++end
++
++function Selectors.runner(::Type{CrossReferences}, doc::Documents.Document)
++ is_doctest_only(doc, "CrossReferences") && return
++ @info "CrossReferences: building cross-references."
++ Documenter.CrossReferences.crossref(doc)
++end
++
++function Selectors.runner(::Type{CheckDocument}, doc::Documents.Document)
++ is_doctest_only(doc, "CheckDocument") && return
++ @info "CheckDocument: running document checks."
++ Documenter.DocChecks.missingdocs(doc)
++ Documenter.DocChecks.footnotes(doc)
++ Documenter.DocChecks.linkcheck(doc)
++end
++
++function Selectors.runner(::Type{Populate}, doc::Documents.Document)
++ is_doctest_only(doc, "Populate") && return
++ @info "Populate: populating indices."
++ Documents.doctest_replace!(doc)
++ Documents.populate!(doc)
++end
++
++function Selectors.runner(::Type{RenderDocument}, doc::Documents.Document)
++ is_doctest_only(doc, "RenderDocument") && return
++ count = length(doc.internal.errors)
++ if doc.user.strict && count > 0
++ error("`makedocs` encountered $(count > 1 ? "errors" : "an error"). Terminating build")
++ else
++ @info "RenderDocument: rendering document."
++ Documenter.Writers.render(doc)
++ end
++end
++
++Selectors.runner(::Type{DocumentPipeline}, doc::Documents.Document) = nothing
++
++function is_doctest_only(doc, stepname)
++ if doc.user.doctest in [:fix, :only]
++ @info "Skipped $stepname step (doctest only)."
++ return true
++ end
++ return false
++end
++
++end
--- /dev/null
--- /dev/null
++"""
++Provides the [`crossref`](@ref) function used to automatically calculate link URLs.
++"""
++module CrossReferences
++
++import ..Documenter:
++ Anchors,
++ Builder,
++ Documents,
++ Expanders,
++ Documenter,
++ Utilities
++
++using DocStringExtensions
++import Markdown
++
++"""
++$(SIGNATURES)
++
++Traverses a [`Documents.Document`](@ref) and replaces links containg `@ref` URLs with
++their real URLs.
++"""
++function crossref(doc::Documents.Document)
++ for (src, page) in doc.blueprint.pages
++ empty!(page.globals.meta)
++ for element in page.elements
++ crossref(page.mapping[element], page, doc)
++ end
++ end
++end
++
++function crossref(elem, page, doc)
++ Documents.walk(page.globals.meta, elem) do link
++ xref(link, page.globals.meta, page, doc)
++ end
++end
++
++# Dispatch to `namedxref` / `docsxref`.
++# -------------------------------------
++
++const NAMED_XREF = r"^@ref (.+)$"
++
++function xref(link::Markdown.Link, meta, page, doc)
++ link.url == "@ref" ? basicxref(link, meta, page, doc) :
++ occursin(NAMED_XREF, link.url) ? namedxref(link, meta, page, doc) : nothing
++ return false # Stop `walk`ing down this `link` element.
++end
++xref(other, meta, page, doc) = true # Continue to `walk` through element `other`.
++
++function basicxref(link::Markdown.Link, meta, page, doc)
++ if length(link.text) === 1 && isa(link.text[1], Markdown.Code)
++ docsxref(link, link.text[1].code, meta, page, doc)
++ elseif isa(link.text, Vector)
++ # No `name` was provided, since given a `@ref`, so slugify the `.text` instead.
++ text = strip(sprint(Markdown.plain, Markdown.Paragraph(link.text)))
++ if occursin(r"#[0-9]+", text)
++ issue_xref(link, lstrip(text, '#'), meta, page, doc)
++ else
++ name = Utilities.slugify(text)
++ namedxref(link, name, meta, page, doc)
++ end
++ end
++end
++
++# Cross referencing headers.
++# --------------------------
++
++function namedxref(link::Markdown.Link, meta, page, doc)
++ # Extract the `name` from the `(@ref ...)`.
++ slug = match(NAMED_XREF, link.url)[1]
++ if isempty(slug)
++ text = sprint(Markdown.plaininline, link)
++ push!(doc.internal.errors, :cross_references)
++ @warn "'$text' missing a name after '#' in $(Utilities.locrepr(page.source))."
++ else
++ if Anchors.exists(doc.internal.headers, slug)
++ namedxref(link, slug, meta, page, doc)
++ elseif length(link.text) === 1 && isa(link.text[1], Markdown.Code)
++ docsxref(link, slug, meta, page, doc)
++ else
++ namedxref(link, slug, meta, page, doc)
++ end
++ end
++end
++
++function namedxref(link::Markdown.Link, slug, meta, page, doc)
++ headers = doc.internal.headers
++ # Add the link to list of local uncheck links.
++ doc.internal.locallinks[link] = link.url
++ # Error checking: `slug` should exist and be unique.
++ # TODO: handle non-unique slugs.
++ if Anchors.exists(headers, slug)
++ if Anchors.isunique(headers, slug)
++ # Replace the `@ref` url with a path to the referenced header.
++ anchor = Anchors.anchor(headers, slug)
++ path = relpath(anchor.file, dirname(page.build))
++ link.url = string(path, '#', slug, '-', anchor.nth)
++ else
++ push!(doc.internal.errors, :cross_references)
++ @warn "'$slug' is not unique in $(Utilities.locrepr(page.source))."
++ end
++ else
++ push!(doc.internal.errors, :cross_references)
++ @warn "reference for '$slug' could not be found in $(Utilities.locrepr(page.source))."
++ end
++end
++
++# Cross referencing docstrings.
++# -----------------------------
++
++function docsxref(link::Markdown.Link, code, meta, page, doc)
++ # Add the link to list of local uncheck links.
++ doc.internal.locallinks[link] = link.url
++ # Parse the link text and find current module.
++ keyword = Symbol(strip(code))
++ local ex
++ if haskey(Docs.keywords, keyword)
++ ex = QuoteNode(keyword)
++ else
++ try
++ ex = Meta.parse(code)
++ catch err
++ !isa(err, Meta.ParseError) && rethrow(err)
++ push!(doc.internal.errors, :cross_references)
++ @warn "unable to parse the reference '[`$code`](@ref)' in $(Utilities.locrepr(page.source))."
++ return
++ end
++ end
++ mod = get(meta, :CurrentModule, Main)
++
++ # Find binding and type signature associated with the link.
++ local binding
++ try
++ binding = Documenter.DocSystem.binding(mod, ex)
++ catch err
++ push!(doc.internal.errors, :cross_references)
++ @warn "unable to get the binding for '[`$code`](@ref)' in $(Utilities.locrepr(page.source)) from expression '$(repr(ex))' in module $(mod)" exception = err
++ return
++ end
++
++ local typesig
++ try
++ typesig = Core.eval(mod, Documenter.DocSystem.signature(ex, rstrip(code)))
++ catch err
++ push!(doc.internal.errors, :cross_references)
++ @warn "unable to evaluate the type signature for '[`$code`](@ref)' in $(Utilities.locrepr(page.source)) from expression '$(repr(ex))' in module $(mod)" exception = err
++ return
++ end
++
++ # Try to find a valid object that we can cross-reference.
++ object = find_object(doc, binding, typesig)
++ if object !== nothing
++ # Replace the `@ref` url with a path to the referenced docs.
++ docsnode = doc.internal.objects[object]
++ path = relpath(docsnode.page.build, dirname(page.build))
++ slug = Utilities.slugify(object)
++ link.url = string(path, '#', slug)
++ else
++ push!(doc.internal.errors, :cross_references)
++ @warn "no doc found for reference '[`$code`](@ref)' in $(Utilities.locrepr(page.source))."
++ end
++end
++
++"""
++$(SIGNATURES)
++
++Find the included `Object` in the `doc` matching `binding` and `typesig`. The matching
++heuristic isn't too picky about what matches and will only fail when no `Binding`s matching
++`binding` have been included.
++"""
++function find_object(doc::Documents.Document, binding, typesig)
++ object = Utilities.Object(binding, typesig)
++ if haskey(doc.internal.objects, object)
++ # Exact object matching the requested one.
++ return object
++ else
++ objects = get(doc.internal.bindings, binding, Utilities.Object[])
++ if isempty(objects)
++ # No bindings match the requested object == FAILED.
++ return nothing
++ elseif length(objects) == 1
++ # Only one possible choice. Use it even if the signature doesn't match.
++ return objects[1]
++ else
++ candidate = find_object(binding, typesig)
++ if candidate in objects
++ # We've found an actual match out of the possible choices! Use it.
++ return candidate
++ else
++ # No match in the possible choices. Use the one that was first included.
++ return objects[1]
++ end
++ end
++ end
++end
++function find_object(binding, typesig)
++ if Documenter.DocSystem.defined(binding)
++ local λ = Documenter.DocSystem.resolve(binding)
++ return find_object(λ, binding, typesig)
++ else
++ return Utilities.Object(binding, typesig)
++ end
++end
++function find_object(λ::Union{Function, DataType}, binding, typesig)
++ if hasmethod(λ, typesig)
++ signature = getsig(λ, typesig)
++ return Utilities.Object(binding, signature)
++ else
++ return Utilities.Object(binding, typesig)
++ end
++end
++find_object(::Union{Function, DataType}, binding, ::Union{Union,Type{Union{}}}) = Utilities.Object(binding, Union{})
++find_object(other, binding, typesig) = Utilities.Object(binding, typesig)
++
++getsig(λ::Union{Function, DataType}, typesig) = Base.tuple_type_tail(which(λ, typesig).sig)
++
++
++# Issues/PRs cross referencing.
++# -----------------------------
++
++function issue_xref(link::Markdown.Link, num, meta, page, doc)
++ link.url = isempty(doc.internal.remote) ? link.url :
++ "https://github.com/$(doc.internal.remote)/issues/$num"
++end
++
++end
--- /dev/null
--- /dev/null
++"""
++Exported module that provides build and deploy dependencies and related functions.
++
++Currently only [`pip`](@ref) is implemented.
++"""
++module Deps
++
++export pip
++
++using DocStringExtensions
++
++"""
++$(SIGNATURES)
++
++Installs (as non-root user) all python packages listed in `deps`.
++
++# Examples
++
++```julia
++using Documenter
++
++makedocs(
++ # ...
++)
++
++deploydocs(
++ deps = Deps.pip("pygments", "mkdocs", "mkdocs-material"),
++ # ...
++)
++```
++"""
++function pip(deps...)
++ for dep in deps
++ run(`pip install --user $(dep)`)
++ end
++end
++
++
++function localbin()
++ Sys.islinux() ? joinpath(homedir(), ".local", "bin") :
++ Sys.isapple() ? joinpath(homedir(), "Library", "Python", "2.7", "bin") : ""
++end
++
++function updatepath!(p = localbin())
++ if occursin(p, ENV["PATH"])
++ ENV["PATH"]
++ else
++ ENV["PATH"] = "$p:$(ENV["PATH"])"
++ end
++end
++
++end
--- /dev/null
--- /dev/null
++"""
++Provides the [`missingdocs`](@ref), [`footnotes`](@ref) and [`linkcheck`](@ref) functions
++for checking docs.
++"""
++module DocChecks
++
++import ..Documenter:
++ Documenter,
++ Documents,
++ Utilities,
++ Utilities.Markdown2
++
++using DocStringExtensions
++import Markdown
++
++# Missing docstrings.
++# -------------------
++
++"""
++$(SIGNATURES)
++
++Checks that a [`Documents.Document`](@ref) contains all available docstrings that are
++defined in the `modules` keyword passed to [`Documenter.makedocs`](@ref).
++
++Prints out the name of each object that has not had its docs spliced into the document.
++"""
++function missingdocs(doc::Documents.Document)
++ doc.user.checkdocs === :none && return
++ @debug "checking for missing docstrings."
++ bindings = allbindings(doc.user.checkdocs, doc.blueprint.modules)
++ for object in keys(doc.internal.objects)
++ # The module references in docs blocks can yield a binding like
++ # Docs.Binding(Mod, :SubMod) for a module SubMod, a submodule of Mod. However, the
++ # module bindings that come from Docs.meta() always appear to be of the form
++ # Docs.Binding(Mod.SubMod, :SubMod) (since Julia 0.7). We therefore "normalize"
++ # module bindings before we search in the list returned by allbindings().
++ binding = if Documenter.DocSystem.defined(object.binding) && !Documenter.DocSystem.iskeyword(object.binding)
++ m = Documenter.DocSystem.resolve(object.binding)
++ isa(m, Module) && nameof(object.binding.mod) != object.binding.var ?
++ Docs.Binding(m, nameof(m)) : object.binding
++ else
++ object.binding
++ end
++ if haskey(bindings, binding)
++ signatures = bindings[binding]
++ if object.signature ≡ Union{} || length(signatures) ≡ 1
++ delete!(bindings, binding)
++ elseif object.signature in signatures
++ delete!(signatures, object.signature)
++ end
++ end
++ end
++ n = reduce(+, map(length, values(bindings)), init=0)
++ if n > 0
++ b = IOBuffer()
++ println(b, "$n docstring$(n ≡ 1 ? "" : "s") potentially missing:\n")
++ for (binding, signatures) in bindings
++ for sig in signatures
++ println(b, " $binding", sig ≡ Union{} ? "" : " :: $sig")
++ end
++ end
++ push!(doc.internal.errors, :missing_docs)
++ @warn String(take!(b))
++ end
++end
++
++function allbindings(checkdocs::Symbol, mods)
++ out = Dict{Utilities.Binding, Set{Type}}()
++ for m in mods
++ allbindings(checkdocs, m, out)
++ end
++ out
++end
++
++function allbindings(checkdocs::Symbol, mod::Module, out = Dict{Utilities.Binding, Set{Type}}())
++ for (obj, doc) in meta(mod)
++ isa(obj, IdDict{Any,Any}) && continue
++ name = nameof(obj)
++ isexported = Base.isexported(mod, name)
++ if checkdocs === :all || (isexported && checkdocs === :exports)
++ out[Utilities.Binding(mod, name)] = Set(sigs(doc))
++ end
++ end
++ out
++end
++
++meta(m) = Docs.meta(m)
++
++nameof(b::Base.Docs.Binding) = b.var
++nameof(x) = Base.nameof(x)
++
++sigs(x::Base.Docs.MultiDoc) = x.order
++sigs(::Any) = Type[Union{}]
++
++
++# Footnote checks.
++# ----------------
++"""
++$(SIGNATURES)
++
++Checks footnote links in a [`Documents.Document`](@ref).
++"""
++function footnotes(doc::Documents.Document)
++ @debug "checking footnote links."
++ # A mapping of footnote ids to a tuple counter of how many footnote references and
++ # footnote bodies have been found.
++ #
++ # For all ids the final result should be `(N, 1)` where `N > 1`, i.e. one or more
++ # footnote references and a single footnote body.
++ footnotes = Dict{Documents.Page, Dict{String, Tuple{Int, Int}}}()
++ for (src, page) in doc.blueprint.pages
++ empty!(page.globals.meta)
++ orphans = Dict{String, Tuple{Int, Int}}()
++ for element in page.elements
++ Documents.walk(page.globals.meta, page.mapping[element]) do block
++ footnote(block, orphans)
++ end
++ end
++ footnotes[page] = orphans
++ end
++ for (page, orphans) in footnotes
++ for (id, (ids, bodies)) in orphans
++ # Multiple footnote bodies.
++ if bodies > 1
++ push!(doc.internal.errors, :footnote)
++ @warn "footnote '$id' has $bodies bodies in $(Utilities.locrepr(page.source))."
++ end
++ # No footnote references for an id.
++ if ids === 0
++ push!(doc.internal.errors, :footnote)
++ @warn "unused footnote named '$id' in $(Utilities.locrepr(page.source))."
++ end
++ # No footnote bodies for an id.
++ if bodies === 0
++ push!(doc.internal.errors, :footnote)
++ @warn "no footnotes found for '$id' in $(Utilities.locrepr(page.source))."
++ end
++ end
++ end
++end
++
++function footnote(fn::Markdown.Footnote, orphans::Dict)
++ ids, bodies = get(orphans, fn.id, (0, 0))
++ if fn.text === nothing
++ # Footnote references: syntax `[^1]`.
++ orphans[fn.id] = (ids + 1, bodies)
++ return false # No more footnotes inside footnote references.
++ else
++ # Footnote body: syntax `[^1]:`.
++ orphans[fn.id] = (ids, bodies + 1)
++ return true # Might be footnotes inside footnote bodies.
++ end
++end
++
++footnote(other, orphans::Dict) = true
++
++# Link Checks.
++# ------------
++
++hascurl() = (try; success(`curl --version`); catch err; false; end)
++
++"""
++$(SIGNATURES)
++
++Checks external links using curl.
++"""
++function linkcheck(doc::Documents.Document)
++ if doc.user.linkcheck
++ if hascurl()
++ for (src, page) in doc.blueprint.pages
++ for element in page.elements
++ Documents.walk(page.globals.meta, page.mapping[element]) do block
++ linkcheck(block, doc)
++ end
++ end
++ end
++ else
++ push!(doc.internal.errors, :linkcheck)
++ @warn "linkcheck requires `curl`."
++ end
++ end
++ return nothing
++end
++
++function linkcheck(link::Markdown.Link, doc::Documents.Document; method::Symbol=:HEAD)
++
++ # first, make sure we're not supposed to ignore this link
++ for r in doc.user.linkcheck_ignore
++ if linkcheck_ismatch(r, link.url)
++ @debug "linkcheck '$(link.url)': ignored."
++ return false
++ end
++ end
++
++ if !haskey(doc.internal.locallinks, link)
++ null_file = @static Sys.iswindows() ? "nul" : "/dev/null"
++ cmd = `curl $(method === :HEAD ? "-sI" : "-s") --proto =http,https,ftp,ftps $(link.url) --max-time 10 -o $null_file --write-out "%{http_code} %{url_effective} %{redirect_url}"`
++
++ local result
++ try
++ # interpolating into backticks escapes spaces so constructing a Cmd is necessary
++ result = read(cmd, String)
++ catch err
++ push!(doc.internal.errors, :linkcheck)
++ @warn "$cmd failed:" exception = err
++ return false
++ end
++ STATUS_REGEX = r"^(\d+) (\w+)://(?:\S+) (\S+)?$"m
++ matched = match(STATUS_REGEX, result)
++ if matched !== nothing
++ status, scheme, location = matched.captures
++ status = parse(Int, status)
++ scheme = uppercase(scheme)
++ protocol = startswith(scheme, "HTTP") ? :HTTP :
++ startswith(scheme, "FTP") ? :FTP : :UNKNOWN
++
++ if (protocol === :HTTP && status < 300) ||
++ (protocol === :FTP && (200 <= status < 300 || status == 350))
++ @debug "linkcheck '$(link.url)' status: $(status)."
++ elseif protocol === :HTTP && status < 400
++ if location !== nothing
++ @warn "linkcheck '$(link.url)' status: $(status), redirects to $(location)."
++ else
++ @warn "linkcheck '$(link.url)' status: $(status)."
++ end
++ elseif protocol === :HTTP && status == 405 && method === :HEAD
++ # when a server doesn't support HEAD requests, fallback to GET
++ @debug "linkcheck '$(link.url)' status: $(status), retrying without `-I`"
++ return linkcheck(link, doc; method=:GET)
++ else
++ push!(doc.internal.errors, :linkcheck)
++ @error "linkcheck '$(link.url)' status: $(status)."
++ end
++ else
++ push!(doc.internal.errors, :linkcheck)
++ @warn "invalid result returned by $cmd:" result
++ end
++ end
++ return false
++end
++linkcheck(other, doc::Documents.Document) = true
++
++linkcheck_ismatch(r::String, url) = (url == r)
++linkcheck_ismatch(r::Regex, url) = occursin(r, url)
++
++end
--- /dev/null
--- /dev/null
++"""
++This module provides APIs for handling documentation metadata in modules.
++
++The implementation is similar to how docstrings are handled in `Base` by the `Base.Docs`
++module — a special variable is created in each module that has documentation metadata.
++
++# Public API
++
++* [`DocMeta.getdocmeta`](@ref)
++* [`DocMeta.setdocmeta!`](@ref)
++
++# Supported metadata
++
++* `DocTestSetup`: contains the doctest setup code for doctests in the module.
++"""
++module DocMeta
++using ..Documenter: Utilities
++using DocStringExtensions
++
++"The unique `Symbol` that is used to store the metadata dictionary in each module."
++const META = gensym(:docmeta)
++
++"List of modules that have the metadata dictionary added."
++const METAMODULES = Module[]
++
++"Type of the metadata dictionary."
++const METATYPE = Dict{Symbol,Any}
++
++"Dictionary of all valid metadata keys and their types."
++const VALIDMETA = Dict{Symbol,Type}(:DocTestSetup => Union{Expr,Symbol})
++
++"""
++"""
++function initdocmeta!(m::Module)
++ if !isdefined(m, META)
++ @debug "Creating documentation metadata dictionary (META=$META) in $m"
++ Core.eval(m, :(const $META = $(METATYPE())))
++ push!(METAMODULES, m)
++ else
++ @warn "Existing documentation metadata dictionary (META=$META) in $m. Ignoring."
++ end
++ return getfield(m, META)
++end
++
++"""
++ getdocmeta(m::Module)
++
++Returns the documentation metadata dictionary for the module `m`. The dictionary should be
++considered immutable and assigning values to it is not well-defined. To set documentation
++metadata values, [`DocMeta.setdocmeta!`](@ref) should be used instead.
++"""
++getdocmeta(m::Module) = isdefined(m, META) ? getfield(m, META) : METATYPE()
++
++"""
++ getdocmeta(m::Module, key::Symbol, default=nothing)
++
++Return the `key` entry from the documentation metadata for module `m`, or `default` if the
++value is unset.
++"""
++getdocmeta(m::Module, key::Symbol, default=nothing) = get(getdocmeta(m), key, default)
++
++"""
++ setdocmeta!(m::Module, key::Symbol, value; recursive=false, warn=true)
++
++Set the documentation metadata value `key` for module `m` to `value`.
++
++If `recursive` is set to `true`, it sets the same metadata value for all the submodules too.
++If `warn` is `true`, it prints a warning when `key` already exists and is gets rewritten.
++"""
++function setdocmeta!(m::Module, key::Symbol, value; warn=true, recursive=false)
++ key in keys(VALIDMETA) || throw(ArgumentError("Invalid metadata key\nValid keys are: $(join(keys(VALIDMETA), ", "))"))
++ isa(value, VALIDMETA[key]) || throw(ArgumentError("Bad value type ($(typeof(value))) for metadata key $(key). Must be <: $(VALIDMETA[key])"))
++ if recursive
++ for mod in Utilities.submodules(m)
++ setdocmeta!(mod, key, value; warn=warn, recursive=false)
++ end
++ else
++ isdefined(m, META) || initdocmeta!(m)
++ meta = getdocmeta(m)
++ if warn && haskey(meta, key)
++ @warn "$(key) already set for module $m. Overwriting."
++ end
++ meta[key] = value
++ end
++ return nothing
++end
++
++end
--- /dev/null
--- /dev/null
++"""
++Provides a consistent interface to retreiving `DocStr` objects from the Julia
++docsystem in both `0.4` and `0.5`.
++"""
++module DocSystem
++
++using DocStringExtensions
++import Markdown
++import Base.Docs: MultiDoc, parsedoc, formatdoc, DocStr
++
++## Bindings ##
++
++"""
++Converts an object to a `Base.Docs.Binding` object.
++
++$(SIGNATURES)
++
++Supported inputs are:
++
++- `Binding`
++- `DataType`
++- `Function`
++- `Module`
++- `Symbol`
++
++Note that unsupported objects will throw an `ArgumentError`.
++"""
++binding(any::Any) = throw(ArgumentError("cannot convert `$(repr(any))` to a `Binding`."))
++
++#
++# The simple definitions.
++#
++binding(b::Docs.Binding) = binding(b.mod, b.var)
++binding(d::DataType) = binding(d.name.module, d.name.name)
++binding(m::Module) = binding(m, nameof(m))
++binding(s::Symbol) = binding(Main, s)
++binding(f::Function) = binding(typeof(f).name.module, typeof(f).name.mt.name)
++
++#
++# We need a lookup table for `IntrinsicFunction`s since they do not track their
++# own name and defining module.
++#
++# Note that `IntrinsicFunction` is exported from `Base` in `0.4`, but not in `0.5`.
++#
++let INTRINSICS = Dict(map(s -> getfield(Core.Intrinsics, s) => s, names(Core.Intrinsics, all=true)))
++ global binding(i::Core.IntrinsicFunction) = binding(Core.Intrinsics, INTRINSICS[i]::Symbol)
++end
++
++#
++# Normalise the parent module.
++#
++# This is done within the `Binding` constructor on `0.5`, but not on `0.4`.
++#
++function binding(m::Module, v::Symbol)
++ m = nameof(m) === v ? parentmodule(m) : m
++ Docs.Binding(m, v)
++end
++
++#
++# Pseudo-eval of `Expr`s to find their equivalent `Binding`.
++#
++binding(m::Module, x::Expr) =
++ Meta.isexpr(x, :.) ? binding(getmod(m, x.args[1]), x.args[2].value) :
++ Meta.isexpr(x, [:call, :macrocall, :curly]) ? binding(m, x.args[1]) :
++ Meta.isexpr(x, :where) ? binding(m, x.args[1].args[1]) :
++ error("`binding` cannot understand expression `$x`.")
++
++# Helper methods for the above `binding` method.
++getmod(m::Module, x::Expr) = getfield(getmod(m, x.args[1]), x.args[2].value)
++getmod(m::Module, s::Symbol) = getfield(m, s)
++
++binding(m::Module, q::QuoteNode) = binding(Main, q.value)
++
++binding(m::Module, λ::Any) = binding(λ)
++
++## Signatures. ##
++
++function signature(x, str::AbstractString)
++ ts = Base.Docs.signature(x)
++ (Meta.isexpr(x, :macrocall, 2) && !endswith(strip(str), "()")) ? :(Union{}) : ts
++end
++
++## Docstring containers. ##
++
++
++"""
++Construct a `MultiDoc` object from the provided argument.
++
++Valid inputs are:
++
++- `Markdown.MD`
++- `Docs.FuncDoc`
++- `Docs.TypeDoc`
++
++"""
++function multidoc end
++
++function multidoc(markdown::Markdown.MD)
++ md = MultiDoc()
++ sig = Union{}
++ push!(md.order, sig)
++ md.docs[sig] = docstr(markdown)
++ md
++end
++
++
++
++"""
++$(SIGNATURES)
++
++Construct a `DocStr` object from a `Markdown.MD` object.
++
++The optional keyword arguments are used to add new data to the `DocStr`'s
++`.data` dictionary.
++"""
++function docstr(md::Markdown.MD; kws...)
++ data = Dict{Symbol, Any}(
++ :path => md.meta[:path],
++ :module => md.meta[:module],
++ :linenumber => 0,
++ )
++ doc = DocStr(Core.svec(), md, data)
++ for (key, value) in kws
++ doc.data[key] = value
++ end
++ doc
++end
++docstr(other) = other
++
++
++## Formatting `DocStr`s. ##
++
++
++
++
++## Converting docstring caches. ##
++
++"""
++$(SIGNATURES)
++
++Converts a `0.4`-style docstring cache into a `0.5` one.
++
++The original docstring cache is not modified.
++"""
++function convertmeta(meta::IdDict{Any,Any})
++ if !haskey(CACHED, meta)
++ docs = IdDict{Any,Any}()
++ for (k, v) in meta
++ if !isa(k, Union{Number, AbstractString, IdDict{Any,Any}})
++ docs[binding(k)] = multidoc(v)
++ end
++ end
++ CACHED[meta] = docs
++ end
++ CACHED[meta]::IdDict{Any,Any}
++end
++const CACHED = IdDict{Any,Any}()
++
++
++## Get docs from modules.
++
++"""
++$(SIGNATURES)
++
++Find all `DocStr` objects that match the provided arguments:
++
++- `binding`: the name of the object.
++- `typesig`: the signature of the object. Default: `Union{}`.
++- `compare`: how to compare signatures? Exact (`==`) or subtypes (`<:`). Default: `<:`.
++- `modules`: which modules to search through. Default: *all modules*.
++- `aliases`: check aliases of `binding` when nothing is found. Default: `true`.
++
++Returns a `Vector{DocStr}` ordered by definition order in `0.5` and by
++`type_morespecific` in `0.4`.
++"""
++function getdocs(
++ binding::Docs.Binding,
++ typesig::Type = Union{};
++ compare = (==),
++ modules = Docs.modules,
++ aliases = true,
++ )
++ # Fall back to searching all modules if user provides no modules.
++ modules = isempty(modules) ? Docs.modules : modules
++ # Keywords are special-cased within the docsystem. Handle those first.
++ iskeyword(binding) && return [docstr(Base.Docs.keywords[binding.var])]
++ # Handle all the other possible bindings.
++ results = DocStr[]
++ for mod in modules
++ meta = getmeta(mod)
++ if haskey(meta, binding)
++ multidoc = meta[binding]::MultiDoc
++ for signature in multidoc.order
++ if compare(typesig, signature)
++ doc = multidoc.docs[signature]
++ doc.data[:binding] = binding
++ doc.data[:typesig] = signature
++ push!(results, doc)
++ end
++ end
++ end
++ end
++ if compare == (==)
++ # Exact matching of signatures:
++ #
++ # When we get a single match from using `==` as the comparision then we just return
++ # that one result.
++ #
++ # Otherwise we fallback to comparing signatures using `<:` to match, hopefully, a
++ # wider range of possible docstrings.
++ if length(results) == 1
++ results
++ else
++ getdocs(binding, typesig; compare = (<:), modules = modules, aliases = aliases)
++ end
++ else
++ # When nothing is found we check whether the `binding` is an alias of some other
++ # `Binding`. If so then we redo the search using that `Binding` instead.
++ if aliases && isempty(results) && (b = aliasof(binding)) != binding
++ getdocs(b, typesig; compare = compare, modules = modules)
++ else
++ results
++ end
++ end
++end
++
++"""
++$(SIGNATURES)
++
++Accepts objects of any type and tries to convert them to `Binding`s before
++searching for the `Binding` in the docsystem.
++
++Note that when conversion fails this method returns an empty `Vector{DocStr}`.
++"""
++function getdocs(object::Any, typesig::Type = Union{}; kws...)
++ binding = aliasof(object, object)
++ binding === object ? DocStr[] : getdocs(binding, typesig; kws...)
++end
++
++#
++# Helper methods used by the `getdocs` function above.
++#
++
++getmeta(m::Module) = Docs.meta(m)
++
++import Base.Docs: aliasof, resolve, defined
++
++
++aliasof(s::Symbol, b) = binding(s)
++
++iskeyword(b::Docs.Binding) = b.mod === Main && haskey(Base.Docs.keywords, b.var)
++ismacro(b::Docs.Binding) = startswith(string(b.var), '@')
++
++
++function category(b::Docs.Binding)
++ if iskeyword(b)
++ :keyword
++ elseif ismacro(b)
++ :macro
++ else
++ category(resolve(b))
++ end
++end
++category(::Function) = :function
++category(::DataType) = :type
++category(x::UnionAll) = category(Base.unwrap_unionall(x))
++category(::Module) = :module
++category(::Any) = :constant
++
++end
--- /dev/null
--- /dev/null
++"""
++Provides the [`doctest`](@ref) function that makes sure that the `jldoctest` code blocks
++in the documents and docstrings run and are up to date.
++"""
++module DocTests
++using DocStringExtensions
++
++import ..Documenter:
++ DocSystem,
++ DocMeta,
++ Documenter,
++ Documents,
++ Expanders,
++ Utilities,
++ IdDict
++
++import Markdown, REPL
++import .Utilities: Markdown2
++
++# Julia code block testing.
++# -------------------------
++
++mutable struct MutableMD2CodeBlock
++ language :: String
++ code :: String
++end
++MutableMD2CodeBlock(block :: Markdown2.CodeBlock) = MutableMD2CodeBlock(block.language, block.code)
++
++struct DocTestContext
++ file :: String
++ doc :: Documents.Document
++ meta :: Dict{Symbol, Any}
++ DocTestContext(file::String, doc::Documents.Document) = new(file, doc, Dict())
++end
++
++"""
++$(SIGNATURES)
++
++Traverses the pages and modules in the documenter blueprint, searching and
++executing doctests.
++
++Will abort the document generation when an error is thrown. Use `doctest = false`
++keyword in [`Documenter.makedocs`](@ref) to disable doctesting.
++"""
++function doctest(blueprint::Documents.DocumentBlueprint, doc::Documents.Document)
++ @debug "Running doctests."
++ # find all the doctest blocks in the pages
++ for (src, page) in blueprint.pages
++ doctest(page, doc)
++ end
++
++ # find all the doctest block in all the docstrings (within specified modules)
++ for mod in blueprint.modules
++ for (binding, multidoc) in DocSystem.getmeta(mod)
++ for signature in multidoc.order
++ doctest(multidoc.docs[signature], mod, doc)
++ end
++ end
++ end
++end
++
++function doctest(page::Documents.Page, doc::Documents.Document)
++ ctx = DocTestContext(page.source, doc) # FIXME
++ ctx.meta[:CurrentFile] = page.source
++ doctest(ctx, page.md2ast)
++end
++
++function doctest(docstr::Docs.DocStr, mod::Module, doc::Documents.Document)
++ md = DocSystem.parsedoc(docstr)
++ # Note: parsedocs / formatdoc in Base is weird. It double-wraps the docstring Markdown
++ # in a Markdown.MD object..
++ @assert isa(md, Markdown.MD) # relying on Julia internals here
++ if length(md.content) == 1 && isa(first(md.content), Markdown.MD)
++ md = first(md.content)
++ end
++ md2ast = Markdown2.convert(Markdown2.MD, md)
++ ctx = DocTestContext(docstr.data[:path], doc)
++ merge!(ctx.meta, DocMeta.getdocmeta(mod))
++ ctx.meta[:CurrentFile] = get(docstr.data, :path, nothing)
++ doctest(ctx, md2ast)
++end
++
++function parse_metablock(ctx::DocTestContext, block::Markdown2.CodeBlock)
++ @assert startswith(block.language, "@meta")
++ meta = Dict{Symbol, Any}()
++ for (ex, str) in Utilities.parseblock(block.code, ctx.doc, ctx.file)
++ if Utilities.isassign(ex)
++ try
++ meta[ex.args[1]] = Core.eval(Main, ex.args[2])
++ catch err
++ push!(ctx.doc.internal.errors, :meta_block)
++ @warn "Failed to evaluate `$(strip(str))` in `@meta` block." err
++ end
++ end
++ end
++ return meta
++end
++
++function doctest(ctx::DocTestContext, md2ast::Markdown2.MD)
++ Markdown2.walk(md2ast) do node
++ isa(node, Markdown2.CodeBlock) || return true
++ if startswith(node.language, "jldoctest")
++ doctest(ctx, node)
++ elseif startswith(node.language, "@meta")
++ merge!(ctx.meta, parse_metablock(ctx, node))
++ else
++ return true
++ end
++ return false
++ end
++end
++
++function doctest(ctx::DocTestContext, block_immutable::Markdown2.CodeBlock)
++ lang = block_immutable.language
++ if startswith(lang, "jldoctest")
++ # Define new module or reuse an old one from this page if we have a named doctest.
++ name = match(r"jldoctest[ ]?(.*)$", split(lang, ';', limit = 2)[1])[1]
++ sym = isempty(name) ? gensym("doctest-") : Symbol("doctest-", name)
++ sandbox = get!(() -> Expanders.get_new_sandbox(sym), ctx.meta, sym)
++
++ # Normalise line endings.
++ block = MutableMD2CodeBlock(block_immutable)
++ block.code = replace(block.code, "\r\n" => "\n")
++
++ # parse keyword arguments to doctest
++ d = Dict()
++ idx = findfirst(c -> c == ';', lang)
++ if idx !== nothing
++ kwargs = Meta.parse("($(lang[nextind(lang, idx):end]),)")
++ for kwarg in kwargs.args
++ if !(isa(kwarg, Expr) && kwarg.head === :(=) && isa(kwarg.args[1], Symbol))
++ file = ctx.meta[:CurrentFile]
++ lines = Utilities.find_block_in_file(block.code, file)
++ @warn("""
++ invalid syntax for doctest keyword arguments in $(Utilities.locrepr(file, lines))
++ Use ```jldoctest name; key1 = value1, key2 = value2
++
++ ```$(lang)
++ $(block.code)
++ ```
++ """)
++ return false
++ end
++ d[kwarg.args[1]] = Core.eval(sandbox, kwarg.args[2])
++ end
++ end
++ ctx.meta[:LocalDocTestArguments] = d
++
++ for expr in [get(ctx.meta, :DocTestSetup, []); get(ctx.meta[:LocalDocTestArguments], :setup, [])]
++ Meta.isexpr(expr, :block) && (expr.head = :toplevel)
++ try
++ Core.eval(sandbox, expr)
++ catch e
++ push!(ctx.doc.internal.errors, :doctest)
++ @error("could not evaluate expression from doctest setup.",
++ expression = expr, exception = e)
++ return false
++ end
++ end
++ if occursin(r"^julia> "m, block.code)
++ eval_repl(block, sandbox, ctx.meta, ctx.doc, ctx.file)
++ elseif occursin(r"^# output$"m, block.code)
++ eval_script(block, sandbox, ctx.meta, ctx.doc, ctx.file)
++ else
++ push!(ctx.doc.internal.errors, :doctest)
++ file = ctx.meta[:CurrentFile]
++ lines = Utilities.find_block_in_file(block.code, file)
++ @warn("""
++ invalid doctest block in $(Utilities.locrepr(file, lines))
++ Requires `julia> ` or `# output`
++
++ ```$(lang)
++ $(block.code)
++ ```
++ """)
++ end
++ delete!(ctx.meta, :LocalDocTestArguments)
++ end
++ false
++end
++doctest(ctx::DocTestContext, block) = true
++
++# Doctest evaluation.
++
++mutable struct Result
++ block :: MutableMD2CodeBlock # The entire code block that is being tested.
++ input :: String # Part of `block.code` representing the current input.
++ output :: String # Part of `block.code` representing the current expected output.
++ file :: String # File in which the doctest is written. Either `.md` or `.jl`.
++ value :: Any # The value returned when evaluating `input`.
++ hide :: Bool # Semi-colon suppressing the output?
++ stdout :: IOBuffer # Redirected stdout/stderr gets sent here.
++ bt :: Vector # Backtrace when an error is thrown.
++
++ function Result(block, input, output, file)
++ new(block, input, rstrip(output, '\n'), file, nothing, false, IOBuffer())
++ end
++end
++
++function eval_repl(block, sandbox, meta::Dict, doc::Documents.Document, page)
++ for (input, output) in repl_splitter(block.code)
++ result = Result(block, input, output, meta[:CurrentFile])
++ for (ex, str) in Utilities.parseblock(input, doc, page; keywords = false, raise=false)
++ # Input containing a semi-colon gets suppressed in the final output.
++ result.hide = REPL.ends_with_semicolon(str)
++ (value, success, backtrace, text) = Utilities.withoutput() do
++ Core.eval(sandbox, ex)
++ end
++ Core.eval(sandbox, Expr(:global, Expr(:(=), :ans, QuoteNode(value))))
++ result.value = value
++ print(result.stdout, text)
++ if !success
++ result.bt = backtrace
++ end
++ # don't evaluate further if there is a parse error
++ isa(ex, Expr) && ex.head === :error && break
++ end
++ checkresult(sandbox, result, meta, doc)
++ end
++end
++
++function eval_script(block, sandbox, meta::Dict, doc::Documents.Document, page)
++ # TODO: decide whether to keep `# output` syntax for this. It's a bit ugly.
++ # Maybe use double blank lines, i.e.
++ #
++ #
++ # to mark `input`/`output` separation.
++ input, output = split(block.code, "# output\n", limit = 2)
++ input = rstrip(input, '\n')
++ output = lstrip(output, '\n')
++ result = Result(block, input, output, meta[:CurrentFile])
++ for (ex, str) in Utilities.parseblock(input, doc, page; keywords = false, raise=false)
++ (value, success, backtrace, text) = Utilities.withoutput() do
++ Core.eval(sandbox, ex)
++ end
++ result.value = value
++ print(result.stdout, text)
++ if !success
++ result.bt = backtrace
++ break
++ end
++ end
++ checkresult(sandbox, result, meta, doc)
++end
++
++function filter_doctests(strings::NTuple{2, AbstractString},
++ doc::Documents.Document, meta::Dict)
++ meta_block_filters = get(meta, :DocTestFilters, [])
++ meta_block_filters == nothing && meta_block_filters == []
++ doctest_local_filters = get(meta[:LocalDocTestArguments], :filter, [])
++ for r in [doc.user.doctestfilters; meta_block_filters; doctest_local_filters]
++ if all(occursin.((r,), strings))
++ strings = replace.(strings, (r => "",))
++ end
++ end
++ return strings
++end
++
++# Regex used here to replace gensym'd module names could probably use improvements.
++function checkresult(sandbox::Module, result::Result, meta::Dict, doc::Documents.Document)
++ sandbox_name = nameof(sandbox)
++ mod_regex = Regex("(Main\\.)?(Symbol\\(\"$(sandbox_name)\"\\)|$(sandbox_name))[,.]")
++ mod_regex_nodot = Regex(("(Main\\.)?$(sandbox_name)"))
++ outio = IOContext(result.stdout, :module => sandbox)
++ if isdefined(result, :bt) # An error was thrown and we have a backtrace.
++ # To avoid dealing with path/line number issues in backtraces we use `[...]` to
++ # mark ignored output from an error message. Only the text prior to it is used to
++ # test for doctest success/failure.
++ head = replace(split(result.output, "\n[...]"; limit = 2)[1], mod_regex => "")
++ head = replace(head, mod_regex_nodot => "Main")
++ str = replace(error_to_string(outio, result.value, result.bt), mod_regex => "")
++ str = replace(str, mod_regex_nodot => "Main")
++
++ str, head = filter_doctests((str, head), doc, meta)
++ # Since checking for the prefix of an error won't catch the empty case we need
++ # to check that manually with `isempty`.
++ if isempty(head) || !startswith(str, head)
++ if doc.user.doctest === :fix
++ fix_doctest(result, str, doc)
++ else
++ report(result, str, doc)
++ @debug "Doctest metadata" meta
++ push!(doc.internal.errors, :doctest)
++ end
++ end
++ else
++ value = result.hide ? nothing : result.value # `;` hides output.
++ output = replace(rstrip(sanitise(IOBuffer(result.output))), mod_regex => "")
++ str = replace(result_to_string(outio, value), mod_regex => "")
++ # Replace a standalone module name with `Main`.
++ str = rstrip(replace(str, mod_regex_nodot => "Main"))
++ filteredstr, filteredoutput = filter_doctests((str, output), doc, meta)
++ if filteredstr != filteredoutput
++ if doc.user.doctest === :fix
++ fix_doctest(result, str, doc)
++ else
++ report(result, str, doc)
++ @debug "Doctest metadata" meta
++ push!(doc.internal.errors, :doctest)
++ end
++ end
++ end
++ return nothing
++end
++
++# Display doctesting results.
++
++function result_to_string(buf, value)
++ value === nothing || Base.invokelatest(show, IOContext(buf, :limit => true), MIME"text/plain"(), value)
++ return sanitise(buf)
++end
++
++function error_to_string(buf, er, bt)
++ # Remove unimportant backtrace info. TODO: this backtrace handling should maybe be done
++ # by Utilities.withoutput() already.
++ bt = remove_common_backtrace(bt, backtrace())
++ # Remove everything below the last eval call (which should be the one in withoutput)
++ index = findlast(ptr -> Base.ip_matches_func(ptr, :eval), bt)
++ bt = (index === nothing) ? bt : bt[1:(index - 1)]
++ # Print a REPL-like error message.
++ print(buf, "ERROR: ")
++ Base.invokelatest(showerror, buf, er, bt)
++ return sanitise(buf)
++end
++
++function remove_common_backtrace(bt, reference_bt)
++ cutoff = nothing
++ # We'll start from the top of the backtrace (end of the array) and go down, checking
++ # if the backtraces agree
++ for ridx in 1:length(bt)
++ # Cancel search if we run out the reference BT or find a non-matching one frames:
++ if ridx > length(reference_bt) || bt[length(bt) - ridx + 1] != reference_bt[length(reference_bt) - ridx + 1]
++ cutoff = length(bt) - ridx + 1
++ break
++ end
++ end
++ # It's possible that the loop does not find anything, i.e. that all BT elements are in
++ # the reference_BT too. In that case we'll just return an empty BT.
++ bt[1:(cutoff === nothing ? 0 : cutoff)]
++end
++
++# Strip trailing whitespace from each line and return resulting string
++function sanitise(buffer)
++ out = IOBuffer()
++ for line in eachline(seekstart(Base.unwrapcontext(buffer)[1]))
++ println(out, rstrip(line))
++ end
++ return rstrip(String(take!(out)), '\n')
++end
++
++import .Utilities.TextDiff
++
++function report(result::Result, str, doc::Documents.Document)
++ diff = TextDiff.Diff{TextDiff.Words}(result.output, rstrip(str))
++ lines = Utilities.find_block_in_file(result.block.code, result.file)
++ @error("""
++ doctest failure in $(Utilities.locrepr(result.file, lines))
++
++ ```$(result.block.language)
++ $(result.block.code)
++ ```
++
++ Subexpression:
++
++ $(result.input)
++
++ Evaluated output:
++
++ $(rstrip(str))
++
++ Expected output:
++
++ $(result.output)
++
++ """, diff)
++end
++
++function fix_doctest(result::Result, str, doc::Documents.Document)
++ code = result.block.code
++ filename = Base.find_source_file(result.file)
++ # read the file containing the code block
++ content = read(filename, String)
++ # output stream
++ io = IOBuffer(sizehint = sizeof(content))
++ # first look for the entire code block
++ # make a regex of the code that matches leading whitespace
++ rcode = "(\\h*)" * replace(Utilities.regex_escape(code), "\\n" => "\\n\\h*")
++ r = Regex(rcode)
++ codeidx = findfirst(r, content)
++ if codeidx === nothing
++ @warn "could not find code block in source file"
++ return
++ end
++ # use the capture group to identify indentation
++ indent = match(r, content).captures[1]
++ # write everything up until the code block
++ write(io, content[1:prevind(content, first(codeidx))])
++ # next look for the particular input string in the given code block
++ # make a regex of the input that matches leading whitespace (for multiline input)
++ rinput = "\\h*" * replace(Utilities.regex_escape(result.input), "\\n" => "\\n\\h*")
++ r = Regex(rinput)
++ inputidx = findfirst(r, code)
++ if inputidx === nothing
++ @warn "could not find input line in code block"
++ return
++ end
++ # construct the new code-snippet (without indent)
++ # first part: everything up until the last index of the input string
++ newcode = code[1:last(inputidx)]
++ isempty(result.output) && (newcode *= '\n') # issue #772
++ # second part: the rest, with the old output replaced with the new one
++ newcode *= replace(code[nextind(code, last(inputidx)):end], result.output => str, count = 1)
++ # replace internal code block with the non-indented new code, needed if we come back
++ # looking to replace output in the same code block later
++ result.block.code = newcode
++ # write the new code snippet to the stream, with indent
++ newcode = replace(newcode, r"^(.+)$"m => Base.SubstitutionString(indent * "\\1"))
++ write(io, newcode)
++ # write rest of the file
++ write(io, content[nextind(content, last(codeidx)):end])
++ # write to file
++ write(filename, seekstart(io))
++ return
++end
++
++# REPL doctest splitter.
++
++const PROMPT_REGEX = r"^julia> (.*)$"
++const SOURCE_REGEX = r"^ (.*)$"
++const ANON_FUNC_DECLARATION = r"#[0-9]+ \(generic function with [0-9]+ method(s)?\)"
++
++function repl_splitter(code)
++ lines = split(string(code, "\n"), '\n')
++ input = String[]
++ output = String[]
++ buffer = IOBuffer()
++ while !isempty(lines)
++ line = popfirst!(lines)
++ # REPL code blocks may contain leading lines with comments. Drop them.
++ # TODO: handle multiline comments?
++ # ANON_FUNC_DECLARATION deals with `x->x` -> `#1 (generic function ....)` on 0.7
++ # TODO: Remove this special case and just disallow lines with comments?
++ startswith(line, '#') && !occursin(ANON_FUNC_DECLARATION, line) && continue
++ prompt = match(PROMPT_REGEX, line)
++ if prompt === nothing
++ source = match(SOURCE_REGEX, line)
++ if source === nothing
++ savebuffer!(input, buffer)
++ println(buffer, line)
++ takeuntil!(PROMPT_REGEX, buffer, lines)
++ else
++ println(buffer, source[1])
++ end
++ else
++ savebuffer!(output, buffer)
++ println(buffer, prompt[1])
++ end
++ end
++ savebuffer!(output, buffer)
++ zip(input, output)
++end
++
++function savebuffer!(out, buf)
++ n = bytesavailable(seekstart(buf))
++ n > 0 ? push!(out, rstrip(String(take!(buf)))) : out
++end
++
++function takeuntil!(r, buf, lines)
++ while !isempty(lines)
++ line = lines[1]
++ if !occursin(r, line)
++ println(buf, popfirst!(lines))
++ else
++ break
++ end
++ end
++end
++
++end
--- /dev/null
--- /dev/null
++"""
++Main module for `Documenter.jl` -- a documentation generation package for Julia.
++
++Two functions are exported from this module for public use:
++
++- [`makedocs`](@ref). Generates documentation from docstrings and templated markdown files.
++- [`deploydocs`](@ref). Deploys generated documentation from *Travis-CI* to *GitHub Pages*.
++
++# Exports
++
++$(EXPORTS)
++
++"""
++module Documenter
++
++using Test: @testset, @test
++using DocStringExtensions
++import Base64: base64decode
++
++"""
++ abstract type Plugin end
++
++Any plugin that needs to either solicit user input or store information in a
++[`Documents.Document`](@ref) should create a subtype of `Plugin`. The
++subtype, `T <: Documenter.Plugin`, must have an empty constructor `T()` that
++initialized `T` with the appropriate default values.
++
++To retrieve the values stored in `T`, the plugin can call [`Documents.getplugin`](@ref).
++If `T` was passed to [`makedocs`](@ref), the passed type will be returned. Otherwise,
++a new `T` object will be created.
++"""
++abstract type Plugin end
++
++abstract type Writer end
++
++# Submodules
++# ----------
++
++include("Utilities/Utilities.jl")
++include("DocMeta.jl")
++include("DocSystem.jl")
++include("Anchors.jl")
++include("Documents.jl")
++include("Expanders.jl")
++include("DocTests.jl")
++include("Builder.jl")
++include("CrossReferences.jl")
++include("DocChecks.jl")
++include("Writers/Writers.jl")
++include("Deps.jl")
++
++import .Utilities: Selectors
++import .Writers.HTMLWriter: HTML
++
++
++# User Interface.
++# ---------------
++export Deps, makedocs, deploydocs, hide, doctest, DocMeta
++
++"""
++ makedocs(
++ root = "<current-directory>",
++ source = "src",
++ build = "build",
++ clean = true,
++ doctest = true,
++ modules = Module[],
++ repo = "",
++ highlightsig = true,
++ sitename = "",
++ expandfirst = [],
++ )
++
++Combines markdown files and inline docstrings into an interlinked document.
++In most cases [`makedocs`](@ref) should be run from a `make.jl` file:
++
++```julia
++using Documenter
++makedocs(
++ # keywords...
++)
++```
++
++which is then run from the command line with:
++
++```sh
++\$ julia make.jl
++```
++
++The folder structure that [`makedocs`](@ref) expects looks like:
++
++ docs/
++ build/
++ src/
++ make.jl
++
++# Keywords
++
++**`root`** is the directory from which `makedocs` should run. When run from a `make.jl` file
++this keyword does not need to be set. It is, for the most part, needed when repeatedly
++running `makedocs` from the Julia REPL like so:
++
++ julia> makedocs(root = joinpath(dirname(pathof(MyModule)), "..", "docs"))
++
++**`source`** is the directory, relative to `root`, where the markdown source files are read
++from. By convention this folder is called `src`. Note that any non-markdown files stored
++in `source` are copied over to the build directory when [`makedocs`](@ref) is run.
++
++**`build`** is the directory, relative to `root`, into which generated files and folders are
++written when [`makedocs`](@ref) is run. The name of the build directory is, by convention,
++called `build`, though, like with `source`, users are free to change this to anything else
++to better suit their project needs.
++
++**`clean`** tells [`makedocs`](@ref) whether to remove all the content from the `build`
++folder prior to generating new content from `source`. By default this is set to `true`.
++
++**`doctest`** instructs [`makedocs`](@ref) on whether to try to test Julia code blocks
++that are encountered in the generated document. By default this keyword is set to `true`.
++Doctesting should only ever be disabled when initially setting up a newly developed package
++where the developer is just trying to get their package and documentation structure correct.
++After that, it's encouraged to always make sure that documentation examples are runnable and
++produce the expected results. See the [Doctests](@ref) manual section for details about
++running doctests.
++
++Setting `doctest` to `:only` allows for doctesting without a full build. In this mode, most
++build stages are skipped and the `strict` keyword is ignore (a doctesting error will always
++make `makedocs` throw an error).
++
++**`modules`** specifies a vector of modules that should be documented in `source`. If any
++inline docstrings from those modules are seen to be missing from the generated content then
++a warning will be printed during execution of [`makedocs`](@ref). By default no modules are
++passed to `modules` and so no warnings will appear. This setting can be used as an indicator
++of the "coverage" of the generated documentation.
++For example Documenter's `make.jl` file contains:
++
++```julia
++makedocs(
++ modules = [Documenter],
++ # ...
++)
++```
++
++and so any docstring from the module `Documenter` that is not spliced into the generated
++documentation in `build` will raise a warning.
++
++**`repo`** specifies a template for the "link to source" feature. If you are
++using GitHub, this is automatically generated from the remote. If you are using
++a different host, you can use this option to tell Documenter how URLs should be
++generated. The following placeholders will be replaced with the respective
++value of the generated link:
++
++ - `{commit}` Git branch or tag name, or commit hash
++ - `{path}` Path to the file in the repository
++ - `{line}` Line (or range of lines) in the source file
++
++For example if you are using GitLab.com, you could use
++
++```julia
++makedocs(repo = \"https://gitlab.com/user/project/blob/{commit}{path}#{line}\")
++```
++
++**`highlightsig`** enables or disables automatic syntax highlighting of leading, unlabeled
++code blocks in docstrings (as Julia code). For example, if your docstring begins with an
++indented code block containing the function signature, then that block would be highlighted
++as if it were a labeled Julia code block. No other code blocks are affected. This feature
++is enabled by default.
++
++**`sitename`** is displayed in the title bar and/or the navigation menu when applicable.
++
++**`expandfirst`** allows some of the pages to be _expanded_ (i.e. at-blocks evaluated etc.)
++before the others. Documenter normally evaluates the files in the alphabetic order of their
++file paths relative to `src`, but `expandfirst` allows some pages to be prioritized.
++
++For example, if you have `foo.md` and `bar.md`, `bar.md` would normally be evaluated before
++`foo.md`. But with `expandfirst = ["foo.md"]`, you can force `foo.md` to be evaluated first.
++
++Evaluation order among the `expandfirst` pages is according to the order they appear in the
++argument.
++
++# Experimental keywords
++
++In addition to standard arguments there is a set of non-finalized experimental keyword
++arguments. The behaviour of these may change or they may be removed without deprecation
++when a minor version changes (i.e. except in patch releases).
++
++**`checkdocs`** instructs [`makedocs`](@ref) to check whether all names within the modules
++defined in the `modules` keyword that have a docstring attached have the docstring also
++listed in the manual (e.g. there's a `@docs` blocks with that docstring). Possible values
++are `:all` (check all names) and `:exports` (check only exported names). The default value
++is `:none`, in which case no checks are performed. If `strict` is also enabled then the
++build will fail if any missing docstrings are encountered.
++
++**`linkcheck`** -- if set to `true` [`makedocs`](@ref) uses `curl` to check the status codes
++of external-pointing links, to make sure that they are up-to-date. The links and their
++status codes are printed to the standard output. If `strict` is also enabled then the build
++will fail if there are any broken (400+ status code) links. Default: `false`.
++
++**`linkcheck_ignore`** allows certain URLs to be ignored in `linkcheck`. The values should
++be a list of strings (which get matched exactly) or `Regex` objects. By default nothing is
++ignored.
++
++**`strict`** -- [`makedocs`](@ref) fails the build right before rendering if it encountered
++any errors with the document in the previous build phases.
++
++**`workdir`** determines the working directory where `@example` and `@repl` code blocks are
++executed. It can be either a path or the special value `:build` (default).
++
++If the `workdir` is set to a path, the working directory is reset to that path for each code
++block being evaluated. Relative paths are taken to be relative to `root`, but using absolute
++paths is recommended (e.g. `workdir = joinpath(@__DIR__, "..")` for executing in the package
++root for the usual `docs/make.jl` setup).
++
++With the default `:build` option, the working directory is set to a subdirectory of `build`,
++determined from the source file path. E.g. for `src/foo.md` it is set to `build/`, for
++`src/foo/bar.md` it is set to `build/foo` etc.
++
++Note that `workdir` does not affect doctests.
++
++## Output formats
++**`format`** allows the output format to be specified. The default format is
++[`Documenter.HTML`](@ref) which creates a set of HTML files.
++
++There are other possible formats that are enabled by using other addon-packages.
++For examples, the `DocumenterMarkdown` package define the `DocumenterMarkdown.Markdown()`
++format for use with e.g. MkDocs, and the `DocumenterLaTeX` package define the
++`DocumenterLaTeX.LaTeX()` format for LaTeX / PDF output.
++See the [Other Output Formats](@ref) for more information.
++
++# See Also
++
++A guide detailing how to document a package using Documenter's [`makedocs`](@ref) is provided
++in the [setup guide in the manual](@ref Package-Guide).
++"""
++function makedocs(components...; debug = false, format = HTML(),
++ html_prettyurls::Union{Bool, Nothing} = nothing, # deprecated
++ html_disable_git::Union{Bool, Nothing} = nothing, # deprecated
++ html_edit_branch::Union{String, Nothing} = nothing, # deprecated
++ html_canonical::Union{String, Nothing} = nothing, # deprecated
++ assets::Union{Vector{<:AbstractString}, Nothing} = nothing, # deprecated
++ analytics::Union{<:AbstractString, Nothing} = nothing, # deprecated
++ kwargs...)
++ # html_ keywords deprecation
++ html_keywords = Dict()
++ function html_warn(kw)
++ replace_with = startswith(kw, "html_") ? kw[6:end] : kw
++ @warn """
++ The `$kw` keyword argument should now be specified in the
++ `Documenter.HTML()` format specifier. To fix this warning replace
++ ```
++ $kw = ...
++ ```
++ with
++ ```
++ format = Documenter.HTML($(replace_with) = ...)
++ ```
++ """
++ end
++ if html_prettyurls !== nothing
++ html_warn("html_prettyurls")
++ html_keywords[:prettyurls] = html_prettyurls
++ end
++ if html_disable_git !== nothing
++ html_warn("html_disable_git")
++ html_keywords[:disable_git] = html_disable_git
++ end
++ if html_edit_branch !== nothing
++ html_warn("html_edit_branch")
++ html_keywords[:edit_branch] = html_edit_branch
++ end
++ if html_canonical !== nothing
++ html_warn("html_canonical")
++ html_keywords[:canonical] = html_canonical
++ end
++ if assets !== nothing
++ html_warn("assets")
++ html_keywords[:assets] = assets
++ end
++ if analytics !== nothing
++ html_warn("analytics")
++ html_keywords[:analytics] = analytics
++ end
++
++ # deprecation of format as Symbols
++ function fmt(f)
++ if f === :html
++ Base.depwarn("`format = :html` is deprecated, use `format = Documenter.HTML()` instead.", :makedocs)
++ return Writers.HTMLWriter.HTML(; html_keywords...)
++ elseif f === :latex
++ Base.depwarn("`format = :latex` is deprecated, use `format = LaTeX()` from " *
++ "the DocumenterLaTeX package instead.", :makedocs)
++ return Writers.LaTeXWriter.LaTeX()
++ elseif f === :markdown
++ Base.depwarn("`format = :markdown` is deprecated, use `format = Markdown()` " *
++ "from the DocumenterMarkdown package instead.", :makedocs)
++ return Writers.MarkdownWriter.Markdown()
++ end
++ end
++ if isa(format, AbstractVector{<:Symbol})
++ format = fmt.(format)
++ elseif isa(format, Symbol)
++ format = fmt(format)
++ end
++ # overwrite some stuff in HTML() if outer html_ kwargs have been set
++ # seems ok since the depwarns will still be there.
++ overwrite(x) = x
++ function overwrite(html::HTML)
++ d = Dict(x => getfield(html, x) for x in fieldnames(HTML))
++ d = merge!(d, html_keywords)
++ return HTML(; d...)
++ end
++ if isa(format, HTML)
++ format = overwrite(format)
++ elseif format isa AbstractVector
++ format = overwrite.(format)
++ end
++
++ document = Documents.Document(components; format=format, kwargs...)
++ cd(document.user.root) do
++ Selectors.dispatch(Builder.DocumentPipeline, document)
++ end
++ debug ? document : nothing
++end
++
++"""
++$(SIGNATURES)
++
++Allows a page to be hidden in the navigation menu. It will only show up if it happens to be
++the current page. The hidden page will still be present in the linear page list that can be
++accessed via the previous and next page links. The title of the hidden page can be overriden
++using the `=>` operator as usual.
++
++# Usage
++
++```julia
++makedocs(
++ ...,
++ pages = [
++ ...,
++ hide("page1.md"),
++ hide("Title" => "page2.md")
++ ]
++)
++```
++"""
++hide(page::Pair) = (false, page.first, page.second, [])
++hide(page::AbstractString) = (false, nothing, page, [])
++
++"""
++$(SIGNATURES)
++
++Allows a subsection of pages to be hidden from the navigation menu. `root` will be linked
++to in the navigation menu, with the title determined as usual. `children` should be a list
++of pages (note that it **can not** be hierarchical).
++
++# Usage
++
++```julia
++makedocs(
++ ...,
++ pages = [
++ ...,
++ hide("Hidden section" => "hidden_index.md", [
++ "hidden1.md",
++ "Hidden 2" => "hidden2.md"
++ ]),
++ hide("hidden_index.md", [...])
++ ]
++)
++```
++"""
++hide(root::Pair, children) = (true, root.first, root.second, map(hide, children))
++hide(root::AbstractString, children) = (true, nothing, root, map(hide, children))
++
++"""
++ deploydocs(
++ root = "<current-directory>",
++ target = "build",
++ repo = "<required>",
++ branch = "gh-pages",
++ deps = nothing | <Function>,
++ make = nothing | <Function>,
++ devbranch = "master",
++ devurl = "dev",
++ versions = ["stable" => "v^", "v#.#", devurl => devurl]
++ )
++
++Converts markdown files generated by [`makedocs`](@ref) to HTML and pushes them to `repo`.
++This function should be called from within a package's `docs/make.jl` file after the call to
++[`makedocs`](@ref), like so
++
++```julia
++using Documenter, PACKAGE_NAME
++makedocs(
++ # options...
++)
++deploydocs(
++ repo = "github.com/..."
++)
++```
++
++When building the docs for a tag (i.e. a release) the documentation is deployed to
++a directory with the tag name (i.e. `vX.Y.Z`) and to the `stable` directory.
++Otherwise the docs are deployed to the directory determined by the `devurl` argument.
++
++# Required keyword arguments
++
++**`repo`** is the remote repository where generated HTML content should be pushed to. Do not
++specify any protocol - "https://" or "git@" should not be present. This keyword *must*
++be set and will throw an error when left undefined. For example this package uses the
++following `repo` value:
++
++```julia
++repo = "github.com/JuliaDocs/Documenter.jl.git"
++```
++
++# Optional keyword arguments
++
++**`root`** has the same purpose as the `root` keyword for [`makedocs`](@ref).
++
++**`target`** is the directory, relative to `root`, where generated content that should be
++deployed to `gh-pages` is written to. written to. It should generally be the same as
++[`makedocs`](@ref)'s `build` and defaults to `"build"`.
++
++**`branch`** is the branch where the generated documentation is pushed. If the branch does
++not exist, a new orphaned branch is created automatically. It defaults to `"gh-pages"`.
++
++**`deps`** is the function used to install any additional dependencies needed to build the
++documentation. By default nothing is installed.
++
++It can be used e.g. for a Markdown build. The following example installed the `pygments` and
++`mkdocs` Python packages using the [`Deps.pip`](@ref) function:
++
++```julia
++deps = Deps.pip("pygments", "mkdocs")
++```
++
++**`make`** is the function used to specify an additonal build phase. By default, nothing gets
++executed.
++
++**`devbranch`** is the branch that "tracks" the in-development version of the generated
++documentation. By default this value is set to `"master"`.
++
++**`devurl`** the folder that in-development version of the docs will be deployed.
++Defaults to `"dev"`.
++
++**`forcepush`** a boolean that specifies the behavior of the git-deployment.
++The default (`forcepush = false`) is to push a new commit, but when
++`forcepush = true` the changes will be combined with the previous commit and
++force pushed, erasing the Git history on the deployment branch.
++
++**`versions`** determines content and order of the resulting version selector in
++the generated html. The following entries are valied in the `versions` vector:
++ - `"v#"`: includes links to the latest documentation for each major release cycle
++ (i.e. `v2.0`, `v1.1`).
++ - `"v#.#"`: includes links to the latest documentation for each minor release cycle
++ (i.e. `v2.0`, `v1.1`, `v1.0`, `v0.1`).
++ - `"v#.#.#"`: includes links to all released versions.
++ - `"v^"`: includes a link to the docs for the maximum version
++ (i.e. a link `vX.Y` pointing to `vX.Y.Z` for highest `X`, `Y`, `Z`, respectively).
++ - A pair, e.g. `"first" => "second"`, which will put `"first"` in the selector,
++ and generate a url from which `"second"` can be accessed.
++ The second argument can be `"v^"`, to point to the maximum version docs
++ (as in e.g. `"stable" => "v^"`).
++
++# Environment variables
++
++[`deploydocs`](@ref)'s behavior is influenced by the following environment variables, many
++of which are specific to the [Travis CI platform](https://travis-ci.com/).
++
++ - **`DOCUMENTER_KEY`**: must contain the Base64-encoded SSH private key for the repository.
++
++ - **`TRAVIS_PULL_REQUEST`**: must be set to `false`.
++
++ This avoids deployment on pull request builds. Note that there is no way to _safely_
++ enable builds on pull requests, since that would expose the SSH private key
++ (`DOCUMENTER_KEY`), giving anyone opening a pull request full write access to the repository.
++
++ - **`TRAVIS_REPO_SLUG`**: must match the value of the `repo` keyword.
++
++ - **`TRAVIS_EVENT_TYPE`**: may not be set to `cron`.
++
++ This avoids the re-deployment of existing docs on builds that were triggered by a Travis
++ cron job.
++
++ - **`TRAVIS_BRANCH`**: unless `TRAVIS_TAG` is non-empty, this must have the same value as the
++ `devbranch` keyword.
++
++ This makes sure that only the development branch (commonly, the `master` branch) will deploy
++ the "dev" documentation (deployed into a directory specified by the `devurl` keyword).
++
++ - **`TRAVIS_TAG`**: if set, a tagged version deployment is performed instead; the value must be
++ a valid version number (i.e. match `Base.VERSION_REGEX`).
++
++ The documentation for a package version tag gets deployed to a directory named after the
++ version number in `TRAVIS_TAG` instead.
++
++The `TRAVIS_*` variables are set automatically on Travis, but could be set manually to
++appropriate values as well to run [`deploydocs`](@ref) locally or on other CI platforms.
++More information on how Travis sets the `TRAVIS_*` variables can be found in the
++[Travis documentation](https://docs.travis-ci.com/user/environment-variables/#default-environment-variables).
++
++# See Also
++
++The [Hosting Documentation](@ref) section of the manual provides a step-by-step guide to
++using the [`deploydocs`](@ref) function to automatically generate docs and push them to
++GitHub.
++"""
++function deploydocs(;
++ root = Utilities.currentdir(),
++ target = "build",
++ dirname = "",
++
++ repo = error("no 'repo' keyword provided."),
++ branch = "gh-pages",
++ latest::Union{String,Nothing} = nothing, # deprecated
++
++ osname::Union{String,Nothing} = nothing, # deprecated
++ julia::Union{String,Nothing} = nothing, # deprecated
++
++ deps = nothing,
++ make = nothing,
++
++ devbranch = "master",
++ devurl = "dev",
++ versions = ["stable" => "v^", "v#.#", devurl => devurl],
++ forcepush::Bool = false,
++ )
++ # deprecation of latest kwarg (renamed to devbranch)
++ if latest !== nothing
++ Base.depwarn("The `latest` keyword argument has been renamed to `devbranch`.", :deploydocs)
++ devbranch = latest
++ @info "setting `devbranch` to `$(devbranch)`."
++ end
++ # deprecation/removal of `julia` and `osname` kwargs
++ if julia !== nothing
++ Base.depwarn("the `julia` keyword argument to `Documenter.deploydocs` is " *
++ "removed. Use Travis Build Stages for determining from where to deploy instead. " *
++ "See the section about Hosting in the Documenter manual for more details.", :deploydocs)
++ @info "skipping docs deployment."
++ return
++ end
++ if osname !== nothing
++ Base.depwarn("the `osname` keyword argument to `Documenter.deploydocs` is " *
++ "removed. Use Travis Build Stages for determining from where to deploy instead. " *
++ "See the section about Hosting in the Documenter manual for more details.", :deploydocs)
++ @info "skipping docs deployment."
++ return
++ end
++
++ # Get environment variables.
++ documenter_key = get(ENV, "DOCUMENTER_KEY", "")
++ travis_branch = get(ENV, "TRAVIS_BRANCH", "")
++ travis_pull_request = get(ENV, "TRAVIS_PULL_REQUEST", "")
++ travis_repo_slug = get(ENV, "TRAVIS_REPO_SLUG", "")
++ travis_tag = get(ENV, "TRAVIS_TAG", "")
++ travis_event_type = get(ENV, "TRAVIS_EVENT_TYPE", "")
++
++
++ # Other variables.
++ sha = cd(root) do
++ # We'll make sure we run the git commands in the source directory (root), in case
++ # the working directory has been changed (e.g. if the makedocs' build argument is
++ # outside root).
++ try
++ readchomp(`git rev-parse --short HEAD`)
++ catch
++ # git rev-parse will throw an error and return code 128 if it is not being
++ # run in a git repository, which will make run/readchomp throw an exception.
++ # We'll assume that if readchomp fails it is due to this and set the sha
++ # variable accordingly.
++ "(not-git-repo)"
++ end
++ end
++
++ # Check criteria for deployment
++ ## The deploydocs' repo should match TRAVIS_REPO_SLUG
++ repo_ok = occursin(travis_repo_slug, repo)
++ ## Do not deploy for PRs
++ pr_ok = travis_pull_request == "false"
++ ## If a tag exist it should be a valid VersionNumber
++ tag_ok = isempty(travis_tag) || occursin(Base.VERSION_REGEX, travis_tag)
++ ## If no tag exists deploydocs' devbranch should match TRAVIS_BRANCH
++ branch_ok = !isempty(travis_tag) || travis_branch == devbranch
++ ## DOCUMENTER_KEY should exist
++ key_ok = !isempty(documenter_key)
++ ## Cron jobs should not deploy
++ type_ok = travis_event_type != "cron"
++ should_deploy = repo_ok && pr_ok && tag_ok && branch_ok && key_ok && type_ok
++
++ marker(x) = x ? "✔" : "✘"
++ @info """Deployment criteria:
++ - $(marker(repo_ok)) ENV["TRAVIS_REPO_SLUG"]="$(travis_repo_slug)" occurs in repo="$(repo)"
++ - $(marker(pr_ok)) ENV["TRAVIS_PULL_REQUEST"]="$(travis_pull_request)" is "false"
++ - $(marker(tag_ok)) ENV["TRAVIS_TAG"]="$(travis_tag)" is (i) empty or (ii) a valid VersionNumber
++ - $(marker(branch_ok)) ENV["TRAVIS_BRANCH"]="$(travis_branch)" matches devbranch="$(devbranch)" (if tag is empty)
++ - $(marker(key_ok)) ENV["DOCUMENTER_KEY"] exists
++ - $(marker(type_ok)) ENV["TRAVIS_EVENT_TYPE"]="$(travis_event_type)" is not "cron"
++ Deploying: $(marker(should_deploy))
++ """
++
++ if should_deploy
++ # Add local bin path if needed.
++ Deps.updatepath!()
++ # Install dependencies when applicable.
++ if deps !== nothing
++ @debug "installing dependencies."
++ deps()
++ end
++ # Change to the root directory and try to deploy the docs.
++ cd(root) do
++ @debug "setting up target directory."
++ isdir(target) || mkpath(target)
++ # Run extra build steps defined in `make` if required.
++ if make !== nothing
++ @debug "running extra build steps."
++ make()
++ end
++ @debug "pushing new documentation to remote: '$repo:$branch'."
++ mktempdir() do temp
++ git_push(
++ root, temp, repo;
++ branch=branch, dirname=dirname, target=target,
++ tag=travis_tag, key=documenter_key, sha=sha,
++ devurl = devurl, versions = versions, forcepush = forcepush,
++ )
++ end
++ end
++ end
++end
++
++"""
++ git_push(
++ root, tmp, repo;
++ branch="gh-pages", dirname="", target="site", tag="", key="", sha="", devurl="dev"
++ )
++
++Handles pushing changes to the remote documentation branch.
++When `tag` is empty the docs are deployed to the `devurl` directory,
++and when building docs for a tag they are deployed to a `vX.Y.Z` directory.
++"""
++function git_push(
++ root, temp, repo;
++ branch="gh-pages", dirname="", target="site", tag="", key="", sha="", devurl="dev",
++ versions, forcepush=false,
++ )
++ dirname = isempty(dirname) ? temp : joinpath(temp, dirname)
++ isdir(dirname) || mkpath(dirname)
++
++ target_dir = abspath(target)
++
++ # Extract host from repo as everything up to first ':' or '/' character
++ host = match(r"(.*?)[:\/]", repo)[1]
++
++ # The upstream URL to which we push new content and the ssh decryption commands.
++ upstream = "git@$(replace(repo, "$host/" => "$host:"))"
++
++ keyfile = abspath(joinpath(root, ".documenter"))
++ try
++ write(keyfile, String(base64decode(key)))
++ catch e
++ @error """
++ Documenter failed to decode the DOCUMENTER_KEY environment variable.
++ Make sure that the environment variable is properly set up as a Base64-encoded string
++ of the SSH private key. You may need to re-generate the keys with DocumenterTools.
++ """
++ rethrow(e)
++ end
++ chmod(keyfile, 0o600)
++
++ try
++ # Use a custom SSH config file to avoid overwriting the default user config.
++ withfile(joinpath(homedir(), ".ssh", "config"),
++ """
++ Host $host
++ StrictHostKeyChecking no
++ HostName $host
++ IdentityFile "$keyfile"
++ BatchMode yes
++ """
++ ) do
++ cd(temp) do
++ # Setup git.
++ run(`git init`)
++ run(`git config user.name "zeptodoctor"`)
++ run(`git config user.email "44736852+zeptodoctor@users.noreply.github.com"`)
++
++ # Fetch from remote and checkout the branch.
++ run(`git remote add upstream $upstream`)
++ try
++ run(`git fetch upstream`)
++ catch e
++ @error """
++ Git failed to fetch $upstream
++ This can be caused by a DOCUMENTER_KEY variable that is not correctly set up.
++ Make sure that the environment variable is properly set up as a Base64-encoded string
++ of the SSH private key. You may need to re-generate the keys with DocumenterTools.
++ """
++ rethrow(e)
++ end
++
++ try
++ run(`git checkout -b $branch upstream/$branch`)
++ catch e
++ @debug "checking out $branch failed with error: $e"
++ @debug "creating a new local $branch branch."
++ run(`git checkout --orphan $branch`)
++ run(`git commit --allow-empty -m "Initial empty commit for docs"`)
++ end
++
++ # Copy docs to `devurl`, or `stable`, `<release>`, and `<version>` directories.
++ if isempty(tag)
++ devurl_dir = joinpath(dirname, devurl)
++ gitrm_copy(target_dir, devurl_dir)
++ Writers.HTMLWriter.generate_siteinfo_file(devurl_dir, devurl)
++ # symlink "latest" to devurl to preserve links (remove in some future release)
++ if devurl != "latest"
++ rm(joinpath(dirname, "latest"); recursive = true, force = true)
++ @warn(string("creating symlink from `latest` to `$(devurl)` for backwards ",
++ "compatibility with old links. In future Documenter versions this symlink ",
++ "will not be created. Please update any links that point to `latest`."))
++ cd(dirname) do; rm_and_add_symlink(devurl, "latest"); end
++ end
++ else
++ tagged_dir = joinpath(dirname, tag)
++ gitrm_copy(target_dir, tagged_dir)
++ Writers.HTMLWriter.generate_siteinfo_file(tagged_dir, tag)
++ end
++
++ # Expand the users `versions` vector
++ entries, symlinks = Writers.HTMLWriter.expand_versions(dirname, versions)
++
++ # Create the versions.js file containing a list of `entries`.
++ # This must always happen after the folder copying.
++ Writers.HTMLWriter.generate_version_file(joinpath(dirname, "versions.js"), entries)
++
++ # generate the symlinks, make sure we don't overwrite devurl
++ cd(dirname) do
++ for kv in symlinks
++ i = findfirst(x -> x.first == devurl, symlinks)
++ if i === nothing
++ rm_and_add_symlink(kv.second, kv.first)
++ else
++ throw(ArgumentError(string("link `$(kv)` cannot overwrite ",
++ "`devurl = $(devurl)` with the same name.")))
++ end
++ end
++ end
++
++ # Add, commit, and push the docs to the remote.
++ run(`git add -A .`)
++ if !success(`git diff --cached --exit-code`)
++ if forcepush
++ run(`git commit --amend --date=now -m "build based on $sha"`)
++ run(`git push -fq upstream HEAD:$branch`)
++ else
++ run(`git commit -m "build based on $sha"`)
++ run(`git push -q upstream HEAD:$branch`)
++ end
++ else
++ @debug "new docs identical to the old -- not committing nor pushing."
++ end
++ end
++ end
++ finally
++ # Remove the unencrypted private key.
++ isfile(keyfile) && rm(keyfile)
++ end
++end
++
++function rm_and_add_symlink(target, link)
++ if ispath(link)
++ @warn "removing `$(link)` and linking `$(link)` to `$(target)`."
++ rm(link; force = true, recursive = true)
++ end
++ symlink(target, link)
++end
++
++"""
++ gitrm_copy(src, dst)
++
++Uses `git rm -r` to remove `dst` and then copies `src` to `dst`. Assumes that the working
++directory is within the git repository of `dst` is when the function is called.
++
++This is to get around [#507](https://github.com/JuliaDocs/Documenter.jl/issues/507) on
++filesystems that are case-insensitive (e.g. on OS X, Windows). Without doing a `git rm`
++first, `git add -A` will not detect case changes in filenames.
++"""
++function gitrm_copy(src, dst)
++ # --ignore-unmatch so that we wouldn't get errors if dst does not exist
++ run(`git rm -rf --ignore-unmatch $(dst)`)
++ cp(src, dst; force=true)
++end
++
++function withfile(func, file::AbstractString, contents::AbstractString)
++ dir = dirname(file)
++ hasdir = isdir(dir)
++ hasdir || mkpath(dir)
++
++ hasfile = isfile(file)
++ original = hasfile ? read(file, String) : ""
++ open(file, "w") do stream
++ print(stream, contents)
++ flush(stream) # Make sure file is written before continuing.
++ end
++ try
++ func()
++ finally
++ if hasfile
++ open(file, "w") do stream
++ print(stream, original)
++ end
++ else
++ rm(file)
++ end
++
++ if !hasdir
++ # dir should be empty now as the only file inside was deleted
++ rm(dir, recursive=true)
++ end
++ end
++end
++
++function getenv(regex::Regex)
++ for (key, value) in ENV
++ occursin(regex, key) && return value
++ end
++ error("could not find key/iv pair.")
++end
++
++"""
++ doctest(package::Module; kwargs...)
++
++Convenience method that runs and checks all the doctests for a given Julia package.
++`package` must be the `Module` object corresponding to the top-level module of the package.
++Behaves like an `@testset` call, returning a testset if all the doctests are successful or
++throwing a `TestSetException` if there are any failures. Can be included in other testsets.
++
++# Keywords
++
++**`manual`** controls how manual pages are handled. By default (`manual = true`), `doctest`
++assumes that manual pages are located under `docs/src`. If that is not the case, the
++`manual` keyword argument can be passed to specify the directory. Setting `manual = false`
++will skip doctesting of manual pages altogether.
++
++Additional keywords are passed on to the main [`doctest`](@ref) method.
++"""
++function doctest(package::Module; manual=true, testset=nothing, kwargs...)
++ if pathof(package) === nothing
++ throw(ArgumentError("$(package) is not a top-level package module."))
++ end
++ source = nothing
++ if manual === true
++ source = normpath(joinpath(dirname(pathof(package)), "..", "docs", "src"))
++ isdir(source) || throw(ArgumentError("""
++ Package $(package) does not have a documentation source directory at standard location.
++ Searched at: $(source)
++ If ...
++ """))
++ end
++ testset = (testset === nothing) ? "Doctests: $(package)" : testset
++ doctest(source, [package]; testset=testset, kwargs...)
++end
++
++"""
++ doctest(source, modules; kwargs...)
++
++Runs all the doctests in the given modules and on manual pages under the `source` directory.
++Behaves like an `@testset` call, returning a testset if all the doctests are successful or
++throwing a `TestSetException` if there are any failures. Can be included in other testsets.
++
++The manual pages are searched recursively in subdirectories of `source` too. Doctesting of
++manual pages can be disabled if `source` is set to `nothing`.
++
++# Keywords
++
++**`testset`** specifies the name of test testset (default `Doctests`).
++
++**`fix`**, if set to `true`, updates all the doctests that fail with the correct output
++(default `false`).
++
++!!! warning
++ When running `doctest(...; fix=true)`, Documenter will modify the Markdown and Julia
++ source files. It is strongly recommended that you only run it on packages in Pkg's
++ develop mode and commit any staged changes. You should also review all the changes made
++ by `doctest` before committing them, as there may be edge cases when the automatic
++ fixing fails.
++"""
++function doctest(
++ source::Union{AbstractString,Nothing},
++ modules::AbstractVector{Module};
++ fix = false,
++ testset = "Doctests",
++ )
++ function all_doctests()
++ dir = mktempdir()
++ try
++ @debug "Doctesting in temporary directory: $(dir)" modules
++ if source === nothing
++ source = joinpath(dir, "src")
++ mkdir(source)
++ end
++ makedocs(
++ root = dir,
++ source = source,
++ sitename = "",
++ doctest = fix ? :fix : :only,
++ modules = modules,
++ )
++ true
++ catch err
++ @error "Doctesting failed"
++ showerror(stdout, err, catch_backtrace())
++ false
++ finally
++ rm(dir; recursive=true)
++ end
++ end
++ @testset "$testset" begin
++ @test all_doctests()
++ end
++end
++
++end # module
--- /dev/null
--- /dev/null
++"""
++Defines [`Document`](@ref) and its supporting types
++
++- [`Page`](@ref)
++- [`User`](@ref)
++- [`Internal`](@ref)
++- [`Globals`](@ref)
++
++"""
++module Documents
++
++import ..Documenter:
++ Documenter,
++ Anchors,
++ Utilities,
++ Plugin,
++ Writer
++
++import ..Documenter.Utilities.Markdown2
++using DocStringExtensions
++import Markdown
++using Unicode
++
++# Pages.
++# ------
++
++"""
++[`Page`](@ref)-local values such as current module that are shared between nodes in a page.
++"""
++mutable struct Globals
++ mod :: Module
++ meta :: Dict{Symbol, Any}
++end
++Globals() = Globals(Main, Dict())
++
++"""
++Represents a single markdown file.
++"""
++struct Page
++ source :: String
++ build :: String
++ workdir :: Union{Symbol,String}
++ """
++ Ordered list of raw toplevel markdown nodes from the parsed page contents. This vector
++ should be considered immutable.
++ """
++ elements :: Vector
++ """
++ Each element in `.elements` maps to an "expanded" element. This may be itself if the
++ element does not need expanding or some other object, such as a `DocsNode` in the case
++ of `@docs` code blocks.
++ """
++ mapping :: IdDict{Any,Any}
++ globals :: Globals
++ md2ast :: Markdown2.MD
++end
++function Page(source::AbstractString, build::AbstractString, workdir::AbstractString)
++ mdpage = Markdown.parse(read(source, String))
++ md2ast = try
++ Markdown2.convert(Markdown2.MD, mdpage)
++ catch e
++ @error "Markdown2.convert failed to convert $(source)"
++ rethrow(e)
++ end
++ Page(source, build, workdir, mdpage.content, IdDict{Any,Any}(), Globals(), md2ast)
++end
++
++# FIXME -- special overload for Utilities.parseblock
++Utilities.parseblock(code::AbstractString, doc, page::Documents.Page; kwargs...) = Utilities.parseblock(code, doc, page.source; kwargs...)
++
++# Document blueprints.
++# --------------------
++
++# Should contain all the information that is necessary to build a document.
++# Currently has enough information to just run doctests.
++struct DocumentBlueprint
++ pages :: Dict{String, Page} # Markdown files only.
++ modules :: Set{Module} # Which modules to check for missing docs?
++end
++
++
++# Document Nodes.
++# ---------------
++
++## IndexNode.
++
++struct IndexNode
++ pages :: Vector{String} # Which pages to include in the index? Set by user.
++ modules :: Vector{Module} # Which modules to include? Set by user.
++ order :: Vector{Symbol} # What order should docs be listed in? Set by user.
++ build :: String # Path to the file where this index will appear.
++ source :: String # Path to the file where this index was written.
++ elements :: Vector # (object, doc, page, mod, cat)-tuple for constructing links.
++
++ function IndexNode(;
++ # TODO: Fix difference between uppercase and lowercase naming of keys.
++ # Perhaps deprecate the uppercase versions? Same with `ContentsNode`.
++ Pages = [],
++ Modules = [],
++ Order = [:module, :constant, :type, :function, :macro],
++ build = error("missing value for `build` in `IndexNode`."),
++ source = error("missing value for `source` in `IndexNode`."),
++ others...
++ )
++ new(Pages, Modules, Order, build, source, [])
++ end
++end
++
++## ContentsNode.
++
++struct ContentsNode
++ pages :: Vector{String} # Which pages should be included in contents? Set by user.
++ depth :: Int # Down to which level should headers be displayed? Set by user.
++ build :: String # Same as for `IndexNode`s.
++ source :: String # Same as for `IndexNode`s.
++ elements :: Vector # (order, page, anchor)-tuple for constructing links.
++
++ function ContentsNode(;
++ Pages = [],
++ Depth = 2,
++ build = error("missing value for `build` in `ContentsNode`."),
++ source = error("missing value for `source` in `ContentsNode`."),
++ others...
++ )
++ new(Pages, Depth, build, source, [])
++ end
++end
++
++## Other nodes
++
++struct MetaNode
++ dict :: Dict{Symbol, Any}
++end
++
++struct MethodNode
++ method :: Method
++ visible :: Bool
++end
++
++struct DocsNode
++ docstr :: Any
++ anchor :: Anchors.Anchor
++ object :: Utilities.Object
++ page :: Documents.Page
++end
++
++struct DocsNodes
++ nodes :: Vector{Union{DocsNode,Markdown.Admonition}}
++end
++
++struct EvalNode
++ code :: Markdown.Code
++ result :: Any
++end
++
++struct RawHTML
++ code::String
++end
++
++struct RawNode
++ name::Symbol
++ text::String
++end
++
++struct MultiOutput
++ content::Vector
++end
++
++# Navigation
++# ----------------------
++
++"""
++Element in the navigation tree of a document, containing navigation references
++to other page, reference to the [`Page`](@ref) object etc.
++"""
++mutable struct NavNode
++ """
++ `nothing` if the `NavNode` is a non-page node of the navigation tree, otherwise
++ the string should be a valid key in `doc.blueprint.pages`
++ """
++ page :: Union{String, Nothing}
++ """
++ If not `nothing`, specifies the text that should be displayed in navigation
++ links etc. instead of the automatically determined text.
++ """
++ title_override :: Union{String, Nothing}
++ parent :: Union{NavNode, Nothing}
++ children :: Vector{NavNode}
++ visible :: Bool
++ prev :: Union{NavNode, Nothing}
++ next :: Union{NavNode, Nothing}
++end
++NavNode(page, title_override, parent) = NavNode(page, title_override, parent, [], true, nothing, nothing)
++
++"""
++Constructs a list of the ancestors of the `navnode` (inclding the `navnode` itself),
++ordered so that the root of the navigation tree is the first and `navnode` itself
++is the last item.
++"""
++navpath(navnode::NavNode) = navnode.parent === nothing ? [navnode] :
++ push!(navpath(navnode.parent), navnode)
++
++
++# Inner Document Fields.
++# ----------------------
++
++"""
++User-specified values used to control the generation process.
++"""
++struct User
++ root :: String # An absolute path to the root directory of the document.
++ source :: String # Parent directory is `.root`. Where files are read from.
++ build :: String # Parent directory is also `.root`. Where files are written to.
++ workdir :: Union{Symbol,String} # Parent directory is also `.root`. Where code is executed from.
++ format :: Vector{Writer} # What format to render the final document with?
++ clean :: Bool # Empty the `build` directory before starting a new build?
++ doctest :: Union{Bool,Symbol} # Run doctests?
++ linkcheck::Bool # Check external links..
++ linkcheck_ignore::Vector{Union{String,Regex}} # ..and then ignore (some of) them.
++ checkdocs::Symbol # Check objects missing from `@docs` blocks. `:none`, `:exports`, or `:all`.
++ doctestfilters::Vector{Regex} # Filtering for doctests
++ strict::Bool # Throw an exception when any warnings are encountered.
++ pages :: Vector{Any} # Ordering of document pages specified by the user.
++ expandfirst::Vector{String} # List of pages that get "expanded" before others
++ repo :: String # Template for URL to source code repo
++ sitename:: String
++ authors :: String
++ version :: String # version string used in the version selector by default
++ highlightsig::Bool # assume leading unlabeled code blocks in docstrings to be Julia.
++end
++
++"""
++Private state used to control the generation process.
++"""
++struct Internal
++ assets :: String # Path where asset files will be copied to.
++ remote :: String # The remote repo on github where this package is hosted.
++ navtree :: Vector{NavNode} # A vector of top-level navigation items.
++ navlist :: Vector{NavNode} # An ordered list of `NavNode`s that point to actual pages
++ headers :: Anchors.AnchorMap # See `modules/Anchors.jl`. Tracks `Markdown.Header` objects.
++ docs :: Anchors.AnchorMap # See `modules/Anchors.jl`. Tracks `@docs` docstrings.
++ bindings:: IdDict{Any,Any} # Tracks insertion order of object per-binding.
++ objects :: IdDict{Any,Any} # Tracks which `Utilities.Objects` are included in the `Document`.
++ contentsnodes :: Vector{ContentsNode}
++ indexnodes :: Vector{IndexNode}
++ locallinks :: Dict{Markdown.Link, String}
++ errors::Set{Symbol}
++end
++
++# Document.
++# ---------
++
++"""
++Represents an entire document.
++"""
++struct Document
++ user :: User # Set by the user via `makedocs`.
++ internal :: Internal # Computed values.
++ plugins :: Dict{DataType, Plugin}
++ blueprint :: DocumentBlueprint
++end
++
++function Document(plugins = nothing;
++ root :: AbstractString = Utilities.currentdir(),
++ source :: AbstractString = "src",
++ build :: AbstractString = "build",
++ workdir :: Union{Symbol, AbstractString} = :build,
++ format :: Any = Documenter.HTML(),
++ clean :: Bool = true,
++ doctest :: Union{Bool,Symbol} = true,
++ linkcheck:: Bool = false,
++ linkcheck_ignore :: Vector = [],
++ checkdocs::Symbol = :all,
++ doctestfilters::Vector{Regex}= Regex[],
++ strict::Bool = false,
++ modules :: Utilities.ModVec = Module[],
++ pages :: Vector = Any[],
++ expandfirst :: Vector = String[],
++ repo :: AbstractString = "",
++ sitename :: AbstractString = "",
++ authors :: AbstractString = "",
++ version :: AbstractString = "",
++ highlightsig::Bool = true,
++ others...
++ )
++ Utilities.check_kwargs(others)
++
++ if !isa(format, AbstractVector)
++ format = Writer[format]
++ end
++
++ if version == "git-commit"
++ version = "git:$(Utilities.get_commit_short(root))"
++ end
++
++ user = User(
++ root,
++ source,
++ build,
++ workdir,
++ format,
++ clean,
++ doctest,
++ linkcheck,
++ linkcheck_ignore,
++ checkdocs,
++ doctestfilters,
++ strict,
++ pages,
++ expandfirst,
++ repo,
++ sitename,
++ authors,
++ version,
++ highlightsig
++ )
++ internal = Internal(
++ Utilities.assetsdir(),
++ Utilities.getremote(root),
++ [],
++ [],
++ Anchors.AnchorMap(),
++ Anchors.AnchorMap(),
++ IdDict{Any,Any}(),
++ IdDict{Any,Any}(),
++ [],
++ [],
++ Dict{Markdown.Link, String}(),
++ Set{Symbol}()
++ )
++
++ plugin_dict = Dict{DataType, Plugin}()
++ if plugins !== nothing
++ for plugin in plugins
++ plugin isa Plugin ||
++ throw(ArgumentError("$(typeof(plugin)) is not a subtype of `Documenter.Plugin`."))
++ haskey(plugin_dict, typeof(plugin)) &&
++ throw(ArgumentError("only one copy of $(typeof(plugin)) may be passed."))
++ plugin_dict[typeof(plugin)] = plugin
++ end
++ end
++
++ blueprint = DocumentBlueprint(
++ Dict{String, Page}(),
++ Utilities.submodules(modules),
++ )
++ Document(user, internal, plugin_dict, blueprint)
++end
++
++"""
++ getplugin(doc::Document, T)
++
++Retrieves the [`Plugin`](@ref Documenter.Plugin) type for `T` stored in `doc`. If `T` was passed to
++[`makedocs`](@ref Documenter.makedocs), the passed type will be returned. Otherwise, a new `T` object
++will be created using the default constructor `T()`.
++"""
++function getplugin(doc::Document, plugin_type::Type{T}) where T <: Plugin
++ if !haskey(doc.plugins, plugin_type)
++ doc.plugins[plugin_type] = plugin_type()
++ end
++
++ doc.plugins[plugin_type]
++end
++
++## Methods
++
++function addpage!(doc::Document, src::AbstractString, dst::AbstractString, wd::AbstractString)
++ page = Page(src, dst, wd)
++ # page's identifier is the path relative to the `doc.user.source` directory
++ name = normpath(relpath(src, doc.user.source))
++ doc.blueprint.pages[name] = page
++end
++
++"""
++$(SIGNATURES)
++
++Populates the `ContentsNode`s and `IndexNode`s of the `document` with links.
++
++This can only be done after all the blocks have been expanded (and nodes constructed),
++because the items have to exist before we can gather the links to those items.
++"""
++function populate!(document::Document)
++ for node in document.internal.contentsnodes
++ populate!(node, document)
++ end
++ for node in document.internal.indexnodes
++ populate!(node, document)
++ end
++end
++
++function populate!(index::IndexNode, document::Document)
++ # Filtering valid index links.
++ for (object, doc) in document.internal.objects
++ page = relpath(doc.page.build, dirname(index.build))
++ mod = object.binding.mod
++ # Include *all* signatures, whether they are `Union{}` or not.
++ cat = Symbol(lowercase(Utilities.doccat(object.binding, Union{})))
++ if _isvalid(page, index.pages) && _isvalid(mod, index.modules) && _isvalid(cat, index.order)
++ push!(index.elements, (object, doc, page, mod, cat))
++ end
++ end
++ # Sorting index links.
++ pagesmap = precedence(index.pages)
++ modulesmap = precedence(index.modules)
++ ordermap = precedence(index.order)
++ comparison = function(a, b)
++ (x = _compare(pagesmap, 3, a, b)) == 0 || return x < 0 # page
++ (x = _compare(modulesmap, 4, a, b)) == 0 || return x < 0 # module
++ (x = _compare(ordermap, 5, a, b)) == 0 || return x < 0 # category
++ string(a[1].binding) < string(b[1].binding) # object name
++ end
++ sort!(index.elements, lt = comparison)
++ return index
++end
++
++function populate!(contents::ContentsNode, document::Document)
++ # Filtering valid contents links.
++ for (id, filedict) in document.internal.headers.map
++ for (file, anchors) in filedict
++ for anchor in anchors
++ page = relpath(anchor.file, dirname(contents.build))
++ if _isvalid(page, contents.pages) && Utilities.header_level(anchor.object) ≤ contents.depth
++ push!(contents.elements, (anchor.order, page, anchor))
++ end
++ end
++ end
++ end
++ # Sorting contents links.
++ pagesmap = precedence(contents.pages)
++ comparison = function(a, b)
++ (x = _compare(pagesmap, 2, a, b)) == 0 || return x < 0 # page
++ a[1] < b[1] # anchor order
++ end
++ sort!(contents.elements, lt = comparison)
++ return contents
++end
++
++# some replacements for jldoctest blocks
++function doctest_replace!(doc::Documents.Document)
++ for (src, page) in doc.blueprint.pages
++ empty!(page.globals.meta)
++ for element in page.elements
++ page.globals.meta[:CurrentFile] = page.source
++ walk(page.globals.meta, page.mapping[element]) do block
++ doctest_replace!(block)
++ end
++ end
++ end
++end
++function doctest_replace!(block::Markdown.Code)
++ startswith(block.language, "jldoctest") || return false
++ # suppress output for `#output`-style doctests with `output=false` kwarg
++ if occursin(r"^# output$"m, block.code) && occursin(r";.*output\h*=\h*false", block.language)
++ input = first(split(block.code, "# output\n", limit = 2))
++ block.code = rstrip(input)
++ end
++ # correct the language field
++ block.language = occursin(r"^julia> "m, block.code) ? "julia-repl" : "julia"
++ return false
++end
++doctest_replace!(block) = true
++
++## Utilities.
++
++function buildnode(T::Type, block, doc, page)
++ mod = get(page.globals.meta, :CurrentModule, Main)
++ dict = Dict{Symbol, Any}(:source => page.source, :build => page.build)
++ for (ex, str) in Utilities.parseblock(block.code, doc, page)
++ if Utilities.isassign(ex)
++ cd(dirname(page.source)) do
++ dict[ex.args[1]] = Core.eval(mod, ex.args[2])
++ end
++ end
++ end
++ T(; dict...)
++end
++
++function _compare(col, ind, a, b)
++ x, y = a[ind], b[ind]
++ haskey(col, x) && haskey(col, y) ? _compare(col[x], col[y]) : 0
++end
++_compare(a, b) = a < b ? -1 : a == b ? 0 : 1
++_isvalid(x, xs) = isempty(xs) || x in xs
++precedence(vec) = Dict(zip(vec, 1:length(vec)))
++
++##############################################
++# walk (previously in the Walkers submodule) #
++##############################################
++"""
++$(SIGNATURES)
++
++Calls `f` on `element` and any of its child elements. `meta` is a `Dict` containing metadata
++such as current module.
++"""
++walk(f, meta, element) = (f(element); nothing)
++
++# Change to the docstring's defining module if it has one. Change back afterwards.
++function walk(f, meta, block::Markdown.MD)
++ tmp = get(meta, :CurrentModule, nothing)
++ mod = get(block.meta, :module, nothing)
++ mod ≡ nothing || (meta[:CurrentModule] = mod)
++ f(block) && walk(f, meta, block.content)
++ tmp ≡ nothing ? delete!(meta, :CurrentModule) : (meta[:CurrentModule] = tmp)
++ nothing
++end
++
++function walk(f, meta, block::Vector)
++ for each in block
++ walk(f, meta, each)
++ end
++end
++
++const MDContentElements = Union{
++ Markdown.BlockQuote,
++ Markdown.Paragraph,
++ Markdown.MD,
++}
++walk(f, meta, block::MDContentElements) = f(block) ? walk(f, meta, block.content) : nothing
++
++const MDTextElements = Union{
++ Markdown.Bold,
++ Markdown.Header,
++ Markdown.Italic,
++}
++walk(f, meta, block::MDTextElements) = f(block) ? walk(f, meta, block.text) : nothing
++walk(f, meta, block::Markdown.Footnote) = f(block) ? walk(f, meta, block.text) : nothing
++walk(f, meta, block::Markdown.Admonition) = f(block) ? walk(f, meta, block.content) : nothing
++walk(f, meta, block::Markdown.Image) = f(block) ? walk(f, meta, block.alt) : nothing
++walk(f, meta, block::Markdown.Table) = f(block) ? walk(f, meta, block.rows) : nothing
++walk(f, meta, block::Markdown.List) = f(block) ? walk(f, meta, block.items) : nothing
++walk(f, meta, block::Markdown.Link) = f(block) ? walk(f, meta, block.text) : nothing
++walk(f, meta, block::RawHTML) = nothing
++walk(f, meta, block::DocsNodes) = walk(f, meta, block.nodes)
++walk(f, meta, block::DocsNode) = walk(f, meta, block.docstr)
++walk(f, meta, block::EvalNode) = walk(f, meta, block.result)
++walk(f, meta, block::MetaNode) = (merge!(meta, block.dict); nothing)
++walk(f, meta, block::Anchors.Anchor) = walk(f, meta, block.object)
++
++end
--- /dev/null
--- /dev/null
++"""
++Defines node "expanders" that transform nodes from the parsed markdown files.
++"""
++module Expanders
++
++import ..Documenter:
++ Anchors,
++ Documents,
++ Documenter,
++ Utilities
++
++import .Documents:
++ MethodNode,
++ DocsNode,
++ DocsNodes,
++ EvalNode,
++ MetaNode
++
++import .Utilities: Selectors
++
++import Markdown, REPL
++import Base64: stringmime
++
++
++function expand(doc::Documents.Document)
++ priority_pages = filter(doc.user.expandfirst) do src
++ if src in keys(doc.blueprint.pages)
++ return true
++ else
++ @warn "$(src) in expandfirst does not exist"
++ return false
++ end
++ end
++ normal_pages = filter(src -> !(src in priority_pages), keys(doc.blueprint.pages))
++ normal_pages = sort([src for src in normal_pages])
++ @debug "pages" keys(doc.blueprint.pages) priority_pages normal_pages
++ for src in Iterators.flatten([priority_pages, normal_pages])
++ page = doc.blueprint.pages[src]
++ @debug "Running ExpanderPipeline on $src"
++ empty!(page.globals.meta)
++ for element in page.elements
++ Selectors.dispatch(ExpanderPipeline, element, page, doc)
++ end
++ pagecheck(page)
++ end
++end
++
++# run some checks after expanding the page
++function pagecheck(page)
++ # make sure there is no "continued code" lingering around
++ if haskey(page.globals.meta, :ContinuedCode) && !isempty(page.globals.meta[:ContinuedCode])
++ @warn "code from a continued @example block unused in $(Utilities.locrepr(page.source))."
++ end
++end
++
++
++# Expander Pipeline.
++# ------------------
++
++"""
++The default node expander "pipeline", which consists of the following expanders:
++
++- [`TrackHeaders`](@ref)
++- [`MetaBlocks`](@ref)
++- [`DocsBlocks`](@ref)
++- [`AutoDocsBlocks`](@ref)
++- [`EvalBlocks`](@ref)
++- [`IndexBlocks`](@ref)
++- [`ContentsBlocks`](@ref)
++- [`ExampleBlocks`](@ref)
++- [`SetupBlocks`](@ref)
++- [`REPLBlocks`](@ref)
++
++"""
++abstract type ExpanderPipeline <: Selectors.AbstractSelector end
++
++"""
++Tracks all `Markdown.Header` nodes found in the parsed markdown files and stores an
++[`Anchors.Anchor`](@ref) object for each one.
++"""
++abstract type TrackHeaders <: ExpanderPipeline end
++
++"""
++Parses each code block where the language is `@meta` and evaluates the key/value pairs found
++within the block, i.e.
++
++````markdown
++```@meta
++CurrentModule = Documenter
++DocTestSetup = quote
++ using Documenter
++end
++```
++````
++"""
++abstract type MetaBlocks <: ExpanderPipeline end
++
++"""
++Parses each code block where the language is `@docs` and evaluates the expressions found
++within the block. Replaces the block with the docstrings associated with each expression.
++
++````markdown
++```@docs
++Documenter
++makedocs
++deploydocs
++```
++````
++"""
++abstract type DocsBlocks <: ExpanderPipeline end
++
++"""
++Parses each code block where the language is `@autodocs` and replaces it with all the
++docstrings that match the provided key/value pairs `Modules = ...` and `Order = ...`.
++
++````markdown
++```@autodocs
++Modules = [Foo, Bar]
++Order = [:function, :type]
++```
++````
++"""
++abstract type AutoDocsBlocks <: ExpanderPipeline end
++
++"""
++Parses each code block where the language is `@eval` and evaluates it's content. Replaces
++the block with the value resulting from the evaluation. This can be useful for inserting
++generated content into a document such as plots.
++
++````markdown
++```@eval
++using PyPlot
++x = linspace(-π, π)
++y = sin(x)
++plot(x, y, color = "red")
++savefig("plot.svg")
++Markdown.parse("")
++```
++````
++"""
++abstract type EvalBlocks <: ExpanderPipeline end
++
++abstract type RawBlocks <: ExpanderPipeline end
++
++"""
++Parses each code block where the language is `@index` and replaces it with an index of all
++docstrings spliced into the document. The pages that are included can be set using a
++key/value pair `Pages = [...]` such as
++
++````markdown
++```@index
++Pages = ["foo.md", "bar.md"]
++```
++````
++"""
++abstract type IndexBlocks <: ExpanderPipeline end
++
++"""
++Parses each code block where the language is `@contents` and replaces it with a nested list
++of all `Header` nodes in the generated document. The pages and depth of the list can be set
++using `Pages = [...]` and `Depth = N` where `N` is and integer.
++
++````markdown
++```@contents
++Pages = ["foo.md", "bar.md"]
++Depth = 1
++```
++````
++The default `Depth` value is `2`.
++"""
++abstract type ContentsBlocks <: ExpanderPipeline end
++
++"""
++Parses each code block where the language is `@example` and evaluates the parsed Julia code
++found within. The resulting value is then inserted into the final document after the source
++code.
++
++````markdown
++```@example
++a = 1
++b = 2
++a + b
++```
++````
++"""
++abstract type ExampleBlocks <: ExpanderPipeline end
++
++"""
++Similar to the [`ExampleBlocks`](@ref) expander, but inserts a Julia REPL prompt before each
++toplevel expression in the final document.
++"""
++abstract type REPLBlocks <: ExpanderPipeline end
++
++"""
++Similar to the [`ExampleBlocks`](@ref) expander, but hides all output in the final document.
++"""
++abstract type SetupBlocks <: ExpanderPipeline end
++
++Selectors.order(::Type{TrackHeaders}) = 1.0
++Selectors.order(::Type{MetaBlocks}) = 2.0
++Selectors.order(::Type{DocsBlocks}) = 3.0
++Selectors.order(::Type{AutoDocsBlocks}) = 4.0
++Selectors.order(::Type{EvalBlocks}) = 5.0
++Selectors.order(::Type{IndexBlocks}) = 6.0
++Selectors.order(::Type{ContentsBlocks}) = 7.0
++Selectors.order(::Type{ExampleBlocks}) = 8.0
++Selectors.order(::Type{REPLBlocks}) = 9.0
++Selectors.order(::Type{SetupBlocks}) = 10.0
++Selectors.order(::Type{RawBlocks}) = 11.0
++
++Selectors.matcher(::Type{TrackHeaders}, node, page, doc) = isa(node, Markdown.Header)
++Selectors.matcher(::Type{MetaBlocks}, node, page, doc) = iscode(node, "@meta")
++Selectors.matcher(::Type{DocsBlocks}, node, page, doc) = iscode(node, "@docs")
++Selectors.matcher(::Type{AutoDocsBlocks}, node, page, doc) = iscode(node, "@autodocs")
++Selectors.matcher(::Type{EvalBlocks}, node, page, doc) = iscode(node, "@eval")
++Selectors.matcher(::Type{IndexBlocks}, node, page, doc) = iscode(node, "@index")
++Selectors.matcher(::Type{ContentsBlocks}, node, page, doc) = iscode(node, "@contents")
++Selectors.matcher(::Type{ExampleBlocks}, node, page, doc) = iscode(node, r"^@example")
++Selectors.matcher(::Type{REPLBlocks}, node, page, doc) = iscode(node, r"^@repl")
++Selectors.matcher(::Type{SetupBlocks}, node, page, doc) = iscode(node, r"^@setup")
++Selectors.matcher(::Type{RawBlocks}, node, page, doc) = iscode(node, r"^@raw")
++
++# Default Expander.
++
++Selectors.runner(::Type{ExpanderPipeline}, x, page, doc) = page.mapping[x] = x
++
++# Track Headers.
++# --------------
++
++function Selectors.runner(::Type{TrackHeaders}, header, page, doc)
++ # Get the header slug.
++ text =
++ if namedheader(header)
++ url = header.text[1].url
++ header.text = header.text[1].text
++ match(NAMEDHEADER_REGEX, url)[1]
++ else
++ sprint(Markdown.plain, Markdown.Paragraph(header.text))
++ end
++ slug = Utilities.slugify(text)
++ # Add the header to the document's header map.
++ anchor = Anchors.add!(doc.internal.headers, header, slug, page.build)
++ # Map the header element to the generated anchor and the current anchor count.
++ page.mapping[header] = anchor
++end
++
++# @meta
++# -----
++
++function Selectors.runner(::Type{MetaBlocks}, x, page, doc)
++ meta = page.globals.meta
++ lines = Utilities.find_block_in_file(x.code, page.source)
++ for (ex, str) in Utilities.parseblock(x.code, doc, page)
++ if Utilities.isassign(ex)
++ try
++ meta[ex.args[1]] = Core.eval(Main, ex.args[2])
++ catch err
++ push!(doc.internal.errors, :meta_block)
++ @warn("""
++ failed to evaluate `$(strip(str))` in `@meta` block in $(Utilities.locrepr(page.source, lines))
++ ```$(x.language)
++ $(x.code)
++ ```
++ """, exception = err)
++ end
++ end
++ end
++ page.mapping[x] = MetaNode(copy(meta))
++end
++
++# @docs
++# -----
++
++function Selectors.runner(::Type{DocsBlocks}, x, page, doc)
++ nodes = Union{DocsNode,Markdown.Admonition}[]
++ curmod = get(page.globals.meta, :CurrentModule, Main)
++ lines = Utilities.find_block_in_file(x.code, page.source)
++ for (ex, str) in Utilities.parseblock(x.code, doc, page)
++ admonition = Markdown.Admonition("warning", "Missing docstring.",
++ Utilities.mdparse("Missing docstring for `$(strip(str))`. Check Documenter's build log for details.", mode=:blocks))
++ binding = try
++ Documenter.DocSystem.binding(curmod, ex)
++ catch err
++ push!(doc.internal.errors, :docs_block)
++ @warn("""
++ unable to get the binding for '$(strip(str))' in `@docs` block in $(Utilities.locrepr(page.source, lines)) from expression '$(repr(ex))' in module $(curmod)
++ ```$(x.language)
++ $(x.code)
++ ```
++ """,
++ exception = err)
++ push!(nodes, admonition)
++ continue
++ end
++ # Undefined `Bindings` get discarded.
++ if !Documenter.DocSystem.iskeyword(binding) && !Documenter.DocSystem.defined(binding)
++ push!(doc.internal.errors, :docs_block)
++ @warn("""
++ undefined binding '$(binding)' in `@docs` block in $(Utilities.locrepr(page.source, lines))
++ ```$(x.language)
++ $(x.code)
++ ```
++ """)
++ push!(nodes, admonition)
++ continue
++ end
++ typesig = Core.eval(curmod, Documenter.DocSystem.signature(ex, str))
++
++ object = Utilities.Object(binding, typesig)
++ # We can't include the same object more than once in a document.
++ if haskey(doc.internal.objects, object)
++ push!(doc.internal.errors, :docs_block)
++ @warn("""
++ duplicate docs found for '$(strip(str))' in `@docs` block in $(Utilities.locrepr(page.source, lines))
++ ```$(x.language)
++ $(x.code)
++ ```
++ """)
++ push!(nodes, admonition)
++ continue
++ end
++
++ # Find the docs matching `binding` and `typesig`. Only search within the provided modules.
++ docs = Documenter.DocSystem.getdocs(binding, typesig; modules = doc.blueprint.modules)
++
++ # Include only docstrings from user-provided modules if provided.
++ if !isempty(doc.blueprint.modules)
++ filter!(d -> d.data[:module] in doc.blueprint.modules, docs)
++ end
++
++ # Check that we aren't printing an empty docs list. Skip block when empty.
++ if isempty(docs)
++ push!(doc.internal.errors, :docs_block)
++ @warn("""
++ no docs found for '$(strip(str))' in `@docs` block in $(Utilities.locrepr(page.source, lines))
++ ```$(x.language)
++ $(x.code)
++ ```
++ """)
++ push!(nodes, admonition)
++ continue
++ end
++
++ # Concatenate found docstrings into a single `MD` object.
++ docstr = Markdown.MD(map(Documenter.DocSystem.parsedoc, docs))
++ docstr.meta[:results] = docs
++
++ # If the first element of the docstring is a code block, make it Julia by default.
++ doc.user.highlightsig && highlightsig!(docstr)
++
++ # Generate a unique name to be used in anchors and links for the docstring.
++ slug = Utilities.slugify(object)
++ anchor = Anchors.add!(doc.internal.docs, object, slug, page.build)
++ docsnode = DocsNode(docstr, anchor, object, page)
++
++ # Track the order of insertion of objects per-binding.
++ push!(get!(doc.internal.bindings, binding, Utilities.Object[]), object)
++
++ doc.internal.objects[object] = docsnode
++ push!(nodes, docsnode)
++ end
++ page.mapping[x] = DocsNodes(nodes)
++end
++
++# @autodocs
++# ---------
++
++const AUTODOCS_DEFAULT_ORDER = [:module, :constant, :type, :function, :macro]
++
++function Selectors.runner(::Type{AutoDocsBlocks}, x, page, doc)
++ curmod = get(page.globals.meta, :CurrentModule, Main)
++ fields = Dict{Symbol, Any}()
++ lines = Utilities.find_block_in_file(x.code, page.source)
++ for (ex, str) in Utilities.parseblock(x.code, doc, page)
++ if Utilities.isassign(ex)
++ try
++ if ex.args[1] == :Filter
++ fields[ex.args[1]] = Core.eval(Main, ex.args[2])
++ else
++ fields[ex.args[1]] = Core.eval(curmod, ex.args[2])
++ end
++ catch err
++ push!(doc.internal.errors, :autodocs_block)
++ @warn("""
++ failed to evaluate `$(strip(str))` in `@autodocs` block in $(Utilities.locrepr(page.source, lines))
++ ```$(x.language)
++ $(x.code)
++ ```
++ """, exception = err)
++ end
++ end
++ end
++ if haskey(fields, :Modules)
++ # Gather and filter docstrings.
++ modules = fields[:Modules]
++ order = get(fields, :Order, AUTODOCS_DEFAULT_ORDER)
++ pages = map(normpath, get(fields, :Pages, []))
++ public = get(fields, :Public, true)
++ private = get(fields, :Private, true)
++ filterfunc = get(fields, :Filter, x -> true)
++ results = []
++ for mod in modules
++ for (binding, multidoc) in Documenter.DocSystem.getmeta(mod)
++ # Which bindings should be included?
++ isexported = Base.isexported(mod, binding.var)
++ included = (isexported && public) || (!isexported && private)
++ # What category does the binding belong to?
++ category = Documenter.DocSystem.category(binding)
++ if category in order && included
++ # filter the elements after category/order has been evaluated
++ # to ensure that e.g. when `Order = [:type]` is given, the filter
++ # function really receives only types
++ filtered = Base.invokelatest(filterfunc, Core.eval(binding.mod, binding.var))
++ if filtered
++ for (typesig, docstr) in multidoc.docs
++ path = normpath(docstr.data[:path])
++ object = Utilities.Object(binding, typesig)
++ if isempty(pages)
++ push!(results, (mod, path, category, object, isexported, docstr))
++ else
++ for p in pages
++ if endswith(path, p)
++ push!(results, (mod, p, category, object, isexported, docstr))
++ break
++ end
++ end
++ end
++ end
++ end
++ end
++ end
++ end
++
++ # Sort docstrings.
++ modulemap = Documents.precedence(modules)
++ pagesmap = Documents.precedence(pages)
++ ordermap = Documents.precedence(order)
++ comparison = function (a, b)
++ local t
++ (t = Documents._compare(modulemap, 1, a, b)) == 0 || return t < 0 # module
++ a[5] == b[5] || return a[5] > b[5] # exported bindings before unexported ones.
++ (t = Documents._compare(pagesmap, 2, a, b)) == 0 || return t < 0 # page
++ (t = Documents._compare(ordermap, 3, a, b)) == 0 || return t < 0 # category
++ string(a[4]) < string(b[4]) # name
++ end
++ sort!(results; lt = comparison)
++
++ # Finalise docstrings.
++ nodes = DocsNode[]
++ for (mod, path, category, object, isexported, docstr) in results
++ if haskey(doc.internal.objects, object)
++ push!(doc.internal.errors, :autodocs_block)
++ @warn("""
++ duplicate docs found for '$(object.binding)' in $(Utilities.locrepr(page.source, lines))
++ ```$(x.language)
++ $(x.code)
++ ```
++ """)
++ continue
++ end
++ markdown = Markdown.MD(Documenter.DocSystem.parsedoc(docstr))
++ markdown.meta[:results] = [docstr]
++ doc.user.highlightsig && highlightsig!(markdown)
++ slug = Utilities.slugify(object)
++ anchor = Anchors.add!(doc.internal.docs, object, slug, page.build)
++ docsnode = DocsNode(markdown, anchor, object, page)
++
++ # Track the order of insertion of objects per-binding.
++ push!(get!(doc.internal.bindings, object.binding, Utilities.Object[]), object)
++
++ doc.internal.objects[object] = docsnode
++ push!(nodes, docsnode)
++ end
++ page.mapping[x] = DocsNodes(nodes)
++ else
++ push!(doc.internal.errors, :autodocs_block)
++ @warn("""
++ '@autodocs' missing 'Modules = ...' in $(Utilities.locrepr(page.source, lines))
++ ```$(x.language)
++ $(x.code)
++ ```
++ """)
++ page.mapping[x] = x
++ end
++end
++
++# @eval
++# -----
++
++function Selectors.runner(::Type{EvalBlocks}, x, page, doc)
++ sandbox = Module(:EvalBlockSandbox)
++ lines = Utilities.find_block_in_file(x.code, page.source)
++ cd(page.workdir) do
++ result = nothing
++ for (ex, str) in Utilities.parseblock(x.code, doc, page; keywords = false)
++ try
++ result = Core.eval(sandbox, ex)
++ catch err
++ push!(doc.internal.errors, :eval_block)
++ @warn("""
++ failed to evaluate `@eval` block in $(Utilities.locrepr(page.source))
++ ```$(x.language)
++ $(x.code)
++ ```
++ """, exception = err)
++ end
++ end
++ page.mapping[x] = EvalNode(x, result)
++ end
++end
++
++# @index
++# ------
++
++function Selectors.runner(::Type{IndexBlocks}, x, page, doc)
++ node = Documents.buildnode(Documents.IndexNode, x, doc, page)
++ push!(doc.internal.indexnodes, node)
++ page.mapping[x] = node
++end
++
++# @contents
++# ---------
++
++function Selectors.runner(::Type{ContentsBlocks}, x, page, doc)
++ node = Documents.buildnode(Documents.ContentsNode, x, doc, page)
++ push!(doc.internal.contentsnodes, node)
++ page.mapping[x] = node
++end
++
++# @example
++# --------
++
++function Selectors.runner(::Type{ExampleBlocks}, x, page, doc)
++ # The sandboxed module -- either a new one or a cached one from this page.
++ name = match(r"^@example[ ]?(.*)$", first(split(x.language, ';', limit = 2)))[1]
++ sym = isempty(name) ? gensym("ex-") : Symbol("ex-", name)
++ mod = get!(() -> get_new_sandbox(sym), page.globals.meta, sym)
++ lines = Utilities.find_block_in_file(x.code, page.source)
++
++ # "parse" keyword arguments to example (we only need to look for continued = true)
++ continued = occursin(r"continued\s*=\s*true", x.language)
++
++ # Evaluate the code block. We redirect stdout/stderr to `buffer`.
++ result, buffer = nothing, IOBuffer()
++ if !continued # run the code
++ # check if there is any code wating
++ if haskey(page.globals.meta, :ContinuedCode) && haskey(page.globals.meta[:ContinuedCode], sym)
++ code = page.globals.meta[:ContinuedCode][sym] * '\n' * x.code
++ delete!(page.globals.meta[:ContinuedCode], sym)
++ else
++ code = x.code
++ end
++ for (ex, str) in Utilities.parseblock(code, doc, page; keywords = false)
++ (value, success, backtrace, text) = Utilities.withoutput() do
++ cd(page.workdir) do
++ Core.eval(mod, ex)
++ end
++ end
++ Core.eval(mod, Expr(:global, Expr(:(=), :ans, QuoteNode(value))))
++ result = value
++ print(buffer, text)
++ if !success
++ push!(doc.internal.errors, :example_block)
++ @warn("""
++ failed to run `@example` block in $(Utilities.locrepr(page.source, lines))
++ ```$(x.language)
++ $(x.code)
++ ```
++ """, value)
++ page.mapping[x] = x
++ return
++ end
++ end
++ else # store the continued code
++ CC = get!(page.globals.meta, :ContinuedCode, Dict())
++ CC[sym] = get(CC, sym, "") * '\n' * x.code
++ end
++ # Splice the input and output into the document.
++ content = []
++ input = droplines(x.code)
++
++ # Generate different in different formats and let each writer select
++ output = Base.invokelatest(Utilities.display_dict, result)
++
++ # Only add content when there's actually something to add.
++ isempty(input) || push!(content, Markdown.Code("julia", input))
++ if result === nothing
++ code = Documenter.DocTests.sanitise(buffer)
++ isempty(code) || push!(content, Markdown.Code(code))
++ elseif !isempty(output)
++ push!(content, output)
++ end
++ # ... and finally map the original code block to the newly generated ones.
++ page.mapping[x] = Documents.MultiOutput(content)
++end
++
++# @repl
++# -----
++
++function Selectors.runner(::Type{REPLBlocks}, x, page, doc)
++ matched = match(r"^@repl[ ]?(.*)$", x.language)
++ matched === nothing && error("invalid '@repl' syntax: $(x.language)")
++ name = matched[1]
++ sym = isempty(name) ? gensym("ex-") : Symbol("ex-", name)
++ mod = get!(() -> get_new_sandbox(sym), page.globals.meta, sym)
++ code = split(x.code, '\n'; limit = 2)[end]
++ result, out = nothing, IOBuffer()
++ for (ex, str) in Utilities.parseblock(x.code, doc, page; keywords = false)
++ buffer = IOBuffer()
++ input = droplines(str)
++ (value, success, backtrace, text) = Utilities.withoutput() do
++ cd(page.workdir) do
++ Core.eval(mod, ex)
++ end
++ end
++ Core.eval(mod, Expr(:global, Expr(:(=), :ans, QuoteNode(value))))
++ result = value
++ output = if success
++ hide = REPL.ends_with_semicolon(input)
++ Documenter.DocTests.result_to_string(buffer, hide ? nothing : value)
++ else
++ Documenter.DocTests.error_to_string(buffer, value, [])
++ end
++ isempty(input) || println(out, prepend_prompt(input))
++ print(out, text)
++ if isempty(input) || isempty(output)
++ println(out)
++ else
++ println(out, output, "\n")
++ end
++ end
++ page.mapping[x] = Markdown.Code("julia-repl", rstrip(String(take!(out))))
++end
++
++# @setup
++# ------
++
++function Selectors.runner(::Type{SetupBlocks}, x, page, doc)
++ matched = match(r"^@setup[ ](.+)$", x.language)
++ matched === nothing && error("invalid '@setup <name>' syntax: $(x.language)")
++ # The sandboxed module -- either a new one or a cached one from this page.
++ name = matched[1]
++ sym = isempty(name) ? gensym("ex-") : Symbol("ex-", name)
++ mod = get!(page.globals.meta, sym, Module(sym))::Module
++
++ # Evaluate whole @setup block at once instead of piecewise
++ page.mapping[x] =
++ try
++ cd(page.workdir) do
++ include_string(mod, x.code)
++ end
++ Markdown.MD([])
++ catch err
++ push!(doc.internal.errors, :setup_block)
++ @warn("""
++ failed to run `@setup` block in $(Utilities.locrepr(page.source))
++ ```$(x.language)
++ $(x.code)
++ ```
++ """, exception=err)
++ x
++ end
++ # ... and finally map the original code block to the newly generated ones.
++ page.mapping[x] = Markdown.MD([])
++end
++
++# @raw
++# ----
++
++function Selectors.runner(::Type{RawBlocks}, x, page, doc)
++ m = match(r"@raw[ ](.+)$", x.language)
++ m === nothing && error("invalid '@raw <name>' syntax: $(x.language)")
++ page.mapping[x] = Documents.RawNode(Symbol(m[1]), x.code)
++end
++
++# Utilities.
++# ----------
++
++iscode(x::Markdown.Code, r::Regex) = occursin(r, x.language)
++iscode(x::Markdown.Code, lang) = x.language == lang
++iscode(x, lang) = false
++
++const NAMEDHEADER_REGEX = r"^@id (.+)$"
++
++function namedheader(h::Markdown.Header)
++ if isa(h.text, Vector) && length(h.text) === 1 && isa(h.text[1], Markdown.Link)
++ url = h.text[1].url
++ occursin(NAMEDHEADER_REGEX, url)
++ else
++ false
++ end
++end
++
++# Remove any `# hide` lines, leading/trailing blank lines, and trailing whitespace.
++function droplines(code; skip = 0)
++ buffer = IOBuffer()
++ for line in split(code, r"\r?\n")[(skip + 1):end]
++ occursin(r"^(.*)#\s*hide$", line) && continue
++ println(buffer, rstrip(line))
++ end
++ strip(String(take!(buffer)), '\n')
++end
++
++function prepend_prompt(input)
++ prompt = "julia> "
++ padding = " "^length(prompt)
++ out = IOBuffer()
++ for (n, line) in enumerate(split(input, '\n'))
++ line = rstrip(line)
++ println(out, n == 1 ? prompt : padding, line)
++ end
++ rstrip(String(take!(out)))
++end
++
++function get_new_sandbox(name::Symbol)
++ m = Module(name)
++ # eval(expr) is available in the REPL (i.e. Main) so we emulate that for the sandbox
++ Core.eval(m, :(eval(x) = Core.eval($m, x)))
++ # modules created with Module() does not have include defined
++ Core.eval(m, :(include(x) = Base.include($m, abspath(x))))
++ return m
++end
++
++highlightsig!(x) = nothing
++function highlightsig!(md::Markdown.MD)
++ isempty(md.content) || highlightsig!(first(md.content))
++end
++function highlightsig!(code::Markdown.Code)
++ if isempty(code.language)
++ code.language = "julia"
++ end
++end
++
++end
--- /dev/null
--- /dev/null
++"""
++Provides a domain specific language for representing HTML documents.
++
++# Examples
++
++```julia
++using Documenter.Utilities.DOM
++
++# `DOM` does not export any HTML tags. Define the ones we actually need.
++@tags div p em strong ul li
++
++div(
++ p("This ", em("is"), " a ", strong("paragraph."),
++ p("And this is ", strong("another"), " one"),
++ ul(
++ li("and"),
++ li("an"),
++ li("unordered"),
++ li("list")
++ )
++)
++```
++
++*Notes*
++
++All the arguments passed to a node are flattened into a single vector rather
++than preserving any nested structure. This means that passing two vectors of
++nodes to a `div` will result in a `div` node with a single vector of children
++(the concatenation of the two vectors) rather than two vector children. The
++only arguments that are not flattened are nested nodes.
++
++String arguments are automatically converted into text nodes. Text nodes do not
++have any children or attributes and when displayed the string is escaped using
++[`escapehtml`](@ref).
++
++# Attributes
++
++As well as plain nodes shown in the previous example, nodes can have attributes
++added to them using the following syntax.
++
++```julia
++div[".my-class"](
++ img[:src => "foo.jpg"],
++ input[\"#my-id\", :disabled]
++)
++```
++
++In the above example we add a `class = "my-class"` attribute to the `div` node,
++a `src = "foo.jpg"` to the `img`, and `id = "my-id" disabled` attributes to the
++`input` node.
++
++The following syntax is supported within `[...]`:
++
++```julia
++tag[\"#id\"]
++tag[".class"]
++tag[\".class#id\"]
++tag[:disabled]
++tag[:src => "foo.jpg"]
++# ... or any combination of the above arguments.
++```
++
++# Internal Representation
++
++The [`@tags`](@ref) macro defines named [`Tag`](@ref) objects as follows
++
++```julia
++@tags div p em strong
++```
++
++expands to
++
++```julia
++const div, p, em, strong = Tag(:div), Tag(:p), Tag(:em), Tag(:strong)
++```
++
++These [`Tag`](@ref) objects are lightweight representations of empty HTML
++elements without any attributes and cannot be used to represent a complete
++document. To create an actual tree of HTML elements that can be rendered we
++need to add some attributes and/or child elements using `getindex` or `call`
++syntax. Applying either to a [`Tag`](@ref) object will construct a new
++[`Node`](@ref) object.
++
++```julia
++tag(...) # No attributes.
++tag[...] # No children.
++tag[...](...) # Has both attributes and children.
++```
++
++All three of the above syntaxes return a new [`Node`](@ref) object. Printing of
++`Node` objects is defined using the standard Julia display functions, so only
++needs a call to `print` to print out a valid HTML document with all nessesary
++text escaped.
++"""
++module DOM
++
++import ..Utilities
++
++tostr(p::Pair) = p
++
++export @tags
++
++#
++# The following sets are based on:
++#
++# - https://developer.mozilla.org/en/docs/Web/HTML/Block-level_elements
++# - https://developer.mozilla.org/en-US/docs/Web/HTML/Inline_elements
++# - https://developer.mozilla.org/en-US/docs/Glossary/empty_element
++#
++const BLOCK_ELEMENTS = Set([
++ :address, :article, :aside, :blockquote, :canvas, :dd, :div, :dl,
++ :fieldset, :figcaption, :figure, :footer, :form, :h1, :h2, :h3, :h4, :h5,
++ :h6, :header, :hgroup, :hr, :li, :main, :nav, :noscript, :ol, :output, :p,
++ :pre, :section, :table, :tfoot, :ul, :video,
++])
++const INLINE_ELEMENTS = Set([
++ :a, :abbr, :acronym, :b, :bdo, :big, :br, :button, :cite, :code, :dfn, :em,
++ :i, :img, :input, :kbd, :label, :map, :object, :q, :samp, :script, :select,
++ :small, :span, :strong, :sub, :sup, :textarea, :time, :tt, :var,
++])
++const VOID_ELEMENTS = Set([
++ :area, :base, :br, :col, :command, :embed, :hr, :img, :input, :keygen,
++ :link, :meta, :param, :source, :track, :wbr,
++])
++const ALL_ELEMENTS = union(BLOCK_ELEMENTS, INLINE_ELEMENTS, VOID_ELEMENTS)
++
++#
++# Empty string as a constant to make equality checks slightly cheaper.
++#
++const EMPTY_STRING = ""
++const TEXT = Symbol(EMPTY_STRING)
++
++"""
++Represents a empty and attribute-less HTML element.
++
++Use [`@tags`](@ref) to define instances of this type rather than manually
++creating them via `Tag(:tagname)`.
++"""
++struct Tag
++ name :: Symbol
++end
++
++Base.show(io::IO, t::Tag) = print(io, "<", t.name, ">")
++
++"""
++Define a collection of [`Tag`](@ref) objects and bind them to constants
++with the same names.
++
++# Examples
++
++Defined globally within a module:
++
++```julia
++@tags div ul li
++```
++
++Defined within the scope of a function to avoid cluttering the global namespace:
++
++```julia
++function template(args...)
++ @tags div ul li
++ # ...
++end
++```
++"""
++macro tags(args...) esc(tags(args)) end
++tags(s) = :(($(s...),) = $(map(Tag, s)))
++
++const Attributes = Vector{Pair{Symbol, String}}
++
++"""
++Represents an element within an HTML document including any textual content,
++children `Node`s, and attributes.
++
++This type should not be constructed directly, but instead via `(...)` and
++`[...]` applied to a [`Tag`](@ref) or another [`Node`](@ref) object.
++"""
++struct Node
++ name :: Symbol
++ text :: String
++ attributes :: Attributes
++ nodes :: Vector{Node}
++
++ Node(name::Symbol, attr::Attributes, data::Vector{Node}) = new(name, EMPTY_STRING, attr, data)
++ Node(text::AbstractString) = new(TEXT, text)
++end
++
++#
++# Syntax for defining `Node` objects from `Tag`s and other `Node` objects.
++#
++(t::Tag)(args...) = Node(t.name, Attributes(), data(args))
++(n::Node)(args...) = Node(n.name, n.attributes, data(args))
++Base.getindex(t::Tag, args...) = Node(t.name, attr(args), Node[])
++Base.getindex(n::Node, args...) = Node(n.name, attr(args), n.nodes)
++
++#
++# Helper methods for the above `Node` "pseudo-constructors".
++#
++data(args) = flatten!(nodes!, Node[], args)
++attr(args) = flatten!(attributes!, Attributes(), args)
++
++#
++# Types that must not be flattened when constructing a `Node`'s child vector.
++#
++const Atom = Union{AbstractString, Node, Pair, Symbol}
++
++"""
++# Signatures
++
++```julia
++flatten!(f!, out, x::Atom)
++flatten!(f!, out, xs)
++```
++
++Flatten the contents the third argument into the second after applying the
++function `f!` to the element.
++"""
++flatten!(f!, out, x::Atom) = f!(out, x)
++flatten!(f!, out, xs) = (for x in xs; flatten!(f!, out, x); end; out)
++
++#
++# Helper methods for handling flattening children elements in `Node` construction.
++#
++nodes!(out, s::AbstractString) = push!(out, Node(s))
++nodes!(out, n::Node) = push!(out, n)
++
++#
++# Helper methods for handling flattening in construction of attribute vectors.
++#
++function attributes!(out, s::AbstractString)
++ class, id = IOBuffer(), IOBuffer()
++ for x in eachmatch(r"[#|\.]([\w\-]+)", s)
++ print(startswith(x.match, '.') ? class : id, x.captures[1], ' ')
++ end
++ position(class) === 0 || push!(out, tostr(:class => rstrip(String(take!(class)))))
++ position(id) === 0 || push!(out, tostr(:id => rstrip(String(take!(id)))))
++ return out
++end
++attributes!(out, s::Symbol) = push!(out, tostr(s => ""))
++attributes!(out, p::Pair) = push!(out, tostr(p))
++
++function Base.show(io::IO, n::Node)
++ if n.name === Symbol("#RAW#")
++ print(io, n.nodes[1].text)
++ elseif n.name === TEXT
++ print(io, escapehtml(n.text))
++ else
++ print(io, '<', n.name)
++ for (name, value) in n.attributes
++ print(io, ' ', name)
++ isempty(value) || print(io, '=', repr(escapehtml(value)))
++ end
++ if n.name in VOID_ELEMENTS
++ print(io, "/>")
++ else
++ print(io, '>')
++ if n.name === :script || n.name === :style
++ isempty(n.nodes) || print(io, n.nodes[1].text)
++ else
++ for each in n.nodes
++ show(io, each)
++ end
++ end
++ print(io, "</", n.name, '>')
++ end
++ end
++end
++
++Base.show(io::IO, ::MIME"text/html", n::Node) = print(io, n)
++
++"""
++Escape characters in the provided string. This converts the following characters:
++
++- `<` to `<`
++- `>` to `>`
++- `&` to `&`
++- `'` to `'`
++- `\"` to `"`
++
++When no escaping is needed then the same object is returned, otherwise a new
++string is constructed with the characters escaped. The returned object should
++always be treated as an immutable copy and compared using `==` rather than `===`.
++"""
++function escapehtml(text::AbstractString)
++ if occursin(r"[<>&'\"]", text)
++ buffer = IOBuffer()
++ for char in text
++ char === '<' ? write(buffer, "<") :
++ char === '>' ? write(buffer, ">") :
++ char === '&' ? write(buffer, "&") :
++ char === '\'' ? write(buffer, "'") :
++ char === '"' ? write(buffer, """) : write(buffer, char)
++ end
++ String(take!(buffer))
++ else
++ text
++ end
++end
++
++"""
++A HTML node that wraps around the root node of the document and adds a DOCTYPE
++to it.
++"""
++mutable struct HTMLDocument
++ doctype :: String
++ root :: Node
++end
++HTMLDocument(root) = HTMLDocument("html", root)
++
++function Base.show(io::IO, doc::HTMLDocument)
++ println(io, "<!DOCTYPE $(doc.doctype)>")
++ println(io, doc.root)
++end
++
++end
--- /dev/null
--- /dev/null
++"""
++Provides the [`mdflatten`](@ref) function that can "flatten" Markdown objects into
++a string, with formatting etc. stripped.
++
++Note that the tests in `test/mdflatten.jl` should be considered to be the spec
++for the output (number of newlines, indents, formatting, etc.).
++"""
++module MDFlatten
++
++export mdflatten
++
++import ..Utilities
++
++import Markdown:
++ MD, BlockQuote, Bold, Code, Header, HorizontalRule,
++ Image, Italic, LaTeX, LineBreak, Link, List, Paragraph, Table,
++ Footnote, Admonition
++
++"""
++Convert a Markdown object to a `String` of only text (i.e. not formatting info).
++
++It drop most of the extra information (e.g. language of a code block, URLs)
++and formatting (e.g. emphasis, headers). This "flattened" representation can
++then be used as input for search engines.
++"""
++function mdflatten(md)
++ io = IOBuffer()
++ mdflatten(io, md)
++ String(take!(io))
++end
++
++mdflatten(io, md) = mdflatten(io, md, md)
++mdflatten(io, md::MD, parent) = mdflatten(io, md.content, md)
++mdflatten(io, vec::Vector, parent) = map(x -> mdflatten(io, x, parent), vec)
++function mdflatten(io, vec::Vector, parent::MD)
++ # this special case separates top level blocks with newlines
++ for md in vec
++ mdflatten(io, md, parent)
++ print(io, "\n\n")
++ end
++end
++
++# Block level MD nodes
++mdflatten(io, h::Header{N}, parent) where {N} = mdflatten(io, h.text, h)
++mdflatten(io, p::Paragraph, parent) = mdflatten(io, p.content, p)
++mdflatten(io, bq::BlockQuote, parent) = mdflatten(io, bq.content, bq)
++mdflatten(io, ::HorizontalRule, parent) = nothing
++function mdflatten(io, list::List, parent)
++ for (idx, li) in enumerate(list.items)
++ for (jdx, x) in enumerate(li)
++ mdflatten(io, x, list)
++ jdx == length(li) || print(io, '\n')
++ end
++ idx == length(list.items) || print(io, '\n')
++ end
++end
++function mdflatten(io, t::Table, parent)
++ for (idx, row) = enumerate(t.rows)
++ for (jdx, x) in enumerate(row)
++ mdflatten(io, x, t)
++ jdx == length(row) || print(io, ' ')
++ end
++ idx == length(t.rows) || print(io, '\n')
++ end
++end
++
++# Inline nodes
++mdflatten(io, text::AbstractString, parent) = print(io, text)
++mdflatten(io, link::Link, parent) = mdflatten(io, link.text, link)
++mdflatten(io, b::Bold, parent) = mdflatten(io, b.text, b)
++mdflatten(io, i::Italic, parent) = mdflatten(io, i.text, i)
++mdflatten(io, i::Image, parent) = print(io, "(Image: $(i.alt))")
++mdflatten(io, m::LaTeX, parent) = print(io, replace(m.formula, r"[^()+\-*^=\w\s]" => ""))
++mdflatten(io, ::LineBreak, parent) = print(io, '\n')
++
++# Is both inline and block
++mdflatten(io, c::Code, parent) = print(io, c.code)
++
++# Special (inline) "node" -- due to JuliaMark's interpolations
++mdflatten(io, expr::Union{Symbol,Expr}, parent) = print(io, expr)
++
++mdflatten(io, f::Footnote, parent) = footnote(io, f.id, f.text, f)
++footnote(io, id, text::Nothing, parent) = print(io, "[$id]")
++function footnote(io, id, text, parent)
++ print(io, "[$id]: ")
++ mdflatten(io, text, parent)
++end
++
++function mdflatten(io, a::Admonition, parent)
++ println(io, "$(a.category): $(a.title)")
++ mdflatten(io, a.content, a)
++end
++
++end
--- /dev/null
--- /dev/null
++"""
++Provides types and functions to work with Markdown syntax trees.
++
++The module is similar to the [Markdown standard library](https://docs.julialang.org/en/v1/stdlib/Markdown/),
++but aims to be stricter and provide a more well-defined API.
++
++!!! note
++ Markdown2 does not provide a parser, just a data structure to represent Markdown ASTs.
++
++# Markdown nodes
++
++The types in this module represent the different types of nodes you can have in a Markdown
++abstract syntax tree (AST). Currently it supports all the nodes necessary to represent Julia
++flavored Markdown. But having this as a separate module from the Markdown standard library
++allows us to consistently extend the node type we support (e.g. to support the raw HTML
++nodes from [CommonMark](https://spec.commonmark.org/0.29/#raw-html), or strikethrough text
++from [GitHub Flavored Markdown](https://github.github.com/gfm/#strikethrough-extension-)).
++
++Markdown nodes split into to two different classes: [block nodes and inline
++nodes](https://spec.commonmark.org/0.29/#blocks-and-inlines). Generally, the direct children
++of a particular node can only be either inline or block (e.g. paragraphs contain inline
++nodes, admonitions contain block nodes as direct children).
++
++In Markdown2, this is represented using a simple type hierarchy. All Markdown nodes are
++subtypes of either the [`MarkdownBlockNode`](@ref) or the [`MarkdownInlineNode`](@ref)
++abstract type. Both of these abstract types themselves are a subtype of the
++[`MarkdownNode`](@ref).
++
++# Additional methods
++
++* The `Base.convert(::Type{Markdown2.MD}, md::Markdown.MD)` method can be used to convert
++ the Julia Markdown standard libraries ASTs into Markdown2 ASTs.
++* The [`walk`](@ref) function can be used for walking over a [`Markdown2.MD`](@ref) tree.
++"""
++module Markdown2
++using DocStringExtensions
++import Markdown
++
++
++# Abstract type hierarchy for Markdown nodes
++# ==========================================
++"""
++ abstract type MarkdownNode
++
++Supertype for all Markdown nodes.
++"""
++abstract type MarkdownNode end
++
++"""
++ abstract type MarkdownBlockNode <: MarkdownNode
++
++Supertype for all block-level Markdown nodes.
++"""
++abstract type MarkdownBlockNode <: MarkdownNode end
++
++"""
++ abstract type MarkdownInlineNode <: MarkdownNode
++
++Supertype for all inline Markdown nodes.
++"""
++abstract type MarkdownInlineNode <: MarkdownNode end
++
++# Concrete types representing markdown nodes
++# ==========================================
++"""
++ struct MD
++
++The root node of a Markdown document. Its children are a list of top-level block-type nodes.
++Note that `MD` is not a subtype of `MarkdownNode`.
++"""
++struct MD
++ nodes :: Vector{MarkdownBlockNode}
++
++ MD(content::AbstractVector) = new(content)
++end
++MD() = MD([])
++
++# Forward some array methods
++Base.push!(md::MD, x) = push!(md.nodes, x)
++Base.getindex(md::MD, args...) = md.nodes[args...]
++Base.setindex!(md::MD, args...) = setindex!(md.nodes, args...)
++Base.lastindex(md::MD) = endof(md.nodes)
++Base.length(md::MD) = length(md.nodes)
++Base.isempty(md::MD) = isempty(md.nodes)
++
++
++# Block nodes
++# -----------
++"""
++ struct ThematicBreak <: MarkdownBlockNode
++
++A block node represeting a thematic break (a `<hr>` tag).
++"""
++struct ThematicBreak <: MarkdownBlockNode end
++
++struct Heading <: MarkdownBlockNode
++ level :: Int
++ nodes :: Vector{MarkdownInlineNode}
++
++ function Heading(level::Integer, nodes::Vector{MarkdownInlineNode})
++ @assert 1 <= level <= 6 # TODO: error message
++ new(level, nodes)
++ end
++end
++
++struct CodeBlock <: MarkdownBlockNode
++ language :: String
++ code :: String
++end
++
++#struct HTMLBlock <: MarkdownBlockNode end # the parser in Base does not support this currently
++#struct LinkDefinition <: MarkdownBlockNode end # the parser in Base does not support this currently
++
++"""
++ struct Paragraph <: MarkdownBlockNode
++
++Represents a paragraph block-type node. Its children are inline nodes.
++"""
++struct Paragraph <: MarkdownBlockNode
++ nodes :: Vector{MarkdownInlineNode}
++end
++
++## Container blocks
++struct BlockQuote <: MarkdownBlockNode
++ nodes :: Vector{MarkdownBlockNode}
++end
++
++"""
++ struct List <: MarkdownBlockNode
++
++If `.orderedstart` is `nothing` then the list is unordered. Otherwise is specifies the first
++number in the list.
++"""
++struct List <: MarkdownBlockNode
++ tight :: Bool
++ orderedstart :: Union{Int, Nothing}
++ items :: Vector{Vector{MarkdownBlockNode}} # TODO: Better types?
++end
++
++# Non-Commonmark extensions
++struct DisplayMath <: MarkdownBlockNode
++ formula :: String
++end
++
++struct Footnote <: MarkdownBlockNode
++ id :: String
++ nodes :: Vector{MarkdownBlockNode} # Footnote is a container block
++end
++
++struct Table <: MarkdownBlockNode
++ align :: Vector{Symbol}
++ cells :: Array{Vector{MarkdownInlineNode}, 2} # TODO: better type?
++ # Note: Table is _not_ a container type -- the cells can only contan inlines.
++end
++
++struct Admonition <: MarkdownBlockNode
++ category :: String
++ title :: String
++ nodes :: Vector{MarkdownBlockNode} # Admonition is a container block
++end
++
++# Inline nodes
++# ------------
++
++struct Text <: MarkdownInlineNode
++ text :: String
++end
++
++struct CodeSpan <: MarkdownInlineNode
++ code :: String
++end
++
++struct Emphasis <: MarkdownInlineNode
++ nodes :: Vector{MarkdownInlineNode}
++end
++
++struct Strong <: MarkdownInlineNode
++ nodes :: Vector{MarkdownInlineNode}
++end
++
++struct Link <: MarkdownInlineNode
++ destination :: String
++ #title :: String # the parser in Base does not support this currently
++ nodes :: Vector{MarkdownInlineNode}
++end
++
++struct Image <: MarkdownInlineNode
++ destination :: String
++ description :: String
++ #title :: String # the parser in Base does not support this currently
++ #nodes :: Vector{MarkdownInlineNode} # the parser in Base does not parse the description currently
++end
++#struct InlineHTML <: MarkdownInlineNode end # the parser in Base does not support this currently
++struct LineBreak <: MarkdownInlineNode end
++
++# Non-Commonmark extensions
++struct InlineMath <: MarkdownInlineNode
++ formula :: String
++end
++
++struct FootnoteReference <: MarkdownInlineNode
++ id :: String
++end
++
++
++# Conversion methods
++# ==================
++"""
++ convert(::Type{MD}, md::Markdown.MD) -> Markdown2.MD
++
++Converts a Markdown standard library AST into a Markdown2 AST.
++"""
++function Base.convert(::Type{MD}, md::Markdown.MD)
++ nodes = map(_convert_block, md.content)
++ MD(nodes)
++end
++
++_convert_block(xs::Vector) = MarkdownBlockNode[_convert_block(x) for x in xs]
++_convert_block(b::Markdown.HorizontalRule) = ThematicBreak()
++_convert_block(b::Markdown.Header{N}) where N = Heading(N, _convert_inline(b.text))
++_convert_block(b::Markdown.Code) = CodeBlock(b.language, b.code)
++_convert_block(b::Markdown.Paragraph) = Paragraph(_convert_inline(b.content))
++_convert_block(b::Markdown.BlockQuote) = BlockQuote(_convert_block(b.content))
++function _convert_block(b::Markdown.List)
++ tight = all(isequal(1), length.(b.items))
++ orderedstart = (b.ordered == -1) ? nothing : b.ordered
++ List(tight, orderedstart, _convert_block.(b.items))
++end
++
++# Non-Commonmark extensions
++_convert_block(b::Markdown.LaTeX) = DisplayMath(b.formula)
++_convert_block(b::Markdown.Footnote) = Footnote(b.id, _convert_block(b.text))
++function _convert_block(b::Markdown.Table)
++ @assert all(isequal(length(b.align)), length.(b.rows)) # TODO: error
++ cells = [_convert_inline(b.rows[i][j]) for i = 1:length(b.rows), j = 1:length(b.align)]
++ Table(
++ b.align,
++ [_convert_inline(b.rows[i][j]) for i = 1:length(b.rows), j = 1:length(b.align)]
++ )
++end
++_convert_block(b::Markdown.Admonition) = Admonition(b.category, b.title, _convert_block(b.content))
++
++
++_convert_inline(xs::Vector) = MarkdownInlineNode[_convert_inline(x) for x in xs]
++_convert_inline(s::String) = Text(s)
++function _convert_inline(s::Markdown.Code)
++ @assert isempty(s.language) # TODO: error
++ CodeSpan(s.code)
++end
++_convert_inline(s::Markdown.Bold) = Strong(_convert_inline(s.text))
++_convert_inline(s::Markdown.Italic) = Emphasis(_convert_inline(s.text))
++function _convert_inline(s::Markdown.Link)
++ text = _convert_inline(s.text)
++ # Autolinks (the `<URL>` syntax) yield Link objects where .text is just a String
++ nodes = isa(text, AbstractVector) ? text : [text]
++ Link(s.url, nodes)
++end
++_convert_inline(s::Markdown.Image) = Image(s.url, s.alt)
++# struct InlineHTML <: MarkdownInlineNode end # the parser in Base does not support this currently
++_convert_inline(::Markdown.LineBreak) = LineBreak()
++
++# Non-Commonmark extensions
++_convert_inline(s::Markdown.LaTeX) = InlineMath(s.formula)
++function _convert_inline(s::Markdown.Footnote)
++ @assert s.text === nothing # footnote references should not have any content, TODO: error
++ FootnoteReference(s.id)
++end
++
++
++# walk() function
++# ===============
++"""
++ walk(f, element)
++
++Calls `f(element)` on `element` and any of its child elements. The elements are assumed to
++be [`Markdown2`](@ref) elements.
++"""
++function walk end
++
++function walk(f, node::T) where {T <: Union{MarkdownNode, MD}}
++ f(node) || return
++ if :nodes in fieldnames(T)
++ walk(f, node.nodes)
++ end
++ return
++end
++
++function walk(f, nodes::Vector)
++ for node in nodes
++ walk(f, node)
++ end
++end
++
++function walk(f, list::List)
++ f(list) || return
++ for item in list.items
++ walk(f, item)
++ end
++end
++
++function walk(f, table::Table)
++ f(table) || return
++ for cell in table.cells
++ walk(f, cell)
++ end
++end
++end
--- /dev/null
--- /dev/null
++"""
++An extensible code selection interface.
++
++The `Selectors` module provides an extensible way to write code that has to dispatch on
++different predicates without hardcoding the control flow into a single chain of `if`
++statements.
++
++In the following example a selector for a simple condition is implemented and the generated
++selector code is described:
++
++```julia
++abstract type MySelector <: Selectors.AbstractSelector end
++
++# The different cases we want to test.
++abstract type One <: MySelector end
++abstract type NotOne <: MySelector end
++
++# The order in which to test the cases.
++Selectors.order(::Type{One}) = 0.0
++Selectors.order(::Type{NotOne}) = 1.0
++
++# The predicate to test against.
++Selectors.matcher(::Type{One}, x) = x === 1
++Selectors.matcher(::Type{NotOne}, x) = x !== 1
++
++# What to do when a test is successful.
++Selectors.runner(::Type{One}, x) = println("found one")
++Selectors.runner(::Type{NotOne}, x) = println("not found")
++
++# Test our selector with some numbers.
++for i in 0:5
++ Selectors.dispatch(MySelector, i)
++end
++```
++
++`Selectors.dispatch(Selector, i)` will behave equivalent to the following:
++
++```julia
++function dispatch(::Type{MySelector}, i::Int)
++ if matcher(One, i)
++ runner(One, i)
++ elseif matcher(NotOne, i)
++ runner(NotOne, i)
++ end
++end
++```
++
++and further to
++
++```julia
++function dispatch(::Type{MySelector}, i::Int)
++ if i === 1
++ println("found one")
++ elseif i !== 1
++ println("not found")
++ end
++end
++```
++
++The module provides the following interface for creating selectors:
++
++- [`order`](@ref)
++- [`matcher`](@ref)
++- [`runner`](@ref)
++- [`strict`](@ref)
++- [`disable`](@ref)
++- [`dispatch`](@ref)
++
++"""
++module Selectors
++
++import InteractiveUtils: subtypes
++
++"""
++Root selector type. Each user-defined selector must subtype from this, i.e.
++
++```julia
++abstract type MySelector <: Selectors.AbstractSelector end
++
++abstract type First <: MySelector end
++abstract type Second <: MySelector end
++```
++"""
++abstract type AbstractSelector end
++
++"""
++Define the precedence of each case in a selector, i.e.
++
++```julia
++Selectors.order(::Type{First}) = 1.0
++Selectors.order(::Type{Second}) = 2.0
++```
++
++Note that the return type must be `Float64`. Defining multiple case types to have the same
++order will result in undefined behaviour.
++"""
++function order end
++
++"""
++Define the matching test for each case in a selector, i.e.
++
++```julia
++Selectors.matcher(::Type{First}, x) = x == 1
++Selectors.matcher(::Type{Second}, x) = true
++```
++
++Note that the return type must be `Bool`.
++
++To match against multiple cases use the [`Selectors.strict`](@ref) function.
++"""
++function matcher end
++
++"""
++Define the code that will run when a particular [`Selectors.matcher`](@ref) test returns
++`true`, i.e.
++
++```julia
++Selectors.runner(::Type{First}, x) = println("`x` is equal to `1`.")
++Selectors.runner(::Type{Second}, x) = println("`x` is not equal to `1`.")
++```
++"""
++function runner end
++
++"""
++Define whether a selector case will "fallthrough" or not when successfully matched against.
++By default matching is strict and does not fallthrough to subsequent selector cases.
++
++```julia
++# Adding a debugging selector case.
++abstract type Debug <: MySelector end
++
++# Insert prior to all other cases.
++Selectors.order(::Type{Debug}) = 0.0
++
++# Fallthrough to the next case on success.
++Selectors.strict(::Type{Debug}) = false
++
++# We always match, regardless of the value of `x`.
++Selectors.matcher(::Type{Debug}, x) = true
++
++# Print some debugging info.
++Selectors.runner(::Type{Debug}, x) = @show x
++```
++"""
++strict(::Type{T}) where {T <: AbstractSelector} = true
++
++"""
++Disable a particular case in a selector so that it is never used.
++
++```julia
++Selectors.disable(::Type{Debug}) = true
++```
++"""
++disable(::Type{T}) where {T <: AbstractSelector} = false
++
++"""
++Call `Selectors.runner(T, args...)` where `T` is a subtype of
++`MySelector` for which `matcher(T, args...)` is `true`.
++
++```julia
++Selectors.dispatch(MySelector, args...)
++```
++"""
++function dispatch(::Type{T}, x...) where T <: AbstractSelector
++ for t in (sort(subtypes(T); by = order))
++ if !disable(t) && matcher(t, x...)
++ runner(t, x...)
++ strict(t) && return
++ end
++ end
++ runner(T, x...)
++end
++
++end
--- /dev/null
--- /dev/null
++module TextDiff
++
++using DocStringExtensions
++
++# Utilities.
++
++function lcs(old_tokens::Vector, new_tokens::Vector)
++ m = length(old_tokens)
++ n = length(new_tokens)
++ weights = zeros(Int, m + 1, n + 1)
++ for i = 2:(m + 1), j = 2:(n + 1)
++ weights[i, j] = old_tokens[i - 1] == new_tokens[j - 1] ?
++ weights[i - 1, j - 1] + 1 : max(weights[i, j - 1], weights[i - 1, j])
++ end
++ return weights
++end
++
++function makediff(weights::Matrix, old_tokens::Vector, new_tokens::Vector)
++ m = length(old_tokens)
++ n = length(new_tokens)
++ diff = Vector{Pair{Symbol, SubString{String}}}()
++ makediff!(diff, weights, old_tokens, new_tokens, m + 1, n + 1)
++ return diff
++end
++
++function makediff!(out, weights, X, Y, i, j)
++ if i > 1 && j > 1 && X[i - 1] == Y[j - 1]
++ makediff!(out, weights, X, Y, i - 1, j - 1)
++ push!(out, :normal => X[i - 1])
++ else
++ if j > 1 && (i == 1 || weights[i, j - 1] >= weights[i - 1, j])
++ makediff!(out, weights, X, Y, i, j - 1)
++ push!(out, :green => Y[j - 1])
++ elseif i > 1 && (j == 1 || weights[i, j - 1] < weights[i - 1, j])
++ makediff!(out, weights, X, Y, i - 1, j)
++ push!(out, :red => X[i - 1])
++ end
++ end
++ return out
++end
++
++"""
++$(SIGNATURES)
++
++Splits `text` at `regex` matches, returning an array of substrings. The parts of the string
++that match the regular expression are also included at the ends of the returned strings.
++"""
++function splitby(reg::Regex, text::AbstractString)
++ out = SubString{String}[]
++ token_first = 1
++ for each in eachmatch(reg, text)
++ token_last = each.offset + lastindex(each.match) - 1
++ push!(out, SubString(text, token_first, token_last))
++ token_first = nextind(text, token_last)
++ end
++ laststr = SubString(text, token_first)
++ isempty(laststr) || push!(out, laststr)
++ return out
++end
++
++# Diff Type.
++
++struct Lines end
++struct Words end
++
++splitter(::Type{Lines}) = r"\n"
++splitter(::Type{Words}) = r"\s+"
++
++struct Diff{T}
++ old_tokens::Vector{SubString{String}}
++ new_tokens::Vector{SubString{String}}
++ weights::Matrix{Int}
++ diff::Vector{Pair{Symbol, SubString{String}}}
++
++ function Diff{T}(old_text::AbstractString, new_text::AbstractString) where T
++ reg = splitter(T)
++ old_tokens = splitby(reg, old_text)
++ new_tokens = splitby(reg, new_text)
++ weights = lcs(old_tokens, new_tokens)
++ diff = makediff(weights, old_tokens, new_tokens)
++ return new{T}(old_tokens, new_tokens, weights, diff)
++ end
++end
++
++# Display.
++
++prefix(::Diff{Lines}, s::Symbol) = s === :green ? "+ " : s === :red ? "- " : " "
++prefix(::Diff{Words}, ::Symbol) = ""
++
++function Base.show(io::IO, diff::Diff)
++ get(io, :color, false) || println(io, "Warning: Diff output requires color.")
++ for (color, text) in diff.diff
++ printstyled(io, prefix(diff, color), text, color=color)
++ end
++end
++
++end
--- /dev/null
--- /dev/null
++"""
++Provides a collection of utility functions and types that are used in other submodules.
++"""
++module Utilities
++
++using Base.Meta
++import Base: isdeprecated, Docs.Binding
++using DocStringExtensions
++import Markdown, LibGit2
++import Base64: stringmime
++
++# escape characters that has a meaning in regex
++regex_escape(str) = sprint(escape_string, str, "\\^\$.|?*+()[{")
++
++# helper to display linerange for error printing
++function find_block_in_file(code, file)
++ source_file = Base.find_source_file(file)
++ source_file === nothing && return nothing
++ isfile(source_file) || return nothing
++ content = read(source_file, String)
++ content = replace(content, "\r\n" => "\n")
++ # make a regex of the code that matches leading whitespace
++ rcode = "\\h*" * replace(regex_escape(code), "\\n" => "\\n\\h*")
++ blockidx = findfirst(Regex(rcode), content)
++ blockidx === nothing && return nothing
++ startline = countlines(IOBuffer(content[1:prevind(content, first(blockidx))]))
++ endline = startline + countlines(IOBuffer(code)) + 1 # +1 to include the closing ```
++ return ":$(startline)-$(endline)"
++end
++
++# Pretty-printing locations
++function locrepr(file, line=nothing)
++ str = Base.contractuser(file) # TODO: Maybe print this relative the doc-root??
++ line !== nothing && (str = str * "$(line)")
++ return str
++end
++
++# Directory paths.
++
++"""
++Returns the current directory.
++"""
++function currentdir()
++ d = Base.source_dir()
++ d === nothing ? pwd() : d
++end
++
++"""
++Returns the path to the Documenter `assets` directory.
++"""
++assetsdir() = normpath(joinpath(dirname(@__FILE__), "..", "..", "assets"))
++
++cleandir(d::AbstractString) = (isdir(d) && rm(d, recursive = true); mkdir(d))
++
++"""
++Find the path of a file relative to the `source` directory. `root` is the path
++to the directory containing the file `file`.
++
++It is meant to be used with `walkdir(source)`.
++"""
++srcpath(source, root, file) = normpath(joinpath(relpath(root, source), file))
++
++# Slugify text.
++
++"""
++Slugify a string into a suitable URL.
++"""
++function slugify(s::AbstractString)
++ s = replace(s, r"\s+" => "-")
++ s = replace(s, r"^\d+" => "")
++ s = replace(s, r"&" => "-and-")
++ s = replace(s, r"[^\p{L}\p{P}\d\-]+" => "")
++ s = strip(replace(s, r"\-\-+" => "-"), '-')
++end
++slugify(object) = string(object) # Non-string slugifying doesn't do anything.
++
++# Parse code blocks.
++
++"""
++Returns a vector of parsed expressions and their corresponding raw strings.
++
++Returns a `Vector` of tuples `(expr, code)`, where `expr` is the corresponding expression
++(e.g. a `Expr` or `Symbol` object) and `code` is the string of code the expression was
++parsed from.
++
++The keyword argument `skip = N` drops the leading `N` lines from the input string.
++
++If `raise=false` is passed, the `Meta.parse` does not raise an exception on parse errors,
++but instead returns an expression that will raise an error when evaluated. `parseblock`
++returns this expression normally and it must be handled appropriately by the caller.
++"""
++function parseblock(code::AbstractString, doc, file; skip = 0, keywords = true, raise=true)
++ # Drop `skip` leading lines from the code block. Needed for deprecated `{docs}` syntax.
++ code = string(code, '\n')
++ code = last(split(code, '\n', limit = skip + 1))
++ endofstr = lastindex(code)
++ results = []
++ cursor = 1
++ while cursor < endofstr
++ # Check for keywords first since they will throw parse errors if we `parse` them.
++ line = match(r"^(.*)\r?\n"m, SubString(code, cursor)).match
++ keyword = Symbol(strip(line))
++ (ex, ncursor) =
++ # TODO: On 0.7 Symbol("") is in Docs.keywords, remove that check when dropping 0.6
++ if keywords && (haskey(Docs.keywords, keyword) || keyword == Symbol(""))
++ (QuoteNode(keyword), cursor + lastindex(line))
++ else
++ try
++ Meta.parse(code, cursor; raise=raise)
++ catch err
++ push!(doc.internal.errors, :parse_error)
++ @warn "failed to parse exception in $(Utilities.locrepr(file))" exception = err
++ break
++ end
++ end
++ str = SubString(code, cursor, prevind(code, ncursor))
++ if !isempty(strip(str))
++ push!(results, (ex, str))
++ end
++ cursor = ncursor
++ end
++ results
++end
++isassign(x) = isexpr(x, :(=), 2) && isa(x.args[1], Symbol)
++
++# Checking arguments.
++
++"""
++Prints a formatted warning to the user listing unrecognised keyword arguments.
++"""
++function check_kwargs(kws)
++ isempty(kws) && return
++ out = IOBuffer()
++ println(out, "Unknown keywords:\n")
++ for (k, v) in kws
++ println(out, " ", k, " = ", v)
++ end
++ @warn(String(take!(out)))
++end
++
++# Finding submodules.
++
++const ModVec = Union{Module, Vector{Module}}
++
++"""
++Returns the set of submodules of a given root module/s.
++"""
++function submodules(modules::Vector{Module})
++ out = Set{Module}()
++ for each in modules
++ submodules(each, out)
++ end
++ out
++end
++function submodules(root::Module, seen = Set{Module}())
++ push!(seen, root)
++ for name in names(root, all=true)
++ if Base.isidentifier(name) && isdefined(root, name) && !isdeprecated(root, name)
++ object = getfield(root, name)
++ if isa(object, Module) && !(object in seen) && parentmodule(object::Module) == root
++ submodules(object, seen)
++ end
++ end
++ end
++ return seen
++end
++
++
++
++## objects
++## =======
++
++
++
++"""
++Represents an object stored in the docsystem by its binding and signature.
++"""
++struct Object
++ binding :: Binding
++ signature :: Type
++
++ function Object(b::Binding, signature::Type)
++ m = nameof(b.mod) === b.var ? parentmodule(b.mod) : b.mod
++ new(Binding(m, b.var), signature)
++ end
++end
++
++function splitexpr(x::Expr)
++ isexpr(x, :macrocall) ? splitexpr(x.args[1]) :
++ isexpr(x, :.) ? (x.args[1], x.args[2]) :
++ error("Invalid @var syntax `$x`.")
++end
++splitexpr(s::Symbol) = :(Main), quot(s)
++splitexpr(other) = error("Invalid @var syntax `$other`.")
++
++"""
++ object(ex, str)
++
++Returns a expression that, when evaluated, returns an [`Object`](@ref) representing `ex`.
++"""
++function object(ex::Union{Symbol, Expr}, str::AbstractString)
++ binding = Expr(:call, Binding, splitexpr(Docs.namify(ex))...)
++ signature = Base.Docs.signature(ex)
++ isexpr(ex, :macrocall, 2) && !endswith(str, "()") && (signature = :(Union{}))
++ Expr(:call, Object, binding, signature)
++end
++
++function object(qn::QuoteNode, str::AbstractString)
++ if haskey(Base.Docs.keywords, qn.value)
++ binding = Expr(:call, Binding, Main, qn)
++ Expr(:call, Object, binding, Union{})
++ else
++ error("'$(qn.value)' is not a documented keyword.")
++ end
++end
++
++function Base.print(io::IO, obj::Object)
++ print(io, obj.binding)
++ print_signature(io, obj.signature)
++end
++print_signature(io::IO, signature::Union{Union, Type{Union{}}}) = nothing
++print_signature(io::IO, signature) = print(io, '-', signature)
++
++## docs
++## ====
++
++"""
++ docs(ex, str)
++
++Returns an expression that, when evaluated, returns the docstrings associated with `ex`.
++"""
++function docs end
++
++# Macro representation changed between 0.4 and 0.5.
++function docs(ex::Union{Symbol, Expr}, str::AbstractString)
++ isexpr(ex, :macrocall, 2) && !endswith(rstrip(str), "()") && (ex = quot(ex))
++ :(Base.Docs.@doc $ex)
++end
++docs(qn::QuoteNode, str::AbstractString) = :(Base.Docs.@doc $(qn.value))
++
++"""
++Returns the category name of the provided [`Object`](@ref).
++"""
++doccat(obj::Object) = startswith(string(obj.binding.var), '@') ?
++ "Macro" : doccat(obj.binding, obj.signature)
++
++function doccat(b::Binding, ::Union{Union, Type{Union{}}})
++ if b.mod === Main && haskey(Base.Docs.keywords, b.var)
++ "Keyword"
++ elseif startswith(string(b.var), '@')
++ "Macro"
++ else
++ doccat(getfield(b.mod, b.var))
++ end
++end
++
++doccat(b::Binding, ::Type) = "Method"
++
++doccat(::Function) = "Function"
++doccat(::DataType) = "Type"
++doccat(x::UnionAll) = doccat(Base.unwrap_unionall(x))
++doccat(::Module) = "Module"
++doccat(::Any) = "Constant"
++
++"""
++ filterdocs(doc, modules)
++
++Remove docstrings from the markdown object, `doc`, that are not from one of `modules`.
++"""
++function filterdocs(doc::Markdown.MD, modules::Set{Module})
++ if isempty(modules)
++ # When no modules are specified in `makedocs` then don't filter anything.
++ doc
++ else
++ if haskey(doc.meta, :module)
++ doc.meta[:module] ∈ modules ? doc : nothing
++ else
++ if haskey(doc.meta, :results)
++ out = []
++ results = []
++ for (each, result) in zip(doc.content, doc.meta[:results])
++ r = filterdocs(each, modules)
++ if r !== nothing
++ push!(out, r)
++ push!(results, result)
++ end
++ end
++ if isempty(out)
++ nothing
++ else
++ md = Markdown.MD(out)
++ md.meta[:results] = results
++ md
++ end
++ else
++ out = []
++ for each in doc.content
++ r = filterdocs(each, modules)
++ r === nothing || push!(out, r)
++ end
++ isempty(out) ? nothing : Markdown.MD(out)
++ end
++ end
++ end
++end
++# Non-markdown docs won't have a `.meta` field so always just accept those.
++filterdocs(other, modules::Set{Module}) = other
++
++"""
++Does the given docstring represent actual documentation or a no docs error message?
++"""
++nodocs(x) = occursin("No documentation found.", stringmime("text/plain", x))
++nodocs(::Nothing) = false
++
++header_level(::Markdown.Header{N}) where {N} = N
++
++"""
++ repo_root(file; dbdir=".git")
++
++Tries to determine the root directory of the repository containing `file`. If the file is
++not in a repository, the function returns `nothing`.
++
++The `dbdir` keyword argument specifies the name of the directory we are searching for to
++determine if this is a repostory or not. If there is a file called `dbdir`, then it's
++contents is checked under the assumption that it is a Git worktree or a submodule.
++"""
++function repo_root(file; dbdir=".git")
++ parent_dir, parent_dir_last = dirname(abspath(file)), ""
++ while parent_dir != parent_dir_last
++ dbdir_path = joinpath(parent_dir, dbdir)
++ isdir(dbdir_path) && return parent_dir
++ # Let's see if this is a worktree checkout
++ if isfile(dbdir_path)
++ contents = chomp(read(dbdir_path, String))
++ if startswith(contents, "gitdir: ")
++ if isdir(joinpath(parent_dir, contents[9:end]))
++ return parent_dir
++ end
++ end
++ end
++ parent_dir, parent_dir_last = dirname(parent_dir), parent_dir
++ end
++ return nothing
++end
++
++"""
++ $(SIGNATURES)
++
++Returns the path of `file`, relative to the root of the Git repository, or `nothing` if the
++file is not in a Git repository.
++"""
++function relpath_from_repo_root(file)
++ cd(dirname(file)) do
++ root = repo_root(file)
++ root !== nothing && startswith(file, root) ? relpath(file, root) : nothing
++ end
++end
++
++function repo_commit(file)
++ cd(dirname(file)) do
++ readchomp(`git rev-parse HEAD`)
++ end
++end
++
++function url(repo, file; commit=nothing)
++ file = realpath(abspath(file))
++ remote = getremote(dirname(file))
++ isempty(repo) && (repo = "https://github.com/$remote/blob/{commit}{path}")
++ path = relpath_from_repo_root(file)
++ if path === nothing
++ nothing
++ else
++ repo = replace(repo, "{commit}" => commit === nothing ? repo_commit(file) : commit)
++ # Note: replacing any backslashes in path (e.g. if building the docs on Windows)
++ repo = replace(repo, "{path}" => string("/", replace(path, '\\' => '/')))
++ repo = replace(repo, "{line}" => "")
++ repo
++ end
++end
++
++url(remote, repo, doc) = url(remote, repo, doc.data[:module], doc.data[:path], linerange(doc))
++
++function url(remote, repo, mod, file, linerange)
++ file === nothing && return nothing # needed on julia v0.6, see #689
++ remote = getremote(dirname(file))
++ isabspath(file) && isempty(remote) && isempty(repo) && return nothing
++
++ # make sure we get the true path, as otherwise we will get different paths when we compute `root` below
++ if isfile(file)
++ file = realpath(abspath(file))
++ end
++
++ # Format the line range.
++ line = format_line(linerange, LineRangeFormatting(repo_host_from_url(repo)))
++ # Macro-generated methods such as those produced by `@deprecate` list their file as
++ # `deprecated.jl` since that is where the macro is defined. Use that to help
++ # determine the correct URL.
++ if inbase(mod) || !isabspath(file)
++ file = replace(file, '\\' => '/')
++ base = "https://github.com/JuliaLang/julia/blob"
++ dest = "base/$file#$line"
++ if isempty(Base.GIT_VERSION_INFO.commit)
++ "$base/v$VERSION/$dest"
++ else
++ commit = Base.GIT_VERSION_INFO.commit
++ "$base/$commit/$dest"
++ end
++ else
++ path = relpath_from_repo_root(file)
++ if isempty(repo)
++ repo = "https://github.com/$remote/blob/{commit}{path}#{line}"
++ end
++ if path === nothing
++ nothing
++ else
++ repo = replace(repo, "{commit}" => repo_commit(file))
++ # Note: replacing any backslashes in path (e.g. if building the docs on Windows)
++ repo = replace(repo, "{path}" => string("/", replace(path, '\\' => '/')))
++ repo = replace(repo, "{line}" => line)
++ repo
++ end
++ end
++end
++
++function getremote(dir::AbstractString)
++ remote =
++ try
++ cd(() -> readchomp(`git config --get remote.origin.url`), dir)
++ catch err
++ ""
++ end
++ m = match(LibGit2.GITHUB_REGEX, remote)
++ if m === nothing
++ travis = get(ENV, "TRAVIS_REPO_SLUG", "")
++ isempty(travis) ? "" : travis
++ else
++ m[1]
++ end
++end
++
++"""
++$(SIGNATURES)
++
++Returns the first 5 characters of the current git commit hash of the directory `dir`.
++"""
++function get_commit_short(dir)
++ commit = cd(dir) do
++ readchomp(`git rev-parse HEAD`)
++ end
++ (length(commit) > 5) ? commit[1:5] : commit
++end
++
++function inbase(m::Module)
++ if m ≡ Base
++ true
++ else
++ parent = parentmodule(m)
++ parent ≡ m ? false : inbase(parent)
++ end
++end
++
++# Repository hosts
++# RepoUnknown denotes that the repository type could not be determined automatically
++@enum RepoHost RepoGithub RepoBitbucket RepoGitlab RepoUnknown
++
++# Repository host from repository url
++# i.e. "https://github.com/something" => RepoGithub
++# "https://bitbucket.org/xxx" => RepoBitbucket
++# If no match, returns RepoUnknown
++function repo_host_from_url(repoURL::String)
++ if occursin("bitbucket", repoURL)
++ return RepoBitbucket
++ elseif occursin("github", repoURL) || isempty(repoURL)
++ return RepoGithub
++ elseif occursin("gitlab", repoURL)
++ return RepoGitlab
++ else
++ return RepoUnknown
++ end
++end
++
++# Find line numbers.
++# ------------------
++
++linerange(doc) = linerange(doc.text, doc.data[:linenumber])
++
++function linerange(text, from)
++ lines = sum([isodd(n) ? newlines(s) : 0 for (n, s) in enumerate(text)])
++ return lines > 0 ? (from:(from + lines + 1)) : (from:from)
++end
++
++struct LineRangeFormatting
++ prefix::String
++ separator::String
++
++ function LineRangeFormatting(host::RepoHost)
++ if host == RepoBitbucket
++ new("", ":")
++ elseif host == RepoGitlab
++ new("L", "-")
++ else
++ # default is github-style
++ new("L", "-L")
++ end
++ end
++end
++
++function format_line(range::AbstractRange, format::LineRangeFormatting)
++ if length(range) <= 1
++ string(format.prefix, first(range))
++ else
++ string(format.prefix, first(range), format.separator, last(range))
++ end
++end
++
++newlines(s::AbstractString) = count(c -> c === '\n', s)
++newlines(other) = 0
++
++
++# Output redirection.
++# -------------------
++using Logging
++
++"""
++Call a function and capture all `stdout` and `stderr` output.
++
++ withoutput(f) --> (result, success, backtrace, output)
++
++where
++
++ * `result` is the value returned from calling function `f`.
++ * `success` signals whether `f` has thrown an error, in which case `result` stores the
++ `Exception` that was raised.
++ * `backtrace` a `Vector{Ptr{Cvoid}}` produced by `catch_backtrace()` if an error is thrown.
++ * `output` is the combined output of `stdout` and `stderr` during execution of `f`.
++
++"""
++function withoutput(f)
++ # Save the default output streams.
++ default_stdout = stdout
++ default_stderr = stderr
++
++ # Redirect both the `stdout` and `stderr` streams to a single `Pipe` object.
++ pipe = Pipe()
++ Base.link_pipe!(pipe; reader_supports_async = true, writer_supports_async = true)
++ redirect_stdout(pipe.in)
++ redirect_stderr(pipe.in)
++ # Also redirect logging stream to the same pipe
++ logger = ConsoleLogger(pipe.in)
++
++ # Bytes written to the `pipe` are captured in `output` and converted to a `String`.
++ output = UInt8[]
++
++ # Run the function `f`, capturing all output that it might have generated.
++ # Success signals whether the function `f` did or did not throw an exception.
++ result, success, backtrace = with_logger(logger) do
++ try
++ f(), true, Vector{Ptr{Cvoid}}()
++ catch err
++ # InterruptException should never happen during normal doc-testing
++ # and not being able to abort the doc-build is annoying (#687).
++ isa(err, InterruptException) && rethrow(err)
++
++ err, false, catch_backtrace()
++ finally
++ # Force at least a single write to `pipe`, otherwise `readavailable` blocks.
++ println()
++ # Restore the original output streams.
++ redirect_stdout(default_stdout)
++ redirect_stderr(default_stderr)
++ # NOTE: `close` must always be called *after* `readavailable`.
++ append!(output, readavailable(pipe))
++ close(pipe)
++ end
++ end
++ return result, success, backtrace, chomp(String(output))
++end
++
++
++"""
++ issubmodule(sub, mod)
++
++Checks whether `sub` is a submodule of `mod`. A module is also considered to be
++its own submodule.
++
++E.g. `A.B.C` is a submodule of `A`, `A.B` and `A.B.C`, but it is not a submodule
++of `D`, `A.D` nor `A.B.C.D`.
++"""
++function issubmodule(sub, mod)
++ if (sub === Main) && (mod !== Main)
++ return false
++ end
++ (sub === mod) || issubmodule(parentmodule(sub), mod)
++end
++
++"""
++ isabsurl(url)
++
++Checks whether `url` is an absolute URL (as opposed to a relative one).
++"""
++isabsurl(url) = occursin(ABSURL_REGEX, url)
++const ABSURL_REGEX = r"^[[:alpha:]+-.]+://"
++
++"""
++ mdparse(s::AbstractString; mode=:single)
++
++Parses the given string as Markdown using `Markdown.parse`, but strips away the surrounding
++layers, such as the outermost `Markdown.MD`. What exactly is returned depends on the `mode`
++keyword.
++
++The `mode` keyword argument can be one of the following:
++
++* `:single` (default) -- returns a single block-level object (e.g. `Markdown.Paragraph` or
++ `Markdown.Admonition`) and errors if the string parses into multiple blocks.
++* `:blocks` -- the function returns a `Vector{Any}` of Markdown blocks.
++* `:span` -- Returns a `Vector{Any}` of span-level items, stripping away the outer block.
++ This requires the string to parse into a single `Markdown.Paragraph`, the contents of
++ which gets returned.
++"""
++function mdparse(s::AbstractString; mode=:single)
++ mode in [:single, :blocks, :span] || throw(ArgumentError("Invalid mode keyword $(mode)"))
++ md = Markdown.parse(s)
++ if mode == :blocks
++ md.content
++ elseif length(md.content) == 0
++ # case where s == "". We'll just return an empty string / paragraph.
++ (mode == :single) ? Markdown.Paragraph(Any[""]) : Any[""]
++ elseif (mode == :single || mode == :span) && length(md.content) > 1
++ @error "mode == :$(mode) requires the Markdown string to parse into a single block" s md.content
++ throw(ArgumentError("Unsuitable string for mode=:$(mode)"))
++ else
++ @assert length(md.content) == 1
++ @assert mode == :span || mode == :single
++ if mode == :span && !isa(md.content[1], Markdown.Paragraph)
++ @error "mode == :$(mode) requires the Markdown string to parse into a Markdown.Paragraph" s md.content
++ throw(ArgumentError("Unsuitable string for mode=:$(mode)"))
++ end
++ (mode == :single) ? md.content[1] : md.content[1].content
++ end
++end
++
++# Capturing output in different representations similar to IJulia.jl
++function limitstringmime(m::MIME"text/plain", x)
++ io = IOBuffer()
++ show(IOContext(io, :limit=> true), m, x)
++ return String(take!(io))
++end
++function display_dict(x)
++ out = Dict{MIME,Any}()
++ x === nothing && return out
++ # Always generate text/plain
++ out[MIME"text/plain"()] = limitstringmime(MIME"text/plain"(), x)
++ for m in [MIME"text/html"(), MIME"image/svg+xml"(), MIME"image/png"(),
++ MIME"image/webp"(), MIME"image/gif"(), MIME"image/jpeg"(),
++ MIME"text/latex"(), MIME"text/markdown"()]
++ showable(m, x) && (out[m] = stringmime(m, x))
++ end
++ return out
++end
++
++include("DOM.jl")
++include("MDFlatten.jl")
++include("TextDiff.jl")
++include("Selectors.jl")
++include("Markdown2.jl")
++
++end
--- /dev/null
--- /dev/null
++"""
++A module for rendering `Document` objects to HTML.
++
++# Keywords
++
++[`HTMLWriter`](@ref) uses the following additional keyword arguments that can be passed to
++[`Documenter.makedocs`](@ref): `authors`, `pages`, `sitename`, `version`.
++The behavior of [`HTMLWriter`](@ref) can be further customized by setting the `format`
++keyword of [`Documenter.makedocs`](@ref) to a [`HTML`](@ref), which accepts the following
++keyword arguments: `analytics`, `assets`, `canonical`, `disable_git`, `edit_branch` and
++`prettyurls`.
++
++**`sitename`** is the site's title displayed in the title bar and at the top of the
++*navigation menu. This argument is mandatory for [`HTMLWriter`](@ref).
++
++**`pages`** defines the hierarchy of the navigation menu.
++
++# Experimental keywords
++
++**`version`** specifies the version string of the current version which will be the
++selected option in the version selector. If this is left empty (default) the version
++selector will be hidden. The special value `git-commit` sets the value in the output to
++`git:{commit}`, where `{commit}` is the first few characters of the current commit hash.
++
++# `HTML` `Plugin` options
++
++The [`HTML`](@ref) [`Documenter.Plugin`](@ref) provides additional customization options
++for the [`HTMLWriter`](@ref). For more information, see the [`HTML`](@ref) documentation.
++
++# Page outline
++
++The [`HTMLWriter`](@ref) makes use of the page outline that is determined by the
++headings. It is assumed that if the very first block of a page is a level 1 heading,
++then it is intended as the page title. This has two consequences:
++
++1. It is then used to automatically determine the page title in the navigation menu
++ and in the `<title>` tag, unless specified in the `.pages` option.
++2. If the first heading is interpreted as being the page title, it is not displayed
++ in the navigation sidebar.
++"""
++module HTMLWriter
++
++import Markdown
++import JSON
++
++import ...Documenter:
++ Anchors,
++ Builder,
++ Documents,
++ Expanders,
++ Documenter,
++ Utilities,
++ Writers
++
++import ...Utilities.DOM: DOM, Tag, @tags
++using ...Utilities.MDFlatten
++
++export HTML
++
++"""
++ HTML(kwargs...)
++
++Sets the behavior of [`HTMLWriter`](@ref).
++
++# Keyword arguments
++
++**`prettyurls`** (default `true`) -- allows toggling the pretty URLs feature.
++
++By default (i.e. when `prettyurls` is set to `true`), Documenter creates a directory
++structure that hides the `.html` suffixes from the URLs (e.g. by default `src/foo.md`
++becomes `src/foo/index.html`, but can be accessed with via `src/foo/` in the browser). This
++structure is preferred when publishing the generate HTML files as a website (e.g. on GitHub
++Pages), which is Documenter's primary use case.
++
++If `prettyurls = false`, then Documenter generates `src/foo.html` instead, suitable for
++local documentation builds, as browsers do not normally resolve `foo/` to `foo/index.html`
++for local files.
++
++To have pretty URLs disabled in local builds, but still have them enabled for the automatic
++CI deployment builds, you can set `prettyurls = get(ENV, "CI", nothing) == "true"` (the
++specific environment variable you will need to check may depend on the CI system you are
++using, but this will work on Travis CI).
++
++**`disable_git`** can be used to disable calls to `git` when the document is not
++in a Git-controlled repository. Without setting this to `true`, Documenter will throw
++an error and exit if any of the Git commands fail. The calls to Git are mainly used to
++gather information about the current commit hash and file paths, necessary for constructing
++the links to the remote repository.
++
++**`edit_branch`** specifies which branch, tag or commit the "Edit on GitHub" links
++point to. It defaults to `master`. If it set to `nothing`, the current commit will be used.
++
++**`canonical`** specifies the canonical URL for your documentation. We recommend
++you set this to the base url of your stable documentation, e.g. `https://juliadocs.github.io/Documenter.jl/stable`.
++This allows search engines to know which version to send their users to. [See
++wikipedia for more information](https://en.wikipedia.org/wiki/Canonical_link_element).
++Default is `nothing`, in which case no canonical link is set.
++
++**`analytics`** can be used specify the Google Analytics tracking ID.
++
++**`assets`** can be used to include additional assets (JS, CSS, ICO etc. files). See below
++for more information.
++
++# Default and custom assets
++
++Documenter copies all files under the source directory (e.g. `/docs/src/`) over
++to the compiled site. It also copies a set of default assets from `/assets/html/`
++to the site's `assets/` directory, unless the user already had a file with the
++same name, in which case the user's files overrides the Documenter's file.
++This could, in principle, be used for customizing the site's style and scripting.
++
++The HTML output also links certain custom assets to the generated HTML documents,
++specifically a logo and additional javascript files.
++The asset files that should be linked must be placed in `assets/`, under the source
++directory (e.g `/docs/src/assets`) and must be on the top level (i.e. files in
++the subdirectories of `assets/` are not linked).
++
++For the **logo**, Documenter checks for the existence of `assets/logo.{svg,png,webp,gif,jpg,jpeg}`,
++in this order. The first one it finds gets displayed at the top of the navigation sidebar.
++
++Additional JS, ICO, and CSS assets can be included in the generated pages using the
++`assets` keyword for `makedocs`. `assets` must be a `Vector{String}` and will include
++each listed asset in the `<head>` of every page in the order in which they are listed.
++The type of the asset (i.e. whether it is going to be included with a `<script>` or a
++`<link>` tag) is determined by the file's extension -- either `.js`, `.ico`, or `.css`.
++Adding an ICO asset is primarilly useful for setting a custom `favicon`.
++"""
++struct HTML <: Documenter.Writer
++ prettyurls :: Bool
++ disable_git :: Bool
++ edit_branch :: Union{String, Nothing}
++ canonical :: Union{String, Nothing}
++ assets :: Vector{String}
++ analytics :: String
++
++ function HTML(;
++ prettyurls::Bool = true,
++ disable_git::Bool = false,
++ edit_branch::Union{String, Nothing} = "master",
++ canonical::Union{String, Nothing} = nothing,
++ assets::Vector{String} = String[],
++ analytics::String = "")
++ new(prettyurls, disable_git, edit_branch, canonical, assets, analytics)
++ end
++end
++
++const requirejs_cdn = "file:///usr/share/javascript/requirejs/require.min.js"
++const normalize_css = "file:///usr/share/javascript/normalize.css/normalize.min.css"
++const google_fonts = "file:///usr/share/doc/julia-doc/fontface.css"
++const fontawesome_css = "file:///usr/share/fonts-font-awesome/css/font-awesome.min.css"
++const highlightjs_css = "file:///usr/share/javascript/highlight.js/styles/default.css"
++
++
++struct SearchRecord
++ src :: String
++ page :: Documents.Page
++ loc :: String
++ category :: String
++ title :: String
++ page_title :: String
++ text :: String
++end
++
++"""
++[`HTMLWriter`](@ref)-specific globals that are passed to [`domify`](@ref) and
++other recursive functions.
++"""
++mutable struct HTMLContext
++ doc :: Documents.Document
++ settings :: HTML
++ logo :: String
++ scripts :: Vector{String}
++ documenter_js :: String
++ search_js :: String
++ search_index :: Vector{SearchRecord}
++ search_index_js :: String
++ search_navnode :: Documents.NavNode
++ local_assets :: Vector{String}
++end
++
++HTMLContext(doc, settings=HTML()) = HTMLContext(doc, settings, "", [], "", "", [], "", Documents.NavNode("search", "Search", nothing), [])
++
++function SearchRecord(ctx::HTMLContext, navnode; loc="", title=nothing, category="page", text="")
++ page_title = mdflatten(pagetitle(ctx, navnode))
++ if title === nothing
++ title = page_title
++ end
++ SearchRecord(
++ pretty_url(ctx, get_url(ctx, navnode.page)),
++ getpage(ctx, navnode),
++ loc,
++ lowercase(category),
++ title,
++ page_title,
++ text
++ )
++end
++
++function SearchRecord(ctx::HTMLContext, navnode, node::Markdown.Header)
++ a = getpage(ctx, navnode).mapping[node]
++ SearchRecord(ctx, navnode;
++ loc="$(a.id)-$(a.nth)",
++ title=mdflatten(node),
++ category="section")
++end
++
++function SearchRecord(ctx, navnode, node)
++ SearchRecord(ctx, navnode; text=mdflatten(node))
++end
++
++function JSON.lower(rec::SearchRecord)
++ # Replace any backslashes in links, if building the docs on Windows
++ src = replace(rec.src, '\\' => '/')
++ ref = string(src, '#', rec.loc)
++ Dict{String, String}(
++ "location" => ref,
++ "page" => rec.page_title,
++ "title" => rec.title,
++ "category" => rec.category,
++ "text" => rec.text
++ )
++end
++
++"""
++Returns a page (as a [`Documents.Page`](@ref) object) using the [`HTMLContext`](@ref).
++"""
++getpage(ctx, path) = ctx.doc.blueprint.pages[path]
++getpage(ctx, navnode::Documents.NavNode) = getpage(ctx, navnode.page)
++
++
++function render(doc::Documents.Document, settings::HTML=HTML())
++ @info "HTMLWriter: rendering HTML pages."
++ !isempty(doc.user.sitename) || error("HTML output requires `sitename`.")
++
++ ctx = HTMLContext(doc, settings)
++ ctx.search_index_js = "search_index.js"
++
++ copy_asset("arrow.svg", doc)
++
++ for logoext in ["svg", "png", "webp", "gif", "jpg", "jpeg"]
++ logo = joinpath("assets", "logo.$(logoext)")
++ if isfile(joinpath(doc.user.build, logo))
++ ctx.logo = logo
++ break
++ end
++ end
++
++ ctx.documenter_js = copy_asset("documenter.js", doc)
++ ctx.search_js = copy_asset("search.js", doc)
++
++ push!(ctx.local_assets, copy_asset("documenter.css", doc))
++ append!(ctx.local_assets, settings.assets)
++
++ for page in keys(doc.blueprint.pages)
++ idx = findfirst(nn -> nn.page == page, doc.internal.navlist)
++ nn = (idx === nothing) ? Documents.NavNode(page, nothing, nothing) : doc.internal.navlist[idx]
++ @debug "Rendering $(page) [$(repr(idx))]"
++ render_page(ctx, nn)
++ end
++
++ render_search(ctx)
++
++ open(joinpath(doc.user.build, ctx.search_index_js), "w") do io
++ println(io, "var documenterSearchIndex = {\"docs\":")
++ # convert Vector{SearchRecord} to a JSON string, and escape two Unicode
++ # characters since JSON is not a JS subset, and we want JS here
++ # ref http://timelessrepo.com/json-isnt-a-javascript-subset
++ escapes = ('\u2028' => "\\u2028", '\u2029' => "\\u2029")
++ js = reduce(replace, escapes, init=JSON.json(ctx.search_index))
++ println(io, js, "\n}")
++ end
++end
++
++"""
++Copies an asset from Documenters `assets/html/` directory to `doc.user.build`.
++Returns the path of the copied asset relative to `.build`.
++"""
++function copy_asset(file, doc)
++ src = joinpath(Utilities.assetsdir(), "html", file)
++ alt_src = joinpath(doc.user.source, "assets", file)
++ dst = joinpath(doc.user.build, "assets", file)
++ isfile(src) || error("Asset '$file' not found at $(abspath(src))")
++
++ # Since user's alternative assets are already copied over in a previous build
++ # step and they should override documenter's original assets, we only actually
++ # perform the copy if <source>/assets/<file> does not exist. Note that checking
++ # the existence of <build>/assets/<file> is not sufficient since the <build>
++ # directory might be dirty from a previous build.
++ if isfile(alt_src)
++ @warn "not copying '$src', provided by the user."
++ else
++ ispath(dirname(dst)) || mkpath(dirname(dst))
++ ispath(dst) && @warn "overwriting '$dst'."
++ cp(src, dst, force=true)
++ end
++ assetpath = normpath(joinpath("assets", file))
++ # Replace any backslashes in links, if building the docs on Windows
++ return replace(assetpath, '\\' => '/')
++end
++
++# Page
++# ------------------------------------------------------------------------------
++
++"""
++Constructs and writes the page referred to by the `navnode` to `.build`.
++"""
++function render_page(ctx, navnode)
++ @tags html body
++
++ page = getpage(ctx, navnode)
++
++ head = render_head(ctx, navnode)
++ navmenu = render_navmenu(ctx, navnode)
++ article = render_article(ctx, navnode)
++
++ htmldoc = DOM.HTMLDocument(
++ html[:lang=>"en"](
++ head,
++ body(navmenu, article)
++ )
++ )
++
++ open_output(ctx, navnode) do io
++ print(io, htmldoc)
++ end
++end
++
++function render_head(ctx, navnode)
++ @tags head meta link script title
++ src = get_url(ctx, navnode)
++
++ page_title = "$(mdflatten(pagetitle(ctx, navnode))) · $(ctx.doc.user.sitename)"
++ css_links = [
++ normalize_css,
++ google_fonts,
++ fontawesome_css,
++ highlightjs_css,
++ ]
++ head(
++ meta[:charset=>"UTF-8"],
++ meta[:name => "viewport", :content => "width=device-width, initial-scale=1.0"],
++ title(page_title),
++
++ analytics_script(ctx.settings.analytics),
++
++ canonical_link_element(ctx.settings.canonical, src),
++
++ # Stylesheets.
++ map(css_links) do each
++ link[:href => each, :rel => "stylesheet", :type => "text/css"]
++ end,
++
++ script("documenterBaseURL=\"$(relhref(src, "."))\""),
++ script[
++ :src => requirejs_cdn,
++ Symbol("data-main") => relhref(src, ctx.documenter_js)
++ ],
++
++ script[:src => relhref(src, "siteinfo.js")],
++ script[:src => relhref(src, "../versions.js")],
++
++ # Custom user-provided assets.
++ asset_links(src, ctx.local_assets)
++ )
++end
++
++function asset_links(src::AbstractString, assets::Vector)
++ @tags link script
++ links = DOM.Node[]
++ for each in assets
++ ext = splitext(each)[end]
++ url = relhref(src, each)
++ node =
++ ext == ".ico" ? link[:href => url, :rel => "icon", :type => "image/x-icon"] :
++ ext == ".css" ? link[:href => url, :rel => "stylesheet", :type => "text/css"] :
++ ext == ".js" ? script[:src => url] : continue # Skip non-js/css files.
++ push!(links, node)
++ end
++ return links
++end
++
++analytics_script(tracking_id::AbstractString) =
++ isempty(tracking_id) ? Tag(Symbol("#RAW#"))("") : Tag(:script)(
++ """
++ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
++ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
++ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
++ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
++
++ ga('create', '$(tracking_id)', 'auto');
++ ga('send', 'pageview');
++ """
++ )
++
++function canonical_link_element(canonical_link, src)
++ @tags link
++ if canonical_link === nothing
++ return Tag(Symbol("#RAW#"))("")
++ else
++ canonical_link_stripped = rstrip(canonical_link, '/')
++ href = "$canonical_link_stripped/$src"
++ return link[:rel => "canonical", :href => href]
++ end
++end
++
++## Search page
++# ------------
++
++function render_search(ctx)
++ @tags article body h1 header hr html li nav p span ul script
++
++ src = get_url(ctx, ctx.search_navnode)
++
++ head = render_head(ctx, ctx.search_navnode)
++ navmenu = render_navmenu(ctx, ctx.search_navnode)
++ article = article(
++ header(
++ nav(ul(li("Search"))),
++ hr(),
++ render_topbar(ctx, ctx.search_navnode),
++ ),
++ h1("Search"),
++ p["#search-info"]("Number of results: ", span["#search-results-number"]("loading...")),
++ ul["#search-results"]
++ )
++
++ htmldoc = DOM.HTMLDocument(
++ html[:lang=>"en"](
++ head,
++ body(navmenu, article),
++ script[:src => relhref(src, ctx.search_index_js)],
++ script[:src => relhref(src, ctx.search_js)],
++ )
++ )
++ open_output(ctx, ctx.search_navnode) do io
++ print(io, htmldoc)
++ end
++end
++
++# Navigation menu
++# ------------------------------------------------------------------------------
++
++function render_navmenu(ctx, navnode)
++ @tags a form h1 img input nav div select option
++
++ src = get_url(ctx, navnode)
++
++ navmenu = nav[".toc"]
++ if !isempty(ctx.logo)
++ push!(navmenu.nodes,
++ # the logo will point to the first page in the navigation menu
++ a[:href => navhref(ctx, first(ctx.doc.internal.navlist), navnode)](
++ img[
++ ".logo",
++ :src => relhref(src, ctx.logo),
++ :alt => "$(ctx.doc.user.sitename) logo"
++ ]
++ )
++ )
++ end
++ push!(navmenu.nodes, h1(ctx.doc.user.sitename))
++ let version_selector = select["#version-selector", :onChange => "window.location.href=this.value"]()
++ if isempty(ctx.doc.user.version)
++ push!(version_selector.attributes, :style => "visibility: hidden")
++ else
++ push!(version_selector.nodes,
++ option[
++ :value => "#",
++ :selected => "selected",
++ ](ctx.doc.user.version)
++ )
++ end
++ push!(navmenu.nodes, version_selector)
++ end
++ push!(navmenu.nodes,
++ form[".search#search-form", :action => navhref(ctx, ctx.search_navnode, navnode)](
++ input[
++ "#search-query",
++ :name => "q",
++ :type => "text",
++ :placeholder => "Search docs",
++ ],
++ )
++ )
++ push!(navmenu.nodes, navitem(ctx, navnode))
++ navmenu
++end
++
++"""
++[`navitem`](@ref) returns the lists and list items of the navigation menu.
++It gets called recursively to construct the whole tree.
++
++It always returns a [`DOM.Node`](@ref). If there's nothing to display (e.g. the node is set
++to be invisible), it returns an empty text node (`DOM.Node("")`).
++"""
++navitem(ctx, current) = navitem(ctx, current, ctx.doc.internal.navtree)
++function navitem(ctx, current, nns::Vector)
++ nodes = map(nn -> navitem(ctx, current, nn), nns)
++ filter!(node -> node.name !== DOM.TEXT, nodes)
++ isempty(nodes) ? DOM.Node("") : DOM.Tag(:ul)(nodes)
++end
++function navitem(ctx, current, nn::Documents.NavNode)
++ @tags ul li span a
++
++ # We'll do the children first, primarily to determine if this node has any that are
++ # visible. If it does not and it itself is not visible (including current), then
++ # we'll hide this one as well, returning an empty string Node.
++ children = navitem(ctx, current, nn.children)
++ if nn !== current && !nn.visible && children.name === DOM.TEXT
++ return DOM.Node("")
++ end
++
++ # construct this item
++ title = mdconvert(pagetitle(ctx, nn); droplinks=true)
++ link = if nn.page === nothing
++ span[".toctext"](title)
++ else
++ a[".toctext", :href => navhref(ctx, nn, current)](title)
++ end
++ item = (nn === current) ? li[".current"](link) : li(link)
++
++ # add the subsections (2nd level headings) from the page
++ if (nn === current) && current.page !== nothing
++ subs = collect_subsections(ctx.doc.blueprint.pages[current.page])
++ internal_links = map(subs) do s
++ istoplevel, anchor, text = s
++ _li = istoplevel ? li[".toplevel"] : li[]
++ _li(a[".toctext", :href => anchor](mdconvert(text; droplinks=true)))
++ end
++ push!(item.nodes, ul[".internal"](internal_links))
++ end
++
++ # add the visible subsections, if any, as a single list
++ (children.name === DOM.TEXT) || push!(item.nodes, children)
++
++ item
++end
++
++
++# Article (page contents)
++# ------------------------------------------------------------------------------
++
++function render_article(ctx, navnode)
++ @tags article header footer nav ul li hr span a
++
++ header_links = map(Documents.navpath(navnode)) do nn
++ title = mdconvert(pagetitle(ctx, nn); droplinks=true)
++ nn.page === nothing ? li(title) : li(a[:href => navhref(ctx, nn, navnode)](title))
++ end
++
++ topnav = nav(ul(header_links))
++
++ # Set the logo and name for the "Edit on.." button.
++ host_type = Utilities.repo_host_from_url(ctx.doc.user.repo)
++ if host_type == Utilities.RepoGitlab
++ host = "GitLab"
++ logo = "\uf296"
++ elseif host_type == Utilities.RepoGithub
++ host = "GitHub"
++ logo = "\uf09b"
++ elseif host_type == Utilities.RepoBitbucket
++ host = "BitBucket"
++ logo = "\uf171"
++ else
++ host = ""
++ logo = "\uf15c"
++ end
++ hoststring = isempty(host) ? " source" : " on $(host)"
++
++ if !ctx.settings.disable_git
++ pageurl = get(getpage(ctx, navnode).globals.meta, :EditURL, getpage(ctx, navnode).source)
++ if Utilities.isabsurl(pageurl)
++ url = pageurl
++ else
++ if !(pageurl == getpage(ctx, navnode).source)
++ # need to set users path relative the page itself
++ pageurl = joinpath(first(splitdir(getpage(ctx, navnode).source)), pageurl)
++ end
++ url = Utilities.url(ctx.doc.user.repo, pageurl, commit=ctx.settings.edit_branch)
++ end
++ if url !== nothing
++ edit_verb = (ctx.settings.edit_branch === nothing) ? "View" : "Edit"
++ push!(topnav.nodes, a[".edit-page", :href => url](span[".fa"](logo), " $(edit_verb)$hoststring"))
++ end
++ end
++ art_header = header(topnav, hr(), render_topbar(ctx, navnode))
++
++ # build the footer with nav links
++ art_footer = footer(hr())
++ if navnode.prev !== nothing
++ direction = span[".direction"]("Previous")
++ title = span[".title"](mdconvert(pagetitle(ctx, navnode.prev); droplinks=true))
++ link = a[".previous", :href => navhref(ctx, navnode.prev, navnode)](direction, title)
++ push!(art_footer.nodes, link)
++ end
++
++ if navnode.next !== nothing
++ direction = span[".direction"]("Next")
++ title = span[".title"](mdconvert(pagetitle(ctx, navnode.next); droplinks=true))
++ link = a[".next", :href => navhref(ctx, navnode.next, navnode)](direction, title)
++ push!(art_footer.nodes, link)
++ end
++
++ pagenodes = domify(ctx, navnode)
++ article["#docs"](art_header, pagenodes, art_footer)
++end
++
++function render_topbar(ctx, navnode)
++ @tags a div span
++ page_title = string(mdflatten(pagetitle(ctx, navnode)))
++ return div["#topbar"](span(page_title), a[".fa .fa-bars", :href => "#"])
++end
++
++# expand the versions argument from the user
++# and return entries and needed symlinks
++function expand_versions(dir, versions)
++ # output: entries and symlinks
++ entries = String[]
++ symlinks = Pair{String,String}[]
++
++ # read folders and filter out symlinks
++ available_folders = readdir(dir)
++ cd(() -> filter!(!islink, available_folders), dir)
++
++ # filter and sort release folders
++ vnum(x) = VersionNumber(x)
++ version_folders = [x for x in available_folders if occursin(Base.VERSION_REGEX, x)]
++ sort!(version_folders, lt = (x, y) -> vnum(x) < vnum(y), rev = true)
++ release_folders = filter(x -> (v = vnum(x); v.prerelease == () && v.build == ()), version_folders)
++ # pre_release_folders = filter(x -> (v = vnum(x); v.prerelease != () || v.build != ()), version_folders)
++ major_folders = filter!(x -> (v = vnum(x); v.major != 0),
++ unique(x -> (v = vnum(x); v.major), release_folders))
++ minor_folders = filter!(x -> (v = vnum(x); !(v.major == 0 && v.minor == 0)),
++ unique(x -> (v = vnum(x); (v.major, v.minor)), release_folders))
++ patch_folders = unique(x -> (v = vnum(x); (v.major, v.minor, v.patch)), release_folders)
++
++ filter!(x -> vnum(x) !== 0, major_folders)
++
++ # populate output
++ for entry in versions
++ if entry == "v#" # one doc per major release
++ for x in major_folders
++ vstr = "v$(vnum(x).major).$(vnum(x).minor)"
++ push!(entries, vstr)
++ push!(symlinks, vstr => x)
++ end
++ elseif entry == "v#.#" # one doc per minor release
++ for x in minor_folders
++ vstr = "v$(vnum(x).major).$(vnum(x).minor)"
++ push!(entries, vstr)
++ push!(symlinks, vstr => x)
++ end
++ elseif entry == "v#.#.#" # one doc per patch release
++ for x in patch_folders
++ vstr = "v$(vnum(x).major).$(vnum(x).minor).$(vnum(x).patch)"
++ push!(entries, vstr)
++ push!(symlinks, vstr => x)
++ end
++ elseif entry == "v^" || (entry isa Pair && entry.second == "v^")
++ if !isempty(release_folders)
++ x = first(release_folders)
++ vstr = isa(entry, Pair) ? entry.first : "v$(vnum(x).major).$(vnum(x).minor)"
++ push!(entries, vstr)
++ push!(symlinks, vstr => x)
++ end
++ elseif entry isa Pair
++ k, v = entry
++ i = findfirst(==(v), available_folders)
++ if i === nothing
++ @warn "no match for `versions` entry `$(repr(entry))`"
++ else
++ push!(entries, k)
++ push!(symlinks, k => v)
++ end
++ else
++ @warn "no match for `versions` entry `$(repr(entry))`"
++ end
++ end
++ unique!(entries) # remove any duplicates
++
++ # generate remaining symlinks
++ foreach(x -> push!(symlinks, "v$(vnum(x).major)" => x), major_folders)
++ foreach(x -> push!(symlinks, "v$(vnum(x).major).$(vnum(x).minor)" => x), minor_folders)
++ foreach(x -> push!(symlinks, "v$(vnum(x).major).$(vnum(x).minor).$(vnum(x).patch)" => x), patch_folders)
++ filter!(x -> x.first != x.second, unique!(symlinks))
++
++ # assert that none of the links point to another link
++ for link in symlinks
++ i = findfirst(x -> link.first == x.second, symlinks)
++ if i !== nothing
++ throw(ArgumentError("link `$(link)` incompatible with link `$(symlinks[i])`."))
++ end
++ end
++
++ return entries, symlinks
++end
++
++# write version file
++function generate_version_file(versionfile::AbstractString, entries)
++ open(versionfile, "w") do buf
++ println(buf, "var DOC_VERSIONS = [")
++ for folder in entries
++ println(buf, " \"", folder, "\",")
++ end
++ println(buf, "];")
++ end
++end
++
++function generate_siteinfo_file(dir::AbstractString, version::AbstractString)
++ open(joinpath(dir, "siteinfo.js"), "w") do buf
++ println(buf, "var DOCUMENTER_CURRENT_VERSION = \"$(version)\";")
++ end
++end
++
++## domify(...)
++# ------------
++
++"""
++Converts recursively a [`Documents.Page`](@ref), `Markdown` or Documenter
++`*Node` objects into HTML DOM.
++"""
++function domify(ctx, navnode)
++ page = getpage(ctx, navnode)
++ map(page.elements) do elem
++ rec = SearchRecord(ctx, navnode, elem)
++ push!(ctx.search_index, rec)
++ domify(ctx, navnode, page.mapping[elem])
++ end
++end
++
++function domify(ctx, navnode, node)
++ fixlinks!(ctx, navnode, node)
++ mdconvert(node, Markdown.MD())
++end
++
++function domify(ctx, navnode, anchor::Anchors.Anchor)
++ @tags a
++ aid = "$(anchor.id)-$(anchor.nth)"
++ if isa(anchor.object, Markdown.Header)
++ h = anchor.object
++ fixlinks!(ctx, navnode, h)
++ DOM.Tag(Symbol("h$(Utilities.header_level(h))"))(
++ a[".nav-anchor", :id => aid, :href => "#$aid"](mdconvert(h.text, h))
++ )
++ else
++ a[".nav-anchor", :id => aid, :href => "#$aid"](domify(ctx, navnode, anchor.object))
++ end
++end
++
++
++struct ListBuilder
++ es::Vector
++end
++ListBuilder() = ListBuilder([])
++
++import Base: push!
++function push!(lb::ListBuilder, level, node)
++ @assert level >= 1
++ if level == 1
++ push!(lb.es, node)
++ else
++ if isempty(lb.es) || typeof(last(lb.es)) !== ListBuilder
++ push!(lb.es, ListBuilder())
++ end
++ push!(last(lb.es), level-1, node)
++ end
++end
++
++function domify(lb::ListBuilder)
++ @tags ul li
++ ul(map(e -> isa(e, ListBuilder) ? domify(e) : li(e), lb.es))
++end
++
++function domify(ctx, navnode, contents::Documents.ContentsNode)
++ @tags a
++ navnode_dir = dirname(navnode.page)
++ navnode_url = get_url(ctx, navnode)
++ lb = ListBuilder()
++ for (count, path, anchor) in contents.elements
++ path = joinpath(navnode_dir, path) # links in ContentsNodes are relative to current page
++ path = pretty_url(ctx, relhref(navnode_url, get_url(ctx, path)))
++ header = anchor.object
++ url = string(path, '#', anchor.id, '-', anchor.nth)
++ node = a[:href=>url](mdconvert(header.text; droplinks=true))
++ level = Utilities.header_level(header)
++ push!(lb, level, node)
++ end
++ domify(lb)
++end
++
++function domify(ctx, navnode, index::Documents.IndexNode)
++ @tags a code li ul
++ navnode_dir = dirname(navnode.page)
++ navnode_url = get_url(ctx, navnode)
++ lis = map(index.elements) do el
++ object, doc, path, mod, cat = el
++ path = joinpath(navnode_dir, path) # links in IndexNodes are relative to current page
++ path = pretty_url(ctx, relhref(navnode_url, get_url(ctx, path)))
++ url = string(path, "#", Utilities.slugify(object))
++ li(a[:href=>url](code("$(object.binding)")))
++ end
++ ul(lis)
++end
++
++function domify(ctx, navnode, docs::Documents.DocsNodes)
++ [domify(ctx, navnode, node) for node in docs.nodes]
++end
++
++function domify(ctx, navnode, node::Documents.DocsNode)
++ @tags a code div section span
++
++ # push to search index
++ rec = SearchRecord(ctx, navnode;
++ loc=node.anchor.id,
++ title=string(node.object.binding),
++ category=Utilities.doccat(node.object),
++ text = mdflatten(node.docstr))
++
++ push!(ctx.search_index, rec)
++
++ section[".docstring"](
++ div[".docstring-header"](
++ a[".docstring-binding", :id=>node.anchor.id, :href=>"#$(node.anchor.id)"](code("$(node.object.binding)")),
++ " — ", # —
++ span[".docstring-category"]("$(Utilities.doccat(node.object))"),
++ "."
++ ),
++ domify_doc(ctx, navnode, node.docstr)
++ )
++end
++
++function domify_doc(ctx, navnode, md::Markdown.MD)
++ @tags a
++ if haskey(md.meta, :results)
++ # The `:results` field contains a vector of `Docs.DocStr` objects associated with
++ # each markdown object. The `DocStr` contains data such as file and line info that
++ # we need for generating correct source links.
++ map(zip(md.content, md.meta[:results])) do md
++ markdown, result = md
++ ret = Any[domify(ctx, navnode, Writers.MarkdownWriter.dropheaders(markdown))]
++ # When a source link is available then print the link.
++ if !ctx.settings.disable_git
++ url = Utilities.url(ctx.doc.internal.remote, ctx.doc.user.repo, result)
++ if url !== nothing
++ push!(ret, a[".source-link", :target=>"_blank", :href=>url]("source"))
++ end
++ end
++ ret
++ end
++ else
++ # Docstrings with no `:results` metadata won't contain source locations so we don't
++ # try to print them out. Just print the basic docstring.
++ domify(ctx, navnode, Writers.MarkdownWriter.dropheaders(md))
++ end
++end
++
++function domify(ctx, navnode, node::Documents.EvalNode)
++ node.result === nothing ? DOM.Node[] : domify(ctx, navnode, node.result)
++end
++
++# nothing to show for MetaNodes, so we just return an empty list
++domify(ctx, navnode, node::Documents.MetaNode) = DOM.Node[]
++
++function domify(ctx, navnode, raw::Documents.RawNode)
++ raw.name === :html ? Tag(Symbol("#RAW#"))(raw.text) : DOM.Node[]
++end
++
++
++# Utilities
++# ------------------------------------------------------------------------------
++
++"""
++Opens the output file of the `navnode` in write node. If necessary, the path to the output
++file is created before opening the file.
++"""
++function open_output(f, ctx, navnode)
++ path = joinpath(ctx.doc.user.build, get_url(ctx, navnode))
++ isdir(dirname(path)) || mkpath(dirname(path))
++ open(f, path, "w")
++end
++
++"""
++Get the relative hyperlink between two [`Documents.NavNode`](@ref)s. Assumes that both
++[`Documents.NavNode`](@ref)s have an associated [`Documents.Page`](@ref) (i.e. `.page`
++is not `nothing`).
++"""
++navhref(ctx, to, from) = pretty_url(ctx, relhref(get_url(ctx, from), get_url(ctx, to)))
++
++"""
++Calculates a relative HTML link from one path to another.
++"""
++function relhref(from, to)
++ pagedir = dirname(from)
++ # The regex separator replacement is necessary since otherwise building the docs on
++ # Windows will result in paths that have `//` separators which break asset inclusion.
++ replace(relpath(to, isempty(pagedir) ? "." : pagedir), r"[/\\]+" => "/")
++end
++
++"""
++Returns the full path corresponding to a path of a `.md` page file. The the input and output
++paths are assumed to be relative to `src/`.
++"""
++function get_url(ctx, path::AbstractString)
++ if ctx.settings.prettyurls
++ d = if basename(path) == "index.md"
++ dirname(path)
++ else
++ first(splitext(path))
++ end
++ isempty(d) ? "index.html" : "$d/index.html"
++ else
++ # change extension to .html
++ string(splitext(path)[1], ".html")
++ end
++end
++
++"""
++Returns the full path of a [`Documents.NavNode`](@ref) relative to `src/`.
++"""
++get_url(ctx, navnode::Documents.NavNode) = get_url(ctx, navnode.page)
++
++"""
++If `prettyurls` for [`HTML`](@ref Documenter.HTML) is enabled, returns a "pretty" version of
++the `path` which can then be used in links in the resulting HTML file.
++"""
++function pretty_url(ctx, path::AbstractString)
++ if ctx.settings.prettyurls
++ dir, file = splitdir(path)
++ if file == "index.html"
++ return length(dir) == 0 ? "" : "$(dir)/"
++ end
++ end
++ return path
++end
++
++"""
++Tries to guess the page title by looking at the `<h1>` headers and returns the
++header contents of the first `<h1>` on a page (or `nothing` if the algorithm
++was unable to find any `<h1>` headers).
++"""
++function pagetitle(page::Documents.Page)
++ title = nothing
++ for element in page.elements
++ if isa(element, Markdown.Header{1})
++ title = element.text
++ break
++ end
++ end
++ title
++end
++
++function pagetitle(ctx, navnode::Documents.NavNode)
++ if navnode.title_override !== nothing
++ # parse title_override as markdown
++ md = Markdown.parse(navnode.title_override)
++ # Markdown.parse results in a paragraph so we need to strip that
++ if !(length(md.content) === 1 && isa(first(md.content), Markdown.Paragraph))
++ error("Bad Markdown provided for page title: '$(navnode.title_override)'")
++ end
++ return first(md.content).content
++ end
++
++ if navnode.page !== nothing
++ title = pagetitle(getpage(ctx, navnode))
++ title === nothing || return title
++ end
++
++ "-"
++end
++
++"""
++Returns an ordered list of tuples, `(toplevel, anchor, text)`, corresponding to level 1 and 2
++headings on the `page`. Note that if the first header on the `page` is a level 1 header then
++it is not included -- it is assumed to be the page title and so does not need to be included
++in the navigation menu twice.
++"""
++function collect_subsections(page::Documents.Page)
++ sections = []
++ title_found = false
++ for element in page.elements
++ if isa(element, Markdown.Header) && Utilities.header_level(element) < 3
++ toplevel = Utilities.header_level(element) === 1
++ # Don't include the first header if it is `h1`.
++ if toplevel && isempty(sections) && !title_found
++ title_found = true
++ continue
++ end
++ anchor = page.mapping[element]
++ push!(sections, (toplevel, "#$(anchor.id)-$(anchor.nth)", element.text))
++ end
++ end
++ return sections
++end
++
++
++# mdconvert
++# ------------------------------------------------------------------------------
++
++const md_block_nodes = [Markdown.MD, Markdown.BlockQuote]
++push!(md_block_nodes, Markdown.List)
++push!(md_block_nodes, Markdown.Admonition)
++
++"""
++[`MDBlockContext`](@ref) is a union of all the Markdown nodes whose children should
++be blocks. It can be used to dispatch on all the block-context nodes at once.
++"""
++const MDBlockContext = Union{md_block_nodes...}
++
++"""
++Convert a markdown object to a `DOM.Node` object.
++
++The `parent` argument is passed to allow for context-dependant conversions.
++"""
++mdconvert(md; kwargs...) = mdconvert(md, md; kwargs...)
++
++mdconvert(text::AbstractString, parent; kwargs...) = DOM.Node(text)
++
++mdconvert(vec::Vector, parent; kwargs...) = [mdconvert(x, parent; kwargs...) for x in vec]
++
++mdconvert(md::Markdown.MD, parent; kwargs...) = Tag(:div)(mdconvert(md.content, md; kwargs...))
++
++mdconvert(b::Markdown.BlockQuote, parent; kwargs...) = Tag(:blockquote)(mdconvert(b.content, b; kwargs...))
++
++mdconvert(b::Markdown.Bold, parent; kwargs...) = Tag(:strong)(mdconvert(b.text, parent; kwargs...))
++
++function mdconvert(c::Markdown.Code, parent::MDBlockContext; kwargs...)
++ @tags pre code
++ language = isempty(c.language) ? "none" : c.language
++ pre(code[".language-$(language)"](c.code))
++end
++mdconvert(c::Markdown.Code, parent; kwargs...) = Tag(:code)(c.code)
++
++mdconvert(h::Markdown.Header{N}, parent; kwargs...) where {N} = DOM.Tag(Symbol("h$N"))(mdconvert(h.text, h; kwargs...))
++
++mdconvert(::Markdown.HorizontalRule, parent; kwargs...) = Tag(:hr)()
++
++function mdconvert(i::Markdown.Image, parent; kwargs...)
++ @tags video img a
++
++ if occursin(r"\.(webm|mp4|ogg|ogm|ogv|avi)$", i.url)
++ video[:src => i.url, :controls => "true", :title => i.alt](
++ a[:href => i.url](i.alt)
++ )
++ else
++ img[:src => i.url, :alt => i.alt]
++ end
++end
++
++mdconvert(i::Markdown.Italic, parent; kwargs...) = Tag(:em)(mdconvert(i.text, i; kwargs...))
++
++mdconvert(m::Markdown.LaTeX, ::MDBlockContext; kwargs...) = Tag(:div)(string("\\[", m.formula, "\\]"))
++mdconvert(m::Markdown.LaTeX, parent; kwargs...) = Tag(:span)(string('$', m.formula, '$'))
++
++mdconvert(::Markdown.LineBreak, parent; kwargs...) = Tag(:br)()
++
++function mdconvert(link::Markdown.Link, parent; droplinks=false, kwargs...)
++ link_text = mdconvert(link.text, link; droplinks=droplinks, kwargs...)
++ droplinks ? link_text : Tag(:a)[:href => link.url](link_text)
++end
++
++mdconvert(list::Markdown.List, parent; kwargs...) = (Markdown.isordered(list) ? Tag(:ol) : Tag(:ul))(map(Tag(:li), mdconvert(list.items, list; kwargs...)))
++
++mdconvert(paragraph::Markdown.Paragraph, parent; kwargs...) = Tag(:p)(mdconvert(paragraph.content, paragraph; kwargs...))
++
++# For compatibility with versions before Markdown.List got the `loose field, Julia PR #26598
++const list_has_loose_field = :loose in fieldnames(Markdown.List)
++function mdconvert(paragraph::Markdown.Paragraph, parent::Markdown.List; kwargs...)
++ content = mdconvert(paragraph.content, paragraph; kwargs...)
++ return (list_has_loose_field && !parent.loose) ? content : Tag(:p)(content)
++end
++
++function mdconvert(t::Markdown.Table, parent; kwargs...)
++ @tags table tr th td
++ alignment_style = map(t.align) do align
++ if align == :r
++ "text-align: right"
++ elseif align == :c
++ "text-align: center"
++ else
++ "text-align: left"
++ end
++ end
++ table(
++ tr(map(enumerate(t.rows[1])) do (i, x)
++ th[:style => alignment_style[i]](mdconvert(x, t; kwargs...))
++ end),
++ map(t.rows[2:end]) do x
++ tr(map(enumerate(x)) do (i, y) # each cell in a row
++ td[:style => alignment_style[i]](mdconvert(y, x; kwargs...))
++ end)
++ end
++ )
++end
++
++mdconvert(expr::Union{Expr,Symbol}, parent; kwargs...) = string(expr)
++
++mdconvert(f::Markdown.Footnote, parent; kwargs...) = footnote(f.id, f.text, parent; kwargs...)
++footnote(id, text::Nothing, parent; kwargs...) = Tag(:a)[:href => "#footnote-$(id)"]("[$id]")
++function footnote(id, text, parent; kwargs...)
++ Tag(:div)[".footnote#footnote-$(id)"](
++ Tag(:a)[:href => "#footnote-$(id)"](Tag(:strong)("[$id]")),
++ mdconvert(text, parent; kwargs...),
++ )
++end
++
++function mdconvert(a::Markdown.Admonition, parent; kwargs...)
++ @tags div
++ div[".admonition.$(a.category)"](
++ div[".admonition-title"](a.title),
++ div[".admonition-text"](mdconvert(a.content, a; kwargs...))
++ )
++end
++
++mdconvert(html::Documents.RawHTML, parent; kwargs...) = Tag(Symbol("#RAW#"))(html.code)
++
++# Select the "best" representation for HTML output.
++mdconvert(mo::Documents.MultiOutput, parent; kwargs...) =
++ Base.invokelatest(mdconvert, mo.content, parent; kwargs...)
++function mdconvert(d::Dict{MIME,Any}, parent; kwargs...)
++ if haskey(d, MIME"text/html"())
++ out = Documents.RawHTML(d[MIME"text/html"()])
++ elseif haskey(d, MIME"image/svg+xml"())
++ out = Documents.RawHTML(d[MIME"image/svg+xml"()])
++ elseif haskey(d, MIME"image/png"())
++ out = Documents.RawHTML(string("<img src=\"data:image/png;base64,", d[MIME"image/png"()], "\" />"))
++ elseif haskey(d, MIME"image/webp"())
++ out = Documents.RawHTML(string("<img src=\"data:image/webp;base64,", d[MIME"image/webp"()], "\" />"))
++ elseif haskey(d, MIME"image/gif"())
++ out = Documents.RawHTML(string("<img src=\"data:image/gif;base64,", d[MIME"image/gif"()], "\" />"))
++ elseif haskey(d, MIME"image/jpeg"())
++ out = Documents.RawHTML(string("<img src=\"data:image/jpeg;base64,", d[MIME"image/jpeg"()], "\" />"))
++ elseif haskey(d, MIME"text/latex"())
++ out = Utilities.mdparse(d[MIME"text/latex"()]; mode = :single)
++ elseif haskey(d, MIME"text/markdown"())
++ out = Markdown.parse(d[MIME"text/markdown"()])
++ elseif haskey(d, MIME"text/plain"())
++ out = Markdown.Code(d[MIME"text/plain"()])
++ else
++ error("this should never happen.")
++ end
++ return mdconvert(out, parent; kwargs...)
++end
++
++# fixlinks!
++# ------------------------------------------------------------------------------
++
++"""
++Replaces URLs in `Markdown.Link` elements (if they point to a local `.md` page) with the
++actual URLs.
++"""
++function fixlinks!(ctx, navnode, link::Markdown.Link)
++ fixlinks!(ctx, navnode, link.text)
++ Utilities.isabsurl(link.url) && return
++
++ # links starting with a # are references within the same file -- there's nothing to fix
++ # for such links
++ startswith(link.url, '#') && return
++
++ s = split(link.url, "#", limit = 2)
++ if Sys.iswindows() && ':' in first(s)
++ @warn "invalid local link: colons not allowed in paths on Windows in $(Utilities.locrepr(navnode.page))" link = link.url
++ return
++ end
++ path = normpath(joinpath(dirname(navnode.page), first(s)))
++
++ if endswith(path, ".md") && path in keys(ctx.doc.blueprint.pages)
++ # make sure that links to different valid pages are correct
++ path = pretty_url(ctx, relhref(get_url(ctx, navnode), get_url(ctx, path)))
++ elseif isfile(joinpath(ctx.doc.user.build, path))
++ # update links to other files that are present in build/ (e.g. either user
++ # provided files or generated by code examples)
++ path = relhref(get_url(ctx, navnode), path)
++ else
++ @warn "invalid local link: unresolved path in $(Utilities.locrepr(navnode.page))" link = link.url
++ end
++
++ # Replace any backslashes in links, if building the docs on Windows
++ path = replace(path, '\\' => '/')
++ link.url = (length(s) > 1) ? "$path#$(last(s))" : String(path)
++end
++
++function fixlinks!(ctx, navnode, img::Markdown.Image)
++ Utilities.isabsurl(img.url) && return
++
++ if Sys.iswindows() && ':' in img.url
++ @warn "invalid local image: colons not allowed in paths on Windows in $(Utilities.locrepr(navnode.page))" link = img.url
++ return
++ end
++
++ path = joinpath(dirname(navnode.page), img.url)
++ if isfile(joinpath(ctx.doc.user.build, path))
++ path = relhref(get_url(ctx, navnode), path)
++ # Replace any backslashes in links, if building the docs on Windows
++ img.url = replace(path, '\\' => '/')
++ else
++ @warn "invalid local image: unresolved path in $(Utilities.locrepr(navnode.page))" link = img.url
++ end
++end
++
++fixlinks!(ctx, navnode, md::Markdown.MD) = fixlinks!(ctx, navnode, md.content)
++function fixlinks!(ctx, navnode, a::Markdown.Admonition)
++ fixlinks!(ctx, navnode, a.title)
++ fixlinks!(ctx, navnode, a.content)
++end
++fixlinks!(ctx, navnode, b::Markdown.BlockQuote) = fixlinks!(ctx, navnode, b.content)
++fixlinks!(ctx, navnode, b::Markdown.Bold) = fixlinks!(ctx, navnode, b.text)
++fixlinks!(ctx, navnode, f::Markdown.Footnote) = fixlinks!(ctx, navnode, f.text)
++fixlinks!(ctx, navnode, h::Markdown.Header) = fixlinks!(ctx, navnode, h.text)
++fixlinks!(ctx, navnode, i::Markdown.Italic) = fixlinks!(ctx, navnode, i.text)
++fixlinks!(ctx, navnode, list::Markdown.List) = fixlinks!(ctx, navnode, list.items)
++fixlinks!(ctx, navnode, p::Markdown.Paragraph) = fixlinks!(ctx, navnode, p.content)
++fixlinks!(ctx, navnode, t::Markdown.Table) = fixlinks!(ctx, navnode, t.rows)
++
++fixlinks!(ctx, navnode, mds::Vector) = map(md -> fixlinks!(ctx, navnode, md), mds)
++fixlinks!(ctx, navnode, md) = nothing
++
++# TODO: do some regex-magic in raw HTML blocks? Currently ignored.
++#fixlinks!(ctx, navnode, md::Documents.RawHTML) = ...
++
++end
--- /dev/null
--- /dev/null
++"""
++A module for rendering `Document` objects to LaTeX and PDF.
++
++# Keywords
++
++[`LaTeXWriter`](@ref) uses the following additional keyword arguments that can be passed to
++[`makedocs`](@ref Documenter.makedocs): `authors`, `sitename`.
++
++**`sitename`** is the site's title displayed in the title bar and at the top of the
++navigation menu. It goes into the `\\title` LaTeX command.
++
++**`authors`** can be used to specify the authors of. It goes into the `\\author` LaTeX command.
++
++"""
++module LaTeXWriter
++import ...Documenter: Documenter
++
++"""
++ LaTeXWriter.LaTeX(; kwargs...)
++
++Output format specifier that results in LaTeX/PDF output.
++Used together with [`makedocs`](@ref Documenter.makedocs), e.g.
++
++```julia
++makedocs(
++ format = LaTeX()
++)
++```
++
++The `makedocs` argument `sitename` will be used for the `\\title` field in the tex document,
++and if the build is for a release tag (i.e. when the `"TRAVIS_TAG"` environment variable is set)
++the version number will be appended to the title.
++The `makedocs` argument `authors` should also be specified, it will be used for the
++`\\authors` field in the tex document.
++
++# Keyword arguments
++
++**`platform`** sets the platform where the tex-file is compiled, either `"native"` (default) or `"docker"`.
++See [Other Output Formats](@ref) for more information.
++"""
++struct LaTeX <: Documenter.Writer
++ platform::String
++ function LaTeX(; platform = "native")
++ platform ∈ ("native", "docker") || throw(ArgumentError("unknown platform: $platform"))
++ return new(platform)
++ end
++end
++
++import ...Documenter:
++ Anchors,
++ Builder,
++ Documents,
++ Expanders,
++ Documenter,
++ Utilities,
++ Writers
++
++import Markdown
++
++mutable struct Context{I <: IO} <: IO
++ io::I
++ in_header::Bool
++ footnotes::Dict{String, Int}
++ depth::Int
++ filename::String # currently active source file
++end
++Context(io) = Context{typeof(io)}(io, false, Dict(), 1, "")
++
++_print(c::Context, args...) = Base.print(c.io, args...)
++_println(c::Context, args...) = Base.println(c.io, args...)
++
++
++const STYLE = joinpath(dirname(@__FILE__), "..", "..", "assets", "latex", "documenter.sty")
++
++hastex() = (try; success(`latexmk -version`); catch; false; end)
++
++const DOCUMENT_STRUCTURE = (
++ "part",
++ "chapter",
++ "section",
++ "subsection",
++ "subsubsection",
++ "paragraph",
++ "subparagraph",
++)
++
++function render(doc::Documents.Document, settings::LaTeX=LaTeX())
++ @info "LaTeXWriter: rendering PDF."
++ mktempdir() do path
++ cp(joinpath(doc.user.root, doc.user.build), joinpath(path, "build"))
++ cd(joinpath(path, "build")) do
++ name = doc.user.sitename
++ let tag = get(ENV, "TRAVIS_TAG", "")
++ if occursin(Base.VERSION_REGEX, tag)
++ v = VersionNumber(tag)
++ name *= "-$(v.major).$(v.minor).$(v.patch)"
++ end
++ end
++ name = replace(name, " " => "")
++ texfile = name * ".tex"
++ pdffile = name * ".pdf"
++ open(texfile, "w") do io
++ context = Context(io)
++ writeheader(context, doc)
++ for (title, filename, depth) in files(doc.user.pages)
++ context.filename = filename
++ empty!(context.footnotes)
++ if 1 <= depth <= length(DOCUMENT_STRUCTURE)
++ header_type = DOCUMENT_STRUCTURE[depth]
++ header_text = "\n\\$(header_type){$(title)}\n"
++ if isempty(filename)
++ _println(context, header_text)
++ else
++ path = normpath(filename)
++ page = doc.blueprint.pages[path]
++ if get(page.globals.meta, :IgnorePage, :none) !== :latex
++ context.depth = depth + (isempty(title) ? 0 : 1)
++ context.depth > depth && _println(context, header_text)
++ latex(context, page, doc)
++ end
++ end
++ end
++ end
++ writefooter(context, doc)
++ end
++ cp(STYLE, "documenter.sty")
++
++ # compile .tex and copy over the .pdf file if compile_tex return true
++ status = compile_tex(doc, settings, texfile)
++ status && cp(pdffile, joinpath(doc.user.root, doc.user.build, pdffile); force = true)
++
++ # Debug: if DOCUMENTER_LATEX_DEBUG environment variable is set, copy the LaTeX
++ # source files over to a directory under doc.user.root.
++ if haskey(ENV, "DOCUMENTER_LATEX_DEBUG")
++ sources = cp(pwd(), mktempdir(doc.user.root), force=true)
++ @info "LaTeX sources copied for debugging to $(sources)"
++ end
++ end
++ end
++end
++
++const DOCKER_IMAGE_TAG = "0.1"
++
++function compile_tex(doc::Documents.Document, settings::LaTeX, texfile::String)
++ if settings.platform == "native"
++ Sys.which("latexmk") === nothing && (@error "LaTeXWriter: latexmk command not found."; return false)
++ @info "LaTeXWriter: using latexmk to compile tex."
++ try
++ piperun(`latexmk -f -interaction=nonstopmode -view=none -lualatex -shell-escape $texfile`)
++ return true
++ catch err
++ logs = cp(pwd(), mktempdir(); force=true)
++ @error "LaTeXWriter: failed to compile tex with latexmk. " *
++ "Logs and partial output can be found in $(Utilities.locrepr(logs))." exception = err
++ return false
++ end
++ elseif settings.platform == "docker"
++ Sys.which("docker") === nothing && (@error "LaTeXWriter: docker command not found."; return false)
++ @info "LaTeXWriter: using docker to compile tex."
++ script = """
++ mkdir /home/zeptodoctor/build
++ cd /home/zeptodoctor/build
++ cp -r /mnt/. .
++ latexmk -f -interaction=nonstopmode -view=none -lualatex -shell-escape $texfile
++ """
++ try
++ piperun(`docker run -itd -u zeptodoctor --name latex-container -v $(pwd()):/mnt/ --rm juliadocs/documenter-latex:$(DOCKER_IMAGE_TAG)`)
++ piperun(`docker exec -u zeptodoctor latex-container bash -c $(script)`)
++ piperun(`docker cp latex-container:/home/zeptodoctor/build/. .`)
++ return true
++ catch err
++ logs = cp(pwd(), mktempdir(); force=true)
++ @error "LaTeXWriter: failed to compile tex with docker. " *
++ "Logs and partial output can be found in $(Utilities.locrepr(logs))." exception = err
++ return false
++ finally
++ try; piperun(`docker stop latex-container`); catch; end
++ end
++ end
++end
++
++function piperun(cmd)
++ verbose = "--verbose" in ARGS || get(ENV, "DOCUMENTER_VERBOSE", "false") == "true"
++ run(pipeline(cmd, stdout = verbose ? stdout : "LaTeXWriter.stdout",
++ stderr = verbose ? stderr : "LaTeXWriter.stderr"))
++end
++
++function writeheader(io::IO, doc::Documents.Document)
++ custom = joinpath(doc.user.root, doc.user.source, "assets", "custom.sty")
++ isfile(custom) ? cp(custom, "custom.sty"; force = true) : touch("custom.sty")
++ preamble =
++ """
++ \\documentclass{memoir}
++
++ \\usepackage{./documenter}
++ \\usepackage{./custom}
++
++ \\title{
++ {\\HUGE $(doc.user.sitename)}\\\\
++ {\\Large $(get(ENV, "TRAVIS_TAG", ""))}
++ }
++ \\author{$(doc.user.authors)}
++
++ \\begin{document}
++
++ \\frontmatter
++ \\maketitle
++ \\tableofcontents
++
++ \\mainmatter
++
++ """
++ _println(io, preamble)
++end
++
++function writefooter(io::IO, doc::Documents.Document)
++ _println(io, "\n\\end{document}")
++end
++
++function latex(io::IO, page::Documents.Page, doc::Documents.Document)
++ for element in page.elements
++ latex(io, page.mapping[element], page, doc)
++ end
++end
++
++function latex(io::IO, vec::Vector, page, doc)
++ for each in vec
++ latex(io, each, page, doc)
++ end
++end
++
++function latex(io::IO, anchor::Anchors.Anchor, page, doc)
++ id = string(hash(string(anchor.id, "-", anchor.nth)))
++ _println(io, "\n\\hypertarget{", id, "}{}\n")
++ latex(io, anchor.object, page, doc)
++end
++
++
++## Documentation Nodes.
++
++function latex(io::IO, node::Documents.DocsNodes, page, doc)
++ for node in node.nodes
++ latex(io, node, page, doc)
++ end
++end
++
++function latex(io::IO, node::Documents.DocsNode, page, doc)
++ id = string(hash(string(node.anchor.id)))
++ # Docstring header based on the name of the binding and it's category.
++ _println(io, "\\hypertarget{", id, "}{} ")
++ _print(io, "\\hyperlink{", id, "}{\\texttt{")
++ latexesc(io, string(node.object.binding))
++ _print(io, "}} ")
++ _println(io, " -- {", Utilities.doccat(node.object), ".}\n")
++ # # Body. May contain several concatenated docstrings.
++ _println(io, "\\begin{adjustwidth}{2em}{0pt}")
++ latexdoc(io, node.docstr, page, doc)
++ _println(io, "\n\\end{adjustwidth}")
++end
++
++function latexdoc(io::IO, md::Markdown.MD, page, doc)
++ if haskey(md.meta, :results)
++ # The `:results` field contains a vector of `Docs.DocStr` objects associated with
++ # each markdown object. The `DocStr` contains data such as file and line info that
++ # we need for generating correct scurce links.
++ for (markdown, result) in zip(md.content, md.meta[:results])
++ latex(io, Writers.MarkdownWriter.dropheaders(markdown), page, doc)
++ # When a source link is available then print the link.
++ url = Utilities.url(doc.internal.remote, doc.user.repo, result)
++ if url !== nothing
++ link = "\\href{$url}{\\texttt{source}}"
++ _println(io, "\n", link, "\n")
++ end
++ end
++ else
++ # Docstrings with no `:results` metadata won't contain source locations so we don't
++ # try to print them out. Just print the basic docstring.
++ render(io, mime, dropheaders(md), page, doc)
++ end
++end
++
++function latexdoc(io::IO, other, page, doc)
++ # TODO: properly support non-markdown docstrings at some point.
++ latex(io, other, page, doc)
++end
++
++
++## Index, Contents, and Eval Nodes.
++
++function latex(io::IO, index::Documents.IndexNode, page, doc)
++ _println(io, "\\begin{itemize}")
++ for (object, _, page, mod, cat) in index.elements
++ id = string(hash(string(Utilities.slugify(object))))
++ text = string(object.binding)
++ _print(io, "\\item \\hyperlink{")
++ _print(io, id, "}{\\texttt{")
++ latexesc(io, text)
++ _println(io, "}}")
++ end
++ _println(io, "\\end{itemize}\n")
++end
++
++function latex(io::IO, contents::Documents.ContentsNode, page, doc)
++ depth = 1
++ needs_end = false
++ _println(io, "\\begin{itemize}")
++ for (count, path, anchor) in contents.elements
++ header = anchor.object
++ level = Utilities.header_level(header)
++ id = string(hash(string(anchor.id, "-", anchor.nth)))
++ level < depth && (_println(io, "\\end{itemize}"); needs_end = false)
++ level > depth && (_println(io, "\\begin{itemize}"); needs_end = true)
++ _print(io, "\\item \\hyperlink{", id, "}{")
++ latexinline(io, header.text)
++ _println(io, "}")
++ depth = level
++ end
++ needs_end && _println(io, "\\end{itemize}")
++ _println(io, "\\end{itemize}")
++ _println(io)
++end
++
++function latex(io::IO, node::Documents.EvalNode, page, doc)
++ node.result === nothing ? nothing : latex(io, node.result, page, doc)
++end
++
++# Select the "best" representation for LaTeX output.
++using Base64: base64decode
++function latex(io::IO, mo::Documents.MultiOutput)
++ foreach(x->Base.invokelatest(latex, io, x), mo.content)
++end
++function latex(io::IO, d::Dict{MIME,Any})
++ filename = String(rand('a':'z', 7))
++ if haskey(d, MIME"image/png"())
++ write("$(filename).png", base64decode(d[MIME"image/png"()]))
++ _println(io, """
++ \\begin{figure}[H]
++ \\centering
++ \\includegraphics{$(filename)}
++ \\end{figure}
++ """)
++ elseif haskey(d, MIME"image/jpeg"())
++ write("$(filename).jpeg", base64decode(d[MIME"image/jpeg"()]))
++ _println(io, """
++ \\begin{figure}[H]
++ \\centering
++ \\includegraphics{$(filename)}
++ \\end{figure}
++ """)
++ elseif haskey(d, MIME"text/latex"())
++ latex(io, Utilities.mdparse(d[MIME"text/latex"()]; mode = :single))
++ elseif haskey(d, MIME"text/markdown"())
++ latex(io, Markdown.parse(d[MIME"text/markdown"()]))
++ elseif haskey(d, MIME"text/plain"())
++ latex(io, Markdown.Code(d[MIME"text/plain"()]))
++ else
++ error("this should never happen.")
++ end
++ return nothing
++end
++
++
++## Basic Nodes. AKA: any other content that hasn't been handled yet.
++
++latex(io::IO, str::AbstractString, page, doc) = _print(io, str)
++
++function latex(io::IO, other, page, doc)
++ _println(io)
++ latex(io, other)
++ _println(io)
++end
++
++latex(io::IO, md::Markdown.MD) = latex(io, md.content)
++
++function latex(io::IO, content::Vector)
++ for c in content
++ latex(io, c)
++ end
++end
++
++function latex(io::IO, h::Markdown.Header{N}) where N
++ tag = DOCUMENT_STRUCTURE[min(io.depth + N - 1, length(DOCUMENT_STRUCTURE))]
++ _print(io, "\\", tag, "{")
++ io.in_header = true
++ latexinline(io, h.text)
++ io.in_header = false
++ _println(io, "}\n")
++end
++
++# Whitelisted lexers.
++const LEXER = Set([
++ "julia",
++ "jlcon",
++])
++
++function latex(io::IO, code::Markdown.Code)
++ language = isempty(code.language) ? "none" : code.language
++ # the julia-repl is called "jlcon" in Pygments
++ language = (language == "julia-repl") ? "jlcon" : language
++ if language in LEXER
++ _print(io, "\n\\begin{minted}[escapeinside=\\%\\%]")
++ _println(io, "{", language, "}")
++ _print_code_escapes(io, code.code)
++ _println(io, "\\end{minted}\n")
++ else
++ _println(io, "\n\\begin{lstlisting}[escapeinside=\\%\\%]")
++ _print_code_escapes(io, code.code)
++ _println(io, "\\end{lstlisting}\n")
++ end
++end
++
++function _print_code_escapes(io, s::AbstractString)
++ for ch in s
++ ch === '%' ? _print(io, "%\\%%") :
++ ch === '⊻' ? _print(io, "%\\unicodeveebar%") :
++ _print(io, ch)
++ end
++end
++
++function latexinline(io::IO, code::Markdown.Code)
++ _print(io, "\\texttt{")
++ _print_code_escapes_inline(io, code.code)
++ _print(io, "}")
++end
++
++function _print_code_escapes_inline(io, s::AbstractString)
++ for ch in s
++ ch === '⊻' ? _print(io, "\\unicodeveebar{}") :
++ latexesc(io, ch)
++ end
++end
++
++function latex(io::IO, md::Markdown.Paragraph)
++ for md in md.content
++ latexinline(io, md)
++ end
++ _println(io, "\n")
++end
++
++function latex(io::IO, md::Markdown.BlockQuote)
++ wrapblock(io, "quote") do
++ latex(io, md.content)
++ end
++end
++
++function latex(io::IO, md::Markdown.Admonition)
++ wrapblock(io, "quote") do
++ wrapinline(io, "textbf") do
++ _print(io, md.title)
++ end
++ _println(io, "\n")
++ latex(io, md.content)
++ end
++end
++
++function latex(io::IO, f::Markdown.Footnote)
++ id = get(io.footnotes, f.id, 1)
++ _print(io, "\\footnotetext[", id, "]{")
++ latex(io, f.text)
++ _println(io, "}")
++end
++
++function latex(io::IO, md::Markdown.List)
++ # `\begin{itemize}` is used here for both ordered and unordered lists since providing
++ # custom starting numbers for enumerated lists is simpler to do by manually assigning
++ # each number to `\item` ourselves rather than using `\setcounter{enumi}{<start>}`.
++ #
++ # For an ordered list starting at 5 the following will be generated:
++ #
++ # \begin{itemize}
++ # \item[5. ] ...
++ # \item[6. ] ...
++ # ...
++ # \end{itemize}
++ #
++ pad = ndigits(md.ordered + length(md.items)) + 2
++ fmt = n -> (Markdown.isordered(md) ? "[$(rpad("$(n + md.ordered - 1).", pad))]" : "")
++ wrapblock(io, "itemize") do
++ for (n, item) in enumerate(md.items)
++ _print(io, "\\item$(fmt(n)) ")
++ latex(io, item)
++ n < length(md.items) && _println(io)
++ end
++ end
++end
++
++
++function latex(io::IO, hr::Markdown.HorizontalRule)
++ _println(io, "{\\rule{\\textwidth}{1pt}}")
++end
++
++# This (equation*, split) math env seems to be the only way to correctly
++# render all the equations in the Julia manual.
++function latex(io::IO, math::Markdown.LaTeX)
++ _print(io, "\\begin{equation*}\n\\begin{split}")
++ _print(io, math.formula)
++ _println(io, "\\end{split}\\end{equation*}")
++end
++
++function latex(io::IO, md::Markdown.Table)
++ _println(io, "\n\\begin{table}[h]")
++ _print(io, "\n\\begin{tabulary}{\\linewidth}")
++ _println(io, "{|", uppercase(join(md.align, '|')), "|}")
++ for (i, row) in enumerate(md.rows)
++ i === 1 && _println(io, "\\hline")
++ for (j, cell) in enumerate(row)
++ j === 1 || _print(io, " & ")
++ latexinline(io, cell)
++ end
++ _println(io, " \\\\")
++ _println(io, "\\hline")
++ end
++ _println(io, "\\end{tabulary}\n")
++ _println(io, "\\end{table}\n")
++end
++
++function latex(io::IO, raw::Documents.RawNode)
++ raw.name === :latex ? _println(io, "\n", raw.text, "\n") : nothing
++end
++
++# Inline Elements.
++
++function latexinline(io::IO, md::Vector)
++ for c in md
++ latexinline(io, c)
++ end
++end
++
++function latexinline(io::IO, md::AbstractString)
++ latexesc(io, md)
++end
++
++function latexinline(io::IO, md::Markdown.Bold)
++ wrapinline(io, "textbf") do
++ latexinline(io, md.text)
++ end
++end
++
++function latexinline(io::IO, md::Markdown.Italic)
++ wrapinline(io, "emph") do
++ latexinline(io, md.text)
++ end
++end
++
++function latexinline(io::IO, md::Markdown.Image)
++ wrapblock(io, "figure") do
++ _println(io, "\\centering")
++ url = if Utilities.isabsurl(md.url)
++ @warn "images with absolute URLs not supported in LaTeX output in $(Utilities.locrepr(io.filename))" url = md.url
++ # We nevertheless output an \includegraphics with the URL. The LaTeX build will
++ # then give an error, indicating to the user that something wrong. Only the
++ # warning would be drowned by all the output from LaTeX.
++ md.url
++ elseif startswith(md.url, '/')
++ # URLs starting with a / are assumed to be relative to the document's root
++ normpath(lstrip(md.url, '/'))
++ else
++ normpath(joinpath(dirname(io.filename), md.url))
++ end
++ url = replace(url, "\\" => "/") # use / on Windows too.
++ wrapinline(io, "includegraphics") do
++ _print(io, url)
++ end
++ _println(io)
++ wrapinline(io, "caption") do
++ latexinline(io, md.alt)
++ end
++ _println(io)
++ end
++end
++
++function latexinline(io::IO, f::Markdown.Footnote)
++ id = get!(io.footnotes, f.id, length(io.footnotes) + 1)
++ _print(io, "\\footnotemark[", id, "]")
++end
++
++function latexinline(io::IO, md::Markdown.Link)
++ if io.in_header
++ latexinline(io, md.text)
++ else
++ if occursin(".md#", md.url)
++ file, target = split(md.url, ".md#"; limit = 2)
++ id = string(hash(target))
++ wrapinline(io, "hyperlink") do
++ _print(io, id)
++ end
++ _print(io, "{")
++ latexinline(io, md.text)
++ _print(io, "}")
++ else
++ wrapinline(io, "href") do
++ latexesc(io, md.url)
++ end
++ _print(io, "{")
++ latexinline(io, md.text)
++ _print(io, "}")
++ end
++ end
++end
++
++function latexinline(io, math::Markdown.LaTeX)
++ # Handle MathJax and TeX inconsistency since the first wants `\LaTeX` wrapped
++ # in math delims, whereas actual TeX fails when that is done.
++ math.formula == "\\LaTeX" ? _print(io, math.formula) : _print(io, "\\(", math.formula, "\\)")
++end
++
++function latexinline(io, hr::Markdown.HorizontalRule)
++ _println(io, "\\rule{\\textwidth}{1pt}}")
++end
++
++
++# Metadata Nodes get dropped from the final output for every format but are needed throughout
++# rest of the build and so we just leave them in place and print a blank line in their place.
++latex(io::IO, node::Documents.MetaNode, page, doc) = _println(io, "\n")
++
++# Utilities.
++
++const _latexescape_chars = Dict{Char, AbstractString}(
++ '~' => "{\\textasciitilde}",
++ '^' => "{\\textasciicircum}",
++ '\\' => "{\\textbackslash}",
++ '\'' => "{\\textquotesingle}",
++ '"' => "{\\textquotedbl}",
++ '_' => "{\\_}",
++)
++for ch in "&%\$#_{}"
++ _latexescape_chars[ch] = "\\$ch"
++end
++
++latexesc(io, ch::AbstractChar) = _print(io, get(_latexescape_chars, ch, ch))
++
++function latexesc(io, s::AbstractString)
++ for ch in s
++ latexesc(io, ch)
++ end
++end
++
++latexesc(s) = sprint(latexesc, s)
++
++function wrapblock(f, io, env)
++ _println(io, "\\begin{", env, "}")
++ f()
++ _println(io, "\\end{", env, "}")
++end
++
++function wrapinline(f, io, cmd)
++ _print(io, "\\", cmd, "{")
++ f()
++ _print(io, "}")
++end
++
++
++function files!(out::Vector, v::Vector, depth)
++ for each in v
++ files!(out, each, depth + 1)
++ end
++ return out
++end
++
++# Tuples come from `hide(page)` with either
++# (visible, nothing, page, children) or
++# (visible, page.first, pages.second, children)
++function files!(out::Vector, v::Tuple, depth)
++ files!(out, v[2] == nothing ? v[3] : v[2] => v[3], depth)
++ files!(out, v[4], depth)
++end
++
++files!(out, s::AbstractString, depth) = push!(out, ("", s, depth))
++
++function files!(out, p::Pair{S, T}, depth) where {S <: AbstractString, T <: AbstractString}
++ push!(out, (p.first, p.second, depth))
++end
++
++function files!(out, p::Pair{S, V}, depth) where {S <: AbstractString, V}
++ push!(out, (p.first, "", depth))
++ files!(out, p.second, depth)
++end
++
++files(v::Vector) = files!(Tuple{String, String, Int}[], v, 0)
++
++end
--- /dev/null
--- /dev/null
++"""
++A module for rendering `Document` objects to markdown.
++"""
++module MarkdownWriter
++
++import ...Documenter:
++ Anchors,
++ Builder,
++ Documents,
++ Expanders,
++ Documenter,
++ Utilities
++
++# import Markdown as MarkdownStdlib
++module _Markdown
++ import Markdown
++end
++const MarkdownStdlib = _Markdown.Markdown
++
++struct Markdown <: Documenter.Writer
++end
++
++# return the same file with the extension changed to .md
++mdext(f) = string(splitext(f)[1], ".md")
++
++function render(doc::Documents.Document, settings::Markdown=Markdown())
++ @info "MarkdownWriter: rendering Markdown pages."
++ copy_assets(doc)
++ mime = MIME"text/plain"()
++ for (src, page) in doc.blueprint.pages
++ open(mdext(page.build), "w") do io
++ for elem in page.elements
++ node = page.mapping[elem]
++ render(io, mime, node, page, doc)
++ end
++ end
++ end
++end
++
++function copy_assets(doc::Documents.Document)
++ @debug "copying assets to build directory."
++ assets = joinpath(doc.internal.assets, "mkdocs")
++ if isdir(assets)
++ builddir = joinpath(doc.user.build, "assets")
++ isdir(builddir) || mkdir(builddir)
++ for each in readdir(assets)
++ src = joinpath(assets, each)
++ dst = joinpath(builddir, each)
++ ispath(dst) && @warn "Documenter: overwriting '$dst'."
++ cp(src, dst; force = true)
++ end
++ else
++ error("assets directory '$(abspath(assets))' is missing.")
++ end
++end
++
++function render(io::IO, mime::MIME"text/plain", vec::Vector, page, doc)
++ for each in vec
++ render(io, mime, each, page, doc)
++ end
++end
++
++function render(io::IO, mime::MIME"text/plain", anchor::Anchors.Anchor, page, doc)
++ println(io, "\n<a id='", anchor.id, "-", anchor.nth, "'></a>")
++ render(io, mime, anchor.object, page, doc)
++end
++
++
++## Documentation Nodes.
++
++function render(io::IO, mime::MIME"text/plain", node::Documents.DocsNodes, page, doc)
++ for node in node.nodes
++ render(io, mime, node, page, doc)
++ end
++end
++
++function render(io::IO, mime::MIME"text/plain", node::Documents.DocsNode, page, doc)
++ # Docstring header based on the name of the binding and it's category.
++ anchor = "<a id='$(node.anchor.id)' href='#$(node.anchor.id)'>#</a>"
++ header = "**`$(node.object.binding)`** — *$(Utilities.doccat(node.object))*."
++ println(io, anchor, "\n", header, "\n\n")
++ # Body. May contain several concatenated docstrings.
++ renderdoc(io, mime, node.docstr, page, doc)
++end
++
++function renderdoc(io::IO, mime::MIME"text/plain", md::MarkdownStdlib.MD, page, doc)
++ if haskey(md.meta, :results)
++ # The `:results` field contains a vector of `Docs.DocStr` objects associated with
++ # each markdown object. The `DocStr` contains data such as file and line info that
++ # we need for generating correct source links.
++ for (markdown, result) in zip(md.content, md.meta[:results])
++ render(io, mime, dropheaders(markdown), page, doc)
++ # When a source link is available then print the link.
++ url = Utilities.url(doc.internal.remote, doc.user.repo, result)
++ if url !== nothing
++ link = "<a target='_blank' href='$url' class='documenter-source'>source</a><br>"
++ println(io, "\n", link, "\n")
++ end
++ end
++ else
++ # Docstrings with no `:results` metadata won't contain source locations so we don't
++ # try to print them out. Just print the basic docstring.
++ render(io, mime, dropheaders(md), page, doc)
++ end
++end
++
++function renderdoc(io::IO, mime::MIME"text/plain", other, page, doc)
++ # TODO: properly support non-markdown docstrings at some point.
++ render(io, mime, other, page, doc)
++end
++
++
++## Index, Contents, and Eval Nodes.
++
++function render(io::IO, ::MIME"text/plain", index::Documents.IndexNode, page, doc)
++ for (object, _, page, mod, cat) in index.elements
++ page = mdext(page)
++ url = string(page, "#", Utilities.slugify(object))
++ println(io, "- [`", object.binding, "`](", url, ")")
++ end
++ println(io)
++end
++
++function render(io::IO, ::MIME"text/plain", contents::Documents.ContentsNode, page, doc)
++ for (count, path, anchor) in contents.elements
++ path = mdext(path)
++ header = anchor.object
++ url = string(path, '#', anchor.id, '-', anchor.nth)
++ link = MarkdownStdlib.Link(header.text, url)
++ level = Utilities.header_level(header)
++ print(io, " "^(level - 1), "- ")
++ MarkdownStdlib.plaininline(io, link)
++ println(io)
++ end
++ println(io)
++end
++
++function render(io::IO, mime::MIME"text/plain", node::Documents.EvalNode, page, doc)
++ node.result === nothing ? nothing : render(io, mime, node.result, page, doc)
++end
++
++# Select the "best" representation for Markdown output.
++using Base64: base64decode
++function render(io::IO, mime::MIME"text/plain", d::Documents.MultiOutput, page, doc)
++ foreach(x -> Base.invokelatest(render, io, mime, x, page, doc), d.content)
++end
++function render(io::IO, mime::MIME"text/plain", d::Dict{MIME,Any}, page, doc)
++ filename = String(rand('a':'z', 7))
++ if haskey(d, MIME"text/markdown"())
++ println(io, d[MIME"text/markdown"()])
++ elseif haskey(d, MIME"text/html"())
++ println(io, d[MIME"text/html"()])
++ elseif haskey(d, MIME"image/svg+xml"())
++ # NOTE: It seems that we can't simply save the SVG images as a file and include them
++ # as browsers seem to need to have the xmlns attribute set in the <svg> tag if you
++ # want to include it with <img>. However, setting that attribute is up to the code
++ # creating the SVG image.
++ println(io, d[MIME"image/svg+xml"()])
++ elseif haskey(d, MIME"image/png"())
++ write(joinpath(dirname(page.build), "$(filename).png"), base64decode(d[MIME"image/png"()]))
++ println(io, """
++ .png)
++ """)
++ elseif haskey(d, MIME"image/webp"())
++ write(joinpath(dirname(page.build), "$(filename).webp"), base64decode(d[MIME"image/webp"()]))
++ println(io, """
++ .webp)
++ """)
++ elseif haskey(d, MIME"image/jpeg"())
++ write(joinpath(dirname(page.build), "$(filename).jpeg"), base64decode(d[MIME"image/jpeg"()]))
++ println(io, """
++ .jpeg)
++ """)
++ elseif haskey(d, MIME"image/gif"())
++ write(joinpath(dirname(page.build), "$(filename).gif"), base64decode(d[MIME"image/gif"()]))
++ println(io, """
++ .gif)
++ """)
++ elseif haskey(d, MIME"text/plain"())
++ render(io, mime, MarkdownStdlib.Code(d[MIME"text/plain"()]), page, doc)
++ else
++ error("this should never happen.")
++ end
++ return nothing
++end
++
++
++## Basic Nodes. AKA: any other content that hasn't been handled yet.
++
++function render(io::IO, ::MIME"text/plain", other, page, doc)
++ println(io)
++ MarkdownStdlib.plain(io, other)
++ println(io)
++end
++
++render(io::IO, ::MIME"text/plain", str::AbstractString, page, doc) = print(io, str)
++
++# Metadata Nodes get dropped from the final output for every format but are needed throughout
++# rest of the build and so we just leave them in place and print a blank line in their place.
++render(io::IO, ::MIME"text/plain", node::Documents.MetaNode, page, doc) = println(io, "\n")
++
++function render(io::IO, ::MIME"text/plain", raw::Documents.RawNode, page, doc)
++ raw.name === :html ? println(io, "\n", raw.text, "\n") : nothing
++end
++
++
++## Markdown Utilities.
++
++# Remove all header nodes from a markdown object and replace them with bold font.
++# Only for use in `text/plain` output, since we'll use some css to make these less obtrusive
++# in the HTML rendering instead of using this hack.
++function dropheaders(md::MarkdownStdlib.MD)
++ out = MarkdownStdlib.MD()
++ out.meta = md.meta
++ out.content = map(dropheaders, md.content)
++ out
++end
++dropheaders(h::MarkdownStdlib.Header) = MarkdownStdlib.Paragraph([MarkdownStdlib.Bold(h.text)])
++dropheaders(v::Vector) = map(dropheaders, v)
++dropheaders(other) = other
++
++end
--- /dev/null
--- /dev/null
++"""
++A module that provides several renderers for `Document` objects. The supported
++formats are currently:
++
++ * `:markdown` -- the default format.
++ * `:html` -- generates a complete HTML site with navigation and search included.
++ * `:latex` -- generates a PDF using LuaLaTeX.
++
++"""
++module Writers
++
++import ..Documenter:
++ Anchors,
++ Builder,
++ Documents,
++ Expanders,
++ Documenter,
++ Utilities
++
++import .Utilities: Selectors
++
++#
++# Format selector definitions.
++#
++
++abstract type FormatSelector <: Selectors.AbstractSelector end
++
++abstract type MarkdownFormat <: FormatSelector end
++abstract type LaTeXFormat <: FormatSelector end
++abstract type HTMLFormat <: FormatSelector end
++
++Selectors.order(::Type{MarkdownFormat}) = 1.0
++Selectors.order(::Type{LaTeXFormat}) = 2.0
++Selectors.order(::Type{HTMLFormat}) = 3.0
++
++Selectors.matcher(::Type{MarkdownFormat}, fmt, _) = isa(fmt, MarkdownWriter.Markdown)
++Selectors.matcher(::Type{LaTeXFormat}, fmt, _) = isa(fmt, LaTeXWriter.LaTeX)
++Selectors.matcher(::Type{HTMLFormat}, fmt, _) = isa(fmt, HTMLWriter.HTML)
++
++Selectors.runner(::Type{MarkdownFormat}, fmt, doc) = MarkdownWriter.render(doc, fmt)
++Selectors.runner(::Type{LaTeXFormat}, fmt, doc) = LaTeXWriter.render(doc, fmt)
++Selectors.runner(::Type{HTMLFormat}, fmt, doc) = HTMLWriter.render(doc, fmt)
++
++"""
++Writes a [`Documents.Document`](@ref) object to `.user.build` directory in
++the formats specified in the `.user.format` vector.
++
++Adding additional formats requires adding new `Selector` definitions as follows:
++
++```julia
++abstract type CustomFormat <: FormatSelector end
++
++Selectors.order(::Type{CustomFormat}) = 4.0 # or a higher number.
++Selectors.matcher(::Type{CustomFormat}, fmt, _) = fmt === :custom
++Selectors.runner(::Type{CustomFormat}, _, doc) = CustomWriter.render(doc)
++
++# Definition of `CustomWriter` module below...
++```
++"""
++function render(doc::Documents.Document)
++ # Render each format. Additional formats must define an `order`, `matcher`, `runner`, as
++ # well as their own rendering methods in a separate module.
++ for each in doc.user.format
++ if isa(each, MarkdownWriter.Markdown) && !backends_enabled[:markdown]
++ @warn """Deprecated format
++
++ The Markdown/MkDocs backend must now be imported from a separate package.
++ Add DocumenterMarkdown to your documentation dependencies and add
++
++ using DocumenterMarkdown
++
++ to your make.jl script, and use
++
++ makedocs(
++ format = Markdown(),
++ ...
++ )
++
++ in the call to `makedocs`.
++ Built-in support for markdown outpu will be removed completely in a future
++ Documenter version, causing builds to fail completely.
++
++ See the Output Backends section in the manual for more information.
++ """
++ elseif isa(each, LaTeXWriter.LaTeX) && !backends_enabled[:latex]
++ @warn """Deprecated format
++
++ The LaTeX/PDF backend must now be imported from a separate package.
++ Add DocumenterLaTeX to your documentation dependencies and add
++
++ using DocumenterLaTeX
++
++ to your make.jl script, and use
++
++ makedocs(
++ format = LaTeX(),
++ ...
++ )
++
++ in the call to `makedocs`.
++ Built-in support for LaTeX/PDF output will be removed completely in a future
++ Documenter version, causing builds to fail completely.
++
++ See the Output Backends section in the manual for more information.
++ """
++ end
++ Selectors.dispatch(FormatSelector, each, doc)
++ end
++ # Revert all local links to their original URLs.
++ for (link, url) in doc.internal.locallinks
++ link.url = url
++ end
++end
++
++include("MarkdownWriter.jl")
++include("HTMLWriter.jl")
++include("LaTeXWriter.jl")
++
++# This is hack to enable shell packages that would behave as in the supplementary Writer
++# modules have been moved out of Documenter.
++#
++# External packages DocumenterMarkdown and DocumenterLaTeX can use the enable_backend
++# function to mark that a certain backend is loaded in backends_enabled. That is used to
++# determine whether a deprecation warning should be printed in the render method above.
++#
++# enable_backend() is not part of the API and will be removed as soon as LaTeXWriter and
++# MarkdownWriter are actually moved out into a separate module (TODO).
++backends_enabled = Dict(
++ :markdown => false,
++ :latex => false
++)
++
++function enable_backend(backend::Symbol)
++ global backends_enabled
++ if backend in keys(backends_enabled)
++ backends_enabled[backend] = true
++ else
++ @error "Unknown backend. Expected one of:" keys(backends_enabled)
++ throw(ArgumentError("Unknown backend $backend."))
++ end
++end
++
++end
--- /dev/null
--- /dev/null
++module DocCheckTests
++
++using Test
++
++using Markdown
++using Documenter.DocChecks: linkcheck
++using Documenter.Documents
++
++@testset "DocChecks" begin
++ # The linkcheck tests are currently not reliable on CI, so they are disabled.
++ @testset "linkcheck" begin
++ src = md"""
++ [HTTP (HTTP/1.1) success](http://www.google.com)
++ [HTTPS (HTTP/2) success](https://www.google.com)
++ [FTP success](ftp://ftp.iana.org/tz/data/etcetera)
++ [FTP (no proto) success](ftp.iana.org/tz/data/etcetera)
++ [Redirect success](google.com)
++ [HEAD fail GET success](https://codecov.io/gh/invenia/LibPQ.jl)
++ """
++
++ Documents.walk(Dict{Symbol, Any}(), src) do block
++ doc = Documents.Document(; linkcheck=true)
++ result = linkcheck(block, doc)
++ @test_skip doc.internal.errors == Set{Symbol}()
++ result
++ end
++
++ src = Markdown.parse("[FILE failure](file://$(@__FILE__))")
++ doc = Documents.Document(; linkcheck=true)
++ Documents.walk(Dict{Symbol, Any}(), src) do block
++ linkcheck(block, doc)
++ end
++ @test_skip doc.internal.errors == Set{Symbol}([:linkcheck])
++ end
++end
++
++end
--- /dev/null
--- /dev/null
++module DocSystemTests
++
++using Test
++
++import Documenter: Documenter, DocSystem
++
++const alias_of_getdocs = DocSystem.getdocs # NOTE: won't get docstrings if in a @testset
++
++@testset "DocSystem" begin
++ ## Bindings.
++ @test_throws ArgumentError DocSystem.binding(9000)
++ let b = Docs.Binding(@__MODULE__, :DocSystem)
++ @test DocSystem.binding(b) == b
++ end
++ let b = DocSystem.binding(Documenter.Documents.Document)
++ @test b.mod === Documenter.Documents
++ @test b.var === :Document
++ end
++ let b = DocSystem.binding(Documenter)
++ @test b.mod === (Documenter)
++ @test b.var === :Documenter
++ end
++ let b = DocSystem.binding(:Main)
++ # @test b.mod === Main
++ @test b.var === :Main
++ end
++ let b = DocSystem.binding(DocSystem.binding)
++ @test b.mod === DocSystem
++ @test b.var === :binding
++ end
++ let b = DocSystem.binding(Documenter, :Documenter)
++ @test b.mod === (Documenter)
++ @test b.var === :Documenter
++ end
++
++ ## `MultiDoc` object.
++ @test isdefined(DocSystem, :MultiDoc)
++ @test (fieldnames(DocSystem.MultiDoc)...,) == (:order, :docs)
++
++ ## `DocStr` object.
++ @test isdefined(DocSystem, :DocStr)
++ @test (fieldnames(DocSystem.DocStr)...,) == (:text, :object, :data)
++ ## `getdocs`.
++ let b = DocSystem.binding(DocSystem, :getdocs),
++ d_0 = DocSystem.getdocs(b, Tuple{}),
++ d_1 = DocSystem.getdocs(b),
++ d_2 = DocSystem.getdocs(b, Union{Tuple{Any}, Tuple{Any, Type}}; compare = (==)),
++ d_3 = DocSystem.getdocs(b; modules = Module[Main]),
++ d_4 = DocSystem.getdocs(DocSystem.binding(@__MODULE__, :alias_of_getdocs)),
++ d_5 = DocSystem.getdocs(DocSystem.binding(@__MODULE__, :alias_of_getdocs); aliases = false)
++
++ @test length(d_0) == 0
++ @test length(d_1) == 2
++ @test length(d_2) == 1
++ @test length(d_3) == 0
++ @test length(d_4) == 2
++ @test length(d_5) == 0
++
++ @test d_1[1].data[:binding] == b
++ @test d_1[2].data[:binding] == b
++ @test d_1[1].data[:typesig] == Union{Tuple{Docs.Binding}, Tuple{Docs.Binding, Type}}
++ @test d_1[2].data[:typesig] == Union{Tuple{Any}, Tuple{Any, Type}}
++ @test d_1[1].data[:module] == DocSystem
++ @test d_1[2].data[:module] == DocSystem
++
++ @test d_2[1].data[:binding] == b
++ @test d_2[1].data[:typesig] == Union{Tuple{Any}, Tuple{Any, Type}}
++ @test d_2[1].data[:module] == DocSystem
++
++ @test d_1 == d_4
++ @test d_1 != d_5
++ end
++
++ ## `UnionAll`
++ let b = DocSystem.binding(@__MODULE__, Meta.parse("f(x::T) where T"))
++ @test b.var == :f
++ end
++end
++
++end
--- /dev/null
--- /dev/null
++module DocMetaTests
++using Test
++using Documenter
++
++module TestMod
++module Submodule end
++end
++
++@testset "DocMeta" begin
++ @test DocMeta.getdocmeta(TestMod) == Dict()
++ @test DocMeta.getdocmeta(TestMod, :DocTestSetup) === nothing
++ @test DocMeta.getdocmeta(TestMod, :DocTestSetup, 42) === 42
++ @test DocMeta.setdocmeta!(TestMod, :DocTestSetup, :foo) === nothing
++ @test DocMeta.getdocmeta(TestMod) == Dict(:DocTestSetup => :foo)
++ @test DocMeta.getdocmeta(TestMod, :DocTestSetup) == :foo
++ @test DocMeta.getdocmeta(TestMod, :DocTestSetup, 42) == :foo
++ # bad key
++ @test_throws ArgumentError DocMeta.setdocmeta!(TestMod, :FooBar, 0)
++ # bad argument type
++ @test_throws ArgumentError DocMeta.setdocmeta!(TestMod, :DocTestSetup, 42)
++ # setting again works
++ @test DocMeta.setdocmeta!(TestMod, :DocTestSetup, :foo; warn=false) === nothing
++ # recursive setting
++ @test DocMeta.getdocmeta(TestMod, :DocTestSetup) == :foo
++ @test DocMeta.getdocmeta(TestMod.Submodule, :DocTestSetup) === nothing
++ @test DocMeta.setdocmeta!(TestMod, :DocTestSetup, :foo; recursive=true, warn=false) === nothing
++ @test DocMeta.getdocmeta(TestMod, :DocTestSetup) == :foo
++ @test DocMeta.getdocmeta(TestMod.Submodule, :DocTestSetup) == :foo
++end
++
++end
--- /dev/null
--- /dev/null
++# Tests for the public doctest() function
++#
++# If the tests are giving you trouble, you can run the tests with
++#
++# JULIA_DEBUG=DocTestAPITests julia doctests.jl
++#
++# TODO: Combine the makedocs calls and stdout files. Also, allow running them one by one.
++#
++module DocTestAPITests
++using Test
++using Documenter
++
++# Test the Documenter.doctest function
++# ------------------------------------
++function run_doctest(f, args...; kwargs...)
++ (result, success, backtrace, output) = Documenter.Utilities.withoutput() do
++ # Running inside a Task to make sure that the parent testsets do not interfere.
++ t = Task(() -> doctest(args...; kwargs...))
++ schedule(t)
++ fetch(t) # if an exception happens, it gets propagated
++ end
++
++ @debug """run_doctest($args;, $kwargs) -> $(success ? "success" : "fail")
++ ------------------------------------ output ------------------------------------
++ $(output)
++ --------------------------------------------------------------------------------
++ """ result stacktrace(backtrace)
++
++ f(result, success, backtrace, output)
++end
++
++"""
++```jldoctest
++julia> 2 + 2
++4
++```
++"""
++module DocTest1 end
++
++"""
++```jldoctest
++julia> 2 + 2
++5
++```
++"""
++module DocTest2 end
++
++"""
++```jldoctest
++julia> x
++42
++```
++"""
++module DocTest3 end
++
++module DocTest4
++ """
++ ```jldoctest
++ julia> x
++ 42
++ ```
++ """
++ function foo end
++ module Submodule
++ """
++ ```jldoctest
++ julia> x + 1
++ 43
++ ```
++ """
++ function foo end
++ end
++end
++
++module DocTest5
++ """
++ ```jldoctest
++ julia> x
++ 42
++ ```
++ """
++ function foo end
++ """
++ ```jldoctest
++ julia> x
++ 4200
++ ```
++ """
++ module Submodule
++ """
++ ```jldoctest
++ julia> x + 1
++ 4201
++ ```
++ """
++ function foo end
++ end
++end
++
++"""
++```jldoctest
++julia> map(tuple, 1/(i+j) for i=1:2, j=1:2, [1:4;])
++ERROR: syntax: invalid iteration specification
++```
++```jldoctest
++julia> 1.2.3
++ERROR: syntax: invalid numeric constant "1.2."
++```
++```jldoctest
++println(9.8.7)
++# output
++ERROR: syntax: invalid numeric constant "9.8."
++```
++```jldoctest
++julia> Meta.ParseError("foo")
++Base.Meta.ParseError("foo")
++
++julia> Meta.ParseError("foo") |> throw
++ERROR: Base.Meta.ParseError("foo")
++Stacktrace:
++[...]
++```
++"""
++module ParseErrorSuccess end
++
++"""
++```jldoctest
++julia> map(tuple, 1/(i+j) for i=1:2, j=1:2, [1:4;])
++ERROR: syntax: invalid iteration specificationX
++```
++"""
++module ParseErrorFail end
++
++"""
++```jldoctest
++println(9.8.7)
++# output
++ERROR: syntax: invalid numeric constant "1.2."
++```
++"""
++module ScriptParseErrorFail end
++
++@testset "Documenter.doctest" begin
++ # DocTest1
++ run_doctest(nothing, [DocTest1]) do result, success, backtrace, output
++ @test success
++ @test result isa Test.DefaultTestSet
++ end
++
++ # DocTest2
++ run_doctest(nothing, [DocTest2]) do result, success, backtrace, output
++ @test !success
++ @test result isa TestSetException
++ end
++
++ # DocTest3
++ run_doctest(nothing, [DocTest3]) do result, success, backtrace, output
++ @test !success
++ @test result isa TestSetException
++ end
++ DocMeta.setdocmeta!(DocTest3, :DocTestSetup, :(x = 42))
++ run_doctest(nothing, [DocTest3]) do result, success, backtrace, output
++ @test success
++ @test result isa Test.DefaultTestSet
++ end
++
++ # DocTest4
++ run_doctest(nothing, [DocTest4]) do result, success, backtrace, output
++ @test !success
++ @test result isa TestSetException
++ end
++ DocMeta.setdocmeta!(DocTest4, :DocTestSetup, :(x = 42))
++ run_doctest(nothing, [DocTest4]) do result, success, backtrace, output
++ @test !success
++ @test result isa TestSetException
++ end
++ DocMeta.setdocmeta!(DocTest4, :DocTestSetup, :(x = 42); recursive = true, warn = false)
++ run_doctest(nothing, [DocTest4]) do result, success, backtrace, output
++ @test success
++ @test result isa Test.DefaultTestSet
++ end
++
++ # DocTest5
++ run_doctest(nothing, [DocTest5]) do result, success, backtrace, output
++ @test !success
++ @test result isa TestSetException
++ end
++ DocMeta.setdocmeta!(DocTest5, :DocTestSetup, :(x = 42))
++ DocMeta.setdocmeta!(DocTest5.Submodule, :DocTestSetup, :(x = 4200))
++ run_doctest(nothing, [DocTest5]) do result, success, backtrace, output
++ @test success
++ @test result isa Test.DefaultTestSet
++ end
++
++ # Parse errors in doctests (https://github.com/JuliaDocs/Documenter.jl/issues/1046)
++ run_doctest(nothing, [ParseErrorSuccess]) do result, success, backtrace, output
++ @test success
++ @test result isa Test.DefaultTestSet
++ end
++ run_doctest(nothing, [ParseErrorFail]) do result, success, backtrace, output
++ @test !success
++ @test result isa TestSetException
++ end
++ run_doctest(nothing, [ScriptParseErrorFail]) do result, success, backtrace, output
++ @test !success
++ @test result isa TestSetException
++ end
++end
++
++end # module
--- /dev/null
--- /dev/null
++# To fix all the output reference, run this file with
++#
++# DOCUMENTER_FIXTESTS= julia doctests.jl
++#
++# If the inputs and outputs are giving you trouble, you can run the tests with
++#
++# JULIA_DEBUG=DocTestsTests julia doctests.jl
++#
++# TODO: Combine the makedocs calls and stdout files. Also, allow running them one by one.
++#
++module DocTestsTests
++using Test
++using Documenter
++using Documenter.Utilities.TextDiff: Diff, Words
++
++include("src/FooWorking.jl")
++include("src/FooBroken.jl")
++include("src/NoMeta.jl")
++
++const builds_directory = joinpath(@__DIR__, "builds")
++ispath(builds_directory) && rm(builds_directory, recursive=true)
++mkpath(builds_directory)
++
++function run_makedocs(f, mdfiles, modules=Module[]; kwargs...)
++ dir = mktempdir(builds_directory)
++ srcdir = joinpath(dir, "src"); mkpath(srcdir)
++
++ for mdfile in mdfiles
++ cp(joinpath(@__DIR__, "src", mdfile), joinpath(srcdir, mdfile))
++ end
++
++ (result, success, backtrace, output) = Documenter.Utilities.withoutput() do
++ makedocs(
++ sitename = " ",
++ root = dir,
++ modules = modules;
++ kwargs...
++ )
++ end
++
++ @debug """run_makedocs($mdfiles, modules=$modules) -> $(success ? "success" : "fail")
++ ------------------------------------ output ------------------------------------
++ $(output)
++ --------------------------------------------------------------------------------
++ """ result stacktrace(backtrace) dir
++
++ write(joinpath(dir, "output"), output)
++ write(joinpath(dir, "output.onormalize"), onormalize(output))
++ open(joinpath(dir, "result"), "w") do io
++ show(io, "text/plain", result)
++ println(io, "-"^80)
++ show(io, "text/plain", stacktrace(backtrace))
++ end
++
++ f(result, success, backtrace, output)
++end
++
++function printoutput(result, success, backtrace, output)
++ printstyled("="^80, color=:cyan); println()
++ println(output)
++ printstyled("-"^80, color=:cyan); println()
++ println(repr(result))
++ printstyled("-"^80, color=:cyan); println()
++end
++
++function onormalize(s)
++ # Runs a bunch of regexes on captured documenter output strings to remove any machine /
++ # platform / environment / time dependent parts, so that it would actually be possible
++ # to compare Documenter output to previously generated reference outputs.
++
++ # Remove filesystem paths in doctests failures
++ s = replace(s, r"(doctest failure in )(.*)$"m => s"\1{PATH}")
++ s = replace(s, r"(@ Documenter.DocTests )(.*)$"m => s"\1{PATH}")
++
++ # Remove stacktraces
++ s = replace(s, r"(│\s+Stacktrace:)(\n(│\s+)\[[0-9]+\].*)*" => s"\1\\n\3{STACKTRACE}")
++
++ return s
++end
++
++function is_same_as_file(output, filename)
++ # Compares output to the contents of a reference file. Runs onormalize on both strings
++ # before doing a character-by-character comparison.
++ fixtests = haskey(ENV, "DOCUMENTER_FIXTESTS")
++ success = if isfile(filename)
++ reference = read(filename, String)
++ if onormalize(reference) != onormalize(output)
++ diff = Diff{Words}(onormalize(reference), onormalize(output))
++ @error """Output does not agree with reference file
++ ref: $(filename)
++ ------------------------------------ output ------------------------------------
++ $(output)
++ ---------------------------------- reference ----------------------------------
++ $(reference)
++ ------------------------------ onormalize(output) ------------------------------
++ $(onormalize(output))
++ ---------------------------- onormalize(reference) ----------------------------
++ $(onormalize(reference))
++ """ diff
++ false
++ else
++ true
++ end
++ else
++ fixtests || error("Missing reference file: $(filename)")
++ false
++ end
++ if fixtests && !success
++ @info "Updating $(filename)"
++ write(filename, output)
++ success = true
++ end
++ return success
++end
++
++rfile(filename) = joinpath(@__DIR__, "stdouts", filename)
++
++@testset "doctesting" begin
++ # So, we have 4 doctests: 2 in a docstring, 2 in an .md file. One of either pair is
++ # OK, other is broken. Here we first test all possible combinations of these doctest
++ # with strict = true to make sure that the doctests are indeed failing.
++ #
++ # Some tests are broken due to https://github.com/JuliaDocs/Documenter.jl/issues/974
++ run_makedocs(["working.md"]; strict=true) do result, success, backtrace, output
++ @test success
++ @test is_same_as_file(output, rfile("1.stdout"))
++ end
++
++ run_makedocs(["broken.md"]; strict=true) do result, success, backtrace, output
++ @test !success
++ @test is_same_as_file(output, rfile("2.stdout"))
++ end
++
++ run_makedocs(["working.md", "fooworking.md"]; modules=[FooWorking], strict=true) do result, success, backtrace, output
++ @test success
++ @test is_same_as_file(output, rfile("3.stdout"))
++ end
++
++ run_makedocs(["working.md", "foobroken.md"]; modules=[FooBroken], strict=true) do result, success, backtrace, output
++ @test !success
++ @test is_same_as_file(output, rfile("4.stdout"))
++ end
++
++ run_makedocs(["broken.md", "fooworking.md"]; modules=[FooWorking], strict=true) do result, success, backtrace, output
++ @test !success
++ @test is_same_as_file(output, rfile("5.stdout"))
++ end
++
++ run_makedocs(["broken.md", "foobroken.md"]; modules=[FooBroken], strict=true) do result, success, backtrace, output
++ @test !success
++ @test is_same_as_file(output, rfile("6.stdout"))
++ end
++
++ run_makedocs(["fooworking.md"]; modules=[FooWorking], strict=true) do result, success, backtrace, output
++ @test success
++ @test is_same_as_file(output, rfile("7.stdout"))
++ end
++
++ run_makedocs(["foobroken.md"]; modules=[FooBroken], strict=true) do result, success, backtrace, output
++ @test !success
++ @test is_same_as_file(output, rfile("8.stdout"))
++ end
++
++ # Here we try the default (strict = false) -- output should say that doctest failed, but
++ # success should still be true.
++ run_makedocs(["working.md"]) do result, success, backtrace, output
++ @test success
++ @test is_same_as_file(output, rfile("11.stdout"))
++ end
++
++ run_makedocs(["broken.md"]) do result, success, backtrace, output
++ @test success
++ @test is_same_as_file(output, rfile("12.stdout"))
++ end
++
++ # Tests for doctest = :only. The outout should reflect that the docs themselves do not
++ # get built.
++ run_makedocs(["working.md"]; modules=[FooWorking], doctest = :only) do result, success, backtrace, output
++ @test success
++ @test is_same_as_file(output, rfile("21.stdout"))
++ end
++
++ run_makedocs(["working.md"]; modules=[FooBroken], doctest = :only) do result, success, backtrace, output
++ @test !success
++ @test is_same_as_file(output, rfile("22.stdout"))
++ end
++
++ run_makedocs(["broken.md"]; modules=[FooWorking], doctest = :only) do result, success, backtrace, output
++ @test !success
++ @test is_same_as_file(output, rfile("23.stdout"))
++ end
++
++ run_makedocs(["broken.md"]; modules=[FooBroken], doctest = :only) do result, success, backtrace, output
++ @test !success
++ @test is_same_as_file(output, rfile("24.stdout"))
++ end
++ # strict gets ignored with doctest = :only
++ run_makedocs(["broken.md"]; modules=[FooBroken], doctest = :only, strict=false) do result, success, backtrace, output
++ @test !success
++ @test is_same_as_file(output, rfile("25.stdout"))
++ end
++
++ # DocTestSetup in modules
++ run_makedocs([]; modules=[NoMeta], doctest = :only) do result, success, backtrace, output
++ @test !success
++ @test is_same_as_file(output, rfile("31.stdout"))
++ end
++ # Now, let's use Documenter's APIs to add the necessary meta information
++ DocMeta.setdocmeta!(NoMeta, :DocTestSetup, :(baz(x) = 2x))
++ run_makedocs([]; modules=[NoMeta], doctest = :only) do result, success, backtrace, output
++ @test success
++ @test is_same_as_file(output, rfile("32.stdout"))
++ end
++end
++
++using Documenter.DocTests: remove_common_backtrace
++@testset "DocTest.remove_common_backtrace" begin
++ @test remove_common_backtrace([], []) == []
++ @test remove_common_backtrace([1], []) == [1]
++ @test remove_common_backtrace([1,2], []) == [1,2]
++ @test remove_common_backtrace([1,2,3], [1]) == [1,2,3]
++ @test remove_common_backtrace([1,2,3], [2]) == [1,2,3]
++ @test remove_common_backtrace([1,2,3], [3]) == [1,2]
++ @test remove_common_backtrace([1,2,3], [2,3]) == [1]
++ @test remove_common_backtrace([1,2,3], [1,3]) == [1,2]
++ @test remove_common_backtrace([1,2,3], [1,2,3]) == []
++ @test remove_common_backtrace([1,2,3], [0,1,2,3]) == []
++end
++
++end # module
--- /dev/null
--- /dev/null
++module Foo
++"""
++```jldoctest
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++
++julia> Int64[1, 2, 3, 4]
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest
++julia> Int64[1, 2, 3, 4]
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest
++julia> begin
++ Int64[1, 2, 3, 4] * 2
++ end
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest
++Int64[1, 2, 3, 4] * 2
++
++# output
++
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest; filter = r"foo"
++julia> println(" foobar")
++ foobaz
++```
++```jldoctest
++julia> 1 + 2
++
++julia> 3 + 4
++```
++"""
++foo() = 1
++
++ """
++ ```jldoctest
++ julia> begin
++ Int64[1, 2, 3, 4] * 2
++ end
++ 4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++ ```
++ ```jldoctest
++ julia> println(); println("foo")
++
++ bar
++ ```
++ """
++ foo(x) = 1
++
++end # module
--- /dev/null
--- /dev/null
++```@docs
++DocTestFixTest.Foo.foo
++```
++
++```jldoctest
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++
++julia> Int64[1, 2, 3, 4]
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest
++julia> Int64[1, 2, 3, 4]
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest
++julia> begin
++ Int64[1, 2, 3, 4] * 2
++ end
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest
++Int64[1, 2, 3, 4] * 2
++
++# output
++
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest; filter = r"foo"
++julia> println(" foobar")
++ foobaz
++```
++```jldoctest
++julia> 1 + 2
++
++julia> 3 + 4
++```
--- /dev/null
--- /dev/null
++module Foo
++"""
++```jldoctest
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++
++julia> Int64[1, 2, 3, 4]
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest
++julia> Int64[1, 2, 3, 4]
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++```
++```jldoctest
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++```
++```jldoctest
++julia> begin
++ Int64[1, 2, 3, 4] * 2
++ end
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++```
++```jldoctest
++Int64[1, 2, 3, 4] * 2
++
++# output
++
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++```
++```jldoctest; filter = r"foo"
++julia> println(" foobar")
++ foobar
++```
++```jldoctest
++julia> 1 + 2
++3
++
++julia> 3 + 4
++7
++```
++"""
++foo() = 1
++
++ """
++ ```jldoctest
++ julia> begin
++ Int64[1, 2, 3, 4] * 2
++ end
++ 4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++ ```
++ ```jldoctest
++ julia> println(); println("foo")
++
++ foo
++ ```
++ """
++ foo(x) = 1
++
++end # module
--- /dev/null
--- /dev/null
++```@docs
++DocTestFixTest.Foo.foo
++```
++
++```jldoctest
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++
++julia> Int64[1, 2, 3, 4]
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++```
++```jldoctest
++julia> Int64[1, 2, 3, 4]
++4-element Array{Int64,1}:
++ 1
++ 2
++ 3
++ 4
++
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++```
++```jldoctest
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++
++julia> Int64[1, 2, 3, 4] * 2
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++```
++```jldoctest
++julia> begin
++ Int64[1, 2, 3, 4] * 2
++ end
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++```
++```jldoctest
++Int64[1, 2, 3, 4] * 2
++
++# output
++
++4-element Array{Int64,1}:
++ 2
++ 4
++ 6
++ 8
++```
++```jldoctest; filter = r"foo"
++julia> println(" foobar")
++ foobar
++```
++```jldoctest
++julia> 1 + 2
++3
++
++julia> 3 + 4
++7
++```
--- /dev/null
--- /dev/null
++# Tests for doctest = :fix
++#
++# DOCUMENTER_TEST_DEBUG= JULIA_DEBUG=all julia test/doctests/fix/tests.jl
++#
++module DocTestFixTest
++using Documenter, Test
++
++function test_doctest_fix(dir)
++ srcdir = mktempdir(dir)
++ builddir = mktempdir(dir)
++ @debug "Testing doctest = :fix" srcdir builddir
++ cp(joinpath(@__DIR__, "broken.md"), joinpath(srcdir, "index.md"))
++ cp(joinpath(@__DIR__, "broken.jl"), joinpath(srcdir, "src.jl"))
++
++ # fix up
++ include(joinpath(srcdir, "src.jl")); @eval import .Foo
++ @debug "Running doctest/fix doctests with doctest=:fix"
++ makedocs(sitename="-", modules = [Foo], source = srcdir, build = builddir, doctest = :fix)
++
++ # test that strict = true works
++ include(joinpath(srcdir, "src.jl")); @eval import .Foo
++ @debug "Running doctest/fix doctests with doctest=true"
++ makedocs(sitename="-", modules = [Foo], source = srcdir, build = builddir, strict = true)
++
++ # also test that we obtain the expected output
++ @test read(joinpath(srcdir, "index.md"), String) == read(joinpath(@__DIR__, "fixed.md"), String)
++ @test read(joinpath(srcdir, "src.jl"), String) == read(joinpath(@__DIR__, "fixed.jl"), String)
++end
++
++println("="^50)
++@info("Testing `doctest = :fix`")
++if haskey(ENV, "DOCUMENTER_TEST_DEBUG")
++ # in this mode the directories remain
++ test_doctest_fix(mktempdir(@__DIR__))
++else
++ mktempdir(test_doctest_fix, @__DIR__)
++end
++@info("Done testing `doctest = :fix`")
++println("="^50)
++
++end # module
--- /dev/null
--- /dev/null
++module FooBroken
++
++"""
++This docstring contains a broken doctest:
++
++```jldoctest
++julia> 2 + 2
++42
++```
++"""
++function foo end
++
++end
--- /dev/null
--- /dev/null
++module FooWorking
++
++"""
++This docstring contains a passing doctest:
++
++```jldoctest
++julia> 2 + 2
++4
++```
++"""
++function foo end
++
++end
--- /dev/null
--- /dev/null
++module NoMeta
++
++"""
++This docstring contains a doctest that needs a DocTestSetup
++
++```jldoctest
++julia> baz(20)
++40
++```
++"""
++function foo end
++
++"""
++This docstring contains a doctest that needs a DocTestSetup, but it's provided:
++
++```@meta
++DocTestSetup = quote
++ qux(x) = 3x
++end
++```
++
++```jldoctest
++julia> qux(10)
++30
++```
++
++```@meta
++DocTestSetup = nothing
++```
++"""
++function bar end
++
++end
--- /dev/null
--- /dev/null
++This source file contains a broken doctest:
++
++```jldoctest
++julia> 2 + 2
++-6
++```
--- /dev/null
--- /dev/null
++```@autodocs
++Modules = [DocTestsTests.FooBroken]
++```
--- /dev/null
--- /dev/null
++```@autodocs
++Modules = [DocTestsTests.FooWorking]
++```
--- /dev/null
--- /dev/null
++This source file contains a working doctest:
++
++```jldoctest
++julia> 2 + 2
++4
++```
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++[ Info: ExpandTemplates: expanding markdown templates.
++[ Info: CrossReferences: building cross-references.
++[ Info: CheckDocument: running document checks.
++[ Info: Populate: populating indices.
++[ Info: RenderDocument: rendering document.
++[ Info: HTMLWriter: rendering HTML pages.
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++[ Info: ExpandTemplates: expanding markdown templates.
++[ Info: CrossReferences: building cross-references.
++[ Info: CheckDocument: running document checks.
++[ Info: Populate: populating indices.
++[ Info: RenderDocument: rendering document.
++[ Info: HTMLWriter: rendering HTML pages.
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++┌ Error: doctest failure in src/broken.md:3-6
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ -6
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ -6
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ -64
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
++[ Info: ExpandTemplates: expanding markdown templates.
++[ Info: CrossReferences: building cross-references.
++[ Info: CheckDocument: running document checks.
++[ Info: Populate: populating indices.
++[ Info: RenderDocument: rendering document.
++[ Info: HTMLWriter: rendering HTML pages.
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++┌ Error: doctest failure in src/broken.md:3-6
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ -6
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ -6
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ -64
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++[ Info: Skipped ExpandTemplates step (doctest only).
++[ Info: Skipped CrossReferences step (doctest only).
++[ Info: Skipped CheckDocument step (doctest only).
++[ Info: Skipped Populate step (doctest only).
++[ Info: Skipped RenderDocument step (doctest only).
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++┌ Error: doctest failure in ~/Julia/JuliaDocs/Documenter/test/doctests/src/FooBroken.jl:6-9
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ 42
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ 42
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ 424
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++┌ Error: doctest failure in src/broken.md:3-6
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ -6
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ -6
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ -64
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++┌ Error: doctest failure in src/broken.md:3-6
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ -6
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ -6
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ -64
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
++┌ Error: doctest failure in ~/Julia/JuliaDocs/Documenter/test/doctests/src/FooBroken.jl:6-9
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ 42
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ 42
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ 424
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++┌ Error: doctest failure in src/broken.md:3-6
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ -6
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ -6
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ -64
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
++┌ Error: doctest failure in ~/Julia/JuliaDocs/Documenter/test/doctests/src/FooBroken.jl:6-9
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ 42
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ 42
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ 424
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++[ Info: ExpandTemplates: expanding markdown templates.
++[ Info: CrossReferences: building cross-references.
++[ Info: CheckDocument: running document checks.
++[ Info: Populate: populating indices.
++[ Info: RenderDocument: rendering document.
++[ Info: HTMLWriter: rendering HTML pages.
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++┌ Error: doctest failure in ~/Julia/JuliaDocs/Documenter/test/doctests/src/NoMeta.jl:6-9
++│
++│ ```jldoctest
++│ julia> baz(20)
++│ 40
++│ ```
++│
++│ Subexpression:
++│
++│ baz(20)
++│
++│ Evaluated output:
++│
++│ ERROR: UndefVarError: baz not defined
++│ Stacktrace:
++│ [1] top-level scope at none:0
++│
++│ Expected output:
++│
++│ 40
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ 40ERROR: UndefVarError: baz not defined
++│ Stacktrace:
++│ [1] top-level scope at none:0
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:349
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++[ Info: Skipped ExpandTemplates step (doctest only).
++[ Info: Skipped CrossReferences step (doctest only).
++[ Info: Skipped CheckDocument step (doctest only).
++[ Info: Skipped Populate step (doctest only).
++[ Info: Skipped RenderDocument step (doctest only).
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++┌ Error: doctest failure in ~/Julia/JuliaDocs/Documenter/test/doctests/src/FooBroken.jl:6-9
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ 42
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ 42
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ 424
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++┌ Error: doctest failure in src/broken.md:3-6
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ -6
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ -6
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ -64
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++┌ Error: doctest failure in src/broken.md:3-6
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ -6
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ -6
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ -64
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
++┌ Error: doctest failure in ~/Julia/JuliaDocs/Documenter/test/doctests/src/FooBroken.jl:6-9
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ 42
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ 42
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ 424
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++[ Info: ExpandTemplates: expanding markdown templates.
++[ Info: CrossReferences: building cross-references.
++[ Info: CheckDocument: running document checks.
++[ Info: Populate: populating indices.
++[ Info: RenderDocument: rendering document.
++[ Info: HTMLWriter: rendering HTML pages.
--- /dev/null
--- /dev/null
++[ Info: SetupBuildDirectory: setting up build directory.
++[ Info: Doctest: running doctests.
++┌ Error: doctest failure in ~/Julia/JuliaDocs/Documenter/test/doctests/src/FooBroken.jl:6-9
++│
++│ ```jldoctest
++│ julia> 2 + 2
++│ 42
++│ ```
++│
++│ Subexpression:
++│
++│ 2 + 2
++│
++│ Evaluated output:
++│
++│ 4
++│
++│ Expected output:
++│
++│ 42
++│
++│ diff =
++│ Warning: Diff output requires color.
++│ 424
++└ @ Documenter.DocTests ~/Julia/JuliaDocs/Documenter/src/DocTests.jl:336
--- /dev/null
--- /dev/null
++module DOMTests
++
++using Test
++
++import Documenter.Utilities.DOM: DOM, @tags, HTMLDocument
++
++@tags div ul li p
++
++@testset "DOM" begin
++ for tag in (:div, :ul, :li, :p)
++ TAG = @eval $tag
++ @test isa(TAG, DOM.Tag)
++ @test TAG.name === tag
++ end
++
++ @test div().name === :div
++ @test div().text == ""
++ @test isempty(div().nodes)
++ @test isempty(div().attributes)
++
++ @test div("...").name === :div
++ @test div("...").text == ""
++ @test length(div("...").nodes) === 1
++ @test div("...").nodes[1].text == "..."
++ @test div("...").nodes[1].name === Symbol("")
++ @test isempty(div("...").attributes)
++
++ @test div[".class"]("...").name === :div
++ @test div[".class"]("...").text == ""
++ @test length(div[".class"]("...").nodes) === 1
++ @test div[".class"]("...").nodes[1].text == "..."
++ @test div[".class"]("...").nodes[1].name === Symbol("")
++ @test length(div[".class"]("...").attributes) === 1
++ @test div[".class"]("...").attributes[1] == (:class => "class")
++ @test div[:attribute].attributes[1] == (:attribute => "")
++ @test div[:attribute => "value"].attributes[1] == (:attribute => "value")
++
++ let d = div(ul(map(li, [string(n) for n = 1:10])))
++ @test d.name === :div
++ @test d.text == ""
++ @test isempty(d.attributes)
++ @test length(d.nodes) === 1
++ let u = d.nodes[1]
++ @test u.name === :ul
++ @test u.text == ""
++ @test isempty(u.attributes)
++ @test length(u.nodes) === 10
++ for n = 1:10
++ let v = u.nodes[n]
++ @test v.name === :li
++ @test v.text == ""
++ @test isempty(v.attributes)
++ @test length(v.nodes) === 1
++ @test v.nodes[1].name === Symbol("")
++ @test v.nodes[1].text == string(n)
++ @test !isdefined(v.nodes[1], :attributes)
++ @test !isdefined(v.nodes[1], :nodes)
++ end
++ end
++ end
++ end
++
++ @tags script style img
++
++ @test string(div(p("one"), p("two"))) == "<div><p>one</p><p>two</p></div>"
++ @test string(div[:key => "value"]) == "<div key=\"value\"></div>"
++ @test string(p(" < > & ' \" ")) == "<p> < > & ' " </p>"
++ @test string(img[:src => "source"]) == "<img src=\"source\"/>"
++ @test string(img[:none]) == "<img none/>"
++ @test string(script(" < > & ' \" ")) == "<script> < > & ' \" </script>"
++ @test string(style(" < > & ' \" ")) == "<style> < > & ' \" </style>"
++ @test string(script) == "<script>"
++
++ function locally_defined()
++ @tags button
++ @test try
++ x = button
++ true
++ catch err
++ false
++ end
++ end
++ @test !isdefined(@__MODULE__, :button)
++ locally_defined()
++ @test !isdefined(@__MODULE__, :button)
++
++ # HTMLDocument
++ @test string(HTMLDocument(div())) == "<!DOCTYPE html>\n<div></div>\n"
++ @test string(HTMLDocument("custom doctype", div())) == "<!DOCTYPE custom doctype>\n<div></div>\n"
++end
++
++end
--- /dev/null
--- /dev/null
++module ErrorsModule
++
++"""
++```jldoctest
++julia> a = 1
++2
++
++```
++
++```jldoctest
++```
++"""
++func(x) = x
++
++end
++
++using Documenter
++
++makedocs(sitename="-", modules = [ErrorsModule])
++
++@test_throws ErrorException makedocs(modules = [ErrorsModule], strict = true)
--- /dev/null
--- /dev/null
++
++```@docs
++missing_doc
++```
++
++```@docs
++parse error
++```
++
++```@meta
++CurrentModule = NonExistantModule
++```
++
++```@autodocs
++Modules = [NonExistantModule]
++```
++
++```@eval
++NonExistantModule
++```
++
++```@docs
++# comment in a @docs block
++```
++
++[`foo(x::Foo)`](@ref) creates an [`UndefVarError`](@ref) when `eval`d
++for the type signature, since `Foo` is not defined.
++
++Numeric literals don't have bindings: [`1`](@ref). Nor [`"strings"`](@ref).
++[`:symbols`] do, however.
++
++Some syntax errors in references will fail with an `ParseError`: [`foo+*bar`](@ref).
++Others, like [`foo(x`](@ref) will give an `:incomplete` expression.
++
++This is the footnote [^1]. And [^another] [^another].
++
++[^1]: one
++
++ [^nested]: a nested footnote
++
++[^another_one]:
++
++ Things! [^1]. [^2].
++
++[^nested]
++
++[^nested]:
++
++ Duplicate [^1] nested footnote.
++
++```@docs
++ErrorsModule.func
++```
++
++```jldoctest
++julia> b = 1
++2
++
++julia> x
++
++julia> x
++ERROR: UndefVarError: x not defined
++
++julia> x
++```
++
++```jldoctest; setup
++julia> 1+1
++2
++```
++```jldoctest invalidkwarg1; setup
++julia> 1+1
++2
++```
++```jldoctest; setup == 1
++julia> 1+1
++2
++```
++```jldoctest invalidkwarg2; setup == 1
++julia> 1+1
++2
++```
++
++```jldoctest; output = false
++foo(a, b) = a * b
++foo(2, 3)
++
++# output
++
++1
++```
++```jldoctest; output = true
++foo(a, b) = a * b
++foo(2, 3)
++
++# output
++
++1
++```
--- /dev/null
--- /dev/null
++# Defines the modules referred to in the example docs (under src/) and then builds them.
++# It can be called separately to build the examples/, or as part of the test suite.
++#
++# It defines a set of variables (`examples_*`) that can be used in the tests.
++# The `examples_root` should be used to check whether this file has already been included
++# or not and should be kept unique.
++isdefined(@__MODULE__, :examples_root) && error("examples_root is already defined\n$(@__FILE__) included multiple times?")
++
++# The `Mod` and `AutoDocs` modules are assumed to exists in the Main module.
++(@__MODULE__) === Main || error("$(@__FILE__) must be included into Main.")
++
++# Modules `Mod` and `AutoDocs`
++module Mod
++ """
++ func(x)
++
++ [`T`](@ref)
++ """
++ func(x) = x
++
++ """
++ T
++
++ [`func(x)`](@ref)
++ """
++ mutable struct T end
++end
++
++"`AutoDocs` module."
++module AutoDocs
++ module Pages
++ include("pages/a.jl")
++ include("pages/b.jl")
++ include("pages/c.jl")
++ include("pages/d.jl")
++ include("pages/e.jl")
++ end
++
++ "Function `f`."
++ f(x) = x
++
++ "Constant `K`."
++ const K = 1
++
++ "Type `T`."
++ mutable struct T end
++
++ "Macro `@m`."
++ macro m() end
++
++ "Module `A`."
++ module A
++ "Function `A.f`."
++ f(x) = x
++
++ "Constant `A.K`."
++ const K = 1
++
++ "Type `B.T`."
++ mutable struct T end
++
++ "Macro `B.@m`."
++ macro m() end
++ end
++
++ "Module `B`."
++ module B
++ "Function `B.f`."
++ f(x) = x
++
++ "Constant `B.K`."
++ const K = 1
++
++ "Type `B.T`."
++ mutable struct T end
++
++ "Macro `B.@m`."
++ macro m() end
++ end
++
++ module Filter
++ "abstract super type"
++ abstract type Major end
++
++ "abstract sub type 1"
++ abstract type Minor1 <: Major end
++
++ "abstract sub type 2"
++ abstract type Minor2 <: Major end
++
++ "random constant"
++ qq = 3.14
++
++ "random function"
++ function qqq end
++ end
++end
++
++# Build example docs
++using Documenter, DocumenterMarkdown
++
++const examples_root = @__DIR__
++const builds_directory = joinpath(examples_root, "builds")
++ispath(builds_directory) && rm(builds_directory, recursive=true)
++
++expandfirst = ["expandorder/AA.md"]
++
++@info("Building mock package docs: MarkdownWriter")
++examples_markdown_doc = makedocs(
++ format = Markdown(),
++ debug = true,
++ root = examples_root,
++ build = "builds/markdown",
++ doctest = false,
++ expandfirst = expandfirst,
++)
++
++
++htmlbuild_pages = Any[
++ "**Home**" => "index.md",
++ "Manual" => [
++ "man/tutorial.md",
++ ],
++ hide("hidden.md"),
++ "Library" => [
++ "lib/functions.md",
++ "lib/autodocs.md",
++ ],
++ hide("Hidden Pages" => "hidden/index.md", Any[
++ "Page X" => "hidden/x.md",
++ "hidden/y.md",
++ "hidden/z.md",
++ ]),
++ "Expandorder" => [
++ "expandorder/00.md",
++ "expandorder/01.md",
++ "expandorder/AA.md",
++ ],
++ "unicode.md",
++]
++
++@info("Building mock package docs: HTMLWriter / local build")
++examples_html_local_doc = makedocs(
++ debug = true,
++ root = examples_root,
++ build = "builds/html-local",
++ doctestfilters = [r"Ptr{0x[0-9]+}"],
++ sitename = "Documenter example",
++ pages = htmlbuild_pages,
++ expandfirst = expandfirst,
++
++ linkcheck = true,
++ linkcheck_ignore = [r"(x|y).md", "z.md", r":func:.*"],
++ format = Documenter.HTML(
++ assets = ["assets/custom.css"],
++ prettyurls = false,
++ edit_branch = nothing,
++ ),
++)
++
++# Build with pretty URLs and canonical links and a PNG logo
++@info("Building mock package docs: HTMLWriter / deployment build")
++
++function withassets(f, assets...)
++ src(asset) = joinpath(@__DIR__, asset)
++ dst(asset) = joinpath(@__DIR__, "src/assets/$(basename(asset))")
++ for asset in assets
++ isfile(src(asset)) || error("$(asset) is missing")
++ end
++ for asset in assets
++ cp(src(asset), dst(asset))
++ end
++ rv = try
++ f()
++ catch exception
++ @warn "f() threw an exception" exception
++ nothing
++ end
++ for asset in assets
++ rm(dst(asset))
++ end
++ return rv
++end
++
++examples_html_deploy_doc = withassets("images/logo.png", "images/logo.jpg", "images/logo.gif") do
++ makedocs(
++ debug = true,
++ root = examples_root,
++ build = "builds/html-deploy",
++ doctestfilters = [r"Ptr{0x[0-9]+}"],
++ sitename = "Documenter example",
++ pages = htmlbuild_pages,
++ expandfirst = expandfirst,
++ doctest = false,
++ format = Documenter.HTML(
++ assets = [
++ "assets/favicon.ico",
++ "assets/custom.css"
++ ],
++ prettyurls = true,
++ canonical = "https://example.com/stable",
++ )
++ )
++end
--- /dev/null
--- /dev/null
++site_name: Documenter.jl
++repo_url: https://github.com/JuliaDocs/Documenter.jl
++site_description: Julia package documentation generator.
++site_author: Michael Hatherly
++
++theme: material
++
++extra:
++ palette:
++ primary: 'indigo'
++ accent: 'blue'
++
++extra_css:
++ - assets/Documenter.css
++
++markdown_extensions:
++ - codehilite
++ - extra
++ - tables
++ - fenced_code
++
++extra_javascript:
++ - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS_HTML
++ - assets/mathjaxhelper.js
++
++docs_dir: 'builds/markdown'
++
++pages:
++- Home: index.md
++- Manual:
++ - Tutorial: man/tutorial.md
++- Library:
++ - Functions: lib/functions.md
++ - AutoDocs: lib/autodocs.md
--- /dev/null
--- /dev/null
++
++"""
++`f` from page `a.jl`.
++
++Links:
++
++- [`ccall`](@ref)
++- [`while`](@ref)
++- [`@time(x)`](@ref)
++- [`T(x)`](@ref)
++- [`T(x, y)`](@ref)
++- [`f(::Integer)`](@ref)
++- [`f(::Any)`](@ref)
++- [`f(::Any, ::Any)`](@ref)
++- [`f(x, y, z)`](@ref)
++
++[^footnote]:
++
++ Footnote contents. [^footnote]
++
++"""
++f(x) = x
--- /dev/null
--- /dev/null
++
++"""
++`f` from page `b.jl`.
++
++Links:
++
++- [`ccall`](@ref)
++- [`while`](@ref)
++- [`@time`](@ref)
++- [`T`](@ref)
++- [`f`](@ref)
++- [`f(::Any)`](@ref)
++- [`f(::Any, ::Any)`](@ref)
++- [`f(::Any, ::Any, ::Any)`](@ref)
++
++"""
++f(x, y) = x + y
--- /dev/null
--- /dev/null
++
++"""
++`f` from page `c.jl`.
++
++Links:
++
++- [`ccall`](@ref)
++- [`while`](@ref)
++- [`@time`](@ref)
++- [`T`](@ref)
++- [`f`](@ref)
++- [`f(::Any)`](@ref)
++- [`f(::Any, ::Any)`](@ref)
++- [`f(::Any, ::Any, ::Any)`](@ref)
++
++"""
++f(x, y, z) = x + y + z
--- /dev/null
--- /dev/null
++
++"""
++`T` from page `d.jl`.
++
++Links:
++
++- [`ccall`](@ref)
++- [`while`](@ref)
++- [`@time`](@ref)
++- [`T`](@ref)
++- [`f`](@ref)
++- [`f(x)`](@ref)
++- [`f(x, y)`](@ref)
++- [`f(::Any, ::Any, ::Any)`](@ref)
++
++"""
++mutable struct T end
++
++
++"""
++`T` from page `d.jl`.
++
++Links:
++
++- [`ccall`](@ref)
++- [`while`](@ref)
++- [`@time`](@ref)
++- [`T(x)`](@ref)
++- [`T(x, y)`](@ref)
++- [`T(x, y, z)`](@ref)
++- [`f`](@ref)
++- [`f(x)`](@ref)
++- [`f(x, y)`](@ref)
++- [`f(::Any, ::Any, ::Any)`](@ref)
++
++"""
++T(x) = T()
++
++"""
++`T` from page `d.jl`.
++
++Links:
++
++- [`ccall`](@ref)
++- [`while`](@ref)
++- [`@time`](@ref)
++- [`T()`](@ref)
++- [`T(x)`](@ref)
++- [`T(x, y)`](@ref)
++- [`T(x, y, z)`](@ref)
++- [`f`](@ref)
++- [`f(x)`](@ref)
++- [`f(x, y)`](@ref)
++- [`f(::Any, ::Any, ::Any)`](@ref)
++
++"""
++T(x, y) = T()
--- /dev/null
--- /dev/null
++module E
++
++export f_1, f_2, f_3
++
++"f_1"
++f_1(x) = x
++
++"f_2"
++f_2(x) = x
++
++"f_3"
++f_3(x) = x
++
++
++"g_1"
++g_1(x) = x
++
++"g_2"
++g_2(x) = x
++
++"g_3"
++g_3(x) = x
++
++export T_1
++
++"T_1"
++mutable struct T_1 end
++
++"T_2"
++mutable struct T_2 end
++
++"T_3"
++struct T_3{T} end
++
++end
--- /dev/null
--- /dev/null
++/* custom.css */
++
++center.raw-html-block {
++ color: red;
++}
--- /dev/null
--- /dev/null
++// custom javascript
--- /dev/null
--- /dev/null
++// overrides Documenter's search.js
--- /dev/null
--- /dev/null
++# Expand order test 00
++
++Filename suggest that this will be expanded before `01.md`.
++
++```@example
++touch("00.txt")
++```
--- /dev/null
--- /dev/null
++# Expand order test 01
++
++This should be expanded after `00.md` and `AA.md`.
++
++```@example
++isfile("00.txt") || error("00.txt missing")
++```
++
++```@example
++isfile("AA.txt") || error("AA.txt missing")
++```
--- /dev/null
--- /dev/null
++# Expand order test AA
++
++Filename suggest that this will be expanded after `00.md` and `01.md`.
++Hence we use `expandfirst` to force this to be expanded first.
++
++```@example
++touch("AA.txt")
++```
--- /dev/null
--- /dev/null
++# Hidden (toplevel)
++
++## Section
--- /dev/null
--- /dev/null
++# Hidden pages
++
++Pages can be hidden with the [`hide`](@ref) function.
++
++## List of hidden pages
++
++- [Hidden page 1](x.md)
++- [Hidden page 2](y.md)
++- [Hidden page 3](z.md)
++
++## Docs for `hide`
++
++```@docs
++hide
++```
--- /dev/null
--- /dev/null
++# Hidden 1
++
++## First heading
++## Second heading
--- /dev/null
--- /dev/null
++# Hidden 2
--- /dev/null
--- /dev/null
++# Hidden 3
--- /dev/null
--- /dev/null
++# Documentation
++
++## Index Page
++
++```@contents
++Pages = ["index.md"]
++Depth = 5
++```
++
++## Functions Contents
++
++```@contents
++Pages = ["lib/functions.md"]
++Depth = 3
++```
++
++## Tutorial Contents
++
++```@contents
++Pages = ["man/tutorial.md"]
++```
++
++## Index
++
++```@index
++```
++
++### Embedded `@ref` links headers: [`ccall`](@ref)
++
++[#60](@ref) [#61](@ref)
++
++```@repl
++zeros(5, 5)
++zeros(50, 50)
++```
++
++```@meta
++DocTestSetup = quote
++ using Base
++ x = -3:0.01:3
++ y = -4:0.02:5
++ z = [Float64((xi^2 + yi^2)) for xi in x, yi in y]
++end
++```
++
++```jldoctest
++julia> [1.0, 2.0, 3.0]
++3-element Array{Float64,1}:
++ 1.0
++ 2.0
++ 3.0
++
++```
++
++```jldoctest
++julia> println(" "^5)
++
++julia> "\nfoo\n\nbar\n\n\nbaz"
++"\nfoo\n\nbar\n\n\nbaz"
++
++julia> println(ans)
++
++foo
++
++bar
++
++
++baz
++```
++
++ * `one` two three
++ * four `five` six
++
++ * ```
++ one
++ ```
++
++## Raw Blocks
++
++```@raw html
++<center class="raw-html-block">
++ <strong>CENTER</strong>
++</center>
++```
++
++```@raw latex
++\begin{verbatim}
++```
++
++```@raw latex
++\end{verbatim}
++```
++
++# Symbols in doctests
++
++```jldoctest
++julia> a = :undefined
++:undefined
++
++julia> a
++:undefined
++```
++
++# Named doctests
++
++```jldoctest test-one
++julia> a = 1
++1
++```
++
++```jldoctest test-one
++julia> a + 1
++2
++```
++
++# Filtered doctests
++
++## Global
++
++```jldoctest
++julia> print("Ptr{0x123456}")
++Ptr{0x654321}
++```
++
++## Local
++```@meta
++DocTestFilters = [r"foo[a-z]+"]
++```
++
++```jldoctest
++julia> print("foobar")
++foobuu
++```
++
++```@meta
++DocTestFilters = [r"foo[a-z]+", r"[0-9]+"]
++```
++
++```jldoctest
++julia> print("foobar123")
++foobuu456
++```
++
++```@meta
++DocTestFilters = r"foo[a-z]+"
++```
++
++```jldoctest
++julia> print("foobar")
++foobuu
++```
++
++```@meta
++DocTestFilters = []
++```
++
++## Errors
++
++```@meta
++DocTestFilters = [r"Stacktrace:\n \[1\][\s\S]+"]
++```
++
++```jldoctest
++julia> error()
++ERROR:
++Stacktrace:
++ [1] error() at ./thisfiledoesnotexist.jl:123456789
++```
++
++
++```jldoctest
++julia> error()
++ERROR:
++Stacktrace:
++[...]
++```
++
++```@meta
++DocTestFilters = []
++```
++
++# Doctest keyword arguments
++
++```jldoctest; setup = :(f(x) = x^2; g(x) = x)
++julia> f(2)
++4
++
++julia> g(2)
++2
++```
++```jldoctest
++julia> f(2)
++ERROR: UndefVarError: f not defined
++```
++
++```jldoctest PR650; setup = :(f(x) = x^2; g(x) = x)
++julia> f(2)
++4
++
++julia> g(2)
++2
++```
++```jldoctest PR650
++julia> f(2)
++4
++
++julia> g(2)
++2
++```
++
++```jldoctest; filter = [r"foo[a-z]+"]
++julia> print("foobar")
++foobuu
++```
++
++```jldoctest; filter = [r"foo[a-z]+", r"[0-9]+"]
++julia> print("foobar123")
++foobuu456
++```
++
++```jldoctest; filter = r"foo[a-z]+"
++julia> print("foobar")
++foobuu
++```
++
++```jldoctest; filter = r"foo[a-z]+", setup = :(f() = print("foobar"))
++julia> f()
++foobuu
++```
++
++```jldoctest; output = false
++foo(a, b) = a * b
++foo(2, 3)
++
++# output
++
++6
++```
++
++## World age issue for show
++```jldoctest
++julia> @enum Color red blue green
++
++julia> instances(Color)
++(red, blue, green)
++```
++
++
++# Sanitise module names
++
++```jldoctest
++julia> struct T end
++
++julia> t = T()
++T()
++
++julia> fullname(@__MODULE__)
++(:Main,)
++
++julia> fullname(Base.Broadcast)
++(:Base, :Broadcast)
++
++julia> @__MODULE__
++Main
++```
++
++# Issue398
++
++```@meta
++DocTestSetup = quote
++ module Issue398
++
++ struct TestType{T} end
++
++ function _show end
++ Base.show(io::IO, t::TestType) = _show(io, t)
++
++ macro define_show_and_make_object(x, y)
++ z = Expr(:quote, x)
++ esc(quote
++ $(Issue398)._show(io::IO, t::$(Issue398).TestType{$z}) = print(io, $y)
++ const $x = $(Issue398).TestType{$z}()
++ end)
++ end
++
++ export @define_show_and_make_object
++
++ end # module
++
++ using .Issue398
++end
++```
++
++```jldoctest
++julia> @define_show_and_make_object q "abcd"
++abcd
++```
++
++```@meta
++DocTestSetup = nothing
++```
++
++# Issue653
++
++```jldoctest
++julia> struct MyException <: Exception
++ msg::AbstractString
++ end
++
++julia> function Base.showerror(io::IO, err::MyException)
++ print(io, "MyException: ")
++ print(io, err.msg)
++ end
++
++julia> err = MyException("test exception")
++MyException("test exception")
++
++julia> sprint(showerror, err)
++"MyException: test exception"
++
++julia> throw(MyException("test exception"))
++ERROR: MyException: test exception
++```
++
++# Issue418
++
++```jldoctest
++julia> f(x::Float64) = x
++f (generic function with 1 method)
++
++julia> f("")
++ERROR: MethodError: no method matching f(::String)
++Closest candidates are:
++ f(!Matched::Float64) at none:1
++```
++
++
++```jldoctest
++julia> a = 1
++1
++
++julia> b = 2
++2
++
++julia> ex = :(a + b)
++:(a + b)
++
++julia> eval(ex)
++3
++```
++
++```@repl
++ex = :(1 + 5)
++eval(ex)
++```
++
++```@example
++ex = :(1 + 5)
++eval(ex)
++```
++
++```@example
++a = 1
++:(a + 1)
++```
++
++# Issue #793
++```jldoctest
++julia> write("issue793.jl", "\"Hello!\"");
++
++julia> include("issue793.jl")
++"Hello!"
++
++julia> rm("issue793.jl");
++```
++```@repl
++write("issue793.jl", "\"Hello!\"")
++include("issue793.jl")
++rm("issue793.jl")
++```
++```@example
++write("issue793.jl", "\"Hello!\"")
++r = include("issue793.jl")
++rm("issue793.jl")
++r
++```
++
++
++```jldoctest
++julia> a = 1
++1
++
++julia> ans
++1
++```
++
++```jldoctest issue959
++julia> "hello"; "world"
++"world"
++
++julia> ans
++"world"
++```
++
++# Issue513
++
++```jldoctest named
++julia> a = 1
++1
++
++julia> ans
++1
++```
++
++# Filtering of `Main.`
++
++```jldoctest
++julia> struct Point end;
++
++julia> println(Point)
++Point
++
++julia> sqrt(100)
++10.0
++
++julia> sqrt = 4
++ERROR: cannot assign variable Base.sqrt from module Main
++```
++
++```jldoctest
++julia> g(x::Float64, y) = 2x + y
++g (generic function with 1 method)
++
++julia> g(x, y::Float64) = x + 2y
++g (generic function with 2 methods)
++
++julia> g(2.0, 3)
++7.0
++
++julia> g(2, 3.0)
++8.0
++
++julia> g(2.0, 3.0)
++ERROR: MethodError: g(::Float64, ::Float64) is ambiguous. Candidates:
++ g(x, y::Float64) in Main at none:1
++ g(x::Float64, y) in Main at none:1
++Possible fix, define
++ g(::Float64, ::Float64)
++```
++
++# Anonymous function declaration
++
++```jldoc
++julia> x->x # ignore error on 0.7
++#1 (generic function with 1 method)
++```
++
++# Assigning symbols example
++
++```@example
++r = :a
++```
++
++# Bad links (Windows)
++
++* [Colons not allowed on Windows -- `some:path`](some:path)
++* [No "drive" -- `:path`](:path)
++* [Absolute Windows paths -- `X:\some\path`](X:\some\path)
++
++# Rendering text/markdown
++
++```@example
++struct MarkdownOnly
++ value::String
++end
++Base.show(io::IO, ::MIME"text/markdown", mo::MarkdownOnly) = print(io, mo.value)
++
++MarkdownOnly("""
++**bold** output from MarkdownOnly
++""")
++```
--- /dev/null
--- /dev/null
++# `@autodocs` tests
++
++```@meta
++CurrentModule = Main
++```
++
++## Public
++
++Should include docs for
++
++ * [`AutoDocs.Pages.E.f_1`](@ref)
++ * [`AutoDocs.Pages.E.f_2`](@ref)
++ * [`AutoDocs.Pages.E.f_3`](@ref)
++
++in that order.
++
++```@autodocs
++Modules = [AutoDocs.Pages.E]
++Private = false
++Order = [:function]
++```
++
++## Private
++
++Should include docs for
++
++ * [`AutoDocs.Pages.E.g_1`](@ref)
++ * [`AutoDocs.Pages.E.g_2`](@ref)
++ * [`AutoDocs.Pages.E.g_3`](@ref)
++
++in that order.
++
++```@autodocs
++Modules = [AutoDocs.Pages.E]
++Public = false
++Order = [:function]
++```
++
++## Ordering of Public and Private
++
++Should include docs for
++
++ * [`AutoDocs.Pages.E.T_1`](@ref)
++ * [`AutoDocs.Pages.E.T_2`](@ref)
++
++in that order.
++
++```@autodocs
++Modules = [AutoDocs.Pages.E]
++Order = [:type]
++```
++
++## Filtering
++
++Should include docs for
++
++ * [`AutoDocs.Filter.Major`](@ref)
++ * [`AutoDocs.Filter.Minor1`](@ref)
++ * [`AutoDocs.Filter.Minor2`](@ref)
++
++in that order.
++
++```@autodocs
++Modules = [AutoDocs.Filter]
++Order = [:type]
++Filter = t -> t <: AutoDocs.Filter.Major
++```
--- /dev/null
--- /dev/null
++!!! warning\r
++\r
++ This file contains windows line endings. Do not edit.\r
++\r
++```jldoctest\r
++a = 1\r
++b = 2\r
++a + b\r
++\r
++# output\r
++\r
++3\r
++```\r
--- /dev/null
--- /dev/null
++
++```@meta
++CurrentModule = Main.Mod
++```
++
++# Function Index
++
++```@index
++Pages = ["lib/functions.md"]
++```
++
++# Functions
++
++[`ccall`](@ref), [`func(x)`](@ref), [`T`](@ref), [`for`](@ref), and [`while`](@ref).
++
++```@docs
++func(x)
++T
++ccall
++for
++while
++@time
++@assert
++```
++
++# Foo
++
++```@example
++@show pwd()
++a = 1
++```
++
++...
++
++```@example
++@isdefined a
++```
++
++```@example 1
++f(x) = 2x
++g(x) = 3x
++nothing # hide
++```
++
++```@example 2
++x, y = 1, 2
++println(x, y)
++```
++
++```@example 3
++struct T end
++t = T()
++```
++
++```@example hide-all-the-things
++a = 1#hide
++b = 2# hide
++c = 3# hide
++d = 4 #hide
++e = 5 # hide
++f = 6 # hide
++a + b + c + d + e + f
++```
++
++## Foo
++
++```@example 3
++@isdefined T
++@show @isdefined t # hide
++@show typeof(T)
++typeof(t) # hide
++```
++
++```@example 2
++x + y
++```
++
++```@example 1
++f(2), g(2)
++```
++
++### Foo
++
++```@example 2
++x - y
++```
++
++```@example 1
++f(1), g(1)
++```
++
++```@example 3
++using InteractiveUtils
++@which T()
++```
++
++```@example continued-code
++A = 1
++```
++```@example continued-code; continued = true
++for i in 1:3
++```
++```@example
++A = 2
++```
++```@example continued-code; continued = true
++ println(A + i)
++```
++```@example continued-code
++end
++```
++```@example continued-code
++A + 1
++```
++
++#### Foo
++
++```@example
++a = 1
++b = ans
++@assert a === b
++```
++
++```@repl
++using Random # hide
++Random.seed!(1) # hide
++nothing
++rand()
++a = 1
++println(a)
++b = 2
++a + b
++struct T
++ x :: Int
++ y :: Vector
++end
++x = T(1, [1])
++x.y
++x.x
++```
++
++```@repl 1
++d = 1
++```
++
++```@repl 1
++println(d)
++```
++
++Test setup function
++
++```@setup testsetup
++w = 5
++```
++
++```@example testsetup
++@assert w === 5
++```
++
++```@repl testsetup
++@assert w === 5
++```
++
++# Autodocs
++
++```@meta
++CurrentModule = Main
++```
++
++## AutoDocs Module
++
++```@autodocs
++Modules = [AutoDocs]
++```
++
++## Functions, Modules, and Macros
++
++```@autodocs
++Modules = [AutoDocs.A, AutoDocs.B]
++Order = [:function, :module, :macro]
++```
++
++## Constants and Types
++
++```@autodocs
++Modules = [AutoDocs.A, AutoDocs.B]
++Order = [:constant, :type]
++```
++
++## Autodocs by Page
++
++```@autodocs
++Modules = [AutoDocs.Pages]
++Pages = ["a.jl", "b.jl"]
++```
++
++```@autodocs
++Modules = [AutoDocs.Pages]
++Pages = ["c.jl", "d.jl"]
++```
++
++A footnote reference [^footnote].
++
++# Named docstring `@ref`s
++
++ * a normal docstring `@ref` link: [`AutoDocs.Pages.f`](@ref);
++ * a named docstring `@ref` link: [`f`](@ref AutoDocs.Pages.f);
++ * and a link with custom text: [`@time 1 + 2`](@ref @time);
++ * some invalid syntax: [`for i = 1:10; ...`](@ref for).
--- /dev/null
--- /dev/null
++csv,data,file
++1,2,3
--- /dev/null
--- /dev/null
++# Tutorial
++
++[Documentation](@ref)
++
++[Index](@ref)
++
++[Functions](@ref)
++
++[`Main.Mod.func(x)`](@ref)
++
++[`Main.Mod.T`](@ref)
++
++```jldoctest
++julia> using Base.Meta # `nothing` shouldn't be displayed.
++
++julia> Meta
++Base.Meta
++
++julia> a = 1
++1
++
++julia> b = 2;
++
++julia> a + b
++3
++```
++
++```jldoctest
++a = 1
++b = 2
++a + b
++
++# output
++
++3
++```
++
++```@meta
++DocTestSetup =
++ quote
++ using Documenter
++ using Random
++ Random.seed!(1)
++ end
++```
++
++```jldoctest
++a = 1
++b = 2
++a / b
++
++# output
++
++0.5
++```
++
++```jldoctest
++julia> a = 1;
++
++julia> b = 2
++2
++
++julia> a / b
++0.5
++```
++
++```@eval
++import Markdown
++code = string(sprint(Base.banner), "julia>")
++Markdown.Code(code)
++```
++
++```jldoctest
++julia> # First definition.
++ function f(x, y)
++ x + y
++ end
++ #
++ # Second definition.
++ #
++ struct T
++ x
++ end
++
++julia> @isdefined(f), @isdefined(T) # Check for both definitions.
++(true, true)
++
++julia> import Base
++
++julia> using Base.Meta
++
++julia> r = isexpr(:(using Base.Meta), :using); # Discarded result.
++
++julia> !r
++false
++```
++
++```jldoctest
++julia> for i = 1:5
++ println(i)
++ end
++1
++2
++3
++4
++5
++
++julia> println("Printing with semi-comma ending.");
++Printing with semi-comma ending.
++
++julia> div(1, 0)
++ERROR: DivideError: integer division error
++[...]
++
++julia> println("a"); # Semi-colons *not* on the last expression shouldn't suppress output.
++ println(1) # ...
++ 2 # ...
++a
++1
++2
++
++julia> println("a"); # Semi-colons *not* on the last expression shouldn't suppress output.
++ println(1) # ...
++ 2; # Only those in the last expression.
++a
++1
++```
++
++```jldoctest
++a = 1
++b = 2; # Semi-colons don't affect script doctests.
++
++# output
++
++2
++```
++
++```@repl 1
++f(x) = (sleep(x); x)
++@time f(0.1);
++```
++
++```@repl 1
++f(0.01)
++div(1, 0)
++```
++
++Make sure that stdout is in the right place (#484):
++
++```@repl 1
++println("---") === nothing
++versioninfo()
++```
++
++```@eval
++1 + 2
++nothing
++```
++
++## Including images with `MIME`
++
++If `show(io, ::MIME, x)` is overloaded for a particular type then `@example` blocks can show the SVG, HTML/JS/CSS, PNG, JPEG, GIF or WebP image as appropriate in the output.
++
++Assuming the following type and method live in the `InlineSVG` module
++
++```julia
++struct SVG
++ code :: String
++end
++Base.show(io, ::MIME"image/svg+xml", svg::SVG) = write(io, svg.code)
++```
++
++.. then we we can invoke and show them with an `@example` block:
++
++```@setup inlinesvg
++module InlineSVG
++export SVG
++mutable struct SVG
++ code :: String
++end
++Base.show(io, ::MIME"image/svg+xml", svg::SVG) = write(io, svg.code)
++end # module
++```
++
++```@example inlinesvg
++using .InlineSVG
++SVG("""
++<svg width="82" height="76">
++ <g style="stroke-width: 3">
++ <circle cx="20" cy="56" r="16" style="stroke: #cb3c33; fill: #d5635c" />
++ <circle cx="41" cy="20" r="16" style="stroke: #389826; fill: #60ad51" />
++ <circle cx="62" cy="56" r="16" style="stroke: #9558b2; fill: #aa79c1" />
++ </g>
++</svg>
++""")
++```
++
++_Note: we can't define the `show` method in the `@example` block due to the world age
++counter in Julia 0.6 (Documenter's `makedocs` is not aware of any of the new method
++definitions happening in `eval`s)._
++
++We can also show SVG images with interactivity via the `text/html` MIME to display output that combines HTML, JS and CSS. Assume the following type and method live in the `InlineHTML` modeul
++
++```julia
++struct HTML
++ code::String
++end
++Base.show(io, ::MIME"text/html", html::HTML) = write(io, read(html.code))
++```
++
++.. then we can invoke and show them with an `@example` block (try mousing over the circles to see the applied style):
++
++```@setup inlinehtml
++module InlineHTML
++mutable struct HTML
++ code::String
++end
++Base.show(io, ::MIME"text/html", html::HTML) = write(io, html.code)
++end # module
++```
++
++```@example inlinehtml
++using .InlineHTML
++InlineHTML.HTML("""
++<script>
++ function showStyle(e) {
++ document.querySelector("#inline-html-style").innerHTML = e.getAttribute('style');
++ }
++</script>
++<svg width="100%" height="76">
++ <g style="stroke-width: 3">
++ <circle cx="20" cy="56" r="16" style="stroke: #cb3c33; fill: #d5635c" onmouseover="showStyle(this)"/>
++ <circle cx="41" cy="20" r="16" style="stroke: #389826; fill: #60ad51" onmouseover="showStyle(this)"/>
++ <circle cx="62" cy="56" r="16" style="stroke: #9558b2; fill: #aa79c1" onmouseover="showStyle(this)"/>
++ <text id="inline-html-style" x="90", y="20"></text>
++ </g>
++</svg>
++""")
++```
++
++The same mechanism also works for PNG files. Assuming again the following
++type and method live in the `InlinePNG` module
++
++```julia
++struct PNG
++ filename::String
++end
++Base.show(io, ::MIME"image/png", png::PNG) = write(io, read(png.filename))
++```
++
++.. then we can invoke and show them with an `@example` block:
++
++```@setup inlinepng
++module InlinePNG
++export PNG
++mutable struct PNG
++ filename::String
++end
++Base.show(io, ::MIME"image/png", png::PNG) = write(io, read(png.filename))
++end # module
++```
++
++```@example inlinepng
++using Documenter
++using .InlinePNG
++PNG(joinpath(dirname(pathof(Documenter)), "..", "test", "examples", "images", "logo.png"))
++```
++
++
++.. and JPEG, GIF and WebP files:
++
++```@setup inlinewebpgifjpeg
++module InlineWEBPGIFJPEG
++export WEBP, GIF, JPEG
++mutable struct WEBP
++ filename :: String
++end
++Base.show(io, ::MIME"image/webp", image::WEBP) = write(io, read(image.filename))
++mutable struct GIF
++ filename :: String
++end
++Base.show(io, ::MIME"image/gif", image::GIF) = write(io, read(image.filename))
++mutable struct JPEG
++ filename :: String
++end
++Base.show(io, ::MIME"image/jpeg", image::JPEG) = write(io, read(image.filename))
++end # module
++```
++
++```@example inlinewebpgifjpeg
++using Documenter
++using .InlineWEBPGIFJPEG
++WEBP(joinpath(dirname(pathof(Documenter)), "..", "test", "examples", "images", "logo.webp"))
++```
++
++```@example inlinewebpgifjpeg
++GIF(joinpath(dirname(pathof(Documenter)), "..", "test", "examples", "images", "logo.gif"))
++```
++
++```@example inlinewebpgifjpeg
++JPEG(joinpath(dirname(pathof(Documenter)), "..", "test", "examples", "images", "logo.jpg"))
++```
++
++## Interacting with external files
++
++You can also write output files and then refer to them in the document:
++
++```@example
++open("julia.svg", "w") do io
++ write(io, """
++ <svg width="82" height="76" xmlns="http://www.w3.org/2000/svg">
++ <g style="stroke-width: 3">
++ <circle cx="20" cy="56" r="16" style="stroke: #cb3c33; fill: #d5635c" />
++ <circle cx="41" cy="20" r="16" style="stroke: #389826; fill: #60ad51" />
++ <circle cx="62" cy="56" r="16" style="stroke: #9558b2; fill: #aa79c1" />
++ </g>
++ </svg>
++ """)
++end
++```
++
++
++
++Dowload [`data.csv`](data.csv).
++
++
++## [Links](../index.md) in headers
++
++... are dropped in the navigation links.
++
++
++## Embedding raw HTML
++
++Below is a nicely rendered version of `^D`:
++
++```@raw html
++<kbd>Ctrl</kbd> + <kbd>D</kbd>
++```
++
++## Tables
++
++| object | implemented | value |
++|--------|-------------|------------|
++| `A` | ✓ | 10.00 |
++| `BB` | ✓ | 1000000.00 |
++
++With explicit alignment.
++
++| object | implemented | value |
++| :--- | :---: | ---: |
++| `A` | ✓ | 10.00 |
++| `BB` | ✓ | 1000000.00 |
--- /dev/null
--- /dev/null
++# Omitted
++
++This file is omitted from the navigation menu (`pages`), but will still get built.
--- /dev/null
--- /dev/null
++# Unicode
++
++Some unicode tests here.
++
++In main sans-serif font:
++
++* Checkmark: "✓"
++* Cicled plus: "⊕"
++* XOR: "⊻"
++* Exists: "∀", forall: "∃"
++
++`\begin{lstlisting}` is used for non-highlighted blocks:
++
++```
++xor: ⊻
++forall: ∀
++exists: ∃
++check: ✓
++oplus: ⊕
++
++What about the other edge cases: \ % \% %\ %% %\%%
++```
++
++`\begin{minted}` is used for highlighted blocks:
++
++```julia
++xor: ⊻
++forall: ∀
++exists: ∃
++check: ✓
++oplus: ⊕
++```
++
++Inlines:
++
++`xor: ⊻ -> %\unicodeveebar% <-`
++
++`forall: ∀, exists: ∃, check: ✓`
++
++`%\%%\unicodeveebar, oplus: ⊕`
++
++## Drawings etc
++
++```
++┌────────────────────────────────────────────────────────────────────────────┐
++│ ┌───────────────┐ │
++│ HTTP.request(method, uri, headers, body) -> │ HTTP.Response ├──────────────┼┐
++│ │ └───────────────┘ ││
++│ │ ││
++│ │ ┌──────────────────────────────────────┐ ┌──────────────────┐ ││
++│ └───▶│ request(RedirectLayer, ...) │ │ HTTP.StatusError │ ││
++│ └─┬────────────────────────────────────┴─┐ └─────────▲────────┘ ││
++│ │ request(BasicAuthLayer, ...) │ │ ││
++│ └─┬────────────────────────────────────┴─┐ │ ││
++│ │ request(CookieLayer, ...) │ │ ││
++│ └─┬────────────────────────────────────┴─┐ │ ││
++│ │ request(CanonicalizeLayer, ...) │ │ ││
++│ └─┬────────────────────────────────────┴─┐ │ ││
++│ │ request(MessageLayer, ...) ├─────────┼──────┐ ││
++```
++
++```julia
++ ┌──────────────────────────────────────────────────────────────────────┐
++1 │ ▗▄▞▀▀▀▀▀▀▀▄▄ │
++ │ ▄▞▘ ▀▄▖ │
++ │ ▄▀ ▝▚▖ │
++ │ ▗▞ ▝▄ │
++ │ ▞▘ ▝▚▖ │
++ │ ▗▀ ▝▚ │
++ │ ▞▘ ▀▖ │
++ │ ▗▞ ▝▄ │
++ │ ▄▘ ▚▖ │
++ │ ▗▞ ▝▄ │
++ │ ▄▘ ▚▖ │
++ │ ▗▀ ▝▚ │
++ │ ▗▞▘ ▀▄ │
++ │ ▄▀▘ ▀▚▖ │
++0 │ ▄▄▄▄▀▀ ▝▀▚▄▄▄▖│
++ └──────────────────────────────────────────────────────────────────────┘
++ 0 70
++```
++
++```
++2×4 DataFrames.DataFrame
++│ Row │ a │ b │ c │ d │
++│ │ Int64 │ Float64 │ Int64 │ String │
++├─────┼───────┼─────────┼───────┼────────┤
++│ 1 │ 2 │ 2.0 │ 2 │ John │
++│ 2 │ 2 │ 2.0 │ 2 │ Sally │
++```
++
++```julia
++function map_filter_iterators(xs, init)
++ ret = iterate(xs)
++ ret === nothing && return
++ acc = init
++ @goto filter
++ local state, x
++ while true
++ while true # input
++ ret = iterate(xs, state) #
++ ret === nothing && return acc #
++ @label filter #
++ x, state = ret #
++ iseven(x) && break # filter :
++ end # :
++ y = 2x # imap : :
++ acc += y # + : : :
++ end # : : : :
++ # + <-- imap <-------- filter <-- input
++ return acc
++end
++```
--- /dev/null
--- /dev/null
++using Test
++
++# When the file is run separately we need to include make.jl which actually builds
++# the docs and defines a few modules that are referred to in the docs. The make.jl
++# has to be expected in the context of the Main module.
++if (@__MODULE__) === Main && !@isdefined examples_root
++ include("make.jl")
++elseif (@__MODULE__) !== Main && isdefined(Main, :examples_root)
++ using Documenter
++ const examples_root = Main.examples_root
++elseif (@__MODULE__) !== Main && !isdefined(Main, :examples_root)
++ error("examples/make.jl has not been loaded into Main.")
++end
++
++@testset "Examples" begin
++ @testset "Markdown" begin
++ doc = Main.examples_markdown_doc
++
++ @test isa(doc, Documenter.Documents.Document)
++
++ let build_dir = joinpath(examples_root, "builds", "markdown"),
++ source_dir = joinpath(examples_root, "src")
++
++ @test isdir(build_dir)
++ @test isdir(joinpath(build_dir, "assets"))
++ @test isdir(joinpath(build_dir, "lib"))
++ @test isdir(joinpath(build_dir, "man"))
++
++ @test isfile(joinpath(build_dir, "index.md"))
++ @test isfile(joinpath(build_dir, "assets", "mathjaxhelper.js"))
++ @test isfile(joinpath(build_dir, "assets", "Documenter.css"))
++ @test isfile(joinpath(build_dir, "assets", "custom.css"))
++ @test isfile(joinpath(build_dir, "assets", "custom.js"))
++ @test isfile(joinpath(build_dir, "lib", "functions.md"))
++ @test isfile(joinpath(build_dir, "man", "tutorial.md"))
++ @test isfile(joinpath(build_dir, "man", "data.csv"))
++ @test isfile(joinpath(build_dir, "man", "julia.svg"))
++
++ @test (==)(
++ read(joinpath(source_dir, "man", "data.csv"), String),
++ read(joinpath(build_dir, "man", "data.csv"), String),
++ )
++ end
++
++ @test doc.user.root == examples_root
++ @test doc.user.source == "src"
++ @test doc.user.build == "builds/markdown"
++ @test doc.user.clean == true
++ @test doc.user.format == [Documenter.Writers.MarkdownWriter.Markdown()]
++
++ @test realpath(doc.internal.assets) == realpath(joinpath(dirname(@__FILE__), "..", "..", "assets"))
++
++ @test length(doc.blueprint.pages) == 15
++
++ let headers = doc.internal.headers
++ @test Documenter.Anchors.exists(headers, "Documentation")
++ @test Documenter.Anchors.exists(headers, "Documentation")
++ @test Documenter.Anchors.exists(headers, "Index-Page")
++ @test Documenter.Anchors.exists(headers, "Functions-Contents")
++ @test Documenter.Anchors.exists(headers, "Tutorial-Contents")
++ @test Documenter.Anchors.exists(headers, "Index")
++ @test Documenter.Anchors.exists(headers, "Tutorial")
++ @test Documenter.Anchors.exists(headers, "Function-Index")
++ @test Documenter.Anchors.exists(headers, "Functions")
++ @test Documenter.Anchors.isunique(headers, "Functions")
++ @test Documenter.Anchors.isunique(headers, "Functions", joinpath("builds", "markdown", "lib", "functions.md"))
++ let name = "Foo", path = joinpath("builds", "markdown", "lib", "functions.md")
++ @test Documenter.Anchors.exists(headers, name, path)
++ @test !Documenter.Anchors.isunique(headers, name)
++ @test !Documenter.Anchors.isunique(headers, name, path)
++ @test length(headers.map[name][path]) == 4
++ end
++ end
++
++ @test length(doc.internal.objects) == 41
++ end
++
++ @testset "HTML: local" begin
++ doc = Main.examples_html_local_doc
++
++ @test isa(doc, Documenter.Documents.Document)
++
++ # TODO: test the HTML build
++
++ let build_dir = joinpath(examples_root, "builds", "html-local")
++
++ index_html = read(joinpath(build_dir, "index.html"), String)
++ @test occursin("<strong>bold</strong> output from MarkdownOnly", index_html)
++
++ @test isfile(joinpath(build_dir, "index.html"))
++ @test isfile(joinpath(build_dir, "omitted.html"))
++ @test isfile(joinpath(build_dir, "hidden.html"))
++ @test isfile(joinpath(build_dir, "lib", "autodocs.html"))
++ end
++ end
++
++ @testset "HTML: deploy" begin
++ doc = Main.examples_html_deploy_doc
++
++ @test isa(doc, Documenter.Documents.Document)
++
++ # TODO: test the HTML build with pretty URLs
++
++ let build_dir = joinpath(examples_root, "builds", "html-deploy")
++ @test joinpath(build_dir, "index.html") |> isfile
++ @test joinpath(build_dir, "omitted", "index.html") |> isfile
++ @test joinpath(build_dir, "hidden", "index.html") |> isfile
++ @test joinpath(build_dir, "lib", "autodocs", "index.html") |> isfile
++ end
++ end
++end
--- /dev/null
--- /dev/null
++# build pdf version of Documenter's docs on 64-bit Linux
++if Sys.ARCH === :x86_64 && Sys.KERNEL === :Linux
++ cd(joinpath(@__DIR__, "..", "..")) do
++ cmd = `$(Base.julia_cmd()) --project=docs/pdf/`
++ @test success(`$(cmd) -e 'using Pkg; Pkg.instantiate()'`)
++ @test success(`$(cmd) docs/pdf/make.jl --verbose`)
++ # deploy only from Julia v1.0.X
++ if VERSION.major == 1 && VERSION.minor == 1
++ @test success(`$(cmd) docs/pdf/deploy.jl`)
++ end
++ end
++end
--- /dev/null
--- /dev/null
++module MarkdownFormatTests
++
++using Test
++using Random
++
++using Documenter
++
++# Documenter package docs
++@info("Building Documenter's docs with Markdown.")
++const Documenter_root = normpath(joinpath(@__DIR__, "..", "..", "docs"))
++build_dir_relpath = relpath(joinpath(@__DIR__, "builds/markdown"), Documenter_root)
++doc = makedocs(
++ format = :markdown,
++ debug = true,
++ root = Documenter_root,
++ modules = Documenter,
++ build = build_dir_relpath,
++)
++
++@testset "Markdown" begin
++ @test isa(doc, Documenter.Documents.Document)
++
++ let build_dir = joinpath(Documenter_root, build_dir_relpath),
++ source_dir = joinpath(Documenter_root, "src")
++ @test isdir(build_dir)
++ @test isdir(joinpath(build_dir, "assets"))
++ @test isdir(joinpath(build_dir, "lib"))
++ @test isdir(joinpath(build_dir, "man"))
++
++ @test isfile(joinpath(build_dir, "index.md"))
++ @test isfile(joinpath(build_dir, "assets", "mathjaxhelper.js"))
++ @test isfile(joinpath(build_dir, "assets", "Documenter.css"))
++ end
++
++ @test doc.user.root == Documenter_root
++ @test doc.user.source == "src"
++ @test doc.user.build == build_dir_relpath
++ @test doc.user.clean == true
++end
++
++end
--- /dev/null
--- /dev/null
++module HTMLWriterTests
++
++using Test
++
++import JSON
++import Documenter.Writers.HTMLWriter: generate_version_file, expand_versions
++
++function verify_version_file(versionfile, entries)
++ @test isfile(versionfile)
++ content = read(versionfile, String)
++ idx = 1
++ for entry in entries
++ i = findnext(entry, content, idx)
++ @test i !== nothing
++ idx = last(i)
++ end
++end
++
++@testset "HTMLWriter" begin
++ mktempdir() do tmpdir
++ versionfile = joinpath(tmpdir, "versions.js")
++ versions = ["stable", "dev",
++ "2.1.1", "v2.1.0", "v2.0.1", "v2.0.0",
++ "1.1.1", "v1.1.0", "v1.0.1", "v1.0.0",
++ "0.1.1", "v0.1.0"] # note no `v` on first ones
++ cd(tmpdir) do
++ for version in versions
++ mkdir(version)
++ end
++ end
++
++ # expanding versions
++ versions = ["stable" => "v^", "v#.#", "dev" => "dev"] # default to makedocs
++ entries, symlinks = expand_versions(tmpdir, versions)
++ @test entries == ["stable", "v2.1", "v2.0", "v1.1", "v1.0", "v0.1", "dev"]
++ @test symlinks == ["stable"=>"2.1.1", "v2.1"=>"2.1.1", "v2.0"=>"v2.0.1",
++ "v1.1"=>"1.1.1", "v1.0"=>"v1.0.1", "v0.1"=>"0.1.1",
++ "v2"=>"2.1.1", "v1"=>"1.1.1", "v2.1.1"=>"2.1.1",
++ "v1.1.1"=>"1.1.1", "v0.1.1"=>"0.1.1"]
++ generate_version_file(versionfile, entries)
++ verify_version_file(versionfile, entries)
++
++ versions = ["v#"]
++ entries, symlinks = expand_versions(tmpdir, versions)
++ @test entries == ["v2.1", "v1.1"]
++ @test symlinks == ["v2.1"=>"2.1.1", "v1.1"=>"1.1.1", "v2"=>"2.1.1", "v1"=>"1.1.1",
++ "v2.0"=>"v2.0.1", "v1.0"=>"v1.0.1", "v0.1"=>"0.1.1",
++ "v2.1.1"=>"2.1.1", "v1.1.1"=>"1.1.1", "v0.1.1"=>"0.1.1"]
++ generate_version_file(versionfile, entries)
++ verify_version_file(versionfile, entries)
++
++ versions = ["v#.#.#"]
++ entries, symlinks = expand_versions(tmpdir, versions)
++ @test entries == ["v2.1.1", "v2.1.0", "v2.0.1", "v2.0.0", "v1.1.1", "v1.1.0",
++ "v1.0.1", "v1.0.0", "v0.1.1", "v0.1.0"]
++ @test symlinks == ["v2.1.1"=>"2.1.1", "v1.1.1"=>"1.1.1", "v0.1.1"=>"0.1.1",
++ "v2"=>"2.1.1", "v1"=>"1.1.1", "v2.1"=>"2.1.1",
++ "v2.0"=>"v2.0.1", "v1.1"=>"1.1.1", "v1.0"=>"v1.0.1", "v0.1"=>"0.1.1"]
++ generate_version_file(versionfile, entries)
++ verify_version_file(versionfile, entries)
++
++ versions = ["v^", "devel" => "dev", "foobar", "foo" => "bar"]
++ entries, symlinks = expand_versions(tmpdir, versions)
++ @test entries == ["v2.1", "devel"]
++ @test ("v2.1" => "2.1.1") in symlinks
++ @test ("devel" => "dev") in symlinks
++ generate_version_file(versionfile, entries)
++ verify_version_file(versionfile, entries)
++
++ versions = ["stable" => "v^", "dev" => "stable"]
++ @test_throws ArgumentError expand_versions(tmpdir, versions)
++ end
++end
++
++end
--- /dev/null
--- /dev/null
++using Documenter
++using Test
++
++@testset "Manual doctest" begin
++ @info "Doctesting Documenter manual"
++ doctest(Documenter)
++
++ # Make sure that doctest() fails if there is a manual page with a failing doctest
++ # Will need to run it in a Task though, so that we could easily capture the error.
++ @info "Doctesting Documenter manual w/ failing doctest"
++ tmpfile = joinpath(@__DIR__, "..", "docs", "src", "lib", "internals", "tmpfile.md")
++ write(tmpfile, """
++ # Temporary source file w/ failing doctest
++ ```jldoctest
++ julia> 2 + 2
++ 42
++ ```
++ """)
++ @test isfile(tmpfile)
++ @test_throws TestSetException fetch(schedule(Task(() -> doctest(Documenter))))
++ println("^^^ Expected error output.")
++ rm(tmpfile)
++ @test !isfile(tmpfile)
++end
--- /dev/null
--- /dev/null
++module Markdown2Tests
++using Test
++import Markdown
++import Documenter.Utilities: Markdown2
++
++@testset "Markdown2" begin
++ let md = Markdown.parse(""),
++ md2 = convert(Markdown2.MD, md)
++ @test isa(md2, Markdown2.MD)
++ @test length(md2) === 0
++ end
++
++ let md = Markdown.parse("""
++ # Text Paragraphs
++
++ Foo *bar **baz** qux*!
++
++ Foo Bar \\
++ Baz
++ """),
++ md2 = convert(Markdown2.MD, md)
++
++ @test isa(md2, Markdown2.MD)
++ @test length(md2) === 3
++
++ let h = md2.nodes[1]
++ @test isa(h, Markdown2.Heading)
++ @test length(h.nodes) === 1
++ @test isa(h.nodes[1], Markdown2.Text)
++ @test h.nodes[1].text == "Text Paragraphs"
++ end
++
++ let p = md2.nodes[2]
++ @test isa(p, Markdown2.Paragraph)
++ @test length(p.nodes) === 3
++
++ @test isa(p.nodes[1], Markdown2.Text)
++ @test p.nodes[1].text == "Foo "
++ @test isa(p.nodes[2], Markdown2.Emphasis)
++ @test isa(p.nodes[3], Markdown2.Text)
++ @test p.nodes[3].text == "!"
++
++ @test length(p.nodes[2].nodes) === 3
++ @test isa(p.nodes[2].nodes[1], Markdown2.Text)
++ @test p.nodes[2].nodes[1].text == "bar "
++ @test isa(p.nodes[2].nodes[2], Markdown2.Strong)
++ @test length(p.nodes[2].nodes[2].nodes) === 1
++ @test isa(p.nodes[2].nodes[2].nodes[1], Markdown2.Text)
++ @test p.nodes[2].nodes[2].nodes[1].text == "baz"
++ @test isa(p.nodes[2].nodes[3], Markdown2.Text)
++ @test p.nodes[2].nodes[3].text == " qux"
++ end
++
++ @test isa(md2.nodes[3], Markdown2.Paragraph)
++ end
++
++ let md = Markdown.parse("""
++ # Images
++
++ 
++ 
++ """),
++ md2 = convert(Markdown2.MD, md)
++
++ @test isa(md2, Markdown2.MD)
++ @test length(md2) === 2
++
++ @test isa(md2.nodes[1], Markdown2.Heading)
++ @test md2.nodes[1].level === 1
++
++ @test isa(md2.nodes[2], Markdown2.Paragraph)
++ images = md2.nodes[2].nodes
++ @test length(md2.nodes[2].nodes) === 3 # there are Text() nodes between Image() nodes
++
++ @test isa(images[1], Markdown2.Image)
++ @test images[1].destination == "https://example.com/image.png"
++ @test images[1].description == "Alt Text"
++
++ @test isa(images[3], Markdown2.Image)
++ @test images[3].destination == "https://example.com/image-noalt.png"
++ @test images[3].description == ""
++ end
++
++ let md = Markdown.parse("""
++ Blocks
++ ------
++
++ ```language
++ Hello
++ > World!
++ ```
++
++ ---
++
++ > Block
++ > ``z+1``
++ > Quote!
++ >
++ > ```math
++ > x^2 + y^2 = z^2
++ > ```
++
++ --- ---
++ """),
++ md2 = convert(Markdown2.MD, md)
++
++ @test isa(md2, Markdown2.MD)
++ @test length(md2) === 5
++
++ @test isa(md2.nodes[1], Markdown2.Heading)
++ @test md2.nodes[1].level === 2
++
++ @test isa(md2.nodes[2], Markdown2.CodeBlock)
++ @test md2.nodes[2].language == "language"
++
++ @test isa(md2.nodes[3], Markdown2.ThematicBreak)
++ @test isa(md2.nodes[4], Markdown2.BlockQuote)
++ @test isa(md2.nodes[5], Markdown2.ThematicBreak)
++ end
++
++ let md = Markdown.parse("""
++ ### Lists
++
++ - a `code span`
++ - b
++ - c
++ """),
++ md2 = convert(Markdown2.MD, md)
++
++ @test isa(md2, Markdown2.MD)
++ @test length(md2) === 2
++
++ @test isa(md2.nodes[1], Markdown2.Heading)
++ @test md2.nodes[1].level === 3
++
++ let list = md2.nodes[2]
++ @test isa(list, Markdown2.List)
++ @test list.tight === true
++ @test list.orderedstart === nothing
++ @test length(list.items) === 3
++
++ @test length(list.items[1]) === 1
++ @test isa(list.items[1][1], Markdown2.Paragraph)
++ @test length(list.items[1][1].nodes) === 2
++ @test isa(list.items[1][1].nodes[1], Markdown2.Text)
++ @test isa(list.items[1][1].nodes[2], Markdown2.CodeSpan)
++ @test list.items[1][1].nodes[2].code == "code span"
++ end
++ end
++
++ let md = Markdown.parse("""
++ !!! warn "FOOBAR"
++ Hello World
++
++ ``math
++ x+1
++ ``
++ """),
++ md2 = convert(Markdown2.MD, md)
++
++ @test isa(md2, Markdown2.MD)
++ @test length(md2) === 1
++
++ @test isa(md2.nodes[1], Markdown2.Admonition)
++ end
++
++ let md = Markdown.parse("""
++ | Column One | Column Two | Column Three |
++ |:---------- | ---------- |:------------:|
++ | Row `1` | Column `2` | > asd |
++ | *Row* 2 | **Row** 2 | Column ``3`` |
++ """),
++ md2 = convert(Markdown2.MD, md)
++
++ @test isa(md2, Markdown2.MD)
++ @test length(md2) === 1
++
++ @test isa(md2.nodes[1], Markdown2.Table)
++ end
++end
++
++end # module
--- /dev/null
--- /dev/null
++module MDFlattenTests
++
++using Test
++
++import Markdown
++using Documenter.Utilities.MDFlatten
++
++@testset "MDFlatten" begin
++ @test mdflatten(Markdown.Paragraph("...")) == "..."
++ @test mdflatten(Markdown.Header{1}("...")) == "..."
++
++ # a simple test for blocks in top-level (each gets two newline appended to it)
++ @test mdflatten(Markdown.parse("# Test\nTest")) == "Test\n\nTest\n\n"
++ block_md = Markdown.parse("""
++ # MDFlatten test
++
++
++ ^^^ Ignoring extra whitespace.
++
++ ```markdown
++ code
++ is forwarded as **is**
++ ```
++ """)
++ block_text = """
++ MDFlatten test
++
++ ^^^ Ignoring extra whitespace.
++
++ code
++ is forwarded as **is**
++
++ """
++ @test mdflatten(block_md) == block_text
++
++ # blocks
++ @test mdflatten(Markdown.parse("> Test\n> Test\n\n> Test")) == "Test Test\n\nTest\n\n"
++ @test mdflatten(Markdown.parse("HRs\n\n---\n\nto whitespace")) == "HRs\n\n\n\nto whitespace\n\n"
++ @test mdflatten(Markdown.parse("HRs\n\n---\n\nto whitespace")) == "HRs\n\n\n\nto whitespace\n\n"
++ @test mdflatten(Markdown.parse("HRs\n\n---\n\nto whitespace")) == "HRs\n\n\n\nto whitespace\n\n"
++
++ # test some inline blocks
++ @test mdflatten(Markdown.parse("`code` *em* normal **strong**")) == "code em normal strong\n\n"
++ @test mdflatten(Markdown.parse("[link text *parsed*](link/itself/ignored)")) == "link text parsed\n\n"
++ @test mdflatten(Markdown.parse("- a\n- b\n- c")) == "a\nb\nc\n\n"
++ @test mdflatten(Markdown.parse("A | B\n---|---\naa|bb\ncc | dd")) == "A B\naa bb\ncc dd\n\n"
++
++ # Math
++ @test mdflatten(Markdown.parse("\$e=mc^2\$")) == "e=mc^2\n\n"
++ # backticks and blocks for math only in 0.5, i.e. these fail on 0.4
++ @test mdflatten(Markdown.parse("``e=mc^2``")) == "e=mc^2\n\n"
++ @test mdflatten(Markdown.parse("```math\n\\(m+n)(m-n)\nx=3\\sin(x)\n```")) == "(m+n)(m-n)\nx=3sin(x)\n\n"
++
++ # symbols in markdown
++ @test mdflatten(Markdown.parse("A \$B C")) == "A B C\n\n"
++
++ # linebreaks
++ @test mdflatten(Markdown.parse("A\\\nB")) == "A\nB\n\n"
++
++ # footnotes
++ @test mdflatten(Markdown.parse("[^name]")) == "[name]\n\n"
++ @test mdflatten(Markdown.parse("[^name]:**Strong** text.")) == "[name]: Strong text.\n\n"
++
++ # admonitions
++ @test mdflatten(Markdown.parse("!!! note \"Admonition Title\"\n Test")) == "note: Admonition Title\nTest\n\n"
++end
++
++end
--- /dev/null
--- /dev/null
++module MissingDocs
++ export f
++
++ "exported"
++ f(x) = x
++
++ "unexported"
++ g(x) = x
++end
++
++using Documenter
++
++for sym in [:none, :exports]
++ makedocs(
++ root = dirname(@__FILE__),
++ source = joinpath("src", string(sym)),
++ build = joinpath("build", string(sym)),
++ modules = MissingDocs,
++ checkdocs = sym,
++ sitename = "MissingDocs Checks",
++ )
++end
--- /dev/null
--- /dev/null
++# MissingDocs Exports
++
++```@docs
++Main.MissingDocs.f
++```
--- /dev/null
--- /dev/null
++# MissingDocs None
++
++```@docs
++```
--- /dev/null
--- /dev/null
++module NavNodeTests
++
++using Test
++
++import Documenter: Documents, Builder
++import Documenter.Documents: NavNode
++
++mutable struct FakeDocumentBlueprint
++ pages :: Dict{String, Nothing}
++ FakeDocumentBlueprint() = new(Dict())
++end
++mutable struct FakeDocumentInternal
++ navlist :: Vector{NavNode}
++ FakeDocumentInternal() = new([])
++end
++mutable struct FakeDocument
++ internal :: FakeDocumentInternal
++ blueprint :: FakeDocumentBlueprint
++ FakeDocument() = new(FakeDocumentInternal(), FakeDocumentBlueprint())
++end
++
++@testset "NavNode" begin
++ @test fieldtype(FakeDocumentInternal, :navlist) == fieldtype(Documents.Internal, :navlist)
++
++ pages = [
++ "page1.md",
++ "Page2" => "page2.md",
++ "Section" => [
++ "page3.md",
++ "Page4" => "page4.md",
++ "Subsection" => [
++ "page5.md",
++ ],
++ ],
++ "page6.md",
++ ]
++ doc = FakeDocument()
++ doc.blueprint.pages = Dict(map(i -> "page$i.md" => nothing, 1:8))
++ navtree = Builder.walk_navpages(pages, nothing, doc)
++ navlist = doc.internal.navlist
++
++ @test length(navlist) == 6
++ for (i,navnode) in enumerate(navlist)
++ @test navnode.page == "page$i.md"
++ end
++
++ @test isa(navtree, Vector{NavNode})
++ @test length(navtree) == 4
++ @test navtree[1] === navlist[1]
++ @test navtree[2] === navlist[2]
++ @test navtree[4] === navlist[6]
++
++ section = navtree[3]
++ @test section.title_override == "Section"
++ @test section.page === nothing
++ @test length(section.children) == 3
++
++ navpath = Documents.navpath(navlist[5])
++ @test length(navpath) == 3
++ @test navpath[1] === section
++ @test navpath[3] === navlist[5]
++end
++
++end
--- /dev/null
--- /dev/null
++using Documenter
++
++makedocs(
++ debug = true,
++ doctestfilters = [r"Ptr{0x[0-9]+}"],
++ sitename = "Documenter example",
++ pages = ["index.md"],
++)
--- /dev/null
--- /dev/null
++# Test
++
++....
--- /dev/null
--- /dev/null
++mktempdir() do tmpdir
++ @info("Building 'nongit' in $tmpdir")
++ cp(joinpath(@__DIR__, "docs"), joinpath(tmpdir, "docs"))
++ include(joinpath(tmpdir, "docs/make.jl"))
++ # Copy the build/ directory back so that it would be possible to inspect the output.
++ cp(joinpath(tmpdir, "docs/build"), joinpath(@__DIR__, "build"); force=true)
++end
--- /dev/null
--- /dev/null
++using Test
++
++# Build the example docs
++include("examples/make.jl")
++
++# Test missing docs
++include("missingdocs/make.jl")
++
++# Primary @testset
++
++# Error reporting.
++println("="^50)
++@info("The following errors are expected output.")
++include(joinpath("errors", "make.jl"))
++@info("END of expected error output.")
++println("="^50)
++
++@testset "Documenter" begin
++ # Unit tests for module internals.
++ include("utilities.jl")
++ include("markdown2.jl")
++
++ # DocChecks tests
++ include("docchecks.jl")
++
++ # NavNode tests.
++ include("navnode.jl")
++
++ # DocSystem unit tests.
++ include("docsystem.jl")
++
++ # DocTest unit tests.
++ include("doctests/docmeta.jl")
++ include("doctests/doctestapi.jl")
++ include("doctests/doctests.jl")
++ include("doctests/fix/tests.jl")
++
++ # DOM Tests.
++ include("dom.jl")
++
++ # MDFlatten tests.
++ include("mdflatten.jl")
++
++ # HTMLWriter
++ include("htmlwriter.jl")
++
++ # Mock package docs.
++ include("examples/tests.jl")
++
++ # Documenter package docs with other formats.
++ include("formats/markdown.jl")
++
++ # A simple build outside of a Git repository
++ include("nongit/tests.jl")
++
++ # A simple build evaluating code outside build directory
++ include("workdir/tests.jl")
++
++ # Passing a writer positionally (https://github.com/JuliaDocs/Documenter.jl/issues/1046)
++ @test_throws ArgumentError makedocs(sitename="", HTML())
++end
++
++# Additional tests
++
++## `Markdown.MD` to `DOM.Node` conversion tests.
++module MarkdownToNode
++ import Documenter.DocSystem
++ import Documenter.Writers.HTMLWriter: mdconvert
++
++ # Exhaustive Conversion from Markdown to Nodes.
++ for mod in Base.Docs.modules
++ for (binding, multidoc) in DocSystem.getmeta(mod)
++ for (typesig, docstr) in multidoc.docs
++ md = DocSystem.parsedoc(docstr)
++ string(mdconvert(md))
++ end
++ end
++ end
++end
++
++# Docstring signature syntax highlighting tests.
++module HighlightSig
++ using Test
++ import Markdown
++ import Documenter.Expanders: highlightsig!
++
++ @testset "highlightsig!" begin
++ s = """
++ foo(bar::Baz)
++ ---
++ foo(bar::Baz)
++ """
++ original = Markdown.parse(s)
++ md = Markdown.parse(s)
++ highlightsig!(md)
++ @test isempty(original.content[1].language)
++ @test md.content[1].language == "julia"
++ @test original.content[end].language == md.content[end].language
++
++ s = """
++ ```lang
++ foo(bar::Baz)
++ ```
++ """
++ original = Markdown.parse(s)
++ md = Markdown.parse(s)
++ highlightsig!(md)
++ @test original == md
++ end
++end
++
++include("manual.jl")
--- /dev/null
--- /dev/null
++module UtilitiesTests
++
++using Test
++import Base64: stringmime
++
++import Documenter
++import Markdown
++
++module UnitTests
++ module SubModule end
++
++ # Does `submodules` collect *all* the submodules?
++ module A
++ module B
++ module C
++ module D end
++ end
++ end
++ end
++
++ mutable struct T end
++ mutable struct S{T} end
++
++ "Documenter unit tests."
++ Base.length(::T) = 1
++
++ f(x) = x
++
++ const pi = 3.0
++end
++
++module OuterModule
++module InnerModule
++import ..OuterModule
++export OuterModule
++end
++end
++
++module ExternalModule end
++module ModuleWithAliases
++using ..ExternalModule
++Y = ExternalModule
++module A
++ module B
++ const X = Main
++ end
++end
++end
++
++@testset "Utilities" begin
++ let doc = @doc(length)
++ a = Documenter.Utilities.filterdocs(doc, Set{Module}())
++ b = Documenter.Utilities.filterdocs(doc, Set{Module}([UnitTests]))
++ c = Documenter.Utilities.filterdocs(doc, Set{Module}([Base]))
++ d = Documenter.Utilities.filterdocs(doc, Set{Module}([UtilitiesTests]))
++
++ @test a !== nothing
++ @test a === doc
++ @test b !== nothing
++ @test occursin("Documenter unit tests.", stringmime("text/plain", b))
++ @test c !== nothing
++ @test !occursin("Documenter unit tests.", stringmime("text/plain", c))
++ @test d === nothing
++ end
++
++ # Documenter.Utilities.issubmodule
++ @test Documenter.Utilities.issubmodule(Main, Main) === true
++ @test Documenter.Utilities.issubmodule(UnitTests, UnitTests) === true
++ @test Documenter.Utilities.issubmodule(UnitTests.SubModule, Main) === true
++ @test Documenter.Utilities.issubmodule(UnitTests.SubModule, UnitTests) === true
++ @test Documenter.Utilities.issubmodule(UnitTests.SubModule, Base) === false
++ @test Documenter.Utilities.issubmodule(UnitTests, UnitTests.SubModule) === false
++
++ @test UnitTests.A in Documenter.Utilities.submodules(UnitTests.A)
++ @test UnitTests.A.B in Documenter.Utilities.submodules(UnitTests.A)
++ @test UnitTests.A.B.C in Documenter.Utilities.submodules(UnitTests.A)
++ @test UnitTests.A.B.C.D in Documenter.Utilities.submodules(UnitTests.A)
++ @test OuterModule in Documenter.Utilities.submodules(OuterModule)
++ @test OuterModule.InnerModule in Documenter.Utilities.submodules(OuterModule)
++ @test length(Documenter.Utilities.submodules(OuterModule)) == 2
++ @test Documenter.Utilities.submodules(ModuleWithAliases) == Set([ModuleWithAliases, ModuleWithAliases.A, ModuleWithAliases.A.B])
++
++ @test Documenter.Utilities.isabsurl("file.md") === false
++ @test Documenter.Utilities.isabsurl("../file.md") === false
++ @test Documenter.Utilities.isabsurl(".") === false
++ @test Documenter.Utilities.isabsurl("https://example.org/file.md") === true
++ @test Documenter.Utilities.isabsurl("http://example.org") === true
++ @test Documenter.Utilities.isabsurl("ftp://user:pw@example.org") === true
++ @test Documenter.Utilities.isabsurl("/fs/absolute/path") === false
++
++ @test Documenter.Utilities.doccat(UnitTests) == "Module"
++ @test Documenter.Utilities.doccat(UnitTests.T) == "Type"
++ @test Documenter.Utilities.doccat(UnitTests.S) == "Type"
++ @test Documenter.Utilities.doccat(UnitTests.f) == "Function"
++ @test Documenter.Utilities.doccat(UnitTests.pi) == "Constant"
++
++ # repo type
++ @test Documenter.Utilities.repo_host_from_url("https://bitbucket.org/somerepo") == Documenter.Utilities.RepoBitbucket
++ @test Documenter.Utilities.repo_host_from_url("https://www.bitbucket.org/somerepo") == Documenter.Utilities.RepoBitbucket
++ @test Documenter.Utilities.repo_host_from_url("http://bitbucket.org/somethingelse") == Documenter.Utilities.RepoBitbucket
++ @test Documenter.Utilities.repo_host_from_url("http://github.com/Whatever") == Documenter.Utilities.RepoGithub
++ @test Documenter.Utilities.repo_host_from_url("https://github.com/Whatever") == Documenter.Utilities.RepoGithub
++ @test Documenter.Utilities.repo_host_from_url("https://www.github.com/Whatever") == Documenter.Utilities.RepoGithub
++ @test Documenter.Utilities.repo_host_from_url("https://gitlab.com/Whatever") == Documenter.Utilities.RepoGitlab
++
++ # line range
++ let formatting = Documenter.Utilities.LineRangeFormatting(Documenter.Utilities.RepoGithub)
++ @test Documenter.Utilities.format_line(1:1, formatting) == "L1"
++ @test Documenter.Utilities.format_line(123:123, formatting) == "L123"
++ @test Documenter.Utilities.format_line(2:5, formatting) == "L2-L5"
++ @test Documenter.Utilities.format_line(100:9999, formatting) == "L100-L9999"
++ end
++
++ let formatting = Documenter.Utilities.LineRangeFormatting(Documenter.Utilities.RepoGitlab)
++ @test Documenter.Utilities.format_line(1:1, formatting) == "L1"
++ @test Documenter.Utilities.format_line(123:123, formatting) == "L123"
++ @test Documenter.Utilities.format_line(2:5, formatting) == "L2-5"
++ @test Documenter.Utilities.format_line(100:9999, formatting) == "L100-9999"
++ end
++
++ let formatting = Documenter.Utilities.LineRangeFormatting(Documenter.Utilities.RepoBitbucket)
++ @test Documenter.Utilities.format_line(1:1, formatting) == "1"
++ @test Documenter.Utilities.format_line(123:123, formatting) == "123"
++ @test Documenter.Utilities.format_line(2:5, formatting) == "2:5"
++ @test Documenter.Utilities.format_line(100:9999, formatting) == "100:9999"
++ end
++
++ # URL building
++ filepath = string(first(methods(Documenter.Utilities.url)).file)
++ Sys.iswindows() && (filepath = replace(filepath, "/" => "\\")) # work around JuliaLang/julia#26424
++ let expected_filepath = "/src/Utilities/Utilities.jl"
++ Sys.iswindows() && (expected_filepath = replace(expected_filepath, "/" => "\\"))
++ @test endswith(filepath, expected_filepath)
++ end
++
++ mktempdir() do path
++ path_repo = joinpath(path, "repository")
++ mkpath(path_repo)
++ cd(path_repo) do
++ # Create a simple mock repo in a temporary directory with a single file.
++ @test success(`git init`)
++ @test success(`git config user.email "tester@example.com"`)
++ @test success(`git config user.name "Test Committer"`)
++ @test success(`git remote add origin git@github.com:JuliaDocs/Documenter.jl.git`)
++ mkpath("src")
++ filepath = abspath(joinpath("src", "SourceFile.jl"))
++ write(filepath, "X")
++ @test success(`git add -A`)
++ @test success(`git commit -m"Initial commit."`)
++
++ # Run tests
++ commit = Documenter.Utilities.repo_commit(filepath)
++
++ @test Documenter.Utilities.url("//blob/{commit}{path}#{line}", filepath) == "//blob/$(commit)/src/SourceFile.jl#"
++ @test Documenter.Utilities.url(nothing, "//blob/{commit}{path}#{line}", Documenter.Utilities, filepath, 10:20) == "//blob/$(commit)/src/SourceFile.jl#L10-L20"
++
++ # repo_root & relpath_from_repo_root
++ @test Documenter.Utilities.repo_root(filepath) == dirname(abspath(joinpath(dirname(filepath), ".."))) # abspath() keeps trailing /, hence dirname()
++ @test Documenter.Utilities.repo_root(filepath; dbdir=".svn") == nothing
++ @test Documenter.Utilities.relpath_from_repo_root(filepath) == joinpath("src", "SourceFile.jl")
++ # We assume that a temporary file is not in a repo
++ @test Documenter.Utilities.repo_root(tempname()) == nothing
++ @test Documenter.Utilities.relpath_from_repo_root(tempname()) == nothing
++ end
++
++ # Test worktree
++ path_worktree = joinpath(path, "worktree")
++ cd("$(path_repo)") do
++ @test success(`git worktree add $(path_worktree)`)
++ end
++ cd("$(path_worktree)") do
++ filepath = abspath(joinpath("src", "SourceFile.jl"))
++ # Run tests
++ commit = Documenter.Utilities.repo_commit(filepath)
++
++ @test Documenter.Utilities.url("//blob/{commit}{path}#{line}", filepath) == "//blob/$(commit)/src/SourceFile.jl#"
++ @test Documenter.Utilities.url(nothing, "//blob/{commit}{path}#{line}", Documenter.Utilities, filepath, 10:20) == "//blob/$(commit)/src/SourceFile.jl#L10-L20"
++
++ # repo_root & relpath_from_repo_root
++ @test Documenter.Utilities.repo_root(filepath) == dirname(abspath(joinpath(dirname(filepath), ".."))) # abspath() keeps trailing /, hence dirname()
++ @test Documenter.Utilities.repo_root(filepath; dbdir=".svn") == nothing
++ @test Documenter.Utilities.relpath_from_repo_root(filepath) == joinpath("src", "SourceFile.jl")
++ # We assume that a temporary file is not in a repo
++ @test Documenter.Utilities.repo_root(tempname()) == nothing
++ @test Documenter.Utilities.relpath_from_repo_root(tempname()) == nothing
++ end
++
++ # Test submodule
++ path_submodule = joinpath(path, "submodule")
++ mkpath(path_submodule)
++ cd(path_submodule) do
++ @test success(`git init`)
++ @test success(`git config user.email "tester@example.com"`)
++ @test success(`git config user.name "Test Committer"`)
++ # NOTE: the target path in the `git submodule add` command is necessary for
++ # Windows builds, since otherwise Git claims that the path is in a .gitignore
++ # file.
++ @test success(`git submodule add $(path_repo) repository`)
++ @test success(`git add -A`)
++ @test success(`git commit -m"Initial commit."`)
++ end
++ path_submodule_repo = joinpath(path, "submodule", "repository")
++ @test isdir(path_submodule_repo)
++ cd(path_submodule_repo) do
++ filepath = abspath(joinpath("src", "SourceFile.jl"))
++ # Run tests
++ commit = Documenter.Utilities.repo_commit(filepath)
++
++ @test isfile(filepath)
++
++ @test Documenter.Utilities.url("//blob/{commit}{path}#{line}", filepath) == "//blob/$(commit)/src/SourceFile.jl#"
++ @test Documenter.Utilities.url(nothing, "//blob/{commit}{path}#{line}", Documenter.Utilities, filepath, 10:20) == "//blob/$(commit)/src/SourceFile.jl#L10-L20"
++
++ # repo_root & relpath_from_repo_root
++ @test Documenter.Utilities.repo_root(filepath) == dirname(abspath(joinpath(dirname(filepath), ".."))) # abspath() keeps trailing /, hence dirname()
++ @test Documenter.Utilities.repo_root(filepath; dbdir=".svn") == nothing
++ @test Documenter.Utilities.relpath_from_repo_root(filepath) == joinpath("src", "SourceFile.jl")
++ # We assume that a temporary file is not in a repo
++ @test Documenter.Utilities.repo_root(tempname()) == nothing
++ @test Documenter.Utilities.relpath_from_repo_root(tempname()) == nothing
++ end
++ end
++
++ import Documenter.Documents: Document, Page, Globals
++ import Documenter.Utilities: Markdown2
++ let page = Page("source", "build", :build, [], IdDict{Any,Any}(), Globals(), Markdown2.MD()), doc = Document()
++ code = """
++ x += 3
++ γγγ_γγγ
++ γγγ
++ """
++ exprs = Documenter.Utilities.parseblock(code, doc, page)
++
++ @test isa(exprs, Vector)
++ @test length(exprs) === 3
++
++ @test isa(exprs[1][1], Expr)
++ @test exprs[1][1].head === :+=
++ @test exprs[1][2] == "x += 3\n"
++
++ @test exprs[2][2] == "γγγ_γγγ\n"
++
++ @test exprs[3][1] === :γγγ
++ @test exprs[3][2] == "γγγ\n"
++ end
++
++ @testset "TextDiff" begin
++ import Documenter.Utilities.TextDiff: splitby
++ @test splitby(r"\s+", "X Y Z") == ["X ", "Y ", "Z"]
++ @test splitby(r"[~]", "X~Y~Z") == ["X~", "Y~", "Z"]
++ @test splitby(r"[▶]", "X▶Y▶Z") == ["X▶", "Y▶", "Z"]
++ @test splitby(r"[▶]+", "X▶▶Y▶Z▶") == ["X▶▶", "Y▶", "Z▶"]
++ @test splitby(r"[▶]+", "▶▶Y▶Z▶") == ["▶▶", "Y▶", "Z▶"]
++ @test splitby(r"[▶]+", "Ω▶▶Y▶Z▶") == ["Ω▶▶", "Y▶", "Z▶"]
++ @test splitby(r"[▶]+", "Ω▶▶Y▶Z▶κ") == ["Ω▶▶", "Y▶", "Z▶", "κ"]
++ end
++
++ @static if isdefined(Base, :with_logger)
++ @testset "withoutput" begin
++ _, _, _, output = Documenter.Utilities.withoutput() do
++ println("println")
++ @info "@info"
++ f() = (Base.depwarn("depwarn", :f); nothing)
++ f()
++ end
++ @test startswith(output, "println\n[ Info: @info\n┌ Warning: depwarn\n")
++ end
++ end
++
++ @testset "issues #749, #790, #823" begin
++ let parse(x) = Documenter.Utilities.parseblock(x, nothing, nothing)
++ for LE in ("\r\n", "\n")
++ l1, l2 = parse("x = Int[]$(LE)$(LE)push!(x, 1)$(LE)")
++ @test l1[1] == :(x = Int[])
++ @test l1[2] == "x = Int[]$(LE)"
++ @test l2[1] == :(push!(x, 1))
++ @test l2[2] == "push!(x, 1)$(LE)"
++ end
++ end
++ end
++
++ @testset "mdparse" begin
++ mdparse = Documenter.Utilities.mdparse
++
++ @test_throws ArgumentError mdparse("", mode=:foo)
++
++ mdparse("") isa Markdown.Paragraph
++ @test mdparse("foo bar") isa Markdown.Paragraph
++ let md = mdparse("", mode=:span)
++ @test md isa Vector{Any}
++ @test length(md) == 1
++ end
++ let md = mdparse("", mode=:blocks)
++ @test md isa Vector{Any}
++ @test length(md) == 0
++ end
++
++ @test mdparse("!!! adm"; mode=:single) isa Markdown.Admonition
++ let md = mdparse("!!! adm", mode=:blocks)
++ @test md isa Vector{Any}
++ @test length(md) == 1
++ end
++ let md = mdparse("x\n\ny", mode=:blocks)
++ @test md isa Vector{Any}
++ @test length(md) == 2
++ end
++
++ @info "Expected error output:"
++ @test_throws ArgumentError mdparse("!!! adm", mode=:span)
++ @test_throws ArgumentError mdparse("x\n\ny")
++ @test_throws ArgumentError mdparse("x\n\ny", mode=:span)
++ @info ".. end of expected error output."
++ end
++end
++
++end
--- /dev/null
--- /dev/null
++using Documenter
++
++const pages = [
++ "Home" => "index.md",
++ "File" => "file.md",
++ "Subdir" => "subdir/index.md",
++ "Subfile" => "subdir/file.md",
++]
++
++@info "Building builds/default"
++makedocs(sitename="Test", pages = pages, build="builds/default")
++
++@info "Building builds/absolute"
++mkdir(joinpath(@__DIR__, "builds/absolute-workdir"))
++makedocs(sitename="Test", pages = pages, build="builds/absolute", workdir=joinpath(@__DIR__, "builds/absolute-workdir"))
++
++@info "Building builds/relative"
++mkdir(joinpath(@__DIR__, "builds/relative-workdir"))
++makedocs(sitename="Test", pages = pages, build="builds/relative", workdir="builds/relative-workdir")
--- /dev/null
--- /dev/null
++# Testing
++
++Here's a test
++
++```@repl
++pwd()
++
++touch("root_file.txt")
++```
--- /dev/null
--- /dev/null
++# Testing
++
++Here's a test
++
++```@repl
++pwd()
++
++touch("root_index.txt")
++```
--- /dev/null
--- /dev/null
++# Testing
++
++Here's a test
++
++```@repl
++pwd()
++
++touch("subdir_file.txt")
++```
--- /dev/null
--- /dev/null
++# Testing
++
++Here's a test
++
++```@repl
++pwd()
++
++touch("subdir_index.txt")
++```
--- /dev/null
--- /dev/null
++using Test
++
++# for convenience, when debugging, the build step can be disabled when running the tests with
++# julia test/workdir/tests.jl skipbuild
++if !("skipbuild" in ARGS)
++ rm(joinpath(@__DIR__, "builds"), recursive=true, force=true) # cleanup of previous test run
++ include(joinpath(@__DIR__, "make.jl"))
++end
++
++@testset "makedocs workdir" begin
++ # test for the default build
++ @test isfile(joinpath(@__DIR__, "builds", "default", "root_index.txt"))
++ @test isfile(joinpath(@__DIR__, "builds", "default", "root_file.txt"))
++ @test isfile(joinpath(@__DIR__, "builds", "default", "subdir", "subdir_index.txt"))
++ @test isfile(joinpath(@__DIR__, "builds", "default", "subdir", "subdir_file.txt"))
++
++ # absolute path
++ @test !isfile(joinpath(@__DIR__, "builds", "absolute", "root_index.txt"))
++ @test !isfile(joinpath(@__DIR__, "builds", "absolute", "root_file.txt"))
++ @test !isfile(joinpath(@__DIR__, "builds", "absolute", "subdir", "subdir_index.txt"))
++ @test !isfile(joinpath(@__DIR__, "builds", "absolute", "subdir", "subdir_file.txt"))
++ @test isfile(joinpath(@__DIR__, "builds", "absolute-workdir", "root_index.txt"))
++ @test isfile(joinpath(@__DIR__, "builds", "absolute-workdir", "root_file.txt"))
++ @test isfile(joinpath(@__DIR__, "builds", "absolute-workdir", "subdir_index.txt"))
++ @test isfile(joinpath(@__DIR__, "builds", "absolute-workdir", "subdir_file.txt"))
++
++ # relative path
++ @test !isfile(joinpath(@__DIR__, "builds", "relative", "root_index.txt"))
++ @test !isfile(joinpath(@__DIR__, "builds", "relative", "root_file.txt"))
++ @test !isfile(joinpath(@__DIR__, "builds", "relative", "subdir", "subdir_index.txt"))
++ @test !isfile(joinpath(@__DIR__, "builds", "relative", "subdir", "subdir_file.txt"))
++ @test isfile(joinpath(@__DIR__, "builds", "relative-workdir", "root_index.txt"))
++ @test isfile(joinpath(@__DIR__, "builds", "relative-workdir", "root_file.txt"))
++ @test isfile(joinpath(@__DIR__, "builds", "relative-workdir", "subdir_index.txt"))
++ @test isfile(joinpath(@__DIR__, "builds", "relative-workdir", "subdir_file.txt"))
++end
--- /dev/null
--- /dev/null
++language: julia
++
++os:
++ - linux
++ - osx
++
++julia:
++ - 0.7
++ - 1.0
++ - nightly
++
++notifications:
++ email: false
++
++after_success:
++ - julia --project=coverage/ -e 'using Pkg; Pkg.instantiate()'
++ - julia --project=coverage/ coverage/coverage.jl
--- /dev/null
--- /dev/null
++# DocumenterLaTeX.jl changelog
++
++## Version `v0.2.0`
++
++* ![Enhancement][badge-enhancement] Now defines and exports the `LaTeX` type
++ which should be passed to Documenter's `makedocs` as `makedocs(format = LaTeX(), ...)`
++ for specifying LaTeX / PDF output ([#6][github-6]).
++
++## Version `v0.1.0`
++
++* Initial release.
++
++
++[github-6]: https://github.com/JuliaDocs/DocumenterLaTeX.jl/pull/6
++
++
++[badge-breaking]: https://img.shields.io/badge/BREAKING-red.svg
++[badge-deprecation]: https://img.shields.io/badge/deprecation-orange.svg
++[badge-feature]: https://img.shields.io/badge/feature-green.svg
++[badge-enhancement]: https://img.shields.io/badge/enhancement-blue.svg
++[badge-bugfix]: https://img.shields.io/badge/bugfix-purple.svg
++
++<!--
++# Badges
++
++![BREAKING][badge-breaking]
++![Deprecation][badge-deprecation]
++![Feature][badge-feature]
++![Enhancement][badge-enhancement]
++![Bugfix][badge-bugfix]
++-->
--- /dev/null
--- /dev/null
++DocumenterLaTeX.jl is licensed under the MIT "Expat" License:
++
++> Copyright (c) 2016-2017: Michael Hatherly.
++> Copyright (c) 2018: Morten Piibeleht and others.
++>
++> Permission is hereby granted, free of charge, to any person obtaining a copy
++> of this software and associated documentation files (the "Software"), to deal
++> in the Software without restriction, including without limitation the rights
++> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
++> copies of the Software, and to permit persons to whom the Software is
++> furnished to do so, subject to the following conditions:
++>
++> The above copyright notice and this permission notice shall be included in all
++> copies or substantial portions of the Software.
++>
++> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
++> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
++> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
++> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
++> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
++> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
++> SOFTWARE.
++>
++
++DocumenterLaTeX.jl includes code from
++[Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) (by Michael Hatherly
++and other Documenter.jl contributors) released under the MIT license.
--- /dev/null
--- /dev/null
++name = "DocumenterLaTeX"
++uuid = "cd674d7a-5f81-5cf3-af33-235ef1834b99"
++version = "0.1.0"
++
++[deps]
++Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
++
++[extras]
++Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
++
++[targets]
++test = ["Test"]
--- /dev/null
--- /dev/null
++# DocumenterLaTeX
++
++| **Build Status** |
++|:-----------------------------------------------------------------------------------------------:|
++| [![][travis-img]][travis-url] [![][appveyor-img]][appveyor-url] [![][codecov-img]][codecov-url] |
++
++This package enables the LaTeX / PDF backend of [`Documenter.jl`][documenter].
++
++## Installation
++
++The package can be added using the Julia package manager.
++From the Julia REPL, type `]` to enter the Pkg REPL mode and run
++
++```
++pkg> add DocumenterLaTeX
++```
++
++## Usage
++
++To enable the backend import the package in `make.jl` and then just pass `format = DocumenterLaTeX.LaTeX()`
++to `makedocs`:
++
++```julia
++using Documenter
++using DocumenterLaTeX
++makedocs(format = DocumenterLaTeX.LaTeX(), ...)
++```
++
++[documenter]: https://github.com/JuliaDocs/Documenter.jl
++[documenter-docs]: https://juliadocs.github.io/Documenter.jl/stable/
++
++[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
++[docs-stable-url]: https://juliadocs.github.io/DocumenterLaTeX.jl/stable
++
++[travis-img]: https://travis-ci.org/JuliaDocs/DocumenterLaTeX.jl.svg?branch=master
++[travis-url]: https://travis-ci.org/JuliaDocs/DocumenterLaTeX.jl
++
++[appveyor-img]: https://ci.appveyor.com/api/projects/status/x5d69ftlp7q44kam?svg=true
++[appveyor-url]: https://ci.appveyor.com/project/JuliaDocs/documenterlatex-jl
++
++[codecov-img]: https://codecov.io/gh/JuliaDocs/DocumenterLaTeX.jl/branch/master/graph/badge.svg
++[codecov-url]: https://codecov.io/gh/JuliaDocs/DocumenterLaTeX.jl
--- /dev/null
--- /dev/null
++julia 0.7
++Documenter 0.21
--- /dev/null
--- /dev/null
++environment:
++ matrix:
++ - julia_version: 0.7
++ - julia_version: 1.0
++ - julia_version: latest
++
++platform:
++ - x86 # 32-bit
++ - x64 # 64-bit
++
++## uncomment the following lines to allow failures on nightly julia
++## (tests will run but not make your overall status red)
++#matrix:
++# allow_failures:
++# - julia_version: latest
++
++branches:
++ only:
++ - master
++ - /release-.*/
++
++notifications:
++ - provider: Email
++ on_build_success: false
++ on_build_failure: false
++ on_build_status_changed: false
++
++install:
++ - ps: iex ((new-object net.webclient).DownloadString("https://raw.githubusercontent.com/JuliaCI/Appveyor.jl/version-1/bin/install.ps1"))
++
++build_script:
++ - echo "%JL_BUILD_SCRIPT%"
++ - C:\julia\bin\julia -e "%JL_BUILD_SCRIPT%"
++
++test_script:
++ - echo "%JL_TEST_SCRIPT%"
++ - C:\julia\bin\julia -e "%JL_TEST_SCRIPT%"
--- /dev/null
--- /dev/null
++[deps]
++Coverage = "a2441757-f6aa-5fb2-8edb-039e3f45d037"
--- /dev/null
--- /dev/null
++# Only run coverage from linux nightly build on travis.
++get(ENV, "TRAVIS_OS_NAME", "") == "linux" || exit()
++get(ENV, "TRAVIS_JULIA_VERSION", "") == "nightly" || exit()
++
++using Coverage
++
++cd(joinpath(dirname(@__FILE__), "..")) do
++ Codecov.submit(Codecov.process_folder())
++end
--- /dev/null
--- /dev/null
++# juliadocs/documenter-latex:0.1
++FROM ubuntu:18.04
++ENV DEBIAN_FRONTEND noninteractive
++RUN apt-get update && \
++ apt-get install --no-install-recommends -qy \
++ latexmk \
++ texlive-latex-base \
++ texlive-luatex \
++ texlive-latex-recommended \
++ texlive-latex-extra \
++ fonts-lato \
++ python-pygments \
++ fontconfig && \
++ rm -rf /var/lib/apt/lists/*
++ADD https://api.github.com/repos/google/fonts/tarball/master google-fonts.tar.gz
++RUN mkdir google-fonts /usr/share/fonts/robotomono/ && \
++ tar xzf google-fonts.tar.gz --strip-components=1 -C google-fonts && \
++ mv google-fonts/apache/robotomono/RobotoMono*.ttf /usr/share/fonts/robotomono/ && \
++ rm -rf google-fonts google-fonts.tar.gz && \
++ fc-cache -fv
++RUN useradd -m zeptodoctor
++WORKDIR /home/zeptodoctor/
--- /dev/null
--- /dev/null
++# documenter-latex
++
++[](https://hub.docker.com/r/juliadocs/documenter-latex/)
++
++Docker image for compiling pdf output with
++[`Documenter.jl`](https://github.com/JuliaDocs/Documenter.jl) and
++[`DocumenterLaTeX.jl`](https://github.com/JuliaDocs/DocumenterLaTeX.jl).
++
++## Whats in the image?
++
++Ubuntu + a (minimal) texlive installation, essentially only including what's
++needed for compiling the output of `Documenter.jl`/`DocumenterLaTeX.jl`.
--- /dev/null
--- /dev/null
++module DocumenterLaTeX
++
++using Documenter
++
++const LaTeX = Documenter.Writers.LaTeXWriter.LaTeX
++export LaTeX
++
++function __init__()
++ if !isdefined(Documenter.Writers, :enable_backend)
++ @warn """Incompatible Documenter version.
++
++ Documenter.Writers is missing the enable_backend() function.
++ """
++ return
++ end
++ Documenter.Writers.enable_backend(:latex)
++ nothing
++end
++
++end # module
--- /dev/null
--- /dev/null
++using Test
++using Documenter
++
++@test isdefined(Documenter.Writers, :enable_backend)
++@test isdefined(Documenter.Writers, :backends_enabled)
++
++@test Documenter.Writers.backends_enabled[:latex] === false
++
++using DocumenterLaTeX
++
++@test Documenter.Writers.backends_enabled[:latex] === true
--- /dev/null
--- /dev/null
++language: julia
++os:
++ - osx
++ - linux
++julia:
++ - 0.7
++ - 1.0
++ - nightly
++notifications:
++ email: false
++after_success:
++ - julia -e 'import Pkg; Pkg.add("Coverage"); using Coverage; Codecov.submit(process_folder())';
--- /dev/null
--- /dev/null
++The Julia JSON package is licensed under the MIT Expat License:
++
++> Copyright (c) 2002: JSON.org, 2012–2016: Avik Sengupta, Stefan Karpinski,
++> David de Laat, Dirk Gadsen, Milo Yip and other contributors
++> – https://github.com/JuliaLang/JSON.jl/contributors
++> and https://github.com/miloyip/nativejson-benchmark/contributors
++>
++> Permission is hereby granted, free of charge, to any person obtaining
++> a copy of this software and associated documentation files (the
++> "Software"), to deal in the Software without restriction, including
++> without limitation the rights to use, copy, modify, merge, publish,
++> distribute, sublicense, and/or sell copies of the Software, and to
++> permit persons to whom the Software is furnished to do so, subject to
++> the following conditions:
++>
++> The above copyright notice and this permission notice shall be
++> included in all copies or substantial portions of the Software.
++>
++> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
++> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
++> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
++> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
++> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
++> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
++> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
--- /dev/null
--- /dev/null
++name = "JSON"
++uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
++version = "0.21.0"
++
++[deps]
++Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
++Mmap = "a63ad114-7e13-5084-954f-fe012c677804"
++Parsers = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
++Unicode = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
++
++[extras]
++DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
++Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
++FixedPointNumbers = "53c48c17-4a7d-5ca2-90c5-79b7896eea93"
++OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
++Sockets = "6462fe0b-24de-5631-8697-dd941f90decc"
++Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
++
++[compat]
++julia = "0.7, 1.0"
++
++[targets]
++test = ["DataStructures", "Distributed", "FixedPointNumbers", "OffsetArrays", "Sockets", "Test"]
--- /dev/null
--- /dev/null
++# JSON.jl
++### Parsing and printing JSON in pure Julia.
++
++[](https://travis-ci.org/JuliaIO/JSON.jl)
++[](https://ci.appveyor.com/project/staticfloat/json-jl)
++[](http://codecov.io/github/JuliaIO/JSON.jl?branch=master)
++
++[](http://pkg.julialang.org/?pkg=JSON&ver=0.3)
++[](http://pkg.julialang.org/?pkg=JSON&ver=0.4)
++[](http://pkg.julialang.org/?pkg=JSON&ver=0.5)
++[](http://pkg.julialang.org/?pkg=JSON&ver=0.6)
++
++**Installation**: `julia> Pkg.add("JSON")`
++
++
++## Basic Usage
++
++
++```julia
++import JSON
++
++# JSON.parse - string or stream to Julia data structures
++s = "{\"a_number\" : 5.0, \"an_array\" : [\"string\", 9]}"
++j = JSON.parse(s)
++# Dict{AbstractString,Any} with 2 entries:
++# "an_array" => {"string",9}
++# "a_number" => 5.0
++
++# JSON.json - Julia data structures to a string
++JSON.json([2,3])
++# "[2,3]"
++JSON.json(j)
++# "{\"an_array\":[\"string\",9],\"a_number\":5.0}"
++```
++
++## Documentation
++
++
++```julia
++JSON.print(io::IO, s::AbstractString)
++JSON.print(io::IO, s::Union{Integer, AbstractFloat})
++JSON.print(io::IO, n::Nothing)
++JSON.print(io::IO, b::Bool)
++JSON.print(io::IO, a::AbstractDict)
++JSON.print(io::IO, v::AbstractVector)
++JSON.print{T, N}(io::IO, v::Array{T, N})
++```
++
++Writes a compact (no extra whitespace or indentation) JSON representation
++to the supplied IO.
++
++```julia
++JSON.print(a::AbstractDict, indent)
++JSON.print(io::IO, a::AbstractDict, indent)
++```
++
++Writes a JSON representation with newlines, and indentation if specified. Non-zero `indent` will be applied recursively to nested elements.
++
++
++```julia
++json(a::Any)
++```
++
++Returns a compact JSON representation as an `AbstractString`.
++
++```julia
++JSON.parse(s::AbstractString; dicttype=Dict, inttype=Int64)
++JSON.parse(io::IO; dicttype=Dict, inttype=Int64)
++JSON.parsefile(filename::AbstractString; dicttype=Dict, inttype=Int64, use_mmap=true)
++```
++
++Parses a JSON `AbstractString` or IO stream into a nested `Array` or `Dict`.
++
++The `dicttype` indicates the dictionary type (`<: Associative`), or a function that
++returns an instance of a dictionary type,
++that JSON objects are parsed to. It defaults to `Dict` (the built-in Julia
++dictionary), but a different type can be passed for additional functionality.
++For example, if you `import DataStructures`
++(assuming the [DataStructures
++package](https://github.com/JuliaLang/DataStructures.jl) is
++installed)
++
++ - you can pass `dicttype=DataStructures.OrderedDict` to maintain the insertion order
++ of the items in the object;
++ - or you can pass `()->DefaultDict{String,Any}(Missing)` to having any non-found keys
++ return `missing` when you index the result.
++
++
++The `inttype` argument controls how integers are parsed. If a number in a JSON
++file is recognized to be an integer, it is parsed as one; otherwise it is parsed
++as a `Float64`. The `inttype` defaults to `Int64`, but, for example, if you know
++that your integer numbers are all small and want to save space, you can pass
++`inttype=Int32`. Alternatively, if your JSON input has integers which are too large
++for Int64, you can pass `inttype=Int128` or `inttype=BigInt`. `inttype` can be any
++subtype of `Real`.
++
++```julia
++JSONText(s::AbstractString)
++```
++A wrapper around a Julia string representing JSON-formatted text,
++which is inserted *as-is* in the JSON output of `JSON.print` and `JSON.json`.
++
++```julia
++JSON.lower(p::Point2D) = [p.x, p.y]
++```
++
++Define a custom serialization rule for a particular data type. Must return a
++value that can be directly serialized; see help for more details.
--- /dev/null
--- /dev/null
++environment:
++ matrix:
++ - julia_version: 0.7
++ - julia_version: 1
++ - julia_version: nightly
++
++platform:
++ - x86 # 32-bit
++ - x64 # 64-bit
++
++# # Uncomment the following lines to allow failures on nightly julia
++# # (tests will run but not make your overall status red)
++# matrix:
++# allow_failures:
++# - julia_version: nightly
++
++branches:
++ only:
++ - master
++ - /release-.*/
++
++notifications:
++ - provider: Email
++ on_build_success: false
++ on_build_failure: false
++ on_build_status_changed: false
++
++install:
++ - ps: iex ((new-object net.webclient).DownloadString("https://raw.githubusercontent.com/JuliaCI/Appveyor.jl/version-1/bin/install.ps1"))
++
++build_script:
++ - echo "%JL_BUILD_SCRIPT%"
++ - C:\julia\bin\julia -e "%JL_BUILD_SCRIPT%"
++
++test_script:
++ - echo "%JL_TEST_SCRIPT%"
++ - C:\julia\bin\julia -e "%JL_TEST_SCRIPT%"
++
++# # Uncomment to support code coverage upload. Should only be enabled for packages
++# # which would have coverage gaps without running on Windows
++# on_success:
++# - echo "%JL_CODECOV_SCRIPT%"
++# - C:\julia\bin\julia -e "%JL_CODECOV_SCRIPT%"
--- /dev/null
--- /dev/null
++#!/usr/bin/julia --color=yes
++
++using ArgParse
++using JSON
++
++
++function bench(f, flags, parsefile, simulate=false)
++ fp = joinpath(JSON_DATA_DIR, string(f, ".json"))
++ if !isfile(fp)
++ println("Downloading benchmark file...")
++ download(DATA_SOURCES[f], fp)
++ end
++ GC.gc() # run gc so it doesn't affect benchmarks
++ t = if parsefile
++ @elapsed JSON.parsefile(fp)
++ else
++ data = read(fp, String)
++ @elapsed JSON.Parser.parse(data)
++ end
++
++ if !simulate
++ printstyled(" [Bench$flags] "; color=:yellow)
++ println(f, " ", t, " seconds")
++ end
++ t
++end
++
++
++const JSON_DATA_DIR = joinpath(dirname(dirname(@__FILE__)), "data")
++const s = ArgParseSettings(description="Benchmark JSON.jl")
++
++const DATA_SOURCES = Dict(
++ "canada" => "https://raw.githubusercontent.com/miloyip/nativejson-benchmark/v1.0.0/data/canada.json",
++ "citm_catalog" => "https://raw.githubusercontent.com/miloyip/nativejson-benchmark/v1.0.0/data/citm_catalog.json",
++ "citylots" => "https://raw.githubusercontent.com/zemirco/sf-city-lots-json/master/citylots.json",
++ "twitter" => "https://raw.githubusercontent.com/miloyip/nativejson-benchmark/v1.0.0/data/twitter.json")
++
++function main()
++ @add_arg_table s begin
++ "parse"
++ action = :command
++ help = "Run a JSON parser benchmark"
++ "list"
++ action = :command
++ help = "List available JSON files for use"
++ end
++
++ @add_arg_table s["parse"] begin
++ "--include-compile", "-c"
++ help = "If set, include the compile time in measurements"
++ action = :store_true
++ "--parse-file", "-f"
++ help = "If set, measure JSON.parsefile, hence including IO time"
++ action = :store_true
++ "file"
++ help = "The JSON file to benchmark (leave out to benchmark all)"
++ required = false
++ end
++
++ args = parse_args(ARGS, s)
++
++ if args["%COMMAND%"] == "parse"
++ include_compile = args["parse"]["include-compile"]
++ parsefile = args["parse"]["parse-file"]
++
++ flags = string(include_compile ? "C" : "",
++ parsefile ? "F" : "")
++
++ if args["parse"]["file"] ≠ nothing
++ file = args["parse"]["file"]
++
++ if !include_compile
++ bench(file, flags, parsefile, true)
++ end
++ bench(file, flags, parsefile)
++ else
++ times = 1.0
++ if include_compile
++ error("Option --include-compile can only be used for single file.")
++ end
++ for k in sort(collect(keys(DATA_SOURCES)))
++ bench(k, flags, parsefile, true) # warm up compiler
++ end
++ for k in sort(collect(keys(DATA_SOURCES)))
++ times *= bench(k, flags, parsefile) # do benchmark
++ end
++ printstyled(" [Bench$flags] ", color=:yellow)
++ println("Total (G.M.) ", times^(1/length(DATA_SOURCES)), " seconds")
++ end
++ elseif args["%COMMAND%"] == "list"
++ println("Available benchmarks are:")
++ for k in sort(collect(keys(DATA_SOURCES)))
++ println(" • $k")
++ end
++ end
++end
++
++main()
--- /dev/null
--- /dev/null
++from functools import reduce
++from textwrap import dedent as dd
++from timeit import repeat
++
++
++sources = ["canada", "citm_catalog", "citylots", "twitter"]
++
++min_times = []
++for source in sources:
++ s = dd(f"""\
++ with open("../data/{source}.json") as f:
++ json.load(f)""")
++ times = repeat(stmt=s, setup="import json", repeat=3, number=1)
++ t = reduce(min, times)
++ print(f"{source} {t:0.06f} seconds")
++ min_times.append(t)
++
++geo_mean = reduce(lambda a, b: a*b, min_times)**(1/len(min_times))
++print(f"Total (G.M): {geo_mean:0.06f}")
--- /dev/null
--- /dev/null
++# JSON Microbenchmarks
++# 0.6 required for running benchmarks
++
++using JSON
++using BenchmarkTools
++using Dates
++
++const suite = BenchmarkGroup()
++
++suite["print"] = BenchmarkGroup(["serialize"])
++suite["pretty-print"] = BenchmarkGroup(["serialize"])
++
++struct CustomListType
++ x::Int
++ y::Float64
++ z::Union{CustomListType, Nothing}
++end
++
++struct CustomTreeType
++ x::String
++ y::Union{CustomTreeType, Nothing}
++ z::Union{CustomTreeType, Nothing}
++end
++
++list(x) = x == 0 ? nothing : CustomListType(1, 1.0, list(x - 1))
++tree(x) = x == 0 ? nothing : CustomTreeType("!!!", tree(x - 1), tree(x - 1))
++
++const micros = Dict(
++ "integer" => 88,
++ "float" => -88.8,
++ "ascii" => "Hello World!",
++ "ascii-1024" => "x" ^ 1024,
++ "unicode" => "ສະບາຍດີຊາວໂລກ!",
++ "unicode-1024" => "ℜ" ^ 1024,
++ "bool" => true,
++ "null" => nothing,
++ "flat-homogenous-array-16" => collect(1:16),
++ "flat-homogenous-array-1024" => collect(1:1024),
++ "heterogenous-array" => [
++ 1, 2, 3, 7, "A", "C", "E", "N", "Q", "R", "Shuttle to Grand Central"],
++ "nested-array-16^2" => [collect(1:16) for _ in 1:16],
++ "nested-array-16^3" => [[collect(1:16) for _ in 1:16] for _ in 1:16],
++ "small-dict" => Dict(
++ :a => :b, :c => "💙💙💙💙💙💙", :e => 10, :f => Dict(:a => :b)),
++ "flat-dict-128" => Dict(zip(collect(1:128), collect(1:128))),
++ "date" => Date(2016, 08, 09),
++ "matrix-16" => [i == j ? 1.0 : 0.0 for i in 1:16, j in 1:16],
++ "custom-list-128" => list(128),
++ "custom-tree-8" => tree(8))
++
++for (k, v) in micros
++ io = IOBuffer()
++ suite["print"][k] = @benchmarkable JSON.print($(IOBuffer()), $v)
++ suite["pretty-print"][k] = @benchmarkable JSON.print(
++ $(IOBuffer()), $v, 4)
++end
--- /dev/null
--- /dev/null
++fable
--- /dev/null
--- /dev/null
++["Unclosed array"
--- /dev/null
--- /dev/null
++{unquoted_key: "keys must be quoted"}
--- /dev/null
--- /dev/null
++["extra comma",]
--- /dev/null
--- /dev/null
++["double extra comma",,]
--- /dev/null
--- /dev/null
++[ , "<-- missing value"]
--- /dev/null
--- /dev/null
++["Comma after the close"],
--- /dev/null
--- /dev/null
++["Extra close"]]
--- /dev/null
--- /dev/null
++{"Extra comma": true,}
--- /dev/null
--- /dev/null
++{"Extra value after close": true} "misplaced quoted value"
--- /dev/null
--- /dev/null
++{"Illegal expression": 1 + 2}
--- /dev/null
--- /dev/null
++{"Illegal invocation": alert()}
--- /dev/null
--- /dev/null
++{"Numbers cannot have leading zeroes": 013}
--- /dev/null
--- /dev/null
++{"Numbers cannot be hex": 0x14}
--- /dev/null
--- /dev/null
++["Illegal backslash escape: \x15"]
--- /dev/null
--- /dev/null
++[\naked]
--- /dev/null
--- /dev/null
++["Illegal backslash escape: \017"]
--- /dev/null
--- /dev/null
++"mutliple"
++"things"
--- /dev/null
--- /dev/null
++{"Missing colon" null}
--- /dev/null
--- /dev/null
++{"Double colon":: null}
--- /dev/null
--- /dev/null
++{"Comma instead of colon", null}
--- /dev/null
--- /dev/null
++["Colon instead of comma": false]
--- /dev/null
--- /dev/null
++["Bad value", truth]
--- /dev/null
--- /dev/null
++['single quote']
--- /dev/null
--- /dev/null
++[" tab character in string "]
--- /dev/null
--- /dev/null
++["tab\ character\ in\ string\ "]
--- /dev/null
--- /dev/null
++["line
++break"]
--- /dev/null
--- /dev/null
++["line\
++break"]
--- /dev/null
--- /dev/null
++[0e]
--- /dev/null
--- /dev/null
++[0e+]
--- /dev/null
--- /dev/null
++[0e+-1]
--- /dev/null
--- /dev/null
++{"Comma instead of closing brace": true,
--- /dev/null
--- /dev/null
++["mismatch"}
--- /dev/null
--- /dev/null
++{"garbage" before : "separator"}
--- /dev/null
--- /dev/null
++{"no separator"
--- /dev/null
--- /dev/null
++{"no closing brace": true
--- /dev/null
--- /dev/null
++[
--- /dev/null
--- /dev/null
++{
--- /dev/null
--- /dev/null
++[
++ "JSON Test Pattern pass1",
++ {"object with 1 member":["array with 1 element"]},
++ {},
++ [],
++ -42,
++ true,
++ false,
++ null,
++ {
++ "integer": 1234567890,
++ "real": -9876.543210,
++ "e": 0.123456789e-12,
++ "E": 1.234567890E+34,
++ "": 23456789012E66,
++ "zero": 0,
++ "one": 1,
++ "space": " ",
++ "quote": "\"",
++ "backslash": "\\",
++ "controls": "\b\f\n\r\t",
++ "slash": "/ & \/",
++ "alpha": "abcdefghijklmnopqrstuvwyz",
++ "ALPHA": "ABCDEFGHIJKLMNOPQRSTUVWYZ",
++ "digit": "0123456789",
++ "0123456789": "digit",
++ "special": "`1~!@#$%^&*()_+-={':[,]}|;.</>?",
++ "hex": "\u0123\u4567\u89AB\uCDEF\uabcd\uef4A",
++ "true": true,
++ "false": false,
++ "null": null,
++ "array":[ ],
++ "object":{ },
++ "address": "50 St. James Street",
++ "url": "http://www.JSON.org/",
++ "comment": "// /* <!-- --",
++ "# -- --> */": " ",
++ " s p a c e d " :[1,2 , 3
++
++,
++
++4 , 5 , 6 ,7 ],"compact":[1,2,3,4,5,6,7],
++ "jsontext": "{\"object with 1 member\":[\"array with 1 element\"]}",
++ "quotes": "" \u0022 %22 0x22 034 "",
++ "\/\\\"\uCAFE\uBABE\uAB98\uFCDE\ubcda\uef4A\b\f\n\r\t`1~!@#$%^&*()_+-=[]{}|;:',./<>?"
++: "A key can be any string"
++ },
++ 0.5 ,98.6
++,
++99.44
++,
++
++1066,
++1e1,
++0.1e1,
++1e-1,
++1e00,2e+00,2e-00
++,"rosebud"]
--- /dev/null
--- /dev/null
++[[[[[[[[[[[[[[[[[[["Not too deep"]]]]]]]]]]]]]]]]]]]
--- /dev/null
--- /dev/null
++{
++ "JSON Test Pattern pass3": {
++ "The outermost value": "must be an object or array.",
++ "In this test": "It is an object."
++ }
++}
--- /dev/null
--- /dev/null
++Test suite from http://json.org/JSON_checker/.
++
++If the JSON_checker is working correctly, it must accept all of the pass*.json files and reject all of the fail*.json files.
--- /dev/null
--- /dev/null
++[null]
--- /dev/null
--- /dev/null
++[true]
--- /dev/null
--- /dev/null
++[false]
--- /dev/null
--- /dev/null
++[0]
--- /dev/null
--- /dev/null
++["foo"]
--- /dev/null
--- /dev/null
++[]
--- /dev/null
--- /dev/null
++{}
--- /dev/null
--- /dev/null
++[0,1]
--- /dev/null
--- /dev/null
++{"foo":"bar"}
--- /dev/null
--- /dev/null
++{"a":null,"foo":"bar"}
--- /dev/null
--- /dev/null
++[-1]
--- /dev/null
--- /dev/null
++[-2147483648]
--- /dev/null
--- /dev/null
++[-1234567890123456789]
--- /dev/null
--- /dev/null
++[-9223372036854775808]
--- /dev/null
--- /dev/null
++[1]
--- /dev/null
--- /dev/null
++[2147483647]
--- /dev/null
--- /dev/null
++[4294967295]
--- /dev/null
--- /dev/null
++[1234567890123456789]
--- /dev/null
--- /dev/null
++[9223372036854775807]
--- /dev/null
--- /dev/null
++[0.0]
--- /dev/null
--- /dev/null
++[-0.0]
--- /dev/null
--- /dev/null
++[1.2345]
--- /dev/null
--- /dev/null
++[-1.2345]
--- /dev/null
--- /dev/null
++[5e-324]
--- /dev/null
--- /dev/null
++[2.225073858507201e-308]
--- /dev/null
--- /dev/null
++[2.2250738585072014e-308]
--- /dev/null
--- /dev/null
++[1.7976931348623157e308]
--- /dev/null
--- /dev/null
++"""
++Internal implementation detail.
++"""
++module Common
++
++using Unicode
++
++include("bytes.jl")
++include("errors.jl")
++
++end
--- /dev/null
--- /dev/null
++VERSION < v"0.7.0-beta2.199" && __precompile__()
++
++module JSON
++
++export json # returns a compact (or indented) JSON representation as a string
++export JSONText # string wrapper to insert raw JSON into JSON output
++
++include("Common.jl")
++
++# Parser modules
++include("Parser.jl")
++
++# Writer modules
++include("Serializations.jl")
++include("Writer.jl")
++
++# stuff to re-"export"
++# note that this package does not actually export anything except `json` but
++# all of the following are part of the public interface in one way or another
++using .Parser: parse, parsefile
++using .Writer: show_json, json, lower, print, StructuralContext, show_element,
++ show_string, show_key, show_pair, show_null, begin_array,
++ end_array, begin_object, end_object, indent, delimit, separate,
++ JSONText
++using .Serializations: Serialization, CommonSerialization,
++ StandardSerialization
++
++# for pretty-printed (non-compact) output, JSONText must be re-parsed:
++Writer.lower(json::JSONText) = parse(json.s)
++
++end # module
--- /dev/null
--- /dev/null
++module Parser # JSON
++
++using Mmap
++using ..Common
++import Parsers
++
++include("pushvector.jl")
++
++"""
++Like `isspace`, but work on bytes and includes only the four whitespace
++characters defined by the JSON standard: space, tab, line feed, and carriage
++return.
++"""
++isjsonspace(b::UInt8) = b == SPACE || b == TAB || b == NEWLINE || b == RETURN
++
++"""
++Like `isdigit`, but for bytes.
++"""
++isjsondigit(b::UInt8) = DIGIT_ZERO ≤ b ≤ DIGIT_NINE
++
++abstract type ParserState end
++
++mutable struct MemoryParserState <: ParserState
++ utf8::String
++ s::Int
++end
++
++# it is convenient to access MemoryParserState like a Vector{UInt8} to avoid copies
++Base.@propagate_inbounds Base.getindex(state::MemoryParserState, i::Int) = codeunit(state.utf8, i)
++Base.length(state::MemoryParserState) = sizeof(state.utf8)
++
++mutable struct StreamingParserState{T <: IO} <: ParserState
++ io::T
++ cur::UInt8
++ used::Bool
++ utf8array::PushVector{UInt8, Vector{UInt8}}
++end
++StreamingParserState(io::IO) = StreamingParserState(io, 0x00, true, PushVector{UInt8}())
++
++struct ParserContext{DictType, IntType, AllowNanInf, NullValue} end
++
++"""
++Return the byte at the current position of the `ParserState`. If there is no
++byte (that is, the `ParserState` is done), then an error is thrown that the
++input ended unexpectedly.
++"""
++@inline function byteat(ps::MemoryParserState)
++ @inbounds if hasmore(ps)
++ return ps[ps.s]
++ else
++ _error(E_UNEXPECTED_EOF, ps)
++ end
++end
++
++@inline function byteat(ps::StreamingParserState)
++ if ps.used
++ ps.used = false
++ if eof(ps.io)
++ _error(E_UNEXPECTED_EOF, ps)
++ else
++ ps.cur = read(ps.io, UInt8)
++ end
++ end
++ ps.cur
++end
++
++"""
++Like `byteat`, but with no special bounds check and error message. Useful when
++a current byte is known to exist.
++"""
++@inline current(ps::MemoryParserState) = ps[ps.s]
++@inline current(ps::StreamingParserState) = byteat(ps)
++
++"""
++Require the current byte of the `ParserState` to be the given byte, and then
++skip past that byte. Otherwise, an error is thrown.
++"""
++@inline function skip!(ps::ParserState, c::UInt8)
++ if byteat(ps) == c
++ incr!(ps)
++ else
++ _error_expected_char(c, ps)
++ end
++end
++@noinline _error_expected_char(c, ps) = _error("Expected '$(Char(c))' here", ps)
++
++function skip!(ps::ParserState, cs::UInt8...)
++ for c in cs
++ skip!(ps, c)
++ end
++end
++
++"""
++Move the `ParserState` to the next byte.
++"""
++@inline incr!(ps::MemoryParserState) = (ps.s += 1)
++@inline incr!(ps::StreamingParserState) = (ps.used = true)
++
++"""
++Move the `ParserState` to the next byte, and return the value at the byte before
++the advancement. If the `ParserState` is already done, then throw an error.
++"""
++@inline advance!(ps::ParserState) = (b = byteat(ps); incr!(ps); b)
++
++"""
++Return `true` if there is a current byte, and `false` if all bytes have been
++exausted.
++"""
++@inline hasmore(ps::MemoryParserState) = ps.s ≤ length(ps)
++@inline hasmore(ps::StreamingParserState) = true # no more now ≠ no more ever
++
++"""
++Remove as many whitespace bytes as possible from the `ParserState` starting from
++the current byte.
++"""
++@inline function chomp_space!(ps::ParserState)
++ @inbounds while hasmore(ps) && isjsonspace(current(ps))
++ incr!(ps)
++ end
++end
++
++
++# Used for line counts
++function _count_before(haystack::AbstractString, needle::Char, _end::Int)
++ count = 0
++ for (i,c) in enumerate(haystack)
++ i >= _end && return count
++ count += c == needle
++ end
++ return count
++end
++
++
++# Throws an error message with an indicator to the source
++@noinline function _error(message::AbstractString, ps::MemoryParserState)
++ orig = ps.utf8
++ lines = _count_before(orig, '\n', ps.s)
++ # Replace all special multi-line/multi-space characters with a space.
++ strnl = replace(orig, r"[\b\f\n\r\t\s]" => " ")
++ li = (ps.s > 20) ? ps.s - 9 : 1 # Left index
++ ri = min(lastindex(orig), ps.s + 20) # Right index
++ error(message *
++ "\nLine: " * string(lines) *
++ "\nAround: ..." * strnl[li:ri] * "..." *
++ "\n " * (" " ^ (ps.s - li)) * "^\n"
++ )
++end
++
++@noinline function _error(message::AbstractString, ps::StreamingParserState)
++ error("$message\n ...when parsing byte with value '$(current(ps))'")
++end
++
++# PARSING
++
++"""
++Given a `ParserState`, after possibly any amount of whitespace, return the next
++parseable value.
++"""
++function parse_value(pc::ParserContext, ps::ParserState)
++ chomp_space!(ps)
++
++ @inbounds byte = byteat(ps)
++ if byte == STRING_DELIM
++ parse_string(ps)
++ elseif isjsondigit(byte) || byte == MINUS_SIGN
++ parse_number(pc, ps)
++ elseif byte == OBJECT_BEGIN
++ parse_object(pc, ps)
++ elseif byte == ARRAY_BEGIN
++ parse_array(pc, ps)
++ else
++ parse_jsconstant(pc, ps)
++ end
++end
++
++function parse_jsconstant(::ParserContext{<:Any,<:Any,AllowNanInf,NullValue},
++ ps::ParserState) where {AllowNanInf,NullValue}
++ c = advance!(ps)
++ if c == LATIN_T # true
++ skip!(ps, LATIN_R, LATIN_U, LATIN_E)
++ true
++ elseif c == LATIN_F # false
++ skip!(ps, LATIN_A, LATIN_L, LATIN_S, LATIN_E)
++ false
++ elseif c == LATIN_N # null
++ skip!(ps, LATIN_U, LATIN_L, LATIN_L)
++ NullValue
++ elseif AllowNanInf && c == LATIN_UPPER_N
++ skip!(ps, LATIN_A, LATIN_UPPER_N)
++ NaN
++ elseif AllowNanInf && c == LATIN_UPPER_I
++ skip!(ps, LATIN_N, LATIN_F, LATIN_I, LATIN_N, LATIN_I, LATIN_T, LATIN_Y)
++ Inf
++ else
++ _error(E_UNEXPECTED_CHAR, ps)
++ end
++end
++
++function parse_array(pc::ParserContext, ps::ParserState)
++ result = Any[]
++ @inbounds incr!(ps) # Skip over opening '['
++ chomp_space!(ps)
++ if byteat(ps) ≠ ARRAY_END # special case for empty array
++ @inbounds while true
++ push!(result, parse_value(pc, ps))
++ chomp_space!(ps)
++ byteat(ps) == ARRAY_END && break
++ skip!(ps, DELIMITER)
++ end
++ end
++
++ @inbounds incr!(ps)
++ result
++end
++
++
++function parse_object(pc::ParserContext{DictType,<:Real,<:Any}, ps::ParserState) where DictType
++ obj = DictType()
++ keyT = keytype(typeof(obj))
++
++ incr!(ps) # Skip over opening '{'
++ chomp_space!(ps)
++ if byteat(ps) ≠ OBJECT_END # special case for empty object
++ @inbounds while true
++ # Read key
++ chomp_space!(ps)
++ byteat(ps) == STRING_DELIM || _error(E_BAD_KEY, ps)
++ key = parse_string(ps)
++ chomp_space!(ps)
++ skip!(ps, SEPARATOR)
++ # Read value
++ value = parse_value(pc, ps)
++ chomp_space!(ps)
++ obj[keyT === Symbol ? Symbol(key) : convert(keyT, key)] = value
++ byteat(ps) == OBJECT_END && break
++ skip!(ps, DELIMITER)
++ end
++ end
++
++ incr!(ps)
++ obj
++end
++
++
++utf16_is_surrogate(c::UInt16) = (c & 0xf800) == 0xd800
++utf16_get_supplementary(lead::UInt16, trail::UInt16) = Char(UInt32(lead-0xd7f7)<<10 + trail)
++
++function read_four_hex_digits!(ps::ParserState)
++ local n::UInt16 = 0
++
++ for _ in 1:4
++ b = advance!(ps)
++ n = n << 4 + if isjsondigit(b)
++ b - DIGIT_ZERO
++ elseif LATIN_A ≤ b ≤ LATIN_F
++ b - (LATIN_A - UInt8(10))
++ elseif LATIN_UPPER_A ≤ b ≤ LATIN_UPPER_F
++ b - (LATIN_UPPER_A - UInt8(10))
++ else
++ _error(E_BAD_ESCAPE, ps)
++ end
++ end
++
++ n
++end
++
++function read_unicode_escape!(ps)
++ u1 = read_four_hex_digits!(ps)
++ if utf16_is_surrogate(u1)
++ skip!(ps, BACKSLASH)
++ skip!(ps, LATIN_U)
++ u2 = read_four_hex_digits!(ps)
++ utf16_get_supplementary(u1, u2)
++ else
++ Char(u1)
++ end
++end
++
++function parse_string(ps::ParserState)
++ b = IOBuffer()
++ incr!(ps) # skip opening quote
++ while true
++ c = advance!(ps)
++
++ if c == BACKSLASH
++ c = advance!(ps)
++ if c == LATIN_U # Unicode escape
++ write(b, read_unicode_escape!(ps))
++ else
++ c = get(ESCAPES, c, 0x00)
++ c == 0x00 && _error(E_BAD_ESCAPE, ps)
++ write(b, c)
++ end
++ continue
++ elseif c < SPACE
++ _error(E_BAD_CONTROL, ps)
++ elseif c == STRING_DELIM
++ return String(take!(b))
++ end
++
++ write(b, c)
++ end
++end
++
++"""
++Return `true` if the given bytes vector, starting at `from` and ending at `to`,
++has a leading zero.
++"""
++function hasleadingzero(bytes, from::Int, to::Int)
++ c = bytes[from]
++ from + 1 < to && c == UInt8('-') &&
++ bytes[from + 1] == DIGIT_ZERO && isjsondigit(bytes[from + 2]) ||
++ from < to && to > from + 1 && c == DIGIT_ZERO &&
++ isjsondigit(bytes[from + 1])
++end
++
++"""
++Parse a float from the given bytes vector, starting at `from` and ending at the
++byte before `to`. Bytes enclosed should all be ASCII characters.
++"""
++float_from_bytes(bytes::PushVector, from::Int, to::Int) = _float_from_bytes(bytes.v, from, to)
++float_from_bytes(bytes::MemoryParserState, from::Int, to::Int) = _float_from_bytes(bytes.utf8, from, to)
++
++function _float_from_bytes(bytes, from::Int, to::Int)::Union{Float64,Nothing}
++ # Would like to use tryparse, but we want it to consume the full input,
++ # and the version in Parsers does not do this.
++
++ # return Parsers.tryparse(Float64, @view bytes.utf8[from:to])
++
++ len = to - from + 1
++ x, code, vpos, vlen, tlen = Parsers.xparse(Float64, bytes, from, to, Parsers.OPTIONS)
++ if !Parsers.ok(code) || vlen < len
++ return nothing
++ end
++ return x::Float64
++end
++
++"""
++Parse an integer from the given bytes vector, starting at `from` and ending at
++the byte before `to`. Bytes enclosed should all be ASCII characters.
++"""
++function int_from_bytes(pc::ParserContext{<:Any,IntType,<:Any},
++ ps::ParserState,
++ bytes,
++ from::Int,
++ to::Int) where IntType <: Real
++ @inbounds isnegative = bytes[from] == MINUS_SIGN ? (from += 1; true) : false
++ num = IntType(0)
++ @inbounds for i in from:to
++ c = bytes[i]
++ dig = c - DIGIT_ZERO
++ if dig < 0x10
++ num = IntType(10) * num + IntType(dig)
++ else
++ _error(E_BAD_NUMBER, ps)
++ end
++ end
++ ifelse(isnegative, -num, num)
++end
++
++function number_from_bytes(pc::ParserContext,
++ ps::ParserState,
++ isint::Bool,
++ bytes,
++ from::Int,
++ to::Int)
++ @inbounds if hasleadingzero(bytes, from, to)
++ _error(E_LEADING_ZERO, ps)
++ end
++
++ if isint
++ @inbounds if to == from && bytes[from] == MINUS_SIGN
++ _error(E_BAD_NUMBER, ps)
++ end
++ int_from_bytes(pc, ps, bytes, from, to)
++ else
++ res = float_from_bytes(bytes, from, to)
++ res === nothing ? _error(E_BAD_NUMBER, ps) : res
++ end
++end
++
++
++function parse_number(pc::ParserContext{<:Any,<:Any,AllowNanInf}, ps::ParserState) where AllowNanInf
++ # Determine the end of the floating point by skipping past ASCII values
++ # 0-9, +, -, e, E, and .
++ number = ps.utf8array
++ isint = true
++ negative = false
++
++ c = current(ps)
++
++ # Parse and keep track of initial minus sign (for parsing -Infinity)
++ if AllowNanInf && c == MINUS_SIGN
++ push!(number, UInt8(c)) # save in case the next character is a number
++ negative = true
++ incr!(ps)
++ end
++
++ @inbounds while hasmore(ps)
++ c = current(ps)
++
++ if isjsondigit(c) || c == MINUS_SIGN
++ push!(number, UInt8(c))
++ elseif c in (PLUS_SIGN, LATIN_E, LATIN_UPPER_E, DECIMAL_POINT)
++ push!(number, UInt8(c))
++ isint = false
++ elseif AllowNanInf && c == LATIN_UPPER_I
++ infinity = parse_jsconstant(pc, ps)
++ resize!(number, 0)
++ return (negative ? -infinity : infinity)
++ else
++ break
++ end
++
++ incr!(ps)
++ end
++
++ v = number_from_bytes(pc, ps, isint, number, 1, length(number))
++ resize!(number, 0)
++ return v
++end
++
++
++unparameterize_type(x) = x # Fallback for nontypes -- functions etc
++function unparameterize_type(T::Type)
++ candidate = typeintersect(T, AbstractDict{String, Any})
++ candidate <: Union{} ? T : candidate
++end
++
++# Workaround for slow dynamic dispatch for creating objects
++const DEFAULT_PARSERCONTEXT = ParserContext{Dict{String, Any}, Int64, false, nothing}()
++function _get_parsercontext(dicttype, inttype, allownan, null)
++ if dicttype == Dict{String, Any} && inttype == Int64 && !allownan
++ DEFAULT_PARSERCONTEXT
++ else
++ ParserContext{unparameterize_type(dicttype), inttype, allownan, null}.instance
++ end
++end
++
++"""
++ parse{T<:Associative}(str::AbstractString;
++ dicttype::Type{T}=Dict,
++ inttype::Type{<:Real}=Int64,
++ allownan::Bool=true,
++ null=nothing)
++
++Parses the given JSON string into corresponding Julia types.
++
++Keyword arguments:
++ • dicttype: Associative type to use when parsing JSON objects (default: Dict{String, Any})
++ • inttype: Real number type to use when parsing JSON numbers that can be parsed
++ as integers (default: Int64)
++ • allownan: allow parsing of NaN, Infinity, and -Infinity (default: true)
++ • null: value to use for parsed JSON `null` values (default: `nothing`)
++"""
++function parse(str::AbstractString;
++ dicttype=Dict{String,Any},
++ inttype::Type{<:Real}=Int64,
++ allownan::Bool=true,
++ null=nothing)
++ pc = _get_parsercontext(dicttype, inttype, allownan, null)
++ ps = MemoryParserState(str, 1)
++ v = parse_value(pc, ps)
++ chomp_space!(ps)
++ if hasmore(ps)
++ _error(E_EXPECTED_EOF, ps)
++ end
++ v
++end
++
++"""
++ parse{T<:Associative}(io::IO;
++ dicttype::Type{T}=Dict,
++ inttype::Type{<:Real}=Int64,
++ allownan=true,
++ null=nothing)
++
++Parses JSON from the given IO stream into corresponding Julia types.
++
++Keyword arguments:
++ • dicttype: Associative type to use when parsing JSON objects (default: Dict{String, Any})
++ • inttype: Real number type to use when parsing JSON numbers that can be parsed
++ as integers (default: Int64)
++ • allownan: allow parsing of NaN, Infinity, and -Infinity (default: true)
++ • null: value to use for parsed JSON `null` values (default: `nothing`)
++"""
++function parse(io::IO;
++ dicttype=Dict{String,Any},
++ inttype::Type{<:Real}=Int64,
++ allownan::Bool=true,
++ null=nothing)
++ pc = _get_parsercontext(dicttype, inttype, allownan, null)
++ ps = StreamingParserState(io)
++ parse_value(pc, ps)
++end
++
++"""
++ parsefile(filename::AbstractString;
++ dicttype=Dict{String, Any},
++ inttype::Type{<:Real}=Int64,
++ allownan::Bool=true,
++ null=nothing,
++ use_mmap::Bool=true)
++
++Convenience function to parse JSON from the given file into corresponding Julia types.
++
++Keyword arguments:
++ • dicttype: Associative type to use when parsing JSON objects (default: Dict{String, Any})
++ • inttype: Real number type to use when parsing JSON numbers that can be parsed
++ as integers (default: Int64)
++ • allownan: allow parsing of NaN, Infinity, and -Infinity (default: true)
++ • null: value to use for parsed JSON `null` values (default: `nothing`)
++ • use_mmap: use mmap when opening the file (default: true)
++"""
++function parsefile(filename::AbstractString;
++ dicttype=Dict{String, Any},
++ inttype::Type{<:Real}=Int64,
++ null=nothing,
++ allownan::Bool=true,
++ use_mmap::Bool=true)
++ sz = filesize(filename)
++ open(filename) do io
++ s = use_mmap ? String(Mmap.mmap(io, Vector{UInt8}, sz)) : read(io, String)
++ parse(s; dicttype=dicttype, inttype=inttype, allownan=allownan, null=null)
++ end
++end
++
++# Efficient implementations of some of the above for in-memory parsing
++include("specialized.jl")
++
++end # module Parser
--- /dev/null
--- /dev/null
++"""
++JSON writer serialization contexts.
++
++This module defines the `Serialization` abstract type and several concrete
++implementations, as they relate to JSON.
++"""
++module Serializations
++
++using ..Common
++
++"""
++A `Serialization` defines how objects are lowered to JSON format.
++"""
++abstract type Serialization end
++
++"""
++The `CommonSerialization` comes with a default set of rules for serializing
++Julia types to their JSON equivalents. Additional rules are provided either by
++packages explicitly defining `JSON.show_json` for this serialization, or by the
++`JSON.lower` method. Most concrete implementations of serializers should subtype
++`CommonSerialization`, unless it is desirable to bypass the `lower` system, in
++which case `Serialization` should be subtyped.
++"""
++abstract type CommonSerialization <: Serialization end
++
++"""
++The `StandardSerialization` defines a common, standard JSON serialization format
++that is optimized to:
++
++- strictly follow the JSON standard
++- be useful in the greatest number of situations
++
++All serializations defined for `CommonSerialization` are inherited by
++`StandardSerialization`. It is therefore generally advised to add new
++serialization behaviour to `CommonSerialization`.
++"""
++struct StandardSerialization <: CommonSerialization end
++
++end
--- /dev/null
--- /dev/null
++module Writer
++
++using Dates
++using ..Common
++using ..Serializations: Serialization, StandardSerialization,
++ CommonSerialization
++
++using Unicode
++
++
++"""
++Internal JSON.jl implementation detail; do not depend on this type.
++
++A JSON primitive that wraps around any composite type to enable `Dict`-like
++serialization.
++"""
++struct CompositeTypeWrapper{T}
++ wrapped::T
++ fns::Vector{Symbol}
++end
++
++CompositeTypeWrapper(x, syms) = CompositeTypeWrapper(x, collect(syms))
++CompositeTypeWrapper(x) = CompositeTypeWrapper(x, fieldnames(typeof(x)))
++
++"""
++ lower(x)
++
++Return a value of a JSON-encodable primitive type that `x` should be lowered
++into before encoding as JSON. Supported types are: `AbstractDict` to JSON
++objects, `Tuple` and `AbstractVector` to JSON arrays, `AbstractArray` to nested
++JSON arrays, `AbstractString`, `Symbol`, `Enum`, or `Char` to JSON string,
++`Integer` and `AbstractFloat` to JSON number, `Bool` to JSON boolean, and
++`Nothing` to JSON null, or any other types with a `show_json` method defined.
++
++Extensions of this method should preserve the property that the return value is
++one of the aforementioned types. If first lowering to some intermediate type is
++required, then extensions should call `lower` before returning a value.
++
++Note that the return value need not be *recursively* lowered—this function may
++for instance return an `AbstractArray{Any, 1}` whose elements are not JSON
++primitives.
++"""
++function lower(a)
++ if nfields(a) > 0
++ CompositeTypeWrapper(a)
++ else
++ error("Cannot serialize type $(typeof(a))")
++ end
++end
++
++# To avoid allocating an intermediate string, we directly define `show_json`
++# for this type instead of lowering it to a string first (which would
++# allocate). However, the `show_json` method does call `lower` so as to allow
++# users to change the lowering of their `Enum` or even `AbstractString`
++# subtypes if necessary.
++const IsPrintedAsString = Union{
++ Dates.TimeType, Char, Type, AbstractString, Enum, Symbol}
++lower(x::IsPrintedAsString) = x
++
++lower(m::Module) = throw(ArgumentError("cannot serialize Module $m as JSON"))
++lower(x::Real) = convert(Float64, x)
++lower(x::Base.AbstractSet) = collect(x)
++
++"""
++Abstract supertype of all JSON and JSON-like structural writer contexts.
++"""
++abstract type StructuralContext <: IO end
++
++"""
++Internal implementation detail.
++
++A JSON structural context around an `IO` object. Structural writer contexts
++define the behaviour of serializing JSON structural objects, such as objects,
++arrays, and strings to JSON. The translation of Julia types to JSON structural
++objects is not handled by a `JSONContext`, but by a `Serialization` wrapper
++around it. Abstract supertype of `PrettyContext` and `CompactContext`. Data can
++be written to a JSON context in the usual way, but often higher-level operations
++such as `begin_array` or `begin_object` are preferred to directly writing bytes
++to the stream.
++"""
++abstract type JSONContext <: StructuralContext end
++
++"""
++Internal implementation detail.
++
++Keeps track of the current location in the array or object, which winds and
++unwinds during serialization.
++"""
++mutable struct PrettyContext{T<:IO} <: JSONContext
++ io::T
++ step::Int # number of spaces to step
++ state::Int # number of steps at present
++ first::Bool # whether an object/array was just started
++end
++PrettyContext(io::IO, step) = PrettyContext(io, step, 0, false)
++
++"""
++Internal implementation detail.
++
++For compact printing, which in JSON is fully recursive.
++"""
++mutable struct CompactContext{T<:IO} <: JSONContext
++ io::T
++ first::Bool
++end
++CompactContext(io::IO) = CompactContext(io, false)
++
++"""
++Internal implementation detail.
++
++Implements an IO context safe for printing into JSON strings.
++"""
++struct StringContext{T<:IO} <: IO
++ io::T
++end
++
++# These aliases make defining additional methods on `show_json` easier.
++const CS = CommonSerialization
++const SC = StructuralContext
++
++# Low-level direct access
++Base.write(io::JSONContext, byte::UInt8) = write(io.io, byte)
++Base.write(io::StringContext, byte::UInt8) =
++ write(io.io, ESCAPED_ARRAY[byte + 1])
++#= turn on if there's a performance benefit
++write(io::StringContext, char::Char) =
++ char <= '\x7f' ? write(io, ESCAPED_ARRAY[UInt8(c) + 1]) :
++ Base.print(io, c)
++=#
++
++"""
++ indent(io::StructuralContext)
++
++If appropriate, write a newline to the given context, then indent it by the
++appropriate number of spaces. Otherwise, do nothing.
++"""
++@inline function indent(io::PrettyContext)
++ write(io, NEWLINE)
++ for _ in 1:io.state
++ write(io, SPACE)
++ end
++end
++@inline indent(io::CompactContext) = nothing
++
++"""
++ separate(io::StructuralContext)
++
++Write a colon, followed by a space if appropriate, to the given context.
++"""
++@inline separate(io::PrettyContext) = write(io, SEPARATOR, SPACE)
++@inline separate(io::CompactContext) = write(io, SEPARATOR)
++
++"""
++ delimit(io::StructuralContext)
++
++If this is not the first item written in a collection, write a comma in the
++structural context. Otherwise, do not write a comma, but set a flag that the
++first element has been written already.
++"""
++@inline function delimit(io::JSONContext)
++ if !io.first
++ write(io, DELIMITER)
++ end
++ io.first = false
++end
++
++for kind in ("object", "array")
++ beginfn = Symbol("begin_", kind)
++ beginsym = Symbol(uppercase(kind), "_BEGIN")
++ endfn = Symbol("end_", kind)
++ endsym = Symbol(uppercase(kind), "_END")
++ # Begin and end objects
++ @eval function $beginfn(io::PrettyContext)
++ write(io, $beginsym)
++ io.state += io.step
++ io.first = true
++ end
++ @eval $beginfn(io::CompactContext) = (write(io, $beginsym); io.first = true)
++ @eval function $endfn(io::PrettyContext)
++ io.state -= io.step
++ if !io.first
++ indent(io)
++ end
++ write(io, $endsym)
++ io.first = false
++ end
++ @eval $endfn(io::CompactContext) = (write(io, $endsym); io.first = false)
++end
++
++"""
++ show_string(io::IO, str)
++
++Print `str` as a JSON string (that is, properly escaped and wrapped by double
++quotes) to the given IO object `io`.
++"""
++function show_string(io::IO, x)
++ write(io, STRING_DELIM)
++ Base.print(StringContext(io), x)
++ write(io, STRING_DELIM)
++end
++
++"""
++ show_null(io::IO)
++
++Print the string `null` to the given IO object `io`.
++"""
++show_null(io::IO) = Base.print(io, "null")
++
++"""
++ show_element(io::StructuralContext, s, x)
++
++Print object `x` as an element of a JSON array to context `io` using rules
++defined by serialization `s`.
++"""
++function show_element(io::JSONContext, s, x)
++ delimit(io)
++ indent(io)
++ show_json(io, s, x)
++end
++
++"""
++ show_key(io::StructuralContext, k)
++
++Print string `k` as the key of a JSON key-value pair to context `io`.
++"""
++function show_key(io::JSONContext, k)
++ delimit(io)
++ indent(io)
++ show_string(io, k)
++ separate(io)
++end
++
++"""
++ show_pair(io::StructuralContext, s, k, v)
++
++Print the key-value pair defined by `k => v` as JSON to context `io`, using
++rules defined by serialization `s`.
++"""
++function show_pair(io::JSONContext, s, k, v)
++ show_key(io, k)
++ show_json(io, s, v)
++end
++show_pair(io::JSONContext, s, kv) = show_pair(io, s, first(kv), last(kv))
++
++# Default serialization rules for CommonSerialization (CS)
++function show_json(io::SC, s::CS, x::IsPrintedAsString)
++ # We need this check to allow `lower(x::Enum)` overrides to work if needed;
++ # it should be optimized out if `lower` is a no-op
++ lx = lower(x)
++ if x === lx
++ show_string(io, x)
++ else
++ show_json(io, s, lx)
++ end
++end
++
++function show_json(io::SC, s::CS, x::Union{Integer, AbstractFloat})
++ if isfinite(x)
++ Base.print(io, x)
++ else
++ show_null(io)
++ end
++end
++
++show_json(io::SC, ::CS, ::Nothing) = show_null(io)
++show_json(io::SC, ::CS, ::Missing) = show_null(io)
++
++function show_json(io::SC, s::CS, a::AbstractDict)
++ begin_object(io)
++ for kv in a
++ show_pair(io, s, kv)
++ end
++ end_object(io)
++end
++
++function show_json(io::SC, s::CS, kv::Pair)
++ begin_object(io)
++ show_pair(io, s, kv)
++ end_object(io)
++end
++
++function show_json(io::SC, s::CS, x::CompositeTypeWrapper)
++ begin_object(io)
++ for fn in x.fns
++ show_pair(io, s, fn, getfield(x.wrapped, fn))
++ end
++ end_object(io)
++end
++
++function show_json(io::SC, s::CS, x::Union{AbstractVector, Tuple})
++ begin_array(io)
++ for elt in x
++ show_element(io, s, elt)
++ end
++ end_array(io)
++end
++
++"""
++Serialize a multidimensional array to JSON in column-major format. That is,
++`json([1 2 3; 4 5 6]) == "[[1,4],[2,5],[3,6]]"`.
++"""
++function show_json(io::SC, s::CS, A::AbstractArray{<:Any,n}) where n
++ begin_array(io)
++ newdims = ntuple(_ -> :, n - 1)
++ for j in axes(A, n)
++ show_element(io, s, view(A, newdims..., j))
++ end
++ end_array(io)
++end
++
++# special case for 0-dimensional arrays
++show_json(io::SC, s::CS, A::AbstractArray{<:Any,0}) = show_json(io, s, A[])
++
++show_json(io::SC, s::CS, a) = show_json(io, s, lower(a))
++
++# Fallback show_json for non-SC types
++"""
++Serialize Julia object `obj` to IO `io` using the behaviour described by `s`. If
++`indent` is provided, then the JSON will be pretty-printed; otherwise it will be
++printed on one line. If pretty-printing is enabled, then a trailing newline will
++be printed; otherwise there will be no trailing newline.
++"""
++function show_json(io::IO, s::Serialization, obj; indent=nothing)
++ ctx = indent === nothing ? CompactContext(io) : PrettyContext(io, indent)
++ show_json(ctx, s, obj)
++ if indent !== nothing
++ println(io)
++ end
++end
++
++"""
++ JSONText(s::AbstractString)
++
++`JSONText` is a wrapper around a Julia string representing JSON-formatted
++text, which is inserted *as-is* in the JSON output of `JSON.print` and `JSON.json`
++for compact output, and is otherwise re-parsed for pretty-printed output.
++
++`s` *must* contain valid JSON text. Otherwise compact output will contain
++the malformed `s` and other serialization output will throw a parsing exception.
++"""
++struct JSONText
++ s::String
++end
++show_json(io::CompactContext, s::CS, json::JSONText) = write(io, json.s)
++# other contexts for JSONText are handled by lower(json) = parse(json.s)
++
++print(io::IO, obj, indent) =
++ show_json(io, StandardSerialization(), obj; indent=indent)
++print(io::IO, obj) = show_json(io, StandardSerialization(), obj)
++
++print(a, indent) = print(stdout, a, indent)
++print(a) = print(stdout, a)
++
++"""
++ json(a)
++ json(a, indent::Int)
++
++Creates a JSON string from a Julia object or value.
++
++Arguments:
++ • a: the Julia object or value to encode
++ • indent (optional number): if provided, pretty-print array and object
++ substructures by indenting with the provided number of spaces
++"""
++json(a) = sprint(print, a)
++json(a, indent) = sprint(print, a, indent)
++
++end
--- /dev/null
--- /dev/null
++# The following bytes have significant meaning in JSON
++const BACKSPACE = UInt8('\b')
++const TAB = UInt8('\t')
++const NEWLINE = UInt8('\n')
++const FORM_FEED = UInt8('\f')
++const RETURN = UInt8('\r')
++const SPACE = UInt8(' ')
++const STRING_DELIM = UInt8('"')
++const PLUS_SIGN = UInt8('+')
++const DELIMITER = UInt8(',')
++const MINUS_SIGN = UInt8('-')
++const DECIMAL_POINT = UInt8('.')
++const SOLIDUS = UInt8('/')
++const DIGIT_ZERO = UInt8('0')
++const DIGIT_NINE = UInt8('9')
++const SEPARATOR = UInt8(':')
++const LATIN_UPPER_A = UInt8('A')
++const LATIN_UPPER_E = UInt8('E')
++const LATIN_UPPER_F = UInt8('F')
++const LATIN_UPPER_I = UInt8('I')
++const LATIN_UPPER_N = UInt8('N')
++const ARRAY_BEGIN = UInt8('[')
++const BACKSLASH = UInt8('\\')
++const ARRAY_END = UInt8(']')
++const LATIN_A = UInt8('a')
++const LATIN_B = UInt8('b')
++const LATIN_E = UInt8('e')
++const LATIN_F = UInt8('f')
++const LATIN_I = UInt8('i')
++const LATIN_L = UInt8('l')
++const LATIN_N = UInt8('n')
++const LATIN_R = UInt8('r')
++const LATIN_S = UInt8('s')
++const LATIN_T = UInt8('t')
++const LATIN_U = UInt8('u')
++const LATIN_Y = UInt8('y')
++const OBJECT_BEGIN = UInt8('{')
++const OBJECT_END = UInt8('}')
++
++const ESCAPES = Dict(
++ STRING_DELIM => STRING_DELIM,
++ BACKSLASH => BACKSLASH,
++ SOLIDUS => SOLIDUS,
++ LATIN_B => BACKSPACE,
++ LATIN_F => FORM_FEED,
++ LATIN_N => NEWLINE,
++ LATIN_R => RETURN,
++ LATIN_T => TAB)
++
++const REVERSE_ESCAPES = Dict(reverse(p) for p in ESCAPES)
++const ESCAPED_ARRAY = Vector{Vector{UInt8}}(undef, 256)
++for c in 0x00:0xFF
++ ESCAPED_ARRAY[c + 1] = if c == SOLIDUS
++ [SOLIDUS] # don't escape this one
++ elseif c ≥ 0x80
++ [c] # UTF-8 character copied verbatim
++ elseif haskey(REVERSE_ESCAPES, c)
++ [BACKSLASH, REVERSE_ESCAPES[c]]
++ elseif iscntrl(Char(c)) || !isprint(Char(c))
++ UInt8[BACKSLASH, LATIN_U, string(c, base=16, pad=4)...]
++ else
++ [c]
++ end
++end
++
++export BACKSPACE, TAB, NEWLINE, FORM_FEED, RETURN, SPACE, STRING_DELIM,
++ PLUS_SIGN, DELIMITER, MINUS_SIGN, DECIMAL_POINT, SOLIDUS, DIGIT_ZERO,
++ DIGIT_NINE, SEPARATOR, LATIN_UPPER_A, LATIN_UPPER_E, LATIN_UPPER_F,
++ LATIN_UPPER_I, LATIN_UPPER_N, ARRAY_BEGIN, BACKSLASH, ARRAY_END,
++ LATIN_A, LATIN_B, LATIN_E, LATIN_F, LATIN_I, LATIN_L, LATIN_N, LATIN_R,
++ LATIN_S, LATIN_T, LATIN_U, LATIN_Y, OBJECT_BEGIN, OBJECT_END, ESCAPES,
++ REVERSE_ESCAPES, ESCAPED_ARRAY
--- /dev/null
--- /dev/null
++# The following errors may be thrown by the parser
++const E_EXPECTED_EOF = "Expected end of input"
++const E_UNEXPECTED_EOF = "Unexpected end of input"
++const E_UNEXPECTED_CHAR = "Unexpected character"
++const E_BAD_KEY = "Invalid object key"
++const E_BAD_ESCAPE = "Invalid escape sequence"
++const E_BAD_CONTROL = "ASCII control character in string"
++const E_LEADING_ZERO = "Invalid leading zero in number"
++const E_BAD_NUMBER = "Invalid number"
++
++export E_EXPECTED_EOF, E_UNEXPECTED_EOF, E_UNEXPECTED_CHAR, E_BAD_KEY,
++ E_BAD_ESCAPE, E_BAD_CONTROL, E_LEADING_ZERO, E_BAD_NUMBER
--- /dev/null
--- /dev/null
++# This is a vector wrapper that we use as a workaround for `push!`
++# being slow (it always calls into the runtime even if the underlying buffer,
++# has enough space). Here we keep track of the length using an extra field
++mutable struct PushVector{T, A<:AbstractVector{T}} <: AbstractVector{T}
++ v::A
++ l::Int
++end
++
++# Default length of 20 should be enough to never need to grow in most cases
++PushVector{T}() where {T} = PushVector(Vector{T}(undef, 20), 0)
++
++Base.length(v::PushVector) = v.l
++Base.size(v::PushVector) = (v.l,)
++@inline function Base.getindex(v::PushVector, i)
++ @boundscheck checkbounds(v, i)
++ @inbounds v.v[i]
++end
++
++function Base.push!(v::PushVector, i)
++ v.l += 1
++ if v.l > length(v.v)
++ resize!(v.v, v.l * 2)
++ end
++ v.v[v.l] = i
++ return v
++end
++
++function Base.resize!(v::PushVector, l::Integer)
++ # Only support shrinking for now, since that is all we need
++ @assert l <= v.l
++ v.l = l
++end
--- /dev/null
--- /dev/null
++function maxsize_buffer(maxsize::Int)
++ IOBuffer(maxsize=maxsize)
++end
++
++# Specialized functions for increased performance when JSON is in-memory
++function parse_string(ps::MemoryParserState)
++ # "Dry Run": find length of string so we can allocate the right amount of
++ # memory from the start. Does not do full error checking.
++ fastpath, len = predict_string(ps)
++
++ # Now read the string itself:
++
++ # Fast path occurs when the string has no escaped characters. This is quite
++ # often the case in real-world data, especially when keys are short strings.
++ # We can just copy the data from the buffer in this case.
++ if fastpath
++ s = ps.s
++ ps.s = s + len + 2 # byte after closing quote
++ return unsafe_string(pointer(ps.utf8)+s, len)
++ else
++ String(take!(parse_string(ps, maxsize_buffer(len))))
++ end
++end
++
++"""
++Scan through a string at the current parser state and return a tuple containing
++information about the string. This function avoids memory allocation where
++possible.
++
++The first element of the returned tuple is a boolean indicating whether the
++string may be copied directly from the parser state. Special casing string
++parsing when there are no escaped characters leads to substantially increased
++performance in common situations.
++
++The second element of the returned tuple is an integer representing the exact
++length of the string, in bytes when encoded as UTF-8. This information is useful
++for pre-sizing a buffer to contain the parsed string.
++
++This function will throw an error if:
++
++ - invalid control characters are found
++ - an invalid unicode escape is read
++ - the string is not terminated
++
++No error is thrown when other invalid backslash escapes are encountered.
++"""
++function predict_string(ps::MemoryParserState)
++ e = length(ps)
++ fastpath = true # true if no escapes in this string, so it can be copied
++ len = 0 # the number of UTF8 bytes the string contains
++
++ s = ps.s + 1 # skip past opening string character "
++ @inbounds while s <= e
++ c = ps[s]
++ if c == BACKSLASH
++ fastpath = false
++ (s += 1) > e && break
++ if ps[s] == LATIN_U # Unicode escape
++ t = ps.s
++ ps.s = s + 1
++ len += write(devnull, read_unicode_escape!(ps))
++ s = ps.s
++ ps.s = t
++ continue
++ end
++ elseif c == STRING_DELIM
++ return fastpath, len
++ elseif c < SPACE
++ ps.s = s
++ _error(E_BAD_CONTROL, ps)
++ end
++ len += 1
++ s += 1
++ end
++
++ ps.s = s
++ _error(E_UNEXPECTED_EOF, ps)
++end
++
++"""
++Parse the string starting at the parser state’s current location into the given
++pre-sized IOBuffer. The only correctness checking is for escape sequences, so the
++passed-in buffer must exactly represent the amount of space needed for parsing.
++"""
++function parse_string(ps::MemoryParserState, b::IOBuffer)
++ s = ps.s
++ e = length(ps)
++
++ s += 1 # skip past opening string character "
++ len = b.maxsize
++ @inbounds while b.size < len
++ c = ps[s]
++ if c == BACKSLASH
++ s += 1
++ s > e && break
++ c = ps[s]
++ if c == LATIN_U # Unicode escape
++ ps.s = s + 1
++ write(b, read_unicode_escape!(ps))
++ s = ps.s
++ continue
++ else
++ c = get(ESCAPES, c, 0x00)
++ if c == 0x00
++ ps.s = s
++ _error(E_BAD_ESCAPE, ps)
++ end
++ end
++ end
++
++ # UTF8-encoded non-ascii characters will be copied verbatim, which is
++ # the desired behaviour
++ write(b, c)
++ s += 1
++ end
++
++ # don't worry about non-termination or other edge cases; those should have
++ # been caught in the dry run.
++ ps.s = s + 1
++ b
++end
++
++function parse_number(pc::ParserContext{<:Any,<:Any,AllowNanInf}, ps::MemoryParserState) where AllowNanInf
++ s = p = ps.s
++ e = length(ps)
++ isint = true
++ negative = false
++
++ @inbounds c = ps[p]
++
++ # Parse and keep track of initial minus sign (for parsing -Infinity)
++ if AllowNanInf && c == MINUS_SIGN
++ negative = true
++ p += 1
++ end
++
++ # Determine the end of the floating point by skipping past ASCII values
++ # 0-9, +, -, e, E, and .
++ while p ≤ e
++ @inbounds c = ps[p]
++ if isjsondigit(c) || MINUS_SIGN == c # no-op
++ elseif PLUS_SIGN == c || LATIN_E == c || LATIN_UPPER_E == c ||
++ DECIMAL_POINT == c
++ isint = false
++ elseif AllowNanInf && LATIN_UPPER_I == c
++ ps.s = p
++ infinity = parse_jsconstant(pc, ps)
++ return (negative ? -infinity : infinity)
++ else
++ break
++ end
++ p += 1
++ end
++ ps.s = p
++
++ number_from_bytes(pc, ps, isint, ps, s, p - 1)
++end
--- /dev/null
--- /dev/null
++DataStructures
++FixedPointNumbers
++OffsetArrays
--- /dev/null
--- /dev/null
++finished_async_tests = RemoteChannel()
++
++using Sockets
++
++@async begin
++ s = listen(7777)
++ s = accept(s)
++
++ Base.start_reading(s)
++
++ @test JSON.parse(s) != nothing # a
++ @test JSON.parse(s) != nothing # b
++ validate_c(s) # c
++ @test JSON.parse(s) != nothing # d
++ validate_svg_tviewer_menu(s) # svg_tviewer_menu
++ @test JSON.parse(s) != nothing # gmaps
++ @test JSON.parse(s) != nothing # colors1
++ @test JSON.parse(s) != nothing # colors2
++ @test JSON.parse(s) != nothing # colors3
++ @test JSON.parse(s) != nothing # twitter
++ @test JSON.parse(s) != nothing # facebook
++ validate_flickr(s) # flickr
++ @test JSON.parse(s) != nothing # youtube
++ @test JSON.parse(s) != nothing # iphone
++ @test JSON.parse(s) != nothing # customer
++ @test JSON.parse(s) != nothing # product
++ @test JSON.parse(s) != nothing # interop
++ validate_unicode(s) # unicode
++ @test JSON.parse(s) != nothing # issue5
++ @test JSON.parse(s) != nothing # dollars
++ @test JSON.parse(s) != nothing # brackets
++
++ put!(finished_async_tests, nothing)
++end
++
++w = connect("localhost", 7777)
++
++@test JSON.parse(a) != nothing
++write(w, a)
++
++@test JSON.parse(b) != nothing
++write(w, b)
++
++validate_c(c)
++write(w, c)
++
++@test JSON.parse(d) != nothing
++write(w, d)
++
++validate_svg_tviewer_menu(svg_tviewer_menu)
++write(w, svg_tviewer_menu)
++
++@test JSON.parse(gmaps) != nothing
++write(w, gmaps)
++
++@test JSON.parse(colors1) != nothing
++write(w, colors1)
++
++@test JSON.parse(colors2) != nothing
++write(w, colors2)
++
++@test JSON.parse(colors3) != nothing
++write(w, colors3)
++
++@test JSON.parse(twitter) != nothing
++write(w, twitter)
++
++@test JSON.parse(facebook) != nothing
++write(w, facebook)
++
++validate_flickr(flickr)
++write(w, flickr)
++
++@test JSON.parse(youtube) != nothing
++write(w, youtube)
++
++@test JSON.parse(iphone) != nothing
++write(w, iphone)
++
++@test JSON.parse(customer) != nothing
++write(w, customer)
++
++@test JSON.parse(product) != nothing
++write(w, product)
++
++@test JSON.parse(interop) != nothing
++write(w, interop)
++
++validate_unicode(unicode)
++write(w, unicode)
++
++# issue #5
++issue5 = "[\"A\",\"B\",\"C\\n\"]"
++JSON.parse(issue5)
++write(w, issue5)
++
++# $ escaping issue
++dollars = ["all of the \$s", "µniçø∂\$"]
++json_dollars = json(dollars)
++@test JSON.parse(json_dollars) != nothing
++write(w, json_dollars)
++
++# unmatched brackets
++brackets = Dict("foo"=>"ba}r", "be}e]p"=>"boo{p")
++json_brackets = json(brackets)
++@test JSON.parse(json_brackets) != nothing
++write(w, json_dollars)
++
++fetch(finished_async_tests)
--- /dev/null
--- /dev/null
++@enum Animal zebra aardvark horse
++@test json(zebra) == "\"zebra\""
++@test json([aardvark, horse, Dict("z" => zebra)]) ==
++ "[\"aardvark\",\"horse\",{\"z\":\"zebra\"}]"
--- /dev/null
--- /dev/null
++# check indented json has same final value as non indented
++fb = JSON.parse(facebook)
++fbjson1 = json(fb, 2)
++fbjson2 = json(fb)
++@test JSON.parse(fbjson1) == JSON.parse(fbjson2)
++
++ev = JSON.parse(svg_tviewer_menu)
++ejson1 = json(ev, 2)
++ejson2 = json(ev)
++@test JSON.parse(ejson1) == JSON.parse(ejson2)
--- /dev/null
--- /dev/null
++# Run modified JSON checker tests
++
++const JSON_DATA_DIR = joinpath(dirname(@__DIR__), "data")
++
++for i in 1:38
++ file = "fail$(lpad(string(i), 2, "0")).json"
++ filepath = joinpath(JSON_DATA_DIR, "jsonchecker", file)
++
++ @test_throws ErrorException JSON.parsefile(filepath)
++end
++
++for i in 1:3
++ # Test that the files parse successfully and match streaming parser
++ tf = joinpath(JSON_DATA_DIR, "jsonchecker", "pass$(lpad(string(i), 2, "0")).json")
++ @test JSON.parsefile(tf) == open(JSON.parse, tf)
++end
++
++# Run JSON roundtrip tests (check consistency of .json)
++
++roundtrip(data) = JSON.json(JSON.Parser.parse(data))
++
++for i in 1:27
++ file = "roundtrip$(lpad(string(i), 2, "0")).json"
++ filepath = joinpath(JSON_DATA_DIR, "roundtrip", file)
++
++ rt = roundtrip(read(filepath, String))
++ @test rt == roundtrip(rt)
++end
--- /dev/null
--- /dev/null
++#Examples from http://json.org/example.html
++a="{\"menu\": {
++ \"id\": \"file\",
++ \"value\": \"File\",
++ \"popup\": {
++ \"menuitem\": [
++ {\"value\": \"New\", \"onclick\": \"CreateNewDoc()\"},
++ {\"value\": \"Open\", \"onclick\": \"OpenDoc()\"},
++ {\"value\": \"Close\", \"onclick\": \"CloseDoc()\"}
++ ]
++ }
++ }}
++ "
++
++
++b="{
++ \"glossary\": {
++ \"title\": \"example glossary\",
++ \"GlossDiv\": {
++ \"title\": \"S\",
++ \"GlossList\": {
++ \"GlossEntry\": {
++ \"ID\": \"SGML\",
++ \"SortAs\": \"SGML\",
++ \"GlossTerm\": \"Standard Generalized Markup Language\",
++ \"Acronym\": \"SGML\",
++ \"Abbrev\": \"ISO 8879:1986\",
++ \"GlossDef\": {
++ \"para\": \"A meta-markup language, used to create markup languages such as DocBook.\",
++ \"GlossSeeAlso\": [\"GML\", \"XML\"]
++ },
++ \"GlossSee\": \"markup\"
++ }
++ }
++ }
++ }
++}
++"
++
++const c = """
++{"widget": {
++ "debug": "on",
++ "window": {
++ "title": "Sample Konfabulator Widget",
++ "name": "main_window",
++ "width": 500,
++ "height": 500
++ },
++ "image": {
++ "src": "Images/Sun.png",
++ "name": "sun1",
++ "hOffset": 250,
++ "vOffset": 250,
++ "alignment": "center"
++ },
++ "text": {
++ "data": "Click Here",
++ "size": 36.5,
++ "style": "bold",
++ "name": "text1",
++ "hOffset": 250,
++ "vOffset": 100,
++ "alignment": "center",
++ "onMouseUp": "sun1.opacity = (sun1.opacity / 100) * 90;"
++ }
++}}"""
++function validate_c(c)
++ j = JSON.parse(c)
++ @test j != nothing
++ @test typeof(j["widget"]["image"]["hOffset"]) == Int64
++ @test j["widget"]["image"]["hOffset"] == 250
++ @test typeof(j["widget"]["text"]["size"]) == Float64
++ @test j["widget"]["text"]["size"] == 36.5
++end
++
++d = "{\"web-app\": {
++ \"servlet\": [
++ {
++ \"servlet-name\": \"cofaxCDS\",
++ \"servlet-class\": \"org.cofax.cds.CDSServlet\",
++ \"init-param\": {
++ \"configGlossary:installationAt\": \"Philadelphia, PA\",
++ \"configGlossary:adminEmail\": \"ksm@pobox.com\",
++ \"configGlossary:poweredBy\": \"Cofax\",
++ \"configGlossary:poweredByIcon\": \"/images/cofax.gif\",
++ \"configGlossary:staticPath\": \"/content/static\",
++ \"templateProcessorClass\": \"org.cofax.WysiwygTemplate\",
++ \"templateLoaderClass\": \"org.cofax.FilesTemplateLoader\",
++ \"templatePath\": \"templates\",
++ \"templateOverridePath\": \"\",
++ \"defaultListTemplate\": \"listTemplate.htm\",
++ \"defaultFileTemplate\": \"articleTemplate.htm\",
++ \"useJSP\": false,
++ \"jspListTemplate\": \"listTemplate.jsp\",
++ \"jspFileTemplate\": \"articleTemplate.jsp\",
++ \"cachePackageTagsTrack\": 200,
++ \"cachePackageTagsStore\": 200,
++ \"cachePackageTagsRefresh\": 60,
++ \"cacheTemplatesTrack\": 100,
++ \"cacheTemplatesStore\": 50,
++ \"cacheTemplatesRefresh\": 15,
++ \"cachePagesTrack\": 200,
++ \"cachePagesStore\": 100,
++ \"cachePagesRefresh\": 10,
++ \"cachePagesDirtyRead\": 10,
++ \"searchEngineListTemplate\": \"forSearchEnginesList.htm\",
++ \"searchEngineFileTemplate\": \"forSearchEngines.htm\",
++ \"searchEngineRobotsDb\": \"WEB-INF/robots.db\",
++ \"useDataStore\": true,
++ \"dataStoreClass\": \"org.cofax.SqlDataStore\",
++ \"redirectionClass\": \"org.cofax.SqlRedirection\",
++ \"dataStoreName\": \"cofax\",
++ \"dataStoreDriver\": \"com.microsoft.jdbc.sqlserver.SQLServerDriver\",
++ \"dataStoreUrl\": \"jdbc:microsoft:sqlserver://LOCALHOST:1433;DatabaseName=goon\",
++ \"dataStoreUser\": \"sa\",
++ \"dataStorePassword\": \"dataStoreTestQuery\",
++ \"dataStoreTestQuery\": \"SET NOCOUNT ON;select test='test';\",
++ \"dataStoreLogFile\": \"/usr/local/tomcat/logs/datastore.log\",
++ \"dataStoreInitConns\": 10,
++ \"dataStoreMaxConns\": 100,
++ \"dataStoreConnUsageLimit\": 100,
++ \"dataStoreLogLevel\": \"debug\",
++ \"maxUrlLength\": 500}},
++ {
++ \"servlet-name\": \"cofaxEmail\",
++ \"servlet-class\": \"org.cofax.cds.EmailServlet\",
++ \"init-param\": {
++ \"mailHost\": \"mail1\",
++ \"mailHostOverride\": \"mail2\"}},
++ {
++ \"servlet-name\": \"cofaxAdmin\",
++ \"servlet-class\": \"org.cofax.cds.AdminServlet\"},
++
++ {
++ \"servlet-name\": \"fileServlet\",
++ \"servlet-class\": \"org.cofax.cds.FileServlet\"},
++ {
++ \"servlet-name\": \"cofaxTools\",
++ \"servlet-class\": \"org.cofax.cms.CofaxToolsServlet\",
++ \"init-param\": {
++ \"templatePath\": \"toolstemplates/\",
++ \"log\": 1,
++ \"logLocation\": \"/usr/local/tomcat/logs/CofaxTools.log\",
++ \"logMaxSize\": \"\",
++ \"dataLog\": 1,
++ \"dataLogLocation\": \"/usr/local/tomcat/logs/dataLog.log\",
++ \"dataLogMaxSize\": \"\",
++ \"removePageCache\": \"/content/admin/remove?cache=pages&id=\",
++ \"removeTemplateCache\": \"/content/admin/remove?cache=templates&id=\",
++ \"fileTransferFolder\": \"/usr/local/tomcat/webapps/content/fileTransferFolder\",
++ \"lookInContext\": 1,
++ \"adminGroupID\": 4,
++ \"betaServer\": true}}],
++ \"servlet-mapping\": {
++ \"cofaxCDS\": \"/\",
++ \"cofaxEmail\": \"/cofaxutil/aemail/*\",
++ \"cofaxAdmin\": \"/admin/*\",
++ \"fileServlet\": \"/static/*\",
++ \"cofaxTools\": \"/tools/*\"},
++
++ \"taglib\": {
++ \"taglib-uri\": \"cofax.tld\",
++ \"taglib-location\": \"/WEB-INF/tlds/cofax.tld\"}}}"
++
++const svg_tviewer_menu = """
++{"menu": {
++ "header": "SVG\\tViewer\\u03b1",
++ "items": [
++ {"id": "Open"},
++ {"id": "OpenNew", "label": "Open New"},
++ null,
++ {"id": "ZoomIn", "label": "Zoom In"},
++ {"id": "ZoomOut", "label": "Zoom Out"},
++ {"id": "OriginalView", "label": "Original View"},
++ null,
++ {"id": "Quality"},
++ {"id": "Pause"},
++ {"id": "Mute"},
++ null,
++ {"id": "Find", "label": "Find..."},
++ {"id": "FindAgain", "label": "Find Again"},
++ {"id": "Copy"},
++ {"id": "CopyAgain", "label": "Copy Again"},
++ {"id": "CopySVG", "label": "Copy SVG"},
++ {"id": "ViewSVG", "label": "View SVG"},
++ {"id": "ViewSource", "label": "View Source"},
++ {"id": "SaveAs", "label": "Save As"},
++ null,
++ {"id": "Help"},
++ {"id": "About", "label": "About Adobe SVG Viewer..."}
++ ]
++}}"""
++function validate_svg_tviewer_menu(str)
++ j = JSON.parse(str)
++ @test j != nothing
++ @test typeof(j) == Dict{String, Any}
++ @test length(j) == 1
++ @test typeof(j["menu"]) == Dict{String, Any}
++ @test length(j["menu"]) == 2
++ @test j["menu"]["header"] == "SVG\tViewerα"
++ @test isa(j["menu"]["items"], Vector{Any})
++ @test length(j["menu"]["items"]) == 22
++ @test j["menu"]["items"][3] == nothing
++ @test j["menu"]["items"][2]["id"] == "OpenNew"
++ @test j["menu"]["items"][2]["label"] == "Open New"
++end
++
++
++#Example JSON strings from http://www.jquery4u.com/json/10-example-json-files/
++
++gmaps= "{\"markers\": [
++ {
++ \"point\":\"new GLatLng(40.266044,-74.718479)\",
++ \"homeTeam\":\"Lawrence Library\",
++ \"awayTeam\":\"LUGip\",
++ \"markerImage\":\"images/red.png\",
++ \"information\": \"Linux users group meets second Wednesday of each month.\",
++ \"fixture\":\"Wednesday 7pm\",
++ \"capacity\":\"\",
++ \"previousScore\":\"\"
++ },
++ {
++ \"point\":\"new GLatLng(40.211600,-74.695702)\",
++ \"homeTeam\":\"Hamilton Library\",
++ \"awayTeam\":\"LUGip HW SIG\",
++ \"markerImage\":\"images/white.png\",
++ \"information\": \"Linux users can meet the first Tuesday of the month to work out harward and configuration issues.\",
++ \"fixture\":\"Tuesday 7pm\",
++ \"capacity\":\"\",
++ \"tv\":\"\"
++ },
++ {
++ \"point\":\"new GLatLng(40.294535,-74.682012)\",
++ \"homeTeam\":\"Applebees\",
++ \"awayTeam\":\"After LUPip Mtg Spot\",
++ \"markerImage\":\"images/newcastle.png\",
++ \"information\": \"Some of us go there after the main LUGip meeting, drink brews, and talk.\",
++ \"fixture\":\"Wednesday whenever\",
++ \"capacity\":\"2 to 4 pints\",
++ \"tv\":\"\"
++ }
++] }"
++
++colors1 = "{
++ \"colorsArray\":[{
++ \"colorName\":\"red\",
++ \"hexValue\":\"#f00\"
++ },
++ {
++ \"colorName\":\"green\",
++ \"hexValue\":\"#0f0\"
++ },
++ {
++ \"colorName\":\"blue\",
++ \"hexValue\":\"#00f\"
++ },
++ {
++ \"colorName\":\"cyan\",
++ \"hexValue\":\"#0ff\"
++ },
++ {
++ \"colorName\":\"magenta\",
++ \"hexValue\":\"#f0f\"
++ },
++ {
++ \"colorName\":\"yellow\",
++ \"hexValue\":\"#ff0\"
++ },
++ {
++ \"colorName\":\"black\",
++ \"hexValue\":\"#000\"
++ }
++ ]
++}"
++
++colors2 = "{
++ \"colorsArray\":[{
++ \"red\":\"#f00\",
++ \"green\":\"#0f0\",
++ \"blue\":\"#00f\",
++ \"cyan\":\"#0ff\",
++ \"magenta\":\"#f0f\",
++ \"yellow\":\"#ff0\",
++ \"black\":\"#000\"
++ }
++ ]
++}"
++
++colors3 = "{
++ \"red\":\"#f00\",
++ \"green\":\"#0f0\",
++ \"blue\":\"#00f\",
++ \"cyan\":\"#0ff\",
++ \"magenta\":\"#f0f\",
++ \"yellow\":\"#ff0\",
++ \"black\":\"#000\"
++}"
++
++twitter = "{\"results\":[
++
++ {\"text\":\"@twitterapi http://tinyurl.com/ctrefg\",
++ \"to_user_id\":396524,
++ \"to_user\":\"TwitterAPI\",
++ \"from_user\":\"jkoum\",
++ \"metadata\":
++ {
++ \"result_type\":\"popular\",
++ \"recent_retweets\": 109
++ },
++ \"id\":1478555574,
++ \"from_user_id\":1833773,
++ \"iso_language_code\":\"nl\",
++ \"source\":\"<a href=\\\"http://twitter.com/\\\">twitter</a>\",
++ \"profile_image_url\":\"http://s3.amazonaws.com/twitter_production/profile_images/118412707/2522215727_a5f07da155_b_normal.jpg\",
++ \"created_at\":\"Wed, 08 Apr 2009 19:22:10 +0000\"}],
++ \"since_id\":0,
++ \"max_id\":1480307926,
++ \"refresh_url\":\"?since_id=1480307926&q=%40twitterapi\",
++ \"results_per_page\":15,
++ \"next_page\":\"?page=2&max_id=1480307926&q=%40twitterapi\",
++ \"completed_in\":0.031704,
++ \"page\":1,
++ \"query\":\"%40twitterapi\"}"
++
++facebook= "{
++ \"data\": [
++ {
++ \"id\": \"X999_Y999\",
++ \"from\": {
++ \"name\": \"Tom Brady\", \"id\": \"X12\"
++ },
++ \"message\": \"Looking forward to 2010!\",
++ \"actions\": [
++ {
++ \"name\": \"Comment\",
++ \"link\": \"http://www.facebook.com/X999/posts/Y999\"
++ },
++ {
++ \"name\": \"Like\",
++ \"link\": \"http://www.facebook.com/X999/posts/Y999\"
++ }
++ ],
++ \"type\": \"status\",
++ \"created_time\": \"2010-08-02T21:27:44+0000\",
++ \"updated_time\": \"2010-08-02T21:27:44+0000\"
++ },
++ {
++ \"id\": \"X998_Y998\",
++ \"from\": {
++ \"name\": \"Peyton Manning\", \"id\": \"X18\"
++ },
++ \"message\": \"Where's my contract?\",
++ \"actions\": [
++ {
++ \"name\": \"Comment\",
++ \"link\": \"http://www.facebook.com/X998/posts/Y998\"
++ },
++ {
++ \"name\": \"Like\",
++ \"link\": \"http://www.facebook.com/X998/posts/Y998\"
++ }
++ ],
++ \"type\": \"status\",
++ \"created_time\": \"2010-08-02T21:27:44+0000\",
++ \"updated_time\": \"2010-08-02T21:27:44+0000\"
++ }
++ ]
++}"
++
++const flickr = """{
++ "title": "Talk On Travel Pool",
++ "link": "http://www.flickr.com/groups/talkontravel/pool/",
++ "description": "Travel and vacation photos from around the world.",
++ "modified": "2009-02-02T11:10:27Z",
++ "generator": "http://www.flickr.com/",
++ "totalItems":222,
++ "items": [
++ {
++ "title": "View from the hotel",
++ "link": "http://www.flickr.com/photos/33112458@N08/3081564649/in/pool-998875@N22",
++ "media": {"m":"http://farm4.static.flickr.com/3037/3081564649_4a6569750c_m.jpg"},
++ "date_taken": "2008-12-04T04:43:03-08:00",
++ "description": "<p><a href=\\"http://www.flickr.com/people/33112458@N08/\\"> Talk On Travel</a> has added a photo to the pool:</p> <p><a href=\\"http:// www.flickr.com/photos/33112458@N08/3081564649/\\" title=\\"View from the hotel\\"> <img src=\\"http://farm4.static.flickr.com/3037/3081564649_4a6569750c_m.jpg\\" width=\\"240\\" height=\\"180\\" alt=\\"View from the hotel\\" /></a></p> ",
++ "published": "2008-12-04T12:43:03Z",
++ "author": "nobody@flickr.com (Talk On Travel)",
++ "author_id": "33112458@N08",
++ "tags": "spain dolphins tenerife canaries lagomera aqualand playadelasamericas junglepark losgigantos loscristines talkontravel"
++ }
++ ]
++}"""
++function validate_flickr(str)
++ k = JSON.parse(str)
++ @test k != nothing
++ @test k["totalItems"] == 222
++ @test k["items"][1]["description"][12] == '\"'
++end
++
++youtube = "{\"apiVersion\":\"2.0\",
++ \"data\":{
++ \"updated\":\"2010-01-07T19:58:42.949Z\",
++ \"totalItems\":800,
++ \"startIndex\":1,
++ \"itemsPerPage\":1,
++ \"items\":[
++ {\"id\":\"hYB0mn5zh2c\",
++ \"uploaded\":\"2007-06-05T22:07:03.000Z\",
++ \"updated\":\"2010-01-07T13:26:50.000Z\",
++ \"uploader\":\"GoogleDeveloperDay\",
++ \"category\":\"News\",
++ \"title\":\"Google Developers Day US - Maps API Introduction\",
++ \"description\":\"Google Maps API Introduction ...\",
++ \"tags\":[
++ \"GDD07\",\"GDD07US\",\"Maps\"
++ ],
++ \"thumbnail\":{
++ \"default\":\"http://i.ytimg.com/vi/hYB0mn5zh2c/default.jpg\",
++ \"hqDefault\":\"http://i.ytimg.com/vi/hYB0mn5zh2c/hqdefault.jpg\"
++ },
++ \"player\":{
++ \"default\":\"http://www.youtube.com/watch?v\u003dhYB0mn5zh2c\"
++ },
++ \"content\":{
++ \"1\":\"rtsp://v5.cache3.c.youtube.com/CiILENy.../0/0/0/video.3gp\",
++ \"5\":\"http://www.youtube.com/v/hYB0mn5zh2c?f...\",
++ \"6\":\"rtsp://v1.cache1.c.youtube.com/CiILENy.../0/0/0/video.3gp\"
++ },
++ \"duration\":2840,
++ \"aspectRatio\":\"widescreen\",
++ \"rating\":4.63,
++ \"ratingCount\":68,
++ \"viewCount\":220101,
++ \"favoriteCount\":201,
++ \"commentCount\":22,
++ \"status\":{
++ \"value\":\"restricted\",
++ \"reason\":\"limitedSyndication\"
++ },
++ \"accessControl\":{
++ \"syndicate\":\"allowed\",
++ \"commentVote\":\"allowed\",
++ \"rate\":\"allowed\",
++ \"list\":\"allowed\",
++ \"comment\":\"allowed\",
++ \"embed\":\"allowed\",
++ \"videoRespond\":\"moderated\"
++ }
++ }
++ ]
++ }
++}"
++
++iphone = "{
++ \"menu\": {
++ \"header\": \"xProgress SVG Viewer\",
++ \"items\": [
++ {
++ \"id\": \"Open\"
++ },
++ {
++ \"id\": \"OpenNew\",
++ \"label\": \"Open New\"
++ },
++ null,
++ {
++ \"id\": \"ZoomIn\",
++ \"label\": \"Zoom In\"
++ },
++ {
++ \"id\": \"ZoomOut\",
++ \"label\": \"Zoom Out\"
++ },
++ {
++ \"id\": \"OriginalView\",
++ \"label\": \"Original View\"
++ },
++ null,
++ {
++ \"id\": \"Quality\"
++ },
++ {
++ \"id\": \"Pause\"
++ },
++ {
++ \"id\": \"Mute\"
++ },
++ null,
++ {
++ \"id\": \"Find\",
++ \"label\": \"Find...\"
++ },
++ {
++ \"id\": \"FindAgain\",
++ \"label\": \"Find Again\"
++ },
++ {
++ \"id\": \"Copy\"
++ },
++ {
++ \"id\": \"CopyAgain\",
++ \"label\": \"Copy Again\"
++ },
++ {
++ \"id\": \"CopySVG\",
++ \"label\": \"Copy SVG\"
++ },
++ {
++ \"id\": \"ViewSVG\",
++ \"label\": \"View SVG\"
++ },
++ {
++ \"id\": \"ViewSource\",
++ \"label\": \"View Source\"
++ },
++ {
++ \"id\": \"SaveAs\",
++ \"label\": \"Save As\"
++ },
++ null,
++ {
++ \"id\": \"Help\"
++ },
++ {
++ \"id\": \"About\",
++ \"label\": \"About xProgress CVG Viewer...\"
++ }
++ ]
++ }
++}"
++
++customer = "{
++ \"firstName\": \"John\",
++ \"lastName\": \"Smith\",
++ \"age\": 25,
++ \"address\":
++ {
++ \"streetAddress\": \"21 2nd Street\",
++ \"city\": \"New York\",
++ \"state\": \"NY\",
++ \"postalCode\": \"10021\"
++ },
++ \"phoneNumber\":
++ [
++ {
++ \"type\": \"home\",
++ \"number\": \"212 555-1234\"
++ },
++ {
++ \"type\": \"fax\",
++ \"number\": \"646 555-4567\"
++ }
++ ]
++ }"
++
++ product = "{
++ \"name\":\"Product\",
++ \"properties\":
++ {
++ \"id\":
++ {
++ \"type\":\"number\",
++ \"description\":\"Product identifier\",
++ \"required\":true
++ },
++ \"name\":
++ {
++ \"description\":\"Name of the product\",
++ \"type\":\"string\",
++ \"required\":true
++ },
++ \"price\":
++ {
++ \"type\":\"number\",
++ \"minimum\":0,
++ \"required\":true
++ },
++ \"tags\":
++ {
++ \"type\":\"array\",
++ \"items\":
++ {
++ \"type\":\"string\"
++ }
++ }
++ }
++}"
++
++interop = "{
++ \"ResultSet\": {
++ \"totalResultsAvailable\": \"1827221\",
++ \"totalResultsReturned\": 2,
++ \"firstResultPosition\": 1,
++ \"Result\": [
++ {
++ \"Title\": \"potato jpg\",
++ \"Summary\": \"Kentang Si bungsu dari keluarga Solanum tuberosum L ini ternyata memiliki khasiat untuk mengurangi kerutan jerawat bintik hitam dan kemerahan pada kulit Gunakan seminggu sekali sebagai\",
++ \"Url\": \"http://www.mediaindonesia.com/spaw/uploads/images/potato.jpg\",
++ \"ClickUrl\": \"http://www.mediaindonesia.com/spaw/uploads/images/potato.jpg\",
++ \"RefererUrl\": \"http://www.mediaindonesia.com/mediaperempuan/index.php?ar_id=Nzkw\",
++ \"FileSize\": 22630,
++ \"FileFormat\": \"jpeg\",
++ \"Height\": \"362\",
++ \"Width\": \"532\",
++ \"Thumbnail\": {
++ \"Url\": \"http://thm-a01.yimg.com/nimage/557094559c18f16a\",
++ \"Height\": \"98\",
++ \"Width\": \"145\"
++ }
++ },
++ {
++ \"Title\": \"potato jpg\",
++ \"Summary\": \"Introduction of puneri aloo This is a traditional potato preparation flavoured with curry leaves and peanuts and can be eaten on fasting day Preparation time 10 min\",
++ \"Url\": \"http://www.infovisual.info/01/photo/potato.jpg\",
++ \"ClickUrl\": \"http://www.infovisual.info/01/photo/potato.jpg\",
++ \"RefererUrl\": \"http://sundayfood.com/puneri-aloo-indian-%20recipe\",
++ \"FileSize\": 119398,
++ \"FileFormat\": \"jpeg\",
++ \"Height\": \"685\",
++ \"Width\": \"1024\",
++ \"Thumbnail\": {
++ \"Url\": \"http://thm-a01.yimg.com/nimage/7fa23212efe84b64\",
++ \"Height\": \"107\",
++ \"Width\": \"160\"
++ }
++ }
++ ]
++ }
++}"
++
++const unicode = """
++{"অলিম্পিকস": {
++ "অ্যাথলেট": "২২টি দেশ থেকে ২,০৩৫ জন প্রতিযোগী",
++ "ইভেন্ট": "২২টি ইভেন্টের মধ্যে ছিল দড়ি টানাটানি",
++ "রেকর্ড": [
++ {"১০০মি. স্প্রিন্ট": "রেজি ওয়াকার, দক্ষিণ আফ্রিকা"},
++ {"Marathon": "জনি হেইস"},
++ {" ফ্রি-স্টাইল সাঁতার": "Henry Taylor, Britain"}
++ ]
++}}
++"""
++function validate_unicode(str)
++ u = JSON.parse(str)
++ @test u != nothing
++ @test u["অলিম্পিকস"]["রেকর্ড"][2]["Marathon"] == "জনি হেইস"
++end
--- /dev/null
--- /dev/null
++module TestLowering
++
++using JSON
++using Test
++using Dates
++using FixedPointNumbers: Fixed
++
++@test JSON.json(Date(2016, 8, 3)) == "\"2016-08-03\""
++
++@test JSON.json(:x) == "\"x\""
++@test_throws ArgumentError JSON.json(Base)
++
++struct Type151{T}
++ x::T
++end
++
++@test JSON.parse(JSON.json(Type151)) == string(Type151)
++
++JSON.lower(v::Type151{T}) where {T} = Dict(:type => T, :value => v.x)
++@test JSON.parse(JSON.json(Type151(1.0))) == Dict(
++ "type" => "Float64",
++ "value" => 1.0)
++
++fixednum = Fixed{Int16, 15}(0.1234)
++@test JSON.parse(JSON.json(fixednum)) == convert(Float64, fixednum)
++
++# test that the default string-serialization of enums can be overriden by
++# `lower` if needed
++@enum Fruit apple orange banana
++JSON.lower(x::Fruit) = string("Fruit: ", x)
++@test JSON.json(apple) == "\"Fruit: apple\""
++
++@enum Vegetable carrot tomato potato
++JSON.lower(x::Vegetable) = Dict(string(x) => Int(x))
++@test JSON.json(potato) == "{\"potato\":2}"
++
++end
--- /dev/null
--- /dev/null
++MissingDict() = DataStructures.DefaultDict{String,Any}(Missing)
++
++@testset for T in [
++ DataStructures.OrderedDict,
++ Dict{Symbol, Int32},
++ MissingDict
++]
++ val = JSON.parse("{\"x\": 3}", dicttype=T)
++ @test length(val) == 1
++ key = collect(keys(val))[1]
++ @test string(key) == "x"
++ @test val[key] == 3
++
++ if T == MissingDict
++ @test val isa DataStructures.DefaultDict{String}
++ @test val["y"] === missing
++ else
++ @test val isa T
++ @test_throws KeyError val["y"]
++ end
++end
++
--- /dev/null
--- /dev/null
++@testset for T in [Int32, Int64, Int128, BigInt]
++ val = JSON.parse("{\"x\": 3}", inttype=T)
++ @test isa(val, Dict{String, Any})
++ @test length(val) == 1
++ key = collect(keys(val))[1]
++ @test string(key) == "x"
++ value = val[key]
++ @test value == 3
++ @test typeof(value) == T
++end
++
++@testset begin
++ teststr = """{"201736327611975630": 18005722827070440994}"""
++ val = JSON.parse(teststr, inttype=Int128)
++ @test val == Dict{String,Any}("201736327611975630"=> 18005722827070440994)
++end
--- /dev/null
--- /dev/null
++const FAILURES = [
++ # Unexpected character in array
++ "[1,2,3/4,5,6,7]",
++ # Unexpected character in object
++ "{\"1\":2, \"2\":3 _ \"4\":5}",
++ # Invalid escaped character
++ "[\"alpha\\α\"]",
++ "[\"\\u05AG\"]",
++ # Invalid 'simple' and 'unknown value'
++ "[tXXe]",
++ "[fail]",
++ "∞",
++ # Invalid number
++ "[5,2,-]",
++ "[5,2,+β]",
++ # Incomplete escape
++ "\"\\",
++ # Control character
++ "\"\0\"",
++ # Issue #99
++ "[\"🍕\"_\"🍕\"",
++ # Issue #260
++ "1997-03-03",
++ "1997.1-",
++]
++
++@testset for fail in FAILURES
++ # Test memory parser
++ @test_throws ErrorException JSON.parse(fail)
++
++ # Test streaming parser
++ @test_throws ErrorException JSON.parse(IOBuffer(fail))
++end
--- /dev/null
--- /dev/null
++@testset begin
++ test_str = """
++ {
++ "x": NaN,
++ "y": Infinity,
++ "z": -Infinity,
++ "q": [true, null, "hello", 1, -1, 1.5, -1.5, [true]]
++ }"""
++
++ test_dict = Dict(
++ "x" => NaN,
++ "y" => Inf,
++ "z" => -Inf,
++ "q" => [true, nothing, "hello", 1, -1, 1.5, -1.5, [true]]
++ )
++
++ @test_throws ErrorException JSON.parse(test_str, allownan=false)
++ val = JSON.parse(test_str)
++ @test isequal(val, test_dict)
++
++ @test_throws ErrorException JSON.parse(IOBuffer(test_str), allownan=false)
++ val2 = JSON.parse(IOBuffer(test_str))
++ @test isequal(val2, test_dict)
++
++ # Test that the number following -Infinity parses correctly
++ @test isequal(JSON.parse("[-Infinity, 1]"), [-Inf, 1])
++ @test isequal(JSON.parse("[-Infinity, -1]"), [-Inf, -1])
++ @test isequal(JSON.parse("""{"a": -Infinity, "b": 1.0}"""), Dict("a" => -Inf, "b"=> 1.0))
++ @test isequal(JSON.parse("""{"a": -Infinity, "b": -1.0}"""), Dict("a" => -Inf, "b"=> -1.0))
++
++ @test isequal(JSON.parse(IOBuffer("[-Infinity, 1]")), [-Inf, 1])
++ @test isequal(JSON.parse(IOBuffer("[-Infinity, -1]")), [-Inf, -1])
++ @test isequal(JSON.parse(IOBuffer("""{"a": -Infinity, "b": 1.0}""")), Dict("a" => -Inf, "b"=> 1.0))
++ @test isequal(JSON.parse(IOBuffer("""{"a": -Infinity, "b": -1.0}""")), Dict("a" => -Inf, "b"=> -1.0))
++end
--- /dev/null
--- /dev/null
++@testset "Custom null values" begin
++ s = "{\"x\": null}"
++ for null in (nothing, missing)
++ val = JSON.parse(s, null=null)
++ @test val["x"] === null
++ end
++end
--- /dev/null
--- /dev/null
++tmppath, io = mktemp()
++write(io, facebook)
++close(io)
++if Sys.iswindows()
++ # don't use mmap on Windows, to avoid ERROR: unlink: operation not permitted (EPERM)
++ @test haskey(JSON.parsefile(tmppath; use_mmap=false), "data")
++else
++ @test haskey(JSON.parsefile(tmppath), "data")
++end
++rm(tmppath)
--- /dev/null
--- /dev/null
++test21 = "[\r\n{\r\n\"a\": 1,\r\n\"b\": 2\r\n},\r\n{\r\n\"a\": 3,\r\n\"b\": 4\r\n}\r\n]"
++a = JSON.parse(test21)
++@test isa(a, Vector{Any})
++@test length(a) == 2
--- /dev/null
--- /dev/null
++obj = JSON.parse("{\"a\":2e10}")
++@test obj["a"] == 2e10
--- /dev/null
--- /dev/null
++obj = JSON.parse("{\"\U0001d712\":\"\\ud835\\udf12\"}")
++@test(obj["𝜒"] == "𝜒")
--- /dev/null
--- /dev/null
++mutable struct t109
++ i::Int
++end
++
++let iob = IOBuffer()
++ JSON.print(iob, t109(1))
++ @test get(JSON.parse(String(take!(iob))), "i", 0) == 1
++end
--- /dev/null
--- /dev/null
++@test json([Int64[] Int64[]]) == "[[],[]]"
++@test json([Int64[] Int64[]]') == "[]"
--- /dev/null
--- /dev/null
++@test Float32(JSON.parse(json(2.1f-8))) == 2.1f-8
--- /dev/null
--- /dev/null
++using JSON
++using Test
++using Dates
++using Distributed: RemoteChannel
++using OffsetArrays
++
++import DataStructures
++
++include("json-samples.jl")
++
++@testset "Parser" begin
++ @testset "Parser Failures" begin
++ include("parser/invalid-input.jl")
++ end
++
++ @testset "parsefile" begin
++ include("parser/parsefile.jl")
++ end
++
++ @testset "dicttype" begin
++ include("parser/dicttype.jl")
++ end
++
++ @testset "inttype" begin
++ include("parser/inttype.jl")
++ end
++
++ @testset "nan_inf" begin
++ include("parser/nan-inf.jl")
++ end
++
++ @testset "null" begin
++ include("parser/null.jl")
++ end
++
++ @testset "Miscellaneous" begin
++ # test for single values
++ @test JSON.parse("true") == true
++ @test JSON.parse("null") == nothing
++ @test JSON.parse("\"hello\"") == "hello"
++ @test JSON.parse("\"a\"") == "a"
++ @test JSON.parse("1") == 1
++ @test JSON.parse("1.5") == 1.5
++ @test JSON.parse("[true]") == [true]
++ end
++end
++
++@testset "Serializer" begin
++ @testset "Standard Serializer" begin
++ include("standard-serializer.jl")
++ end
++
++ @testset "Lowering" begin
++ include("lowering.jl")
++ end
++
++ @testset "Custom Serializer" begin
++ include("serializer.jl")
++ end
++end
++
++@testset "Integration" begin
++ # ::Nothing values should be encoded as null
++ testDict = Dict("a" => nothing)
++ nothingJson = JSON.json(testDict)
++ nothingDict = JSON.parse(nothingJson)
++ @test testDict == nothingDict
++
++ @testset "async" begin
++ include("async.jl")
++ end
++
++ @testset "indentation" begin
++ include("indentation.jl")
++ end
++
++ @testset "JSON Checker" begin
++ include("json-checker.jl")
++ end
++end
++
++@testset "Regression" begin
++ @testset "for issue #$i" for i in [21, 26, 57, 109, 152, 163]
++ include("regression/issue$(lpad(string(i), 3, "0")).jl")
++ end
++end
++
++# Check that printing to the default stdout doesn't fail
--- /dev/null
--- /dev/null
++module TestSerializer
++
++using JSON
++using Test
++
++# to define a new serialization behaviour, import these first
++import JSON.Serializations: CommonSerialization, StandardSerialization
++import JSON: StructuralContext
++
++# those names are long so we can define some type aliases
++const CS = CommonSerialization
++const SC = StructuralContext
++
++# for test harness purposes
++function sprint_kwarg(f, args...; kwargs...)
++ b = IOBuffer()
++ f(b, args...; kwargs...)
++ String(take!(b))
++end
++
++# issue #168: Print NaN and Inf as Julia would
++struct NaNSerialization <: CS end
++JSON.show_json(io::SC, ::NaNSerialization, f::AbstractFloat) = Base.print(io, f)
++
++@test sprint(JSON.show_json, NaNSerialization(), [NaN, Inf, -Inf, 0.0]) ==
++ "[NaN,Inf,-Inf,0.0]"
++
++@test sprint_kwarg(
++ JSON.show_json,
++ NaNSerialization(),
++ [NaN, Inf, -Inf, 0.0];
++ indent=4
++) == """
++[
++ NaN,
++ Inf,
++ -Inf,
++ 0.0
++]
++"""
++
++# issue #170: Print JavaScript functions directly
++struct JSSerialization <: CS end
++struct JSFunction
++ data::String
++end
++
++function JSON.show_json(io::SC, ::JSSerialization, f::JSFunction)
++ first = true
++ for line in split(f.data, '\n')
++ if !first
++ JSON.indent(io)
++ end
++ first = false
++ Base.print(io, line)
++ end
++end
++
++@test sprint_kwarg(JSON.show_json, JSSerialization(), Any[
++ 1,
++ 2,
++ JSFunction("function test() {\n return 1;\n}")
++]; indent=2) == """
++[
++ 1,
++ 2,
++ function test() {
++ return 1;
++ }
++]
++"""
++
++# test serializing a type without any fields
++struct SingletonType end
++@test_throws ErrorException json(SingletonType())
++
++# test printing to stdout
++let filename = tempname()
++ open(filename, "w") do f
++ redirect_stdout(f) do
++ JSON.print(Any[1, 2, 3.0])
++ end
++ end
++ @test read(filename, String) == "[1,2,3.0]"
++ rm(filename)
++end
++
++# issue #184: serializing a 0-dimensional array
++@test sprint(JSON.show_json, JSON.StandardSerialization(), view([184], 1)) == "184"
++
++# test serializing with a JSONText object
++@test json([JSONText("{\"bar\": [3,4,5]}"),314159]) == "[{\"bar\": [3,4,5]},314159]"
++@test json([JSONText("{\"bar\": [3,4,5]}"),314159], 1) == "[\n {\n \"bar\": [\n 3,\n 4,\n 5\n ]\n },\n 314159\n]\n"
++
++end
--- /dev/null
--- /dev/null
++@testset "Symbol" begin
++ symtest = Dict(:symbolarray => [:apple, :pear], :symbolsingleton => :hello)
++ @test (JSON.json(symtest) == "{\"symbolarray\":[\"apple\",\"pear\"],\"symbolsingleton\":\"hello\"}"
++ || JSON.json(symtest) == "{\"symbolsingleton\":\"hello\",\"symbolarray\":[\"apple\",\"pear\"]}")
++end
++
++@testset "Floats" begin
++ @test sprint(JSON.print, [NaN]) == "[null]"
++ @test sprint(JSON.print, [Inf]) == "[null]"
++end
++
++@testset "Union{Nothing,T} (old Nullable)" begin
++ @test sprint(JSON.print, Union{Any,Nothing}[nothing]) == "[null]"
++ @test sprint(JSON.print, Union{Int64,Nothing}[nothing]) == "[null]"
++ @test sprint(JSON.print, Union{Int64,Nothing}[1]) == "[1]"
++end
++
++@testset "Char" begin
++ @test json('a') == "\"a\""
++ @test json('\\') == "\"\\\\\""
++ @test json('\n') == "\"\\n\""
++ @test json('🍩') =="\"🍩\""
++end
++
++@testset "Enum" begin
++ include("enum.jl")
++end
++
++@testset "Type" begin
++ @test sprint(JSON.print, Float64) == string("\"Float64\"")
++end
++
++@testset "Module" begin
++ @test_throws ArgumentError sprint(JSON.print, JSON)
++end
++
++@testset "Dates" begin
++ @test json(Date("2016-04-13")) == "\"2016-04-13\""
++ @test json([Date("2016-04-13"), Date("2016-04-12")]) == "[\"2016-04-13\",\"2016-04-12\"]"
++ @test json(DateTime("2016-04-13T00:00:00")) == "\"2016-04-13T00:00:00\""
++ @test json([DateTime("2016-04-13T00:00:00"), DateTime("2016-04-12T00:00:00")]) == "[\"2016-04-13T00:00:00\",\"2016-04-12T00:00:00\"]"
++end
++
++@testset "Null bytes" begin
++ zeros = Dict("\0" => "\0")
++ json_zeros = json(zeros)
++ @test occursin("\\u0000", json_zeros)
++ @test !occursin("\\0", json_zeros)
++ @test JSON.parse(json_zeros) == zeros
++end
++
++@testset "All bytes" begin
++ str = String(collect(0x00:0xff))
++ bytes = Dict(str => str)
++ json_bytes = json(bytes)
++ @test JSON.parse(json_bytes) == bytes
++end
++
++@testset "Arrays" begin
++ # Printing an empty array or Dict shouldn't cause a BoundsError
++ @test json(String[]) == "[]"
++ @test json(Dict()) == "{}"
++
++ #Multidimensional arrays
++ @test json([0 1; 2 0]) == "[[0,2],[1,0]]"
++ @test json(OffsetArray([0 1; 2 0], 0:1, 10:11)) == "[[0,2],[1,0]]"
++end
++
++@testset "Pairs" begin
++ @test json(1 => 2) == "{\"1\":2}"
++ @test json(:foo => 2) == "{\"foo\":2}"
++ @test json([1, 2] => [3, 4]) == "{\"$([1, 2])\":[3,4]}"
++ @test json([1 => 2]) == "[{\"1\":2}]"
++end
++
++@testset "Sets" begin
++ @test json(Set()) == "[]"
++ @test json(Set([1, 2])) in ["[1,2]", "[2,1]"]
++end
--- /dev/null
--- /dev/null
++language: julia
++
++sudo: false
++
++os:
++ - linux
++ - osx
++
++julia:
++ - 1.0
++ - nightly
++
++notifications:
++ email: false
++
++after_success:
++ - julia -e 'using Pkg; cd(Pkg.dir("Parsers")); Pkg.add("Coverage"); using Coverage; Codecov.submit(process_folder())'
--- /dev/null
--- /dev/null
++The MIT License (MIT)
++
++Copyright (c) 2018 The JuliaData Collaborators
++
++Permission is hereby granted, free of charge, to any person obtaining a copy
++of this software and associated documentation files (the "Software"), to deal
++in the Software without restriction, including without limitation the rights
++to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
++copies of the Software, and to permit persons to whom the Software is
++furnished to do so, subject to the following conditions:
++
++The above copyright notice and this permission notice shall be included in all
++copies or substantial portions of the Software.
++
++THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
++IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
++FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
++AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
++LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
++OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
++SOFTWARE.
++
--- /dev/null
--- /dev/null
++name = "Parsers"
++uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
++authors = ["quinnj <quinn.jacobd@gmail.com>"]
++version = "0.3.6"
++
++[deps]
++Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
++Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
++
++[compat]
++julia = "1"
--- /dev/null
--- /dev/null
++Parsers.jl
++=============
++
++[](https://coveralls.io/github/JuliaData/Parsers.jl?branch=master)
++[](https://travis-ci.org/JuliaData/Parsers.jl)
++[](https://ci.appveyor.com/project/quinnj/dataframes-jl/branch/master)
++
++A collection of type parsers and utilities for Julia.
++
++**Installation**: at the Julia REPL, `Pkg.add("Parsers")`
++
++**Maintenance**: Parsers is maintained collectively by the [JuliaData collaborators](https://github.com/orgs/JuliaData/people).
++Responsiveness to pull requests and issues can vary, depending on the availability of key collaborators.
++
++
++### Basic Usage
++```julia
++using Parsers
++
++# basic int/float parsing
++x = Parsers.parse("101", Int)
++y = Parsers.parse("101.101", Float64)
++
++# use comma as decimal
++y2 = Parsers.parse("101,101", Float64, Parsers.Options(decimal=','))
++
++# Bool parsing
++z = Parsers.parse("true", Bool)
++
++# Date/DateTime parsing
++using Dates
++a = Parsers.parse("2018-01-01", Date)
++
++# custom dateformat
++b = Parsers.parse("01/20/2018", Date, Parsers.Options(dateformat="mm/dd/yyyy"))
++
++# will throw on invalid values
++Parsers.parse("abc", Int)
++
++# tryparse will return `nothing` on invalid values
++y = Parsers.tryparse("abc", Int)
++```
++
++### Additional usage
++Read through the docs of the following types/functions for more information on using advanced Parsers machinery:
++ * `?Parsers.Options`
++ * `?Parsers.xparse`
++ * `?Parsers.ReturnCode`
--- /dev/null
--- /dev/null
++environment:
++ matrix:
++ - julia_version: 1
++ - julia_version: nightly
++
++platform:
++ - x86 # 32-bit
++ - x64 # 64-bit
++
++branches:
++ only:
++ - master
++ - /release-.*/
++
++notifications:
++ - provider: Email
++ on_build_success: false
++ on_build_failure: false
++ on_build_status_changed: false
++
++install:
++ - ps: iex ((new-object net.webclient).DownloadString("https://raw.githubusercontent.com/JuliaCI/Appveyor.jl/version-1/bin/install.ps1"))
++
++build_script:
++ - echo "%JL_BUILD_SCRIPT%"
++ - C:\julia\bin\julia -e "%JL_BUILD_SCRIPT%"
++
++test_script:
++ - echo "%JL_TEST_SCRIPT%"
++ - C:\julia\bin\julia -e "%JL_TEST_SCRIPT%"
--- /dev/null
--- /dev/null
++nums = rand(100000)
++
++
++for i = 1:length(nums)
++ r = rand(rng)
++ nums[i] *= exp10(r)
++end
++
++open("testfloats", "w") do f
++ for num in nums
++ println(f, num)
++ end
++end
++
++function strtod()
++ for line in eachline("testfloats")
++ parse(Float64, line)
++ end
++end
++
++using Mmap
++function xparse()
++ io = IOBuffer(Mmap.mmap("testfloats"))
++ for i = 1:100_000
++ Main.Parsers.xparse(io, Float64)
++ Main.Parsers.readbyte(io)
++ end
++end
++
++function bench(n=100_000)
++ open("results", "w") do f
++ println(f, "exp,float,strtod,xparse")
++ rng = -322:307
++ for i = 1:n
++ exp = rand(rng)
++ r = string(exp10(exp) * round(rand(), digits=rand(1:9)))
++ strtod = @elapsed begin
++ a1 = parse(Float64, r)
++ end
++ io = IOBuffer(r)
++ xparse = @elapsed begin
++ a2 = Main.Parsers.xparse(io, Float64)
++ end
++ if a1 != a2.result
++ @warn "a1: $a1, a2: $a2"
++ end
++ println(f, exp, ',', r, ',', strtod, ',', xparse)
++ end
++ end
++end
++
++
++function prof(str, n)
++ io = IOBuffer(str)
++ res = Parsers.Result(Float64)
++ for i = 1:n
++ seekstart(io)
++ r = Parsers.defaultparser(io, res)
++ end
++end
--- /dev/null
--- /dev/null
++using BenchmarkTools, Parsers, Dates
++
++# parse
++@benchmark Parsers.parse(String, "\"-86706967560385154\",")
++@benchmark Parsers.parse(String, "-86706967560385154")
++
++# tryparse
++@benchmark Parsers.parse(Int64, "-86706967560385154")
++@benchmark Parsers.tryparse(Int64, "-86706967560385154")
++
++# xparse
++@benchmark Parsers.xparse(Int64, "\"-86706967560385154\",", 1, 21)
++@benchmark Parsers.xparse(Int64, "-86706967560385154", 1, 18)
++
++@benchmark Parsers.xparse(String, "\"-86706967560385154\",", 1, 21)
++@benchmark Parsers.xparse(String, "-86706967560385154", 1, 18)
++
++# Int
++@benchmark Parsers.parse(Int64, "10")
++@benchmark Base.parse(Int64, "10")
++@benchmark Parsers.parse(Int64, "-86706967560385154")
++@benchmark Base.parse(Int64, "-86706967560385154")
++
++# Float64
++@benchmark Parsers.parse(Float64, "10")
++@benchmark Base.parse(Float64, "10")
++@benchmark Parsers.parse(Float64, "-86706967560385154")
++@benchmark Base.parse(Float64, "-86706967560385154")
++@benchmark Parsers.parse(Float64, "NaN")
++@benchmark Base.parse(Float64, "NaN")
++@benchmark Parsers.parse(Float64, "0.0017138347201173243")
++@benchmark Base.parse(Float64, "0.0017138347201173243")
++@benchmark Parsers.parse(Float64, "2.2250738585072011e-308")
++@benchmark Base.parse(Float64, "2.2250738585072011e-308")
++
++# Date
++@benchmark Parsers.parse(Date, "2019-01-01")
++@benchmark Base.parse(Date, "2019-01-01")
++
++@benchmark Parsers.parse(DateTime, "2019-01-01")
++@benchmark Base.parse(DateTime, "2019-01-01")
++
++@benchmark Parsers.parse(DateTime, "2019-01-01T01:02:03")
++@benchmark Base.parse(DateTime, "2019-01-01T01:02:03")
--- /dev/null
--- /dev/null
++@inline function parseint(io::IO, len::Int)
++ if len == 1
++ return Int(Parsers.readbyte(io) - Parsers.ZERO)
++ end
++ v = zero(Int)
++ b = Parsers.readbyte(io)
++ negative = false
++ if b === Parsers.MINUS # check for leading '-' or '+'
++ negative = true
++ elseif b !== Parsers.PLUS
++ v = Int(b - Parsers.ZERO)
++ end
++ for _ = 1:(len - 1)
++ v *= Int(10)
++ v += Int(Parsers.readbyte(io) - Parsers.ZERO)
++ end
++ return ifelse(negative, -v, v)
++end
++
++function checkint2(str::String)
++ len = sizeof(str)
++ BUF.data = str
++ BUF.ptr = 1
++ BUF.size = len
++ return checkint(BUF)
++end
++
++@inline function checkint(io::IO)
++ eof(io) && return false
++ b = Parsers.peekbyte(io)
++ negative = false
++ if b === Parsers.MINUS # check for leading '-' or '+'
++ negative = true
++ Parsers.readbyte(io)
++ eof(io) && return false
++ b = Parsers.peekbyte(io)
++ elseif b === Parsers.PLUS
++ Parsers.readbyte(io)
++ eof(io) && return false
++ b = Parsers.peekbyte(io)
++ end
++ parseddigits = false
++ while Parsers.NEG_ONE < b < Parsers.TEN
++ parseddigits = true
++ b = Parsers.readbyte(io)
++ eof(io) && break
++ b = Parsers.peekbyte(io)
++ end
++ return parseddigits
++end
--- /dev/null
--- /dev/null
++module Parsers
++
++using Dates
++
++include("utils.jl")
++
++"""
++ `Parsers.Options` is a structure for holding various parsing settings when calling `Parsers.parse`, `Parsers.tryparse`, and `Parsers.xparse`. They include:
++
++ * `sentinel=nothing`: valid values include: `nothing` meaning don't check for sentinel values; `missing` meaning an "empty field" should be considered a sentinel value; or a `Vector{String}` of the various string values that should each be checked as a sentinel value. Note that sentinels will always be checked longest to shortest, with the longest valid match taking precedence.
++ * `wh1=' '`: the first ascii character to be considered when ignoring leading/trailing whitespace in value parsing
++ * `wh2='\t'`: the second ascii character to be considered when ignoring leading/trailing whitespace in value parsing
++ * `openquotechar='"'`: the ascii character that signals a "quoted" field while parsing; subsequent characters will be treated as non-significant until a valid `closequotechar` is detected
++ * `closequotechar='"'`: the ascii character that signals the end of a quoted field
++ * `escapechar='"'`: an ascii character used to "escape" a `closequotechar` within a quoted field
++ * `delim=nothing`: if `nothing`, no delimiter will be checked for; if a `Char` or `String`, a delimiter will be checked for directly after parsing a value or `closequotechar`; a newline (`\n`), return (`\r`), or CRLF (`"\r\n"`) are always considered "delimiters", in addition to EOF
++ * `decimal='.'`: an ascii character to be used when parsing float values that separates a decimal value
++ * `trues=nothing`: if `nothing`, `Bool` parsing will only check for the string `true` or an `Integer` value of `1` as valid values for `true`; as a `Vector{String}`, each string value will be checked to indicate a valid `true` value
++ * `falses=nothing`: if `nothing`, `Bool` parsing will only check for the string `false` or an `Integer` value of `0` as valid values for `false`; as a `Vector{String}`, each string value will be checked to indicate a valid `false` value
++ * `dateformat=nothing`: if `nothing`, `Date`, `DateTime`, and `Time` parsing will use a default `Dates.DateFormat` object while parsing; a `String` or `Dates.DateFormat` object can be provided for custom format parsing
++ * `ignorerepeated=false`: if `true`, consecutive delimiter characters or strings will be consumed until a non-delimiter is encountered; if `false`, only a single delimiter character/string will be consumed. Useful for fixed-width delimited files where fields are padded with delimiters
++ * `quoted=false`: whether parsing should check for `openquotechar` and `closequotechar` characters to signal quoted fields
++ * `debug=false`: if `true`, various debug logging statements will be printed while parsing; useful when diagnosing why parsing returns certain `Parsers.ReturnCode` values
++"""
++struct Options{ignorerepeated, Q, debug, S, D, DF}
++ sentinel::S # Union{Nothing, Missing, Vector{Tuple{Ptr{UInt8}, Int}}}
++ wh1::UInt8
++ wh2::UInt8
++ oq::UInt8
++ cq::UInt8
++ e::UInt8
++ delim::D # Union{Nothing, UInt8, Tuple{Ptr{UInt8}, Int}}
++ decimal::UInt8
++ trues::Union{Nothing, Vector{Tuple{Ptr{UInt8}, Int}}}
++ falses::Union{Nothing, Vector{Tuple{Ptr{UInt8}, Int}}}
++ dateformat::DF # Union{Nothing, Dates.DateFormat}
++ strict::Bool
++ silencewarnings::Bool
++end
++
++prepare(x::Vector{String}) = sort!(map(ptrlen, x), by=x->x[2], rev=true)
++asciival(c::Char) = isascii(c)
++asciival(b::UInt8) = b < 0x80
++
++function Options(
++ sentinel::Union{Nothing, Missing, Vector{String}},
++ wh1::Union{UInt8, Char},
++ wh2::Union{UInt8, Char},
++ oq::Union{UInt8, Char},
++ cq::Union{UInt8, Char},
++ e::Union{UInt8, Char},
++ delim::Union{Nothing, UInt8, Char, String},
++ decimal::Union{UInt8, Char},
++ trues::Union{Nothing, Vector{String}},
++ falses::Union{Nothing, Vector{String}},
++ dateformat::Union{Nothing, String, Dates.DateFormat},
++ ignorerepeated, quoted, debug, strict=false, silencewarnings=false)
++ asciival(wh1) && asciival(wh2) || throw(ArgumentError("whitespace characters must be ASCII"))
++ asciival(oq) && asciival(cq) && asciival(e) || throw(ArgumentError("openquotechar, closequotechar, and escapechar must be ASCII characters"))
++ (wh1 == delim) || (wh2 == delim) && throw(ArgumentError("whitespace characters must be different than delim argument"))
++ (oq == delim) || (cq == delim) || (e == delim) && throw(ArgumentError("delim argument must be different than openquotechar, closequotechar, and escapechar arguments"))
++ if sentinel isa Vector{String}
++ for sent in sentinel
++ if startswith(sent, string(Char(wh1))) || startswith(sent, string(Char(wh2)))
++ throw(ArgumentError("sentinel value isn't allowed to start with wh1 or wh2 characters"))
++ end
++ if startswith(sent, string(Char(oq))) || startswith(sent, string(Char(cq)))
++ throw(ArgumentError("sentinel value isn't allowed to start with openquotechar, closequotechar, or escapechar characters"))
++ end
++ if (delim isa UInt8 || delim isa Char) && startswith(sent, string(Char(delim)))
++ throw(ArgumentError("sentinel value isn't allowed to start with a delimiter character"))
++ elseif delim isa String && startswith(sent, delim)
++ throw(ArgumentError("sentinel value isn't allowed to start with a delimiter string"))
++ end
++ end
++ end
++ sent = sentinel === nothing || sentinel === missing ? sentinel : prepare(sentinel)
++ del = delim === nothing ? nothing : delim isa String ? ptrlen(delim) : delim % UInt8
++ trues = trues === nothing ? nothing : prepare(trues)
++ falses = falses === nothing ? nothing : prepare(falses)
++ df = dateformat === nothing ? nothing : dateformat isa String ? Dates.DateFormat(dateformat) : dateformat
++ return Options{ignorerepeated, quoted, debug, typeof(sent), typeof(del), typeof(df)}(sent, wh1 % UInt8, wh2 % UInt8, oq % UInt8, cq % UInt8, e % UInt8, del, decimal % UInt8, trues, falses, df, strict, silencewarnings)
++end
++
++Options(;
++ sentinel::Union{Nothing, Missing, Vector{String}}=nothing,
++ wh1::Union{UInt8, Char}=UInt8(' '),
++ wh2::Union{UInt8, Char}=UInt8('\t'),
++ openquotechar::Union{UInt8, Char}=UInt8('"'),
++ closequotechar::Union{UInt8, Char}=UInt8('"'),
++ escapechar::Union{UInt8, Char}=UInt8('"'),
++ delim::Union{Nothing, UInt8, Char, String}=nothing,
++ decimal::Union{UInt8, Char}=UInt8('.'),
++ trues::Union{Nothing, Vector{String}}=nothing,
++ falses::Union{Nothing, Vector{String}}=nothing,
++ dateformat::Union{Nothing, String, Dates.DateFormat}=nothing,
++ ignorerepeated::Bool=false,
++ quoted::Bool=false,
++ debug::Bool=false,
++) = Options(sentinel, wh1, wh2, openquotechar, closequotechar, escapechar, delim, decimal, trues, falses, dateformat, ignorerepeated, quoted, debug)
++
++const OPTIONS = Options(nothing, UInt8(' '), UInt8('\t'), UInt8('"'), UInt8('"'), UInt8('"'), nothing, UInt8('.'), nothing, nothing, nothing, false, false, false)
++const XOPTIONS = Options(missing, UInt8(' '), UInt8('\t'), UInt8('"'), UInt8('"'), UInt8('"'), UInt8(','), UInt8('.'), nothing, nothing, nothing, false, true, false)
++
++# high-level convenience functions like in Base
++"Attempt to parse a value of type `T` from string `buf`. Throws `Parsers.Error` on parser failures and invalid values."
++function parse(::Type{T}, buf::Union{AbstractVector{UInt8}, AbstractString, IO}, options=OPTIONS; pos::Integer=1, len::Integer=buf isa IO ? 0 : sizeof(buf)) where {T}
++ x, code, vpos, vlen, tlen = xparse(T, buf isa AbstractString ? codeunits(buf) : buf, pos, len, options)
++ return ok(code) ? x : throw(Error(buf, T, code, pos, tlen))
++end
++
++"Attempt to parse a value of type `T` from `buf`. Returns `nothing` on parser failures and invalid values."
++function tryparse(::Type{T}, buf::Union{AbstractVector{UInt8}, AbstractString, IO}, options=OPTIONS; pos::Integer=1, len::Integer=buf isa IO ? 0 : sizeof(buf)) where {T}
++ x, code, vpos, vlen, tlen = xparse(T, buf isa AbstractString ? codeunits(buf) : buf, pos, len, options)
++ return ok(code) ? x : nothing
++end
++
++default(::Type{T}) where {T <: Integer} = zero(T)
++default(::Type{T}) where {T <: AbstractFloat} = T(0.0)
++default(::Type{T}) where {T <: Dates.TimeType} = T(0)
++
++# for testing purposes only, it's much too slow to dynamically create Options for every xparse call
++"""
++ Parsers.xparse(T, buf, pos, len, options) => (x, code, startpos, value_len, total_len)
++
++ The core parsing function for any type `T`. Takes a `buf`, which can be a `Vector{UInt8}`, `Base.CodeUnits`,
++ or an `IO`. `pos` is the byte position to begin parsing at. `len` is the total # of bytes in `buf` (signaling eof).
++ `options` is an instance of `Parsers.Options`.
++
++ `Parsers.xparse` returns a tuple of 5 values:
++ * `x` is a value of type `T`, even if parsing does not succeed
++ * `code` is a bitmask of parsing codes, use `Parsers.codes(code)` or `Parsers.text(code)` to see the various bit values set. See `?Parsers.ReturnCode` for additional details on the various parsing codes
++ * `startpos`: the starting byte position of the value being parsed; will always equal the start `pos` passed in, except for quoted field where it will point instead to the first byte after the open quote character
++ * `value_len`: the # of bytes consumed while parsing a value, will be equal to the total number of bytes consumed, except for quoted or delimited fields where the quote and delimiter characters will be subtracted out
++ * `total_len`: the total # of bytes consumed while parsing a value, including any quote or delimiter characters; this can be added to the starting `pos` to allow calling `Parsers.xparse` again for a subsequent field/value
++"""
++function xparse end
++
++function xparse(::Type{T}, buf::Union{AbstractVector{UInt8}, AbstractString, IO}; pos::Integer=1, len::Integer=buf isa IO ? 0 : sizeof(buf), sentinel=nothing, wh1::Union{UInt8, Char}=UInt8(' '), wh2::Union{UInt8, Char}=UInt8('\t'), quoted::Bool=true, openquotechar::Union{UInt8, Char}=UInt8('"'), closequotechar::Union{UInt8, Char}=UInt8('"'), escapechar::Union{UInt8, Char}=UInt8('"'), ignorerepeated::Bool=false, delim::Union{UInt8, Char, Tuple{Ptr{UInt8}, Int}, AbstractString, Nothing}=UInt8(','), decimal::Union{UInt8, Char}=UInt8('.'), trues=nothing, falses=nothing, dateformat::Union{Nothing, String, Dates.DateFormat}=nothing, debug::Bool=false) where {T}
++ options = Options(sentinel, wh1, wh2, openquotechar, closequotechar, escapechar, delim, decimal, trues, falses, dateformat, ignorerepeated, quoted, debug)
++ return xparse(T, buf isa AbstractString ? codeunits(buf) : buf, pos, len, options)
++end
++
++function xparse(::Type{T}, buf::AbstractString, pos, len, options::Options=XOPTIONS) where {T}
++ return xparse(T, codeunits(buf), pos, len, options)
++end
++
++@inline function xparse(::Type{T}, source::Union{AbstractVector{UInt8}, IO}, pos, len, options::Options{ignorerepeated, Q, debug, S, D, DF}=XOPTIONS) where {T, ignorerepeated, Q, debug, S, D, DF}
++ startpos = vstartpos = vpos = pos
++ sentinel = options.sentinel
++ code = SUCCESS
++ x = default(T)
++ quoted = false
++ sentinelpos = 0
++ if debug
++ println("parsing $T, pos=$pos, len=$len")
++ end
++ if eof(source, pos, len)
++ code = (sentinel === missing ? SENTINEL : INVALID) | EOF
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("1) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ # strip leading whitespace
++ while b == options.wh1 || b == options.wh2
++ if debug
++ println("stripping leading whitespace")
++ end
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code = INVALID | EOF
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("2) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ # check for start of quoted field
++ if Q
++ quoted = b == options.oq
++ if quoted
++ if debug
++ println("detected open quote character")
++ end
++ code = QUOTED
++ pos += 1
++ vstartpos = pos
++ incr!(source)
++ if eof(source, pos, len)
++ code |= INVALID_QUOTED_FIELD
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("3) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ # ignore whitespace within quoted field
++ while b == options.wh1 || b == options.wh2
++ if debug
++ println("stripping whitespace within quoted field")
++ end
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= INVALID_QUOTED_FIELD | EOF
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("4) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ end
++ end
++ # check for sentinel values if applicable
++ if sentinel !== nothing && sentinel !== missing
++ if debug
++ println("checking for sentinel value")
++ end
++ sentinelpos = checksentinel(source, pos, len, sentinel, debug)
++ end
++ x, code, pos = typeparser(T, source, pos, len, b, code, options)
++ if sentinel !== nothing && sentinel !== missing && sentinelpos >= pos
++ # if we matched a sentinel value that was as long or longer than our type value
++ code &= ~(OK | INVALID | OVERFLOW)
++ pos = sentinelpos
++ fastseek!(source, pos - 1)
++ code |= SENTINEL
++ if eof(source, pos, len)
++ code |= EOF
++ end
++ elseif sentinel === missing && pos == vstartpos
++ code &= ~(OK | INVALID)
++ code |= SENTINEL
++ end
++ vpos = pos
++ if (code & EOF) == EOF
++ if quoted
++ # if we detected a quote character, it's an invalid quoted field due to eof in the middle
++ code |= INVALID_QUOTED_FIELD
++ end
++ @goto donedone
++ end
++
++@label donevalue
++ b = peekbyte(source, pos)
++ if debug
++ println("finished $T value parsing: pos=$pos, current character: '$(escape_string(string(Char(b))))'")
++ end
++ # donevalue means we finished parsing a value or sentinel, but didn't reach len, b is still the current byte
++ # strip trailing whitespace
++ while b == options.wh1 || b == options.wh2
++ if debug
++ println("stripping trailing whitespace")
++ end
++ pos += 1
++ vpos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ if quoted
++ code |= INVALID_QUOTED_FIELD
++ end
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("8) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ if Q
++ # for quoted fields, find the closing quote character
++ # we should be positioned at the correct place to find the closing quote character if everything is as it should be
++ # if we don't find the quote character immediately, something's wrong, so mark INVALID
++ if quoted
++ if debug
++ println("looking for close quote character")
++ end
++ same = options.cq == options.e
++ first = true
++ while true
++ vpos = pos
++ pos += 1
++ incr!(source)
++ if same && b == options.e
++ if eof(source, pos, len)
++ code |= EOF
++ if !first
++ code |= INVALID
++ end
++ @goto donedone
++ elseif peekbyte(source, pos) != options.cq
++ if !first
++ code |= INVALID
++ end
++ break
++ end
++ code |= ESCAPED_STRING
++ pos += 1
++ incr!(source)
++ elseif b == options.e
++ if eof(source, pos, len)
++ code |= INVALID_QUOTED_FIELD | EOF
++ @goto donedone
++ end
++ code |= ESCAPED_STRING
++ pos += 1
++ incr!(source)
++ elseif b == options.cq
++ if !first
++ code |= INVALID
++ end
++ if eof(source, pos, len)
++ code |= EOF
++ @goto donedone
++ end
++ break
++ end
++ if eof(source, pos, len)
++ code |= INVALID_QUOTED_FIELD | EOF
++ @goto donedone
++ end
++ first = false
++ b = peekbyte(source, pos)
++ if debug
++ println("9) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("10) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ # ignore whitespace after quoted field
++ while b == options.wh1 || b == options.wh2
++ if debug
++ println("stripping trailing whitespace after close quote character")
++ end
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("11) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ end
++ end
++
++ if options.delim !== nothing
++ delim = options.delim
++ # now we check for a delimiter; if we don't find it, keep parsing until we do
++ if debug
++ println("checking for delimiter: pos=$pos")
++ end
++ if !ignorerepeated
++ # we're checking for a single appearance of a delimiter
++ if delim isa UInt8
++ if b == delim
++ pos += 1
++ incr!(source)
++ code |= DELIMITED
++ @goto donedone
++ end
++ else
++ predelimpos = pos
++ pos = checkdelim(source, pos, len, delim)
++ if pos > predelimpos
++ # found the delimiter we were looking for
++ code |= DELIMITED
++ @goto donedone
++ end
++ end
++ else
++ # keep parsing as long as we keep matching delim
++ if delim isa UInt8
++ matched = false
++ while b == delim
++ matched = true
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= DELIMITED
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("12) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ if matched
++ code |= DELIMITED
++ @goto donedone
++ end
++ else
++ matched = false
++ predelimpos = pos
++ pos = checkdelim(source, pos, len, delim)
++ while pos > predelimpos
++ matched = true
++ if eof(source, pos, len)
++ code |= DELIMITED
++ @goto donedone
++ end
++ predelimpos = pos
++ pos = checkdelim(source, pos, len, delim)
++ end
++ if matched
++ code |= DELIMITED
++ @goto donedone
++ end
++ end
++ end
++ # didn't find delimiter, but let's check for a newline character
++ if b == UInt8('\n')
++ pos += 1
++ incr!(source)
++ code |= NEWLINE | ifelse(eof(source, pos, len), EOF, SUCCESS)
++ @goto donedone
++ elseif b == UInt8('\r')
++ pos += 1
++ incr!(source)
++ if !eof(source, pos, len) && peekbyte(source, pos) == UInt8('\n')
++ pos += 1
++ incr!(source)
++ end
++ code |= NEWLINE | ifelse(eof(source, pos, len), EOF, SUCCESS)
++ @goto donedone
++ end
++ # didn't find delimiter or newline, so we're invalid, keep parsing until we find delimiter, newline, or len
++ quo = Int(!quoted)
++ code |= INVALID_DELIMITER
++ while true
++ pos += 1
++ vpos += quo
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("13) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ if !ignorerepeated
++ if delim isa UInt8
++ if b == delim
++ pos += 1
++ incr!(source)
++ code |= DELIMITED
++ @goto donedone
++ end
++ else
++ predelimpos = pos
++ pos = checkdelim(source, pos, len, delim)
++ if pos > predelimpos
++ # found the delimiter we were looking for
++ code |= DELIMITED
++ @goto donedone
++ end
++ end
++ else
++ if delim isa UInt8
++ matched = false
++ while b == delim
++ matched = true
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= DELIMITED
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("12) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ if matched
++ code |= DELIMITED
++ @goto donedone
++ end
++ else
++ predelimpos = pos
++ pos = checkdelim(source, pos, len, delim)
++ while pos > predelimpos
++ matched = true
++ if eof(source, pos, len)
++ code |= DELIMITED
++ @goto donedone
++ end
++ predelimpos = pos
++ pos = checkdelim(source, pos, len, delim)
++ end
++ if matched
++ code |= DELIMITED
++ @goto donedone
++ end
++ end
++ end
++ # didn't find delimiter, but let's check for a newline character
++ if b == UInt8('\n')
++ pos += 1
++ incr!(source)
++ code |= NEWLINE | ifelse(eof(source, pos, len), EOF, SUCCESS)
++ @goto donedone
++ elseif b == UInt8('\r')
++ pos += 1
++ incr!(source)
++ if !eof(source, pos, len) && peekbyte(source, pos) == UInt8('\n')
++ pos += 1
++ incr!(source)
++ end
++ code |= NEWLINE | ifelse(eof(source, pos, len), EOF, SUCCESS)
++ @goto donedone
++ end
++ end
++ end
++
++@label donedone
++ if debug
++ println("finished parsing: $(codes(code))")
++ end
++ return x, code, Int64(vstartpos), Int64(vpos - vstartpos), Int64(pos - startpos)
++end
++
++function checkdelim!(buf, pos, len, options::Options{ignorerepeated}) where {ignorerepeated}
++ pos > len && return pos
++ delim = options.delim
++ @inbounds b = buf[pos]
++ valuepos = pos
++ if !ignorerepeated
++ # we're checking for a single appearance of a delimiter
++ if delim isa UInt8
++ b == delim && return pos + 1
++ else
++ pos = checkdelim(buf, pos, len, delim)
++ pos > valuepos && return pos
++ end
++ else
++ # keep parsing as long as we keep matching delim
++ if delim isa UInt8
++ matched = false
++ while b == delim
++ matched = true
++ pos += 1
++ pos > len && return pos
++ @inbounds b = buf[pos]
++ end
++ matched && return pos
++ else
++ matched = false
++ predelimpos = pos
++ pos = checkdelim(buf, pos, len, delim)
++ while pos > predelimpos
++ matched = true
++ pos > len && return pos
++ predelimpos = pos
++ pos = checkdelim(buf, pos, len, delim)
++ end
++ matched && return pos
++ end
++ end
++ return pos
++end
++
++include("ints.jl")
++include("floats.jl")
++include("strings.jl")
++include("bools.jl")
++include("dates.jl")
++
++function __init__()
++ # floats.jl globals
++ Threads.resize_nthreads!(ONES)
++ foreach(x->MPZ.init!(x), ONES)
++ Threads.resize_nthreads!(NUMS)
++ foreach(x->MPZ.init!(x), NUMS)
++ Threads.resize_nthreads!(QUOS)
++ foreach(x->MPZ.init!(x), QUOS)
++ Threads.resize_nthreads!(REMS)
++ foreach(x->MPZ.init!(x), REMS)
++ Threads.resize_nthreads!(SCLS)
++ foreach(x->MPZ.init!(x), SCLS)
++ return
++end
++
++end # module
--- /dev/null
--- /dev/null
++@inline function typeparser(::Type{Bool}, source, pos, len, b, code, options::Options{ignorerepeated, Q, debug, S, D, DF}) where {ignorerepeated, Q, debug, S, D, DF}
++ x = false
++ if debug
++ println("start of Bool parsing")
++ end
++ trues = options.trues
++ falses = options.falses
++ if trues === nothing
++ if b == UInt8('t')
++ if debug
++ println("matched 't'")
++ end
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= INVALID | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('r')
++ if debug
++ println("matched 'r'")
++ end
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= INVALID | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('u')
++ if debug
++ println("matched 'u'")
++ end
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= INVALID | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('e')
++ if debug
++ println("matched 'e'")
++ end
++ pos += 1
++ incr!(source)
++ x = true
++ code |= OK
++ if eof(source, pos, len)
++ code |= EOF
++ end
++ @goto done
++ end
++ end
++ end
++ else
++ intx, intcode, intpos = typeparser(UInt8, source, pos, len, b, code, options)
++ if ok(intcode) && intx < 0x02
++ x = intx == 0x01 ? true : false
++ code = intcode
++ pos = intpos
++ @goto done
++ end
++ end
++ else
++ if source isa AbstractVector{UInt8}
++ startptr = pointer(source, pos)
++ for (i, (ptr, ptrlen)) in enumerate(trues)
++ if pos + ptrlen - 1 <= len
++ match = memcmp(startptr, ptr, ptrlen)
++ if match
++ x = true
++ code |= OK
++ pos = pos + ptrlen
++ if eof(source, pos, len)
++ code |= EOF
++ end
++ @goto done
++ end
++ end
++ end
++ else # source isa IO
++ for (i, (ptr, ptrlen)) in enumerate(trues)
++ matched = match!(source, ptr, ptrlen)
++ if matched
++ x = true
++ code |= OK
++ pos = pos + ptrlen
++ if eof(source, pos, len)
++ code |= EOF
++ end
++ @goto done
++ end
++ end
++ end
++ end
++ if falses === nothing
++ if b == UInt8('f')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= INVALID | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('a')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= INVALID | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('l')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= INVALID | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('s')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= INVALID | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('e')
++ pos += 1
++ incr!(source)
++ code |= OK
++ if eof(source, pos, len)
++ code |= EOF
++ end
++ @goto done
++ end
++ end
++ end
++ end
++ end
++ else
++ if source isa AbstractVector{UInt8}
++ startptr = pointer(source, pos)
++ for (i, (ptr, ptrlen)) in enumerate(falses)
++ if pos + ptrlen - 1 <= len
++ match = memcmp(startptr, ptr, ptrlen)
++ if match
++ x = false
++ code |= OK
++ pos = pos + ptrlen
++ if eof(source, pos, len)
++ code |= EOF
++ end
++ @goto done
++ end
++ end
++ end
++ else # source isa IO
++ for (i, (ptr, ptrlen)) in enumerate(falses)
++ matched = match!(source, ptr, ptrlen)
++ if matched
++ x = false
++ code |= OK
++ pos = pos + ptrlen
++ if eof(source, pos, len)
++ code |= EOF
++ end
++ @goto done
++ end
++ end
++ end
++ end
++ fastseek!(source, pos - 1)
++ code |= INVALID
++
++@label done
++ return x, code, pos
++end
--- /dev/null
--- /dev/null
++@inline function typeparser(::Type{T}, source, pos, len, b, code, options::Options{ignorerepeated, Q, debug, S, D, DF}) where {T <: Dates.TimeType, ignorerepeated, Q, debug, S, D, DF}
++ df = options.dateformat === nothing ? Dates.default_format(T) : options.dateformat
++ ret = mytryparsenext_internal(T, source, Int(pos), len, df)
++ if debug
++ if ret === nothing
++ println("failed to parse $T")
++ else
++ println("parsed: $ret")
++ end
++ end
++ if ret === nothing
++ x = default(T)
++ code |= INVALID
++ else
++ values, pos = ret
++ x = T(values...)
++ code |= OK
++ if eof(source, pos, len)
++ code |= EOF
++ end
++ end
++
++ return x, code, pos
++end
++
++@generated function mytryparsenext_internal(::Type{T}, str, pos, len, df::DateFormat) where {T <: Dates.TimeType}
++ letters = Dates.character_codes(df)
++
++ tokens = Type[Dates.CONVERSION_SPECIFIERS[letter] for letter in letters]
++ value_names = Symbol[Dates.genvar(t) for t in tokens]
++
++ output_tokens = Dates.CONVERSION_TRANSLATIONS[T]
++ output_names = Symbol[Dates.genvar(t) for t in output_tokens]
++ output_defaults = Tuple(Dates.CONVERSION_DEFAULTS[t] for t in output_tokens)
++
++ assign_defaults = Expr[
++ quote
++ $name = $default
++ end
++ for (name, default) in zip(output_names, output_defaults)
++ ]
++ value_tuple = Expr(:tuple, value_names...)
++
++ return quote
++ $(Expr(:meta, :inline))
++ val = mytryparsenext_core(str, pos, len, df)
++ val === nothing && return nothing
++ values, pos, num_parsed = val
++ $(assign_defaults...)
++ $value_tuple = values
++ return $(Expr(:tuple, output_names...)), pos
++ end
++end
++
++@generated function mytryparsenext_core(str, pos, len, df::DateFormat)
++ directives = Dates._directives(df)
++ letters = Dates.character_codes(directives)
++
++ tokens = Type[Dates.CONVERSION_SPECIFIERS[letter] for letter in letters]
++ value_names = Symbol[Dates.genvar(t) for t in tokens]
++ value_defaults = Tuple(Dates.CONVERSION_DEFAULTS[t] for t in tokens)
++
++ assign_defaults = Expr[]
++ for (name, default) in zip(value_names, value_defaults)
++ push!(assign_defaults, quote
++ $name = $default
++ end)
++ end
++
++ vi = 1
++ parsers = Expr[]
++ for i = 1:length(directives)
++ if directives[i] <: Dates.DatePart
++ name = value_names[vi]
++ vi += 1
++ push!(parsers, quote
++ pos > len && @goto done
++ let val = Dates.tryparsenext(directives[$i], str, pos, len, locale)
++ if val === nothing
++ $i > 1 && @goto done
++ @goto error
++ end
++ $name, pos = val
++ end
++ num_parsed += 1
++ directive_index += 1
++ end)
++ else
++ push!(parsers, quote
++ pos > len && @goto done
++ let val = Dates.tryparsenext(directives[$i], str, pos, len, locale)
++ if val === nothing
++ $i > 1 && @goto done
++ @goto error
++ end
++ delim, pos = val
++ end
++ directive_index += 1
++ end)
++ end
++ end
++
++ return quote
++ $(Expr(:meta, :inline))
++ directives = df.tokens
++ locale::Dates.DateLocale = df.locale
++ num_parsed = 0
++ directive_index = 1
++ $(assign_defaults...)
++ $(parsers...)
++ @label done
++ return $(Expr(:tuple, value_names...)), pos, num_parsed
++ @label error
++ return nothing
++ end
++end
++
++@inline function Dates.tryparsenext(d::Dates.Delim{<:AbstractChar, N}, str::AbstractVector{UInt8}, i::Int, len) where N
++ for j = 1:N
++ i > len && return nothing
++ next = iterate(str, i)
++ @assert next !== nothing
++ c, i = next
++ c != UInt8(d.d) && return nothing
++ end
++ return true, i
++end
++
++@inline function Dates.tryparsenext(d::Dates.Delim{String, N}, str::AbstractVector{UInt8}, i::Int, len) where N
++ i1 = i
++ i2 = firstindex(d.d)
++ for j = 1:N
++ if i1 > len
++ return nothing
++ end
++ next1 = iterate(str, i1)
++ @assert next1 !== nothing
++ c1, i1 = next1
++ next2 = iterate(d.d, i2)
++ @assert next2 !== nothing
++ c2, i2 = next2
++ if c1 != UInt8(c2)
++ return nothing
++ end
++ end
++ return true, i1
++end
++
++@inline function Dates.tryparsenext_base10(str::AbstractVector{UInt8}, i, len, min_width=1, max_width=0)
++ i > len && return nothing
++ min_pos = min_width <= 0 ? i : i + min_width - 1
++ max_pos = max_width <= 0 ? len : min(i + max_width - 1, len)
++ d::Int64 = 0
++ @inbounds while i <= max_pos
++ c, ii = iterate(str, i)
++ if UInt8('0') <= c <= UInt8('9')
++ d = d * 10 + (c - UInt8('0'))
++ else
++ break
++ end
++ i = ii
++ end
++ if i <= min_pos
++ return nothing
++ else
++ return d, i
++ end
++end
++
++@inline function Dates.tryparsenext_word(str::AbstractVector{UInt8}, i, len, locale, maxchars=0)
++ word_start, word_end = i, 0
++ max_pos = maxchars <= 0 ? len : min(len, nextind(str, i, maxchars-1))
++ @inbounds while i <= max_pos
++ c, ii = iterate(str, i)
++ if isletter(Char(c))
++ word_end = i
++ else
++ break
++ end
++ i = ii
++ end
++ if word_end == 0
++ return nothing
++ else
++ return unsafe_string(pointer(str, word_start), word_end - word_start + 1), i
++ end
++end
--- /dev/null
--- /dev/null
++wider(::Type{Int64}) = Int128
++wider(::Type{Int128}) = BigInt
++
++# include a non-inlined version in case of widening (otherwise, all widened cases would fully inline)
++@noinline _typeparser(::Type{T}, source, pos, len, b, code, options::Options{ignorerepeated, Q, debug, S, D, DF}, ::Type{IntType}) where {T <: AbstractFloat, ignorerepeated, Q, debug, S, D, DF, IntType} =
++ typeparser(T, source, pos, len, b, code, options, IntType)
++
++@inline function typeparser(::Type{T}, source, pos, len, b, code, options::Options{ignorerepeated, Q, debug, S, D, DF}, ::Type{IntType}=Int64) where {T <: AbstractFloat, ignorerepeated, Q, debug, S, D, DF, IntType}
++ startpos = pos
++ origb = b
++ x = zero(T)
++ digits = zero(IntType)
++ if debug
++ println("float parsing")
++ end
++ neg = b == UInt8('-')
++ if neg || b == UInt8('+')
++ pos += 1
++ incr!(source)
++ end
++ if eof(source, pos, len)
++ code |= INVALID | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == options.decimal
++ @goto decimalcheck
++ end
++ b -= UInt8('0')
++ if debug
++ println("float 1) $(b + UInt8('0'))")
++ end
++ if b > 0x09
++ # character isn't a digit, check for special values, otherwise INVALID
++ b += UInt8('0')
++ if b == UInt8('n') || b == UInt8('N')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto invalid
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('a') || b == UInt8('A')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto invalid
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('n') || b == UInt8('N')
++ x = T(NaN)
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ end
++ code |= OK
++ @goto done
++ end
++ end
++ elseif b == UInt8('i') || b == UInt8('I')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto invalid
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('n') || b == UInt8('N')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto invalid
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('f') || b == UInt8('F')
++ x = ifelse(neg, T(-Inf), T(Inf))
++ code |= OK
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('i') || b == UInt8('I')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('n') || b == UInt8('N')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('i') || b == UInt8('I')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('t') || b == UInt8('T')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b == UInt8('y') || b == UInt8('Y')
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ end
++ @goto done
++ end
++ end
++ end
++ end
++ end
++ @goto done
++ end
++ end
++ else
++ end
++@label invalid
++ fastseek!(source, startpos)
++ code |= INVALID
++ @goto done
++ end
++ while true
++ digits = IntType(10) * digits + b
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ x = T(ifelse(neg, -digits, digits))
++ code |= OK | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos) - UInt8('0')
++ if debug
++ println("float 2) $(b + UInt8('0'))")
++ end
++ b > 0x09 && break
++ if overflows(IntType) && digits > overflowval(IntType)
++ fastseek!(source, startpos)
++ return _typeparser(T, source, startpos, len, origb, code, options, wider(IntType))
++ end
++ end
++ b += UInt8('0')
++ if debug
++ println("float 3) $(Char(b))")
++ end
++@label decimalcheck
++ if b == options.decimal
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ x = T(ifelse(neg, -digits, digits))
++ code |= OK | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if b - UInt8('0') > 0x09 && !(b == UInt8('e') || b == UInt8('E') || b == UInt8('f') || b == UInt8('F'))
++ x = T(ifelse(neg, -digits, digits))
++ code |= OK
++ @goto done
++ end
++ end
++ frac = 0
++ if debug
++ println("float 4) $(Char(b))")
++ end
++ b -= UInt8('0')
++ if b < 0x0a
++ while true
++ digits = IntType(10) * digits + b
++ pos += 1
++ incr!(source)
++ frac += 1
++ if eof(source, pos, len)
++ x = scale(T, digits, -frac, neg)
++ code |= OK | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos) - UInt8('0')
++ if debug
++ println("float 5) $b")
++ end
++ b > 0x09 && break
++ if overflows(IntType) && digits > overflowval(IntType)
++ fastseek!(source, startpos)
++ return _typeparser(T, source, startpos, len, origb, code, options, wider(IntType))
++ end
++ end
++ end
++ b += UInt8('0')
++ if debug
++ println("float 6) $(Char(b))")
++ end
++ # check for exponent notation
++ if b == UInt8('e') || b == UInt8('E') || b == UInt8('f') || b == UInt8('F')
++ pos += 1
++ incr!(source)
++ # error to have a "dangling" 'e'
++ if eof(source, pos, len)
++ code |= INVALID | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("float 7) $(Char(b))")
++ end
++ exp = zero(IntType)
++ negexp = b == UInt8('-')
++ if negexp || b == UInt8('+')
++ pos += 1
++ incr!(source)
++ end
++ b = peekbyte(source, pos) - UInt8('0')
++ if debug
++ println("float 8) $b")
++ end
++ if b > 0x09
++ # invalid to have a "dangling" 'e'
++ code |= INVALID
++ @goto done
++ end
++ while true
++ exp = IntType(10) * exp + b
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ x = scale(T, digits, ifelse(negexp, -exp, exp) - frac, neg)
++ code |= OK | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos) - UInt8('0')
++ if debug
++ println("float 9) $b")
++ end
++ if b > 0x09
++ x = scale(T, digits, ifelse(negexp, -exp, exp) - frac, neg)
++ code |= OK
++ @goto done
++ end
++ if overflows(IntType) && exp > overflowval(IntType)
++ fastseek!(source, startpos)
++ return _typeparser(T, source, startpos, len, origb, code, options, wider(IntType))
++ end
++ end
++ else
++ x = scale(T, digits, -frac, neg)
++ code |= OK
++ end
++
++@label done
++ return x, code, pos
++end
++
++using Base.GMP, Base.GMP.MPZ
++
++const ONES = [BigInt(1)]
++const NUMS = [BigInt()]
++const QUOS = [BigInt()]
++const REMS = [BigInt()]
++const SCLS = [BigInt()]
++
++const BIG_E = UInt8('E')
++const LITTLE_E = UInt8('e')
++
++const bipows5 = [big(5)^x for x = 0:325]
++
++function roundQuotient(num, den)
++ @inbounds quo, rem = MPZ.tdiv_qr!(QUOS[Threads.threadid()], REMS[Threads.threadid()], num, den)
++ q = Int64(quo)
++ cmpflg = cmp(MPZ.mul_2exp!(rem, 1), den)
++ return ((q & 1) == 0 ? 1 == cmpflg : -1 < cmpflg) ? q + 1 : q
++end
++
++maxsig(::Type{Float16}) = 2048
++maxsig(::Type{Float32}) = 16777216
++maxsig(::Type{Float64}) = 9007199254740992
++
++ceillog5(::Type{Float16}) = 5
++ceillog5(::Type{Float32}) = 11
++ceillog5(::Type{Float64}) = 23
++
++const F16_SHORT_POWERS = [exp10(Float16(x)) for x = 0:2ceillog5(Float16)-1]
++const F32_SHORT_POWERS = [exp10(Float32(x)) for x = 0:2ceillog5(Float32)-1]
++const F64_SHORT_POWERS = [exp10(Float64(x)) for x = 0:2ceillog5(Float64)-1]
++
++pow10(::Type{Float16}, e) = (@inbounds v = F16_SHORT_POWERS[e+1]; return v)
++pow10(::Type{Float32}, e) = (@inbounds v = F32_SHORT_POWERS[e+1]; return v)
++pow10(::Type{Float64}, e) = (@inbounds v = F64_SHORT_POWERS[e+1]; return v)
++
++significantbits(::Type{Float16}) = 11
++significantbits(::Type{Float32}) = 24
++significantbits(::Type{Float64}) = 53
++
++bitlength(this) = GMP.MPZ.sizeinbase(this, 2)
++bits(::Type{T}) where {T <: Union{Float16, Float32, Float64}} = 8sizeof(T)
++
++BigInt!(y::BigInt, x::BigInt) = x
++BigInt!(y::BigInt, x::Union{Clong,Int32}) = MPZ.set_si!(y, x)
++# copied from base/gmp.jl:285
++function BigInt!(y::BigInt, x::Integer)
++ x == 0 && return y
++ nd = ndigits(x, base=2)
++ z = GMP.MPZ.realloc2!(y, nd)
++ s = sign(x)
++ s == -1 && (x = -x)
++ x = unsigned(x)
++ size = 0
++ limbnbits = sizeof(GMP.Limb) << 3
++ while nd > 0
++ size += 1
++ unsafe_store!(z.d, x % GMP.Limb, size)
++ x >>>= limbnbits
++ nd -= limbnbits
++ end
++ z.size = s*size
++ z
++end
++
++function scale(::Type{T}, v, exp) where {T <: Union{Float16, Float32, Float64}}
++ ms = maxsig(T)
++ cl = ceillog5(T)
++ if v < ms
++ # fastest path
++ if 0 <= exp < cl
++ return T(v) * pow10(T, exp)
++ elseif -cl < exp < 0
++ return T(v) / pow10(T, -exp)
++ end
++ end
++ v == 0 && return zero(T)
++ @inbounds mant = BigInt!(NUMS[Threads.threadid()], v)
++ if 0 <= exp < 327
++ num = MPZ.mul!(mant, bipows5[exp+1])
++ bex = bitlength(num) - significantbits(T)
++ bex <= 0 && return ldexp(T(num), exp)
++ @inbounds one = MPZ.mul_2exp!(MPZ.set_si!(ONES[Threads.threadid()], 1), bex)
++ quo = roundQuotient(num, one)
++ return ldexp(T(quo), bex + exp)
++ elseif -327 < exp < 0
++ maxpow = length(bipows5) - 1
++ @inbounds scl = SCLS[Threads.threadid()]
++ if -exp <= maxpow
++ MPZ.set!(scl, bipows5[-exp+1])
++ else
++ # this branch isn't tested
++ MPZ.set!(scl, bipows5[maxpow+1])
++ MPZ.mul!(scl, bipows5[-exp-maxpow+1])
++ end
++ bex = bitlength(mant) - bitlength(scl) - significantbits(T)
++ bex = min(bex, 0)
++ num = MPZ.mul_2exp!(mant, -bex)
++ quo = roundQuotient(num, scl)
++ if (bits(T) - leading_zeros(quo) > significantbits(T)) || exp == -324
++ bex += 1
++ quo = roundQuotient(num, MPZ.mul_2exp!(scl, 1))
++ end
++ if exp <= -324
++ return T(ldexp(BigFloat(quo), bex + exp))
++ else
++ return ldexp(T(quo), bex + exp)
++ end
++ else
++ return exp > 0 ? T(Inf) : T(0)
++ end
++end
++
++@inline function scale(::Type{T}, lmant, exp, neg) where {T <: Union{Float16, Float32, Float64}}
++ result = scale(T, lmant, exp)
++ return ifelse(neg, -result, result)
++end
--- /dev/null
--- /dev/null
++overflows(::Type{T}) where {T} = true
++overflows(::Type{BigInt}) = false
++overflowval(::Type{T}) where {T <: Integer} = div(typemax(T) - T(9), T(10))
++# if we eventually support non-base 10
++# overflowval(::Type{T}, base) where {T <: Integer} = div(typemax(T) - base + 1, base)
++
++@inline function typeparser(::Type{T}, source, pos, len, b, code, options::Options{ignorerepeated, Q, debug, S, D, DF}) where {T <: Integer, ignorerepeated, Q, debug, S, D, DF}
++ x = zero(T)
++ neg = false
++ # start actual int parsing
++ if debug
++ println("start of actual $T parsing")
++ end
++ neg = b == UInt8('-')
++ if neg || b == UInt8('+')
++ pos += 1
++ incr!(source)
++ end
++ if eof(source, pos, len)
++ code |= INVALID | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos) - UInt8('0')
++ if b > 0x09
++ # character isn't a digit, INVALID value
++ code |= INVALID
++ @goto done
++ end
++ while true
++ x = T(10) * x + b
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ x = ifelse(neg, -x, x)
++ code |= OK | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos) - UInt8('0')
++ if b > 0x09
++ # detected a non-digit, time to bail on value parsing
++ x = ifelse(neg, -x, x)
++ code |= OK
++ @goto done
++ end
++ overflows(T) && x > overflowval(T) && break
++ end
++ # extra loop because we got too close to overflowing while parsing digits
++ x = ifelse(neg, -x, x)
++ while true
++ x, ov_mul = Base.mul_with_overflow(x, T(10))
++ x, ov_add = Base.add_with_overflow(x, ifelse(neg, -T(b), T(b)))
++ if ov_mul | ov_add
++ # we overflowed, mark as OVERFLOW
++ code |= OVERFLOW
++ # in this case, we know b is a digit that caused us
++ # to overflow, so we don't really want to consider it for
++ # a close quote character or delimiter, so if b is the last character
++ # let's just bail as eof
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ end
++ @goto done
++ end
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ x = ifelse(neg, -x, x)
++ code |= OK | EOF
++ @goto done
++ end
++ b = peekbyte(source, pos) - UInt8('0')
++ if b > 0x09
++ x = ifelse(neg, -x, x)
++ code |= OK
++ @goto done
++ end
++ end
++
++@label done
++ return x, code, pos
++end
--- /dev/null
--- /dev/null
++# this is mostly copy-pasta from Parsers.jl main xparse function
++@inline function xparse(::Type{T}, source::Union{AbstractVector{UInt8}, IO}, pos, len, options::Options{ignorerepeated, Q, debug, S, D, DF}) where {T <: AbstractString, ignorerepeated, Q, debug, S, D, DF}
++ startpos = vstartpos = vpos = pos
++ sentinelpos = 0
++ code = SUCCESS
++ sentinel = options.sentinel
++ quoted = false
++ if debug
++ println("parsing $T, pos=$pos, len=$len")
++ end
++ if eof(source, pos, len)
++ code = (sentinel === missing ? SENTINEL : OK) | EOF
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("string 1) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ # strip leading whitespace
++ while b == options.wh1 || b == options.wh2
++ if debug
++ println("stripping leading whitespace")
++ end
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("string 2) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ # check for start of quoted field
++ if Q
++ quoted = b == options.oq
++ if quoted
++ if debug
++ println("detected open quote character")
++ end
++ code = QUOTED
++ pos += 1
++ vstartpos = pos
++ incr!(source)
++ if eof(source, pos, len)
++ code |= INVALID_QUOTED_FIELD
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("string 3) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ # ignore whitespace within quoted field
++ while b == options.wh1 || b == options.wh2
++ if debug
++ println("stripping whitespace within quoted field")
++ end
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= INVALID_QUOTED_FIELD | EOF
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("string 4) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ end
++ end
++ # check for sentinel values if applicable
++ if sentinel !== nothing && sentinel !== missing
++ if debug
++ println("checking for sentinel value")
++ end
++ sentstart = pos
++ sentinelpos = checksentinel(source, pos, len, sentinel, debug)
++ end
++ vpos = pos
++ if Q
++ # for quoted fields, find the closing quote character
++ # we should be positioned at the correct place to find the closing quote character if everything is as it should be
++ # if we don't find the quote character immediately, something's wrong, so mark INVALID
++ if quoted
++ if debug
++ println("looking for close quote character")
++ end
++ same = options.cq == options.e
++ while true
++ vpos = pos
++ pos += 1
++ incr!(source)
++ if same && b == options.e
++ if eof(source, pos, len)
++ code |= EOF
++ @goto donedone
++ elseif peekbyte(source, pos) != options.cq
++ break
++ end
++ code |= ESCAPED_STRING
++ pos += 1
++ incr!(source)
++ elseif b == options.e
++ if eof(source, pos, len)
++ code |= INVALID_QUOTED_FIELD | EOF
++ @goto donedone
++ end
++ code |= ESCAPED_STRING
++ pos += 1
++ incr!(source)
++ elseif b == options.cq
++ if eof(source, pos, len)
++ code |= EOF
++ @goto donedone
++ end
++ break
++ end
++ if eof(source, pos, len)
++ code |= INVALID_QUOTED_FIELD | EOF
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("string 9) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("string 10) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ # ignore whitespace after quoted field
++ while b == options.wh1 || b == options.wh2
++ if debug
++ println("stripping trailing whitespace after close quote character")
++ end
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("string 11) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ end
++ end
++ if options.delim !== nothing
++ delim = options.delim
++ quo = Int(!quoted)
++ # now we check for a delimiter; if we don't find it, keep parsing until we do
++ if debug
++ println("checking for delimiter: pos=$pos")
++ end
++ while true
++ if !ignorerepeated
++ if delim isa UInt8
++ if b == delim
++ pos += 1
++ incr!(source)
++ code |= DELIMITED
++ @goto donedone
++ end
++ else
++ predelimpos = pos
++ pos = checkdelim(source, pos, len, delim)
++ if pos > predelimpos
++ # found the delimiter we were looking for
++ code |= DELIMITED
++ @goto donedone
++ end
++ end
++ else
++ if delim isa UInt8
++ matched = false
++ while b == delim
++ matched = true
++ pos += 1
++ incr!(source)
++ if eof(source, pos, len)
++ code |= DELIMITED
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ if debug
++ println("string 14) parsed: '$(escape_string(string(Char(b))))'")
++ end
++ end
++ if matched
++ code |= DELIMITED
++ @goto donedone
++ end
++ else
++ matched = false
++ predelimpos = pos
++ pos = checkdelim(source, pos, len, delim)
++ while pos > predelimpos
++ matched = true
++ if eof(source, pos, len)
++ code |= DELIMITED
++ @goto donedone
++ end
++ predelimpos = pos
++ pos = checkdelim(source, pos, len, delim)
++ end
++ if matched
++ code |= DELIMITED
++ @goto donedone
++ end
++ end
++ end
++ # didn't find delimiter, but let's check for a newline character
++ if b == UInt8('\n')
++ pos += 1
++ incr!(source)
++ code |= NEWLINE | ifelse(eof(source, pos, len), EOF, SUCCESS)
++ @goto donedone
++ elseif b == UInt8('\r')
++ pos += 1
++ incr!(source)
++ if !eof(source, pos, len) && peekbyte(source, pos) == UInt8('\n')
++ pos += 1
++ incr!(source)
++ end
++ code |= NEWLINE | ifelse(eof(source, pos, len), EOF, SUCCESS)
++ @goto donedone
++ end
++ # didn't find delimiter nor newline, so increment and check the next byte
++ pos += 1
++ vpos += quo
++ incr!(source)
++ if eof(source, pos, len)
++ code |= EOF
++ @goto donedone
++ end
++ b = peekbyte(source, pos)
++ end
++ end
++
++@label donedone
++ if sentinel !== nothing && sentinel !== missing && sentstart == vstartpos && sentinelpos == vpos
++ # if we matched a sentinel value that was as long or longer than our type value
++ code |= SENTINEL
++ elseif sentinel === missing && vstartpos == vpos
++ code |= SENTINEL
++ else
++ code |= OK
++ end
++ if debug
++ println("finished parsing: $(codes(code))")
++ end
++ return code, code, Int64(vstartpos), Int64(vpos - vstartpos), Int64(pos - startpos)
++end
--- /dev/null
--- /dev/null
++struct Error <: Exception
++ str::String
++ T
++ code
++end
++
++Error(buf::AbstractString, T, code, pos, totallen) = Error(buf, T, code)
++Error(buf::AbstractVector{UInt8}, T, code, pos, totallen) = Error(String(copy(buf)), T, code)
++
++function Error(buf::IO, T, code, pos, totallen)
++ fastseek!(buf, pos - 1)
++ bytes = read(buf, totallen)
++ return Error(String(bytes), T, code)
++end
++
++function Base.showerror(io::IO, e::Error)
++ c = e.code
++ println(io, "Parsers.Error ($(codes(c))):")
++ println(io, text(c))
++ println(io, "attempted to parse $(e.T) from: \"$(escape_string(e.str))\"")
++end
++
++"""
++A bitmask value, with various bits corresponding to different parsing signals and scenarios.
++
++`Parsers.xparse` returns a `code` value with various bits set according to the various scenarios
++encountered while parsing a value.
++
++ * `INVALID`: there are a number of invalid parsing states, all include the INVALID bit set (check via `Parsers.invalid(code)`)
++ * `OK`: signals specifically that a valid value of type `T` was parsed (check via `Parsers.ok(code)`)
++ * `SENTINEL`: signals that a valid sentinel value was detected while parsing, passed via the `sentinel` keyword argument to `Parsers.Options` (check via `Parsers.sentinel(code)`)
++ * `QUOTED`: a `openquotechar` from `Parsers.Options` was detected at the beginning of parsing (check via `Parsers.quoted(code)`)
++ * `DELIMITED`: a `delim` character or string from `Parsers.Options` was detected while parsing (check via `Parsers.delimited(code)`)
++ * `NEWLINE`: a non-quoted newline character (`'\n'`), return character (`'\r'`), or CRLF (`"\r\n"`) was detected while parsing (check via `Parsers.newline(code)`)
++ * `EOF`: the end of file was reached while parsing
++ * `ESCAPED_STRING`: an `escapechar` from `Parsers.Options` was encountered while parsing (check via `Parsers.escapedstring(code)`)
++ * `INVALID_QUOTED_FIELD`: a `openquotechar` were detected when parsing began, but no corresponding `closequotechar` were found to correctly close a quoted field, this is usually a fatal parsing error because parsing will continue until EOF to look for the close quote character (check via `Parsers.invalidquotedfield(code)`)
++ * `INVALID_DELIMITER`: a `delim` character or string were eventually detected, but not at the expected position (directly after parsing a valid value), indicating there are extra, invalid characters between a valid value and the expected delimiter (check via `Parsers.invaliddelimiter(code)`)
++ * `OVERFLOW`: overflow occurred while parsing an `Integer` value type (check via `Parsers.overflow(code)`)
++
++One additional convenience function is provided, `Parsers.quotednotescaped(code)`, which checks if a value was quoted,
++but didn't contain any escape characters, useful to indicate if a string may be used "as-is", instead of needing to be unescaped.
++"""
++const ReturnCode = Int16
++
++const SUCCESS = 0b0000000000000000 % ReturnCode
++const INVALID = 0b1000000000000000 % ReturnCode
++
++# success flags
++const OK = 0b0000000000000001 % ReturnCode
++const SENTINEL = 0b0000000000000010 % ReturnCode
++
++# property flags
++const QUOTED = 0b0000000000000100 % ReturnCode
++const DELIMITED = 0b0000000000001000 % ReturnCode
++const NEWLINE = 0b0000000000010000 % ReturnCode
++const EOF = 0b0000000000100000 % ReturnCode
++const ESCAPED_STRING = 0b0000001000000000 % ReturnCode
++
++# invalid flags
++const INVALID_QUOTED_FIELD = 0b1000000001000000 % ReturnCode
++const INVALID_DELIMITER = 0b1000000010000000 % ReturnCode
++const OVERFLOW = 0b1000000100000000 % ReturnCode
++
++ok(x::ReturnCode) = (x & (OK | INVALID)) == OK
++invalid(x::ReturnCode) = x < 0
++sentinel(x::ReturnCode) = (x & SENTINEL) == SENTINEL
++quoted(x::ReturnCode) = (x & QUOTED) == QUOTED
++delimited(x::ReturnCode) = (x & DELIMITED) == DELIMITED
++newline(x::ReturnCode) = (x & NEWLINE) == NEWLINE
++escapedstring(x::ReturnCode) = (x & ESCAPED_STRING) == ESCAPED_STRING
++invalidquotedfield(x::ReturnCode) = (x & INVALID_QUOTED_FIELD) == INVALID_QUOTED_FIELD
++invaliddelimiter(x::ReturnCode) = (x & INVALID_DELIMITER) == INVALID_DELIMITER
++overflow(x::ReturnCode) = (x & OVERFLOW) == OVERFLOW
++quotednotescaped(x::ReturnCode) = (x & (QUOTED | ESCAPED_STRING)) == QUOTED
++
++memcmp(a::Ptr{UInt8}, b::Ptr{UInt8}, len::Int) = ccall(:memcmp, Cint, (Ptr{UInt8}, Ptr{UInt8}, Csize_t), a, b, len) == 0
++
++@inline function checksentinel(source::AbstractVector{UInt8}, pos, len, sentinel, debug)
++ sentinelpos = 0
++ startptr = pointer(source, pos)
++ # sentinel is an iterable of Tuple{Ptr{UInt8}, Int}, sorted from longest sentinel string to shortest
++ for (ptr, ptrlen) in sentinel
++ if pos + ptrlen - 1 <= len
++ match = memcmp(startptr, ptr, ptrlen)
++ if match
++ if debug
++ println("matched sentinel value: \"$(escape_string(unsafe_string(ptr, ptrlen)))\"")
++ end
++ sentinelpos = pos + ptrlen
++ break
++ end
++ end
++ end
++ return sentinelpos
++end
++
++@inline function checksentinel(source::IO, pos, len, sentinel, debug)
++ sentinelpos = 0
++ origpos = position(source)
++ for (ptr, ptrlen) in sentinel
++ matched = match!(source, ptr, ptrlen)
++ if matched
++ if debug
++ println("matched sentinel value: \"$(escape_string(unsafe_string(ptr, ptrlen)))\"")
++ end
++ sentinelpos = pos + ptrlen
++ break
++ end
++ end
++ fastseek!(source, origpos)
++ return sentinelpos
++end
++
++@inline function checkdelim(source::AbstractVector{UInt8}, pos, len, (ptr, ptrlen))
++ startptr = pointer(source, pos)
++ delimpos = pos
++ if pos + ptrlen - 1 <= len
++ match = memcmp(startptr, ptr, ptrlen)
++ if match
++ delimpos = pos + ptrlen
++ end
++ end
++ return delimpos
++end
++
++@inline function checkdelim(source::IO, pos, len, (ptr, ptrlen))
++ delimpos = pos
++ matched = match!(source, ptr, ptrlen)
++ if matched
++ delimpos = pos + ptrlen
++ end
++ return delimpos
++end
++
++@inline function match!(source::IO, ptr, ptrlen)
++ b = peekbyte(source)
++ c = unsafe_load(ptr)
++ if b != c
++ return false
++ elseif ptrlen == 1
++ incr!(source)
++ return true
++ end
++ pos = position(source)
++ i = 1
++ while true
++ incr!(source)
++ if Base.eof(source)
++ fastseek!(source, pos)
++ return false
++ end
++ b = peekbyte(source)
++ c = unsafe_load(ptr + i)
++ if b != c
++ fastseek!(source, pos)
++ return false
++ elseif i == ptrlen - 1
++ break
++ end
++ i += 1
++ end
++ incr!(source)
++ return true
++end
++
++"""
++ Parsers.fastseek!(io::IO, n::Integer)
++
++ Without valididty checks, seek an `IO` to desired byte position `n`. Used in Parsers.jl to
++ seek back to a previous location already parsed.
++"""
++function fastseek! end
++
++fastseek!(io::IO, n::Integer) = seek(io, n)
++function fastseek!(io::IOBuffer, n::Integer)
++ io.ptr = n + 1
++ return
++end
++fastseek!(io::AbstractVector{UInt8}, n::Integer) = nothing
++
++"""
++ Parsers.readbyte(io::IO)::UInt8
++
++ Consume a single byte from an `IO` without checking `eof(io)`.
++"""
++function readbyte end
++
++"""
++ Parsers.peekbyte(io::IO)::UInt8
++
++ Return, but do not consume, the next byte from an `IO` without checking `eof(io)`.
++"""
++function peekbyte end
++
++incr!(io::IO) = readbyte(io)
++readbyte(from::IO) = Base.read(from, UInt8)
++peekbyte(from::IO) = UInt8(Base.peek(from))
++
++function readbyte(from::IOBuffer)
++ i = from.ptr
++ @inbounds byte = from.data[i]
++ from.ptr = i + 1
++ return byte
++end
++
++function peekbyte(from::IOBuffer)
++ @inbounds byte = from.data[from.ptr]
++ return byte
++end
++
++function incr!(from::IOBuffer)
++ from.ptr += 1
++ return
++end
++
++incr!(from::AbstractVector{UInt8}) = nothing
++peekbyte(from::IO, pos) = peekbyte(from)
++function peekbyte(from::AbstractVector{UInt8}, pos)
++ @inbounds b = from[pos]
++ return b
++end
++
++eof(source::AbstractVector{UInt8}, pos::Integer, len::Integer) = pos > len
++eof(source::IO, pos::Integer, len::Integer) = Base.eof(source)
++
++function text(r)
++ str = ""
++ if r & QUOTED > 0
++ str = "encountered an opening quote character, initial value parsing "
++ else
++ str = "initial value parsing "
++ end
++ if r & OK > 0
++ str *= "succeeded"
++ else
++ str *= "failed"
++ end
++ if r & (~INVALID & OVERFLOW) > 0
++ str *= ", value overflowed"
++ end
++ if r & SENTINEL > 0
++ str *= ", a sentinel value was parsed"
++ end
++ if r & ESCAPED_STRING > 0
++ str *= ", encountered escape character"
++ end
++ if r & (~INVALID & INVALID_QUOTED_FIELD) > 0
++ str *= ", invalid quoted value"
++ end
++ if r & DELIMITED > 0
++ str *= ", a valid delimiter was parsed"
++ end
++ if r & NEWLINE > 0
++ str *= ", a newline was encountered"
++ end
++ if r & EOF > 0
++ str *= ", reached EOF"
++ end
++ if r & (~INVALID & INVALID_DELIMITER) > 0
++ str *= ", invalid delimiter"
++ end
++ return str
++end
++
++codes(r) = chop(chop(string(
++ ifelse(r > 0, "SUCCESS: ", "INVALID: "),
++ ifelse(r & OK > 0, "OK | ", ""),
++ ifelse(r & SENTINEL > 0, "SENTINEL | ", ""),
++ ifelse(r & QUOTED > 0, "QUOTED | ", ""),
++ ifelse(r & ESCAPED_STRING > 0, "ESCAPED_STRING | ", ""),
++ ifelse(r & DELIMITED > 0, "DELIMITED | ", ""),
++ ifelse(r & NEWLINE > 0, "NEWLINE | ", ""),
++ ifelse(r & EOF > 0, "EOF | ", ""),
++ ifelse(r & (~INVALID & INVALID_QUOTED_FIELD) > 0, "INVALID_QUOTED_FIELD | ", ""),
++ ifelse(r & (~INVALID & INVALID_DELIMITER) > 0, "INVALID_DELIMITER | ", ""),
++ ifelse(r & (~INVALID & OVERFLOW) > 0, "OVERFLOW | ", "")
++)))
++
++defaultdateformat(T) = Dates.dateformat""
++defaultdateformat(::Type{T}) where {T <: Dates.TimeType} = Dates.default_format(T)
++ptrlen(s::String) = (pointer(s), sizeof(s))
--- /dev/null
--- /dev/null
++using Dates
++
++@testset "Date.TimeTypes" begin
++
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "")
++@test x === Date(0)
++@test code == INVALID | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "2018-01-01")
++@test x === Date(2018, 1, 01)
++@test code == OK | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(DateTime, "2018-01-01")
++@test x === DateTime(2018, 1, 01)
++@test code == OK | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(Time, "01:02:03")
++@test x === Time(1, 2, 3)
++@test code == OK | EOF
++
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "")
++@test x === Date(0)
++@test code == INVALID | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "\"\"")
++@test x === Date(0)
++@test code == QUOTED | INVALID | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "2018-01-01")
++@test x === Date(2018, 1, 01)
++@test code == OK | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "\"2018-01-01\"")
++@test x === Date(2018, 1, 01)
++@test code == QUOTED | OK | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(DateTime, "\"2018-01-01")
++@test x === DateTime(2018, 1, 1)
++@test code == OK | QUOTED | EOF | INVALID_QUOTED_FIELD
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "\"abcd\"")
++@test x === Date(0)
++@test code == QUOTED | INVALID | EOF
++
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "NA", sentinel=["NA"])
++@test x === Date(0)
++@test code === SENTINEL | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "\\N", sentinel=["\\N"])
++@test x === Date(0)
++@test code === SENTINEL | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "NA2", sentinel=["NA"])
++@test x === Date(0)
++@test code === SENTINEL | INVALID_DELIMITER | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "-", sentinel=["-"])
++@test x === Date(0)
++@test code === SENTINEL | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "£", sentinel=["£"])
++@test x === Date(0)
++@test code === SENTINEL | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "null")
++@test x === Date(0)
++@test code === INVALID_DELIMITER | EOF
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, ",")
++@test x === Date(0)
++@test code === INVALID | DELIMITED
++x, code, vpos, vlen, tlen = Parsers.xparse(Date, "1,")
++@test x === Date(1)
++@test code === OK | DELIMITED
++
++@test Parsers.parse(DateTime, "1996/Feb/15", Parsers.Options(dateformat="yy/uuu/dd")) === DateTime(1996, 2, 15)
++@test Parsers.parse(DateTime, "1996, Jan, 15", Parsers.Options(dateformat="yyyy, uuu, dd")) === DateTime(1996, 1, 15)
++
++end
--- /dev/null
--- /dev/null
++@testset "Floats" begin
++
++x, code, vpos, vlen, vlen = Parsers.xparse(Float64, "1x")
++
++testcases = [
++ (str="", x=0.0, code=(INVALID | EOF), len=0, tot=0),
++ (str="-", x=0.0, code=(INVALID | EOF), len=1, tot=1),
++ (str="1", x=1.0, code=(OK | EOF), len=1, tot=1),
++ (str="+1", x=1.0, code=(OK | EOF), len=2, tot=2),
++ (str="1.1", x=1.1, code=(OK | EOF), len=3, tot=3),
++ (str="1.", x=1.0, code=(OK | EOF), len=2, tot=2),
++ (str="1.a", x=1.0, code=(OK | EOF | INVALID_DELIMITER), len=2, tot=2),
++ (str="1.1.", x=1.1, code=(OK | EOF | INVALID_DELIMITER), len=4, tot=4),
++ (str="1e23", x=1e23, code=(OK | EOF), len=4, tot=4),
++ (str="1E23", x=1e23, code=(OK | EOF), len=4, tot=4),
++ (str="1f23", x=1e23, code=(OK | EOF), len=4, tot=4),
++ (str="1F23", x=1e23, code=(OK | EOF), len=4, tot=4),
++ (str="428.E+03", x=428000.0, code=(OK | EOF), len=8, tot=8),
++ (str="1.0e", x=0.0, code=(INVALID | EOF), len=4, tot=4),
++ (str="1.0ea", x=0.0, code=(INVALID | EOF | INVALID_DELIMITER), len=5, tot=5),
++ (str="100000000000000000000000", x=1e23, code=(OK | EOF), len=24, tot=24),
++ (str="1e-100", x=1e-100, code=(OK | EOF), len=6, tot=6),
++ (str="123456700", x=1.234567e+08, code=(OK | EOF), len=9, tot=9),
++ (str="99999999999999974834176", x=9.999999999999997e+22, code=(OK | EOF), len=23, tot=23),
++ (str="100000000000000000000001", x=1.0000000000000001e+23, code=(OK | EOF), len=24, tot=24),
++ (str="100000000000000008388608", x=1.0000000000000001e+23, code=(OK | EOF), len=24, tot=24),
++ (str="100000000000000016777215", x=1.0000000000000001e+23, code=(OK | EOF), len=24, tot=24),
++ (str="100000000000000016777216", x=1.0000000000000003e+23, code=(OK | EOF), len=0, tot=0),
++
++ (str="-1", x=-1.0, code=(OK | EOF), len=0, tot=0),
++ (str="-0.1", x=-0.1, code=(OK | EOF), len=0, tot=0),
++ (str="-0", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="1e-20", x=1e-20, code=(OK | EOF), len=0, tot=0),
++ (str="625e-3", x=0.625, code=(OK | EOF), len=0, tot=0),
++
++ # zeros
++ (str="0", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="0e0", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="-0e0", x=-0.0, code=(OK | EOF), len=0, tot=0),
++ (str="+0e0", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="0e-0", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="-0e-0", x=-0.0, code=(OK | EOF), len=0, tot=0),
++ (str="+0e-0", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="0e+0", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="-0e+0", x=-0.0, code=(OK | EOF), len=0, tot=0),
++ (str="+0e+0", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="0e+01234567890123456789", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="0.00e-01234567890123456789", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="-0e+01234567890123456789", x=-0.0, code=(OK | EOF), len=0, tot=0),
++ (str="-0.00e-01234567890123456789", x=-0.0, code=(OK | EOF), len=0, tot=0),
++ (str="0e291", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="0e292", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="0e347", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="0e348", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="-0e291", x=-0.0, code=(OK | EOF), len=0, tot=0),
++ (str="-0e292", x=-0.0, code=(OK | EOF), len=0, tot=0),
++ (str="-0e347", x=-0.0, code=(OK | EOF), len=0, tot=0),
++ (str="-0e348", x=-0.0, code=(OK | EOF), len=0, tot=0),
++
++ # Infs/invalid NaNs
++ (str="n", x=0.0, code=(INVALID | EOF), len=1, tot=1),
++ (str="na", x=0.0, code=(INVALID | EOF), len=2, tot=2),
++ (str="n", x=0.0, code=(INVALID | EOF), len=1, tot=1),
++ (str="inf", x=Inf, code=(OK | EOF), len=0, tot=0),
++ (str="infinity", x=Inf, code=(OK | EOF), len=0, tot=0),
++ (str="-inf", x=-Inf, code=(OK | EOF), len=0, tot=0),
++ (str="-Inf", x=-Inf, code=(OK | EOF), len=0, tot=0),
++ (str="-infinity", x=-Inf, code=(OK | EOF), len=0, tot=0),
++ (str="-INFINITY", x=-Inf, code=(OK | EOF), len=0, tot=0),
++ (str="+inf", x=Inf, code=(OK | EOF), len=0, tot=0),
++ (str="i", x=0.0, code=(INVALID | EOF), len=1, tot=1),
++ (str="in", x=0.0, code=(INVALID | EOF), len=2, tot=2),
++ (str="infi", x=Inf, code=(OK | EOF), len=1, tot=1),
++ (str="infin", x=Inf, code=(OK | EOF), len=1, tot=1),
++ (str="infini", x=Inf, code=(OK | EOF), len=1, tot=1),
++ (str="infinit", x=Inf, code=(OK | EOF), len=1, tot=1),
++ (str="i,", x=0.0, code=(INVALID | DELIMITED), len=1, tot=1),
++ (str="in,", x=0.0, code=(INVALID | DELIMITED), len=2, tot=2),
++ (str="infi,", x=Inf, code=(OK | DELIMITED), len=1, tot=1),
++ (str="infin,", x=Inf, code=(OK | DELIMITED), len=1, tot=1),
++ (str="infini,", x=Inf, code=(OK | DELIMITED), len=1, tot=1),
++ (str="infinit,", x=Inf, code=(OK | DELIMITED), len=1, tot=1),
++
++ # largest float64
++ (str="1.7976931348623157e308", x=1.7976931348623157e+308, code=(OK | EOF), len=0, tot=0),
++ (str="-1.7976931348623157e308", x=-1.7976931348623157e+308, code=(OK | EOF), len=0, tot=0),
++ # next float64 - too large
++ (str="1.7976931348623159e308", x=+Inf, code=(OK | EOF), len=0, tot=0),
++ (str="-1.7976931348623159e308", x=-Inf, code=(OK | EOF), len=0, tot=0),
++ # the border is ...158079
++ # borderline - okay
++ (str="1.7976931348623158e308", x=1.7976931348623157e+308, code=(OK | EOF), len=0, tot=0),
++ (str="-1.7976931348623158e308", x=-1.7976931348623157e+308, code=(OK | EOF), len=0, tot=0),
++ # borderline - too large
++ (str="1.797693134862315808e308", x=+Inf, code=(OK | EOF), len=0, tot=0),
++ (str="-1.797693134862315808e308", x=-Inf, code=(OK | EOF), len=0, tot=0),
++
++ # a little too large
++ (str="1e308", x=1e+308, code=(OK | EOF), len=0, tot=0),
++ (str="2e308", x=+Inf, code=(OK | EOF), len=0, tot=0),
++ (str="1e309", x=+Inf, code=(OK | EOF), len=0, tot=0),
++
++ # way too large
++ (str="1e310", x=+Inf, code=(OK | EOF), len=0, tot=0),
++ (str="-1e310", x=-Inf, code=(OK | EOF), len=0, tot=0),
++ (str="1e400", x=+Inf, code=(OK | EOF), len=0, tot=0),
++ (str="-1e400", x=-Inf, code=(OK | EOF), len=0, tot=0),
++ (str="1e400000", x=+Inf, code=(OK | EOF), len=0, tot=0),
++ (str="-1e400000", x=-Inf, code=(OK | EOF), len=0, tot=0),
++
++ # denormalized
++ (str="1e-305", x=1e-305, code=(OK | EOF), len=0, tot=0),
++ (str="1e-306", x=1e-306, code=(OK | EOF), len=0, tot=0),
++ (str="1e-307", x=1e-307, code=(OK | EOF), len=0, tot=0),
++ (str="1e-308", x=1e-308, code=(OK | EOF), len=0, tot=0),
++ (str="1e-309", x=1e-309, code=(OK | EOF), len=0, tot=0),
++ (str="1e-310", x=1e-310, code=(OK | EOF), len=0, tot=0),
++ (str="1e-322", x=1e-322, code=(OK | EOF), len=0, tot=0),
++ # smallest denormal
++ (str="5e-324", x=5e-324, code=(OK | EOF), len=0, tot=0),
++ (str="4e-324", x=5e-324, code=(OK | EOF), len=0, tot=0),
++ (str="3e-324", x=5e-324, code=(OK | EOF), len=0, tot=0),
++ # too small
++ (str="2e-324", x=0.0, code=(OK | EOF), len=0, tot=0),
++ # way too small
++ (str="1e-350", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="1e-400000", x=0.0, code=(OK | EOF), len=0, tot=0),
++
++ # try to overflow exponent
++ (str="1e-4294967296", x=0.0, code=(OK | EOF), len=0, tot=0),
++ (str="1e+4294967296", x=+Inf, code=(OK | EOF), len=0, tot=0),
++ (str="1e-18446744073709551616", x=0.0, code=(OK | EOF), len=0, tot=0),
++
++ (str="1e+18446744073709551616", x=+Inf, code=(OK | EOF), len=0, tot=0),
++
++ # Parse errors
++ # (str="1e", x=missing, code=(INVALID | EOF), len=0, tot=0),
++ # (str="1e-", x=missing, code=(INVALID | EOF), len=0, tot=0),
++ # (str=".e-1", x=missing, code=(INVALID | EOF), len=0, tot=0),
++ # (str="1\x00.2", x=1.0, code=(OK), len=0, tot=0),
++
++ # http:#www.exploringbinary.com/java-hangs-when-converting-2-2250738585072012e-308/
++ (str="2.2250738585072012e-308", x=2.2250738585072014e-308, code=(OK | EOF), len=0, tot=0),
++ # http://www.exploringbinary.com/php-hangs-on-numeric-value-2-2250738585072011e-308/
++ (str="2.2250738585072011e-308", x=2.225073858507201e-308, code=(OK | EOF), len=0, tot=0),
++
++ # A very large number (initially wrongly parsed by the fast algorithm).
++ (str="4.630813248087435e+307", x=4.630813248087435e+307, code=(OK | EOF), len=0, tot=0),
++
++ # A different kind of very large number.
++ (str="22.222222222222222", x=22.22222222222222, code=(OK | EOF), len=0, tot=0),
++
++ # Exactly halfway between 1 and math.Nextafter(1, 2).
++ # Round to even (down).
++ (str="1.00000000000000011102230246251565404236316680908203125", x=1.0, code=(OK | EOF), len=0, tot=0),
++ # # Slightly lower; still round down.
++ (str="1.00000000000000011102230246251565404236316680908203124", x=1.0, code=(OK | EOF), len=0, tot=0),
++ # # Slightly higher; round up.
++ (str="1.00000000000000011102230246251565404236316680908203126", x=1.0000000000000002, code=(OK | EOF), len=0, tot=0),
++
++ (str="-5.871153289887625082e-01", x=-5.871153289887625082e-01, code=(OK | EOF), len=0, tot=0),
++ (str="8.095032986136727615e-01", x=8.095032986136727615e-01, code=(OK | EOF), len=0, tot=0),
++ (str="9.900000000000006573e-01", x=9.900000000000006573e-01, code=(OK | EOF), len=0, tot=0),
++ (str="9.900000000000006573e-01", x=9.900000000000006573e-01, code=(OK | EOF), len=0, tot=0),
++ (str="-9.866066418838319585e-01", x=-9.866066418838319585e-01, code=(OK | EOF), len=0, tot=0),
++ (str="-3.138907529596844714e+00", x=-3.138907529596844714e+00, code=(OK | EOF), len=0, tot=0),
++ (str="-5.129218106887371675e+00", x=-5.129218106887371675e+00, code=(OK | EOF), len=0, tot=0),
++ (str="-4.803915800699462224e+00", x=-4.803915800699462224e+00, code=(OK | EOF), len=0, tot=0),
++
++ # issue #18
++ (str=".24409E+03", x=244.09, code=(OK | EOF), len=0, tot=0),
++ (str=".24409E+03 ", x=244.09, code=(OK | EOF), len=0, tot=0),
++ (str="-.2", x=-0.2, code=(OK | EOF), len=0, tot=0),
++ (str=".2", x=0.2, code=(OK | EOF), len=0, tot=0),
++
++ # from https://www.icir.org/vern/papers/testbase-report.pdf
++ (str=string(5.0 * exp10(+125)), x=(5.0 * exp10(+125)), code=(OK | EOF), len=0, tot=0),
++ (str=string(69.0 * exp10(+267)), x=(69.0 * exp10(+267)), code=(OK | EOF), len=0, tot=0),
++ (str=string(999.0 * exp10(-26)), x=(999.0 * exp10(-26)), code=(OK | EOF), len=0, tot=0),
++ (str=string(7861.0 * exp10(-34)), x=(7861.0 * exp10(-34)), code=(OK | EOF), len=0, tot=0),
++ (str=string(75569.0 * exp10(-254)), x=(75569.0 * exp10(-254)), code=(OK | EOF), len=0, tot=0),
++ (str=string(928609.0 * exp10(-261)), x=(928609.0 * exp10(-261)), code=(OK | EOF), len=0, tot=0),
++ (str=string(9210917.0 * exp10(+80)), x=(9210917.0 * exp10(+80)), code=(OK | EOF), len=0, tot=0),
++ (str=string(84863171.0 * exp10(+114)), x=(84863171.0 * exp10(+114)), code=(OK | EOF), len=0, tot=0),
++ (str=string(653777767.0 * exp10(+273)), x=(653777767.0 * exp10(+273)), code=(OK | EOF), len=0, tot=0),
++ (str=string(5232604057.0 * exp10(-298)), x=(5232604057.0 * exp10(-298)), code=(OK | EOF), len=0, tot=0),
++ (str=string(27235667517.0 * exp10(-109)), x=(27235667517.0 * exp10(-109)), code=(OK | EOF), len=0, tot=0),
++ (str=string(653532977297.0 * exp10(-123)), x=(653532977297.0 * exp10(-123)), code=(OK | EOF), len=0, tot=0),
++ (str=string(3142213164987.0 * exp10(-294)), x=(3142213164987.0 * exp10(-294)), code=(OK | EOF), len=0, tot=0),
++ (str=string(46202199371337.0 * exp10(-72)), x=(46202199371337.0 * exp10(-72)), code=(OK | EOF), len=0, tot=0),
++ (str=string(231010996856685.0 * exp10(-73)), x=(231010996856685.0 * exp10(-73)), code=(OK | EOF), len=0, tot=0),
++ (str=string(9324754620109615.0 * exp10(+212)), x=(9324754620109615.0 * exp10(+212)), code=(OK | EOF), len=0, tot=0),
++ (str=string(78459735791271921.0 * exp10(+49)), x=(78459735791271921.0 * exp10(+49)), code=(OK | EOF), len=0, tot=0),
++ (str=string(272104041512242479.0 * exp10(+200)), x=(272104041512242479.0 * exp10(+200)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6802601037806061975.0 * exp10(+198)), x=(6802601037806061975.0 * exp10(+198)), code=(OK | EOF), len=0, tot=0),
++ (str=string(20505426358836677347.0 * exp10(-221)), x=(20505426358836677347.0 * exp10(-221)), code=(OK | EOF), len=0, tot=0),
++ (str=string(836168422905420598437.0 * exp10(-234)), x=(836168422905420598437.0 * exp10(-234)), code=(OK | EOF), len=0, tot=0),
++ (str=string(4891559871276714924261.0 * exp10(+222)), x=(4891559871276714924261.0 * exp10(+222)), code=(OK | EOF), len=0, tot=0),
++
++ (str=string(9.0 * exp10(-265)), x=(9.0 * exp10(-265)), code=(OK | EOF), len=0, tot=0),
++ (str=string(85.0 * exp10(-037)), x=(85.0 * exp10(-037)), code=(OK | EOF), len=0, tot=0),
++ (str=string(623.0 * exp10(+100)), x=(623.0 * exp10(+100)), code=(OK | EOF), len=0, tot=0),
++ (str=string(3571.0 * exp10(+263)), x=(3571.0 * exp10(+263)), code=(OK | EOF), len=0, tot=0),
++ (str=string(81661.0 * exp10(+153)), x=(81661.0 * exp10(+153)), code=(OK | EOF), len=0, tot=0),
++ (str=string(920657.0 * exp10(-023)), x=(920657.0 * exp10(-023)), code=(OK | EOF), len=0, tot=0),
++ (str=string(4603285.0 * exp10(-024)), x=(4603285.0 * exp10(-024)), code=(OK | EOF), len=0, tot=0),
++ (str=string(87575437.0 * exp10(-309)), x=(87575437.0 * exp10(-309)), code=(OK | EOF), len=0, tot=0),
++ (str=string(245540327.0 * exp10(+122)), x=(245540327.0 * exp10(+122)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6138508175.0 * exp10(+120)), x=(6138508175.0 * exp10(+120)), code=(OK | EOF), len=0, tot=0),
++ (str=string(83356057653.0 * exp10(+193)), x=(83356057653.0 * exp10(+193)), code=(OK | EOF), len=0, tot=0),
++ (str=string(619534293513.0 * exp10(+124)), x=(619534293513.0 * exp10(+124)), code=(OK | EOF), len=0, tot=0),
++ (str=string(2335141086879.0 * exp10(+218)), x=(2335141086879.0 * exp10(+218)), code=(OK | EOF), len=0, tot=0),
++ (str=string(36167929443327.0 * exp10(-159)), x=(36167929443327.0 * exp10(-159)), code=(OK | EOF), len=0, tot=0),
++ (str=string(609610927149051.0 * exp10(-255)), x=(609610927149051.0 * exp10(-255)), code=(OK | EOF), len=0, tot=0),
++ (str=string(3743626360493413.0 * exp10(-165)), x=(3743626360493413.0 * exp10(-165)), code=(OK | EOF), len=0, tot=0),
++ (str=string(94080055902682397.0 * exp10(-242)), x=(94080055902682397.0 * exp10(-242)), code=(OK | EOF), len=0, tot=0),
++ (str=string(899810892172646163.0 * exp10(+283)), x=(899810892172646163.0 * exp10(+283)), code=(OK | EOF), len=0, tot=0),
++ (str=string(7120190517612959703.0 * exp10(+120)), x=(7120190517612959703.0 * exp10(+120)), code=(OK | EOF), len=0, tot=0),
++ (str=string(25188282901709339043.0 * exp10(-252)), x=(25188282901709339043.0 * exp10(-252)), code=(OK | EOF), len=0, tot=0),
++ (str=string(308984926168550152811.0 * exp10(-052)), x=(308984926168550152811.0 * exp10(-052)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6372891218502368041059.0 * exp10(+064)), x=(6372891218502368041059.0 * exp10(+064)), code=(OK | EOF), len=0, tot=0),
++
++ (str=string(8511030020275656.0 * exp2(-0342)), x=(8511030020275656.0 * exp2(-0342)), code=(OK | EOF), len=0, tot=0),
++ (str=string(5201988407066741.0 * exp2(-0824)), x=(5201988407066741.0 * exp2(-0824)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6406892948269899.0 * exp2(+0237)), x=(6406892948269899.0 * exp2(+0237)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8431154198732492.0 * exp2(+0072)), x=(8431154198732492.0 * exp2(+0072)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6475049196144587.0 * exp2(+0099)), x=(6475049196144587.0 * exp2(+0099)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8274307542972842.0 * exp2(+0726)), x=(8274307542972842.0 * exp2(+0726)), code=(OK | EOF), len=0, tot=0),
++ (str=string(5381065484265332.0 * exp2(-0456)), x=(5381065484265332.0 * exp2(-0456)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6761728585499734.0 * exp2(-1057)), x=(6761728585499734.0 * exp2(-1057)), code=(OK | EOF), len=0, tot=0),
++ (str=string(7976538478610756.0 * exp2(+0376)), x=(7976538478610756.0 * exp2(+0376)), code=(OK | EOF), len=0, tot=0),
++ (str=string(5982403858958067.0 * exp2(+0377)), x=(5982403858958067.0 * exp2(+0377)), code=(OK | EOF), len=0, tot=0),
++ (str=string(5536995190630837.0 * exp2(+0093)), x=(5536995190630837.0 * exp2(+0093)), code=(OK | EOF), len=0, tot=0),
++ (str=string(7225450889282194.0 * exp2(+0710)), x=(7225450889282194.0 * exp2(+0710)), code=(OK | EOF), len=0, tot=0),
++ (str=string(7225450889282194.0 * exp2(+0709)), x=(7225450889282194.0 * exp2(+0709)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8703372741147379.0 * exp2(+0117)), x=(8703372741147379.0 * exp2(+0117)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8944262675275217.0 * exp2(-1001)), x=(8944262675275217.0 * exp2(-1001)), code=(OK | EOF), len=0, tot=0),
++ (str=string(7459803696087692.0 * exp2(-0707)), x=(7459803696087692.0 * exp2(-0707)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6080469016670379.0 * exp2(-0381)), x=(6080469016670379.0 * exp2(-0381)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8385515147034757.0 * exp2(+0721)), x=(8385515147034757.0 * exp2(+0721)), code=(OK | EOF), len=0, tot=0),
++ (str=string(7514216811389786.0 * exp2(-0828)), x=(7514216811389786.0 * exp2(-0828)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8397297803260511.0 * exp2(-0345)), x=(8397297803260511.0 * exp2(-0345)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6733459239310543.0 * exp2(+0202)), x=(6733459239310543.0 * exp2(+0202)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8091450587292794.0 * exp2(-0473)), x=(8091450587292794.0 * exp2(-0473)), code=(OK | EOF), len=0, tot=0),
++
++ (str=string(6567258882077402.0 * exp2(+952)), x=(6567258882077402.0 * exp2(+952)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6712731423444934.0 * exp2(+535)), x=(6712731423444934.0 * exp2(+535)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6712731423444934.0 * exp2(+534)), x=(6712731423444934.0 * exp2(+534)), code=(OK | EOF), len=0, tot=0),
++ (str=string(5298405411573037.0 * exp2(-957)), x=(5298405411573037.0 * exp2(-957)), code=(OK | EOF), len=0, tot=0),
++ (str=string(5137311167659507.0 * exp2(-144)), x=(5137311167659507.0 * exp2(-144)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6722280709661868.0 * exp2(+363)), x=(6722280709661868.0 * exp2(+363)), code=(OK | EOF), len=0, tot=0),
++ (str=string(5344436398034927.0 * exp2(-169)), x=(5344436398034927.0 * exp2(-169)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8369123604277281.0 * exp2(-853)), x=(8369123604277281.0 * exp2(-853)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8995822108487663.0 * exp2(-780)), x=(8995822108487663.0 * exp2(-780)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8942832835564782.0 * exp2(-383)), x=(8942832835564782.0 * exp2(-383)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8942832835564782.0 * exp2(-384)), x=(8942832835564782.0 * exp2(-384)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8942832835564782.0 * exp2(-385)), x=(8942832835564782.0 * exp2(-385)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6965949469487146.0 * exp2(-249)), x=(6965949469487146.0 * exp2(-249)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6965949469487146.0 * exp2(-250)), x=(6965949469487146.0 * exp2(-250)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6965949469487146.0 * exp2(-251)), x=(6965949469487146.0 * exp2(-251)), code=(OK | EOF), len=0, tot=0),
++ (str=string(7487252720986826.0 * exp2(+548)), x=(7487252720986826.0 * exp2(+548)), code=(OK | EOF), len=0, tot=0),
++ (str=string(5592117679628511.0 * exp2(+164)), x=(5592117679628511.0 * exp2(+164)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8887055249355788.0 * exp2(+665)), x=(8887055249355788.0 * exp2(+665)), code=(OK | EOF), len=0, tot=0),
++ (str=string(6994187472632449.0 * exp2(+690)), x=(6994187472632449.0 * exp2(+690)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8797576579012143.0 * exp2(+588)), x=(8797576579012143.0 * exp2(+588)), code=(OK | EOF), len=0, tot=0),
++ (str=string(7363326733505337.0 * exp2(+272)), x=(7363326733505337.0 * exp2(+272)), code=(OK | EOF), len=0, tot=0),
++ (str=string(8549497411294502.0 * exp2(-448)), x=(8549497411294502.0 * exp2(-448)), code=(OK | EOF), len=0, tot=0),
++];
++
++for (i, case) in enumerate(testcases)
++ x, code, vpos, vlen, tlen = Parsers.xparse(Float64, case.str)
++ if x != case.x || code != case.code #|| len != case.len || tlen != case.tlen
++ println("ERROR on case=$i, $case")
++ x, code, vpos, vlen, tlen = Parsers.xparse(Float64, case.str; debug=Val(true))
++ end
++ @test x == case.x
++ @test code == case.code
++ # @test len == case.len
++ # @test tlen == case.tlen
++end
++
++# NaNs
++case = (str="nan", x=NaN, code=(OK | EOF), len=3, tot=3)
++x, code, vpos, vlen, tlen = Parsers.xparse(Float64, case.str)
++@test isnan(x)
++@test code == case.code
++@test vlen == tlen == 3
++case = (str="NaN", x=NaN, code=(OK | EOF), len=3, tot=3)
++x, code, vpos, vlen, tlen = Parsers.xparse(Float64, case.str)
++@test isnan(x)
++@test code == case.code
++@test vlen == tlen == 3
++case = (str="NAN", x=NaN, code=(OK | EOF), len=3, tot=3)
++x, code, vpos, vlen, tlen = Parsers.xparse(Float64, case.str)
++@test isnan(x)
++@test code == case.code
++@test vlen == tlen == 3
++case = (str="nAN", x=NaN, code=(OK | EOF), len=3, tot=3)
++x, code, vpos, vlen, tlen = Parsers.xparse(Float64, case.str)
++@test isnan(x)
++@test code == case.code
++@test vlen == tlen == 3
++case = (str="nAN,", x=NaN, code=(OK | DELIMITED), len=4, tot=4)
++x, code, vpos, vlen, tlen = Parsers.xparse(Float64, case.str)
++@test isnan(x)
++@test code == case.code
++@test vlen == 3
++@test tlen == 4
++
++# #25
++case = (str="74810199.033988851037472901827191090834", x=7.481019903398885e7, code=(OK | EOF))
++x, code, vpos, vlen, tlen = Parsers.xparse(Float64, case.str)
++@test x == case.x
++@test code == case.code
++@test vlen == tlen == 39
++
++end # @testset
--- /dev/null
--- /dev/null
++using Parsers, Test, Dates
++
++import Parsers: INVALID, OK, SENTINEL, QUOTED, DELIMITED, NEWLINE, EOF, INVALID_QUOTED_FIELD, INVALID_DELIMITER, OVERFLOW, ESCAPED_STRING
++
++@testset "Parsers" begin
++
++@testset "Core Parsers.xparse" begin
++
++sentinels = ["NANA", "NAN", "NA"]
++
++testcases = [
++ (str="", kwargs=(), x=0, code=(INVALID | EOF), vpos=1, vlen=0, tlen=0),
++ (str="", kwargs=(sentinel=missing,), x=0, code=(SENTINEL | EOF), vpos=1, vlen=0, tlen=0),
++ (str=" ", kwargs=(), x=0, code=(INVALID | EOF), vpos=1, vlen=0, tlen=1),
++ (str=" ", kwargs=(sentinel=missing,), x=0, code=(INVALID | EOF), vpos=1, vlen=0, tlen=1),
++ (str=" -", kwargs=(sentinel=missing,), x=0, code=(INVALID | EOF), vpos=1, vlen=2, tlen=2),
++ (str=" +", kwargs=(sentinel=missing,), x=0, code=(INVALID | EOF), vpos=1, vlen=2, tlen=2),
++ (str="-", kwargs=(sentinel=missing,), x=0, code=(INVALID | EOF), vpos=1, vlen=1, tlen=1),
++ (str=" {-", kwargs=(sentinel=missing,), x=0, code=(QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=3, vlen=1, tlen=3),
++ (str="{+", kwargs=(sentinel=missing,), x=0, code=(QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=2, vlen=1, tlen=2),
++ (str=" {+,", kwargs=(sentinel=missing,), x=0, code=(QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=3, vlen=1, tlen=4),
++ (str="{-,", kwargs=(sentinel=missing,), x=0, code=(QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=2, vlen=1, tlen=3),
++ (str="+,", kwargs=(sentinel=missing,), x=0, code=(INVALID | DELIMITED), vpos=1, vlen=1, tlen=2),
++ (str="-,", kwargs=(sentinel=missing,), x=0, code=(INVALID | DELIMITED), vpos=1, vlen=1, tlen=2),
++ (str=" {-},", kwargs=(sentinel=missing,), x=0, code=(INVALID | QUOTED | DELIMITED), vpos=3, vlen=1, tlen=5),
++ (str="{+} ,", kwargs=(sentinel=missing,), x=0, code=(INVALID | QUOTED | DELIMITED), vpos=2, vlen=1, tlen=5),
++ (str="{", kwargs=(), x=0, code=(QUOTED | INVALID_QUOTED_FIELD), vpos=2, vlen=-1, tlen=1),
++ (str="{}", kwargs=(), x=0, code=(INVALID | QUOTED | EOF), vpos=2, vlen=0, tlen=2),
++ (str=" {", kwargs=(), x=0, code=(QUOTED | INVALID_QUOTED_FIELD), vpos=3, vlen=-2, tlen=2),
++ (str=" {\\\\", kwargs=(), x=0, code=(QUOTED | INVALID_QUOTED_FIELD | ESCAPED_STRING | EOF), vpos=3, vlen=0, tlen=4),
++ (str=" {\\}} ", kwargs=(), x=0, code=(QUOTED | INVALID | ESCAPED_STRING | EOF), vpos=3, vlen=2, tlen=6),
++ (str=" {\\\\}", kwargs=(), x=0, code=(INVALID | QUOTED | ESCAPED_STRING | EOF), vpos=3, vlen=2, tlen=5),
++
++ (str=" {}", kwargs=(), x=0, code=(INVALID | QUOTED | EOF), vpos=3, vlen=0, tlen=3),
++ (str=" { }", kwargs=(), x=0, code=(INVALID | QUOTED | EOF), vpos=3, vlen=1, tlen=4),
++ (str=" {,} ", kwargs=(), x=0, code=(INVALID | QUOTED | EOF), vpos=3, vlen=1, tlen=5),
++ (str=" { } ", kwargs=(), x=0, code=(INVALID | QUOTED | EOF), vpos=3, vlen=1, tlen=5),
++ (str=" {\t", kwargs=(), x=0, code=(INVALID_QUOTED_FIELD | QUOTED | EOF), vpos=3, vlen=-2, tlen=3),
++
++ (str="NA", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | EOF), vpos=1, vlen=2, tlen=2),
++ (str="£", kwargs=(sentinel=["£"],), x=0, code=(SENTINEL | EOF), vpos=1, vlen=2, tlen=2),
++ (str="NA2", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | EOF | INVALID_DELIMITER), vpos=1, vlen=3, tlen=3),
++ (str="NAN", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | EOF), vpos=1, vlen=3, tlen=3),
++ (str="NANA", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | EOF), vpos=1, vlen=4, tlen=4),
++ (str=" NA", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | EOF), vpos=1, vlen=3, tlen=3),
++ (str="{NAN", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | EOF | QUOTED | INVALID_QUOTED_FIELD), vpos=2, vlen=3, tlen=4),
++ (str="{NANA}", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | QUOTED | EOF), vpos=2, vlen=4, tlen=6),
++ (str=" {NA", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=3, vlen=2, tlen=4),
++ (str=" {NANA}", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | QUOTED | EOF), vpos=3, vlen=4, tlen=7),
++ (str=" { NAN}", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | QUOTED | EOF), vpos=3, vlen=4, tlen=7),
++ (str=" {NAN }", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | QUOTED | EOF), vpos=3, vlen=4, tlen=7),
++ (str=" {NA} ", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | QUOTED | EOF), vpos=3, vlen=2, tlen=6),
++ (str=" { NANA} ", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | QUOTED | EOF), vpos=3, vlen=5, tlen=9),
++ (str=" {\tNA", kwargs=(sentinel=sentinels,), x=0, code=(SENTINEL | EOF | QUOTED | INVALID_QUOTED_FIELD), vpos=3, vlen=3, tlen=5),
++
++ (str="-", kwargs=(sentinel=["-"],), x=0, code=(SENTINEL | EOF), vpos=1, vlen=1, tlen=1),
++ (str=" +", kwargs=(sentinel=["+"],), x=0, code=(SENTINEL | EOF), vpos=1, vlen=2, tlen=2),
++ (str="+1 ", kwargs=(sentinel=["+1"],), x=1, code=(SENTINEL | EOF), vpos=1, vlen=3, tlen=3),
++ (str=" -1 ", kwargs=(sentinel=["-1"],), x=-1, code=(SENTINEL | EOF), vpos=1, vlen=4, tlen=4),
++ (str="{1", kwargs=(sentinel=["1"],), x=1, code=(SENTINEL | EOF | QUOTED | INVALID_QUOTED_FIELD), vpos=2, vlen=1, tlen=2),
++ (str="{1 ", kwargs=(sentinel=["1"],), x=1, code=(SENTINEL | EOF | QUOTED | INVALID_QUOTED_FIELD), vpos=2, vlen=2, tlen=3),
++ (str="{-1}", kwargs=(sentinel=["-1"],), x=-1, code=(SENTINEL | QUOTED | EOF), vpos=2, vlen=2, tlen=4),
++ (str=" {+1", kwargs=(sentinel=["+1"],), x=1, code=(SENTINEL | EOF | QUOTED | INVALID_QUOTED_FIELD), vpos=3, vlen=2, tlen=4),
++ (str=" {-}", kwargs=(sentinel=["-"],), x=0, code=(SENTINEL | QUOTED | EOF), vpos=3, vlen=1, tlen=4),
++ (str=" { +}", kwargs=(sentinel=["+"],), x=0, code=(SENTINEL | QUOTED | EOF), vpos=3, vlen=2, tlen=5),
++ (str=" {-1 }", kwargs=(sentinel=["-1"],), x=-1, code=(SENTINEL | QUOTED | EOF), vpos=3, vlen=3, tlen=6),
++ (str=" {+1} ", kwargs=(sentinel=["+1"],), x=1, code=(SENTINEL | QUOTED | EOF), vpos=3, vlen=2, tlen=6),
++ (str=" { 1} ", kwargs=(sentinel=["1"],), x=1, code=(SENTINEL | QUOTED | EOF), vpos=3, vlen=2, tlen=6),
++ (str=" {\t-", kwargs=(sentinel=["-"],), x=0, code=(SENTINEL | EOF | QUOTED | INVALID_QUOTED_FIELD), vpos=3, vlen=2, tlen=4),
++
++ (str="+a ", kwargs=(sentinel=["+1"],), x=0, code=(INVALID | EOF | INVALID_DELIMITER), vpos=1, vlen=3, tlen=3),
++ (str=" -a ", kwargs=(sentinel=["-1"],), x=0, code=(INVALID | EOF | INVALID_DELIMITER), vpos=1, vlen=4, tlen=4),
++ (str="{a", kwargs=(sentinel=["1"],), x=0, code=(INVALID | EOF | QUOTED | INVALID_QUOTED_FIELD), vpos=2, vlen=0, tlen=2),
++ (str="{-a}", kwargs=(sentinel=["-1"],), x=0, code=(INVALID | EOF | QUOTED), vpos=2, vlen=2, tlen=4),
++ (str=" {+1a", kwargs=(sentinel=["+1"],), x=1, code=(SENTINEL | QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=3, vlen=2, tlen=5),
++ (str=" {-1a }", kwargs=(sentinel=["-1"],), x=-1, code=(SENTINEL | QUOTED | INVALID | EOF), vpos=3, vlen=4, tlen=7),
++ (str=" {+a} ", kwargs=(sentinel=["+1"],), x=0, code=(INVALID | QUOTED | EOF), vpos=3, vlen=2, tlen=6),
++ (str=" { a} ", kwargs=(sentinel=["1"],), x=0, code=(INVALID | QUOTED | EOF), vpos=3, vlen=2, tlen=6),
++
++ (str="-", kwargs=(), x=0, code=(INVALID | EOF), vpos=1, vlen=1, tlen=1),
++ (str="0", kwargs=(), x=0, code=(OK | EOF), vpos=1, vlen=1, tlen=1),
++ (str=" +", kwargs=(), x=0, code=(INVALID | EOF), vpos=1, vlen=2, tlen=2),
++ (str=" +1", kwargs=(), x=1, code=(OK | EOF), vpos=1, vlen=3, tlen=3),
++ (str="-1 ", kwargs=(), x=-1, code=(OK | EOF), vpos=1, vlen=3, tlen=3),
++ (str=" +1 ", kwargs=(), x=1, code=(OK | EOF), vpos=1, vlen=4, tlen=4),
++ (str="{1", kwargs=(), x=1, code=(OK | QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=2, vlen=1, tlen=2),
++ (str="{1 ", kwargs=(), x=1, code=(OK | QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=2, vlen=2, tlen=3),
++ (str="{-1}", kwargs=(), x=-1, code=(OK | QUOTED | EOF), vpos=2, vlen=2, tlen=4),
++ (str=" {+1", kwargs=(), x=1, code=(OK | QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=3, vlen=2, tlen=4),
++ (str=" {-}", kwargs=(), x=0, code=(INVALID | QUOTED | EOF), vpos=3, vlen=1, tlen=4),
++ (str=" { +}", kwargs=(), x=0, code=(INVALID | QUOTED | EOF), vpos=3, vlen=2, tlen=5),
++ (str=" {-1 }", kwargs=(), x=-1, code=(OK | QUOTED | EOF), vpos=3, vlen=3, tlen=6),
++ (str=" {+1} ", kwargs=(), x=1, code=(OK | QUOTED | EOF), vpos=3, vlen=2, tlen=6),
++ (str=" { 1} ", kwargs=(), x=1, code=(OK | QUOTED | EOF), vpos=3, vlen=2, tlen=6),
++ (str=" {\t-", kwargs=(), x=0, code=(QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=3, vlen=2, tlen=4),
++ (str="{1ab\\\\c}", kwargs=(), x=1, code=(OK | QUOTED | ESCAPED_STRING | EOF | INVALID), vpos=2, vlen=6, tlen=8),
++ (str="{1\\\\abc,", kwargs=(), x=1, code=(OK | QUOTED | ESCAPED_STRING | EOF | INVALID_QUOTED_FIELD), vpos=2, vlen=6, tlen=8),
++ (str="{1abc},", kwargs=(sentinel=["1abc"],), x=1, code=(SENTINEL | QUOTED | DELIMITED), vpos=2, vlen=4, tlen=7),
++ (str="{1abc", kwargs=(sentinel=["1abc"],), x=1, code=(SENTINEL | QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=2, vlen=4, tlen=5),
++
++ (str="922337203,", kwargs=(sentinel=["92233"],), x=922337203, code=(OK | DELIMITED), vpos=1, vlen=9, tlen=10),
++ (str="92233,", kwargs=(sentinel=["92233"],), x=92233, code=(SENTINEL | DELIMITED), vpos=1, vlen=5, tlen=6),
++ (str="92233 ", kwargs=(sentinel=["92233"],), x=92233, code=(SENTINEL | EOF), vpos=1, vlen=7, tlen=7),
++ (str="{92233 ,", kwargs=(sentinel=["92233"],), x=92233, code=(SENTINEL | QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=2, vlen=7, tlen=9),
++ (str="{92233} ,", kwargs=(sentinel=["92233"],), x=92233, code=(SENTINEL | QUOTED | DELIMITED), vpos=2, vlen=5, tlen=9),
++ (str=" { 92233 },", kwargs=(sentinel=["92233"],), x=92233, code=(SENTINEL | QUOTED | DELIMITED), vpos=3, vlen=7, tlen=11),
++ (str="922337203685477580", kwargs=(), x=922337203685477580, code=(OK | EOF), vpos=1, vlen=18, tlen=18),
++ (str="9223372036854775808", kwargs=(), x=-9223372036854775808, code=(OVERFLOW | EOF), vpos=1, vlen=19, tlen=19),
++ (str="9223372036854775808a", kwargs=(sentinel=["9223372036854775808a"],), x=-9223372036854775808, code=(SENTINEL | EOF), vpos=1, vlen=20, tlen=20),
++ (str="{9223372036854775808a", kwargs=(sentinel=["9223372036854775808a"],), x=-9223372036854775808, code=(SENTINEL | QUOTED | EOF | INVALID_QUOTED_FIELD), vpos=2, vlen=20, tlen=21),
++
++ (str="{9223372036854775808", kwargs=(), x=-9223372036854775808, code=(OVERFLOW | EOF | QUOTED | INVALID_QUOTED_FIELD), vpos=2, vlen=19, tlen=20),
++ (str="{9223372036854775807", kwargs=(), x=9223372036854775807, code=(OK | EOF | QUOTED | INVALID_QUOTED_FIELD), vpos=2, vlen=19, tlen=20),
++ (str="{9223372036854775807a", kwargs=(), x=9223372036854775807, code=(OK | EOF | QUOTED | INVALID_QUOTED_FIELD), vpos=2, vlen=19, tlen=21),
++ (str="9223372036854775807a", kwargs=(), x=9223372036854775807, code=(OK | EOF | INVALID_DELIMITER), vpos=1, vlen=20, tlen=20),
++ (str="9223372036854775807,", kwargs=(), x=9223372036854775807, code=(OK | DELIMITED), vpos=1, vlen=19, tlen=20),
++ (str="9223372036854775807", kwargs=(sentinel=["9223372036854775807"],), x=9223372036854775807, code=(SENTINEL | EOF), vpos=1, vlen=19, tlen=19),
++ (str="{9223372036854775807a", kwargs=(sentinel=["9223372036854775807a"],), x=9223372036854775807, code=(SENTINEL | EOF | QUOTED | INVALID_QUOTED_FIELD), vpos=2, vlen=20, tlen=21),
++
++ (str="9223372036854775808", kwargs=(sentinel=["92233"],), x=-9223372036854775808, code=(OVERFLOW | EOF), vpos=1, vlen=19, tlen=19),
++ (str="922337203685477580", kwargs=(sentinel=["92233"],), x=922337203685477580, code=(OK | EOF), vpos=1, vlen=18, tlen=18),
++ (str="922337203685477580,", kwargs=(), x=922337203685477580, code=(OK | DELIMITED), vpos=1, vlen=18, tlen=19),
++ (str="922337203685477580,", kwargs=(sentinel=["92233"],), x=922337203685477580, code=(OK | DELIMITED), vpos=1, vlen=18, tlen=19),
++ (str="9223372036854775800000,", kwargs=(sentinel=["92233"],), x=-80, code=(DELIMITED | INVALID_DELIMITER | OVERFLOW), vpos=1, vlen=22, tlen=23),
++
++ (str="1;", kwargs=(), x=1, code=(OK | EOF | INVALID_DELIMITER), vpos=1, vlen=2, tlen=2),
++ (str="1;", kwargs=(delim=UInt8(';'),), x=1, code=(OK | DELIMITED), vpos=1, vlen=1, tlen=2),
++ (str="1abc;", kwargs=(delim=UInt8(';'),), x=1, code=(OK | DELIMITED | INVALID_DELIMITER), vpos=1, vlen=4, tlen=5),
++ (str="1\n", kwargs=(), x=1, code=(OK | NEWLINE | EOF), vpos=1, vlen=1, tlen=2),
++ (str="1\r", kwargs=(), x=1, code=(OK | NEWLINE | EOF), vpos=1, vlen=1, tlen=2),
++ (str="1\r\n", kwargs=(), x=1, code=(OK | NEWLINE | EOF), vpos=1, vlen=1, tlen=3),
++ (str="1\n2", kwargs=(), x=1, code=(OK | NEWLINE), vpos=1, vlen=1, tlen=2),
++ (str="1\r2", kwargs=(), x=1, code=(OK | NEWLINE), vpos=1, vlen=1, tlen=2),
++ (str="1\r\n2", kwargs=(), x=1, code=(OK | NEWLINE), vpos=1, vlen=1, tlen=3),
++ (str="1a\n", kwargs=(), x=1, code=(OK | NEWLINE | EOF | INVALID_DELIMITER), vpos=1, vlen=2, tlen=3),
++ (str="1a\r", kwargs=(), x=1, code=(OK | NEWLINE | EOF | INVALID_DELIMITER), vpos=1, vlen=2, tlen=3),
++ (str="1a\r\n", kwargs=(), x=1, code=(OK | NEWLINE | EOF | INVALID_DELIMITER), vpos=1, vlen=2, tlen=4),
++ (str="1a\n2", kwargs=(), x=1, code=(OK | NEWLINE | INVALID_DELIMITER), vpos=1, vlen=2, tlen=3),
++ (str="1a\r2", kwargs=(), x=1, code=(OK | NEWLINE | INVALID_DELIMITER), vpos=1, vlen=2, tlen=3),
++ (str="1a\r\n2", kwargs=(), x=1, code=(OK | NEWLINE | INVALID_DELIMITER), vpos=1, vlen=2, tlen=4),
++
++ (str="1,,,2,null,4", kwargs=(), x=1, code=(OK | DELIMITED), vpos=1, vlen=1, tlen=2),
++ (str="1,,,2,null,4", kwargs=(ignorerepeated=true,), x=1, code=(OK | DELIMITED), vpos=1, vlen=1, tlen=4),
++ (str="1,", kwargs=(ignorerepeated=true,), x=1, code=(OK | DELIMITED), vpos=1, vlen=1, tlen=2),
++ (str="1,,", kwargs=(ignorerepeated=true,), x=1, code=(OK | DELIMITED), vpos=1, vlen=1, tlen=3),
++ (str="1,,,", kwargs=(ignorerepeated=true,), x=1, code=(OK | DELIMITED), vpos=1, vlen=1, tlen=4),
++ (str="1::2", kwargs=(delim="::",), x=1, code=(OK | DELIMITED), vpos=1, vlen=1, tlen=3),
++ (str="1::::2", kwargs=(ignorerepeated=true, delim="::"), x=1, code=(OK | DELIMITED), vpos=1, vlen=1, tlen=5),
++ (str="1a::::2", kwargs=(ignorerepeated=true, delim="::"), x=1, code=(OK | DELIMITED | INVALID_DELIMITER), vpos=1, vlen=2, tlen=6),
++ (str="1[][]", kwargs=(delim="[]", ignorerepeated = true), x = 1, code=(OK | DELIMITED), vpos=1, vlen=1, tlen=5),
++ (str="1a[][]", kwargs=(delim="[]", ignorerepeated = true), x = 1, code=(OK | DELIMITED | INVALID_DELIMITER), vpos=1, vlen=2, tlen=6),
++ (str="1a[][]", kwargs=(delim="[]",), x = 1, code=(OK | DELIMITED | INVALID_DELIMITER), vpos=1, vlen=2, tlen=4),
++ # ignorerepeated
++ (str="1a,,", kwargs=(ignorerepeated=true,), x=1, code=(OK | DELIMITED | INVALID_DELIMITER), vpos=1, vlen=2, tlen=4),
++ (str="1a,,2", kwargs=(ignorerepeated=true,), x=1, code=(OK | DELIMITED | INVALID_DELIMITER), vpos=1, vlen=2, tlen=4),
++];
++
++for useio in (false, true)
++ for (oq, cq, e) in ((UInt8('"'), UInt8('"'), UInt8('"')), (UInt8('"'), UInt8('"'), UInt8('\\')), (UInt8('{'), UInt8('}'), UInt8('\\')))
++ for (i, case) in enumerate(testcases)
++ str = replace(replace(replace(case.str, '{'=>Char(oq)), '}'=>Char(cq)), '\\'=>Char(e))
++ source = useio ? IOBuffer(str) : str
++ x, code, vpos, vlen, tlen = Parsers.xparse(Int64, source; openquotechar=oq, closequotechar=cq, escapechar=e, case.kwargs...)
++ if x != case.x || code != case.code || vpos != case.vpos || vlen != case.vlen || tlen != case.tlen
++ println("ERROR on useio=$useio, case=$i, oq='$(Char(oq))', cq='$(Char(cq))', e='$(Char(e))', str=$(escape_string(str)), $case")
++ source = useio ? IOBuffer(str) : str
++ x, code, vpos, vlen, tlen = Parsers.xparse(Int64, source; debug=true, openquotechar=oq, closequotechar=cq, escapechar=e, case.kwargs...)
++ end
++ @test x == case.x
++ @test code == case.code
++ @test vpos == case.vpos
++ @test vlen == case.vlen
++ @test tlen == case.tlen
++ end
++ end
++end
++
++# strings
++oq = UInt8('{')
++cq = UInt8('}')
++e = UInt8('\\')
++for (i, case) in enumerate(testcases)
++ str = replace(replace(replace(case.str, '{'=>Char(oq)), '}'=>Char(cq)), '\\'=>Char(e))
++ x, code, vpos, vlen, tlen = Parsers.xparse(String, case.str; openquotechar=oq, closequotechar=cq, escapechar=e, case.kwargs...)
++ if vpos != case.vpos || vlen != case.vlen || tlen != case.tlen
++ println("ERROR on case=$i, oq='$(Char(oq))', cq='$(Char(cq))', e='$(Char(e))', str=$(escape_string(str)), $case")
++ x, code, vpos, vlen, tlen = Parsers.xparse(String, case.str; debug=true, openquotechar=oq, closequotechar=cq, escapechar=e, case.kwargs...)
++ end
++ if !Parsers.invalidquotedfield(code)
++ @test vpos == case.vpos
++ @test vlen == case.vlen
++ @test tlen == case.tlen
++ end
++end
++
++end # @testset "Core Parsers.xparse"
++
++@testset "ints" begin
++
++# test lots of ints
++@time for i in typemin(Int64):100_000_000_000_000:typemax(Int64)
++ str = string(i)
++ x, code, vpos, vlen, tlen = Parsers.xparse(Int64, str)
++ @test string(x) == str
++ @test code == OK | EOF
++ @test vlen == length(str)
++end
++
++end # @testset "ints"
++
++@testset "bools" begin
++
++trues1 = ["T"]
++falses1 = ["F"]
++trues2 = ["truthy"]
++falses2 = ["falsy"]
++
++testcases = [
++ (str="", kwargs=(), x=false, code=(INVALID | EOF), vpos=1, vlen=0),
++ (str="t", kwargs=(), x=false, code=(INVALID | EOF), vpos=1, vlen=1),
++ (str="tr", kwargs=(), x=false, code=(INVALID | EOF), vpos=1, vlen=2),
++ (str="tru", kwargs=(), x=false, code=(INVALID | EOF), vpos=1, vlen=3),
++ (str="true", kwargs=(), x=true, code=(OK | EOF), vpos=1, vlen=4),
++
++ (str="f", kwargs=(), x=false, code=(INVALID | EOF), vpos=1, vlen=1),
++ (str="fa", kwargs=(), x=false, code=(INVALID | EOF), vpos=1, vlen=2),
++ (str="fal", kwargs=(), x=false, code=(INVALID | EOF), vpos=1, vlen=3),
++ (str="fals", kwargs=(), x=false, code=(INVALID | EOF), vpos=1, vlen=4),
++ (str="false", kwargs=(), x=false, code=(OK | EOF), vpos=1, vlen=5),
++
++ (str="t,", kwargs=(), x=false, code=(INVALID | DELIMITED), vpos=1, vlen=1),
++ (str="tr,", kwargs=(), x=false, code=(INVALID | DELIMITED), vpos=1, vlen=2),
++ (str="tru,", kwargs=(), x=false, code=(INVALID | DELIMITED), vpos=1, vlen=3),
++ (str="true,", kwargs=(), x=true, code=(OK | DELIMITED), vpos=1, vlen=4),
++
++ (str="f,", kwargs=(), x=false, code=(INVALID | DELIMITED), vpos=1, vlen=1),
++ (str="fa,", kwargs=(), x=false, code=(INVALID | DELIMITED), vpos=1, vlen=2),
++ (str="fal,", kwargs=(), x=false, code=(INVALID | DELIMITED), vpos=1, vlen=3),
++ (str="fals,", kwargs=(), x=false, code=(INVALID | DELIMITED), vpos=1, vlen=4),
++ (str="false,", kwargs=(), x=false, code=(OK | DELIMITED), vpos=1, vlen=5),
++
++ (str="0", kwargs=(), x=false, code=(OK | EOF), vpos=1, vlen=1),
++ (str="1", kwargs=(), x=true, code=(OK | EOF), vpos=1, vlen=1),
++ (str="001", kwargs=(), x=true, code=(OK | EOF), vpos=1, vlen=3),
++ (str="2", kwargs=(), x=false, code=(INVALID | EOF | INVALID_DELIMITER), vpos=1, vlen=1),
++
++ (str="t", kwargs=(trues=trues1, falses=falses1,), x=false, code=(INVALID | EOF | INVALID_DELIMITER), vpos=1, vlen=1),
++ (str="T", kwargs=(trues=trues1, falses=falses1,), x=true, code=(OK | EOF), vpos=1, vlen=1),
++ (str="T,", kwargs=(trues=trues1, falses=falses1,), x=true, code=(OK | DELIMITED), vpos=1, vlen=1),
++ (str="Tr", kwargs=(trues=trues1, falses=falses1,), x=true, code=(OK | EOF | INVALID_DELIMITER), vpos=1, vlen=2),
++ (str="F", kwargs=(trues=trues1, falses=falses1,), x=false, code=(OK | EOF), vpos=1, vlen=1),
++ (str="truthy", kwargs=(trues=trues2, falses=falses2,), x=true, code=(OK | EOF), vpos=1, vlen=6),
++ (str="truthyfalsy", kwargs=(trues=trues2, falses=falses2,), x=true, code=(OK | EOF | INVALID_DELIMITER), vpos=1, vlen=11),
++ (str="falsytruthy", kwargs=(trues=trues2, falses=falses2,), x=false, code=(OK | EOF | INVALID_DELIMITER), vpos=1, vlen=11),
++];
++
++for useio in (false, true)
++ for (i, case) in enumerate(testcases)
++ x, code, vpos, vlen, tot = Parsers.xparse(Bool, useio ? IOBuffer(case.str) : case.str; case.kwargs...)
++ if x != case.x || code != case.code || vlen != case.vlen
++ println("error for case = $i: useio=$useio, $case")
++ println(Parsers.codes(code))
++ end
++ @test x == case.x
++ @test code == case.code
++ @test vlen == case.vlen
++ end
++end
++
++end # @testset "bools"
++
++@testset "misc" begin
++
++# additional tests for full xparse branch coverage
++oq = UInt8('{')
++cq = UInt8('}')
++e = UInt8('\\')
++str=" {\\"
++x, code, vpos, vlen, tlen = Parsers.xparse(Int64, str; openquotechar=oq, closequotechar=cq, escapechar=e)
++@test x == 0
++@test code == QUOTED | EOF | INVALID_QUOTED_FIELD
++@test tlen == 3
++
++@test Parsers.parse(Int, "101") === 101
++@test Parsers.parse(Float64, "101,101", Parsers.Options(decimal=',')) === 101.101
++@test Parsers.parse(Bool, IOBuffer("true")) === true
++@test_throws Parsers.Error Parsers.parse(Int, "abc")
++
++@test Parsers.tryparse(Int, "abc") === nothing
++@test Parsers.tryparse(Float32, IOBuffer("101,101"), Parsers.Options(decimal=',')) === Float32(101.101)
++@test Parsers.parse(Date, "01/20/2018", Parsers.Options(dateformat="mm/dd/yyyy")) === Date(2018, 1, 20)
++
++# https://github.com/JuliaData/CSV.jl/issues/345
++x, code, vpos, vlen, tlen = Parsers.xparse(String, "\"DALLAS BLACK DANCE THEATRE\",")
++@test vpos == 2
++@test vlen == 26
++@test tlen == 29
++@test code == OK | QUOTED | DELIMITED
++
++# https://github.com/JuliaData/CSV.jl/issues/344
++str = "1,2,null,4"
++pos = 1
++x, code, vpos, vlen, tlen = Parsers.xparse(Int, str; pos=pos, sentinel=["null"])
++pos += tlen
++@test x === 1
++@test code === OK | DELIMITED
++@test vpos == 1
++@test vlen == 1
++@test pos == 3
++x, code, vpos, vlen, tlen = Parsers.xparse(Int, str; pos=pos, sentinel=["null"])
++pos += tlen
++@test x === 2
++@test code === OK | DELIMITED
++@test vpos == 3
++@test vlen == 1
++@test pos == 5
++x, code, vpos, vlen, tlen = Parsers.xparse(Int, str; pos=pos, sentinel=["null"])
++pos += tlen
++@test x == 0
++@test code === SENTINEL | DELIMITED
++@test vpos == 5
++@test vlen == 4
++@test pos == 10
++x, code, vpos, vlen, tlen = Parsers.xparse(Int, str; pos=pos, sentinel=["null"])
++pos += tlen
++@test x === 4
++@test code === OK | EOF
++@test vpos == 10
++@test vlen == 1
++@test pos == 11
++
++@test Parsers.parse(Int, SubString("101")) === 101
++@test Parsers.parse(Float64, SubString("101,101"), Parsers.Options(decimal=',')) === 101.101
++
++@test Parsers.asciival(' ')
++
++@test_throws ArgumentError Parsers.Options(sentinel=[" "])
++@test_throws ArgumentError Parsers.Options(sentinel=["\""])
++@test_throws ArgumentError Parsers.Options(sentinel=[","], delim=',')
++@test_throws ArgumentError Parsers.Options(sentinel=[","], delim=",")
++
++@test Parsers.default(Int32) === Int32(0)
++@test Parsers.default(Float32) === Float32(0)
++@test Parsers.xparse(Int64, "10", 1, 2, Parsers.XOPTIONS) == (Int64(10), OK | EOF, 1, 2, 2)
++@test Parsers.xparse(Int64, "a", 1, 1, Parsers.Options(sentinel=missing)) == (Int64(0), SENTINEL, 1, 0, 0)
++
++@test Parsers.checkdelim!(UInt8[], 1, 0, Parsers.OPTIONS) == 1
++@test Parsers.checkdelim!(codeunits(","), 1, 1, Parsers.XOPTIONS) == 2
++@test Parsers.checkdelim!(codeunits("::"), 1, 2, Parsers.Options(delim="::")) == 3
++@test Parsers.checkdelim!(codeunits(",,"), 1, 2, Parsers.Options(ignorerepeated=true, delim=',')) == 3
++@test Parsers.checkdelim!(codeunits("::::"), 1, 4, Parsers.Options(delim="::", ignorerepeated=true)) == 5
++
++e = Parsers.Error(Vector{UInt8}("hey"), Int64, INVALID | EOF, 1, 3)
++io = IOBuffer()
++showerror(io, e)
++@test String(take!(io)) == "Parsers.Error (INVALID: EOF ):\ninitial value parsing failed, reached EOF\nattempted to parse Int64 from: \"hey\"\n"
++e2 = Parsers.Error(IOBuffer("hey"), Int64, INVALID | EOF, 1, 3)
++showerror(io, e2)
++@test String(take!(io)) == "Parsers.Error (INVALID: EOF ):\ninitial value parsing failed, reached EOF\nattempted to parse Int64 from: \"hey\"\n"
++
++@test Parsers.invalid(INVALID_DELIMITER)
++@test Parsers.sentinel(SENTINEL)
++@test !Parsers.sentinel(OK)
++@test Parsers.quoted(QUOTED)
++@test !Parsers.quoted(INVALID_DELIMITER)
++@test Parsers.delimited(DELIMITED)
++@test !Parsers.delimited(OK)
++@test Parsers.newline(NEWLINE)
++@test !Parsers.newline(DELIMITED)
++@test Parsers.escapedstring(ESCAPED_STRING)
++@test !Parsers.escapedstring(OK)
++@test Parsers.invalidquotedfield(INVALID_QUOTED_FIELD)
++@test !Parsers.invalidquotedfield(INVALID_DELIMITER)
++@test Parsers.invaliddelimiter(INVALID_DELIMITER)
++@test !Parsers.invaliddelimiter(INVALID_QUOTED_FIELD)
++@test Parsers.overflow(OVERFLOW)
++@test !Parsers.overflow(OK)
++@test Parsers.quotednotescaped(QUOTED)
++@test !Parsers.quotednotescaped(QUOTED | ESCAPED_STRING)
++
++# https://github.com/JuliaData/CSV.jl/issues/454
++x, code, vpos, vlen, tlen = Parsers.xparse(Float64, "\"\"", 1, 2)
++@test Parsers.sentinel(code)
++
++x, code, vpos, vlen, tlen = Parsers.xparse(String, "\"\"", 1, 2)
++@test Parsers.sentinel(code)
++
++end # @testset "misc"
++
++include("floats.jl")
++include("dates.jl")
++
++end # @testset "Parsers"
--- /dev/null
--- /dev/null
++#!/bin/sh -e
++
++PKG_JL_BASE=https://api.github.com/repos/JuliaLang/Pkg.jl/tarball/
++PKG_JL_HASH=5de608c7b1837a24ed84eaaa14dde017986cb460
++
++LIBUV_BASE=https://api.github.com/repos/JuliaLang/libuv/tarball/
++LIBUV_HASH=35b1504507a7a4168caae3d78db54d1121b121e1
++
++LIBWHICH_BASE=https://api.github.com/repos/vtjnash/libwhich/tarball/
++LIBWHICH_HASH=81e9723c0273d78493dc8c8ed570f68d9ce7e89e
++
++if ! test -r $PKG_JL_HASH; then
++ wget -c ${PKG_JL_BASE}${PKG_JL_HASH}
++fi
++
++if ! test -r libuv-$LIBUV_HASH.tar.gz; then
++ wget -c ${LIBUV_BASE}${LIBUV_HASH} -O libuv-${LIBUV_HASH}.tar.gz
++fi
++
++if ! test -r libwhich-${LIBWHICH_HASH}.tar.gz; then
++ wget -c ${LIBWHICH_BASE}${LIBWHICH_HASH} -O libwhich-${LIBWHICH_HASH}.tar.gz
++fi
++
++foobar () {
++ P=${1}
++ URL=${2}
++ if ! test -d $P; then
++ mkdir -p $P
++ wget -c $URL -O $P.tar.gz
++ tar xvf $P.tar.gz --strip-components=1 -C $P
++ rm $P.tar.gz
++ fi
++}
++
++Documenter=https://github.com/JuliaDocs/Documenter.jl/archive/v0.23.0.tar.gz
++foobar Documenter $Documenter
++
++JSON=https://github.com/JuliaIO/JSON.jl/archive/v0.21.0.tar.gz
++foobar JSON $JSON
++
++DocumenterLaTeX=https://github.com/JuliaDocs/DocumenterLaTeX.jl/archive/v0.2.0.tar.gz
++foobar DocumenterLaTeX $DocumenterLaTeX
++
++DocStringExtensions=https://github.com/JuliaDocs/DocStringExtensions.jl/archive/v0.8.0.tar.gz
++foobar DocStringExtensions $DocStringExtensions
++
++Parsers=https://github.com/JuliaData/Parsers.jl/archive/v0.3.6.tar.gz
++foobar Parsers $Parsers
--- /dev/null
--- /dev/null
++/* This file is provided by Debian as an replacement to
++ * https://fonts.googleapis.com/css?family=Lato|Roboto+Mono
++ * MIT License, 2018, Mo Zhou <cdluminate@gmail.com>
++ */
++@font-face {
++ font-family: 'Lato';
++ font-style: normal;
++ font-weight: 400;
++ src: local('Lato Regular'),
++ local('Lato-Regular'),
++ url(file:///usr/share/fonts/truetype/lato/Lato-Regular.ttf) format('truetype');
++}
++@font-face {
++ font-family: 'Inconsolata';
++ font-style: normal;
++ font-weight: 400;
++ src: local('Inconsolata'),
++ url(file:///usr/share/fonts/truetype/inconsolata/Inconsolata.otf) format('opentype');
++}
--- /dev/null
--- /dev/null
++[DEFAULT]
++pristine-tar = True
--- /dev/null
--- /dev/null
++include:
++ - https://salsa.debian.org/salsa-ci-team/pipeline/raw/master/salsa-ci.yml
++ - https://salsa.debian.org/salsa-ci-team/pipeline/raw/master/pipeline-jobs.yml
--- /dev/null
--- /dev/null
++etc/julia/
++usr/share/julia/base
++#usr/share/julia/build_sysimg.jl
++usr/share/julia/julia-config.jl
++usr/share/julia/stdlib
++usr/share/julia/test
--- /dev/null
--- /dev/null
++# Docs are deliberately put there.
++julia-common: package-contains-documentation-outside-usr-share-doc usr/share/julia/stdlib/*
++# This is false-positive
++julia-common: wrong-path-for-interpreter
--- /dev/null
--- /dev/null
++Document: julia-manual
++Title: Julia Language Manual
++Abstract: Describes the Julia language and its standard library
++Section: Programming
++
++Format: HTML
++Index: /usr/share/doc/julia/html/en/index.html
++Files: /usr/share/doc/julia/html/*
--- /dev/null
--- /dev/null
++#doc/_build/pdf/en/TheJuliaLanguage.pdf
++doc/_build/html
--- /dev/null
--- /dev/null
++debian/fontface.css usr/share/doc/julia-doc/
--- /dev/null
--- /dev/null
++CONTRIBUTING.md
++HISTORY.md
++NEWS.md
++README.md
++VERSION
--- /dev/null
--- /dev/null
++debian/prompt.example.jl
--- /dev/null
--- /dev/null
++usr/bin/julia
++usr/share/appdata/julia.appdata.xml usr/share/metainfo/
++usr/share/applications/julia.desktop
++usr/share/icons/hicolor/scalable/apps/julia.svg
++usr/share/julia/base.cache
++usr/share/julia/base/build_h.jl
--- /dev/null
--- /dev/null
++debian/tmp/usr/share/man/man1/julia.1
--- /dev/null
--- /dev/null
++usr/include/julia
++usr/lib/*/libjulia.so
--- /dev/null
--- /dev/null
++libjulia1-dbgsym: debug-file-with-no-debug-symbols
++
--- /dev/null
--- /dev/null
++usr/lib/*/julia
++usr/lib/*/libjulia.so.*
--- /dev/null
--- /dev/null
++# Deliberately keeping debug info https://github.com/JuliaLang/julia/issues/23115#issuecomment-320715030
++libjulia1: unstripped-binary-or-object usr/lib/*/julia/sys.so
++# Deliberately keeping debug info https://github.com/JuliaLang/julia/issues/23115#issuecomment-320715030
++libjulia1: unstripped-binary-or-object usr/lib/*/libjulia.so.*
++
++libjulia1: shared-lib-without-dependency-information usr/lib/*/julia/libsuitesparse_wrapper.so
++
--- /dev/null
--- /dev/null
++libjulia.so.1 libjulia1 #MINVER#
++ LLVMExtraAddAllocOptPass@Base 1.2.0~rc2
++ LLVMExtraAddBarrierNoopPass@Base 1.2.0~rc2
++ LLVMExtraAddCombineMulAddPass@Base 1.2.0~rc2
++ LLVMExtraAddFinalLowerGCPass@Base 1.3.0+dfsg
++ LLVMExtraAddGCInvariantVerifierPass@Base 1.2.0~rc2
++ LLVMExtraAddInternalizePassWithExportList@Base 0.7.0~beta2
++ LLVMExtraAddLateLowerGCFramePass@Base 1.2.0~rc2
++ LLVMExtraAddLowerExcHandlersPass@Base 1.2.0~rc2
++ LLVMExtraAddLowerPTLSPass@Base 1.2.0~rc2
++ LLVMExtraAddLowerSimdLoopPass@Base 1.2.0~rc2
++ LLVMExtraAddMultiVersioningPass@Base 1.2.0~rc2
++ LLVMExtraAddNVVMReflectFunctionPass@Base 1.3.0+dfsg
++ LLVMExtraAddPass@Base 0.7.0~beta2
++ LLVMExtraAddPropagateJuliaAddrspaces@Base 1.2.0~rc2
++ LLVMExtraAddTargetLibraryInfoByTiple@Base 0.7.0~beta2
++ LLVMExtraCreateBasicBlockPass@Base 0.7.0~beta2
++ LLVMExtraCreateFunctionPass@Base 0.7.0~beta2
++ LLVMExtraCreateModulePass@Base 0.7.0~beta2
++ LLVMExtraGetDebugMDVersion@Base 0.7.0~beta2
++ LLVMExtraGetSourceLocation@Base 0.7.0~beta2
++ LLVMExtraGetValueContext@Base 0.7.0~beta2
++ LLVMExtraInitializeAllAsmParsers@Base 0.7.0~beta2
++ LLVMExtraInitializeAllAsmPrinters@Base 0.7.0~beta2
++ LLVMExtraInitializeAllDisassemblers@Base 0.7.0~beta2
++ LLVMExtraInitializeAllTargetInfos@Base 0.7.0~beta2
++ LLVMExtraInitializeAllTargetMCs@Base 0.7.0~beta2
++ LLVMExtraInitializeAllTargets@Base 0.7.0~beta2
++ LLVMExtraInitializeNativeAsmParser@Base 0.7.0~beta2
++ LLVMExtraInitializeNativeAsmPrinter@Base 0.7.0~beta2
++ LLVMExtraInitializeNativeDisassembler@Base 0.7.0~beta2
++ LLVMExtraInitializeNativeTarget@Base 0.7.0~beta2
++ __stack_chk_guard@Base 0.6.3
++ bitvector_get@Base 0.6.3
++ bitvector_new@Base 0.6.3
++ bitvector_resize@Base 0.6.3
++ bitvector_set@Base 0.6.3
++ int32hash@Base 0.6.3
++ int64hash@Base 0.6.3
++ int64to32hash@Base 0.6.3
++ ios_bufmode@Base 0.6.3
++ ios_close@Base 0.6.3
++ ios_copy@Base 0.6.3
++ ios_copyall@Base 0.6.3
++ ios_copyuntil@Base 0.6.3
++ ios_eof@Base 0.6.3
++ ios_eof_blocking@Base 0.6.3
++ ios_fd@Base 0.6.3
++ ios_file@Base 0.6.3
++ ios_flush@Base 0.6.3
++ ios_get_readable@Base 0.6.3
++ ios_get_writable@Base 0.6.3
++ ios_getc@Base 0.6.3
++ ios_getutf8@Base 0.6.3
++ ios_isopen@Base 0.6.3
++ ios_mem@Base 0.6.3
++ ios_mkstemp@Base 0.6.3
++ ios_nchomp@Base 0.6.3
++ ios_peekc@Base 0.6.3
++ ios_peekutf8@Base 0.6.3
++ ios_pos@Base 0.6.3
++ ios_printf@Base 0.6.3
++ ios_purge@Base 0.6.3
++ ios_putc@Base 0.6.3
++ ios_pututf8@Base 0.6.3
++ ios_read@Base 0.6.3
++ ios_readall@Base 0.6.3
++ ios_readline@Base 0.6.3
++ ios_readprep@Base 0.6.3
++ ios_seek@Base 0.6.3
++ ios_seek_end@Base 0.6.3
++ ios_set_readonly@Base 0.6.3
++ ios_setbuf@Base 0.6.3
++ ios_skip@Base 0.6.3
++ ios_stderr@Base 0.6.3
++ ios_stdin@Base 0.6.3
++ ios_stdout@Base 0.6.3
++ ios_take_buffer@Base 0.6.3
++ ios_trunc@Base 0.6.3
++ ios_vprintf@Base 0.6.3
++ ios_write@Base 0.6.3
++ ios_write_direct@Base 0.6.3
++ jl_@Base 0.6.3
++ jl_LLVMContext@Base 0.6.3
++ jl_LLVMCreateDisasm@Base 0.6.3
++ jl_LLVMDisasmInstruction@Base 0.6.3
++ jl_LLVMFlipSign@Base 0.6.3
++ jl_LLVMSMod@Base 0.6.3
++ jl_RTLD_DEFAULT_handle@Base 0.6.3
++ jl_SC_CLK_TCK@Base 0.6.3
++ jl_abs_float@Base 0.6.3
++ jl_abs_float_withtype@Base 0.6.3
++ jl_abstractarray_type@Base 0.6.3
++ jl_abstractslot_type@Base 0.6.3
++ jl_abstractstring_type@Base 0.6.3
++ jl_add_float@Base 0.6.3
++ jl_add_int@Base 0.6.3
++ jl_add_optimization_passes@Base 0.7.0~beta2
++ jl_add_ptr@Base 0.7.0~beta2
++ jl_add_standard_imports@Base 0.6.3
++ jl_alignment@Base 0.6.3
++ jl_alloc_array_1d@Base 0.6.3
++ jl_alloc_array_2d@Base 0.6.3
++ jl_alloc_array_3d@Base 0.6.3
++ jl_alloc_string@Base 0.6.3
++ jl_alloc_svec@Base 0.6.3
++ jl_alloc_svec_uninit@Base 0.6.3
++ jl_alloc_vec_any@Base 0.6.3
++ jl_an_empty_string@Base 1.2.0~rc2
++ jl_an_empty_vec_any@Base 0.6.3
++ jl_and_int@Base 0.6.3
++ jl_any_type@Base 0.6.3
++ jl_anytuple_type@Base 0.6.3
++ jl_anytuple_type_type@Base 0.6.3
++ jl_apply_array_type@Base 0.6.3
++ jl_apply_generic@Base 0.6.3
++ jl_apply_tuple_type@Base 0.6.3
++ jl_apply_tuple_type_v@Base 0.6.3
++ jl_apply_type1@Base 0.6.3
++ jl_apply_type2@Base 0.6.3
++ jl_apply_type@Base 0.6.3
++ jl_argument_datatype@Base 0.7.0~beta2
++ jl_argument_method_table@Base 1.3.0+dfsg
++ jl_argumenterror_type@Base 0.6.3
++ jl_array_any_type@Base 0.6.3
++ jl_array_cconvert_cstring@Base 0.6.3
++ jl_array_copy@Base 0.6.3
++ jl_array_data_owner@Base 0.6.3
++ jl_array_del_at@Base 0.6.3
++ jl_array_del_beg@Base 0.6.3
++ jl_array_del_end@Base 0.6.3
++ jl_array_eltype@Base 0.6.3
++ jl_array_grow_at@Base 0.6.3
++ jl_array_grow_beg@Base 0.6.3
++ jl_array_grow_end@Base 0.6.3
++ jl_array_int32_type@Base 0.7.0~beta2
++ jl_array_isassigned@Base 0.6.3
++ jl_array_ptr@Base 0.6.3
++ jl_array_ptr_1d_append@Base 0.6.3
++ jl_array_ptr_1d_push@Base 0.6.3
++ jl_array_ptr_copy@Base 0.6.3
++ jl_array_rank@Base 0.6.3
++ jl_array_size@Base 0.6.3
++ jl_array_sizehint@Base 0.6.3
++ jl_array_store_unboxed@Base 0.7.0~beta2
++ jl_array_symbol_type@Base 0.6.3
++ jl_array_to_string@Base 0.6.3
++ jl_array_type@Base 0.6.3
++ jl_array_typename@Base 0.6.3
++ jl_array_typetagdata@Base 0.7.0
++ jl_array_uint8_type@Base 0.6.3
++ jl_arraylen@Base 0.6.3
++ jl_arrayref@Base 0.6.3
++ jl_arrayset@Base 0.6.3
++ jl_arrayunset@Base 0.6.3
++ jl_ashr_int@Base 0.6.3
++ jl_ast_flag_inferred@Base 0.6.3
++ jl_ast_flag_inlineable@Base 0.6.3
++ jl_ast_flag_pure@Base 0.6.3
++ jl_ast_nslots@Base 1.1.0+dfsg
++ jl_ast_slotflag@Base 1.2.0~rc2
++ jl_astaggedvalue@Base 0.6.3
++ jl_atexit_hook@Base 0.6.3
++ jl_backtrace_from_here@Base 0.6.3
++ jl_base_module@Base 0.6.3
++ jl_base_relative_to@Base 0.6.3
++ jl_binding_owner@Base 0.7.0~beta2
++ jl_binding_resolved_p@Base 0.6.3
++ jl_bitcast@Base 0.6.3
++ jl_bool_type@Base 0.6.3
++ jl_bottom_type@Base 0.6.3
++ jl_boundp@Base 0.6.3
++ jl_bounds_error@Base 0.6.3
++ jl_bounds_error_int@Base 0.6.3
++ jl_bounds_error_ints@Base 0.6.3
++ jl_bounds_error_tuple_int@Base 0.6.3
++ jl_bounds_error_unboxed_int@Base 0.6.3
++ jl_bounds_error_v@Base 0.6.3
++ jl_boundserror_type@Base 0.6.3
++ jl_box_bool@Base 0.6.3
++ jl_box_char@Base 0.6.3
++ jl_box_float32@Base 0.6.3
++ jl_box_float64@Base 0.6.3
++ jl_box_int16@Base 0.6.3
++ jl_box_int32@Base 0.6.3
++ jl_box_int64@Base 0.6.3
++ jl_box_int8@Base 0.6.3
++ jl_box_slotnumber@Base 0.6.3
++ jl_box_ssavalue@Base 0.6.3
++ jl_box_uint16@Base 0.6.3
++ jl_box_uint32@Base 0.6.3
++ jl_box_uint64@Base 0.6.3
++ jl_box_uint8@Base 0.6.3
++ jl_box_voidpointer@Base 0.6.3
++ jl_breakpoint@Base 0.6.3
++ jl_bswap_int@Base 0.6.3
++ jl_builtin_type@Base 0.6.3
++ jl_call0@Base 0.6.3
++ jl_call1@Base 0.6.3
++ jl_call2@Base 0.6.3
++ jl_call3@Base 0.6.3
++ jl_call@Base 0.6.3
++ jl_call_in_typeinf_world@Base 1.1.0+dfsg
++ jl_calloc@Base 0.6.3
++ jl_capture_interp_frame@Base 0.7.0~beta2
++ jl_ceil_llvm@Base 0.6.3
++ jl_ceil_llvm_withtype@Base 0.6.3
++ jl_cglobal@Base 0.6.3
++ jl_cglobal_auto@Base 0.6.3
++ jl_char_type@Base 0.6.3
++ jl_checked_assignment@Base 0.6.3
++ jl_checked_sadd_int@Base 0.6.3
++ jl_checked_sdiv_int@Base 0.6.3
++ jl_checked_smul_int@Base 0.6.3
++ jl_checked_srem_int@Base 0.6.3
++ jl_checked_ssub_int@Base 0.6.3
++ jl_checked_uadd_int@Base 0.6.3
++ jl_checked_udiv_int@Base 0.6.3
++ jl_checked_umul_int@Base 0.6.3
++ jl_checked_urem_int@Base 0.6.3
++ jl_checked_usub_int@Base 0.6.3
++ jl_clear_malloc_data@Base 0.6.3
++ jl_clock_now@Base 0.6.3
++ jl_close_uv@Base 0.6.3
++ jl_code_for_staged@Base 0.6.3
++ jl_code_info_type@Base 0.6.3
++ jl_code_instance_type@Base 1.2.0~rc2
++ jl_compile_hint@Base 0.6.3
++ jl_compress_argnames@Base 1.2.0~rc2
++ jl_compress_ast@Base 0.6.3
++ jl_compute_fieldtypes@Base 1.3.0+dfsg
++ jl_copy_ast@Base 0.6.3
++ jl_copy_code_info@Base 0.6.3
++ jl_copysign_float@Base 0.6.3
++ jl_core_module@Base 0.6.3
++ jl_cpu_pause@Base 0.6.3
++ jl_cpu_threads@Base 0.7.0~beta2
++ jl_cpu_wake@Base 0.6.3
++ (arch=amd64 i386)jl_cpuid@Base 0.6.3
++ (arch=amd64 i386)jl_cpuidex@Base 0.7.0~beta2
++ jl_crc32c@Base 0.6.3
++ jl_crc32c_sw@Base 0.7.0~beta2
++ jl_create_system_image@Base 0.6.3
++ jl_cstr_to_string@Base 0.6.3
++ jl_ctlz_int@Base 0.6.3
++ jl_ctpop_int@Base 0.6.3
++ jl_cttz_int@Base 0.6.3
++ jl_current_exception@Base 1.1.0+dfsg
++ jl_datatype_type@Base 0.6.3
++ jl_declare_constant@Base 0.6.3
++ jl_default_cgparams@Base 0.6.3
++ jl_default_debug_info_kind@Base 1.3.0+dfsg
++ jl_defines_or_exports_p@Base 0.6.3
++ jl_densearray_type@Base 0.6.3
++ jl_deprecate_binding@Base 0.6.3
++ jl_div_float@Base 0.6.3
++ jl_diverror_exception@Base 0.6.3
++ jl_dl_handle@Base 0.6.3
++ jl_dlclose@Base 0.6.3
++ jl_dlopen@Base 0.6.3
++ jl_dlsym@Base 0.6.3
++ jl_dump_compiles@Base 0.6.3
++ jl_dump_fptr_asm@Base 0.7.0~beta2
++ jl_dump_function_asm@Base 0.6.3
++ jl_dump_function_ir@Base 0.6.3
++ jl_dump_host_cpu@Base 0.7.0~beta2
++ jl_egal@Base 0.6.3
++ jl_eh_restore_state@Base 1.1.0+dfsg
++ jl_emptysvec@Base 0.6.3
++ jl_emptytuple@Base 0.6.3
++ jl_emptytuple_type@Base 0.6.3
++ jl_enqueue_task@Base 1.2.0~rc2
++ jl_enter_handler@Base 0.6.3
++ jl_environ@Base 0.6.3
++ jl_eof_error@Base 0.6.3
++ jl_eq_float@Base 0.6.3
++ jl_eq_int@Base 0.6.3
++ jl_eqtable_get@Base 0.6.3
++ jl_eqtable_nextind@Base 0.6.3
++ jl_eqtable_pop@Base 0.6.3
++ jl_eqtable_put@Base 0.6.3
++ jl_errno@Base 0.6.3
++ jl_error@Base 0.6.3
++ jl_errorexception_type@Base 0.6.3
++ jl_errorf@Base 0.6.3
++ jl_eval_string@Base 0.6.3
++ jl_exception_clear@Base 0.6.3
++ jl_exception_occurred@Base 0.6.3
++ jl_exceptionf@Base 0.6.3
++ jl_excstack_state@Base 1.1.0+dfsg
++ jl_exe_handle@Base 0.6.3
++ jl_exit@Base 0.6.3
++ jl_exit_on_sigint@Base 0.6.3
++ jl_expand@Base 0.6.3
++ jl_expand_stmt@Base 0.7.0~beta2
++ jl_expand_stmt_with_loc@Base 1.2.0~rc2
++ jl_expand_with_loc@Base 1.2.0~rc2
++ jl_expr_type@Base 0.6.3
++ jl_extern_c@Base 0.6.3
++ jl_f__apply@Base 0.6.3
++ jl_f__apply_latest@Base 0.6.3
++ jl_f__apply_pure@Base 0.6.3
++ jl_f__expr@Base 0.6.3
++ jl_f__typevar@Base 1.1.0+dfsg
++ jl_f_applicable@Base 0.6.3
++ jl_f_apply_type@Base 0.6.3
++ jl_f_arrayref@Base 0.6.3
++ jl_f_arrayset@Base 0.6.3
++ jl_f_arraysize@Base 0.6.3
++ jl_f_const_arrayref@Base 1.2.0~rc2
++ jl_f_fieldtype@Base 0.6.3
++ jl_f_getfield@Base 0.6.3
++ jl_f_ifelse@Base 0.7.0~beta2
++ jl_f_intrinsic_call@Base 0.6.3
++ jl_f_invoke@Base 0.6.3
++ jl_f_invoke_kwsorter@Base 0.6.3
++ jl_f_is@Base 0.6.3
++ jl_f_isa@Base 0.6.3
++ jl_f_isdefined@Base 0.6.3
++ jl_f_issubtype@Base 0.6.3
++ jl_f_new_module@Base 0.6.3
++ jl_f_nfields@Base 0.6.3
++ jl_f_setfield@Base 0.6.3
++ jl_f_sizeof@Base 0.6.3
++ jl_f_svec@Base 0.6.3
++ jl_f_throw@Base 0.6.3
++ jl_f_tuple@Base 0.6.3
++ jl_f_typeassert@Base 0.6.3
++ jl_f_typeof@Base 0.6.3
++ jl_false@Base 0.6.3
++ jl_field_index@Base 0.6.3
++ jl_field_isdefined@Base 0.6.3
++ jl_filename@Base 0.6.3
++ jl_finalize@Base 0.6.3
++ jl_finalize_th@Base 0.6.3
++ jl_find_free_typevars@Base 0.6.3
++ jl_first_argument_datatype@Base 0.6.3
++ jl_flipsign_int@Base 0.6.3
++ jl_float16_type@Base 0.6.3
++ jl_float32_type@Base 0.6.3
++ jl_float64_type@Base 0.6.3
++ jl_floatingpoint_type@Base 0.6.3
++ jl_floor_llvm@Base 0.6.3
++ jl_floor_llvm_withtype@Base 0.6.3
++ jl_flush_cstdio@Base 0.6.3
++ jl_fma_float@Base 0.6.3
++ jl_forceclose_uv@Base 0.6.3
++ jl_format_filename@Base 1.1.0+dfsg
++ jl_fpext@Base 0.6.3
++ jl_fpiseq@Base 0.6.3
++ jl_fpislt@Base 0.6.3
++ jl_fptosi@Base 0.6.3
++ jl_fptoui@Base 0.6.3
++ jl_fptr_args@Base 0.7.0~beta2
++ jl_fptr_const_return@Base 0.7.0~beta2
++ jl_fptr_interpret_call@Base 0.7.0~beta2
++ jl_fptr_sparam@Base 0.7.0~beta2
++ jl_fptrunc@Base 0.6.3
++ jl_free@Base 0.6.3
++ jl_free_stack@Base 1.1.0+dfsg
++ jl_fs_chmod@Base 0.6.3
++ jl_fs_chown@Base 0.6.3
++ jl_fs_close@Base 0.6.3
++ jl_fs_read@Base 0.6.3
++ jl_fs_read_byte@Base 0.6.3
++ jl_fs_rename@Base 0.6.3
++ jl_fs_sendfile@Base 0.6.3
++ jl_fs_symlink@Base 0.6.3
++ jl_fs_unlink@Base 0.6.3
++ jl_fs_write@Base 0.6.3
++ jl_fstat@Base 0.6.3
++ jl_ftruncate@Base 0.6.3
++ jl_function_ptr@Base 0.6.3
++ jl_function_ptr_by_llvm_name@Base 0.6.3
++ jl_function_type@Base 0.6.3
++ jl_gc_add_finalizer@Base 0.6.3
++ jl_gc_add_finalizer_th@Base 0.6.3
++ jl_gc_add_ptr_finalizer@Base 0.6.3
++ jl_gc_alloc@Base 0.6.3
++ jl_gc_alloc_0w@Base 0.6.3
++ jl_gc_alloc_1w@Base 0.6.3
++ jl_gc_alloc_2w@Base 0.6.3
++ jl_gc_alloc_3w@Base 0.6.3
++ jl_gc_alloc_typed@Base 1.1.0+dfsg
++ jl_gc_allocobj@Base 0.6.3
++ jl_gc_big_alloc@Base 0.6.3
++ jl_gc_collect@Base 0.6.3
++ jl_gc_conservative_gc_support_enabled@Base 1.1.0+dfsg
++ jl_gc_counted_calloc@Base 0.6.3
++ jl_gc_counted_free_with_size@Base 0.7.0~beta2
++ jl_gc_counted_malloc@Base 0.6.3
++ jl_gc_counted_realloc_with_old_size@Base 0.6.3
++ jl_gc_diff_total_bytes@Base 0.6.3
++ jl_gc_enable@Base 0.6.3
++ jl_gc_enable_conservative_gc_support@Base 1.1.0+dfsg
++ jl_gc_enable_finalizers@Base 0.6.3
++ jl_gc_external_obj_hdr_size@Base 1.1.0+dfsg
++ jl_gc_find_taggedvalue_pool@Base 0.6.3
++ jl_gc_internal_obj_base_ptr@Base 1.1.0+dfsg
++ jl_gc_is_enabled@Base 0.6.3
++ jl_gc_managed_malloc@Base 0.6.3
++ jl_gc_managed_realloc@Base 0.6.3
++ jl_gc_mark_queue_obj@Base 1.1.0+dfsg
++ jl_gc_mark_queue_objarray@Base 1.1.0+dfsg
++ jl_gc_max_internal_obj_size@Base 1.1.0+dfsg
++ jl_gc_new_weakref@Base 0.6.3
++ jl_gc_new_weakref_th@Base 0.6.3
++ jl_gc_num@Base 0.6.3
++ jl_gc_pool_alloc@Base 0.6.3
++ jl_gc_queue_root@Base 0.6.3
++ jl_gc_safe_enter@Base 0.6.3
++ jl_gc_safe_leave@Base 0.6.3
++ jl_gc_safepoint@Base 0.6.3
++ jl_gc_schedule_foreign_sweepfunc@Base 1.1.0+dfsg
++ jl_gc_set_cb_notify_external_alloc@Base 1.1.0+dfsg
++ jl_gc_set_cb_notify_external_free@Base 1.1.0+dfsg
++ jl_gc_set_cb_post_gc@Base 1.1.0+dfsg
++ jl_gc_set_cb_pre_gc@Base 1.1.0+dfsg
++ jl_gc_set_cb_root_scanner@Base 1.1.0+dfsg
++ jl_gc_set_cb_task_scanner@Base 1.1.0+dfsg
++ jl_gc_total_bytes@Base 0.6.3
++ jl_gc_total_hrtime@Base 0.6.3
++ jl_gc_unsafe_enter@Base 0.6.3
++ jl_gc_unsafe_leave@Base 0.6.3
++ jl_gdblookup@Base 0.6.3
++ jl_generating_output@Base 0.6.3
++ jl_generic_function_def@Base 0.6.3
++ jl_gensym@Base 0.6.3
++ jl_get_ARCH@Base 0.6.3
++ jl_get_JIT@Base 0.6.3
++ jl_get_LLVM_VERSION@Base 0.6.3
++ jl_get_UNAME@Base 0.6.3
++ jl_get_backtrace@Base 0.6.3
++ jl_get_binding@Base 0.6.3
++ jl_get_binding_for_method_def@Base 0.6.3
++ jl_get_binding_or_error@Base 0.6.3
++ jl_get_binding_wr@Base 0.6.3
++ jl_get_cfunction_trampoline@Base 0.7.0~beta2
++ jl_get_cpu_name@Base 0.6.3
++ jl_get_current_task@Base 0.6.3
++ jl_get_default_sysimg_path@Base 0.6.3
++ jl_get_dobj_data@Base 0.6.3
++ jl_get_excstack@Base 1.1.0+dfsg
++ jl_get_fenv_consts@Base 0.6.3
++ jl_get_field@Base 0.6.3
++ jl_get_field_offset@Base 0.6.3
++ jl_get_fieldtypes@Base 1.3.0+dfsg
++ jl_get_global@Base 0.6.3
++ jl_get_image_file@Base 0.6.3
++ jl_get_invoke_lambda@Base 0.6.3
++ jl_get_julia_bin@Base 0.6.3
++ jl_get_julia_bindir@Base 0.7.0~beta2
++ jl_get_keyword_sorter@Base 0.6.3
++ jl_get_kwsorter@Base 0.6.3
++ jl_get_llvm_fptr@Base 0.6.3
++ jl_get_llvmf_decl@Base 0.6.3
++ jl_get_llvmf_defn@Base 0.6.3
++ jl_get_method_inferred@Base 1.2.0~rc2
++ jl_get_module_binding@Base 1.1.0+dfsg
++ jl_get_module_of_binding@Base 0.6.3
++ jl_get_nth_field@Base 0.6.3
++ jl_get_nth_field_checked@Base 0.6.3
++ jl_get_nth_field_noalloc@Base 0.7.0~beta2
++ jl_get_ptls_states@Base 0.6.3
++ jl_get_root_symbol@Base 0.6.3
++ jl_get_section_start@Base 0.6.3
++ jl_get_size@Base 0.6.3
++ jl_get_spec_lambda@Base 0.6.3
++ jl_get_task_tid@Base 1.2.0~rc2
++ jl_get_tls_world_age@Base 0.6.3
++ jl_get_world_counter@Base 0.6.3
++ jl_get_zero_subnormals@Base 0.6.3
++ jl_getaddrinfo@Base 0.6.3
++ jl_getallocationgranularity@Base 0.6.3
++ jl_getnameinfo@Base 0.7.0~beta2
++ jl_getpagesize@Base 0.6.3
++ jl_getpid@Base 0.6.3
++ jl_gettimeofday@Base 0.6.3
++ jl_getutf8@Base 0.6.3
++ jl_gf_invoke_lookup@Base 0.6.3
++ jl_git_branch@Base 0.6.3
++ jl_git_commit@Base 0.6.3
++ jl_global_event_loop@Base 0.6.3
++ jl_globalref_type@Base 0.6.3
++ jl_gotonode_type@Base 0.6.3
++ jl_has_empty_intersection@Base 0.6.3
++ jl_has_free_typevars@Base 0.6.3
++ jl_has_so_reuseport@Base 0.7.0~beta2
++ jl_has_typevar@Base 0.6.3
++ jl_has_typevar_from_unionall@Base 0.6.3
++ jl_hrtime@Base 0.6.3
++ jl_id_char@Base 0.6.3
++ jl_id_start_char@Base 0.6.3
++ jl_idtable_rehash@Base 0.6.3
++ jl_incomplete_sym@Base 0.6.3
++ jl_infer_thunk@Base 0.7.0~beta2
++ jl_init__threading@Base 0.7.0~beta2
++ jl_init_restored_modules@Base 0.7.0
++ jl_init_with_image__threading@Base 0.7.0~beta2
++ jl_initerror_type@Base 0.6.3
++ jl_install_sigint_handler@Base 0.6.3
++ jl_instantiate_type_in_env@Base 0.6.3
++ jl_instantiate_unionall@Base 0.6.3
++ jl_int16_type@Base 0.6.3
++ jl_int32_type@Base 0.6.3
++ jl_int64_type@Base 0.6.3
++ jl_int8_type@Base 0.6.3
++ jl_interrupt_exception@Base 0.6.3
++ jl_intersect_types@Base 0.6.3
++ jl_intrinsic_name@Base 0.6.3
++ jl_intrinsic_type@Base 0.6.3
++ jl_invoke@Base 0.6.3
++ jl_invoke_api@Base 0.7.0~beta2
++ jl_iolock_begin@Base 1.3.0+dfsg
++ jl_iolock_end@Base 1.3.0+dfsg
++ jl_ios_buffer_n@Base 1.3.0+dfsg
++ jl_ios_fd@Base 0.6.3
++ jl_ios_get_nbyte_int@Base 0.6.3
++ jl_is_binding_deprecated@Base 0.6.3
++ jl_is_char_signed@Base 0.6.3
++ jl_is_const@Base 0.6.3
++ jl_is_debugbuild@Base 0.6.3
++ jl_is_enter_interpreter_frame@Base 0.7.0~beta2
++ jl_is_identifier@Base 0.7.0~beta2
++ jl_is_imported@Base 0.6.3
++ jl_is_in_pure_context@Base 0.6.3
++ jl_is_initialized@Base 0.6.3
++ jl_is_interpreter_frame@Base 0.7.0~beta2
++ jl_is_memdebug@Base 0.6.3
++ jl_is_not_broken_subtype@Base 0.7.0~beta2
++ jl_is_operator@Base 0.6.3
++ jl_is_task_started@Base 0.6.3
++ jl_is_unary_and_binary_operator@Base 0.7.0~beta2
++ jl_is_unary_operator@Base 0.7.0~beta2
++ jl_isa@Base 0.6.3
++ jl_isa_compileable_sig@Base 0.7.0~beta2
++ jl_islayout_inline@Base 0.7.0~beta2
++ jl_istopmod@Base 0.6.3
++ jl_le_float@Base 0.6.3
++ jl_lineinfonode_type@Base 0.7.0~beta2
++ jl_lineno@Base 0.6.3
++ jl_linenumbernode_type@Base 0.6.3
++ jl_lisp_prompt@Base 0.6.3
++ jl_load@Base 0.6.3
++ jl_load_@Base 0.6.3
++ jl_load_and_lookup@Base 0.6.3
++ jl_load_dynamic_library@Base 0.6.3
++ jl_load_file_string@Base 0.6.3
++ jl_loaderror_type@Base 0.6.3
++ jl_lookup_code_address@Base 0.6.3
++ jl_lseek@Base 0.6.3
++ jl_lshr_int@Base 0.6.3
++ jl_lstat@Base 0.6.3
++ jl_lt_float@Base 0.6.3
++ jl_macroexpand1@Base 0.7.0~beta2
++ jl_macroexpand@Base 0.6.3
++ jl_main_module@Base 0.6.3
++ jl_malloc@Base 0.6.3
++ jl_malloc_stack@Base 1.1.0+dfsg
++ jl_matching_methods@Base 0.6.3
++ jl_maxrss@Base 0.6.3
++ jl_memory_exception@Base 0.6.3
++ jl_method_def@Base 0.6.3
++ jl_method_instance_add_backedge@Base 0.6.3
++ jl_method_instance_type@Base 0.6.3
++ jl_method_table_add_backedge@Base 0.6.3
++ jl_method_table_disable@Base 0.7.0~beta2
++ jl_method_table_for@Base 1.3.0+dfsg
++ jl_method_table_insert@Base 0.6.3
++ jl_method_type@Base 0.6.3
++ jl_methoderror_type@Base 0.6.3
++ jl_methtable_lookup@Base 0.6.3
++ jl_methtable_type@Base 0.6.3
++ jl_mmap@Base 0.6.3
++ jl_module_build_id@Base 0.7.0~beta2
++ jl_module_export@Base 0.6.3
++ jl_module_exports_p@Base 0.6.3
++ jl_module_globalref@Base 0.6.3
++ jl_module_import@Base 0.6.3
++ jl_module_name@Base 0.6.3
++ jl_module_names@Base 0.6.3
++ jl_module_parent@Base 0.6.3
++ jl_module_type@Base 0.6.3
++ jl_module_use@Base 0.6.3
++ jl_module_using@Base 0.6.3
++ jl_module_usings@Base 0.6.3
++ jl_module_uuid@Base 0.6.3
++ jl_mul_float@Base 0.6.3
++ jl_mul_int@Base 0.6.3
++ jl_muladd_float@Base 0.6.3
++ jl_n_threads@Base 0.6.3
++ jl_namedtuple_type@Base 0.7.0~beta2
++ jl_namedtuple_typename@Base 0.7.0~beta2
++ jl_native_alignment@Base 0.6.3
++ jl_nb_available@Base 0.6.3
++ jl_ne_float@Base 0.6.3
++ jl_ne_int@Base 0.6.3
++ jl_neg_float@Base 0.6.3
++ jl_neg_float_withtype@Base 0.6.3
++ jl_neg_int@Base 0.6.3
++ jl_new_array@Base 0.6.3
++ jl_new_bits@Base 0.6.3
++ jl_new_code_info_uninit@Base 0.6.3
++ jl_new_datatype@Base 0.6.3
++ jl_new_foreign_type@Base 1.1.0+dfsg
++ jl_new_method_instance_uninit@Base 0.6.3
++ jl_new_method_table@Base 0.6.3
++ jl_new_method_uninit@Base 0.6.3
++ jl_new_module@Base 0.6.3
++ jl_new_primitivetype@Base 0.6.3
++ jl_new_struct@Base 0.6.3
++ jl_new_struct_uninit@Base 0.6.3
++ jl_new_structt@Base 1.2.0~rc2
++ jl_new_structv@Base 0.6.3
++ jl_new_task@Base 0.6.3
++ jl_new_typename_in@Base 0.6.3
++ jl_new_typevar@Base 0.6.3
++ jl_newvarnode_type@Base 0.6.3
++ jl_next_from_addrinfo@Base 0.6.3
++ jl_no_exc_handler@Base 0.6.3
++ jl_not_int@Base 0.6.3
++ jl_nothing@Base 0.6.3
++ jl_number_type@Base 0.6.3
++ jl_object_id@Base 0.6.3
++ jl_object_id_@Base 1.3.0+dfsg
++ jl_obvious_subtype@Base 1.2.0~rc2
++ jl_op_suffix_char@Base 0.7.0~beta2
++ jl_operator_precedence@Base 0.6.3
++ jl_options@Base 0.6.3
++ jl_or_int@Base 0.6.3
++ jl_parse_all@Base 1.2.0~rc2
++ jl_parse_input_line@Base 0.6.3
++ jl_parse_opts@Base 0.6.3
++ jl_parse_string@Base 0.6.3
++ jl_pathname_for_handle@Base 0.6.3
++ jl_pchar_to_array@Base 0.6.3
++ jl_pchar_to_string@Base 0.6.3
++ jl_phicnode_type@Base 0.7.0~beta2
++ jl_phinode_type@Base 0.7.0~beta2
++ jl_pinode_type@Base 0.7.0~beta2
++ jl_pointer_type@Base 0.6.3
++ jl_pointer_typename@Base 0.6.3
++ jl_pointerref@Base 0.6.3
++ jl_pointerset@Base 0.6.3
++ jl_pop_handler@Base 0.6.3
++ jl_preload_sysimg_so@Base 0.6.3
++ jl_prepend_cwd@Base 0.7.0~beta2
++ jl_printf@Base 0.6.3
++ jl_process_events@Base 0.6.3
++ jl_profile_clear_data@Base 0.6.3
++ jl_profile_delay_nsec@Base 0.6.3
++ jl_profile_get_data@Base 0.6.3
++ jl_profile_init@Base 0.6.3
++ jl_profile_is_running@Base 0.6.3
++ jl_profile_len_data@Base 0.6.3
++ jl_profile_maxlen_data@Base 0.6.3
++ jl_profile_start_timer@Base 0.6.3
++ jl_profile_stop_timer@Base 0.6.3
++ jl_ptr_to_array@Base 0.6.3
++ jl_ptr_to_array_1d@Base 0.6.3
++ jl_ptrarrayref@Base 0.7.0~beta2
++ jl_pwrite@Base 0.6.3
++ jl_queue_work@Base 0.6.3
++ jl_quotenode_type@Base 0.6.3
++ jl_raise_debugger@Base 0.6.3
++ jl_read_verify_header@Base 0.6.3
++ jl_readonlymemory_exception@Base 0.6.3
++ jl_readuntil@Base 0.6.3
++ jl_realloc@Base 0.6.3
++ jl_ref_type@Base 0.6.3
++ jl_register_newmeth_tracer@Base 0.6.3
++ jl_rem_float@Base 0.6.3
++ jl_repl_raise_sigtstp@Base 0.7.0~beta2
++ jl_reshape_array@Base 0.6.3
++ jl_restore_excstack@Base 1.1.0+dfsg
++ jl_restore_incremental@Base 0.6.3
++ jl_restore_incremental_from_buf@Base 0.6.3
++ jl_restore_system_image@Base 0.6.3
++ jl_restore_system_image_data@Base 0.6.3
++ jl_rethrow@Base 0.6.3
++ jl_rethrow_other@Base 0.6.3
++ jl_rettype_inferred@Base 1.2.0~rc2
++ jl_rint_llvm@Base 0.6.3
++ jl_rint_llvm_withtype@Base 0.6.3
++ jl_run_once@Base 0.6.3
++ jl_running_on_valgrind@Base 0.6.3
++ jl_safe_printf@Base 0.6.3
++ jl_save_incremental@Base 0.6.3
++ jl_save_system_image@Base 0.6.3
++ jl_sdiv_int@Base 0.6.3
++ jl_set_ARGS@Base 0.6.3
++ jl_set_const@Base 0.6.3
++ jl_set_errno@Base 0.6.3
++ jl_set_global@Base 0.6.3
++ jl_set_istopmod@Base 0.6.3
++ jl_set_method_inferred@Base 0.6.3
++ jl_set_module_nospecialize@Base 0.7.0
++ jl_set_module_uuid@Base 0.7.0~beta2
++ jl_set_nth_field@Base 0.6.3
++ jl_set_ptls_states_getter@Base 0.6.3
++ jl_set_sysimg_so@Base 0.6.3
++ jl_set_task_tid@Base 1.3.0+dfsg
++ jl_set_typeinf_func@Base 0.6.3
++ jl_set_zero_subnormals@Base 0.6.3
++ jl_sext_int@Base 0.6.3
++ jl_shl_int@Base 0.6.3
++ jl_sig_throw@Base 1.1.0+dfsg
++ jl_sigatomic_begin@Base 0.6.3
++ jl_sigatomic_end@Base 0.6.3
++ jl_signal_pending@Base 0.6.3
++ jl_signed_type@Base 0.6.3
++ jl_simplevector_type@Base 0.6.3
++ jl_sitofp@Base 0.6.3
++ jl_sizeof_ios_t@Base 0.6.3
++ jl_sizeof_jl_options@Base 0.7.0~beta2
++ jl_sizeof_mode_t@Base 0.6.3
++ jl_sizeof_off_t@Base 0.6.3
++ jl_sizeof_stat@Base 0.6.3
++ jl_sizeof_uv_fs_t@Base 0.6.3
++ jl_sle_int@Base 0.6.3
++ jl_slotnumber_type@Base 0.6.3
++ jl_slt_int@Base 0.6.3
++ jl_smod_int@Base 0.6.3
++ jl_sockaddr_from_addrinfo@Base 0.6.3
++ jl_sockaddr_host4@Base 0.6.3
++ jl_sockaddr_host6@Base 0.6.3
++ jl_sockaddr_is_ip4@Base 0.6.3
++ jl_sockaddr_is_ip6@Base 0.6.3
++ jl_sockaddr_port4@Base 1.3.0+dfsg
++ jl_sockaddr_port6@Base 1.3.0+dfsg
++ jl_sockaddr_set_port@Base 0.6.3
++ jl_spawn@Base 0.6.3
++ jl_specializations_get_linfo@Base 0.6.3
++ jl_specializations_lookup@Base 0.6.3
++ jl_sqrt_llvm@Base 0.6.3
++ jl_sqrt_llvm_withtype@Base 0.6.3
++ jl_srem_int@Base 0.6.3
++ jl_ssavalue_type@Base 0.6.3
++ jl_stackovf_exception@Base 0.6.3
++ jl_stat@Base 0.6.3
++ jl_stat_blksize@Base 0.6.3
++ jl_stat_blocks@Base 0.6.3
++ jl_stat_ctime@Base 0.6.3
++ jl_stat_dev@Base 0.6.3
++ jl_stat_gid@Base 0.6.3
++ jl_stat_ino@Base 0.6.3
++ jl_stat_mode@Base 0.6.3
++ jl_stat_mtime@Base 0.6.3
++ jl_stat_nlink@Base 0.6.3
++ jl_stat_rdev@Base 0.6.3
++ jl_stat_size@Base 0.6.3
++ jl_stat_uid@Base 0.6.3
++ jl_static_show@Base 0.6.3
++ jl_static_show_func_sig@Base 0.6.3
++ jl_stderr_obj@Base 0.6.3
++ jl_stderr_stream@Base 0.6.3
++ jl_stdin_stream@Base 0.6.3
++ jl_stdout_obj@Base 0.6.3
++ jl_stdout_stream@Base 0.6.3
++ jl_string_ptr@Base 0.6.3
++ jl_string_to_array@Base 0.6.3
++ jl_string_type@Base 0.6.3
++ jl_strtod_c@Base 0.6.3
++ jl_strtof_c@Base 0.6.3
++ jl_sub_float@Base 0.6.3
++ jl_sub_int@Base 0.6.3
++ jl_sub_ptr@Base 0.7.0~beta2
++ jl_substrtod@Base 0.6.3
++ jl_substrtof@Base 0.6.3
++ jl_subtype@Base 0.6.3
++ jl_subtype_env@Base 0.6.3
++ jl_subtype_env_size@Base 0.6.3
++ jl_svec1@Base 0.6.3
++ jl_svec2@Base 0.6.3
++ jl_svec@Base 0.6.3
++ jl_svec_copy@Base 0.6.3
++ jl_svec_fill@Base 0.6.3
++ jl_switchto@Base 0.6.3
++ jl_symbol@Base 0.6.3
++ jl_symbol_lookup@Base 0.6.3
++ jl_symbol_n@Base 0.6.3
++ jl_symbol_name@Base 0.6.3
++ jl_symbol_type@Base 0.6.3
++ jl_tagged_gensym@Base 0.6.3
++ jl_take_buffer@Base 0.6.3
++ jl_task_get_next@Base 1.2.0~rc2
++ jl_task_stack_buffer@Base 1.1.0+dfsg
++ jl_task_type@Base 0.6.3
++ jl_tcp_bind@Base 0.6.3
++ jl_tcp_connect@Base 1.3.0+dfsg
++ jl_tcp_getpeername@Base 0.6.3
++ jl_tcp_getsockname@Base 0.6.3
++ jl_tcp_quickack@Base 0.6.3
++ jl_tcp_reuseport@Base 0.6.3
++ jl_threadid@Base 0.6.3
++ jl_threading_enabled@Base 0.6.3
++ jl_threading_run@Base 0.6.3
++ jl_throw@Base 0.6.3
++ jl_throw_out_of_memory_error@Base 1.2.0~rc2
++ jl_too_few_args@Base 0.6.3
++ jl_too_many_args@Base 0.6.3
++ jl_top_module@Base 0.6.3
++ jl_toplevel_eval@Base 0.6.3
++ jl_toplevel_eval_in@Base 0.6.3
++ jl_true@Base 0.6.3
++ jl_trunc_int@Base 0.6.3
++ jl_trunc_llvm@Base 0.6.3
++ jl_trunc_llvm_withtype@Base 0.6.3
++ jl_try_substrtod@Base 0.6.3
++ jl_try_substrtof@Base 0.6.3
++ jl_tty_set_mode@Base 0.6.3
++ jl_tuple_typename@Base 0.6.3
++ jl_tupletype_fill@Base 0.6.3
++ jl_tvar_type@Base 0.6.3
++ jl_type_error@Base 0.6.3
++ jl_type_error_rt@Base 0.6.3
++ jl_type_intersection@Base 0.6.3
++ jl_type_intersection_with_env@Base 0.7.0~beta2
++ jl_type_morespecific@Base 0.6.3
++ jl_type_morespecific_no_subtype@Base 0.6.3
++ jl_type_type@Base 0.6.3
++ jl_type_typename@Base 0.6.3
++ jl_type_union@Base 0.6.3
++ jl_type_unionall@Base 0.6.3
++ jl_typeassert@Base 0.6.3
++ jl_typedslot_type@Base 0.6.3
++ jl_typeerror_type@Base 0.6.3
++ jl_typeinf_begin@Base 0.6.3
++ jl_typeinf_end@Base 0.6.3
++ jl_typemap_entry_type@Base 0.6.3
++ jl_typemap_level_type@Base 0.6.3
++ jl_typemax_uint@Base 0.7.0~beta2
++ jl_typename_str@Base 0.6.3
++ jl_typename_type@Base 0.6.3
++ jl_typeof@Base 0.6.3
++ jl_typeof_str@Base 0.6.3
++ jl_typeofbottom_type@Base 0.6.3
++ jl_types_equal@Base 0.6.3
++ jl_typetype_type@Base 0.6.3
++ jl_udiv_int@Base 0.6.3
++ jl_udp_bind@Base 0.6.3
++ jl_udp_send@Base 0.6.3
++ jl_uint16_type@Base 0.6.3
++ jl_uint32_type@Base 0.6.3
++ jl_uint64_type@Base 0.6.3
++ jl_uint8_type@Base 0.6.3
++ jl_uitofp@Base 0.6.3
++ jl_ule_int@Base 0.6.3
++ jl_ult_int@Base 0.6.3
++ jl_unbox_bool@Base 0.6.3
++ jl_unbox_float32@Base 0.6.3
++ jl_unbox_float64@Base 0.6.3
++ jl_unbox_int16@Base 0.6.3
++ jl_unbox_int32@Base 0.6.3
++ jl_unbox_int64@Base 0.6.3
++ jl_unbox_int8@Base 0.6.3
++ jl_unbox_uint16@Base 0.6.3
++ jl_unbox_uint32@Base 0.6.3
++ jl_unbox_uint64@Base 0.6.3
++ jl_unbox_uint8@Base 0.6.3
++ jl_unbox_voidpointer@Base 0.6.3
++ jl_uncompress_argname_n@Base 1.2.0~rc2
++ jl_uncompress_argnames@Base 1.2.0~rc2
++ jl_uncompress_ast@Base 0.6.3
++ jl_undefined_var_error@Base 0.6.3
++ jl_undefref_exception@Base 0.6.3
++ jl_undefvarerror_type@Base 0.6.3
++ jl_unionall_type@Base 0.6.3
++ jl_uniontype_type@Base 0.6.3
++ jl_upsilonnode_type@Base 0.7.0~beta2
++ jl_urem_int@Base 0.6.3
++ jl_uv_associate_julia_struct@Base 0.6.3
++ jl_uv_buf_base@Base 0.6.3
++ jl_uv_buf_len@Base 0.6.3
++ jl_uv_buf_set_base@Base 0.6.3
++ jl_uv_buf_set_len@Base 0.6.3
++ jl_uv_connect_handle@Base 0.6.3
++ jl_uv_disassociate_julia_struct@Base 0.6.3
++ jl_uv_file_handle@Base 0.6.3
++ jl_uv_fs_t_path@Base 1.2.0~rc2
++ jl_uv_fs_t_ptr@Base 0.6.3
++ jl_uv_handle@Base 0.6.3
++ jl_uv_handle_data@Base 0.6.3
++ jl_uv_handle_type@Base 0.6.3
++ jl_uv_interface_address_is_internal@Base 0.6.3
++ jl_uv_interface_address_sockaddr@Base 0.6.3
++ jl_uv_interface_addresses@Base 0.6.3
++ jl_uv_process_data@Base 0.6.3
++ jl_uv_process_pid@Base 1.1.0+dfsg
++ jl_uv_putb@Base 0.6.3
++ jl_uv_putc@Base 0.6.3
++ jl_uv_puts@Base 0.6.3
++ jl_uv_req_data@Base 0.6.3
++ jl_uv_req_set_data@Base 0.6.3
++ jl_uv_sizeof_interface_address@Base 0.6.3
++ jl_uv_stderr@Base 0.6.3
++ jl_uv_stdin@Base 0.6.3
++ jl_uv_stdout@Base 0.6.3
++ jl_uv_unix_fd_is_watched@Base 0.6.3
++ jl_uv_write@Base 0.6.3
++ jl_uv_write_handle@Base 0.6.3
++ jl_uv_writecb@Base 0.6.3
++ jl_value_ptr@Base 0.6.3
++ jl_valueof@Base 0.6.3
++ jl_vararg_type@Base 0.6.3
++ jl_vararg_typename@Base 0.6.3
++ jl_vecelement_typename@Base 0.6.3
++ jl_ver_is_release@Base 0.6.3
++ jl_ver_major@Base 0.6.3
++ jl_ver_minor@Base 0.6.3
++ jl_ver_patch@Base 0.6.3
++ jl_ver_string@Base 0.6.3
++ jl_vexceptionf@Base 1.2.0~rc2
++ jl_void_type@Base 0.6.3
++ jl_voidpointer_type@Base 0.6.3
++ jl_vprintf@Base 0.6.3
++ jl_wakeup_thread@Base 1.2.0~rc2
++ jl_weakref_type@Base 0.6.3
++ jl_world_counter@Base 0.6.3
++ jl_xor_int@Base 0.6.3
++ jl_yield@Base 0.6.3
++ jl_zext_int@Base 0.6.3
++ jlbacktrace@Base 0.6.3
++ julia_init__threading@Base 0.7.0~beta2
++ julia_type_to_llvm@Base 0.6.3
++ libsupport_init@Base 0.6.3
++ memhash32@Base 0.6.3
++ memhash32_seed@Base 0.6.3
++ memhash@Base 0.6.3
++ memhash_seed@Base 0.6.3
++ u8_charnum@Base 0.6.3
++ u8_isvalid@Base 0.6.3
++ u8_offset@Base 0.6.3
++ u8_strwidth@Base 0.6.3
++ uv__accept4@Base 0.7.0~beta2
++ uv__accept@Base 0.7.0~beta2
++ uv__async_close@Base 0.7.0~beta2
++ uv__async_stop@Base 0.7.0~beta2
++ uv__calloc@Base 0.7.0~beta2
++ uv__check_close@Base 0.7.0~beta2
++ uv__cloexec_fcntl@Base 0.7.0~beta2
++ uv__cloexec_ioctl@Base 0.7.0~beta2
++ uv__close@Base 0.7.0~beta2
++ uv__close_nocancel@Base 1.3.0+dfsg
++ uv__close_nocheckstdio@Base 0.7.0~beta2
++ uv__count_bufs@Base 0.7.0~beta2
++ uv__dup2_cloexec@Base 0.7.0~beta2
++ uv__dup3@Base 0.7.0~beta2
++ uv__eventfd2@Base 0.7.0~beta2
++ uv__eventfd@Base 0.7.0~beta2
++ uv__fd_exists@Base 1.1.0+dfsg
++ uv__free@Base 0.7.0~beta2
++ uv__fs_event_close@Base 0.7.0~beta2
++ uv__fs_get_dirent_type@Base 1.3.0+dfsg
++ uv__fs_poll_close@Base 0.7.0~beta2
++ uv__fs_readdir_cleanup@Base 1.3.0+dfsg
++ uv__fs_scandir_cleanup@Base 0.7.0~beta2
++ uv__getaddrinfo_translate_error@Base 0.7.0~beta2
++ uv__getiovmax@Base 0.7.0~beta2
++ uv__getpwuid_r@Base 0.7.0~beta2
++ uv__getsockpeername@Base 1.1.0+dfsg
++ uv__handle_type@Base 0.7.0~beta2
++ uv__hrtime@Base 0.7.0~beta2
++ uv__idle_close@Base 0.7.0~beta2
++ uv__idna_toascii@Base 1.1.0+dfsg
++ uv__inotify_add_watch@Base 0.7.0~beta2
++ uv__inotify_init1@Base 0.7.0~beta2
++ uv__inotify_init@Base 0.7.0~beta2
++ uv__inotify_rm_watch@Base 0.7.0~beta2
++ uv__io_active@Base 0.7.0~beta2
++ uv__io_check_fd@Base 0.7.0~beta2
++ uv__io_close@Base 0.7.0~beta2
++ uv__io_feed@Base 0.7.0~beta2
++ uv__io_init@Base 0.7.0~beta2
++ uv__io_poll@Base 0.7.0~beta2
++ uv__io_start@Base 0.7.0~beta2
++ uv__io_stop@Base 0.7.0~beta2
++ uv__loop_close@Base 0.7.0~beta2
++ uv__loop_configure@Base 0.7.0~beta2
++ uv__make_close_pending@Base 0.7.0~beta2
++ uv__make_pipe@Base 0.7.0~beta2
++ uv__malloc@Base 0.7.0~beta2
++ uv__next_timeout@Base 0.7.0~beta2
++ uv__nonblock_fcntl@Base 0.7.0~beta2
++ uv__nonblock_ioctl@Base 0.7.0~beta2
++ uv__open_cloexec@Base 0.7.0~beta2
++ uv__open_file@Base 0.7.0~beta2
++ uv__pipe2@Base 0.7.0~beta2
++ uv__pipe_close@Base 0.7.0~beta2
++ uv__platform_invalidate_fd@Base 0.7.0~beta2
++ uv__platform_loop_delete@Base 0.7.0~beta2
++ uv__platform_loop_init@Base 0.7.0~beta2
++ uv__poll_close@Base 0.7.0~beta2
++ uv__preadv@Base 0.7.0~beta2
++ uv__prepare_close@Base 0.7.0~beta2
++ uv__process_close@Base 0.7.0~beta2
++ uv__pwritev@Base 0.7.0~beta2
++ uv__realloc@Base 0.7.0~beta2
++ uv__recvmmsg@Base 0.7.0~beta2
++ uv__recvmsg@Base 0.7.0~beta2
++ uv__run_check@Base 0.7.0~beta2
++ uv__run_idle@Base 0.7.0~beta2
++ uv__run_prepare@Base 0.7.0~beta2
++ uv__run_timers@Base 0.7.0~beta2
++ uv__sendmmsg@Base 0.7.0~beta2
++ uv__server_io@Base 0.7.0~beta2
++ uv__set_process_title@Base 0.7.0~beta2
++ uv__signal_close@Base 0.7.0~beta2
++ uv__signal_global_once_init@Base 0.7.0~beta2
++ uv__signal_loop_cleanup@Base 0.7.0~beta2
++ uv__socket@Base 0.7.0~beta2
++ uv__socket_sockopt@Base 0.7.0~beta2
++ uv__statx@Base 1.3.0+dfsg
++ uv__strdup@Base 0.7.0~beta2
++ uv__stream_close@Base 0.7.0~beta2
++ uv__stream_destroy@Base 0.7.0~beta2
++ uv__stream_flush_write_queue@Base 0.7.0~beta2
++ uv__stream_init@Base 0.7.0~beta2
++ uv__stream_open@Base 0.7.0~beta2
++ uv__strndup@Base 0.7.0~beta2
++ uv__strscpy@Base 1.3.0+dfsg
++ uv__tcp_bind@Base 0.7.0~beta2
++ uv__tcp_close@Base 0.7.0~beta2
++ uv__tcp_connect@Base 0.7.0~beta2
++ uv__tcp_keepalive@Base 0.7.0~beta2
++ uv__tcp_nodelay@Base 0.7.0~beta2
++ uv__timer_close@Base 0.7.0~beta2
++ uv__udp_bind@Base 0.7.0~beta2
++ uv__udp_check_before_send@Base 1.1.0+dfsg
++ uv__udp_close@Base 0.7.0~beta2
++ uv__udp_connect@Base 1.1.0+dfsg
++ uv__udp_disconnect@Base 1.1.0+dfsg
++ uv__udp_finish_close@Base 0.7.0~beta2
++ uv__udp_is_connected@Base 1.1.0+dfsg
++ uv__udp_recv_start@Base 0.7.0~beta2
++ uv__udp_recv_stop@Base 0.7.0~beta2
++ uv__udp_send@Base 0.7.0~beta2
++ uv__udp_try_send@Base 0.7.0~beta2
++ uv__utf8_decode1@Base 1.1.0+dfsg
++ uv__work_done@Base 0.7.0~beta2
++ uv__work_submit@Base 0.7.0~beta2
++ uv_accept@Base 0.6.3
++ uv_async_init@Base 0.6.3
++ uv_async_send@Base 0.6.3
++ uv_backend_fd@Base 0.6.3
++ uv_backend_timeout@Base 0.6.3
++ uv_barrier_destroy@Base 0.6.3
++ uv_barrier_init@Base 0.6.3
++ uv_barrier_wait@Base 0.6.3
++ uv_buf_init@Base 0.6.3
++ uv_cancel@Base 0.6.3
++ uv_chdir@Base 0.6.3
++ uv_check_init@Base 0.6.3
++ uv_check_start@Base 0.6.3
++ uv_check_stop@Base 0.6.3
++ uv_close@Base 0.6.3
++ uv_cond_broadcast@Base 0.6.3
++ uv_cond_destroy@Base 0.6.3
++ uv_cond_init@Base 0.6.3
++ uv_cond_signal@Base 0.6.3
++ uv_cond_timedwait@Base 0.6.3
++ uv_cond_wait@Base 0.6.3
++ uv_cpu_info@Base 0.6.3
++ uv_cpumask_size@Base 0.7.0~beta2
++ uv_cwd@Base 0.6.3
++ uv_default_loop@Base 0.6.3
++ uv_disable_stdio_inheritance@Base 0.6.3
++ uv_dlclose@Base 0.6.3
++ uv_dlerror@Base 0.6.3
++ uv_dlopen@Base 0.6.3
++ uv_dlsym@Base 0.6.3
++ uv_err_name@Base 0.6.3
++ uv_err_name_r@Base 1.1.0+dfsg
++ uv_exepath@Base 0.6.3
++ uv_fileno@Base 0.6.3
++ uv_free_cpu_info@Base 0.6.3
++ uv_free_interface_addresses@Base 0.6.3
++ uv_freeaddrinfo@Base 0.6.3
++ uv_fs_access@Base 0.6.3
++ uv_fs_chmod@Base 0.6.3
++ uv_fs_chown@Base 0.6.3
++ uv_fs_close@Base 0.6.3
++ uv_fs_closedir@Base 1.3.0+dfsg
++ uv_fs_copyfile@Base 1.1.0+dfsg
++ uv_fs_event_getpath@Base 0.6.3
++ uv_fs_event_init@Base 0.6.3
++ uv_fs_event_start@Base 0.6.3
++ uv_fs_event_stop@Base 0.6.3
++ uv_fs_fchmod@Base 0.6.3
++ uv_fs_fchown@Base 0.6.3
++ uv_fs_fdatasync@Base 0.6.3
++ uv_fs_fstat@Base 0.6.3
++ uv_fs_fsync@Base 0.6.3
++ uv_fs_ftruncate@Base 0.6.3
++ uv_fs_futime@Base 0.6.3
++ uv_fs_futime_ex@Base 1.1.0+dfsg
++ uv_fs_get_path@Base 1.1.0+dfsg
++ uv_fs_get_ptr@Base 1.1.0+dfsg
++ uv_fs_get_result@Base 1.1.0+dfsg
++ uv_fs_get_statbuf@Base 1.1.0+dfsg
++ uv_fs_get_type@Base 1.1.0+dfsg
++ uv_fs_lchown@Base 1.1.0+dfsg
++ uv_fs_link@Base 0.6.3
++ uv_fs_lstat@Base 0.6.3
++ uv_fs_mkdir@Base 0.6.3
++ uv_fs_mkdtemp@Base 0.6.3
++ uv_fs_open@Base 0.6.3
++ uv_fs_opendir@Base 1.3.0+dfsg
++ uv_fs_poll_getpath@Base 0.6.3
++ uv_fs_poll_init@Base 0.6.3
++ uv_fs_poll_start@Base 0.6.3
++ uv_fs_poll_stop@Base 0.6.3
++ uv_fs_read@Base 0.6.3
++ uv_fs_readdir@Base 1.3.0+dfsg
++ uv_fs_readlink@Base 0.6.3
++ uv_fs_realpath@Base 0.6.3
++ uv_fs_rename@Base 0.6.3
++ uv_fs_req_cleanup@Base 0.6.3
++ uv_fs_rmdir@Base 0.6.3
++ uv_fs_scandir@Base 0.6.3
++ uv_fs_scandir_next@Base 0.6.3
++ uv_fs_sendfile@Base 0.6.3
++ uv_fs_stat@Base 0.6.3
++ uv_fs_symlink@Base 0.6.3
++ uv_fs_unlink@Base 0.6.3
++ uv_fs_utime@Base 0.6.3
++ uv_fs_utime_ex@Base 1.1.0+dfsg
++ uv_fs_write@Base 0.6.3
++ uv_get_constrained_memory@Base 1.3.0+dfsg
++ uv_get_free_memory@Base 0.6.3
++ uv_get_process_title@Base 0.6.3
++ uv_get_total_memory@Base 0.6.3
++ uv_getaddrinfo@Base 0.6.3
++ uv_getnameinfo@Base 0.6.3
++ uv_getrusage@Base 0.6.3
++ uv_gettimeofday@Base 1.3.0+dfsg
++ uv_guess_handle@Base 0.6.3
++ uv_handle_get_data@Base 1.1.0+dfsg
++ uv_handle_get_loop@Base 1.1.0+dfsg
++ uv_handle_get_type@Base 1.1.0+dfsg
++ uv_handle_set_data@Base 1.1.0+dfsg
++ uv_handle_size@Base 0.6.3
++ uv_handle_type_name@Base 1.1.0+dfsg
++ uv_has_ref@Base 0.6.3
++ uv_hrtime@Base 0.6.3
++ uv_idle_init@Base 0.6.3
++ uv_idle_start@Base 0.6.3
++ uv_idle_stop@Base 0.6.3
++ uv_if_indextoiid@Base 1.1.0+dfsg
++ uv_if_indextoname@Base 1.1.0+dfsg
++ uv_inet_ntop@Base 0.6.3
++ uv_inet_pton@Base 0.6.3
++ uv_interface_addresses@Base 0.6.3
++ uv_ip4_addr@Base 0.6.3
++ uv_ip4_name@Base 0.6.3
++ uv_ip6_addr@Base 0.6.3
++ uv_ip6_name@Base 0.6.3
++ uv_is_active@Base 0.6.3
++ uv_is_closing@Base 0.6.3
++ uv_is_readable@Base 0.6.3
++ uv_is_writable@Base 0.6.3
++ uv_key_create@Base 0.6.3
++ uv_key_delete@Base 0.6.3
++ uv_key_get@Base 0.6.3
++ uv_key_set@Base 0.6.3
++ uv_kill@Base 0.6.3
++ uv_listen@Base 0.6.3
++ uv_loadavg@Base 0.6.3
++ uv_loop_alive@Base 0.6.3
++ uv_loop_close@Base 0.6.3
++ uv_loop_configure@Base 0.6.3
++ uv_loop_delete@Base 0.6.3
++ uv_loop_get_data@Base 1.1.0+dfsg
++ uv_loop_init@Base 0.6.3
++ uv_loop_new@Base 0.6.3
++ uv_loop_set_data@Base 1.1.0+dfsg
++ uv_loop_size@Base 0.6.3
++ uv_mutex_destroy@Base 0.6.3
++ uv_mutex_init@Base 0.6.3
++ uv_mutex_init_recursive@Base 1.1.0+dfsg
++ uv_mutex_lock@Base 0.6.3
++ uv_mutex_trylock@Base 0.6.3
++ uv_mutex_unlock@Base 0.6.3
++ uv_now@Base 0.6.3
++ uv_once@Base 0.6.3
++ uv_os_free_passwd@Base 0.6.3
++ uv_os_get_passwd@Base 0.6.3
++ uv_os_getenv@Base 0.7.0~beta2
++ uv_os_gethostname@Base 0.7.0~beta2
++ uv_os_getpid@Base 1.1.0+dfsg
++ uv_os_getppid@Base 1.1.0+dfsg
++ uv_os_getpriority@Base 1.1.0+dfsg
++ uv_os_homedir@Base 0.6.3
++ uv_os_setenv@Base 0.7.0~beta2
++ uv_os_setpriority@Base 1.1.0+dfsg
++ uv_os_tmpdir@Base 0.6.3
++ uv_os_uname@Base 1.3.0+dfsg
++ uv_os_unsetenv@Base 0.7.0~beta2
++ uv_pipe@Base 0.7.0~beta2
++ uv_pipe_bind@Base 0.6.3
++ uv_pipe_chmod@Base 1.1.0+dfsg
++ uv_pipe_connect@Base 0.6.3
++ uv_pipe_getpeername@Base 0.6.3
++ uv_pipe_getsockname@Base 0.6.3
++ uv_pipe_init@Base 0.6.3
++ uv_pipe_listen@Base 0.7.0~beta2
++ uv_pipe_open@Base 0.6.3
++ uv_pipe_pending_count@Base 0.6.3
++ uv_pipe_pending_instances@Base 0.6.3
++ uv_pipe_pending_type@Base 0.6.3
++ uv_poll_init@Base 0.6.3
++ uv_poll_start@Base 0.6.3
++ uv_poll_stop@Base 0.6.3
++ uv_prepare_init@Base 0.6.3
++ uv_prepare_start@Base 0.6.3
++ uv_prepare_stop@Base 0.6.3
++ uv_print_active_handles@Base 0.6.3
++ uv_print_all_handles@Base 0.6.3
++ uv_process_get_pid@Base 1.1.0+dfsg
++ uv_process_kill@Base 0.6.3
++ uv_queue_work@Base 0.6.3
++ uv_read_start@Base 0.6.3
++ uv_read_stop@Base 0.6.3
++ uv_recv_buffer_size@Base 0.6.3
++ uv_ref@Base 0.6.3
++ uv_replace_allocator@Base 0.6.3
++ uv_req_get_data@Base 1.1.0+dfsg
++ uv_req_get_type@Base 1.1.0+dfsg
++ uv_req_set_data@Base 1.1.0+dfsg
++ uv_req_size@Base 0.6.3
++ uv_req_type_name@Base 1.1.0+dfsg
++ uv_resident_set_memory@Base 0.6.3
++ uv_run@Base 0.6.3
++ uv_rwlock_destroy@Base 0.6.3
++ uv_rwlock_init@Base 0.6.3
++ uv_rwlock_rdlock@Base 0.6.3
++ uv_rwlock_rdunlock@Base 0.6.3
++ uv_rwlock_tryrdlock@Base 0.6.3
++ uv_rwlock_trywrlock@Base 0.6.3
++ uv_rwlock_wrlock@Base 0.6.3
++ uv_rwlock_wrunlock@Base 0.6.3
++ uv_sem_destroy@Base 0.6.3
++ uv_sem_init@Base 0.6.3
++ uv_sem_post@Base 0.6.3
++ uv_sem_trywait@Base 0.6.3
++ uv_sem_wait@Base 0.6.3
++ uv_send_buffer_size@Base 0.6.3
++ uv_set_process_title@Base 0.6.3
++ uv_setup_args@Base 0.6.3
++ uv_shutdown@Base 0.6.3
++ uv_signal_init@Base 0.6.3
++ uv_signal_start@Base 0.6.3
++ uv_signal_start_oneshot@Base 0.7.0~beta2
++ uv_signal_stop@Base 0.6.3
++ uv_socketpair@Base 0.7.0~beta2
++ uv_spawn@Base 0.6.3
++ uv_stop@Base 0.6.3
++ uv_stream_get_write_queue_size@Base 1.1.0+dfsg
++ uv_stream_set_blocking@Base 0.6.3
++ uv_strerror@Base 0.6.3
++ uv_strerror_r@Base 1.1.0+dfsg
++ uv_tcp_bind@Base 0.6.3
++ uv_tcp_connect@Base 0.6.3
++ uv_tcp_getpeername@Base 0.6.3
++ uv_tcp_getsockname@Base 0.6.3
++ uv_tcp_init@Base 0.6.3
++ uv_tcp_init_ex@Base 0.6.3
++ uv_tcp_keepalive@Base 0.6.3
++ uv_tcp_listen@Base 0.7.0~beta2
++ uv_tcp_nodelay@Base 0.6.3
++ uv_tcp_open@Base 0.6.3
++ uv_tcp_simultaneous_accepts@Base 0.6.3
++ uv_thread_create@Base 0.6.3
++ uv_thread_create_ex@Base 1.3.0+dfsg
++ uv_thread_detach@Base 0.6.3
++ uv_thread_equal@Base 0.6.3
++ uv_thread_getaffinity@Base 0.6.3
++ uv_thread_join@Base 0.6.3
++ uv_thread_self@Base 0.6.3
++ uv_thread_setaffinity@Base 0.6.3
++ uv_timer_again@Base 0.6.3
++ uv_timer_get_repeat@Base 0.6.3
++ uv_timer_init@Base 0.6.3
++ uv_timer_set_repeat@Base 0.6.3
++ uv_timer_start@Base 0.6.3
++ uv_timer_stop@Base 0.6.3
++ uv_translate_sys_error@Base 0.7.0~beta2
++ uv_try_write@Base 0.6.3
++ uv_try_write_cb@Base 0.7.0~beta2
++ uv_tty_get_winsize@Base 0.6.3
++ uv_tty_init@Base 0.6.3
++ uv_tty_reset_mode@Base 0.6.3
++ uv_tty_set_mode@Base 0.6.3
++ uv_udp_bind@Base 0.6.3
++ uv_udp_connect@Base 1.1.0+dfsg
++ uv_udp_get_send_queue_count@Base 1.1.0+dfsg
++ uv_udp_get_send_queue_size@Base 1.1.0+dfsg
++ uv_udp_getpeername@Base 1.1.0+dfsg
++ uv_udp_getsockname@Base 0.6.3
++ uv_udp_init@Base 0.6.3
++ uv_udp_init_ex@Base 0.6.3
++ uv_udp_open@Base 0.6.3
++ uv_udp_recv_start@Base 0.6.3
++ uv_udp_recv_stop@Base 0.6.3
++ uv_udp_send@Base 0.6.3
++ uv_udp_set_broadcast@Base 0.6.3
++ uv_udp_set_membership@Base 0.6.3
++ uv_udp_set_multicast_interface@Base 0.6.3
++ uv_udp_set_multicast_loop@Base 0.6.3
++ uv_udp_set_multicast_ttl@Base 0.6.3
++ uv_udp_set_ttl@Base 0.6.3
++ uv_udp_try_send@Base 0.6.3
++ uv_unref@Base 0.6.3
++ uv_update_time@Base 0.6.3
++ uv_uptime@Base 0.6.3
++ uv_version@Base 0.6.3
++ uv_version_string@Base 0.6.3
++ uv_walk@Base 0.6.3
++ uv_write2@Base 0.6.3
++ uv_write@Base 0.6.3
--- /dev/null
--- /dev/null
++activate-noawait ldconfig
--- /dev/null
--- /dev/null
++usr/share/doc/julia/html/*
++usr/share/icons/hicolor/icon-theme.cache
--- /dev/null
--- /dev/null
++Description https://github.com/JuliaLang/julia/pull/31399/files
++--- a/Make.inc
+++++ b/Make.inc
++@@ -813,6 +813,7 @@
++ ifneq (,$(findstring aarch64,$(ARCH)))
++ OPENBLAS_DYNAMIC_ARCH:=0
++ OPENBLAS_TARGET_ARCH:=ARMV8
+++BINARY:=64
++ endif
++
++ # Set MARCH-specific flags
--- /dev/null
--- /dev/null
++--- a/deps/checksums/SuiteSparse-5.4.0.tar.gz/md5
+++++ b/deps/checksums/SuiteSparse-5.4.0.tar.gz/md5
++@@ -1 +1 @@
++-4a6d4e74fc44c503f52996ae95cad03a
+++c5463d7b292f5e8f6da736dd75c0a4ea
++--- a/deps/checksums/SuiteSparse-5.4.0.tar.gz/sha512
+++++ b/deps/checksums/SuiteSparse-5.4.0.tar.gz/sha512
++@@ -1 +1 @@
++-8328bcc2ef5eb03febf91b9c71159f091ff405c1ba7522e53714120fcf857ceab2d2ecf8bf9a2e1fc45e1a934665a341e3a47f954f87b59934f4fce6164775d6
+++2ade6c921e6f7ce6efe2806c4ea273ee3b66ebe9cf0c846274f16d1124f1c2de57c782b12f3936adefa3029bf30bb6d9a7dd38f1a6a88c3e096737471cafcd69
--- /dev/null
--- /dev/null
++Description: enable distro julia packages so that they are immediately importable after install
++See: https://github.com/cdluminate/DistroHelper.jl
++ https://github.com/JuliaLang/julia/issues/30528
++Author: Mo Zhou
++
++diff --git a/base/initdefs.jl b/base/initdefs.jl
++index f95c22b4..e63d395b 100644
++--- a/base/initdefs.jl
+++++ b/base/initdefs.jl
++@@ -61,6 +61,7 @@ end
++ # entries starting with `@` are named environments:
++ # - the first three `#`s in a named environment are replaced with version numbers
++ # - `@stdlib` is a special name for the standard library and expands to its path
+++# - `@distro` is a special name for distributions' vendored julia packages
++
++ # if you want a current env setup, use direnv and
++ # have your .envrc do something like this:
++@@ -70,7 +71,7 @@ end
++ # this will inherit an existing JULIA_LOAD_PATH value or if there is none, leave
++ # a trailing empty entry in JULIA_LOAD_PATH which will be replaced with defaults.
++
++-const DEFAULT_LOAD_PATH = ["@", "@v#.#", "@stdlib"]
+++const DEFAULT_LOAD_PATH = ["@", "@v#.#", "@stdlib", "@distro"]
++
++ """
++ LOAD_PATH
--- /dev/null
--- /dev/null
++Description: Let it download the embedded source tarball through a file:// URI
++Author: Mo Zhou
++Last-Update: 20180711
++Forward: no need
++
++--- a/deps/libuv.mk
+++++ b/deps/libuv.mk
++@@ -1,6 +1,5 @@
++ ## LIBUV ##
++-LIBUV_GIT_URL:=git://github.com/JuliaLang/libuv.git
++-LIBUV_TAR_URL=https://api.github.com/repos/JuliaLang/libuv/tarball/$1
+++LIBUV_TAR_URL=file://$(CURDIR)/../debian/embedded/libuv-$1.tar.gz
++ $(eval $(call git-external,libuv,LIBUV,configure,,$(SRCCACHE)))
++
++ ifneq ($(USE_BINARYBUILDER_LIBUV),1)
--- /dev/null
--- /dev/null
++Description: prevent upstream build system from accessing internet
++Author: Mo Zhou
++Forwarded: no need
++Last-Update: 20180719
++--- a/deps/libwhich.mk
+++++ b/deps/libwhich.mk
++@@ -1,6 +1,5 @@
++ ## LIBWHICH ##
++-LIBWHICH_GIT_URL := git://github.com/vtjnash/libwhich.git
++-LIBWHICH_TAR_URL = https://api.github.com/repos/vtjnash/libwhich/tarball/$1
+++LIBWHICH_TAR_URL = file://$(CURDIR)/../debian/embedded/libwhich-$1.tar.gz
++ $(eval $(call git-external,libwhich,LIBWHICH,,,$(BUILDDIR)))
++
++ LIBWHICH_OBJ_LIB := $(build_depsbindir)/libwhich
--- /dev/null
--- /dev/null
++--- a/deps/llvm.mk
+++++ b/deps/llvm.mk
++@@ -171,7 +171,7 @@
++ LLVM_CMAKE += -DLLVM_TOOL_LLDB_BUILD=OFF
++ endif
++
++-LLVM_SRC_URL := http://releases.llvm.org/$(LLVM_VER)
+++LLVM_SRC_URL := file://$(shell pwd)/../debian/embedded/$(LLVM_VER)
++
++ ifneq ($(LLVM_CLANG_TAR),)
++ $(LLVM_CLANG_TAR): | $(SRCCACHE)
--- /dev/null
--- /dev/null
++--- a/deps/blas.mk
+++++ b/deps/blas.mk
++@@ -1,7 +1,7 @@
++ ## OpenBLAS ##
++ # LAPACK is built into OpenBLAS by default
++ OPENBLAS_GIT_URL := git://github.com/xianyi/OpenBLAS.git
++-OPENBLAS_TAR_URL = https://api.github.com/repos/xianyi/OpenBLAS/tarball/$1
+++OPENBLAS_TAR_URL = file:///$(CURDIR)/../debian/embedded/$1
++ $(eval $(call git-external,openblas,OPENBLAS,,,$(BUILDDIR)))
++
++ OPENBLAS_BUILD_OPTS := CC="$(CC)" FC="$(FC)" LD="$(LD)" RANLIB="$(RANLIB)" TARGET=$(OPENBLAS_TARGET_ARCH) BINARY=$(BINARY)
--- /dev/null
--- /dev/null
++Description: Prevent upstream build system from downloading Pkg.jl
++Forward: no need
++Author: Mo Zhou
++--- a/stdlib/Makefile
+++++ b/stdlib/Makefile
++@@ -20,7 +20,8 @@
++ SharedArrays Sockets SparseArrays Statistics SuiteSparse Test Unicode UUIDs
++ STDLIBS_EXT = Pkg
++ PKG_GIT_URL := git://github.com/JuliaLang/Pkg.jl.git
++-PKG_TAR_URL = https://api.github.com/repos/JuliaLang/Pkg.jl/tarball/$1
+++PKG_TAR_URL = file://$(CURDIR)/../debian/embedded/$1
+++
++
++ $(foreach module, $(STDLIBS_EXT), $(eval $(call stdlib-external,$(module),$(shell echo $(module) | tr a-z A-Z))))
++
--- /dev/null
--- /dev/null
++--- a/deps/suitesparse.mk
+++++ b/deps/suitesparse.mk
++@@ -33,7 +33,7 @@
++ endif
++
++ $(SRCCACHE)/SuiteSparse-$(SUITESPARSE_VER).tar.gz: | $(SRCCACHE)
++- $(JLDOWNLOAD) $@ http://faculty.cse.tamu.edu/davis/SuiteSparse/$(notdir $@)
+++ $(JLDOWNLOAD) $@ file:///$(CURDIR)/../debian/embedded/$(notdir $@)
++
++ $(BUILDDIR)/SuiteSparse-$(SUITESPARSE_VER)/source-extracted: $(SRCCACHE)/SuiteSparse-$(SUITESPARSE_VER).tar.gz
++ $(JLCHECKSUM) $<
--- /dev/null
--- /dev/null
++Description: Prevent the build system from downloading anything while building docs.
++Forwarded: no need.
++Author: Mo Zhou
++Last-Update: 2018-07-03
++
++--- a/doc/make.jl
+++++ b/doc/make.jl
++@@ -3,8 +3,7 @@
++ push!(LOAD_PATH, @__DIR__, "@stdlib")
++ empty!(DEPOT_PATH)
++ pushfirst!(DEPOT_PATH, joinpath(@__DIR__, "deps"))
++-using Pkg
++-Pkg.instantiate()
+++push!(LOAD_PATH, "../debian/embedded")
++
++ using Documenter, DocumenterLaTeX
++
++--- a/doc/Makefile
+++++ b/doc/Makefile
++@@ -25,12 +25,8 @@
++ texplatform=$(texplatform)
++
++ $(SRCCACHE)/UnicodeData.txt:
++- @mkdir -p "$(SRCCACHE)"
++- $(JLDOWNLOAD) "$@" http://www.unicode.org/Public/9.0.0/ucd/UnicodeData.txt
++-
++-deps: $(SRCCACHE)/UnicodeData.txt
++- $(JLCHECKSUM) "$<"
++- cp "$<" UnicodeData.txt
+++deps:
+++ true
++
++ clean:
++ -rm -rf _build/* deps/* docbuild.log UnicodeData.txt
++--- a/doc/Project.toml
+++++ b/doc/Project.toml
++@@ -1,3 +1 @@
++-[deps]
++-Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
++ DocumenterLaTeX = "cd674d7a-5f81-5cf3-af33-235ef1834b99"
--- /dev/null
--- /dev/null
++diff --git a/debian/embedded/Documenter.jl-0.20.0/src/Writers/LaTeXWriter.jl b/debian/embedded/Documenter.jl-0.20.0/src/Writers/LaTeXWriter.jl
++index f442d959..51ce92e7 100644
++--- a/debian/embedded/Documenter.jl-0.20.0/src/Writers/LaTeXWriter.jl
+++++ b/debian/embedded/Documenter.jl-0.20.0/src/Writers/LaTeXWriter.jl
++@@ -87,7 +87,7 @@ function render(doc::Documents.Document)
++ outdir = joinpath(doc.user.root, doc.user.build)
++ pdf = replace("$(doc.user.sitename).pdf", " " => "")
++ try
++- run(`latexmk -f -interaction=nonstopmode -view=none -lualatex -shell-escape $file`)
+++ run(`latexmk -silent -f -interaction=nonstopmode -view=none -lualatex -shell-escape $file`)
++ catch err
++ Utilities.warn("failed to compile. Check generated LaTeX file.")
++ cp(file, joinpath(outdir, file); force = true)
++
++diff --git a/debian/embedded/Documenter.jl-0.21.0/src/Writers/LaTeXWriter.jl b/debian/embedded/Documenter.jl-0.21.0/src/Writers/LaTeXWriter.jl
++index 9b98b34e..21727866 100644
++--- a/debian/embedded/Documenter.jl-0.21.0/src/Writers/LaTeXWriter.jl
+++++ b/debian/embedded/Documenter.jl-0.21.0/src/Writers/LaTeXWriter.jl
++@@ -139,7 +139,7 @@ function compile_tex(doc::Documents.Document, settings::LaTeX, texfile::String)
++ Sys.which("latexmk") === nothing && (@error "LaTeXWriter: latexmk command not found."; return false)
++ @info "LaTeXWriter: using latexmk to compile tex."
++ try
++- piperun(`latexmk -f -interaction=nonstopmode -view=none -lualatex -shell-escape $texfile`)
+++ piperun(`latexmk -silent -f -interaction=nonstopmode -view=none -lualatex -shell-escape $texfile`)
++ return true
++ catch err
++ logs = cp(pwd(), mktempdir(); force=true)
--- /dev/null
--- /dev/null
++Description: build documentation using Debian's unicode data,
++ instead of a downloaded one
++Forwarded: no need
++Author: Mo Zhou
++--- a/doc/src/manual/unicode-input.md
+++++ b/doc/src/manual/unicode-input.md
++@@ -31,7 +31,7 @@
++ end
++
++ function unicode_data()
++- file = normpath(@__DIR__, "..", "..", "..", "..", "..", "doc", "UnicodeData.txt")
+++ file = "/usr/share/unicode/UnicodeData.txt"
++ names = Dict{UInt32, String}()
++ open(file) do unidata
++ for line in readlines(unidata)
--- /dev/null
--- /dev/null
++Description: Let the upstream downloader used during build be verbose,
++ and prevent it from accessing internet.
++Author: Mo Zhou
++Last-Update: 20180711
++Forwarded: no need
++
++--- a/deps/tools/jldownload
+++++ b/deps/tools/jldownload
++@@ -2,6 +2,7 @@
++ #
++ # usage: jldownload [<output-filename>] <url>
++ #
+++set -x
++
++ CACHE_HOST=https://cache.julialang.org
++
++@@ -44,4 +45,5 @@
++ # forward to the original URL if it has not cached this download yet, or
++ # if the URL is not cacheable. We fallback to directly querying the
++ # uncached URL to protect against cache service downtime
++-$GETURL $CACHE_URL || $GETURL $URL
+++#$GETURL $CACHE_URL || $GETURL $URL
+++$GETURL $URL
--- /dev/null
--- /dev/null
++--- a/test/offsetarray.jl
+++++ b/test/offsetarray.jl
++@@ -474,8 +474,8 @@
++
++ @test rotl90(A) == OffsetArray(rotl90(parent(A)), A.offsets[[2,1]])
++ @test rotr90(A) == OffsetArray(rotr90(parent(A)), A.offsets[[2,1]])
++-@test reverse(A, dims=1) == OffsetArray(reverse(parent(A), dims=1), A.offsets)
++-@test reverse(A, dims=2) == OffsetArray(reverse(parent(A), dims=2), A.offsets)
+++#@test reverse(A, dims=1) == OffsetArray(reverse(parent(A), dims=1), A.offsets)
+++#@test reverse(A, dims=2) == OffsetArray(reverse(parent(A), dims=2), A.offsets)
++
++ @test A .+ 1 == OffsetArray(parent(A) .+ 1, A.offsets)
++ @test 2*A == OffsetArray(2*parent(A), A.offsets)
--- /dev/null
--- /dev/null
++--- a/test/file.jl
+++++ b/test/file.jl
++@@ -428,8 +428,9 @@
++ @test stat(file).gid == 0
++ @test stat(file).uid == 0
++ else
++- @test_throws Base.IOError chown(file, -2, -1) # Non-root user cannot change ownership to another user
++- @test_throws Base.IOError chown(file, -1, -2) # Non-root user cannot change group to a group they are not a member of (eg: nogroup)
+++# @test_throws Base.IOError chown(file, -2, -1) # Non-root user cannot change ownership to another user
+++# @test_throws Base.IOError chown(file, -1, -2) # Non-root user cannot change group to a group they are not a member of (eg: nogroup)
+++ true
++ end
++ else
++ # test that chown doesn't cause any errors for Windows
++--- a/test/read.jl
+++++ b/test/read.jl
++@@ -462,8 +462,9 @@
++ if !Sys.iswindows() && get(ENV, "USER", "") != "root" && get(ENV, "HOME", "") != "/root"
++ # msvcrt _wchmod documentation states that all files are readable,
++ # so we don't test that it correctly set the umask on windows
++- @test_throws SystemError open(f)
++- @test_throws Base.IOError Base.Filesystem.open(f, Base.Filesystem.JL_O_RDONLY)
+++# @test_throws SystemError open(f)
+++# @test_throws Base.IOError Base.Filesystem.open(f, Base.Filesystem.JL_O_RDONLY)
+++ true
++ else
++ Sys.iswindows() || @warn "File permissions tests skipped due to running tests as root (not recommended)"
++ close(open(f))
++@@ -509,12 +510,12 @@
++ close(f2)
++ @test eof(f1)
++ @test_throws Base.IOError eof(f2)
++-if get(ENV, "USER", "") != "root" && get(ENV, "HOME", "") != "/root"
++- @test_throws SystemError open(f, "r+")
++- @test_throws Base.IOError Base.Filesystem.open(f, Base.Filesystem.JL_O_RDWR)
++-else
++- @warn "File permissions tests skipped due to running tests as root (not recommended)"
++-end
+++#if get(ENV, "USER", "") != "root" && get(ENV, "HOME", "") != "/root"
+++# @test_throws SystemError open(f, "r+")
+++# @test_throws Base.IOError Base.Filesystem.open(f, Base.Filesystem.JL_O_RDWR)
+++#else
+++# @warn "File permissions tests skipped due to running tests as root (not recommended)"
+++#end
++ chmod(f, 0o600)
++ f1 = open(f, "r+")
++ f2 = Base.Filesystem.open(f, Base.Filesystem.JL_O_RDWR)
--- /dev/null
--- /dev/null
++Description: Do not compile and install the debugging version of Julia
++Author: Sébastien Villemot <sebastien@debian.org>
++Author: Mo Zhou <cdluminate@gmail.com>
++Forwarded: not-needed
++Last-Update: 2018-07-19
++---
++This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
++--- a/Makefile
+++++ b/Makefile
++@@ -4,7 +4,7 @@
++ VERSDIR := v`cut -d. -f1-2 < $(JULIAHOME)/VERSION`
++
++ default: $(JULIA_BUILD_MODE) # contains either "debug" or "release"
++-all: debug release
+++all: release
++
++ # sort is used to remove potential duplicates
++ DIRS := $(sort $(build_bindir) $(build_depsbindir) $(build_libdir) $(build_private_libdir) $(build_libexecdir) $(build_includedir) $(build_includedir)/julia $(build_sysconfdir)/julia $(build_datarootdir)/julia $(build_datarootdir)/julia/stdlib $(build_man1dir))
--- /dev/null
--- /dev/null
++Description: we use openblas 0.3.7 because 0.3.5 has severe
++ problem with GCC9
++--- a/deps/openblas.version
+++++ b/deps/openblas.version
++@@ -1,2 +1,2 @@
++-OPENBLAS_BRANCH=v0.3.5
++-OPENBLAS_SHA1=eebc18928715775c9ed254684edee16e4efe0342
+++OPENBLAS_BRANCH=v0.3.7
+++OPENBLAS_SHA1=6a79b36d1bf73584a513139806d226f9189d621e
++--- a/deps/blas.mk
+++++ b/deps/blas.mk
++@@ -95,8 +95,6 @@
++ ifneq ($(USE_BINARYBUILDER_OPENBLAS), 1)
++
++ $(BUILDDIR)/$(OPENBLAS_SRC_DIR)/openblas-skylakexdgemm.patch-applied: $(BUILDDIR)/$(OPENBLAS_SRC_DIR)/source-extracted
++- cd $(BUILDDIR)/$(OPENBLAS_SRC_DIR) && \
++- patch -p1 -f < $(SRCDIR)/patches/openblas-skylakexdgemm.patch
++ echo 1 > $@
++
++ $(BUILDDIR)/$(OPENBLAS_SRC_DIR)/build-configured: $(BUILDDIR)/$(OPENBLAS_SRC_DIR)/openblas-skylakexdgemm.patch-applied
--- /dev/null
--- /dev/null
++Purpose: fix lintian error caused by embedded documenter
++Author: Mo Zhou <cdluminate@gmail.com>
++
++--- a/debian/embedded/Documenter/assets/html/documenter.css
+++++ b/debian/embedded/Documenter/assets/html/documenter.css
++@@ -21,7 +21,7 @@ body, input {
++ }
++
++ pre, code, kbd {
++- font-family: 'Roboto Mono', Monaco, courier, monospace;
+++ font-family: Inconsolata, Monaco, courier, monospace;
++ font-size: 0.90em;
++ }
++
++--- a/debian/embedded/Documenter/assets/html/documenter.js
+++++ b/debian/embedded/Documenter/assets/html/documenter.js
++@@ -7,13 +7,14 @@
++
++ requirejs.config({
++ paths: {
++- 'jquery': 'https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min',
++- 'jqueryui': 'https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.12.0/jquery-ui.min',
++- 'headroom': 'https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.3/headroom.min',
++- 'mathjax': 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS_HTML',
++- 'highlight': 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min',
++- 'highlight-julia': 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/julia.min',
++- 'highlight-julia-repl': 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/julia-repl.min',
+++ 'jquery': 'file:///usr/share/javascript/jquery/jquery.min.js',
+++ 'jqueryui': 'file:///usr/share/javascript/jquery-ui/jquery-ui.min.js',
+++ //'headroom': 'https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.3/headroom.min',
+++ 'headroom': 'http://localhost',
+++ 'mathjax': 'file:///usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS_HTML',
+++ 'highlight': 'file:///usr/lib/nodejs/highlight.js/highlight.js',
+++ 'highlight-julia': 'file:////usr/lib/nodejs/highlight.js/languages/julia.js',
+++ 'highlight-julia-repl': 'file:////usr/lib/nodejs/highlight.js/languages/julia-repl.js',
++ },
++ shim: {
++ 'mathjax' : {
++
++--- a/debian/embedded/Documenter/src/Writers/HTMLWriter.jl
+++++ b/debian/embedded/Documenter/src/Writers/HTMLWriter.jl
++@@ -98,11 +98,12 @@ import ...Documenter:
++ import ...Utilities.DOM: DOM, Tag, @tags
++ using ...Utilities.MDFlatten
++
++-const requirejs_cdn = "https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js"
++-const normalize_css = "https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css"
++-const google_fonts = "https://fonts.googleapis.com/css?family=Lato|Roboto+Mono"
++-const fontawesome_css = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css"
++-const highlightjs_css = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"
+++const requirejs_cdn = "file:///usr/share/javascript/requirejs/require.min.js"
+++const normalize_css = "file:///usr/share/javascript/normalize.css/normalize.min.css"
+++const google_fonts = "file:///usr/share/doc/julia-doc/fontface.css"
+++const fontawesome_css = "file:///usr/share/fonts-font-awesome/css/font-awesome.min.css"
+++const highlightjs_css = "file:///usr/share/javascript/highlight.js/styles/default.css"
+++
++
++ """
++ [`HTMLWriter`](@ref)-specific globals that are passed to [`domify`](@ref) and
--- /dev/null
--- /dev/null
++Description: Julia requires SSE2 on i386
++ This patch adds an explicit error message if the CPU does not support SSE2.
++ The CPU features are queried using the x86 CPUID opcode. The wrapper function
++ __get_cpuid() is provided by GCC and Clang. See <cpuid.h> for the list of
++ supported CPU extension flags.
++Author: Sébastien Villemot <sebastien@debian.org>
++Author: Peter Colberg <peter@colberg.org>
++Bug: https://github.com/JuliaLang/julia/issues/7185
++Forwarded: no
++Last-Update: 2015-11-01
++---
++This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
++--- a/src/codegen.cpp
+++++ b/src/codegen.cpp
++@@ -18,6 +18,9 @@
++ #endif
++
++ #include <setjmp.h>
+++#ifdef __i386__
+++#include <cpuid.h>
+++#endif
++ #include <string>
++ #include <sstream>
++ #include <fstream>
++@@ -7629,6 +7632,15 @@
++
++ extern "C" void *jl_init_llvm(void)
++ {
+++#ifdef __i386__
+++ unsigned int eax = 0, ebx = 0, ecx = 0, edx = 0;
+++ __get_cpuid(1, &eax, &ebx, &ecx, &edx);
+++ if (!(edx & bit_SSE2)) {
+++ fprintf(stderr, "Your processor does not have SSE2 extension, which is required by Julia. Exiting.\n");
+++ exit(EXIT_FAILURE);
+++ }
+++#endif
+++
++ const char *const argv_tailmerge[] = {"", "-enable-tail-merge=0"}; // NOO TOUCHIE; NO TOUCH! See #922
++ cl::ParseCommandLineOptions(sizeof(argv_tailmerge)/sizeof(argv_tailmerge[0]), argv_tailmerge, "disable-tail-merge\n");
++ #if defined(_OS_WINDOWS_) && defined(_CPU_X86_64_)
--- /dev/null
--- /dev/null
++# Build system and feature
++mask-failing-tests.patch
++jldownload-verbose-fakedownload.patch
++support-noopt.patch
++require-sse2-on-i386.patch
++no-debug-version.patch
++do-not-download-libuv.patch
++do-not-download-libwhich.patch
++do-not-download-pkgjl.patch
++do-not-download-llvm.patch
++do-not-download-openblas.patch
++openblas037.patch
++do-not-download-suitesparse.patch
++checksum-suitesparse.patch
++doc-make.patch
++doc-unicode-data-path.patch
++
++# distro integration, wip, experimental, disabled by default
++#default-load-path-distro.patch
++
++# Test
++test-skip-sigint.patch
++test-skip-dns-ubuntu.patch
++
++# This patch is for embedded sources. Already pre-applied.
++# privacy-breach.patch
++# doc-silent.patch
++
++mask-tests-1.2.0.patch
++arm64-openblas.patch
--- /dev/null
--- /dev/null
++Description: Remove hardcoded GCC optimization flags
++ This is necessary in order to make DEB_BUILD_OPTIONS=noopt work as expected.
++ .
++ Note that the hack on llvm-config --cxxflags is not absolutely needed, because
++ the -O2 that it brings come before the -O0 brought by dpkg-buildflags. But I
++ leave it for clarity.
++Author: Sébastien Villemot <sebastien@debian.org>
++Forwarded: not-needed
++Last-Update: 2015-11-17
++---
++This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
++--- a/Make.inc
+++++ b/Make.inc
++@@ -469,7 +469,7 @@
++ JCXXFLAGS += -pedantic
++ endif
++ DEBUGFLAGS := -O0 -ggdb2 -DJL_DEBUG_BUILD -fstack-protector-all
++-SHIPFLAGS := -O3 -ggdb2 -falign-functions
+++SHIPFLAGS := -ggdb2 -falign-functions
++ endif
++
++ ifeq ($(USECLANG),1)
++--- a/deps/suitesparse.mk
+++++ b/deps/suitesparse.mk
++@@ -119,7 +119,7 @@
++
++ $(build_shlibdir)/libsuitesparse_wrapper.$(SHLIB_EXT): $(SRCDIR)/SuiteSparse_wrapper.c
++ mkdir -p $(build_shlibdir)
++- $(CC) $(CPPFLAGS) $(CFLAGS) $(LDFLAGS) -O2 -shared $(fPIC) $(SUITESPARSE_INC) $< -o $@ $(SUITESPARSE_LIB)
+++ $(CC) $(CPPFLAGS) $(CFLAGS) $(LDFLAGS) -shared $(fPIC) $(SUITESPARSE_INC) $< -o $@ $(SUITESPARSE_LIB)
++ $(INSTALL_NAME_CMD)libsuitesparse_wrapper.$(SHLIB_EXT) $@
++ touch -c $@
++
++--- a/src/Makefile
+++++ b/src/Makefile
++@@ -150,7 +150,7 @@
++ $(BUILDDIR)/%.dbg.obj: $(SRCDIR)/%.c $(HEADERS) | $(BUILDDIR)
++ @$(call PRINT_CC, $(CC) $(JCPPFLAGS) $(JCFLAGS) $(DEBUGFLAGS) -c $< -o $@)
++ $(BUILDDIR)/%.o: $(SRCDIR)/%.cpp $(SRCDIR)/llvm-version.h $(HEADERS) $(LLVM_CONFIG_ABSOLUTE) | $(BUILDDIR)
++- @$(call PRINT_CC, $(CXX) $(shell $(LLVM_CONFIG_HOST) --cxxflags) $(JCPPFLAGS) $(JCXXFLAGS) $(SHIPFLAGS) $(CXX_DISABLE_ASSERTION) -c $< -o $@)
+++ @$(call PRINT_CC, $(CXX) $(shell $(LLVM_CONFIG_HOST) --cxxflags | sed 's/^/ /;s/$$/ /;s/\s-O.\s/ /') $(JCPPFLAGS) $(JCXXFLAGS) $(SHIPFLAGS) $(CXX_DISABLE_ASSERTION) -c $< -o $@)
++ $(BUILDDIR)/%.dbg.obj: $(SRCDIR)/%.cpp $(SRCDIR)/llvm-version.h $(HEADERS) $(LLVM_CONFIG_ABSOLUTE) | $(BUILDDIR)
++ @$(call PRINT_CC, $(CXX) $(shell $(LLVM_CONFIG_HOST) --cxxflags) $(JCPPFLAGS) $(JCXXFLAGS) $(DEBUGFLAGS) -c $< -o $@)
++
--- /dev/null
--- /dev/null
++Description: Skip DNS tests which fail on Ubuntu autopkgtest infrastructure
++Author: Graham Inggs <ginggs@debian.org>
++Last-Update: 2018-10-01
++
++--- a/stdlib/Sockets/test/runtests.jl
+++++ b/stdlib/Sockets/test/runtests.jl
++@@ -163,25 +163,25 @@
++ end
++
++ @testset "getnameinfo on some unroutable IP addresses (RFC 5737)" begin
++- @test getnameinfo(ip"192.0.2.1") == "192.0.2.1"
++- @test getnameinfo(ip"198.51.100.1") == "198.51.100.1"
++- @test getnameinfo(ip"203.0.113.1") == "203.0.113.1"
++- @test getnameinfo(ip"0.1.1.1") == "0.1.1.1"
++- @test getnameinfo(ip"::ffff:0.1.1.1") == "::ffff:0.1.1.1"
++- @test getnameinfo(ip"::ffff:192.0.2.1") == "::ffff:192.0.2.1"
++- @test getnameinfo(ip"2001:db8::1") == "2001:db8::1"
+++# @test getnameinfo(ip"192.0.2.1") == "192.0.2.1"
+++# @test getnameinfo(ip"198.51.100.1") == "198.51.100.1"
+++# @test getnameinfo(ip"203.0.113.1") == "203.0.113.1"
+++# @test getnameinfo(ip"0.1.1.1") == "0.1.1.1"
+++# @test getnameinfo(ip"::ffff:0.1.1.1") == "::ffff:0.1.1.1"
+++# @test getnameinfo(ip"::ffff:192.0.2.1") == "::ffff:192.0.2.1"
+++# @test getnameinfo(ip"2001:db8::1") == "2001:db8::1"
++ end
++
++ @testset "getnameinfo on some valid IP addresses" begin
++ @test !isempty(getnameinfo(ip"::")::String)
++- @test !isempty(getnameinfo(ip"0.0.0.0")::String)
++- @test !isempty(getnameinfo(ip"10.1.0.0")::String)
++- @test !isempty(getnameinfo(ip"10.1.0.255")::String)
++- @test !isempty(getnameinfo(ip"10.1.255.1")::String)
++- @test !isempty(getnameinfo(ip"255.255.255.255")::String)
++- @test !isempty(getnameinfo(ip"255.255.255.0")::String)
++- @test !isempty(getnameinfo(ip"192.168.0.1")::String)
++- @test !isempty(getnameinfo(ip"::1")::String)
+++# @test !isempty(getnameinfo(ip"0.0.0.0")::String)
+++# @test !isempty(getnameinfo(ip"10.1.0.0")::String)
+++# @test !isempty(getnameinfo(ip"10.1.0.255")::String)
+++# @test !isempty(getnameinfo(ip"10.1.255.1")::String)
+++# @test !isempty(getnameinfo(ip"255.255.255.255")::String)
+++# @test !isempty(getnameinfo(ip"255.255.255.0")::String)
+++# @test !isempty(getnameinfo(ip"192.168.0.1")::String)
+++# @test !isempty(getnameinfo(ip"::1")::String)
++ end
++
++ @testset "getaddrinfo" begin
--- /dev/null
--- /dev/null
++Description: temporarily skip this test which causes random test failure. Further investigation needed.
++Forward: never
++Last-Update: 20180812
++Author: Mo Zhou
++
++--- a/test/stress.jl
+++++ b/test/stress.jl
++@@ -91,16 +91,3 @@
++ test_22566()
++ end
++ end # !Sys.iswindows
++-
++-# sig 2 is SIGINT per the POSIX.1-1990 standard
++-if !Sys.iswindows()
++- ccall(:jl_exit_on_sigint, Cvoid, (Cint,), 0)
++- @test_throws InterruptException begin
++- ccall(:kill, Cvoid, (Cint, Cint,), getpid(), 2)
++- for i in 1:10
++- Libc.systemsleep(0.1)
++- ccall(:jl_gc_safepoint, Cvoid, ()) # wait for SIGINT to arrive
++- end
++- end
++- ccall(:jl_exit_on_sigint, Cvoid, (Cint,), 1)
++-end
--- /dev/null
--- /dev/null
++# This example changes the default prompt string.
++# Just include this file in ~/.julia/config/startup.jl
++# For more tweaks to your REPL, please install the "OhMyREPL" package.
++import REPL
++function myrepl(repl)
++ repl.interface = REPL.setup_interface(repl)
++ repl.interface.modes[1].prompt = "⛬ >"
++ return
++end
++atreplinit(myrepl)
--- /dev/null
--- /dev/null
++#!/usr/bin/make -f
++include /usr/share/dpkg/default.mk
++export DEB_BUILD_MAINT_OPTIONS=hardening=+all
++
++# Disable unaligned access on armhf
++ifneq (,$(filter $(DEB_HOST_ARCH),armhf))
++ export DEB_CFLAGS_MAINT_APPEND += -mno-unaligned-access
++endif
++
++# Ensure pcre_h.jl and errno_h.jl are sorted reproducibly
++export LC_ALL=C.UTF-8
++# HOME is needed to avoid "mkdir(): Permission denied" while building docs.
++# Some tests also need a HOME directory.
++export HOME=/tmp
++# If you want to do a custom build of Julia against MKL, set it to 1.
++export CUSTOM_MKL ?= 0
++# If you want to do a custom build for native machine architecture
++export CUSTOM_NATIVE ?= 0
++
++LLVM_VER = $(shell grep -e 'llvm-.*-dev' debian/control | cut -d- -f2)
++
++# NOTES:
++# 1. Some of these flags come from upstream's Make.inc .
++# 2. To enable USE_BLAS64=0 (ILP64), we need to set INTERFACE64=1 for OpenBLAS.
++# 3. Julia is tightly coupled with a specific libuv1 version. we cannot use the one provided in archive.
++# 4. ∴ is unicode "therefore", ⛬ is unicode "historic site" https://unicode-table.com/en/26EC/
++COMMON_FLAGS = \
++ prefix=/usr \
++ sysconfdir=/etc \
++ DESTDIR=debian/tmp/ \
++ LLVM_CONFIG=/usr/bin/llvm-config-$(LLVM_VER) \
++ LLVM_VER=$(LLVM_VER) \
++ MULTIARCH=$(DEB_HOST_MULTIARCH) \
++ MULTIARCH_INSTALL=1 \
++ NO_GIT=1 \
++ TAGGED_RELEASE_BANNER='$(DEB_VENDOR) ⛬ julia/$(DEB_VERSION)' \
++ USE_BINARYBUILDER=0 \
++ USE_BLAS64=1 \
++ USE_LLVM_SHLIB=1 \
++ USE_SYSTEM_BLAS=0 \
++ USE_SYSTEM_CURL=1 \
++ USE_SYSTEM_DSFMT=1 \
++ USE_SYSTEM_GMP=1 \
++ USE_SYSTEM_LAPACK=0 \
++ USE_SYSTEM_LIBGIT2=1 \
++ USE_SYSTEM_LIBSSH2=1 \
++ USE_SYSTEM_LIBUNWIND=1 \
++ USE_SYSTEM_LIBUV=0 \
++ USE_SYSTEM_LLVM=1 \
++ USE_SYSTEM_MBEDTLS=1 \
++ USE_SYSTEM_MPFR=1 \
++ USE_SYSTEM_OPENSPECFUN=1 \
++ USE_SYSTEM_P7ZIP=1 \
++ USE_SYSTEM_PATCHELF=1 \
++ USE_SYSTEM_PCRE=1 \
++ USE_SYSTEM_SUITESPARSE=0 \
++ USE_SYSTEM_UTF8PROC=1 \
++ USE_SYSTEM_ZLIB=1 \
++ VERBOSE=1
++
++# Set architecture specific CPU targets. See: #910784
++ifneq (,$(filter $(DEB_HOST_ARCH),amd64 kfreebsd-amd64 x32))
++COMMON_FLAGS += MARCH=x86-64 \
++ JULIA_CPU_TARGET="generic;sandybridge,-xsaveopt,clone_all;haswell,-rdrnd,base(1)"
++else ifneq (,$(filter $(DEB_HOST_ARCH),i386 hurd-i386 kfreebsd-i386))
++COMMON_FLAGS += MARCH=pentium4 \
++ JULIA_CPU_TARGET="pentium4;sandybridge,-xsaveopt,clone_all"
++else ifneq (,$(filter $(DEB_HOST_ARCH),arm64))
++COMMON_FLAGS += USE_BLAS64=0
++else ifneq (,$(filter $(DEB_HOST_ARCH),armhf))
++COMMON_FLAGS += JULIA_CPU_TARGET="armv7-a;armv7-a,neon;armv7-a,neon,vfp4"
++else ifneq (,$(filter $(DEB_HOST_ARCH),ppc64el))
++COMMON_FLAGS += JULIA_CPU_TARGET="pwr8"
++else
++COMMON_FLAGS += JULIA_CPU_TARGET="generic"
++endif
++
++# Use libopenlibm on architectures that have it
++ifneq (,$(filter $(DEB_HOST_ARCH),amd64 kfreebsd-amd64 x32))
++COMMON_FLAGS += USE_SYSTEM_OPENLIBM=1 USE_SYSTEM_LIBM=0
++else ifneq (,$(filter $(DEB_HOST_ARCH),i386 hurd-i386 kfreebsd-i386))
++COMMON_FLAGS += USE_SYSTEM_OPENLIBM=1 USE_SYSTEM_LIBM=0
++else ifneq (,$(filter $(DEB_HOST_ARCH),arm64 armhf mips mips64el mipsel powerpc ppc64 ppc64el))
++COMMON_FLAGS += USE_SYSTEM_OPENLIBM=1 USE_SYSTEM_LIBM=0
++else
++# Use libm elsewhere
++COMMON_FLAGS += USE_SYSTEM_OPENLIBM=0 USE_SYSTEM_LIBM=1
++endif
++
++# Use libopenblas on architectures that have it.
++# Use libblas and liblapack elsewhere
++ifeq (,$(filter $(DEB_HOST_ARCH),amd64 arm64 armhf i386 kfreebsd-amd64 kfreebsd-i386 mips64el ppc64el s390x))
++COMMON_FLAGS += LIBBLAS=-lblas LIBBLASNAME=libblas \
++ LIBLAPACK=-llapack LIBLAPACKNAME=liblapack
++endif
++
++# Set number of parallel workers for tests
++ifneq (,$(filter parallel=1,$(DEB_BUILD_OPTIONS)))
++TESTS_ENV += JULIA_CPU_THREADS=2
++else ifneq (,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
++TESTS_ENV += JULIA_CPU_THREADS=$(patsubst parallel=%,%,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
++else
++TESTS_ENV += JULIA_CPU_THREADS=2
++endif
++# Restart workers exceeding maximum resident memory size (requires JULIA_CPU_THREADS >= 2)
++TESTS_ENV += JULIA_TEST_MAXRSS_MB=500
++
++ifeq (1,$(CUSTOM_MKL))
++COMMON_FLAGS += USE_INTEL_MKL=1 USE_BLAS64=1 \
++ LIBBLAS=-lmkl_rt LIBBLASNAME=libmkl_rt \
++ LIBLAPACK=-lmkl_rt LIBLAPACKNAME=libmkl_rt \
++ MKLROOT=/usr MKLLIB=/usr/lib/$(DEB_HOST_MULTIARCH)
++endif
++ifeq (1,$(CUSTOM_NATIVE))
++COMMON_FLAGS += MARCH=native JULIA_CPU_TARGET=native
++endif
++
++
++%:
++ dh $@
++
++override_dh_auto_build-arch:
++ dh_auto_build -- $(COMMON_FLAGS)
++
++override_dh_auto_build-indep:
++ dh_auto_build -- $(COMMON_FLAGS)
++ #-$(MAKE) -C doc pdf
++
++override_dh_auto_test-arch:
++ifeq (,$(filter nocheck,$(DEB_BUILD_OPTIONS)))
++ifeq (,$(filter $(DEB_HOST_ARCH),amd64 i386))
++ -env $(TESTS_ENV) make -C test $(COMMON_FLAGS)
++else
++ #XXX: the dash is temporary
++ -env $(TESTS_ENV) make -C test $(COMMON_FLAGS)
++endif
++endif
++
++override_dh_auto_test-indep:
++
++override_dh_auto_clean:
++ make $(COMMON_FLAGS) distcleanall
++ make -f debian/shlibdeps.mk $(COMMON_FLAGS) clean
++
++override_dh_auto_install:
++ make $(COMMON_FLAGS) install
++ rm -rf usr # Otherwise dh_install does not see debian/tmp/usr
++ find debian -type f -name '*.so.debug' -delete
++ find debian -type f -name .gitignore -delete
++ find debian -type f -name 'LICENSE.md' -delete
++
++override_dh_missing:
++ dh_missing --list-missing
++
++override_dh_link-arch:
++ # Create *.so symlinks for dlopen'd libraries in private libdir.
++ make -f debian/shlibdeps.mk $(COMMON_FLAGS)
++ dh_link
++
++override_dh_shlibdeps:
++ # Generate dependencies for dlopen'd libraries using dummy executable.
++ # Suppress useless dependency warnings caused by unused library symbols.
++ dh_shlibdeps -- --warnings=1 debian/shlibdeps
++
++override_dh_compress:
++ dh_compress --exclude=examples/
++
++override_dh_install-arch:
++ dh_install -Xlibgcc_s -Xlibgfortran -Xlibquadmath
++
++override_dh_install-indep:
++ dh_install --exclude=build_h.jl --exclude=build.h
++
++override_dh_fixperms:
++ dh_fixperms
++ # Fix shebang and mode bits
++ find debian \( -type f -name '*.jl' \
++ -exec grep -q '..usr/bin/env julia' '{}' \; \
++ -a -exec sed -i -e 's@#!/usr/bin/env julia@#!/usr/bin/julia@g' '{}' \; \
++ -a -exec chmod +x '{}' \; -print \)
++
++# Don't strip sys.so and libjulia.so.* to keep the sanity of this program.
++# https://github.com/JuliaLang/julia/issues/23115#issuecomment-320715030
++#
++# Julia sysimage (i.e. sys.so) sys.so is NOT compiled from any compiled
++# language such as C/C++, but from Julia scripts instead. Julia precompiles .jl
++# scripts under the base and stdlib directories into this ELF-formated shared
++# object sys.so to speedup program startup time. A glance at the symbol table
++# (readelf -sW sys.so) would illustrate that. For more detail about how such
++# debugging information is useful, please refer the official documentation:
++# https://docs.julialang.org/en/v1.0.0/manual/stacktraces/
++#
++override_dh_strip:
++ dh_strip -X"sys.so"
++
++override_dh_makeshlibs:
++ dh_makeshlibs --no-scripts -XLLVM -Xlibopenblas64_ -Xlibcolamd -Xlibumfpack \
++ -Xlibccolamd -Xlibcholmod -Xlibcamd -Xlibamd -Xlibspqr -Xlibsuitesparseconfig
--- /dev/null
--- /dev/null
++/*
++ * Query soname of shared library.
++ * Copyright © 2015 Peter Colberg.
++ * Distributed under the MIT license.
++ */
++
++#define _GNU_SOURCE
++#include <dlfcn.h>
++#include <stdio.h>
++#include <stdlib.h>
++
++#define error(fmt, ...) fprintf(stderr, "%s: "fmt"\n", argv[0], ##__VA_ARGS__)
++
++/*
++ * For a given symbol name, this program prints the path relative to /
++ * of the shared library containing that symbol. The program must be
++ * linked against the shared libraries to be queried for symbols, and
++ * compiled as a position-independent executable using -fPIE.
++ */
++int main(int argc, const char *const *argv)
++{
++ Dl_info info;
++ void *sym;
++
++ if (argc != 2) {
++ fprintf(stderr, "Usage: %s SYMBOL\n", argv[0]);
++ return 1;
++ }
++ if (!(sym = dlsym(RTLD_DEFAULT, argv[1]))) {
++ fprintf(stderr, "%s\n", dlerror());
++ return 1;
++ }
++ if (dladdr(sym, &info) == 0) {
++ fprintf(stderr, "%s\n", dlerror());
++ return 1;
++ }
++ if (info.dli_saddr != sym) {
++ error("mismatching symbol name: %s", info.dli_sname);
++ return 1;
++ }
++ if (info.dli_fname[0] != '/') {
++ error("library name not an absolute path: %s", info.dli_fname);
++ return 1;
++ }
++ printf("%s", info.dli_fname + 1);
++ return 0;
++}
--- /dev/null
--- /dev/null
++# This makefile compiles a dummy executable linked against
++# those shared libraries that are dlopen'd by Julia modules
++# in Base. The dummy executable is passed to dpkg-shlibdeps
++# to generate library dependencies for the julia package.
++#
++# The dummy executable is further used to generate symbolic
++# links lib*.so => lib*.so.SOVERSION in the private library
++# path for Julia, which ensures that ccall() loads exactly
++# those library versions that the julia package was built
++# with and depends on.
++
++# Include Julia makefile with LIB*NAME definitions.
++JULIAHOME := $(CURDIR)
++include Make.inc
++
++TARGETS := debian/shlibdeps debian/libjulia$(SOMAJOR).links
++
++all: $(TARGETS)
++
++ifeq ($(USE_SYSTEM_BLAS),1)
++SHLIBDEPS += $(LIBBLAS)
++# OpenBLAS library provides both BLAS and LAPACK.
++ifneq ($(LIBBLASNAME),$(LIBLAPACKNAME))
++SHLIBDEPS += $(LIBLAPACK)
++endif
++endif
++
++ifeq ($(USE_SYSTEM_CURL),1)
++SHLIBDEPS += -lcurl
++endif
++
++ifeq ($(USE_SYSTEM_DSFMT),1)
++SHLIBDEPS += -ldSFMT
++endif
++
++ifeq ($(USE_SYSTEM_GMP),1)
++SHLIBDEPS += -lgmp
++endif
++
++ifeq ($(USE_SYSTEM_LIBGIT2),1)
++SHLIBDEPS += -lgit2
++endif
++
++ifeq ($(USE_SYSTEM_LIBM),1)
++SHLIBDEPS += $(LIBM)
++else ifeq ($(USE_SYSTEM_OPENLIBM),1)
++SHLIBDEPS += $(LIBM)
++endif
++
++ifeq ($(USE_SYSTEM_LIBSSH2),1)
++SHLIBDEPS += -lssh2
++endif
++
++ifeq ($(USE_SYSTEM_LIBUNWIND),1)
++ifeq (,$(filter $(DEB_HOST_ARCH),s390x))
++SHLIBDEPS += -lunwind
++endif
++endif
++
++ifeq ($(USE_SYSTEM_LIBUV),1)
++SHLIBDEPS += -luv
++endif
++
++ifeq ($(USE_SYSTEM_LLVM),1)
++SHLIBDEPS += -lLLVM -L/usr/lib/llvm-$(LLVM_VER)/lib/
++endif
++
++ifeq ($(USE_SYSTEM_MBEDTLS),1)
++SHLIBDEPS += -lmbedtls -lmbedcrypto -lmbedx509
++endif
++
++ifeq ($(USE_SYSTEM_MPFR),1)
++SHLIBDEPS += -lmpfr
++endif
++
++ifeq ($(USE_SYSTEM_PCRE),1)
++SHLIBDEPS += -lpcre2-8
++endif
++
++ifeq ($(USE_SYSTEM_SUITESPARSE),1)
++SHLIBDEPS += -lcholmod -lspqr -lsuitesparseconfig -lumfpack
++endif
++
++ifeq ($(USE_SYSTEM_UTF8PROC),1)
++SHLIBDEPS += -lutf8proc
++endif
++
++# Append other libraries
++SHLIBDEPS += -lquadmath -lgcc_s -lgfortran
++
++# The dummy executable is linked with --no-as-needed to prevent
++# the linker from potentially disregarding the given libraries
++# because none of the library symbols are used at compile time.
++debian/shlibdeps: debian/shlibdeps.c
++ $(CC) -fPIE -o $@ $< -ldl -Wl,--no-as-needed $(SHLIBDEPS)
++
++# The soname for each library is looked up by invoking the
++# dummy executable with the name of an arbitrary symbol such
++# as a function exported by that library. Ideally, these
++# should be functions that are ccall'd by the Julia modules.
++debian/libjulia$(SOMAJOR).links: debian/shlibdeps
++ rm -f $@.tmp
++ifeq ($(USE_SYSTEM_BLAS),1)
++ debian/shlibdeps daxpy_ >> $@.tmp
++ echo " $(private_libdir)/$(LIBBLASNAME).so" >> $@.tmp
++ifneq ($(LIBBLASNAME),$(LIBLAPACKNAME))
++ debian/shlibdeps dggsvd_ >> $@.tmp
++ echo " $(private_libdir)/$(LIBLAPACKNAME).so" >> $@.tmp
++endif
++endif
++ifeq ($(USE_SYSTEM_CURL),1)
++ debian/shlibdeps curl_easy_recv >> $@.tmp
++ echo " $(private_libdir)/libcurl.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_DSFMT),1)
++ debian/shlibdeps dsfmt_get_idstring >> $@.tmp
++ echo " $(private_libdir)/libdSFMT.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_GMP),1)
++ debian/shlibdeps __gmpz_get_str >> $@.tmp
++ echo " $(private_libdir)/libgmp.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_LIBGIT2),1)
++ debian/shlibdeps git_libgit2_version >> $@.tmp
++ echo " $(private_libdir)/libgit2.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_LIBM),1)
++ debian/shlibdeps pow >> $@.tmp
++ echo " $(private_libdir)/$(LIBMNAME).so" >> $@.tmp
++else ifeq ($(USE_SYSTEM_OPENLIBM),1)
++ debian/shlibdeps pow >> $@.tmp
++ echo " $(private_libdir)/$(LIBMNAME).so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_MPFR),1)
++ debian/shlibdeps mpfr_init2 >> $@.tmp
++ echo " $(private_libdir)/libmpfr.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_PCRE),1)
++ debian/shlibdeps pcre2_compile_8 >> $@.tmp
++ echo " $(private_libdir)/libpcre2-8.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_LIBSSH2),1)
++ debian/shlibdeps libssh2_version >> $@.tmp
++ echo " $(private_libdir)/libssh2.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_LIBUV),1)
++ debian/shlibdeps uv_tcp_open >> $@.tmp
++ echo " $(private_libdir)/libuv.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_LIBUNWIND),1)
++ debian/shlibdeps backtrace >> $@.tmp
++ echo " $(private_libdir)/libunwind.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_LLVM),1)
++ debian/shlibdeps llvm_regexec >> $@.tmp
++ echo " $(private_libdir)/libLLVM.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_MBEDTLS),1)
++ debian/shlibdeps mbedtls_net_init >> $@.tmp
++ echo " $(private_libdir)/libmbedtls.so" >> $@.tmp
++ debian/shlibdeps mbedtls_md5 >> $@.tmp
++ echo " $(private_libdir)/libmbedcrypto.so" >> $@.tmp
++ debian/shlibdeps mbedtls_x509_get_serial >> $@.tmp
++ echo " $(private_libdir)/libmbedx509.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_SUITESPARSE),1)
++ debian/shlibdeps cholmod_version >> $@.tmp
++ echo " $(private_libdir)/libcholmod.so" >> $@.tmp
++ debian/shlibdeps SuiteSparseQR_C_free >> $@.tmp
++ echo " $(private_libdir)/libspqr.so" >> $@.tmp
++ debian/shlibdeps SuiteSparse_config >> $@.tmp
++ echo " $(private_libdir)/libsuitesparseconfig.so" >> $@.tmp
++ debian/shlibdeps umfpack_dl_report_info >> $@.tmp
++ echo " $(private_libdir)/libumfpack.so" >> $@.tmp
++endif
++ifeq ($(USE_SYSTEM_UTF8PROC),1)
++ debian/shlibdeps utf8proc_errmsg >> $@.tmp
++ echo " $(private_libdir)/libutf8proc.so" >> $@.tmp
++endif
++ mv $@.tmp $@
++
++clean:
++ $(RM) $(TARGETS)
--- /dev/null
--- /dev/null
++3.0 (quilt)
--- /dev/null
--- /dev/null
++debian/embedded/libuv-ed3700c849289ed01fe04273a7bf865340b2bd7e.tar.gz
++debian/embedded/libwhich-81e9723c0273d78493dc8c8ed570f68d9ce7e89e.tar.gz
++debian/embedded/1609a05aee5d5960670738d8d834d91235bd6b1e
++debian/embedded/Documenter.jl-0.20.0/docs/src/man/hosting/puttygen-generated.png
++debian/embedded/Documenter.jl-0.20.0/docs/src/man/hosting/puttygen-export-private-key.png
++debian/embedded/Documenter.jl-0.20.0/docs/src/man/hosting/puttygen.png
++debian/embedded/Documenter.jl-0.20.0/docs/src/man/hosting/travis-variables.png
++debian/embedded/Documenter.jl-0.20.0/docs/src/man/hosting/github-add-deploy-key.png
++debian/embedded/Documenter.jl-0.20.0/docs/src/assets/favicon.ico
++debian/embedded/Documenter.jl-0.20.0/docs/src/assets/logo.png
++debian/embedded/Documenter.jl-0.20.0/test/examples/src/assets/favicon.ico
++debian/embedded/Documenter.jl-0.20.0/test/examples/images/logo.jpg
++debian/embedded/Documenter.jl-0.20.0/test/examples/images/logo.webp
++debian/embedded/Documenter.jl-0.20.0/test/examples/images/logo.gif
++debian/embedded/Documenter.jl-0.20.0/test/examples/images/logo.png
++debian/embedded/DocStringExtensions.jl-0.5.0/docs/src/assets/logo.png
++debian/embedded/libuv-2348256acf5759a544e5ca7935f638d2bc091d60.tar.gz
++debian/embedded/40cbbe224d4a491503279dfc5b9aefe15412f007
++debian/embedded/Documenter/test/examples/images/logo.gif
++debian/embedded/Documenter/test/examples/images/logo.jpg
++debian/embedded/Documenter/test/examples/images/logo.webp
++debian/embedded/Documenter/test/examples/images/logo.png
++debian/embedded/Documenter/test/examples/src/assets/favicon.ico
++debian/embedded/Documenter/docs/src/man/hosting/puttygen-export-private-key.png
++debian/embedded/Documenter/docs/src/man/hosting/travis-variables.png
++debian/embedded/Documenter/docs/src/man/hosting/puttygen-generated.png
++debian/embedded/Documenter/docs/src/man/hosting/github-add-deploy-key.png
++debian/embedded/Documenter/docs/src/man/hosting/puttygen.png
++debian/embedded/Documenter/docs/src/assets/favicon.ico
++debian/embedded/DocStringExtensions/docs/src/assets/favicon.ico
++debian/embedded/394e7c5d55d3722f5b2ab660ca0a694ea0041974
++debian/embedded/SuiteSparse-5.4.0.tar.gz
++debian/embedded/openblas-eebc18928715775c9ed254684edee16e4efe0342.tar.gz
++debian/embedded/eebc18928715775c9ed254684edee16e4efe0342
++debian/embedded/6a79b36d1bf73584a513139806d226f9189d621e
++debian/embedded/openblas-6a79b36d1bf73584a513139806d226f9189d621e.tar.gz
++debian/embedded/libuv-35b1504507a7a4168caae3d78db54d1121b121e1.tar.gz
++debian/embedded/5de608c7b1837a24ed84eaaa14dde017986cb460
++
--- /dev/null
--- /dev/null
++# Justification for "needs-root": https://github.com/JuliaLang/julia/issues/28023
++Tests: runtests.sh
++Restrictions: allow-stderr, needs-root
++Depends: curl, dpkg-dev, @
--- /dev/null
--- /dev/null
++#!/bin/sh
++set -ex
++
++export JULIA_TEST_MAXRSS_MB=500
++export HOME=/tmp
++
++cd $AUTOPKGTEST_TMP
++
++/usr/bin/julia \
++ --check-bounds=yes \
++ --startup-file=no \
++ /usr/share/julia/test/runtests.jl all || true # temporary
--- /dev/null
--- /dev/null
++Name: Julia
++Bug-Database: https://github.com/julialang/julia/issues
++Bug-Submit: https://github.com/julialang/julia/issues
++Cite-As: "Julia: A Fresh Approach to Numerical Computing. Jeff Bezanson, Alan Edelman, Stefan Karpinski and Viral B. Shah (2017) SIAM Review, 59: 65–98. doi: 10.1137/141000671. url: http://julialang.org/publications/julia-fresh-approach-BEKS.pdf."
++Documentation: https://docs.julialang.org/
++Reference:
++ Author: Jeff Bezanson, Alan Edelman, Stefan Karpinski and Viral B. Shah
++ Booktitle: SIAM Review
++ DOI: 10.1137/141000671
++ Number: 59
++ Pages: 65–98
++ Title: "Julia: A Fresh Approach to Numerical Computing"
++ Year: 2017
++Repository: https://github.com/JuliaLang/julia
++Repository-Browse: https://github.com/JuliaLang/julia
--- /dev/null
--- /dev/null
++version=4
++opts="filenamemangle=s%(?:.*?)?v?(\d[\d.]*)\.tar\.gz%julia-$1.tar.gz%,\
++ dversionmangle=s/\+dfsg\d*$// ,repacksuffix=+dfsg" \
++ https://github.com/JuliaLang/julia/tags \
++ (?:.*?/)?v?(\d[\d.]*)\.tar\.gz debian uupdate
projects / julia.git / commitdiff
