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

    34

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

    35

#                                   Helpers

    36

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

    37

    38

    39

def GetDirFilterChoiceOptions():

    40

    _ = lambda x : x

    41

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

    42

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

    43

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

    44

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

    45

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

    46

    47

    48

def GetTypeFilterChoiceOptions():

    49

    _ = lambda x : x

    50

    return [_("All"),

    51

            _("Type and derivated"),

    52

            _("Type strict")]

    53

    54

# turn LOCATIONDATATYPES inside-out

    55

LOCATION_SIZES = {}

    56

for size, types in LOCATIONDATATYPES.iteritems():

    57

    for type in types:

    58

        LOCATION_SIZES[type] = size

    59

    60

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

    61

#                            Browse Locations Dialog

    62

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

    63

    64

    65

class BrowseLocationsDialog(wx.Dialog):

    66

    67

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

    68

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

    69

              style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)

    70

    71

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

    72

        main_sizer.AddGrowableCol(0)

    73

        main_sizer.AddGrowableRow(1)

    74

    75

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

    76

        main_sizer.AddWindow(locations_label, border=20,

    77

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

    78

    79

        self.LocationsTree = wx.TreeCtrl(self,

    80

              style=wx.TR_HAS_BUTTONS|wx.TR_SINGLE|wx.SUNKEN_BORDER|wx.TR_HIDE_ROOT|wx.TR_LINES_AT_ROOT)

    81

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

    82

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

    83

                  self.LocationsTree)

    84

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

    85

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

    86

    87

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

    88

        button_gridsizer.AddGrowableCol(1)

    89

        button_gridsizer.AddGrowableCol(3)

    90

        button_gridsizer.AddGrowableRow(0)

    91

        main_sizer.AddSizer(button_gridsizer, border=20,

    92

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

    93

    94

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

    95

        button_gridsizer.AddWindow(direction_label,

    96

              flag=wx.ALIGN_CENTER_VERTICAL)

    97

    98

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

    99

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

   100

        button_gridsizer.AddWindow(self.DirFilterChoice,

   101

              flag=wx.GROW|wx.ALIGN_CENTER_VERTICAL)

   102

   103

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

   104

        button_gridsizer.AddWindow(filter_label,

   105

              flag=wx.ALIGN_CENTER_VERTICAL)

   106

   107

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

   108

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

   109

        button_gridsizer.AddWindow(self.TypeFilterChoice,

   110

              flag=wx.GROW|wx.ALIGN_CENTER_VERTICAL)

   111

   112

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

   113

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

   114

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

   115

   116

        self.SetSizer(main_sizer)

   117

   118

        self.Controller = controller

   119

        self.VarType = var_type

   120

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

   121

        self.VarTypeSize = LOCATION_SIZES[self.BaseVarType]

   122

        self.Locations = self.Controller.GetVariableLocationTree()

   123

   124

        # Define Tree item icon list

   125

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

   126

        self.TreeImageDict = {}

   127

   128

        # Icons for items

   129

        for imgname, itemtype in [

   130

            ("CONFIGURATION", LOCATION_CONFNODE),

   131

            ("RESOURCE",      LOCATION_MODULE),

   132

            ("PROGRAM",       LOCATION_GROUP),

   133

            ("VAR_INPUT",     LOCATION_VAR_INPUT),

   134

            ("VAR_OUTPUT",    LOCATION_VAR_OUTPUT),

   135

            ("VAR_LOCAL",     LOCATION_VAR_MEMORY)]:

   136

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

   137

   138

        # Assign icon list to TreeCtrls

   139

        self.LocationsTree.SetImageList(self.TreeImageList)

   140

   141

        # Set a options for the choice

   142

        for option, filter in GetDirFilterChoiceOptions():

   143

            self.DirFilterChoice.Append(_(option))

   144

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

   145

        for option in GetTypeFilterChoiceOptions():

   146

            self.TypeFilterChoice.Append(_(option))

   147

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

   148

        self.RefreshFilters()

   149

   150

        self.RefreshLocationsTree()

   151

        self.Fit()

   152

   153

    def RefreshFilters(self):

   154

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

   155

        self.TypeFilter = self.TypeFilterChoice.GetSelection()

   156

   157

    def RefreshLocationsTree(self):

   158

        root = self.LocationsTree.GetRootItem()

   159

        if not root.IsOk():

   160

            root = self.LocationsTree.AddRoot("")

   161

        self.GenerateLocationsTreeBranch(root, self.Locations)

   162

   163

    def FilterType(self, location_type, location_size):

   164

        if self.TypeFilter == 0:

   165

            return True

   166

   167

        if location_size != self.VarTypeSize:

   168

            return False

   169

   170

        if self.TypeFilter == 1:

   171

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

   172

        elif self.TypeFilter == 2:

   173

            return location_type == self.VarType

   174

   175

        return True

   176

   177

    def GenerateLocationsTreeBranch(self, root, locations):

   178

        to_delete = []

   179

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

   180

        for loc_infos in locations:

   181

            infos = loc_infos.copy()

   182

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

   183

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

   184

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

   185

                if not item.IsOk():

   186

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

   187

                    if wx.Platform != '__WXMSW__':

   188

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

   189

                else:

   190

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

   191

                self.LocationsTree.SetPyData(item, infos)

   192

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

   193

                self.GenerateLocationsTreeBranch(item, children)

   194

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

   195

        while item.IsOk():

   196

            to_delete.append(item)

   197

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

   198

        for item in to_delete:

   199

            self.LocationsTree.Delete(item)

   200

   201

    def OnLocationsTreeItemActivated(self, event):

   202

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

   203

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

   204

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

   205

        event.Skip()

   206

   207

    def OnFilterChoice(self, event):

   208

        self.RefreshFilters()

   209

        self.RefreshLocationsTree()

   210

   211

    def GetValues(self):

   212

        selected = self.LocationsTree.GetSelection()

   213

        return self.LocationsTree.GetPyData(selected)

   214

   215

    def OnOK(self, event):

   216

        selected = self.LocationsTree.GetSelection()

   217

        var_infos = None

   218

        if selected.IsOk():

   219

            var_infos = self.LocationsTree.GetPyData(selected)

   220

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

   221

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

   222

            dialog.ShowModal()

   223

            dialog.Destroy()

   224

        else:

   225

            self.EndModal(wx.ID_OK)