add extensions for nim files (#4295)

* add extensions for nim files

* fixes https://forum.nim-lang.org/t/4307

* Update languages.yml

* remove config.nims, covered by .nims

* add to samples/Nim/ these ext: nims cfg nimble

* update foo.nim to something more interesting

* address comments

lib/linguist/languages.yml

@@ -3083,7 +3083,12 @@ Nim:
   color: "#37775b"
   extensions:
   - ".nim"
+  - ".nim.cfg"
+  - ".nimble"
   - ".nimrod"
+  - ".nims"
+  filenames:
+  - nim.cfg
   ace_mode: text
   tm_scope: source.nim
   language_id: 249

samples/Nim/config.nims

@@ -0,0 +1,274 @@
+# from https://github.com/kaushalmodi/nim_config/blob/master/config.nims
+
+from macros import error
+from ospaths import `/`, splitPath, splitFile
+from strutils import `%`
+from sequtils import filterIt
+from strutils import endsWith
+
+## Switches
+switch("nep1", "on")
+
+## Constants
+const
+  doOptimize = true
+
+## Lets
+let
+  root = projectDir() # projectDir() needs nim 0.20.0 (or nim devel as of Tue Oct 16 08:41:09 EDT 2018)
+  (_, pkgName) = root.splitPath()
+  srcFile = root / "src" / (pkgName & ".nim")
+  # pcre
+  pcreVersion = getEnv("PCREVER", "8.42")
+  pcreSourceDir = "pcre-" & pcreVersion
+  pcreArchiveFile = pcreSourceDir & ".tar.bz2"
+  pcreDownloadLink = "https://downloads.sourceforge.net/pcre/" & pcreArchiveFile
+  pcreInstallDir = (root / "pcre/") & pcreVersion
+  # http://www.linuxfromscratch.org/blfs/view/8.1/general/pcre.html
+  pcreConfigureCmd = ["./configure", "--prefix=" & pcreInstallDir, "--enable-pcre16", "--enable-pcre32", "--disable-shared"]
+  pcreIncludeDir = pcreInstallDir / "include"
+  pcreLibDir = pcreInstallDir / "lib"
+  pcreLibFile = pcreLibDir / "libpcre.a"
+  # libressl
+  libreSslVersion = getEnv("LIBRESSLVER", "2.8.1")
+  libreSslSourceDir = "libressl-" & libreSslVersion
+  libreSslArchiveFile = libreSslSourceDir & ".tar.gz"
+  libreSslDownloadLink = "https://ftp.openbsd.org/pub/OpenBSD/LibreSSL/" & libreSslArchiveFile
+  libreSslInstallDir = (root / "libressl/") & libreSslVersion
+  libreSslConfigureCmd = ["./configure", "--disable-shared", "--prefix=" & libreSslInstallDir]
+  libreSslLibDir = libreSslInstallDir / "lib"
+  libreSslLibFile = libreSslLibDir / "libssl.a"
+  libreCryptoLibFile = libreSslLibDir / "libcrypto.a"
+  libreSslIncludeDir = libreSslInstallDir / "include/openssl"
+  # openssl
+  openSslSeedConfigOsCompiler = "linux-x86_64"
+  openSslVersion = getEnv("OPENSSLVER", "1.1.1")
+  openSslSourceDir = "openssl-" & openSslVersion
+  openSslArchiveFile = openSslSourceDir & ".tar.gz"
+  openSslDownloadLink = "https://www.openssl.org/source/" & openSslArchiveFile
+  openSslInstallDir = (root / "openssl/") & openSslVersion
+  # "no-async" is needed for openssl to compile using musl
+  #   - https://gitter.im/nim-lang/Nim?at=5bbf75c3ae7be940163cc198
+  #   - https://www.openwall.com/lists/musl/2016/02/04/5
+  # -DOPENSSL_NO_SECURE_MEMORY is needed to make openssl compile using musl.
+  #   - https://github.com/openssl/openssl/issues/7207#issuecomment-420814524
+  openSslConfigureCmd = ["./Configure", openSslSeedConfigOsCompiler, "no-shared", "no-zlib", "no-async", "-fPIC", "-DOPENSSL_NO_SECURE_MEMORY", "--prefix=" & openSslInstallDir]
+  openSslLibDir = openSslInstallDir / "lib"
+  openSslLibFile = openSslLibDir / "libssl.a"
+  openCryptoLibFile = openSslLibDir / "libcrypto.a"
+  openSslIncludeDir = openSslInstallDir / "include/openssl"
+
+## Helper Procs
+# https://github.com/kaushalmodi/elnim
+proc dollar[T](s: T): string =
+  result = $s
+proc mapconcat[T](s: openArray[T]; sep = " "; op: proc(x: T): string = dollar): string =
+  ## Concatenate elements of ``s`` after applying ``op`` to each element.
+  ## Separate each element using ``sep``.
+  for i, x in s:
+    result.add(op(x))
+    if i < s.len-1:
+      result.add(sep)
+
+proc binOptimize(binFile: string) =
+  ## Optimize size of the ``binFile`` binary.
+  echo ""
+  if findExe("strip") != "":
+    echo "Running 'strip -s' .."
+    exec "strip -s " & binFile
+  if findExe("upx") != "":
+    # https://github.com/upx/upx/releases/
+    echo "Running 'upx --best' .."
+    exec "upx --best " & binFile
+
+## Tasks
+task installPcre, "Installs PCRE using musl-gcc":
+  if not existsFile(pcreLibFile):
+    if not existsDir(pcreSourceDir):
+      if not existsFile(pcreArchiveFile):
+        exec("curl -LO " & pcreDownloadLink)
+      exec("tar xf " & pcreArchiveFile)
+    else:
+      echo "PCRE lib source dir " & pcreSourceDir & " already exists"
+    withDir pcreSourceDir:
+      putEnv("CC", "musl-gcc -static")
+      exec(pcreConfigureCmd.mapconcat())
+      exec("make -j8")
+      exec("make install")
+  else:
+    echo pcreLibFile & " already exists"
+  setCommand("nop")
+
+task installLibreSsl, "Installs LIBRESSL using musl-gcc":
+  if (not existsFile(libreSslLibFile)) or (not existsFile(libreCryptoLibFile)):
+    if not existsDir(libreSslSourceDir):
+      if not existsFile(libreSslArchiveFile):
+        exec("curl -LO " & libreSslDownloadLink)
+      exec("tar xf " & libreSslArchiveFile)
+    else:
+      echo "LibreSSL lib source dir " & libreSslSourceDir & " already exists"
+    withDir libreSslSourceDir:
+      #  -idirafter /usr/include/ # Needed for linux/sysctl.h
+      #  -idirafter /usr/include/x86_64-linux-gnu/ # Needed for Travis/Ubuntu build to pass, for asm/types.h
+      putEnv("CC", "musl-gcc -static -idirafter /usr/include/ -idirafter /usr/include/x86_64-linux-gnu/")
+      putEnv("C_INCLUDE_PATH", libreSslIncludeDir)
+      exec(libreSslConfigureCmd.mapconcat())
+      exec("make -j8 -C crypto") # build just the "crypto" component
+      exec("make -j8 -C ssl")    # build just the "ssl" component
+      exec("make -C crypto install")
+      exec("make -C ssl install")
+  else:
+    echo libreSslLibFile & " already exists"
+  setCommand("nop")
+
+task installOpenSsl, "Installs OPENSSL using musl-gcc":
+  if (not existsFile(openSslLibFile)) or (not existsFile(openCryptoLibFile)):
+    if not existsDir(openSslSourceDir):
+      if not existsFile(openSslArchiveFile):
+        exec("curl -LO " & openSslDownloadLink)
+      exec("tar xf " & openSslArchiveFile)
+    else:
+      echo "OpenSSL lib source dir " & openSslSourceDir & " already exists"
+    withDir openSslSourceDir:
+      # https://gcc.gnu.org/onlinedocs/gcc/Directory-Options.html
+      #  -idirafter /usr/include/ # Needed for Travis/Ubuntu build to pass, for linux/version.h, etc.
+      #  -idirafter /usr/include/x86_64-linux-gnu/ # Needed for Travis/Ubuntu build to pass, for asm/types.h
+      putEnv("CC", "musl-gcc -static -idirafter /usr/include/ -idirafter /usr/include/x86_64-linux-gnu/")
+      putEnv("C_INCLUDE_PATH", openSslIncludeDir)
+      exec(openSslConfigureCmd.mapconcat())
+      echo "The insecure switch -DOPENSSL_NO_SECURE_MEMORY is needed so that OpenSSL can be compiled using MUSL."
+      exec("make -j8 depend")
+      exec("make -j8")
+      exec("make install_sw")
+  else:
+    echo openSslLibFile & " already exists"
+  setCommand("nop")
+
+# nim musl foo.nim
+task musl, "Builds an optimized static binary using musl":
+  ## Usage: nim musl [-d:pcre] [-d:libressl|-d:openssl] <FILE1> <FILE2> ..
+  var
+    switches: seq[string]
+    nimFiles: seq[string]
+  let
+    numParams = paramCount()
+
+  when defined(libressl) and defined(openssl):
+    error("Define only 'libressl' or 'openssl', not both.")
+
+  # param 0 will always be "nim"
+  # param 1 will always be "musl"
+  for i in 2 .. numParams:
+    if paramStr(i)[0] == '-':    # -d:foo or --define:foo
+      switches.add(paramStr(i))
+    else:
+      # Non-switch parameters are assumed to be Nim file names.
+      nimFiles.add(paramStr(i))
+
+  if nimFiles.len == 0:
+    error(["The 'musl' sub-command accepts at least one Nim file name",
+           "  Examples: nim musl FILE.nim",
+           "            nim musl FILE1.nim FILE2.nim",
+           "            nim musl -d:pcre FILE.nim",
+           "            nim musl -d:libressl FILE.nim",
+           "            nim musl -d:pcre -d:openssl FILE.nim"].mapconcat("\n"))
+
+  for f in nimFiles:
+    let
+      extraSwitches = switches.mapconcat()
+      (dirName, baseName, _) = splitFile(f)
+      binFile = dirName / baseName  # Save the binary in the same dir as the nim file
+      nimArgsArray = when doOptimize:
+                       ["c", "-d:musl", "-d:release", "--opt:size", extraSwitches, f]
+                     else:
+                       ["c", "-d:musl", extraSwitches, f]
+      nimArgs = nimArgsArray.mapconcat()
+    # echo "[debug] f = " & f & ", binFile = " & binFile
+
+    # Build binary
+    echo "\nRunning 'nim " & nimArgs & "' .."
+    selfExec nimArgs
+
+    when doOptimize:
+      # Optimize binary
+      binOptimize(binFile)
+
+    echo "\nCreated binary: " & binFile
+
+task test, "Run tests via 'nim doc' and runnableExamples and tests in tests dir":
+  let
+    testDir = root / "tests"
+  selfExec("doc " & srcFile)
+  if dirExists(testDir):
+    let
+      testFiles = listFiles(testDir).filterIt(it.len >= 5 and it.endsWith(".nim"))
+    for t in testFiles:
+      selfExec "c -r " & t
+
+task docs, "Deploy doc html + search index to public/ directory":
+  let
+    deployDir = root / "public"
+    docOutBaseName = "index"
+    deployHtmlFile = deployDir / (docOutBaseName & ".html")
+    genDocCmd = "nim doc --index:on -o:$1 $2" % [deployHtmlFile, srcFile]
+    deployIdxFile = deployDir / (pkgName & ".idx")
+    sedCmd = "sed -i 's|" & pkgName & r"\.html|" & docOutBaseName & ".html|' " & deployIdxFile
+    genTheIndexCmd = "nim buildIndex -o:$1/theindex.html $1" % [deployDir]
+    deployJsFile = deployDir / "dochack.js"
+    docHackJsSource = "https://nim-lang.github.io/Nim/dochack.js" # devel docs dochack.js
+  mkDir(deployDir)
+  exec(genDocCmd)
+  exec(sedCmd) # Hack: replace <pkgName>.html with <docOutBaseName>.html in the .idx file
+  exec(genTheIndexCmd) # Generate theindex.html only after fixing the .idx file
+  if not fileExists(deployJsFile):
+    withDir deployDir:
+      exec("curl -LO " & docHackJsSource)
+
+## Define Switch Parsing
+# -d:musl
+when defined(musl):
+  var
+    muslGccPath: string
+  echo "  [-d:musl] Building a static binary using musl .."
+  muslGccPath = findExe("musl-gcc")
+  echo "debug: " & muslGccPath
+  if muslGccPath == "":
+    error("'musl-gcc' binary was not found in PATH.")
+  switch("passL", "-static")
+  switch("gcc.exe", muslGccPath)
+  switch("gcc.linkerexe", muslGccPath)
+  # -d:pcre
+  when defined(pcre):
+    if not existsFile(pcreLibFile):
+      selfExec "installPcre"    # Install PCRE in current dir if pcreLibFile is not found
+    switch("passC", "-I" & pcreIncludeDir) # So that pcre.h is found when running the musl task
+    switch("define", "usePcreHeader")
+    switch("passL", pcreLibFile)
+  # -d:libressl or -d:openssl
+  when defined(libressl) or defined(openssl):
+    switch("define", "ssl")     # Pass -d:ssl to nim
+    when defined(libressl):
+      let
+        sslLibFile = libreSslLibFile
+        cryptoLibFile = libreCryptoLibFile
+        sslIncludeDir = libreSslIncludeDir
+        sslLibDir = libreSslLibDir
+    when defined(openssl):
+      let
+        sslLibFile = openSslLibFile
+        cryptoLibFile = openCryptoLibFile
+        sslIncludeDir = openSslIncludeDir
+        sslLibDir = openSslLibDir
+
+    if (not existsFile(sslLibFile)) or (not existsFile(cryptoLibFile)):
+      # Install SSL in current dir if sslLibFile or cryptoLibFile is not found
+      when defined(libressl):
+        selfExec "installLibreSsl"
+      when defined(openssl):
+        selfExec "installOpenSsl"
+    switch("passC", "-I" & sslIncludeDir) # So that ssl.h is found when running the musl task
+    switch("passL", "-L" & sslLibDir)
+    switch("passL", "-lssl")
+    switch("passL", "-lcrypto") # This *has* to come *after* -lssl
+    switch("dynlibOverride", "libssl")
+    switch("dynlibOverride", "libcrypto")