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 time import time as gettime

    27

from cycler import cycler

    28

    29

import numpy

    30

import wx

    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

from controls.DebugVariablePanel.DebugVariableViewer import *

    40

from controls.DebugVariablePanel.GraphButton import GraphButton

    41

    42

    43

# Graph variable display type

    44

GRAPH_PARALLEL, GRAPH_ORTHOGONAL = list(range(2))

    45

    46

# Canvas height

    47

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

    48

    49

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

    50

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

    51

VALUE_LABEL_HEIGHT = 17.    # Height of variable label in graph

    52

AXES_LABEL_HEIGHT = 12.75   # Height of variable value in graph

    53

    54

# Colors used cyclically for graph curves

    55

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

    56

# Color for graph cursor

    57

CURSOR_COLOR = '#800080'

    58

    59

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

    60

#                      Debug Variable Graphic Viewer Helpers

    61

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

    62

    63

    64

def merge_ranges(ranges):

    65

    """

    66

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

    67

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

    68

    around graph in canvas

    69

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

    70

    @return: merged_range_min_value, merged_range_max_value

    71

    """

    72

    # Get minimal and maximal range value

    73

    min_value = max_value = None

    74

    for range_min, range_max in ranges:

    75

        # Update minimal range value

    76

        if min_value is None:

    77

            min_value = range_min

    78

        elif range_min is not None:

    79

            min_value = min(min_value, range_min)

    80

    81

        # Update maximal range value

    82

        if max_value is None:

    83

            max_value = range_max

    84

        elif range_min is not None:

    85

            max_value = max(max_value, range_max)

    86

    87

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

    88

    if min_value is not None and max_value is not None:

    89

        center = (min_value + max_value) / 2.

    90

        range_size = max(1.0, max_value - min_value)

    91

    92

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

    93

    else:

    94

        center = 0.5

    95

        range_size = 1.0

    96

    97

    # Return range expended from 10 %

    98

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

    99

   100

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

   101

#                   Debug Variable Graphic Viewer Drop Target

   102

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

   103

   104

   105

class DebugVariableGraphicDropTarget(wx.TextDropTarget):

   106

    """

   107

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

   108

    Viewer

   109

    """

   110

   111

    def __init__(self, parent, window):

   112

        """

   113

        Constructor

   114

        @param parent: Reference to Debug Variable Graphic Viewer

   115

        @param window: Reference to the Debug Variable Panel

   116

        """

   117

        wx.TextDropTarget.__init__(self)

   118

        self.ParentControl = parent

   119

        self.ParentWindow = window

   120

   121

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

   122

        """

   123

        Function called when mouse is dragged over Drop Target

   124

        @param x: X coordinate of mouse pointer

   125

        @param y: Y coordinate of mouse pointer

   126

        @param d: Suggested default for return value

   127

        """

   128

        # Signal parent that mouse is dragged over

   129

        self.ParentControl.OnMouseDragging(x, y)

   130

   131

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

   132

   133

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

   134

        """

   135

        Function called when mouse is released in Drop Target

   136

        @param x: X coordinate of mouse pointer

   137

        @param y: Y coordinate of mouse pointer

   138

        @param data: Text associated to drag'n drop

   139

        """

   140

        # Signal Debug Variable Panel to reset highlight

   141

        self.ParentWindow.ResetHighlight()

   142

   143

        message = None

   144

   145

        # Check that data is valid regarding DebugVariablePanel

   146

        try:

   147

            values = eval(data)

   148

            if not isinstance(values, tuple):

   149

                raise ValueError

   150

        except Exception:

   151

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

   152

            values = None

   153

   154

        # Display message if data is invalid

   155

        if message is not None:

   156

            wx.CallAfter(self.ShowMessage, message)

   157

            return False

   158

   159

        # Data contain a reference to a variable to debug

   160

        elif values[1] == "debug":

   161

            target_idx = self.ParentControl.GetIndex()

   162

   163

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

   164

            # not 3D canvas, graphs will be merged

   165

            rect = self.ParentControl.GetAxesBoundingBox()

   166

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

   167

                # Default merge type is parallel

   168

                merge_type = GRAPH_PARALLEL

   169

   170

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

   171

                # wall be merged orthogonally

   172

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

   173

                                     rect.width / 2., rect.height)

   174

                if merge_rect.Contains(x, y):

   175

                    merge_type = GRAPH_ORTHOGONAL

   176

   177

                # Merge graphs

   178

                wx.CallAfter(self.ParentWindow.MergeGraphs,

   179

                             values[0], target_idx,

   180

                             merge_type, force=True)

   181

   182

            else:

   183

                _width, height = self.ParentControl.GetSize()

   184

   185

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

   186

                # according to the position of mouse in Viewer.

   187

                if y > height // 2:

   188

                    target_idx += 1

   189

   190

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

   191

                # Variable Panel

   192

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

   193

                    self.ParentWindow.MoveValue(values[0],

   194

                                                target_idx)

   195

   196

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

   197

                else:

   198

                    self.ParentWindow.InsertValue(values[0],

   199

                                                  target_idx,

   200

                                                  force=True)

   201

            return True

   202

        return False

   203

   204

    def OnLeave(self):

   205

        """

   206

        Function called when mouse is leave Drop Target

   207

        """

   208

        # Signal Debug Variable Panel to reset highlight

   209

        self.ParentWindow.ResetHighlight()

   210

        return wx.TextDropTarget.OnLeave(self)

   211

   212

    def ShowMessage(self, message):

   213

        """

   214

        Show error message in Error Dialog

   215

        @param message: Error message to display

   216

        """

   217

        dialog = wx.MessageDialog(self.ParentWindow,

   218

                                  message,

   219

                                  _("Error"),

   220

                                  wx.OK | wx.ICON_ERROR)

   221

        dialog.ShowModal()

   222

        dialog.Destroy()

   223

   224

   225

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

   226

#                      Debug Variable Graphic Viewer Class

   227

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

   228

   229

   230

class DebugVariableGraphicViewer(DebugVariableViewer, FigureCanvas):

   231

    """

   232

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

   233

    """

   234

   235

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

   236

        """

   237

        Constructor

   238

        @param parent: Parent wx.Window of DebugVariableText

   239

        @param window: Reference to the Debug Variable Panel

   240

        @param items: List of DebugVariableItem displayed by Viewer

   241

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

   242

        """

   243

        DebugVariableViewer.__init__(self, window, items)

   244

   245

        self.GraphType = graph_type        # Graph type display

   246

        self.CursorTick = None             # Tick of the graph cursor

   247

   248

        # Mouse position when start dragging

   249

        self.MouseStartPos = None

   250

        # Tick when moving tick start

   251

        self.StartCursorTick = None

   252

        # Canvas size when starting to resize canvas

   253

        self.CanvasStartSize = None

   254

   255

        # List of current displayed contextual buttons

   256

        self.ContextualButtons = []

   257

        # Reference to item for which contextual buttons was displayed

   258

        self.ContextualButtonsItem = None

   259

   260

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

   261

        # data range if False

   262

        self.ZoomFit = False

   263

   264

        # Create figure for drawing graphs

   265

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

   266

        # Defined border around figure in canvas

   267

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

   268

                                       bottom=0.1, right=0.95)

   269

   270

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

   271

        self.SetWindowStyle(wx.WANTS_CHARS)

   272

   273

        # Bind wx events

   274

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

   275

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

   276

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

   277

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

   278

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

   279

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

   280

   281

        # Set canvas min size

   282

        canvas_size = self.GetCanvasMinSize()

   283

        self.SetMinSize(canvas_size)

   284

   285

        # Define Viewer drop target

   286

        self.SetDropTarget(DebugVariableGraphicDropTarget(self, window))

   287

   288

        # Connect matplotlib events

   289

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

   290

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

   291

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

   292

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

   293

   294

        # Add buttons for zooming on current displayed data range

   295

        self.Buttons.append(

   296

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

   297

   298

        # Add buttons for changing canvas size with predefined height

   299

        for size, bitmap in zip(

   300

                [SIZE_MINI, SIZE_MIDDLE, SIZE_MAXI],

   301

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

   302

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

   303

                                            self.GetOnChangeSizeButton(size)))

   304

   305

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

   306

        for bitmap, callback in [

   307

                ("export_graph_mini", self.OnExportGraphButton),

   308

                ("delete_graph", self.OnCloseButton)]:

   309

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

   310

   311

        # Update graphs elements

   312

        self.ResetGraphics()

   313

        self.RefreshLabelsPosition(canvas_size.height)

   314

   315

    def AddItem(self, item):

   316

        """

   317

        Add an item to the list of items displayed by Viewer

   318

        @param item: Item to add to the list

   319

        """

   320

        DebugVariableViewer.AddItem(self, item)

   321

        self.ResetGraphics()

   322

   323

    def RemoveItem(self, item):

   324

        """

   325

        Remove an item from the list of items displayed by Viewer

   326

        @param item: Item to remove from the list

   327

        """

   328

        DebugVariableViewer.RemoveItem(self, item)

   329

   330

        # If list of items is not empty

   331

        if not self.ItemsIsEmpty():

   332

            # Return to parallel graph if there is only one item

   333

            # especially if it's actually orthogonal

   334

            if len(self.Items) == 1:

   335

                self.GraphType = GRAPH_PARALLEL

   336

            self.ResetGraphics()

   337

   338

    def SetCursorTick(self, cursor_tick):

   339

        """

   340

        Set cursor tick

   341

        @param cursor_tick: Cursor tick

   342

        """

   343

        self.CursorTick = cursor_tick

   344

   345

    def SetZoomFit(self, zoom_fit):

   346

        """

   347

        Set flag indicating that zoom fit current displayed data range

   348

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

   349

        """

   350

        # Flag is different from the actual one

   351

        if zoom_fit != self.ZoomFit:

   352

            # Save new flag value

   353

            self.ZoomFit = zoom_fit

   354

   355

            # Update button for zoom fit bitmap

   356

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

   357

   358

            # Refresh canvas

   359

            self.RefreshViewer()

   360

   361

    def SubscribeAllDataConsumers(self):

   362

        """

   363

        Function that unsubscribe and remove every item that store values of

   364

        a variable that doesn't exist in PLC anymore

   365

        """

   366

        DebugVariableViewer.SubscribeAllDataConsumers(self)

   367

   368

        # Graph still have data to display

   369

        if not self.ItemsIsEmpty():

   370

            # Reset flag indicating that zoom fit current displayed data range

   371

            self.SetZoomFit(False)

   372

   373

            self.ResetGraphics()

   374

   375

    def Is3DCanvas(self):

   376

        """

   377

        Return if Viewer is a 3D canvas

   378

        @return: True if Viewer is a 3D canvas

   379

        """

   380

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

   381

   382

    def GetButtons(self):

   383

        """

   384

        Return list of buttons defined in Viewer

   385

        @return: List of buttons

   386

        """

   387

        # Add contextual buttons to default buttons

   388

        return self.Buttons + self.ContextualButtons

   389

   390

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

   391

        """

   392

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

   393

        by the bounding box of label in figure

   394

        @param item: Item for which contextual is shown

   395

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

   396

        @param direction: Direction in which buttons must be drawn

   397

        """

   398

        # Return immediately if contextual menu for item is already shown

   399

        if self.ContextualButtonsItem == item:

   400

            return

   401

   402

        # Close already shown contextual menu

   403

        self.DismissContextualButtons()

   404

   405

        # Save item for which contextual menu is shown

   406

        self.ContextualButtonsItem = item

   407

   408

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

   409

        # contextual menu

   410

        if self.ContextualButtonsItem.IsForced():

   411

            self.ContextualButtons.append(

   412

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

   413

   414

        # Add other buttons to contextual menu

   415

        for bitmap, callback in [

   416

                ("force", self.OnForceItemButton),

   417

                ("export_graph_mini", self.OnExportItemGraphButton),

   418

                ("delete_graph", self.OnRemoveItemButton)]:

   419

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

   420

   421

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

   422

        # will be set in reverse order

   423

        buttons = self.ContextualButtons[:]

   424

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

   425

            buttons.reverse()

   426

   427

        # Set contextual menu buttons position aside rect depending on

   428

        # direction given

   429

        offset = 0

   430

        for button in buttons:

   431

            w, h = button.GetSize()

   432

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

   433

                x = rect.x + (- w - offset

   434

                              if direction == wx.LEFT

   435

                              else rect.width + offset)

   436

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

   437

                offset += w

   438

            else:

   439

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

   440

                y = rect.y + (- h - offset

   441

                              if direction == wx.TOP

   442

                              else rect.height + offset)

   443

                offset += h

   444

            button.SetPosition(x, y)

   445

            button.Show()

   446

   447

        # Refresh canvas

   448

        self.ParentWindow.ForceRefresh()

   449

   450

    def DismissContextualButtons(self):

   451

        """

   452

        Close current shown contextual menu

   453

        """

   454

        # Return immediately if no contextual menu is shown

   455

        if self.ContextualButtonsItem is None:

   456

            return

   457

   458

        # Reset variables corresponding to contextual menu

   459

        self.ContextualButtonsItem = None

   460

        self.ContextualButtons = []

   461

   462

        # Refresh canvas

   463

        self.ParentWindow.ForceRefresh()

   464

   465

    def IsOverContextualButton(self, x, y):

   466

        """

   467

        Return if point is over one contextual button of Viewer

   468

        @param x: X coordinate of point

   469

        @param y: Y coordinate of point

   470

        @return: contextual button where point is over

   471

        """

   472

        for button in self.ContextualButtons:

   473

            if button.HitTest(x, y):

   474

                return button

   475

        return None

   476

   477

    def ExportGraph(self, item=None):

   478

        """

   479

        Export item(s) data to clipboard in CSV format

   480

        @param item: Item from which data to export, all items if None

   481

        (default None)