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

    26

from structures import *

    27

from types import *

    28

import os, re

    29

    30

"""

    31

Dictionary that makes the relation between var names in plcopen and displayed values

    32

"""

    33

VarTypes = {"Local" : "localVars", "Temp" : "tempVars", "Input" : "inputVars",

    34

            "Output" : "outputVars", "InOut" : "inOutVars", "External" : "externalVars",

    35

            "Global" : "globalVars", "Access" : "accessVars"}

    36

    37

searchResultVarTypes = {

    38

    "inputVars": "var_input",

    39

    "outputVars": "var_output",

    40

    "inOutVars": "var_inout"

    41

}

    42

    43

"""

    44

Define in which order var types must be displayed

    45

"""

    46

VarOrder = ["Local","Temp","Input","Output","InOut","External","Global","Access"]

    47

    48

"""

    49

Define which action qualifier must be associated with a duration 

    50

"""

    51

QualifierList = {"N" : False, "R" : False, "S" : False, "L" : True, "D" : True, 

    52

    "P" : False, "P0" : False, "P1" : False, "SD" : True, "DS" : True, "SL" : True}

    53

    54

    55

FILTER_ADDRESS_MODEL = "(%%[IQM](?:[XBWDL])?)(%s)((?:\.[0-9]+)*)" 

    56

    57

def update_address(address, address_model, new_leading):

    58

    result = address_model.match(address)

    59

    if result is None:

    60

        return address

    61

    groups = result.groups()

    62

    return groups[0] + new_leading + groups[2]

    63

    64

def _init_and_compare(function, v1, v2):

    65

    if v1 is None:

    66

        return v2

    67

    if v2 is not None:

    68

        return function(v1, v2)

    69

    return v1

    70

    71

"""

    72

Helper class for bounding_box calculation 

    73

"""

    74

class rect:

    75

    76

    def __init__(self, x=None, y=None, width=None, height=None):

    77

        self.x_min = x

    78

        self.x_max = None

    79

        self.y_min = y

    80

        self.y_max = None

    81

        if width is not None and x is not None:

    82

            self.x_max = x + width

    83

        if height is not None and y is not None:

    84

            self.y_max = y + height

    85

    86

    def update(self, x, y):

    87

        self.x_min = _init_and_compare(min, self.x_min, x)

    88

        self.x_max = _init_and_compare(max, self.x_max, x)

    89

        self.y_min = _init_and_compare(min, self.y_min, y)

    90

        self.y_max = _init_and_compare(max, self.y_max, y)

    91

    92

    def union(self, rect):

    93

        self.x_min = _init_and_compare(min, self.x_min, rect.x_min)

    94

        self.x_max = _init_and_compare(max, self.x_max, rect.x_max)

    95

        self.y_min = _init_and_compare(min, self.y_min, rect.y_min)

    96

        self.y_max = _init_and_compare(max, self.y_max, rect.y_max)

    97

    98

    def bounding_box(self):

    99

        width = height = None

   100

        if self.x_min is not None and self.x_max is not None:

   101

            width = self.x_max - self.x_min

   102

        if self.y_min is not None and self.y_max is not None:

   103

            height = self.y_max - self.y_min

   104

        return self.x_min, self.y_min, width, height

   105

   106

def TextLenInRowColumn(text):

   107

    if text == "":

   108

        return (0, 0)

   109

    lines = text.split("\n")

   110

    return len(lines) - 1, len(lines[-1])

   111

   112

def TestTextElement(text, criteria):

   113

    lines = text.splitlines()

   114

    if not criteria["case_sensitive"]:

   115

        text = text.upper()

   116

    test_result = []

   117

    result = criteria["pattern"].search(text)

   118

    while result is not None:

   119

        start = TextLenInRowColumn(text[:result.start()])

   120

        end = TextLenInRowColumn(text[:result.end() - 1])

   121

        test_result.append((start, end, "\n".join(lines[start[0]:end[0] + 1])))

   122

        result = criteria["pattern"].search(text, result.end())

   123

    return test_result

   124

   125

PLCOpenClasses = GenerateClassesFromXSD(os.path.join(os.path.split(__file__)[0], "tc6_xml_v201.xsd"))

   126

   127

ElementNameToClass = {}

   128

   129

cls = PLCOpenClasses.get("formattedText", None)

   130

if cls:

   131

    def updateElementName(self, old_name, new_name):

   132

        text = self.text.decode("utf-8")

   133

        index = text.find(old_name)

   134

        while index != -1:

   135

            if index > 0 and (text[index - 1].isalnum() or text[index - 1] == "_"):

   136

                index = text.find(old_name, index + len(old_name))

   137

            elif index < len(text) - len(old_name) and (text[index + len(old_name)].isalnum() or text[index + len(old_name)] == "_"):

   138

                index = text.find(old_name, index + len(old_name))

   139

            else:

   140

                text = text[:index] + new_name + text[index + len(old_name):]

   141

                index = text.find(old_name, index + len(new_name))

   142

        self.text = text.encode("utf-8")

   143

    setattr(cls, "updateElementName", updateElementName)

   144

   145

    def updateElementAddress(self, address_model, new_leading):

   146

        text = self.text.decode("utf-8")

   147

        startpos = 0

   148

        result = address_model.search(text, startpos)

   149

        while result is not None:

   150

            groups = result.groups()

   151

            new_address = groups[0] + new_leading + groups[2]

   152

            text = text[:result.start()] + new_address + text[result.end():]

   153

            startpos = result.start() + len(new_address)

   154

            result = address_model.search(self.text, startpos)

   155

        self.text = text.encode("utf-8")

   156

    setattr(cls, "updateElementAddress", updateElementAddress)

   157

   158

    def Search(self, criteria, parent_infos):

   159

        return [(tuple(parent_infos),) + result for result in TestTextElement(self.gettext(), criteria)]

   160

    setattr(cls, "Search", Search)

   161

   162

cls = PLCOpenClasses.get("project", None)

   163

if cls:

   164

    cls.singleLineAttributes = False

   165

    cls.EnumeratedDataTypeValues = {}

   166

    cls.CustomDataTypeRange = {}

   167

    cls.CustomTypeHierarchy = {}

   168

    cls.ElementUsingTree = {}

   169

    cls.CustomBlockTypes = []

   170

   171

    def setname(self, name):

   172

        self.contentHeader.setname(name)

   173

    setattr(cls, "setname", setname)

   174

   175

    def getname(self):

   176

        return self.contentHeader.getname()

   177

    setattr(cls, "getname", getname)

   178

   179

    def getfileHeader(self):

   180

        fileheader = {}

   181

        fileheader["companyName"] = self.fileHeader.getcompanyName()

   182

        if self.fileHeader.getcompanyURL():

   183

            fileheader["companyURL"] = self.fileHeader.getcompanyURL()

   184

        fileheader["productName"] = self.fileHeader.getproductName()

   185

        fileheader["productVersion"] = self.fileHeader.getproductVersion()

   186

        if self.fileHeader.getproductRelease():

   187

            fileheader["productRelease"] = self.fileHeader.getproductRelease()

   188

        fileheader["creationDateTime"] = self.fileHeader.getcreationDateTime()

   189

        if self.fileHeader.getcontentDescription():

   190

            fileheader["contentDescription"] = self.fileHeader.getcontentDescription()

   191

        return fileheader

   192

    setattr(cls, "getfileHeader", getfileHeader)

   193

   194

    def setfileHeader(self, fileheader):

   195

        self.fileHeader.setcompanyName(fileheader["companyName"])

   196

        if fileheader.has_key("companyURL"):

   197

            self.fileHeader.setcompanyURL(fileheader["companyURL"])

   198

        self.fileHeader.setproductName(fileheader["productName"])

   199

        self.fileHeader.setproductVersion(fileheader["productVersion"])

   200

        if fileheader.has_key("productRelease"):

   201

            self.fileHeader.setproductRelease(fileheader["productRelease"])

   202

        self.fileHeader.setcreationDateTime(fileheader["creationDateTime"])

   203

        if fileheader.has_key("contentDescription"):

   204

            self.fileHeader.setcontentDescription(fileheader["contentDescription"])

   205

    setattr(cls, "setfileHeader", setfileHeader)

   206

   207

    def getcontentHeader(self):

   208

        contentheader = {}

   209

        contentheader["projectName"] = self.contentHeader.getname()

   210

        if self.contentHeader.getversion():

   211

            contentheader["projectVersion"] = self.contentHeader.getversion()

   212

        if self.contentHeader.getmodificationDateTime():

   213

            contentheader["modificationDateTime"] = self.contentHeader.getmodificationDateTime()

   214

        if self.contentHeader.getorganization():

   215

            contentheader["organization"] = self.contentHeader.getorganization()

   216

        if self.contentHeader.getauthor():

   217

            contentheader["authorName"] = self.contentHeader.getauthor()

   218

        if self.contentHeader.getlanguage():

   219

            contentheader["language"] = self.contentHeader.getlanguage()

   220

        contentheader["pageSize"] = self.contentHeader.getpageSize()

   221

        contentheader["scaling"] = self.contentHeader.getscaling()

   222

        return contentheader

   223

    setattr(cls, "getcontentHeader", getcontentHeader)

   224

   225

    def setcontentHeader(self, contentheader):

   226

        self.contentHeader.setname(contentheader["projectName"])

   227

        if contentheader.has_key("projectVersion"):

   228

            self.contentHeader.setversion(contentheader["projectVersion"])

   229

        if contentheader.has_key("modificationDateTime"):

   230

            self.contentHeader.setmodificationDateTime(contentheader["modificationDateTime"])

   231

        if contentheader.has_key("organization"):

   232

            self.contentHeader.setorganization(contentheader["organization"])

   233

        if contentheader.has_key("authorName"):

   234

            self.contentHeader.setauthor(contentheader["authorName"])

   235

        if contentheader.has_key("language"):

   236

            self.contentHeader.setlanguage(contentheader["language"])

   237

        self.contentHeader.setpageSize(*contentheader["pageSize"])

   238

        self.contentHeader.setscaling(contentheader["scaling"])

   239

    setattr(cls, "setcontentHeader", setcontentHeader)

   240

   241

    def getdataTypes(self):

   242

        return self.types.getdataTypeElements()

   243

    setattr(cls, "getdataTypes", getdataTypes)

   244

   245

    def getdataType(self, name):

   246

        return self.types.getdataTypeElement(name)

   247

    setattr(cls, "getdataType", getdataType)

   248

   249

    def appenddataType(self, name):

   250

        if self.CustomTypeHierarchy.has_key(name):

   251

            raise ValueError, "\"%s\" Data Type already exists !!!"%name

   252

        self.types.appenddataTypeElement(name)

   253

        self.AddCustomDataType(self.getdataType(name))

   254

    setattr(cls, "appenddataType", appenddataType)

   255

   256

    def insertdataType(self, index, datatype):

   257

        self.types.insertdataTypeElement(index, datatype)

   258

        self.AddCustomDataType(datatype)

   259

    setattr(cls, "insertdataType", insertdataType)

   260

   261

    def removedataType(self, name):

   262

        self.types.removedataTypeElement(name)

   263

        self.RefreshDataTypeHierarchy()

   264

        self.RefreshElementUsingTree()

   265

    setattr(cls, "removedataType", removedataType)

   266

   267

    def getpous(self):

   268

        return self.types.getpouElements()

   269

    setattr(cls, "getpous", getpous)

   270

   271

    def getpou(self, name):

   272

        return self.types.getpouElement(name)

   273

    setattr(cls, "getpou", getpou)

   274

   275

    def appendpou(self, name, pou_type, body_type):

   276

        self.types.appendpouElement(name, pou_type, body_type)

   277

        self.AddCustomBlockType(self.getpou(name))

   278

    setattr(cls, "appendpou", appendpou)

   279

   280

    def insertpou(self, index, pou):

   281

        self.types.insertpouElement(index, pou)

   282

        self.AddCustomBlockType(pou)

   283

    setattr(cls, "insertpou", insertpou)

   284

   285

    def removepou(self, name):

   286

        self.types.removepouElement(name)

   287

        self.RefreshCustomBlockTypes()

   288

        self.RefreshElementUsingTree()

   289

    setattr(cls, "removepou", removepou)

   290

   291

    def getconfigurations(self):

   292

        configurations = self.instances.configurations.getconfiguration()

   293

        if configurations:

   294

            return configurations

   295

        return []

   296

    setattr(cls, "getconfigurations", getconfigurations)

   297

   298

    def getconfiguration(self, name):

   299

        for configuration in self.instances.configurations.getconfiguration():

   300

            if configuration.getname() == name:

   301

                return configuration

   302

        return None

   303

    setattr(cls, "getconfiguration", getconfiguration)

   304

   305

    def addconfiguration(self, name):

   306

        for configuration in self.instances.configurations.getconfiguration():

   307

            if configuration.getname() == name:

   308

                raise ValueError, _("\"%s\" configuration already exists !!!")%name

   309

        new_configuration = PLCOpenClasses["configurations_configuration"]()

   310

        new_configuration.setname(name)

   311

        self.instances.configurations.appendconfiguration(new_configuration)

   312

    setattr(cls, "addconfiguration", addconfiguration)    

   313

   314

    def removeconfiguration(self, name):

   315

        found = False

   316

        for idx, configuration in enumerate(self.instances.configurations.getconfiguration()):

   317

            if configuration.getname() == name:

   318

                self.instances.configurations.removeconfiguration(idx)

   319

                found = True

   320

                break

   321

        if not found:

   322

            raise ValueError, ("\"%s\" configuration doesn't exist !!!")%name

   323

    setattr(cls, "removeconfiguration", removeconfiguration)

   324

   325

    def getconfigurationResource(self, config_name, name):

   326

        configuration = self.getconfiguration(config_name)

   327

        if configuration:

   328

            for resource in configuration.getresource():

   329

                if resource.getname() == name:

   330

                    return resource

   331

        return None

   332

    setattr(cls, "getconfigurationResource", getconfigurationResource)

   333

   334

    def addconfigurationResource(self, config_name, name):

   335

        configuration = self.getconfiguration(config_name)

   336

        if configuration:

   337

            for resource in configuration.getresource():

   338

                if resource.getname() == name:

   339

                    raise ValueError, _("\"%s\" resource already exists in \"%s\" configuration !!!")%(name, config_name)

   340

            new_resource = PLCOpenClasses["configuration_resource"]()

   341

            new_resource.setname(name)

   342

            configuration.appendresource(new_resource)

   343

    setattr(cls, "addconfigurationResource", addconfigurationResource)

   344

   345

    def removeconfigurationResource(self, config_name, name):

   346

        configuration = self.getconfiguration(config_name)

   347

        if configuration:

   348

            found = False

   349

            for idx, resource in enumerate(configuration.getresource()):

   350

                if resource.getname() == name:

   351

                    configuration.removeresource(idx)

   352

                    found = True

   353

                    break

   354

            if not found:

   355

                raise ValueError, _("\"%s\" resource doesn't exist in \"%s\" configuration !!!")%(name, config_name)

   356

    setattr(cls, "removeconfigurationResource", removeconfigurationResource)

   357

   358

    def updateElementName(self, old_name, new_name):

   359

        for datatype in self.types.getdataTypeElements():

   360

            datatype.updateElementName(old_name, new_name)

   361

        for pou in self.types.getpouElements():

   362

            pou.updateElementName(old_name, new_name)

   363

        for configuration in self.instances.configurations.getconfiguration():

   364

            configuration.updateElementName(old_name, new_name)

   365

    setattr(cls, "updateElementName", updateElementName)

   366

   367

    def updateElementAddress(self, old_leading, new_leading):

   368

        address_model = re.compile(FILTER_ADDRESS_MODEL % old_leading)

   369

        for pou in self.types.getpouElements():

   370

            pou.updateElementAddress(address_model, new_leading)

   371

        for configuration in self.instances.configurations.getconfiguration():

   372

            configuration.updateElementAddress(address_model, new_leading)

   373

    setattr(cls, "updateElementAddress", updateElementAddress)

   374

   375

    def removeVariableByAddress(self, address):

   376

        for pou in self.types.getpouElements():

   377

            pou.removeVariableByAddress(address)

   378

        for configuration in self.instances.configurations.getconfiguration():

   379

            configuration.removeVariableByAddress(address)

   380

    setattr(cls, "removeVariableByAddress", removeVariableByAddress)

   381

   382

    def removeVariableByFilter(self, leading):

   383

        address_model = re.compile(FILTER_ADDRESS_MODEL % leading)

   384

        for pou in self.types.getpouElements():

   385

            pou.removeVariableByFilter(address_model)

   386

        for configuration in self.instances.configurations.getconfiguration():

   387

            configuration.removeVariableByFilter(address_model)

   388

    setattr(cls, "removeVariableByFilter", removeVariableByFilter)

   389

   390

    def RefreshDataTypeHierarchy(self):

   391

        self.EnumeratedDataTypeValues = {}

   392

        self.CustomDataTypeRange = {}

   393

        self.CustomTypeHierarchy = {}

   394

        for datatype in self.getdataTypes():

   395

            self.AddCustomDataType(datatype)

   396

    setattr(cls, "RefreshDataTypeHierarchy", RefreshDataTypeHierarchy)

   397

   398

    def AddCustomDataType(self, datatype):

   399

        name = datatype.getname()

   400

        basetype_content = datatype.getbaseType().getcontent()

   401

        if basetype_content["value"] is None:

   402

            self.CustomTypeHierarchy[name] = basetype_content["name"]

   403

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

   404

            self.CustomTypeHierarchy[name] = basetype_content["name"].upper()

   405

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

   406

            self.CustomTypeHierarchy[name] = basetype_content["value"].getname()

   407

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

   408

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

   409

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

   410

            self.CustomDataTypeRange[name] = range

   411

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

   412

            if base_type["value"] is None:

   413

                self.CustomTypeHierarchy[name] = base_type["name"]

   414

            else:

   415

                self.CustomTypeHierarchy[name] = base_type["value"].getname()

   416

        else:

   417

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

   418

                values = []

   419

                for value in basetype_content["value"].values.getvalue():

   420

                    values.append(value.getname())

   421

                self.EnumeratedDataTypeValues[name] = values

   422

            self.CustomTypeHierarchy[name] = "ANY_DERIVED"

   423

    setattr(cls, "AddCustomDataType", AddCustomDataType)

   424

   425

    # Update Block types with user-defined pou added

   426

    def RefreshCustomBlockTypes(self):

   427

        # Reset the tree of user-defined pou cross-use

   428

        self.CustomBlockTypes = []

   429

        for pou in self.getpous():

   430

            self.AddCustomBlockType(pou)

   431

    setattr(cls, "RefreshCustomBlockTypes", RefreshCustomBlockTypes)

   432

   433

    def AddCustomBlockType(self, pou): 

   434

        pou_name = pou.getname()

   435

        pou_type = pou.getpouType()

   436

        pou_description = pou.getdescription()

   437

        if pou_description != "":

   438

            pou_comment = "%s\n%s" % (pou_name, pou_description)

   439

        else:

   440

            pou_comment = pou_name

   441

        block_infos = {"name" : pou_name, "type" : pou_type, "extensible" : False,

   442

                       "inputs" : [], "outputs" : [], "comment" : pou_comment,

   443

                       "generate" : generate_block, "initialise" : initialise_block}

   444

        if pou.getinterface():

   445

            return_type = pou.interface.getreturnType()

   446

            if return_type:

   447

                var_type = return_type.getcontent()

   448

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

   449

                    block_infos["outputs"].append(("", var_type["value"].getname(), "none"))

   450

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

   451

                    block_infos["outputs"].append(("", var_type["name"].upper(), "none"))

   452

                else:

   453

                    block_infos["outputs"].append(("", var_type["name"], "none"))

   454

            for type, varlist in pou.getvars():

   455

                if type == "InOut":

   456

                    for var in varlist.getvariable():

   457

                        var_type = var.type.getcontent()

   458

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

   459

                            block_infos["inputs"].append((var.getname(), var_type["value"].getname(), "none"))

   460

                            block_infos["outputs"].append((var.getname(), var_type["value"].getname(), "none"))

   461

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

   462

                            block_infos["inputs"].append((var.getname(), var_type["name"].upper(), "none"))

   463

                            block_infos["outputs"].append((var.getname(), var_type["name"].upper(), "none"))

   464

                        else:

   465

                            block_infos["inputs"].append((var.getname(), var_type["name"], "none"))

   466

                            block_infos["outputs"].append((var.getname(), var_type["name"], "none"))

   467

                elif type == "Input":

   468

                    for var in varlist.getvariable():

   469

                        var_type = var.type.getcontent()

   470

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

   471

                            block_infos["inputs"].append((var.getname(), var_type["value"].getname(), "none"))

   472

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

   473

                            block_infos["inputs"].append((var.getname(), var_type["name"].upper(), "none"))

   474

                        else:

   475

                            block_infos["inputs"].append((var.getname(), var_type["name"], "none"))

   476

                elif type == "Output":

   477

                    for var in varlist.getvariable():

   478

                        var_type = var.type.getcontent()

   479

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

   480

                            block_infos["outputs"].append((var.getname(), var_type["value"].getname(), "none"))

   481

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

   482

                            block_infos["outputs"].append((var.getname(), var_type["name"].upper(), "none"))

   483

                        else:

   484

                            block_infos["outputs"].append((var.getname(), var_type["name"], "none"))    

   485

        block_infos["usage"] = "\n (%s) => (%s)" % (", ".join(["%s:%s" % (input[1], input[0]) for input in block_infos["inputs"]]),

   486

                                                    ", ".join(["%s:%s" % (output[1], output[0]) for output in block_infos["outputs"]]))

   487

        self.CustomBlockTypes.append(block_infos)

   488

    setattr(cls, "AddCustomBlockType", AddCustomBlockType)

   489

   490

    def RefreshElementUsingTree(self):

   491

        # Reset the tree of user-defined element cross-use