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 types import TupleType

    26

from time import time as gettime

    27

import numpy

    28

    29

import wx

    30

    31

import matplotlib

    32

import matplotlib.pyplot

    33

from matplotlib.backends.backend_wxagg import FigureCanvasWxAgg as FigureCanvas

    34

from matplotlib.backends.backend_wxagg import _convert_agg_to_wx_bitmap

    35

from matplotlib.backends.backend_agg import FigureCanvasAgg

    36

from mpl_toolkits.mplot3d import Axes3D

    37

    38

from editors.DebugViewer import REFRESH_PERIOD

    39

    40

from DebugVariableItem import DebugVariableItem

    41

from DebugVariableViewer import *

    42

from GraphButton import GraphButton

    43

    44

    45

from distutils.version import LooseVersion

    46

if LooseVersion(matplotlib.__version__) >= LooseVersion("1.5.0"):

    47

    from cycler import cycler

    48

    49

    50

# Graph variable display type

    51

GRAPH_PARALLEL, GRAPH_ORTHOGONAL = range(2)

    52

    53

# Canvas height

    54

[SIZE_MINI, SIZE_MIDDLE, SIZE_MAXI] = [0, 100, 200]

    55

    56

CANVAS_BORDER = (20., 10.)  # Border height on at bottom and top of graph

    57

CANVAS_PADDING = 8.5        # Border inside graph where no label is drawn

    58

VALUE_LABEL_HEIGHT = 17.    # Height of variable label in graph

    59

AXES_LABEL_HEIGHT = 12.75   # Height of variable value in graph

    60

    61

# Colors used cyclically for graph curves

    62

COLOR_CYCLE = ['r', 'b', 'g', 'm', 'y', 'k']

    63

# Color for graph cursor

    64

CURSOR_COLOR = '#800080'

    65

    66

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

    67

#                      Debug Variable Graphic Viewer Helpers

    68

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

    69

    70

    71

def merge_ranges(ranges):

    72

    """

    73

    Merge variables data range in a list to return a range of minimal min range

    74

    value and maximal max range value extended of 10% for keeping a padding

    75

    around graph in canvas

    76

    @param ranges: [(range_min_value, range_max_value),...]

    77

    @return: merged_range_min_value, merged_range_max_value

    78

    """

    79

    # Get minimal and maximal range value

    80

    min_value = max_value = None

    81

    for range_min, range_max in ranges:

    82

        # Update minimal range value

    83

        if min_value is None:

    84

            min_value = range_min

    85

        elif range_min is not None:

    86

            min_value = min(min_value, range_min)

    87

    88

        # Update maximal range value

    89

        if max_value is None:

    90

            max_value = range_max

    91

        elif range_min is not None:

    92

            max_value = max(max_value, range_max)

    93

    94

    # Calculate range center and width if at least one valid range is defined

    95

    if min_value is not None and max_value is not None:

    96

        center = (min_value + max_value) / 2.

    97

        range_size = max(1.0, max_value - min_value)

    98

    99

    # Set default center and with if no valid range is defined

   100

    else:

   101

        center = 0.5

   102

        range_size = 1.0

   103

   104

    # Return range expended from 10 %

   105

    return center - range_size * 0.55, center + range_size * 0.55

   106

   107

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

   108

#                   Debug Variable Graphic Viewer Drop Target

   109

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

   110

   111

   112

class DebugVariableGraphicDropTarget(wx.TextDropTarget):

   113

    """

   114

    Class that implements a custom drop target class for Debug Variable Graphic

   115

    Viewer

   116

    """

   117

   118

    def __init__(self, parent, window):

   119

        """

   120

        Constructor

   121

        @param parent: Reference to Debug Variable Graphic Viewer

   122

        @param window: Reference to the Debug Variable Panel

   123

        """

   124

        wx.TextDropTarget.__init__(self)

   125

        self.ParentControl = parent

   126

        self.ParentWindow = window

   127

   128

    def __del__(self):

   129

        """

   130

        Destructor

   131

        """

   132

        # Remove reference to Debug Variable Graphic Viewer and Debug Variable

   133

        # Panel

   134

        self.ParentControl = None

   135

        self.ParentWindow = None

   136

   137

    def OnDragOver(self, x, y, d):

   138

        """

   139

        Function called when mouse is dragged over Drop Target

   140

        @param x: X coordinate of mouse pointer

   141

        @param y: Y coordinate of mouse pointer

   142

        @param d: Suggested default for return value

   143

        """

   144

        # Signal parent that mouse is dragged over

   145

        self.ParentControl.OnMouseDragging(x, y)

   146

   147

        return wx.TextDropTarget.OnDragOver(self, x, y, d)

   148

   149

    def OnDropText(self, x, y, data):

   150

        """

   151

        Function called when mouse is released in Drop Target

   152

        @param x: X coordinate of mouse pointer

   153

        @param y: Y coordinate of mouse pointer

   154

        @param data: Text associated to drag'n drop

   155

        """

   156

        # Signal Debug Variable Panel to reset highlight

   157

        self.ParentWindow.ResetHighlight()

   158

   159

        message = None

   160

   161

        # Check that data is valid regarding DebugVariablePanel

   162

        try:

   163

            values = eval(data)

   164

            if not isinstance(values, TupleType):

   165

                raise ValueError

   166

        except:

   167

            message = _("Invalid value \"%s\" for debug variable") % data

   168

            values = None

   169

   170

        # Display message if data is invalid

   171

        if message is not None:

   172

            wx.CallAfter(self.ShowMessage, message)

   173

   174

        # Data contain a reference to a variable to debug

   175

        elif values[1] == "debug":

   176

            target_idx = self.ParentControl.GetIndex()

   177

   178

            # If mouse is dropped in graph canvas bounding box and graph is

   179

            # not 3D canvas, graphs will be merged

   180

            rect = self.ParentControl.GetAxesBoundingBox()

   181

            if not self.ParentControl.Is3DCanvas() and rect.InsideXY(x, y):

   182

                # Default merge type is parallel

   183

                merge_type = GRAPH_PARALLEL

   184

   185

                # If mouse is dropped in left part of graph canvas, graph

   186

                # wall be merged orthogonally

   187

                merge_rect = wx.Rect(rect.x, rect.y,

   188

                                     rect.width / 2., rect.height)

   189

                if merge_rect.InsideXY(x, y):

   190

                    merge_type = GRAPH_ORTHOGONAL

   191

   192

                # Merge graphs

   193

                wx.CallAfter(self.ParentWindow.MergeGraphs,

   194

                             values[0], target_idx,

   195

                             merge_type, force=True)

   196

   197

            else:

   198

                width, height = self.ParentControl.GetSize()

   199

   200

                # Get Before which Viewer the variable has to be moved or added

   201

                # according to the position of mouse in Viewer.

   202

                if y > height / 2:

   203

                    target_idx += 1

   204

   205

                # Drag'n Drop is an internal is an internal move inside Debug

   206

                # Variable Panel

   207

                if len(values) > 2 and values[2] == "move":

   208

                    self.ParentWindow.MoveValue(values[0],

   209

                                                target_idx)

   210

   211

                # Drag'n Drop was initiated by another control of Beremiz

   212

                else:

   213

                    self.ParentWindow.InsertValue(values[0],

   214

                                                  target_idx,

   215

                                                  force=True)

   216

   217

    def OnLeave(self):

   218

        """

   219

        Function called when mouse is leave Drop Target

   220

        """

   221

        # Signal Debug Variable Panel to reset highlight

   222

        self.ParentWindow.ResetHighlight()

   223

        return wx.TextDropTarget.OnLeave(self)

   224

   225

    def ShowMessage(self, message):

   226

        """

   227

        Show error message in Error Dialog

   228

        @param message: Error message to display

   229

        """

   230

        dialog = wx.MessageDialog(self.ParentWindow,

   231

                                  message,

   232

                                  _("Error"),

   233

                                  wx.OK|wx.ICON_ERROR)

   234

        dialog.ShowModal()

   235

        dialog.Destroy()

   236

   237

   238

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

   239

#                      Debug Variable Graphic Viewer Class

   240

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

   241

   242

   243

class DebugVariableGraphicViewer(DebugVariableViewer, FigureCanvas):

   244

    """

   245

    Class that implements a Viewer that display variable values as a graphs

   246

    """

   247

   248

    def __init__(self, parent, window, items, graph_type):

   249

        """

   250

        Constructor

   251

        @param parent: Parent wx.Window of DebugVariableText

   252

        @param window: Reference to the Debug Variable Panel

   253

        @param items: List of DebugVariableItem displayed by Viewer

   254

        @param graph_type: Graph display type (Parallel or orthogonal)

   255

        """

   256

        DebugVariableViewer.__init__(self, window, items)

   257

   258

        self.GraphType = graph_type        # Graph type display

   259

        self.CursorTick = None             # Tick of the graph cursor

   260

   261

        # Mouse position when start dragging

   262

        self.MouseStartPos = None

   263

        # Tick when moving tick start

   264

        self.StartCursorTick = None

   265

        # Canvas size when starting to resize canvas

   266

        self.CanvasStartSize = None

   267

   268

        # List of current displayed contextual buttons

   269

        self.ContextualButtons = []

   270

        # Reference to item for which contextual buttons was displayed

   271

        self.ContextualButtonsItem = None

   272

   273

        # Flag indicating that zoom fit current displayed data range or whole

   274

        # data range if False

   275

        self.ZoomFit = False

   276

   277

        # Create figure for drawing graphs

   278

        self.Figure = matplotlib.figure.Figure(facecolor='w')

   279

        # Defined border around figure in canvas

   280

        self.Figure.subplotpars.update(top=0.95, left=0.1,

   281

                                       bottom=0.1, right=0.95)

   282

   283

        FigureCanvas.__init__(self, parent, -1, self.Figure)

   284

        self.SetWindowStyle(wx.WANTS_CHARS)

   285

        self.SetBackgroundColour(wx.WHITE)

   286

   287

        # Bind wx events

   288

        self.Bind(wx.EVT_LEFT_DCLICK, self.OnLeftDClick)

   289

        self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)

   290

        self.Bind(wx.EVT_ENTER_WINDOW, self.OnEnter)

   291

        self.Bind(wx.EVT_LEAVE_WINDOW, self.OnLeave)

   292

        self.Bind(wx.EVT_ERASE_BACKGROUND, self.OnEraseBackground)

   293

        self.Bind(wx.EVT_SIZE, self.OnResize)

   294

   295

        # Set canvas min size

   296

        canvas_size = self.GetCanvasMinSize()

   297

        self.SetMinSize(canvas_size)

   298

   299

        # Define Viewer drop target

   300

        self.SetDropTarget(DebugVariableGraphicDropTarget(self, window))

   301

   302

        # Connect matplotlib events

   303

        self.mpl_connect('button_press_event', self.OnCanvasButtonPressed)

   304

        self.mpl_connect('motion_notify_event', self.OnCanvasMotion)

   305

        self.mpl_connect('button_release_event', self.OnCanvasButtonReleased)

   306

        self.mpl_connect('scroll_event', self.OnCanvasScroll)

   307

   308

        # Add buttons for zooming on current displayed data range

   309

        self.Buttons.append(

   310

                GraphButton(0, 0, "fit_graph", self.OnZoomFitButton))

   311

   312

        # Add buttons for changing canvas size with predefined height

   313

        for size, bitmap in zip(

   314

                [SIZE_MINI, SIZE_MIDDLE, SIZE_MAXI],

   315

                ["minimize_graph", "middle_graph", "maximize_graph"]):

   316

            self.Buttons.append(

   317

                    GraphButton(0, 0, bitmap,

   318

                                self.GetOnChangeSizeButton(size)))

   319

   320

        # Add buttons for exporting graph values to clipboard and close graph

   321

        for bitmap, callback in [

   322

                ("export_graph_mini", self.OnExportGraphButton),

   323

                ("delete_graph", self.OnCloseButton)]:

   324

            self.Buttons.append(GraphButton(0, 0, bitmap, callback))

   325

   326

        # Update graphs elements

   327

        self.ResetGraphics()

   328

        self.RefreshLabelsPosition(canvas_size.height)

   329

   330

    def AddItem(self, item):

   331

        """

   332

        Add an item to the list of items displayed by Viewer

   333

        @param item: Item to add to the list

   334

        """

   335

        DebugVariableViewer.AddItem(self, item)

   336

        self.ResetGraphics()

   337

   338

    def RemoveItem(self, item):

   339

        """

   340

        Remove an item from the list of items displayed by Viewer

   341

        @param item: Item to remove from the list

   342

        """

   343

        DebugVariableViewer.RemoveItem(self, item)

   344

   345

        # If list of items is not empty

   346

        if not self.ItemsIsEmpty():

   347

            # Return to parallel graph if there is only one item

   348

            # especially if it's actually orthogonal

   349

            if len(self.Items) == 1:

   350

                self.GraphType = GRAPH_PARALLEL

   351

            self.ResetGraphics()

   352

   353

    def SetCursorTick(self, cursor_tick):

   354

        """

   355

        Set cursor tick

   356

        @param cursor_tick: Cursor tick

   357

        """

   358

        self.CursorTick = cursor_tick

   359

   360

    def SetZoomFit(self, zoom_fit):

   361

        """

   362

        Set flag indicating that zoom fit current displayed data range

   363

        @param zoom_fit: Flag for zoom fit (False: zoom fit whole data range)

   364

        """

   365

        # Flag is different from the actual one

   366

        if zoom_fit != self.ZoomFit:

   367

            # Save new flag value

   368

            self.ZoomFit = zoom_fit

   369

   370

            # Update button for zoom fit bitmap

   371

            self.Buttons[0].SetBitmap("full_graph" if zoom_fit else "fit_graph")

   372

   373

            # Refresh canvas

   374

            self.RefreshViewer()

   375

   376

    def SubscribeAllDataConsumers(self):

   377

        """

   378

        Function that unsubscribe and remove every item that store values of

   379

        a variable that doesn't exist in PLC anymore

   380

        """

   381

        DebugVariableViewer.SubscribeAllDataConsumers(self)

   382

   383

        # Graph still have data to display

   384

        if not self.ItemsIsEmpty():

   385

            # Reset flag indicating that zoom fit current displayed data range

   386

            self.SetZoomFit(False)

   387

   388

            self.ResetGraphics()

   389

   390

    def Is3DCanvas(self):

   391

        """

   392

        Return if Viewer is a 3D canvas

   393

        @return: True if Viewer is a 3D canvas

   394

        """

   395

        return self.GraphType == GRAPH_ORTHOGONAL and len(self.Items) == 3

   396

   397

    def GetButtons(self):

   398

        """

   399

        Return list of buttons defined in Viewer

   400

        @return: List of buttons

   401

        """

   402

        # Add contextual buttons to default buttons

   403

        return self.Buttons + self.ContextualButtons

   404

   405

    def PopupContextualButtons(self, item, rect, direction=wx.RIGHT):

   406

        """

   407

        Show contextual menu for item aside a label of this item defined

   408

        by the bounding box of label in figure

   409

        @param item: Item for which contextual is shown

   410

        @param rect: Bounding box of label aside which drawing menu

   411

        @param direction: Direction in which buttons must be drawn

   412

        """

   413

        # Return immediately if contextual menu for item is already shown

   414

        if self.ContextualButtonsItem == item:

   415

            return

   416

   417

        # Close already shown contextual menu

   418

        self.DismissContextualButtons()

   419

   420

        # Save item for which contextual menu is shown

   421

        self.ContextualButtonsItem = item

   422

   423

        # If item variable is forced, add button for release variable to

   424

        # contextual menu

   425

        if self.ContextualButtonsItem.IsForced():

   426

            self.ContextualButtons.append(

   427

                GraphButton(0, 0, "release", self.OnReleaseItemButton))

   428

   429

        # Add other buttons to contextual menu

   430

        for bitmap, callback in [

   431

                ("force", self.OnForceItemButton),

   432

                ("export_graph_mini", self.OnExportItemGraphButton),

   433

                ("delete_graph", self.OnRemoveItemButton)]:

   434

            self.ContextualButtons.append(

   435

                    GraphButton(0, 0, bitmap, callback))

   436

   437

        # If buttons are shown at left side or upper side of rect, positions

   438

        # will be set in reverse order

   439

        buttons = self.ContextualButtons[:]

   440

        if direction in [wx.TOP, wx.LEFT]:

   441

             buttons.reverse()

   442

   443

        # Set contextual menu buttons position aside rect depending on

   444

        # direction given

   445

        offset = 0

   446

        for button in buttons:

   447

            w, h = button.GetSize()

   448

            if direction in [wx.LEFT, wx.RIGHT]:

   449

                x = rect.x + (- w - offset

   450

                            if direction == wx.LEFT

   451

                            else rect.width + offset)

   452

                y = rect.y + (rect.height - h) / 2

   453

                offset += w

   454

            else:

   455

                x = rect.x + (rect.width - w ) / 2

   456

                y = rect.y + (- h - offset

   457

                              if direction == wx.TOP

   458

                              else rect.height + offset)

   459

                offset += h

   460

            button.SetPosition(x, y)

   461

            button.Show()

   462

   463

        # Refresh canvas

   464

        self.ParentWindow.ForceRefresh()

   465

   466

    def DismissContextualButtons(self):

   467

        """

   468

        Close current shown contextual menu

   469

        """

   470

        # Return immediately if no contextual menu is shown

   471

        if self.ContextualButtonsItem is None:

   472

            return

   473

   474

        # Reset variables corresponding to contextual menu

   475

        self.ContextualButtonsItem = None

   476

        self.ContextualButtons = []

   477

   478

        # Refresh canvas

   479

        self.ParentWindow.ForceRefresh()

   480

   481

    def IsOverContextualButton(self, x, y):

   482

        """

   483

        Return if point is over one contextual button of Viewer