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, 

    41

 ITEM_DATATYPE] = range(10)

    42

    43

ScriptDirectory = os.path.split(os.path.realpath(__file__))[0]

    44

    45

"""

    46

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

    47

reports. This class is used for not displaying them

    48

"""

    49

class HolePseudoFile:

    50

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

    51

    def __init__(self, output = None):

    52

        if output is None: output = []

    53

        self.output = output

    54

    55

    def writelines(self, l):

    56

        map(self.write, l)

    57

    58

    def write(self, s):

    59

        pass

    60

    61

    def flush(self):

    62

        pass

    63

    64

    def isatty(self):

    65

        return false

    66

    67

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

    68

#                         Undo Buffer for PLCOpenEditor

    69

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

    70

    71

# Length of the buffer

    72

UNDO_BUFFER_LENGTH = 20

    73

    74

"""

    75

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

    76

"""

    77

class UndoBuffer:

    78

    79

    # Constructor initialising buffer

    80

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

    81

        self.Buffer = []

    82

        self.CurrentIndex = -1

    83

        self.MinIndex = -1

    84

        self.MaxIndex = -1

    85

        # if current state is defined

    86

        if currentstate:

    87

            self.CurrentIndex = 0

    88

            self.MinIndex = 0

    89

            self.MaxIndex = 0

    90

        # Initialising buffer with currentstate at the first place

    91

        for i in xrange(UNDO_BUFFER_LENGTH):

    92

            if i == 0:

    93

                self.Buffer.append(currentstate)

    94

            else:

    95

                self.Buffer.append(None)

    96

        # Initialising index of state saved

    97

        if issaved:

    98

            self.LastSave = 0

    99

        else:

   100

            self.LastSave = -1

   101

   102

    # Add a new state in buffer

   103

    def Buffering(self, currentstate):

   104

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

   105

        self.Buffer[self.CurrentIndex] = currentstate

   106

        # Actualising buffer limits

   107

        self.MaxIndex = self.CurrentIndex

   108

        if self.MinIndex == self.CurrentIndex:

   109

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

   110

            if self.LastSave == self.MinIndex:

   111

                self.LastSave = -1

   112

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

   113

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

   114

   115

    # Return current state of buffer

   116

    def Current(self):

   117

        return self.Buffer[self.CurrentIndex]

   118

   119

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

   120

    def Previous(self):

   121

        if self.CurrentIndex != self.MinIndex:

   122

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

   123

            return self.Buffer[self.CurrentIndex]

   124

        return None

   125

   126

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

   127

    def Next(self):

   128

        if self.CurrentIndex != self.MaxIndex:

   129

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

   130

            return self.Buffer[self.CurrentIndex]

   131

        return None

   132

   133

    # Return True if current state is the first in buffer

   134

    def IsFirst(self):

   135

        return self.CurrentIndex == self.MinIndex

   136

   137

    # Return True if current state is the last in buffer

   138

    def IsLast(self):

   139

        return self.CurrentIndex == self.MaxIndex

   140

   141

    # Note that current state is saved

   142

    def CurrentSaved(self):

   143

        self.LastSave = self.CurrentIndex

   144

   145

    # Return True if current state is saved

   146

    def IsCurrentSaved(self):

   147

        return self.LastSave == self.CurrentIndex

   148

   149

   150

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

   151

#                           Controler for PLCOpenEditor

   152

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

   153

   154

"""

   155

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

   156

"""

   157

class PLCControler:

   158

   159

    # Create a new PLCControler

   160

    def __init__(self):

   161

        self.LastNewIndex = 0

   162

        self.Reset()

   163

   164

    # Reset PLCControler internal variables

   165

    def Reset(self):

   166

        self.VerifyXML = False

   167

        self.Project = None

   168

        self.ProjectBuffer = None

   169

        self.Buffering = False

   170

        self.FilePath = ""

   171

        self.FileName = ""

   172

        self.ProgramFilePath = ""

   173

        self.RefreshDataTypeUsingTree()

   174

        self.RefreshDataTypes()

   175

        self.RefreshPouUsingTree()

   176

        self.RefreshBlockTypes()

   177

   178

    def GetQualifierTypes(self):

   179

        return plcopen.QualifierList

   180

   181

   182

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

   183

#                         Project management functions

   184

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

   185

   186

    # Return if a project is opened

   187

    def HasOpenedProject(self):

   188

        return self.Project != None

   189

   190

    # Create a new project by replacing the current one

   191

    def CreateNewProject(self, name):

   192

        # Create the project

   193

        self.Project = plcopen.project()

   194

        self.Project.setName(name)

   195

        self.SetFilePath("")

   196

        # Initialize the project buffer

   197

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

   198

        self.Buffering = False

   199

   200

    # Return project data type names

   201

    def GetProjectDataTypeNames(self):

   202

        if self.Project:

   203

            return [datatype.getName() for datatype in self.Project.getDataTypes()]

   204

        return []

   205

   206

    # Return project pou names

   207

    def GetProjectPouNames(self):

   208

        if self.Project:

   209

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

   210

        return []

   211

   212

    # Return project pou names

   213

    def GetProjectConfigNames(self):

   214

        if self.Project:

   215

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

   216

        return []

   217

   218

    # Return project pou variables

   219

    def GetProjectPouVariables(self, pou_name=None):

   220

        variables = []

   221

        for pou in self.Project.getPous():

   222

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

   223

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

   224

                for transition in pou.getTransitionList():

   225

                    variables.append(transition.getName())

   226

                for action in pou.getActionList():

   227

                    variables.append(action.getName())

   228

        return variables

   229

   230

    # Return if project is saved

   231

    def ProjectIsSaved(self):

   232

        return self.ProjectBuffer.IsCurrentSaved()

   233

   234

    # Return file path if project is an open file

   235

    def GetFilePath(self):

   236

        return self.FilePath

   237

   238

    # Return file path if project is an open file

   239

    def GetProgramFilePath(self):

   240

        return self.ProgramFilePath

   241

   242

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

   243

    def GetFilename(self):

   244

        if self.ProjectBuffer.IsCurrentSaved():

   245

            return self.FileName

   246

        else:

   247

            return "~%s~"%self.FileName

   248

   249

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

   250

    def SetFilePath(self, filepath):

   251

        self.FilePath = filepath

   252

        if filepath == "":

   253

            self.LastNewIndex += 1

   254

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

   255

        else:

   256

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

   257

   258

    # Change project properties

   259

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

   260

        if name != None:

   261

            self.Project.setName(name)

   262

        if properties != None:

   263

            self.Project.setFileHeader(properties)

   264

        if name != None or properties != None:

   265

            self.BufferProject()

   266

   267

    # Return project properties

   268

    def GetProjectProperties(self):

   269

        properties = self.Project.getFileHeader()

   270

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

   271

        return properties

   272

   273

    # Return project informations

   274

    def GetProjectInfos(self):

   275

        if self.Project:

   276

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

   277

            datatypes = {"name": "Data Types", "type": ITEM_UNEDITABLE, "values":[]}

   278

            for datatype in self.Project.getDataTypes():

   279

                datatypes["values"].append({"name": datatype.getName(), "type": ITEM_DATATYPE, "values": []})

   280

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

   281

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

   282

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

   283

            for pou in self.Project.getPous():

   284

                pou_type = pou.getPouType().getValue()

   285

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

   286

                pou_values = []

   287

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

   288

                    transitions = []

   289

                    for transition in pou.getTransitionList():

   290

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

   291

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

   292

                    actions = []

   293

                    for action in pou.getActionList():

   294

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

   295

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

   296

                if pou_type in pou_types:

   297

                    pou_infos["values"] = pou_values

   298

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

   299

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

   300

            for config in self.Project.getConfigurations():

   301

                config_name = config.getName()

   302

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

   303

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

   304

                for resource in config.getResource():

   305

                    resource_name = resource.getName()

   306

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

   307

                    resources["values"].append(resource_infos)

   308

                config_infos["values"] = [resources]

   309

                configurations["values"].append(config_infos)

   310

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

   311

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

   312

                               pou_types["program"], configurations]

   313

            return infos

   314

        return None

   315

   316

    # Refresh the tree of user-defined data type cross-use

   317

    def RefreshDataTypeUsingTree(self):

   318

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

   319

        self.DataTypeUsingTree = {}

   320

        if self.Project:

   321

            datatypes = self.Project.getDataTypes()

   322

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

   323

            # user-defined data type cross-use

   324

            datatypenames = [datatype.getName() for datatype in datatypes]

   325

            for name in datatypenames:

   326

                self.DataTypeUsingTree[name] = []

   327

            # Analyze each data type

   328

            for datatype in datatypes:

   329

                name = datatype.getName()

   330

                basetype_content = datatype.getBaseType().getContent()

   339

                        if basetype_name in datatypenames and name not in self.DataTypeUsingTree[basetype_name]:

   340

                            self.DataTypeUsingTree[basetype_name].append(name)

   341

   342

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

   343

    def RefreshPouUsingTree(self):

   344

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

   345

        self.PouUsingTree = {}

   346

        if self.Project:

   347

            pous = self.Project.getPous()

   348

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

   349

            # user-defined pou cross-use

   350

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

   351

            for name in pounames:

   352

                self.PouUsingTree[name] = []

   353

            # Analyze each pou 

   354

            for pou in pous:

   355

                name = pou.getName()

   356

                if pou.interface:

   357

                    # Extract variables from every varLists

   358

                    for type, varlist in pou.getVars():

   359

                        for var in varlist.getVariable():

   360

                            vartype_content = var.getType().getContent()

   362

                                typename = vartype_content["value"].getName()

   363

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

   364

                                    self.PouUsingTree[typename].append(name)

   365

                bodytype = pou.getBodyType()

   366

                # If pou is written in a graphical language

   367

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

   368

                    # Analyze each instance of the pou

   369

                    for instance in pou.getInstances():

   370

                        if isinstance(instance, plcopen.block):

   371

                            typename = instance.getTypeName()

   372

                            # Update tree if there is a cross-use

   373

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

   374

                                 self.PouUsingTree[typename].append(name)

   375

                # If pou is written in a textual language

   376

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

   377

                    text = pou.getText()

   378

                    # Search if each pou is mentioned in the pou text

   379

                    for typename in pounames:

   380

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

   381

                        # Update tree if there is a cross-use

   382

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

   383

                            self.PouUsingTree[typename].append(name)

   384

   385

    # Return if data type given by name is used by another data type or pou

   386

    def DataTypeIsUsed(self, name):

   387

        if name in self.DataTypeUsingTree:

   388

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

   389

        return False

   390

   391

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

   392

    def PouIsUsed(self, name):

   393

        if name in self.PouUsingTree:

   394

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

   395

        return False

   396

   397

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

   398

    def DataTypeIsUsedBy(self, name, reference):

   399

        if name in self.DataTypeUsingTree:

   400

            list = self.DataTypeUsingTree[name]

   401

            # Test if data type is directly used by reference

   402

            if reference in list:

   403

                return True

   404

            else:

   405

                # Test if data type is undirectly used by reference, by testing if data types 

   406

                # that directly use data type is directly or undirectly used by reference

   407

                used = False

   408

                for element in list:

   409

                    used |= self.DataTypeIsUsedBy(element, reference)

   410

                return used

   411

        return False

   412

   413

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

   414

    def PouIsUsedBy(self, name, reference):

   415

        if name in self.PouUsingTree:

   416

            list = self.PouUsingTree[name]

   417

            # Test if pou is directly used by reference

   418

            if reference in list:

   419

                return True

   420

            else:

   421

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

   422

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

   423

                used = False

   424

                for element in list:

   425

                    used |= self.PouIsUsedBy(element, reference)

   426

                return used

   427

        return False

   428

   429

    def GenerateProgram(self, filepath):

   430

        if self.Project:

   431

            try:

   432

                program = GenerateCurrentProgram(self.Project)

   433

                programfile = open(filepath, "w")

   434

                programfile.write(program)

   435

                programfile.close()

   436

                self.ProgramFilePath = filepath

   437

                return True

   438

            except:

   439

                pass

   440

        return False

   441

   442

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

   443

#                        Project Pous management functions

   444

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

   445

   446

    # Add a Data Type to Project

   447

    def ProjectAddDataType(self, datatype_name):

   448

        # Add the pou to project

   449

        self.Project.appendDataType(datatype_name)

   450

        self.RefreshDataTypeUsingTree()

   451

        self.RefreshDataTypes()

   452

        self.BufferProject()

   453

   454

    # Remove a Data Type from project

   455

    def ProjectRemoveDataType(self, datatype_name):

   456

        self.Project.removeDataType(datatype_name)

   457

        self.RefreshDataTypeUsingTree()

   458

        self.RefreshDataTypes()

   459

        self.BufferProject()

   460

   461

    # Add a Pou to Project

   462

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

   463

        # Add the pou to project

   464

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

   465

        if pou_type == "function":

   466

            self.SetPouInterfaceReturnType(pou_name, "BOOL")

   467

        self.RefreshPouUsingTree()

   468

        self.RefreshBlockTypes()

   469

        self.BufferProject()

   470

   471

    # Remove a Pou from project

   472

    def ProjectRemovePou(self, pou_name):

   473

        self.Project.removePou(pou_name)

   474

        self.RefreshPouUsingTree()

   475

        self.RefreshBlockTypes()

   476

        self.BufferProject()

   477

   478

    # Add a configuration to Project

   479

    def ProjectAddConfiguration(self, config_name):

   480

        self.Project.addConfiguration(config_name)

   481

        self.BufferProject()

   482

   483

    # Remove a configuration from project

   484

    def ProjectRemoveConfiguration(self, config_name):

   485

        self.Project.removeConfiguration(config_name)

   486

        self.BufferProject()

   487

   488

    # Add a resource to a configuration of the Project

   489

    def ProjectAddConfigurationResource(self, config_name, resource_name):

   490

        self.Project.addConfigurationResource(config_name, resource_name)

   491

        self.BufferProject()

   492

   493

    # Remove a resource from a configuration of the project

   494

    def ProjectRemoveConfigurationResource(self, config_name, resource_name):

   495

        self.Project.removeConfigurationResource(config_name, resource_name)

   496

        self.BufferProject()

   497

   498

    # Add a Transition to a Project Pou

   499

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

   500

        pou = self.Project.getPou(pou_name)

   501

        pou.addTransition(transition_name, transition_type)

   502

        self.BufferProject()

   503

   504

    # Remove a Transition from a Project Pou

   505

    def ProjectRemovePouTransition(self, pou_name, transition_name):

   506

        pou = self.Project.getPou(pou_name)

   507

        pou.removeTransition(transition_name)

   508

        self.BufferProject()

   509