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

    26

from __future__ import absolute_import

    27

from collections import OrderedDict

    28

    29

import wx

    30

from matplotlib.backends.backend_wxagg import _convert_agg_to_wx_bitmap

    31

    32

from dialogs.ForceVariableDialog import ForceVariableDialog

    33

    34

# Viewer highlight types

    35

[HIGHLIGHT_NONE,

    36

 HIGHLIGHT_BEFORE,

    37

 HIGHLIGHT_AFTER,

    38

 HIGHLIGHT_LEFT,

    39

 HIGHLIGHT_RIGHT,

    40

 HIGHLIGHT_RESIZE] = range(6)

    41

    42

# Viewer highlight styles

    43

HIGHLIGHT = {

    44

}

    45

    46

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

    47

#                        Base Debug Variable Viewer Class

    48

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

    49

    50

    51

class DebugVariableViewer(object):

    52

    """

    53

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

    54

    This class has to be inherited to effectively display variable values

    55

    """

    56

    57

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

    58

        """

    59

        Constructor

    60

        @param window: Reference to the Debug Variable Panel

    61

        @param items: List of DebugVariableItem displayed by Viewer

    62

        """

    63

        self.ParentWindow = window

    64

        items = [] if items is None else items

    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

        if not HIGHLIGHT:

    87

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

    88

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

    89

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

    90

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

    91

    92

    def GetIndex(self):

    93

        """

    94

        Return position of Viewer in Debug Variable Panel

    95

        @return: Position of Viewer

    96

        """

    97

        return self.ParentWindow.GetViewerIndex(self)

    98

    99

    def GetItem(self, variable):

   100

        """

   101

        Return item storing values of a variable

   102

        @param variable: Variable path

   103

        @return: Item storing values of this variable

   104

        """

   105

        return self.ItemsDict.get(variable, None)

   106

   107

    def GetItems(self):

   108

        """

   109

        Return items displayed by Viewer

   110

        @return: List of items displayed in Viewer

   111

        """

   112

        return self.ItemsDict.values()

   113

   114

    def AddItem(self, item):

   115

        """

   116

        Add an item to the list of items displayed by Viewer

   117

        @param item: Item to add to the list

   118

        """

   119

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

   120

   121

    def RemoveItem(self, item):

   122

        """

   123

        Remove an item from the list of items displayed by Viewer

   124

        @param item: Item to remove from the list

   125

        """

   126

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

   127

   128

    def ClearItems(self):

   129

        """

   130

        Clear list of items displayed by Viewer

   131

        """

   132

        # Unsubscribe every items of the list

   133

        for item in self.Items:

   134

            self.ParentWindow.RemoveDataConsumer(item)

   135

   136

        # Clear list

   137

        self.ItemsDict.clear()

   138

   139

    def ItemsIsEmpty(self):

   140

        """

   141

        Return if list of items displayed by Viewer is empty

   142

        @return: True if list is empty

   143

        """

   144

        return len(self.Items) == 0

   145

   146

    def SubscribeAllDataConsumers(self):

   147

        """

   148

        Function that unsubscribe and remove every item that store values of

   149

        a variable that doesn't exist in PLC anymore

   150

        """

   151

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

   152

            iec_path = item.GetVariable()

   153

   154

            # Check that variablepath exist in PLC

   155

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

   156

                # If not, unsubscribe and remove it

   157

                self.ParentWindow.RemoveDataConsumer(item)

   158

                self.RemoveItem(item)

   159

            else:

   160

                # If it exist, resubscribe and refresh data type

   161

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

   162

                item.RefreshVariableType()

   163

   164

    def ResetItemsData(self):

   165

        """

   166

        Reset data stored in every items displayed in Viewer

   167

        """

   168

        for item in self.Items:

   169

            item.ResetData()

   170

   171

    def GetItemsMinCommonTick(self):

   172

        """

   173

        Return the minimum tick common to all iems displayed in Viewer

   174

        @return: Minimum common tick between items

   175

        """

   176

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

   177

                            for item in self.Items

   178

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

   179

   180

    def RefreshViewer(self):

   181

        """

   182

        Method that refresh the content displayed by Viewer

   183

        Need to be overridden by inherited classes

   184

        """

   185

        pass

   186

   187

    def SetHighlight(self, highlight):

   188

        """

   189

        Set Highlight type displayed in Viewer

   190

        @return: True if highlight has changed

   191

        """

   192

        # Return immediately if highlight don't change

   193

        if self.Highlight == highlight:

   194

            return False

   195

   196

        self.Highlight = highlight

   197

        return True

   198

   199

    def GetButtons(self):

   200

        """

   201

        Return list of buttons defined in Viewer

   202

        @return: List of buttons

   203

        """

   204

        return self.Buttons

   205

   206

    def IsOverButton(self, x, y):

   207

        """

   208

        Return if point is over one button of Viewer

   209

        @param x: X coordinate of point

   210

        @param y: Y coordinate of point

   211

        @return: button where point is over

   212

        """

   213

        for button in self.GetButtons():

   214

            if button.HitTest(x, y):

   215

                return button

   216

        return None

   217

   218

    def HandleButton(self, x, y):

   219

        """

   220

        Search for the button under point and if found execute associated

   221

        callback

   222

        @param x: X coordinate of point

   223

        @param y: Y coordinate of point

   224

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

   225

        """

   226

        button = self.IsOverButton(x, y)

   227

        if button is None:

   228

            return False

   229

   230

        button.ProcessCallback()

   231

        return True

   232

   233

    def ShowButtons(self, show):

   234

        """

   235

        Set display state of buttons in Viewer

   236

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

   237

        """

   238

        # Change display of every buttons

   239

        for button in self.Buttons:

   240

            button.Show(show)

   241

   242

        # Refresh button positions

   243

        self.RefreshButtonsPosition()

   244

        self.RefreshViewer()

   245

   246

    def RefreshButtonsPosition(self):

   247

        """

   248

        Function that refresh buttons position in Viewer

   249

        """

   250

        # Get Viewer size

   251

        width, _height = self.GetSize()

   252

   253

        # Buttons are align right so we calculate buttons positions in

   254

        # reverse order

   255

        buttons = self.Buttons[:]

   256

        buttons.reverse()

   257

   258

        # Position offset on x coordinate

   259

        x_offset = 0

   260

        for button in buttons:

   261

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

   262

            if button.IsEnabled():

   263

                # Update button position according to button width and offset

   264

                # on x coordinate

   265

                w, _h = button.GetSize()

   266

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

   267

                # Update offset on x coordinate

   268

                x_offset += w + 2

   269

   270

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

   271

        """

   272

        Function that draw common graphics for every Viewers

   273

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

   274

        common graphics

   275

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

   276

        (default None)

   277

        """

   278

        # Get Viewer size

   279

        width, height = self.GetSize()

   280

   281

        # Set dc styling for drop before or drop after highlight

   282

        dc.SetPen(HIGHLIGHT['DROP_PEN'])

   283

        dc.SetBrush(HIGHLIGHT['DROP_BRUSH'])

   284

   285

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

   286

        if self.Highlight == HIGHLIGHT_BEFORE:

   287

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

   288

   289

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

   290

        elif self.Highlight == HIGHLIGHT_AFTER:

   291

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

   292

   293

        # If no specific buttons are defined, get default buttons

   294

        if buttons is None:

   295

            buttons = self.Buttons

   296

        # Draw buttons

   297

        for button in buttons:

   298

            button.Draw(dc)

   299

   300

        # If graph dragging is processing

   301

        if self.ParentWindow.IsDragging():

   302

            destBBox = self.ParentWindow.GetDraggingAxesClippingRegion(self)

   303

            srcPos = self.ParentWindow.GetDraggingAxesPosition(self)

   304

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

   305

                srcPanel = self.ParentWindow.DraggingAxesPanel

   306

                srcBBox = srcPanel.GetAxesBoundingBox()

   307

   308

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

   309

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

   310

   311

                srcBmp = _convert_agg_to_wx_bitmap(

   312

                    srcPanel.get_renderer(), None)

   313

                srcDC = wx.MemoryDC()

   314

                srcDC.SelectObject(srcBmp)

   315

   316

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

   317

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

   318

                        srcDC, srcX, srcY)

   319

   320

    def OnEnter(self, event):

   321

        """

   322

        Function called when entering Viewer

   323

        @param event: wx.MouseEvent

   324

        """

   325

        # Display buttons

   326

        self.ShowButtons(True)

   327

        event.Skip()

   328

   329

    def OnLeave(self, event):

   330

        """

   331

        Function called when leaving Viewer

   332

        @param event: wx.MouseEvent

   333

        """

   334

        # Hide buttons

   335

        self.ShowButtons(False)

   336

        event.Skip()

   337

   338

    def OnCloseButton(self):

   339

        """

   340

        Function called when Close button is pressed

   341

        """

   342

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

   343

   344

    def OnForceButton(self):

   345

        """

   346

        Function called when Force button is pressed

   347

        """

   348

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

   349

   350

    def OnReleaseButton(self):

   351

        """

   352

        Function called when Release button is pressed

   353

        """

   354

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

   355

   356

    def OnMouseDragging(self, x, y):

   357

        """

   358

        Function called when mouse is dragged over Viewer

   359

        @param x: X coordinate of mouse pointer

   360

        @param y: Y coordinate of mouse pointer

   361

        """

   362

        xw, yw = self.GetPosition()

   363

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

   364

        # in another Viewer

   365

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

   366

   367

    def RefreshHighlight(self, x, y):

   368

        """

   369

        Function called by Debug Variable Panel asking Viewer to refresh

   370

        highlight according to mouse position

   371

        @param x: X coordinate of mouse pointer

   372

        @param y: Y coordinate of mouse pointer

   373

        """

   374

        # Get Viewer size

   375

        _width, height = self.GetSize()

   376

   377

        # Mouse is in the first half of Viewer

   378

        if y < height / 2:

   379

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

   380

            if self.ParentWindow.IsViewerFirst(self):

   381

                self.SetHighlight(HIGHLIGHT_BEFORE)

   382

   383

            # Else draw drop after highlight in previous Viewer

   384

            else:

   385

                self.SetHighlight(HIGHLIGHT_NONE)

   386

                self.ParentWindow.HighlightPreviousViewer(self)

   387

   388

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

   389

        else:

   390

            self.SetHighlight(HIGHLIGHT_AFTER)

   391

   392

    def OnEraseBackground(self, event):

   393

        """

   394

        Function called when Viewer background is going to be erase

   395

        @param event: wx.EraseEvent

   396

        """

   397

        # Prevent flicker on Windows

   398

        pass

   399

   400

    def OnResize(self, event):

   401

        """

   402

        Function called when Viewer size changed

   403

        @param event: wx.ResizeEvent

   404

        """

   405

        # Refresh button positions

   406

        self.RefreshButtonsPosition()

   407

        self.ParentWindow.ForceRefresh()

   408

        event.Skip()

   409

   410

    def ForceValue(self, item):

   411

        """

   412

        Force value of item given

   413

        @param item: Item to force value

   414

        """

   415

        # Check variable data type

   416

        iec_path = item.GetVariable()

   417

        iec_type = self.ParentWindow.GetDataType(iec_path)

   418

        # Return immediately if not found

   419

        if iec_type is None:

   420

            return

   421

   422

        # Open a dialog to enter varaible forced value

   423

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

   424

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

   425

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

   426

                                             dialog.GetValue())

   427

   428

    def ReleaseValue(self, item):

   429

        """

   430

        Release value of item given

   431

        @param item: Item to release value

   432

        """

   433

        self.ParentWindow.ReleaseDataValue(

   434

            item.GetVariable().upper())