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 functools import reduce

    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

from plcopen.types_enums import GetElementType

    36

    37

    38

def GenerateName(infos):

    39

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

    40

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

    41

    elif infos[0] == "range":

    42

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

    43

    elif infos[0] == "struct":

    44

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

    45

    return "%s:" % infos[0]

    46

    47

    48

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

    49

#                            Search Result Panel

    50

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

    51

    52

    53

[

    54

    ID_SEARCHRESULTPANEL, ID_SEARCHRESULTPANELHEADERLABEL,

    55

    ID_SEARCHRESULTPANELSEARCHRESULTSTREE, ID_SEARCHRESULTPANELRESETBUTTON,

    56

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

    57

    58

    59

class SearchResultPanel(wx.Panel):

    60

    61

    def _init_coll_MainSizer_Items(self, parent):

    62

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

    63

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

    64

    65

    def _init_coll_MainSizer_Growables(self, parent):

    66

        parent.AddGrowableCol(0)

    67

        parent.AddGrowableRow(1)

    68

    69

    def _init_coll_HeaderSizer_Items(self, parent):

    70

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

    71

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

    72

    73

    def _init_coll_HeaderSizer_Growables(self, parent):

    74

        parent.AddGrowableCol(0)

    75

    76

    def _init_sizers(self):

    77

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

    78

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

    79

    80

        self._init_coll_MainSizer_Items(self.MainSizer)

    81

        self._init_coll_MainSizer_Growables(self.MainSizer)

    82

        self._init_coll_HeaderSizer_Items(self.HeaderSizer)

    83

    84

        self.SetSizer(self.MainSizer)

    85

    86

    def _init_ctrls(self, prnt):

    87

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

    88

                                         name='HeaderLabel', parent=self,

    89

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

    90

    91

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

    92

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

    93

                                                   name="SearchResultsTree", parent=self,

    94

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

    95

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

    96

            self.SearchResultsTree.SetAGWWindowStyleFlag(search_results_tree_style)

    97

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

    98

                  id=ID_SEARCHRESULTPANELSEARCHRESULTSTREE)

    99

   100

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

   101

            self, bitmap=GetBitmap("reset"),

   102

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

   103

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

   104

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

   105

   106

        self._init_sizers()

   107

   108

    def __init__(self, parent, window):

   109

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

   110

                          name='SearchResultPanel', parent=parent,

   111

                          pos=wx.Point(0, 0),

   112

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

   113

   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

                ("FILE",           ITEM_CONFNODE)]:

   135

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

   136

   137

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

   138

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

   139

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

   140

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

   141

                         "var_local", "var_input",

   142

                         "var_inout", "var_output"]:

   143

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

   144

   145

        # Assign icon list to TreeCtrl

   146

        self.SearchResultsTree.SetImageList(self.TreeImageList)

   147

   148

        self.ResetSearchResults()

   149

   150

    def SetSearchResults(self, criteria, search_results):

   151

        self.Criteria = criteria

   152

        self.SearchResults = {}

   153

        self.ElementsOrder = []

   154

   155

        for infos, start, end, text in search_results:

   156

            if infos[0] not in self.ElementsOrder:

   157

                self.ElementsOrder.append(infos[0])

   158

   159

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

   160

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

   161

   162

        self.RefreshView()

   163

   164

    def ResetSearchResults(self):

   165

        self.Criteria = None

   166

        self.ElementsOrder = []

   167

        self.SearchResults = {}

   168

        self.RefreshView()

   169

   170

    def RefreshView(self):

   171

        self.SearchResultsTree.DeleteAllItems()

   172

        if self.Criteria is None:

   173

            self.SearchResultsTree.AddRoot("")

   174

            root = self.SearchResultsTree.GetRootItem()

   175

            root.SetHilight(False)

   176

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

   177

            self.ResetButton.Enable(False)

   178

        else:

   179

            matches_number = 0

   180

            search_results_tree_infos = {

   181

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

   182

                "type": ITEM_PROJECT,

   183

                "data": None,

   184

                "text": None,

   185

                "matches": None,

   186

            }

   187

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

   188

            for tagname in self.ElementsOrder:

   189

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

   190

                matches_number += len(results)

   191

   192

                words = tagname.split("::")

   193

   194

                element_type = GetElementType(tagname)

   195

                if element_type == ITEM_POU:

   196

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

   197

   198

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

   199

                                 "type": element_type,

   200

                                 "data": tagname,

   201

                                 "text": None,

   202

                                 "matches": len(results)}

   203

   204

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

   205

                for infos, start, end, text in results:

   206

                    if len(words) == 1:  # CTN match

   207

                        child_name = {"body": str(start[0])+":",

   208

                                      "var_inout": _("Variable:")}[infos[1]]

   209

                        child_type = {"body": ITEM_CONFNODE,

   210

                                      "var_inout": "var_inout"}[infos[1]]

   211

                    elif 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

                # not Project node

   242

                if len(words) > 2:

   243

                    for _element_infos in search_results_tree_children:

   244

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

   245

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

   246

                            _element_infos["children"].append(element_infos)

   247

                            break

   248

                    if element_type == ITEM_RESOURCE:

   249

                        search_results_tree_children.append(element_infos)

   250

                else:  # Project node or CTN

   251

                    search_results_tree_children.append(element_infos)

   252

   253

            if matches_number < 2:

   254

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

   255

            else:

   256

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

   257

   258

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

   259

            self.ResetButton.Enable(True)

   260

   261

            if matches_number > 0:

   262

                root = self.SearchResultsTree.GetRootItem()

   263

                if root is None:

   264

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

   265

                self.GenerateSearchResultsTreeBranch(root, search_results_tree_infos)

   266

                self.SearchResultsTree.Expand(root)

   267

   268

    def GetTextCtrlClickFunction(self, item):

   269

        def OnTextCtrlClick(event):

   270

            self.SearchResultsTree.SelectItem(item)

   271

            event.Skip()

   272

        return OnTextCtrlClick

   273

   274

    def GetTextCtrlDClickFunction(self, item):

   275

        def OnTextCtrlDClick(event):

   276

            self.ShowSearchResults(item)

   277

            event.Skip()

   278

        return OnTextCtrlDClick

   279

   280

    def GenerateSearchResultsTreeBranch(self, root, infos):

   281

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

   282

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

   283

        else:

   284

            item_name = infos["name"]

   285

   286

        self.SearchResultsTree.SetItemText(root, item_name)

   287

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

   288

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

   289

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

   290

        if infos["type"] is not None:

   291

            if infos["type"] == ITEM_POU:

   292

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

   293

            else:

   294

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

   295

   296

        text = None

   297

        if infos["text"] is not None:

   298

            text = infos["text"]

   299

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

   300

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

   301

            start_idx = start[1]

   302

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

   303

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

   304

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

   305

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

   306

            start_idx, end_idx = 0, len(text)

   307

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

   308

   309

        if text is not None:

   310

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

   311

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

   312

                text_ctrl_style |= wx.TE_MULTILINE | wx.TE_NO_VSCROLL

   313

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

   314

                                    value=text, style=text_ctrl_style)

   315

            width, height = text_ctrl.GetTextExtent(text)

   316

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

   317

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

   318

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

   319

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

   320

            text_ctrl.SetInsertionPoint(0)

   321

            text_ctrl.SetStyle(start_idx, end_idx, style)

   322

            self.SearchResultsTree.SetItemWindow(root, text_ctrl)

   323

   324

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

   325

        for child in infos["children"]:

   326

            if item is None:

   327

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

   328

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

   329

            self.GenerateSearchResultsTreeBranch(item, child)

   330

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

   331

   332

    def ShowSearchResults(self, item):

   333

        data = self.SearchResultsTree.GetPyData(item)

   334

        if isinstance(data, tuple):

   335

            search_results = [data]

   336

        else:

   337

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

   338

        self.ParentWindow.ClearHighlights(SEARCH_RESULT_HIGHLIGHT)

   339

        for infos, start, end, _text in search_results:

   340

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

   341

   342

    def OnSearchResultsTreeItemActivated(self, event):

   343

        self.ShowSearchResults(event.GetItem())

   344

        event.Skip()

   345

   346

    def OnResetButton(self, event):

   347

        self.ResetSearchResults()

   348

        self.ParentWindow.ClearSearchResults()

   349

        event.Skip()