beremiz

fix issue with sometimes wrong return code of ProcessLogger

2016-04-28, Andrey Skvortsov
d7f474d10210
fix issue with sometimes wrong return code of ProcessLogger


As a result of wrong return code Beremiz gives folowing traceback:
Traceback (most recent call last):
File "./Beremiz.py", line 850, in OnMenu
getattr(self.CTR, method)()
File "/home/developer/WorkData/PLC/beremiz/beremiz/ProjectController.py", line 925, in _Build
IECGenRes = self._Generate_SoftPLC()
File "/home/developer/WorkData/PLC/beremiz/beremiz/ProjectController.py", line 568, in _Generate_SoftPLC
return self._Compile_ST_to_SoftPLC()
File "/home/developer/WorkData/PLC/beremiz/beremiz/ProjectController.py", line 661, in _Compile_ST_to_SoftPLC
C_files.remove("POUS.c")
ValueError: list.remove(x): x not in list

The problem is that both threads (for reading stdout and stderr) call self.Proc.poll(),
that updates internal returncode field. This call is done without any locking and the first thread gets correct result,
but other gets 0 as retval. If 0 gets thread, that afterwards calls callback finish, then wrong return code is returned
to the parent. Now only the thread with a callback polls for the return code, other thread just checked local value.

Additionally function spin() waits now until all threads finish reading their pipes, so the results are always correct.
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor
#based on the plcopen standard.
#
#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
#
#See COPYING file for copyrights details.
#
#This library is free software; you can redistribute it and/or
#modify it under the terms of the GNU General Public
#License as published by the Free Software Foundation; either
#version 2.1 of the License, or (at your option) any later version.
#
#This library is distributed in the hope that it will be useful,
#but WITHOUT ANY WARRANTY; without even the implied warranty of
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
#General Public License for more details.
#
#You should have received a copy of the GNU General Public
#License along with this library; if not, write to the Free Software
#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
import wx
from controls.CustomToolTip import CustomToolTip, TOOLTIP_WAIT_PERIOD
#-------------------------------------------------------------------------------
# Tool Tip Producer class
#-------------------------------------------------------------------------------
"""
Class that implements an element that generate Tool Tip
"""
class ToolTipProducer:
def __init__(self, parent):
"""
Constructor
@param parent: Parent Viewer
"""
self.Parent = parent
self.ToolTip = None
self.ToolTipPos = None
# Timer for firing Tool tip display
self.ToolTipTimer = wx.Timer(self.Parent, -1)
self.Parent.Bind(wx.EVT_TIMER,
self.OnToolTipTimer,
self.ToolTipTimer)
def __del__(self):
"""
Destructor
"""
self.DestroyToolTip()
def OnToolTipTimer(self, event):
"""
Callback for Tool Tip firing timer Event
@param event: Tool tip text
"""
# Get Tool Tip text
value = self.GetToolTipValue()
if value is not None and self.ToolTipPos is not None:
# Create Tool Tip
self.ToolTip = CustomToolTip(self.Parent, value)
self.ToolTip.SetToolTipPosition(self.ToolTipPos)
self.ToolTip.Show()
def GetToolTipValue(self):
"""
Return tool tip text
Have to be overridden by inherited classes
@return: Tool tip text (None if not overridden)
"""
return None
def DisplayToolTip(self, pos):
"""
Display Tool tip
@param pos: Tool tip position
"""
# Destroy current displayed Tool tip
self.DestroyToolTip()
# Save Tool Tip position
self.ToolTipPos = pos
# Start Tool tip firing timer
self.ToolTipTimer.Start(
int(TOOLTIP_WAIT_PERIOD * 1000),
oneShot=True)
def SetToolTipText(self, text):
"""
Set current Tool tip text
@param text: Tool tip Text
"""
if self.ToolTip is not None:
self.ToolTip.SetTip(text)
def DestroyToolTip(self):
"""
Destroy current displayed Tool Tip
"""
# Stop Tool tip firing timer
self.ToolTipTimer.Stop()
self.ToolTipPos = None
# Destroy Tool Tip
if self.ToolTip is not None:
self.ToolTip.Destroy()
self.ToolTip = None