virtual_sq1.py

"""
A Python representation of the Square-1 twisty puzzle.

Classes:
    Square1: A virtual Square-1 object.
        _flip_equator():
            Directly changes the equator state `equator_flipped` of the Square1
            from flipped (True) to not flipped (False) (and vice-versa) without
            affecting other pieces.
        _invert_alg(simplified_alg):
            Inverts the input simplified algorithm `simplified_alg`
            and returns it.
        _error_detected(input_type, errored_input, error_turns, error_turns_i):
            Prints an error message depending on the input type `input_type`.
            If `input_type = 0` or `input_type = 1`: `error_turns` and
            `error_turns_i` are the specifics of where the error occurred
            in `errored_input`.

        slash():
            Does a slice/slash move to the Square1.
        apply_alg(alg, for_case):
            If `for_case = False` (default): Applies an input algorithm `alg`
            to the Square1.
            If `for_case = True`: Changes the Square1's state so that the
            input algorithm `alg` brings it to its current state.
        apply_state(state):
            Changes the Square1's state to match the input state `state`.


    Layer: An arbitrary layer of the Square1.
        _is_sliceable():
            Determines whether or not the Layer can slice/slash at the
            current position and returns True if possible (False otherwise).

        turn(amount):
            Rotates the Layer by an input amount `amount` and returns True
            if successful (False if Layer becomes unsliceable).

Author: Seby Amador
License: GNU GPLv3

This module was highly inspired by the following:
    Tyson Decker's puzzle-gen
        https://tdecker91.github.io/puzzlegen-demo/
    Jaap's Square-1 optimiser
        https://www.jaapsch.net/puzzles/square1.htm#progs


Need help? Visit https://github.com/Wo0fle/virtual-sq1
"""

__version__ = '1.1.0'


class Square1:
    """
    A virtual Square-1 object.

    Need help? Visit https://github.com/Wo0fle/virtual-sq1
    """

    def __init__(self) -> None:
        """Initializes the Square1. Solved by default."""

        self.top = Layer("A1B2C3D4")
        self.equator_flipped = False
        self.bottom = Layer("5E6F7G8H")
        self.error_message = ""

    def __str__(self) -> str:
        """Converts the Square1's state to a string."""

        if self.equator_flipped:
            return f"{self.top}/{self.bottom}"
        else:
            return f"{self.top}-{self.bottom}"

    def _flip_equator(self) -> None:
        """
        Directly changes the equator state `equator_flipped` of the Square1
        from flipped (True) to not flipped (False) (and vice-versa)
        without affecting other pieces.
        """

        self.equator_flipped = not self.equator_flipped

    def _invert_alg(self, simplified_alg: list) -> list:
        """
        Inverts the input simplified algorithm `simplified_alg`.

        Notes:
            An "inversion" in this context refers to manipulating an algorithm
            in such a way that applying the normal algorithm followed by the
            inverted algorithm (or vice-versa) would result in zero net effect
            on the Square-1.
        """

        simplified_alg = simplified_alg[::-1]

        for i in range(len(simplified_alg)):
            for j in range(len(simplified_alg[i])):
                if "-" in simplified_alg[i][j]:
                    simplified_alg[i][j] = simplified_alg[i][j].replace('-', '', 1)
                else:
                    if simplified_alg[i][j] != '0' and simplified_alg[i][j] != '':
                        simplified_alg[i][j] = "-" + simplified_alg[i][j]

        return simplified_alg

    def _error_detected(self, input_type: int, errored_input, error_turns: list = [], error_turns_i: int = 0) -> None:
        """
        Prints an error message depending on the input type `input_type`
        (where 0 is "Case", 1 is "Algorithm", and 2 is "State").

        `errored_input` can be either an errored simplified algorithm
        (for Algorithm or Case) or an errored state (for State).

        For Case and Algorithm:
            `error_turns` is the set of top/bottom layer rotations where the
            error was detected.

            `error_turns_i` is the index of `error_turns` in the simplified
            algorithm `errored_input`.
        """

        if input_type == 0:  # case
            self._invert_alg(errored_input)

            self.error_message = f'Error at "{",".join(error_turns)}" (move #{len(errored_input) - error_turns_i}).\nCheck that your input starts and ends in fully-aligned cubeshape.\nSquare-1 reset to previous state.\n'
        elif input_type == 1:  # alg
            self.error_message = f'Error at "{",".join(error_turns)}" (move #{error_turns_i + 1}).\nSquare-1 reset to previous state.\n'
        elif input_type == 2:  # state
            self.error_message = f'Error with "{"".join(errored_input)}".\nCheck your input isn\'t missing any or contains any extra symbols.\nSquare-1 reset to previous state.\n'
        
        print(self.error_message)

    def slash(self) -> None:  # lol "slice" is taken by Python already
        """Does a slice/slash move to the Square1."""

        value = 0

        for i in range(len(self.top.current_state)):
            if self.top.current_state[i] in "12345678":
                value += 1
            elif self.top.current_state[i] in "ABCDEFGH":
                value += 2

            if value == 6:
                left_side_U = self.top.current_state[:i+1]
                right_side_U = self.top.current_state[i+1:]

        value = 0

        for i in range(len(self.bottom.current_state)):
            if self.bottom.current_state[i] in "12345678":
                value += 1
            elif self.bottom.current_state[i] in "ABCDEFGH":
                value += 2

            if value == 6:
                right_side_D = self.bottom.current_state[:i+1]
                left_side_D = self.bottom.current_state[i+1:]

        self.top = Layer(left_side_U + right_side_D)
        self.bottom = Layer(right_side_U + left_side_D)
        self._flip_equator()

    def apply_alg(self, alg: str, for_case: bool = False) -> None:
        """
        If `for_case = False` (default): Applies an input algorithm `alg`
        to the Square1.

        If `for_case = True`: Changes the Square1's state so that the
        input algorithm `alg` brings it to its current state.

        Resets the Square1 to its previous state if unsuccessful.

        Notes:
            The distinction between a "case" and an "algorithm" was made by
            Tyson Decker's puzzle-gen: https://tdecker91.github.io/puzzlegen-demo/
        """

        initial_top = self.top.current_state
        initial_equator = self.equator_flipped
        initial_bottom = self.bottom.current_state

        simplfied_alg = list(alg)

        for char in alg:
            if not char.isnumeric() and ((char != '/') and (char != ',') and (char != '-')):
                simplfied_alg.remove(char)

        simplfied_alg = [slash.split(',') for slash in (''.join(simplfied_alg)).split('/')]

        if for_case:
            simplfied_alg = self._invert_alg(simplfied_alg)

        legal = True

        for i in range(len(simplfied_alg)):
            try:
                turn_amount = int(simplfied_alg[i][0])

                while abs(turn_amount) > 6:
                    if turn_amount > 0:
                        turn_amount -= 12
                    else:
                        turn_amount += 12

                if not self.top.turn(turn_amount):
                    self.top = Layer(initial_top)
                    self.equator_flipped = initial_equator
                    self.bottom = Layer(initial_bottom)
                    legal = False
                    break
            except ValueError:
                if simplfied_alg[i][0] != '':
                    print('\nSYNTAX ERROR involving "-" detected!')
                    self.top = Layer(initial_top)
                    self.equator_flipped = initial_equator
                    self.bottom = Layer(initial_bottom)
                    legal = False
                    break

            try:
                turn_amount = int(simplfied_alg[i][1])

                while abs(turn_amount) > 6:
                    if turn_amount > 0:
                        turn_amount -= 12
                    else:
                        turn_amount += 12

                if not self.bottom.turn(turn_amount):
                    self.top = Layer(initial_top)
                    self.equator_flipped = initial_equator
                    self.bottom = Layer(initial_bottom)
                    legal = False
                    break
            except ValueError:
                if simplfied_alg[i][1] != '':
                    print('\nSYNTAX ERROR involving "-" detected!')
                    self.top = Layer(initial_top)
                    self.equator_flipped = initial_equator
                    self.bottom = Layer(initial_bottom)
                    legal = False
                    break
            except IndexError:
                pass  # assume 0 for bottom turn if there's only one input

            if len(simplfied_alg[i]) > 2:
                print('\nSYNTAX ERROR involving "," detected!')
                self.top = Layer(initial_top)
                self.equator_flipped = initial_equator
                self.bottom = Layer(initial_bottom)
                legal = False
                break

            self.slash()

        if legal:
            self.slash()
            self.error_message = ""
        else:
            if for_case:
                self._error_detected(0, simplfied_alg, simplfied_alg[i], i)
            else:
                self._error_detected(1, simplfied_alg, simplfied_alg[i], i)

    def apply_state(self, state: str) -> None:
        """
        Changes the Square1's state to match the input state `state`
        (resets the Square1 to its previous state if unsuccessful).

        Notes:
            This module uses (almost) the same position notation as
            Jaap's Square-1 optimiser: https://www.jaapsch.net/puzzles/square1.htm#progs.
        """

        initial_top = self.top.current_state
        initial_equator = self.equator_flipped
        initial_bottom = self.bottom.current_state

        req_pieces = "ABCDEFGH12345678"
        state = [piece for piece in state.upper() if piece != " "]
        state_list = list(state)

        for req_piece in req_pieces:
            if len(state_list) == 0 or req_piece not in state_list:
                print('\nSYNTAX ERROR involving missing pieces detected!')
                self.top = Layer(initial_top)
                self.equator_flipped = initial_equator
                self.bottom = Layer(initial_bottom)
                self._error_detected(2, state)
                break

            if req_piece in state_list:
                state_list.remove(req_piece)

        if len(state_list) > 1:
            print('\nSYNTAX ERROR involving extra/nonexistent pieces detected!')
            self.top = Layer(initial_top)
            self.equator_flipped = initial_equator
            self.bottom = Layer(initial_bottom)
            self._error_detected(2, state)
        else:
            value = 0

            if len(state_list) == 1:
                state_list = list(state)

                if "/" in state:
                    self._flip_equator()
                    state_list = list(state)
                    state_list.remove("/")
                elif "-" in state:
                    state_list = list(state)
                    state_list.remove("-")
            else:
                state_list = list(state)

            for i in range(len(state)):
                if state[i] in "12345678":
                    value += 1
                elif state[i] in "ABCDEFGH":
                    value += 2

                if value == 12:
                    new_top = ''.join(state_list[:i+1])
                    new_bottom = ''.join(state_list[i+1:])

                    self.top = Layer(new_top)
                    self.bottom = Layer(new_bottom)

                    self.error_message = ""

                    break
                elif value > 12:
                    print('\nSYNTAX ERROR involving impossible layer state detected!')
                    self.top = Layer(initial_top)
                    self.equator_flipped = initial_equator
                    self.bottom = Layer(initial_bottom)
                    self._error_detected(2, state)
                    break


class Layer:
    """An arbitrary layer of the Square1."""

    def __init__(self, initial_state: str) -> None:
        """Initializes the Layer. Initial state `initial_state` is input."""

        self.current_state = initial_state

    def __str__(self) -> str:
        """Converts the Layer's state to a string."""

        return str(self.current_state)

    def _is_sliceable(self):
        """
        Determines whether or not the Layer can slice/slash at the current
        position and returns True if possible (returns False otherwise).
        """

        value = 0

        for piece in self.current_state:
            if piece in "12345678":
                value += 1
            elif piece in "ABCDEFGH":
                value += 2

            if value == 6:
                return True
            elif value > 6:
                return False

    def turn(self, amount: int):
        """
        Rotates the Layer by an input amount `amount` and returns True
        (if successful).

        If the rotation leaves the Layer in an unsliceable position, it resets
        the Layer to its previous state and returns False.
        """

        if amount > 0:
            initial_state = self.current_state[::-1]

            for piece in initial_state:
                if piece in "12345678":
                    value = 1
                elif piece in "ABCDEFGH":
                    value = 2

                if amount >= value:
                    amount -= value
                    self.current_state = piece + self.current_state[:-1]
                else:
                    if amount != 0 or not self._is_sliceable():
                        print('\nLOGIC ERROR involving an incomplete turn detected!\n')
                        self.current_state = initial_state[::-1]
                        return False

                    return True
        elif amount < 0:
            amount *= -1
            initial_state = self.current_state

            for piece in initial_state:
                if piece in "12345678":
                    value = 1
                elif piece in "ABCDEFGH":
                    value = 2

                if amount >= value:
                    amount -= value
                    self.current_state = self.current_state[1:] + piece
                else:
                    if amount != 0 or not self._is_sliceable():
                        print('\nLOGIC ERROR involving an incomplete turn detected!\n')
                        self.current_state = initial_state
                        return False

                    return True
        else:
            return True