jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3454 from jlp765/osproc

Browse source 
add simple example for execProcess, exeCmd, execCmdEx
This commit is contained in:
Andreas Rumpf 2015-10-23 02:01:26 +02:00
commit ba63ea9e82
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
lib/pure/osproc.nim
View file

@ -124,11 +124,21 @@ proc execProcess*(command: string,
## and returns its output as a string. ## and returns its output as a string.
## WARNING: this function uses poEvalCommand by default for backward compatibility. ## WARNING: this function uses poEvalCommand by default for backward compatibility.
## Make sure to pass options explicitly. ## Make sure to pass options explicitly.
##
## .. code-block:: Nim
##
## let outp = execProcess("nim c -r mytestfile.nim")
## # Note: outp may have an interleave of text from the nim compile
## # and any output from mytestfile when it runs
proc execCmd*(command: string): int {.rtl, extern: "nosp$1", tags: [ExecIOEffect].} proc execCmd*(command: string): int {.rtl, extern: "nosp$1", tags: [ExecIOEffect].}
## Executes ``command`` and returns its error code. Standard input, output, ## Executes ``command`` and returns its error code. Standard input, output,
## error streams are inherited from the calling process. This operation ## error streams are inherited from the calling process. This operation
## is also often called `system`:idx:. ## is also often called `system`:idx:.
##
## .. code-block:: Nim
##
## let errC = execCmd("nim c -r mytestfile.nim")
proc startProcess*(command: string, proc startProcess*(command: string,
workingDir: string = "", workingDir: string = "",
@ -1055,6 +1065,10 @@ proc execCmdEx*(command: string, options: set[ProcessOption] = {
exitCode: int] {.tags: [ExecIOEffect, ReadIOEffect], gcsafe.} = exitCode: int] {.tags: [ExecIOEffect, ReadIOEffect], gcsafe.} =
## a convenience proc that runs the `command`, grabs all its output and ## a convenience proc that runs the `command`, grabs all its output and
## exit code and returns both. ## exit code and returns both.
##
## .. code-block:: Nim
##
## let (outp, errC) = execCmdEx("nim c -r mytestfile.nim")
var p = startProcess(command, options=options + {poEvalCommand}) var p = startProcess(command, options=options + {poEvalCommand})
var outp = outputStream(p) var outp = outputStream(p)
result = (TaintedString"", -1) result = (TaintedString"", -1)