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)?(?:([0-9]{1,2})s)?(?:([0-9]{1,3})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.ElementsOpened = []

   168

        self.CurrentElementEditing = None

   169

        self.RefreshPouUsingTree()

   170

        self.RefreshBlockTypes()

   171

   172

    def GetQualifierTypes(self):

   173

        return plcopen.QualifierList

   174

   175

   176

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

   177

#                         Project management functions

   178

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

   179

   180

    # Return if a project is opened

   181

    def HasOpenedProject(self):

   182

        return self.Project != None

   183

   184

    # Create a new project by replacing the current one

   185

    def CreateNewProject(self, name):

   186

        # Create the project

   187

        self.Project = plcopen.project()

   188

        self.Project.setName(name)

   189

        # Initialize the project buffer

   190

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

   191

   192

    # Change project name

   193

    def SetProjectName(self, name):

   194

        self.Project.setName(name)

   195

   196

    # Return project name

   197

    def GetProjectName(self):

   198

        return self.Project.getName()

   199

   200

    # Return project pou names

   201

    def GetProjectPouNames(self):

   202

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

   203

   204

    # Return project pou names

   205

    def GetProjectConfigNames(self):

   206

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

   207

   208

    # Return project pou variables

   209

    def GetProjectPouVariables(self, pou_name=None):

   210

        variables = []

   211

        for pou in self.Project.getPous():

   212

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

   213

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

   214

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

   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 file path if project is an open file

   222

    def GetFilePath(self):

   223

        return self.FilePath

   224

   225

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

   226

    def GetFilename(self):

   227

        if self.ProjectBuffer.IsCurrentSaved():

   228

            return self.FileName

   229

        else:

   230

            return "~%s~"%self.FileName

   231

   232

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

   233

    def SetFilePath(self, filepath):

   234

        self.FilePath = filepath

   235

        if filepath == "":

   236

            self.LastNewIndex += 1

   237

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

   238

        else:

   239

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

   240

   241

    # Change project properties

   242

    def SetProjectProperties(self, values):

   243

        self.Project.setFileHeader(values)

   244

   245

    # Return project properties

   246

    def GetProjectProperties(self):

   247

        return self.Project.getFileHeader()

   248

   249

    # Return project informations

   250

    def GetProjectInfos(self):

   251

        if self.Project:

   252

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

   253

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

   254

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

   255

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

   256

            for pou in self.Project.getPous():

   257

                pou_type = pou.getPouType().getValue()

   258

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

   259

                var_types = {"Input": {"name": "Input", "type": ITEM_CLASS, "values": []},

   260

                         "Output": {"name": "Output", "type": ITEM_CLASS, "values": []},

   261

                         "InOut": {"name": "InOut", "type": ITEM_CLASS, "values": []},

   262

                         "External": {"name": "External", "type": ITEM_CLASS, "values": []},

   263

                         "Local": {"name": "Local", "type": ITEM_CLASS, "values": []},

   264

                         "Temp": {"name": "Temp", "type": ITEM_CLASS, "values": []},

   265

                         "Global": {"name": "Global", "type": ITEM_CLASS, "values": []}}

   266

                for var in self.GetPouInterfaceVars(pou):

   267

                    var_values = {"name": var["Name"], "type": ITEM_VARIABLE, "values": []}

   268

                    if var["Class"] in var_types.keys():

   269

                        var_types[var["Class"]]["values"].append(var_values)

   270

                pou_values = []

   271

                pou_values.append({"name": "Interface", "type": ITEM_CLASS, 

   272

                    "values": [var_types["Input"], var_types["Output"], var_types["InOut"], var_types["External"]]})

   273

                pou_values.append({"name": "Variables", "type": ITEM_CLASS, 

   274

                    "values": [var_types["Local"], var_types["Temp"]]})

   275

                if pou_type == "program":

   276

                    pou_values.append(var_types["Global"])

   277

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

   278

                    transitions = []

   279

                    for transition in pou.getTransitionList():

   280

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

   281

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

   282

                    actions = []

   283

                    for action in pou.getActionList():

   284

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

   285

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

   286

                if pou_type in pou_types:

   287

                    pou_infos["values"] = pou_values

   288

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

   289

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

   290

            for config in self.Project.getConfigurations():

   291

                config_name = config.getName()

   292

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

   293

                config_vars = {"name": "Global", "type": ITEM_CLASS, "values": []}

   294

                for var in self.GetConfigurationGlobalVars(config_name):

   295

                    var_values = {"name": var["Name"], "type": ITEM_VARIABLE, "values": []}

   296

                    config_vars["values"].append(var_values)

   297

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

   298

                for resource in config.getResource():

   299

                    resource_name = resource.getName()

   300

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

   301

                    resource_vars = {"name": "Global", "type": ITEM_CLASS, "values": []}

   302

                    for var in self.GetConfigurationResourceGlobalVars(config_name, resource_name):

   303

                        var_values = {"name": var["Name"], "type": ITEM_VARIABLE, "values": []}

   304

                        resource_vars["values"].append(var_values)

   305

                    resource_infos["values"].append(resource_vars)

   306

                    resources["values"].append(resource_infos)

   307

                config_infos["values"] = [config_vars, resources]

   308

                configurations["values"].append(config_infos)

   309

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

   310

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

   311

                               pou_types["program"], configurations]

   312

            return infos

   313

        return None

   314

   315

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

   316

    def RefreshPouUsingTree(self):

   317

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

   318

        self.PouUsingTree = {}

   319

        if self.Project:

   320

            pous = self.Project.getPous()

   321

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

   322

            # user-defined pou cross-use

   323

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

   324

            for name in pounames:

   325

                self.PouUsingTree[name] = []

   326

            # Analyze each pou 

   327

            for pou in pous:

   328

                name = pou.getName()

   329

                bodytype = pou.getBodyType()

   330

                # If pou is written in a graphical language

   331

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

   332

                    # Analyze each instance of the pou

   333

                    for instance in pou.getInstances():

   334

                        if isinstance(instance, plcopen.block):

   335

                            typename = instance.getTypeName()

   336

                            # Update tree if there is a cross-use

   337

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

   338

                                 self.PouUsingTree[typename].append(name)

   339

                # If pou is written in a textual language

   340

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

   341

                    text = pou.getText()

   342

                    # Search if each pou is mentioned in the pou text

   343

                    for typename in pounames:

   344

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

   345

                        # Update tree if there is a cross-use

   346

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

   347

                            self.PouUsingTree[typename].append(name)

   348

   349

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

   350

    def PouIsUsed(self, name):

   351

        if name in self.PouUsingTree:

   352

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

   353

        return False

   354

   355

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

   356

    def PouIsUsedBy(self, name, reference):

   357

        if name in self.PouUsingTree:

   358

            list = self.PouUsingTree[name]

   359

            # Test if pou is directly used by reference

   360

            if reference in list:

   361

                return True

   362

            else:

   363

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

   364

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

   365

                used = False

   366

                for element in list:

   367

                    used |= self.PouIsUsedBy(element, reference)

   368

                return used

   369

        return False

   370

   371

    def GenerateProgram(self, filepath):

   372

        if self.Project:

   381

        return False

   382

   383

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

   384

#                        Project Pous management functions

   385

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

   386

   387

    # Add a Pou to Project

   388

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

   389

        # Add the pou to project

   390

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

   391

        self.RefreshPouUsingTree()

   392

        self.RefreshBlockTypes()

   393

   394

    # Remove a pou from project

   395

    def ProjectRemovePou(self, name):

   396

        removed = None

   397

        # Search if the pou removed is currently opened

   398

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

   399

            if pou == name:

   400

                removed = i

   401

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

   402

        if removed != None:

   403

            self.ElementsOpened.pop(removed)

   404

            if self.CurrentElementEditing > removed:

   405

                self.CurrentElementEditing -= 1

   406

            if len(self.ElementsOpened) > 0:

   407

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

   408

            else:

   409

                self.CurrentElementEditing = None

   410

        # Remove pou from project

   411

        self.Project.removePou(name)

   412

        self.RefreshPouUsingTree()

   413

        self.RefreshBlockTypes()

   414

   415

    # Add a configuration to Project

   416

    def ProjectAddConfiguration(self, name):

   417

        self.Project.addConfiguration(name)

   418

        self.RefreshPouUsingTree()

   419

        self.RefreshBlockTypes()

   420

   421

    # Remove a configuration from project

   422

    def ProjectRemoveConfiguration(self, name):

   423

        self.Project.removeConfiguration(name)

   424

        self.RefreshPouUsingTree()

   425

        self.RefreshBlockTypes()

   426

   427

    # Add a resource to a configuration of the Project

   428

    def ProjectAddConfigurationResource(self, config, name):

   429

        self.Project.addConfigurationResource(config, name)

   430

        self.RefreshPouUsingTree()

   431

        self.RefreshBlockTypes()

   432

   433

    # Remove a resource from a configuration of the project

   434

    def ProjectRemoveConfigurationResource(self, config, name):

   435

        self.Project.removeConfigurationResource(config, name)

   436

        self.RefreshPouUsingTree()

   437

        self.RefreshBlockTypes()

   438

   439

    # Add a Transition to a Project Pou

   440

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

   441

        pou = self.Project.getPou(pou_name)

   442

        pou.addTransition(transition_name, transition_type)

   443

   444

    # Add a Transition to a Project Pou

   445

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

   446

        pou = self.Project.getPou(pou_name)

   447

        pou.addAction(action_name, action_type)

   448

   449

    # Change the name of a pou

   450

    def ChangePouName(self, old_name, new_name):

   451

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

   452

        pou = self.Project.getPou(old_name)

   453

        pou.setName(new_name)

   454

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

   455

        if old_name in self.ElementsOpened:

   456

            idx = self.ElementsOpened.index(old_name)

   457

            self.ElementsOpened[idx] = new_name

   458

        self.RefreshPouUsingTree()

   459

        self.RefreshBlockTypes()

   460

   461

    # Change the name of a pou transition

   462

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

   463

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

   464

        pou = self.Project.getPou(pou_name)

   465

        transition = pou.getTransition(old_name)

   466

        transition.setName(new_name)

   467

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

   468

        old_computedname = self.ComputePouTransitionName(pou_name, old_name)

   469

        new_computedname = self.ComputePouTransitionName(pou_name, new_name)

   470

        if old_computedname in self.ElementsOpened:

   471

            idx = self.ElementsOpened.index(old_computedname)

   472

            self.ElementsOpened[idx] = new_computedname

   473

   474

    # Change the name of a pou action

   475

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

   476

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

   477

        pou = self.Project.getPou(pou_name)

   478

        action = pou.getAction(old_name)

   479

        action.setName(new_name)

   480

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

   481

        old_computedname = self.ComputePouActionName(pou_name, old_name)

   482

        new_computedname = self.ComputePouActionName(pou_name, new_name)

   483

        if old_computedname in self.ElementsOpened:

   484

            idx = self.ElementsOpened.index(old_computedname)

   485

            self.ElementsOpened[idx] = new_computedname

   486

   487

    # Change the name of a pou action

   488

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

   489

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

   490

        pou = self.Project.getPou(pou_name)

   491

        for type, varlist in pou.getVars():

   492

            for var in varlist.getVariable():

   493

                if var.getName() == old_name:

   494

                    var.setName(new_name)

   495

        self.RefreshBlockTypes()

   496

   497

    # Change the name of a configuration

   498

    def ChangeConfigurationName(self, old_name, new_name):

   499

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

   500

        configuration = self.Project.getConfiguration(old_name)

   501

        configuration.setName(new_name)

   502

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

   503

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

   504

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

   505

   506

    # Change the name of a configuration resource

   507

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

   508

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

   509

        resource = self.Project.getConfigurationResource(config_name)

   510

        resource.setName(new_name)

   511

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

   512

        old_computedname = self.ComputeConfigurationResourceName(config_name, old_name)

   513

        new_computedname = self.ComputeConfigurationResourceName(config_name, new_name)

   514

        if old_computedname in self.ElementsOpened:

   515

            idx = self.ElementsOpened.index(old_computedname)

   516

            self.ElementsOpened[idx] = new_computedname

   517

   518

    # Return the type of the pou given by its name

   519

    def GetPouType(self, name):

   520

        # Found the pou correponding to name and return its type

   521

        pou = self.Project.getPou(name)

   522

        return pou.pouType.getValue()

   523

   524