ardupilot/libraries/AP_HAL/utility/BetterStream.h

59 lines
2.0 KiB
C++

/*
This program 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.
This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
//
// Copyright (c) 2010 Michael Smith. All rights reserved.
//
//
#pragma once
#include <AP_Common/AP_Common.h>
#include <AP_HAL/AP_HAL_Namespace.h>
#include <stdarg.h>
#include <unistd.h>
class AP_HAL::BetterStream {
public:
virtual void printf(const char *, ...) FMT_PRINTF(2, 3);
virtual void vprintf(const char *, va_list);
void print(const char *str) { write(str); }
void println(const char *str) { printf("%s\r\n", str); }
virtual size_t write(uint8_t) = 0;
virtual size_t write(const uint8_t *buffer, size_t size) = 0;
size_t write(const char *str);
virtual uint32_t available() = 0;
int16_t read(); // old function; prefer calling the boolean method
virtual bool read(uint8_t &b) WARN_IF_UNUSED = 0;
// no base-class implementation to force descendants to
// do things efficiently. Looping over 2^32-1 bytes would be bad.
// returns false if discard failed (e.g. port locked)
virtual bool discard_input() = 0; // discard all bytes available for reading
// returns -1 on error (e.g. port locked), number of bytes read
// otherwise
virtual ssize_t read(uint8_t *buffer, uint16_t count);
/* NB txspace was traditionally a member of BetterStream in the
* FastSerial library. As far as concerns go, it belongs with available() */
virtual uint32_t txspace() = 0;
};