remove unused variable in Kernel

[clinton/Smoothieware.git] / src / libs / StreamOutput.h

diff --git a/src/libs/StreamOutput.h b/src/libs/StreamOutput.h
index c7da6d4..ffb905b 100644 (file)
--- a/src/libs/StreamOutput.h
+++ b/src/libs/StreamOutput.h
@@ -1,17 +1,40 @@
-/*  
+/*
       This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
       Smoothie is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
       Smoothie 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 General Public License for more details.
-      You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>. 
+      You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef STREAMOUTPUT_H
 #define STREAMOUTPUT_H
 
+#include <cstdarg>
+#include <cstring>
+#include <stdio.h>
+
+// This is a base class for all StreamOutput objects.
+// StreamOutputs are basically "things you can sent strings to". They are passed along with gcodes for example so modules can answer to those gcodes.
+// They are usually associated with a command source, but can also be a NullStreamOutput if we just want to ignore whatever is sent
+
+class NullStreamOutput;
+
 class StreamOutput {
     public:
-       StreamOutput(){}
-       virtual int printf(const char* format, ...) { return 0; }
+        StreamOutput(){}
+        virtual ~StreamOutput(){}
+
+        virtual int printf(const char *format, ...) __attribute__ ((format(printf, 2, 3)));
+        virtual int _putc(int c) { return 1; }
+        virtual int _getc(void) { return 0; }
+        virtual int puts(const char* str) = 0;
+        virtual bool ready() { return true; };
+
+        static NullStreamOutput NullStream;
+};
+
+class NullStreamOutput : public StreamOutput {
+    public:
+        int puts(const char* str) { return strlen(str); }
 };
 
 #endif