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 xml.dom import minidom

    26

from types import StringType, UnicodeType

    27

import cPickle

    28

import os,sys,re

    29

from time import localtime

    30

from datetime import *

    31

    32

from plcopen import plcopen

    33

from plcopen.structures import *

    34

from graphics.GraphicCommons import *

    35

from PLCGenerator import *

    36

    37

duration_model = re.compile("(?:([0-9]{1,2})h)?(?:([0-9]{1,2})m(?!s))?(?:([0-9]{1,2})s)?(?:([0-9]{1,3}(?:.[0-9]*)?)ms)?")

    38

    39

[ITEM_UNEDITABLE, ITEM_PROJECT, ITEM_POU, ITEM_CLASS, ITEM_VARIABLE,

    40

 ITEM_TRANSITION, ITEM_ACTION, ITEM_CONFIGURATION, ITEM_RESOURCE, 

    41

 ITEM_DATATYPE] = range(10)

    42

    43

ScriptDirectory = os.path.split(os.path.realpath(__file__))[0]

    44

    45

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

    46

#                         Undo Buffer for PLCOpenEditor

    47

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

    48

    49

# Length of the buffer

    50

UNDO_BUFFER_LENGTH = 20

    51

    52

"""

    53

Class implementing a buffer of changes made on the current editing Object Dictionary

    54

"""

    55

class UndoBuffer:

    56

    57

    # Constructor initialising buffer

    58

    def __init__(self, currentstate, issaved = False):

    59

        self.Buffer = []

    60

        self.CurrentIndex = -1

    61

        self.MinIndex = -1

    62

        self.MaxIndex = -1

    63

        # if current state is defined

    64

        if currentstate:

    65

            self.CurrentIndex = 0

    66

            self.MinIndex = 0

    67

            self.MaxIndex = 0

    68

        # Initialising buffer with currentstate at the first place

    69

        for i in xrange(UNDO_BUFFER_LENGTH):

    70

            if i == 0:

    71

                self.Buffer.append(currentstate)

    72

            else:

    73

                self.Buffer.append(None)

    74

        # Initialising index of state saved

    75

        if issaved:

    76

            self.LastSave = 0

    77

        else:

    78

            self.LastSave = -1

    79

    80

    # Add a new state in buffer

    81

    def Buffering(self, currentstate):

    82

        self.CurrentIndex = (self.CurrentIndex + 1) % UNDO_BUFFER_LENGTH

    83

        self.Buffer[self.CurrentIndex] = currentstate

    84

        # Actualising buffer limits

    85

        self.MaxIndex = self.CurrentIndex

    86

        if self.MinIndex == self.CurrentIndex:

    87

            # If the removed state was the state saved, there is no state saved in the buffer

    88

            if self.LastSave == self.MinIndex:

    89

                self.LastSave = -1

    90

            self.MinIndex = (self.MinIndex + 1) % UNDO_BUFFER_LENGTH

    91

        self.MinIndex = max(self.MinIndex, 0)

    92

    93

    # Return current state of buffer

    94

    def Current(self):

    95

        return self.Buffer[self.CurrentIndex]

    96

    97

    # Change current state to previous in buffer and return new current state

    98

    def Previous(self):

    99

        if self.CurrentIndex != self.MinIndex:

   100

            self.CurrentIndex = (self.CurrentIndex - 1) % UNDO_BUFFER_LENGTH

   101

            return self.Buffer[self.CurrentIndex]

   102

        return None

   103

   104

    # Change current state to next in buffer and return new current state

   105

    def Next(self):

   106

        if self.CurrentIndex != self.MaxIndex:

   107

            self.CurrentIndex = (self.CurrentIndex + 1) % UNDO_BUFFER_LENGTH

   108

            return self.Buffer[self.CurrentIndex]

   109

        return None

   110

   111

    # Return True if current state is the first in buffer

   112

    def IsFirst(self):

   113

        return self.CurrentIndex == self.MinIndex

   114

   115

    # Return True if current state is the last in buffer

   116

    def IsLast(self):

   117

        return self.CurrentIndex == self.MaxIndex

   118

   119

    # Note that current state is saved

   120

    def CurrentSaved(self):

   121

        self.LastSave = self.CurrentIndex

   122

   123

    # Return True if current state is saved

   124

    def IsCurrentSaved(self):

   125

        return self.LastSave == self.CurrentIndex

   126

   127

   128

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

   129

#                           Controler for PLCOpenEditor

   130

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

   131

   132

"""

   133

Class which controls the operations made on the plcopen model and answers to view requests

   134

"""

   135

class PLCControler:

   136

   137

    # Create a new PLCControler

   138

    def __init__(self):

   139

        self.LastNewIndex = 0

   140

        self.Reset()

   141

   142

    # Reset PLCControler internal variables

   143

    def Reset(self):

   144

        self.Project = None

   145

        self.ProjectBuffer = None

   146

        self.Buffering = False

   147

        self.FilePath = ""

   148

        self.FileName = ""

   149

        self.ProgramFilePath = ""

   150

        self.RefreshDataTypeUsingTree()

   151

        self.RefreshDataTypes()

   152

        self.RefreshPouUsingTree()

   153

        self.RefreshBlockTypes()

   154

   155

    def GetQualifierTypes(self):

   156

        return plcopen.QualifierList

   157

   158

   159

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

   160

#                         Project management functions

   161

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

   162

   163

    # Return if a project is opened

   164

    def HasOpenedProject(self):

   165

        return self.Project != None

   166

   167

    # Create a new project by replacing the current one

   168

    def CreateNewProject(self, properties):

   169

        # Create the project

   170

        self.Project = plcopen.project()

   171

        properties["creationDateTime"] = datetime(*localtime()[:6])

   172

        self.Project.setfileHeader(properties)

   173

        self.Project.setcontentHeader(properties)

   174

        self.SetFilePath("")

   175

        # Initialize the project buffer

   176

        self.ProjectBuffer = UndoBuffer(self.Copy(self.Project), False)

   177

        self.Buffering = False

   178

   179

    # Return project data type names

   180

    def GetProjectDataTypeNames(self):

   181

        if self.Project:

   182

            return [datatype.getname() for datatype in self.Project.getdataTypes()]

   183

        return []

   184

   185

    # Return project pou names

   186

    def GetProjectPouNames(self):

   187

        if self.Project:

   188

            return [pou.getname() for pou in self.Project.getpous()]

   189

        return []

   190

   191

    # Return project pou names

   192

    def GetProjectConfigNames(self):

   193

        if self.Project:

   194

            return [config.getName() for config in self.Project.getconfigurations()]

   195

        return []

   196

   197

    # Return project pou variables

   198

    def GetProjectPouVariables(self, pou_name=None):

   199

        variables = []

   200

        for pou in self.Project.getpous():

   201

            if not pou_name or pou_name == pou.getname():

   202

                variables.extend([var["Name"] for var in self.GetPouInterfaceVars(pou)])

   203

                for transition in pou.gettransitionList():

   204

                    variables.append(transition.getname())

   205

                for action in pou.getactionList():

   206

                    variables.append(action.getname())

   207

        return variables

   208

   209

    # Return if project is saved

   210

    def ProjectIsSaved(self):

   211

        return self.ProjectBuffer.IsCurrentSaved()

   212

   213

    # Return file path if project is an open file

   214

    def GetFilePath(self):

   215

        return self.FilePath

   216

   217

    # Return file path if project is an open file

   218

    def GetProgramFilePath(self):

   219

        return self.ProgramFilePath

   220

   221

    # Return file name and point out if file is up to date

   222

    def GetFilename(self):

   223

        if self.ProjectBuffer.IsCurrentSaved():

   224

            return self.FileName

   225

        else:

   226

            return "~%s~"%self.FileName

   227

   228

    # Change file path and save file name or create a default one if file path not defined

   229

    def SetFilePath(self, filepath):

   230

        self.FilePath = filepath

   231

        if filepath == "":

   232

            self.LastNewIndex += 1

   233

            self.FileName = "Unnamed%d"%self.LastNewIndex

   234

        else:

   235

            self.FileName = os.path.splitext(os.path.basename(filepath))[0]

   236

   237

    # Change project properties

   238

    def SetProjectProperties(self, name = None, properties = None):

   239

        if name != None:

   240

            self.Project.setname(name)

   241

        if properties != None:

   242

            self.Project.setfileHeader(properties)

   243

            self.Project.setcontentHeader(properties)

   244

        if name != None or properties != None:

   245

            self.BufferProject()

   246

   247

    # Return project properties

   248

    def GetProjectProperties(self):

   249

        properties = self.Project.getfileHeader()

   250

        properties.update(self.Project.getcontentHeader())

   251

        return properties

   252

   253

    # Return project informations

   254

    def GetProjectInfos(self):

   255

        if self.Project:

   256

            infos = {"name": self.Project.getname(), "type": ITEM_PROJECT}

   257

            datatypes = {"name": "Data Types", "type": ITEM_UNEDITABLE, "values":[]}

   258

            for datatype in self.Project.getdataTypes():

   259

                datatypes["values"].append({"name": datatype.getname(), "type": ITEM_DATATYPE, "values": []})

   260

            pou_types = {"function": {"name": "Functions", "type": ITEM_UNEDITABLE, "values":[]},

   261

                         "functionBlock": {"name": "Function Blocks", "type": ITEM_UNEDITABLE, "values":[]},

   262

                         "program": {"name": "Programs", "type": ITEM_UNEDITABLE, "values":[]}}

   263

            for pou in self.Project.getpous():

   264

                pou_type = pou.getpouType()

   265

                pou_infos = {"name": pou.getname(), "type": ITEM_POU}

   266

                pou_values = []

   267

                if pou.getbodyType() == "SFC":

   268

                    transitions = []

   269

                    for transition in pou.gettransitionList():

   270

                        transitions.append({"name": transition.getname(), "type": ITEM_TRANSITION, "values": []})

   271

                    pou_values.append({"name": "Transitions", "type": ITEM_UNEDITABLE, "values": transitions})

   272

                    actions = []

   273

                    for action in pou.getactionList():

   274

                        actions.append({"name": action.getname(), "type": ITEM_ACTION, "values": []})

   275

                    pou_values.append({"name": "Actions", "type": ITEM_UNEDITABLE, "values": actions})

   276

                if pou_type in pou_types:

   277

                    pou_infos["values"] = pou_values

   278

                    pou_types[pou_type]["values"].append(pou_infos)

   279

            configurations = {"name": "Configurations", "type": ITEM_UNEDITABLE, "values": []}

   280

            for config in self.Project.getconfigurations():

   281

                config_name = config.getname()

   282

                config_infos = {"name": config_name, "type": ITEM_CONFIGURATION, "values": []}

   283

                resources = {"name": "Resources", "type": ITEM_UNEDITABLE, "values": []}

   284

                for resource in config.getresource():

   285

                    resource_name = resource.getname()

   286

                    resource_infos = {"name": resource_name, "type": ITEM_RESOURCE, "values": []}

   287

                    resources["values"].append(resource_infos)

   288

                config_infos["values"] = [resources]

   289

                configurations["values"].append(config_infos)

   290

            infos["values"] = [{"name": "Properties", "type": ITEM_UNEDITABLE, "values": []},

   291

                               datatypes, pou_types["function"], pou_types["functionBlock"], 

   292

                               pou_types["program"], configurations]

   293

            return infos

   294

        return None

   295

   380

    # Refresh the tree of user-defined data type cross-use

   381

    def RefreshDataTypeUsingTree(self):

   382

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

   383

        self.DataTypeUsingTree = {}

   384

        if self.Project:

   385

            datatypes = self.Project.getdataTypes()

   386

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

   387

            # user-defined data type cross-use

   388

            datatypenames = [datatype.getname() for datatype in datatypes]

   389

            for name in datatypenames:

   390

                self.DataTypeUsingTree[name] = []

   391

            # Analyze each data type

   392

            for datatype in datatypes:

   393

                name = datatype.getname()

   394

                basetype_content = datatype.getbaseType().getcontent()

   395

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

   396

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

   397

                    if basetype_name in datatypenames and name not in self.DataTypeUsingTree[basetype_name]:

   398

                        self.DataTypeUsingTree[basetype_name].append(name)

   399

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

   400

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

   401

                    if base_type["value"] is not None:

   402

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

   403

                        if basetype_name in datatypenames and name not in self.DataTypeUsingTree[basetype_name]:

   404

                            self.DataTypeUsingTree[basetype_name].append(name)

   405

   406

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

   407

    def RefreshPouUsingTree(self):

   408

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

   409

        self.PouUsingTree = {}

   410

        if self.Project:

   411

            pous = self.Project.getpous()

   412

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

   413

            # user-defined pou cross-use

   414

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

   415

            for name in pounames:

   416

                self.PouUsingTree[name] = []

   417

            # Analyze each pou 

   418

            for pou in pous:

   419

                name = pou.getname()

   420

                if pou.interface:

   421

                    # Extract variables from every varLists

   422

                    for type, varlist in pou.getvars():

   423

                        for var in varlist.getvariable():

   424

                            vartype_content = var.gettype().getcontent()

   425

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

   426

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

   427

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

   428

                                    self.PouUsingTree[typename].append(name)

   429

                bodytype = pou.getbodyType()

   430

                # If pou is written in a graphical language

   431

                if bodytype in ["FBD","LD","SFC"]:

   432

                    # Analyze each instance of the pou

   433

                    for instance in pou.getinstances():

   434

                        if isinstance(instance, plcopen.fbdObjects_block):

   435

                            typename = instance.gettypeName()

   436

                            # Update tree if there is a cross-use

   437

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

   438

                                 self.PouUsingTree[typename].append(name)

   439

                # If pou is written in a textual language

   440

                elif bodytype in ["IL", "ST"]:

   441

                    text = pou.gettext()

   442

                    # Search if each pou is mentioned in the pou text

   443

                    for typename in pounames:

   444

                        typename_model = re.compile("[ \t\n]%s[ \t\n]"%typename)

   445

                        # Update tree if there is a cross-use

   446

                        if typename != name and typename_model.search(text):

   447

                            self.PouUsingTree[typename].append(name)

   448

   449

    # Return if data type given by name is used by another data type or pou

   450

    def DataTypeIsUsed(self, name):

   451

        if name in self.DataTypeUsingTree:

   452

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

   453

        return False

   454

   455

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

   456

    def PouIsUsed(self, name):

   457

        if name in self.PouUsingTree:

   458

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

   459

        return False

   460

   461

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

   462

    def DataTypeIsUsedBy(self, name, reference):

   463

        if name in self.DataTypeUsingTree:

   464

            list = self.DataTypeUsingTree[name]

   465

            # Test if data type is directly used by reference

   466

            if reference in list:

   467

                return True

   468

            else:

   469

                # Test if data type is undirectly used by reference, by testing if data types 

   470

                # that directly use data type is directly or undirectly used by reference

   471

                used = False

   472

                for element in list:

   473

                    used |= self.DataTypeIsUsedBy(element, reference)

   474

                return used

   475

        return False

   476

   477

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

   478

    def PouIsUsedBy(self, name, reference):

   479

        if name in self.PouUsingTree:

   480

            list = self.PouUsingTree[name]

   481

            # Test if pou is directly used by reference

   482

            if reference in list:

   483

                return True

   484

            else:

   485

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

   486

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

   487

                used = False

   488

                for element in list:

   489

                    used |= self.PouIsUsedBy(element, reference)

   490

                return used

   491

        return False

   492

   493

    def GenerateProgram(self, filepath):

   494

        if self.Project:

   495

            try:

   496

                program = GenerateCurrentProgram(self.Project)

   497

                programfile = open(filepath, "w")

   498

                programfile.write(program)

   499

                programfile.close()

   500

                self.ProgramFilePath = filepath

   501

                return None

   502

            except PLCGenException, e:

   503

                return e.message

   504

        return "No project opened"

   505