# The MIT License (MIT)
#
# Copyright (c) 2019 Scott Shawcroft for Adafruit Industries
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""
`string`
====================================================

This module provides string characteristics.

"""

from . import Attribute
from . import Characteristic

__version__ = "6.0.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BLE.git"

class StringCharacteristic(Characteristic):
    """UTF-8 Encoded string characteristic."""
    def __init__(self, *, uuid=None, properties=Characteristic.READ,
                 read_perm=Attribute.OPEN, write_perm=Attribute.OPEN,
                 initial_value=None):
        super().__init__(uuid=uuid, properties=properties,
                         read_perm=read_perm, write_perm=write_perm,
                         max_length=510,  # shorter than 512 due to fixed_length==False
                         fixed_length=False,
                         initial_value=initial_value)

    def __get__(self, obj, cls=None):
        return str(super().__get__(obj, cls), "utf-8")

    def __set__(self, obj, value):
        super().__set__(obj, value.encode("utf-8"))

class FixedStringCharacteristic(Characteristic):
    """Fixed strings are set once when bound and unchanged after."""
    def __init__(self, *, uuid=None, read_perm=Attribute.OPEN):
        super().__init__(uuid=uuid, properties=Characteristic.READ,
                         read_perm=read_perm, write_perm=Attribute.NO_ACCESS,
                         fixed_length=True)

    def __get__(self, obj, cls=None):
        return str(super().__get__(obj, cls), "utf-8")
