std::queueは、ブロック単位でのメモリ確保を行い動的にキューのサイズを拡張していきますが、本クラスではメモリサイズを抑制し固定長のキューを実装します。

本クラスはstd::queueを継承しています。

バッファのブロックサイズ

GCCの場合はバッファのブロックサイズを定義することができます。

本ライブラリでの利用を想定し以下のように64バイトにしています。

メソッド

FixedQueue() - コンストラクタ

sizeを最大値としてキューを生成します。

push()

キューに要素を追加します。キューが一杯になると何もせずfalseを返します。

pop()

キューから要素を削除します。

front()

要素にアクセスします。

empty()

キューが空の場合trueを返します。

typedef SimpleBuffer<uint8_t> SmplBuf_Byte;

uint8_t型のSimpleBufferです。

可変長の配列ですが、最大長は固定の配列クラスです。

template <class T>
class SimpleBuffer { ... };

配列のメモリは、外部の固定バッファを参照する方法と、内部にコストラクタで確保する方法の２種類があります。

メソッド

SimpleBuffer() - コストラクタ

SimpleBuffer()
SimpleBuffer(T* p, uint16_t u16len, uint16_t u16maxlen)
SimpleBuffer(uint16_t u16maxlen)

パラメータなしのコンストラクタは、バッファ未登録として初期化します。バッファが未登録の場合はlength_max()が0になります。このオブジェクトを配列として利用するにはattach()メソッドにより改めてバッファを登録する必要があります。

外部のバッファを参照する場合は、バッファへのポインタp、配列の初期長u16len、配列の最大長u16maxlenを指定します。

メモリを動的確保するにはu16maxlenのみを指定するコンストラクタを呼び出します。

代入演算子、コピーコンストラクタ

SimpleBuffer(const SimpleBuffer<T>& ref)
SimpleBuffer<T>& operator = (const SimpleBuffer<T>& ref)

コピー元が、外部メモリ参照の場合は、コピー元の参照先をそのままコピーします。

コピー元が、内部にメモリ確保している場合は、コピー元のメモリ領域をそのまま利用します。新たにメモリのコピーを作成するわけではありません。本クラスでの内部確保したメモリは、スマートポインタshared_ptrで管理されます。コピー先とコピー元すべてのオブジェクトが破棄された時点で、メモリ領域を破棄します。

attach()

void attach(T* p, uint16_t l, uint16_t lm)

配列の参照先を再設定します。

SimpleBuffer<uint8_t> buf(128), buf_sub;

buf_sub = buf;
buf_sub.attach(buf.begin() + 16, 0, buf.max_length() - 16);

begin(), end()

T* begin()
T* end()

配列の先頭ポインタ、末尾＋１のアドレスのポインタを返します。STLのアルゴリズムや範囲for文などで利用されます。

配列バッファの先頭ポインタを得るときにbegin()を用います。

append()

⇒push_back()

push_back()

bool append(T c)
void push_back(T c) { append(c); }

配列の末尾に要素を追加します。要素が追加できないときはfalseが戻ります。

length(), length_max()

⇒size(), capacity()

size(), capacity()

uint16_t length()
uint16_t size() { return length(); }

uint16_t length_max()
uint16_t capacity() { return length_max(); }

size()は配列の長さ、capacity()は配列の最大長を返します。

redim()

⇒reserve()

reserve()

bool redim(uint16_t len)
bool reserve(uint16_t len) { return redim(len); }

配列の長さを変更します。現在の長さより大きくなる場合は要素型Tのデフォルトの初期化方法T{}にて初期化されます。数値型なら0です。

operator []

inline T& operator [] (int i)

配列へのアクセス手段を提供します。

インデックスiは、負の値の場合は配列の末尾からのインデックスとなります。-1が末尾になります。

printf, sprintfに対応する処理を行います。

printfmt

ストリームIStreamOutオブジェクトに対して<<演算子の右オペランドとして利用します。

printfmt(const char*fmt, ...)
ISteramOut& operator << (IStreamOut& strm, printfmt f)

//例
  the_screen << printfmt("%04X", 0x12ab) << crlf;

printfmtクラスのコストラクタのパラメータの１番目fmtに書式を指定します。以降のパラメータはC++テンプレートのパラメータパックで実装されており可変数引数となっています。printfのように書式に対応した引数を指定します。printfと違い引数の数は最大４つに制限されます。

fPrintf()

ストリームIStreamOutオブジェクトを出力先としてfprintfと同じ処理を行います。

int fPrintf(TWE::IStreamOut& fp, const char* format, ...)

１番目の引数がストリームオブジェクトとなる点を除きfprintfと同じ使い方です。

snPrintf()

snprintfの処理を行います。

int snPrintf(char* buffer, size_t count, const char* format, ...)

本クラスは namespace TWE 内に定義されています。

出力ストリームの基底クラスで、以下のメソッドが定義されており、１バイトの出力、改行文字など特殊クラスを受け付けるためのメソッドが定義されています。

virtual inline IStreamOut& operator ()(char_t c) = 0
virtual inline IStreamOut& write_w(wchar_t c)

operator () はchar_t型の１文字を出力するための仮想関数です。write_w()はwchar_t型の出力に対応します。

ストリームへの出力は<<演算子を用います。最終的には上記の出力用の関数が呼び出されます。

以下の例はITermクラスでの実装例です。

class ITerm : public TWE::IStreamOut {
  // ... 各種定義
  
  ITerm& write(char_t c) {
    // ... １バイト入力を受け付ける処理
  }
  
  // StreamOut::operator () の実装
  TWE::IStreamOut& operator ()(char_t c) {
    write(c);
    return *this;
  }
};

operator <<

inline IStreamOut& operator << (char_t c)
inline IStreamOut& operator << (wchar_t c)
inline IStreamOut& operator << (IStreamSpecial& sc)

operator << の右オペランドとして以下の型に対応します。

inline ITerm& operator << (ITerm& t, char_t c)
   { *static_cast<TWE::IStreamOut*>(&t) << c; return t; } 

IStreamSpecial

特殊な文字列などを指定するためのオブジェクトを定義するための基底クラスです。

class IStreamSpecial {
	public:
		virtual inline IStreamOut& operator ()(IStreamOut& of) = 0;
};

派生クラスとして CR LF (0x0d 0x0a) を出力する IStream_endl が定義されています。

class IStream_endl : public IStreamSpecial {
  inline IStreamOut& operator ()(IStreamOut& of) { 
    // ... CR LF の出力
    of ('\r');
    of ('\n');
  }
};

IStream_endl crlf;

オブジェクトcrlfは以下のように使用します。

the_screen << "Hello World!" << crlf;