Module that should import everything so that nim doc --project nimtero/all runs docs on everything.
+Module that should import everything so that nim doc --project nimtero/all runs docs on everything.
Imports
-
@@ -832,7 +1264,7 @@ function main() {
Module that should import everything so that nim doc --project nimtero/all runs docs on everything.
+Module that should import everything so that nim doc --project nimtero/all runs docs on everything.
Main import file to write wrappers. Each compileTime proc must be used in a compile time context, eg using:
--static: - cAddStdDir() -+
Main import file to write wrappers. Each compileTime proc must be used in a compile time context, eg using:
+```
+```
-proc cSkipSymbol(skips: seq[string]) {...}{.compileTime, raises: [], tags: [].}
proc cSkipSymbol(skips: seq[string]) {...}{.compileTime, raises: [], tags: [].}
Examples:
@@ -884,21 +1322,21 @@ Similar to cOverrproc cSearchPath(path: string): string {...}{.compileTime, raises: [], tags: [ReadDirEffect].}
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: [].}
proc cDebug() {...}{.compileTime, raises: [], tags: [].}
proc cDisableCaching() {...}{.compileTime, raises: [], tags: [].}
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.
@@ -907,7 +1345,7 @@ Enable debug messages and display the generated Nim codeproc cAddSearchDir(dir: string) {...}{.compileTime, raises: [], tags: [].}
proc cAddSearchDir(dir: string) {...}{.compileTime, raises: [], tags: [].}
Examples:
@@ -920,7 +1358,7 @@ Add directory dir toproc cAddStdDir(mode = "c") {...}{.compileTime, raises: [], tags: [].}
proc cAddStdDir(mode = "c") {...}{.compileTime, raises: [], tags: [].}
Examples:
@@ -937,8 +1375,8 @@ Add the standard c [dmacro cOverride(body): untyped
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 no longer defines these symbols.
For example:
@@ -949,20 +1387,20 @@ Add the standard c [dmacro cPlugin(body): untyped
macro cPlugin(body): untyped
proc onSymbol(sym: var Symbol) {.exportc, dynlib.}
onSymbol() can be used to handle symbol name modifications required due to invalid characters like leading/trailing _ or rename symbols that would clash due to Nim's style insensitivity. It can also be used to remove prefixes and suffixes like SDL_. The symbol name and type is provided to the callback and the name can be modified.
-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.
+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 like leading/trailing _ or rename symbols that would clash due to Nim's style insensitivity. It can also be used to remove prefixes and suffixes like SDL_. The symbol name and type is provided to the callback and the name can be modified.
+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:
-nimterop/plugins is implicitly imported to provide access to standard plugin facilities.
+nimterop/plugins is implicitly imported to provide access to standard plugin facilities.
Examples:
cPlugin: @@ -984,19 +1422,19 @@ When cOverride()<
macro cDefine(name: static string; val: static string = ""): untyped
macro cDefine(name: static string; val: static string = ""): untyped
macro cIncludeDir(dir: static string): untyped
macro cIncludeDir(dir: static string): untyped
macro cCompile(path: static string; mode = "c"; exclude = ""): untyped
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:
@@ -1007,8 +1445,8 @@ Add an include directory that is forwarded to the C/C++ compiler using cCompile("path/to/dir", exclude="test2.c")macro cImport(filename: static string; recurse: static bool = false): untyped
macro cImport(filename: static string; recurse: static bool = false): 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()
@@ -1016,11 +1454,6 @@ Add an include directory that is forwarded to the C/C++ compiler using -proc relativePath(file, base: string): string {...}{.raises: [], tags: [].}
Examples:
+import + ospaths, unittest + +check: + "/foo/bar/baz/log.txt".unixToNativePath.relativePath( + "/foo/bar".unixToNativePath) == "baz/log.txt".unixToNativePath + "foo/bar/baz/log.txt".unixToNativePath.relativePath("foo/bar".unixToNativePath) == + "baz/log.txt".unixToNativePath+ +
proc execAction(cmd: string; nostderr = false): string {...}{. - raises: [OSError, Exception, ValueError, IOError, Defect], +- -
- -
- -
- -
- +
proc extractZip(zipfile, outdir: string) {...}{.raises: [OSError, Exception, ValueError, - IOError, Defect], tags: [ExecIOEffect, ReadIOEffect, RootEffect].}- -
- +
proc downloadUrl(url, outdir: string) {...}{.raises: [OSError, Exception, ValueError, - IOError, Defect], tags: [ReadDirEffect, ExecIOEffect, ReadIOEffect, RootEffect].}- -
- -
- +
proc gitCheckout(file, outdir: string) {...}{.raises: [ValueError, OSError, Exception, - IOError, Defect], tags: [ExecIOEffect, ReadIOEffect, RootEffect, TimeEffect].}- -
- +
+ +- +
proc configure(path, check: string) {...}{.raises: [OSError, Exception, ValueError], tags: [ + ReadDirEffect, ExecIOEffect, ReadIOEffect, RootEffect].}- + +
proc nimteropRoot(): string {...}{.raises: [], tags: [].}
proc nimteropRoot(): string {...}{.raises: [], tags: [].}
proc nimteropBuildDir(): string {...}{.raises: [], tags: [].}
proc nimteropBuildDir(): string {...}{.raises: [], tags: [].}
proc nimteropSrcDir(): string {...}{.raises: [], tags: [].}
proc nimteropSrcDir(): string {...}{.raises: [], tags: [].}
proc toastExePath(): string {...}{.raises: [], tags: [].}
proc toastExePath(): string {...}{.raises: [], tags: [].}
proc incDir(): string {...}{.raises: [], tags: [].}
proc incDir(): string {...}{.raises: [], tags: [].}
proc testsIncludeDir(): string {...}{.raises: [], tags: [].}
proc testsIncludeDir(): string {...}{.raises: [], tags: [].}
time_t = time_t_temp.Time
time_t = Time
template enumOp(op, typ, typout)
template enumOp(op, typ, typout)
template defineEnum(typ)
template defineEnum(typ)