Merge pull request #3467 from nanoant/patch/fuse-msg-api-n-use-stdout-help

Simplify msg API and always use stdout for help/usage

compiler/commands.nim

@@ -65,14 +65,15 @@ proc getCommandLineDesc(): string =
 
 proc helpOnError(pass: TCmdLinePass) =
   if pass == passCmd1:
-    msgWriteln(getCommandLineDesc())
+    msgWriteln(getCommandLineDesc(), {msgStdout})
     msgQuit(0)
 
 proc writeAdvancedUsage(pass: TCmdLinePass) =
   if pass == passCmd1:
     msgWriteln(`%`(HelpMessage, [VersionAsString,
                                  platform.OS[platform.hostOS].name,
-                                 CPU[platform.hostCPU].name]) & AdvancedUsage)
+                                 CPU[platform.hostCPU].name]) & AdvancedUsage,
+               {msgStdout})
     msgQuit(0)
 
 proc writeVersionInfo(pass: TCmdLinePass) =
@@ -95,7 +96,7 @@ var
 
 proc writeCommandLineUsage() =
   if not helpWritten:
-    msgWriteln(getCommandLineDesc())
+    msgWriteln(getCommandLineDesc(), {msgStdout})
     helpWritten = true
 
 proc addPrefix(switch: string): string =

compiler/main.nim

@@ -317,11 +317,12 @@ proc mainCommand* =
         (key: "lib_paths", val: libpaths)
       ]
 
-      outWriteln($dumpdata)
+      msgWriteln($dumpdata, {msgStdout, msgSkipHook})
     else:
-      outWriteln("-- list of currently defined symbols --")
+      msgWriteln("-- list of currently defined symbols --",
-      for s in definedSymbolNames(): outWriteln(s)
+                 {msgStdout, msgSkipHook})
-      outWriteln("-- end of list --")
+      for s in definedSymbolNames(): msgWriteln(s, {msgStdout, msgSkipHook})
+      msgWriteln("-- end of list --", {msgStdout, msgSkipHook})
 
       for it in iterSearchPath(searchPaths): msgWriteln(it)
   of "check":

compiler/msgs.nim

@@ -727,20 +727,23 @@ proc `??`* (info: TLineInfo, filename: string): bool =
 
 var gTrackPos*: TLineInfo
 
-proc outWriteln*(s: string) =
+type
-  ## Writes to stdout. Always.
+  MsgFlag* = enum  ## flags altering msgWriteln behavior
-  if eStdOut in errorOutputs:
+    msgStdout,     ## force writing to stdout, even stderr is default
-    writeLine(stdout, s)
+    msgSkipHook    ## skip message hook even if it is present
-    flushFile(stdout)
+  MsgFlags* = set[MsgFlag]
 
-proc msgWriteln*(s: string) =
+proc msgWriteln*(s: string, flags: MsgFlags = {}) =
-  ## Writes to stderr. If --stdout option is given, writes to stdout instead.
+  ## Writes given message string to stderr by default.
+  ## If ``--stdout`` option is given, writes to stdout instead. If message hook
+  ## is present, then it is used to output message rather than stderr/stdout.
+  ## This behavior can be altered by given optional flags.
 
   #if gCmd == cmdIdeTools and optCDebug notin gGlobalOptions: return
 
-  if not isNil(writelnHook):
+  if not isNil(writelnHook) and msgSkipHook notin flags:
     writelnHook(s)
-  elif optStdout in gGlobalOptions:
+  elif optStdout in gGlobalOptions or msgStdout in flags:
     if eStdOut in errorOutputs:
       writeLine(stdout, s)
       flushFile(stdout)
@@ -751,15 +754,6 @@ proc msgWriteln*(s: string) =
       when defined(windows):
         flushFile(stderr)
 
-proc stdoutWriteln*(s: string) =
-  ## Writes to stdout.
-  ## Should be used only for VM time equivalents to procs outputting to stdout.
-  if not isNil(writelnHook):
-    writelnHook(s)
-  else:
-    writeLine(stdout, s)
-    flushFile(stdout)
-
 macro callIgnoringStyle(theProc: typed, first: typed,
                         args: varargs[expr]): stmt =
   let typForegroundColor = bindSym"ForegroundColor".getType

compiler/vm.nim

@@ -811,13 +811,13 @@ proc rawExecute(c: PCtx, start: int, tos: PStackFrame): TFullReg =
     of opcEcho:
       let rb = instr.regB
       if rb == 1:
-        stdoutWriteln(regs[ra].node.strVal)
+        msgWriteln(regs[ra].node.strVal, {msgStdout})
       else:
         var outp = ""
         for i in ra..ra+rb-1:
           #if regs[i].kind != rkNode: debug regs[i]
           outp.add(regs[i].node.strVal)
-        stdoutWriteln(outp)
+        msgWriteln(outp, {msgStdout})
     of opcContainsSet:
       decodeBC(rkInt)
       regs[ra].intVal = ord(inSet(regs[rb].node, regs[rc].regToNode))