Browse Source

AP_HAL: add WARN_IF_UNUSED to several methods

c415-sdk
Peter Barker 5 years ago committed by Randy Mackay
parent
commit
85b1264ff4
  1. 24
      libraries/AP_HAL/utility/RingBuffer.h

24
libraries/AP_HAL/utility/RingBuffer.h

@ -24,7 +24,7 @@ public: @@ -24,7 +24,7 @@ public:
uint32_t space(void) const;
// true if available() is zero
bool is_empty(void) const;
bool is_empty(void) const WARN_IF_UNUSED;
// write bytes to ringbuffer. Returns number of bytes written
uint32_t write(const uint8_t *data, uint32_t len);
@ -33,7 +33,7 @@ public: @@ -33,7 +33,7 @@ public:
uint32_t read(uint8_t *data, uint32_t len);
// read a byte from ring buffer. Returns true on success, false otherwise
bool read_byte(uint8_t *data);
bool read_byte(uint8_t *data) WARN_IF_UNUSED;
/*
update bytes at the read pointer. Used to update an object without
@ -142,7 +142,7 @@ public: @@ -142,7 +142,7 @@ public:
// true is available() == 0
// !!! Note ObjectBuffer_TS is a duplicate of this update, in both places !!!
bool is_empty(void) const {
bool is_empty(void) const WARN_IF_UNUSED {
return buffer->is_empty();
}
@ -176,7 +176,7 @@ public: @@ -176,7 +176,7 @@ public:
pop earliest object off the front of the queue
*/
// !!! Note ObjectBuffer_TS is a duplicate of this update, in both places !!!
bool pop(T &object) {
bool pop(T &object) WARN_IF_UNUSED {
if (buffer->available() < sizeof(T)) {
return false;
}
@ -212,7 +212,7 @@ public: @@ -212,7 +212,7 @@ public:
peek copies an object out from the front of the queue without advancing the read pointer
*/
// !!! Note ObjectBuffer_TS is a duplicate of this update, in both places !!!
bool peek(T &object) {
bool peek(T &object) WARN_IF_UNUSED {
return buffer->peekbytes((uint8_t*)&object, sizeof(T)) == sizeof(T);
}
@ -309,7 +309,7 @@ public: @@ -309,7 +309,7 @@ public:
// true is available() == 0
// !!! Note this is a duplicate of ObjectBuffer with semaphore, update in both places !!!
bool is_empty(void) {
bool is_empty(void) WARN_IF_UNUSED {
WITH_SEMAPHORE(sem);
return buffer->is_empty();
}
@ -347,7 +347,7 @@ public: @@ -347,7 +347,7 @@ public:
pop earliest object off the front of the queue
*/
// !!! Note this is a duplicate of ObjectBuffer with semaphore, update in both places !!!
bool pop(T &object) {
bool pop(T &object) WARN_IF_UNUSED {
WITH_SEMAPHORE(sem);
if (buffer->available() < sizeof(T)) {
return false;
@ -385,7 +385,7 @@ public: @@ -385,7 +385,7 @@ public:
peek copies an object out from the front of the queue without advancing the read pointer
*/
// !!! Note this is a duplicate of ObjectBuffer with semaphore, update in both places !!!
bool peek(T &object) {
bool peek(T &object) WARN_IF_UNUSED {
WITH_SEMAPHORE(sem);
return buffer->peekbytes((uint8_t*)&object, sizeof(T)) == sizeof(T);
}
@ -459,7 +459,7 @@ public: @@ -459,7 +459,7 @@ public:
}
// true is available() == 0
bool is_empty(void) const {
bool is_empty(void) const WARN_IF_UNUSED {
return _count == 0;
}
@ -476,7 +476,7 @@ public: @@ -476,7 +476,7 @@ public:
/*
throw away an object
*/
bool pop(void) {
bool pop(void) WARN_IF_UNUSED {
if (is_empty()) {
return false;
}
@ -494,7 +494,7 @@ public: @@ -494,7 +494,7 @@ public:
/*
pop earliest object off the queue
*/
bool pop(T &object) {
bool pop(T &object) WARN_IF_UNUSED {
if (is_empty()) {
return false;
}
@ -509,7 +509,7 @@ public: @@ -509,7 +509,7 @@ public:
*/
bool push_force(const T &object) {
if (space() == 0) {
pop();
UNUSED_RESULT(pop());
}
return push(object);
}

Loading…
Cancel
Save