1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

    26

from __future__ import absolute_import

    27

from __future__ import division

    28

from math import *

    29

from types import *

    30

from six.moves import xrange

    31

    32

import wx

    33

from graphics.ToolTipProducer import ToolTipProducer

    34

from graphics.DebugDataConsumer import DebugDataConsumer

    35

    36

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

    37

#                               Common constants

    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

   119

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

   120

    fraction = x / n

   121

    if constraint == -1:

   122

        xround = int(fraction)

   123

    else:

   124

        xround = round(fraction)

   125

        if constraint == 1 and xround < fraction:

   126

            xround += 1

   127

    return int(xround * n)

   128

   129

   130

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

   131

# Basic vector operations for calculate wire points

   132

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

   133

   134

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

   135

    """

   136

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

   137

    """

   138

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

   139

    if normal:

   140

        return normalize(vector)

   141

    return vector

   142

   143

   144

def norm(v):

   145

    """

   146

    Calculate the norm of a given vector

   147

    """

   148

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

   149

   150

   151

def normalize(v):

   152

    """

   153

    Normalize a given vector

   154

    """

   155

    v_norm = norm(v)

   156

    # Verifie if it is not a null vector

   157

    if v_norm > 0:

   158

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

   159

    else:

   160

        return v

   161

   162

   163

def is_null_vector(v):

   164

    """

   165

    Calculate the scalar product of two vectors

   166

    """

   167

    return v == (0, 0)

   168

   169

   170

def add_vectors(v1, v2):

   171

    """

   172

    Calculate the scalar product of two vectors

   173

    """

   174

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

   175

   176

   177

def product(v1, v2):

   178

    """

   179

    Calculate the scalar product of two vectors

   180

    """

   181

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

   182

   183

   184

def GetScaledEventPosition(event, dc, scaling):

   185

    """

   186

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

   187

    """

   188

    pos = event.GetLogicalPosition(dc)

   189

    if scaling:

   190

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

   191

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

   192

    return pos

   193

   194

   195

def DirectionChoice(v_base, v_target, dir_target):

   196

    """

   197

    Function that choose a direction during the wire points generation

   198

    """

   199

    dir_product = product(v_base, v_target)

   200

    if dir_product < 0:

   201

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

   202

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

   203

        return dir_target

   204

    return v_base

   205

   206

   207

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

   208

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

   209

    pen.SetJoin(wx.JOIN_MITER)

   210

    pen.SetCap(wx.CAP_PROJECTING)

   211

    return pen

   212

   213

   214

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

   215

#                    Helpers for highlighting text

   216

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

   217

   218

   219

def AddHighlight(highlights, infos):

   220

    RemoveHighlight(highlights, infos)

   221

    highlights.append(infos)

   222

   223

   224

def RemoveHighlight(highlights, infos):

   225

    if infos in highlights:

   226

        highlights.remove(infos)

   227

        return True

   228

    return False

   229

   230

   231

def ClearHighlights(highlights, highlight_type=None):

   232

    if highlight_type is not None:

   233

        return [highlight for highlight in highlights if highlight[2] != highlight_type]

   234

    return []

   235

   236

   237

def DrawHighlightedText(dc, text, highlights, x, y):

   238

    current_pen = dc.GetPen()

   239

    dc.SetPen(wx.TRANSPARENT_PEN)

   240

    for start, end, highlight_type in highlights:

   241

        dc.SetBrush(wx.Brush(highlight_type[0]))

   242

        offset_width, _offset_height = dc.GetTextExtent(text[:start[1]])

   243

        part = text[start[1]:end[1] + 1]

   244

        part_width, part_height = dc.GetTextExtent(part)

   245

        dc.DrawRectangle(x + offset_width, y, part_width, part_height)

   246

        dc.SetTextForeground(highlight_type[1])

   247

        dc.DrawText(part, x + offset_width, y)

   248

    dc.SetPen(current_pen)

   249

    dc.SetTextForeground(wx.BLACK)

   250

   251

   252

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

   253

#                           Graphic element base class

   254

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

   255

   256

   257

class Graphic_Element(ToolTipProducer):

   258

    """

   259

    Class that implements a generic graphic element

   260

    """

   261

   262

    # Create a new graphic element

   263

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

   264

        ToolTipProducer.__init__(self, parent)

   265

        self.Parent = parent

   266

        self.Id = id

   267

        self.oldPos = None

   268

        self.StartPos = None

   269

        self.CurrentDrag = None

   270

        self.Handle = (None, None)

   271

        self.Dragging = False

   272

        self.Selected = False

   273

        self.Highlighted = False

   274

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

   275

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

   276

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

   277

        self.Visible = False

   278

   279

    def GetDefinition(self):

   280

        return [self.Id], []

   281

   282

    def TestVisible(self, screen):

   283

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

   284

   285

    def IsVisible(self):

   286

        return self.Visible

   287

   288

    def SpreadCurrent(self):

   289

        pass

   290

   291

    def GetConnectorTranslation(self, element):

   292

        return {}

   293

   294

    def FindNearestConnector(self, position, connectors):

   295

        distances = []

   296

        for connector in connectors:

   297

            connector_pos = connector.GetRelPosition()

   298

            distances.append((sqrt((self.Pos.x + connector_pos.x - position.x) ** 2 +

   299

                                   (self.Pos.y + connector_pos.y - position.y) ** 2),

   300

                              connector))

   301

        distances.sort()

   302

        if len(distances) > 0:

   303

            return distances[0][1]

   304

        return None

   305

   306

    def IsOfType(self, type, reference):

   307

        return self.Parent.IsOfType(type, reference)

   308

   309

    def IsEndType(self, type):

   310

        return self.Parent.IsEndType(type)

   311

   312

    def GetDragging(self):

   313

        return self.Dragging

   314

   315

    # Make a clone of this element

   316

    def Clone(self, parent):

   317

        return Graphic_Element(parent, self.Id)

   318

   319

    # Changes the block position

   320

    def SetPosition(self, x, y):

   321

        self.Pos.x = x

   322

        self.Pos.y = y

   323

        self.RefreshConnected()

   324

        self.RefreshBoundingBox()

   325

   326

    # Returns the block position

   327

    def GetPosition(self):

   328

        return self.Pos.x, self.Pos.y

   329

   330

    # Changes the element size

   331

    def SetSize(self, width, height):

   332

        self.Size.SetWidth(width)

   333

        self.Size.SetHeight(height)

   334

        self.RefreshConnectors()

   335

        self.RefreshBoundingBox()

   336

   337

    # Returns the element size

   338

    def GetSize(self):

   339

        return self.Size.GetWidth(), self.Size.GetHeight()

   340

   341

    # Returns the minimum element size

   342

    def GetMinSize(self):

   343

        return 0, 0

   344

   345

    # Set size of the element to the minimum size

   346

    def SetBestSize(self, scaling, x_factor=0.5, y_factor=0.5):

   347

        width, height = self.GetSize()

   348

        posx, posy = self.GetPosition()

   349

        min_width, min_height = self.GetMinSize()

   350

        if width < min_width:

   351

            self.Pos.x = max(0, self.Pos.x - (width - min_width) * x_factor)

   352

            width = min_width

   353

        if height < min_height:

   354

            self.Pos.y = max(0, self.Pos.y - (height - min_height) * y_factor)

   355

            height = min_height

   356

        if scaling is not None:

   357

            self.Pos.x = round_scaling(self.Pos.x, scaling[0])

   358

            self.Pos.y = round_scaling(self.Pos.y, scaling[1])

   359

            width = round_scaling(width, scaling[0], 1)

   360

            height = round_scaling(height, scaling[1], 1)

   361

        self.SetSize(width, height)

   362

        return self.Pos.x - posx, self.Pos.y - posy

   363

   364

    # Refresh the element connectors position

   365

    def RefreshConnectors(self):

   366

        pass

   367

   368

    # Refresh the position of wires connected to element inputs and outputs

   369

    def RefreshConnected(self, exclude=None):

   370

        pass

   371

   372

    # Change the parent

   373

    def SetParent(self, parent):

   374

        self.Parent = parent

   375

   376

    # Override this method for defining the method to call for deleting this element

   377

    def Delete(self):

   378

        pass

   379

   380

    # Returns the Id

   381

    def GetId(self):

   382

        return self.Id

   383

   384

    # Returns if the point given is in the bounding box

   385

    def HitTest(self, pt, connectors=True):

   386

        if connectors:

   387

            rect = self.BoundingBox

   388

        else:

   389

            rect = wx.Rect(self.Pos.x, self.Pos.y, self.Size[0], self.Size[1])

   390

        return rect.InsideXY(pt.x, pt.y)

   391

   392

    # Returns if the point given is in the bounding box

   393

    def IsInSelection(self, rect):

   394

        return rect.InsideXY(self.BoundingBox.x, self.BoundingBox.y) and rect.InsideXY(self.BoundingBox.x + self.BoundingBox.width, self.BoundingBox.y + self.BoundingBox.height)

   395

   396

    # Override this method for refreshing the bounding box

   397

    def RefreshBoundingBox(self):

   398

        pass

   399

   400

    # Returns the bounding box

   401

    def GetBoundingBox(self):

   402

        return self.BoundingBox

   403

   404

    # Returns the RedrawRect

   405

    def GetRedrawRect(self, movex=0, movey=0):

   406

        scalex, scaley = self.Parent.GetViewScale()

   407

        rect = wx.Rect()

   408

        rect.x = self.BoundingBox.x - int(HANDLE_SIZE / scalex) - 3 - abs(movex)

   409

        rect.y = self.BoundingBox.y - int(HANDLE_SIZE / scaley) - 3 - abs(movey)

   410

        rect.width = self.BoundingBox.width + 2 * (int(HANDLE_SIZE / scalex) + abs(movex) + 1) + 4

   411

        rect.height = self.BoundingBox.height + 2 * (int(HANDLE_SIZE / scaley) + abs(movey) + 1) + 4

   412

        return rect

   413

   414

    def Refresh(self, rect=None):

   415

        if self.Visible:

   416

            if rect is not None:

   417

                self.Parent.RefreshRect(self.Parent.GetScrolledRect(rect), False)

   418

            else:

   419

                self.Parent.RefreshRect(self.Parent.GetScrolledRect(self.GetRedrawRect()), False)

   420

   421

    # Change the variable that indicates if this element is selected

   422

    def SetSelected(self, selected):

   423

        self.Selected = selected

   424

        self.Refresh()

   425

   426

    # Change the variable that indicates if this element is highlighted

   427

    def SetHighlighted(self, highlighted):

   428

        self.Highlighted = highlighted

   429

        self.Refresh()

   430

   431

    # Test if the point is on a handle of this element

   432

    def TestHandle(self, event):

   433

        dc = self.Parent.GetLogicalDC()

   434

        scalex, scaley = dc.GetUserScale()

   435

        pos = event.GetPosition()

   436

        pt = wx.Point(*self.Parent.CalcUnscrolledPosition(pos.x, pos.y))

   437

   438

        left = (self.BoundingBox.x - 2) * scalex - HANDLE_SIZE

   439

        center = (self.BoundingBox.x + self.BoundingBox.width // 2) * scalex - HANDLE_SIZE // 2

   440

        right = (self.BoundingBox.x + self.BoundingBox.width + 2) * scalex

   441

   442

        top = (self.BoundingBox.y - 2) * scaley - HANDLE_SIZE

   443

        middle = (self.BoundingBox.y + self.BoundingBox.height / 2) * scaley - HANDLE_SIZE // 2

   444

        bottom = (self.BoundingBox.y + self.BoundingBox.height + 2) * scaley

   445

   446

        extern_rect = wx.Rect(left, top, right + HANDLE_SIZE - left, bottom + HANDLE_SIZE - top)

   447

        intern_rect = wx.Rect(left + HANDLE_SIZE, top + HANDLE_SIZE, right - left - HANDLE_SIZE, bottom - top - HANDLE_SIZE)

   448

   449

        # Verify that this element is selected

   450

        if self.Selected and extern_rect.InsideXY(pt.x, pt.y) and not intern_rect.InsideXY(pt.x, pt.y):

   451

            # Find if point is on a handle horizontally

   452

            if left <= pt.x < left + HANDLE_SIZE:

   453

                handle_x = 1

   454

            elif center <= pt.x < center + HANDLE_SIZE:

   455

                handle_x = 2

   456

            elif right <= pt.x < right + HANDLE_SIZE:

   457

                handle_x = 3

   458

            else:

   459

                handle_x = 0

   460

            # Find if point is on a handle vertically

   461

            if top <= pt.y < top + HANDLE_SIZE:

   462

                handle_y = 1

   463

            elif middle <= pt.y < middle + HANDLE_SIZE:

   464

                handle_y = 2

   465

            elif bottom <= pt.y < bottom + HANDLE_SIZE:

   466

                handle_y = 3

   467

            else:

   468

                handle_y = 0

   469

            # Verify that the result is valid

   470

            if (handle_x, handle_y) in VALID_HANDLES:

   471

                return handle_x, handle_y

   472

        return 0, 0

   473

   474

    # Method called when a LeftDown event have been generated

   475

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

   476

        # Test if an handle have been clicked

   477

        handle = self.TestHandle(event)

   478

        # Find which type of handle have been clicked,

   479

        # Save a resize event and change the cursor

   480

        cursor = HANDLE_CURSORS.get(handle, 1)

   481

        wx.CallAfter(self.Parent.SetCurrentCursor, cursor)

   482

        if cursor > 1:

   483

            self.Handle = (HANDLE_RESIZE, handle)

   484

        else:

   485

            self.Handle = (HANDLE_MOVE, None)

   486

            self.SetSelected(False)

   487

        # Initializes the last position

   488

        self.oldPos = GetScaledEventPosition(event, dc, scaling)

   489

        self.StartPos = wx.Point(self.Pos.x, self.Pos.y)

   490

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

   491

   492

    # Method called when a LeftUp event have been generated

   493

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

   494

        # If a dragging have been initiated

   495

        if self.Dragging and self.oldPos:

   496

            self.RefreshModel()

   497

            self.Parent.RefreshBuffer()

   498

        wx.CallAfter(self.Parent.SetCurrentCursor, 0)

   499

        self.SetSelected(True)

   500

        self.oldPos = None

   501

   502

    # Method called when a RightDown event have been generated

   503

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

   504

        pass

   505

   506

    # Method called when a RightUp event have been generated