error_messages.py

"""Error messages"""
from __future__ import annotations

import os
import signal
import sys
import traceback
from types import TracebackType
from typing import TYPE_CHECKING, NoReturn

from PyQt6 import QtCore, QtWidgets

from utils import FROZEN, GITHUB_REPOSITORY

if TYPE_CHECKING:
    from AutoSplit import AutoSplit


def __exit_program():
    # stop main thread (which is probably blocked reading input) via an interrupt signal
    os.kill(os.getpid(), signal.SIGINT)
    sys.exit(1)


def set_text_message(message: str, details: str = "", kill_button: str = "", accept_button: str = ""):
    message_box = QtWidgets.QMessageBox()
    message_box.setWindowTitle("Error")
    message_box.setTextFormat(QtCore.Qt.TextFormat.RichText)
    message_box.setText(message)
    # Button order is important for default focus
    if accept_button:
        message_box.addButton(accept_button, QtWidgets.QMessageBox.ButtonRole.AcceptRole)
    if kill_button:
        force_quit_button = message_box.addButton(kill_button, QtWidgets.QMessageBox.ButtonRole.ResetRole)
        force_quit_button.clicked.connect(__exit_program)
    if details:
        message_box.setDetailedText(details)
        # Preopen the details
        for button in message_box.buttons():
            if message_box.buttonRole(button) == QtWidgets.QMessageBox.ButtonRole.ActionRole:
                button.click()
                break
    message_box.exec()


def split_image_directory():
    set_text_message("No split image folder is selected.")


def split_image_directory_not_found():
    set_text_message("The Split Image Folder does not exist.")


def split_image_directory_empty():
    set_text_message("The Split Image Folder is empty.")


def image_type(image: str):
    set_text_message(
        f"{image!r} is not a valid image file, does not exist, "
        + "or the full image file path contains a special character.",
    )


def region():
    set_text_message(
        "No region is selected or the Capture Region window is not open. "
        + "Select a region or load settings while the Capture Region window is open.",
    )


def split_hotkey():
    set_text_message("No split hotkey has been set.")


def pause_hotkey():
    set_text_message(
        "Your split image folder contains an image filename with a pause flag {p}, "
        + "but no pause hotkey is set.",
    )


def align_region_image_type():
    set_text_message("File not a valid image file")


def alignment_not_matched():
    set_text_message("No area in capture region matched reference image. Alignment failed.")


def no_keyword_image(keyword: str):
    set_text_message(f"Your split image folder does not contain an image with the keyword {keyword!r}.")


def multiple_keyword_images(keyword: str):
    set_text_message(f"Only one image with the keyword {keyword!r} is allowed.")


def reset_hotkey():
    set_text_message("Your split image folder contains a reset image, but no reset hotkey is set.")


def old_version_settings_file():
    set_text_message(
        "Old version settings file detected. This version allows settings files in .toml format. Starting from v2.0.",
    )


def invalid_settings():
    set_text_message("Invalid settings file.")


def invalid_hotkey(hotkey_name: str):
    set_text_message(f"Invalid hotkey {hotkey_name!r}")


def no_settings_file_on_open():
    set_text_message(
        "No settings file found. One can be loaded on open if placed in the same folder as the AutoSplit executable.",
    )


def too_many_settings_files_on_open():
    set_text_message(
        "Too many settings files found. "
        + "Only one can be loaded on open if placed in the same folder as the AutoSplit executable.",
    )


def check_for_updates():
    set_text_message("An error occurred while attempting to check for updates. Please check your connection.")


def load_start_image():
    set_text_message(
        "Start Image found, but cannot be loaded unless Start, Reset, and Pause hotkeys are set. "
        + "Please set these hotkeys, and then click the Reload Start Image button.",
    )


def stdin_lost():
    set_text_message("stdin not supported or lost, external control like LiveSplit integration will not work.")


def already_open():
    set_text_message(
        "An instance of AutoSplit is already running.<br/>Are you sure you want to open a another one?",
        "",
        "Don't open",
        "Ignore",
    )


def exception_traceback(exception: BaseException, message: str = ""):
    if not message:
        message = "AutoSplit encountered an unhandled exception and will try to recover, " + \
            f"however, there is no guarantee it will keep working properly. {CREATE_NEW_ISSUE_MESSAGE}"
    set_text_message(
        message,
        "\n".join(traceback.format_exception(None, exception, exception.__traceback__)),
        "Close AutoSplit",
    )


CREATE_NEW_ISSUE_MESSAGE = (
    f"Please create a New Issue at <a href='https://github.com/{GITHUB_REPOSITORY}/issues'>"
    + f"github.com/{GITHUB_REPOSITORY}/issues</a>, describe what happened, "
    + "and copy & paste the entire error message below"
)


def make_excepthook(autosplit: AutoSplit):
    def excepthook(exception_type: type[BaseException], exception: BaseException, _traceback: TracebackType | None):
        # Catch Keyboard Interrupts for a clean close
        if exception_type is KeyboardInterrupt or isinstance(exception, KeyboardInterrupt):
            sys.exit(0)
        # HACK: Can happen when starting the region selector while capturing with WindowsGraphicsCapture
        if (
            exception_type is SystemError
            and str(exception) == "<class 'PyQt6.QtGui.QPaintEvent'> returned a result with an error set"
        ):
            return
        # Whithin LiveSplit excepthook needs to use MainWindow's signals to show errors
        autosplit.show_error_signal.emit(lambda: exception_traceback(exception))
    return excepthook


def handle_top_level_exceptions(exception: Exception) -> NoReturn:
    message = f"AutoSplit encountered an unrecoverable exception and will likely now close. {CREATE_NEW_ISSUE_MESSAGE}"
    # Print error to console if not running in executable
    if FROZEN:
        exception_traceback(exception, message)
    else:
        traceback.print_exception(type(exception), exception, exception.__traceback__)
    sys.exit(1)