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

    32

    33

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

    34

#                         Textual programs Viewer class

    35

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

    36

    37

    38

NEWLINE = "\n"

    39

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

    40

LETTERS = ['_']

    41

for i in xrange(26):

    42

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

    43

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

    44

    45

[STC_PLC_WORD, STC_PLC_COMMENT, STC_PLC_NUMBER, STC_PLC_STRING, 

    46

 STC_PLC_VARIABLE, STC_PLC_PARAMETER, STC_PLC_FUNCTION, STC_PLC_JUMP, 

    47

 STC_PLC_ERROR, STC_PLC_SEARCH_RESULT] = range(10)

    48

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

    49

    50

[ID_TEXTVIEWER,

    51

] = [wx.NewId() for _init_ctrls in range(1)]

    52

    53

if wx.Platform == '__WXMSW__':

    54

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

    55

              'mono' : 'Courier New',

    56

              'helv' : 'Arial',

    57

              'other': 'Comic Sans MS',

    58

              'size' : 10,

    59

             }

    60

else:

    61

    faces = { 'times': 'Times',

    62

              'mono' : 'Courier',

    63

              'helv' : 'Helvetica',

    64

              'other': 'new century schoolbook',

    65

              'size' : 12,

    66

             }

    67

re_texts = {}

    68

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

    69

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

    70

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

    71

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

    72

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

    73

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

    74

    75

HIGHLIGHT_TYPES = {

    76

    ERROR_HIGHLIGHT: STC_PLC_ERROR,

    77

    SEARCH_RESULT_HIGHLIGHT: STC_PLC_SEARCH_RESULT,

    78

}

    79

    80

def GetCursorPos(old, new):

    81

    old_length = len(old)

    82

    new_length = len(new)

    83

    common_length = min(old_length, new_length)

    84

    i = 0

    85

    for i in xrange(common_length):

    86

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

    87

            break

    88

    if old_length < new_length:

    89

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

    90

            return i + new_length - old_length

    91

        else:

    92

            return i + new_length - old_length + 1

    93

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

    94

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

    95

            return i

    96

        else:

    97

            return i + 1

    98

    else:

    99

        return None

   100

   101

   102

class TextViewer(wx.stc.StyledTextCtrl):

   103

   104

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

   105

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

   106

            if id is not None:

   107

                event(self, id, function)

   108

            else:

   109

                event(self, function)

   110

   111

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

   112

        wx.stc.StyledTextCtrl.__init__(self, parent, ID_TEXTVIEWER, size=wx.Size(0, 0), style=0)

   113

   114

        self.CmdKeyAssign(ord('+'), wx.stc.STC_SCMOD_CTRL, wx.stc.STC_CMD_ZOOMIN)

   115

        self.CmdKeyAssign(ord('-'), wx.stc.STC_SCMOD_CTRL, wx.stc.STC_CMD_ZOOMOUT)

   116

   117

        self.SetViewWhiteSpace(False)

   118

   119

        self.SetLexer(wx.stc.STC_LEX_CONTAINER)

   120

   121

        # Global default styles for all languages

   122

        self.StyleSetSpec(wx.stc.STC_STYLE_DEFAULT, "face:%(mono)s,size:%(size)d" % faces)

   123

        self.StyleClearAll()  # Reset all to be like the default

   124

   125

        self.StyleSetSpec(wx.stc.STC_STYLE_LINENUMBER,  "back:#C0C0C0,size:%(size)d" % faces)

   126

        self.SetSelBackground(1, "#E0E0E0")

   127

   128

        # Highlighting styles

   129

        self.StyleSetSpec(STC_PLC_WORD, "fore:#00007F,bold,size:%(size)d" % faces)

   130

        self.StyleSetSpec(STC_PLC_VARIABLE, "fore:#7F0000,size:%(size)d" % faces)

   131

        self.StyleSetSpec(STC_PLC_PARAMETER, "fore:#7F007F,size:%(size)d" % faces)

   132

        self.StyleSetSpec(STC_PLC_FUNCTION, "fore:#7F7F00,size:%(size)d" % faces)

   133

        self.StyleSetSpec(STC_PLC_COMMENT, "fore:#7F7F7F,size:%(size)d" % faces)

   134

        self.StyleSetSpec(STC_PLC_NUMBER, "fore:#007F7F,size:%(size)d" % faces)

   135

        self.StyleSetSpec(STC_PLC_STRING, "fore:#007F00,size:%(size)d" % faces)

   136

        self.StyleSetSpec(STC_PLC_JUMP, "fore:#FF7FFF,size:%(size)d" % faces)

   137

        self.StyleSetSpec(STC_PLC_ERROR, "fore:#FF0000,back:#FFFF00,size:%(size)d" % faces)

   138

        self.StyleSetSpec(STC_PLC_SEARCH_RESULT, "fore:#FFFFFF,back:#FFA500,size:%(size)d" % faces)

   139

   140

        # Indicators styles

   141

        self.IndicatorSetStyle(0, wx.stc.STC_INDIC_SQUIGGLE)

   142

        if window and controler:

   143

            self.IndicatorSetForeground(0, wx.RED)

   144

        else:

   145

            self.IndicatorSetForeground(0, wx.WHITE)

   146

   147

        # Line numbers in the margin

   148

        self.SetMarginType(1, wx.stc.STC_MARGIN_NUMBER)

   149

        self.SetMarginWidth(1, 50)

   150

   151

        # Indentation size

   152

        self.SetTabWidth(2)

   153

        self.SetUseTabs(0)

   154

   155

        self.Keywords = []

   156

        self.Variables = {}

   157

        self.Functions = {}

   158

        self.TypeNames = []

   159

        self.Jumps = []

   160

        self.EnumeratedValues = []

   161

        self.DisableEvents = True

   162

        self.TextSyntax = "ST"

   163

        self.CurrentAction = None

   164

        self.TagName = tagname

   165

        self.Highlights = []

   166

        self.Debug = debug

   167

        self.InstancePath = instancepath

   168

        self.ContextStack = []

   169

        self.CallStack = []

   170

   171

        self.ParentWindow = window

   172

        self.Controler = controler

   173

   174

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

   175

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

   176

   177

        self.SetModEventMask(wx.stc.STC_MOD_BEFOREINSERT|

   178

                             wx.stc.STC_MOD_BEFOREDELETE|

   179

                             wx.stc.STC_PERFORMED_USER)

   180

   181

        self.Bind(wx.stc.EVT_STC_STYLENEEDED, self.OnStyleNeeded, id=ID_TEXTVIEWER)

   182

        if controler:

   183

            self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)

   184

            self.Bind(wx.stc.EVT_STC_DO_DROP, self.OnDoDrop, id=ID_TEXTVIEWER)

   185

            self.Bind(wx.EVT_KILL_FOCUS, self.OnKillFocus)

   186

            self.Bind(wx.stc.EVT_STC_MODIFIED, self.OnModification, id=ID_TEXTVIEWER)

   187

   188

    def __del__(self):

   189

        self.RefreshHighlightsTimer.Stop()

   190

   191

    def SetTagName(self, tagname):

   192

        self.TagName = tagname

   193

   194

    def GetTagName(self):

   195

        return self.TagName

   196

   197

    def GetInstancePath(self):

   198

        return self.InstancePath

   199

   200

    def IsViewing(self, tagname):

   201

        if self.Debug:

   202

            return self.InstancePath == tagname

   203

        else:

   204

            return self.TagName == tagname

   205

   206

    def IsDebugging(self):

   207

        return self.Debug

   208

   209

    def SetMode(self, mode):

   210

        pass

   211

   212

    def OnModification(self, event):

   213

        if not self.DisableEvents:

   214

            mod_type = event.GetModificationType()

   215

            if mod_type&wx.stc.STC_MOD_BEFOREINSERT:

   216

                if self.CurrentAction == None:

   217

                    self.StartBuffering()

   218

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

   219

                    self.Controler.EndBuffering()

   220

                    self.StartBuffering()

   221

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

   222

                wx.CallAfter(self.RefreshModel)

   223

            elif mod_type&wx.stc.STC_MOD_BEFOREDELETE:

   224

                if self.CurrentAction == None:

   225

                    self.StartBuffering()

   226

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

   227

                    self.Controler.EndBuffering()

   228

                    self.StartBuffering()

   229

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

   230

                wx.CallAfter(self.RefreshModel)

   231

        event.Skip()

   232

   233

    def OnDoDrop(self, event):

   234

        try:

   235

            values = eval(event.GetDragText())

   236

        except:

   237

            values = event.GetDragText()

   238

        if isinstance(values, tuple):

   239

            message = None

   240

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

   241

                event.SetDragText("")

   242

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

   243

                blockname = values[2]

   244

                if len(values) > 3:

   245

                    blockinputs = values[3]

   246

                else:

   247

                    blockinputs = None

   248

                if values[1] != "function": 

   249

                    if  blockname == "":

   250

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

   251

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

   252

                            blockname = dialog.GetValue()

   253

                        else:

   254

                            return

   255

                        dialog.Destroy()

   256

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

   257

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

   258

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

   259

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

   260

                    else:

   261

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

   262

                        self.ParentWindow.RefreshVariablePanel(self.TagName)

   263

                        self.RefreshVariableTree()

   264

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

   265

                hint = ',\n    '.join(

   266

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

   267

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

   268

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

   269

            elif values[1] == "location":

   270

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

   271

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

   272

                    var_name = values[3]

   273

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

   274

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

   275

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

   276

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

   277

                    else:

   278

                        if values[2] is not None:

   279

                            var_type = values[2]

   280

                        else:

   281

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

   282

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

   283

                        self.ParentWindow.RefreshVariablePanel(self.TagName)

   284

                        self.RefreshVariableTree()

   285

                        event.SetDragText(var_name)

   286

                else:

   287

                    event.SetDragText("")

   288

            elif values[3] == self.TagName:

   289

                self.ResetBuffer()

   290

                event.SetDragText(values[0])

   291

                wx.CallAfter(self.RefreshModel)

   292

            else:

   293

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

   294

            if message is not None:

   295

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

   296

                dialog.ShowModal()

   297

                dialog.Destroy()

   298

                event.SetDragText("")

   299

        event.Skip()

   300

   301

    def SetTextSyntax(self, syntax):

   302

        self.TextSyntax = syntax

   303

   304

    def SetKeywords(self, keywords):

   305

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

   306

        self.Colourise(0, -1)

   307

   308

    def RefreshJumpList(self):

   309

        if self.TextSyntax != "IL":

   310

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

   311

            self.Colourise(0, -1)

   312

   313

    # Buffer the last model state

   314

    def RefreshBuffer(self):

   315

        self.Controler.BufferProject()

   316

        if self.ParentWindow:

   317

            self.ParentWindow.RefreshTitle()

   318

            self.ParentWindow.RefreshFileMenu()

   319

            self.ParentWindow.RefreshEditMenu()

   320

   321

    def StartBuffering(self):

   322

        self.Controler.StartBuffering()

   323

        if self.ParentWindow:

   324

            self.ParentWindow.RefreshTitle()

   325

            self.ParentWindow.RefreshFileMenu()

   326

            self.ParentWindow.RefreshEditMenu()

   327

   328

    def ResetBuffer(self):

   329

        if self.CurrentAction != None:

   330

            self.Controler.EndBuffering()

   331

            self.CurrentAction = None

   332

   333

    def RefreshView(self):

   334

        self.ResetBuffer()

   335

        self.DisableEvents = True

   336

        old_cursor_pos = self.GetCurrentPos()

   337

        old_text = self.GetText()

   338

        new_text = self.Controler.GetEditedElementText(self.TagName, self.Debug)

   339

        self.SetText(new_text)

   340

        new_cursor_pos = GetCursorPos(old_text, new_text)

   341

        if new_cursor_pos != None:

   342

            self.GotoPos(new_cursor_pos)

   343

        else:

   344

            self.GotoPos(old_cursor_pos)

   345

        self.ScrollToColumn(0)

   346

        self.RefreshJumpList()

   347

        self.EmptyUndoBuffer()

   348

        self.DisableEvents = False

   349

   350

        self.RefreshVariableTree()

   351

   352

        self.TypeNames = [typename.upper() for typename in self.Controler.GetDataTypes(self.TagName, True, self.Debug)]

   353

        self.EnumeratedValues = [value.upper() for value in self.Controler.GetEnumeratedDataValues()]

   354

   355

        self.Functions = {}

   356

        for category in self.Controler.GetBlockTypes(self.TagName, self.Debug):

   357

            for blocktype in category["list"]:

   358

                blockname = blocktype["name"].upper()

   359

                if blocktype["type"] == "function" and blockname not in self.Keywords and blockname not in self.Variables.keys():

   360

                    interface = dict([(name, {}) for name, type, modifier in blocktype["inputs"] + blocktype["outputs"] if name != ''])

   361

                    for param in ["EN", "ENO"]:

   362

                        if not interface.has_key(param):

   363

                            interface[param] = {}

   364

                    if self.Functions.has_key(blockname):

   365

                        self.Functions[blockname]["interface"].update(interface)

   366

                        self.Functions[blockname]["extensible"] |= blocktype["extensible"]

   367

                    else:

   368

                        self.Functions[blockname] = {"interface": interface,

   369

                                                     "extensible": blocktype["extensible"]}

   370

        self.Colourise(0, -1)

   371

   372

    def RefreshVariableTree(self):

   373

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

   374

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

   375

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

   376

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

   377

            if return_type is not None:

   378

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

   379

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

   380

            else:

   381

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

   382

   383

    def GenerateVariableTree(self, list):

   384

        tree = {}

   385

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

   386

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

   387

        return tree

   388

   389

    def RefreshScaling(self, refresh=True):

   390

        pass

   391

   392

    def IsValidVariable(self, name, context):

   393

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

   394

   395

    def IsCallParameter(self, name, call):

   396

        if call is not None:

   397

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

   398

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

   399

        return False

   400

   401

    def OnStyleNeeded(self, event):

   402

        self.TextChanged = True

   403

        line = self.LineFromPosition(self.GetEndStyled())

   404

        if line == 0:

   405

            start_pos = last_styled_pos = 0

   406

        else:

   407

            start_pos = last_styled_pos = self.GetLineEndPosition(line - 1) + 1

   408

        end_pos = event.GetPosition()

   409

        self.StartStyling(start_pos, 0xff)

   410

   411

        current_context = self.Variables

   412

        current_call = None

   413

   414

        current_pos = last_styled_pos

   415

        state = SPACE

   416

        line = ""

   417

        word = ""

   418

        while current_pos < end_pos:

   419

            char = chr(self.GetCharAt(current_pos)).upper()

   420

            line += char

   421

            if char == NEWLINE:

   422

                self.ContextStack = []

   423

                current_context = self.Variables

   424

                if state == COMMENT:

   425

                    self.SetStyling(current_pos - last_styled_pos + 1, STC_PLC_COMMENT)

   426

                elif state == NUMBER:

   427

                    self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   428

                elif state == WORD:

   429

                    if word in self.Keywords or word in self.TypeNames:

   430

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_WORD)

   431

                    elif self.IsValidVariable(word, current_context):

   432

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_VARIABLE)

   433

                    elif self.IsCallParameter(word, current_call):

   434

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_PARAMETER)

   435

                    elif word in self.Functions:

   436

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_FUNCTION)

   437

                    elif self.TextSyntax == "IL" and word in self.Jumps:

   438

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_JUMP)

   439

                    elif word in self.EnumeratedValues:

   440

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   441

                    else:

   442

                        self.SetStyling(current_pos - last_styled_pos, 31)

   443

                        if word not in ["]", ")"] and (self.GetCurrentPos() < last_styled_pos or self.GetCurrentPos() > current_pos):

   444

                            self.StartStyling(last_styled_pos, wx.stc.STC_INDICS_MASK)

   445

                            self.SetStyling(current_pos - last_styled_pos, wx.stc.STC_INDIC0_MASK)

   446

                            self.StartStyling(current_pos, 0xff)

   447

                else:

   448

                    self.SetStyling(current_pos - last_styled_pos, 31)

   449

                last_styled_pos = current_pos

   450

                state = SPACE

   451

                line = ""

   452

            elif line.endswith("(*") and state != COMMENT:

   453

                self.SetStyling(current_pos - last_styled_pos - 1, 31)

   454

                last_styled_pos = current_pos

   455

                if state == WORD:

   456

                    current_context = self.Variables

   457

                state = COMMENT

   458

            elif state == COMMENT:

   459

                if line.endswith("*)"):

   460

                    self.SetStyling(current_pos - last_styled_pos + 2, STC_PLC_COMMENT)

   461

                    last_styled_pos = current_pos + 1

   462

                    state = SPACE

   463

            elif (line.endswith("'") or line.endswith('"')) and state not in [COMMENT, STRING, WSTRING]:

   464

                self.SetStyling(current_pos - last_styled_pos, 31)

   465

                last_styled_pos = current_pos

   466

                if state == WORD:

   467

                    current_context = self.Variables

   468

                if line.endswith("'"):

   469

                    state = STRING

   470

                else:

   471

                    state = WSTRING

   472

            elif state == STRING:

   473

                if line.endswith("'") and not line.endswith("$'"):

   474

                    self.SetStyling(current_pos - last_styled_pos + 1, STC_PLC_STRING)

   475

                    last_styled_pos = current_pos + 1

   476

                    state = SPACE

   477

            elif state == WSTRING:

   478

                if line.endswith('"') and not line.endswith('$"'):

   479

                    self.SetStyling(current_pos - last_styled_pos + 1, STC_PLC_STRING)

   480

                    last_styled_pos = current_pos + 1

   481

                    state = SPACE

   482

            elif char in LETTERS:

   483

                if state == NUMBER:

   484

                    word = "#"

   485

                    state = WORD

   486

                elif state == SPACE:

   487

                    self.SetStyling(current_pos - last_styled_pos, 31)

   488

                    word = char

   489

                    last_styled_pos = current_pos

   490

                    state = WORD

   491

                else:

   492

                    word += char

   493

            elif char in NUMBERS or char == '.' and state != WORD:

   494