1

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

     2

     3

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

     4

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

     5

#

     6

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

     7

#

     8

# See COPYING file for copyrights details.

     9

#

    10

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

    11

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

    12

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

    13

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

    14

#

    15

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

    16

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

    17

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    18

# GNU General Public License for more details.

    19

#

    20

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

    21

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

    22

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

    23

    24

    25

from __future__ import absolute_import

    26

import re

    27

import datetime

    28

from builtins import str as text

    29

    30

import wx

    31

    32

# -------------------------------------------------------------------------------

    33

#                                Helpers

    34

# -------------------------------------------------------------------------------

    35

    36

LOCATIONDATATYPES = {"X": ["BOOL"],

    37

                     "B": ["SINT", "USINT", "BYTE", "STRING"],

    38

                     "W": ["INT", "UINT", "WORD", "WSTRING"],

    39

                     "D": ["DINT", "UDINT", "REAL", "DWORD"],

    40

                     "L": ["LINT", "ULINT", "LREAL", "LWORD"]}

    41

    42

    43

def gen_get_function(f):

    44

    def get_function(v):

    45

        try:

    46

            return f(v)

    47

        except Exception:

    48

            return None

    49

    return get_function

    50

    51

    52

def gen_get_string(delimiter):

    53

    STRING_MODEL = re.compile("%(delimiter)s([^%(delimiter)s]*)%(delimiter)s$" % {"delimiter": delimiter})

    54

    55

    def get_string(v):

    56

        result = STRING_MODEL.match(v)

    57

        if result is not None:

    58

            return result.group(1)

    59

        return None

    60

    return get_string

    61

    62

    63

getinteger = gen_get_function(int)

    64

getfloat = gen_get_function(float)

    65

getstring = gen_get_string("'")

    66

getwstring = gen_get_string('"')

    67

    68

SECOND = 1000000

    69

MINUTE = 60 * SECOND

    70

HOUR = 60 * MINUTE

    71

DAY = 24 * HOUR

    72

    73

IEC_TIME_MODEL = re.compile(r"(?:(?:T|TIME)#)?(-)?(?:(%(float)s)D_?)?(?:(%(float)s)H_?)?(?:(%(float)s)M(?!S)_?)?(?:(%(float)s)S_?)?(?:(%(float)s)MS)?$" % {"float": r"[0-9]+(?:\.[0-9]+)?"})

    74

IEC_DATE_MODEL = re.compile(r"(?:(?:D|DATE)#)?([0-9]{4})-([0-9]{2})-([0-9]{2})$")

    75

IEC_DATETIME_MODEL = re.compile(r"(?:(?:DT|DATE_AND_TIME)#)?([0-9]{4})-([0-9]{2})-([0-9]{2})-([0-9]{2}):([0-9]{2}):([0-9]{2}(?:\.[0-9]+)?)$")

    76

IEC_TIMEOFDAY_MODEL = re.compile(r"(?:(?:TOD|TIME_OF_DAY)#)?([0-9]{2}):([0-9]{2}):([0-9]{2}(?:\.[0-9]+)?)$")

    77

    78

    79

def gettime(v):

    80

    result = IEC_TIME_MODEL.match(v.upper())

    81

    if result is not None:

    82

        negative, days, hours, minutes, seconds, milliseconds = result.groups()

    83

        microseconds = 0

    84

        not_null = False

    85

        for value, factor in [(days, DAY),

    86

                              (hours, HOUR),

    87

                              (minutes, MINUTE),

    88

                              (seconds, SECOND),

    89

                              (milliseconds, 1000)]:

    90

            if value is not None:

    91

                microseconds += float(value) * factor

    92

                not_null = True

    93

        if not not_null:

    94

            return None

    95

        if negative is not None:

    96

            microseconds = -microseconds

    97

        return datetime.timedelta(microseconds=microseconds)

    98

    99

    else:

   100

        return None

   101

   102

   103

def getdate(v):

   104

    result = IEC_DATE_MODEL.match(v.upper())

   105

    if result is not None:

   106

        year, month, day = result.groups()

   107

        try:

   108

            date = datetime.datetime(int(year), int(month), int(day))

   109

        except ValueError:

   110

            return None

   111

        base_date = datetime.datetime(1970, 1, 1)

   112

        return date - base_date

   113

    else:

   114

        return None

   115

   116

   117

def getdatetime(v):

   118

    result = IEC_DATETIME_MODEL.match(v.upper())

   119

    if result is not None:

   120

        year, month, day, hours, minutes, seconds = result.groups()

   121

        try:

   122

            date = datetime.datetime(int(year), int(month), int(day), int(hours), int(minutes), int(float(seconds)), int((float(seconds) * SECOND) % SECOND))

   123

        except ValueError:

   124

            return None

   125

        base_date = datetime.datetime(1970, 1, 1)

   126

        return date - base_date

   127

    else:

   128

        return None

   129

   130

   131

def gettimeofday(v):

   132

    result = IEC_TIMEOFDAY_MODEL.match(v.upper())

   133

    if result is not None:

   134

        hours, minutes, seconds = result.groups()

   135

        microseconds = 0

   136

        for value, factor in [(hours, HOUR),

   137

                              (minutes, MINUTE),

   138

                              (seconds, SECOND)]:

   139

            microseconds += float(value) * factor

   140

        return datetime.timedelta(microseconds=microseconds)

   141

    else:

   142

        return None

   143

   144

   145

GetTypeValue = {"BOOL": lambda x: {"TRUE": True, "FALSE": False, "0": False, "1": True}.get(x.upper(), None),

   146

                "SINT": getinteger,

   147

                "INT": getinteger,

   148

                "DINT": getinteger,

   149

                "LINT": getinteger,

   150

                "USINT": getinteger,

   151

                "UINT": getinteger,

   152

                "UDINT": getinteger,

   153

                "ULINT": getinteger,

   154

                "BYTE": getinteger,

   155

                "WORD": getinteger,

   156

                "DWORD": getinteger,

   157

                "LWORD": getinteger,

   158

                "REAL": getfloat,

   159

                "LREAL": getfloat,

   160

                "STRING": getstring,

   161

                "WSTRING": getwstring,

   162

                "TIME": gettime,

   163

                "DATE": getdate,

   164

                "DT": getdatetime,

   165

                "TOD": gettimeofday}

   166

   167

# -------------------------------------------------------------------------------

   168

#                            Force Variable Dialog

   169

# -------------------------------------------------------------------------------

   170

   171

   172

class ForceVariableDialog(wx.Dialog):

   173

    """Dialog to enforce new value for variables in debug panel"""

   174

   175

    def __init__(self, parent, iec_type, defaultValue=""):

   176

        """

   177

        Constructor

   178

        @param parent: Parent wx.Window of dialog for modal

   179

        @param iec_type: IEC type of variable (string). For example 'BOOL', 'LREAL'.

   180

        @param defaultValue: current variable value as string. Default is empty string.

   181

        """

   182

        wx.Dialog.__init__(

   183

            self, parent,

   184

            name='ForceVariableDialog',

   185

            title=_("Please enter value for a \"%s\" variable:") % iec_type,

   186

            style=wx.DEFAULT_DIALOG_STYLE, pos=wx.DefaultPosition)

   187

   188

        self.IEC_Type = iec_type

   189

        info_sizer = wx.BoxSizer(wx.VERTICAL)

   190

   191

        message_label = wx.StaticText(self, label=_("Forcing Variable Value"))

   192

        info_sizer.AddWindow(message_label, border=10,

   193

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

   194

   195

        if GetTypeValue[self.IEC_Type] in [getinteger, getfloat]:

   196

            self.InitCtrlNumber(info_sizer, defaultValue)

   197

        elif self.IEC_Type == "BOOL":

   198

            self.InitCtrlBool(info_sizer, defaultValue)

   199

        else:

   200

            self.InitCtrlDefault(info_sizer, defaultValue)

   201

        self.GetEnteredValue = self.GetValueDefault

   202

   203

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

   204

        self.Bind(wx.EVT_BUTTON, self.OnOK, button_sizer.GetAffirmativeButton())

   205

        info_sizer.AddSizer(button_sizer, border=10, flag=wx.ALIGN_RIGHT | wx.ALL)

   206

   207

        self.SetSizer(info_sizer)

   208

        self.Fit()

   209

        self.ValueCtrl.SetFocus()

   210

   211

    # ---------------------------------

   212

    # default type methods

   213

    # ---------------------------------

   214

   215

    def InitCtrlDefault(self, info_sizer, defaultValue):

   216

        """Add simple text control to change variable of any type"""

   217

        self.ValueCtrl = wx.TextCtrl(self)

   218

        self.ValueCtrl.SetValue(defaultValue)

   219

        info_sizer.AddWindow(self.ValueCtrl, border=10, proportion=1,

   220

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

   221

   222

    def GetValueDefault(self):

   223

        """

   224

        Returns text representation for a variable value

   225

        @return: variable value as a string

   226

        """

   227

        return text(self.ValueCtrl.GetValue())

   228

   229

    # -----------------------------------------------

   230

    # integer and floating point number type methods

   231

    # ----------------------------------------------

   232

   233

    def InitCtrlNumber(self, info_sizer, defaultValue):

   234

        """Add controls to change float and integer variables"""

   235

        sizer = wx.BoxSizer(wx.HORIZONTAL)

   236

        self.InitCtrlDefault(sizer, defaultValue)

   237

        self.SpinButtonCtrl = wx.SpinButton(self, style=wx.HORIZONTAL | wx.SP_WRAP)

   238

        sizer.AddWindow(self.SpinButtonCtrl, border=10,

   239

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

   240

        self.Bind(wx.EVT_SPIN_UP, self.SpinButtonChanged)

   241

        self.Bind(wx.EVT_SPIN_DOWN, self.SpinButtonChanged)

   242

        info_sizer.AddWindow(sizer, proportion=1, flag=wx.EXPAND)

   243

   244

    def SpinButtonChanged(self, evt):

   245

        """Increment/decrement variable value"""

   246

        value = self.GetValue()

   247

        if value is not None:

   248

            up = evt.GetEventType() == wx.EVT_SPIN_UP._getEvtType()

   249

            value = value + 1 if up else value - 1

   250

            self.ValueCtrl.SetValue(text(value))

   251

        evt.Skip()

   252

   253

    # -----------------------------------------------

   254

    # bool type related methods

   255

    # ----------------------------------------------

   256

   257

    def InitCtrlBool(self, info_sizer, defaultValue):

   258

        """Add button to change value of boolean variable"""

   259

        self.ValueCtrl = wx.ToggleButton(self, label=_("Toggle value"))

   260

        value = GetTypeValue[self.IEC_Type](defaultValue)

   261

        if value is not None:

   262

            self.ValueCtrl.SetValue(value)

   263

   264

        info_sizer.AddWindow(self.ValueCtrl, border=10,

   265

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

   266

   267

    def OnOK(self, event):

   268

        """

   269

        Checks new entered value

   270

        before closing dialog window

   271

        """

   272

        message = None

   273

        ret = True

   274

        value = self.GetEnteredValue()

   275

        if value == "":

   276

            message = _("You must type a value!")

   277

        elif GetTypeValue[self.IEC_Type](value) is None:

   278

            message = _("Invalid value \"{a1}\" for \"{a2}\" variable!").format(a1=value, a2=self.IEC_Type)

   279

        if message is not None:

   280

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

   281

            dialog.ShowModal()

   282

            dialog.Destroy()

   283

            ret = False

   284

        else:

   285

            self.EndModal(wx.ID_OK)

   286

        event.Skip(ret)

   287

   288

    def GetValue(self):

   289

        """

   290

        Return new enforce value of particular type

   291

        """

   292

        return GetTypeValue[self.IEC_Type](self.GetEnteredValue())