1

import os

     2

from xml.dom import minidom

     3

import cPickle

     4

     5

from xmlclass import *

     6

     7

from CFileEditor import CFileEditor

     8

from PLCControler import UndoBuffer, LOCATION_CONFNODE, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT 

     9

    10

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

    11

    12

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

    13

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

    14

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

    15

    16

class CFile:

    17

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

    18

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

    19

      <xsd:element name="CExtension">

    20

        <xsd:complexType>

    21

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

    22

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

    23

        </xsd:complexType>

    24

      </xsd:element>

    25

    </xsd:schema>

    26

    """

    27

    EditorType = CFileEditor

    28

    29

    def __init__(self):

    30

        filepath = self.CFileName()

    31

    32

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

    33

        if os.path.isfile(filepath):

    34

            xmlfile = open(filepath, 'r')

    35

            tree = minidom.parse(xmlfile)

    36

            xmlfile.close()

    37

    38

            for child in tree.childNodes:

    39

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

    40

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

    41

                    self.CreateCFileBuffer(True)

    42

        else:

    43

            self.CreateCFileBuffer(False)

    44

            self.OnCTNSave()

    45

    46

    def GetIconName(self):

    47

        return "Cfile"

    48

    49

    def CFileName(self):

    50

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

    51

    52

    def GetBaseTypes(self):

    53

        return self.GetCTRoot().GetBaseTypes()

    54

    55

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

    56

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

    57

    58

    def GetSizeOfType(self, type):

    59

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

    60

    61

    def SetVariables(self, variables):

    62

        self.CFile.variables.setvariable([])

    63

        for var in variables:

    64

            variable = CFileClasses["variables_variable"]()

    65

            variable.setname(var["Name"])

    66

            variable.settype(var["Type"])

    67

            variable.setclass(var["Class"])

    68

            self.CFile.variables.appendvariable(variable)

    69

    70

    def GetVariables(self):

    71

        datas = []

    72

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

    73

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

    74

        return datas

    75

    76

    def GetVariableLocationTree(self):

    77

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

    78

    79

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

    80

    81

        vars = []

    82

        input = memory = output = 0

    83

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

    84

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

    85

            var_location = ""

    86

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

    87

                var_class = LOCATION_VAR_INPUT

    88

                if var_size is not None:

    89

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

    90

                input += 1

    91

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

    92

                var_class = LOCATION_VAR_INPUT

    93

                if var_size is not None:

    94

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

    95

                memory += 1

    96

            else:

    97

                var_class = LOCATION_VAR_OUTPUT

    98

                if var_size is not None:

    99

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

   100

                output += 1

   101

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

   102

                         "type": var_class,

   103

                         "size": var_size,

   104

                         "IEC_type": var.gettype(),

   105

                         "var_name": var.getname(),

   106

                         "location": var_location,

   107

                         "description": "",

   108

                         "children": []})

   109

   110

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

   111

                "type": LOCATION_CONFNODE,

   112

                "location": self.GetFullIEC_Channel(),

   113

                "children": vars}

   114

   115

    def SetPartText(self, name, text):

   116

        if name == "Includes":

   117

            self.CFile.includes.settext(text)

   118

        elif name == "Globals":

   119

            self.CFile.globals.settext(text)

   120

        elif name == "Init":

   121

            self.CFile.initFunction.settext(text)

   122

        elif name == "CleanUp":

   123

            self.CFile.cleanUpFunction.settext(text)

   124

        elif name == "Retrieve":

   125

            self.CFile.retrieveFunction.settext(text)

   126

        elif name == "Publish":

   127

            self.CFile.publishFunction.settext(text)

   128

   129

    def GetPartText(self, name):

   130

        if name == "Includes":

   131

            return self.CFile.includes.gettext()

   132

        elif name == "Globals":

   133

            return self.CFile.globals.gettext()

   134

        elif name == "Init":

   135

            return self.CFile.initFunction.gettext()

   136

        elif name == "CleanUp":

   137

            return self.CFile.cleanUpFunction.gettext()

   138

        elif name == "Retrieve":

   139

            return self.CFile.retrieveFunction.gettext()

   140

        elif name == "Publish":

   141

            return self.CFile.publishFunction.gettext()

   142

        return ""

   143

   144

    def CTNTestModified(self):

   145

        return self.ChangesToSave or not self.CFileIsSaved()    

   146

   147

    def OnCTNSave(self):

   148

        filepath = self.CFileName()

   149

   150

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

   151

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

   152

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

   153

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

   154

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

   155

   156

        xmlfile = open(filepath,"w")

   157

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

   158

        xmlfile.close()

   159

   160

        self.MarkCFileAsSaved()

   161

        return True

   162

   163

    def CTNGenerate_C(self, buildpath, locations):

   164

        """

   165

        Generate C code

   166

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

   167

        @param locations: List of complete variables locations \

   168

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

   169

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

   170

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

   171

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

   172

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

   173

            }, ...]

   174

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

   175

        """

   176

        current_location = self.GetCurrentLocation()

   177

        # define a unique name for the generated C file

   178

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

   179

   180

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

   181

   182

        # Adding includes

   183

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

   184

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

   185

        text += "\n"

   186

   187

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

   188

#ifdef _WINDOWS_H

   189

  #include "iec_types.h"

   190

#else

   191

  #include "iec_std_lib.h"

   192

#endif

   193

   194

"""

   195

   196

        # Adding variables

   197

        vars = []

   198

        inputs = memories = outputs = 0

   199

        for variable in self.CFile.variables.variable:

   200

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

   201

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

   202

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

   203

                inputs += 1

   204

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

   205

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

   206

                memories += 1

   207

            else:

   208

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

   209

                outputs += 1

   210

            vars.append(var)

   211

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

   212

        base_types = self.GetCTRoot().GetBaseTypes()

   213

        for var in vars:

   214

            if var["Type"] in base_types:

   215

                prefix = "IEC_"

   216

            else:

   217

                prefix = ""

   218

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

   219

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

   220

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

   221

        for var in vars:

   222

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

   223

        text += "\n"

   224

   225

        # Adding user global variables and routines

   226

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

   227

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

   228

   229

        # Adding Beremiz confnode functions

   230

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

   231

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

   232

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

   233

        text += "  return 0;\n"

   234

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

   235

   236

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

   237

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

   238

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

   239

   240

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

   241

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

   242

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

   243

   244

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

   245

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

   246

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

   247

   248

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

   249

        cfile = open(Gen_Cfile_path,'w')

   250

        cfile.write(text)

   251

        cfile.close()

   252

   253

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

   254

   255

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

   256

   257

   258

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

   259

#                      Current Buffering Management Functions

   260

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

   261

   262

    """

   263

    Return a copy of the cfile model

   264

    """

   265

    def Copy(self, model):

   266

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

   267

   268

    def CreateCFileBuffer(self, saved):

   269

        self.Buffering = False

   270

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

   271

   272

    def BufferCFile(self):

   273

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

   274

   275

    def StartBuffering(self):

   276

        self.Buffering = True

   277

   278

    def EndBuffering(self):

   279

        if self.Buffering:

   280

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

   281

            self.Buffering = False

   282

   283

    def MarkCFileAsSaved(self):

   284

        self.EndBuffering()

   285

        self.CFileBuffer.CurrentSaved()

   286

   287

    def CFileIsSaved(self):

   288

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

   289

   290

    def LoadPrevious(self):

   291

        self.EndBuffering()

   292

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

   293

   294

    def LoadNext(self):

   295

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

   296

   297

    def GetBufferState(self):

   298

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

   299

        last = self.CFileBuffer.IsLast()

   300

        return not first, not last

   301