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

import datetime

    30

    31

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

    32

#                               Common constants

    33

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

    34

    35

"""

    36

Definition of constants for dimensions of graphic elements

    37

"""

    38

    39

# FBD and SFC constants

    40

MIN_MOVE = 5                            # Minimum move before starting a element dragging

    41

CONNECTOR_SIZE = 8                      # Size of connectors

    42

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

    43

HANDLE_SIZE = 6                         # Size of the squares for handles

    44

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

    45

POINT_RADIUS = 2                        # Radius of the point of wire ends

    46

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

    47

    48

# LD constants

    49

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

    50

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

    51

LD_WIRE_SIZE = 30                       # Size of a wire between two contact

    52

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

    53

LD_POWERRAIL_WIDTH = 3                  # Width of a Powerrail

    54

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

    55

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

    56

    57

# SFC constants

    58

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

    59

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

    60

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

    61

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

    62

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

    63

SFC_WIRE_MIN_SIZE = 25                  # Size of a wire between two elements

    64

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

    65

    66

# Type definition constants for graphic elements

    67

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

    68

[CONNECTOR, CONTINUATION] = range(2)

    69

[LEFTRAIL, RIGHTRAIL] = range(2)

    70

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

    71

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

    72

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

    73

    74

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

    75

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

    76

    77

# List of value for resize handle that are valid

    78

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

    79

    80

# Contants for defining the direction of a connector

    81

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

    82

    83

# Contants for defining which mode is selected for each view 

    84

[MODE_SELECTION, MODE_BLOCK, MODE_VARIABLE, MODE_CONNECTION, MODE_COMMENT, 

    85

 MODE_COIL, MODE_CONTACT, MODE_POWERRAIL, MODE_INITIALSTEP, MODE_STEP, 

    86

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

    87

    88

# Contants for defining alignment types for graphic group 

    89

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

    90

    91

# Contants for defining which drawing mode is selected for app

    92

[FREEDRAWING_MODE, DRIVENDRAWING_MODE] = [1, 2]

    93

    94

# Color for Highlighting

    95

HIGHLIGHTCOLOR = wx.CYAN

    96

    97

HANDLE_CURSORS = {

    98

    (1, 1) : 2,

    99

    (3, 3) : 2,

   100

    (1, 3) : 3,

   101

    (3, 1) : 3,

   102

    (1, 2) : 4,

   103

    (3, 2) : 4,

   104

    (2, 1) : 5,

   105

    (2, 3) : 5

   106

}

   107

   108

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

   109

    fraction = float(x) / float(n)

   110

    if constraint == - 1:

   111

        xround = int(fraction)

   112

    else:

   113

        xround = round(fraction)

   114

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

   115

            xround += 1

   116

    return xround * n

   117

   118

"""

   119

Basic vector operations for calculate wire points

   120

"""

   121

   122

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

   123

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

   124

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

   125

    if normal:

   126

        return normalize(vector)

   127

    return vector

   128

   129

# Calculate the norm of a given vector

   130

def norm(v):

   131

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

   132

   133

# Normalize a given vector

   134

def normalize(v):

   135

    v_norm = norm(v)

   136

    # Verifie if it is not a null vector

   137

    if v_norm > 0:

   138

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

   139

    else:

   140

        return v

   141

   142

# Calculate the scalar product of two vectors

   143

def is_null_vector(v):

   144

    return v == (0, 0)

   145

   146

# Calculate the scalar product of two vectors

   147

def add_vectors(v1, v2):

   148

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

   149

   150

# Calculate the scalar product of two vectors

   151

def product(v1, v2):

   152

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

   153

   154

   155

"""

   156

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

   157

"""

   158

   159

def GetScaledEventPosition(event, dc, scaling):

   160

    pos = event.GetLogicalPosition(dc)

   161

    if scaling:

   162

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

   163

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

   164

    return pos

   165

   166

   167

"""

   168

Function that choose a direction during the wire points generation

   169

"""

   170

   171

def DirectionChoice(v_base, v_target, dir_target):

   172

    dir_product = product(v_base, v_target)

   173

    if dir_product < 0:

   174

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

   175

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

   176

        return dir_target

   177

    return v_base

   178

   179

SECOND = 1000000

   180

MINUTE = 60 * SECOND

   181

HOUR = 60 * MINUTE

   182

DAY = 24 * HOUR

   183

   184

def generate_time(value):

   185

    microseconds = float(value.days * DAY + value.seconds * SECOND + value.microseconds)

   186

    negative = microseconds < 0

   187

    microseconds = abs(microseconds)

   188

    data = "T#"

   189

    not_null = False

   190

    if negative:

   191

        data += "-"

   192

    for val, format in [(int(microseconds) / DAY, "%dd"),

   193

                        ((int(microseconds) % DAY) / HOUR, "%dh"),

   194

                        ((int(microseconds) % HOUR) / MINUTE, "%dm"),

   195

                        ((int(microseconds) % MINUTE) / SECOND, "%ds")]:

   196

        if val > 0 or not_null:

   197

            data += format % val

   198

            not_null = True

   199

    data += "%gms" % (microseconds % SECOND / 1000.)

   200

    return data

   201

   202

def generate_date(value):

   203

    base_date = datetime.datetime(1970, 1, 1)

   204

    date = base_date + value 

   205

    return date.strftime("DATE#%Y-%m-%d")

   206

   207

def generate_datetime(value):

   208

    base_date = datetime.datetime(1970, 1, 1)

   209

    date_time = base_date + value 

   210

    return date_time.strftime("DT#%Y-%m-%d-%H:%M:%S.%f")

   211

   212

def generate_timeofday(value):

   213

    microseconds = float(value.days * DAY + value.seconds * SECOND + value.microseconds)

   214

    negative = microseconds < 0

   215

    microseconds = abs(microseconds)

   216

    data = "TOD#"

   217

    for val, format in [(int(microseconds) / HOUR, "%2.2d:"),

   218

                        ((int(microseconds) % HOUR) / MINUTE, "%2.2d:"),

   219

                        ((int(microseconds) % MINUTE) / SECOND, "%2.2d."),

   220

                        (microseconds % SECOND, "%6.6d")]:

   221

        data += format % val

   222

    return data

   223

   224

TYPE_TRANSLATOR = {"TIME": generate_time,

   225

                   "DATE": generate_date,

   226

                   "DT": generate_datetime,

   227

                   "TOD": generate_timeofday}

   228

   229

def MiterPen(colour, width=1, style=wx.SOLID):

   230

    pen = wx.Pen(colour, width, style)

   231

    pen.SetJoin(wx.JOIN_MITER)

   232

    pen.SetCap(wx.CAP_PROJECTING)

   233

    return pen

   234

   235

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

   236

#                            Debug Data Consumer Class

   237

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

   238

   239

class DebugDataConsumer:

   240

   241

    def __init__(self):

   242

        self.LastValue = None

   243

        self.Value = None

   244

        self.DataType = None

   245

        self.LastForced = False

   246

        self.Forced = False

   247

        self.Inhibited = False

   248

   249

    def Inhibit(self, inhibit):

   250

        self.Inhibited = inhibit

   251

        if not inhibit and self.LastValue is not None:

   252

            self.SetForced(self.LastForced)

   253

            self.SetValue(self.LastValue)

   254

            self.LastValue = None

   255

   256

    def SetDataType(self, data_type):

   257

        self.DataType = data_type

   258

   259

    def NewValue(self, tick, value, forced=False):

   260

        value = TYPE_TRANSLATOR.get(self.DataType, lambda x:x)(value)

   261

        if self.Inhibited:

   262

            self.LastValue = value

   263

            self.LastForced = forced

   264

        else:

   265

            self.SetForced(forced)

   266

            self.SetValue(value)

   267

   268

    def SetValue(self, value):

   269

        self.Value = value

   270

   271

    def GetValue(self):

   272

        return self.Value

   273

   274

    def SetForced(self, forced):

   275

        self.Forced = forced

   276

   277

    def IsForced(self):

   278

        return self.Forced

   279

   280

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

   281

#                               Debug Viewer Class

   282

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

   283

   284

REFRESH_PERIOD = 0.1

   285

   286

class DebugViewer:

   287

   288

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

   289

        self.DataProducer = None

   290

        self.Debug = debug

   291

        self.RegisterTick = register_tick

   292

        self.Inhibited = False

   293

   294

        self.DataConsumers = {}

   295

   296

        self.LastRefreshTime = gettime()

   297

   298

        self.RefreshTimer = wx.Timer(self, -1)

   299

        self.Bind(wx.EVT_TIMER, self.OnRefreshTimer, self.RefreshTimer)

   300

   301

        self.SetDataProducer(producer)

   302

   303

    def __del__(self):

   304

        self.DataProducer = None

   305

        self.DeleteDataConsumers()

   306

        self.RefreshTimer.Stop()

   307

   308

    def SetDataProducer(self, producer):

   309

        if self.RegisterTick and self.Debug:

   310

            if producer is not None:

   311

                producer.SubscribeDebugIECVariable("__tick__", self)

   312

            if self.DataProducer is not None:

   313

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

   314

        self.DataProducer = producer

   315

   316

    def IsDebugging(self):

   317

        return self.Debug

   318

   319

    def Inhibit(self, inhibit):

   320

        self.Inhibited = inhibit

   321

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

   322

            consumer.Inhibit(inhibit)

   323

   324

    def AddDataConsumer(self, iec_path, consumer):

   325

        if self.DataProducer is None:

   326

            return False

   327

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

   328

        if result is not None and consumer != self:

   329

            self.DataConsumers[consumer] = iec_path

   330

            consumer.SetDataType(self.GetDataType(iec_path))

   331

        return result

   332

   333

    def RemoveDataConsumer(self, consumer):

   334

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

   335

        if iec_path is not None:

   336

            self.DataProducer.UnsubscribeDebugIECVariable(iec_path, consumer)

   337

   338

    def GetDataType(self, iec_path):

   339

        if self.DataProducer is not None:

   340

            return self.DataProducer.GetDebugIECVariableType(iec_path)

   341

        return None

   342

   343

    def ForceDataValue(self, iec_path, value):

   344

        if self.DataProducer is not None:

   345

            self.DataProducer.ForceDebugIECVariable(iec_path, value)

   346

   347

    def ReleaseDataValue(self, iec_path):

   348

        if self.DataProducer is not None:

   349

            self.DataProducer.ReleaseDebugIECVariable(iec_path)

   350

   351

    def DeleteDataConsumers(self):

   352

        if self.DataProducer is not None:

   353

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

   354

                self.DataProducer.UnsubscribeDebugIECVariable(iec_path, consumer)

   355

        self.DataConsumers = {}

   356

   357

    def OnRefreshTimer(self, event):

   358

        self.RefreshNewData()

   359

        event.Skip()

   360

   361

    def NewDataAvailable(self):

   362

        self.RefreshTimer.Stop()

   363

        if not self.Inhibited:

   364

            current_time = gettime()

   365

            if current_time - self.LastRefreshTime > REFRESH_PERIOD:

   366

                self.LastRefreshTime = current_time

   367

                self.Inhibit(True)

   368

                wx.CallAfter(self.RefreshViewOnNewData)

   369

   370

    def RefreshViewOnNewData(self):

   371

        if self:

   372

            self.RefreshNewData()

   373

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

   374

   375

    def RefreshNewData(self):

   376

        self.Inhibit(False)

   377

   378

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

   379

#                               Viewer Rubberband

   380

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

   381

   382

"""

   383

Class that implements a rubberband

   384

"""

   385

   386

class RubberBand:

   387

   388

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

   389

    def __init__(self, drawingSurface):

   390

        self.drawingSurface = drawingSurface

   391

        self.Reset()

   392

   393

    # Method that initializes the internal attributes of the rubberband

   394

    def Reset(self):

   395

        self.startPoint = None

   396

        self.currentBox = None

   397

        self.lastBox = None

   398

   399

    # Method that return if a box is currently edited

   400

    def IsShown(self):

   401

        return self.currentBox != None

   402

   403

    # Method that returns the currently edited box

   404

    def GetCurrentExtent(self):

   405

        return self.currentBox

   406

   407

    # Method called when a new box starts to be edited

   408

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

   409

        pos = GetScaledEventPosition(event, dc, scaling)

   410

        # Save the point for calculate the box position and size

   411

        self.startPoint = pos

   412

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

   413

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

   414

        self.Redraw()

   415

   416

    # Method called when dragging with a box edited

   417

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

   418

        pos = GetScaledEventPosition(event, dc, scaling)

   419

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

   420

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

   421

            self.currentBox.height)

   422

        # Calculate new position and size of the box 

   423

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

   424

            self.currentBox.x = self.startPoint.x

   425

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

   426

        else:

   427

            self.currentBox.x = pos.x

   428

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

   429

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

   430

            self.currentBox.y = self.startPoint.y

   431

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

   432

        else:

   433

            self.currentBox.y = pos.y

   434

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

   435

        self.Redraw()

   436

   437

    # Method called when dragging is stopped

   438

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

   439

        self.drawingSurface.SetCursor(wx.NullCursor)

   440

        self.lastBox = self.currentBox

   441

        self.currentBox = None

   442

        self.Redraw()

   443

   444

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

   445

    def Redraw(self, dc = None):

   446

        if not dc:

   447

            dc = self.drawingSurface.GetLogicalDC()

   448

        scalex, scaley = dc.GetUserScale()

   449

        dc.SetUserScale(1, 1)

   450

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

   451

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   452

        dc.SetLogicalFunction(wx.XOR)

   453

        if self.lastBox:

   454

            # Erase last box

   455

            dc.DrawRectangle(self.lastBox.x * scalex, self.lastBox.y * scaley, 

   456

                             self.lastBox.width * scalex, self.lastBox.height * scaley)

   457

        if self.currentBox:

   458

            # Draw current box

   459

            dc.DrawRectangle(self.currentBox.x * scalex, self.currentBox.y * scaley, 

   460

                             self.currentBox.width * scalex, self.currentBox.height * scaley)

   461

        dc.SetUserScale(scalex, scaley)

   462

   463

    # Erase last box

   464

    def Erase(self, dc = None):

   465

        if not dc:

   466

            dc = self.drawingSurface.GetLogicalDC()

   467

        scalex, scaley = dc.GetUserScale()

   468

        dc.SetUserScale(1, 1)

   469

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

   470

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   471

        dc.SetLogicalFunction(wx.XOR)

   472

        if self.lastBox:

   473

            dc.DrawRectangle(self.lastBox.x * scalex, self.lastBox.y * scaley, 

   474

                             self.lastBox.width * scalex, self.lastBox.height * scalex)

   475

        dc.SetUserScale(scalex, scaley)

   476

   477

    # Draw current box

   478

    def Draw(self, dc = None):

   479

        if not dc:

   480

            dc = self.drawingSurface.GetLogicalDC()

   481

        scalex, scaley = dc.GetUserScale()

   482

        dc.SetUserScale(1, 1)

   483

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

   484

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   485

        dc.SetLogicalFunction(wx.XOR)

   486

        if self.currentBox:

   487

            # Draw current box

   488

            dc.DrawRectangle(self.currentBox.x * scalex, self.currentBox.y * scaley, 

   489

                             self.currentBox.width * scalex, self.currentBox.height * scaley)

   490

        dc.SetUserScale(scalex, scaley)

   491

   492

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

   493

#                               Viewer ToolTip

   494

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

   495

   496

"""

   497

Class that implements a custom tool tip

   498

"""

   499