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

from types import TupleType

    26

    27

import wx

    28

import wx.lib.buttons

    29

import wx.lib.agw.customtreectrl as CT

    30

    31

from PLCControler import *

    32

from util.BitmapLibrary import GetBitmap

    33

    34

    35

def GenerateName(infos):

    36

    if infos[0] in ["input", "output", "value"]:

    37

        return "%s %d:" % (infos[0], infos[1])

    38

    elif infos[0] == "range":

    39

        return "%s %d %s" % (infos[0], infos[1], infos[2])

    40

    elif infos[0] == "struct":

    41

        return "element %d %s" % (infos[1], infos[2])

    42

    return "%s:" % infos[0]

    43

    44

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

    45

#                            Search Result Panel

    46

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

    47

    48

    49

[ID_SEARCHRESULTPANEL, ID_SEARCHRESULTPANELHEADERLABEL,

    50

 ID_SEARCHRESULTPANELSEARCHRESULTSTREE, ID_SEARCHRESULTPANELRESETBUTTON,

    51

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

    52

    53

    54

class SearchResultPanel(wx.Panel):

    55

    56

    if wx.VERSION < (2, 6, 0):

    57

        def Bind(self, event, function, id=None):

    58

            if id is not None:

    59

                event(self, id, function)

    60

            else:

    61

                event(self, function)

    62

    63

    def _init_coll_MainSizer_Items(self, parent):

    64

        parent.AddSizer(self.HeaderSizer, 0, border=0, flag=wx.GROW)

    65

        parent.AddWindow(self.SearchResultsTree, 1, border=0, flag=wx.GROW)

    66

    67

    def _init_coll_MainSizer_Growables(self, parent):

    68

        parent.AddGrowableCol(0)

    69

        parent.AddGrowableRow(1)

    70

    71

    def _init_coll_HeaderSizer_Items(self, parent):

    72

        parent.AddWindow(self.HeaderLabel, 1, border=5, flag=wx.LEFT | wx.RIGHT | wx.ALIGN_CENTER_VERTICAL)

    73

        parent.AddWindow(self.ResetButton, 0, border=0, flag=0)

    74

    75

    def _init_coll_HeaderSizer_Growables(self, parent):

    76

        parent.AddGrowableCol(0)

    77

    78

    def _init_sizers(self):

    79

        self.MainSizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0)

    80

        self.HeaderSizer = wx.BoxSizer(wx.HORIZONTAL)

    81

    82

        self._init_coll_MainSizer_Items(self.MainSizer)

    83

        self._init_coll_MainSizer_Growables(self.MainSizer)

    84

        self._init_coll_HeaderSizer_Items(self.HeaderSizer)

    85

    86

        self.SetSizer(self.MainSizer)

    87

    88

    def _init_ctrls(self, prnt):

    89

        wx.Panel.__init__(self, id=ID_SEARCHRESULTPANEL,

    90

              name='SearchResultPanel', parent=prnt, pos=wx.Point(0, 0),

    91

              size=wx.Size(0, 0), style=wx.TAB_TRAVERSAL)

    92

    93

        self.HeaderLabel = wx.StaticText(id=ID_SEARCHRESULTPANELHEADERLABEL,

    94

              name='HeaderLabel', parent=self,

    95

              pos=wx.Point(0, 0), size=wx.Size(0, 17), style=0)

    96

    97

        search_results_tree_style = CT.TR_HAS_BUTTONS | CT.TR_NO_LINES | CT.TR_HAS_VARIABLE_ROW_HEIGHT

    98

        self.SearchResultsTree = CT.CustomTreeCtrl(id=ID_SEARCHRESULTPANELSEARCHRESULTSTREE,

    99

              name="SearchResultsTree", parent=self,

   100

              pos=wx.Point(0, 0), style=search_results_tree_style)

   101

        if wx.VERSION >= (2, 8, 11):

   102

            self.SearchResultsTree.SetAGWWindowStyleFlag(search_results_tree_style)

   103

        self.Bind(wx.EVT_TREE_ITEM_ACTIVATED, self.OnSearchResultsTreeItemActivated,

   104

              id=ID_SEARCHRESULTPANELSEARCHRESULTSTREE)

   105

   106

        self.ResetButton = wx.lib.buttons.GenBitmapButton(self,

   107

              bitmap=GetBitmap("reset"), size=wx.Size(28, 28), style=wx.NO_BORDER)

   108

        self.ResetButton.SetToolTipString(_("Reset search result"))

   109

        self.Bind(wx.EVT_BUTTON, self.OnResetButton, self.ResetButton)

   110

   111

        self._init_sizers()

   112

   113

    def __init__(self, parent, window):

   114

        self.ParentWindow = window

   115

   116

        self._init_ctrls(parent)

   117

   118

        # Define Tree item icon list

   119

        self.TreeImageList = wx.ImageList(16, 16)

   120

        self.TreeImageDict = {}

   121

   122

        # Icons for other items

   123

        for imgname, itemtype in [

   124

            # editables

   125

            ("PROJECT",        ITEM_PROJECT),

   126

            ("TRANSITION",     ITEM_TRANSITION),

   127

            ("ACTION",         ITEM_ACTION),

   128

            ("CONFIGURATION",  ITEM_CONFIGURATION),

   129

            ("RESOURCE",       ITEM_RESOURCE),

   130

            ("DATATYPE",       ITEM_DATATYPE),

   131

            ("ACTION",         "action_block"),

   132

            ("IL",             "IL"),

   133

            ("ST",             "ST")]:

   134

            self.TreeImageDict[itemtype] = self.TreeImageList.Add(GetBitmap(imgname))

   135

   136

        for itemtype in ["function", "functionBlock", "program",

   137

                         "comment", "block", "io_variable",

   138

                         "connector", "contact", "coil",

   139

                         "step", "transition", "jump",

   140

                         "var_local", "var_input",

   141

                         "var_inout", "var_output"]:

   142

            self.TreeImageDict[itemtype] = self.TreeImageList.Add(GetBitmap(itemtype.upper()))

   143

   144

        # Assign icon list to TreeCtrl

   145

        self.SearchResultsTree.SetImageList(self.TreeImageList)

   146

   147

        self.ResetSearchResults()

   148

   149

    def SetSearchResults(self, criteria, search_results):

   150

        self.Criteria = criteria

   151

        self.SearchResults = {}

   152

        self.ElementsOrder = []

   153

   154

        for infos, start, end, text in search_results:

   155

            if infos[0] not in self.ElementsOrder:

   156

                self.ElementsOrder.append(infos[0])

   157

   158

            results = self.SearchResults.setdefault(infos[0], [])

   159

            results.append((infos, start, end, text))

   160

   161

        self.RefreshView()

   162

   163

    def ResetSearchResults(self):

   164

        self.Criteria = None

   165

        self.ElementsOrder = []

   166

        self.SearchResults = {}

   167

        self.RefreshView()

   168

   169

    def RefreshView(self):

   170

        self.SearchResultsTree.DeleteAllItems()

   171

        if self.Criteria is None:

   172

            self.HeaderLabel.SetLabel(_("No search results available."))

   173

            self.ResetButton.Enable(False)

   174

        else:

   175

            matches_number = 0

   176

            search_results_tree_infos = {"name": _("Project '%s':") % self.ParentWindow.Controler.GetProjectName(),

   177

                                         "type": ITEM_PROJECT,

   178

                                         "data": None,

   179

                                         "text": None,

   180

                                         "matches": None,

   181

                                        }

   182

            search_results_tree_children = search_results_tree_infos.setdefault("children", [])

   183

            for tagname in self.ElementsOrder:

   184

                results = self.SearchResults.get(tagname, [])

   185

                matches_number += len(results)

   186

   187

                words = tagname.split("::")

   188

   189

                element_type = self.ParentWindow.Controler.GetElementType(tagname)

   190

                if element_type == ITEM_POU:

   191

                    element_type = self.ParentWindow.Controler.GetPouType(words[1])

   192

   193

                element_infos = {"name": words[-1],

   194

                                 "type": element_type,

   195

                                 "data": tagname,

   196

                                 "text": None,

   197

                                 "matches": len(results)}

   198

   199

                children = element_infos.setdefault("children", [])

   200

                for infos, start, end, text in results:

   201

                    if infos[1] == "name" or element_type == ITEM_DATATYPE:

   202

                        child_name = GenerateName(infos[1:])

   203

                        child_type = element_type

   204

                    else:

   205

                        if element_type == ITEM_RESOURCE:

   206

                            child_type = element_type

   207

                        else:

   208

                            child_type = infos[1]

   209

                        if child_type == "name":

   210

                            child_name = "name"

   211

                        elif child_type == "body":

   212

                            child_name = "body"

   213

                            if element_type == ITEM_TRANSITION:

   214

                                child_type = self.ParentWindow.Controler.GetTransitionBodyType(words[1], words[2])

   215

                            elif element_type == ITEM_ACTION:

   216

                                child_type = self.ParentWindow.Controler.GetActionBodyType(words[1], words[2])

   217

                            else:

   218

                                child_type = self.ParentWindow.Controler.GetPouBodyType(words[1])

   219

                        else:

   220

                            child_name = GenerateName(infos[3:])

   221

                    child_infos = {"name": child_name,

   222

                                   "type": child_type,

   223

                                   "data": (infos, start, end, None),

   224

                                   "text": text,

   225

                                   "matches": 1,

   226

                                   "children": [],

   227

                                  }

   228

                    children.append(child_infos)

   229

   230

                if len(words) > 2:

   231

                    for _element_infos in search_results_tree_children:

   232

                        if _element_infos["name"] == words[1]:

   233

                            _element_infos["matches"] += len(children)

   234

                            _element_infos["children"].append(element_infos)

   235

                            break

   236

                    if element_type == ITEM_RESOURCE:

   237

                        search_results_tree_children.append(element_infos)

   238

                else:

   239

                    search_results_tree_children.append(element_infos)

   240

   241

            if matches_number < 2:

   242

                header_format = _("'{a1}' - {a2} match in project")

   243

            else:

   244

                header_format = _("'{a1}' - {a2} matches in project")

   245

   246

            self.HeaderLabel.SetLabel(header_format.format(a1=self.Criteria["find_pattern"], a2=matches_number))

   247

            self.ResetButton.Enable(True)

   248

   249

            if matches_number > 0:

   250

                root = self.SearchResultsTree.GetRootItem()

   251

                if root is None:

   252

                    root = self.SearchResultsTree.AddRoot(search_results_tree_infos["name"])

   253

                self.GenerateSearchResultsTreeBranch(root, search_results_tree_infos)

   254

                self.SearchResultsTree.Expand(root)

   255

   256

    def GetTextCtrlClickFunction(self, item):

   257

        def OnTextCtrlClick(event):

   258

            self.SearchResultsTree.SelectItem(item)

   259

            event.Skip()

   260

        return OnTextCtrlClick

   261

   262

    def GetTextCtrlDClickFunction(self, item):

   263

        def OnTextCtrlDClick(event):

   264

            self.ShowSearchResults(item)

   265

            event.Skip()

   266

        return OnTextCtrlDClick

   267

   268

    def GenerateSearchResultsTreeBranch(self, root, infos):

   269

        to_delete = []

   270

        if infos["name"] == "body":

   271

            item_name = "%d:" % infos["data"][1][0]

   272

        else:

   273

            item_name = infos["name"]

   274

   275

        self.SearchResultsTree.SetItemText(root, item_name)

   276

        self.SearchResultsTree.SetPyData(root, infos["data"])

   277

        self.SearchResultsTree.SetItemBackgroundColour(root, wx.WHITE)

   278

        self.SearchResultsTree.SetItemTextColour(root, wx.BLACK)

   279

        if infos["type"] is not None:

   280

            if infos["type"] == ITEM_POU:

   281

                self.SearchResultsTree.SetItemImage(root, self.TreeImageDict[self.ParentWindow.Controler.GetPouType(infos["name"])])

   282

            else:

   283

                self.SearchResultsTree.SetItemImage(root, self.TreeImageDict[infos["type"]])

   284

   285

        text = None

   286

        if infos["text"] is not None:

   287

            text = infos["text"]

   288

            start, end = infos["data"][1:3]

   289

            text_lines = infos["text"].splitlines()

   290

            start_idx = start[1]

   291

            end_idx = reduce(lambda x, y: x + y, map(lambda x: len(x) + 1, text_lines[:end[0] - start[0]]), end[1] + 1)

   292

            style = wx.TextAttr(wx.BLACK, wx.Colour(206, 204, 247))

   293

        elif infos["type"] is not None and infos["matches"] > 1:

   294

            text = _("(%d matches)") % infos["matches"]

   295

            start_idx, end_idx = 0, len(text)

   296

            style = wx.TextAttr(wx.Colour(0, 127, 174))

   297

   298

        if text is not None:

   299

            text_ctrl_style = wx.BORDER_NONE | wx.TE_READONLY | wx.TE_RICH2

   300

            if wx.Platform != '__WXMSW__' or len(text.splitlines()) > 1:

   301

                text_ctrl_style |= wx.TE_MULTILINE

   302

            text_ctrl = wx.TextCtrl(id=-1, parent=self.SearchResultsTree, pos=wx.Point(0, 0),

   303

                    value=text, style=text_ctrl_style)

   304

            width, height = text_ctrl.GetTextExtent(text)

   305

            text_ctrl.SetClientSize(wx.Size(width + 1, height))

   306

            text_ctrl.SetBackgroundColour(self.SearchResultsTree.GetBackgroundColour())

   307

            text_ctrl.Bind(wx.EVT_LEFT_DOWN, self.GetTextCtrlClickFunction(root))

   308

            text_ctrl.Bind(wx.EVT_LEFT_DCLICK, self.GetTextCtrlDClickFunction(root))

   309

            text_ctrl.SetInsertionPoint(0)

   310

            text_ctrl.SetStyle(start_idx, end_idx, style)

   311

            self.SearchResultsTree.SetItemWindow(root, text_ctrl)

   312

   313

        if wx.VERSION >= (2, 6, 0):

   314

            item, root_cookie = self.SearchResultsTree.GetFirstChild(root)

   315

        else:

   316

            item, root_cookie = self.SearchResultsTree.GetFirstChild(root, 0)

   317

        for child in infos["children"]:

   318

            if item is None:

   319

                item = self.SearchResultsTree.AppendItem(root, "")

   320

                item, root_cookie = self.SearchResultsTree.GetNextChild(root, root_cookie)

   321

            self.GenerateSearchResultsTreeBranch(item, child)

   322

            item, root_cookie = self.SearchResultsTree.GetNextChild(root, root_cookie)

   323

   324

    def ShowSearchResults(self, item):

   325

        data = self.SearchResultsTree.GetPyData(item)

   326

        if isinstance(data, TupleType):

   327

            search_results = [data]

   328

        else:

   329

            search_results = self.SearchResults.get(data, [])

   330

        self.ParentWindow.ClearHighlights(SEARCH_RESULT_HIGHLIGHT)

   331

        for infos, start, end, text in search_results:

   332

            self.ParentWindow.ShowSearchResult(infos, start, end)

   333

   334

    def OnSearchResultsTreeItemActivated(self, event):

   335

        self.ShowSearchResults(event.GetItem())

   336

        event.Skip()

   337

   338

    def OnResetButton(self, event):

   339

        self.ResetSearchResults()

   340

        self.ParentWindow.ClearSearchResults()

   341

        event.Skip()