ByteBuffer.h

 
#ifndef MFRAME_C76BAF3F_EE1F_46A3_A050_9CD1057055E5
#define MFRAME_C76BAF3F_EE1F_46A3_A050_9CD1057055E5
 
/* ***************************************************************************************
 * Include
 */
 
//----------------------------------------------------------------------------------------
 
//----------------------------------------------------------------------------------------
#include "./../io/Buffer.h"
#include "./../lang/Memory.h"
#include "./../lang/Strings.h"
 
/* ***************************************************************************************
 * Namespace
 */
namespace ufm::io {
  class ByteBuffer;
}  // namespace ufm::io
 
/* ***************************************************************************************
 * Class/Interface/Struct
 */
 
class ufm::io::ByteBuffer : public ufm::lang::Object,
                            public ufm::lang::Appendable,
                            public ufm::lang::Readable,
                            public ufm::io::Buffer {
  /* *************************************************************************************
   *  Variable
   */
 protected:
  ufm::lang::Memory vMemory;
  int               vPosition;
  int               vMark;
  int               vLimit;
 
  /* *************************************************************************************
   *  Abstract Method
   */
 
  /* *************************************************************************************
   *  Construct Method
   */
 public:
  ByteBuffer(ufm::lang::Memory memory) noexcept;
 
  inline ByteBuffer(int length) : ByteBuffer(ufm::lang::Memory(length)) {
    return;
  }
 
  inline ByteBuffer(void* pointer, int length)
      : ByteBuffer(ufm::lang::Memory(pointer, length)) {
    return;
  }
 
  virtual ~ByteBuffer(void) override;
 
  /* *************************************************************************************
   * Operator Method
   */
 public:
  inline ByteBuffer& operator<<(char c) {
    this->putByte(c);
    return *this;
  }
 
  inline ByteBuffer& operator<<(short s) {
    this->putShort(s);
    return *this;
  }
 
  inline ByteBuffer& operator<<(int v) {
    this->putInt(v);
    return *this;
  }
 
  inline ByteBuffer& operator<<(const char* string) {
    this->put(string);
    return *this;
  }
 
  inline ByteBuffer& operator<<(ufm::lang::Strings& string) {
    this->put(string);
    return *this;
  }
 
  inline int operator=(int v) {
    this->position(v);
    return this->position();
  }
 
  inline void operator+=(int shift) {
    this->position(this->position() + shift);
  }
 
  inline void operator-=(int shift) {
    this->position(this->position() - shift);
  }
 
  inline uint32 operator++(void) {
    this->position(this->position() + 1);
    return static_cast<uint32>(this->position());
  }
 
  inline uint32 operator--(void) {
    this->position(this->position() - 1);
    return static_cast<uint32>(this->position());
  }
 
  inline uint32 operator++(int) {
    uint32 result = static_cast<uint32>(this->position());
    this->position(this->position() + 1);
    return result;
  }
 
  inline uint32 operator--(int) {
    uint32 result = static_cast<uint32>(this->position());
    this->position(this->position() - 1);
    return result;
  }
 
  /* *************************************************************************************
   * Override Method - ufm::io::Buffer
   */
 public:
  virtual void clear(void) override;
 
  virtual ufm::lang::Readable& getReadable(void) override;
 
  virtual ufm::lang::Appendable& getAppendable(void) override;
 
  /* *************************************************************************************
   * Override Method - ufm::lang::Readable
   */
 public:
  virtual int avariable(void) const override;
 
  virtual int pollByte(char& result) override;
 
  virtual int poll(ufm::lang::Appendable& appendable) override;
 
  virtual int poll(void* pointer, int length) override;
 
  /* *************************************************************************************
   * Override Method - ufm::lang::Iterable<const char>
   */
 public:
  virtual void forEach(ufm::func::Consumer<const char&>& action) override;
 
  virtual const char* elementAt(int index) const override;
 
  virtual int nextIndex(int index) const override;
 
  virtual ufm::util::Iterator<const char> begin(void) override;
 
  virtual ufm::util::Iterator<const char> end(void) override;
 
  /* *************************************************************************************
   * Override Method - ufm::lang::Appendable
   */
 public:
  virtual int remaining(void) const override;
 
  virtual int putByte(const char data) override;
 
  virtual int put(ufm::lang::Readable& readable) override;
 
  virtual int put(const void* pointer, int length) override;
 
  /* *************************************************************************************
   * Public Method
   */
 public:
  inline int limit(void) const {
    return this->vLimit;
  }
 
  inline int capacity(void) const {
    return this->vMemory.length();
  }
 
  inline int position(void) const {
    return this->vPosition;
  }
 
  inline ByteBuffer& reset(void) {
    this->position(this->vMark);
    return *this;
  }
 
  inline ByteBuffer& mark(void) {
    this->vMark = vPosition;
    return *this;
  }
 
  inline ByteBuffer& rewind(void) {
    this->vPosition = 0;
    this->vMark     = 0;
    return *this;
  }
 
  inline bool pollByte(uint8& result) {
    return this->pollByte(reinterpret_cast<char&>(result));
  }
 
  inline bool pollShort(uint16& result) {
    return this->pollShort(reinterpret_cast<short&>(result));
  }
 
  inline bool pollInt(uint32& result) {
    return this->pollInt(reinterpret_cast<int&>(result));
  }
 
  inline ufm::lang::Memory& memory(void) {
    return this->vMemory;
  }
 
  bool limit(int newLimit);
 
  bool position(int newPosition);
 
  void flip(void);
 
  void move(int position);
 
  bool put(const char* string);
 
  bool put(const ufm::lang::Strings& string);
 
  int putFormat(const char* format, ...);
 
  int putFormat(const char* format, va_list args);
 
  bool putShort(const short value);
 
  bool putInt(const int value);
 
  bool putFloat(const float value);
 
  bool pollShort(short& result);
 
  bool pollInt(int& result);
 
  bool pollFloat(float& result);
 
  /* *************************************************************************************
   * Protected Method
   */
 
  /* *************************************************************************************
   * Private Method
   */
 
  /* *************************************************************************************
   * Static Variable
   */
 
  /* *************************************************************************************
   * Static Method
   */
};
 
/* ***************************************************************************************
 *    End of file
 */
 
#endif /* MFRAME_C76BAF3F_EE1F_46A3_A050_9CD1057055E5 */