1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library is distributed in the hope that it will be useful,

    17

#but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

from minixsv import pyxsval

    26

from xml.dom import minidom

    27

from types import StringType, UnicodeType

    28

import cPickle

    29

import os,sys,re

    30

from datetime import *

    31

    32

from plcopen import plcopen

    33

from plcopen.structures import *

    34

from graphics.GraphicCommons import *

    35

from PLCGenerator import *

    36

    37

duration_model = re.compile("(?:([0-9]{1,2})h)?(?:([0-9]{1,2})m(?!s))?(?:([0-9]{1,2})s)?(?:([0-9]{1,3}(?:.[0-9]*)?)ms)?")

    38

    39

[ITEM_UNEDITABLE, ITEM_PROJECT, ITEM_POU, ITEM_CLASS, ITEM_VARIABLE,

    40

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

    41

    42

"""

    43

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

    44

reports. This class is used for not displaying them

    45

"""

    46

class HolePseudoFile:

    47

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

    48

    def __init__(self, output = None):

    49

        if output is None: output = []

    50

        self.output = output

    51

    52

    def writelines(self, l):

    53

        map(self.write, l)

    54

    55

    def write(self, s):

    56

        pass

    57

    58

    def flush(self):

    59

        pass

    60

    61

    def isatty(self):

    62

        return false

    63

    64

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

    65

#                         Undo Buffer for PLCOpenEditor

    66

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

    67

    68

# Length of the buffer

    69

UNDO_BUFFER_LENGTH = 20

    70

    71

"""

    72

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

    73

"""

    74

class UndoBuffer:

    75

    76

    # Constructor initialising buffer

    77

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

    78

        self.Buffer = []

    79

        self.CurrentIndex = -1

    80

        self.MinIndex = -1

    81

        self.MaxIndex = -1

    82

        # if current state is defined

    83

        if currentstate:

    84

            self.CurrentIndex = 0

    85

            self.MinIndex = 0

    86

            self.MaxIndex = 0

    87

        # Initialising buffer with currentstate at the first place

    88

        for i in xrange(UNDO_BUFFER_LENGTH):

    89

            if i == 0:

    90

                self.Buffer.append(currentstate)

    91

            else:

    92

                self.Buffer.append(None)

    93

        # Initialising index of state saved

    94

        if issaved:

    95

            self.LastSave = 0

    96

        else:

    97

            self.LastSave = -1

    98

    99

    # Add a new state in buffer

   100

    def Buffering(self, currentstate):

   101

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

   102

        self.Buffer[self.CurrentIndex] = currentstate

   103

        # Actualising buffer limits

   104

        self.MaxIndex = self.CurrentIndex

   105

        if self.MinIndex == self.CurrentIndex:

   106

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

   107

            if self.LastSave == self.MinIndex:

   108

                self.LastSave = -1

   109

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

   110

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

   111

   112

    # Return current state of buffer

   113

    def Current(self):

   114

        return self.Buffer[self.CurrentIndex]

   115

   116

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

   117

    def Previous(self):

   118

        if self.CurrentIndex != self.MinIndex:

   119

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

   120

            return self.Buffer[self.CurrentIndex]

   121

        return None

   122

   123

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

   124

    def Next(self):

   125

        if self.CurrentIndex != self.MaxIndex:

   126

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

   127

            return self.Buffer[self.CurrentIndex]

   128

        return None

   129

   130

    # Return True if current state is the first in buffer

   131

    def IsFirst(self):

   132

        return self.CurrentIndex == self.MinIndex

   133

   134

    # Return True if current state is the last in buffer

   135

    def IsLast(self):

   136

        return self.CurrentIndex == self.MaxIndex

   137

   138

    # Note that current state is saved

   139

    def CurrentSaved(self):

   140

        self.LastSave = self.CurrentIndex

   141

   142

    # Return True if current state is saved

   143

    def IsCurrentSaved(self):

   144

        return self.LastSave == self.CurrentIndex

   145

   146

   147

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

   148

#                           Controler for PLCOpenEditor

   149

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

   150

   151

"""

   152

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

   153

"""

   154

class PLCControler:

   155

   156

    # Create a new PLCControler

   157

    def __init__(self):

   158

        self.LastNewIndex = 0

   159

        self.Reset()

   160

   161

    # Reset PLCControler internal variables

   162

    def Reset(self):

   163

        self.VerifyXML = False

   164

        self.Project = None

   165

        self.ProjectBuffer = None

   166

        self.Buffering = False

   167

        self.FilePath = ""

   168

        self.FileName = ""

   169

        self.ProgramFilePath = ""

   170

        self.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

        self.SetFilePath("")

   191

        # Initialize the project buffer

   192

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

   193

        self.Buffering = False

   194

   195

    # Return project pou names

   196

    def GetProjectPouNames(self):

   197

        if self.Project:

   198

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

   199

        return []

   200

   201

    # Return project pou names

   202

    def GetProjectConfigNames(self):

   203

        if self.Project:

   204

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

   205

        return []

   206

   207

    # Return project pou variables

   208

    def GetProjectPouVariables(self, pou_name=None):

   209

        variables = []

   210

        for pou in self.Project.getPous():

   211

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

   212

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

   213

                for transition in pou.getTransitionList():

   214

                    variables.append(transition.getName())

   215

                for action in pou.getActionList():

   216

                    variables.append(action.getName())

   217

        return variables

   218

   219

    # Return if project is saved

   220

    def ProjectIsSaved(self):

   221

        return self.ProjectBuffer.IsCurrentSaved()

   222

   223

    # Return file path if project is an open file

   224

    def GetFilePath(self):

   225

        return self.FilePath

   226

   227

    # Return file path if project is an open file

   228

    def GetProgramFilePath(self):

   229

        return self.ProgramFilePath

   230

   231

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

   232

    def GetFilename(self):

   233

        if self.ProjectBuffer.IsCurrentSaved():

   234

            return self.FileName

   235

        else:

   236

            return "~%s~"%self.FileName

   237

   238

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

   239

    def SetFilePath(self, filepath):

   240

        self.FilePath = filepath

   241

        if filepath == "":

   242

            self.LastNewIndex += 1

   243

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

   244

        else:

   245

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

   246

   247

    # Change project properties

   248

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

   249

        if name != None:

   250

            self.Project.setName(name)

   251

        if properties != None:

   252

            self.Project.setFileHeader(properties)

   253

        if name != None or properties != None:

   254

            self.BufferProject()

   255

   256

    # Return project properties

   257

    def GetProjectProperties(self):

   258

        properties = self.Project.getFileHeader()

   259

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

   260

        return properties

   261

   262

    # Return project informations

   263

    def GetProjectInfos(self):

   264

        if self.Project:

   265

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

   266

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

   267

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

   268

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

   269

            for pou in self.Project.getPous():

   270

                pou_type = pou.getPouType().getValue()

   271

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

   272

                pou_values = []

   273

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

   274

                    transitions = []

   275

                    for transition in pou.getTransitionList():

   276

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

   277

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

   278

                    actions = []

   279

                    for action in pou.getActionList():

   280

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

   281

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

   282

                if pou_type in pou_types:

   283

                    pou_infos["values"] = pou_values

   284

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

   285

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

   286

            for config in self.Project.getConfigurations():

   287

                config_name = config.getName()

   288

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

   289

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

   290

                for resource in config.getResource():

   291

                    resource_name = resource.getName()

   292

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

   293

                    resources["values"].append(resource_infos)

   294

                config_infos["values"] = [resources]

   295

                configurations["values"].append(config_infos)

   296

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

   297

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

   298

                               pou_types["program"], configurations]

   299

            return infos

   300

        return None

   301

   302

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

   303

    def RefreshPouUsingTree(self):

   304

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

   305

        self.PouUsingTree = {}

   306

        if self.Project:

   307

            pous = self.Project.getPous()

   308

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

   309

            # user-defined pou cross-use

   310

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

   311

            for name in pounames:

   312

                self.PouUsingTree[name] = []

   313

            # Analyze each pou 

   314

            for pou in pous:

   315

                name = pou.getName()

   316

                if pou.interface:

   317

                    # Extract variables from every varLists

   318

                    for type, varlist in pou.getVars():

   319

                        for var in varlist.getVariable():

   320

                            var_type = var.getType().getValue()

   321

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

   322

                                typename = var_type.getName()

   323

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

   324

                                    self.PouUsingTree[typename].append(name)

   325

                bodytype = pou.getBodyType()

   326

                # If pou is written in a graphical language

   327

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

   328

                    # Analyze each instance of the pou

   329

                    for instance in pou.getInstances():

   330

                        if isinstance(instance, plcopen.block):

   331

                            typename = instance.getTypeName()

   332

                            # Update tree if there is a cross-use

   333

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

   334

                                 self.PouUsingTree[typename].append(name)

   335

                # If pou is written in a textual language

   336

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

   337

                    text = pou.getText()

   338

                    # Search if each pou is mentioned in the pou text

   339

                    for typename in pounames:

   340

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

   341

                        # Update tree if there is a cross-use

   342

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

   343

                            self.PouUsingTree[typename].append(name)

   344

   345

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

   346

    def PouIsUsed(self, name):

   347

        if name in self.PouUsingTree:

   348

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

   349

        return False

   350

   351

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

   352

    def PouIsUsedBy(self, name, reference):

   353

        if name in self.PouUsingTree:

   354

            list = self.PouUsingTree[name]

   355

            # Test if pou is directly used by reference

   356

            if reference in list:

   357

                return True

   358

            else:

   359

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

   360

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

   361

                used = False

   362

                for element in list:

   363

                    used |= self.PouIsUsedBy(element, reference)

   364

                return used

   365

        return False

   366

   367

    def GenerateProgram(self, filepath):

   368

        if self.Project:

   369

            try:

   370

                program = GenerateCurrentProgram(self.Project)

   371

                programfile = open(filepath, "w")

   372

                programfile.write(program)

   373

                programfile.close()

   374

                self.ProgramFilePath = filepath

   375

                return True

   376

            except:

   377

                pass

   378

        return False

   379

   380

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

   381

#                        Project Pous management functions

   382

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

   383

   384

    # Add a Pou to Project

   385

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

   386

        # Add the pou to project

   387

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

   388

        if pou_type == "function":

   389

            self.SetPouInterfaceReturnType(pou_name, "BOOL")

   390

        self.RefreshPouUsingTree()

   391

        self.RefreshBlockTypes()

   392

        self.BufferProject()

   393

   394

    # Remove a pou from project

   395

    def ProjectRemovePou(self, pou_name):

   396

        self.Project.removePou(pou_name)

   397

        self.RefreshPouUsingTree()

   398

        self.RefreshBlockTypes()

   399

        self.BufferProject()

   400

   401

    # Add a configuration to Project

   402

    def ProjectAddConfiguration(self, config_name):

   403

        self.Project.addConfiguration(config_name)

   404

        self.RefreshPouUsingTree()

   405

        self.RefreshBlockTypes()

   406

        self.BufferProject()

   407

   408

    # Remove a configuration from project

   409

    def ProjectRemoveConfiguration(self, config_name):

   410

        self.Project.removeConfiguration(config_name)

   411

        self.BufferProject()

   412

   413

    # Add a resource to a configuration of the Project

   414

    def ProjectAddConfigurationResource(self, config_name, resource_name):

   415

        self.Project.addConfigurationResource(config_name, resource_name)

   416

        self.RefreshPouUsingTree()

   417

        self.RefreshBlockTypes()

   418

        self.BufferProject()

   419

   420

    # Remove a resource from a configuration of the project

   421

    def ProjectRemoveConfigurationResource(self, config_name, resource_name):

   422

        self.Project.removeConfigurationResource(config_name, resource_name)

   423

        self.BufferProject()

   424

   425

    # Add a Transition to a Project Pou

   426

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

   427

        pou = self.Project.getPou(pou_name)

   428

        pou.addTransition(transition_name, transition_type)

   429

        self.BufferProject()

   430

   431

    # Remove a Transition from a Project Pou

   432

    def ProjectRemovePouTransition(self, pou_name, transition_name):

   433

        pou = self.Project.getPou(pou_name)

   434

        pou.removeTransition(transition_name)

   435

        self.BufferProject()

   436

   437

    # Add an Action to a Project Pou

   438

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

   439

        pou = self.Project.getPou(pou_name)

   440

        pou.addAction(action_name, action_type)

   441

        self.BufferProject()

   442

   443

    # Remove an Action from a Project Pou

   444

    def ProjectRemovePouAction(self, pou_name, action_name):

   445

        # Search if the pou removed is currently opened

   446

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

   447

            words = element.split("::")

   448

            if words[0] == "A" and words[1] == pou_name and words[2] == action_name:

   449

                self.RemoveElementEditing(i)

   450

        pou = self.Project.getPou(pou_name)

   451

        pou.removeAction(action_name)

   452

        self.BufferProject()

   453

   454

    # Change the name of a pou

   455

    def ChangePouName(self, old_name, new_name):

   456

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

   457

        pou = self.Project.getPou(old_name)

   458

        pou.setName(new_name)

   459

        self.Project.updateElementName(old_name, new_name)

   460

        self.RefreshPouUsingTree()

   461

        self.RefreshBlockTypes()

   462

        self.BufferProject()

   463

   464

    # Change the name of a pou transition

   465

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

   466

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

   467

        pou = self.Project.getPou(pou_name)

   468

        transition = pou.getTransition(old_name)

   469

        transition.setName(new_name)

   470

        pou.updateElementName(old_name, new_name)

   471

        self.BufferProject()

   472

   473

    # Change the name of a pou action

   474

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

   475

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

   476

        pou = self.Project.getPou(pou_name)

   477

        action = pou.getAction(old_name)

   478

        action.setName(new_name)

   479

        pou.updateElementName(old_name, new_name)

   480

        self.BufferProject()

   481

   482

    # Change the name of a pou variable

   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

        self.BufferProject()

   492

   493

    # Change the name of a configuration

   494

    def ChangeConfigurationName(self, old_name, new_name):

   495

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

   496

        configuration = self.Project.getConfiguration(old_name)

   497

        configuration.setName(new_name)

   498

        self.BufferProject()

   499

   500

    # Change the name of a configuration resource

   501

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

   502

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

   503

        resource = self.Project.getConfigurationResource(config_name)

   504

        resource.setName(new_name)

   505

        self.BufferProject()

   506

   507

    # Return the type of the pou given by its name

   508

    def GetPouType(self, name):

   509

        # Found the pou correponding to name and return its type

   510

        pou = self.Project.getPou(name)

   511

        return pou.pouType.getValue()

   512