1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

#Copyright (C) 2012: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

from types import TupleType, ListType, FloatType

    26

from time import time as gettime

    27

import math

    28

import numpy

    29

import binascii

    30

    31

import wx

    32

import wx.lib.buttons

    33

    34

try:

    35

    import matplotlib

    36

    matplotlib.use('WX')

    37

    import matplotlib.pyplot

    38

    from matplotlib.backends.backend_wxagg import FigureCanvasWxAgg as FigureCanvas

    39

    from matplotlib.backends.backend_wxagg import _convert_agg_to_wx_bitmap

    40

    from matplotlib.backends.backend_agg import FigureCanvasAgg

    41

    from mpl_toolkits.mplot3d import Axes3D

    42

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

    43

    cursor_color = '#800080'

    44

    USE_MPL = True

    45

except:

    46

    USE_MPL = False

    47

    48

from graphics import DebugDataConsumer, DebugViewer, REFRESH_PERIOD

    49

from controls import CustomGrid, CustomTable

    50

from dialogs.ForceVariableDialog import ForceVariableDialog

    51

from util.BitmapLibrary import GetBitmap

    52

    53

def AppendMenu(parent, help, id, kind, text):

    54

    parent.Append(help=help, id=id, kind=kind, text=text)

    55

    56

def GetDebugVariablesTableColnames():

    57

    _ = lambda x : x

    58

    return [_("Variable"), _("Value")]

    59

    60

CRC_SIZE = 8

    61

CRC_MASK = 2 ** CRC_SIZE - 1

    62

    63

class VariableTableItem(DebugDataConsumer):

    64

    65

    def __init__(self, parent, variable):

    66

        DebugDataConsumer.__init__(self)

    67

        self.Parent = parent

    68

        self.Variable = variable

    69

        self.RefreshVariableType()

    70

        self.Value = ""

    71

    72

    def __del__(self):

    73

        self.Parent = None

    74

    75

    def SetVariable(self, variable):

    76

        if self.Parent and self.Variable != variable:

    77

            self.Variable = variable

    78

            self.RefreshVariableType()

    79

            self.Parent.RefreshView()

    80

    81

    def GetVariable(self, mask=None):

    82

        variable = self.Variable

    83

        if mask is not None:

    84

            parts = variable.split('.')

    85

            mask = mask + ['*'] * max(0, len(parts) - len(mask))

    86

            last = None

    87

            variable = ""

    88

            for m, v in zip(mask, parts):

    89

                if m == '*':

    90

                    if last == '*':

    91

                        variable += '.'

    92

                    variable += v

    93

                elif last is None or last == '*':

    94

                    variable += '..'

    95

                last = m

    96

        return variable

    97

    98

    def RefreshVariableType(self):

    99

        self.VariableType = self.Parent.GetDataType(self.Variable)

   100

        if USE_MPL:

   101

            self.ResetData()

   102

   103

    def GetVariableType(self):

   104

        return self.VariableType

   105

   106

    def GetData(self, start_tick=None, end_tick=None):

   107

        if USE_MPL and self.IsNumVariable():

   108

            if len(self.Data) == 0:

   109

                return self.Data

   110

   111

            start_idx = end_idx = None

   112

            if start_tick is not None:

   113

                start_idx = self.GetNearestData(start_tick, -1)

   114

            if end_tick is not None:

   115

                end_idx = self.GetNearestData(end_tick, 1)

   116

            if start_idx is None:

   117

                start_idx = 0

   118

            if end_idx is not None:

   119

                return self.Data[start_idx:end_idx + 1]

   120

            else:

   121

                return self.Data[start_idx:]

   122

   123

        return None

   124

   125

    def GetRawValue(self, idx):

   126

        if self.VariableType in ["STRING", "WSTRING"] and idx < len(self.RawData):

   127

            return self.RawData[idx][0]

   128

        return ""

   129

   130

    def GetRange(self):

   131

        return self.MinValue, self.MaxValue

   132

   133

    def ResetData(self):

   134

        if self.IsNumVariable():

   135

            self.Data = numpy.array([]).reshape(0, 3)

   136

            if self.VariableType in ["STRING", "WSTRING"]:

   137

                self.RawData = []

   138

            self.MinValue = None

   139

            self.MaxValue = None

   140

        else:

   141

            self.Data = None

   142

   143

    def IsNumVariable(self):

   144

        return (self.Parent.IsNumType(self.VariableType) or 

   145

                self.VariableType in ["STRING", "WSTRING"])

   146

   147

    def NewValue(self, tick, value, forced=False):

   148

        if USE_MPL and self.IsNumVariable():

   149

            if self.VariableType in ["STRING", "WSTRING"]:

   150

                num_value = binascii.crc32(value) & CRC_MASK

   151

            else:

   152

                num_value = float(value)

   153

            if self.MinValue is None:

   154

                self.MinValue = num_value

   155

            else:

   156

                self.MinValue = min(self.MinValue, num_value)

   157

            if self.MaxValue is None:

   158

                self.MaxValue = num_value

   159

            else:

   160

                self.MaxValue = max(self.MaxValue, num_value)

   161

            forced_value = float(forced)

   162

            if self.VariableType in ["STRING", "WSTRING"]:

   163

                raw_data = (value, forced_value)

   164

                if len(self.RawData) == 0 or self.RawData[-1] != raw_data:

   165

                    extra_value = len(self.RawData)

   166

                    self.RawData.append(raw_data)

   167

                else:

   168

                    extra_value = len(self.RawData) - 1

   169

            else:

   170

                extra_value = forced_value

   171

            self.Data = numpy.append(self.Data, [[float(tick), num_value, extra_value]], axis=0)

   172

            self.Parent.HasNewData = True

   173

        DebugDataConsumer.NewValue(self, tick, value, forced)

   174

   175

    def SetForced(self, forced):

   176

        if self.Forced != forced:

   177

            self.Forced = forced

   178

            self.Parent.HasNewData = True

   179

   180

    def SetValue(self, value):

   181

        if (self.VariableType == "STRING" and value.startswith("'") and value.endswith("'") or

   182

            self.VariableType == "WSTRING" and value.startswith('"') and value.endswith('"')):

   183

            value = value[1:-1]

   184

        if self.Value != value:

   185

            self.Value = value

   186

            self.Parent.HasNewData = True

   187

   188

    def GetValue(self, tick=None, raw=False):

   189

        if tick is not None and self.IsNumVariable():

   190

            if len(self.Data) > 0:

   191

                idx = numpy.argmin(abs(self.Data[:, 0] - tick))

   192

                if self.VariableType in ["STRING", "WSTRING"]:

   193

                    value, forced = self.RawData[int(self.Data[idx, 2])]

   194

                    if not raw:

   195

                        if self.VariableType == "STRING":

   196

                            value = "'%s'" % value

   197

                        else:

   198

                            value = '"%s"' % value

   199

                    return value, forced

   200

                else:

   201

                    value = self.Data[idx, 1]

   202

                    if not raw and isinstance(value, FloatType):

   203

                        value = "%.6g" % value

   204

                    return value, self.Data[idx, 2]

   205

            return self.Value, self.IsForced()

   206

        elif not raw:

   207

            if self.VariableType == "STRING":

   208

                return "'%s'" % self.Value

   209

            elif self.VariableType == "WSTRING":

   210

                return '"%s"' % self.Value

   211

            elif isinstance(self.Value, FloatType):

   212

                return "%.6g" % self.Value

   213

        return self.Value

   214

   215

    def GetNearestData(self, tick, adjust):

   216

        if USE_MPL and self.IsNumVariable():

   217

            ticks = self.Data[:, 0]

   218

            new_cursor = numpy.argmin(abs(ticks - tick))

   219

            if adjust == -1 and ticks[new_cursor] > tick and new_cursor > 0:

   220

                new_cursor -= 1

   221

            elif adjust == 1 and ticks[new_cursor] < tick and new_cursor < len(ticks):

   222

                new_cursor += 1

   223

            return new_cursor

   224

        return None

   225

   226

class DebugVariableTable(CustomTable):

   227

   228

    def GetValue(self, row, col):

   229

        if row < self.GetNumberRows():

   230

            return self.GetValueByName(row, self.GetColLabelValue(col, False))

   231

        return ""

   232

   233

    def SetValue(self, row, col, value):

   234

        if col < len(self.colnames):

   235

            self.SetValueByName(row, self.GetColLabelValue(col, False), value)

   236

   237

    def GetValueByName(self, row, colname):

   238

        if row < self.GetNumberRows():

   239

            if colname == "Variable":

   240

                return self.data[row].GetVariable()

   241

            elif colname == "Value":

   242

                return self.data[row].GetValue()

   243

        return ""

   244

   245

    def SetValueByName(self, row, colname, value):

   246

        if row < self.GetNumberRows():

   247

            if colname == "Variable":

   248

                self.data[row].SetVariable(value)

   249

            elif colname == "Value":

   250

                self.data[row].SetValue(value)

   251

   252

    def IsForced(self, row):

   253

        if row < self.GetNumberRows():

   254

            return self.data[row].IsForced()

   255

        return False

   256

   257

    def IsNumVariable(self, row):

   258

        if row < self.GetNumberRows():

   259

            return self.data[row].IsNumVariable()

   260

        return False

   261

   262

    def _updateColAttrs(self, grid):

   263

        """

   264

        wx.grid.Grid -> update the column attributes to add the

   265

        appropriate renderer given the column name.

   266

   267

        Otherwise default to the default renderer.

   268

        """

   269

   270

        for row in range(self.GetNumberRows()):

   271

            for col in range(self.GetNumberCols()):

   272

                colname = self.GetColLabelValue(col, False)

   273

                if colname == "Value":

   274

                    if self.IsForced(row):

   275

                        grid.SetCellTextColour(row, col, wx.BLUE)

   276

                    else:

   277

                        grid.SetCellTextColour(row, col, wx.BLACK)

   278

                grid.SetReadOnly(row, col, True)

   279

            self.ResizeRow(grid, row)

   280

   281

    def AppendItem(self, data):

   282

        self.data.append(data)

   283

   284

    def InsertItem(self, idx, data):

   285

        self.data.insert(idx, data)

   286

   287

    def RemoveItem(self, idx):

   288

        self.data.pop(idx)

   289

   290

    def MoveItem(self, idx, new_idx):

   291

        self.data.insert(new_idx, self.data.pop(idx))

   292

   293

    def GetItem(self, idx):

   294

        return self.data[idx]

   295

   296

class DebugVariableDropTarget(wx.TextDropTarget):

   297

   298

    def __init__(self, parent, control=None):

   299

        wx.TextDropTarget.__init__(self)

   300

        self.ParentWindow = parent

   301

        self.ParentControl = control

   302

   303

    def __del__(self):

   304

        self.ParentWindow = None

   305

        self.ParentControl = None

   306

   307

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

   308

        if self.ParentControl is not None:

   309

            self.ParentControl.OnCanvasDragging(x, y)

   310

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

   311

   312

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

   313

        message = None

   314

        try:

   315

            values = eval(data)

   316

        except:

   317

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

   318

            values = None

   319

        if not isinstance(values, TupleType):

   320

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

   321

            values = None

   322

   323

        if message is not None:

   324

            wx.CallAfter(self.ShowMessage, message)

   325

        elif values is not None and values[1] == "debug":

   326

            if isinstance(self.ParentControl, CustomGrid):

   327

                x, y = self.ParentControl.CalcUnscrolledPosition(x, y)

   328

                row = self.ParentControl.YToRow(y - self.ParentControl.GetColLabelSize())

   329

                if row == wx.NOT_FOUND:

   330

                    row = self.ParentWindow.Table.GetNumberRows()

   331

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

   332

            elif self.ParentControl is not None:

   333

                width, height = self.ParentControl.Canvas.GetSize()

   334

                target_idx = self.ParentControl.GetIndex()

   335

                merge_type = GRAPH_PARALLEL

   336

                if self.ParentControl.Is3DCanvas():

   337

                    if y > height / 2:

   338

                        target_idx += 1

   339

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

   340

                else:

   341

                    rect = self.ParentControl.GetAxesBoundingBox()

   342

                    if rect.InsideXY(x, y):

   343

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

   344

                        if merge_rect.InsideXY(x, y):

   345

                            merge_type = GRAPH_ORTHOGONAL

   346

                        wx.CallAfter(self.ParentWindow.MergeGraphs, values[0], target_idx, merge_type, force=True)

   347

                    else:

   348

                        if y > height / 2:

   349

                            target_idx += 1

   350

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

   351

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

   352

   353

    def OnLeave(self):

   354

        if self.ParentControl is not None:

   355

            self.ParentControl.OnCanvasLeave()

   356

        return wx.TextDropTarget.OnLeave(self)

   357

   358

    def ShowMessage(self, message):

   359

        dialog = wx.MessageDialog(self.ParentWindow, message, _("Error"), wx.OK|wx.ICON_ERROR)

   360

        dialog.ShowModal()

   361

        dialog.Destroy()

   362

   363

if USE_MPL:

   364

    MILLISECOND = 1000000

   365

    SECOND = 1000 * MILLISECOND

   366

    MINUTE = 60 * SECOND

   367

    HOUR = 60 * MINUTE

   368

    DAY = 24 * HOUR

   369

   370

    ZOOM_VALUES = map(lambda x:("x %.1f" % x, x), [math.sqrt(2) ** i for i in xrange(8)])

   371

    RANGE_VALUES = map(lambda x: (str(x), x), [25 * 2 ** i for i in xrange(6)])

   372

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

   373

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

   374

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

   375

   376

    GRAPH_PARALLEL, GRAPH_ORTHOGONAL = range(2)

   377

   378

    SCROLLBAR_UNIT = 10

   379

   380

    def NextTick(variables):

   381

        next_tick = None

   382

        for item, data in variables:

   383

            if len(data) > 0:

   384

                if next_tick is None:

   385

                    next_tick = data[0][0]

   386

                else:

   387

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

   388

        return next_tick

   389

   390

    def OrthogonalData(item, start_tick, end_tick):

   391

        data = item.GetData(start_tick, end_tick)

   392

        min_value, max_value = item.GetRange()

   393

        if min_value is not None and max_value is not None:

   394

            center = (min_value + max_value) / 2.

   395

            range = max(1.0, max_value - min_value)

   396

        else:

   397

            center = 0.5

   398

            range = 1.0

   399

        return data, center - range * 0.55, center + range * 0.55

   400

   401

    class DebugVariableViewer(wx.Panel):

   402

   403

        def AddViewer(self):

   404

            pass

   405

   406

        def AddButtons(self):

   407

            pass

   408

   409

        def __init__(self, parent, window, items=[]):

   410

            wx.Panel.__init__(self, parent)

   411

            self.SetBackgroundColour(wx.WHITE)

   412

            self.SetDropTarget(DebugVariableDropTarget(window, self))

   413

   414

            self.ParentWindow = window

   415

            self.Items = items

   416

   417

        def __del__(self):

   418

            self.ParentWindow = None

   419

   420

        def GetIndex(self):

   421

            return self.ParentWindow.GetViewerIndex(self)

   422

   423

        def GetItem(self, variable):

   424

            for item in self.Items:

   425

                if item.GetVariable() == variable:

   426

                    return item

   427

            return None

   428

   429

        def GetItems(self):

   430

            return self.Items

   431

   432

        def GetVariables(self):

   433

            if len(self.Items) > 1:

   434

                variables = [item.GetVariable() for item in self.Items]

   435

                if self.GraphType == GRAPH_ORTHOGONAL:

   436

                    return tuple(variables)

   437

                return variables

   438

            return self.Items[0].GetVariable()

   439

   440

        def AddItem(self, item):

   441

            self.Items.append(item)

   442

   443

        def RemoveItem(self, item):

   444

            if item in self.Items:

   445

                self.Items.remove(item)

   446

   447

        def Clear(self):

   448

            for item in self.Items:

   449

                self.ParentWindow.RemoveDataConsumer(item)

   450

            self.Items = []

   451

   452

        def IsEmpty(self):

   453

            return len(self.Items) == 0

   454

   455

        def UnregisterObsoleteData(self):

   456

            for item in self.Items[:]:

   457

                iec_path = item.GetVariable().upper()

   458

                if self.ParentWindow.GetDataType(iec_path) is None:

   459

                    self.ParentWindow.RemoveDataConsumer(item)

   460

                    self.RemoveItem(item)

   461

                else:

   462

                    self.ParentWindow.AddDataConsumer(iec_path, item)

   463

                    item.RefreshVariableType()

   464

   465

        def ResetData(self):

   466

            for item in self.Items:

   467

                item.ResetData()

   468

   469

        def Refresh(self):

   470

            pass

   471

   472

        def OnForceButton(self, event):

   473

            if len(self.Items) == 1:

   474

                wx.CallAfter(self.ForceValue, self.Items[0])

   475

            else:

   476

                menu = wx.Menu(title='')

   477

                for item in self.Items:

   478

                    new_id = wx.NewId()

   479

                    AppendMenu(menu, help='', id=new_id, kind=wx.ITEM_NORMAL, 

   480

                        text=item.GetVariable(self.ParentWindow.GetVariableNameMask()))

   481

                    self.Bind(wx.EVT_MENU, 

   482

                        self.GetForceVariableMenuFunction(item),

   483

                        id=new_id)

   484

                self.PopupMenu(menu)

   485

            event.Skip()

   486

   487

        def OnReleaseButton(self, event):

   488

            if len(self.Items) == 1:

   489

                wx.CallAfter(self.ReleaseValue, self.Items[0])

   490

            else:

   491

                menu = wx.Menu(title='')

   492

                for item in self.Items:

   493

                    new_id = wx.NewId()

   494

                    AppendMenu(menu, help='', id=new_id, kind=wx.ITEM_NORMAL, 

   495

                        text=item.GetVariable(self.ParentWindow.GetVariableNameMask()))

   496

                    self.Bind(wx.EVT_MENU, 

   497

                        self.GetReleaseVariableMenuFunction(item),

   498

                        id=new_id)