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

import os

    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

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 | wx.TR_SINGLE | wx.SUNKEN_BORDER | wx.TR_HIDE_ROOT | wx.TR_LINES_AT_ROOT)

    85

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

    86

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

    87

                  self.LocationsTree)

    88

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

    89

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

    90

    91

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

    92

        button_gridsizer.AddGrowableCol(1)

    93

        button_gridsizer.AddGrowableCol(3)

    94

        button_gridsizer.AddGrowableRow(0)

    95

        main_sizer.AddSizer(button_gridsizer, border=20,

    96

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

    97

    98

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

    99

        button_gridsizer.AddWindow(direction_label,

   100

              flag=wx.ALIGN_CENTER_VERTICAL)

   101

   102

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

   103

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

   104

        button_gridsizer.AddWindow(self.DirFilterChoice,

   105

              flag=wx.GROW | wx.ALIGN_CENTER_VERTICAL)

   106

   107

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

   108

        button_gridsizer.AddWindow(filter_label,

   109

              flag=wx.ALIGN_CENTER_VERTICAL)

   110

   111

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

   112

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

   113

        button_gridsizer.AddWindow(self.TypeFilterChoice,

   114

              flag=wx.GROW | wx.ALIGN_CENTER_VERTICAL)

   115

   116

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

   117

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

   118

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

   119

   120

        self.SetSizer(main_sizer)

   121

   122

        self.Controller = controller

   123

        self.VarType = var_type

   124

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

   125

        self.VarTypeSize = LOCATION_SIZES[self.BaseVarType]

   126

        self.Locations = self.Controller.GetVariableLocationTree()

   127

   128

        # Define Tree item icon list

   129

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

   130

        self.TreeImageDict = {}

   131

   132

        # Icons for items

   133

        for imgname, itemtype in [

   140

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

   141

   142

        # Assign icon list to TreeCtrls

   143

        self.LocationsTree.SetImageList(self.TreeImageList)

   144

   145

        # Set a options for the choice

   146

        for option, filter in GetDirFilterChoiceOptions():

   147

            self.DirFilterChoice.Append(_(option))

   148

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

   149

        for option in GetTypeFilterChoiceOptions():

   150

            self.TypeFilterChoice.Append(_(option))

   151

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

   152

        self.RefreshFilters()

   153

   154

        self.RefreshLocationsTree()

   155

        self.Fit()

   156

   157

    def RefreshFilters(self):

   158

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

   159

        self.TypeFilter = self.TypeFilterChoice.GetSelection()

   160

   161

    def RefreshLocationsTree(self):

   162

        root = self.LocationsTree.GetRootItem()

   163

        if not root.IsOk():

   164

            root = self.LocationsTree.AddRoot("")

   165

        self.GenerateLocationsTreeBranch(root, self.Locations)

   166

   167

    def FilterType(self, location_type, location_size):

   168

        if self.TypeFilter == 0:

   169

            return True

   170

   171

        if location_size != self.VarTypeSize:

   172

            return False

   173

   174

        if self.TypeFilter == 1:

   175

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

   176

        elif self.TypeFilter == 2:

   177

            return location_type == self.VarType

   178

   179

        return True

   180

   181

    def GenerateLocationsTreeBranch(self, root, locations):

   182

        to_delete = []

   183

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

   184

        for loc_infos in locations:

   185

            infos = loc_infos.copy()

   186

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

   187

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

   188

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

   189

                if not item.IsOk():

   190

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

   191

                    if wx.Platform != '__WXMSW__':

   192

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

   193

                else:

   194

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

   195

                self.LocationsTree.SetPyData(item, infos)

   196

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

   197

                self.GenerateLocationsTreeBranch(item, children)

   198

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

   199

        while item.IsOk():

   200

            to_delete.append(item)

   201

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

   202

        for item in to_delete:

   203

            self.LocationsTree.Delete(item)

   204

   205

    def OnLocationsTreeItemActivated(self, event):

   206

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

   207

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

   208

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

   209

        event.Skip()

   210

   211

    def OnFilterChoice(self, event):

   212

        self.RefreshFilters()

   213

        self.RefreshLocationsTree()

   214

   215

    def GetValues(self):

   216

        selected = self.LocationsTree.GetSelection()

   217

        return self.LocationsTree.GetPyData(selected)

   218

   219

    def OnOK(self, event):

   220

        selected = self.LocationsTree.GetSelection()

   221

        var_infos = None

   222

        if selected.IsOk():

   223

            var_infos = self.LocationsTree.GetPyData(selected)

   224

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

   225

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

   226

            dialog.ShowModal()

   227

            dialog.Destroy()

   228

        else:

   229

            self.EndModal(wx.ID_OK)