Program Listing for File serial_stream.h

↰ Return to documentation for file (src/serial_stream.h)

// BSD 3-Clause License
//
// Copyright (c) 2024, Ekumen Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#pragma once

#include <stdio.h>

namespace andino {

class SerialStream {
 public:
  enum Base {
    kBin = 2,
    kOct = 8,
    kDec = 10,
    kHex = 16,
  };

  explicit SerialStream() = default;

  virtual ~SerialStream() = default;

  virtual void begin(unsigned long baud) const = 0;

  virtual int available() const = 0;

  virtual int read() const = 0;

  virtual size_t print(const char* c) const = 0;

  virtual size_t print(char c) const = 0;

  virtual size_t print(unsigned char b, int base = kDec) const = 0;

  virtual size_t print(int num, int base = kDec) const = 0;

  virtual size_t print(unsigned int num, int base = kDec) const = 0;

  virtual size_t print(long num, int base = kDec) const = 0;

  virtual size_t print(unsigned long num, int base = kDec) const = 0;

  virtual size_t print(double num, int digits = 2) const = 0;

  virtual size_t println(const char* c) const = 0;

  virtual size_t println(char c) const = 0;

  virtual size_t println(unsigned char b, int base = kDec) const = 0;

  virtual size_t println(int num, int base = kDec) const = 0;

  virtual size_t println(unsigned int num, int base = kDec) const = 0;

  virtual size_t println(long num, int base = kDec) const = 0;

  virtual size_t println(unsigned long num, int base = kDec) const = 0;

  virtual size_t println(double num, int digits = 2) const = 0;
};

}  // namespace andino