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

    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

def GetTypeFilterChoiceOptions():

    49

    _ = NoTranslate

    50

    return [_("All"),

    51

            _("Type and derivated"),

    52

            _("Type strict")]

    53

    54

    55

# turn LOCATIONDATATYPES inside-out

    56

LOCATION_SIZES = {}

    57

for size, types in LOCATIONDATATYPES.items():

    58

    for type in types:

    59

        LOCATION_SIZES[type] = size

    60

    61

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

    62

#                            Browse Locations Dialog

    63

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

    64

    65

    66

class BrowseLocationsDialog(wx.Dialog):

    67

    68

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

    69

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

    70

                           style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER)

    71

    72

        self.DIRFILTERCHOICE_OPTIONS = dict(

    73

            [(_(option), filter) for option, filter in GetDirFilterChoiceOptions()])

    74

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

    75

        main_sizer.AddGrowableCol(0)

    76

        main_sizer.AddGrowableRow(1)

    77

    78

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

    79

        main_sizer.Add(locations_label, border=20,

    80

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

    81

    82

        self.LocationsTree = wx.TreeCtrl(self,

    83

                                         style=(wx.TR_HAS_BUTTONS |

    84

                                                wx.TR_SINGLE |

    85

                                                wx.SUNKEN_BORDER |

    86

                                                wx.TR_HIDE_ROOT |

    87

                                                wx.TR_LINES_AT_ROOT))

    88

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

    89

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

    90

                  self.LocationsTree)

    91

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

    92

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

    93

    94

        self.RenameCheckBox = wx.CheckBox(self, label=_("Rename variable to signal name"))

    95

        self.Config = wx.ConfigBase.Get()

    96

        default_checked = self.Config.Read("RenameVariableOnLocationChange") == "True"

    97

        self.RenameCheckBox.SetValue(default_checked)

    98

        self.do_rename = default_checked

    99

   100

        main_sizer.Add(self.RenameCheckBox, border=20,

   101

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

   102

   103

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

   104

        button_gridsizer.AddGrowableCol(1)

   105

        button_gridsizer.AddGrowableCol(3)

   106

        button_gridsizer.AddGrowableRow(0)

   107

        main_sizer.Add(button_gridsizer, border=20,

   108

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

   109

   110

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

   111

        button_gridsizer.Add(direction_label,

   112

                                   flag=wx.ALIGN_CENTER_VERTICAL)

   113

   114

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

   115

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

   116

        button_gridsizer.Add(self.DirFilterChoice,

   117

                                   flag=wx.GROW | wx.ALIGN_CENTER_VERTICAL)

   118

   119

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

   120

        button_gridsizer.Add(filter_label,

   121

                                   flag=wx.ALIGN_CENTER_VERTICAL)

   122

   123

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

   124

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

   125

        button_gridsizer.Add(self.TypeFilterChoice,

   126

                                   flag=wx.GROW | wx.ALIGN_CENTER_VERTICAL)

   127

   128

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

   129

        self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.GetAffirmativeId())

   130

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

   131

   132

        self.SetSizer(main_sizer)

   133

   134

        self.Controller = controller

   135

        self.VarType = var_type

   136

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

   137

        self.VarTypeSize = LOCATION_SIZES[self.BaseVarType] if self.BaseVarType else None

   138

        self.Locations = self.Controller.GetVariableLocationTree()

   139

   140

        # Define Tree item icon list

   141

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

   142

        self.TreeImageDict = {}

   143

   144

        # Icons for items

   145

        for imgname, itemtype in [

   146

                ("CONFIGURATION", LOCATION_CONFNODE),

   147

                ("RESOURCE",      LOCATION_MODULE),

   148

                ("PROGRAM",       LOCATION_GROUP),

   149

                ("VAR_INPUT",     LOCATION_VAR_INPUT),

   150

                ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   151

                ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   152

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

   153

   154

        # Assign icon list to TreeCtrls

   155

        self.LocationsTree.SetImageList(self.TreeImageList)

   156

   157

        # Set a options for the choice

   158

        for option, _filter in GetDirFilterChoiceOptions():

   159

            self.DirFilterChoice.Append(_(option))

   160

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

   161

        for option in GetTypeFilterChoiceOptions():

   162

            self.TypeFilterChoice.Append(_(option))

   163

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

   164

        self.RefreshFilters()

   165

   166

        self.RefreshLocationsTree()

   167

        self.Fit()

   168

   169

    def RefreshFilters(self):

   170

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

   171

        self.TypeFilter = self.TypeFilterChoice.GetSelection()

   172

   173

    def RefreshLocationsTree(self):

   174

        root = self.LocationsTree.GetRootItem()

   175

        if not root.IsOk():

   176

            root = self.LocationsTree.AddRoot("")

   177

        self.GenerateLocationsTreeBranch(root, self.Locations)

   178

   179

    def FilterType(self, location_type, location_size):

   180

        if self.TypeFilter == 0:

   181

            return True

   182

   183

        if self.VarTypeSize is not None and location_size != self.VarTypeSize:

   184

            return False

   185

   186

        if self.TypeFilter == 1:

   187

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

   188

        elif self.TypeFilter == 2:

   189

            return location_type == self.VarType

   190

   191

        return True

   192

   193

    def GenerateLocationsTreeBranch(self, root, locations):

   194

        to_delete = []

   195

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

   196

        for loc_infos in locations:

   197

            infos = loc_infos.copy()

   198

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

   199

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

   200

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

   201

                if not item.IsOk():

   202

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

   203

                    if wx.Platform != '__WXMSW__':

   204

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

   205

                else:

   206

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

   207

                self.LocationsTree.SetItemData(item, infos)

   208

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

   209

                self.GenerateLocationsTreeBranch(item, children)

   210

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

   211

        while item.IsOk():

   212

            to_delete.append(item)

   213

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

   214

        for item in to_delete:

   215

            self.LocationsTree.Delete(item)

   216

   217

    def OnLocationsTreeItemActivated(self, event):

   218

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

   219

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

   220

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

   221

        event.Skip()

   222

   223

    def OnFilterChoice(self, event):

   224

        self.RefreshFilters()

   225

        self.RefreshLocationsTree()

   226

   227

    def GetValues(self):

   228

        selected = self.LocationsTree.GetSelection()

   229

        infos = self.LocationsTree.GetItemData(selected)

   230

        if not self.do_rename:

   231

            infos["var_name"] = None

   232

        return infos

   233

   234

    def OnOK(self, event):

   235

        self.do_rename = self.RenameCheckBox.IsChecked()

   236

        self.Config.Write("RenameVariableOnLocationChange", str(self.do_rename))

   237

        selected = self.LocationsTree.GetSelection()

   238

        var_infos = None

   239

        if selected.IsOk():

   240

            var_infos = self.LocationsTree.GetItemData(selected)

   241

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

   242

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

   243

            dialog.ShowModal()

   244

            dialog.Destroy()

   245

        else:

   246

            self.EndModal(wx.ID_OK)