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

    26

from __future__ import absolute_import

    27

from types import TupleType

    28

    29

import wx

    30

import wx.lib.buttons

    31

import wx.lib.agw.customtreectrl as CT

    32

    33

from PLCControler import *

    34

from util.BitmapLibrary import GetBitmap

    35

    36

    37

def GenerateName(infos):

    38

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

    39

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

    40

    elif infos[0] == "range":

    41

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

    42

    elif infos[0] == "struct":

    43

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

    44

    return "%s:" % infos[0]

    45

    46

    47

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

    48

#                            Search Result Panel

    49

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

    50

    51

    52

[

    53

    ID_SEARCHRESULTPANEL, ID_SEARCHRESULTPANELHEADERLABEL,

    54

    ID_SEARCHRESULTPANELSEARCHRESULTSTREE, ID_SEARCHRESULTPANELRESETBUTTON,

    55

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

    56

    57

    58

class SearchResultPanel(wx.Panel):

    59

    60

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

    61

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

    62

            if id is not None:

    63

                event(self, id, function)

    64

            else:

    65

                event(self, function)

    66

    67

    def _init_coll_MainSizer_Items(self, parent):

    68

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

    69

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

    70

    71

    def _init_coll_MainSizer_Growables(self, parent):

    72

        parent.AddGrowableCol(0)

    73

        parent.AddGrowableRow(1)

    74

    75

    def _init_coll_HeaderSizer_Items(self, parent):

    76

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

    77

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

    78

    79

    def _init_coll_HeaderSizer_Growables(self, parent):

    80

        parent.AddGrowableCol(0)

    81

    82

    def _init_sizers(self):

    83

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

    84

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

    85

    86

        self._init_coll_MainSizer_Items(self.MainSizer)

    87

        self._init_coll_MainSizer_Growables(self.MainSizer)

    88

        self._init_coll_HeaderSizer_Items(self.HeaderSizer)

    89

    90

        self.SetSizer(self.MainSizer)

    91

    92

    def _init_ctrls(self, prnt):

    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(

   107

            self, bitmap=GetBitmap("reset"),

   108

            size=wx.Size(28, 28), style=wx.NO_BORDER)

   109

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

   110

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

   111

   112

        self._init_sizers()

   113

   114

    def __init__(self, parent, window):

   115

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

   116

                          name='SearchResultPanel', parent=parent,

   117

                          pos=wx.Point(0, 0),

   118

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

   119

   120

        self.ParentWindow = window

   121

   122

        self._init_ctrls(parent)

   123

   124

        # Define Tree item icon list

   125

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

   126

        self.TreeImageDict = {}

   127

   128

        # Icons for other items

   129

        for imgname, itemtype in [

   130

                # editables

   131

                ("PROJECT",        ITEM_PROJECT),

   132

                ("TRANSITION",     ITEM_TRANSITION),

   133

                ("ACTION",         ITEM_ACTION),

   134

                ("CONFIGURATION",  ITEM_CONFIGURATION),

   135

                ("RESOURCE",       ITEM_RESOURCE),

   136

                ("DATATYPE",       ITEM_DATATYPE),

   137

                ("ACTION",         "action_block"),

   138

                ("IL",             "IL"),

   139

                ("ST",             "ST")]:

   140

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

   141

   142

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

   143

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

   144

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

   145

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

   146

                         "var_local", "var_input",

   147

                         "var_inout", "var_output"]:

   148

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

   149

   150

        # Assign icon list to TreeCtrl

   151

        self.SearchResultsTree.SetImageList(self.TreeImageList)

   152

   153

        self.ResetSearchResults()

   154

   155

    def SetSearchResults(self, criteria, search_results):

   156

        self.Criteria = criteria

   157

        self.SearchResults = {}

   158

        self.ElementsOrder = []

   159

   160

        for infos, start, end, text in search_results:

   161

            if infos[0] not in self.ElementsOrder:

   162

                self.ElementsOrder.append(infos[0])

   163

   164

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

   165

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

   166

   167

        self.RefreshView()

   168

   169

    def ResetSearchResults(self):

   170

        self.Criteria = None

   171

        self.ElementsOrder = []

   172

        self.SearchResults = {}

   173

        self.RefreshView()

   174

   175

    def RefreshView(self):

   176

        self.SearchResultsTree.DeleteAllItems()

   177

        if self.Criteria is None:

   178

            self.SearchResultsTree.AddRoot("")

   179

            root = self.SearchResultsTree.GetRootItem()

   180

            root.SetHilight(False)

   181

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

   182

            self.ResetButton.Enable(False)

   183

        else:

   184

            matches_number = 0

   185

            search_results_tree_infos = {

   186

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

   187

                "type": ITEM_PROJECT,

   188

                "data": None,

   189

                "text": None,

   190

                "matches": None,

   191

            }

   192

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

   193

            for tagname in self.ElementsOrder:

   194

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

   195

                matches_number += len(results)

   196

   197

                words = tagname.split("::")

   198

   199

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

   200

                if element_type == ITEM_POU:

   201

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

   202

   203

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

   204

                                 "type": element_type,

   205

                                 "data": tagname,

   206

                                 "text": None,

   207

                                 "matches": len(results)}

   208

   209

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

   210

                for infos, start, end, text in results:

   211

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

   212

                        child_name = GenerateName(infos[1:])

   213

                        child_type = element_type

   214

                    else:

   215

                        if element_type == ITEM_RESOURCE:

   216

                            child_type = element_type

   217

                        else:

   218

                            child_type = infos[1]

   219

                        if child_type == "name":

   220

                            child_name = "name"

   221

                        elif child_type == "body":

   222

                            child_name = "body"

   223

                            if element_type == ITEM_TRANSITION:

   224

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

   225

                            elif element_type == ITEM_ACTION:

   226

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

   227

                            else:

   228

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

   229

                        else:

   230

                            child_name = GenerateName(infos[3:])

   231

                    child_infos = {

   232

                        "name": child_name,

   233

                        "type": child_type,

   234

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

   235

                        "text": text,

   236

                        "matches": 1,

   237

                        "children": [],

   238

                    }

   239

                    children.append(child_infos)

   240

   241

                if len(words) > 2:

   242

                    for _element_infos in search_results_tree_children:

   243

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

   244

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

   245

                            _element_infos["children"].append(element_infos)

   246

                            break

   247

                    if element_type == ITEM_RESOURCE:

   248

                        search_results_tree_children.append(element_infos)

   249

                else:

   250

                    search_results_tree_children.append(element_infos)

   251

   252

            if matches_number < 2:

   253

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

   254

            else:

   255

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

   256

   257

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

   258

            self.ResetButton.Enable(True)

   259

   260

            if matches_number > 0:

   261

                root = self.SearchResultsTree.GetRootItem()

   262

                if root is None:

   263

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

   264

                self.GenerateSearchResultsTreeBranch(root, search_results_tree_infos)

   265

                self.SearchResultsTree.Expand(root)

   266

   267

    def GetTextCtrlClickFunction(self, item):

   268

        def OnTextCtrlClick(event):

   269

            self.SearchResultsTree.SelectItem(item)

   270

            event.Skip()

   271

        return OnTextCtrlClick

   272

   273

    def GetTextCtrlDClickFunction(self, item):

   274

        def OnTextCtrlDClick(event):

   275

            self.ShowSearchResults(item)

   276

            event.Skip()

   277

        return OnTextCtrlDClick

   278

   279

    def GenerateSearchResultsTreeBranch(self, root, infos):

   280

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

   281

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

   282

        else:

   283

            item_name = infos["name"]

   284

   285

        self.SearchResultsTree.SetItemText(root, item_name)

   286

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

   287

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

   288

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

   289

        if infos["type"] is not None:

   290

            if infos["type"] == ITEM_POU:

   291

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

   292

            else:

   293

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

   294

   295

        text = None

   296

        if infos["text"] is not None:

   297

            text = infos["text"]

   298

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

   299

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

   300

            start_idx = start[1]

   301

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

   302

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

   303

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

   304

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

   305

            start_idx, end_idx = 0, len(text)

   306

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

   307

   308

        if text is not None:

   309

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

   310

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

   311

                text_ctrl_style |= wx.TE_MULTILINE

   312

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

   313

                                    value=text, style=text_ctrl_style)

   314

            width, height = text_ctrl.GetTextExtent(text)

   315

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

   316

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

   317

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

   318

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

   319

            text_ctrl.SetInsertionPoint(0)

   320

            text_ctrl.SetStyle(start_idx, end_idx, style)

   321

            self.SearchResultsTree.SetItemWindow(root, text_ctrl)

   322

   323

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

   324

        for child in infos["children"]:

   325

            if item is None:

   326

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

   327

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

   328

            self.GenerateSearchResultsTreeBranch(item, child)

   329

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

   330

   331

    def ShowSearchResults(self, item):

   332

        data = self.SearchResultsTree.GetPyData(item)

   333

        if isinstance(data, TupleType):

   334

            search_results = [data]

   335

        else:

   336

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

   337

        self.ParentWindow.ClearHighlights(SEARCH_RESULT_HIGHLIGHT)

   338

        for infos, start, end, _text in search_results:

   339

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

   340

   341

    def OnSearchResultsTreeItemActivated(self, event):

   342

        self.ShowSearchResults(event.GetItem())

   343

        event.Skip()

   344

   345

    def OnResetButton(self, event):

   346

        self.ResetSearchResults()

   347

        self.ParentWindow.ClearSearchResults()

   348

        event.Skip()