# -----------------------------------------------------------------------------
# Name:         style.py
# Purpose:      Music21 classes for non-analytic display properties
#
# Authors:      Michael Scott Asato Cuthbert
#
# Copyright:    Copyright © 2016-2022 Michael Scott Asato Cuthbert
# License:      BSD, see license.txt
# -----------------------------------------------------------------------------
'''
The style module represents information about the style of a Note, Accidental,
etc. such that precise positioning information, layout, size, etc. can be specified.
'''
from __future__ import annotations

import typing as t
import unittest

from music21 import common
from music21 import exceptions21
from music21.prebase import ProtoM21Object


if t.TYPE_CHECKING:
    from music21 import editorial


class TextFormatException(exceptions21.Music21Exception):
    pass


class Enclosure(common.StrEnum):
    RECTANGLE = 'rectangle'
    SQUARE = 'square'
    OVAL = 'oval'
    CIRCLE = 'circle'
    BRACKET = 'bracket'
    TRIANGLE = 'triangle'
    DIAMOND = 'diamond'
    PENTAGON = 'pentagon'
    HEXAGON = 'hexagon'
    HEPTAGON = 'heptagon'
    OCTAGON = 'octagon'
    NONAGON = 'nonagon'
    DECAGON = 'decagon'
    INVERTED_BRACKET = 'inverted-bracket'
    NO_ENCLOSURE = 'none'


class Style(ProtoM21Object):
    '''
    A style object is a lightweight object that
    keeps track of information about the look of an object.

    >>> st = style.Style()
    >>> st.units
    'tenths'
    >>> st.absoluteX is None
    True

    >>> st.absoluteX = 20.4
    >>> st.absoluteX
    20.4

    '''
    _DOC_ATTR: dict[str, str] = {
        'hideObjectOnPrint': '''
            If set to `True`, the Music21Object will not print upon output
            (only used in MusicXML output at this point and
            in Lilypond output for notes, chords, and rests).
            ''',
        'units': '''
            What distances are measured in.  The default "tenths" is a concept
            borrowed from MusicXML which refers to 1/10th of the distance between
            two staff lines.  It is currently also the only supported unit.
            ''',
    }

    def __init__(self) -> None:
        self.size = None

        self.relativeX: float|int|None = None
        self.relativeY: float|int|None = None
        self.absoluteX: float|int|None = None

        # managed by property below.
        self._absoluteY: float|int|None = None

        # None means enclosure is left unspecified, NO_ENCLOSURE means
        # explicitly that there is no enclosure.
        self._enclosure: Enclosure|None = None

        # how should this symbol be represented in the font?
        # SMuFL characters are allowed.
        self.fontRepresentation = None

        self.color: str|None = None

        self.units: str = 'tenths'
        self.hideObjectOnPrint: bool = False

        self.dashLength: float|int|None = None
        self.spaceLength: float|int|None = None


    @property
    def enclosure(self) -> Enclosure|None:
        '''
        Get or set the enclosure as a style.Enclosure enum (or
        None, which means the enclosure is left unspecified).

        Valid names are:

        * "rectangle"/style.Enclosure.RECTANGLE,
        * "square"/style.Enclosure.SQUARE,
        * "oval"/style.Enclosure.OVAL,
        * "circle"/style.Enclosure.CIRCLE,
        * "bracket"/style.Enclosure.BRACKET,
        * "inverted-bracket"/style.Enclosure.INVERTED_BRACKET (output in musicxml 4 only)
        * "none"/style.Enclosure.NO_ENCLOSURE
        * None (i.e. enclosure is unspecified)

        or the following other shapes with their ALLCAPS Enclosure equivalents:

        triangle, diamond, pentagon, hexagon, heptagon, octagon,
        nonagon, or decagon.

        >>> tst = style.TextStyle()
        >>> tst.enclosure = None
        >>> tst.enclosure = style.Enclosure.RECTANGLE
        >>> tst.enclosure
        <Enclosure.RECTANGLE>

        Setting as a string is still supported, but is converted to
        an enum.

        >>> tst.enclosure = 'octagon'
        >>> tst.enclosure
        <Enclosure.OCTAGON>

        Setting an invalid enclosure raises a TextFormatException

        >>> tst.enclosure = 'parabola'
        Traceback (most recent call last):
        music21.style.TextFormatException:
            Not a supported enclosure: 'parabola'

        OMIT_FROM_DOCS

        Similarly for non-strings:

        >>> tst.enclosure = 4
        Traceback (most recent call last):
        music21.style.TextFormatException:
            Not a supported enclosure: 4

        * Changed in v9.7: We now differentiate between no enclosure
          (Enclosure.NO_ENCLOSURE) and unspecified enclosure (None).
        '''
        return self._enclosure

    @enclosure.setter
    def enclosure(self, value: Enclosure|str|None):
        if value is None:
            self._enclosure = value
        elif isinstance(value, Enclosure):
            self._enclosure = value
        elif isinstance(value, str):
            try:
                enc_value = Enclosure(value.lower())
            except ValueError as ve:
                raise TextFormatException(f'Not a supported enclosure: {value!r}') from ve

            self._enclosure = enc_value

        else:
            raise TextFormatException(f'Not a supported enclosure: {value!r}')

    def _getAbsoluteY(self):
        return self._absoluteY

    def _setAbsoluteY(self, value):
        if value is None:
            self._absoluteY = None
        elif value == 'above':  # TODO: convert to Enum and keep it
            self._absoluteY = 10
        elif value == 'below':
            self._absoluteY = -70
        else:
            try:
                self._absoluteY = common.numToIntOrFloat(value)
            except ValueError as ve:
                raise TextFormatException(
                    f'Not a supported absoluteY position: {value!r}'
                ) from ve

    absoluteY = property(_getAbsoluteY,
                         _setAbsoluteY,
                         doc='''
        Get or set the vertical position, where 0
        is the top line of the staff and units
        are whatever is defined in `.units`, generally "tenths", meaning
        1/10th of a staff space.

        Other legal positions are 'above' and 'below' which
        are synonyms for 10 and -70 respectively (for 5-line
        staves; other staves are not yet implemented)
        This behavior may change in music21 v8 or after.

        >>> te = style.Style()
        >>> te.absoluteY = 10
        >>> te.absoluteY
        10

        >>> te.absoluteY = 'below'
        >>> te.absoluteY
        -70

        Setting an invalid position raises a TextFormatException

        >>> te.absoluteY = 'hello'
        Traceback (most recent call last):
        music21.style.TextFormatException:
            Not a supported absoluteY position: 'hello'
        ''')


class NoteStyle(Style):
    '''
    A Style object that also includes stem and accidental style information.

    Beam style is stored on the Beams object.  Lyric style is stored on the Lyric
    object.
    '''
    _DOC_ATTR: dict[str, str] = {
        'stemStyle': '''
            An optional style.Style object describing what the stem looks like.

            >>> n = note.Note()
            >>> n.style.stemStyle is None
            True

            Note that stemStyle is not created automatically.  Users must
            instantiate a :class:`~music21.style.Style` object.

            >>> n.style.stemStyle = style.Style()
            >>> n.style.stemStyle.color = 'red'
            ''',
        'accidentalStyle': '''
            An optional style.Style object describing what the accidental looks like.

            >>> n = note.Note()
            >>> n.style.accidentalStyle is None
            True

            Note that accidentalStyle is not created automatically.  Users must
            instantiate a :class:`~music21.style.Style` object.

            >>> n.style.accidentalStyle = style.Style()
            >>> n.style.accidentalStyle.relativeX = -2.0

            Note: do not use .hideObjectOnPrint in accidentalStyle to hide the
            accidental.  Set the displayType on the Accidental itself.

            This object may eventually move to Note.pitch.accidental.style.
            ''',
        'noteSize': '''
            An optional string representing the size of the note as a type of note.

            Valid values are None (=normal), `'cue'`, `'grace'`, `'graceCue'`, and `'large'`
            (taken from MusicXML, with "graceCue" replacing "grace-cue").
            ''',
    }

    def __init__(self) -> None:
        super().__init__()
        self.stemStyle: Style|None = None
        self.accidentalStyle: Style|None = None
        self.noteSize: str|None = None  # can be 'cue' etc.


class TextStyle(Style):
    '''
    A Style object that also includes text formatting.

    >>> ts = style.TextStyle()
    >>> ts.classes
    ('TextStyle', 'Style', 'ProtoM21Object', 'object')
    '''

    def __init__(self):
        super().__init__()
        self._fontFamily = None
        self._fontSize = None
        self._fontStyle = None
        self._fontWeight = None
        self._letterSpacing = None

        self.lineHeight = None
        self.textDirection = None
        self.textRotation = None
        self.language = None
        # this might be a complex device -- underline, overline, line-through etc.
        self.textDecoration = None

        self._justify = None
        self._alignHorizontal = None
        self._alignVertical = None

    def _getAlignVertical(self):
        return self._alignVertical

    def _setAlignVertical(self, value):
        # TODO: convert to StrEnum
        if value in (None, 'top', 'middle', 'bottom', 'baseline'):
            self._alignVertical = value
        else:
            raise TextFormatException(f'Invalid vertical align: {value!r}')

    alignVertical = property(_getAlignVertical,
                             _setAlignVertical,
                             doc='''
        Get or set the vertical align. Valid values are top, middle, bottom, baseline
        or None

        >>> te = style.TextStyle()
        >>> te.alignVertical = 'top'
        >>> te.alignVertical
        'top'

        Invalid vertical aligns raise a TextFormatException:

        >>> te.alignVertical = 'hello'
        Traceback (most recent call last):
        music21.style.TextFormatException:
            Invalid vertical align: 'hello'
        ''')

    def _getAlignHorizontal(self):
        return self._alignHorizontal

    def _setAlignHorizontal(self, value):
        if value in (None, 'left', 'right', 'center'):
            self._alignHorizontal = value
        else:
            raise TextFormatException(f'Invalid horizontal align: {value!r}')

    alignHorizontal = property(_getAlignHorizontal,
                               _setAlignHorizontal,
                               doc='''
        Get or set the horizontal alignment.  Valid values are left, right, center,
        or None

        >>> te = style.TextStyle()
        >>> te.alignHorizontal = 'right'
        >>> te.alignHorizontal
        'right'

        Invalid horizontal aligns raise a TextFormatException:

        >>> te.alignHorizontal = 'hello'
        Traceback (most recent call last):
        music21.style.TextFormatException:
            Invalid horizontal align: 'hello'
        ''')


    @property
    def justify(self) -> str|None:
        '''
        Get or set the justification.  Valid values are left,
        center, right, full (not supported by MusicXML), and None

        >>> tst = style.TextStyle()
        >>> tst.justify = 'center'
        >>> tst.justify
        'center'

        Invalid values raise a TextFormatException

        >>> tst.justify = 'hello'
        Traceback (most recent call last):
        music21.style.TextFormatException:
            Not a supported justification: 'hello'
        '''
        return self._justify

    @justify.setter
    def justify(self, value: str|None):
        if value is None:
            self._justify = None
        else:
            if value.lower() not in ('left', 'center', 'right', 'full'):
                raise TextFormatException(f'Not a supported justification: {value!r}')
            self._justify = value.lower()

    @property
    def fontStyle(self) -> str|None:
        '''
        Get or set the style, as normal, italic, bold, and bolditalic.
        None is currently an acceptable value which should be "normal".

        >>> tst = style.TextStyle()
        >>> tst.fontStyle = 'bold'
        >>> tst.fontStyle
        'bold'

        Invalid values raise a TextFormatException

        >>> tst.fontStyle = 'hello'
        Traceback (most recent call last):
        music21.style.TextFormatException:
            Not a supported fontStyle: 'hello'
        '''
        return self._fontStyle

    @fontStyle.setter
    def fontStyle(self, value: str|None) -> None:
        if value is None:
            self._fontStyle = None
        else:
            if value.lower() not in ('italic', 'normal', 'bold', 'bolditalic'):
                raise TextFormatException(f'Not a supported fontStyle: {value!r}')
            self._fontStyle = value.lower()

    def _getWeight(self):
        return self._fontWeight

    def _setWeight(self, value):
        if value is None:
            self._fontWeight = None
        else:
            if value.lower() not in ('normal', 'bold'):
                raise TextFormatException(f'Not a supported fontWeight: {value}')
            self._fontWeight = value.lower()

    # TODO: figure out if we want to use fontStyle for all weights.

    fontWeight = property(_getWeight,
                          _setWeight,
                          doc='''
        Get or set the weight, as normal, or bold.

        >>> tst = style.TextStyle()
        >>> tst.fontWeight = 'bold'
        >>> tst.fontWeight
        'bold'
        ''')

    def _getSize(self):
        return self._fontSize

    def _setSize(self, value):
        if value is not None:
            try:
                value = common.numToIntOrFloat(value)
            except ValueError:
                pass  # MusicXML font sizes can be CSS strings.
                # raise TextFormatException(f'Not a supported size: {value}')
        self._fontSize = value

    fontSize = property(_getSize,
                        _setSize,
                        doc='''
        Get or set the size.  Best, an int or float, but also a css font size

        >>> tst = style.TextStyle()
        >>> tst.fontSize = 20
        >>> tst.fontSize
        20
        ''')

    def _getLetterSpacing(self):
        return self._letterSpacing

    def _setLetterSpacing(self, value):
        if value != 'normal' and value is not None:
            # convert to number
            try:
                value = float(value)
            except ValueError as ve:
                raise TextFormatException(
                    f'Not a supported letterSpacing: {value!r}'
                ) from ve

        self._letterSpacing = value

    letterSpacing = property(_getLetterSpacing,
                             _setLetterSpacing,
                             doc='''
         Get or set the letter spacing.

        >>> tst = style.TextStyle()
        >>> tst.letterSpacing = 20
        >>> tst.letterSpacing
        20.0
        >>> tst.letterSpacing = 'normal'
        ''')

    @property
    def fontFamily(self):
        '''
        Returns a list of font family names associated with
        the style, or sets the font family name list.

        If a single string is passed then it is converted to
        a list.

        >>> ts = style.TextStyle()
        >>> ff = ts.fontFamily
        >>> ff
        []
        >>> ff.append('Times')
        >>> ts.fontFamily
        ['Times']
        >>> ts.fontFamily.append('Garamond')
        >>> ts.fontFamily
        ['Times', 'Garamond']
        >>> ts.fontFamily = 'Helvetica, sans-serif'
        >>> ts.fontFamily
        ['Helvetica', 'sans-serif']
        '''
        if self._fontFamily is None:
            self._fontFamily = []
        return self._fontFamily

    @fontFamily.setter
    def fontFamily(self, newFamily):
        if common.isIterable(newFamily):
            self._fontFamily = newFamily
        else:
            self._fontFamily = [f.strip() for f in newFamily.split(',')]


class TextStylePlacement(TextStyle):
    '''
    TextStyle plus a placement attribute
    '''

    def __init__(self):
        super().__init__()
        self.placement = None


class BezierStyle(Style):
    '''
    From the MusicXML Definition.
    '''

    def __init__(self):
        super().__init__()

        self.bezierOffset = None
        self.bezierOffset2 = None

        self.bezierX = None
        self.bezierY = None
        self.bezierX2 = None
        self.bezierY2 = None


class LineStyle(Style):
    '''
    from the MusicXML Definition

    Defines lineShape ('straight', 'curved' or None)
    lineType ('solid', 'dashed', 'dotted', 'wavy' or None)
    dashLength (in tenths)
    spaceLength (in tenths)
    '''

    def __init__(self):
        super().__init__()

        self.lineShape = None
        self.lineType = None
        self.dashLength = None
        self.spaceLength = None


class StreamStyle(Style):
    '''
    Includes several elements in the MusicXML <appearance> tag in <defaults>
    along with <music-font> and <word-font>
    '''

    def __init__(self):
        super().__init__()
        self.lineWidths = []  # two-tuples of type, width measured in tenths
        self.noteSizes = []  # two-tuples of type and percentages of the normal size
        self.distances = []  # two-tuples of beam or hyphen and tenths
        self.otherAppearances = []  # two-tuples of type and tenths
        self.musicFont = None  # None or a TextStyle object
        self.wordFont = None  # None or a TextStyle object
        self.lyricFonts = []  # a list of TextStyle objects
        self.lyricLanguages = []  # a list of strings

        self.printPartName = True
        self.printPartAbbreviation = True

        # can be None -- meaning no comment,
        # 'none', 'measure', or 'system'...
        self.measureNumbering = None
        self.measureNumberStyle = None


class BeamStyle(Style):
    '''
    Style for beams
    '''

    def __init__(self):
        super().__init__()
        self.fan = None


class StyleMixin(common.SlottedObjectMixin):
    '''
    Mixin for any class that wants to support style and editorial, since several
    non-music21 objects, such as Lyrics and Accidentals will support Style.

    Not used by Music21Objects because of the added trouble in copying etc. so
    there is code duplication with base.Music21Object
    '''
    # anytime something is changed here, change in base.Music21Object and vice versa
    _styleClass = Style

    __slots__ = ('_style', '_editorial')

    def __init__(self) -> None:
        # no need to call super().__init__() on SlottedObjectMixin
        # This might be dangerous though
        self._style: Style|None = None
        self._editorial: editorial.Editorial|None = None

    @property
    def hasStyleInformation(self) -> bool:
        '''
        Returns True if there is a :class:`~music21.style.Style` object
        already associated with this object, False otherwise.

        Calling .style on an object will always create a new
        Style object, so even though a new Style object isn't too expensive
        to create, this property helps to prevent creating new Styles more than
        necessary.

        >>> lObj = note.Lyric('hello')
        >>> lObj.hasStyleInformation
        False
        >>> lObj.style
        <music21.style.TextStylePlacement object at 0x10b0a2080>
        >>> lObj.hasStyleInformation
        True
        '''
        if not hasattr(self, '_style'):
            return False
        return self._style is not None

    @property
    def style(self) -> Style:
        '''
        Returns (or Creates and then Returns) the Style object
        associated with this object, or sets a new
        style object.  Different classes might use
        different Style objects because they might have different
        style needs (such as text formatting or bezier positioning)

        Eventually will also query the groups to see if they have
        any styles associated with them.

        >>> acc = pitch.Accidental()
        >>> st = acc.style
        >>> st
        <music21.style.TextStyle object at 0x10ba96208>
        >>> st.absoluteX = 20.0
        >>> st.absoluteX
        20.0
        >>> acc.style = style.TextStyle()
        >>> acc.style.absoluteX is None
        True
        '''
        # anytime something is changed here, change in base.Music21Object and vice versa
        if self._style is None:
            styleClass = self._styleClass
            self._style = styleClass()
        return self._style

    @style.setter
    def style(self, newStyle: Style):
        self._style = newStyle

    @property
    def hasEditorialInformation(self) -> bool:
        '''
        Returns True if there is a :class:`~music21.editorial.Editorial` object
        already associated with this object, False otherwise.

        Calling .style on an object will always create a new
        Style object, so even though a new Style object isn't too expensive
        to create, this property helps to prevent creating new Styles more than
        necessary.

        >>> acc = pitch.Accidental('#')
        >>> acc.hasEditorialInformation
        False
        >>> acc.editorial
        <music21.editorial.Editorial {}>
        >>> acc.hasEditorialInformation
        True
        '''
        return self._editorial is not None

    @property
    def editorial(self) -> editorial.Editorial:
        '''
        a :class:`~music21.editorial.Editorial` object that stores editorial information
        (comments, footnotes, harmonic information, ficta).

        Created automatically as needed:

        >>> acc = pitch.Accidental()
        >>> acc.editorial
        <music21.editorial.Editorial {}>
        >>> acc.editorial.ficta = pitch.Accidental('sharp')
        >>> acc.editorial.ficta
        <music21.pitch.Accidental sharp>
        >>> acc.editorial
        <music21.editorial.Editorial {'ficta': <music21.pitch.Accidental sharp>}>
        '''
        # anytime something is changed here, change in base.Music21Object and vice versa
        from music21 import editorial
        if self._editorial is None:
            self._editorial = editorial.Editorial()
        return self._editorial

    @editorial.setter
    def editorial(self, ed: editorial.Editorial):
        self._editorial = ed


class Test(unittest.TestCase):
    pass


if __name__ == '__main__':
    import music21
    music21.mainTest(Test)  # , runTest='')

