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 functools import cmp_to_key

    27

from operator import eq

    28

import re

    29

from functools import reduce

    30

    31

from plcopen import PLCOpenParser

    32

from plcopen.structures import *

    33

from plcopen.types_enums import *

    34

    35

    36

# Dictionary associating PLCOpen variable categories to the corresponding

    37

# IEC 61131-3 variable categories

    38

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

    39

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

    40

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

    41

    42

    43

# Dictionary associating PLCOpen POU categories to the corresponding

    44

# IEC 61131-3 POU categories

    45

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

    46

    47

    48

errorVarTypes = {

    49

    "VAR_INPUT": "var_input",

    50

    "VAR_OUTPUT": "var_output",

    51

    "VAR_INOUT": "var_inout",

    52

}

    53

    54

    55

def ReIndentText(text, nb_spaces):

    56

    """ Helper function for reindenting text """

    57

    compute = ""

    58

    lines = text.splitlines()

    59

    if len(lines) > 0:

    60

        line_num = 0

    61

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

    62

            line_num += 1

    63

        if line_num < len(lines):

    64

            spaces = 0

    65

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

    66

                spaces += 1

    67

            indent = ""

    68

            for dummy in range(spaces, nb_spaces):

    69

                indent += " "

    70

            for line in lines:

    71

                if line != "":

    72

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

    73

                else:

    74

                    compute += "\n"

    75

    return compute

    76

    77

    78

def SortInstances(a, b):

    79

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

    80

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

    81

    if abs(ay - by) < 10:

    82

        return eq(ax, bx)

    83

    else:

    84

        return eq(ay, by)

    85

    86

    87

def JoinList(separator, mylist):

    88

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

    89

    if len(mylist) > 0:

    90

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

    91

    else:

    92

        return mylist

    93

    94

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

    95

#                  Specific exception for PLC generating errors

    96

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

    97

    98

    99

class PLCGenException(Exception):

   100

    pass

   101

   102

   103

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

   104

#                           Generator of PLC program

   105

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

   106

   107

   108

class ProgramGenerator(object):

   109

   110

    # Create a new PCL program generator

   111

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

   112

        # Keep reference of the controler and project

   113

        self.Controler = controler

   114

        self.Project = project

   115

        # Reset the internal variables used to generate PLC programs

   116

        self.Program = []

   117

        self.DatatypeComputed = {}

   118

        self.PouComputed = {}

   119

        self.Errors = errors

   120

        self.Warnings = warnings

   121

   122

    # Compute value according to type given

   123

    def ComputeValue(self, value, var_type):

   124

        base_type = self.Controler.GetBaseType(var_type)

   125

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

   126

            return "'%s'" % value

   127

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

   128

            return "\"%s\"" % value

   129

        return value

   130

   131

    # Generate a data type from its name

   132

    def GenerateDataType(self, datatype_name):

   133

        # Verify that data type hasn't been generated yet

   134

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

   135

            # If not mark data type as computed

   136

            self.DatatypeComputed[datatype_name] = True

   137

   138

            # Getting datatype model from project

   139

            datatype = self.Project.getdataType(datatype_name)

   140

            tagname = ComputeDataTypeName(datatype.getname())

   141

            datatype_def = [("  ", ()),

   142

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

   143

                            (" : ", ())]

   144

            basetype_content = datatype.baseType.getcontent()

   145

            basetype_content_type = basetype_content.getLocalTag()

   146

            # Data type derived directly from a user defined type

   147

            if basetype_content_type == "derived":

   148

                basetype_name = basetype_content.getname()

   149

                self.GenerateDataType(basetype_name)

   150

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

   151

            # Data type is a subrange

   152

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

   153

                base_type = basetype_content.baseType.getcontent()

   154

                base_type_type = base_type.getLocalTag()

   155

                # Subrange derived directly from a user defined type

   156

                if base_type_type == "derived":

   157

                    basetype_name = base_type_type.getname()

   158

                    self.GenerateDataType(basetype_name)

   159

                # Subrange derived directly from an elementary type

   160

                else:

   161

                    basetype_name = base_type_type

   162

                min_value = basetype_content.range.getlower()

   163

                max_value = basetype_content.range.getupper()

   164

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

   165

                                 (" (", ()),

   166

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

   167

                                 ("..", ()),

   168

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

   169

                                 (")", ())]

   170

            # Data type is an enumerated type

   171

            elif basetype_content_type == "enum":

   172

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

   173

                          for i, value in enumerate(

   174

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

   175

                                                     namespaces=PLCOpenParser.NSMAP))]

   176

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

   177

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

   178

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

   179

            # Data type is an array

   180

            elif basetype_content_type == "array":

   181

                base_type = basetype_content.baseType.getcontent()

   182

                base_type_type = base_type.getLocalTag()

   183

                # Array derived directly from a user defined type

   184

                if base_type_type == "derived":

   185

                    basetype_name = base_type.getname()

   186

                    self.GenerateDataType(basetype_name)

   187

                # Array derived directly from an elementary type

   188

                else:

   189

                    basetype_name = base_type_type.upper()

   190

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

   191

                               ("..", ()),

   192

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

   193

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

   194

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

   195

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

   196

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

   197

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

   198

            # Data type is a structure

   199

            elif basetype_content_type == "struct":

   200

                elements = []

   201

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

   202

                    element_type = element.type.getcontent()

   203

                    element_type_type = element_type.getLocalTag()

   204

                    # Structure element derived directly from a user defined type

   205

                    if element_type_type == "derived":

   206

                        elementtype_name = element_type.getname()

   207

                        self.GenerateDataType(elementtype_name)

   208

                    elif element_type_type == "array":

   209

                        base_type = element_type.baseType.getcontent()

   210

                        base_type_type = base_type.getLocalTag()

   211

                        # Array derived directly from a user defined type

   212

                        if base_type_type == "derived":

   213

                            basetype_name = base_type.getname()

   214

                            self.GenerateDataType(basetype_name)

   215

                        # Array derived directly from an elementary type

   216

                        else:

   217

                            basetype_name = base_type_type.upper()

   218

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

   219

                                      for dimension in element_type.getdimension()]

   220

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

   221

                    # Structure element derived directly from an elementary type

   222

                    else:

   223

                        elementtype_name = element_type_type.upper()

   224

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

   225

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

   226

                                    (" : ", ()),

   227

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

   228

                    if element.initialValue is not None:

   229

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

   230

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

   231

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

   232

                    elements.append(element_text)

   233

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

   234

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

   235

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

   236

            # Data type derived directly from a elementary type

   237

            else:

   238

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

   239

            # Data type has an initial value

   240

            if datatype.initialValue is not None:

   241

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

   242

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

   243

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

   244

            self.Program += datatype_def

   245

   246

    # Generate a POU from its name

   247

    def GeneratePouProgram(self, pou_name):

   248

        # Verify that POU hasn't been generated yet

   249

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

   250

            # If not mark POU as computed

   251

            self.PouComputed[pou_name] = True

   252

   253

            # Getting POU model from project

   254

            pou = self.Project.getpou(pou_name)

   255

            pou_type = pou.getpouType()

   256

            # Verify that POU type exists

   257

            if pou_type in pouTypeNames:

   258

                # Create a POU program generator

   259

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

   260

                program = pou_program.GenerateProgram(pou)

   261

                self.Program += program

   262

            else:

   263

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

   264

   265

    # Generate a POU defined and used in text

   266

    def GeneratePouProgramInText(self, text):

   267

        for pou_name in list(self.PouComputed.keys()):

   268

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

   269

            if model.search(text) is not None:

   270

                self.GeneratePouProgram(pou_name)

   271

   272

    # Generate a configuration from its model

   273

    def GenerateConfiguration(self, configuration):

   274

        tagname = ComputeConfigurationName(configuration.getname())

   275

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

   276

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

   277

                  ("\n", ())]

   278

        var_number = 0

   279

   280

        varlists = configuration.getglobalVars()[:]

   281

   282

        extra_variables = self.Controler.GetConfigurationExtraVariables()

   283

        extra_CTN_globals = []

   284

   285

        for item in extra_variables:

   286

            if item.getLocalTag() == "globalVars":

   287

                varlists.append(item)

   288

            else:

   289

                extra_CTN_globals.append(item)

   290

   291

        if len(extra_CTN_globals) > 0:

   292

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

   293

   294

            for variable in extra_CTN_globals:

   295

                extra_varlist.appendvariable(variable)

   296

   297

            varlists.append(extra_varlist)

   298

   299

        # Generate any global variable in configuration

   300

        for varlist in varlists:

   301

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

   302

            # Generate variable block with modifier

   303

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

   304

            if varlist.getconstant():

   305

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

   306

            elif varlist.getretain():

   307

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

   308

            elif varlist.getnonretain():

   309

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

   310

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

   311

            # Generate any variable of this block

   312

            for var in varlist.getvariable():

   313

                vartype_content = var.gettype().getcontent()

   314

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

   315

                    var_type = vartype_content.getname()

   316

                    self.GenerateDataType(var_type)

   317

                else:

   318

                    var_type = var.gettypeAsText()

   319

   320

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

   321

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

   322

                           (" ", ())]

   323

                # Generate variable address if exists

   324

                address = var.getaddress()

   325

                if address:

   326

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

   327

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

   328

                               (" ", ())]

   329

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

   330

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

   331

                # Generate variable initial value if exists

   332

                initial = var.getinitialValue()

   333

                if initial is not None:

   334

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

   335

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

   336

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

   337

                var_number += 1

   338

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

   339

   340

        # Generate any resource in the configuration

   341

        for resource in configuration.getresource():

   342

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

   343

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

   344

        return config

   345

   346

    # Generate a resource from its model

   347

    def GenerateResource(self, resource, config_name):

   348

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

   349

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

   350

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

   351

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

   352

        var_number = 0

   353

        # Generate any global variable in configuration

   354

        for varlist in resource.getglobalVars():

   355

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

   356

            # Generate variable block with modifier

   357

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

   358

            if varlist.getconstant():

   359

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

   360

            elif varlist.getretain():

   361

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

   362

            elif varlist.getnonretain():

   363

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

   364

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

   365

            # Generate any variable of this block

   366

            for var in varlist.getvariable():

   367

                vartype_content = var.gettype().getcontent()

   368

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

   369

                    var_type = vartype_content.getname()

   370

                    self.GenerateDataType(var_type)

   371

                else:

   372

                    var_type = var.gettypeAsText()

   373

   374

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

   375

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

   376

                           (" ", ())]

   377

                address = var.getaddress()

   378

                # Generate variable address if exists

   379

                if address:

   380

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

   381

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

   382

                               (" ", ())]

   383

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

   384

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

   385

                # Generate variable initial value if exists

   386

                initial = var.getinitialValue()

   387

                if initial is not None:

   388

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

   389

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

   390

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

   391

                var_number += 1

   392

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

   393

        # Generate any task in the resource

   394

        tasks = resource.gettask()

   395

        task_number = 0

   396

        for task in tasks:

   397

            # Task declaration

   398

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

   399

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

   400

                       ("(", ())]

   401

            single = task.getsingle()

   402

            # Single argument if exists

   403

            if single is not None:

   404

                if len(single) == 0:

   405

                    raise PLCGenException(

   406

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

   407

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

   408

   409

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

   410

                    SNGLKW = "MULTI"

   411

                else:

   412

                    SNGLKW = "SINGLE"

   413

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

   414

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

   415

                           (",", ())]

   416

            # Interval argument if exists

   417

            interval = task.getinterval()

   418

            if interval is not None:

   419

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

   420

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

   421

                           (",", ())]

   422

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

   423

#                if interval.hour != 0:

   424

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

   425

#                if interval.minute != 0:

   426

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

   427

#                if interval.second != 0:

   428

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

   429

#                if interval.microsecond != 0:

   430

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

   431

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

   432

            # Priority argument

   433

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

   434

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

   435

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

   436

            task_number += 1

   437

        instance_number = 0

   438

        # Generate any program assign to each task

   439

        for task in tasks:

   440

            for instance in task.getpouInstance():

   441

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

   442

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

   443

                           (" WITH ", ()),

   444

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

   445

                           (" : ", ()),

   446

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

   447

                           (";\n", ())]

   448

                instance_number += 1

   449

        # Generate any program assign to no task

   450

        for instance in resource.getpouInstance():

   451

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

   452

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

   453

                       (" : ", ()),

   454

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

   455

                       (";\n", ())]

   456

            instance_number += 1

   457

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

   458

        return resrce

   459

   460

    # Generate the entire program for current project

   461

    def GenerateProgram(self, log, noconfig=False):

   462

        log("Collecting data types")

   463

        # Find all data types defined

   464

        for datatype in self.Project.getdataTypes():

   465

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

   466

        log("Collecting POUs")

   467

        # Find all data types defined

   468

        for pou in self.Project.getpous():

   469

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

   470

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

   471

        # type defined

   472

        if len(self.DatatypeComputed) > 0:

   473

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

   474

            # Generate every data types defined

   475

            for datatype_name in list(self.DatatypeComputed.keys()):

   476

                log("Generate Data Type %s"%datatype_name)

   477

                self.GenerateDataType(datatype_name)

   478

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

   479

        # Generate every POUs defined

   480

        for pou_name in list(self.PouComputed.keys()):

   481

            log("Generate POU %s"%pou_name)

   482

            self.GeneratePouProgram(pou_name)

   483

        if noconfig:

   484

            return

   485

        # Generate every configurations defined

   486

        log("Generate Config(s)")

   487

        for config in self.Project.getconfigurations():

   488

            self.Program += self.GenerateConfiguration(config)

   489

   490

    # Return generated program

   491

    def GetGeneratedProgram(self):

   492

        return self.Program

   493

   494

   495

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

   496

#                           Generator of POU programs

   497

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

   498

   499

[ConnectorClass, ContinuationClass, ActionBlockClass] = [

   500

    PLCOpenParser.GetElementClass(instance_name, "commonObjects")

   501

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

   502

[InVariableClass, InOutVariableClass, OutVariableClass, BlockClass] = [