ConfigTreeNode.py
author Edouard Tisserant
Tue, 26 Mar 2019 09:43:51 +0100
branchwx.NewID_abuse_fix
changeset 2556 f07d389772fd
parent 2552 46a1e8d1e92c
child 2579 8fb5c6eddc72
permissions -rw-r--r--
Continued wx.NewID abuse removal in Viewer.py : get rid of one call to AppendMenu method, having no real purpose apparently. To be continued.
1511
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
     1
#!/usr/bin/env python
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
     2
# -*- coding: utf-8 -*-
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
     3
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
     4
# This file is part of Beremiz, a Integrated Development Environment for
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
     5
# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
     6
#
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
     7
# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
     8
#
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
     9
# See COPYING file for copyrights details.
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    10
#
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    11
# This program is free software; you can redistribute it and/or
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    12
# modify it under the terms of the GNU General Public License
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    13
# as published by the Free Software Foundation; either version 2
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    14
# of the License, or (at your option) any later version.
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    15
#
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    16
# This program is distributed in the hope that it will be useful,
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    17
# but WITHOUT ANY WARRANTY; without even the implied warranty of
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    19
# GNU General Public License for more details.
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    20
#
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    21
# You should have received a copy of the GNU General Public License
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    22
# along with this program; if not, write to the Free Software
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    23
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1332
diff changeset
    24
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    25
"""
725
31dade089db5 refactoring
Edouard Tisserant
parents: 722
diff changeset
    26
Config Tree Node base class.
31dade089db5 refactoring
Edouard Tisserant
parents: 722
diff changeset
    27
31dade089db5 refactoring
Edouard Tisserant
parents: 722
diff changeset
    28
- A Beremiz project is organized in a tree each node derivate from ConfigTreeNode
31dade089db5 refactoring
Edouard Tisserant
parents: 722
diff changeset
    29
- Project tree organization match filesystem organization of project directory.
31dade089db5 refactoring
Edouard Tisserant
parents: 722
diff changeset
    30
- Each node of the tree have its own xml configuration, whose grammar is defined for each node type, as XSD
31dade089db5 refactoring
Edouard Tisserant
parents: 722
diff changeset
    31
- ... TODO : document
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    32
"""
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    33
1881
091005ec69c4 fix pylint py3k conversion warning: "(no-absolute-import) import missing `from __future__ import absolute_import`"
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1868
diff changeset
    34
from __future__ import absolute_import
1732
94ffe74e6895 clean-up: fix PEP8 E401 multiple imports on one line
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    35
import os
94ffe74e6895 clean-up: fix PEP8 E401 multiple imports on one line
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    36
import traceback
94ffe74e6895 clean-up: fix PEP8 E401 multiple imports on one line
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    37
import types
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    38
import shutil
2523
aa7f138648f3 WIP adding searching capabilities in python files:
Edouard Tisserant
parents: 2443
diff changeset
    39
from operator import add
2551
245644bfcd24 Make spaghetti-code-quality great again.
Edouard Tisserant
parents: 2524
diff changeset
    40
from functools import reduce
2434
07f48018b6f5 python3 support: pylint, W1612 # (unicode-builtin) unicode built-in referenced
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2418
diff changeset
    41
from builtins import str as text
2443
75a274023970 python3 support: pylint, W1606 # (execfile-builtin) execfile built-in referenced
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2434
diff changeset
    42
from past.builtins import execfile
2434
07f48018b6f5 python3 support: pylint, W1612 # (unicode-builtin) unicode built-in referenced
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2418
diff changeset
    43
1315
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
    44
from lxml import etree
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
    45
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
    46
from xmlclass import GenerateParserFromXSDstring
1850
614396cbffbf fix pylint warning '(unused-import), Unused import connectors'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1847
diff changeset
    47
from PLCControler import LOCATION_CONFNODE
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents: 801
diff changeset
    48
from editors.ConfTreeNodeEditor import ConfTreeNodeEditor
274
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
    49
1315
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
    50
_BaseParamsParser = GenerateParserFromXSDstring("""<?xml version="1.0" encoding="ISO-8859-1" ?>
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    51
        <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    52
          <xsd:element name="BaseParams">
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    53
            <xsd:complexType>
86
f0a9d74e3b26 Adding support for the new version of xmlclass
lbessard
parents: 82
diff changeset
    54
              <xsd:attribute name="Name" type="xsd:string" use="optional" default="__unnamed__"/>
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
    55
              <xsd:attribute name="IEC_Channel" type="xsd:integer" use="required"/>
86
f0a9d74e3b26 Adding support for the new version of xmlclass
lbessard
parents: 82
diff changeset
    56
              <xsd:attribute name="Enabled" type="xsd:boolean" use="optional" default="true"/>
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    57
            </xsd:complexType>
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    58
          </xsd:element>
1315
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
    59
        </xsd:schema>""")
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    60
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    61
NameTypeSeparator = '@'
1722
89824afffef2 fix some typos
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1581
diff changeset
    62
XSDSchemaErrorMessage = _("{a1} XML file doesn't follow XSD schema at line {a2}:\n{a3}")
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    63
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1734
diff changeset
    64
1831
56b48961cc68 fix (old-style-class) Old-style class defined error for most parts of
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1828
diff changeset
    65
class ConfigTreeNode(object):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    66
    """
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
    67
    This class is the one that define confnodes.
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    68
    """
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    69
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    70
    XSD = None
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
    71
    CTNChildrenTypes = []
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
    72
    CTNMaxCount = None
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
    73
    ConfNodeMethods = []
274
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
    74
    LibraryControler = None
743
4645a3a398ad Fix bugs with ConfigTreeNode
laurent
parents: 741
diff changeset
    75
    EditorType = ConfTreeNodeEditor
738
413946c04c87 refactoring
laurent
parents: 734
diff changeset
    76
    IconPath = None
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
    77
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    78
    def _AddParamsMembers(self):
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
    79
        self.CTNParams = None
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
    80
        if self.XSD:
1315
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
    81
            self.Parser = GenerateParserFromXSDstring(self.XSD)
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
    82
            obj = self.Parser.CreateRoot()
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
    83
            name = obj.getLocalTag()
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
    84
            self.CTNParams = (name, obj)
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
    85
            setattr(self, name, obj)
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
    86
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
    87
    def __init__(self):
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
    88
        # Create BaseParam
1315
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
    89
        self.BaseParams = _BaseParamsParser.CreateRoot()
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
    90
        self.MandatoryParams = ("BaseParams", self.BaseParams)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    91
        self._AddParamsMembers()
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
    92
        self.Children = {}
656
c1792dfc8c7e Fixing bug integrated plugin editors not closed when removing corresponding plugin
laurent
parents: 655
diff changeset
    93
        self._View = None
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
    94
        # copy ConfNodeMethods so that it can be later customized
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
    95
        self.ConfNodeMethods = [dic.copy() for dic in self.ConfNodeMethods]
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
    96
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
    97
    def ConfNodeBaseXmlFilePath(self, CTNName=None):
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
    98
        return os.path.join(self.CTNPath(CTNName), "baseconfnode.xml")
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
    99
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   100
    def ConfNodeXmlFilePath(self, CTNName=None):
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   101
        return os.path.join(self.CTNPath(CTNName), "confnode.xml")
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   102
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   103
    def ConfNodePath(self):
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   104
        return os.path.join(self.CTNParent.ConfNodePath(), self.CTNType)
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   105
1740
b789b695b5c6 clean-up: fix PEP8 E231 missing whitespace after ':' or ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1739
diff changeset
   106
    def CTNPath(self, CTNName=None, project_path=None):
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   107
        if not CTNName:
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   108
            CTNName = self.CTNName()
1061
02f371f3e063 Fixed Save As... function in Beremiz
Laurent Bessard
parents: 1033
diff changeset
   109
        if not project_path:
02f371f3e063 Fixed Save As... function in Beremiz
Laurent Bessard
parents: 1033
diff changeset
   110
            project_path = self.CTNParent.CTNPath()
02f371f3e063 Fixed Save As... function in Beremiz
Laurent Bessard
parents: 1033
diff changeset
   111
        return os.path.join(project_path,
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   112
                            CTNName + NameTypeSeparator + self.CTNType)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   113
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   114
    def CTNName(self):
675
44b35c27e9ff Adding support for quickly open recent projects in file menu
laurent
parents: 674
diff changeset
   115
        return self.BaseParams.getName()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   116
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   117
    def CTNEnabled(self):
675
44b35c27e9ff Adding support for quickly open recent projects in file menu
laurent
parents: 674
diff changeset
   118
        return self.BaseParams.getEnabled()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   119
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   120
    def CTNFullName(self):
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   121
        parent = self.CTNParent.CTNFullName()
656
c1792dfc8c7e Fixing bug integrated plugin editors not closed when removing corresponding plugin
laurent
parents: 655
diff changeset
   122
        if parent != "":
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   123
            return parent + "." + self.CTNName()
656
c1792dfc8c7e Fixing bug integrated plugin editors not closed when removing corresponding plugin
laurent
parents: 655
diff changeset
   124
        return self.BaseParams.getName()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   125
2523
aa7f138648f3 WIP adding searching capabilities in python files:
Edouard Tisserant
parents: 2443
diff changeset
   126
    def CTNSearch(self, criteria):
aa7f138648f3 WIP adding searching capabilities in python files:
Edouard Tisserant
parents: 2443
diff changeset
   127
        # TODO match config's fields name and fields contents
aa7f138648f3 WIP adding searching capabilities in python files:
Edouard Tisserant
parents: 2443
diff changeset
   128
        return reduce(add, [
aa7f138648f3 WIP adding searching capabilities in python files:
Edouard Tisserant
parents: 2443
diff changeset
   129
            CTNChild.CTNSearch(criteria)
2552
46a1e8d1e92c Fix error when searching accross project. Collection of result wasn't initialized and was failing in case some CTN was returning no result.
Edouard Tisserant
parents: 2551
diff changeset
   130
            for CTNChild in self.IterChildren()],[])
2523
aa7f138648f3 WIP adding searching capabilities in python files:
Edouard Tisserant
parents: 2443
diff changeset
   131
781
cdc6393705ce Adding support using plcopeneditor bitmap library for icon request
laurent
parents: 780
diff changeset
   132
    def GetIconName(self):
734
5c42cafaee15 Moved LPC sources to a separate project
Edouard Tisserant
parents: 728
diff changeset
   133
        return None
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   134
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   135
    def CTNTestModified(self):
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   136
        return self.ChangesToSave
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   137
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   138
    def ProjectTestModified(self):
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   139
        """
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   140
        recursively check modified status
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   141
        """
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   142
        if self.CTNTestModified():
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   143
            return True
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   144
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   145
        for CTNChild in self.IterChildren():
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   146
            if CTNChild.ProjectTestModified():
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   147
                return True
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   148
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   149
        return False
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   150
699
6ff64cadb1ff Adding support for executing python scripts on remote runtime
laurent
parents: 696
diff changeset
   151
    def RemoteExec(self, script, **kwargs):
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   152
        return self.CTNParent.RemoteExec(script, **kwargs)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   153
1061
02f371f3e063 Fixed Save As... function in Beremiz
Laurent Bessard
parents: 1033
diff changeset
   154
    def OnCTNSave(self, from_project_path=None):
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1778
diff changeset
   155
        """Default, do nothing and return success"""
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   156
        return True
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   157
1744
69dfdb26f600 clean-up: fix PEP8 E251 unexpected spaces around keyword / parameter equals
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1742
diff changeset
   158
    def GetParamsAttributes(self, path=None):
19
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   159
        if path:
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   160
            parts = path.split(".", 1)
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   161
            if self.MandatoryParams and parts[0] == self.MandatoryParams[0]:
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   162
                return self.MandatoryParams[1].getElementInfos(parts[0], parts[1])
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   163
            elif self.CTNParams and parts[0] == self.CTNParams[0]:
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   164
                return self.CTNParams[1].getElementInfos(parts[0], parts[1])
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   165
        else:
19
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   166
            params = []
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   167
            if self.CTNParams:
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   168
                params.append(self.CTNParams[1].getElementInfos(self.CTNParams[0]))
19
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   169
            return params
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   170
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   171
    def SetParamsAttribute(self, path, value):
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   172
        self.ChangesToSave = True
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   173
        # Filter IEC_Channel and Name, that have specific behavior
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   174
        if path == "BaseParams.IEC_Channel":
443
34c9788bd933 Adding support for updating located variables when changing plugin IEC_Channel
laurent
parents: 440
diff changeset
   175
            old_leading = ".".join(map(str, self.GetCurrentLocation()))
34c9788bd933 Adding support for updating located variables when changing plugin IEC_Channel
laurent
parents: 440
diff changeset
   176
            new_value = self.FindNewIEC_Channel(value)
842
3c4c1e076a34 Fix bug when modifying IEC_Channel
Laurent Bessard
parents: 841
diff changeset
   177
            if new_value != value:
3c4c1e076a34 Fix bug when modifying IEC_Channel
Laurent Bessard
parents: 841
diff changeset
   178
                new_leading = ".".join(map(str, self.CTNParent.GetCurrentLocation() + (new_value,)))
3c4c1e076a34 Fix bug when modifying IEC_Channel
Laurent Bessard
parents: 841
diff changeset
   179
                self.GetCTRoot().UpdateProjectVariableLocation(old_leading, new_leading)
443
34c9788bd933 Adding support for updating located variables when changing plugin IEC_Channel
laurent
parents: 440
diff changeset
   180
            return new_value, True
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   181
        elif path == "BaseParams.Name":
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   182
            res = self.FindNewName(value)
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   183
            self.CTNRequestSave()
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   184
            return res, True
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   185
19
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   186
        parts = path.split(".", 1)
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   187
        if self.MandatoryParams and parts[0] == self.MandatoryParams[0]:
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   188
            self.MandatoryParams[1].setElementValue(parts[1], value)
1179
3e7bd88fcff7 Fixed inconsistency in value display when setting integer value for float parameter
Laurent Bessard
parents: 1063
diff changeset
   189
            value = self.MandatoryParams[1].getElementInfos(parts[0], parts[1])["value"]
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   190
        elif self.CTNParams and parts[0] == self.CTNParams[0]:
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   191
            self.CTNParams[1].setElementValue(parts[1], value)
1179
3e7bd88fcff7 Fixed inconsistency in value display when setting integer value for float parameter
Laurent Bessard
parents: 1063
diff changeset
   192
            value = self.CTNParams[1].getElementInfos(parts[0], parts[1])["value"]
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   193
        return value, False
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   194
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   195
    def CTNMakeDir(self):
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   196
        os.mkdir(self.CTNPath())
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   197
1061
02f371f3e063 Fixed Save As... function in Beremiz
Laurent Bessard
parents: 1033
diff changeset
   198
    def CTNRequestSave(self, from_project_path=None):
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   199
        if self.GetCTRoot().CheckProjectPathPerm(False):
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   200
            # If confnode do not have corresponding directory
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   201
            ctnpath = self.CTNPath()
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   202
            if not os.path.isdir(ctnpath):
427
7ac746c07ff2 Check ProjectPath write permission
greg
parents: 423
diff changeset
   203
                # Create it
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   204
                os.mkdir(ctnpath)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   205
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   206
            # generate XML for base XML parameters controller of the confnode
427
7ac746c07ff2 Check ProjectPath write permission
greg
parents: 423
diff changeset
   207
            if self.MandatoryParams:
1740
b789b695b5c6 clean-up: fix PEP8 E231 missing whitespace after ':' or ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1739
diff changeset
   208
                BaseXMLFile = open(self.ConfNodeBaseXmlFilePath(), 'w')
1315
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
   209
                BaseXMLFile.write(etree.tostring(
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   210
                    self.MandatoryParams[1],
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   211
                    pretty_print=True,
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   212
                    xml_declaration=True,
1315
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
   213
                    encoding='utf-8'))
427
7ac746c07ff2 Check ProjectPath write permission
greg
parents: 423
diff changeset
   214
                BaseXMLFile.close()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   215
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   216
            # generate XML for XML parameters controller of the confnode
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   217
            if self.CTNParams:
1740
b789b695b5c6 clean-up: fix PEP8 E231 missing whitespace after ':' or ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1739
diff changeset
   218
                XMLFile = open(self.ConfNodeXmlFilePath(), 'w')
1315
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
   219
                XMLFile.write(etree.tostring(
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   220
                    self.CTNParams[1],
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   221
                    pretty_print=True,
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   222
                    xml_declaration=True,
1315
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
   223
                    encoding='utf-8'))
427
7ac746c07ff2 Check ProjectPath write permission
greg
parents: 423
diff changeset
   224
                XMLFile.close()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   225
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   226
            # Call the confnode specific OnCTNSave method
1061
02f371f3e063 Fixed Save As... function in Beremiz
Laurent Bessard
parents: 1033
diff changeset
   227
            result = self.OnCTNSave(from_project_path)
427
7ac746c07ff2 Check ProjectPath write permission
greg
parents: 423
diff changeset
   228
            if not result:
1734
750eeb7230a1 clean-up: fix some PEP8 E228 missing whitespace around modulo operator
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1733
diff changeset
   229
                return _("Error while saving \"%s\"\n") % self.CTNPath()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   230
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   231
            # mark confnode as saved
427
7ac746c07ff2 Check ProjectPath write permission
greg
parents: 423
diff changeset
   232
            self.ChangesToSave = False
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   233
            # go through all children and do the same
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   234
            for CTNChild in self.IterChildren():
1063
9b5995303db1 Fixed bug in Save function in Beremiz
Laurent Bessard
parents: 1061
diff changeset
   235
                CTNChildPath = None
9b5995303db1 Fixed bug in Save function in Beremiz
Laurent Bessard
parents: 1061
diff changeset
   236
                if from_project_path is not None:
9b5995303db1 Fixed bug in Save function in Beremiz
Laurent Bessard
parents: 1061
diff changeset
   237
                    CTNChildPath = CTNChild.CTNPath(project_path=from_project_path)
9b5995303db1 Fixed bug in Save function in Beremiz
Laurent Bessard
parents: 1061
diff changeset
   238
                result = CTNChild.CTNRequestSave(CTNChildPath)
427
7ac746c07ff2 Check ProjectPath write permission
greg
parents: 423
diff changeset
   239
                if result:
7ac746c07ff2 Check ProjectPath write permission
greg
parents: 423
diff changeset
   240
                    return result
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   241
        return None
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   242
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   243
    def CTNImport(self, src_CTNPath):
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   244
        shutil.copytree(src_CTNPath, self.CTNPath)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   245
        return True
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   246
883
235a9ec83b95 Adding support for defining specific global variables for ConfTreeNodes
Laurent Bessard
parents: 842
diff changeset
   247
    def CTNGlobalInstances(self):
235a9ec83b95 Adding support for defining specific global variables for ConfTreeNodes
Laurent Bessard
parents: 842
diff changeset
   248
        """
235a9ec83b95 Adding support for defining specific global variables for ConfTreeNodes
Laurent Bessard
parents: 842
diff changeset
   249
        @return: [(instance_name, instance_type),...]
235a9ec83b95 Adding support for defining specific global variables for ConfTreeNodes
Laurent Bessard
parents: 842
diff changeset
   250
        """
235a9ec83b95 Adding support for defining specific global variables for ConfTreeNodes
Laurent Bessard
parents: 842
diff changeset
   251
        return []
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   252
883
235a9ec83b95 Adding support for defining specific global variables for ConfTreeNodes
Laurent Bessard
parents: 842
diff changeset
   253
    def _GlobalInstances(self):
235a9ec83b95 Adding support for defining specific global variables for ConfTreeNodes
Laurent Bessard
parents: 842
diff changeset
   254
        instances = self.CTNGlobalInstances()
235a9ec83b95 Adding support for defining specific global variables for ConfTreeNodes
Laurent Bessard
parents: 842
diff changeset
   255
        for CTNChild in self.IECSortedChildren():
235a9ec83b95 Adding support for defining specific global variables for ConfTreeNodes
Laurent Bessard
parents: 842
diff changeset
   256
            instances.extend(CTNChild._GlobalInstances())
235a9ec83b95 Adding support for defining specific global variables for ConfTreeNodes
Laurent Bessard
parents: 842
diff changeset
   257
        return instances
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   258
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   259
    def CTNGenerate_C(self, buildpath, locations):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   260
        """
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   261
        Generate C code
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   262
        @param locations: List of complete variables locations \
22
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   263
            [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   264
            "NAME" : name of the variable (generally "__IW0_1_2" style)
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   265
            "DIR" : direction "Q","I" or "M"
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   266
            "SIZE" : size "X", "B", "W", "D", "L"
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   267
            "LOC" : tuple of interger for IEC location (0,1,2,...)
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   268
            }, ...]
18
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
   269
        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
   270
        """
1833
2269739dd098 fix unnecessary lambda and enable corresponding pylint check
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1831
diff changeset
   271
        self.GetCTRoot().logger.write_warning(".".join(map(str, self.GetCurrentLocation())) + " -> Nothing to do\n")
1740
b789b695b5c6 clean-up: fix PEP8 E231 missing whitespace after ':' or ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1739
diff changeset
   272
        return [], "", False
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   273
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   274
    def _Generate_C(self, buildpath, locations):
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   275
        # Generate confnodes [(Cfiles, CFLAGS)], LDFLAGS, DoCalls, extra_files
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   276
        # extra_files = [(fname,fobject), ...]
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   277
        gen_result = self.CTNGenerate_C(buildpath, locations)
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   278
        CTNCFilesAndCFLAGS, CTNLDFLAGS, DoCalls = gen_result[:3]
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   279
        extra_files = gen_result[3:]
361
331d698e1118 Adding support for internationalization
laurent
parents: 356
diff changeset
   280
        # if some files have been generated put them in the list with their location
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   281
        if CTNCFilesAndCFLAGS:
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   282
            LocationCFilesAndCFLAGS = [(self.GetCurrentLocation(), CTNCFilesAndCFLAGS, DoCalls)]
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   283
        else:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   284
            LocationCFilesAndCFLAGS = []
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   285
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   286
        # confnode asks for some LDFLAGS
2003
2076df8743b5 Support unicode in LDFLAGS returned by extensions
Edouard Tisserant
parents: 1932
diff changeset
   287
        LDFLAGS = []
2076df8743b5 Support unicode in LDFLAGS returned by extensions
Edouard Tisserant
parents: 1932
diff changeset
   288
        if CTNLDFLAGS is not None:
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   289
            # LDFLAGS can be either string
2434
07f48018b6f5 python3 support: pylint, W1612 # (unicode-builtin) unicode built-in referenced
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2418
diff changeset
   290
            if isinstance(CTNLDFLAGS, (str, text)):
2003
2076df8743b5 Support unicode in LDFLAGS returned by extensions
Edouard Tisserant
parents: 1932
diff changeset
   291
                LDFLAGS += [CTNLDFLAGS]
1733
dea107dce0c4 clean-up: fix some PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1732
diff changeset
   292
            # or list of strings
1778
1c6a704bd39c clean-up: fix PEP8 E721 do not compare types, use 'isinstance()'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
   293
            elif isinstance(CTNLDFLAGS, list):
2003
2076df8743b5 Support unicode in LDFLAGS returned by extensions
Edouard Tisserant
parents: 1932
diff changeset
   294
                LDFLAGS += CTNLDFLAGS
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   295
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   296
        # recurse through all children, and stack their results
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   297
        for CTNChild in self.IECSortedChildren():
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   298
            new_location = CTNChild.GetCurrentLocation()
24
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
   299
            # How deep are we in the tree ?
1742
92932cd370a4 clean-up: fix PEP8 E225 missing whitespace around operator
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1740
diff changeset
   300
            depth = len(new_location)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   301
            _LocationCFilesAndCFLAGS, _LDFLAGS, _extra_files = \
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   302
                CTNChild._Generate_C(
1733
dea107dce0c4 clean-up: fix some PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1732
diff changeset
   303
                    # keep the same path
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   304
                    buildpath,
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   305
                    # filter locations that start with current IEC location
1746
45d6f5fba016 clean-up: fix PEP8 E202 whitespace before ')'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1744
diff changeset
   306
                    [loc for loc in locations if loc["LOC"][0:depth] == new_location])
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   307
            # stack the result
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   308
            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   309
            LDFLAGS += _LDFLAGS
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   310
            extra_files += _extra_files
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   311
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   312
        return LocationCFilesAndCFLAGS, LDFLAGS, extra_files
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   313
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   314
    def IterChildren(self):
1847
6198190bc121 explicitly mark unused variables found by pylint with _ or dummy
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1846
diff changeset
   315
        for _CTNType, Children in self.Children.items():
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   316
            for CTNInstance in Children:
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   317
                yield CTNInstance
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   318
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   319
    def IECSortedChildren(self):
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   320
        # reorder children by IEC_channels
1740
b789b695b5c6 clean-up: fix PEP8 E231 missing whitespace after ':' or ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1739
diff changeset
   321
        ordered = [(chld.BaseParams.getIEC_Channel(), chld) for chld in self.IterChildren()]
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   322
        if ordered:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   323
            ordered.sort()
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   324
            return zip(*ordered)[1]
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   325
        else:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   326
            return []
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   327
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   328
    def _GetChildBySomething(self, something, toks):
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   329
        for CTNInstance in self.IterChildren():
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   330
            # if match component of the name
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   331
            if getattr(CTNInstance.BaseParams, something) == toks[0]:
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   332
                # if Name have other components
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   333
                if len(toks) >= 2:
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   334
                    # Recurse in order to find the latest object
1747
6046ffa2280f clean-up: fix PEP8 E201 whitespace after '{'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1746
diff changeset
   335
                    return CTNInstance._GetChildBySomething(something, toks[1:])
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   336
                # No sub name -> found
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   337
                return CTNInstance
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   338
        # Not found
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   339
        return None
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   340
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   341
    def GetChildByName(self, Name):
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   342
        if Name:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   343
            toks = Name.split('.')
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   344
            return self._GetChildBySomething("Name", toks)
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   345
        else:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   346
            return self
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   347
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   348
    def GetChildByIECLocation(self, Location):
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   349
        if Location:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   350
            return self._GetChildBySomething("IEC_Channel", Location)
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   351
        else:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   352
            return self
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   353
23
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   354
    def GetCurrentLocation(self):
24
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
   355
        """
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   356
        @return:  Tupple containing confnode IEC location of current confnode : %I0.0.4.5 => (0,0,4,5)
24
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
   357
        """
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   358
        return self.CTNParent.GetCurrentLocation() + (self.BaseParams.getIEC_Channel(),)
23
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   359
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   360
    def GetCurrentName(self):
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   361
        """
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   362
        @return:  String "ParentParentName.ParentName.Name"
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   363
        """
1738
d2e979738700 clean-up: fix PEP8 E271 multiple spaces after keyword
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1737
diff changeset
   364
        return self.CTNParent._GetCurrentName() + self.BaseParams.getName()
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   365
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   366
    def _GetCurrentName(self):
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   367
        """
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   368
        @return:  String "ParentParentName.ParentName.Name."
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   369
        """
1738
d2e979738700 clean-up: fix PEP8 E271 multiple spaces after keyword
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1737
diff changeset
   370
        return self.CTNParent._GetCurrentName() + self.BaseParams.getName() + "."
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   371
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   372
    def GetCTRoot(self):
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   373
        return self.CTNParent.GetCTRoot()
23
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   374
97
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   375
    def GetFullIEC_Channel(self):
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   376
        return ".".join([str(i) for i in self.GetCurrentLocation()]) + ".x"
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   377
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   378
    def GetLocations(self):
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   379
        location = self.GetCurrentLocation()
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   380
        return [loc for loc in self.CTNParent.GetLocations() if loc["LOC"][0:len(location)] == location]
97
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   381
401
8106a853a7c7 Adding support for displaying plugins available variable into Beremiz plugin tree
laurent
parents: 396
diff changeset
   382
    def GetVariableLocationTree(self):
8106a853a7c7 Adding support for displaying plugins available variable into Beremiz plugin tree
laurent
parents: 396
diff changeset
   383
        '''
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   384
        This function is meant to be overridden by confnodes.
401
8106a853a7c7 Adding support for displaying plugins available variable into Beremiz plugin tree
laurent
parents: 396
diff changeset
   385
8106a853a7c7 Adding support for displaying plugins available variable into Beremiz plugin tree
laurent
parents: 396
diff changeset
   386
        It should returns an list of dictionaries
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   387
401
8106a853a7c7 Adding support for displaying plugins available variable into Beremiz plugin tree
laurent
parents: 396
diff changeset
   388
        - IEC_type is an IEC type like BOOL/BYTE/SINT/...
8106a853a7c7 Adding support for displaying plugins available variable into Beremiz plugin tree
laurent
parents: 396
diff changeset
   389
        - location is a string of this variable's location, like "%IX0.0.0"
8106a853a7c7 Adding support for displaying plugins available variable into Beremiz plugin tree
laurent
parents: 396
diff changeset
   390
        '''
8106a853a7c7 Adding support for displaying plugins available variable into Beremiz plugin tree
laurent
parents: 396
diff changeset
   391
        children = []
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   392
        for child in self.IECSortedChildren():
402
984e238e63d0 Bugs on displaying plugin available variables in PluginTree fixed
laurent
parents: 401
diff changeset
   393
            children.append(child.GetVariableLocationTree())
984e238e63d0 Bugs on displaying plugin available variables in PluginTree fixed
laurent
parents: 401
diff changeset
   394
        return {"name": self.BaseParams.getName(),
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   395
                "type": LOCATION_CONFNODE,
402
984e238e63d0 Bugs on displaying plugin available variables in PluginTree fixed
laurent
parents: 401
diff changeset
   396
                "location": self.GetFullIEC_Channel(),
984e238e63d0 Bugs on displaying plugin available variables in PluginTree fixed
laurent
parents: 401
diff changeset
   397
                "children": children}
401
8106a853a7c7 Adding support for displaying plugins available variable into Beremiz plugin tree
laurent
parents: 396
diff changeset
   398
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   399
    def FindNewName(self, DesiredName):
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   400
        """
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   401
        Changes Name to DesiredName if available, Name-N if not.
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   402
        @param DesiredName: The desired Name (string)
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   403
        """
1846
14b40afccd69 remove unused variables found by pylint
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1833
diff changeset
   404
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   405
        # Build a list of used Name out of parent's Children
1742
92932cd370a4 clean-up: fix PEP8 E225 missing whitespace around operator
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1740
diff changeset
   406
        AllNames = []
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   407
        for CTNInstance in self.CTNParent.IterChildren():
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   408
            if CTNInstance != self:
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   409
                AllNames.append(CTNInstance.BaseParams.getName())
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   410
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   411
        # Find a free name, eventually appending digit
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   412
        res = DesiredName
833
3f997fb22928 Fix confnode new name format that generates an error with frame class name in wxGlade extension
laurent
parents: 814
diff changeset
   413
        if DesiredName.endswith("_0"):
841
8e19df12b596 Fix unexpected warning message when adding extension to project
Laurent Bessard
parents: 833
diff changeset
   414
            BaseDesiredName = DesiredName[:-2]
8e19df12b596 Fix unexpected warning message when adding extension to project
Laurent Bessard
parents: 833
diff changeset
   415
        else:
8e19df12b596 Fix unexpected warning message when adding extension to project
Laurent Bessard
parents: 833
diff changeset
   416
            BaseDesiredName = DesiredName
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   417
        suffix = 1
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   418
        while res in AllNames:
1734
750eeb7230a1 clean-up: fix some PEP8 E228 missing whitespace around modulo operator
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1733
diff changeset
   419
            res = "%s_%d" % (BaseDesiredName, suffix)
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   420
            suffix += 1
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   421
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   422
        # Check previous confnode existance
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   423
        dontexist = self.BaseParams.getName() == "__unnamed__"
1932
65d2dbbf7022 Better variable naming, and small optimization.
Edouard Tisserant
parents: 1881
diff changeset
   424
        if not dontexist:
65d2dbbf7022 Better variable naming, and small optimization.
Edouard Tisserant
parents: 1881
diff changeset
   425
            # Get old path
65d2dbbf7022 Better variable naming, and small optimization.
Edouard Tisserant
parents: 1881
diff changeset
   426
            oldpath = self.CTNPath()
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   427
        # Set the new name
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   428
        self.BaseParams.setName(res)
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   429
        # Rename confnode dir if exist
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   430
        if not dontexist:
1932
65d2dbbf7022 Better variable naming, and small optimization.
Edouard Tisserant
parents: 1881
diff changeset
   431
            shutil.move(oldpath, self.CTNPath())
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   432
        # warn user he has two left hands
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   433
        if DesiredName != res:
1744
69dfdb26f600 clean-up: fix PEP8 E251 unexpected spaces around keyword / parameter equals
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1742
diff changeset
   434
            msg = _("A child named \"{a1}\" already exists -> \"{a2}\"\n").format(a1=DesiredName, a2=res)
1581
2295fdc5c271 fix translation strings with multiple parameters
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
   435
            self.GetCTRoot().logger.write_warning(msg)
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   436
        return res
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   437
683
57aa9da845d5 Fix wrong panel size making strange background in topology plugin element
laurent
parents: 677
diff changeset
   438
    def GetAllChannels(self):
1742
92932cd370a4 clean-up: fix PEP8 E225 missing whitespace around operator
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1740
diff changeset
   439
        AllChannels = []
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   440
        for CTNInstance in self.CTNParent.IterChildren():
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   441
            if CTNInstance != self:
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   442
                AllChannels.append(CTNInstance.BaseParams.getIEC_Channel())
683
57aa9da845d5 Fix wrong panel size making strange background in topology plugin element
laurent
parents: 677
diff changeset
   443
        AllChannels.sort()
57aa9da845d5 Fix wrong panel size making strange background in topology plugin element
laurent
parents: 677
diff changeset
   444
        return AllChannels
57aa9da845d5 Fix wrong panel size making strange background in topology plugin element
laurent
parents: 677
diff changeset
   445
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   446
    def FindNewIEC_Channel(self, DesiredChannel):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   447
        """
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   448
        Changes IEC Channel number to DesiredChannel if available, nearest available if not.
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   449
        @param DesiredChannel: The desired IEC channel (int)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   450
        """
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   451
        # Get Current IEC channel
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   452
        CurrentChannel = self.BaseParams.getIEC_Channel()
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   453
        # Do nothing if no change
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1778
diff changeset
   454
        # if CurrentChannel == DesiredChannel: return CurrentChannel
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   455
        # Build a list of used Channels out of parent's Children
683
57aa9da845d5 Fix wrong panel size making strange background in topology plugin element
laurent
parents: 677
diff changeset
   456
        AllChannels = self.GetAllChannels()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   457
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   458
        # Now, try to guess the nearest available channel
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   459
        res = DesiredChannel
1737
a39c2918c015 clean-up: fix PEP8 E261 at least two spaces before inline comment
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1736
diff changeset
   460
        while res in AllChannels:  # While channel not free
a39c2918c015 clean-up: fix PEP8 E261 at least two spaces before inline comment
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1736
diff changeset
   461
            if res < CurrentChannel:  # Want to go down ?
1758
845ca626db09 clean-up: fix PEP8 E222 multiple spaces after operator
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1747
diff changeset
   462
                res -= 1  # Test for n-1
1739
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1738
diff changeset
   463
                if res < 0:
1734
750eeb7230a1 clean-up: fix some PEP8 E228 missing whitespace around modulo operator
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1733
diff changeset
   464
                    self.GetCTRoot().logger.write_warning(_("Cannot find lower free IEC channel than %d\n") % CurrentChannel)
1737
a39c2918c015 clean-up: fix PEP8 E261 at least two spaces before inline comment
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1736
diff changeset
   465
                    return CurrentChannel  # Can't go bellow 0, do nothing
1739
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1738
diff changeset
   466
            else:  # Want to go up ?
1758
845ca626db09 clean-up: fix PEP8 E222 multiple spaces after operator
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1747
diff changeset
   467
                res += 1  # Test for n-1
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   468
        # Finally set IEC Channel
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   469
        self.BaseParams.setIEC_Channel(res)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   470
        return res
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   471
967
8a339cd61cb4 Added support for extension custom contextual add menu
Laurent Bessard
parents: 883
diff changeset
   472
    def GetContextualMenuItems(self):
8a339cd61cb4 Added support for extension custom contextual add menu
Laurent Bessard
parents: 883
diff changeset
   473
        return None
8a339cd61cb4 Added support for extension custom contextual add menu
Laurent Bessard
parents: 883
diff changeset
   474
2524
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   475
    def GetView(self):
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   476
        if self._View is None and self.EditorType is not None:
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   477
            app_frame = self.GetCTRoot().AppFrame
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   478
            self._View = self.EditorType(app_frame.TabsOpened, self, app_frame)
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   479
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   480
        return self._View
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   481
782
6f0e10085df9 Adding support for file explorer for project files
laurent
parents: 781
diff changeset
   482
    def _OpenView(self, name=None, onlyopened=False):
2524
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   483
        view = self.GetView()
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   484
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   485
        if view is not None:
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   486
            if name is None:
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   487
                name = self.CTNFullName()
782
6f0e10085df9 Adding support for file explorer for project files
laurent
parents: 781
diff changeset
   488
            app_frame = self.GetCTRoot().AppFrame
2524
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   489
            app_frame.EditProjectElement(view, name)
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   490
c80b0d864475 WIP adding searching capabilities in python files. was done :
Edouard Tisserant
parents: 2523
diff changeset
   491
        return view
675
44b35c27e9ff Adding support for quickly open recent projects in file menu
laurent
parents: 674
diff changeset
   492
774
78b5fa92dd1c Fix bug when opening and closing confnode extra viewers
laurent
parents: 744
diff changeset
   493
    def _CloseView(self, view):
78b5fa92dd1c Fix bug when opening and closing confnode extra viewers
laurent
parents: 744
diff changeset
   494
        app_frame = self.GetCTRoot().AppFrame
78b5fa92dd1c Fix bug when opening and closing confnode extra viewers
laurent
parents: 744
diff changeset
   495
        if app_frame is not None:
78b5fa92dd1c Fix bug when opening and closing confnode extra viewers
laurent
parents: 744
diff changeset
   496
            app_frame.DeletePage(view)
78b5fa92dd1c Fix bug when opening and closing confnode extra viewers
laurent
parents: 744
diff changeset
   497
675
44b35c27e9ff Adding support for quickly open recent projects in file menu
laurent
parents: 674
diff changeset
   498
    def OnCloseEditor(self, view):
44b35c27e9ff Adding support for quickly open recent projects in file menu
laurent
parents: 674
diff changeset
   499
        if self._View == view:
44b35c27e9ff Adding support for quickly open recent projects in file menu
laurent
parents: 674
diff changeset
   500
            self._View = None
656
c1792dfc8c7e Fixing bug integrated plugin editors not closed when removing corresponding plugin
laurent
parents: 655
diff changeset
   501
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   502
    def OnCTNClose(self):
656
c1792dfc8c7e Fixing bug integrated plugin editors not closed when removing corresponding plugin
laurent
parents: 655
diff changeset
   503
        if self._View is not None:
780
70632f4612a1 Fix bug when deleting conf tree node and conf tree node editor opened for this same node
laurent
parents: 774
diff changeset
   504
            self._CloseView(self._View)
774
78b5fa92dd1c Fix bug when opening and closing confnode extra viewers
laurent
parents: 744
diff changeset
   505
            self._View = None
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   506
        return True
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   507
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   508
    def _doRemoveChild(self, CTNInstance):
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   509
        # Remove all children of child
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   510
        for SubCTNInstance in CTNInstance.IterChildren():
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   511
            CTNInstance._doRemoveChild(SubCTNInstance)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   512
        # Call the OnCloseMethod
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   513
        CTNInstance.OnCTNClose()
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   514
        # Delete confnode dir
2004
28af541d776b Allow deleting configuration tree node with no corresponding directory in project tree
Edouard Tisserant
parents: 2003
diff changeset
   515
        try:
28af541d776b Allow deleting configuration tree node with no corresponding directory in project tree
Edouard Tisserant
parents: 2003
diff changeset
   516
            shutil.rmtree(CTNInstance.CTNPath())
2182
eeca1aff0691 Fix linter errors
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2004
diff changeset
   517
        except Exception:
2004
28af541d776b Allow deleting configuration tree node with no corresponding directory in project tree
Edouard Tisserant
parents: 2003
diff changeset
   518
            pass
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   519
        # Remove child of Children
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   520
        self.Children[CTNInstance.CTNType].remove(CTNInstance)
1033
1eec9b855e47 Clean Config Tree Node children list by type after removing one child
Laurent Bessard
parents: 967
diff changeset
   521
        if len(self.Children[CTNInstance.CTNType]) == 0:
1eec9b855e47 Clean Config Tree Node children list by type after removing one child
Laurent Bessard
parents: 967
diff changeset
   522
            self.Children.pop(CTNInstance.CTNType)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   523
        # Forget it... (View have to refresh)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   524
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   525
    def CTNRemove(self):
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   526
        # Fetch the confnode
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1778
diff changeset
   527
        # CTNInstance = self.GetChildByName(CTNName)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   528
        # Ask to his parent to remove it
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   529
        self.CTNParent._doRemoveChild(self)
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   530
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   531
    def CTNAddChild(self, CTNName, CTNType, IEC_Channel=0):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   532
        """
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   533
        Create the confnodes that may be added as child to this node self
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   534
        @param CTNType: string desining the confnode class name (get name from CTNChildrenTypes)
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   535
        @param CTNName: string for the name of the confnode instance
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   536
        """
720
6be032177e2a refactoring
Edouard Tisserant
parents: 718
diff changeset
   537
        # reorganize self.CTNChildrenTypes tuples from (name, CTNClass, Help)
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   538
        # to ( name, (CTNClass, Help)), an make a dict
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   539
        transpose = zip(*self.CTNChildrenTypes)
1740
b789b695b5c6 clean-up: fix PEP8 E231 missing whitespace after ':' or ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1739
diff changeset
   540
        CTNChildrenTypes = dict(zip(transpose[0], zip(transpose[1], transpose[2])))
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   541
        # Check that adding this confnode is allowed
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   542
        try:
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   543
            CTNClass, CTNHelp = CTNChildrenTypes[CTNType]
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   544
        except KeyError:
1765
ccf59c1f0b45 clean-up: fix PEP8 W602 deprecated form of raising exception
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1760
diff changeset
   545
            raise Exception(_("Cannot create child {a1} of type {a2} ").
1767
c74815729afd clean-up: fix PEP8 E127 continuation line over-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1765
diff changeset
   546
                            format(a1=CTNName, a2=CTNType))
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   547
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   548
        # if CTNClass is a class factory, call it. (prevent unneeded imports)
1778
1c6a704bd39c clean-up: fix PEP8 E721 do not compare types, use 'isinstance()'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
   549
        if isinstance(CTNClass, types.FunctionType):
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   550
            CTNClass = CTNClass()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   551
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   552
        # Eventualy Initialize child instance list for this class of confnode
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   553
        ChildrenWithSameClass = self.Children.setdefault(CTNType, list())
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   554
        # Check count
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   555
        if getattr(CTNClass, "CTNMaxCount", None) and len(ChildrenWithSameClass) >= CTNClass.CTNMaxCount:
1765
ccf59c1f0b45 clean-up: fix PEP8 W602 deprecated form of raising exception
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1760
diff changeset
   556
            raise Exception(
ccf59c1f0b45 clean-up: fix PEP8 W602 deprecated form of raising exception
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1760
diff changeset
   557
                _("Max count ({a1}) reached for this confnode of type {a2} ").
ccf59c1f0b45 clean-up: fix PEP8 W602 deprecated form of raising exception
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1760
diff changeset
   558
                format(a1=CTNClass.CTNMaxCount, a2=CTNType))
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   559
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   560
        # create the final class, derived of provided confnode and template
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   561
        class FinalCTNClass(CTNClass, ConfigTreeNode):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   562
            """
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   563
            ConfNode class is derivated into FinalCTNClass before being instanciated
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   564
            This way __init__ is overloaded to ensure ConfigTreeNode.__init__ is called
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   565
            before CTNClass.__init__, and to do the file related stuff.
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   566
            """
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   567
            def __init__(self, parent):
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   568
                self.CTNParent = parent
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   569
                # Keep track of the confnode type name
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   570
                self.CTNType = CTNType
106
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   571
                # remind the help string, for more fancy display
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   572
                self.CTNHelp = CTNHelp
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   573
                # Call the base confnode template init - change XSD into class members
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   574
                ConfigTreeNode.__init__(self)
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   575
                # check name is unique
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   576
                NewCTNName = self.FindNewName(CTNName)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   577
                # If dir have already be made, and file exist
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   578
                if os.path.isdir(self.CTNPath(NewCTNName)):  # and os.path.isfile(self.ConfNodeXmlFilePath(CTNName)):
1733
dea107dce0c4 clean-up: fix some PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1732
diff changeset
   579
                    # Load the confnode.xml file into parameters members
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   580
                    self.LoadXMLParams(NewCTNName)
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   581
                    # Basic check. Better to fail immediately.
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   582
                    if self.BaseParams.getName() != NewCTNName:
1765
ccf59c1f0b45 clean-up: fix PEP8 W602 deprecated form of raising exception
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1760
diff changeset
   583
                        raise Exception(
ccf59c1f0b45 clean-up: fix PEP8 W602 deprecated form of raising exception
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1760
diff changeset
   584
                            _("Project tree layout do not match confnode.xml {a1}!={a2} ").
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   585
                            format(a1=NewCTNName, a2=self.BaseParams.getName()))
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   586
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   587
                    # Now, self.CTNPath() should be OK
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   588
15
7a473efc4530 More precise design for plugins.... to be continued...
etisserant
parents: 14
diff changeset
   589
                    # Check that IEC_Channel is not already in use.
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   590
                    self.FindNewIEC_Channel(self.BaseParams.getIEC_Channel())
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   591
                    # Call the confnode real __init__
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   592
                    if getattr(CTNClass, "__init__", None):
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   593
                        CTNClass.__init__(self)
1733
dea107dce0c4 clean-up: fix some PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1732
diff changeset
   594
                    # Load and init all the children
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   595
                    self.LoadChildren()
1733
dea107dce0c4 clean-up: fix some PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1732
diff changeset
   596
                    # just loaded, nothing to saved
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   597
                    self.ChangesToSave = False
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   598
                else:
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   599
                    # If confnode do not have corresponding file/dirs - they will be created on Save
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   600
                    self.CTNMakeDir()
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   601
                    # Find an IEC number
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   602
                    self.FindNewIEC_Channel(IEC_Channel)
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   603
                    # Call the confnode real __init__
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   604
                    if getattr(CTNClass, "__init__", None):
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   605
                        CTNClass.__init__(self)
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   606
                    self.CTNRequestSave()
1733
dea107dce0c4 clean-up: fix some PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1732
diff changeset
   607
                    # just created, must be saved
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   608
                    self.ChangesToSave = True
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   609
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   610
            def _getBuildPath(self):
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   611
                return self.CTNParent._getBuildPath()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   612
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   613
        # Create the object out of the resulting class
1868
616c3f4bcbcb fix pylint error '(no-self-argument) Method should have "self" as first argument'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   614
        newConfNodeOpj = FinalCTNClass(self)
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   615
        # Store it in CTNgedChils
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   616
        ChildrenWithSameClass.append(newConfNodeOpj)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   617
717
1c23952dbde1 refactoring
Edouard Tisserant
parents: 716
diff changeset
   618
        return newConfNodeOpj
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   619
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   620
    def ClearChildren(self):
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   621
        for child in self.IterChildren():
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   622
            child.ClearChildren()
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   623
        self.Children = {}
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   624
1744
69dfdb26f600 clean-up: fix PEP8 E251 unexpected spaces around keyword / parameter equals
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1742
diff changeset
   625
    def LoadXMLParams(self, CTNName=None):
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   626
        methode_name = os.path.join(self.CTNPath(CTNName), "methods.py")
105
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
   627
        if os.path.isfile(methode_name):
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
   628
            execfile(methode_name)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   629
1332
ac7d39f4e376 Fixed error message printed when error in XML files is detected
Laurent Bessard
parents: 1330
diff changeset
   630
        ConfNodeName = CTNName if CTNName is not None else self.CTNName()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   631
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   632
        # Get the base xml tree
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   633
        if self.MandatoryParams:
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   634
            try:
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   635
                basexmlfile = open(self.ConfNodeBaseXmlFilePath(CTNName), 'r')
1330
96b242e4c59d Added support for loading XML file even if not following XSD schema (but still following XML syntax), warning user of errors in XML file
Laurent Bessard
parents: 1315
diff changeset
   636
                self.BaseParams, error = _BaseParamsParser.LoadXMLString(basexmlfile.read())
96b242e4c59d Added support for loading XML file even if not following XSD schema (but still following XML syntax), warning user of errors in XML file
Laurent Bessard
parents: 1315
diff changeset
   637
                if error is not None:
1581
2295fdc5c271 fix translation strings with multiple parameters
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
   638
                    (fname, lnum, src) = ((ConfNodeName + " BaseParams",) + error)
1744
69dfdb26f600 clean-up: fix PEP8 E251 unexpected spaces around keyword / parameter equals
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1742
diff changeset
   639
                    self.GetCTRoot().logger.write_warning(XSDSchemaErrorMessage.format(a1=fname, a2=lnum, a3=src))
1315
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
   640
                self.MandatoryParams = ("BaseParams", self.BaseParams)
106
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   641
                basexmlfile.close()
2418
5587c490a070 Use python 3 compatible exception syntax everywhere
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2414
diff changeset
   642
            except Exception as exc:
2434
07f48018b6f5 python3 support: pylint, W1612 # (unicode-builtin) unicode built-in referenced
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2418
diff changeset
   643
                msg = _("Couldn't load confnode base parameters {a1} :\n {a2}").format(a1=ConfNodeName, a2=text(exc))
1581
2295fdc5c271 fix translation strings with multiple parameters
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
   644
                self.GetCTRoot().logger.write_error(msg)
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   645
                self.GetCTRoot().logger.write_error(traceback.format_exc())
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   646
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   647
        # Get the xml tree
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   648
        if self.CTNParams:
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   649
            try:
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   650
                xmlfile = open(self.ConfNodeXmlFilePath(CTNName), 'r')
1330
96b242e4c59d Added support for loading XML file even if not following XSD schema (but still following XML syntax), warning user of errors in XML file
Laurent Bessard
parents: 1315
diff changeset
   651
                obj, error = self.Parser.LoadXMLString(xmlfile.read())
96b242e4c59d Added support for loading XML file even if not following XSD schema (but still following XML syntax), warning user of errors in XML file
Laurent Bessard
parents: 1315
diff changeset
   652
                if error is not None:
1581
2295fdc5c271 fix translation strings with multiple parameters
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
   653
                    (fname, lnum, src) = ((ConfNodeName,) + error)
1744
69dfdb26f600 clean-up: fix PEP8 E251 unexpected spaces around keyword / parameter equals
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1742
diff changeset
   654
                    self.GetCTRoot().logger.write_warning(XSDSchemaErrorMessage.format(a1=fname, a2=lnum, a3=src))
1315
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
   655
                name = obj.getLocalTag()
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
   656
                setattr(self, name, obj)
ff14a66bbd12 Fixed Beremiz for working with new xmlclass support using lxml
Laurent Bessard
parents: 1179
diff changeset
   657
                self.CTNParams = (name, obj)
106
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   658
                xmlfile.close()
2418
5587c490a070 Use python 3 compatible exception syntax everywhere
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2414
diff changeset
   659
            except Exception as exc:
2434
07f48018b6f5 python3 support: pylint, W1612 # (unicode-builtin) unicode built-in referenced
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2418
diff changeset
   660
                msg = _("Couldn't load confnode parameters {a1} :\n {a2}").format(a1=ConfNodeName, a2=text(exc))
1581
2295fdc5c271 fix translation strings with multiple parameters
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
   661
                self.GetCTRoot().logger.write_error(msg)
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   662
                self.GetCTRoot().logger.write_error(traceback.format_exc())
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1722
diff changeset
   663
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   664
    def LoadChildren(self):
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   665
        # Iterate over all CTNName@CTNType in confnode directory, and try to open them
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   666
        for CTNDir in os.listdir(self.CTNPath()):
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   667
            if os.path.isdir(os.path.join(self.CTNPath(), CTNDir)) and \
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   668
               CTNDir.count(NameTypeSeparator) == 1:
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   669
                pname, ptype = CTNDir.split(NameTypeSeparator)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   670
                try:
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   671
                    self.CTNAddChild(pname, ptype)
2418
5587c490a070 Use python 3 compatible exception syntax everywhere
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2414
diff changeset
   672
                except Exception as exc:
2434
07f48018b6f5 python3 support: pylint, W1612 # (unicode-builtin) unicode built-in referenced
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2418
diff changeset
   673
                    msg = _("Could not add child \"{a1}\", type {a2} :\n{a3}\n").format(a1=pname, a2=ptype, a3=text(exc))
1581
2295fdc5c271 fix translation strings with multiple parameters
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
   674
                    self.GetCTRoot().logger.write_error(msg)
718
5d4dc150b956 refactoring
Edouard Tisserant
parents: 717
diff changeset
   675
                    self.GetCTRoot().logger.write_error(traceback.format_exc())