valareport.vala 9.9 KB
Newer Older
1 2
/* valareport.vala
 *
3
 * Copyright (C) 2006-2010  Jürg Billeter
4 5 6 7
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
8
 * version 2.1 of the License, or (at your option) any later version.
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.

 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
 *
 * Author:
 * 	Jürg Billeter <j@bitron.ch>
 */

using GLib;

Florian Brosch's avatar
Florian Brosch committed
25

26
/**
27
 * Namespace to centralize reporting warnings and errors.
28
 */
29
public class Vala.Report {
30 31 32 33 34 35
	public enum Colored {
		AUTO,
		NEVER,
		ALWAYS
	}

Florian Brosch's avatar
Florian Brosch committed
36
	/**
37
	 * SGR (Select Graphic Rendition) end tag
Florian Brosch's avatar
Florian Brosch committed
38 39 40 41
	 */
	private const string ANSI_COLOR_END = "\x1b[0m";

	/**
42
	 * SGR (Select Graphic Rendition) start tag for source location
Florian Brosch's avatar
Florian Brosch committed
43 44 45 46
	 */
	private string locus_color_start = "";

	/**
47
	 * SGR (Select Graphic Rendition) end tag for source location
Florian Brosch's avatar
Florian Brosch committed
48 49 50 51
	 */
	private unowned string locus_color_end = "";

	/**
52
	 * SGR (Select Graphic Rendition) start tag for warning titles
Florian Brosch's avatar
Florian Brosch committed
53 54 55 56
	 */
	private string warning_color_start = "";

	/**
57
	 * SGR (Select Graphic Rendition) end tag for warning titles
Florian Brosch's avatar
Florian Brosch committed
58 59 60 61
	 */
	private unowned string warning_color_end = "";

	/**
62
	 * SGR (Select Graphic Rendition) start tag for error titles
Florian Brosch's avatar
Florian Brosch committed
63 64 65 66
	 */
	private string error_color_start = "";

	/**
67
	 * SGR (Select Graphic Rendition) end tag for error titles
Florian Brosch's avatar
Florian Brosch committed
68 69 70 71
	 */
	private unowned string error_color_end = "";

	/**
72
	 * SGR (Select Graphic Rendition) start tag for note titles
Florian Brosch's avatar
Florian Brosch committed
73 74 75 76
	 */
	private string note_color_start = "";

	/**
77
	 * SGR (Select Graphic Rendition) end tag for note titles
Florian Brosch's avatar
Florian Brosch committed
78 79 80 81
	 */
	private unowned string note_color_end = "";

	/**
82
	 * SGR (Select Graphic Rendition) start tag for caret line (^^^)
Florian Brosch's avatar
Florian Brosch committed
83 84 85 86
	 */
	private string caret_color_start = "";

	/**
87
	 * SGR (Select Graphic Rendition) end tag for caret line (^^^)
Florian Brosch's avatar
Florian Brosch committed
88 89 90 91
	 */
	private unowned string caret_color_end = "";

	/**
92
	 * SGR (Select Graphic Rendition) start tag for quotes line ('...', `...`, `...')
Florian Brosch's avatar
Florian Brosch committed
93 94 95 96
	 */
	private string quote_color_start = "";

	/**
97
	 * SGR (Select Graphic Rendition) end tag for quotes line ('...', `...`, `...')
Florian Brosch's avatar
Florian Brosch committed
98 99 100 101
	 */
	private unowned string quote_color_end = "";


102 103
	protected int warnings;
	protected int errors;
104

Florian Brosch's avatar
Florian Brosch committed
105
	private bool verbose_errors;
106

107 108
	public bool enable_warnings { get; set; default = true; }

109
	static GLib.Regex val_regex;
Florian Brosch's avatar
Florian Brosch committed
110 111 112 113 114 115 116 117

	/**
	 * Set all colors by string
	 *
	 * {{{
	 *   "error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01"
	 * }}}
	 */
118
	public bool set_colors (string str, Report.Colored colored_output = Report.Colored.AUTO) {
Florian Brosch's avatar
Florian Brosch committed
119
		try {
120 121
			if (val_regex == null)
				val_regex = new Regex ("^\\s*[0-9]+(;[0-9]*)*\\s*$");
Florian Brosch's avatar
Florian Brosch committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
		} catch (RegexError e) {
			assert_not_reached ();
		}

		string error_color = null;
		string warning_color = null;
		string note_color = null;
		string caret_color = null;
		string locus_color = null;
		string quote_color = null;

		string[] fragments = str.split (":");
		foreach (unowned string fragment in fragments) {
			string[] eq = fragment.split ("=", 2);
			if (eq.length != 2) {
				return false;
			}

			if (!val_regex.match (eq[1])) {
				return false;
			}


			unowned string checked_value = eq[1]._strip ();
			switch (eq[0]._strip ()) {
			case "error":
				error_color = checked_value;
				break;

			case "warning":
				warning_color = checked_value;
				break;

			case "note":
				note_color = checked_value;
				break;

			case "caret":
				caret_color = checked_value;
				break;

			case "locus":
				locus_color = checked_value;
				break;

			case "quote":
				quote_color = checked_value;
				break;

			default:
				return false;
			}
		}

176
		if (colored_output == Report.Colored.ALWAYS || (colored_output == Report.Colored.AUTO && is_atty (stderr.fileno ()))) {
Florian Brosch's avatar
Florian Brosch committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
			if (error_color != null) {
				this.error_color_start = "\x1b[0" + error_color + "m";
				this.error_color_end = ANSI_COLOR_END;
			}

			if (warning_color != null) {
				this.warning_color_start = "\x1b[0" + warning_color + "m";
				this.warning_color_end = ANSI_COLOR_END;
			}

			if (note_color != null) {
				this.note_color_start = "\x1b[0" + note_color + "m";
				this.note_color_end = ANSI_COLOR_END;
			}

			if (caret_color != null) {
				this.caret_color_start = "\x1b[0" + caret_color + "m";
				this.caret_color_end = ANSI_COLOR_END;
			}

			if (locus_color != null) {
				this.locus_color_start = "\x1b[0" + locus_color + "m";
				this.locus_color_end = ANSI_COLOR_END;
			}

			if (quote_color != null) {
				this.quote_color_start = "\x1b[0" + quote_color + "m";
				this.quote_color_end = ANSI_COLOR_END;
			}
		}
		return true;
	}

210 211 212
	/**
	 * Set the error verbosity.
	 */
213
	public void set_verbose_errors (bool verbose) {
214 215 216
		verbose_errors = verbose;
	}

217 218 219
	/**
	 * Returns the total number of warnings reported.
	 */
220
	public int get_warnings () {
221 222
		return warnings;
	}
Florian Brosch's avatar
Florian Brosch committed
223

224 225 226
	/**
	 * Returns the total number of errors reported.
	 */
227
	public int get_errors () {
228 229 230
		return errors;
	}

231 232 233
	/**
	 * Pretty-print the actual line of offending code if possible.
	 */
Florian Brosch's avatar
Florian Brosch committed
234
	private void report_source (SourceReference source) {
235
		if (source.begin.line != source.end.line) {
236 237 238 239
			// FIXME Cannot report multi-line issues currently
			return;
		}

240
		string offending_line = source.file.get_source_line (source.begin.line);
241 242 243 244

		if (offending_line != null) {
			stderr.printf ("%s\n", offending_line);
			int idx;
Florian Brosch's avatar
Florian Brosch committed
245

246 247 248
			/* We loop in this manner so that we don't fall over on differing
			 * tab widths. This means we get the ^s in the right places.
			 */
249
			for (idx = 1; idx < source.begin.column; ++idx) {
250 251 252 253 254 255 256
				if (offending_line[idx - 1] == '\t') {
					stderr.printf ("\t");
				} else {
					stderr.printf (" ");
				}
			}

Florian Brosch's avatar
Florian Brosch committed
257
			stderr.puts (caret_color_start);
258
			for (idx = source.begin.column; idx <= source.end.column; ++idx) {
259 260 261 262 263 264
				if (offending_line[idx - 1] == '\t') {
					stderr.printf ("\t");
				} else {
					stderr.printf ("^");
				}
			}
Florian Brosch's avatar
Florian Brosch committed
265
			stderr.puts (caret_color_end);
266 267 268 269 270

			stderr.printf ("\n");
		}
	}

Florian Brosch's avatar
Florian Brosch committed
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
	private void print_highlighted_message (string message) {
		int start = 0;
		int cur = 0;

		while (message[cur] != '\0') {
			if (message[cur] == '\'' || message[cur] == '`') {
				unowned string end_chars = (message[cur] == '`')? "`'" : "'";
				stderr.puts (message.substring (start, cur - start));
				start = cur;
				cur++;

				while (message[cur] != '\0' && end_chars.index_of_char (message[cur]) < 0) {
					cur++;
				}
				if (message[cur] == '\0') {
					stderr.puts (message.substring (start, cur - start));
					start = cur;
				} else {
					cur++;
					stderr.printf ("%s%s%s", quote_color_start, message.substring (start, cur - start), quote_color_end);
					start = cur;
				}
			} else {
				cur++;
			}
		}

		stderr.puts (message.offset (start));
	}

	private void print_message (SourceReference? source, string type, string type_color_start, string type_color_end, string message, bool do_report_source) {
		if (source != null) {
			stderr.printf ("%s%s:%s ", locus_color_start, source.to_string (), locus_color_end);
		}

		stderr.printf ("%s%s:%s ", type_color_start, type, type_color_end);

		// highlight '', `', ``
		print_highlighted_message (message);
		stderr.putc ('\n');

		if (do_report_source && source != null) {
			report_source (source);
		}
	}

317 318 319 320 321 322 323 324 325 326 327
	/**
	 * Reports the specified message as note.
	 *
	 * @param source  reference to source code
	 * @param message note message
	 */
	public virtual void note (SourceReference? source, string message) {
		if (!enable_warnings) {
			return;
		}

Florian Brosch's avatar
Florian Brosch committed
328
		print_message (source, "note", note_color_start, note_color_end, message, verbose_errors);
329 330
	}

331 332 333 334 335 336 337 338 339 340 341 342
	/**
	 * Reports the specified message as deprecation warning.
	 *
	 * @param source  reference to source code
	 * @param message warning message
	 */
	public virtual void depr (SourceReference? source, string message) {
		if (!enable_warnings) {
			return;
		}

		warnings++;
Florian Brosch's avatar
Florian Brosch committed
343 344

		print_message (source, "warning", warning_color_start, warning_color_end, message, false);
345 346
	}

347 348 349 350 351 352
	/**
	 * Reports the specified message as warning.
	 *
	 * @param source  reference to source code
	 * @param message warning message
	 */
353
	public virtual void warn (SourceReference? source, string message) {
354 355 356 357
		if (!enable_warnings) {
			return;
		}

358
		warnings++;
Florian Brosch's avatar
Florian Brosch committed
359 360

		print_message (source, "warning", warning_color_start, warning_color_end, message, verbose_errors);
361
	}
Florian Brosch's avatar
Florian Brosch committed
362

363 364 365 366 367 368
	/**
	 * Reports the specified message as error.
	 *
	 * @param source  reference to source code
	 * @param message error message
	 */
369
	public virtual void err (SourceReference? source, string message) {
370
		errors++;
Florian Brosch's avatar
Florian Brosch committed
371 372

		print_message (source, "error", error_color_start, error_color_end, message, verbose_errors);
373
	}
374 375

	/* Convenience methods calling warn and err on correct instance */
376 377 378
	public static void notice (SourceReference? source, string message) {
		CodeContext.get ().report.note (source, message);
	}
379 380 381
	public static void deprecated (SourceReference? source, string message) {
		CodeContext.get ().report.depr (source, message);
	}
382 383 384
	public static void experimental (SourceReference? source, string message) {
		CodeContext.get ().report.depr (source, message);
	}
385 386 387 388 389 390
	public static void warning (SourceReference? source, string message) {
		CodeContext.get ().report.warn (source, message);
	}
	public static void error (SourceReference? source, string message) {
		CodeContext.get ().report.err (source, message);
	}
Florian Brosch's avatar
Florian Brosch committed
391 392 393 394 395 396


	[CCode (has_target = false)]
	private delegate int AttyFunc (int fd);

	private bool is_atty (int fd) {
397
		Module module = Module.open (null, ModuleFlags.BIND_LAZY);
Florian Brosch's avatar
Florian Brosch committed
398 399 400 401 402 403 404 405 406 407 408 409 410
		if (module == null) {
			return false;
		}

		void* _func;
		module.symbol ("isatty", out _func);
		if (_func == null) {
			return false;
		}

		AttyFunc? func = (AttyFunc) _func;
		return func (fd) == 1;
	}
411
}