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

    27

    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 OnDragOver(self, x, y, d):

    55

        """

    56

        Function called when mouse is dragged over Drop Target

    57

        @param x: X coordinate of mouse pointer

    58

        @param y: Y coordinate of mouse pointer

    59

        @param d: Suggested default for return value

    60

        """

    61

        # Signal parent that mouse is dragged over

    62

        self.ParentControl.OnMouseDragging(x, y)

    63

    64

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

    65

    66

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

    67

        """

    68

        Function called when mouse is released in Drop Target

    69

        @param x: X coordinate of mouse pointer

    70

        @param y: Y coordinate of mouse pointer

    71

        @param data: Text associated to drag'n drop

    72

        """

    73

        # Signal Debug Variable Panel to reset highlight

    74

        self.ParentWindow.ResetHighlight()

    75

    76

        message = None

    77

    78

        # Check that data is valid regarding DebugVariablePanel

    79

        try:

    80

            values = eval(data)

    81

            if not isinstance(values, tuple):

    82

                raise ValueError

    83

        except Exception:

    84

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

    85

            values = None

    86

    87

        # Display message if data is invalid

    88

        if message is not None:

    89

            wx.CallAfter(self.ShowMessage, message)

    90

            return False

    91

    92

        # Data contain a reference to a variable to debug

    93

        elif values[1] == "debug":

    94

    95

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

    96

            # according to the position of mouse in Viewer.

    97

            _width, height = self.ParentControl.GetSize()

    98

            target_idx = self.ParentControl.GetIndex()

    99

            if y > height // 2:

   100

                target_idx += 1

   101

   102

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

   103

            # Variable Panel

   104

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

   105

                self.ParentWindow.MoveValue(values[0],

   106

                                            target_idx)

   107

   108

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

   109

            else:

   110

                self.ParentWindow.InsertValue(values[0],

   111

                                              target_idx,

   112

                                              force=True)

   113

            return True

   114

        return False

   115

   116

        return True

   117

   118

    def OnLeave(self):

   119

        """

   120

        Function called when mouse is leave Drop Target

   121

        """

   122

        # Signal Debug Variable Panel to reset highlight

   123

        self.ParentWindow.ResetHighlight()

   124

   125

        return wx.TextDropTarget.OnLeave(self)

   126

   127

    def ShowMessage(self, message):

   128

        """

   129

        Show error message in Error Dialog

   130

        @param message: Error message to display

   131

        """

   132

        dialog = wx.MessageDialog(self.ParentWindow,

   133

                                  message,

   134

                                  _("Error"),

   135

                                  wx.OK | wx.ICON_ERROR)

   136

        dialog.ShowModal()

   137

        dialog.Destroy()

   138

   139

   140

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

   141

#                      Debug Variable Text Viewer Class

   142

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

   143

   144

class DebugVariableTextViewer(DebugVariableViewer, wx.Panel):

   145

    """

   146

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

   147

    """

   148

   149

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

   150

        """

   151

        Constructor

   152

        @param parent: Parent wx.Window of DebugVariableText

   153

        @param window: Reference to the Debug Variable Panel

   154

        @param items: List of DebugVariableItem displayed by Viewer

   155

        """

   156

        DebugVariableViewer.__init__(self, window, items)

   157

   158

        wx.Panel.__init__(self, parent)

   159

        # Set panel background colour

   160

        self.SetBackgroundColour(wx.WHITE)

   161

        # Define panel drop target

   162

        self.SetDropTarget(DebugVariableTextDropTarget(self, window))

   163

   164

        # Bind events

   165

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

   166

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

   167

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

   168

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

   169

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

   170

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

   171

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

   172

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

   173

   174

        # Define panel min size for parent sizer layout

   175

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

   176

   177

        # Add buttons to Viewer

   178

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

   179

                                 ("release", self.OnReleaseButton),

   180

                                 ("delete_graph", self.OnCloseButton)]:

   181

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

   182

   183

    def RefreshViewer(self):

   184

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

   185

        self.Refresh()

   186

   187

    def DrawViewer(self):

   188

        """

   189

        Redraw content displayed by Viewer

   190

        """

   191

   192

        # Create buffered DC for drawing in panel

   193

        width, height = self.GetSize()

   194

        bitmap = wx.Bitmap(width, height)

   195

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

   196

        dc.Clear()

   197

   198

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

   199

        # rendering

   200

        gc = wx.GCDC(dc)

   201

   202

        # Get first item

   203

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

   204

   205

        # Get item variable path masked according Debug Variable Panel mask

   206

        item_path = item.GetVariable(

   207

            self.ParentWindow.GetVariableNameMask())

   208

   209

        # Draw item variable path at Viewer left side

   210

        w, h = gc.GetTextExtent(item_path)

   211

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

   212

   213

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

   214

        # flag value

   215

        item_forced = item.IsForced()

   216

        self.Buttons[1].Enable(item_forced)

   217

        self.RefreshButtonsPosition()

   218

        if item_forced:

   219

            gc.SetTextForeground(wx.BLUE)

   220

   221

        # Draw item current value at right side of Viewer

   222

        item_value = item.GetValue()

   223

        w, h = gc.GetTextExtent(item_value)

   224

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

   225

   226

        # Draw other Viewer common elements

   227

        self.DrawCommonElements(gc)

   228

   229

    def OnLeftDown(self, event):

   230

        """

   231

        Function called when mouse left button is pressed

   232

        @param event: wx.MouseEvent

   233

        """

   234

        # Get first item

   235

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

   236

   237

        # Calculate item path bounding box

   238

        _width, height = self.GetSize()

   239

        item_path = item.GetVariable(

   240

            self.ParentWindow.GetVariableNameMask())

   241

        w, h = self.GetTextExtent(item_path)

   242

   243

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

   244

        # start a move drag'n drop of item variable

   245

        x, y = event.GetPosition()

   246

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

   247

        if item_path_bbox.Contains(x, y):

   248

            self.ShowButtons(False)

   249

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

   250

            dragSource = wx.DropSource(self)

   251

            dragSource.SetData(data)

   252

            dragSource.DoDragDrop()

   253

   254

        # In other case handle event normally

   255

        else:

   256

            event.Skip()

   257

   258

    def OnLeftUp(self, event):

   259

        """

   260

        Function called when mouse left button is released

   261

        @param event: wx.MouseEvent

   262

        """

   263

        # Execute callback on button under mouse pointer if it exists

   264

        x, y = event.GetPosition()

   265

        self.HandleButton(x, y)

   266

        event.Skip()

   267

   268

    def OnLeftDClick(self, event):

   269

        """

   270

        Function called when mouse left button is double clicked

   271

        @param event: wx.MouseEvent

   272

        """

   273

        # Only numeric variables can be toggled to graph canvas

   274

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

   275

            self.ParentWindow.ToggleViewerType(self)

   276

   277

    def OnPaint(self, event):

   278

        """

   279

        Function called when redrawing Viewer content is needed

   280

        @param event: wx.PaintEvent

   281

        """

   282

        self.DrawViewer()

   283

        event.Skip()