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

from threading import Lock,Timer

    31

    33

    34

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

    35

#                               Common constants

    36

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

    37

    38

"""

    39

Definition of constants for dimensions of graphic elements

    40

"""

    41

    42

# FBD and SFC constants

    43

MIN_MOVE = 5                            # Minimum move before starting a element dragging

    44

CONNECTOR_SIZE = 8                      # Size of connectors

    45

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

    46

HANDLE_SIZE = 6                         # Size of the squares for handles

    47

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

    48

POINT_RADIUS = 2                        # Radius of the point of wire ends

    49

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

    50

    51

# LD constants

    52

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

    53

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

    54

LD_WIRE_SIZE = 30                       # Size of a wire between two contact

    55

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

    56

LD_POWERRAIL_WIDTH = 3                  # Width of a Powerrail

    57

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

    58

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

    59

    60

# SFC constants

    61

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

    62

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

    63

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

    64

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

    65

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

    66

SFC_WIRE_MIN_SIZE = 25                  # Size of a wire between two elements

    67

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

    68

    69

# Type definition constants for graphic elements

    70

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

    71

[CONNECTOR, CONTINUATION] = range(2)

    72

[LEFTRAIL, RIGHTRAIL] = range(2)

    73

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

    74

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

    75

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

    76

    77

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

    78

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

    79

    80

# List of value for resize handle that are valid

    81

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

    82

    83

# Contants for defining the direction of a connector

    84

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

    85

    86

# Contants for defining which mode is selected for each view 

    87

[MODE_SELECTION, MODE_BLOCK, MODE_VARIABLE, MODE_CONNECTION, MODE_COMMENT, 

    88

 MODE_COIL, MODE_CONTACT, MODE_POWERRAIL, MODE_INITIALSTEP, MODE_STEP, 

    89

 MODE_TRANSITION, MODE_DIVERGENCE, MODE_JUMP, MODE_ACTION, MODE_MOTION] = range(15)

    90

    91

# Contants for defining alignment types for graphic group 

    92

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

    93

    94

# Contants for defining which drawing mode is selected for app

    95

[FREEDRAWING_MODE, DRIVENDRAWING_MODE] = [1, 2]

    96

    97

# Color for Highlighting

    98

HIGHLIGHTCOLOR = wx.CYAN

    99

   100

# Define highlight types

   101

ERROR_HIGHLIGHT = (wx.Colour(255, 255, 0), wx.RED)

   102

SEARCH_RESULT_HIGHLIGHT = (wx.Colour(255, 165, 0), wx.WHITE)

   103

   104

# Define highlight refresh inhibition period in second

   105

REFRESH_HIGHLIGHT_PERIOD = 0.1

   106

   107

HANDLE_CURSORS = {

   108

    (1, 1) : 2,

   109

    (3, 3) : 2,

   110

    (1, 3) : 3,

   111

    (3, 1) : 3,

   112

    (1, 2) : 4,

   113

    (3, 2) : 4,

   114

    (2, 1) : 5,

   115

    (2, 3) : 5

   116

}

   117

   118

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

   119

    fraction = float(x) / float(n)

   120

    if constraint == -1:

   121

        xround = int(fraction)

   122

    else:

   123

        xround = round(fraction)

   124

        if constraint == 1 and xround < fraction:

   125

            xround += 1 

   126

    return int(xround * n)

   127

   128

"""

   129

Basic vector operations for calculate wire points

   130

"""

   131

   132

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

   133

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

   134

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

   135

    if normal:

   136

        return normalize(vector)

   137

    return vector

   138

   139

# Calculate the norm of a given vector

   140

def norm(v):

   141

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

   142

   143

# Normalize a given vector

   144

def normalize(v):

   145

    v_norm = norm(v)

   146

    # Verifie if it is not a null vector

   147

    if v_norm > 0:

   148

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

   149

    else:

   150

        return v

   151

   152

# Calculate the scalar product of two vectors

   153

def is_null_vector(v):

   154

    return v == (0, 0)

   155

   156

# Calculate the scalar product of two vectors

   157

def add_vectors(v1, v2):

   158

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

   159

   160

# Calculate the scalar product of two vectors

   161

def product(v1, v2):

   162

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

   163

   164

   165

"""

   166

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

   167

"""

   168

   169

def GetScaledEventPosition(event, dc, scaling):

   170

    pos = event.GetLogicalPosition(dc)

   171

    if scaling:

   172

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

   173

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

   174

    return pos

   175

   176

   177

"""

   178

Function that choose a direction during the wire points generation

   179

"""

   180

   181

def DirectionChoice(v_base, v_target, dir_target):

   182

    dir_product = product(v_base, v_target)

   183

    if dir_product < 0:

   184

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

   185

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

   186

        return dir_target

   187

    return v_base

   188

   189

SECOND = 1000000

   190

MINUTE = 60 * SECOND

   191

HOUR = 60 * MINUTE

   192

DAY = 24 * HOUR

   193

   194

def generate_time(value):

   195

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

   196

    negative = microseconds < 0

   197

    microseconds = abs(microseconds)

   198

    data = "T#"

   199

    not_null = False

   200

    if negative:

   201

        data += "-"

   202

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

   203

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

   204

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

   205

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

   206

        if val > 0 or not_null:

   207

            data += format % val

   208

            not_null = True

   209

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

   210

    return data

   211

   212

def generate_date(value):

   213

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

   214

    date = base_date + value 

   215

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

   216

   217

def generate_datetime(value):

   218

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

   219

    date_time = base_date + value 

   220

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

   221

   222

def generate_timeofday(value):

   223

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

   224

    negative = microseconds < 0

   225

    microseconds = abs(microseconds)

   226

    data = "TOD#"

   227

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

   228

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

   229

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

   230

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

   231

        data += format % val

   232

    return data

   233

   234

TYPE_TRANSLATOR = {"TIME": generate_time,

   235

                   "DATE": generate_date,

   236

                   "DT": generate_datetime,

   237

                   "TOD": generate_timeofday}

   238

   239

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

   240

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

   241

    pen.SetJoin(wx.JOIN_MITER)

   242

    pen.SetCap(wx.CAP_PROJECTING)

   243

    return pen

   244

   245

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

   246

#                            Debug Data Consumer Class

   247

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

   248

   249

class DebugDataConsumer:

   250

   251

    def __init__(self):

   252

        self.LastValue = None

   253

        self.Value = None

   254

        self.DataType = None

   255

        self.LastForced = False

   256

        self.Forced = False

   257

        self.Inhibited = False

   258

   259

    def Inhibit(self, inhibit):

   260

        self.Inhibited = inhibit

   261

        if not inhibit and self.LastValue is not None:

   262

            self.SetForced(self.LastForced)

   263

            self.SetValue(self.LastValue)

   264

            self.LastValue = None

   265

   266

    def SetDataType(self, data_type):

   267

        self.DataType = data_type

   268

   269

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

   270

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

   271

        if self.Inhibited:

   272

            self.LastValue = value

   273

            self.LastForced = forced

   274

        else:

   275

            self.SetForced(forced)

   276

            self.SetValue(value)

   277

   278

    def SetValue(self, value):

   279

        self.Value = value

   280

   281

    def GetValue(self):

   282

        return self.Value

   283

   284

    def SetForced(self, forced):

   285

        self.Forced = forced

   286

   287

    def IsForced(self):

   288

        return self.Forced

   289

   290

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

   291

#                               Debug Viewer Class

   292

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

   293

   294

REFRESH_PERIOD = 0.1

   295

DEBUG_REFRESH_LOCK = Lock()

   296

   297

class DebugViewer:

   298

   299

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

   300

        self.DataProducer = None

   301

        self.Debug = debug

   302

        self.RegisterTick = register_tick

   303

        self.Inhibited = False

   304

   305

        self.DataConsumers = {}

   306

   307

        self.LastRefreshTime = gettime()

   308

        self.HasAcquiredLock = False

   309

        self.AccessLock = Lock()

   310

        self.TimerAccessLock = Lock()

   311

   312

        self.LastRefreshTimer = None

   313

   314

        self.SetDataProducer(producer)

   315

   316

    def __del__(self):

   317

        self.DataProducer = None

   318

        self.DeleteDataConsumers()

   319

        if self.LastRefreshTimer is not None:

   320

            self.LastRefreshTimer.Stop()

   321

        if self.HasAcquiredLock:

   322

            DEBUG_REFRESH_LOCK.release()

   323

   324

    def SetDataProducer(self, producer):

   325

        if self.RegisterTick and self.Debug:

   326

            if producer is not None:

   327

                producer.SubscribeDebugIECVariable("__tick__", self)

   328

            if self.DataProducer is not None:

   329

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

   330

        self.DataProducer = producer

   331

   332

    def IsDebugging(self):

   333

        return self.Debug

   334

   335

    def Inhibit(self, inhibit):

   336

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

   337

            consumer.Inhibit(inhibit)

   338

        self.Inhibited = inhibit

   339

   340

    def AddDataConsumer(self, iec_path, consumer):

   341

        if self.DataProducer is None:

   342

            return None

   343

        result = self.DataProducer.SubscribeDebugIECVariable(iec_path, consumer)

   344

        if result is not None and consumer != self:

   345

            self.DataConsumers[consumer] = iec_path

   346

            consumer.SetDataType(self.GetDataType(iec_path))

   347

        return result

   348

   349

    def RemoveDataConsumer(self, consumer):

   350

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

   351

        if iec_path is not None:

   352

            self.DataProducer.UnsubscribeDebugIECVariable(iec_path, consumer)

   353

   354

    def RegisterVariables(self):

   355

        if self.RegisterTick and self.Debug and self.DataProducer is not None:

   356

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

   357

   358

    def GetDataType(self, iec_path):

   359

        if self.DataProducer is not None:

   360

            data_type = self.DataProducer.GetDebugIECVariableType(iec_path.upper())

   361

            if data_type is not None:

   362

                return data_type

   363

   364

            infos = self.DataProducer.GetInstanceInfos(iec_path)

   365

            if infos is not None:

   366

                return infos["type"]

   367

        return None

   368

   369

    def IsNumType(self, data_type):

   370

        return self.DataProducer.IsNumType(data_type)

   371

   372

    def ForceDataValue(self, iec_path, value):

   373

        if self.DataProducer is not None:

   374

            self.DataProducer.ForceDebugIECVariable(iec_path, value)

   375

   376

    def ReleaseDataValue(self, iec_path):

   377

        if self.DataProducer is not None:

   378

            self.DataProducer.ReleaseDebugIECVariable(iec_path)

   379

   380

    def DeleteDataConsumers(self):

   381

        if self.DataProducer is not None:

   382

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

   383

                self.DataProducer.UnsubscribeDebugIECVariable(iec_path, consumer)

   384

        self.DataConsumers = {}

   385

   386

    def ShouldRefresh(self):

   387

        if self:

   388

            wx.CallAfter(self._ShouldRefresh)

   389

   390

    def _ShouldRefresh(self):

   391

        if self:

   392

            if DEBUG_REFRESH_LOCK.acquire(False):

   393

                self.AccessLock.acquire()

   394

                self.HasAcquiredLock = True

   395

                self.AccessLock.release()

   396

                self.RefreshNewData()

   397

            else:

   398

                self.TimerAccessLock.acquire()

   399

                self.LastRefreshTimer = Timer(REFRESH_PERIOD, self.ShouldRefresh)

   400

                self.LastRefreshTimer.start()

   401

                self.TimerAccessLock.release()

   402

   403

    def NewDataAvailable(self, tick, *args, **kwargs):

   404

        self.TimerAccessLock.acquire()

   405

        if self.LastRefreshTimer is not None:

   406

            self.LastRefreshTimer.cancel()

   407

            self.LastRefreshTimer=None

   408

        self.TimerAccessLock.release()

   409

        if self.IsShown() and not self.Inhibited:

   410

            if gettime() - self.LastRefreshTime > REFRESH_PERIOD and DEBUG_REFRESH_LOCK.acquire(False):

   411

                self.AccessLock.acquire()

   412

                self.HasAcquiredLock = True

   413

                self.AccessLock.release()

   414

                self.LastRefreshTime = gettime()

   415

                self.Inhibit(True)

   416

                wx.CallAfter(self.RefreshViewOnNewData, *args, **kwargs)

   417

            else:

   418

                self.TimerAccessLock.acquire()

   419

                self.LastRefreshTimer = Timer(REFRESH_PERIOD, self.ShouldRefresh)

   420

                self.LastRefreshTimer.start()

   421

                self.TimerAccessLock.release()

   422

        elif not self.IsShown() and self.HasAcquiredLock:

   423

            DebugViewer.RefreshNewData(self)

   424

   425

    def RefreshViewOnNewData(self, *args, **kwargs):

   426

        if self:

   427

            self.RefreshNewData(*args, **kwargs)

   428

   429

    def RefreshNewData(self, *args, **kwargs):

   430

        self.Inhibit(False)

   431

        self.AccessLock.acquire()

   432

        if self.HasAcquiredLock:

   433

            DEBUG_REFRESH_LOCK.release()

   434

            self.HasAcquiredLock = False

   435

        if gettime() - self.LastRefreshTime > REFRESH_PERIOD:

   436

            self.LastRefreshTime = gettime()

   437

        self.AccessLock.release()

   438

   439

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

   440

#                               Viewer Rubberband

   441

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

   442

   443

"""

   444

Class that implements a rubberband

   445

"""

   446

   447

class RubberBand:

   448

   449

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

   450

    def __init__(self, viewer):

   451

        self.Viewer = viewer

   452

        self.drawingSurface = viewer.Editor

   453

        self.Reset()

   454

   455

    # Method that initializes the internal attributes of the rubberband

   456

    def Reset(self):

   457

        self.startPoint = None

   458

        self.currentBox = None

   459

        self.lastBox = None

   460

   461

    # Method that return if a box is currently edited

   462

    def IsShown(self):

   463

        return self.currentBox != None

   464

   465

    # Method that returns the currently edited box

   466

    def GetCurrentExtent(self):

   467

        if self.currentBox is None:

   468

            return self.lastBox

   469

        return self.currentBox

   470

   471

    # Method called when a new box starts to be edited

   472

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

   473

        pos = GetScaledEventPosition(event, dc, scaling)

   474

        # Save the point for calculate the box position and size

   475

        self.startPoint = pos

   476

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

   477

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

   478

        self.Redraw()

   479

   480

    # Method called when dragging with a box edited

   481

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

   482

        pos = GetScaledEventPosition(event, dc, scaling)

   483

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

   484

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

   485

            self.currentBox.height)

   486

        # Calculate new position and size of the box 

   487

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

   488

            self.currentBox.x = self.startPoint.x

   489

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

   490

        else:

   491

            self.currentBox.x = pos.x

   492

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

   493

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

   494

            self.currentBox.y = self.startPoint.y

   495

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

   496

        else:

   497

            self.currentBox.y = pos.y

   498

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

   499

        self.Redraw()

   500

   501

    # Method called when dragging is stopped

   502

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

   503

        self.drawingSurface.SetCursor(wx.NullCursor)

   504

        self.lastBox = self.currentBox

   505

        self.currentBox = None

   506

        self.Redraw()

   507

   508

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

   509

    def Redraw(self, dc = None):

   510

        if dc is None:

   511

            dc = self.Viewer.GetLogicalDC()

   512

        scalex, scaley = dc.GetUserScale()

   513

        dc.SetUserScale(1, 1)

   514

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

   515

        dc.SetBrush(wx.TRANSPARENT_BRUSH)

   516

        dc.SetLogicalFunction(wx.XOR)

   517

        if self.lastBox:

   518

            # Erase last box

   519

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

   520

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

   521

        if self.currentBox: