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 types import *

    27

import re

    28

from plcopen import PLCOpenParser

    29

from plcopen.structures import *

    30

    31

    32

# Dictionary associating PLCOpen variable categories to the corresponding

    33

# IEC 61131-3 variable categories

    34

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

    35

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

    36

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

    37

    38

    39

# Dictionary associating PLCOpen POU categories to the corresponding

    40

# IEC 61131-3 POU categories

    41

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

    42

    43

    44

errorVarTypes = {

    45

    "VAR_INPUT": "var_input",

    46

    "VAR_OUTPUT": "var_output",

    47

    "VAR_INOUT": "var_inout",

    48

}

    49

    50

    51

def ReIndentText(text, nb_spaces):

    52

    """ Helper function for reindenting text """

    53

    compute = ""

    54

    lines = text.splitlines()

    55

    if len(lines) > 0:

    56

        line_num = 0

    57

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

    58

            line_num += 1

    59

        if line_num < len(lines):

    60

            spaces = 0

    61

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

    62

                spaces += 1

    63

            indent = ""

    64

            for dummy in xrange(spaces, nb_spaces):

    65

                indent += " "

    66

            for line in lines:

    67

                if line != "":

    68

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

    69

                else:

    70

                    compute += "\n"

    71

    return compute

    72

    73

    74

def SortInstances(a, b):

    75

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

    76

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

    77

    if abs(ay - by) < 10:

    78

        return cmp(ax, bx)

    79

    else:

    80

        return cmp(ay, by)

    81

    82

    83

def JoinList(separator, mylist):

    84

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

    85

    if len(mylist) > 0:

    86

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

    87

    else:

    88

        return mylist

    89

    90

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

    91

#                  Specific exception for PLC generating errors

    92

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

    93

    94

    95

class PLCGenException(Exception):

    96

    pass

    97

    98

    99

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

   100

#                           Generator of PLC program

   101

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

   102

   103

   104

class ProgramGenerator(object):

   105

   106

    # Create a new PCL program generator

   107

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

   108

        # Keep reference of the controler and project

   109

        self.Controler = controler

   110

        self.Project = project

   111

        # Reset the internal variables used to generate PLC programs

   112

        self.Program = []

   113

        self.DatatypeComputed = {}

   114

        self.PouComputed = {}

   115

        self.Errors = errors

   116

        self.Warnings = warnings

   117

   118

    # Compute value according to type given

   119

    def ComputeValue(self, value, var_type):

   120

        base_type = self.Controler.GetBaseType(var_type)

   121

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

   122

            return "'%s'" % value

   123

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

   124

            return "\"%s\"" % value

   125

        return value

   126

   127

    # Generate a data type from its name

   128

    def GenerateDataType(self, datatype_name):

   129

        # Verify that data type hasn't been generated yet

   130

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

   131

            # If not mark data type as computed

   132

            self.DatatypeComputed[datatype_name] = True

   133

   134

            # Getting datatype model from project

   135

            datatype = self.Project.getdataType(datatype_name)

   136

            tagname = self.Controler.ComputeDataTypeName(datatype.getname())

   137

            datatype_def = [("  ", ()),

   138

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

   139

                            (" : ", ())]

   140

            basetype_content = datatype.baseType.getcontent()

   141

            basetype_content_type = basetype_content.getLocalTag()

   142

            # Data type derived directly from a user defined type

   143

            if basetype_content_type == "derived":

   144

                basetype_name = basetype_content.getname()

   145

                self.GenerateDataType(basetype_name)

   146

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

   147

            # Data type is a subrange

   148

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

   149

                base_type = basetype_content.baseType.getcontent()

   150

                base_type_type = base_type.getLocalTag()

   151

                # Subrange derived directly from a user defined type

   152

                if base_type_type == "derived":

   153

                    basetype_name = base_type_type.getname()

   154

                    self.GenerateDataType(basetype_name)

   155

                # Subrange derived directly from an elementary type

   156

                else:

   157

                    basetype_name = base_type_type

   158

                min_value = basetype_content.range.getlower()

   159

                max_value = basetype_content.range.getupper()

   160

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

   161

                                 (" (", ()),

   162

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

   163

                                 ("..", ()),

   164

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

   165

                                 (")", ())]

   166

            # Data type is an enumerated type

   167

            elif basetype_content_type == "enum":

   168

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

   169

                          for i, value in enumerate(

   170

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

   171

                                                     namespaces=PLCOpenParser.NSMAP))]

   172

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

   173

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

   174

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

   175

            # Data type is an array

   176

            elif basetype_content_type == "array":

   177

                base_type = basetype_content.baseType.getcontent()

   178

                base_type_type = base_type.getLocalTag()

   179

                # Array derived directly from a user defined type

   180

                if base_type_type == "derived":

   181

                    basetype_name = base_type.getname()

   182

                    self.GenerateDataType(basetype_name)

   183

                # Array derived directly from an elementary type

   184

                else:

   185

                    basetype_name = base_type_type.upper()

   186

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

   187

                               ("..", ()),

   188

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

   189

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

   190

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

   191

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

   192

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

   193

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

   194

            # Data type is a structure

   195

            elif basetype_content_type == "struct":

   196

                elements = []

   197

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

   198

                    element_type = element.type.getcontent()

   199

                    element_type_type = element_type.getLocalTag()

   200

                    # Structure element derived directly from a user defined type

   201

                    if element_type_type == "derived":

   202

                        elementtype_name = element_type.getname()

   203

                        self.GenerateDataType(elementtype_name)

   204

                    elif element_type_type == "array":

   205

                        base_type = element_type.baseType.getcontent()

   206

                        base_type_type = base_type.getLocalTag()

   207

                        # Array derived directly from a user defined type

   208

                        if base_type_type == "derived":

   209

                            basetype_name = base_type.getname()

   210

                            self.GenerateDataType(basetype_name)

   211

                        # Array derived directly from an elementary type

   212

                        else:

   213

                            basetype_name = base_type_type.upper()

   214

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

   215

                                      for dimension in element_type.getdimension()]

   216

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

   217

                    # Structure element derived directly from an elementary type

   218

                    else:

   219

                        elementtype_name = element_type_type.upper()

   220

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

   221

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

   222

                                    (" : ", ()),

   223

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

   224

                    if element.initialValue is not None:

   225

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

   226

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

   227

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

   228

                    elements.append(element_text)

   229

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

   230

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

   231

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

   232

            # Data type derived directly from a elementary type

   233

            else:

   234

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

   235

            # Data type has an initial value

   236

            if datatype.initialValue is not None:

   237

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

   238

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

   239

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

   240

            self.Program += datatype_def

   241

   242

    # Generate a POU from its name

   243

    def GeneratePouProgram(self, pou_name):

   244

        # Verify that POU hasn't been generated yet

   245

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

   246

            # If not mark POU as computed

   247

            self.PouComputed[pou_name] = True

   248

   249

            # Getting POU model from project

   250

            pou = self.Project.getpou(pou_name)

   251

            pou_type = pou.getpouType()

   252

            # Verify that POU type exists

   253

            if pou_type in pouTypeNames:

   254

                # Create a POU program generator

   255

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

   256

                program = pou_program.GenerateProgram(pou)

   257

                self.Program += program

   258

            else:

   259

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

   260

   261

    # Generate a POU defined and used in text

   262

    def GeneratePouProgramInText(self, text):

   263

        for pou_name in self.PouComputed.keys():

   264

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

   265

            if model.search(text) is not None:

   266

                self.GeneratePouProgram(pou_name)

   267

   268

    # Generate a configuration from its model

   269

    def GenerateConfiguration(self, configuration):

   270

        tagname = self.Controler.ComputeConfigurationName(configuration.getname())

   271

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

   272

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

   273

                  ("\n", ())]

   274

        var_number = 0

   275

   276

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

   277

   278

        extra_variables = self.Controler.GetConfigurationExtraVariables()

   279

        extra_global_vars = None

   280

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

   281

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

   282

            configuration.setglobalVars([extra_global_vars])

   283

            varlists = [(extra_global_vars, [])]

   284

   285

        for variable in extra_variables:

   286

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

   287

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

   288

   289

        # Generate any global variable in configuration

   290

        for varlist, varlist_variables in varlists:

   291

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

   292

            # Generate variable block with modifier

   293

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

   294

            if varlist.getconstant():

   295

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

   296

            elif varlist.getretain():

   297

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

   298

            elif varlist.getnonretain():

   299

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

   300

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

   301

            # Generate any variable of this block

   302

            for var in varlist_variables:

   303

                vartype_content = var.gettype().getcontent()

   304

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

   305

                    var_type = vartype_content.getname()

   306

                    self.GenerateDataType(var_type)

   307

                else:

   308

                    var_type = var.gettypeAsText()

   309

   310

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

   311

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

   312

                           (" ", ())]

   313

                # Generate variable address if exists

   314

                address = var.getaddress()

   315

                if address:

   316

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

   317

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

   318

                               (" ", ())]

   319

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

   320

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

   321

                # Generate variable initial value if exists

   322

                initial = var.getinitialValue()

   323

                if initial is not None:

   324

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

   325

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

   326

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

   327

                var_number += 1

   328

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

   329

   330

        if extra_global_vars is not None:

   331

            configuration.remove(extra_global_vars)

   332

        else:

   333

            for variable in extra_variables:

   334

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

   335

   336

        # Generate any resource in the configuration

   337

        for resource in configuration.getresource():

   338

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

   339

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

   340

        return config

   341

   342

    # Generate a resource from its model

   343

    def GenerateResource(self, resource, config_name):

   344

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

   345

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

   346

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

   347

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

   348

        var_number = 0

   349

        # Generate any global variable in configuration

   350

        for varlist in resource.getglobalVars():

   351

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

   352

            # Generate variable block with modifier

   353

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

   354

            if varlist.getconstant():

   355

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

   356

            elif varlist.getretain():

   357

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

   358

            elif varlist.getnonretain():

   359

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

   360

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

   361

            # Generate any variable of this block

   362

            for var in varlist.getvariable():

   363

                vartype_content = var.gettype().getcontent()

   364

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

   365

                    var_type = vartype_content.getname()

   366

                    self.GenerateDataType(var_type)

   367

                else:

   368

                    var_type = var.gettypeAsText()

   369

   370

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

   371

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

   372

                           (" ", ())]

   373

                address = var.getaddress()

   374

                # Generate variable address if exists

   375

                if address:

   376

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

   377

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

   378

                               (" ", ())]

   379

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

   380

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

   381

                # Generate variable initial value if exists

   382

                initial = var.getinitialValue()

   383

                if initial is not None:

   384

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

   385

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

   386

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

   387

                var_number += 1

   388

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

   389

        # Generate any task in the resource

   390

        tasks = resource.gettask()

   391

        task_number = 0

   392

        for task in tasks:

   393

            # Task declaration

   394

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

   395

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

   396

                       ("(", ())]

   397

            single = task.getsingle()

   398

            # Single argument if exists

   399

            if single is not None:

   400

                if len(single) == 0:

   401

                    raise PLCGenException(

   402

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

   403

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

   404

   405

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

   406

                    SNGLKW = "MULTI"

   407

                else:

   408

                    SNGLKW = "SINGLE"

   409

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

   410

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

   411

                           (",", ())]

   412

            # Interval argument if exists

   413

            interval = task.getinterval()

   414

            if interval is not None:

   415

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

   416

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

   417

                           (",", ())]

   418

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

   419

#                if interval.hour != 0:

   420

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

   421

#                if interval.minute != 0:

   422

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

   423

#                if interval.second != 0:

   424

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

   425

#                if interval.microsecond != 0:

   426

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

   427

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

   428

            # Priority argument

   429

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

   430

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

   431

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

   432

            task_number += 1

   433

        instance_number = 0

   434

        # Generate any program assign to each task

   435

        for task in tasks:

   436

            for instance in task.getpouInstance():

   437

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

   438

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

   439

                           (" WITH ", ()),

   440

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

   441

                           (" : ", ()),

   442

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

   443

                           (";\n", ())]

   444

                instance_number += 1

   445

        # Generate any program assign to no task

   446

        for instance in resource.getpouInstance():

   447

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

   448

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

   449

                       (" : ", ()),

   450

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

   451

                       (";\n", ())]

   452

            instance_number += 1

   453

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

   454

        return resrce

   455

   456

    # Generate the entire program for current project

   457

    def GenerateProgram(self):

   458

        # Find all data types defined

   459

        for datatype in self.Project.getdataTypes():

   460

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

   461

        # Find all data types defined

   462

        for pou in self.Project.getpous():

   463

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

   464

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

   465

        # type defined

   466

        if len(self.DatatypeComputed) > 0:

   467

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

   468

            # Generate every data types defined

   469

            for datatype_name in self.DatatypeComputed.keys():

   470

                self.GenerateDataType(datatype_name)

   471

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

   472

        # Generate every POUs defined

   473

        for pou_name in self.PouComputed.keys():

   474

            self.GeneratePouProgram(pou_name)

   475

        # Generate every configurations defined

   476

        for config in self.Project.getconfigurations():

   477

            self.Program += self.GenerateConfiguration(config)

   478

   479

    # Return generated program

   480

    def GetGeneratedProgram(self):

   481

        return self.Program

   482

   483

   484

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

   485

#                           Generator of POU programs

   486

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

   487

   488

[ConnectorClass, ContinuationClass, ActionBlockClass] = [

   489

    PLCOpenParser.GetElementClass(instance_name, "commonObjects")

   490

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

   491

[InVariableClass, InOutVariableClass, OutVariableClass, BlockClass] = [

   492

    PLCOpenParser.GetElementClass(instance_name, "fbdObjects")

   493

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

   494

[ContactClass, CoilClass, LeftPowerRailClass, RightPowerRailClass] = [

   495

    PLCOpenParser.GetElementClass(instance_name, "ldObjects")

   496

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

   497

[StepClass, TransitionClass, JumpStepClass,

   498

 SelectionConvergenceClass, SelectionDivergenceClass,

   499

 SimultaneousConvergenceClass, SimultaneousDivergenceClass] = [