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

class CodeEditor(CustomStyledTextCtrl):

    26

    27

    KEYWORDS = []

    28

    COMMENT_HEADER = ""

    29

    30

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

    31

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

    32

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

    33

    34

        self.SetMarginType(1, stc.STC_MARGIN_NUMBER)

    35

        self.SetMarginWidth(1, 25)

    36

    37

        self.CmdKeyAssign(ord('B'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMIN)

    38

        self.CmdKeyAssign(ord('N'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMOUT)

    39

    40

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

    41

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

    42

        self.SetMargins(0,0)

    43

    44

        self.SetViewWhiteSpace(False)

    45

    46

        self.SetEdgeMode(stc.STC_EDGE_BACKGROUND)

    47

        self.SetEdgeColumn(78)

    48

    49

        # Setup a margin to hold fold markers

    50

        self.SetMarginType(2, stc.STC_MARGIN_SYMBOL)

    51

        self.SetMarginMask(2, stc.STC_MASK_FOLDERS)

    52

        self.SetMarginSensitive(2, True)

    53

        self.SetMarginWidth(2, 12)

    54

    55

        # Like a flattened tree control using square headers

    56

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

    57

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

    58

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

    59

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

    60

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

    61

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

    62

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

    63

    64

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

    65

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

    66

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

    67

    68

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

    69

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

    70

        # Scintilla sample property files.

    71

    72

        # Global default styles for all languages

    73

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

    74

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

    75

    76

        # Global default styles for all languages

    77

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

    78

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

    79

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

    80

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

    81

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

    82

    83

        # Highlighting styles

    84

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

    85

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

    86

    87

        # Section style

    88

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

    89

        self.StyleSetChangeable(STC_CODE_SECTION, False)

    90

    91

        # register some images for use in the AutoComplete box.

    92

        #self.RegisterImage(1, images.getSmilesBitmap())

    93

        self.RegisterImage(1, 

    94

            wx.ArtProvider.GetBitmap(wx.ART_DELETE, size=(16,16)))

    95

        self.RegisterImage(2, 

    96

            wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16,16)))

    97

        self.RegisterImage(3, 

    98

            wx.ArtProvider.GetBitmap(wx.ART_COPY, size=(16,16)))

    99

   100

        # Indentation size

   101

        self.SetTabWidth(2)

   102

        self.SetUseTabs(0)

   103

   104

        self.SetCodeLexer()

   105

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

   106

   107

        self.Controler = controler

   108

        self.ParentWindow = window

   109

   110

        self.DisableEvents = True

   111

        self.CurrentAction = None

   112

   113

        self.Highlights = []

   114

        self.SearchParams = None

   115

        self.SearchResults = None

   116

        self.CurrentFindHighlight = None

   117

   118

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

   119

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

   120

   121

        self.SectionsComments = {}

   122

        for section in self.Controler.SECTIONS_NAMES:

   123

            section_comment = " %s section " % (section)

   124

            len_headers = 78 - len(section_comment)

   125

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

   126

                              section_comment + \

   127

                              self.COMMENT_HEADER * (len_headers - len_headers / 2)

   128

   129

            self.SectionsComments[section] = {

   130

                 "comment": section_comment,

   131

            }

   132

   133

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

   134

            section_infos = self.SectionsComments[section]

   135

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

   136

                section_end = self.SectionsComments[

   137

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

   138

            else:

   139

                section_end = "$"

   140

            section_infos["pattern"] = re.compile(

   141

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

   142

                section_end, re.DOTALL)

   143

   144

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

   145

   146

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

   147

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

   148

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

   149

   150

    def SetCodeLexer(self):

   151

        pass

   152

   153

    def OnModification(self, event):

   154

        if not self.DisableEvents:

   155

            mod_type = event.GetModificationType()

   156

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

   157

                if mod_type&wx.stc.STC_MOD_BEFOREINSERT:

   158

                    if self.CurrentAction == None:

   159

                        self.StartBuffering()

   160

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

   161

                        self.Controler.EndBuffering()

   162

                        self.StartBuffering()

   163

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

   164

                    wx.CallAfter(self.RefreshModel)

   165

                elif mod_type&wx.stc.STC_MOD_BEFOREDELETE:

   166

                    if self.CurrentAction == None:

   167

                        self.StartBuffering()

   168

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

   169

                        self.Controler.EndBuffering()

   170

                        self.StartBuffering()

   171

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

   172

                    wx.CallAfter(self.RefreshModel)

   173

        wx.CallAfter(self.RefreshSectionStyling)

   174

        event.Skip()

   175

   176

    def OnDoDrop(self, event):

   177

        try:

   178

            values = eval(event.GetDragText())

   179

        except:

   180

            values = event.GetDragText()

   181

        if isinstance(values, tuple):

   182

            message = None

   183

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

   184

                self.ResetBuffer()

   185

                event.SetDragText(values[0])

   186

                wx.CallAfter(self.RefreshModel)

   187

            else:

   188

                event.SetDragText("")

   189

        else:

   190

            self.ResetBuffer()

   191

            wx.CallAfter(self.RefreshModel)

   192

        event.Skip()

   193

   194

    # Buffer the last model state

   195

    def RefreshBuffer(self):

   196

        self.Controler.BufferCodeFile()

   197

        if self.ParentWindow is not None:

   198

            self.ParentWindow.RefreshTitle()

   199

            self.ParentWindow.RefreshFileMenu()

   200

            self.ParentWindow.RefreshEditMenu()

   201

            self.ParentWindow.RefreshPageTitles()

   202

   203

    def StartBuffering(self):

   204

        self.Controler.StartBuffering()

   205

        if self.ParentWindow is not None:

   206

            self.ParentWindow.RefreshTitle()

   207

            self.ParentWindow.RefreshFileMenu()

   208

            self.ParentWindow.RefreshEditMenu()

   209

            self.ParentWindow.RefreshPageTitles()

   210

   211

    def ResetBuffer(self):

   212

        if self.CurrentAction != None:

   213

            self.Controler.EndBuffering()

   214

            self.CurrentAction = None

   215

   216

    def GetCodeText(self):

   217

        parts = self.Controler.GetTextParts()

   218

        text = ""

   219

        for section in self.Controler.SECTIONS_NAMES:

   220

            section_comments = self.SectionsComments[section]

   221

            text += section_comments["comment"]

   222

            if parts[section] == "":

   223

                text += "\n"

   224

            else:

   225

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

   226

                    text += "\n"

   227

                text += parts[section]

   228

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

   229

                    text += "\n"

   230

        return text

   231

   232

    def RefreshView(self, scroll_to_highlight=False):

   233

        self.ResetBuffer()

   234

        self.DisableEvents = True

   235

        old_cursor_pos = self.GetCurrentPos()

   236

        line = self.GetFirstVisibleLine()

   237

        column = self.GetXOffset()

   238

        old_text = self.GetText()

   239

        new_text = self.GetCodeText()

   240

        if old_text != new_text:

   241

            self.SetText(new_text)

   242

            new_cursor_pos = GetCursorPos(old_text, new_text)

   243

            self.LineScroll(column, line)

   244

            if new_cursor_pos != None:

   245

                self.GotoPos(new_cursor_pos)

   246

            else:

   247

                self.GotoPos(old_cursor_pos)

   248

            self.EmptyUndoBuffer()

   249

        self.DisableEvents = False

   250

   251

        self.RefreshSectionStyling()

   252

   253

        self.ShowHighlights()

   254

   255

    def RefreshSectionStyling(self):

   256

        self.Colourise(0, -1)

   257

   258

        text = self.GetText()

   259

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

   260

            self.SetLineState(line, 0)

   261

   262

        for section in self.Controler.SECTIONS_NAMES:

   263

            section_comments = self.SectionsComments[section]

   264

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

   265

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

   266

            self.StartStyling(start_pos, 0xff)

   267

            self.SetStyling(end_pos - start_pos, STC_CODE_SECTION)

   268

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

   269

   270

        self.StartStyling(end_pos, 0x00)

   271

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

   272

   273

    def DoGetBestSize(self):

   274

        return self.ParentWindow.GetPanelBestSize()

   275

   276

    def RefreshModel(self):

   277

        text = self.GetText()

   278

        parts = {}

   279

        for section in self.Controler.SECTIONS_NAMES:

   280

            section_comments = self.SectionsComments[section]

   281

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

   282

            if result is not None:

   283

                parts[section] = result.group(1)

   284

            else:

   285

                parts[section] = ""

   286

        self.Controler.SetTextParts(parts)

   287

   288

    def OnKeyPressed(self, event):

   289

        if self.CallTipActive():

   290

            self.CallTipCancel()

   291

        key = event.GetKeyCode()

   292

        current_pos = self.GetCurrentPos()

   293

        selected = self.GetSelection()

   294

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

   295

   296

        # Test if caret is before Windows like new line

   297

        text = self.GetText()

   298

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

   299

            newline_size = 2

   300

        else:

   301

            newline_size = 1

   302

   303

        # Disable to type any character in section header lines

   304

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

   305

            not text_selected and

   306

            key not in NAVIGATION_KEYS + [

   307

                wx.WXK_RETURN,

   308

                wx.WXK_NUMPAD_ENTER]):

   309

            return

   310

   311

        # Disable to delete line between code and header lines

   312

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

   313

              (key == wx.WXK_BACK and

   314

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

   315

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

   316

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

   317

            return

   318

   319

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

   320

            pos = self.GetCurrentPos()

   321

   322

            # Tips

   323

            if event.ShiftDown():

   324

                pass

   325

            # Code completion

   326

            else:

   327

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

   328

   329

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

   330

                                            for var in self.Controler.GetVariables()]

   331

                keywords.sort()

   332

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

   333

        else:

   334

            event.Skip()

   335

   336

    def OnKillFocus(self, event):

   337

        self.AutoCompCancel()

   338

        event.Skip()

   339

   340

    def OnUpdateUI(self, event):

   341

        # check for matching braces

   342

        braceAtCaret = -1

   343

        braceOpposite = -1

   344

        charBefore = None

   345

        caretPos = self.GetCurrentPos()

   346

   347

        if caretPos > 0:

   348

            charBefore = self.GetCharAt(caretPos - 1)

   349

            styleBefore = self.GetStyleAt(caretPos - 1)

   350

   351

        # check before

   352

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

   353

            braceAtCaret = caretPos - 1

   354

   355

        # check after

   356

        if braceAtCaret < 0:

   357

            charAfter = self.GetCharAt(caretPos)

   358

            styleAfter = self.GetStyleAt(caretPos)

   359

   360

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

   361

                braceAtCaret = caretPos

   362

   363

        if braceAtCaret >= 0:

   364

            braceOpposite = self.BraceMatch(braceAtCaret)

   365

   366

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

   367

            self.BraceBadLight(braceAtCaret)

   368

        else:

   369

            self.BraceHighlight(braceAtCaret, braceOpposite)

   370

   371

        selected_text = self.GetSelectedText()

   372

        if selected_text:

   373

            self.ParentWindow.SetCopyBuffer(selected_text, True)

   374

        event.Skip()

   375

   376

    def OnMarginClick(self, event):

   377

        # fold and unfold as needed

   378

        if evt.GetMargin() == 2:

   379

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

   380

                self.FoldAll()

   381

            else:

   382

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

   383

   384

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

   385

                    if evt.GetShift():

   386

                        self.SetFoldExpanded(lineClicked, True)

   387

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

   388

                    elif evt.GetControl():

   389

                        if self.GetFoldExpanded(lineClicked):

   390

                            self.SetFoldExpanded(lineClicked, False)

   391

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

   392

                        else:

   393

                            self.SetFoldExpanded(lineClicked, True)

   394

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

   395

                    else:

   396

                        self.ToggleFold(lineClicked)

   397

        event.Skip()

   398

   399

    def FoldAll(self):

   400

        lineCount = self.GetLineCount()

   401

        expanding = True

   402

   403

        # find out if we are folding or unfolding

   404

        for lineNum in range(lineCount):

   405

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

   406

                expanding = not self.GetFoldExpanded(lineNum)

   407

                break

   408

   409

        lineNum = 0

   410

   411

        while lineNum < lineCount:

   412

            level = self.GetFoldLevel(lineNum)

   413

            if level & stc.STC_FOLDLEVELHEADERFLAG and \

   414

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

   415

   416

                if expanding:

   417

                    self.SetFoldExpanded(lineNum, True)

   418

                    lineNum = self.Expand(lineNum, True)

   419

                    lineNum = lineNum - 1

   420

                else:

   421

                    lastChild = self.GetLastChild(lineNum, -1)

   422

                    self.SetFoldExpanded(lineNum, False)

   423

   424

                    if lastChild > lineNum:

   425

                        self.HideLines(lineNum+1, lastChild)

   426

   427

            lineNum = lineNum + 1

   428

   429

   430

   431

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

   432

        lastChild = self.GetLastChild(line, level)

   433

        line = line + 1

   434

   435

        while line <= lastChild:

   436

            if force:

   437

                if visLevels > 0:

   438

                    self.ShowLines(line, line)

   439

                else:

   440

                    self.HideLines(line, line)

   441

            else:

   442

                if doExpand:

   443

                    self.ShowLines(line, line)

   444

   445

            if level == -1:

   446

                level = self.GetFoldLevel(line)

   447

   448

            if level & stc.STC_FOLDLEVELHEADERFLAG:

   449

                if force:

   450

                    if visLevels > 1:

   451

                        self.SetFoldExpanded(line, True)

   452

                    else:

   453

                        self.SetFoldExpanded(line, False)

   454

   455

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

   456

   457

                else:

   458

                    if doExpand and self.GetFoldExpanded(line):

   459

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

   460

                    else:

   461

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

   462

            else:

   463

                line = line + 1

   464

   465

        return line

   466

   467

    def Cut(self):

   468

        self.ResetBuffer()

   469

        self.DisableEvents = True

   470

        self.CmdKeyExecute(wx.stc.STC_CMD_CUT)

   471

        self.DisableEvents = False

   472

        self.RefreshModel()

   473

        self.RefreshBuffer()

   474

   475

    def Copy(self):

   476

        self.CmdKeyExecute(wx.stc.STC_CMD_COPY)

   477

        self.ParentWindow.RefreshEditMenu()

   478

   479

    def Paste(self):

   480

        self.ResetBuffer()

   481

        self.DisableEvents = True

   482

        self.CmdKeyExecute(wx.stc.STC_CMD_PASTE)

   483

        self.DisableEvents = False

   484

        self.RefreshModel()

   485

        self.RefreshBuffer()

   486

   487

    def Find(self, direction, search_params):

   488

        if self.SearchParams != search_params:

   489

            self.ClearHighlights(SEARCH_RESULT_HIGHLIGHT)

   490

   491

            self.SearchParams = search_params

   492

            criteria = {

   493

                "raw_pattern": search_params["find_pattern"], 

   494

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

   495

                "case_sensitive": search_params["case_sensitive"],

   496

                "regular_expression": search_params["regular_expression"],

   497

                "filter": "all"}

   498

   499

            self.SearchResults = [

   500

                (start, end, SEARCH_RESULT_HIGHLIGHT)

   501

                for start, end, text in 

   502

                TestTextElement(self.GetText(), criteria)]

   503

            self.CurrentFindHighlight = None

   504