1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2012: Edouard TISSERANT and Laurent BESSARD

     8

# Copyright (C) 2017: Andrey Skvortsov <andrej.skvortzov@gmail.com>

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

# This program is free software; you can redistribute it and/or

    13

# modify it under the terms of the GNU General Public License

    14

# as published by the Free Software Foundation; either version 2

    15

# of the License, or (at your option) any later version.

    16

#

    17

# This program is distributed in the hope that it will be useful,

    18

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

# You should have received a copy of the GNU General Public License

    23

# along with this program; if not, write to the Free Software

    24

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    25

    26

    27

from __future__ import absolute_import

    28

import wx

    29

    30

from plcopen.structures import TestIdentifier, IEC_KEYWORDS

    31

from util.TranslationCatalogs import NoTranslate

    32

    33

    34

class PouDialog(wx.Dialog):

    35

    """

    36

    Dialog to create new POU.

    37

    It allows selection of POU type, name and

    38

    used IEC 61131-3 programming language

    39

    """

    40

    41

    POU_TYPES = None

    42

    POU_TYPES_DICT = None

    43

    POU_LANGUAGES = None

    44

    POU_LANGUAGES_DICT = None

    45

    46

    def __init__(self, parent, pou_type=None, type_readonly=False):

    47

        wx.Dialog.__init__(self, id=-1, parent=parent,

    48

                           name='PouDialog', title=_('Create a new POU'),

    49

                           style=wx.DEFAULT_DIALOG_STYLE)

    50

    51

        if PouDialog.POU_TYPES_DICT is None:

    52

            self.InitPouTypesDict()

    53

            self.InitPouLanguagesDict()

    54

    55

        main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=10)

    56

        main_sizer.AddGrowableCol(0)

    57

        main_sizer.AddGrowableRow(0)

    58

    59

        infos_sizer = wx.FlexGridSizer(cols=2, hgap=5, rows=3, vgap=15)

    60

        infos_sizer.AddGrowableCol(1)

    61

        main_sizer.Add(infos_sizer, border=20,

    62

                            flag=wx.GROW | wx.TOP | wx.LEFT | wx.RIGHT)

    63

    64

        pouname_label = wx.StaticText(self, label=_('POU Name:'))

    65

        infos_sizer.Add(pouname_label, border=4,

    66

                              flag=wx.ALIGN_CENTER_VERTICAL | wx.TOP)

    67

    68

        self.PouName = wx.TextCtrl(self)

    69

        infos_sizer.Add(self.PouName, flag=wx.GROW)

    70

    71

        poutype_label = wx.StaticText(self, label=_('POU Type:'))

    72

        infos_sizer.Add(poutype_label, border=4,

    73

                              flag=wx.ALIGN_CENTER_VERTICAL | wx.TOP)

    74

    75

        self.PouType = wx.ComboBox(self, style=wx.CB_READONLY)

    76

        self.Bind(wx.EVT_COMBOBOX, self.OnTypeChanged, self.PouType)

    77

        infos_sizer.Add(self.PouType, flag=wx.GROW)

    78

    79

        language_label = wx.StaticText(self, label=_('Language:'))

    80

        infos_sizer.Add(language_label, border=4,

    81

                              flag=wx.ALIGN_CENTER_VERTICAL | wx.TOP)

    82

    83

        self.Language = wx.ComboBox(self, style=wx.CB_READONLY)

    84

        infos_sizer.Add(self.Language, flag=wx.GROW)

    85

    86

        button_sizer = self.CreateButtonSizer(wx.OK | wx.CANCEL | wx.CENTRE)

    87

        self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.GetAffirmativeId())

    88

        main_sizer.Add(button_sizer, border=20,

    89

                            flag=wx.ALIGN_RIGHT | wx.BOTTOM | wx.LEFT | wx.RIGHT)

    90

    91

        self.SetSizer(main_sizer)

    92

    93

        for option in self.POU_TYPES:

    94

            if not type_readonly or _(option) == _(pou_type):

    95

                self.PouType.Append(_(option))

    96

        if pou_type is not None:

    97

            self.PouType.SetStringSelection(_(pou_type))

    98

        self.RefreshLanguage()

    99

        self.Fit()

   100

        self.PouNames = []

   101

        self.PouElementNames = []

   102

   103

    def InitPouTypes(self):

   104

        """

   105

        Initialize POU_TYPES class list.

   106

        This list contains not translated POU types used in PLCopen XML.

   107

        _() are necessary so mk18n.py could find these string for localization.

   108

        """

   109

        _ = NoTranslate

   110

        self.__class__.POU_TYPES = [_("function"), _("functionBlock"), _("program")]

   111

   112

    def InitPouTypesDict(self):

   113

        """

   114

        Initialize POU_TYPES_DICT class dictionary and POU_TYPE list

   115

        Dictionary contains localized POU types and they are shown in UI.

   116

        """

   117

        self.InitPouTypes()

   118

        self.__class__.POU_TYPES_DICT = dict([(_(pou_type), pou_type)

   119

                                              for pou_type in self.POU_TYPES])

   120

   121

    def InitPouLanguages(self):

   122

        """

   123

        Initialize POU_LANGUAGES class list.

   124

        This list contains not translated programming languages used in PLCopen XML.

   125

        _() are necessary so mk18n.py could find these string for localization.

   126

        """

   127

        _ = NoTranslate

   128

        self.__class__.POU_LANGUAGES = [_("IL"), _("ST"), _("LD"), _("FBD"), _("SFC")]

   129

   130

    def InitPouLanguagesDict(self):

   131

        """

   132

        Initialize POU_LANGUAGES_DICT class dictionary and POU_LANGUAGES list

   133

        Dictionary contains localized names for programming languages

   134

        as they are shown in UI.

   135

        """

   136

        self.InitPouLanguages()

   137

        self.__class__.POU_LANGUAGES_DICT = dict([(_(language), language)

   138

                                                  for language in self.POU_LANGUAGES])

   139

   140

    def OnOK(self, event):

   141

        error = []

   142

        pou_name = self.PouName.GetValue()

   143

        if pou_name == "":

   144

            error.append(_("POU Name"))

   145

        if self.PouType.GetSelection() == -1:

   146

            error.append(_("POU Type"))

   147

        if self.Language.GetSelection() == -1:

   148

            error.append(_("Language"))

   149

        message = None

   150

        question = False

   151

        if len(error) > 0:

   152

            text = ""

   153

            for i, item in enumerate(error):

   154

                if i == 0:

   155

                    text += item

   156

                elif i == len(error) - 1:

   157

                    text += _(" and %s") % item

   158

                else:

   159

                    text += _(", %s") % item

   160

            message = _("Form isn't complete. %s must be filled!") % text

   161

        elif not TestIdentifier(pou_name):

   162

            message = _("\"%s\" is not a valid identifier!") % pou_name

   163

        elif pou_name.upper() in IEC_KEYWORDS:

   164

            message = _("\"%s\" is a keyword. It can't be used!") % pou_name

   165

        elif pou_name.upper() in self.PouNames:

   166

            message = _("\"%s\" pou already exists!") % pou_name

   167

        elif pou_name.upper() in self.PouElementNames:

   168

            message = _("A POU has an element named \"%s\". This could cause a conflict. Do you wish to continue?") % pou_name

   169

            question = True

   170

        if message is not None:

   171

            if question:

   172

                dialog = wx.MessageDialog(self, message, _("Warning"), wx.YES_NO | wx.ICON_EXCLAMATION)

   173

                result = dialog.ShowModal()

   174

                dialog.Destroy()

   175

                if result == wx.ID_YES:

   176

                    self.EndModal(wx.ID_OK)

   177

            else:

   178

                dialog = wx.MessageDialog(self, message, _("Error"), wx.OK | wx.ICON_ERROR)

   179

                dialog.ShowModal()

   180

                dialog.Destroy()

   181

        else:

   182

            self.EndModal(wx.ID_OK)

   183

   184

    def RefreshLanguage(self):

   185

        selection = self.POU_LANGUAGES_DICT.get(self.Language.GetStringSelection(), "")

   186

        self.Language.Clear()

   187

        for language in self.POU_LANGUAGES:

   188

            if language != "SFC" or self.POU_TYPES_DICT[self.PouType.GetStringSelection()] != "function":

   189

                self.Language.Append(_(language))

   190

        if self.Language.FindString(_(selection)) != wx.NOT_FOUND:

   191

            self.Language.SetStringSelection(_(selection))

   192

   193

    def OnTypeChanged(self, event):

   194

        self.RefreshLanguage()

   195

        event.Skip()

   196

   197

    def SetPouNames(self, pou_names):

   198

        self.PouNames = [pou_name.upper() for pou_name in pou_names]

   199

   200

    def SetPouElementNames(self, element_names):

   201

        self.PouElementNames = [element_name.upper() for element_name in element_names]

   202

   203

    def SetValues(self, values):

   204

        for item, value in values.items():

   205

            if item == "pouName":

   206

                self.PouName.SetValue(value)

   207

            elif item == "pouType":

   208

                self.PouType.SetStringSelection(_(value))

   209

            elif item == "language":

   210

                self.Language.SetStringSelection(_(value))

   211

   212

    def GetValues(self):

   213

        values = {}

   214

        values["pouName"] = self.PouName.GetValue()

   215

        values["pouType"] = self.POU_TYPES_DICT[self.PouType.GetStringSelection()]

   216

        values["language"] = self.POU_LANGUAGES_DICT[self.Language.GetStringSelection()]

   217

        return values