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): 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

#Lesser 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

import cPickle

    28

import os,sys,re

    29

from datetime import *

    30

    31

from plcopen import plcopen

    32

from plcopen.structures import *

    33

from graphics.GraphicCommons import *

    34

from PLCGenerator import *

    35

    36

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)?")

    37

    38

[ITEM_UNEDITABLE, ITEM_PROJECT, ITEM_POU, ITEM_CLASS, ITEM_VARIABLE,

    39

 ITEM_TRANSITION, ITEM_ACTION, ITEM_CONFIGURATION, ITEM_RESOURCE] = range(9)

    40

    41

"""

    42

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

    43

reports. This class is used for not displaying them

    44

"""

    45

class HolePseudoFile:

    46

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

    47

    def __init__(self, output = None):

    48

        if output is None: output = []

    49

        self.output = output

    50

    51

    def writelines(self, l):

    52

        map(self.write, l)

    53

    54

    def write(self, s):

    55

        pass

    56

    57

    def flush(self):

    58

        pass

    59

    60

    def isatty(self):

    61

        return false

    62

    63

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

    64

#                         Undo Buffer for PLCOpenEditor

    65

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

    66

    67

# Length of the buffer

    68

UNDO_BUFFER_LENGTH = 20

    69

    70

"""

    71

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

    72

"""

    73

class UndoBuffer:

    74

    75

    # Constructor initialising buffer

    76

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

    77

        self.Buffer = []

    78

        self.CurrentIndex = -1

    79

        self.MinIndex = -1

    80

        self.MaxIndex = -1

    81

        # if current state is defined

    82

        if currentstate:

    83

            self.CurrentIndex = 0

    84

            self.MinIndex = 0

    85

            self.MaxIndex = 0

    86

        # Initialising buffer with currentstate at the first place

    87

        for i in xrange(UNDO_BUFFER_LENGTH):

    88

            if i == 0:

    89

                self.Buffer.append(currentstate)

    90

            else:

    91

                self.Buffer.append(None)

    92

        # Initialising index of state saved

    93

        if issaved:

    94

            self.LastSave = 0

    95

        else:

    96

            self.LastSave = -1

    97

    98

    # Add a new state in buffer

    99

    def Buffering(self, currentstate):

   100

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

   101

        self.Buffer[self.CurrentIndex] = currentstate

   102

        # Actualising buffer limits

   103

        self.MaxIndex = self.CurrentIndex

   104

        if self.MinIndex == self.CurrentIndex:

   105

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

   106

            if self.LastSave == self.MinIndex:

   107

                self.LastSave = -1

   108

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

   109

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

   110

   111

    # Return current state of buffer

   112

    def Current(self):

   113

        return self.Buffer[self.CurrentIndex]

   114

   115

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

   116

    def Previous(self):

   117

        if self.CurrentIndex != self.MinIndex:

   118

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

   119

            return self.Buffer[self.CurrentIndex]

   120

        return None

   121

   122

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

   123

    def Next(self):

   124

        if self.CurrentIndex != self.MaxIndex:

   125

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

   126

            return self.Buffer[self.CurrentIndex]

   127

        return None

   128

   129

    # Return True if current state is the first in buffer

   130

    def IsFirst(self):

   131

        return self.CurrentIndex == self.MinIndex

   132

   133

    # Return True if current state is the last in buffer

   134

    def IsLast(self):

   135

        return self.CurrentIndex == self.MaxIndex

   136

   137

    # Note that current state is saved

   138

    def CurrentSaved(self):

   139

        self.LastSave = self.CurrentIndex

   140

   141

    # Return True if current state is saved

   142

    def IsCurrentSaved(self):

   143

        return self.LastSave == self.CurrentIndex

   144

   145

   146

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

   147

#                           Controler for PLCOpenEditor

   148

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

   149

   150

"""

   151

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

   152

"""

   153

class PLCControler:

   154

   155

    # Create a new PLCControler

   156

    def __init__(self):

   157

        self.LastNewIndex = 0

   158

        self.Reset()

   159

   160

    # Reset PLCControler internal variables

   161

    def Reset(self):

   162

        self.VerifyXML = False

   163

        self.Project = None

   164

        self.ProjectBuffer = None

   165

        self.FilePath = ""

   166

        self.FileName = ""

   167

        self.ProgramFilePath = ""

   168

        self.ElementsOpened = []

   169

        self.CurrentElementEditing = None

   170

        self.RefreshPouUsingTree()

   171

        self.RefreshBlockTypes()

   172

   173

    def GetQualifierTypes(self):

   174

        return plcopen.QualifierList

   175

   176

   177

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

   178

#                         Project management functions

   179

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

   180

   181

    # Return if a project is opened

   182

    def HasOpenedProject(self):

   183

        return self.Project != None

   184

   185

    # Create a new project by replacing the current one

   186

    def CreateNewProject(self, name):

   187

        # Create the project

   188

        self.Project = plcopen.project()

   189

        self.Project.setName(name)

   190

        # Initialize the project buffer

   191

        #self.ProjectBuffer = UndoBuffer(self.Copy(self.Project))

   192

   193

    # Change project name

   194

    def SetProjectName(self, name):

   195

        self.Project.setName(name)

   196

   197

    # Return project name

   198

    def GetProjectName(self):

   199

        return self.Project.getName()

   200

   201

    # Return project pou names

   202

    def GetProjectPouNames(self):

   203

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

   204

   205

    # Return project pou names

   206

    def GetProjectConfigNames(self):

   207

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

   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

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

   216

                    for transition in pou.getTransitionList():

   217

                        variables.append(transition.getName())

   218

                    for action in pou.getActionList():

   219

                        variables.append(action.getName())

   220

        return variables

   221

   222

    # Return file path if project is an open file

   223

    def GetFilePath(self):

   224

        return self.FilePath

   225

   226

    # Return file path if project is an open file

   227

    def GetProgramFilePath(self):

   228

        return self.ProgramFilePath

   229

   230

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

   231

    def GetFilename(self):

   232

        if self.ProjectBuffer.IsCurrentSaved():

   233

            return self.FileName

   234

        else:

   235

            return "~%s~"%self.FileName

   236

   237

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

   238

    def SetFilePath(self, filepath):

   239

        self.FilePath = filepath

   240

        if filepath == "":

   241

            self.LastNewIndex += 1

   242

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

   243

        else:

   244

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

   245

   246

    # Change project properties

   247

    def SetProjectProperties(self, values):

   248

        self.Project.setFileHeader(values)

   249

   250

    # Return project properties

   251

    def GetProjectProperties(self):

   252

        return self.Project.getFileHeader()

   253

   254

    # Return project informations

   255

    def GetProjectInfos(self):

   256

        if self.Project:

   257

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

   258

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

   259

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

   260

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

   261

            for pou in self.Project.getPous():

   262

                pou_type = pou.getPouType().getValue()

   263

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

   264

                pou_values = []

   282

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

   283

                    transitions = []

   284

                    for transition in pou.getTransitionList():

   285

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

   286

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

   287

                    actions = []

   288

                    for action in pou.getActionList():

   289

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

   290

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

   291

                if pou_type in pou_types:

   292

                    pou_infos["values"] = pou_values

   293

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

   294

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

   295

            for config in self.Project.getConfigurations():

   296

                config_name = config.getName()

   297

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

   302

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

   303

                for resource in config.getResource():

   304

                    resource_name = resource.getName()

   305

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

   311

                    resources["values"].append(resource_infos)

   314

                configurations["values"].append(config_infos)

   315

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

   316

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

   317

                               pou_types["program"], configurations]

   318

            return infos

   319

        return None

   320

   321

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

   322

    def RefreshPouUsingTree(self):

   323

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

   324

        self.PouUsingTree = {}

   325

        if self.Project:

   326

            pous = self.Project.getPous()

   327

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

   328

            # user-defined pou cross-use

   329

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

   330

            for name in pounames:

   331

                self.PouUsingTree[name] = []

   332

            # Analyze each pou 

   333

            for pou in pous:

   334

                name = pou.getName()

   335

                bodytype = pou.getBodyType()

   336

                # If pou is written in a graphical language

   337

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

   338

                    # Analyze each instance of the pou

   339

                    for instance in pou.getInstances():

   340

                        if isinstance(instance, plcopen.block):

   341

                            typename = instance.getTypeName()

   342

                            # Update tree if there is a cross-use

   343

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

   344

                                 self.PouUsingTree[typename].append(name)

   345

                # If pou is written in a textual language

   346

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

   347

                    text = pou.getText()

   348

                    # Search if each pou is mentioned in the pou text

   349

                    for typename in pounames:

   350

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

   351

                        # Update tree if there is a cross-use

   352

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

   353

                            self.PouUsingTree[typename].append(name)

   354

   355

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

   356

    def PouIsUsed(self, name):

   357

        if name in self.PouUsingTree:

   358

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

   359

        return False

   360

   361

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

   362

    def PouIsUsedBy(self, name, reference):

   363

        if name in self.PouUsingTree:

   364

            list = self.PouUsingTree[name]

   365

            # Test if pou is directly used by reference

   366

            if reference in list:

   367

                return True

   368

            else:

   369

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

   370

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

   371

                used = False

   372

                for element in list:

   373

                    used |= self.PouIsUsedBy(element, reference)

   374

                return used

   375

        return False

   376

   377

    def GenerateProgram(self, filepath):

   378

        if self.Project:

   379

            #try:

   380

            program = GenerateCurrentProgram(self.Project)

   381

            programfile = open(filepath, "w")

   382

            programfile.write(program)

   383

            programfile.close()

   384

            self.ProgramFilePath = filepath

   385

            return True

   386

            #except:

   387

            #    pass

   388

        return False

   389

   390

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

   391

#                        Project Pous management functions

   392

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

   393

   394

    # Add a Pou to Project

   395

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

   396

        # Add the pou to project

   397

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

   398

        self.RefreshPouUsingTree()

   399

        self.RefreshBlockTypes()

   400

   401

    # Remove a pou from project

   402

    def ProjectRemovePou(self, name):

   403

        removed = None

   404

        # Search if the pou removed is currently opened

   405

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

   406

            if pou == name:

   407

                removed = i

   408

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

   409

        if removed != None:

   410

            self.ElementsOpened.pop(removed)

   411

            if self.CurrentElementEditing > removed:

   412

                self.CurrentElementEditing -= 1

   413

            if len(self.ElementsOpened) > 0:

   414

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

   415

            else:

   416

                self.CurrentElementEditing = None

   417

        # Remove pou from project

   418

        self.Project.removePou(name)

   419

        self.RefreshPouUsingTree()

   420

        self.RefreshBlockTypes()

   421

   422

    # Add a configuration to Project

   423

    def ProjectAddConfiguration(self, name):

   424

        self.Project.addConfiguration(name)

   425

        self.RefreshPouUsingTree()

   426

        self.RefreshBlockTypes()

   427

   428

    # Remove a configuration from project

   429

    def ProjectRemoveConfiguration(self, name):

   430

        self.Project.removeConfiguration(name)

   431

        self.RefreshPouUsingTree()

   432

        self.RefreshBlockTypes()

   433

   434

    # Add a resource to a configuration of the Project

   435

    def ProjectAddConfigurationResource(self, config, name):

   436

        self.Project.addConfigurationResource(config, name)

   437

        self.RefreshPouUsingTree()

   438

        self.RefreshBlockTypes()

   439

   440

    # Remove a resource from a configuration of the project

   441

    def ProjectRemoveConfigurationResource(self, config, name):

   442

        self.Project.removeConfigurationResource(config, name)

   443

        self.RefreshPouUsingTree()

   444

        self.RefreshBlockTypes()

   445

   446

    # Add a Transition to a Project Pou

   447

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

   448

        pou = self.Project.getPou(pou_name)

   449

        pou.addTransition(transition_name, transition_type)

   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

   456

    # Change the name of a pou

   457

    def ChangePouName(self, old_name, new_name):

   458

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

   459

        pou = self.Project.getPou(old_name)

   460

        pou.setName(new_name)

   461

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

   462

        if old_name in self.ElementsOpened:

   463

            idx = self.ElementsOpened.index(old_name)

   464

            self.ElementsOpened[idx] = new_name

   465

        self.RefreshPouUsingTree()

   466

        self.RefreshBlockTypes()

   467

   468

    # Change the name of a pou transition

   469

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

   470

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

   471

        pou = self.Project.getPou(pou_name)

   472

        transition = pou.getTransition(old_name)

   473

        transition.setName(new_name)

   474

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

   475

        old_computedname = self.ComputePouTransitionName(pou_name, old_name)

   476

        new_computedname = self.ComputePouTransitionName(pou_name, new_name)

   477

        if old_computedname in self.ElementsOpened:

   478

            idx = self.ElementsOpened.index(old_computedname)

   479

            self.ElementsOpened[idx] = new_computedname

   480

   481

    # Change the name of a pou action

   482

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

   483

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

   484

        pou = self.Project.getPou(pou_name)

   485

        action = pou.getAction(old_name)

   486

        action.setName(new_name)

   487

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

   488

        old_computedname = self.ComputePouActionName(pou_name, old_name)

   489

        new_computedname = self.ComputePouActionName(pou_name, new_name)

   490

        if old_computedname in self.ElementsOpened:

   491

            idx = self.ElementsOpened.index(old_computedname)

   492

            self.ElementsOpened[idx] = new_computedname

   493

   494

    # Change the name of a pou action

   495

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

   496

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

   497

        pou = self.Project.getPou(pou_name)

   498

        for type, varlist in pou.getVars():

   499

            for var in varlist.getVariable():

   500

                if var.getName() == old_name:

   501

                    var.setName(new_name)

   502

        self.RefreshBlockTypes()

   503

   504

    # Change the name of a configuration

   505

    def ChangeConfigurationName(self, old_name, new_name):

   506

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

   507

        configuration = self.Project.getConfiguration(old_name)

   508

        configuration.setName(new_name)

   509

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

   510

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

   511

            self.ElementsOpened[idx] = element.replace(old_name, new_name)

   512

   513

    # Change the name of a configuration resource

   514

    def ChangeConfigurationResourceName(self, config_name, old_name, new_name):

   515

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

   516

        resource = self.Project.getConfigurationResource(config_name)

   517

        resource.setName(new_name)

   518

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

   519

        old_computedname = self.ComputeConfigurationResourceName(config_name, old_name)

   520

        new_computedname = self.ComputeConfigurationResourceName(config_name, new_name)