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

    38

    39

    def __init__(self, parent, size):

    40

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

    41

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

    42

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

    43

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

    44

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

    45

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

    46

    47

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

    48

        self.ThumbScrollingStartPos = None

    49

    50

    def GetRangeRect(self):

    51

        width, height = self.GetClientSize()

    52

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

    53

    54

    def GetThumbRect(self):

    55

        width, height = self.GetClientSize()

    56

        range_rect = self.GetRangeRect()

    57

        thumb_size = range_rect.height * THUMB_SIZE_RATIO

    58

        thumb_range = range_rect.height - thumb_size

    59

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

    60

        thumb_start = int(thumb_center_position - thumb_size / 2.)

    61

        thumb_end = int(thumb_center_position + thumb_size / 2.)

    62

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

    63

    64

    def RefreshThumbPosition(self, thumb_position=None):

    65

        if thumb_position is None:

    66

            thumb_position = self.ThumbPosition

    67

        if self.Parent.IsMessagePanelTop():

    68

            thumb_position = max(0., thumb_position)

    69

        if self.Parent.IsMessagePanelBottom():

    70

            thumb_position = min(0., thumb_position)

    71

        if thumb_position != self.ThumbPosition:

    72

            self.ThumbPosition = thumb_position

    73

            self.Parent.SetScrollSpeed(self.ThumbPosition)

    74

        self.Refresh()

    75

    76

    def OnLeftDown(self, event):

    77

        self.CaptureMouse()

    78

        posx, posy = event.GetPosition()

    79

        width, height = self.GetClientSize()

    80

        range_rect = self.GetRangeRect()

    81

        thumb_rect = self.GetThumbRect()

    82

        if range_rect.InsideXY(posx, posy):

    83

            if thumb_rect.InsideXY(posx, posy):

    84

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

    85

            elif posy < thumb_rect.y:

    86

                self.Parent.ScrollToLast()

    87

            elif posy > thumb_rect.y + thumb_rect.height:

    88

                self.Parent.ScrollToFirst()

    89

        elif posy < width:

    90

            self.Parent.ScrollMessagePanelByTimestamp(1)

    91

        elif posy > height - width:

    92

            self.Parent.ScrollMessagePanelByTimestamp(-1)

    93

        event.Skip()

    94

    95

    def OnLeftUp(self, event):

    96

        self.ThumbScrollingStartPos = None

    97

        self.RefreshThumbPosition(0.)

    98

        if self.HasCapture():

    99

            self.ReleaseMouse()

   100

        event.Skip()

   101

   102

    def OnMotion(self, event):

   103

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

   104

            posx, posy = event.GetPosition()

   105

            width, height = self.GetClientSize()

   106

            range_rect = self.GetRangeRect()

   107

            thumb_size = range_rect.height * THUMB_SIZE_RATIO

   108

            thumb_range = range_rect.height - thumb_size

   109

            self.RefreshThumbPosition(

   110

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

   111

        event.Skip()

   112

   113

    def OnResize(self, event):

   114

        self.Refresh()

   115

        event.Skip()

   116

   117

    def OnPaint(self, event):

   118

        dc = wx.BufferedPaintDC(self)

   119

        dc.Clear()

   120

        dc.BeginDrawing()

   121

   122

        width, height = self.GetClientSize()

   123

   124

        thumb_rect = self.GetThumbRect()

   125

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

   126

                                 thumb_rect.width, thumb_rect.height)

   127

        if self.Parent.IsMessagePanelTop():

   128

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

   129

        if self.Parent.IsMessagePanelBottom():

   130

            exclusion_rect.height = height - width - exclusion_rect.y

   131

        if exclusion_rect != thumb_rect:

   132

            colour = wx.NamedColour("LIGHT GREY")

   133

            dc.SetPen(wx.Pen(colour))

   134

            dc.SetBrush(wx.Brush(colour))

   135

   136

            dc.DrawRectangle(exclusion_rect.x, exclusion_rect.y, 

   137

                             exclusion_rect.width, exclusion_rect.height)

   138

   139

        dc.SetPen(wx.GREY_PEN)

   140

        dc.SetBrush(wx.GREY_BRUSH)

   141

   142

        dc.DrawPolygon([wx.Point(width / 2, 1),

   143

                        wx.Point(1, width - 2),

   144

                        wx.Point(width - 1, width - 2)])

   145

   146

        dc.DrawPolygon([wx.Point(width / 2, height - 1),

   147

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

   148

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

   149

   150

        dc.DrawRectangle(thumb_rect.x, thumb_rect.y, 

   151

                         thumb_rect.width, thumb_rect.height)

   152

   153

        dc.EndDrawing()

   154

        event.Skip()

   155

   205

DATE_INFO_SIZE = 10

   206

MESSAGE_INFO_SIZE = 30

   207

   208

class LogMessage:

   209

   210

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

   211

        self.Date = datetime.fromtimestamp(tv_sec)

   212

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

   213

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

   214

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

   215

        self.Level = level

   216

        self.LevelBitmap = level_bitmap

   217

        self.Message = msg

   218

        self.DrawDate = True

   219

   220

    def __cmp__(self, other):

   221

        if self.Date == other.Date:

   222

            return cmp(self.Seconds, other.Seconds)

   223

        return cmp(self.Date, other.Date)

   224

   225

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

   226

        if draw_date:

   227

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

   228

            dw, dh = dc.GetTextExtent(datetime_text)

   229

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

   230

            offset += DATE_INFO_SIZE

   231

   232

        seconds_text = "%12.9f" % self.Seconds

   233

        sw, sh = dc.GetTextExtent(seconds_text)

   234

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

   235

   236

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

   237

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

   238

   239

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

   240

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

   241

   242

    def GetHeight(self, draw_date):

   243

        if draw_date:

   244

            return DATE_INFO_SIZE + MESSAGE_INFO_SIZE

   245

        return MESSAGE_INFO_SIZE

   246

   247

SECOND = 1

   248

MINUTE = 60 * SECOND

   249

HOUR = 60 * MINUTE

   250

DAY = 24 * HOUR

   251

   252

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

   253

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

   254

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

   255

   256

class LogViewer(DebugViewer, wx.Panel):

   257

   258

    def __init__(self, parent, window):

   259

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

   260

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

   261

   262

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

   263

        main_sizer.AddGrowableCol(0)

   264

        main_sizer.AddGrowableRow(1)

   265

   266

        filter_sizer = wx.BoxSizer(wx.HORIZONTAL)

   267

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

   268

   269

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

   270

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

   271

        levels = LogLevels[:3]

   272

        levels.reverse()

   273

        for level in levels:

   274

            self.MessageFilter.Append(_(level))

   275

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

   276

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

   277

   278

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

   279

        self.SearchMessage.ShowSearchButton(True)

   280

        self.SearchMessage.ShowCancelButton(True)

   281

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

   282

        self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN, 

   283

              self.OnSearchMessageSearchButtonClick, self.SearchMessage)

   284

        self.Bind(wx.EVT_SEARCHCTRL_CANCEL_BTN, 

   285

              self.OnSearchMessageCancelButtonClick, self.SearchMessage)

   286

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

   287

   290

        message_panel_sizer.AddGrowableRow(0)

   291

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

   292

   293

        self.MessagePanel = wx.Panel(self)

   294

        if wx.Platform == '__WXMSW__':

   295

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

   296

        else:

   299

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

   300

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

   301

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

   302

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

   303

   305

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

   306

   307

        self.SetSizer(main_sizer)

   319

        self.MessageFilter.SetSelection(0)

   320

        self.LogSource = None

   321

        self.ResetLogMessages()

   322

        self.ParentWindow = window

   323

   324

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

   325

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

   326

        self.CurrentFilter = self.LevelFilters[0]

   327

        self.CurrentSearchValue = ""

   328

   329

        self.ScrollSpeed = 0.

   330

        self.LastStartTime = None

   331

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

   332

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

   333

   334

    def __del__(self):

   335

        self.ScrollTimer.Stop()

   336

   337

    def ResetLogMessages(self):

   338

        self.previous_log_count = [None]*LogLevelsCount

   339

        self.OldestMessages = []

   340

        self.LogMessages = []

   341

        self.LogMessagesTimestamp = numpy.array([])

   342

        self.CurrentMessage = None

   343

        self.HasNewData = False

   344

   345

    def SetLogSource(self, log_source):

   346

        self.LogSource = log_source

   347

        if log_source is not None:

   348

            self.ResetLogMessages()

   349

            self.RefreshView()

   350

   351

    def GetLogMessageFromSource(self, msgidx, level):

   352

        if self.LogSource is not None:

   353

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

   354

            if answer is not None:

   355

                msg, tick, tv_sec, tv_nsec = answer

   356

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

   357

        return None

   358

   359

    def SetLogCounters(self, log_count):

   360

        new_messages = []

   361

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

   362

            if count is not None and prev != count:

   363

                if prev is None:

   364

                    dump_end = count - 2

   365

                else:

   366

                    dump_end = prev - 1

   367

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

   368

                    new_message = self.GetLogMessageFromSource(msgidx, level)

   369

                    if new_message is not None:

   370

                        if prev is None:

   371

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

   372

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

   373

                                new_messages = [new_message]

   374

                        else:

   375

                            new_messages.insert(0, new_message)

   376

                    else:

   377

                        if prev is None:

   378

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

   379

                        break

   380

                self.previous_log_count[level] = count

   381

        new_messages.sort()

   382

        if len(new_messages) > 0:

   383

            self.HasNewData = True

   384

            old_length = len(self.LogMessages)

   385

            for new_message in new_messages:

   386

                self.LogMessages.append(new_message)

   387

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

   388

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

   389

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

   390

            self.NewDataAvailable(None)

   391

   392

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

   393

        return (message.Level in self.CurrentFilter and 

   394

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

   395

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

   396

   397

    def GetMessageByTimestamp(self, timestamp):

   398

        if self.CurrentMessage is not None:

   399

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

   400

            message = self.LogMessages[msgidx]

   401

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

   402

                return self.GetPreviousMessage(msgidx, timestamp)

   403

            return message, msgidx

   404

        return None, None

   405

   406

    def GetNextMessage(self, msgidx):

   407

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

   408

            message = self.LogMessages[msgidx + 1]

   409

            if self.FilterLogMessage(message):

   410

                return message, msgidx + 1

   411

            msgidx += 1

   412

        return None, None

   413

   414

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

   415

        message = None

   416

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

   417

            message = self.LogMessages[msgidx - 1]

   418

            if self.FilterLogMessage(message, timestamp):

   419

                return message, msgidx - 1

   420

            msgidx -= 1

   421

        if len(self.LogMessages) > 0:

   422

            message = self.LogMessages[0]

   423

            while message is not None:

   424

                level = message.Level

   425

                oldest_msgidx, oldest_message = self.OldestMessages[level]

   426

                if oldest_msgidx > 0:

   427

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

   428

                    if old_message is not None:

   429

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

   430

                    else:

   431

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

   432

                else:

   433

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

   434

                message = None

   435

                for idx, msg in self.OldestMessages:

   436

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

   437

                        message = msg

   438

                if message is not None:

   439

                    self.LogMessages.insert(0, message)

   440

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

   441

                    if self.CurrentMessage is not None:

   442

                        self.CurrentMessage += 1

   443

                    else:

   444

                        self.CurrentMessage = 0

   445

                    if self.FilterLogMessage(message, timestamp):

   446

                        return message, 0

   447

        return None, None

   448

   449

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

   450

        if self.HasNewData:

   451

            self.HasNewData = False

   452

            self.RefreshView()

   453

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

   454

   455

    def RefreshView(self):

   456

        width, height = self.MessagePanel.GetClientSize()

   457

        bitmap = wx.EmptyBitmap(width, height)

   458

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

   459

        dc.Clear()

   460

        dc.BeginDrawing()

   461

   462

        if self.CurrentMessage is not None:

   469

            message_idx = self.CurrentMessage

   470

            message = self.LogMessages[message_idx]

   471

            draw_date = True

   472

            offset = 5

   473

            while offset < height and message is not None:

   474

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

   475

                offset += message.GetHeight(draw_date)

   476

   477

                previous_message, message_idx = self.GetPreviousMessage(message_idx)

   478

                if previous_message is not None:

   479

                    draw_date = message.Date != previous_message.Date

   480

                message = previous_message

   481

   482

        dc.EndDrawing()

   483

   484

        self.MessageScrollBar.RefreshThumbPosition()

   485

   486

    def IsMessagePanelTop(self, message_idx=None):

   487

        if message_idx is None:

   488

            message_idx = self.CurrentMessage

   489

        if message_idx is not None:

   490

            return self.GetNextMessage(message_idx)[0] is None

   491

        return True

   492

   493

    def IsMessagePanelBottom(self, message_idx=None):

   494

        if message_idx is None:

   495

            message_idx = self.CurrentMessage

   496

        if message_idx is not None:

   497

            width, height = self.MessagePanel.GetClientSize()

   498

            offset = 5

   499

            message = self.LogMessages[message_idx]

   500

            draw_date = True

   501

            while message is not None and offset < height:

   502

                offset += message.GetHeight(draw_date)

   503

                previous_message, message_idx = self.GetPreviousMessage(message_idx)

   504

                if previous_message is not None:

   505

                    draw_date = message.Date != previous_message.Date

   506

                message = previous_message

   507

            return offset < height

   508

        return True

   509

   510

    def ScrollMessagePanel(self, scroll):

   511

        if self.CurrentMessage is not None:

   512

            message = self.LogMessages[self.CurrentMessage]

   513

            while scroll > 0 and message is not None: