diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..61390ef --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +## ignore all files wo extension +* +!/**/ +!*.* + + +# Notes: +# all generated files should go inside `build/` +# use absolute paths to refer to a path assumed to be at a fixed level in the hierarchy +/build + + +nimcache + +.DS_Store + +*.exe +*.swp + diff --git a/.nojekyll b/.nojekyll deleted file mode 100644 index e69de29..0000000 diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..5a88169 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,59 @@ +os: linux +dist: bionic +language: c + +addons: + apt: + packages: + - autopoint + +matrix: + include: + # Linux - amd64 + - env: BRANCH=0.20.2 + - env: BRANCH=1.0.8 + - env: BRANCH=1.2.4 + - env: BRANCH=devel + + # Linux - arm64 + # - arch: arm64 + # env: BRANCH=1.2.4 + + # Linux - ppc64 + # - arch: ppc64le + # env: BRANCH=1.2.4 + + # macOS - amd64 + - os: osx + env: BRANCH=0.20.2 + - os: osx + env: BRANCH=1.0.8 + - os: osx + env: BRANCH=1.2.4 + - os: osx + env: BRANCH=devel + + # windows - amd64 + - os: windows + env: BRANCH=0.20.2 + - os: windows + env: BRANCH=1.0.8 + - os: windows + env: BRANCH=1.2.4 + - os: windows + env: BRANCH=devel + +cache: + directories: + - "$HOME/.choosenim" + +install: + - export PATH="/usr/local/opt/gettext/bin:$PATH" + - curl https://gist.github.com/genotrance/fb53504a4fba88bc5201d3783df5c522/raw/travis.sh -LsSf -o travis.sh + - source travis.sh + +script: + - set -e + - nimble develop -y + - nimble test + - nimble --verbose --nimbleDir:`pwd`/build/fakenimble install nimterop@#head -y diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 0000000..edd6c97 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,158 @@ +# Nimterop Change History + +## Version 0.6.0 + +This release adds the ability to download precompiled binaries from [Conan.io](https://conan.io/center) and Julia's [BinaryBuilder.org](https://binarybuilder.org). This alleviates the headache of searching and downloading libraries manually both for wrapper writers as well as end users. There are some known limitations but it should prove to become more useful as these sites expand their capabilities. + +Conan.io shared builds tend to have all dependencies statically linked into the binary so a single so/dll/dylib has everything. For Conan.io static builds and all libraries on BinaryBuilder.org, dependencies are also downloaded and linked as needed. They are returned in the new `const xxxLDeps` in case wrapper writers need it for some reason. + +Known concerns: +- Conan.io only compiles Windows builds with Microsoft's VC++ compiler so static .lib files may not always work with MinGW on Windows. +- Conan.io compiles all Mac builds on OSX 10.14 so older versions of the OS will grumble when statically linking these libraries. +- BinaryBuilder.org does not include static libs for all their projects. + +Refer to the documentation for `getHeader()` for details on how to use this new capability. + +See the full list of changes here: + +https://github.com/nimterop/nimterop/compare/v0.5.9...v0.6.5 + +### Breaking changes + +- The legacy algorithm has been removed as promised. `ast2` is now the default and wrappers no longer need to explicitly specify `-f:ast2` in order to use it. + +- All shared libraries installed by `getHeader()` will now get copied into the `libdir` parameter specified. If left blank, `libdir` will default to the directory where the executable binary gets created (outdir). While this is not really a breaking change, it is a change in behavior compared to older versions of nimterop. Note that `Std` libraries are not copied over. [#154][i154] + +- `git.nim` has been removed. This module was an artifact from the early days and was renamed to `build.nim` back in v0.2.0. + +- Nameless enum values are no longer typed to the made-up enum type name, they are instead typed as `cint` to match the underlying type. This allows using such enums without having to depend on the made-up name which could change if enum ordering changes upstream. [#236][i236] (since v0.6.1) + +- Static libraries installed and linked with `getHeader()` now have their `{.passL.}` pragmas forwarded to the generated wrapper. This might lead to link errors in existing wrappers if other dependencies are specified with `{.passL.}` calls and the order of linking is wrong. This can be fixed by changing such explicit `{.passL.}` calls with `cPassL()` which will forward the link call to the generated wrapper as well. (since v0.6.5) + +### New functionality + +- `getHeader()` now detects and links against `.lib` files as part of enabling Conan.io. Not all `.lib` files are compatible with MinGW as already stated above but for those that work, this is a required capability. + +- The `dynlib` command line parameter to `toast` and `cImport()` can also be the path to a shared library (dll|so|dylib) in place of a Nim const string containing the path. This allows for the traditional use case of passing `"xxxLPath"` to `cImport()` as well as simply passing the path to the library on the command line as is. This allows the creation of standalone cached wrappers as well as the usage of the `--check` and the `--stub` functionality that `toast` provides via `cImport()`. + +- `gitPull()` now checks if an existing repository is at the `checkout` value specified. If not, it will pull the latest changes and checkout the specified commit, tag or branch. + +- `cImport()` can now write the generated wrapper output to a user-defined file with the `nimFile` param. [#127][i127] (since v0.6.1) + +- Nimterop now supports anonymous nested structs/unions but it only works correctly for unions when `noHeader` is turned off (the default). This is because Nim does not support nested structs/unions and is unaware of the underlying memory structure. [#237][i237] (since v0.6.1) + +- `xxxJBB` now allows for customizing the base location to search packages with the `jbbFlags` param to `getHeader()`. Specifying `giturl=xxx` where `xxx` could be a full Git URL or just the username for Github.com allows changing the default Git repo. In addition, `url=xxx` is also supported to download project info and binaries compiled with BinaryBuilder.org but hosted at another non-Git location. (since v0.6.3) + +- It is now possible to exclude the contents of specific files or entire directories from the wrapped output using `--exclude | -X` with `toast` or `cExclude()` from a wrapper. This might be required when a header uses `#include` to pull in external dependencies. E.g. `sciter` has a `#include ` which pulls in the entire GTK ecosystem which is needed for successful preprocessing but we do not want to include those headers in the wrapped output when using `--recurse | -r`. (since v0.6.4) + +- All `cDefine()`, `cIncludeDir()` and `cCompile()` calls now forward relevant pragmas into the generated wrapper further enabling standalone wrappers. [#239][i239] + +- Added `cPassC()` and `cPassL()` to forward C/C++ compilation pragmas into the generated wrapper. These should be used in place of `{.passC.}` and `{.passL.}` and need to be called before `cImport()` to take effect. (since v0.6.5) + +- Added `--compile`, `--passC` and `--passL` flags to `toast` to enable the previous two improvements. (since v0.6.5) + +- Added `renderPragma()` to create pragmas inline in case `cImport()` is not being used. (since v0.6.5) + +- `xxxConan` and `xxxJBB` now allow skipping required dependencies by specifying `skip=pkg1,pkg2` to the `conanFlags` and `jbbFlags` params to `getHeader()`. (since v0.6.6) + +### Other improvements + +- Generated wrappers no longer depend on nimterop being present - no more `import nimterop/types`. Supporting code is directly included in the wrapper output and only when required. E.g. enum macro is only included if wrapper contains enums. [#125][i125] (since v0.6.1) + +- `cImport()` now includes wrapper output from a file rather than inline. Errors in generated wrappers will no longer point to a line in `macros.nim` making debugging easier. (since v0.6.1) + +- `cIncludeDir()` can now accept a `seq[string]` of directories and an optional `exclude` param which sets those include directories to not be included in the wrapped output. (since v0.6.4) + +- `cDefine()` can now accept a `seq[string]` of values. (since v0.6.5) + + +## Version 0.5.0 + +This release introduces a new backend for wrapper generation dubbed `ast2` that leverages the Nim compiler AST and renderer. The new design simplifies feature development and already includes all the functionality of the legacy algorithm plus fixes for several open issues. + +The new backend can be leveraged with the `-f:ast2` flag to `toast` or `flags = "-f:ast2"` to `cImport()`. The legacy algorithm will be the default backend for this release but no new functionality or bugfixes are expected going forward. Usage of the legacy algorithm will display a *deprecated* hint to encourage users to test their wrappers with `-f:ast2` and remove any overrides that the new algorithm supports. + +Version 0.6.0 of Nimterop will make `ast2` the default backend and the legacy algorithm will be removed altogether. + +See the full list of changes here: + +https://github.com/nimterop/nimterop/compare/v0.4.4...v0.5.4 + +### Breaking changes + +- Nimterop used to default to C++ mode for preprocessing and tree-sitter parsing in all cases unless explicitly informed to use C mode. This has been changed and is now detected based on the file extension. This means some existing wrappers could break since they might contain C++ code or include C++ headers like `#include ` which will not work in C mode. Explicitly setting `mode = "cpp"` or `-mcpp` should fix such issues. [#176][i176] + +- Enums were originally being mapped to `distint int` - this has been changed to `distinct cint` since the sizes are incorrect on 64-bit and is especially noticeable when types or unions have enum fields. + +- `static inline` functions are no longer wrapped by the legacy backend. The `ast2` backend correctly generates wrappers for such functions but they are only generated when `--noHeader | -H` is not in effect. This is because such functions do not exist in the binary and can only be referenced when the header is compiled in. + +- Support for Nim v0.19.6 has been dropped and the test matrix now covers v0.20.2, v1.0.6, v1.2.0 and devel. + +### New functionality + +- Nimterop can now skip generating the `{.header.}` pragma when the `--noHeader | -H` flag is used. This skips the header file `#include` in the generated code and allows creation of wrappers that do not require presence of the header during compile time. Note that `static inline` functions will only be wrapped when the header is compiled in. This change applies to both `ast2` and the legacy backend, although `ast2` can also generate wrappers with both `{.header.}` and `{.dynlib.}` in effect enabling type size checking with `-d:checkAbi`. More information is available in the [README.md](README.md). [#169][i169] + +- `ast2` includes support for various C constructs that were issues with the legacy backend. These changes should reduce the reliance on `cOverride()` and existing wrappers should attempt to clean up such sections where possible. + - N-dimensional arrays and pointers - [#54][i54] + - Synomyms for types - [#74][i74] + - Varargs support - [#76][i76] + - Nested structs, unions and enums - [#137][i137] [#147][i147] + - Forward declarations of types - [#148][i148] + - Nested function pointers - [#155][i155] [#156][i156] + - Various enum fixes - [#159][i159] [#171][i171] + - Map `int arr[]` to `arr: UncheckedArray[cint]` - [#174][i174] + - Global variables including arrays and procs (since v0.5.4) + +- `ast2` also includes an advanced expression parser that can reliably handle constructs typically seen with `#define` statements and enumeration values: + - Integers + integer like expressions (hex, octal, suffixes) + - Floating point expressions + - Strings and character literals, including C's escape characters + - Math operators `+ - / *` + - Some Unary operators `- ! ~` + - Any identifiers + - C type descriptors `int char` etc + - Boolean values `true false` + - Shift, cast, math or sizeof expressions + - Most type coercions + +- Wrappers can now point to an external plugin file with `cPluginPath()` instead of having to declaring plugins inline with `cPlugin()`. This allows multiple wrappers to share the same plugin. [#181][i181] + +- `cImport()` adds support for importing multiple headers in a single call - this enables support for libraries that have many header files that include shared headers and typically cannot be imported in multiple `cImport()` calls since it results in duplicate symbols. Calling `toast` with multiple headers uses the same algorithm. + +- `ast2` now creates Nim doc comments instead of reqular comments which get rendered when the wrapper is run through `nim doc` or the `buildDocs()` API. [#197][i197] + +- `toast` now includes `--replace | -G` to manipulate identifier names beyond `--prefix` and `--suffix`. `-G:X=Y` replaces X with Y and `-G:@_[_]+=_` replaces multiple `_` with a single instance using the `@` prefix to enable regular expressions. + +- `toast` also includes `--typeMap | -T` to map C types to another type. E.g. `--typeMap:GLint64=int64` generates a wrapper where all instances of `GLint64` are remapped to the Nim type `int64` and `GLint64` is not defined. (since v0.5.2) + +- CLI flags can now be specified one or more per line in a file and path provided to `toast`. They will be expanded in place. [#196][i196] (since v0.5.3) + +- Nimterop is now able to detect Nim configuration of projects and can better handle cases where defaults such as `nimcacheDir` or `nimblePath` are overridden. This especially enables better interop with workflows that do not depend on Nimble. [#151][i151] [#153][i153] + +- Nimterop defaults to `cmake`, followed by `autoconf` for building libraries with `getHeader()`. It is now possible to change the order of discovery with the `buildType` value. [#200][i200] + +[i54]: https://github.com/nimterop/nimterop/issues/54 +[i74]: https://github.com/nimterop/nimterop/issues/74 +[i76]: https://github.com/nimterop/nimterop/issues/76 +[i125]: https://github.com/nimterop/nimterop/issues/125 +[i127]: https://github.com/nimterop/nimterop/issues/127 +[i137]: https://github.com/nimterop/nimterop/issues/137 +[i147]: https://github.com/nimterop/nimterop/issues/147 +[i148]: https://github.com/nimterop/nimterop/issues/148 +[i151]: https://github.com/nimterop/nimterop/issues/151 +[i153]: https://github.com/nimterop/nimterop/issues/153 +[i154]: https://github.com/nimterop/nimterop/issues/154 +[i155]: https://github.com/nimterop/nimterop/issues/155 +[i156]: https://github.com/nimterop/nimterop/issues/156 +[i159]: https://github.com/nimterop/nimterop/issues/159 +[i169]: https://github.com/nimterop/nimterop/issues/169 +[i171]: https://github.com/nimterop/nimterop/issues/171 +[i174]: https://github.com/nimterop/nimterop/issues/174 +[i176]: https://github.com/nimterop/nimterop/issues/176 +[i181]: https://github.com/nimterop/nimterop/issues/181 +[i196]: https://github.com/nimterop/nimterop/issues/196 +[i197]: https://github.com/nimterop/nimterop/issues/197 +[i200]: https://github.com/nimterop/nimterop/issues/200 +[i236]: https://github.com/nimterop/nimterop/issues/236 +[i237]: https://github.com/nimterop/nimterop/issues/237 +[i239]: https://github.com/nimterop/nimterop/issues/239 \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..69dd3a7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Ganesh Viswanathan + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..96f3a46 --- /dev/null +++ b/README.md @@ -0,0 +1,280 @@ +[![Chat on Gitter](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/nimterop/Lobby) +[![Build status](https://ci.appveyor.com/api/projects/status/hol1yvqbp6hq4ao8/branch/master?svg=true)](https://ci.appveyor.com/project/genotrance/nimterop-8jcj7/branch/master) +[![Build Status](https://travis-ci.org/nimterop/nimterop.svg?branch=master)](https://travis-ci.org/nimterop/nimterop) + +Nimterop is a [Nim](https://nim-lang.org/) package that aims to make C/C++ interop seamless + +Most of the wrapping functionality is contained within the `toast` binary that is built when nimterop is installed and can be used standalone similar to how `c2nim` can be used today. In addition, nimterop also offers an API to pull in the generated Nim content directly into an application and other functionality that helps in automating the wrapping process. There is also support to statically or dynamically link to system installed libraries or downloading and building them with `autoconf` or `cmake` from a Git repo or source archive. + +The nimterop wrapping functionality is still limited to C but is constantly expanding. C++ support will be added once most popular C libraries can be wrapped seamlessly. Meanwhile, `c2nim` can also be used in place of `toast` with the `c2nImport()` API call. + +The goal is to make interop seamless so nimterop will focus on wrapping headers and not the outright conversion of C/C++ implementation. + +## Installation + +Nimterop can be installed via [Nimble](https://github.com/nim-lang/nimble): + +```bash +nimble install nimterop -y +``` +or: +```bash +git clone http://github.com/nimterop/nimterop && cd nimterop +nimble develop -y +nimble build -d:danger +``` + +This will download and install nimterop in the standard Nimble package location, typically `~/.nimble`. Once installed, it can be imported into any Nim program. + +## Usage + +Nimterop can be used in three ways: +- Creating a wrapper file - a `.nim` file that contains calls to the high-level API that can download and build the C library as well as generate the required Nim code to interface with the library. This wrapper file can then be imported into Nim code like any other module and it will be processed at compile time. +- Same as the first option except using the `nimFile` param to `cImport()` to write the generated wrapper to a file during build time just once and then importing that generated wrapper into the application like any other Nim module. +- Using the command line `toast` tool to generate the Nim code which can then be stored into a file and imported separately. + +Any combination of the above is possible - only download, build or wrapping and nimterop avoids imposing any particular workflow. + +Refer to [CHANGES.md](CHANGES.md) for history and information around breaking changes. + +### Build API + +Creating a wrapper has two parts, the first is to setup the C library. This includes downloading it or finding it if already installed, and building it if applicable. The `getHeader()` high-level API provides all of this functionality as a convenience. The following `.nim` wrapper file is an example of using the high-level `getHeader()` API to perform all building, wrapping and linking automatically: + +```nim +import nimterop/[build, cimport] + +static: + cDebug() # Print wrapper to stdout + +const + baseDir = getProjectCacheDir("testwrapper") # Download library within nimcache + +getHeader( + "header.h", # The header file to wrap, full path is returned in `headerPath` + giturl = "https://github.com/username/repo", # Git repo URL + dlurl = "https://website.org/download/repo-$1.tar.gz", # Download URL for archive or raw file + conanuri = "repo/$1", # Conan.io URI + jbburi = "repo/$1", # BinaryBuilder.org URI + outdir = baseDir, # Where to download/build/search + conFlags = "--disable-comp --enable-feature", # Flags to pass configure script + cmakeFlags = "-DENABLE_STATIC_LIB=ON" # Flags to pass to Cmake + altNames = "hdr" # Alterate names of the library binary, full path returned in `headerLPath` +) + +# Wrap headerPath as returned from getHeader() and link statically +# or dynamically depending on user input +when not isDefined(headerStatic): + cImport(headerPath, recurse = true, dynlib = "headerLPath") # Pass dynlib if not static link +else: + cImport(headerPath, recurse = true) +``` + +Module documentation for the build API can be found [here](https://nimterop.github.io/nimterop/build.html). Refer to the ```tests``` directory for additional examples on how the library can be used. Also, check out the [wiki](https://github.com/nimterop/nimterop/wiki/Wrappers) for a list of all known wrappers that have been created using nimterop. They will provide real world examples of how to wrap libraries. Please do add your project once you are done so that others can benefit from your work. + +#### Download / Search + +The above wrapper is generic and allows the end user to control how it works. Note that `headerPath` is derived from `header.h` so if you have `SDL.h` as the argument to `getHeader()`, it generates `SDLPath` and `SDLLPath` and is controlled by `-d:SDLStatic`, `-d:SDLGit` and so forth. + +- If the library is already installed in `/usr/include` then the `-d:headerStd` define to Nim can be used to instruct `getHeader()` to search for `header.h` in the standard system path. +- If the library needs to be downloaded, the user can use `-d:headerGit` to clone the source from the specified git URL, `-d:headerDL` to get the source from download URL, `-d:headerConan` to download from https://conan.io/center or `-d:headerJBB` to download from https://binarybuilder.org. + - The `-d:headerSetVer=X.Y.Z` flag can be used to specify which version to download. It is used as the tag name for Git and for DL, Conan and JBB, it replaces `$1` in the URL if specified. +- If no flag is provided, `getHeader()` simply looks for the library in `outdir`. The user could use Git submodules or manually download or check-in the library to that directory and `getHeader()` will use it directly. + +#### Pre build + +`getHeader()` provides a `headerPreBuild()` hook that gets called after the library is downloaded but before it is built. This allows for any manipulations of the source files or build scripts before build. [archive](https://github.com/genotrance/nimarchive/blob/master/nimarchive/archive.nim) has such an example. + +The build API also includes various compile time helper procs that aid in file manipulation, Cmake shortcuts, library linking, etc. Refer to [build](https://nimterop.github.io/nimterop/build.html) for more details. + +#### Build + +Nimterop currently supports `configure` and `cmake` based building of libraries, with `cmake` taking precedence if a project supports both. Nimterop verifies that the tool selected is available and notifies the user if any issues are found. Bash is required on Windows for `configure` and the binary shipped with Git has been tested. + +Flags can be specified to these tools via `getHeader()` or directly via the underlying `configure()` and `cmake()` calls. Once the build scripts are ready, `getHeader()` then calls `make()`. At every step, `getHeader()` checks for the presence of created artifacts and does not redo steps that have been successfully completed. + +#### Linking + +If `-d:headerStatic` is specified, `getHeader()` will return the static library path in `headerLPath`. The wrapper writer can check for this and call `cImport()` accordingly as in the example above. If `-d:headerStatic` is omitted, the dynamic library is returned in `headerLPath`. + +All dependency libraries (supported by Conan and JBB) will be returned in `headerLDeps`. Static libraries and dependencies are automatically linked using `cPassL()`. Conan shared libs typically include dependencies compiled in whereas JBB shared libs expect the required dependencies to be in the same location or in `LD_LIBRARY_PATH`. `conanFlags` and `jbbFlags` can be used to skip required dependencies from being downloaded in case another source is preferred. This can be done with `skip=pkg1,pkg2` to these flags. + +`getHeader()` searches for libraries based on the header name by default: +- `libheader.so` or `libheader.a` on Linux +- `libheader.dylib` on OSX +- `header.dll`, `header.a` or `header.lib` on Windows + +If a library has a different header and library binary name, `altNames` can be used to configure an alternate name of library binary. +- For example, Bzip2 has `bzlib.h` but the library is `libbz2.so` so `altNames = "bz2"`. +- In the example above, `altNames = "hdr"` so `getHeader()` will look for `libhdr.so`, `hdr.dll`, etc. +- See [bzlib.nim](https://github.com/genotrance/nimarchive/blob/master/nimarchive/bzlib.nim) for an example. + +[lzma.nim](https://github.com/nimterop/nimterop/blob/master/tests/lzma.nim) is an example of a library that allows both static and dynamic linking. + +#### User control + +The `-d:xxxYYY` Nim define flags have already been described above and can be specified on the command line or in a nim.cfg file. It is also possible to specify them within the wrapper itself using `setDefines()` if required. Further, all defines, regardless of how they are specified, can be generically checked using `isDefined()`. + +If more fine-tuned control is desired over the build process, it is possible to manually control all steps that `getHeader()` performs by directly using the API provided by [build](https://nimterop.github.io/nimterop/build.html). Note also that there is no requirement to use these APIs to setup the library. Any other established mechanisms can be used to do so any limitations imposed by Nimterop are unintentional and feedback is most welcome. + +### Wrapper API + +Once the C library is setup, the next step is to generate code that inform Nim of all the types and functions that are available. Following is a simple example covering the API: + +```nim +import nimterop/cimport + +static: + cDebug() + cDisableCaching() # Regenerate Nim wrapper every time + +cDefine("HAS_ABC") # Set #defines for preprocessor and compiler +cDefine("HAS_ABC", "DEF") + +cIncludeDir("clib/include") # Setup any include directories +cExclude("clib/file.h") # Exclude file from wrapped output + +cImport("clib.h") # Generate wrappers for header specified + +cCompile("clib/src/*.c") # Compile in any implementation source files +``` + +All `{.compileTime.}` procs must be used in a compile time context, like `cDebug()` and `cDisableCaching()` above. + +Module documentation for the wrapper API can be found [here](https://nimterop.github.io/nimterop/cimport.html). + +#### Preprocessing + +In order to leverage the preprocessor, certain projects might need `cDefine()` calls to set `#define` values. Simpler library may have documentation that cover this but larger ones will rely on build tools that discover and set values in a `config.h` which is loaded with `#include`. Projects might also require some `cIncludeDir()` calls to specify paths to directories that contain other headers. This might be within the library or refer to another library. + +The wrapper API always runs headers through the C preprocessor before wrapping. Details on why are discussed further down. + +By default, the `$CC` environment variable is used for the compiler path. If not found, `toast` defaults to `gcc`. + +#### Wrapping + +The `cImport()` call invokes the `toast` binary with appropriate command line flags including any `cDefine()` and `cInclude()` parameters configured. The output of `toast` is then pulled into the module as Nim code and printed if `cDebug()` is specified. This allows for an end user to simply import the wrapper into their code and access the library API as Nim types and procs. Output is cached to save time on subsequent runs. It is also possible to just redirect the output to a file and import that instead if preferred. + +The `recurse` flag can be set to enable the recursion capability which runs through all #include files in the header. If the library needs to be dyamically linked using Nim's `dynlib` pragma, the `dynlib = "constName"` attribute can be set to generate wrappers that load the DLL automatically. Without `dynlib`, static link is assumed so it is the user's responsibility to link the library. + +There may be cases where the wrapper generated by `toast` for certain types or procs is not preferred, or may be skipped or altogether wrong due to limitations or bugs. In these instances, the `cOverride()` macro can be used to define consts, types or procs to use in place of the wrapper generated output. `cImport()` will forward this information to `toast` and the values will be inserted in context in the generated wrapper. This allows wrapper authors to work around tool limitations or to improve the wrapper output - say change `ptr X` to `var X` or to create more Nim friendly types or proc signatures. + +Several C libraries also use leading and/or trailing `_` in identifiers and since Nim does not allow this, the `cPlugin()` macro can be used to modify such symbols or `cSkipSymbol()` them altogether. Instead of a full `cPlugin()` section, it might also be preferred to set `flags = "-E_ -F_"` to the `cImport()` call to trim out such characters. These features can also be used to remove common prefixes like `SDL_` to generate a cleaner wrapper. The `--replace | -G` flag can be used for replacements. `cPlugin()` is real Nim code though so anything Nim allows is fair game. Note that `cPlugin()` overrides any `-E -F -G` flags. Also, behind the scenes, `cOverride()` is communicated to `toast` via `cPlugin()`. + +If the same `cPlugin()` is needed in multiple wrapper files, the code can be moved into a standalone file and be used with the `cPluginPath()` call. + +Lastly, `c2nImport()` provides access to calling `c2nim` from the wrapper instead of `toast`. Note that `c2nImport()` does not use any of the above described features like `cPlugin()` and needs to be controlled with `c2nim` specific flags via the `flags` param. + +#### Header vs. Dynlib + +Nim provides some flexibility when it comes to using C/C++ libraries. In order to understand this better, some Nim pragmas need to be introduced. The main one is `{.importc.}` which informs Nim to use a symbol defined in a C library. This applies to both types and procs but how Nim should find the symbol is slightly different for each. + +For types, `{.header: "header.h".}` informs Nim that `header.h` has the symbol and to `#include "header.h"` in the generated code. However, types can be mostly recreated in pure Nim so it is also possible to omit both `{.importc.}` and `{.header}` and it will work just fine except with a different name in the generated C code. This allows the user to compile the wrapper without requiring `header.h` to be present. + +For functions, `{.header.}` works the same as types and can be omitted if preferred. The `{.importc.}` pragma is still required, unlike types since functions need to be linked to the implementation in the library. The user will need to provide this information at link time with `cPassL()` and linking to a library with `-lheader` or `path/to/libheader.a`. It is also possible to just use `cCompile()` or `{.compile.}` to compile some C source files which contain the implementation. + +While `{.header.}` can be omitted for convenience, it does prevent wrapping of `static inline` functions as well as type checking of the wrapper ABI with `-d:checkAbi` at compile time. Further, anonymous nested structs/unions within unions will be rendered incorrectly by Nim since it is unaware of the true memory structure of the type. The user will need to choose based on the library in question. + +Going further, the `{.dynlib: "path/to/libheader.so".}` pragma can be used to inform Nim to load the library at runtime and link the function instead of linking at compile time. This enables creation of a wrapper that does not need the library present at compile time. + +Now that this is understood, a user might want any combination of the above in the wrapper rendered by Nimterop. This can be controlled with various flags to `cImport()` and `toast`. +- By default, generated wrappers will include the `{.header, importc.}` pragmas for types and procs. This can be disabled with the `--noHeader | -H` flag to `toast` or `flags = "-H"` param to `cImport()` which will remove `{.header}` for both and `{.importc.}` for types only. +- By default, generated wrappers will assume that the user will link the library implementation themselves. The `--dynlib | -l` flag to `toast` or `dynlib = "headerLPath"` param to `cImport()` will configure the wrapper to generate `{.dynlib.}` pragmas for procs. + +This results in four supported cases: +1. Default: `{.header, importc.}` for both types and procs +2. With `--noHeader`, types will be pure Nim and procs will be just `{.importc.}` +3. With `--dynlib`, types will still be `{.header, importc.}` but procs will be `{.dynlib, importc.}` +4. With `--dynlib` and `--noHeader`, types will be pure Nim, procs will be `{.dynlib, importc.}` + +Creation of a standalone wrapper (case 4) which does not require the header or library at compile time will require an explicit `--noHeader` and `--dynlib`. + +More documentation on on these pragmas can be found in the Nim manual: +- [{.importc.}](https://nim-lang.org/docs/manual.html#foreign-function-interface-importc-pragma) +- [{.header.}](https://nim-lang.org/docs/manual.html#implementation-specific-pragmas-header-pragma) +- [{.dynlib.}](https://nim-lang.org/docs/manual.html#foreign-function-interface-dynlib-pragma-for-import) +- [{.passL.}](https://nim-lang.org/docs/manual.html#implementation-specific-pragmas-passl-pragma) +- [{.compile.}](https://nim-lang.org/docs/manual.html#implementation-specific-pragmas-compile-pragma) + +#### Compiling the source + +The job of building and compiling the underlying C library is best left to the build mechanism selected by the library author so using `getHeader()` is recommended. For simpler projects with a few `.c` files though, `cCompile()` should be more than enough. It is not recommended for larger projects which heavily rely on functionality offered by build tools. Recreating reliable logic in Nim can be tedious and one can expect minimal support from that author if their tested build mechanism is not used. + +### Docs API + +Nimterop also provides a [docs](https://nimterop.github.io/nimterop/docs.html) API which can be used to generate documentation from the generated wrappers. This can be added as a task in the `.nimble` or `.nims` file for convenience. See [nimarchive.nimble](https://github.com/genotrance/nimarchive/blob/master/nimarchive.nimble) for an example. + +### Command line API + +The `toast` binary can also be used directly on the CLI, similar to `c2nim`. These flags can be specified on the command line or via a file, one or more flags per line, and the path provided to `toast` instead, or a combination. The file contents will be expanded in place. + +Note: unlike the wrapper API, the `-p | --preprocess` flag is not enabled by default but is *highly* recommended. + +``` +> toast -h +Usage: + main [optional-params] C/C++ source/header(s) and command line file(s) +Options: + -h, --help print this cligen-erated help + --help-syntax advanced: prepend,plurals,.. + -k, --check bool false check generated wrapper with compiler + --compile= strings {} create {.compile.} entries in generated wrapper + -C=, --convention= string "cdecl" calling convention for wrapped procs + -d, --debug bool false enable debug output + -D=, --defines= strings {} definitions to pass to preprocessor + -l=, --dynlib= string "" {.dynlib.} pragma to import symbols - Nim const string or + file path + -X=, --exclude= strings {} files or directories to exclude from the wrapped output + -f=, --feature= Features {} flags to enable experimental features + -I=, --includeDirs= strings {} include directory to pass to preprocessor + -m=, --mode= string "" language parser: c or cpp + --nim= string "nim" use a particular Nim executable + -c, --noComments bool false exclude top-level comments from output + -H, --noHeader bool false skip {.header.} pragma in wrapper + -o=, --output= string "" file to output content - default: stdout + --passC= strings {} create {.passC.} entries in generated wrapper + --passL= strings {} create {.passL.} entries in generated wrapper + -a, --past bool false print AST output + --pluginSourcePath= string "" nim file to build and load as a plugin + -n, --pnim bool false print Nim output + -E=, --prefix= strings {} strip prefix from identifiers + -p, --preprocess bool false run preprocessor on header + -r, --recurse bool false process #include files - implies --preprocess + -G=, --replace= strings {} replace X with Y in identifiers, X1=Y1,X2=Y2, @X for regex + -s, --stub bool false stub out undefined type references as objects + -F=, --suffix= strings {} strip suffix from identifiers + -O=, --symOverride= strings {} skip generating specified symbols + -T=, --typeMap= strings {} map instances of type X to Y - e.g. ABC=cint +``` + +## Why nimterop + +Nim has one of the best FFI you can find - importing C/C++ is supported out of the box. All you need to provide is type and proc definitions for Nim to interop with C/C++ binaries. Generation of these wrappers is easy for simple libraries but can quickly get out of hand. [c2nim](https://github.com/nim-lang/c2nim) greatly helps here by parsing and converting C/C++ into Nim but is limited due to the complex and constantly evolving C/C++ grammar. [nimgen](https://github.com/genotrance/nimgen) mainly focused on automating the wrapping process with `c2nim` and filled some holes but is again limited to `c2nim` capabilities. + +The goal of nimterop is to leverage the [tree-sitter](http://tree-sitter.github.io/tree-sitter/) engine to parse C/C++ code and then convert relevant portions of the AST into Nim definitions. [tree-sitter](https://github.com/tree-sitter) is a Github sponsored project that can parse a variety of languages into an AST which is then leveraged by the [Atom](https://atom.io/) editor for syntax highlighting and code folding. The advantages of this approach are multifold: +- Benefit from the tree-sitter community's ongoing investment into language parsing +- Wrap what is recognized in the AST rather than completely failing due to parsing errors + +The tree-sitter library is limited though - it may fail on some advanced language constructs but is designed to handle them gracefully since it is expected to have bad code while actively typing in an editor. When an error is detected, tree-sitter includes an ERROR node at that location in the AST. At this time, `cImport()` will complain and continue if it encounters any errors. Depending on how severe the errors are, compilation may succeed or fail. Glaring issues will be communicated to the tree-sitter team but their goals may not always align with those of this project. + +It is debatable whether a syntax highlighting engine like `tree-sitter` is the most reliable method to convert C code into AST. However, it is lightweight, cross-platform with no dependencies and handles error conditions gracefully. It has produced usable wrappers for C libraries though things could get murky when considering C++ but that will be a topic for another day. Nimterop relies heavily on the preprocessor, as discussed next, so having an engine which can run anywhere has been worth the compromise. Only time will tell though. + +### Preprocessing + +The wrapper API always runs headers through the C preprocessor before wrapping, unlike the command line interface where the `-p | --preprocess` flag is not set by default but *highly* recommended. This is because almost all platform, compiler and package discovery is handled by build tools like `configure` and `cmake` which then use preprocessor `#define` values to tweak what C code is applicable for that platform. While parsing preprocessor macros is possible in tools like `toast`, given how dependent the `#ifdef` branches are on values provided by these and many other build tools, preprocessing seems is best left to them than attempting to self-discover or intercept that information. + +Nimterop is still able to wrap most relevant `#define` like numbers and strings thanks to `gcc -E` providing the sufficient detail in its output. Many C libraries also use `#define` templates for some of their user facing API and providing that functionality in Nim is on the Nimterop roadmap. + +The con of this approach of delegating to the preprocessor is that the Nim wrapper generated by Nimterop is no longer portable despite being Nim code. A wrapper rendered on Linux might not work on Windows since some APIs may not be available or inappropriate, integer sizes might be wrong, types could be missing and many other possible issues. But none of this is easily or accurately known at the Nim level since it would require input from the build tools which already work well with the preprocessor or have to be completely reimplemented within Nim. Neither approach that bypasses such build tools would be supported by the library author. + +This is part of the reason why Nimterop provides a wrapper API so that the generation of wrappers is Nim code that can be rendered as part of the build process on the target platform. It helps to think of Nimterop as a build time tool like `cmake` that renders artifacts on the target rather than a tool whose generated artifacts should be checked into source control. Regardless, both the wrapper API and the `toast` command line still allow saving the wrapper output to a file to be stored in source control since it might work well enough for many projects. + +## Credits + +Nimterop depends on [tree-sitter](http://tree-sitter.github.io/tree-sitter/) and all licensing terms of [tree-sitter](https://github.com/tree-sitter/tree-sitter/blob/master/LICENSE) apply to the usage of this package. The tree-sitter functionality is pulled and wrapped using nimterop itself. + +Thank you to all the [contributors](https://github.com/nimterop/nimterop/graphs/contributors), issue submitters, various people in [#nim](irc://freenode.net/nim) and users for helping improve Nimterop over the years. + +## Feedback + +Nimterop is a work in progress and any feedback or suggestions are welcome. It is hosted on [GitHub](https://github.com/nimterop/nimterop) with an MIT license so issues, forks and PRs are most appreciated. diff --git a/all.html b/all.html deleted file mode 100644 index 436ccbf..0000000 --- a/all.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - - - - - - - - - - - - -all - - - - - - - - -
-
-

all

-
-
-
- -     Dark Mode -
- -
- Search: -
-
- Group by: - -
- - -
-
-
- -

Module that should import everything so that nim doc --project nimtero/all runs docs on everything.

- - -
-
- -
-
- -
- Made with Nim. Generated: 2020-03-24 20:55:42 UTC -
-
-
-
- - - diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..d807b19 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,93 @@ +version: '{build}' + +image: + - Visual Studio 2015 + - Ubuntu + +matrix: + fast_finish: true + +environment: + matrix: + - NIM_VERSION: 0.20.2 + - NIM_VERSION: 1.0.8 + - NIM_VERSION: 1.2.4 + +for: +- + matrix: + only: + - image: Visual Studio 2015 + + environment: + ARCH: 64 + GIT_URL: https://github.com/git-for-windows/git/releases/download/v2.23.0.windows.1/ + GIT_ARCHIVE: PortableGit-2.23.0-64-bit.7z.exe + + install: + - CD c:\ + - IF not exist "binaries" ( + echo %NIM_VERSION% && + MKDIR binaries && + CD binaries && + MKDIR git && + CD git && + appveyor DownloadFile "%GIT_URL%/%GIT_ARCHIVE%" -FileName "%GIT_ARCHIVE%" && + 7z x -y -bd "%GIT_ARCHIVE%"> nul && + del "%GIT_ARCHIVE%" && + CD .. && + appveyor DownloadFile "https://nim-lang.org/download/nim-%NIM_VERSION%_x%ARCH%.zip" -FileName "nim-%NIM_VERSION%_x%ARCH%.zip" && + 7z x -y "nim-%NIM_VERSION%_x%ARCH%.zip"> nul && + del "nim-%NIM_VERSION%_x%ARCH%.zip") + - SET PATH=c:\binaries\git\bin;C:\mingw-w64\x86_64-8.1.0-posix-seh-rt_v6-rev0\mingw64\bin;c:\binaries\nim-%NIM_VERSION%\bin;%USERPROFILE%\.nimble\bin;%PATH% + - CD %APPVEYOR_BUILD_FOLDER% + +# on_finish: +# - 7z a -r buildlogs-win-pkgs.zip %USERPROFILE%\.nimble\pkgs +# - appveyor PushArtifact buildlogs-win-pkgs.zip +# - 7z a -r buildlogs-win-projects.zip c:\projects\* +# - appveyor PushArtifact buildlogs-win-projects.zip + + cache: + - c:\binaries + +- + matrix: + only: + - image: Ubuntu + + install: + - sudo apt-get update + - sudo apt-get --yes --force-yes install liblzma-dev liblzma5 autopoint + - if [ ! -e /home/appveyor/binaries ]; then + echo $NIM_VERSION && + mkdir /home/appveyor/binaries && + cd /home/appveyor/binaries && + curl -s -o nim-$NIM_VERSION.tar.xz https://nim-lang.org/download/nim-$NIM_VERSION.tar.xz && + tar xJf nim-$NIM_VERSION.tar.xz && + cd nim-$NIM_VERSION && + sh build.sh && + bin/nim c -d:release koch && + ./koch boot -d:release && + ./koch nimble -d:release; + fi + - export PATH=/home/appveyor/binaries/nim-$NIM_VERSION/bin:~/.nimble/bin:$PATH + - cd $APPVEYOR_BUILD_FOLDER + +# on_finish: +# - zip -r -q buildlogs-lin-pkgs.zip ~/.nimble/pkgs +# - appveyor PushArtifact buildlogs-lin-pkgs.zip +# - zip -r -q buildlogs-lin-projects.zip /home/appveyor/projects +# - appveyor PushArtifact buildlogs-lin-projects.zip + + cache: + - /home/appveyor/binaries + +build_script: + - nimble --verbose develop -y + +test_script: + - nimble --verbose test + - nimble --verbose --nimbleDir:test install nimterop -y + +deploy: off diff --git a/build.html b/build.html deleted file mode 100644 index 47844fe..0000000 --- a/build.html +++ /dev/null @@ -1,589 +0,0 @@ - - - - - - - - - - - - - - - - - - -build - - - - - - - - -
-
-

build

-
-
-
- -     Dark Mode -
- -
- Search: -
-
- Group by: - -
- - -
-
-
- -

-
-

Procs

-
- -
proc sanitizePath(path: string; noQuote = false; sep = $'/'): string {...}{.raises: [], tags: [].}
-
- - - -
- -
proc sleep(milsecs: int) {...}{.raises: [], tags: [].}
-
- -Sleep at compile time - -
- -
proc getCurrentNimCompiler(): string {...}{.raises: [], tags: [].}
-
- - - -
- -
proc execAction(cmd: string; retry = 0; die = true; cache = false; cacheKey = ""): tuple[
-    output: string, ret: int] {...}{.raises: [IOError, ValueError, OSError, Exception, Defect], tags: [
-    ReadEnvEffect, ReadIOEffect, ReadDirEffect, WriteIOEffect, ExecIOEffect,
-    RootEffect].}
-
- -

Execute an external command - supported at compile time

-

Checks if command exits successfully before returning. If not, an error is raised. Always caches results to be used in nimsuggest or nimcheck mode.

-

retry - number of times command should be retried before error die = false - return on errors cache = true - cache results unless cleared with -f cacheKey - key to create unique cache entry

- - -
- -
proc findExe(exe: string): string {...}{.raises: [IOError, ValueError, OSError, Exception,
-                                        Defect], tags: [ReadEnvEffect,
-    ReadIOEffect, ReadDirEffect, WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -Find the specified executable using the which/where command - supported at compile time - -
- -
proc mkDir(dir: string) {...}{.raises: [IOError, ValueError, OSError, Exception, Defect], tags: [
-    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, ExecIOEffect,
-    RootEffect].}
-
- -

Create a directory at compile time

-

The os module is not available at compile time so a few crucial helper functions are included with nimterop.

- - -
- -
proc cpFile(source, dest: string; move = false) {...}{.
-    raises: [IOError, ValueError, OSError, Exception, Defect], tags: [ReadEnvEffect,
-    ReadIOEffect, ReadDirEffect, WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -Copy a file from source to dest at compile time - -
- -
proc mvFile(source, dest: string) {...}{.raises: [IOError, ValueError, OSError, Exception,
-                                        Defect], tags: [ReadEnvEffect,
-    ReadIOEffect, ReadDirEffect, WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -Move a file from source to dest at compile time - -
- -
proc rmFile(source: string; dir = false) {...}{.raises: [IOError, ValueError, OSError,
-    Exception, Defect], tags: [ReadDirEffect, ReadEnvEffect, ReadIOEffect,
-                            WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -Remove a file or pattern at compile time - -
- -
proc rmDir(dir: string) {...}{.raises: [IOError, ValueError, OSError, Exception, Defect], tags: [
-    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect, ExecIOEffect,
-    RootEffect].}
-
- -Remove a directory or pattern at compile time - -
- -
proc getProjectCacheDir(name: string; forceClean = true): string {...}{.
-    raises: [IOError, ValueError, OSError, Exception, Defect], tags: [ReadEnvEffect,
-    ReadIOEffect, ReadDirEffect, WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -

Get a cache directory where all nimterop artifacts can be stored

-

Projects can use this location to download source code and build binaries that can be then accessed by multiple apps. This is created under the per-user Nim cache directory.

-

Use name to specify the subdirectory name for a project.

-

forceClean is enabled by default and effectively deletes the folder if Nim is compiled with the -f or --forceBuild flag. This allows any project to start out with a clean cache dir on a forced build.

-

NOTE: avoid calling getProjectCacheDir() multiple times on the same name when forceClean = true else checked out source might get deleted at the wrong time during build.

-
E.g.
-

nimgit2 downloads libgit2 source so name = "libgit2"

-

nimarchive downloads libarchive, bzlib, liblzma and zlib so name = "nimarchive" / "libarchive" for libarchive, etc.

-
-
- - -
- -
proc extractZip(zipfile, outdir: string) {...}{.raises: [IOError, ValueError, OSError,
-    Exception, Defect], tags: [ReadEnvEffect, ReadIOEffect, ReadDirEffect,
-                            WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -Extract a zip file using powershell on Windows and unzip on other systems to the specified output directory - -
- -
proc extractTar(tarfile, outdir: string) {...}{.raises: [IOError, ValueError, OSError,
-    Exception, Defect], tags: [ReadEnvEffect, ReadIOEffect, ReadDirEffect,
-                            WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -Extract a tar file using tar, 7z or 7za to the specified output directory - -
- -
proc downloadUrl(url, outdir: string) {...}{.raises: [IOError, ValueError, OSError,
-    Exception, Defect], tags: [ReadDirEffect, ReadEnvEffect, ReadIOEffect,
-                            WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -

Download a file using curl or wget (or powershell on Windows) to the specified directory

-

If an archive file, it is automatically extracted after download.

- - -
- -
proc gitReset(outdir: string) {...}{.raises: [ValueError, IOError, OSError, Exception, Defect], tags: [
-    ReadEnvEffect, ReadIOEffect, ReadDirEffect, WriteIOEffect, ExecIOEffect,
-    RootEffect].}
-
- -Hard reset the git repository at the specified directory - -
- -
proc gitCheckout(file, outdir: string) {...}{.raises: [ValueError, IOError, OSError,
-    Exception, Defect], tags: [RootEffect, ReadEnvEffect, ReadIOEffect, ReadDirEffect,
-                            WriteIOEffect, ExecIOEffect].}
-
- -

Checkout the specified file in the git repository at outdir

-

This effectively resets all changes in the file and can be used to undo any changes that were made to source files to enable successful wrapping with cImport() or c2nImport().

- - -
- -
proc gitPull(url: string; outdir = ""; plist = ""; checkout = "") {...}{.
-    raises: [ValueError, IOError, OSError, Exception, Defect], tags: [ReadDirEffect,
-    ReadEnvEffect, ReadIOEffect, WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -

Pull the specified git repository to the output directory

-

plist is the list of specific files and directories or wildcards to sparsely checkout. Multiple values can be specified one entry per line. It is optional and if omitted, the entire repository will be checked out.

-

checkout is the git tag, branch or commit hash to checkout once the repository is downloaded. This allows for pinning to a specific version of the code.

- - -
- -
proc findFile(file: string; dir: string; recurse = true; first = false; regex = false): string {...}{.
-    raises: [ValueError, IOError, OSError, Exception, Defect], tags: [ReadEnvEffect,
-    ReadIOEffect, ReadDirEffect, WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -

Find the file in the specified directory

-

file is a regular expression if regex is true

-

Turn off recursive search with recurse and stop on first match with first. Without it, the shortest match is returned.

- - -
- -
proc flagBuild(base: string; flags: openArray[string]): string {...}{.raises: [ValueError],
-    tags: [].}
-
- -

Simple helper proc to generate flags for configure, cmake, etc.

-

Every entry in flags is replaced into the base string and concatenated to the result.

-
E.g.
-
base = "--disable-$#" flags = @["one", "two"]
-
-

flagBuild(base, flags) => " --disable-one --disable-two"

- - -
- -
proc linkLibs(names: openArray[string]; staticLink = true): string {...}{.
-    raises: [ValueError, IOError, OSError, Exception, Defect], tags: [ReadEnvEffect,
-    ReadIOEffect, ReadDirEffect, WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -

Create linker flags for specified libraries

-

Prepends lib to the name so you only need ssl for libssl.

- - -
- -
proc configure(path, check: string; flags = "") {...}{.
-    raises: [IOError, ValueError, OSError, Exception, Defect], tags: [ReadDirEffect,
-    ReadEnvEffect, ReadIOEffect, WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -

Run the GNU configure command to generate all Makefiles or other build scripts in the specified path

-

If a configure script is not present and an autogen.sh script is present, it will be run before attempting configure.

-

Next, if configure.ac or configure.in exist, autoreconf will be executed.

-

check is a file that will be generated by the configure command. This is required to prevent configure from running on every build. It is relative to the path and should not be an absolute path.

-

flags are any flags that should be passed to the configure command.

- - -
- -
proc getCmakeIncludePath(paths: openArray[string]): string {...}{.raises: [], tags: [].}
-
- -

Create a cmake flag to specify custom include paths

-

Result can be included in the flag parameter for cmake() or the cmakeFlags parameter for getHeader().

- - -
- -
proc setCmakeProperty(outdir, name, property, value: string) {...}{.
-    raises: [IOError, ValueError],
-    tags: [ReadDirEffect, WriteIOEffect, ReadIOEffect].}
-
- -

Set a cmake property in outdir / CMakeLists.txt - usable in the xxxPreBuild hook for getHeader()

-

set_target_properties(name PROPERTIES property "value")

- - -
- -
proc setCmakeLibName(outdir, name, prefix = ""; oname = ""; suffix = "") {...}{.
-    raises: [ValueError, IOError],
-    tags: [ReadDirEffect, WriteIOEffect, ReadIOEffect].}
-
- -

Set a cmake property in outdir / CMakeLists.txt to specify a custom library output name - usable in the xxxPreBuild hook for getHeader()

-

prefix is typically lib oname is the library name suffix is typically .a

-

Sometimes, cmake generates non-standard library names - e.g. zlib compiles to libzlibstatic.a on Windows. This proc can help rename it to libzlib.a so that getHeader() can find it after the library is compiled.

-

-set_target_properties(name PROPERTIES PREFIX "prefix")
-set_target_properties(name PROPERTIES OUTPUT_NAME "oname")
-set_target_properties(name PROPERTIES SUFFIX "suffix")
-

- - -
- -
proc setCmakePositionIndependentCode(outdir: string) {...}{.raises: [IOError],
-    tags: [ReadDirEffect, ReadIOEffect, WriteIOEffect].}
-
- -Set a cmake directive to create libraries with -fPIC enabled - -
- -
proc cmake(path, check, flags: string) {...}{.raises: [IOError, ValueError, OSError,
-    Exception, Defect], tags: [ReadDirEffect, ReadEnvEffect, ReadIOEffect,
-                            WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -

Run the cmake command to generate all Makefiles or other build scripts in the specified path

-

path will be created since typically cmake is run in an empty directory.

-

check is a file that will be generated by the cmake command. This is required to prevent cmake from running on every build. It is relative to the path and should not be an absolute path.

-

flags are any flags that should be passed to the cmake command. Unlike configure, it is required since typically it will be the path to the repository, typically .. when path is a subdir.

- - -
- -
proc make(path, check: string; flags = ""; regex = false) {...}{.
-    raises: [ValueError, IOError, OSError, Exception, Defect], tags: [ReadEnvEffect,
-    ReadIOEffect, ReadDirEffect, WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -

Run the make command to build all binaries in the specified path

-

check is a file that will be generated by the make command. This is required to prevent make from running on every build. It is relative to the path and should not be an absolute path.

-

flags are any flags that should be passed to the make command.

-

regex can be set to true if check is a regular expression.

-

If make.exe is missing and mingw32-make.exe is available, it will be copied over to make.exe in the same location.

- - -
- -
proc getCompiler(): string {...}{.raises: [], tags: [ReadEnvEffect].}
-
- - - -
- -
proc getGccPaths(mode = "c"): seq[string] {...}{.raises: [IOError, ValueError, OSError,
-    Exception, Defect], tags: [ReadEnvEffect, ReadIOEffect, ReadDirEffect,
-                            WriteIOEffect, ExecIOEffect, RootEffect].}
-
- - - -
- -
proc getGccLibPaths(mode = "c"): seq[string] {...}{.
-    raises: [IOError, ValueError, OSError, Exception, Defect], tags: [ReadEnvEffect,
-    ReadIOEffect, ReadDirEffect, WriteIOEffect, ExecIOEffect, RootEffect].}
-
- - - -
- -
-
-

Macros

-
- -
macro setDefines(defs: static openArray[string]): untyped
-
- -

Specify -d:xxx values in code instead of having to rely on the command line or cfg or nims files.

-

At this time, Nim does not allow creation of -d:xxx defines in code. In addition, Nim only loads config files for the module being compiled but not for imported packages. This becomes a challenge when wanting to ship a wrapper library that wants to control getHeader() for an underlying package.

-

E.g. nimarchive wanting to set -d:lzmaStatic

-

The consumer of nimarchive would need to set such defines as part of their project, making it inconvenient.

-

By calling this proc with the defines preferred before importing such a module, the caller can set the behavior in code instead.

-
setDefines(@["lzmaStatic", "lzmaDL", "lzmaSetVer=5.2.4"])
-
-import lzma
- -
- -
macro clearDefines(): untyped
-
- -Clear all defines set using setDefines(). - -
- -
macro isDefined(def: untyped): untyped
-
- -Check if -d:xxx is set globally or via setDefines() - -
- -
macro getHeader(header: static[string]; giturl: static[string] = "";
-               dlurl: static[string] = ""; outdir: static[string] = "";
-               conFlags: static[string] = ""; cmakeFlags: static[string] = "";
-               makeFlags: static[string] = ""; altNames: static[string] = ""): untyped
-
- -

Get the path to a header file for wrapping with cImport() or c2nImport().

-

This proc checks -d:xxx defines based on the header name (e.g. lzma from lzma.h), and accordingly employs different ways to obtain the source.

-

-d:xxxStd - search standard system paths. E.g. /usr/include and /usr/lib on Linux -d:xxxGit - clone source from a git repo specified in giturl -d:xxxDL - download source from dlurl and extract if required

-

This allows a single wrapper to be used in different ways depending on the user's needs. If no -d:xxx defines are specified, outdir will be searched for the header as is.

-

If multiple -d:xxx defines are specified, precedence is Std and then Git or DL. This allows using a system installed library if available before falling back to manual building.

-

-d:xxxSetVer=x.y.z can be used to specify which version to use. It is used as a tag name for Git whereas for DL, it replaces $1 in the URL defined.

-

All defines can also be set in code using setDefines().

-

The library is then configured (with cmake or autotools if possible) and built using make, unless using -d:xxxStd which presumes that the system package manager was used to install prebuilt headers and binaries.

-

The header path is stored in const xxxPath and can be used in a cImport() call in the calling wrapper. The dynamic library path is stored in const xxxLPath and can be used for the dynlib parameter (within quotes) or with {.passL.}.

-

-d:xxxStatic can be specified to statically link with the library instead. This will automatically add a {.passL.} call to the static library for convenience.

-

conFlags, cmakeFlags and makeFlags allow sending custom parameters to configure, cmake and make in case additional configuration is required as part of the build process.

-

altNames is a list of alternate names for the library - e.g. zlib uses zlib.h for the header but the typical lib name is libz.so and not libzlib.so. However, it is libzlib.dll on Windows if built with cmake. In this case, altNames = "z,zlib". Comma separate for multiple alternate names without spaces.

-

The original header name is not included by default if altNames is set since it could cause the wrong lib to be selected. E.g. SDL2/SDL.h could pick libSDL.so even if altNames = "SDL2". Explicitly include it in altNames like the zlib example when required.

-

xxxPreBuild is a hook that is called after the source code is pulled from Git or downloaded but before the library is built. This might be needed if some initial prep needs to be done before compilation. A few values are provided to the hook to help provide context:

-

outdir is the same outdir passed in and header is the discovered header path in the downloaded source code.

-

Simply define proc xxxPreBuild(outdir, header: string) in the wrapper and it will get called prior to the build process.

- - -
- -
- -
-
- -
-
- -
- Made with Nim. Generated: 2020-03-24 20:55:39 UTC -
-
-
-
- - - diff --git a/build.idx b/build.idx deleted file mode 100644 index dbed146..0000000 --- a/build.idx +++ /dev/null @@ -1,34 +0,0 @@ -sanitizePath build.html#sanitizePath,string build: sanitizePath(path: string; noQuote = false; sep = $'/'): string -sleep build.html#sleep,int build: sleep(milsecs: int) -getCurrentNimCompiler build.html#getCurrentNimCompiler build: getCurrentNimCompiler(): string -execAction build.html#execAction,string,int,string build: execAction(cmd: string; retry = 0; die = true; cache = false; cacheKey = ""): tuple[\n output: string, ret: int] -findExe build.html#findExe,string build: findExe(exe: string): string -mkDir build.html#mkDir,string build: mkDir(dir: string) -cpFile build.html#cpFile,string,string build: cpFile(source, dest: string; move = false) -mvFile build.html#mvFile,string,string build: mvFile(source, dest: string) -rmFile build.html#rmFile,string build: rmFile(source: string; dir = false) -rmDir build.html#rmDir,string build: rmDir(dir: string) -getProjectCacheDir build.html#getProjectCacheDir,string build: getProjectCacheDir(name: string; forceClean = true): string -extractZip build.html#extractZip,string,string build: extractZip(zipfile, outdir: string) -extractTar build.html#extractTar,string,string build: extractTar(tarfile, outdir: string) -downloadUrl build.html#downloadUrl,string,string build: downloadUrl(url, outdir: string) -gitReset build.html#gitReset,string build: gitReset(outdir: string) -gitCheckout build.html#gitCheckout,string,string build: gitCheckout(file, outdir: string) -gitPull build.html#gitPull,string,string,string,string build: gitPull(url: string; outdir = ""; plist = ""; checkout = "") -findFile build.html#findFile,string,string build: findFile(file: string; dir: string; recurse = true; first = false; regex = false): string -flagBuild build.html#flagBuild,string,openArray[string] build: flagBuild(base: string; flags: openArray[string]): string -linkLibs build.html#linkLibs,openArray[string] build: linkLibs(names: openArray[string]; staticLink = true): string -configure build.html#configure,string,string,string build: configure(path, check: string; flags = "") -getCmakeIncludePath build.html#getCmakeIncludePath,openArray[string] build: getCmakeIncludePath(paths: openArray[string]): string -setCmakeProperty build.html#setCmakeProperty,string,string,string,string build: setCmakeProperty(outdir, name, property, value: string) -setCmakeLibName build.html#setCmakeLibName,string,string,string,string,string build: setCmakeLibName(outdir, name, prefix = ""; oname = ""; suffix = "") -setCmakePositionIndependentCode build.html#setCmakePositionIndependentCode,string build: setCmakePositionIndependentCode(outdir: string) -cmake build.html#cmake,string,string,string build: cmake(path, check, flags: string) -make build.html#make,string,string,string build: make(path, check: string; flags = ""; regex = false) -getCompiler build.html#getCompiler build: getCompiler(): string -getGccPaths build.html#getGccPaths,string build: getGccPaths(mode = "c"): seq[string] -getGccLibPaths build.html#getGccLibPaths,string build: getGccLibPaths(mode = "c"): seq[string] -setDefines build.html#setDefines.m build: setDefines(defs: static openArray[string]): untyped -clearDefines build.html#clearDefines.m build: clearDefines(): untyped -isDefined build.html#isDefined.m,untyped build: isDefined(def: untyped): untyped -getHeader build.html#getHeader.m,static[string],static[string],static[string],static[string],static[string],static[string],static[string],static[string] build: getHeader(header: static[string]; giturl: static[string] = "";\n dlurl: static[string] = ""; outdir: static[string] = "";\n conFlags: static[string] = ""; cmakeFlags: static[string] = "";\n makeFlags: static[string] = ""; altNames: static[string] = ""): untyped diff --git a/cimport.html b/cimport.html deleted file mode 100644 index 91c81f3..0000000 --- a/cimport.html +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - - - - - - - - - - - - - -cimport - - - - - - - - -
-
-

cimport

-
-
-
- -     Dark Mode -
- -
- Search: -
-
- Group by: - -
- - -
-
-
- -

This is the main nimterop import file to help with wrapping C/C++ source code.

-

Check out template.nim as a starting point for wrapping a new library. The template can be copied and trimmed down and modified as required. templite.nim is a shorter version for more experienced users.

-

All {.compileTime.} procs must be used in a compile time context, e.g. using:

-
static:
-  cAddStdDir()

- -
-

Types

-
- -
Feature = enum
-  ast2
-
- - - -
- -
-
-

Procs

-
- -
proc cSkipSymbol(skips: seq[string]) {...}{.compileTime, raises: [], tags: [].}
-
- -

Similar to cOverride(), this macro allows filtering out symbols not of interest from the generated output.

-

cSkipSymbol() only affects calls to cImport() that follow it.

- -

Examples:

-
static :
-  cSkipSymbol @["proc1", "Type2"]
- -
- -
proc cSearchPath(path: string): string {...}{.compileTime, raises: [], tags: [ReadDirEffect].}
-
- -

Get full path to file or directory path in search path configured using cAddSearchDir() and cAddStdDir().

-

This can be used to locate files or directories that can be passed onto cCompile(), cIncludeDir() and cImport().

- - -
- -
proc cDebug() {...}{.compileTime, raises: [], tags: [].}
-
- -Enable debug messages and display the generated Nim code - -
- -
proc cDisableCaching() {...}{.compileTime, raises: [], tags: [].}
-
- -

Disable caching of generated Nim code - useful during wrapper development

-

If files included by header being processed by cImport() change and affect the generated content, they will be ignored and the cached value will continue to be used . Use cDisableCaching() to avoid this scenario during development.

-

nim -f was broken prior to 0.19.4 but can also be used to flush the cached content.

- - -
- -
proc cAddSearchDir(dir: string) {...}{.compileTime, raises: [], tags: [].}
-
- -Add directory dir to the search path used in calls to cSearchPath(). -

Examples:

-
import
-  paths, os
-
-static :
-  cAddSearchDir testsIncludeDir()
-doAssert cSearchPath("test.h").existsFile
- -
- -
proc cAddStdDir(mode = "c") {...}{.compileTime, raises: [IOError, ValueError, OSError,
-    Exception, Defect], tags: [ReadEnvEffect, ReadIOEffect, ReadDirEffect,
-                            WriteIOEffect, ExecIOEffect, RootEffect].}
-
- -Add the standard c [default] or cpp include paths to search path used in calls to cSearchPath() -

Examples:

-
static :
-  cAddStdDir()
-import
-  os
-
-doAssert cSearchPath("math.h").existsFile
- -
- -
-
-

Macros

-
- -
macro cOverride(body): untyped
-
- -

When the wrapper code generated by nimterop is missing certain symbols or not accurate, it may be required to hand wrap them. Define them in a cOverride() macro block so that Nimterop uses these definitions instead.

-

For example:

-
int svGetCallerInfo(const char** fileName, int *lineNumber);

This might map to:

-
proc svGetCallerInfo(fileName: ptr cstring; lineNumber: var cint)

Whereas it might mean:

-
cOverride:
-  proc svGetCallerInfo(fileName: var cstring; lineNumber: var cint)

Using the cOverride() block, nimterop can be instructed to use this definition of svGetCallerInfo() instead. This works for procs, consts and types.

-

cOverride() only affects the next cImport() call. This is because any recognized symbols get overridden in place and any remaining symbols get added to the top. If reused, the next cImport() would add those symbols again leading to redefinition errors.

- - -
- -
macro cPlugin(body): untyped
-
- -When cOverride() and cSkipSymbol() are not adequate, the cPlugin() macro can be used to customize the generated Nim output. The following callbacks are available at this time.
proc onSymbol(sym: var Symbol) {.exportc, dynlib.}

onSymbol() can be used to handle symbol name modifications required due to invalid characters in identifiers or to rename symbols that would clash due to Nim's style insensitivity. The symbol name and type is provided to the callback and the name can be modified.

-

While cPlugin can easily remove leading/trailing _ or prefixes and suffixes like SDL_, passing --prefix or --suffix flags to cImport in the flags parameter is much easier. However, these flags will only be considered when no cPlugin is specified.

-

Returning a blank name will result in the symbol being skipped. This will fail for nskParam and nskField since the generated Nim code will be wrong.

-

Symbol types can be any of the following:

-
  • nskConst for constants
    • -
  • nskType for type identifiers, including primitive
    • -
  • nskParam for param names
    • -
  • nskField for struct field names
    • -
  • nskEnumField for enum (field) names, though they are in the global namespace as nskConst
    • -
  • nskProc - for proc names
    • -
-

nimterop/plugins is implicitly imported to provide access to standard plugin facilities.

-

cPlugin() only affects calls to cImport() that follow it.

- -

Examples:

-
cPlugin:
-  import
-    strutils
-
-  proc onSymbol*(sym: var Symbol) {...}{.exportc, dynlib.} =
-    sym.name = sym.name.strip(chars = {'_'})
-
-

Examples:

-
cPlugin:
-  import
-    strutils
-
-  proc onSymbol*(sym: var Symbol) {...}{.exportc, dynlib.} =
-    if sym.kind == nskProc and sym.name.contains("SDL_"):
-      sym.name = sym.name.replace("SDL_", "")
-
- -
- -
macro cDefine(name: static string; val: static string = ""): untyped
-
- -#define an identifer that is forwarded to the C/C++ preprocessor if called within cImport() or c2nImport() as well as to the C/C++ compiler during Nim compilation using {.passC: "-DXXX".} - -
- -
macro cIncludeDir(dir: static string): untyped
-
- -Add an include directory that is forwarded to the C/C++ preprocessor if called within cImport() or c2nImport() as well as to the C/C++ compiler during Nim compilation using {.passC: "-IXXX".}. - -
- -
macro cCompile(path: static string; mode = "c"; exclude = ""): untyped
-
- -

Compile and link C/C++ implementation into resulting binary using {.compile.}

-

path can be a specific file or contain wildcards:

-
cCompile("file.c")
-cCompile("path/to/*.c")

mode recursively searches for code files in path.

-

c searches for *.c whereas cpp searches for *.C *.cpp *.c++ *.cc *.cxx

-
cCompile("path/to/dir", "cpp")

exclude can be used to exclude files by partial string match. Comma separated to specify multiple exclude strings

-
cCompile("path/to/dir", exclude="test2.c")
- -
- -
macro cImport(filename: static string; recurse: static bool = false;
-             dynlib: static string = ""; mode: static string = "c";
-             flags: static string = ""): untyped
-
- -

Import all supported definitions from specified header file. Generated content is cached in nimcache until filename changes unless cDisableCaching() is set. nim -f can also be used after Nim v0.19.4 to flush the cache.

-

recurse can be used to generate Nim wrappers from #include files referenced in filename. This is only done for files in the same directory as filename or in a directory added using cIncludeDir()

-

dynlib can be used to specify the Nim string to use to specify the dynamic library to load the imported symbols from. For example:

-
const
-  dynpcre =
-    when defined(windows):
-      when defined(cpu64):
-        "pcre64.dll"
-      else:
-        "pcre32.dll"
-    elif hostOS == "macosx":
-      "libpcre(.3|.1|).dylib"
-    else:
-      "libpcre.so(.3|.1|)"
-
-cImport("pcre.h", dynlib="dynpcre")

If dynlib is not specified, the C/C++ implementation files can be compiled in with cCompile(), or the {.passL.} pragma can be used to specify the static lib to link.

-

mode is purely for forward compatibility when toast adds C++ support. It can be ignored for the foreseeable future.

-

flags can be used to pass any other command line arguments to toast. A good example would be --prefix and --suffix which strip leading and trailing strings from identifiers, _ being quite common.

-

cImport() consumes and resets preceding cOverride() calls. cPlugin() is retained for the next cImport() call unless a new cPlugin() call is defined.

- - -
- -
macro c2nImport(filename: static string; recurse: static bool = false;
-               dynlib: static string = ""; mode: static string = "c";
-               flags: static string = ""): untyped
-
- -

Import all supported definitions from specified header file using c2nim

-

Similar to cImport() but uses c2nim to generate the Nim wrapper instead of toast. Note that neither cOverride(), cSkipSymbol() nor cPlugin() have any impact on c2nim.

-

toast is only used to preprocess the header file and recurse if specified.

-

mode should be set to cpp for c2nim to wrap C++ headers.

-

flags can be used to pass other command line arguments to c2nim.

-

nimterop does not depend on c2nim as a nimble dependency so it does not get installed automatically. Any wrapper or library that requires this proc needs to install c2nim with nimble install c2nim or add it as a dependency in its own .nimble file.

- - -
- -
- - -
-
- -
-
- -
- Made with Nim. Generated: 2020-03-24 20:55:42 UTC -
-
-
-
- - - diff --git a/cimport.idx b/cimport.idx deleted file mode 100644 index 1c392ae..0000000 --- a/cimport.idx +++ /dev/null @@ -1,15 +0,0 @@ -ast2 cimport.html#ast2 Feature.ast2 -Feature cimport.html#Feature cimport: Feature -cOverride cimport.html#cOverride.m cimport: cOverride(body): untyped -cSkipSymbol cimport.html#cSkipSymbol,seq[T][string] cimport: cSkipSymbol(skips: seq[string]) -cPlugin cimport.html#cPlugin.m cimport: cPlugin(body): untyped -cSearchPath cimport.html#cSearchPath,string cimport: cSearchPath(path: string): string -cDebug cimport.html#cDebug cimport: cDebug() -cDisableCaching cimport.html#cDisableCaching cimport: cDisableCaching() -cDefine cimport.html#cDefine.m,,string cimport: cDefine(name: static string; val: static string = ""): untyped -cAddSearchDir cimport.html#cAddSearchDir,string cimport: cAddSearchDir(dir: string) -cIncludeDir cimport.html#cIncludeDir.m cimport: cIncludeDir(dir: static string): untyped -cAddStdDir cimport.html#cAddStdDir,string cimport: cAddStdDir(mode = "c") -cCompile cimport.html#cCompile.m,,string,string cimport: cCompile(path: static string; mode = "c"; exclude = ""): untyped -cImport cimport.html#cImport.m,,string,string,string cimport: cImport(filename: static string; recurse: static bool = false;\n dynlib: static string = ""; mode: static string = "c"; flags: static string = ""): untyped -c2nImport cimport.html#c2nImport.m,,string,string,string cimport: c2nImport(filename: static string; recurse: static bool = false;\n dynlib: static string = ""; mode: static string = "c"; flags: static string = ""): untyped diff --git a/compat.html b/compat.html deleted file mode 100644 index 85fdf3b..0000000 --- a/compat.html +++ /dev/null @@ -1,870 +0,0 @@ - - - - - - - - - - - - - - - - - - -compat - - - - - - - - -
-
-

compat

-
-
- -
- Search: -
-
- Group by: - -
- - -
-
-
- -

-
-

Procs

-
- -
proc myNormalizedPath(path: string): string {...}{.raises: [], tags: [].}
-
- - - -
- -
- -
-
- -
-
- -
- Made with Nim. Generated: 2020-03-10 02:10:43 UTC -
-
-
-
- - - diff --git a/compat.idx b/compat.idx deleted file mode 100644 index 8dd5329..0000000 --- a/compat.idx +++ /dev/null @@ -1 +0,0 @@ -myNormalizedPath compat.html#myNormalizedPath,string compat: myNormalizedPath(path: string): string diff --git a/dochack.js b/dochack.js deleted file mode 100644 index 0fd6939..0000000 --- a/dochack.js +++ /dev/null @@ -1,2011 +0,0 @@ -/* Generated by the Nim Compiler v1.1.1 */ -var framePtr = null; -var excHandler = 0; -var lastJSError = null; -if (typeof Int8Array === 'undefined') Int8Array = Array; -if (typeof Int16Array === 'undefined') Int16Array = Array; -if (typeof Int32Array === 'undefined') Int32Array = Array; -if (typeof Uint8Array === 'undefined') Uint8Array = Array; -if (typeof Uint16Array === 'undefined') Uint16Array = Array; -if (typeof Uint32Array === 'undefined') Uint32Array = Array; -if (typeof Float32Array === 'undefined') Float32Array = Array; -if (typeof Float64Array === 'undefined') Float64Array = Array; -var NTI163 = {size: 0,kind: 1,base: null,node: null,finalizer: null}; -var NTI9681058 = {size: 0, kind: 18, base: null, node: null, finalizer: null}; -var NTI6098 = {size: 0, kind: 17, base: null, node: null, finalizer: null}; -var NTI9835571 = {size: 0,kind: 24,base: null,node: null,finalizer: null}; -var NTI622454 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622450 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622446 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622442 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622438 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622434 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622430 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622426 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622422 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622418 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622414 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622410 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622406 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622402 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622398 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622394 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622390 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622386 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622382 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622378 = {size: 0,kind: 25,base: null,node: null,finalizer: null}; -var NTI622205 = {size: 0, kind: 17, base: null, node: null, finalizer: null}; -var NTI622289 = {size: 0, kind: 17, base: null, node: null, finalizer: null}; -var NTI622287 = {size: 0,kind: 22,base: null,node: null,finalizer: null}; -var NTI622229 = {size: 0, kind: 14, base: null, node: null, finalizer: null}; -var NTI622574 = {size: 0,kind: 24,base: null,node: null,finalizer: null}; -var NTI622572 = {size: 0,kind: 24,base: null,node: null,finalizer: null}; -var NTI622570 = {size: 0,kind: 24,base: null,node: null,finalizer: null}; -var NTI622233 = {size: 0, kind: 17, base: null, node: null, finalizer: null}; -var NTI622231 = {size: 0,kind: 22,base: null,node: null,finalizer: null}; -var NTI624105 = {size: 0,kind: 24,base: null,node: null,finalizer: null}; -var NTI6086 = {size: 0, kind: 17, base: null, node: null, finalizer: null}; -var NTI6094 = {size: 0, kind: 17, base: null, node: null, finalizer: null}; -var NTI143 = {size: 0,kind: 31,base: null,node: null,finalizer: null}; -var NTI160043 = {size: 0, kind: 18, base: null, node: null, finalizer: null}; -var NTI6008 = {size: 0, kind: 17, base: null, node: null, finalizer: null}; -var NTI6131 = {size: 0,kind: 22,base: null,node: null,finalizer: null}; -var NTI112 = {size: 0,kind: 28,base: null,node: null,finalizer: null}; -var NTI114 = {size: 0,kind: 29,base: null,node: null,finalizer: null}; -var NTI6126 = {size: 0,kind: 22,base: null,node: null,finalizer: null}; -var NTI6062 = {size: 0, kind: 17, base: null, node: null, finalizer: null}; -var NTI6064 = {size: 0, kind: 17, base: null, node: null, finalizer: null}; -var NTI6078 = {size: 0, kind: 17, base: null, node: null, finalizer: null}; -var NTI6082 = {size: 0, kind: 17, base: null, node: null, finalizer: null}; -var NNI6082 = {kind: 2, len: 0, offset: 0, typ: null, name: null, sons: []}; -NTI6082.node = NNI6082; -var NNI6078 = {kind: 2, len: 0, offset: 0, typ: null, name: null, sons: []}; -NTI6078.node = NNI6078; -var NNI6064 = {kind: 2, len: 0, offset: 0, typ: null, name: null, sons: []}; -NTI6064.node = NNI6064; -NTI6126.base = NTI6062; -NTI6131.base = NTI6062; -var NNI6062 = {kind: 2, len: 5, offset: 0, typ: null, name: null, sons: [{kind: 1, offset: "parent", len: 0, typ: NTI6126, name: "parent", sons: null}, -{kind: 1, offset: "name", len: 0, typ: NTI114, name: "name", sons: null}, -{kind: 1, offset: "message", len: 0, typ: NTI112, name: "msg", sons: null}, -{kind: 1, offset: "trace", len: 0, typ: NTI112, name: "trace", sons: null}, -{kind: 1, offset: "up", len: 0, typ: NTI6131, name: "up", sons: null}]}; -NTI6062.node = NNI6062; -var NNI6008 = {kind: 2, len: 0, offset: 0, typ: null, name: null, sons: []}; -NTI6008.node = NNI6008; -NTI6062.base = NTI6008; -NTI6064.base = NTI6062; -NTI6078.base = NTI6064; -NTI6082.base = NTI6078; -var NNI160043 = {kind: 2, len: 2, offset: 0, typ: null, name: null, sons: [{kind: 1, offset: "Field0", len: 0, typ: NTI114, name: "Field0", sons: null}, -{kind: 1, offset: "Field1", len: 0, typ: NTI143, name: "Field1", sons: null}]}; -NTI160043.node = NNI160043; -var NNI6094 = {kind: 2, len: 0, offset: 0, typ: null, name: null, sons: []}; -NTI6094.node = NNI6094; -NTI6094.base = NTI6064; -var NNI6086 = {kind: 2, len: 0, offset: 0, typ: null, name: null, sons: []}; -NTI6086.node = NNI6086; -NTI6086.base = NTI6064; -NTI622570.base = NTI622231; -NTI622572.base = NTI622231; -NTI622574.base = NTI622231; -var NNI622229 = {kind: 2, offset: 0, typ: null, name: null, len: 12, sons: {"1": {kind: 1, offset: 1, typ: NTI622229, name: "ElementNode", len: 0, sons: null}, -"2": {kind: 1, offset: 2, typ: NTI622229, name: "AttributeNode", len: 0, sons: null}, -"3": {kind: 1, offset: 3, typ: NTI622229, name: "TextNode", len: 0, sons: null}, -"4": {kind: 1, offset: 4, typ: NTI622229, name: "CDATANode", len: 0, sons: null}, -"5": {kind: 1, offset: 5, typ: NTI622229, name: "EntityRefNode", len: 0, sons: null}, -"6": {kind: 1, offset: 6, typ: NTI622229, name: "EntityNode", len: 0, sons: null}, -"7": {kind: 1, offset: 7, typ: NTI622229, name: "ProcessingInstructionNode", len: 0, sons: null}, -"8": {kind: 1, offset: 8, typ: NTI622229, name: "CommentNode", len: 0, sons: null}, -"9": {kind: 1, offset: 9, typ: NTI622229, name: "DocumentNode", len: 0, sons: null}, -"10": {kind: 1, offset: 10, typ: NTI622229, name: "DocumentTypeNode", len: 0, sons: null}, -"11": {kind: 1, offset: 11, typ: NTI622229, name: "DocumentFragmentNode", len: 0, sons: null}, -"12": {kind: 1, offset: 12, typ: NTI622229, name: "NotationNode", len: 0, sons: null}}}; -NTI622229.node = NNI622229; -var NNI622289 = {kind: 2, len: 100, offset: 0, typ: null, name: null, sons: [{kind: 1, offset: "background", len: 0, typ: NTI114, name: "background", sons: null}, -{kind: 1, offset: "backgroundAttachment", len: 0, typ: NTI114, name: "backgroundAttachment", sons: null}, -{kind: 1, offset: "backgroundColor", len: 0, typ: NTI114, name: "backgroundColor", sons: null}, -{kind: 1, offset: "backgroundImage", len: 0, typ: NTI114, name: "backgroundImage", sons: null}, -{kind: 1, offset: "backgroundPosition", len: 0, typ: NTI114, name: "backgroundPosition", sons: null}, -{kind: 1, offset: "backgroundRepeat", len: 0, typ: NTI114, name: "backgroundRepeat", sons: null}, -{kind: 1, offset: "backgroundSize", len: 0, typ: NTI114, name: "backgroundSize", sons: null}, -{kind: 1, offset: "border", len: 0, typ: NTI114, name: "border", sons: null}, -{kind: 1, offset: "borderBottom", len: 0, typ: NTI114, name: "borderBottom", sons: null}, -{kind: 1, offset: "borderBottomColor", len: 0, typ: NTI114, name: "borderBottomColor", sons: null}, -{kind: 1, offset: "borderBottomStyle", len: 0, typ: NTI114, name: "borderBottomStyle", sons: null}, -{kind: 1, offset: "borderBottomWidth", len: 0, typ: NTI114, name: "borderBottomWidth", sons: null}, -{kind: 1, offset: "borderColor", len: 0, typ: NTI114, name: "borderColor", sons: null}, -{kind: 1, offset: "borderLeft", len: 0, typ: NTI114, name: "borderLeft", sons: null}, -{kind: 1, offset: "borderLeftColor", len: 0, typ: NTI114, name: "borderLeftColor", sons: null}, -{kind: 1, offset: "borderLeftStyle", len: 0, typ: NTI114, name: "borderLeftStyle", sons: null}, -{kind: 1, offset: "borderLeftWidth", len: 0, typ: NTI114, name: "borderLeftWidth", sons: null}, -{kind: 1, offset: "borderRadius", len: 0, typ: NTI114, name: "borderRadius", sons: null}, -{kind: 1, offset: "borderRight", len: 0, typ: NTI114, name: "borderRight", sons: null}, -{kind: 1, offset: "borderRightColor", len: 0, typ: NTI114, name: "borderRightColor", sons: null}, -{kind: 1, offset: "borderRightStyle", len: 0, typ: NTI114, name: "borderRightStyle", sons: null}, -{kind: 1, offset: "borderRightWidth", len: 0, typ: NTI114, name: "borderRightWidth", sons: null}, -{kind: 1, offset: "borderStyle", len: 0, typ: NTI114, name: "borderStyle", sons: null}, -{kind: 1, offset: "borderTop", len: 0, typ: NTI114, name: "borderTop", sons: null}, -{kind: 1, offset: "borderTopColor", len: 0, typ: NTI114, name: "borderTopColor", sons: null}, -{kind: 1, offset: "borderTopStyle", len: 0, typ: NTI114, name: "borderTopStyle", sons: null}, -{kind: 1, offset: "borderTopWidth", len: 0, typ: NTI114, name: "borderTopWidth", sons: null}, -{kind: 1, offset: "borderWidth", len: 0, typ: NTI114, name: "borderWidth", sons: null}, -{kind: 1, offset: "bottom", len: 0, typ: NTI114, name: "bottom", sons: null}, -{kind: 1, offset: "boxSizing", len: 0, typ: NTI114, name: "boxSizing", sons: null}, -{kind: 1, offset: "boxShadow", len: 0, typ: NTI114, name: "boxShadow", sons: null}, -{kind: 1, offset: "captionSide", len: 0, typ: NTI114, name: "captionSide", sons: null}, -{kind: 1, offset: "clear", len: 0, typ: NTI114, name: "clear", sons: null}, -{kind: 1, offset: "clip", len: 0, typ: NTI114, name: "clip", sons: null}, -{kind: 1, offset: "color", len: 0, typ: NTI114, name: "color", sons: null}, -{kind: 1, offset: "cursor", len: 0, typ: NTI114, name: "cursor", sons: null}, -{kind: 1, offset: "direction", len: 0, typ: NTI114, name: "direction", sons: null}, -{kind: 1, offset: "display", len: 0, typ: NTI114, name: "display", sons: null}, -{kind: 1, offset: "emptyCells", len: 0, typ: NTI114, name: "emptyCells", sons: null}, -{kind: 1, offset: "cssFloat", len: 0, typ: NTI114, name: "cssFloat", sons: null}, -{kind: 1, offset: "font", len: 0, typ: NTI114, name: "font", sons: null}, -{kind: 1, offset: "fontFamily", len: 0, typ: NTI114, name: "fontFamily", sons: null}, -{kind: 1, offset: "fontSize", len: 0, typ: NTI114, name: "fontSize", sons: null}, -{kind: 1, offset: "fontStretch", len: 0, typ: NTI114, name: "fontStretch", sons: null}, -{kind: 1, offset: "fontStyle", len: 0, typ: NTI114, name: "fontStyle", sons: null}, -{kind: 1, offset: "fontVariant", len: 0, typ: NTI114, name: "fontVariant", sons: null}, -{kind: 1, offset: "fontWeight", len: 0, typ: NTI114, name: "fontWeight", sons: null}, -{kind: 1, offset: "height", len: 0, typ: NTI114, name: "height", sons: null}, -{kind: 1, offset: "left", len: 0, typ: NTI114, name: "left", sons: null}, -{kind: 1, offset: "letterSpacing", len: 0, typ: NTI114, name: "letterSpacing", sons: null}, -{kind: 1, offset: "lineHeight", len: 0, typ: NTI114, name: "lineHeight", sons: null}, -{kind: 1, offset: "listStyle", len: 0, typ: NTI114, name: "listStyle", sons: null}, -{kind: 1, offset: "listStyleImage", len: 0, typ: NTI114, name: "listStyleImage", sons: null}, -{kind: 1, offset: "listStylePosition", len: 0, typ: NTI114, name: "listStylePosition", sons: null}, -{kind: 1, offset: "listStyleType", len: 0, typ: NTI114, name: "listStyleType", sons: null}, -{kind: 1, offset: "margin", len: 0, typ: NTI114, name: "margin", sons: null}, -{kind: 1, offset: "marginBottom", len: 0, typ: NTI114, name: "marginBottom", sons: null}, -{kind: 1, offset: "marginLeft", len: 0, typ: NTI114, name: "marginLeft", sons: null}, -{kind: 1, offset: "marginRight", len: 0, typ: NTI114, name: "marginRight", sons: null}, -{kind: 1, offset: "marginTop", len: 0, typ: NTI114, name: "marginTop", sons: null}, -{kind: 1, offset: "maxHeight", len: 0, typ: NTI114, name: "maxHeight", sons: null}, -{kind: 1, offset: "maxWidth", len: 0, typ: NTI114, name: "maxWidth", sons: null}, -{kind: 1, offset: "minHeight", len: 0, typ: NTI114, name: "minHeight", sons: null}, -{kind: 1, offset: "minWidth", len: 0, typ: NTI114, name: "minWidth", sons: null}, -{kind: 1, offset: "opacity", len: 0, typ: NTI114, name: "opacity", sons: null}, -{kind: 1, offset: "outline", len: 0, typ: NTI114, name: "outline", sons: null}, -{kind: 1, offset: "overflow", len: 0, typ: NTI114, name: "overflow", sons: null}, -{kind: 1, offset: "overflowX", len: 0, typ: NTI114, name: "overflowX", sons: null}, -{kind: 1, offset: "overflowY", len: 0, typ: NTI114, name: "overflowY", sons: null}, -{kind: 1, offset: "padding", len: 0, typ: NTI114, name: "padding", sons: null}, -{kind: 1, offset: "paddingBottom", len: 0, typ: NTI114, name: "paddingBottom", sons: null}, -{kind: 1, offset: "paddingLeft", len: 0, typ: NTI114, name: "paddingLeft", sons: null}, -{kind: 1, offset: "paddingRight", len: 0, typ: NTI114, name: "paddingRight", sons: null}, -{kind: 1, offset: "paddingTop", len: 0, typ: NTI114, name: "paddingTop", sons: null}, -{kind: 1, offset: "pageBreakAfter", len: 0, typ: NTI114, name: "pageBreakAfter", sons: null}, -{kind: 1, offset: "pageBreakBefore", len: 0, typ: NTI114, name: "pageBreakBefore", sons: null}, -{kind: 1, offset: "pointerEvents", len: 0, typ: NTI114, name: "pointerEvents", sons: null}, -{kind: 1, offset: "position", len: 0, typ: NTI114, name: "position", sons: null}, -{kind: 1, offset: "resize", len: 0, typ: NTI114, name: "resize", sons: null}, -{kind: 1, offset: "right", len: 0, typ: NTI114, name: "right", sons: null}, -{kind: 1, offset: "scrollbar3dLightColor", len: 0, typ: NTI114, name: "scrollbar3dLightColor", sons: null}, -{kind: 1, offset: "scrollbarArrowColor", len: 0, typ: NTI114, name: "scrollbarArrowColor", sons: null}, -{kind: 1, offset: "scrollbarBaseColor", len: 0, typ: NTI114, name: "scrollbarBaseColor", sons: null}, -{kind: 1, offset: "scrollbarDarkshadowColor", len: 0, typ: NTI114, name: "scrollbarDarkshadowColor", sons: null}, -{kind: 1, offset: "scrollbarFaceColor", len: 0, typ: NTI114, name: "scrollbarFaceColor", sons: null}, -{kind: 1, offset: "scrollbarHighlightColor", len: 0, typ: NTI114, name: "scrollbarHighlightColor", sons: null}, -{kind: 1, offset: "scrollbarShadowColor", len: 0, typ: NTI114, name: "scrollbarShadowColor", sons: null}, -{kind: 1, offset: "scrollbarTrackColor", len: 0, typ: NTI114, name: "scrollbarTrackColor", sons: null}, -{kind: 1, offset: "tableLayout", len: 0, typ: NTI114, name: "tableLayout", sons: null}, -{kind: 1, offset: "textAlign", len: 0, typ: NTI114, name: "textAlign", sons: null}, -{kind: 1, offset: "textDecoration", len: 0, typ: NTI114, name: "textDecoration", sons: null}, -{kind: 1, offset: "textIndent", len: 0, typ: NTI114, name: "textIndent", sons: null}, -{kind: 1, offset: "textTransform", len: 0, typ: NTI114, name: "textTransform", sons: null}, -{kind: 1, offset: "transform", len: 0, typ: NTI114, name: "transform", sons: null}, -{kind: 1, offset: "top", len: 0, typ: NTI114, name: "top", sons: null}, -{kind: 1, offset: "verticalAlign", len: 0, typ: NTI114, name: "verticalAlign", sons: null}, -{kind: 1, offset: "visibility", len: 0, typ: NTI114, name: "visibility", sons: null}, -{kind: 1, offset: "width", len: 0, typ: NTI114, name: "width", sons: null}, -{kind: 1, offset: "wordSpacing", len: 0, typ: NTI114, name: "wordSpacing", sons: null}, -{kind: 1, offset: "zIndex", len: 0, typ: NTI143, name: "zIndex", sons: null}]}; -NTI622289.node = NNI622289; -NTI622289.base = NTI6008; -NTI622287.base = NTI622289; -var NNI622233 = {kind: 2, len: 16, offset: 0, typ: null, name: null, sons: [{kind: 1, offset: "attributes", len: 0, typ: NTI622570, name: "attributes", sons: null}, -{kind: 1, offset: "childNodes", len: 0, typ: NTI622572, name: "childNodes", sons: null}, -{kind: 1, offset: "children", len: 0, typ: NTI622574, name: "children", sons: null}, -{kind: 1, offset: "data", len: 0, typ: NTI114, name: "data", sons: null}, -{kind: 1, offset: "firstChild", len: 0, typ: NTI622231, name: "firstChild", sons: null}, -{kind: 1, offset: "lastChild", len: 0, typ: NTI622231, name: "lastChild", sons: null}, -{kind: 1, offset: "nextSibling", len: 0, typ: NTI622231, name: "nextSibling", sons: null}, -{kind: 1, offset: "nodeName", len: 0, typ: NTI114, name: "nodeName", sons: null}, -{kind: 1, offset: "nodeType", len: 0, typ: NTI622229, name: "nodeType", sons: null}, -{kind: 1, offset: "nodeValue", len: 0, typ: NTI114, name: "nodeValue", sons: null}, -{kind: 1, offset: "parentNode", len: 0, typ: NTI622231, name: "parentNode", sons: null}, -{kind: 1, offset: "previousSibling", len: 0, typ: NTI622231, name: "previousSibling", sons: null}, -{kind: 1, offset: "innerHTML", len: 0, typ: NTI114, name: "innerHTML", sons: null}, -{kind: 1, offset: "innerText", len: 0, typ: NTI114, name: "innerText", sons: null}, -{kind: 1, offset: "textContent", len: 0, typ: NTI114, name: "textContent", sons: null}, -{kind: 1, offset: "style", len: 0, typ: NTI622287, name: "style", sons: null}]}; -NTI622233.node = NNI622233; -var NNI622205 = {kind: 2, len: 20, offset: 0, typ: null, name: null, sons: [{kind: 1, offset: "onabort", len: 0, typ: NTI622378, name: "onabort", sons: null}, -{kind: 1, offset: "onblur", len: 0, typ: NTI622382, name: "onblur", sons: null}, -{kind: 1, offset: "onchange", len: 0, typ: NTI622386, name: "onchange", sons: null}, -{kind: 1, offset: "onclick", len: 0, typ: NTI622390, name: "onclick", sons: null}, -{kind: 1, offset: "ondblclick", len: 0, typ: NTI622394, name: "ondblclick", sons: null}, -{kind: 1, offset: "onerror", len: 0, typ: NTI622398, name: "onerror", sons: null}, -{kind: 1, offset: "onfocus", len: 0, typ: NTI622402, name: "onfocus", sons: null}, -{kind: 1, offset: "onkeydown", len: 0, typ: NTI622406, name: "onkeydown", sons: null}, -{kind: 1, offset: "onkeypress", len: 0, typ: NTI622410, name: "onkeypress", sons: null}, -{kind: 1, offset: "onkeyup", len: 0, typ: NTI622414, name: "onkeyup", sons: null}, -{kind: 1, offset: "onload", len: 0, typ: NTI622418, name: "onload", sons: null}, -{kind: 1, offset: "onmousedown", len: 0, typ: NTI622422, name: "onmousedown", sons: null}, -{kind: 1, offset: "onmousemove", len: 0, typ: NTI622426, name: "onmousemove", sons: null}, -{kind: 1, offset: "onmouseout", len: 0, typ: NTI622430, name: "onmouseout", sons: null}, -{kind: 1, offset: "onmouseover", len: 0, typ: NTI622434, name: "onmouseover", sons: null}, -{kind: 1, offset: "onmouseup", len: 0, typ: NTI622438, name: "onmouseup", sons: null}, -{kind: 1, offset: "onreset", len: 0, typ: NTI622442, name: "onreset", sons: null}, -{kind: 1, offset: "onselect", len: 0, typ: NTI622446, name: "onselect", sons: null}, -{kind: 1, offset: "onsubmit", len: 0, typ: NTI622450, name: "onsubmit", sons: null}, -{kind: 1, offset: "onunload", len: 0, typ: NTI622454, name: "onunload", sons: null}]}; -NTI622205.node = NNI622205; -NTI622205.base = NTI6008; -NTI622233.base = NTI622205; -NTI622231.base = NTI622233; -NTI624105.base = NTI622231; -NTI9835571.base = NTI114; -var NNI6098 = {kind: 2, len: 0, offset: 0, typ: null, name: null, sons: []}; -NTI6098.node = NNI6098; -NTI6098.base = NTI6064; -var NNI9681058 = {kind: 2, len: 2, offset: 0, typ: null, name: null, sons: [{kind: 1, offset: "Field0", len: 0, typ: NTI143, name: "Field0", sons: null}, -{kind: 1, offset: "Field1", len: 0, typ: NTI163, name: "Field1", sons: null}]}; -NTI9681058.node = NNI9681058; - -function makeNimstrLit(c_225062) { - var ln = c_225062.length; - var result = new Array(ln); - for (var i = 0; i < ln; ++i) { - result[i] = c_225062.charCodeAt(i); - } - return result; - - - -} - -function arrayConstr(len_250067, value_250068, typ_250069) { - var result = new Array(len_250067); - for (var i = 0; i < len_250067; ++i) result[i] = nimCopy(null, value_250068, typ_250069); - return result; - - - -} - -function setConstr() { - var result = {}; - for (var i = 0; i < arguments.length; ++i) { - var x = arguments[i]; - if (typeof(x) == "object") { - for (var j = x[0]; j <= x[1]; ++j) { - result[j] = true; - } - } else { - result[x] = true; - } - } - return result; - - - -} -var ConstSet1 = setConstr(17, 16, 4, 18, 27, 19, 23, 22, 21); - -function nimCopy(dest_240023, src_240024, ti_240025) { - var result_245219 = null; - - switch (ti_240025.kind) { - case 21: - case 22: - case 23: - case 5: - if (!(is_fat_pointer_235401(ti_240025))) { - result_245219 = src_240024; - } - else { - result_245219 = [src_240024[0], src_240024[1]]; - } - - break; - case 19: - if (dest_240023 === null || dest_240023 === undefined) { - dest_240023 = {}; - } - else { - for (var key in dest_240023) { delete dest_240023[key]; } - } - for (var key in src_240024) { dest_240023[key] = src_240024[key]; } - result_245219 = dest_240023; - - break; - case 18: - case 17: - if (!((ti_240025.base == null))) { - result_245219 = nimCopy(dest_240023, src_240024, ti_240025.base); - } - else { - if ((ti_240025.kind == 17)) { - result_245219 = (dest_240023 === null || dest_240023 === undefined) ? {m_type: ti_240025} : dest_240023; - } - else { - result_245219 = (dest_240023 === null || dest_240023 === undefined) ? {} : dest_240023; - } - } - nimCopyAux(result_245219, src_240024, ti_240025.node); - break; - case 24: - case 4: - case 27: - case 16: - if (src_240024 === null) { - result_245219 = null; - } - else { - if (dest_240023 === null || dest_240023 === undefined) { - dest_240023 = new Array(src_240024.length); - } - else { - dest_240023.length = src_240024.length; - } - result_245219 = dest_240023; - for (var i = 0; i < src_240024.length; ++i) { - result_245219[i] = nimCopy(result_245219[i], src_240024[i], ti_240025.base); - } - } - - break; - case 28: - if (src_240024 !== null) { - result_245219 = src_240024.slice(0); - } - - break; - default: - result_245219 = src_240024; - break; - } - - return result_245219; - -} - -function cstrToNimstr(c_225079) { - var ln = c_225079.length; - var result = new Array(ln); - var r = 0; - for (var i = 0; i < ln; ++i) { - var ch = c_225079.charCodeAt(i); - - if (ch < 128) { - result[r] = ch; - } - else { - if (ch < 2048) { - result[r] = (ch >> 6) | 192; - } - else { - if (ch < 55296 || ch >= 57344) { - result[r] = (ch >> 12) | 224; - } - else { - ++i; - ch = 65536 + (((ch & 1023) << 10) | (c_225079.charCodeAt(i) & 1023)); - result[r] = (ch >> 18) | 240; - ++r; - result[r] = ((ch >> 12) & 63) | 128; - } - ++r; - result[r] = ((ch >> 6) & 63) | 128; - } - ++r; - result[r] = (ch & 63) | 128; - } - ++r; - } - return result; - - - -} - -function toJSStr(s_225096) { - var Tmp5; - var Tmp7; - - var result_225097 = null; - - var res_225170 = new_seq_225128((s_225096 != null ? s_225096.length : 0)); - var i_225172 = 0; - var j_225174 = 0; - L1: do { - L2: while (true) { - if (!(i_225172 < (s_225096 != null ? s_225096.length : 0))) break L2; - var c_225175 = s_225096[i_225172]; - if ((c_225175 < 128)) { - res_225170[j_225174] = String.fromCharCode(c_225175); - i_225172 += 1; - } - else { - var helper_225198 = new_seq_225128(0); - L3: do { - L4: while (true) { - if (!true) break L4; - var code_225199 = c_225175.toString(16); - if (((code_225199 != null ? code_225199.length : 0) == 1)) { - if (helper_225198 != null) { helper_225198.push("%0"); } else { helper_225198 = ["%0"]; }; - } - else { - if (helper_225198 != null) { helper_225198.push("%"); } else { helper_225198 = ["%"]; }; - } - - if (helper_225198 != null) { helper_225198.push(code_225199); } else { helper_225198 = [code_225199]; }; - i_225172 += 1; - if (((s_225096 != null ? s_225096.length : 0) <= i_225172)) Tmp5 = true; else { Tmp5 = (s_225096[i_225172] < 128); } if (Tmp5) { - break L3; - } - - c_225175 = s_225096[i_225172]; - } - } while(false); -++excHandler; - Tmp7 = framePtr; - try { - res_225170[j_225174] = decodeURIComponent(helper_225198.join("")); ---excHandler; -} catch (EXC) { - var prevJSError = lastJSError; - lastJSError = EXC; - --excHandler; - framePtr = Tmp7; - res_225170[j_225174] = helper_225198.join(""); - lastJSError = prevJSError; - } finally { - framePtr = Tmp7; - } - } - - j_225174 += 1; - } - } while(false); - if (res_225170 === null) res_225170 = []; - if (res_225170.length < j_225174) { for (var i=res_225170.length;i 2147483647 || result < -2147483648) raiseOverflow(); - return result; - - - -} - -function chckIndx(i_250086, a_250087, b_250088) { - var Tmp1; - - var result_250089 = 0; - - BeforeRet: do { - if (!(a_250087 <= i_250086)) Tmp1 = false; else { Tmp1 = (i_250086 <= b_250088); } if (Tmp1) { - result_250089 = i_250086; - break BeforeRet; - } - else { - raiseIndexError(i_250086, a_250087, b_250088); - } - - } while (false); - - return result_250089; - -} - -function subInt(a_230421, b_230422) { - var result = a_230421 - b_230422; - if (result > 2147483647 || result < -2147483648) raiseOverflow(); - return result; - - - -} -var ConstSet2 = setConstr([65, 90]); - -function chckRange(i_255016, a_255017, b_255018) { - var Tmp1; - - var result_255019 = 0; - - BeforeRet: do { - if (!(a_255017 <= i_255016)) Tmp1 = false; else { Tmp1 = (i_255016 <= b_255018); } if (Tmp1) { - result_255019 = i_255016; - break BeforeRet; - } - else { - raiseRangeError(); - } - - } while (false); - - return result_255019; - -} -var ConstSet3 = setConstr(95, 32, 46); -var ConstSet4 = setConstr(95, 32, 46); - -function mulInt(a_230439, b_230440) { - var result = a_230439 * b_230440; - if (result > 2147483647 || result < -2147483648) raiseOverflow(); - return result; - - - -} -var ConstSet5 = setConstr([97, 122]); -var ConstSet6 = setConstr([65, 90], [97, 122]); -var ConstSet7 = setConstr([97, 122]); -var ConstSet8 = setConstr([65, 90]); - -function nimMax(a_230821, b_230822) { - var Tmp1; - - var result_230823 = 0; - - BeforeRet: do { - if ((b_230822 <= a_230821)) { - Tmp1 = a_230821; - } - else { - Tmp1 = b_230822; - } - - result_230823 = Tmp1; - break BeforeRet; - } while (false); - - return result_230823; - -} - -function nimMin(a_230803, b_230804) { - var Tmp1; - - var result_230805 = 0; - - BeforeRet: do { - if ((a_230803 <= b_230804)) { - Tmp1 = a_230803; - } - else { - Tmp1 = b_230804; - } - - result_230805 = Tmp1; - break BeforeRet; - } while (false); - - return result_230805; - -} -var nim_program_result = 0; -var global_raise_hook_142018 = [null]; -var local_raise_hook_142023 = [null]; -var out_of_mem_hook_142026 = [null]; -var unhandled_exception_hook_142031 = [null]; -if (!Math.trunc) { - Math.trunc = function(v) { - v = +v; - if (!isFinite(v)) return v; - return (v - v % 1) || (v < 0 ? -0 : v === 0 ? v : 0); - }; -} - -var alternative_9835319 = [null]; - -function add_142042(x_142045, x_142045_Idx, y_142046) { - if (x_142045[x_142045_Idx] === null) { x_142045[x_142045_Idx] = []; } - var off = x_142045[x_142045_Idx].length; - x_142045[x_142045_Idx].length += y_142046.length; - for (var i = 0; i < y_142046.length; ++i) { - x_142045[x_142045_Idx][off+i] = y_142046.charCodeAt(i); - } - - - -} - -function is_fat_pointer_235401(ti_235403) { - var result_235404 = false; - - BeforeRet: do { - result_235404 = !((ConstSet1[ti_235403.base.kind] != undefined)); - break BeforeRet; - } while (false); - - return result_235404; - -} - -function nimCopyAux(dest_240028, src_240029, n_240031) { - switch (n_240031.kind) { - case 0: - break; - case 1: - dest_240028[n_240031.offset] = nimCopy(dest_240028[n_240031.offset], src_240029[n_240031.offset], n_240031.typ); - - break; - case 2: - for (var i = 0; i < n_240031.sons.length; i++) { - nimCopyAux(dest_240028, src_240029, n_240031.sons[i]); - } - - break; - case 3: - dest_240028[n_240031.offset] = nimCopy(dest_240028[n_240031.offset], src_240029[n_240031.offset], n_240031.typ); - for (var i = 0; i < n_240031.sons.length; ++i) { - nimCopyAux(dest_240028, src_240029, n_240031.sons[i][1]); - } - - break; - } - - -} - -function aux_write_stack_trace_160038(f_160040) { - var Tmp3; - - var result_160041 = [null]; - - var it_160049 = f_160040; - var i_160051 = 0; - var total_160053 = 0; - var temp_frames_160060 = arrayConstr(64, {Field0: null, Field1: 0}, NTI160043); - L1: do { - L2: while (true) { - if (!!((it_160049 == null))) Tmp3 = false; else { Tmp3 = (i_160051 <= 63); } if (!Tmp3) break L2; - temp_frames_160060[i_160051].Field0 = it_160049.procname; - temp_frames_160060[i_160051].Field1 = it_160049.line; - i_160051 += 1; - total_160053 += 1; - it_160049 = it_160049.prev; - } - } while(false); - L4: do { - L5: while (true) { - if (!!((it_160049 == null))) break L5; - total_160053 += 1; - it_160049 = it_160049.prev; - } - } while(false); - result_160041[0] = nimCopy(null, [], NTI112); - if (!((total_160053 == i_160051))) { - if (result_160041[0] != null) { result_160041[0] = (result_160041[0]).concat(makeNimstrLit("(")); } else { result_160041[0] = makeNimstrLit("("); }; - if (result_160041[0] != null) { result_160041[0] = (result_160041[0]).concat(cstrToNimstr(((total_160053 - i_160051))+"")); } else { result_160041[0] = cstrToNimstr(((total_160053 - i_160051))+"").slice(); }; - if (result_160041[0] != null) { result_160041[0] = (result_160041[0]).concat(makeNimstrLit(" calls omitted) ...\x0A")); } else { result_160041[0] = makeNimstrLit(" calls omitted) ...\x0A"); }; - } - - L6: do { - var j_175236 = 0; - var colontmp__9835463 = 0; - colontmp__9835463 = (i_160051 - 1); - var res_9835468 = colontmp__9835463; - L7: do { - L8: while (true) { - if (!(0 <= res_9835468)) break L8; - j_175236 = res_9835468; - add_142042(result_160041, 0, temp_frames_160060[j_175236].Field0); - if ((0 < temp_frames_160060[j_175236].Field1)) { - if (result_160041[0] != null) { result_160041[0] = (result_160041[0]).concat(makeNimstrLit(", line: ")); } else { result_160041[0] = makeNimstrLit(", line: "); }; - if (result_160041[0] != null) { result_160041[0] = (result_160041[0]).concat(cstrToNimstr((temp_frames_160060[j_175236].Field1)+"")); } else { result_160041[0] = cstrToNimstr((temp_frames_160060[j_175236].Field1)+"").slice(); }; - } - - if (result_160041[0] != null) { result_160041[0] = (result_160041[0]).concat(makeNimstrLit("\x0A")); } else { result_160041[0] = makeNimstrLit("\x0A"); }; - res_9835468 -= 1; - } - } while(false); - } while(false); - - return result_160041[0]; - -} - -function raw_write_stack_trace_180059() { - var result_180061 = null; - - if (!((framePtr == null))) { - result_180061 = nimCopy(null, (makeNimstrLit("Traceback (most recent call last)\x0A") || []).concat(aux_write_stack_trace_160038(framePtr) || []), NTI112); - } - else { - result_180061 = nimCopy(null, makeNimstrLit("No stack traceback available\x0A"), NTI112); - } - - - return result_180061; - -} - -function new_seq_225128(len_225131) { - var result_225133 = null; - - var F={procname:"newSeq.newSeq",prev:framePtr,filename:"system.nim",line:0}; - framePtr = F; - F.line = 626; - result_225133 = new Array(len_225131); for (var i=0;i", "text/html"); - - stuff_9835556 = doc.documentElement; - - F.line = 286; - db_9835528[0] = nimCopy(null, stuff_9835556.getElementsByClassName("reference"), NTI624105); - F.line = 287; - contents_9835530[0] = nimCopy(null, [], NTI9835571); - L1: do { - F.line = 288; - var ahref_9845214 = null; - F.line = 184; - var i_9855040 = 0; - F.line = 185; - var l_9855041 = (db_9835528[0] != null ? db_9835528[0].length : 0); - L2: do { - F.line = 186; - L3: while (true) { - if (!(i_9855040 < l_9855041)) break L3; - F.line = 288; - ahref_9845214 = db_9835528[0][chckIndx(i_9855040, 0, (db_9835528[0] != null ? db_9835528[0].length : 0)+0-1)-0]; - F.line = 289; - if (contents_9835530[0] != null) { contents_9835530[0].push(ahref_9845214.getAttribute("data-doc-search-tag")); } else { contents_9835530[0] = [ahref_9845214.getAttribute("data-doc-search-tag")]; }; - F.line = 188; - i_9855040 = addInt(i_9855040, 1); - if (!(((db_9835528[0] != null ? db_9835528[0].length : 0) == l_9855041))) { - F.line = 189; - failed_assert_impl_102680(makeNimstrLit("/home/genotrance/.choosenim/toolchains/nim-#devel/lib/system/iterators.nim(189, 11) `len(a) == L` the length of the seq changed while iterating over it")); - } - - } - } while(false); - } while(false); - } - - F.line = 290; - var ul_9845225 = tree_9756020(makeNimstrLit("UL"), []); - F.line = 291; - result_9835550 = tree_9756020(makeNimstrLit("DIV"), []); - F.line = 292; - set_class_9756118(result_9835550, makeNimstrLit("search_results")); - F.line = 293; - var matches_9845246 = []; - L4: do { - F.line = 294; - var i_9845259 = 0; - F.line = 104; - var colontmp__9855047 = 0; - F.line = 294; - colontmp__9855047 = (db_9835528[0] != null ? db_9835528[0].length : 0); - F.line = 106; - var i_9855048 = 0; - L5: do { - F.line = 107; - L6: while (true) { - if (!(i_9855048 < colontmp__9855047)) break L6; - F.line = 294; - i_9845259 = i_9855048; - L7: do { - F.line = 295; - var c_9845260 = contents_9835530[0][chckIndx(i_9845259, 0, (contents_9835530[0] != null ? contents_9835530[0].length : 0)+0-1)-0]; - if (((c_9845260 == "Examples") || (c_9845260 == "PEG construction"))) { - F.line = 300; - break L7; - } - - F.line = 301; - var colontmp__9855055 = fuzzy_match_9681054(value_9835549, c_9845260); - F.line = 301; - var score_9845261 = colontmp__9855055["Field0"]; - F.line = 301; - var matched_9845262 = colontmp__9855055["Field1"]; - if (matched_9845262) { - F.line = 303; - if (matches_9845246 != null) { matches_9845246.push({Field0: db_9835528[0][chckIndx(i_9845259, 0, (db_9835528[0] != null ? db_9835528[0].length : 0)+0-1)-0], Field1: score_9845261}); } else { matches_9845246 = [{Field0: db_9835528[0][chckIndx(i_9845259, 0, (db_9835528[0] != null ? db_9835528[0].length : 0)+0-1)-0], Field1: score_9845261}]; }; - } - - } while(false); - F.line = 109; - i_9855048 = addInt(i_9855048, 1); - } - } while(false); - } while(false); - F.line = 305; - matches_9845246.sort(HEX3Aanonymous_9845273); - L8: do { - F.line = 306; - var i_9845326 = 0; - F.line = 104; - var colontmp__9855052 = 0; - F.line = 306; - colontmp__9855052 = nimMin((matches_9845246 != null ? matches_9845246.length : 0), 19); - F.line = 106; - var i_9855053 = 0; - L9: do { - F.line = 107; - L10: while (true) { - if (!(i_9855053 < colontmp__9855052)) break L10; - F.line = 306; - i_9845326 = i_9855053; - F.line = 307; - matches_9845246[chckIndx(i_9845326, 0, (matches_9845246 != null ? matches_9845246.length : 0)+0-1)-0]["Field0"].innerHTML = matches_9845246[chckIndx(i_9845326, 0, (matches_9845246 != null ? matches_9845246.length : 0)+0-1)-0]["Field0"].getAttribute("data-doc-search-tag"); - F.line = 308; - add_9756100(ul_9845225, tree_9756020(makeNimstrLit("LI"), [matches_9845246[chckIndx(i_9845326, 0, (matches_9845246 != null ? matches_9845246.length : 0)+0-1)-0]["Field0"]])); - F.line = 109; - i_9855053 = addInt(i_9855053, 1); - } - } while(false); - } while(false); - if ((ul_9845225.childNodes.length == 0)) { - F.line = 310; - add_9756100(result_9835550, tree_9756020(makeNimstrLit("B"), [text_9756135(makeNimstrLit("no search results"))])); - } - else { - F.line = 312; - add_9756100(result_9835550, tree_9756020(makeNimstrLit("B"), [text_9756135(makeNimstrLit("search results"))])); - F.line = 313; - add_9756100(result_9835550, ul_9845225); - } - - framePtr = F.prev; - - return result_9835550; - -} - -function search() { - - function wrapper_9845435() { - var F={procname:"search.wrapper",prev:framePtr,filename:"dochack.nim",line:0}; - framePtr = F; - F.line = 320; - var elem_9845437 = document.getElementById("searchInput"); - F.line = 321; - var value_9845438 = elem_9845437.value; - if (!(((value_9845438 != null ? value_9845438.length : 0) == 0))) { - if ((oldtoc_9845403[0] == null)) { - F.line = 324; - oldtoc_9845403[0] = document.getElementById("tocRoot"); - } - - F.line = 325; - var results_9850006 = dosearch_9835547(value_9845438); - F.line = 326; - replace_by_id_9756172("tocRoot", results_9850006); - } - else { - if (!((oldtoc_9845403[0] == null))) { - F.line = 328; - replace_by_id_9756172("tocRoot", oldtoc_9845403[0]); - } - } - framePtr = F.prev; - - - } - - var F={procname:"dochack.search",prev:framePtr,filename:"dochack.nim",line:0}; - framePtr = F; - if (!((timer_9845404[0] == null))) { - F.line = 330; - clearTimeout(timer_9845404[0]); - } - - F.line = 331; - timer_9845404[0] = setTimeout(wrapper_9845435, 400); - framePtr = F.prev; - - -} diff --git a/docs.html b/docs.html deleted file mode 100644 index c5da9ef..0000000 --- a/docs.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - - - - - - - - - - - - - -docs - - - - - - - - -
-
-

docs

-
-
-
- -     Dark Mode -
- -
- Search: -
-
- Group by: - -
- - -
-
-
- -

-
-

Procs

-
- -
proc buildDocs(files: openArray[string]; path: string;
-              baseDir = getProjectPath() & "/"; defines: openArray[string] = @[]) {...}{.
-    raises: [OSError, ValueError], tags: [ReadIOEffect].}
-
- -

Generate docs for all specified nim files to the specified path

-

baseDir is the project path by default and files and path are relative to that directory. Set to "" if using absolute paths.

-

defines is a list of -d:xxx define flags (the xxx part) that should be passed to nim doc so that getHeader() is invoked correctly.

-

Use the --publish flag with nimble to publish docs contained in path to Github in the gh-pages branch. This requires the ghp-import package for Python: pip install ghp-import

-

WARNING: --publish will destroy any existing content in this branch.

-

NOTE: buildDocs() only works correctly on Windows with Nim 1.0+ since https://github.com/nim-lang/Nim/pull/11814 is required.

- - -
- -
- -
-
- -
-
- -
- Made with Nim. Generated: 2020-03-24 20:55:37 UTC -
-
-
-
- - - diff --git a/docs.idx b/docs.idx deleted file mode 100644 index e494dcb..0000000 --- a/docs.idx +++ /dev/null @@ -1 +0,0 @@ -buildDocs docs.html#buildDocs,openArray[string],string,openArray[string] docs: buildDocs(files: openArray[string]; path: string; baseDir = getProjectPath() & "/";\n defines: openArray[string] = @[]) diff --git a/nimdoc.out.css b/nimdoc.out.css deleted file mode 100644 index 4ee73ea..0000000 --- a/nimdoc.out.css +++ /dev/null @@ -1,891 +0,0 @@ -/* -Stylesheet for use with Docutils/rst2html. - -See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to -customize this style sheet. - -Modified from Chad Skeeters' rst2html-style -https://bitbucket.org/cskeeters/rst2html-style/ - -Modified by Boyd Greenfield and narimiran -*/ - -:root { - --primary-background: #fff; - --secondary-background: ghostwhite; - --third-background: #e8e8e8; - --border: #dde; - --text: #222; - --anchor: #07b; - --anchor-focus: #607c9f; - --input-focus: #1fa0eb; - --strong: #3c3c3c; - --hint: #9A9A9A; - --nim-sprite-base64: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAN4AAAA9CAYAAADCt9ebAAAACXBIWXMAAAsTAAALEwEAmpwYAAAFFmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4gPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS42LWMxNDggNzkuMTY0MDM2LCAyMDE5LzA4LzEzLTAxOjA2OjU3ICAgICAgICAiPiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyIgeG1sbnM6cGhvdG9zaG9wPSJodHRwOi8vbnMuYWRvYmUuY29tL3Bob3Rvc2hvcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RFdnQ9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZUV2ZW50IyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgMjEuMCAoV2luZG93cykiIHhtcDpDcmVhdGVEYXRlPSIyMDE5LTEyLTAzVDAxOjAzOjQ4KzAxOjAwIiB4bXA6TW9kaWZ5RGF0ZT0iMjAxOS0xMi0wM1QwMjoyODo0MSswMTowMCIgeG1wOk1ldGFkYXRhRGF0ZT0iMjAxOS0xMi0wM1QwMjoyODo0MSswMTowMCIgZGM6Zm9ybWF0PSJpbWFnZS9wbmciIHBob3Rvc2hvcDpDb2xvck1vZGU9IjMiIHBob3Rvc2hvcDpJQ0NQcm9maWxlPSJzUkdCIElFQzYxOTY2LTIuMSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDozMzM0ZjAxYS0yMDExLWE1NGQtOTVjNy1iOTgxMDFlMDFhMmEiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MzMzNGYwMWEtMjAxMS1hNTRkLTk1YzctYjk4MTAxZTAxYTJhIiB4bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ9InhtcC5kaWQ6MzMzNGYwMWEtMjAxMS1hNTRkLTk1YzctYjk4MTAxZTAxYTJhIj4gPHhtcE1NOkhpc3Rvcnk+IDxyZGY6U2VxPiA8cmRmOmxpIHN0RXZ0OmFjdGlvbj0iY3JlYXRlZCIgc3RFdnQ6aW5zdGFuY2VJRD0ieG1wLmlpZDozMzM0ZjAxYS0yMDExLWE1NGQtOTVjNy1iOTgxMDFlMDFhMmEiIHN0RXZ0OndoZW49IjIwMTktMTItMDNUMDE6MDM6NDgrMDE6MDAiIHN0RXZ0OnNvZnR3YXJlQWdlbnQ9IkFkb2JlIFBob3Rvc2hvcCAyMS4wIChXaW5kb3dzKSIvPiA8L3JkZjpTZXE+IDwveG1wTU06SGlzdG9yeT4gPC9yZGY6RGVzY3JpcHRpb24+IDwvcmRmOlJERj4gPC94OnhtcG1ldGE+IDw/eHBhY2tldCBlbmQ9InIiPz4PsixkAAAJ5klEQVR4nO2dfbBUZR3HP3vvxVD0zo0ACXxBuQMoQjJ1DfMl0NIhNcuSZqQhfGt6UWtK06xJexkrmywVRTQlHCIdtclC0zBJvYIvvEUgZpc3XyC7RVbKlQu1/fHdbc+uu2fPOfs85+y55/nMnBl2z+5zfnc5v/M8z+8119XVRYroAG4HfgvMT1YUR4MMAa4HLkhakCRoSVqAELwLeBY4C7gF+D6QS1QiR1ROAJ4Dzk9akKQwoXhtwL4GxvHjU8AKoNPz3leAu4HBFq+bAyZZHD9rDAK+BywDDklYlkQxoXhfAtYAEw2MVckQYBHwU6or99nA08BBFq49GngUeBIYaWH8rNEJdAOXA60Jy5I4jSreSOBKYDzwBPCJhiUqcSjwe2BWnc9NLnxuvMFrnwqsAqYBBwBfNzh2FpmNfs9jkhakWcg1aFxZiH5UL3cDnwf+Xue7BwFjgFHAOwuv24tyob3cO0LIshP4EbCn8Pq/wKvA9sLxMvCvOmPsA1yDZnHv/nEv2mM+F0IeR4m8z7lM7tMbUbzj0CxX7YfbAXwaWFJ4PRrNIu9FS9KJyEIZN68CG4DnkRJtLBw7gHHAYuDdNb77EDAjBhkHIk7xKoiqeK3IwjilzuceQJvoZjdQ/AMZaeoZiWYgBXSEwyleBW0Rv3cR9ZUO4LSI48fN2wN+bi5wJNBvUZaBSCaVy48oxpVhwDdMC5ISxpJRh6/DLGEUrxXt29YBQ+2IkwquR76ofZIWxJFegireNLSnm48skFmmDfmiVgJHJyuKI620ADOpbWEcDPwYOZKD7OmyxCTkXL+wzueOiEEWR8poQb60V4A7kLm/yFjgKeALuM1xLfYDbkX+zEGe98cAX0Oui6viF8vR7OS6urragW2UZr21wK+Aiwlu7XPoN3sYOAd4H6WH1SnA0qSEcjQnRT/e1bgnsw16kGPez4/lyCBF48oNwL+TFGSAsgCndI4qFBVvJ0owdZhjL3CnxfHzBo8+YBMyol0CHBijrKbHS/LoA7Yio9sPgJNr/QHekLGR6MffL+KP4SjnHmQxtoXNmbQP+CHyV75hYDzTIWNpWkU8iR5mq71vVsZqXgtcFqNQ/wG2IOtfD8oi6AX+Ujj+isKz8sBrnu+1okyGdmD/wnEgcDClTIdRyJRvI1cvCMciq7At4rj5eoCPAusbHCfLigda/VyKgi+AtyreMGAzykGzQQ/wO+BxSlkCuy1dq8hw5OieUjimYT+x9bHCdWwS1823Ez1EXmhgjKwrXpHzkduuanbCtzGX+NkPPAj8GincNkPjNkIO5dadUjiOB95m+BonopQpm8R58/0JJbHWy2eshVM8sRvdbyurKV4Hmoka2WA/iwwLP6d+QmzSdKC92GzK/W9R+Q3woQbHCELcN991wJcjftcpXolngKm18vFmoVonYcgDv0Qz5pqGREuOTuA8lPYUZbndh0LJNpkUqgZx33xvomim7RG+6xSvnOm1gqQXoyiMoKxFs8VZpFfpQHvQK4HDUPnAsBa9bxGP0tUjF+IYCkxFew+/G3owdq20pgjzt3uPRscs/o43IaOhH2f4ZaAPRyZQP6vgbuCbyGext87F0sgIZFI/N8BnlwBnolovcWAjq/uzwM0+55cBJ0UYN84ZL+rfbnLMM4FfUDv7Z1XlCe8FetETbleNL7+CZrnvMjCVDuTOOA84Hf+96ga0PC8qXY50FQsuMg+41+d8p885R4n7gdt8zo+qvDkmUF4fZQXwEbS+99KDMhlWkw0eALqQglXyDDCdcovf+4lv5jPNXJ9zWc/FDMMdPudGVCreRlTWwVtWbynwYVQQCFSp61Q042WJLUjB1nneuw8tvXo97x1Lugvg+j1Mo9boySLVHtJFWqsthx5GlbSGeN5bigrHdqPl52Zj4qWLXvTQWY4KOX2ccgPMBLRcuy9+0YzhguXN4GuYq2Zc2R/NZg+hfYt3/9ZCepdQthmB4vIWIYOTbWyWzGt2Y0izG1fqjlltxnsdpbPMRMmd3lqTTumqMw7FZY5G5mSHw5dalreiRWYGWjbZ7gYUlFa0xOtIWA4vk1E6zWEoI+FvyYrjSAO1FG8DCmQGKd+DJFsGogWVVFiP/GWbga9Svg9NgtPQvnd04fUNCcriSBF+vqZ5nn9PQ+Xs4q401oI6EP0R+BkyXoAeAtcgBfwidnvkVaMVFTO6n1JoWTfqiONw1MVP8e6l3GVwOPJZXW5VItGGiuduAu5CZdOrMQJ1CHqpIFccS+LxaD/3Hcr7vF0Xw7UdAwQ/xduLGkJ6aUMhVAuwU006B3wM+ZLmozJ5QRhWkGs9yjKw1fhwDsq8eE/F+y+i1CeHIxD1wppupXrA5xyUOjQHMzU3cyjTeS2aaaN2Fzoc1bhch3xspuqBTkDulQVUz1q4mYEbNuewQD3FexGFS1VjOLoRHwOOinj9HAooXY2CSidHHKeSI5GFcRWNdSxqR7VH1iHHeTV24R+X53C8hSCBvPPqnD8B+AOygn6OYAm0ORSGthLl8B0d4DtRmIKsoMsJF1U/Hi1dt6DusIN8PrsIlUdwOAITpDFlC6q3MTbgmHm011qGepOvQSXPipyOCujW6rxqk0dRWYsVFe8PRSn5JxWOoEvdfOGzfnF5tnCRK+bGi33MoB1hL0U5d1H5J5oVD6A5mp8sQS6KSWh5e0jEcR4BPmhKqJA4xTM3XuxjBlW8DuRacDU3y0myNbNTPHPjxT5m0GTN15A/zVFiI+HKYzgc/ydMlrRfgmQWuYn0F91xJEQYxVuDnMcOrQAWJi2EI72ErQviwqLEQpQ+5XBEIqzi3YWLwF+BMiMcjshEqYR1Gdk1KmxBsaR9SQviSDdRFK8fxVU+YliWZmcbcq7vSFoQR/qJWvuxD0WgLDYoSzPzAqowtjVhORwDhEaKru4GPoliGgcyy4Hj0DLT4TBCo9WO88jQ8Bns97lLghvRTOfqqDiMYqrM+HyUYdBtaLykeRmlK12C9rQOh1FM1vd/HqUIzaT5e+LVoh/VxByHShs6HFaw0VjjHhTxP5d0LT+fRnu5q3HuAodlbHW02Q5cDByM+sw1642cRylCx6PeZiuTFScUFxK+f19QovaRS+t4tsasxhvABbZbSfUCV6CM7qtQl6Fm4E1U22UqcAYqvZ42fgJMxH6vdYc5nkBlSW6Pq4fbS6hb6jg0u9yGug7FyS5U1+UcVBbwbFSuMM1sQ1bXK4A9CcviqM0e9H80HdUxCpwIa4McygA/GfgAcCJqmGKKXUixupEv7nHsLc2agWNQ0d9OzC+PHNHIo1XeLCoe8kkqXiUtwKFoWXoEKqk3BpWLaC8cXsV8HT1J+tFTZKvn+DMqFZi1knvtyKg1O2lBHADcCVxEedNSAP4HJcsr0NNWHVUAAAAASUVORK5CYII="); - - --keyword: #5e8f60; - --identifier: #222; - --comment: #484a86; - --operator: #155da4; - --punctuation: black; - --other: black; - --escapeSequence: #c4891b; - --number: #252dbe; - --literal: #a4255b; - --raw-data: #a4255b; -} - -[data-theme="dark"] { - --primary-background: #171921; - --secondary-background: #1e202a; - --third-background: #2b2e3b; - --border: #0e1014; - --text: #fff; - --anchor: #8be9fd; - --anchor-focus: #8be9fd; - --input-focus: #8be9fd; - --strong: #bd93f9; - --hint: #7A7C85; - --nim-sprite-base64: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAARMAAABMCAYAAABOBlMuAAAACXBIWXMAAAsTAAALEwEAmpwYAAAFFmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4gPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS42LWMxNDggNzkuMTY0MDM2LCAyMDE5LzA4LzEzLTAxOjA2OjU3ICAgICAgICAiPiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyIgeG1sbnM6cGhvdG9zaG9wPSJodHRwOi8vbnMuYWRvYmUuY29tL3Bob3Rvc2hvcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RFdnQ9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZUV2ZW50IyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgMjEuMCAoV2luZG93cykiIHhtcDpDcmVhdGVEYXRlPSIyMDE5LTEyLTAzVDAxOjE4OjIyKzAxOjAwIiB4bXA6TW9kaWZ5RGF0ZT0iMjAxOS0xMi0wM1QwMToyMDoxMCswMTowMCIgeG1wOk1ldGFkYXRhRGF0ZT0iMjAxOS0xMi0wM1QwMToyMDoxMCswMTowMCIgZGM6Zm9ybWF0PSJpbWFnZS9wbmciIHBob3Rvc2hvcDpDb2xvck1vZGU9IjMiIHBob3Rvc2hvcDpJQ0NQcm9maWxlPSJzUkdCIElFQzYxOTY2LTIuMSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDplZGViMzU3MC1iNmZjLWQyNDQtYTExZi0yMjc5YmY4NDNhYTAiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6ZWRlYjM1NzAtYjZmYy1kMjQ0LWExMWYtMjI3OWJmODQzYWEwIiB4bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ9InhtcC5kaWQ6ZWRlYjM1NzAtYjZmYy1kMjQ0LWExMWYtMjI3OWJmODQzYWEwIj4gPHhtcE1NOkhpc3Rvcnk+IDxyZGY6U2VxPiA8cmRmOmxpIHN0RXZ0OmFjdGlvbj0iY3JlYXRlZCIgc3RFdnQ6aW5zdGFuY2VJRD0ieG1wLmlpZDplZGViMzU3MC1iNmZjLWQyNDQtYTExZi0yMjc5YmY4NDNhYTAiIHN0RXZ0OndoZW49IjIwMTktMTItMDNUMDE6MTg6MjIrMDE6MDAiIHN0RXZ0OnNvZnR3YXJlQWdlbnQ9IkFkb2JlIFBob3Rvc2hvcCAyMS4wIChXaW5kb3dzKSIvPiA8L3JkZjpTZXE+IDwveG1wTU06SGlzdG9yeT4gPC9yZGY6RGVzY3JpcHRpb24+IDwvcmRmOlJERj4gPC94OnhtcG1ldGE+IDw/eHBhY2tldCBlbmQ9InIiPz4JZNR8AAAfG0lEQVR4nO2deViTZ7r/7yxkJaxJ2MK+GCBAMCwS1kgUFQSKK4XWWqsz1jpjp3b0tDP1V+eqU391fqfT/mpPPd20drTFDS0KFEVWJSGAEgLIZpAICBJACIRs549Rj1WILAkBfD/XlevySp68z/0S3+/7vPdzLyidTgcLkU2bd+z39/f/q1gshsrKSoJELFCa2iaEuU9K6kb+8uXxv54/fzE8L/eswNT2zCfQpjbAGKS8lPFKSEjIXiaTCSEhIeDj4xNnapsQ5j6rktZGp6UlfxIdzQVzCplmanvmG1hTG2BIAtlc26CgoDfT0tL2e3l5AQCAjY0NkMnk/a9s2k6rrKw8UV8n1JjYTIQ5RlAw14KzmL3xze1vfJyUuMJaq9UCFovFm9qu+YbBxcSPFUYkk8l2Q0NDsvo6ocrQx5+I8Ih4bz6f/0l8fHyKlZXV4/dRKBQwmcwwMpn8A4FAoPgHhH9bV1sxa488wZxoaycnJ/a9e/duCa5fkc3WvAiTI4Ib77p+XdqHG9anbfLy8gAAgLGxMdBpF+bjvzExqJj4scKI0dHRnwQHB++orq7+AgDeMuTxJ2Jl4rqU9PT0EwEBAUQCgTDuGAaDAampqYepVKpHUHDk325Ulw0a266YuFW+Gzdu/MDPz29jfn7+XgA4aOw5ESZP6kvpCXv3vnM8NiaSamVl+fj9BepGNDoGFRN7e/slcXFxO1xcXMDJyWnH7j//H/fi4uJdgutXmgw5z5O8smn7X9euXbvf29sbMBjMhONQKBRYWVlBbGzsbjMzM3JoOG+/sKKwy1h2rd/4elpGRsYuLy+vaDweD2w2Oy1h5ZrCvEunEaeeiVnMiabyl/F2/+X9P+8JDPQHHA5napMWBAYTk6DgSNuEhIS9DAYDAP7tq1i6dOkqOp3OWbNu0wens44emeoxA9lcWwKBYEMkEm2JRKIdHo+3QKFQWJ1Op8ZgMER3d/dVq1evTnFycpr0MSkUCsTExGzH4/Gk1LTME/39/TI0Go1FoVCg1WrVY2NjipGRkcGRkRH5dPwrEZHLXMPCwjJSUlIy3dzcfB+97+rqGhYSEpIOAIiYmBguN3zL77dt3uPh4W5qUxYUBhMTb2/vjeHh4cvR6P/dILK0tITIyEg7BweHr363/Z3Ampqaf1Zcu/zMKiVsyVJvMplsRyKR7IhEor2FhYUbhUJhJCYm2pFIJB6JRAIymQx4PB7QaDRoNBowMzMDJycnwOOn7icjEokQGxu7icFgbLp///7jFY1WqwWlUgkjIyOgUCgO7Ni5Rz48PCwfHh7uGRkZeaBQKOSjo6ODCoVCXlNVKn/6uCsT13FXrVr1emho6BYKhfLMnP7+/omrU9LPX8g+UThloxEMxqJFXjxESAyPQcSEExrLWLNmzW57e/txP/fw8ABHR8cdDAaDt3xF2ru9vb03sVgs0cbGxs/FxWVZUlISj0aj+dna2oKtrS1M5PcwJCgUCry8vODRrs84vPfoH6OjoyCXy6Gvr+/R6+CWrX9s7evrk/b19bWr1Wqli4sLZ8OGDe95eXmxUSjUuAd0cHDwjoqK2sYKXFIhvnldYYTTQpgU4/8+jyASCYDGoCd+ZkYYF8OICYezl8PhuOkbQyAQIDo62s/NzS2np6cHbGxsgEajAYFAAAwGA1gsFia6CE0NgUAABwcHsLe3B61WC2q1eo9WqwWNRgNKpRLUajUQiUSgUCh6zwGHwwGTydzo5+eXBQBnZu8MEJ5keHhYPqyYWMtHR0ZBpVIhYj9FUDONgOUvT12+du3avMDAQJjssdRqNWCxCyrEZdLodDoQi8Ulx44de628NL/V1Pa8iERE8l2dHB2CJvpcq9Nqbt1qKURWj1Njxld0ZGTkAW9v70kLCQC8sEIC8O/HKx8fn2gmk8kHgCk7pRFmzrWyAikASE1tx0Jj2uH0EZHL/N7YtuvT4OBgzmz4OBYSeDweIiMjt2S++vtMP1YYEmmJsCCY8mNOIJtr6+zsHBcZGXmIw+G4mZubG8m0hU9HRwcUFxe/KxQKTyDRsQjznSmJCS9+dVRERMTfQ0NDo2xtbfUGiSFMjtHRUaitrc3Jzc09kHvxVLmp7UFAmC6oZQkvrZLL5RJhReHtiQb5scKIXC7371FRUX90dnYGIpE4JR8Jgn40Gg20t7fXFxYWfnr9+vWjz8sdYi+Osh4vzgUBwZSgtu94V+fs7Hx7YGCgra6u7khLS0u2RCwYeTQgKmYFh8fj/f/g4OAldnZ2prR1wdPd3Q1CofBQSUnJkdLi3N8E93FCY6k+Pj48FxcXjlar1ZSWlh65VvYr4kREmDNg79+/D3FxcW5OTk5uXl5evNbW1tL0jK3ZXV1d1ykUintycvInoaGhdkj+gvGxs7MDPp+/m0AgWMQvS/lyeHhYTqPRPJycnIJSU1NZ3t7eW2g0Gly/fv2oWq1Gij0hzClQ/gHhpLS0tEM8Hm/7I8Ho7++HlpYWsLa2Bg8PDxOb+OKhUCigqakJ7t+/D25ubuDu7g4oFAp0Oh08ePAAvv7666TTWUdzTG0nAsKTYMU3ryuSU18+4+bmFrZo0SIOAICVlRUsXrx4zkakLnRIJBI8CgJ8MtdJp9NBZ2enqL29XWRC8xAQxgUNAHD+3L8KGhoaCp78ABES04JCoX4jJAAAAwMDUFtbe96YpRMQEKbL41DU5ubmko6Ojj2PSgggzD36+/vrb9y4cX425zzw93/8EBjon2is44+NjSkePBjqGRwc7G5v7xBV19w8U5B/3qgrr9+/uWtXUuKKD/TZ9MXh/066/OuFmunO8dGBQ98HBbGSp/t9U6LRaDXK0dHBoeFhuVzeL22/0yFqamopufjLqRJ933ssJi0tLSXV1dWHGAzGbuObOzs8ubqa71vZKpUKOjo6blwpOF8zm/Mu5cVkLlkSaswprAHAaVihgK7O7oSGxltvfXLon3nXK4RHT2cdN4pfKDCAlZyUuMJan02nTmczAaBmunPw4qI3cbnh0/36XICq0+lgcPABp7OrK629vUP5z8++LLh2XXD05L++yxrvC4/F5EZ12WBS8saLS5Ys2U2lUufUY45SqQSlUgkqlQrUavXj19jYGGg0GtBoNKDT6UCn05VotVq1TqfToFAojFar1eh0Og0Wi8XhcDgeGo1+/PhgZmYGOBwOsFgsmJmZ/eY1F+nt7YXa2trs2Z73wdCQBgCMHp1IJpHA09MdPD3dLRIS+OtKisvWvbP7vf2lZdePVFwzbHTwyMiI3hidkZFRUKvUYzOZ48HQkBIA5nWqBAqFAktLC7C0tADmIh88Pz4uMSyUk7hn776DV4tKPn/6d/lNxp1MJqsRCASf8vn8XdMpOjRTVCoVjI2NgUqlAq1WCyMjI9DX1wf379+Hvr6+/Q8ePOgdGRmRKxSKx0WLFAqFXKlUKnQ6nUar1arHq47mxwrD4/F4Eg6HI2GxWDwej7cgkUjWFAqFam5uTjU3N6eRyeQPLSwswNraGqysrIBAIDwWFywW+zja11Qi29LSclIikeSZZPJZBovBAI8XA8HBQR9kZZ3lR8cmvFZSlGe00p8IkwONRkNERBj4+i7a4+XpHv307/IbMakWlciXJbx0nMPh7Jqo0JGh0el0MDo6Cl1dXSCVSkEmk7177969W319fe1DQ0M9KpVKoVarlWq1WjndNhUPG3ApAWDcOxLTLwSDwWAOotFoDBaLxRMIBAsrKysne3t7Xzqd7k2n0/c4OzsDlUoFHA4364IyMDAATU1NxdWikhcq6tXKyhJezljPJZKI2eERS5cZeoWCMD2srCwhPX0tVzk2djiCG//GtfLLUoBxShB0dHTU3Lx580sLC4vtJBLJKMZoNBqQSqUglUqPdnR01PT09DT19/fLHjx40DM0NNQ72933GiSVGgB4JFQK+LfoSAGgnL04yppEIh2xtLS0t7GxcaFSqR7Ozs4fMRgMcHR0nJX8pJs3b54Ui8UXjT7RHIRMIkFK8irfwcEHPwQELUmqvYHUGJkLmJubw8YNa/i9vfffY/px3myQiDTPiEl9nVDDX576jaenZ7SnpyfLUJNrNBqQyWRw+/bt4x0dHTdkMlltV1dXw/XygjkdEv4wB0YOAK0AUM70C8HQ6fSzdDrdm0qlejg6OrLc3Ny2MBiMadWjfR4PHjyAmzdvZs/1v5MxoVAokJK8iicWS95k+nH+s0EiQhqpzQGoVFtYk5a87ba0XQAA34xbpagg/5zoT7s/OGNnZ8eaaYkBuVwOnZ2d5VKpVNTS0lLS2NhYWFVZ3Dujg5qQh6uY+ocvCAiKIPn4+Jz19PSMdnV15VCpVL6Dg4NBViw6nQ5EItHRpqamqzM+2DzHzo4O69amftLQeKsAZrDLgmBY/PyYsCIhfs+SiKUFE5Y8EwqFx11cXDihoaFTjjFAoVAwPDwMHR0dourq6jNCofDHhZqUVnvjmgIAcgAgJyg40mLRokX8kJCQjT4+PussLS1n1JPl7t27UFxcfHguB6mNjY2B7G4naNRTWyygUCjAYDGAx+PB0sICSCSi3vFYLBbCwjjA8vddBQtATKb7d3saBwc7IJPJBpsHjUGDGRYLJBIJLK0sAfucmyIGg4FFi3y8AwNZtycUk5KiS02vvf7WWQaDkejg4DApQwAeh3xDaWnpPoFAcPxFqnP6sEvgGf+A8Bx3d/cvIyIiNi1evHjT8wpNj8fAwACUlZW9P9dD5+/ckcFbf9gd2dcnn9LNAovF4inmZHtXNxdOdBR3+/JlS33pdP29wolEInA4weuiYxOy5vvuTkeHDHb+8c8xvb33Z3R9/N+Df+uIjYk02DwkEsna2trS1d/fNyGeF7uTyw1/7g3R3t4O2OxA/TVghULhcQqFQk1JSfmYSNR/5wD4d6EfgUBwvLS09IhUKhW9qAV5H9YjKQwJi6uvrKw8ERoamhkSEpKp7w7yJEqlEiQSyZmysrJv53qjdaVSCZdyTk+3qFMrAJRHRPLPN95qeifj5fU7mYt8JhyMRqMhMJDFdnF25gDAvBYTpXIMWlpay2fq/8m5mDcIABYGnEcGAGI/VlhBZWX1yZdSkz55OX0dV5+7w9bGGvz8mPrFpK62QskJjf2GTqd7x8bGbpnID4BCoUAmk0lLSkqOiESik2UleS/MakQflYKrXQDQxY1a3tTe3i6KiIjY5OXlxX7e9+rr6wsuXbr0t4ffn9OgMWjghMZQRcLp+8GulRVI/QPC37Wxtnal0ajJtjY2E451ZjiBra31vE9lR2PQQKFQaAAwo98Yi8Xq9fpPd56HO6rlvKWJv/PwcK+JilyCmajWMw6HAzs7+rMFpQOCIn6zHywSFvXm5eUdFAqFZ9Rq9bgHa2trq79w4cK+zz49cAARkmcpL81v/a/Dhz49d+7c3qqqqjyVSjXuOJ1OBxKJpDw3N/fA5V+zax6978cKw/sHhM/raMrnUVdboSy4fPWQSFSjd5yFBQWIRNKEd2IEw1J4JUd88WL+R51d3XrHWVDMnxUTa2tr1zXrNiUGsrmPf7DS4tymCxcu7Kuurs55+kKQSqVN586d23vs+8NHDXUCC5Wzp3/Iy8rKeruysvLM2Nhvo7VVKhXU1tYWnj17du/T7UOdnZ2D7OzsfGGB09raVi4S1RzXl0eFw+EAj8chYjKLVFffyOrq1C8mJBLpWTFRKBRyDofzC4vFWvXk+1ev/CLOzs7eKxAIslQqFeh0Oujp6enKzs7em/XTd7OayTqfKb56sT4rK+sPAoHg5KO/o0KhAKFQmHXy5MkdF3/5+TeZmctXpIXZ29v7zqVcKWNRX1epuXu3U/y8pEw0GmndOZt0dnXVDw0P6/W5oNHoZ30mQ0NDPb29vfvj4+Pf3rR5B/7od188XnEUXr4gDgmL+0NfX5/U19d3d3l5+YGfTnyDtLmcIhXXLsu4UcvfR6PRGGtra9eysrIjYrE45+kt4Fheou/69es/unnz5vm7d+/Wmsre2WRkZGTQ1DYg/JYGiUiTm1ugBAC9IfHPiEmDpFITE7fqJI/H27lmzZpDq5LWtz55t6wUXO3ihMYerK+vz2tpaUFaM0yT8tL81ujYle+TSCTrvEunBU9/voTLd92wYcPHVCqV39XVdXCu7+oYCp1O90Kc50Jk3I5+xVcv1jc3N5d4enpSMzIyvkpK3sh78nORsKg3++yPBS/q1q+hKCm61DSekERGJ3ikp6d/ERsbm1xVVXWwtbX1hRFtFAqFPMLMUyZsDyoQCI7LZDKIiIjwzczM/GpV0vro2TTsRSUqZoX3+vXrP1u9enXi0NAQiESirIdRtggIc5oJ40zq6uryGhoa8ry8vBJCQ0O9USjU94mrN7yWc+EnvaXb5gJMvxCMp6cnl0Kh2Le1tZVXXLs8L1LXefGrWRkZGZ/x+XyeUqkEkUh0vqenZ14HZyG8OEwoJjdrygd37NxTEBkZmWBtbQ3BwcEeKBTq+/UbX3/355Pfzlmn66qk9dGbN29+k8PhbCSRSNDZ2Snb9ae/HCkpKTksEhbN2QTD5NSX+Vu3bj0cHBzsjcFg4O7du1BWVvbNwxB9BIQ5j94I2Fu3bhXW19cDl8sFLBYLHA7Hg0wmf/e77e84ffXlPz6fLSMnQ2paZkJ4eHjmtm3b+B4eHvZkMhlQKBTY29s72dvbfxgUFJT8x7ffP1NRUfHjXErnZ/qFYKKjo7dt3rz5g8DAQPtH/XHa2tpqGhsbC55/BASEuYFeMblz505NTU3NgfDw8PcwGAygUCjw9fW1IJPJn/1130Hv0tLSI4WXL4hny9inYS+Osvbz80tgMpn8jIwMPovFch2vpoiDgwM4ODhwfH19OYsWLeJv3/Hu+cbGxquzXZz5aZYlvMRJT0/fFhkZue3JZmfd3d0gEolOIr4ShPmEXjFpkFRqXlrzSnFnZ+d7Tk5OjzNfXVxcICMjY6ezszNnVdL6vU8HWhmbgKAIkrOzMyc1NTXz0YU4maAuOp0OK1as4EVFRfGEQqHg1dfePHzr1q2rs71S8WOF4f38/BLS09M/iIyM5DxdxLq5uVlcVVU1bgVwBIS5il4xAQCQyWRigUBwJikpKe3JVGQcDgdLly7l2tranti0ecf7IpEoy9hbxX6sMDydTvdevXr1ltjY2F3u7u6AxT73FJ7B3Nwc4uLiwthsdphQKCzZkL7l0/r6+oKbNeVG90+EhMXZL1++fFtycvKHrq6uz4igUqmE5ubmEiTHCWG+8dwrUXD9imz9xtd/jIuLS7N5KpsTjUZDUFCQE4PB+F4oFGYmJW888Mv5k4UTHGpGxC9LYaenp78VEhKyxdHRESgUyoyOh0KhwNraGuLi4qIDAgKi6+rqyjekb/mHMSN6N6RvSdu+ffseNpsdZm09ftuW+vp6EIvFSB9hhHnHpG7rUqm0orW1tdXS0tLj6TIEaDQaaDQaxMfH811dXTl/3Xfw+JUrVz411J01cfWG6IiIiC07d+5McHNzs7ewMGyOFw6HAwcHB6BSqVx3d/fwz7/4rkAgEBwXCoUnHpZonDGrU9J5MTEx27du3Zrm4uKC0beaqq6u/ry+vj7XEPMiIMwmkxKTimuXZe/u+fCkp6fnexPdUfF4PPj7+1szGIydLi4unF1/+kvenTt3RG1tbRXTqfma8lIG39/fP/HVV19NZrFYHpMpzjQTzMzMwNPTE+Pp6Zng6emZ4Ofnl5CesfV8bW1tznQe3/wDwvFeXl7Rvr6+Ca+88kpaUFCQh74GXzqdDrq7u6GpqankRQmdR1hYTNrhUFVVlcXj8d6ysrKy0OfstLS0hPj4eC6Xy+U2NzeDRCI5/sa2XeX37t1rGhwc7BoYGJBN1P+FFbiE5OzszGaxWImvvvrqpoCAAKfp+ERmCpPJBCaTmcnhcDJLS0u/TE59+YxUKhXoi/lg+oVgrKysGJaWlna2trYeaWlpXDabvTMgIGDSfp2KiorzbW1tL0zoPMLCYtJX6uVfs2u++PKowMPDgz+ZIslEIhECAgKAxWJlajSazJ6eHmhra4PW1tZvtmz9o6Czs7O+r6+vfWxsbFir1WosLCzsV6xYkcnj8d7z9vaelmPV0Hh5eYGnp+f2mJiY7UVFRZ/HL0v5tru7+5ZGo1FisVg8Docj4fF4CxsbG1c+nx/m7e39sYeHB7i4uIC5ufmU6r4ODQ1BZWXlifkSrYuA8DRTumIrKytPent78728vCb9HRQKBVgsFhwcHIBOpwObzd4yNja2RaVSwdDQEHR1dcHo6CjQaDRwdXWdsWPV0KBQKPDw8AA7O7udERERO2tra2FgYACoVCo4OTkBjUYDMpkMeDz+8WuqaLVaaGxsbL19+/YzSX8ICPOFqYrJidDQ0AwvLy/e80c/CwaDARKJBI86BdJoNHB3dwe1Wj0nViL6IJPJwGQywdnZGZRKJRAIBDBUx8OBgQEoLS39BtkORpjPTJg1PB61N64pmpqarvb39xvUiLkuJE9CJpPBxsbGYEICANDZ2SlHgtQQ5jtTEhMAgLq6ulyJRFJvDGNeREZGRkAikRSUFuci2cEI85opi0l+7hmBWCzOeV6dToTJcfv27cHr168jxbgR5j1TFhMAgObm5hKZDNl0MAQtLS3Xzpw6hkS8Isx7piUmUqlUIBAIJuyjgzA5Ojs7QSKRINGuCAuCaYmJsKKw68qVK59KJJIu5HFneiiVSigqKjouEolOmtoWBARDMC0xAQC4+MvPJadOnXq3ra1N8yL0dDEkOp0OSktLy/Pz8w8+3d4CAWG+Mm0xAQA4fuy/jl+8ePGju3fvGsqeBY9Wq4XKysrWU6dOvX31yi8mKyyFgGBoZiQmAAD/79D+fadPn96PCMrz0el0UFVV1frtt9+mj9fiAgFhPjNjMQEAyMvLO3Ds2LE/tLS0INmuerh27Vr9999//xoiJAgLEYOEntbVVigB4PNNm3cMpqSkfMRms50McdyFgkqlgqKiovJTp069nZ97BhEShAWJQePYj373xdF1GzbLFQrFx6Ghob766ne8KNy7dw+KiopO5ubmfmTK4tsICMbG4EkxWT99d35l4rre/v7+D0NCQvh0Ot3QU8wL1Go1SKVSTX5+/sH8/PyDSP8bhIWOUTLsLuVklQcFR65pbGzcvnLlyvfc3NwsCASCMaaac+h0OhgaGoLq6uqaCxcu/OV01tGcTw7uM7VZCAhGx2jpug/vxAd58atzoqKitq1cuXKnvb29saabE+h0Oqiurpbm5eUdrK6uPlspuDrvY0hmO4YIhUIBGq1/X2CmNqFQKL3/79HomZ/z82xEowyy9zFr80zGDqPn/hdeviBmL47ad+fOnRsRERGbQkNDo62srIw97azT2dkJxcXFx0tKSo7Mdh8hY4LD4TDPH2U4MFjMc6tLmZmZzaj+Aw6H0/t9PB4PGCxmRudNJBL0ngeZTAI0Gj3jv+1szfM88Hic8cUEAKCmqlQOAN/ELU2qkEgkySwWK3HRokVcBoMxG9MbDZ1OB83NzdDU1FRQW1t7XiAQHJ+ovu18pbr6Rg6L5ZtoM0EhcUPT0tJW8tWRb0vQqIkvgKqqmhnVfrl2TfANXo+gjKlUio4OWc1M5sjOzjnQUH8rbqLPu3t6moaGhmfc+3q25tGHUqmECoEIUKbIrVkcEkONiIh4jcvlvu7s7OxLo9GmVe7QVCgUCujq6oKGhoaCioqKo9XV1WeM3YDMVPDik1gpyas+XrVyeaKXl8czjyANjbcgI/MNmkg49Q4ECPOH3NyC4RUr+M8IcHt7B1y9WlKRl3/5kElKnD1sfXEoJCzueEBAQGJYWFgGk8nk2djYAIFAgLm4pTw6Ogqjo6Mgl8vhxo0b50tLS4/U19fnLvS2FIWXfxEDQNLmLW9ueW1TxtchHDaQyWRTm4VgYkZHR6G+vhF+/NfP+y5e+vVjiVgwZpKVydOwF0dZW1lZOTGZTD6bzU4LCAiIptPp8HTDL1MwOjoKLS0tUFdXd1IsFudIpdKKgYGB7tloJTrX4MUnsVJTEj9etzY10dHRAQAAGm81wcsZW5CVyQInL69gNCGBjwcAGBx8ANnncypOnTr3H9nn/reD55wovvrQpyIHAHFUzIocGo3mQaPRfBwdHVlubm7bXF1dgcFgABqNNvruglwuh7t374JMJoOOjo7P79y5I+ru7m7q7e1tXQi7MzOh8PIv4pCw2DdaWtte37Au7aPIyCWAxWABjUbPif9HCMbjURtKiaQBfvr5zH9evlJ0uLQ4r/nJMXNiZTIRrMAlJAcHB18HBweWo6Mjy8rKajeJRAJLS0uwtLQECwsLoFAogMfjAYvFgpmZ2XNXMyqVCoaHh2FoaAiGh4cfvwYGBqCvrw+6u7vfvnfvXlNvb29rT09Pq0QsUM7S6c4rNqS/lrZ5U+YPRBKR9M7u9xwqBUUvtNAudH766XSLE8PR49ixE78/8tVnX403Zk7fUR46NUUAIPIPCMdTKJTdNjY2QKPRgE6nA51OB1tbWyCRSIDD4YBAIAAejwcCgfDYUajVakGlUoFarQadTvfY79HX1wf9/f0gl8tBLpfDvXv3HvXw+dxQPYYXMj+d+P7Mmzv+5OHr6/OJWq1GBHeB09TcUiKuq/coKS3/eqIx/wPkiIXC3w6YjAAAAABJRU5ErkJggg=="); - - --keyword: #ff79c6; - --identifier: #f8f8f2; - --comment: #6272a4; - --operator: #ff79c6; - --punctuation: #f8f8f2; - --other: #f8f8f2; - --escapeSequence: #bd93f9; - --number: #bd93f9; - --literal: #f1fa8c; - --raw-data: #8be9fd; -} - -.theme-switch-wrapper { - display: flex; - align-items: center; - - em { - margin-left: 10px; - font-size: 1rem; - } -} -.theme-switch { - display: inline-block; - height: 22px; - position: relative; - width: 50px; -} - -.theme-switch input { - display: none; -} - -.slider { - background-color: #ccc; - bottom: 0; - cursor: pointer; - left: 0; - position: absolute; - right: 0; - top: 0; - transition: .4s; -} - -.slider:before { - background-color: #fff; - bottom: 4px; - content: ""; - height: 13px; - left: 4px; - position: absolute; - transition: .4s; - width: 13px; -} - -input:checked + .slider { - background-color: #66bb6a; -} - -input:checked + .slider:before { - transform: translateX(26px); -} - -.slider.round { - border-radius: 17px; -} - -.slider.round:before { - border-radius: 50%; -} - -html { - font-size: 100%; - -webkit-text-size-adjust: 100%; - -ms-text-size-adjust: 100%; } - -body { - font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif; - font-weight: 400; - font-size: 1.125em; - line-height: 1.5; - color: var(--text); - background-color: var(--primary-background); } - -/* Skeleton grid */ -.container { - position: relative; - width: 100%; - max-width: 1050px; - margin: 0 auto; - padding: 0; - box-sizing: border-box; } - -.column, -.columns { - width: 100%; - float: left; - box-sizing: border-box; - margin-left: 1%; -} - -.column:first-child, -.columns:first-child { - margin-left: 0; } - -.three.columns { - width: 19%; } - -.nine.columns { - width: 80.0%; } - -.twelve.columns { - width: 100%; - margin-left: 0; } - -@media screen and (max-width: 860px) { - .three.columns { - display: none; - } - .nine.columns { - width: 98.0%; - } - body { - font-size: 1em; - line-height: 1.35; - } -} - -cite { - font-style: italic !important; } - - -/* Nim search input */ -div#searchInputDiv { - margin-bottom: 1em; -} -input#searchInput { - width: 80%; -} - -/* - * Some custom formatting for input forms. - * This also fixes input form colors on Firefox with a dark system theme on Linux. - */ -input { - -moz-appearance: none; - background-color: var(--secondary-background); - color: var(--text); - border: 1px solid var(--border); - font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif; - font-size: 0.9em; - padding: 6px; -} - -input:focus { - border: 1px solid var(--input-focus); - box-shadow: 0 0 3px var(--input-focus); -} - -select { - -moz-appearance: none; - background-color: var(--secondary-background); - color: var(--text); - border: 1px solid var(--border); - font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif; - font-size: 0.9em; - padding: 6px; -} - -select:focus { - border: 1px solid var(--input-focus); - box-shadow: 0 0 3px var(--input-focus); -} - -/* Docgen styles */ -/* Links */ -a { - color: var(--anchor); - text-decoration: none; -} - -a span.Identifier { - text-decoration: underline; - text-decoration-color: #aab; -} - -a.reference-toplevel { - font-weight: bold; -} - -a.toc-backref { - text-decoration: none; - color: var(--text); } - -a.link-seesrc { - color: #607c9f; - font-size: 0.9em; - font-style: italic; } - -a:hover, -a:focus { - color: var(--anchor-focus); - text-decoration: underline; } - -a:hover span.Identifier { - color: var(--anchor); -} - - -sub, -sup { - position: relative; - font-size: 75%; - line-height: 0; - vertical-align: baseline; } - -sup { - top: -0.5em; } - -sub { - bottom: -0.25em; } - -img { - width: auto; - height: auto; - max-width: 100%; - vertical-align: middle; - border: 0; - -ms-interpolation-mode: bicubic; } - -@media print { - * { - color: black !important; - text-shadow: none !important; - background: transparent !important; - box-shadow: none !important; } - - a, - a:visited { - text-decoration: underline; } - - a[href]:after { - content: " (" attr(href) ")"; } - - abbr[title]:after { - content: " (" attr(title) ")"; } - - .ir a:after, - a[href^="javascript:"]:after, - a[href^="#"]:after { - content: ""; } - - pre, - blockquote { - border: 1px solid #999; - page-break-inside: avoid; } - - thead { - display: table-header-group; } - - tr, - img { - page-break-inside: avoid; } - - img { - max-width: 100% !important; } - - @page { - margin: 0.5cm; } - - h1 { - page-break-before: always; } - - h1.title { - page-break-before: avoid; } - - p, - h2, - h3 { - orphans: 3; - widows: 3; } - - h2, - h3 { - page-break-after: avoid; } -} - - -p { - margin-top: 0.5em; - margin-bottom: 0.5em; -} - -small { - font-size: 85%; } - -strong { - font-weight: 600; - font-size: 0.95em; - color: var(--strong); -} - -em { - font-style: italic; } - -h1 { - font-size: 1.8em; - font-weight: 400; - padding-bottom: .25em; - border-bottom: 6px solid var(--third-background); - margin-top: 2.5em; - margin-bottom: 1em; - line-height: 1.2em; } - -h1.title { - padding-bottom: 1em; - border-bottom: 0px; - font-size: 2.5em; - text-align: center; - font-weight: 900; - margin-top: 0.75em; - margin-bottom: 0em; -} - -h2 { - font-size: 1.3em; - margin-top: 2em; } - -h2.subtitle { - text-align: center; } - -h3 { - font-size: 1.125em; - font-style: italic; - margin-top: 1.5em; } - -h4 { - font-size: 1.125em; - margin-top: 1em; } - -h5 { - font-size: 1.125em; - margin-top: 0.75em; } - -h6 { - font-size: 1.1em; } - - -ul, -ol { - padding: 0; - margin-top: 0.5em; - margin-left: 0.75em; } - -ul ul, -ul ol, -ol ol, -ol ul { - margin-bottom: 0; - margin-left: 1.25em; } - -li { - list-style-type: circle; -} - -ul.simple-boot li { - list-style-type: none; - margin-left: 0em; - margin-bottom: 0.5em; -} - -ol.simple > li, ul.simple > li { - margin-bottom: 0.25em; - margin-left: 0.4em } - -ul.simple.simple-toc > li { - margin-top: 1em; -} - -ul.simple-toc { - list-style: none; - font-size: 0.9em; - margin-left: -0.3em; - margin-top: 1em; } - -ul.simple-toc > li { - list-style-type: none; -} - -ul.simple-toc-section { - list-style-type: circle; - margin-left: 1em; - color: #6c9aae; } - - -ol.arabic { - list-style: decimal; } - -ol.loweralpha { - list-style: lower-alpha; } - -ol.upperalpha { - list-style: upper-alpha; } - -ol.lowerroman { - list-style: lower-roman; } - -ol.upperroman { - list-style: upper-roman; } - -ul.auto-toc { - list-style-type: none; } - - -dl { - margin-bottom: 1.5em; } - -dt { - margin-bottom: -0.5em; - margin-left: 0.0em; } - -dd { - margin-left: 2.0em; - margin-bottom: 3.0em; - margin-top: 0.5em; } - - -hr { - margin: 2em 0; - border: 0; - border-top: 1px solid #aaa; } - -blockquote { - font-size: 0.9em; - font-style: italic; - padding-left: 0.5em; - margin-left: 0; - border-left: 5px solid #bbc; -} - -.pre { - font-family: "Source Code Pro", Monaco, Menlo, Consolas, "Courier New", monospace; - font-weight: 500; - font-size: 0.85em; - color: var(--text); - background-color: var(--third-background); - padding-left: 3px; - padding-right: 3px; - border-radius: 4px; -} - -pre { - font-family: "Source Code Pro", Monaco, Menlo, Consolas, "Courier New", monospace; - color: var(--text); - font-weight: 500; - display: inline-block; - box-sizing: border-box; - min-width: 100%; - padding: 0.5em; - margin-top: 0.5em; - margin-bottom: 0.5em; - font-size: 0.85em; - white-space: pre !important; - overflow-y: hidden; - overflow-x: visible; - background-color: var(--secondary-background); - border: 1px solid var(--border); - -webkit-border-radius: 6px; - -moz-border-radius: 6px; - border-radius: 6px; } - -.pre-scrollable { - max-height: 340px; - overflow-y: scroll; } - - -/* Nim line-numbered tables */ -.line-nums-table { - width: 100%; - table-layout: fixed; } - -table.line-nums-table { - border-radius: 4px; - border: 1px solid #cccccc; - background-color: ghostwhite; - border-collapse: separate; - margin-top: 15px; - margin-bottom: 25px; } - -.line-nums-table tbody { - border: none; } - -.line-nums-table td pre { - border: none; - background-color: transparent; } - -.line-nums-table td.blob-line-nums { - width: 28px; } - -.line-nums-table td.blob-line-nums pre { - color: #b0b0b0; - -webkit-filter: opacity(75%); - text-align: right; - border-color: transparent; - background-color: transparent; - padding-left: 0px; - margin-left: 0px; - padding-right: 0px; - margin-right: 0px; } - - -table { - max-width: 100%; - background-color: transparent; - margin-top: 0.5em; - margin-bottom: 1.5em; - border-collapse: collapse; - border-color: var(--third-background); - border-spacing: 0; - font-size: 0.9em; -} - -table th, table td { - padding: 0px 0.5em 0px; - border-color: var(--third-background); -} - -table th { - background-color: var(--third-background); - border-color: var(--third-background); - font-weight: bold; } - -table th.docinfo-name { - background-color: transparent; -} - -table tr:hover { - background-color: var(--third-background); } - - -/* rst2html default used to remove borders from tables and images */ -.borderless, table.borderless td, table.borderless th { - border: 0; } - -table.borderless td, table.borderless th { - /* Override padding for "table.docutils td" with "! important". - The right padding separates the table cells. */ - padding: 0 0.5em 0 0 !important; } - -.first { - /* Override more specific margin styles with "! important". */ - margin-top: 0 !important; } - -.last, .with-subtitle { - margin-bottom: 0 !important; } - -.hidden { - display: none; } - -blockquote.epigraph { - margin: 2em 5em; } - -dl.docutils dd { - margin-bottom: 0.5em; } - -object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { - overflow: hidden; } - - -div.figure { - margin-left: 2em; - margin-right: 2em; } - -div.footer, div.header { - clear: both; - text-align: center; - color: #666; - font-size: smaller; } - -div.footer { - padding-top: 5em; -} - -div.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; } - -div.line-block div.line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; } - -div.topic { - margin: 2em; } - -div.search_results { - background-color: antiquewhite; - margin: 3em; - padding: 1em; - border: 1px solid #4d4d4d; -} - -div#global-links ul { - margin-left: 0; - list-style-type: none; -} - -div#global-links > simple-boot { - margin-left: 3em; -} - -hr.docutils { - width: 75%; } - -img.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; } - -img.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; } - -img.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; } - -.align-left { - text-align: left; } - -.align-center { - clear: both; - text-align: center; } - -.align-right { - text-align: right; } - -/* reset inner alignment in figures */ -div.align-right { - text-align: inherit; } - -p.attribution { - text-align: right; - margin-left: 50%; } - -p.caption { - font-style: italic; } - -p.credits { - font-style: italic; - font-size: smaller; } - -p.label { - white-space: nowrap; } - -p.rubric { - font-weight: bold; - font-size: larger; - color: maroon; - text-align: center; } - -p.topic-title { - font-weight: bold; } - -pre.address { - margin-bottom: 0; - margin-top: 0; - font: inherit; } - -pre.literal-block, pre.doctest-block, pre.math, pre.code { - margin-left: 2em; - margin-right: 2em; } - -pre.code .ln { - color: grey; } - -/* line numbers */ -pre.code, code { - background-color: #eeeeee; } - -pre.code .comment, code .comment { - color: #5c6576; } - -pre.code .keyword, code .keyword { - color: #3B0D06; - font-weight: bold; } - -pre.code .literal.string, code .literal.string { - color: #0c5404; } - -pre.code .name.builtin, code .name.builtin { - color: #352b84; } - -pre.code .deleted, code .deleted { - background-color: #DEB0A1; } - -pre.code .inserted, code .inserted { - background-color: #A3D289; } - -span.classifier { - font-style: oblique; } - -span.classifier-delimiter { - font-weight: bold; } - -span.option { - white-space: nowrap; } - -span.problematic { - color: #b30000; } - -span.section-subtitle { - /* font-size relative to parent (h1..h6 element) */ - font-size: 80%; } - -span.DecNumber { - color: var(--number); } - -span.BinNumber { - color: var(--number); } - -span.HexNumber { - color: var(--number); } - -span.OctNumber { - color: var(--number); } - -span.FloatNumber { - color: var(--number); } - -span.Identifier { - color: var(--identifier); } - -span.Keyword { - font-weight: 600; - color: var(--keyword); } - -span.StringLit { - color: var(--literal); } - -span.LongStringLit { - color: var(--literal); } - -span.CharLit { - color: var(--literal); } - -span.EscapeSequence { - color: var(--escapeSequence); } - -span.Operator { - color: var(--operator); } - -span.Punctuation { - color: var(--punctuation); } - -span.Comment, span.LongComment { - font-style: italic; - font-weight: 400; - color: var(--comment); } - -span.RegularExpression { - color: darkviolet; } - -span.TagStart { - color: darkviolet; } - -span.TagEnd { - color: darkviolet; } - -span.Key { - color: #252dbe; } - -span.Value { - color: #252dbe; } - -span.RawData { - color: var(--raw-data); } - -span.Assembler { - color: #252dbe; } - -span.Preprocessor { - color: #252dbe; } - -span.Directive { - color: #252dbe; } - -span.Command, span.Rule, span.Hyperlink, span.Label, span.Reference, -span.Other { - color: var(--other); } - -/* Pop type, const, proc, and iterator defs in nim def blocks */ -dt pre > span.Identifier, dt pre > span.Operator { - color: var(--identifier); - font-weight: 700; } - -dt pre > span.Keyword ~ span.Identifier, dt pre > span.Identifier ~ span.Identifier, -dt pre > span.Operator ~ span.Identifier, dt pre > span.Other ~ span.Identifier { - color: var(--identifier); - font-weight: inherit; } - -/* Nim sprite for the footer (taken from main page favicon) */ -.nim-sprite { - display: inline-block; - width: 51px; - height: 14px; - background-position: 0 0; - background-size: 51px 14px; - -webkit-filter: opacity(50%); - background-repeat: no-repeat; - background-image: var(--nim-sprite-base64); - margin-bottom: 5px; } - -span.pragmadots { - /* Position: relative frees us up to make the dots - look really nice without fucking up the layout and - causing bulging in the parent container */ - position: relative; - /* 1px down looks slightly nicer */ - top: 1px; - padding: 2px; - background-color: var(--third-background); - border-radius: 4px; - margin: 0 2px; - cursor: pointer; - font-size: 0.8em; -} - -span.pragmadots:hover { - background-color: var(--hint); -} -span.pragmawrap { - display: none; -} - -span.attachedType { - display: none; - visibility: hidden; -} \ No newline at end of file diff --git a/nimterop.nimble b/nimterop.nimble new file mode 100644 index 0000000..87e1bc4 --- /dev/null +++ b/nimterop.nimble @@ -0,0 +1,109 @@ +# Package + +version = "0.6.13" +author = "genotrance" +description = "C/C++ interop for Nim" +license = "MIT" + +bin = @["nimterop/toast", "nimterop/loaf"] +installDirs = @["nimterop"] + +# Dependencies +requires "nim >= 0.20.2", "regex >= 0.15.0", "cligen >= 1.5.3" + +import nimterop/docs +import os + +proc execCmd(cmd: string) = + exec "tests/timeit " & cmd + +proc execTest(test: string, flags = "", runDocs = true) = + execCmd "nim c --hints:off -f -d:checkAbi " & flags & " -r " & test + let + # -d:checkAbi broken in cpp mode until post 1.2.0 + cppAbi = when (NimMajor, NimMinor) >= (1, 3): "-d:checkAbi " else: "" + execCmd "nim cpp --hints:off " & cppAbi & flags & " -r " & test + + if runDocs: + let docPath = "build/html_" & test.extractFileName.changeFileExt("") & "_docs" + rmDir docPath + mkDir docPath + buildDocs(@[test], docPath, nimArgs = "--hints:off " & flags) + +task buildTimeit, "build timer": + exec "nim c --hints:off -d:danger tests/timeit" + +task buildLoaf, "build loaf": + execCmd("nim c --hints:off -d:danger nimterop/loaf.nim") + +task buildToast, "build toast": + execCmd("nim c --hints:off -d:danger nimterop/toast.nim") + +task bt, "build toast": + buildToastTask() + +task btd, "build toast": + execCmd("nim c -g nimterop/toast.nim") + +task docs, "Generate docs": + buildDocs(@["nimterop/all.nim"], "build/htmldocs") + +task minitest, "Test for Nim CI": + exec "nim c -f -d:danger nimterop/loaf.nim" + exec "nim c -f -d:danger nimterop/toast" + exec "nim c -f -d:checkAbi -r tests/tast2.nim" + exec "nim c -f -d:checkAbi -d:zlibJBB -d:zlibSetVer=1.2.11 -r tests/zlib.nim" + +task basic, "Basic tests": + execTest "tests/tast2.nim" + execTest "tests/tast2.nim", "-d:NOHEADER" + execTest "tests/tast2.nim", "-d:NOHEADER -d:WRAPPED" + + execTest "tests/tnimterop_c.nim" + execTest "tests/tnimterop_c.nim", "-d:FLAGS=\"-H\"" + + execCmd "nim cpp --hints:off -f -r tests/tnimterop_cpp.nim" + execCmd "./nimterop/toast tests/toast.cfg tests/include/toast.h" + +task wrapper, "Wrapper tests": + execTest "tests/tpcre.nim" + + when defined(Linux): + execTest "tests/rsa.nim" + execTest "tests/rsa.nim", "-d:FLAGS=\"-H\"" + + # Platform specific tests + when defined(Windows): + execTest "tests/tmath.nim" + execTest "tests/tmath.nim", "-d:FLAGS=\"-H\"" + if defined(OSX) or defined(Windows) or not existsEnv("TRAVIS"): + execTest "tests/tsoloud.nim" + execTest "tests/tsoloud.nim", "-d:FLAGS=\"-H\"" + +task getheader, "getHeader tests": + withDir("tests"): + exec "nim e getheader.nims" + +task package, "Wrapper package tests": + if not existsEnv("APPVEYOR"): + withDir("tests"): + exec "nim e wrappers.nims" + +task test, "Test": + rmFile("tests/timeit.txt") + + buildTimeitTask() + buildLoafTask() + buildToastTask() + + basicTask() + + wrapperTask() + + getheaderTask() + + packageTask() + + docsTask() + + echo readFile("tests/timeit.txt") diff --git a/nimterop/all.nim b/nimterop/all.nim new file mode 100644 index 0000000..20ab4e8 --- /dev/null +++ b/nimterop/all.nim @@ -0,0 +1,5 @@ +##[ +The following modules are available to users of Nimterop. +]## + +import "."/[build, cimport, docs, plugin] diff --git a/nimterop/build.nim b/nimterop/build.nim new file mode 100644 index 0000000..3a73f56 --- /dev/null +++ b/nimterop/build.nim @@ -0,0 +1,39 @@ +when not defined(TOAST): + import os except findExe, sleep +else: + import os + +export extractFilename, `/` + +# Misc helpers +import "."/build/misc +export misc + +# Nim cfg file related functionality +import "."/build/nimconf +export nimconf + +# Functionality shelled out to external executables +import "."/build/shell +export shell + +# C compiler support +import "."/build/ccompiler +export ccompiler + +when not defined(TOAST): + # configure, cmake, make support + import "."/build/tools + export tools + + # Conan.io support + import "."/build/conan + export conan + + # Julia BinaryBuilder.org support + import "."/build/jbb + export jbb + + # getHeader support + import "."/build/getheader + export getheader diff --git a/nimterop/build/ccompiler.nim b/nimterop/build/ccompiler.nim new file mode 100644 index 0000000..f21f45a --- /dev/null +++ b/nimterop/build/ccompiler.nim @@ -0,0 +1,105 @@ +import os, strformat, strutils + +import "."/shell + +proc getCompilerMode*(path: string): string = + ## Determines a target language mode from an input filename, if one is not already specified. + let file = path.splitFile() + if file.ext in [".hxx", ".hpp", ".hh", ".H", ".h++", ".cpp", ".cxx", ".cc", ".C", ".c++"]: + result = "cpp" + elif file.ext in [".h", ".c"]: + result = "c" + +proc getGccModeArg*(mode: string): string = + ## Produces a GCC argument that explicitly sets the language mode to be used by the compiler. + if mode == "cpp": + result = "-xc++" + elif mode == "c": + result = "-xc" + +proc getCompiler*(): string = + var + compiler = + when defined(gcc): + "gcc" + elif defined(clang): + "clang" + else: + doAssert false, "Nimterop only supports gcc and clang at this time" + + result = getEnv("CC", compiler) + +proc getGccPaths*(mode: string): seq[string] = + var + nul = when defined(Windows): "nul" else: "/dev/null" + inc = false + + (outp, _) = execAction(&"""{getCompiler()} -Wp,-v {getGccModeArg(mode)} {nul}""", die = false) + + for line in outp.splitLines(): + if "#include <...> search starts here" in line: + inc = true + continue + elif "End of search list" in line: + break + if inc: + var + path = line.strip().normalizedPath() + if path notin result: + result.add path + + when defined(osx): + result.add(execAction("xcrun --show-sdk-path").output.strip() & "/usr/include") + +proc getGccLibPaths*(mode: string): seq[string] = + var + nul = when defined(Windows): "nul" else: "/dev/null" + linker = when defined(OSX): "-Xlinker" else: "" + + (outp, _) = execAction(&"""{getCompiler()} {linker} -v {getGccModeArg(mode)} {nul}""", die = false) + + for line in outp.splitLines(): + if "LIBRARY_PATH=" in line: + for path in line[13 .. ^1].split(PathSep): + var + path = path.strip().normalizedPath() + if path notin result: + result.add path + break + elif '\t' in line: + var + path = line.strip().normalizedPath() + if path notin result: + result.add path + + when defined(osx): + result.add "/usr/lib" + +proc getGccInfo*(): tuple[arch, os, compiler, version, libc: string] = + let + (outp, _) = execAction(&"{getCompiler()} -v") + for line in outp.splitLines(): + if line.startsWith("Target: "): + result.arch = line.split(' ')[1].split('-')[0] + result.os = + if "linux" in line: + "linux" + elif "android" in line: + "android" + elif "darwin" in line: + "macos" + elif "w64" in line or "mingw" in line: + "windows" + else: + "unknown" + elif " version " in line: + result.version = line.split(" version ")[1].split(' ')[0] + if "clang" in outp: + if result.os == "macos": + result.compiler = "apple-clang" + else: + result.compiler = "clang" + else: + result.compiler = "gcc" + if "musl" in outp: + result.libc = "musl" diff --git a/nimterop/build/conan.nim b/nimterop/build/conan.nim new file mode 100644 index 0000000..ac74089 --- /dev/null +++ b/nimterop/build/conan.nim @@ -0,0 +1,466 @@ +import json, os, strformat, strutils, tables + + +import ".."/globals +import "."/[ccompiler, misc, nimconf, shell] + +when (NimMajor, NimMinor, NimPatch) < (1, 2, 0): + import marshal + +type + ConanPackage* = ref object + ## ConanPackage type that stores conan uri and recipes/builds/revisions + name*: string + version*: string + user*: string + channel*: string + recipes*: OrderedTableRef[string, seq[ConanBuild]] + + arch*, os*, compiler*, compversion*: string + + bhash*: string + shared*: bool + sharedLibs*: seq[string] + staticLibs*: seq[string] + requires*: seq[ConanPackage] + + skipRequires*: seq[string] + + ConanBuild* = ref object + ## Build type that stores build specific info and revisions + bhash*: string + settings*: TableRef[string, string] + options*: TableRef[string, string] + requires*: seq[string] + recipe_hash*: string + revisions*: seq[string] + +const + # Conan API urls + conanBaseUrl = "https://conan.bintray.com/v2/conans" + conanSearchUrl = conanBaseUrl & "/search?q=$query" + conanPkgUrl = conanBaseUrl & "/$name/$version/$user/$channel/search$query" + conanCfgUrl = conanBaseUrl & "/$name/$version/$user/$channel/revisions/$recipe/packages/$build/revisions" + conanDlUrl = conanBaseUrl & "/$name/$version/$user/$channel/revisions/$recipe/packages/$build/revisions/$revision/files/$file" + + # Bintray download sub-URL for explicit `user/channel` (not _/_) + conanDlAltUrl = "/download_file?file_path=$user%2F$name%2F$version%2F$channel%2F0%2Fpackage%2F$build%2F0%2F$file" + + # Strings + conanInfo = "conaninfo.json" + conanPackage = "conan_package.tgz" + conanManifest = "conanmanifest.txt" + +var + # Bintray download URL for explicit `user/channel` + conanBaseAltUrl {.compileTime.} = { + "bincrafters": "https://bintray.com/bincrafters/public-conan", + "conan": "https://bintray.com/conan-community/conan" + }.toTable() + + # Reuse dependencies already downloaded + gConanRequires {.compileTime.}: Table[string, ConanPackage] + +proc addAltConanBaseUrl*(name, url: string) = + # Add an alternate base URL for a custom conan repo on bintray + conanBaseAltUrl[name] = url + +proc jsonGet(url: string): JsonNode = + # Make HTTP call and return content as JSON + let + temp = getTempDir() + file = block: + var + file = temp / url.extractFilename() + when defined(Windows): + file = file.replace('?', '_') + file + + downloadUrl(url, temp, quiet = true) + try: + result = readFile(file).parseJson() + except JsonParsingError: + discard + rmFile(file) + +proc `==`*(pkg1, pkg2: ConanPackage): bool = + ## Check if two ConanPackage objects are equal + (not pkg1.isNil and not pkg2.isNil and + pkg1.name == pkg2.name and + pkg1.version == pkg2.version and + pkg1.user == pkg2.user and + pkg1.channel == pkg2.channel and + + pkg1.arch == pkg2.arch and + pkg1.os == pkg2.os and + pkg1.compiler == pkg2.compiler and + pkg1.compversion == pkg2.compversion and + + pkg1.bhash == pkg2.bhash and + pkg1.shared == pkg2.shared) + +proc newConanPackage*(name, version, user = "_", channel = "_", bhash = "", shared = true): ConanPackage = + ## Create a new ConanPackage with specified name and version + result = new(ConanPackage) + result.name = name + result.version = version + result.user = user + result.channel = channel + result.recipes = newOrderedTable[string, seq[ConanBuild]](2) + + let + (arch, os, compiler, compversion, libc) = getGccInfo() + doAssert libc != "musl", "Conan does not provide precompiled binaries using musl" + + result.arch = arch + result.os = os + result.compiler = compiler + result.compversion = compversion + + result.bhash = bhash + result.shared = shared + +proc newConanPackageFromUri*(uri: string, shared = true): ConanPackage = + ## Create a new ConanPackage from a conan uri typically formatted as name/version[@user/channel][:bhash] + var + name, version, user, channel, bhash: string + + spl = uri.split(":") + + if spl.len > 1: + bhash = spl[1] + + spl = spl[0].split('/') + + name = spl[0] + user = "_" + channel = "_" + + if spl.len > 2: + channel = spl[2] + if spl.len > 1: + spl = spl[1].split('@') + + version = spl[0] + if spl.len > 1: + user = spl[1] + + result = newConanPackage(name, version, user, channel, bhash, shared) + +proc getUriFromConanPackage*(pkg: ConanPackage): string = + ## Convert a ConanPackage to a conan uri + result = pkg.name + if pkg.version.nBl: + result &= "/" & pkg.version + if pkg.user.nBl: + result &= "@" & pkg.user + if pkg.channel.nBl: + result &= "/" & pkg.channel + if pkg.bhash.nBl: + result &= ":" & pkg.bhash + +proc searchConan*(name: string, version = "", user = "", channel = ""): ConanPackage = + ## Search for package by `name` and optional `version`, `user` and `channel` + ## + ## Search is quite slow so it is preferable to specify a version and use `getConanBuilds()` + var + query = name + if version.nBl: + query &= "/" & version + if user.nBl: + query &= "@" & user + if channel.nBl: + query &= "/" & channel + + gecho &"# Searching Conan.io for latest version of {name}" + + let + j1 = jsonGet(conanSearchUrl % ["query", query]) + res = j1.getOrDefault("results").getElems() + + # Return latest comparing versions - prefer @_/_ + var + latest = "" + latestv = "" + for i in 0 ..< res.len: + let + str = res[i].getStr() + if "@_/_" in str: + let + ver = str.split('/')[1].split('@')[0] + if latestv.Bl or compareVersions(ver, latestv) > 0: + latestv = ver + latest = str + + if latest.nBl: + result = newConanPackageFromUri(latest) + +proc searchConan*(pkg: ConanPackage): ConanPackage = + ## Search for latest package based on incomplete package info + result = searchConan(pkg.name, pkg.version, pkg.user, pkg.channel) + +proc getConanBuilds*(pkg: ConanPackage, filter = "") = + ## Get all builds for a package based on the C compiler's target OS/arch info + ## + ## `filter` can be used to tweak search terms + ## e.g. build_type=Debug&compiler=clang + let + vsplit = pkg.compversion.split('.') + + vfilter = + when defined(OSX): + vsplit[0 .. 1].join(".") + else: + vsplit[0] + + query = + if pkg.bhash.Bl: + block: + var + query = &"?q=arch={pkg.arch}&os={pkg.os.capitalizeAscii()}" + if "build_type" notin filter: + query &= "&build_type=Release" + if "shared=" notin filter: + query &= &"&options.shared={($pkg.shared).capitalizeAscii()}" + if filter.nBl: + query &= &"&{filter}" + if "compiler=" notin filter and pkg.os != "windows": + query &= &"&compiler={pkg.compiler}&compiler.version=" & vfilter + if "compiler.runtime=" notin filter and pkg.os == "windows": + query &= &"&compiler.runtime=MD" + if "compiler.version=" notin filter and pkg.os == "windows": + query &= &"&compiler.version=14" + + query.replace("&", "%20and%20") + else: "" + + url = conanPkgUrl % [ + "name", pkg.name, + "version", pkg.version, + "user", pkg.user, + "channel", pkg.channel, + "query", query + ] + + j1 = jsonGet(url) + + if not j1.isNil: + for bhash, bdata in j1.getFields(): + if pkg.bhash.Bl or pkg.bhash == bhash: + let + bld = new(ConanBuild) + settings = bdata.getOrDefault("settings") + options = bdata.getOrDefault("options") + requires = bdata.getOrDefault("requires") + bld.bhash = bhash + if not settings.isNil: + bld.settings = newTable[string, string](8) + for key, value in settings.getFields(): + bld.settings[key] = value.getStr() + if not options.isNil: + bld.options = newTable[string, string](8) + for key, value in options.getFields(): + bld.options[key] = value.getStr() + for req in requires.to(seq[string]): + # Filter skipped dependencies + if req.toLowerAscii() notin pkg.skipRequires: + bld.requires.add req + bld.recipe_hash = bdata.getOrDefault("recipe_hash").getStr() + + if pkg.recipes.hasKey(bld.recipe_hash): + pkg.recipes[bld.recipe_hash].add bld + else: + pkg.recipes[bld.recipe_hash] = @[bld] + + # Only need first or matching build + break + +proc getConanRevisions*(pkg: ConanPackage, bld: ConanBuild) = + ## Get all revisions of a build + let + url = conanCfgUrl % [ + "name", pkg.name, + "version", pkg.version, + "user", pkg.user, + "channel", pkg.channel, + "recipe", bld.recipe_hash, + "build", bld.bhash + ] + + j1 = jsonGet(url) + + if not j1.isNil: + let + revs = j1.getOrDefault("revisions") + for i in revs: + bld.revisions.add i.getOrDefault("revision").getStr() + +proc loadConanInfo*(outdir: string): ConanPackage = + ## Load cached package info from `outdir/conaninfo.json` + let + file = fixRelPath(outdir) / conanInfo + + if fileExists(file): + when (NimMajor, NimMinor, NimPatch) < (1, 2, 0): + result = to[ConanPackage](readFile(file)) + else: + try: + result = to(readFile(file).parseJson(), ConanPackage) + except: + discard + +proc saveConanInfo*(pkg: ConanPackage, outdir: string) = + ## Save downloaded package info to `outdir/conaninfo.json` + let + file = fixRelPath(outdir) / conanInfo + + when (NimMajor, NimMinor, NimPatch) < (1, 2, 0): + writeFile(file, $$pkg) + else: + writeFile(file, $(%pkg)) + +proc parseConanManifest(pkg: ConanPackage, outdir: string) = + # Get all library info from downloaded conan package + let + file = outdir / conanManifest + + if fileExists(file): + let + data = readFile(file) + for line in data.splitLines(): + let + line = line.split(':')[0] + if line.startsWith("lib/"): + if line.endsWith(".a") or line.endsWith(".lib"): + pkg.staticLibs.add line + elif line.endsWith(".so") or line.endsWith(".dylib"): + pkg.sharedLibs.add line + elif line.startsWith("bin/") and line.endsWith("dll"): + pkg.sharedLibs.add line + +proc dlConanBuild*(pkg: ConanPackage, bld: ConanBuild, outdir: string, revision = "") = + ## Download specific `revision` of `bld` to `outdir` + ## + ## If omitted, the latest revision (first) is downloaded + doAssert bld.revisions.nBl, "No build revisions found for Conan.io package " & pkg.getUriFromConanPackage() + + let + outdir = fixRelPath(outdir) + + revision = + if revision.nBl: + revision + else: + bld.revisions[0] + + url = + if pkg.user == "_": + conanDlUrl % [ + "name", pkg.name, + "version", pkg.version, + "user", pkg.user, + "channel", pkg.channel, + "recipe", bld.recipe_hash, + "build", bld.bhash, + "revision", revision, + "file", conanPackage + ] + else: + conanBaseAltUrl[pkg.user] & conanDlAltUrl % [ + "name", pkg.name, + "version", pkg.version, + "user", pkg.user, + "channel", pkg.channel, + "build", bld.bhash, + "file", conanPackage + ] + + downloadUrl(url, outdir, quiet = true) + downloadUrl(url.replace(conanPackage, conanManifest), outdir, quiet = true) + + pkg.parseConanManifest(outdir) + + rmFile(outdir / url.extractFilename()) + rmFile(outdir / conanManifest) + +proc dlConanRequires*(pkg: ConanPackage, bld: ConanBuild, outdir: string) +proc downloadConan*(pkg: ConanPackage, outdir: string, main = true) = + ## Download latest recipe/build/revision of `pkg` to `outdir` + ## + ## High-level API that handles the end to end Conan process flow to find + ## latest package binary and downloads and extracts it to `outdir`. + let + outdir = fixRelPath(outdir) + + pkg = + if pkg.version.Bl: + searchConan(pkg) + else: + pkg + + if main: + let + cpkg = loadConanInfo(outdir) + + if cpkg == pkg: + return + + cleanDir(outdir) + + pkg.getConanBuilds() + + doAssert pkg.recipes.nBl, &"Failed to download {pkg.name} v{pkg.version} from Conan - check https://conan.io/center" + + gecho &"# Downloading {pkg.name} v{pkg.version} from Conan.io" + for recipe, builds in pkg.recipes: + for build in builds: + if pkg.bhash.Bl or pkg.bhash == build.bhash: + pkg.getConanRevisions(build) + pkg.dlConanBuild(build, outdir) + pkg.dlConanRequires(build, outdir) + break + break + + if main: + pkg.saveConanInfo(outdir) + +proc dlConanRequires*(pkg: ConanPackage, bld: ConanBuild, outdir: string) = + ## Download all required dependencies of this `bld` + ## + ## This is not required for shared libs since conan builds them + ## with all dependencies statically linked in + let + outdir = fixRelPath(outdir) + if bld.options["shared"] == "False": + for req in bld.requires: + let + name = req.split('/')[0] + if gConanRequires.hasKey(name): + # Reuse dep already downloaded + pkg.requires.add gConanRequires[name] + else: + let + rpkg = newConanPackageFromUri(req, shared = false) + rpkg.skipRequires = pkg.skipRequires + + downloadConan(rpkg, outdir, main = false) + pkg.requires.add rpkg + gConanRequires[name] = rpkg + +proc getConanLDeps*(pkg: ConanPackage, outdir: string, main = true): seq[string] = + ## Get all Conan libs - shared (.so|.dll) or static (.a|.lib) in pkg, including deps + ## in descending order + ## + ## `outdir` is prefixed to each entry + let + libs = if pkg.shared: pkg.sharedLibs else: pkg.staticLibs + str = if pkg.shared: "shared" else: "static" + + doAssert libs.nBl, &"No {str} libs found for {pkg.name} in {outdir}" + + if not main: + for lib in libs: + result.add outdir / lib + + for cpkg in pkg.requires: + result.add cpkg.getConanLDeps(outdir, main = false) diff --git a/nimterop/build/getheader.nim b/nimterop/build/getheader.nim new file mode 100644 index 0000000..6c83939 --- /dev/null +++ b/nimterop/build/getheader.nim @@ -0,0 +1,568 @@ +import macros, strformat, strutils, tables + +import os except findExe + +import ".."/globals +import "."/[ccompiler, conan, jbb, nimconf, shell, tools] + +var + gDefines {.compileTime.} = initTable[string, string]() + +macro setDefines*(defs: static openArray[string]): untyped = + ## Specify `-d:xxx` values in code instead of having to rely on the command + ## line or `cfg` or `nims` files. + ## + ## At this time, Nim does not allow creation of `-d:xxx` defines in code. In + ## addition, Nim only loads config files for the module being compiled but not + ## for imported packages. This becomes a challenge when wanting to ship a wrapper + ## library that wants to control `getHeader()` for an underlying package. + ## + ## E.g. nimarchive wanting to set `-d:lzmaStatic` + ## + ## The consumer of nimarchive would need to set such defines as part of their + ## project, making it inconvenient. + ## + ## By calling this proc with the defines preferred before importing such a module, + ## the caller can set the behavior in code instead. + ## + ## .. code-block:: nim + ## + ## setDefines(@["lzmaStatic", "lzmaDL", "lzmaSetVer=5.2.4"]) + ## + ## import lzma + for def in defs: + let + nv = def.strip().split("=", maxsplit = 1) + if nv.nBl: + let + n = nv[0] + v = + if nv.len == 2: + nv[1] + else: + "" + gDefines[n] = v + +macro clearDefines*(): untyped = + ## Clear all defines set using `setDefines()`. + gDefines.clear() + +macro isDefined*(def: untyped): untyped = + ## Check if `-d:xxx` is set globally or via `setDefines()` + let + sdef = gDefines.hasKey(def.strVal()) + result = newNimNode(nnkStmtList) + result.add(quote do: + when defined(`def`) or `sdef` != 0: + true + else: + false + ) + +macro getDefine*(def: untyped): untyped = + let version = newIdentNode(def.strVal()) + let verVal = + if gDefines.hasKey(def.strVal()): + gDefines[def.strVal()] + else: + "" + result = quote do: + const `version` {.strdefine.} = `verVal` + `version` + +proc getDynlibExt(): string = + when defined(Windows): + result = "[0-9.\\-]*\\.dll" + elif defined(linux) or defined(FreeBSD): + result = "\\.so[0-9.]*" + elif defined(macosx): + result = "[0-9.\\-]*\\.dylib" + +proc getStdPath(header, mode: string): string = + for inc in getGccPaths(mode): + result = findFile(header, inc, recurse = false, first = true) + if result.nBl: + break + +proc getStdLibPath(lname, mode: string): string = + for lib in getGccLibPaths(mode): + result = findFile(lname, lib, recurse = false, first = true, regex = true) + if result.nBl: + break + +proc getGitPath(header, url, outdir, version: string): string = + doAssert url.nBl, "No git url setup for " & header + doAssert findExe("git").nBl, "git executable missing" + + gitPull(url, outdir, checkout = version) + + result = findFile(header, outdir) + +proc getDlPath(header, url, outdir, version: string): string = + doAssert url.nBl, "No download url setup for " & header + + var + dlurl = url + if "$#" in url or "$1" in url: + doAssert version.nBl, "Need version for download url" + dlurl = url % version + else: + doAssert version.Bl, "Download url does not contain version" + + downloadUrl(dlurl, outdir) + + var + dirname = "" + for kind, path in walkDir(outdir, relative = true): + if kind == pcFile and path != dlurl.extractFilename(): + dirname = "" + break + elif kind == pcDir: + if dirname.Bl: + dirname = path + else: + dirname = "" + break + + if dirname.nBl: + for kind, path in walkDir(outdir / dirname, relative = true): + mvFile(outdir / dirname / path, outdir / path) + + result = findFile(header, outdir) + +proc getConanPath(header, uri, flags, outdir, version: string, shared: bool): string = + var + uri = uri + + if "$#" in uri or "$1" in uri: + doAssert version.nBl, "Need version for Conan.io uri: " & uri + uri = uri % version + elif version.nBl: + uri = uri & "/" & version + + let + pkg = newConanPackageFromUri(uri, shared) + + # Handle `conanFlags` + if flags.nBl: + for flag in flags.split(" "): + if flag.startsWith("skip="): + for req in flag["skip=".len .. ^1].split(","): + if req.nBl: + pkg.skipRequires.add req.toLowerAscii() + + downloadConan(pkg, outdir) + + result = findFile(header, outdir) + +proc getConanLDeps(outdir: string): seq[string] = + let + pkg = loadConanInfo(outdir) + + result = pkg.getConanLDeps(outdir) + +proc getJBBPath(header, uri, flags, outdir, version: string): string = + let + spl = uri.split('/', 1) + name = spl[0] + hasVersion = version.nBl + + var + ver = if spl.len == 2: spl[1] else: "" + + if ver.nBl: + if "$#" in ver or "$1" in ver: + doAssert hasVersion, "Need version for BinaryBuilder.org uri: " & uri + ver = ver % version + elif hasVersion: + doAssert false, "Version in both uri `" & uri & "` and `-d:xxxSetVer=\"" & + version & "\"` for BinaryBuilder.org" + elif hasVersion: + ver = version + + let + pkg = newJBBPackage(name, ver) + + # Handle `jbbFlags` + if flags.nBl: + for flag in flags.split(" "): + if flag.startsWith("giturl="): + let + val = flag["giturl=".len .. ^1] + if val.contains("://"): + pkg.baseUrl = val + else: + pkg.baseUrl = "https://github.com/" & val + elif flag.startsWith("url="): + pkg.baseUrl = flag["url=".len .. ^1] + pkg.isGit = false + elif flag.startsWith("skip="): + for req in flag["skip=".len .. ^1].split(","): + if req.nBl: + pkg.skipRequires.add req.toLowerAscii() + + downloadJBB(pkg, outdir) + + result = findFile(header, outdir) + +proc getJBBLDeps(outdir: string, shared: bool): seq[string] = + let + pkg = loadJBBInfo(outdir) + + result = pkg.getJBBLDeps(outdir, shared) + +proc getLocalPath(header, outdir: string): string = + if outdir.nBl: + result = findFile(header, outdir) + +proc buildLibrary(lname, outdir, conFlags, cmakeFlags, makeFlags: string, buildTypes: openArray[BuildType]): string = + var + lpath = findFile(lname, outdir, regex = true) + makePath = outdir + buildStatus: BuildStatus + errors: seq[string] + + if lpath.nBl: + return lpath + + + for buildType in buildTypes: + case buildType + of btCmake: + buildStatus = buildWithCmake(makePath, cmakeFlags) + of btAutoconf: + buildStatus = buildWithAutoConf(makePath, conFlags) + + if buildStatus.built: + break + elif buildStatus.error.nBl: + errors.add buildStatus.error + + if buildStatus.buildPath.len > 0: + let libraryExists = findFile(lname, buildStatus.buildPath, regex = true).len > 0 + + if not libraryExists and fileExists(buildStatus.buildPath / "Makefile"): + make(buildStatus.buildPath, lname, makeFlags, regex = true) + buildStatus.built = true + + let error = if errors.len > 0: errors.join("\n") else: "No build files found in " & outdir + doAssert buildStatus.built, &"\nBuild configuration failed - {error}\n" + + result = findFile(lname, outdir, regex = true) + +macro getHeader*( + header: static[string], giturl: static[string] = "", dlurl: static[string] = "", + conanuri: static[string] = "", jbburi: static[string] = "", + outdir: static[string] = "", libdir: static[string] = "", + conFlags: static[string] = "", cmakeFlags: static[string] = "", makeFlags: static[string] = "", + conanFlags: static[string] = "", jbbFlags: static[string] = "", altNames: static[string] = "", + buildTypes: static[openArray[BuildType]] = [btCmake, btAutoconf]): untyped = + ## Get the path to a header file for wrapping with + ## `cImport() `_ or + ## `c2nImport() `_. + ## + ## This proc checks `-d:xxx` defines based on the header name (e.g. lzma from lzma.h), + ## and accordingly employs different ways to obtain the source. + ## + ## `-d:xxxStd` - search standard system paths. E.g. `/usr/include` and `/usr/lib` on Linux + ## `-d:xxxGit` - clone source from a git repo specified in `giturl` + ## `-d:xxxDL` - download source from `dlurl` and extract if required + ## `-d:xxxConan` - download headers and binary from Conan.io using `conanuri` with + ## format `pkgname[/version[@user/channel][:bhash]]` + ## `-d:xxxJBB` - download headers and binary from BinaryBuilder.org using `jbburi` with + ## format `pkgname[/version]` + ## + ## This allows a single wrapper to be used in different ways depending on the user's needs. + ## If no `-d:xxx` defines are specified, `outdir` will be searched for the header as is. + ## The user can opt to download the sources to `outdir` using any other method such as + ## git sub-modules, vendoring or pointing to a repository that was already cloned. + ## + ## If multiple `-d:xxx` defines are specified, precedence is `Std` and then `Git`, `DL`, + ## `Conan` or `JBB`. This allows using a system installed library if available before + ## falling back to manual building. The user would need to specify both `-d:xxxStd` and + ## one of the other methods. + ## + ## `-d:xxxSetVer=x.y.z` can be used to specify which version to use. It is used as a tag + ## name for `Git` whereas for `DL`, `Conan` and `JBB`, it replaces `$1` in the URL + ## if specified. Specifying `-d:xxxSetVer` without a `$1` will download that version for + ## `Conan` and `JBB` if available. If no version is specified, the latest release of the + ## package is downloaded. For `Conan`, `-d:xxxSetVer` can also be used to set additional + ## URI information: + ## `-d:xxxSetVer=1.9.0@bincrafters/stable:bhash` + ## + ## If `conanuri` or `jbburi` are not defined and `Conan` or `JBB` is selected, the `header` + ## filename is used instead. + ## + ## All defines can also be set in code using `setDefines()` and checked for using + ## `isDefined()` which checks for defines set from both `-d` and `setDefines()`. + ## + ## The library is then configured (with `cmake` or `autotools` if possible) and built + ## using `make`, unless using `-d:xxxStd` which presumes that the system package + ## manager was used to install prebuilt headers and binaries, or using `-d:xxxConan` + ## or `-d:xxxJBB` which download pre-built binaries. + ## + ## The header path is stored in `const xxxPath` and can be used in a `cImport()` call + ## in the calling wrapper. The dynamic library path is stored in `const xxxLPath` and can + ## be used for the `dynlib` parameter (within quotes) or with `cPassL()`. Any dependency + ## libraries downloaded by `Conan` or `JBB` are returned in `const xxxLDeps` as a seq[string]. + ## + ## `libdir` can be used to instruct `getHeader()` to copy shared libraries and their + ## dependencies to that directory. This prevents any runtime failures if `outdir` gets + ## removed or its contents changed. By default, `libdir` is set to the output directory + ## where the program binary will be created. The values of `xxxLPath` and `xxxLDeps` will + ## reflect this new location. `libdir` is ignored for `Std` mode. + ## + ## `-d:xxxStatic` can be specified to statically link with the library instead. This + ## will automatically add a `cPassL()` call to the static library for convenience. Note + ## that `-d:xxxConan` and `-d:xxxJBB` download all dependency libs as well and the + ## `xxxLPath` will include paths to all of them separated by space in the right order for + ## linking. + ## + ## Note also that Conan currently builds all OSX binaries on 10.14 so older versions of + ## OSX will complain if statically linking to these binaries. Further, all Conan binaries + ## for Windows are built with Visual Studio so static linking the `.lib` files with gcc + ## or clang might lead to incompatibility issues if the library uses Visual Studio + ## specific compiler features. + ## + ## `conFlags`, `cmakeFlags` and `makeFlags` allow sending custom parameters to `configure`, + ## `cmake` and `make` in case additional configuration is required as part of the build + ## process. + ## + ## `conanFlags` and `jbbFlags` allow changing the Conan.io and BinaryBuilder.org defaults: + ## - `skip=pkg1,pkg2` skips the specified packages which are required dependencies of the + ## package in question. This enables downloading those dependencies from other sources + ## if required. + ## + ## `jbbFlags` allows two additional customizations: + ## - `giturl=customUrl` changes the default `https://github.com/JuliaBinaryWrappers` to + ## another Git URL. If no hostname is specified, `https://github.com` is assumed. + ## - `url=customUrl` uses regular HTTP instead of Git and looks for `Artifacts.toml` and + ## `Project.toml` files at that location. `$1` or `$#` are replaced with the version + ## if specified. + ## + ## `altNames` is a list of alternate names for the library - e.g. zlib uses `zlib.h` for + ## the header but the typical lib name is `libz.so` and not `libzlib.so`. However, it is + ## libzlib.dll on Windows if built with cmake. In this case, `altNames = "z,zlib"`. Comma + ## separate for multiple alternate names without spaces. + ## + ## The original header name is not included by default if `altNames` is set since it could + ## cause the wrong lib to be selected. E.g. `SDL2/SDL.h` could pick `libSDL.so` even if + ## `altNames = "SDL2"`. Explicitly include it in `altNames` like the `zlib` example when + ## required. + ## + ## `buildTypes` specifies a list of ordered build strategies to use when building the + ## downloaded source files. Default is [btCmake, btAutoconf] + ## + ## `xxxPreBuild` is a hook that is called after the source code is pulled from Git or + ## downloaded but before the library is built. This might be needed if some initial prep + ## needs to be done before compilation. A few values are provided to the hook to help + ## provide context: + ## + ## `outdir` is the same `outdir` passed in and `header` is the discovered header path + ## in the downloaded source code. + ## + ## Simply define `proc xxxPreBuild(outdir, header: string)` in the wrapper and it will get + ## called prior to the build process. + var + origname = header.extractFilename().split(".")[0] + name = origname.split(seps = AllChars-Letters-Digits).join() + + # Default to origname if not specified + conanuri = if conanuri.nBl: conanuri else: origname + jbburi = if jbburi.nBl: jbburi else: origname + + # -d:xxx for this header + stdStr = name & "Std" + gitStr = name & "Git" + dlStr = name & "DL" + conanStr = name & "Conan" + jbbStr = name & "JBB" + + staticStr = name & "Static" + verStr = name & "SetVer" + getPath = name & "GetPath" + + # Ident nodes of the -d:xxx to check in when statements + nameStd = newIdentNode(stdStr) + nameGit = newIdentNode(gitStr) + nameDL = newIdentNode(dlStr) + nameConan = newIdentNode(conanStr) + nameJBB = newIdentNode(jbbStr) + + nameStatic = newIdentNode(staticStr) + nameGetPath = newIdentNode(getPath) + + # Consts to generate + path = newIdentNode(name & "Path") + lpath = newIdentNode(name & "LPath") + ldeps = newIdentNode(name & "LDeps") + version = newIdentNode(verStr) + lname = newIdentNode(name & "LName") + preBuild = newIdentNode(name & "PreBuild") + + # Regex for library search + lre = "(lib)?$1[_-]?(static)?" + + # If -d:xxx set with setDefines() + stdVal = gDefines.hasKey(stdStr) + gitVal = gDefines.hasKey(gitStr) + dlVal = gDefines.hasKey(dlStr) + conanVal = gDefines.hasKey(conanStr) + jbbVal = gDefines.hasKey(jbbStr) + staticVal = gDefines.hasKey(staticStr) + verVal = + if gDefines.hasKey(verStr): + gDefines[verStr] + else: + "" + mode = getCompilerMode(header) + + libdir = if libdir.nBl: libdir else: getOutDir() + + # Use alternate library names if specified for regex search + if altNames.nBl: + lre = lre % ("(" & altNames.replace(",", "|") & ")") + else: + lre = lre % origname + + result = newNimNode(nnkStmtList) + result.add(quote do: + # Need to check -d:xxx or setDefines() + const + `nameStd`* = when defined(`nameStd`): true else: `stdVal` == 1 + `nameGit`* = when defined(`nameGit`): true else: `gitVal` == 1 + `nameDL`* = when defined(`nameDL`): true else: `dlVal` == 1 + `nameConan`* = when defined(`nameConan`): true else: `conanVal` == 1 + `nameJBB`* = when defined(`nameJBB`): true else: `jbbVal` == 1 + `nameStatic`* = when defined(`nameStatic`): true else: `staticVal` == 1 + + # Search for header in outdir (after retrieving code) depending on -d:xxx mode + proc `nameGetPath`(header, giturl, dlurl, conanuri, conanFlags, jbburi, jbbFlags, + outdir, version: string, shared: bool): string = + when `nameGit`: + getGitPath(header, giturl, outdir, version) + elif `nameDL`: + getDlPath(header, dlurl, outdir, version) + elif `nameConan`: + getConanPath(header, conanuri, conanFlags, outdir, version, shared) + elif `nameJBB`: + getJBBPath(header, jbburi, jbbFlags, outdir, version) + else: + getLocalPath(header, outdir) + + static: + # Don't delete project + when not `nameStd` and (`nameGit` or `nameDL` or `nameConan` or `nameJBB`): + doAssert `outdir`.len != 0, "getHeader():outdir cannot be blank" + doAssert `outdir` != getProjectPath(), "getHeader():outdir cannot be the project path" + + const + `version`* {.strdefine.} = `verVal` + `lname` = + when `nameStatic`: + `lre` & "\\.(a|lib)" + else: + `lre` & getDynlibExt() + + # Look in standard path if requested by user + stdPath = + when `nameStd`: getStdPath(`header`, `mode`) else: "" + stdLPath = + when `nameStd`: getStdLibPath(`lname`, `mode`) else: "" + + useStd = stdPath.len != 0 and stdLPath.len != 0 + + # Look elsewhere if requested while prioritizing standard paths + prePath = + when useStd: + stdPath + else: + `nameGetPath`(`header`, `giturl`, `dlurl`, `conanuri`, `conanFlags`, `jbburi`, `jbbFlags`, + `outdir`, `version`, not `nameStatic`) + + # Run preBuild hook before building library if not Std, Conan or JBB + when not (useStd or `nameConan` or `nameJBB`) and declared(`preBuild`): + static: + `preBuild`(`outdir`, prePath) + + let + # Library binary path - build if not standard / conan / jbb + lpath {.compileTime.} = + when useStd: + stdLPath + elif `nameConan` or `nameJBB`: + findFile(`lname`, `outdir`, regex = true) + else: + buildLibrary(`lname`, `outdir`, `conFlags`, `cmakeFlags`, `makeFlags`, `buildTypes`) + + # Library dependecy paths + ldeps {.compileTime.}: seq[string] = + when not useStd: + when `nameConan`: + getConanLDeps(`outdir`) + elif `nameJBB`: + getJBBLDeps(`outdir`, not `nameStatic`) + else: + @[] + else: + @[] + + const + # Header path - search again in case header is generated in build + `path`* = + if prePath.len != 0: + prePath + else: + `nameGetPath`(`header`, `giturl`, `dlurl`, `conanuri`, `conanFlags`, `jbburi`, `jbbFlags`, + `outdir`, `version`, not `nameStatic`) + + static: + doAssert `path`.len != 0, "\nHeader " & `header` & " not found - " & + "missing/empty outdir or -d:$1Std -d:$1Git -d:$1DL -d:$1Conan or -d:$1JBB not specified" % `name` + doAssert lpath.len != 0, "\nLibrary " & `lname` & " not found" + + when `nameStatic`: + const + `lpath`* = lpath + `ldeps`* = ldeps + + # Automatically link with static library and dependencies + static: + gecho "# Including library " & lpath + gStateCT.passL.add lpath + if ldeps.len != 0: + gecho "# Including dependencies " & ldeps.join(" ") + gStateCT.passL.add ldeps.join(" ") + else: + const + `lpath`* = when not useStd: `libdir` / lpath.extractFilename() else: lpath + `ldeps`* = + when not useStd: + block: + var + ldeps = ldeps + copied: seq[string] + for i in 0 ..< ldeps.len: + let + lname = ldeps[i].extractFilename() + ldeptgt = `libdir` / lname + if not fileExists(ldeptgt) or getFileDate(ldeps[i]) != getFileDate(ldeptgt): + cpFile(ldeps[i], ldeptgt, psymlink = true) + copied.add lname + ldeps[i] = ldeptgt + # Copy downloaded dependencies to `libdir` + if copied.len != 0: + gecho "# Copying dependencies: " & copied.join(" ") & "\n# to " & `libdir` + ldeps + else: + ldeps + + static: + when not useStd: + # Copy downloaded shared libraries to `libdir` + if not fileExists(`lpath`) or getFileDate(lpath) != getFileDate(`lpath`): + gecho "# Copying " & `lpath`.extractFilename() & " to " & `libdir` + cpFile(lpath, `lpath`) + + gecho "# Including library " & `lpath` + ) diff --git a/nimterop/build/jbb.nim b/nimterop/build/jbb.nim new file mode 100644 index 0000000..392f848 --- /dev/null +++ b/nimterop/build/jbb.nim @@ -0,0 +1,277 @@ +import json, os, strformat, strutils, tables + +import ".."/globals +import "."/[ccompiler, nimconf, shell] + +when (NimMajor, NimMinor, NimPatch) < (1, 2, 0): + import marshal + +type + JBBPackage* = ref object + ## JBBPackage type that stores package information + name*: string + version*: string + + baseUrl*: string # Location to find package + isGit*: bool # Git or HTTP + + url*: string # Download URL + + arch*, os*, libc*: string # Target + + sharedLibs*: seq[string] + staticLibs*: seq[string] + requires*: seq[JBBPackage] + + skipRequires*: seq[string] + +const + # JBB URLs + jbbBaseUrl = "https://github.com/JuliaBinaryWrappers" + + jbbInfo = "jbbinfo.json" + jbbProject = "Project.toml" + jbbArtifacts = "Artifacts.toml" + +var + # Reuse dependencies already downloaded + gJBBRequires {.compileTime.}: Table[string, JBBPackage] + +proc `==`*(pkg1, pkg2: JBBPackage): bool = + ## Check if two JBBPackage objects are equal + (not pkg1.isNil and not pkg2.isNil and + pkg1.name == pkg2.name and + pkg1.version == pkg2.version and + + pkg1.arch == pkg2.arch and + pkg1.os == pkg2.os and + pkg1.libc == pkg2.libc) + +proc newJBBPackage*(name, version: string): JBBPackage = + ## Create a new JBBPackage with specified name and version + result = new(JBBPackage) + result.name = name + result.version = version + result.baseUrl = jbbBaseUrl + result.isGit = true + + let + (arch, os, _, _, libc) = getGccInfo() + result.arch = arch + result.os = os + result.libc = libc + +proc parseJBBProject(pkg: JBBPackage, outdir: string) = + # Get all dependencies from Project.toml + let + file = outdir / jbbProject + + if fileExists(file): + let + data = readFile(file) + var + deps = false + + doAssert pkg.version in data, &"{pkg.name} v{pkg.version} not found" + + for line in data.splitLines(): + let + line = line.strip() + if line.nBl: + if line.startsWith('['): + if line == "[deps]": + deps = true + else: + deps = false + elif deps: + let + name = line.split()[0] + if name.endsWith("_jll"): + # Filter skipped dependencies + let + pname = name[0 .. ^5] + if pname.toLowerAscii() notin pkg.skipRequires: + pkg.requires.add newJBBPackage(pname, "") + pkg.requires[^1].skipRequires = pkg.skipRequires + +proc parseJBBArtifacts(pkg: JBBPackage, outdir: string) = + # Get build information from Artifacts.toml + let + file = outdir / jbbArtifacts + + if fileExists(file): + let + data = readFile(file) + + doAssert pkg.version in data, &"{pkg.name} v{pkg.version} not found" + + var + found = false + for line in data.splitLines(): + let + line = line.strip() + if line.nBl: + let + spl = line.split(" = ", 1) + name = spl[0] + val = if spl.len == 2: spl[1].strip(chars = {'"', ' '}) else: "" + + # Match arch, os and glibc on Linux to find download URL + case name + of "arch": + if val == pkg.arch and not found: found = true + of "os": + if val != pkg.os and found: found = false + of "libc": + when defined(Linux): + if found: + let libc = if pkg.libc.nBl: pkg.libc else: "glibc" + if val != libc: found = false + of "url": + if found: + pkg.url = val + break + else: + discard + +proc findJBBLibs(pkg: JBBPackage, outdir: string) = + pkg.sharedLibs = findFiles("(bin|lib)[\\\\/].*\\.(so|dll|dylib)[0-9.]*", outdir) + + for lib in findFiles("lib[\\\\/].*\\.(a|lib)", outdir): + if not lib.endsWith(".dll.a"): + pkg.staticLibs.add lib + +proc getJBBRepo*(pkg: JBBPackage, outdir: string) = + ## Clone JBB package repo and checkout version tag if version is + ## specified in package + let + path = outdir / "repos" / pkg.name + + if pkg.isGit: + # Get package info using Git + gitPull( + pkg.baseUrl & ("/$1_jll.jl" % pkg.name), + outdir = path, + plist = "*.toml", + "master", + quiet = true + ) + + if pkg.version.nBl: + # Checkout correct tag + let + tags = gitTags(path) + for i in tags.len - 1 .. 0: + if pkg.version in tags[i] and i != tags.len - 1: + gitCheckout(path, tags[i-1]) + else: + # Download package info from HTTP + var + url = pkg.baseUrl + if "$#" in url or "$1" in url: + doAssert pkg.version.nBl, "Need version for custom BinaryBuilder.org url: " & url + url = url % pkg.version + downloadUrl(url & "Artifacts.toml", path, quiet = true) + downloadUrl(url & "Project.toml", path, quiet = true) + + pkg.parseJBBProject(path) + pkg.parseJBBArtifacts(path) + +proc loadJBBInfo*(outdir: string): JBBPackage = + ## Load cached package info from `outdir/jbbinfo.json` + let + file = fixRelPath(outdir) / jbbInfo + + if fileExists(file): + when (NimMajor, NimMinor, NimPatch) < (1, 2, 0): + result = to[JBBPackage](readFile(file)) + else: + try: + result = to(readFile(file).parseJson(), JBBPackage) + except: + discard + +proc saveJBBInfo*(pkg: JBBPackage, outdir: string) = + ## Save downloaded package info to `outdir/jbbinfo.json` + let + file = fixRelPath(outdir) / jbbInfo + + when (NimMajor, NimMinor, NimPatch) < (1, 2, 0): + writeFile(file, $$pkg) + else: + writeFile(file, $(%pkg)) + +proc dlJBBRequires*(pkg: JBBPackage, outdir: string) +proc downloadJBB*(pkg: JBBPackage, outdir: string, main = true) = + ## Download `pkg` from BinaryBuilder.org to `outdir` + ## + ## High-level API that handles the end to end JBB process flow to find + ## latest package binary and downloads and extracts it to `outdir`. + let + outdir = fixRelPath(outdir) + + if main: + let + cpkg = loadJBBInfo(outdir) + + if cpkg == pkg: + return + + cleanDir(outdir) + + pkg.getJBBRepo(outdir) + + if pkg.url.Bl: + # No url for deps means no package for that os/arch combo - e.g. Attr + doAssert not main, &"Failed to download {pkg.name} info from BinaryBuilder.org" + return + + let + vstr = + if pkg.version.nBl: + &" v{pkg.version}" + else: + "" + path = outdir / pkg.name + gecho &"# Downloading {pkg.name}{vstr} from BinaryBuilder.org" + downloadUrl(pkg.url, path, quiet = true) + pkg.findJBBLibs(path) + + pkg.dlJBBRequires(outdir) + + if main: + pkg.saveJBBInfo(outdir) + +proc dlJBBRequires*(pkg: JBBPackage, outdir: string) = + ## Download all required dependencies of this `pkg` + let + outdir = fixRelPath(outdir) + for i in 0 ..< pkg.requires.len: + let + rpkg = pkg.requires[i] + if gJBBRequires.hasKey(rpkg.name): + # Reuse dep already downloaded + pkg.requires[i] = gJBBRequires[rpkg.name] + else: + downloadJBB(rpkg, outdir, main = false) + gJBBRequires[rpkg.name] = rpkg + +proc getJBBLDeps*(pkg: JBBPackage, outdir: string, shared: bool, main = true): seq[string] = + ## Get all BinaryBuilder.org libs - shared (.so|.dll) or static (.a|.lib) in pkg, including deps + ## in descending order + ## + ## `outdir` is prefixed to each entry + let + libs = if shared: pkg.sharedLibs else: pkg.staticLibs + str = if shared: "shared" else: "static" + + doAssert libs.nBl, &"No {str} libs found for {pkg.name} in {outdir}" + + if not main: + for lib in libs: + result.add lib + + for cpkg in pkg.requires: + # No url for deps means no package for that os/arch combo - e.g. Attr + if cpkg.url.nBl: + result.add cpkg.getJBBLDeps(outdir, shared, main = false) diff --git a/nimterop/build/misc.nim b/nimterop/build/misc.nim new file mode 100644 index 0000000..c6c0e48 --- /dev/null +++ b/nimterop/build/misc.nim @@ -0,0 +1,62 @@ +import os, strutils + +when defined(Windows): + import strformat + +import ".."/globals + +proc sanitizePath*(path: string, noQuote = false, sep = $DirSep): string = + result = path.multiReplace([("\\\\", sep), ("\\", sep), ("/", sep)]) + if not noQuote: + result = result.quoteShell + +proc getCurrentNimCompiler*(): string = + when nimvm: + result = getCurrentCompilerExe() + when defined(nimsuggest): + result = result.replace("nimsuggest", "nim") + else: + result = gState.nim + +proc compareVersions*(ver1, ver2: string): int = + ## Compare two version strings x.y.z and return -1, 0, 1 + ## + ## ver1 < ver2 = -1 + ## ver1 = ver2 = 0 + ## ver1 > ver2 = 1 + let + ver1seq = ver1.replace("-", "").split('.') + ver2seq = ver2.replace("-", "").split('.') + for i in 0 ..< ver1seq.len: + let + p1 = ver1seq[i] + p2 = if i < ver2seq.len: ver2seq[i] else: "0" + + try: + let + h1 = p1.parseHexInt() + h2 = p2.parseHexInt() + + if h1 < h2: return -1 + elif h1 > h2: return 1 + except ValueError: + if p1 < p2: return -1 + elif p1 > p2: return 1 + +proc fixCmd*(cmd: string): string = + when defined(Windows): + # Replace 'cd d:\abc' with 'd: && cd d:\abc` + var filteredCmd = cmd + if cmd.toLower().startsWith("cd"): + var + colonIndex = cmd.find(":") + driveLetter = cmd.substr(colonIndex-1, colonIndex) + if (driveLetter[0].isAlphaAscii() and + driveLetter[1] == ':' and + colonIndex == 4): + filteredCmd = &"{driveLetter} && {cmd}" + result = "cmd /c " & filteredCmd + elif defined(posix): + result = cmd + else: + doAssert false diff --git a/nimterop/build/nimconf.nim b/nimterop/build/nimconf.nim new file mode 100644 index 0000000..7624bf2 --- /dev/null +++ b/nimterop/build/nimconf.nim @@ -0,0 +1,240 @@ +import json, os, osproc, sets, strformat, strutils + +import ".."/globals +import "."/misc + +when nimvm: + when (NimMajor, NimMinor, NimPatch) >= (1, 2, 0): + import std/compilesettings + else: + import macros +else: + discard + +# Config detected with std/compilesettings or `nim dump` +type + Config* = ref object + NimMajor*: int + NimMinor*: int + NimPatch*: int + + paths*: OrderedSet[string] + nimblePaths*: OrderedSet[string] + nimcacheDir*: string + outDir*: string + +proc getJson(projectDir: string): JsonNode = + # Get `nim dump` json value for `projectDir` + var + cmd = &"{getCurrentNimCompiler()} --hints:off --dump.format:json dump dummy" + dump = "" + ret = 0 + + if projectDir.len != 0: + # Run `nim dump` in `projectDir` if specified + cmd = &"cd {projectDir.sanitizePath} && " & cmd + + cmd = fixCmd(cmd) + when nimvm: + (dump, ret) = gorgeEx(cmd) + else: + (dump, ret) = execCmdEx(cmd) + + try: + result = parseJson(dump) + except JsonParsingError as e: + gecho "# Failed to parse `nim dump` output: " & e.msg + +proc getOsCacheDir(): string = + # OS default cache directory + when defined(posix): + result = getEnv("XDG_CACHE_HOME", getHomeDir() / ".cache") / "nim" + else: + result = getHomeDir() / "nimcache" + +proc getProjectDir*(): string = + ## Get project directory for this compilation - returns `""` at runtime + when nimvm: + when (NimMajor, NimMinor, NimPatch) >= (1, 2, 0): + # If nim v1.2.0+, get from `std/compilesettings` + result = querySetting(projectFull).parentDir() + else: + # Get from `macros` + result = getProjectPath() + else: + discard + +proc stripName(path, projectName: string): string = + # Remove `pname_d|r` tail from path + let + (head, tail) = path.splitPath() + if projectName in tail: + result = head + else: + result = path + +proc jsonToSeq(node: JsonNode, key: string): seq[string] = + # Convert JsonArray to seq[string] for specified `key` + if node.hasKey(key): + for elem in node[key].getElems(): + result.add elem.getStr() + +proc getAbsoluteDir(projectDir, path: string): string = + # Path is relative to `projectDir` if not absolute + if path.isAbsolute(): + result = path + else: + result = (projectDir / path).normalizedPath() + +proc getNimConfig*(projectDir = ""): Config = + # Get `paths` - list of paths to be forwarded to Nim + result = new(Config) + var + libPath, version: string + lazyPaths, searchPaths: seq[string] + + when nimvm: + result.NimMajor = NimMajor + result.NimMinor = NimMinor + result.NimPatch = NimPatch + + when (NimMajor, NimMinor, NimPatch) >= (1, 2, 0): + # Get value at compile time from `std/compilesettings` + libPath = getCurrentCompilerExe().parentDir().parentDir() / "lib" + lazyPaths = querySettingSeq(MultipleValueSetting.lazyPaths) + searchPaths = querySettingSeq(MultipleValueSetting.searchPaths) + result.nimcacheDir = stripName( + querySetting(SingleValueSetting.nimcacheDir), + querySetting(SingleValueSetting.projectName) + ) + result.outDir = querySetting(SingleValueSetting.outDir) + else: + discard + + let + # Get project directory for < v1.2.0 at compile time + projectDir = if projectDir.len != 0: projectDir else: getProjectDir() + + # Not Nim v1.2.0+ or runtime + if libPath.len == 0: + let + dumpJson = getJson(projectDir) + + if dumpJson != nil: + if dumpJson.hasKey("version"): + version = dumpJson["version"].getStr() + lazyPaths = jsonToSeq(dumpJson, "lazyPaths") + searchPaths = jsonToSeq(dumpJson, "lib_paths") + if dumpJson.hasKey("libpath"): + libPath = dumpJson["libpath"].getStr() + elif searchPaths.len != 0: + # Usually `libPath` is last entry in `searchPaths` + libPath = searchPaths[^1] + + if dumpJson.hasKey("nimcache"): + result.nimcacheDir = stripName(dumpJson["nimcache"].getStr(), "dummy") + if dumpJson.hasKey("outdir"): + result.outDir = dumpJson["outdir"].getStr() + + # Parse version + if version.len != 0: + let + splversion = version.split({'.'}, maxsplit = 3) + result.NimMajor = splversion[0].parseInt() + result.NimMinor = splversion[1].parseInt() + result.NimPatch = splversion[2].parseInt() + + # Find non standard lib paths added to `searchPath` + for path in searchPaths: + let + path = getAbsoluteDir(projectDir, path) + if libPath notin path: + result.paths.incl path + + # Find `nimblePaths` in `lazyPaths` + for path in lazyPaths: + let + path = getAbsoluteDir(projectDir, path) + (_, tail) = path.strip(leading = false, chars = {'/', '\\'}).splitPath() + if tail == "pkgs": + # Nimble path probably + result.nimblePaths.incl path + + # Find `paths` in `lazyPaths` that aren't within `nimblePaths` + # Have to do this separately since `nimblePaths` could be after + # packages in `lazyPaths` + for path in lazyPaths: + let + path = getAbsoluteDir(projectDir, path) + var skip = false + for npath in result.nimblePaths: + if npath in path: + skip = true + break + if not skip: + result.paths.incl path + + if result.nimcacheDir.len == 0: + result.nimcacheDir = getOsCacheDir() + + if result.outDir.len == 0: + result.outDir = projectDir + +proc getNimConfigFlags(cfg: Config): string = + # Convert configuration into Nim flags for cfg file or command line + result = &"--nimcache:\"{cfg.nimcacheDir}\"\n" + + if (cfg.NimMajor, cfg.NimMinor, cfg.NimPatch) >= (1, 2, 0): + # --clearNimbleCache if Nim v1.2.0+ + result &= "--clearNimblePath\n" + + # Add `nimblePaths` if detected - v1.2.0+ + for path in cfg.nimblePaths: + result &= &"--nimblePath:\"{path}\"\n" + + # Add `paths` in all cases if any detected + for path in cfg.paths: + result &= &"--path:\"{path}\"\n" + + when defined(Windows): + result = result.replace("\\", "/") + +proc getNimConfigFlags*(projectDir = ""): string = + ## Get Nim command line configuration flags for `projectDir` + ## + ## If `projectDir` is not specified, it is detected if compile time or + ## current directory is used. + let + cfg = getNimConfig(projectDir) + cfgOut = getNimConfigFlags(cfg) + return cfgOut.replace("\n", " ") + +proc writeNimConfig*(cfgFile: string, projectDir = "") = + ## Write Nim configuration for `projectDir` to specified `cfgFile` + ## + ## If `projectDir` is not specified, it is detected if compile time or + ## current directory is used. + let + cfg = getNimConfig(projectDir) + cfgOut = getNimConfigFlags(cfg) + writeFile(cfgFile, cfgOut) + +proc getNimcacheDir*(projectDir = ""): string = + ## Get nimcache directory for current compilation or specified `projectDir` + let + cfg = getNimConfig(projectDir) + result = cfg.nimcacheDir + +proc getOutDir*(projectDir = ""): string = + ## Get output directory for current compilation or specified `projectDir` + let + cfg = getNimConfig(projectDir) + result = cfg.outDir + +proc getNimteropCacheDir*(): string = + ## Get location to cache all nimterop artifacts + result = getNimcacheDir() / "nimterop" + +proc fixRelPath*(path: string): string = + ## If `path` is relative, consider relative to `projectPath` + if path.isAbsolute: path else: getProjectDir() / path \ No newline at end of file diff --git a/nimterop/build/shell.nim b/nimterop/build/shell.nim new file mode 100644 index 0000000..7df8f15 --- /dev/null +++ b/nimterop/build/shell.nim @@ -0,0 +1,528 @@ +import hashes, osproc, sets, strformat, strutils + +when not defined(TOAST): + import os except findExe, sleep +else: + import os + +import ".."/globals +import "."/[misc, nimconf] + +when not defined(TOAST): + proc sleep*(milsecs: int) = + ## Sleep at compile time + let + cmd = + when defined(Windows): + "cmd /c timeout " + else: + "sleep " + + discard gorgeEx(cmd & $(milsecs / 1000)) +else: + export sleep + +proc execAction*(cmd: string, retry = 0, die = true, cache = false, + cacheKey = "", onRetry: proc() = nil, + onError: proc(output: string, err: int) = nil): tuple[output: string, ret: int] = + ## Execute an external command - supported at compile time + ## + ## Checks if command exits successfully before returning. If not, an + ## error is raised. Always caches results to be used in nimsuggest or nimcheck + ## mode. + ## + ## `retry` - number of times command should be retried before error + ## `die = false` - return on errors + ## `cache = true` - cache results unless cleared with -f + ## `cacheKey` - key to create unique cache entry + ## `onRetry()` - proc to call before retrying + ## `onError(output, err)` - proc to call on error + let + ccmd = fixCmd(cmd) + + when nimvm: + # Cache results for speedup if cache = true + # Else cache for preserving functionality in nimsuggest and nimcheck + let + hash = (ccmd & cacheKey).hash().abs() + cachePath = getNimteropCacheDir() / "execCache" / "nimterop_" & $hash + cacheFile = cachePath & ".txt" + retFile = cachePath & "_ret.txt" + + when defined(nimsuggest) or defined(nimcheck): + # Load results from cache file if generated in previous run + if fileExists(cacheFile) and fileExists(retFile): + result.output = cacheFile.readFile() + result.ret = retFile.readFile().parseInt() + elif die: + doAssert false, "Results not cached - run nim c/cpp at least once\n" & ccmd + else: + if cache and fileExists(cacheFile) and fileExists(retFile) and not compileOption("forceBuild"): + # Return from cache when requested + result.output = cacheFile.readFile() + result.ret = retFile.readFile().parseInt() + else: + # Execute command and store results in cache + (result.output, result.ret) = gorgeEx(ccmd) + if result.ret == 0 or die == false: + # mkdir for execCache dir (circular dependency) + let dir = cacheFile.parentDir() + if not dirExists(dir): + let flag = when not defined(Windows): "-p" else: "" + discard execAction(&"mkdir {flag} {dir.sanitizePath}") + cacheFile.writeFile(result.output) + retFile.writeFile($result.ret) + else: + # Used by toast + (result.output, result.ret) = execCmdEx(ccmd) + + # On failure, retry or die as requested + if result.ret != 0: + if retry > 0: + if not onRetry.isNil: + onRetry() + sleep(500) + result = execAction(cmd, retry = retry - 1, die, cache, cacheKey) + else: + if not onError.isNil: + onError(result.output, result.ret) + + doAssert not die, "Command failed: " & $result.ret & "\ncmd: " & ccmd & + "\nresult:\n" & result.output + +when not defined(TOAST): + proc findExe*(exe: string): string = + ## Find the specified executable using the `which`/`where` command - supported + ## at compile time + var + cmd = + when defined(Windows): + "where " & exe + else: + "which " & exe + + (output, ret) = execAction(cmd, die = false) + + if ret == 0: + return output.splitLines()[0].strip().sanitizePath +else: + export findExe + +proc mkDir*(dir: string) = + ## Create a directory at compile time + ## + ## The `os` module is not available at compile time so a few + ## crucial helper functions are included with nimterop. + if not dirExists(dir): + let + flag = when not defined(Windows): "-p" else: "" + discard execAction(&"mkdir {flag} {dir.sanitizePath}", retry = 2) + +proc cpFile*(source, dest: string, psymlink = false, move = false) = + ## Copy a file from `source` to `dest` at compile time + ## + ## `psymlink = true` preserves symlinks instead of dereferencing on posix + let + source = source.replace("/", $DirSep) + dest = dest.replace("/", $DirSep) + cmd = + when defined(Windows): + if move: + "move /y" + else: + "copy /y" + else: + if move: + "mv -f" + else: + if psymlink: + "cp -fa" + else: + "cp -f" + + discard execAction(&"{cmd} {source.sanitizePath} {dest.sanitizePath}", retry = 2) + +proc mvFile*(source, dest: string) = + ## Move a file from `source` to `dest` at compile time + cpFile(source, dest, move=true) + +proc rmFile*(source: string, dir = false) = + ## Remove a file or pattern at compile time + let + source = source.replace("/", $DirSep) + cmd = + when defined(Windows): + if dir: + "rd /s/q" + else: + "del /q/f" + else: + "rm -rf" + exists = + if dir: + dirExists(source) + else: + fileExists(source) + + if exists: + discard execAction(&"{cmd} {source.sanitizePath}", retry = 2) + +proc rmDir*(dir: string) = + ## Remove a directory or pattern at compile time + rmFile(dir, dir = true) + +proc cleanDir*(dir: string) = + ## Remove all contents of a directory at compile time + for kind, path in walkDir(dir): + if kind == pcDir: + rmDir(path) + else: + rmFile(path) + +proc cpTree*(source, dest: string, move = false) = + ## Copy contents of source dir to the destination, not the directory itself + for kind, path in walkDir(source, relative = true): + if kind == pcDir: + cpTree(source / path, dest / path, move) + if move: + rmDir(source / path) + else: + if not dirExists(dest): + mkDir(dest) + if move: + mvFile(source / path, dest / path) + else: + cpFile(source / path, dest / path) + +proc mvTree*(source, dest: string) = + ## Move contents of source dir to the destination, not the directory itself + cpTree(source, dest, move = true) + +proc getFileDate*(fullpath: string): string = + ## Get file date for `fullpath` + var + ret = 0 + cmd = + when defined(Windows): + let + (head, tail) = fullpath.splitPath() + &"forfiles /P {head.sanitizePath()} /M {tail.sanitizePath} /C \"cmd /c echo @fdate @ftime\"" + elif defined(Linux): + &"stat -c %Y {fullpath.sanitizePath}" + elif defined(OSX) or defined(FreeBSD): + &"stat -f %m {fullpath.sanitizePath}" + + (result, ret) = execAction(cmd, die=false) + +proc touchFile*(fullpath: string) = + ## Touch file to update modified date + var + cmd = + when defined(Windows): + &"cmd /c copy /b {fullpath.sanitizePath}+" + else: + &"touch {fullpath.sanitizePath}" + + discard execAction(cmd) + +proc extractZip*(zipfile, outdir: string, quiet = false) = + ## Extract a zip file using `powershell` on Windows and `unzip` on other + ## systems to the specified output directory + var cmd = "unzip -o $#" + if defined(Windows): + cmd = "powershell -nologo -noprofile -command \"& { Add-Type -A " & + "'System.IO.Compression.FileSystem'; " & + "[IO.Compression.ZipFile]::ExtractToDirectory('$#', '.'); }\"" + + if not quiet: + gecho "# Extracting " & zipfile + discard execAction(&"cd {outdir.sanitizePath} && {cmd % zipfile}") + +proc extractTar*(tarfile, outdir: string, quiet = false) = + ## Extract a tar file using `tar`, `7z` or `7za` to the specified output directory + var + cmd = "" + name = "" + + if findExe("tar").len != 0: + let + ext = tarfile.splitFile().ext.toLowerAscii() + typ = + case ext + of ".gz", ".tgz": "z" + of ".xz": "J" + of ".bz2": "j" + else: "" + + cmd = "tar xvf" & typ & " " & tarfile.sanitizePath + else: + for i in ["7z", "7za"]: + if findExe(i).len != 0: + cmd = i & " x $#" % tarfile.sanitizePath + + name = tarfile.splitFile().name + if ".tar" in name.toLowerAscii(): + cmd &= " && " & i & " x $#" % name.sanitizePath + + break + + doAssert cmd.len != 0, "No extraction tool - tar, 7z, 7za - available for " & tarfile.sanitizePath + + if not quiet: + gecho "# Extracting " & tarfile + discard execAction(&"cd {outdir.sanitizePath} && {cmd}") + if name.len != 0: + rmFile(outdir / name) + +proc downloadUrl*(url, outdir: string, quiet = false, retry = 1) = + ## Download a file using `curl` or `wget` (or `powershell` on Windows) to the specified directory + ## + ## If an archive file, it is automatically extracted after download. + let + file = url.extractFilename() + filePath = outdir / file + ext = file.splitFile().ext.toLowerAscii() + archives = @[".zip", ".xz", ".gz", ".bz2", ".tgz", ".tar"] + + if not (ext in archives and fileExists(filePath)): + if not quiet: + gecho "# Downloading " & file + mkDir(outdir) + var cmd = findExe("curl") + if cmd.len != 0: + cmd &= " -Lk $# -o $#" + else: + cmd = findExe("wget") + if cmd.len != 0: + cmd &= " $# -O $#" + elif defined(Windows): + cmd = "powershell [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; wget $# -OutFile $#" + else: + doAssert false, "No download tool available - curl, wget" + discard execAction(cmd % [url.quoteShell, (filePath).sanitizePath], retry = 3, + onRetry = proc() = rmFile(filePath)) + + if ext == ".zip": + extractZip(file, outdir, quiet) + elif ext in archives: + extractTar(file, outdir, quiet) + +proc gitReset*(outdir: string) = + ## Hard reset the git repository at the specified directory + gecho "# Resetting " & outdir + + let cmd = &"cd {outdir.sanitizePath} && git reset --hard" + while execAction(cmd).output.contains("Permission denied"): + sleep(1000) + gecho "# Retrying ..." + +proc gitCheckout*(file, outdir: string) = + ## Checkout the specified `file` in the git repository at `outdir` + ## + ## This effectively resets all changes in the file and can be + ## used to undo any changes that were made to source files to enable + ## successful wrapping with `cImport()` or `c2nImport()`. + gecho "# Resetting " & file + let file2 = file.relativePath outdir + let cmd = &"cd {outdir.sanitizePath} && git checkout {file2.sanitizePath}" + while execAction(cmd).output.contains("Permission denied"): + sleep(500) + gecho "# Retrying ..." + +proc gitAtCheckout*(outdir, checkout: string): bool = + ## Check if specified git repository is checked out to the specified + ## commit hash, tag or branch + result = checkout in execAction( + &"cd {outdir.sanitizePath} && git log --decorate --no-color -n 1 --format=oneline").output + +proc gitDefaultBranch*(outdir: string): string = + ## Get the default branch for a git repository before it is pulled + result = "master" + let + output = execAction( + &"cd {outdir.sanitizePath} && git remote show origin" + ).output + + for line in output.splitLines(): + if "HEAD branch: " in line: + result = line.split("branch: ")[1].strip() + +proc gitPull*(url: string, outdir = "", plist = "", checkout = "", quiet = false) = + ## Pull the specified git repository to the output directory + ## + ## `plist` is the list of specific files and directories or wildcards + ## to sparsely checkout. Multiple values can be specified one entry per + ## line. It is optional and if omitted, the entire repository will be + ## checked out. + ## + ## `checkout` is the git tag, branch or commit hash to checkout once + ## the repository is downloaded. This allows for pinning to a specific + ## version of the code. + let + outdirQ = outdir.sanitizePath + + if dirExists(outdir/".git"): + gitReset(outdir) + if checkout.nBl and not gitAtCheckout(outdir, checkout): + gecho &"# Updating repository to checkout {checkout}" + discard execAction( + &"cd {outdirQ} && git clean -fxd && git fetch && git checkout {checkout}", retry = 3) + return + + mkDir(outdir) + + if not quiet: + gecho "# Setting up Git repo: " & url + discard execAction(&"cd {outdirQ} && git init .") + discard execAction(&"cd {outdirQ} && git remote add origin {url}") + + if plist.len != 0: + # If a specific list of files is required, create a sparse checkout + # file for git in its config directory + let sparsefile = outdir / ".git/info/sparse-checkout" + + discard execAction(&"cd {outdirQ} && git config core.sparsecheckout true") + writeFile(sparsefile, plist) + + # In case directory has old files from another run + discard execAction(&"cd {outdirQ} && git clean -fxd") + + # Checkout specified branch/tag/commit or default branch - typically master + let + checkout = if checkout.Bl: gitDefaultBranch(outdir) else: checkout + + if not quiet: + gecho "# Checking out " & checkout + discard execAction(&"cd {outdirQ} && git fetch", retry = 3) + discard execAction(&"cd {outdirQ} && git checkout {checkout}") + +proc gitTags*(outdir: string): seq[string] = + ## Get all the git tags in the specified directory + let + cmd = &"cd {outdir.sanitizePath} && git tag" + tags = execAction(cmd).output.splitLines() + for tag in tags: + let + tag = tag.strip() + if tag.len != 0: + result.add tag + +proc loafExePath(): string = + currentSourcePath.parentDir.parentDir / ("loaf".addFileExt ExeExt) + +proc findFiles*(file: string, dir: string, recurse = true, regex = false): seq[string] = + ## Find all matching files in the specified directory + ## + ## `file` is a regular expression if `regex` is true + ## + ## Turn off recursive search with `recurse` + let + loafExe = loafExePath() + + doAssert fileExists(loafExe), "loaf not compiled: " & loafExe.sanitizePath & + " make sure 'nimble build' or 'nimble install' built it" + + var + cmd = loafExe.quoteShell & " find --rexp $1 \"$2\" $3" + recursive = if recurse: "--recurse" else: "" + + var + dir = dir + file = file + # If file = `path/file`, adjust dir = `dir/path` and search for new file + if not (recurse or regex): + let + pdir = file.parentDir() + if pdir.len != 0: + dir = dir / pdir + + file = file.extractFilename + + cmd = cmd % [recursive, (".*[\\\\/]" & file & "$"), dir.sanitizePath] + + let + (files, ret) = execAction(cmd, die = false) + if ret == 0: + for line in files.splitLines(): + if line.len != 0: + result.add line + +proc findFile*(file: string, dir: string, recurse = true, first = false, regex = false): string = + ## Find the file in the specified directory + ## + ## `file` is a regular expression if `regex` is true + ## + ## Turn off recursive search with `recurse` and stop on first match with + ## `first`. Without it, the shortest match is returned. + let + matches = findFiles(file, dir, recurse, regex) + for match in matches: + if (result.len == 0 or result.len > match.len): + result = match + if first: break + +proc linkLibs*(names: openArray[string], staticLink = true): string = + ## Create linker flags for specified libraries using pkg-config + ## + ## Prepends `lib` to the name so you only need `ssl` for `libssl`. + var + stat = if staticLink: "--static" else: "" + resSet: OrderedSet[string] + cmd = &"pkg-config --libs --silence-errors {stat}" + resSet.init() + + for name in names: + for n in ["lib" & name, name]: + # Try libname and name - e.g. MagickWand doesn't have lib + let + cmd = &"{cmd} {n}" + (libs, _) = execAction(cmd, die = false) + if libs.len != 0: + for lib in libs.split(" "): + resSet.incl lib + break + + if staticLink: + resSet.incl "--static" + + for res in resSet: + result &= " " & res + +proc getNumProcs*(): string = + ## Get number of processors + when defined(Windows): + getEnv("NUMBER_OF_PROCESSORS").strip() + elif defined(linux): + execAction("nproc").output.strip() + elif defined(macosx) or defined(FreeBSD): + execAction("sysctl -n hw.ncpu").output.strip() + else: + "1" + +proc getProjectCacheDir*(name: string, forceClean = true): string = + ## Get a cache directory where all nimterop artifacts can be stored + ## + ## Projects can use this location to download source code and build binaries + ## that can be then accessed by multiple apps. This is created under the + ## per-user Nim cache directory. + ## + ## Use `name` to specify the subdirectory name for a project. + ## + ## `forceClean` is enabled by default and effectively deletes the folder + ## if Nim is compiled with the `-f` or `--forceBuild` flag. This allows + ## any project to start out with a clean cache dir on a forced build. + ## + ## NOTE: avoid calling `getProjectCacheDir()` multiple times on the same + ## `name` when `forceClean = true` else checked out source might get deleted + ## at the wrong time during build. + ## + ## E.g. + ## `nimgit2` downloads `libgit2` source so `name = "libgit2"` + ## + ## `nimarchive` downloads `libarchive`, `bzlib`, `liblzma` and `zlib` so + ## `name = "nimarchive" / "libarchive"` for `libarchive`, etc. + result = getNimteropCacheDir() / name + + if forceClean and compileOption("forceBuild"): + gecho "# Removing " & result + rmDir(result) diff --git a/nimterop/build/tools.nim b/nimterop/build/tools.nim new file mode 100644 index 0000000..c164ffd --- /dev/null +++ b/nimterop/build/tools.nim @@ -0,0 +1,256 @@ +import strformat, strutils + +import os except findExe + +import ".."/globals +import "."/[misc, shell] + +proc configure*(path, check: string, flags = "") = + ## Run the GNU `configure` command to generate all Makefiles or other + ## build scripts in the specified path + ## + ## If a `configure` script is not present and an `autogen.sh` script + ## is present, it will be run before attempting `configure`. + ## + ## Next, if `configure.ac` or `configure.in` exist, `autoreconf` will + ## be executed. + ## + ## `check` is a file that will be generated by the `configure` command. + ## This is required to prevent configure from running on every build. It + ## is relative to the `path` and should not be an absolute path. + ## + ## `flags` are any flags that should be passed to the `configure` command. + if (path / check).fileExists(): + return + + gecho "# Configuring " & path + + if not fileExists(path / "configure"): + for i in @["autogen.sh", "build" / "autogen.sh"]: + if fileExists(path / i): + gecho "# Running autogen.sh" + + when defined(unix): + decho execAction( + &"cd {(path / i).parentDir().sanitizePath} && ./autogen.sh").output + else: + decho execAction( + &"cd {(path / i).parentDir().sanitizePath} && bash ./autogen.sh").output + + break + + if not fileExists(path / "configure"): + for i in @["configure.ac", "configure.in"]: + if fileExists(path / i): + gecho "# Running autoreconf" + + decho execAction(&"cd {path.sanitizePath} && autoreconf -fi").output + + break + + if fileExists(path / "configure"): + gecho "# Running configure " & flags + + when defined(unix): + var + cmd = &"cd {path.sanitizePath} && ./configure" + else: + var + cmd = &"cd {path.sanitizePath} && bash ./configure" + if flags.len != 0: + cmd &= &" {flags}" + + decho execAction(cmd).output + + doAssert (path / check).fileExists(), "Configure failed" + +proc getCmakePropertyStr(name, property, value: string): string = + &"\nset_target_properties({name} PROPERTIES {property} \"{value}\")\n" + +proc getCmakeIncludePath*(paths: openArray[string]): string = + ## Create a `cmake` flag to specify custom include paths + ## + ## Result can be included in the `flag` parameter for `cmake()` or + ## the `cmakeFlags` parameter for `getHeader()`. + for path in paths: + result &= path & ";" + result = " -DCMAKE_INCLUDE_PATH=" & result[0 .. ^2].sanitizePath(sep = "/") + +proc setCmakeProperty*(outdir, name, property, value: string) = + ## Set a `cmake` property in `outdir / CMakeLists.txt` - usable in the `xxxPreBuild` hook + ## for `getHeader()` + ## + ## `set_target_properties(name PROPERTIES property "value")` + let + cm = outdir / "CMakeLists.txt" + if cm.fileExists(): + cm.writeFile( + cm.readFile() & getCmakePropertyStr(name, property, value) + ) + +proc setCmakeLibName*(outdir, name, prefix = "", oname = "", suffix = "") = + ## Set a `cmake` property in `outdir / CMakeLists.txt` to specify a custom library output + ## name - usable in the `xxxPreBuild` hook for `getHeader()` + ## + ## `prefix` is typically `lib` + ## `oname` is the library name + ## `suffix` is typically `.a` + ## + ## Sometimes, `cmake` generates non-standard library names - e.g. zlib compiles to + ## `libzlibstatic.a` on Windows. This proc can help rename it to `libzlib.a` so that `getHeader()` + ## can find it after the library is compiled. + ## + ## ``` + ## set_target_properties(name PROPERTIES PREFIX "prefix") + ## set_target_properties(name PROPERTIES OUTPUT_NAME "oname") + ## set_target_properties(name PROPERTIES SUFFIX "suffix") + ## ``` + let + cm = outdir / "CMakeLists.txt" + if cm.fileExists(): + var + str = "" + if prefix.len != 0: + str &= getCmakePropertyStr(name, "PREFIX", prefix) + if oname.len != 0: + str &= getCmakePropertyStr(name, "OUTPUT_NAME", oname) + if suffix.len != 0: + str &= getCmakePropertyStr(name, "SUFFIX", suffix) + if str.len != 0: + cm.writeFile(cm.readFile() & str) + +proc setCmakePositionIndependentCode*(outdir: string) = + ## Set a `cmake` directive to create libraries with -fPIC enabled + let + cm = outdir / "CMakeLists.txt" + if cm.fileExists(): + let + pic = "set(CMAKE_POSITION_INDEPENDENT_CODE ON)" + cmd = cm.readFile() + if not cmd.contains(pic): + cm.writeFile( + pic & "\n" & cmd + ) + +proc cmake*(path, check, flags: string) = + ## Run the `cmake` command to generate all Makefiles or other + ## build scripts in the specified path + ## + ## `path` will be created since typically `cmake` is run in an + ## empty directory. + ## + ## `check` is a file that will be generated by the `cmake` command. + ## This is required to prevent `cmake` from running on every build. It + ## is relative to the `path` and should not be an absolute path. + ## + ## `flags` are any flags that should be passed to the `cmake` command. + ## Unlike `configure`, it is required since typically it will be the + ## path to the repository, typically `..` when `path` is a subdir. + if (path / check).fileExists(): + return + + gecho "# Running cmake " & flags + gecho "# Path: " & path + + mkDir(path) + + let + cmd = &"cd {path.sanitizePath} && cmake {flags}" + + decho execAction(cmd).output + + doAssert (path / check).fileExists(), "cmake failed" + +proc make*(path, check: string, flags = "", regex = false) = + ## Run the `make` command to build all binaries in the specified path + ## + ## `check` is a file that will be generated by the `make` command. + ## This is required to prevent `make` from running on every build. It + ## is relative to the `path` and should not be an absolute path. + ## + ## `flags` are any flags that should be passed to the `make` command. + ## + ## `regex` can be set to true if `check` is a regular expression. + ## + ## If `make.exe` is missing and `mingw32-make.exe` is available, it will + ## be copied over to make.exe in the same location. + if findFile(check, path, regex = regex).len != 0: + return + + gecho "# Running make " & flags + gecho "# Path: " & path + + var + cmd = findExe("make") + + if cmd.len == 0: + cmd = findExe("mingw32-make") + if cmd.len != 0: + cpFile(cmd, cmd.replace("mingw32-make", "make")) + doAssert cmd.len != 0, "Make not found" + + cmd = &"cd {path.sanitizePath} && make -j {getNumProcs()}" + if flags.len != 0: + cmd &= &" {flags}" + + decho execAction(cmd).output + + doAssert findFile(check, path, regex = regex).len != 0, "make failed" + +proc buildWithCmake*(outdir, flags: string): BuildStatus = + if not fileExists(outdir / "Makefile"): + if fileExists(outdir / "CMakeLists.txt"): + if findExe("cmake").len != 0: + var + gen = "" + when defined(Windows): + if findExe("sh").len != 0: + let + uname = execAction("sh -c uname -a").output.toLowerAscii() + if uname.contains("msys"): + gen = "MSYS Makefiles".quoteShell + elif uname.contains("mingw"): + gen = "MinGW Makefiles".quoteShell & " -DCMAKE_SH=\"CMAKE_SH-NOTFOUND\"" + else: + gecho "Unsupported system: " & uname + else: + gen = "MinGW Makefiles".quoteShell + else: + gen = "Unix Makefiles".quoteShell + if findExe("ccache").len != 0: + gen &= " -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache" + result.buildPath = outdir / "buildcache" + cmake(result.buildPath, "Makefile", &".. -G {gen} {flags}") + result.built = true + else: + result.error = "cmake capable but cmake executable missing" + else: + result.buildPath = outdir + +proc buildWithAutoConf*(outdir, flags: string): BuildStatus = + if not fileExists(outdir / "Makefile"): + if findExe("bash").len != 0: + for file in @["configure", "configure.ac", "configure.in", "autogen.sh", "build/autogen.sh"]: + if fileExists(outdir / file): + configure(outdir, "Makefile", flags) + result.buildPath = outdir + result.built = true + break + else: + result.error = "configure capable but bash executable missing" + else: + result.buildPath = outdir + +proc flagBuild*(base: string, flags: openArray[string]): string = + ## Simple helper proc to generate flags for `configure`, `cmake`, etc. + ## + ## Every entry in `flags` is replaced into the `base` string and + ## concatenated to the result. + ## + ## E.g. + ## `base = "--disable-$#"` + ## `flags = @["one", "two"]` + ## + ## `flagBuild(base, flags) => " --disable-one --disable-two"` + for i in flags: + result &= " " & base % i diff --git a/nimterop/cimport.nim b/nimterop/cimport.nim new file mode 100644 index 0000000..88aed1a --- /dev/null +++ b/nimterop/cimport.nim @@ -0,0 +1,778 @@ +import hashes, macros, os, strformat, strutils + +import "."/[globals, paths] +import "."/build/[ccompiler, misc, nimconf, shell] + +proc findPath(path: string, fail = true): string = + # Relative to project path + let + path = fixRelPath(path) + result = path.replace("\\", "/") + if not fileExists(result) and not dirExists(result): + doAssert (not fail), "File or directory not found: " & path + result = "" + +proc getCacheValue(fullpath: string): string = + if not gStateCT.nocache: + result = fullpath.getFileDate() + +proc getCacheValue(fullpaths: seq[string]): string = + if not gStateCT.nocache: + for fullpath in fullpaths: + result &= getCacheValue(fullpath) + +proc getNimCheckError(nimFile: string) = + let + (check, _) = execAction( + &"{getCurrentNimCompiler()} check {nimFile.sanitizePath}", + die = false + ) + + doAssert false, &"\n\n{check}\n\n" & + "Codegen limitation or error - review 'nim check' output above generated for " & nimFile + +proc getToast(fullpaths: seq[string], recurse: bool = false, dynlib: string = "", + mode = "c", flags = "", outFile = "", noNimout = false): string = + var + cmd = when defined(Windows): "cmd /c " else: "" + ext = "h" + + let + toastExe = toastExePath() + # see https://github.com/nimterop/nimterop/issues/69 + cacheKey = getCacheValue(toastExe) & getCacheValue(fullpaths) + + doAssert fileExists(toastExe), "toast not compiled: " & toastExe.sanitizePath & + " make sure 'nimble build' or 'nimble install' built it" + + cmd &= &"{toastExe} --preprocess -m:{mode}" + + if recurse: + cmd.add " --recurse" + + if flags.nBl: + cmd.add " " & flags + + for i in gStateCT.defines: + cmd.add &" --defines+={i.quoteShell}" + + for i in gStateCT.includeDirs: + cmd.add &" --includeDirs+={i.sanitizePath}" + + for i in gStateCT.exclude: + cmd.add &" --exclude+={i.sanitizePath}" + + for i in gStateCT.passC: + cmd.add &" --passC+={i.quoteShell}" + gStateCT.passC = @[] + + for i in gStateCT.passL: + cmd.add &" --passL+={i.quoteShell}" + gStateCT.passL = @[] + + for i in gStateCT.compile: + cmd.add &" --compile+={i.sanitizePath}" + gStateCT.compile = @[] + + if not noNimout: + cmd.add &" --pnim" + + if dynlib.nBl: + cmd.add &" --dynlib={dynlib}" + + if gStateCT.symOverride.nBl: + cmd.add &" --symOverride={gStateCT.symOverride.join(\",\")}" + + cmd.add &" --nim:{getCurrentNimCompiler().sanitizePath}" + + if gStateCT.pluginSourcePath.nBl: + cmd.add &" --pluginSourcePath={gStateCT.pluginSourcePath.sanitizePath}" + + ext = "nim" + + for fullpath in fullpaths: + cmd.add &" {fullpath.sanitizePath}" + + let + cacheFile = getNimteropCacheDir() / "toastCache" / "nimterop_" & + ($(cmd & cacheKey).hash().abs()).addFileExt(ext) + + if outFile.nBl: + result = fixRelPath(outFile) + else: + result = cacheFile + + when defined(Windows): + result = result.replace(DirSep, '/') + + let + # When to regenerate the wrapper + regen = + if gStateCT.nocache or compileOption("forceBuild"): + # No caching or forced + true + elif not fileExists(result): + # Cache or outfile doesn't exist + true + elif outFile.nBl and (not fileExists(cacheFile) or + result.getFileDate() > cacheFile.getFileDate()): + # Outfile exists but cache doesn't or outdated + true + else: + false + + if regen: + let + dir = result.parentDir() + if not dirExists(dir): + mkDir(dir) + + cmd.add &" -o {result.sanitizePath}" + + var + (output, ret) = execAction(cmd, die = false) + if ret != 0: + # If toast fails, print failure to output and delete any generated files + let errout = if result.fileExists(): result.readFile() & output else: output + rmFile(result) + doAssert false, "\n\n" & errout & "\n" + + # Write empty cache file to track changes when outFile specified + if outFile.nBl: + let dir = cacheFile.parentDir() + if not dirExists(dir): + mkdir(dir) + + writeFile(cacheFile, "") + +proc cDebug*() {.compileTime.} = + ## Enable debug messages and display the generated Nim code + gStateCT.debug = true + +proc cDisableCaching*() {.compileTime.} = + ## Disable caching of generated Nim code - useful during wrapper development + ## + ## If files included by header being processed by + ## `cImport()` change and affect the generated content, they will be ignored + ## and the cached value will continue to be used . Use `cDisableCaching()` to + ## avoid this scenario during development. + ## + ## `nim -f` can also be used to flush the cached content. + gStateCT.nocache = true + +proc cSearchPath*(path: string): string {.compileTime.} = + ## Get full path to file or directory `path` in search path configured + ## using `cAddSearchDir()` and `cAddStdDir()`. + ## + ## This can be used to locate files or directories that can be passed onto + ## `cCompile()`, `cIncludeDir()` and `cImport()`. + result = findPath(path, fail = false) + if result.Bl: + var found = false + for inc in gStateCT.searchDirs: + result = findPath(inc / path, fail = false) + if result.nBl: + found = true + break + doAssert found, "File or directory not found: " & path & + " gStateCT.searchDirs: " & $gStateCT.searchDirs + +proc cAddSearchDir*(dir: string) {.compileTime.} = + ## Add directory `dir` to the search path used in calls to + ## `cSearchPath()`. + runnableExamples: + import nimterop/paths, os + static: + cAddSearchDir testsIncludeDir() + doAssert cSearchPath("test.h").fileExists + + if dir notin gStateCT.searchDirs: + gStateCT.searchDirs.add(dir) + +proc cAddStdDir*(mode = "c") {.compileTime.} = + ## Add the standard `c` [default] or `cpp` include paths to search + ## path used in calls to `cSearchPath()`. + runnableExamples: + import os + static: + cAddStdDir() + doAssert cSearchPath("math.h").fileExists + for inc in getGccPaths(mode): + cAddSearchDir inc + +macro cDefine*(name: static[string], val: static[string] = ""): untyped = + ## `#define` an identifer that is forwarded to the C/C++ preprocessor if + ## called within `cImport()` or `c2nImport()` as well as to the C/C++ + ## compiler during Nim compilation using `{.passC: "-DXXX".}` + ## + ## This needs to be called before `cImport()` to take effect. + var str = name + if val.nBl: + str &= &"={val.quoteShell}" + + if str notin gStateCT.defines: + gStateCT.defines.add(str) + +macro cDefine*(values: static seq[string]): untyped = + ## `#define` multiple identifers that are forwarded to the C/C++ preprocessor + ## if called within `cImport()` or `c2nImport()` as well as to the C/C++ + ## compiler during Nim compilation using `{.passC: "-DXXX".}` + ## + ## This needs to be called before `cImport()` to take effect. + for value in values: + let + spl = value.split("=", maxsplit = 1) + name = spl[0] + val = if spl.len == 2: spl[1] else: "" + discard quote do: + cDefine(`name`, `val`) + +macro cIncludeDir*(dirs: static seq[string], exclude: static[bool] = false): untyped = + ## Add include directories that are forwarded to the C/C++ preprocessor if + ## called within `cImport()` or `c2nImport()` as well as to the C/C++ + ## compiler during Nim compilation using `{.passC: "-IXXX".}`. + ## + ## Set `exclude = true` if the contents of these include directories should + ## not be included in the wrapped output. + ## + ## This needs to be called before `cImport()` to take effect. + for dir in dirs: + let fullpath = findPath(dir) + if fullpath notin gStateCT.includeDirs: + gStateCT.includeDirs.add(fullpath) + if exclude: + gStateCT.exclude.add(fullpath) + +macro cIncludeDir*(dir: static[string], exclude: static[bool] = false): untyped = + ## Add an include directory that is forwarded to the C/C++ preprocessor if + ## called within `cImport()` or `c2nImport()` as well as to the C/C++ + ## compiler during Nim compilation using `{.passC: "-IXXX".}`. + ## + ## Set `exclude = true` if the contents of this include directory should + ## not be included in the wrapped output. + ## + ## This needs to be called before `cImport()` to take effect. + return quote do: + cIncludeDir(@[`dir`], `exclude` == 1) + +macro cExclude*(paths: static seq[string]): untyped = + ## Exclude specified paths - files or directories from the wrapped output + ## + ## Full path to file or directory is required. + result = newNimNode(nnkStmtList) + for path in paths: + gStateCT.exclude.add path + +macro cExclude*(path: static string): untyped = + ## Exclude specified path - file or directory from the wrapped output. + ## + ## Full path to file or directory is required. + return quote do: + cExclude(@[`path`]) + +macro cPassC*(value: static string): untyped = + ## Create a `{.passC.}` entry that gets forwarded to the C/C++ compiler + ## during Nim compilation. + ## + ## `cPassC()` needs to be called before `cImport()` to take effect and gets + ## consumed and reset so as not to impact subsequent `cImport()` calls. + gStateCT.passC.add value + +macro cPassL*(value: static string): untyped = + ## Create a `{.passL.}` entry that gets forwarded to the C/C++ compiler + ## during Nim compilation. + ## + ## `cPassL()` needs to be called before `cImport()` to take effect and gets + ## consumed and reset so as not to impact subsequent `cImport()` calls. + gStateCT.passL.add value + +macro cCompile*(path: static string, mode: static[string] = "c", exclude: static[string] = ""): untyped = + ## Compile and link C/C++ implementation into resulting binary using `{.compile.}` + ## + ## `path` can be a specific file or contain `*` wildcard for filename: + ## + ## .. code-block:: nim + ## + ## cCompile("file.c") + ## cCompile("path/to/*.c") + ## + ## `mode` recursively searches for code files in `path`. + ## + ## `c` searches for `*.c` whereas `cpp` searches for `*.C *.cpp *.c++ *.cc *.cxx` + ## + ## .. code-block:: nim + ## + ## cCompile("path/to/dir", "cpp") + ## + ## `exclude` can be used to exclude files by partial string match. Comma separated to + ## specify multiple exclude strings + ## + ## .. code-block:: nim + ## + ## cCompile("path/to/dir", exclude="test2.c") + ## + ## `cCompile()` needs to be called before `cImport()` to take effect and gets + ## consumed and reset so as not to impact subsequent `cImport()` calls. + + proc fcompile(file: string) = + let + (_, fn, ext) = file.splitFile() + var + ufn = fn + uniq = 1 + while ufn in gStateCT.compcache: + ufn = fn & $uniq + uniq += 1 + + # - https://github.com/nim-lang/Nim/issues/10299 + # - https://github.com/nim-lang/Nim/issues/10486 + gStateCT.compcache.add(ufn) + if fn == ufn: + gStateCT.compile.add file.replace("\\", "/") + else: + # - https://github.com/nim-lang/Nim/issues/9370 + let + hash = file.hash().abs() + tmpFile = file.parentDir() / &"_nimterop_{$hash}_{ufn}{ext}" + if not tmpFile.fileExists() or file.getFileDate() > tmpFile.getFileDate(): + cpFile(file, tmpFile) + gStateCT.compile.add tmpFile.replace("\\", "/") + + # Due to https://github.com/nim-lang/Nim/issues/9863 + # cannot use seq[string] for excludes + proc notExcluded(file, exclude: string): bool = + result = true + if "_nimterop_" in file: + result = false + elif exclude.nBl: + for excl in exclude.split(","): + if excl in file: + result = false + + proc dcompile(dir, exclude: string, ext="") = + let + (dir, pat) = + if "*" in dir: + dir.splitPath() + else: + (dir, "") + + for file in walkDirRec(dir): + if ext.nBl or pat.nBl: + let + fext = file.splitFile().ext + if (ext.nBl and fext != ext) or (pat.nBl and fext != pat[1 .. ^1]): + continue + if file.notExcluded(exclude): + fcompile(file) + + if "*" in path: + dcompile(path, exclude) + else: + let fpath = findPath(path) + if fileExists(fpath) and fpath.notExcluded(exclude): + fcompile(fpath) + elif dirExists(fpath): + if mode.contains("cpp"): + for i in @[".cpp", ".c++", ".cc", ".cxx"]: + dcompile(fpath, exclude, i) + when not defined(Windows): + dcompile(fpath, exclude, ".C") + else: + dcompile(fpath, exclude, ".c") + +macro renderPragma*(): untyped = + ## All `cDefine()`, `cIncludeDir()`, `cCompile()`, `cPassC()` and `cPassL()` + ## content typically gets forwarded via `cImport()` to the generated wrapper to be + ## rendered as part of the output so as to enable standalone wrappers. If `cImport()` + ## is not being used for some reason, `renderPragma()` can create these pragmas + ## in the nimterop wrapper itself. A good example is using `getHeader()` without + ## calling `cImport()`. + ## + ## `c2nImport()` already uses this macro so there's no need to use it when typically + ## wrapping headers. + result = newNimNode(nnkStmtList) + + for i in gStateCT.defines: + let str = "-D" & i + result.add quote do: + {.passC: `str`.} + + for i in gStateCT.includeDirs: + let str = &"-I{i.quoteShell}" + result.add quote do: + {.passC: `str`.} + + for i in gStateCT.passC: + result.add quote do: + {.passC: `i`.} + gStateCT.passC = @[] + + for i in gStateCT.passL: + result.add quote do: + {.passL: `i`.} + gStateCT.passL = @[] + + for i in gStateCT.compile: + result.add quote do: + {.compile: `i`.} + gStateCT.compile = @[] + +proc cSkipSymbol*(skips: seq[string]) {.compileTime.} = + ## Similar to `cOverride()`, this macro allows filtering out symbols not of + ## interest from the generated output. + ## + ## `cSkipSymbol()` only affects calls to `cImport()` that follow it. + runnableExamples: + static: cSkipSymbol @["proc1", "Type2"] + gStateCT.symOverride.add skips + +macro cOverride*(body): untyped = + ## When the wrapper code generated by nimterop is missing certain symbols or not + ## accurate, it may be required to hand wrap them. Define them in a `cOverride()` + ## macro block so that Nimterop uses these definitions instead. + ## + ## For example: + ## + ## .. code-block:: c + ## + ## int svGetCallerInfo(const char** fileName, int *lineNumber); + ## + ## This might map to: + ## + ## .. code-block:: nim + ## + ## proc svGetCallerInfo(fileName: ptr cstring; lineNumber: var cint) + ## + ## Whereas it might mean: + ## + ## .. code-block:: nim + ## + ## cOverride: + ## proc svGetCallerInfo(fileName: var cstring; lineNumber: var cint) + ## + ## Using the `cOverride()` block, nimterop can be instructed to use this + ## definition of `svGetCallerInfo()` instead. This works for procs, consts + ## and types. + ## + ## `cOverride()` only affects the next `cImport()` call. This is because any + ## recognized symbols get overridden in place and any remaining symbols get + ## added to the top. If reused, the next `cImport()` would add those symbols + ## again leading to redefinition errors. + + iterator findOverrides(node: NimNode): tuple[name, override: string, kind: NimNodeKind] = + for child in node: + case child.kind + of nnkTypeSection, nnkConstSection: + # Types, const + for inst in child: + let name = + if inst[0].kind == nnkPragmaExpr: + $inst[0][0] + else: + $inst[0] + + yield (name.strip(chars={'*'}), inst.repr, child.kind) + of nnkProcDef: + let + name = $child[0] + + yield (name.strip(chars={'*'}), child.repr, child.kind) + else: + discard + + if gStateCT.overrides.Bl: + gStateCT.overrides = """ +import sets, tables + +proc onSymbolOverride*(sym: var Symbol) {.exportc, dynlib.} = +""" + + # If cPlugin called before cOverride + if gStateCT.pluginSourcePath.nBl: + gStateCT.pluginSourcePath = "" + + var + names: seq[string] + for name, override, kind in body.findOverrides(): + let + typ = + case kind + of nnkTypeSection: "nskType" + of nnkConstSection: "nskConst" + of nnkProcDef: "nskProc" + else: "" + + gStateCT.overrides &= &""" + if sym.name == "{name}" and sym.kind == {typ} and "{name}" in cOverrides["{typ}"]: + sym.override = """ & "\"\"\"" & override & "\"\"\"\n" + + gStateCT.overrides &= &" cOverrides[\"{typ}\"].excl \"{name}\"\n" + + gStateCT.overrides = gStateCT.overrides.replace("proc onSymbolOverride", + &"cOverrides[\"{typ}\"].incl \"{name}\"\nproc onSymbolOverride") + + names.add name + + gStateCT.symOverride.add name + + if names.nBl: + decho "Overriding " & names.join(" ") + +proc cPluginHelper(body: string, imports = "import macros, nimterop/plugin\n\n") = + gStateCT.pluginSource = body + + if gStateCT.pluginSource.nBl or gStateCT.overrides.nBl: + let + data = imports & body & "\n\n" & gStateCT.overrides + hash = data.hash().abs() + path = getProjectCacheDir("cPlugins", forceClean = false) / "nimterop_" & $hash & ".nim" + + if not fileExists(path) or gStateCT.nocache or compileOption("forceBuild"): + mkDir(path.parentDir()) + writeFile(path, data) + writeNimConfig(path & ".cfg") + + doAssert fileExists(path), "Unable to write plugin file: " & path + + gStateCT.pluginSourcePath = path + +macro cPlugin*(body): untyped = + ## When `cOverride()` and `cSkipSymbol()` are not adequate, the `cPlugin()` + ## macro can be used to customize the generated Nim output. The following + ## callbacks are available at this time. + ## + ## .. code-block:: nim + ## + ## proc onSymbol(sym: var Symbol) {.exportc, dynlib.} + ## + ## `onSymbol()` can be used to handle symbol name modifications required due + ## to invalid characters in identifiers or to rename symbols that would clash + ## due to Nim's style insensitivity. The symbol name and type is provided to + ## the callback and the name can be modified. + ## + ## While `cPlugin` can easily remove leading/trailing `_` or prefixes and + ## suffixes like `SDL_`, passing `--prefix` or `--suffix` flags to `cImport` + ## in the `flags` parameter is much easier. However, these flags will only be + ## considered when no `cPlugin` is specified. + ## + ## Returning a blank name will result in the symbol being skipped. This will + ## fail for `nskParam` and `nskField` since the generated Nim code will be wrong. + ## + ## Symbol types can be any of the following: + ## - `nskConst` for constants + ## - `nskType` for type identifiers, including primitive + ## - `nskParam` for param names + ## - `nskField` for struct field names + ## - `nskEnumField` for enum (field) names, though they are in the global namespace as `nskConst` + ## - `nskProc` - for proc names + ## + ## `macros` and `nimterop/plugins` are implicitly imported to provide access to standard + ## plugin facilities. + ## + ## `cPlugin()` only affects calls to `cImport()` that follow it. + runnableExamples: + cPlugin: + import strutils + + # Strip leading and trailing underscores + proc onSymbol*(sym: var Symbol) {.exportc, dynlib.} = + sym.name = sym.name.strip(chars={'_'}) + + runnableExamples: + cPlugin: + import strutils + + # Strip prefix from procs + proc onSymbol*(sym: var Symbol) {.exportc, dynlib.} = + if sym.kind == nskProc and sym.name.contains("SDL_"): + sym.name = sym.name.replace("SDL_", "") + + cPluginHelper(body.repr) + +macro cPluginPath*(path: static[string]): untyped = + ## Rather than embedding the `cPlugin()` code within the wrapper, it might be + ## preferable to have it stored in a separate source file. This allows for reuse + ## across multiple wrappers when applicable. + ## + ## The `cPluginPath()` macro enables this functionality - specify the path to the + ## plugin file and it will be consumed in the same way as `cPlugin()`. + ## + ## `path` is relative to the current dir and not necessarily relative to the + ## location of the wrapper file. Use `currentSourcePath` to specify a path relative + ## to the wrapper file. + ## + ## Unlike `cPlugin()`, this macro also does not implicitly import any other modules + ## since the standalone plugin file will need explicit imports for `nim check` and + ## suggestions to work. `import nimterop/plugin` is required for all plugins. + doAssert fileExists(path), "Plugin file not found: " & path + cPluginHelper(readFile(path), imports = "") + +macro cImport*(filenames: static seq[string], recurse: static bool = false, dynlib: static string = "", + mode: static string = "c", flags: static string = "", nimFile: static string = ""): untyped = + ## Import multiple headers in one shot + ## + ## This macro is preferable over multiple individual `cImport()` calls, especially + ## when the headers might `#include` the same headers and result in duplicate symbols. + result = newNimNode(nnkStmtList) + + var + fullpaths: seq[string] + + for filename in filenames: + fullpaths.add findPath(filename) + + # In case cOverride called after cPlugin + if gStateCT.pluginSourcePath.Bl: + cPluginHelper(gStateCT.pluginSource) + + gecho "# Importing " & fullpaths.join(", ").sanitizePath + + let + nimFile = getToast(fullpaths, recurse, dynlib, mode, flags, nimFile) + + # Reset plugin and overrides for next cImport + if gStateCT.overrides.nBl: + gStateCT.pluginSourcePath = "" + gStateCT.overrides = "" + + if gStateCT.debug: + gecho nimFile.readFile() + + gecho "# Saved to " & nimFile + + try: + let + nimFileNode = newStrLitNode(nimFile.changeFileExt("")) + result.add quote do: + include `nimFileNode` + except: + getNimCheckError(nimFile) + +macro cImport*(filename: static string, recurse: static bool = false, dynlib: static string = "", + mode: static string = "c", flags: static string = "", nimFile: static string = ""): untyped = + ## Import all supported definitions from specified header file. Generated + ## content is cached in `nimcache` until `filename` changes unless + ## `cDisableCaching()` is set. `nim -f` can also be used to flush the cache. + ## + ## `recurse` can be used to generate Nim wrappers from `#include` files + ## referenced in `filename`. This is only done for files in the same + ## directory as `filename` or in a directory added using + ## `cIncludeDir()`. + ## + ## `dynlib` can be used to specify the Nim string to use to specify the dynamic + ## library to load the imported symbols from. For example: + ## + ## .. code-block:: nim + ## + ## const + ## dynpcre = + ## when defined(Windows): + ## when defined(cpu64): + ## "pcre64.dll" + ## else: + ## "pcre32.dll" + ## elif hostOS == "macosx": + ## "libpcre(.3|.1|).dylib" + ## else: + ## "libpcre.so(.3|.1|)" + ## + ## cImport("pcre.h", dynlib="dynpcre") + ## + ## If `dynlib` is not specified, the C/C++ implementation files can be compiled + ## in with `cCompile()`, or the `{.passL.}` pragma can be used to specify the + ## static lib to link. + ## + ## `mode` selects the preprocessor and tree-sitter parser to be used to process + ## the header. + ## + ## `flags` can be used to pass any other command line arguments to `toast`. A + ## good example would be `--prefix` and `--suffix` which strip leading and + ## trailing strings from identifiers, `_` being quite common. + ## + ## `nimFile` is the location where the generated wrapper should get written. + ## By default, the generated wrapper is written to `nimcache` and included from + ## there. `nimFile` makes it possible to write the wrapper to a predetermined + ## location which can then be directly imported into the main application and + ## checked into source control if preferred. Importing the nimterop wrapper with + ## `nimFile` specified still works per usual. If `nimFile` is not an absolute + ## path, it is relative to the project path. + ## + ## `cImport()` consumes and resets preceding `cOverride()` calls. `cPlugin()` + ## is retained for the next `cImport()` call unless a new `cPlugin()` call is + ## defined. + return quote do: + cImport(@[`filename`], bool(`recurse`), `dynlib`, `mode`, `flags`, `nimFile`) + +macro c2nImport*(filename: static string, recurse: static bool = false, dynlib: static string = "", + mode: static string = "c", flags: static string = "", nimFile: static string = ""): untyped = + ## Import all supported definitions from specified header file using `c2nim` + ## + ## Similar to `cImport()` but uses `c2nim` to generate the Nim wrapper instead + ## of `toast`. Note that neither `cOverride()`, `cSkipSymbol()` nor `cPlugin()` + ## have any impact on `c2nim`. + ## + ## `toast` is only used to preprocess the header file and `recurse` if specified. + ## + ## `mode` should be set to `cpp` for c2nim to wrap C++ headers. + ## + ## `flags` can be used to pass other command line arguments to `c2nim`. + ## + ## `nimFile` is the location where the generated wrapper should get written, + ## similar to `cImport()`. + ## + ## `nimterop` does not depend on `c2nim` as a `nimble` dependency so it does not + ## get installed automatically. Any wrapper or library that requires this proc + ## needs to install `c2nim` with `nimble install c2nim` or add it as a dependency + ## in its own `.nimble` file. + result = newNimNode(nnkStmtList) + + let + fullpath = findPath(filename) + + gecho "# Importing " & fullpath & " with c2nim" + + let + hFile = getToast(@[fullpath], recurse, dynlib, mode, noNimout = true) + nimFile = if nimFile.nBl: fixRelPath(nimFile) else: hFile.changeFileExt("nim") + header = "header" & fullpath.splitFile().name.split(seps = {'-', '.'}).join() + + if not fileExists(nimFile) or gStateCT.nocache or compileOption("forceBuild"): + var + cmd = when defined(Windows): "cmd /c " else: "" + cmd &= &"c2nim {hFile} --header:{header} --out:{nimFile.sanitizePath}" + + if dynlib.nBl: + cmd.add &" --dynlib:{dynlib}" + if mode.contains("cpp"): + cmd.add " --cpp" + if flags.nBl: + cmd.add &" {flags}" + + for i in gStateCT.defines: + cmd.add &" --assumedef:{i.quoteShell}" + + # Have to create pragmas for c2nim since toast handles this at runtime + result.add quote do: + renderPragma() + + let + (c2nimout, ret) = execAction(cmd) + if ret != 0: + rmFile(nimFile) + doAssert false, "\n\nc2nim codegen limitation or error - " & c2nimout + + nimFile.writeFile(&"const {header} = \"{fullpath}\"\n\n" & readFile(nimFile)) + + if gStateCT.debug: + gecho nimFile.readFile() + + gecho "# Saved to " & nimFile + + try: + let + nimFileNode = newStrLitNode(nimFile.changeFileExt("")) + result.add quote do: + include `nimFileNode` + except: + getNimCheckError(nimFile) diff --git a/nimterop/docs.nim b/nimterop/docs.nim new file mode 100644 index 0000000..6a5ef0c --- /dev/null +++ b/nimterop/docs.nim @@ -0,0 +1,85 @@ +import strformat + +from os import parentDir, getCurrentCompilerExe, DirSep + +when defined(nimdoc): + from os import getCurrentDir, paramCount, paramStr + +proc getNimRootDir(): string = + #[ + hack, but works + alternatively (but more complex), use (from a nim file, not nims otherwise + you get Error: ambiguous call; both system.fileExists): + import "$nim/testament/lib/stdtest/specialpaths.nim" + nimRootDir + ]# + fmt"{currentSourcePath}".parentDir.parentDir.parentDir + +const + DirSep = when defined(Windows): '\\' else: '/' + +proc execAction(cmd: string): string = + var + ccmd = "" + ret = 0 + when defined(Windows): + ccmd = "cmd /c " & cmd + elif defined(posix): + ccmd = cmd + else: + doAssert false + + (result, ret) = gorgeEx(ccmd) + doAssert ret == 0, "Command failed: " & $ret & "\ncmd: " & ccmd & "\nresult:\n" & result + +proc buildDocs*(files: openArray[string], path: string, baseDir = getCurrentDir() & $DirSep, + defines: openArray[string] = @[], nimArgs = "") = + ## Generate docs for all specified nim `files` to the specified `path` + ## + ## `baseDir` is the project path by default and `files` and `path` are relative + ## to that directory. Set to "" if using absolute paths. + ## + ## `defines` is a list of `-d:xxx` define flags (the `xxx` part) that should be passed + ## to `nim doc` so that `getHeader()` is invoked correctly. + ## + ## `nimArgs` is a string representing extra arguments to send to the `nim doc` call. + ## + ## Use the `--publish` flag with nimble to publish docs contained in + ## `path` to Github in the `gh-pages` branch. This requires the ghp-import + ## package for Python: `pip install ghp-import` + ## + ## WARNING: `--publish` will destroy any existing content in this branch. + ## + ## NOTE: `buildDocs()` only works correctly on Windows with Nim 1.0+ since + ## https://github.com/nim-lang/Nim/pull/11814 is required. + when defined(Windows) and (NimMajor, NimMinor, NimPatch) < (1, 0, 0): + echo "buildDocs() unsupported on Windows for Nim < 1.0 - requires PR #11814" + else: + let + baseDir = + if baseDir == $DirSep: + getCurrentDir() & $DirSep + else: + baseDir + path = baseDir & path + defStr = block: + var defStr = "" + for def in defines: + defStr &= " -d:" & def + defStr + nim = getCurrentCompilerExe() + for file in files: + echo execAction(&"{nim} doc {defStr} {nimArgs} -o:{path} --project --index:on {baseDir & file}") + + echo execAction(&"{nim} buildIndex {nimArgs} -o:{path}/theindex.html {path}") + when declared(getNimRootDir): + #[ + this enables doc search, works at least locally with: + cd {path} && python -m SimpleHTTPServer 9009 + ]# + echo execAction(&"{nim} js {nimArgs} -o:{path}/dochack.js {getNimRootDir()}/tools/dochack/dochack.nim") + + for i in 0 .. paramCount(): + if paramStr(i) == "--publish": + echo execAction(&"cd {path} && ghp-import --no-jekyll -fp {path}") + break \ No newline at end of file diff --git a/nimterop/enumtype.nim b/nimterop/enumtype.nim new file mode 100644 index 0000000..3c20b79 --- /dev/null +++ b/nimterop/enumtype.nim @@ -0,0 +1,42 @@ +import macros + +macro defineEnum(typ: untyped): untyped = + result = newNimNode(nnkStmtList) + + # Enum mapped to distinct cint + result.add quote do: + type `typ`* = distinct cint + + for i in ["+", "-", "*", "div", "mod", "shl", "shr", "or", "and", "xor", "<", "<=", "==", ">", ">="]: + let + ni = newIdentNode(i) + typout = if i[0] in "<=>": newIdentNode("bool") else: typ # comparisons return bool + if i[0] == '>': # cannot borrow `>` and `>=` from templates + let + nopp = if i.len == 2: newIdentNode("<=") else: newIdentNode("<") + result.add quote do: + proc `ni`*(x: `typ`, y: cint): `typout` = `nopp`(y, x) + proc `ni`*(x: cint, y: `typ`): `typout` = `nopp`(y, x) + proc `ni`*(x, y: `typ`): `typout` = `nopp`(y, x) + else: + result.add quote do: + proc `ni`*(x: `typ`, y: cint): `typout` {.borrow.} + proc `ni`*(x: cint, y: `typ`): `typout` {.borrow.} + proc `ni`*(x, y: `typ`): `typout` {.borrow.} + result.add quote do: + proc `ni`*(x: `typ`, y: int): `typout` = `ni`(x, y.cint) + proc `ni`*(x: int, y: `typ`): `typout` = `ni`(x.cint, y) + + let + divop = newIdentNode("/") # `/`() + dlrop = newIdentNode("$") # `$`() + notop = newIdentNode("not") # `not`() + result.add quote do: + proc `divop`*(x, y: `typ`): `typ` = `typ`((x.float / y.float).cint) + proc `divop`*(x: `typ`, y: cint): `typ` = `divop`(x, `typ`(y)) + proc `divop`*(x: cint, y: `typ`): `typ` = `divop`(`typ`(x), y) + proc `divop`*(x: `typ`, y: int): `typ` = `divop`(x, y.cint) + proc `divop`*(x: int, y: `typ`): `typ` = `divop`(x.cint, y) + + proc `dlrop`*(x: `typ`): string {.borrow.} + proc `notop`*(x: `typ`): `typ` {.borrow.} diff --git a/nimterop/enumtypepub.nim b/nimterop/enumtypepub.nim new file mode 100644 index 0000000..7700e30 --- /dev/null +++ b/nimterop/enumtypepub.nim @@ -0,0 +1,42 @@ +import macros + +macro defineEnum*(typ: untyped): untyped = + result = newNimNode(nnkStmtList) + + # Enum mapped to distinct cint + result.add quote do: + type `typ`* = distinct cint + + for i in ["+", "-", "*", "div", "mod", "shl", "shr", "or", "and", "xor", "<", "<=", "==", ">", ">="]: + let + ni = newIdentNode(i) + typout = if i[0] in "<=>": newIdentNode("bool") else: typ # comparisons return bool + if i[0] == '>': # cannot borrow `>` and `>=` from templates + let + nopp = if i.len == 2: newIdentNode("<=") else: newIdentNode("<") + result.add quote do: + proc `ni`*(x: `typ`, y: cint): `typout` = `nopp`(y, x) + proc `ni`*(x: cint, y: `typ`): `typout` = `nopp`(y, x) + proc `ni`*(x, y: `typ`): `typout` = `nopp`(y, x) + else: + result.add quote do: + proc `ni`*(x: `typ`, y: cint): `typout` {.borrow.} + proc `ni`*(x: cint, y: `typ`): `typout` {.borrow.} + proc `ni`*(x, y: `typ`): `typout` {.borrow.} + result.add quote do: + proc `ni`*(x: `typ`, y: int): `typout` = `ni`(x, y.cint) + proc `ni`*(x: int, y: `typ`): `typout` = `ni`(x.cint, y) + + let + divop = newIdentNode("/") # `/`() + dlrop = newIdentNode("$") # `$`() + notop = newIdentNode("not") # `not`() + result.add quote do: + proc `divop`*(x, y: `typ`): `typ` = `typ`((x.float / y.float).cint) + proc `divop`*(x: `typ`, y: cint): `typ` = `divop`(x, `typ`(y)) + proc `divop`*(x: cint, y: `typ`): `typ` = `divop`(`typ`(x), y) + proc `divop`*(x: `typ`, y: int): `typ` = `divop`(x, y.cint) + proc `divop`*(x: int, y: `typ`): `typ` = `divop`(x.cint, y) + + proc `dlrop`*(x: `typ`): string {.borrow.} + proc `notop`*(x: `typ`): `typ` {.borrow.} diff --git a/nimterop/globals.nim b/nimterop/globals.nim new file mode 100644 index 0000000..2900272 --- /dev/null +++ b/nimterop/globals.nim @@ -0,0 +1,167 @@ +import strutils, tables + +when defined(TOAST): + import sets, sequtils, strutils + + import "."/plugin + + import compiler/[ast, idents, modulegraphs, options] + + # import "."/treesitter/api + +type + Feature* = enum + ast2 + + State* = ref object + # Command line arguments to toast - some forwarded from cimport.nim + compile*: seq[string] # `--compile` to create `{.compile.}` entries in generated wrapper + convention*: string # `--convention | -C` to change calling convention from cdecl default + debug*: bool # `cDebug()` or `--debug | -d` to enable debug mode + defines*: seq[string] # Symbols added by `cDefine()` and `--define | -D` for C/C++ preprocessor/compiler + dynlib*: string # `cImport(dynlib)` or `--dynlib | -l` to specify variable containing library name + exclude*: seq[string] # files or directories to exclude from the wrapped output + feature*: seq[Feature] # `--feature | -f` feature flags enabled + includeDirs*: seq[string] # Paths added by `cIncludeDir()` and `--includeDirs | -I` for C/C++ preprocessor/compiler + mode*: string # `cImport(mode)` or `--mode | -m` to override detected compiler mode - c or cpp + nim*: string # `--nim` to specify full path to Nim compiler + noComments*: bool # `--noComments | -c` to disable rendering comments in wrappers + noHeader*: bool # `--noHeader | -H` to skip {.header.} pragma in wrapper + passC*: seq[string] # `--passC` to create `{.passC.}` entries in the generated wrapper + passL*: seq[string] # `--passL` to create `{.passL.}` entries in the generated wrapper + past*: bool # `--past | -a` to print tree-sitter AST of code + pluginSourcePath*: string # `--pluginSourcePath` specified path to plugin file to compile and load + pnim*: bool # `--pnim | -n` to render Nim wrapper for header + preprocess*: bool # `--preprocess | -p` to enable preprocessing of code before wrapping + prefix*: seq[string] # `--prefix` strings to strip from start of identifiers + recurse*: bool # `--recurse | -r` to recurse into #include files in headers specified + replace*: OrderedTableRef[string, string] + # `--replace | -G` replacement rules for identifiers + suffix*: seq[string] # `--suffix` strings to strip from end of identifiers + symOverride*: seq[string] # `cSkipSymbol()`, `cOverride()` and `--symOverride | -O` symbols to skip during wrapping + typeMap*: TableRef[string, string] + # `--typeMap | -T` to map instances of type X to Y - e.g. ABC=cint + + when defined(TOAST): + # Data fields + code*: string # Contents of header file currently being processed + currentHeader*: string # Const name of header being currently processed + impShort*: string # Short base name for pragma in output + outputHandle*: File # `--output | -o` open file handle + sourceFile*: string # Full path of header being currently processed + + # Plugin callbacks + onSymbol*, onSymbolOverride*: OnSymbol + onSymbolOverrideFinal*: OnSymbolOverrideFinal + + # Symbol tables + constIdentifiers*: HashSet[string] # Const names for enum casting + identifiers*: TableRef[string, string] # Symbols that have been declared so far indexed by nimName + skippedSyms*: HashSet[string] # Symbols that have been skipped due to being unwrappable or + # the user provided override is blank + headersProcessed*: HashSet[string] # Headers already processed directly or recursively + + # Nim compiler objects + constSection*, enumSection*, pragmaSection*, procSection*, typeSection*, varSection*: PNode + identCache*: IdentCache + config*: ConfigRef + graph*: ModuleGraph + + # Table of symbols to generated AST PNode - used to implement forward declarations + identifierNodes*: TableRef[string, PNode] + + # Used for the exprparser.nim module + currentExpr*, currentTyCastName*: string + # Controls whether or not the current expression + # should validate idents against currently defined idents + skipIdentValidation*: bool + + # Top level header for wrapper output - include imported types, pragmas and other info + wrapperHeader*: string + else: + # cimport.nim specific + compcache*: seq[string] # `cCompile()` list of files already processed + nocache*: bool # `cDisableCaching()` to disable caching of artifacts + overrides*: string # `cOverride()` code which gets added to `cPlugin()` output + pluginSource*: string # `cPlugin()` generated code to write to plugin file from + searchDirs*: seq[string] # `cSearchPath()` added directories for header search + + BuildType* = enum + btAutoconf, btCmake + + BuildStatus* = object + built*: bool + buildPath*: string + error*: string + +when nimvm: + var + gStateCT* {.compileTime, used.} = new(State) +else: + var + gState*: State + +when defined(TOAST): + const + gAtoms* {.used.} = @[ + "field_identifier", + "identifier", + "number_literal", + "char_literal", + "preproc_arg", + "primitive_type", + "sized_type_specifier", + "type_identifier" + ].toHashSet() + + gExpressions* {.used.} = @[ + "parenthesized_expression", + "bitwise_expression", + "shift_expression", + "math_expression", + "escape_sequence", + "binary_expression", + "unary_expression" + ].toHashSet() + + gEnumVals* {.used.} = @[ + "identifier", + "number_literal", + "char_literal" + ].concat(toSeq(gExpressions.items)) + + type + Status* = enum + success, unknown, error + +template getCommented*(str: string): string = + "\n# " & str.strip().replace("\n", "\n# ") + +# Redirect output to file when required +template gecho*(args: string) = + when defined(TOAST): + when nimvm: + echo args + else: + if gState.outputHandle.isNil: + echo args + else: + gState.outputHandle.writeLine(args) + else: + echo args + +template decho*(args: varargs[string, `$`]): untyped = + let + str = join(args, "") + when defined(TOAST): + if gState.debug: + gecho str.getCommented() + else: + if gStateCT.debug: + echo str.getCommented() + +template nBl*(s: typed): untyped {.used.} = + (s.len != 0) + +template Bl*(s: typed): untyped {.used.} = + (s.len == 0) \ No newline at end of file diff --git a/nimterop/loaf.nim b/nimterop/loaf.nim new file mode 100644 index 0000000..04b377e --- /dev/null +++ b/nimterop/loaf.nim @@ -0,0 +1,39 @@ +import system except find + +import os + +import cligen + +import strutils except find +import regex except find + +proc findRec(dir: string, pattern: string | Regex, recurse: bool) = + for kind, path in walkDir(dir): + if kind in [pcDir, pcLinkToDir]: + if recurse: findRec(path, pattern, recurse) + elif pattern in path: + echo path.absolutePath() + +proc find(recurse = false, rexp = false, args: seq[string]) = + var + pat = "" + rpat: Regex + for arg in args: + if not arg.startsWith("-"): + if dirExists(arg): + if rexp: + findRec(arg, rpat, recurse) + else: + findRec(arg, pat, recurse) + else: + pat = arg + if rexp: rpat = re(arg) + +when isMainModule: + dispatchMulti([ + find, help = { + "recurse": "recursive search", + "rexp": "patterns are regular expressions", + "args": "pattern1 dir1 dir2 pattern2 dir3 ..." + } + ]) diff --git a/nimterop/paths.nim b/nimterop/paths.nim new file mode 100644 index 0000000..b336d46 --- /dev/null +++ b/nimterop/paths.nim @@ -0,0 +1,18 @@ +import os + +import "."/build/shell + +const + cacheDir* = getProjectCacheDir("nimterop", forceClean = false) + +proc nimteropRoot*(): string = + currentSourcePath.parentDir.parentDir + +proc nimteropSrcDir*(): string = + nimteropRoot() / "nimterop" + +proc toastExePath*(): string = + nimteropSrcDir() / ("toast".addFileExt ExeExt) + +proc testsIncludeDir*(): string = + nimteropRoot() / "tests" / "include" diff --git a/nimterop/plugin.nim b/nimterop/plugin.nim new file mode 100644 index 0000000..20d7b78 --- /dev/null +++ b/nimterop/plugin.nim @@ -0,0 +1,22 @@ +import macros, sets, tables + +type + Symbol* = object + name*: string + parent*: string + kind*: NimSymKind + override*: string + StringHash = HashSet[string] + OnSymbol* = proc(sym: var Symbol) {.cdecl.} + OnSymbolOverrideFinal* = proc(typ: string): StringHash {.cdecl.} + +var + cOverrides*: Table[string, StringHash] + +cOverrides = initTable[string, StringHash]() +cOverrides["nskType"] = StringHash() +cOverrides["nskConst"] = StringHash() +cOverrides["nskProc"] = StringHash() + +proc onSymbolOverrideFinal*(typ: string): StringHash {.exportc, dynlib.} = + result = cOverrides[typ] diff --git a/nimterop/setup.nim b/nimterop/setup.nim new file mode 100644 index 0000000..6da1358 --- /dev/null +++ b/nimterop/setup.nim @@ -0,0 +1,43 @@ +import os, strutils + +import "."/[paths] +import "."/build/[shell] + +proc treesitterSetup*() = + gitPull("https://github.com/tree-sitter/tree-sitter", cacheDir / "treesitter", """ +lib/include/* +lib/src/* +""", "0.16.8") + + let + tbase = cacheDir / "treesitter" / "lib" + stack = tbase / "src" / "stack.c" + parser = tbase / "include" / "tree_sitter" / "parser.h" + tparser = parser.replace("parser", "tparser") + language = tbase / "src" / "language.h" + lexer = tbase / "src" / "lexer.h" + subtree = tbase / "src" / "subtree.h" + + stack.writeFile(stack.readFile().replace("inline Stack", "Stack")) + + # parser.h + mvFile(parser, tparser) + language.writeFile(language.readFile().replace("parser.h", "tparser.h")) + lexer.writeFile(lexer.readFile().replace("parser.h", "tparser.h")) + subtree.writeFile(subtree.readFile().replace("parser.h", "tparser.h")) + +proc treesitterCSetup*() = + gitPull("https://github.com/tree-sitter/tree-sitter-c", cacheDir / "treesitter_c", """ +src/*.h +src/*.c +src/*.cc +src/tree_sitter/parser.h +""", "0.16.1") + +proc treesitterCppSetup*() = + gitPull("https://github.com/tree-sitter/tree-sitter-cpp", cacheDir / "treesitter_cpp", """ +src/*.h +src/*.c +src/*.cc +src/tree_sitter/parser.h +""", "v0.16.0") diff --git a/nimterop/toast.nim b/nimterop/toast.nim new file mode 100644 index 0000000..8695216 --- /dev/null +++ b/nimterop/toast.nim @@ -0,0 +1,278 @@ +import os, osproc, sets, strformat, strutils, tables, times + +import "."/treesitter/[api, c, cpp] + +import "."/[globals] + +import "."/toastlib/[ast2, getters, tshelp] + +import "."/build/[ccompiler, misc] + +var + # Output generated before main() is called + preMainOut = "" + +proc process(gState: State, path: string) = + doAssert fileExists(path), &"Invalid path {path}" + + if gState.mode.Bl: + gState.mode = getCompilerMode(path) + + if gState.preprocess: + gState.getPreprocessor(path) + else: + gState.code = readFile(path) + + withCodeAst(gState.code, gState.mode): + if gState.past: + gecho gState.printLisp(root) + elif gState.pnim: + parseNim(gState, path, root) + elif gState.preprocess: + gecho gState.code + +# CLI processing with default values +proc main( + check = false, + compile: seq[string] = @[], + convention = "cdecl", + debug = false, + defines: seq[string] = @[], + dynlib: string = "", + exclude: seq[string] = @[], + feature: seq[Feature] = @[], + includeDirs: seq[string] = @[], + mode = "", + nim: string = "nim", + noComments = false, + noHeader = false, + output = "", + passC: seq[string] = @[], + passL: seq[string] = @[], + past = false, + pluginSourcePath: string = "", + pnim = false, + prefix: seq[string] = @[], + preprocess = false, + recurse = false, + replace: seq[string] = @[], + stub = false, + suffix: seq[string] = @[], + symOverride: seq[string] = @[], + typeMap: seq[string] = @[], + source: seq[string] + ) = + + # Setup global state with arguments + gState = State( + compile: compile, + convention: convention, + debug: debug, + defines: defines, + dynlib: dynlib, + exclude: exclude, + feature: feature, + includeDirs: includeDirs, + mode: mode, + nim: nim.sanitizePath, + noComments: noComments, + noHeader: noHeader, + passC: passC, + passL: passL, + past: past, + pluginSourcePath: pluginSourcePath, + pnim: pnim, + prefix: prefix, + preprocess: preprocess, + recurse: recurse, + replace: newOrderedTable[string, string](), + suffix: suffix, + symOverride: symOverride + ) + + # Split some arguments with , + gState.symOverride = gState.symOverride.getSplitComma() + gState.prefix = gState.prefix.getSplitComma() + gState.suffix = gState.suffix.getSplitComma() + + # Replace => Table + for i in replace.getSplitComma(): + let + nv = i.split("=", maxsplit = 1) + name = nv[0] + value = if nv.len == 2: nv[1] else: "" + gState.replace[name] = value + + # typeMap => getters.gTypeMap + for i in typeMap.getSplitComma(): + let + nv = i.split("=", maxsplit = 1) + doAssert nv.len == 2, "`--typeMap` requires X=Y format" + gTypeMap[nv[0]] = nv[1] + gTypeMapValues.incl nv[1] + + if pluginSourcePath.nBl: + gState.loadPlugin(pluginSourcePath) + + var + outputFile = output + check = check or stub + + # Fix output file extention for Nim mode + if outputFile.len != 0 and pnim: + if outputFile.splitFile().ext != ".nim": + outputFile = outputFile & ".nim" + + # Check needs a file + if check and outputFile.len == 0: + outputFile = getTempDir() / "toast_" & ($getTime().toUnix()).addFileExt("nim") + + # Recurse implies preprocess + if gState.recurse: + gState.preprocess = true + + # Redirect output to file + if outputFile.len != 0: + doAssert gState.outputHandle.open(outputFile, fmWrite), + &"Failed to write to {outputFile}" + + decho &"# Writing output to {outputFile}\n" + + if source.nBl: + # Print source after preprocess or Nim output + if gState.pnim: + gecho preMainOut + gState.initNim() + for src in source: + let + src = src.expandSymlinkAbs() + if src notin gState.headersProcessed: + gState.process(src) + gState.headersProcessed.incl src + if gState.pnim: + printNim(gState) + + # Close outputFile + if outputFile.len != 0: + gState.outputHandle.close() + + # Check Nim output + if gState.pnim and check: + # Run nim check on generated wrapper + var + (check, err) = execCmdEx(&"{gState.nim} check {outputFile}") + if err != 0: + # Failed check so try stubbing + if stub: + # Find undeclared identifiers in error + var + data = "" + stubData = "" + for line in check.splitLines: + if "undeclared identifier" in line: + try: + # Add stub of object type + stubData &= " " & line.split("'")[1] & " = object\n" + except: + discard + + # Include in wrapper file + data = outputFile.readFile() + let + idx = data.find("\ntype\n") + if idx != -1: + # In first existing type block + data = data[0 ..< idx+6] & stubData & data[idx+6 .. ^1] + else: + # At the top if none already + data = "type\n" & stubData & data + outputFile.writeFile(data) + + # Rerun nim check on stubbed wrapper + (check, err) = execCmdEx(&"{gState.nim} check {outputFile}") + doAssert err == 0, data & "\n# Nim check with stub failed:\n\n" & check + else: + doAssert err == 0, outputFile.readFile() & "\n# Nim check failed:\n\n" & check + + # Print wrapper if temporarily redirected to file + if check and output.len == 0: + stdout.write outputFile.readFile() + +proc mergeParams(cmdNames: seq[string], cmdLine = commandLineParams()): seq[string] = + # Load command-line params from `source` if it is a .cfg file + if cmdNames.len != 0: + # https://github.com/c-blake/cligen/issues/149 + for param in cmdLine: + if param.fileExists() and param.splitFile().ext == ".cfg": + preMainOut &= &"# Loading flags from '{param}'\n" + for line in param.readFile().splitLines(): + let + line = line.strip() + if line.len > 1 and line[0] != '#': + result.add line.parseCmdLine() + else: + result.add param + + if result.len != 0 and "-h" notin result and "--help" notin result: + preMainOut &= &"""# Generated @ {$now()} +# Command line: +# {getAppFilename()} {result.join(" ")} +""" + else: + result = cmdLine + +when isMainModule: + # Setup cligen command line help and short flags + import cligen + dispatch(main, help = { + "check": "check generated wrapper with compiler", + "compile": "create {.compile.} entries in generated wrapper", + "convention": "calling convention for wrapped procs", + "debug": "enable debug output", + "defines": "definitions to pass to preprocessor", + "dynlib": "{.dynlib.} pragma to import symbols - Nim const string or file path", + "exclude": "files or directories to exclude from the wrapped output", + "feature": "flags to enable experimental features", + "includeDirs": "include directory to pass to preprocessor", + "mode": "language parser: c or cpp", + "nim": "use a particular Nim executable", + "noComments": "exclude top-level comments from output", + "noHeader": "skip {.header.} pragma in wrapper", + "output": "file to output content - default: stdout", + "passC": "create {.passC.} entries in generated wrapper", + "passL": "create {.passL.} entries in generated wrapper", + "past": "print AST output", + "pluginSourcePath": "nim file to build and load as a plugin", + "pnim": "print Nim output", + "prefix": "strip prefix from identifiers", + "preprocess": "run preprocessor on header", + "recurse": "process #include files - implies --preprocess", + "replace": "replace X with Y in identifiers, X1=Y1,X2=Y2, @X for regex", + "source" : "C/C++ source/header(s) and command line file(s)", + "stub": "stub out undefined type references as objects", + "suffix": "strip suffix from identifiers", + "symOverride": "skip generating specified symbols", + "typeMap": "map instances of type X to Y - e.g. ABC=cint" + }, short = { + "check": 'k', + "convention": 'C', + "debug": 'd', + "defines": 'D', + "dynlib": 'l', + "exclude": 'X', + "feature": 'f', + "includeDirs": 'I', + "noComments": 'c', + "noHeader": 'H', + "output": 'o', + "past": 'a', + "pnim": 'n', + "prefix": 'E', + "preprocess": 'p', + "recurse": 'r', + "replace": 'G', + "stub": 's', + "suffix": 'F', + "symOverride": 'O', + "typeMap": 'T' + }) diff --git a/nimterop/toast.nims b/nimterop/toast.nims new file mode 100644 index 0000000..e67a881 --- /dev/null +++ b/nimterop/toast.nims @@ -0,0 +1,30 @@ +import os + +# Workaround for C++ scanner.cc causing link error with other C obj files +switch("clang.linkerexe", "clang++") +switch("gcc.linkerexe", "g++") + +# Workaround for NilAccessError crash on Windows #98 +# Could also help for OSX/Linux crash +switch("gc", "markAndSweep") + +# Retain stackTrace for clear errors +switch("stackTrace", "on") +switch("lineTrace", "on") + +# Path to compiler +switch("path", "$nim") + +# Case objects +when not defined(danger): + switch("define", "nimOldCaseObjects") + +# Prevent outdir override +switch("out", currentSourcePath.parentDir() / "toast".addFileExt(ExeExt)) + +# Define TOAST for globals.nim +switch("define", "TOAST") + +# Static for Windows - #248 +when defined(Windows): + switch("passL", "-static") diff --git a/nimterop/toastlib/ast2.nim b/nimterop/toastlib/ast2.nim new file mode 100644 index 0000000..bea6ff6 --- /dev/null +++ b/nimterop/toastlib/ast2.nim @@ -0,0 +1,1965 @@ +import macros, os, sequtils, sets, strformat, strutils, tables, times + +import compiler/[ast, idents, lineinfos, modulegraphs, msgs, options, renderer] + +import ".."/[globals, treesitter/api] + +import "."/[comphelp, exprparser, getters, tshelp] + +proc getOverrideOrSkip(gState: State, node: TSNode, origname: string, kind: NimSymKind): PNode = + # Check if symbol `origname` of `kind` and `origname` has any cOverride defined + # and use that if present + # + # If not, symbol needs to be skipped - only get here if `name` is blank + let + # Get cleaned name for symbol, set parent so that cOverride is ignored + name = gState.getIdentifier(origname, kind, parent = "IgnoreSkipSymbol") + + override = gState.getOverride(origname, kind) + + var + skind = getKeyword(kind) & " " + if override.nBl: + if kind == nskProc: + skind = "" + let + pnode = gState.parseString(skind & override.replace(origname, name)) + if not pnode.isNil: + result = pnode[0][0] + else: + gecho &"# {skind}'{origname}' skipped" + gState.skippedSyms.incl origname + +proc addOverrideFinal(gState: State, kind: NimSymKind) = + # Add all unused cOverride symbols for `kind` to AST + var + syms = gState.getOverrideFinal(kind) + skind = getKeyword(kind) & "\n" + if kind == nskProc: + skind = "" + + if syms.nBl: + var + nsyms = gState.parseString(skind & syms) + if not nsyms.isNil: + let + list = + if kind == nskProc: + nsyms.sons + else: + nsyms[0].sons + case kind + of nskConst: + gState.constSection.sons.insert(list, 0) + of nskType: + gState.typeSection.sons.insert(list, 0) + of nskProc: + gState.procSection.sons.insert(list, 0) + else: + discard + +proc addAllOverrideFinal(gState: State) = + # Add all unused cOverride symbols to AST + for kind in [nskConst, nskType, nskProc]: + gState.addOverrideFinal(kind) + +proc newConstDef(gState: State, node: TSNode, fname = "", fval = ""): PNode = + # Create an nkConstDef PNode + # + # If `fname` or `fval` are set, use them as name and val + let + origname = + if fname.nBl: + fname + else: + # node[0] = identifier = const name + gState.getNodeVal(node.getAtom()) + + name = gState.getIdentifier(origname, nskConst) + info = gState.getLineInfo(node) + ident = gState.getIdent(name, info) + + # node[1] = preproc_arg = value + val = + if fval.nBl: + fval + else: + gState.getNodeVal(node[1]) + + var valident = newNode(nkNone) + + withCodeAst(val, gState.mode): + # This section is a hack for determining that the first + # node is a type, which shouldn't be accepted by a const + # def section. Need to replace this with some other mechanism + # to handle type aliases + var maybeTyNode: TSNode + # Take the very first node, which may be 2 levels + # down if there is an error node + if root.len > 0 and root[0].getName() == "ERROR": + maybeTyNode = root[0][0] + elif root.len > 0: + maybeTyNode = root[0] + + if not maybeTyNode.isNil: + let name = maybeTyNode.getName() + case name + of "type_descriptor", "sized_type_specifier", "primitive_type", "type_identifier": + discard + else: + # Can't do gState.parseCExpression(root) here for some reason? + # get a SEGFAULT if we use root + valident = gState.parseCExpression(val) + + if name.Bl: + # Name skipped or overridden since blank + result = gState.getOverrideOrSkip(node, origname, nskConst) + elif valident.kind != nkNone: + if gState.addNewIdentifer(name): + # const X* = Y + # + # nkConstDef( + # nkPostfix( + # nkIdent("*"), + # nkIdent("X") + # ), + # nkEmpty(), + # nkXLit(Y) + # ) + result = newNode(nkConstDef) + result.add ident + result.add newNode(nkEmpty) + if valident.kind == nkStmtList and valident.len == 1: + # Collapse single line statement + result.add valident[0] + else: + result.add valident + # In case symbol was skipped earlier + gState.skippedSyms.excl origname + else: + decho &"const '{origname}' is duplicate, skipped" + else: + gecho &"# const '{origname}' has unsupported value '{val.strip()}'" + gState.skippedSyms.incl origname + +proc addConst(gState: State, node: TSNode) = + # Add a const to the AST + # + # #define X Y + # + # (preproc_def + # (identifier) + # (preproc_arg) + # ) + decho("addConst()") + gState.printDebug(node) + + if node[0].getName() == "identifier" and + node[1].getName() == "preproc_arg": + let + constDef = gState.newConstDef(node) + + if not constDef.isNil: + # nkConstSection.add + gState.constSection.add constDef + gState.constIdentifiers.incl constDef.getIdentName() + + gState.printDebug(constDef) + +proc addPragma(gState: State, node: TSNode, pragma: PNode, name: string, value: PNode = nil) = + # Add pragma to an existing nkPragma tree + let + pinfo = gState.getLineInfo(node.getAtom()) + pident = gState.getIdent(name, pinfo, exported = false) + + if value.isNil: + pragma.add pident + else: + let + colExpr = newNode(nkExprColonExpr) + colExpr.add pident + colExpr.add value + pragma.add colExpr + +proc addPragma(gState: State, node: TSNode, pragma: PNode, pragmas: seq[string]) = + # Add sequence of pragmas to an existing nkPragma tree + for name in pragmas: + gState.addPragma(node, pragma, name) + +proc addPragma(gState: State, node: TSNode, pragma: PNode, pragmas: OrderedTable[string, PNode]) = + # Add a table of name:value pragmas to an existing nkPragma tree + for name, value in pragmas.pairs: + gState.addPragma(node, pragma, name, value) + +proc newPragma(gState: State, node: TSNode, name: string, value: PNode = nil): PNode = + # Create nkPragma tree for name:value + # + # {.name1, name2: value2.} + # + # nkPragma( + # nkIdent(name1), + # nkExprColonExpr( + # nkIdent(name2), + # nkStrLit(value2) + # ) + # ) + result = newNode(nkPragma) + gState.addPragma(node, result, name, value) + +proc newPragma(gState: State, node: TSNode, pragmas: seq[string] | OrderedTable[string, PNode]): PNode = + # Create nkPragma tree for multiple name:value + result = newNode(nkPragma) + gState.addPragma(node, result, pragmas) + +proc newPragmaExpr(gState: State, node: TSNode, ident: PNode, name: string, value: PNode = nil): PNode = + # Create nkPragmaExpr tree for name:value + # + # nkPragmaExpr( + # nkPostfix( + # nkIdent("*"), + # nkIdent("X") + # ), + # nkPragma( + # nkIdent(name1), + # nkExprColonExpr( + # nkIdent(name2), + # nkStrLit(value2) + # ) + # ) + # ) + result = newNode(nkPragmaExpr) + result.add ident + result.add gState.newPragma(node, name, value) + +proc newPragmaExpr(gState: State, node: TSNode, ident: PNode, pragmas: seq[string] | OrderedTable[string, PNode]): PNode = + # Create nkPragmaExpr tree for multiple name:value + result = newNode(nkPragmaExpr) + result.add ident + result.add gState.newPragma(node, pragmas) + +proc newXIdent(gState: State, node: TSNode, kind = nskType, fname = "", pragmas: seq[string] = @[], istype = false): PNode = + # Create nkTypeDef PNode with first ident if `nskType` + # Create nkIdentDefs PNode with first ident if `nskVar` + # Create an nkPostfix node for `nskProc` + # + # If `fname`, use it instead of node.getAtom() for name + # If `pragmas`, add as nkPragmaExpr but not for `nskProc` since procs add pragmas elsewhere + # If `istype` is set, this is a typedef, else struct/union so add {.importc: "struct/union X".} + # when `not noHeader` + let + atom = node.getAtom() + + (tname, torigname, info) = + if not atom.isNil: + gState.getNameInfo(atom, kind) + else: + ("", "", gState.getLineInfo(node)) + + origname = + if fname.nBl: + fname + else: + torigname + + # Process name if forced, getNameInfo() already runs getIdentifier() + name = + if fname.nBl: + gState.getIdentifier(fname, kind) + else: + tname + + ident = gState.getIdent(name, info) + + if name.Bl: + # Name skipped or overridden since blank + result = gState.getOverrideOrSkip(node, origname, kind) + elif name notin gTypeMapValues and gState.addNewIdentifer(name): + # Add only if not an existing Nim type + + if kind == nskType: + # type name* = + # + # nkTypeDef( + # nkPostfix( + # nkIdent("*"), + # nkIdent(name) + # ), + # nkEmpty() + # ) + # + # type name* {.bycopy, importc: "abc".} = + # + # nkTypeDef( + # nkPragmaExpr( + # nkPostfix( + # nkIdent("*"), + # nkIdent(name) + # ), + # nkPragma( + # nkIdent("bycopy"), + # nkExprColonExpr( + # nkIdent("importc"), + # nkStrLit("abc") + # ) + # ) + # ), + # nkEmpty() + # ) + var + pragmas = + if not gState.noHeader: + # Need to add header and importc + if istype and name == origname: + # Neither struct/union nor name change + pragmas & "importc" & (gState.impShort & "Hdr") + else: + # Add header shortcut, additional pragmas added later + pragmas & (gState.impShort & "Hdr") + else: + pragmas + + prident = + if pragmas.nBl: + gState.newPragmaExpr(node, ident, pragmas) + else: + ident + + if not gState.noHeader: + if not istype or name != origname: + # Add importc pragma since either struct/union or name changed + let + uors = + if not istype: + if "union" in pragmas: + "union " + else: + "struct " + else: + "" + gState.addPragma(node, prident[1], "importc", newStrNode(nkStrLit, &"{uors}{origname}")) + + result = newNode(nkTypeDef) + result.add prident + result.add newNode(nkEmpty) + elif kind == nskVar: + # Used by `addVar()` for regular vars and proc vars + # + # name* {.importc: "abc".} + # + # nkPragmaExpr( + # nkPostfix( + # nkIdent("*"), + # nkIdent(name) + # ), + # nkPragma( + # nkExprColonExpr( + # nkIdent("importc"), + # nkStrLit("abc") + # ) + # ) + # ) + result = block: + var + prident: PNode + # Add {.importc.} pragma + if name != origname: + # Name changed + prident = gState.newPragmaExpr(node, ident, "importc", newStrNode(nkStrLit, &"{origname}")) + else: + prident = gState.newPragmaExpr(node, ident, "importc") + + if gState.dynlib.nBl: + # Add {.dynlib.} + gState.addPragma(node, prident[1], gState.impShort & "Dyn") + elif not gState.noHeader: + # Add {.header.} + gState.addPragma(node, prident[1], gState.impShort & "Hdr") + + if pragmas.nBl: + gState.addPragma(node, prident[1], pragmas) + prident + elif kind == nskProc: + # name* + # + # nkPostfix( + # nkIdent("*"), + # nkIdent(name) + # ) + # + # No pragmas here since proc pragmas are elsewhere in the AST + result = ident + + gState.identifierNodes[name] = result + else: + decho &"{getKeyword(kind)} '{origname}' is duplicate, skipped" + +proc newArrayTree(gState: State, node: TSNode, typ, size: PNode = nil): PNode = + # Create nkBracketExpr tree depending on input + # + # If `size` is nil, create UncheckedArray[typ] + let + info = gState.getLineInfo(node.getAtom()) + tname = + if size.isNil: + "UncheckedArray" + else: + "array" + ident = gState.getIdent(tname, info, exported = false) + + # array[size, typ] + # + # nkBracketExpr( + # nkIdent("array"), + # size, + # typ + # ) + result = newNode(nkBracketExpr) + result.add ident + if not size.isNil: + result.add size + result.add typ + +proc getTypeArray(gState: State, node: TSNode, tident: PNode, name: string): PNode +proc getTypeProc(gState: State, name: string, node, rnode: TSNode): PNode + +proc getTypeAndStart(gState: State, name: string, node: TSNode, ftname = ""): + tuple[tname: string, tinfo: TLineInfo, tident: PNode, start: int] = + # Shortcut to get start node and type info from first node + # + # `name` is the parent type or proc + # + # If `ftname` is set, use it as the type name instead + result.start = getStartAtom(node) + + let + # node[start] - param type + (tname0, _, tinfo) = gState.getNameInfo(node[result.start].getAtom(), nskType, parent = name) + + # Override type name + result.tname = + if ftname.nBl: + ftname + else: + tname0 + + result.tinfo = tinfo + result.tident = gState.getIdent(result.tname, tinfo, exported = false) + +proc newIdentDef(gState: State, name: string, node: TSNode, tname: string, tinfo: TLineInfo, tident: PNode, + start, offset, poffset: SomeInteger, exported = false): PNode = + # Create nkIdentDefs tree for specified proc parameter, object field or var/proc var + # + # `name` is the parent type or proc - if blank, this is a var so add pragmas + # `tname`, `tinfo` and `tident` are the type info for the node + # `start` is the `node` child where type is located + # `offset` is the nth `node` child where specified param/field/var is located - from `addVar()` + # `poffset` is the param number and used for unnamed params in procs - from `newIdentDefs()` iterator + # `isvar` when true adds pragmas + # + # pname: [ptr ..] typ + # + # nkIdentDefs( + # nkIdent(pname), + # typ, + # nkEmpty() + # ) + # + # For objects and vars/proc vars, field should be exported + # + # pname*: [ptr ..] typ + # + # nkIdentDefs( + # nkPostfix( + # nkIdent("*"), + # nkIdent(pname) + # ), + # typ, + # nkEmpty() + # ) + result = newNode(nkIdentDefs) + + let + fdecl = node[offset].firstChildInTree("function_declarator") + afdecl = node[offset].firstChildInTree("abstract_function_declarator") + adecl = node[offset].firstChildInTree("array_declarator") + abst = node[offset].getName() == "abstract_pointer_declarator" + if fdecl.isNil and afdecl.isNil and adecl.isNil: + if abst: + # Only for proc with no named param with pointer type + # Create a param name based on poffset + # + # int func(char *, int **); + let + pname = "a" & $(poffset+1) + pident = gState.getIdent(pname, tinfo, exported) + acount = node[offset].getXCount("abstract_pointer_declarator") + result.add pident + result.add gState.newPtrTree(acount, tident) + result.add newNode(nkEmpty) + else: + # Named param, simple type + if name.nBl: + # Types and procs - `newIdentDefs()` iterator + let + (pname, _, pinfo) = gState.getNameInfo(node[offset].getAtom(), nskField, parent = name) + pident = gState.getIdent(pname, pinfo, exported) + + # Bitfield support - typedef struct { int field: 1; }; + prident = + if node.len > offset and node[offset + 1].getName() == "bitfield_clause": + gState.newPragmaExpr(node, pident, "bitsize", + newIntNode(nkIntLit, parseInt(gState.getNodeVal(node[offset + 1].getAtom())))) + else: + pident + + result.add prident + else: + # Vars - `addVar()` + let + pident = gState.newXIdent(node[offset], nskVar) + if pident.isNil: + return nil + + result.add pident + + let + # Could be parenthesized + count = node[offset].getAtom().tsNodeParent().getPtrCount(reverse = true) + if count > 0: + result.add gState.newPtrTree(count, tident) + else: + result.add tident + result.add newNode(nkEmpty) + elif not fdecl.isNil: + # Named param, function pointer + var + name = name + pident: PNode + if name.nBl: + # Types and procs - `newIdentDefs()` iterator + let + (pname, _, pinfo) = gState.getNameInfo(node[offset].getAtom(), nskField, parent = name) + pident = gState.getIdent(pname, pinfo, exported) + else: + # Vars - `addVar()` + pident = gState.newXIdent(node[offset], nskVar) + if pident.isNil: + return nil + # The var is the parent + name = pident.getIdentName() + + result.add pident + result.add gState.getTypeProc(name, node[offset], node[start]) + result.add newNode(nkEmpty) + elif not afdecl.isNil: + # Only for proc with no named param with function pointer type + # Create a param name based on poffset + # + # int func(int (*)(int *)); + let + pname = "a" & $(poffset+1) + pident = gState.getIdent(pname, tinfo, exported) + procTy = gState.getTypeProc(name, node[offset], node[start]) + result.add pident + result.add procTy + result.add newNode(nkEmpty) + elif not adecl.isNil: + # Named param, array type + var + name = name + pident: PNode + if name.nBl: + # Types and procs - `newIdentDefs()` iterator + let + (pname, _, pinfo) = gState.getNameInfo(node[offset].getAtom(), nskField, parent = name) + pident = gState.getIdent(pname, pinfo, exported) + else: + # Vars - `addVar()` + pident = gState.newXIdent(node[offset], nskVar) + if pident.isNil: + return nil + # The var is the parent + name = pident.getIdentName() + + result.add pident + result.add gState.getTypeArray(node[offset], tident, name) + result.add newNode(nkEmpty) + else: + result = nil + +iterator newIdentDefs(gState: State, name: string, node: TSNode, offset: SomeInteger, ftname = "", exported = false): PNode = + # Create nkIdentDefs tree for specified proc parameter or object field + # + # `name` is the parent type or proc + # `offset` is the param number and used for unnamed params in procs + # + # For proc, param should not be `exported` + # + # If `ftname` is set, use it as the type name + # + # Iterator since structs can have multiple comma separated fields for the + # same type so can yield multiple results. + # + # struct ABC { int w, h; }; + # + # This is not applicable for procs. + let + (tname, tinfo, tident, start0) = gState.getTypeAndStart(name, node, ftname) + + # Skip qualifiers after type + var + start = start0 + while start < node.len - 1 and node[start+1].getName() in ["type_qualifier", "comment"]: + start += 1 + + if start == node.len - 1: + # Only for proc with no named param - create a param name based on offset + # + # int func(char, int); + var + result = newNode(nkIdentDefs) + + if tname != "object": + let + pname = "a" & $(offset+1) + pident = gState.getIdent(pname, tinfo, exported) + result.add pident + result.add tident + result.add newNode(nkEmpty) + else: + # int func(void) + result = nil + + yield result + else: + for i in start+1 ..< node.len: + if node[i].getName() in ["bitfield_clause", "comment"]: + continue + yield gState.newIdentDef(name, node, tname, tinfo, tident, start, i, offset, exported) + +proc newFormalParams(gState: State, name: string, node: TSNode, rtyp: PNode): PNode = + # Create nkFormalParams tree for specified params and return type + # + # proc(pname: ptyp ..): rtyp + # + # nkFormalParams( + # rtyp, + # nkIdentDefs( # multiple depending on params + # .. + # ) + # ) + result = newNode(nkFormalParams) + + # Add return type + result.add rtyp + + if not node.isNil: + for i in 0 ..< node.len: + if node[i].getName() == "parameter_declaration": + # Add nkIdentDefs for each param + for param in gState.newIdentDefs(name, node[i], i, exported = false): + if not param.isNil: + result.add param + +proc newProcTy(gState: State, name: string, node: TSNode, rtyp: PNode): PNode = + # Create nkProcTy tree for specified proc type + + # proc(pname: ptyp ..): rtyp + # + # nkProcTy( + # nkFormalParams( + # rtyp, + # nkIdentDefs( # multiple depending on params + # .. + # ) + # ), + # nkPragma(...) + # ) + result = newNode(nkProcTy) + result.add gState.newFormalParams(name, node, rtyp) + result.add gState.newPragma(node, gState.convention) + + # Add varargs if ... + if node.getVarargs(): + gState.addPragma(node, result[^1], "varargs") + +proc processNode(gState: State, node: TSNode): Status +proc newRecListTree(gState: State, name: string, node: TSNode): PNode = + # Create nkRecList tree for specified object + if not node.isNil: + # fname*: ftyp + # .. + # + # nkRecList( + # nkIdentDefs( # multiple depending on fields + # .. + # ) + # ) + result = newNode(nkRecList) + + for i in 0 ..< node.len: + if node[i].getName() == "field_declaration": + # Check for nested structs / unions / enums + let + fdecl = node[i].anyChildInTree("field_declaration_list") + edecl = node[i].anyChildInTree("enumerator_list") + commentNodes = gState.getCommentNodes(node[i]) + + # Check if struct/union field is anonymous + isNamedField = block: + var found = false + if not fdecl.isNil: + var sibling = fdecl.tsNodeParent().tsNodeNextNamedSibling() + while not sibling.isNil and sibling.getName() != "field_identifier": + sibling = sibling.tsNodeNextNamedSibling() + if not sibling.isNil: + found = true + found + + # `tname` is name of nested struct / union / enum just + # added, passed on as type name for field in `newIdentDefs()` + (processed, tname) = + if not fdecl.isNil: + # Nested struct / union + ( + gState.processNode(fdecl.tsNodeParent()), + gState.typeSection[^1].getIdentName() + ) + elif not edecl.isNil: + # Nested enum + ( + gState.processNode(edecl.tsNodeParent()), + $gState.enumSection[^1][0][1] + ) + else: + (success, "") + + if processed != success: + return nil + + if not fdecl.isNil and not isNamedField: + # Since anonymous, add fields directly to this struct/union + + # nkTypeDef( <= last + # nkPragmaExpr( + # .. + # ), + # nkEmpty(), + # nkObjectTy( <= last[2] + # nkEmpty(), + # nkEmpty(), + # nkRecList( <= last[2][2] + # nkIdentDefs( <= field1 + # .. + # ), + # nkIdentDefs( <= field2 + # .. + # ) + # ) + # ) + # ) + let + last = gState.typeSection[^1] + obj = + if last.len > 2 and last[2].kind == nkObjectTy: + last[2] + else: nil + recList = + if not obj.isNil and obj.len > 2 and obj[2].kind == nkRecList: + obj[2] + else: nil + + if not recList.isNil: + for identdef in recList: + result.add identdef + gState.typeSection.sons.del(gState.typeSection.len-1) + else: + # Add nkIdentDefs for each field + for field in gState.newIdentDefs(name, node[i], i, ftname = tname, exported = true): + if not field.isNil: + field.comment = gState.getCommentsStr(commentNodes) + result.add field + +proc addTypeObject(gState: State, node: TSNode, typeDef: PNode = nil, fname = "", istype = false, union = false) = + # Add a type of object + # + # If `typeDef` is set, use it instead of creating new PNode + # If `fname` is set, use it as the name when creating new PNode + # If `istype` is set, this is a typedef, else struct/union + decho("addTypeObject()") + let commentNodes = gState.getCommentNodes(node.tsNodeParent()) + + let + # Object has fields or not + fdlist = node.anyChildInTree("field_declaration_list") + + pragmas = block: + var pragmas = + if union: + @["union"] + else: + @[] + if not fdlist.isNil and fdlist.len > 0: + # Object with fields should be bycopy + pragmas.add "bycopy" + else: + # Incomplete, might get forward declared + pragmas.add "incompleteStruct" + + pragmas + + fname = + if not node.firstChildInTree("field_declaration_list").isNil and + node.tsNodeParent().getName() == "field_declaration": + # If nested struct / union without a name + gState.getUniqueIdentifier( + if union: "Union" else: "Type" + ) + else: + fname + + typeDefExisting = not typeDef.isNil + + typeDef = + if typeDef.isNil: + gState.newXIdent(node, fname = fname, pragmas = pragmas, istype = istype) + else: + typeDef + + if not typeDef.isNil: + # type X* = object + # + # nkTypeDef( + # nkPostfix( + # nkIdent("*"), + # nkIdent("X") + # ), + # nkEmpty(), + # nkObjectTy( + # nkEmpty(), + # nkEmpty(), + # nkEmpty() + # ) + # ) + # + # type + # X* {.bycopy.} = object + # field1*: cint + # + # nkTypeDef( + # nkPragmaExpr( + # nkPostfix( + # nkIdent("*"), + # nkIdent("X") + # ), + # nkPragma( + # nkIdent("bycopy") + # ) + # ), + # nkEmpty(), + # nkObjectTy( + # nkEmpty(), + # nkEmpty(), + # nkRecList( + # nkIdentDefs( + # nkPostfix( + # nkIdent("*"), + # nkIdent("field1") + # ), + # nkIdent("cint"), + # nkEmpty() + # ) + # ) + # ) + # ) + let + name = typeDef.getIdentName() + obj = newNode(nkObjectTy) + obj.add newNode(nkEmpty) + obj.add newNode(nkEmpty) + + if not fdlist.isNil and fdlist.len > 0: + # Add fields to object if present + let + fields = gState.newRecListTree(name, fdlist) + if fields.isNil: + return + obj.add fields + else: + obj.add newNode(nkEmpty) + + typeDef.add obj + + # If typeDef was passed in, need to add pragmas if any + if pragmas.nBl and typeDefExisting: + if typeDef[0].kind != nkPragmaExpr: + let + npexpr = gState.newPragmaExpr(node, typedef[0], pragmas) + typedef[0] = npexpr + else: + # `not gState.noHeader` already added pragmas in newXIdent() + gState.addPragma(node, typeDef[0][1], pragmas) + + # nkTypeSection.add + typeDef.comment = gState.getCommentsStr(commentNodes) + gState.typeSection.add typeDef + + gState.printDebug(typeDef) + else: + # Forward declaration case + let + fdlist = node.anyChildInTree("field_declaration_list") + if not fdlist.isNil and fdlist.len > 0: + # Current node has fields + let + origname = gState.getNodeVal(node.getAtom()) + commentNodes = gState.getCommentNodes(node) + + # Fix issue #185 + name = + if origname.nBl: + gState.getIdentifier(origname, nskType) + else: + "" + + if name.nBl and gState.identifierNodes.hasKey(name): + let + def = gState.identifierNodes[name] + def.comment = gState.getCommentsStr(commentNodes) + + # Duplicate nkTypeDef for `name` with empty fields + if def.kind == nkTypeDef and def.len == 3 and + def[2].kind == nkObjectTy and def[2].len == 3 and + def[2][2].kind == nkEmpty: + # Add fields to existing object + let + fields = gState.newRecListTree(name, fdlist) + if fields.isNil: + return + def[2][2] = fields + + # Change incompleteStruct to bycopy pragma + if def[0].kind == nkPragmaExpr and def[0].len == 2 and + def[0][1].kind == nkPragma and def[0][1].len > 0: + for i in 0 ..< def[0][1].len: + if $def[0][1][i] == "incompleteStruct": + def[0][1][i] = gState.getIdent( + "bycopy", gState.getLineInfo(node.getAtom()), + exported = false + ) + + gState.printDebug(def) + +proc addTypeTyped(gState: State, node: TSNode, ftname = "", offset = 0) = + # Add a type of a specified type + # + # If `ftname` is set, use it as the type name + # If `offset` is set, skip `offset` names, since created already + decho("addTypeTyped()") + let + start = getStartAtom(node) + commentNodes = gState.getCommentNodes(node) + for i in start+1+offset ..< node.len: + # Add a type of a specific type + let + # node[i] = identifer = name + typeDef = gState.newXIdent(node[i], istype = true) + + if not typeDef.isNil: + typeDef.comment = gState.getCommentsStr(commentNodes) + let + name = typeDef.getIdentName() + + # node[start] = identifier = type name + (tname0, _, tinfo) = gState.getNameInfo(node[start].getAtom(), nskType, parent = name) + + # Override type name + tname = + if ftname.nBl: + ftname + else: + tname0 + + ident = gState.getIdent(tname, tinfo, exported = false) + + # node[i] could have nested pointers + count = node[i].getPtrCount() + + # Skip typedef X X; + if name != tname: + if count > 0: + # If pointers + typeDef.add gState.newPtrTree(count, ident) + else: + typeDef.add ident + + # type X* = [ptr ..] Y + # + # nkTypeDef( + # nkPostfix( + # nkIdent("*"), + # nkIdent("X") + # ), + # nkEmpty(), + # nkPtrTy( # optional, nested + # nkIdent("Y") + # ) + # ) + + # nkTypeSection.add + gState.typeSection.add typeDef + + gState.printDebug(typeDef) + else: + gState.addTypeObject(node, typeDef = typeDef, istype = true) + +proc getTypeArray(gState: State, node: TSNode, tident: PNode, name: string): PNode = + # Create array type tree + # + # `tident` is type PNode + let + # Top-most array declarator + adecl = node.firstChildInTree("array_declarator") + + # node could have nested arrays + acount = adecl.getArrayCount() + innermost = adecl.mostNestedChildInTree() + + # node could have nested pointers - type + tcount = node.getPtrCount() + + # Name could be nested pointer to array + # + # (.. + # (array_declarator + # (parenthesized_declarator + # (pointer_declarator .. + # (pointer_declarator <- search upwards from atom + # (type_identifier) <- atom + # ) + # ) + # ) + # ) + # ) + ncount = innermost[0].getAtom().tsNodeParent().getPtrCount(reverse = true) + + result = tident + var + cnode = adecl + + if tcount > 0: + # If pointers + result = gState.newPtrTree(tcount, result) + + for i in 0 ..< acount: + if cnode.len == 2: + # type name[X] => array[X, type] + let + # Size of array could be a Nim expression + size = gState.parseCExpression(gState.getNodeVal(cnode[1]), skipIdentValidation = true) + + result = gState.newArrayTree(cnode, result, size) + cnode = cnode[0] + elif cnode.len == 1: + # type name[] = UncheckedArray[type] + result = gState.newArrayTree(cnode, result) + cnode = cnode[0] + + if ncount > 0: + result = gState.newPtrTree(ncount, result) + +proc addTypeArray(gState: State, node: TSNode) = + # Add a type of array type + decho("addTypeArray()") + let + (_, _, tident, start) = gState.getTypeAndStart("addTypeArray", node) + + commentNodes = gState.getCommentNodes(node) + + # Could have multiple types, comma separated + for i in start+1 ..< node.len: + let + # node[i] = identifer = name + typeDef = gState.newXIdent(node[i], istype = true) + + if not typeDef.isNil: + let + name = typeDef.getIdentName() + typ = gState.getTypeArray(node[i], tident, name) + + typeDef.add typ + + # type X* = [ptr] array[x, [ptr] Y] + # + # nkTypeDef( + # nkPostfix( + # nkIdent("*"), + # nkIdent("X") + # ), + # nkEmpty(), + # nkPtrTy( # optional, nested + # nkBracketExpr( + # nkIdent("array") + # nkXLit(x), + # nkPtrTy( # optional, nested + # nkIdent("Y") + # ) + # ) + # ) + # ) + + typeDef.comment = gState.getCommentsStr(commentNodes) + # nkTypeSection.add + gState.typeSection.add typeDef + + gState.printDebug(typeDef) + +proc getTypeProc(gState: State, name: string, node, rnode: TSNode): PNode = + # Create proc type tree + # + # `name` is the parent type or proc + # `rnode` is the return type + let + # rnode = identifier = return type name + (rname, _, rinfo) = gState.getNameInfo(rnode.getAtom(), nskType, parent = name) + + # Parameter list + plist = node.anyChildInTree("parameter_list") + + # node could have nested pointers + tcount = node.getPtrCount() + + # Nameless function pointer + afdecl = node.firstChildInTree("abstract_function_declarator") + + # Name could be nested pointer to function + # + # (.. + # (function_declarator + # (parenthesized_declarator + # (pointer_declarator .. + # (pointer_declarator <- search upwards from atom + # (type_identifier) <- atom + # ) + # ) + # ) + # ) + # ) + ncount = + if not afdecl.isNil: + # Pointer to function pointer + if afdecl[0].getName() == "abstract_parenthesized_declarator": + afdecl[0][0].getXCount("abstract_pointer_declarator") + else: + afdecl[0].getXCount("abstract_pointer_declarator") + else: + node.getAtom().tsNodeParent().getPtrCount(reverse = true) + + # Return type + var + retType = + if rname == "object" and tcount == 0: + # void (*func)(..) + newNode(nkEmpty) + else: + gState.getIdent(rname, rinfo, exported = false) + if tcount > 0: + retType = gState.newPtrTree(tcount, retType) + + # Proc with return type and params + result = gState.newProcTy(name, plist, retType) + if ncount > 1: + result = gState.newPtrTree(ncount-1, result) + +proc addTypeProc(gState: State, node: TSNode) = + # Add a type of proc type + decho("addTypeProc()") + let + start = getStartAtom(node) + + # node[start] = return type + rnode = node[start] + + # Could have multiple types, comma separated + for i in start+1 ..< node.len: + let + # node[i] = identifier = name + typeDef = gState.newXIdent(node[i], istype = true) + + if not typeDef.isNil: + let + name = typeDef.getIdentName() + + procTy = gState.getTypeProc(name, node[i], rnode) + + typeDef.add procTy + + # type X* = proc(a1: Y, a2: Z): P + # + # nkTypeDef( + # nkPostfix( + # nkIdent("*"), + # nkIdent("X") + # ), + # nkEmpty(), + # nkPtrTy( # optional, nested + # nkProcTy( + # nkFormalParams( + # nkPtrTy( # optional, nested + # nkIdent(retType) + # ), + # nkIdentDefs( + # nkIdent(param), + # nkPtrTy( + # nkIdent(ptype) + # ), + # nkEmpty() + # ), + # ... + # ), + # nkPragma(...) + # ) + # ) + # ) + + # nkTypeSection.add + gState.typeSection.add typeDef + + gState.printDebug(typeDef) + +proc addType(gState: State, node: TSNode, union = false) = + decho("addType()") + gState.printDebug(node) + + if node.getName() in ["struct_specifier", "union_specifier"]: + # struct X; + # + # (struct_specifier + # (type_identifier) + # ) + # + # struct X {}; + # + # (struct_specifier + # (type_identifier) + # (field_declaration_list = "{}") + # ) + # + # struct X { char *a1; }; + # + # (struct_specifier + # (type_identifier) + # (field_declaration_list + # (field_declaration + # (type_identifier|primitive_type|) + # (struct_specifier + # (type_identifier) + # ) + # + # (field_identifier) + # ) + # (field_declaration ...) + # ) + decho("addType(): case 1") + gState.addTypeObject(node, union = union) + elif node.getName() == "type_definition": + if node.len >= 2: + let + fdlist = node[0].anyChildInTree("field_declaration_list") + if (fdlist.isNil or (not fdlist.isNil and fdlist.Bl)) and + gState.getNodeVal(node[1]) == "": + # typedef struct X; + # + # (type_definition + # (struct_specifier + # (type_identifier) + # ) + # (type_definition = "") + # ) + # + # typedef struct X {}; + # + # (type_definition + # (struct_specifier + # (type_identifier) + # (field_declaration_list = "{}") + # ) + # (type_definition = "") + # ) + decho("addType(): case 2") + gState.addTypeObject(node[0], union = union) + else: + let + start = node.getStartAtom() + fdecl = node[start+1].anyChildInTree("function_declarator") + adecl = node[start+1].anyChildInTree("array_declarator") + if fdlist.isNil: + if adecl.isNil and fdecl.isNil: + # typedef X Y; + # typedef X *Y; + # typedef struct X Y; + # typedef struct X *Y; + # + # (type_definition + # (type_qualifier?) + # (type_identifier|primitive_type|) + # (struct_specifier + # (type_identifier) + # ) + # + # (pointer_declarator - optional, nested + # (type_identifier) + # ) + # ) + decho("addType(): case 3") + gState.addTypeTyped(node) + elif not fdecl.isNil: + # typedef X (*Y)(a1, a2, a3); + # typedef X *(*Y)(a1, a2, a3); + # typedef struct X (*Y)(a1, a2, a3); + # typedef struct X *(*Y)(a1, a2, a3); + # + # (type_definition + # (type_qualifier?) + # (type_identifier|primitive_type|) + # (struct_specifier + # (type_identifier) + # ) + # + # (pointer_declarator - optional, nested + # (function_declarator + # (parenthesized_declarator + # (pointer_declarator + # (type_identifer) + # ) + # ) + # (parameter_list + # (parameter_declaration + # (struct_specifier|type_identifier|primitive_type|array_declarator|function_declarator) + # (identifier - optional) + # ) + # ) + # ) + # ) + # ) + decho("addType(): case 4") + gState.addTypeProc(node) + elif not adecl.isNil: + # typedef struct X Y[a][..]; + # typedef struct X *Y[a][..]; + # typedef struct X *(*Y)[a][..]; + # + # (type_definition + # (type_qualifier?) + # (type_identifier|primitive_type|) + # (struct_specifier + # (type_identifier) + # ) + # + # (pointer_declarator - optional, nested + # (array_declarator - nested + # (pointer_declarator - optional, nested + # (type_identifier) + # ) + # (number_literal) + # ) + # ) + # ) + decho("addType(): case 5") + gState.addTypeArray(node) + else: + if node.firstChildInTree("field_declaration_list").isNil: + # typedef struct X { .. } Y, *Z; + # + # (type_definition + # (struct_specifier + # (type_identifier) - named struct <==== + # (field_declaration_list + # (field_declaration - optional, multiple + # (type_identifier|primitive_type|) + # (function_declarator|array_declarator + # .. + # ) + # + # (field_identifier) + # ) + # ) + # ) + # + # (type_identifier) + # (pointer_declarator - optional, nested + # (type_identifier) + # ) + # ) + + # First add struct as object + decho("addType(): case 6") + gState.addTypeObject(node[start], union = union) + + if node.len > start+1 and gState.getNodeVal(node[start+1]) != "": + # Add any additional names + gState.addTypeTyped(node) + else: + # Same as above except unnamed struct + # + # typedef struct { .. } Y, *Z; + + # Get any name that isn't a pointer + decho("addType(): case 7") + let + name = block: + var + name = "" + for i in start+1 ..< node.len: + if node[i].getName() == "type_identifier": + name = gState.getNodeVal(node[i].getAtom()) + + name + + # Now add struct as object with specified name + gState.addTypeObject(node[start], fname = name, istype = true, union = union) + + if name.nBl: + # Add any additional names + gState.addTypeTyped(node, ftname = name, offset = 1) + +proc addEnum(gState: State, node: TSNode) = + decho("addEnum()") + gState.printDebug(node) + + let + enumlist = node.anyChildInTree("enumerator_list") + if not enumlist.isNil: + var + name, origname = "" + offset = 0 + prev = "" + + if node.getAtom().getName() == "type_identifier": + # [typedef] enum X {} Y; + # Use X as name + origname = gState.getNodeVal(node.getAtom()) + elif node.getName() == "type_definition" and node.len > 1: + # typedef enum {} Y; + # Use Y as name + origname = gState.getNodeVal(node[1].getAtom()) + offset = 1 + + if origname.nBl: + name = gState.getIdentifier(origname, nskType) + else: + # enum {}; + # Nameless so create a name + name = gState.getUniqueIdentifier("Enum") + + if name.Bl: + # Name skipped or overridden since blank + let + eoverride = gState.getOverrideOrSkip(node, origname, nskType) + if not eoverride.isNil: + gState.typeSection.add eoverride + elif gState.addNewIdentifer(name): + # Add enum definition and helpers + let defineNode = gState.parseString(&"defineEnum({name})") + # nkStmtList( + # nkCall( + # nkIdent("defineEnum"), + # nkIdent(name) <- set the comment here + # ) + # ) + defineNode[0][1].comment = gState.getCommentsStr(gState.getCommentNodes(node)) + gState.enumSection.add defineNode + + # Create const for fields + var + fnames: HashSet[string] + # Hold all of field information so that we can add all of them + # after the const identifiers has been updated + fieldDeclarations: seq[tuple[fname, forigname, fval, cexpr: string, comment: seq[TSNode]]] + for i in 0 .. enumlist.len - 1: + let + en = enumlist[i] + if en.getName() == "comment": + continue + + let + atom = en.getAtom() + commentNodes = gState.getCommentNodes(en) + forigname = gState.getNodeVal(atom) + fname = gState.getIdentifier(forigname, nskEnumField) + + if fname.nBl and gState.addNewIdentifer(fname): + var + fval = "" + if prev.Bl: + # Starting default value + fval = &"(0)" + else: + # One greater than previous + fval = &"({prev} + 1)" + + if en.len > 1 and en[1].getName() in gEnumVals: + # Enum value specified, evaluate later, don't use calculated value + fieldDeclarations.add((fname, forigname, "", gState.getNodeVal(en[1]), commentNodes)) + else: + # Set calculated value + fieldDeclarations.add((fname, forigname, fval, "", commentNodes)) + + fnames.incl fname + prev = fname + + # Add fields to list of consts after processing enum so that we don't cast + # enum field to itself + gState.constIdentifiers.incl fnames + + # parseCExpression requires all const identifiers to be present for the enum + for (fname, forigname, fval, cexpr, commentNodes) in fieldDeclarations: + let + fval = block: + var fval = fval + if fval.Bl: + # Evaluate enum value from expression + fval = &"({$gState.parseCExpression(cexpr, name)})" + if origname.nBl: + # Named enum so cast to type - #236 + fval &= &".{name}" + else: + # Cast to cint to match underlying type + fval &= ".cint" + fval + + # Cannot use newConstDef() since parseString(fval) adds backticks to and/or + constNode = gState.parseString(&"const {fname}* = {fval}")[0][0] + + constNode.comment = gState.getCommentsStr(commentNodes) + gState.constSection.add constNode + # In case symbol was skipped earlier + gState.skippedSyms.excl forigname + + # Add other names + if node.getName() == "type_definition" and node.len > 1: + gState.addTypeTyped(node, ftname = name, offset = offset) + + if gEnumMacro.nBl: + # Add enum generation macro once + gState.wrapperHeader &= gEnumMacro + gEnumMacro = "" + +proc addProc(gState: State, node, rnode: TSNode, commentNodes: seq[TSNode]) = + # Add a proc + # + # `node` is the `nth` child of (declaration) + # `rnode` is the return value node, the first child of (declaration) + decho("addProc()") + let + # node = identifier = name + ident = gState.newXIdent(node, kind = nskProc) + + if not ident.isNil: + let + # Only need the ident tree, not nkTypeDef parent + name = ident.getIdentName() + origname = gState.getNodeVal(node.getAtom()) + + # node could have nested pointers + tcount = node.getPtrCount() + + # rnode = identifier = return type name + (rname, _, rinfo) = gState.getNameInfo(rnode.getAtom(), nskType, parent = name) + + # Parameter list + plist = node.anyChildInTree("parameter_list") + + procDef = newNode(nkProcDef) + + # proc X(a1: Y, a2: Z): P {.pragma.} + # + # nkProcDef( + # nkPostfix( + # nkIdent("*"), + # nkIdent("X") + # ), + # nkEmpty(), + # nkEmpty(), + # nkFormalParams( + # nkPtrTy( # optional, nested + # nkIdent(retType) + # ), + # nkIdentDefs( + # nkIdent(param), + # nkPtrTy( + # nkIdent(ptype) + # ), + # nkEmpty() + # ), + # ... + # ), + # nkPragma(...), + # nkEmpty(), + # nkEmpty() + # ) + + procDef.add ident + procDef.add newNode(nkEmpty) + procDef.add newNode(nkEmpty) + + # Return type + var + retType = + if rname == "object" and tcount == 0: + # void func(..) + newNode(nkEmpty) + else: + gState.getIdent(rname, rinfo, exported = false) + if tcount > 0: + retType = gState.newPtrTree(tcount, retType) + + # Proc with return type and params + procDef.add gState.newFormalParams(name, plist, retType) + + # Pragmas + let + prident = + if name != origname: + # Explicit {.importc: "origname".} + gState.newPragma(node, "importc", newStrNode(nkStrLit, origname)) + else: + # {.impnameC.} shortcut + gState.newPragma(node, "importc") + + # Detect ... and add {.varargs.} + pvarargs = plist.getVarargs() + + # Need {.convention.} + gState.addPragma(node, prident, gState.convention) + + if gState.dynlib.nBl: + # Add {.dynlib.} + gState.addPragma(node, prident, gState.impShort & "Dyn") + elif not gState.noHeader: + # Add {.header.} + gState.addPragma(node, prident, gState.impShort & "Hdr") + + if pvarargs: + # Add {.varargs.} for ... + gState.addPragma(node, prident, "varargs") + + procDef.add prident + procDef.add newNode(nkEmpty) + procDef.add newNode(nkEmpty) + + procDef.comment = gState.getCommentsStr(commentNodes) + + # nkProcSection.add + gState.procSection.add procDef + + gState.printDebug(procDef) + +proc addVar(gState: State, node: TSNode, offset: SomeInteger, commentNodes: seq[TSNode]) = + # Add a regular variable + # + # `node` is the `nth` child of (declaration) + # `tnode` is the type node, the first child of (declaration) + decho("addVar()") + let + (tname, tinfo, tident, start) = gState.getTypeAndStart("", node) + + identDefs = gState.newIdentDef("", node, tname, tinfo, tident, start, offset, 0, exported = true) + + if not identDefs.isNil: + # proc var + # + # P (*_X)(Y a1, Z a2); + # + # var X* {.importc: "_X": proc(a1: Y, a2: Z): P {.cdecl.} + # + # nkIdentDefs( + # nkPragmaExpr( + # nkPostfix( + # nkIdent("*"), + # nkIdent("X") + # ), + # nkPragma( + # nkExprColonExpr( + # nkIdent("importc"), + # nkStrLit("_X") + # ) + # ) + # ), + # nkProcTy( + # nkFormalParams( + # nkIdent("P"), + # nkIdentDefs( + # nkIdent("a1"), + # nkIdent("Y"), + # nkEmpty() + # ), + # nkIdentDefs( + # nkIdent("a2"), + # nkIdent("Z"), + # nkEmpty() + # ) + # ), + # nkPragma( + # nkIdent("cdecl") + # ) + # ), + # nkEmpty() + # ) + + identDefs.comment = gState.getCommentsStr(commentNodes) + + # nkVarSection.add + gState.varSection.add identDefs + + gState.printDebug(identDefs) + +proc addDecl(gState: State, node: TSNode) = + # Add a declaration + decho("addDecl()") + gState.printDebug(node) + + let + start = getStartAtom(node) + + var + firstDecl = true + commentNodes: seq[TSNode] + + for i in start+1 ..< node.len: + if node[i].getName() in ["comment", "type_qualifier"]: + continue + + if firstDecl: + # If it's the first declaration, use the whole node + # to get the comment above/below + commentNodes = gState.getCommentNodes(node) + firstDecl = false + else: + commentNodes = gState.getCommentNodes(node[i]) + + if not node[i].firstChildInTree("function_declarator").isNil: + # Proc declaration - var or actual proc + if node[i].getAtom().getPxName(1) == "pointer_declarator": + # proc var + #gState.addProcVar(node[i], node[start], commentNodes) + gState.addVar(node, i, commentNodes) + else: + # proc + gState.addProc(node[i], node[start], commentNodes) + else: + # Regular var + gState.addVar(node, i, commentNodes) + +proc addDef(gState: State, node: TSNode) = + # Wrap static inline definition if {.header.} mode is specified + # + # Without {.header.} the definition will not be available to the C compiler + # and will fail at link time + decho("addDef()") + gState.printDebug(node) + + let + start = getStartAtom(node) + commentNodes = gState.getCommentNodes(node) + fdecl = node[start+1].firstChildInTree("function_declarator") + + if not fdecl.isNil: + if gState.getNodeError(fdecl): + return + + if not gState.noHeader: + gState.addProc(node[start+1], node[start], commentNodes) + else: + gecho "# proc '$1' skipped - static inline procs cannot work with '--noHeader | -H'" % + gState.getNodeVal(node[start+1].getAtom()) + +proc processNode(gState: State, node: TSNode): Status = + const + known = ["preproc_def", "type_definition", + "struct_specifier", "union_specifier", "enum_specifier", + "declaration"].toHashSet() + + result = success + let + name = node.getName() + if name in known: + # Recognized top-level nodes + if gState.getNodeError(node): + result = Status.error + else: + # Process nodes + case name + of "preproc_def": + gState.addConst(node) + of "type_definition": + if node.len > 0 and node[0].getName() == "enum_specifier": + gState.addEnum(node) + elif node.len > 0 and node[0].getName() == "union_specifier": + gState.addType(node, union = true) + else: + gState.addType(node) + of "struct_specifier": + gState.addType(node) + of "union_specifier": + gState.addType(node, union = true) + of "enum_specifier": + gState.addEnum(node) + of "declaration": + gState.addDecl(node) + elif name == "function_definition": + # Separate since we only need to check function_declarator for errors and + # not the compound_statement which could have errors but does not impact + # wrapper generation + gState.addDef(node) + else: + # Unknown, will check child nodes + result = unknown + +proc searchTree(gState: State, root: TSNode) = + # Search AST generated by tree-sitter for recognized elements + var + node = root + nextnode: TSNode + depth = 0 + processed = success + + while true: + if not node.isNil and depth > -1: + processed = gState.processNode(node) + else: + break + + if processed == unknown and node.len != 0: + nextnode = node[0] + depth += 1 + else: + nextnode = node.tsNodeNextNamedSibling() + + if nextnode.isNil: + while true: + node = node.tsNodeParent() + depth -= 1 + if depth == -1: + break + if node == root: + break + if not node.tsNodeNextNamedSibling().isNil: + node = node.tsNodeNextNamedSibling() + break + else: + node = nextnode + + if node == root: + break + +### +# gState.addPragma(root, impPragma, "importc") +# gState.addPragma(root, impConvPragma, gState.convention) + +proc setupPragmas(gState: State, root: TSNode, fullpath: string) = + # Create shortcut pragmas to reduce clutter + var + count = 0 + + if not gState.noHeader: + # {.pragma: impnameHdr, header: "xxx".} + let + hdrPragma = gState.newPragma(root, "pragma", gState.getIdent(gState.impShort & "Hdr")) + gState.addPragma(root, hdrPragma, "header", newStrNode(nkStrLit, fullpath)) + gState.pragmaSection.add hdrPragma + count += 1 + + if gState.dynlib.nBl: + # {.pragma: impnameDyn, dynlib: libname.} + let + dynPragma = gState.newPragma(root, "pragma", gState.getIdent(gState.impShort & "Dyn")) + if '.' in gState.dynlib: + gState.addPragma(root, dynPragma, "dynlib", newStrNode(nkStrLit, gState.dynlib)) + else: + gState.addPragma(root, dynPragma, "dynlib", gState.getIdent(gState.dynlib)) + gState.pragmaSection.add dynPragma + count += 1 + + # Only if not already done + if gState.pragmaSection.len == count: + # Add `{.experimental: "codeReordering".} for #206 + gState.pragmaSection.add gState.newPragma(root, "experimental", newStrNode(nkStrLit, "codeReordering")) + + # Create `{.passC.}` from defines + for define in gState.defines: + gState.pragmaSection.add gState.newPragma(root, "passC", newStrNode(nkStrLit, "-D" & define)) + + # Create `{.passC.}` from include directories + for inc in gState.includeDirs: + gState.pragmaSection.add gState.newPragma(root, "passC", newStrNode(nkStrLit, "-I" & inc.quoteShell)) + + # Create `{.passC.}` from passC + for passC in gState.passC: + gState.pragmaSection.add gState.newPragma(root, "passC", newStrNode(nkStrLit, passC)) + + # Create `{.passL.}` from passL + for passL in gState.passL: + gState.pragmaSection.add gState.newPragma(root, "passL", newStrNode(nkStrLit, passL)) + + # Create `{.compile.}` for specified files + for file in gState.compile: + gState.pragmaSection.add gState.newPragma(root, "compile", newStrNode(nkStrLit, file)) + +proc initNim*(gState: State) = + # Initialize for parseNim() one time + gState.wrapperHeader = "{.push hint[ConvFromXtoItselfNotNeeded]: off.}\n" + + # Track identifiers already rendered and corresponding PNodes + gState.identifiers = newTable[string, string]() + gState.identifierNodes = newTable[string, PNode]() + + # Nim compiler objects + gState.identCache = newIdentCache() + gState.config = newConfigRef() + gState.graph = newModuleGraph(gState.identCache, gState.config) + + # Initialize all section PNodes + gState.constSection = newNode(nkConstSection) + gState.enumSection = newNode(nkStmtList) + gState.pragmaSection = newNode(nkStmtList) + gState.procSection = newNode(nkStmtList) + gState.typeSection = newNode(nkTypeSection) + gState.varSection = newNode(nkVarSection) + +proc parseNim*(gState: State, fullpath: string, root: TSNode) = + # Generate Nim from tree-sitter AST root node + let + fp = fullpath.replace("\\", "/") + + # toast objects + gState.currentHeader = getCurrentHeader(fullpath) + gState.impShort = gState.currentHeader.replace("header", "imp") + gState.sourceFile = fullpath + + # Setup pragmas + gState.setupPragmas(root, fp) + + # Search root node and render Nim + gState.searchTree(root) + +proc printNim*(gState: State) = + # Print Nim generated by parseNim() + + # Add any unused cOverride symbols to output + gState.addAllOverrideFinal() + + # Create output to Nim using Nim compiler renderer + var + tree = newNode(nkStmtList) + tree.add gState.pragmaSection + tree.add gState.enumSection + tree.add gState.constSection + tree.add gState.typeSection + tree.add gState.varSection + tree.add gState.procSection + + gecho gState.wrapperHeader + gecho tree.renderTree() + + gecho "{.pop.}" \ No newline at end of file diff --git a/nimterop/toastlib/comphelp.nim b/nimterop/toastlib/comphelp.nim new file mode 100644 index 0000000..642fbbd --- /dev/null +++ b/nimterop/toastlib/comphelp.nim @@ -0,0 +1,147 @@ +import macros, strutils + +import compiler/[ast, idents, lineinfos, msgs, options, parser, pathutils, renderer] + +import ".."/[globals, treesitter/api] +import "."/[getters, tshelp] + +proc handleError*(conf: ConfigRef, info: TLineInfo, msg: TMsgKind, arg: string) = + # Raise exception in parseString() instead of exiting for errors + if msg < warnMin: + raise newException(Exception, msgKindToString(msg)) + +proc parseString*(gState: State, str: string): PNode = + # Parse a string into Nim AST - use custom error handler that raises + # an exception rather than exiting on failure + try: + result = parseString( + str, gState.identCache, gState.config, errorHandler = handleError + ) + except: + decho getCurrentExceptionMsg() + +proc printTree*(gState: State, pnode: PNode, offset = ""): string = + if not pnode.isNil and gState.debug and pnode.kind != nkNone: + result &= "\n# " & offset & $pnode.kind & "(" + case pnode.kind + of nkCharLit: + result &= ($pnode.intVal.char).escape & ")" + of nkIntLit..nkUInt64Lit: + result &= $pnode.intVal & ")" + of nkFloatLit..nkFloat128Lit: + result &= $pnode.floatVal & ")" + of nkStrLit..nkTripleStrLit: + result &= pnode.strVal.escape & ")" + of nkSym: + result &= $pnode.sym & ")" + of nkIdent: + result &= "\"" & $pnode.ident.s & "\")" + else: + if pnode.sons.len != 0: + for i in 0 ..< pnode.sons.len: + result &= gState.printTree(pnode.sons[i], offset & " ") + if i != pnode.sons.len - 1: + result &= "," + result &= "\n# " & offset & ")" + else: + result &= ")" + if offset.len == 0: + result &= "\n" + +proc printDebug*(gState: State, pnode: PNode) = + if gState.debug and pnode.kind != nkNone: + gecho ("Output => " & $pnode).getCommented() + gecho gState.printTree(pnode) + +proc getDefaultLineInfo*(gState: State): TLineInfo = + result = newLineInfo(gState.config, gState.sourceFile.AbsoluteFile, 0, 0) + +proc getLineInfo*(gState: State, node: TSNode): TLineInfo = + # Get Nim equivalent line:col info from node + let + (line, col) = gState.getLineCol(node) + + result = newLineInfo(gState.config, gState.sourceFile.AbsoluteFile, line, col) + +proc getIdent*(gState: State, name: string, info: TLineInfo, exported = true): PNode = + if name.nBl: + # Get ident PNode for name + info + let + exp = getIdent(gState.identCache, "*") + ident = getIdent(gState.identCache, name) + + if exported: + result = newNode(nkPostfix) + result.add newIdentNode(exp, info) + result.add newIdentNode(ident, info) + else: + result = newIdentNode(ident, info) + +proc getIdent*(gState: State, name: string): PNode = + gState.getIdent(name, gState.getDefaultLineInfo(), exported = false) + +proc getIdentName*(node: PNode): string = + if not node.isNil: + for i in 0 ..< node.len: + if node[i].kind == nkIdent and $node[i] != "*": + result = $node[i] + if result.Bl and node.len > 0: + result = node[0].getIdentName() + +proc getNameInfo*(gState: State, node: TSNode, kind: NimSymKind, parent = ""): + tuple[name, origname: string, info: TLineInfo] = + # Shortcut to get identifier name and info (node value and line:col) + result.origname = gState.getNodeVal(node) + result.name = gState.getIdentifier(result.origname, kind, parent) + if result.name.nBl: + if kind == nskType: + result.name = gState.getType(result.name, parent) + result.info = gState.getLineInfo(node) + +proc getPtrType*(str: string): string = + result = case str: + of "cchar": + "cstring" + of "object": + "pointer" + of "FILE": + "File" + else: + str + +proc newPtrTree*(gState: State, count: int, typ: PNode): PNode = + # Create nkPtrTy tree depending on count + # + # Reduce by 1 if Nim type available for ptr X - e.g. ptr cchar = cstring + result = typ + var + count = count + if typ.kind == nkIdent: + let + tname = typ.ident.s + ptname = getPtrType(tname) + if tname != ptname: + # If Nim type available, use that ident + result = gState.getIdent(ptname, typ.info, exported = false) + # One ptr reduced + count -= 1 + if count > 0: + # Nested nkPtrTy(typ) depending on count + # + # [ptr ...] typ + # + # nkPtrTy( + # nkPtrTy( + # typ + # ) + # ) + var + nresult = newNode(nkPtrTy) + parent = nresult + child: PNode + for i in 1 ..< count: + child = newNode(nkPtrTy) + parent.add child + parent = child + parent.add result + result = nresult \ No newline at end of file diff --git a/nimterop/toastlib/exprparser.nim b/nimterop/toastlib/exprparser.nim new file mode 100644 index 0000000..a67ed59 --- /dev/null +++ b/nimterop/toastlib/exprparser.nim @@ -0,0 +1,643 @@ +import strformat, strutils, macros, sets, sequtils + +import regex + +import compiler/[ast, renderer] + +import ".."/treesitter/[api, c, cpp] +import ".."/globals +import "."/[getters, comphelp, tshelp] + +# This version of exprparser should be able to handle: +# +# All integers + integer like expressions (hex, octal, suffixes) +# All floating point expressions (except for C++'s hex floating point stuff) +# Strings and character literals, including C's escape characters (not sure if this is the same as C++'s escape characters or not) +# Math operators (+, -, /, *) +# Some Unary operators (-, !, ~). ++, --, and & are yet to be implemented +# Any identifiers +# C type descriptors (int, char, etc) +# Boolean values (true, false) +# Shift expressions (containing anything in this list) +# Cast expressions (containing anything in this list) +# Math expressions (containing anything in this list) +# Sizeof expressions (containing anything in this list) +# Cast expressions (containing anything in this list) +# Parentheses expressions (containing anything in this list) +# Expressions containing other expressions +# +# In addition to the above, it should also handle most type coercions, except +# for where Nim can't (such as uint + -int) + +type + ExprParseError* = object of CatchableError + +const + CharRegStr = "(\\\\x[[:xdigit:]]{2}|\\\\\\d{3}|\\\\0|\\\\a|\\\\b|\\\\e|\\\\f|\\\\n|\\\\r|\\\\t|\\\\v|\\\\\\\\|\\\\'|\\\\\"|[[:ascii:]])" + CharRegex = re(CharRegStr) + +template val(node: TSNode): string = + gState.currentExpr.getNodeVal(node) + +proc printDebugExpr*(gState: State, node: TSNode) = + if gState.debug: + gecho ("Input => " & node.val).getCommented() + gecho gState.currentExpr.printLisp(node).getCommented() + +proc getExprIdent*(gState: State, identName: string, kind = nskConst, parent = ""): PNode = + ## Gets a cPlugin transformed identifier from `identName` + ## + ## Returns PNode(nkNone) if the identifier is blank + result = newNode(nkNone) + if gState.skipIdentValidation or identName notin gState.skippedSyms: + var ident = identName + if ident != "_": + # Process the identifier through cPlugin + ident = gState.getIdentifier(ident, kind, parent) + if kind == nskType: + result = gState.getIdent(ident) + elif gState.skipIdentValidation or ident.nBl and ident in gState.constIdentifiers: + if gState.currentTyCastName.nBl: + ident = ident & "." & gState.currentTyCastName + result = gState.getIdent(ident) + +proc getExprIdent*(gState: State, node: TSNode, kind = nskConst, parent = ""): PNode = + ## Gets a cPlugin transformed identifier from `identName` + ## + ## Returns PNode(nkNone) if the identifier is blank + gState.getExprIdent(node.val, kind, parent) + +proc parseChar(charStr: string): uint8 {.inline.} = + ## Parses a character literal out of a string. This is needed + ## because treesitter gives unescaped characters when parsing + ## strings. + if charStr.len == 1: + return charStr[0].uint8 + + # Handle octal, hex, unicode? + if charStr.startsWith("\\x"): + result = parseHexInt(charStr.replace("\\x", "0x")).uint8 + elif charStr.len == 4: # Octal + result = parseOctInt("0o" & charStr[1 ..< charStr.len]).uint8 + + if result == 0: + case charStr + of "\\0": + result = ord('\0') + of "\\a": + result = 0x07 + of "\\b": + result = 0x08 + of "\\e": + result = 0x1B + of "\\f": + result = 0x0C + of "\\n": + result = '\n'.uint8 + of "\\r": + result = 0x0D + of "\\t": + result = 0x09 + of "\\v": + result = 0x0B + of "\\\\": + result = 0x5C + of "\\'": + result = '\''.uint8 + of "\\\"": + result = '\"'.uint8 + of "\\?": + result = 0x3F + else: + discard + + if result > uint8.high: + result = uint8.high + +proc getCharLit(charStr: string): PNode {.inline.} = + ## Convert a character string into a proper Nim char lit node + result = newNode(nkCharLit) + result.intVal = parseChar(charStr).int64 + +proc getFloatNode(number, suffix: string): PNode {.inline.} = + ## Get a Nim float node from a C float expression + suffix + let floatSuffix = number[number.len-1] + try: + case floatSuffix + of 'l', 'L': + # TODO: handle long double (128 bits) + # result = newNode(nkFloat128Lit) + result = newFloatNode(nkFloat64Lit, parseFloat(number[0 ..< number.len - 1])) + of 'f', 'F': + result = newFloatNode(nkFloat64Lit, parseFloat(number[0 ..< number.len - 1])) + else: + result = newFloatNode(nkFloatLit, parseFloat(number)) + except ValueError: + raise newException(ExprParseError, &"Could not parse float value \"{number}\".") + +proc getIntNode(number, suffix: string): PNode {.inline.} = + ## Get a Nim int node from a C integer expression + suffix + var + val: BiggestInt + flags: TNodeFlags + if number.len > 1 and number[0] == '0': + if number[1] in ['x', 'X']: + val = parseHexInt(number) + flags = {nfBase16} + elif number[1] in ['b', 'B']: + val = parseBinInt(number) + flags = {nfBase2} + else: + val = parseOctInt(number) + flags = {nfBase8} + else: + val = parseInt(number) + + case suffix + of "u", "U": + result = newNode(nkUintLit) + of "l", "L": + # If the value doesn't fit, adjust + if val > int32.high or val < int32.low: + result = newNode(nkInt64Lit) + else: + result = newNode(nkInt32Lit) + of "ul", "UL": + # If the value doesn't fit, adjust + if val > uint32.high.BiggestInt: + result = newNode(nkUInt64Lit) + else: + result = newNode(nkUInt32Lit) + of "ll", "LL": + result = newNode(nkInt64Lit) + of "ull", "ULL": + result = newNode(nkUint64Lit) + else: + result = newNode(nkIntLit) + + result.intVal = val + result.flags = flags + +proc getNumNode(number, suffix: string): PNode {.inline.} = + ## Convert a C number to a Nim number PNode + if number.contains("."): + getFloatNode(number, suffix) + else: + getIntNode(number, suffix) + +proc processNumberLiteral(gState: State, node: TSNode): PNode = + ## Parse a number literal from a TSNode. Can be a float, hex, long, etc + result = newNode(nkNone) + let nodeVal = node.val + var + prefix: string + number = nodeVal + suffix: string + + const + singleEndings = ["u", "l", "U", "L"] + doubleEndings = ["ul", "UL", "ll", "LL"] + tripleEndings = ["ull", "ULL"] + + if number.startsWith("-"): + number = number[1 ..< number.len] + prefix = "-" + if tripleEndings.any(proc (s: string): bool = number.endsWith(s)): + suffix = number[^3 .. ^1] + number = number[0 ..< ^3] + elif doubleEndings.any(proc (s: string): bool = number.endsWith(s)): + suffix = number[^2 .. ^1] + number = number[0 ..< ^2] + elif singleEndings.any(proc (s: string): bool = number.endsWith(s)): + suffix = $number[number.len - 1] + number = number[0 ..< ^1] + + result = getNumNode(number, suffix) + + if result.kind != nkNone and prefix == "-": + result = nkPrefix.newTree( + gState.getIdent("-"), + result + ) + +proc processCharacterLiteral(gState: State, node: TSNode): PNode = + # Input => 'G' + # + # (char_literal 1 1 3 "'G'") + # + # Output => 'G' + # + # nkCharLit("G") + let val = node.val + result = getCharLit(val[1 ..< val.len - 1]) + +proc processStringLiteral(gState: State, node: TSNode): PNode = + # Input => "\n\rfoobar\0\'" + # + # (string_literal 1 1 16 ""\n\rfoobar\0\'"" + # (escape_sequence 1 2 2 "\n") + # (escape_sequence 1 4 2 "\r") + # (escape_sequence 1 12 2 "\0") + # (escape_sequence 1 14 2 "\'") + # ) + # + # Output => "\n\cfoobar\x00\'" + # + # nkStrLit("\x0A\x0Dfoobar\x00\'") + let + nodeVal = node.val + strVal = nodeVal[1 ..< nodeVal.len - 1] + + # Convert the c string escape sequences/etc to Nim chars + var nimStr = newStringOfCap(nodeVal.len) + for m in strVal.findAll(CharRegex): + nimStr.add(parseChar(strVal[m.group(0)[0]]).chr) + + result = newStrNode(nkStrLit, nimStr) + +proc processTSNode(gState: State, node: TSNode, typeofNode: var PNode): PNode + +proc processParenthesizedExpr(gState: State, node: TSNode, typeofNode: var PNode): PNode = + # Input => (a + b) + # + # (parenthesized_expression 1 1 7 + # (math_expression 1 2 5 + # (identifier 1 2 1 "a") + # (identifier 1 6 1 "b") + # ) + # ) + # + # Output => (typeof(a)(a + typeof(a)(b))) + # + # nkPar( + # nkCall( + # nkCall( + # nkIdent("typeof"), + # nkIdent("a") + # ), + # nkInfix( + # nkIdent("+"), + # nkIdent("a"), + # nkCall( + # nkCall( + # nkIdent("typeof"), + # nkIdent("a") + # ), + # nkIdent("b") + # ) + # ) + # ) + # ) + result = newNode(nkPar) + for i in 0 ..< node.len(): + result.add(gState.processTSNode(node[i], typeofNode)) + +proc processCastExpression(gState: State, node: TSNode, typeofNode: var PNode): PNode = + # Input => (int)a + # + # (cast_expression 1 1 6 "(int)a" + # (type_descriptor 1 2 3 "int" + # (primitive_type 1 2 3 "int") + # ) + # (identifier 1 6 1 "a") + # ) + # + # Output => cast[cint](a) + # + # nkCast( + # nkIdent("cint"), + # nkIdent("a") + # ) + result = nkCast.newTree( + gState.processTSNode(node[0], typeofNode), + gState.processTSNode(node[1], typeofNode) + ) + +proc getNimUnarySym(csymbol: string): string = + ## Get the Nim equivalent of a unary C symbol + ## + ## TODO: Add ++, --, + case csymbol + of "+", "-": + result = csymbol + of "~", "!": + result = "not" + else: + raise newException(ExprParseError, &"Unsupported unary symbol \"{csymbol}\"") + +proc getNimBinarySym(csymbol: string): string = + case csymbol + of "|", "||": + result = "or" + of "&", "&&": + result = "and" + of "^": + result = "xor" + of "==", "!=", + "+", "-", "/", "*", + ">", "<", ">=", "<=": + result = csymbol + of "%": + result = "mod" + of "<<": + result = "shl" + of ">>": + result = "shr" + else: + raise newException(ExprParseError, &"Unsupported binary symbol \"{csymbol}\"") + +proc processBinaryExpression(gState: State, node: TSNode, typeofNode: var PNode): PNode = + # Node has left and right children ie: (2 + 7) + # + # Input => a == b + # + # (equality_expression 1 1 6 + # (identifier 1 1 1 "a") + # (identifier 1 6 1 "b") + # ) + # + # Output => a == typeof(a)(b) + # + # nkInfix( + # nkIdent("=="), + # nkIdent("a"), + # nkCall( + # nkCall( + # nkIdent("typeof"), + # nkIdent("a") + # ), + # nkIdent("b") + # ) + # ) + result = newNode(nkInfix) + + let + left = node[0] + right = node[1] + binarySym = node.tsNodeChild(1).val.strip() + nimSym = getNimBinarySym(binarySym) + + result.add gState.getIdent(nimSym) + let leftNode = gState.processTSNode(left, typeofNode) + var tyNode = typeofNode + + if typeofNode.isNil: + typeofNode = nkCall.newTree( + gState.getIdent("typeof"), + leftNode + ) + tyNode = typeofNode + + # Special case of setting the shift left/right type + # to be the type of the direct left operand + if binarySym in [">>", "<<"]: + tyNode = nkCall.newTree( + gState.getIdent("typeof"), + leftNode + ) + + let rightNode = gState.processTSNode(right, tyNode) + + result.add leftNode + result.add nkCall.newTree( + tyNode, + rightNode + ) + if binarySym == "/": + # Special case. Nim's operators generally output + # the same type they take in, except for division. + # So we need to emulate C here and cast the whole + # expression to the type of the first arg + result = nkCall.newTree( + tyNode, + result + ) + +proc processUnaryExpression(gState: State, node: TSNode, typeofNode: var PNode): PNode = + # Input => !a + # + # (logical_expression 1 1 2 "!a" + # (identifier 1 2 1 "a") + # ) + # + # Output => (not a) + # + # nkPar( + # nkPrefix( + # nkIdent("not"), + # nkIdent("a") + # ) + # ) + result = newNode(nkPar) + + let + child = node[0] + unarySym = node.tsNodeChild(0).val.strip() + nimSym = getNimUnarySym(unarySym) + + if nimSym == "-": + # Special case. The minus symbol must be in front of an integer, + # so we have to make a gentle cast here to coerce it to one. + # Might be bad because we are overwriting the type + # There's probably a better way of doing this + if typeofNode.isNil: + typeofNode = gState.getIdent("int64") + + result.add nkPrefix.newTree( + gState.getIdent(unarySym), + nkPar.newTree( + nkCall.newTree( + gState.getIdent("int64"), + gState.processTSNode(child, typeofNode) + ) + ) + ) + else: + result.add nkPrefix.newTree( + gState.getIdent(nimSym), + gState.processTSNode(child, typeofNode) + ) + +proc processUnaryOrBinaryExpression(gState: State, node: TSNode, typeofNode: var PNode): PNode = + ## Processes both unary (-1, ~true, !something) and binary (a + b, c * d) expressions + if node.len > 1: + # Node has left and right children ie: (2 + 7) + result = processBinaryExpression(gState, node, typeofNode) + elif node.len() == 1: + # Node has only one child, ie -(20 + 7) + result = processUnaryExpression(gState, node, typeofNode) + else: + raise newException(ExprParseError, &"Invalid {node.getName()} \"{node.val}\"") + +proc processSizeofExpression(gState: State, node: TSNode, typeofNode: var PNode): PNode = + # Input => sizeof(int) + # + # (sizeof_expression 1 1 11 "sizeof(int)" + # (type_descriptor 1 8 3 "int" + # (primitive_type 1 8 3 "int") + # ) + # ) + # + # Output => sizeof(cint) + # + # nkCall( + # nkIdent("sizeof"), + # nkIdent("cint") + # ) + result = nkCall.newTree( + gState.getIdent("sizeof"), + gState.processTSNode(node[0], typeofNode) + ) + +proc processTSNode(gState: State, node: TSNode, typeofNode: var PNode): PNode = + ## Handle all of the types of expressions here. This proc gets called recursively + ## in the processX procs and will drill down to sub nodes. + result = newNode(nkNone) + let nodeName = node.getName() + + decho "NODE: ", nodeName, ", VAL: ", node.val + + case nodeName + of "number_literal": + # Input -> 0x1234FE, 1231, 123u, 123ul, 123ull, 1.334f + # Output -> 0x1234FE, 1231, 123'u, 123'u32, 123'u64, 1.334 + result = gState.processNumberLiteral(node) + of "string_literal": + # Input -> "foo\0\x42" + # Output -> "foo\0" + result = gState.processStringLiteral(node) + of "char_literal": + # Input -> 'F', '\060' // Octal, '\x5A' // Hex, '\r' // escape sequences + # Output -> 'F', '0', 'Z', '\r' + result = gState.processCharacterLiteral(node) + of "expression_statement", "ERROR", "translation_unit": + # Note that we're parsing partial expressions, so the TSNode might contain + # an ERROR node. If that's the case, they usually contain children with + # partial results, which will contain parsed expressions + # + # Input (top level statement) -> ((1 + 3 - IDENT) - (int)400.0) + # Output -> (1 + typeof(1)(3) - typeof(1)(IDENT) - typeof(1)(cast[int](400.0))) # Type casting in case some args differ + if node.len == 1: + result = gState.processTSNode(node[0], typeofNode) + elif node.len > 1: + var nodes: seq[PNode] + for i in 0 ..< node.len: + let subNode = gState.processTSNode(node[i], typeofNode) + if subNode.kind != nkNone: + nodes.add(subNode) + # Multiple nodes can get tricky. Don't support them yet, unless they + # have at most one valid node + if nodes.len > 1: + raise newException(ExprParseError, &"Node type \"{nodeName}\" with val ({node.val}) has more than one non empty node") + if nodes.len == 1: + result = nodes[0] + else: + raise newException(ExprParseError, &"Node type \"{nodeName}\" has no children") + of "parenthesized_expression": + # Input -> (IDENT - OTHERIDENT) + # Output -> (IDENT - typeof(IDENT)(OTHERIDENT)) # Type casting in case OTHERIDENT is a slightly different type (uint vs int) + result = gState.processParenthesizedExpr(node, typeofNode) + of "sizeof_expression": + # Input -> sizeof(char) + # Output -> sizeof(cchar) + result = gState.processSizeofExpression(node, typeofNode) + # binary_expression from the new treesitter upgrade should work here + # once we upgrade + of "math_expression", "logical_expression", "relational_expression", + "bitwise_expression", "equality_expression", "binary_expression", + "shift_expression", "unary_expression": + # Input -> a == b, a != b, !a, ~a, a < b, a > b, a <= b, a >= b, a >> b, a << b + # Output -> + # typeof(a)(a == typeof(a)(b)) + # typeof(a)(a != typeof(a)(b)) + # (not a) + # (not a) + # typeof(a)(a < typeof(a)(b)) + # typeof(a)(a > typeof(a)(b)) + # typeof(a)(a <= typeof(a)(b)) + # typeof(a)(a >= typeof(a)(b)) + # a shr typeof(a)(b) + # a shl typeof(a)(b) + result = gState.processUnaryOrBinaryExpression(node, typeofNode) + of "cast_expression": + # Input -> (int) a + # Output -> cast[cint](a) + result = gState.processCastExpression(node, typeofNode) + # Why are these node types named true/false? + of "true", "false": + # Input -> true, false + # Output -> true, false + result = gState.parseString(node.val) + of "type_descriptor": + # Input => int* + # (type_descriptor 1 2 4 "int*" + # (type_identifier 1 2 3 "int") + # (abstract_pointer_declarator 1 3 1 "*") + # ) + # + # Output => ptr int + # + # nkPtrTy( + # nkIdent("int") + # ) + let pointerDecl = node.anyChildInTree("abstract_pointer_declarator") + + if pointerDecl.isNil: + result = gState.processTSNode(node[0], typeofNode) + else: + let pointerCount = pointerDecl.getXCount("abstract_pointer_declarator") + result = gState.newPtrTree(pointerCount, gState.processTSNode(node[0], typeofNode)) + of "sized_type_specifier", "primitive_type", "type_identifier": + # Input -> int, unsigned int, long int, etc + # Output -> cint, cuint, clong, etc + let ty = gState.getType(node.val, parent = node.getName()) + if ty.len > 0: + # If ty is not empty, one of C's builtin types has been found + result = gState.getExprIdent(ty, nskType, parent=node.getName()) + else: + result = gState.getExprIdent(node.val, nskType, parent=node.getName()) + if result.kind == nkNone: + raise newException(ExprParseError, &"Missing type specifier \"{node.val}\"") + of "identifier": + # Input -> IDENT + # Output -> IDENT (if found in sym table, else error) + result = gState.getExprIdent(node, parent=node.getName()) + if result.kind == nkNone: + raise newException(ExprParseError, &"Missing identifier \"{node.val}\"") + of "comment": + discard + else: + raise newException(ExprParseError, &"Unsupported node type \"{nodeName}\" for node \"{node.val}\"") + + if result.kind != nkNone: + decho "NODE RESULT: ", result + +proc parseCExpression*(gState: State, codeRoot: TSNode): PNode = + ## Parse a c expression from a root ts node + + # This var is used for keeping track of the type of the first + # symbol used for type casting + var tnode: PNode = nil + result = newNode(nkNone) + try: + result = gState.processTSNode(codeRoot, tnode) + except ExprParseError as e: + decho e.msg + result = newNode(nkNone) + except Exception as e: + decho "UNEXPECTED EXCEPTION: ", e.msg + result = newNode(nkNone) + +proc parseCExpression*(gState: State, code: string, name = "", skipIdentValidation = false): PNode = + ## Convert the C string to a nim PNode tree + gState.currentExpr = code + gState.currentTyCastName = name + gState.skipIdentValidation = skipIdentValidation + + withCodeAst(gState.currentExpr, gState.mode): + result = gState.parseCExpression(root) + + # Clear the state + gState.currentExpr = "" + gState.currentTyCastName = "" + gState.skipIdentValidation = false \ No newline at end of file diff --git a/nimterop/toastlib/getters.nim b/nimterop/toastlib/getters.nim new file mode 100644 index 0000000..2e1ac4c --- /dev/null +++ b/nimterop/toastlib/getters.nim @@ -0,0 +1,421 @@ +import dynlib, macros, os, osproc, sequtils, sets, streams, strformat, strutils, tables, times + +import regex + +import ".."/[globals, plugin] +import ".."/build/[ccompiler, misc, nimconf, shell] + +const gReserved = """ +addr and as asm +bind block break +case cast concept const continue converter +defer discard distinct div do +elif else end enum except export +finally for from func +if import in include interface is isnot iterator +let +macro method mixin mod +nil not notin +of or out +proc ptr +raise ref return +shl shr static +template try tuple type +using +var +when while +xor +yield""".split(Whitespace).toHashSet() + +# Types related + +const + # Enum macro read from file - written into wrapper when required + gEnumMacroConst = "import nimterop / enumtypepub" + +var + gEnumMacro* = gEnumMacroConst + + gTypeMap* = { + # char + "char": "cchar", + "signed char": "cschar", + "unsigned char": "cuchar", + + # short + "short": "cshort", + "short int": "cshort", + "signed short": "cshort", + "signed short int": "cshort", + "unsigned short": "cushort", + "unsigned short int": "cushort", + "uShort": "cushort", + "u_short": "cushort", + + # int + "int": "cint", + "signed": "cint", + "signed int": "cint", + "ssize_t": "int", + "unsigned": "cuint", + "unsigned int": "cuint", + "uInt": "cuint", + "u_int": "cuint", + "size_t": "uint", + + "int8_t": "int8", + "int16_t": "int16", + "int32_t": "int32", + "int64_t": "int64", + + "intptr_t": "ptr int", + + "Int8": "int8", + "Int16": "int16", + "Int32": "int32", + "Int64": "int64", + + "uint8_t": "uint8", + "uint16_t": "uint16", + "uint32_t": "uint32", + "uint64_t": "uint64", + + "uintptr_t": "ptr uint", + + "Uint8": "uint8", + "Uint16": "uint16", + "Uint32": "uint32", + "Uint64": "uint64", + + # long + "long": "clong", + "long int": "clong", + "signed long": "clong", + "signed long int": "clong", + "off_t": "clong", + "unsigned long": "culong", + "unsigned long int": "culong", + "uLong": "culong", + "u_long": "culong", + + # long long + "long long": "clonglong", + "long long int": "clonglong", + "signed long long": "clonglong", + "signed long long int": "clonglong", + "off64_t": "clonglong", + "unsigned long long": "culonglong", + "unsigned long long int": "culonglong", + + # floating point + "float": "cfloat", + "double": "cdouble", + "long double": "clongdouble", + + # Misc Nim types + "Bool": "bool", + "ptrdiff_t": "ByteAddress" + }.toTable() + + # Nim type names that shouldn't need to be wrapped again + gTypeMapValues* = toSeq(gTypeMap.values).toHashSet() + + # Types to import from C/Nim if used in wrapper + gTypeImport* = { + "time_t": """ +import std/time_t as std_time_t +type time_t* = std_time_t.Time +""", + + "time64_t": """ +import std/time_t as std_time64_t +type time64_t* = std_time64_t.Time +""", + + "wchar_t": """ +when defined(cpp): + # http://www.cplusplus.com/reference/cwchar/wchar_t/ + # In C++, wchar_t is a distinct fundamental type (and thus it is + # not defined in nor any other header). + type wchar_t* {.importc.} = object +else: + type wchar_t* {.importc, header:"stddef.h".} = object +""", + + "va_list": """ +type va_list* {.importc, header:"".} = object +"""}.toTable() + +proc getType*(gState: State, str, parent: string): string = + if str == "void": + return "object" + + result = str.strip(chars={'_'}).splitWhitespace().join(" ") + + if gTypeMap.hasKey(result): + result = gTypeMap[result] + elif parent.nBl and gTypeImport.hasKey(result) and not gState.identifierNodes.hasKey(result): + # Include C/Nim type imports once if a field/param and not already declared + gState.wrapperHeader &= "\n" & gTypeImport[result] + gTypeImport.del result + +# Identifier related + +proc checkIdentifier(name, kind, parent, origName: string) = + let + parentStr = if parent.nBl: parent & ":" else: "" + + if name.nBl: + let + origStr = if name != origName: &", originally '{origName}' before 'cPlugin:onSymbol()'," else: "" + errmsg = &"Identifier '{parentStr}{name}' ({kind}){origStr} $1 " & + "which Nim does not allow. Use toast flag '$2' or 'cPlugin()' to modify." + + doAssert name[0] != '_' and name[^1] != '_', errmsg % ["has leading/trailing underscores '_'", "--prefix or --suffix"] + + doAssert (not name.contains("__")): errmsg % ["has consecutive underscores '_'", "--replace"] + + doAssert not name[0].isDigit(), errmsg % [&"starts with a digit '{name[0]}'", "--prefix"] + + # Cannot blank out symbols which are fields or params + # + # `IgnoreSkipSymbol` is used to `getIdentifier()` even if symbol is in `symOverride` list + # so that any prefix/suffix/replace or `onSymbol()` processing can occur. This is only used + # for `cOverride()` since it also depends on `symOverride`. + if parent.nBl and parent != "IgnoreSkipSymbol": + doAssert name.nBl, &"Blank identifier, originally '{parentStr}{origName}' ({kind}), cannot be empty" + +proc getIdentifier*(gState: State, name: string, kind: NimSymKind, parent=""): string = + doAssert name.nBl, "Blank identifier error" + + if name notin gState.symOverride or parent.nBl: + if gState.onSymbol != nil: + # Use onSymbol from plugin provided by user + var + sym = Symbol(name: name, parent: parent, kind: kind) + gState.onSymbol(sym) + + result = sym.name + else: + result = name + + # Strip out --prefix from CLI if specified + for str in gState.prefix: + if result.startsWith(str): + result = result[str.len .. ^1] + + # Strip out --suffix from CLI if specified + for str in gState.suffix: + if result.endsWith(str): + result = result[0 .. ^(str.len+1)] + + # --replace from CLI if specified + for name, value in gState.replace.pairs: + if name.len > 1 and name[0] == '@': + result = result.replace(re(name[1 .. ^1]), value) + else: + result = result.replace(name, value) + + checkIdentifier(result, $kind, parent, name) + + if result in gReserved or (result == "object" and kind != nskType): + # Enclose in backticks since Nim reserved word + result = &"`{result}`" + else: + # Skip identifier since in symOverride + result = "" + +proc getUniqueIdentifier*(gState: State, prefix = ""): string = + var + name = prefix & "_" & gState.sourceFile.extractFilename().multiReplace([(".", ""), ("-", "")]) + nimName = name[0] & name[1 .. ^1].replace("_", "").toLowerAscii + count = 1 + + while (nimName & $count) in gState.identifiers: + count += 1 + + return name & $count + +proc addNewIdentifer*(gState: State, name: string, override = false): bool = + if override or name notin gState.symOverride: + let + nimName = name[0] & name[1 .. ^1].replace("_", "").toLowerAscii + + if gState.identifiers.hasKey(nimName): + doAssert name == gState.identifiers[nimName], + &"Identifier '{name}' is a stylistic duplicate of identifier " & + &"'{gState.identifiers[nimName]}', use 'cPlugin:onSymbol()' to rename" + result = false + else: + gState.identifiers[nimName] = name + result = true + +# Overrides related + +proc getOverride*(gState: State, name: string, kind: NimSymKind): string = + # Get cOverride for identifier `name` of `kind` if defined + doAssert name.nBl, "Blank identifier error" + + if gState.onSymbolOverride != nil: + var + nname = gState.getIdentifier(name, kind, "IgnoreSkipSymbol") + sym = Symbol(name: nname, kind: kind) + if nname.nBl: + gState.onSymbolOverride(sym) + + if sym.override.nBl and gState.addNewIdentifer(nname, override = true): + result = sym.override + + if kind != nskProc: + result = " " & result.replace("\n", "\n ") + +proc getOverrideFinal*(gState: State, kind: NimSymKind): string = + # Get all unused cOverride symbols of `kind` + let + typ = $kind + + if gState.onSymbolOverrideFinal != nil: + for i in gState.onSymbolOverrideFinal(typ): + result &= "\n" & gState.getOverride(i, kind) + +proc getKeyword*(kind: NimSymKind): string = + # Convert `kind` into a Nim keyword + # cOverride procs already include `proc` keyword + result = ($kind).replace("nsk", "").toLowerAscii() + +proc getCurrentHeader*(fullpath: string): string = + ("header" & fullpath.splitFile().name.multiReplace([(".", ""), ("-", "")])) + +proc isIncluded(gState: State, file: string): bool {.inline.} = + # Check if the specified file should be excluded from wrapped output + if gState.exclude.nBl: + for excl in gState.exclude: + if file.startsWith(excl): + return + result = true + +proc getPreprocessor*(gState: State, fullpath: string) = + # Get preprocessed output from the C/C++ compiler + var + args: seq[string] + start = false + sfile = fullpath.sanitizePath(noQuote = true) + + sfileName = sfile.extractFilename() + pDir = sfile.expandFilename().parentDir() + includeDirs: seq[string] + + args.add @["-E", "-dD", getGccModeArg(gState.mode), "-w"] + if not gState.noComments: + args.add "-CC" + + for inc in gState.includeDirs: + args.add &"-I{inc.sanitizePath}" + includeDirs.add inc.absolutePath().sanitizePath(noQuote = true) + + for def in gState.defines: + args.add &"-D{def}" + + # Remove gcc special calls + # https://github.com/tree-sitter/tree-sitter-c/issues/43 + args.add @["-D__attribute__(x)=", "-D__restrict=", "-D__restrict__=", "-D__extension__=", "-D__inline__=inline", + "-D__inline=inline", "-D_Noreturn=", &"{fullpath.sanitizePath}"] + + # Include content only from file + var + p = startProcess(getCompiler(), args = args, options = {poStdErrToStdOut, poUsePath}) + outp = p.outputStream() + line = "" + newHeaders: HashSet[string] + + # Include content only from file + gState.code = "" + while true: + if outp.readLine(line): + # We want to keep blank lines here for comment processing + if line.len > 10 and line[0] == '#' and line[1] == ' ' and line.contains('"'): + # # 1 "path/to/file.h" 1 + start = false + line = line.split('"')[1].sanitizePath(noQuote = true) + if sfile == line or + (DirSep notin line and sfileName == line): + start = true + elif gState.recurse: + if (pDir.Bl or pDir in line) and line notin gState.headersProcessed: + newHeaders.incl line + start = gState.isIncluded(line) + else: + for inc in includeDirs: + if line.startsWith(inc) and line notin gState.headersProcessed: + newHeaders.incl line + start = gState.isIncluded(line) + if start: + break + elif ": fatal error:" in line: + doAssert false, + "\n\nFailed in preprocessing, check if `cIncludeDir()` is needed or compiler `mode` is correct (c/cpp)" & + "\n\nERROR:$1\n" % line.split(": fatal error:")[1] + else: + if start: + if "#undef" in line: + continue + gState.code.add line & "\n" + elif not p.running(): break + p.close() + assert p.peekExitCode() == 0, + gState.code & "\n\nFailed in preprocessing:\n " & + getCompiler() & " " & args.join(" ") + gState.headersProcessed.incl newHeaders + +# Plugin related + +proc dll*(path: string): string = + let + (dir, name, _) = path.splitFile() + + result = dir / (DynlibFormat % name) + +proc loadPlugin*(gState: State, sourcePath: string) = + doAssert fileExists(sourcePath), "Plugin file does not exist: " & sourcePath + + let + pdll = sourcePath.dll + if not fileExists(pdll) or + sourcePath.getLastModificationTime() > pdll.getLastModificationTime(): + let + # Get Nim configuration flags if not already specified in a .cfg file + flags = + if fileExists(sourcePath & ".cfg"): "" + else: getNimConfigFlags(getCurrentDir()) + + # Always set output to same directory as source, prevents override + outflags = &"--out:\"{pdll}\"" + + # Compile plugin as library with `markAndSweep` GC + cmd = &"{gState.nim} c --app:lib --gc:markAndSweep {flags} {outflags} {sourcePath.sanitizePath}" + + (output, ret) = execAction(cmd, die = false) + doAssert ret == 0, output & "\nFailed to compile cPlugin()\n\ncmd: " & cmd + doAssert fileExists(pdll), "No plugin binary generated for " & sourcePath + + let lib = loadLib(pdll) + doAssert lib != nil, "Plugin $1 compiled to $2 failed to load" % [sourcePath, pdll] + + gState.onSymbol = cast[OnSymbol](lib.symAddr("onSymbol")) + + gState.onSymbolOverride = cast[OnSymbol](lib.symAddr("onSymbolOverride")) + + gState.onSymbolOverrideFinal = cast[OnSymbolOverrideFinal](lib.symAddr("onSymbolOverrideFinal")) + +# Misc toast helpers + +proc getSplitComma*(joined: seq[string]): seq[string] = + for i in joined: + result = result.concat(i.split(",")) + +proc expandSymlinkAbs*(path: string): string = + try: + result = path.expandFilename().normalizedPath() + except: + result = path + result = result.sanitizePath(noQuote = true) diff --git a/nimterop/toastlib/tshelp.nim b/nimterop/toastlib/tshelp.nim new file mode 100644 index 0000000..81c8d0d --- /dev/null +++ b/nimterop/toastlib/tshelp.nim @@ -0,0 +1,410 @@ +import sets, strformat, strutils + +import ".."/treesitter/[api, c, cpp] +import ".."/globals + +template withCodeAst*(code: string, mode: string, body: untyped): untyped = + ## A simple template to inject the TSNode into a body of code + mixin treeSitterC + mixin treeSitterCpp + + var parser = tsParserNew() + defer: + parser.tsParserDelete() + + doAssert code.nBl, "Empty code or preprocessor error" + + if mode == "c": + doAssert parser.tsParserSetLanguage(treeSitterC()), "Failed to load C parser" + elif mode == "cpp": + doAssert parser.tsParserSetLanguage(treeSitterCpp()), "Failed to load C++ parser" + else: + doAssert false, "Invalid parser " & mode + + var + tree = parser.tsParserParseString(nil, code.cstring, code.len.uint32) + root {.inject.} = tree.tsTreeRootNode() + + body + + defer: + tree.tsTreeDelete() + +proc isNil*(node: TSNode): bool = + node.tsNodeIsNull() + +proc len*(node: TSNode): int = + if not node.isNil: + result = node.tsNodeNamedChildCount().int + +proc `[]`*(node: TSNode, i: SomeInteger): TSNode = + if i < type(i)(node.len()): + result = node.tsNodeNamedChild(i.uint32) + +proc getName*(node: TSNode): string {.inline.} = + if not node.isNil: + return $node.tsNodeType() + +proc getNodeVal*(code: var string, node: TSNode): string = + if not node.isNil: + return code[node.tsNodeStartByte() .. node.tsNodeEndByte()-1] + +proc getNodeVal*(gState: State, node: TSNode): string = + gState.code.getNodeVal(node) + +proc getAtom*(node: TSNode): TSNode = + if not node.isNil: + # Get child node which is topmost atom + if node.getName() in gAtoms: + return node + elif node.len != 0: + if node[0].getName() in ["type_qualifier", "comment"]: + # Skip const, volatile + if node.len > 1: + return node[1].getAtom() + else: + return + else: + return node[0].getAtom() + +proc getStartAtom*(node: TSNode): int = + if not node.isNil: + # Skip const, volatile and other type qualifiers + for i in 0 .. node.len - 1: + if node[i].getAtom().getName() notin gAtoms: + result += 1 + else: + break + +proc getConstQualifier*(gState: State, node: TSNode): bool = + # Check if node siblings have type_qualifier = `const` + var + curr = node.tsNodePrevNamedSibling() + while not curr.isNil: + # Check previous siblings + if curr.getName() == "type_qualifier" and + gState.getNodeVal(curr) == "const": + return true + curr = curr.tsNodePrevNamedSibling() + + # Check immediate next sibling + curr = node.tsNodePrevNamedSibling() + if curr.getName() == "type_qualifier" and + gState.getNodeVal(curr) == "const": + return true + +proc getXCount*(node: TSNode, ntype: string, reverse = false): int = + if not node.isNil: + # Get number of ntype nodes nested in tree + var + cnode = node + while ntype in cnode.getName(): + result += 1 + if reverse: + cnode = cnode.tsNodeParent() + else: + if cnode.len != 0: + if cnode[0].getName() == "type_qualifier": + # Skip const, volatile + if cnode.len > 1: + cnode = cnode[1] + else: + break + else: + cnode = cnode[0] + else: + break + +proc getPtrCount*(node: TSNode, reverse = false): int = + node.getXCount("pointer_declarator", reverse) + +proc getArrayCount*(node: TSNode, reverse = false): int = + node.getXCount("array_declarator") + +proc getDeclarator*(node: TSNode): TSNode = + if not node.isNil: + # Return if child is a function or array declarator + if node.getName() in ["function_declarator", "array_declarator"]: + return node + elif node.len != 0: + return node[0].getDeclarator() + +proc getVarargs*(node: TSNode): bool = + # Detect ... and add {.varargs.} + # + # `node` is the param list + # + # ... is an unnamed node, second last node and ) is last node + let + nlen = node.tsNodeChildCount() + if nlen > 1.uint32: + let + nval = node.tsNodeChild(nlen - 2.uint32).getName() + if nval == "...": + result = true + +proc firstChildInTree*(node: TSNode, ntype: string): TSNode = + # Search for node type in tree - first children + var + cnode = node + while not cnode.isNil: + if cnode.getName() == ntype: + return cnode + if cnode.len != 0: + for i in 0 ..< cnode.len: + if cnode[i].getName() != "comment": + cnode = cnode[i] + break + else: + cnode = cnode[0] + +proc anyChildInTree*(node: TSNode, ntype: string): TSNode = + # Search for node type anywhere in tree - depth first + var + cnode = node + while not cnode.isNil: + if cnode.getName() == ntype: + return cnode + for i in 0 ..< cnode.len: + let + ccnode = cnode[i].anyChildInTree(ntype) + if not ccnode.isNil: + return ccnode + if cnode != node: + cnode = cnode.tsNodeNextNamedSibling() + else: + break + +proc mostNestedChildInTree*(node: TSNode): TSNode = + # Search for the most nested child of node's type in tree + var + cnode = node + ntype = cnode.getName() + while not cnode.isNil and cnode.len != 0 and cnode[0].getName() == ntype: + cnode = cnode[0] + result = cnode + +proc inChildren*(node: TSNode, ntype: string): bool = + # Search for node type in immediate children + result = false + for i in 0 ..< node.len: + if (node[i]).getName() == ntype: + result = true + break + +proc getLineCol*(code: var string, node: TSNode): tuple[line, col: int] = + # Get line number and column info for node + let + point = node.tsNodeStartPoint() + result.line = point.row.int + 1 + result.col = point.column.int + 1 + +proc getLineCol*(gState: State, node: TSNode): tuple[line, col: int] = + getLineCol(gState.code, node) + +proc getEndLineCol*(code: var string, node: TSNode): tuple[line, col: int] = + # Get line number and column info for node + let + point = node.tsNodeEndPoint() + result.line = point.row.int + 1 + result.col = point.column.int + 1 + +proc getEndLineCol*(gState: State, node: TSNode): tuple[line, col: int] = + getEndLineCol(gState.code, node) + +proc getTSNodeNamedChildCountSansComments*(node: TSNode): int = + for i in 0 ..< node.len: + if node.getName() != "comment": + result += 1 + +proc getPxName*(node: TSNode, offset: int): string = + # Get the xth (grand)parent of the node + var + np = node + count = 0 + + while not np.isNil and count < offset: + np = np.tsNodeParent() + count += 1 + + if count == offset and not np.isNil: + return np.getName() + +proc printLisp*(code: var string, root: TSNode): string = + var + node = root + nextnode: TSNode + depth = 0 + + while true: + if not node.isNil and depth > -1: + result &= spaces(depth) + let + (line, col) = code.getLineCol(node) + result &= &"({$node.tsNodeType()} {line} {col} {node.tsNodeEndByte() - node.tsNodeStartByte()}" + let + val = code.getNodeVal(node) + if "\n" notin val and " " notin val: + result &= &" \"{val}\"" + else: + break + + if node.len() != 0: + result &= "\n" + nextnode = node[0] + depth += 1 + else: + result &= ")\n" + nextnode = node.tsNodeNextNamedSibling() + + if nextnode.isNil: + while true: + node = node.tsNodeParent() + depth -= 1 + if depth == -1: + break + result &= spaces(depth) & ")\n" + if node == root: + break + if not node.tsNodeNextNamedSibling().isNil: + node = node.tsNodeNextNamedSibling() + break + else: + node = nextnode + + if node == root: + break + +proc printLisp*(gState: State, root: TSNode): string = + printLisp(gState.code, root) + +proc printDebug*(gState: State, node: TSNode) = + if gState.debug: + gecho ("Input => " & gState.getNodeVal(node)).getCommented() + gecho gState.printLisp(node).getCommented() + +proc getCommentsStr*(gState: State, commentNodes: seq[TSNode]): string = + ## Generate a comment from a set of comment nodes. Comment is guaranteed + ## to be able to be rendered using nim doc + if commentNodes.len > 0: + for commentNode in commentNodes: + result &= "\n " & gState.getNodeVal(commentNode).strip() + + result = "```\n " & result.multiReplace( + { + "/**": "", "**/": "", "/*": "", + "*/": "", "/*": "", "//": "", + "\n": "\n ", "`": "" + } + # need to replace this last otherwise it supercedes other replacements + ).replace(" *", "").strip() & "\n```" + +proc getCommentNodes*(gState: State, node: TSNode, maxSearch=1): seq[TSNode] = + ## Get a set of comment nodes in order of priority. Will search up to ``maxSearch`` + ## nodes before and after the current node + ## + ## Priority is (closest line number) > comment before > comment after. + ## This priority might need to be changed based on the project, but + ## for now it is good enough + + # Skip this if we don't want comments + if gState.noComments: + return + + let (line, _) = gState.getLineCol(node) + + # Keep track of both directions from a node + var + prevSibling = node.tsNodePrevNamedSibling() + nextSibling = node.tsNodeNextNamedSibling() + nilNode: TSNode + + var + i = 0 + prevSiblingDistance, nextSiblingDistance: int = int.high + lowestDistance: int + commentsFound = false + + while not commentsFound and i < maxSearch: + # Distance from the current node will tell us approximately if the + # comment belongs to the node. The closer it is in terms of line + # numbers, the more we can be sure it's the comment we want + if not prevSibling.isNil: + if prevSibling.getName() == "comment": + prevSiblingDistance = abs(gState.getEndLineCol(prevSibling)[0] - line) + else: + prevSiblingDistance = int.high + if not nextSibling.isNil: + if nextSibling.getName() == "comment": + nextSiblingDistance = abs(gState.getLineCol(nextSibling)[0] - line) + else: + nextSiblingDistance = int.high + + lowestDistance = min(prevSiblingDistance, nextSiblingDistance) + + if prevSiblingDistance > maxSearch: + # If the line is out of range, skip searching + prevSibling = nilNode # Can't do `= nil` + + if nextSiblingDistance > maxSearch: + # If the line is out of range, skip searching + nextSibling = nilNode + + # Search above the current line for comments. When one is found + # keep going to retrieve successive comments for cases with multiple + # `//` style comments + while ( + not prevSibling.isNil and + prevSibling.getName() == "comment" and + prevSiblingDistance == lowestDistance + ): + # Put the previous nodes in reverse order so the comments + # make logical sense + result.insert(prevSibling, 0) + prevSibling = prevSibling.tsNodePrevNamedSibling() + commentsFound = true + + # If we've already found comments above the current line, quit + if commentsFound: + break + + # Search below or at the current line for comments. When one is found + # keep going to retrieve successive comments for cases with multiple + # `//` style comments + while ( + not nextSibling.isNil and + nextSibling.getName() == "comment" and + nextSiblingDistance == lowestDistance + ): + result.add(nextSibling) + nextSibling = nextSibling.tsNodeNextNamedSibling() + commentsFound = true + + if commentsFound: + break + + # Go to next sibling pair + if not prevSibling.isNil: + prevSibling = prevSibling.tsNodePrevNamedSibling() + if not nextSibling.isNil: + nextSibling = nextSibling.tsNodeNextNamedSibling() + + i += 1 + +proc getTSNodeNamedChildNames*(node: TSNode): seq[string] = + if node.tsNodeNamedChildCount() != 0: + for i in 0 .. node.tsNodeNamedChildCount()-1: + let + name = $node.tsNodeNamedChild(i).tsNodeType() + + if name != "comment": + result.add(name) + +proc getNodeError*(gState: State, node: TSNode): bool = + let + err = node.anyChildInTree("ERROR") + if not err.isNil: + # Bail on errors + gState.printDebug(node) + gecho &"# tree-sitter parse error: '{gState.getNodeVal(node).splitLines()[0]}', skipped" + result = true \ No newline at end of file diff --git a/nimterop/treesitter/api.nim b/nimterop/treesitter/api.nim new file mode 100644 index 0000000..b763722 --- /dev/null +++ b/nimterop/treesitter/api.nim @@ -0,0 +1,259 @@ +{.experimental: "codeReordering".} + +import strutils, os + +include ".."/enumtype +import ".."/[paths, setup] + +static: + treesitterSetup() + +const sourcePath = cacheDir / "treesitter" / "lib" + +when defined(Linux) and defined(gcc): + {.passC: "-std=c11".} + +{.passC: "-I$1" % (sourcePath / "include").} +{.passC: "-I$1" % (sourcePath / "src").} + +{.compile: sourcePath / "src" / "lib.c".} + +### Generated below + +{.push hint[ConvFromXtoItselfNotNeeded]: off.} +{.pragma: impapiHdr, header: sourcePath / "include" / "tree_sitter" / "api.h".} + +defineEnum(TSInputEncoding) +defineEnum(TSSymbolType) +defineEnum(TSLogType) +defineEnum(TSQueryPredicateStepType) +defineEnum(TSQueryError) + +const + TREE_SITTER_LANGUAGE_VERSION* = 11 + TREE_SITTER_MIN_COMPATIBLE_LANGUAGE_VERSION* = 9 + TSInputEncodingUTF8* = (0).TSInputEncoding + TSInputEncodingUTF16* = (TSInputEncodingUTF8 + 1).TSInputEncoding + TSSymbolTypeRegular* = (0).TSSymbolType + TSSymbolTypeAnonymous* = (TSSymbolTypeRegular + 1).TSSymbolType + TSSymbolTypeAuxiliary* = (TSSymbolTypeAnonymous + 1).TSSymbolType + TSLogTypeParse* = (0).TSLogType + TSLogTypeLex* = (TSLogTypeParse + 1).TSLogType + TSQueryPredicateStepTypeDone* = (0).TSQueryPredicateStepType + TSQueryPredicateStepTypeCapture* = (TSQueryPredicateStepTypeDone + 1).TSQueryPredicateStepType + TSQueryPredicateStepTypeString* = (TSQueryPredicateStepTypeCapture + 1).TSQueryPredicateStepType + TSQueryErrorNone* = (0).TSQueryError + TSQueryErrorSyntax* = (TSQueryErrorNone + 1).TSQueryError + TSQueryErrorNodeType* = (TSQueryErrorSyntax + 1).TSQueryError + TSQueryErrorField* = (TSQueryErrorNodeType + 1).TSQueryError + TSQueryErrorCapture* = (TSQueryErrorField + 1).TSQueryError + +type + TSSymbol* {.importc, impapiHdr.} = uint16 + TSFieldId* {.importc, impapiHdr.} = uint16 + TSLanguage* {.importc, impapiHdr, incompleteStruct.} = object + TSParser* {.importc, impapiHdr, incompleteStruct.} = object + TSTree* {.importc, impapiHdr, incompleteStruct.} = object + TSQuery* {.importc, impapiHdr, incompleteStruct.} = object + TSQueryCursor* {.importc, impapiHdr, incompleteStruct.} = object + TSPoint* {.bycopy, importc, impapiHdr.} = object + row*: uint32 + column*: uint32 + + TSRange* {.bycopy, importc, impapiHdr.} = object + start_point*: TSPoint + end_point*: TSPoint + start_byte*: uint32 + end_byte*: uint32 + + TSInput* {.bycopy, importc, impapiHdr.} = object + payload*: pointer + read*: proc (payload: pointer; byte_index: uint32; position: TSPoint; + bytes_read: ptr uint32): cstring {.cdecl.} + encoding*: TSInputEncoding + + TSLogger* {.bycopy, importc, impapiHdr.} = object + payload*: pointer + log*: proc (payload: pointer; a2: TSLogType; a3: cstring) {.cdecl.} + + TSInputEdit* {.bycopy, importc, impapiHdr.} = object + start_byte*: uint32 + old_end_byte*: uint32 + new_end_byte*: uint32 + start_point*: TSPoint + old_end_point*: TSPoint + new_end_point*: TSPoint + + TSNode* {.bycopy, importc, impapiHdr.} = object + context*: array[4, uint32] + id*: pointer + tree*: ptr TSTree + + TSTreeCursor* {.bycopy, importc, impapiHdr.} = object + tree*: pointer + id*: pointer + context*: array[2, uint32] + + TSQueryCapture* {.bycopy, importc, impapiHdr.} = object + node*: TSNode + index*: uint32 + + TSQueryMatch* {.bycopy, importc, impapiHdr.} = object + id*: uint32 + pattern_index*: uint16 + capture_count*: uint16 + captures*: ptr TSQueryCapture + + TSQueryPredicateStep* {.bycopy, importc, impapiHdr.} = object + `type`*: TSQueryPredicateStepType + value_id*: uint32 + +proc ts_parser_new*(): ptr TSParser {.importc, cdecl, impapiHdr.} +proc ts_parser_delete*(parser: ptr TSParser) {.importc, cdecl, impapiHdr.} +proc ts_parser_set_language*(self: ptr TSParser; language: ptr TSLanguage): bool {. + importc, cdecl, impapiHdr.} +proc ts_parser_language*(self: ptr TSParser): ptr TSLanguage {.importc, cdecl, impapiHdr.} +proc ts_parser_set_included_ranges*(self: ptr TSParser; ranges: ptr TSRange; + length: uint32) {.importc, cdecl, impapiHdr.} +proc ts_parser_included_ranges*(self: ptr TSParser; length: ptr uint32): ptr TSRange {. + importc, cdecl, impapiHdr.} +proc ts_parser_parse*(self: ptr TSParser; old_tree: ptr TSTree; input: TSInput): ptr TSTree {. + importc, cdecl, impapiHdr.} +proc ts_parser_parse_string*(self: ptr TSParser; old_tree: ptr TSTree; string: cstring; + length: uint32): ptr TSTree {.importc, cdecl, impapiHdr.} +proc ts_parser_parse_string_encoding*(self: ptr TSParser; old_tree: ptr TSTree; + string: cstring; length: uint32; + encoding: TSInputEncoding): ptr TSTree {. + importc, cdecl, impapiHdr.} +proc ts_parser_reset*(self: ptr TSParser) {.importc, cdecl, impapiHdr.} +proc ts_parser_set_timeout_micros*(self: ptr TSParser; timeout: uint64) {.importc, + cdecl, impapiHdr.} +proc ts_parser_timeout_micros*(self: ptr TSParser): uint64 {.importc, cdecl, impapiHdr.} +proc ts_parser_set_cancellation_flag*(self: ptr TSParser; flag: ptr uint) {.importc, + cdecl, impapiHdr.} +proc ts_parser_cancellation_flag*(self: ptr TSParser): ptr uint {.importc, cdecl, + impapiHdr.} +proc ts_parser_set_logger*(self: ptr TSParser; logger: TSLogger) {.importc, cdecl, + impapiHdr.} +proc ts_parser_logger*(self: ptr TSParser): TSLogger {.importc, cdecl, impapiHdr.} +proc ts_parser_print_dot_graphs*(self: ptr TSParser; file: cint) {.importc, cdecl, + impapiHdr.} +proc ts_parser_halt_on_error*(self: ptr TSParser; halt: bool) {.importc, cdecl, + impapiHdr.} +proc ts_tree_copy*(self: ptr TSTree): ptr TSTree {.importc, cdecl, impapiHdr.} +proc ts_tree_delete*(self: ptr TSTree) {.importc, cdecl, impapiHdr.} +proc ts_tree_root_node*(self: ptr TSTree): TSNode {.importc, cdecl, impapiHdr.} +proc ts_tree_language*(a1: ptr TSTree): ptr TSLanguage {.importc, cdecl, impapiHdr.} +proc ts_tree_edit*(self: ptr TSTree; edit: ptr TSInputEdit) {.importc, cdecl, impapiHdr.} +proc ts_tree_get_changed_ranges*(old_tree: ptr TSTree; new_tree: ptr TSTree; + length: ptr uint32): ptr TSRange {.importc, cdecl, + impapiHdr.} +proc ts_tree_print_dot_graph*(a1: ptr TSTree; a2: File) {.importc, cdecl, impapiHdr.} +proc ts_node_type*(a1: TSNode): cstring {.importc, cdecl, impapiHdr.} +proc ts_node_symbol*(a1: TSNode): TSSymbol {.importc, cdecl, impapiHdr.} +proc ts_node_start_byte*(a1: TSNode): uint32 {.importc, cdecl, impapiHdr.} +proc ts_node_start_point*(a1: TSNode): TSPoint {.importc, cdecl, impapiHdr.} +proc ts_node_end_byte*(a1: TSNode): uint32 {.importc, cdecl, impapiHdr.} +proc ts_node_end_point*(a1: TSNode): TSPoint {.importc, cdecl, impapiHdr.} +proc ts_node_string*(a1: TSNode): cstring {.importc, cdecl, impapiHdr.} +proc ts_node_is_null*(a1: TSNode): bool {.importc, cdecl, impapiHdr.} +proc ts_node_is_named*(a1: TSNode): bool {.importc, cdecl, impapiHdr.} +proc ts_node_is_missing*(a1: TSNode): bool {.importc, cdecl, impapiHdr.} +proc ts_node_is_extra*(a1: TSNode): bool {.importc, cdecl, impapiHdr.} +proc ts_node_has_changes*(a1: TSNode): bool {.importc, cdecl, impapiHdr.} +proc ts_node_has_error*(a1: TSNode): bool {.importc, cdecl, impapiHdr.} +proc ts_node_parent*(a1: TSNode): TSNode {.importc, cdecl, impapiHdr.} +proc ts_node_child*(a1: TSNode; a2: uint32): TSNode {.importc, cdecl, impapiHdr.} +proc ts_node_child_count*(a1: TSNode): uint32 {.importc, cdecl, impapiHdr.} +proc ts_node_named_child*(a1: TSNode; a2: uint32): TSNode {.importc, cdecl, impapiHdr.} +proc ts_node_named_child_count*(a1: TSNode): uint32 {.importc, cdecl, impapiHdr.} +proc ts_node_child_by_field_name*(self: TSNode; field_name: cstring; + field_name_length: uint32): TSNode {.importc, + cdecl, impapiHdr.} +proc ts_node_child_by_field_id*(a1: TSNode; a2: TSFieldId): TSNode {.importc, cdecl, + impapiHdr.} +proc ts_node_next_sibling*(a1: TSNode): TSNode {.importc, cdecl, impapiHdr.} +proc ts_node_prev_sibling*(a1: TSNode): TSNode {.importc, cdecl, impapiHdr.} +proc ts_node_next_named_sibling*(a1: TSNode): TSNode {.importc, cdecl, impapiHdr.} +proc ts_node_prev_named_sibling*(a1: TSNode): TSNode {.importc, cdecl, impapiHdr.} +proc ts_node_first_child_for_byte*(a1: TSNode; a2: uint32): TSNode {.importc, cdecl, + impapiHdr.} +proc ts_node_first_named_child_for_byte*(a1: TSNode; a2: uint32): TSNode {.importc, + cdecl, impapiHdr.} +proc ts_node_descendant_for_byte_range*(a1: TSNode; a2: uint32; a3: uint32): TSNode {. + importc, cdecl, impapiHdr.} +proc ts_node_descendant_for_point_range*(a1: TSNode; a2: TSPoint; a3: TSPoint): TSNode {. + importc, cdecl, impapiHdr.} +proc ts_node_named_descendant_for_byte_range*(a1: TSNode; a2: uint32; a3: uint32): TSNode {. + importc, cdecl, impapiHdr.} +proc ts_node_named_descendant_for_point_range*(a1: TSNode; a2: TSPoint; a3: TSPoint): TSNode {. + importc, cdecl, impapiHdr.} +proc ts_node_edit*(a1: ptr TSNode; a2: ptr TSInputEdit) {.importc, cdecl, impapiHdr.} +proc ts_node_eq*(a1: TSNode; a2: TSNode): bool {.importc, cdecl, impapiHdr.} +proc ts_tree_cursor_new*(a1: TSNode): TSTreeCursor {.importc, cdecl, impapiHdr.} +proc ts_tree_cursor_delete*(a1: ptr TSTreeCursor) {.importc, cdecl, impapiHdr.} +proc ts_tree_cursor_reset*(a1: ptr TSTreeCursor; a2: TSNode) {.importc, cdecl, impapiHdr.} +proc ts_tree_cursor_current_node*(a1: ptr TSTreeCursor): TSNode {.importc, cdecl, + impapiHdr.} +proc ts_tree_cursor_current_field_name*(a1: ptr TSTreeCursor): cstring {.importc, + cdecl, impapiHdr.} +proc ts_tree_cursor_current_field_id*(a1: ptr TSTreeCursor): TSFieldId {.importc, + cdecl, impapiHdr.} +proc ts_tree_cursor_goto_parent*(a1: ptr TSTreeCursor): bool {.importc, cdecl, + impapiHdr.} +proc ts_tree_cursor_goto_next_sibling*(a1: ptr TSTreeCursor): bool {.importc, cdecl, + impapiHdr.} +proc ts_tree_cursor_goto_first_child*(a1: ptr TSTreeCursor): bool {.importc, cdecl, + impapiHdr.} +proc ts_tree_cursor_goto_first_child_for_byte*(a1: ptr TSTreeCursor; a2: uint32): int64 {. + importc, cdecl, impapiHdr.} +proc ts_tree_cursor_copy*(a1: ptr TSTreeCursor): TSTreeCursor {.importc, cdecl, + impapiHdr.} +proc ts_query_new*(language: ptr TSLanguage; source: cstring; source_len: uint32; + error_offset: ptr uint32; error_type: ptr TSQueryError): ptr TSQuery {. + importc, cdecl, impapiHdr.} +proc ts_query_delete*(a1: ptr TSQuery) {.importc, cdecl, impapiHdr.} +proc ts_query_pattern_count*(a1: ptr TSQuery): uint32 {.importc, cdecl, impapiHdr.} +proc ts_query_capture_count*(a1: ptr TSQuery): uint32 {.importc, cdecl, impapiHdr.} +proc ts_query_string_count*(a1: ptr TSQuery): uint32 {.importc, cdecl, impapiHdr.} +proc ts_query_start_byte_for_pattern*(a1: ptr TSQuery; a2: uint32): uint32 {.importc, + cdecl, impapiHdr.} +proc ts_query_predicates_for_pattern*(self: ptr TSQuery; pattern_index: uint32; + length: ptr uint32): ptr TSQueryPredicateStep {. + importc, cdecl, impapiHdr.} +proc ts_query_capture_name_for_id*(a1: ptr TSQuery; id: uint32; length: ptr uint32): cstring {. + importc, cdecl, impapiHdr.} +proc ts_query_string_value_for_id*(a1: ptr TSQuery; id: uint32; length: ptr uint32): cstring {. + importc, cdecl, impapiHdr.} +proc ts_query_disable_capture*(a1: ptr TSQuery; a2: cstring; a3: uint32) {.importc, + cdecl, impapiHdr.} +proc ts_query_cursor_new*(): ptr TSQueryCursor {.importc, cdecl, impapiHdr.} +proc ts_query_cursor_delete*(a1: ptr TSQueryCursor) {.importc, cdecl, impapiHdr.} +proc ts_query_cursor_exec*(a1: ptr TSQueryCursor; a2: ptr TSQuery; a3: TSNode) {.importc, + cdecl, impapiHdr.} +proc ts_query_cursor_set_byte_range*(a1: ptr TSQueryCursor; a2: uint32; a3: uint32) {. + importc, cdecl, impapiHdr.} +proc ts_query_cursor_set_point_range*(a1: ptr TSQueryCursor; a2: TSPoint; a3: TSPoint) {. + importc, cdecl, impapiHdr.} +proc ts_query_cursor_next_match*(a1: ptr TSQueryCursor; match: ptr TSQueryMatch): bool {. + importc, cdecl, impapiHdr.} +proc ts_query_cursor_remove_match*(a1: ptr TSQueryCursor; id: uint32) {.importc, cdecl, + impapiHdr.} +proc ts_query_cursor_next_capture*(a1: ptr TSQueryCursor; match: ptr TSQueryMatch; + capture_index: ptr uint32): bool {.importc, cdecl, + impapiHdr.} +proc ts_language_symbol_count*(a1: ptr TSLanguage): uint32 {.importc, cdecl, impapiHdr.} +proc ts_language_symbol_name*(a1: ptr TSLanguage; a2: TSSymbol): cstring {.importc, + cdecl, impapiHdr.} +proc ts_language_symbol_for_name*(self: ptr TSLanguage; string: cstring; + length: uint32; is_named: bool): TSSymbol {.importc, + cdecl, impapiHdr.} +proc ts_language_field_count*(a1: ptr TSLanguage): uint32 {.importc, cdecl, impapiHdr.} +proc ts_language_field_name_for_id*(a1: ptr TSLanguage; a2: TSFieldId): cstring {. + importc, cdecl, impapiHdr.} +proc ts_language_field_id_for_name*(a1: ptr TSLanguage; a2: cstring; a3: uint32): TSFieldId {. + importc, cdecl, impapiHdr.} +proc ts_language_symbol_type*(a1: ptr TSLanguage; a2: TSSymbol): TSSymbolType {. + importc, cdecl, impapiHdr.} +proc ts_language_version*(a1: ptr TSLanguage): uint32 {.importc, cdecl, impapiHdr.} +{.pop.} diff --git a/nimterop/treesitter/c.nim b/nimterop/treesitter/c.nim new file mode 100644 index 0000000..4280b91 --- /dev/null +++ b/nimterop/treesitter/c.nim @@ -0,0 +1,16 @@ +import strutils, os + +import ".."/[setup, paths] + +static: + treesitterCSetup() + +const srcDir = cacheDir / "treesitter_c" / "src" + +import "."/api + +{.passC: "-I$1" % srcDir.} + +{.compile: srcDir / "parser.c".} + +proc treeSitterC*(): ptr TSLanguage {.importc: "tree_sitter_c".} diff --git a/nimterop/treesitter/cpp.nim b/nimterop/treesitter/cpp.nim new file mode 100644 index 0000000..fd0437e --- /dev/null +++ b/nimterop/treesitter/cpp.nim @@ -0,0 +1,21 @@ +import strutils, os + +import ".."/[setup, paths] +import ".."/build/shell + +static: + treesitterCppSetup() + +const srcDir = cacheDir / "treesitter_cpp" / "src" + +{.passC: "-I$1" % srcDir.} + +import "."/api + +static: + cpFile(srcDir / "parser.c", srcDir / "parser_cpp.c") + +{.compile: srcDir / "parser_cpp.c".} +{.compile: srcDir / "scanner.cc".} + +proc treeSitterCpp*(): ptr TSLanguage {.importc: "tree_sitter_cpp".} diff --git a/nimterop/treesitter/tsgen.nim b/nimterop/treesitter/tsgen.nim new file mode 100644 index 0000000..ee2c8e0 --- /dev/null +++ b/nimterop/treesitter/tsgen.nim @@ -0,0 +1,11 @@ +# nim c tsgen.nim > temp.nim +# Move temp.nim contents to api.nim below generated line + minor adjustments + +import os + +import nimterop/[cimport, paths] + +static: + cDebug() + +cImport(cacheDir / "treesitter" / "lib" / "include" / "tree_sitter" / "api.h", flags = "-E_ -c") diff --git a/paths.html b/paths.html deleted file mode 100644 index 672c3eb..0000000 --- a/paths.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - - - - - - - - - - - - - -paths - - - - - - - - -
-
-

paths

-
-
-
- -     Dark Mode -
- -
- Search: -
-
- Group by: - -
- - -
-
-
- -

-
-

Imports

-
-build -
-
-

Consts

-
- -
cacheDir = "/home/genotrance/.cache/nim/nimterop/nimterop"
-
- - - -
- -
-
-

Procs

-
- -
proc nimteropRoot(): string {...}{.raises: [], tags: [].}
-
- - - -
- -
proc nimteropSrcDir(): string {...}{.raises: [], tags: [].}
-
- - - -
- -
proc toastExePath(): string {...}{.raises: [], tags: [].}
-
- - - -
- -
proc testsIncludeDir(): string {...}{.raises: [], tags: [].}
-
- - - -
- -
- -
-
- -
-
- -
- Made with Nim. Generated: 2020-03-24 20:55:39 UTC -
-
-
-
- - - diff --git a/paths.idx b/paths.idx deleted file mode 100644 index 0392c66..0000000 --- a/paths.idx +++ /dev/null @@ -1,5 +0,0 @@ -cacheDir paths.html#cacheDir paths: cacheDir -nimteropRoot paths.html#nimteropRoot paths: nimteropRoot(): string -nimteropSrcDir paths.html#nimteropSrcDir paths: nimteropSrcDir(): string -toastExePath paths.html#toastExePath paths: toastExePath(): string -testsIncludeDir paths.html#testsIncludeDir paths: testsIncludeDir(): string diff --git a/plugin.html b/plugin.html deleted file mode 100644 index eae2f37..0000000 --- a/plugin.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - - - - - - - - - - - - - -plugin - - - - - - - - -
-
-

plugin

-
-
-
- -     Dark Mode -
- -
- Search: -
-
- Group by: - -
- - -
-
-
- -

-
-

Types

-
- -
Symbol = object
-  name*: string
-  parent*: string
-  kind*: NimSymKind
-  override*: string
-
-
- - - -
- -
OnSymbol = proc (sym: var Symbol) {...}{.cdecl.}
-
- - - -
- -
OnSymbolOverrideFinal = proc (typ: string): StringHash {...}{.cdecl.}
-
- - - -
- -
-
-

Vars

-
- -
cOverrides: Table[string, StringHash]
-
- - - -
- -
-
-

Procs

-
- -
proc onSymbolOverrideFinal(typ: string): StringHash {...}{.exportc, dynlib,
-    raises: [KeyError], tags: [].}
-
- - - -
- -
- -
-
- -
-
- -
- Made with Nim. Generated: 2020-03-24 20:55:39 UTC -
-
-
-
- - - diff --git a/plugin.idx b/plugin.idx deleted file mode 100644 index 94cbcd1..0000000 --- a/plugin.idx +++ /dev/null @@ -1,5 +0,0 @@ -Symbol plugin.html#Symbol plugin: Symbol -OnSymbol plugin.html#OnSymbol plugin: OnSymbol -OnSymbolOverrideFinal plugin.html#OnSymbolOverrideFinal plugin: OnSymbolOverrideFinal -cOverrides plugin.html#cOverrides plugin: cOverrides -onSymbolOverrideFinal plugin.html#onSymbolOverrideFinal,string plugin: onSymbolOverrideFinal(typ: string): StringHash diff --git a/tests/getheader.nims b/tests/getheader.nims new file mode 100644 index 0000000..e5d964c --- /dev/null +++ b/tests/getheader.nims @@ -0,0 +1,75 @@ +import strutils + +proc testCall(cmd, output: string, exitCode: int, delete = true) = + var + ccmd = "../tests/timeit " & cmd + + if not delete: + ccmd = ccmd.replace(" -f ", " ") + + var + (outp, exitC) = gorgeEx(ccmd) + echo outp + doAssert exitC == exitCode, $exitC + doAssert outp.contains(output), outp + +var + cmd = "nim c -f --hints:off -d:checkAbi" + lrcmd = " -r lzma.nim" + zrcmd = " -r zlib.nim" + sshcmd = " -r libssh2.nim" + lexp = "liblzma version = " + zexp = "zlib version = " + +when (NimMajor, NimMinor, NimPatch) >= (1, 2, 0): + cmd &= " --gc:arc" + +testCall(cmd & lrcmd, "No build files found", 1) +testCall(cmd & " -d:libssh2Conan" & sshcmd, "Need version for Conan.io uri", 1) +testCall(cmd & " -d:libssh2JBB -d:libssh2SetVer=1.9.0" & sshcmd, "Version in both uri", 1) + +when defined(posix): + # stdlib + testCall(cmd & " -d:envTest" & lrcmd, lexp, 0) + testCall(cmd & " -d:envTestStatic" & lrcmd, lexp, 0) + + when not defined(osx): + testCall(cmd & " -d:zlibStd" & zrcmd, zexp, 0) + testCall(cmd & " -d:zlibStd -d:zlibStatic" & zrcmd, zexp, 0) + + # git tag + testCall(cmd & " -d:lzmaGit -d:lzmaSetVer=v5.2.0" & lrcmd, lexp & "5.2.0", 0) + testCall(cmd & " -d:lzmaGit -d:lzmaStatic -d:lzmaSetVer=v5.2.0" & lrcmd, lexp & "5.2.0", 0, delete = false) + + # conan static + testCall(cmd & " -d:libssh2Conan -d:libssh2SetVer=1.9.0 -d:libssh2Static" & sshcmd, zexp, 0) +else: + # conan static for Windows + testCall(cmd & " -d:zlibConan -d:zlibSetVer=1.2.11 -d:zlibStatic" & zrcmd, zexp, 0) + +# JBB +testCall(cmd & " -d:libssh2JBB" & sshcmd, zexp, 0) +testCall(cmd & " -d:zlibJBB -d:zlibSetVer=1.2.11" & zrcmd, zexp, 0) +testCall(cmd & " -d:zlibJBB -d:zlibSetVer=1.2.11 -d:zlibStatic" & zrcmd, zexp, 0, delete = false) +testCall(cmd & " -d:lzmaJBB -d:lzmaSetVer=5.2.4" & lrcmd, lexp & "5.2.4", 0) + +# git +testCall(cmd & " -d:envTest" & zrcmd, zexp, 0) +testCall(cmd & " -d:envTestStatic" & zrcmd, zexp, 0, delete = false) + +# git tag +testCall(cmd & " -d:zlibGit -d:zlibSetVer=v1.2.10" & zrcmd, zexp & "1.2.10", 0) +testCall(cmd & " -d:zlibGit -d:zlibStatic -d:zlibSetVer=v1.2.10" & zrcmd, zexp & "1.2.10", 0, delete = false) + +# dl +testCall(cmd & " -d:lzmaDL" & lrcmd, "Need version", 1) +testCall(cmd & " -d:lzmaDL -d:lzmaSetVer=5.2.4" & lrcmd, lexp & "5.2.4", 0) +testCall(cmd & " -d:lzmaDL -d:lzmaStatic -d:lzmaSetVer=5.2.4" & lrcmd, lexp & "5.2.4", 0, delete = false) + +# dl +testCall(cmd & " -d:zlibDL -d:zlibSetVer=1.2.11" & zrcmd, zexp & "1.2.11", 0) +testCall(cmd & " -d:zlibDL -d:zlibStatic -d:zlibSetVer=1.2.11" & zrcmd, zexp & "1.2.11", 0, delete = false) + +# conan +testCall(cmd & " -d:libssh2Conan -d:libssh2SetVer=1.9.0" & sshcmd, zexp, 0) +testCall(cmd & " -d:lzmaConan -d:lzmaSetVer=5.2.4" & lrcmd, lexp & "5.2.4", 0) \ No newline at end of file diff --git a/tests/include/tast2.h b/tests/include/tast2.h new file mode 100644 index 0000000..ede71d5 --- /dev/null +++ b/tests/include/tast2.h @@ -0,0 +1,603 @@ +#ifdef __cplusplus +extern "C" { +#endif + +#define A 1 +#define B 1.0 +#define C 0x10 +#define D "hello" +#define E 'c' +#define F 01234 + +#define UEXPR (1234u << 1) +#define ULEXPR (1234ul << 2) +#define ULLEXPR (1234ull << 3) +#define LEXPR (1234l << 4) +#define LLEXPR (1234ll << 5) + +#define SHL1 (1u << 1) +#define SHL2 (1u << 2) +#define SHL3 (1u << 3) +#define COERCE 645635634896ull + 35436 +#define COERCE2 645635634896 + 35436ul +#define BINEXPR ~(-(1u << !-1)) ^ (10 >> 1) +#define POINTEREXPR (int*)0 +#define POINTERPOINTERPOINTEREXPR (int***)0 +#define BOOL true +#define MATHEXPR (1 + 2/3*20 - 100) +#define ANDEXPR (100 & 11000) +#define CASTEXPR (char) 34 +#define AVAL 100 +#define BVAL 200 +#define EQ1 AVAL <= BVAL +#define EQ2 AVAL >= BVAL +#define EQ3 AVAL > BVAL +#define EQ4 AVAL < BVAL +#define EQ5 AVAL != BVAL +#define EQ6 AVAL == BVAL +#define SX_NEAR_ZERO (1.0f / (1 << 28)) + +// testing integer out of long int range +#define INT_FAST16_MIN (-9223372036854775807L-1) + +#define SIZEOF sizeof(char) +#define REG_STR "regular string" +#define NOTSUPPORTEDSTR "not a " REG_STR + +#define NULLCHAR '\0' +#define OCTCHAR '\012' +#define HEXCHAR '\xFE' +#define TRICKYSTR "\x4E\034\nfoo\0\'\"\r\v\a\b\e\f\t\\\?bar" + +#define ALLSHL (SHL1 | SHL2 | SHL3) + +#ifdef NIMTEROP +#define SOME_CONST 8 +#endif + +struct some_struct_s +{ + int x; +}; + +struct parent_struct_s +{ + /* Random comment */ + struct some_struct_s s[SOME_CONST]; +}; + +typedef struct some_struct_s SOME_ARRAY[SOME_CONST]; + +struct A0; +struct A1 {}; +typedef struct A2; +typedef struct A3 {}; +typedef struct A4 A4, *A4p; +typedef const int A5; +typedef int *A6; +typedef struct A0 **A7; +typedef void *A8; + +// Forward declaration +struct A0 { + int f1; +}; + +struct A4 { + float f1; +}; + +typedef char *A9p[3], A9[4]; +typedef char *A10[3][6]; +typedef char *(*A11)[3]; +typedef struct A0 *A111[12]; + +typedef int + **(*A12)(int, int b, int *c, int *, int /*out*/ *count[4], int (*func)(int, int)), + **(*A121)(float, float b, float *c, float *, float *count[4], float (*func)(float, float)), + **(*A122)(char, char b, char *c, char *, char *count[4], char (*func)(char, char)); +typedef int (*A13)(int, int, void (*func)(void)); + +struct A14 { volatile char a1; }; +struct A15 { char *a1; const int *a2[1]; }; + +typedef struct A16 { char f1; }; +typedef struct A17 { char *a1; int *a2[1]; } A18, *A18p; +typedef struct { char *a1; int *a2[1]; } A19, *A19p; + +typedef struct A20 { char a1; } A20, A21, *A21p; + +//Expression +typedef struct A22 { const int **f1; int *f2[123+132]; } A22; + +// #231 +typedef const char *(*A23)(); + +//Unions +union U1 {int f1; float f2; }; +typedef union U2 { const int **f1; int abc[123+132]; } U2; + +// Enums + +// Issue #159 +#define NK_FLAG(x) (1 << (x)) +enum nk_panel_type { + NK_PANEL_NONE = 0, + NK_PANEL_WINDOW = NK_FLAG(0), + NK_PANEL_GROUP = NK_FLAG(1), + NK_PANEL_POPUP = NK_FLAG(2), + NK_PANEL_CONTEXTUAL = NK_FLAG(4), + NK_PANEL_COMBO = NK_FLAG(5), + NK_PANEL_MENU = NK_FLAG(6), + NK_PANEL_TOOLTIP = NK_FLAG(7) +}; +enum nk_panel_set { + NK_PANEL_SET_NONBLOCK = NK_PANEL_CONTEXTUAL|NK_PANEL_COMBO|NK_PANEL_MENU|NK_PANEL_TOOLTIP, + NK_PANEL_SET_POPUP = NK_PANEL_SET_NONBLOCK|NK_PANEL_POPUP, + NK_PANEL_SET_SUB = NK_PANEL_SET_POPUP|NK_PANEL_GROUP +}; + +// Issue #171 +typedef enum VSColorFamily { + /* all planar formats */ + cmGray = 1000000, + cmRGB = 2000000, + cmYUV = 3000000, + cmYCoCg = 4000000, + /* special for compatibility */ + cmCompat = 9000000 +} VSColorFamily; + +typedef enum VSPresetFormat { + pfNone = 0, + + pfGray8 = cmGray + 10, + pfGray16, + + pfYUV420P8 = cmYUV + 10, + pfYUV422P8, + + pfRGB24 = cmRGB + 10, + pfRGB27, + /* test */ + + pfCompatBGR32 = cmCompat + 10, + pfCompatYUY2 +} VSPresetFormat; + +// Anonymous +//typedef struct { char a1; }; + +//struct A2 test_proc1(struct A0 a); + +// Proc vars +void + *(*pcre_malloc)(size_t, ...), + (*pcre_free)(void *), + *(*pcre_stack_malloc)(size_t); + +typedef int ImageView, MagickBooleanType; +typedef MagickBooleanType + (*DuplexTransferImageViewMethod)(const ImageView *,const ImageView *, + ImageView *,const size_t,const int,void *), + (*GetImageViewMethod)(const ImageView *,const size_t,const int,void *), + (*SetImageViewMethod)(ImageView *,const size_t,const int,void *), + (*TransferImageViewMethod)(const ImageView *,ImageView *,const size_t, + const int,void *), +(*UpdateImageViewMethod)(ImageView *,const size_t,const int,void *); + +// Issue #156, math.h +void + *absfunptr1 (int (*)(struct A0 *)), + **absfunptr2 (int (**)(struct A1 *)), + absfunptr3 (int *(*)(struct A2 *)), + *absfunptr4 (int *(**)(struct A3 *)), + absfunptr5 (int (*a)(A4 *)); + +int sqlite3_bind_blob(struct A1*, int, const void*, int n, void(*)(void*)); + +// Issue #174 - type name[] => UncheckedArray[type] +int ucArrFunc1(int text[]); +int ucArrFunc2(int text[][5], int (*func)(int text[])); + +typedef int ucArrType1[][5]; +struct ucArrType2 { + float f1[5][5]; + int *f2[][5]; +}; + +typedef struct fieldfuncfunc { + int *(*func1)(int f1, int *(*sfunc1)(int f1, int *(*ssfunc1)(int f1, ...))); +}; + +int *func2(int f1, int *(*sfunc2)(int f1, int *(*ssfunc2)(int f1))); + +typedef struct { + const char *name; // description + const char *driver; // driver + int flags; +} BASS_DEVICEINFO; + +// Issue #183 +struct GPU_Target +{ + int w, *h; + char *x, y, **z; +}; + +// Issue #185 +struct SDL_AudioCVT; + +typedef struct SDL_AudioCVT +{ + int needed; +} SDL_AudioCVT; + +// Issue #172 +typedef struct { + const char* const* x; +} SomeType; + +// Nested #137 +typedef struct { + struct NT1 { int f1; } f1; + struct { int f1; } f2; + + struct NT3 { + /* Random comment */ + struct { + int f1; + union NU1 { + float f1; + } f2; + enum { NEV1, NEV2, NEV3 } f3; + } f1; + } f3; + + struct { int f1; } f4; + + union NU2 { int f1; } f5; + union { int f1; } f6; + enum NE1 { NEV4 = 8, NEV5 } f7; + enum { NEV6 = 8 * 8, NEV7 } f8; +} nested; + +static inline int sitest1(int f1) { + return f1 * 2; +} + +// Issue #196 +typedef int MyInt; +struct TestMyInt { + MyInt f1; +}; + +// Issue #237 +typedef union sx_ivec3 { + struct { + int x; + int y; + struct { + int z; + }; + }; + + int n[3]; +} sx_ivec3; + +// Issue #236 +enum { + SG_INVALID_ID = 0, + SG_NUM_SHADER_STAGES = 2, + SG_MAX_MIPMAPS = 16, + SG_MAX_TEXTUREARRAY_LAYERS = 128 +}; + +struct parenpoin { + void (*gtk_reserved1); +}; + + +// DUPLICATES + +#ifdef NOHEADER + +#define A 1 +#define B 1.0 +#define C 0x10 +#define D "hello" +#define E 'c' +#define F 01234 + +#define UEXPR (1234u << 1) +#define ULEXPR (1234ul << 2) +#define ULLEXPR (1234ull << 3) +#define LEXPR (1234l << 4) +#define LLEXPR (1234ll << 5) + +#define SHL1 (1u << 1) +#define SHL2 (1u << 2) +#define SHL3 (1u << 3) +#define COERCE 645635634896ull + 35436 +#define COERCE2 645635634896 + 35436ul +#define BINEXPR ~(-(1u << !-1)) ^ (10 >> 1) +#define POINTEREXPR (int*)0 +#define POINTERPOINTERPOINTEREXPR (int***)0 +#define BOOL true +#define MATHEXPR (1 + 2/3*20 - 100) +#define ANDEXPR (100 & 11000) +#define CASTEXPR (char) 34 +#define AVAL 100 +#define BVAL 200 +#define EQ1 AVAL <= BVAL +#define EQ2 AVAL >= BVAL +#define EQ3 AVAL > BVAL +#define EQ4 AVAL < BVAL +#define EQ5 AVAL != BVAL +#define EQ6 AVAL == BVAL + +// testing integer out of long int range +#define INT_FAST16_MIN (-9223372036854775807L-1) + +#define SIZEOF sizeof(char) +#define REG_STR "regular string" +#define NOTSUPPORTEDSTR "not a " REG_STR + +#define NULLCHAR '\0' +#define OCTCHAR '\012' +#define HEXCHAR '\xFE' +#define TRICKYSTR "\x4E\034\nfoo\0\'\"\r\v\a\b\e\f\t\\\?bar" + +#define ALLSHL (SHL1 | SHL2 | SHL3) + +#ifdef NIMTEROP +#define SOME_CONST 8 +#endif + +struct some_struct_s +{ + int x; +}; + +struct parent_struct_s +{ + /* Random comment */ + struct some_struct_s s[SOME_CONST]; +}; + +typedef struct some_struct_s SOME_ARRAY[SOME_CONST]; + +struct A0; +struct A1 {}; +typedef struct A2; +typedef struct A3 {}; +typedef struct A4 A4, *A4p; +typedef const int A5; +typedef int *A6; +typedef struct A0 **A7; +typedef void *A8; + +// Forward declaration +struct A0 { + int f1; +}; + +struct A4 { + float f1; +}; + +typedef char *A9p[3], A9[4]; +typedef char *A10[3][6]; +typedef char *(*A11)[3]; +typedef struct A0 *A111[12]; + +typedef int + **(*A12)(int, int b, int *c, int *, int /*out*/ *count[4], int (*func)(int, int)), + **(*A121)(float, float b, float *c, float *, float *count[4], float (*func)(float, float)), + **(*A122)(char, char b, char *c, char *, char *count[4], char (*func)(char, char)); +typedef int (*A13)(int, int, void (*func)(void)); + +struct A14 { volatile char a1; }; +struct A15 { char *a1; const int *a2[1]; }; + +typedef struct A16 { char f1; }; +typedef struct A17 { char *a1; int *a2[1]; } A18, *A18p; +typedef struct { char *a1; int *a2[1]; } A19, *A19p; + +typedef struct A20 { char a1; } A20, A21, *A21p; + +//Expression +typedef struct A22 { const int **f1; int *f2[123+132]; } A22; + +// #231 +typedef const char *(*A23)(); + +//Unions +union U1 {int f1; float f2; }; +typedef union U2 { const int **f1; int abc[123+132]; } U2; + +// Enums + +// Issue #159 +#define NK_FLAG(x) (1 << (x)) +enum nk_panel_type { + NK_PANEL_NONE = 0, + NK_PANEL_WINDOW = NK_FLAG(0), + NK_PANEL_GROUP = NK_FLAG(1), + NK_PANEL_POPUP = NK_FLAG(2), + NK_PANEL_CONTEXTUAL = NK_FLAG(4), + NK_PANEL_COMBO = NK_FLAG(5), + NK_PANEL_MENU = NK_FLAG(6), + NK_PANEL_TOOLTIP = NK_FLAG(7) +}; +enum nk_panel_set { + NK_PANEL_SET_NONBLOCK = NK_PANEL_CONTEXTUAL|NK_PANEL_COMBO|NK_PANEL_MENU|NK_PANEL_TOOLTIP, + NK_PANEL_SET_POPUP = NK_PANEL_SET_NONBLOCK|NK_PANEL_POPUP, + NK_PANEL_SET_SUB = NK_PANEL_SET_POPUP|NK_PANEL_GROUP +}; + +// Issue #171 +typedef enum VSColorFamily { + /* all planar formats */ + cmGray = 1000000, + cmRGB = 2000000, + cmYUV = 3000000, + cmYCoCg = 4000000, + /* special for compatibility */ + cmCompat = 9000000 +} VSColorFamily; + +typedef enum VSPresetFormat { + pfNone = 0, + + pfGray8 = cmGray + 10, + pfGray16, + + pfYUV420P8 = cmYUV + 10, + pfYUV422P8, + + pfRGB24 = cmRGB + 10, + pfRGB27, + /* test */ + + pfCompatBGR32 = cmCompat + 10, + pfCompatYUY2 +} VSPresetFormat; + +// Anonymous +//typedef struct { char a1; }; + +//struct A2 test_proc1(struct A0 a); + +// Proc vars +void + *(*pcre_malloc)(size_t, ...), + (*pcre_free)(void *), + *(*pcre_stack_malloc)(size_t); + +typedef int ImageView, MagickBooleanType; +typedef MagickBooleanType + (*DuplexTransferImageViewMethod)(const ImageView *,const ImageView *, + ImageView *,const size_t,const int,void *), + (*GetImageViewMethod)(const ImageView *,const size_t,const int,void *), + (*SetImageViewMethod)(ImageView *,const size_t,const int,void *), + (*TransferImageViewMethod)(const ImageView *,ImageView *,const size_t, + const int,void *), +(*UpdateImageViewMethod)(ImageView *,const size_t,const int,void *); + +// Issue #156, math.h +void + *absfunptr1 (int (*)(struct A0 *)), + **absfunptr2 (int (**)(struct A1 *)), + absfunptr3 (int *(*)(struct A2 *)), + *absfunptr4 (int *(**)(struct A3 *)), + absfunptr5 (int (*a)(A4 *)); + +int sqlite3_bind_blob(struct A1*, int, const void*, int n, void(*)(void*)); + +// Issue #174 - type name[] => UncheckedArray[type] +int ucArrFunc1(int text[]); +int ucArrFunc2(int text[][5], int (*func)(int text[])); + +typedef int ucArrType1[][5]; +struct ucArrType2 { + float f1[5][5]; + int *f2[][5]; +}; + +typedef struct fieldfuncfunc { + int *(*func1)(int f1, int *(*sfunc1)(int f1, int *(*ssfunc1)(int f1, ...))); +}; + +int *func2(int f1, int *(*sfunc2)(int f1, int *(*ssfunc2)(int f1))); + +typedef struct { + const char *name; // description + const char *driver; // driver + int flags; +} BASS_DEVICEINFO; + +// Issue #183 +struct GPU_Target +{ + int w, *h; + char *x, y, **z; +}; + +// Issue #185 +struct SDL_AudioCVT; + +typedef struct SDL_AudioCVT +{ + int needed; +} SDL_AudioCVT; + +// Issue #172 +typedef struct { + const char* const* x; +} SomeType; + +// Nested #137 +typedef struct { + struct NT1 { int f1; } f1; + struct { int f1; } f2; + + struct NT3 { + /* Random comment */ + struct { + int f1; + union NU1 { + float f1; + } f2; + enum { NEV1, NEV2, NEV3 } f3; + } f1; + } f3; + + struct { int f1; } f4; + + union NU2 { int f1; } f5; + union { int f1; } f6; + enum NE1 { NEV4 = 8, NEV5 } f7; + enum { NEV6 = 8 * 8, NEV7 } f8; +} nested; + +static inline int sitest1(int f1) { + return f1 * 2; +} + +// Issue #196 +typedef int MyInt; +struct TestMyInt { + MyInt f1; +}; + +// Issue #237 +typedef union sx_ivec3 { + struct { + int x; + int y; + struct z { + int z; + }; + }; + + int n[3]; +} sx_ivec3; + +// Issue #236 +enum { + SG_INVALID_ID = 0, + SG_NUM_SHADER_STAGES = 2, + SG_MAX_MIPMAPS = 16, + SG_MAX_TEXTUREARRAY_LAYERS = 128 +}; + +struct parenpoin { + void (*__gtk_reserved1); +}; + +#endif + +#ifdef __cplusplus +} +#endif diff --git a/tests/include/test.c b/tests/include/test.c new file mode 100644 index 0000000..e9cb2aa --- /dev/null +++ b/tests/include/test.c @@ -0,0 +1,85 @@ +#include "test.h" + +int test_call_int() { + return 5; +} + +#ifdef FORCE +struct STRUCT1 _test_call_param_(int param1) { + struct STRUCT1 s; + + s.field1 = param1; + + return s; +} +#endif + +STRUCT2 test_call_param2(int param1, STRUCT2 param2) { + STRUCT2 s; + + s.field1 = param1 + param2.field1; + + return s; +} + +STRUCT2 test_call_param3(int param1, struct STRUCT1 param2) { + STRUCT2 s; + + s.field1 = param1 + param2.field1; + + return s; +} + +ENUM2 test_call_param4(enum ENUM param1) { + return enum4; +} + +union UNION1 test_call_param5(float param1) { + union UNION1 u; + + u.field2 = param1; + + return u; +} + +unsigned char test_call_param6(UNION2 param1) { + return param1.field2; +} + +int test_call_param7(union UNION1 param1) { + return param1.field1; +} + +float test_call_param8(int *param1) { + *param1 = 5 * *param1; + + return 1.0 * *param1; +} + +void *test_call9() { + return NULL; +} + +void **test_call10(int **param1) { + return NULL; +} + +char *test_array_param(int arr[5]) { + return NULL; +} + +void multiline1(void) {} + +void *multiline2(void) { + return NULL; +} + +void multiline3(void) {} + +int weirdfunc(char ***apple) { + return 1; +} + +int weirdfunc2(char **apple) { + return 2; +} diff --git a/tests/include/test.h b/tests/include/test.h new file mode 100644 index 0000000..e9c281c --- /dev/null +++ b/tests/include/test.h @@ -0,0 +1,205 @@ +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +#define TEST_INT 512 +#define TEST_FLOAT 5.12 +#define TEST_HEX 0x512 +#define TEST_CHAR 'a' +#define TEST_STR "hello world" + +#ifdef __APPLE__ +#define OSDEF 10 +#endif + +#ifdef _WIN32 +#define OSDEF 20 +#endif + +#ifdef __linux__ +#define OSDEF 30 +#endif + +#define foobar1(x) OSDEF * x +#define foobar2(x) x + 1 + +typedef uint8_t PRIMTYPE; +typedef PRIMTYPE CUSTTYPE; +typedef CUSTTYPE _CCUSTTYPE_; + +struct STRUCT0; + +struct STRUCT1 { + int field1; +}; + +typedef struct STRUCT1 STRUCT2; + +typedef struct { + int field1; +} STRUCT3; + +enum ENUM { + enum1, + enum2, + enum3 +}; + +typedef enum { + enum4 = 3, + enum5, + enum6, + enum6a = enum5 & enum6, + enum6b = enum5 | enum6 +} ENUM2; + +enum { + enum7, + enum8, + enum9 +}; + +typedef enum ENUM4 { + enum10, + enum11, + enum12 +} ENUM4; + +enum ENUM5 { + enum13 = (1 << 2), + enum14 = ((1 << 3) | 1), + enum15 = (1 << (1 & 1)) +}; + +enum ENUM7 { + enum17 = '\0', + enum18 = 'A' +}; + +typedef void * VOIDPTR; +typedef int * INTPTR; + +typedef struct { + struct STRUCT1 *field0; + int *field; + int field2[TEST_INT]; + enum ENUM field3[TEST_INT]; + int *field4[TEST_INT]; + ENUM4 *field5[TEST_INT + TEST_INT]; + int field6 : 1; +} STRUCT4; + +typedef struct struct5 { + int (*tci)(); + struct STRUCT1 (*tcp)(int); + float (*tcp8)(int *i); + void *(*tcv)(); +} STRUCT5; + +union UNION1 { + int field1; + float field2; +}; + +typedef union UNION2 { + double field1; + unsigned char field2; +} UNION2; + +int test_call_int(); +struct STRUCT1 _test_call_param_(int param1); +STRUCT2 test_call_param2(int param1, STRUCT2 param2); +STRUCT2 test_call_param3(int param1, struct STRUCT1 param2); +ENUM2 test_call_param4(enum ENUM param1); +union UNION1 test_call_param5(float param1); +unsigned char test_call_param6(UNION2 param1); +int test_call_param7(union UNION1 param1); +float test_call_param8(int *param1); +void *test_call9(); +void **test_call10(int **param1); +char *test_array_param(int arr[5]); + +// Issue #58 +void + multiline1(void), + *multiline2(void), + multiline3(void); + +// Issue #52 +typedef struct struct6 { char name; } *STRUCT6; +typedef enum enum6t { enum16 } *ENUM6; +typedef union union3 { char name; } *UNION3; + +struct struct6 test_call_stype6(); +STRUCT6 test_call_stype_ptr6(); + +enum enum6t test_call_etype6(); +ENUM6 test_call_etype_ptr6(); + +union union3 test_call_utype3(); +UNION3 test_call_etype_ptr3(); + +typedef struct _Kernel { char name; } *Kernel; + +// Double pointers +typedef void **DVOIDPTR; +typedef int **DINTPTR; + +struct dstruct { + int **field1; +}; + +typedef struct dstruct2 { + char **field1; + float **field2; + void **(*tcv)(int **param1); +} DSTRUCT2; + +// Issue #131 +enum +{ + TDEFL_LZ_CODE_BUF_SIZE = 64 * 1024, + TDEFL_OUT_BUF_SIZE = (TDEFL_LZ_CODE_BUF_SIZE * 13) / 10, + TDEFL_BOGUS_1 = (1024 * 128) / TDEFL_LZ_CODE_BUF_SIZE, + TDEFL_BOGUS_2 = TDEFL_LZ_CODE_BUF_SIZE / 64, + TDEFL_BOGUS_3 = TDEFL_OUT_BUF_SIZE / TDEFL_BOGUS_1 +}; + +// cOverride +struct foo { int foo[8][1]; }; + +typedef struct tagBITMAPINFOHEADER{ + int biClrImportant; +} BITMAPINFOHEADER, * pBITMAPINFOHEADER; + +#define BIT 123u + +#define BIT2 123u + +#define BIT3 123 + +typedef int ABC; + +typedef int DEF; + +typedef struct { + int **f1; +} GHI; + +struct JKL { + int **f1; +}; + +// Issue #178 +typedef enum +{ + SDLK_UNDERSCORE = '_' +} SDL_KeyCode; + +#ifdef __cplusplus +} +#endif diff --git a/tests/include/test2.cpp b/tests/include/test2.cpp new file mode 100644 index 0000000..7039cde --- /dev/null +++ b/tests/include/test2.cpp @@ -0,0 +1,5 @@ +#include "test2.hpp" + +int test_call_int() { + return 5; +} diff --git a/tests/include/test2.hpp b/tests/include/test2.hpp new file mode 100644 index 0000000..2f9a281 --- /dev/null +++ b/tests/include/test2.hpp @@ -0,0 +1,26 @@ +#include + +#define TEST_INT 512 +#define TEST_FLOAT 5.12 +#define TEST_HEX 0x512 + +extern "C" { + int test_call_int(); + + struct Foo{ + int bar; + }; +} + +class Foo1{ + int bar1; +}; + +template +struct Foo2{ + int bar2; +}; + +typedef Foo2 Foo2_int; + + diff --git a/tests/include/toast.h b/tests/include/toast.h new file mode 100644 index 0000000..b6b11a8 --- /dev/null +++ b/tests/include/toast.h @@ -0,0 +1,23 @@ +// #57 +enum { + _SG_STRING_SIZE = 16, + _SG_SLOT_SHIFT = 16, + _SG_SLOT_MASK = (1<<_SG_SLOT_SHIFT)-1, + _SG_MAX_POOL_SIZE = (1<<_SG_SLOT_SHIFT), + _SG_DEFAULT_BUFFER_POOL_SIZE = 128, + _SG_DEFAULT_IMAGE_POOL_SIZE = 128, + _SG_DEFAULT_SHADER_POOL_SIZE = 32, + _SG_DEFAULT_PIPELINE_POOL_SIZE = 64, + _SG_DEFAULT_PASS_POOL_SIZE = 16, + _SG_DEFAULT_CONTEXT_POOL_SIZE = 16, + _SG_MTL_DEFAULT_UB_SIZE = 4 * 1024 * 1024, + _SG_MTL_DEFAULT_SAMPLER_CACHE_CAPACITY = 64, +}; + +// #152 +enum { + _ONE, + _TWO, + _MAX = _TWO, + _MORE +}; diff --git a/tests/libssh2.nim b/tests/libssh2.nim new file mode 100644 index 0000000..940b2df --- /dev/null +++ b/tests/libssh2.nim @@ -0,0 +1,47 @@ +import nimterop/[build, cimport] + +const + outdir = getProjectCacheDir("libssh2") + +getHeader( + header = "libssh2.h", + conanuri = "libssh2/$1", + jbburi = "libssh2/1.9.0", + outdir = outdir +) + +cOverride: + type + stat = object + stat64 = object + SOCKET = object + +when not libssh2Static: + cImport(libssh2Path, recurse = true, dynlib = "libssh2LPath", flags = "-c -E_ -F_") + + when not defined(Windows) and not isDefined(libssh2JBB): + proc zlibVersion(): cstring {.importc, dynlib: libssh2LPath.} +else: + cPassL("-lpthread") + + cImport(libssh2Path, recurse = true, flags = "-c -E_ -F_") + + when not defined(Windows) and not isDefined(libssh2JBB): + proc zlibVersion(): cstring {.importc.} + +assert libssh2_init(0) == 0 + +let + session = libssh2_session_init_ex(nil, nil, nil, nil) + +if session == nil: + quit(1) + +libssh2_session_set_blocking(session, 0.cint) + +echo "zlib version = " & (block: + when not defined(Windows) and not isDefined(libssh2JBB): + $zlibVersion() + else: + "" +) diff --git a/tests/lzma.nim b/tests/lzma.nim new file mode 100644 index 0000000..9bda18e --- /dev/null +++ b/tests/lzma.nim @@ -0,0 +1,49 @@ +import os, strutils + +import nimterop/[build, cimport] + +const + FLAGS {.strdefine.} = "" + + baseDir = getProjectCacheDir("nimterop" / "tests" / "liblzma") + tflags = "--prefix=___,__,_ --suffix=__,_ " & FLAGS + +static: + cSkipSymbol(@[ + "PRIX8", "PRIX16", "PRIX32", + "PRIXLEAST8", "PRIXLEAST16", "PRIXLEAST32", + "PRIXFAST8" + ]) + +when defined(envTest): + setDefines(@["lzmaStd"]) +elif defined(envTestStatic): + setDefines(@["lzmaStd", "lzmaStatic"]) + +getHeader( + "lzma.h", + giturl = "https://github.com/xz-mirror/xz", + dlurl = "https://tukaani.org/xz/xz-$1.tar.gz", + conanuri = "xz_utils", + jbburi = "xz", + outdir = baseDir, + conFlags = "--disable-xz --disable-xzdec --disable-lzmadec --disable-lzmainfo" +) + +cOverride: + type + lzma_internal = object + lzma_index = object + lzma_index_hash = object + + lzma_options_lzma = object + lzma_stream_flags = object + lzma_block = object + lzma_index_iter = object + +when not lzmaStatic: + cImport(lzmaPath, recurse = true, dynlib = "lzmaLPath", flags = tflags) +else: + cImport(lzmaPath, recurse = true, flags = tflags) + +echo "liblzma version = " & $lzma_version_string() diff --git a/tests/nim.cfg b/tests/nim.cfg new file mode 100644 index 0000000..5bb1fab --- /dev/null +++ b/tests/nim.cfg @@ -0,0 +1 @@ +--path:".." \ No newline at end of file diff --git a/tests/rsa.nim b/tests/rsa.nim new file mode 100644 index 0000000..ee36286 --- /dev/null +++ b/tests/rsa.nim @@ -0,0 +1,47 @@ +import os +import strutils + +import nimterop/[build, cimport] + +setDefines(@["cryptoStd"]) +getHeader("openssl/crypto.h") + +const + basePath = cryptoPath.parentDir + FLAGS {.strdefine.} = "" + +static: + cSkipSymbol(@["ERR_load_crypto_strings", "OpenSSLDie"]) + +cPlugin: + import strutils + + proc onSymbol*(sym: var Symbol) {.exportc, dynlib.} = + sym.name = sym.name.strip(chars = {'_'}).replace("__", "_") + + if sym.name in [ + "AES_ENCRYPT", "AES_DECRYPT", + "BIO_CTRL_PENDING", "BIO_CTRL_WPENDING", + "BN_F_BNRAND", "BN_F_BNRAND_RANGE", + "CRYPTO_LOCK", "CRYPTO_NUM_LOCKS", "CRYPTO_THREADID", + "EVP_CIPHER", + "OPENSSL_VERSION", + "PKCS7_ENCRYPT", "PKCS7_STREAM", + "SSLEAY_VERSION", + "SSL_TXT_ADH", "SSL_TXT_AECDH", "SSL_TXT_kECDHE" + ]: + sym.name = "C_" & sym.name + +cOverride: + proc OPENSSL_die*(assertion: cstring; file: cstring; line: cint) {.importc.} + +cPassL(cryptoLPath) + +# Skip comments for https://github.com/tree-sitter/tree-sitter-c/issues/44 +cImport(@[ + basePath / "rsa.h", + basePath / "err.h", +], recurse = true, flags = "-s -c " & FLAGS) + +OpensslInit() +echo $OPENSSL_VERSION_TEXT diff --git a/tests/tast2.nim b/tests/tast2.nim new file mode 100644 index 0000000..e301fb5 --- /dev/null +++ b/tests/tast2.nim @@ -0,0 +1,524 @@ +import macros, os, sets, strutils + +import nimterop/[cimport] + +cPassC("-DNIMTEROP") + +static: + # Skip casting on lower nim compilers because + # the VM does not support it + when (NimMajor, NimMinor, NimPatch) < (1, 0, 0): + cSkipSymbol @["CASTEXPR"] + +const + path = currentSourcePath.parentDir() / "include" / "tast2.h" + +when defined(NOHEADER): + cDefine("NOHEADER") + const + flags = " -H" + pHeader: seq[string] = @[] + pHeaderImp: seq[string] = @[] +else: + const + flags = "" + pHeader = @["header:" & path.replace("\\", "/")] + pHeaderImp = @["importc"] & pHeader + +const + pHeaderImpBy = @["bycopy"] & pHeaderImp + pHeaderBy = @["bycopy"] & pHeader + pHeaderInc = @["incompleteStruct"] & pHeader + +cOverride: + const + A* = 2 + + type + A1* = A0 + +cDefine("SOME_CONST=100") + +when not defined(WRAPPED): + cImport(path, flags="-f:ast2 -ENK_,SDL_ -GVICE=SLICE -TMyInt=cint" & flags, nimFile = "tast2wrapped.nim") +else: + import tast2wrapped + +proc getPragmas(n: NimNode): HashSet[string] = + # Find all pragmas in AST, return as "name" or "name:value" in set + for i in 0 ..< n.len: + if n[i].kind == nnkPragma: + for j in 0 ..< n[i].len: + if n[i][j].kind == nnkIdent: + result.incl $n[i][j] + elif n[i][j].kind == nnkExprColonExpr: + result.incl $n[i][j][0] & ":" & $n[i][j][1] + else: + result.incl n[i].getPragmas() + +proc getRecList(n: NimNode): NimNode = + # Find nnkRecList in AST + for i in 0 ..< n.len: + if n[i].kind == nnkRecList: + return n[i] + elif n[i].len != 0: + let + rl = getRecList(n[i]) + if not rl.isNil: + return rl + +macro checkPragmas(t: typed, pragmas: static[seq[string]], istype: static[bool] = true, + origname: static[string] = ""): untyped = + # Verify that type has expected pragmas defined + # `istype` is true when typedef X + var + ast = t.getImpl() + prag = ast.getPragmas() + exprag = pragmas.toHashSet() + when not defined(NOHEADER): + if not istype: + if "union" in exprag: + exprag.incl "importc:union " & $t + else: + exprag.incl "importc:struct " & $t + elif origname.len != 0: + exprag.incl "importc:" & $origname + + doAssert symmetricDifference(prag, exprag).len == 0, + "\nWrong number of pragmas in " & $t & "\n" & $prag & " vs " & $exprag + +macro testFields(t: typed, fields: static[string] = "") = + # Verify that type has expected fields + var + ast = t.getImpl() + rl = ast.getRecList() + fsplit = fields.split("!") + names = fsplit[0].split("|") + types = + if fsplit.len > 1: + fsplit[1].split("|") + else: + @[] + if not rl.isNil: + for i in 0 ..< rl.len: + let + name = ($rl[i][0]).strip(chars = {'*'}) + typ = ($(rl[i][1].repr())).replace("\n", "").replace(" ", "").replace("typeof", "type") + n = names.find(name) + assert n != -1, $t & "." & name & " invalid" + assert types[n].replace("typeof", "type") == typ, + "typeof(" & $t & ":" & name & ") != " & types[n].replace("typeof", "type") & ", is " & typ + +assert A == 2 +assert B == 1.0 +assert C == 0x10 +assert D == "hello" +assert E == 'c' +assert F == 0o1234 + +assert not defined(NOTSUPPORTEDSTR) + +assert UEXPR == (1234.uint shl 1) +assert ULEXPR == (1234.uint32 shl 2) +assert ULLEXPR == (1234.uint64 shl 3) +assert LEXPR == (1234.int32 shl 4) +assert LLEXPR == (1234.int64 shl 5) + +assert AVAL == 100 +assert BVAL == 200 + +assert EQ1 == (AVAL <= BVAL) +assert EQ2 == (AVAL >= BVAL) +assert EQ3 == (AVAL > BVAL) +assert EQ4 == (AVAL < BVAL) +assert EQ5 == (AVAL != BVAL) +assert EQ6 == (AVAL == BVAL) + +assert SX_NEAR_ZERO == 3.725290298461914e-09 + +assert SIZEOF == 1 + +assert COERCE == 645635670332'u64 +assert COERCE2 == 645635670332'i64 + +assert INT_FAST16_MIN == -9223372036854775807'i64 - 1 + +assert BINEXPR == 5 +assert BOOL == true +assert MATHEXPR == -99 +assert ANDEXPR == 96 + +when (NimMajor, NimMinor, NimPatch) >= (1, 0, 0): + assert CASTEXPR == 34.chr + +assert TRICKYSTR == "N\x1C\nfoo\x00\'\"\c\v\a\b\e\f\t\\\\?bar" +assert NULLCHAR == '\0' +assert OCTCHAR == '\n' +assert HEXCHAR.int == 0xFE + +assert SHL1 == (1.uint shl 1) +assert SHL2 == (1.uint shl 2) +assert SHL3 == (1.uint shl 3) + +assert typeof(POINTEREXPR) is (ptr cint) +assert typeof(POINTERPOINTERPOINTEREXPR) is (ptr ptr ptr cint) + +assert ALLSHL == (SHL1 or SHL2 or SHL3) + +assert typeof(parent_struct_s().s) is array[100, some_struct_s] +assert typeof(SOME_ARRAY) is array[100, some_struct_s] + +assert A0 is object +testFields(A0, "f1!cint") +checkPragmas(A0, pHeaderBy, istype = false) +var a0: A0 +a0.f1 = 1 + +assert A1 is A0 +testFields(A1, "f1!cint") +var a1: A1 +a1.f1 = 2 + +assert A2 is object +testFields(A2) +checkPragmas(A2, pHeaderInc, istype = false) +when defined(NOHEADER): + # typedef struct X; is invalid + var a2: A2 + +assert A3 is object +testFields(A3) +checkPragmas(A3, pHeaderInc, istype = false) +var a3: A3 + +assert A4 is object +testFields(A4, "f1!cfloat") +checkPragmas(A4, pHeaderImpBy) +var a4: A4 +a4.f1 = 4.1 + +assert A4p is ptr A4 +testFields(A4p, "f1!cfloat") +checkPragmas(A4p, pHeaderImp) +var a4p: A4p +a4p = addr a4 + +assert A5 is cint +checkPragmas(A5, pHeaderImp) +const a5: A5 = 5 + +assert A6 is ptr cint +checkPragmas(A6, pHeaderImp) +var + a6: A6 + a6i = 6 +a6 = cast[A6](addr a6i) + +assert A7 is ptr ptr A0 +checkPragmas(A7, pHeaderImp) +var + a7: A7 + a7a = addr a0 +a7 = addr a7a + +assert A8 is pointer +checkPragmas(A8, pHeaderImp) +var a8: A8 +a8 = nil + +assert A9p is array[3, cstring] +checkPragmas(A9p, pHeaderImp) +var a9p: A9p +a9p[1] = nil +a9p[2] = "hello".cstring + +assert A9 is array[4, cchar] +checkPragmas(A9, pHeaderImp) +var a9: A9 +a9[2] = 'c' + +assert A10 is array[3, array[6, cstring]] +checkPragmas(A10, pHeaderImp) +var a10: A10 +a10[2][5] = "12345".cstring + +assert A11 is ptr array[3, cstring] +checkPragmas(A11, pHeaderImp) +var a11: A11 +a11 = addr a9p + +assert A111 is array[12, ptr A1] +checkPragmas(A111, pHeaderImp) +var a111: A111 +a111[11] = addr a0 + +assert A12 is proc(a1: cint, b: cint, c: ptr cint, a4: ptr cint, count: array[4, ptr cint], `func`: proc(a1: cint, a2: cint): cint {.cdecl.}): ptr ptr cint {.cdecl.} +checkPragmas(A12, pHeaderImp & "cdecl") +var a12: A12 + +assert A121 is proc(a1: cfloat, b: cfloat, c: ptr cfloat, a4: ptr cfloat, count: array[4, ptr cfloat], `func`: proc(a1: cfloat, a2: cfloat): cfloat {.cdecl.}): ptr ptr cint {.cdecl.} +checkPragmas(A121, pHeaderImp & "cdecl") +var a121: A121 + +assert A122 is proc(a1: cchar, b: cchar, c: cstring, a4: cstring, count: array[4, cstring], `func`: proc(a1: cchar, a2: cchar): cchar {.cdecl.}): ptr ptr cint {.cdecl.} +checkPragmas(A122, pHeaderImp & "cdecl") +var a122: A122 + +assert A13 is proc(a1: cint, a2: cint, `func`: proc() {.cdecl.}): cint {.cdecl.} +checkPragmas(A13, pHeaderImp & "cdecl") +var a13: A13 + +assert A14 is object +testFields(A14, "a1!cchar") +checkPragmas(A14, pHeaderBy, istype = false) +var a14: A14 +a14.a1 = 'a' + +assert A15 is object +testFields(A15, "a1|a2!cstring|array[1, ptr cint]") +checkPragmas(A15, pHeaderBy, istype = false) +var + a15: A15 + a15i = 15.cint +a15.a1 = "hello".cstring +a15.a2[0] = addr a15i + +assert A16 is object +testFields(A16, "f1!cchar") +checkPragmas(A16, pHeaderBy, istype = false) +var a16: A16 +a16.f1 = 's' + +assert A17 is object +testFields(A17, "a1|a2!cstring|array[1, ptr cint]") +checkPragmas(A17, pHeaderBy, istype = false) +var a17: A17 +a17.a1 = "hello".cstring +a17.a2[0] = addr a15i + +assert A18 is A17 +checkPragmas(A18, pHeaderImp) +var a18: A18 + +assert A18p is ptr A17 +checkPragmas(A18p, pHeaderImp) +var a18p: A18p +a18p = addr a18 + +assert A19 is object +testFields(A19, "a1|a2!cstring|array[1, ptr cint]") +checkPragmas(A19, pHeaderImpBy) +var a19: A19 +a19.a1 = "hello".cstring +a19.a2[0] = addr a15i + +assert A19p is ptr A19 +checkPragmas(A19p, pHeaderImp) +var a19p: A19p +a19p = addr a19 + +assert A20 is object +testFields(A20, "a1!cchar") +checkPragmas(A20, pHeaderBy, istype = false) +var a20: A20 +a20.a1 = 'a' + +assert A21 is A20 +checkPragmas(A21, pHeaderImp) +var a21: A21 +a21 = a20 + +assert A21p is ptr A20 +checkPragmas(A21p, pHeaderImp) +var a21p: A21p +a21p = addr a20 + +assert A22 is object +testFields(A22, "f1|f2!ptr ptr cint|array[123 + type(123)(132), ptr cint]") +checkPragmas(A22, pHeaderBy, istype = false) +var a22: A22 +a22.f1 = addr a15.a2[0] + +assert A23 is proc(): cstring {.cdecl.} +checkPragmas(A23, pHeaderImp & "cdecl") +var a23: A23 + +assert U1 is object +assert sizeof(U1) == sizeof(cfloat) +checkPragmas(U1, pHeaderBy & @["union"], istype = false) +var u1: U1 +u1.f1 = 5 + +assert U2 is object +assert sizeof(U2) == 256 * sizeof(cint) +checkPragmas(U2, pHeaderBy & @["union"], istype = false) +var u2: U2 +u2.f1 = addr a15.a2[0] + +assert PANEL_WINDOW is nk_panel_type +assert PANEL_WINDOW == 1 +assert PANEL_GROUP == 2 +assert PANEL_POPUP == 4 +assert PANEL_CONTEXTUAL == 16 +assert PANEL_COMBO == 32 +assert PANEL_MENU == 64 +assert PANEL_TOOLTIP == 128 +assert PANEL_SET_NONBLOCK == 240 +assert PANEL_SET_POPUP == 244 +assert PANEL_SET_SUB == 246 + +assert cmGray == 1000000 +assert pfGray16 == 1000011 +assert pfYUV422P8 == pfYUV420P8 + 1 +assert pfRGB27 == cmRGB.VSPresetFormat + 11 +assert pfCompatYUY2 == pfCompatBGR32 + 1 + +assert pcre_malloc is proc(a1: uint): pointer {.cdecl, varargs.} +checkPragmas(pcre_malloc, @["importc", "cdecl", "varargs"] & pHeader) + +assert pcre_free is proc(a1: pointer) {.cdecl.} +checkPragmas(pcre_free, @["importc", "cdecl"] & pHeader) + +assert pcre_stack_malloc is proc(a1: uint): pointer {.cdecl.} +checkPragmas(pcre_stack_malloc, @["importc", "cdecl"] & pHeader) + +assert DuplexTransferImageViewMethod is + proc (a1: ptr ImageView; a2: ptr ImageView; a3: ptr ImageView; a4: uint; + a5: cint; a6: pointer): MagickBooleanType {.cdecl.} + +assert GetImageViewMethod is + proc (a1: ptr ImageView; a2: uint; a3: cint; a4: pointer): MagickBooleanType {.cdecl.} + +assert SetImageViewMethod is + proc (a1: ptr ImageView; a2: uint; a3: cint; a4: pointer): MagickBooleanType {.cdecl.} + +assert TransferImageViewMethod is + proc (a1: ptr ImageView; a2: ptr ImageView; a3: uint; a4: cint; a5: pointer): MagickBooleanType {.cdecl.} + +assert UpdateImageViewMethod is + proc (a1: ptr ImageView; a2: uint; a3: cint; a4: pointer): MagickBooleanType {.cdecl.} + +# Issue #156, math.h +assert absfunptr1 is proc(a1: proc(a1: ptr A0): cint {.cdecl.}): pointer {.cdecl.} +assert absfunptr2 is proc(a1: ptr proc(a1: ptr A1): cint {.cdecl.}): ptr pointer {.cdecl.} +assert absfunptr3 is proc(a1: proc(a1: ptr A2): ptr cint {.cdecl.}) {.cdecl.} +assert absfunptr4 is proc(a1: ptr proc(a1: ptr A3): ptr cint {.cdecl.}): pointer {.cdecl.} +assert absfunptr5 is proc(a1: proc(a1: ptr A4): cint {.cdecl.}) {.cdecl.} + +assert sqlite3_bind_blob is + proc(a1: ptr A1, a2: cint, a3: pointer, n: cint, a5: proc(a1: pointer) {.cdecl.}): cint {.cdecl.} + +# Issue #174 - type name[] => UncheckedArray[type] +assert ucArrFunc1 is proc(text: UncheckedArray[cint]): cint {.cdecl.} +assert ucArrFunc2 is + proc(text: UncheckedArray[array[5, cint]], `func`: proc(text: UncheckedArray[cint]): cint {.cdecl.}): cint {.cdecl.} + +assert ucArrType1 is UncheckedArray[array[5, cint]] +checkPragmas(ucArrType1, pHeaderImp) + +assert ucArrType2 is object +testFields(ucArrType2, "f1|f2!array[5, array[5, cfloat]]|UncheckedArray[array[5, ptr cint]]") +checkPragmas(ucArrType2, pHeaderBy, istype = false) + +assert fieldfuncfunc is object +testFields(fieldfuncfunc, + "func1!proc (f1: cint; sfunc1: proc (f1: cint; ssfunc1: proc (f1: cint): ptr cint {.cdecl, varargs.}): ptr cint {.cdecl.}): ptr cint {.cdecl.}") + +assert func2 is proc (f1: cint; sfunc2: proc (f1: cint; ssfunc2: proc (f1: cint): ptr cint {.cdecl.}): ptr cint {.cdecl.}): ptr cint {.cdecl.} + +# Test --replace VICE=SLICE +assert BASS_DESLICEINFO is object +testFields(BASS_DESLICEINFO, "name|driver|flags!cstring|cstring|cint") +checkPragmas(BASS_DESLICEINFO, pHeaderBy, origname = "BASS_DEVICEINFO") + +# Issue #183 +assert GPU_Target is object +testFields(GPU_Target, "w|h|x|y|z!cint|ptr cint|cstring|cchar|ptr cstring") +checkPragmas(GPU_Target, pHeaderBy, istype = false) + +# Issue #185 +assert AudioCVT is object +testFields(AudioCVT, "needed!cint") +checkPragmas(AudioCVT, pHeaderBy, origname = "struct SDL_AudioCVT") + +# Issue #172 +assert SomeType is object +testFields(SomeType, "x!ptr cstring") +checkPragmas(SomeType, pHeaderImpBy) + +# Nested #137 +assert NT1 is object +testFields(NT1, "f1!cint") +checkPragmas(NT1, pHeaderBy, istype = false) + +assert Type_tast2h1 is object +testFields(Type_tast2h1, "f1!cint") +checkPragmas(Type_tast2h1, pHeaderBy, istype = false) + +assert NU1 is object +testFields(NU1, "f1!cfloat") +checkPragmas(NU1, pHeaderBy & @["union"], istype = false) + +assert NEV1 == 0 +assert NEV2 == 1 +assert NEV3 == 2 + +assert Type_tast2h2 is object +testFields(Type_tast2h2, "f1|f2|f3!cint|NU1|Enum_tast2h1") +checkPragmas(Type_tast2h2, pHeaderBy, istype = false) + +assert NT3 is object +testFields(NT3, "f1!Type_tast2h2") +checkPragmas(NT3, pHeaderBy, istype = false) + +assert Type_tast2h3 is object +testFields(Type_tast2h3, "f1!cint") +checkPragmas(Type_tast2h3, pHeaderBy, istype = false) + +assert NU2 is object +testFields(NU2, "f1!cint") +checkPragmas(NU2, pHeaderBy & @["union"], istype = false) + +assert Union_tast2h1 is object +testFields(Union_tast2h1, "f1!cint") +checkPragmas(Union_tast2h1, pHeaderBy & @["union"], istype = false) + +assert NEV4 == 8 +assert NEV5 == 9 + +assert NEV6 == 64 +assert NEV7 == 65 + +assert nested is object +testFields(nested, "f1|f2|f3|f4|f5|f6|f7|f8!NT1|Type_tast2h1|NT3|Type_tast2h3|NU2|Union_tast2h1|NE1|Enum_tast2h2") +checkPragmas(nested, pHeaderImpBy) + +when not defined(NOHEADER): + assert sitest1(5) == 10 + assert sitest1(10) == 20 + +when declared(MyInt): + assert false, "MyInt is defined!" +testFields(TestMyInt, "f1!cint") +checkPragmas(TestMyInt, pHeaderBy, isType = false) + +# #237 +assert sx_ivec3 is object +testFields(sx_ivec3, "x|y|z|n!cint|cint|cint|array[3, cint]") +checkPragmas(sx_ivec3, pHeaderBy & @["union"], istype = false) +var sx: sx_ivec3 +sx.x = 5 +assert sx.n[0] == 5 +when not defined(NOHEADER): + # Nim doesn't know of the anonymous nested struct so when the header + # isn't present, the test below breaks + sx.n[1] = 4 + assert sx.y == 4 + +# #236 +assert SG_MAX_MIPMAPS is cint +assert SG_MAX_MIPMAPS == 16 + +assert parenpoin is object +var pp: parenpoin +assert pp.gtk_reserved1 is pointer \ No newline at end of file diff --git a/tests/timeit.nim b/tests/timeit.nim new file mode 100644 index 0000000..cf9417f --- /dev/null +++ b/tests/timeit.nim @@ -0,0 +1,29 @@ +import os, osproc, sequtils, strformat, strutils, times + +when (NimMajor, NimMinor) >= (1, 0): + import std/monotimes + + template getTime(): MonoTime = getMonoTime() +else: + template getTime(): float = epochTime() + +when isMainModule: + var params = commandLineParams() + params.apply(quoteShell) + + let cmd = params.join(" ") + echo &"================\nRunning: {cmd}\n" + + let + + start = getTime() + ret = execCmd(cmd) + endt = getTime() + + outf = getAppDir() / "timeit.txt" + outd = if fileExists(outf): readFile(outf) else: "" + outp = &"\nRan: {cmd}\nTime taken: {$(endt - start)}\n" + + echo outp + writeFile(outf, outd & outp) + quit(ret mod 255) diff --git a/tests/tmath.nim b/tests/tmath.nim new file mode 100644 index 0000000..8f947b2 --- /dev/null +++ b/tests/tmath.nim @@ -0,0 +1,36 @@ +import unittest +import nimterop/cimport + +cOverride: + type + locale_t = object + mingw_ldbl_type_t = object + mingw_dbl_type_t = object + +when defined(Windows): + cOverride: + type + complex = object + +static: + when (NimMajor, NimMinor, NimPatch) < (1, 0, 0): + # FP_ILOGB0 and FP_ILOGBNAN are casts that are unsupported + # on lower Nim VMs + cSkipSymbol @["math_errhandling", "FP_ILOGB0", "FP_ILOGBNAN"] + else: + cSkipSymbol @["math_errhandling"] + cDisableCaching() + cAddStdDir() + +cPlugin: + import strutils + + proc onSymbol*(sym: var Symbol) {.exportc, dynlib.} = + sym.name = sym.name.strip(chars={'_'}).replace("__", "_") + +const FLAGS {.strdefine.} = "" +cImport(cSearchPath("math.h"), flags = FLAGS) + +check sin(5) == -0.9589242746631385 +check abs(-5) == 5 +check sqrt(4.00) == 2.0 diff --git a/tests/tnimterop_c.nim b/tests/tnimterop_c.nim new file mode 100644 index 0000000..ac7193c --- /dev/null +++ b/tests/tnimterop_c.nim @@ -0,0 +1,224 @@ +import std/unittest +import os +import macros +import nimterop/cimport +import nimterop/paths + +static: + cDisableCaching() + cAddSearchDir testsIncludeDir() + +cDefine("FORCE") +cIncludeDir testsIncludeDir() +cCompile cSearchPath("test.c") + +cPluginPath(getProjectPath() / "tnimterop_c_plugin.nim") + +cOverride: + type + BITMAPINFOHEADER* {.bycopy.} = object + biClrImportant*: int + + Random = object + + ABC = pointer + + GHI = object + f2: ptr ptr cint + + JKL = object + f2: ptr ptr cint + + const + BIT* = 1 + + proc weirdfunc(apple: ptr ptr ptr cchar): int {.importc.} + proc weirdfunc2(mango: ptr ptr cchar): int {.importc.} + +const FLAGS {.strdefine.} = "" +cImport(cSearchPath("test.h"), flags = FLAGS) + +check TEST_INT == 512 +check TEST_FLOAT == 5.12 +check TEST_HEX == 0x512 +check TEST_CHAR == 'a' +check TEST_STR == "hello world" + +when defined(osx): + check OSDEF == 10 +elif defined(Windows): + check OSDEF == 20 +else: + check OSDEF == 30 + +block: + # workaround for https://github.com/nim-lang/Nim/issues/10129 + const ok = OSDEF + +var + pt: PRIMTYPE + ct: CUSTTYPE + cct: CCUSTTYPE + + s0: ptr STRUCT0 + s1: STRUCT1 + s2: STRUCT2 + s3: STRUCT3 + s4: STRUCT4 + s5: STRUCT5 + s51: struct5 + + e: ENUM + e2: ENUM2 = enum5 + e3 = enum7 + e4: ENUM4 = enum11 + + vptr: VOIDPTR + iptr: INTPTR + + u: UNION1 + u2: UNION2 + + i: cint + +pt = 3 +ct = 4 +cct = 5 + +s1.field1 = 5 +s2.field1 = 6 +s3.field1 = 7 +s4.field2[2] = 5 + +# note: simplify with `defined(c)` for nim >= 0.19.9 +when defined(cpp) and defined(OSX): + discard +else: + s4.field3[3] = enum1 + +s4.field6 = 1 +s4.field6 += 1 +check s4.field6 == 0 + +s5.tci = test_call_int +s5.tcp = test_call_param +s5.tcp8 = test_call_param8 +s51.tci = test_call_int +s51.tcv = test_call9 +check s5.tci() == 5 +check s51.tci() == 5 +check s51.tcv() == nil + +e = enum1 +e2 = enum4 + +u2.field2 = 'c' + +i = 5 + +check test_call_int() == 5 +check test_call_param(5).field1 == 5 +check test_call_param2(5, s2).field1 == 11 +check test_call_param3(5, s1).field1 == 10 +when defined(cpp) and defined(OSX): + # error: assigning to 'enum ENUM' from incompatible type 'NI' (aka 'long long') + discard +else: + check test_call_param4(e) == e2 +check test_call_param5(5.0).field2 == 5.0 +check test_call_param6(u2) == 'c' +u.field1 = 4 +check test_call_param7(u) == 4 + +when defined(cpp) and defined(OSX): + # note: candidate function not viable: no known conversion from 'NI *' (aka 'long long *') to 'int *' for 1st argument + # check test_call_param8(cast[ptr int](addr i)) == 25.0 + discard +else: + check test_call_param8(addr i) == 25.0 + check i == 25 + +check test_call9() == nil + +check enum6a == 4 +check enum6b == 5 + +check e3 == enum7 +check e4 == enum11 + +check enum13 == 4 +check enum14 == 9 +check enum15 == 2 +check enum17 == '\0'.ENUM7 +check enum18 == 'A'.ENUM7 + +# Issue #58 +multiline1() +let p = multiline2() +multiline3() + +# Issue #52 +var + s6: struct6 + s6p: STRUCT6 + e6: enum6t + e6p: ENUM6 + u3: union3 + u3p: UNION3 + k: uKernel + kp: Kernel + +## failing tests +when false: + static: # Error: undeclared identifier: 'foobar1' + doAssert foobar1(3) == OSDEF * 3 +when false: # Error: undeclared identifier: 'foobar2' + doAssert foobar2(3) == 3 + 1 + +# Double pointer +var + dv: DVOIDPTR + di: DINTPTR + ds: dstruct + cstr = "Hello".cstring + ds2: DSTRUCT2 + +dv = addr vptr +di = addr iptr + +ds.field1 = di +ds2.field1 = addr cstr +ds2.tcv = test_call10 +check ds2.tcv(di) == nil + +# Issue #131 +check TDEFL_OUT_BUF_SIZE == 85196 +check TDEFL_BOGUS_1 == 2 +check TDEFL_BOGUS_2 == 1024 +check TDEFL_BOGUS_3 == (85196 / 2).int + +var + arr: array[5, cint] + +check test_array_param(arr) == nil + +# cOverride + +var + ca = weirdfunc + cb: BITMAPINFOHEADER + cc = weirdfunc2 + cd: ABC + ce: DEF + cf: GHI + cg: JKL + +cd = nil +ce = 5 +cf.f2 = nil +cg.f2 = nil + +doAssert BIT == 1 +doAssert ca(nil) == 1 +doAssert cc(nil) == 2 +doAssert SDLK_UNDERSCORE == 95 \ No newline at end of file diff --git a/tests/tnimterop_c_plugin.nim b/tests/tnimterop_c_plugin.nim new file mode 100644 index 0000000..90ac2ab --- /dev/null +++ b/tests/tnimterop_c_plugin.nim @@ -0,0 +1,9 @@ +import nimterop/plugin + +import strutils + +proc onSymbol*(sym: var Symbol) {.exportc, dynlib.} = + if sym.name == "_Kernel": + sym.name = "uKernel" + else: + sym.name = sym.name.strip(chars={'_'}) \ No newline at end of file diff --git a/tests/tnimterop_cpp.nim b/tests/tnimterop_cpp.nim new file mode 100644 index 0000000..3f44e86 --- /dev/null +++ b/tests/tnimterop_cpp.nim @@ -0,0 +1,19 @@ +import unittest +import nimterop/cimport +import nimterop/paths + +static: + cDisableCaching() + cAddSearchDir testsIncludeDir() + +cIncludeDir testsIncludeDir() +cCompile cSearchPath "test2.cpp" +cImport cSearchPath "test2.hpp" + +check TEST_INT == 512 +check TEST_FLOAT == 5.12 +check TEST_HEX == 0x512 +check test_call_int() == 5 + +var foo: Foo +check foo.bar == 0 diff --git a/tests/toast.cfg b/tests/toast.cfg new file mode 100644 index 0000000..8c37f3c --- /dev/null +++ b/tests/toast.cfg @@ -0,0 +1,2 @@ +--preprocess +-nk -E=_ \ No newline at end of file diff --git a/tests/tpcre.nim b/tests/tpcre.nim new file mode 100644 index 0000000..4a3badb --- /dev/null +++ b/tests/tpcre.nim @@ -0,0 +1,43 @@ +import os + +import nimterop/[cimport, build] + +const + baseDir = getProjectCacheDir("nimterop" / "tests" / "pcre") + pcreH = baseDir/"pcre.h.in" + +static: + if not pcreH.fileExists(): + downloadUrl("https://github.com/svn2github/pcre/raw/master/pcre.h.in", baseDir) + cDisableCaching() + +const + dynpcre = + when defined(Windows): + when defined(cpu64): + "pcre64.dll" + else: + "pcre32.dll" + elif hostOS == "macosx": + "libpcre(.3|.1|).dylib" + else: + "libpcre.so(.3|.1|)" + +cPlugin: + import strutils + + proc onSymbol*(sym: var Symbol) {.exportc, dynlib.} = + sym.name = sym.name.replace("pcre_", "") + if sym.name.startsWith("pcre16_") or sym.name.startsWith("pcre32_"): + sym.name = "" + +const FLAGS {.strdefine.} = "" +cImport(pcreH, dynlib="dynpcre", flags="--mode=c " & FLAGS) +echo version() + +when FLAGS.len != 0: + # Legacy algorithm is broken - does not convert void * return to pointer + proc my_malloc(a1: uint): pointer {.cdecl.} = + discard + + malloc = my_malloc diff --git a/tests/tsoloud.nim b/tests/tsoloud.nim new file mode 100644 index 0000000..d594516 --- /dev/null +++ b/tests/tsoloud.nim @@ -0,0 +1,60 @@ +import os, nimterop/[cimport, build] + +const + FLAGS {.strdefine.} = "" + + baseDir = getProjectCacheDir("nimterop" / "tests" / "soloud") + incl = baseDir/"include" + src = baseDir/"src" + +static: + gitPull("https://github.com/jarikomppa/soloud", baseDir, "include/*\nsrc/*\n", checkout = "RELEASE_20200207") + cDisableCaching() + +cOverride: + type + Soloud* = pointer + AlignedFloatBuffer* = pointer + + proc Soloud_destroy*(aSoloud: ptr Soloud) {.importc: "Soloud_destroy", header: cSearchPath(incl/"soloud_c.h").} + +static: cSkipSymbol @["WavStream_stop", "WavStream_setFilter"] + +cIncludeDir(incl) + +when defined(osx): + cDefine("WITH_COREAUDIO") + cPassL("-framework CoreAudio -framework AudioToolbox") + cCompile(src/"backend/coreaudio/*.cpp") +elif defined(Linux): + cPassL("-lpthread") + cDefine("WITH_OSS") + cCompile(src/"backend/oss/*.cpp") +elif defined(Windows): + cPassC("-msse") + cPassL("-lwinmm") + cDefine("WITH_WINMM") + cCompile(src/"backend/winmm/*.cpp") +else: + static: doAssert false + +cCompile(src/"c_api/soloud_c.cpp") +cCompile(src/"core/*.cpp") +cCompile(src/"audiosource", "cpp", exclude="ay/") +cCompile(src/"audiosource", "c") +cCompile(src/"filter/*.cpp") + +cImport(incl/"soloud_c.h", flags = FLAGS) + +var + s = Soloud_create() + +echo s.Soloud_init() + +s.Soloud_destroy() + +when declared(WavStream_stop): + assert "WavStream_stop() not skipped" + +when declared(WavStream_setFilter): + assert "WavStream_setFilter not skipped" diff --git a/tests/tsoloud.nims b/tests/tsoloud.nims new file mode 100644 index 0000000..3b6174b --- /dev/null +++ b/tests/tsoloud.nims @@ -0,0 +1,5 @@ +# Workaround for C++ scanner.cc causing link error with other C obj files +when defined(MacOSX): + switch("clang.linkerexe", "g++") +else: + switch("gcc.linkerexe", "g++") \ No newline at end of file diff --git a/tests/wrappers.nims b/tests/wrappers.nims new file mode 100644 index 0000000..4687d7a --- /dev/null +++ b/tests/wrappers.nims @@ -0,0 +1,15 @@ +import os + +let + wrappers = @["genotrance/nimarchive", "genotrance/nimgit2"] + +rmDir("wrappers") +mkDir("wrappers") +withDir("wrappers"): + for wrapper in wrappers: + let + name = wrapper.extractFilename() + exec "../../tests/timeit git clone https://github.com/" & wrapper + withDir(name): + exec "../../../tests/timeit nimble install -d" + exec "../../../tests/timeit nimble test" \ No newline at end of file diff --git a/tests/zlib.nim b/tests/zlib.nim new file mode 100644 index 0000000..d4744eb --- /dev/null +++ b/tests/zlib.nim @@ -0,0 +1,76 @@ +import os, strutils + +import nimterop/[build, cimport] + +const + FLAGS {.strdefine.} = "" + + baseDir = getProjectCacheDir("nimterop" / "tests" / "zlib") + +proc zlibPreBuild(outdir, path: string) = + let + mf = outdir / "Makefile" + if mf.fileExists(): + # Delete default Makefile + if mf.readFile().contains("configure first"): + mf.rmFile() + when defined(Windows): + # Fix static lib name on Windows + setCmakeLibName(outdir, "zlibstatic", prefix = "lib", oname = "zlib", suffix = ".a") + +when defined(envTest): + setDefines(@["zlibGit"]) +elif defined(envTestStatic): + setDefines(@["zlibGit", "zlibStatic"]) + +getHeader( + "zlib.h", + giturl = "https://github.com/madler/zlib", + dlurl = "http://zlib.net/zlib-$1.tar.gz", + outdir = baseDir, + altNames = "z,zlib" +) + +cPlugin: + import regex, strutils + + proc onSymbol*(sym: var Symbol) {.exportc, dynlib.} = + sym.name = sym.name.replace(re"_[_]+", "_").strip(chars = {'_'}) + +cOverride: + type + voidpf = ptr object + voidpc = ptr object + voidp = ptr object + uLongf = culong + z_size_t = culong + z_crc_t = culong + alloc_func* {.importc.} = proc(opaque: voidpf, items, size: uint) {.cdecl.} + Bytef {.importc.} = object + +when defined(posix): + cOverride: + type + pthread_mutex_s = object + pthread_cond_s = object + pthread_rwlock_arch_t = object + extension = object + fd_set = object + +when defined(posix): + static: + cSkipSymbol(@["u_int8_t", "u_int16_t", "u_int32_t", "u_int64_t"]) + +when zlibGit or zlibDL: + when dirExists(baseDir / "buildcache"): + cIncludeDir(baseDir / "buildcache") + +when not isDefined(zlibStatic): + cImport(zlibPath, recurse = true, dynlib = "zlibLPath", flags = FLAGS) +else: + when isDefined(zlibJBB): + cPassL("-no-pie") + + cImport(zlibPath, recurse = true, flags = FLAGS) + +echo "zlib version = " & $zlibVersion() \ No newline at end of file diff --git a/theindex.html b/theindex.html deleted file mode 100644 index 49925a5..0000000 --- a/theindex.html +++ /dev/null @@ -1,374 +0,0 @@ - - - - - - - - - - - - - - - - - - -Index - - - - - - - - -
-
-

Index

- Modules: build, cimport, compat, docs, paths, plugin, types.

API symbols

-
ast2:
-
buildDocs:
-
c2nImport:
-
cacheDir:
-
cAddSearchDir:
-
cAddStdDir:
-
cCompile:
-
cDebug:
-
cDefine:
-
cDisableCaching:
-
cImport:
-
cIncludeDir:
-
clearDefines:
-
cmake:
-
configure:
-
cOverride:
-
cOverrides:
-
cpFile:
-
cPlugin:
-
cSearchPath:
-
cSkipSymbol:
-
defineEnum:
-
downloadUrl:
-
enumOp:
-
execAction:
-
extractTar:
-
extractZip:
-
Feature:
-
findExe:
-
findFile:
-
flagBuild:
-
getCmakeIncludePath:
-
getCompiler:
-
getCurrentNimCompiler:
-
getGccLibPaths:
-
getGccPaths:
-
getHeader:
-
getProjectCacheDir:
-
gitCheckout:
-
gitPull:
-
gitReset:
-
isDefined:
-
linkLibs:
-
make:
-
mkDir:
-
mvFile:
-
myNormalizedPath:
-
nimteropRoot:
-
nimteropSrcDir:
-
OnSymbol:
-
OnSymbolOverrideFinal:
-
onSymbolOverrideFinal:
-
ptrdiff_t:
-
rmDir:
-
rmFile:
-
sanitizePath:
-
setCmakeLibName:
-
setCmakePositionIndependentCode:
-
setCmakeProperty:
-
setDefines:
-
sleep:
-
Symbol:
-
testsIncludeDir:
-
time64_t:
-
time_t:
-
toastExePath:
-
va_list:
-
wchar_t:
-
-
-
- -
- Made with Nim. Generated: 2020-03-24 20:55:42 UTC -
-
-
-
- - - diff --git a/types.html b/types.html deleted file mode 100644 index 8321d6f..0000000 --- a/types.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - - - - - - - - - - - - - -types - - - - - - - - -
-
-

types

-
-
-
- -     Dark Mode -
- -
- Search: -
-
- Group by: - -
- - -
-
-
- -

-
-

Types

-
- -
time_t = time_t_temp.Time
-
- - - -
- -
time64_t = time_t_temp.Time
-
- - - -
- -
wchar_t {...}{.importc, header: "<cwchar>".} = object
-
- - - -
- -
ptrdiff_t = ByteAddress
-
- - - -
- -
va_list {...}{.importc, header: "<stdarg.h>".} = object
-
- - - -
- -
-
-

Templates

-
- -
template enumOp(op, typ, typout)
-
- - - -
- -
template defineEnum(typ)
-
- - - -
- -
- -
-
- -
-
- -
- Made with Nim. Generated: 2020-03-24 20:55:39 UTC -
-
-
-
- - - diff --git a/types.idx b/types.idx deleted file mode 100644 index 5f5fb02..0000000 --- a/types.idx +++ /dev/null @@ -1,7 +0,0 @@ -time_t types.html#time_t types: time_t -time64_t types.html#time64_t types: time64_t -wchar_t types.html#wchar_t types: wchar_t -ptrdiff_t types.html#ptrdiff_t types: ptrdiff_t -va_list types.html#va_list types: va_list -enumOp types.html#enumOp.t,,, types: enumOp(op, typ, typout) -defineEnum types.html#defineEnum.t types: defineEnum(typ)