# Copyright (c) 2015, Ecole Polytechnique Federale de Lausanne, Blue Brain Project
# All rights reserved.
#
# This file is part of NeuroM <https://github.com/BlueBrain/NeuroM>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#     1. Redistributions of source code must retain the above copyright
#        notice, this list of conditions and the following disclaimer.
#     2. Redistributions in binary form must reproduce the above copyright
#        notice, this list of conditions and the following disclaimer in the
#        documentation and/or other materials provided with the distribution.
#     3. Neither the name of the copyright holder nor the names of
#        its contributors may be used to endorse or promote products
#        derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

'''Type enumerations'''

from enum import Enum, unique


@unique
class TreeType(Enum):
    '''Enum representing valid tree types'''
    undefined = 1
    soma = 2
    axon = 3
    basal_dendrite = 4
    apical_dendrite = 5
    all = 32


def tree_type_checker(*ref):
    '''Tree type checker functor

    Returns:
        Functor that takes a tree, and returns true if that tree matches any of
        TreeTypes in ref

    Ex:
        >>> from neurom.core.types import TreeType, tree_type_checker
        >>> tree_filter = tree_type_checker(TreeType.axon, TreeType.basal_dendrite)
        >>> nrn.i_neurites(tree.isegment, tree_filter=tree_filter)
    '''
    ref = tuple(ref)
    if TreeType.all in ref:
        def check_tree_type(_):
            '''Always returns true'''
            return True
    else:
        def check_tree_type(tree):
            '''Check whether tree has the same type as ref

            Returns:
                True if ref in the same type as tree.type or ref is TreeType.all
            '''
            return tree.type in ref

    return check_tree_type


NEURITES = (TreeType.all,
            TreeType.axon,
            TreeType.basal_dendrite,
            TreeType.apical_dendrite)


ROOT_ID = -1
