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

import re

    26

import datetime

    27

    28

import wx

    29

    30

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

    31

#                                Helpers

    32

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

    33

    34

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

    35

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

    36

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

    37

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

    38

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

    39

    40

    41

def gen_get_function(f):

    42

    def get_function(v):

    43

        try:

    44

            return f(v)

    45

        except Exception:

    46

            return None

    47

    return get_function

    48

    49

    50

def gen_get_string(delimiter):

    51

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

    52

    53

    def get_string(v):

    54

        result = STRING_MODEL.match(v)

    55

        if result is not None:

    56

            return result.group(1)

    57

        return None

    58

    return get_string

    59

    60

    61

getinteger = gen_get_function(int)

    62

getfloat = gen_get_function(float)

    63

getstring = gen_get_string("'")

    64

getwstring = gen_get_string('"')

    65

    66

SECOND = 1000000

    67

MINUTE = 60 * SECOND

    68

HOUR = 60 * MINUTE

    69

DAY = 24 * HOUR

    70

    71

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]+)?"})

    72

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

    73

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]+)?)$")

    74

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

    75

    76

    77

def gettime(v):

    78

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

    79

    if result is not None:

    80

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

    81

        microseconds = 0

    82

        not_null = False

    83

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

    84

                              (hours, HOUR),

    85

                              (minutes, MINUTE),

    86

                              (seconds, SECOND),

    87

                              (milliseconds, 1000)]:

    88

            if value is not None:

    89

                microseconds += float(value) * factor

    90

                not_null = True

    91

        if not not_null:

    92

            return None

    93

        if negative is not None:

    94

            microseconds = -microseconds

    95

        return datetime.timedelta(microseconds=microseconds)

    96

    97

    else:

    98

        return None

    99

   100

   101

def getdate(v):

   102

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

   103

    if result is not None:

   104

        year, month, day = result.groups()

   105

        try:

   106

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

   107

        except ValueError:

   108

            return None

   109

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

   110

        return date - base_date

   111

    else:

   112

        return None

   113

   114

   115

def getdatetime(v):

   116

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

   117

    if result is not None:

   118

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

   119

        try:

   120

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

   121

        except ValueError:

   122

            return None

   123

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

   124

        return date - base_date

   125

    else:

   126

        return None

   127

   128

   129

def gettimeofday(v):

   130

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

   131

    if result is not None:

   132

        hours, minutes, seconds = result.groups()

   133

        microseconds = 0

   134

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

   135

                              (minutes, MINUTE),

   136

                              (seconds, SECOND)]:

   137

            microseconds += float(value) * factor

   138

        return datetime.timedelta(microseconds=microseconds)

   139

    else:

   140

        return None

   141

   142

   143

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

   144

                "SINT": getinteger,

   145

                "INT": getinteger,

   146

                "DINT": getinteger,

   147

                "LINT": getinteger,

   148

                "USINT": getinteger,

   149

                "UINT": getinteger,

   150

                "UDINT": getinteger,

   151

                "ULINT": getinteger,

   152

                "BYTE": getinteger,

   153

                "WORD": getinteger,

   154

                "DWORD": getinteger,

   155

                "LWORD": getinteger,

   156

                "REAL": getfloat,

   157

                "LREAL": getfloat,

   158

                "STRING": getstring,

   159

                "WSTRING": getwstring,

   160

                "TIME": gettime,

   161

                "DATE": getdate,

   162

                "DT": getdatetime,

   163

                "TOD": gettimeofday}

   164

   165

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

   166

#                            Force Variable Dialog

   167

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

   168

   169

   170

class ForceVariableDialog(wx.Dialog):

   171

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

   172

   173

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

   174

        """

   175

        Constructor

   176

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

   177

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

   178

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

   179

        """

   180

        wx.Dialog.__init__(

   181

            self, parent,

   182

            name='ForceVariableDialog',

   183

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

   184

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

   185

   186

        self.IEC_Type = iec_type

   187

        info_sizer = wx.BoxSizer(wx.VERTICAL)

   188

   189

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

   190

        info_sizer.Add(message_label, border=10,

   191

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

   192

   193

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

   194

            self.InitCtrlNumber(info_sizer, defaultValue)

   195

        elif self.IEC_Type == "BOOL":

   196

            self.InitCtrlBool(info_sizer, defaultValue)

   197

        else:

   198

            self.InitCtrlDefault(info_sizer, defaultValue)

   199

        self.GetEnteredValue = self.GetValueDefault

   200

   201

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

   202

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

   203

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

   204

   205

        self.SetSizer(info_sizer)

   206

        self.Fit()

   207

        self.ValueCtrl.SetFocus()

   208

   209

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

   210

    # default type methods

   211

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

   212

   213

    def InitCtrlDefault(self, info_sizer, defaultValue):

   214

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

   215

        self.ValueCtrl = wx.TextCtrl(self)

   216

        self.ValueCtrl.SetValue(defaultValue)

   217

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

   218

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

   219

   220

    def GetValueDefault(self):

   221

        """

   222

        Returns text representation for a variable value

   223

        @return: variable value as a string

   224

        """

   225

        return str(self.ValueCtrl.GetValue())

   226

   227

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

   228

    # integer and floating point number type methods

   229

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

   230

   231

    def InitCtrlNumber(self, info_sizer, defaultValue):

   232

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

   233

        sizer = wx.BoxSizer(wx.HORIZONTAL)

   234

        self.InitCtrlDefault(sizer, defaultValue)

   235

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

   236

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

   237

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

   238

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

   239

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

   240

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

   241

   242

    def SpinButtonChanged(self, evt):

   243

        """Increment/decrement variable value"""

   244

        value = self.GetValue()

   245

        if value is not None:

   246

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

   247

            value = value + 1 if up else value - 1

   248

            self.ValueCtrl.SetValue(str(value))

   249

        evt.Skip()

   250

   251

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

   252

    # bool type related methods

   253

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

   254

   255

    def InitCtrlBool(self, info_sizer, defaultValue):

   256

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

   257

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

   258

        value = GetTypeValue[self.IEC_Type](defaultValue)

   259

        if value is not None:

   260

            self.ValueCtrl.SetValue(value)

   261

   262

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

   263

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

   264

   265

    def OnOK(self, event):

   266

        """

   267

        Checks new entered value

   268

        before closing dialog window

   269

        """

   270

        message = None

   271

        ret = True

   272

        value = self.GetEnteredValue()

   273

        if value == "":

   274

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

   275

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

   276

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

   277

        if message is not None:

   278

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

   279

            dialog.ShowModal()

   280

            dialog.Destroy()

   281

            ret = False

   282

        else:

   283

            self.EndModal(wx.ID_OK)

   284

        event.Skip(ret)

   285

   286

    def GetValue(self):

   287

        """

   288

        Return new enforce value of particular type

   289

        """

   290

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