# ------------------------------------------------------------------------------
# This file is part of Appy, a framework for building applications in the Python
# language. Copyright (C) 2007 Gaetan Delannay

# Appy is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation; either version 3 of the License, or (at your option) any later
# version.

# Appy is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.

# You should have received a copy of the GNU General Public License along with
# Appy. If not, see <http://www.gnu.org/licenses/>.

# ------------------------------------------------------------------------------
from appy import Object
from list import List
from appy.px import Px
from appy.gen.layout import Table

# ------------------------------------------------------------------------------
class Dict(List):
    '''A Dict is stored as a dict of Object instances [Object]~. Keys are fixed
       and are given by a method specified in parameter "keys". Values are
       Object instances, whose attributes are determined by parameter "fields"
       that, similarly to the List field, determines sub-data for every entry in
       the dict. This field is build on top of the List field.'''

    # PX for rendering a single row
    pxRow = Px('''
     <tr valign="top" class=":loop.row.odd and 'even' or 'odd'">
      <td>:row[1]</td>
      <td for="info in subFields" if="info[1]" align="center"
          var2="field=info[1];
                fieldName='%s*%d' % (field.name, rowIndex);
                tagCss='noStyle'">:field.pxRender</td>
     </tr>''')

    # PX for rendering the dict (shared between pxView and pxEdit)
    pxTable = Px('''
     <table var="isEdit=layoutType == 'edit'" if="isEdit or value"
            id=":'list_%s' % name" class=":isEdit and 'grid' or 'compact list'"
            width=":field.width"
            var2="keys=field.keys(obj);
                  subFields=field.getSubFields(zobj, layoutType)">
      <!-- Header -->
      <tr valign="bottom">
       <th></th>
       <th for="info in subFields" if="info[1]"
           width=":field.widths[loop.info.nb]">::_(info[1].labelId)</th>
      </tr>
      <!-- Rows of data -->
      <x for="row in keys" var2="rowIndex=loop.row.nb">:field.pxRow</x>
     </table>''')

    def __init__(self, keys, fields, validator=None, multiplicity=(0,1),
                 default=None, show=True, page='main', group=None, layouts=None,
                 move=0, specificReadPermission=False,
                 specificWritePermission=False, width='', height=None,
                 maxChars=None, colspan=1, master=None, masterValue=None,
                 focus=False, historized=False, mapping=None, label=None,
                 subLayouts=Table('frv', width=None), widths=None, view=None,
                 xml=None):
        List.__init__(self, fields, validator, multiplicity, default, show, page,
                      group, layouts, move, specificReadPermission,
                      specificWritePermission, width, height, maxChars, colspan,
                      master, masterValue, focus, historized, mapping, label,
                      subLayouts, widths, view, xml)
        # Method in "keys" must return a list of tuples (key, title): "key"
        # determines the key that will be used to store the entry in the
        # database, while "title" will get the text that will be shown in the ui
        # while encoding/viewing this entry.
        self.keys = keys

    def getFormattedValue(self, obj, value, layoutType='view',
                          showChanges=False, language=None):
        '''Formats the dict value as a list of values'''
        res = []
        for key, title in self.keys(obj.appy()):
            if key in value:
                res.append(value[key])
            else:
                # There is no value for this key in the database p_value
                res.append(None)
        return res

    def getStorableValue(self, obj, value):
        '''Gets p_value in a form that can be stored in the database'''
        res = {}
        values = List.getStorableValue(self, obj, value)
        i = -1
        for key, title in self.keys(obj.appy()):
            i += 1
            res[key] = values[i]
        return res
# ------------------------------------------------------------------------------