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

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

    27

    USE_AUI = True

    28

else:

    29

    USE_AUI = False

    30

    31

from plcopen.structures import *

    32

from PLCControler import ITEM_POU

    33

    34

from Dialogs import *

    35

    36

from types import TupleType

    37

    38

SCROLLBAR_UNIT = 10

    39

WINDOW_BORDER = 10

    40

SCROLL_ZONE = 10

    41

    42

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

    43

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

    44

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

    45

    else:

    46

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

    47

    48

if wx.Platform == '__WXMSW__':

    49

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

    50

              'mono' : 'Courier New',

    51

              'helv' : 'Arial',

    52

              'other': 'Comic Sans MS',

    53

              'size' : 20,

    54

             }

    55

else:

    56

    faces = { 'times': 'Times',

    57

              'mono' : 'Courier',

    58

              'helv' : 'Helvetica',

    59

              'other': 'new century schoolbook',

    60

              'size' : 20,

    61

             }

    62

    63

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

    64

#                       Graphic elements Viewer base class

    65

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

    66

    67

# ID Constants for alignment menu items

    68

[ID_VIEWERALIGNMENTMENUITEMS0, ID_VIEWERALIGNMENTMENUITEMS1,

    69

 ID_VIEWERALIGNMENTMENUITEMS2, ID_VIEWERALIGNMENTMENUITEMS4,

    70

 ID_VIEWERALIGNMENTMENUITEMS5, ID_VIEWERALIGNMENTMENUITEMS6,

    71

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

    72

    73

# ID Constants for contextual menu items

    74

[ID_VIEWERCONTEXTUALMENUITEMS0, ID_VIEWERCONTEXTUALMENUITEMS1,

    75

 ID_VIEWERCONTEXTUALMENUITEMS2, ID_VIEWERCONTEXTUALMENUITEMS3,

    76

 ID_VIEWERCONTEXTUALMENUITEMS5, ID_VIEWERCONTEXTUALMENUITEMS6,

    77

 ID_VIEWERCONTEXTUALMENUITEMS8, ID_VIEWERCONTEXTUALMENUITEMS9,

    78

 ID_VIEWERCONTEXTUALMENUITEMS11, ID_VIEWERCONTEXTUALMENUITEMS12,

    79

 ID_VIEWERCONTEXTUALMENUITEMS14, ID_VIEWERCONTEXTUALMENUITEMS16,

    80

 ID_VIEWERCONTEXTUALMENUITEMS17,

    81

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

    82

    83

    84

class ViewerDropTarget(wx.TextDropTarget):

    85

    86

    def __init__(self, parent):

    87

        wx.TextDropTarget.__init__(self)

    88

        self.ParentWindow = parent

    89

    90

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

    91

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

    92

        scaling = self.ParentWindow.Scaling

    93

        message = None

    94

        try:

    95

            values = eval(data)

    96

        except:

    97

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

    98

            values = None

    99

        if not isinstance(values, TupleType):

   100

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

   101

            values = None

   102

        if values is not None:

   103

            if values[1] == "debug":

   104

                pass

   105

            elif values[1] == "program":

   106

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

   107

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

   108

                name, type = self.ParentWindow.Controler.GetEditedElementType(self.ParentWindow.GetTagName(), self.ParentWindow.Debug)

   109

                words = self.ParentWindow.TagName.split("::")

   110

                if name == values[0]:

   111

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

   112

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

   113

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

   114

                elif words[0] == "T" and values[1] != "function":

   115

                    message = "Function Blocks can't be used in Transitions!"

   116

                elif self.ParentWindow.Controler.PouIsUsedBy(name, values[0], self.ParentWindow.Debug):

   117

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

   118

                else:

   119

                    blockname = values[2]

   120

                    if len(values) > 3:

   121

                        blockinputs = values[3]

   122

                    else:

   123

                        blockinputs = None

   124

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

   125

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

   126

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

   127

                            blockname = dialog.GetValue()

   128

                        else:

   129

                            return

   130

                        dialog.Destroy()

   131

                    if blockname.upper() in [name.upper() for name in self.ParentWindow.Controler.GetProjectPouNames(self.ParentWindow.Debug)]:

   132

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

   133

                    elif blockname.upper() in [name.upper() for name in self.ParentWindow.Controler.GetEditedElementVariables(self.ParentWindow.GetTagName(), self.ParentWindow.Debug)]:

   134

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

   135

                    else:

   136

                        id = self.ParentWindow.GetNewId()

   137

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

   138

                        width, height = block.GetMinSize()

   139

                        if scaling is not None:

   140

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

   141

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

   142

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

   143

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

   144

                        block.SetPosition(x, y)

   145

                        block.SetSize(width, height)

   146

                        self.ParentWindow.AddBlock(block)

   147

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

   148

                        self.ParentWindow.RefreshBlockModel(block)

   149

                        self.ParentWindow.RefreshBuffer()

   150

                        self.ParentWindow.RefreshScrollBars()

   151

                        self.ParentWindow.RefreshVisibleElements()

   152

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

   153

                        self.ParentWindow.Refresh(False)

   154

            elif values[1] != "location":

   157

                    if values[1] == "Output":

   159

                    elif values[1] == "InOut":

   161

                    else:

   173

                else:

   174

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

   175

        if message is not None:

   176

            wx.CallAfter(self.ShowMessage, message)

   177

   221

    def ShowMessage(self, message):

   222

        message = wx.MessageDialog(self.ParentWindow, message, "Error", wx.OK|wx.ICON_ERROR)

   223

        message.ShowModal()

   224

        message.Destroy()

   225

   226

   227

"""

   228

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

   229

manipulating graphic elements

   230

"""

   231

   232

class Viewer(wx.ScrolledWindow):

   233

   234

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

   235

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

   236

            if id is not None:

   237

                event(self, id, function)

   238

            else:

   239

                event(self, function)

   240

   241

    # Create Alignment Menu items

   242

    def _init_coll_AlignmentMenu_Items(self, parent):

   243

        # Create menu items

   244

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

   245

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

   246

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

   247

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

   248

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

   249

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

   250

        parent.AppendSeparator()

   251

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

   252

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

   253

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

   254

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

   255

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

   256

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

   257

        # Link menu event to corresponding called functions

   258

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

   259

              id=ID_VIEWERALIGNMENTMENUITEMS0)

   260

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

   261

              id=ID_VIEWERALIGNMENTMENUITEMS1)

   262

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

   263

              id=ID_VIEWERALIGNMENTMENUITEMS2)

   264

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

   265

              id=ID_VIEWERALIGNMENTMENUITEMS4)

   266

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

   267

              id=ID_VIEWERALIGNMENTMENUITEMS5)

   268

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

   269

              id=ID_VIEWERALIGNMENTMENUITEMS6)

   270

   271

    # Create Contextual Menu items

   272

    def _init_coll_ContextualMenu_Items(self, parent):

   273

        # Create menu items

   274

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

   275

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

   276

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

   277

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

   278

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

   279

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

   280

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

   281

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

   282

        parent.AppendSeparator()

   283

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

   284

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

   285

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

   286

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

   287

        parent.AppendSeparator()

   288

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

   289

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

   290

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

   291

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

   292

        parent.AppendSeparator()

   293

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

   294

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

   295

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

   296

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

   297

        parent.AppendSeparator()

   298

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

   299

        parent.AppendSeparator()

   300

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

   301

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

   302

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

   303

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

   304

        # Link menu event to corresponding called functions

   305

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

   306

              id=ID_VIEWERCONTEXTUALMENUITEMS0)

   307

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

   308

              id=ID_VIEWERCONTEXTUALMENUITEMS1)

   309

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

   310

              id=ID_VIEWERCONTEXTUALMENUITEMS2)

   311

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

   312

              id=ID_VIEWERCONTEXTUALMENUITEMS3)

   313

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

   314

              id=ID_VIEWERCONTEXTUALMENUITEMS5)

   315

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

   316

              id=ID_VIEWERCONTEXTUALMENUITEMS6)

   317

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

   318

              id=ID_VIEWERCONTEXTUALMENUITEMS8)

   319

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

   320

              id=ID_VIEWERCONTEXTUALMENUITEMS9)

   321

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

   322

              id=ID_VIEWERCONTEXTUALMENUITEMS11)

   323

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

   324

              id=ID_VIEWERCONTEXTUALMENUITEMS12)

   325

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

   326

              id=ID_VIEWERCONTEXTUALMENUITEMS16)

   327

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

   328

              id=ID_VIEWERCONTEXTUALMENUITEMS17)

   329

   330

    # Create and initialize Contextual Menu

   331

    def _init_menus(self):

   332

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

   333

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

   334

   335

        self._init_coll_AlignmentMenu_Items(self.AlignmentMenu)

   336

        self._init_coll_ContextualMenu_Items(self.ContextualMenu)

   337

   338

    # Create a new Viewer

   339

    def __init__(self, parent, tagname, window, controler, debug = False, instancepath = ""):

   340

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

   341

            style=wx.HSCROLL | wx.VSCROLL)

   342

        self._init_menus()

   343

        # Adding a rubberband to Viewer

   344

        self.rubberBand = RubberBand(drawingSurface=self)

   345

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

   346

        self.SetBackgroundStyle(wx.BG_STYLE_CUSTOM)

   347

        self.ResetView()

   348

        self.Scaling = None

   349

        self.DrawGrid = True

   350

        self.GridBrush = wx.TRANSPARENT_BRUSH

   351

        self.PageSize = None

   352

        self.PagePen = wx.TRANSPARENT_PEN

   353

        self.DrawingWire = False

   354

        self.current_id = 0

   355

        self.TagName = tagname

   356

        self.Errors = []

   357

        self.Debug = debug

   358

        self.InstancePath = instancepath

   359

   360

        # Initialize Block, Wire and Comment numbers

   361

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

   362

   363

        # Initialize Viewer mode to Selection mode

   364

        self.Mode = MODE_SELECTION

   365

        self.SavedMode = False

   366

        self.CurrentLanguage = "FBD"

   367

   368

        self.ParentWindow = window

   369

        self.Controler = controler

   370

   371

        if not self.Debug:

   372

            self.SetDropTarget(ViewerDropTarget(self))

   373

   374

        dc = wx.ClientDC(self)

   375

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

   376

        dc.SetFont(font)

   377

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

   378

        while width > 260:

   379

            faces["size"] -= 1

   380

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

   381

            dc.SetFont(font)

   382

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

   383

        self.SetFont(font)

   384

   385

        self.ResetView()

   386

   387

        # Link Viewer event to corresponding methods

   388

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

   389

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

   390

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

   391

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

   392

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

   393

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

   394

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

   395

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

   396

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

   397

        self.Bind(wx.EVT_SCROLLWIN, self.OnScrollWindow)

   398

        self.Bind(wx.EVT_MOUSEWHEEL, self.OnMouseWheelWindow)

   399

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

   400

   401

    def GetScrolledRect(self, rect):

   402

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

   403

        return rect

   404

   405

    def GetScaling(self):

   406

        return self.Scaling

   407

   408

    def SetTagName(self, tagname):

   409

        self.TagName = tagname

   410

   411

    def GetTagName(self):

   412

        return self.TagName

   413

   414

    def GetInstancePath(self):

   415

        return self.InstancePath

   416

   417

    def IsViewing(self, tagname):

   418

        if self.Debug:

   419

            return self.InstancePath == tagname

   420

        else:

   421

            return self.TagName == tagname

   422

   423

    # Returns a new id

   424

    def GetNewId(self):

   425

        self.current_id += 1

   426

        return self.current_id

   427

   428

    # Destructor

   429

    def __del__(self):

   430

        self.Flush()

   431

        self.ResetView()

   432

   433

    def GetLogicalDC(self, buffered=False):

   434

        if buffered:

   435

            dc = wx.AutoBufferedPaintDC(self)

   436

        else:

   437

            dc = wx.ClientDC(self)

   438

        dc.SetFont(self.GetFont())

   439

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

   440

            self.DoPrepareDC(dc)

   441

        else:

   442

            self.PrepareDC(dc)

   443

        return dc

   444

   445

    def GetMiniFont(self):

   446

        font = self.GetFont()

   447

        return wx.Font(font.GetPointSize() * 0.75, wx.SWISS, wx.NORMAL, wx.NORMAL, faceName = faces["helv"])

   448

   449

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

   450

#                         Element management functions

   451

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

   452

   453

    def AddBlock(self, block):

   454

        self.block_id += 1

   455

        self.Blocks[block] = self.block_id

   456

   457

    def AddWire(self, wire):

   458

        self.wire_id += 1

   459

        self.Wires[wire] = self.wire_id

   460

   461

    def AddComment(self, comment):

   462

        self.comment_id += 1

   463

        self.Comments[comment] = self.comment_id

   464

   465

    def IsBlock(self, block):

   466

        return self.Blocks.get(block, False)

   467

   468

    def IsWire(self, wire):

   469

        return self.Wires.get(wire, False)

   470

   471

    def IsComment(self, comment):

   472

        return self.Comments.get(comment, False)

   473

   474

    def RemoveBlock(self, block):

   475

        self.Blocks.pop(block)

   476

   477

    def RemoveWire(self, wire):

   478

        self.Wires.pop(wire)

   479

   480

    def RemoveComment(self, comment):

   481

        self.Comments.pop(comment)

   482

   483

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

   484

        blocks = self.Blocks.keys()

   485

        wires = self.Wires.keys()

   486

        comments = self.Comments.keys()

   487

        if sort_blocks:

   488

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

   489

        if sort_wires:

   490

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