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

#

     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

    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.Buffering = False

   166

        self.FilePath = ""

   167

        self.FileName = ""

   168

        self.ProgramFilePath = ""

   169

        self.ElementsOpened = []

   170

        self.CurrentElementEditing = None

   171

        self.RefreshPouUsingTree()

   172

        self.RefreshBlockTypes()

   173

   174

    def GetQualifierTypes(self):

   175

        return plcopen.QualifierList

   176

   177

   178

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

   179

#                         Project management functions

   180

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

   181

   182

    # Return if a project is opened

   183

    def HasOpenedProject(self):

   184

        return self.Project != None

   185

   186

    # Create a new project by replacing the current one

   187

    def CreateNewProject(self, name):

   188

        # Create the project

   189

        self.Project = plcopen.project()

   190

        self.Project.setName(name)

   191

        self.SetFilePath("")

   192

        # Initialize the project buffer

   193

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

   194

        self.Buffering = False

   195

   196

    # Return project pou names

   197

    def GetProjectPouNames(self):

   198

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

   199

   200

    # Return project pou names

   201

    def GetProjectConfigNames(self):

   202

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

   203

   204

    # Return project pou variables

   205

    def GetProjectPouVariables(self, pou_name=None):

   206

        variables = []

   207

        for pou in self.Project.getPous():

   208

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

   209

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

   210

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

   211

                    for transition in pou.getTransitionList():

   212

                        variables.append(transition.getName())

   213

                    for action in pou.getActionList():

   214

                        variables.append(action.getName())

   215

        return variables

   216

   217

    # Return if project is saved

   218

    def ProjectIsSaved(self):

   219

        return self.ProjectBuffer.IsCurrentSaved()

   220

   221

    # Return file path if project is an open file

   222

    def GetFilePath(self):

   223

        return self.FilePath

   224

   225

    # Return file path if project is an open file

   226

    def GetProgramFilePath(self):

   227

        return self.ProgramFilePath

   228

   229

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

   230

    def GetFilename(self):

   231

        if self.ProjectBuffer.IsCurrentSaved():

   232

            return self.FileName

   233

        else:

   234

            return "~%s~"%self.FileName

   235

   236

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

   237

    def SetFilePath(self, filepath):

   238

        self.FilePath = filepath

   239

        if filepath == "":

   240

            self.LastNewIndex += 1

   241

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

   242

        else:

   243

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

   244

   245

    # Change project properties

   246

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

   247

        if name != None:

   248

            self.Project.setName(name)

   249

        if properties != None:

   250

            self.Project.setFileHeader(properties)

   251

        if name != None or properties != None:

   252

            self.BufferProject()

   253

   254

    # Return project properties

   255

    def GetProjectProperties(self):

   256

        properties = self.Project.getFileHeader()

   257

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

   258

        return properties

   259

   260

    # Return project informations

   261

    def GetProjectInfos(self):

   262

        if self.Project:

   263

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

   264

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

   265

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

   266

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

   267

            for pou in self.Project.getPous():

   268

                pou_type = pou.getPouType().getValue()

   269

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

   270

                pou_values = []

   271

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

   272

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

   273

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

   274

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

   275

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

   276

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

   277

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

   278

##                for var in self.GetPouInterfaceVars(pou):

   279

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

   280

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

   281

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

   282

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

   283

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

   284

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

   285

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

   286

##                if pou_type == "program":

   287

##                    pou_values.append(var_types["Global"])

   288

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

   289

                    transitions = []

   290

                    for transition in pou.getTransitionList():

   291

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

   292

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

   293

                    actions = []

   294

                    for action in pou.getActionList():

   295

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

   296

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

   297

                if pou_type in pou_types:

   298

                    pou_infos["values"] = pou_values

   299

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

   300

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

   301

            for config in self.Project.getConfigurations():

   302

                config_name = config.getName()

   303

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

   304

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

   305

##                for var in self.GetConfigurationGlobalVars(config_name):

   306

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

   307

##                    config_vars["values"].append(var_values)

   308

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

   309

                for resource in config.getResource():

   310

                    resource_name = resource.getName()

   311

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

   312

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

   313

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

   314

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

   315

##                        resource_vars["values"].append(var_values)

   316

##                    resource_infos["values"].append(resource_vars)

   317

                    resources["values"].append(resource_infos)

   318

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

   319

                config_infos["values"] = [resources]

   320

                configurations["values"].append(config_infos)

   321

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

   322

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

   323

                               pou_types["program"], configurations]

   324

            return infos

   325

        return None

   326

   327

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

   328

    def RefreshPouUsingTree(self):

   329

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

   330

        self.PouUsingTree = {}

   331

        if self.Project:

   332

            pous = self.Project.getPous()

   333

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

   334

            # user-defined pou cross-use

   335

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

   336

            for name in pounames:

   337

                self.PouUsingTree[name] = []

   338

            # Analyze each pou 

   339

            for pou in pous:

   340

                name = pou.getName()

   341

                bodytype = pou.getBodyType()

   342

                # If pou is written in a graphical language

   343

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

   344

                    # Analyze each instance of the pou

   345

                    for instance in pou.getInstances():

   346

                        if isinstance(instance, plcopen.block):

   347

                            typename = instance.getTypeName()

   348

                            # Update tree if there is a cross-use

   349

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

   350

                                 self.PouUsingTree[typename].append(name)

   351

                # If pou is written in a textual language

   352

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

   353

                    text = pou.getText()

   354

                    # Search if each pou is mentioned in the pou text

   355

                    for typename in pounames:

   356

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

   357

                        # Update tree if there is a cross-use

   358

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

   359

                            self.PouUsingTree[typename].append(name)

   360

   361

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

   362

    def PouIsUsed(self, name):

   363

        if name in self.PouUsingTree:

   364

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

   365

        return False

   366

   367

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

   368

    def PouIsUsedBy(self, name, reference):

   369

        if name in self.PouUsingTree:

   370

            list = self.PouUsingTree[name]

   371

            # Test if pou is directly used by reference

   372

            if reference in list:

   373

                return True

   374

            else:

   375

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

   376

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

   377

                used = False

   378

                for element in list:

   379

                    used |= self.PouIsUsedBy(element, reference)

   380

                return used

   381

        return False

   382

   383

    def GenerateProgram(self, filepath):

   384

        if self.Project:

   385

            try:

   386

                program = GenerateCurrentProgram(self.Project)

   387

                programfile = open(filepath, "w")

   388

                programfile.write(program)

   389

                programfile.close()

   390

                self.ProgramFilePath = filepath

   391

                return True

   392

            except:

   393

                pass

   394

        return False

   395

   396

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

   397

#                        Project Pous management functions

   398

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

   399

   400

    # Add a Pou to Project

   401

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

   402

        # Add the pou to project

   403

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

   404

        self.RefreshPouUsingTree()

   405

        self.RefreshBlockTypes()

   406

        self.BufferProject()

   407

   408

    # Remove a pou from project

   409

    def ProjectRemovePou(self, name):

   410

        removed = None

   411

        # Search if the pou removed is currently opened

   412

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

   413

            if pou == name:

   414

                removed = i

   415

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

   416

        if removed != None:

   417

            self.ElementsOpened.pop(removed)

   418

            if self.CurrentElementEditing > removed:

   419

                self.CurrentElementEditing -= 1

   420

            if len(self.ElementsOpened) > 0:

   421

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

   422

            else:

   423

                self.CurrentElementEditing = None

   424

        # Remove pou from project

   425

        self.Project.removePou(name)

   426

        self.RefreshPouUsingTree()

   427

        self.RefreshBlockTypes()

   428

        self.BufferProject()

   429

   430

    # Add a configuration to Project

   431

    def ProjectAddConfiguration(self, name):

   432

        self.Project.addConfiguration(name)

   433

        self.RefreshPouUsingTree()

   434

        self.RefreshBlockTypes()

   435

        self.BufferProject()

   436

   437

    # Remove a configuration from project

   438

    def ProjectRemoveConfiguration(self, name):

   439

        self.Project.removeConfiguration(name)

   440

        self.RefreshPouUsingTree()

   441

        self.RefreshBlockTypes()

   442

        self.BufferProject()

   443

   444

    # Add a resource to a configuration of the Project

   445

    def ProjectAddConfigurationResource(self, config, name):

   446

        self.Project.addConfigurationResource(config, name)

   447

        self.RefreshPouUsingTree()

   448

        self.RefreshBlockTypes()

   449

        self.BufferProject()

   450

   451

    # Remove a resource from a configuration of the project

   452

    def ProjectRemoveConfigurationResource(self, config, name):

   453

        self.Project.removeConfigurationResource(config, name)

   454

        self.RefreshPouUsingTree()

   455

        self.RefreshBlockTypes()

   456

        self.BufferProject()

   457

   458

    # Add a Transition to a Project Pou

   459

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

   460

        pou = self.Project.getPou(pou_name)

   461

        pou.addTransition(transition_name, transition_type)

   462

        self.BufferProject()

   463

   464

    # Add a Transition to a Project Pou

   465

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

   466

        pou = self.Project.getPou(pou_name)

   467

        pou.addAction(action_name, action_type)

   468

        self.BufferProject()

   469

   470

    # Change the name of a pou

   471

    def ChangePouName(self, old_name, new_name):

   472

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

   473

        pou = self.Project.getPou(old_name)

   474

        pou.setName(new_name)

   475

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

   476

        if old_name in self.ElementsOpened:

   477

            idx = self.ElementsOpened.index(old_name)

   478

            self.ElementsOpened[idx] = new_name

   480

        self.RefreshPouUsingTree()

   481

        self.RefreshBlockTypes()

   482

        self.BufferProject()

   483

   484

    # Change the name of a pou transition

   485

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

   486

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

   487

        pou = self.Project.getPou(pou_name)

   488

        transition = pou.getTransition(old_name)

   489

        transition.setName(new_name)

   490

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

   491

        old_computedname = self.ComputePouTransitionName(pou_name, old_name)

   492

        new_computedname = self.ComputePouTransitionName(pou_name, new_name)

   493

        if old_computedname in self.ElementsOpened:

   494

            idx = self.ElementsOpened.index(old_computedname)

   495

            self.ElementsOpened[idx] = new_computedname

   496

        self.BufferProject()

   497

   498

    # Change the name of a pou action

   499

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

   500

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

   501

        pou = self.Project.getPou(pou_name)

   502

        action = pou.getAction(old_name)

   503

        action.setName(new_name)

   504

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

   505

        old_computedname = self.ComputePouActionName(pou_name, old_name)

   506

        new_computedname = self.ComputePouActionName(pou_name, new_name)

   507

        if old_computedname in self.ElementsOpened:

   508

            idx = self.ElementsOpened.index(old_computedname)

   509

            self.ElementsOpened[idx] = new_computedname

   510

        self.BufferProject()

   511

   512

    # Change the name of a pou action

   513

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

   514

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

   515

        pou = self.Project.getPou(pou_name)

   516

        for type, varlist in pou.getVars():