First Commit of library

Author: thijse

ArduinoLog.cpp

@@ -0,0 +1,150 @@
+/*
+    _   ___ ___  _   _ ___ _  _  ___  _    ___   ___ 
+   /_\ | _ \   \| | | |_ _| \| |/ _ \| |  / _ \ / __|
+  / _ \|   / |) | |_| || || .` | (_) | |_| (_) | (_ |
+ /_/ \_\_|_\___/ \___/|___|_|\_|\___/|____\___/ \___|
+                                                     
+  Log library for Arduino
+  version 1.0.0
+  https://github.com/thijse/Arduino-Log
+
+Licensed under the MIT License <http://opensource.org/licenses/MIT>.
+
+Permission is hereby  granted, free of charge, to any  person obtaining a copy
+of this software and associated  documentation files (the "Software"), to deal
+in the Software  without restriction, including without  limitation the rights
+to  use, copy,  modify, merge,  publish, distribute,  sublicense, and/or  sell
+copies  of  the Software,  and  to  permit persons  to  whom  the Software  is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE  IS PROVIDED "AS  IS", WITHOUT WARRANTY  OF ANY KIND,  EXPRESS OR
+IMPLIED,  INCLUDING BUT  NOT  LIMITED TO  THE  WARRANTIES OF  MERCHANTABILITY,
+FITNESS FOR  A PARTICULAR PURPOSE AND  NONINFRINGEMENT. IN NO EVENT  SHALL THE
+AUTHORS  OR COPYRIGHT  HOLDERS  BE  LIABLE FOR  ANY  CLAIM,  DAMAGES OR  OTHER
+LIABILITY, WHETHER IN AN ACTION OF  CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE  OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+#include "ArduinoLog.h"
+
+void Logging::begin(int level, Print* logOutput, bool showLevel){
+    _level     = constrain(level,LOG_LEVEL_SILENT,LOG_LEVEL_VERBOSE);
+	_showLevel = showLevel;
+    _logOutput = logOutput;
+}
+
+void Logging::print(const __FlashStringHelper *format, va_list args) {
+#ifndef DISABLE_LOGGING	  	
+  PGM_P p = reinterpret_cast<PGM_P>(format);
+  char c = pgm_read_byte(p++);
+  for(;c != 0; c = pgm_read_byte(p++)){
+    if (c == '%') {
+      c = pgm_read_byte(p++);
+      printFormat(c, &args);
+    } else {
+      _logOutput->print(c);
+    }
+  }
+#endif	  
+}
+
+void Logging::print(const char *format, va_list args) {
+#ifndef DISABLE_LOGGING	  	
+  for (; *format != 0; ++format) {
+    if (*format == '%') {
+      ++format;
+      printFormat(*format, &args);
+    } else {
+      _logOutput->print(*format);
+    }
+  }
+#endif	  
+}
+
+void Logging::printFormat(const char format, va_list *args) {
+#ifndef DISABLE_LOGGING	  	
+  if (format == '\0') return;
+
+  if (format == '%') {
+    _logOutput->print(format);
+    return;
+  }
+
+  if( format == 's' ) {
+    register char *s = (char *)va_arg( *args, int );
+    _logOutput->print(s);
+    return;
+  }
+
+  if( format == 'd' || format == 'i') {
+    _logOutput->print(va_arg( *args, int ),DEC);
+    return;
+  }
+
+  if( format == 'x' ) {
+    _logOutput->print(va_arg( *args, int ),HEX);
+    return;
+  }
+
+  if( format == 'X' ) {
+    _logOutput->print("0x");
+    _logOutput->print(va_arg( *args, int ),HEX);
+    return;
+  }
+
+  if( format == 'b' ) {
+    _logOutput->print(va_arg( *args, int ),BIN);
+    return;
+  }
+
+  if( format == 'B' ) {
+    _logOutput->print("0b");
+    _logOutput->print(va_arg( *args, int ),BIN);
+    return;
+  }
+
+  if( format == 'l' ) {
+    _logOutput->print(va_arg( *args, long ),DEC);
+    return;
+  }
+
+  if( format == 'c' ) {
+    _logOutput->print(va_arg( *args, int ));
+    return;
+  }
+
+  if( format == 't' ) {
+    if (va_arg( *args, int ) == 1) {
+      _logOutput->print("T");
+    }
+    else {
+      _logOutput->print("F");
+    }
+    return;
+  }
+
+  if( format == 'T' ) {
+    if (va_arg( *args, int ) == 1) {
+      _logOutput->print(F("true"));
+    }
+    else {
+      _logOutput->print(F("false"));
+    }
+    return;
+  }
+#endif	  
+}
+ 
+Logging Log = Logging();
+
+ 
+ 
+  
+
+
+
+

ArduinoLog.h

@@ -0,0 +1,214 @@
+/*
+    _   ___ ___  _   _ ___ _  _  ___  _    ___   ___ 
+   /_\ | _ \   \| | | |_ _| \| |/ _ \| |  / _ \ / __|
+  / _ \|   / |) | |_| || || .` | (_) | |_| (_) | (_ |
+ /_/ \_\_|_\___/ \___/|___|_|\_|\___/|____\___/ \___|
+                                                     
+  Log library for Arduino
+  version 1.0.0
+  https://github.com/thijse/Arduino-Log
+
+Licensed under the MIT License <http://opensource.org/licenses/MIT>.
+
+*/
+
+#ifndef LOGGING_H
+#define LOGGING_H
+#include <inttypes.h>
+#include <stdarg.h>
+#if defined(ARDUINO) && ARDUINO >= 100
+	#include "Arduino.h"
+#else
+	#include "WProgram.h"
+#endif
+
+//#include <stdint.h>
+//#include <stddef.h>
+// *************************************************************************
+//  Uncomment line below to fully disable logging, and reduce project size
+// ************************************************************************
+//#define DISABLE_LOGGING
+
+
+#define LOG_LEVEL_SILENT  0 
+#define LOG_LEVEL_FATAL   1
+#define LOG_LEVEL_ERROR   2
+#define LOG_LEVEL_WARNING 3
+#define LOG_LEVEL_NOTICE  4
+#define LOG_LEVEL_VERBOSE 5
+
+#define CR "\n"
+#define LOGGING_VERSION 1_0_0
+
+/*!
+ Logging is a helper class to output informations over
+ RS232. If you know log4j or log4net, this logging class
+ is more or less similar ;-) <br>
+ Different loglevels can be used to extend or reduce output
+ All methods are able to handle any number of output parameters.
+ All methods print out a formated string (like printf).<br>
+ To reduce output and program size, reduce loglevel.
+ 
+ Output format string can contain below wildcards. Every wildcard
+ must be start with percent sign (\%)
+ 
+**** Wildcards
+ 
+* %s	replace with an string (char*)
+* %c	replace with an character
+* %d	replace with an integer value
+* %l	replace with an long value
+* %x	replace and convert integer value into hex
+* %X	like %x but combine with 0x123AB
+* %b	replace and convert integer value into binary
+* %B	like %x but combine with 0b10100011
+* %t	replace and convert boolean value into "t" or "f"
+* %T	like %t but convert into "true" or "false"
+
+**** Loglevels
+
+* 0 - LOG_LEVEL_SILENT     no output 
+* 1 - LOG_LEVEL_FATAL      fatal errors 
+* 2 - LOG_LEVEL_ERROR      all errors  
+* 3 - LOG_LEVEL_WARNING    errors, and warnings 
+* 4 - LOG_LEVEL_NOTICE     errors, warnings and notices 
+* 5 - LOG_LEVEL_VERBOSE    all 
+*/
+
+class Logging {
+private:
+    int _level;
+	bool _showLevel;
+    Print* _logOutput;
+public:
+    /*! 
+	 * default Constructor
+	 */
+    Logging()
+      : _level(LOG_LEVEL_SILENT),
+	    _showLevel(true),
+        _logOutput(NULL) {}
+	
+
+    /**
+    * Initializing, must be called as first. Note that if you use
+    * this variant of Init, you need to initialize the baud rate
+    * yourself, if printer happens to be a serial port.
+    * \param level - logging levels <= this will be logged.
+    * \param printer - place that logging output will be sent to.
+    * \return void
+    *
+    */
+    void begin(int level, Print *output, bool showLevel = true);
+
+	    /**
+	* Output an error message. Output message contains
+	* ERROR: followed by original msg
+	* Error messages are printed out, at every loglevel
+	* except 0 ;-)
+	* \param msg format string to output
+	* \param ... any number of variables
+	* \return void
+	*/
+  template <class T> void fatal(T msg, ...){
+#ifndef DISABLE_LOGGING	  
+    if (LOG_LEVEL_FATAL <= _level) {
+      if (_showLevel) _logOutput->print("F: ");
+      va_list args;
+      va_start(args, msg);
+      print(msg,args);
+    }
+#endif	
+  }
+	
+    /**
+	* Output an error message. Output message contains
+	* ERROR: followed by original msg
+	* Error messages are printed out, at every loglevel
+	* except 0 ;-)
+	* \param msg format string to output
+	* \param ... any number of variables
+	* \return void
+	*/
+  template <class T> void error(T msg, ...){
+#ifndef DISABLE_LOGGING	  
+    if (LOG_LEVEL_ERROR <= _level) {
+      if (_showLevel) _logOutput->print("E: ");
+      va_list args;
+      va_start(args, msg);
+      print(msg,args);
+    }
+#endif	
+  }
+    /**
+	* Output an info message. Output message contains
+	* Info messages are printed out at l
+	* loglevels >= LOG_LEVEL_INFOS
+	*
+	* \param msg format string to output
+	* \param ... any number of variables
+	* \return void
+	*/
+
+  template <class T> void warning(T msg, ...){
+#ifndef DISABLE_LOGGING	  
+    if (LOG_LEVEL_WARNING <= _level) {
+      if (_showLevel) _logOutput->print("W: ");
+      va_list args;
+      va_start(args, msg);
+      print(msg,args);
+    }
+#endif		
+  }
+    /**
+	* Output an debug message. Output message contains
+	* Debug messages are printed out at l
+	* loglevels >= LOG_LEVEL_DEBUG
+	*
+	* \param msg format string to output
+	* \param ... any number of variables
+	* \return void
+	*/
+
+  template <class T> void notice(T msg, ...){
+#ifndef DISABLE_LOGGING	  
+    if (LOG_LEVEL_NOTICE <= _level) {
+	  if (_showLevel) _logOutput->print("N: ");
+      va_list args;
+      va_start(args, msg);
+      print(msg,args);
+    }
+#endif		
+  }
+    /**
+	* Output an verbose message. Output message contains
+	* Debug messages are printed out at l
+	* loglevels >= LOG_LEVEL_VERBOSE
+	*
+	* \param msg format string to output
+	* \param ... any number of variables
+	* \return void
+	*/
+  template <class T> void verbose(T msg, ...){
+#ifndef DISABLE_LOGGING	  
+    if (LOG_LEVEL_VERBOSE <= _level) {
+	  if (_showLevel) _logOutput->print("V: ");
+      va_list args;
+      va_start(args, msg);
+      print(msg,args);
+    }
+#endif		
+  }
+    
+private:
+    void print(const char *format, va_list args);
+    void print(const __FlashStringHelper *format, va_list args);
+    void printFormat(const char format, va_list *args);
+};
+
+extern Logging Log;
+#endif
+
+
+
+