1

#!/usr/bin/env python

     2

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

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

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

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

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

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

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

    15

#

    16

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

    17

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

    18

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    19

#General Public License for more details.

    20

#

    21

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

    22

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

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import string, os, sys, re

    26

    27

LANGUAGES = ["IL","ST","FBD","LD","SFC"]

    28

    29

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

    30

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

    31

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

    32

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

    33

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

    34

    35

_ = lambda x:x

    36

    37

# Helper for emulate join on element list

    38

def JoinList(separator, mylist):

    39

    if len(mylist) > 0 :

    40

        return reduce(lambda x, y: x + separator + y, mylist)

    41

    else :

    42

        return mylist

    43

    44

def generate_block(generator, block, block_infos, body, link, order=False, to_inout=False):

    45

    body_type = body.getcontent()["name"]

    46

    name = block.getinstanceName()

    47

    type = block.gettypeName()

    48

    executionOrderId = block.getexecutionOrderId()

    49

    input_variables = block.inputVariables.getvariable()

    50

    output_variables = block.outputVariables.getvariable()

    51

    inout_variables = {}

    52

    for input_variable in input_variables:

    53

        for output_variable in output_variables:

    54

            if input_variable.getformalParameter() == output_variable.getformalParameter():

    55

                inout_variables[input_variable.getformalParameter()] = ""

    56

    input_names = [input[0] for input in block_infos["inputs"]]

    57

    output_names = [output[0] for output in block_infos["outputs"]]

    58

    if block_infos["type"] == "function":

    59

        if not generator.ComputedBlocks.get(block, False) and not order:

    60

            generator.ComputedBlocks[block] = True

    61

            connected_vars = []

    62

            input_connected = dict([("EN", None)] + 

    63

                                   [(input_name, None) for input_name in input_names])

    64

            for variable in input_variables:

    65

                parameter = variable.getformalParameter()

    66

                if input_connected.has_key(parameter):

    67

                    input_connected[parameter] = variable

    68

            if input_connected["EN"] is None:

    69

                input_connected.pop("EN")

    70

                input_parameters = input_names

    71

            else:

    72

                input_parameters = ["EN"] + input_names

    73

            one_input_connected = False

    74

            all_input_connected = True

    75

            for i, parameter in enumerate(input_parameters):

    76

                variable = input_connected.get(parameter)

    77

                if variable is not None:

    78

                    input_info = (generator.TagName, "block", block.getlocalId(), "input", i)

    79

                    connections = variable.connectionPointIn.getconnections()

    80

                    if connections is not None:

    81

                        if parameter != "EN":

    82

                            one_input_connected = True

    83

                        if inout_variables.has_key(parameter):

    84

                            value = generator.ComputeExpression(body, connections, executionOrderId > 0, True)

    85

                            inout_variables[parameter] = value

    86

                        else:

    87

                            value = generator.ComputeExpression(body, connections, executionOrderId > 0)

    88

                        connected_vars.append(([(parameter, input_info), (" := ", ())],

    89

                                               generator.ExtractModifier(variable, value, input_info)))

    90

                    else:

    91

                        all_input_connected = False

    92

                else:

    93

                    all_input_connected = False

    94

            if len(output_variables) > 1 or not all_input_connected:

    95

                vars = [name + value for name, value in connected_vars]

    96

            else:

    97

                vars = [value for name, value in connected_vars]

    98

            if one_input_connected:

    99

                for i, variable in enumerate(output_variables):

   100

                    parameter = variable.getformalParameter()

   101

                    if not inout_variables.has_key(parameter) and parameter in output_names + ["ENO"]:

   102

                        if variable.getformalParameter() == "":

   103

                            variable_name = "%s%d"%(type, block.getlocalId())

   104

                        else:

   105

                            variable_name = "%s%d_%s"%(type, block.getlocalId(), parameter)

   106

                        if generator.Interface[-1][0] != "VAR" or generator.Interface[-1][1] is not None or generator.Interface[-1][2]:

   107

                            generator.Interface.append(("VAR", None, False, []))

   108

                        if variable.connectionPointOut in generator.ConnectionTypes:

   109

                            generator.Interface[-1][3].append((generator.ConnectionTypes[variable.connectionPointOut], variable_name, None, None))

   110

                        else:

   111

                            generator.Interface[-1][3].append(("ANY", variable_name, None, None))

   112

                        if len(output_variables) > 1 and parameter not in ["", "OUT"]:

   113

                            vars.append([(parameter, (generator.TagName, "block", block.getlocalId(), "output", i)), 

   114

                                         (" => %s"%variable_name, ())])

   115

                        else:

   116

                            output_info = (generator.TagName, "block", block.getlocalId(), "output", i)

   117

                            output_name = variable_name

   118

                generator.Program += [(generator.CurrentIndent, ()),

   119

                                      (output_name, output_info),

   120

                                      (" := ", ()),

   121

                                      (type, (generator.TagName, "block", block.getlocalId(), "type")),

   122

                                      ("(", ())]

   123

                generator.Program += JoinList([(", ", ())], vars)

   124

                generator.Program += [(");\n", ())]

   125

            else:

   126

                generator.Warnings.append(_("\"%s\" function cancelled in \"%s\" POU: No input connected")%(type, generator.TagName.split("::")[-1]))

   127

    elif block_infos["type"] == "functionBlock":

   128

        if not generator.ComputedBlocks.get(block, False) and not order:

   129

            generator.ComputedBlocks[block] = True

   130

            vars = []

   131

            offset_idx = 0

   132

            for variable in input_variables:

   133

                parameter = variable.getformalParameter()

   134

                if parameter in input_names or parameter == "EN":

   135

                    if parameter == "EN":

   136

                        input_idx = 0

   137

                        offset_idx = 1

   138

                    else:

   139

                        input_idx = offset_idx + input_names.index(parameter)

   140

                    input_info = (generator.TagName, "block", block.getlocalId(), "input", input_idx)

   141

                    connections = variable.connectionPointIn.getconnections()

   142

                    if connections is not None:

   143

                        value = generator.ComputeExpression(body, connections, executionOrderId > 0, inout_variables.has_key(parameter))

   144

                        vars.append([(parameter, input_info),

   145

                                     (" := ", ())] + generator.ExtractModifier(variable, value, input_info))

   146

            generator.Program += [(generator.CurrentIndent, ()), 

   147

                                  (name, (generator.TagName, "block", block.getlocalId(), "name")),

   148

                                  ("(", ())]

   149

            generator.Program += JoinList([(", ", ())], vars)

   150

            generator.Program += [(");\n", ())]

   151

   152

    if link:

   153

        connectionPoint = link.getposition()[-1]

   154

        output_parameter = link.getformalParameter()

   155

    else:

   156

        connectionPoint = None

   157

        output_parameter = None

   158

   159

    output_variable = None

   160

    output_idx = 0

   161

    if output_parameter is not None:

   162

        if output_parameter in output_names or output_parameter == "ENO":

   163

            for variable in output_variables:

   164

                if variable.getformalParameter() == output_parameter:

   165

                    output_variable = variable

   166

                    if output_parameter != "ENO":

   167

                        output_idx = output_names.index(output_parameter)

   168

    else:

   169

        for i, variable in enumerate(output_variables):

   170

            blockPointx, blockPointy = variable.connectionPointOut.getrelPositionXY()

   171

            if (not connectionPoint or 

   172

                block.getx() + blockPointx == connectionPoint.getx() and 

   173

                block.gety() + blockPointy == connectionPoint.gety()):

   174

                output_variable = variable

   175

                output_parameter = variable.getformalParameter()

   176

                output_idx = i

   177

   178

    if output_variable is not None:

   179

        if block_infos["type"] == "function":

   180

            output_info = (generator.TagName, "block", block.getlocalId(), "output", output_idx)

   181

            if inout_variables.has_key(output_parameter):

   182

                output_value = inout_variables[output_parameter]

   183

            else:

   184

                if output_parameter == "":

   185

                    output_name = "%s%d"%(type, block.getlocalId())

   186

                else:

   187

                    output_name = "%s%d_%s"%(type, block.getlocalId(), output_parameter)

   188

                output_value = [(output_name, output_info)]

   189

            return generator.ExtractModifier(output_variable, output_value, output_info)

   190

   191

        if block_infos["type"] == "functionBlock":

   192

            output_info = (generator.TagName, "block", block.getlocalId(), "output", output_idx)

   193

            output_name = generator.ExtractModifier(output_variable, [("%s.%s"%(name, output_parameter), output_info)], output_info)

   194

            if to_inout:

   195

                variable_name = "%s_%s"%(name, output_parameter)

   196

                if not generator.IsAlreadyDefined(variable_name):

   197

                    if generator.Interface[-1][0] != "VAR" or generator.Interface[-1][1] is not None or generator.Interface[-1][2]:

   198

                        generator.Interface.append(("VAR", None, False, []))

   199

                    if variable.connectionPointOut in generator.ConnectionTypes:

   200

                        generator.Interface[-1][3].append(

   201

                            (generator.ConnectionTypes[output_variable.connectionPointOut], variable_name, None, None))

   202

                    else:

   203

                        generator.Interface[-1][3].append(("ANY", variable_name, None, None))

   204

                    generator.Program += [(generator.CurrentIndent, ()),

   205

                                          ("%s := "%variable_name, ())]

   206

                    generator.Program += output_name

   207

                    generator.Program += [(";\n", ())]

   208

                return [(variable_name, ())]

   209

            return output_name 

   210

    if link is not None:

   211

        if output_parameter is None:

   212

            output_parameter = ""

   213

        if name:

   214

            blockname = "%s(%s)" % (name, type)

   215

        else:

   216

            blockname = type

   217

        raise ValueError, _("No output %s variable found in block %s in POU %s. Connection must be broken")  % \

   218

                          (output_parameter, blockname, generator.Name)

   219

   220

def initialise_block(type, name, block = None):

   221

    return [(type, name, None, None)]

   222

   223

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

   224

#                        Function Block Types definitions

   225

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

   226

   227

   228

"""

   229

Ordored list of common Function Blocks defined in the IEC 61131-3

   230

Each block have this attributes:

   231

    - "name" : The block name

   232

    - "type" : The block type. It can be "function", "functionBlock" or "program"

   233

    - "extensible" : Boolean that define if the block is extensible

   234

    - "inputs" : List of the block inputs

   235

    - "outputs" : List of the block outputs

   236

    - "comment" : Comment that will be displayed in the block popup

   237

    - "generate" : Method that generator will call for generating ST block code

   238

Inputs and outputs are a tuple of characteristics that are in order:

   239

    - The name

   240

    - The data type

   241

    - The default modifier which can be "none", "negated", "rising" or "falling"

   242

"""

   243

   244

BlockTypes = [{"name" : _("Standard function blocks"), "list":

   245

               [{"name" : "SR", "type" : "functionBlock", "extensible" : False, 

   246

                    "inputs" : [("S1","BOOL","none"),("R","BOOL","none")], 

   247

                    "outputs" : [("Q1","BOOL","none")],

   248

                    "comment" : _("SR bistable\nThe SR bistable is a latch where the Set dominates."),

   249

                    "generate" : generate_block, "initialise" : initialise_block},

   250

                {"name" : "RS", "type" : "functionBlock", "extensible" : False, 

   251

                    "inputs" : [("S","BOOL","none"),("R1","BOOL","none")], 

   252

                    "outputs" : [("Q1","BOOL","none")],

   253

                    "comment" : _("RS bistable\nThe RS bistable is a latch where the Reset dominates."),

   254

                    "generate" : generate_block, "initialise" : initialise_block},

   255

                {"name" : "SEMA", "type" : "functionBlock", "extensible" : False, 

   256

                    "inputs" : [("CLAIM","BOOL","none"),("RELEASE","BOOL","none")], 

   257

                    "outputs" : [("BUSY","BOOL","none")],

   258

                    "comment" : _("Semaphore\nThe semaphore provides a mechanism to allow software elements mutually exclusive access to certain ressources."),

   259

                    "generate" : generate_block, "initialise" : initialise_block},

   260

                {"name" : "R_TRIG", "type" : "functionBlock", "extensible" : False, 

   261

                    "inputs" : [("CLK","BOOL","none")], 

   262

                    "outputs" : [("Q","BOOL","none")],

   263

                    "comment" : _("Rising edge detector\nThe output produces a single pulse when a rising edge is detected."),

   264

                    "generate" : generate_block, "initialise" : initialise_block},

   265

                {"name" : "F_TRIG", "type" : "functionBlock", "extensible" : False, 

   266

                    "inputs" : [("CLK","BOOL","none")], 

   267

                    "outputs" : [("Q","BOOL","none")],

   268

                    "comment" : _("Falling edge detector\nThe output produces a single pulse when a falling edge is detected."),

   269

                    "generate" : generate_block, "initialise" : initialise_block},

   270

                {"name" : "CTU", "type" : "functionBlock", "extensible" : False, 

   271

                    "inputs" : [("CU","BOOL","rising"),("R","BOOL","none"),("PV","INT","none")], 

   272

                    "outputs" : [("Q","BOOL","none"),("CV","INT","none")],

   273

                    "comment" : _("Up-counter\nThe up-counter can be used to signal when a count has reached a maximum value."),

   274

                    "generate" : generate_block, "initialise" : initialise_block},

   275

                {"name" : "CTD", "type" : "functionBlock", "extensible" : False, 

   276

                    "inputs" : [("CD","BOOL","rising"),("LD","BOOL","none"),("PV","INT","none")], 

   277

                    "outputs" : [("Q","BOOL","none"),("CV","INT","none")],

   278

                    "comment" : _("Down-counter\nThe down-counter can be used to signal when a count has reached zero, on counting down from a preset value."),

   279

                    "generate" : generate_block, "initialise" : initialise_block},

   280

                {"name" : "CTUD", "type" : "functionBlock", "extensible" : False, 

   281

                    "inputs" : [("CU","BOOL","rising"),("CD","BOOL","rising"),("R","BOOL","none"),("LD","BOOL","none"),("PV","INT","none")], 

   282

                    "outputs" : [("QU","BOOL","none"),("QD","BOOL","none"),("CV","INT","none")],

   283

                    "comment" : _("Up-down counter\nThe up-down counter has two inputs CU and CD. It can be used to both count up on one input and down on the other."),

   284

                    "generate" : generate_block, "initialise" : initialise_block},

   285

                {"name" : "TP", "type" : "functionBlock", "extensible" : False, 

   286

                    "inputs" : [("IN","BOOL","none"),("PT","TIME","none")], 

   287

                    "outputs" : [("Q","BOOL","none"),("ET","TIME","none")],

   288

                    "comment" : _("Pulse timer\nThe pulse timer can be used to generate output pulses of a given time duration."),

   289

                    "generate" : generate_block, "initialise" : initialise_block},

   290

                {"name" : "TON", "type" : "functionBlock", "extensible" : False, 

   291

                    "inputs" : [("IN","BOOL","none"),("PT","TIME","none")], 

   292

                    "outputs" : [("Q","BOOL","none"),("ET","TIME","none")],

   293

                    "comment" : _("On-delay timer\nThe on-delay timer can be used to delay setting an output true, for fixed period after an input becomes true."),

   294

                    "generate" : generate_block, "initialise" : initialise_block},

   295

                {"name" : "TOF", "type" : "functionBlock", "extensible" : False, 

   296

                    "inputs" : [("IN","BOOL","none"),("PT","TIME","none")], 

   297

                    "outputs" : [("Q","BOOL","none"),("ET","TIME","none")],

   298

                    "comment" : _("Off-delay timer\nThe off-delay timer can be used to delay setting an output false, for fixed period after input goes false."),

   299

                    "generate" : generate_block, "initialise" : initialise_block},

   300

                ]},

   301

              {"name" : _("Additional function blocks"), "list":

   302

               [{"name" : "RTC", "type" : "functionBlock", "extensible" : False, 

   303

                    "inputs" : [("IN","BOOL","none"),("PDT","DATE_AND_TIME","none")], 

   304

                    "outputs" : [("Q","BOOL","none"),("CDT","DATE_AND_TIME","none")],

   305

                    "comment" : _("Real time clock\nThe real time clock has many uses including time stamping, setting dates and times of day in batch reports, in alarm messages and so on."),

   306

                    "generate" : generate_block, "initialise" : initialise_block},

   307

                {"name" : "INTEGRAL", "type" : "functionBlock", "extensible" : False, 

   308

                    "inputs" : [("RUN","BOOL","none"),("R1","BOOL","none"),("XIN","REAL","none"),("X0","REAL","none"),("CYCLE","TIME","none")], 

   309

                    "outputs" : [("Q","BOOL","none"),("XOUT","REAL","none")],

   310

                    "comment" : _("Integral\nThe integral function block integrates the value of input XIN over time."),

   311

                    "generate" : generate_block, "initialise" : initialise_block},

   312

                {"name" : "DERIVATIVE", "type" : "functionBlock", "extensible" : False, 

   313

                    "inputs" : [("RUN","BOOL","none"),("XIN","REAL","none"),("CYCLE","TIME","none")], 

   314

                    "outputs" : [("XOUT","REAL","none")],

   315

                    "comment" : _("Derivative\nThe derivative function block produces an output XOUT proportional to the rate of change of the input XIN."),

   316

                    "generate" : generate_block, "initialise" : initialise_block},

   317

                {"name" : "PID", "type" : "functionBlock", "extensible" : False, 

   318

                    "inputs" : [("AUTO","BOOL","none"),("PV","REAL","none"),("SP","REAL","none"),("X0","REAL","none"),("KP","REAL","none"),("TR","REAL","none"),("TD","REAL","none"),("CYCLE","TIME","none")], 

   319

                    "outputs" : [("XOUT","REAL","none")],

   320

                    "comment" : _("PID\nThe PID (proportional, Integral, Derivative) function block provides the classical three term controller for closed loop control."),

   321

                    "generate" : generate_block, "initialise" : initialise_block},

   322

                {"name" : "RAMP", "type" : "functionBlock", "extensible" : False, 

   323

                    "inputs" : [("RUN","BOOL","none"),("X0","REAL","none"),("X1","REAL","none"),("TR","TIME","none"),("CYCLE","TIME","none")], 

   324

                    "outputs" : [("BUSY","BOOL","none"),("XOUT","REAL","none")],

   325

                    "comment" : _("Ramp\nThe RAMP function block is modelled on example given in the standard."),

   326

                    "generate" : generate_block, "initialise" : initialise_block},

   327

                {"name" : "HYSTERESIS", "type" : "functionBlock", "extensible" : False, 

   328

                    "inputs" : [("XIN1","REAL","none"),("XIN2","REAL","none"),("EPS","REAL","none")], 

   329

                    "outputs" : [("Q","BOOL","none")],

   330

                    "comment" : _("Hysteresis\nThe hysteresis function block provides a hysteresis boolean output driven by the difference of two floating point (REAL) inputs XIN1 and XIN2."),

   331

                    "generate" : generate_block, "initialise" : initialise_block},

   332

##                {"name" : "RATIO_MONITOR", "type" : "functionBlock", "extensible" : False, 

   333

##                    "inputs" : [("PV1","REAL","none"),("PV2","REAL","none"),("RATIO","REAL","none"),("TIMON","TIME","none"),("TIMOFF","TIME","none"),("TOLERANCE","BOOL","none"),("RESET","BOOL","none"),("CYCLE","TIME","none")], 

   334

##                    "outputs" : [("ALARM","BOOL","none"),("TOTAL_ERR","BOOL","none")],

   335

##                    "comment" : _("Ratio monitor\nThe ratio_monitor function block checks that one process value PV1 is always a given ratio (defined by input RATIO) of a second process value PV2."),

   336

##                    "generate" : generate_block, "initialise" : initialise_block}

   337

                ]},

   338

             ]

   339

   340

   341

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

   342

#                           Data Types definitions

   343

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

   344

   345

"""

   346

Ordored list of common data types defined in the IEC 61131-3

   347

Each type is associated to his direct parent type. It defines then a hierarchy

   348

between type that permits to make a comparison of two types

   349

"""

   350

TypeHierarchy_list = [

   351

    ("ANY", None),

   352

    ("ANY_DERIVED", "ANY"),

   353

    ("ANY_ELEMENTARY", "ANY"),

   354

    ("ANY_MAGNITUDE", "ANY_ELEMENTARY"),

   355

    ("ANY_BIT", "ANY_ELEMENTARY"),

   356

    ("ANY_NBIT", "ANY_BIT"),

   357

    ("ANY_STRING", "ANY_ELEMENTARY"),

   358

    ("ANY_DATE", "ANY_ELEMENTARY"),

   359

    ("ANY_NUM", "ANY_MAGNITUDE"),

   360

    ("ANY_REAL", "ANY_NUM"),

   361

    ("ANY_INT", "ANY_NUM"),

   362

    ("ANY_SINT", "ANY_INT"),

   363

    ("ANY_UINT", "ANY_INT"),

   364

    ("BOOL", "ANY_BIT"),

   365

    ("SINT", "ANY_SINT"),

   366

    ("INT", "ANY_SINT"),

   367

    ("DINT", "ANY_SINT"),

   368

    ("LINT", "ANY_SINT"),

   369

    ("USINT", "ANY_UINT"),

   370

    ("UINT", "ANY_UINT"),

   371

    ("UDINT", "ANY_UINT"),

   372

    ("ULINT", "ANY_UINT"),

   373

    ("REAL", "ANY_REAL"),

   374

    ("LREAL", "ANY_REAL"),

   375

    ("TIME", "ANY_MAGNITUDE"),

   376

    ("DATE", "ANY_DATE"),

   377

    ("TOD", "ANY_DATE"),

   378

    ("DT", "ANY_DATE"),

   379

    ("STRING", "ANY_STRING"),

   380

    ("BYTE", "ANY_NBIT"),

   381

    ("WORD", "ANY_NBIT"),

   382

    ("DWORD", "ANY_NBIT"),

   383

    ("LWORD", "ANY_NBIT")

   384

    #("WSTRING", "ANY_STRING") # TODO

   385

]

   386

   387

TypeHierarchy = dict(TypeHierarchy_list)

   388

   389

"""

   390

returns true if the given data type is the same that "reference" meta-type or one of its types.

   391

"""

   392

def IsOfType(type, reference):

   393

    if reference is None:

   394

        return True

   395

    elif type == reference:

   396

        return True

   397

    else:

   398

        parent_type = TypeHierarchy[type]

   399

        if parent_type is not None:

   400

            return IsOfType(parent_type, reference)

   401

    return False

   402

   403

"""

   404

returns list of all types that correspont to the ANY* meta type

   405

"""

   406

def GetSubTypes(type):

   407

    return [typename for typename, parenttype in TypeHierarchy.items() if not typename.startswith("ANY") and IsOfType(typename, type)]

   408

   409

   410

DataTypeRange_list = [

   411

    ("SINT", (-2**7, 2**7 - 1)),

   412

    ("INT", (-2**15, 2**15 - 1)),

   413

    ("DINT", (-2**31, 2**31 - 1)),

   414

    ("LINT", (-2**31, 2**31 - 1)),

   415

    ("USINT", (0, 2**8 - 1)),

   416

    ("UINT", (0, 2**16 - 1)),

   417

    ("UDINT", (0, 2**31 - 1)),

   418

    ("ULINT", (0, 2**31 - 1))

   419

]

   420

   421

DataTypeRange = dict(DataTypeRange_list)

   422

   423

   424

   425

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

   426

#                             Test identifier

   427

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

   428

   429

IDENTIFIER_MODEL = re.compile(

   430

    "(?:%(letter)s|_(?:%(letter)s|%(digit)s))(?:_?(?:%(letter)s|%(digit)s))*$" %

   431

    {"letter": "[a-zA-Z]", "digit": "[0-9]"})

   432

   433

# Test if identifier is valid

   434

def TestIdentifier(identifier):

   435

     return IDENTIFIER_MODEL.match(identifier) is not None

   436

   437

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

   438

#                        Standard functions list generation

   439

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

   440

   441

   442

"""

   443

take a .csv file and translate it it a "csv_table"

   444

"""            

   445

def csv_file_to_table(file):

   446

    return [ map(string.strip,line.split(';')) for line in file.xreadlines()]

   447

   448

"""

   449

seek into the csv table to a section ( section_name match 1st field )

   450

return the matching row without first field

   451

"""

   452

def find_section(section_name, table):

   453

    fields = [None]

   454

    while(fields[0] != section_name):

   455

        fields = table.pop(0)

   456

    return fields[1:]

   457

   458

"""

   459

extract the standard functions standard parameter names and types...

   460

return a { ParameterName: Type, ...}

   461

"""

   462

def get_standard_funtions_input_variables(table):

   463

    variables = find_section("Standard_functions_variables_types", table)

   464

    standard_funtions_input_variables = {}

   465

    fields = [True,True]

   466

    while(fields[1]):

   467

        fields = table.pop(0)

   468

        variable_from_csv = dict([(champ, val) for champ, val in zip(variables, fields[1:]) if champ!=''])

   469

        standard_funtions_input_variables[variable_from_csv['name']] = variable_from_csv['type']

   470

    return standard_funtions_input_variables

   471

   472

"""

   473

translate .csv file input declaration into PLCOpenEditor interessting values

   474

in : "(ANY_NUM, ANY_NUM)" and { ParameterName: Type, ...}

   475

return [("IN1","ANY_NUM","none"),("IN2","ANY_NUM","none")] 

   476

"""

   477

def csv_input_translate(str_decl, variables, base):

   478

    decl = str_decl.replace('(','').replace(')','').replace(' ','').split(',')

   479

    params = []

   480

   481

    len_of_not_predifined_variable = len([True for param_type in decl if param_type not in variables])

   482

   483

    for param_type in decl:

   484

        if param_type in variables.keys():

   485

            param_name = param_type

   486

            param_type = variables[param_type]

   487

        elif len_of_not_predifined_variable > 1:

   488

            param_name = "IN%d"%base

   489

            base += 1

   490

        else:

   491

            param_name = "IN"

   492

        params.append((param_name, param_type, "none"))

   493

    return params

   494

   495

   496

ANY_TO_ANY_LIST=[

   497

        # simple type conv are let as C cast

   498

        (("ANY_INT","ANY_BIT"),("ANY_NUM","ANY_BIT"), ("return_type", "__move_", "IN_type")),

   499

        (("ANY_REAL",),("ANY_REAL",), ("return_type", "__move_", "IN_type")),

   500

        # REAL_TO_INT

   501

        (("ANY_REAL",),("ANY_SINT",), ("return_type", "__real_to_sint", None)),

   502

        (("ANY_REAL",),("ANY_UINT",), ("return_type", "__real_to_uint", None)),

   503

        (("ANY_REAL",),("ANY_BIT",), ("return_type", "__real_to_bit", None)),

   504

        # TO_TIME

   505

        (("ANY_INT","ANY_BIT"),("ANY_DATE","TIME"), ("return_type", "__int_to_time", None)),

   506

        (("ANY_REAL",),("ANY_DATE","TIME"), ("return_type", "__real_to_time", None)),

   507

        (("ANY_STRING",), ("ANY_DATE","TIME"), ("return_type", "__string_to_time", None)),

   508

        # FROM_TIME

   509

        (("ANY_DATE","TIME"), ("ANY_REAL",), ("return_type", "__time_to_real", None)),

   510

        (("ANY_DATE","TIME"), ("ANY_INT","ANY_NBIT"), ("return_type", "__time_to_int", None)),

   511

        (("TIME",), ("ANY_STRING",), ("return_type", "__time_to_string", None)),

   512

        (("DATE",), ("ANY_STRING",), ("return_type", "__date_to_string", None)),

   513

        (("TOD",), ("ANY_STRING",), ("return_type", "__tod_to_string", None)),

   514

        (("DT",), ("ANY_STRING",), ("return_type", "__dt_to_string", None)),

   515

        # TO_STRING

   516

        (("BOOL",), ("ANY_STRING",), ("return_type", "__bool_to_string", None)),

   517

        (("ANY_BIT",), ("ANY_STRING",), ("return_type", "__bit_to_string", None)),

   518

        (("ANY_REAL",), ("ANY_STRING",), ("return_type", "__real_to_string", None)),

   519

        (("ANY_SINT",), ("ANY_STRING",), ("return_type", "__sint_to_string", None)),