aboutsummaryrefslogtreecommitdiff
path: root/libraries
diff options
context:
space:
mode:
Diffstat (limited to 'libraries')
-rw-r--r--libraries/EEPROM/EEPROM.cpp50
-rw-r--r--libraries/EEPROM/EEPROM.h139
-rw-r--r--libraries/EEPROM/keywords.txt6
-rw-r--r--libraries/EEPROM/library.properties4
4 files changed, 138 insertions, 61 deletions
diff --git a/libraries/EEPROM/EEPROM.cpp b/libraries/EEPROM/EEPROM.cpp
deleted file mode 100644
index dfa1deb..0000000
--- a/libraries/EEPROM/EEPROM.cpp
+++ /dev/null
@@ -1,50 +0,0 @@
-/*
- EEPROM.cpp - EEPROM library
- Copyright (c) 2006 David A. Mellis. All right reserved.
-
- 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
-*/
-
-/******************************************************************************
- * Includes
- ******************************************************************************/
-
-#include <avr/eeprom.h>
-#include "Arduino.h"
-#include "EEPROM.h"
-
-/******************************************************************************
- * Definitions
- ******************************************************************************/
-
-/******************************************************************************
- * Constructors
- ******************************************************************************/
-
-/******************************************************************************
- * User API
- ******************************************************************************/
-
-uint8_t EEPROMClass::read(int address)
-{
- return eeprom_read_byte((unsigned char *) address);
-}
-
-void EEPROMClass::write(int address, uint8_t value)
-{
- eeprom_write_byte((unsigned char *) address, value);
-}
-
-EEPROMClass EEPROM;
diff --git a/libraries/EEPROM/EEPROM.h b/libraries/EEPROM/EEPROM.h
index aa2b577..1b528f7 100644
--- a/libraries/EEPROM/EEPROM.h
+++ b/libraries/EEPROM/EEPROM.h
@@ -1,6 +1,7 @@
/*
EEPROM.h - EEPROM library
- Copyright (c) 2006 David A. Mellis. All right reserved.
+ 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
@@ -21,15 +22,137 @@
#define EEPROM_h
#include <inttypes.h>
+#include <avr/eeprom.h>
+#include <avr/io.h>
-class EEPROMClass
-{
- public:
- uint8_t read(int);
- void write(int, uint8_t);
+/***
+ 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.
};
-extern EEPROMClass EEPROM;
+/***
+ 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( this->index ); }
+
+
+ /** Prefix increment/decrement **/
+ EEPtr& operator++() { return ++index, *this; }
+ EEPtr& operator--() { return --index, *this; }
+
+
+ /** Postfix increment/decrement **/
+ EEPtr operator++ (int){
+ int ret = index;
+ return ++index, ret;
+ }
-#endif
+ EEPtr operator-- (int){
+ int ret = index;
+ return --index, ret;
+ }
+
+ 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 index ) { return( index ); }
+ 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;
+ }
+};
+
+extern EEPROMClass EEPROM;
+#endif \ No newline at end of file
diff --git a/libraries/EEPROM/keywords.txt b/libraries/EEPROM/keywords.txt
index d3218fe..2cabc0b 100644
--- a/libraries/EEPROM/keywords.txt
+++ b/libraries/EEPROM/keywords.txt
@@ -1,5 +1,5 @@
#######################################
-# Syntax Coloring Map For Ultrasound
+# Syntax Coloring Map For EEPROM
#######################################
#######################################
@@ -7,11 +7,15 @@
#######################################
EEPROM KEYWORD1
+EERef KEYWORD1
+EEPtr KEYWORD2
#######################################
# Methods and Functions (KEYWORD2)
#######################################
+update KEYWORD2
+
#######################################
# Constants (LITERAL1)
#######################################
diff --git a/libraries/EEPROM/library.properties b/libraries/EEPROM/library.properties
index 796f7cb..955a0ae 100644
--- a/libraries/EEPROM/library.properties
+++ b/libraries/EEPROM/library.properties
@@ -1,6 +1,6 @@
name=EEPROM
-version=1.0
-author=Arduino
+version=2.0
+author=Arduino, Christopher Andrews
maintainer=Arduino <info@arduino.cc>
sentence=Enables reading and writing to the permanent board storage. For all Arduino boards BUT Arduino DUE.
paragraph=
generated by cgit v1.2.3-18-g5258 (git 2.32.0) at 2024-11-22 17:47:42 +0000