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

    26

from math import *

    27

from types import *

    28

import datetime

    29

from threading import Lock, Timer

    30

    32

from graphics.ToolTipProducer import ToolTipProducer

    33

from graphics.DebugDataConsumer import DebugDataConsumer

    34

    35

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

    36

#                               Common constants

    37

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

    38

    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 = float(x) / float(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

   136

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

   137

    """

   138

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

   139

    """

   140

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

   141

    if normal:

   142

        return normalize(vector)

   143

    return vector

   144

   145

   146

def norm(v):

   147

    """

   148

    Calculate the norm of a given vector

   149

    """

   150

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

   151

   152

   153

def normalize(v):

   154

    """

   155

    Normalize a given vector

   156

    """

   157

    v_norm = norm(v)

   158

    # Verifie if it is not a null vector

   159

    if v_norm > 0:

   160

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

   161

    else:

   162

        return v

   163

   164

   165

def is_null_vector(v):

   166

    """

   167

    Calculate the scalar product of two vectors

   168

    """

   169

    return v == (0, 0)

   170

   171

   172

def add_vectors(v1, v2):

   173

    """

   174

    Calculate the scalar product of two vectors

   175

    """

   176

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

   177

   178

   179

def product(v1, v2):

   180

    """

   181

    Calculate the scalar product of two vectors

   182

    """

   183

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

   184

   185

   186

def GetScaledEventPosition(event, dc, scaling):

   187

    """

   188

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

   189

    """

   190

    pos = event.GetLogicalPosition(dc)

   191

    if scaling:

   192

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

   193

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

   194

    return pos

   195

   196

   197

def DirectionChoice(v_base, v_target, dir_target):

   198

    """

   199

    Function that choose a direction during the wire points generation

   200

    """

   201

    dir_product = product(v_base, v_target)

   202

    if dir_product < 0:

   203

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

   204

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

   205

        return dir_target

   206

    return v_base

   207

   208

   209

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

   210

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

   211

    pen.SetJoin(wx.JOIN_MITER)

   212

    pen.SetCap(wx.CAP_PROJECTING)

   213

    return pen

   214

   215

   216

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

   217

#                    Helpers for highlighting text

   218

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

   219

   220

   221

def AddHighlight(highlights, infos):

   222

    RemoveHighlight(highlights, infos)

   223

    highlights.append(infos)

   224

   225

   226

def RemoveHighlight(highlights, infos):

   227

    if infos in highlights:

   228

        highlights.remove(infos)

   229

        return True

   230

    return False

   231

   232

   233

def ClearHighlight(highlights, highlight_type=None):

   234

    if highlight_type is not None:

   235

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

   236

    return []

   237

   238

   239

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

   240

    current_pen = dc.GetPen()

   241

    dc.SetPen(wx.TRANSPARENT_PEN)

   242

    for start, end, highlight_type in highlights:

   243

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

   244

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

   245

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

   246

        part_width, part_height = dc.GetTextExtent(part)

   247

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

   248

        dc.SetTextForeground(highlight_type[1])

   249

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

   250

    dc.SetPen(current_pen)

   251

    dc.SetTextForeground(wx.BLACK)

   252

   253

   254

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

   255

#                           Graphic element base class

   256

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

   257

   258

   259

class Graphic_Element(ToolTipProducer):

   260

    """

   261

    Class that implements a generic graphic element

   262

    """

   263

   264

    # Create a new graphic element

   265

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

   266

        ToolTipProducer.__init__(self, parent)

   267

        self.Parent = parent

   268

        self.Id = id

   269

        self.oldPos = None

   270

        self.StartPos = None

   271

        self.CurrentDrag = None

   272

        self.Handle = (None, None)

   273

        self.Dragging = False

   274

        self.Selected = False

   275

        self.Highlighted = False

   276

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

   277

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

   278

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

   279

        self.Visible = False

   280

   281

    def GetDefinition(self):

   282

        return [self.Id], []

   283

   284

    def TestVisible(self, screen):

   285

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

   286

   287

    def IsVisible(self):

   288

        return self.Visible

   289

   290

    def SpreadCurrent(self):

   291

        pass

   292

   293

    def GetConnectorTranslation(self, element):

   294

        return {}

   295

   296

    def FindNearestConnector(self, position, connectors):

   297

        distances = []

   298

        for connector in connectors:

   299

            connector_pos = connector.GetRelPosition()

   300

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

   301

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

   302

                              connector))

   303

        distances.sort()

   304

        if len(distances) > 0:

   305

            return distances[0][1]

   306

        return None

   307

   308

    def IsOfType(self, type, reference):

   309

        return self.Parent.IsOfType(type, reference)

   310

   311

    def IsEndType(self, type):

   312

        return self.Parent.IsEndType(type)

   313

   314

    def GetDragging(self):

   315

        return self.Dragging

   316

   317

    # Make a clone of this element

   318

    def Clone(self, parent):

   319

        return Graphic_Element(parent, self.Id)

   320

   321

    # Changes the block position

   322

    def SetPosition(self, x, y):

   323

        self.Pos.x = x

   324

        self.Pos.y = y

   325

        self.RefreshConnected()

   326

        self.RefreshBoundingBox()

   327

   328

    # Returns the block position

   329

    def GetPosition(self):

   330

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

   331

   332

    # Changes the element size

   333

    def SetSize(self, width, height):

   334

        self.Size.SetWidth(width)

   335

        self.Size.SetHeight(height)

   336

        self.RefreshConnectors()

   337

        self.RefreshBoundingBox()

   338

   339

    # Returns the element size

   340

    def GetSize(self):

   341

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

   342

   343

    # Returns the minimum element size

   344

    def GetMinSize(self):

   345

        return 0, 0

   346

   347

    # Set size of the element to the minimum size

   348

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

   349

        width, height = self.GetSize()

   350

        posx, posy = self.GetPosition()

   351

        min_width, min_height = self.GetMinSize()

   352

        if width < min_width:

   353

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

   354

            width = min_width

   355

        if height < min_height:

   356

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

   357

            height = min_height

   358

        if scaling is not None:

   359

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

   360

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

   361

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

   362

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

   363

        self.SetSize(width, height)

   364

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

   365

   366

    # Refresh the element Bounding Box

   367

    def RefreshBoundingBox(self):

   368

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

   369

   370

    # Refresh the element connectors position

   371

    def RefreshConnectors(self):

   372

        pass

   373

   374

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

   375

    def RefreshConnected(self):

   376

        pass

   377

   378

    # Change the parent

   379

    def SetParent(self, parent):

   380

        self.Parent = parent

   381

   382

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

   383

    def Delete(self):

   384

        pass

   385

   386

    # Returns the Id

   387

    def GetId(self):

   388

        return self.Id

   389

   390

    # Returns if the point given is in the bounding box

   391

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

   392

        if connectors:

   393

            rect = self.BoundingBox

   394

        else:

   395

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

   396

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

   397

   398

    # Returns if the point given is in the bounding box

   399

    def IsInSelection(self, rect):

   400

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

   401

   402

    # Override this method for refreshing the bounding box

   403

    def RefreshBoundingBox(self):

   404

        pass

   405

   406

    # Returns the bounding box

   407

    def GetBoundingBox(self):

   408

        return self.BoundingBox

   409

   410

    # Returns the RedrawRect

   411

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

   412

        scalex, scaley = self.Parent.GetViewScale()

   413

        rect = wx.Rect()

   414

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

   415

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

   416

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

   417

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

   418

        return rect

   419

   420

    def Refresh(self, rect=None):

   421

        if self.Visible:

   422

            if rect is not None:

   423

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

   424

            else:

   425

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

   426

   427

    # Change the variable that indicates if this element is selected

   428

    def SetSelected(self, selected):

   429

        self.Selected = selected

   430

        self.Refresh()

   431

   432

    # Change the variable that indicates if this element is highlighted

   433

    def SetHighlighted(self, highlighted):

   434

        self.Highlighted = highlighted

   435

        self.Refresh()

   436

   437

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

   438

    def TestHandle(self, event):

   439

        dc = self.Parent.GetLogicalDC()

   440

        scalex, scaley = dc.GetUserScale()

   441

        pos = event.GetPosition()

   442

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

   443

   444

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

   445

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

   446

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

   447

   448

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

   449

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

   450

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

   451

   452

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

   453

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

   454

   455

        # Verify that this element is selected

   456

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

   457

            # Find if point is on a handle horizontally

   458

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

   459

                handle_x = 1

   460

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

   461

                handle_x = 2

   462

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

   463

                handle_x = 3

   464

            else:

   465

                handle_x = 0

   466

            # Find if point is on a handle vertically

   467

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

   468

                handle_y = 1

   469

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

   470

                handle_y = 2

   471

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

   472

                handle_y = 3

   473

            else:

   474

                handle_y = 0

   475

            # Verify that the result is valid

   476

            if (handle_x, handle_y) in VALID_HANDLES:

   477

                return handle_x, handle_y

   478

        return 0, 0

   479

   480

    # Method called when a LeftDown event have been generated

   481

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

   482

        pos = event.GetLogicalPosition(dc)

   483

        # Test if an handle have been clicked

   484

        handle = self.TestHandle(event)

   485

        # Find which type of handle have been clicked,

   486

        # Save a resize event and change the cursor

   487

        cursor = HANDLE_CURSORS.get(handle, 1)

   488

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

   489

        if cursor > 1:

   490

            self.Handle = (HANDLE_RESIZE, handle)

   491

        else:

   492

            self.Handle = (HANDLE_MOVE, None)

   493

            self.SetSelected(False)

   494

        # Initializes the last position

   495

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

   496

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

   497

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

   498

   499

    # Method called when a LeftUp event have been generated

   500

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

   501

        # If a dragging have been initiated

   502

        if self.Dragging and self.oldPos:

   503

            self.RefreshModel()

   504

            self.Parent.RefreshBuffer()

   505

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

   506

        self.SetSelected(True)

   507

        self.oldPos = None

   508