1

import re

     2

     3

import wx

     4

import wx.grid

     5

import wx.stc as stc

     6

import wx.lib.buttons

     7

     8

from plcopen.plcopen import TestTextElement

     9

from plcopen.structures import TestIdentifier, IEC_KEYWORDS

    10

from controls import CustomGrid, CustomTable

    11

from editors.ConfTreeNodeEditor import ConfTreeNodeEditor

    12

from util.BitmapLibrary import GetBitmap

    13

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

    14

from controls.VariablePanel import VARIABLE_NAME_SUFFIX_MODEL

    15

from graphics.GraphicCommons import ERROR_HIGHLIGHT, SEARCH_RESULT_HIGHLIGHT, REFRESH_HIGHLIGHT_PERIOD

    16

    17

[STC_CODE_ERROR, STC_CODE_SEARCH_RESULT, 

    18

 STC_CODE_SECTION] = range(15, 18)

    19

    20

HIGHLIGHT_TYPES = {

    21

    ERROR_HIGHLIGHT: STC_CODE_ERROR,

    22

    SEARCH_RESULT_HIGHLIGHT: STC_CODE_SEARCH_RESULT,

    23

}

    24

    25

EDGE_COLUMN = 80

    26

    27

class CodeEditor(CustomStyledTextCtrl):

    28

    29

    KEYWORDS = []

    30

    COMMENT_HEADER = ""

    31

    32

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

    33

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

    34

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

    35

    36

        self.SetMarginType(1, stc.STC_MARGIN_NUMBER)

    37

        self.SetMarginWidth(1, 25)

    38

    39

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

    40

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

    41

        self.SetMargins(0,0)

    42

    43

        self.SetViewWhiteSpace(False)

    44

    45

        self.SetEdgeMode(stc.STC_EDGE_BACKGROUND)

    46

        self.SetEdgeColumn(EDGE_COLUMN)

    47

    48

        # Setup a margin to hold fold markers

    49

        self.SetMarginType(2, stc.STC_MARGIN_SYMBOL)

    50

        self.SetMarginMask(2, stc.STC_MASK_FOLDERS)

    51

        self.SetMarginSensitive(2, True)

    52

        self.SetMarginWidth(2, 12)

    53

    54

        # Like a flattened tree control using square headers

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

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

    62

    63

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

    64

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

    65

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

    66

    67

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

    68

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

    69

        # Scintilla sample property files.

    70

    71

        # Global default styles for all languages

    72

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

    73

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

    74

    75

        # Global default styles for all languages

    76

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

    77

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

    78

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

    79

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

    80

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

    81

    82

        # Highlighting styles

    83

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

    84

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

    85

    86

        # Section style

    87

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

    88

        self.StyleSetChangeable(STC_CODE_SECTION, False)

    89

    90

        # Indentation size

    91

        self.SetTabWidth(4)

    92

        self.SetUseTabs(0)

    93

    94

        self.SetCodeLexer()

    95

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

    96

    97

        self.Controler = controler

    98

        self.ParentWindow = window

    99

   100

        self.DisableEvents = True

   101

        self.CurrentAction = None

   102

   103

        self.Highlights = []

   104

        self.SearchParams = None

   105

        self.SearchResults = None

   106

        self.CurrentFindHighlight = None

   107

   108

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

   109

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

   110

   111

        self.SectionsComments = {}

   112

        for section in self.Controler.SECTIONS_NAMES:

   113

            section_comment = " %s section " % (section)

   114

            len_headers = EDGE_COLUMN - len(section_comment)

   115

            section_comment = self.COMMENT_HEADER * (len_headers / 2) + \

   116

                              section_comment + \

   117

                              self.COMMENT_HEADER * (len_headers - len_headers / 2)

   118

   119

            self.SectionsComments[section] = {

   120

                 "comment": section_comment,

   121

            }

   122

   123

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

   124

            section_infos = self.SectionsComments[section]

   125

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

   126

                section_end = self.SectionsComments[

   127

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

   128

            else:

   129

                section_end = "$"

   130

            section_infos["pattern"] = re.compile(

   131

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

   132

                section_end, re.DOTALL)

   133

   134

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

   135

   136

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

   137

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

   138

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

   139

   140

    def SetCodeLexer(self):

   141

        pass

   142

   143

    def OnModification(self, event):

   144

        if not self.DisableEvents:

   145

            mod_type = event.GetModificationType()

   146

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

   147

                if mod_type&wx.stc.STC_MOD_BEFOREINSERT:

   148

                    if self.CurrentAction == None:

   149

                        self.StartBuffering()

   150

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

   151

                        self.Controler.EndBuffering()

   152

                        self.StartBuffering()

   153

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

   154

                    wx.CallAfter(self.RefreshModel)

   155

                elif mod_type&wx.stc.STC_MOD_BEFOREDELETE:

   156

                    if self.CurrentAction == None:

   157

                        self.StartBuffering()

   158

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

   159

                        self.Controler.EndBuffering()

   160

                        self.StartBuffering()

   161

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

   162

                    wx.CallAfter(self.RefreshModel)

   163

        wx.CallAfter(self.RefreshSectionStyling)

   164

        event.Skip()

   165

   166

    def OnDoDrop(self, event):

   167

        try:

   168

            values = eval(event.GetDragText())

   169

        except:

   170

            values = event.GetDragText()

   171

        if isinstance(values, tuple):

   172

            message = None

   173

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

   174

                self.ResetBuffer()

   175

                event.SetDragText(values[0])

   176

                wx.CallAfter(self.RefreshModel)

   177

            else:

   178

                event.SetDragText("")

   179

        else:

   180

            self.ResetBuffer()

   181

            wx.CallAfter(self.RefreshModel)

   182

        event.Skip()

   183

   184

    # Buffer the last model state

   185

    def RefreshBuffer(self):

   186

        self.Controler.BufferCodeFile()

   187

        if self.ParentWindow is not None:

   188

            self.ParentWindow.RefreshTitle()

   189

            self.ParentWindow.RefreshFileMenu()

   190

            self.ParentWindow.RefreshEditMenu()

   191

            self.ParentWindow.RefreshPageTitles()

   192

   193

    def StartBuffering(self):

   194

        self.Controler.StartBuffering()

   195

        if self.ParentWindow is not None:

   196

            self.ParentWindow.RefreshTitle()

   197

            self.ParentWindow.RefreshFileMenu()

   198

            self.ParentWindow.RefreshEditMenu()

   199

            self.ParentWindow.RefreshPageTitles()

   200

   201

    def ResetBuffer(self):

   202

        if self.CurrentAction != None:

   203

            self.Controler.EndBuffering()

   204

            self.CurrentAction = None

   205

   206

    def GetCodeText(self):

   207

        parts = self.Controler.GetTextParts()

   208

        text = ""

   209

        for section in self.Controler.SECTIONS_NAMES:

   210

            section_comments = self.SectionsComments[section]

   211

            text += section_comments["comment"]

   212

            if parts[section] == "":

   213

                text += "\n"

   214

            else:

   215

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

   216

                    text += "\n"

   217

                text += parts[section]

   218

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

   219

                    text += "\n"

   220

        return text

   221

   222

    def RefreshView(self, scroll_to_highlight=False):

   223

        self.ResetBuffer()

   224

        self.DisableEvents = True

   225

        old_cursor_pos = self.GetCurrentPos()

   226

        line = self.GetFirstVisibleLine()

   227

        column = self.GetXOffset()

   228

        old_text = self.GetText()

   229

        new_text = self.GetCodeText()

   230

        if old_text != new_text:

   231

            self.SetText(new_text)

   232

            new_cursor_pos = GetCursorPos(old_text, new_text)

   233

            self.LineScroll(column, line)

   234

            if new_cursor_pos != None:

   235

                self.GotoPos(new_cursor_pos)

   236

            else:

   237

                self.GotoPos(old_cursor_pos)

   238

            self.EmptyUndoBuffer()

   239

        self.DisableEvents = False

   240

   241

        self.RefreshSectionStyling()

   242

   243

        self.ShowHighlights()

   244

   245

    def RefreshSectionStyling(self):

   246

        self.Colourise(0, -1)

   247

   248

        text = self.GetText()

   249

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

   250

            self.SetLineState(line, 0)

   251

   252

        for section in self.Controler.SECTIONS_NAMES:

   253

            section_comments = self.SectionsComments[section]

   254

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

   255

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

   256

            self.StartStyling(start_pos, 0xff)

   257

            self.SetStyling(end_pos - start_pos, STC_CODE_SECTION)

   258

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

   259

   260

        self.StartStyling(end_pos, 0x00)

   261

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

   262

   263

    def DoGetBestSize(self):

   264

        return self.ParentWindow.GetPanelBestSize()

   265

   266

    def RefreshModel(self):

   267

        text = self.GetText()

   268

        parts = {}

   269

        for section in self.Controler.SECTIONS_NAMES:

   270

            section_comments = self.SectionsComments[section]

   271

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

   272

            if result is not None:

   273

                parts[section] = result.group(1)

   274

            else:

   275

                parts[section] = ""

   276

        self.Controler.SetTextParts(parts)

   277

   278

    def OnKeyPressed(self, event):

   279

        if self.CallTipActive():

   280

            self.CallTipCancel()

   281

        key = event.GetKeyCode()

   282

        current_pos = self.GetCurrentPos()

   283

        selected = self.GetSelection()

   284

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

   285

   286

        # Test if caret is before Windows like new line

   287

        text = self.GetText()

   288

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

   289

            newline_size = 2

   290

        else:

   291

            newline_size = 1

   292

   293

        # Disable to type any character in section header lines

   294

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

   295

            not text_selected and

   296

            key not in NAVIGATION_KEYS + [

   297

                wx.WXK_RETURN,

   298

                wx.WXK_NUMPAD_ENTER]):

   299

            return

   300

   301

        # Disable to delete line between code and header lines

   302

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

   303

              (key == wx.WXK_BACK and

   304

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

   305

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

   306

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

   307

            return

   308

   309

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

   310

            pos = self.GetCurrentPos()

   311

   312

            # Tips

   313

            if event.ShiftDown():

   314

                pass

   315

            # Code completion

   316

            else:

   317

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

   318

   319

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

   320

                                            for var in self.Controler.GetVariables()]

   321

                keywords.sort()

   322

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

   323

        else:

   324

            event.Skip()

   325

   326

    def OnKillFocus(self, event):

   327

        self.AutoCompCancel()

   328

        event.Skip()

   329

   330

    def OnUpdateUI(self, event):

   331

        # check for matching braces

   332

        braceAtCaret = -1

   333

        braceOpposite = -1

   334

        charBefore = None

   335

        caretPos = self.GetCurrentPos()

   336

   337

        if caretPos > 0:

   338

            charBefore = self.GetCharAt(caretPos - 1)

   339

            styleBefore = self.GetStyleAt(caretPos - 1)

   340

   341

        # check before

   342

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

   343

            braceAtCaret = caretPos - 1

   344

   345

        # check after

   346

        if braceAtCaret < 0:

   347

            charAfter = self.GetCharAt(caretPos)

   348

            styleAfter = self.GetStyleAt(caretPos)

   349

   350

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

   351

                braceAtCaret = caretPos

   352

   353

        if braceAtCaret >= 0:

   354

            braceOpposite = self.BraceMatch(braceAtCaret)

   355

   356

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

   357

            self.BraceBadLight(braceAtCaret)

   358

        else:

   359

            self.BraceHighlight(braceAtCaret, braceOpposite)

   360

   361

        selected_text = self.GetSelectedText()

   362

        if selected_text:

   363

            self.ParentWindow.SetCopyBuffer(selected_text, True)

   364

   365

    def OnMarginClick(self, event):

   366

        # fold and unfold as needed

   367

        if evt.GetMargin() == 2:

   368

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

   369

                self.FoldAll()

   370

            else:

   371

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

   372

   373

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

   374

                    if evt.GetShift():

   375

                        self.SetFoldExpanded(lineClicked, True)

   376

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

   377

                    elif evt.GetControl():

   378

                        if self.GetFoldExpanded(lineClicked):

   379

                            self.SetFoldExpanded(lineClicked, False)

   380

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

   381

                        else:

   382

                            self.SetFoldExpanded(lineClicked, True)

   383

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

   384

                    else:

   385

                        self.ToggleFold(lineClicked)

   386

        event.Skip()

   387

   388

    def FoldAll(self):

   389

        lineCount = self.GetLineCount()

   390

        expanding = True

   391

   392

        # find out if we are folding or unfolding

   393

        for lineNum in range(lineCount):

   394

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

   395

                expanding = not self.GetFoldExpanded(lineNum)

   396

                break

   397

   398

        lineNum = 0

   399

   400

        while lineNum < lineCount:

   401

            level = self.GetFoldLevel(lineNum)

   402

            if level & stc.STC_FOLDLEVELHEADERFLAG and \

   403

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

   404

   405

                if expanding:

   406

                    self.SetFoldExpanded(lineNum, True)

   407

                    lineNum = self.Expand(lineNum, True)

   408

                    lineNum = lineNum - 1

   409

                else:

   410

                    lastChild = self.GetLastChild(lineNum, -1)

   411

                    self.SetFoldExpanded(lineNum, False)

   412

   413

                    if lastChild > lineNum:

   414

                        self.HideLines(lineNum+1, lastChild)

   415

   416

            lineNum = lineNum + 1

   417

   418

   419

   420

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

   421

        lastChild = self.GetLastChild(line, level)

   422

        line = line + 1

   423

   424

        while line <= lastChild:

   425

            if force:

   426

                if visLevels > 0:

   427

                    self.ShowLines(line, line)

   428

                else:

   429

                    self.HideLines(line, line)

   430

            else:

   431

                if doExpand:

   432

                    self.ShowLines(line, line)

   433

   434

            if level == -1:

   435

                level = self.GetFoldLevel(line)

   436

   437

            if level & stc.STC_FOLDLEVELHEADERFLAG:

   438

                if force:

   439

                    if visLevels > 1:

   440

                        self.SetFoldExpanded(line, True)

   441

                    else:

   442

                        self.SetFoldExpanded(line, False)

   443

   444

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

   445

   446

                else:

   447

                    if doExpand and self.GetFoldExpanded(line):

   448

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

   449

                    else:

   450

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

   451

            else:

   452

                line = line + 1

   453

   454

        return line

   455

   456

    def Cut(self):

   457

        self.ResetBuffer()

   458

        self.DisableEvents = True

   459

        self.CmdKeyExecute(wx.stc.STC_CMD_CUT)

   460

        self.DisableEvents = False

   461

        self.RefreshModel()

   462

        self.RefreshBuffer()

   463

   464

    def Copy(self):

   465

        self.CmdKeyExecute(wx.stc.STC_CMD_COPY)

   466

        self.ParentWindow.RefreshEditMenu()

   467

   468

    def Paste(self):

   469

        self.ResetBuffer()

   470

        self.DisableEvents = True

   471

        self.CmdKeyExecute(wx.stc.STC_CMD_PASTE)

   472

        self.DisableEvents = False

   473

        self.RefreshModel()

   474

        self.RefreshBuffer()

   475

   476

    def Find(self, direction, search_params):

   477

        if self.SearchParams != search_params:

   478

            self.ClearHighlights(SEARCH_RESULT_HIGHLIGHT)

   479

   480

            self.SearchParams = search_params

   481

            criteria = {

   482

                "raw_pattern": search_params["find_pattern"], 

   483

                "pattern": re.compile(search_params["find_pattern"]),

   484

                "case_sensitive": search_params["case_sensitive"],

   485

                "regular_expression": search_params["regular_expression"],

   486

                "filter": "all"}

   487

   488

            self.SearchResults = [

   489

                (start, end, SEARCH_RESULT_HIGHLIGHT)

   490

                for start, end, text in 

   491

                TestTextElement(self.GetText(), criteria)]

   492

            self.CurrentFindHighlight = None

   493

   494

        if len(self.SearchResults) > 0:

   495

            if self.CurrentFindHighlight is not None:

   496

                old_idx = self.SearchResults.index(self.CurrentFindHighlight)

   497

                if self.SearchParams["wrap"]:

   498

                    idx = (old_idx + direction) % len(self.SearchResults)

   499

                else:

   500

                    idx = max(0, min(old_idx + direction, len(self.SearchResults) - 1))

   501

                if idx != old_idx:

   502

                    self.RemoveHighlight(*self.CurrentFindHighlight)

   503

                    self.CurrentFindHighlight = self.SearchResults[idx]