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

import wx

    26

    27

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

    28

#                                 Helpers

    29

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

    30

    31

    32

[CATEGORY, BLOCK] = range(2)

    33

    34

    35

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

    36

#                              Library Panel

    37

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

    38

    39

    40

class LibraryPanel(wx.Panel):

    41

    """

    42

    Class that implements a panel displaying a tree containing an hierarchical list

    43

    of functions and function blocks available in project an a search control for

    44

    quickly find one functions or function blocks in this list and a text control

    45

    displaying informations about selected functions or function blocks

    46

    """

    47

    48

    def __init__(self, parent, enable_drag=False):

    49

        """

    50

        Constructor

    51

        @param parent: Parent wx.Window of LibraryPanel

    52

        @param enable_drag: Flag indicating that function or function block can

    53

        be drag'n drop from LibraryPanel (default: False)

    54

        """

    55

        wx.Panel.__init__(self, parent, style=wx.TAB_TRAVERSAL)

    56

    57

        # Define LibraryPanel main sizer

    58

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

    59

        main_sizer.AddGrowableCol(0)

    60

        main_sizer.AddGrowableRow(1)

    61

    62

        # Add SearchCtrl to main sizer

    63

        self.SearchCtrl = wx.SearchCtrl(self)

    64

        # Add a button with a magnifying glass, essentially to show that this

    65

        # control is for searching in tree

    66

        self.SearchCtrl.ShowSearchButton(True)

    67

        self.Bind(wx.EVT_TEXT, self.OnSearchCtrlChanged, self.SearchCtrl)

    68

        self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN,

    69

                  self.OnSearchButtonClick, self.SearchCtrl)

    70

        # Bind keyboard event on SearchCtrl text control to catch UP and DOWN

    71

        # for search previous and next occurrence

    72

    73

        # This protects from fail to start when no children[0] available (possible for wxPython 3.0)

    74

        if self.SearchCtrl.GetChildren():

    75

            search_textctrl = self.SearchCtrl.GetChildren()[0]

    76

            search_textctrl.Bind(wx.EVT_CHAR, self.OnKeyDown)

    77

    78

        main_sizer.AddWindow(self.SearchCtrl, flag=wx.GROW)

    79

    80

        # Add Splitter window for tree and block comment to main sizer

    81

        splitter_window = wx.SplitterWindow(self)

    82

        splitter_window.SetSashGravity(1.0)

    83

        main_sizer.AddWindow(splitter_window, flag=wx.GROW)

    84

    85

        # Add TreeCtrl for functions and function blocks library in splitter

    86

        # window

    87

        self.Tree = wx.TreeCtrl(splitter_window,

    88

                                size=wx.Size(0, 0),

    89

                                style=(wx.TR_HAS_BUTTONS |

    90

                                       wx.TR_SINGLE |

    91

                                       wx.SUNKEN_BORDER |

    92

                                       wx.TR_HIDE_ROOT |

    93

                                       wx.TR_LINES_AT_ROOT))

    94

        self.Bind(wx.EVT_TREE_SEL_CHANGED, self.OnTreeItemSelected, self.Tree)

    95

        self.Tree.Bind(wx.EVT_CHAR, self.OnKeyDown)

    96

        # If drag'n drop is enabled, bind event generated when a drag begins on

    97

        # tree to start a drag'n drop

    98

        if enable_drag:

    99

            self.Bind(wx.EVT_TREE_BEGIN_DRAG, self.OnTreeBeginDrag, self.Tree)

   100

   101

        # Add TextCtrl for function and function block informations

   102

        self.Comment = wx.TextCtrl(splitter_window, size=wx.Size(0, 80),

   103

                                   style=wx.TE_READONLY | wx.TE_MULTILINE)

   104

   105

        splitter_window.SplitHorizontally(self.Tree, self.Comment, -80)

   106

   107

        self.SetSizer(main_sizer)

   108

   109

        # Reference to the project controller

   110

        self.Controller = None

   111

   112

        # Variable storing functions and function blocks library to display

   113

        self.BlockList = None

   114

   115

    def __del__(self):

   116

        """

   117

        Destructor

   118

        """

   119

        # Remove reference to project controller

   120

        self.Controller = None

   121

   122

    def SetController(self, controller):

   123

        """

   124

        Set reference to project controller

   125

        @param controller: Reference to project controller

   126

        """

   127

        self.Controller = controller

   128

   129

    def SetBlockList(self, blocklist):

   130

        """

   131

        Set function and function block library to display in TreeCtrl

   132

        @param blocklist: Function and function block library

   133

        """

   134

        # Save functions and function blocks library

   135

        self.BlockList = blocklist

   136

        # Refresh TreeCtrl values

   137

        self.RefreshTree()

   138

   139

    def SetFocus(self):

   140

        """

   141

        Called to give focus to LibraryPanel

   142

        Override wx.Window SetFocus method

   143

        """

   144

        # Give focus to SearchCtrl

   145

        self.SearchCtrl.SetFocus()

   146

   147

    def ResetTree(self):

   148

        """

   149

        Reset LibraryPanel values displayed in controls

   150

        """

   151

        # Clear SearchCtrl, TreeCtrl and TextCtrl

   152

        self.SearchCtrl.SetValue("")

   153

        self.Tree.DeleteAllItems()

   154

        self.Comment.SetValue("")

   155

   156

    def RefreshTree(self):

   157

        """

   158

        Refresh LibraryPanel values displayed in controls

   159

        """

   160

        # Get function and function blocks library

   161

        blocktypes = self.BlockList

   162

        if blocktypes is None and self.Controller is not None:

   163

            # Get library from project controller if not defined

   164

            blocktypes = self.Controller.GetBlockTypes()

   165

   166

        # Refresh TreeCtrl values if a library is defined

   167

        if blocktypes is not None:

   168

            # List that will contain tree items to be deleted when TreeCtrl

   169

            # will be refreshed

   170

            items_to_delete = []

   171

   172

            # Get current selected item for selected it when values refreshed

   173

            selected_item = self.Tree.GetSelection()

   174

            selected_pydata = (self.Tree.GetPyData(selected_item)

   175

                               if (selected_item.IsOk() and

   176

                                   selected_item != self.Tree.GetRootItem())

   177

                               else None)

   178

            # Don't save selected item if it is a category

   179

            selected_infos = ((self.Tree.GetItemText(selected_item),

   180

                               selected_pydata["inputs"])

   181

                              if (selected_pydata is not None and

   182

                                  selected_pydata["type"] == BLOCK)

   183

                              else (None, None))

   184

   185

            # Get TreeCtrl root item (hidden)

   186

            root = self.Tree.GetRootItem()

   187

            if not root.IsOk():

   188

                # Create root if not present

   189

                root = self.Tree.AddRoot("")

   190

   191

            # Iterate over functions and function blocks library categories and

   192

            # add a tree item to root item for each of them

   193

   194

            # Get first child under root item

   195

            category_item, root_cookie = self.Tree.GetFirstChild(root)

   196

            for category in blocktypes:

   197

                # Store category name in a local variable to prevent script

   198

                # extracting translated strings for gettext to consider "name"

   199

                # to be translated

   200

                category_name = category["name"]

   201

   202

                # Tree item already exists, set item label

   203

                if category_item.IsOk():

   204

                    self.Tree.SetItemText(category_item, _(category_name))

   205

   206

                # Tree item doesn't exist, add new one to root

   207

                else:

   208

                    category_item = self.Tree.AppendItem(root, _(category_name))

   209

                    # On Windows, needs to get next child of root to have a

   210

                    # reference to the newly added tree item

   211

                    if wx.Platform != '__WXMSW__':

   212

                        category_item, root_cookie = \

   213

                            self.Tree.GetNextChild(root, root_cookie)

   214

   215

                # Set data associated to tree item (only save that item is a

   216

                # category)

   217

                self.Tree.SetPyData(category_item, {"type": CATEGORY})

   218

   219

                # Iterate over functions and function blocks defined in library

   220

                # category add a tree item to category tree item for each of

   221

                # them

   222

   223

                # Get first child under category tree item

   224

                blocktype_item, category_cookie = \

   225

                    self.Tree.GetFirstChild(category_item)

   226

                for blocktype in category["list"]:

   227

   228

                    # Tree item already exists, set item label

   229

                    if blocktype_item.IsOk():

   230

                        self.Tree.SetItemText(blocktype_item, blocktype["name"])

   231

   232

                    # Tree item doesn't exist, add new one to category item

   233

                    else:

   234

                        blocktype_item = self.Tree.AppendItem(

   235

                                            category_item, blocktype["name"])

   236

                        # See comment when adding category

   237

                        if wx.Platform != '__WXMSW__':

   238

                            blocktype_item, category_cookie = \

   239

                                self.Tree.GetNextChild(category_item,

   240

                                                       category_cookie)

   241

   242

                    # Define data to associate to block tree item

   243

                    comment = blocktype["comment"]

   244

                    block_data = {

   245

                        "type":       BLOCK,

   246

                        "block_type": blocktype["type"],

   247

                        "inputs":     tuple([type

   248

                                             for name, type, modifier

   249

                                             in blocktype["inputs"]]),

   250

                        "extension":  (len(blocktype["inputs"])

   251

                                       if blocktype["extensible"] else None),

   252

                        "comment":    _(comment) + blocktype.get("usage", "")

   253

                    }

   254

                    self.Tree.SetPyData(blocktype_item, block_data)

   255

   256

                    # Select block tree item in tree if it corresponds to

   257

                    # previously selected one

   258

                    if selected_infos == (blocktype["name"],

   259

                                          blocktype["inputs"]):

   260

                        self.Tree.SelectItem(blocktype_item)

   261

   262

                        # Update TextCtrl value

   263

                        self.Comment.SetValue(block_data["comment"])

   264

   265

                    # Get next block tree item under category tree item

   266

                    blocktype_item, category_cookie = \

   267

                        self.Tree.GetNextChild(category_item, category_cookie)

   268

   269

                # Add every remaining tree item under category tree item after

   270

                # updating all block items to the list of items to delete

   271

                while blocktype_item.IsOk():

   272

                    items_to_delete.append(blocktype_item)

   273

                    blocktype_item, category_cookie = \

   274

                        self.Tree.GetNextChild(category_item, category_cookie)

   275

   276

                # Get next category tree item under root item

   277

                category_item, root_cookie = \

   278

                    self.Tree.GetNextChild(root, root_cookie)

   279

   280

            # Add every remaining tree item under root item after updating all

   281

            # category items to the list of items to delete

   282

            while category_item.IsOk():

   283

                items_to_delete.append(category_item)

   284

                category_item, root_cookie = \

   285

                    self.Tree.GetNextChild(root, root_cookie)

   286

   287

            # Remove all items in list of items to delete from TreeCtrl

   288

            for item in items_to_delete:

   289

                self.Tree.Delete(item)

   290

   291

    def GetSelectedBlock(self):

   292

        """

   293

        Get selected block informations

   294

        @return: {"type": block_type_name, "inputs": [input_type,...]} or None

   295

        if no block selected

   296

        """

   297

        # Get selected item associated data in tree

   298

        selected_item = self.Tree.GetSelection()

   299

        selected_pydata = (self.Tree.GetPyData(selected_item)

   300

                           if (selected_item.IsOk() and

   301

                               selected_item != self.Tree.GetRootItem())

   302

                           else None)

   303

   304

        # Return value is None if selected tree item is root or a category

   305

        return ({"type": self.Tree.GetItemText(selected_item),

   306

                 "inputs": selected_pydata["inputs"]}

   307

                if (selected_pydata is not None and

   308

                    selected_pydata["type"] == BLOCK)

   309

                else None)

   310

   311

    def SelectTreeItem(self, name, inputs):

   312

        """

   313

        Select Tree item corresponding to block informations given

   314

        @param name: Block type name

   315

        @param inputs: List of block inputs type [input_type,...]

   316

        """

   317

        # Find tree item corresponding to block informations

   318

        item = self.FindTreeItem(self.Tree.GetRootItem(), name, inputs)

   319

        if item is not None and item.IsOk():

   320

            # Select tree item found

   321

            self.Tree.SelectItem(item)

   322

            self.Tree.EnsureVisible(item)

   323

   324

    def FindTreeItem(self, item, name, inputs=None):

   325

        """

   326

        Find Tree item corresponding to block informations given

   327

        Function is recursive

   328

        @param item: Item to test

   329

        @param name: Block type name

   330

        @param inputs: List of block inputs type [input_type,...]

   331

        """

   332

        # Return immediately if item isn't valid

   333

        if not item.IsOk():

   334

            return None

   335

   336

        # Get data associated to item to test

   337

        item_pydata = self.Tree.GetPyData(item)

   338

        if item_pydata is not None and item_pydata["type"] == BLOCK:

   339

            # Only test item corresponding to block

   340

   341

            # Test if block inputs type are the same than those given

   342

            type_inputs = item_pydata.get("inputs", None)

   343

            type_extension = item_pydata.get("extension", None)

   344

            if inputs is not None and type_inputs is not None:

   345

                same_inputs = reduce(

   346

                    lambda x, y: x and y,

   347

                    map(

   348

                        lambda x: x[0] == x[1] or x[0] == 'ANY' or x[1] == 'ANY',

   349

                        zip(type_inputs,

   350

                            (inputs[:type_extension]

   351

                             if type_extension is not None

   352

                             else inputs))),

   353

                    True)

   354

            else:

   355

                same_inputs = True

   356

   357

            # Return item if  block data corresponds to informations given

   358

            if self.Tree.GetItemText(item) == name and same_inputs:

   359

                return item

   360

   361

        # Test item children if item doesn't correspond

   362

        child, child_cookie = self.Tree.GetFirstChild(item)

   363

        while child.IsOk():

   364

            result = self.FindTreeItem(child, name, inputs)

   365

            if result:

   366

                return result

   367

            child, child_cookie = self.Tree.GetNextChild(item, child_cookie)

   368

   369

        return None

   370

   371

    def SearchInTree(self, value, mode="first"):

   372

        """

   373

        Search in Tree and select item that name contains string given

   374

        @param value: String contained in block name to find

   375

        @param mode: Search mode ('first', 'previous' or 'next')

   376

        (default: 'first')

   377

        @return: True if an item was found

   378

        """

   379

        # Return immediately if root isn't valid

   380

        root = self.Tree.GetRootItem()

   381

        if not root.IsOk():

   382

            return False

   383

   384

        # Set function to navigate in Tree item sibling according to search

   385

        # mode defined

   386

        sibling_function = (self.Tree.GetPrevSibling

   387

                            if mode == "previous"

   388

                            else self.Tree.GetNextSibling)

   389

   390

        # Get current selected item (for next and previous mode)

   391

        item = self.Tree.GetSelection()

   392

        if not item.IsOk() or mode == "first":

   393

            item, item_cookie = self.Tree.GetFirstChild(root)

   394

            selected = None

   395

        else:

   396

            selected = item

   397

   398

        # Navigate through tree items until one matching found or reach tree

   399

        # starting or ending

   400

        while item.IsOk():

   401

   402

            # Get item data to get item type

   403

            item_pydata = self.Tree.GetPyData(item)

   404

   405

            # Item is a block category

   406

            if (item == root) or item_pydata["type"] == CATEGORY:

   407

   408

                # Get category first or last child according to search mode

   409

                # defined

   410

                child = (self.Tree.GetLastChild(item)

   411

                         if mode == "previous"

   412

                         else self.Tree.GetFirstChild(item)[0])

   413

   414

                # If category has no child, go to sibling category

   415

                item = (child if child.IsOk() else sibling_function(item))

   416

   417

            # Item is a block

   418

            else:

   419

   420

                # Extract item block name

   421

                name = self.Tree.GetItemText(item)

   422

                # Test if block name contains string given

   423

                if name.upper().find(value.upper()) != -1 and item != selected:

   424

                    # Select block and collapse all categories other than block

   425

                    # category

   426

                    child, child_cookie = self.Tree.GetFirstChild(root)

   427

                    while child.IsOk():

   428

                        self.Tree.CollapseAllChildren(child)

   429

                        child, child_cookie = self.Tree.GetNextChild(root, child_cookie)

   430

                    self.Tree.SelectItem(item)

   431

                    self.Tree.EnsureVisible(item)

   432

                    return True

   433

   434

                # Go to next item sibling if block not found

   435

                next = sibling_function(item)

   436

   437

                # If category has no other child, go to next category sibling

   438

                item = (next

   439

                        if next.IsOk()

   440

                        else sibling_function(self.Tree.GetItemParent(item)))

   441

   442

        return False

   443

   444

    def OnSearchCtrlChanged(self, event):

   445

        """

   446

        Called when SearchCtrl text control value changed

   447

        @param event: TextCtrl change event

   448

        """

   449

        # Search for block containing SearchCtrl value in 'first' mode

   450

        self.SearchInTree(self.SearchCtrl.GetValue())

   451

        event.Skip()

   452

   453

    def OnSearchButtonClick(self, event):

   454

        """

   455

        Called when SearchCtrl search button was clicked

   456

        @param event: Button clicked event

   457

        """

   458

        # Search for block containing SearchCtrl value in 'next' mode

   459

        self.SearchInTree(self.SearchCtrl.GetValue(), "next")

   460

        event.Skip()

   461

   462

    def OnTreeItemSelected(self, event):

   463

        """

   464

        Called when tree item is selected

   465

        @param event: wx.TreeEvent

   466

        """

   467

        # Update TextCtrl value with block selected usage

   468

        item_pydata = self.Tree.GetPyData(event.GetItem())

   469

        self.Comment.SetValue(

   470

            item_pydata["comment"]

   471

            if item_pydata is not None and item_pydata["type"] == BLOCK

   472

            else "")

   473

   474

        # Call extra function defined when tree item is selected

   475

        if getattr(self, "_OnTreeItemSelected", None) is not None:

   476

            self._OnTreeItemSelected(event)

   477

   478

        event.Skip()

   479

   480

    def OnTreeBeginDrag(self, event):

   481

        """

   482

        Called when a drag is started in tree

   483

        @param event: wx.TreeEvent

   484

        """

   485

        selected_item = event.GetItem()

   486

        item_pydata = self.Tree.GetPyData(selected_item)

   487