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

# Copyright (C) 2017: Andrey Skvortsov

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

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

    13

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

    14

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

    15

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

    16

#

    17

# This program is distributed in the hope that it will be useful,

    18

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

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

    23

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

    24

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

    25

    26

    27

from __future__ import absolute_import

    28

import os

    29

import re

    30

import util.paths as paths

    31

    32

from xmlclass import GenerateParserFromXSD

    33

    34

from CodeFileTreeNode import CodeFile

    35

from py_ext.PythonEditor import PythonEditor

    36

    37

    38

class PythonFileCTNMixin(CodeFile):

    39

    40

    CODEFILE_NAME = "PyFile"

    41

    SECTIONS_NAMES = [

    42

        "globals",

    43

        "init",

    44

        "cleanup",

    45

        "start",

    46

        "stop"]

    47

    EditorType = PythonEditor

    48

    49

    def __init__(self):

    50

        CodeFile.__init__(self)

    51

    52

        filepath = self.PythonFileName()

    53

    54

        if os.path.isfile(filepath):

    55

            PythonParser = GenerateParserFromXSD(paths.AbsNeighbourFile(__file__, "py_ext_xsd.xsd"))

    56

    57

            xmlfile = open(filepath, 'r')

    58

            pythonfile_xml = xmlfile.read()

    59

            xmlfile.close()

    60

    61

            pythonfile_xml = pythonfile_xml.replace(

    62

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

    63

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

    64

            for cre, repl in [

    65

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

    66

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

    67

                pythonfile_xml = cre.sub(repl, pythonfile_xml)

    68

    69

            try:

    70

                python_code, error = PythonParser.LoadXMLString(pythonfile_xml)

    71

                if error is None:

    72

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

    73

                    os.remove(filepath)

    74

                    self.CreateCodeFileBuffer(False)

    75

                    self.OnCTNSave()

    76

            except Exception, exc:

    77

                error = unicode(exc)

    78

    79

            if error is not None:

    80

                self.GetCTRoot().logger.write_error(

    81

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

    82

    83

    def CodeFileName(self):

    84

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

    85

    86

    def PythonFileName(self):

    87

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

    88

    89

    PreSectionsTexts = {}

    90

    PostSectionsTexts = {}

    91

    92

    def GetSection(self, section):

    93

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

    94

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

    95

               self.PostSectionsTexts.get(section, "")

    96

    97

    def CTNGenerate_C(self, buildpath, locations):

    98

        # location string for that CTN

    99

        location_str = "_".join(map(str, self.GetCurrentLocation()))

   100

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

   101

   102

        pyextname = self.CTNName()

   103

        varinfos = map(lambda variable: {

   104

            "name": variable.getname(),

   105

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

   106

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

   107

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

   108

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

   109

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

   110

            if variable.getonchange() else None,

   111

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

   112

            "configname": configname.upper(),

   113

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

   114

            "IECtype": variable.gettype(),

   115

            "pyextname": pyextname},

   116

                       self.CodeFile.variables.variable)

   117

        # python side PLC global variables access stub

   118

        globalstubs = "\n".join([

   119

            """\

   120

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

   121

    TypeTranslator["%(IECtype)s"]

   122

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

   123

_PySafeGetPLCGlob_%(name)s.restype = None

   124

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

   125

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

   126

_PySafeSetPLCGlob_%(name)s.restype = None

   127

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

   128

_%(pyextname)sGlobalsDesc.append((

   129

    "%(name)s",

   130

    "%(IECtype)s",

   131

    %(desc)s,

   132

    %(onchange)s,

   133

    %(opts)s))

   134

""" % varinfo for varinfo in varinfos])

   135

   136

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

   137

        rtcalls = ""

   138

        for section in self.SECTIONS_NAMES:

   139

            if section != "globals":

   140

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

   141

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

   142

                if sectiontext:

   143

                    rtcalls += '    ' + \

   144

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

   145

                else:

   146

                    rtcalls += "    pass\n\n"

   147

   148

        globalsection = self.GetSection("globals")

   149

   150

        loc_dict = {

   151

            "pyextname": pyextname,

   152

            "globalstubs": globalstubs,

   153

            "globalsection": globalsection,

   154

            "rtcalls": rtcalls,

   155

        }

   156

   157

        PyFileContent = """\

   158

#!/usr/bin/env python

   159

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

   160

## Code generated by Beremiz python mixin confnode

   161

##

   162

   163

## Code for PLC global variable access

   164

from targets.typemapping import TypeTranslator

   165

import ctypes

   166

_%(pyextname)sGlobalsDesc = []

   167

__ext_name__ = "%(pyextname)s"

   168

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

   169

%(globalstubs)s

   170

   171

## User code in "global" scope

   172

%(globalsection)s

   173

   174

## Beremiz python runtime calls

   175

%(rtcalls)s

   176

   177

del __ext_name__

   178

   179

""" % loc_dict

   180

   181

        # write generated content to python file

   182

        runtimefile_path = os.path.join(buildpath,

   183

                                        "runtime_%s.py" % location_str)

   184

        runtimefile = open(runtimefile_path, 'w')

   185

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

   186

        runtimefile.close()

   187

   188

        # C code for safe global variables access

   189

   190

        vardecfmt = """\

   191

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

   192

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

   193

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

   194

long __%(name)s_rlock = 0;

   195

long __%(name)s_wlock = 0;

   196

int __%(name)s_wbuffer_written = 0;

   197

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

   198

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

   199

    *pvalue = __%(name)s_rbuffer;

   200

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

   201

}

   202

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

   203

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

   204

    __%(name)s_wbuffer = *value;

   205

    __%(name)s_wbuffer_written = 1;

   206

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

   207

}

   208

   209

"""

   210

   211

        vardeconchangefmt = """\

   212

PYTHON_POLL* __%(name)s_notifier;

   213

"""

   214

   215

        varretfmt = """\

   216

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

   217

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

   218

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

   219

            __%(name)s_wbuffer_written = 0;

   220

        }

   221

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

   222

    }

   223

"""

   224

        varpubfmt = """\

   225

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

   226

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

   227

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

   228

    }

   229

"""

   230

   231

        varpubonchangefmt = """\

   232

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

   233

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

   234

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

   235

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

   236

            PYTHON_POLL_body__(__%(name)s_notifier);

   237

        }

   238

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

   239

    }

   240

"""

   241

        varinitonchangefmt = """\

   242

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

   243

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

   244

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

   245

"""

   246

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

   247

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

   248

                            for varinfo in varinfos])

   249

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

   250

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

   251

                             varpubfmt) % varinfo

   252

                            for varinfo in varinfos])

   253

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

   254

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

   255

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

   256

   257

        loc_dict = {

   258

            "vardec": vardec,

   259

            "varinit": varinit,

   260

            "varret": varret,

   261

            "varpub": varpub,

   262

            "location_str": location_str,

   263

        }

   264

   265

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

   266

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

   267

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

   268

        PyCFileContent = """\

   269

/*

   270

 * Code generated by Beremiz py_ext confnode

   271

 * for safe global variables access

   272

 */

   273

#include "iec_types_all.h"

   274

#include "POUS.h"

   275

#include "config.h"

   276

#include "beremiz.h"

   277

   278

/* User variables reference */

   279

%(vardec)s

   280

   281

/* Beremiz confnode functions */

   282

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

   283

%(varinit)s

   284

    return 0;

   285

}

   286

   287

void __cleanup_%(location_str)s(void){

   288

}

   289

   290

void __retrieve_%(location_str)s(void){

   291

%(varret)s

   292

}

   293

   294

void __publish_%(location_str)s(void){

   295

%(varpub)s

   296

}

   297

""" % loc_dict

   298

   299

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

   300

        pycfile = open(Gen_PyCfile_path, 'w')

   301

        pycfile.write(PyCFileContent)

   302

        pycfile.close()

   303

   304

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

   305

            self.GetCTRoot().GetIECLibPath())

   306

   307

        return ([(Gen_PyCfile_path, matiec_CFLAGS)],

   308

                "",

   309

                True,

   310

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