conout.c

   1 /*
   2  * Copyright (C) 2012, 2013, 2014
   3  *     Dale Weiler
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
   9  * of the Software, and to permit persons to whom the Software is furnished to do
  10  * so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23 #include <stdio.h>
  24 #include "gmqcc.h"
  25
  26 #define GMQCC_IS_STDOUT(X) ((fs_file_t*)((void*)X) == (fs_file_t*)stdout)
  27 #define GMQCC_IS_STDERR(X) ((fs_file_t*)((void*)X) == (fs_file_t*)stderr)
  28 #define GMQCC_IS_DEFINE(X) (GMQCC_IS_STDERR(X) || GMQCC_IS_STDOUT(X))
  29
  30 typedef struct {
  31     fs_file_t *handle_err;
  32     fs_file_t *handle_out;
  33     int        color_err;
  34     int        color_out;
  35 } con_t;
  36
  37 /*
  38  * We use standard files as default. These can be changed at any time
  39  * with con_change(F, F)
  40  */
  41 static con_t console;
  42
  43 /*
  44  * Enables color on output if supported.
  45  * NOTE: The support for checking colors is NULL.  On windows this will
  46  * always work, on *nix it depends if the term has colors.
  47  *
  48  * NOTE: This prevents colored output to piped stdout/err via isatty
  49  * checks.
  50  */
  51 static void con_enablecolor(void) {
  52     console.color_err = util_isatty(console.handle_err);
  53     console.color_out = util_isatty(console.handle_out);
  54 }
  55
  56 /*
  57  * Does a write to the handle with the format string and list of
  58  * arguments.  This colorizes for windows as well via translate
  59  * step.
  60  */
  61 static int con_write(fs_file_t *handle, const char *fmt, va_list va) {
  62     return vfprintf((FILE*)handle, fmt, va);
  63 }
  64
  65 /**********************************************************************
  66  * EXPOSED INTERFACE BEGINS
  67  *********************************************************************/
  68
  69 void con_close() {
  70     if (!GMQCC_IS_DEFINE(console.handle_err))
  71         fs_file_close(console.handle_err);
  72     if (!GMQCC_IS_DEFINE(console.handle_out))
  73         fs_file_close(console.handle_out);
  74 }
  75
  76 void con_color(int state) {
  77     if (state)
  78         con_enablecolor();
  79     else {
  80         console.color_err = 0;
  81         console.color_out = 0;
  82     }
  83 }
  84
  85 void con_init() {
  86     console.handle_err = (fs_file_t*)stderr;
  87     console.handle_out = (fs_file_t*)stdout;
  88     con_enablecolor();
  89 }
  90
  91 void con_reset() {
  92     con_close();
  93     con_init ();
  94 }
  95
  96 /*
  97  * This is clever, say you want to change the console to use two
  98  * files for out/err.  You pass in two strings, it will properly
  99  * close the existing handles (if they're not std* handles) and
 100  * open them.  Now say you want TO use stdout and stderr, this
 101  * allows you to do that so long as you cast them to (char*).
 102  * Say you need stdout for out, but want a file for error, you can
 103  * do this too, just cast the stdout for (char*) and stick to a
 104  * string for the error file.
 105  */
 106 int con_change(const char *out, const char *err) {
 107     con_close();
 108
 109     if (!out) out = (const char *)((!console.handle_out) ? (fs_file_t*)stdout : console.handle_out);
 110     if (!err) err = (const char *)((!console.handle_err) ? (fs_file_t*)stderr : console.handle_err);
 111
 112     if (GMQCC_IS_DEFINE(out)) {
 113         console.handle_out = (fs_file_t*)(GMQCC_IS_STDOUT(out) ? stdout : stderr);
 114         con_enablecolor();
 115     } else if (!(console.handle_out = fs_file_open(out, "w"))) return 0;
 116
 117     if (GMQCC_IS_DEFINE(err)) {
 118         console.handle_err = (fs_file_t*)(GMQCC_IS_STDOUT(err) ? stdout : stderr);
 119         con_enablecolor();
 120     } else if (!(console.handle_err = fs_file_open(err, "w"))) return 0;
 121
 122     return 1;
 123 }
 124
 125 /*
 126  * Defaultizer because stdio.h shouldn't be used anywhere except here
 127  * and inside file.c To prevent mis-match of wrapper-interfaces.
 128  */
 129 fs_file_t *con_default_out() {
 130     return (fs_file_t*)(console.handle_out = (fs_file_t*)stdout);
 131 }
 132 fs_file_t *con_default_err() {
 133     return (fs_file_t*)(console.handle_err = (fs_file_t*)stderr);
 134 }
 135
 136 int con_verr(const char *fmt, va_list va) {
 137     return con_write(console.handle_err, fmt, va);
 138 }
 139 int con_vout(const char *fmt, va_list va) {
 140     return con_write(console.handle_out, fmt, va);
 141 }
 142
 143 /*
 144  * Standard stdout/stderr printf functions used generally where they need
 145  * to be used.
 146  */
 147 int con_err(const char *fmt, ...) {
 148     va_list  va;
 149     int      ln = 0;
 150     va_start(va, fmt);
 151     con_verr(fmt, va);
 152     va_end  (va);
 153     return   ln;
 154 }
 155 int con_out(const char *fmt, ...) {
 156     va_list  va;
 157     int      ln = 0;
 158     va_start(va, fmt);
 159     con_vout(fmt, va);
 160     va_end  (va);
 161     return   ln;
 162 }
 163
 164 /*
 165  * Utility console message writes for lexer contexts.  These will allow
 166  * for reporting of file:line based on lexer context, These are used
 167  * heavily in the parser/ir/ast.
 168  */
 169 static void con_vprintmsg_c(int level, const char *name, size_t line, size_t column, const char *msgtype, const char *msg, va_list ap, const char *condname) {
 170     /* color selection table */
 171     static int sel[] = {
 172         CON_WHITE,
 173         CON_CYAN,
 174         CON_RED
 175     };
 176
 177     int  err                             = !!(level == LVL_ERROR);
 178     int  color                           = (err) ? console.color_err : console.color_out;
 179     int (*print) (const char *, ...)     = (err) ? &con_err          : &con_out;
 180     int (*vprint)(const char *, va_list) = (err) ? &con_verr         : &con_vout;
 181
 182     if (color)
 183         print("\033[0;%dm%s:%d:%d: \033[0;%dm%s: \033[0m", CON_CYAN, name, (int)line, (int)column, sel[level], msgtype);
 184     else
 185         print("%s:%d:%d: %s: ", name, (int)line, (int)column, msgtype);
 186
 187     vprint(msg, ap);
 188     if (condname)
 189         print(" [%s]\n", condname);
 190     else
 191         print("\n");
 192 }
 193
 194 void con_vprintmsg(int level, const char *name, size_t line, size_t column, const char *msgtype, const char *msg, va_list ap) {
 195     con_vprintmsg_c(level, name, line, column, msgtype, msg, ap, NULL);
 196 }
 197
 198 void con_printmsg(int level, const char *name, size_t line, size_t column, const char *msgtype, const char *msg, ...) {
 199     va_list   va;
 200     va_start(va, msg);
 201     con_vprintmsg(level, name, line, column, msgtype, msg, va);
 202     va_end  (va);
 203 }
 204
 205 void con_cvprintmsg(lex_ctx_t ctx, int lvl, const char *msgtype, const char *msg, va_list ap) {
 206     con_vprintmsg(lvl, ctx.file, ctx.line, ctx.column, msgtype, msg, ap);
 207 }
 208
 209 void con_cprintmsg(lex_ctx_t ctx, int lvl, const char *msgtype, const char *msg, ...) {
 210     va_list   va;
 211     va_start(va, msg);
 212     con_cvprintmsg(ctx, lvl, msgtype, msg, va);
 213     va_end  (va);
 214 }
 215
 216 /* General error interface: TODO seperate as part of the compiler front-end */
 217 size_t compile_errors   = 0;
 218 size_t compile_warnings = 0;
 219 size_t compile_Werrors  = 0;
 220 static lex_ctx_t first_werror;
 221
 222 void compile_show_werrors()
 223 {
 224     con_cprintmsg(first_werror, LVL_ERROR, "first warning", "was here");
 225 }
 226
 227 void vcompile_error(lex_ctx_t ctx, const char *msg, va_list ap)
 228 {
 229     ++compile_errors;
 230     con_cvprintmsg(ctx, LVL_ERROR, "error", msg, ap);
 231 }
 232
 233 void compile_error(lex_ctx_t ctx, const char *msg, ...)
 234 {
 235     va_list ap;
 236     va_start(ap, msg);
 237     vcompile_error(ctx, msg, ap);
 238     va_end(ap);
 239 }
 240
 241 bool GMQCC_WARN vcompile_warning(lex_ctx_t ctx, int warntype, const char *fmt, va_list ap)
 242 {
 243     const char *msgtype = "warning";
 244     int         lvl     = LVL_WARNING;
 245     char        warn_name[1024];
 246
 247     if (!OPTS_WARN(warntype))
 248         return false;
 249
 250     warn_name[0] = '-';
 251     warn_name[1] = 'W';
 252     (void)util_strtononcmd(opts_warn_list[warntype].name, warn_name+2, sizeof(warn_name)-2);
 253
 254     ++compile_warnings;
 255     if (OPTS_WERROR(warntype)) {
 256         if (!compile_Werrors)
 257             first_werror = ctx;
 258         ++compile_Werrors;
 259         msgtype = "Werror";
 260         if (OPTS_FLAG(BAIL_ON_WERROR)) {
 261             msgtype = "error";
 262             ++compile_errors;
 263         }
 264         lvl = LVL_ERROR;
 265     }
 266
 267     con_vprintmsg_c(lvl, ctx.file, ctx.line, ctx.column, msgtype, fmt, ap, warn_name);
 268
 269     return OPTS_WERROR(warntype) && OPTS_FLAG(BAIL_ON_WERROR);
 270 }
 271
 272 bool GMQCC_WARN compile_warning(lex_ctx_t ctx, int warntype, const char *fmt, ...)
 273 {
 274     bool r;
 275     va_list ap;
 276     va_start(ap, fmt);
 277     r = vcompile_warning(ctx, warntype, fmt, ap);
 278     va_end(ap);
 279     return r;
 280 }