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 = []

   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

   156

   157

        self.ParentWindow = window

   158

        self.Controler = controler

   159

   160

        self.SetModEventMask(wx.stc.STC_MOD_BEFOREINSERT|wx.stc.STC_MOD_BEFOREDELETE)

   161

   162

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

   163

        if controler:

   164

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

   165

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

   166

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

   167

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

   168

   169

    def SetTagName(self, tagname):

   170

        self.TagName = tagname

   171

   172

    def GetTagName(self):

   173

        return self.TagName

   174

   175

    def GetInstancePath(self):

   176

        return self.InstancePath

   177

   178

    def IsViewing(self, tagname):

   179

        if self.Debug:

   180

            return self.InstancePath == tagname

   181

        else:

   182

            return self.TagName == tagname

   183

   184

    def SetMode(self, mode):

   185

        pass

   186

   187

    def OnModification(self, event):

   188

        if not self.DisableEvents:

   189

            mod_type = event.GetModificationType()

   190

            if not (mod_type&wx.stc.STC_PERFORMED_UNDO or mod_type&wx.stc.STC_PERFORMED_REDO):

   191

                if mod_type&wx.stc.STC_MOD_BEFOREINSERT:

   192

                    if self.CurrentAction == None:

   193

                        self.StartBuffering()

   194

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

   195

                        self.Controler.EndBuffering()

   196

                        self.StartBuffering()

   197

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

   198

                elif mod_type&wx.stc.STC_MOD_BEFOREDELETE:

   199

                    if self.CurrentAction == None:

   200

                        self.StartBuffering()

   201

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

   202

                        self.Controler.EndBuffering()

   203

                        self.StartBuffering()

   204

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

   205

        event.Skip()

   206

   207

    def OnDoDrop(self, event):

   208

        try:

   209

            values = eval(event.GetDragText())

   210

        except:

   211

            values = event.GetDragText()

   212

        if isinstance(values, tuple):

   213

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

   214

                event.SetDragText("")

   215

            elif values[1] == "function":

   216

                event.SetDragText(values[0])

   217

            elif values[1] != "location":

   218

                if values[3] == self.TagName:

   219

                    self.ResetBuffer()

   220

                    event.SetDragText(values[0])

   221

                    wx.CallAfter(self.RefreshModel)

   222

                else:

   223

                    event.SetDragText("")

   224

                    message = wx.MessageDialog(self.ParentWindow, "Variable don't belong to this POU!", "Error", wx.OK|wx.ICON_ERROR)

   225

                    message.ShowModal()

   226

                    message.Destroy()

   227

        event.Skip()

   228

   229

    def SetTextSyntax(self, syntax):

   230

        self.TextSyntax = syntax

   231

   232

    def SetKeywords(self, keywords):

   233

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

   234

        self.Colourise(0, -1)

   235

   236

    def RefreshJumpList(self):

   237

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

   238

        self.Colourise(0, -1)

   239

   240

    # Buffer the last model state

   241

    def RefreshBuffer(self):

   242

        self.Controler.BufferProject()

   243

        if self.ParentWindow:

   244

            self.ParentWindow.RefreshTitle()

   245

            self.ParentWindow.RefreshEditMenu()

   246

   247

    def StartBuffering(self):

   248

        self.Controler.StartBuffering()

   249

        if self.ParentWindow:

   250

            self.ParentWindow.RefreshTitle()

   251

            self.ParentWindow.RefreshEditMenu()

   252

   253

    def ResetBuffer(self):

   254

        if self.CurrentAction != None:

   255

            self.Controler.EndBuffering()

   256

            self.CurrentAction = None

   257

   258

    def RefreshView(self):

   259

        self.ResetBuffer()

   260

        self.DisableEvents = True

   261

        old_cursor_pos = self.GetCurrentPos()

   262

        old_text = self.GetText()

   263

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

   264

        self.SetText(new_text)

   265

        new_cursor_pos = GetCursorPos(old_text, new_text)

   266

        if new_cursor_pos != None:

   267

            self.GotoPos(new_cursor_pos)

   268

        else:

   269

            self.GotoPos(old_cursor_pos)

   270

        self.ScrollToColumn(0)

   271

        self.RefreshJumpList()

   272

        self.EmptyUndoBuffer()

   273

        self.DisableEvents = False

   274

   275

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

   278

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

   280

   281

        self.Functions = []

   282

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

   283

            for blocktype in category["list"]:

   285

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

   286

   287

        self.EnumeratedValues = []

   288

        for value in self.Controler.GetEnumeratedDataValues():

   289

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

   290

   291

        self.Colourise(0, -1)

   292

   293

    def RefreshScaling(self, refresh=True):

   294

        pass

   295

   305

    def OnStyleNeeded(self, event):

   306

        self.TextChanged = True

   307

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

   308

        if line == 0:

   309

            start_pos = last_styled_pos = 0

   310

        else:

   311

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

   312

        end_pos = event.GetPosition()

   313

        self.StartStyling(start_pos, 0xff)

   314

   317

        current_pos = last_styled_pos

   318

        state = SPACE

   319

        line = ""

   320

        word = ""

   321

        while current_pos < end_pos:

   322

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

   323

            line += char

   324

            if char == NEWLINE:

   325

                if state == COMMENT:

   326

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

   327

                elif state == NUMBER:

   328

                    self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   329

                elif state == WORD:

   330

                    if word in self.Keywords:

   331

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_WORD)

   333

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_VARIABLE)

   334

                    elif word in self.Functions:

   335

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_FUNCTION)

   336

                    elif word in self.Jumps:

   337

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_JUMP)

   338

                    elif word in self.EnumeratedValues:

   339

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   340

                    else:

   341

                        self.SetStyling(current_pos - last_styled_pos, 31)

   343

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

   344

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

   345

                            self.StartStyling(current_pos, 0xff)

   347

                else:

   348

                    self.SetStyling(current_pos - last_styled_pos, 31)

   349

                last_styled_pos = current_pos

   350

                state = SPACE

   351

                line = ""

   352

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

   353

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

   354

                last_styled_pos = current_pos

   357

                state = COMMENT

   358

            elif state == COMMENT:

   359

                if line.endswith("*)"):

   360

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

   361

                    last_styled_pos = current_pos + 1

   362

                    state = SPACE

   363

            elif char in LETTERS:

   364

                if state == NUMBER:

   365

                    word = "#"

   366

                    state = WORD

   367

                elif state == SPACE:

   368

                    self.SetStyling(current_pos - last_styled_pos, 31)

   369

                    word = char

   370

                    last_styled_pos = current_pos

   371

                    state = WORD

   372

                else:

   373

                    word += char

   374

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

   375

                if state == SPACE:

   376

                    self.SetStyling(current_pos - last_styled_pos, 31)

   377

                    last_styled_pos = current_pos

   378

                    state = NUMBER

   379

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

   380

                    word += char

   381

            else:

   382

                if state == WORD:

   383

                    if word in self.Keywords:

   384

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_WORD)

   386

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_VARIABLE)

   387

                    elif word in self.Functions:

   388

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_FUNCTION)

   389

                    elif word in self.Jumps:

   390

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_JUMP)

   391

                    elif word in self.EnumeratedValues:

   392

                        self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   393

                    else:

   394

                        self.SetStyling(current_pos - last_styled_pos, 31)

   396

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

   397

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

   398

                            self.StartStyling(current_pos, 0xff)

   406

                    word = ""

   407

                    last_styled_pos = current_pos

   408

                    state = SPACE

   409

                elif state == NUMBER:

   410

                    self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   411

                    last_styled_pos = current_pos

   412

                    state = SPACE

   417

            current_pos += 1

   418

        if state == COMMENT:

   419

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

   420

        elif state == NUMBER:

   421

            self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   422

        elif state == WORD:

   423

            if word in self.Keywords:

   424

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_WORD)

   426

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_VARIABLE)

   427

            elif word in self.Functions:

   428

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_FUNCTION)

   429

            elif word in self.Jumps:

   430

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_JUMP)

   431

            elif word in self.EnumeratedValues:

   432

                self.SetStyling(current_pos - last_styled_pos, STC_PLC_NUMBER)

   433

            else:

   434

                self.SetStyling(current_pos - last_styled_pos, 31)

   435

        else:

   436

            self.SetStyling(current_pos - start_pos, 31)

   437

        self.ShowErrors(start_pos, end_pos)

   438

        event.Skip()

   439

   440

    def Cut(self):

   441

        self.ResetBuffer()

   442

        self.CmdKeyExecute(wx.stc.STC_CMD_CUT)

   443

        self.RefreshModel()

   444

        self.RefreshBuffer()

   445

   446

    def Copy(self):

   447

        self.CmdKeyExecute(wx.stc.STC_CMD_COPY)

   448

   449

    def Paste(self):

   450

        self.ResetBuffer()

   451

        self.CmdKeyExecute(wx.stc.STC_CMD_PASTE)

   452

        self.RefreshModel()

   453

        self.RefreshBuffer()

   454

   455

    def RefreshModel(self):

   456

        self.RefreshJumpList()

   457

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

   458

   459

    def OnKeyDown(self, event):

   460

        if self.CallTipActive():

   461

            self.CallTipCancel()

   462

        key = event.GetKeyCode()

   463

   464

        # Code completion

   465

        if key == wx.WXK_SPACE and event.ControlDown():

   466

   467

            line = self.GetCurrentLine()

   468

            if line == 0:

   469

                start_pos = 0

   470

            else:

   471

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

   472

            end_pos = self.GetCurrentPos()

   473

   474

            lineText = self.GetTextRange(start_pos, end_pos).replace("\t", " ")

   475

            words = lineText.split(" ")

   476

            words = [word for i, word in enumerate(words) if word != '' or i == len(words) - 1]

   477

   478

            kw = []

   479

   480

            if self.TextSyntax == "IL":

   481

                if len(words) == 1:

   482

                    kw = self.Keywords

   483

                elif len(words) == 2:

   484

                    if words[0].upper() in ["CAL", "CALC", "CALNC"]:

   485

                        kw = self.Functions

   486

                    elif words[0].upper() in ["JMP", "JMPC", "JMPNC"]:

   487

                        kw = self.Jumps

   488

                    else:

   492

            if len(kw) > 0:

   493

                kw.sort()

   494

                self.AutoCompSetIgnoreCase(True)

   495

                self.AutoCompShow(len(words[-1]), " ".join(kw))

   496

        else:

   497