src/libs/StreamOutput.h

   1 /*
   2       This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
   3       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.
   4       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.
   5       You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
   6 */
   7
   8 #ifndef STREAMOUTPUT_H
   9 #define STREAMOUTPUT_H
  10
  11 #include <cstdarg>
  12 #include <cstring>
  13 #include <stdio.h>
  14
  15 // This is a base class for all StreamOutput objects.
  16 // StreamOutputs are basically "things you can sent strings to". They are passed along with gcodes for example so modules can answer to those gcodes.
  17 // They are usually associated with a command source, but can also be a NullStreamOutput if we just want to ignore whatever is sent
  18
  19 class NullStreamOutput;
  20
  21 class StreamOutput {
  22     public:
  23         StreamOutput(){}
  24         virtual ~StreamOutput(){}
  25
  26         virtual int printf(const char *format, ...) __attribute__ ((format(printf, 2, 3)));
  27         virtual int _putc(int c) { return 1; }
  28         virtual int _getc(void) { return 0; }
  29         virtual int puts(const char* str) = 0;
  30         virtual bool ready() { return true; };
  31
  32         static NullStreamOutput NullStream;
  33 };
  34
  35 class NullStreamOutput : public StreamOutput {
  36     public:
  37         int puts(const char* str) { return strlen(str); }
  38 };
  39
  40 #endif