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

    27

import os, re

    28

from lxml import etree

    29

"""

    30

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

    31

"""

    32

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

    33

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

    34

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

    35

    36

searchResultVarTypes = {

    37

    "inputVars": "var_input",

    38

    "outputVars": "var_output",

    39

    "inOutVars": "var_inout"

    40

}

    41

    42

"""

    43

Define in which order var types must be displayed

    44

"""

    45

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

    46

    47

"""

    48

Define which action qualifier must be associated with a duration 

    49

"""

    50

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

    51

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

    52

    53

    54

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

    55

    56

def update_address(address, address_model, new_leading):

    57

    result = address_model.match(address)

    58

    if result is None:

    59

        return address

    60

    groups = result.groups()

    61

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

    62

    63

def _init_and_compare(function, v1, v2):

    64

    if v1 is None:

    65

        return v2

    66

    if v2 is not None:

    67

        return function(v1, v2)

    68

    return v1

    69

    70

"""

    71

Helper class for bounding_box calculation 

    72

"""

    73

class rect:

    74

    75

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

    76

        self.x_min = x

    77

        self.x_max = None

    78

        self.y_min = y

    79

        self.y_max = None

    80

        if width is not None and x is not None:

    81

            self.x_max = x + width

    82

        if height is not None and y is not None:

    83

            self.y_max = y + height

    84

    85

    def update(self, x, y):

    86

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

    87

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

    88

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

    89

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

    90

    91

    def union(self, rect):

    92

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

    93

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

    94

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

    95

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

    96

    97

    def bounding_box(self):

    98

        width = height = None

    99

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

   100

            width = self.x_max - self.x_min

   101

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

   102

            height = self.y_max - self.y_min

   103

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

   104

   105

def TextLenInRowColumn(text):

   106

    if text == "":

   107

        return (0, 0)

   108

    lines = text.split("\n")

   109

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

   110

   111

def TestTextElement(text, criteria):

   112

    lines = text.splitlines()

   113

    if not criteria["case_sensitive"]:

   114

        text = text.upper()

   115

    test_result = []

   116

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

   117

    while result is not None:

   118

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

   119

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

   120

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

   121

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

   122

    return test_result

   123

   124

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

   125

PLCOpen_XPath = lambda xpath: etree.XPath(xpath, namespaces=PLCOpenParser.NSMAP)

   126

   127

LOAD_POU_PROJECT_TEMPLATE = """

   128

<project xmlns:ns1="http://www.plcopen.org/xml/tc6_0201" 

   129

         xmlns:xhtml="http://www.w3.org/1999/xhtml" 

   130

         xmlns:xsd="http://www.w3.org/2001/XMLSchema" 

   131

         xmlns="http://www.plcopen.org/xml/tc6_0201">

   132

  <fileHeader companyName="" productName="" productVersion="" 

   133

              creationDateTime="1970-01-01T00:00:00"/>

   134

  <contentHeader name="paste_project">

   135

    <coordinateInfo>

   136

      <fbd><scaling x="0" y="0"/></fbd>

   137

      <ld><scaling x="0" y="0"/></ld>

   138

      <sfc><scaling x="0" y="0"/></sfc>

   139

    </coordinateInfo>

   140

  </contentHeader>

   141

  <types>

   142

    <dataTypes/>

   143

    <pous>%s</pous>

   144

  </types>

   145

  <instances>

   146

    <configurations/>

   147

  </instances>

   148

</project>

   149

"""

   150

   151

def LOAD_POU_INSTANCES_PROJECT_TEMPLATE(body_type):

   152

    return LOAD_POU_PROJECT_TEMPLATE % """

   153

<pou name="paste_pou" pouType="program">

   154

  <body>

   155

    <%(body_type)s>%%s</%(body_type)s>

   156

  </body>

   157

</pou>""" % locals()

   158

   161

        "http://www.plcopen.org/xml/tc6.xsd", 

   162

        "http://www.plcopen.org/xml/tc6_0201")

   163

    for cre, repl in [

   164

        (re.compile("(?<!<xhtml:p>)(?:<!\[CDATA\[)"), "<xhtml:p><![CDATA["),

   165

        (re.compile("(?:]]>)(?!</xhtml:p>)"), "]]></xhtml:p>")]:

   166

        project_xml = cre.sub(repl, project_xml)

   181

    project_file.close()

   183

   184

project_pou_xpath = PLCOpen_XPath("/ppx:project/ppx:types/ppx:pous/ppx:pou")

   185

def LoadPou(xml_string):

   188

   189

project_pou_instances_xpath = {

   190

    body_type: PLCOpen_XPath(

   191

        "/ppx:project/ppx:types/ppx:pous/ppx:pou[@name='paste_pou']/ppx:body/ppx:%s/*" % body_type)

   192

    for body_type in ["FBD", "LD", "SFC"]}

   193

def LoadPouInstances(xml_string, body_type):

   197

   198

def SaveProject(project, filepath):

   199

    project_file = open(filepath, 'w')

   200

    project_file.write(etree.tostring(

   201

        project, 

   202

        pretty_print=True, 

   203

        xml_declaration=True, 

   204

        encoding='utf-8'))

   205

    project_file.close()

   206

   207

cls = PLCOpenParser.GetElementClass("formattedText")

   208

if cls:

   209

    def updateElementName(self, old_name, new_name):

   210

        text = self.getanyText()

   211

        index = text.find(old_name)

   212

        while index != -1:

   213

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

   214

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

   215

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

   216

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

   217

            else:

   218

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

   219

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

   220

        self.setanyText(text)

   221

    setattr(cls, "updateElementName", updateElementName)

   222

   223

    def updateElementAddress(self, address_model, new_leading):

   224

        text = self.getanyText()

   225

        startpos = 0

   226

        result = address_model.search(text, startpos)

   227

        while result is not None:

   228

            groups = result.groups()

   229

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

   230

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

   231

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

   232

            result = address_model.search(text, startpos)

   233

        self.setanyText(text)

   234

    setattr(cls, "updateElementAddress", updateElementAddress)

   235

   236

    def hasblock(self, block_type):

   237

        text = self.getanyText().upper()

   238

        index = text.find(block_type.upper())

   239

        while index != -1:

   240

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

   241

                not (index < len(text) - len(block_type) and text[index + len(block_type)] != "(")):

   242

                return True

   243

            index = text.find(block_type.upper(), index + len(block_type))

   244

        return False

   245

    setattr(cls, "hasblock", hasblock)

   246

   247

    def Search(self, criteria, parent_infos):

   248

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

   249

    setattr(cls, "Search", Search)

   250

   251

cls = PLCOpenParser.GetElementClass("project")

   252

if cls:

   253

   254

    def setname(self, name):

   255

        self.contentHeader.setname(name)

   256

    setattr(cls, "setname", setname)

   257

   258

    def getname(self):

   259

        return self.contentHeader.getname()

   260

    setattr(cls, "getname", getname)

   261

   262

    def getfileHeader(self):

   263

        fileheader_obj = self.fileHeader

   264

        return {

   265

            attr: value if value is not None else ""

   266

            for attr, value in [

   267

                ("companyName", fileheader_obj.getcompanyName()),

   268

                ("companyURL", fileheader_obj.getcompanyURL()),

   269

                ("productName", fileheader_obj.getproductName()),

   270

                ("productVersion", fileheader_obj.getproductVersion()),

   271

                ("productRelease", fileheader_obj.getproductRelease()),

   272

                ("creationDateTime", fileheader_obj.getcreationDateTime()),

   273

                ("contentDescription", fileheader_obj.getcontentDescription())]

   274

        }

   275

    setattr(cls, "getfileHeader", getfileHeader)

   276

   277

    def setfileHeader(self, fileheader):

   278

        fileheader_obj = self.fileHeader

   279

        for attr in ["companyName", "companyURL", "productName",

   280

                     "productVersion", "productRelease", "creationDateTime",

   281

                     "contentDescription"]:

   282

            value = fileheader.get(attr)

   283

            if value is not None:

   284

                setattr(fileheader_obj, attr, value)

   285

    setattr(cls, "setfileHeader", setfileHeader)

   286

   287

    def getcontentHeader(self):

   288

        contentheader_obj = self.contentHeader

   289

        contentheader = {

   290

            attr: value if value is not None else ""

   291

            for attr, value in [

   292

                ("projectName", contentheader_obj.getname()),

   293

                ("projectVersion", contentheader_obj.getversion()),

   294

                ("modificationDateTime", contentheader_obj.getmodificationDateTime()),

   295

                ("organization", contentheader_obj.getorganization()),

   296

                ("authorName", contentheader_obj.getauthor()),

   297

                ("language", contentheader_obj.getlanguage())]

   298

        }

   299

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

   300

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

   301

        return contentheader

   302

    setattr(cls, "getcontentHeader", getcontentHeader)

   303

   304

    def setcontentHeader(self, contentheader):

   305

        contentheader_obj = self.contentHeader

   306

        for attr, value in contentheader.iteritems():

   307

            func = {"projectName": contentheader_obj.setname,

   308

                    "projectVersion": contentheader_obj.setversion,

   309

                    "authorName": contentheader_obj.setauthor,

   310

                    "pageSize": lambda v: contentheader_obj.setpageSize(*v),

   311

                    "scaling": contentheader_obj.setscaling}.get(attr)

   312

            if func is not None:

   313

                func(value)

   314

            elif attr in ["modificationDateTime", "organization", "language"]:

   315

                setattr(contentheader_obj, attr, value)

   316

    setattr(cls, "setcontentHeader", setcontentHeader)

   317

   318

    def gettypeElementFunc(element_type):

   319

        elements_xpath = PLCOpen_XPath(

   320

            "ppx:types/ppx:%(element_type)ss/ppx:%(element_type)s[@name=$name]" % locals())

   321

        def gettypeElement(self, name):

   322

            elements = elements_xpath(self, name=name)

   323

            if len(elements) == 1:

   324

                return elements[0]

   325

            return None

   326

        return gettypeElement

   327

   328

    datatypes_xpath = PLCOpen_XPath("ppx:types/ppx:dataTypes/ppx:dataType")

   329

    filtered_datatypes_xpath = PLCOpen_XPath(

   330

        "ppx:types/ppx:dataTypes/ppx:dataType[@name!=$exclude]")

   331

    def getdataTypes(self, exclude=None):

   332

        if exclude is not None:

   333

            return filtered_datatypes_xpath(self, exclude=exclude)

   334

        return datatypes_xpath(self)

   335

    setattr(cls, "getdataTypes", getdataTypes)

   336

   337

    setattr(cls, "getdataType", gettypeElementFunc("dataType"))

   338

   339

    def appenddataType(self, name):

   340

        if self.getdataType(name) is not None:

   341

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

   342

        self.types.appenddataTypeElement(name)

   343

    setattr(cls, "appenddataType", appenddataType)

   344

   345

    def insertdataType(self, index, datatype):

   346

        self.types.insertdataTypeElement(index, datatype)

   347

    setattr(cls, "insertdataType", insertdataType)

   348

   349

    def removedataType(self, name):

   350

        self.types.removedataTypeElement(name)

   351

    setattr(cls, "removedataType", removedataType)

   352

   353

    def getpous(self, exclude=None, filter=[]):

   354

        return self.xpath(

   355

            "ppx:types/ppx:pous/ppx:pou%s%s" % 

   356

                (("[@name!='%s']" % exclude) if exclude is not None else '',

   357

                 ("[%s]" % " or ".join(

   358

                    map(lambda x: "@pouType='%s'" % x, filter)))

   359

                 if len(filter) > 0 else ""),

   360

            namespaces=PLCOpenParser.NSMAP)

   361

    setattr(cls, "getpous", getpous)

   362

   363

    setattr(cls, "getpou", gettypeElementFunc("pou"))

   364

   365

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

   366

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

   367

    setattr(cls, "appendpou", appendpou)

   368

   369

    def insertpou(self, index, pou):

   370

        self.types.insertpouElement(index, pou)

   371

    setattr(cls, "insertpou", insertpou)

   372

   373

    def removepou(self, name):

   374

        self.types.removepouElement(name)

   375

    setattr(cls, "removepou", removepou)

   376

   377

    configurations_xpath = PLCOpen_XPath(

   378

        "ppx:instances/ppx:configurations/ppx:configuration")

   379

    def getconfigurations(self):

   380

        return configurations_xpath(self)

   381

    setattr(cls, "getconfigurations", getconfigurations)

   382

   383

    configuration_xpath = PLCOpen_XPath(

   384

        "ppx:instances/ppx:configurations/ppx:configuration[@name=$name]")

   385

    def getconfiguration(self, name):

   386

        configurations = configuration_xpath(self, name=name)

   387

        if len(configurations) == 1:

   388

            return configurations[0]

   389

        return None

   390

    setattr(cls, "getconfiguration", getconfiguration)

   391

   392

    def addconfiguration(self, name):

   393

        if self.getconfiguration(name) is not None:

   394

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

   395

        new_configuration = PLCOpenParser.CreateElement("configuration", "configurations")

   396

        new_configuration.setname(name)

   397

        self.instances.configurations.appendconfiguration(new_configuration)

   398

    setattr(cls, "addconfiguration", addconfiguration)    

   399

   400

    def removeconfiguration(self, name):

   401

        configuration = self.getconfiguration(name)

   402

        if configuration is None:

   403

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

   404

        self.instances.configurations.remove(configuration)

   405

    setattr(cls, "removeconfiguration", removeconfiguration)

   406

   407

    resources_xpath = PLCOpen_XPath(

   408

        "ppx:instances/ppx:configurations/ppx:configuration[@name=$configname]/ppx:resource[@name=$name]")

   409

    def getconfigurationResource(self, config_name, name):

   410

        resources = resources_xpath(self, configname=config_name, name=name)

   411

        if len(resources) == 1:

   412

            return resources[0]

   413

        return None

   414

    setattr(cls, "getconfigurationResource", getconfigurationResource)

   415

   416

    def addconfigurationResource(self, config_name, name):

   417

        if self.getconfigurationResource(config_name, name) is not None:

   418

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

   419

        configuration = self.getconfiguration(config_name)

   420

        if configuration is not None:

   421

            new_resource = PLCOpenParser.CreateElement("resource", "configuration")

   422

            new_resource.setname(name)

   423

            configuration.appendresource(new_resource)

   424

    setattr(cls, "addconfigurationResource", addconfigurationResource)

   425

   426

    def removeconfigurationResource(self, config_name, name):

   427

        configuration = self.getconfiguration(config_name)

   428

        found = False

   429

        if configuration is not None:

   430

            resource = self.getconfigurationResource(config_name, name)

   431

            if resource is not None:

   432

                configuration.remove(resource)

   433

                found = True

   434

        if not found:

   435

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

   436

    setattr(cls, "removeconfigurationResource", removeconfigurationResource)

   437

   438

    def updateElementName(self, old_name, new_name):

   439

        for datatype in self.getdataTypes():

   440

            datatype.updateElementName(old_name, new_name)

   441

        for pou in self.getpous():

   442

            pou.updateElementName(old_name, new_name)

   443

        for configuration in self.getconfigurations():

   444

            configuration.updateElementName(old_name, new_name)

   445

    setattr(cls, "updateElementName", updateElementName)

   446

   447

    def updateElementAddress(self, old_leading, new_leading):

   448

        address_model = re.compile(FILTER_ADDRESS_MODEL % old_leading)

   449

        for pou in self.getpous():

   450

            pou.updateElementAddress(address_model, new_leading)

   451

        for configuration in self.getconfigurations():

   452

            configuration.updateElementAddress(address_model, new_leading)

   453

    setattr(cls, "updateElementAddress", updateElementAddress)

   454

   455

    def removeVariableByAddress(self, address):

   456

        for pou in self.getpous():

   457

            pou.removeVariableByAddress(address)

   458

        for configuration in self.getconfigurations():

   459

            configuration.removeVariableByAddress(address)

   460

    setattr(cls, "removeVariableByAddress", removeVariableByAddress)

   461

   462

    def removeVariableByFilter(self, leading):

   463

        address_model = re.compile(FILTER_ADDRESS_MODEL % leading)

   464

        for pou in self.getpous():

   465

            pou.removeVariableByFilter(address_model)

   466

        for configuration in self.getconfigurations():

   467

            configuration.removeVariableByFilter(address_model)

   468

    setattr(cls, "removeVariableByFilter", removeVariableByFilter)

   469

   470

    enumerated_values_xpath = PLCOpen_XPath(

   471

        "ppx:types/ppx:dataTypes/ppx:dataType/ppx:baseType/ppx:enum/ppx:values/ppx:value")

   472

    def GetEnumeratedDataTypeValues(self):

   473

        return [value.getname() for value in enumerated_values_xpath(self)]

   474

    setattr(cls, "GetEnumeratedDataTypeValues", GetEnumeratedDataTypeValues)

   475

   476

    def Search(self, criteria, parent_infos=[]):

   477

        result = self.types.Search(criteria, parent_infos)

   478

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

   479

            result.extend(configuration.Search(criteria, parent_infos))

   480

        return result

   481

    setattr(cls, "Search", Search)

   482

   483

cls = PLCOpenParser.GetElementClass("contentHeader", "project")

   484

if cls:

   485

   486

    def setpageSize(self, width, height):

   487

        self.coordinateInfo.setpageSize(width, height)

   488

    setattr(cls, "setpageSize", setpageSize)

   489

   490

    def getpageSize(self):

   491

        return self.coordinateInfo.getpageSize()

   492

    setattr(cls, "getpageSize", getpageSize)

   493

   494

    def setscaling(self, scaling):

   495

        for language, (x, y) in scaling.items():

   496

            self.coordinateInfo.setscaling(language, x, y)

   497

    setattr(cls, "setscaling", setscaling)

   498

   499

    def getscaling(self):

   500

        scaling = {}

   501

        scaling["FBD"] = self.coordinateInfo.getscaling("FBD")

   502

        scaling["LD"] = self.coordinateInfo.getscaling("LD")

   503

        scaling["SFC"] = self.coordinateInfo.getscaling("SFC")

   504

        return scaling

   505

    setattr(cls, "getscaling", getscaling)

   506

   507