"""Support for simplified access to data on nodes of type omni.graph.action.ForLoop

Executes the a loop body once for each value within a range. When step is positive, the values in the range are determined
by the formula:
 r[i] = start + step*i, i >= 0 & r[i] < stop.
When step is negative the constraint  is instead r[i] > stop.
A step of zero is an error.
 The break input can be used to break out of the loop before the last index.  The finished output
is executed after all iterations are complete, or when the loop was broken
"""

import carb

import omni.graph.core as og
import omni.graph.core._omni_graph_core as _og
import omni.graph.tools.ogn as ogn



class OgnForLoopDatabase(og.Database):
    """Helper class providing simplified access to data on nodes of type omni.graph.action.ForLoop

    Class Members:
        node: Node being evaluated

    Attribute Value Properties:
        Inputs:
            inputs.breakLoop
            inputs.execIn
            inputs.start
            inputs.step
            inputs.stop
        Outputs:
            outputs.finished
            outputs.index
            outputs.loopBody
            outputs.value
        State:
            state.i
    """

    # Imprint the generator and target ABI versions in the file for JIT generation
    GENERATOR_VERSION = (1, 41, 3)
    TARGET_VERSION = (2, 139, 12)

    # This is an internal object that provides per-class storage of a per-node data dictionary
    PER_NODE_DATA = {}

    # This is an internal object that describes unchanging attributes in a generic way
    # The values in this list are in no particular order, as a per-attribute tuple
    #     Name, Type, ExtendedTypeIndex, UiName, Description, Metadata,
    #     Is_Required, DefaultValue, Is_Deprecated, DeprecationMsg
    # You should not need to access any of this data directly, use the defined database interfaces
    INTERFACE = og.Database._get_interface([
        ('inputs:breakLoop', 'execution', 0, 'Break', 'Breaks out of the loop when the loop body traversal reaches it', {}, True, None, False, ''),
        ('inputs:execIn', 'execution', 0, 'In', 'Input execution', {}, True, None, False, ''),
        ('inputs:start', 'int', 0, 'Start', 'The first value in the range', {}, True, 0, False, ''),
        ('inputs:step', 'int', 0, 'Step', 'The step size of the range', {ogn.MetadataKeys.DEFAULT: '1'}, True, 1, False, ''),
        ('inputs:stop', 'int', 0, 'Stop', 'The limiting value of the range', {}, True, 0, False, ''),
        ('outputs:finished', 'execution', 0, None, 'Executed when the loop is finished', {}, True, None, False, ''),
        ('outputs:index', 'int', 0, None, 'The current or last index within the range', {}, True, None, False, ''),
        ('outputs:loopBody', 'execution', 0, None, 'Executed for each index in the range', {}, True, None, False, ''),
        ('outputs:value', 'int', 0, None, 'The current or last value of the range', {}, True, None, False, ''),
        ('state:i', 'int', 0, None, 'The next position in the range or -1 when loop is not active', {ogn.MetadataKeys.DEFAULT: '-1'}, True, -1, False, ''),
    ])

    @classmethod
    def _populate_role_data(cls):
        """Populate a role structure with the non-default roles on this node type"""
        role_data = super()._populate_role_data()
        role_data.inputs.breakLoop = og.AttributeRole.EXECUTION
        role_data.inputs.execIn = og.AttributeRole.EXECUTION
        role_data.outputs.finished = og.AttributeRole.EXECUTION
        role_data.outputs.loopBody = og.AttributeRole.EXECUTION
        return role_data

    class ValuesForInputs(og.DynamicAttributeAccess):
        LOCAL_PROPERTY_NAMES = { }
        """Helper class that creates natural hierarchical access to input attributes"""
        def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
            """Initialize simplified access for the attribute data"""
            context = node.get_graph().get_default_graph_context()
            super().__init__(context, node, attributes, dynamic_attributes)
            self._batchedReadAttributes = []
            self._batchedReadValues = []

        @property
        def breakLoop(self):
            data_view = og.AttributeValueHelper(self._attributes.breakLoop)
            return data_view.get()

        @breakLoop.setter
        def breakLoop(self, value):
            if self._setting_locked:
                raise og.ReadOnlyError(self._attributes.breakLoop)
            data_view = og.AttributeValueHelper(self._attributes.breakLoop)
            data_view.set(value)

        @property
        def execIn(self):
            data_view = og.AttributeValueHelper(self._attributes.execIn)
            return data_view.get()

        @execIn.setter
        def execIn(self, value):
            if self._setting_locked:
                raise og.ReadOnlyError(self._attributes.execIn)
            data_view = og.AttributeValueHelper(self._attributes.execIn)
            data_view.set(value)

        @property
        def start(self):
            data_view = og.AttributeValueHelper(self._attributes.start)
            return data_view.get()

        @start.setter
        def start(self, value):
            if self._setting_locked:
                raise og.ReadOnlyError(self._attributes.start)
            data_view = og.AttributeValueHelper(self._attributes.start)
            data_view.set(value)

        @property
        def step(self):
            data_view = og.AttributeValueHelper(self._attributes.step)
            return data_view.get()

        @step.setter
        def step(self, value):
            if self._setting_locked:
                raise og.ReadOnlyError(self._attributes.step)
            data_view = og.AttributeValueHelper(self._attributes.step)
            data_view.set(value)

        @property
        def stop(self):
            data_view = og.AttributeValueHelper(self._attributes.stop)
            return data_view.get()

        @stop.setter
        def stop(self, value):
            if self._setting_locked:
                raise og.ReadOnlyError(self._attributes.stop)
            data_view = og.AttributeValueHelper(self._attributes.stop)
            data_view.set(value)

        def _prefetch(self):
            readAttributes = self._batchedReadAttributes
            newValues = _og._prefetch_input_attributes_data(readAttributes)
            if len(readAttributes) == len(newValues):
                self._batchedReadValues = newValues

    class ValuesForOutputs(og.DynamicAttributeAccess):
        LOCAL_PROPERTY_NAMES = { }
        """Helper class that creates natural hierarchical access to output attributes"""
        def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
            """Initialize simplified access for the attribute data"""
            context = node.get_graph().get_default_graph_context()
            super().__init__(context, node, attributes, dynamic_attributes)
            self._batchedWriteValues = { }

        @property
        def finished(self):
            data_view = og.AttributeValueHelper(self._attributes.finished)
            return data_view.get()

        @finished.setter
        def finished(self, value):
            data_view = og.AttributeValueHelper(self._attributes.finished)
            data_view.set(value)

        @property
        def index(self):
            data_view = og.AttributeValueHelper(self._attributes.index)
            return data_view.get()

        @index.setter
        def index(self, value):
            data_view = og.AttributeValueHelper(self._attributes.index)
            data_view.set(value)

        @property
        def loopBody(self):
            data_view = og.AttributeValueHelper(self._attributes.loopBody)
            return data_view.get()

        @loopBody.setter
        def loopBody(self, value):
            data_view = og.AttributeValueHelper(self._attributes.loopBody)
            data_view.set(value)

        @property
        def value(self):
            data_view = og.AttributeValueHelper(self._attributes.value)
            return data_view.get()

        @value.setter
        def value(self, value):
            data_view = og.AttributeValueHelper(self._attributes.value)
            data_view.set(value)

        def _commit(self):
            _og._commit_output_attributes_data(self._batchedWriteValues)
            self._batchedWriteValues = { }

    class ValuesForState(og.DynamicAttributeAccess):
        """Helper class that creates natural hierarchical access to state attributes"""
        def __init__(self, node: og.Node, attributes, dynamic_attributes: og.DynamicAttributeInterface):
            """Initialize simplified access for the attribute data"""
            context = node.get_graph().get_default_graph_context()
            super().__init__(context, node, attributes, dynamic_attributes)

        @property
        def i(self):
            data_view = og.AttributeValueHelper(self._attributes.i)
            return data_view.get()

        @i.setter
        def i(self, value):
            data_view = og.AttributeValueHelper(self._attributes.i)
            data_view.set(value)

    def __init__(self, node):
        super().__init__(node)
        dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_INPUT)
        self.inputs = OgnForLoopDatabase.ValuesForInputs(node, self.attributes.inputs, dynamic_attributes)
        dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_OUTPUT)
        self.outputs = OgnForLoopDatabase.ValuesForOutputs(node, self.attributes.outputs, dynamic_attributes)
        dynamic_attributes = self.dynamic_attribute_data(node, og.AttributePortType.ATTRIBUTE_PORT_TYPE_STATE)
        self.state = OgnForLoopDatabase.ValuesForState(node, self.attributes.state, dynamic_attributes)
