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) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

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

    13

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

    14

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

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

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

    24

    25

    26

from __future__ import absolute_import

    27

from types import *

    28

import re

    29

from plcopen import PLCOpenParser

    30

from plcopen.structures import *

    31

from plcopen.types_enums import *

    32

    33

    34

# Dictionary associating PLCOpen variable categories to the corresponding

    35

# IEC 61131-3 variable categories

    36

varTypeNames = {"localVars": "VAR", "tempVars": "VAR_TEMP", "inputVars": "VAR_INPUT",

    37

                "outputVars": "VAR_OUTPUT", "inOutVars": "VAR_IN_OUT", "externalVars": "VAR_EXTERNAL",

    38

                "globalVars": "VAR_GLOBAL", "accessVars": "VAR_ACCESS"}

    39

    40

    41

# Dictionary associating PLCOpen POU categories to the corresponding

    42

# IEC 61131-3 POU categories

    43

pouTypeNames = {"function": "FUNCTION", "functionBlock": "FUNCTION_BLOCK", "program": "PROGRAM"}

    44

    45

    46

errorVarTypes = {

    47

    "VAR_INPUT": "var_input",

    48

    "VAR_OUTPUT": "var_output",

    49

    "VAR_INOUT": "var_inout",

    50

}

    51

    52

    53

def ReIndentText(text, nb_spaces):

    54

    """ Helper function for reindenting text """

    55

    compute = ""

    56

    lines = text.splitlines()

    57

    if len(lines) > 0:

    58

        line_num = 0

    59

        while line_num < len(lines) and len(lines[line_num].strip()) == 0:

    60

            line_num += 1

    61

        if line_num < len(lines):

    62

            spaces = 0

    63

            while lines[line_num][spaces] == " ":

    64

                spaces += 1

    65

            indent = ""

    66

            for dummy in xrange(spaces, nb_spaces):

    67

                indent += " "

    68

            for line in lines:

    69

                if line != "":

    70

                    compute += "%s%s\n" % (indent, line)

    71

                else:

    72

                    compute += "\n"

    73

    return compute

    74

    75

    76

def SortInstances(a, b):

    77

    ax, ay = int(a.getx()), int(a.gety())

    78

    bx, by = int(b.getx()), int(b.gety())

    79

    if abs(ay - by) < 10:

    80

        return cmp(ax, bx)

    81

    else:

    82

        return cmp(ay, by)

    83

    84

    85

def JoinList(separator, mylist):

    86

    """ Helper for emulate join on element list """

    87

    if len(mylist) > 0:

    88

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

    89

    else:

    90

        return mylist

    91

    92

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

    93

#                  Specific exception for PLC generating errors

    94

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

    95

    96

    97

class PLCGenException(Exception):

    98

    pass

    99

   100

   101

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

   102

#                           Generator of PLC program

   103

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

   104

   105

   106

class ProgramGenerator(object):

   107

   108

    # Create a new PCL program generator

   109

    def __init__(self, controler, project, errors, warnings):

   110

        # Keep reference of the controler and project

   111

        self.Controler = controler

   112

        self.Project = project

   113

        # Reset the internal variables used to generate PLC programs

   114

        self.Program = []

   115

        self.DatatypeComputed = {}

   116

        self.PouComputed = {}

   117

        self.Errors = errors

   118

        self.Warnings = warnings

   119

   120

    # Compute value according to type given

   121

    def ComputeValue(self, value, var_type):

   122

        base_type = self.Controler.GetBaseType(var_type)

   123

        if base_type == "STRING" and not value.startswith("'") and not value.endswith("'"):

   124

            return "'%s'" % value

   125

        elif base_type == "WSTRING" and not value.startswith('"') and not value.endswith('"'):

   126

            return "\"%s\"" % value

   127

        return value

   128

   129

    # Generate a data type from its name

   130

    def GenerateDataType(self, datatype_name):

   131

        # Verify that data type hasn't been generated yet

   132

        if not self.DatatypeComputed.get(datatype_name, True):

   133

            # If not mark data type as computed

   134

            self.DatatypeComputed[datatype_name] = True

   135

   136

            # Getting datatype model from project

   137

            datatype = self.Project.getdataType(datatype_name)

   138

            tagname = ComputeDataTypeName(datatype.getname())

   139

            datatype_def = [("  ", ()),

   140

                            (datatype.getname(), (tagname, "name")),

   141

                            (" : ", ())]

   142

            basetype_content = datatype.baseType.getcontent()

   143

            basetype_content_type = basetype_content.getLocalTag()

   144

            # Data type derived directly from a user defined type

   145

            if basetype_content_type == "derived":

   146

                basetype_name = basetype_content.getname()

   147

                self.GenerateDataType(basetype_name)

   148

                datatype_def += [(basetype_name, (tagname, "base"))]

   149

            # Data type is a subrange

   150

            elif basetype_content_type in ["subrangeSigned", "subrangeUnsigned"]:

   151

                base_type = basetype_content.baseType.getcontent()

   152

                base_type_type = base_type.getLocalTag()

   153

                # Subrange derived directly from a user defined type

   154

                if base_type_type == "derived":

   155

                    basetype_name = base_type_type.getname()

   156

                    self.GenerateDataType(basetype_name)

   157

                # Subrange derived directly from an elementary type

   158

                else:

   159

                    basetype_name = base_type_type

   160

                min_value = basetype_content.range.getlower()

   161

                max_value = basetype_content.range.getupper()

   162

                datatype_def += [(basetype_name, (tagname, "base")),

   163

                                 (" (", ()),

   164

                                 ("%s" % min_value, (tagname, "lower")),

   165

                                 ("..", ()),

   166

                                 ("%s" % max_value, (tagname, "upper")),

   167

                                 (")", ())]

   168

            # Data type is an enumerated type

   169

            elif basetype_content_type == "enum":

   170

                values = [[(value.getname(), (tagname, "value", i))]

   171

                          for i, value in enumerate(

   172

                              basetype_content.xpath("ppx:values/ppx:value",

   173

                                                     namespaces=PLCOpenParser.NSMAP))]

   174

                datatype_def += [("(", ())]

   175

                datatype_def += JoinList([(", ", ())], values)

   176

                datatype_def += [(")", ())]

   177

            # Data type is an array

   178

            elif basetype_content_type == "array":

   179

                base_type = basetype_content.baseType.getcontent()

   180

                base_type_type = base_type.getLocalTag()

   181

                # Array derived directly from a user defined type

   182

                if base_type_type == "derived":

   183

                    basetype_name = base_type.getname()

   184

                    self.GenerateDataType(basetype_name)

   185

                # Array derived directly from an elementary type

   186

                else:

   187

                    basetype_name = base_type_type.upper()

   188

                dimensions = [[("%s" % dimension.getlower(), (tagname, "range", i, "lower")),

   189

                               ("..", ()),

   190

                               ("%s" % dimension.getupper(), (tagname, "range", i, "upper"))]

   191

                              for i, dimension in enumerate(basetype_content.getdimension())]

   192

                datatype_def += [("ARRAY [", ())]

   193

                datatype_def += JoinList([(",", ())], dimensions)

   194

                datatype_def += [("] OF ", ()),

   195

                                 (basetype_name, (tagname, "base"))]

   196

            # Data type is a structure

   197

            elif basetype_content_type == "struct":

   198

                elements = []

   199

                for i, element in enumerate(basetype_content.getvariable()):

   200

                    element_type = element.type.getcontent()

   201

                    element_type_type = element_type.getLocalTag()

   202

                    # Structure element derived directly from a user defined type

   203

                    if element_type_type == "derived":

   204

                        elementtype_name = element_type.getname()

   205

                        self.GenerateDataType(elementtype_name)

   206

                    elif element_type_type == "array":

   207

                        base_type = element_type.baseType.getcontent()

   208

                        base_type_type = base_type.getLocalTag()

   209

                        # Array derived directly from a user defined type

   210

                        if base_type_type == "derived":

   211

                            basetype_name = base_type.getname()

   212

                            self.GenerateDataType(basetype_name)

   213

                        # Array derived directly from an elementary type

   214

                        else:

   215

                            basetype_name = base_type_type.upper()

   216

                        dimensions = ["%s..%s" % (dimension.getlower(), dimension.getupper())

   217

                                      for dimension in element_type.getdimension()]

   218

                        elementtype_name = "ARRAY [%s] OF %s" % (",".join(dimensions), basetype_name)

   219

                    # Structure element derived directly from an elementary type

   220

                    else:

   221

                        elementtype_name = element_type_type.upper()

   222

                    element_text = [("\n    ", ()),

   223

                                    (element.getname(), (tagname, "struct", i, "name")),

   224

                                    (" : ", ()),

   225

                                    (elementtype_name, (tagname, "struct", i, "type"))]

   226

                    if element.initialValue is not None:

   227

                        element_text.extend([(" := ", ()),

   228

                                             (self.ComputeValue(element.initialValue.getvalue(), elementtype_name), (tagname, "struct", i, "initial value"))])

   229

                    element_text.append((";", ()))

   230

                    elements.append(element_text)

   231

                datatype_def += [("STRUCT", ())]

   232

                datatype_def += JoinList([("", ())], elements)

   233

                datatype_def += [("\n  END_STRUCT", ())]

   234

            # Data type derived directly from a elementary type

   235

            else:

   236

                datatype_def += [(basetype_content_type.upper(), (tagname, "base"))]

   237

            # Data type has an initial value

   238

            if datatype.initialValue is not None:

   239

                datatype_def += [(" := ", ()),

   240

                                 (self.ComputeValue(datatype.initialValue.getvalue(), datatype_name), (tagname, "initial value"))]

   241

            datatype_def += [(";\n", ())]

   242

            self.Program += datatype_def

   243

   244

    # Generate a POU from its name

   245

    def GeneratePouProgram(self, pou_name):

   246

        # Verify that POU hasn't been generated yet

   247

        if not self.PouComputed.get(pou_name, True):

   248

            # If not mark POU as computed

   249

            self.PouComputed[pou_name] = True

   250

   251

            # Getting POU model from project

   252

            pou = self.Project.getpou(pou_name)

   253

            pou_type = pou.getpouType()

   254

            # Verify that POU type exists

   255

            if pou_type in pouTypeNames:

   256

                # Create a POU program generator

   257

                pou_program = PouProgramGenerator(self, pou.getname(), pouTypeNames[pou_type], self.Errors, self.Warnings)

   258

                program = pou_program.GenerateProgram(pou)

   259

                self.Program += program

   260

            else:

   261

                raise PLCGenException(_("Undefined pou type \"%s\"") % pou_type)

   262

   263

    # Generate a POU defined and used in text

   264

    def GeneratePouProgramInText(self, text):

   265

        for pou_name in self.PouComputed.keys():

   266

            model = re.compile("(?:^|[^0-9^A-Z])%s(?:$|[^0-9^A-Z])" % pou_name.upper())

   267

            if model.search(text) is not None:

   268

                self.GeneratePouProgram(pou_name)

   269

   270

    # Generate a configuration from its model

   271

    def GenerateConfiguration(self, configuration):

   272

        tagname = ComputeConfigurationName(configuration.getname())

   273

        config = [("\nCONFIGURATION ", ()),

   274

                  (configuration.getname(), (tagname, "name")),

   275

                  ("\n", ())]

   276

        var_number = 0

   277

   278

        varlists = [(varlist, varlist.getvariable()[:]) for varlist in configuration.getglobalVars()]

   279

   280

        extra_variables = self.Controler.GetConfigurationExtraVariables()

   281

        extra_global_vars = None

   282

        if len(extra_variables) > 0 and len(varlists) == 0:

   283

            extra_global_vars = PLCOpenParser.CreateElement("globalVars", "interface")

   284

            configuration.setglobalVars([extra_global_vars])

   285

            varlists = [(extra_global_vars, [])]

   286

   287

        for variable in extra_variables:

   288

            varlists[-1][0].appendvariable(variable)

   289

            varlists[-1][1].append(variable)

   290

   291

        # Generate any global variable in configuration

   292

        for varlist, varlist_variables in varlists:

   293

            variable_type = errorVarTypes.get("VAR_GLOBAL", "var_local")

   294

            # Generate variable block with modifier

   295

            config += [("  VAR_GLOBAL", ())]

   296

            if varlist.getconstant():

   297

                config += [(" CONSTANT", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "constant"))]

   298

            elif varlist.getretain():

   299

                config += [(" RETAIN", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "retain"))]

   300

            elif varlist.getnonretain():

   301

                config += [(" NON_RETAIN", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "non_retain"))]

   302

            config += [("\n", ())]

   303

            # Generate any variable of this block

   304

            for var in varlist_variables:

   305

                vartype_content = var.gettype().getcontent()

   306

                if vartype_content.getLocalTag() == "derived":

   307

                    var_type = vartype_content.getname()

   308

                    self.GenerateDataType(var_type)

   309

                else:

   310

                    var_type = var.gettypeAsText()

   311

   312

                config += [("    ", ()),

   313

                           (var.getname(), (tagname, variable_type, var_number, "name")),

   314

                           (" ", ())]

   315

                # Generate variable address if exists

   316

                address = var.getaddress()

   317

                if address:

   318

                    config += [("AT ", ()),

   319

                               (address, (tagname, variable_type, var_number, "location")),

   320

                               (" ", ())]

   321

                config += [(": ", ()),

   322

                           (var.gettypeAsText(), (tagname, variable_type, var_number, "type"))]

   323

                # Generate variable initial value if exists

   324

                initial = var.getinitialValue()

   325

                if initial is not None:

   326

                    config += [(" := ", ()),

   327

                               (self.ComputeValue(initial.getvalue(), var_type), (tagname, variable_type, var_number, "initial value"))]

   328

                config += [(";\n", ())]

   329

                var_number += 1

   330

            config += [("  END_VAR\n", ())]

   331

   332

        if extra_global_vars is not None:

   333

            configuration.remove(extra_global_vars)

   334

        else:

   335

            for variable in extra_variables:

   336

                varlists[-1][0].remove(variable)

   337

   338

        # Generate any resource in the configuration

   339

        for resource in configuration.getresource():

   340

            config += self.GenerateResource(resource, configuration.getname())

   341

        config += [("END_CONFIGURATION\n", ())]

   342

        return config

   343

   344

    # Generate a resource from its model

   345

    def GenerateResource(self, resource, config_name):

   346

        tagname = ComputeConfigurationResourceName(config_name, resource.getname())

   347

        resrce = [("\n  RESOURCE ", ()),

   348

                  (resource.getname(), (tagname, "name")),

   349

                  (" ON PLC\n", ())]

   350

        var_number = 0

   351

        # Generate any global variable in configuration

   352

        for varlist in resource.getglobalVars():

   353

            variable_type = errorVarTypes.get("VAR_GLOBAL", "var_local")

   354

            # Generate variable block with modifier

   355

            resrce += [("    VAR_GLOBAL", ())]

   356

            if varlist.getconstant():

   357

                resrce += [(" CONSTANT", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "constant"))]

   358

            elif varlist.getretain():

   359

                resrce += [(" RETAIN", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "retain"))]

   360

            elif varlist.getnonretain():

   361

                resrce += [(" NON_RETAIN", (tagname, variable_type, (var_number, var_number + len(varlist.getvariable())), "non_retain"))]

   362

            resrce += [("\n", ())]

   363

            # Generate any variable of this block

   364

            for var in varlist.getvariable():

   365

                vartype_content = var.gettype().getcontent()

   366

                if vartype_content.getLocalTag() == "derived":

   367

                    var_type = vartype_content.getname()

   368

                    self.GenerateDataType(var_type)

   369

                else:

   370

                    var_type = var.gettypeAsText()

   371

   372

                resrce += [("      ", ()),

   373

                           (var.getname(), (tagname, variable_type, var_number, "name")),

   374

                           (" ", ())]

   375

                address = var.getaddress()

   376

                # Generate variable address if exists

   377

                if address:

   378

                    resrce += [("AT ", ()),

   379

                               (address, (tagname, variable_type, var_number, "location")),

   380

                               (" ", ())]

   381

                resrce += [(": ", ()),

   382

                           (var.gettypeAsText(), (tagname, variable_type, var_number, "type"))]

   383

                # Generate variable initial value if exists

   384

                initial = var.getinitialValue()

   385

                if initial is not None:

   386

                    resrce += [(" := ", ()),

   387

                               (self.ComputeValue(initial.getvalue(), var_type), (tagname, variable_type, var_number, "initial value"))]

   388

                resrce += [(";\n", ())]

   389

                var_number += 1

   390

            resrce += [("    END_VAR\n", ())]

   391

        # Generate any task in the resource

   392

        tasks = resource.gettask()

   393

        task_number = 0

   394

        for task in tasks:

   395

            # Task declaration

   396

            resrce += [("    TASK ", ()),

   397

                       (task.getname(), (tagname, "task", task_number, "name")),

   398

                       ("(", ())]

   399

            single = task.getsingle()

   400

            # Single argument if exists

   401

            if single is not None:

   402

                if len(single) == 0:

   403

                    raise PLCGenException(

   404

                        _("Source signal has to be defined for single task '{a1}' in resource '{a2}.{a3}'.").

   405

                        format(a1=task.getname(), a2=config_name, a3=resource.getname()))

   406

   407

                if single[0] == '[' and single[-1] == ']':

   408

                    SNGLKW = "MULTI"

   409

                else:

   410

                    SNGLKW = "SINGLE"

   411

                resrce += [(SNGLKW + " := ", ()),

   412

                           (single, (tagname, "task", task_number, "single")),

   413

                           (",", ())]

   414

            # Interval argument if exists

   415

            interval = task.getinterval()

   416

            if interval is not None:

   417

                resrce += [("INTERVAL := ", ()),

   418

                           (interval, (tagname, "task", task_number, "interval")),

   419

                           (",", ())]

   420

#                resrce += [("INTERVAL := t#", ())]

   421

#                if interval.hour != 0:

   422

#                    resrce += [("%dh"%interval.hour, (tagname, "task", task_number, "interval", "hour"))]

   423

#                if interval.minute != 0:

   424

#                    resrce += [("%dm"%interval.minute, (tagname, "task", task_number, "interval", "minute"))]

   425

#                if interval.second != 0:

   426

#                    resrce += [("%ds"%interval.second, (tagname, "task", task_number, "interval", "second"))]

   427

#                if interval.microsecond != 0:

   428

#                    resrce += [("%dms"%(interval.microsecond / 1000), (tagname, "task", task_number, "interval", "millisecond"))]

   429

#                resrce += [(",", ())]

   430

            # Priority argument

   431

            resrce += [("PRIORITY := ", ()),

   432

                       ("%d" % task.getpriority(), (tagname, "task", task_number, "priority")),

   433

                       (");\n", ())]

   434

            task_number += 1

   435

        instance_number = 0

   436

        # Generate any program assign to each task

   437

        for task in tasks:

   438

            for instance in task.getpouInstance():

   439

                resrce += [("    PROGRAM ", ()),

   440

                           (instance.getname(), (tagname, "instance", instance_number, "name")),

   441

                           (" WITH ", ()),

   442

                           (task.getname(), (tagname, "instance", instance_number, "task")),

   443

                           (" : ", ()),

   444

                           (instance.gettypeName(), (tagname, "instance", instance_number, "type")),

   445

                           (";\n", ())]

   446

                instance_number += 1

   447

        # Generate any program assign to no task

   448

        for instance in resource.getpouInstance():

   449

            resrce += [("    PROGRAM ", ()),

   450

                       (instance.getname(),     (tagname, "instance", instance_number, "name")),

   451

                       (" : ", ()),

   452

                       (instance.gettypeName(), (tagname, "instance", instance_number, "type")),

   453

                       (";\n", ())]

   454

            instance_number += 1

   455

        resrce += [("  END_RESOURCE\n", ())]

   456

        return resrce

   457

   458

    # Generate the entire program for current project

   459

    def GenerateProgram(self):

   460

        # Find all data types defined

   461

        for datatype in self.Project.getdataTypes():

   462

            self.DatatypeComputed[datatype.getname()] = False

   463

        # Find all data types defined

   464

        for pou in self.Project.getpous():

   465

            self.PouComputed[pou.getname()] = False

   466

        # Generate data type declaration structure if there is at least one data

   467

        # type defined

   468

        if len(self.DatatypeComputed) > 0:

   469

            self.Program += [("TYPE\n", ())]

   470

            # Generate every data types defined

   471

            for datatype_name in self.DatatypeComputed.keys():

   472

                self.GenerateDataType(datatype_name)

   473

            self.Program += [("END_TYPE\n\n", ())]

   474

        # Generate every POUs defined

   475

        for pou_name in self.PouComputed.keys():

   476

            self.GeneratePouProgram(pou_name)

   477

        # Generate every configurations defined

   478

        for config in self.Project.getconfigurations():

   479

            self.Program += self.GenerateConfiguration(config)

   480

   481

    # Return generated program

   482

    def GetGeneratedProgram(self):

   483

        return self.Program

   484

   485

   486

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

   487

#                           Generator of POU programs

   488

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

   489

   490

[ConnectorClass, ContinuationClass, ActionBlockClass] = [

   491

    PLCOpenParser.GetElementClass(instance_name, "commonObjects")

   492

    for instance_name in ["connector", "continuation", "actionBlock"]]

   493

[InVariableClass, InOutVariableClass, OutVariableClass, BlockClass] = [

   494

    PLCOpenParser.GetElementClass(instance_name, "fbdObjects")

   495

    for instance_name in ["inVariable", "inOutVariable", "outVariable", "block"]]

   496

[ContactClass, CoilClass, LeftPowerRailClass, RightPowerRailClass] = [

   497

    PLCOpenParser.GetElementClass(instance_name, "ldObjects")

   498

    for instance_name in ["contact", "coil", "leftPowerRail", "rightPowerRail"]]

   499

[StepClass, TransitionClass, JumpStepClass,

   500

 SelectionConvergenceClass, SelectionDivergenceClass,

   501

 SimultaneousConvergenceClass, SimultaneousDivergenceClass] = [

   502

     PLCOpenParser.GetElementClass(instance_name, "sfcObjects")

   503