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 future.builtins import round

    30

from six import string_types

    31

from six.moves import xrange

    32

    33

import wx

    34

from graphics.ToolTipProducer import ToolTipProducer

    35

from graphics.DebugDataConsumer import DebugDataConsumer

    36

    37

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

    38

#                               Common constants

    39

#

    40

#            Definition of constants for dimensions of graphic elements

    41

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

    42

    43

# FBD and SFC constants

    44

MIN_MOVE = 5                            # Minimum move before starting a element dragging

    45

CONNECTOR_SIZE = 8                      # Size of connectors

    46

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

    47

HANDLE_SIZE = 6                         # Size of the squares for handles

    48

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

    49

POINT_RADIUS = 2                        # Radius of the point of wire ends

    50

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

    51

    52

# LD constants

    53

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

    54

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

    55

LD_WIRE_SIZE = 30                       # Size of a wire between two contact

    56

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

    57

LD_POWERRAIL_WIDTH = 3                  # Width of a Powerrail

    58

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

    59

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

    60

    61

# SFC constants

    62

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

    63

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

    64

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

    65

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

    66

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

    67

SFC_WIRE_MIN_SIZE = 25                  # Size of a wire between two elements

    68

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

    69

    70

# Type definition constants for graphic elements

    71

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

    72

[CONNECTOR, CONTINUATION] = range(2)

    73

[LEFTRAIL, RIGHTRAIL] = range(2)

    74

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

    75

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

    76

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

    77

    78

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

    79

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

    80

    81

# List of value for resize handle that are valid

    82

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

    83

    84

# Contants for defining the direction of a connector

    85

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

    86

    87

# Contants for defining which mode is selected for each view

    88

[MODE_SELECTION, MODE_BLOCK, MODE_VARIABLE, MODE_CONNECTION, MODE_COMMENT,

    89

 MODE_COIL, MODE_CONTACT, MODE_POWERRAIL, MODE_INITIALSTEP, MODE_STEP,

    90

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

    91

    92

# Contants for defining alignment types for graphic group

    93

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

    94

    95

# Contants for defining which drawing mode is selected for app

    96

[FREEDRAWING_MODE, DRIVENDRAWING_MODE] = [1, 2]

    97

    98

# Color for Highlighting

    99

HIGHLIGHTCOLOR = wx.CYAN

   100

   101

# Define highlight types

   102

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

   103

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

   104

   105

# Define highlight refresh inhibition period in second

   106

REFRESH_HIGHLIGHT_PERIOD = 0.1

   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

   120

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

   121

    fraction = x / n

   122

    if constraint == -1:

   123

        xround = int(fraction)

   124

    else:

   125

        xround = round(fraction)

   126

        if constraint == 1 and xround < fraction:

   127

            xround += 1

   128

    return int(xround * n)

   129

   130

   131

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

   132

# Basic vector operations for calculate wire points

   133

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

   134

   135

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

   136

    """

   137

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

   138

    """

   139

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

   140

    if normal:

   141

        return normalize(vector)

   142

    return vector

   143

   144

   145

def norm(v):

   146

    """

   147

    Calculate the norm of a given vector

   148

    """

   149

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

   150

   151

   152

def normalize(v):

   153

    """

   154

    Normalize a given vector

   155

    """

   156

    v_norm = norm(v)

   157

    # Verifie if it is not a null vector

   158

    if v_norm > 0:

   159

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

   160

    else:

   161

        return v

   162

   163

   164

def is_null_vector(v):

   165

    """

   166

    Calculate the scalar product of two vectors

   167

    """

   168

    return v == (0, 0)

   169

   170

   171

def add_vectors(v1, v2):

   172

    """

   173

    Calculate the scalar product of two vectors

   174

    """

   175

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

   176

   177

   178

def product(v1, v2):

   179

    """

   180

    Calculate the scalar product of two vectors

   181

    """

   182

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

   183

   184

   185

def GetScaledEventPosition(event, dc, scaling):

   186

    """

   187

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

   188

    """

   189

    pos = event.GetLogicalPosition(dc)

   190

    if scaling:

   191

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

   192

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

   193

    return pos

   194

   195

   196

def DirectionChoice(v_base, v_target, dir_target):

   197

    """

   198

    Function that choose a direction during the wire points generation

   199

    """

   200

    dir_product = product(v_base, v_target)

   201

    if dir_product < 0:

   202

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

   203

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

   204

        return dir_target

   205

    return v_base

   206

   207

   208

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

   209

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

   210

    pen.SetJoin(wx.JOIN_MITER)

   211

    pen.SetCap(wx.CAP_PROJECTING)

   212

    return pen

   213

   214

   215

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

   216

#                    Helpers for highlighting text

   217

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

   218

   219

   220

def AddHighlight(highlights, infos):

   221

    RemoveHighlight(highlights, infos)

   222

    highlights.append(infos)

   223

   224

   225

def RemoveHighlight(highlights, infos):

   226

    if infos in highlights:

   227

        highlights.remove(infos)

   228

        return True

   229

    return False

   230

   231

   232

def ClearHighlights(highlights, highlight_type=None):

   233

    if highlight_type is not None:

   234

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

   235

    return []

   236

   237

   238

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

   239

    current_pen = dc.GetPen()

   240

    dc.SetPen(wx.TRANSPARENT_PEN)

   241

    for start, end, highlight_type in highlights:

   242

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

   243

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

   244

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

   245

        part_width, part_height = dc.GetTextExtent(part)

   246

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

   247

        dc.SetTextForeground(highlight_type[1])

   248

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

   249

    dc.SetPen(current_pen)

   250

    dc.SetTextForeground(wx.BLACK)

   251

   252

   253

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

   254

#                           Graphic element base class

   255

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

   256

   257

   258

class Graphic_Element(ToolTipProducer):

   259

    """

   260

    Class that implements a generic graphic element

   261

    """

   262

   263

    # Create a new graphic element

   264

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

   265

        ToolTipProducer.__init__(self, parent)

   266

        self.Parent = parent

   267

        self.Id = id

   268

        self.oldPos = None

   269

        self.StartPos = None

   270

        self.CurrentDrag = None

   271

        self.Handle = (None, None)

   272

        self.Dragging = False

   273

        self.Selected = False

   274

        self.Highlighted = False

   275

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

   276

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

   277

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

   278

        self.Visible = False

   279

   280

    def GetDefinition(self):

   281

        return [self.Id], []

   282

   283

    def TestVisible(self, screen):

   284

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

   285

   286

    def IsVisible(self):

   287

        return self.Visible

   288

   289

    def SpreadCurrent(self):

   290

        pass

   291

   292

    def GetConnectorTranslation(self, element):

   293

        return {}

   294

   295

    def FindNearestConnector(self, position, connectors):

   296

        distances = []

   297

        for connector in connectors:

   298

            connector_pos = connector.GetRelPosition()

   299

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

   300

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

   301

                              connector))

   302

        distances.sort()

   303

        if len(distances) > 0:

   304

            return distances[0][1]

   305

        return None

   306

   307

    def IsOfType(self, type, reference):

   308

        return self.Parent.IsOfType(type, reference)

   309

   310

    def IsEndType(self, type):

   311

        return self.Parent.IsEndType(type)

   312

   313

    def GetDragging(self):

   314

        return self.Dragging

   315

   316

    # Make a clone of this element

   317

    def Clone(self, parent):

   318

        return Graphic_Element(parent, self.Id)

   319

   320

    # Changes the block position

   321

    def SetPosition(self, x, y):

   322

        self.Pos.x = x

   323

        self.Pos.y = y

   324

        self.RefreshConnected()

   325

        self.RefreshBoundingBox()

   326

   327

    # Returns the block position

   328

    def GetPosition(self):

   329

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

   330

   331

    # Changes the element size

   332

    def SetSize(self, width, height):

   333

        self.Size.SetWidth(width)

   334

        self.Size.SetHeight(height)

   335

        self.RefreshConnectors()

   336

        self.RefreshBoundingBox()

   337

   338

    # Returns the element size

   339

    def GetSize(self):

   340

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

   341

   342

    # Returns the minimum element size

   343

    def GetMinSize(self):

   344

        return 0, 0

   345

   346

    # Set size of the element to the minimum size

   347

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

   348

        width, height = self.GetSize()

   349

        posx, posy = self.GetPosition()

   350

        min_width, min_height = self.GetMinSize()

   351

        if width < min_width:

   352

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

   353

            width = min_width

   354

        if height < min_height:

   355

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

   356

            height = min_height

   357

        if scaling is not None:

   358

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

   359

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

   360

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

   361

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

   362

        self.SetSize(width, height)

   363

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

   364

   365

    # Refresh the element connectors position

   366

    def RefreshConnectors(self):

   367

        pass

   368

   369

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

   370

    def RefreshConnected(self, exclude=None):

   371

        pass

   372

   373

    # Change the parent

   374

    def SetParent(self, parent):

   375

        self.Parent = parent

   376

   377

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

   378

    def Delete(self):

   379

        pass

   380

   381

    # Returns the Id

   382

    def GetId(self):

   383

        return self.Id

   384

   385

    # Returns if the point given is in the bounding box

   386

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

   387

        if connectors:

   388

            rect = self.BoundingBox

   389

        else:

   390

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

   391

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

   392

   393

    # Returns if the point given is in the bounding box

   394

    def IsInSelection(self, rect):

   395

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

   396

   397

    # Override this method for refreshing the bounding box

   398

    def RefreshBoundingBox(self):

   399

        pass

   400

   401

    # Returns the bounding box

   402

    def GetBoundingBox(self):

   403

        return self.BoundingBox

   404

   405

    # Returns the RedrawRect

   406

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

   407

        scalex, scaley = self.Parent.GetViewScale()

   408

        rect = wx.Rect()

   409

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

   410

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

   411

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

   412

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

   413

        return rect

   414

   415

    def Refresh(self, rect=None):

   416

        if self.Visible:

   417

            if rect is not None:

   418

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

   419

            else:

   420

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

   421

   422

    # Change the variable that indicates if this element is selected

   423

    def SetSelected(self, selected):

   424

        self.Selected = selected

   425

        self.Refresh()

   426

   427

    # Change the variable that indicates if this element is highlighted

   428

    def SetHighlighted(self, highlighted):

   429

        self.Highlighted = highlighted

   430

        self.Refresh()

   431

   432

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

   433

    def TestHandle(self, event):

   434

        dc = self.Parent.GetLogicalDC()

   435

        scalex, scaley = dc.GetUserScale()

   436

        pos = event.GetPosition()

   437

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

   438

   439

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

   440

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

   441

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

   442

   443

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

   444

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

   445

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

   446

   447

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

   448

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

   449

   450

        # Verify that this element is selected

   451

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

   452

            # Find if point is on a handle horizontally

   453

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

   454

                handle_x = 1

   455

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

   456

                handle_x = 2

   457

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

   458

                handle_x = 3

   459

            else:

   460

                handle_x = 0

   461

            # Find if point is on a handle vertically

   462

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

   463

                handle_y = 1

   464

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

   465

                handle_y = 2

   466

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

   467

                handle_y = 3

   468

            else:

   469

                handle_y = 0

   470

            # Verify that the result is valid

   471

            if (handle_x, handle_y) in VALID_HANDLES:

   472

                return handle_x, handle_y

   473

        return 0, 0

   474

   475

    # Method called when a LeftDown event have been generated

   476

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

   477

        # Test if an handle have been clicked

   478

        handle = self.TestHandle(event)

   479

        # Find which type of handle have been clicked,

   480

        # Save a resize event and change the cursor

   481

        cursor = HANDLE_CURSORS.get(handle, 1)

   482

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

   483

        if cursor > 1:

   484

            self.Handle = (HANDLE_RESIZE, handle)

   485

        else:

   486

            self.Handle = (HANDLE_MOVE, None)

   487

            self.SetSelected(False)

   488

        # Initializes the last position

   489

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

   490

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

   491

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

   492

   493

    # Method called when a LeftUp event have been generated

   494

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

   495

        # If a dragging have been initiated

   496

        if self.Dragging and self.oldPos:

   497

            self.RefreshModel()

   498

            self.Parent.RefreshBuffer()

   499

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

   500

        self.SetSelected(True)

   501

        self.oldPos = None

   502

   503

    # Method called when a RightDown event have been generated

   504

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

   505

        pass

   506