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

    27

    28

import wx

    29

from graphics.ToolTipProducer import ToolTipProducer

    30

from graphics.DebugDataConsumer import DebugDataConsumer

    31

    32

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

    33

#                               Common constants

    34

#

    35

#            Definition of constants for dimensions of graphic elements

    36

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

    37

    38

# FBD and SFC constants

    39

MIN_MOVE = 5                            # Minimum move before starting a element dragging

    40

CONNECTOR_SIZE = 8                      # Size of connectors

    41

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

    42

HANDLE_SIZE = 6                         # Size of the squares for handles

    43

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

    44

POINT_RADIUS = 2                        # Radius of the point of wire ends

    45

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

    46

    47

# LD constants

    48

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

    49

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

    50

LD_WIRE_SIZE = 30                       # Size of a wire between two contact

    51

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

    52

LD_POWERRAIL_WIDTH = 3                  # Width of a Powerrail

    53

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

    54

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

    55

    56

# SFC constants

    57

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

    58

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

    59

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

    60

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

    61

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

    62

SFC_WIRE_MIN_SIZE = 25                  # Size of a wire between two elements

    63

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

    64

    65

# Type definition constants for graphic elements

    66

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

    67

[CONNECTOR, CONTINUATION] = list(range(2))

    68

[LEFTRAIL, RIGHTRAIL] = list(range(2))

    69

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

    70

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

    71

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

    72

    73

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

    74

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

    75

    76

# List of value for resize handle that are valid

    77

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

    78

    79

# Contants for defining the direction of a connector

    80

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

    81

    82

# Contants for defining which mode is selected for each view

    83

[MODE_SELECTION, MODE_BLOCK, MODE_VARIABLE, MODE_CONNECTION, MODE_COMMENT,

    84

 MODE_COIL, MODE_CONTACT, MODE_POWERRAIL, MODE_INITIALSTEP, MODE_STEP,

    85

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

    86

    87

# Contants for defining alignment types for graphic group

    88

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

    89

    90

# Contants for defining which drawing mode is selected for app

    91

[FREEDRAWING_MODE, DRIVENDRAWING_MODE] = [1, 2]

    92

    93

# Color for Highlighting

    94

HIGHLIGHTCOLOR = wx.CYAN

    95

    96

# Define highlight types

    97

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

    98

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

    99

   100

# Define highlight refresh inhibition period in second

   101

REFRESH_HIGHLIGHT_PERIOD = 0.1

   102

   103

HANDLE_CURSORS = {

   104

    (1, 1): 2,

   105

    (3, 3): 2,

   106

    (1, 3): 3,

   107

    (3, 1): 3,

   108

    (1, 2): 4,

   109

    (3, 2): 4,

   110

    (2, 1): 5,

   111

    (2, 3): 5

   112

}

   113

   114

   115

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

   116

    fraction = x / n

   117

    if constraint == -1:

   118

        xround = int(fraction)

   119

    else:

   120

        xround = round(fraction)

   121

        if constraint == 1 and xround < fraction:

   122

            xround += 1

   123

    return int(xround * n)

   124

   125

   126

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

   127

# Basic vector operations for calculate wire points

   128

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

   129

   130

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

   131

    """

   132

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

   133

    """

   134

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

   135

    if normal:

   136

        return normalize(vector)

   137

    return vector

   138

   139

   140

def norm(v):

   141

    """

   142

    Calculate the norm of a given vector

   143

    """

   144

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

   145

   146

   147

def normalize(v):

   148

    """

   149

    Normalize a given vector

   150

    """

   151

    v_norm = norm(v)

   152

    # Verifie if it is not a null vector

   153

    if v_norm > 0:

   154

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

   155

    else:

   156

        return v

   157

   158

   159

def is_null_vector(v):

   160

    """

   161

    Calculate the scalar product of two vectors

   162

    """

   163

    return v == (0, 0)

   164

   165

   166

def add_vectors(v1, v2):

   167

    """

   168

    Calculate the scalar product of two vectors

   169

    """

   170

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

   171

   172

   173

def product(v1, v2):

   174

    """

   175

    Calculate the scalar product of two vectors

   176

    """

   177

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

   178

   179

   180

def GetScaledEventPosition(event, dc, scaling):

   181

    """

   182

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

   183

    """

   184

    pos = event.GetLogicalPosition(dc)

   185

    if scaling:

   186

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

   187

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

   188

    return pos

   189

   190

   191

def DirectionChoice(v_base, v_target, dir_target):

   192

    """

   193

    Function that choose a direction during the wire points generation

   194

    """

   195

    dir_product = product(v_base, v_target)

   196

    if dir_product < 0:

   197

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

   198

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

   199

        return dir_target

   200

    return v_base

   201

   202

   203

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

   204

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

   205

    pen.SetJoin(wx.JOIN_MITER)

   206

    pen.SetCap(wx.CAP_PROJECTING)

   207

    return pen

   208

   209

   210

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

   211

#                    Helpers for highlighting text

   212

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

   213

   214

   215

def AddHighlight(highlights, infos):

   216

    RemoveHighlight(highlights, infos)

   217

    highlights.append(infos)

   218

   219

   220

def RemoveHighlight(highlights, infos):

   221

    if infos in highlights:

   222

        highlights.remove(infos)

   223

        return True

   224

    return False

   225

   226

   227

def ClearHighlights(highlights, highlight_type=None):

   228

    if highlight_type is not None:

   229

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

   230

    return []

   231

   232

   233

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

   234

    current_pen = dc.GetPen()

   235

    dc.SetPen(wx.TRANSPARENT_PEN)

   236

    for start, end, highlight_type in highlights:

   237

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

   238

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

   239

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

   240

        part_width, part_height = dc.GetTextExtent(part)

   241

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

   242

        dc.SetTextForeground(highlight_type[1])

   243

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

   244

    dc.SetPen(current_pen)

   245

    dc.SetTextForeground(wx.BLACK)

   246

   247

   248

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

   249

#                           Graphic element base class

   250

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

   251

   252

   253

class Graphic_Element(ToolTipProducer):

   254

    """

   255

    Class that implements a generic graphic element

   256

    """

   257

   258

    # Create a new graphic element

   259

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

   260

        ToolTipProducer.__init__(self, parent)

   261

        self.Parent = parent

   262

        self.Id = id

   263

        self.oldPos = None

   264

        self.StartPos = None

   265

        self.CurrentDrag = None

   266

        self.Handle = (None, None)

   267

        self.Dragging = False

   268

        self.Selected = False

   269

        self.Highlighted = False

   270

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

   271

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

   272

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

   273

        self.Visible = False

   274

   275

    def GetDefinition(self):

   276

        return [self.Id], []

   277

   278

    def TestVisible(self, screen):

   279

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

   280

   281

    def IsVisible(self):

   282

        return self.Visible

   283

   284

    def SpreadCurrent(self):

   285

        pass

   286

   287

    def GetConnectorTranslation(self, element):

   288

        return {}

   289

   290

    def FindNearestConnector(self, position, connectors):

   291

        distances = []

   292

        for connector in connectors:

   293

            connector_pos = connector.GetRelPosition()

   294

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

   295

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

   296

                              connector))

   297

        distances.sort(key=lambda n: n[0])

   298

        if len(distances) > 0:

   299

            return distances[0][1]

   300

        return None

   301

   302

    def IsOfType(self, type, reference):

   303

        return self.Parent.IsOfType(type, reference)

   304

   305

    def IsEndType(self, type):

   306

        return self.Parent.IsEndType(type)

   307

   308

    def GetDragging(self):

   309

        return self.Dragging

   310

   311

    # Make a clone of this element

   312

    def Clone(self, parent):

   313

        return Graphic_Element(parent, self.Id)

   314

   315

    # Changes the block position

   316

    def SetPosition(self, x, y):

   317

        self.Pos.x = x

   318

        self.Pos.y = y

   319

        self.RefreshConnected()

   320

        self.RefreshBoundingBox()

   321

   322

    # Returns the block position

   323

    def GetPosition(self):

   324

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

   325

   326

    # Changes the element size

   327

    def SetSize(self, width, height):

   328

        self.Size.SetWidth(width)

   329

        self.Size.SetHeight(height)

   330

        self.RefreshConnectors()

   331

        self.RefreshBoundingBox()

   332

   333

    # Returns the element size

   334

    def GetSize(self):

   335

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

   336

   337

    # Returns the minimum element size

   338

    def GetMinSize(self):

   339

        return 0, 0

   340

   341

    # Set size of the element to the minimum size

   342

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

   343

        width, height = self.GetSize()

   344

        posx, posy = self.GetPosition()

   345

        min_width, min_height = self.GetMinSize()

   346

        if width < min_width:

   347

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

   348

            width = min_width

   349

        if height < min_height:

   350

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

   351

            height = min_height

   352

        if scaling is not None:

   353

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

   354

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

   355

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

   356

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

   357

        self.SetSize(width, height)

   358

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

   359

   360

    # Refresh the element connectors position

   361

    def RefreshConnectors(self):

   362

        pass

   363

   364

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

   365

    def RefreshConnected(self, exclude=None):

   366

        pass

   367

   368

    # Change the parent

   369

    def SetParent(self, parent):

   370

        self.Parent = parent

   371

   372

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

   373

    def Delete(self):

   374

        pass

   375

   376

    # Returns the Id

   377

    def GetId(self):

   378

        return self.Id

   379

   380

    # Returns if the point given is in the bounding box

   381

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

   382

        if connectors:

   383

            rect = self.BoundingBox

   384

        else:

   385

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

   386

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

   387

   388

    # Returns if the point given is in the bounding box

   389

    def IsInSelection(self, rect):

   390

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

   391

   392

    # Override this method for refreshing the bounding box

   393

    def RefreshBoundingBox(self):

   394

        pass

   395

   396

    # Returns the bounding box

   397

    def GetBoundingBox(self):

   398

        return self.BoundingBox

   399

   400

    # Returns the RedrawRect

   401

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

   402

        scalex, scaley = self.Parent.GetViewScale()

   403

        rect = wx.Rect()

   404

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

   405

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

   406

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

   407

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

   408

        return rect

   409

   410

    def Refresh(self, rect=None):

   411

        if self.Visible:

   412

            if rect is not None:

   413

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

   414

            else:

   415

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

   416

   417

    # Change the variable that indicates if this element is selected

   418

    def SetSelected(self, selected):

   419

        self.Selected = selected

   420

        self.Refresh()

   421

   422

    # Change the variable that indicates if this element is highlighted

   423

    def SetHighlighted(self, highlighted):

   424

        self.Highlighted = highlighted

   425

        self.Refresh()

   426

   427

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

   428

    def TestHandle(self, event):

   429

        dc = self.Parent.GetLogicalDC()

   430

        scalex, scaley = dc.GetUserScale()

   431

        pos = event.GetPosition()

   432

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

   433

   434

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

   435

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

   436

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

   437

   438

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

   439

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

   440

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

   441

   442

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

   443

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

   444

   445

        # Verify that this element is selected

   446

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

   447

            # Find if point is on a handle horizontally

   448

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

   449

                handle_x = 1

   450

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

   451

                handle_x = 2

   452

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

   453

                handle_x = 3

   454

            else:

   455

                handle_x = 0

   456

            # Find if point is on a handle vertically

   457

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

   458

                handle_y = 1

   459

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

   460

                handle_y = 2

   461

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

   462

                handle_y = 3

   463

            else:

   464

                handle_y = 0

   465

            # Verify that the result is valid

   466

            if (handle_x, handle_y) in VALID_HANDLES:

   467

                return handle_x, handle_y

   468

        return 0, 0

   469

   470

    # Method called when a LeftDown event have been generated

   471

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

   472

        # Test if an handle have been clicked

   473

        handle = self.TestHandle(event)

   474

        # Find which type of handle have been clicked,

   475

        # Save a resize event and change the cursor

   476

        cursor = HANDLE_CURSORS.get(handle, 1)

   477

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

   478

        if cursor > 1:

   479

            self.Handle = (HANDLE_RESIZE, handle)

   480

        else:

   481

            self.Handle = (HANDLE_MOVE, None)

   482

            self.SetSelected(False)

   483

        # Initializes the last position

   484

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

   485

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

   486

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

   487

   488

    # Method called when a LeftUp event have been generated

   489

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

   490

        # If a dragging have been initiated

   491

        if self.Dragging and self.oldPos:

   492

            self.RefreshModel()

   493

            self.Parent.RefreshBuffer()

   494

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

   495

        self.SetSelected(True)

   496

        self.oldPos = None

   497

   498

    # Method called when a RightDown event have been generated

   499

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

   500

        pass

   501

   502

    # Method called when a RightUp event have been generated

   503

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

   504

        if self.Dragging and self.oldPos: