1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

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

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

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

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

    26

from datetime import datetime

    27

from time import time as gettime

    28

import numpy

    29

    30

import wx

    31

    32

from controls.CustomToolTip import CustomToolTip, TOOLTIP_WAIT_PERIOD

    33

from editors.DebugViewer import DebugViewer, REFRESH_PERIOD

    34

from targets.typemapping import LogLevelsCount, LogLevels

    35

from util.BitmapLibrary import GetBitmap

    36

from weakref import proxy

    37

    38

THUMB_SIZE_RATIO = 1. / 8.

    39

    40

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

    41

    if direction == wx.TOP:

    42

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

    43

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

    44

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

    45

    else:

    46

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

    47

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

    48

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

    49

    50

class LogScrollBar(wx.Panel):

    51

    52

    def __init__(self, parent, size):

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

    61

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

    62

        self.ThumbScrollingStartPos = None

    63

    64

    def GetRangeRect(self):

    65

        width, height = self.GetClientSize()

    66

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

    67

    68

    def GetThumbRect(self):

    69

        width, height = self.GetClientSize()

    70

        range_rect = self.GetRangeRect()

    71

        thumb_size = range_rect.height * THUMB_SIZE_RATIO

    72

        thumb_range = range_rect.height - thumb_size

    73

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

    74

        thumb_start = int(thumb_center_position - thumb_size / 2.)

    75

        thumb_end = int(thumb_center_position + thumb_size / 2.)

    76

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

    77

    78

    def RefreshThumbPosition(self, thumb_position=None):

    79

        if thumb_position is None:

    80

            thumb_position = self.ThumbPosition

    81

        if self.Parent.IsMessagePanelTop():

    82

            thumb_position = max(0., thumb_position)

    83

        if self.Parent.IsMessagePanelBottom():

    84

            thumb_position = min(0., thumb_position)

    85

        if thumb_position != self.ThumbPosition:

    86

            self.ThumbPosition = thumb_position

    87

            self.Parent.SetScrollSpeed(self.ThumbPosition)

    88

        self.Refresh()

    89

    90

    def OnLeftDown(self, event):

    91

        self.CaptureMouse()

    92

        posx, posy = event.GetPosition()

    93

        width, height = self.GetClientSize()

    94

        range_rect = self.GetRangeRect()

    95

        thumb_rect = self.GetThumbRect()

    96

        if range_rect.InsideXY(posx, posy):

    97

            if thumb_rect.InsideXY(posx, posy):

    98

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

    99

            elif posy < thumb_rect.y:

   100

                self.Parent.ScrollToLast()

   101

            elif posy > thumb_rect.y + thumb_rect.height:

   102

                self.Parent.ScrollToFirst()

   103

        elif posy < width:

   104

            self.Parent.ScrollMessagePanelByPage(1)

   105

        elif posy > height - width:

   106

            self.Parent.ScrollMessagePanelByPage(-1)

   107

        event.Skip()

   108

   109

    def OnLeftUp(self, event):

   110

        self.ThumbScrollingStartPos = None

   111

        self.RefreshThumbPosition(0.)

   112

        if self.HasCapture():

   113

            self.ReleaseMouse()

   114

        event.Skip()

   115

   116

    def OnMotion(self, event):

   117

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

   118

            posx, posy = event.GetPosition()

   119

            width, height = self.GetClientSize()

   120

            range_rect = self.GetRangeRect()

   121

            thumb_size = range_rect.height * THUMB_SIZE_RATIO

   122

            thumb_range = range_rect.height - thumb_size

   123

            self.RefreshThumbPosition(

   124

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

   125

        event.Skip()

   126

   127

    def OnResize(self, event):

   128

        self.Refresh()

   129

        event.Skip()

   130

   131

    def OnEraseBackground(self, event):

   132

        pass

   133

   134

    def OnPaint(self, event):

   135

        dc = wx.BufferedPaintDC(self)

   136

        dc.Clear()

   137

        dc.BeginDrawing()

   138

   139

        gc = wx.GCDC(dc)

   140

   141

        width, height = self.GetClientSize()

   142

   143

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

   144

        gc.SetBrush(wx.GREY_BRUSH)

   145

   146

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

   147

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

   148

   149

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

   150

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

   151

   152

        thumb_rect = self.GetThumbRect()

   153

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

   154

                                 thumb_rect.width, thumb_rect.height)

   155

        if self.Parent.IsMessagePanelTop():

   156

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

   157

        if self.Parent.IsMessagePanelBottom():

   158

            exclusion_rect.height = height - width - exclusion_rect.y

   159

        if exclusion_rect != thumb_rect:

   160

            colour = wx.NamedColour("LIGHT GREY")

   161

            gc.SetPen(wx.Pen(colour))

   162

            gc.SetBrush(wx.Brush(colour))

   163

   164

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

   165

                             exclusion_rect.width, exclusion_rect.height)

   166

   167

        gc.SetPen(wx.GREY_PEN)

   168

        gc.SetBrush(wx.GREY_BRUSH)

   169

   170

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

   171

   172

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

   173

   174

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

   175

                         thumb_rect.width, thumb_rect.height)

   176

   177

        dc.EndDrawing()

   178

        event.Skip()

   179

   180

BUTTON_SIZE = (70, 15)

   181

   182

class LogButton():

   183

   184

    def __init__(self, label, callback):

   185

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

   186

        self.Size = wx.Size(*BUTTON_SIZE)

   187

        self.Label = label

   188

        self.Shown = True

   189

        self.Callback = callback

   190

   191

    def __del__(self):

   192

        self.callback = None

   193

   194

    def GetSize(self):

   195

        return self.Size

   196

   197

    def SetPosition(self, x, y):

   198

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

   199

   200

    def HitTest(self, x, y):

   201

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

   202

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

   203

        if rect.InsideXY(x, y):

   204

            return True

   205

        return False

   206

   207

    def ProcessCallback(self):

   208

        if self.Callback is not None:

   209

            wx.CallAfter(self.Callback)

   210

   211

    def Draw(self, dc):

   212

        dc.SetPen(wx.TRANSPARENT_PEN)

   213

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

   214

   215

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

   216

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

   217

   218

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

   219

        dc.DrawText(self.Label,

   220

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

   221

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

   222

   223

DATE_INFO_SIZE = 10

   224

MESSAGE_INFO_SIZE = 18

   225

   226

class LogMessage:

   227

   228

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

   229

        self.Date = datetime.utcfromtimestamp(tv_sec)

   230

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

   231

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

   232

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

   233

        self.Level = level

   234

        self.LevelBitmap = level_bitmap

   235

        self.Message = msg

   236

        self.DrawDate = True

   237

   238

    def __cmp__(self, other):

   239

        if self.Date == other.Date:

   240

            return cmp(self.Seconds, other.Seconds)

   241

        return cmp(self.Date, other.Date)

   242

   243

    def GetFullText(self):

   244

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

   245

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

   246

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

   247

            LogLevels[self.Level],

   248

            str(date), nsec,

   249

            self.Message)

   250

   251

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

   252

        if draw_date:

   253

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

   254

            dw, dh = dc.GetTextExtent(datetime_text)

   255

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

   256

            offset += DATE_INFO_SIZE

   257

   258

        seconds_text = "%12.9f" % self.Seconds

   259

        sw, sh = dc.GetTextExtent(seconds_text)

   260

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

   261

   262

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

   263

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

   264

   265

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

   266

        mw, mh = dc.GetTextExtent(text)

   267

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

   268

   269

    def GetHeight(self, draw_date):

   270

        if draw_date:

   271

            return DATE_INFO_SIZE + MESSAGE_INFO_SIZE

   272

        return MESSAGE_INFO_SIZE

   273

   274

SECOND = 1

   275

MINUTE = 60 * SECOND

   276

HOUR = 60 * MINUTE

   277

DAY = 24 * HOUR

   278

   279

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

   280

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

   281

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

   282

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

   283

   284

class LogViewer(DebugViewer, wx.Panel):

   285

   286

    def __init__(self, parent, window):

   287

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

   288

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

   289

   290

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

   291

        main_sizer.AddGrowableCol(0)

   292

        main_sizer.AddGrowableRow(1)

   293

   294

        filter_sizer = wx.BoxSizer(wx.HORIZONTAL)

   295

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

   296

   297

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

   298

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

   299

        levels = LogLevels[:3]

   300

        levels.reverse()

   301

        for level in levels:

   302

            self.MessageFilter.Append(_(level))

   303

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

   304

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

   305

   306

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

   307

        self.SearchMessage.ShowSearchButton(True)

   308

        self.SearchMessage.ShowCancelButton(True)

   309

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

   310

        self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN,

   311

              self.OnSearchMessageSearchButtonClick, self.SearchMessage)

   312

        self.Bind(wx.EVT_SEARCHCTRL_CANCEL_BTN,

   313

              self.OnSearchMessageCancelButtonClick, self.SearchMessage)

   314

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

   315

   316

        self.CleanButton = wx.lib.buttons.GenBitmapButton(self, bitmap=GetBitmap("Clean"),

   317

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

   318

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

   319

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

   320

        filter_sizer.AddWindow(self.CleanButton)

   321

   322

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

   323

        message_panel_sizer.AddGrowableCol(0)

   324

        message_panel_sizer.AddGrowableRow(0)

   325

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

   326

   327

        self.MessagePanel = wx.Panel(self)

   328

        if wx.Platform == '__WXMSW__':

   329

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

   330

        else:

   331

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

   332

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

   333

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

   334

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

   335

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

   336

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

   337

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

   338

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

   339

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

   340

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

   341

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

   342

   343

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

   344

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

   345

   346

        self.SetSizer(main_sizer)

   347

   348

        self.LeftButtons = []

   349

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

   350

                                for text, duration in CHANGE_TIMESTAMP_BUTTONS]:

   351

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

   352

   353

        self.RightButtons = []

   354

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

   355

                                for text, duration in CHANGE_TIMESTAMP_BUTTONS]:

   356

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

   357

   358

        self.MessageFilter.SetSelection(0)

   359

        self.LogSource = None

   360

        self.ResetLogMessages()

   361

        self.ParentWindow = window

   362

   363

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

   364

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

   365

        self.CurrentFilter = self.LevelFilters[0]

   366

        self.CurrentSearchValue = ""

   367

   368

        self.ScrollSpeed = 0.

   369

        self.LastStartTime = None

   370

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

   371

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

   372

   373

        self.LastMousePos = None

   374

        self.MessageToolTip = None

   375

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

   376

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

   377

   378

    def __del__(self):

   379

        self.ScrollTimer.Stop()

   380

   381

    def ResetLogMessages(self):

   383

        self.OldestMessages = []

   384

        self.LogMessages = []

   385

        self.LogMessagesTimestamp = numpy.array([])

   386

        self.CurrentMessage = None

   387

        self.HasNewData = False

   388

   389

    def SetLogSource(self, log_source):

   390

        self.LogSource = proxy(log_source) if log_source else None

   391

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

   392

        if log_source is not None:

   393

            self.ResetLogMessages()

   394

            self.RefreshView()

   395

   396

    def GetLogMessageFromSource(self, msgidx, level):

   397

        if self.LogSource is not None:

   398

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

   399

            if answer is not None:

   400

                msg, tick, tv_sec, tv_nsec = answer

   401

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

   402

        return None

   403

   407

    def SetLogCounters(self, log_count):

   408

        new_messages = []

   409

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

   410

            if count is not None and prev != count:

   411

                if prev is None:

   412

                    dump_end = max(-1, count - 10)

   413

                    oldest_message = (-1, None)

   414

                else:

   415

                    dump_end = prev - 1

   416

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

   417

                    new_message = self.GetLogMessageFromSource(msgidx, level)

   418

                    if new_message is None:

   419

                        if prev is None:

   420

                            oldest_message = (-1, None)

   421

                        break

   422

                    if prev is None:

   423

                        oldest_message = (msgidx, new_message)

   424

                        if len(new_messages) == 0:

   425

                            new_messages = [new_message]

   426

                        else:

   427

                            new_messages.insert(0, new_message)

   428

                    else:

   429

                        new_messages.insert(0, new_message)

   430

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

   431

                    self.OldestMessages.append(oldest_message)

   432

                self.previous_log_count[level] = count

   433

        new_messages.sort()

   434

        if len(new_messages) > 0:

   435

            self.HasNewData = True

   436

            if self.CurrentMessage is not None:

   437

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

   438

            else:

   439

                current_is_last = True

   440

            for new_message in new_messages:

   441

                self.LogMessages.append(new_message)

   442

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

   443

            if current_is_last:

   444

                self.ScrollToLast(False)

   445

                self.ResetMessageToolTip()

   446

                self.MessageToolTipTimer.Stop()

   447

                self.ParentWindow.SelectTab(self)

   448

            self.NewDataAvailable(None)

   449

   450

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

   451

        return (message.Level in self.CurrentFilter and

   452

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

   453

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

   454

   455

    def GetMessageByTimestamp(self, timestamp):

   456

        if self.CurrentMessage is not None:

   457

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

   458

            message = self.LogMessages[msgidx]

   459

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

   460

                return self.GetPreviousMessage(msgidx, timestamp)

   461

            return message, msgidx

   462

        return None, None

   463

   464

    def GetNextMessage(self, msgidx):

   465

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

   466

            message = self.LogMessages[msgidx + 1]

   467

            if self.FilterLogMessage(message):

   468

                return message, msgidx + 1

   469

            msgidx += 1

   470

        return None, None

   471

   472

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

   473

        message = None

   474

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

   475

            message = self.LogMessages[msgidx - 1]

   476

            if self.FilterLogMessage(message, timestamp):

   477

                return message, msgidx - 1

   478

            msgidx -= 1

   479

        if len(self.LogMessages) > 0:

   480

            message = self.LogMessages[0]

   481

            for idx, msg in self.OldestMessages:

   482

                if msg is not None and msg > message:

   483

                    message = msg

   484

            while message is not None:

   485

                level = message.Level

   486

                oldest_msgidx, oldest_message = self.OldestMessages[level]

   487

                if oldest_msgidx > 0:

   488

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

   489

                    if message is not None:

   490

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

   491

                    else: