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

    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 = {

    45

}

    46

    47

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

    48

#                        Base Debug Variable Viewer Class

    49

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

    50

    51

    52

class DebugVariableViewer:

    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

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

    59

        """

    60

        Constructor

    61

        @param window: Reference to the Debug Variable Panel

    62

        @param items: List of DebugVariableItem displayed by Viewer

    63

        """

    64

        self.ParentWindow = window

    65

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

    66

                                      for item in items])

    67

        self.Items = self.ItemsDict.viewvalues()

    68

    69

        # Variable storing current highlight displayed in Viewer

    70

        self.Highlight = HIGHLIGHT_NONE

    71

        # List of buttons

    72

        self.Buttons = []

    73

        self.InitHighlightPensBrushes()

    74

    75

    def __del__(self):

    76

        """

    77

        Destructor

    78

        """

    79

        # Remove reference to Debug Variable Panel

    80

        self.ParentWindow = None

    81

    82

    def InitHighlightPensBrushes(self):

    83

        """

    84

        Init global pens and brushes

    85

        """

    86

        global HIGHLIGHT

    87

        if not HIGHLIGHT:

    88

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

    89

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

    90

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

    91

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

    92

    93

    def GetIndex(self):

    94

        """

    95

        Return position of Viewer in Debug Variable Panel

    96

        @return: Position of Viewer

    97

        """

    98

        return self.ParentWindow.GetViewerIndex(self)

    99

   100

    def GetItem(self, variable):

   101

        """

   102

        Return item storing values of a variable

   103

        @param variable: Variable path

   104

        @return: Item storing values of this variable

   105

        """

   106

        return self.ItemsDict.get(variable, None)

   107

   108

    def GetItems(self):

   109

        """

   110

        Return items displayed by Viewer

   111

        @return: List of items displayed in Viewer

   112

        """

   113

        return self.ItemsDict.values()

   114

   115

    def AddItem(self, item):

   116

        """

   117

        Add an item to the list of items displayed by Viewer

   118

        @param item: Item to add to the list

   119

        """

   120

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

   121

   122

    def RemoveItem(self, item):

   123

        """

   124

        Remove an item from the list of items displayed by Viewer

   125

        @param item: Item to remove from the list

   126

        """

   127

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

   128

   129

    def ClearItems(self):

   130

        """

   131

        Clear list of items displayed by Viewer

   132

        """

   133

        # Unsubscribe every items of the list

   134

        for item in self.Items:

   135

            self.ParentWindow.RemoveDataConsumer(item)

   136

   137

        # Clear list

   138

        self.ItemsDict.clear()

   139

   140

    def ItemsIsEmpty(self):

   141

        """

   142

        Return if list of items displayed by Viewer is empty

   143

        @return: True if list is empty

   144

        """

   145

        return len(self.Items) == 0

   146

   147

    def SubscribeAllDataConsumers(self):

   148

        """

   149

        Function that unsubscribe and remove every item that store values of

   150

        a variable that doesn't exist in PLC anymore

   151

        """

   152

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

   153

            iec_path = item.GetVariable()

   154

   155

            # Check that variablepath exist in PLC

   156

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

   157

                # If not, unsubscribe and remove it

   158

                self.ParentWindow.RemoveDataConsumer(item)

   159

                self.RemoveItem(item)

   160

            else:

   161

                # If it exist, resubscribe and refresh data type

   162

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

   163

                item.RefreshVariableType()

   164

   165

    def ResetItemsData(self):

   166

        """

   167

        Reset data stored in every items displayed in Viewer

   168

        """

   169

        for item in self.Items:

   170

            item.ResetData()

   171

   172

    def GetItemsMinCommonTick(self):

   173

        """

   174

        Return the minimum tick common to all iems displayed in Viewer

   175

        @return: Minimum common tick between items

   176

        """

   177

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

   178

                            for item in self.Items

   179

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

   180

   181

    def RefreshViewer(self):

   182

        """

   183

        Method that refresh the content displayed by Viewer

   184

        Need to be overridden by inherited classes

   185

        """

   186

        pass

   187

   188

    def SetHighlight(self, highlight):

   189

        """

   190

        Set Highlight type displayed in Viewer

   191

        @return: True if highlight has changed

   192

        """

   193

        # Return immediately if highlight don't change

   194

        if self.Highlight == highlight:

   195

            return False

   196

   197

        self.Highlight = highlight

   198

        return True

   199

   200

    def GetButtons(self):

   201

        """

   202

        Return list of buttons defined in Viewer

   203

        @return: List of buttons

   204

        """

   205

        return self.Buttons

   206

   207

    def IsOverButton(self, x, y):

   208

        """

   209

        Return if point is over one button of Viewer

   210

        @param x: X coordinate of point

   211

        @param y: Y coordinate of point

   212

        @return: button where point is over

   213

        """

   214

        for button in self.GetButtons():

   215

            if button.HitTest(x, y):

   216

                return button

   217

        return None

   218

   219

    def HandleButton(self, x, y):

   220

        """

   221

        Search for the button under point and if found execute associated

   222

        callback

   223

        @param x: X coordinate of point

   224

        @param y: Y coordinate of point

   225

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

   226

        """

   227

        button = self.IsOverButton(x, y)

   228

        if button is None:

   229

            return False

   230

   231

        button.ProcessCallback()

   232

        return True

   233

   234

    def ShowButtons(self, show):

   235

        """

   236

        Set display state of buttons in Viewer

   237

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

   238

        """

   239

        # Change display of every buttons

   240

        for button in self.Buttons:

   241

            button.Show(show)

   242

   243

        # Refresh button positions

   244

        self.RefreshButtonsPosition()

   245

        self.RefreshViewer()

   246

   247

    def RefreshButtonsPosition(self):

   248

        """

   249

        Function that refresh buttons position in Viewer

   250

        """

   251

        # Get Viewer size

   252

        width, height = self.GetSize()

   253

   254

        # Buttons are align right so we calculate buttons positions in

   255

        # reverse order

   256

        buttons = self.Buttons[:]

   257

        buttons.reverse()

   258

   259

        # Position offset on x coordinate

   260

        x_offset = 0

   261

        for button in buttons:

   262

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

   263

            if button.IsEnabled():

   264

                # Update button position according to button width and offset

   265

                # on x coordinate

   266

                w, h = button.GetSize()

   267

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

   268

                # Update offset on x coordinate

   269

                x_offset += w + 2

   270

   271

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

   272

        """

   273

        Function that draw common graphics for every Viewers

   274

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

   275

        common graphics

   276

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

   277

        (default None)

   278

        """

   279

        # Get Viewer size

   280

        width, height = self.GetSize()

   281

   282

        # Set dc styling for drop before or drop after highlight

   283

        dc.SetPen(HIGHLIGHT['DROP_PEN'])

   284

        dc.SetBrush(HIGHLIGHT['DROP_BRUSH'])

   285

   286

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

   287

        if self.Highlight == HIGHLIGHT_BEFORE:

   288

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

   289

   290

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

   291

        elif self.Highlight == HIGHLIGHT_AFTER:

   292

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

   293

   294

        # If no specific buttons are defined, get default buttons

   295

        if buttons is None:

   296

            buttons = self.Buttons

   297

        # Draw buttons

   298

        for button in buttons:

   299

            button.Draw(dc)

   300

   301

        # If graph dragging is processing

   302

        if self.ParentWindow.IsDragging():

   303

            destBBox = self.ParentWindow.GetDraggingAxesClippingRegion(self)

   304

            srcPos = self.ParentWindow.GetDraggingAxesPosition(self)

   305

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

   306

                srcPanel = self.ParentWindow.DraggingAxesPanel

   307

                srcBBox = srcPanel.GetAxesBoundingBox()

   308

   309

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

   310

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

   311

   312

                srcBmp = _convert_agg_to_wx_bitmap(

   313

                            srcPanel.get_renderer(), None)

   314

                srcDC = wx.MemoryDC()

   315

                srcDC.SelectObject(srcBmp)

   316

   317

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

   318

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

   319

                        srcDC, srcX, srcY)

   320

   321

    def OnEnter(self, event):

   322

        """

   323

        Function called when entering Viewer

   324

        @param event: wx.MouseEvent

   325

        """

   326

        # Display buttons

   327

        self.ShowButtons(True)

   328

        event.Skip()

   329

   330

    def OnLeave(self, event):

   331

        """

   332

        Function called when leaving Viewer

   333

        @param event: wx.MouseEvent

   334

        """

   335

        # Hide buttons

   336

        self.ShowButtons(False)

   337

        event.Skip()

   338

   339

    def OnCloseButton(self):

   340

        """

   341

        Function called when Close button is pressed

   342

        """

   343

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

   344

   345

    def OnForceButton(self):

   346

        """

   347

        Function called when Force button is pressed

   348

        """

   349

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

   350

   351

    def OnReleaseButton(self):

   352

        """

   353

        Function called when Release button is pressed

   354

        """

   355

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

   356

   357

    def OnMouseDragging(self, x, y):

   358

        """

   359

        Function called when mouse is dragged over Viewer

   360

        @param x: X coordinate of mouse pointer

   361

        @param y: Y coordinate of mouse pointer

   362

        """

   363

        xw, yw = self.GetPosition()

   364

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

   365

        # in another Viewer

   366

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

   367

   368

    def RefreshHighlight(self, x, y):

   369

        """

   370

        Function called by Debug Variable Panel asking Viewer to refresh

   371

        highlight according to mouse position

   372

        @param x: X coordinate of mouse pointer

   373

        @param y: Y coordinate of mouse pointer

   374

        """

   375

        # Get Viewer size

   376

        width, height = self.GetSize()

   377

   378

        # Mouse is in the first half of Viewer

   379

        if y < height / 2:

   380

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

   381

            if self.ParentWindow.IsViewerFirst(self):

   382

                self.SetHighlight(HIGHLIGHT_BEFORE)

   383

   384

            # Else draw drop after highlight in previous Viewer

   385

            else:

   386

                self.SetHighlight(HIGHLIGHT_NONE)

   387

                self.ParentWindow.HighlightPreviousViewer(self)

   388

   389

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

   390

        else:

   391

            self.SetHighlight(HIGHLIGHT_AFTER)

   392

   393

    def OnEraseBackground(self, event):

   394

        """

   395

        Function called when Viewer background is going to be erase

   396

        @param event: wx.EraseEvent

   397

        """

   398

        # Prevent flicker on Windows

   399

        pass

   400

   401

    def OnResize(self, event):

   402

        """

   403

        Function called when Viewer size changed

   404

        @param event: wx.ResizeEvent

   405

        """

   406

        # Refresh button positions

   407

        self.RefreshButtonsPosition()

   408

        self.ParentWindow.ForceRefresh()

   409

        event.Skip()

   410

   411

    def ForceValue(self, item):

   412

        """

   413

        Force value of item given

   414

        @param item: Item to force value

   415

        """

   416

        # Check variable data type

   417

        iec_path = item.GetVariable()

   418

        iec_type = self.ParentWindow.GetDataType(iec_path)

   419

        # Return immediately if not found

   420

        if iec_type is None:

   421

            return

   422

   423

        # Open a dialog to enter varaible forced value

   424

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

   425

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

   426

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

   427

                                             dialog.GetValue())

   428

   429

    def ReleaseValue(self, item):

   430

        """

   431

        Release value of item given

   432

        @param item: Item to release value

   433

        """

   434

        self.ParentWindow.ReleaseDataValue(

   435

                item.GetVariable().upper())