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] = range(6)

    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

if wx.VERSION >= (2, 8, 0):

    93

    import wx.aui

    94

    95

    class TextMDIViewer(wx.aui.AuiMDIChildFrame):

    96

        def __init__(self, parent, tagname, window, controler):

    97

            wx.aui.AuiMDIChildFrame.__init__(self, parent, -1, title = "")

    98

    99

            sizer = wx.BoxSizer(wx.HORIZONTAL)

   100

   101

            self.Viewer = TextViewer(self, tagname, window, controler)

   102

   103

            sizer.AddWindow(self.Viewer, 1, border=0, flag=wx.GROW)

   104

   105

            self.SetSizer(sizer)

   106

   107

        def GetViewer(self):

   108

            return self.Viewer

   109

   110

class TextViewer(wx.stc.StyledTextCtrl):

   111

   112

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

   113

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

   114

            if id is not None:

   115

                event(self, id, function)

   116

            else:

   117

                event(self, function)

   118

   119

    def __init__(self, parent, tagname, window, controler):

   120

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

   121

   122

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

   123

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

   124

   125

        self.SetViewWhiteSpace(False)

   126

   127

        self.SetLexer(wx.stc.STC_LEX_CONTAINER)

   128

   129

        # Global default styles for all languages

   130

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

   131

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

   132

   133

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

   134

        self.SetSelBackground(1, "#E0E0E0")

   135

   136

        # Highlighting styles

   137

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

   138

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

   139

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

   140

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

   141

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

   142

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

   143

   144

        # Indicators styles

   145

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

   146

        if window and controler:

   147

            self.IndicatorSetForeground(0, wx.RED)

   148

        else:

   149

            self.IndicatorSetForeground(0, wx.WHITE)

   150

   151

        # Line numbers in the margin

   152

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

   153

        self.SetMarginWidth(1, 50)

   154

   155

        # Indentation size

   156

        self.SetTabWidth(2)

   157

        self.SetUseTabs(0)

   158

   159

        self.Keywords = []

   160

        self.Variables = []

   161

        self.Functions = []

   162

        self.Jumps = []

   164

        self.TextChanged = False

   165

        self.DisableEvents = True

   166

        self.TextSyntax = "ST"

   167

        self.CurrentAction = None

   168

        self.TagName = tagname

   169

   170

        self.ParentWindow = window

   171

        self.Controler = controler

   172

   173

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

   174

   175

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

   176

        if controler:

   177

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

   178

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

   179

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

   180

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

   181

   182

    def SetTagName(self, tagname):

   183

        self.TagName = tagname

   184

   185

    def GetTagName(self):

   186

        return self.TagName

   187

   188

    def IsViewing(self, tagname):

   189

        return self.TagName == tagname

   190

   191

    def SetMode(self, mode):

   192

        pass

   193

   194

    def OnModification(self, event):

   195

        if not self.DisableEvents:

   196

            mod_type = event.GetModificationType()

   197

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

   198

                if mod_type&wx.stc.STC_MOD_BEFOREINSERT:

   199

                    if self.CurrentAction == None:

   200

                        self.StartBuffering()

   201

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

   202

                        self.Controler.EndBuffering()

   203

                        self.StartBuffering()

   204

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

   205

                elif mod_type&wx.stc.STC_MOD_BEFOREDELETE:

   206

                    if self.CurrentAction == None:

   207

                        self.StartBuffering()

   208

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

   209

                        self.Controler.EndBuffering()

   210

                        self.StartBuffering()

   211

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

   212

        event.Skip()

   213

   214

    def OnDoDrop(self, event):

   215

        try:

   216

            values = eval(event.GetDragText())

   217

        except:

   218

            values = event.GetDragText()

   219

        if isinstance(values, tuple):

   220

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

   221

                event.SetDragText("")

   222

            elif values[1] == "function":

   223

                event.SetDragText(values[0])

   224

            elif values[1] != "location":

   225

                if values[3] == self.TagName:

   226

                    event.SetDragText(values[0])

   227

                else:

   228

                    event.SetDragText("")

   229

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

   230

                    message.ShowModal()

   231

                    message.Destroy()

   232

        event.Skip()

   233

   234

    def SetTextSyntax(self, syntax):

   235

        self.TextSyntax = syntax

   236

   237

    def SetKeywords(self, keywords):

   238

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

   239

        self.Colourise(0, -1)

   240

   241

    def RefreshJumpList(self):

   242

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

   243

        self.Colourise(0, -1)

   244

   245

    # Buffer the last model state

   246

    def RefreshBuffer(self):

   247

        self.Controler.BufferProject()

   248

        if self.ParentWindow:

   249

            self.ParentWindow.RefreshTitle()

   250

            self.ParentWindow.RefreshEditMenu()

   251

   252

    def StartBuffering(self):

   253

        self.Controler.StartBuffering()

   254

        if self.ParentWindow:

   255

            self.ParentWindow.RefreshTitle()

   256

            self.ParentWindow.RefreshEditMenu()

   257

   258

    def ResetBuffer(self):

   259

        if self.CurrentAction != None:

   260

            self.Controler.EndBuffering()

   261

            self.CurrentAction = None

   262

   263

    def RefreshView(self):

   264

        self.ResetBuffer()

   265

        self.DisableEvents = True

   266

        old_cursor_pos = self.GetCurrentPos()

   267

        old_text = self.GetText()

   268

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

   269

        self.SetText(new_text)

   270

        new_cursor_pos = GetCursorPos(old_text, new_text)

   271

        if new_cursor_pos != None:

   272

            self.GotoPos(new_cursor_pos)

   273

        else:

   274

            self.GotoPos(old_cursor_pos)

   275

        self.ScrollToColumn(0)

   276

        self.RefreshJumpList()

   277

        self.EmptyUndoBuffer()

   278

        self.DisableEvents = False

   279

   280

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

   281

        self.Variables = [variable["Name"].upper() for variable in self.Controler.GetEditedElementInterfaceVars(self.TagName)]

   282

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

   283

            self.Variables.append(words[-1].upper())

   284

   285

        self.Functions = []

   286

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

   287

            for blocktype in category["list"]:

   288

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

   289

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

   290

   295

        self.Colourise(0, -1)

   296

   297

    def OnStyleNeeded(self, event):

   298

        self.TextChanged = True

   299

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

   300

        if line == 0:

   301

            start_pos = 0

   302

        else:

   303

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

   304

        end_pos = event.GetPosition()

   305

        self.StartStyling(start_pos, 0xff)

   306

   307

        i = start_pos

   308

        state = SPACE

   309

        line = ""

   310

        word = ""

   311

        while i < end_pos:

   312

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

   313

            line += char

   314

            if char == NEWLINE:

   315

                if state == COMMENT:

   316

                    self.SetStyling(i - start_pos + 1, STC_PLC_COMMENT)

   317

                elif state == NUMBER:

   318

                    self.SetStyling(i - start_pos, STC_PLC_NUMBER)

   319

                elif state == WORD:

   320

                    if word in self.Keywords:

   321

                        self.SetStyling(i - start_pos, STC_PLC_WORD)

   322

                    elif word in self.Variables:

   323

                        self.SetStyling(i - start_pos, STC_PLC_VARIABLE)

   324

                    elif word in self.Functions:

   325

                        self.SetStyling(i - start_pos, STC_PLC_FUNCTION)

   326

                    elif word in self.Jumps:

   327

                        self.SetStyling(i - start_pos, STC_PLC_JUMP)

   330

                    else:

   331

                        self.SetStyling(i - start_pos, 31)

   332

                        if self.GetCurrentPos() < start_pos or self.GetCurrentPos() > i:

   333

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

   334

                            self.SetStyling(i - start_pos, wx.stc.STC_INDIC0_MASK)

   335

                            self.StartStyling(i, 0xff)    

   336

                else:

   337

                    self.SetStyling(i - start_pos, 31)

   338

                start_pos = i

   339

                state = SPACE

   340

                line = ""

   341

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

   342

                self.SetStyling(i - start_pos - 1, 31)

   343

                start_pos = i

   344

                state = COMMENT

   345

            elif state == COMMENT:

   346

                if line.endswith("*)"):

   347

                    self.SetStyling(i - start_pos + 2, STC_PLC_COMMENT)

   348

                    start_pos = i + 1

   349

                    state = SPACE

   350

            elif char in LETTERS:

   351

                if state == NUMBER:

   352

                    word = "#"

   353

                    state = WORD

   354

                elif state == SPACE:

   355

                    self.SetStyling(i - start_pos, 31)

   356

                    word = char

   357

                    start_pos = i

   358

                    state = WORD

   359

                else:

   360

                    word += char

   361

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

   362

                if state == SPACE:

   363

                    self.SetStyling(i - start_pos, 31)

   364

                    start_pos = i

   365

                    state = NUMBER

   366

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

   367

                    word += char

   368

            else:

   369

                if state == WORD:

   370

                    if word in self.Keywords:

   371

                        self.SetStyling(i - start_pos, STC_PLC_WORD)

   372

                    elif word in self.Variables:

   373

                        self.SetStyling(i - start_pos, STC_PLC_VARIABLE)

   374

                    elif word in self.Functions:

   375

                        self.SetStyling(i - start_pos, STC_PLC_FUNCTION)

   376

                    elif word in self.Jumps:

   377

                        self.SetStyling(i - start_pos, STC_PLC_JUMP)

   380

                    else:

   381

                        self.SetStyling(i - start_pos, 31)

   382

                        if self.GetCurrentPos() < start_pos or self.GetCurrentPos() > i:

   383

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

   384

                            self.SetStyling(i - start_pos, wx.stc.STC_INDIC0_MASK)

   385

                            self.StartStyling(i, 0xff)

   386

                    word = ""

   387

                    start_pos = i

   388

                    state = SPACE

   389

                elif state == NUMBER:

   390

                    self.SetStyling(i - start_pos, STC_PLC_NUMBER)

   391

                    start_pos = i

   392

                    state = SPACE

   393

            i += 1

   394

        if state == COMMENT:

   395

            self.SetStyling(i - start_pos + 2, STC_PLC_COMMENT)

   396

        elif state == NUMBER:

   397

            self.SetStyling(i - start_pos, STC_PLC_NUMBER)

   398

        elif state == WORD:

   399

            if word in self.Keywords:

   400

                self.SetStyling(i - start_pos, STC_PLC_WORD)

   401

            elif word in self.Variables:

   402

                self.SetStyling(i - start_pos, STC_PLC_VARIABLE)

   403

            elif word in self.Functions:

   404

                self.SetStyling(i - start_pos, STC_PLC_FUNCTION)

   405

            elif word in self.Jumps:

   406

                self.SetStyling(i - start_pos, STC_PLC_JUMP)

   409

            else:

   410

                self.SetStyling(i - start_pos, 31)

   411

        else:

   412

            self.SetStyling(i - start_pos, 31)

   413

        event.Skip()

   414

   415

    def Cut(self):

   416

        self.ResetBuffer()

   417

        self.CmdKeyExecute(wx.stc.STC_CMD_CUT)

   418

        self.RefreshBuffer()

   419

   420

    def Copy(self):

   421

        self.CmdKeyExecute(wx.stc.STC_CMD_COPY)

   422

   423

    def Paste(self):

   424

        self.ResetBuffer()

   425

        self.CmdKeyExecute(wx.stc.STC_CMD_PASTE)

   426

        self.RefreshBuffer()

   427

   428

    def RefreshModel(self):

   429

        if self.TextChanged:

   430

            self.RefreshJumpList()

   431

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

   432

   433

    def OnKeyDown(self, event):

   434

        if self.CallTipActive():

   435

            self.CallTipCancel()

   436

        key = event.GetKeyCode()

   437

   438

        # Code completion

   439

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

   440

   441

            line = self.GetCurrentLine()

   442

            if line == 0:

   443

                start_pos = 0

   444

            else:

   445

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

   446

            end_pos = self.GetCurrentPos()

   447

   448

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

   449

            words = lineText.split(" ")

   450

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

   451

   452

            kw = []

   453

   454

            if self.TextSyntax == "IL":

   455

                if len(words) == 1:

   456

                    kw = self.Keywords

   457

                elif len(words) == 2:

   458

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

   459

                        kw = self.Functions

   460

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

   461

                        kw = self.Jumps

   462

                    else:

   463

                        kw = self.Variables

   464

            else:

   465

                kw = self.Keywords + self.Variables + self.Functions

   466

            if len(kw) > 0:

   467

                kw.sort()

   468

                self.AutoCompSetIgnoreCase(True)

   469

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

   470

        else:

   471

            self.TextChanged = False

   472

            wx.CallAfter(self.RefreshModel)

   473

            event.Skip()

   474

   475

    def OnKillFocus(self, event):

   476

        self.AutoCompCancel()

   477

        event.Skip()

   478