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

from lxml import etree

    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

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

   126

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

   127

   128

LOAD_POU_PROJECT_TEMPLATE = """

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

  <contentHeader name="paste_project">

   136

    <coordinateInfo>

   137

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

   138

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

   139

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

   140

    </coordinateInfo>

   141

  </contentHeader>

   142

  <types>

   143

    <dataTypes/>

   144

    <pous>%s</pous>

   145

  </types>

   146

  <instances>

   147

    <configurations/>

   148

  </instances>

   149

</project>

   150

"""

   151

   152

def LOAD_POU_INSTANCES_PROJECT_TEMPLATE(body_type):

   153

    return LOAD_POU_PROJECT_TEMPLATE % """

   154

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

   155

  <body>

   156

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

   157

  </body>

   158

</pou>""" % locals()

   159

   160

def LoadProject(filepath):

   161

    project_file = open(filepath)

   162

    project_xml = project_file.read().replace(

   163

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

   164

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

   165

    for cre, repl in [

   166

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

   167

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

   168

        project_xml = cre.sub(repl, project_xml)

   169

    project_file.close()

   170

   171

    return etree.fromstring(project_xml, PLCOpenParser)

   172

   173

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

   174

def LoadPou(xml_string):

   175

    root = etree.fromstring(

   176

        LOAD_POU_PROJECT_TEMPLATE % xml_string, 

   177

        PLCOpenParser)

   178

    return project_pou_xpath(root)[0]

   179

   180

project_pou_instances_xpath = {

   181

    body_type: PLCOpen_XPath(

   182

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

   183

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

   184

def LoadPouInstances(xml_string, body_type):

   185

    root = etree.fromstring(

   186

        LOAD_POU_INSTANCES_PROJECT_TEMPLATE(body_type) % xml_string, 

   187

        PLCOpenParser)

   188

    return project_pou_instances_xpath[body_type](root)

   189

   190

def SaveProject(project, filepath):

   191

    project_file = open(filepath, 'w')

   192

    project_file.write(etree.tostring(

   193

        project, 

   194

        pretty_print=True, 

   195

        xml_declaration=True, 

   196

        encoding='utf-8'))

   197

    project_file.close()

   198

   199

cls = PLCOpenParser.GetElementClass("formattedText")

   200

if cls:

   201

    def updateElementName(self, old_name, new_name):

   202

        text = self.getanyText()

   203

        index = text.find(old_name)

   204

        while index != -1:

   205

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

   206

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

   207

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

   208

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

   209

            else:

   210

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

   211

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

   212

        self.setanyText(text)

   213

    setattr(cls, "updateElementName", updateElementName)

   214

   215

    def updateElementAddress(self, address_model, new_leading):

   216

        text = self.getanyText()

   217

        startpos = 0

   218

        result = address_model.search(text, startpos)

   219

        while result is not None:

   220

            groups = result.groups()

   221

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

   222

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

   223

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

   224

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

   225

        self.setanyText(text)

   226

    setattr(cls, "updateElementAddress", updateElementAddress)

   227

   228

    def hasblock(self, block_type):

   229

        text = self.getanyText().upper()

   230

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

   231

        while index != -1:

   232

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

   233

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

   234

                return True

   235

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

   236

        return False

   237

    setattr(cls, "hasblock", hasblock)

   238

   239

    def Search(self, criteria, parent_infos):

   240

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

   241

    setattr(cls, "Search", Search)

   242

   243

cls = PLCOpenParser.GetElementClass("project")

   244

if cls:

   245

   246

    def setname(self, name):

   247

        self.contentHeader.setname(name)

   248

    setattr(cls, "setname", setname)

   249

   250

    def getname(self):

   251

        return self.contentHeader.getname()

   252

    setattr(cls, "getname", getname)

   253

   254

    def getfileHeader(self):

   255

        fileheader_obj = self.fileHeader

   256

        return {

   257

            attr: value if value is not None else ""

   258

            for attr, value in [

   259

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

   260

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

   261

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

   262

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

   263

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

   264

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

   265

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

   266

        }

   267

    setattr(cls, "getfileHeader", getfileHeader)

   268

   269

    def setfileHeader(self, fileheader):

   270

        fileheader_obj = self.fileHeader

   277

    setattr(cls, "setfileHeader", setfileHeader)

   278

   279

    def getcontentHeader(self):

   280

        contentheader_obj = self.contentHeader

   281

        contentheader = {

   282

            attr: value if value is not None else ""

   283

            for attr, value in [

   284

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

   285

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

   286

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

   287

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

   288

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

   289

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

   290

        }

   291

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

   292

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

   293

        return contentheader

   294

    setattr(cls, "getcontentHeader", getcontentHeader)

   295

   296

    def setcontentHeader(self, contentheader):

   297

        contentheader_obj = self.contentHeader

   298

        for attr, value in contentheader.iteritems():

   299

            if attr == "projectName":

   300

                contentheader_obj.setname(value)

   301

            elif attr == "projectVersion":

   302

                contentheader_obj.setversion(value)

   305

            elif attr == "pageSize":

   306

                contentheader_obj.setpageSize(*contentheader["pageSize"])

   307

            elif attr == "scaling":

   308

                contentheader_obj.setscaling(contentheader["scaling"])

   310

                setattr(contentheader_obj, attr, value)

   311

    setattr(cls, "setcontentHeader", setcontentHeader)

   312

   313

    def gettypeElementFunc(element_type):

   314

        elements_xpath = PLCOpen_XPath(

   315

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

   316

        def gettypeElement(self, name):

   317

            elements = elements_xpath(self, name=name)

   318

            if len(elements) == 1:

   319

                return elements[0]

   320

            return None

   321

        return gettypeElement

   322

   323

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

   324

    filtered_datatypes_xpath = PLCOpen_XPath(

   325

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

   326

    def getdataTypes(self, exclude=None):

   327

        if exclude is not None:

   328

            return filtered_datatypes_xpath(self, exclude=exclude)

   329

        return datatypes_xpath(self)

   330

    setattr(cls, "getdataTypes", getdataTypes)

   331

   332

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

   333

   334

    def appenddataType(self, name):

   335

        if self.getdataType(name) is not None:

   336

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

   337

        self.types.appenddataTypeElement(name)

   338

    setattr(cls, "appenddataType", appenddataType)

   339

   340

    def insertdataType(self, index, datatype):

   341

        self.types.insertdataTypeElement(index, datatype)

   342

    setattr(cls, "insertdataType", insertdataType)

   343

   344

    def removedataType(self, name):

   345

        self.types.removedataTypeElement(name)

   346

    setattr(cls, "removedataType", removedataType)

   347

   348

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

   349

        return self.xpath(

   350

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

   351

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

   352

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

   353

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

   354

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

   355

            namespaces=PLCOpenParser.NSMAP)

   356

    setattr(cls, "getpous", getpous)

   357

   358

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

   359

   360

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

   361

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

   362

    setattr(cls, "appendpou", appendpou)

   363

   364

    def insertpou(self, index, pou):

   365

        self.types.insertpouElement(index, pou)

   366

    setattr(cls, "insertpou", insertpou)

   367

   368

    def removepou(self, name):

   369

        self.types.removepouElement(name)

   370

    setattr(cls, "removepou", removepou)

   371

   372

    configurations_xpath = PLCOpen_XPath(

   373

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

   374

    def getconfigurations(self):

   375

        return configurations_xpath(self)

   376

    setattr(cls, "getconfigurations", getconfigurations)

   377

   378

    configuration_xpath = PLCOpen_XPath(

   379

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

   380

    def getconfiguration(self, name):

   381

        configurations = configuration_xpath(self, name=name)

   382

        if len(configurations) == 1:

   383

            return configurations[0]

   384

        return None

   385

    setattr(cls, "getconfiguration", getconfiguration)

   386

   387

    def addconfiguration(self, name):

   388

        if self.getconfiguration(name) is not None:

   389

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

   390

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

   391

        new_configuration.setname(name)

   392

        self.instances.configurations.appendconfiguration(new_configuration)

   393

    setattr(cls, "addconfiguration", addconfiguration)    

   394

   395

    def removeconfiguration(self, name):

   396

        configuration = self.getconfiguration(name)

   397

        if configuration is None:

   398

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

   399

        self.instances.configurations.remove(configuration)

   400

    setattr(cls, "removeconfiguration", removeconfiguration)

   401

   402

    resources_xpath = PLCOpen_XPath(

   403

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

   404

    def getconfigurationResource(self, config_name, name):

   405

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

   406

        if len(resources) == 1:

   407

            return resources[0]

   408

        return None

   409

    setattr(cls, "getconfigurationResource", getconfigurationResource)

   410

   411

    def addconfigurationResource(self, config_name, name):

   412

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

   413

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

   414

        configuration = self.getconfiguration(config_name)

   415

        if configuration is not None:

   416

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

   417

            new_resource.setname(name)

   418

            configuration.appendresource(new_resource)

   419

    setattr(cls, "addconfigurationResource", addconfigurationResource)

   420

   421

    def removeconfigurationResource(self, config_name, name):

   422

        configuration = self.getconfiguration(config_name)

   423

        found = False

   424

        if configuration is not None:

   425

            resource = self.getconfigurationResource(config_name, name)

   426

            if resource is not None:

   427

                configuration.remove(resource)

   428

                found = True

   429

        if not found:

   430

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

   431

    setattr(cls, "removeconfigurationResource", removeconfigurationResource)

   432

   433

    def updateElementName(self, old_name, new_name):

   434

        for datatype in self.getdataTypes():

   435

            datatype.updateElementName(old_name, new_name)

   436

        for pou in self.getpous():

   437

            pou.updateElementName(old_name, new_name)

   438

        for configuration in self.getconfigurations():

   439

            configuration.updateElementName(old_name, new_name)

   440

    setattr(cls, "updateElementName", updateElementName)

   441

   442

    def updateElementAddress(self, old_leading, new_leading):

   443

        address_model = re.compile(FILTER_ADDRESS_MODEL % old_leading)

   444

        for pou in self.getpous():

   445

            pou.updateElementAddress(address_model, new_leading)

   446

        for configuration in self.getconfigurations():

   447

            configuration.updateElementAddress(address_model, new_leading)

   448

    setattr(cls, "updateElementAddress", updateElementAddress)

   449

   450

    def removeVariableByAddress(self, address):

   451

        for pou in self.getpous():

   452

            pou.removeVariableByAddress(address)

   453

        for configuration in self.getconfigurations():

   454

            configuration.removeVariableByAddress(address)

   455

    setattr(cls, "removeVariableByAddress", removeVariableByAddress)

   456

   457

    def removeVariableByFilter(self, leading):

   458

        address_model = re.compile(FILTER_ADDRESS_MODEL % leading)

   459

        for pou in self.getpous():

   460

            pou.removeVariableByFilter(address_model)

   461

        for configuration in self.getconfigurations():

   462

            configuration.removeVariableByFilter(address_model)

   463

    setattr(cls, "removeVariableByFilter", removeVariableByFilter)

   464

   465

    enumerated_values_xpath = PLCOpen_XPath(

   466

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

   467

    def GetEnumeratedDataTypeValues(self):

   468

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

   469

    setattr(cls, "GetEnumeratedDataTypeValues", GetEnumeratedDataTypeValues)

   470

   471

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

   472

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

   473

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

   474

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

   475

        return result

   476

    setattr(cls, "Search", Search)

   477

   478

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

   479

if cls:

   480

   481

    def setpageSize(self, width, height):

   482

        self.coordinateInfo.setpageSize(width, height)

   483

    setattr(cls, "setpageSize", setpageSize)

   484

   485

    def getpageSize(self):

   486

        return self.coordinateInfo.getpageSize()

   487

    setattr(cls, "getpageSize", getpageSize)

   488

   489

    def setscaling(self, scaling):

   490

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

   491

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

   492

    setattr(cls, "setscaling", setscaling)

   493

   494

    def getscaling(self):

   495

        scaling = {}

   496

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

   497

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

   498

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

   499

        return scaling

   500

    setattr(cls, "getscaling", getscaling)

   501

   502

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

   503

if cls:

   504

    def setpageSize(self, width, height):

   505

        if width == 0 and height == 0:

   506

            self.deletepageSize()

   507

        else: