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 math import *

    28

from types import *

    29

from six.moves import xrange

    30

    31

import wx

    32

from graphics.ToolTipProducer import ToolTipProducer

    33

from graphics.DebugDataConsumer import DebugDataConsumer

    34

    35

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

    36

#                               Common constants

    37

#

    38

#            Definition of constants for dimensions of graphic elements

    39

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

    40

    41

# FBD and SFC constants

    42

MIN_MOVE = 5                            # Minimum move before starting a element dragging

    43

CONNECTOR_SIZE = 8                      # Size of connectors

    44

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

    45

HANDLE_SIZE = 6                         # Size of the squares for handles

    46

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

    47

POINT_RADIUS = 2                        # Radius of the point of wire ends

    48

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

    49

    50

# LD constants

    51

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

    52

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

    53

LD_WIRE_SIZE = 30                       # Size of a wire between two contact

    54

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

    55

LD_POWERRAIL_WIDTH = 3                  # Width of a Powerrail

    56

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

    57

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

    58

    59

# SFC constants

    60

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

    61

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

    62

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

    63

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

    64

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

    65

SFC_WIRE_MIN_SIZE = 25                  # Size of a wire between two elements

    66

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

    67

    68

# Type definition constants for graphic elements

    69

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

    70

[CONNECTOR, CONTINUATION] = range(2)

    71

[LEFTRAIL, RIGHTRAIL] = range(2)

    72

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

    73

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

    74

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

    75

    76

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

    77

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

    78

    79

# List of value for resize handle that are valid

    80

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

    81

    82

# Contants for defining the direction of a connector

    83

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

    84

    85

# Contants for defining which mode is selected for each view

    86

[MODE_SELECTION, MODE_BLOCK, MODE_VARIABLE, MODE_CONNECTION, MODE_COMMENT,

    87

 MODE_COIL, MODE_CONTACT, MODE_POWERRAIL, MODE_INITIALSTEP, MODE_STEP,

    88

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

    89

    90

# Contants for defining alignment types for graphic group

    91

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

    92

    93

# Contants for defining which drawing mode is selected for app

    94

[FREEDRAWING_MODE, DRIVENDRAWING_MODE] = [1, 2]

    95

    96

# Color for Highlighting

    97

HIGHLIGHTCOLOR = wx.CYAN

    98

    99

# Define highlight types

   100

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

   101

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

   102

   103

# Define highlight refresh inhibition period in second

   104

REFRESH_HIGHLIGHT_PERIOD = 0.1

   105

   106

HANDLE_CURSORS = {

   107

    (1, 1): 2,

   108

    (3, 3): 2,

   109

    (1, 3): 3,

   110

    (3, 1): 3,

   111

    (1, 2): 4,

   112

    (3, 2): 4,

   113

    (2, 1): 5,

   114

    (2, 3): 5

   115

}

   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

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

   130

# Basic vector operations for calculate wire points

   131

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

   132

   133

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

   134

    """

   135

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

   136

    """

   137

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

   138

    if normal:

   139

        return normalize(vector)

   140

    return vector

   141

   142

   143

def norm(v):

   144

    """

   145

    Calculate the norm of a given vector

   146

    """

   147

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

   148

   149

   150

def normalize(v):

   151

    """

   152

    Normalize a given vector

   153

    """

   154

    v_norm = norm(v)

   155

    # Verifie if it is not a null vector

   156

    if v_norm > 0:

   157

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

   158

    else:

   159

        return v

   160

   161

   162

def is_null_vector(v):

   163

    """

   164

    Calculate the scalar product of two vectors

   165

    """

   166

    return v == (0, 0)

   167

   168

   169

def add_vectors(v1, v2):

   170

    """

   171

    Calculate the scalar product of two vectors

   172

    """

   173

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

   174

   175

   176

def product(v1, v2):

   177

    """

   178

    Calculate the scalar product of two vectors

   179

    """

   180

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

   181

   182

   183

def GetScaledEventPosition(event, dc, scaling):

   184

    """

   185

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

   186

    """

   187

    pos = event.GetLogicalPosition(dc)

   188

    if scaling:

   189

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

   190

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

   191

    return pos

   192

   193

   194

def DirectionChoice(v_base, v_target, dir_target):

   195

    """

   196

    Function that choose a direction during the wire points generation

   197

    """

   198

    dir_product = product(v_base, v_target)

   199

    if dir_product < 0:

   200

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

   201

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

   202

        return dir_target

   203

    return v_base

   204

   205

   206

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

   207

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

   208

    pen.SetJoin(wx.JOIN_MITER)

   209

    pen.SetCap(wx.CAP_PROJECTING)

   210

    return pen

   211

   212

   213

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

   214

#                    Helpers for highlighting text

   215

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

   216

   217

   218

def AddHighlight(highlights, infos):

   219

    RemoveHighlight(highlights, infos)

   220

    highlights.append(infos)

   221

   222

   223

def RemoveHighlight(highlights, infos):

   224

    if infos in highlights:

   225

        highlights.remove(infos)

   226

        return True

   227

    return False

   228

   229

   230

def ClearHighlights(highlights, highlight_type=None):

   231

    if highlight_type is not None:

   232

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

   233

    return []

   234

   235

   236

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

   237

    current_pen = dc.GetPen()

   238

    dc.SetPen(wx.TRANSPARENT_PEN)

   239

    for start, end, highlight_type in highlights:

   240

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

   241

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

   242

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

   243

        part_width, part_height = dc.GetTextExtent(part)

   244

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

   245

        dc.SetTextForeground(highlight_type[1])

   246

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

   247

    dc.SetPen(current_pen)

   248

    dc.SetTextForeground(wx.BLACK)

   249

   250

   251

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

   252

#                           Graphic element base class

   253

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

   254

   255

   256

class Graphic_Element(ToolTipProducer):

   257

    """

   258

    Class that implements a generic graphic element

   259

    """

   260

   261

    # Create a new graphic element

   262

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

   263

        ToolTipProducer.__init__(self, parent)

   264

        self.Parent = parent

   265

        self.Id = id

   266

        self.oldPos = None

   267

        self.StartPos = None

   268

        self.CurrentDrag = None

   269

        self.Handle = (None, None)

   270

        self.Dragging = False

   271

        self.Selected = False

   272

        self.Highlighted = False

   273

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

   274

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

   275

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

   276

        self.Visible = False

   277

   278

    def GetDefinition(self):

   279

        return [self.Id], []

   280

   281

    def TestVisible(self, screen):

   282

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

   283

   284

    def IsVisible(self):

   285

        return self.Visible

   286

   287

    def SpreadCurrent(self):

   288

        pass

   289

   290

    def GetConnectorTranslation(self, element):

   291

        return {}

   292

   293

    def FindNearestConnector(self, position, connectors):

   294

        distances = []

   295

        for connector in connectors:

   296

            connector_pos = connector.GetRelPosition()

   297

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

   298

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

   299

                              connector))

   300

        distances.sort()

   301

        if len(distances) > 0:

   302

            return distances[0][1]

   303

        return None

   304

   305

    def IsOfType(self, type, reference):

   306

        return self.Parent.IsOfType(type, reference)

   307

   308

    def IsEndType(self, type):

   309

        return self.Parent.IsEndType(type)

   310

   311

    def GetDragging(self):

   312

        return self.Dragging

   313

   314

    # Make a clone of this element

   315

    def Clone(self, parent):

   316

        return Graphic_Element(parent, self.Id)

   317

   318

    # Changes the block position

   319

    def SetPosition(self, x, y):

   320

        self.Pos.x = x

   321

        self.Pos.y = y

   322

        self.RefreshConnected()

   323

        self.RefreshBoundingBox()

   324

   325

    # Returns the block position

   326

    def GetPosition(self):

   327

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

   328

   329

    # Changes the element size

   330

    def SetSize(self, width, height):

   331

        self.Size.SetWidth(width)

   332

        self.Size.SetHeight(height)

   333

        self.RefreshConnectors()

   334

        self.RefreshBoundingBox()

   335

   336

    # Returns the element size

   337

    def GetSize(self):

   338

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

   339

   340

    # Returns the minimum element size

   341

    def GetMinSize(self):

   342

        return 0, 0

   343

   344

    # Set size of the element to the minimum size

   345

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

   346

        width, height = self.GetSize()

   347

        posx, posy = self.GetPosition()

   348

        min_width, min_height = self.GetMinSize()

   349

        if width < min_width:

   350

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

   351

            width = min_width

   352

        if height < min_height:

   353

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

   354

            height = min_height

   355

        if scaling is not None:

   356

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

   357

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

   358

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

   359

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

   360

        self.SetSize(width, height)

   361

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

   362

   363

    # Refresh the element connectors position

   364

    def RefreshConnectors(self):

   365

        pass

   366

   367

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

   368

    def RefreshConnected(self, exclude=None):

   369

        pass

   370

   371

    # Change the parent

   372

    def SetParent(self, parent):

   373

        self.Parent = parent

   374

   375

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

   376

    def Delete(self):

   377

        pass

   378

   379

    # Returns the Id

   380

    def GetId(self):

   381

        return self.Id

   382

   383

    # Returns if the point given is in the bounding box

   384

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

   385

        if connectors:

   386

            rect = self.BoundingBox

   387

        else:

   388

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

   389

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

   390

   391

    # Returns if the point given is in the bounding box

   392

    def IsInSelection(self, rect):

   393

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

   394

   395

    # Override this method for refreshing the bounding box

   396

    def RefreshBoundingBox(self):

   397

        pass

   398

   399

    # Returns the bounding box

   400

    def GetBoundingBox(self):

   401

        return self.BoundingBox

   402

   403

    # Returns the RedrawRect

   404

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

   405

        scalex, scaley = self.Parent.GetViewScale()

   406

        rect = wx.Rect()

   407

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

   408

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

   409

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

   410

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

   411

        return rect

   412

   413

    def Refresh(self, rect=None):

   414

        if self.Visible:

   415

            if rect is not None:

   416

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

   417

            else:

   418

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

   419

   420

    # Change the variable that indicates if this element is selected

   421

    def SetSelected(self, selected):

   422

        self.Selected = selected

   423

        self.Refresh()

   424

   425

    # Change the variable that indicates if this element is highlighted

   426

    def SetHighlighted(self, highlighted):

   427

        self.Highlighted = highlighted

   428

        self.Refresh()

   429

   430

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

   431

    def TestHandle(self, event):

   432

        dc = self.Parent.GetLogicalDC()

   433

        scalex, scaley = dc.GetUserScale()

   434

        pos = event.GetPosition()

   435

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

   436

   437

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

   438

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

   439

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

   440

   441

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

   442

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

   443

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

   444

   445

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

   446

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

   447

   448

        # Verify that this element is selected

   449

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

   450

            # Find if point is on a handle horizontally

   451

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

   452

                handle_x = 1

   453

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

   454

                handle_x = 2

   455

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

   456

                handle_x = 3

   457

            else:

   458

                handle_x = 0

   459

            # Find if point is on a handle vertically

   460

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

   461

                handle_y = 1

   462

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

   463

                handle_y = 2

   464

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

   465

                handle_y = 3

   466

            else:

   467

                handle_y = 0

   468

            # Verify that the result is valid

   469

            if (handle_x, handle_y) in VALID_HANDLES:

   470

                return handle_x, handle_y

   471

        return 0, 0

   472

   473

    # Method called when a LeftDown event have been generated

   474

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

   475

        # Test if an handle have been clicked

   476

        handle = self.TestHandle(event)

   477

        # Find which type of handle have been clicked,

   478

        # Save a resize event and change the cursor

   479

        cursor = HANDLE_CURSORS.get(handle, 1)

   480

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

   481

        if cursor > 1:

   482

            self.Handle = (HANDLE_RESIZE, handle)

   483

        else:

   484

            self.Handle = (HANDLE_MOVE, None)

   485

            self.SetSelected(False)

   486

        # Initializes the last position

   487

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

   488

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

   489

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

   490

   491

    # Method called when a LeftUp event have been generated

   492

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

   493

        # If a dragging have been initiated

   494

        if self.Dragging and self.oldPos:

   495

            self.RefreshModel()

   496

            self.Parent.RefreshBuffer()

   497

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

   498

        self.SetSelected(True)

   499

        self.oldPos = None

   500

   501

    # Method called when a RightDown event have been generated

   502

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

   503

        pass

   504

   505

    # Method called when a RightUp event have been generated

   506

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