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

    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_PAINT, self.OnPaint)

    55

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

    56

    57

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

    58

        self.ThumbScrollingStartPos = None

    59

    60

    def GetRangeRect(self):

    61

        width, height = self.GetClientSize()

    62

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

    63

    64

    def GetThumbRect(self):

    65

        width, height = self.GetClientSize()

    66

        range_rect = self.GetRangeRect()

    67

        thumb_size = range_rect.height * THUMB_SIZE_RATIO

    68

        thumb_range = range_rect.height - thumb_size

    69

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

    70

        thumb_start = int(thumb_center_position - thumb_size / 2.)

    71

        thumb_end = int(thumb_center_position + thumb_size / 2.)

    72

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

    73

    74

    def RefreshThumbPosition(self, thumb_position=None):

    75

        if thumb_position is None:

    76

            thumb_position = self.ThumbPosition

    77

        if self.Parent.IsMessagePanelTop():

    78

            thumb_position = max(0., thumb_position)

    79

        if self.Parent.IsMessagePanelBottom():

    80

            thumb_position = min(0., thumb_position)

    81

        if thumb_position != self.ThumbPosition:

    82

            self.ThumbPosition = thumb_position

    83

            self.Parent.SetScrollSpeed(self.ThumbPosition)

    84

        self.Refresh()

    85

    86

    def OnLeftDown(self, event):

    87

        self.CaptureMouse()

    88

        posx, posy = event.GetPosition()

    89

        width, height = self.GetClientSize()

    90

        range_rect = self.GetRangeRect()

    91

        thumb_rect = self.GetThumbRect()

    92

        if range_rect.InsideXY(posx, posy):

    93

            if thumb_rect.InsideXY(posx, posy):

    94

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

    95

            elif posy < thumb_rect.y:

    96

                self.Parent.ScrollToLast()

    97

            elif posy > thumb_rect.y + thumb_rect.height:

    98

                self.Parent.ScrollToFirst()

    99

        elif posy < width:

   101

        elif posy > height - width:

   103

        event.Skip()

   104

   105

    def OnLeftUp(self, event):

   106

        self.ThumbScrollingStartPos = None

   107

        self.RefreshThumbPosition(0.)

   108

        if self.HasCapture():

   109

            self.ReleaseMouse()

   110

        event.Skip()

   111

   112

    def OnMotion(self, event):

   113

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

   114

            posx, posy = event.GetPosition()

   115

            width, height = self.GetClientSize()

   116

            range_rect = self.GetRangeRect()

   117

            thumb_size = range_rect.height * THUMB_SIZE_RATIO

   118

            thumb_range = range_rect.height - thumb_size

   119

            self.RefreshThumbPosition(

   120

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

   121

        event.Skip()

   122

   123

    def OnResize(self, event):

   124

        self.Refresh()

   125

        event.Skip()

   126

   127

    def OnPaint(self, event):

   128

        dc = wx.BufferedPaintDC(self)

   129

        dc.Clear()

   130

        dc.BeginDrawing()

   131

   132

        width, height = self.GetClientSize()

   133

   143

        thumb_rect = self.GetThumbRect()

   144

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

   145

                                 thumb_rect.width, thumb_rect.height)

   146

        if self.Parent.IsMessagePanelTop():

   147

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

   148

        if self.Parent.IsMessagePanelBottom():

   149

            exclusion_rect.height = height - width - exclusion_rect.y

   150

        if exclusion_rect != thumb_rect:

   151

            colour = wx.NamedColour("LIGHT GREY")

   152

            dc.SetPen(wx.Pen(colour))

   153

            dc.SetBrush(wx.Brush(colour))

   154

   155

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

   156

                             exclusion_rect.width, exclusion_rect.height)

   157

   158

        dc.SetPen(wx.GREY_PEN)

   159

        dc.SetBrush(wx.GREY_BRUSH)

   160

   164

   165

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

   166

                         thumb_rect.width, thumb_rect.height)

   167

   168

        dc.EndDrawing()

   169

        event.Skip()

   170

   171

BUTTON_SIZE = (30, 15)

   172

   173

class LogButton():

   174

   175

    def __init__(self, label, callback):

   176

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

   177

        self.Size = wx.Size(*BUTTON_SIZE)

   178

        if wx.Platform == '__WXMSW__':

   179

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

   180

        else:

   181

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

   182

        self.Label = label

   183

        self.Shown = True

   184

        self.Callback = callback

   185

   186

    def __del__(self):

   187

        self.callback = None

   188

   189

    def GetSize(self):

   190

        return self.Size

   191

   192

    def SetPosition(self, x, y):

   193

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

   194

   195

    def HitTest(self, x, y):

   196

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

   197

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

   198

        if rect.InsideXY(x, y):

   199

            return True

   200

        return False

   201

   202

    def ProcessCallback(self):

   203

        if self.Callback is not None:

   204

            wx.CallAfter(self.Callback)

   205

   206

    def Draw(self, dc):

   207

        dc.SetPen(wx.TRANSPARENT_PEN)

   208

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

   209

   210

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

   211

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

   212

   213

        dc.SetFont(self.Font)

   214

   215

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

   216

        dc.DrawText(self.Label, 

   217

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

   218

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

   219

   220

DATE_INFO_SIZE = 10

   221

MESSAGE_INFO_SIZE = 30

   222

   223

class LogMessage:

   224

   225

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

   226

        self.Date = datetime.fromtimestamp(tv_sec)

   227

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

   228

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

   229

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

   230

        self.Level = level

   231

        self.LevelBitmap = level_bitmap

   232

        self.Message = msg

   233

        self.DrawDate = True

   234

   235

    def __cmp__(self, other):

   236

        if self.Date == other.Date:

   237

            return cmp(self.Seconds, other.Seconds)

   238

        return cmp(self.Date, other.Date)

   239

   240

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

   241

        if draw_date:

   242

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

   243

            dw, dh = dc.GetTextExtent(datetime_text)

   244

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

   245

            offset += DATE_INFO_SIZE

   246

   247

        seconds_text = "%12.9f" % self.Seconds

   248

        sw, sh = dc.GetTextExtent(seconds_text)

   249

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

   250

   251

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

   252

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

   253

   254

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

   255

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

   256

   257

    def GetHeight(self, draw_date):

   258

        if draw_date:

   259

            return DATE_INFO_SIZE + MESSAGE_INFO_SIZE

   260

        return MESSAGE_INFO_SIZE

   261

   262

SECOND = 1

   263

MINUTE = 60 * SECOND

   264

HOUR = 60 * MINUTE

   265

DAY = 24 * HOUR

   266

   267

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

   268

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

   271

   272

class LogViewer(DebugViewer, wx.Panel):

   273

   274

    def __init__(self, parent, window):

   275

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

   276

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

   277

   278

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

   279

        main_sizer.AddGrowableCol(0)

   280

        main_sizer.AddGrowableRow(1)

   281

   282

        filter_sizer = wx.BoxSizer(wx.HORIZONTAL)

   283

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

   284

   285

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

   286

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

   287

        levels = LogLevels[:3]

   288

        levels.reverse()

   289

        for level in levels:

   290

            self.MessageFilter.Append(_(level))

   291

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

   292

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

   293

   294

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

   295

        self.SearchMessage.ShowSearchButton(True)

   296

        self.SearchMessage.ShowCancelButton(True)

   297

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

   298

        self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN, 

   299

              self.OnSearchMessageSearchButtonClick, self.SearchMessage)

   300

        self.Bind(wx.EVT_SEARCHCTRL_CANCEL_BTN, 

   301

              self.OnSearchMessageCancelButtonClick, self.SearchMessage)

   302

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

   303

   304

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

   305

        message_panel_sizer.AddGrowableCol(0)

   306

        message_panel_sizer.AddGrowableRow(0)

   307

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

   308

   309

        self.MessagePanel = wx.Panel(self)

   310

        if wx.Platform == '__WXMSW__':

   311

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

   312

        else:

   313

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

   314

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

   316

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

   317

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

   318

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

   319

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

   320

   321

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

   322

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

   323

   324

        self.SetSizer(main_sizer)

   325

   326

        self.LeftButtons = []

   327

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

   328

                                for text, duration in CHANGE_TIMESTAMP_BUTTONS]:

   329

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

   330

   331

        self.RightButtons = []

   332

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

   333

                                for text, duration in CHANGE_TIMESTAMP_BUTTONS]:

   334

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

   335

   336

        self.MessageFilter.SetSelection(0)

   337

        self.LogSource = None

   338

        self.ResetLogMessages()

   339

        self.ParentWindow = window

   340

   341

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

   342

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

   343

        self.CurrentFilter = self.LevelFilters[0]

   344

        self.CurrentSearchValue = ""

   345

   346

        self.ScrollSpeed = 0.

   347

        self.LastStartTime = None

   348

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

   349

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

   350

   351

    def __del__(self):

   352

        self.ScrollTimer.Stop()

   353

   354

    def ResetLogMessages(self):

   355

        self.previous_log_count = [None]*LogLevelsCount

   356

        self.OldestMessages = []

   357

        self.LogMessages = []

   358

        self.LogMessagesTimestamp = numpy.array([])

   359

        self.CurrentMessage = None

   360

        self.HasNewData = False

   361

   362

    def SetLogSource(self, log_source):

   363

        self.LogSource = log_source

   364

        if log_source is not None:

   365

            self.ResetLogMessages()

   366

            self.RefreshView()

   367

   368

    def GetLogMessageFromSource(self, msgidx, level):

   369

        if self.LogSource is not None:

   370

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

   371

            if answer is not None:

   372

                msg, tick, tv_sec, tv_nsec = answer

   373

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

   374

        return None

   375

   376

    def SetLogCounters(self, log_count):

   377

        new_messages = []

   378

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

   379

            if count is not None and prev != count:

   380

                if prev is None:

   381

                    dump_end = count - 2

   382

                else:

   383

                    dump_end = prev - 1

   384

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

   385

                    new_message = self.GetLogMessageFromSource(msgidx, level)

   386

                    if new_message is not None:

   387

                        if prev is None:

   388

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

   389

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

   390

                                new_messages = [new_message]

   391

                        else:

   392

                            new_messages.insert(0, new_message)

   393

                    else:

   394

                        if prev is None:

   395

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

   396

                        break

   397

                self.previous_log_count[level] = count

   398

        new_messages.sort()

   399

        if len(new_messages) > 0:

   400

            self.HasNewData = True

   401

            old_length = len(self.LogMessages)

   402

            for new_message in new_messages:

   403

                self.LogMessages.append(new_message)

   404

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

   405

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

   406

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

   407

            self.NewDataAvailable(None)

   408

   409

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

   410

        return (message.Level in self.CurrentFilter and 

   411

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

   412

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

   413

   414

    def GetMessageByTimestamp(self, timestamp):

   415

        if self.CurrentMessage is not None:

   416

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

   417

            message = self.LogMessages[msgidx]

   418

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

   419

                return self.GetPreviousMessage(msgidx, timestamp)

   420

            return message, msgidx

   421

        return None, None

   422

   423

    def GetNextMessage(self, msgidx):

   424

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

   425

            message = self.LogMessages[msgidx + 1]

   426

            if self.FilterLogMessage(message):

   427

                return message, msgidx + 1

   428

            msgidx += 1

   429

        return None, None

   430

   431

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

   432

        message = None

   433

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

   434

            message = self.LogMessages[msgidx - 1]

   435

            if self.FilterLogMessage(message, timestamp):

   436

                return message, msgidx - 1

   437

            msgidx -= 1

   438

        if len(self.LogMessages) > 0:

   439

            message = self.LogMessages[0]

   440

            while message is not None:

   441

                level = message.Level

   442

                oldest_msgidx, oldest_message = self.OldestMessages[level]

   443

                if oldest_msgidx > 0:

   444

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

   445

                    if old_message is not None:

   446

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

   447

                    else:

   448

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

   449

                else:

   450

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

   451

                message = None

   452

                for idx, msg in self.OldestMessages:

   453

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

   454

                        message = msg

   455

                if message is not None:

   456

                    self.LogMessages.insert(0, message)

   457

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

   458

                    if self.CurrentMessage is not None:

   459

                        self.CurrentMessage += 1

   460

                    else:

   461

                        self.CurrentMessage = 0

   462

                    if self.FilterLogMessage(message, timestamp):

   463

                        return message, 0

   464

        return None, None

   465

   466

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

   467

        if self.HasNewData:

   468

            self.HasNewData = False

   469

            self.RefreshView()

   470

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

   471

   472

    def RefreshView(self):

   473

        width, height = self.MessagePanel.GetClientSize()

   474

        bitmap = wx.EmptyBitmap(width, height)

   475

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

   476

        dc.Clear()

   477

        dc.BeginDrawing()

   478

   479

        if self.CurrentMessage is not None:

   480

   481

            for button in self.LeftButtons + self.RightButtons:

   482

                button.Draw(dc)

   483

   484

            dc.SetFont(self.Font)

   485

   486

            message_idx = self.CurrentMessage

   487

            message = self.LogMessages[message_idx]

   488

            draw_date = True

   489

            offset = 5

   490

            while offset < height and message is not None:

   491

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

   492

                offset += message.GetHeight(draw_date)

   493

   494

                previous_message, message_idx = self.GetPreviousMessage(message_idx)

   495

                if previous_message is not None:

   496

                    draw_date = message.Date != previous_message.Date

   497

                message = previous_message

   498

   499

        dc.EndDrawing()

   500

   501

        self.MessageScrollBar.RefreshThumbPosition()

   502

   503

    def IsMessagePanelTop(self, message_idx=None):

   504

        if message_idx is None:

   505

            message_idx = self.CurrentMessage

   506

        if message_idx is not None:

   507

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

   508

        return True

   509

   510

    def IsMessagePanelBottom(self, message_idx=None):

   511

        if message_idx is None: