1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library is distributed in the hope that it will be useful,

    17

#but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import wx

    26

import wx.stc

    27

from types import *

    28

    29

import re

    30

    31

from graphics.GraphicCommons import ERROR_HIGHLIGHT, SEARCH_RESULT_HIGHLIGHT, REFRESH_HIGHLIGHT_PERIOD

    33

from controls import EditorPanel

    34

    35

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

    36

#                         Textual programs Viewer class

    37

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

    38

    39

    40

NEWLINE = "\n"

    41

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

    42

LETTERS = ['_']

    43

for i in xrange(26):

    44

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

    45

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

    46

    47

[STC_PLC_WORD, STC_PLC_COMMENT, STC_PLC_NUMBER, STC_PLC_STRING, 

    48

 STC_PLC_VARIABLE, STC_PLC_PARAMETER, STC_PLC_FUNCTION, STC_PLC_JUMP, 

    49

 STC_PLC_ERROR, STC_PLC_SEARCH_RESULT] = range(10)

    50

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

    51

    52

[ID_TEXTVIEWER, ID_TEXTVIEWERTEXTCTRL,

    53

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

    54

    55

if wx.Platform == '__WXMSW__':

    56

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

    57

              'mono' : 'Courier New',

    58

              'helv' : 'Arial',

    59

              'other': 'Comic Sans MS',

    60

              'size' : 10,

    61

             }

    62

else:

    63

    faces = { 'times': 'Times',

    64

              'mono' : 'Courier',

    65

              'helv' : 'Helvetica',

    66

              'other': 'new century schoolbook',

    67

              'size' : 12,

    68

             }

    69

re_texts = {}

    70

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

    71

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

    72

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

    73

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

    74

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

    75

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

    76

    77

HIGHLIGHT_TYPES = {

    78

    ERROR_HIGHLIGHT: STC_PLC_ERROR,

    79

    SEARCH_RESULT_HIGHLIGHT: STC_PLC_SEARCH_RESULT,

    80

}

    81

    82

def GetCursorPos(old, new):

    83

    old_length = len(old)

    84

    new_length = len(new)

    85

    common_length = min(old_length, new_length)

    86

    i = 0

    87

    for i in xrange(common_length):

    88

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

    89

            break

    90

    if old_length < new_length:

    91

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

    92

            return i + new_length - old_length

    93

        else:

    94

            return i + new_length - old_length + 1

    95

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

    96

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

    97

            return i

    98

        else:

    99

            return i + 1

   100

    else:

   101

        return None

   102

   103

def LineStartswith(line, symbols):

   104

    return reduce(lambda x, y: x or y, map(lambda x: line.startswith(x), symbols), False)

   105

   106

class TextViewer(EditorPanel):

   107

   108

    ID = ID_TEXTVIEWER

   109

   110

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

   111

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

   112

            if id is not None:

   113

                event(self, id, function)

   114

            else:

   115

                event(self, function)

   116

   117

    def _init_Editor(self, prnt):

   118

        self.Editor = wx.stc.StyledTextCtrl(id=ID_TEXTVIEWERTEXTCTRL, 

   119

                parent=prnt, name="TextViewer", size=wx.Size(0, 0), style=0)

   120

        self.Editor.ParentWindow = self

   121

   122

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

   123

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

   124

   125

        self.Editor.SetViewWhiteSpace(False)

   126

   127

        self.Editor.SetLexer(wx.stc.STC_LEX_CONTAINER)

   128

   129

        # Global default styles for all languages

   130

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

   131

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

   132

   133

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

   134

        self.Editor.SetSelBackground(1, "#E0E0E0")

   135

   136

        # Highlighting styles

   137

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

   138

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

   139

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

   140

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

   141

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

   142

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

   143

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

   144

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

   145

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

   146

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

   147

   148

        # Indicators styles

   149

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

   150

        if self.ParentWindow is not None and self.Controler is not None:

   151

            self.Editor.IndicatorSetForeground(0, wx.RED)

   152

        else:

   153

            self.Editor.IndicatorSetForeground(0, wx.WHITE)

   154

   155

        # Line numbers in the margin

   156

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

   157

        self.Editor.SetMarginWidth(1, 50)

   158

   159

        # Folding

   160

        self.Editor.MarkerDefine(wx.stc.STC_MARKNUM_FOLDEROPEN,    wx.stc.STC_MARK_BOXMINUS,          "white", "#808080")

   161

        self.Editor.MarkerDefine(wx.stc.STC_MARKNUM_FOLDER,        wx.stc.STC_MARK_BOXPLUS,           "white", "#808080")

   162

        self.Editor.MarkerDefine(wx.stc.STC_MARKNUM_FOLDERSUB,     wx.stc.STC_MARK_VLINE,             "white", "#808080")

   163

        self.Editor.MarkerDefine(wx.stc.STC_MARKNUM_FOLDERTAIL,    wx.stc.STC_MARK_LCORNER,           "white", "#808080")

   164

        self.Editor.MarkerDefine(wx.stc.STC_MARKNUM_FOLDEREND,     wx.stc.STC_MARK_BOXPLUSCONNECTED,  "white", "#808080")

   165

        self.Editor.MarkerDefine(wx.stc.STC_MARKNUM_FOLDEROPENMID, wx.stc.STC_MARK_BOXMINUSCONNECTED, "white", "#808080")

   166

        self.Editor.MarkerDefine(wx.stc.STC_MARKNUM_FOLDERMIDTAIL, wx.stc.STC_MARK_TCORNER,           "white", "#808080")

   167

   168

        # Indentation size

   169

        self.Editor.SetTabWidth(2)

   170

        self.Editor.SetUseTabs(0)

   171

   172

        self.Editor.SetModEventMask(wx.stc.STC_MOD_BEFOREINSERT|

   173

                                    wx.stc.STC_MOD_BEFOREDELETE|

   174

                                    wx.stc.STC_PERFORMED_USER)

   175

   176

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

   177

        self.Editor.Bind(wx.stc.EVT_STC_MARGINCLICK, self.OnMarginClick)

   178

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

   179

        if self.Controler is not None:

   180

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

   181

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

   182

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

   183

   184

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

   185

        if tagname != "" and controler is not None:

   186

            self.VARIABLE_PANEL_TYPE = controler.GetPouType(tagname.split("::")[1])

   187

   188

        EditorPanel.__init__(self, parent, tagname, window, controler, debug)

   189

   190

        self.Keywords = []

   191

        self.Variables = {}

   192

        self.Functions = {}

   193

        self.TypeNames = []

   194

        self.Jumps = []

   195

        self.EnumeratedValues = []

   196

        self.DisableEvents = True

   197

        self.TextSyntax = None

   198

        self.CurrentAction = None

   199

        self.Highlights = []

   200

        self.SearchParams = None

   201

        self.SearchResults = None

   202

        self.CurrentFindHighlight = None

   203

        self.InstancePath = instancepath

   204

        self.ContextStack = []

   205

        self.CallStack = []

   206

   207

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

   208

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

   209

   210

    def __del__(self):

   211

        self.RefreshHighlightsTimer.Stop()

   212

   213

    def GetTitle(self):

   214

        if self.Debug or self.TagName == "":

   215

            if len(self.InstancePath) > 15:

   216

                return "..." + self.InstancePath[-12:]

   217

            return self.InstancePath

   218

        return EditorPanel.GetTitle(self)

   219

   220

    def GetInstancePath(self):

   221

        return self.InstancePath

   222

   223

    def IsViewing(self, tagname):

   224

        if self.Debug or self.TagName == "":

   225

            return self.InstancePath == tagname

   226

        else:

   227

            return self.TagName == tagname

   228

   229

    def GetText(self):

   230

        return self.Editor.GetText()

   231

   232

    def SetText(self, text):

   233

        self.Editor.SetText(text)

   234

   235

    def SelectAll(self):

   236

        self.Editor.SelectAll()

   237

   238

    def Colourise(self, start, end):

   239

        self.Editor.Colourise(start, end)

   240

   241

    def StartStyling(self, pos, mask):

   242

        self.Editor.StartStyling(pos, mask)

   243

   244

    def SetStyling(self, length, style):

   245

        self.Editor.SetStyling(length, style)

   246

   247

    def GetCurrentPos(self):

   248

        return self.Editor.GetCurrentPos()

   249

   250

    def GetState(self):

   251

        return {"cursor_pos": self.Editor.GetCurrentPos()}

   252

   253

    def SetState(self, state):

   254

        if self and state.has_key("cursor_pos"):

   255

            self.Editor.GotoPos(state.get("cursor_pos", 0))

   256

   257

    def OnModification(self, event):

   258

        if not self.DisableEvents:

   259

            mod_type = event.GetModificationType()

   260

            if mod_type&wx.stc.STC_MOD_BEFOREINSERT:

   261

                if self.CurrentAction == None:

   262

                    self.StartBuffering()

   263

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

   264

                    self.Controler.EndBuffering()

   265

                    self.StartBuffering()

   266

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

   267

                wx.CallAfter(self.RefreshModel)

   268

            elif mod_type&wx.stc.STC_MOD_BEFOREDELETE:

   269

                if self.CurrentAction == None:

   270

                    self.StartBuffering()

   271

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

   272

                    self.Controler.EndBuffering()

   273

                    self.StartBuffering()

   274

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

   275

                wx.CallAfter(self.RefreshModel)

   276

        event.Skip()

   277

   278

    def OnDoDrop(self, event):

   279

        try:

   280

            values = eval(event.GetDragText())

   281

        except:

   282

            values = event.GetDragText()

   283

        if isinstance(values, tuple):

   284

            message = None

   285

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

   286

                event.SetDragText("")

   287

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

   288

                blocktype = values[0]

   289

                blockname = values[2]

   290

                if len(values) > 3:

   291

                    blockinputs = values[3]

   292

                else:

   293

                    blockinputs = None

   294

                if values[1] != "function": 

   295

                    if blockname == "":

   296

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

   297

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

   298

                            blockname = dialog.GetValue()

   299

                        else:

   300

                            return

   301

                        dialog.Destroy()

   302

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

   303

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

   304

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

   305

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

   306

                    else:

   307

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

   308

                        self.RefreshVariablePanel()

   309

                        self.RefreshVariableTree()

   310

                blockinfo = self.Controler.GetBlockType(blocktype, blockinputs, self.Debug)

   311

                hint = ',\n    '.join(

   312

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

   313

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

   314

                if values[1] == "function":

   315

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

   316

                else:

   317

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

   318

            elif values[1] == "location":

   319

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

   320

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

   321

                    var_name = values[3]

   322

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

   323

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

   324

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

   325

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

   326

                    else:

   347

                        if values[2] is not None:

   348

                            var_type = values[2]

   349

                        else:

   352

                        self.RefreshVariablePanel()

   353

                        self.RefreshVariableTree()

   354

                        event.SetDragText(var_name)

   355

                else:

   356

                    event.SetDragText("")

   357

            elif values[1] == "Global":

   358

                var_name = values[0]

   359

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

   360

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

   361

                else:

   362

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

   363

                        self.Controler.AddEditedElementPouExternalVar(self.TagName, values[2], var_name)

   364

                        self.RefreshVariablePanel()

   365

                        self.RefreshVariableTree()

   366

                    event.SetDragText(var_name)

   367

            elif values[1] == "Constant":

   368

                event.SetDragText(values[0])

   369

            elif values[3] == self.TagName:

   370

                self.ResetBuffer()

   371

                event.SetDragText(values[0])

   372

                wx.CallAfter(self.RefreshModel)

   373

            else:

   374

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

   375

            if message is not None:

   376

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

   377

                dialog.ShowModal()

   378

                dialog.Destroy()

   379

                event.SetDragText("")

   380

        event.Skip()

   381

   382

    def SetTextSyntax(self, syntax):

   383

        self.TextSyntax = syntax

   384

        if syntax in ["ST", "ALL"]:

   385

            self.Editor.SetMarginType(2, wx.stc.STC_MARGIN_SYMBOL)

   386

            self.Editor.SetMarginMask(2, wx.stc.STC_MASK_FOLDERS)

   387

            self.Editor.SetMarginSensitive(2, 1)

   388

            self.Editor.SetMarginWidth(2, 12)

   389

            if syntax == "ST":

   390

                self.BlockStartKeywords = ST_BLOCK_START_KEYWORDS

   391

                self.BlockEndKeywords = ST_BLOCK_START_KEYWORDS

   392

            else:

   393

                self.BlockStartKeywords = IEC_BLOCK_START_KEYWORDS

   394

                self.BlockEndKeywords = IEC_BLOCK_START_KEYWORDS

   395

        else:

   396

            self.BlockStartKeywords = []

   397

            self.BlockEndKeywords = []

   398

   399

    def SetKeywords(self, keywords):

   400

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

   401

        self.Colourise(0, -1)

   402

   403

    def RefreshJumpList(self):

   404

        if self.TextSyntax != "IL":

   405

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

   406

            self.Colourise(0, -1)

   407

   408

    # Buffer the last model state

   409

    def RefreshBuffer(self):

   410

        self.Controler.BufferProject()

   411

        if self.ParentWindow:

   412

            self.ParentWindow.RefreshTitle()

   413

            self.ParentWindow.RefreshFileMenu()

   414

            self.ParentWindow.RefreshEditMenu()

   415

   416

    def StartBuffering(self):

   417

        self.Controler.StartBuffering()

   418

        if self.ParentWindow:

   419

            self.ParentWindow.RefreshTitle()

   420

            self.ParentWindow.RefreshFileMenu()

   421

            self.ParentWindow.RefreshEditMenu()

   422

   423

    def ResetBuffer(self):

   424

        if self.CurrentAction != None:

   425

            self.Controler.EndBuffering()

   426

            self.CurrentAction = None

   427

   428

    def GetBufferState(self):

   429

        if not self.Debug and self.TextSyntax != "ALL":

   430

            return self.Controler.GetBufferState()

   431

        return False, False

   432

   433

    def Undo(self):

   434

        if not self.Debug and self.TextSyntax != "ALL":

   435

            self.Controler.LoadPrevious()

   436

            self.ParentWindow.CloseTabsWithoutModel()

   437

   438

    def Redo(self):

   439

        if not self.Debug and self.TextSyntax != "ALL":

   440

            self.Controler.LoadNext()

   441

            self.ParentWindow.CloseTabsWithoutModel()

   442

   443

    def HasNoModel(self):

   444

        if not self.Debug and self.TextSyntax != "ALL":

   445

            return self.Controler.GetEditedElement(self.TagName) is None

   446

        return False

   447

   448

    def RefreshView(self, variablepanel=True):

   449

        EditorPanel.RefreshView(self, variablepanel)

   450

   451

        if self.Controler is not None:

   452

            self.ResetBuffer()

   453

            self.DisableEvents = True

   454

            old_cursor_pos = self.GetCurrentPos()

   455

            old_text = self.GetText()

   456

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

   457

            self.SetText(new_text)

   458

            new_cursor_pos = GetCursorPos(old_text, new_text)

   459

            if new_cursor_pos != None:

   460

                self.Editor.GotoPos(new_cursor_pos)

   461

            else:

   462

                self.Editor.GotoPos(old_cursor_pos)

   463

            self.Editor.ScrollToColumn(0)

   464

            self.RefreshJumpList()

   465

            self.Editor.EmptyUndoBuffer()

   466

            self.DisableEvents = False

   467

   468

            self.RefreshVariableTree()

   469

   470

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

   471

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

   472

   473

            self.Functions = {}

   474

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

   475

                for blocktype in category["list"]:

   476

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

   477

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

   478

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

   479

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

   480

                            if not interface.has_key(param):

   481

                                interface[param] = {}

   482

                        if self.Functions.has_key(blockname):

   483

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

   484

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

   485

                        else:

   486

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

   487

                                                         "extensible": blocktype["extensible"]}

   488

   489

        self.Colourise(0, -1)

   490

   491

    def RefreshVariableTree(self):

   492

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

   493

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

   494

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