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

from weakref import proxy

    29

    30

import numpy

    31

import wx

    32

    33

from controls.CustomToolTip import CustomToolTip, TOOLTIP_WAIT_PERIOD

    34

from editors.DebugViewer import DebugViewer, REFRESH_PERIOD

    35

from runtime.loglevels import LogLevelsCount, LogLevels

    36

from util.BitmapLibrary import GetBitmap

    37

    38

    39

THUMB_SIZE_RATIO = 1. / 8.

    40

    41

    42

def ArrowPoints(*args):

    43

    direction, width, height, xoffset, yoffset = map(lambda x:x if type(x)==int else int(x), args)

    44

    if direction == wx.TOP:

    45

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

    46

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

    47

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

    48

    else:

    49

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

    50

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

    51

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

    52

    53

    54

class LogScrollBar(wx.Panel):

    55

    56

    def __init__(self, parent, size):

    57

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

    58

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

    59

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

    60

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

    61

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

    62

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

    63

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

    64

    65

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

    66

        self.ThumbScrollingStartPos = None

    67

    68

    def GetRangeRect(self):

    69

        width, height = self.GetClientSize()

    70

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

    71

    72

    def GetThumbRect(self):

    73

        width, _height = self.GetClientSize()

    74

        range_rect = self.GetRangeRect()

    75

        thumb_size = range_rect.height * THUMB_SIZE_RATIO

    76

        thumb_range = range_rect.height - thumb_size

    77

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

    78

        thumb_start = int(thumb_center_position - thumb_size / 2.)

    79

        thumb_end = int(thumb_center_position + thumb_size / 2.)

    80

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

    81

    82

    def RefreshThumbPosition(self, thumb_position=None):

    83

        if thumb_position is None:

    84

            thumb_position = self.ThumbPosition

    85

        if self.Parent.IsMessagePanelTop():

    86

            thumb_position = max(0., thumb_position)

    87

        if self.Parent.IsMessagePanelBottom():

    88

            thumb_position = min(0., thumb_position)

    89

        if thumb_position != self.ThumbPosition:

    90

            self.ThumbPosition = thumb_position

    91

            self.Parent.SetScrollSpeed(self.ThumbPosition)

    92

        self.Refresh()

    93

    94

    def OnLeftDown(self, event):

    95

        self.CaptureMouse()

    96

        posx, posy = event.GetPosition()

    97

        width, height = self.GetClientSize()

    98

        range_rect = self.GetRangeRect()

    99

        thumb_rect = self.GetThumbRect()

   100

        if range_rect.Contains(posx, posy):

   101

            if thumb_rect.Contains(posx, posy):

   102

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

   103

            elif posy < thumb_rect.y:

   104

                self.Parent.ScrollToLast()

   105

            elif posy > thumb_rect.y + thumb_rect.height:

   106

                self.Parent.ScrollToFirst()

   107

        elif posy < width:

   108

            self.Parent.ScrollMessagePanelByPage(1)

   109

        elif posy > height - width:

   110

            self.Parent.ScrollMessagePanelByPage(-1)

   111

        event.Skip()

   112

   113

    def OnLeftUp(self, event):

   114

        self.ThumbScrollingStartPos = None

   115

        self.RefreshThumbPosition(0.)

   116

        if self.HasCapture():

   117

            self.ReleaseMouse()

   118

        event.Skip()

   119

   120

    def OnMotion(self, event):

   121

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

   122

            _posx, posy = event.GetPosition()

   123

            range_rect = self.GetRangeRect()

   124

            thumb_size = range_rect.height * THUMB_SIZE_RATIO

   125

            thumb_range = range_rect.height - thumb_size

   126

            self.RefreshThumbPosition(

   127

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

   128

        event.Skip()

   129

   130

    def OnResize(self, event):

   131

        self.Refresh()

   132

        event.Skip()

   133

   134

    def OnEraseBackground(self, event):

   135

        pass

   136

   137

    def OnPaint(self, event):

   138

        dc = wx.BufferedPaintDC(self)

   139

        dc.Clear()

   140

   141

        gc = wx.GCDC(dc)

   142

   143

        width, height = self.GetClientSize()

   144

   145

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

   146

        gc.SetBrush(wx.GREY_BRUSH)

   147

   148

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

   149

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

   150

   151

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

   152

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

   153

   154

        thumb_rect = self.GetThumbRect()

   155

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

   156

                                 thumb_rect.width, thumb_rect.height)

   157

        if self.Parent.IsMessagePanelTop():

   158

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

   159

        if self.Parent.IsMessagePanelBottom():

   160

            exclusion_rect.height = height - width - exclusion_rect.y

   161

        if exclusion_rect != thumb_rect:

   162

            colour = wx.Colour("LIGHT GREY")

   163

            gc.SetPen(wx.Pen(colour))

   164

            gc.SetBrush(wx.Brush(colour))

   165

   166

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

   167

                             exclusion_rect.width, exclusion_rect.height)

   168

   169

        gc.SetPen(wx.GREY_PEN)

   170

        gc.SetBrush(wx.GREY_BRUSH)

   171

   172

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

   173

   174

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

   175

   176

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

   177

                         thumb_rect.width, thumb_rect.height)

   178

   179

        event.Skip()

   180

   181

   182

BUTTON_SIZE = (70, 15)

   183

   184

   185

class LogButton(object):

   186

   187

    def __init__(self, label, callback):

   188

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

   189

        self.Size = wx.Size(*BUTTON_SIZE)

   190

        self.Label = label

   191

        self.Shown = True

   192

        self.Callback = callback

   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.Contains(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.Colour("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

   224

DATE_INFO_SIZE = 10

   225

MESSAGE_INFO_SIZE = 18

   226

   227

   228

class LogMessage(object):

   229

   230

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

   231

        self.Date = datetime.utcfromtimestamp(tv_sec)

   232

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

   233

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

   234

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

   235

        self.Level = level

   236

        self.LevelBitmap = level_bitmap

   237

        self.Message = msg

   238

        self.DrawDate = True

   239

   240

    def __lt__(self, other):

   241

        if self.Date == other.Date:

   242

            return self.Seconds < other.Seconds

   243

        return self.Date < other.Date

   244

   245

    def GetFullText(self):

   246

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

   247

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

   248

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

   249

            LogLevels[self.Level],

   250

            str(date), nsec,

   251

            self.Message)

   252

   253

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

   254

        if draw_date:

   255

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

   256

            dw, dh = dc.GetTextExtent(datetime_text)

   257

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

   258

            offset += DATE_INFO_SIZE

   259

   260

        seconds_text = "%12.9f" % self.Seconds

   261

        sw, sh = dc.GetTextExtent(seconds_text)

   262

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

   263

   264

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

   265

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

   266

   267

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

   268

        _mw, mh = dc.GetTextExtent(text)

   269

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

   270

   271

    def GetHeight(self, draw_date):

   272

        if draw_date:

   273

            return DATE_INFO_SIZE + MESSAGE_INFO_SIZE

   274

        return MESSAGE_INFO_SIZE

   275

   276

   277

SECOND = 1

   278

MINUTE = 60 * SECOND

   279

HOUR = 60 * MINUTE

   280

DAY = 24 * HOUR

   281

   282

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

   283

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

   284

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

   285

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

   286

   287

   288

class LogViewer(DebugViewer, wx.Panel):

   289

   290

    def __init__(self, parent, window):

   291

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

   292

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

   293

   294

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

   295

        main_sizer.AddGrowableCol(0)

   296

        main_sizer.AddGrowableRow(1)

   297

   298

        filter_sizer = wx.BoxSizer(wx.HORIZONTAL)

   299

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

   300

   301

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

   302

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

   303

        levels = LogLevels[:3]

   304

        levels.reverse()

   305

        for level in levels:

   306

            self.MessageFilter.Append(_(level))

   307

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

   308

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

   309

   310

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

   311

        self.SearchMessage.ShowSearchButton(True)

   312

        self.SearchMessage.ShowCancelButton(True)

   313

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

   314

        self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN,

   315

                  self.OnSearchMessageSearchButtonClick, self.SearchMessage)

   316

        self.Bind(wx.EVT_SEARCHCTRL_CANCEL_BTN,

   317

                  self.OnSearchMessageCancelButtonClick, self.SearchMessage)

   318

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

   319

   320

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

   321

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

   322

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

   323

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

   324

        filter_sizer.Add(self.CleanButton)

   325

   326

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

   327

        message_panel_sizer.AddGrowableCol(0)

   328

        message_panel_sizer.AddGrowableRow(0)

   329

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

   330

   331

        self.MessagePanel = wx.Panel(self)

   332

        if wx.Platform == '__WXMSW__':

   333

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

   334

        else:

   335

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

   336

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

   337

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

   338

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

   339

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

   340

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

   341

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

   342

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

   343

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

   344

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

   345

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

   346

   347

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

   348

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

   349

   350

        self.SetSizer(main_sizer)

   351

   352

        self.LeftButtons = []

   353

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

   354

                                for text, duration in CHANGE_TIMESTAMP_BUTTONS]:

   355

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

   356

   357

        self.RightButtons = []

   358

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

   359

                                for text, duration in CHANGE_TIMESTAMP_BUTTONS]:

   360

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

   361

   362

        self.MessageFilter.SetSelection(0)

   363

        self.LogSource = None

   364

        self.ResetLogMessages()

   365

        self.ParentWindow = window

   366

   367

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

   368

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

   369

        self.CurrentFilter = self.LevelFilters[0]

   370

        self.CurrentSearchValue = ""

   371

   372

        self.ScrollSpeed = 0.

   373

        self.LastStartTime = None

   374

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

   375

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

   376

   377

        self.LastMousePos = None

   378

        self.MessageToolTip = None

   379

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

   380

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

   381

   382

    def ResetLogMessages(self):

   383

        self.ResetLogCounters()

   384

        self.OldestMessages = []

   385

        self.LogMessages = []

   386

        self.LogMessagesTimestamp = numpy.array([])

   387

        self.CurrentMessage = None

   388

        self.HasNewData = False

   389

   390

    def SetLogSource(self, log_source):

   391

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

   392

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

   393

        if log_source is not None:

   394

            self.ResetLogMessages()

   395

            wx.CallAfter(self.RefreshView)

   396

   397

    def GetLogMessageFromSource(self, msgidx, level):

   398

        if self.LogSource is not None:

   399

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

   400

            if answer is not None:

   401

                msg, _tick, tv_sec, tv_nsec = answer

   402

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

   403

        return None

   404

   405

    def ResetLogCounters(self):

   406

        self.previous_log_count = [None]*LogLevelsCount

   407

   408

    def SetLogCounters(self, log_count):

   409

        new_messages = []

   410

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

   411

            if count is not None and prev != count:

   412

                if prev is None:

   413

                    dump_end = max(-1, count - 10)

   414

                    oldest_message = (-1, None)

   415

                else:

   416

                    dump_end = prev - 1

   417

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

   418

                    new_message = self.GetLogMessageFromSource(msgidx, level)

   419

                    if new_message is None:

   420

                        if prev is None:

   421

                            oldest_message = (-1, None)

   422

                        break

   423

                    if prev is None:

   424

                        oldest_message = (msgidx, new_message)

   425

                        if len(new_messages) == 0:

   426

                            new_messages = [new_message]

   427

                        else:

   428

                            new_messages.insert(0, new_message)

   429

                    else:

   430

                        new_messages.insert(0, new_message)

   431

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

   432

                    self.OldestMessages.append(oldest_message)

   433

                self.previous_log_count[level] = count

   434

        new_messages.sort()

   435

        if len(new_messages) > 0:

   436

            self.HasNewData = True

   437

            if self.CurrentMessage is not None:

   438

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

   439

            else:

   440

                current_is_last = True

   441

            for new_message in new_messages:

   442

                self.LogMessages.append(new_message)

   443

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

   444

            if current_is_last:

   445

                self.ScrollToLast(False)

   446

                self.ResetMessageToolTip()

   447

                self.MessageToolTipTimer.Stop()

   448

                self.ParentWindow.SelectTab(self)

   449

            self.NewDataAvailable(None)

   450

   451

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

   452

        return (message.Level in self.CurrentFilter and

   453

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

   454

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

   455

   456

    def GetMessageByTimestamp(self, timestamp):

   457

        if self.CurrentMessage is not None:

   458

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

   459

            message = self.LogMessages[msgidx]

   460

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

   461

                return self.GetPreviousMessage(msgidx, timestamp)

   462

            return message, msgidx

   463

        return None, None

   464

   465

    def GetNextMessage(self, msgidx):

   466

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

   467

            message = self.LogMessages[msgidx + 1]

   468

            if self.FilterLogMessage(message):

   469

                return message, msgidx + 1

   470

            msgidx += 1

   471

        return None, None

   472

   473

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

   474

        message = None

   475

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

   476

            message = self.LogMessages[msgidx - 1]

   477

            if self.FilterLogMessage(message, timestamp):

   478

                return message, msgidx - 1

   479

            msgidx -= 1

   480

        if len(self.LogMessages) > 0:

   481

            message = self.LogMessages[0]

   482

            for _idx, msg in self.OldestMessages:

   483

                if msg is not None and msg > message:

   484

                    message = msg

   485

            while message is not None:

   486

                level = message.Level

   487

                oldest_msgidx, _oldest_message = self.OldestMessages[level]