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

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

    32

#                         Textual programs Viewer class

    33

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

    34

    35

    36

NEWLINE = "\n"

    37

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

    38

LETTERS = ['_']

    39

for i in xrange(26):

    40

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

    41

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

    42

    43

[STC_PLC_WORD, STC_PLC_COMMENT, STC_PLC_NUMBER, STC_PLC_VARIABLE, 

    44

 STC_PLC_FUNCTION, STC_PLC_JUMP, STC_PLC_ERROR] = range(7)

    45

[SPACE, WORD, NUMBER, COMMENT] = range(4)

    46

    47

[ID_TEXTVIEWER,

    48

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

    49

    50

if wx.Platform == '__WXMSW__':

    51

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

    52

              'mono' : 'Courier New',

    53

              'helv' : 'Arial',

    54

              'other': 'Comic Sans MS',

    55

              'size' : 10,

    56

             }

    57

else:

    58

    faces = { 'times': 'Times',

    59

              'mono' : 'Courier',

    60

              'helv' : 'Helvetica',

    61

              'other': 'new century schoolbook',

    62

              'size' : 12,

    63

             }

    64

re_texts = {}

    65

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

    66

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

    67

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

    68

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

    69

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

    70

    71

def GetCursorPos(old, new):

    72

    old_length = len(old)

    73

    new_length = len(new)

    74

    common_length = min(old_length, new_length)

    75

    i = 0

    76

    for i in xrange(common_length):

    77

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

    78

            break

    79

    if old_length < new_length:

    80

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

    81

            return i + new_length - old_length

    82

        else:

    83

            return i + new_length - old_length + 1

    84

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

    85

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

    86

            return i

    87

        else:

    88

            return i + 1

    89

    else:

    90

        return None

    91

    92

    93

class TextViewer(wx.stc.StyledTextCtrl):

    94

    95

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

    96

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

    97

            if id is not None:

    98

                event(self, id, function)

    99

            else:

   100

                event(self, function)

   101

   102

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

   103

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

   104

   105

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

   106

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

   107

   108

        self.SetViewWhiteSpace(False)

   109

   110

        self.SetLexer(wx.stc.STC_LEX_CONTAINER)

   111

   112

        # Global default styles for all languages

   113

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

   114

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

   115

   116

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

   117

        self.SetSelBackground(1, "#E0E0E0")

   118

   119

        # Highlighting styles

   120

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

   121

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

   122

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

   123

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

   124

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

   125

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

   126

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

   127

   128

        # Indicators styles

   129

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

   130

        if window and controler:

   131

            self.IndicatorSetForeground(0, wx.RED)

   132

        else:

   133

            self.IndicatorSetForeground(0, wx.WHITE)

   134

   135

        # Line numbers in the margin

   136

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

   137

        self.SetMarginWidth(1, 50)

   138

   139

        # Indentation size

   140

        self.SetTabWidth(2)

   141

        self.SetUseTabs(0)

   142

   143

        self.Keywords = []

   144

        self.Variables = {}

   145

        self.Functions = []

   146

        self.Jumps = []

   147

        self.EnumeratedValues = []

   148

        self.DisableEvents = True

   149

        self.TextSyntax = "ST"

   150

        self.CurrentAction = None

   151

        self.TagName = tagname

   152

        self.Errors = []

   153

        self.Debug = debug

   154

        self.InstancePath = instancepath

   155

        self.StructElementsStack = []

   156

   157

        self.ParentWindow = window

   158

        self.Controler = controler

   159

   160

        self.SetModEventMask(wx.stc.STC_MOD_BEFOREINSERT|

   161

                             wx.stc.STC_MOD_BEFOREDELETE|

   162

                             wx.stc.STC_PERFORMED_USER)

   163

   164

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

   165

        if controler:

   166

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

   167

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

   168

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

   169

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

   170

   171

    def SetTagName(self, tagname):

   172

        self.TagName = tagname

   173

   174

    def GetTagName(self):

   175

        return self.TagName

   176

   177

    def GetInstancePath(self):

   178

        return self.InstancePath

   179

   180

    def IsViewing(self, tagname):

   181

        if self.Debug:

   182

            return self.InstancePath == tagname

   183

        else:

   184

            return self.TagName == tagname

   185

   186

    def IsDebugging(self):

   187

        return self.Debug

   188

   189

    def SetMode(self, mode):

   190

        pass

   191

   192

    def OnModification(self, event):

   193

        if not self.DisableEvents:

   194

            mod_type = event.GetModificationType()

   195

            if mod_type&wx.stc.STC_MOD_BEFOREINSERT:

   196

                if self.CurrentAction == None:

   197

                    self.StartBuffering()

   198

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

   199

                    self.Controler.EndBuffering()

   200

                    self.StartBuffering()

   201

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

   202

                wx.CallAfter(self.RefreshModel)

   203

            elif mod_type&wx.stc.STC_MOD_BEFOREDELETE:

   204

                if self.CurrentAction == None:

   205

                    self.StartBuffering()

   206

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

   207

                    self.Controler.EndBuffering()

   208

                    self.StartBuffering()

   209

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

   210

                wx.CallAfter(self.RefreshModel)

   211

        event.Skip()

   212

   213

    def OnDoDrop(self, event):

   214

        try:

   215

            values = eval(event.GetDragText())

   216

        except:

   217

            values = event.GetDragText()

   218

        if isinstance(values, tuple):

   219

            message = None

   221

                event.SetDragText("")

   249

            elif values[1] == "location":

   250

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

   251

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

   252

                    var_name = values[3]

   253

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

   254

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

   255

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

   256

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

   257

                    else:

   258

                        if values[2] is not None:

   259

                            var_type = values[2]

   260

                        else:

   261

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

   262

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

   263

                        self.ParentWindow.RefreshVariablePanel(self.TagName)

   264

                        self.RefreshVariableTree()

   265

                        event.SetDragText(var_name)

   266

                else:

   267

                    event.SetDragText("")

   268

            elif values[3] == self.TagName:

   269

                self.ResetBuffer()

   270

                event.SetDragText(values[0])

   271

                wx.CallAfter(self.RefreshModel)

   272

            else:

   273

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

   274

            if message is not None:

   275

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

   276

                dialog.ShowModal()

   277

                dialog.Destroy()

   278

                event.SetDragText("")

   279

        event.Skip()

   280

   281

    def SetTextSyntax(self, syntax):

   282

        self.TextSyntax = syntax

   283

   284

    def SetKeywords(self, keywords):

   285

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

   286

        self.Colourise(0, -1)

   287

   288

    def RefreshJumpList(self):

   289

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

   290

        self.Colourise(0, -1)

   291

   292

    # Buffer the last model state

   293

    def RefreshBuffer(self):

   294

        self.Controler.BufferProject()

   295

        if self.ParentWindow:

   296

            self.ParentWindow.RefreshTitle()

   297

            self.ParentWindow.RefreshFileMenu()

   298

            self.ParentWindow.RefreshEditMenu()

   299

   300

    def StartBuffering(self):

   301

        self.Controler.StartBuffering()

   302

        if self.ParentWindow:

   303

            self.ParentWindow.RefreshTitle()

   304

            self.ParentWindow.RefreshFileMenu()

   305

            self.ParentWindow.RefreshEditMenu()

   306

   307

    def ResetBuffer(self):

   308

        if self.CurrentAction != None:

   309

            self.Controler.EndBuffering()

   310

            self.CurrentAction = None

   311

   312

    def RefreshView(self):

   313

        self.ResetBuffer()

   314

        self.DisableEvents = True

   315

        old_cursor_pos = self.GetCurrentPos()

   316

        old_text = self.GetText()

   317

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

   318

        self.SetText(new_text)

   319

        new_cursor_pos = GetCursorPos(old_text, new_text)

   320

        if new_cursor_pos != None:

   321

            self.GotoPos(new_cursor_pos)

   322

        else:

   323

            self.GotoPos(old_cursor_pos)

   324

        self.ScrollToColumn(0)

   325

        self.RefreshJumpList()

   326

        self.EmptyUndoBuffer()

   327

        self.DisableEvents = False

   328

   329

        self.RefreshVariableTree()

   330

   331

        self.Functions = []

   332

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

   333

            for blocktype in category["list"]:

   334

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

   335

                    self.Functions.append(blocktype["name"].upper())

   336

   337

        self.EnumeratedValues = []

   338

        for value in self.Controler.GetEnumeratedDataValues():

   339

            self.EnumeratedValues.append(value.upper())

   340

   341

        self.Colourise(0, -1)

   342

   343

    def RefreshVariableTree(self):

   344

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

   345

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

   346

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

   347

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

   348

   349

    def GenerateVariableTree(self, list):

   350

        tree = {}

   351

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

   352

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

   353

        return tree

   354

   355

    def RefreshScaling(self, refresh=True):

   356

        pass

   357

   358

    def IsValidVariable(self, name_list, var_tree):

   359

        if len(name_list) == 0:

   360

            return True

   361

        else:

   362

            sub_tree = var_tree.get(name_list[0].upper(), None)

   363

            if sub_tree is not None:

   364

                return self.IsValidVariable(name_list[1:], sub_tree)

   365

        return False

   366

   367

    def OnStyleNeeded(self, event):

   368

        self.TextChanged = True

   369

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

   370

        if line == 0:

   371

            start_pos = last_styled_pos = 0

   372

        else:

   373

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

   374

        end_pos = event.GetPosition()

   375

        self.StartStyling(start_pos, 0xff)

   376

   377

        struct_elements = []

   378

   379

        current_pos = last_styled_pos

   380

        state = SPACE

   381

        line = ""

   382

        word = ""

   383

        while current_pos < end_pos:

   384

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

   385

            line += char

   386

            if char == NEWLINE:

   387

                if state == COMMENT:

   388

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

   389

                elif state == NUMBER:

   390

                    self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   391

                elif state == WORD:

   392

                    if word in self.Keywords:

   393

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_WORD)

   394

                    elif self.IsValidVariable(struct_elements + [word], self.Variables):

   395

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_VARIABLE)

   396

                    elif word in self.Functions:

   397

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_FUNCTION)

   398

                    elif word in self.Jumps:

   399

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_JUMP)

   400

                    elif word in self.EnumeratedValues:

   401

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   402

                    else:

   403

                        self.SetStyling(current_pos - last_styled_pos, 31)

   404

                        if word != "]" and (self.GetCurrentPos() < last_styled_pos or self.GetCurrentPos() > current_pos):

   405

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

   406

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

   407

                            self.StartStyling(current_pos, 0xff)

   408

                    struct_elements = []

   409

                else:

   410

                    self.SetStyling(current_pos - last_styled_pos, 31)

   411

                last_styled_pos = current_pos

   412

                state = SPACE

   413

                line = ""

   414

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

   415

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

   416

                last_styled_pos = current_pos

   417

                if state == WORD:

   418

                    struct_elements = []

   419

                state = COMMENT

   420

            elif state == COMMENT:

   421

                if line.endswith("*)"):

   422

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

   423

                    last_styled_pos = current_pos + 1

   424

                    state = SPACE

   425

            elif char in LETTERS:

   426

                if state == NUMBER:

   427

                    word = "#"

   428

                    state = WORD

   429

                elif state == SPACE:

   430

                    self.SetStyling(current_pos - last_styled_pos, 31)

   431

                    word = char

   432

                    last_styled_pos = current_pos

   433

                    state = WORD

   434

                else:

   435

                    word += char

   436

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

   437

                if state == SPACE:

   438

                    self.SetStyling(current_pos - last_styled_pos, 31)

   439

                    last_styled_pos = current_pos

   440

                    state = NUMBER

   441

                if state == WORD and char != '.':

   442

                    word += char

   443

            else:

   444

                if state == WORD:

   445

                    if word in self.Keywords:

   446

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_WORD)

   447

                    elif self.IsValidVariable(struct_elements + [word], self.Variables):

   448

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_VARIABLE)

   449

                    elif word in self.Functions:

   450

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_FUNCTION)

   451

                    elif word in self.Jumps:

   452

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_JUMP)

   453

                    elif word in self.EnumeratedValues:

   454

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   455

                    else:

   456

                        self.SetStyling(current_pos - last_styled_pos, 31)

   457

                        if word != "]" and (self.GetCurrentPos() < last_styled_pos or self.GetCurrentPos() > current_pos):

   458

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

   459

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

   460

                            self.StartStyling(current_pos, 0xff)

   461

                    if char == '.':

   462

                        if word != "]":

   463

                            struct_elements.append(word)

   464

                    else:

   465

                        if char == '[':

   466

                            self.StructElementsStack.append(struct_elements + [word])

   467

                        struct_elements = []

   468

                    word = ""

   469

                    last_styled_pos = current_pos

   470

                    state = SPACE

   471

                elif state == NUMBER:

   472

                    self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   473

                    last_styled_pos = current_pos

   474

                    state = SPACE

   475

                if char == ']':

   476

                    if len(self.StructElementsStack) > 0:

   477

                        struct_elements = self.StructElementsStack.pop()

   478

                    word = char

   479

                    state = WORD

   480

            current_pos += 1

   481

        if state == COMMENT:

   482

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

   483

        elif state == NUMBER:

   484

            self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   485

        elif state == WORD:

   486

            if word in self.Keywords:

   487

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_WORD)

   488

            elif self.IsValidVariable(struct_elements + [word], self.Variables):

   489

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_VARIABLE)

   490

            elif word in self.Functions:

   491

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_FUNCTION)

   492

            elif word in self.Jumps:

   493

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_JUMP)

   494

            elif word in self.EnumeratedValues:

   495