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

    31

# Dictionary associating PLCOpen variable categories to the corresponding 

    32

# IEC 61131-3 variable categories

    33

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

    34

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

    35

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

    36

    37

    38

# Dictionary associating PLCOpen POU categories to the corresponding 

    39

# IEC 61131-3 POU categories

    40

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

    41

    42

    43

# Helper function for reindenting text

    44

def ReIndentText(text, nb_spaces):

    45

    compute = ""

    46

    lines = text.splitlines()

    47

    if len(lines) > 0:

    48

        line_num = 0

    49

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

    50

            line_num += 1

    51

        if line_num < len(lines):

    52

            spaces = 0

    53

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

    54

                spaces += 1

    55

            indent = ""

    56

            for i in xrange(spaces, nb_spaces):

    57

                indent += " "

    58

            for line in lines:

    59

                if line != "":

    60

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

    61

                else:

    62

                    compute += "\n"

    63

    return compute

    64

    65

def SortInstances(a, b):

    66

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

    67

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

    68

    if abs(ay - by) < 10:

    69

        return cmp(ax, bx)

    70

    else:

    71

        return cmp(ay, by)

    72

    73

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

    74

#                  Specific exception for PLC generating errors

    75

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

    76

    77

    78

class PLCGenException(Exception):

    79

    pass

    80

    81

    82

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

    83

#                           Generator of PLC program

    84

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

    85

    86

    87

class ProgramGenerator:

    88

    89

    # Create a new PCL program generator

    90

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

    91

        # Keep reference of the controler and project

    92

        self.Controler = controler

    93

        self.Project = project

    94

        # Reset the internal variables used to generate PLC programs

    95

        self.Program = []

    96

        self.DatatypeComputed = {}

    97

        self.PouComputed = {}

    98

        self.Errors = errors

    99

        self.Warnings = warnings

   100

   101

    # Compute value according to type given

   102

    def ComputeValue(self, value, var_type):

   103

        base_type = self.Controler.GetBaseType(var_type)

   104

        if base_type == "STRING":

   105

            return "'%s'"%value

   106

        elif base_type == "WSTRING":

   107

            return "\"%s\""%value

   108

        return value

   109

   110

    # Generate a data type from its name

   111

    def GenerateDataType(self, datatype_name):

   112

        # Verify that data type hasn't been generated yet

   113

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

   114

            # If not mark data type as computed

   115

            self.DatatypeComputed[datatype_name] = True

   116

   117

            # Getting datatype model from project

   118

            datatype = self.Project.getdataType(datatype_name)

   119

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

   120

            datatype_def = [("  ", ()), 

   121

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

   122

                            (" : ", ())]

   123

            basetype_content = datatype.baseType.getcontent()

   124

            # Data type derived directly from a string type 

   125

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

   126

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

   127

            # Data type derived directly from a user defined type 

   128

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

   129

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

   130

                self.GenerateDataType(basetype_name)

   131

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

   132

            # Data type is a subrange

   133

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

   134

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

   135

                # Subrange derived directly from a user defined type 

   136

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

   137

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

   138

                    self.GenerateDataType(basetype_name)

   139

                # Subrange derived directly from an elementary type 

   140

                else:

   141

                    basetype_name = base_type["name"]

   142

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

   143

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

   144

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

   145

                                 (" (", ()),

   146

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

   147

                                 ("..", ()),

   148

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

   149

                                 (")",())]

   150

            # Data type is an enumerated type

   151

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

   152

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

   153

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

   154

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

   155

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

   156

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

   157

            # Data type is an array

   158

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

   159

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

   160

                # Array derived directly from a user defined type 

   161

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

   162

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

   163

                    self.GenerateDataType(basetype_name)

   164

                # Array derived directly from a string type 

   165

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

   166

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

   167

                # Array derived directly from an elementary type 

   168

                else:

   169

                    basetype_name = base_type["name"]

   170

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

   171

                               ("..", ()),

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

            # Data type is a structure

   179

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

   180

                elements = []

   181

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

   182

                    element_type = element.type.getcontent()

   183

                    # Structure element derived directly from a user defined type 

   184

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

   185

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

   186

                        self.GenerateDataType(elementtype_name)

   187

                    # Structure element derived directly from a string type 

   188

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

   189

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

   190

                    # Structure element derived directly from an elementary type 

   191

                    else:

   192

                        elementtype_name = element_type["name"]

   193

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

   194

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

   195

                                    (" : ", ()),

   196

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

   197

                    if element.initialValue is not None:

   198

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

   199

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

   200

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

   201

                    elements.append(element_text)

   202

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

   203

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

   204

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

   205

            # Data type derived directly from a elementary type 

   206

            else:

   207

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

   208

            # Data type has an initial value

   209

            if datatype.initialValue is not None:

   210

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

   211

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

   212

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

   213

            self.Program += datatype_def

   214

   215

    # Generate a POU from its name

   216

    def GeneratePouProgram(self, pou_name):

   217

        # Verify that POU hasn't been generated yet

   218

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

   219

            # If not mark POU as computed

   220

            self.PouComputed[pou_name] = True

   221

   222

            # Getting POU model from project

   223

            pou = self.Project.getpou(pou_name)

   224

            pou_type = pou.getpouType()

   225

            # Verify that POU type exists

   226

            if pouTypeNames.has_key(pou_type):

   227

                # Create a POU program generator

   228

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

   229

                program = pou_program.GenerateProgram(pou)

   230

                self.Program += program

   231

            else:

   232

                raise PLCGenException, "Undefined pou type \"%s\""%pou_type

   233

   234

    # Generate a POU defined and used in text

   235

    def GeneratePouProgramInText(self, text):

   236

        for pou_name in self.PouComputed.keys():

   237

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

   238

            if model.search(text) is not None:

   239

                self.GeneratePouProgram(pou_name)

   240

   241

    # Generate a configuration from its model

   242

    def GenerateConfiguration(self, configuration):

   243

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

   244

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

   245

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

   246

                  ("\n", ())]

   247

        var_number = 0

   248

        # Generate any global variable in configuration

   249

        for varlist in configuration.getglobalVars():

   250

            # Generate variable block with modifier

   251

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

   252

            if varlist.getretain():

   253

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

   254

            if varlist.getconstant():

   255

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

   256

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

   257

            # Generate any variable of this block

   258

            for var in varlist.getvariable():

   259

                vartype_content = var.gettype().getcontent()

   260

                # Variable type is a user data type

   261

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

   262

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

   263

                # Variable type is a string type

   264

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

   265

                    var_type = vartype_content["name"].upper()

   266

                # Variable type is an elementary type

   267

                else:

   268

                    var_type = vartype_content["name"]

   269

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

   270

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

   271

                           (" ", ())]

   272

                # Generate variable address if exists

   273

                address = var.getaddress()

   274

                if address:

   275

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

   276

                               (address, (tagname, "variable", var_number, "address")),

   277

                               (" ", ())]

   278

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

   279

                           (var_type, (tagname, "variable", var_number, "type"))]

   280

                # Generate variable initial value if exists

   281

                initial = var.getinitialValue()

   282

                if initial:

   283

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

   284

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

   285

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

   286

                var_number += 1

   287

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

   288

        # Generate any resource in the configuration

   289

        for resource in configuration.getresource():

   290

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

   291

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

   292

        return config

   293

   294

    # Generate a resource from its model

   295

    def GenerateResource(self, resource, config_name):

   296

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

   297

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

   298

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

   299

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

   300

        var_number = 0

   301

        # Generate any global variable in configuration

   302

        for varlist in resource.getglobalVars():

   303

            # Generate variable block with modifier

   304

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

   305

            if varlist.getretain():

   306

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

   307

            if varlist.getconstant():

   308

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

   310

            # Generate any variable of this block

   311

            for var in varlist.getvariable():

   312

                vartype_content = var.gettype().getcontent()

   313

                # Variable type is a user data type

   314

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

   315

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

   316

                # Variable type is a string type

   317

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

   318

                    var_type = vartype_content["name"].upper()

   319

                # Variable type is an elementary type

   320

                else:

   321

                    var_type = vartype_content["name"]

   322

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

   323

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

   324

                           (" ", ())]

   325

                address = var.getaddress()

   326

                # Generate variable address if exists

   327

                if address:

   328

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

   329

                               (address, (tagname, "variable", var_number, "address")),

   330

                               (" ", ())]

   331

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

   332

                           (var_type, (tagname, "variable", var_number, "type"))]

   333

                # Generate variable initial value if exists

   334

                initial = var.getinitialValue()

   335

                if initial:

   336

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

   337

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

   338

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

   339

                var_number += 1

   340

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

   341

        # Generate any task in the resource

   342

        tasks = resource.gettask()

   343

        task_number = 0

   344

        for task in tasks:

   345

            # Task declaration

   346

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

   347

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

   348

                       ("(", ())]

   349

            args = []

   350

            single = task.getsingle()

   351

            # Single argument if exists

   352

            if single:

   353

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

   354

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

   355

                           (",", ())]

   356

            # Interval argument if exists

   357

            interval = task.getinterval()

   358

            if interval:

   359

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

   360

                if interval.hour != 0:

   361

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

   362

                if interval.minute != 0:

   363

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

   364

                if interval.second != 0:

   365

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

   366

                if interval.microsecond != 0:

   367

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

   368

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

   369

            # Priority argument

   370

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

   371

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

   372

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

   373

            task_number += 1

   374

        instance_number = 0

   375

        # Generate any program assign to each task

   376

        for task in tasks:

   377

            for instance in task.getpouInstance():

   378

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

   379

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

   380

                           (" WITH ", ()),

   381

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

   382

                           (" : ", ()),

   383

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

   384

                           (";\n", ())]

   385

                instance_number += 1

   386

        # Generate any program assign to no task

   387

        for instance in resource.getpouInstance():

   388

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

   389

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

   390

                           (" : ", ()),

   391

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

   392

                           (";\n", ())]

   393

            instance_number += 1

   394

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

   395

        return resrce

   396

   397

    # Generate the entire program for current project

   398

    def GenerateProgram(self):        

   399

        # Find all data types defined

   400

        for datatype in self.Project.getdataTypes():

   401

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

   402

        # Find all data types defined

   403

        for pou in self.Project.getpous():

   404

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

   405

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

   406

        # type defined

   407

        if len(self.DatatypeComputed) > 0:

   408

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

   409

            # Generate every data types defined

   410

            for datatype_name in self.DatatypeComputed.keys():

   411

                self.GenerateDataType(datatype_name)

   412

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

   413

        # Generate every POUs defined

   414

        for pou_name in self.PouComputed.keys():

   415

            self.GeneratePouProgram(pou_name)

   416

        # Generate every configurations defined

   417

        for config in self.Project.getconfigurations():

   418

            self.Program += self.GenerateConfiguration(config)

   419

   420

    # Return generated program

   421

    def GetGeneratedProgram(self):

   422

        return self.Program

   423

   424

   425

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

   426

#                           Generator of POU programs

   427

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

   428

   429

   430

class PouProgramGenerator:

   431

   432

    # Create a new POU program generator

   433

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

   434

        # Keep Reference to the parent generator

   435

        self.ParentGenerator = parent

   436

        self.Name = name

   437

        self.Type = type

   438

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

   439

        self.CurrentIndent = "  "

   440

        self.ReturnType = None

   441

        self.Interface = []

   442

        self.InitialSteps = []

   443

        self.ComputedBlocks = {}

   444

        self.ComputedConnectors = {}

   445

        self.ConnectionTypes = {}

   446

        self.RelatedConnections = []

   447

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

   448

        self.SFCComputedBlocks = []

   449

        self.ActionNumber = 0

   450

        self.Program = []

   451

        self.Errors = errors

   452

        self.Warnings = warnings

   453

   454

    def GetBlockType(self, type):

   455

        return self.ParentGenerator.Controler.GetBlockType(type)

   456

   457

    def IndentLeft(self):

   458

        if len(self.CurrentIndent) >= 2:

   459

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

   460

   461

    def IndentRight(self):

   462

        self.CurrentIndent += "  "

   463

   464

    # Generator of unique ID for inline actions

   465

    def GetActionNumber(self):

   466

        self.ActionNumber += 1

   467

        return self.ActionNumber

   468

   469

    # Test if a variable has already been defined

   470

    def IsAlreadyDefined(self, name):

   471

        for list_type, retain, constant, located, vars in self.Interface:

   472

            for var_type, var_name, var_address, var_initial in vars:

   473

                if name == var_name:

   474

                    return True

   475

        return False

   476

   477

    # Return the type of a variable defined in interface

   478

    def GetVariableType(self, name):

   479

        for list_type, retain, constant, located, vars in self.Interface:

   480

            for var_type, var_name, var_address, var_initial in vars:

   481

                if name == var_name:

   482

                    return var_type

   483

        return None

   484

   485

    # Return connectors linked by a connection to the given connector

   486

    def GetConnectedConnector(self, connector, body):

   487

        links = connector.getconnections()

   488

        if links and len(links) == 1:

   489

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

   490

        return None        

   491

   492

    def GetLinkedConnector(self, link, body):

   493

        parameter = link.getformalParameter()