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

errorVarTypes = {

    44

    "VAR_INPUT": "var_input",

    45

    "VAR_OUTPUT": "var_output",

    46

    "VAR_INOUT": "var_inout",

    47

}

    48

    49

# Helper function for reindenting text

    50

def ReIndentText(text, nb_spaces):

    51

    compute = ""

    52

    lines = text.splitlines()

    53

    if len(lines) > 0:

    54

        line_num = 0

    55

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

    56

            line_num += 1

    57

        if line_num < len(lines):

    58

            spaces = 0

    59

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

    60

                spaces += 1

    61

            indent = ""

    62

            for i in xrange(spaces, nb_spaces):

    63

                indent += " "

    64

            for line in lines:

    65

                if line != "":

    66

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

    67

                else:

    68

                    compute += "\n"

    69

    return compute

    70

    71

def SortInstances(a, b):

    72

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

    73

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

    74

    if abs(ay - by) < 10:

    75

        return cmp(ax, bx)

    76

    else:

    77

        return cmp(ay, by)

    78

    79

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

    80

#                  Specific exception for PLC generating errors

    81

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

    82

    83

    84

class PLCGenException(Exception):

    85

    pass

    86

    87

    88

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

    89

#                           Generator of PLC program

    90

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

    91

    92

    93

class ProgramGenerator:

    94

    95

    # Create a new PCL program generator

    96

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

    97

        # Keep reference of the controler and project

    98

        self.Controler = controler

    99

        self.Project = project

   100

        # Reset the internal variables used to generate PLC programs

   101

        self.Program = []

   102

        self.DatatypeComputed = {}

   103

        self.PouComputed = {}

   104

        self.Errors = errors

   105

        self.Warnings = warnings

   106

   107

    # Compute value according to type given

   108

    def ComputeValue(self, value, var_type):

   109

        base_type = self.Controler.GetBaseType(var_type)

   110

        if base_type == "STRING":

   111

            return "'%s'"%value

   112

        elif base_type == "WSTRING":

   113

            return "\"%s\""%value

   114

        return value

   115

   116

    # Generate a data type from its name

   117

    def GenerateDataType(self, datatype_name):

   118

        # Verify that data type hasn't been generated yet

   119

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

   120

            # If not mark data type as computed

   121

            self.DatatypeComputed[datatype_name] = True

   122

   123

            # Getting datatype model from project

   124

            datatype = self.Project.getdataType(datatype_name)

   125

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

   126

            datatype_def = [("  ", ()), 

   127

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

   128

                            (" : ", ())]

   129

            basetype_content = datatype.baseType.getcontent()

   130

            # Data type derived directly from a string type 

   131

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

   132

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

   133

            # Data type derived directly from a user defined type 

   134

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

   135

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

   136

                self.GenerateDataType(basetype_name)

   137

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

   138

            # Data type is a subrange

   139

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

   140

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

   141

                # Subrange derived directly from a user defined type 

   142

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

   143

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

   144

                    self.GenerateDataType(basetype_name)

   145

                # Subrange derived directly from an elementary type 

   146

                else:

   147

                    basetype_name = base_type["name"]

   148

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

   149

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

   150

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

   151

                                 (" (", ()),

   152

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

   153

                                 ("..", ()),

   154

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

   155

                                 (")",())]

   156

            # Data type is an enumerated type

   157

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

   158

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

   159

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

   160

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

   161

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

   162

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

   163

            # Data type is an array

   164

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

   165

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

   166

                # Array derived directly from a user defined type 

   167

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

   168

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

   169

                    self.GenerateDataType(basetype_name)

   170

                # Array derived directly from a string type 

   171

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

   172

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

   173

                # Array derived directly from an elementary type 

   174

                else:

   175

                    basetype_name = base_type["name"]

   176

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

   177

                               ("..", ()),

   178

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

   179

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

   180

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

   181

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

   182

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

   183

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

   184

            # Data type is a structure

   185

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

   186

                elements = []

   187

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

   188

                    element_type = element.type.getcontent()

   189

                    # Structure element derived directly from a user defined type 

   190

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

   191

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

   192

                        self.GenerateDataType(elementtype_name)

   193

                    # Structure element derived directly from a string type 

   194

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

   195

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

   196

                    # Structure element derived directly from an elementary type 

   197

                    else:

   198

                        elementtype_name = element_type["name"]

   199

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

   200

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

   201

                                    (" : ", ()),

   202

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

   203

                    if element.initialValue is not None:

   204

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

   205

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

   206

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

   207

                    elements.append(element_text)

   208

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

   209

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

   210

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

   211

            # Data type derived directly from a elementary type 

   212

            else:

   213

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

   214

            # Data type has an initial value

   215

            if datatype.initialValue is not None:

   216

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

   217

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

   218

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

   219

            self.Program += datatype_def

   220

   221

    # Generate a POU from its name

   222

    def GeneratePouProgram(self, pou_name):

   223

        # Verify that POU hasn't been generated yet

   224

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

   225

            # If not mark POU as computed

   226

            self.PouComputed[pou_name] = True

   227

   228

            # Getting POU model from project

   229

            pou = self.Project.getpou(pou_name)

   230

            pou_type = pou.getpouType()

   231

            # Verify that POU type exists

   232

            if pouTypeNames.has_key(pou_type):

   233

                # Create a POU program generator

   234

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

   235

                program = pou_program.GenerateProgram(pou)

   236

                self.Program += program

   237

            else:

   238

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

   239

   240

    # Generate a POU defined and used in text

   241

    def GeneratePouProgramInText(self, text):

   242

        for pou_name in self.PouComputed.keys():

   243

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

   244

            if model.search(text) is not None:

   245

                self.GeneratePouProgram(pou_name)

   246

   247

    # Generate a configuration from its model

   248

    def GenerateConfiguration(self, configuration):

   249

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

   250

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

   251

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

   252

                  ("\n", ())]

   253

        var_number = 0

   254

        # Generate any global variable in configuration

   255

        for varlist in configuration.getglobalVars():

   256

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

   257

            # Generate variable block with modifier

   258

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

   259

            if varlist.getconstant():

   260

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

   261

            elif varlist.getretain():

   262

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

   263

            elif varlist.getnonretain():

   264

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

   265

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

   266

            # Generate any variable of this block

   267

            for var in varlist.getvariable():

   268

                vartype_content = var.gettype().getcontent()

   269

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

   270

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

   271

                    self.GenerateDataType(var_type)

   272

                else:

   273

                    var_type = var.gettypeAsText()

   274

   275

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

   276

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

   277

                           (" ", ())]

   278

                # Generate variable address if exists

   279

                address = var.getaddress()

   280

                if address:

   281

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

   282

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

   283

                               (" ", ())]

   284

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

   285

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

   286

                # Generate variable initial value if exists

   287

                initial = var.getinitialValue()

   288

                if initial:

   289

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

   290

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

   291

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

   292

                var_number += 1

   293

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

   294

        # Generate any resource in the configuration

   295

        for resource in configuration.getresource():

   296

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

   297

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

   298

        return config

   299

   300

    # Generate a resource from its model

   301

    def GenerateResource(self, resource, config_name):

   302

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

   303

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

   304

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

   305

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

   306

        var_number = 0

   307

        # Generate any global variable in configuration

   308

        for varlist in resource.getglobalVars():

   309

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

   310

            # Generate variable block with modifier

   311

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

   312

            if varlist.getconstant():

   313

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

   314

            elif varlist.getretain():

   315

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

   316

            elif varlist.getnonretain():

   317

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

   318

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

   319

            # Generate any variable of this block

   320

            for var in varlist.getvariable():

   321

                vartype_content = var.gettype().getcontent()

   322

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

   323

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

   324

                    self.GenerateDataType(var_type)

   325

                else:

   326

                    var_type = var.gettypeAsText()

   327

   328

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

   329

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

   330

                           (" ", ())]

   331

                address = var.getaddress()

   332

                # Generate variable address if exists

   333

                if address:

   334

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

   335

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

   336

                               (" ", ())]

   337

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

   338

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

   339

                # Generate variable initial value if exists

   340

                initial = var.getinitialValue()

   341

                if initial:

   342

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

   343

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

   344

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

   345

                var_number += 1

   346

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

   347

        # Generate any task in the resource

   348

        tasks = resource.gettask()

   349

        task_number = 0

   350

        for task in tasks:

   351

            # Task declaration

   352

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

   353

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

   354

                       ("(", ())]

   355

            args = []

   356

            single = task.getsingle()

   357

            # Single argument if exists

   358

            if single:

   359

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

   360

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

   361

                           (",", ())]

   362

            # Interval argument if exists

   363

            interval = task.getinterval()

   364

            if interval:

   365

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

   366

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

   367

                           (",", ())]

   368

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

   369

##                if interval.hour != 0:

   370

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

   371

##                if interval.minute != 0:

   372

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

   373

##                if interval.second != 0:

   374

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

   375

##                if interval.microsecond != 0:

   376

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

   377

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

   378

            # Priority argument

   379

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

   380

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

   381

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

   382

            task_number += 1

   383

        instance_number = 0

   384

        # Generate any program assign to each task

   385

        for task in tasks:

   386

            for instance in task.getpouInstance():

   387

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

   388

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

   389

                           (" WITH ", ()),

   390

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

   391

                           (" : ", ()),

   392

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

   393

                           (";\n", ())]

   394

                instance_number += 1

   395

        # Generate any program assign to no task

   396

        for instance in resource.getpouInstance():

   397

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

   398

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

   399

                           (" : ", ()),

   400

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

   401

                           (";\n", ())]

   402

            instance_number += 1

   403

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

   404

        return resrce

   405

   406

    # Generate the entire program for current project

   407

    def GenerateProgram(self):        

   408

        # Find all data types defined

   409

        for datatype in self.Project.getdataTypes():

   410

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

   411

        # Find all data types defined

   412

        for pou in self.Project.getpous():

   413

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

   414

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

   415

        # type defined

   416

        if len(self.DatatypeComputed) > 0:

   417

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

   418

            # Generate every data types defined

   419

            for datatype_name in self.DatatypeComputed.keys():

   420

                self.GenerateDataType(datatype_name)

   421

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

   422

        # Generate every POUs defined

   423

        for pou_name in self.PouComputed.keys():

   424

            self.GeneratePouProgram(pou_name)

   425

        # Generate every configurations defined

   426

        for config in self.Project.getconfigurations():

   427

            self.Program += self.GenerateConfiguration(config)

   428

   429

    # Return generated program

   430

    def GetGeneratedProgram(self):

   431

        return self.Program

   432

   433

   434

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

   435

#                           Generator of POU programs

   436

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

   437

   438

   439

class PouProgramGenerator:

   440

   441

    # Create a new POU program generator

   442

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

   443

        # Keep Reference to the parent generator

   444

        self.ParentGenerator = parent

   445

        self.Name = name

   446

        self.Type = type

   447

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

   448

        self.CurrentIndent = "  "

   449

        self.ReturnType = None

   450

        self.Interface = []

   451

        self.InitialSteps = []

   452

        self.ComputedBlocks = {}

   453

        self.ComputedConnectors = {}

   454

        self.ConnectionTypes = {}

   455

        self.RelatedConnections = []

   456

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

   457

        self.SFCComputedBlocks = []

   458

        self.ActionNumber = 0

   459

        self.Program = []

   460

        self.Errors = errors

   461

        self.Warnings = warnings

   462

   463

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

   464

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

   465

   466

    def IndentLeft(self):

   467

        if len(self.CurrentIndent) >= 2:

   468

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

   469

   470

    def IndentRight(self):

   471

        self.CurrentIndent += "  "

   472

   473

    # Generator of unique ID for inline actions

   474

    def GetActionNumber(self):

   475

        self.ActionNumber += 1

   476

        return self.ActionNumber

   477

   478

    # Test if a variable has already been defined

   479

    def IsAlreadyDefined(self, name):

   480

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

   481

            for var_type, var_name, var_address, var_initial in vars:

   482

                if name == var_name:

   483

                    return True

   484

        return False

   485

   486

    # Return the type of a variable defined in interface

   487

    def GetVariableType(self, name):

   488

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

   489

            for var_type, var_name, var_address, var_initial in vars:

   490

                if name == var_name: