# # # The Nim Installation Generator # (c) Copyright 2015 Andreas Rumpf # # See the file "copying.txt", included in this # distribution, for details about the copyright. # const haveZipLib = defined(unix) when haveZipLib: import zipfiles import os, osproc, strutils, parseopt, parsecfg, strtabs, streams, debcreation const maxOS = 20 # max number of OSes maxCPU = 10 # max number of CPUs buildShFile = "build.sh" buildBatFile32 = "build.bat" buildBatFile64 = "build64.bat" makeFile = "makefile" installShFile = "install.sh" deinstallShFile = "deinstall.sh" type AppType = enum appConsole, appGUI Action = enum actionNone, # action not yet known actionCSource # action: create C sources actionInno, # action: create Inno Setup installer actionNsis, # action: create NSIS installer actionScripts # action: create install and deinstall scripts actionZip, # action: create zip file actionDeb # action: prepare deb package FileCategory = enum fcWinBin, # binaries for Windows fcConfig, # configuration files fcData, # data files fcDoc, # documentation files fcLib, # library files fcOther, # other files; will not be copied on UNIX fcWindows, # files only for Windows fcUnix, # files only for Unix; must be after ``fcWindows`` fcUnixBin, # binaries for Unix fcDocStart # links to documentation for Windows installer ConfigData = object of RootObj actions: set[Action] cat: array[FileCategory, seq[string]] binPaths, authors, oses, cpus, downloads: seq[string] cfiles: array[1..maxOS, array[1..maxCPU, seq[string]]] platforms: array[1..maxOS, array[1..maxCPU, bool]] ccompiler, linker, innosetup, nsisSetup: tuple[path, flags: string] name, displayName, version, description, license, infile, outdir: string mainfile, libpath: string innoSetupFlag, installScript, uninstallScript: bool explicitPlatforms: bool vars: StringTableRef app: AppType nimArgs: string debOpts: TDebOptions const unixDirVars: array[fcConfig..fcLib, string] = [ "$configdir", "$datadir", "$docdir", "$libdir" ] proc iniConfigData(c: var ConfigData) = c.actions = {} for i in low(FileCategory)..high(FileCategory): c.cat[i] = @[] c.binPaths = @[] c.authors = @[] c.oses = @[] c.cpus = @[] c.downloads = @[] c.ccompiler = ("", "") c.linker = ("", "") c.innosetup = ("", "") c.nsisSetup = ("", "") c.name = "" c.displayName = "" c.version = "" c.description = "" c.license = "" c.infile = "" c.mainfile = "" c.outdir = "" c.nimArgs = "" c.libpath = "" c.innoSetupFlag = false c.installScript = false c.uninstallScript = false c.vars = newStringTable(modeStyleInsensitive) c.debOpts.buildDepends = "" c.debOpts.pkgDepends = "" c.debOpts.shortDesc = "" c.debOpts.licenses = @[] proc firstBinPath(c: ConfigData): string = if c.binPaths.len > 0: result = c.binPaths[0] else: result = "" proc `\`(a, b: string): string = result = if a.len == 0: b else: a & '\\' & b template toUnix(s: string): string = s.replace('\\', '/') template toWin(s: string): string = s.replace('/', '\\') proc skipRoot(f: string): string = # "abc/def/xyz" --> "def/xyz" var i = 0 result = "" for component in split(f, {DirSep, AltSep}): if i > 0: result = result / component inc i if result.len == 0: result = f include "inno.tmpl" include "nsis.tmpl" include "buildsh.tmpl" include "makefile.tmpl" include "buildbat.tmpl" include "install.tmpl" include "deinstall.tmpl" # ------------------------- configuration file ------------------------------- const Version = "1.0" Usage = "niminst - Nim Installation Generator Version " & Version & """ (c) 2015 Andreas Rumpf Usage: niminst [options] command[;command2...] ini-file[.ini] [compile_options] Command: csource build C source code for source based installations scripts build install and deinstall scripts zip build the ZIP file inno build the Inno Setup installer nsis build the NSIS Setup installer deb create files for debhelper Options: -o, --output:dir set the output directory -m, --main:file set the main nim file, by default ini-file with .nim extension --var:name=value set the value of a variable -h, --help shows this help -v, --version shows the version Compile_options: will be passed to the Nim compiler """ proc parseCmdLine(c: var ConfigData) = var p = initOptParser() while true: next(p) var kind = p.kind var key = p.key var val = p.val.string case kind of cmdArgument: if c.actions == {}: for a in split(normalize(key.string), {';', ','}): case a of "csource": incl(c.actions, actionCSource) of "scripts": incl(c.actions, actionScripts) of "zip": incl(c.actions, actionZip) of "inno": incl(c.actions, actionInno) of "nsis": incl(c.actions, actionNsis) of "deb": incl(c.actions, actionDeb) else: quit(Usage) else: c.infile = addFileExt(key.string, "ini") c.nimArgs = cmdLineRest(p).string break of cmdLongoption, cmdShortOption: case normalize(key.string) of "help", "h": stdout.write(Usage) quit(0) of "version", "v": stdout.write(Version & "\n") quit(0) of "o", "output": c.outdir = val of "m", "main": c.mainfile = changeFileExt(val, "nim") of "var": var idx = val.find('=') if idx < 0: quit("invalid command line") c.vars[substr(val, 0, idx-1)] = substr(val, idx+1) else: quit(Usage) of cmdEnd: break if c.infile.len == 0: quit(Usage) if c.mainfile.len == 0: c.mainfile = changeFileExt(c.infile, "nim") proc walkDirRecursively(s: var seq[string], root: string) = for k, f in walkDir(root): case k of pcFile, pcLinkToFile: add(s, unixToNativePath(f)) of pcDir: walkDirRecursively(s, f) of pcLinkToDir: discard proc addFiles(s: var seq[string], patterns: seq[string]) = for p in items(patterns): if existsDir(p): walkDirRecursively(s, p) else: var i = 0 for f in walkFiles(p): add(s, unixToNativePath(f)) inc(i) if i == 0: echo("[Warning] No file found that matches: " & p) proc pathFlags(p: var CfgParser, k, v: string, t: var tuple[path, flags: string]) = case normalize(k) of "path": t.path = v of "flags": t.flags = v else: quit(errorStr(p, "unknown variable: " & k)) proc filesOnly(p: var CfgParser, k, v: string, dest: var seq[string]) = case normalize(k) of "files": addFiles(dest, split(v, {';'})) else: quit(errorStr(p, "unknown variable: " & k)) proc yesno(p: var CfgParser, v: string): bool = case normalize(v) of "yes", "y", "on", "true": result = true of "no", "n", "off", "false": result = false else: quit(errorStr(p, "unknown value; use: yes|no")) proc incl(s: var seq[string], x: string): int = for i in 0.. 0: c.outdir else: "build" proc writeFile(filename, content, newline: string) = var f: File if open(f, filename, fmWrite): for x in splitLines(content): write(f, x) write(f, newline) close(f) else: quit("Cannot open for writing: " & filename) proc removeDuplicateFiles(c: var ConfigData) = for osA in countdown(c.oses.len, 1): for cpuA in countdown(c.cpus.len, 1): if c.cfiles[osA][cpuA].isNil: c.cfiles[osA][cpuA] = @[] if c.explicitPlatforms and not c.platforms[osA][cpuA]: continue for i in 0..c.cfiles[osA][cpuA].len-1: var dup = c.cfiles[osA][cpuA][i] var f = extractFilename(dup) for osB in 1..c.oses.len: for cpuB in 1..c.cpus.len: if osB != osA or cpuB != cpuA: var orig = buildDir(osB, cpuB) / f if existsFile(orig) and existsFile(dup) and sameFileContent(orig, dup): # file is identical, so delete duplicate: removeFile(dup) c.cfiles[osA][cpuA][i] = orig proc writeInstallScripts(c: var ConfigData) = if c.installScript: writeFile(installShFile, generateInstallScript(c), "\10") inclFilePermissions(installShFile, {fpUserExec, fpGroupExec, fpOthersExec}) if c.uninstallScript: writeFile(deinstallShFile, generateDeinstallScript(c), "\10") inclFilePermissions(deinstallShFile, {fpUserExec, fpGroupExec, fpOthersExec}) proc srcdist(c: var ConfigData) = if not existsDir(getOutputDir(c) / "c_code"): createDir(getOutputDir(c) / "c_code") for x in walkFiles(c.libpath / "lib/*.h"): echo(getOutputDir(c) / "c_code" / extractFilename(x)) copyFile(dest=getOutputDir(c) / "c_code" / extractFilename(x), source=x) var winIndex = -1 var intel32Index = -1 var intel64Index = -1 for osA in 1..c.oses.len: let osname = c.oses[osA-1] if osname.cmpIgnoreStyle("windows") == 0: winIndex = osA for cpuA in 1..c.cpus.len: if c.explicitPlatforms and not c.platforms[osA][cpuA]: continue let cpuname = c.cpus[cpuA-1] if cpuname.cmpIgnoreStyle("i386") == 0: intel32Index = cpuA elif cpuname.cmpIgnoreStyle("amd64") == 0: intel64Index = cpuA var dir = getOutputDir(c) / buildDir(osA, cpuA) if existsDir(dir): removeDir(dir) createDir(dir) var cmd = ("nim compile -f --symbolfiles:off --compileonly " & "--gen_mapping --cc:gcc --skipUserCfg" & " --os:$# --cpu:$# $# $#") % [osname, cpuname, c.nimArgs, c.mainfile] echo(cmd) if execShellCmd(cmd) != 0: quit("Error: call to nim compiler failed") readCFiles(c, osA, cpuA) for i in 0 .. c.cfiles[osA][cpuA].len-1: let dest = dir / extractFilename(c.cfiles[osA][cpuA][i]) let relDest = buildDir(osA, cpuA) / extractFilename(c.cfiles[osA][cpuA][i]) copyFile(dest=dest, source=c.cfiles[osA][cpuA][i]) c.cfiles[osA][cpuA][i] = relDest # second pass: remove duplicate files removeDuplicateFiles(c) writeFile(getOutputDir(c) / buildShFile, generateBuildShellScript(c), "\10") inclFilePermissions(getOutputDir(c) / buildShFile, {fpUserExec, fpGroupExec, fpOthersExec}) writeFile(getOutputDir(c) / makeFile, generateMakefile(c), "\10") if winIndex >= 0: if intel32Index >= 0: writeFile(getOutputDir(c) / buildBatFile32, generateBuildBatchScript(c, winIndex, intel32Index), "\13\10") if intel64Index >= 0: writeFile(getOutputDir(c) / buildBatFile64, generateBuildBatchScript(c, winIndex, intel64Index), "\13\10") writeInstallScripts(c) # --------------------- generate inno setup ----------------------------------- proc setupDist(c: var ConfigData) = let scrpt = generateInnoSetup(c) let n = "build" / "install_$#_$#.iss" % [toLower(c.name), c.version] writeFile(n, scrpt, "\13\10") when defined(windows): if c.innosetup.path.len == 0: c.innosetup.path = "iscc.exe" let outcmd = if c.outdir.len == 0: "build" else: c.outdir let cmd = "$# $# /O$# $#" % [quoteShell(c.innosetup.path), c.innosetup.flags, outcmd, n] echo(cmd) if execShellCmd(cmd) == 0: removeFile(n) else: quit("External program failed") # --------------------- generate NSIS setup ----------------------------------- proc setupDist2(c: var ConfigData) = let scrpt = generateNsisSetup(c) let n = "build" / "install_$#_$#.nsi" % [toLower(c.name), c.version] writeFile(n, scrpt, "\13\10") when defined(windows): if c.nsisSetup.path.len == 0: c.nsisSetup.path = "makensis.exe" let outcmd = if c.outdir.len == 0: "build" else: c.outdir let cmd = "$# $# /O$# $#" % [quoteShell(c.nsisSetup.path), c.nsisSetup.flags, outcmd, n] echo(cmd) if execShellCmd(cmd) == 0: removeFile(n) else: quit("External program failed") # ------------------ generate ZIP file --------------------------------------- when haveZipLib: proc zipDist(c: var ConfigData) = var proj = toLower(c.name) & "-" & c.version var n = "$#.zip" % proj if c.outdir.len == 0: n = "build" / n else: n = c.outdir / n var z: TZipArchive if open(z, n, fmWrite): addFile(z, proj / buildBatFile32, "build" / buildBatFile32) addFile(z, proj / buildBatFile64, "build" / buildBatFile64) addFile(z, proj / buildShFile, "build" / buildShFile) addFile(z, proj / makeFile, "build" / makeFile) addFile(z, proj / installShFile, installShFile) addFile(z, proj / deinstallShFile, deinstallShFile) for f in walkFiles(c.libpath / "lib/*.h"): addFile(z, proj / "c_code" / extractFilename(f), f) for osA in 1..c.oses.len: for cpuA in 1..c.cpus.len: var dir = buildDir(osA, cpuA) for k, f in walkDir("build" / dir): if k == pcFile: addFile(z, proj / dir / extractFilename(f), f) for cat in items({fcConfig..fcOther, fcUnix}): for f in items(c.cat[cat]): addFile(z, proj / f, f) close(z) else: quit("Cannot open for writing: " & n) # -- prepare build files for .deb creation proc debDist(c: var ConfigData) = if not existsFile(getOutputDir(c) / "build.sh"): quit("No build.sh found.") if not existsFile(getOutputDir(c) / "install.sh"): quit("No install.sh found.") if c.debOpts.shortDesc == "": quit("shortDesc must be set in the .ini file.") if c.debOpts.licenses.len == 0: echo("[Warning] No licenses specified for .deb creation.") # -- Copy files into /tmp/.. echo("Copying source to tmp/niminst/deb/") var currentSource = getCurrentDir() var workingDir = getTempDir() / "niminst" / "deb" var upstreamSource = (c.name.toLower() & "-" & c.version) createDir(workingDir / upstreamSource) template copyNimDist(f, dest: string): stmt = createDir((workingDir / upstreamSource / dest).splitFile.dir) copyFile(currentSource / f, workingDir / upstreamSource / dest) # Don't copy all files, only the ones specified in the config: copyNimDist(buildShFile, buildShFile) copyNimDist(makeFile, makeFile) copyNimDist(installShFile, installShFile) createDir(workingDir / upstreamSource / "build") for f in walkFiles(c.libpath / "lib/*.h"): copyNimDist(f, "build" / extractFilename(f)) for osA in 1..c.oses.len: for cpuA in 1..c.cpus.len: var dir = buildDir(osA, cpuA) for k, f in walkDir(dir): if k == pcFile: copyNimDist(f, dir / extractFilename(f)) for cat in items({fcConfig..fcOther, fcUnix}): for f in items(c.cat[cat]): copyNimDist(f, f) # -- Create necessary build files for debhelper. let mtnName = c.vars["mtnname"] let mtnEmail = c.vars["mtnemail"] prepDeb(c.name, c.version, mtnName, mtnEmail, c.debOpts.shortDesc, c.description, c.debOpts.licenses, c.cat[fcUnixBin], c.cat[fcConfig], c.cat[fcDoc], c.cat[fcLib], c.debOpts.buildDepends, c.debOpts.pkgDepends) # ------------------- main ---------------------------------------------------- var c: ConfigData iniConfigData(c) parseCmdLine(c) parseIniFile(c) if actionInno in c.actions: setupDist(c) if actionNsis in c.actions: setupDist2(c) if actionCSource in c.actions: srcdist(c) if actionScripts in c.actions: writeInstallScripts(c) if actionZip in c.actions: when haveZipLib: zipDist(c) else: quit("libzip is not installed") if actionDeb in c.actions: debDist(c)