Index

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

API symbols

ast2:

• Feature.ast2

buildDocs:

• docs: buildDocs(files: openArray[string]; path: string; baseDir = getProjectPath() & "/"; defines: openArray[string] = @[])

c2nImport:

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

cacheDir:

• paths: cacheDir

cAddSearchDir:

• cimport: cAddSearchDir(dir: string)

cAddStdDir:

• cimport: cAddStdDir(mode = "c")

cCompile:

• cimport: cCompile(path: static string; mode = "c"; exclude = ""): untyped

cDebug:

• cimport: cDebug()

cDefine:

• cimport: cDefine(name: static string; val: static string = ""): untyped

cDisableCaching:

• cimport: cDisableCaching()

cImport:

• cimport: cImport(filename: static string; recurse: static bool = false; dynlib: static string = ""; mode: static string = "c"; flags: static string = ""): untyped

cIncludeDir:

• cimport: cIncludeDir(dir: static string): untyped

clearDefines:

• build: clearDefines(): untyped

cmake:

• build: cmake(path, check, flags: string)

configure:

• build: configure(path, check: string; flags = "")

cOverride:

• cimport: cOverride(body): untyped

cOverrides:

• plugin: cOverrides

cpFile:

• build: cpFile(source, dest: string; move = false)

cPlugin:

• cimport: cPlugin(body): untyped

cSearchPath:

• cimport: cSearchPath(path: string): string

cSkipSymbol:

• cimport: cSkipSymbol(skips: seq[string])

defineEnum:

• types: defineEnum(typ)

downloadUrl:

• build: downloadUrl(url, outdir: string)

enumOp:

• types: enumOp(op, typ, typout)

execAction:

• build: execAction(cmd: string; retry = 0; die = true; cache = false; cacheKey = ""): tuple[ output: string, ret: int]

extractTar:

• build: extractTar(tarfile, outdir: string)

extractZip:

• build: extractZip(zipfile, outdir: string)

Feature:

• cimport: Feature

findExe:

• build: findExe(exe: string): string

findFile:

• build: findFile(file: string; dir: string; recurse = true; first = false; regex = false): string

flagBuild:

• build: flagBuild(base: string; flags: openArray[string]): string

getCmakeIncludePath:

• build: getCmakeIncludePath(paths: openArray[string]): string

getCompiler:

• build: getCompiler(): string

getCurrentNimCompiler:

• build: getCurrentNimCompiler(): string

getGccLibPaths:

• build: getGccLibPaths(mode = "c"): seq[string]

getGccPaths:

• build: getGccPaths(mode = "c"): seq[string]

getHeader:

• build: 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

getProjectCacheDir:

• build: getProjectCacheDir(name: string; forceClean = true): string

gitCheckout:

• build: gitCheckout(file, outdir: string)

gitPull:

• build: gitPull(url: string; outdir = ""; plist = ""; checkout = "")

gitReset:

• build: gitReset(outdir: string)

isDefined:

• build: isDefined(def: untyped): untyped

linkLibs:

• build: linkLibs(names: openArray[string]; staticLink = true): string

make:

• build: make(path, check: string; flags = ""; regex = false)

mkDir:

• build: mkDir(dir: string)

mvFile:

• build: mvFile(source, dest: string)

myNormalizedPath:

• compat: myNormalizedPath(path: string): string

nimteropRoot:

• paths: nimteropRoot(): string

nimteropSrcDir:

• paths: nimteropSrcDir(): string

OnSymbol:

• plugin: OnSymbol

OnSymbolOverrideFinal:

• plugin: OnSymbolOverrideFinal

onSymbolOverrideFinal:

• plugin: onSymbolOverrideFinal(typ: string): StringHash

ptrdiff_t:

• types: ptrdiff_t

rmDir:

• build: rmDir(dir: string)

rmFile:

• build: rmFile(source: string; dir = false)

sanitizePath:

• build: sanitizePath(path: string; noQuote = false; sep = $'/'): string

setCmakeLibName:

• build: setCmakeLibName(outdir, name, prefix = ""; oname = ""; suffix = "")

setCmakePositionIndependentCode:

• build: setCmakePositionIndependentCode(outdir: string)

setCmakeProperty:

• build: setCmakeProperty(outdir, name, property, value: string)

setDefines:

• build: setDefines(defs: static openArray[string]): untyped

sleep:

• build: sleep(milsecs: int)

Symbol:

• plugin: Symbol

testsIncludeDir:

• paths: testsIncludeDir(): string

time64_t:

• types: time64_t

time_t:

• types: time_t

toastExePath:

• paths: toastExePath(): string

va_list:

• types: va_list

wchar_t:

• types: wchar_t