1

import os

     2

from xml.dom import minidom

     3

import cPickle

     4

     5

from xmlclass import *

     6

     7

from util.misc import opjimg

     8

from CFileEditor import CFileEditor

     9

from PLCControler import UndoBuffer, LOCATION_CONFNODE, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT 

    10

    11

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

    12

    13

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

    14

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

    15

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

    16

    17

class CFile:

    18

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

    19

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

    20

      <xsd:element name="CExtension">

    21

        <xsd:complexType>

    22

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

    23

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

    24

        </xsd:complexType>

    25

      </xsd:element>

    26

    </xsd:schema>

    27

    """

    28

    EditorType = CFileEditor

    29

    30

    def __init__(self):

    31

        filepath = self.CFileName()

    32

    33

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

    34

        if os.path.isfile(filepath):

    35

            xmlfile = open(filepath, 'r')

    36

            tree = minidom.parse(xmlfile)

    37

            xmlfile.close()

    38

    39

            for child in tree.childNodes:

    40

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

    41

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

    42

                    self.CreateCFileBuffer(True)

    43

        else:

    44

            self.CreateCFileBuffer(False)

    45

            self.OnCTNSave()

    46

    47

    def GetIconPath(self):

    48

        return opjimg("Cfile")

    49

    50

    def CFileName(self):

    51

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

    52

    53

    def GetBaseTypes(self):

    54

        return self.GetCTRoot().GetBaseTypes()

    55

    56

    def GetDataTypes(self, basetypes = False, only_locatables = False):

    57

        return self.GetCTRoot().GetDataTypes(basetypes=basetypes, only_locatables=only_locatables)

    58

    59

    def GetSizeOfType(self, type):

    60

        return TYPECONVERSION.get(self.GetCTRoot().GetBaseType(type), None)

    61

    62

    def SetVariables(self, variables):

    63

        self.CFile.variables.setvariable([])

    64

        for var in variables:

    65

            variable = CFileClasses["variables_variable"]()

    66

            variable.setname(var["Name"])

    67

            variable.settype(var["Type"])

    68

            variable.setclass(var["Class"])

    69

            self.CFile.variables.appendvariable(variable)

    70

    71

    def GetVariables(self):

    72

        datas = []

    73

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

    74

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

    75

        return datas

    76

    77

    def GetVariableLocationTree(self):

    78

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

    79

    80

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

    81

    82

        vars = []

    83

        input = memory = output = 0

    84

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

    85

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

    86

            var_location = ""

    87

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

    88

                var_class = LOCATION_VAR_INPUT

    89

                if var_size is not None:

    90

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

    91

                input += 1

    92

            elif var.getclass() == "memory":

    93

                var_class = LOCATION_VAR_INPUT

    94

                if var_size is not None:

    95

                    var_location = "%%M%s%s.%d"%(var_size, current_location, memory)

    96

                memory += 1

    97

            else:

    98

                var_class = LOCATION_VAR_OUTPUT

    99

                if var_size is not None:

   100

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

   101

                output += 1

   102

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

   103

                         "type": var_class,

   104

                         "size": var_size,

   105

                         "IEC_type": var.gettype(),

   106

                         "var_name": var.getname(),

   107

                         "location": var_location,

   108

                         "description": "",

   109

                         "children": []})

   110

   111

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

   112

                "type": LOCATION_CONFNODE,

   113

                "location": self.GetFullIEC_Channel(),

   114

                "children": vars}

   115

   116

    def SetPartText(self, name, text):

   117

        if name == "Includes":

   118

            self.CFile.includes.settext(text)

   119

        elif name == "Globals":

   120

            self.CFile.globals.settext(text)

   121

        elif name == "Init":

   122

            self.CFile.initFunction.settext(text)

   123

        elif name == "CleanUp":

   124

            self.CFile.cleanUpFunction.settext(text)

   125

        elif name == "Retrieve":

   126

            self.CFile.retrieveFunction.settext(text)

   127

        elif name == "Publish":

   128

            self.CFile.publishFunction.settext(text)

   129

   130

    def GetPartText(self, name):

   131

        if name == "Includes":

   132

            return self.CFile.includes.gettext()

   133

        elif name == "Globals":

   134

            return self.CFile.globals.gettext()

   135

        elif name == "Init":

   136

            return self.CFile.initFunction.gettext()

   137

        elif name == "CleanUp":

   138

            return self.CFile.cleanUpFunction.gettext()

   139

        elif name == "Retrieve":

   140

            return self.CFile.retrieveFunction.gettext()

   141

        elif name == "Publish":

   142

            return self.CFile.publishFunction.gettext()

   143

        return ""

   144

   145

    def CTNTestModified(self):

   146

        return self.ChangesToSave or not self.CFileIsSaved()    

   147

   148

    def OnCTNSave(self):

   149

        filepath = self.CFileName()

   150

   151

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

   152

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

   153

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

   154

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

   155

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

   156

   157

        xmlfile = open(filepath,"w")

   158

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

   159

        xmlfile.close()

   160

   161

        self.MarkCFileAsSaved()

   162

        return True

   163

   164

    def CTNGenerate_C(self, buildpath, locations):

   165

        """

   166

        Generate C code

   167

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

   168

        @param locations: List of complete variables locations \

   169

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

   170

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

   171

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

   172

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

   173

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

   174

            }, ...]

   175

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

   176

        """

   177

        current_location = self.GetCurrentLocation()

   178

        # define a unique name for the generated C file

   179

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

   180

   181

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

   182

   183

        # Adding includes

   184

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

   185

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

   186

        text += "\n"

   187

   188

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

   189

#ifdef _WINDOWS_H

   190

  #include "iec_types.h"

   191

#else

   192

  #include "iec_std_lib.h"

   193

#endif

   194

   195

"""

   196

   197

        # Adding variables

   198

        vars = []

   199

        inputs = memories = outputs = 0

   200

        for variable in self.CFile.variables.variable:

   201

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

   202

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

   203

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

   204

                inputs += 1

   205

            elif variable.getclass() == "memory":

   206

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

   207

                memories += 1

   208

            else:

   209

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

   210

                outputs += 1

   211

            vars.append(var)

   212

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

   213

        base_types = self.GetCTRoot().GetBaseTypes()

   214

        for var in vars:

   215

            if var["Type"] in base_types:

   216

                prefix = "IEC_"

   217

            else:

   218

                prefix = ""

   219

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

   220

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

   221

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

   222

        for var in vars:

   223

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

   224

        text += "\n"

   225

   226

        # Adding user global variables and routines

   227

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

   228

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

   229

   230

        # Adding Beremiz confnode functions

   231

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

   232

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

   233

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

   234

        text += "  return 0;\n"

   235

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

   236

   237

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

   238

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

   239

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

   240

   241

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

   242

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

   243

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

   244

   245

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

   246

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

   247

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

   248

   249

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

   250

        cfile = open(Gen_Cfile_path,'w')

   251

        cfile.write(text)

   252

        cfile.close()

   253

   254

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

   255

   256

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

   257

   258

   259

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

   260

#                      Current Buffering Management Functions

   261

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

   262

   263

    """

   264

    Return a copy of the cfile model

   265

    """

   266

    def Copy(self, model):

   267

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

   268

   269

    def CreateCFileBuffer(self, saved):

   270

        self.Buffering = False

   271

        self.CFileBuffer = UndoBuffer(cPickle.dumps(self.CFile), saved)

   272

   273

    def BufferCFile(self):

   274

        self.CFileBuffer.Buffering(cPickle.dumps(self.CFile))

   275

   276

    def StartBuffering(self):

   277

        self.Buffering = True

   278

   279

    def EndBuffering(self):

   280

        if self.Buffering:

   281

            self.CFileBuffer.Buffering(cPickle.dumps(self.CFile))

   282

            self.Buffering = False

   283

   284

    def MarkCFileAsSaved(self):

   285

        self.EndBuffering()

   286

        self.CFileBuffer.CurrentSaved()

   287

   288

    def CFileIsSaved(self):

   289

        return self.CFileBuffer.IsCurrentSaved() and not self.Buffering

   290

   291

    def LoadPrevious(self):

   292

        self.EndBuffering()

   293

        self.CFile = cPickle.loads(self.CFileBuffer.Previous())

   294

   295

    def LoadNext(self):

   296

        self.CFile = cPickle.loads(self.CFileBuffer.Next())

   297

   298

    def GetBufferState(self):

   299

        first = self.CFileBuffer.IsFirst() and not self.Buffering

   300

        last = self.CFileBuffer.IsLast()

   301

        return not first, not last

   302