1

import wx

     2

import os

     3

from xml.dom import minidom

     4

import cPickle

     5

     6

from xmlclass import *

     7

     8

from plugger import PlugTemplate

     9

from CFileEditor import CFileEditor

    10

from PLCControler import PLCControler, LOCATION_PLUGIN, LOCATION_MODULE, LOCATION_GROUP, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT, LOCATION_VAR_MEMORY

    11

    12

CFileClasses = GenerateClassesFromXSD(os.path.join(os.path.dirname(__file__), "cext_xsd.xsd")) 

    13

    14

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

    15

#                         Undo Buffer for CFile

    16

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

    17

    18

# Length of the buffer

    19

UNDO_BUFFER_LENGTH = 20

    20

    21

"""

    22

Class implementing a buffer of changes made on the current editing model

    23

"""

    24

class UndoBuffer:

    25

    26

    # Constructor initialising buffer

    27

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

    28

        self.Buffer = []

    29

        self.CurrentIndex = -1

    30

        self.MinIndex = -1

    31

        self.MaxIndex = -1

    32

        # if current state is defined

    33

        if currentstate:

    34

            self.CurrentIndex = 0

    35

            self.MinIndex = 0

    36

            self.MaxIndex = 0

    37

        # Initialising buffer with currentstate at the first place

    38

        for i in xrange(UNDO_BUFFER_LENGTH):

    39

            if i == 0:

    40

                self.Buffer.append(currentstate)

    41

            else:

    42

                self.Buffer.append(None)

    43

        # Initialising index of state saved

    44

        if issaved:

    45

            self.LastSave = 0

    46

        else:

    47

            self.LastSave = -1

    48

    49

    # Add a new state in buffer

    50

    def Buffering(self, currentstate):

    51

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

    52

        self.Buffer[self.CurrentIndex] = currentstate

    53

        # Actualising buffer limits

    54

        self.MaxIndex = self.CurrentIndex

    55

        if self.MinIndex == self.CurrentIndex:

    56

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

    57

            if self.LastSave == self.MinIndex:

    58

                self.LastSave = -1

    59

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

    60

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

    61

    62

    # Return current state of buffer

    63

    def Current(self):

    64

        return self.Buffer[self.CurrentIndex]

    65

    66

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

    67

    def Previous(self):

    68

        if self.CurrentIndex != self.MinIndex:

    69

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

    70

            return self.Buffer[self.CurrentIndex]

    71

        return None

    72

    73

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

    74

    def Next(self):

    75

        if self.CurrentIndex != self.MaxIndex:

    76

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

    77

            return self.Buffer[self.CurrentIndex]

    78

        return None

    79

    80

    # Return True if current state is the first in buffer

    81

    def IsFirst(self):

    82

        return self.CurrentIndex == self.MinIndex

    83

    84

    # Return True if current state is the last in buffer

    85

    def IsLast(self):

    86

        return self.CurrentIndex == self.MaxIndex

    87

    88

    # Note that current state is saved

    89

    def CurrentSaved(self):

    90

        self.LastSave = self.CurrentIndex

    91

    92

    # Return True if current state is saved

    93

    def IsCurrentSaved(self):

    94

        return self.LastSave == self.CurrentIndex

    95

    96

    97

TYPECONVERSION = {"BOOL" : "X", "SINT" : "B", "INT" : "W", "DINT" : "D", "LINT" : "L",

    98

    "USINT" : "B", "UINT" : "W", "UDINT" : "D", "ULINT" : "L", "REAL" : "D", "LREAL" : "L",

    99

    "STRING" : "B", "BYTE" : "B", "WORD" : "W", "DWORD" : "D", "LWORD" : "L", "WSTRING" : "W"}

   100

   101

class _Cfile:

   102

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

   103

    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   104

      <xsd:element name="CExtension">

   105

        <xsd:complexType>

   106

          <xsd:attribute name="CFLAGS" type="xsd:string" use="required"/>

   107

          <xsd:attribute name="LDFLAGS" type="xsd:string" use="required"/>

   108

        </xsd:complexType>

   109

      </xsd:element>

   110

    </xsd:schema>

   111

    """

   112

    def __init__(self):

   113

        filepath = self.CFileName()

   114

   115

        self.Buffering = False

   116

        self.CFile = CFileClasses["CFile"]()

   117

        self.CFileBuffer = UndoBuffer(self.Copy(self.CFile), False)

   118

        if os.path.isfile(filepath):

   119

            xmlfile = open(filepath, 'r')

   120

            tree = minidom.parse(xmlfile)

   121

            xmlfile.close()

   122

   123

            for child in tree.childNodes:

   124

                if child.nodeType == tree.ELEMENT_NODE and child.nodeName == "CFile":

   125

                    self.CFile.loadXMLTree(child, ["xmlns", "xmlns:xsi", "xsi:schemaLocation"])

   126

                    self.CFileBuffer = UndoBuffer(self.Copy(self.CFile), True)

   127

        else:

   128

            self.OnPlugSave()

   129

   130

    def CFileName(self):

   131

        return os.path.join(self.PlugPath(), "cfile.xml")

   132

   133

    def GetFilename(self):

   134

        if self.CFileBuffer.IsCurrentSaved():

   135

            return "cfile"

   136

        else:

   137

            return "~cfile~"

   138

   139

    def GetBaseTypes(self):

   140

        return self.GetPlugRoot().GetBaseTypes()

   141

   142

    def GetDataTypes(self, basetypes = False):

   143

        return self.GetPlugRoot().GetDataTypes(basetypes = basetypes)

   144

   145

    def GetSizeOfType(self, type):

   146

        return TYPECONVERSION[self.GetPlugRoot().GetBaseType(type)]

   147

   148

    def SetVariables(self, variables):

   149

        self.CFile.variables.setvariable([])

   150

        for var in variables:

   151

            variable = CFileClasses["variables_variable"]()

   152

            variable.setname(var["Name"])

   153

            variable.settype(var["Type"])

   154

            variable.setclass(var["Class"])

   155

            self.CFile.variables.appendvariable(variable)

   156

   157

    def GetVariables(self):

   158

        datas = []

   159

        for var in self.CFile.variables.getvariable():

   160

            datas.append({"Name" : var.getname(), "Type" : var.gettype(), "Class" : var.getclass()})

   161

        return datas

   162

   163

    def GetVariableLocationTree(self):

   164

        '''See PlugTemplate.GetVariableLocationTree() for a description.'''

   165

   166

        current_location = ".".join(map(str, self.GetCurrentLocation()))

   167

   168

        vars = []

   169

        input = output = 0

   170

        for var in self.CFile.variables.getvariable():

   171

            var_size = self.GetSizeOfType(var.gettype())

   172

            if var.getclass() == "input":

   173

                var_class = LOCATION_VAR_INPUT

   174

                var_location = "%%I%s%s.%d"%(var_size, current_location, input)

   175

                input += 1

   176

            else:

   177

                var_class = LOCATION_VAR_OUTPUT

   178

                var_location = "%%Q%s%s.%d"%(var_size, current_location, output)

   179

                output += 1

   180

            vars.append({"name": var.getname(),

   181

                         "type": var_class,

   182

                         "size": var_size,

   183

                         "IEC_type": var.gettype(),

   184

                         "location": var_location,

   185

                         "description": "",

   186

                         "children": []})

   187

   188

        return  {"name": self.BaseParams.getName(),

   189

                "type": LOCATION_PLUGIN,

   190

                "location": self.GetFullIEC_Channel(),

   191

                "children": vars}

   192

   193

    def SetPartText(self, name, text):

   194

        if name == "Includes":

   195

            self.CFile.includes.settext(text)

   196

        elif name == "Globals":

   197

            self.CFile.globals.settext(text)

   198

        elif name == "Init":

   199

            self.CFile.initFunction.settext(text)

   200

        elif name == "CleanUp":

   201

            self.CFile.cleanUpFunction.settext(text)

   202

        elif name == "Retrieve":

   203

            self.CFile.retrieveFunction.settext(text)

   204

        elif name == "Publish":

   205

            self.CFile.publishFunction.settext(text)

   206

   207

    def GetPartText(self, name):

   208

        if name == "Includes":

   209

            return self.CFile.includes.gettext()

   210

        elif name == "Globals":

   211

            return self.CFile.globals.gettext()

   212

        elif name == "Init":

   213

            return self.CFile.initFunction.gettext()

   214

        elif name == "CleanUp":

   215

            return self.CFile.cleanUpFunction.gettext()

   216

        elif name == "Retrieve":

   217

            return self.CFile.retrieveFunction.gettext()

   218

        elif name == "Publish":

   219

            return self.CFile.publishFunction.gettext()

   220

        return ""

   221

   222

    _View = None

   223

    def _OpenView(self):

   224

        if not self._View:

   225

            open_cfileeditor = True

   226

            has_permissions = self.GetPlugRoot().CheckProjectPathPerm()

   227

            if not has_permissions:

   228

                dialog = wx.MessageDialog(self.GetPlugRoot().AppFrame,

   229

                                          _("You don't have write permissions.\nOpen CFileEditor anyway ?"),

   230

                                          _("Open CFileEditor"),

   231

                                          wx.YES_NO|wx.ICON_QUESTION)

   232

                open_cfileeditor = dialog.ShowModal() == wx.ID_YES

   233

                dialog.Destroy()

   234

            if open_cfileeditor:

   235

                def _onclose():

   236

                    self._View = None

   237

                if has_permissions:

   238

                    def _onsave():

   239

                        self.GetPlugRoot().SaveProject()

   240

                else:

   241

                    def _onsave():

   242

                        pass

   243

                self._View = CFileEditor(self.GetPlugRoot().AppFrame, self)

   244

                self._View._onclose = _onclose

   245

                self._View._onsave = _onsave

   246

                self._View.Show()

   247

   248

    PluginMethods = [

   249

        {"bitmap" : os.path.join("images", "EditCfile"),

   250

         "name" : _("Edit C File"), 

   251

         "tooltip" : _("Edit C File"),

   252

         "method" : "_OpenView"},

   253

    ]

   254

   255

    def OnPlugSave(self):

   256

        filepath = self.CFileName()

   257

   258

        text = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n"

   259

        extras = {"xmlns":"http://www.w3.org/2001/XMLSchema",

   260

                  "xmlns:xsi":"http://www.w3.org/2001/XMLSchema-instance",

   261

                  "xsi:schemaLocation" : "cext_xsd.xsd"}

   262

        text += self.CFile.generateXMLText("CFile", 0, extras)

   263

   264

        xmlfile = open(filepath,"w")

   265

        xmlfile.write(text.encode("utf-8"))

   266

        xmlfile.close()

   267

   268

        self.CFileBuffer.CurrentSaved()

   269

        return True

   270

   271

    def PlugGenerate_C(self, buildpath, locations):

   272

        """

   273

        Generate C code

   274

        @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5)

   275

        @param locations: List of complete variables locations \

   276

            [{"IEC_TYPE" : the IEC type (i.e. "INT", "STRING", ...)

   277

            "NAME" : name of the variable (generally "__IW0_1_2" style)

   278

            "DIR" : direction "Q","I" or "M"

   279

            "SIZE" : size "X", "B", "W", "D", "L"

   280

            "LOC" : tuple of interger for IEC location (0,1,2,...)

   281

            }, ...]

   282

        @return: [(C_file_name, CFLAGS),...] , LDFLAGS_TO_APPEND

   283

        """

   284

        current_location = self.GetCurrentLocation()

   285

        # define a unique name for the generated C file

   286

        location_str = "_".join(map(str, current_location))

   287

   288

        text = "/* Code generated by Beremiz c_ext plugin */\n\n"

   289

   290

        # Adding includes

   291

        text += "/* User includes */\n"

   292

        text += self.CFile.includes.gettext()

   293

        text += "\n"

   294

   295

        text += """/* Beremiz c_ext plugin includes */

   296

#ifdef _WINDOWS_H

   297

  #include "iec_types.h"

   298

#else

   299

  #include "iec_std_lib.h"

   300

#endif

   301

   302

"""

   303

   304

        # Adding variables

   305

        vars = []

   306

        inputs = outputs = 0

   307

        for variable in self.CFile.variables.variable:

   308

            var = {"Name" : variable.getname(), "Type" : variable.gettype()}

   309

            if variable.getclass() == "input":

   310

                var["location"] = "__I%s%s_%d"%(self.GetSizeOfType(var["Type"]), location_str, inputs)

   311

                inputs += 1

   312

            else:

   313

                var["location"] = "__Q%s%s_%d"%(self.GetSizeOfType(var["Type"]), location_str, outputs)

   314

                outputs += 1

   315

            vars.append(var)

   316

        text += "/* Beremiz c_ext plugin user variables definition */\n"

   317

        base_types = self.GetPlugRoot().GetBaseTypes()

   318

        for var in vars:

   319

            if var["Type"] in base_types:

   320

                prefix = "IEC_"

   321

            else:

   322

                prefix = ""

   323

            text += "%s%s beremiz%s;\n"%(prefix, var["Type"], var["location"])

   324

            text += "%s%s *%s = &beremiz%s;\n"%(prefix, var["Type"], var["location"], var["location"])

   325

        text += "/* User variables reference */\n"

   326

        for var in vars:

   327

            text += "#define %s beremiz%s\n"%(var["Name"], var["location"])

   328

        text += "\n"

   329

   330

        # Adding user global variables and routines

   331

        text += "/* User internal user variables and routines */\n"

   332

        text += self.CFile.globals.gettext()

   333

   334

        # Adding Beremiz plugin functions

   335

        text += "/* Beremiz plugin functions */\n"

   336

        text += "int __init_%s(int argc,char **argv)\n{\n"%location_str

   337

        text += self.CFile.initFunction.gettext()

   338

        text += "  return 0;\n"

   339

        text += "\n}\n\n"

   340

   341

        text += "void __cleanup_%s(void)\n{\n"%location_str

   342

        text += self.CFile.cleanUpFunction.gettext()

   343

        text += "\n}\n\n"

   344

   345

        text += "void __retrieve_%s(void)\n{\n"%location_str

   346

        text += self.CFile.retrieveFunction.gettext()

   347

        text += "\n}\n\n"

   348

   349

        text += "void __publish_%s(void)\n{\n"%location_str

   350

        text += self.CFile.publishFunction.gettext()

   351

        text += "\n}\n\n"

   352

   353

        Gen_Cfile_path = os.path.join(buildpath, "CFile_%s.c"%location_str)

   354

        cfile = open(Gen_Cfile_path,'w')

   355

        cfile.write(text)

   356

        cfile.close()

   357

   358

        matiec_flags = '"-I%s"'%os.path.abspath(self.GetPlugRoot().GetIECLibPath())

   359

   360

        return [(Gen_Cfile_path, str(self.CExtension.getCFLAGS() + matiec_flags))],str(self.CExtension.getLDFLAGS()),True

   361

   362

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

   363

#                      Current Buffering Management Functions

   364

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

   365

   366

    """

   367

    Return a copy of the project

   368

    """

   369

    def Copy(self, model):

   370

        return cPickle.loads(cPickle.dumps(model))

   371

   372

    def BufferCFile(self):

   373

        self.CFileBuffer.Buffering(self.Copy(self.CFile))

   374

   375

    def StartBuffering(self):

   376

        self.CFileBuffer.Buffering(self.CFile)

   377

        self.Buffering = True

   378

   379

    def EndBuffering(self):

   380

        if self.Buffering:

   381

            self.CFile = self.Copy(self.CFile)

   382

            self.Buffering = False

   383

   384

    def CFileIsSaved(self):

   385

        if self.CFileBuffer:

   386

            return self.CFileBuffer.IsCurrentSaved()

   387

        else:

   388

            return True

   389

   390

    def LoadPrevious(self):

   391

        self.CFile = self.Copy(self.CFileBuffer.Previous())

   392

   393

    def LoadNext(self):

   394

        self.CFile = self.Copy(self.CFileBuffer.Next())

   395

   396

    def GetBufferState(self):

   397

        first = self.CFileBuffer.IsFirst()

   398

        last = self.CFileBuffer.IsLast()

   399

        return not first, not last

   400

   401

class RootClass:

   402

   403

    PlugChildsTypes = [("C_File",_Cfile, "C file")]

   404

   405

    def PlugGenerate_C(self, buildpath, locations):

   406

        return [],"",False

   407

   408