1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

# Copyright (C) 2017: Andrey Skvortsov <andrej.skvortzov@gmail.com>

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

# This program is free software; you can redistribute it and/or

    13

# modify it under the terms of the GNU General Public License

    14

# as published by the Free Software Foundation; either version 2

    15

# of the License, or (at your option) any later version.

    16

#

    17

# This program is distributed in the hope that it will be useful,

    18

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

# You should have received a copy of the GNU General Public License

    23

# along with this program; if not, write to the Free Software

    24

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.#

    25

    26

    27

from __future__ import absolute_import

    28

import wx

    29

    30

from plcopen.structures import LOCATIONDATATYPES

    31

from PLCControler import LOCATION_CONFNODE, LOCATION_MODULE, LOCATION_GROUP, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT, LOCATION_VAR_MEMORY

    32

from util.BitmapLibrary import GetBitmap

    33

from util.TranslationCatalogs import NoTranslate

    34

    35

# -------------------------------------------------------------------------------

    36

#                                   Helpers

    37

# -------------------------------------------------------------------------------

    38

    39

    40

def GetDirFilterChoiceOptions():

    41

    _ = NoTranslate

    42

    return [(_("All"), [LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT, LOCATION_VAR_MEMORY]),

    43

            (_("Input"), [LOCATION_VAR_INPUT]),

    44

            (_("Output"), [LOCATION_VAR_OUTPUT]),

    45

            (_("Memory"), [LOCATION_VAR_MEMORY])]

    46

    47

    48

DIRFILTERCHOICE_OPTIONS = dict([(_(option), filter) for option, filter in GetDirFilterChoiceOptions()])

    49

    50

    51

def GetTypeFilterChoiceOptions():

    52

    _ = NoTranslate

    53

    return [_("All"),

    54

            _("Type and derivated"),

    55

            _("Type strict")]

    56

    57

    58

# turn LOCATIONDATATYPES inside-out

    59

LOCATION_SIZES = {}

    60

for size, types in LOCATIONDATATYPES.iteritems():

    61

    for type in types:

    62

        LOCATION_SIZES[type] = size

    63

    64

# -------------------------------------------------------------------------------

    65

#                            Browse Locations Dialog

    66

# -------------------------------------------------------------------------------

    67

    68

    69

class BrowseLocationsDialog(wx.Dialog):

    70

    71

    def __init__(self, parent, var_type, controller):

    72

        wx.Dialog.__init__(self, parent, title=_('Browse Locations'),

    73

                           style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER)

    74

    75

        main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=3, vgap=10)

    76

        main_sizer.AddGrowableCol(0)

    77

        main_sizer.AddGrowableRow(1)

    78

    79

        locations_label = wx.StaticText(self, label=_('Locations available:'))

    80

        main_sizer.AddWindow(locations_label, border=20,

    81

                             flag=wx.TOP | wx.LEFT | wx.RIGHT | wx.GROW)

    82

    83

        self.LocationsTree = wx.TreeCtrl(self,

    84

                                         style=(wx.TR_HAS_BUTTONS |

    85

                                                wx.TR_SINGLE |

    86

                                                wx.SUNKEN_BORDER |

    87

                                                wx.TR_HIDE_ROOT |

    88

                                                wx.TR_LINES_AT_ROOT))

    89

        self.LocationsTree.SetInitialSize(wx.Size(-1, 300))

    90

        self.Bind(wx.EVT_TREE_ITEM_ACTIVATED, self.OnLocationsTreeItemActivated,

    91

                  self.LocationsTree)

    92

        main_sizer.AddWindow(self.LocationsTree, border=20,

    93

                             flag=wx.LEFT | wx.RIGHT | wx.GROW)

    94

    95

        button_gridsizer = wx.FlexGridSizer(cols=5, hgap=5, rows=1, vgap=0)

    96

        button_gridsizer.AddGrowableCol(1)

    97

        button_gridsizer.AddGrowableCol(3)

    98

        button_gridsizer.AddGrowableRow(0)

    99

        main_sizer.AddSizer(button_gridsizer, border=20,

   100

                            flag=wx.BOTTOM | wx.LEFT | wx.RIGHT | wx.GROW)

   101

   102

        direction_label = wx.StaticText(self, label=_('Direction:'))

   103

        button_gridsizer.AddWindow(direction_label,

   104

                                   flag=wx.ALIGN_CENTER_VERTICAL)

   105

   106

        self.DirFilterChoice = wx.ComboBox(self, style=wx.CB_READONLY)

   107

        self.Bind(wx.EVT_COMBOBOX, self.OnFilterChoice, self.DirFilterChoice)

   108

        button_gridsizer.AddWindow(self.DirFilterChoice,

   109

                                   flag=wx.GROW | wx.ALIGN_CENTER_VERTICAL)

   110

   111

        filter_label = wx.StaticText(self, label=_('Type:'))

   112

        button_gridsizer.AddWindow(filter_label,

   113

                                   flag=wx.ALIGN_CENTER_VERTICAL)

   114

   115

        self.TypeFilterChoice = wx.ComboBox(self, style=wx.CB_READONLY)

   116

        self.Bind(wx.EVT_COMBOBOX, self.OnFilterChoice, self.TypeFilterChoice)

   117

        button_gridsizer.AddWindow(self.TypeFilterChoice,

   118

                                   flag=wx.GROW | wx.ALIGN_CENTER_VERTICAL)

   119

   120

        button_sizer = self.CreateButtonSizer(wx.OK | wx.CANCEL | wx.CENTRE)

   121

        self.Bind(wx.EVT_BUTTON, self.OnOK, button_sizer.GetAffirmativeButton())

   122

        button_gridsizer.AddSizer(button_sizer, flag=wx.ALIGN_RIGHT)

   123

   124

        self.SetSizer(main_sizer)

   125

   126

        self.Controller = controller

   127

        self.VarType = var_type

   128

        self.BaseVarType = self.Controller.GetBaseType(self.VarType)

   129

        self.VarTypeSize = LOCATION_SIZES[self.BaseVarType]

   130

        self.Locations = self.Controller.GetVariableLocationTree()

   131

   132

        # Define Tree item icon list

   133

        self.TreeImageList = wx.ImageList(16, 16)

   134

        self.TreeImageDict = {}

   135

   136

        # Icons for items

   137

        for imgname, itemtype in [

   138

                ("CONFIGURATION", LOCATION_CONFNODE),

   139

                ("RESOURCE",      LOCATION_MODULE),

   140

                ("PROGRAM",       LOCATION_GROUP),

   141

                ("VAR_INPUT",     LOCATION_VAR_INPUT),

   142

                ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   143

                ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   144

            self.TreeImageDict[itemtype] = self.TreeImageList.Add(GetBitmap(imgname))

   145

   146

        # Assign icon list to TreeCtrls

   147

        self.LocationsTree.SetImageList(self.TreeImageList)

   148

   149

        # Set a options for the choice

   150

        for option, _filter in GetDirFilterChoiceOptions():

   151

            self.DirFilterChoice.Append(_(option))

   152

        self.DirFilterChoice.SetStringSelection(_("All"))

   153

        for option in GetTypeFilterChoiceOptions():

   154

            self.TypeFilterChoice.Append(_(option))

   155

        self.TypeFilterChoice.SetStringSelection(_("All"))

   156

        self.RefreshFilters()

   157

   158

        self.RefreshLocationsTree()

   159

        self.Fit()

   160

   161

    def RefreshFilters(self):

   162

        self.DirFilter = DIRFILTERCHOICE_OPTIONS[self.DirFilterChoice.GetStringSelection()]

   163

        self.TypeFilter = self.TypeFilterChoice.GetSelection()

   164

   165

    def RefreshLocationsTree(self):

   166

        root = self.LocationsTree.GetRootItem()

   167

        if not root.IsOk():

   168

            root = self.LocationsTree.AddRoot("")

   169

        self.GenerateLocationsTreeBranch(root, self.Locations)

   170

   171

    def FilterType(self, location_type, location_size):

   172

        if self.TypeFilter == 0:

   173

            return True

   174

   175

        if location_size != self.VarTypeSize:

   176

            return False

   177

   178

        if self.TypeFilter == 1:

   179

            return self.Controller.IsOfType(location_type, self.BaseVarType)

   180

        elif self.TypeFilter == 2:

   181

            return location_type == self.VarType

   182

   183

        return True

   184

   185

    def GenerateLocationsTreeBranch(self, root, locations):

   186

        to_delete = []

   187

        item, root_cookie = self.LocationsTree.GetFirstChild(root)

   188

        for loc_infos in locations:

   189

            infos = loc_infos.copy()

   190

            if infos["type"] in [LOCATION_CONFNODE, LOCATION_MODULE, LOCATION_GROUP] or\

   191

               infos["type"] in self.DirFilter and self.FilterType(infos["IEC_type"], infos["size"]):

   192

                children = [child for child in infos.pop("children")]

   193

                if not item.IsOk():

   194

                    item = self.LocationsTree.AppendItem(root, infos["name"])

   195

                    if wx.Platform != '__WXMSW__':

   196

                        item, root_cookie = self.LocationsTree.GetNextChild(root, root_cookie)

   197

                else:

   198

                    self.LocationsTree.SetItemText(item, infos["name"])

   199

                self.LocationsTree.SetPyData(item, infos)

   200

                self.LocationsTree.SetItemImage(item, self.TreeImageDict[infos["type"]])

   201

                self.GenerateLocationsTreeBranch(item, children)

   202

                item, root_cookie = self.LocationsTree.GetNextChild(root, root_cookie)

   203

        while item.IsOk():

   204

            to_delete.append(item)

   205

            item, root_cookie = self.LocationsTree.GetNextChild(root, root_cookie)

   206

        for item in to_delete:

   207

            self.LocationsTree.Delete(item)

   208

   209

    def OnLocationsTreeItemActivated(self, event):

   210

        infos = self.LocationsTree.GetPyData(event.GetItem())

   211

        if infos["type"] not in [LOCATION_CONFNODE, LOCATION_MODULE, LOCATION_GROUP]:

   212

            wx.CallAfter(self.EndModal, wx.ID_OK)

   213

        event.Skip()

   214

   215

    def OnFilterChoice(self, event):

   216

        self.RefreshFilters()

   217

        self.RefreshLocationsTree()

   218

   219

    def GetValues(self):

   220

        selected = self.LocationsTree.GetSelection()

   221

        return self.LocationsTree.GetPyData(selected)

   222

   223

    def OnOK(self, event):

   224

        selected = self.LocationsTree.GetSelection()

   225

        var_infos = None

   226

        if selected.IsOk():

   227

            var_infos = self.LocationsTree.GetPyData(selected)

   228

        if var_infos is None or var_infos["type"] in [LOCATION_CONFNODE, LOCATION_MODULE, LOCATION_GROUP]:

   229

            dialog = wx.MessageDialog(self, _("A location must be selected!"), _("Error"), wx.OK | wx.ICON_ERROR)

   230

            dialog.ShowModal()

   231

            dialog.Destroy()

   232

        else:

   233

            self.EndModal(wx.ID_OK)