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): 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

#Lesser 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

from wxPython.wx import *

    26

from wxPython.stc import * 

    27

import wx

    29

    30

import re

    31

    32

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

    33

#                         Textual programs Viewer class

    34

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

    35

    36

    37

NEWLINE = "\n"

    38

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

    39

LETTERS = ['_']

    40

for i in xrange(26):

    41

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

    42

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

    43

    44

[wxSTC_PLC_WORD, wxSTC_PLC_COMMENT, wxSTC_PLC_NUMBER, wxSTC_PLC_VARIABLE, 

    45

 wxSTC_PLC_FUNCTION, wxSTC_PLC_JUMP] = range(6)

    46

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

    47

    48

[wxID_TEXTVIEWER,

    49

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

    50

    51

if wx.Platform == '__WXMSW__':

    52

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

    53

              'mono' : 'Courier New',

    54

              'helv' : 'Arial',

    55

              'other': 'Comic Sans MS',

    56

              'size' : 10,

    57

             }

    58

else:

    59

    faces = { 'times': 'Times',

    60

              'mono' : 'Courier',

    61

              'helv' : 'Helvetica',

    62

              'other': 'new century schoolbook',

    63

              'size' : 12,

    64

             }

    65

re_texts = {}

    66

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

    67

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

    68

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

    69

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

    70

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

    71

    93

class TextViewer(wxStyledTextCtrl):

    94

    95

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

    96

        wxStyledTextCtrl.__init__(self, parent, wxID_TEXTVIEWER, style=0)

    97

    98

        self.CmdKeyAssign(ord('+'), wxSTC_SCMOD_CTRL, wxSTC_CMD_ZOOMIN)

    99

        self.CmdKeyAssign(ord('-'), wxSTC_SCMOD_CTRL, wxSTC_CMD_ZOOMOUT)

   100

   101

        self.SetViewWhiteSpace(False)

   102

   103

        self.SetLexer(wxSTC_LEX_CONTAINER)

   104

   105

        # Global default styles for all languages

   106

        self.StyleSetSpec(wxSTC_STYLE_DEFAULT, "face:%(mono)s,size:%(size)d" % faces)

   107

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

   108

   109

        self.StyleSetSpec(wxSTC_STYLE_LINENUMBER,  "back:#C0C0C0,size:%(size)d" % faces)

   110

        self.SetSelBackground(1, "#E0E0E0")

   111

   112

        # Highlighting styles

   113

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

   114

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

   115

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

   116

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

   117

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

   118

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

   119

   120

        # Indicators styles

   121

        self.IndicatorSetStyle(0, wxSTC_INDIC_SQUIGGLE)

   122

        self.IndicatorSetForeground(0, wxRED)

   123

   124

        # Line numbers in the margin

   125

        self.SetMarginType(1, wxSTC_MARGIN_NUMBER)

   126

        self.SetMarginWidth(1, 50)

   127

   128

        # Indentation size

   129

        self.SetTabWidth(2)

   130

        self.SetUseTabs(0)

   131

   132

        self.Keywords = []

   133

        self.Variables = []

   134

        self.Functions = []

   135

        self.Jumps = []

   136

        self.TextChanged = False

   138

        self.TextSyntax = "ST"

   142

        self.Controler = controler

   143

   146

        EVT_KEY_DOWN(self, self.OnKeyDown)

   147

        EVT_STC_STYLENEEDED(self, wxID_TEXTVIEWER, self.OnStyleNeeded)

   148

        EVT_STC_DO_DROP(self, wxID_TEXTVIEWER, self.OnDoDrop)

   149

        EVT_KILL_FOCUS(self, self.OnKillFocus)

   171

   172

    def OnDoDrop(self, event):

   173

        try:

   174

            values = eval(event.GetDragText())

   175

        except:

   176

            values = event.GetDragText()

   177

        if isinstance(values, tuple):

   178

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

   179

                event.SetDragText("")

   180

            else:

   181

                event.SetDragText(values[0])

   182

        event.Skip()

   183

   184

    def SetTextSyntax(self, syntax):

   185

        self.TextSyntax = syntax

   186

   187

    def SetKeywords(self, keywords):

   188

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

   189

        self.Colourise(0, -1)

   190

   191

    def SetVariables(self, variables):

   192

        self.Variables = [variable.upper() for variable in variables]

   193

        self.Colourise(0, -1)

   194

   195

    def SetFunctions(self, blocktypes):

   196

        self.Functions = []

   197

        for category in blocktypes:

   198

            for blocktype in category["list"]:

   199

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

   200

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

   201

        self.Colourise(0, -1)

   202

   203

    def RefreshJumpList(self):

   204

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

   205

        self.Colourise(0, -1)

   206

   223

    def RefreshView(self):

   236

        self.RefreshJumpList()

   240

    def OnStyleNeeded(self, event):

   241

        self.TextChanged = True

   242

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

   243

        if line == 0:

   244

            start_pos = 0

   245

        else:

   246

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

   247

        end_pos = event.GetPosition()

   248

        self.StartStyling(start_pos, 0xff)

   249

   250

        i = start_pos

   251

        state = SPACE

   252

        line = ""

   253

        word = ""

   254

        while i < end_pos:

   255

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

   256

            line += char

   257

            if char == NEWLINE:

   258

                if state == COMMENT:

   259

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

   260

                elif state == NUMBER:

   261

                    self.SetStyling(i - start_pos, wxSTC_PLC_NUMBER)

   262

                elif state == WORD:

   263

                    if word in self.Keywords:

   264

                        self.SetStyling(i - start_pos, wxSTC_PLC_WORD)

   265

                    elif word in self.Variables:

   266

                        self.SetStyling(i - start_pos, wxSTC_PLC_VARIABLE)

   267

                    elif word in self.Functions:

   268

                        self.SetStyling(i - start_pos, wxSTC_PLC_FUNCTION)

   269

                    elif word in self.Jumps:

   270

                        self.SetStyling(i - start_pos, wxSTC_PLC_JUMP)

   271

                    else:

   272

                        self.SetStyling(i - start_pos, 31)

   273

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

   274

                            self.StartStyling(start_pos, wxSTC_INDICS_MASK)

   275

                            self.SetStyling(i - start_pos, wxSTC_INDIC0_MASK)

   276

                            self.StartStyling(i, 0xff)    

   277

                else:

   278

                    self.SetStyling(i - start_pos, 31)

   279

                start_pos = i

   280

                state = SPACE

   281

                line = ""

   282

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

   283

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

   284

                start_pos = i

   285

                state = COMMENT

   286

            elif state == COMMENT:

   287

                if line.endswith("*)"):

   288

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

   289

                    start_pos = i + 1

   290

                    state = SPACE

   291

            elif char in LETTERS:

   292

                if state == NUMBER:

   293

                    word = "#"

   294

                    state = WORD

   295

                elif state == SPACE:

   296

                    self.SetStyling(i - start_pos, 31)

   297

                    word = char

   298

                    start_pos = i

   299

                    state = WORD

   300

                else:

   301

                    word += char

   302

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

   303

                if state == SPACE:

   304

                    self.SetStyling(i - start_pos, 31)

   305

                    start_pos = i

   306

                    state = NUMBER

   307

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

   308

                    word += char

   309

            else:

   310

                if state == WORD:

   311

                    if word in self.Keywords:

   312

                        self.SetStyling(i - start_pos, wxSTC_PLC_WORD)

   313

                    elif word in self.Variables:

   314

                        self.SetStyling(i - start_pos, wxSTC_PLC_VARIABLE)

   315

                    elif word in self.Functions:

   316

                        self.SetStyling(i - start_pos, wxSTC_PLC_FUNCTION)

   317

                    elif word in self.Jumps:

   318

                        self.SetStyling(i - start_pos, wxSTC_PLC_JUMP)

   319

                    else:

   320

                        self.SetStyling(i - start_pos, 31)

   321

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

   322

                            self.StartStyling(start_pos, wxSTC_INDICS_MASK)

   323

                            self.SetStyling(i - start_pos, wxSTC_INDIC0_MASK)

   324

                            self.StartStyling(i, 0xff)

   325

                    word = ""

   326

                    start_pos = i

   327

                    state = SPACE

   328

                elif state == NUMBER:

   329

                    self.SetStyling(i - start_pos, wxSTC_PLC_NUMBER)

   330

                    start_pos = i

   331

                    state = SPACE

   332

            i += 1

   333

        if state == COMMENT:

   334

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

   335

        elif state == NUMBER:

   336

            self.SetStyling(i - start_pos, wxSTC_PLC_NUMBER)

   337

        elif state == WORD:

   338

            if word in self.Keywords:

   339

                self.SetStyling(i - start_pos, wxSTC_PLC_WORD)

   340

            elif word in self.Variables:

   341

                self.SetStyling(i - start_pos, wxSTC_PLC_VARIABLE)

   342

            elif word in self.Functions:

   343

                self.SetStyling(i - start_pos, wxSTC_PLC_FUNCTION)

   344

            elif word in self.Jumps:

   345

                self.SetStyling(i - start_pos, wxSTC_PLC_JUMP)

   346

            else:

   347

                self.SetStyling(i - start_pos, 31)

   348

        else:

   349

            self.SetStyling(i - start_pos, 31)

   350

        event.Skip()

   351

   352

    def Cut(self):

   354

        self.CmdKeyExecute(wxSTC_CMD_CUT)

   357

    def Copy(self):

   358

        self.CmdKeyExecute(wxSTC_CMD_COPY)

   359

   360

    def Paste(self):

   362

        self.CmdKeyExecute(wxSTC_CMD_PASTE)

   364

   365

    def RefreshModel(self):

   366

        if self.TextChanged:

   367

            self.RefreshJumpList()

   368

            self.Controler.SetCurrentElementEditingText(self.GetText())

   369

   370

    def OnKeyDown(self, event):

   371

        if self.CallTipActive():

   372

            self.CallTipCancel()

   373

        key = event.KeyCode()

   374

   375

        # Code completion

   376

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

   377

   378

            line = self.GetCurrentLine()

   379

            if line == 0:

   380

                start_pos = 0

   381

            else:

   382

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

   383

            end_pos = self.GetCurrentPos()

   384

   385

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

   386

            words = lineText.split(" ")

   387

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

   388

   389

            kw = []

   390

   391

            if self.TextSyntax == "IL":

   392

                if len(words) == 1:

   393

                    kw = self.Keywords

   394

                elif len(words) == 2:

   395

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

   396

                        kw = self.Functions

   397

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

   398

                        kw = self.Jumps

   399

                    else:

   400

                        kw = self.Variables

   401

            else:

   402

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

   403

            if len(kw) > 0:

   404

                kw.sort()

   405

                self.AutoCompSetIgnoreCase(True)

   406

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

   407

        else:

   408

            self.TextChanged = False

   409

            wxCallAfter(self.RefreshModel)

   410

            event.Skip()

   411

   412

    def OnKillFocus(self, event):

   413

        self.AutoCompCancel()

   414

        event.Skip()

   415