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 minixsv import pyxsval

    26

from xml.dom import minidom

    27

from types import StringType, UnicodeType

    28

import cPickle

    29

import os,sys,re

    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] = range(9)

    41

    42

"""

    43

pyxsval is not complete and the parts that are not supported print some error

    44

reports. This class is used for not displaying them

    45

"""

    46

class HolePseudoFile:

    47

    """ Base class for file like objects to facilitate StdOut for the Shell."""

    48

    def __init__(self, output = None):

    49

        if output is None: output = []

    50

        self.output = output

    51

    52

    def writelines(self, l):

    53

        map(self.write, l)

    54

    55

    def write(self, s):

    56

        pass

    57

    58

    def flush(self):

    59

        pass

    60

    61

    def isatty(self):

    62

        return false

    63

    64

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

    65

#                         Undo Buffer for PLCOpenEditor

    66

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

    67

    68

# Length of the buffer

    69

UNDO_BUFFER_LENGTH = 20

    70

    71

"""

    72

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

    73

"""

    74

class UndoBuffer:

    75

    76

    # Constructor initialising buffer

    77

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

    78

        self.Buffer = []

    79

        self.CurrentIndex = -1

    80

        self.MinIndex = -1

    81

        self.MaxIndex = -1

    82

        # if current state is defined

    83

        if currentstate:

    84

            self.CurrentIndex = 0

    85

            self.MinIndex = 0

    86

            self.MaxIndex = 0

    87

        # Initialising buffer with currentstate at the first place

    88

        for i in xrange(UNDO_BUFFER_LENGTH):

    89

            if i == 0:

    90

                self.Buffer.append(currentstate)

    91

            else:

    92

                self.Buffer.append(None)

    93

        # Initialising index of state saved

    94

        if issaved:

    95

            self.LastSave = 0

    96

        else:

    97

            self.LastSave = -1

    98

    99

    # Add a new state in buffer

   100

    def Buffering(self, currentstate):

   101

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

   102

        self.Buffer[self.CurrentIndex] = currentstate

   103

        # Actualising buffer limits

   104

        self.MaxIndex = self.CurrentIndex

   105

        if self.MinIndex == self.CurrentIndex:

   106

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

   107

            if self.LastSave == self.MinIndex:

   108

                self.LastSave = -1

   109

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

   110

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

   111

   112

    # Return current state of buffer

   113

    def Current(self):

   114

        return self.Buffer[self.CurrentIndex]

   115

   116

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

   117

    def Previous(self):

   118

        if self.CurrentIndex != self.MinIndex:

   119

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

   120

            return self.Buffer[self.CurrentIndex]

   121

        return None

   122

   123

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

   124

    def Next(self):

   125

        if self.CurrentIndex != self.MaxIndex:

   126

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

   127

            return self.Buffer[self.CurrentIndex]

   128

        return None

   129

   130

    # Return True if current state is the first in buffer

   131

    def IsFirst(self):

   132

        return self.CurrentIndex == self.MinIndex

   133

   134

    # Return True if current state is the last in buffer

   135

    def IsLast(self):

   136

        return self.CurrentIndex == self.MaxIndex

   137

   138

    # Note that current state is saved

   139

    def CurrentSaved(self):

   140

        self.LastSave = self.CurrentIndex

   141

   142

    # Return True if current state is saved

   143

    def IsCurrentSaved(self):

   144

        return self.LastSave == self.CurrentIndex

   145

   146

   147

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

   148

#                           Controler for PLCOpenEditor

   149

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

   150

   151

"""

   152

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

   153

"""

   154

class PLCControler:

   155

   156

    # Create a new PLCControler

   157

    def __init__(self):

   158

        self.LastNewIndex = 0

   159

        self.Reset()

   160

   161

    # Reset PLCControler internal variables

   162

    def Reset(self):

   163

        self.VerifyXML = False

   164

        self.Project = None

   165

        self.ProjectBuffer = None

   166

        self.Buffering = False

   167

        self.FilePath = ""

   168

        self.FileName = ""

   169

        self.ProgramFilePath = ""

   170

        self.ElementsOpened = []

   171

        self.CurrentElementEditing = None

   172

        self.RefreshPouUsingTree()

   173

        self.RefreshBlockTypes()

   174

   175

    def GetQualifierTypes(self):

   176

        return plcopen.QualifierList

   177

   178

   179

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

   180

#                         Project management functions

   181

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

   182

   183

    # Return if a project is opened

   184

    def HasOpenedProject(self):

   185

        return self.Project != None

   186

   187

    # Create a new project by replacing the current one

   188

    def CreateNewProject(self, name):

   189

        # Create the project

   190

        self.Project = plcopen.project()

   191

        self.Project.setName(name)

   192

        self.SetFilePath("")

   193

        # Initialize the project buffer

   194

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

   195

        self.Buffering = False

   196

   197

    # Return project pou names

   198

    def GetProjectPouNames(self):

   199

        if self.Project:

   200

            return [pou.getName() for pou in self.Project.getPous()]

   201

        return []

   202

   203

    # Return project pou names

   204

    def GetProjectConfigNames(self):

   205

        if self.Project:

   206

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

   207

        return []

   208

   209

    # Return project pou variables

   210

    def GetProjectPouVariables(self, pou_name=None):

   211

        variables = []

   212

        for pou in self.Project.getPous():

   213

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

   214

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

   215

                for transition in pou.getTransitionList():

   216

                    variables.append(transition.getName())

   217

                for action in pou.getActionList():

   218

                    variables.append(action.getName())

   219

        return variables

   220

   221

    # Return if project is saved

   222

    def ProjectIsSaved(self):

   223

        return self.ProjectBuffer.IsCurrentSaved()

   224

   225

    # Return file path if project is an open file

   226

    def GetFilePath(self):

   227

        return self.FilePath

   228

   229

    # Return file path if project is an open file

   230

    def GetProgramFilePath(self):

   231

        return self.ProgramFilePath

   232

   233

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

   234

    def GetFilename(self):

   235

        if self.ProjectBuffer.IsCurrentSaved():

   236

            return self.FileName

   237

        else:

   238

            return "~%s~"%self.FileName

   239

   240

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

   241

    def SetFilePath(self, filepath):

   242

        self.FilePath = filepath

   243

        if filepath == "":

   244

            self.LastNewIndex += 1

   245

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

   246

        else:

   247

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

   248

   249

    # Change project properties

   250

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

   251

        if name != None:

   252

            self.Project.setName(name)

   253

        if properties != None:

   254

            self.Project.setFileHeader(properties)

   255

        if name != None or properties != None:

   256

            self.BufferProject()

   257

   258

    # Return project properties

   259

    def GetProjectProperties(self):

   260

        properties = self.Project.getFileHeader()

   261

        properties["projectName"] = self.Project.getName()

   262

        return properties

   263

   264

    # Return project informations

   265

    def GetProjectInfos(self):

   266

        if self.Project:

   267

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

   268

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

   269

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

   270

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

   271

            for pou in self.Project.getPous():

   272

                pou_type = pou.getPouType().getValue()

   273

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

   274

                pou_values = []

   275

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

   276

                    transitions = []

   277

                    for transition in pou.getTransitionList():

   278

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

   279

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

   280

                    actions = []

   281

                    for action in pou.getActionList():

   282

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

   283

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

   284

                if pou_type in pou_types:

   285

                    pou_infos["values"] = pou_values

   286

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

   287

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

   288

            for config in self.Project.getConfigurations():

   289

                config_name = config.getName()

   290

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

   291

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

   292

                for resource in config.getResource():

   293

                    resource_name = resource.getName()

   294

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

   295

                    resources["values"].append(resource_infos)

   296

                config_infos["values"] = [resources]

   297

                configurations["values"].append(config_infos)

   298

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

   299

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

   300

                               pou_types["program"], configurations]

   301

            return infos

   302

        return None

   303

   304

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

   305

    def RefreshPouUsingTree(self):

   306

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

   307

        self.PouUsingTree = {}

   308

        if self.Project:

   309

            pous = self.Project.getPous()

   310

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

   311

            # user-defined pou cross-use

   312

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

   313

            for name in pounames:

   314

                self.PouUsingTree[name] = []

   315

            # Analyze each pou 

   316

            for pou in pous:

   317

                name = pou.getName()

   318

                if pou.interface:

   319

                    # Extract variables from every varLists

   320

                    for type, varlist in pou.getVars():

   321

                        for var in varlist.getVariable():

   322

                            var_type = var.getType().getValue()

   323

                            if not isinstance(var_type, (StringType, UnicodeType)):

   324

                                typename = var_type.getName()

   325

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

   326

                                    self.PouUsingTree[typename].append(name)

   327

                bodytype = pou.getBodyType()

   328

                # If pou is written in a graphical language

   329

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

   330

                    # Analyze each instance of the pou

   331

                    for instance in pou.getInstances():

   332

                        if isinstance(instance, plcopen.block):

   333

                            typename = instance.getTypeName()

   334

                            # Update tree if there is a cross-use

   335

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

   336

                                 self.PouUsingTree[typename].append(name)

   337

                # If pou is written in a textual language

   338

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

   339

                    text = pou.getText()

   340

                    # Search if each pou is mentioned in the pou text

   341

                    for typename in pounames:

   342

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

   343

                        # Update tree if there is a cross-use

   344

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

   345

                            self.PouUsingTree[typename].append(name)

   346

   347

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

   348

    def PouIsUsed(self, name):

   349

        if name in self.PouUsingTree:

   350

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

   351

        return False

   352

   353

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

   354

    def PouIsUsedBy(self, name, reference):

   355

        if name in self.PouUsingTree:

   356

            list = self.PouUsingTree[name]

   357

            # Test if pou is directly used by reference

   358

            if reference in list:

   359

                return True

   360

            else:

   361

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

   362

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

   363

                used = False

   364

                for element in list:

   365

                    used |= self.PouIsUsedBy(element, reference)

   366

                return used

   367

        return False

   368

   369

    def GenerateProgram(self, filepath):

   370

        if self.Project:

   371

            try:

   372

                program = GenerateCurrentProgram(self.Project)

   373

                programfile = open(filepath, "w")

   374

                programfile.write(program)

   375

                programfile.close()

   376

                self.ProgramFilePath = filepath

   377

                return True

   378

            except:

   379

                pass

   380

        return False

   381

   382

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

   383

#                        Project Pous management functions

   384

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

   385

   386

    # Add a Pou to Project

   387

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

   388

        # Add the pou to project

   389

        self.Project.appendPou(name, pou_type, body_type)

   390

        self.SetPouInterfaceReturnType(name, "BOOL")

   391

        self.RefreshPouUsingTree()

   392

        self.RefreshBlockTypes()

   393

        self.BufferProject()

   394

   395

    # Remove a pou from project

   396

    def ProjectRemovePou(self, name):

   397

        removed = None

   398

        # Search if the pou removed is currently opened

   399

        for i, pou in enumerate(self.ElementsOpened):

   400

            if pou == name:

   401

                removed = i

   402

        # If found, remove pou from list of opened pous and actualize current edited

   403

        if removed != None:

   404

            self.ElementsOpened.pop(removed)

   405

            if self.CurrentElementEditing > removed:

   406

                self.CurrentElementEditing -= 1

   407

            if len(self.ElementsOpened) > 0:

   408

                self.CurrentElementEditing = max(0, min(self.CurrentElementEditing, len(self.ElementsOpened) - 1))

   409

            else:

   410

                self.CurrentElementEditing = None

   411

        # Remove pou from project

   412

        self.Project.removePou(name)

   413

        self.RefreshPouUsingTree()

   414

        self.RefreshBlockTypes()

   415

        self.BufferProject()

   416

   417

    # Add a configuration to Project

   418

    def ProjectAddConfiguration(self, name):

   419

        self.Project.addConfiguration(name)

   420

        self.RefreshPouUsingTree()

   421

        self.RefreshBlockTypes()

   422

        self.BufferProject()

   423

   424

    # Remove a configuration from project

   425

    def ProjectRemoveConfiguration(self, name):

   426

        self.Project.removeConfiguration(name)

   427

        self.RefreshPouUsingTree()

   428

        self.RefreshBlockTypes()

   429

        self.BufferProject()

   430

   431

    # Add a resource to a configuration of the Project

   432

    def ProjectAddConfigurationResource(self, config, name):

   433

        self.Project.addConfigurationResource(config, name)

   434

        self.RefreshPouUsingTree()

   435

        self.RefreshBlockTypes()

   436

        self.BufferProject()

   437

   438

    # Remove a resource from a configuration of the project

   439

    def ProjectRemoveConfigurationResource(self, config, name):

   440

        self.Project.removeConfigurationResource(config, name)

   441

        self.RefreshPouUsingTree()

   442

        self.RefreshBlockTypes()

   443

        self.BufferProject()

   444

   445

    # Add a Transition to a Project Pou

   446

    def ProjectAddPouTransition(self, pou_name, transition_name, transition_type):

   447

        pou = self.Project.getPou(pou_name)

   448

        pou.addTransition(transition_name, transition_type)

   449

        self.BufferProject()

   450

   451

    # Add a Transition to a Project Pou

   452

    def ProjectAddPouAction(self, pou_name, action_name, action_type):

   453

        pou = self.Project.getPou(pou_name)

   454

        pou.addAction(action_name, action_type)

   455

        self.BufferProject()

   456

   457

    # Change the name of a pou

   458

    def ChangePouName(self, old_name, new_name):

   459

        # Found the pou corresponding to old name and change its name to new name

   460

        pou = self.Project.getPou(old_name)

   461

        pou.setName(new_name)

   462

        # If pou is currently opened, change its name in the list of opened pous

   463

        for idx, element in enumerate(self.ElementsOpened):

   464

            words = element.split("::")

   465

            if words[0] in ["P","T","A"] and words[1] == old_name:

   466

                if words[0] == "P":

   467

                    self.ElementsOpened[idx] = self.ComputePouName(new_name)

   468

                elif words[0] == "T":

   469

                    self.ElementsOpened[idx] = self.ComputePouTransitionName(new_name, words[2])

   470

                else:

   471

                    self.ElementsOpened[idx] = self.ComputePouActionName(new_name, words[2])

   472

        self.Project.updateElementName(old_name, new_name)

   473

        self.RefreshPouUsingTree()

   474

        self.RefreshBlockTypes()

   475

        self.BufferProject()

   476

   477

    # Change the name of a pou transition

   478

    def ChangePouTransitionName(self, pou_name, old_name, new_name):

   479

        # Found the pou transition corresponding to old name and change its name to new name

   480

        pou = self.Project.getPou(pou_name)

   481

        transition = pou.getTransition(old_name)

   482

        transition.setName(new_name)

   483

        # If pou transition is currently opened, change its name in the list of opened elements

   484

        old_computedname = self.ComputePouTransitionName(pou_name, old_name)

   485

        new_computedname = self.ComputePouTransitionName(pou_name, new_name)

   486

        if old_computedname in self.ElementsOpened:

   487

            idx = self.ElementsOpened.index(old_computedname)

   488

            self.ElementsOpened[idx] = new_computedname

   489

        self.BufferProject()

   490

   491

    # Change the name of a pou action

   492

    def ChangePouActionName(self, pou_name, old_name, new_name):

   493

        # Found the pou action corresponding to old name and change its name to new name

   494

        pou = self.Project.getPou(pou_name)

   495

        action = pou.getAction(old_name)

   496

        action.setName(new_name)

   497

        # If pou action is currently opened, change its name in the list of opened elements

   498

        old_computedname = self.ComputePouActionName(pou_name, old_name)

   499

        new_computedname = self.ComputePouActionName(pou_name, new_name)

   500

        if old_computedname in self.ElementsOpened:

   501

            idx = self.ElementsOpened.index(old_computedname)

   502

            self.ElementsOpened[idx] = new_computedname

   503

        self.BufferProject()

   504

   505

    # Change the name of a pou variable

   506

    def ChangePouVariableName(self, pou_name, old_name, new_name):

   507

        # Found the pou action corresponding to old name and change its name to new name

   508

        pou = self.Project.getPou(pou_name)

   509

        for type, varlist in pou.getVars():

   510

            for var in varlist.getVariable():

   511

                if var.getName() == old_name:

   512

                    var.setName(new_name)

   513

        self.RefreshBlockTypes()

   514

        self.BufferProject()

   515