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

   220

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

   221

                event.SetDragText("")

   222

            elif values[1] == "function":

   223

                event.SetDragText(values[0])

   224

            elif values[1] == "location":

   225

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

   226

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

   227

                    var_name = values[3]

   228

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

   229

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

   230

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

   231

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

   232

                    else:

   233

                        if values[2] is not None:

   234

                            var_type = values[2]

   235

                        else:

   236

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

   237

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

   238

                        self.ParentWindow.RefreshVariablePanel(self.TagName)

   239

                        self.RefreshVariableTree()

   240

                        event.SetDragText(var_name)

   241

                else:

   242

                    event.SetDragText("")

   243

            elif values[3] == self.TagName:

   244

                self.ResetBuffer()

   245

                event.SetDragText(values[0])

   246

                wx.CallAfter(self.RefreshModel)

   247

            else:

   248

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

   249

            if message is not None:

   250

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

   251

                dialog.ShowModal()

   252

                dialog.Destroy()

   253

                event.SetDragText("")

   254

        event.Skip()

   255

   256

    def SetTextSyntax(self, syntax):

   257

        self.TextSyntax = syntax

   258

   259

    def SetKeywords(self, keywords):

   260

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

   261

        self.Colourise(0, -1)

   262

   263

    def RefreshJumpList(self):

   264

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

   265

        self.Colourise(0, -1)

   266

   267

    # Buffer the last model state

   268

    def RefreshBuffer(self):

   269

        self.Controler.BufferProject()

   270

        if self.ParentWindow:

   271

            self.ParentWindow.RefreshTitle()

   272

            self.ParentWindow.RefreshEditMenu()

   273

   274

    def StartBuffering(self):

   275

        self.Controler.StartBuffering()

   276

        if self.ParentWindow:

   277

            self.ParentWindow.RefreshTitle()

   278

            self.ParentWindow.RefreshEditMenu()

   279

   280

    def ResetBuffer(self):

   281

        if self.CurrentAction != None:

   282

            self.Controler.EndBuffering()

   283

            self.CurrentAction = None

   284

   285

    def RefreshView(self):

   286

        self.ResetBuffer()

   287

        self.DisableEvents = True

   288

        old_cursor_pos = self.GetCurrentPos()

   289

        old_text = self.GetText()

   290

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

   291

        self.SetText(new_text)

   292

        new_cursor_pos = GetCursorPos(old_text, new_text)

   293

        if new_cursor_pos != None:

   294

            self.GotoPos(new_cursor_pos)

   295

        else:

   296

            self.GotoPos(old_cursor_pos)

   297

        self.ScrollToColumn(0)

   298

        self.RefreshJumpList()

   299

        self.EmptyUndoBuffer()

   300

        self.DisableEvents = False

   301

   302

        self.RefreshVariableTree()

   303

   304

        self.Functions = []

   305

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

   306

            for blocktype in category["list"]:

   307

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

   308

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

   309

   310

        self.EnumeratedValues = []

   311

        for value in self.Controler.GetEnumeratedDataValues():

   312

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

   313

   314

        self.Colourise(0, -1)

   315

   316

    def RefreshVariableTree(self):

   317

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

   318

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

   319

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

   320

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

   321

   322

    def GenerateVariableTree(self, list):

   323

        tree = {}

   324

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

   325

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

   326

        return tree

   327

   328

    def RefreshScaling(self, refresh=True):

   329

        pass

   330

   331

    def IsValidVariable(self, name_list, var_tree):

   332

        if len(name_list) == 0:

   333

            return True

   334

        else:

   335

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

   336

            if sub_tree is not None:

   337

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

   338

        return False

   339

   340

    def OnStyleNeeded(self, event):

   341

        self.TextChanged = True

   342

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

   343

        if line == 0:

   344

            start_pos = last_styled_pos = 0

   345

        else:

   346

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

   347

        end_pos = event.GetPosition()

   348

        self.StartStyling(start_pos, 0xff)

   349

   350

        struct_elements = []

   351

   352

        current_pos = last_styled_pos

   353

        state = SPACE

   354

        line = ""

   355

        word = ""

   356

        while current_pos < end_pos:

   357

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

   358

            line += char

   359

            if char == NEWLINE:

   360

                if state == COMMENT:

   361

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

   362

                elif state == NUMBER:

   363

                    self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   364

                elif state == WORD:

   365

                    if word in self.Keywords:

   366

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_WORD)

   367

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

   368

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_VARIABLE)

   369

                    elif word in self.Functions:

   370

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_FUNCTION)

   371

                    elif word in self.Jumps:

   372

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_JUMP)

   373

                    elif word in self.EnumeratedValues:

   374

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   375

                    else:

   376

                        self.SetStyling(current_pos - last_styled_pos, 31)

   377

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

   378

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

   379

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

   380

                            self.StartStyling(current_pos, 0xff)

   381

                    struct_elements = []

   382

                else:

   383

                    self.SetStyling(current_pos - last_styled_pos, 31)

   384

                last_styled_pos = current_pos

   385

                state = SPACE

   386

                line = ""

   387

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

   388

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

   389

                last_styled_pos = current_pos

   390

                if state == WORD:

   391

                    struct_elements = []

   392

                state = COMMENT

   393

            elif state == COMMENT:

   394

                if line.endswith("*)"):

   395

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

   396

                    last_styled_pos = current_pos + 1

   397

                    state = SPACE

   398

            elif char in LETTERS:

   399

                if state == NUMBER:

   400

                    word = "#"

   401

                    state = WORD

   402

                elif state == SPACE:

   403

                    self.SetStyling(current_pos - last_styled_pos, 31)

   404

                    word = char

   405

                    last_styled_pos = current_pos

   406

                    state = WORD

   407

                else:

   408

                    word += char

   409

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

   410

                if state == SPACE:

   411

                    self.SetStyling(current_pos - last_styled_pos, 31)

   412

                    last_styled_pos = current_pos

   413

                    state = NUMBER

   414

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

   415

                    word += char

   416

            else:

   417

                if state == WORD:

   418

                    if word in self.Keywords:

   419

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_WORD)

   420

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

   421

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_VARIABLE)

   422

                    elif word in self.Functions:

   423

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_FUNCTION)

   424

                    elif word in self.Jumps:

   425

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_JUMP)

   426

                    elif word in self.EnumeratedValues:

   427

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   428

                    else:

   429

                        self.SetStyling(current_pos - last_styled_pos, 31)

   430

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

   431

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

   432

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

   433

                            self.StartStyling(current_pos, 0xff)

   434

                    if char == '.':

   435

                        if word != "]":

   436

                            struct_elements.append(word)

   437

                    else:

   438

                        if char == '[':

   439

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

   440

                        struct_elements = []

   441

                    word = ""

   442

                    last_styled_pos = current_pos

   443

                    state = SPACE

   444

                elif state == NUMBER:

   445

                    self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   446

                    last_styled_pos = current_pos

   447

                    state = SPACE

   448

                if char == ']':

   449

                    if len(self.StructElementsStack) > 0:

   450

                        struct_elements = self.StructElementsStack.pop()

   451

                    word = char

   452

                    state = WORD

   453

            current_pos += 1

   454

        if state == COMMENT:

   455

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

   456

        elif state == NUMBER:

   457

            self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   458

        elif state == WORD:

   459

            if word in self.Keywords:

   460

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_WORD)

   461

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

   462

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_VARIABLE)

   463

            elif word in self.Functions:

   464

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_FUNCTION)

   465

            elif word in self.Jumps:

   466

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_JUMP)

   467

            elif word in self.EnumeratedValues:

   468

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   469

            else:

   470

                self.SetStyling(current_pos - last_styled_pos, 31)

   471

        else:

   472

            self.SetStyling(current_pos - start_pos, 31)

   473

        self.ShowErrors(start_pos, end_pos)

   474

        event.Skip()

   475

   476

    def Cut(self):

   477

        self.ResetBuffer()

   478

        self.CmdKeyExecute(wx.stc.STC_CMD_CUT)

   479

        self.RefreshModel()

   480

        self.RefreshBuffer()

   481

   482

    def Copy(self):

   483

        self.CmdKeyExecute(wx.stc.STC_CMD_COPY)

   484

   485

    def Paste(self):

   486

        self.ResetBuffer()

   487

        self.CmdKeyExecute(wx.stc.STC_CMD_PASTE)

   488

        self.RefreshModel()

   489

        self.RefreshBuffer()

   490

   491

    def RefreshModel(self):

   492

        self.RefreshJumpList()

   493

        self.Controler.SetEditedElementText(self.TagName, self.GetText())

   494