1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

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

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

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

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

import re

    26

    27

import wx

    28

import wx.grid

    29

import wx.stc as stc

    30

import wx.lib.buttons

    31

    32

from plcopen.plcopen import TestTextElement

    33

from plcopen.structures import TestIdentifier, IEC_KEYWORDS, DefaultType

    34

from controls import CustomGrid, CustomTable

    35

from editors.ConfTreeNodeEditor import ConfTreeNodeEditor

    36

from util.BitmapLibrary import GetBitmap

    37

from controls.CustomStyledTextCtrl import CustomStyledTextCtrl, faces, GetCursorPos, NAVIGATION_KEYS

    38

from controls.VariablePanel import VARIABLE_NAME_SUFFIX_MODEL

    39

from graphics.GraphicCommons import ERROR_HIGHLIGHT, SEARCH_RESULT_HIGHLIGHT, REFRESH_HIGHLIGHT_PERIOD

    40

from util.TranslationCatalogs import NoTranslate

    41

    42

[STC_CODE_ERROR, STC_CODE_SEARCH_RESULT,

    43

 STC_CODE_SECTION] = range(15, 18)

    44

    45

HIGHLIGHT_TYPES = {

    46

    ERROR_HIGHLIGHT: STC_CODE_ERROR,

    47

    SEARCH_RESULT_HIGHLIGHT: STC_CODE_SEARCH_RESULT,

    48

}

    49

    50

EDGE_COLUMN = 80

    51

    52

    53

class CodeEditor(CustomStyledTextCtrl):

    54

    55

    KEYWORDS = []

    56

    COMMENT_HEADER = ""

    57

    58

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

    59

        CustomStyledTextCtrl.__init__(self, parent, -1, wx.DefaultPosition,

    60

                                      wx.Size(-1, 300), 0)

    61

    62

        self.SetMarginType(1, stc.STC_MARGIN_NUMBER)

    63

        self.SetMarginWidth(1, 25)

    64

    65

        self.SetProperty("fold", "1")

    66

        self.SetProperty("tab.timmy.whinge.level", "1")

    67

        self.SetMargins(0, 0)

    68

    69

        self.SetViewWhiteSpace(False)

    70

    71

        self.SetEdgeMode(stc.STC_EDGE_BACKGROUND)

    72

        self.SetEdgeColumn(EDGE_COLUMN)

    73

    74

        # Setup a margin to hold fold markers

    75

        self.SetMarginType(2, stc.STC_MARGIN_SYMBOL)

    76

        self.SetMarginMask(2, stc.STC_MASK_FOLDERS)

    77

        self.SetMarginSensitive(2, True)

    78

        self.SetMarginWidth(2, 12)

    79

    80

        # Like a flattened tree control using square headers

    81

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

    82

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

    83

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

    84

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

    85

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

    86

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

    87

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

    88

    89

        self.Bind(stc.EVT_STC_UPDATEUI, self.OnUpdateUI)

    90

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

    91

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

    92

    93

        # Make some styles,  The lexer defines what each style is used for, we

    94

        # just have to define what each style looks like.  This set is adapted from

    95

        # Scintilla sample property files.

    96

    97

        # Global default styles for all languages

    98

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

    99

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

   100

   101

        # Global default styles for all languages

   102

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

   103

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

   104

        self.StyleSetSpec(stc.STC_STYLE_CONTROLCHAR, "face:%(mono)s" % faces)

   105

        self.StyleSetSpec(stc.STC_STYLE_BRACELIGHT,  "fore:#FFFFFF,back:#0000FF,bold")

   106

        self.StyleSetSpec(stc.STC_STYLE_BRACEBAD,    "fore:#000000,back:#FF0000,bold")

   107

   108

        # Highlighting styles

   109

        self.StyleSetSpec(STC_CODE_ERROR, 'fore:#FF0000,back:#FFFF00,size:%(size)d' % faces)

   110

        self.StyleSetSpec(STC_CODE_SEARCH_RESULT, 'fore:#FFFFFF,back:#FFA500,size:%(size)d' % faces)

   111

   112

        # Section style

   113

        self.StyleSetSpec(STC_CODE_SECTION, 'fore:#808080,size:%(size)d')

   114

        self.StyleSetChangeable(STC_CODE_SECTION, False)

   115

   116

        # Indentation size

   117

        self.SetTabWidth(4)

   118

        self.SetUseTabs(0)

   119

   120

        self.SetCodeLexer()

   121

        self.SetKeyWords(0, " ".join(self.KEYWORDS))

   122

   123

        self.Controler = controler

   124

        self.ParentWindow = window

   125

   126

        self.DisableEvents = True

   127

        self.CurrentAction = None

   128

   129

        self.ResetSearchResults()

   130

   131

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

   132

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

   133

   134

        self.SectionsComments = {}

   135

        for section in self.Controler.SECTIONS_NAMES:

   136

            section_comment = " %s section " % (section)

   137

            len_headers = EDGE_COLUMN - len(section_comment)

   138

            section_comment = \

   139

                self.COMMENT_HEADER * (len_headers / 2) + \

   140

                section_comment + \

   141

                self.COMMENT_HEADER * (len_headers - len_headers / 2)

   142

   143

            self.SectionsComments[section] = {

   144

                 "comment": section_comment,

   145

            }

   146

   147

        for i, section in enumerate(self.Controler.SECTIONS_NAMES):

   148

            section_infos = self.SectionsComments[section]

   149

            if i + 1 < len(self.Controler.SECTIONS_NAMES):

   150

                section_end = self.SectionsComments[

   151

                    self.Controler.SECTIONS_NAMES[i + 1]]["comment"]

   152

            else:

   153

                section_end = "$"

   154

            section_infos["pattern"] = re.compile(

   155

                section_infos["comment"] + "(.*)" +

   156

                section_end, re.DOTALL)

   157

   158

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

   159

   160

        self.Bind(wx.stc.EVT_STC_DO_DROP, self.OnDoDrop)

   161

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

   162

        self.Bind(wx.stc.EVT_STC_MODIFIED, self.OnModification)

   163

   164

    def SetCodeLexer(self):

   165

        pass

   166

   167

    def ResetSearchResults(self):

   168

        self.Highlights = []

   169

        self.SearchParams = None

   170

        self.SearchResults = None

   171

        self.CurrentFindHighlight = None

   172

   173

    def OnModification(self, event):

   174

        if not self.DisableEvents:

   175

            mod_type = event.GetModificationType()

   176

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

   177

                if mod_type & wx.stc.STC_MOD_BEFOREINSERT:

   178

                    if self.CurrentAction is None:

   179

                        self.StartBuffering()

   180

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

   181

                        self.Controler.EndBuffering()

   182

                        self.StartBuffering()

   183

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

   184

                    wx.CallAfter(self.RefreshModel)

   185

                elif mod_type & wx.stc.STC_MOD_BEFOREDELETE:

   186

                    if self.CurrentAction is None:

   187

                        self.StartBuffering()

   188

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

   189

                        self.Controler.EndBuffering()

   190

                        self.StartBuffering()

   191

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

   192

                    wx.CallAfter(self.RefreshModel)

   193

        wx.CallAfter(self.RefreshSectionStyling)

   194

        event.Skip()

   195

   196

    def OnDoDrop(self, event):

   197

        try:

   198

            values = eval(event.GetDragText())

   200

            values = event.GetDragText()

   201

        if isinstance(values, tuple):

   202

            message = None

   203

            if values[3] == self.Controler.GetCurrentLocation():

   204

                self.ResetBuffer()

   205

                event.SetDragText(values[0])

   206

                wx.CallAfter(self.RefreshModel)

   207

            else:

   208

                event.SetDragText("")

   209

        else:

   210

            self.ResetBuffer()

   211

            wx.CallAfter(self.RefreshModel)

   212

        event.Skip()

   213

   214

    # Buffer the last model state

   215

    def RefreshBuffer(self):

   216

        self.Controler.BufferCodeFile()

   217

        if self.ParentWindow is not None:

   218

            self.ParentWindow.RefreshTitle()

   219

            self.ParentWindow.RefreshFileMenu()

   220

            self.ParentWindow.RefreshEditMenu()

   221

            self.ParentWindow.RefreshPageTitles()

   222

   223

    def StartBuffering(self):

   224

        self.Controler.StartBuffering()

   225

        if self.ParentWindow is not None:

   226

            self.ParentWindow.RefreshTitle()

   227

            self.ParentWindow.RefreshFileMenu()

   228

            self.ParentWindow.RefreshEditMenu()

   229

            self.ParentWindow.RefreshPageTitles()

   230

   231

    def ResetBuffer(self):

   232

        if self.CurrentAction is not None:

   233

            self.Controler.EndBuffering()

   234

            self.CurrentAction = None

   235

   236

    def GetCodeText(self):

   237

        parts = self.Controler.GetTextParts()

   238

        text = ""

   239

        for section in self.Controler.SECTIONS_NAMES:

   240

            section_comments = self.SectionsComments[section]

   241

            text += section_comments["comment"]

   242

            if parts[section] == "":

   243

                text += "\n"

   244

            else:

   245

                if not parts[section].startswith("\n"):

   246

                    text += "\n"

   247

                text += parts[section]

   248

                if not parts[section].endswith("\n"):

   249

                    text += "\n"

   250

        return text

   251

   252

    def RefreshView(self, scroll_to_highlight=False):

   253

        self.ResetBuffer()

   254

        self.DisableEvents = True

   255

        old_cursor_pos = self.GetCurrentPos()

   256

        line = self.GetFirstVisibleLine()

   257

        column = self.GetXOffset()

   258

        old_text = self.GetText()

   259

        new_text = self.GetCodeText()

   260

        if old_text != new_text:

   261

            self.SetText(new_text)

   262

            new_cursor_pos = GetCursorPos(old_text, new_text)

   263

            self.LineScroll(column, line)

   264

            if new_cursor_pos is not None:

   265

                self.GotoPos(new_cursor_pos)

   266

            else:

   267

                self.GotoPos(old_cursor_pos)

   268

            self.EmptyUndoBuffer()

   269

        self.DisableEvents = False

   270

   271

        self.RefreshSectionStyling()

   272

   273

        self.ShowHighlights()

   274

   275

    def RefreshSectionStyling(self):

   276

        self.Colourise(0, -1)

   277

   278

        text = self.GetText()

   279

        for line in xrange(self.GetLineCount()):

   280

            self.SetLineState(line, 0)

   281

   282

        for section in self.Controler.SECTIONS_NAMES:

   283

            section_comments = self.SectionsComments[section]

   284

            start_pos = text.find(section_comments["comment"])

   285

            end_pos = start_pos + len(section_comments["comment"])

   286

            self.StartStyling(start_pos, 0xff)

   287

            self.SetStyling(end_pos - start_pos, STC_CODE_SECTION)

   288

            self.SetLineState(self.LineFromPosition(start_pos), 1)

   289

   290

        self.StartStyling(end_pos, 0x00)

   291

        self.SetStyling(len(self.GetText()) - end_pos, stc.STC_STYLE_DEFAULT)

   292

   293

    def DoGetBestSize(self):

   294

        return self.ParentWindow.GetPanelBestSize()

   295

   296

    def RefreshModel(self):

   297

        text = self.GetText()

   298

        parts = {}

   299

        for section in self.Controler.SECTIONS_NAMES:

   300

            section_comments = self.SectionsComments[section]

   301

            result = section_comments["pattern"].search(text)

   302

            if result is not None:

   303

                parts[section] = result.group(1)

   304

            else:

   305

                parts[section] = ""

   306

        self.Controler.SetTextParts(parts)

   307

        self.ResetSearchResults()

   308

   309

    def OnKeyPressed(self, event):

   310

        if self.CallTipActive():

   311

            self.CallTipCancel()

   312

        key = event.GetKeyCode()

   313

        current_pos = self.GetCurrentPos()

   314

        selected = self.GetSelection()

   315

        text_selected = selected[0] != selected[1]

   316

   317

        # Test if caret is before Windows like new line

   318

        text = self.GetText()

   319

        if current_pos < len(text) and ord(text[current_pos]) == 13:

   320

            newline_size = 2

   321

        else:

   322

            newline_size = 1

   323

   324

        # Disable to type any character in section header lines

   325

        if (self.GetLineState(self.LineFromPosition(current_pos)) and

   326

            not text_selected and

   327

            key not in NAVIGATION_KEYS + [

   328

                wx.WXK_RETURN,

   329

                wx.WXK_NUMPAD_ENTER]):

   330

            return

   331

   332

        # Disable to delete line between code and header lines

   333

        elif (self.GetCurLine()[0].strip() != "" and not text_selected and

   334

              (key == wx.WXK_BACK and

   335

               self.GetLineState(self.LineFromPosition(max(0, current_pos - 1))) or

   336

               key in [wx.WXK_DELETE, wx.WXK_NUMPAD_DELETE] and

   337

               self.GetLineState(self.LineFromPosition(min(len(text), current_pos + newline_size))))):

   338

            return

   339

   340

        elif key == 32 and event.ControlDown():

   341

            pos = self.GetCurrentPos()

   342

   343

            # Tips

   344

            if event.ShiftDown():

   345

                pass

   346

            # Code completion

   347

            else:

   348

                self.AutoCompSetIgnoreCase(False)  # so this needs to match

   349

   350

                keywords = self.KEYWORDS + [var["Name"]

   351

                                            for var in self.Controler.GetVariables()]

   352

                keywords.sort()

   353

                self.AutoCompShow(0, " ".join(keywords))

   354

        else:

   355

            event.Skip()

   356

   357

    def OnKillFocus(self, event):

   358

        self.AutoCompCancel()

   359

        event.Skip()

   360

   361

    def OnUpdateUI(self, event):

   362

        # check for matching braces

   363

        braceAtCaret = -1

   364

        braceOpposite = -1

   365

        charBefore = None

   366

        caretPos = self.GetCurrentPos()

   367

   368

        if caretPos > 0:

   369

            charBefore = self.GetCharAt(caretPos - 1)

   370

            styleBefore = self.GetStyleAt(caretPos - 1)

   371

   372

        # check before

   373

        if charBefore and chr(charBefore) in "[]{}()" and styleBefore == stc.STC_P_OPERATOR:

   374

            braceAtCaret = caretPos - 1

   375

   376

        # check after

   377

        if braceAtCaret < 0:

   378

            charAfter = self.GetCharAt(caretPos)

   379

            styleAfter = self.GetStyleAt(caretPos)

   380

   381

            if charAfter and chr(charAfter) in "[]{}()" and styleAfter == stc.STC_P_OPERATOR:

   382

                braceAtCaret = caretPos

   383

   384

        if braceAtCaret >= 0:

   385

            braceOpposite = self.BraceMatch(braceAtCaret)

   386

   387

        if braceAtCaret != -1 and braceOpposite == -1:

   388

            self.BraceBadLight(braceAtCaret)

   389

        else:

   390

            self.BraceHighlight(braceAtCaret, braceOpposite)

   391

   392

        selected_text = self.GetSelectedText()

   393

        if selected_text:

   394

            self.ParentWindow.SetCopyBuffer(selected_text, True)

   395

   396

    def OnMarginClick(self, event):

   397

        # fold and unfold as needed

   398

        if evt.GetMargin() == 2:

   399

            if evt.GetShift() and evt.GetControl():

   400

                self.FoldAll()

   401

            else:

   402

                lineClicked = self.LineFromPosition(evt.GetPosition())

   403

   404

                if self.GetFoldLevel(lineClicked) & stc.STC_FOLDLEVELHEADERFLAG:

   405

                    if evt.GetShift():

   406

                        self.SetFoldExpanded(lineClicked, True)

   407

                        self.Expand(lineClicked, True, True, 1)

   408

                    elif evt.GetControl():

   409

                        if self.GetFoldExpanded(lineClicked):

   410

                            self.SetFoldExpanded(lineClicked, False)

   411

                            self.Expand(lineClicked, False, True, 0)

   412

                        else:

   413

                            self.SetFoldExpanded(lineClicked, True)

   414

                            self.Expand(lineClicked, True, True, 100)

   415

                    else:

   416

                        self.ToggleFold(lineClicked)

   417

        event.Skip()

   418

   419

    def FoldAll(self):

   420

        lineCount = self.GetLineCount()

   421

        expanding = True

   422

   423

        # find out if we are folding or unfolding

   424

        for lineNum in range(lineCount):

   425

            if self.GetFoldLevel(lineNum) & stc.STC_FOLDLEVELHEADERFLAG:

   426

                expanding = not self.GetFoldExpanded(lineNum)

   427

                break

   428

   429

        lineNum = 0

   430

   431

        while lineNum < lineCount:

   432

            level = self.GetFoldLevel(lineNum)

   433

            if level & stc.STC_FOLDLEVELHEADERFLAG and \

   434

               (level & stc.STC_FOLDLEVELNUMBERMASK) == stc.STC_FOLDLEVELBASE:

   435

   436

                if expanding:

   437

                    self.SetFoldExpanded(lineNum, True)

   438

                    lineNum = self.Expand(lineNum, True)

   439

                    lineNum = lineNum - 1

   440

                else:

   441

                    lastChild = self.GetLastChild(lineNum, -1)

   442

                    self.SetFoldExpanded(lineNum, False)

   443

   444

                    if lastChild > lineNum:

   445

                        self.HideLines(lineNum+1, lastChild)

   446

   447

            lineNum = lineNum + 1

   448

   449

    def Expand(self, line, doExpand, force=False, visLevels=0, level=-1):

   450

        lastChild = self.GetLastChild(line, level)

   451

        line = line + 1

   452

   453

        while line <= lastChild:

   454

            if force:

   455

                if visLevels > 0:

   456

                    self.ShowLines(line, line)

   457

                else:

   458

                    self.HideLines(line, line)

   459

            else:

   460

                if doExpand:

   461

                    self.ShowLines(line, line)

   462

   463

            if level == -1:

   464

                level = self.GetFoldLevel(line)

   465

   466

            if level & stc.STC_FOLDLEVELHEADERFLAG:

   467

                if force:

   468

                    if visLevels > 1:

   469

                        self.SetFoldExpanded(line, True)

   470

                    else:

   471

                        self.SetFoldExpanded(line, False)

   472

   473

                    line = self.Expand(line, doExpand, force, visLevels-1)

   474

   475

                else:

   476

                    if doExpand and self.GetFoldExpanded(line):

   477

                        line = self.Expand(line, True, force, visLevels-1)

   478

                    else:

   479

                        line = self.Expand(line, False, force, visLevels-1)

   480

            else:

   481

                line = line + 1

   482

   483

        return line

   484

   485

    def Cut(self):

   486

        self.ResetBuffer()

   487

        self.DisableEvents = True

   488

        self.CmdKeyExecute(wx.stc.STC_CMD_CUT)

   489

        self.DisableEvents = False

   490

        self.RefreshModel()

   491

        self.RefreshBuffer()

   492

   493

    def Copy(self):

   494

        self.CmdKeyExecute(wx.stc.STC_CMD_COPY)

   495

        self.ParentWindow.RefreshEditMenu()

   496

   497

    def Paste(self):