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

from types import TupleType

    26

    27

import wx

    28

    29

from DebugVariableViewer import DebugVariableViewer

    30

from GraphButton import GraphButton

    31

    32

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

    33

#                     Debug Variable Text Viewer Drop Target

    34

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

    35

    36

    37

class DebugVariableTextDropTarget(wx.TextDropTarget):

    38

    """

    39

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

    40

    """

    41

    42

    def __init__(self, parent, window):

    43

        """

    44

        Constructor

    45

        @param parent: Reference to Debug Variable Text Viewer

    46

        @param window: Reference to the Debug Variable Panel

    47

        """

    48

        wx.TextDropTarget.__init__(self)

    49

        self.ParentControl = parent

    50

        self.ParentWindow = window

    51

    52

    def __del__(self):

    53

        """

    54

        Destructor

    55

        """

    56

        # Remove reference to Debug Variable Text Viewer and Debug Variable

    57

        # Panel

    58

        self.ParentControl = None

    59

        self.ParentWindow = None

    60

    61

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

    62

        """

    63

        Function called when mouse is dragged over Drop Target

    64

        @param x: X coordinate of mouse pointer

    65

        @param y: Y coordinate of mouse pointer

    66

        @param d: Suggested default for return value

    67

        """

    68

        # Signal parent that mouse is dragged over

    69

        self.ParentControl.OnMouseDragging(x, y)

    70

    71

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

    72

    73

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

    74

        """

    75

        Function called when mouse is released in Drop Target

    76

        @param x: X coordinate of mouse pointer

    77

        @param y: Y coordinate of mouse pointer

    78

        @param data: Text associated to drag'n drop

    79

        """

    80

        # Signal Debug Variable Panel to reset highlight

    81

        self.ParentWindow.ResetHighlight()

    82

    83

        message = None

    84

    85

        # Check that data is valid regarding DebugVariablePanel

    86

        try:

    87

            values = eval(data)

    88

            if not isinstance(values, TupleType):

    89

                raise ValueError

    90

        except Exception:

    91

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

    92

            values = None

    93

    94

        # Display message if data is invalid

    95

        if message is not None:

    96

            wx.CallAfter(self.ShowMessage, message)

    97

    98

        # Data contain a reference to a variable to debug

    99

        elif values[1] == "debug":

   100

   101

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

   102

            # according to the position of mouse in Viewer.

   103

            _width, height = self.ParentControl.GetSize()

   104

            target_idx = self.ParentControl.GetIndex()

   105

            if y > height / 2:

   106

                target_idx += 1

   107

   108

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

   109

            # Variable Panel

   110

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

   111

                self.ParentWindow.MoveValue(values[0],

   112

                                            target_idx)

   113

   114

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

   115

            else:

   116

                self.ParentWindow.InsertValue(values[0],

   117

                                              target_idx,

   118

                                              force=True)

   119

   120

    def OnLeave(self):

   121

        """

   122

        Function called when mouse is leave Drop Target

   123

        """

   124

        # Signal Debug Variable Panel to reset highlight

   125

        self.ParentWindow.ResetHighlight()

   126

   127

        return wx.TextDropTarget.OnLeave(self)

   128

   129

    def ShowMessage(self, message):

   130

        """

   131

        Show error message in Error Dialog

   132

        @param message: Error message to display

   133

        """

   134

        dialog = wx.MessageDialog(self.ParentWindow,

   135

                                  message,

   136

                                  _("Error"),

   137

                                  wx.OK | wx.ICON_ERROR)

   138

        dialog.ShowModal()

   139

        dialog.Destroy()

   140

   141

   142

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

   143

#                      Debug Variable Text Viewer Class

   144

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

   145

   146

class DebugVariableTextViewer(DebugVariableViewer, wx.Panel):

   147

    """

   148

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

   149

    """

   150

   152

        """

   153

        Constructor

   154

        @param parent: Parent wx.Window of DebugVariableText

   155

        @param window: Reference to the Debug Variable Panel

   156

        @param items: List of DebugVariableItem displayed by Viewer

   157

        """

   158

        DebugVariableViewer.__init__(self, window, items)

   159

   160

        wx.Panel.__init__(self, parent)

   161

        # Set panel background colour

   162

        self.SetBackgroundColour(wx.WHITE)

   163

        # Define panel drop target

   164

        self.SetDropTarget(DebugVariableTextDropTarget(self, window))

   165

   166

        # Bind events

   167

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

   168

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

   169

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

   170

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

   171

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

   172

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

   173

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

   174

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

   175

   176

        # Define panel min size for parent sizer layout

   177

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

   178

   179

        # Add buttons to Viewer

   180

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

   181

                                 ("release", self.OnReleaseButton),

   182

                                 ("delete_graph", self.OnCloseButton)]:

   183

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

   184

   185

    def RefreshViewer(self):

   186

        """

   187

        Method that refresh the content displayed by Viewer

   188

        """

   189

        # Create buffered DC for drawing in panel

   190

        width, height = self.GetSize()

   191

        bitmap = wx.EmptyBitmap(width, height)

   192

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

   193

        dc.Clear()

   194

   195

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

   196

        # rendering

   197

        gc = wx.GCDC(dc)

   198

   199

        gc.BeginDrawing()

   200

   201

        # Get first item

   202

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

   203

   204

        # Get item variable path masked according Debug Variable Panel mask

   205

        item_path = item.GetVariable(

   206

                self.ParentWindow.GetVariableNameMask())

   207

   208

        # Draw item variable path at Viewer left side

   209

        w, h = gc.GetTextExtent(item_path)

   210

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

   211

   212

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

   213

        # flag value

   214

        item_forced = item.IsForced()

   215

        self.Buttons[1].Enable(item_forced)

   216

        self.RefreshButtonsPosition()

   217

        if item_forced:

   218

            gc.SetTextForeground(wx.BLUE)

   219

   220

        # Draw item current value at right side of Viewer

   221

        item_value = item.GetValue()

   222

        w, h = gc.GetTextExtent(item_value)

   223

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

   224

   225

        # Draw other Viewer common elements

   226

        self.DrawCommonElements(gc)

   227

   228

        gc.EndDrawing()

   229

   230

    def OnLeftDown(self, event):

   231

        """

   232

        Function called when mouse left button is pressed

   233

        @param event: wx.MouseEvent

   234

        """

   235

        # Get first item

   236

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

   237

   238

        # Calculate item path bounding box

   239

        _width, height = self.GetSize()

   240

        item_path = item.GetVariable(

   241

                self.ParentWindow.GetVariableNameMask())

   242

        w, h = self.GetTextExtent(item_path)

   243

   244

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

   245

        # start a move drag'n drop of item variable

   246

        x, y = event.GetPosition()

   247

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

   248

        if item_path_bbox.InsideXY(x, y):

   249

            self.ShowButtons(False)

   250

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

   251

            dragSource = wx.DropSource(self)

   252

            dragSource.SetData(data)

   253

            dragSource.DoDragDrop()

   254

   255

        # In other case handle event normally

   256

        else:

   257

            event.Skip()

   258

   259

    def OnLeftUp(self, event):

   260

        """

   261

        Function called when mouse left button is released

   262

        @param event: wx.MouseEvent

   263

        """

   264

        # Execute callback on button under mouse pointer if it exists

   265

        x, y = event.GetPosition()

   266

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

   267

        event.Skip()

   268

   269

    def OnLeftDClick(self, event):

   270

        """

   271

        Function called when mouse left button is double clicked

   272

        @param event: wx.MouseEvent

   273

        """

   274

        # Only numeric variables can be toggled to graph canvas

   275

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

   276

            self.ParentWindow.ToggleViewerType(self)

   277

   278

    def OnPaint(self, event):

   279

        """

   280

        Function called when redrawing Viewer content is needed

   281

        @param event: wx.PaintEvent

   282

        """

   283

        self.RefreshViewer()

   284

        event.Skip()