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

from time import time as gettime

    27

from math import *

    28

from types import *

    29

    30

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

    31

#                               Common constants

    32

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

    33

    34

"""

    35

Definition of constants for dimensions of graphic elements

    36

"""

    37

    38

# FBD and SFC constants

    39

MIN_MOVE = 5                            # Minimum move before starting a element dragging

    40

CONNECTOR_SIZE = 8                      # Size of connectors

    41

BLOCK_LINE_SIZE = 20                    # Minimum size of each line in a block

    42

HANDLE_SIZE = 6                         # Size of the squares for handles

    43

ANCHOR_DISTANCE = 5                     # Distance where wire is automativally attached to a connector

    44

POINT_RADIUS = 2                        # Radius of the point of wire ends

    45

MIN_SEGMENT_SIZE = 2                    # Minimum size of the endling segments of a wire

    46

    47

# LD constants

    48

LD_LINE_SIZE = 40                       # Distance between two lines in a ladder rung

    49

LD_ELEMENT_SIZE = (21, 15)              # Size (width, height) of a ladder element (contact or coil)

    50

LD_WIRE_SIZE = 30                       # Size of a wire between two contact

    51

LD_WIRECOIL_SIZE = 70                   # Size of a wire between a coil and a contact

    52

LD_POWERRAIL_WIDTH = 3                  # Width of a Powerrail

    53

LD_OFFSET = (10, 10)                    # Distance (x, y) between each comment and rung of the ladder

    54

LD_COMMENT_DEFAULTSIZE = (600, 40)      # Size (width, height) of a comment box

    55

    56

# SFC constants

    57

SFC_STEP_DEFAULT_SIZE = (40, 30)        # Default size of a SFC step

    58

SFC_TRANSITION_SIZE = (20, 2)           # Size of a SFC transition

    59

SFC_DEFAULT_SEQUENCE_INTERVAL = 40      # Default size of the interval between two divergence branches

    60

SFC_SIMULTANEOUS_SEQUENCE_EXTRA = 20    # Size of extra lines for simultaneous divergence and convergence

    61

SFC_JUMP_SIZE = (12, 13)                # Size of a SFC jump to step

    62

SFC_WIRE_MIN_SIZE = 25                  # Size of a wire between two elements

    63

SFC_ACTION_MIN_SIZE = (100, 30)         # Minimum size of an action block line

    64

    65

# Type definition constants for graphic elements

    66

[INPUT, OUTPUT, INOUT] = range(3)

    67

[CONNECTOR, CONTINUATION] = range(2)

    68

[LEFTRAIL, RIGHTRAIL] = range(2)

    69

[CONTACT_NORMAL, CONTACT_REVERSE, CONTACT_RISING, CONTACT_FALLING] = range(4)

    70

[COIL_NORMAL, COIL_REVERSE, COIL_SET, COIL_RESET, COIL_RISING, COIL_FALLING] = range(6)

    71

[SELECTION_DIVERGENCE, SELECTION_CONVERGENCE, SIMULTANEOUS_DIVERGENCE, SIMULTANEOUS_CONVERGENCE] = range(4)

    72

    73

# Constants for defining the type of dragging that has been selected

    74

[HANDLE_MOVE, HANDLE_RESIZE, HANDLE_POINT, HANDLE_SEGMENT, HANDLE_CONNECTOR] = range(5)

    75

    76

# List of value for resize handle that are valid

    77

VALID_HANDLES = [(1,1), (1,2), (1,3), (2,3), (3,3), (3,2), (3,1), (2,1)]

    78

    79

# Contants for defining the direction of a connector

    80

[EAST, NORTH, WEST, SOUTH] = [(1,0), (0,-1), (-1,0), (0,1)]

    81

    82

# Contants for defining which mode is selected for each view 

    83

[MODE_SELECTION, MODE_BLOCK, MODE_VARIABLE, MODE_CONNECTION, MODE_COMMENT, 

    84

 MODE_COIL, MODE_CONTACT, MODE_POWERRAIL, MODE_INITIALSTEP, MODE_STEP, 

    85

 MODE_TRANSITION, MODE_DIVERGENCE, MODE_JUMP, MODE_ACTION] = range(14)

    86

    87

# Contants for defining alignment types for graphic group 

    88

[ALIGN_LEFT, ALIGN_CENTER, ALIGN_RIGHT, ALIGN_TOP, ALIGN_MIDDLE, ALIGN_BOTTOM] = range(6)

    89

    90

# Contants for defining which drawing mode is selected for app

    91

[FREEDRAWING_MODE, DRIVENDRAWING_MODE] = [1, 2]

    92

    93

# Color for Highlighting

    94

HIGHLIGHTCOLOR = wx.CYAN

    95

    96

CURSORS = None

    97

    98

def ResetCursors():

    99

    global CURSORS

   100

    if CURSORS == None:

   101

        CURSORS = [wx.NullCursor, 

   102

                   wx.StockCursor(wx.CURSOR_HAND),

   103

                   wx.StockCursor(wx.CURSOR_SIZENWSE),

   104

                   wx.StockCursor(wx.CURSOR_SIZENESW),

   105

                   wx.StockCursor(wx.CURSOR_SIZEWE),

   106

                   wx.StockCursor(wx.CURSOR_SIZENS)]

   107

   108

HANDLE_CURSORS = {

   109

    (1, 1) : 2,

   110

    (3, 3) : 2,

   111

    (1, 3) : 3,

   112

    (3, 1) : 3,

   113

    (1, 2) : 4,

   114

    (3, 2) : 4,

   115

    (2, 1) : 5,

   116

    (2, 3) : 5

   117

}

   118

   119

def round_scaling(x, n, constraint=0):

   120

    fraction = float(x) / float(n)

   121

    if constraint == - 1:

   122

        xround = int(fraction)

   123

    else:

   124

        xround = round(fraction)

   125

        if constraint == 1 and int(fraction) == xround:

   126

            xround += 1

   127

    return xround * n

   128

   129

"""

   130

Basic vector operations for calculate wire points

   131

"""

   132

   133

# Create a vector from two points and define if vector must be normal

   134

def vector(p1, p2, normal = True):

   135

    vector = (p2.x - p1.x, p2.y - p1.y)

   136

    if normal:

   137

        return normalize(vector)

   138

    return vector

   139

   140

# Calculate the norm of a given vector

   141

def norm(v):

   142

    return sqrt(v[0] * v[0] + v[1] * v[1])

   143

   144

# Normalize a given vector

   145

def normalize(v):

   146

    v_norm = norm(v)

   147

    # Verifie if it is not a null vector

   148

    if v_norm > 0:

   149

        return (v[0] / v_norm, v[1] / v_norm)

   150

    else:

   151

        return v

   152

   153

# Calculate the scalar product of two vectors

   154

def is_null_vector(v):

   155

    return v == (0, 0)

   156

   157

# Calculate the scalar product of two vectors

   158

def add_vectors(v1, v2):

   159

    return (v1[0] + v2[0], v1[1] + v2[1])

   160

   161

# Calculate the scalar product of two vectors

   162

def product(v1, v2):

   163

    return v1[0] * v2[0] + v1[1] * v2[1]

   164

   165

   166

"""

   167

Function that calculates the nearest point of the grid defined by scaling for the given point

   168

"""

   169

   170

def GetScaledEventPosition(event, dc, scaling):

   171

    pos = event.GetLogicalPosition(dc)

   172

    if scaling:

   173

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

   174

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

   175

    return pos

   176

   177

   178

"""

   179

Function that choose a direction during the wire points generation

   180

"""

   181

   182

def DirectionChoice(v_base, v_target, dir_target):

   183

    dir_product = product(v_base, v_target)

   184

    if dir_product < 0:

   185

        return (-v_base[0], -v_base[1])

   186

    elif dir_product == 0 and product(v_base, dir_target) != 0:

   187

        return dir_target

   188

    return v_base

   189

   190

   191

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

   192

#                            Debug Data Consumer Class

   193

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

   194

   195

class DebugDataConsumer:

   196

   197

    def __init__(self):

   198

        self.LastValue = None

   199

        self.Value = None

   200

        self.Inhibited = False

   201

   202

    def Inhibit(self, inhibit):

   203

        self.Inhibited = inhibit

   205

            self.SetValue(self.LastValue)

   206

            self.LastValue = None

   207

   208

    def NewValue(self, tick, value):

   209

        if self.Inhibited:

   210

            self.LastValue = value

   211

        else:

   212

            self.SetValue(value)

   213

   214

    def SetValue(self, value):

   215

        self.Value = value

   216

   217

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

   218

#                               Debug Viewer Class

   219

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

   220

   221

REFRESH_PERIOD = 0.1

   222

   223

class DebugViewer:

   224

   225

    def __init__(self, producer, debug, register_tick=True):

   226

        self.DataProducer = producer

   227

        self.Debug = debug

   229

   230

        self.DataConsumers = {}

   231

   232

        self.LastRefreshTime = gettime()

   233

   237

        if register_tick and debug:

   238

            self.DataProducer.SubscribeDebugIECVariable("__tick__", self)

   239

   240

    def __del__(self):

   241

        if self.Debug:

   242

            self.DataProducer.UnsubscribeDebugIECVariable("__tick__", self)

   243

        self.DeleteDataConsumers()

   244

        self.RefreshTimer.Stop()

   245

   246

    def Inhibit(self, inhibit):

   248

        for consumer, iec_path in self.DataConsumers.iteritems():

   249

            consumer.Inhibit(inhibit)

   250

   251

    def AddDataConsumer(self, iec_path, consumer):

   252

        result = self.DataProducer.SubscribeDebugIECVariable(iec_path, consumer) is not None

   253

        if result is not None and consumer != self:

   254

            self.DataConsumers[consumer] = iec_path

   255

        return result

   256

   257

    def RemoveDataConsumer(self, consumer):

   258

        iec_path = self.DataConsumers.pop(consumer, None)

   259

        if iec_path is not None:

   260

            self.DataProducer.UnsubscribeDebugIECVariable(iec_path, consumer)

   261

   262

    def DeleteDataConsumers(self):

   263

        for consumer, iec_path in self.DataConsumers.iteritems():

   264

            self.DataProducer.UnsubscribeDebugIECVariable(iec_path, consumer)

   265

        self.DataConsumers = {}

   266

   267

    def OnRefreshTimer(self, event):

   268

        self.RefreshNewData()

   269

        event.Skip()

   270

   271

    def NewDataAvailable(self):

   280

    def RefreshViewOnNewData(self):

   281

        if self:

   282

            self.RefreshNewData()

   283

            self.RefreshTimer.Start(int(REFRESH_PERIOD * 1000), oneShot=True)

   284

   285

    def RefreshNewData(self):

   286

        self.Inhibit(False)

   287

   288

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

   289

#                               Viewer Rubberband

   290

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

   291

   292

"""

   293

Class that implements a rubberband

   294

"""

   295

   296

class RubberBand:

   297

   298

    # Create a rubberband by indicated on which window it must be drawn

   299

    def __init__(self, drawingSurface):

   300

        self.drawingSurface = drawingSurface

   301

        self.Reset()

   302

   303

    # Method that initializes the internal attributes of the rubberband

   304

    def Reset(self):

   305

        self.startPoint = None

   306

        self.currentBox = None

   307

        self.lastBox = None

   308

   309

    # Method that return if a box is currently edited

   310

    def IsShown(self):

   311

        return self.currentBox != None

   312

   313

    # Method that returns the currently edited box

   314

    def GetCurrentExtent(self):

   315

        return self.currentBox

   316

   317

    # Method called when a new box starts to be edited

   318

    def OnLeftDown(self, event, dc, scaling):

   319

        pos = GetScaledEventPosition(event, dc, scaling)

   320

        # Save the point for calculate the box position and size

   321

        self.startPoint = pos

   322

        self.currentBox = wx.Rect(pos.x, pos.y, 0, 0)

   323

        self.drawingSurface.SetCursor(wx.StockCursor(wx.CURSOR_CROSS))

   324

        self.Redraw()

   325

   326

    # Method called when dragging with a box edited

   327

    def OnMotion(self, event, dc, scaling):

   328

        pos = GetScaledEventPosition(event, dc, scaling)

   329

        # Save the last position and size of the box for erasing it

   330

        self.lastBox = wx.Rect(self.currentBox.x, self.currentBox.y, self.currentBox.width,

   331

            self.currentBox.height)

   332

        # Calculate new position and size of the box 

   333

        if pos.x >= self.startPoint.x:

   334

            self.currentBox.x = self.startPoint.x

   335

            self.currentBox.width = pos.x - self.startPoint.x + 1

   336

        else:

   337

            self.currentBox.x = pos.x

   338

            self.currentBox.width = self.startPoint.x - pos.x + 1

   339

        if pos.y >= self.startPoint.y:

   340

            self.currentBox.y = self.startPoint.y

   341

            self.currentBox.height = pos.y - self.startPoint.y + 1

   342

        else:

   343

            self.currentBox.y = pos.y

   344

            self.currentBox.height = self.startPoint.y - pos.y + 1

   345

        self.Redraw()

   346

   347

    # Method called when dragging is stopped

   348

    def OnLeftUp(self, event, dc, scaling):

   349

        self.drawingSurface.SetCursor(wx.NullCursor)

   350

        self.lastBox = self.currentBox

   351

        self.currentBox = None

   352

        self.Redraw()

   353

   354

    # Method that erase the last box and draw the new box

   355

    def Redraw(self, dc = None):

   356

        if not dc:

   357

            dc = self.drawingSurface.GetLogicalDC()

   358

        dc.SetPen(wx.Pen(wx.WHITE, 1, wx.DOT))

   359

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   360

        dc.SetLogicalFunction(wx.XOR)

   361

        if self.lastBox:

   362

            # Erase last box

   363

            dc.DrawRectangle(self.lastBox.x, self.lastBox.y, self.lastBox.width,

   364

                self.lastBox.height)

   365

        if self.currentBox:

   366

            # Draw current box

   367

            dc.DrawRectangle(self.currentBox.x, self.currentBox.y, self.currentBox.width,

   368

                self.currentBox.height)

   369

   370

    # Erase last box

   371

    def Erase(self, dc = None):

   372

        if not dc:

   373

            dc = self.drawingSurface.GetLogicalDC()

   374

        dc.SetPen(wx.Pen(wx.WHITE, 1, wx.DOT))

   375

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   376

        dc.SetLogicalFunction(wx.XOR)

   377

        if self.lastBox:

   378

            dc.DrawRectangle(self.lastBox.x, self.lastBox.y, self.lastBox.width,

   379

                self.lastBox.height)

   380

   381

    # Draw current box

   382

    def Draw(self, dc = None):

   383

        if not dc:

   384

            dc = self.drawingSurface.GetLogicalDC()

   385

        dc.SetPen(wx.Pen(wx.WHITE, 1, wx.DOT))

   386

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   387

        dc.SetLogicalFunction(wx.XOR)

   388

        if self.currentBox:

   389

            # Draw current box

   390

            dc.DrawRectangle(self.currentBox.x, self.currentBox.y, self.currentBox.width,

   391

                self.currentBox.height)

   392

   393

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

   394

#                               Viewer ToolTip

   395

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

   396

   397

"""

   398

Class that implements a custom tool tip

   399

"""

   400

   401

class ToolTip(wx.PopupWindow):

   402

   403

    # Create a rubberband by indicated on which window it must be drawn

   404

    def __init__(self, parent, tip):

   405

        wx.PopupWindow.__init__(self, parent)

   406

        self.SetBackgroundStyle(wx.BG_STYLE_CUSTOM)

   407

        self.SetTip(tip)

   408

   409

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

   410

   411

    def SetTip(self, tip):

   412

        self.Tip = tip

   413

        wx.CallAfter(self.RefreshTip)

   414

   415

    def RefreshTip(self):

   416

        if self:

   417

            dc = wx.ClientDC(self)

   418

            w, h = dc.GetTextExtent(self.Tip)

   419

            self.SetSize(wx.Size(w + 4, h + 4))

   420

            self.Refresh()

   421

   422

    def OnPaint(self, event):

   423

        dc = wx.AutoBufferedPaintDC(self)

   424

        dc.Clear()

   425

        dc.SetPen(wx.BLACK_PEN)

   426

        dc.SetBrush(wx.Brush(wx.Colour(255, 238, 170)))

   427

        dc.BeginDrawing()

   428

        w, h = dc.GetTextExtent(self.Tip)

   429

        dc.DrawRectangle(0, 0, w + 4, h + 4)

   430

        dc.DrawText(self.Tip, 2, 2)

   431

        dc.EndDrawing()

   432

        event.Skip()

   433

   434

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

   435

#                    Helper for highlighting error in drawn text

   436

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

   437

   438

def HighlightErrorZone(dc, x, y, width, height):

   439

    dc.SetPen(wx.TRANSPARENT_PEN)

   440

    dc.SetLogicalFunction(wx.AND)

   441

    dc.SetBrush(wx.Brush(wx.Colour(0,255,0)))

   442

    dc.DrawRectangle(x, y, width, height)

   443

    dc.SetLogicalFunction(wx.XOR)

   444

    dc.SetBrush(wx.Brush(wx.Colour(255,0,0)))

   445

    dc.DrawRectangle(x, y, width, height)

   446

    dc.SetLogicalFunction(wx.COPY)

   447

   448

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

   449

#                           Graphic element base class

   450

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

   451

   452

"""

   453

Class that implements a generic graphic element

   454

"""

   455

   456

class Graphic_Element:

   457

   458

    # Create a new graphic element

   459

    def __init__(self, parent, id = None):

   460

        self.Parent = parent

   461

        self.Id = id

   462

        self.oldPos = None

   463

        self.StartPos = None

   464

        self.CurrentDrag = None

   465

        self.Handle = (None,None)

   466

        self.Dragging = False

   467

        self.Selected = False

   468

        self.Highlighted = False

   469

        self.Pos = wx.Point(0, 0)

   470

        self.Size = wx.Size(0, 0)

   471

        self.BoundingBox = wx.Rect(0, 0, 0, 0)

   472

        self.Visible = False

   473

        self.CurrentCursor = 0

   474

        ResetCursors()

   475

   476

    def TestVisible(self, screen):

   477

        self.Visible = self.GetRedrawRect().Intersects(screen)

   478

   479

    def IsVisible(self):

   480

        return self.Visible

   481

   482

    def SpreadCurrent(self):

   483

        pass

   484

   485

    def GetConnectorTranslation(self, element):

   486

        return {}

   487

   488

    def IsOfType(self, type, reference):

   489

        return self.Parent.IsOfType(type, reference)

   490

   491

    def IsEndType(self, type):

   492

        return self.Parent.IsEndType(type)

   493

   494

    def GetDragging(self):

   495

        return self.Dragging

   496

   497

    # Make a clone of this element

   498

    def Clone(self, parent):

   499

        return Graphic_Element(parent, self.Id)

   500

   501

    # Changes the block position

   502

    def SetPosition(self, x, y):