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

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

    79

#                  Specific exception for PLC generating errors

    80

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

    81

    82

    83

class PLCGenException(Exception):

    84

    pass

    85

    86

    87

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

    88

#                           Generator of PLC program

    89

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

    90

    91

    92

class ProgramGenerator:

    93

    94

    # Create a new PCL program generator

    95

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

    96

        # Keep reference of the controler and project

    97

        self.Controler = controler

    98

        self.Project = project

    99

        # Reset the internal variables used to generate PLC programs

   100

        self.Program = []

   101

        self.DatatypeComputed = {}

   102

        self.PouComputed = {}

   103

        self.Errors = errors

   104

        self.Warnings = warnings

   105

   106

    # Compute value according to type given

   107

    def ComputeValue(self, value, var_type):

   108

        base_type = self.Controler.GetBaseType(var_type)

   109

        if base_type == "STRING":

   110

            return "'%s'"%value

   111

        elif base_type == "WSTRING":

   112

            return "\"%s\""%value

   113

        return value

   114

   115

    # Generate a data type from its name

   116

    def GenerateDataType(self, datatype_name):

   117

        # Verify that data type hasn't been generated yet

   118

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

   119

            # If not mark data type as computed

   120

            self.DatatypeComputed[datatype_name] = True

   121

   122

            # Getting datatype model from project

   123

            datatype = self.Project.getdataType(datatype_name)

   124

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

   125

            datatype_def = [("  ", ()), 

   126

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

   127

                            (" : ", ())]

   128

            basetype_content = datatype.baseType.getcontent()

   129

            # Data type derived directly from a string type 

   130

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

   131

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

   132

            # Data type derived directly from a user defined type 

   133

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

   134

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

   135

                self.GenerateDataType(basetype_name)

   136

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

   137

            # Data type is a subrange

   138

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

   139

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

   140

                # Subrange derived directly from a user defined type 

   141

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

   142

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

   143

                    self.GenerateDataType(basetype_name)

   144

                # Subrange derived directly from an elementary type 

   145

                else:

   146

                    basetype_name = base_type["name"]

   147

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

   148

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

   149

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

   150

                                 (" (", ()),

   151

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

   152

                                 ("..", ()),

   153

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

   154

                                 (")",())]

   155

            # Data type is an enumerated type

   156

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

   157

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

   158

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

   159

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

   160

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

   161

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

   162

            # Data type is an array

   163

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

   164

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

   165

                # Array derived directly from a user defined type 

   166

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

   167

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

   168

                    self.GenerateDataType(basetype_name)

   169

                # Array derived directly from a string type 

   170

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

   171

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

   172

                # Array derived directly from an elementary type 

   173

                else:

   174

                    basetype_name = base_type["name"]

   175

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

   176

                               ("..", ()),

   177

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

   178

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

   179

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

   180

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

   181

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

   182

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

   183

            # Data type is a structure

   184

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

   185

                elements = []

   186

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

   187

                    element_type = element.type.getcontent()

   188

                    # Structure element derived directly from a user defined type 

   189

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

   190

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

   191

                        self.GenerateDataType(elementtype_name)

   192

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

   193

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

   194

                        # Array derived directly from a user defined type 

   195

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

   196

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

   197

                            self.GenerateDataType(basetype_name)

   198

                        # Array derived directly from a string type 

   199

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

   200

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

   201

                        # Array derived directly from an elementary type 

   202

                        else:

   203

                            basetype_name = base_type["name"]

   204

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

   205

                                      for dimension in element_type["value"].getdimension()]

   206

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

   207

                    # Structure element derived directly from a string type 

   208

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

   209

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

   210

                    # Structure element derived directly from an elementary type 

   211

                    else:

   212

                        elementtype_name = element_type["name"]

   213

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

   214

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

   215

                                    (" : ", ()),

   216

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

   217

                    if element.initialValue is not None:

   218

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

   219

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

   220

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

   221

                    elements.append(element_text)

   222

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

   223

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

   224

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

   225

            # Data type derived directly from a elementary type 

   226

            else:

   227

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

   228

            # Data type has an initial value

   229

            if datatype.initialValue is not None:

   230

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

   231

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

   232

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

   233

            self.Program += datatype_def

   234

   235

    # Generate a POU from its name

   236

    def GeneratePouProgram(self, pou_name):

   237

        # Verify that POU hasn't been generated yet

   238

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

   239

            # If not mark POU as computed

   240

            self.PouComputed[pou_name] = True

   241

   242

            # Getting POU model from project

   243

            pou = self.Project.getpou(pou_name)

   244

            pou_type = pou.getpouType()

   245

            # Verify that POU type exists

   246

            if pouTypeNames.has_key(pou_type):

   247

                # Create a POU program generator

   248

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

   249

                program = pou_program.GenerateProgram(pou)

   250

                self.Program += program

   251

            else:

   252

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

   253

   254

    # Generate a POU defined and used in text

   255

    def GeneratePouProgramInText(self, text):

   256

        for pou_name in self.PouComputed.keys():

   257

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

   258

            if model.search(text) is not None:

   259

                self.GeneratePouProgram(pou_name)

   260

   261

    # Generate a configuration from its model

   262

    def GenerateConfiguration(self, configuration):

   263

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

   264

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

   265

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

   266

                  ("\n", ())]

   267

        var_number = 0

   268

   269

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

   270

   271

        extra_variables = self.Controler.GetConfigurationExtraVariables()

   272

        if len(extra_variables) > 0:

   273

            if len(varlists) == 0:

   274

                varlists = [(plcopen.interface_globalVars(), [])]

   275

            varlists[-1][1].extend(extra_variables)

   276

   277

        # Generate any global variable in configuration

   278

        for varlist, varlist_variables in varlists:

   279

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

   280

            # Generate variable block with modifier

   281

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

   282

            if varlist.getconstant():

   283

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

   284

            elif varlist.getretain():

   285

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

   286

            elif varlist.getnonretain():

   287

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

   288

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

   289

            # Generate any variable of this block

   290

            for var in varlist_variables:

   291

                vartype_content = var.gettype().getcontent()

   292

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

   293

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

   294

                    self.GenerateDataType(var_type)

   295

                else:

   296

                    var_type = var.gettypeAsText()

   297

   298

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

   299

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

   300

                           (" ", ())]

   301

                # Generate variable address if exists

   302

                address = var.getaddress()

   303

                if address:

   304

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

   305

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

   306

                               (" ", ())]

   307

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

   308

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

   309

                # Generate variable initial value if exists

   310

                initial = var.getinitialValue()

   311

                if initial:

   312

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

   313

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

   314

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

   315

                var_number += 1

   316

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

   317

        # Generate any resource in the configuration

   318

        for resource in configuration.getresource():

   319

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

   320

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

   321

        return config

   322

   323

    # Generate a resource from its model

   324

    def GenerateResource(self, resource, config_name):

   325

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

   326

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

   327

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

   328

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

   329

        var_number = 0

   330

        # Generate any global variable in configuration

   331

        for varlist in resource.getglobalVars():

   332

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

   333

            # Generate variable block with modifier

   334

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

   335

            if varlist.getconstant():

   336

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

   337

            elif varlist.getretain():

   338

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

   339

            elif varlist.getnonretain():

   340

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

   341

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

   342

            # Generate any variable of this block

   343

            for var in varlist.getvariable():

   344

                vartype_content = var.gettype().getcontent()

   345

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

   346

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

   347

                    self.GenerateDataType(var_type)

   348

                else:

   349

                    var_type = var.gettypeAsText()

   350

   351

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

   352

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

   353

                           (" ", ())]

   354

                address = var.getaddress()

   355

                # Generate variable address if exists

   356

                if address:

   357

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

   358

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

   359

                               (" ", ())]

   360

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

   361

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

   362

                # Generate variable initial value if exists

   363

                initial = var.getinitialValue()

   364

                if initial:

   365

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

   366

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

   367

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

   368

                var_number += 1

   369

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

   370

        # Generate any task in the resource

   371

        tasks = resource.gettask()

   372

        task_number = 0

   373

        for task in tasks:

   374

            # Task declaration

   375

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

   376

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

   377

                       ("(", ())]

   378

            args = []

   379

            single = task.getsingle()

   380

            # Single argument if exists

   381

            if single:

   382

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

   383

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

   384

                           (",", ())]

   385

            # Interval argument if exists

   386

            interval = task.getinterval()

   387

            if interval:

   388

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

   389

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

   390

                           (",", ())]

   391

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

   392

##                if interval.hour != 0:

   393

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

   394

##                if interval.minute != 0:

   395

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

   396

##                if interval.second != 0:

   397

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

   398

##                if interval.microsecond != 0:

   399

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

   400

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

   401

            # Priority argument

   402

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

   403

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

   404

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

   405

            task_number += 1

   406

        instance_number = 0

   407

        # Generate any program assign to each task

   408

        for task in tasks:

   409

            for instance in task.getpouInstance():

   410

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

   411

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

   412

                           (" WITH ", ()),

   413

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

   414

                           (" : ", ()),

   415

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

   416

                           (";\n", ())]

   417

                instance_number += 1

   418

        # Generate any program assign to no task

   419

        for instance in resource.getpouInstance():

   420

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

   421

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

   422

                           (" : ", ()),

   423

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

   424

                           (";\n", ())]

   425

            instance_number += 1

   426

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

   427

        return resrce

   428

   429

    # Generate the entire program for current project

   430

    def GenerateProgram(self):        

   431

        # Find all data types defined

   432

        for datatype in self.Project.getdataTypes():

   433

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

   434

        # Find all data types defined

   435

        for pou in self.Project.getpous():

   436

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

   437

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

   438

        # type defined

   439

        if len(self.DatatypeComputed) > 0:

   440

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

   441

            # Generate every data types defined

   442

            for datatype_name in self.DatatypeComputed.keys():

   443

                self.GenerateDataType(datatype_name)

   444

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

   445

        # Generate every POUs defined

   446

        for pou_name in self.PouComputed.keys():

   447

            self.GeneratePouProgram(pou_name)

   448

        # Generate every configurations defined

   449

        for config in self.Project.getconfigurations():

   450

            self.Program += self.GenerateConfiguration(config)

   451

   452

    # Return generated program

   453

    def GetGeneratedProgram(self):

   454

        return self.Program

   455

   456

   457

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

   458

#                           Generator of POU programs

   459

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

   460

   461

   462

class PouProgramGenerator:

   463

   464

    # Create a new POU program generator

   465

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

   466

        # Keep Reference to the parent generator

   467

        self.ParentGenerator = parent

   468

        self.Name = name

   469

        self.Type = type

   470

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

   471

        self.CurrentIndent = "  "

   472

        self.ReturnType = None

   473

        self.Interface = []

   474

        self.InitialSteps = []

   475

        self.ComputedBlocks = {}

   476

        self.ComputedConnectors = {}

   477

        self.ConnectionTypes = {}

   478

        self.RelatedConnections = []

   479

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

   480

        self.SFCComputedBlocks = []

   481

        self.ActionNumber = 0

   482

        self.Program = []

   483

        self.Errors = errors

   484

        self.Warnings = warnings

   485

   486

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

   487

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

   488

   489

    def IndentLeft(self):

   490

        if len(self.CurrentIndent) >= 2:

   491

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

   492

   493

    def IndentRight(self):

   494

        self.CurrentIndent += "  "

   495

   496

    # Generator of unique ID for inline actions

   497

    def GetActionNumber(self):

   498

        self.ActionNumber += 1

   499

        return self.ActionNumber

   500

   501

    # Test if a variable has already been defined

   502

    def IsAlreadyDefined(self, name):

   503

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

   504

            for var_type, var_name, var_address, var_initial in vars:

   505

                if name == var_name:

   506

                    return True

   507

        return False

   508

   509

    # Return the type of a variable defined in interface

   510

    def GetVariableType(self, name):

   511

        parts = name.split('.')

   512

        current_type = None

   513

        if len(parts) > 0:

   514

            name = parts.pop(0)

   515

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

   516

                for var_type, var_name, var_address, var_initial in vars:

   517

                    if name == var_name:

   518

                        current_type = var_type

   519

                        break

   520

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

   521

                blocktype = self.ParentGenerator.Controler.GetBlockType(current_type)

   522

                if blocktype is not None:

   523

                    name = parts.pop(0)

   524

                    current_type = None

   525

                    for var_name, var_type, var_modifier in blocktype["inputs"] + blocktype["outputs"]:

   526

                        if var_name == name:

   527

                            current_type = var_type