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) 2013: 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 datetime import datetime

    26

from time import time as gettime

    27

import numpy

    28

    29

import wx

    30

    31

from graphics import DebugViewer, REFRESH_PERIOD

    32

from targets.typemapping import LogLevelsCount, LogLevels

    33

from util.BitmapLibrary import GetBitmap

    34

    35

THUMB_SIZE_RATIO = 1. / 8.

    36

    37

def ArrowPoints(direction, width, height, offset):

    38

    if direction == wx.TOP:

    39

        return [wx.Point(1, offset + height - 2),

    40

                wx.Point(width / 2, offset + 1),

    41

                wx.Point(width - 1, offset + height - 2)]

    42

    else:

    43

        return [wx.Point(1, offset - height + 1),

    44

                wx.Point(width / 2, offset - 2),

    45

                wx.Point(width - 1, offset - height + 1)]

    46

    47

class LogScrollBar(wx.Panel):

    48

    49

    def __init__(self, parent, size):

    50

        wx.Panel.__init__(self, parent, size=size)

    51

        self.Bind(wx.EVT_LEFT_DOWN, self.OnLeftDown)

    52

        self.Bind(wx.EVT_LEFT_UP, self.OnLeftUp)

    53

        self.Bind(wx.EVT_MOTION, self.OnMotion)

    54

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

    55

        self.Bind(wx.EVT_PAINT, self.OnPaint)

    56

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

    57

    58

        self.ThumbPosition = 0. # -1 <= ThumbPosition <= 1

    59

        self.ThumbScrollingStartPos = None

    60

    61

    def GetRangeRect(self):

    62

        width, height = self.GetClientSize()

    63

        return wx.Rect(0, width, width, height - 2 * width)

    64

    65

    def GetThumbRect(self):

    66

        width, height = self.GetClientSize()

    67

        range_rect = self.GetRangeRect()

    68

        thumb_size = range_rect.height * THUMB_SIZE_RATIO

    69

        thumb_range = range_rect.height - thumb_size

    70

        thumb_center_position = (thumb_size + (self.ThumbPosition + 1) * thumb_range) / 2.

    71

        thumb_start = int(thumb_center_position - thumb_size / 2.)

    72

        thumb_end = int(thumb_center_position + thumb_size / 2.)

    73

        return wx.Rect(0, range_rect.y + thumb_start, width, thumb_end - thumb_start)

    74

    75

    def RefreshThumbPosition(self, thumb_position=None):

    76

        if thumb_position is None:

    77

            thumb_position = self.ThumbPosition

    78

        if self.Parent.IsMessagePanelTop():

    79

            thumb_position = max(0., thumb_position)

    80

        if self.Parent.IsMessagePanelBottom():

    81

            thumb_position = min(0., thumb_position)

    82

        if thumb_position != self.ThumbPosition:

    83

            self.ThumbPosition = thumb_position

    84

            self.Parent.SetScrollSpeed(self.ThumbPosition)

    85

        self.Refresh()

    86

    87

    def OnLeftDown(self, event):

    88

        self.CaptureMouse()

    89

        posx, posy = event.GetPosition()

    90

        width, height = self.GetClientSize()

    91

        range_rect = self.GetRangeRect()

    92

        thumb_rect = self.GetThumbRect()

    93

        if range_rect.InsideXY(posx, posy):

    94

            if thumb_rect.InsideXY(posx, posy):

    95

                self.ThumbScrollingStartPos = wx.Point(posx, posy)

    96

            elif posy < thumb_rect.y:

    97

                self.Parent.ScrollToLast()

    98

            elif posy > thumb_rect.y + thumb_rect.height:

    99

                self.Parent.ScrollToFirst()

   100

        elif posy < width:

   101

            self.Parent.ScrollMessagePanelByPage(1)

   102

        elif posy > height - width:

   103

            self.Parent.ScrollMessagePanelByPage(-1)

   104

        event.Skip()

   105

   106

    def OnLeftUp(self, event):

   107

        self.ThumbScrollingStartPos = None

   108

        self.RefreshThumbPosition(0.)

   109

        if self.HasCapture():

   110

            self.ReleaseMouse()

   111

        event.Skip()

   112

   113

    def OnMotion(self, event):

   114

        if event.Dragging() and self.ThumbScrollingStartPos is not None:

   115

            posx, posy = event.GetPosition()

   116

            width, height = self.GetClientSize()

   117

            range_rect = self.GetRangeRect()

   118

            thumb_size = range_rect.height * THUMB_SIZE_RATIO

   119

            thumb_range = range_rect.height - thumb_size

   120

            self.RefreshThumbPosition(

   121

                max(-1., min((posy - self.ThumbScrollingStartPos.y) * 2. / thumb_range, 1.)))

   122

        event.Skip()

   123

   124

    def OnResize(self, event):

   125

        self.Refresh()

   126

        event.Skip()

   127

   128

    def OnEraseBackground(self, event):

   129

        pass

   130

   131

    def OnPaint(self, event):

   132

        dc = wx.BufferedPaintDC(self)

   133

        dc.Clear()

   134

        dc.BeginDrawing()

   135

   136

        gc = wx.GCDC(dc)

   137

   138

        width, height = self.GetClientSize()

   139

   140

        gc.SetPen(wx.Pen(wx.NamedColour("GREY"), 2))

   141

        gc.SetBrush(wx.GREY_BRUSH)

   142

   143

        gc.DrawLines(ArrowPoints(wx.TOP, width, width * 0.75, 2 * width))

   144

        gc.DrawLines(ArrowPoints(wx.TOP, width, width * 0.75, 2 * width + 6))

   145

   146

        gc.DrawLines(ArrowPoints(wx.BOTTOM, width, width * 0.75, height - 2 * width))

   147

        gc.DrawLines(ArrowPoints(wx.BOTTOM, width, width * 0.75, height - 2 * width - 6))

   148

   149

        thumb_rect = self.GetThumbRect()

   150

        exclusion_rect = wx.Rect(thumb_rect.x, thumb_rect.y,

   151

                                 thumb_rect.width, thumb_rect.height)

   152

        if self.Parent.IsMessagePanelTop():

   153

            exclusion_rect.y, exclusion_rect.height = width, exclusion_rect.y + exclusion_rect.height - width

   154

        if self.Parent.IsMessagePanelBottom():

   155

            exclusion_rect.height = height - width - exclusion_rect.y

   156

        if exclusion_rect != thumb_rect:

   157

            colour = wx.NamedColour("LIGHT GREY")

   158

            gc.SetPen(wx.Pen(colour))

   159

            gc.SetBrush(wx.Brush(colour))

   160

   161

            gc.DrawRectangle(exclusion_rect.x, exclusion_rect.y, 

   162

                             exclusion_rect.width, exclusion_rect.height)

   163

   164

        gc.SetPen(wx.GREY_PEN)

   165

        gc.SetBrush(wx.GREY_BRUSH)

   166

   167

        gc.DrawPolygon(ArrowPoints(wx.TOP, width, width, 0))

   168

   169

        gc.DrawPolygon(ArrowPoints(wx.BOTTOM, width, width, height))

   170

   171

        gc.DrawRectangle(thumb_rect.x, thumb_rect.y, 

   172

                         thumb_rect.width, thumb_rect.height)

   173

   174

        dc.EndDrawing()

   175

        event.Skip()

   176

   177

BUTTON_SIZE = (30, 15)

   178

   179

class LogButton():

   180

   181

    def __init__(self, label, callback):

   182

        self.Position = wx.Point(0, 0)

   183

        self.Size = wx.Size(*BUTTON_SIZE)

   184

        if wx.Platform == '__WXMSW__':

   185

            self.Font = wx.Font(8, wx.SWISS, wx.NORMAL, wx.NORMAL, faceName='Courier New')

   186

        else:

   187

            self.Font = wx.Font(10, wx.SWISS, wx.NORMAL, wx.NORMAL, faceName='Courier')

   188

        self.Label = label

   189

        self.Shown = True

   190

        self.Callback = callback

   191

   192

    def __del__(self):

   193

        self.callback = None

   194

   195

    def GetSize(self):

   196

        return self.Size

   197

   198

    def SetPosition(self, x, y):

   199

        self.Position = wx.Point(x, y)

   200

   201

    def HitTest(self, x, y):

   202

        rect = wx.Rect(self.Position.x, self.Position.y, 

   203

                       self.Size.width, self.Size.height)

   204

        if rect.InsideXY(x, y):

   205

            return True

   206

        return False

   207

   208

    def ProcessCallback(self):

   209

        if self.Callback is not None:

   210

            wx.CallAfter(self.Callback)

   211

   212

    def Draw(self, dc):

   213

        dc.SetPen(wx.TRANSPARENT_PEN)

   214

        dc.SetBrush(wx.Brush(wx.NamedColour("LIGHT GREY")))

   215

   216

        dc.DrawRectangle(self.Position.x, self.Position.y, 

   217

                         self.Size.width, self.Size.height)

   218

   219

        dc.SetFont(self.Font)

   220

   221

        w, h = dc.GetTextExtent(self.Label)

   222

        dc.DrawText(self.Label, 

   223

            self.Position.x + (self.Size.width - w) / 2, 

   224

            self.Position.y + (self.Size.height - h) / 2)

   225

   226

DATE_INFO_SIZE = 10

   227

MESSAGE_INFO_SIZE = 30

   228

   229

class LogMessage:

   230

   231

    def __init__(self, tv_sec, tv_nsec, level, level_bitmap, msg):

   232

        self.Date = datetime.fromtimestamp(tv_sec)

   233

        self.Seconds = self.Date.second + tv_nsec * 1e-9

   234

        self.Date = self.Date.replace(second=0)

   235

        self.Timestamp = tv_sec + tv_nsec * 1e-9

   236

        self.Level = level

   237

        self.LevelBitmap = level_bitmap

   238

        self.Message = msg

   239

        self.DrawDate = True

   240

   241

    def __cmp__(self, other):

   242

        if self.Date == other.Date:

   243

            return cmp(self.Seconds, other.Seconds)

   244

        return cmp(self.Date, other.Date)

   245

   246

    def Draw(self, dc, offset, width, draw_date):

   247

        if draw_date:

   248

            datetime_text = self.Date.strftime("%d/%m/%y %H:%M")

   249

            dw, dh = dc.GetTextExtent(datetime_text)

   250

            dc.DrawText(datetime_text, (width - dw) / 2, offset + (DATE_INFO_SIZE - dh) / 2)

   251

            offset += DATE_INFO_SIZE

   252

   253

        seconds_text = "%12.9f" % self.Seconds

   254

        sw, sh = dc.GetTextExtent(seconds_text)

   255

        dc.DrawText(seconds_text, 5, offset + (MESSAGE_INFO_SIZE - sh) / 2)

   256

   257

        bw, bh = self.LevelBitmap.GetWidth(), self.LevelBitmap.GetHeight()

   258

        dc.DrawBitmap(self.LevelBitmap, 10 + sw, offset + (MESSAGE_INFO_SIZE - bh) / 2)

   259

   260

        mw, mh = dc.GetTextExtent(self.Message)

   261

        dc.DrawText(self.Message, 15 + sw + bw, offset + (MESSAGE_INFO_SIZE - mh) / 2)

   262

   263

    def GetHeight(self, draw_date):

   264

        if draw_date:

   265

            return DATE_INFO_SIZE + MESSAGE_INFO_SIZE

   266

        return MESSAGE_INFO_SIZE

   267

   268

SECOND = 1

   269

MINUTE = 60 * SECOND

   270

HOUR = 60 * MINUTE

   271

DAY = 24 * HOUR

   272

   273

CHANGE_TIMESTAMP_BUTTONS = [(_("1d"), DAY),

   274

                            (_("1h"), HOUR),

   275

                            (_("1m"), MINUTE),

   276

                            (_("1s"), SECOND)]

   277

   278

class LogViewer(DebugViewer, wx.Panel):

   279

   280

    def __init__(self, parent, window):

   281

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

   282

        DebugViewer.__init__(self, None, False, False)

   283

   284

        main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=5)

   285

        main_sizer.AddGrowableCol(0)

   286

        main_sizer.AddGrowableRow(1)

   287

   288

        filter_sizer = wx.BoxSizer(wx.HORIZONTAL)

   289

        main_sizer.AddSizer(filter_sizer, border=5, flag=wx.TOP|wx.LEFT|wx.RIGHT|wx.GROW)

   290

   291

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

   292

        self.MessageFilter.Append(_("All"))

   293

        levels = LogLevels[:3]

   294

        levels.reverse()

   295

        for level in levels:

   296

            self.MessageFilter.Append(_(level))

   297

        self.Bind(wx.EVT_COMBOBOX, self.OnMessageFilterChanged, self.MessageFilter)

   298

        filter_sizer.AddWindow(self.MessageFilter, 1, border=5, flag=wx.RIGHT|wx.GROW)

   299

   300

        self.SearchMessage = wx.SearchCtrl(self, style=wx.TE_PROCESS_ENTER)

   301

        self.SearchMessage.ShowSearchButton(True)

   302

        self.SearchMessage.ShowCancelButton(True)

   303

        self.Bind(wx.EVT_TEXT_ENTER, self.OnSearchMessageChanged, self.SearchMessage)

   304

        self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN, 

   305

              self.OnSearchMessageSearchButtonClick, self.SearchMessage)

   306

        self.Bind(wx.EVT_SEARCHCTRL_CANCEL_BTN, 

   307

              self.OnSearchMessageCancelButtonClick, self.SearchMessage)

   308

        filter_sizer.AddWindow(self.SearchMessage, 3, flag=wx.GROW)

   309

   310

        message_panel_sizer = wx.FlexGridSizer(cols=2, hgap=0, rows=1, vgap=0)

   311

        message_panel_sizer.AddGrowableCol(0)

   312

        message_panel_sizer.AddGrowableRow(0)

   313

        main_sizer.AddSizer(message_panel_sizer, border=5, flag=wx.LEFT|wx.RIGHT|wx.BOTTOM|wx.GROW)

   314

   315

        self.MessagePanel = wx.Panel(self)

   316

        if wx.Platform == '__WXMSW__':

   317

            self.Font = wx.Font(10, wx.SWISS, wx.NORMAL, wx.NORMAL, faceName='Courier New')

   318

        else:

   319

            self.Font = wx.Font(12, wx.SWISS, wx.NORMAL, wx.NORMAL, faceName='Courier')

   320

        self.MessagePanel.Bind(wx.EVT_LEFT_UP, self.OnMessagePanelLeftUp)

   321

        self.MessagePanel.Bind(wx.EVT_LEFT_DCLICK, self.OnMessagePanelLeftDCLick)

   322

        self.MessagePanel.Bind(wx.EVT_MOUSEWHEEL, self.OnMessagePanelMouseWheel)

   323

        self.MessagePanel.Bind(wx.EVT_ERASE_BACKGROUND, self.OnMessagePanelEraseBackground)

   324

        self.MessagePanel.Bind(wx.EVT_PAINT, self.OnMessagePanelPaint)

   325

        self.MessagePanel.Bind(wx.EVT_SIZE, self.OnMessagePanelResize)

   326

        message_panel_sizer.AddWindow(self.MessagePanel, flag=wx.GROW)

   327

   328

        self.MessageScrollBar = LogScrollBar(self, wx.Size(16, -1))

   329

        message_panel_sizer.AddWindow(self.MessageScrollBar, flag=wx.GROW)

   330

   331

        self.SetSizer(main_sizer)

   332

   333

        self.LeftButtons = []

   334

        for label, callback in [("+" + text, self.GenerateOnDurationButton(duration)) 

   335

                                for text, duration in CHANGE_TIMESTAMP_BUTTONS]:

   336

            self.LeftButtons.append(LogButton(label, callback))

   337

   338

        self.RightButtons = []

   339

        for label, callback in [("-" + text, self.GenerateOnDurationButton(-duration)) 

   340

                                for text, duration in CHANGE_TIMESTAMP_BUTTONS]:

   341

            self.RightButtons.append(LogButton(label, callback))

   342

   343

        self.MessageFilter.SetSelection(0)

   344

        self.LogSource = None

   345

        self.ResetLogMessages()

   346

        self.ParentWindow = window

   347

   348

        self.LevelIcons = [GetBitmap("LOG_" + level) for level in LogLevels]

   349

        self.LevelFilters = [range(i) for i in xrange(4, 0, -1)]

   350

        self.CurrentFilter = self.LevelFilters[0]

   351

        self.CurrentSearchValue = ""

   352

   353

        self.ScrollSpeed = 0.

   354

        self.LastStartTime = None

   355

        self.ScrollTimer = wx.Timer(self, -1)

   356

        self.Bind(wx.EVT_TIMER, self.OnScrollTimer, self.ScrollTimer)

   357

   358

    def __del__(self):

   359

        self.ScrollTimer.Stop()

   360

   361

    def ResetLogMessages(self):

   362

        self.previous_log_count = [None]*LogLevelsCount

   363

        self.OldestMessages = []

   364

        self.LogMessages = []

   365

        self.LogMessagesTimestamp = numpy.array([])

   366

        self.CurrentMessage = None

   367

        self.HasNewData = False

   368

   369

    def SetLogSource(self, log_source):

   370

        self.LogSource = log_source

   371

        if log_source is not None:

   372

            self.ResetLogMessages()

   373

            self.RefreshView()

   374

   375

    def GetLogMessageFromSource(self, msgidx, level):

   376

        if self.LogSource is not None:

   377

            answer = self.LogSource.GetLogMessage(level, msgidx)

   378

            if answer is not None:

   379

                msg, tick, tv_sec, tv_nsec = answer

   380

                return LogMessage(tv_sec, tv_nsec, level, self.LevelIcons[level], msg)

   381

        return None

   382

   383

    def SetLogCounters(self, log_count):

   384

        new_messages = []

   385

        for level, count, prev in zip(xrange(LogLevelsCount), log_count, self.previous_log_count):

   386

            if count is not None and prev != count:

   387

                if prev is None:

   388

                    dump_end = count - 2

   389

                else:

   390

                    dump_end = prev - 1

   391

                for msgidx in xrange(count-1, dump_end,-1):

   392

                    new_message = self.GetLogMessageFromSource(msgidx, level)

   393

                    if new_message is not None:

   394

                        if prev is None:

   395

                            self.OldestMessages.append((msgidx, new_message))

   396

                            if len(new_messages) == 0 or new_message > new_messages[0]:

   397

                                new_messages = [new_message]

   398

                        else:

   399

                            new_messages.insert(0, new_message)

   400

                    else:

   401

                        if prev is None:

   402

                            self.OldestMessages.append((-1, None))

   403

                        break

   404

                self.previous_log_count[level] = count

   405

        new_messages.sort()

   406

        if len(new_messages) > 0:

   407

            self.HasNewData = True

   408

            old_length = len(self.LogMessages)

   409

            for new_message in new_messages:

   410

                self.LogMessages.append(new_message)

   411

                self.LogMessagesTimestamp = numpy.append(self.LogMessagesTimestamp, [new_message.Timestamp])

   412

            if self.CurrentMessage is None or self.CurrentMessage == old_length - 1:

   413

                self.CurrentMessage = len(self.LogMessages) - 1

   414

            self.NewDataAvailable(None)

   415

   416

    def FilterLogMessage(self, message, timestamp=None):

   417

        return (message.Level in self.CurrentFilter and 

   418

                message.Message.find(self.CurrentSearchValue) != -1 and

   419

                (timestamp is None or message.Timestamp < timestamp))

   420

   421

    def GetMessageByTimestamp(self, timestamp):

   422

        if self.CurrentMessage is not None:

   423

            msgidx = numpy.argmin(abs(self.LogMessagesTimestamp - timestamp))

   424

            message = self.LogMessages[msgidx]

   425

            if self.FilterLogMessage(message) and message.Timestamp > timestamp:

   426

                return self.GetPreviousMessage(msgidx, timestamp)

   427

            return message, msgidx

   428

        return None, None

   429

   430

    def GetNextMessage(self, msgidx):

   431

        while msgidx < len(self.LogMessages) - 1:

   432

            message = self.LogMessages[msgidx + 1]

   433

            if self.FilterLogMessage(message):

   434

                return message, msgidx + 1

   435

            msgidx += 1

   436

        return None, None

   437

   438

    def GetPreviousMessage(self, msgidx, timestamp=None):

   439

        message = None

   440

        while 0 < msgidx < len(self.LogMessages):

   441

            message = self.LogMessages[msgidx - 1]

   442

            if self.FilterLogMessage(message, timestamp):

   443

                return message, msgidx - 1

   444

            msgidx -= 1

   445

        if len(self.LogMessages) > 0:

   446

            message = self.LogMessages[0]

   447

            while message is not None:

   448

                level = message.Level

   449

                oldest_msgidx, oldest_message = self.OldestMessages[level]

   450

                if oldest_msgidx > 0:

   451

                    old_message = self.GetLogMessageFromSource(oldest_msgidx - 1, level)

   452

                    if old_message is not None:

   453

                        self.OldestMessages[level] = (oldest_msgidx - 1, old_message)

   454

                    else:

   455

                        self.OldestMessages[level] = (-1, None)

   456

                else:

   457

                    self.OldestMessages[level] = (-1, None)

   458

                message = None

   459

                for idx, msg in self.OldestMessages:

   460

                    if msg is not None and (message is None or msg > message):

   461

                        message = msg

   462

                if message is not None:

   463

                    self.LogMessages.insert(0, message)

   464

                    self.LogMessagesTimestamp = numpy.insert(self.LogMessagesTimestamp, [0], [message.Timestamp])

   465

                    if self.CurrentMessage is not None:

   466

                        self.CurrentMessage += 1

   467

                    else:

   468

                        self.CurrentMessage = 0

   469

                    if self.FilterLogMessage(message, timestamp):

   470

                        return message, 0

   471

        return None, None

   472

   473

    def RefreshNewData(self, *args, **kwargs):

   474

        if self.HasNewData:

   475

            self.HasNewData = False

   476

            self.RefreshView()

   477

        DebugViewer.RefreshNewData(self, *args, **kwargs)

   478

   479

    def RefreshView(self):

   480

        width, height = self.MessagePanel.GetClientSize()

   481

        bitmap = wx.EmptyBitmap(width, height)

   482

        dc = wx.BufferedDC(wx.ClientDC(self.MessagePanel), bitmap)

   483

        dc.Clear()

   484

        dc.BeginDrawing()

   485

   486

        if self.CurrentMessage is not None:

   487

   488

            for button in self.LeftButtons + self.RightButtons:

   489

                button.Draw(dc)

   490

   491

            dc.SetFont(self.Font)

   492

   493

            message_idx = self.CurrentMessage

   494

            message = self.LogMessages[message_idx]

   495

            draw_date = True

   496

            offset = 5

   497

            while offset < height and message is not None:

   498

                message.Draw(dc, offset, width, draw_date)

   499

                offset += message.GetHeight(draw_date)

   500

   501

                previous_message, message_idx = self.GetPreviousMessage(message_idx)

   502

                if previous_message is not None:

   503

                    draw_date = message.Date != previous_message.Date

   504

                message = previous_message

   505

   506

        dc.EndDrawing()

   507

   508

        self.MessageScrollBar.RefreshThumbPosition()

   509

   510