From 077419886205a3cfa2e19c41e64373231edb0322 Mon Sep 17 00:00:00 2001
From: Jean-Marc Paratte <jean-marc@paratte.ch>
Date: Mon, 1 May 2017 21:07:18 +0100
Subject: [PATCH] 1.0.3

Add _yield()_, _sleep()_, _rearm_async(); Remove _void rearm(timestamp_t
time, timestamp_t ival);_
---
 README.md          |   3 ++
 jm_Scheduler.cpp   | 104 ++++++++++++++++++++++++++++++++++++++++++---
 jm_Scheduler.h     |  31 +++++++++++---
 library.properties |   2 +-
 4 files changed, 129 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 8e84c8b..2ad253a 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
 <!--
 
+2017-05-05: 1.0.3
 2017-04-26: 1.0.2
 2017-03-29: 1.0.1
 2016-07-14: In progress...
@@ -17,6 +18,8 @@ Email: jean-marc@paratte.ch
 
 # jm_Scheduler - A Scheduler Library for Arduino
 
+2017-05-05: 1.0.3 - Add _yield()_, _sleep()_, _rearm_async(); Remove _void rearm(timestamp_t time, timestamp_t ival);_
+
 2017-04-26: 1.0.2 - Add _void rearm(timestamp_t time, timestamp_t ival);_
 
 2017-03-29: 1.0.1 - Minor adjustment
diff --git a/jm_Scheduler.cpp b/jm_Scheduler.cpp
index 62f2966..55f1660 100644
--- a/jm_Scheduler.cpp
+++ b/jm_Scheduler.cpp
@@ -116,8 +116,15 @@ void jm_Scheduler::wakeup_chain_remove()
 	this->wakeup_next = 0;
 }
 
+//------------------------------------------------------------------------------
+
 jm_Scheduler::jm_Scheduler()
 {
+//	jm_Scheduler(false);
+//}
+//
+//jm_Scheduler::jm_Scheduler(bool async)
+//{
 	this->func = 0;
 	this->time = 0;
 	this->ival = 0;
@@ -128,8 +135,10 @@ jm_Scheduler::jm_Scheduler()
 	this->wakeup_next = 0;	// next in wakeup routine chain
 	this->wakeup_count = 0;	// count of repeated interrupt routine
 
+//	this->async = async;
 	this->started = false;
 	this->stopping = false;
+	this->yielded = false;
 }
 
 jm_Scheduler::~jm_Scheduler()
@@ -142,6 +151,8 @@ jm_Scheduler::operator bool()
 	return (this->started);
 }
 
+//------------------------------------------------------------------------------
+
 void jm_Scheduler::display(int line)
 {
 	Serial.print(line);
@@ -188,6 +199,8 @@ void jm_Scheduler::display(int line)
 	Serial.flush();
 }
 
+//------------------------------------------------------------------------------
+
 void jm_Scheduler::time_cycle()
 {
 	jm_Scheduler::tref = timestamp_read();
@@ -256,6 +269,41 @@ void jm_Scheduler::cycle()
 }
 }
 
+void jm_Scheduler::yield()
+{
+	if (jm_Scheduler::crnt) // called from a running routine ?
+	{
+		// backup routine states
+		timestamp_t tref_ = jm_Scheduler::tref;
+		jm_Scheduler *crnt_ = jm_Scheduler::crnt;
+
+		// set routine yielded state
+		crnt_->yielded = true;
+
+		jm_Scheduler::crnt = 0; // free scheduler from current routine
+		jm_Scheduler::cycle(); // yield current routine
+
+		// clr routine yielded state
+		crnt_->yielded = false;
+
+		// restore routine states
+		jm_Scheduler::crnt = crnt_;
+		jm_Scheduler::tref = tref_;
+	}
+	else // called from setup() or loop().
+	{
+		jm_Scheduler::cycle();
+	}
+}
+
+void jm_Scheduler::sleep(timestamp_t ival)
+{
+	timestamp_t time1 = jm_Scheduler_time_read() + ival;
+	while (!jm_Scheduler_time_ge_time(jm_Scheduler_time_read(), time1)) jm_Scheduler::yield();
+}
+
+//------------------------------------------------------------------------------
+
 // start routine immediately
 void jm_Scheduler::start(voidfuncptr_t func)
 {
@@ -271,6 +319,7 @@ void jm_Scheduler::start(voidfuncptr_t func)
 
 	this->started = true;
 	this->stopping = false;
+	this->yielded = false;
 }
 
 // start routine immediately and repeat it at fixed intervals
@@ -288,6 +337,7 @@ void jm_Scheduler::start(voidfuncptr_t func, timestamp_t ival)
 
 	this->started = true;
 	this->stopping = false;
+	this->yielded = false;
 }
 
 // start routine on time and repeat it at fixed intervals
@@ -305,6 +355,7 @@ void jm_Scheduler::start(voidfuncptr_t func, timestamp_t time, timestamp_t ival)
 
 	this->started = true;
 	this->stopping = false;
+	this->yielded = false;
 }
 
 // stop routine, current or scheduled, remove from chain
@@ -321,31 +372,70 @@ void jm_Scheduler::stop()
 	{
 		this->started = false;
 		this->stopping = false;
+		this->yielded = false;
 
 		this->chain_remove();
 	}
 }
 
-// rearm current routine and set or reset interval
+//------------------------------------------------------------------------------
+
+// rearm routine
+void jm_Scheduler::rearm()
+{
+}
+
+// rearm routine asynchronously
+void jm_Scheduler::rearm_async()
+{
+	this->time = jm_Scheduler_time_read();
+}
+
+// rearm routine and set next interval
 void jm_Scheduler::rearm(timestamp_t ival)
 {
 	this->ival = ival;
 }
 
-// rearm current routine, set time and set or reset interval
-void jm_Scheduler::rearm(timestamp_t time, timestamp_t ival)
+// rearm routine asynchronously and set next interval
+void jm_Scheduler::rearm_async(timestamp_t ival)
 {
-	this->time = time;
+	this->time = jm_Scheduler_time_read();
 	this->ival = ival;
 }
 
-// rearm current routine, change routine function and set or reset interval
+//// rearm routine, set time and set next interval
+//void jm_Scheduler::rearm(timestamp_t time, timestamp_t ival)
+//{
+//	this->time = time;
+//	this->ival = ival;
+//}
+
+// rearm routine, change routine function and set next interval
 void jm_Scheduler::rearm(voidfuncptr_t func, timestamp_t ival)
 {
 	this->func = func;
 	this->ival = ival;
 }
 
+// rearm routine asynchronously, change routine function and set next interval
+void jm_Scheduler::rearm_async(voidfuncptr_t func, timestamp_t ival)
+{
+	this->time = jm_Scheduler_time_read();
+	this->func = func;
+	this->ival = ival;
+}
+
+//// rearm routine, change routine function, set time and set next interval
+//void jm_Scheduler::rearm(voidfuncptr_t func, timestamp_t time, timestamp_t ival)
+//{
+//	this->func = func;
+//	this->time = time;
+//	this->ival = ival;
+//}
+
+//------------------------------------------------------------------------------
+
 // wakeup a scheduled routine (maybe repeated)
 void jm_Scheduler::wakeup()
 {
@@ -382,3 +472,7 @@ int jm_Scheduler::wakeup_read()
 
 	return count;
 }
+
+//------------------------------------------------------------------------------
+
+// END.
\ No newline at end of file
diff --git a/jm_Scheduler.h b/jm_Scheduler.h
index ad8f3e6..1197db1 100644
--- a/jm_Scheduler.h
+++ b/jm_Scheduler.h
@@ -30,7 +30,7 @@
 //------------------------------------------------------------------------------
 
 #ifndef assert
-#define assert(v) while(!v){} // default assert function
+#define assert(v) while(!(v)){} // default assert function
 #endif
 
 #ifndef voidfuncptr_t
@@ -104,10 +104,14 @@ class jm_Scheduler
 	void wakeup_chain_append();
 	void wakeup_chain_remove();
 
+//	bool async;
 	bool started;
 	bool stopping;
+	bool yielded;
 
 	jm_Scheduler();
+//	jm_Scheduler(bool async);
+
 	~jm_Scheduler();
 
 	operator bool();
@@ -116,6 +120,8 @@ class jm_Scheduler
 
 	static void time_cycle();
 	static void cycle();
+	static void yield();
+	static void sleep(timestamp_t ival);
 
 	// start routine immediately
 	void start(voidfuncptr_t func);
@@ -129,15 +135,30 @@ class jm_Scheduler
 	// stop routine, current or scheduled, remove it from chain
 	void stop();
 
-	// rearm current routine and set or reset interval
+	// rearm routine
+	void rearm();
+
+	// rearm routine asynchronously
+	void rearm_async();
+
+	// rearm routine and set interval
 	void rearm(timestamp_t ival);
 
-	// rearm current routine, set time and set or reset interval
-	void rearm(timestamp_t time, timestamp_t ival);
+	// rearm routine asynchronously and set interval
+	void rearm_async(timestamp_t ival);
 
-	// rearm current routine, change routine function and set or reset interval
+//	// rearm routine, set time and set next interval
+//	void rearm(timestamp_t time, timestamp_t ival);
+
+	// rearm routine, change routine function and set interval
 	void rearm(voidfuncptr_t func, timestamp_t ival);
 
+	// rearm routine asynchronously, change routine function and set interval
+	void rearm_async(voidfuncptr_t func, timestamp_t ival);
+
+//	// rearm routine, change routine function, set time and set interval
+//	void rearm(voidfuncptr_t func, timestamp_t time, timestamp_t ival);
+
 	// wakeup a scheduled routine (maybe repeated)
 	void wakeup();
 
diff --git a/library.properties b/library.properties
index 706ec78..7d49f6d 100644
--- a/library.properties
+++ b/library.properties
@@ -1,5 +1,5 @@
 name=jm_Scheduler
-version=1.0.2
+version=1.0.3
 author=Jean-Marc Paratte <jean-marc@paratte.ch>
 maintainer=Jean-Marc Paratte <jean-marc@paratte.ch>
 sentence=A Scheduler Library for Arduino.