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) 2012: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

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

    13

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

    14

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

    15

#

    16

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

    17

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

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

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

    24

    25

from collections import OrderedDict

    26

    27

import wx

    28

from matplotlib.backends.backend_wxagg import _convert_agg_to_wx_bitmap

    29

    30

from dialogs.ForceVariableDialog import ForceVariableDialog

    31

    32

# Viewer highlight types

    33

[HIGHLIGHT_NONE,

    34

 HIGHLIGHT_BEFORE,

    35

 HIGHLIGHT_AFTER,

    36

 HIGHLIGHT_LEFT,

    37

 HIGHLIGHT_RIGHT,

    38

 HIGHLIGHT_RESIZE] = range(6)

    39

    40

# Viewer highlight styles

    41

HIGHLIGHT = {

    42

}

    43

    44

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

    45

#                        Base Debug Variable Viewer Class

    46

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

    47

    48

    49

class DebugVariableViewer(object):

    50

    """

    51

    Class that implements a generic viewer that display a list of variable values

    52

    This class has to be inherited to effectively display variable values

    53

    """

    54

    55

    def __init__(self, window, items=None):

    56

        """

    57

        Constructor

    58

        @param window: Reference to the Debug Variable Panel

    59

        @param items: List of DebugVariableItem displayed by Viewer

    60

        """

    61

        self.ParentWindow = window

    62

        items = [] if items is None else items

    63

        self.ItemsDict = OrderedDict([(item.GetVariable(), item)

    64

                                      for item in items])

    65

        self.Items = self.ItemsDict.viewvalues()

    66

    67

        # Variable storing current highlight displayed in Viewer

    68

        self.Highlight = HIGHLIGHT_NONE

    69

        # List of buttons

    70

        self.Buttons = []

    71

        self.InitHighlightPensBrushes()

    72

    73

    def __del__(self):

    74

        """

    75

        Destructor

    76

        """

    77

        # Remove reference to Debug Variable Panel

    78

        self.ParentWindow = None

    79

    80

    def InitHighlightPensBrushes(self):

    81

        """

    82

        Init global pens and brushes

    83

        """

    84

        if not HIGHLIGHT:

    85

            HIGHLIGHT['DROP_PEN'] = wx.Pen(wx.Colour(0, 128, 255))

    86

            HIGHLIGHT['DROP_BRUSH'] = wx.Brush(wx.Colour(0, 128, 255, 128))

    87

            HIGHLIGHT['RESIZE_PEN'] = wx.Pen(wx.Colour(200, 200, 200))

    88

            HIGHLIGHT['RESIZE_BRUSH'] = wx.Brush(wx.Colour(200, 200, 200))

    89

    90

    def GetIndex(self):

    91

        """

    92

        Return position of Viewer in Debug Variable Panel

    93

        @return: Position of Viewer

    94

        """

    95

        return self.ParentWindow.GetViewerIndex(self)

    96

    97

    def GetItem(self, variable):

    98

        """

    99

        Return item storing values of a variable

   100

        @param variable: Variable path

   101

        @return: Item storing values of this variable

   102

        """

   103

        return self.ItemsDict.get(variable, None)

   104

   105

    def GetItems(self):

   106

        """

   107

        Return items displayed by Viewer

   108

        @return: List of items displayed in Viewer

   109

        """

   110

        return self.ItemsDict.values()

   111

   112

    def AddItem(self, item):

   113

        """

   114

        Add an item to the list of items displayed by Viewer

   115

        @param item: Item to add to the list

   116

        """

   117

        self.ItemsDict[item.GetVariable()] = item

   118

   119

    def RemoveItem(self, item):

   120

        """

   121

        Remove an item from the list of items displayed by Viewer

   122

        @param item: Item to remove from the list

   123

        """

   124

        self.ItemsDict.pop(item.GetVariable(), None)

   125

   126

    def ClearItems(self):

   127

        """

   128

        Clear list of items displayed by Viewer

   129

        """

   130

        # Unsubscribe every items of the list

   131

        for item in self.Items:

   132

            self.ParentWindow.RemoveDataConsumer(item)

   133

   134

        # Clear list

   135

        self.ItemsDict.clear()

   136

   137

    def ItemsIsEmpty(self):

   138

        """

   139

        Return if list of items displayed by Viewer is empty

   140

        @return: True if list is empty

   141

        """

   142

        return len(self.Items) == 0

   143

   144

    def SubscribeAllDataConsumers(self):

   145

        """

   146

        Function that unsubscribe and remove every item that store values of

   147

        a variable that doesn't exist in PLC anymore

   148

        """

   149

        for item in self.ItemsDict.values()[:]:

   150

            iec_path = item.GetVariable()

   151

   152

            # Check that variablepath exist in PLC

   153

            if self.ParentWindow.GetDataType(iec_path) is None:

   154

                # If not, unsubscribe and remove it

   155

                self.ParentWindow.RemoveDataConsumer(item)

   156

                self.RemoveItem(item)

   157

            else:

   158

                # If it exist, resubscribe and refresh data type

   159

                self.ParentWindow.AddDataConsumer(iec_path.upper(), item, True)

   160

                item.RefreshVariableType()

   161

   162

    def ResetItemsData(self):

   163

        """

   164

        Reset data stored in every items displayed in Viewer

   165

        """

   166

        for item in self.Items:

   167

            item.ResetData()

   168

   169

    def GetItemsMinCommonTick(self):

   170

        """

   171

        Return the minimum tick common to all iems displayed in Viewer

   172

        @return: Minimum common tick between items

   173

        """

   174

        return reduce(max, [item.GetData()[0, 0]

   175

                            for item in self.Items

   176

                            if len(item.GetData()) > 0], 0)

   177

   178

    def RefreshViewer(self):

   179

        """

   180

        Method that refresh the content displayed by Viewer

   181

        Need to be overridden by inherited classes

   182

        """

   183

        pass

   184

   185

    def SetHighlight(self, highlight):

   186

        """

   187

        Set Highlight type displayed in Viewer

   188

        @return: True if highlight has changed

   189

        """

   190

        # Return immediately if highlight don't change

   191

        if self.Highlight == highlight:

   192

            return False

   193

   194

        self.Highlight = highlight

   195

        return True

   196

   197

    def GetButtons(self):

   198

        """

   199

        Return list of buttons defined in Viewer

   200

        @return: List of buttons

   201

        """

   202

        return self.Buttons

   203

   204

    def IsOverButton(self, x, y):

   205

        """

   206

        Return if point is over one button of Viewer

   207

        @param x: X coordinate of point

   208

        @param y: Y coordinate of point

   209

        @return: button where point is over

   210

        """

   211

        for button in self.GetButtons():

   212

            if button.HitTest(x, y):

   213

                return button

   214

        return None

   215

   216

    def HandleButton(self, x, y):

   217

        """

   218

        Search for the button under point and if found execute associated

   219

        callback

   220

        @param x: X coordinate of point

   221

        @param y: Y coordinate of point

   222

        @return: True if a button was found and callback executed

   223

        """

   224

        button = self.IsOverButton(x, y)

   225

        if button is None:

   226

            return False

   227

   228

        button.ProcessCallback()

   229

        return True

   230

   231

    def ShowButtons(self, show):

   232

        """

   233

        Set display state of buttons in Viewer

   234

        @param show: Display state (True if buttons must be displayed)

   235

        """

   236

        # Change display of every buttons

   237

        for button in self.Buttons:

   238

            button.Show(show)

   239

   240

        # Refresh button positions

   241

        self.RefreshButtonsPosition()

   242

        self.RefreshViewer()

   243

   244

    def RefreshButtonsPosition(self):

   245

        """

   246

        Function that refresh buttons position in Viewer

   247

        """

   248

        # Get Viewer size

   249

        width, _height = self.GetSize()

   250

   251

        # Buttons are align right so we calculate buttons positions in

   252

        # reverse order

   253

        buttons = self.Buttons[:]

   254

        buttons.reverse()

   255

   256

        # Position offset on x coordinate

   257

        x_offset = 0

   258

        for button in buttons:

   259

            # Buttons are stacked right, removing those that are not active

   260

            if button.IsEnabled():

   261

                # Update button position according to button width and offset

   262

                # on x coordinate

   263

                w, _h = button.GetSize()

   264

                button.SetPosition(width - 5 - w - x_offset, 5)

   265

                # Update offset on x coordinate

   266

                x_offset += w + 2

   267

   268

    def DrawCommonElements(self, dc, buttons=None):

   269

        """

   270

        Function that draw common graphics for every Viewers

   271

        @param dc: wx.DC object corresponding to Device context where drawing

   272

        common graphics

   273

        @param buttons: List of buttons to draw if different from default

   274

        (default None)

   275

        """

   276

        # Get Viewer size

   277

        width, height = self.GetSize()

   278

   279

        # Set dc styling for drop before or drop after highlight

   280

        dc.SetPen(HIGHLIGHT['DROP_PEN'])

   281

        dc.SetBrush(HIGHLIGHT['DROP_BRUSH'])

   282

   283

        # Draw line at upper side of Viewer if highlight is drop before

   284

        if self.Highlight == HIGHLIGHT_BEFORE:

   285

            dc.DrawLine(0, 1, width - 1, 1)

   286

   287

        # Draw line at lower side of Viewer if highlight is drop before

   288

        elif self.Highlight == HIGHLIGHT_AFTER:

   289

            dc.DrawLine(0, height - 1, width - 1, height - 1)

   290

   291

        # If no specific buttons are defined, get default buttons

   292

        if buttons is None:

   293

            buttons = self.Buttons

   294

        # Draw buttons

   295

        for button in buttons:

   296

            button.Draw(dc)

   297

   298

        # If graph dragging is processing

   299

        if self.ParentWindow.IsDragging():

   300

            destBBox = self.ParentWindow.GetDraggingAxesClippingRegion(self)

   301

            srcPos = self.ParentWindow.GetDraggingAxesPosition(self)

   302

            if destBBox.width > 0 and destBBox.height > 0:

   303

                srcPanel = self.ParentWindow.DraggingAxesPanel

   304

                srcBBox = srcPanel.GetAxesBoundingBox()

   305

   306

                srcX = srcBBox.x - (srcPos.x if destBBox.x == 0 else 0)

   307

                srcY = srcBBox.y - (srcPos.y if destBBox.y == 0 else 0)

   308

   309

                srcBmp = _convert_agg_to_wx_bitmap(

   310

                            srcPanel.get_renderer(), None)

   311

                srcDC = wx.MemoryDC()

   312

                srcDC.SelectObject(srcBmp)

   313

   314

                dc.Blit(destBBox.x, destBBox.y,

   315

                        int(destBBox.width), int(destBBox.height),

   316

                        srcDC, srcX, srcY)

   317

   318

    def OnEnter(self, event):

   319

        """

   320

        Function called when entering Viewer

   321

        @param event: wx.MouseEvent

   322

        """

   323

        # Display buttons

   324

        self.ShowButtons(True)

   325

        event.Skip()

   326

   327

    def OnLeave(self, event):

   328

        """

   329

        Function called when leaving Viewer

   330

        @param event: wx.MouseEvent

   331

        """

   332

        # Hide buttons

   333

        self.ShowButtons(False)

   334

        event.Skip()

   335

   336

    def OnCloseButton(self):

   337

        """

   338

        Function called when Close button is pressed

   339

        """

   340

        wx.CallAfter(self.ParentWindow.DeleteValue, self)

   341

   342

    def OnForceButton(self):

   343

        """

   344

        Function called when Force button is pressed

   345

        """

   346

        self.ForceValue(self.ItemsDict.values()[0])

   347

   348

    def OnReleaseButton(self):

   349

        """

   350

        Function called when Release button is pressed

   351

        """

   352

        self.ReleaseValue(self.ItemsDict.values()[0])

   353

   354

    def OnMouseDragging(self, x, y):

   355

        """

   356

        Function called when mouse is dragged over Viewer

   357

        @param x: X coordinate of mouse pointer

   358

        @param y: Y coordinate of mouse pointer

   359

        """

   360

        xw, yw = self.GetPosition()

   361

        # Refresh highlight in Debug Variable Panel (highlight can be displayed

   362

        # in another Viewer

   363

        self.ParentWindow.RefreshHighlight(x + xw, y + yw)

   364

   365

    def RefreshHighlight(self, x, y):

   366

        """

   367

        Function called by Debug Variable Panel asking Viewer to refresh

   368

        highlight according to mouse position

   369

        @param x: X coordinate of mouse pointer

   370

        @param y: Y coordinate of mouse pointer

   371

        """

   372

        # Get Viewer size

   373

        _width, height = self.GetSize()

   374

   375

        # Mouse is in the first half of Viewer

   376

        if y < height / 2:

   377

            # If Viewer is the upper one, draw drop before highlight

   378

            if self.ParentWindow.IsViewerFirst(self):

   379

                self.SetHighlight(HIGHLIGHT_BEFORE)

   380

   381

            # Else draw drop after highlight in previous Viewer

   382

            else:

   383

                self.SetHighlight(HIGHLIGHT_NONE)

   384

                self.ParentWindow.HighlightPreviousViewer(self)

   385

   386

        # Mouse is in the second half of Viewer, draw drop after highlight

   387

        else:

   388

            self.SetHighlight(HIGHLIGHT_AFTER)

   389

   390

    def OnEraseBackground(self, event):

   391

        """

   392

        Function called when Viewer background is going to be erase

   393

        @param event: wx.EraseEvent

   394

        """

   395

        # Prevent flicker on Windows

   396

        pass

   397

   398

    def OnResize(self, event):

   399

        """

   400

        Function called when Viewer size changed

   401

        @param event: wx.ResizeEvent

   402

        """

   403

        # Refresh button positions

   404

        self.RefreshButtonsPosition()

   405

        self.ParentWindow.ForceRefresh()

   406

        event.Skip()

   407

   408

    def ForceValue(self, item):

   409

        """

   410

        Force value of item given

   411

        @param item: Item to force value

   412

        """

   413

        # Check variable data type

   414

        iec_path = item.GetVariable()

   415

        iec_type = self.ParentWindow.GetDataType(iec_path)

   416

        # Return immediately if not found

   417

        if iec_type is None:

   418

            return

   419

   420

        # Open a dialog to enter varaible forced value

   421

        dialog = ForceVariableDialog(self, iec_type, str(item.GetValue()))

   422

        if dialog.ShowModal() == wx.ID_OK:

   423

            self.ParentWindow.ForceDataValue(iec_path.upper(),

   424

                                             dialog.GetValue())

   425

   426

    def ReleaseValue(self, item):

   427

        """

   428

        Release value of item given

   429

        @param item: Item to release value

   430

        """

   431

        self.ParentWindow.ReleaseDataValue(

   432

                item.GetVariable().upper())