Add prototyping terminal to uLab client for TDE

6 files changed, 410 insertions, 1 deletions

diff --git a/clients/tde/src/part/Makefile.am b/clients/tde/src/part/Makefile.am
index 097c647..f9bfb88 100644
--- a/clients/tde/src/part/Makefile.am
+++ b/clients/tde/src/part/Makefile.am
@@ -1 +1 @@
-SUBDIRS     = scope commanalyzer fpgaview fpgaprogram sensormonitor adminconsole adminusermgmt
+SUBDIRS     = scope commanalyzer fpgaview fpgaprogram sensormonitor adminconsole adminusermgmt prototerminal
diff --git a/clients/tde/src/part/prototerminal/Makefile.am b/clients/tde/src/part/prototerminal/Makefile.am
new file mode 100644
index 0000000..dd7f18a
--- /dev/null
+++ b/clients/tde/src/part/prototerminal/Makefile.am
@@ -0,0 +1,12 @@
+INCLUDES     = $(all_includes) -I$(top_srcdir)/src -I$(top_srcdir)/src/widgets $(KDE_INCLUDES)/tde
+KDE_CXXFLAGS = $(USE_EXCEPTIONS)
+METASOURCES  = AUTO
+
+KDE_ICON = libremotelab_prototerminal
+
+#Part
+kde_module_LTLIBRARIES  =  libremotelab_prototerminal.la
+libremotelab_prototerminal_la_LIBADD  = $(LIB_KFILE) $(LIB_TDEPARTS) $(LIB_TDEUI) $(LIB_QT)
+libremotelab_prototerminal_la_LDFLAGS = $(all_libraries) $(KDE_PLUGIN) -ltdecore -ltdeui -ltdeio -ltdefx -ltdekrbsocket -ltqtrla
+libremotelab_prototerminal_la_SOURCES = \
+   part.cpp layout.ui
diff --git a/clients/tde/src/part/prototerminal/hi16-action-libremotelab_prototerminal.png b/clients/tde/src/part/prototerminal/hi16-action-libremotelab_prototerminal.png
new file mode 100644
index 0000000..75fa314
--- /dev/null
+++ b/clients/tde/src/part/prototerminal/hi16-action-libremotelab_prototerminal.png
diff --git a/clients/tde/src/part/prototerminal/layout.ui b/clients/tde/src/part/prototerminal/layout.ui
new file mode 100644
index 0000000..31087e9
--- /dev/null
+++ b/clients/tde/src/part/prototerminal/layout.ui
@@ -0,0 +1,58 @@
+<!DOCTYPE UI><UI version="3.0" stdsetdef="1">
+	<class>ProtoTerminalBase</class>
+	<widget class="TQWidget">
+		<property name="name">
+			<cstring>ProtoTerminalBase</cstring>
+		</property>
+		<property name="geometry">
+			<rect>
+				<x>0</x>
+				<y>0</y>
+				<width>519</width>
+				<height>356</height>
+			</rect>
+		</property>
+		<grid>
+			<property name="name">
+				<cstring>unnamed</cstring>
+			</property>
+			<widget class="KTextEdit" row="0" column="0" colspan="3">
+				<property name="name">
+					<cstring>textOutput</cstring>
+				</property>
+				<property name="readOnly">
+					<bool>true</bool>
+				</property>
+			</widget>
+			<widget class="TQLabel" row="1" column="0" colspan="1">
+				<property name="name">
+					<cstring>unnamed</cstring>
+				</property>
+				<property name="text">
+					<string>Input:</string>
+				</property>
+				<property name="textFormat">
+					<enum>PlainText</enum>
+				</property>
+			</widget>
+			<widget class="KLineEdit" row="1" column="1" colspan="1">
+				<property name="name">
+					<cstring>textInput</cstring>
+				</property>
+			</widget>
+			<widget class="TQPushButton" row="1" column="2" colspan="1">
+				<property name="name">
+					<cstring>sendText</cstring>
+				</property>
+				<property name="text">
+					<cstring>Send</cstring>
+				</property>
+			</widget>
+		</grid>
+	</widget>
+	<includes>
+		<include location="local" impldecl="in implementation">ProtoTerminalBase.ui.h</include>
+	</includes>
+	<layoutdefaults spacing="3" margin="6"/>
+	<layoutfunctions spacing="KDialog::spacingHint" margin="KDialog::marginHint"/>
+</UI>
diff --git a/clients/tde/src/part/prototerminal/part.cpp b/clients/tde/src/part/prototerminal/part.cpp
new file mode 100644
index 0000000..434c675
--- /dev/null
+++ b/clients/tde/src/part/prototerminal/part.cpp
@@ -0,0 +1,275 @@
+//Author:    Timothy Pearson <kb9vqf@pearsoncomputing.net>, (C) 2012
+//Copyright: See COPYING file that comes with this distribution
+
+#include "define.h"
+#include "part.h"
+
+#include <tdeaboutdata.h>   //::createAboutData()
+#include <tdeaction.h>
+#include <tdelocale.h>
+#include <tdemessagebox.h>  //::start()
+#include <tdeparts/genericfactory.h>
+#include <kstatusbar.h>
+#include <kstdaction.h>
+#include <tqfile.h>        //encodeName()
+#include <tqtimer.h>
+#include <tqvbox.h>
+#include <tqsocket.h>
+#include <tqmutex.h>
+#include <tqeventloop.h>
+#include <tqapplication.h>
+#include <tqpushbutton.h>
+#include <klineedit.h>
+#include <ktextedit.h>
+#include <unistd.h>       //access()
+#include <stdint.h>
+#include <cmath>
+
+#include "layout.h"
+
+#define NETWORK_COMM_TIMEOUT_MS 15000
+
+/* exception handling */
+struct exit_exception {
+	int c;
+	exit_exception(int c):c(c) { }
+};
+
+namespace RemoteLab {
+
+typedef KParts::GenericFactory<RemoteLab::ProtoTerminalPart> Factory;
+#define CLIENT_LIBRARY "libremotelab_prototerminal"
+K_EXPORT_COMPONENT_FACTORY( libremotelab_prototerminal, RemoteLab::Factory )
+
+
+ProtoTerminalPart::ProtoTerminalPart( TQWidget *parentWidget, const char *widgetName, TQObject *parent, const char *name, const TQStringList& )
+	: RemoteInstrumentPart( parent, name ), m_commHandlerState(-1), m_commHandlerMode(0), m_commHandlerCommandState(0), m_connectionActiveAndValid(false), m_base(0)
+{
+	// Initialize important base class variables
+	m_clientLibraryName = CLIENT_LIBRARY;
+
+	// Initialize mutex
+	m_instrumentMutex = new TQMutex(false);
+
+	// Initialize kpart
+	setInstance(Factory::instance());
+	setWidget(new TQVBox(parentWidget, widgetName));
+
+	// Create timers
+	m_forcedUpdateTimer = new TQTimer(this);
+	connect(m_forcedUpdateTimer, SIGNAL(timeout()), this, SLOT(mainEventLoop()));
+	m_updateTimeoutTimer = new TQTimer(this);
+	connect(m_updateTimeoutTimer, SIGNAL(timeout()), this, SLOT(mainEventLoop()));
+
+	// Create widgets
+	m_base = new ProtoTerminalBase(widget());
+
+	connect(m_base->sendText, SIGNAL(clicked()), this, SLOT(sendTextClicked()));
+	connect(m_base->textInput, SIGNAL(returnPressed()), m_base->sendText, SIGNAL(clicked()));
+
+	TQTimer::singleShot(0, this, TQT_SLOT(postInit()));
+}
+
+ProtoTerminalPart::~ProtoTerminalPart() {
+	if (m_instrumentMutex->locked()) {
+		printf("[WARNING] Exiting when data transfer still in progress!\n\r"); fflush(stdout);
+	}
+
+	disconnectFromServer();
+	delete m_instrumentMutex;
+}
+
+void ProtoTerminalPart::postInit() {
+	setUsingFixedSize(false);
+}
+
+bool ProtoTerminalPart::openURL(const KURL &url) {
+	int ret;
+	m_connectionActiveAndValid = false;
+	ret = connectToServer(url.url());
+	processLockouts();
+	return (ret != 0);
+}
+
+bool ProtoTerminalPart::closeURL() {
+	disconnectFromServer();
+	m_url = KURL();
+	return true;
+}
+
+void ProtoTerminalPart::processLockouts() {
+	if (m_connectionActiveAndValid) {
+		m_base->setEnabled(true);
+	}
+	else {
+		m_base->setEnabled(false);
+	}
+}
+
+void ProtoTerminalPart::disconnectFromServerCallback() {
+	m_forcedUpdateTimer->stop();
+	m_updateTimeoutTimer->stop();
+	m_connectionActiveAndValid = false;
+}
+
+void ProtoTerminalPart::connectionFinishedCallback() {
+	connect(m_socket, SIGNAL(readyRead()), m_socket, SLOT(processPendingData()));
+	m_socket->processPendingData();
+	connect(m_socket, SIGNAL(newDataReceived()), this, SLOT(mainEventLoop()));
+	m_tickerState = 0;
+	m_commHandlerState = 0;
+	m_commHandlerMode = 0;
+	m_socket->setDataTimeout(NETWORK_COMM_TIMEOUT_MS);
+	m_updateTimeoutTimer->start(NETWORK_COMM_TIMEOUT_MS, TRUE);
+	processLockouts();
+	mainEventLoop();
+	return;
+}
+
+void ProtoTerminalPart::connectionStatusChangedCallback() {
+	processLockouts();
+}
+
+void ProtoTerminalPart::setTickerMessage(TQString message) {
+	m_connectionActiveAndValid = true;
+	TQString tickerChar;
+	switch (m_tickerState) {
+		case 0:
+			tickerChar = "-";
+			break;
+		case 1:
+			tickerChar = "\\";
+			break;
+		case 2:
+			tickerChar = "|";
+			break;
+		case 3:
+			tickerChar = "/";
+			break;
+	}
+	setStatusMessage(message + TQString("... %1").arg(tickerChar));
+	m_tickerState++;
+	if (m_tickerState > 3) {
+		m_tickerState = 0;
+	}
+}
+
+#define UPDATEDISPLAY_TIMEOUT		m_connectionActiveAndValid = false;														\
+					m_tickerState = 0;																\
+					m_commHandlerState = 2;																\
+					m_commHandlerMode = 0;																\
+					m_socket->clearIncomingData();															\
+					setStatusMessage(i18n("Server ping timeout.  Please verify the status of your network connection."));						\
+					m_updateTimeoutTimer->start(NETWORK_COMM_TIMEOUT_MS, TRUE);											\
+					m_instrumentMutex->unlock();															\
+					return;
+
+#define COMMUNICATIONS_FAILED		m_connectionActiveAndValid = false;														\
+					m_tickerState = 0;																\
+					m_commHandlerState = 2;																\
+					m_commHandlerMode = 0;																\
+					m_socket->clearIncomingData();															\
+					setStatusMessage(i18n("Instrument communication failure.  Please verify the status of your network connection."));				\
+					m_updateTimeoutTimer->start(NETWORK_COMM_TIMEOUT_MS, TRUE);											\
+					m_instrumentMutex->unlock();															\
+					return;
+
+#define SET_WATCHDOG_TIMER		if (!m_updateTimeoutTimer->isActive()) m_updateTimeoutTimer->start(NETWORK_COMM_TIMEOUT_MS, TRUE);
+#define PAT_WATCHDOG_TIMER		m_updateTimeoutTimer->stop(); m_updateTimeoutTimer->start(NETWORK_COMM_TIMEOUT_MS, TRUE);							\
+					setTickerMessage(i18n("Connected"));
+
+#define SET_NEXT_STATE(x)		if (m_commHandlerMode == 0) {															\
+						m_commHandlerState = x;															\
+					}																		\
+					else {																		\
+						m_commHandlerState = 255;														\
+					}
+
+#define EXEC_NEXT_STATE_IMMEDIATELY	m_forcedUpdateTimer->start(0, TRUE);
+
+void ProtoTerminalPart::mainEventLoop() {
+	TQDataStream ds(m_socket);
+	ds.setPrintableData(true);
+
+	if (!m_instrumentMutex->tryLock()) {
+		EXEC_NEXT_STATE_IMMEDIATELY
+		return;
+	}
+
+	if (m_socket) {
+		if ((m_commHandlerMode == 0) || (m_commHandlerMode == 1)) {
+			if (m_commHandlerState == 0) {
+				// Setup functions go here
+				setTickerMessage("Connection established");
+
+				m_commHandlerState = 1;
+				EXEC_NEXT_STATE_IMMEDIATELY
+			}
+			else if (m_commHandlerState == 1) {
+				// Receive data
+				if (m_socket->canReadFrame()) {
+					PAT_WATCHDOG_TIMER
+
+					// Get command status
+					TQString input;
+					ds >> input;
+					m_socket->clearFrameTail();
+
+					if (input != "") {
+						 m_base->textOutput->append(">>>" + input);
+						EXEC_NEXT_STATE_IMMEDIATELY
+					}
+				}
+				else {
+					if (!m_updateTimeoutTimer->isActive()) {
+						UPDATEDISPLAY_TIMEOUT
+					}
+				}
+
+				// Send data
+				if (m_TextToSend != "") {
+					ds << m_TextToSend;
+					m_socket->writeEndOfFrame();
+
+					m_base->textOutput->append("<<<" + m_TextToSend);
+					m_TextToSend = "";
+
+					EXEC_NEXT_STATE_IMMEDIATELY
+				}
+
+				// Never time out
+				PAT_WATCHDOG_TIMER
+			}
+			else if (m_commHandlerState == 2) {
+				// Ignore timeouts
+				m_commHandlerState = 1;
+				EXEC_NEXT_STATE_IMMEDIATELY
+			}
+			SET_WATCHDOG_TIMER
+		}
+	}
+	else {
+		m_commHandlerState = 0;
+		m_commHandlerCommandState = 0;
+	}
+
+	processLockouts();
+
+	m_instrumentMutex->unlock();
+}
+
+void ProtoTerminalPart::sendTextClicked() {
+	m_TextToSend = m_TextToSend + m_base->textInput->text();
+	m_base->textInput->setText("");
+
+	// Transmit!
+	EXEC_NEXT_STATE_IMMEDIATELY
+}
+
+TDEAboutData* ProtoTerminalPart::createAboutData() {
+	return new TDEAboutData( APP_NAME, I18N_NOOP( APP_PRETTYNAME ), APP_VERSION );
+}
+
+} //namespace RemoteLab
+
+#include "part.moc"
diff --git a/clients/tde/src/part/prototerminal/part.h b/clients/tde/src/part/prototerminal/part.h
new file mode 100644
index 0000000..0f90745
--- /dev/null
+++ b/clients/tde/src/part/prototerminal/part.h
@@ -0,0 +1,64 @@
+//Author:    Timothy Pearson <kb9vqf@pearsoncomputing.net>, (C) 2012
+//Copyright: See COPYING file that comes with this distribution
+
+#ifndef REMOTELAB_COMMANALYZERPART_H
+#define REMOTELAB_COMMANALYZERPART_H
+
+#include <tdeparts/browserextension.h>
+#include <tdeparts/statusbarextension.h>
+#include <tdeparts/part.h>
+#include <kurl.h>
+
+#include <tqtrla.h>
+
+class TDEAboutData;
+using KParts::StatusBarExtension;
+class TraceWidget;
+class TQSocket;
+class TQTimer;
+class TQMutex;
+class TQRectF;
+class ProtoTerminalBase;
+
+namespace RemoteLab
+{
+	class ProtoTerminalPart : public KParts::RemoteInstrumentPart
+	{
+		Q_OBJECT
+	
+		public:
+			ProtoTerminalPart( QWidget *, const char *, TQObject *, const char *, const TQStringList&);
+			~ProtoTerminalPart();
+	
+			virtual bool openFile() { return false; }	// pure virtual in the base class
+			virtual bool closeURL();
+			static TDEAboutData *createAboutData();
+
+		public slots:
+			virtual bool openURL(const KURL &url);
+		
+		private slots:
+			void postInit();
+			void processLockouts();
+			void connectionFinishedCallback();
+			void disconnectFromServerCallback();
+			void connectionStatusChangedCallback();
+			void setTickerMessage(TQString message);
+			void mainEventLoop();
+			void sendTextClicked();
+	
+		private:
+			int m_commHandlerState;
+			int m_commHandlerMode;
+			int m_commHandlerCommandState;
+			TQTimer* m_forcedUpdateTimer;
+			TQTimer* m_updateTimeoutTimer;
+			bool m_connectionActiveAndValid;
+			unsigned char m_tickerState;
+			ProtoTerminalBase* m_base;
+			TQMutex* m_instrumentMutex;
+			TQString m_TextToSend;
+	};
+}
+
+#endif