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.ResetSearchResults()

   104

   105

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

   106

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

   107

   108

        self.SectionsComments = {}

   109

        for section in self.Controler.SECTIONS_NAMES:

   110

            section_comment = " %s section " % (section)

   111

            len_headers = EDGE_COLUMN - len(section_comment)

   112

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

   113

                              section_comment + \

   114

                              self.COMMENT_HEADER * (len_headers - len_headers / 2)

   115

   116

            self.SectionsComments[section] = {

   117

                 "comment": section_comment,

   118

            }

   119

   120

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

   121

            section_infos = self.SectionsComments[section]

   122

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

   123

                section_end = self.SectionsComments[

   124

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

   125

            else:

   126

                section_end = "$"

   127

            section_infos["pattern"] = re.compile(

   128

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

   129

                section_end, re.DOTALL)

   130

   131

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

   132

   133

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

   134

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

   135

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

   136

   137

    def SetCodeLexer(self):

   138

        pass

   139

   140

    def ResetSearchResults(self):

   141

        self.Highlights = []

   142

        self.SearchParams = None

   143

        self.SearchResults = None

   144

        self.CurrentFindHighlight = None

   145

   146

    def OnModification(self, event):

   147

        if not self.DisableEvents:

   148

            mod_type = event.GetModificationType()

   149

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

   150

                if mod_type&wx.stc.STC_MOD_BEFOREINSERT:

   151

                    if self.CurrentAction == None:

   152

                        self.StartBuffering()

   153

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

   154

                        self.Controler.EndBuffering()

   155

                        self.StartBuffering()

   156

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

   157

                    wx.CallAfter(self.RefreshModel)

   158

                elif mod_type&wx.stc.STC_MOD_BEFOREDELETE:

   159

                    if self.CurrentAction == None:

   160

                        self.StartBuffering()

   161

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

   162

                        self.Controler.EndBuffering()

   163

                        self.StartBuffering()

   164

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

   165

                    wx.CallAfter(self.RefreshModel)

   166

        wx.CallAfter(self.RefreshSectionStyling)

   167

        event.Skip()

   168

   169

    def OnDoDrop(self, event):

   170

        try:

   171

            values = eval(event.GetDragText())

   172

        except:

   173

            values = event.GetDragText()

   174

        if isinstance(values, tuple):

   175

            message = None

   176

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

   177

                self.ResetBuffer()

   178

                event.SetDragText(values[0])

   179

                wx.CallAfter(self.RefreshModel)

   180

            else:

   181

                event.SetDragText("")

   182

        else:

   183

            self.ResetBuffer()

   184

            wx.CallAfter(self.RefreshModel)

   185

        event.Skip()

   186

   187

    # Buffer the last model state

   188

    def RefreshBuffer(self):

   189

        self.Controler.BufferCodeFile()

   190

        if self.ParentWindow is not None:

   191

            self.ParentWindow.RefreshTitle()

   192

            self.ParentWindow.RefreshFileMenu()

   193

            self.ParentWindow.RefreshEditMenu()

   194

            self.ParentWindow.RefreshPageTitles()

   195

   196

    def StartBuffering(self):

   197

        self.Controler.StartBuffering()

   198

        if self.ParentWindow is not None:

   199

            self.ParentWindow.RefreshTitle()

   200

            self.ParentWindow.RefreshFileMenu()

   201

            self.ParentWindow.RefreshEditMenu()

   202

            self.ParentWindow.RefreshPageTitles()

   203

   204

    def ResetBuffer(self):

   205

        if self.CurrentAction != None:

   206

            self.Controler.EndBuffering()

   207

            self.CurrentAction = None

   208

   209

    def GetCodeText(self):

   210

        parts = self.Controler.GetTextParts()

   211

        text = ""

   212

        for section in self.Controler.SECTIONS_NAMES:

   213

            section_comments = self.SectionsComments[section]

   214

            text += section_comments["comment"]

   215

            if parts[section] == "":

   216

                text += "\n"

   217

            else:

   218

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

   219

                    text += "\n"

   220

                text += parts[section]

   221

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

   222

                    text += "\n"

   223

        return text

   224

   225

    def RefreshView(self, scroll_to_highlight=False):

   226

        self.ResetBuffer()

   227

        self.DisableEvents = True

   228

        old_cursor_pos = self.GetCurrentPos()

   229

        line = self.GetFirstVisibleLine()

   230

        column = self.GetXOffset()

   231

        old_text = self.GetText()

   232

        new_text = self.GetCodeText()

   233

        if old_text != new_text:

   234

            self.SetText(new_text)

   235

            new_cursor_pos = GetCursorPos(old_text, new_text)

   236

            self.LineScroll(column, line)

   237

            if new_cursor_pos != None:

   238

                self.GotoPos(new_cursor_pos)

   239

            else:

   240

                self.GotoPos(old_cursor_pos)

   241

            self.EmptyUndoBuffer()

   242

        self.DisableEvents = False

   243

   244

        self.RefreshSectionStyling()

   245

   246

        self.ShowHighlights()

   247

   248

    def RefreshSectionStyling(self):

   249

        self.Colourise(0, -1)

   250

   251

        text = self.GetText()

   252

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

   253

            self.SetLineState(line, 0)

   254

   255

        for section in self.Controler.SECTIONS_NAMES:

   256

            section_comments = self.SectionsComments[section]

   257

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

   258

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

   259

            self.StartStyling(start_pos, 0xff)

   260

            self.SetStyling(end_pos - start_pos, STC_CODE_SECTION)

   261

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

   262

   263

        self.StartStyling(end_pos, 0x00)

   264

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

   265

   266

    def DoGetBestSize(self):

   267

        return self.ParentWindow.GetPanelBestSize()

   268

   269

    def RefreshModel(self):

   270

        text = self.GetText()

   271

        parts = {}

   272

        for section in self.Controler.SECTIONS_NAMES:

   273

            section_comments = self.SectionsComments[section]

   274

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

   275

            if result is not None:

   276

                parts[section] = result.group(1)

   277

            else:

   278

                parts[section] = ""

   279

        self.Controler.SetTextParts(parts)

   280

        self.ResetSearchResults()

   281

   282

    def OnKeyPressed(self, event):

   283

        if self.CallTipActive():

   284

            self.CallTipCancel()

   285

        key = event.GetKeyCode()

   286

        current_pos = self.GetCurrentPos()

   287

        selected = self.GetSelection()

   288

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

   289

   290

        # Test if caret is before Windows like new line

   291

        text = self.GetText()

   292

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

   293

            newline_size = 2

   294

        else:

   295

            newline_size = 1

   296

   297

        # Disable to type any character in section header lines

   298

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

   299

            not text_selected and

   300

            key not in NAVIGATION_KEYS + [

   301

                wx.WXK_RETURN,

   302

                wx.WXK_NUMPAD_ENTER]):

   303

            return

   304

   305

        # Disable to delete line between code and header lines

   306

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

   307

              (key == wx.WXK_BACK and

   308

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

   309

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

   310

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

   311

            return

   312

   313

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

   314

            pos = self.GetCurrentPos()

   315

   316

            # Tips

   317

            if event.ShiftDown():

   318

                pass

   319

            # Code completion

   320

            else:

   321

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

   322

   323

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

   324

                                            for var in self.Controler.GetVariables()]

   325

                keywords.sort()

   326

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

   327

        else:

   328

            event.Skip()

   329

   330

    def OnKillFocus(self, event):

   331

        self.AutoCompCancel()

   332

        event.Skip()

   333

   334

    def OnUpdateUI(self, event):

   335

        # check for matching braces

   336

        braceAtCaret = -1

   337

        braceOpposite = -1

   338

        charBefore = None

   339

        caretPos = self.GetCurrentPos()

   340

   341

        if caretPos > 0:

   342

            charBefore = self.GetCharAt(caretPos - 1)

   343

            styleBefore = self.GetStyleAt(caretPos - 1)

   344

   345

        # check before

   346

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

   347

            braceAtCaret = caretPos - 1

   348

   349

        # check after

   350

        if braceAtCaret < 0:

   351

            charAfter = self.GetCharAt(caretPos)

   352

            styleAfter = self.GetStyleAt(caretPos)

   353

   354

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

   355

                braceAtCaret = caretPos

   356

   357

        if braceAtCaret >= 0:

   358

            braceOpposite = self.BraceMatch(braceAtCaret)

   359

   360

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

   361

            self.BraceBadLight(braceAtCaret)

   362

        else:

   363

            self.BraceHighlight(braceAtCaret, braceOpposite)

   364

   365

        selected_text = self.GetSelectedText()

   366

        if selected_text:

   367

            self.ParentWindow.SetCopyBuffer(selected_text, True)

   368

   369

    def OnMarginClick(self, event):

   370

        # fold and unfold as needed

   371

        if evt.GetMargin() == 2:

   372

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

   373

                self.FoldAll()

   374

            else:

   375

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

   376

   377

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

   378

                    if evt.GetShift():

   379

                        self.SetFoldExpanded(lineClicked, True)

   380

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

   381

                    elif evt.GetControl():

   382

                        if self.GetFoldExpanded(lineClicked):

   383

                            self.SetFoldExpanded(lineClicked, False)

   384

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

   385

                        else:

   386

                            self.SetFoldExpanded(lineClicked, True)

   387

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

   388

                    else:

   389

                        self.ToggleFold(lineClicked)

   390

        event.Skip()

   391

   392

    def FoldAll(self):

   393

        lineCount = self.GetLineCount()

   394

        expanding = True

   395

   396

        # find out if we are folding or unfolding

   397

        for lineNum in range(lineCount):

   398

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

   399

                expanding = not self.GetFoldExpanded(lineNum)

   400

                break

   401

   402

        lineNum = 0

   403

   404

        while lineNum < lineCount:

   405

            level = self.GetFoldLevel(lineNum)

   406

            if level & stc.STC_FOLDLEVELHEADERFLAG and \

   407

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

   408

   409

                if expanding:

   410

                    self.SetFoldExpanded(lineNum, True)

   411

                    lineNum = self.Expand(lineNum, True)

   412

                    lineNum = lineNum - 1

   413

                else:

   414

                    lastChild = self.GetLastChild(lineNum, -1)

   415

                    self.SetFoldExpanded(lineNum, False)

   416

   417

                    if lastChild > lineNum:

   418

                        self.HideLines(lineNum+1, lastChild)

   419

   420

            lineNum = lineNum + 1

   421

   422

   423

   424

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

   425

        lastChild = self.GetLastChild(line, level)

   426

        line = line + 1

   427

   428

        while line <= lastChild:

   429

            if force:

   430

                if visLevels > 0:

   431

                    self.ShowLines(line, line)

   432

                else:

   433

                    self.HideLines(line, line)

   434

            else:

   435

                if doExpand:

   436

                    self.ShowLines(line, line)

   437

   438

            if level == -1:

   439

                level = self.GetFoldLevel(line)

   440

   441

            if level & stc.STC_FOLDLEVELHEADERFLAG:

   442

                if force:

   443

                    if visLevels > 1:

   444

                        self.SetFoldExpanded(line, True)

   445

                    else:

   446

                        self.SetFoldExpanded(line, False)

   447

   448

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

   449

   450

                else:

   451

                    if doExpand and self.GetFoldExpanded(line):

   452

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

   453

                    else:

   454

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

   455

            else:

   456

                line = line + 1

   457

   458

        return line

   459

   460

    def Cut(self):

   461

        self.ResetBuffer()

   462

        self.DisableEvents = True

   463

        self.CmdKeyExecute(wx.stc.STC_CMD_CUT)

   464

        self.DisableEvents = False

   465

        self.RefreshModel()

   466

        self.RefreshBuffer()

   467

   468

    def Copy(self):

   469

        self.CmdKeyExecute(wx.stc.STC_CMD_COPY)

   470

        self.ParentWindow.RefreshEditMenu()

   471

   472

    def Paste(self):

   473

        self.ResetBuffer()

   474

        self.DisableEvents = True

   475

        self.CmdKeyExecute(wx.stc.STC_CMD_PASTE)

   476

        self.DisableEvents = False

   477

        self.RefreshModel()

   478

        self.RefreshBuffer()

   479

   480

    def Find(self, direction, search_params):

   481

        if self.SearchParams != search_params:

   482

            self.ClearHighlights(SEARCH_RESULT_HIGHLIGHT)

   483

   484

            self.SearchParams = search_params

   485

            criteria = {

   486

                "raw_pattern": search_params["find_pattern"], 

   487

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

   488

                "case_sensitive": search_params["case_sensitive"],

   489

                "regular_expression": search_params["regular_expression"],

   490

                "filter": "all"}

   491

   492

            self.SearchResults = [

   493

                (start, end, SEARCH_RESULT_HIGHLIGHT)

   494

                for start, end, text in 

   495

                TestTextElement(self.GetText(), criteria)]

   496

            self.CurrentFindHighlight = None

   497

   498

        if len(self.SearchResults) > 0:

   499

            if self.CurrentFindHighlight is not None:

   500

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

   501

                if self.SearchParams["wrap"]:

   502

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