#!/usr/bin/python
# -*- coding: utf-8 -*-

# ---------------------------------------------------------------------
# Copyright (c) 2012 Michael Hull.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
#  - Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#  - 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.
#
# 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.
# ----------------------------------------------------------------------

from Cheetah.Template import Template
from morphforge.morphology.visitor.visitorbaseclasses import SectionIndexerDF
from morphforge.simulation.neuron.simulationdatacontainers import MHOCSections
from morphforge.simulation.neuron.simulationdatacontainers import MHocFileData

_cell_templ_tmpl = """

v_init = $cell.initial_voltage.rescale('mV').magnitude

// Cell Template for: $cell_template_name
#set nSections = len($section_indexer)
begintemplate $cell_template_name
    create internalsections[$nSections]
    public internalsections

    proc init() {
        create internalsections[$nSections]

        #for $section in $cell.morphology:
        internalsections[$section_indexer[$section]] {

            // Section ID: $section.idtag

            // Section Geometry:
            L = $section.get_length
            #set p_d = $section.p_r * 2.0
            #set d_d = $section.d_r * 2.0
            diam(0.0) = $p_d
            diam(1.0) = $d_d

            // Passive Parameters:
            cm = $cell.get_biophysics().get_passive_property_for_section($section, "SpecificCapacitance").rescale("uF/cm2").magnitude
            Ra = $cell.get_biophysics().get_passive_property_for_section($section, "AxialResistance").rescale("ohmcm").magnitude

            // Segmentation:
            nseg = $cell.get_segmenter().get_num_segments($section)





        }
        #end for




        // Section Connections
        ///////////////////////

        // Non-root sections:
        #for $section in $cell.morphology:
        #if $section.is_a_root_section(): #continue
        // Make a Connection
        connect internalsections[$section_indexer[$section.parent]](1.0),  internalsections[$section_indexer[$section]](0.0)
        #end for


        // Root Sections:
        #set roots = $cell.morphology.get_root_sections
        #for r in roots[1:]:
        connect internalsections[$section_indexer[$r]](0.0),  internalsections[$section_indexer[$r]](0.0)
        #end for

    }
endtemplate $cell_template_name

"""

_cell_obj_decl_tmpl = """
objref $cell_name
$cell_name = new  $cell_template_name ()
"""


[docs]class HocBuilder_Cell(object):

    @classmethod
[docs]    def build(cls, hocfile_obj, cell):

        data = {
            'cell': cell,
            'section_indexer': SectionIndexerDF(morph=cell.morphology)(),
            'cell_template_name': 'CellTempl_%s' % cell.name,
            'cell_name': 'cell_%s' % cell.name,
            }

        # Create the Cell Topology Template:
        hocfile_obj.add_to_section(
                        MHOCSections.InitTemplates,
                        Template(_cell_templ_tmpl, data).respond())
        hocfile_obj.add_to_section(
                        MHOCSections.InitCells,
                        Template(_cell_obj_decl_tmpl, data).respond())

        # Save the data about this cell:
        hocfile_obj[MHocFileData.Cells][cell] = data

        # Create the membrane properties:
        for section in cell.morphology:
            for mta in cell.get_biophysics().get_resolved_mtas_for_section(section):
                mta.channel.build_hoc_section(cell=cell,
                        section=section, hocfile_obj=hocfile_obj, mta=mta)