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

     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 controls.CustomToolTip import CustomToolTip, TOOLTIP_WAIT_PERIOD

    32

from editors.DebugViewer import DebugViewer, REFRESH_PERIOD

    33

from targets.typemapping import LogLevelsCount, LogLevels

    34

from util.BitmapLibrary import GetBitmap

    36

    37

THUMB_SIZE_RATIO = 1. / 8.

    38

    39

def ArrowPoints(direction, width, height, xoffset, yoffset):

    40

    if direction == wx.TOP:

    41

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

    42

                wx.Point(xoffset + width / 2, yoffset + 1),

    43

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

    44

    else:

    45

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

    46

                wx.Point(xoffset + width / 2, yoffset - 2),

    47

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

    48

    49

class LogScrollBar(wx.Panel):

    51

    def __init__(self, parent, size):

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    60

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

    61

        self.ThumbScrollingStartPos = None

    63

    def GetRangeRect(self):

    64

        width, height = self.GetClientSize()

    65

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

    67

    def GetThumbRect(self):

    68

        width, height = self.GetClientSize()

    69

        range_rect = self.GetRangeRect()

    70

        thumb_size = range_rect.height * THUMB_SIZE_RATIO

    71

        thumb_range = range_rect.height - thumb_size

    72

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

    73

        thumb_start = int(thumb_center_position - thumb_size / 2.)

    74

        thumb_end = int(thumb_center_position + thumb_size / 2.)

    75

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

    77

    def RefreshThumbPosition(self, thumb_position=None):

    78

        if thumb_position is None:

    79

            thumb_position = self.ThumbPosition

    80

        if self.Parent.IsMessagePanelTop():

    81

            thumb_position = max(0., thumb_position)

    82

        if self.Parent.IsMessagePanelBottom():

    83

            thumb_position = min(0., thumb_position)

    84

        if thumb_position != self.ThumbPosition:

    85

            self.ThumbPosition = thumb_position

    86

            self.Parent.SetScrollSpeed(self.ThumbPosition)

    87

        self.Refresh()

    89

    def OnLeftDown(self, event):

    90

        self.CaptureMouse()

    91

        posx, posy = event.GetPosition()

    92

        width, height = self.GetClientSize()

    93

        range_rect = self.GetRangeRect()

    94

        thumb_rect = self.GetThumbRect()

    95

        if range_rect.InsideXY(posx, posy):

    96

            if thumb_rect.InsideXY(posx, posy):

    97

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

    98

            elif posy < thumb_rect.y:

    99

                self.Parent.ScrollToLast()

   100

            elif posy > thumb_rect.y + thumb_rect.height:

   101

                self.Parent.ScrollToFirst()

   102

        elif posy < width:

   103

            self.Parent.ScrollMessagePanelByPage(1)

   104

        elif posy > height - width:

   105

            self.Parent.ScrollMessagePanelByPage(-1)

   106

        event.Skip()

   108

    def OnLeftUp(self, event):

   109

        self.ThumbScrollingStartPos = None

   110

        self.RefreshThumbPosition(0.)

   111

        if self.HasCapture():

   112

            self.ReleaseMouse()

   113

        event.Skip()

   115

    def OnMotion(self, event):

   116

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

   117

            posx, posy = event.GetPosition()

   118

            width, height = self.GetClientSize()

   119

            range_rect = self.GetRangeRect()

   120

            thumb_size = range_rect.height * THUMB_SIZE_RATIO

   121

            thumb_range = range_rect.height - thumb_size

   122

            self.RefreshThumbPosition(

   123

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

   124

        event.Skip()

   126

    def OnResize(self, event):

   127

        self.Refresh()

   128

        event.Skip()

   130

    def OnEraseBackground(self, event):

   131

        pass

   133

    def OnPaint(self, event):

   134

        dc = wx.BufferedPaintDC(self)

   135

        dc.Clear()

   136

        dc.BeginDrawing()

   138

        gc = wx.GCDC(dc)

   140

        width, height = self.GetClientSize()

   142

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

   143

        gc.SetBrush(wx.GREY_BRUSH)

   145

        gc.DrawLines(ArrowPoints(wx.TOP, width * 0.75, width * 0.5, 2, (width + height) / 4 - 3))

   146

        gc.DrawLines(ArrowPoints(wx.TOP, width * 0.75, width * 0.5, 2, (width + height) / 4 + 3))

   148

        gc.DrawLines(ArrowPoints(wx.BOTTOM, width * 0.75, width * 0.5, 2, (height * 3 - width) / 4 + 3))

   149

        gc.DrawLines(ArrowPoints(wx.BOTTOM, width * 0.75, width * 0.5, 2, (height * 3 - width) / 4 - 3))

   151

        thumb_rect = self.GetThumbRect()

   152

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

   153

                                 thumb_rect.width, thumb_rect.height)

   154

        if self.Parent.IsMessagePanelTop():

   155

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

   156

        if self.Parent.IsMessagePanelBottom():

   157

            exclusion_rect.height = height - width - exclusion_rect.y

   158

        if exclusion_rect != thumb_rect:

   159

            colour = wx.NamedColour("LIGHT GREY")

   160

            gc.SetPen(wx.Pen(colour))

   161

            gc.SetBrush(wx.Brush(colour))

   164

                             exclusion_rect.width, exclusion_rect.height)

   166

        gc.SetPen(wx.GREY_PEN)

   167

        gc.SetBrush(wx.GREY_BRUSH)

   169

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

   171

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

   174

                         thumb_rect.width, thumb_rect.height)

   176

        dc.EndDrawing()

   177

        event.Skip()

   178

   179

BUTTON_SIZE = (30, 15)

   180

   181

class LogButton():

   183

    def __init__(self, label, callback):

   184

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

   185

        self.Size = wx.Size(*BUTTON_SIZE)

   186

        self.Label = label

   187

        self.Shown = True

   188

        self.Callback = callback

   190

    def __del__(self):

   191

        self.callback = None

   193

    def GetSize(self):

   194

        return self.Size

   196

    def SetPosition(self, x, y):

   197

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

   199

    def HitTest(self, x, y):

   201

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

   202

        if rect.InsideXY(x, y):

   203

            return True

   204

        return False

   206

    def ProcessCallback(self):

   207

        if self.Callback is not None:

   208

            wx.CallAfter(self.Callback)

   210

    def Draw(self, dc):

   211

        dc.SetPen(wx.TRANSPARENT_PEN)

   212

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

   215

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

   217

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

   220

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

   221

   222

DATE_INFO_SIZE = 10

   223

MESSAGE_INFO_SIZE = 18

   224

   225

class LogMessage:

   227

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

   228

        self.Date = datetime.utcfromtimestamp(tv_sec)

   229

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

   230

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

   231

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

   232

        self.Level = level

   233

        self.LevelBitmap = level_bitmap

   234

        self.Message = msg

   235

        self.DrawDate = True

   237

    def __cmp__(self, other):

   238

        if self.Date == other.Date:

   239

            return cmp(self.Seconds, other.Seconds)

   240

        return cmp(self.Date, other.Date)

   242

    def GetFullText(self):

   243

        date = self.Date.replace(second=int(self.Seconds))

   244

        nsec = (self.Seconds % 1.) * 1e9

   245

        return "%s at %s.%9.9d:\n%s" % (

   246

            LogLevels[self.Level],

   247

            str(date), nsec,

   248

            self.Message)

   250

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

   251

        if draw_date:

   252

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

   253

            dw, dh = dc.GetTextExtent(datetime_text)

   254

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

   255

            offset += DATE_INFO_SIZE

   257

        seconds_text = "%12.9f" % self.Seconds

   258

        sw, sh = dc.GetTextExtent(seconds_text)

   259

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

   261

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

   262

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

   264

        text = self.Message.replace("\n", " ")

   265

        mw, mh = dc.GetTextExtent(text)

   266

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

   268

    def GetHeight(self, draw_date):

   269

        if draw_date:

   270

            return DATE_INFO_SIZE + MESSAGE_INFO_SIZE

   271

        return MESSAGE_INFO_SIZE

   272

   273

SECOND = 1

   274

MINUTE = 60 * SECOND

   275

HOUR = 60 * MINUTE

   276

DAY = 24 * HOUR

   277

   278

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

   279

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

   280

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

   281

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

   282

   283

class LogViewer(DebugViewer, wx.Panel):

   285

    def __init__(self, parent, window):

   286

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

   287

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

   289

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

   290

        main_sizer.AddGrowableCol(0)

   291

        main_sizer.AddGrowableRow(1)

   293

        filter_sizer = wx.BoxSizer(wx.HORIZONTAL)

   294

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

   296

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

   297

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

   298

        levels = LogLevels[:3]

   299

        levels.reverse()

   300

        for level in levels:

   301

            self.MessageFilter.Append(_(level))

   302

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

   303

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

   305

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

   306

        self.SearchMessage.ShowSearchButton(True)

   307

        self.SearchMessage.ShowCancelButton(True)

   308

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

   310

              self.OnSearchMessageSearchButtonClick, self.SearchMessage)

   312

              self.OnSearchMessageCancelButtonClick, self.SearchMessage)

   313

        filter_sizer.AddWindow(self.SearchMessage, 3, border=5, flag=wx.RIGHT|wx.ALIGN_CENTER_VERTICAL)

   316

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

   317

        self.CleanButton.SetToolTipString(_("Clean log messages"))

   318

        self.Bind(wx.EVT_BUTTON, self.OnCleanButton, self.CleanButton)

   319

        filter_sizer.AddWindow(self.CleanButton)

   321

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

   322

        message_panel_sizer.AddGrowableCol(0)

   323

        message_panel_sizer.AddGrowableRow(0)

   324

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

   326

        self.MessagePanel = wx.Panel(self)

   327

        if wx.Platform == '__WXMSW__':

   328

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

   329

        else:

   330

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

   331

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

   332

        self.MessagePanel.Bind(wx.EVT_RIGHT_UP, self.OnMessagePanelRightUp)

   333

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

   334

        self.MessagePanel.Bind(wx.EVT_MOTION, self.OnMessagePanelMotion)

   335

        self.MessagePanel.Bind(wx.EVT_LEAVE_WINDOW, self.OnMessagePanelLeaveWindow)

   336

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

   337

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

   338

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

   339

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

   340

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

   342

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

   343

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

   345

        self.SetSizer(main_sizer)

   347

        self.LeftButtons = []

   349

                                for text, duration in CHANGE_TIMESTAMP_BUTTONS]:

   350

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

   352

        self.RightButtons = []

   354

                                for text, duration in CHANGE_TIMESTAMP_BUTTONS]:

   355

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

   357

        self.MessageFilter.SetSelection(0)

   358

        self.LogSource = None

   359

        self.ResetLogMessages()

   360

        self.ParentWindow = window

   362

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

   363

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

   364

        self.CurrentFilter = self.LevelFilters[0]

   365

        self.CurrentSearchValue = ""

   367

        self.ScrollSpeed = 0.

   368

        self.LastStartTime = None

   369

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

   370

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

   372

        self.LastMousePos = None

   373

        self.MessageToolTip = None

   374

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

   375

        self.Bind(wx.EVT_TIMER, self.OnMessageToolTipTimer, self.MessageToolTipTimer)

   377

    def __del__(self):

   378

        self.ScrollTimer.Stop()

   380

    def ResetLogMessages(self):

   381

        self.previous_log_count = [None]*LogLevelsCount

   382

        self.OldestMessages = []

   383

        self.LogMessages = []

   384

        self.LogMessagesTimestamp = numpy.array([])

   385

        self.CurrentMessage = None

   386

        self.HasNewData = False

   388

    def SetLogSource(self, log_source):

   390

        self.CleanButton.Enable(self.LogSource is not None)

   391

        if log_source is not None:

   392

            self.ResetLogMessages()

   393

            self.RefreshView()

   395

    def GetLogMessageFromSource(self, msgidx, level):

   396

        if self.LogSource is not None:

   397

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

   398

            if answer is not None:

   399

                msg, tick, tv_sec, tv_nsec = answer

   400

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

   401

        return None

   403

    def SetLogCounters(self, log_count):

   404

        new_messages = []

   405

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

   406

            if count is not None and prev != count:

   407

                if prev is None:

   408

                    dump_end = max(-1, count - 10)

   409

                    oldest_message = (-1, None)

   410

                else:

   411

                    dump_end = prev - 1

   412

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

   413

                    new_message = self.GetLogMessageFromSource(msgidx, level)

   414

                    if new_message is None:

   415

                        if prev is None:

   416

                            oldest_message = (-1, None)

   417

                        break

   418

                    if prev is None:

   419

                        oldest_message = (msgidx, new_message)

   420

                        if len(new_messages) == 0:

   421

                            new_messages = [new_message]

   422

                        else:

   423

                            new_messages.insert(0, new_message)

   424

                    else:

   425

                        new_messages.insert(0, new_message)

   426

                if prev is None and len(self.OldestMessages) <= level:

   427

                    self.OldestMessages.append(oldest_message)

   428

                self.previous_log_count[level] = count

   429

        new_messages.sort()

   430

        if len(new_messages) > 0:

   431

            self.HasNewData = True

   432

            if self.CurrentMessage is not None:

   433

                current_is_last = self.GetNextMessage(self.CurrentMessage)[0] is None

   434

            else:

   435

                current_is_last = True

   436

            for new_message in new_messages:

   437

                self.LogMessages.append(new_message)

   438

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

   439

            if current_is_last:

   440

                self.ScrollToLast(False)

   441

                self.ResetMessageToolTip()

   442

                self.MessageToolTipTimer.Stop()

   443

                self.ParentWindow.SelectTab(self)

   444

            self.NewDataAvailable(None)

   446

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

   448

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

   449

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

   451

    def GetMessageByTimestamp(self, timestamp):

   452

        if self.CurrentMessage is not None:

   453

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

   454

            message = self.LogMessages[msgidx]

   455

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

   456

                return self.GetPreviousMessage(msgidx, timestamp)

   457

            return message, msgidx

   458

        return None, None

   460

    def GetNextMessage(self, msgidx):

   461

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

   462

            message = self.LogMessages[msgidx + 1]

   463

            if self.FilterLogMessage(message):

   464

                return message, msgidx + 1

   465

            msgidx += 1

   466

        return None, None

   468

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

   469

        message = None

   470

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

   471

            message = self.LogMessages[msgidx - 1]

   472

            if self.FilterLogMessage(message, timestamp):

   473

                return message, msgidx - 1

   474

            msgidx -= 1

   475

        if len(self.LogMessages) > 0:

   476

            message = self.LogMessages[0]

   477

            for idx, msg in self.OldestMessages:

   478

                if msg is not None and msg > message:

   479

                    message = msg

   480

            while message is not None:

   481

                level = message.Level

   482

                oldest_msgidx, oldest_message = self.OldestMessages[level]

   483

                if oldest_msgidx > 0:

   484

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

   485

                    if message is not None:

   486

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

   487

                    else:

   488

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

   489

                else:

   490

                    message = None

   491

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

   492

                if message is not None:

   493

                    message_idx = 0