checkClip

returns the newest entry from the Clipboard requires xclip to be installed , works provided string does not have special utf8 etc chars experimental since more than one clipboard maybe installed

printLnBiCol("Last Clipboard Entry : " & checkClip())

checkColor

returns true if colname is a known color name in colorNames constants.nim

colorio

Displays name,hex code and rgb of colors available in cx.nim

cxAlert

issues an alert

also available printAlertMsg see cxprint.nim

cxAlertLn

issues an alert line

also available printLnAlertMsg see cxprint.nim

import nimcx
# try to change the width of the terminal  window
while true:
   if tw < 100:
       infoproc(cxAlertLn(2))
       showTerminalSize()
   else:
       infoproc(printLnOkMsg($(tw),2))
   sleepy(0.5)

cxBell

ring system bell may or may not work

cxcat

same as nimcat but does not specialise for nim if no extension found A simple file lister which shows all rows and some stats. It also allows counting of tokens. A file name without extension will be assuemed to be .nim Countphrase is case sensitive This proc uses memfiles for speed and has an added linesFlg to show or not show Line numbers

cxcat("ducknotes.csv",linesFlg=false)                          # show all lines
cxcat("bigdatafile.csv",linesFlg=false)     # do not show line numbrs
cxcat("/data5/notes.txt",countphrase = @["nice" , "hanya", "88"],linesFlg=true) # also count how often a token appears in the file

cxcolor

returns a color from a cxpal , which can be used in cxprintLn and other print routines

cxprintln(3,cxcolor(cxredpal[8]),cxcolorBg(cxgreypal[6]),"NimCx Pallet")

cxcolorBg

returns a color from a cxpal to be used as background color in cxprintLn and other print routines

cxprintln(3,cxcolor(cxyellowpal[x]),cxcolorBg(cxbluepal[5]),"NimCx Pallet")

cxHelp

a help generator which can easily be called from within or on app start with ability to include code blocks

cxHelp(["Help system for " & extractFileName(getAppFilename()),
     "",
    "1) Read the book",
    "2) use more data",
    "3) have a beer",
    cxcodestart,
    "Example 1",
    "",
    "let abc = @[1,2,3]",
    "    ",
    "var xfg = mysupergenerator(abc,3)",
    cxcodeend,
    "this should be help style again",
    cxcodestart,
    "Example 2  ",
    "",
    "for x in 0..<n:",
    """   printLn("Something Nice  ",blue)"""",
    cxcodeend,
    "Have a nice day"])

cxhostnamectl

wrapper to display hostnamectl output

hostnamectl is available on many systems

cxSound

play a sound file with aplay , default is receive.wav , if file and aplay is avaialble

doByeBye

a simple end program routine do give some feedback when exiting

doCxEnd

short testing routine of cx.nim if run as main

doInfo

A more than you want to know information proc

getColorName

this functions returns the colorname based on a color escape sequence

usually used with randcol() to see what color was actually returned

referenced colornames defined in cxconstants.nim

import nimcx
for x in 0 ..< 10:
   let acol = randcol()
   let acolname = getColorName(acol)
   printLn(acolname,acol)

handler

exit handler this runs if ctrl-c is pressed

and provides some feedback upon exit

just by using this module your project will have an automatic

exit handler via ctrl-c

this handler may not work if code compiled into a .dll or .so file

or under some circumstances like being called during readLineFromStdin

infoLine

prints some info about current application

makeColor

a utility function to show random effect of rgb changes see makeColorTest or makeGreyScaleTest for example use

makeColorTest

testing makeColor proc need to be run in a KDE konsole to see all the colors

makeGreyScaleTest

shows a greyscale table with desired params

newColor

creates a new color string from r,g,b values. Passed in colors can be used as foregroundcolor in print,printLn routines and as bgr in cxPrint,cxprintLn .

Example

import nimcx
printLn("Test for rgb color 12345  " & efb2 * 10,newColor(27354,4763,1089))
decho()
printLn("Test for rgb color 12345  " & efb2 * 10,newColor(73547,4873,4888))
decho()
printLn("Test for rgb color 12345  " & efb2 * 10,newColor(990,483,38),bgblue)
decho()
# or save it
let mymystiquecolor = newColor2(93547,84873,77888)
printLn("Here we go",mymystiquecolor)
doFinish()

newColor2

creates a new color string from r,g,b values passed in with styleReverse effect for text best used as backgroundcolor in print, printLn etc. routines

newCxcounter

set up a new cxcounter

simple counter with add,dec and reset procs

var counter1 = newCxcounter()
counter1.add   # add 1
counter1.dec   # dec 1
counter1.reset # set to 0
echo counter1.value # show current value

newDir

creates a new directory and provides some feedback

nimcat

A simple file lister which shows all rows and some stats. It also allows counting of tokens. A file name without extension will be assuemed to be .nim Countphrase is case sensitive This proc uses memfiles for speed alternatively use cxcat where any line numbers can be omitted

nimcat("notes.txt")                   # show all lines
nimcat("bigdatafile.csv")
nimcat("/data5/notes.txt",countphrase = @["nice" , "hanya", "88"]) # also count how often a token appears in the file

printTest

prints TEST,the current filename and an optional string

qqTop

prints qqTop in custom color

remDir

deletes an existing directory , all subdirectories and files and provides some feedback

root and home directory removal is disallowed

this obviously is a dangerous proc handle with care !!

showBench

Displays results of all benchmarks

showColors

display all colorNames in color !

showHexColors

pass in a seq of hexcolors like: myhexcols = @"#F5F5F5","#FFFF00","#9ACD32"

:: showPalette

Displays palette with all coltype as found in colorNames coltype examples : "red","blue","medium","dark","light","pastel" etc..

showTerminalSize

displays current terminal dimensions

width is always available via tw

height is always available via th

spellFloat

writes out a float number in english with up to 14 positions after the dot currency denotes spelling of an amount sep and sepname can be adjusted as needed default sep = "." default sepname = " dot "

import nimcx
printLn spellFloat(0.00)
printLn spellFloat(234)
printLn spellFloat(-2311.345)
printLn spellFloat(5212311.00).replace("dot","and") & "hundreds"
printLn spellFloat(122311.34,true).replace("dot","dollars and") & " cents"

spellInteger2

used in after comma part of a float , we just put out the numbers one by one

code adapted from rosettacode and updated

toClip

send a string to the Clipboard using xclip only error messages will shown if any. required xclip to be installed

for x in 33..126:
  echo(fmtx(["<3","","","",""],x,spaces(2),x as char,spaces(2),ff2(x as float,3)))

benchmark

a quick benchmark template showing cpu and epoch times without repeat

benchmark("whatever"):
  let z = 0.. 1000
  loopy(z,printLn("Kami makan tiga kali setiap hari.",randcol()))

proc doit() =
     var s = createSeqFloat(10,9)
     var cc = newCxCounter()
     s.sort(system.cmp,order = Descending)
     for x in s:
         cc.add
         cxprintLn(0,fmtx(["",">4","<6","","<f15.7"],yellowgreen,cc.value," :",beige,$x))
 
 var bx = newCxCounter()
 benchmark("doit",10000):
         doit()
         bx.add
         cxprintLn(3,fmtx(["","","","",">8"],greenyellow, " " , uparrow , " Run " , bx.value))
         echo()
 showBench() 

benchmark

a quick benchmark template showing cpu and epoch times with repeat looping param suitable for quick in-program timing of procs

benchmark("whatever",1000):
    printLn("Kami makan tiga kali setiap hari.",randcol())

import nimcx,algorithm

proc doit() =
    var s = createSeqFloat(10,9)
    var c = 0
    s.sort(system.cmp,order = Descending)
    for x in s:
        inc c
        printLnBiCol(fmtx([">4","<6","<f15.7"],$c," :",$x))

template cxcounter(bx:int):int =
        inc bx
        bx

var x = 0
benchmark("doit",10000):
        doit()
        hline(30)
        printLn( " " & uparrow & " Run " & $cxcounter(x),greenyellow)
        echo()

showBench()

checkLocals

check name,type and value of local variables needs to be called inside a proc ,calling from toplevel has no effect best placed at bottom end of a proc to pick up all Variables

currentFile

returns path and current filename

cxbg

used to set background colors from cxpallets see cxconsts.nim .. code-block:: nim cxbg(cxbluepal3) cxbg(cxblue3) # is the same , declarations in cxconsts.nim

cxfg

to set foreground colors from cxpallets see cxconsts.nim

cxrv

color reverser

Example: .. code-block:: nim cxprintln(0,"Nice number ",white,redbg,78.cxrv," test finished ! ",truetomato,"Good test .".cxrv, yellowgreen,"OK".cxrv )

infoProc

shows from where a specific function has been called and combined with checkLocals gives a nice formatted output for debugging

proc test1[T](ff:varargs[T,`$`]) =
  let yu1 = @["test"]
  var yu2 = "sdfsdf"
  var yu3 = parseInt(ff[1]) * 3  # ff[1] has been converted to string we change it back to int and multiply
  print("test output    : ",lime)
  for x in ff: print(x & spaces(1)) # print the passed in varargs
  checklocals()

proc test2(s:string,b:int) : string =
   var bb = b * getRndInt(10,200)
   result = s & $bb
   checklocals()

infoproc(test1("zz",1234,789.88))
infoproc:
    printLnBiCol(fmtx(["","",""],"Test2 output  : ",rightarrow & spaces(1),test2("nice",2000)),colLeft = cyan,colRight=gold,":",0,false,{})
doFinish()

toCxOpenarray

used to pass seqs to procs expecting an openarray type as input, passing a seq would work too but openarray is faster

var s1 = createSeqInt(5)
var s2 = createSeqInt(5)
var zs = zipWith(`/`,s1,s2)   # try with +,-,*,/,div...
echo zs

original code ex Nim Forum