1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import wx

    26

    27

from plcopen.structures import *

    28

from PLCControler import ITEM_POU

    29

    30

from Dialogs import *

    31

    32

from types import TupleType

    33

    34

SCROLLBAR_UNIT = 10

    35

WINDOW_BORDER = 10

    36

SCROLL_ZONE = 10

    37

    38

def AppendMenu(parent, help, id, kind, text):

    39

    if wx.VERSION >= (2, 6, 0):

    40

        parent.Append(help=help, id=id, kind=kind, text=text)

    41

    else:

    42

        parent.Append(helpString=help, id=id, kind=kind, item=text)

    43

    44

if wx.Platform == '__WXMSW__':

    45

    faces = { 'times': 'Times New Roman',

    46

              'mono' : 'Courier New',

    47

              'helv' : 'Arial',

    48

              'other': 'Comic Sans MS',

    49

              'size' : 20,

    50

             }

    51

else:

    52

    faces = { 'times': 'Times',

    53

              'mono' : 'Courier',

    54

              'helv' : 'Helvetica',

    55

              'other': 'new century schoolbook',

    56

              'size' : 20,

    57

             }

    58

    59

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

    60

#                       Graphic elements Viewer base class

    61

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

    62

    63

# ID Constants for alignment menu items

    64

[ID_VIEWERALIGNMENTMENUITEMS0, ID_VIEWERALIGNMENTMENUITEMS1,

    65

 ID_VIEWERALIGNMENTMENUITEMS2, ID_VIEWERALIGNMENTMENUITEMS4,

    66

 ID_VIEWERALIGNMENTMENUITEMS5, ID_VIEWERALIGNMENTMENUITEMS6,

    67

] = [wx.NewId() for _init_coll_AlignmentMenu_Items in range(6)]

    68

    69

# ID Constants for contextual menu items

    70

[ID_VIEWERCONTEXTUALMENUITEMS0, ID_VIEWERCONTEXTUALMENUITEMS1,

    71

 ID_VIEWERCONTEXTUALMENUITEMS2, ID_VIEWERCONTEXTUALMENUITEMS3,

    72

 ID_VIEWERCONTEXTUALMENUITEMS5, ID_VIEWERCONTEXTUALMENUITEMS6,

    73

 ID_VIEWERCONTEXTUALMENUITEMS8, ID_VIEWERCONTEXTUALMENUITEMS9,

    74

 ID_VIEWERCONTEXTUALMENUITEMS11, ID_VIEWERCONTEXTUALMENUITEMS12,

    75

 ID_VIEWERCONTEXTUALMENUITEMS14, ID_VIEWERCONTEXTUALMENUITEMS16,

    76

 ID_VIEWERCONTEXTUALMENUITEMS17,

    77

] = [wx.NewId() for _init_coll_ContextualMenu_Items in range(13)]

    78

    79

    80

class ViewerDropTarget(wx.TextDropTarget):

    81

    82

    def __init__(self, parent):

    83

        wx.TextDropTarget.__init__(self)

    84

        self.ParentWindow = parent

    85

    86

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

    87

        x, y = self.ParentWindow.CalcUnscrolledPosition(x, y)

    88

        scaling = self.ParentWindow.Scaling

    89

        message = None

    90

        try:

    91

            values = eval(data)

    92

        except:

    93

            message = "Invalid value \"%s\" for viewer block"%data

    94

            values = None

    95

        if not isinstance(values, TupleType):

    96

            message = "Invalid value \"%s\" for viewer block"%data

    97

            values = None

    98

        if values is not None:

   102

                message = "Programs can't be used by other POUs!"

   103

            elif values[1] in ["function", "functionBlock", "program"]:

   105

                if name == values[0]:

   106

                    message = "\"%s\" can't use itself!"%name

   107

                elif type == "function" and values[1] != "function":

   108

                    message = "Function Blocks can't be used by Functions!"

   110

                    message = "\"%s\" is already used by \"%s\"!"%(name, values[0])

   111

                else:

   112

                    blockname = values[2]

   113

                    if len(values) > 3:

   114

                        blockinputs = values[3]

   115

                    else:

   116

                        blockinputs = None

   117

                    if values[1] != "function" and blockname == "":

   118

                        dialog = wx.TextEntryDialog(self.ParentWindow.ParentWindow, "Block name", "Please enter a block name", "", wx.OK|wx.CANCEL|wx.CENTRE)

   119

                        if dialog.ShowModal() == wx.ID_OK:

   120

                            blockname = dialog.GetValue()

   121

                        else:

   122

                            return

   123

                        dialog.Destroy()

   125

                        message = "\"%s\" pou already exists!"%blockname

   127

                        message = "\"%s\" element for this pou already exists!"%blockname

   128

                    else:

   129

                        id = self.ParentWindow.GetNewId()

   130

                        block = FBD_Block(self.ParentWindow, values[0], blockname, id, inputs = blockinputs)

   131

                        width, height = block.GetMinSize()

   132

                        if scaling is not None:

   133

                            x = round(float(x) / float(scaling[0])) * scaling[0]

   134

                            y = round(float(y) / float(scaling[1])) * scaling[1]

   135

                            width = round(float(width) / float(scaling[0]) + 0.5) * scaling[0]

   136

                            height = round(float(height) / float(scaling[1]) + 0.5) * scaling[1]

   137

                        block.SetPosition(x, y)

   138

                        block.SetSize(width, height)

   139

                        self.ParentWindow.AddBlock(block)

   140

                        self.ParentWindow.Controler.AddEditedElementBlock(self.ParentWindow.GetTagName(), id, values[0], blockname)

   141

                        self.ParentWindow.RefreshBlockModel(block)

   142

                        self.ParentWindow.RefreshBuffer()

   143

                        self.ParentWindow.RefreshScrollBars()

   145

                        self.ParentWindow.ParentWindow.RefreshVariablePanel(self.ParentWindow.GetTagName())

   146

                        self.ParentWindow.Refresh(False)

   147

            elif values[1] != "location":

   148

                if values[3] == self.ParentWindow.GetTagName():

   149

                    id = self.ParentWindow.GetNewId()

   150

                    if values[1] == "Output":

   151

                        var_type = OUTPUT

   152

                    elif values[1] == "InOut":

   153

                        var_type = INPUT

   154

                    else:

   155

                        var_type = INPUT

   156

                    variable = FBD_Variable(self.ParentWindow, var_type, values[0], values[2], id)

   157

                    width, height = variable.GetMinSize()

   158

                    if scaling is not None:

   159

                        x = round(float(x) / float(scaling[0])) * scaling[0]

   160

                        y = round(float(y) / float(scaling[1])) * scaling[1]

   161

                        width = round(float(width) / float(scaling[0]) + 0.5) * scaling[0]

   162

                        height = round(float(height) / float(scaling[1]) + 0.5) * scaling[1]

   163

                    variable.SetPosition(x, y)

   164

                    variable.SetSize(width, height)

   165

                    self.ParentWindow.AddBlock(variable)

   166

                    self.ParentWindow.Controler.AddEditedElementVariable(self.ParentWindow.GetTagName(), id, var_type)

   167

                    self.ParentWindow.RefreshVariableModel(variable)

   168

                    self.ParentWindow.RefreshBuffer()

   169

                    self.ParentWindow.RefreshScrollBars()

   171

                    self.ParentWindow.Refresh(False)

   172

                else:

   173

                    message = "Variable don't belong to this POU!"

   176

   177

    def ShowMessage(self, message):

   181

   182

   183

"""

   184

Class that implements a Viewer based on a wx.ScrolledWindow for drawing and 

   185

manipulating graphic elements

   186

"""

   187

   188

class Viewer(wx.ScrolledWindow):

   189

   190

    if wx.VERSION < (2, 6, 0):

   191

        def Bind(self, event, function, id = None):

   192

            if id is not None:

   193

                event(self, id, function)

   194

            else:

   195

                event(self, function)

   196

   197

    # Create Alignment Menu items

   198

    def _init_coll_AlignmentMenu_Items(self, parent):

   199

        # Create menu items

   200

        AppendMenu(parent, help='', id=ID_VIEWERALIGNMENTMENUITEMS0,

   201

              kind=wx.ITEM_NORMAL, text=u'Left')

   202

        AppendMenu(parent, help='', id=ID_VIEWERALIGNMENTMENUITEMS1,

   203

              kind=wx.ITEM_NORMAL, text=u'Center')

   204

        AppendMenu(parent, help='', id=ID_VIEWERALIGNMENTMENUITEMS2,

   205

              kind=wx.ITEM_NORMAL, text=u'Right')

   206

        parent.AppendSeparator()

   207

        AppendMenu(parent, help='', id=ID_VIEWERALIGNMENTMENUITEMS4,

   208

              kind=wx.ITEM_NORMAL, text=u'Top')

   209

        AppendMenu(parent, help='', id=ID_VIEWERALIGNMENTMENUITEMS5,

   210

              kind=wx.ITEM_NORMAL, text=u'Middle')

   211

        AppendMenu(parent, help='', id=ID_VIEWERALIGNMENTMENUITEMS6,

   212

              kind=wx.ITEM_NORMAL, text=u'Bottom')

   213

        # Link menu event to corresponding called functions

   214

        self.Bind(wx.EVT_MENU, self.OnAlignLeftMenu,

   215

              id=ID_VIEWERALIGNMENTMENUITEMS0)

   216

        self.Bind(wx.EVT_MENU, self.OnAlignCenterMenu,

   217

              id=ID_VIEWERALIGNMENTMENUITEMS1)

   218

        self.Bind(wx.EVT_MENU, self.OnAlignRightMenu,

   219

              id=ID_VIEWERALIGNMENTMENUITEMS2)

   220

        self.Bind(wx.EVT_MENU, self.OnAlignTopMenu,

   221

              id=ID_VIEWERALIGNMENTMENUITEMS4)

   222

        self.Bind(wx.EVT_MENU, self.OnAlignMiddleMenu,

   223

              id=ID_VIEWERALIGNMENTMENUITEMS5)

   224

        self.Bind(wx.EVT_MENU, self.OnAlignBottomMenu,

   225

              id=ID_VIEWERALIGNMENTMENUITEMS6)

   226

   227

    # Create Contextual Menu items

   228

    def _init_coll_ContextualMenu_Items(self, parent):

   229

        # Create menu items

   230

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS0,

   231

              kind=wx.ITEM_RADIO, text=u'No Modifier')

   232

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS1,

   233

              kind=wx.ITEM_RADIO, text=u'Negated')

   234

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS2,

   235

              kind=wx.ITEM_RADIO, text=u'Rising Edge')

   236

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS3,

   237

              kind=wx.ITEM_RADIO, text=u'Falling Edge')

   238

        parent.AppendSeparator()

   239

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS5,

   240

              kind=wx.ITEM_NORMAL, text=u'Add Wire Segment')

   241

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS6,

   242

              kind=wx.ITEM_NORMAL, text=u'Delete Wire Segment')

   243

        parent.AppendSeparator()

   244

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS8,

   245

              kind=wx.ITEM_NORMAL, text=u'Add Divergence Branch')

   246

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS9,

   247

              kind=wx.ITEM_NORMAL, text=u'Delete Divergence Branch')

   248

        parent.AppendSeparator()

   249

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS11,

   250

              kind=wx.ITEM_NORMAL, text=u'Clear Execution Order')

   251

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS12,

   252

              kind=wx.ITEM_NORMAL, text=u'Reset Execution Order')

   253

        parent.AppendSeparator()

   254

        parent.AppendMenu(ID_VIEWERCONTEXTUALMENUITEMS14, "Alignment", self.AlignmentMenu)

   255

        parent.AppendSeparator()

   256

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS16,

   257

              kind=wx.ITEM_NORMAL, text=u'Edit Block')

   258

        AppendMenu(parent, help='', id=ID_VIEWERCONTEXTUALMENUITEMS17,

   259

              kind=wx.ITEM_NORMAL, text=u'Delete')

   260

        # Link menu event to corresponding called functions

   261

        self.Bind(wx.EVT_MENU, self.OnNoModifierMenu,

   262

              id=ID_VIEWERCONTEXTUALMENUITEMS0)

   263

        self.Bind(wx.EVT_MENU, self.OnNegatedMenu,

   264

              id=ID_VIEWERCONTEXTUALMENUITEMS1)

   265

        self.Bind(wx.EVT_MENU, self.OnRisingEdgeMenu,

   266

              id=ID_VIEWERCONTEXTUALMENUITEMS2)

   267

        self.Bind(wx.EVT_MENU, self.OnFallingEdgeMenu,

   268

              id=ID_VIEWERCONTEXTUALMENUITEMS3)

   269

        self.Bind(wx.EVT_MENU, self.OnAddSegmentMenu,

   270

              id=ID_VIEWERCONTEXTUALMENUITEMS5)

   271

        self.Bind(wx.EVT_MENU, self.OnDeleteSegmentMenu,

   272

              id=ID_VIEWERCONTEXTUALMENUITEMS6)

   273

        self.Bind(wx.EVT_MENU, self.OnAddBranchMenu,

   274

              id=ID_VIEWERCONTEXTUALMENUITEMS8)

   275

        self.Bind(wx.EVT_MENU, self.OnDeleteBranchMenu,

   276

              id=ID_VIEWERCONTEXTUALMENUITEMS9)

   277

        self.Bind(wx.EVT_MENU, self.OnClearExecutionOrderMenu,

   278

              id=ID_VIEWERCONTEXTUALMENUITEMS11)

   279

        self.Bind(wx.EVT_MENU, self.OnResetExecutionOrderMenu,

   280

              id=ID_VIEWERCONTEXTUALMENUITEMS12)

   281

        self.Bind(wx.EVT_MENU, self.OnEditBlockMenu,

   282

              id=ID_VIEWERCONTEXTUALMENUITEMS16)

   283

        self.Bind(wx.EVT_MENU, self.OnDeleteMenu,

   284

              id=ID_VIEWERCONTEXTUALMENUITEMS17)

   285

   286

    # Create and initialize Contextual Menu

   287

    def _init_menus(self):

   288

        self.AlignmentMenu = wx.Menu(title='')

   289

        self.ContextualMenu = wx.Menu(title='')

   290

   291

        self._init_coll_AlignmentMenu_Items(self.AlignmentMenu)

   292

        self._init_coll_ContextualMenu_Items(self.ContextualMenu)

   293

   294

    # Create a new Viewer

   296

        wx.ScrolledWindow.__init__(self, parent, pos=wx.Point(0, 0), size=wx.Size(0, 0), 

   297

            style=wx.HSCROLL | wx.VSCROLL)

   298

        self._init_menus()

   299

        # Adding a rubberband to Viewer

   300

        self.rubberBand = RubberBand(drawingSurface=self)

   301

        self.SetBackgroundColour(wx.Colour(255,255,255))

   302

        self.SetBackgroundStyle(wx.BG_STYLE_CUSTOM)

   303

        self.ResetView()

   304

        self.Scaling = None

   305

        self.DrawGrid = True

   306

        self.GridBrush = wx.TRANSPARENT_BRUSH

   307

        self.PageSize = None

   308

        self.PagePen = wx.TRANSPARENT_PEN

   309

        self.DrawingWire = False

   310

        self.current_id = 0

   311

        self.TagName = tagname

   312

        self.Errors = []

   315

   316

        # Initialize Block, Wire and Comment numbers

   317

        self.block_id = self.wire_id = self.comment_id = 0

   318

   319

        # Initialize Viewer mode to Selection mode

   320

        self.Mode = MODE_SELECTION

   321

        self.SavedMode = False

   322

        self.CurrentLanguage = "FBD"

   323

   324

        self.ParentWindow = window

   325

        self.Controler = controler

   326

   329

   330

        dc = wx.ClientDC(self)

   331

        font = wx.Font(faces["size"], wx.SWISS, wx.NORMAL, wx.NORMAL, faceName = faces["mono"])

   332

        dc.SetFont(font)

   333

        width, height = dc.GetTextExtent("ABCDEFGHIJKLMNOPQRSTUVWXYZ")

   334

        while width > 260:

   335

            faces["size"] -= 1

   336

            font = wx.Font(faces["size"], wx.SWISS, wx.NORMAL, wx.NORMAL, faceName = faces["mono"])

   337

            dc.SetFont(font)

   338

            width, height = dc.GetTextExtent("ABCDEFGHIJKLMNOPQRSTUVWXYZ")

   339

        self.SetFont(font)

   340

   343

        # Link Viewer event to corresponding methods

   344

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

   345

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

   346

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

   347

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

   348

        self.Bind(wx.EVT_RIGHT_DOWN, self.OnViewerRightDown)

   349

        self.Bind(wx.EVT_RIGHT_UP, self.OnViewerRightUp)

   350

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

   351

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

   352

        self.Bind(wx.EVT_CHAR, self.OnChar)

   354

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

   355

   356

    def GetScrolledRect(self, rect):

   357

        rect.x, rect.y = self.CalcScrolledPosition(rect.x, rect.y)

   358

        return rect

   359

   360

    def GetScaling(self):

   361

        return self.Scaling

   362

   363

    def SetTagName(self, tagname):

   364

        self.TagName = tagname

   365

   366

    def GetTagName(self):

   367

        return self.TagName

   368

   372

    def IsViewing(self, tagname):

   377

   378

    # Returns a new id

   379

    def GetNewId(self):

   380

        self.current_id += 1

   381

        return self.current_id

   382

   383

    # Destructor

   384

    def __del__(self):

   386

        self.ResetView()

   387

   388

    def GetLogicalDC(self, buffered=False):

   389

        if buffered:

   390

            dc = wx.AutoBufferedPaintDC(self)

   391

        else:

   392

            dc = wx.ClientDC(self)

   393

        dc.SetFont(self.GetFont())

   394

        if wx.VERSION >= (2, 6, 0):

   395

            self.DoPrepareDC(dc)

   396

        else:

   397

            self.PrepareDC(dc)

   398

        return dc

   399

   400

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

   401

#                         Element management functions

   402

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

   403

   404

    def AddBlock(self, block):

   405

        self.block_id += 1

   406

        self.Blocks[block] = self.block_id

   407

   408

    def AddWire(self, wire):

   409

        self.wire_id += 1

   410

        self.Wires[wire] = self.wire_id

   411

   412

    def AddComment(self, comment):

   413

        self.comment_id += 1

   414

        self.Comments[comment] = self.comment_id

   415

   416

    def IsBlock(self, block):

   417

        return self.Blocks.get(block, False)

   418

   419

    def IsWire(self, wire):

   420

        return self.Wires.get(wire, False)

   421

   422

    def IsComment(self, comment):

   423

        return self.Comments.get(comment, False)

   424

   425

    def RemoveBlock(self, block):

   426

        self.Blocks.pop(block)

   427

   428

    def RemoveWire(self, wire):

   429

        self.Wires.pop(wire)

   430

   431

    def RemoveComment(self, comment):

   432

        self.Comments.pop(comment)

   433

   434

    def GetElements(self, sort_blocks=False, sort_wires=False, sort_comments=False):

   435

        blocks = self.Blocks.keys()

   436

        wires = self.Wires.keys()

   437

        comments = self.Comments.keys()

   438

        if sort_blocks:

   439

            blocks.sort(lambda x,y:self.Blocks[x].__cmp__(self.Blocks[y]))

   440

        if sort_wires:

   441

            wires.sort(lambda x,y:self.Wires[x].__cmp__(self.Wires[y]))

   442

        if sort_comments:

   443

            comments.sort(lambda x,y:self.Comments[x].__cmp__(self.Comments[y]))

   444

        return blocks + wires + comments

   445

   461

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

   462

#                              Reset functions

   463

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

   464

   465

    # Resets Viewer lists

   466

    def ResetView(self):

   467

        self.Blocks = {}

   468

        self.Wires = {}

   469

        self.Comments = {}

   471

        self.SelectedElement = None

   472

        self.HighlightedElement = None

   473

   480

    # Remove all elements

   481

    def CleanView(self):

   482

        for block in self.Blocks.keys():

   483

            block.Clean()

   484

        self.ResetView()

   485

   486

    # Changes Viewer mode

   487

    def SetMode(self, mode):

   488

        if self.Mode != mode or mode == MODE_SELECTION:

   489

            self.Mode = mode

   490

            self.SavedMode = False

   491