#

# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

# All rights reserved.

# This component and the accompanying materials are made available

# under the terms of "Eclipse Public License v1.0"

# which accompanies this distribution, and is available

# at the URL "http://www.eclipse.org/legal/epl-v10.html".

#

# Initial Contributors:

# Nokia Corporation - initial contribution.

#

# Contributors:

#

# Description: 

#

"""

Base class for Confml elements.

Attributes:

 All Confml element attributes become attributes of this instance.

"""

import types

import sys

import re

from cone.public import api, exceptions, container, utils

class ConfmlElement(api.Base):

    def __init__(self, ref="", **kwargs):

        super(ConfmlElement,self).__init__(ref, **kwargs)

        self.lineno = None

    def _get_mapper(self,modelname):

        """

        Return a instance of appropriate mapper for given model.

        """

        mapmodule = __import__('cone.confml.mapping')

        return mapmodule.confml.mapping.MAPPERS[modelname]()

    def get_desc(self): 

        try:

            desc = getattr(self,ConfmlDescription.refname)

            return desc.text

        except AttributeError:

            return None

    def set_desc(self,value): 

        self._add(ConfmlDescription(value))

    def del_desc(self): 

        try:

            self._remove(ConfmlDescription.refname)

        except exceptions.NotFound:

            pass

    """ The description as a property """

    desc = property(get_desc,set_desc,del_desc)

class ConfmlData(api.Data):

    """

    The data element can contain any data setting for a feature. The data element can be 

    a value definition for any type of data. It basically just links some data to a feature. 

    The default Data attribute is 'data', but it can be any string. For example current use case 

    is 'rfs'.

    """

    def __init__(self, **kwargs):

        super(ConfmlData,self).__init__(**kwargs)

        self.lineno = None

class ConfmlConfiguration(ConfmlElement, api.Configuration):

    """

    Confml configuration class. 

    """

    def __init__(self,ref="", **kwargs):

        super(ConfmlConfiguration,self).__init__(ref, **kwargs)

        if kwargs.get('meta'):

            self.meta = kwargs.get('meta')

        if kwargs.get('desc'):

            self.desc = kwargs.get('desc')

    def _view_class(self):

        return ConfmlView

    def _feature_class(self):

        return ConfmlFeature

    def _configuration_class(self):

        return ConfmlConfiguration

    def get_desc(self): 

        """

        @return: The description of the Configuration.

        """

        try:

            desc = getattr(self,ConfmlDescription.refname)

            return desc.text

        except AttributeError:

            return None

    def set_desc(self,value): 

        self._add(ConfmlDescription(value))

    def del_desc(self): 

        try:

            self._remove(ConfmlDescription.refname)

        except exceptions.NotFound:

            pass

    """ The description as a property """

    desc = property(get_desc,set_desc,del_desc)

    def get_meta(self): 

        """

        @return: The meta element of the Configuration.

        """

        try:

            meta = getattr(self,ConfmlMeta.refname)

            return meta

        except AttributeError:

            return None

    def set_meta(self,value): 

        self._add(ConfmlMeta(value))

    def del_meta(self): 

        try:

            self._remove(ConfmlMeta.refname)

        except exceptions.NotFound:

            pass

    """ The meta element as a property """

    meta = property(get_meta,set_meta,del_meta)

class ConfmlSettingAttributes(ConfmlElement):

    """

    Abstract base class for setting attributes. This is used as 

    a base in actual ConfmlSetting and ConfmlFeatureLink.

    """

    def __init__(self, ref,**kwargs):

        super(ConfmlSettingAttributes,self).__init__(ref,**kwargs)

        if kwargs.get('desc'):

            self.desc = kwargs.get('desc')

        if kwargs.get('minOccurs'):

            self.minOccurs = kwargs.get('minOccurs')

        if kwargs.get('maxOccurs'):

            self.maxOccurs = kwargs.get('maxOccurs')

        if kwargs.get('maxLength'):

            self.maxLength = kwargs.get('maxLength')

        if kwargs.get('minLength'):

            self.minLength = kwargs.get('minLength')

        self.mapKey = kwargs.get('mapKey')

        self.mapValue = kwargs.get('mapValue')

        self.displayName = kwargs.get('displayName')

        self.readOnly = kwargs.get('readOnly',None)

        self.constraint = kwargs.get('constraint',None)

        self.required = kwargs.get('required',None)

        self.relevant = kwargs.get('relevant',None)

    def get_valueset(self):

        """

        Get the ValueSet object for this feature, that has the list of available values.

        """

        return api.ValueRe('.*')

    def get_maxlength(self): 

        try:

            return getattr(self,ConfmlMaxLength.refname).value

        except AttributeError:

            return None

    def set_maxlength(self,value): 

        self._add(ConfmlMaxLength(value))

    def del_maxlength(self): 

        try:

            self._remove(ConfmlMaxLength.refname)

        except exceptions.NotFound:

            pass

    """ The maxLength as a property """

    maxLength = property(get_maxlength,set_maxlength,del_maxlength)

    def get_minlength(self): 

        try:

            return getattr(self,ConfmlMinLength.refname).value

        except AttributeError:

            return None

    def set_minlength(self,value): 

        self._add(ConfmlMinLength(value))

    def del_minlength(self): 

        try:

            self._remove(ConfmlMinLength.refname)

        except exceptions.NotFound:

            pass

    """ The minLength as a property """

    minLength = property(get_minlength,set_minlength,del_minlength)

    def get_length(self): 

        try:

            return getattr(self,ConfmlLength.refname).value

        except AttributeError:

            return None

    def set_length(self,value): 

        self._add(ConfmlLength(value))

    def del_length(self): 

        try:

            self._remove(ConfmlLength.refname)

        except exceptions.NotFound:

            pass

    """ The length as a property """

    length = property(get_length,set_length,del_length)

    def get_minInclusive(self): 

        try:

            return getattr(self,ConfmlMinInclusive.refname).value

        except AttributeError:

            return None

    def set_minInclusive(self,value): 

        self._add(ConfmlMinInclusive(value))

    def del_minInclusive(self): 

        try:

            self._remove(ConfmlMinInclusive.refname)

        except exceptions.NotFound:

            pass     

    """ The minInclusive as a property """

    minInclusive = property(get_minInclusive,set_minInclusive,del_minInclusive)

    def get_maxInclusive(self): 

        try:

            return getattr(self,ConfmlMaxInclusive.refname).value

        except AttributeError:

            return None

    def set_maxInclusive(self,value): 

        self._add(ConfmlMaxInclusive(value))

    def del_maxInclusive(self): 

        try:

            self._remove(ConfmlMaxInclusive.refname)

        except exceptions.NotFound:

            pass     

    """ The minInclusive as a property """

    maxInclusive = property(get_maxInclusive,set_maxInclusive,del_maxInclusive)

    def get_minExclusive(self): 

        try:

            return getattr(self,ConfmlMinExclusive.refname).value

        except AttributeError:

            return None

    def set_minExclusive(self,value): 

        self._add(ConfmlMinExclusive(value))

    def del_minExclusive(self): 

        try:

            self._remove(ConfmlMinExclusive.refname)

        except exceptions.NotFound:

            pass     

    """ The minExclusive as a property """

    minExclusive = property(get_minExclusive,set_minExclusive,del_minExclusive)

    def get_maxExclusive(self): 

        try:

            return getattr(self,ConfmlMaxExclusive.refname).value

        except AttributeError:

            return None

    def set_maxExclusive(self,value): 

        self._add(ConfmlMaxExclusive(value))

    def del_maxExclusive(self): 

        try:

            self._remove(ConfmlMaxExclusive.refname)

        except exceptions.NotFound:

            pass     

    """ The maxExclusive as a property """

    maxExclusive = property(get_maxExclusive,set_maxExclusive,del_maxExclusive)

    def get_pattern(self): 

        try:

            return getattr(self,ConfmlPattern.refname).value

        except AttributeError:

            return None

    def set_pattern(self,value): 

        self._add(ConfmlPattern(value))

    def del_pattern(self): 

        try:

            self._remove(ConfmlPattern.refname)

        except exceptions.NotFound:

            pass     

    """ The pattern as a property """

    pattern = property(get_pattern,set_pattern,del_pattern)

    def get_totalDigits(self): 

        try:

            return getattr(self,ConfmlTotalDigits.refname).value

        except AttributeError:

            return None

    def set_totalDigits(self,value): 

        self._add(ConfmlTotalDigits(value))

    def del_totalDigits(self): 

        try:

            self._remove(ConfmlTotalDigits.refname)

        except exceptions.NotFound:

            pass     

    """ The totalDigits as a property """

    totalDigits = property(get_totalDigits,set_totalDigits,del_totalDigits)

    @property

    def options(self):

        optdict = {}

        for opt in self._objects(type=api.Option):

            optdict[opt.value] = opt

        return  optdict

    @property

    def properties(self):

        propdict = {}

        for prop in self._objects(type=api.Property):

            propdict[prop.name] = prop

        return  propdict

    def get_rfs(self):

        return super(ConfmlSettingAttributes,self).get_value('rfs')

    def set_rfs(self, value):

        super(ConfmlSettingAttributes,self).set_value('rfs',value)

    def del_rfs(self):

        super(ConfmlSettingAttributes,self).del_value('rfs')

    rfs = property(get_rfs,set_rfs,del_rfs)

class ConfmlGroup(ConfmlElement, api.Group):

    """

    Confml view.

    """

    def __init__(self, ref="", **kwargs):

        super(ConfmlGroup,self).__init__(ref,**kwargs)

        if kwargs.get('icon'):

            self.icon = kwargs.get('icon')

        if kwargs.get('desc'):

            self.desc = kwargs.get('desc')

    def _group_class(self):

        return ConfmlGroup

    def _featurelink_class(self):

        return ConfmlFeatureLink

    def get_icon(self): 

        try:

            icon = getattr(self,ConfmlIcon.refname)

            return icon.href

        except AttributeError:

            return None

    def set_icon(self,value): self._add(ConfmlIcon(value))

    def del_icon(self): 

        try:

            self._remove(ConfmlIcon.refname)

        except exceptions.NotFound:

            pass

    """ The icon as a property """

    icon = property(get_icon,set_icon,del_icon)

    def get_desc(self): 

        try:

            desc = getattr(self,ConfmlDescription.refname)

            return desc.text

        except AttributeError:

            return None

    def set_desc(self,value): self._add(ConfmlDescription(value))

    def del_desc(self): 

        try:

            self._remove(ConfmlDescription.refname)

        except exceptions.NotFound:

            pass

    """ The description as a property """

    desc = property(get_desc,set_desc,del_desc)

class ConfmlView(api.View, ConfmlGroup):

    """

    Confml view.

    """

    def __init__(self, ref="", **kwargs):

        super(ConfmlView,self).__init__(ref,**kwargs)

        if kwargs.get('desc'):

            self.desc = kwargs.get('desc')

    def get_desc(self): 

        try:

            desc = getattr(self,ConfmlDescription.refname)

            return desc.text

        except AttributeError:

            return None

    def set_desc(self,value): self._add(ConfmlDescription(value))

    def del_desc(self): 

        try:

            self._remove(ConfmlDescription.refname)

        except exceptions.NotFound:

            pass

    """ The description as a property """

    desc = property(get_desc,set_desc,del_desc)

class ConfmlFeature(ConfmlElement, api.Feature):

    def _feature_class(self):

        return ConfmlSetting

class ConfmlSetting(ConfmlSettingAttributes, api.Feature):

    """

    Confml setting class. Attribute 'options' contains options of this setting.

    """

    supported_types = ['int',

                       'string',

                       'boolean',

                       'selection']

    def __init__(self, ref,**kwargs):

        super(ConfmlSetting,self).__init__(ref,**kwargs)

        self.type = kwargs.get('type',None)

    def get_value_cast(self, value, attr=None):

        """

        A function to perform the value type casting in get operation  

        @param value: the value to cast 

        @param attr: the attribute which is fetched from model (normally in confml either None='data' or 'rfs')

        """

        if not attr or attr == 'data':

            return self.get_data_cast(value)

        elif attr == 'rfs':

            return self.get_rfs_cast(value)

        else:

            return value

    def set_value_cast(self, value, attr=None):

        """

        A function to perform the value type casting in the set operation  

        @param value: the value to cast 

        @param attr: the attribute which is fetched from model (normally in confml either None='data' or 'rfs')

        """

        # Add a exception case for None value, because the data casting will always fail for it

        if value == None:

            return value

        if not attr or attr == 'data':

            return self.set_data_cast(value)

        elif attr == 'rfs':

            return self.set_rfs_cast(value)

        else:

            return value

    def get_data_cast(self, value):

        """

        A function to perform the data type casting in get operation  

        @param value: the value to cast 

        """

        return value

    def set_data_cast(self, value):

        """

        A function to perform the data type casting in the set operation  

        @param value: the value to cast 

        """

        return value

    def get_rfs_cast(self, value):

        """

        A function to perform the rfs type casting in get operation  

        @param value: the value to cast 

        """

        if value == 'true':

            return True

        elif value == 'false':

            return False

        else: # otherwise this is an invalid rfs value. Should it report an error?

            return value