"""HADDOCK library custom errors."""

from os import linesep

from haddock.core.typing import FilePath

class HaddockError(Exception):
    """Error in HADDOCK3."""

    pass


class ConfigurationError(HaddockError):
    """Error in the configuration file."""

    pass


class ModuleError(HaddockError):
    """Error in a HADDOCK3 module."""

    pass


class StepError(HaddockError):
    """Error in a HADDOCK3 workflow step."""

    pass


class JobRunningError(HaddockError):
    """General job running error."""

    pass


class CNSRunningError(HaddockError):
    """CNS run error."""

    pass

class KnownCNSError(CNSRunningError):
    """Detected CNS output error."""

    def __init__(self, cns_message: str, hint: str, filepath: FilePath):
        self.cns_error = cns_message
        self.hint = hint
        self.filepath = filepath
    
    def __str__(self) -> str:
        """Generate custom string representation of this exception."""
        full_msg = (
            f"A CNS error occured: `{self.cns_error}`.{linesep}"
            f"Here is a hint on how to solve it:{linesep}{self.hint}"
            )
        return full_msg


class HaddockModuleError(HaddockError):
    """General error in a HADDOCK3 module."""

    pass


class ThirdPartyIntallationError(HaddockModuleError):
    """General error when a third party module is not properly installed."""

    pass

class SetupError(HaddockError):
    """Set up error."""

    pass


class HaddockTermination(HaddockError):
    """Terminates HADDOCK."""

    pass