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

from types import *

    28

    29

import wx

    30

from graphics.ToolTipProducer import ToolTipProducer

    31

from graphics.DebugDataConsumer import DebugDataConsumer

    32

    33

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

    34

#                               Common constants

    35

#

    36

#            Definition of constants for dimensions of graphic elements

    37

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

    38

    39

# FBD and SFC constants

    40

MIN_MOVE = 5                            # Minimum move before starting a element dragging

    41

CONNECTOR_SIZE = 8                      # Size of connectors

    42

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

    43

HANDLE_SIZE = 6                         # Size of the squares for handles

    44

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

    45

POINT_RADIUS = 2                        # Radius of the point of wire ends

    46

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

    47

    48

# LD constants

    49

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

    50

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

    51

LD_WIRE_SIZE = 30                       # Size of a wire between two contact

    52

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

    53

LD_POWERRAIL_WIDTH = 3                  # Width of a Powerrail

    54

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

    55

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

    56

    57

# SFC constants

    58

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

    59

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

    60

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

    61

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

    62

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

    63

SFC_WIRE_MIN_SIZE = 25                  # Size of a wire between two elements

    64

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

    65

    66

# Type definition constants for graphic elements

    67

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

    68

[CONNECTOR, CONTINUATION] = range(2)

    69

[LEFTRAIL, RIGHTRAIL] = range(2)

    70

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

    71

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

    72

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

    73

    74

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

    75

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

    76

    77

# List of value for resize handle that are valid

    78

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

    79

    80

# Contants for defining the direction of a connector

    81

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

    82

    83

# Contants for defining which mode is selected for each view

    84

[MODE_SELECTION, MODE_BLOCK, MODE_VARIABLE, MODE_CONNECTION, MODE_COMMENT,

    85

 MODE_COIL, MODE_CONTACT, MODE_POWERRAIL, MODE_INITIALSTEP, MODE_STEP,

    86

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

    87

    88

# Contants for defining alignment types for graphic group

    89

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

    90

    91

# Contants for defining which drawing mode is selected for app

    92

[FREEDRAWING_MODE, DRIVENDRAWING_MODE] = [1, 2]

    93

    94

# Color for Highlighting

    95

HIGHLIGHTCOLOR = wx.CYAN

    96

    97

# Define highlight types

    98

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

    99

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

   100

   101

# Define highlight refresh inhibition period in second

   102

REFRESH_HIGHLIGHT_PERIOD = 0.1

   103

   104

HANDLE_CURSORS = {

   105

    (1, 1): 2,

   106

    (3, 3): 2,

   107

    (1, 3): 3,

   108

    (3, 1): 3,

   109

    (1, 2): 4,

   110

    (3, 2): 4,

   111

    (2, 1): 5,

   112

    (2, 3): 5

   113

}

   114

   115

   116

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

   117

    fraction = float(x) / float(n)

   118

    if constraint == -1:

   119

        xround = int(fraction)

   120

    else:

   121

        xround = round(fraction)

   122

        if constraint == 1 and xround < fraction:

   123

            xround += 1

   124

    return int(xround * n)

   125

   126

   127

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

   128

# Basic vector operations for calculate wire points

   129

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

   130

   131

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

   132

    """

   133

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

   134

    """

   135

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

   136

    if normal:

   137

        return normalize(vector)

   138

    return vector

   139

   140

   141

def norm(v):

   142

    """

   143

    Calculate the norm of a given vector

   144

    """

   145

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

   146

   147

   148

def normalize(v):

   149

    """

   150

    Normalize a given vector

   151

    """

   152

    v_norm = norm(v)

   153

    # Verifie if it is not a null vector

   154

    if v_norm > 0:

   155

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

   156

    else:

   157

        return v

   158

   159

   160

def is_null_vector(v):

   161

    """

   162

    Calculate the scalar product of two vectors

   163

    """

   164

    return v == (0, 0)

   165

   166

   167

def add_vectors(v1, v2):

   168

    """

   169

    Calculate the scalar product of two vectors

   170

    """

   171

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

   172

   173

   174

def product(v1, v2):

   175

    """

   176

    Calculate the scalar product of two vectors

   177

    """

   178

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

   179

   180

   181

def GetScaledEventPosition(event, dc, scaling):

   182

    """

   183

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

   184

    """

   185

    pos = event.GetLogicalPosition(dc)

   186

    if scaling:

   187

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

   188

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

   189

    return pos

   190

   191

   192

def DirectionChoice(v_base, v_target, dir_target):

   193

    """

   194

    Function that choose a direction during the wire points generation

   195

    """

   196

    dir_product = product(v_base, v_target)

   197

    if dir_product < 0:

   198

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

   199

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

   200

        return dir_target

   201

    return v_base

   202

   203

   204

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

   205

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

   206

    pen.SetJoin(wx.JOIN_MITER)

   207

    pen.SetCap(wx.CAP_PROJECTING)

   208

    return pen

   209

   210

   211

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

   212

#                    Helpers for highlighting text

   213

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

   214

   215

   216

def AddHighlight(highlights, infos):

   217

    RemoveHighlight(highlights, infos)

   218

    highlights.append(infos)

   219

   220

   221

def RemoveHighlight(highlights, infos):

   222

    if infos in highlights:

   223

        highlights.remove(infos)

   224

        return True

   225

    return False

   226

   227

   228

def ClearHighlights(highlights, highlight_type=None):

   229

    if highlight_type is not None:

   230

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

   231

    return []

   232

   233

   234

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

   235

    current_pen = dc.GetPen()

   236

    dc.SetPen(wx.TRANSPARENT_PEN)

   237

    for start, end, highlight_type in highlights:

   238

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

   239

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

   240

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

   241

        part_width, part_height = dc.GetTextExtent(part)

   242

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

   243

        dc.SetTextForeground(highlight_type[1])

   244

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

   245

    dc.SetPen(current_pen)

   246

    dc.SetTextForeground(wx.BLACK)

   247

   248

   249

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

   250

#                           Graphic element base class

   251

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

   252

   253

   254

class Graphic_Element(ToolTipProducer):

   255

    """

   256

    Class that implements a generic graphic element

   257

    """

   258

   259

    # Create a new graphic element

   260

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

   261

        ToolTipProducer.__init__(self, parent)

   262

        self.Parent = parent

   263

        self.Id = id

   264

        self.oldPos = None

   265

        self.StartPos = None

   266

        self.CurrentDrag = None

   267

        self.Handle = (None, None)

   268

        self.Dragging = False

   269

        self.Selected = False

   270

        self.Highlighted = False

   271

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

   272

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

   273

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

   274

        self.Visible = False

   275

   276

    def GetDefinition(self):

   277

        return [self.Id], []

   278

   279

    def TestVisible(self, screen):

   280

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

   281

   282

    def IsVisible(self):

   283

        return self.Visible

   284

   285

    def SpreadCurrent(self):

   286

        pass

   287

   288

    def GetConnectorTranslation(self, element):

   289

        return {}

   290

   291

    def FindNearestConnector(self, position, connectors):

   292

        distances = []

   293

        for connector in connectors:

   294

            connector_pos = connector.GetRelPosition()

   295

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

   296

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

   297

                              connector))

   298

        distances.sort()

   299

        if len(distances) > 0:

   300

            return distances[0][1]

   301

        return None

   302

   303

    def IsOfType(self, type, reference):

   304

        return self.Parent.IsOfType(type, reference)

   305

   306

    def IsEndType(self, type):

   307

        return self.Parent.IsEndType(type)

   308

   309

    def GetDragging(self):

   310

        return self.Dragging

   311

   312

    # Make a clone of this element

   313

    def Clone(self, parent):

   314

        return Graphic_Element(parent, self.Id)

   315

   316

    # Changes the block position

   317

    def SetPosition(self, x, y):

   318

        self.Pos.x = x

   319

        self.Pos.y = y

   320

        self.RefreshConnected()

   321

        self.RefreshBoundingBox()

   322

   323

    # Returns the block position

   324

    def GetPosition(self):

   325

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

   326

   327

    # Changes the element size

   328

    def SetSize(self, width, height):

   329

        self.Size.SetWidth(width)

   330

        self.Size.SetHeight(height)

   331

        self.RefreshConnectors()

   332

        self.RefreshBoundingBox()

   333

   334

    # Returns the element size

   335

    def GetSize(self):

   336

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

   337

   338

    # Returns the minimum element size

   339

    def GetMinSize(self):

   340

        return 0, 0

   341

   342

    # Set size of the element to the minimum size

   343

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

   344

        width, height = self.GetSize()

   345

        posx, posy = self.GetPosition()

   346

        min_width, min_height = self.GetMinSize()

   347

        if width < min_width:

   348

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

   349

            width = min_width

   350

        if height < min_height:

   351

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

   352

            height = min_height

   353

        if scaling is not None:

   354

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

   355

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

   356

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

   357

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

   358

        self.SetSize(width, height)

   359

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

   360

   361

    # Refresh the element connectors position

   362

    def RefreshConnectors(self):

   363

        pass

   364

   365

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

   366

    def RefreshConnected(self, exclude=None):

   367

        pass

   368

   369

    # Change the parent

   370

    def SetParent(self, parent):

   371

        self.Parent = parent

   372

   373

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

   374

    def Delete(self):

   375

        pass

   376

   377

    # Returns the Id

   378

    def GetId(self):

   379

        return self.Id

   380

   381

    # Returns if the point given is in the bounding box

   382

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

   383

        if connectors:

   384

            rect = self.BoundingBox

   385

        else:

   386

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

   387

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

   388

   389

    # Returns if the point given is in the bounding box

   390

    def IsInSelection(self, rect):

   391

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

   392

   393

    # Override this method for refreshing the bounding box

   394

    def RefreshBoundingBox(self):

   395

        pass

   396

   397

    # Returns the bounding box

   398

    def GetBoundingBox(self):

   399

        return self.BoundingBox

   400

   401

    # Returns the RedrawRect

   402

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

   403

        scalex, scaley = self.Parent.GetViewScale()

   404

        rect = wx.Rect()

   405

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

   406

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

   407

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

   408

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

   409

        return rect

   410

   411

    def Refresh(self, rect=None):

   412

        if self.Visible:

   413

            if rect is not None:

   414

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

   415

            else:

   416

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

   417

   418

    # Change the variable that indicates if this element is selected

   419

    def SetSelected(self, selected):

   420

        self.Selected = selected

   421

        self.Refresh()

   422

   423

    # Change the variable that indicates if this element is highlighted

   424

    def SetHighlighted(self, highlighted):

   425

        self.Highlighted = highlighted

   426

        self.Refresh()

   427

   428

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

   429

    def TestHandle(self, event):

   430

        dc = self.Parent.GetLogicalDC()

   431

        scalex, scaley = dc.GetUserScale()

   432

        pos = event.GetPosition()

   433

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

   434

   435

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

   436

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

   437

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

   438

   439

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

   440

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

   441

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

   442

   443

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

   444

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

   445

   446

        # Verify that this element is selected

   447

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

   448

            # Find if point is on a handle horizontally

   449

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

   450

                handle_x = 1

   451

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

   452

                handle_x = 2

   453

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

   454

                handle_x = 3

   455

            else:

   456

                handle_x = 0

   457

            # Find if point is on a handle vertically

   458

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

   459

                handle_y = 1

   460

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

   461

                handle_y = 2

   462

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

   463

                handle_y = 3

   464

            else:

   465

                handle_y = 0

   466

            # Verify that the result is valid

   467

            if (handle_x, handle_y) in VALID_HANDLES:

   468

                return handle_x, handle_y

   469

        return 0, 0

   470

   471

    # Method called when a LeftDown event have been generated

   472

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

   473

        # Test if an handle have been clicked

   474

        handle = self.TestHandle(event)

   475

        # Find which type of handle have been clicked,

   476

        # Save a resize event and change the cursor

   477

        cursor = HANDLE_CURSORS.get(handle, 1)

   478

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

   479

        if cursor > 1:

   480

            self.Handle = (HANDLE_RESIZE, handle)

   481

        else:

   482

            self.Handle = (HANDLE_MOVE, None)

   483

            self.SetSelected(False)

   484

        # Initializes the last position

   485

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

   486

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

   487

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

   488

   489

    # Method called when a LeftUp event have been generated

   490

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

   491

        # If a dragging have been initiated

   492

        if self.Dragging and self.oldPos:

   493

            self.RefreshModel()

   494

            self.Parent.RefreshBuffer()

   495

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

   496

        self.SetSelected(True)

   497

        self.oldPos = None

   498

   499

    # Method called when a RightDown event have been generated

   500

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

   501

        pass

   502

   503

    # Method called when a RightUp event have been generated

   504

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

   505

        if self.Dragging and self.oldPos:

   506

            self.RefreshModel()

   507

            self.Parent.RefreshBuffer()