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 functools import reduce

    29

import numpy as np

    30

    31

import wx

    32

import wx.lib.buttons

    33

    34

    35

# pylint: disable=wrong-import-position

    36

import matplotlib

    37

matplotlib.use('WX')   # noqa

    38

import matplotlib.pyplot

    39

    40

from editors.DebugViewer import DebugViewer

    41

from util.BitmapLibrary import GetBitmap

    42

    43

from controls.DebugVariablePanel.DebugVariableItem import DebugVariableItem

    44

from controls.DebugVariablePanel.DebugVariableTextViewer import DebugVariableTextViewer

    45

from controls.DebugVariablePanel.DebugVariableGraphicViewer import *

    46

from controls.DebugVariablePanel.RingBuffer import RingBuffer

    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

# Scrollbar increment in pixel

    56

SCROLLBAR_UNIT = 10

    57

    58

    59

def compute_mask(x, y):

    60

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

    61

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

    62

    63

    64

def NextTick(variables):

    65

    next_tick = None

    66

    for _item, data in variables:

    67

        if len(data) == 0:

    68

            continue

    69

    70

        next_tick = (data[0][0]

    71

                     if next_tick is None

    72

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

    73

    74

    return next_tick

    75

    76

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

    77

#                    Debug Variable Graphic Panel Drop Target

    78

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

    79

    80

    81

class DebugVariableDropTarget(wx.TextDropTarget):

    82

    """

    83

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

    84

    Panel

    85

    """

    86

    87

    def __init__(self, window):

    88

        """

    89

        Constructor

    90

        @param window: Reference to the Debug Variable Panel

    91

        """

    92

        wx.TextDropTarget.__init__(self)

    93

        self.ParentWindow = window

    94

    95

    def __del__(self):

    96

        """

    97

        Destructor

    98

        """

    99

        # Remove reference to Debug Variable Panel

   100

        self.ParentWindow = None

   101

   102

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

   103

        """

   104

        Function called when mouse is dragged over Drop Target

   105

        @param x: X coordinate of mouse pointer

   106

        @param y: Y coordinate of mouse pointer

   107

        @param d: Suggested default for return value

   108

        """

   109

        # Signal Debug Variable Panel to refresh highlight giving mouse position

   110

        self.ParentWindow.RefreshHighlight(x, y)

   111

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

   112

   113

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

   114

        """

   115

        Function called when mouse is released in Drop Target

   116

        @param x: X coordinate of mouse pointer

   117

        @param y: Y coordinate of mouse pointer

   118

        @param data: Text associated to drag'n drop

   119

        """

   120

        # Signal Debug Variable Panel to reset highlight

   121

        self.ParentWindow.ResetHighlight()

   122

   123

        message = None

   124

   125

        # Check that data is valid regarding DebugVariablePanel

   126

        try:

   127

            values = eval(data)

   128

            if not isinstance(values, tuple):

   129

                raise ValueError

   130

        except Exception:

   131

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

   132

            values = None

   133

   134

        # Display message if data is invalid

   135

        if message is not None:

   136

            wx.CallAfter(self.ShowMessage, message)

   137

   138

        # Data contain a reference to a variable to debug

   139

        elif values[1] == "debug":

   140

   141

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

   142

            # Variable Panel

   143

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

   144

                self.ParentWindow.MoveValue(values[0])

   145

   146

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

   147

            else:

   148

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

   149

   150

    def OnLeave(self):

   151

        """

   152

        Function called when mouse is leave Drop Target

   153

        """

   154

        # Signal Debug Variable Panel to reset highlight

   155

        self.ParentWindow.ResetHighlight()

   156

        return wx.TextDropTarget.OnLeave(self)

   157

   158

    def ShowMessage(self, message):

   159

        """

   160

        Show error message in Error Dialog

   161

        @param message: Error message to display

   162

        """

   163

        dialog = wx.MessageDialog(self.ParentWindow,

   164

                                  message,

   165

                                  _("Error"),

   166

                                  wx.OK | wx.ICON_ERROR)

   167

        dialog.ShowModal()

   168

        dialog.Destroy()

   169

   170

   171

class DebugVariablePanel(wx.Panel, DebugViewer):

   172

    """

   173

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

   174

    """

   175

   176

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

   177

        """

   178

        Constructor

   179

        @param parent: Reference to the parent wx.Window

   180

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

   181

        consumers

   182

        @param window: Reference to Beremiz frame

   183

        """

   184

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

   185

   186

        # List of values possible for graph range

   187

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

   188

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

   189

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

   190

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

   191

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

   192

   193

        # Save Reference to Beremiz frame

   194

        self.ParentWindow = window

   195

   196

        # Variable storing flag indicating that variable displayed in table

   197

        # received new value and then table need to be refreshed

   198

        self.HasNewData = False

   199

   200

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

   201

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

   202

        # data is available

   203

        self.Force = False

   204

   205

        self.SetBackgroundColour(wx.WHITE)

   206

   207

        main_sizer = wx.BoxSizer(wx.VERTICAL)

   208

   209

        self.Ticks = RingBuffer()  # List of tick received

   210

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

   211

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

   212

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

   213

   214

        self.DraggingAxesPanel = None

   215

        self.DraggingAxesBoundingBox = None

   216

        self.DraggingAxesMousePos = None

   217

        self.VetoScrollEvent = False

   218

   219

        self.VariableNameMask = []

   220

   221

        self.GraphicPanels = []

   222

   223

        graphics_button_sizer = wx.BoxSizer(wx.HORIZONTAL)

   224

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

   225

   226

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

   227

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

   228

   229

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

   230

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

   231

        graphics_button_sizer.Add(self.CanvasRange, 1,

   232

                                        border=5,

   233

                                        flag=wx.LEFT | wx.ALIGN_CENTER_VERTICAL)

   234

   235

        self.CanvasRange.Clear()

   236

        default_range_idx = 0

   237

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

   238

            self.CanvasRange.Append(text)

   239

            if _value == 1000000000:

   240

                default_range_idx = idx

   241

        self.CanvasRange.SetSelection(default_range_idx)

   242

   243

        for name, bitmap, help in [

   244

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

   245

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

   246

            button = wx.lib.buttons.GenBitmapButton(

   247

                self, bitmap=GetBitmap(bitmap),

   248

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

   249

            button.SetToolTip(help)

   250

            setattr(self, name, button)

   251

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

   252

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

   253

   254

        self.CanvasPosition = wx.ScrollBar(

   255

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

   256

        self.CanvasPosition.Bind(wx.EVT_SCROLL_THUMBTRACK,

   257

                                 self.OnPositionChanging, self.CanvasPosition)

   258

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEUP,

   259

                                 self.OnPositionChanging, self.CanvasPosition)

   260

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEDOWN,

   261

                                 self.OnPositionChanging, self.CanvasPosition)

   262

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEUP,

   263

                                 self.OnPositionChanging, self.CanvasPosition)

   264

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEDOWN,

   265

                                 self.OnPositionChanging, self.CanvasPosition)

   266

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

   267

   268

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

   269

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

   270

   271

        self.TickLabel = wx.StaticText(self)

   272

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

   273

   274

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

   275

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

   276

   277

        self.TickTimeLabel = wx.StaticText(self)

   278

        self.TickSizer.Add(self.TickTimeLabel)

   279

   280

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

   281

        self.GraphicsWindow.SetBackgroundColour(wx.WHITE)

   282

        self.GraphicsWindow.SetDropTarget(DebugVariableDropTarget(self))

   283

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

   284

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

   285

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

   286

   287

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

   288

   289

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

   290

        self.GraphicsWindow.SetSizer(self.GraphicsSizer)

   291

   292

        DebugViewer.__init__(self, producer, True)

   293

   294

        self.SetSizer(main_sizer)

   295

        self.SetTickTime()

   296

   297

    def SetTickTime(self, ticktime=0):

   298

        """

   299

        Set Ticktime for calculate data range according to time range selected

   300

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

   301

        """

   302

        # Save ticktime

   303

        self.Ticktime = ticktime

   304

   305

        # Set ticktime to millisecond if undefined

   306

        if self.Ticktime == 0:

   307

            self.Ticktime = MILLISECOND

   308

   309

        # Calculate range to apply to data

   310

        self.CurrentRange = self.RANGE_VALUES[

   311

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

   312

   313

    def SetDataProducer(self, producer):

   314

        """

   315

        Set Data Producer

   316

        @param producer: Data Producer

   317

        """

   318

        DebugViewer.SetDataProducer(self, producer)

   319

   320

        # Set ticktime if data producer is available

   321

        if self.DataProducer is not None:

   322

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

   323

   324

    def RefreshNewData(self):

   325

        """

   326

        Called to refresh Panel according to values received by variables

   327

        Can receive any parameters (not used here)

   328

        """

   329

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

   330

        if self.HasNewData or self.Force:

   331

            self.HasNewData = False

   332

            self.RefreshView()

   333

   334

        DebugViewer.RefreshNewData(self)

   335

   336

    def NewDataAvailable(self, ticks):

   337

        """

   338

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

   339

        graphs

   340

        @param tick: PLC tick captured

   341

        All other parameters are passed to refresh function

   342

        """

   343

        # If tick given

   344

        if ticks is not None:

   345

            tick = ticks[-1]

   346

   347

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

   348

            if self.Ticks.count == 0:

   349

                self.StartTick = ticks[0]

   350

   351

            # Add tick to list of ticks received

   352

            self.Ticks.append(ticks)

   353

   354

            # Update start tick for range if range follow ticks received

   355

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

   356

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

   357

   358

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

   359

            # is too small to fill data range selected

   360

            if self.Fixed :

   361

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

   362

                    self.Force = True

   363

                if self.Ticks.view[0] > self.StartTick:

   364

                    self.StartTick = self.Ticks.view[0]

   365

                    self.Force = True

   366

   367

   368

            self.HasNewData = False

   369

            self.RefreshView()

   370

   371

        else:

   372

            DebugViewer.NewDataAvailable(self, ticks)

   373

   374

    def ForceRefresh(self):

   375

        """

   376

        Called to force refresh of graphs

   377

        """

   378

        self.Force = True

   379

        wx.CallAfter(self.NewDataAvailable, None)

   380

   381

    def SetCursorTick(self, cursor_tick):

   382

        """

   383

        Set Cursor for displaying values of items at a tick given

   384

        @param cursor_tick: Tick of cursor

   385

        """

   386

        # Save cursor tick

   387

        self.CursorTick = cursor_tick

   388

        self.Fixed = cursor_tick is not None

   389

        self.UpdateCursorTick()

   390

   391

    def MoveCursorTick(self, move):

   392

        if self.CursorTick is not None:

   393

            cursor_tick = max(self.Ticks.view[0],

   394

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

   395

            cursor_tick_idx = min(np.searchsorted(self.Ticks.view, cursor_tick), self.Ticks.count - 1)

   396

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

   397

                cursor_tick_idx = max(0,

   398

                                      min(cursor_tick_idx + abs(move) // move,

   399

                                          self.Ticks.count - 1))

   400

            self.CursorTick = self.Ticks.view[cursor_tick_idx]

   401

            self.StartTick = max(

   402

                self.Ticks.view[min(np.searchsorted(self.Ticks.view,  self.CursorTick - self.CurrentRange), self.Ticks.count - 1)],

   403

                min(self.StartTick, self.CursorTick))

   404

            self.RefreshCanvasPosition()

   405

            self.UpdateCursorTick()

   406

   407

    def ResetCursorTick(self):

   408

        self.CursorTick = None

   409

        self.Fixed = False

   410

        self.UpdateCursorTick()

   411

   412

    def UpdateCursorTick(self):

   413

        for panel in self.GraphicPanels:

   414

            if isinstance(panel, DebugVariableGraphicViewer):

   415

                panel.SetCursorTick(self.CursorTick)

   416

        self.ForceRefresh()

   417

   418

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

   419

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

   420

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

   421

            self.DraggingAxesPanel.SetCursorTick(self.CursorTick)

   422

            width, height = panel.GetSize()

   423

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

   424

            self.DraggingAxesPanel.ResetGraphics()

   425

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

   426

        else:

   427

            self.DraggingAxesPanel = panel

   428

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

   429

        self.DraggingAxesMousePos = wx.Point(

   430

            x_mouse_start - self.DraggingAxesBoundingBox.x,

   431

            y_mouse_start - self.DraggingAxesBoundingBox.y)

   432

        self.MoveDragNDrop(x_mouse, y_mouse)

   433

   434

    def MoveDragNDrop(self, x_mouse, y_mouse):

   435

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

   436

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

   437

        self.RefreshHighlight(x_mouse, y_mouse)

   438

   439

    def RefreshHighlight(self, x_mouse, y_mouse):

   440

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

   441

            x, y = panel.GetPosition()

   442

            width, height = panel.GetSize()

   443

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

   444

            if rect.Contains(x_mouse, y_mouse) or \

   445

               idx == 0 and y_mouse < 0 or \

   446

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

   447

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

   448

            else:

   449

                panel.SetHighlight(HIGHLIGHT_NONE)

   450

        if wx.Platform == "__WXMSW__":

   451

            self.RefreshView()

   452

        else:

   453

            self.ForceRefresh()

   454

   455

    def ResetHighlight(self):

   456

        for panel in self.GraphicPanels:

   457

            panel.SetHighlight(HIGHLIGHT_NONE)

   458

        if wx.Platform == "__WXMSW__":

   459

            self.RefreshView()

   460

        else:

   461

            self.ForceRefresh()

   462

   463

    def IsDragging(self):

   464

        return self.DraggingAxesPanel is not None

   465

   466

    def GetDraggingAxesClippingRegion(self, panel):

   467

        x, y = panel.GetPosition()

   468

        width, height = panel.GetSize()

   469

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

   470

        bbox = bbox.Intersect(self.DraggingAxesBoundingBox)

   471

        bbox.x -= x

   472

        bbox.y -= y

   473

        return bbox

   474

   475

    def GetDraggingAxesPosition(self, panel):

   476

        x, y = panel.GetPosition()

   477

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

   478

                        self.DraggingAxesBoundingBox.y - y)

   479