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

import numpy

    27

    28

import wx

    29

import wx.lib.buttons

    30

    31

import matplotlib

    32

matplotlib.use('WX')   # noqa

    33

import matplotlib.pyplot

    34

from matplotlib.backends.backend_wxagg import _convert_agg_to_wx_bitmap

    35

    36

    37

from editors.DebugViewer import DebugViewer

    38

from util.BitmapLibrary import GetBitmap

    39

    40

from DebugVariableItem import DebugVariableItem

    41

from DebugVariableTextViewer import DebugVariableTextViewer

    42

from DebugVariableGraphicViewer import *

    43

    44

    45

MILLISECOND = 1000000        # Number of nanosecond in a millisecond

    46

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

    47

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

    48

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

    49

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

    50

    51

# List of values possible for graph range

    52

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

    53

RANGE_VALUES = \

    54

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

    55

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

    56

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

    57

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

    58

    59

# Scrollbar increment in pixel

    60

SCROLLBAR_UNIT = 10

    61

    62

    63

def compute_mask(x, y):

    64

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

    65

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

    66

    67

    68

def NextTick(variables):

    69

    next_tick = None

    70

    for _item, data in variables:

    71

        if len(data) == 0:

    72

            continue

    73

    74

        next_tick = (data[0][0]

    75

                     if next_tick is None

    76

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

    77

    78

    return next_tick

    79

    80

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

    81

#                    Debug Variable Graphic Panel Drop Target

    82

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

    83

    84

    85

class DebugVariableDropTarget(wx.TextDropTarget):

    86

    """

    87

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

    88

    Panel

    89

    """

    90

    91

    def __init__(self, window):

    92

        """

    93

        Constructor

    94

        @param window: Reference to the Debug Variable Panel

    95

        """

    96

        wx.TextDropTarget.__init__(self)

    97

        self.ParentWindow = window

    98

    99

    def __del__(self):

   100

        """

   101

        Destructor

   102

        """

   103

        # Remove reference to Debug Variable Panel

   104

        self.ParentWindow = None

   105

   106

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

   107

        """

   108

        Function called when mouse is dragged over Drop Target

   109

        @param x: X coordinate of mouse pointer

   110

        @param y: Y coordinate of mouse pointer

   111

        @param d: Suggested default for return value

   112

        """

   113

        # Signal Debug Variable Panel to refresh highlight giving mouse position

   114

        self.ParentWindow.RefreshHighlight(x, y)

   115

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

   116

   117

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

   118

        """

   119

        Function called when mouse is released in Drop Target

   120

        @param x: X coordinate of mouse pointer

   121

        @param y: Y coordinate of mouse pointer

   122

        @param data: Text associated to drag'n drop

   123

        """

   124

        # Signal Debug Variable Panel to reset highlight

   125

        self.ParentWindow.ResetHighlight()

   126

   127

        message = None

   128

   129

        # Check that data is valid regarding DebugVariablePanel

   130

        try:

   131

            values = eval(data)

   132

            if not isinstance(values, TupleType):

   133

                raise ValueError

   134

        except Exception:

   135

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

   136

            values = None

   137

   138

        # Display message if data is invalid

   139

        if message is not None:

   140

            wx.CallAfter(self.ShowMessage, message)

   141

   142

        # Data contain a reference to a variable to debug

   143

        elif values[1] == "debug":

   144

   145

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

   146

            # Variable Panel

   147

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

   148

                self.ParentWindow.MoveValue(values[0])

   149

   150

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

   151

            else:

   152

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

   153

   154

    def OnLeave(self):

   155

        """

   156

        Function called when mouse is leave Drop Target

   157

        """

   158

        # Signal Debug Variable Panel to reset highlight

   159

        self.ParentWindow.ResetHighlight()

   160

        return wx.TextDropTarget.OnLeave(self)

   161

   162

    def ShowMessage(self, message):

   163

        """

   164

        Show error message in Error Dialog

   165

        @param message: Error message to display

   166

        """

   167

        dialog = wx.MessageDialog(self.ParentWindow,

   168

                                  message,

   169

                                  _("Error"),

   170

                                  wx.OK | wx.ICON_ERROR)

   171

        dialog.ShowModal()

   172

        dialog.Destroy()

   173

   174

   175

class DebugVariablePanel(wx.Panel, DebugViewer):

   176

    """

   177

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

   178

    """

   179

   180

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

   181

        """

   182

        Constructor

   183

        @param parent: Reference to the parent wx.Window

   184

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

   185

        consumers

   186

        @param window: Reference to Beremiz frame

   187

        """

   188

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

   189

   190

        # Save Reference to Beremiz frame

   191

        self.ParentWindow = window

   192

   193

        # Variable storing flag indicating that variable displayed in table

   194

        # received new value and then table need to be refreshed

   195

        self.HasNewData = False

   196

   197

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

   198

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

   199

        # data is available

   200

        self.Force = False

   201

   202

        self.SetBackgroundColour(wx.WHITE)

   203

   204

        main_sizer = wx.BoxSizer(wx.VERTICAL)

   205

   206

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

   207

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

   208

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

   209

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

   210

   211

        self.DraggingAxesPanel = None

   212

        self.DraggingAxesBoundingBox = None

   213

        self.DraggingAxesMousePos = None

   214

        self.VetoScrollEvent = False

   215

   216

        self.VariableNameMask = []

   217

   218

        self.GraphicPanels = []

   219

   220

        graphics_button_sizer = wx.BoxSizer(wx.HORIZONTAL)

   221

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

   222

   223

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

   224

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

   225

   226

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

   227

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

   228

        graphics_button_sizer.AddWindow(self.CanvasRange, 1,

   229

                                        border=5,

   230

                                        flag=wx.LEFT | wx.ALIGN_CENTER_VERTICAL)

   231

   232

        self.CanvasRange.Clear()

   233

        default_range_idx = 0

   234

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

   235

            self.CanvasRange.Append(text)

   236

            if text == "1s":

   237

                default_range_idx = idx

   238

        self.CanvasRange.SetSelection(default_range_idx)

   239

   240

        for name, bitmap, help in [

   241

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

   242

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

   243

            button = wx.lib.buttons.GenBitmapButton(

   244

                self, bitmap=GetBitmap(bitmap),

   245

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

   246

            button.SetToolTipString(help)

   247

            setattr(self, name, button)

   248

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

   249

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

   250

   251

        self.CanvasPosition = wx.ScrollBar(

   252

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

   253

        self.CanvasPosition.Bind(wx.EVT_SCROLL_THUMBTRACK,

   254

                                 self.OnPositionChanging, self.CanvasPosition)

   255

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEUP,

   256

                                 self.OnPositionChanging, self.CanvasPosition)

   257

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEDOWN,

   258

                                 self.OnPositionChanging, self.CanvasPosition)

   259

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEUP,

   260

                                 self.OnPositionChanging, self.CanvasPosition)

   261

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEDOWN,

   262

                                 self.OnPositionChanging, self.CanvasPosition)

   263

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

   264

   265

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

   266

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

   267

   268

        self.TickLabel = wx.StaticText(self)

   269

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

   270

   271

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

   272

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

   273

   274

        self.TickTimeLabel = wx.StaticText(self)

   275

        self.TickSizer.AddWindow(self.TickTimeLabel)

   276

   277

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

   278

        self.GraphicsWindow.SetBackgroundColour(wx.WHITE)

   279

        self.GraphicsWindow.SetDropTarget(DebugVariableDropTarget(self))

   280

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

   281

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

   282

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

   283

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

   284

   285

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

   286

   287

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

   288

        self.GraphicsWindow.SetSizer(self.GraphicsSizer)

   289

   290

        DebugViewer.__init__(self, producer, True)

   291

   292

        self.SetSizer(main_sizer)

   293

        self.SetTickTime()

   294

   295

    def SetTickTime(self, ticktime=0):

   296

        """

   297

        Set Ticktime for calculate data range according to time range selected

   298

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

   299

        """

   300

        # Save ticktime

   301

        self.Ticktime = ticktime

   302

   303

        # Set ticktime to millisecond if undefined

   304

        if self.Ticktime == 0:

   305

            self.Ticktime = MILLISECOND

   306

   307

        # Calculate range to apply to data

   308

        self.CurrentRange = RANGE_VALUES[

   309

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

   310

   311

    def SetDataProducer(self, producer):

   312

        """

   313

        Set Data Producer

   314

        @param producer: Data Producer

   315

        """

   316

        DebugViewer.SetDataProducer(self, producer)

   317

   318

        # Set ticktime if data producer is available

   319

        if self.DataProducer is not None:

   320

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

   321

   322

    def RefreshNewData(self):

   323

        """

   324

        Called to refresh Panel according to values received by variables

   325

        Can receive any parameters (not used here)

   326

        """

   327

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

   328

        if self.HasNewData or self.Force:

   329

            self.HasNewData = False

   330

            self.RefreshView()

   331

   332

        DebugViewer.RefreshNewData(self)

   333

   334

    def NewDataAvailable(self, ticks):

   335

        """

   336

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

   337

        graphs

   338

        @param tick: PLC tick captured

   339

        All other parameters are passed to refresh function

   340

        """

   341

        # If tick given

   342

        if ticks is not None:

   343

            tick = ticks[-1]

   344

   345

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

   346

            if len(self.Ticks) == 0:

   347

                self.StartTick = ticks[0]

   348

   349

            # Add tick to list of ticks received

   350

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

   351

   352

            # Update start tick for range if range follow ticks received

   353

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

   354

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

   355

   356

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

   357

            # is too small to fill data range selected

   358

            if self.Fixed and \

   359

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

   360

                self.Force = True

   361

   362

            self.HasNewData = False

   363

            self.RefreshView()

   364

   365

        else:

   366

            DebugViewer.NewDataAvailable(self, ticks)

   367

   368

    def ForceRefresh(self):

   369

        """

   370

        Called to force refresh of graphs

   371

        """

   372

        self.Force = True

   373

        wx.CallAfter(self.NewDataAvailable, None)

   374

   375

    def SetCursorTick(self, cursor_tick):

   376

        """

   377

        Set Cursor for displaying values of items at a tick given

   378

        @param cursor_tick: Tick of cursor

   379

        """

   380

        # Save cursor tick

   381

        self.CursorTick = cursor_tick

   382

        self.Fixed = cursor_tick is not None

   383

        self.UpdateCursorTick()

   384

   385

    def MoveCursorTick(self, move):

   386

        if self.CursorTick is not None:

   387

            cursor_tick = max(self.Ticks[0],

   388

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

   389

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

   390

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

   391

                cursor_tick_idx = max(0,

   392

                                      min(cursor_tick_idx + abs(move) / move,

   393

                                          len(self.Ticks) - 1))

   394

            self.CursorTick = self.Ticks[cursor_tick_idx]

   395

            self.StartTick = max(

   396

                self.Ticks[numpy.argmin(

   397

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

   398

                min(self.StartTick, self.CursorTick))

   399

            self.RefreshCanvasPosition()

   400

            self.UpdateCursorTick()

   401

   402

    def ResetCursorTick(self):

   403

        self.CursorTick = None

   404

        self.Fixed = False

   405

        self.UpdateCursorTick()

   406

   407

    def UpdateCursorTick(self):

   408

        for panel in self.GraphicPanels:

   409

            if isinstance(panel, DebugVariableGraphicViewer):

   410

                panel.SetCursorTick(self.CursorTick)

   411

        self.ForceRefresh()

   412

   413

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

   414

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

   415

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

   416

            self.DraggingAxesPanel.SetCursorTick(self.CursorTick)

   417

            width, height = panel.GetSize()

   418

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

   419

            self.DraggingAxesPanel.ResetGraphics()

   420

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

   421

        else:

   422

            self.DraggingAxesPanel = panel

   423

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

   424

        self.DraggingAxesMousePos = wx.Point(

   425

            x_mouse_start - self.DraggingAxesBoundingBox.x,

   426

            y_mouse_start - self.DraggingAxesBoundingBox.y)

   427

        self.MoveDragNDrop(x_mouse, y_mouse)

   428

   429

    def MoveDragNDrop(self, x_mouse, y_mouse):

   430

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

   431

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

   432

        self.RefreshHighlight(x_mouse, y_mouse)

   433

   434

    def RefreshHighlight(self, x_mouse, y_mouse):

   435

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

   436

            x, y = panel.GetPosition()

   437

            width, height = panel.GetSize()

   438

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

   439

            if rect.InsideXY(x_mouse, y_mouse) or \

   440

               idx == 0 and y_mouse < 0 or \

   441

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

   442

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

   443

            else:

   444

                panel.SetHighlight(HIGHLIGHT_NONE)

   445

        if wx.Platform == "__WXMSW__":

   446

            self.RefreshView()

   447

        else:

   448

            self.ForceRefresh()

   449

   450

    def ResetHighlight(self):

   451

        for panel in self.GraphicPanels:

   452

            panel.SetHighlight(HIGHLIGHT_NONE)

   453

        if wx.Platform == "__WXMSW__":

   454

            self.RefreshView()

   455

        else:

   456

            self.ForceRefresh()

   457

   458

    def IsDragging(self):

   459

        return self.DraggingAxesPanel is not None

   460

   461

    def GetDraggingAxesClippingRegion(self, panel):

   462

        x, y = panel.GetPosition()

   463

        width, height = panel.GetSize()

   464

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

   465

        bbox = bbox.Intersect(self.DraggingAxesBoundingBox)

   466

        bbox.x -= x

   467

        bbox.y -= y

   468

        return bbox

   469

   470

    def GetDraggingAxesPosition(self, panel):

   471

        x, y = panel.GetPosition()

   472

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

   473

                        self.DraggingAxesBoundingBox.y - y)

   474

   475

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

   476

        if self.DraggingAxesPanel not in self.GraphicPanels:

   477

            self.DraggingAxesPanel.Destroy()

   478

        self.DraggingAxesPanel = None

   479

        self.DraggingAxesBoundingBox = None

   480