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

    27

from math import *

    28

from types import *

    29

    30

import wx

    31

from graphics.ToolTipProducer import ToolTipProducer

    32

from graphics.DebugDataConsumer import DebugDataConsumer

    33

    34

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

    35

#                               Common constants

    36

#

    37

#            Definition of constants for dimensions of graphic elements

    38

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

    39

    40

# FBD and SFC constants

    41

MIN_MOVE = 5                            # Minimum move before starting a element dragging

    42

CONNECTOR_SIZE = 8                      # Size of connectors

    43

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

    44

HANDLE_SIZE = 6                         # Size of the squares for handles

    45

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

    46

POINT_RADIUS = 2                        # Radius of the point of wire ends

    47

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

    48

    49

# LD constants

    50

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

    51

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

    52

LD_WIRE_SIZE = 30                       # Size of a wire between two contact

    53

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

    54

LD_POWERRAIL_WIDTH = 3                  # Width of a Powerrail

    55

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

    56

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

    57

    58

# SFC constants

    59

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

    60

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

    61

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

    62

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

    63

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

    64

SFC_WIRE_MIN_SIZE = 25                  # Size of a wire between two elements

    65

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

    66

    67

# Type definition constants for graphic elements

    68

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

    69

[CONNECTOR, CONTINUATION] = range(2)

    70

[LEFTRAIL, RIGHTRAIL] = range(2)

    71

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

    72

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

    73

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

    74

    75

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

    76

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

    77

    78

# List of value for resize handle that are valid

    79

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

    80

    81

# Contants for defining the direction of a connector

    82

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

    83

    84

# Contants for defining which mode is selected for each view

    85

[MODE_SELECTION, MODE_BLOCK, MODE_VARIABLE, MODE_CONNECTION, MODE_COMMENT,

    86

 MODE_COIL, MODE_CONTACT, MODE_POWERRAIL, MODE_INITIALSTEP, MODE_STEP,

    87

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

    88

    89

# Contants for defining alignment types for graphic group

    90

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

    91

    92

# Contants for defining which drawing mode is selected for app

    93

[FREEDRAWING_MODE, DRIVENDRAWING_MODE] = [1, 2]

    94

    95

# Color for Highlighting

    96

HIGHLIGHTCOLOR = wx.CYAN

    97

    98

# Define highlight types

    99

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

   100

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

   101

   102

# Define highlight refresh inhibition period in second

   103

REFRESH_HIGHLIGHT_PERIOD = 0.1

   104

   105

HANDLE_CURSORS = {

   106

    (1, 1): 2,

   107

    (3, 3): 2,

   108

    (1, 3): 3,

   109

    (3, 1): 3,

   110

    (1, 2): 4,

   111

    (3, 2): 4,

   112

    (2, 1): 5,

   113

    (2, 3): 5

   114

}

   115

   116

   117

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

   118

    fraction = float(x) / float(n)

   119

    if constraint == -1:

   120

        xround = int(fraction)

   121

    else:

   122

        xround = round(fraction)

   123

        if constraint == 1 and xround < fraction:

   124

            xround += 1

   125

    return int(xround * n)

   126

   127

   128

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

   129

# Basic vector operations for calculate wire points

   130

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

   131

   132

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

   133

    """

   134

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

   135

    """

   136

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

   137

    if normal:

   138

        return normalize(vector)

   139

    return vector

   140

   141

   142

def norm(v):

   143

    """

   144

    Calculate the norm of a given vector

   145

    """

   146

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

   147

   148

   149

def normalize(v):

   150

    """

   151

    Normalize a given vector

   152

    """

   153

    v_norm = norm(v)

   154

    # Verifie if it is not a null vector

   155

    if v_norm > 0:

   156

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

   157

    else:

   158

        return v

   159

   160

   161

def is_null_vector(v):

   162

    """

   163

    Calculate the scalar product of two vectors

   164

    """

   165

    return v == (0, 0)

   166

   167

   168

def add_vectors(v1, v2):

   169

    """

   170

    Calculate the scalar product of two vectors

   171

    """

   172

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

   173

   174

   175

def product(v1, v2):

   176

    """

   177

    Calculate the scalar product of two vectors

   178

    """

   179

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

   180

   181

   182

def GetScaledEventPosition(event, dc, scaling):

   183

    """

   184

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

   185

    """

   186

    pos = event.GetLogicalPosition(dc)

   187

    if scaling:

   188

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

   189

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

   190

    return pos

   191

   192

   193

def DirectionChoice(v_base, v_target, dir_target):

   194

    """

   195

    Function that choose a direction during the wire points generation

   196

    """

   197

    dir_product = product(v_base, v_target)

   198

    if dir_product < 0:

   199

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

   200

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

   201

        return dir_target

   202

    return v_base

   203

   204

   205

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

   206

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

   207

    pen.SetJoin(wx.JOIN_MITER)

   208

    pen.SetCap(wx.CAP_PROJECTING)

   209

    return pen

   210

   211

   212

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

   213

#                    Helpers for highlighting text

   214

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

   215

   216

   217

def AddHighlight(highlights, infos):

   218

    RemoveHighlight(highlights, infos)

   219

    highlights.append(infos)

   220

   221

   222

def RemoveHighlight(highlights, infos):

   223

    if infos in highlights:

   224

        highlights.remove(infos)

   225

        return True

   226

    return False

   227

   228

   229

def ClearHighlights(highlights, highlight_type=None):

   230

    if highlight_type is not None:

   231

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

   232

    return []

   233

   234

   235

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

   236

    current_pen = dc.GetPen()

   237

    dc.SetPen(wx.TRANSPARENT_PEN)

   238

    for start, end, highlight_type in highlights:

   239

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

   240

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

   241

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

   242

        part_width, part_height = dc.GetTextExtent(part)

   243

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

   244

        dc.SetTextForeground(highlight_type[1])

   245

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

   246

    dc.SetPen(current_pen)

   247

    dc.SetTextForeground(wx.BLACK)

   248

   249

   250

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

   251

#                           Graphic element base class

   252

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

   253

   254

   255

class Graphic_Element(ToolTipProducer):

   256

    """

   257

    Class that implements a generic graphic element

   258

    """

   259

   260

    # Create a new graphic element

   261

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

   262

        ToolTipProducer.__init__(self, parent)

   263

        self.Parent = parent

   264

        self.Id = id

   265

        self.oldPos = None

   266

        self.StartPos = None

   267

        self.CurrentDrag = None

   268

        self.Handle = (None, None)

   269

        self.Dragging = False

   270

        self.Selected = False

   271

        self.Highlighted = False

   272

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

   273

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

   274

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

   275

        self.Visible = False

   276

   277

    def GetDefinition(self):

   278

        return [self.Id], []

   279

   280

    def TestVisible(self, screen):

   281

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

   282

   283

    def IsVisible(self):

   284

        return self.Visible

   285

   286

    def SpreadCurrent(self):

   287

        pass

   288

   289

    def GetConnectorTranslation(self, element):

   290

        return {}

   291

   292

    def FindNearestConnector(self, position, connectors):

   293

        distances = []

   294

        for connector in connectors:

   295

            connector_pos = connector.GetRelPosition()

   296

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

   297

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

   298

                              connector))

   299

        distances.sort()

   300

        if len(distances) > 0:

   301

            return distances[0][1]

   302

        return None

   303

   304

    def IsOfType(self, type, reference):

   305

        return self.Parent.IsOfType(type, reference)

   306

   307

    def IsEndType(self, type):

   308

        return self.Parent.IsEndType(type)

   309

   310

    def GetDragging(self):

   311

        return self.Dragging

   312

   313

    # Make a clone of this element

   314

    def Clone(self, parent):

   315

        return Graphic_Element(parent, self.Id)

   316

   317

    # Changes the block position

   318

    def SetPosition(self, x, y):

   319

        self.Pos.x = x

   320

        self.Pos.y = y

   321

        self.RefreshConnected()

   322

        self.RefreshBoundingBox()

   323

   324

    # Returns the block position

   325

    def GetPosition(self):

   326

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

   327

   328

    # Changes the element size

   329

    def SetSize(self, width, height):

   330

        self.Size.SetWidth(width)

   331

        self.Size.SetHeight(height)

   332

        self.RefreshConnectors()

   333

        self.RefreshBoundingBox()

   334

   335

    # Returns the element size

   336

    def GetSize(self):

   337

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

   338

   339

    # Returns the minimum element size

   340

    def GetMinSize(self):

   341

        return 0, 0

   342

   343

    # Set size of the element to the minimum size

   344

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

   345

        width, height = self.GetSize()

   346

        posx, posy = self.GetPosition()

   347

        min_width, min_height = self.GetMinSize()

   348

        if width < min_width:

   349

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

   350

            width = min_width

   351

        if height < min_height:

   352

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

   353

            height = min_height

   354

        if scaling is not None:

   355

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

   356

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

   357

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

   358

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

   359

        self.SetSize(width, height)

   360

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

   361

   362

    # Refresh the element connectors position

   363

    def RefreshConnectors(self):

   364

        pass

   365

   366

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

   367

    def RefreshConnected(self, exclude=None):

   368

        pass

   369

   370

    # Change the parent

   371

    def SetParent(self, parent):

   372

        self.Parent = parent

   373

   374

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

   375

    def Delete(self):

   376

        pass

   377

   378

    # Returns the Id

   379

    def GetId(self):

   380

        return self.Id

   381

   382

    # Returns if the point given is in the bounding box

   383

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

   384

        if connectors:

   385

            rect = self.BoundingBox

   386

        else:

   387

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

   388

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

   389

   390

    # Returns if the point given is in the bounding box

   391

    def IsInSelection(self, rect):

   392

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

   393

   394

    # Override this method for refreshing the bounding box

   395

    def RefreshBoundingBox(self):

   396

        pass

   397

   398

    # Returns the bounding box

   399

    def GetBoundingBox(self):

   400

        return self.BoundingBox

   401

   402

    # Returns the RedrawRect

   403

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

   404

        scalex, scaley = self.Parent.GetViewScale()

   405

        rect = wx.Rect()

   406

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

   407

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

   408

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

   409

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

   410

        return rect

   411

   412

    def Refresh(self, rect=None):

   413

        if self.Visible:

   414

            if rect is not None:

   415

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

   416

            else:

   417

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

   418

   419

    # Change the variable that indicates if this element is selected

   420

    def SetSelected(self, selected):

   421

        self.Selected = selected

   422

        self.Refresh()

   423

   424

    # Change the variable that indicates if this element is highlighted

   425

    def SetHighlighted(self, highlighted):

   426

        self.Highlighted = highlighted

   427

        self.Refresh()

   428

   429

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

   430

    def TestHandle(self, event):

   431

        dc = self.Parent.GetLogicalDC()

   432

        scalex, scaley = dc.GetUserScale()

   433

        pos = event.GetPosition()

   434

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

   435

   436

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

   437

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

   438

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

   439

   440

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

   441

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

   442

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

   443

   444

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

   445

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

   446

   447

        # Verify that this element is selected

   448

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

   449

            # Find if point is on a handle horizontally

   450

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

   451

                handle_x = 1

   452

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

   453

                handle_x = 2

   454

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

   455

                handle_x = 3

   456

            else:

   457

                handle_x = 0

   458

            # Find if point is on a handle vertically

   459

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

   460

                handle_y = 1

   461

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

   462

                handle_y = 2

   463

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

   464

                handle_y = 3

   465

            else:

   466

                handle_y = 0

   467

            # Verify that the result is valid

   468

            if (handle_x, handle_y) in VALID_HANDLES:

   469

                return handle_x, handle_y

   470

        return 0, 0

   471

   472

    # Method called when a LeftDown event have been generated

   473

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

   474

        # Test if an handle have been clicked

   475

        handle = self.TestHandle(event)

   476

        # Find which type of handle have been clicked,

   477

        # Save a resize event and change the cursor

   478

        cursor = HANDLE_CURSORS.get(handle, 1)

   479

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

   480

        if cursor > 1:

   481

            self.Handle = (HANDLE_RESIZE, handle)

   482

        else:

   483

            self.Handle = (HANDLE_MOVE, None)

   484

            self.SetSelected(False)

   485

        # Initializes the last position

   486

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

   487

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

   488

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

   489

   490

    # Method called when a LeftUp event have been generated

   491

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

   492

        # If a dragging have been initiated

   493

        if self.Dragging and self.oldPos:

   494

            self.RefreshModel()

   495

            self.Parent.RefreshBuffer()

   496

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

   497

        self.SetSelected(True)

   498

        self.oldPos = None

   499

   500

    # Method called when a RightDown event have been generated

   501

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

   502

        pass

   503

   504

    # Method called when a RightUp event have been generated

   505

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

   506

        if self.Dragging and self.oldPos:

   507

            self.RefreshModel()