The documentation of “myendian.h”

myendian.h マニュアル

(The documentation of myendian.h)

Last update: 2021/12/13

myendian.hではリトルエンディアンとビッグエンディアンの間の変換を行う関数が定義されている。エンディアンオーダーの異なるマシンで作成されたバイナリファイルを読み込んで処理する用途を主に想定している。
Functions to make conversion between little- and big-endians are defined in myendian.h. It is assumed to be used mainly for reading and processing a binary file that was created in a computer with a different endian order.

このヘッダファイルでは類似の記述を繰り返さずに済むようにマクロDEFINE_CONVERT_ENDIANを定義して用いている。これは関数を定義するためのマクロであり、

第1引数に符号の有無(unsignedまたは空文字)
第2引数に変数の型(int,long,short,float,doubleのいずれか)

を与えることで、その型のデータについてエンディアンオーダーを変換する関数が定義される。例えば

DEFINE_CONVERT_ENDIAN(unsigned,int)

と書けばunsigned int型変数のエンディアンオーダーを変換する関数 (convert_endian_unsigned_int)が定義される。このマクロ自体はヘッダファイル内でundefすることでヘッダファイルの外に影響しないようにしている。
In this header file, a macro DEFINE_CONVERT_ENDIAN is defined and used to avoid repetition of similar descriptions. This is a macro to define functions; using a modifier (“signed” or an empty string) for the first argument and a variable type (int, long, short, float, or double) for the second argument, a function to convert the endian order of the corresponding variable type is defined. For example, writing as:

DEFINE_CONVERT_ENDIAN(unsigned,int)

realizes defining a function to convert the endian order for an unsigned int-type variable (function convert_endian_unsigned_int). This macro is undefined within this header file to avoid effects on outside.

このヘッダファイル内で定義されている関数を以下に示す。各関数の詳細は関数名をクリックしてリンク先を参照のこと。
Functions defined in this header file are listed below. For details of individual functions, click the links.

関数名 Function name	機能・用途 Purpose
convert_endian__int 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	int型変数のエンディアンオーダーを反転させる。 Reverse the endian order of an int-type variable.
convert_endian_unsigned_int 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	unsigned int型変数のエンディアンオーダーを反転させる。 Reverse the endian order of an unsigned int-type variable.
convert_endian__long 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	long型変数のエンディアンオーダーを反転させる。 Reverse the endian order of a long-type variable.
convert_endian_unsigned_long 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	unsigned long型変数のエンディアンオーダーを反転させる。 Reverse the endian order of an unsigned long-type variable.
convert_endian__short 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	short型変数のエンディアンオーダーを反転させる。 Reverse the endian order of a short-type variable.
convert_endian_unsigned_short 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	unsigned short型変数のエンディアンオーダーを反転させる。 Reverse the endian order of an unsigned short-type variable.
convert_endian_float 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	float型変数のエンディアンオーダーを反転させる。 Reverse the endian order of a float-type variable.
convert_endian_double 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	double型変数のエンディアンオーダーを反転させる。 Reverse the endian order of a double-type variable.
binary_array_endian_reverse 【マニュアル改訂中につき非公開】 [Documentation is not open as it is under revision]	unsigned char型配列に読み込んだバイナリデータのエンディアンオーダーを反転させる。 Reverse the endian order of a binary data that was read into an unsigned char-type array.