SafeInt クラス

[アーティクル]
06/16/2023

整数オーバーフローを防ぐことができるように整数のプリミティブを拡張し、さまざまな種類の整数を比較してみましょう。

Note

最新バージョンの SafeInt ライブラリは https://github.com/dcleblanc/SafeInt にあります。 SafeInt ライブラリを使用するには、リポジトリと #include "SafeInt.hpp" を複製します。

構文

template<typename T, typename E = _SAFEINT_DEFAULT_ERROR_POLICY>
class SafeInt;

パラメーター

T
SafeInt で置き換えられる整数またはブール値パラメーターの型。

E
エラー処理ポリシーを定義する列挙データ型。

U
第 2 オペランドの整数またはブール値パラメーターの型。

rhs
[in] いくつかのスタンドアロン関数で演算子の右側にある値を表す入力パラメーター。

i
[in] いくつかのスタンドアロン関数で演算子の右側にある値を表す入力パラメーター。

bits
[in] いくつかのスタンドアロン関数で演算子の右側にある値を表す入力パラメーター。

メンバー

パブリックコンストラクター

名前	説明
SafeInt::SafeInt	既定のコンストラクターです。

代入演算子

Name	構文
=	`template<typename U>` `SafeInt<T,E>& operator= (const U& rhs)`
=	`SafeInt<T,E>& operator= (const T& rhs) throw()`
=	`template<typename U>` `SafeInt<T,E>& operator= (const SafeInt<U, E>& rhs)`
=	`SafeInt<T,E>& operator= (const SafeInt<T,E>& rhs) throw()`

キャスト演算子

Name	構文
[bool]	`operator bool() throw()`
char	`operator char() const`
signed char	`operator signed char() const`
符号なし文字	`operator unsigned char() const`
__int16	`operator __int16() const`
unsigned __int16	`operator unsigned __int16() const`
__int32	`operator __int32() const`
unsigned __int32	`operator unsigned __int32() const`
long	`operator long() const`
unsigned long	`operator unsigned long() const`
__int64	`operator __int64() const`
unsigned __int64	`operator unsigned __int64() const`
wchar_t	`operator wchar_t() const`

比較演算子

Name	構文
<	`template<typename U>` `bool operator< (U rhs) const throw()`
<	`bool operator< (SafeInt<T,E> rhs) const throw()`
>=	`template<typename U>` `bool operator>= (U rhs) const throw()`
>=	`Bool operator>= (SafeInt<T,E> rhs) const throw()`
>	`template<typename U>` `bool operator> (U rhs) const throw()`
>	`Bool operator> (SafeInt<T,E> rhs) const throw()`
<=	`template<typename U>` `bool operator<= (U rhs) const throw()`
<=	`bool operator<= (SafeInt<T,E> rhs) const throw()`
==	`template<typename U>` `bool operator== (U rhs) const throw()`
==	`bool operator== (bool rhs) const throw()`
==	`bool operator== (SafeInt<T,E> rhs) const throw()`
!=	`template<typename U>` `bool operator!= (U rhs) const throw()`
!=	`bool operator!= (bool b) const throw()`
!=	`bool operator!= (SafeInt<T,E> rhs) const throw()`

算術演算子

Name	構文
+	`const SafeInt<T,E>& operator+ () const throw()`
-	`SafeInt<T,E> operator- () const`
++	`SafeInt<T,E>& operator++ ()`
--	`SafeInt<T,E>& operator-- ()`
%	`template<typename U>` `SafeInt<T,E> operator% (U rhs) const`
%	`SafeInt<T,E> operator% (SafeInt<T,E> rhs) const`
%=	`template<typename U>` `SafeInt<T,E>& operator%= (U rhs)`
%=	`template<typename U>` `SafeInt<T,E>& operator%= (SafeInt<U, E> rhs)`
*	`template<typename U>` `SafeInt<T,E> operator* (U rhs) const`
*	`SafeInt<T,E> operator* (SafeInt<T,E> rhs) const`
*=	`SafeInt<T,E>& operator*= (SafeInt<T,E> rhs)`
*=	`template<typename U>` `SafeInt<T,E>& operator*= (U rhs)`
*=	`template<typename U>` `SafeInt<T,E>& operator*= (SafeInt<U, E> rhs)`
/	`template<typename U>` `SafeInt<T,E> operator/ (U rhs) const`
/	`SafeInt<T,E> operator/ (SafeInt<T,E> rhs ) const`
/=	`SafeInt<T,E>& operator/= (SafeInt<T,E> i)`
/=	`template<typename U>` `SafeInt<T,E>& operator/= (U i)`
/=	`template<typename U>` `SafeInt<T,E>& operator/= (SafeInt<U, E> i)`
+	`SafeInt<T,E> operator+ (SafeInt<T,E> rhs) const`
+	`template<typename U>` `SafeInt<T,E> operator+ (U rhs) const`
+=	`SafeInt<T,E>& operator+= (SafeInt<T,E> rhs)`
+=	`template<typename U>` `SafeInt<T,E>& operator+= (U rhs)`
+=	`template<typename U>` `SafeInt<T,E>& operator+= (SafeInt<U, E> rhs)`
-	`template<typename U>` `SafeInt<T,E> operator- (U rhs) const`
-	`SafeInt<T,E> operator- (SafeInt<T,E> rhs) const`
-=	`SafeInt<T,E>& operator-= (SafeInt<T,E> rhs)`
-=	`template<typename U>` `SafeInt<T,E>& operator-= (U rhs)`
-=	`template<typename U>` `SafeInt<T,E>& operator-= (SafeInt<U, E> rhs)`

論理演算子

Name	構文
!	`bool operator !() const throw()`
~	`SafeInt<T,E> operator~ () const throw()`
<<	`template<typename U>` `SafeInt<T,E> operator<< (U bits) const throw()`
<<	`template<typename U>` `SafeInt<T,E> operator<< (SafeInt<U, E> bits) const throw()`
<<=	`template<typename U>` `SafeInt<T,E>& operator<<= (U bits) throw()`
<<=	`template<typename U>` `SafeInt<T,E>& operator<<= (SafeInt<U, E> bits) throw()`
>>	`template<typename U>` `SafeInt<T,E> operator>> (U bits) const throw()`
>>	`template<typename U>` `SafeInt<T,E> operator>> (SafeInt<U, E> bits) const throw()`
>>=	`template<typename U>` `SafeInt<T,E>& operator>>= (U bits) throw()`
>>=	`template<typename U>` `SafeInt<T,E>& operator>>= (SafeInt<U, E> bits) throw()`
&	`SafeInt<T,E> operator& (SafeInt<T,E> rhs) const throw()`
&	`template<typename U>` `SafeInt<T,E> operator& (U rhs) const throw()`
&=	`SafeInt<T,E>& operator&= (SafeInt<T,E> rhs) throw()`
&=	`template<typename U>` `SafeInt<T,E>& operator&= (U rhs) throw()`
&=	`template<typename U>` `SafeInt<T,E>& operator&= (SafeInt<U, E> rhs) throw()`
^	`SafeInt<T,E> operator^ (SafeInt<T,E> rhs) const throw()`
^	`template<typename U>` `SafeInt<T,E> operator^ (U rhs) const throw()`
^=	`SafeInt<T,E>& operator^= (SafeInt<T,E> rhs) throw()`
^=	`template<typename U>` `SafeInt<T,E>& operator^= (U rhs) throw()`
^=	`template<typename U>` `SafeInt<T,E>& operator^= (SafeInt<U, E> rhs) throw()`
\|	`SafeInt<T,E> operator\| (SafeInt<T,E> rhs) const throw()`
\|	`template<typename U>` `SafeInt<T,E> operator\| (U rhs) const throw()`
\|=	`SafeInt<T,E>& operator\|= (SafeInt<T,E> rhs) throw()`
\|=	`template<typename U>` `SafeInt<T,E>& operator\|= (U rhs) throw()`
\|=	`template<typename U>` `SafeInt<T,E>& operator\|= (SafeInt<U, E> rhs) throw()`

解説

SafeInt クラスは、数学演算での整数オーバーフローを防ぎます。たとえば、2 つの 8 ビット整数を追加するとします。1 つは値が 200 であり、2 つ目は値が 100 です。正しい数学演算は 200 + 100 = 300 です。ただし、8 ビット整数の制限があるため、上位ビットは失われ、結果としてコンパイラから 44 (300 - 2⁸) が返されます。この数式に依存するすべての演算では、予期しない動作が起こります。

SafeInt クラスでは、算術オーバーフローが発生するかどうか、またはコードがゼロ除算を試行しているかどうかが確認されます。いずれの場合も、クラスからエラーハンドラーが呼び出され、プログラムに潜在的な問題が警告されます。

このクラスを使用すると、SafeInt オブジェクトである限り、2 種類の整数を比較することもできます。通常、比較をするときは、最初に数値を同じ型に変換する必要があります。ある数値を別の型にキャストするには、多くの場合、データの損失がないことを確認するチェックが必要です。

このトピックの「演算子」一覧には、SafeInt クラスでサポートされている数学演算子と比較演算子がまとめられています。ほとんどの数学演算子からは、型が T の SafeInt オブジェクトが返されます。

SafeInt と整数型との比較演算は、いずれの方向でも実行できます。たとえば、SafeInt<int>(x) < y と y> SafeInt<int>(x) はどちらも有効であり、同じ結果が返されます。

多くの二項演算子は、2 つの異なる SafeInt 型の使用をサポートしません。その一例は & 演算子です。 SafeInt<T, E> & int はサポートされますが、SafeInt<T, E> & SafeInt<U, E> がサポートされていません。後者の例では、コンパイラはどの型のパラメーターを返すべきかを認識していません。この問題の解決策の 1 つは、2 つ目のパラメーターを基本データ型にキャストすることです。同じパラメーターを使用して、SafeInt<T, E> & (U)SafeInt<U, E> でこれを実行できます。

Note

どのようなビットごとの演算でも、2 つの異なるパラメーターのサイズを同じにする必要があります。サイズが異なると、コンパイラからは ASSERT 例外がスローされます。この演算の結果が正確であることは保証できません。この問題を解決するには、大きい方のパラメーターと同じサイズになるまで小さい方のパラメーターをキャストします。

シフト演算子の場合、そのテンプレート型に存在するよりも多くのビットをシフトすると、ASSERT 例外がスローされます。これはリリースモードには影響しません。戻り値の型は元の型と同じなので、シフト演算子には 2 つの型の SafeInt パラメーターを混在させることができます。演算子の右側側にある数値は、単にシフトするビット数を示しています。

SafeInt オブジェクトを使用して論理比較を実行すると、比較は厳密には算術演算になります。たとえば、以下の式があるとします。

SafeInt<uint>((uint)~0) > -1
((uint)~0) > -1

1 つ目のステートメントは true に解決されますが、2 つ目のステートメントは false に解決されます。 0 のビットごとの否定は 0xFFFFFFFF です。 2 つ目のステートメントでは、既定の比較演算子によって 0xFFFFFFFF と 0xFFFFFFFF が比較され、それらが等しいと見なされます。 SafeInt クラスの比較演算子は、2 つ目のパラメーターが負であり、1 つ目のパラメーターは符号なしであると認識しています。そのため、ビット表現は同じですが、SafeInt 論理演算子は、符号なし整数が -1 よりも大きいと認識しています。

SafeInt クラスを ?: 三項演算子と組み合わせて使用するときは注意してください。次のコード行があるとします。

Int x = flag ? SafeInt<unsigned int>(y) : -1;

コンパイラでは、これが次のように変換されます。

Int x = flag ? SafeInt<unsigned int>(y) : SafeInt<unsigned int>(-1);

flag が false の場合、-1 の値が x に割り当てられるのではなく、コンパイラから例外がスローされます。そのため、この動作を回避するには、次の行のように正しいコードを使用します。

Int x = flag ? (int) SafeInt<unsigned int>(y) : -1;

T と U には、ブール型、文字型、または整数型を割り当てることができます。整数型は、符号付きまたは符号なしで、8 ビットから 64 ビットの任意のサイズにすることができます。

Note

SafeInt クラスはあらゆる種類の整数を受け取りますが、符号なしの型を使用するとより効率的に実行されます。

E は、SafeInt で使用されるエラー処理メカニズムです。 SafeInt ライブラリには、2 つのエラー処理メカニズムが用意されています。既定のポリシーは SafeIntErrorPolicy_SafeIntException であり、エラーが発生したときに SafeIntException クラス例外がスローされます。もう 1 つのポリシーは SafeIntErrorPolicy_InvalidParameter であり、エラーが発生した場合にプログラムが停止されます。

エラーポリシーをカスタマイズするオプションは 2 つあります。 1 つ目のオプションは、SafeInt を作成するときにパラメーター E を設定することです。エラー処理ポリシーを 1 つの SafeInt のみに変更する場合は、このオプションを使用します。もう 1 つのオプションは、SafeInt ライブラリを組み込む前に、カスタマイズされたエラー処理クラスとして _SAFEINT_DEFAULT_ERROR_POLICY を定義することです。コード内の SafeInt クラスのすべてのインスタンスで既定のエラー処理ポリシーを変更する場合は、このオプションを使用します。

Note

SafeInt ライブラリからのエラーを処理するカスタマイズされたクラスでは、エラーハンドラーを呼び出したコードに制御が返されません。エラーハンドラーが呼び出された後の SafeInt 演算の結果は信頼できません。

継承階層

SafeInt

要件

ヘッダー: SafeInt.hpp

Note

このライブラリの最新バージョンは https://github.com/dcleblanc/SafeInt にあります。ライブラリを複製し、SafeInt ライブラリを使用するための SafeInt.hpp をインクルードします。 safeint.h>を<するには、この GitHub リポジトリを使用します。これは最新バージョンの<safeint.h> です。中に少数のバグ修正が含まれており、最新の C++ 機能を使用するため、コードがより効率的になり、gcc、clang、または Intel コンパイラを使用してあらゆるプラットフォームに移植できます。

例

#include "SafeInt.hpp" // set path to your clone of the SafeInt GitHub repo (https://github.com/dcleblanc/SafeInt)

int main()
{
    int divisor = 3;
    int dividend = 6;
    int result;

    bool success = SafeDivide(dividend, divisor, result); // result = 2
    success = SafeDivide(dividend, 0, result); // expect fail. result isn't modified.
}

名前空間: なし

SafeInt::SafeInt

SafeInt オブジェクトを構築します。

SafeInt() throw

SafeInt (const T& i) throw ()

SafeInt (bool b) throw ()

template <typename U>
SafeInt (const SafeInt <U, E>& u)

I template <typename U>
SafeInt (const U& i)

パラメーター

i
[in] 新しい SafeInt オブジェクトの値。これは、コンストラクターに応じて、型 T または U のパラメーターにする必要があります。

b
[in] 新しい SafeInt オブジェクトのブール値。

u
[in] 型 U の SafeInt。新しい SafeInt オブジェクトは、u と同じ値になりますが、型は T になります。

U SafeInt に格納されているデータの型。ブール型、文字型、または整数型のいずれかを使用できます。整数型の場合は、符号付きまたは符号なしの 8 ビットから 64 ビットを使用できます。

解説

コンストラクターの入力パラメーター i または u は、ブール型、文字型、または整数型にする必要があります。これが異なる型のパラメーターの場合、SafeInt クラスから static_assert が呼び出され、無効な入力パラメーターが示されます。

テンプレート型 U を使用するコンストラクターでは、入力パラメーターが T に指定された型に自動的に変換されます。 SafeInt クラスでは、データの損失なしでデータが変換されます。データの損失なしでデータを型 T に変換できない場合、エラーハンドラーに E が報告されます。

ブール値パラメーターから SafeInt を作成した場合は、すぐに値を初期化する必要があります。コード SafeInt<bool> sb; を使用して SafeInt を構築することはできません。その結果、コンパイルエラーが発生します。

次の方法で共有

SafeInt クラス

構文

パラメーター

メンバー

パブリックコンストラクター

代入演算子

キャスト演算子

比較演算子

算術演算子

論理演算子

解説

継承階層

要件

例

SafeInt::SafeInt

パラメーター

解説

フィードバック

その他のリソース

次の方法で共有

SafeInt クラス

構文

パラメーター

メンバー

パブリック コンストラクター

代入演算子

キャスト演算子

比較演算子

算術演算子

論理演算子

解説

継承階層

要件

例

SafeInt::SafeInt

パラメーター

解説

フィードバック

その他のリソース

パブリックコンストラクター