laurent@409: #!/usr/bin/env python
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: #                          Create New Variable Dialog
laurent@409: #-------------------------------------------------------------------------------
laurent@409: 
laurent@409: [ID_FBDVARIABLEDIALOG, ID_FBDVARIABLEDIALOGSPACER, 
laurent@409:  ID_FBDVARIABLEDIALOGNAME, ID_FBDVARIABLEDIALOGCLASS, 
laurent@409:  ID_FBDVARIABLEDIALOGPREVIEW, ID_FBDVARIABLEDIALOGEXPRESSION,
laurent@409:  ID_FBDVARIABLEDIALOGEXECUTIONORDER, ID_FBDVARIABLEDIALOGSTATICTEXT1, 
laurent@409:  ID_FBDVARIABLEDIALOGSTATICTEXT2, ID_FBDVARIABLEDIALOGSTATICTEXT3, 
laurent@409:  ID_FBDVARIABLEDIALOGSTATICTEXT4, ID_FBDVARIABLEDIALOGSTATICTEXT5
laurent@409: ] = [wx.NewId() for _init_ctrls in range(12)]
laurent@409: 
laurent@409: VARIABLE_CLASSES_DICT = {INPUT : _("Input"),
laurent@409:                          INOUT : _("InOut"),
laurent@409:                          OUTPUT : _("Output")}
laurent@409: VARIABLE_CLASSES_DICT_REVERSE = dict([(value, key) for key, value in VARIABLE_CLASSES_DICT.iteritems()])
laurent@409: 
laurent@409: class FBDVariableDialog(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.TopSizer, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.staticText5, 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_MainSizer_Growables(self, parent):
laurent@409:         parent.AddGrowableCol(0)
laurent@409:         parent.AddGrowableRow(2)
laurent@409:     
laurent@409:     def _init_coll_TopSizer_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.Class, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.staticText2, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.Expression, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.staticText3, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.ExecutionOrder, 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(2)
laurent@409:             
laurent@409:     def _init_coll_RightGridSizer_Items(self, parent):
laurent@409:         parent.AddWindow(self.staticText4, 0, border=0, flag=wx.GROW)
laurent@409:         parent.AddWindow(self.VariableName, 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.FlexGridSizer(cols=1, hgap=0, rows=3, vgap=5)
laurent@409:         self.TopSizer = 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_MainSizer_Growables(self.MainSizer)
laurent@409:         self._init_coll_TopSizer_Items(self.TopSizer)
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_FBDVARIABLEDIALOG,
laurent@534:               name='FBDVariableDialog', parent=prnt,
laurent@409:               size=wx.Size(400, 380), style=wx.DEFAULT_DIALOG_STYLE,
laurent@409:               title=_('Variable Properties'))
laurent@409:         self.SetClientSize(wx.Size(400, 380))
laurent@409: 
laurent@409:         self.staticText1 = wx.StaticText(id=ID_FBDVARIABLEDIALOGSTATICTEXT1,
laurent@409:               label=_('Class:'), 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_FBDVARIABLEDIALOGSTATICTEXT2,
laurent@409:               label=_('Expression:'), 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_FBDVARIABLEDIALOGSTATICTEXT3,
laurent@409:               label=_('Execution Order:'), name='staticText3', parent=self,
laurent@409:               pos=wx.Point(0, 0), size=wx.Size(0, 17), style=0)
laurent@409: 
laurent@409:         self.staticText4 = wx.StaticText(id=ID_FBDVARIABLEDIALOGSTATICTEXT4,
laurent@409:               label=_('Name:'), name='staticText4', parent=self,
laurent@409:               pos=wx.Point(0, 0), size=wx.Size(0, 17), style=0)
laurent@409: 
laurent@409:         self.staticText5 = wx.StaticText(id=ID_FBDVARIABLEDIALOGSTATICTEXT5,
laurent@409:               label=_('Preview:'), name='staticText5', parent=self,
laurent@409:               pos=wx.Point(0, 0), size=wx.Size(0, 17), style=0)
laurent@409: 
laurent@409:         self.Class = wx.ComboBox(id=ID_FBDVARIABLEDIALOGCLASS,
laurent@409:               name='Class', parent=self, pos=wx.Point(0, 0),
laurent@409:               size=wx.Size(0, 28), style=wx.CB_READONLY)
laurent@409:         self.Bind(wx.EVT_COMBOBOX, self.OnClassChanged, id=ID_FBDVARIABLEDIALOGCLASS)
laurent@409:         
laurent@409:         self.VariableName = wx.ListBox(id=ID_FBDVARIABLEDIALOGNAME,
laurent@409:               name='Name', parent=self, pos=wx.Point(0, 0),
laurent@409:               size=wx.Size(0, 90), style=wx.LB_SINGLE|wx.LB_SORT)
laurent@409:         self.Bind(wx.EVT_LISTBOX, self.OnNameChanged, id=ID_FBDVARIABLEDIALOGNAME)
laurent@409: 
laurent@409:         self.Expression = wx.TextCtrl(id=ID_FBDVARIABLEDIALOGEXPRESSION,
laurent@409:               name='Expression', parent=self, pos=wx.Point(0, 0),
laurent@409:               size=wx.Size(0, 24), style=0)
laurent@409:         self.Bind(wx.EVT_TEXT, self.OnExpressionChanged, id=ID_FBDVARIABLEDIALOGEXPRESSION)
laurent@409: 
laurent@409:         self.ExecutionOrder = wx.SpinCtrl(id=ID_FBDVARIABLEDIALOGEXECUTIONORDER,
laurent@409:               name='ExecutionOrder', parent=self, pos=wx.Point(0, 0),
laurent@409:               size=wx.Size(0, 24), style=wx.SP_ARROW_KEYS, min=0)
laurent@409:         self.Bind(wx.EVT_SPINCTRL, self.OnExecutionOrderChanged, id=ID_FBDVARIABLEDIALOGEXECUTIONORDER)
laurent@409: 
laurent@409:         self.Spacer = wx.Panel(id=ID_FBDVARIABLEDIALOGSPACER,
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_FBDVARIABLEDIALOGPREVIEW,
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, "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, transition = ""):
laurent@409:         self._init_ctrls(parent, controler)
laurent@409:         self.Transition = transition
laurent@409:         self.Variable = None
laurent@409:         self.VarList = []
laurent@409:         self.MinVariableSize = None
laurent@409:         
laurent@409:         for choice in VARIABLE_CLASSES_DICT.itervalues():
laurent@409:             self.Class.Append(choice)
laurent@409:         self.Class.SetStringSelection(VARIABLE_CLASSES_DICT[INPUT])
laurent@409: 
laurent@409:         self.RefreshNameList()
laurent@577:         self.Class.SetFocus()
laurent@409: 
laurent@409:     def SetPreviewFont(self, font):
laurent@409:         self.Preview.SetFont(font)
laurent@409: 
laurent@409:     def RefreshNameList(self):
laurent@409:         selected = self.VariableName.GetStringSelection()
laurent@409:         var_class = VARIABLE_CLASSES_DICT_REVERSE[self.Class.GetStringSelection()]
laurent@409:         self.VariableName.Clear()
laurent@409:         self.VariableName.Append("")
laurent@409:         for name, var_type, value_type in self.VarList:
laurent@409:             if var_type != "Input" or var_class == INPUT:
laurent@409:                 self.VariableName.Append(name)
laurent@409:         if selected != "" and self.VariableName.FindString(selected) != wx.NOT_FOUND:
laurent@409:             self.VariableName.SetStringSelection(selected)
laurent@409:             self.Expression.Enable(False)
laurent@409:         else:
laurent@409:             self.VariableName.SetStringSelection("")
laurent@488:             #self.Expression.Enable(var_class == INPUT)
laurent@409:         self.VariableName.Enable(self.VariableName.GetCount() > 0)
laurent@409:             
laurent@409:     def SetMinVariableSize(self, size):
laurent@409:         self.MinVariableSize = size
laurent@409: 
laurent@409:     def SetVariables(self, vars):
laurent@409:         self.VarList = vars
laurent@409:         self.RefreshNameList()
laurent@409: 
laurent@409:     def SetValues(self, values):
laurent@409:         value_type = values.get("type", None)
laurent@409:         value_name = values.get("name", None)
laurent@409:         if value_type:
laurent@409:             self.Class.SetStringSelection(VARIABLE_CLASSES_DICT[value_type])
laurent@409:             self.RefreshNameList()
laurent@409:         if value_name:
laurent@409:             if self.VariableName.FindString(value_name) != wx.NOT_FOUND:
laurent@409:                 self.VariableName.SetStringSelection(value_name)
laurent@409:                 self.Expression.Enable(False)
laurent@409:             else:
laurent@409:                 self.Expression.SetValue(value_name)
laurent@409:                 self.VariableName.Enable(False)
laurent@409:         if "executionOrder" in values:
laurent@409:             self.ExecutionOrder.SetValue(values["executionOrder"])
laurent@409:         self.RefreshPreview()
laurent@409:         
laurent@409:     def GetValues(self):
laurent@409:         values = {}
laurent@409:         values["type"] = VARIABLE_CLASSES_DICT_REVERSE[self.Class.GetStringSelection()]
laurent@409:         expression = self.Expression.GetValue()
laurent@409:         if self.Expression.IsEnabled() and expression != "":
laurent@409:             values["name"] = expression
laurent@409:         else:
laurent@409:             values["name"] = self.VariableName.GetStringSelection()
laurent@409:         values["value_type"] = None
laurent@409:         for var_name, var_type, value_type in self.VarList:
laurent@409:             if var_name == values["name"]:
laurent@409:                 values["value_type"] = value_type
laurent@409:         values["width"], values["height"] = self.Variable.GetSize()
laurent@409:         values["executionOrder"] = self.ExecutionOrder.GetValue()
laurent@409:         return values
laurent@409: 
laurent@409:     def OnOK(self, event):
laurent@409:         expression = self.Expression.GetValue()
laurent@409:         if self.Expression.IsEnabled():
laurent@409:             value = expression
laurent@409:         else:
laurent@409:             value = self.VariableName.GetStringSelection()
laurent@409:         if value == "":
laurent@409:             message = wx.MessageDialog(self, _("At least a variable or an expression must be selected!"), _("Error"), wx.OK|wx.ICON_ERROR)
laurent@409:             message.ShowModal()
laurent@409:             message.Destroy()
laurent@409:         elif value.upper() in IEC_KEYWORDS:
laurent@409:             message = wx.MessageDialog(self, _("\"%s\" is a keyword. It can't be used!")%value, _("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 OnClassChanged(self, event):
laurent@409:         self.RefreshNameList()
laurent@409:         self.RefreshPreview()
laurent@409:         event.Skip()
laurent@409: 
laurent@409:     def OnNameChanged(self, event):
laurent@409:         if self.VariableName.GetStringSelection() != "":
laurent@409:             self.Expression.Enable(False)
laurent@409:         elif VARIABLE_CLASSES_DICT_REVERSE[self.Class.GetStringSelection()] == INPUT:
laurent@409:             self.Expression.Enable(True)
laurent@409:         self.RefreshPreview()
laurent@409:         event.Skip()
laurent@409:     
laurent@409:     def OnExpressionChanged(self, event):
laurent@409:         if self.Expression.GetValue() != "":
laurent@409:             self.VariableName.Enable(False)
laurent@409:         else:
laurent@409:             self.VariableName.Enable(True)
laurent@409:         self.RefreshPreview()
laurent@409:         event.Skip()
laurent@409:     
laurent@409:     def OnExecutionOrderChanged(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:         expression = self.Expression.GetValue()
laurent@409:         if self.Expression.IsEnabled() and expression != "":
laurent@409:             name = expression
laurent@409:         else:
laurent@409:             name = self.VariableName.GetStringSelection()
laurent@409:         type = ""
laurent@409:         for var_name, var_type, value_type in self.VarList:
laurent@409:             if var_name == name:
laurent@409:                 type = value_type
laurent@409:         classtype = VARIABLE_CLASSES_DICT_REVERSE[self.Class.GetStringSelection()]
laurent@409:         self.Variable = FBD_Variable(self.Preview, classtype, name, type, executionOrder = self.ExecutionOrder.GetValue())
laurent@409:         width, height = self.MinVariableSize
laurent@409:         min_width, min_height = self.Variable.GetMinSize()
laurent@409:         width, height = max(min_width, width), max(min_height, height)
laurent@409:         self.Variable.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.Variable.SetPosition(x, y)
laurent@409:         self.Variable.Draw(dc)
laurent@409: 
laurent@409:     def OnPaint(self, event):
laurent@409:         self.RefreshPreview()
laurent@409:         event.Skip()