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

    28

import numpy

    29

    30

import wx

    31

import wx.lib.buttons

    32

    33

    34

# pylint: disable=wrong-import-position

    35

import matplotlib

    36

matplotlib.use('WX')   # noqa

    37

import matplotlib.pyplot

    38

from matplotlib.backends.backend_wxagg import _convert_agg_to_wx_bitmap

    39

    40

    41

from editors.DebugViewer import DebugViewer

    42

from util.BitmapLibrary import GetBitmap

    43

    44

from controls.DebugVariablePanel.DebugVariableItem import DebugVariableItem

    45

from controls.DebugVariablePanel.DebugVariableTextViewer import DebugVariableTextViewer

    46

from controls.DebugVariablePanel.DebugVariableGraphicViewer import *

    47

    48

    49

MILLISECOND = 1000000        # Number of nanosecond in a millisecond

    50

SECOND = 1000 * MILLISECOND  # Number of nanosecond in a second

    51

MINUTE = 60 * SECOND         # Number of nanosecond in a minute

    52

HOUR = 60 * MINUTE           # Number of nanosecond in a hour

    53

DAY = 24 * HOUR              # Number of nanosecond in a day

    54

    55

# List of values possible for graph range

    56

# Format is [(time_in_plain_text, value_in_nanosecond),...]

    57

RANGE_VALUES = \

    58

    [(_("%dms") % i, i * MILLISECOND) for i in (10, 20, 50, 100, 200, 500)] + \

    59

    [(_("%ds") % i, i * SECOND) for i in (1, 2, 5, 10, 20, 30)] + \

    60

    [(_("%dm") % i, i * MINUTE) for i in (1, 2, 5, 10, 20, 30)] + \

    61

    [(_("%dh") % i, i * HOUR) for i in (1, 2, 3, 6, 12, 24)]

    62

    63

# Scrollbar increment in pixel

    64

SCROLLBAR_UNIT = 10

    65

    66

    67

def compute_mask(x, y):

    68

    return [(xp if xp == yp else "*")

    69

            for xp, yp in zip(x, y)]

    70

    71

    72

def NextTick(variables):

    73

    next_tick = None

    74

    for _item, data in variables:

    75

        if len(data) == 0:

    76

            continue

    77

    78

        next_tick = (data[0][0]

    79

                     if next_tick is None

    80

                     else min(next_tick, data[0][0]))

    81

    82

    return next_tick

    83

    84

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

    85

#                    Debug Variable Graphic Panel Drop Target

    86

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

    87

    88

    89

class DebugVariableDropTarget(wx.TextDropTarget):

    90

    """

    91

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

    92

    Panel

    93

    """

    94

    95

    def __init__(self, window):

    96

        """

    97

        Constructor

    98

        @param window: Reference to the Debug Variable Panel

    99

        """

   100

        wx.TextDropTarget.__init__(self)

   101

        self.ParentWindow = window

   102

   103

    def __del__(self):

   104

        """

   105

        Destructor

   106

        """

   107

        # Remove reference to Debug Variable Panel

   108

        self.ParentWindow = None

   109

   110

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

   111

        """

   112

        Function called when mouse is dragged over Drop Target

   113

        @param x: X coordinate of mouse pointer

   114

        @param y: Y coordinate of mouse pointer

   115

        @param d: Suggested default for return value

   116

        """

   117

        # Signal Debug Variable Panel to refresh highlight giving mouse position

   118

        self.ParentWindow.RefreshHighlight(x, y)

   119

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

   120

   121

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

   122

        """

   123

        Function called when mouse is released in Drop Target

   124

        @param x: X coordinate of mouse pointer

   125

        @param y: Y coordinate of mouse pointer

   126

        @param data: Text associated to drag'n drop

   127

        """

   128

        # Signal Debug Variable Panel to reset highlight

   129

        self.ParentWindow.ResetHighlight()

   130

   131

        message = None

   132

   133

        # Check that data is valid regarding DebugVariablePanel

   134

        try:

   135

            values = eval(data)

   136

            if not isinstance(values, TupleType):

   137

                raise ValueError

   138

        except Exception:

   139

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

   140

            values = None

   141

   142

        # Display message if data is invalid

   143

        if message is not None:

   144

            wx.CallAfter(self.ShowMessage, message)

   145

   146

        # Data contain a reference to a variable to debug

   147

        elif values[1] == "debug":

   148

   149

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

   150

            # Variable Panel

   151

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

   152

                self.ParentWindow.MoveValue(values[0])

   153

   154

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

   155

            else:

   156

                self.ParentWindow.InsertValue(values[0], force=True)

   157

   158

    def OnLeave(self):

   159

        """

   160

        Function called when mouse is leave Drop Target

   161

        """

   162

        # Signal Debug Variable Panel to reset highlight

   163

        self.ParentWindow.ResetHighlight()

   164

        return wx.TextDropTarget.OnLeave(self)

   165

   166

    def ShowMessage(self, message):

   167

        """

   168

        Show error message in Error Dialog

   169

        @param message: Error message to display

   170

        """

   171

        dialog = wx.MessageDialog(self.ParentWindow,

   172

                                  message,

   173

                                  _("Error"),

   174

                                  wx.OK | wx.ICON_ERROR)

   175

        dialog.ShowModal()

   176

        dialog.Destroy()

   177

   178

   179

class DebugVariablePanel(wx.Panel, DebugViewer):

   180

    """

   181

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

   182

    """

   183

   184

    def __init__(self, parent, producer, window):

   185

        """

   186

        Constructor

   187

        @param parent: Reference to the parent wx.Window

   188

        @param producer: Object receiving debug value and dispatching them to

   189

        consumers

   190

        @param window: Reference to Beremiz frame

   191

        """

   192

        wx.Panel.__init__(self, parent, style=wx.SP_3D | wx.TAB_TRAVERSAL)

   193

   194

        # Save Reference to Beremiz frame

   195

        self.ParentWindow = window

   196

   197

        # Variable storing flag indicating that variable displayed in table

   198

        # received new value and then table need to be refreshed

   199

        self.HasNewData = False

   200

   201

        # Variable storing flag indicating that refresh has been forced, and

   202

        # that next time refresh is possible, it will be done even if no new

   203

        # data is available

   204

        self.Force = False

   205

   206

        self.SetBackgroundColour(wx.WHITE)

   207

   208

        main_sizer = wx.BoxSizer(wx.VERTICAL)

   209

   210

        self.Ticks = numpy.array([])  # List of tick received

   211

        self.StartTick = 0            # Tick starting range of data displayed

   212

        self.Fixed = False            # Flag that range of data is fixed

   213

        self.CursorTick = None        # Tick of cursor for displaying values

   214

   215

        self.DraggingAxesPanel = None

   216

        self.DraggingAxesBoundingBox = None

   217

        self.DraggingAxesMousePos = None

   218

        self.VetoScrollEvent = False

   219

   220

        self.VariableNameMask = []

   221

   222

        self.GraphicPanels = []

   223

   224

        graphics_button_sizer = wx.BoxSizer(wx.HORIZONTAL)

   225

        main_sizer.AddSizer(graphics_button_sizer, border=5, flag=wx.GROW | wx.ALL)

   226

   227

        range_label = wx.StaticText(self, label=_('Range:'))

   228

        graphics_button_sizer.AddWindow(range_label, flag=wx.ALIGN_CENTER_VERTICAL)

   229

   230

        self.CanvasRange = wx.ComboBox(self, style=wx.CB_READONLY)

   231

        self.Bind(wx.EVT_COMBOBOX, self.OnRangeChanged, self.CanvasRange)

   232

        graphics_button_sizer.AddWindow(self.CanvasRange, 1,

   233

                                        border=5,

   234

                                        flag=wx.LEFT | wx.ALIGN_CENTER_VERTICAL)

   235

   236

        self.CanvasRange.Clear()

   237

        default_range_idx = 0

   238

        for idx, (text, _value) in enumerate(RANGE_VALUES):

   239

            self.CanvasRange.Append(text)

   240

            if _value == 1000000000:

   241

                default_range_idx = idx

   242

        self.CanvasRange.SetSelection(default_range_idx)

   243

   244

        for name, bitmap, help in [

   245

                ("CurrentButton",     "current",      _("Go to current value")),

   246

                ("ExportGraphButton", "export_graph", _("Export graph values to clipboard"))]:

   247

            button = wx.lib.buttons.GenBitmapButton(

   248

                self, bitmap=GetBitmap(bitmap),

   249

                size=wx.Size(28, 28), style=wx.NO_BORDER)

   250

            button.SetToolTipString(help)

   251

            setattr(self, name, button)

   252

            self.Bind(wx.EVT_BUTTON, getattr(self, "On" + name), button)

   253

            graphics_button_sizer.AddWindow(button, border=5, flag=wx.LEFT)

   254

   255

        self.CanvasPosition = wx.ScrollBar(

   256

            self, size=wx.Size(0, 16), style=wx.SB_HORIZONTAL)

   257

        self.CanvasPosition.Bind(wx.EVT_SCROLL_THUMBTRACK,

   258

                                 self.OnPositionChanging, self.CanvasPosition)

   259

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEUP,

   260

                                 self.OnPositionChanging, self.CanvasPosition)

   261

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEDOWN,

   262

                                 self.OnPositionChanging, self.CanvasPosition)

   263

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEUP,

   264

                                 self.OnPositionChanging, self.CanvasPosition)

   265

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEDOWN,

   266

                                 self.OnPositionChanging, self.CanvasPosition)

   267

        main_sizer.AddWindow(self.CanvasPosition, border=5, flag=wx.GROW | wx.LEFT | wx.RIGHT | wx.BOTTOM)

   268

   269

        self.TickSizer = wx.BoxSizer(wx.HORIZONTAL)

   270

        main_sizer.AddSizer(self.TickSizer, border=5, flag=wx.ALL | wx.GROW)

   271

   272

        self.TickLabel = wx.StaticText(self)

   273

        self.TickSizer.AddWindow(self.TickLabel, border=5, flag=wx.RIGHT)

   274

   275

        self.MaskLabel = wx.TextCtrl(self, style=wx.TE_READONLY | wx.TE_CENTER | wx.NO_BORDER)

   276

        self.TickSizer.AddWindow(self.MaskLabel, 1, border=5, flag=wx.RIGHT | wx.GROW)

   277

   278

        self.TickTimeLabel = wx.StaticText(self)

   279

        self.TickSizer.AddWindow(self.TickTimeLabel)

   280

   281

        self.GraphicsWindow = wx.ScrolledWindow(self, style=wx.HSCROLL | wx.VSCROLL)

   282

        self.GraphicsWindow.SetBackgroundColour(wx.WHITE)

   283

        self.GraphicsWindow.SetDropTarget(DebugVariableDropTarget(self))

   284

        self.GraphicsWindow.Bind(wx.EVT_ERASE_BACKGROUND, self.OnGraphicsWindowEraseBackground)

   285

        self.GraphicsWindow.Bind(wx.EVT_PAINT, self.OnGraphicsWindowPaint)

   286

        self.GraphicsWindow.Bind(wx.EVT_SIZE, self.OnGraphicsWindowResize)

   287

        self.GraphicsWindow.Bind(wx.EVT_MOUSEWHEEL, self.OnGraphicsWindowMouseWheel)

   288

   289

        main_sizer.AddWindow(self.GraphicsWindow, 1, flag=wx.GROW)

   290

   291

        self.GraphicsSizer = wx.BoxSizer(wx.VERTICAL)

   292

        self.GraphicsWindow.SetSizer(self.GraphicsSizer)

   293

   294

        DebugViewer.__init__(self, producer, True)

   295

   296

        self.SetSizer(main_sizer)

   297

        self.SetTickTime()

   298

   299

    def SetTickTime(self, ticktime=0):

   300

        """

   301

        Set Ticktime for calculate data range according to time range selected

   302

        @param ticktime: Ticktime to apply to range (default: 0)

   303

        """

   304

        # Save ticktime

   305

        self.Ticktime = ticktime

   306

   307

        # Set ticktime to millisecond if undefined

   308

        if self.Ticktime == 0:

   309

            self.Ticktime = MILLISECOND

   310

   311

        # Calculate range to apply to data

   312

        self.CurrentRange = RANGE_VALUES[

   313

            self.CanvasRange.GetSelection()][1] / self.Ticktime

   314

   315

    def SetDataProducer(self, producer):

   316

        """

   317

        Set Data Producer

   318

        @param producer: Data Producer

   319

        """

   320

        DebugViewer.SetDataProducer(self, producer)

   321

   322

        # Set ticktime if data producer is available

   323

        if self.DataProducer is not None:

   324

            self.SetTickTime(self.DataProducer.GetTicktime())

   325

   326

    def RefreshNewData(self):

   327

        """

   328

        Called to refresh Panel according to values received by variables

   329

        Can receive any parameters (not used here)

   330

        """

   331

        # Refresh graphs if new data is available or refresh is forced

   332

        if self.HasNewData or self.Force:

   333

            self.HasNewData = False

   334

            self.RefreshView()

   335

   336

        DebugViewer.RefreshNewData(self)

   337

   338

    def NewDataAvailable(self, ticks):

   339

        """

   340

        Called by DataProducer for each tick captured or by panel to refresh

   341

        graphs

   342

        @param tick: PLC tick captured

   343

        All other parameters are passed to refresh function

   344

        """

   345

        # If tick given

   346

        if ticks is not None:

   347

            tick = ticks[-1]

   348

   349

            # Save tick as start tick for range if data is still empty

   350

            if len(self.Ticks) == 0:

   351

                self.StartTick = ticks[0]

   352

   353

            # Add tick to list of ticks received

   354

            self.Ticks = numpy.append(self.Ticks, ticks)

   355

   356

            # Update start tick for range if range follow ticks received

   357

            if not self.Fixed or tick < self.StartTick + self.CurrentRange:

   358

                self.StartTick = max(self.StartTick, tick - self.CurrentRange)

   359

   360

            # Force refresh if graph is fixed because range of data received

   361

            # is too small to fill data range selected

   362

            if self.Fixed and \

   363

               self.Ticks[-1] - self.Ticks[0] < self.CurrentRange:

   364

                self.Force = True

   365

   366

            self.HasNewData = False

   367

            self.RefreshView()

   368

   369

        else:

   370

            DebugViewer.NewDataAvailable(self, ticks)

   371

   372

    def ForceRefresh(self):

   373

        """

   374

        Called to force refresh of graphs

   375

        """

   376

        self.Force = True

   377

        wx.CallAfter(self.NewDataAvailable, None)

   378

   379

    def SetCursorTick(self, cursor_tick):

   380

        """

   381

        Set Cursor for displaying values of items at a tick given

   382

        @param cursor_tick: Tick of cursor

   383

        """

   384

        # Save cursor tick

   385

        self.CursorTick = cursor_tick

   386

        self.Fixed = cursor_tick is not None

   387

        self.UpdateCursorTick()

   388

   389

    def MoveCursorTick(self, move):

   390

        if self.CursorTick is not None:

   391

            cursor_tick = max(self.Ticks[0],

   392

                              min(self.CursorTick + move, self.Ticks[-1]))

   393

            cursor_tick_idx = numpy.argmin(numpy.abs(self.Ticks - cursor_tick))

   394

            if self.Ticks[cursor_tick_idx] == self.CursorTick:

   395

                cursor_tick_idx = max(0,

   396

                                      min(cursor_tick_idx + abs(move) / move,

   397

                                          len(self.Ticks) - 1))

   398

            self.CursorTick = self.Ticks[cursor_tick_idx]

   399

            self.StartTick = max(

   400

                self.Ticks[numpy.argmin(

   401

                    numpy.abs(self.Ticks - self.CursorTick + self.CurrentRange))],

   402

                min(self.StartTick, self.CursorTick))

   403

            self.RefreshCanvasPosition()

   404

            self.UpdateCursorTick()

   405

   406

    def ResetCursorTick(self):

   407

        self.CursorTick = None

   408

        self.Fixed = False

   409

        self.UpdateCursorTick()

   410

   411

    def UpdateCursorTick(self):

   412

        for panel in self.GraphicPanels:

   413

            if isinstance(panel, DebugVariableGraphicViewer):

   414

                panel.SetCursorTick(self.CursorTick)

   415

        self.ForceRefresh()

   416

   417

    def StartDragNDrop(self, panel, item, x_mouse, y_mouse, x_mouse_start, y_mouse_start):

   418

        if len(panel.GetItems()) > 1:

   419

            self.DraggingAxesPanel = DebugVariableGraphicViewer(self.GraphicsWindow, self, [item], GRAPH_PARALLEL)

   420

            self.DraggingAxesPanel.SetCursorTick(self.CursorTick)

   421

            width, height = panel.GetSize()

   422

            self.DraggingAxesPanel.SetSize(wx.Size(width, height))

   423

            self.DraggingAxesPanel.ResetGraphics()

   424

            self.DraggingAxesPanel.SetPosition(wx.Point(0, -height))

   425

        else:

   426

            self.DraggingAxesPanel = panel

   427

        self.DraggingAxesBoundingBox = panel.GetAxesBoundingBox(parent_coordinate=True)

   428

        self.DraggingAxesMousePos = wx.Point(

   429

            x_mouse_start - self.DraggingAxesBoundingBox.x,

   430

            y_mouse_start - self.DraggingAxesBoundingBox.y)

   431

        self.MoveDragNDrop(x_mouse, y_mouse)

   432

   433

    def MoveDragNDrop(self, x_mouse, y_mouse):

   434

        self.DraggingAxesBoundingBox.x = x_mouse - self.DraggingAxesMousePos.x

   435

        self.DraggingAxesBoundingBox.y = y_mouse - self.DraggingAxesMousePos.y

   436

        self.RefreshHighlight(x_mouse, y_mouse)

   437

   438

    def RefreshHighlight(self, x_mouse, y_mouse):

   439

        for idx, panel in enumerate(self.GraphicPanels):

   440

            x, y = panel.GetPosition()

   441

            width, height = panel.GetSize()

   442

            rect = wx.Rect(x, y, width, height)

   443

            if rect.InsideXY(x_mouse, y_mouse) or \

   444

               idx == 0 and y_mouse < 0 or \

   445

               idx == len(self.GraphicPanels) - 1 and y_mouse > panel.GetPosition()[1]:

   446

                panel.RefreshHighlight(x_mouse - x, y_mouse - y)

   447

            else:

   448

                panel.SetHighlight(HIGHLIGHT_NONE)

   449

        if wx.Platform == "__WXMSW__":

   450

            self.RefreshView()

   451

        else:

   452

            self.ForceRefresh()

   453

   454

    def ResetHighlight(self):

   455

        for panel in self.GraphicPanels:

   456

            panel.SetHighlight(HIGHLIGHT_NONE)

   457

        if wx.Platform == "__WXMSW__":

   458

            self.RefreshView()

   459

        else:

   460

            self.ForceRefresh()

   461

   462

    def IsDragging(self):

   463

        return self.DraggingAxesPanel is not None

   464

   465

    def GetDraggingAxesClippingRegion(self, panel):

   466

        x, y = panel.GetPosition()

   467

        width, height = panel.GetSize()

   468

        bbox = wx.Rect(x, y, width, height)

   469

        bbox = bbox.Intersect(self.DraggingAxesBoundingBox)

   470

        bbox.x -= x

   471

        bbox.y -= y

   472

        return bbox

   473

   474

    def GetDraggingAxesPosition(self, panel):

   475

        x, y = panel.GetPosition()

   476

        return wx.Point(self.DraggingAxesBoundingBox.x - x,

   477

                        self.DraggingAxesBoundingBox.y - y)

   478

   479

    def StopDragNDrop(self, variable, x_mouse, y_mouse):