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 __future__ import division

    28

from collections import OrderedDict

    29

from functools import reduce

    30

    31

import wx

    32

from matplotlib.backends.backend_wxagg import _convert_agg_to_wx_bitmap

    33

    34

from dialogs.ForceVariableDialog import ForceVariableDialog

    35

    36

# Viewer highlight types

    37

[HIGHLIGHT_NONE,

    38

 HIGHLIGHT_BEFORE,

    39

 HIGHLIGHT_AFTER,

    40

 HIGHLIGHT_LEFT,

    41

 HIGHLIGHT_RIGHT,

    42

 HIGHLIGHT_RESIZE] = range(6)

    43

    44

# Viewer highlight styles

    45

HIGHLIGHT = {

    46

}

    47

    48

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

    49

#                        Base Debug Variable Viewer Class

    50

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

    51

    52

    53

class DebugVariableViewer(object):

    54

    """

    55

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

    56

    This class has to be inherited to effectively display variable values

    57

    """

    58

    59

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

    60

        """

    61

        Constructor

    62

        @param window: Reference to the Debug Variable Panel

    63

        @param items: List of DebugVariableItem displayed by Viewer

    64

        """

    65

        self.ParentWindow = window

    66

        items = [] if items is None else items

    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

        self.InitHighlightPensBrushes()

    76

    77

    def __del__(self):

    78

        """

    79

        Destructor

    80

        """

    81

        # Remove reference to Debug Variable Panel

    82

        self.ParentWindow = None

    83

    84

    def InitHighlightPensBrushes(self):

    85

        """

    86

        Init global pens and brushes

    87

        """

    88

        if not HIGHLIGHT:

    89

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

    90

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

    91

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

    92

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

    93

    94

    def GetIndex(self):

    95

        """

    96

        Return position of Viewer in Debug Variable Panel

    97

        @return: Position of Viewer

    98

        """

    99

        return self.ParentWindow.GetViewerIndex(self)

   100

   101

    def GetItem(self, variable):

   102

        """

   103

        Return item storing values of a variable

   104

        @param variable: Variable path

   105

        @return: Item storing values of this variable

   106

        """

   107

        return self.ItemsDict.get(variable, None)

   108

   109

    def GetItems(self):

   110

        """

   111

        Return items displayed by Viewer

   112

        @return: List of items displayed in Viewer

   113

        """

   114

        return self.ItemsDict.values()

   115

   116

    def AddItem(self, item):

   117

        """

   118

        Add an item to the list of items displayed by Viewer

   119

        @param item: Item to add to the list

   120

        """

   121

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

   122

   123

    def RemoveItem(self, item):

   124

        """

   125

        Remove an item from the list of items displayed by Viewer

   126

        @param item: Item to remove from the list

   127

        """

   128

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

   129

   130

    def ClearItems(self):

   131

        """

   132

        Clear list of items displayed by Viewer

   133

        """

   134

        # Unsubscribe every items of the list

   135

        for item in self.Items:

   136

            self.ParentWindow.RemoveDataConsumer(item)

   137

   138

        # Clear list

   139

        self.ItemsDict.clear()

   140

   141

    def ItemsIsEmpty(self):

   142

        """

   143

        Return if list of items displayed by Viewer is empty

   144

        @return: True if list is empty

   145

        """

   146

        return len(self.Items) == 0

   147

   148

    def SubscribeAllDataConsumers(self):

   149

        """

   150

        Function that unsubscribe and remove every item that store values of

   151

        a variable that doesn't exist in PLC anymore

   152

        """

   153

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

   154

            iec_path = item.GetVariable()

   155

   156

            # Check that variablepath exist in PLC

   157

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

   158

                # If not, unsubscribe and remove it

   159

                self.ParentWindow.RemoveDataConsumer(item)

   160

                self.RemoveItem(item)

   161

            else:

   162

                # If it exist, resubscribe and refresh data type

   163

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

   164

                item.RefreshVariableType()

   165

   166

    def ResetItemsData(self):

   167

        """

   168

        Reset data stored in every items displayed in Viewer

   169

        """

   170

        for item in self.Items:

   171

            item.ResetData()

   172

   173

    def GetItemsMinCommonTick(self):

   174

        """

   175

        Return the minimum tick common to all iems displayed in Viewer

   176

        @return: Minimum common tick between items

   177

        """

   178

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

   179

                            for item in self.Items

   180

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

   181

   182

    def RefreshViewer(self):

   183

        """

   184

        Method that refresh the content displayed by Viewer

   185

        Need to be overridden by inherited classes

   186

        """

   187

        pass

   188

   189

    def SetHighlight(self, highlight):

   190

        """

   191

        Set Highlight type displayed in Viewer

   192

        @return: True if highlight has changed

   193

        """

   194

        # Return immediately if highlight don't change

   195

        if self.Highlight == highlight:

   196

            return False

   197

   198

        self.Highlight = highlight

   199

        return True

   200

   201

    def GetButtons(self):

   202

        """

   203

        Return list of buttons defined in Viewer

   204

        @return: List of buttons

   205

        """

   206

        return self.Buttons

   207

   208

    def IsOverButton(self, x, y):

   209

        """

   210

        Return if point is over one button of Viewer

   211

        @param x: X coordinate of point

   212

        @param y: Y coordinate of point

   213

        @return: button where point is over

   214

        """

   215

        for button in self.GetButtons():

   216

            if button.HitTest(x, y):

   217

                return button

   218

        return None

   219

   220

    def HandleButton(self, x, y):

   221

        """

   222

        Search for the button under point and if found execute associated

   223

        callback

   224

        @param x: X coordinate of point

   225

        @param y: Y coordinate of point

   226

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

   227

        """

   228

        button = self.IsOverButton(x, y)

   229

        if button is None:

   230

            return False

   231

   232

        button.ProcessCallback()

   233

        return True

   234

   235

    def ShowButtons(self, show):

   236

        """

   237

        Set display state of buttons in Viewer

   238

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

   239

        """

   240

        # Change display of every buttons

   241

        for button in self.Buttons:

   242

            button.Show(show)

   243

   244

        # Refresh button positions

   245

        self.RefreshButtonsPosition()

   246

        self.RefreshViewer()

   247

   248

    def RefreshButtonsPosition(self):

   249

        """

   250

        Function that refresh buttons position in Viewer

   251

        """

   252

        # Get Viewer size

   253

        width, _height = self.GetSize()

   254

   255

        # Buttons are align right so we calculate buttons positions in

   256

        # reverse order

   257

        buttons = self.Buttons[:]

   258

        buttons.reverse()

   259

   260

        # Position offset on x coordinate

   261

        x_offset = 0

   262

        for button in buttons:

   263

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

   264

            if button.IsEnabled():

   265

                # Update button position according to button width and offset

   266

                # on x coordinate

   267

                w, _h = button.GetSize()

   268

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

   269

                # Update offset on x coordinate

   270

                x_offset += w + 2

   271

   272

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

   273

        """

   274

        Function that draw common graphics for every Viewers

   275

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

   276

        common graphics

   277

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

   278

        (default None)

   279

        """

   280

        # Get Viewer size

   281

        width, height = self.GetSize()

   282

   283

        # Set dc styling for drop before or drop after highlight

   284

        dc.SetPen(HIGHLIGHT['DROP_PEN'])

   285

        dc.SetBrush(HIGHLIGHT['DROP_BRUSH'])

   286

   287

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

   288

        if self.Highlight == HIGHLIGHT_BEFORE:

   289

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

   290

   291

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

   292

        elif self.Highlight == HIGHLIGHT_AFTER:

   293

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

   294

   295

        # If no specific buttons are defined, get default buttons

   296

        if buttons is None:

   297

            buttons = self.Buttons

   298

        # Draw buttons

   299

        for button in buttons:

   300

            button.Draw(dc)

   301

   302

        # If graph dragging is processing

   303

        if self.ParentWindow.IsDragging():

   304

            destBBox = self.ParentWindow.GetDraggingAxesClippingRegion(self)

   305

            srcPos = self.ParentWindow.GetDraggingAxesPosition(self)

   306

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

   307

                srcPanel = self.ParentWindow.DraggingAxesPanel

   308

                srcBBox = srcPanel.GetAxesBoundingBox()

   309

   310

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

   311

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

   312

   313

                srcBmp = _convert_agg_to_wx_bitmap(

   314

                    srcPanel.get_renderer(), None)

   315

                srcDC = wx.MemoryDC()

   316

                srcDC.SelectObject(srcBmp)

   317

   318

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

   319

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

   320

                        srcDC, srcX, srcY)

   321

   322

    def OnEnter(self, event):

   323

        """

   324

        Function called when entering Viewer

   325

        @param event: wx.MouseEvent

   326

        """

   327

        # Display buttons

   328

        self.ShowButtons(True)

   329

        event.Skip()

   330

   331

    def OnLeave(self, event):

   332

        """

   333

        Function called when leaving Viewer

   334

        @param event: wx.MouseEvent

   335

        """

   336

        # Hide buttons

   337

        self.ShowButtons(False)

   338

        event.Skip()

   339

   340

    def OnCloseButton(self):

   341

        """

   342

        Function called when Close button is pressed

   343

        """

   344

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

   345

   346

    def OnForceButton(self):

   347

        """

   348

        Function called when Force button is pressed

   349

        """

   350

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

   351

   352

    def OnReleaseButton(self):

   353

        """

   354

        Function called when Release button is pressed

   355

        """

   356

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

   357

   358

    def OnMouseDragging(self, x, y):

   359

        """

   360

        Function called when mouse is dragged over Viewer

   361

        @param x: X coordinate of mouse pointer

   362

        @param y: Y coordinate of mouse pointer

   363

        """

   364

        xw, yw = self.GetPosition()

   365

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

   366

        # in another Viewer

   367

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

   368

   369

    def RefreshHighlight(self, x, y):

   370

        """

   371

        Function called by Debug Variable Panel asking Viewer to refresh

   372

        highlight according to mouse position

   373

        @param x: X coordinate of mouse pointer

   374

        @param y: Y coordinate of mouse pointer

   375

        """

   376

        # Get Viewer size

   377

        _width, height = self.GetSize()

   378

   379

        # Mouse is in the first half of Viewer

   380

        if y < height // 2:

   381

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

   382

            if self.ParentWindow.IsViewerFirst(self):

   383

                self.SetHighlight(HIGHLIGHT_BEFORE)

   384

   385

            # Else draw drop after highlight in previous Viewer

   386

            else:

   387

                self.SetHighlight(HIGHLIGHT_NONE)

   388

                self.ParentWindow.HighlightPreviousViewer(self)

   389

   390

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

   391

        else:

   392

            self.SetHighlight(HIGHLIGHT_AFTER)

   393

   394

    def OnEraseBackground(self, event):

   395

        """

   396

        Function called when Viewer background is going to be erase

   397

        @param event: wx.EraseEvent

   398

        """

   399

        # Prevent flicker on Windows

   400

        pass

   401

   402

    def OnResize(self, event):

   403

        """

   404

        Function called when Viewer size changed

   405

        @param event: wx.ResizeEvent

   406

        """

   407

        # Refresh button positions

   408

        self.RefreshButtonsPosition()

   409

        self.ParentWindow.ForceRefresh()

   410

        event.Skip()

   411

   412

    def ForceValue(self, item):

   413

        """

   414

        Force value of item given

   415

        @param item: Item to force value

   416

        """

   417

        # Check variable data type

   418

        iec_path = item.GetVariable()

   419

        iec_type = self.ParentWindow.GetDataType(iec_path)

   420

        # Return immediately if not found

   421

        if iec_type is None:

   422

            return

   423

   424

        # Open a dialog to enter varaible forced value

   425

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

   426

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

   427

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

   428

                                             dialog.GetValue())

   429

   430

    def ReleaseValue(self, item):

   431

        """

   432

        Release value of item given

   433

        @param item: Item to release value

   434

        """

   435

        self.ParentWindow.ReleaseDataValue(

   436

            item.GetVariable().upper())