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

from types import TupleType

    29

    30

import wx

    31

    32

from controls.DebugVariablePanel.DebugVariableViewer import DebugVariableViewer

    33

from controls.DebugVariablePanel.GraphButton import GraphButton

    34

    35

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

    36

#                     Debug Variable Text Viewer Drop Target

    37

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

    38

    39

    40

class DebugVariableTextDropTarget(wx.TextDropTarget):

    41

    """

    42

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

    43

    """

    44

    45

    def __init__(self, parent, window):

    46

        """

    47

        Constructor

    48

        @param parent: Reference to Debug Variable Text Viewer

    49

        @param window: Reference to the Debug Variable Panel

    50

        """

    51

        wx.TextDropTarget.__init__(self)

    52

        self.ParentControl = parent

    53

        self.ParentWindow = window

    54

    55

    def __del__(self):

    56

        """

    57

        Destructor

    58

        """

    59

        # Remove reference to Debug Variable Text Viewer and Debug Variable

    60

        # Panel

    61

        self.ParentControl = None

    62

        self.ParentWindow = None

    63

    64

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

    65

        """

    66

        Function called when mouse is dragged over Drop Target

    67

        @param x: X coordinate of mouse pointer

    68

        @param y: Y coordinate of mouse pointer

    69

        @param d: Suggested default for return value

    70

        """

    71

        # Signal parent that mouse is dragged over

    72

        self.ParentControl.OnMouseDragging(x, y)

    73

    74

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

    75

    76

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

    77

        """

    78

        Function called when mouse is released in Drop Target

    79

        @param x: X coordinate of mouse pointer

    80

        @param y: Y coordinate of mouse pointer

    81

        @param data: Text associated to drag'n drop

    82

        """

    83

        # Signal Debug Variable Panel to reset highlight

    84

        self.ParentWindow.ResetHighlight()

    85

    86

        message = None

    87

    88

        # Check that data is valid regarding DebugVariablePanel

    89

        try:

    90

            values = eval(data)

    91

            if not isinstance(values, TupleType):

    92

                raise ValueError

    93

        except Exception:

    94

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

    95

            values = None

    96

    97

        # Display message if data is invalid

    98

        if message is not None:

    99

            wx.CallAfter(self.ShowMessage, message)

   100

   101

        # Data contain a reference to a variable to debug

   102

        elif values[1] == "debug":

   103

   104

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

   105

            # according to the position of mouse in Viewer.

   106

            _width, height = self.ParentControl.GetSize()

   107

            target_idx = self.ParentControl.GetIndex()

   108

            if y > height // 2:

   109

                target_idx += 1

   110

   111

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

   112

            # Variable Panel

   113

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

   114

                self.ParentWindow.MoveValue(values[0],

   115

                                            target_idx)

   116

   117

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

   118

            else:

   119

                self.ParentWindow.InsertValue(values[0],

   120

                                              target_idx,

   121

                                              force=True)

   122

   123

    def OnLeave(self):

   124

        """

   125

        Function called when mouse is leave Drop Target

   126

        """

   127

        # Signal Debug Variable Panel to reset highlight

   128

        self.ParentWindow.ResetHighlight()

   129

   130

        return wx.TextDropTarget.OnLeave(self)

   131

   132

    def ShowMessage(self, message):

   133

        """

   134

        Show error message in Error Dialog

   135

        @param message: Error message to display

   136

        """

   137

        dialog = wx.MessageDialog(self.ParentWindow,

   138

                                  message,

   139

                                  _("Error"),

   140

                                  wx.OK | wx.ICON_ERROR)

   141

        dialog.ShowModal()

   142

        dialog.Destroy()

   143

   144

   145

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

   146

#                      Debug Variable Text Viewer Class

   147

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

   148

   149

class DebugVariableTextViewer(DebugVariableViewer, wx.Panel):

   150

    """

   151

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

   152

    """

   153

   154

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

   155

        """

   156

        Constructor

   157

        @param parent: Parent wx.Window of DebugVariableText

   158

        @param window: Reference to the Debug Variable Panel

   159

        @param items: List of DebugVariableItem displayed by Viewer

   160

        """

   161

        DebugVariableViewer.__init__(self, window, items)

   162

   163

        wx.Panel.__init__(self, parent)

   164

        # Set panel background colour

   165

        self.SetBackgroundColour(wx.WHITE)

   166

        # Define panel drop target

   167

        self.SetDropTarget(DebugVariableTextDropTarget(self, window))

   168

   169

        # Bind events

   170

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

   171

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

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

   179

        # Define panel min size for parent sizer layout

   180

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

   181

   182

        # Add buttons to Viewer

   183

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

   184

                                 ("release", self.OnReleaseButton),

   185

                                 ("delete_graph", self.OnCloseButton)]:

   186

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

   187

   188

    def RefreshViewer(self):

   189

        """

   190

        Method that refresh the content displayed by Viewer

   191

        """

   192

        # Create buffered DC for drawing in panel

   193

        width, height = self.GetSize()

   194

        bitmap = wx.EmptyBitmap(width, height)

   195

        dc = wx.BufferedDC(wx.ClientDC(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

        gc.BeginDrawing()

   203

   204

        # Get first item

   205

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

   206

   207

        # Get item variable path masked according Debug Variable Panel mask

   208

        item_path = item.GetVariable(

   209

            self.ParentWindow.GetVariableNameMask())

   210

   211

        # Draw item variable path at Viewer left side

   212

        w, h = gc.GetTextExtent(item_path)

   213

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

   214

   215

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

   216

        # flag value

   217

        item_forced = item.IsForced()

   218

        self.Buttons[1].Enable(item_forced)

   219

        self.RefreshButtonsPosition()

   220

        if item_forced:

   221

            gc.SetTextForeground(wx.BLUE)

   222

   223

        # Draw item current value at right side of Viewer

   224

        item_value = item.GetValue()

   225

        w, h = gc.GetTextExtent(item_value)

   226

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

   227

   228

        # Draw other Viewer common elements

   229

        self.DrawCommonElements(gc)

   230

   231

        gc.EndDrawing()

   232

   233

    def OnLeftDown(self, event):

   234

        """

   235

        Function called when mouse left button is pressed

   236

        @param event: wx.MouseEvent

   237

        """

   238

        # Get first item

   239

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

   240

   241

        # Calculate item path bounding box

   242

        _width, height = self.GetSize()

   243

        item_path = item.GetVariable(

   244

            self.ParentWindow.GetVariableNameMask())

   245

        w, h = self.GetTextExtent(item_path)

   246

   247

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

   248

        # start a move drag'n drop of item variable

   249

        x, y = event.GetPosition()

   250

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

   251

        if item_path_bbox.InsideXY(x, y):

   252

            self.ShowButtons(False)

   253

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

   254

            dragSource = wx.DropSource(self)

   255

            dragSource.SetData(data)

   256

            dragSource.DoDragDrop()

   257

   258

        # In other case handle event normally

   259

        else:

   260

            event.Skip()

   261

   262

    def OnLeftUp(self, event):

   263

        """

   264

        Function called when mouse left button is released

   265

        @param event: wx.MouseEvent

   266

        """

   267

        # Execute callback on button under mouse pointer if it exists

   268

        x, y = event.GetPosition()

   269

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

   270

        event.Skip()

   271

   272

    def OnLeftDClick(self, event):

   273

        """

   274

        Function called when mouse left button is double clicked

   275

        @param event: wx.MouseEvent

   276

        """

   277

        # Only numeric variables can be toggled to graph canvas

   278

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

   279

            self.ParentWindow.ToggleViewerType(self)

   280

   281

    def OnPaint(self, event):

   282

        """

   283

        Function called when redrawing Viewer content is needed

   284

        @param event: wx.PaintEvent

   285

        """

   286

        self.RefreshViewer()

   287

        event.Skip()