1

#!/usr/bin/env python

     2

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

     3

     4

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

     5

#based on the plcopen standard. 

     6

#

     7

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

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

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

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

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

    15

#

    16

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

    17

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

    18

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

    19

#General Public License for more details.

    20

#

    21

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

    22

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

    23

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

    24

    25

from plcopen import plcopen

    26

from plcopen.structures import *

    27

from types import *

    28

import re

    29

    30

# Dictionary associating PLCOpen variable categories to the corresponding 

    31

# IEC 61131-3 variable categories

    32

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

    33

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

    34

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

    35

    36

    37

# Dictionary associating PLCOpen POU categories to the corresponding 

    38

# IEC 61131-3 POU categories

    39

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

    40

    41

    42

errorVarTypes = {

    43

    "VAR_INPUT": "var_input",

    44

    "VAR_OUTPUT": "var_output",

    45

    "VAR_INOUT": "var_inout",

    46

}

    47

    48

# Helper function for reindenting text

    49

def ReIndentText(text, nb_spaces):

    50

    compute = ""

    51

    lines = text.splitlines()

    52

    if len(lines) > 0:

    53

        line_num = 0

    54

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

    55

            line_num += 1

    56

        if line_num < len(lines):

    57

            spaces = 0

    58

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

    59

                spaces += 1

    60

            indent = ""

    61

            for i in xrange(spaces, nb_spaces):

    62

                indent += " "

    63

            for line in lines:

    64

                if line != "":

    65

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

    66

                else:

    67

                    compute += "\n"

    68

    return compute

    69

    70

def SortInstances(a, b):

    71

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

    72

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

    73

    if abs(ay - by) < 10:

    74

        return cmp(ax, bx)

    75

    else:

    76

        return cmp(ay, by)

    77

    78

REAL_MODEL = re.compile("[0-9]+\.[0-9]+$")

    79

INTEGER_MODEL = re.compile("[0-9]+$")

    80

    81

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

    82

#                  Specific exception for PLC generating errors

    83

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

    84

    85

    86

class PLCGenException(Exception):

    87

    pass

    88

    89

    90

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

    91

#                           Generator of PLC program

    92

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

    93

    94

    95

class ProgramGenerator:

    96

    97

    # Create a new PCL program generator

    98

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

    99

        # Keep reference of the controler and project

   100

        self.Controler = controler

   101

        self.Project = project

   102

        # Reset the internal variables used to generate PLC programs

   103

        self.Program = []

   104

        self.DatatypeComputed = {}

   105

        self.PouComputed = {}

   106

        self.Errors = errors

   107

        self.Warnings = warnings

   108

   109

    # Compute value according to type given

   110

    def ComputeValue(self, value, var_type):

   111

        base_type = self.Controler.GetBaseType(var_type)

   112

        if base_type == "STRING":

   113

            return "'%s'"%value

   114

        elif base_type == "WSTRING":

   115

            return "\"%s\""%value

   116

        return value

   117

   118

    # Generate a data type from its name

   119

    def GenerateDataType(self, datatype_name):

   120

        # Verify that data type hasn't been generated yet

   121

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

   122

            # If not mark data type as computed

   123

            self.DatatypeComputed[datatype_name] = True

   124

   125

            # Getting datatype model from project

   126

            datatype = self.Project.getdataType(datatype_name)

   127

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

   128

            datatype_def = [("  ", ()), 

   129

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

   130

                            (" : ", ())]

   131

            basetype_content = datatype.baseType.getcontent()

   132

            # Data type derived directly from a string type 

   133

            if basetype_content["name"] in ["string", "wstring"]:

   134

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

   135

            # Data type derived directly from a user defined type 

   136

            elif basetype_content["name"] == "derived":

   137

                basetype_name = basetype_content["value"].getname()

   138

                self.GenerateDataType(basetype_name)

   139

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

   140

            # Data type is a subrange

   141

            elif basetype_content["name"] in ["subrangeSigned", "subrangeUnsigned"]:

   142

                base_type = basetype_content["value"].baseType.getcontent()

   143

                # Subrange derived directly from a user defined type 

   144

                if base_type["name"] == "derived":

   145

                    basetype_name = base_type["value"].getname()

   146

                    self.GenerateDataType(basetype_name)

   147

                # Subrange derived directly from an elementary type 

   148

                else:

   149

                    basetype_name = base_type["name"]

   150

                min_value = basetype_content["value"].range.getlower()

   151

                max_value = basetype_content["value"].range.getupper()

   152

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

   153

                                 (" (", ()),

   154

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

   155

                                 ("..", ()),

   156

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

   157

                                 (")",())]

   158

            # Data type is an enumerated type

   159

            elif basetype_content["name"] == "enum":

   160

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

   161

                          for i, value in enumerate(basetype_content["value"].values.getvalue())]

   162

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

   163

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

   164

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

   165

            # Data type is an array

   166

            elif basetype_content["name"] == "array":

   167

                base_type = basetype_content["value"].baseType.getcontent()

   168

                # Array derived directly from a user defined type 

   169

                if base_type["name"] == "derived":

   170

                    basetype_name = base_type["value"].getname()

   171

                    self.GenerateDataType(basetype_name)

   172

                # Array derived directly from a string type 

   173

                elif base_type["name"] in ["string", "wstring"]:

   174

                    basetype_name = base_type["name"].upper()

   175

                # Array derived directly from an elementary type 

   176

                else:

   177

                    basetype_name = base_type["name"]

   178

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

   179

                               ("..", ()),

   180

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

   181

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

   182

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

   183

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

   184

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

   185

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

   186

            # Data type is a structure

   187

            elif basetype_content["name"] == "struct":

   188

                elements = []

   189

                for i, element in enumerate(basetype_content["value"].getvariable()):

   190

                    element_type = element.type.getcontent()

   191

                    # Structure element derived directly from a user defined type 

   192

                    if element_type["name"] == "derived":

   193

                        elementtype_name = element_type["value"].getname()

   194

                        self.GenerateDataType(elementtype_name)

   195

                    # Structure element derived directly from a string type 

   196

                    elif element_type["name"] in ["string", "wstring"]:

   197

                        elementtype_name = element_type["name"].upper()

   198

                    # Structure element derived directly from an elementary type 

   199

                    else:

   200

                        elementtype_name = element_type["name"]

   201

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

   202

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

   203

                                    (" : ", ()),

   204

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

   205

                    if element.initialValue is not None:

   206

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

   207

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

   208

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

   209

                    elements.append(element_text)

   210

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

   211

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

   212

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

   213

            # Data type derived directly from a elementary type 

   214

            else:

   215

                datatype_def += [(basetype_content["name"], (tagname, "base"))]

   216

            # Data type has an initial value

   217

            if datatype.initialValue is not None:

   218

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

   219

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

   220

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

   221

            self.Program += datatype_def

   222

   223

    # Generate a POU from its name

   224

    def GeneratePouProgram(self, pou_name):

   225

        # Verify that POU hasn't been generated yet

   226

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

   227

            # If not mark POU as computed

   228

            self.PouComputed[pou_name] = True

   229

   230

            # Getting POU model from project

   231

            pou = self.Project.getpou(pou_name)

   232

            pou_type = pou.getpouType()

   233

            # Verify that POU type exists

   234

            if pouTypeNames.has_key(pou_type):

   235

                # Create a POU program generator

   236

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

   237

                program = pou_program.GenerateProgram(pou)

   238

                self.Program += program

   239

            else:

   240

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

   241

   242

    # Generate a POU defined and used in text

   243

    def GeneratePouProgramInText(self, text):

   244

        for pou_name in self.PouComputed.keys():

   245

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

   246

            if model.search(text) is not None:

   247

                self.GeneratePouProgram(pou_name)

   248

   249

    # Generate a configuration from its model

   250

    def GenerateConfiguration(self, configuration):

   251

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

   252

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

   253

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

   254

                  ("\n", ())]

   255

        var_number = 0

   256

        # Generate any global variable in configuration

   257

        for varlist in configuration.getglobalVars():

   258

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

   259

            # Generate variable block with modifier

   260

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

   261

            if varlist.getconstant():

   262

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

   263

            elif varlist.getretain():

   264

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

   265

            elif varlist.getnonretain():

   266

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

   267

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

   268

            # Generate any variable of this block

   269

            for var in varlist.getvariable():

   270

                vartype_content = var.gettype().getcontent()

   271

                if vartype_content["name"] == "derived":

   272

                    var_type = vartype_content["value"].getname()

   273

                    self.GenerateDataType(var_type)

   274

                else:

   275

                    var_type = var.gettypeAsText()

   276

   277

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

   278

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

   279

                           (" ", ())]

   280

                # Generate variable address if exists

   281

                address = var.getaddress()

   282

                if address:

   283

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

   284

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

   285

                               (" ", ())]

   286

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

   287

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

   288

                # Generate variable initial value if exists

   289

                initial = var.getinitialValue()

   290

                if initial:

   291

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

   292

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

   293

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

   294

                var_number += 1

   295

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

   296

        # Generate any resource in the configuration

   297

        for resource in configuration.getresource():

   298

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

   299

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

   300

        return config

   301

   302

    # Generate a resource from its model

   303

    def GenerateResource(self, resource, config_name):

   304

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

   305

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

   306

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

   307

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

   308

        var_number = 0

   309

        # Generate any global variable in configuration

   310

        for varlist in resource.getglobalVars():

   311

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

   312

            # Generate variable block with modifier

   313

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

   314

            if varlist.getconstant():

   315

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

   316

            elif varlist.getretain():

   317

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

   318

            elif varlist.getnonretain():

   319

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

   320

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

   321

            # Generate any variable of this block

   322

            for var in varlist.getvariable():

   323

                vartype_content = var.gettype().getcontent()

   324

                if vartype_content["name"] == "derived":

   325

                    var_type = vartype_content["value"].getname()

   326

                    self.GenerateDataType(var_type)

   327

                else:

   328

                    var_type = var.gettypeAsText()

   329

   330

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

   331

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

   332

                           (" ", ())]

   333

                address = var.getaddress()

   334

                # Generate variable address if exists

   335

                if address:

   336

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

   337

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

   338

                               (" ", ())]

   339

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

   340

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

   341

                # Generate variable initial value if exists

   342

                initial = var.getinitialValue()

   343

                if initial:

   344

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

   345

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

   346

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

   347

                var_number += 1

   348

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

   349

        # Generate any task in the resource

   350

        tasks = resource.gettask()

   351

        task_number = 0

   352

        for task in tasks:

   353

            # Task declaration

   354

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

   355

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

   356

                       ("(", ())]

   357

            args = []

   358

            single = task.getsingle()

   359

            # Single argument if exists

   360

            if single:

   361

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

   362

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

   363

                           (",", ())]

   364

            # Interval argument if exists

   365

            interval = task.getinterval()

   366

            if interval:

   367

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

   368

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

   369

                           (",", ())]

   370

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

   371

##                if interval.hour != 0:

   372

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

   373

##                if interval.minute != 0:

   374

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

   375

##                if interval.second != 0:

   376

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

   377

##                if interval.microsecond != 0:

   378

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

   379

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

   380

            # Priority argument

   381

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

   382

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

   383

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

   384

            task_number += 1

   385

        instance_number = 0

   386

        # Generate any program assign to each task

   387

        for task in tasks:

   388

            for instance in task.getpouInstance():

   389

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

   390

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

   391

                           (" WITH ", ()),

   392

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

   393

                           (" : ", ()),

   394

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

   395

                           (";\n", ())]

   396

                instance_number += 1

   397

        # Generate any program assign to no task

   398

        for instance in resource.getpouInstance():

   399

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

   400

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

   401

                           (" : ", ()),

   402

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

   403

                           (";\n", ())]

   404

            instance_number += 1

   405

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

   406

        return resrce

   407

   408

    # Generate the entire program for current project

   409

    def GenerateProgram(self):        

   410

        # Find all data types defined

   411

        for datatype in self.Project.getdataTypes():

   412

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

   413

        # Find all data types defined

   414

        for pou in self.Project.getpous():

   415

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

   416

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

   417

        # type defined

   418

        if len(self.DatatypeComputed) > 0:

   419

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

   420

            # Generate every data types defined

   421

            for datatype_name in self.DatatypeComputed.keys():

   422

                self.GenerateDataType(datatype_name)

   423

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

   424

        # Generate every POUs defined

   425

        for pou_name in self.PouComputed.keys():

   426

            self.GeneratePouProgram(pou_name)

   427

        # Generate every configurations defined

   428

        for config in self.Project.getconfigurations():

   429

            self.Program += self.GenerateConfiguration(config)

   430

   431

    # Return generated program

   432

    def GetGeneratedProgram(self):

   433

        return self.Program

   434

   435

   436

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

   437

#                           Generator of POU programs

   438

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

   439

   440

   441

class PouProgramGenerator:

   442

   443

    # Create a new POU program generator

   444

    def __init__(self, parent, name, type, errors, warnings):

   445

        # Keep Reference to the parent generator

   446

        self.ParentGenerator = parent

   447

        self.Name = name

   448

        self.Type = type

   449

        self.TagName = self.ParentGenerator.Controler.ComputePouName(name)

   450

        self.CurrentIndent = "  "

   451

        self.ReturnType = None

   452

        self.Interface = []

   453

        self.InitialSteps = []

   454

        self.ComputedBlocks = {}

   455

        self.ComputedConnectors = {}

   456

        self.ConnectionTypes = {}

   457

        self.RelatedConnections = []

   458

        self.SFCNetworks = {"Steps":{}, "Transitions":{}, "Actions":{}}

   459

        self.SFCComputedBlocks = []

   460

        self.ActionNumber = 0

   461

        self.Program = []

   462

        self.Errors = errors

   463

        self.Warnings = warnings

   464

   465

    def GetBlockType(self, type, inputs=None):

   466

        return self.ParentGenerator.Controler.GetBlockType(type, inputs)

   467

   468

    def IndentLeft(self):

   469

        if len(self.CurrentIndent) >= 2:

   470

            self.CurrentIndent = self.CurrentIndent[:-2]

   471

   472

    def IndentRight(self):

   473

        self.CurrentIndent += "  "

   474

   475

    # Generator of unique ID for inline actions

   476

    def GetActionNumber(self):

   477

        self.ActionNumber += 1

   478

        return self.ActionNumber

   479

   480

    # Test if a variable has already been defined

   481

    def IsAlreadyDefined(self, name):

   482

        for list_type, option, located, vars in self.Interface:

   483

            for var_type, var_name, var_address, var_initial in vars:

   484

                if name == var_name:

   485

                    return True

   486

        return False

   487

   488

    # Return the type of a variable defined in interface

   489

    def GetVariableType(self, name):

   490

        parts = name.split('.')

   491

        current_type = None

   492

        if len(parts) > 0:

   493

            name = parts.pop(0)

   494

            for list_type, option, located, vars in self.Interface:

   495

                for var_type, var_name, var_address, var_initial in vars:

   496

                    if name == var_name:

   497

                        current_type = var_type

   498

                        break

   499

            while current_type is not None and len(parts) > 0:

   500

                tagname = self.ParentGenerator.Controler.ComputeDataTypeName(current_type)

   501

                infos = self.ParentGenerator.Controler.GetDataTypeInfos(tagname)

   502

                name = parts.pop(0)

   503

                current_type = None

   504

                if infos is not None and infos["type"] == "Structure":

   505

                    for element in infos["elements"]:

   506

                        if element["Name"] == name:

   507

                            current_type = element["Type"]

   508

                            break

   509

        return current_type

   510

   511

    # Return connectors linked by a connection to the given connector

   512

    def GetConnectedConnector(self, connector, body):

   513

        links = connector.getconnections()

   514

        if links and len(links) == 1:

   515

            return self.GetLinkedConnector(links[0], body)

   516

        return None        

   517

   518

    def GetLinkedConnector(self, link, body):

   519

        parameter = link.getformalParameter()

   520

        instance = body.getcontentInstance(link.getrefLocalId())

   521

        if isinstance(instance, (plcopen.fbdObjects_inVariable, plcopen.fbdObjects_inOutVariable, plcopen.commonObjects_continuation, plcopen.ldObjects_contact, plcopen.ldObjects_coil)):

   522

            return instance.connectionPointOut

   523

        elif isinstance(instance, plcopen.fbdObjects_block):

   524

            outputvariables = instance.outputVariables.getvariable()

   525

            if len(outputvariables) == 1:

   526

                return outputvariables[0].connectionPointOut

   527

            elif parameter:

   528

                for variable in outputvariables:

   529

                    if variable.getformalParameter() == parameter:

   530