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

SCROLLBAR_UNIT = 10

    33

WINDOW_BORDER = 10

    34

SCROLL_ZONE = 10

    35

    36

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

    37

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

    38

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

    39

    else:

    40

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

    41

    42

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

    43

#                       Graphic elements Viewer base class

    44

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

    45

    46

# ID Constants for alignment menu items

    47

[ID_VIEWERALIGNMENTMENUITEMS0, ID_VIEWERALIGNMENTMENUITEMS1,

    48

 ID_VIEWERALIGNMENTMENUITEMS2, ID_VIEWERALIGNMENTMENUITEMS4,

    49

 ID_VIEWERALIGNMENTMENUITEMS5, ID_VIEWERALIGNMENTMENUITEMS6,

    50

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

    51

    52

# ID Constants for contextual menu items

    53

[ID_VIEWERCONTEXTUALMENUITEMS0, ID_VIEWERCONTEXTUALMENUITEMS1,

    54

 ID_VIEWERCONTEXTUALMENUITEMS2, ID_VIEWERCONTEXTUALMENUITEMS3,

    55

 ID_VIEWERCONTEXTUALMENUITEMS5, ID_VIEWERCONTEXTUALMENUITEMS6,

    56

 ID_VIEWERCONTEXTUALMENUITEMS8, ID_VIEWERCONTEXTUALMENUITEMS9,

    57

 ID_VIEWERCONTEXTUALMENUITEMS11, ID_VIEWERCONTEXTUALMENUITEMS12,

    58

 ID_VIEWERCONTEXTUALMENUITEMS14, ID_VIEWERCONTEXTUALMENUITEMS16,

    59

 ID_VIEWERCONTEXTUALMENUITEMS17,

    60

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

    61

    62

    63

class ViewerDropTarget(wx.TextDropTarget):

    64

    65

    def __init__(self, parent):

    66

        wx.TextDropTarget.__init__(self)

    67

        self.ParentWindow = parent

    68

    69

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

    70

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

    72

        values = eval(data)

    73

        if values[1] == "program":

    74

            message = wx.MessageDialog(self.ParentWindow, "Programs can't be used by other POUs!", "Error", wx.OK|wx.ICON_ERROR)

    75

            message.ShowModal()

    76

            message.Destroy()

    77

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

    78

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

    79

            if name == values[0]:

    80

                message = wx.MessageDialog(self.ParentWindow, "\"%s\" can't use itself!"%name, "Error", wx.OK|wx.ICON_ERROR)

    81

                message.ShowModal()

    82

                message.Destroy()

    83

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

    84

                message = wx.MessageDialog(self.ParentWindow, "Function Blocks can't be used by Functions!", "Error", wx.OK|wx.ICON_ERROR)

    85

                message.ShowModal()

    86

                message.Destroy()

    87

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

    88

                message = wx.MessageDialog(self.ParentWindow, "\"%s\" is already used by \"%s\"!"%(name, values[0]), "Error", wx.OK|wx.ICON_ERROR)

    89

                message.ShowModal()

    90

                message.Destroy()

    91

            else:

    92

                blockname = values[2]

    93

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

    94

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

    95

                    if dialog.ShowModal():

    96

                        blockname = dialog.GetValue()

    97

                    dialog.Destroy()

    98

                id = self.ParentWindow.GetNewId()

    99

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

   106

                block.SetPosition(x, y)

   107

                block.SetSize(width, height)

   108

                self.ParentWindow.AddBlock(block)

   109

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

   110

                self.ParentWindow.RefreshBlockModel(block)

   111

                self.ParentWindow.RefreshBuffer()

   112

                self.ParentWindow.RefreshScrollBars()

   114

                self.ParentWindow.Refresh()

   115

        elif values[1] != "location":

   116

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

   117

                id = self.ParentWindow.GetNewId()

   118

                if values[1] == "Output":

   119

                    var_type = OUTPUT

   120

                elif values[1] == "InOut":

   121

                    var_type = INPUT

   122

                else:

   123

                    var_type = INPUT

   124

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

   131

                variable.SetPosition(x, y)

   132

                variable.SetSize(width, height)

   133

                self.ParentWindow.AddBlock(variable)

   135

                self.ParentWindow.RefreshVariableModel(variable)

   136

                self.ParentWindow.RefreshBuffer()

   137

                self.ParentWindow.RefreshScrollBars()

   138

                self.ParentWindow.Refresh()

   139

            else:

   140

                message = wx.MessageDialog(self.ParentWindow, "Variable don't belong to this POU!", "Error", wx.OK|wx.ICON_ERROR)

   141

                message.ShowModal()

   142

                message.Destroy()

   143

   144

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

   145

    import wx.aui

   146

   147

    class MDIViewer(wx.aui.AuiMDIChildFrame):

   148

        def __init__(self, parent, tagname, window, controler):

   149

            wx.aui.AuiMDIChildFrame.__init__(self, parent, -1, title = "")

   150

   151

            sizer = wx.BoxSizer(wx.HORIZONTAL)

   152

   153

            self.Viewer = Viewer(self, tagname, window, controler)

   154

   155

            sizer.AddWindow(self.Viewer, 1, border=0, flag=wx.GROW)

   156

   157

            self.SetSizer(sizer)

   158

   159

        def GetViewer(self):

   160

            return self.Viewer

   161

   162

"""

   163

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

   164

manipulating graphic elements

   165

"""

   166

   167

class Viewer(wx.ScrolledWindow):

   168

   169

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

   170

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

   171

            if id is not None:

   172

                event(self, id, function)

   173

            else:

   174

                event(self, function)

   175

   176

    # Create Alignment Menu items

   177

    def _init_coll_AlignmentMenu_Items(self, parent):

   178

        # Create menu items

   179

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

   180

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

   181

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

   182

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

   183

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

   184

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

   185

        parent.AppendSeparator()

   186

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

   187

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

   188

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

   189

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

   190

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

   191

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

   192

        # Link menu event to corresponding called functions

   193

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

   194

              id=ID_VIEWERALIGNMENTMENUITEMS0)

   195

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

   196

              id=ID_VIEWERALIGNMENTMENUITEMS1)

   197

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

   198

              id=ID_VIEWERALIGNMENTMENUITEMS2)

   199

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

   200

              id=ID_VIEWERALIGNMENTMENUITEMS4)

   201

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

   202

              id=ID_VIEWERALIGNMENTMENUITEMS5)

   203

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

   204

              id=ID_VIEWERALIGNMENTMENUITEMS6)

   205

   206

    # Create Contextual Menu items

   207

    def _init_coll_ContextualMenu_Items(self, parent):

   208

        # Create menu items

   209

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

   210

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

   211

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

   212

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

   213

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

   214

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

   215

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

   216

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

   217

        parent.AppendSeparator()

   218

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

   219

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

   220

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

   221

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

   222

        parent.AppendSeparator()

   223

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

   224

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

   225

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

   226

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

   227

        parent.AppendSeparator()

   228

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

   229

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

   230

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

   231

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

   232

        parent.AppendSeparator()

   233

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

   234

        parent.AppendSeparator()

   235

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

   236

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

   237

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

   238

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

   239

        # Link menu event to corresponding called functions

   240

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

   241

              id=ID_VIEWERCONTEXTUALMENUITEMS0)

   242

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

   243

              id=ID_VIEWERCONTEXTUALMENUITEMS1)

   244

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

   245

              id=ID_VIEWERCONTEXTUALMENUITEMS2)

   246

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

   247

              id=ID_VIEWERCONTEXTUALMENUITEMS3)

   248

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

   249

              id=ID_VIEWERCONTEXTUALMENUITEMS5)

   250

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

   251

              id=ID_VIEWERCONTEXTUALMENUITEMS6)

   252

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

   253

              id=ID_VIEWERCONTEXTUALMENUITEMS8)

   254

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

   255

              id=ID_VIEWERCONTEXTUALMENUITEMS9)

   256

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

   257

              id=ID_VIEWERCONTEXTUALMENUITEMS11)

   258

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

   259

              id=ID_VIEWERCONTEXTUALMENUITEMS12)

   260

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

   261

              id=ID_VIEWERCONTEXTUALMENUITEMS16)

   262

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

   263

              id=ID_VIEWERCONTEXTUALMENUITEMS17)

   264

   265

    # Create and initialize Contextual Menu

   266

    def _init_menus(self):

   267

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

   268

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

   269

   270

        self._init_coll_AlignmentMenu_Items(self.AlignmentMenu)

   271

        self._init_coll_ContextualMenu_Items(self.ContextualMenu)

   272

   273

    # Create a new Viewer

   274

    def __init__(self, parent, tagname, window, controler):

   275

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

   276

            style=wx.SUNKEN_BORDER | wx.HSCROLL | wx.VSCROLL)

   277

        self._init_menus()

   278

        # Adding a rubberband to Viewer

   279

        self.rubberBand = RubberBand(drawingSurface=self)

   280

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

   281

        self.ResetView()

   282

        self.Scaling = None

   283

        self.DrawGrid = True

   285

        self.DrawingWire = False

   286

        self.current_id = 0

   287

        self.TagName = tagname

   288

   289

        # Initialize Block, Wire and Comment numbers

   290

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

   291

   292

        # Initialize Viewer mode to Selection mode

   293

        self.Mode = MODE_SELECTION

   294

        self.SavedMode = False

   295

        self.CurrentLanguage = "FBD"

   296

   297

        self.ParentWindow = window

   298

        self.Controler = controler

   299

   300

        self.SetDropTarget(ViewerDropTarget(self))

   301

   302

        # Link Viewer event to corresponding methods

   303

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

   304

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

   305

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

   306

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

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

   315

    def GetScrolledRect(self, rect):

   316

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

   317

        return rect

   318

   322

    def SetTagName(self, tagname):

   323

        self.TagName = tagname

   324

   325

    def GetTagName(self):

   326

        return self.TagName

   327

   328

    def IsViewing(self, tagname):

   329

        return self.TagName == tagname

   330

   331

    # Returns a new id

   332

    def GetNewId(self):

   333

        self.current_id += 1

   334

        return self.current_id

   335

   336

    # Destructor

   337

    def __del__(self):

   338

        self.ResetView()

   339

   340

    def GetLogicalDC(self, buffered=False):

   341

        if buffered:

   342

            dc = wx.BufferedPaintDC(self)

   343

        else:

   344

            dc = wx.ClientDC(self)

   345

        if wx.Platform == '__WXMSW__':

   346

            dc.SetFont(wx.Font(10, wx.SWISS, wx.NORMAL, wx.NORMAL))

   347

        else:

   348

            dc.SetFont(wx.NORMAL_FONT)

   349

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

   350

            self.DoPrepareDC(dc)

   351

        else:

   352

            self.PrepareDC(dc)

   353

        return dc

   354

   355

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

   356

#                         Element management functions

   357

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

   358

   359

    def AddBlock(self, block):

   360

        self.block_id += 1

   361

        self.Blocks[block] = self.block_id

   362

   363

    def AddWire(self, wire):

   364

        self.wire_id += 1

   365

        self.Wires[wire] = self.wire_id

   366

   367

    def AddComment(self, comment):

   368

        self.comment_id += 1

   369

        self.Comments[comment] = self.comment_id

   370

   371

    def IsBlock(self, block):

   372

        return self.Blocks.get(block, False)

   373

   374

    def IsWire(self, wire):

   375

        return self.Wires.get(wire, False)

   376

   377

    def IsComment(self, comment):

   378

        return self.Comments.get(comment, False)

   379

   380

    def RemoveBlock(self, block):

   381

        self.Blocks.pop(block)

   382

   383

    def RemoveWire(self, wire):

   384

        self.Wires.pop(wire)

   385

   386

    def RemoveComment(self, comment):

   387

        self.Comments.pop(comment)

   388

   389

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

   390

        blocks = self.Blocks.keys()

   391

        wires = self.Wires.keys()

   392

        comments = self.Comments.keys()

   393

        if sort_blocks:

   394

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

   395

        if sort_wires:

   396

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

   397

        if sort_comments:

   398

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

   399

        return blocks + wires + comments

   400

   401

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

   402

#                              Reset functions

   403

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

   404

   405

    # Resets Viewer lists

   406

    def ResetView(self):

   407

        self.Blocks = {}

   408

        self.Wires = {}

   409

        self.Comments = {}

   410

        self.SelectedElement = None

   411

        self.HighlightedElement = None

   412

   413

    # Remove all elements

   414

    def CleanView(self):

   415

        for block in self.Blocks.keys():

   416

            block.Clean()

   417

        self.ResetView()

   418

   419

    # Changes Viewer mode

   420

    def SetMode(self, mode):

   421

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

   422

            self.Mode = mode

   423

            self.SavedMode = False

   424

        else:

   425

            self.SavedMode = True

   426

        # Reset selection

   427

        if self.Mode != MODE_SELECTION and self.SelectedElement:

   428

            self.SelectedElement.SetSelected(False)

   429

            self.SelectedElement = None

   430

   431

    # Return current drawing mode

   432

    def GetDrawingMode(self):

   433

        return self.ParentWindow.GetDrawingMode()

   434

   435

    # Buffer the last model state

   436

    def RefreshBuffer(self):

   437

        self.Controler.BufferProject()

   438

        self.ParentWindow.RefreshTitle()

   439

        self.ParentWindow.RefreshEditMenu()

   440

   464

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

   465

#                          Refresh functions

   466

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

   467

   468

    def ResetBuffer(self):

   469

        pass

   470

   471

    # Refresh Viewer elements

   472

    def RefreshView(self):

   473

        self.current_id = 0

   474

        # Start by reseting Viewer

   475

        self.ResetView()

   476

        instance = True

   477

        # List of ids of already loaded blocks

   478

        ids = []

   479

        # Load Blocks until they are all loaded

   480

        while instance:

   481

            instance = self.Controler.GetEditedElementInstanceInfos(self.TagName, exclude=ids)

   482

            if instance:

   483

                self.loadInstance(instance, ids)

   484

        self.RefreshScrollBars()

   485

   486

        to_delete = []

   487

        for wire in self.Wires:

   488

            if not wire.IsConnectedCompatible():

   489

                to_delete.append(wire)

   490

        for wire in to_delete:

   491

            wire.Delete()

   492

   493

        self.Refresh()

   494