plugger.py
author etisserant
Tue, 23 Dec 2008 19:31:28 +0100
changeset 279 47d29c4b55a3
parent 275 ff7c8eb3f362
child 280 f2ef79f3dba0
permissions -rw-r--r--
Fixed minimize/maximize invertion
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
     1
"""
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
     2
Base definitions for beremiz plugins
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
     3
"""
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
     4
178
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 176
diff changeset
     5
import os,sys,traceback
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
     6
import plugins
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
     7
import types
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
     8
import shutil
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
     9
from xml.dom import minidom
22
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
    10
import wx
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
    11
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
    12
#Quick hack to be able to find Beremiz IEC tools. Should be config params.
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
    13
base_folder = os.path.split(sys.path[0])[0]
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
    14
sys.path.append(os.path.join(base_folder, "plcopeneditor"))
126
034979cb02b0 add use of docutils for pdf
greg
parents: 125
diff changeset
    15
sys.path.append(os.path.join(base_folder, "docutils"))
034979cb02b0 add use of docutils for pdf
greg
parents: 125
diff changeset
    16
034979cb02b0 add use of docutils for pdf
greg
parents: 125
diff changeset
    17
from docpdf import *
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    18
from xmlclass import GenerateClassesFromXSDstring
110
a05e8b30c024 Fixed way apps are launched in parralel with single log window... Tested in win32 only.
etisserant
parents: 109
diff changeset
    19
from wxPopen import ProcessLogger
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    20
274
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
    21
from PLCControler import PLCControler
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
    22
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    23
_BaseParamsClass = GenerateClassesFromXSDstring("""<?xml version="1.0" encoding="ISO-8859-1" ?>
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    24
        <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    25
          <xsd:element name="BaseParams">
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    26
            <xsd:complexType>
86
f0a9d74e3b26 Adding support for the new version of xmlclass
lbessard
parents: 82
diff changeset
    27
              <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
    28
              <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
    29
              <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
    30
            </xsd:complexType>
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    31
          </xsd:element>
86
f0a9d74e3b26 Adding support for the new version of xmlclass
lbessard
parents: 82
diff changeset
    32
        </xsd:schema>""")["BaseParams"]
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    33
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    34
NameTypeSeparator = '@'
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    35
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    36
class MiniTextControler:
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    37
    
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    38
    def __init__(self, filepath):
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    39
        self.FilePath = filepath
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    40
        
74
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
    41
    def SetEditedElementText(self, tagname, text):
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    42
        file = open(self.FilePath, "w")
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    43
        file.write(text)
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    44
        file.close()
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    45
        
273
d15a20eb2b8b Bug with debug mode when displaying code fixed
greg
parents: 256
diff changeset
    46
    def GetEditedElementText(self, tagname, debug = False):
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    47
        if os.path.isfile(self.FilePath):
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    48
            file = open(self.FilePath, "r")
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    49
            text = file.read()
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    50
            file.close()
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    51
            return text
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    52
        return ""
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    53
    
273
d15a20eb2b8b Bug with debug mode when displaying code fixed
greg
parents: 256
diff changeset
    54
    def GetEditedElementInterfaceVars(self, tagname, debug = False):
74
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
    55
        return []
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
    56
    
273
d15a20eb2b8b Bug with debug mode when displaying code fixed
greg
parents: 256
diff changeset
    57
    def GetEditedElementType(self, tagname, debug = False):
74
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
    58
        return "program"
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
    59
    
273
d15a20eb2b8b Bug with debug mode when displaying code fixed
greg
parents: 256
diff changeset
    60
    def GetBlockTypes(self, tagname = "", debug = False):
74
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
    61
        return []
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
    62
    
273
d15a20eb2b8b Bug with debug mode when displaying code fixed
greg
parents: 256
diff changeset
    63
    def GetEnumeratedDataValues(self, debug = False):
74
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
    64
        return []
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
    65
    
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    66
    def StartBuffering(self):
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    67
        pass
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    68
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    69
    def EndBuffering(self):
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    70
        pass
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    71
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    72
    def BufferProject(self):
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    73
        pass
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
    74
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
    75
# helper func to get path to images
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
    76
def opjimg(imgname):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
    77
    return os.path.join("images",imgname)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
    78
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    79
class PlugTemplate:
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    80
    """
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    81
    This class is the one that define plugins.
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    82
    """
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    83
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    84
    XSD = None
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    85
    PlugChildsTypes = []
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    86
    PlugMaxCount = None
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    87
    PluginMethods = []
274
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
    88
    LibraryControler = None
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    89
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
    90
    def _AddParamsMembers(self):
19
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
    91
        self.PlugParams = None
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
    92
        if self.XSD:
86
f0a9d74e3b26 Adding support for the new version of xmlclass
lbessard
parents: 82
diff changeset
    93
            Classes = GenerateClassesFromXSDstring(self.XSD)
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
    94
            Classes = [(name, XSDclass) for name, XSDclass in Classes.items() if XSDclass.IsBaseClass]
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
    95
            if len(Classes) == 1:
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
    96
                name, XSDclass = Classes[0]
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
    97
                obj = XSDclass()
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
    98
                self.PlugParams = (name, obj)
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
    99
                setattr(self, name, obj)
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   100
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   101
    def __init__(self):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   102
        # Create BaseParam 
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   103
        self.BaseParams = _BaseParamsClass()
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   104
        self.MandatoryParams = ("BaseParams", self.BaseParams)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   105
        self._AddParamsMembers()
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   106
        self.PluggedChilds = {}
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
   107
        # copy PluginMethods so that it can be later customized
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   108
        self.PluginMethods = [dic.copy() for dic in self.PluginMethods]
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   109
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   110
    def PluginBaseXmlFilePath(self, PlugName=None):
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   111
        return os.path.join(self.PlugPath(PlugName), "baseplugin.xml")
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   112
    
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   113
    def PluginXmlFilePath(self, PlugName=None):
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   114
        return os.path.join(self.PlugPath(PlugName), "plugin.xml")
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   115
274
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   116
    def PluginLibraryFilePath(self, PlugName=None):
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   117
        return os.path.join(os.path.join(os.path.split(__file__)[0], "plugins", self.PlugType, "pous.xml"))
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   118
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   119
    def PlugPath(self,PlugName=None):
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   120
        if not PlugName:
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   121
            PlugName = self.BaseParams.getName()
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   122
        return os.path.join(self.PlugParent.PlugPath(),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   123
                            PlugName + NameTypeSeparator + self.PlugType)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   124
    
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   125
    def PlugTestModified(self):
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   126
        return self.ChangesToSave
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   127
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   128
    def ProjectTestModified(self):
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   129
        """
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   130
        recursively check modified status
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   131
        """
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   132
        if self.PlugTestModified():
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   133
            return True
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   134
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   135
        for PlugChild in self.IterChilds():
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   136
            if PlugChild.ProjectTestModified():
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   137
                return True
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   138
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   139
        return False
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   140
        
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   141
    def OnPlugSave(self):
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   142
        #Default, do nothing and return success
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   143
        return True
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   144
19
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   145
    def GetParamsAttributes(self, path = None):
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   146
        if path:
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   147
            parts = path.split(".", 1)
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   148
            if self.MandatoryParams and parts[0] == self.MandatoryParams[0]:
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   149
                return self.MandatoryParams[1].getElementInfos(parts[0], parts[1])
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   150
            elif self.PlugParams and parts[0] == self.PlugParams[0]:
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   151
                return self.PlugParams[1].getElementInfos(parts[0], parts[1])
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   152
        else:
19
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   153
            params = []
82
d7b4dd1f543f Beremiz layout improved for wx2.8 by inserting all control in TreeCtrl
lbessard
parents: 81
diff changeset
   154
            if wx.VERSION < (2, 8, 0) and self.MandatoryParams:
19
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   155
                params.append(self.MandatoryParams[1].getElementInfos(self.MandatoryParams[0]))
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   156
            if self.PlugParams:
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   157
                params.append(self.PlugParams[1].getElementInfos(self.PlugParams[0]))
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   158
            return params
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   159
        
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   160
    def SetParamsAttribute(self, path, value):
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   161
        self.ChangesToSave = True
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   162
        # 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
   163
        if path == "BaseParams.IEC_Channel":
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   164
            return self.FindNewIEC_Channel(value), True
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   165
        elif path == "BaseParams.Name":
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   166
            res = self.FindNewName(value)
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   167
            self.PlugRequestSave()
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   168
            return res, True
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   169
        
19
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   170
        parts = path.split(".", 1)
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   171
        if self.MandatoryParams and parts[0] == self.MandatoryParams[0]:
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   172
            self.MandatoryParams[1].setElementValue(parts[1], value)
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   173
        elif self.PlugParams and parts[0] == self.PlugParams[0]:
73257cea38bd Adding Plugin params visualization with basic controls
lbessard
parents: 18
diff changeset
   174
            self.PlugParams[1].setElementValue(parts[1], value)
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   175
        return value, False
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   176
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   177
    def PlugRequestSave(self):
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   178
        # If plugin do not have corresponding directory
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   179
        plugpath = self.PlugPath()
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   180
        if not os.path.isdir(plugpath):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   181
            # Create it
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   182
            os.mkdir(plugpath)
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   183
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   184
        # generate XML for base XML parameters controller of the plugin
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   185
        if self.MandatoryParams:
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   186
            BaseXMLFile = open(self.PluginBaseXmlFilePath(),'w')
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   187
            BaseXMLFile.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   188
            BaseXMLFile.write(self.MandatoryParams[1].generateXMLText(self.MandatoryParams[0], 0))
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   189
            BaseXMLFile.close()
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   190
        
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   191
        # generate XML for XML parameters controller of the plugin
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   192
        if self.PlugParams:
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   193
            XMLFile = open(self.PluginXmlFilePath(),'w')
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   194
            XMLFile.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   195
            XMLFile.write(self.PlugParams[1].generateXMLText(self.PlugParams[0], 0))
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   196
            XMLFile.close()
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   197
        
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   198
        # Call the plugin specific OnPlugSave method
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   199
        result = self.OnPlugSave()
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   200
        if not result:
250
01963beca027 Bug with return value of nodelist saving fixed
lbessard
parents: 248
diff changeset
   201
            return "Error while saving \"%s\"\n"%self.PlugPath()
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   202
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   203
        # mark plugin as saved
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   204
        self.ChangesToSave = False        
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   205
        # go through all childs and do the same
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   206
        for PlugChild in self.IterChilds():
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   207
            result = PlugChild.PlugRequestSave()
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   208
            if result:
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   209
                return result
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   210
        return None
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   211
    
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   212
    def PlugImport(self, src_PlugPath):
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   213
        shutil.copytree(src_PlugPath, self.PlugPath)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   214
        return True
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   215
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   216
    def PlugGenerate_C(self, buildpath, locations):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   217
        """
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   218
        Generate C code
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   219
        @param locations: List of complete variables locations \
22
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   220
            [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   221
            "NAME" : name of the variable (generally "__IW0_1_2" style)
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   222
            "DIR" : direction "Q","I" or "M"
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   223
            "SIZE" : size "X", "B", "W", "D", "L"
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   224
            "LOC" : tuple of interger for IEC location (0,1,2,...)
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   225
            }, ...]
18
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
   226
        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
   227
        """
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   228
        self.logger.write_warning(".".join(map(lambda x:str(x), self.GetCurrentLocation())) + " -> Nothing to do\n")
51
c31c55601556 Added project linking, and plugin init,cleanup,retrive and publish method calls in main
etisserant
parents: 49
diff changeset
   229
        return [],"",False
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   230
    
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   231
    def _Generate_C(self, buildpath, locations):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   232
        # Generate plugins [(Cfiles, CFLAGS)], LDFLAGS, DoCalls, extra_files
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   233
        # extra_files = [(fname,fobject), ...]
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   234
        gen_result = self.PlugGenerate_C(buildpath, locations)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   235
        PlugCFilesAndCFLAGS, PlugLDFLAGS, DoCalls = gen_result[:3]
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   236
        extra_files = gen_result[3:]
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   237
        # if some files heve been generated put them in the list with their location
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   238
        if PlugCFilesAndCFLAGS:
51
c31c55601556 Added project linking, and plugin init,cleanup,retrive and publish method calls in main
etisserant
parents: 49
diff changeset
   239
            LocationCFilesAndCFLAGS = [(self.GetCurrentLocation(), PlugCFilesAndCFLAGS, DoCalls)]
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   240
        else:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   241
            LocationCFilesAndCFLAGS = []
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   242
115
9ffdac9cf609 Fixed empty build exception.
etisserant
parents: 114
diff changeset
   243
        # plugin asks for some LDFLAGS
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   244
        if PlugLDFLAGS:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   245
            # LDFLAGS can be either string
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   246
            if type(PlugLDFLAGS)==type(str()):
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   247
                LDFLAGS=[PlugLDFLAGS]
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   248
            #or list of strings
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   249
            elif type(PlugLDFLAGS)==type(list()):
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   250
                LDFLAGS=PlugLDFLAGS[:]
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   251
        else:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   252
            LDFLAGS=[]
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   253
        
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   254
        # recurse through all childs, and stack their results
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   255
        for PlugChild in self.IECSortedChilds():
24
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
   256
            new_location = PlugChild.GetCurrentLocation()
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
   257
            # How deep are we in the tree ?
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
   258
            depth=len(new_location)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   259
            _LocationCFilesAndCFLAGS, _LDFLAGS, _extra_files = \
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   260
                PlugChild._Generate_C(
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   261
                    #keep the same path
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   262
                    buildpath,
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   263
                    # filter locations that start with current IEC location
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   264
                    [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
   265
            # stack the result
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   266
            LocationCFilesAndCFLAGS += _LocationCFilesAndCFLAGS
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   267
            LDFLAGS += _LDFLAGS
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   268
            extra_files += _extra_files
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   269
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   270
        return LocationCFilesAndCFLAGS, LDFLAGS, extra_files
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   271
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   272
    def BlockTypesFactory(self):
274
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   273
        if self.LibraryControler is not None:
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   274
            return [{"name" : "%s POUs" % self.PlugType, "list": self.LibraryControler.Project.GetCustomBlockTypes()}]
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   275
        return []
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   276
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   277
    def STLibraryFactory(self):
274
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   278
        if self.LibraryControler is not None:
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   279
            return self.LibraryControler.GenerateProgram()
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   280
        return ""
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   281
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   282
    def IterChilds(self):
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   283
        for PlugType, PluggedChilds in self.PluggedChilds.items():
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   284
            for PlugInstance in PluggedChilds:
250
01963beca027 Bug with return value of nodelist saving fixed
lbessard
parents: 248
diff changeset
   285
                yield PlugInstance
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   286
    
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   287
    def IECSortedChilds(self):
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   288
        # reorder childs by IEC_channels
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   289
        ordered = [(chld.BaseParams.getIEC_Channel(),chld) for chld in self.IterChilds()]
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   290
        if ordered:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   291
            ordered.sort()
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   292
            return zip(*ordered)[1]
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   293
        else:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   294
            return []
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   295
    
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   296
    def _GetChildBySomething(self, something, toks):
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   297
        for PlugInstance in self.IterChilds():
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   298
            # if match component of the name
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   299
            if getattr(PlugInstance.BaseParams, something) == toks[0]:
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   300
                # if Name have other components
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   301
                if len(toks) >= 2:
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   302
                    # Recurse in order to find the latest object
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   303
                    return PlugInstance._GetChildBySomething( something, toks[1:])
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   304
                # No sub name -> found
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   305
                return PlugInstance
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   306
        # Not found
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   307
        return None
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   308
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   309
    def GetChildByName(self, Name):
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   310
        if Name:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   311
            toks = Name.split('.')
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   312
            return self._GetChildBySomething("Name", toks)
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   313
        else:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   314
            return self
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   315
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   316
    def GetChildByIECLocation(self, Location):
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   317
        if Location:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   318
            return self._GetChildBySomething("IEC_Channel", Location)
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   319
        else:
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   320
            return self
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   321
    
23
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   322
    def GetCurrentLocation(self):
24
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
   323
        """
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
   324
        @return:  Tupple containing plugin IEC location of current plugin : %I0.0.4.5 => (0,0,4,5)
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
   325
        """
23
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   326
        return self.PlugParent.GetCurrentLocation() + (self.BaseParams.getIEC_Channel(),)
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   327
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   328
    def GetCurrentName(self):
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   329
        """
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   330
        @return:  String "ParentParentName.ParentName.Name"
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   331
        """
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   332
        return  self.PlugParent._GetCurrentName() + self.BaseParams.getName()
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   333
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   334
    def _GetCurrentName(self):
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   335
        """
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   336
        @return:  String "ParentParentName.ParentName.Name."
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   337
        """
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   338
        return  self.PlugParent._GetCurrentName() + self.BaseParams.getName() + "."
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   339
23
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   340
    def GetPlugRoot(self):
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   341
        return self.PlugParent.GetPlugRoot()
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   342
97
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   343
    def GetFullIEC_Channel(self):
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   344
        return ".".join([str(i) for i in self.GetCurrentLocation()]) + ".x"
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   345
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   346
    def GetLocations(self):
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   347
        location = self.GetCurrentLocation()
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   348
        return [loc for loc in self.PlugParent.GetLocations() if loc["LOC"][0:len(location)] == location]
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   349
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   350
    def GetPlugInfos(self):
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   351
        childs = []
33
59b84ab7bf8b Enhanced bahavior of plugin tree representation when changing IEC channel
etisserant
parents: 29
diff changeset
   352
        # reorder childs by IEC_channels
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   353
        for child in self.IECSortedChilds():
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   354
            childs.append(child.GetPlugInfos())
82
d7b4dd1f543f Beremiz layout improved for wx2.8 by inserting all control in TreeCtrl
lbessard
parents: 81
diff changeset
   355
        if wx.VERSION < (2, 8, 0):
d7b4dd1f543f Beremiz layout improved for wx2.8 by inserting all control in TreeCtrl
lbessard
parents: 81
diff changeset
   356
            return {"name" : "%d-%s"%(self.BaseParams.getIEC_Channel(),self.BaseParams.getName()), "type" : self.BaseParams.getName(), "values" : childs}
d7b4dd1f543f Beremiz layout improved for wx2.8 by inserting all control in TreeCtrl
lbessard
parents: 81
diff changeset
   357
        else:
d7b4dd1f543f Beremiz layout improved for wx2.8 by inserting all control in TreeCtrl
lbessard
parents: 81
diff changeset
   358
            return {"name" : self.BaseParams.getName(), "channel" : self.BaseParams.getIEC_Channel(), "enabled" : self.BaseParams.getEnabled(), "parent" : len(self.PlugChildsTypes) > 0, "type" : self.BaseParams.getName(), "values" : childs}
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   359
    
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   360
    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
   361
        """
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   362
        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
   363
        @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
   364
        """
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   365
        # Get Current Name
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   366
        CurrentName = self.BaseParams.getName()
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   367
        # Do nothing if no change
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   368
        #if CurrentName == DesiredName: return CurrentName
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   369
        # Build a list of used Name out of parent's PluggedChilds
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   370
        AllNames=[]
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   371
        for PlugInstance in self.PlugParent.IterChilds():
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   372
            if PlugInstance != self:
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   373
                AllNames.append(PlugInstance.BaseParams.getName())
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   374
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   375
        # 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
   376
        res = DesiredName
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   377
        suffix = 1
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   378
        while res in AllNames:
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   379
            res = "%s-%d"%(DesiredName, suffix)
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   380
            suffix += 1
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   381
        
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   382
        # Get old path
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   383
        oldname = self.PlugPath()
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   384
        # Check previous plugin existance
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   385
        dontexist = self.BaseParams.getName() == "__unnamed__"
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   386
        # Set the new name
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   387
        self.BaseParams.setName(res)
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   388
        # Rename plugin dir if exist
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   389
        if not dontexist:
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   390
            shutil.move(oldname, self.PlugPath())
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   391
        # 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
   392
        if DesiredName != res:
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   393
            self.logger.write_warning("A child names \"%s\" already exist -> \"%s\"\n"%(DesiredName,res))
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   394
        return res
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   395
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   396
    def FindNewIEC_Channel(self, DesiredChannel):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   397
        """
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   398
        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
   399
        @param DesiredChannel: The desired IEC channel (int)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   400
        """
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   401
        # Get Current IEC channel
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   402
        CurrentChannel = self.BaseParams.getIEC_Channel()
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   403
        # Do nothing if no change
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   404
        #if CurrentChannel == DesiredChannel: return CurrentChannel
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   405
        # Build a list of used Channels out of parent's PluggedChilds
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   406
        AllChannels=[]
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   407
        for PlugInstance in self.PlugParent.IterChilds():
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   408
            if PlugInstance != self:
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   409
                AllChannels.append(PlugInstance.BaseParams.getIEC_Channel())
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   410
        AllChannels.sort()
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   411
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   412
        # Now, try to guess the nearest available channel
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   413
        res = DesiredChannel
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   414
        while res in AllChannels: # While channel not free
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   415
            if res < CurrentChannel: # Want to go down ?
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   416
                res -=  1 # Test for n-1
33
59b84ab7bf8b Enhanced bahavior of plugin tree representation when changing IEC channel
etisserant
parents: 29
diff changeset
   417
                if res < 0 :
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   418
                    self.logger.write_warning("Cannot find lower free IEC channel than %d\n"%CurrentChannel)
33
59b84ab7bf8b Enhanced bahavior of plugin tree representation when changing IEC channel
etisserant
parents: 29
diff changeset
   419
                    return CurrentChannel # Can't go bellow 0, do nothing
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   420
            else : # Want to go up ?
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   421
                res +=  1 # Test for n-1
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   422
        # Finally set IEC Channel
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   423
        self.BaseParams.setIEC_Channel(res)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   424
        if DesiredChannel != res:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   425
            self.logger.write_warning("A child with IEC channel %d already exist -> %d\n"%(DesiredChannel,res))
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   426
        return res
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   427
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   428
    def OnPlugClose(self):
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   429
        return True
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   430
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   431
    def _doRemoveChild(self, PlugInstance):
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   432
        # Remove all childs of child
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   433
        for SubPlugInstance in PlugInstance.IterChilds():
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   434
            PlugInstance._doRemoveChild(SubPlugInstance)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   435
        # Call the OnCloseMethod
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   436
        PlugInstance.OnPlugClose()
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   437
        # Delete plugin dir
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   438
        shutil.rmtree(PlugInstance.PlugPath())
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   439
        # Remove child of PluggedChilds
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   440
        self.PluggedChilds[PlugInstance.PlugType].remove(PlugInstance)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   441
        # Forget it... (View have to refresh)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   442
51
c31c55601556 Added project linking, and plugin init,cleanup,retrive and publish method calls in main
etisserant
parents: 49
diff changeset
   443
    def PlugRemove(self):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   444
        # Fetch the plugin
51
c31c55601556 Added project linking, and plugin init,cleanup,retrive and publish method calls in main
etisserant
parents: 49
diff changeset
   445
        #PlugInstance = self.GetChildByName(PlugName)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   446
        # Ask to his parent to remove it
51
c31c55601556 Added project linking, and plugin init,cleanup,retrive and publish method calls in main
etisserant
parents: 49
diff changeset
   447
        self.PlugParent._doRemoveChild(self)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   448
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   449
    def PlugAddChild(self, PlugName, PlugType):
14
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
        Create the plugins that may be added as child to this node self
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   452
        @param PlugType: string desining the plugin class name (get name from PlugChildsTypes)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   453
        @param PlugName: string for the name of the plugin instance
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   454
        """
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
   455
        # reorgabize self.PlugChildsTypes tuples from (name, PlugClass, Help)
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   456
        # to ( name, (PlugClass, Help)), an make a dict
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   457
        transpose = zip(*self.PlugChildsTypes)
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   458
        PlugChildsTypes = dict(zip(transpose[0],zip(transpose[1],transpose[2])))
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   459
        # Check that adding this plugin is allowed
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   460
        try:
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
   461
            PlugClass, PlugHelp = PlugChildsTypes[PlugType]
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   462
        except KeyError:
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   463
            raise Exception, "Cannot create child %s of type %s "%(PlugName, PlugType)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   464
        
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   465
        # if PlugClass is a class factory, call it. (prevent unneeded imports)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   466
        if type(PlugClass) == types.FunctionType:
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   467
            PlugClass = PlugClass()
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   468
        
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   469
        # Eventualy Initialize child instance list for this class of plugin
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   470
        PluggedChildsWithSameClass = self.PluggedChilds.setdefault(PlugType, list())
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   471
        # Check count
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   472
        if getattr(PlugClass, "PlugMaxCount", None) and len(PluggedChildsWithSameClass) >= PlugClass.PlugMaxCount:
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   473
            raise Exception, "Max count (%d) reached for this plugin of type %s "%(PlugClass.PlugMaxCount, PlugType)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   474
        
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   475
        # create the final class, derived of provided plugin and template
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   476
        class FinalPlugClass(PlugClass, PlugTemplate):
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   477
            """
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   478
            Plugin class is derivated into FinalPlugClass before being instanciated
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   479
            This way __init__ is overloaded to ensure PlugTemplate.__init__ is called 
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   480
            before PlugClass.__init__, and to do the file related stuff.
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   481
            """
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   482
            def __init__(_self):
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   483
                # self is the parent
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   484
                _self.PlugParent = self
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   485
                # self is the parent
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   486
                _self.logger = self.logger
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   487
                # Keep track of the plugin type name
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   488
                _self.PlugType = PlugType
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
   489
                # remind the help string, for more fancy display
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   490
                _self.PlugHelp = PlugHelp
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   491
                # Call the base plugin template init - change XSD into class members
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   492
                PlugTemplate.__init__(_self)
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   493
                # check name is unique
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   494
                NewPlugName = _self.FindNewName(PlugName)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   495
                # If dir have already be made, and file exist
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   496
                if os.path.isdir(_self.PlugPath(NewPlugName)): #and os.path.isfile(_self.PluginXmlFilePath(PlugName)):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   497
                    #Load the plugin.xml file into parameters members
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   498
                    _self.LoadXMLParams(NewPlugName)
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   499
                    # Basic check. Better to fail immediately.
29
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   500
                    if (_self.BaseParams.getName() != NewPlugName):
282380dea497 Major improvements, plugin renaming and secured name/IEC channel attribution, various fixes on PlugTemplate
etisserant
parents: 25
diff changeset
   501
                        raise Exception, "Project tree layout do not match plugin.xml %s!=%s "%(NewPlugName, _self.BaseParams.getName())
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   502
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   503
                    # Now, self.PlugPath() should be OK
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   504
                    
15
7a473efc4530 More precise design for plugins.... to be continued...
etisserant
parents: 14
diff changeset
   505
                    # Check that IEC_Channel is not already in use.
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   506
                    _self.FindNewIEC_Channel(_self.BaseParams.getIEC_Channel())
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   507
                    # Call the plugin real __init__
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   508
                    if getattr(PlugClass, "__init__", None):
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   509
                        PlugClass.__init__(_self)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   510
                    #Load and init all the childs
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   511
                    _self.LoadChilds()
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   512
                    #just loaded, nothing to saved
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   513
                    _self.ChangesToSave = False
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   514
                else:
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   515
                    # If plugin do not have corresponding file/dirs - they will be created on Save
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   516
                    os.mkdir(_self.PlugPath())
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   517
                    # Find an IEC number
253
b1a9d37bb84c fixed : findiecchannel call
greg
parents: 250
diff changeset
   518
                    _self.FindNewIEC_Channel(0)
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   519
                    # Call the plugin real __init__
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   520
                    if getattr(PlugClass, "__init__", None):
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   521
                        PlugClass.__init__(_self)
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   522
                    _self.PlugRequestSave()
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   523
                    #just created, must be saved
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   524
                    _self.ChangesToSave = True
77
7de69369373e Adding file with generated master in build folder and a button for editing it with objdictedit
lbessard
parents: 75
diff changeset
   525
            
7de69369373e Adding file with generated master in build folder and a button for editing it with objdictedit
lbessard
parents: 75
diff changeset
   526
            def _getBuildPath(_self):
7de69369373e Adding file with generated master in build folder and a button for editing it with objdictedit
lbessard
parents: 75
diff changeset
   527
                return self._getBuildPath()
7de69369373e Adding file with generated master in build folder and a button for editing it with objdictedit
lbessard
parents: 75
diff changeset
   528
            
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   529
        # Create the object out of the resulting class
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   530
        newPluginOpj = FinalPlugClass()
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   531
        # Store it in PluggedChils
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   532
        PluggedChildsWithSameClass.append(newPluginOpj)
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   533
        
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   534
        return newPluginOpj
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   535
            
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   536
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   537
    def LoadXMLParams(self, PlugName = None):
105
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
   538
        methode_name = os.path.join(self.PlugPath(PlugName), "methods.py")
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
   539
        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
   540
            execfile(methode_name)
274
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   541
        
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   542
        # Get library blocks if plcopen library exist
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   543
        library_path = self.PluginLibraryFilePath(PlugName)
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   544
        if os.path.isfile(library_path):
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   545
            self.LibraryControler = PLCControler()
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   546
            self.LibraryControler.OpenXMLFile(library_path)
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   547
        
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   548
        # Get the base xml tree
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   549
        if self.MandatoryParams:
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   550
            try:
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
   551
                basexmlfile = open(self.PluginBaseXmlFilePath(PlugName), 'r')
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   552
                basetree = minidom.parse(basexmlfile)
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   553
                self.MandatoryParams[1].loadXMLTree(basetree.childNodes[0])
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   554
                basexmlfile.close()
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   555
            except Exception, exc:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   556
                self.logger.write_error("Couldn't load plugin base parameters %s :\n %s" % (PlugName, str(exc)))
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   557
                self.logger.write_error(traceback.format_exc())
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   558
        
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   559
        # Get the xml tree
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   560
        if self.PlugParams:
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   561
            try:
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
   562
                xmlfile = open(self.PluginXmlFilePath(PlugName), 'r')
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   563
                tree = minidom.parse(xmlfile)
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   564
                self.PlugParams[1].loadXMLTree(tree.childNodes[0])
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   565
                xmlfile.close()
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   566
            except Exception, exc:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   567
                self.logger.write_error("Couldn't load plugin parameters %s :\n %s" % (PlugName, str(exc)))
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   568
                self.logger.write_error(traceback.format_exc())
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   569
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   570
    def LoadChilds(self):
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   571
        # Iterate over all PlugName@PlugType in plugin directory, and try to open them
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   572
        for PlugDir in os.listdir(self.PlugPath()):
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   573
            if os.path.isdir(os.path.join(self.PlugPath(), PlugDir)) and \
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   574
               PlugDir.count(NameTypeSeparator) == 1:
24
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
   575
                pname, ptype = PlugDir.split(NameTypeSeparator)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   576
                try:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   577
                    self.PlugAddChild(pname, ptype)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   578
                except Exception, exc:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   579
                    self.logger.write_error("Could not add child \"%s\", type %s :\n%s\n"%(pname, ptype, str(exc)))
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   580
                    self.logger.write_error(traceback.format_exc())
13
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   581
109
f27ca37b6e7a Added enable/disable of plugin method buttons. Fixed alpha graying problem with disabled buttons. Updated debug dialog message with bug report path
etisserant
parents: 108
diff changeset
   582
    def EnableMethod(self, method, value):
f27ca37b6e7a Added enable/disable of plugin method buttons. Fixed alpha graying problem with disabled buttons. Updated debug dialog message with bug report path
etisserant
parents: 108
diff changeset
   583
        for d in self.PluginMethods:
f27ca37b6e7a Added enable/disable of plugin method buttons. Fixed alpha graying problem with disabled buttons. Updated debug dialog message with bug report path
etisserant
parents: 108
diff changeset
   584
            if d["method"]==method:
f27ca37b6e7a Added enable/disable of plugin method buttons. Fixed alpha graying problem with disabled buttons. Updated debug dialog message with bug report path
etisserant
parents: 108
diff changeset
   585
                d["enabled"]=value
f27ca37b6e7a Added enable/disable of plugin method buttons. Fixed alpha graying problem with disabled buttons. Updated debug dialog message with bug report path
etisserant
parents: 108
diff changeset
   586
                return True
f27ca37b6e7a Added enable/disable of plugin method buttons. Fixed alpha graying problem with disabled buttons. Updated debug dialog message with bug report path
etisserant
parents: 108
diff changeset
   587
        return False
f27ca37b6e7a Added enable/disable of plugin method buttons. Fixed alpha graying problem with disabled buttons. Updated debug dialog message with bug report path
etisserant
parents: 108
diff changeset
   588
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   589
    def ShowMethod(self, method, value):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   590
        for d in self.PluginMethods:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   591
            if d["method"]==method:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   592
                d["shown"]=value
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   593
                return True
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   594
        return False
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   595
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   596
def _GetClassFunction(name):
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   597
    def GetRootClass():
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   598
        return getattr(__import__("plugins." + name), name).RootClass
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   599
    return GetRootClass
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   600
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   601
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   602
####################################################################################
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   603
####################################################################################
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   604
####################################################################################
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   605
###################################   ROOT    ######################################
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   606
####################################################################################
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   607
####################################################################################
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   608
####################################################################################
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   609
81
3a34b580f141 Windows related enhancements
etisserant
parents: 77
diff changeset
   610
if wx.Platform == '__WXMSW__':
75
9ad18a387a96 Windows related enhancements
etisserant
parents: 74
diff changeset
   611
    exe_ext=".exe"
9ad18a387a96 Windows related enhancements
etisserant
parents: 74
diff changeset
   612
else:
9ad18a387a96 Windows related enhancements
etisserant
parents: 74
diff changeset
   613
    exe_ext=""
9ad18a387a96 Windows related enhancements
etisserant
parents: 74
diff changeset
   614
9ad18a387a96 Windows related enhancements
etisserant
parents: 74
diff changeset
   615
iec2c_path = os.path.join(base_folder, "matiec", "iec2c"+exe_ext)
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   616
ieclib_path = os.path.join(base_folder, "matiec", "lib")
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   617
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   618
# import for project creation timestamping
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
   619
from threading import Timer, Lock, Thread, Semaphore
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   620
from time import localtime
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   621
from datetime import datetime
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   622
# import necessary stuff from PLCOpenEditor
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   623
from PLCOpenEditor import PLCOpenEditor, ProjectDialog
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   624
from TextViewer import TextViewer
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   625
from plcopen.structures import IEC_KEYWORDS, TypeHierarchy_list
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   626
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   627
# Construct debugger natively supported types
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   628
DebugTypes = [t for t in zip(*TypeHierarchy_list)[0] if not t.startswith("ANY")] + \
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   629
    ["STEP","TRANSITION","ACTION"]
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   630
22
9a0c535c3272 Pleliminary build process -- C code generation
etisserant
parents: 20
diff changeset
   631
import re
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   632
import targets
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   633
import connectors
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   634
from discovery import DiscoveryDialog
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
   635
from weakref import WeakKeyDictionary
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   636
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   637
class PluginsRoot(PlugTemplate, PLCControler):
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   638
    """
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   639
    This class define Root object of the plugin tree. 
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   640
    It is responsible of :
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   641
    - Managing project directory
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   642
    - Building project
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   643
    - Handling PLCOpenEditor controler and view
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   644
    - Loading user plugins and instanciante them as childs
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   645
    - ...
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   646
    
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   647
    """
13
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   648
14
eb9fdd316a40 More precise design for plugins.... to be continued...
etisserant
parents: 13
diff changeset
   649
    # For root object, available Childs Types are modules of the plugin packages.
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
   650
    PlugChildsTypes = [(name, _GetClassFunction(name), help) for name, help in zip(plugins.__all__,plugins.helps)]
13
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   651
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   652
    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   653
    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   654
      <xsd:element name="BeremizRoot">
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   655
        <xsd:complexType>
86
f0a9d74e3b26 Adding support for the new version of xmlclass
lbessard
parents: 82
diff changeset
   656
          <xsd:sequence>
f0a9d74e3b26 Adding support for the new version of xmlclass
lbessard
parents: 82
diff changeset
   657
            <xsd:element name="TargetType">
f0a9d74e3b26 Adding support for the new version of xmlclass
lbessard
parents: 82
diff changeset
   658
              <xsd:complexType>
f0a9d74e3b26 Adding support for the new version of xmlclass
lbessard
parents: 82
diff changeset
   659
                <xsd:choice>
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   660
                """+targets.targetchoices+"""
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
   661
                </xsd:choice>
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   662
              </xsd:complexType>
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   663
            </xsd:element>
86
f0a9d74e3b26 Adding support for the new version of xmlclass
lbessard
parents: 82
diff changeset
   664
          </xsd:sequence>
204
f572ab819769 remove URI_location from XSD targets and add to pluginroot XSD
greg
parents: 203
diff changeset
   665
          <xsd:attribute name="URI_location" type="xsd:string" use="optional" default=""/>
13
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   666
        </xsd:complexType>
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   667
      </xsd:element>
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   668
    </xsd:schema>
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   669
    """
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   670
227
48c13b84505c - Some improovements in debug data feedback data
etisserant
parents: 222
diff changeset
   671
    def __init__(self, frame, logger, runtime_port):
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   672
        PLCControler.__init__(self)
227
48c13b84505c - Some improovements in debug data feedback data
etisserant
parents: 222
diff changeset
   673
48c13b84505c - Some improovements in debug data feedback data
etisserant
parents: 222
diff changeset
   674
        self.runtime_port = runtime_port
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   675
        self.MandatoryParams = None
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   676
        self.AppFrame = frame
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   677
        self.logger = logger
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   678
        self._builder = None
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   679
        self._connector = None
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   680
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   681
        # Setup debug information
227
48c13b84505c - Some improovements in debug data feedback data
etisserant
parents: 222
diff changeset
   682
        self.IECdebug_datas = {}
48c13b84505c - Some improovements in debug data feedback data
etisserant
parents: 222
diff changeset
   683
        self.IECdebug_lock = Lock()
222
d0f7d36bf241 Added lock to avoid variable subsciption concurrent to transmission to PLC
etisserant
parents: 217
diff changeset
   684
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
   685
        self.DebugTimer=None
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   686
        self.ResetIECProgramsAndVariables()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   687
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   688
        #This method are not called here... but in NewProject and OpenProject
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   689
        #self._AddParamsMembers()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   690
        #self.PluggedChilds = {}
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   691
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   692
        # In both new or load scenario, no need to save
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   693
        self.ChangesToSave = False        
23
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   694
        # root have no parent
13
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   695
        self.PlugParent = None
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   696
        # Keep track of the plugin type name
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   697
        self.PlugType = "Beremiz"
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   698
        # After __init__ root plugin is not valid
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   699
        self.ProjectPath = None
256
1da137b99948 add buildpath parameter for beremiz
greg
parents: 253
diff changeset
   700
        self.BuildPath = None
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   701
        self.PLCEditor = None
243
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
   702
        self.PLCDebug = None
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
   703
        # copy PluginMethods so that it can be later customized
9810689febb0 Added plugins creation helpstrings, changed GUI layout (more compact), solved staticbitmap issues on win32, re-designed some icons...
etisserant
parents: 105
diff changeset
   704
        self.PluginMethods = [dic.copy() for dic in self.PluginMethods]
110
a05e8b30c024 Fixed way apps are launched in parralel with single log window... Tested in win32 only.
etisserant
parents: 109
diff changeset
   705
274
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   706
    def PluginLibraryFilePath(self, PlugName=None):
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   707
        return os.path.join(os.path.join(os.path.split(__file__)[0], "pous.xml"))
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   708
118
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   709
    def PlugTestModified(self):
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   710
         return self.ChangesToSave or not self.ProjectIsSaved()
185d0d371ea4 Refuse close if PLC running.
etisserant
parents: 115
diff changeset
   711
23
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   712
    def GetPlugRoot(self):
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   713
        return self
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   714
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   715
    def GetCurrentLocation(self):
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   716
        return ()
47
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   717
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   718
    def GetCurrentName(self):
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   719
        return ""
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   720
    
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   721
    def _GetCurrentName(self):
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   722
        return ""
fd45c291fed0 PLC and plugins compilation with gcc now starts (and fail).
etisserant
parents: 41
diff changeset
   723
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   724
    def GetProjectPath(self):
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   725
        return self.ProjectPath
51
c31c55601556 Added project linking, and plugin init,cleanup,retrive and publish method calls in main
etisserant
parents: 49
diff changeset
   726
c31c55601556 Added project linking, and plugin init,cleanup,retrive and publish method calls in main
etisserant
parents: 49
diff changeset
   727
    def GetProjectName(self):
c31c55601556 Added project linking, and plugin init,cleanup,retrive and publish method calls in main
etisserant
parents: 49
diff changeset
   728
        return os.path.split(self.ProjectPath)[1]
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   729
    
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   730
    def GetPlugInfos(self):
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   731
        childs = []
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   732
        for child in self.IterChilds():
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   733
            childs.append(child.GetPlugInfos())
51
c31c55601556 Added project linking, and plugin init,cleanup,retrive and publish method calls in main
etisserant
parents: 49
diff changeset
   734
        return {"name" : "PLC (%s)"%self.GetProjectName(), "type" : None, "values" : childs}
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   735
    
256
1da137b99948 add buildpath parameter for beremiz
greg
parents: 253
diff changeset
   736
    def NewProject(self, ProjectPath, BuildPath=None):
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   737
        """
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   738
        Create a new project in an empty folder
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   739
        @param ProjectPath: path of the folder where project have to be created
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   740
        @param PLCParams: properties of the PLCOpen program created
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   741
        """
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   742
        # Verify that choosen folder is empty
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   743
        if not os.path.isdir(ProjectPath) or len(os.listdir(ProjectPath)) > 0:
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   744
            return "Folder choosen isn't empty. You can't use it for a new project!"
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   745
        
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   746
        dialog = ProjectDialog(self.AppFrame)
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   747
        if dialog.ShowModal() == wx.ID_OK:
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   748
            values = dialog.GetValues()
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   749
            values["creationDateTime"] = datetime(*localtime()[:6])
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   750
            dialog.Destroy()
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   751
        else:
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   752
            dialog.Destroy()
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   753
            return "Project not created"
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   754
        
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   755
        # Create PLCOpen program
113
78a92a18f8d6 Fixed new project creation bug
etisserant
parents: 110
diff changeset
   756
        self.CreateNewProject(values)
13
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   757
        # Change XSD into class members
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   758
        self._AddParamsMembers()
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   759
        self.PluggedChilds = {}
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   760
        # Keep track of the root plugin (i.e. project path)
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   761
        self.ProjectPath = ProjectPath
256
1da137b99948 add buildpath parameter for beremiz
greg
parents: 253
diff changeset
   762
        self.BuildPath = BuildPath
114
2e3d8d4480e7 Now .xml files are automatically created when creating a new project no need to save explicitely.
etisserant
parents: 113
diff changeset
   763
        # get plugins bloclist (is that usefull at project creation?)
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   764
        self.RefreshPluginsBlockLists()
114
2e3d8d4480e7 Now .xml files are automatically created when creating a new project no need to save explicitely.
etisserant
parents: 113
diff changeset
   765
        # this will create files base XML files
2e3d8d4480e7 Now .xml files are automatically created when creating a new project no need to save explicitely.
etisserant
parents: 113
diff changeset
   766
        self.SaveProject()
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   767
        return None
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   768
        
256
1da137b99948 add buildpath parameter for beremiz
greg
parents: 253
diff changeset
   769
    def LoadProject(self, ProjectPath, BuildPath=None):
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   770
        """
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   771
        Load a project contained in a folder
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   772
        @param ProjectPath: path of the project folder
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   773
        """
190
be969d4694c7 Bug with folder path ending by '/' or '\' fixed
lbessard
parents: 178
diff changeset
   774
        if os.path.basename(ProjectPath) == "":
be969d4694c7 Bug with folder path ending by '/' or '\' fixed
lbessard
parents: 178
diff changeset
   775
            ProjectPath = os.path.dirname(ProjectPath)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   776
		# Verify that project contains a PLCOpen program
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   777
        plc_file = os.path.join(ProjectPath, "plc.xml")
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   778
        if not os.path.isfile(plc_file):
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   779
            return "Folder choosen doesn't contain a program. It's not a valid project!"
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   780
        # Load PLCOpen file
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   781
        result = self.OpenXMLFile(plc_file)
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   782
        if result:
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   783
            return result
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   784
        # Change XSD into class members
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   785
        self._AddParamsMembers()
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   786
        self.PluggedChilds = {}
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   787
        # Keep track of the root plugin (i.e. project path)
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   788
        self.ProjectPath = ProjectPath
256
1da137b99948 add buildpath parameter for beremiz
greg
parents: 253
diff changeset
   789
        self.BuildPath = BuildPath
13
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   790
        # If dir have already be made, and file exist
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   791
        if os.path.isdir(self.PlugPath()) and os.path.isfile(self.PluginXmlFilePath()):
13
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   792
            #Load the plugin.xml file into parameters members
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   793
            result = self.LoadXMLParams()
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   794
            if result:
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   795
                return result
13
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   796
            #Load and init all the childs
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   797
            self.LoadChilds()
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   798
        self.RefreshPluginsBlockLists()
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   799
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   800
        if os.path.exists(self._getBuildPath()):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   801
            self.EnableMethod("_Clean", True)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   802
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   803
        if os.path.isfile(self._getIECrawcodepath()):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   804
            self.ShowMethod("_showIECcode", True)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   805
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   806
        return None
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   807
    
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   808
    def SaveProject(self):
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   809
        if not self.SaveXMLFile():
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   810
            self.SaveXMLFile(os.path.join(self.ProjectPath, 'plc.xml'))
25
fa7503684c28 Adding support for using Networkedit et PLCOpenEditor in Beremiz
lbessard
parents: 24
diff changeset
   811
        if self.PLCEditor:
fa7503684c28 Adding support for using Networkedit et PLCOpenEditor in Beremiz
lbessard
parents: 24
diff changeset
   812
            self.PLCEditor.RefreshTitle()
250
01963beca027 Bug with return value of nodelist saving fixed
lbessard
parents: 248
diff changeset
   813
        result = self.PlugRequestSave()
01963beca027 Bug with return value of nodelist saving fixed
lbessard
parents: 248
diff changeset
   814
        if result:
01963beca027 Bug with return value of nodelist saving fixed
lbessard
parents: 248
diff changeset
   815
            self.logger.write_error(result)
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   816
    
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   817
    # Update PLCOpenEditor Plugin Block types from loaded plugins
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   818
    def RefreshPluginsBlockLists(self):
62
ddf0cdd71558 Adding support for refresh block list where beremiz loose focus
lbessard
parents: 57
diff changeset
   819
        if getattr(self, "PluggedChilds", None) is not None:
202
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
   820
            self.ClearPluginTypes()
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
   821
            self.AddPluginBlockList(self.BlockTypesFactory())
62
ddf0cdd71558 Adding support for refresh block list where beremiz loose focus
lbessard
parents: 57
diff changeset
   822
            for child in self.IterChilds():
202
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
   823
                self.AddPluginBlockList(child.BlockTypesFactory())
62
ddf0cdd71558 Adding support for refresh block list where beremiz loose focus
lbessard
parents: 57
diff changeset
   824
        if self.PLCEditor is not None:
ddf0cdd71558 Adding support for refresh block list where beremiz loose focus
lbessard
parents: 57
diff changeset
   825
            self.PLCEditor.RefreshEditor()
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   826
    
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   827
    def PlugPath(self, PlugName=None):
13
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   828
        return self.ProjectPath
17
ee8cb104dbe0 First commit of Beremiz new version with plugin support
lbessard
parents: 16
diff changeset
   829
    
13
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   830
    def PluginXmlFilePath(self, PlugName=None):
f1f0edbeb313 More precise design for plugins.... to be continued...
etisserant
parents:
diff changeset
   831
        return os.path.join(self.PlugPath(PlugName), "beremiz.xml")
18
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
   832
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   833
    def _getBuildPath(self):
256
1da137b99948 add buildpath parameter for beremiz
greg
parents: 253
diff changeset
   834
        if self.BuildPath is None:
1da137b99948 add buildpath parameter for beremiz
greg
parents: 253
diff changeset
   835
            return os.path.join(self.ProjectPath, "build")
1da137b99948 add buildpath parameter for beremiz
greg
parents: 253
diff changeset
   836
        return self.BuildPath
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   837
    
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   838
    def _getExtraFilesPath(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   839
        return os.path.join(self._getBuildPath(), "extra_files")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   840
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   841
    def _getIECcodepath(self):
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   842
        # define name for IEC code file
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   843
        return os.path.join(self._getBuildPath(), "plc.st")
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   844
    
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   845
    def _getIECgeneratedcodepath(self):
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   846
        # define name for IEC generated code file
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   847
        return os.path.join(self._getBuildPath(), "generated_plc.st")
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   848
    
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   849
    def _getIECrawcodepath(self):
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   850
        # define name for IEC raw code file
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   851
        return os.path.join(self.PlugPath(), "raw_plc.st")
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   852
    
97
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   853
    def GetLocations(self):
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   854
        locations = []
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   855
        filepath = os.path.join(self._getBuildPath(),"LOCATED_VARIABLES.h")
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   856
        if os.path.isfile(filepath):
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   857
            # IEC2C compiler generate a list of located variables : LOCATED_VARIABLES.h
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   858
            location_file = open(os.path.join(self._getBuildPath(),"LOCATED_VARIABLES.h"))
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   859
            # each line of LOCATED_VARIABLES.h declares a located variable
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   860
            lines = [line.strip() for line in location_file.readlines()]
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   861
            # This regular expression parses the lines genereated by IEC2C
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   862
            LOCATED_MODEL = re.compile("__LOCATED_VAR\((?P<IEC_TYPE>[A-Z]*),(?P<NAME>[_A-Za-z0-9]*),(?P<DIR>[QMI])(?:,(?P<SIZE>[XBWD]))?,(?P<LOC>[,0-9]*)\)")
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   863
            for line in lines:
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   864
                # If line match RE, 
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   865
                result = LOCATED_MODEL.match(line)
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   866
                if result:
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   867
                    # Get the resulting dict
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   868
                    resdict = result.groupdict()
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   869
                    # rewrite string for variadic location as a tuple of integers
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   870
                    resdict['LOC'] = tuple(map(int,resdict['LOC'].split(',')))
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   871
                    # set located size to 'X' if not given 
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   872
                    if not resdict['SIZE']:
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   873
                        resdict['SIZE'] = 'X'
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   874
                    # finally store into located variable list
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   875
                    locations.append(resdict)
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   876
        return locations
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   877
        
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   878
    def _Generate_SoftPLC(self):
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   879
        """
64
531e6a834d7e Change generate_cc to generate_c
lbessard
parents: 62
diff changeset
   880
        Generate SoftPLC ST/IL/SFC code out of PLCOpenEditor controller, and compile it with IEC2C
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   881
        @param buildpath: path where files should be created
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   882
        """
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   883
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   884
        # Update PLCOpenEditor Plugin Block types before generate ST code
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   885
        self.RefreshPluginsBlockLists()
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
   886
        
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   887
        self.logger.write("Generating SoftPLC IEC-61131 ST/IL/SFC code...\n")
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   888
        buildpath = self._getBuildPath()
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   889
        # ask PLCOpenEditor controller to write ST/IL/SFC code file
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   890
        result = self.GenerateProgram(self._getIECgeneratedcodepath())
113
78a92a18f8d6 Fixed new project creation bug
etisserant
parents: 110
diff changeset
   891
        if result is not None:
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   892
            # Failed !
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   893
            self.logger.write_error("Error in ST/IL/SFC code generator :\n%s\n"%result)
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   894
            return False
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   895
        plc_file = open(self._getIECcodepath(), "w")
274
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   896
        if getattr(self, "PluggedChilds", None) is not None:
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   897
            # Add ST Library from plugins
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   898
            plc_file.write(self.STLibraryFactory())
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   899
            plc_file.write("\n")
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   900
            for child in self.IterChilds():
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   901
                plc_file.write(child.STLibraryFactory())
8628f3dd0979 Adding support for defining plugin library as a plcopen xml file in plugin folder
greg
parents: 273
diff changeset
   902
                plc_file.write("\n")
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   903
        if os.path.isfile(self._getIECrawcodepath()):
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   904
            plc_file.write(open(self._getIECrawcodepath(), "r").read())
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   905
            plc_file.write("\n")
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   906
        plc_file.write(open(self._getIECgeneratedcodepath(), "r").read())
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
   907
        plc_file.close()
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   908
        self.logger.write("Compiling IEC Program in to C code...\n")
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   909
        # Now compile IEC code into many C files
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   910
        # files are listed to stdout, and errors to stderr. 
110
a05e8b30c024 Fixed way apps are launched in parralel with single log window... Tested in win32 only.
etisserant
parents: 109
diff changeset
   911
        status, result, err_result = ProcessLogger(
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   912
               self.logger,
202
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
   913
               "\"%s\" -f \"%s\" -I \"%s\" \"%s\""%(
110
a05e8b30c024 Fixed way apps are launched in parralel with single log window... Tested in win32 only.
etisserant
parents: 109
diff changeset
   914
                         iec2c_path,
a05e8b30c024 Fixed way apps are launched in parralel with single log window... Tested in win32 only.
etisserant
parents: 109
diff changeset
   915
                         self._getIECcodepath(),
a05e8b30c024 Fixed way apps are launched in parralel with single log window... Tested in win32 only.
etisserant
parents: 109
diff changeset
   916
                         ieclib_path, buildpath),
a05e8b30c024 Fixed way apps are launched in parralel with single log window... Tested in win32 only.
etisserant
parents: 109
diff changeset
   917
               no_stdout=True).spin()
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   918
        if status:
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   919
            # Failed !
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   920
            self.logger.write_error("Error : IEC to C compiler returned %d\n"%status)
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   921
            return False
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   922
        # Now extract C files of stdout
113
78a92a18f8d6 Fixed new project creation bug
etisserant
parents: 110
diff changeset
   923
        C_files = [ fname for fname in result.splitlines() if fname[-2:]==".c" or fname[-2:]==".C" ]
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   924
        # remove those that are not to be compiled because included by others
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   925
        C_files.remove("POUS.c")
115
9ffdac9cf609 Fixed empty build exception.
etisserant
parents: 114
diff changeset
   926
        if not C_files:
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   927
            self.logger.write_error("Error : At least one configuration and one ressource must be declared in PLC !\n")
115
9ffdac9cf609 Fixed empty build exception.
etisserant
parents: 114
diff changeset
   928
            return False
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   929
        # transform those base names to full names with path
23
e007d9d466d7 minor fixes
etisserant
parents: 22
diff changeset
   930
        C_files = map(lambda filename:os.path.join(buildpath, filename), C_files)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   931
        self.logger.write("Extracting Located Variables...\n")
97
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   932
        # Keep track of generated located variables for later use by self._Generate_C
9c6fdf60ad2e Beremiz layout changed
lbessard
parents: 96
diff changeset
   933
        self.PLCGeneratedLocatedVars = self.GetLocations()
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
   934
        # Keep track of generated C files for later use by self.PlugGenerate_C
18
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
   935
        self.PLCGeneratedCFiles = C_files
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents: 47
diff changeset
   936
        # compute CFLAGS for plc
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   937
        self.plcCFLAGS = "\"-I"+ieclib_path+"\""
18
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
   938
        return True
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
   939
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   940
    def GetBuilder(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   941
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   942
        Return a Builder (compile C code into machine code)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   943
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   944
        # Get target, module and class name
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   945
        targetname = self.BeremizRoot.getTargetType().getcontent()["name"]
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   946
        modulename = "targets." + targetname
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   947
        classname = targetname + "_target"
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   948
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   949
        # Get module reference
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   950
        try :
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   951
            targetmodule = getattr(__import__(modulename), targetname)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   952
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   953
        except Exception, msg:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   954
            self.logger.write_error("Can't find module for target %s!\n"%targetname)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   955
            self.logger.write_error(str(msg))
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   956
            return None
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   957
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   958
        # Get target class
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   959
        targetclass = getattr(targetmodule, classname)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   960
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   961
        # if target already 
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   962
        if self._builder is None or not isinstance(self._builder,targetclass):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   963
            # Get classname instance
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   964
            self._builder = targetclass(self)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   965
        return self._builder
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   966
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   967
    def GetLastBuildMD5(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   968
        builder=self.GetBuilder()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   969
        if builder is not None:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   970
            return builder.GetBinaryCodeMD5()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   971
        else:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   972
            return None
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   973
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   974
    #######################################################################
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   975
    #
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   976
    #                C CODE GENERATION METHODS
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   977
    #
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   978
    #######################################################################
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   979
    
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   980
    def PlugGenerate_C(self, buildpath, locations):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   981
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   982
        Return C code generated by iec2c compiler 
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   983
        when _generate_softPLC have been called
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   984
        @param locations: ignored
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   985
        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   986
        """
228
848da15cf513 fixed : init_level bug
greg
parents: 227
diff changeset
   987
        return [(C_file_name, self.plcCFLAGS) for C_file_name in self.PLCGeneratedCFiles ] , "", False
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   988
    
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   989
    def ResetIECProgramsAndVariables(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   990
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   991
        Reset variable and program list that are parsed from
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   992
        CSV file generated by IEC2C compiler.
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   993
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   994
        self._ProgramList = None
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   995
        self._VariablesList = None
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   996
        self._IECPathToIdx = None
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
   997
        self.TracedIECPath = []
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
   998
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
   999
    def GetIECProgramsAndVariables(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1000
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1001
        Parse CSV-like file  VARIABLES.csv resulting from IEC2C compiler.
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1002
        Each section is marked with a line staring with '//'
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1003
        list of all variables used in various POUs
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1004
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1005
        if self._ProgramList is None or self._VariablesList is None:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1006
            try:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1007
                csvfile = os.path.join(self._getBuildPath(),"VARIABLES.csv")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1008
                # describes CSV columns
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1009
                ProgramsListAttributeName = ["num", "C_path", "type"]
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1010
                VariablesListAttributeName = ["num", "vartype", "IEC_path", "C_path", "type"]
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1011
                self._ProgramList = []
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1012
                self._VariablesList = []
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1013
                self._IECPathToIdx = {}
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1014
                
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1015
                # Separate sections
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1016
                ListGroup = []
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1017
                for line in open(csvfile,'r').xreadlines():
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1018
                    strippedline = line.strip()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1019
                    if strippedline.startswith("//"):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1020
                        # Start new section
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1021
                        ListGroup.append([])
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1022
                    elif len(strippedline) > 0 and len(ListGroup) > 0:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1023
                        # append to this section
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1024
                        ListGroup[-1].append(strippedline)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1025
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1026
                # first section contains programs
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1027
                for line in ListGroup[0]:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1028
                    # Split and Maps each field to dictionnary entries
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1029
                    attrs = dict(zip(ProgramsListAttributeName,line.strip().split(';')))
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1030
                    # Truncate "C_path" to remove conf an ressources names
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1031
                    attrs["C_path"] = '__'.join(attrs["C_path"].split(".",2)[1:])
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1032
                    # Push this dictionnary into result.
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1033
                    self._ProgramList.append(attrs)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1034
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1035
                # second section contains all variables
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1036
                for line in ListGroup[1]:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1037
                    # Split and Maps each field to dictionnary entries
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1038
                    attrs = dict(zip(VariablesListAttributeName,line.strip().split(';')))
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1039
                    # Truncate "C_path" to remove conf an ressources names
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1040
                    attrs["C_path"] = '__'.join(attrs["C_path"].split(".",2)[1:])
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1041
                    # Push this dictionnary into result.
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1042
                    self._VariablesList.append(attrs)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1043
                    # Fill in IEC<->C translation dicts
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1044
                    IEC_path=attrs["IEC_path"]
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1045
                    Idx=int(attrs["num"])
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1046
                    self._IECPathToIdx[IEC_path]=Idx
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1047
            except Exception,e:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1048
                self.logger.write_error("Cannot open/parse VARIABLES.csv!\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1049
                self.logger.write_error(traceback.format_exc())
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1050
                self.ResetIECProgramsAndVariables()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1051
                return False
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1052
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1053
        return True
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1054
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1055
    def Generate_plc_debugger(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1056
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1057
        Generate trace/debug code out of PLC variable list
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1058
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1059
        self.GetIECProgramsAndVariables()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1060
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1061
        # prepare debug code
209
08dc3d064cb5 Moved template C code to targets dir. Cleaned up some forgotten print.
etisserant
parents: 206
diff changeset
  1062
        debug_code = targets.code("plc_debug") % {
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1063
           "programs_declarations":
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1064
               "\n".join(["extern %(type)s %(C_path)s;"%p for p in self._ProgramList]),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1065
           "extern_variables_declarations":"\n".join([
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1066
              {"PT":"extern %(type)s *%(C_path)s;",
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1067
               "VAR":"extern %(type)s %(C_path)s;"}[v["vartype"]]%v 
275
ff7c8eb3f362 Adding Function Blocks in VARIABLES.csv
lbessard
parents: 274
diff changeset
  1068
               for v in self._VariablesList if v["vartype"] != "FB" and v["C_path"].find('.')<0]),
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1069
           "subscription_table_count":
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1070
               len(self._VariablesList),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1071
           "variables_pointer_type_table_count":
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1072
               len(self._VariablesList),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1073
           "variables_pointer_type_table_initializer":"\n".join([
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1074
               {"PT":"    variable_table[%(num)s].ptrvalue = (void*)(%(C_path)s);\n",
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1075
                "VAR":"    variable_table[%(num)s].ptrvalue = (void*)(&%(C_path)s);\n"}[v["vartype"]]%v + 
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1076
                "    variable_table[%(num)s].type = %(type)s_ENUM;\n"%v
275
ff7c8eb3f362 Adding Function Blocks in VARIABLES.csv
lbessard
parents: 274
diff changeset
  1077
                for v in self._VariablesList if v["vartype"] != "FB" and v["type"] in DebugTypes ])}
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1078
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1079
        return debug_code
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1080
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1081
    def Generate_plc_common_main(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1082
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1083
        Use plugins layout given in LocationCFilesAndCFLAGS to
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1084
        generate glue code that dispatch calls to all plugins
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1085
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1086
        # filter location that are related to code that will be called
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1087
        # in retreive, publish, init, cleanup
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1088
        locstrs = map(lambda x:"_".join(map(str,x)),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1089
           [loc for loc,Cfiles,DoCalls in self.LocationCFilesAndCFLAGS if loc and DoCalls])
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1090
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1091
        # Generate main, based on template
209
08dc3d064cb5 Moved template C code to targets dir. Cleaned up some forgotten print.
etisserant
parents: 206
diff changeset
  1092
        plc_main_code = targets.code("plc_common_main") % {
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1093
            "calls_prototypes":"\n".join([(
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1094
                  "int __init_%(s)s(int argc,char **argv);\n"+
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1095
                  "void __cleanup_%(s)s();\n"+
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1096
                  "void __retrieve_%(s)s();\n"+
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1097
                  "void __publish_%(s)s();")%{'s':locstr} for locstr in locstrs]),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1098
            "retrieve_calls":"\n    ".join([
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1099
                  "__retrieve_%s();"%locstr for locstr in locstrs]),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1100
            "publish_calls":"\n    ".join([ #Call publish in reverse order
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1101
                  "__publish_%s();"%locstrs[i-1] for i in xrange(len(locstrs), 0, -1)]),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1102
            "init_calls":"\n    ".join([
228
848da15cf513 fixed : init_level bug
greg
parents: 227
diff changeset
  1103
                  "init_level=%d; "%(i+1)+
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1104
                  "if(res = __init_%s(argc,argv)){"%locstr +
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1105
                  #"printf(\"%s\"); "%locstr + #for debug
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1106
                  "return res;}" for i,locstr in enumerate(locstrs)]),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1107
            "cleanup_calls":"\n    ".join([
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1108
                  "if(init_level >= %d) "%i+
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1109
                  "__cleanup_%s();"%locstrs[i-1] for i in xrange(len(locstrs), 0, -1)])
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1110
            }
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1111
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1112
        target_name = self.BeremizRoot.getTargetType().getcontent()["name"]
209
08dc3d064cb5 Moved template C code to targets dir. Cleaned up some forgotten print.
etisserant
parents: 206
diff changeset
  1113
        plc_main_code += targets.targetcode(target_name)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1114
        return plc_main_code
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1115
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1116
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1117
    def _build(self):
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1118
        """
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1119
        Method called by user to (re)build SoftPLC and plugin tree
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1120
        """
202
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
  1121
        if self.PLCEditor is not None:
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
  1122
            self.PLCEditor.ClearErrors()
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
  1123
        
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1124
        buildpath = self._getBuildPath()
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1125
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1126
        # Eventually create build dir
18
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
  1127
        if not os.path.exists(buildpath):
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
  1128
            os.mkdir(buildpath)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1129
        # There is something to clean
110
a05e8b30c024 Fixed way apps are launched in parralel with single log window... Tested in win32 only.
etisserant
parents: 109
diff changeset
  1130
        self.EnableMethod("_Clean", True)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1131
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1132
        self.logger.flush()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1133
        self.logger.write("Start build in %s\n" % buildpath)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1134
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1135
        # Generate SoftPLC IEC code
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1136
        IECGenRes = self._Generate_SoftPLC()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1137
        self.ShowMethod("_showIECcode", True)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1138
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1139
        # If IEC code gen fail, bail out.
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1140
        if not IECGenRes:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1141
            self.logger.write_error("IEC-61131-3 code generation failed !\n")
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1142
            return False
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1143
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1144
        # Reset variable and program list that are parsed from
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1145
        # CSV file generated by IEC2C compiler.
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1146
        self.ResetIECProgramsAndVariables()
18
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
  1147
        
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1148
        # Generate C code and compilation params from plugin hierarchy
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1149
        self.logger.write("Generating plugins C code\n")
24
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
  1150
        try:
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1151
            self.LocationCFilesAndCFLAGS, self.LDFLAGS, ExtraFiles = self._Generate_C(
24
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
  1152
                buildpath, 
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1153
                self.PLCGeneratedLocatedVars)
178
2390b409eb93 Added PLC tick alignement on external synchronization source feature.
etisserant
parents: 176
diff changeset
  1154
        except Exception, exc:
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1155
            self.logger.write_error("Plugins code generation failed !\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1156
            self.logger.write_error(traceback.format_exc())
24
585d5b387b6a Working CanOpen OD generation
etisserant
parents: 23
diff changeset
  1157
            return False
18
0fac6d621a24 Base build mechanism layout.
etisserant
parents: 17
diff changeset
  1158
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1159
        # Get temprary directory path
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1160
        extrafilespath = self._getExtraFilesPath()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1161
        # Remove old directory
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1162
        if os.path.exists(extrafilespath):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1163
            shutil.rmtree(extrafilespath)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1164
        # Recreate directory
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1165
        os.mkdir(extrafilespath)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1166
        # Then write the files
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1167
        for fname,fobject in ExtraFiles:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1168
            fpath = os.path.join(extrafilespath,fname)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1169
            open(fpath, "wb").write(fobject.read())
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1170
        # Now we can forget ExtraFiles (will close files object)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1171
        del ExtraFiles
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1172
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1173
        # Template based part of C code generation
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1174
        # files are stacked at the beginning, as files of plugin tree root
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1175
        for generator, filename, name in [
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1176
           # debugger code
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1177
           (self.Generate_plc_debugger, "plc_debugger.c", "Debugger"),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1178
           # init/cleanup/retrieve/publish, run and align code
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1179
           (self.Generate_plc_common_main,"plc_common_main.c","Common runtime")]:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1180
            try:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1181
                # Do generate
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1182
                code = generator()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1183
                code_path = os.path.join(buildpath,filename)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1184
                open(code_path, "w").write(code)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1185
                # Insert this file as first file to be compiled at root plugin
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1186
                self.LocationCFilesAndCFLAGS[0][1].insert(0,(code_path, self.plcCFLAGS))
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1187
            except Exception, exc:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1188
                self.logger.write_error(name+" generation failed !\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1189
                self.logger.write_error(traceback.format_exc())
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1190
                return False
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1191
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1192
        self.logger.write("C code generated successfully.\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1193
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1194
        # Get current or fresh builder
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1195
        builder = self.GetBuilder()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1196
        if builder is None:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1197
            self.logger.write_error("Fatal : cannot get builder.\n")
51
c31c55601556 Added project linking, and plugin init,cleanup,retrive and publish method calls in main
etisserant
parents: 49
diff changeset
  1198
            return False
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1199
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1200
        # Build
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1201
        try:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1202
            if not builder.build() :
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1203
                self.logger.write_error("C Build failed.\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1204
                return False
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1205
        except Exception, exc:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1206
            self.logger.write_error("C Build crashed !\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1207
            self.logger.write_error(traceback.format_exc())
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1208
            return False
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1209
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1210
        # Update GUI status about need for transfer
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1211
        self.CompareLocalAndRemotePLC()
49
45dc6a944ab6 On the long wat towards generated code comilation...
etisserant
parents: 47
diff changeset
  1212
        return True
202
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
  1213
    
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
  1214
    def ShowError(self, logger, from_location, to_location):
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
  1215
        chunk_infos = self.GetChunkInfos(from_location, to_location)
215
0a98f2308107 Bugs on Opening PLCOpenEditor fixed
lbessard
parents: 209
diff changeset
  1216
        self._EditPLC()
202
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
  1217
        for infos, (start_row, start_col) in chunk_infos:
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
  1218
            start = (from_location[0] - start_row, from_location[1] - start_col)
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
  1219
            end = (to_location[0] - start_row, to_location[1] - start_col)
cd81a7a6e55c Adding support for highlighing compiling errors into PLCOpenEditor
lbessard
parents: 199
diff changeset
  1220
            self.PLCEditor.ShowError(infos, start, end)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1221
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1222
    def _showIECcode(self):
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1223
        plc_file = self._getIECcodepath()
173
2a9c4eec8645 Bug on Beremiz close with and IECcode and IECrawcode frames opened fixed
lbessard
parents: 158
diff changeset
  1224
        new_dialog = wx.Frame(self.AppFrame)
74
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
  1225
        ST_viewer = TextViewer(new_dialog, "", None, None)
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1226
        #ST_viewer.Enable(False)
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1227
        ST_viewer.SetKeywords(IEC_KEYWORDS)
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1228
        try:
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1229
            text = file(plc_file).read()
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1230
        except:
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1231
            text = '(* No IEC code have been generated at that time ! *)'
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1232
        ST_viewer.SetText(text = text)
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1233
            
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1234
        new_dialog.Show()
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1235
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1236
    def _editIECrawcode(self):
173
2a9c4eec8645 Bug on Beremiz close with and IECcode and IECrawcode frames opened fixed
lbessard
parents: 158
diff changeset
  1237
        new_dialog = wx.Frame(self.AppFrame)
66
b46237718b27 Bug with raw code edit fixed
lbessard
parents: 65
diff changeset
  1238
        
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1239
        controler = MiniTextControler(self._getIECrawcodepath())
74
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
  1240
        ST_viewer = TextViewer(new_dialog, "", None, controler)
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1241
        #ST_viewer.Enable(False)
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1242
        ST_viewer.SetKeywords(IEC_KEYWORDS)
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1243
        ST_viewer.RefreshView()
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1244
            
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1245
        new_dialog.Show()
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1246
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1247
    def _EditPLC(self):
62
ddf0cdd71558 Adding support for refresh block list where beremiz loose focus
lbessard
parents: 57
diff changeset
  1248
        if self.PLCEditor is None:
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
  1249
            self.RefreshPluginsBlockLists()
25
fa7503684c28 Adding support for using Networkedit et PLCOpenEditor in Beremiz
lbessard
parents: 24
diff changeset
  1250
            def _onclose():
fa7503684c28 Adding support for using Networkedit et PLCOpenEditor in Beremiz
lbessard
parents: 24
diff changeset
  1251
                self.PLCEditor = None
fa7503684c28 Adding support for using Networkedit et PLCOpenEditor in Beremiz
lbessard
parents: 24
diff changeset
  1252
            def _onsave():
fa7503684c28 Adding support for using Networkedit et PLCOpenEditor in Beremiz
lbessard
parents: 24
diff changeset
  1253
                self.SaveProject()
41
1608a434fb8c Adding support for refreshing PLCOpenEditor block list
lbessard
parents: 40
diff changeset
  1254
            self.PLCEditor = PLCOpenEditor(self.AppFrame, self)
25
fa7503684c28 Adding support for using Networkedit et PLCOpenEditor in Beremiz
lbessard
parents: 24
diff changeset
  1255
            self.PLCEditor._onclose = _onclose
fa7503684c28 Adding support for using Networkedit et PLCOpenEditor in Beremiz
lbessard
parents: 24
diff changeset
  1256
            self.PLCEditor._onsave = _onsave
20
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1257
            self.PLCEditor.Show()
d3cb5020997b Beremiz plugins definitions.
etisserant
parents: 19
diff changeset
  1258
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1259
    def _Clean(self):
108
280b458e42e5 add clean implementation
greg
parents: 107
diff changeset
  1260
        if os.path.isdir(os.path.join(self._getBuildPath())):
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1261
            self.logger.write("Cleaning the build directory\n")
108
280b458e42e5 add clean implementation
greg
parents: 107
diff changeset
  1262
            shutil.rmtree(os.path.join(self._getBuildPath()))
280b458e42e5 add clean implementation
greg
parents: 107
diff changeset
  1263
        else:
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1264
            self.logger.write_error("Build directory already clean\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1265
        self.ShowMethod("_showIECcode", False)
110
a05e8b30c024 Fixed way apps are launched in parralel with single log window... Tested in win32 only.
etisserant
parents: 109
diff changeset
  1266
        self.EnableMethod("_Clean", False)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1267
        self.CompareLocalAndRemotePLC()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1268
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1269
    ############# Real PLC object access #############
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1270
    def UpdateMethodsFromPLCStatus(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1271
        # Get PLC state : Running or Stopped
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1272
        # TODO : use explicit status instead of boolean
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1273
        if self._connector is not None:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1274
            status = self._connector.GetPLCstatus()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1275
            self.logger.write("PLC is %s\n"%status)
107
65fe90d49bf7 add Run and Stop implementation
greg
parents: 106
diff changeset
  1276
        else:
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1277
            status = "Disconnected"
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1278
        for args in {
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1279
               "Started":[("_Run", False),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1280
                          ("_Debug", False),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1281
                          ("_Stop", True)],
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1282
               "Stopped":[("_Run", True),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1283
                          ("_Debug", True),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1284
                          ("_Stop", False)],
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1285
               "Empty":  [("_Run", False),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1286
                          ("_Debug", False),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1287
                          ("_Stop", False)],
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1288
               "Dirty":  [("_Run", True),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1289
                          ("_Debug", True),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1290
                          ("_Stop", False)],
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1291
               "Disconnected":  [("_Run", False),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1292
                                 ("_Debug", False),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1293
                                 ("_Stop", False)],
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1294
               }.get(status,[]):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1295
            self.ShowMethod(*args)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1296
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1297
    def _Run(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1298
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1299
        Start PLC
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1300
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1301
        if self._connector.StartPLC():
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1302
            self.logger.write("Starting PLC\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1303
        else:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1304
            self.logger.write_error("Couldn't start PLC !\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1305
        self.UpdateMethodsFromPLCStatus()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1306
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1307
    def RegisterDebugVarToConnector(self):
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1308
        self.DebugTimer=None
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1309
        Idxs = []
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1310
        self.TracedIECPath = []
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1311
        if self._connector is not None:
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1312
            self.IECdebug_lock.acquire()
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1313
            IECPathsToPop = []
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1314
            for IECPath,data_tuple in self.IECdebug_datas.iteritems():
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1315
                WeakCallableDict, data_log, status = data_tuple
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1316
                if len(WeakCallableDict) == 0:
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1317
                    # Callable Dict is empty.
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1318
                    # This variable is not needed anymore!
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1319
                    #print "Unused : " + IECPath
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1320
                    IECPathsToPop.append(IECPath)
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1321
                else:
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1322
                    # Convert 
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1323
                    Idx = self._IECPathToIdx.get(IECPath,None)
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1324
                    if Idx is not None:
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1325
                        Idxs.append(Idx)
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1326
                        self.TracedIECPath.append(IECPath)
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1327
                    else:
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1328
                        self.logger.write_warning("Debug : Unknown variable %s\n"%IECPath)
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1329
            for IECPathToPop in IECPathsToPop:
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1330
                self.IECdebug_datas.pop(IECPathToPop)
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1331
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1332
            self._connector.SetTraceVariablesList(Idxs)
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1333
            self.IECdebug_lock.release()
243
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1334
            
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1335
            #for IEC_path, IECdebug_data in self.IECdebug_datas.iteritems():
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1336
            #    print IEC_path, IECdebug_data[0].keys()
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1337
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1338
    def ReArmDebugRegisterTimer(self):
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1339
        if self.DebugTimer is not None:
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1340
            self.DebugTimer.cancel()
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1341
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1342
        # Timer to prevent rapid-fire when registering many variables
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1343
        # use wx.CallAfter use keep using same thread. TODO : use wx.Timer instead
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1344
        self.DebugTimer=Timer(0.5,wx.CallAfter,args = [self.RegisterDebugVarToConnector])
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1345
        # Rearm anti-rapid-fire timer
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1346
        self.DebugTimer.start()
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1347
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1348
        
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1349
    def SubscribeDebugIECVariable(self, IECPath, callableobj, *args, **kwargs):
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1350
        """
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1351
        Dispatching use a dictionnary linking IEC variable paths
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1352
        to a WeakKeyDictionary linking 
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1353
        weakly referenced callables to optionnal args
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1354
        """
246
3613c6ee9e0e Adding support for Debugging in PLCOpenEditor
lbessard
parents: 244
diff changeset
  1355
        if self._IECPathToIdx.get(IECPath, None) is None:
3613c6ee9e0e Adding support for Debugging in PLCOpenEditor
lbessard
parents: 244
diff changeset
  1356
            return None
3613c6ee9e0e Adding support for Debugging in PLCOpenEditor
lbessard
parents: 244
diff changeset
  1357
        
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1358
        self.IECdebug_lock.acquire()
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1359
        # If no entry exist, create a new one with a fresh WeakKeyDictionary
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1360
        IECdebug_data = self.IECdebug_datas.get(IECPath, None)
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1361
        if IECdebug_data is None:
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1362
            IECdebug_data  = [
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1363
                    WeakKeyDictionary(), # Callables
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1364
                    [],                  # Data storage [(tick, data),...]
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1365
                    "Registered"]        # Variable status
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1366
            self.IECdebug_datas[IECPath] = IECdebug_data
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1367
        
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1368
        IECdebug_data[0][callableobj]=(args, kwargs)
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1369
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1370
        self.IECdebug_lock.release()
243
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1371
        
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1372
        self.ReArmDebugRegisterTimer()
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1373
        
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1374
        return IECdebug_data[1]
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1375
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1376
    def UnsubscribeDebugIECVariable(self, IECPath, callableobj):
243
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1377
        #print "Unsubscribe", IECPath, callableobj
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1378
        self.IECdebug_lock.acquire()
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1379
        IECdebug_data = self.IECdebug_datas.get(IECPath, None)
243
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1380
        if IECdebug_data is not None:
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1381
            IECdebug_data[0].pop(callableobj,None)
243
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1382
        self.IECdebug_lock.release()
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1383
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1384
        self.ReArmDebugRegisterTimer()
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1385
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1386
    def DebugThreadProc(self):
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1387
        """
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1388
        This thread waid PLC debug data, and dispatch them to subscribers
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1389
        """
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1390
        # This lock is used to avoid flooding wx event stack calling callafter
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1391
        self.DebugThreadSlowDownLock = Semaphore(0)
244
85e92d9e34a8 fixed : bug in debugthreadproc (plugger.py)
greg
parents: 243
diff changeset
  1392
        _break = False
85e92d9e34a8 fixed : bug in debugthreadproc (plugger.py)
greg
parents: 243
diff changeset
  1393
        while not _break and self._connector is not None:
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1394
            debug_tick, debug_vars = self._connector.GetTraceVariables()
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1395
            #print debug_tick, debug_vars
243
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1396
            self.IECdebug_lock.acquire()
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1397
            if debug_vars is not None and \
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1398
               len(debug_vars) == len(self.TracedIECPath):
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1399
                for IECPath,value in zip(self.TracedIECPath, debug_vars):
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1400
                    data_tuple = self.IECdebug_datas.get(IECPath, None)
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1401
                    if data_tuple is not None:
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1402
                        WeakCallableDict, data_log, status = data_tuple
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1403
                        data_log.append((debug_tick, value))
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1404
                        for weakcallable,(args,kwargs) in WeakCallableDict.iteritems():
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1405
                            # delegate call to wx event loop
244
85e92d9e34a8 fixed : bug in debugthreadproc (plugger.py)
greg
parents: 243
diff changeset
  1406
                            #print weakcallable, value, args, kwargs
85e92d9e34a8 fixed : bug in debugthreadproc (plugger.py)
greg
parents: 243
diff changeset
  1407
                            wx.CallAfter(weakcallable.SetValue, value, *args, **kwargs)
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1408
                            # This will block thread if more than one call is waiting
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1409
            elif debug_vars is not None:
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1410
                wx.CallAfter(self.logger.write_warning, 
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1411
                             "debug data not coherent %d != %d"%(len(debug_vars), len(self.TracedIECPath)))
243
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1412
            elif debug_tick == -1:
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1413
                #wx.CallAfter(self.logger.write, "Debugger unavailable\n")
243
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1414
                pass
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1415
            else:
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1416
                wx.CallAfter(self.logger.write, "Debugger disabled\n")
244
85e92d9e34a8 fixed : bug in debugthreadproc (plugger.py)
greg
parents: 243
diff changeset
  1417
                _break = True
243
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1418
            self.IECdebug_lock.release()
244
85e92d9e34a8 fixed : bug in debugthreadproc (plugger.py)
greg
parents: 243
diff changeset
  1419
            wx.CallAfter(self.DebugThreadSlowDownLock.release)
85e92d9e34a8 fixed : bug in debugthreadproc (plugger.py)
greg
parents: 243
diff changeset
  1420
            self.DebugThreadSlowDownLock.acquire()
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1421
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1422
    def _Debug(self):
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1423
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1424
        Start PLC (Debug Mode)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1425
        """
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1426
        if self.GetIECProgramsAndVariables() and \
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1427
           self._connector.StartPLC(debug=True):
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1428
            self.logger.write("Starting PLC (debug mode)\n")
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1429
            self.TracedIECPath = []
243
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1430
            if self.PLCDebug is None:
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1431
                self.RefreshPluginsBlockLists()
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1432
                def _onclose():
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1433
                    self.PLCDebug = None
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1434
                self.PLCDebug = PLCOpenEditor(self.AppFrame, self, debug=True)
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1435
                self.PLCDebug._onclose = _onclose
90db933fe956 Adding support for Debugging with PLCOpenEditor
lbessard
parents: 239
diff changeset
  1436
                self.PLCDebug.Show()
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1437
            self.DebugThread = Thread(target=self.DebugThreadProc)
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1438
            self.DebugThread.start()
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1439
        else:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1440
            self.logger.write_error("Couldn't start PLC debug !\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1441
        self.UpdateMethodsFromPLCStatus()
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1442
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1443
#    def _Do_Test_Debug(self):
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1444
#        # debug code
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1445
#        self.temporary_non_weak_callable_refs = []
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1446
#        for IEC_Path, idx in self._IECPathToIdx.iteritems():
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1447
#            class tmpcls:
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1448
#                def __init__(_self):
244
85e92d9e34a8 fixed : bug in debugthreadproc (plugger.py)
greg
parents: 243
diff changeset
  1449
#                    _self.buf = None
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1450
#                def setbuf(_self,buf):
244
85e92d9e34a8 fixed : bug in debugthreadproc (plugger.py)
greg
parents: 243
diff changeset
  1451
#                    _self.buf = buf
239
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1452
#                def SetValue(_self, value, idx, name):
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1453
#                    self.logger.write("debug call: %s %d %s\n"%(repr(value), idx, name))
112b4bc523b3 Fixed bad IPC choice for debugger/PLC/control thread collaboration
etisserant
parents: 236
diff changeset
  1454
#                    #self.logger.write("debug call: %s %d %s %s\n"%(repr(value), idx, name, repr(self.buf)))
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1455
#            a = tmpcls()
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1456
#            res = self.SubscribeDebugIECVariable(IEC_Path, a, idx, IEC_Path)
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1457
#            a.setbuf(res)
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1458
#            self.temporary_non_weak_callable_refs.append(a)
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1459
       
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1460
    def _Stop(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1461
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1462
        Stop PLC
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1463
        """
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1464
        if self._connector.StopPLC():
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1465
            self.logger.write("Stopping PLC\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1466
        else:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1467
            self.logger.write_error("Couldn't stop PLC !\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1468
        self.UpdateMethodsFromPLCStatus()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1469
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1470
    def _Connect(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1471
        # don't accept re-connetion is already connected
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1472
        if self._connector is not None:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1473
            self.logger.write_error("Already connected. Please disconnect\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1474
            return
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1475
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1476
        # Get connector uri
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1477
        uri = self.\
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1478
              BeremizRoot.\
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1479
              getURI_location().\
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1480
              strip()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1481
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1482
        # if uri is empty launch discovery dialog
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1483
        if uri == "":
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1484
            # Launch Service Discovery dialog
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1485
            dia = DiscoveryDialog(self.AppFrame)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1486
            dia.ShowModal()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1487
            uri = dia.GetResult()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1488
            # Nothing choosed or cancel button
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1489
            if uri is None:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1490
                return
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1491
            else:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1492
                self.\
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1493
                BeremizRoot.\
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1494
                setURI_location(uri)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1495
       
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1496
        # Get connector from uri
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1497
        try:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1498
            self._connector = connectors.ConnectorFactory(uri, self)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1499
        except Exception, msg:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1500
            self.logger.write_error("Exception while connecting %s!\n"%uri)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1501
            self.logger.write_error(traceback.format_exc())
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1502
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1503
        # Did connection success ?
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1504
        if self._connector is None:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1505
            # Oups.
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1506
            self.logger.write_error("Connection failed to %s!\n"%uri)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1507
        else:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1508
            self.ShowMethod("_Connect", False)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1509
            self.ShowMethod("_Disconnect", True)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1510
            self.ShowMethod("_Transfer", True)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1511
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1512
            self.CompareLocalAndRemotePLC()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1513
            self.UpdateMethodsFromPLCStatus()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1514
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1515
    def CompareLocalAndRemotePLC(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1516
        if self._connector is None:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1517
            return
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1518
        # We are now connected. Update button status
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1519
        MD5 = self.GetLastBuildMD5()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1520
        # Check remote target PLC correspondance to that md5
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1521
        if MD5 is not None:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1522
            if not self._connector.MatchMD5(MD5):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1523
                self.logger.write_warning(
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1524
                   "Latest build do not match with target, please transfer.\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1525
                self.EnableMethod("_Transfer", True)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1526
            else:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1527
                self.logger.write(
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1528
                   "Latest build match target, no transfer needed.\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1529
                self.EnableMethod("_Transfer", True)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1530
                #self.EnableMethod("_Transfer", False)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1531
        else:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1532
            self.logger.write_warning(
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1533
                "Cannot compare latest build to target. Please build.\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1534
            self.EnableMethod("_Transfer", False)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1535
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1536
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1537
    def _Disconnect(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1538
        self._connector = None
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1539
        self.ShowMethod("_Transfer", False)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1540
        self.ShowMethod("_Connect", True)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1541
        self.ShowMethod("_Disconnect", False)
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1542
        self.UpdateMethodsFromPLCStatus()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1543
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1544
    def _Transfer(self):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1545
        # Get the last build PLC's 
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1546
        MD5 = self.GetLastBuildMD5()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1547
        
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1548
        # Check if md5 file is empty : ask user to build PLC 
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1549
        if MD5 is None :
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1550
            self.logger.write_error("Failed : Must build before transfer.\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1551
            return False
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1552
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1553
        # Compare PLC project with PLC on target
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1554
        if self._connector.MatchMD5(MD5):
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1555
            self.logger.write(
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1556
                "Latest build already match current target. Transfering anyway...\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1557
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1558
        # Get temprary directory path
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1559
        extrafilespath = self._getExtraFilesPath()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1560
        extrafiles = [(name, open(os.path.join(extrafilespath, name), 
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1561
                                  'rb').read()) \
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1562
                      for name in os.listdir(extrafilespath) \
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1563
                      if not name=="CVS"]
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1564
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1565
        # Send PLC on target
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1566
        builder = self.GetBuilder()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1567
        if builder is not None:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1568
            data = builder.GetBinaryCode()
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1569
            if data is not None :
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1570
                if self._connector.NewPLC(MD5, data, extrafiles):
246
3613c6ee9e0e Adding support for Debugging in PLCOpenEditor
lbessard
parents: 244
diff changeset
  1571
                    self.ProgramTransferred()
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1572
                    self.logger.write("Transfer completed successfully.\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1573
                else:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1574
                    self.logger.write_error("Transfer failed\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1575
            else:
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1576
                self.logger.write_error("No PLC to transfer (did build success ?)\n")
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1577
        self.UpdateMethodsFromPLCStatus()
105
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
  1578
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1579
    PluginMethods = [
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1580
        {"bitmap" : opjimg("editPLC"),
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1581
         "name" : "Edit PLC",
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1582
         "tooltip" : "Edit PLC program with PLCOpenEditor",
105
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
  1583
         "method" : "_EditPLC"},
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1584
        {"bitmap" : opjimg("Build"),
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1585
         "name" : "Build",
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1586
         "tooltip" : "Build project into build folder",
105
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
  1587
         "method" : "_build"},
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1588
        {"bitmap" : opjimg("Clean"),
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1589
         "name" : "Clean",
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1590
         "enabled" : False,
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1591
         "tooltip" : "Clean project build folder",
105
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
  1592
         "method" : "_Clean"},
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1593
        {"bitmap" : opjimg("Run"),
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1594
         "name" : "Run",
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1595
         "shown" : False,
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1596
         "tooltip" : "Start PLC",
105
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
  1597
         "method" : "_Run"},
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1598
        {"bitmap" : opjimg("Debug"),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1599
         "name" : "Debug",
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1600
         "shown" : False,
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1601
         "tooltip" : "Start PLC (debug mode)",
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1602
         "method" : "_Debug"},
235
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1603
#        {"bitmap" : opjimg("Debug"),
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1604
#         "name" : "Do_Test_Debug",
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1605
#         "tooltip" : "Test debug mode)",
a66e150f2888 Improved debug data feedback.
etisserant
parents: 228
diff changeset
  1606
#         "method" : "_Do_Test_Debug"},
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1607
        {"bitmap" : opjimg("Stop"),
105
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
  1608
         "name" : "Stop",
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1609
         "shown" : False,
105
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
  1610
         "tooltip" : "Stop Running PLC",
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
  1611
         "method" : "_Stop"},
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1612
        {"bitmap" : opjimg("Connect"),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1613
         "name" : "Connect",
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1614
         "tooltip" : "Connect to the target PLC",
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1615
         "method" : "_Connect"},
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1616
        {"bitmap" : opjimg("Transfer"),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1617
         "name" : "Transfer",
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1618
         "shown" : False,
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1619
         "tooltip" : "Transfer PLC",
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1620
         "method" : "_Transfer"},
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1621
        {"bitmap" : opjimg("Disconnect"),
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1622
         "name" : "Disconnect",
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1623
         "shown" : False,
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1624
         "tooltip" : "Disconnect from PLC",
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1625
         "method" : "_Disconnect"},
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1626
        {"bitmap" : opjimg("ShowIECcode"),
199
aa5f43bafad4 minor gui improvements :
etisserant
parents: 190
diff changeset
  1627
         "name" : "Show code",
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1628
         "shown" : False,
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1629
         "tooltip" : "Show IEC code generated by PLCGenerator",
105
434aed8dc58d Added ability to override plugin methods with arbitrary python code (methods.py) when loading plugins
etisserant
parents: 97
diff changeset
  1630
         "method" : "_showIECcode"},
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1631
        {"bitmap" : opjimg("editIECrawcode"),
199
aa5f43bafad4 minor gui improvements :
etisserant
parents: 190
diff changeset
  1632
         "name" : "Append code",
74
8a726a62fbfc Some bugs fixed
lbessard
parents: 66
diff changeset
  1633
         "tooltip" : "Edit raw IEC code added to code generated by PLCGenerator",
203
cb9901076a21 Added concepts :
etisserant
parents: 202
diff changeset
  1634
         "method" : "_editIECrawcode"},
65
e55d6faee9d1 Adding icons in Beremiz GUI
lbessard
parents: 64
diff changeset
  1635
    ]