aboutsummaryrefslogtreecommitdiff
path: root/libraries/EEPROM/src/EEPROM.h
diff options
context:
space:
mode:
authorAlice Pintus <a.pintus@arduino.cc>2016-03-02 10:49:39 +0100
committerAlice Pintus <a.pintus@arduino.cc>2016-03-02 10:49:39 +0100
commite8f1805137b78307d2411f5670ea016d4355fb8d (patch)
tree4965fc7afaadbfa1e64c62cac19800d7bf7cec8e /libraries/EEPROM/src/EEPROM.h
parentf81317889e48460ab3ed2f2797ad54f0f57e2aba (diff)
moved .h file in src folder
Diffstat (limited to 'libraries/EEPROM/src/EEPROM.h')
-rw-r--r--libraries/EEPROM/src/EEPROM.h146
1 files changed, 146 insertions, 0 deletions
diff --git a/libraries/EEPROM/src/EEPROM.h b/libraries/EEPROM/src/EEPROM.h
new file mode 100644
index 0000000..cde75db
--- /dev/null
+++ b/libraries/EEPROM/src/EEPROM.h
@@ -0,0 +1,146 @@
+/*
+ EEPROM.h - EEPROM library
+ Original Copyright (c) 2006 David A. Mellis. All right reserved.
+ New version by Christopher Andrews 2015.
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser 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
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#ifndef EEPROM_h
+#define EEPROM_h
+
+#include <inttypes.h>
+#include <avr/eeprom.h>
+#include <avr/io.h>
+
+/***
+ EERef class.
+
+ This object references an EEPROM cell.
+ Its purpose is to mimic a typical byte of RAM, however its storage is the EEPROM.
+ This class has an overhead of two bytes, similar to storing a pointer to an EEPROM cell.
+***/
+
+struct EERef{
+
+ EERef( const int index )
+ : index( index ) {}
+
+ //Access/read members.
+ uint8_t operator*() const { return eeprom_read_byte( (uint8_t*) index ); }
+ operator const uint8_t() const { return **this; }
+
+ //Assignment/write members.
+ EERef &operator=( const EERef &ref ) { return *this = *ref; }
+ EERef &operator=( uint8_t in ) { return eeprom_write_byte( (uint8_t*) index, in ), *this; }
+ EERef &operator +=( uint8_t in ) { return *this = **this + in; }
+ EERef &operator -=( uint8_t in ) { return *this = **this - in; }
+ EERef &operator *=( uint8_t in ) { return *this = **this * in; }
+ EERef &operator /=( uint8_t in ) { return *this = **this / in; }
+ EERef &operator ^=( uint8_t in ) { return *this = **this ^ in; }
+ EERef &operator %=( uint8_t in ) { return *this = **this % in; }
+ EERef &operator &=( uint8_t in ) { return *this = **this & in; }
+ EERef &operator |=( uint8_t in ) { return *this = **this | in; }
+ EERef &operator <<=( uint8_t in ) { return *this = **this << in; }
+ EERef &operator >>=( uint8_t in ) { return *this = **this >> in; }
+
+ EERef &update( uint8_t in ) { return in != *this ? *this = in : *this; }
+
+ /** Prefix increment/decrement **/
+ EERef& operator++() { return *this += 1; }
+ EERef& operator--() { return *this -= 1; }
+
+ /** Postfix increment/decrement **/
+ uint8_t operator++ (int){
+ uint8_t ret = **this;
+ return ++(*this), ret;
+ }
+
+ uint8_t operator-- (int){
+ uint8_t ret = **this;
+ return --(*this), ret;
+ }
+
+ int index; //Index of current EEPROM cell.
+};
+
+/***
+ EEPtr class.
+
+ This object is a bidirectional pointer to EEPROM cells represented by EERef objects.
+ Just like a normal pointer type, this can be dereferenced and repositioned using
+ increment/decrement operators.
+***/
+
+struct EEPtr{
+
+ EEPtr( const int index )
+ : index( index ) {}
+
+ operator const int() const { return index; }
+ EEPtr &operator=( int in ) { return index = in, *this; }
+
+ //Iterator functionality.
+ bool operator!=( const EEPtr &ptr ) { return index != ptr.index; }
+ EERef operator*() { return index; }
+
+ /** Prefix & Postfix increment/decrement **/
+ EEPtr& operator++() { return ++index, *this; }
+ EEPtr& operator--() { return --index, *this; }
+ EEPtr operator++ (int) { return index++; }
+ EEPtr operator-- (int) { return index--; }
+
+ int index; //Index of current EEPROM cell.
+};
+
+/***
+ EEPROMClass class.
+
+ This object represents the entire EEPROM space.
+ It wraps the functionality of EEPtr and EERef into a basic interface.
+ This class is also 100% backwards compatible with earlier Arduino core releases.
+***/
+
+struct EEPROMClass{
+
+ //Basic user access methods.
+ EERef operator[]( const int idx ) { return idx; }
+ uint8_t read( int idx ) { return EERef( idx ); }
+ void write( int idx, uint8_t val ) { (EERef( idx )) = val; }
+ void update( int idx, uint8_t val ) { EERef( idx ).update( val ); }
+
+ //STL and C++11 iteration capability.
+ EEPtr begin() { return 0x00; }
+ EEPtr end() { return length(); } //Standards requires this to be the item after the last valid entry. The returned pointer is invalid.
+ uint16_t length() { return E2END + 1; }
+
+ //Functionality to 'get' and 'put' objects to and from EEPROM.
+ template< typename T > T &get( int idx, T &t ){
+ EEPtr e = idx;
+ uint8_t *ptr = (uint8_t*) &t;
+ for( int count = sizeof(T) ; count ; --count, ++e ) *ptr++ = *e;
+ return t;
+ }
+
+ template< typename T > const T &put( int idx, const T &t ){
+ EEPtr e = idx;
+ const uint8_t *ptr = (const uint8_t*) &t;
+ for( int count = sizeof(T) ; count ; --count, ++e ) (*e).update( *ptr++ );
+ return t;
+ }
+};
+
+static EEPROMClass EEPROM;
+#endif \ No newline at end of file