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) 2012: 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 __future__ import absolute_import

    27

from __future__ import division

    28

    29

import wx

    30

    31

from controls.DebugVariablePanel.DebugVariableViewer import DebugVariableViewer

    32

from controls.DebugVariablePanel.GraphButton import GraphButton

    33

    34

# -------------------------------------------------------------------------------

    35

#                     Debug Variable Text Viewer Drop Target

    36

# -------------------------------------------------------------------------------

    37

    38

    39

class DebugVariableTextDropTarget(wx.TextDropTarget):

    40

    """

    41

    Class that implements a custom drop target class for Debug Variable Text Viewer

    42

    """

    43

    44

    def __init__(self, parent, window):

    45

        """

    46

        Constructor

    47

        @param parent: Reference to Debug Variable Text Viewer

    48

        @param window: Reference to the Debug Variable Panel

    49

        """

    50

        wx.TextDropTarget.__init__(self)

    51

        self.ParentControl = parent

    52

        self.ParentWindow = window

    53

    54

    def __del__(self):

    55

        """

    56

        Destructor

    57

        """

    58

        # Remove reference to Debug Variable Text Viewer and Debug Variable

    59

        # Panel

    60

        self.ParentControl = None

    61

        self.ParentWindow = None

    62

    63

    def OnDragOver(self, x, y, d):

    64

        """

    65

        Function called when mouse is dragged over Drop Target

    66

        @param x: X coordinate of mouse pointer

    67

        @param y: Y coordinate of mouse pointer

    68

        @param d: Suggested default for return value

    69

        """

    70

        # Signal parent that mouse is dragged over

    71

        self.ParentControl.OnMouseDragging(x, y)

    72

    73

        return wx.TextDropTarget.OnDragOver(self, x, y, d)

    74

    75

    def OnDropText(self, x, y, data):

    76

        """

    77

        Function called when mouse is released in Drop Target

    78

        @param x: X coordinate of mouse pointer

    79

        @param y: Y coordinate of mouse pointer

    80

        @param data: Text associated to drag'n drop

    81

        """

    82

        # Signal Debug Variable Panel to reset highlight

    83

        self.ParentWindow.ResetHighlight()

    84

    85

        message = None

    86

    87

        # Check that data is valid regarding DebugVariablePanel

    88

        try:

    89

            values = eval(data)

    90

            if not isinstance(values, tuple):

    91

                raise ValueError

    92

        except Exception:

    93

            message = _("Invalid value \"%s\" for debug variable") % data

    94

            values = None

    95

    96

        # Display message if data is invalid

    97

        if message is not None:

    98

            wx.CallAfter(self.ShowMessage, message)

    99

   100

        # Data contain a reference to a variable to debug

   101

        elif values[1] == "debug":

   102

   103

            # Get Before which Viewer the variable has to be moved or added

   104

            # according to the position of mouse in Viewer.

   105

            _width, height = self.ParentControl.GetSize()

   106

            target_idx = self.ParentControl.GetIndex()

   107

            if y > height // 2:

   108

                target_idx += 1

   109

   110

            # Drag'n Drop is an internal is an internal move inside Debug

   111

            # Variable Panel

   112

            if len(values) > 2 and values[2] == "move":

   113

                self.ParentWindow.MoveValue(values[0],

   114

                                            target_idx)

   115

   116

            # Drag'n Drop was initiated by another control of Beremiz

   117

            else:

   118

                self.ParentWindow.InsertValue(values[0],

   119

                                              target_idx,

   120

                                              force=True)

   121

   122

    def OnLeave(self):

   123

        """

   124

        Function called when mouse is leave Drop Target

   125

        """

   126

        # Signal Debug Variable Panel to reset highlight

   127

        self.ParentWindow.ResetHighlight()

   128

   129

        return wx.TextDropTarget.OnLeave(self)

   130

   131

    def ShowMessage(self, message):

   132

        """

   133

        Show error message in Error Dialog

   134

        @param message: Error message to display

   135

        """

   136

        dialog = wx.MessageDialog(self.ParentWindow,

   137

                                  message,

   138

                                  _("Error"),

   139

                                  wx.OK | wx.ICON_ERROR)

   140

        dialog.ShowModal()

   141

        dialog.Destroy()

   142

   143

   144

# -------------------------------------------------------------------------------

   145

#                      Debug Variable Text Viewer Class

   146

# -------------------------------------------------------------------------------

   147

   148

class DebugVariableTextViewer(DebugVariableViewer, wx.Panel):

   149

    """

   150

    Class that implements a Viewer that display variable values as a text

   151

    """

   152

   153

    def __init__(self, parent, window, items=None):

   154

        """

   155

        Constructor

   156

        @param parent: Parent wx.Window of DebugVariableText

   157

        @param window: Reference to the Debug Variable Panel

   158

        @param items: List of DebugVariableItem displayed by Viewer

   159

        """

   160

        DebugVariableViewer.__init__(self, window, items)

   161

   162

        wx.Panel.__init__(self, parent)

   163

        # Set panel background colour

   164

        self.SetBackgroundColour(wx.WHITE)

   165

        # Define panel drop target

   166

        self.SetDropTarget(DebugVariableTextDropTarget(self, window))

   167

   168

        # Bind events

   169

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

   170

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

   171

        self.Bind(wx.EVT_LEFT_DCLICK, self.OnLeftDClick)

   172

        self.Bind(wx.EVT_ENTER_WINDOW, self.OnEnter)

   173

        self.Bind(wx.EVT_LEAVE_WINDOW, self.OnLeave)

   174

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

   175

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

   176

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

   177

   178

        # Define panel min size for parent sizer layout

   179

        self.SetMinSize(wx.Size(0, 25))

   180

   181

        # Add buttons to Viewer

   182

        for bitmap, callback in [("force", self.OnForceButton),

   183

                                 ("release", self.OnReleaseButton),

   184

                                 ("delete_graph", self.OnCloseButton)]:

   185

            self.Buttons.append(GraphButton(0, 0, bitmap, callback))

   186

   187

    def RefreshViewer(self):

   188

        """Triggers EVT_PAINT event to refresh UI"""

   189

        self.Refresh()

   190

   191

    def DrawViewer(self):

   192

        """

   193

        Redraw content displayed by Viewer

   194

        """

   195

   196

        # Create buffered DC for drawing in panel

   197

        width, height = self.GetSize()

   198

        bitmap = wx.EmptyBitmap(width, height)

   199

        dc = wx.BufferedDC(wx.PaintDC(self), bitmap)

   200

        dc.Clear()

   201

   202

        # Get Graphics Context for DC, for anti-aliased and transparent

   203

        # rendering

   204

        gc = wx.GCDC(dc)

   205

   206

        gc.BeginDrawing()

   207

   208

        # Get first item

   209

        item = self.ItemsDict.values()[0]

   210

   211

        # Get item variable path masked according Debug Variable Panel mask

   212

        item_path = item.GetVariable(

   213

            self.ParentWindow.GetVariableNameMask())

   214

   215

        # Draw item variable path at Viewer left side

   216

        w, h = gc.GetTextExtent(item_path)

   217

        gc.DrawText(item_path, 20, (height - h) // 2)

   218

   219

        # Update 'Release' button state and text color according to item forced

   220

        # flag value

   221

        item_forced = item.IsForced()

   222

        self.Buttons[1].Enable(item_forced)

   223

        self.RefreshButtonsPosition()

   224

        if item_forced:

   225

            gc.SetTextForeground(wx.BLUE)

   226

   227

        # Draw item current value at right side of Viewer

   228

        item_value = item.GetValue()

   229

        w, h = gc.GetTextExtent(item_value)

   230

        gc.DrawText(item_value, width - 40 - w, (height - h) // 2)

   231

   232

        # Draw other Viewer common elements

   233

        self.DrawCommonElements(gc)

   234

   235

        gc.EndDrawing()

   236

   237

    def OnLeftDown(self, event):

   238

        """

   239

        Function called when mouse left button is pressed

   240

        @param event: wx.MouseEvent

   241

        """

   242

        # Get first item

   243

        item = self.ItemsDict.values()[0]

   244

   245

        # Calculate item path bounding box

   246

        _width, height = self.GetSize()

   247

        item_path = item.GetVariable(

   248

            self.ParentWindow.GetVariableNameMask())

   249

        w, h = self.GetTextExtent(item_path)

   250

   251

        # Test if mouse has been pressed in this bounding box. In that case

   252

        # start a move drag'n drop of item variable

   253

        x, y = event.GetPosition()

   254

        item_path_bbox = wx.Rect(20, (height - h) / 2, w, h)

   255

        if item_path_bbox.InsideXY(x, y):

   256

            self.ShowButtons(False)

   257

            data = wx.TextDataObject(str((item.GetVariable(), "debug", "move")))

   258

            dragSource = wx.DropSource(self)

   259

            dragSource.SetData(data)

   260

            dragSource.DoDragDrop()

   261

   262

        # In other case handle event normally

   263

        else:

   264

            event.Skip()

   265

   266

    def OnLeftUp(self, event):

   267

        """

   268

        Function called when mouse left button is released

   269

        @param event: wx.MouseEvent

   270

        """

   271

        # Execute callback on button under mouse pointer if it exists

   272

        x, y = event.GetPosition()

   273

        wx.CallAfter(self.HandleButton, x, y)

   274

        event.Skip()

   275

   276

    def OnLeftDClick(self, event):

   277

        """

   278

        Function called when mouse left button is double clicked

   279

        @param event: wx.MouseEvent

   280

        """

   281

        # Only numeric variables can be toggled to graph canvas

   282

        if self.ItemsDict.values()[0].IsNumVariable():

   283

            self.ParentWindow.ToggleViewerType(self)

   284

   285

    def OnPaint(self, event):

   286

        """

   287

        Function called when redrawing Viewer content is needed

   288

        @param event: wx.PaintEvent

   289

        """

   290

        self.DrawViewer()

   291

        event.Skip()