1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import wx

    26

import wx.stc

    27

from types import *

    28

    29

import re

    30

    31

from graphics.GraphicCommons import ERROR_HIGHLIGHT, SEARCH_RESULT_HIGHLIGHT, REFRESH_HIGHLIGHT_PERIOD

    34

    35

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

    36

#                         Textual programs Viewer class

    37

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

    38

    39

    40

NEWLINE = "\n"

    41

NUMBERS = [str(i) for i in xrange(10)]

    42

LETTERS = ['_']

    43

for i in xrange(26):

    44

    LETTERS.append(chr(ord('a') + i))

    45

    LETTERS.append(chr(ord('A') + i))

    46

    47

[STC_PLC_WORD, STC_PLC_COMMENT, STC_PLC_NUMBER, STC_PLC_STRING, 

    48

 STC_PLC_VARIABLE, STC_PLC_PARAMETER, STC_PLC_FUNCTION, STC_PLC_JUMP, 

    49

 STC_PLC_ERROR, STC_PLC_SEARCH_RESULT] = range(10)

    50

[SPACE, WORD, NUMBER, STRING, WSTRING, COMMENT] = range(6)

    51

    54

    55

if wx.Platform == '__WXMSW__':

    56

    faces = { 'times': 'Times New Roman',

    57

              'mono' : 'Courier New',

    58

              'helv' : 'Arial',

    59

              'other': 'Comic Sans MS',

    60

              'size' : 10,

    61

             }

    62

else:

    63

    faces = { 'times': 'Times',

    64

              'mono' : 'Courier',

    65

              'helv' : 'Helvetica',

    66

              'other': 'new century schoolbook',

    67

              'size' : 12,

    68

             }

    69

re_texts = {}

    70

re_texts["letter"] = "[A-Za-z]"

    71

re_texts["digit"] = "[0-9]"

    72

re_texts["identifier"] = "((?:%(letter)s|(?:_(?:%(letter)s|%(digit)s)))(?:_?(?:%(letter)s|%(digit)s))*)"%re_texts

    73

IDENTIFIER_MODEL = re.compile(re_texts["identifier"])

    74

LABEL_MODEL = re.compile("[ \t\n]%(identifier)s:[ \t\n]"%re_texts)

    75

EXTENSIBLE_PARAMETER = re.compile("IN[1-9][0-9]*$")

    76

    77

HIGHLIGHT_TYPES = {

    78

    ERROR_HIGHLIGHT: STC_PLC_ERROR,

    79

    SEARCH_RESULT_HIGHLIGHT: STC_PLC_SEARCH_RESULT,

    80

}

    81

    82

def GetCursorPos(old, new):

    83

    old_length = len(old)

    84

    new_length = len(new)

    85

    common_length = min(old_length, new_length)

    86

    i = 0

    87

    for i in xrange(common_length):

    88

        if old[i] != new[i]:

    89

            break

    90

    if old_length < new_length:

    91

        if common_length > 0 and old[i] != new[i]:

    92

            return i + new_length - old_length

    93

        else:

    94

            return i + new_length - old_length + 1

    95

    elif old_length > new_length or i < min(old_length, new_length) - 1:

    96

        if common_length > 0 and old[i] != new[i]:

    97

            return i

    98

        else:

    99

            return i + 1

   100

    else:

   101

        return None

   102

   103

def LineStartswith(line, symbols):

   104

    return reduce(lambda x, y: x or y, map(lambda x: line.startswith(x), symbols), False)

   105

   109

   110

    if wx.VERSION < (2, 6, 0):

   111

        def Bind(self, event, function, id = None):

   112

            if id is not None:

   113

                event(self, id, function)

   114

            else:

   115

                event(self, function)

   116

   183

    def __init__(self, parent, tagname, window, controler, debug = False, instancepath = ""):

   188

   189

        self.Keywords = []

   190

        self.Variables = {}

   191

        self.Functions = {}

   192

        self.TypeNames = []

   193

        self.Jumps = []

   194

        self.EnumeratedValues = []

   195

        self.DisableEvents = True

   197

        self.CurrentAction = None

   198

        self.Highlights = []

   199

        self.Debug = debug

   200

        self.InstancePath = instancepath

   201

        self.ContextStack = []

   202

        self.CallStack = []

   203

   204

        self.RefreshHighlightsTimer = wx.Timer(self, -1)

   205

        self.Bind(wx.EVT_TIMER, self.OnRefreshHighlightsTimer, self.RefreshHighlightsTimer)

   206

   207

    def __del__(self):

   208

        self.RefreshHighlightsTimer.Stop()

   209

   216

   217

    def GetInstancePath(self):

   218

        return self.InstancePath

   219

   220

    def IsViewing(self, tagname):

   222

            return self.InstancePath == tagname

   223

        else:

   224

            return self.TagName == tagname

   225

   226

    def IsDebugging(self):

   227

        return self.Debug

   228

   249

   250

    def OnModification(self, event):

   251

        if not self.DisableEvents:

   252

            mod_type = event.GetModificationType()

   253

            if mod_type&wx.stc.STC_MOD_BEFOREINSERT:

   254

                if self.CurrentAction == None:

   255

                    self.StartBuffering()

   256

                elif self.CurrentAction[0] != "Add" or self.CurrentAction[1] != event.GetPosition() - 1:

   257

                    self.Controler.EndBuffering()

   258

                    self.StartBuffering()

   259

                self.CurrentAction = ("Add", event.GetPosition())

   260

                wx.CallAfter(self.RefreshModel)

   261

            elif mod_type&wx.stc.STC_MOD_BEFOREDELETE:

   262

                if self.CurrentAction == None:

   263

                    self.StartBuffering()

   264

                elif self.CurrentAction[0] != "Delete" or self.CurrentAction[1] != event.GetPosition() + 1:

   265

                    self.Controler.EndBuffering()

   266

                    self.StartBuffering()

   267

                self.CurrentAction = ("Delete", event.GetPosition())

   268

                wx.CallAfter(self.RefreshModel)

   269

        event.Skip()

   270

   271

    def OnDoDrop(self, event):

   272

        try:

   273

            values = eval(event.GetDragText())

   274

        except:

   275

            values = event.GetDragText()

   276

        if isinstance(values, tuple):

   277

            message = None

   278

            if values[1] in ["program", "debug"]:

   279

                event.SetDragText("")

   280

            elif values[1] in ["functionBlock", "function"]:

   281

                blockname = values[2]

   282

                if len(values) > 3:

   283

                    blockinputs = values[3]

   284

                else:

   285

                    blockinputs = None

   286

                if values[1] != "function": 

   287

                    if  blockname == "":

   288

                        dialog = wx.TextEntryDialog(self.ParentWindow, "Block name", "Please enter a block name", "", wx.OK|wx.CANCEL|wx.CENTRE)

   289

                        if dialog.ShowModal() == wx.ID_OK:

   290

                            blockname = dialog.GetValue()

   291

                        else:

   292

                            return

   293

                        dialog.Destroy()

   294

                    if blockname.upper() in [name.upper() for name in self.Controler.GetProjectPouNames(self.Debug)]:

   295

                        message = _("\"%s\" pou already exists!")%blockname

   296

                    elif blockname.upper() in [name.upper() for name in self.Controler.GetEditedElementVariables(self.TagName, self.Debug)]:

   297

                        message = _("\"%s\" element for this pou already exists!")%blockname

   298

                    else:

   299

                        self.Controler.AddEditedElementPouVar(self.TagName, values[0], blockname)

   301

                        self.RefreshVariableTree()

   302

                blockinfo = self.Controler.GetBlockType(values[0], blockinputs, self.Debug)

   303

                hint = ',\n    '.join(

   304

                            [ " " + fctdecl[0]+" := (*"+fctdecl[1]+"*)" for fctdecl in blockinfo["inputs"]] +

   305

                            [ " " + fctdecl[0]+" => (*"+fctdecl[1]+"*)" for fctdecl in blockinfo["outputs"]])

   306

                event.SetDragText(blockname+"(\n    "+hint+")")

   307

            elif values[1] == "location":

   308

                pou_name, pou_type = self.Controler.GetEditedElementType(self.TagName, self.Debug)

   309

                if len(values) > 2 and pou_type == "program":

   310

                    var_name = values[3]

   311

                    if var_name.upper() in [name.upper() for name in self.Controler.GetProjectPouNames(self.Debug)]:

   312

                        message = _("\"%s\" pou already exists!")%var_name

   313

                    elif var_name.upper() in [name.upper() for name in self.Controler.GetEditedElementVariables(self.TagName, self.Debug)]:

   314

                        message = _("\"%s\" element for this pou already exists!")%var_name

   315

                    else:

   316

                        if values[2] is not None:

   317

                            var_type = values[2]

   318

                        else:

   319

                            var_type = LOCATIONDATATYPES.get(values[0][2], ["BOOL"])[0]

   320

                        self.Controler.AddEditedElementPouVar(self.TagName, var_type, var_name, values[0], values[4])

   322

                        self.RefreshVariableTree()

   323

                        event.SetDragText(var_name)

   324

                else:

   325

                    event.SetDragText("")

   326

            elif values[3] == self.TagName:

   327

                self.ResetBuffer()

   328

                event.SetDragText(values[0])

   329

                wx.CallAfter(self.RefreshModel)

   330

            else:

   331

                message = _("Variable don't belong to this POU!")

   332

            if message is not None:

   333

                dialog = wx.MessageDialog(self, message, _("Error"), wx.OK|wx.ICON_ERROR)

   334

                dialog.ShowModal()

   335

                dialog.Destroy()

   336

                event.SetDragText("")

   337

        event.Skip()

   338

   339

    def SetTextSyntax(self, syntax):

   340

        self.TextSyntax = syntax

   355

   356

    def SetKeywords(self, keywords):

   357

        self.Keywords = [keyword.upper() for keyword in keywords]

   358

        self.Colourise(0, -1)

   359

   360

    def RefreshJumpList(self):

   361

        if self.TextSyntax != "IL":

   362

            self.Jumps = [jump.upper() for jump in LABEL_MODEL.findall(self.GetText())]

   363

            self.Colourise(0, -1)

   364

   365

    # Buffer the last model state

   366

    def RefreshBuffer(self):

   367

        self.Controler.BufferProject()

   368

        if self.ParentWindow:

   369

            self.ParentWindow.RefreshTitle()

   370

            self.ParentWindow.RefreshFileMenu()

   371

            self.ParentWindow.RefreshEditMenu()

   372

   373

    def StartBuffering(self):

   374

        self.Controler.StartBuffering()

   375

        if self.ParentWindow:

   376

            self.ParentWindow.RefreshTitle()

   377

            self.ParentWindow.RefreshFileMenu()

   378

            self.ParentWindow.RefreshEditMenu()

   379

   380

    def ResetBuffer(self):

   381

        if self.CurrentAction != None:

   382

            self.Controler.EndBuffering()

   383

            self.CurrentAction = None

   384

   448

        self.Colourise(0, -1)

   449

   450

    def RefreshVariableTree(self):

   451

        words = self.TagName.split("::")

   452

        self.Variables = self.GenerateVariableTree([(variable["Name"], variable["Type"], variable["Tree"]) for variable in self.Controler.GetEditedElementInterfaceVars(self.TagName, self.Debug)])

   453

        if self.Controler.GetEditedElementType(self.TagName, self.Debug)[1] == "function" or words[0] == "T" and self.TextSyntax == "IL":

   454

            return_type = self.Controler.GetEditedElementInterfaceReturnType(self.TagName, self.Debug)

   455

            if return_type is not None:

   456

                var_tree, var_dimension = self.Controler.GenerateVarTree(return_type, self.Debug)

   457

                self.Variables[words[-1].upper()] = self.GenerateVariableTree(var_tree)

   458

            else:

   459

                self.Variables[words[-1].upper()] = {}

   460

   461

    def GenerateVariableTree(self, list):

   462

        tree = {}

   463

        for var_name, var_type, (var_tree, var_dimension) in list:

   464

            tree[var_name.upper()] = self.GenerateVariableTree(var_tree)

   465

        return tree

   466

   467

    def IsValidVariable(self, name, context):

   468

        return context is not None and context.get(name, None) is not None

   469

   470

    def IsCallParameter(self, name, call):

   471

        if call is not None:

   472

            return (call["interface"].get(name.upper(), None) is not None or 

   473

                    call["extensible"] and EXTENSIBLE_PARAMETER.match(name.upper()) is not None)

   474

        return False

   475

   476

    def RefreshLineFolding(self, line_number):

   480

            if line == "":

   481

                if line_number > 0:

   484

                    else:

   486

                if level != wx.stc.STC_FOLDLEVELBASE:

   487

                    level |=  wx.stc.STC_FOLDLEVELWHITEFLAG 

   489

                level |= wx.stc.STC_FOLDLEVELHEADERFLAG

   493

                else: