mirror of
https://gitlab.gnome.org/jwestman/blueprint-compiler.git
synced 2025-05-04 15:59:08 -04:00
8e4433a487
`blueprint-compiler port` interactively ports a project to blueprint. It will create the subproject wrap file, add it to .gitignore, decompile your GtkBuilder XML files, emit code to copy and paste into your meson.build file, and update POTFILES.in. It can't quite handle all of the features the forward compiler can, so it will skip those files.
134 lines
4.4 KiB
Python
134 lines
4.4 KiB
Python
# errors.py
|
|
#
|
|
# Copyright 2021 James Westman <james@jwestman.net>
|
|
#
|
|
# This file 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 version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# This file 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 program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
# SPDX-License-Identifier: LGPL-3.0-or-later
|
|
|
|
from dataclasses import dataclass
|
|
import typing as T
|
|
import sys, traceback
|
|
from . import utils
|
|
from .utils import Colors
|
|
|
|
class PrintableError(Exception):
|
|
""" Parent class for errors that can be pretty-printed for the user, e.g.
|
|
compilation warnings and errors. """
|
|
|
|
def pretty_print(self, filename, code):
|
|
raise NotImplementedError()
|
|
|
|
|
|
class CompileError(PrintableError):
|
|
""" A PrintableError with a start/end position and optional hints """
|
|
|
|
category = "error"
|
|
|
|
def __init__(self, message, start=None, end=None, did_you_mean=None, hints=None, actions=None):
|
|
super().__init__(message)
|
|
|
|
self.message = message
|
|
self.start = start
|
|
self.end = end
|
|
self.hints = hints or []
|
|
self.actions = actions or []
|
|
|
|
if did_you_mean is not None:
|
|
self._did_you_mean(*did_you_mean)
|
|
|
|
def hint(self, hint: str):
|
|
self.hints.append(hint)
|
|
return self
|
|
|
|
|
|
def _did_you_mean(self, word: str, options: T.List[str]):
|
|
if word.replace("_", "-") in options:
|
|
self.hint(f"use '-', not '_': `{word.replace('_', '-')}`")
|
|
return
|
|
|
|
recommend = utils.did_you_mean(word, options)
|
|
if recommend is not None:
|
|
if word.casefold() == recommend.casefold():
|
|
self.hint(f"Did you mean `{recommend}` (note the capitalization)?")
|
|
else:
|
|
self.hint(f"Did you mean `{recommend}`?")
|
|
self.actions.append(CodeAction(f"Change to `{recommend}`", recommend))
|
|
else:
|
|
self.hint("Did you check your spelling?")
|
|
self.hint("Are your dependencies up to date?")
|
|
|
|
def pretty_print(self, filename, code):
|
|
line_num, col_num = utils.idx_to_pos(self.start + 1, code)
|
|
line = code.splitlines(True)[line_num]
|
|
|
|
# Display 1-based line numbers
|
|
line_num += 1
|
|
|
|
print(f"""{Colors.RED}{Colors.BOLD}{self.category}: {self.message}{Colors.CLEAR}
|
|
at {filename} line {line_num} column {col_num}:
|
|
{Colors.FAINT}{line_num :>4} |{Colors.CLEAR}{line.rstrip()}\n {Colors.FAINT}|{" "*(col_num-1)}^{Colors.CLEAR}""")
|
|
|
|
for hint in self.hints:
|
|
print(f"{Colors.FAINT}hint: {hint}{Colors.CLEAR}")
|
|
print()
|
|
|
|
|
|
@dataclass
|
|
class CodeAction:
|
|
title: str
|
|
replace_with: str
|
|
|
|
|
|
class AlreadyCaughtError(Exception):
|
|
""" Emitted when a validation has already failed and its error message
|
|
should not be repeated. """
|
|
|
|
|
|
class MultipleErrors(PrintableError):
|
|
""" If multiple errors occur during compilation, they can be collected into
|
|
a list and re-thrown using the MultipleErrors exception. It will
|
|
pretty-print all of the errors and a count of how many errors there are. """
|
|
|
|
def __init__(self, errors: T.List[CompileError]):
|
|
super().__init__()
|
|
self.errors = errors
|
|
|
|
def pretty_print(self, filename, code) -> None:
|
|
for error in self.errors:
|
|
error.pretty_print(filename, code)
|
|
if len(self.errors) != 1:
|
|
print(f"{len(self.errors)} errors")
|
|
|
|
|
|
class CompilerBugError(Exception):
|
|
""" Emitted on assertion errors """
|
|
|
|
|
|
def assert_true(truth: bool, message:str=None):
|
|
if not truth:
|
|
raise CompilerBugError(message)
|
|
|
|
|
|
def report_bug():
|
|
""" Report an error and ask people to report it. """
|
|
|
|
print(traceback.format_exc())
|
|
print(f"Arguments: {sys.argv}\n")
|
|
print(f"""{Colors.BOLD}{Colors.RED}***** COMPILER BUG *****
|
|
The blueprint-compiler program has crashed. Please report the above stacktrace,
|
|
along with the input file(s) if possible, on GitLab:
|
|
{Colors.BOLD}{Colors.BLUE}{Colors.UNDERLINE}https://gitlab.gnome.org/jwestman/blueprint-compiler/-/issues/new?issue
|
|
{Colors.CLEAR}""")
|
|
|