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

import cPickle

    27

import os,sys,re

    28

    29

from plcopen import plcopen

    30

from plcopen.structures import *

    31

from graphics.GraphicCommons import *

    32

from PLCGenerator import *

    33

    34

[ITEM_UNEDITABLE, ITEM_PROJECT, ITEM_POU, ITEM_CLASS, ITEM_VARIABLE,

    35

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

    36

    37

"""

    38

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

    39

reports. This class is used for not displaying them

    40

"""

    41

class HolePseudoFile:

    42

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

    43

    def __init__(self, output = None):

    44

        if output is None: output = []

    45

        self.output = output

    46

    47

    def writelines(self, l):

    48

        map(self.write, l)

    49

    50

    def write(self, s):

    51

        pass

    52

    53

    def flush(self):

    54

        pass

    55

    56

    def isatty(self):

    57

        return false

    58

    59

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

    60

#                         Undo Buffer for PLCOpenEditor

    61

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

    62

    63

# Length of the buffer

    64

UNDO_BUFFER_LENGTH = 20

    65

    66

"""

    67

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

    68

"""

    69

class UndoBuffer:

    70

    71

    # Constructor initialising buffer

    72

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

    73

        self.Buffer = []

    74

        self.CurrentIndex = -1

    75

        self.MinIndex = -1

    76

        self.MaxIndex = -1

    77

        # if current state is defined

    78

        if currentstate:

    79

            self.CurrentIndex = 0

    80

            self.MinIndex = 0

    81

            self.MaxIndex = 0

    82

        # Initialising buffer with currentstate at the first place

    83

        for i in xrange(UNDO_BUFFER_LENGTH):

    84

            if i == 0:

    85

                self.Buffer.append(currentstate)

    86

            else:

    87

                self.Buffer.append(None)

    88

        # Initialising index of state saved

    89

        if issaved:

    90

            self.LastSave = 0

    91

        else:

    92

            self.LastSave = -1

    93

    94

    # Add a new state in buffer

    95

    def Buffering(self, currentstate):

    96

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

    97

        self.Buffer[self.CurrentIndex] = currentstate

    98

        # Actualising buffer limits

    99

        self.MaxIndex = self.CurrentIndex

   100

        if self.MinIndex == self.CurrentIndex:

   101

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

   102

            if self.LastSave == self.MinIndex:

   103

                self.LastSave = -1

   104

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

   105

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

   106

   107

    # Return current state of buffer

   108

    def Current(self):

   109

        return self.Buffer[self.CurrentIndex]

   110

   111

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

   112

    def Previous(self):

   113

        if self.CurrentIndex != self.MinIndex:

   114

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

   115

            return self.Buffer[self.CurrentIndex]

   116

        return None

   117

   118

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

   119

    def Next(self):

   120

        if self.CurrentIndex != self.MaxIndex:

   121

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

   122

            return self.Buffer[self.CurrentIndex]

   123

        return None

   124

   125

    # Return True if current state is the first in buffer

   126

    def IsFirst(self):

   127

        return self.CurrentIndex == self.MinIndex

   128

   129

    # Return True if current state is the last in buffer

   130

    def IsLast(self):

   131

        return self.CurrentIndex == self.MaxIndex

   132

   133

    # Note that current state is saved

   134

    def CurrentSaved(self):

   135

        self.LastSave = self.CurrentIndex

   136

   137

    # Return True if current state is saved

   138

    def IsCurrentSaved(self):

   139

        return self.LastSave == self.CurrentIndex

   140

   141

   142

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

   143

#                           Controler for PLCOpenEditor

   144

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

   145

   146

"""

   147

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

   148

"""

   149

class PLCControler:

   150

   151

    # Create a new PLCControler

   152

    def __init__(self):

   153

        self.LastNewIndex = 0

   154

        self.Reset()

   155

   156

    # Reset PLCControler internal variables

   157

    def Reset(self):

   158

        self.Project = None

   159

        self.ProjectBuffer = None

   160

        self.FilePath = ""

   161

        self.FileName = ""

   162

        self.ElementsOpened = []

   163

        self.CurrentElementEditing = None

   164

        self.RefreshPouUsingTree()

   165

        self.RefreshBlockTypes()

   166

   167

    def GetQualifierTypes(self):

   168

        return plcopen.QualifierList

   169

   170

   171

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

   172

#                         Project management functions

   173

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

   174

   175

    # Return if a project is opened

   176

    def HasOpenedProject(self):

   177

        return self.Project != None

   178

   179

    # Create a new project by replacing the current one

   180

    def CreateNewProject(self, name):

   181

        # Create the project

   182

        self.Project = plcopen.project()

   183

        self.Project.setName(name)

   184

        # Initialize the project buffer

   185

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

   186

   187

    # Change project name

   188

    def SetProjectName(self, name):

   189

        self.Project.setName(name)

   190

   191

    # Return project name

   192

    def GetProjectName(self):

   193

        return self.Project.getName()

   194

   195

    # Return project pou names

   196

    def GetProjectPouNames(self):

   197

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

   198

   199

    # Return project pou names

   200

    def GetProjectConfigNames(self):

   201

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

   202

   203

    # Return project pou variables

   204

    def GetProjectPouVariables(self, pou_name=None):

   205

        variables = []

   206

        for pou in self.Project.getPous():

   207

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

   208

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

   209

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

   210

                    for transition in pou.getTransitionList():

   211

                        variables.append(transition.getName())

   212

                    for action in pou.getActionList():

   213

                        variables.append(action.getName())

   214

        return variables

   215

   216

    # Return file path if project is an open file

   217

    def GetFilePath(self):

   218

        return self.FilePath

   219

   220

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

   221

    def GetFilename(self):

   222

        if self.ProjectBuffer.IsCurrentSaved():

   223

            return self.FileName

   224

        else:

   225

            return "~%s~"%self.FileName

   226

   227

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

   228

    def SetFilePath(self, filepath):

   229

        self.FilePath = filepath

   230

        if filepath == "":

   231

            self.LastNewIndex += 1

   232

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

   233

        else:

   234

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

   235

   236

    # Change project properties

   237

    def SetProjectProperties(self, values):

   238

        self.Project.setFileHeader(values)

   239

   240

    # Return project properties

   241

    def GetProjectProperties(self):

   242

        return self.Project.getFileHeader()

   243

   244

    # Return project informations

   245

    def GetProjectInfos(self):

   246

        if self.Project:

   247

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

   248

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

   249

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

   250

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

   251

            for pou in self.Project.getPous():

   252

                pou_type = pou.getPouType().getValue()

   253

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

   254

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

   255

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

   256

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

   257

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

   258

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

   259

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

   260

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

   261

                for var in self.GetPouInterfaceVars(pou):

   262

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

   263

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

   264

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

   265

                pou_values = []

   266

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

   267

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

   268

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

   269

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

   270

                if pou_type == "program":

   271

                    pou_values.append(var_types["Global"])

   272

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

   273

                    transitions = []

   274

                    for transition in pou.getTransitionList():

   275

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

   276

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

   277

                    actions = []

   278

                    for action in pou.getActionList():

   279

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

   280

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

   281

                if pou_type in pou_types:

   282

                    pou_infos["values"] = pou_values

   283

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

   284

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

   285

            for config in self.Project.getConfigurations():

   286

                config_name = config.getName()

   287

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

   288

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

   289

                for var in self.GetConfigurationGlobalVars(config_name):

   290

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

   291

                    config_vars["values"].append(var_values)

   292

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

   293

                for resource in config.getResource():

   294

                    resource_name = resource.getName()

   295

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

   296

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

   297

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

   298

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

   299

                        resource_vars["values"].append(var_values)

   300

                    resource_infos["values"].append(resource_vars)

   301

                    resources["values"].append(resource_infos)

   302

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

   303

                configurations["values"].append(config_infos)

   304

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

   305

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

   306

                               pou_types["program"], configurations]

   307

            return infos

   308

        return None

   309

   310

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

   311

    def RefreshPouUsingTree(self):

   312

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

   313

        self.PouUsingTree = {}

   314

        if self.Project:

   315

            pous = self.Project.getPous()

   316

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

   317

            # user-defined pou cross-use

   318

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

   319

            for name in pounames:

   320

                self.PouUsingTree[name] = []

   321

            # Analyze each pou 

   322

            for pou in pous:

   323

                name = pou.getName()

   324

                bodytype = pou.getBodyType()

   325

                # If pou is written in a graphical language

   326

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

   327

                    # Analyze each instance of the pou

   328

                    for instance in pou.getInstances():

   329

                        if isinstance(instance, plcopen.block):

   330

                            typename = instance.getTypeName()

   331

                            # Update tree if there is a cross-use

   332

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

   333

                                 self.PouUsingTree[typename].append(name)

   334

                # If pou is written in a textual language

   335

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

   336

                    text = pou.getText()

   337

                    # Search if each pou is mentioned in the pou text

   338

                    for typename in pounames:

   339

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

   340

                        # Update tree if there is a cross-use

   341

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

   342

                            self.PouUsingTree[typename].append(name)

   343

   344

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

   345

    def PouIsUsed(self, name):

   346

        if name in self.PouUsingTree:

   347

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

   348

        return False

   349

   350

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

   351

    def PouIsUsedBy(self, name, reference):

   352

        if name in self.PouUsingTree:

   353

            list = self.PouUsingTree[name]

   354

            # Test if pou is directly used by reference

   355

            if reference in list:

   356

                return True

   357

            else:

   358

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

   359

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

   360

                used = False

   361

                for element in list:

   362

                    used |= self.PouIsUsedBy(element, reference)

   363

                return used

   364

        return False

   365

   366

    def GenerateProgram(self, filepath):

   367

        if self.Project:

   368

            try:

   369

                program = GenerateCurrentProgram(self.Project)

   370

                programfile = open(filepath, "w")

   371

                programfile.write(program)

   372

                programfile.close()

   373

                return True

   374

            except:

   375

                pass

   376

        return False

   377

   378

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

   379

#                        Project Pous management functions

   380

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

   381

   382

    # Add a Pou to Project

   383

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

   384

        # Add the pou to project

   385

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

   386

        self.RefreshPouUsingTree()

   387

        self.RefreshBlockTypes()

   388

   389

    # Remove a pou from project

   390

    def ProjectRemovePou(self, name):

   391

        removed = None

   392

        # Search if the pou removed is currently opened

   393

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

   394

            if pou == name:

   395

                removed = i

   396

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

   397

        if removed != None:

   398

            self.ElementsOpened.pop(removed)

   399

            if self.CurrentElementEditing > removed:

   400

                self.CurrentElementEditing -= 1

   401

            if len(self.ElementsOpened) > 0:

   402

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

   403

            else:

   404

                self.CurrentElementEditing = None

   405

        # Remove pou from project

   406

        self.Project.removePou(name)

   407

        self.RefreshPouUsingTree()

   408

        self.RefreshBlockTypes()

   409

   410

    # Add a configuration to Project

   411

    def ProjectAddConfiguration(self, name):

   412

        self.Project.addConfiguration(name)

   413

        self.RefreshPouUsingTree()

   414

        self.RefreshBlockTypes()

   415

   416

    # Remove a configuration from project

   417

    def ProjectRemoveConfiguration(self, name):

   418

        self.Project.removeConfiguration(name)

   419

        self.RefreshPouUsingTree()

   420

        self.RefreshBlockTypes()

   421

   422

    # Add a resource to a configuration of the Project

   423

    def ProjectAddConfigurationResource(self, config, name):

   424

        self.Project.addConfigurationResource(config, name)

   425

        self.RefreshPouUsingTree()

   426

        self.RefreshBlockTypes()

   427

   428

    # Remove a resource from a configuration of the project

   429

    def ProjectRemoveConfigurationResource(self, config, name):

   430

        self.Project.removeConfigurationResource(config, name)

   431

        self.RefreshPouUsingTree()

   432

        self.RefreshBlockTypes()

   433

   434

    # Add a Transition to a Project Pou

   435

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

   436

        pou = self.Project.getPou(pou_name)

   437

        pou.addTransition(transition_name, transition_type)

   438

   439

    # Add a Transition to a Project Pou

   440

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

   441

        pou = self.Project.getPou(pou_name)

   442

        pou.addAction(action_name, action_type)

   443

   444

    # Change the name of a pou

   445

    def ChangePouName(self, old_name, new_name):

   446

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

   447

        pou = self.Project.getPou(old_name)

   448

        pou.setName(new_name)

   449

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

   450

        if old_name in self.ElementsOpened:

   451

            idx = self.ElementsOpened.index(old_name)

   452

            self.ElementsOpened[idx] = new_name

   453

        self.RefreshPouUsingTree()

   454

        self.RefreshBlockTypes()

   455

   456

    # Change the name of a pou transition

   457

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

   458

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

   459

        pou = self.Project.getPou(pou_name)

   460

        transition = pou.getTransition(old_name)

   461

        transition.setName(new_name)

   462

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

   463

        old_computedname = self.ComputePouTransitionName(pou_name, old_name)

   464

        new_computedname = self.ComputePouTransitionName(pou_name, new_name)

   465

        if old_computedname in self.ElementsOpened:

   466

            idx = self.ElementsOpened.index(old_computedname)

   467

            self.ElementsOpened[idx] = new_computedname

   468

   469

    # Change the name of a pou action

   470

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

   471

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

   472

        pou = self.Project.getPou(pou_name)

   473

        action = pou.getAction(old_name)

   474

        action.setName(new_name)

   475

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

   476

        old_computedname = self.ComputePouActionName(pou_name, old_name)

   477

        new_computedname = self.ComputePouActionName(pou_name, new_name)

   478

        if old_computedname in self.ElementsOpened:

   479

            idx = self.ElementsOpened.index(old_computedname)

   480

            self.ElementsOpened[idx] = new_computedname

   481

   482

    # Change the name of a pou action

   483

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

   484

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

   485

        pou = self.Project.getPou(pou_name)

   486

        for type, varlist in pou.getVars():

   487

            for var in varlist.getVariable():

   488

                if var.getName() == old_name:

   489

                    var.setName(new_name)

   490

        self.RefreshBlockTypes()

   491

   492

    # Change the name of a configuration

   493

    def ChangeConfigurationName(self, old_name, new_name):

   494

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

   495

        configuration = self.Project.getConfiguration(old_name)

   496

        configuration.setName(new_name)

   497

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

   498

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

   499

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

   500

   501

    # Change the name of a configuration resource

   502

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

   503

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

   504

        resource = self.Project.getConfigurationResource(config_name)

   505

        resource.setName(new_name)

   506

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

   507

        old_computedname = self.ComputeConfigurationResourceName(config_name, old_name)

   508

        new_computedname = self.ComputeConfigurationResourceName(config_name, new_name)

   509

        if old_computedname in self.ElementsOpened:

   510

            idx = self.ElementsOpened.index(old_computedname)

   511

            self.ElementsOpened[idx] = new_computedname

   512

   513

    # Return the type of the pou given by its name

   514

    def GetPouType(self, name):

   515

        # Found the pou correponding to name and return its type

   516

        pou = self.Project.getPou(name)

   517

        return pou.pouType.getValue()

   518

   519

    # Return pous with SFC language

   520

    def GetSFCPous(self):

   521

        list = []

   522

        if self.Project:

   523

            for pou in self.Project.getPous():

   524

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

   525

                    list.append(pou.getName())