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

import re

    28

from six.moves import xrange

    29

    30

from plcopen import PLCOpenParser

    31

from plcopen.structures import *

    32

from plcopen.types_enums import *

    33

    34

    35

# Dictionary associating PLCOpen variable categories to the corresponding

    36

# IEC 61131-3 variable categories

    37

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

    38

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

    39

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

    40

    41

    42

# Dictionary associating PLCOpen POU categories to the corresponding

    43

# IEC 61131-3 POU categories

    44

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

    45

    46

    47

errorVarTypes = {

    48

    "VAR_INPUT": "var_input",

    49

    "VAR_OUTPUT": "var_output",

    50

    "VAR_INOUT": "var_inout",

    51

}

    52

    53

    54

def ReIndentText(text, nb_spaces):

    55

    """ Helper function for reindenting text """

    56

    compute = ""

    57

    lines = text.splitlines()

    58

    if len(lines) > 0:

    59

        line_num = 0

    60

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

    61

            line_num += 1

    62

        if line_num < len(lines):

    63

            spaces = 0

    64

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

    65

                spaces += 1

    66

            indent = ""

    67

            for dummy in xrange(spaces, nb_spaces):

    68

                indent += " "

    69

            for line in lines:

    70

                if line != "":

    71

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

    72

                else:

    73

                    compute += "\n"

    74

    return compute

    75

    76

    77

def SortInstances(a, b):

    78

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

    79

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

    80

    if abs(ay - by) < 10:

    81

        return cmp(ax, bx)

    82

    else:

    83

        return cmp(ay, by)

    84

    85

    86

def JoinList(separator, mylist):

    87

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

    88

    if len(mylist) > 0:

    89

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

    90

    else:

    91

        return mylist

    92

    93

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

    94

#                  Specific exception for PLC generating errors

    95

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

    96

    97

    98

class PLCGenException(Exception):

    99

    pass

   100

   101

   102

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

   103

#                           Generator of PLC program

   104

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

   105

   106

   107

class ProgramGenerator(object):

   108

   109

    # Create a new PCL program generator

   110

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

   111

        # Keep reference of the controler and project

   112

        self.Controler = controler

   113

        self.Project = project

   114

        # Reset the internal variables used to generate PLC programs

   115

        self.Program = []

   116

        self.DatatypeComputed = {}

   117

        self.PouComputed = {}

   118

        self.Errors = errors

   119

        self.Warnings = warnings

   120

   121

    # Compute value according to type given

   122

    def ComputeValue(self, value, var_type):

   123

        base_type = self.Controler.GetBaseType(var_type)

   124

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

   125

            return "'%s'" % value

   126

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

   127

            return "\"%s\"" % value

   128

        return value

   129

   130

    # Generate a data type from its name

   131

    def GenerateDataType(self, datatype_name):

   132

        # Verify that data type hasn't been generated yet

   133

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

   134

            # If not mark data type as computed

   135

            self.DatatypeComputed[datatype_name] = True

   136

   137

            # Getting datatype model from project

   138

            datatype = self.Project.getdataType(datatype_name)

   139

            tagname = ComputeDataTypeName(datatype.getname())

   140

            datatype_def = [("  ", ()),

   141

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

   142

                            (" : ", ())]

   143

            basetype_content = datatype.baseType.getcontent()

   144

            basetype_content_type = basetype_content.getLocalTag()

   145

            # Data type derived directly from a user defined type

   146

            if basetype_content_type == "derived":

   147

                basetype_name = basetype_content.getname()

   148

                self.GenerateDataType(basetype_name)

   149

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

   150

            # Data type is a subrange

   151

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

   152

                base_type = basetype_content.baseType.getcontent()

   153

                base_type_type = base_type.getLocalTag()

   154

                # Subrange derived directly from a user defined type

   155

                if base_type_type == "derived":

   156

                    basetype_name = base_type_type.getname()

   157

                    self.GenerateDataType(basetype_name)

   158

                # Subrange derived directly from an elementary type

   159

                else:

   160

                    basetype_name = base_type_type

   161

                min_value = basetype_content.range.getlower()

   162

                max_value = basetype_content.range.getupper()

   163

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

   164

                                 (" (", ()),

   165

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

   166

                                 ("..", ()),

   167

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

   168

                                 (")", ())]

   169

            # Data type is an enumerated type

   170

            elif basetype_content_type == "enum":

   171

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

   172

                          for i, value in enumerate(

   173

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

   174

                                                     namespaces=PLCOpenParser.NSMAP))]

   175

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

   176

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

   177

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

   178

            # Data type is an array

   179

            elif basetype_content_type == "array":

   180

                base_type = basetype_content.baseType.getcontent()

   181

                base_type_type = base_type.getLocalTag()

   182

                # Array derived directly from a user defined type

   183

                if base_type_type == "derived":

   184

                    basetype_name = base_type.getname()

   185

                    self.GenerateDataType(basetype_name)

   186

                # Array derived directly from an elementary type

   187

                else:

   188

                    basetype_name = base_type_type.upper()

   189

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

   190

                               ("..", ()),

   191

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

   192

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

   193

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

   194

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

   195

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

   196

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

   197

            # Data type is a structure

   198

            elif basetype_content_type == "struct":

   199

                elements = []

   200

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

   201

                    element_type = element.type.getcontent()

   202

                    element_type_type = element_type.getLocalTag()

   203

                    # Structure element derived directly from a user defined type

   204

                    if element_type_type == "derived":

   205

                        elementtype_name = element_type.getname()

   206

                        self.GenerateDataType(elementtype_name)

   207

                    elif element_type_type == "array":

   208

                        base_type = element_type.baseType.getcontent()

   209

                        base_type_type = base_type.getLocalTag()

   210

                        # Array derived directly from a user defined type

   211

                        if base_type_type == "derived":

   212

                            basetype_name = base_type.getname()

   213

                            self.GenerateDataType(basetype_name)

   214

                        # Array derived directly from an elementary type

   215

                        else:

   216

                            basetype_name = base_type_type.upper()

   217

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

   218

                                      for dimension in element_type.getdimension()]

   219

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

   220

                    # Structure element derived directly from an elementary type

   221

                    else:

   222

                        elementtype_name = element_type_type.upper()

   223

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

   224

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

   225

                                    (" : ", ()),

   226

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

   227

                    if element.initialValue is not None:

   228

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

   229

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

   230

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

   231

                    elements.append(element_text)

   232

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

   233

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

   234

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

   235

            # Data type derived directly from a elementary type

   236

            else:

   237

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

   238

            # Data type has an initial value

   239

            if datatype.initialValue is not None:

   240

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

   241

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

   242

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

   243

            self.Program += datatype_def

   244

   245

    # Generate a POU from its name

   246

    def GeneratePouProgram(self, pou_name):

   247

        # Verify that POU hasn't been generated yet

   248

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

   249

            # If not mark POU as computed

   250

            self.PouComputed[pou_name] = True

   251

   252

            # Getting POU model from project

   253

            pou = self.Project.getpou(pou_name)

   254

            pou_type = pou.getpouType()

   255

            # Verify that POU type exists

   256

            if pou_type in pouTypeNames:

   257

                # Create a POU program generator

   258

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

   259

                program = pou_program.GenerateProgram(pou)

   260

                self.Program += program

   261

            else:

   262

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

   263

   264

    # Generate a POU defined and used in text

   265

    def GeneratePouProgramInText(self, text):

   266

        for pou_name in self.PouComputed.keys():

   267

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

   268

            if model.search(text) is not None:

   269

                self.GeneratePouProgram(pou_name)

   270

   271

    # Generate a configuration from its model

   272

    def GenerateConfiguration(self, configuration):

   273

        tagname = ComputeConfigurationName(configuration.getname())

   274

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

   275

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

   276

                  ("\n", ())]

   277

        var_number = 0

   278

   279

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

   280

   281

        extra_variables = self.Controler.GetConfigurationExtraVariables()

   282

        extra_global_vars = None

   283

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

   284

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

   285

            configuration.setglobalVars([extra_global_vars])

   286

            varlists = [(extra_global_vars, [])]

   287

   288

        for variable in extra_variables:

   289

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

   290

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

   291

   292

        # Generate any global variable in configuration

   293

        for varlist, varlist_variables in varlists:

   294

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

   295

            # Generate variable block with modifier

   296

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

   297

            if varlist.getconstant():

   298

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

   299

            elif varlist.getretain():

   300

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

   301

            elif varlist.getnonretain():

   302

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

   303

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

   304

            # Generate any variable of this block

   305

            for var in varlist_variables:

   306

                vartype_content = var.gettype().getcontent()

   307

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

   308

                    var_type = vartype_content.getname()

   309

                    self.GenerateDataType(var_type)

   310

                else:

   311

                    var_type = var.gettypeAsText()

   312

   313

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

   314

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

   315

                           (" ", ())]

   316

                # Generate variable address if exists

   317

                address = var.getaddress()

   318

                if address:

   319

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

   320

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

   321

                               (" ", ())]

   322

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

   323

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

   324

                # Generate variable initial value if exists

   325

                initial = var.getinitialValue()

   326

                if initial is not None:

   327

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

   328

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

   329

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

   330

                var_number += 1

   331

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

   332

   333

        if extra_global_vars is not None:

   334

            configuration.remove(extra_global_vars)

   335

        else:

   336

            for variable in extra_variables:

   337

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

   338

   339

        # Generate any resource in the configuration

   340

        for resource in configuration.getresource():

   341

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

   342

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

   343

        return config

   344

   345

    # Generate a resource from its model

   346

    def GenerateResource(self, resource, config_name):

   347

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

   348

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

   349

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

   350

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

   351

        var_number = 0

   352

        # Generate any global variable in configuration

   353

        for varlist in resource.getglobalVars():

   354

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

   355

            # Generate variable block with modifier

   356

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

   357

            if varlist.getconstant():

   358

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

   359

            elif varlist.getretain():

   360

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

   361

            elif varlist.getnonretain():

   362

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

   363

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

   364

            # Generate any variable of this block

   365

            for var in varlist.getvariable():

   366

                vartype_content = var.gettype().getcontent()

   367

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

   368

                    var_type = vartype_content.getname()

   369

                    self.GenerateDataType(var_type)

   370

                else:

   371

                    var_type = var.gettypeAsText()

   372

   373

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

   374

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

   375

                           (" ", ())]

   376

                address = var.getaddress()

   377

                # Generate variable address if exists

   378

                if address:

   379

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

   380

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

   381

                               (" ", ())]

   382

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

   383

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

   384

                # Generate variable initial value if exists

   385

                initial = var.getinitialValue()

   386

                if initial is not None:

   387

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

   388

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

   389

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

   390

                var_number += 1

   391

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

   392

        # Generate any task in the resource

   393

        tasks = resource.gettask()

   394

        task_number = 0

   395

        for task in tasks:

   396

            # Task declaration

   397

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

   398

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

   399

                       ("(", ())]

   400

            single = task.getsingle()

   401

            # Single argument if exists

   402

            if single is not None:

   403

                if len(single) == 0:

   404

                    raise PLCGenException(

   405

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

   406

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

   407

   408

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

   409

                    SNGLKW = "MULTI"

   410

                else:

   411

                    SNGLKW = "SINGLE"

   412

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

   413

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

   414

                           (",", ())]

   415

            # Interval argument if exists

   416

            interval = task.getinterval()

   417

            if interval is not None:

   418

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

   419

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

   420

                           (",", ())]

   421

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

   422

#                if interval.hour != 0:

   423

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

   424

#                if interval.minute != 0:

   425

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

   426

#                if interval.second != 0:

   427

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

   428

#                if interval.microsecond != 0:

   429

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

   430

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

   431

            # Priority argument

   432

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

   433

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

   434

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

   435

            task_number += 1

   436

        instance_number = 0

   437

        # Generate any program assign to each task

   438

        for task in tasks:

   439

            for instance in task.getpouInstance():

   440

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

   441

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

   442

                           (" WITH ", ()),

   443

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

   444

                           (" : ", ()),

   445

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

   446

                           (";\n", ())]

   447

                instance_number += 1

   448

        # Generate any program assign to no task

   449

        for instance in resource.getpouInstance():

   450

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

   451

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

   452

                       (" : ", ()),

   453

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

   454

                       (";\n", ())]

   455

            instance_number += 1

   456

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

   457

        return resrce

   458

   459

    # Generate the entire program for current project

   460

    def GenerateProgram(self):

   461

        # Find all data types defined

   462

        for datatype in self.Project.getdataTypes():

   463

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

   464

        # Find all data types defined

   465

        for pou in self.Project.getpous():

   466

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

   467

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

   468

        # type defined

   469

        if len(self.DatatypeComputed) > 0:

   470

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

   471

            # Generate every data types defined

   472

            for datatype_name in self.DatatypeComputed.keys():

   473

                self.GenerateDataType(datatype_name)

   474

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

   475

        # Generate every POUs defined

   476

        for pou_name in self.PouComputed.keys():

   477

            self.GeneratePouProgram(pou_name)

   478

        # Generate every configurations defined

   479

        for config in self.Project.getconfigurations():

   480

            self.Program += self.GenerateConfiguration(config)

   481

   482

    # Return generated program

   483

    def GetGeneratedProgram(self):

   484

        return self.Program

   485

   486

   487

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

   488

#                           Generator of POU programs

   489

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

   490

   491

[ConnectorClass, ContinuationClass, ActionBlockClass] = [

   492

    PLCOpenParser.GetElementClass(instance_name, "commonObjects")

   493

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

   494

[InVariableClass, InOutVariableClass, OutVariableClass, BlockClass] = [

   495

    PLCOpenParser.GetElementClass(instance_name, "fbdObjects")

   496

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

   497

[ContactClass, CoilClass, LeftPowerRailClass, RightPowerRailClass] = [

   498

    PLCOpenParser.GetElementClass(instance_name, "ldObjects")

   499

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

   500

[StepClass, TransitionClass, JumpStepClass,

   501

 SelectionConvergenceClass, SelectionDivergenceClass,

   502

 SimultaneousConvergenceClass, SimultaneousDivergenceClass] = [

   503