etisserant@14: """
etisserant@14: Base definitions for beremiz plugins
etisserant@14: """
etisserant@14:
etisserant@20: import os,sys
lbessard@17: import plugins
etisserant@14: import types
etisserant@14: import shutil
etisserant@14: from xml.dom import minidom
etisserant@22: import wx
etisserant@20:
etisserant@20: #Quick hack to be able to find Beremiz IEC tools. Should be config params.
etisserant@20: base_folder = os.path.split(sys.path[0])[0]
etisserant@20: sys.path.append(os.path.join(base_folder, "plcopeneditor"))
etisserant@20:
etisserant@14: from xmlclass import GenerateClassesFromXSDstring
etisserant@14:
etisserant@14: _BaseParamsClass = GenerateClassesFromXSDstring("""
etisserant@14:
etisserant@14:
etisserant@14:
etisserant@14:
lbessard@17:
etisserant@14:
etisserant@14:
etisserant@14:
etisserant@14: """)[0]["BaseParams"]
etisserant@14:
etisserant@14: NameTypeSeparator = '@'
etisserant@14:
etisserant@14: class PlugTemplate:
etisserant@14: """
etisserant@14: This class is the one that define plugins.
etisserant@14: """
etisserant@14:
etisserant@14: XSD = None
etisserant@14: PlugChildsTypes = []
etisserant@14: PlugMaxCount = None
etisserant@14: PluginMethods = []
etisserant@14:
etisserant@14: def _AddParamsMembers(self):
etisserant@14: Classes = GenerateClassesFromXSDstring(self.XSD)[0]
lbessard@19: self.PlugParams = None
lbessard@17: Classes = [(name, XSDclass) for name, XSDclass in Classes.items() if XSDclass.IsBaseClass]
lbessard@17: if len(Classes) == 1:
lbessard@17: name, XSDclass = Classes[0]
lbessard@17: obj = XSDclass()
lbessard@17: self.PlugParams = (name, obj)
lbessard@17: setattr(self, name, obj)
lbessard@17:
lbessard@17: def __init__(self):
etisserant@14: # Create BaseParam
etisserant@14: self.BaseParams = _BaseParamsClass()
lbessard@17: self.MandatoryParams = ("BaseParams", self.BaseParams)
etisserant@14: self._AddParamsMembers()
etisserant@14: self.PluggedChilds = {}
lbessard@17:
lbessard@17: def PluginBaseXmlFilePath(self, PlugName=None):
lbessard@17: return os.path.join(self.PlugPath(PlugName), "baseplugin.xml")
etisserant@14:
etisserant@14: def PluginXmlFilePath(self, PlugName=None):
etisserant@14: return os.path.join(self.PlugPath(PlugName), "plugin.xml")
etisserant@14:
etisserant@14: def PlugPath(self,PlugName=None):
etisserant@14: if not PlugName:
etisserant@14: PlugName = self.BaseParams.getName()
etisserant@14: return os.path.join(self.PlugParent.PlugPath(), PlugName + NameTypeSeparator + self.PlugType)
etisserant@14:
etisserant@14: def PlugTestModified(self):
etisserant@14: return False
etisserant@14:
etisserant@14: def OnPlugSave(self):
etisserant@20: #Default, do nothing and return success
etisserant@14: return True
etisserant@14:
lbessard@19: def GetParamsAttributes(self, path = None):
lbessard@19: if path:
lbessard@19: parts = path.split(".", 1)
lbessard@19: if self.MandatoryParams and parts[0] == self.MandatoryParams[0]:
lbessard@19: return self.MandatoryParams[1].getElementInfos(parts[0], parts[1])
lbessard@19: elif self.PlugParams and parts[0] == self.PlugParams[0]:
lbessard@19: return self.PlugParams[1].getElementInfos(parts[0], parts[1])
lbessard@17: else:
lbessard@19: params = []
lbessard@19: if self.MandatoryParams:
lbessard@19: params.append(self.MandatoryParams[1].getElementInfos(self.MandatoryParams[0]))
lbessard@19: if self.PlugParams:
lbessard@19: params.append(self.PlugParams[1].getElementInfos(self.PlugParams[0]))
lbessard@19: return params
lbessard@19:
lbessard@19: def SetParamsAttribute(self, path, value):
lbessard@19: parts = path.split(".", 1)
lbessard@19: if self.MandatoryParams and parts[0] == self.MandatoryParams[0]:
lbessard@19: self.MandatoryParams[1].setElementValue(parts[1], value)
lbessard@19: elif self.PlugParams and parts[0] == self.PlugParams[0]:
lbessard@19: self.PlugParams[1].setElementValue(parts[1], value)
lbessard@17:
etisserant@14: def PlugRequestSave(self):
etisserant@14: # If plugin do not have corresponding directory
lbessard@17: plugpath = self.PlugPath()
lbessard@17: if not os.path.isdir(plugpath):
etisserant@14: # Create it
lbessard@17: os.mkdir(plugpath)
lbessard@17:
lbessard@17: # generate XML for base XML parameters controller of the plugin
etisserant@20: if self.MandatoryParams:
etisserant@20: BaseXMLFile = open(self.PluginBaseXmlFilePath(),'w')
lbessard@17: BaseXMLFile.write("\n")
lbessard@17: BaseXMLFile.write(self.MandatoryParams[1].generateXMLText(self.MandatoryParams[0], 0))
lbessard@17: BaseXMLFile.close()
lbessard@17:
lbessard@17: # generate XML for XML parameters controller of the plugin
etisserant@20: if self.PlugParams:
etisserant@20: XMLFile = open(self.PluginXmlFilePath(),'w')
lbessard@17: XMLFile.write("\n")
lbessard@17: XMLFile.write(self.PlugParams[1].generateXMLText(self.PlugParams[0], 0))
lbessard@17: XMLFile.close()
etisserant@14:
etisserant@14: # Call the plugin specific OnPlugSave method
lbessard@17: result = self.OnPlugSave()
lbessard@17: if not result:
lbessard@17: return "Error while saving \"%s\""%self.PlugPath()
etisserant@14:
etisserant@14: # go through all childs and do the same
etisserant@14: for PlugChild in self.IterChilds():
lbessard@17: result = PlugChild.PlugRequestSave()
lbessard@17: if result:
lbessard@17: return result
lbessard@17: return None
etisserant@14:
etisserant@14: def PlugImport(self, src_PlugPath):
etisserant@14: shutil.copytree(src_PlugPath, self.PlugPath)
etisserant@14: return True
etisserant@14:
etisserant@18: def PlugGenerate_C(self, buildpath, current_location, locations, logger):
etisserant@14: """
etisserant@14: Generate C code
etisserant@14: @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5)
etisserant@14: @param locations: List of complete variables locations \
etisserant@22: [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)
etisserant@22: "NAME" : name of the variable (generally "__IW0_1_2" style)
etisserant@22: "DIR" : direction "Q","I" or "M"
etisserant@22: "SIZE" : size "X", "B", "W", "D", "L"
etisserant@22: "LOC" : tuple of interger for IEC location (0,1,2,...)
etisserant@22: }, ...]
etisserant@18: @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND
etisserant@18: """
etisserant@22: logger.write_warning(".".join(map(lambda x:str(x), current_location)) + " -> Nothing yo do\n")
etisserant@14: return [],""
etisserant@14:
etisserant@18: def _Generate_C(self, buildpath, current_location, locations, logger):
etisserant@14: # Generate plugins [(Cfiles, CFLAGS)], LDFLAGS
etisserant@18: PlugCFilesAndCFLAGS, PlugLDFLAGS = self.PlugGenerate_C(buildpath, current_location, locations, logger)
etisserant@14: # recurse through all childs, and stack their results
etisserant@14: for PlugChild in self.IterChilds():
etisserant@18: # Compute child's IEC location
etisserant@16: new_location = current_location + (self.BaseParams.getIEC_Channel())
etisserant@14: # Get childs [(Cfiles, CFLAGS)], LDFLAGS
etisserant@14: CFilesAndCFLAGS, LDFLAGS = \
etisserant@14: PlugChild._Generate_C(
etisserant@14: #keep the same path
etisserant@14: buildpath,
etisserant@14: # but update location (add curent IEC channel at the end)
etisserant@16: new_location,
etisserant@14: # filter locations that start with current IEC location
etisserant@22: [loc for loc in locations if loc["LOC"][0:len(new_location)] == new_location ],
etisserant@18: #propagete logger
etisserant@18: logger)
etisserant@14: # stack the result
etisserant@14: PlugCFilesAndCFLAGS += CFilesAndCFLAGS
etisserant@14: PlugLDFLAGS += LDFLAGS
etisserant@14:
etisserant@14: return PlugCFilesAndCFLAGS,PlugLDFLAGS
etisserant@14:
etisserant@14: def BlockTypesFactory(self):
etisserant@14: return []
etisserant@14:
etisserant@14: def STLibraryFactory(self):
etisserant@14: return ""
etisserant@14:
etisserant@14: def IterChilds(self):
etisserant@14: for PlugType, PluggedChilds in self.PluggedChilds.items():
etisserant@14: for PlugInstance in PluggedChilds:
etisserant@14: yield PlugInstance
etisserant@14:
etisserant@14: def _GetChildBySomething(self, sep, something, matching):
etisserant@14: toks = matching.split(sep,1)
lbessard@17: for PlugInstance in self.IterChilds():
etisserant@14: # if match component of the name
etisserant@14: if getattr(PlugInstance.BaseParams, something) == toks[0]:
etisserant@14: # if Name have other components
etisserant@14: if len(toks) == 2:
etisserant@14: # Recurse in order to find the latest object
etisserant@14: return PlugInstance._GetChildBySomething( sep, something, toks[1])
etisserant@14: # No sub name -> found
etisserant@14: return PlugInstance
etisserant@14: # Not found
etisserant@14: return None
etisserant@14:
etisserant@14: def GetChildByName(self, Name):
etisserant@14: return self._GetChildBySomething('.',"Name", Name)
etisserant@14:
etisserant@14: def GetChildByIECLocation(self, Location):
etisserant@14: return self._GetChildBySomething('_',"IEC_Channel", Name)
etisserant@14:
lbessard@17: def GetPlugInfos(self):
lbessard@17: childs = []
lbessard@17: for child in self.IterChilds():
lbessard@17: childs.append(child.GetPlugInfos())
lbessard@17: return {"name" : self.BaseParams.getName(), "type" : None, "values" : childs}
lbessard@17:
etisserant@14: def FindNewIEC_Channel(self, DesiredChannel):
etisserant@14: """
etisserant@14: Changes IEC Channel number to DesiredChannel if available, nearest available if not.
etisserant@14: @param DesiredChannel: The desired IEC channel (int)
etisserant@14: """
etisserant@14: # Get Current IEC channel
etisserant@14: CurrentChannel = self.BaseParams.getIEC_Channel()
etisserant@14: # Do nothing if no change
etisserant@14: if CurrentChannel == DesiredChannel: return CurrentChannel
etisserant@14: # Build a list of used Channels out of parent's PluggedChilds
etisserant@14: AllChannels=[]
etisserant@14: for PlugInstance in self.PlugParent.IterChilds():
etisserant@14: if PlugInstance != self:
etisserant@14: AllChannels.append(PlugInstance.BaseParams.getIEC_Channel())
etisserant@14: AllChannels.sort()
etisserant@14:
etisserant@14: # Now, try to guess the nearest available channel
etisserant@14: res = DesiredChannel
etisserant@14: while res in AllChannels: # While channel not free
etisserant@14: if res < CurrentChannel: # Want to go down ?
etisserant@14: res -= 1 # Test for n-1
etisserant@14: if res < 0 : return CurrentChannel # Can't go bellow 0, do nothing
etisserant@14: else : # Want to go up ?
etisserant@14: res += 1 # Test for n-1
etisserant@14: # Finally set IEC Channel
etisserant@14: self.BaseParams.setIEC_Channel(res)
etisserant@14: return res
etisserant@14:
etisserant@14: def OnPlugClose(self):
etisserant@14: return True
etisserant@14:
etisserant@14: def _doRemoveChild(self, PlugInstance):
etisserant@14: # Remove all childs of child
etisserant@14: for SubPlugInstance in PlugInstance.IterChilds():
etisserant@14: PlugInstance._doRemoveChild(SubPlugInstance)
etisserant@14: # Call the OnCloseMethod
etisserant@14: PlugInstance.OnPlugClose()
etisserant@14: # Delete plugin dir
etisserant@14: shutil.rmtree(PlugInstance.PlugPath())
etisserant@14: # Remove child of PluggedChilds
etisserant@14: self.PluggedChilds[PlugInstance.PlugType].remove(PlugInstance)
etisserant@14: # Forget it... (View have to refresh)
etisserant@14:
etisserant@14: def PlugRemoveChild(self, PlugName):
etisserant@14: # Fetch the plugin
etisserant@14: PlugInstance = self.GetChildByName(PlugName)
etisserant@14: # Ask to his parent to remove it
etisserant@14: PlugInstance.PlugParent._doRemoveChild(PlugInstance)
etisserant@14:
etisserant@14: def PlugAddChild(self, PlugName, PlugType):
etisserant@14: """
etisserant@14: Create the plugins that may be added as child to this node self
etisserant@14: @param PlugType: string desining the plugin class name (get name from PlugChildsTypes)
etisserant@14: @param PlugName: string for the name of the plugin instance
etisserant@14: """
etisserant@14: PlugChildsTypes = dict(self.PlugChildsTypes)
etisserant@14: # Check that adding this plugin is allowed
etisserant@14: try:
etisserant@14: PlugClass = PlugChildsTypes[PlugType]
etisserant@14: except KeyError:
etisserant@14: raise Exception, "Cannot create child %s of type %s "%(PlugName, PlugType)
etisserant@14:
etisserant@14: # if PlugClass is a class factory, call it. (prevent unneeded imports)
etisserant@14: if type(PlugClass) == types.FunctionType:
etisserant@14: PlugClass = PlugClass()
etisserant@14:
etisserant@14: # Eventualy Initialize child instance list for this class of plugin
lbessard@17: PluggedChildsWithSameClass = self.PluggedChilds.setdefault(PlugType, list())
etisserant@14: # Check count
lbessard@17: if getattr(PlugClass, "PlugMaxCount", None) and len(PluggedChildsWithSameClass) >= PlugClass.PlugMaxCount:
lbessard@17: raise Exception, "Max count (%d) reached for this plugin of type %s "%(PlugClass.PlugMaxCount, PlugType)
etisserant@14:
etisserant@14: # create the final class, derived of provided plugin and template
etisserant@14: class FinalPlugClass(PlugClass, PlugTemplate):
etisserant@14: """
etisserant@14: Plugin class is derivated into FinalPlugClass before being instanciated
etisserant@14: This way __init__ is overloaded to ensure PlugTemplate.__init__ is called
etisserant@14: before PlugClass.__init__, and to do the file related stuff.
etisserant@14: """
etisserant@14: def __init__(_self):
etisserant@14: # self is the parent
etisserant@14: _self.PlugParent = self
etisserant@14: # Keep track of the plugin type name
etisserant@14: _self.PlugType = PlugType
etisserant@14: # Call the base plugin template init - change XSD into class members
etisserant@14: PlugTemplate.__init__(_self)
etisserant@14: # If dir have already be made, and file exist
etisserant@14: if os.path.isdir(_self.PlugPath(PlugName)) and os.path.isfile(_self.PluginXmlFilePath(PlugName)):
etisserant@14: #Load the plugin.xml file into parameters members
lbessard@17: _self.LoadXMLParams(PlugName)
etisserant@20: # Basic check. Better to fail immediately.
etisserant@20: if (_self.BaseParams.getName() != PlugName):
etisserant@20: raise Exception, "Project tree layout do not match plugin.xml %s!=%s "%(PlugName, _self.BaseParams.getName())
etisserant@20:
etisserant@20: # Now, self.PlugPath() should be OK
etisserant@20:
etisserant@15: # Check that IEC_Channel is not already in use.
etisserant@20: _self.FindNewIEC_Channel(_self.BaseParams.getIEC_Channel())
etisserant@14: # Call the plugin real __init__
lbessard@17: if getattr(PlugClass, "__init__", None):
lbessard@17: PlugClass.__init__(_self)
etisserant@14: #Load and init all the childs
etisserant@14: _self.LoadChilds()
etisserant@14: else:
etisserant@14: # If plugin do not have corresponding file/dirs - they will be created on Save
etisserant@14: # Set plugin name
etisserant@14: _self.BaseParams.setName(PlugName)
lbessard@17: os.mkdir(_self.PlugPath())
etisserant@14: # Find an IEC number
etisserant@14: _self.FindNewIEC_Channel(0)
etisserant@14: # Call the plugin real __init__
lbessard@17: if getattr(PlugClass, "__init__", None):
lbessard@17: PlugClass.__init__(_self)
lbessard@17: _self.PlugRequestSave()
etisserant@14:
etisserant@14: # Create the object out of the resulting class
etisserant@14: newPluginOpj = FinalPlugClass()
etisserant@14: # Store it in PluggedChils
etisserant@14: PluggedChildsWithSameClass.append(newPluginOpj)
etisserant@14:
etisserant@14: return newPluginOpj
etisserant@14:
etisserant@14:
etisserant@20: def LoadXMLParams(self, PlugName = None):
lbessard@17: # Get the base xml tree
etisserant@20: if self.MandatoryParams:
etisserant@20: basexmlfile = open(self.PluginBaseXmlFilePath(PlugName), 'r')
lbessard@17: basetree = minidom.parse(basexmlfile)
lbessard@17: self.MandatoryParams[1].loadXMLTree(basetree.childNodes[0])
lbessard@17: basexmlfile.close()
lbessard@17:
etisserant@14: # Get the xml tree
etisserant@20: if self.PlugParams:
etisserant@20: xmlfile = open(self.PluginXmlFilePath(PlugName), 'r')
lbessard@17: tree = minidom.parse(xmlfile)
lbessard@17: self.PlugParams[1].loadXMLTree(tree.childNodes[0])
lbessard@17: xmlfile.close()
lbessard@17:
etisserant@14: def LoadChilds(self):
etisserant@14: # Iterate over all PlugName@PlugType in plugin directory, and try to open them
etisserant@14: for PlugDir in os.listdir(self.PlugPath()):
lbessard@17: if os.path.isdir(os.path.join(self.PlugPath(), PlugDir)) and \
etisserant@14: PlugDir.count(NameTypeSeparator) == 1:
etisserant@14: try:
lbessard@17: self.PlugAddChild(*PlugDir.split(NameTypeSeparator))
etisserant@14: except Exception, e:
etisserant@14: print e
etisserant@13:
lbessard@17: def _GetClassFunction(name):
lbessard@17: def GetRootClass():
lbessard@17: return getattr(__import__("plugins." + name), name).RootClass
lbessard@17: return GetRootClass
lbessard@17:
etisserant@20:
etisserant@20: ####################################################################################
etisserant@20: ####################################################################################
etisserant@20: ####################################################################################
etisserant@20: ################################### ROOT ######################################
etisserant@20: ####################################################################################
etisserant@20: ####################################################################################
etisserant@20: ####################################################################################
etisserant@20:
etisserant@20: iec2cc_path = os.path.join(base_folder, "matiec", "iec2cc")
etisserant@20: ieclib_path = os.path.join(base_folder, "matiec", "lib")
etisserant@20:
etisserant@20: # import for project creation timestamping
etisserant@20: from time import localtime
etisserant@20: from datetime import datetime
etisserant@20: # import necessary stuff from PLCOpenEditor
etisserant@20: from PLCControler import PLCControler
etisserant@20: from PLCOpenEditor import PLCOpenEditor, ProjectDialog
etisserant@20: from TextViewer import TextViewer
etisserant@20: from plcopen.structures import IEC_KEYWORDS
etisserant@22: import re
etisserant@20:
etisserant@13: class PluginsRoot(PlugTemplate):
etisserant@20: """
etisserant@20: This class define Root object of the plugin tree.
etisserant@20: It is responsible of :
etisserant@20: - Managing project directory
etisserant@20: - Building project
etisserant@20: - Handling PLCOpenEditor controler and view
etisserant@20: - Loading user plugins and instanciante them as childs
etisserant@20: - ...
etisserant@20:
etisserant@20: """
etisserant@13:
etisserant@14: # For root object, available Childs Types are modules of the plugin packages.
lbessard@17: PlugChildsTypes = [(name, _GetClassFunction(name)) for name in plugins.__all__]
etisserant@13:
etisserant@13: XSD = """
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
lbessard@17:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@14:
lbessard@17:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@14:
lbessard@17:
lbessard@17:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
lbessard@17:
lbessard@17:
lbessard@17:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
lbessard@17:
lbessard@17:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13:
etisserant@13: """
etisserant@13:
etisserant@20: def __init__(self, frame):
etisserant@20:
etisserant@20: self.MandatoryParams = None
etisserant@20: self.AppFrame = frame
etisserant@20:
etisserant@20: """
etisserant@20: This method are not called here... but in NewProject and OpenProject
etisserant@20: self._AddParamsMembers()
etisserant@20: self.PluggedChilds = {}
etisserant@20: """
etisserant@20:
etisserant@13: # self is the parent
etisserant@13: self.PlugParent = None
etisserant@13: # Keep track of the plugin type name
etisserant@13: self.PlugType = "Beremiz"
lbessard@17:
etisserant@20: # After __init__ root plugin is not valid
etisserant@20: self.ProjectPath = None
lbessard@17: self.PLCManager = None
etisserant@20: self.PLCEditor = None
lbessard@17:
lbessard@17: def HasProjectOpened(self):
lbessard@17: """
lbessard@17: Return if a project is actually opened
lbessard@17: """
etisserant@20: return self.ProjectPath != None
lbessard@17:
lbessard@17: def GetProjectPath(self):
lbessard@17: return self.ProjectPath
lbessard@17:
etisserant@20: def GetPlugInfos(self):
etisserant@20: childs = []
etisserant@20: for child in self.IterChilds():
etisserant@20: childs.append(child.GetPlugInfos())
etisserant@20: return {"name" : os.path.split(self.ProjectPath)[1], "type" : None, "values" : childs}
etisserant@20:
etisserant@20: def NewProject(self, ProjectPath):
lbessard@17: """
lbessard@17: Create a new project in an empty folder
lbessard@17: @param ProjectPath: path of the folder where project have to be created
lbessard@17: @param PLCParams: properties of the PLCOpen program created
lbessard@17: """
lbessard@17: # Verify that choosen folder is empty
lbessard@17: if not os.path.isdir(ProjectPath) or len(os.listdir(ProjectPath)) > 0:
lbessard@17: return "Folder choosen isn't empty. You can't use it for a new project!"
etisserant@20:
etisserant@20: dialog = ProjectDialog(self.AppFrame)
etisserant@20: if dialog.ShowModal() == wx.ID_OK:
etisserant@20: values = dialog.GetValues()
etisserant@20: values["creationDateTime"] = datetime(*localtime()[:6])
etisserant@20: dialog.Destroy()
etisserant@20: else:
etisserant@20: dialog.Destroy()
etisserant@20: return "Project not created"
etisserant@20:
lbessard@17: # Create Controler for PLCOpen program
lbessard@17: self.PLCManager = PLCControler()
etisserant@22: self.PLCManager.CreateNewProject(values.pop("projectName"))
etisserant@22: self.PLCManager.SetProjectProperties(properties = values)
etisserant@13: # Change XSD into class members
etisserant@13: self._AddParamsMembers()
etisserant@13: self.PluggedChilds = {}
lbessard@17: # Keep track of the root plugin (i.e. project path)
lbessard@17: self.ProjectPath = ProjectPath
lbessard@17: return None
lbessard@17:
lbessard@17: def LoadProject(self, ProjectPath):
lbessard@17: """
lbessard@17: Load a project contained in a folder
lbessard@17: @param ProjectPath: path of the project folder
lbessard@17: """
lbessard@17: # Verify that project contains a PLCOpen program
lbessard@17: plc_file = os.path.join(ProjectPath, "plc.xml")
lbessard@17: if not os.path.isfile(plc_file):
lbessard@17: return "Folder choosen doesn't contain a program. It's not a valid project!"
lbessard@17: # Create Controler for PLCOpen program
lbessard@17: self.PLCManager = PLCControler()
lbessard@17: # Load PLCOpen file
lbessard@17: result = self.PLCManager.OpenXMLFile(plc_file)
lbessard@17: if result:
lbessard@17: return result
lbessard@17: # Change XSD into class members
lbessard@17: self._AddParamsMembers()
lbessard@17: self.PluggedChilds = {}
lbessard@17: # Keep track of the root plugin (i.e. project path)
lbessard@17: self.ProjectPath = ProjectPath
etisserant@13: # If dir have already be made, and file exist
lbessard@17: if os.path.isdir(self.PlugPath()) and os.path.isfile(self.PluginXmlFilePath()):
etisserant@13: #Load the plugin.xml file into parameters members
etisserant@20: result = self.LoadXMLParams()
lbessard@17: if result:
lbessard@17: return result
etisserant@13: #Load and init all the childs
lbessard@17: self.LoadChilds()
lbessard@17: return None
lbessard@17:
lbessard@17: def SaveProject(self):
lbessard@17: if not self.PLCManager.SaveXMLFile():
lbessard@17: self.PLCManager.SaveXMLFile(os.path.join(self.ProjectPath, 'plc.xml'))
lbessard@17: self.PlugRequestSave()
lbessard@17:
lbessard@17: def PlugPath(self, PlugName=None):
etisserant@13: return self.ProjectPath
lbessard@17:
etisserant@13: def PluginXmlFilePath(self, PlugName=None):
etisserant@13: return os.path.join(self.PlugPath(PlugName), "beremiz.xml")
etisserant@18:
etisserant@18: def PlugGenerate_C(self, buildpath, current_location, locations, logger):
etisserant@18: """
etisserant@18: Generate C code
etisserant@18: @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5)
etisserant@18: @param locations: List of complete variables locations \
etisserant@18: [(IEC_loc, IEC_Direction, IEC_Type, Name)]\
etisserant@18: ex: [((0,0,4,5),'I','STRING','__IX_0_0_4_5'),...]
etisserant@18: @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND
etisserant@18: """
etisserant@18: return [(C_file_name, "") for C_file_name in self.PLCGeneratedCFiles ] , ""
etisserant@20:
etisserant@20: def _getBuildPath(self):
etisserant@20: return os.path.join(self.ProjectPath, "build")
etisserant@20:
etisserant@20: def _getIECcodepath(self):
etisserant@20: # define name for IEC code file
etisserant@20: return os.path.join(self._getBuildPath(), "plc.st")
etisserant@20:
etisserant@20: def _Generate_SoftPLC(self, logger):
etisserant@20: """
etisserant@20: Generate SoftPLC ST/IL/SFC code out of PLCOpenEditor controller, and compile it with IEC2CC
etisserant@20: @param buildpath: path where files should be created
etisserant@20: @param logger: the log pseudo file
etisserant@20: """
etisserant@20:
etisserant@20: logger.write("Generating SoftPLC IEC-61131 ST/IL/SFC code...\n")
etisserant@20: buildpath = self._getBuildPath()
etisserant@20: # define name for IEC code file
etisserant@20: plc_file = self._getIECcodepath()
etisserant@20: # ask PLCOpenEditor controller to write ST/IL/SFC code file
etisserant@20: result = self.PLCManager.GenerateProgram(plc_file)
etisserant@20: if not result:
etisserant@20: # Failed !
etisserant@22: logger.write_error("Error : ST/IL/SFC code generator returned %d\n"%result)
etisserant@20: return False
etisserant@20: logger.write("Compiling ST Program in to C Program...\n")
etisserant@20: # Now compile IEC code into many C files
etisserant@20: # files are listed to stdout, and errors to stderr.
etisserant@22: status, result, err_result = logger.LogCommand("%s %s -I %s %s"%(iec2cc_path, plc_file, ieclib_path, buildpath))
etisserant@20: if status:
etisserant@20: # Failed !
etisserant@22: logger.write_error("Error : IEC to C compiler returned %d\n"%status)
etisserant@20: return False
etisserant@20: # Now extract C files of stdout
etisserant@20: C_files = result.splitlines()
etisserant@20: # remove those that are not to be compiled because included by others
etisserant@20: C_files.remove("POUS.c")
etisserant@20: C_files.remove("LOCATED_VARIABLES.h")
etisserant@20: # transform those base names to full names with path
etisserant@20: C_files = map(lambda filename:os.path.join(self.TargetDir, filename), C_files)
etisserant@20: logger.write("Extracting Located Variables...\n")
etisserant@20: # IEC2CC compiler generate a list of located variables : LOCATED_VARIABLES.h
etisserant@20: location_file = open(os.path.join(buildpath,"LOCATED_VARIABLES.h"))
etisserant@20: locations = []
etisserant@20: # each line of LOCATED_VARIABLES.h declares a located variable
etisserant@20: lines = [line.strip() for line in location_file.readlines()]
etisserant@20: # This regular expression parses the lines genereated by IEC2CC
etisserant@18: LOCATED_MODEL = re.compile("__LOCATED_VAR\((?P[A-Z]*),(?P[_A-Za-z0-9]*),(?P[QMI])(?:,(?P[XBWD]))?,(?P[,0-9]*)\)")
etisserant@20: for line in lines:
etisserant@20: # If line match RE,
etisserant@20: result = LOCATED_MODEL.match(line)
etisserant@20: if result:
etisserant@20: # Get the resulting dict
etisserant@20: resdict = result.groupdict()
etisserant@20: # rewrite string for variadic location as a tuple of integers
etisserant@20: resdict['LOC'] = tuple(map(int,resdict['LOC'].split(',')))
etisserant@20: # set located size to 'X' if not given
etisserant@20: if not resdict['SIZE']:
etisserant@20: resdict['SIZE'] = 'X'
etisserant@20: # finally store into located variable list
etisserant@20: locations.append(resdict)
etisserant@20: # Keep track of generated C files for later use by self.PlugGenerate_C
etisserant@18: self.PLCGeneratedCFiles = C_files
etisserant@20: # Keep track of generated located variables for later use by self._Generate_C
etisserant@18: self.PLCGeneratedLocatedVars = locations
etisserant@18: return True
etisserant@18:
etisserant@18: def _build(self, logger):
etisserant@20: """
etisserant@20: Method called by user to (re)build SoftPLC and plugin tree
etisserant@20: """
etisserant@20: buildpath = self._getBuildPath()
etisserant@20:
etisserant@20: # Eventually create build dir
etisserant@18: if not os.path.exists(buildpath):
etisserant@18: os.mkdir(buildpath)
etisserant@18:
etisserant@22: logger.write("Start build in %s\n" % buildpath)
etisserant@18:
etisserant@20: # Generate SoftPLC code
etisserant@20: if not self._Generate_SoftPLC(logger):
etisserant@22: logger.write_error("SoftPLC code generation failed !\n")
etisserant@20: return False
etisserant@20:
etisserant@22: logger.write("SoftPLC code generation successfull\n")
etisserant@18:
etisserant@20: # Generate C code and compilation params from plugin hierarchy
etisserant@18: try:
etisserant@18: CFilesAndCFLAGS, LDFLAGS = self._Generate_C(
etisserant@18: buildpath,
etisserant@18: (),
etisserant@18: self.PLCGeneratedLocatedVars,
etisserant@18: logger)
etisserant@18: except Exception, msg:
etisserant@22: logger.write_error("Plugins code generation Failed !\n")
etisserant@18: logger.write_error(str(msg))
etisserant@20: return False
etisserant@18:
etisserant@22: logger.write("Plugins code generation successfull\n")
etisserant@20:
etisserant@20: # Compile the resulting code into object files.
etisserant@18: for CFile, CFLAG in CFilesAndCFLAGS:
etisserant@22: logger.write(str((CFile,CFLAG)))
etisserant@18:
etisserant@20: # Link object files into something that can be executed on target
etisserant@22: logger.write(LDFLAGS)
etisserant@20:
etisserant@20: def _showIECcode(self, logger):
etisserant@20: plc_file = self._getIECcodepath()
etisserant@20: new_dialog = wx.Frame(None)
etisserant@20: ST_viewer = TextViewer(new_dialog, None, None)
etisserant@20: #ST_viewer.Enable(False)
etisserant@20: ST_viewer.SetKeywords(IEC_KEYWORDS)
etisserant@20: try:
etisserant@20: text = file(plc_file).read()
etisserant@20: except:
etisserant@20: text = '(* No IEC code have been generated at that time ! *)'
etisserant@20: ST_viewer.SetText(text)
etisserant@20:
etisserant@20: new_dialog.Show()
etisserant@20:
etisserant@20: def _EditPLC(self, logger):
etisserant@20: if not self.PLCEditor:
etisserant@22: self.PLCEditor = PLCOpenEditor(self.AppFrame, self.PLCManager)
etisserant@20: self.PLCEditor.RefreshProjectTree()
etisserant@20: self.PLCEditor.RefreshFileMenu()
etisserant@20: self.PLCEditor.RefreshEditMenu()
etisserant@20: self.PLCEditor.RefreshToolBar()
etisserant@20: self.PLCEditor.Show()
etisserant@20:
etisserant@22: def _Clean(self, logger):
etisserant@22: logger.write_error("Not impl\n")
etisserant@22:
etisserant@22: def _Run(self, logger):
etisserant@22: logger.write_error("Not impl\n")
etisserant@22:
etisserant@22: PluginMethods = [("EditPLC",_EditPLC), ("Build",_build), ("Clean",_Clean), ("Run",_Run), ("Show IEC code",_showIECcode)]
etisserant@22: