Index

Modules: build, build/ccompiler, build/conan, build/getheader, build/jbb, build/misc, build/nimconf, build/shell, build/tools, cimport, compat, docs, globals, paths, plugin, types.

API symbols

`==`:

• build: `==`(pkg1, pkg2: ConanPackage): bool
• build: `==`(pkg1, pkg2: JBBPackage): bool
• conan: `==`(pkg1, pkg2: ConanPackage): bool
• jbb: `==`(pkg1, pkg2: JBBPackage): bool

addAltConanBaseUrl:

• build: addAltConanBaseUrl(name, url: string)
• conan: addAltConanBaseUrl(name, url: string)

ast2:

• Feature.ast2

Bl:

• globals: Bl(s: typed): untyped

btAutoconf:

• BuildType.btAutoconf
• BuildType.btAutoconf

btCmake:

• BuildType.btCmake
• BuildType.btCmake

buildDocs:

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

BuildStatus:

• globals: BuildStatus

BuildType:

• build: BuildType
• globals: BuildType

buildWithAutoConf:

• tools: buildWithAutoConf(outdir, flags: string): BuildStatus

buildWithCmake:

• tools: buildWithCmake(outdir, flags: string): BuildStatus

c2nImport:

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

cacheDir:

• paths: cacheDir

cAddSearchDir:

• cimport: cAddSearchDir(dir: string)

cAddStdDir:

• cimport: cAddStdDir(mode = "c")

cCompile:

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

cDebug:

• cimport: cDebug()

cDefine:

• cimport: cDefine(values: static seq[string]): untyped
• cimport: cDefine(name: static[string]; val: static[string] = ""): untyped

cDisableCaching:

• cimport: cDisableCaching()

cExclude:

• cimport: cExclude(paths: static seq[string]): untyped
• cimport: cExclude(path: static string): untyped

cImport:

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

cIncludeDir:

• cimport: cIncludeDir(dirs: static seq[string]; exclude: static[bool] = false): untyped
• cimport: cIncludeDir(dir: static[string]; exclude: static[bool] = false): untyped

cleanDir:

• build: cleanDir(dir: string)
• shell: cleanDir(dir: string)

clearDefines:

• build: clearDefines(): untyped
• getheader: clearDefines(): untyped

cmake:

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

compareVersions:

• build: compareVersions(ver1, ver2: string): int
• misc: compareVersions(ver1, ver2: string): int

ConanBuild:

• build: ConanBuild
• conan: ConanBuild

ConanPackage:

• build: ConanPackage
• conan: ConanPackage

Config:

• build: Config
• nimconf: Config

configure:

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

cOverride:

• cimport: cOverride(body): untyped

cOverrides:

• plugin: cOverrides

cPassC:

• cimport: cPassC(value: static string): untyped

cPassL:

• cimport: cPassL(value: static string): untyped

cpFile:

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

cPlugin:

• cimport: cPlugin(body): untyped

cPluginPath:

• cimport: cPluginPath(path: static[string]): untyped

cpTree:

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

cSearchPath:

• cimport: cSearchPath(path: string): string

cSkipSymbol:

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

decho:

• globals: decho(args: varargs[string, `$`]): untyped

defineEnum:

• types: defineEnum(typ)

dlConanBuild:

• build: dlConanBuild(pkg: ConanPackage; bld: ConanBuild; outdir: string; revision = "")
• conan: dlConanBuild(pkg: ConanPackage; bld: ConanBuild; outdir: string; revision = "")

dlConanRequires:

• build: dlConanRequires(pkg: ConanPackage; bld: ConanBuild; outdir: string)
• conan: dlConanRequires(pkg: ConanPackage; bld: ConanBuild; outdir: string)

dlJBBRequires:

• build: dlJBBRequires(pkg: JBBPackage; outdir: string)
• jbb: dlJBBRequires(pkg: JBBPackage; outdir: string)

downloadConan:

• build: downloadConan(pkg: ConanPackage; outdir: string; main = true)
• conan: downloadConan(pkg: ConanPackage; outdir: string; main = true)

downloadJBB:

• build: downloadJBB(pkg: JBBPackage; outdir: string; main = true)
• jbb: downloadJBB(pkg: JBBPackage; outdir: string; main = true)

downloadUrl:

• build: downloadUrl(url, outdir: string; quiet = false; retry = 1)
• shell: downloadUrl(url, outdir: string; quiet = false; retry = 1)

enumOp:

• types: enumOp(op, typ, typout)

execAction:

• build: execAction(cmd: string; retry = 0; die = true; cache = false; cacheKey = ""; onRetry: proc () = nil): tuple[output: string, ret: int]
• shell: 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]

extractTar:

• build: extractTar(tarfile, outdir: string; quiet = false)
• shell: extractTar(tarfile, outdir: string; quiet = false)

extractZip:

• build: extractZip(zipfile, outdir: string; quiet = false)
• shell: extractZip(zipfile, outdir: string; quiet = false)

Feature:

• globals: Feature

findExe:

• build: findExe(exe: string): string
• shell: findExe(exe: string): string

findFile:

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

findFiles:

• build: findFiles(file: string; dir: string; recurse = true; regex = false): seq[string]
• shell: findFiles(file: string; dir: string; recurse = true; regex = false): seq[string]

fixCmd:

• misc: fixCmd(cmd: string): string

fixRelPath:

• nimconf: fixRelPath(path: string): string

flagBuild:

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

gDebug:

• build: gDebug

gDebugCT:

• build: gDebugCT

gecho:

• globals: gecho(args: string)

getCmakeIncludePath:

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

getCommented:

• globals: getCommented(str: string): string

getCompiler:

• build: getCompiler(): string
• ccompiler: getCompiler(): string

getCompilerMode:

• build: getCompilerMode(path: string): string
• ccompiler: getCompilerMode(path: string): string

getConanBuilds:

• build: getConanBuilds(pkg: ConanPackage; filter = "")
• conan: getConanBuilds(pkg: ConanPackage; filter = "")

getConanLDeps:

• build: getConanLDeps(pkg: ConanPackage; outdir: string; main = true): seq[string]
• conan: getConanLDeps(pkg: ConanPackage; outdir: string; main = true): seq[string]

getConanRevisions:

• build: getConanRevisions(pkg: ConanPackage; bld: ConanBuild)
• conan: getConanRevisions(pkg: ConanPackage; bld: ConanBuild)

getCurrentNimCompiler:

• build: getCurrentNimCompiler(): string
• misc: getCurrentNimCompiler(): string

getFileDate:

• build: getFileDate(fullpath: string): string
• shell: getFileDate(fullpath: string): string

getGccInfo:

• build: getGccInfo(): tuple[arch, os, compiler, version: string]
• ccompiler: getGccInfo(): tuple[arch, os, compiler, version: string]

getGccLibPaths:

• build: getGccLibPaths(mode: string): seq[string]
• ccompiler: getGccLibPaths(mode: string): seq[string]

getGccModeArg:

• build: getGccModeArg(mode: string): string
• ccompiler: getGccModeArg(mode: string): string

getGccPaths:

• build: getGccPaths(mode: string): seq[string]
• ccompiler: getGccPaths(mode: string): seq[string]

getHeader:

• build: 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] = ""; altNames: static[string] = ""; buildTypes: static[openArray[BuildType]] = [btCmake, btAutoconf]): untyped
• getheader: 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

getJBBLDeps:

• build: getJBBLDeps(pkg: JBBPackage; outdir: string; shared: bool; main = true): seq[string]
• jbb: getJBBLDeps(pkg: JBBPackage; outdir: string; shared: bool; main = true): seq[string]

getJBBRepo:

• build: getJBBRepo(pkg: JBBPackage; outdir: string)
• jbb: getJBBRepo(pkg: JBBPackage; outdir: string)

getNimcacheDir:

• build: getNimcacheDir(projectDir = ""): string
• nimconf: getNimcacheDir(projectDir = ""): string

getNimConfig:

• build: getNimConfig(projectDir = ""): Config
• nimconf: getNimConfig(projectDir = ""): Config

getNimConfigFlags:

• build: getNimConfigFlags(projectDir = ""): string
• nimconf: getNimConfigFlags(projectDir = ""): string

getNimteropCacheDir:

• nimconf: getNimteropCacheDir(): string

getNumProcs:

• build: getNumProcs(): string
• shell: getNumProcs(): string

getOutDir:

• build: getOutDir(projectDir = ""): string
• nimconf: getOutDir(projectDir = ""): string

getProjectCacheDir:

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

getProjectDir:

• build: getProjectDir(): string
• nimconf: getProjectDir(): string

getUriFromConanPackage:

• build: getUriFromConanPackage(pkg: ConanPackage): string
• conan: getUriFromConanPackage(pkg: ConanPackage): string

gitAtCheckout:

• shell: gitAtCheckout(outdir, checkout: string): bool

gitCheckout:

• build: gitCheckout(file, outdir: string)
• shell: gitCheckout(file, outdir: string)

gitDefaultBranch:

• shell: gitDefaultBranch(outdir: string): string

gitPull:

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

gitReset:

• build: gitReset(outdir: string)
• shell: gitReset(outdir: string)

gitTags:

• build: gitTags(outdir: string): seq[string]
• shell: gitTags(outdir: string): seq[string]

gNimExe:

• build: gNimExe

gStateCT:

• globals: gStateCT

isDefined:

• build: isDefined(def: untyped): untyped
• getheader: isDefined(def: untyped): untyped

JBBPackage:

• build: JBBPackage
• jbb: JBBPackage

linkLibs:

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

loadConanInfo:

• build: loadConanInfo(outdir: string): ConanPackage
• conan: loadConanInfo(outdir: string): ConanPackage

loadJBBInfo:

• build: loadJBBInfo(outdir: string): JBBPackage
• jbb: loadJBBInfo(outdir: string): JBBPackage

make:

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

mkDir:

• build: mkDir(dir: string)
• shell: mkDir(dir: string)

mvFile:

• build: mvFile(source, dest: string)
• shell: mvFile(source, dest: string)

mvTree:

• build: mvTree(source, dest: string)
• shell: mvTree(source, dest: string)

myNormalizedPath:

• compat: myNormalizedPath(path: string): string

nBl:

• globals: nBl(s: typed): untyped

newConanPackage:

• build: newConanPackage(name, version, user = "_"; channel = "_"; bhash = ""; shared = true): ConanPackage
• conan: newConanPackage(name, version, user = "_"; channel = "_"; bhash = ""; shared = true): ConanPackage

newConanPackageFromUri:

• build: newConanPackageFromUri(uri: string; shared = true): ConanPackage
• conan: newConanPackageFromUri(uri: string; shared = true): ConanPackage

newJBBPackage:

• build: newJBBPackage(name, version: string): JBBPackage
• jbb: newJBBPackage(name, version: string): JBBPackage

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

renderPragma:

• cimport: renderPragma(): untyped

rmDir:

• build: rmDir(dir: string)
• shell: rmDir(dir: string)

rmFile:

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

sanitizePath:

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

saveConanInfo:

• build: saveConanInfo(pkg: ConanPackage; outdir: string)
• conan: saveConanInfo(pkg: ConanPackage; outdir: string)

saveJBBInfo:

• build: saveJBBInfo(pkg: JBBPackage; outdir: string)
• jbb: saveJBBInfo(pkg: JBBPackage; outdir: string)

searchConan:

• build: searchConan(pkg: ConanPackage): ConanPackage
• build: searchConan(name: string; version = ""; user = ""; channel = ""): ConanPackage
• conan: searchConan(pkg: ConanPackage): ConanPackage
• conan: searchConan(name: string; version = ""; user = ""; channel = ""): ConanPackage

setCmakeLibName:

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

setCmakePositionIndependentCode:

• build: setCmakePositionIndependentCode(outdir: string)
• tools: setCmakePositionIndependentCode(outdir: string)

setCmakeProperty:

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

setDefines:

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

sleep:

• build: sleep(milsecs: int)
• shell: sleep(milsecs: int)

State:

• globals: State

Symbol:

• plugin: Symbol

testsIncludeDir:

• paths: testsIncludeDir(): string

time64_t:

• types: time64_t

time_t:

• types: time_t

toastExePath:

• paths: toastExePath(): string

touchFile:

• build: touchFile(fullpath: string)
• shell: touchFile(fullpath: string)

va_list:

• types: va_list

wchar_t:

• types: wchar_t

writeNimConfig:

• build: writeNimConfig(cfgFile: string; projectDir = "")
• nimconf: writeNimConfig(cfgFile: string; projectDir = "")