1

#!/usr/bin/env python

     2

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

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

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

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

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

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

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

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

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

    22

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

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

from collections import OrderedDict

    26

    27

import wx

    28

    29

import matplotlib

    30

import matplotlib.pyplot

    31

from matplotlib.backends.backend_wxagg import _convert_agg_to_wx_bitmap

    32

    33

from dialogs.ForceVariableDialog import ForceVariableDialog

    34

    35

# Viewer highlight types

    36

[HIGHLIGHT_NONE,

    37

 HIGHLIGHT_BEFORE,

    38

 HIGHLIGHT_AFTER,

    39

 HIGHLIGHT_LEFT,

    40

 HIGHLIGHT_RIGHT,

    41

 HIGHLIGHT_RESIZE] = range(6)

    42

    43

# Viewer highlight styles

    44

HIGHLIGHT_DROP_PEN = wx.Pen(wx.Colour(0, 128, 255))

    45

HIGHLIGHT_DROP_BRUSH = wx.Brush(wx.Colour(0, 128, 255, 128))

    46

HIGHLIGHT_RESIZE_PEN = wx.Pen(wx.Colour(200, 200, 200))

    47

HIGHLIGHT_RESIZE_BRUSH = wx.Brush(wx.Colour(200, 200, 200))

    48

    49

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

    50

#                        Base Debug Variable Viewer Class

    51

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

    52

    53

"""

    54

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

    55

This class has to be inherited to effectively display variable values

    56

"""

    57

    58

class DebugVariableViewer:

    59

    60

    def __init__(self, window, items=[]):

    61

        """

    62

        Constructor

    63

        @param window: Reference to the Debug Variable Panel

    64

        @param items: List of DebugVariableItem displayed by Viewer

    65

        """

    66

        self.ParentWindow = window

    67

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

    68

                                      for item in items])

    69

        self.Items = self.ItemsDict.viewvalues()

    70

    71

        # Variable storing current highlight displayed in Viewer

    72

        self.Highlight = HIGHLIGHT_NONE

    73

        # List of buttons

    74

        self.Buttons = []

    75

    76

    def __del__(self):

    77

        """

    78

        Destructor

    79

        """

    80

        # Remove reference to Debug Variable Panel

    81

        self.ParentWindow = None

    82

    83

    def GetIndex(self):

    84

        """

    85

        Return position of Viewer in Debug Variable Panel

    86

        @return: Position of Viewer

    87

        """

    88

        return self.ParentWindow.GetViewerIndex(self)

    89

    90

    def GetItem(self, variable):

    91

        """

    92

        Return item storing values of a variable

    93

        @param variable: Variable path

    94

        @return: Item storing values of this variable

    95

        """

    96

        return self.ItemsDict.get(variable, None)

    97

    98

    def GetItems(self):

    99

        """

   100

        Return items displayed by Viewer

   101

        @return: List of items displayed in Viewer

   102

        """

   103

        return self.ItemsDict.values()

   104

   105

    def AddItem(self, item):

   106

        """

   107

        Add an item to the list of items displayed by Viewer

   108

        @param item: Item to add to the list

   109

        """

   110

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

   111

   112

    def RemoveItem(self, item):

   113

        """

   114

        Remove an item from the list of items displayed by Viewer

   115

        @param item: Item to remove from the list

   116

        """

   117

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

   118

   119

    def ClearItems(self):

   120

        """

   121

        Clear list of items displayed by Viewer

   122

        """

   123

        # Unsubscribe every items of the list

   124

        for item in self.Items:

   125

            self.ParentWindow.RemoveDataConsumer(item)

   126

   127

        # Clear list

   128

        self.ItemsDict.clear()

   129

   130

    def ItemsIsEmpty(self):

   131

        """

   132

        Return if list of items displayed by Viewer is empty

   133

        @return: True if list is empty

   134

        """

   135

        return len(self.Items) == 0

   136

   137

    def SubscribeAllDataConsumers(self):

   138

        """

   139

        Function that unsubscribe and remove every item that store values of

   140

        a variable that doesn't exist in PLC anymore

   141

        """

   142

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

   143

            iec_path = item.GetVariable()

   144

   145

            # Check that variablepath exist in PLC

   146

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

   147

                # If not, unsubscribe and remove it

   148

                self.ParentWindow.RemoveDataConsumer(item)

   149

                self.RemoveItem(item)

   150

            else:

   151

                # If it exist, resubscribe and refresh data type

   153

                item.RefreshVariableType()

   154

   155

    def ResetItemsData(self):

   156

        """

   157

        Reset data stored in every items displayed in Viewer

   158

        """

   159

        for item in self.Items:

   160

            item.ResetData()

   161

   162

    def GetItemsMinCommonTick(self):

   163

        """

   164

        Return the minimum tick common to all iems displayed in Viewer

   165

        @return: Minimum common tick between items

   166

        """

   167

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

   168

                            for item in self.Items

   169

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

   170

   171

    def RefreshViewer(self):

   172

        """

   173

        Method that refresh the content displayed by Viewer

   174

        Need to be overridden by inherited classes

   175

        """

   176

        pass

   177

   178

    def SetHighlight(self, highlight):

   179

        """

   180

        Set Highlight type displayed in Viewer

   181

        @return: True if highlight has changed

   182

        """

   183

        # Return immediately if highlight don't change

   184

        if self.Highlight == highlight:

   185

            return False

   186

   187

        self.Highlight = highlight

   188

        return True

   189

   190

    def GetButtons(self):

   191

        """

   192

        Return list of buttons defined in Viewer

   193

        @return: List of buttons

   194

        """

   195

        return self.Buttons

   196

   197

    def IsOverButton(self, x, y):

   198

        """

   199

        Return if point is over one button of Viewer

   200

        @param x: X coordinate of point

   201

        @param y: Y coordinate of point

   202

        @return: button where point is over

   203

        """

   204

        for button in self.GetButtons():

   205

            if button.HitTest(x, y):

   206

                return button

   207

        return None

   208

   209

    def HandleButton(self, x, y):

   210

        """

   211

        Search for the button under point and if found execute associated

   212

        callback

   213

        @param x: X coordinate of point

   214

        @param y: Y coordinate of point

   215

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

   216

        """

   217

        button = self.IsOverButton(x, y)

   218

        if button is None:

   219

            return False

   220

   221

        button.ProcessCallback()

   222

        return True

   223

   224

    def ShowButtons(self, show):

   225

        """

   226

        Set display state of buttons in Viewer

   227

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

   228

        """

   229

        # Change display of every buttons

   230

        for button in self.Buttons:

   231

            button.Show(show)

   232

   233

        # Refresh button positions

   234

        self.RefreshButtonsPosition()

   235

        self.RefreshViewer()

   236

   237

    def RefreshButtonsPosition(self):

   238

        """

   239

        Function that refresh buttons position in Viewer

   240

        """

   241

        # Get Viewer size

   242

        width, height = self.GetSize()

   243

   244

        # Buttons are align right so we calculate buttons positions in

   245

        # reverse order

   246

        buttons = self.Buttons[:]

   247

        buttons.reverse()

   248

   249

        # Position offset on x coordinate

   250

        x_offset = 0

   251

        for button in buttons:

   252

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

   253

            if button.IsEnabled():

   254

                # Update button position according to button width and offset

   255

                # on x coordinate

   256

                w, h = button.GetSize()

   257

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

   258

                # Update offset on x coordinate

   259

                x_offset += w + 2

   260

   261

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

   262

        """

   263

        Function that draw common graphics for every Viewers

   264

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

   265

        common graphics

   266

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

   267

        (default None)

   268

        """

   269

        # Get Viewer size

   270

        width, height = self.GetSize()

   271

   272

        # Set dc styling for drop before or drop after highlight

   273

        dc.SetPen(HIGHLIGHT_DROP_PEN)

   274

        dc.SetBrush(HIGHLIGHT_DROP_BRUSH)

   275

   276

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

   277

        if self.Highlight == HIGHLIGHT_BEFORE:

   278

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

   279

   280

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

   281

        elif self.Highlight == HIGHLIGHT_AFTER:

   282

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

   283

   284

        # If no specific buttons are defined, get default buttons

   285

        if buttons is None:

   286

            buttons = self.Buttons

   287

        # Draw buttons

   288

        for button in buttons:

   289

            button.Draw(dc)

   290

   291

        # If graph dragging is processing

   292

        if self.ParentWindow.IsDragging():

   293

            destBBox = self.ParentWindow.GetDraggingAxesClippingRegion(self)

   294

            srcPos = self.ParentWindow.GetDraggingAxesPosition(self)

   295

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

   296

                srcPanel = self.ParentWindow.DraggingAxesPanel

   297

                srcBBox = srcPanel.GetAxesBoundingBox()

   298

   299

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

   300

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

   301

   302

                srcBmp = _convert_agg_to_wx_bitmap(

   303

                            srcPanel.get_renderer(), None)

   304

                srcDC = wx.MemoryDC()

   305

                srcDC.SelectObject(srcBmp)

   306

   307

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

   308

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

   309

                        srcDC, srcX, srcY)

   310

   311

    def OnEnter(self, event):

   312

        """

   313

        Function called when entering Viewer

   314

        @param event: wx.MouseEvent 

   315

        """

   316

        # Display buttons

   317

        self.ShowButtons(True)

   318

        event.Skip()

   319

   320

    def OnLeave(self, event):

   321

        """

   322

        Function called when leaving Viewer

   323

        @param event: wx.MouseEvent 

   324

        """

   325

        # Hide buttons

   326

        self.ShowButtons(False)

   327

        event.Skip()

   328

   329

    def OnCloseButton(self):

   330

        """

   331

        Function called when Close button is pressed

   332

        """

   333

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

   334

   335

    def OnForceButton(self):

   336

        """

   337

        Function called when Force button is pressed

   338

        """

   339

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

   340

   341

    def OnReleaseButton(self):

   342

        """

   343

        Function called when Release button is pressed

   344

        """

   345

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

   346

   347

    def OnMouseDragging(self, x, y):

   348

        """

   349

        Function called when mouse is dragged over Viewer

   350

        @param x: X coordinate of mouse pointer

   351

        @param y: Y coordinate of mouse pointer

   352

        """

   353

        xw, yw = self.GetPosition()

   354

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

   355

        # in another Viewer

   356

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

   357

   358

    def RefreshHighlight(self, x, y):

   359

        """

   360

        Function called by Debug Variable Panel asking Viewer to refresh

   361

        highlight according to mouse position

   362

        @param x: X coordinate of mouse pointer

   363

        @param y: Y coordinate of mouse pointer

   364

        """

   365

        # Get Viewer size

   366

        width, height = self.GetSize()

   367

   368

        # Mouse is in the first half of Viewer

   369

        if y < height / 2:

   370

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

   371

            if self.ParentWindow.IsViewerFirst(self):

   372

                self.SetHighlight(HIGHLIGHT_BEFORE)

   373

   374

            # Else draw drop after highlight in previous Viewer

   375

            else:

   376

                self.SetHighlight(HIGHLIGHT_NONE)

   377

                self.ParentWindow.HighlightPreviousViewer(self)

   378

   379

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

   380

        else:

   381

            self.SetHighlight(HIGHLIGHT_AFTER)

   382

   383

    def OnEraseBackground(self, event):

   384

        """

   385

        Function called when Viewer background is going to be erase

   386

        @param event: wx.EraseEvent

   387

        """

   388

        # Prevent flicker on Windows

   389

        pass

   390

   391

    def OnResize(self, event):

   392

        """

   393

        Function called when Viewer size changed

   394

        @param event: wx.ResizeEvent

   395

        """

   396

        # Refresh button positions

   397

        self.RefreshButtonsPosition()

   398

        self.ParentWindow.ForceRefresh()

   399

        event.Skip()

   400

   401

    def ForceValue(self, item):

   402

        """

   403

        Force value of item given

   404

        @param item: Item to force value

   405

        """

   406

        # Check variable data type

   407

        iec_path = item.GetVariable()

   408

        iec_type = self.ParentWindow.GetDataType(iec_path)

   409

        # Return immediately if not found

   410

        if iec_type is None:

   411

            return

   412

   413

        # Open a dialog to enter varaible forced value

   414

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

   415

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

   416

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

   417

                                             dialog.GetValue())

   418

   419

    def ReleaseValue(self, item):

   420

        """

   421

        Release value of item given

   422

        @param item: Item to release value

   423

        """

   424

        self.ParentWindow.ReleaseDataValue(

   425

                item.GetVariable().upper())