laurent@409: # -*- coding: utf-8 -*-
laurent@409: 
laurent@409: #This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor
laurent@409: #based on the plcopen standard. 
laurent@409: #
laurent@409: #Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
laurent@409: #
laurent@409: #See COPYING file for copyrights details.
laurent@409: #
laurent@409: #This library is free software; you can redistribute it and/or
laurent@409: #modify it under the terms of the GNU General Public
laurent@409: #License as published by the Free Software Foundation; either
laurent@409: #version 2.1 of the License, or (at your option) any later version.
laurent@409: #
laurent@409: #This library is distributed in the hope that it will be useful,
laurent@409: #but WITHOUT ANY WARRANTY; without even the implied warranty of
laurent@409: #MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
laurent@409: #General Public License for more details.
laurent@409: #
laurent@409: #You should have received a copy of the GNU General Public
laurent@409: #License along with this library; if not, write to the Free Software
laurent@409: #Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
laurent@409: 
laurent@409: import wx
laurent@409: 
laurent@409: from graphics import *
laurent@409: 
laurent@409: #-------------------------------------------------------------------------------
laurent@409: #                          Edit Step Content Dialog
laurent@409: #-------------------------------------------------------------------------------
laurent@409: 
laurent@409: [ID_SFCSTEPDIALOG, ID_SFCSTEPDIALOGSPACER, 
laurent@409:  ID_SFCSTEPDIALOGNAME, ID_SFCSTEPDIALOGPREVIEW, 
laurent@409:  ID_SFCSTEPDIALOGCHECKBOX1, ID_SFCSTEPDIALOGCHECKBOX2,
laurent@409:  ID_SFCSTEPDIALOGCHECKBOX3, ID_SFCSTEPDIALOGSTATICTEXT1, 
laurent@409:  ID_SFCSTEPDIALOGSTATICTEXT2, ID_SFCSTEPDIALOGSTATICTEXT3, 
laurent@409: ] = [wx.NewId() for _init_ctrls in range(10)]
laurent@409: 
laurent@409: class SFCStepDialog(wx.Dialog):
laurent@409:     
laurent@409:     if wx.VERSION < (2, 6, 0):
laurent@409:         def Bind(self, event, function, id = None):
laurent@409:             if id is not None:
laurent@409:                 event(self, id, function)
laurent@409:             else:
laurent@409:                 event(self, function)
laurent@409:     
laurent@409:     def _init_coll_flexGridSizer1_Items(self, parent):
laurent@409:         parent.AddSizer(self.MainSizer, 0, border=20, flag=wx.GROW|wx.TOP|wx.LEFT|wx.RIGHT)
laurent@409:         parent.AddSizer(self.ButtonSizer, 0, border=20, flag=wx.ALIGN_RIGHT|wx.BOTTOM|wx.LEFT|wx.RIGHT)
laurent@409:         
laurent@409:     def _init_coll_flexGridSizer1_Growables(self, parent):
laurent@409:         parent.AddGrowableCol(0)
laurent@409:         parent.AddGrowableRow(0)
laurent@409:     
laurent@409:     def _init_coll_MainSizer_Items(self, parent):
laurent@409:         parent.AddSizer(self.LeftGridSizer, 1, border=5, flag=wx.GROW|wx.RIGHT)
laurent@409:         parent.AddSizer(self.RightGridSizer, 1, border=5, flag=wx.GROW|wx.LEFT)
laurent@409:     
laurent@409:     def _init_coll_LeftGridSizer_Items(self, parent):
laurent@409:         parent.AddWindow(self.staticText1, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.StepName, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.staticText2, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.checkBox1, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.checkBox2, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.checkBox3, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.Spacer, 0, border=0, flag=wx.GROW)
laurent@409:         
laurent@409:     def _init_coll_LeftGridSizer_Growables(self, parent):
laurent@409:         parent.AddGrowableCol(0)
laurent@409:         parent.AddGrowableRow(6)
laurent@409:             
laurent@409:     def _init_coll_RightGridSizer_Items(self, parent):
laurent@409:         parent.AddWindow(self.staticText3, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.Preview, 0, border=0, flag=wx.GROW)
laurent@409:         
laurent@409:     def _init_coll_RightGridSizer_Growables(self, parent):
laurent@409:         parent.AddGrowableCol(0)
laurent@409:         parent.AddGrowableRow(1)
laurent@409: 
laurent@409:     def _init_sizers(self):
laurent@409:         self.flexGridSizer1 = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=10)
laurent@409:         self.MainSizer = wx.BoxSizer(wx.HORIZONTAL)
laurent@409:         self.LeftGridSizer = wx.FlexGridSizer(cols=1, hgap=0, rows=7, vgap=5)
laurent@409:         self.RightGridSizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=5)
laurent@409: 
laurent@409:         self._init_coll_flexGridSizer1_Items(self.flexGridSizer1)
laurent@409:         self._init_coll_flexGridSizer1_Growables(self.flexGridSizer1)
laurent@409:         self._init_coll_MainSizer_Items(self.MainSizer)
laurent@409:         self._init_coll_LeftGridSizer_Items(self.LeftGridSizer)
laurent@409:         self._init_coll_LeftGridSizer_Growables(self.LeftGridSizer)
laurent@409:         self._init_coll_RightGridSizer_Items(self.RightGridSizer)
laurent@409:         self._init_coll_RightGridSizer_Growables(self.RightGridSizer)
laurent@409: 
laurent@409:         self.SetSizer(self.flexGridSizer1)
laurent@409: 
laurent@409:     def _init_ctrls(self, prnt, ctrler):
laurent@409:         wx.Dialog.__init__(self, id=ID_SFCSTEPDIALOG,
laurent@534:               name='SFCStepDialog', parent=prnt,
laurent@409:               size=wx.Size(400, 250), style=wx.DEFAULT_DIALOG_STYLE,
laurent@409:               title=_('Edit Step'))
laurent@409:         self.SetClientSize(wx.Size(400, 250))
laurent@409: 
laurent@409:         self.staticText1 = wx.StaticText(id=ID_SFCSTEPDIALOGSTATICTEXT1,
laurent@409:               label=_('Name:'), name='staticText1', parent=self,
laurent@409:               pos=wx.Point(0, 0), size=wx.Size(0, 17), style=0)
laurent@409: 
laurent@409:         self.staticText2 = wx.StaticText(id=ID_SFCSTEPDIALOGSTATICTEXT2,
laurent@409:               label=_('Connectors:'), name='staticText2', parent=self,
laurent@409:               pos=wx.Point(0, 0), size=wx.Size(0, 17), style=0)
laurent@409: 
laurent@409:         self.staticText3 = wx.StaticText(id=ID_SFCSTEPDIALOGSTATICTEXT3,
laurent@409:               label=_('Preview:'), name='staticText4', parent=self,
laurent@409:               pos=wx.Point(0, 0), size=wx.Size(0, 17), style=0)
laurent@409: 
laurent@409:         self.StepName = wx.TextCtrl(id=ID_SFCSTEPDIALOGNAME,
laurent@409:               name='Name', parent=self, pos=wx.Point(0, 0),
laurent@409:               size=wx.Size(0, 24), style=0)
laurent@409:         self.Bind(wx.EVT_TEXT, self.OnNameChanged, id=ID_SFCSTEPDIALOGNAME)
laurent@409: 
laurent@409:         self.checkBox1 = wx.CheckBox(id=ID_SFCSTEPDIALOGCHECKBOX1,
laurent@409:               label=_("Input"), name='checkBox1', parent=self,
laurent@409:               pos=wx.Point(0, 0), size=wx.Size(0, 24), style=0)
laurent@409:         self.Bind(wx.EVT_CHECKBOX, self.OnConnectorsChanged, id=ID_SFCSTEPDIALOGCHECKBOX1)
laurent@409:         
laurent@409:         self.checkBox2 = wx.CheckBox(id=ID_SFCSTEPDIALOGCHECKBOX2,
laurent@409:               label=_("Output"), name='checkBox2', parent=self,
laurent@409:               pos=wx.Point(0, 0), size=wx.Size(0, 24), style=0)
laurent@409:         self.Bind(wx.EVT_CHECKBOX, self.OnConnectorsChanged, id=ID_SFCSTEPDIALOGCHECKBOX2)
laurent@409:         
laurent@409:         self.checkBox3 = wx.CheckBox(id=ID_SFCSTEPDIALOGCHECKBOX3,
laurent@409:               label=_("Action"), name='checkBox3', parent=self,
laurent@409:               pos=wx.Point(0, 0), size=wx.Size(0, 24), style=0)
laurent@409:         self.Bind(wx.EVT_CHECKBOX, self.OnConnectorsChanged, id=ID_SFCSTEPDIALOGCHECKBOX3)
laurent@409:         
laurent@409:         self.Spacer = wx.Panel(id=ID_SFCSTEPDIALOGSPACER,
laurent@409:               name='Spacer', parent=self, pos=wx.Point(0, 0),
laurent@409:               size=wx.Size(0, 0), style=wx.TAB_TRAVERSAL)
laurent@409: 
laurent@409:         self.Preview = wx.Panel(id=ID_SFCSTEPDIALOGPREVIEW,
laurent@409:               name='Preview', parent=self, pos=wx.Point(0, 0),
laurent@409:               size=wx.Size(0, 0), style=wx.TAB_TRAVERSAL|wx.SIMPLE_BORDER)
laurent@409:         self.Preview.SetBackgroundColour(wx.Colour(255,255,255))
laurent@409:         setattr(self.Preview, "GetDrawingMode", lambda:FREEDRAWING_MODE)
laurent@409:         setattr(self.Preview, "RefreshStepModel", lambda x:None)
laurent@409:         setattr(self.Preview, "GetScaling", lambda:None)
laurent@409:         setattr(self.Preview, "IsOfType", ctrler.IsOfType)
laurent@409: 
laurent@409:         self.ButtonSizer = self.CreateButtonSizer(wx.OK|wx.CANCEL|wx.CENTRE)
laurent@409:         if wx.VERSION >= (2, 5, 0):
laurent@409:             self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.ButtonSizer.GetAffirmativeButton().GetId())
laurent@409:             self.Preview.Bind(wx.EVT_PAINT, self.OnPaint)
laurent@409:         else:
laurent@409:             self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.ButtonSizer.GetChildren()[0].GetSizer().GetChildren()[0].GetWindow().GetId())
laurent@409:             wx.EVT_PAINT(self.Preview, self.OnPaint)
laurent@409:         
laurent@409:         self._init_sizers()
laurent@409: 
laurent@409:     def __init__(self, parent, controler, initial = False):
laurent@409:         self._init_ctrls(parent, controler)
laurent@409:         self.Step = None
laurent@409:         self.Initial = initial
laurent@409:         self.MinStepSize = None
laurent@409:     
laurent@409:         self.PouNames = []
laurent@409:         self.Variables = []
laurent@409:         self.StepNames = []
laurent@577:         
laurent@577:         self.StepName.SetFocus()
laurent@409:     
laurent@409:     def SetPreviewFont(self, font):
laurent@409:         self.Preview.SetFont(font)
laurent@409:     
laurent@409:     def OnOK(self, event):
laurent@409:         step_name = self.StepName.GetValue()
laurent@409:         if step_name == "":
laurent@409:             message = wx.MessageDialog(self, _("You must type a name!"), _("Error"), wx.OK|wx.ICON_ERROR)
laurent@409:             message.ShowModal()
laurent@409:             message.Destroy()
laurent@409:         elif not TestIdentifier(step_name):
laurent@409:             message = wx.MessageDialog(self, _("\"%s\" is not a valid identifier!")%step_name, _("Error"), wx.OK|wx.ICON_ERROR)
laurent@409:             message.ShowModal()
laurent@409:             message.Destroy()
laurent@409:         elif step_name.upper() in IEC_KEYWORDS:
laurent@409:             message = wx.MessageDialog(self, _("\"%s\" is a keyword. It can't be used!")%step_name, _("Error"), wx.OK|wx.ICON_ERROR)
laurent@409:             message.ShowModal()
laurent@409:             message.Destroy()
laurent@409:         elif step_name.upper() in self.PouNames:
laurent@446:             message = wx.MessageDialog(self, _("A POU named \"%s\" already exists!")%step_name, _("Error"), wx.OK|wx.ICON_ERROR)
laurent@409:             message.ShowModal()
laurent@409:             message.Destroy()
laurent@409:         elif step_name.upper() in self.Variables:
laurent@409:             message = wx.MessageDialog(self, _("A variable with \"%s\" as name already exists in this pou!")%step_name, _("Error"), wx.OK|wx.ICON_ERROR)
laurent@409:             message.ShowModal()
laurent@409:             message.Destroy()
laurent@409:         elif step_name.upper() in self.StepNames:
laurent@409:             message = wx.MessageDialog(self, _("\"%s\" step already exists!")%step_name, _("Error"), wx.OK|wx.ICON_ERROR)
laurent@409:             message.ShowModal()
laurent@409:             message.Destroy()
laurent@409:         else:
laurent@409:             self.EndModal(wx.ID_OK)
laurent@409:     
laurent@409:     def SetMinStepSize(self, size):
laurent@409:         self.MinStepSize = size
laurent@409: 
laurent@409:     def SetPouNames(self, pou_names):
laurent@409:         self.PouNames = [pou_name.upper() for pou_name in pou_names]
laurent@409: 
laurent@409:     def SetVariables(self, variables):
laurent@409:         self.Variables = [var["Name"].upper() for var in variables]
laurent@409: 
laurent@409:     def SetStepNames(self, step_names):
laurent@409:         self.StepNames = [step_name.upper() for step_name in step_names]
laurent@409: 
laurent@409:     def SetValues(self, values):
laurent@409:         value_name = values.get("name", None)
laurent@409:         if value_name:
laurent@409:             self.StepName.SetValue(value_name)
laurent@409:         else:
laurent@409:             self.StepName.SetValue("")
laurent@409:         self.checkBox1.SetValue(values.get("input", False))
laurent@409:         self.checkBox2.SetValue(values.get("output", False))
laurent@409:         self.checkBox3.SetValue(values.get("action", False))
laurent@409:         self.RefreshPreview()
laurent@409:         
laurent@409:     def GetValues(self):
laurent@409:         values = {}
laurent@409:         values["name"] = self.StepName.GetValue()
laurent@409:         values["input"] = self.checkBox1.IsChecked()
laurent@409:         values["output"] = self.checkBox2.IsChecked()
laurent@409:         values["action"] = self.checkBox3.IsChecked()
laurent@409:         values["width"], values["height"] = self.Step.GetSize()
laurent@409:         return values
laurent@409:     
laurent@409:     def OnConnectorsChanged(self, event):
laurent@409:         self.RefreshPreview()
laurent@409:         event.Skip()
laurent@409: 
laurent@409:     def OnNameChanged(self, event):
laurent@409:         self.RefreshPreview()
laurent@409:         event.Skip()
laurent@409:     
laurent@409:     def RefreshPreview(self):
laurent@409:         dc = wx.ClientDC(self.Preview)
laurent@409:         dc.SetFont(self.Preview.GetFont())
laurent@409:         dc.Clear()
laurent@409:         self.Step = SFC_Step(self.Preview, self.StepName.GetValue(), self.Initial)
laurent@409:         if self.checkBox1.IsChecked():
laurent@409:             self.Step.AddInput()
laurent@409:         else:
laurent@409:             self.Step.RemoveInput()
laurent@409:         if self.checkBox2.IsChecked():
laurent@409:             self.Step.AddOutput()
laurent@409:         else:
laurent@409:             self.Step.RemoveOutput()
laurent@409:         if self.checkBox3.IsChecked():
laurent@409:             self.Step.AddAction()    
laurent@409:         else:
laurent@409:             self.Step.RemoveAction()
laurent@409:         width, height = self.MinStepSize
laurent@409:         min_width, min_height = self.Step.GetMinSize()
laurent@409:         width, height = max(min_width, width), max(min_height, height)
laurent@409:         self.Step.SetSize(width, height)
laurent@409:         clientsize = self.Preview.GetClientSize()
laurent@409:         x = (clientsize.width - width) / 2
laurent@409:         y = (clientsize.height - height) / 2
laurent@409:         self.Step.SetPosition(x, y)
laurent@409:         self.Step.Draw(dc)
laurent@409: 
laurent@409:     def OnPaint(self, event):
laurent@409:         self.RefreshPreview()
laurent@409:         event.Skip()