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

"""

    38

Define in which order var types must be displayed

    39

"""

    40

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

    41

    42

"""

    43

Define which action qualifier must be associated with a duration 

    44

"""

    45

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

    46

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

    47

    48

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

    49

    50

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

    51

if cls:

    52

    def updateElementName(self, old_name, new_name):

    53

        index = self.text.find(old_name)

    54

        while index != -1:

    55

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

    56

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

    57

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

    58

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

    59

            else:

    60

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

    61

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

    62

    setattr(cls, "updateElementName", updateElementName)

    63

    64

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

    65

if cls:

    66

    cls.singleLineAttributes = False

    67

    cls.EnumeratedDataTypeValues = {}

    68

    cls.CustomDataTypeRange = {}

    69

    cls.CustomTypeHierarchy = {}

    70

    cls.ElementUsingTree = {}

    71

    cls.CustomBlockTypes = []

    72

    73

    def setname(self, name):

    74

        self.contentHeader.setname(name)

    75

    setattr(cls, "setname", setname)

    76

    77

    def getname(self):

    78

        return self.contentHeader.getname()

    79

    setattr(cls, "getname", getname)

    80

    81

    def getfileHeader(self):

    82

        fileheader = {}

    83

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

    84

        if self.fileHeader.getcompanyURL():

    85

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

    86

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

    87

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

    88

        if self.fileHeader.getproductRelease():

    89

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

    90

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

    91

        if self.fileHeader.getcontentDescription():

    92

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

    93

        return fileheader

    94

    setattr(cls, "getfileHeader", getfileHeader)

    95

    96

    def setfileHeader(self, fileheader):

    97

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

    98

        if "companyURL" in fileheader:

    99

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

   100

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

   101

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

   102

        if "productRelease" in fileheader:

   103

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

   104

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

   105

        if "contentDescription" in fileheader:

   106

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

   107

    setattr(cls, "setfileHeader", setfileHeader)

   108

   109

    def getcontentHeader(self):

   110

        contentheader = {}

   111

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

   112

        if self.contentHeader.getversion():

   113

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

   114

        if self.contentHeader.getmodificationDateTime():

   115

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

   116

        if self.contentHeader.getorganization():

   117

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

   118

        if self.contentHeader.getauthor():

   119

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

   120

        if self.contentHeader.getlanguage():

   121

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

   122

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

   123

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

   124

        return contentheader

   125

    setattr(cls, "getcontentHeader", getcontentHeader)

   126

   127

    def setcontentHeader(self, contentheader):

   128

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

   129

        if "projectVersion" in contentheader:

   130

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

   131

        if "modificationDateTime" in contentheader:

   132

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

   133

        if "organization" in contentheader:

   134

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

   135

        if "authorName" in contentheader:

   136

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

   137

        if "language" in contentheader:

   138

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

   139

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

   140

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

   141

    setattr(cls, "setcontentHeader", setcontentHeader)

   142

   143

    def getdataTypes(self):

   144

        return self.types.getdataTypeElements()

   145

    setattr(cls, "getdataTypes", getdataTypes)

   146

   147

    def getdataType(self, name):

   148

        return self.types.getdataTypeElement(name)

   149

    setattr(cls, "getdataType", getdataType)

   150

   151

    def appenddataType(self, name):

   152

        if name in self.CustomTypeHierarchy:

   153

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

   154

        self.types.appenddataTypeElement(name)

   155

        self.AddCustomDataType(self.getdataType(name))

   156

    setattr(cls, "appenddataType", appenddataType)

   157

   158

    def insertdataType(self, index, datatype):

   159

        self.types.insertdataTypeElement(index, datatype)

   160

        self.AddCustomDataType(datatype)

   161

    setattr(cls, "insertdataType", insertdataType)

   162

   163

    def removedataType(self, name):

   164

        self.types.removedataTypeElement(name)

   165

        self.RefreshDataTypeHierarchy()

   166

        self.RefreshElementUsingTree()

   167

    setattr(cls, "removedataType", removedataType)

   168

   169

    def getpous(self):

   170

        return self.types.getpouElements()

   171

    setattr(cls, "getpous", getpous)

   172

   173

    def getpou(self, name):

   174

        return self.types.getpouElement(name)

   175

    setattr(cls, "getpou", getpou)

   176

   177

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

   178

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

   179

        self.AddCustomBlockType(self.getpou(name))

   180

    setattr(cls, "appendpou", appendpou)

   181

   182

    def insertpou(self, index, pou):

   183

        self.types.insertpouElement(index, pou)

   184

        self.AddCustomBlockType(pou)

   185

    setattr(cls, "insertpou", insertpou)

   186

   187

    def removepou(self, name):

   188

        self.types.removepouElement(name)

   189

        self.RefreshCustomBlockTypes()

   190

        self.RefreshElementUsingTree()

   191

    setattr(cls, "removepou", removepou)

   192

   193

    def getconfigurations(self):

   194

        configurations = self.instances.configurations.getconfiguration()

   195

        if configurations:

   196

            return configurations

   197

        return []

   198

    setattr(cls, "getconfigurations", getconfigurations)

   199

   200

    def getconfiguration(self, name):

   201

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

   202

            if configuration.getname() == name:

   203

                return configuration

   204

        return None

   205

    setattr(cls, "getconfiguration", getconfiguration)

   206

   207

    def addconfiguration(self, name):

   208

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

   209

            if configuration.getname() == name:

   210

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

   211

        new_configuration = PLCOpenClasses["configurations_configuration"]()

   212

        new_configuration.setname(name)

   213

        self.instances.configurations.appendconfiguration(new_configuration)

   214

    setattr(cls, "addconfiguration", addconfiguration)    

   215

   216

    def removeconfiguration(self, name):

   217

        found = False

   218

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

   219

            if configuration.getname() == name:

   220

                self.instances.configurations.removeconfiguration(idx)

   221

                found = True

   222

                break

   223

        if not found:

   224

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

   225

    setattr(cls, "removeconfiguration", removeconfiguration)

   226

   227

    def getconfigurationResource(self, config_name, name):

   228

        configuration = self.getconfiguration(config_name)

   229

        if configuration:

   230

            for resource in configuration.getresource():

   231

                if resource.getname() == name:

   232

                    return resource

   233

        return None

   234

    setattr(cls, "getconfigurationResource", getconfigurationResource)

   235

   236

    def addconfigurationResource(self, config_name, name):

   237

        configuration = self.getconfiguration(config_name)

   238

        if configuration:

   239

            for resource in configuration.getresource():

   240

                if resource.getname() == name:

   241

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

   242

            new_resource = PLCOpenClasses["configuration_resource"]()

   243

            new_resource.setname(name)

   244

            configuration.appendresource(new_resource)

   245

    setattr(cls, "addconfigurationResource", addconfigurationResource)

   246

   247

    def removeconfigurationResource(self, config_name, name):

   248

        configuration = self.getconfiguration(config_name)

   249

        if configuration:

   250

            found = False

   251

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

   252

                if resource.getname() == name:

   253

                    configuration.removeresource(idx)

   254

                    found = True

   255

                    break

   256

            if not found:

   257

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

   258

    setattr(cls, "removeconfigurationResource", removeconfigurationResource)

   259

   260

    def updateElementName(self, old_name, new_name):

   261

        for pou in self.types.getpouElements():

   262

            pou.updateElementName(old_name, new_name)

   263

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

   264

            configuration.updateElementName(old_name, new_name)

   265

    setattr(cls, "updateElementName", updateElementName)

   266

   267

    def RefreshDataTypeHierarchy(self):

   268

        self.EnumeratedDataTypeValues = {}

   269

        self.CustomDataTypeRange = {}

   270

        self.CustomTypeHierarchy = {}

   271

        for datatype in self.getdataTypes():

   272

            self.AddCustomDataType(datatype)

   273

    setattr(cls, "RefreshDataTypeHierarchy", RefreshDataTypeHierarchy)

   274

   275

    def AddCustomDataType(self, datatype):

   276

        name = datatype.getname()

   277

        basetype_content = datatype.getbaseType().getcontent()

   278

        if basetype_content["value"] is None:

   279

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

   280

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

   281

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

   282

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

   283

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

   284

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

   285

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

   286

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

   287

            self.CustomDataTypeRange[name] = range

   288

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

   289

            if base_type["value"] is None:

   290

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

   291

            else:

   292

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

   293

        else:

   294

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

   295

                values = []

   296

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

   297

                    values.append(value.getname())

   298

                self.EnumeratedDataTypeValues[name] = values

   299

            self.CustomTypeHierarchy[name] = "ANY_DERIVED"

   300

    setattr(cls, "AddCustomDataType", AddCustomDataType)

   301

   302

    # Update Block types with user-defined pou added

   303

    def RefreshCustomBlockTypes(self):

   304

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

   305

        self.CustomBlockTypes = []

   306

        for pou in self.getpous():

   307

            self.AddCustomBlockType(pou)

   308

    setattr(cls, "RefreshCustomBlockTypes", RefreshCustomBlockTypes)

   309

   310

    def AddCustomBlockType(self, pou): 

   311

        pou_name = pou.getname()

   312

        pou_type = pou.getpouType()

   313

        if pou_type != "program":

   314

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

   315

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

   316

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

   317

            if pou.getinterface():

   318

                for type, varlist in pou.getvars():

   319

                    if type == "InOut":

   320

                        for var in varlist.getvariable():

   321

                            var_type = var.type.getcontent()

   322

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

   323

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

   324

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

   325

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

   326

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

   327

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

   328

                            else:

   329

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

   330

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

   331

                    elif type == "Input":

   332

                        for var in varlist.getvariable():

   333

                            var_type = var.type.getcontent()

   334

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

   335

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

   336

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

   337

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

   338

                            else:

   339

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

   340

                    elif type == "Output":

   341

                        for var in varlist.getvariable():

   342

                            var_type = var.type.getcontent()

   343

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

   344

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

   345

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

   346

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

   347

                            else:

   348

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

   349

                return_type = pou.interface.getreturnType()

   350

                if return_type:

   351

                    var_type = return_type.getcontent()

   352

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

   353

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

   354

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

   355

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

   356

                    else:

   357

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

   358

            if pou.getbodyType() in ["FBD","LD","SFC"]:

   359

                for instance in pou.getinstances():

   360

                    if isinstance(instance, PLCOpenClasses.get("commonObjects_comment", None)):

   361

                        block_infos["comment"] = instance.getcontentText()

   362

            self.CustomBlockTypes.append(block_infos)

   363

    setattr(cls, "AddCustomBlockType", AddCustomBlockType)

   364

   365

    def RefreshElementUsingTree(self):

   366

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

   367

        self.ElementUsingTree = {}

   368

        pous = self.getpous()

   369

        # Reference all the user-defined elementu names and initialize the tree of 

   370

        # user-defined elemnt cross-use

   371

        pounames = [pou.getname() for pou in pous]

   372

        for name in pounames:

   373

            self.ElementUsingTree[name] = []

   374

        # Analyze each pou

   375

        for pou in pous:

   376

            name = pou.getname()

   377

            if pou.interface:

   378

                # Extract variables from every varLists

   379

                for type, varlist in pou.getvars():

   380

                    for var in varlist.getvariable():

   381

                        vartype_content = var.gettype().getcontent()

   382

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

   383

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

   384

                            if typename in pounames and name not in self.ElementUsingTree[typename]:

   385

                                self.ElementUsingTree[typename].append(name)

   386

    setattr(cls, "RefreshElementUsingTree", RefreshElementUsingTree)

   387

   388

    def GetParentType(self, type):

   389

        if type in self.CustomTypeHierarchy:

   390

            return self.CustomTypeHierarchy[type]

   391

        elif type in TypeHierarchy:

   392

            return TypeHierarchy[type]

   393

        return None

   394

    setattr(cls, "GetParentType", GetParentType)

   395

   396

    def GetBaseType(self, type):

   397

        parent_type = self.GetParentType(type)

   398

        if parent_type is not None:

   399

            if parent_type.startswith("ANY"):

   400

                return type

   401

            else:

   402

                return self.GetBaseType(parent_type)

   403

        return None

   404

    setattr(cls, "GetBaseType", GetBaseType)

   405

   406

    def GetSubrangeBaseTypes(self, exclude):

   407

        derived = []

   408

        for type in self.CustomTypeHierarchy.keys():

   409

            for base_type in DataTypeRange.keys():

   410

                if self.IsOfType(type, base_type) and not self.IsOfType(type, exclude):

   411

                    derived.append(type)

   412

                    break

   413

        return DataTypeRange.keys() + derived

   414

    setattr(cls, "GetSubrangeBaseTypes", GetSubrangeBaseTypes)

   415

   416

    """

   417

    returns true if the given data type is the same that "reference" meta-type or one of its types.

   418

    """

   419

    def IsOfType(self, type, reference):

   420

        if reference is None:

   421

            return True

   422

        elif type == reference:

   423

            return True

   424

        else:

   425

            parent_type = self.GetParentType(type)

   426

            if parent_type is not None:

   427

                return self.IsOfType(parent_type, reference)

   428

        return False

   429

    setattr(cls, "IsOfType", IsOfType)

   430

   431

    # Return if pou given by name is used by another pou

   432

    def ElementIsUsed(self, name):

   433

        if name in self.ElementUsingTree:

   434

            return len(self.ElementUsingTree[name]) > 0

   435

        return False

   436

    setattr(cls, "ElementIsUsed", ElementIsUsed)

   437

   438

    def DataTypeIsDerived(self, name):

   439

        return name in self.CustomTypeHierarchy.values()

   440

    setattr(cls, "DataTypeIsDerived", DataTypeIsDerived)

   441

   442

    # Return if pou given by name is directly or undirectly used by the reference pou

   443

    def ElementIsUsedBy(self, name, reference):

   444

        if name in self.ElementUsingTree:

   445

            list = self.ElementUsingTree[name]

   446

            # Test if pou is directly used by reference

   447

            if reference in list:

   448

                return True

   449

            else:

   450

                # Test if pou is undirectly used by reference, by testing if pous 

   451

                # that directly use pou is directly or undirectly used by reference

   452

                used = False

   453

                for element in list:

   454

                    used |= self.ElementIsUsedBy(element, reference)

   455

                return used

   456

        return False

   457

    setattr(cls, "ElementIsUsedBy", ElementIsUsedBy)

   458

   459

    def GetDataTypeRange(self, type):

   460

        if type in self.CustomDataTypeRange:

   461

            return self.CustomDataTypeRange[type]

   462

        elif type in DataTypeRange:

   463

            return DataTypeRange[type]

   464

        else:

   465

            parent_type = self.GetParentType(type)

   466

            if parent_type is not None:

   467

                return self.GetDataTypeRange(parent_type)

   468

        return None

   469

    setattr(cls, "GetDataTypeRange", GetDataTypeRange)

   470

   471

    def GetEnumeratedDataTypeValues(self, type = None):

   472

        if type is None:

   473

            all_values = []

   474

            for values in self.EnumeratedDataTypeValues.values():

   475

                all_values.extend(values)

   476

            return all_values

   477

        elif type in self.EnumeratedDataTypeValues:

   478

            return self.EnumeratedDataTypeValues(type)

   479

        return []

   480

    setattr(cls, "GetEnumeratedDataTypeValues", GetEnumeratedDataTypeValues)

   481

   482

    # Function that returns the block definition associated to the block type given

   483

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

   484

        for customblocktype in self.CustomBlockTypes:

   485

            if inputs:

   486

                customblock_inputs = tuple([var_type for name, var_type, modifier in customblocktype["inputs"]])

   487

                same_inputs = inputs == customblock_inputs

   488

            else:

   489

                same_inputs = True

   490

            if customblocktype["name"] == type and same_inputs:

   491

                return customblocktype

   492

        return None

   493

    setattr(cls, "GetCustomBlockType", GetCustomBlockType)