1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

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

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

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

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

import os, re

    26

from lxml import etree

    27

    28

from xmlclass import GenerateParserFromXSD

    29

    30

from CodeFileTreeNode import CodeFile

    31

from PythonEditor import PythonEditor

    32

    33

class PythonFileCTNMixin(CodeFile):

    34

    35

    CODEFILE_NAME = "PyFile"

    36

    SECTIONS_NAMES = [

    37

        "globals",

    38

        "init",

    39

        "cleanup",

    40

        "start",

    41

        "stop"]

    42

    EditorType = PythonEditor

    43

    44

    def __init__(self):

    45

        CodeFile.__init__(self)

    46

    47

        filepath = self.PythonFileName()

    48

    49

        if os.path.isfile(filepath):

    50

            PythonParser = GenerateParserFromXSD(

    51

                os.path.join(os.path.dirname(__file__), "py_ext_xsd.xsd"))

    52

    53

            xmlfile = open(filepath, 'r')

    54

            pythonfile_xml = xmlfile.read()

    55

            xmlfile.close()

    56

    57

            pythonfile_xml = pythonfile_xml.replace(

    58

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

    59

                'xmlns:xhtml="http://www.w3.org/1999/xhtml"')

    60

            for cre, repl in [

    61

                (re.compile("(?<!<xhtml:p>)(?:<!\[CDATA\[)"), "<xhtml:p><![CDATA["),

    62

                (re.compile("(?:]]>)(?!</xhtml:p>)"), "]]></xhtml:p>")]:

    63

                pythonfile_xml = cre.sub(repl, pythonfile_xml)

    64

    65

            try:

    66

                python_code, error = PythonParser.LoadXMLString(pythonfile_xml)

    67

                if error is None:

    68

                    self.CodeFile.globals.setanyText(python_code.getanyText())

    69

                    os.remove(filepath)

    70

                    self.CreateCodeFileBuffer(False)

    71

                    self.OnCTNSave()

    72

            except Exception, exc:

    73

                error = unicode(exc)

    74

    75

            if error is not None:

    76

                self.GetCTRoot().logger.write_error(

    77

                    _("Couldn't import old %s file.") % self.CTNName())

    78

    79

    def CodeFileName(self):

    80

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

    81

    82

    def PythonFileName(self):

    83

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

    84

    85

    PreSectionsTexts = {}

    86

    PostSectionsTexts = {}

    87

    def GetSection(self,section):

    88

        return self.PreSectionsTexts.get(section,"") + "\n" + \

    89

               getattr(self.CodeFile, section).getanyText() + "\n" + \

    90

               self.PostSectionsTexts.get(section,"")

    91

    92

    def CTNGenerate_C(self, buildpath, locations):

    93

        # location string for that CTN

    94

        location_str = "_".join(map(lambda x:str(x),

    95

                                self.GetCurrentLocation()))

    96

        configname = self.GetCTRoot().GetProjectConfigNames()[0]

    97

    98

        pyextname = self.CTNName()

    99

        varinfos = map(lambda variable : {

   100

                    "name": variable.getname(),

   101

                    "desc" : repr(variable.getdesc()),

   102

                    "onchangecode" : '"'+variable.getonchange()+\

   103

                                         "('"+variable.getname()+"')\"" \

   104

                                     if variable.getonchange() else '""',

   105

                    "onchange" : repr(variable.getonchange()) \

   106

                                 if variable.getonchange() else None,

   107

                    "opts" : repr(variable.getopts()),

   108

                    "configname" : configname.upper(),

   109

                    "uppername" : variable.getname().upper(),

   110

                    "IECtype" : variable.gettype(),

   111

                    "pyextname" :pyextname},

   112

                    self.CodeFile.variables.variable)

   113

        # python side PLC global variables access stub

   114

        globalstubs = "\n".join(["""\

   115

_%(name)s_ctype, _%(name)s_unpack, _%(name)s_pack = \\

   116

    TypeTranslator["%(IECtype)s"]

   117

_PySafeGetPLCGlob_%(name)s = PLCBinary.__SafeGetPLCGlob_%(name)s

   118

_PySafeGetPLCGlob_%(name)s.restype = None

   119

_PySafeGetPLCGlob_%(name)s.argtypes = [ctypes.POINTER(_%(name)s_ctype)]

   120

_PySafeSetPLCGlob_%(name)s = PLCBinary.__SafeSetPLCGlob_%(name)s

   121

_PySafeSetPLCGlob_%(name)s.restype = None

   122

_PySafeSetPLCGlob_%(name)s.argtypes = [ctypes.POINTER(_%(name)s_ctype)]

   123

_%(pyextname)sGlobalsDesc.append((

   124

    "%(name)s",

   125

    "%(IECtype)s",

   126

    %(desc)s,

   127

    %(onchange)s,

   128

    %(opts)s))

   129

""" % varinfo

   130

      for varinfo in varinfos])

   131

   132

        # Runtime calls (start, stop, init, and cleanup)

   133

        rtcalls = ""

   134

        for section in self.SECTIONS_NAMES:

   135

            if section != "globals":

   136

                rtcalls += "def _runtime_%s_%s():\n" % (location_str, section)

   137

                sectiontext = self.GetSection(section).strip()

   138

                if sectiontext:

   139

                    rtcalls += '    ' + \

   140

                        sectiontext.replace('\n', '\n    ')+"\n\n"

   141

                else:

   142

                    rtcalls += "    pass\n\n"

   143

   144

        globalsection = self.GetSection("globals")

   145

   146

        PyFileContent = """\

   147

#!/usr/bin/env python

   148

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

   149

## Code generated by Beremiz python mixin confnode

   150

##

   151

   152

## Code for PLC global variable access

   153

from targets.typemapping import TypeTranslator

   154

import ctypes

   155

_%(pyextname)sGlobalsDesc = []

   156

__ext_name__ = "%(pyextname)s"

   157

PLCGlobalsDesc.append(( "%(pyextname)s" , _%(pyextname)sGlobalsDesc ))

   158

%(globalstubs)s

   159

   160

## User code in "global" scope

   161

%(globalsection)s

   162

   163

## Beremiz python runtime calls

   164

%(rtcalls)s

   165

   166

del __ext_name__

   167

   168

""" % locals()

   169

   170

        # write generated content to python file

   171

        runtimefile_path = os.path.join(buildpath,

   172

            "runtime_%s.py"%location_str)

   173

        runtimefile = open(runtimefile_path, 'w')

   174

        runtimefile.write(PyFileContent.encode('utf-8'))

   175

        runtimefile.close()

   176

   177

        # C code for safe global variables access

   178

   179

        vardecfmt = """\

   180

extern  __IEC_%(IECtype)s_t %(configname)s__%(uppername)s;

   181

IEC_%(IECtype)s __%(name)s_rbuffer = __INIT_%(IECtype)s;

   182

IEC_%(IECtype)s __%(name)s_wbuffer;

   183

long __%(name)s_rlock = 0;

   184

long __%(name)s_wlock = 0;

   185

int __%(name)s_wbuffer_written = 0;

   186

void __SafeGetPLCGlob_%(name)s(IEC_%(IECtype)s *pvalue){

   187

    while(AtomicCompareExchange(&__%(name)s_rlock, 0, 1));

   188

    *pvalue = __%(name)s_rbuffer;

   189

    AtomicCompareExchange((long*)&__%(name)s_rlock, 1, 0);

   190

}

   191

void __SafeSetPLCGlob_%(name)s(IEC_%(IECtype)s *value){

   192

    while(AtomicCompareExchange(&__%(name)s_wlock, 0, 1));

   193

    __%(name)s_wbuffer = *value;

   194

    __%(name)s_wbuffer_written = 1;

   195

    AtomicCompareExchange((long*)&__%(name)s_wlock, 1, 0);

   196

}

   197

   198

"""

   199

   200

        vardeconchangefmt = """\

   201

PYTHON_POLL* __%(name)s_notifier;

   202

"""

   203

   204

        varretfmt = """\

   205

    if(!AtomicCompareExchange(&__%(name)s_wlock, 0, 1)){

   206

        if(__%(name)s_wbuffer_written == 1){

   207

            %(configname)s__%(uppername)s.value = __%(name)s_wbuffer;

   208

            __%(name)s_wbuffer_written = 0;

   209

        }

   210

        AtomicCompareExchange((long*)&__%(name)s_wlock, 1, 0);

   211

    }

   212

"""

   213

        varpubfmt = """\

   214

    if(!AtomicCompareExchange(&__%(name)s_rlock, 0, 1)){

   215

        __%(name)s_rbuffer = __GET_VAR(%(configname)s__%(uppername)s);

   216

        AtomicCompareExchange((long*)&__%(name)s_rlock, 1, 0);

   217

    }

   218

"""

   219

   220

        varpubonchangefmt = """\

   221

    if(!AtomicCompareExchange(&__%(name)s_rlock, 0, 1)){

   222

        IEC_%(IECtype)s tmp = __GET_VAR(%(configname)s__%(uppername)s);

   223

        if(__%(name)s_rbuffer != tmp){

   224

            __%(name)s_rbuffer = %(configname)s__%(uppername)s.value;

   225

            PYTHON_POLL_body__(__%(name)s_notifier);

   226

        }

   227

        AtomicCompareExchange((long*)&__%(name)s_rlock, 1, 0);

   228

    }

   229

"""

   230

        varinitonchangefmt = """\

   231

    __%(name)s_notifier = __GET_GLOBAL_ON%(uppername)sCHANGE();

   232

    __SET_VAR(__%(name)s_notifier->,TRIG,,__BOOL_LITERAL(TRUE));

   233

    __SET_VAR(__%(name)s_notifier->,CODE,,__STRING_LITERAL(%(onchangelen)d,%(onchangecode)s));

   234

"""

   235

        vardec = "\n".join([(vardecfmt + vardeconchangefmt

   236

                             if varinfo["onchange"] else vardecfmt)% varinfo

   237

                            for varinfo in varinfos])

   238

        varret = "\n".join([varretfmt % varinfo for varinfo in varinfos])

   239

        varpub = "\n".join([(varpubonchangefmt if varinfo["onchange"] else

   240

                             varpubfmt) % varinfo

   241

                            for varinfo in varinfos])

   242

        varinit = "\n".join([varinitonchangefmt % dict(

   243

                                onchangelen = len(varinfo["onchangecode"]),**varinfo)

   244

                            for varinfo in varinfos if varinfo["onchange"]])

   245

   246

        # TODO : use config name obtained from model instead of default

   247

        # "config.h". User cannot change config name, but project imported

   248

        # or created in older beremiz vesion could use different name.

   249

        PyCFileContent = """\

   250

/*

   251

 * Code generated by Beremiz py_ext confnode

   252

 * for safe global variables access

   253

 */

   254

#include "iec_types_all.h"

   255

#include "POUS.h"

   256

#include "config.h"

   257

#include "beremiz.h"

   258

   259

/* User variables reference */

   260

%(vardec)s

   261

   262

/* Beremiz confnode functions */

   263

int __init_%(location_str)s(int argc,char **argv){

   264

%(varinit)s

   265

    return 0;

   266

}

   267

   268

void __cleanup_%(location_str)s(void){

   269

}

   270

   271

void __retrieve_%(location_str)s(void){

   272

%(varret)s

   273

}

   274

   275

void __publish_%(location_str)s(void){

   276

%(varpub)s

   277

}

   278

""" % locals()

   279

   280

        Gen_PyCfile_path = os.path.join(buildpath, "PyCFile_%s.c"%location_str)

   281

        pycfile = open(Gen_PyCfile_path,'w')

   282

        pycfile.write(PyCFileContent)

   283

        pycfile.close()

   284

   285

        matiec_CFLAGS = '"-I%s"'%os.path.abspath(

   286

            self.GetCTRoot().GetIECLibPath())

   287

   288

        return ([(Gen_PyCfile_path, matiec_CFLAGS)],

   289

                "",

   290

                True,

   291

                ("runtime_%s.py"%location_str, file(runtimefile_path,"rb")))

   292