/*
Copyright (c) 2011, Cryst.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.
* Neither the name of the Cryst nor the names of its contributors may be used to endorse or
promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*
Copyright (c) 2011, Cryst.
All rights reserved.
ソースコード形式かバイナリ形式か、変更するかしないかを問わず、以下の条件を満たす場合に
限り、再頒布および使用を許可します。
* ソースコードを再頒布する場合、上記の著作権表示、本条件一覧、および 下記免責条項を
含めること。
* バイナリ形式で再頒布する場合、頒布物に付属のドキュメント等の資料に、上記の著作権
表示、本条件一覧、および下記免責条項を含めること。
* 書面による特別の許可なしに、本ソフトウェアから派生した製品の宣伝または販売促進に、
Cryst の名前またはコントリビューターの名前を使用してはならない。
本ソフトウェアは、著作権者およびコントリビューターによって「現状のまま」提供されており、
明示黙示を問わず、商業的な使用可能性、および特定の目的に対する適合性に関する暗黙の保証
も含め、またそれに限定されない、いかなる保証もありません。著作権者もコントリビューター
も、事由のいかんを問わず、損害発生の原因いかんを問わず、かつ責任の根拠が契約であるか
厳格責任であるか（過失その他の）不法行為であるかを問わず、仮にそのような損害が発生する
可能性を知らされていたとしても、本ソフトウェアの使用によって発生した（代替品または代用
サービスの調達、使用の喪失、データの喪失、利益の喪失、業務の中断も含め、またそれに限定
されない）直接損害、間接損害、偶発的な損害、特別損害、懲罰的損害、または結果損害につい
て、一切責任を負わないものとします。
*/
#ifndef _ALLOCARRAY_H_
#define _ALLOCARRAY_H_
#include <stdlib.h>
void **alloc2D( void *data, int sizeOfUnit, int lx, int ly )
/** 連続したピクセルデータ（１次元）を、lx,ly の２次元配列としてアクセス出来るように初期化
void *data: 2Dデータとしてアクセスしたい連続したピクセルデータ（１次元）の格納場所。
原点からX軸方向のデータが LX個連続して格納されている。更にこの並び方で、
LY個のデータが配置され、1画面(2D)分のデータが格納されている。
int sizeOfUnit: １ピクセルを構成するデータのバイト数
int lx: X軸方向のピクセル数
int ly: Y軸方向のピクセル数
returned value: 成功時 配列へのポインタ、失敗時 NULL
使用上の注意：この関数が返すポインターは、不要になったら free() 関数で開放してください。
malloc()や、calloc() 関数の利用（メモリーリークの可能性も同じ）と同じです。
alloca() 関数と同等の使い方は出来ませんので注意してください。
利用例 extern DATA_TYPE *raw_data ;
extern int lx, ly ;
DATA_TYPE v, **p = alloc2D(raw_data, sizeof(DATA_TYPE), lx, ly) ;
:
v = p[y][x] ; // v = *(raw_data + lx*y + x ) ;
:
free(p) ;
*/
{
register void **d, *base=data ;
register int i, s=sizeOfUnit, llx=lx, lly=ly ;
if( (data==NULL) || (sizeOfUnit<1) || (lx<1) || (ly<1) ) return NULL ;
if( (d=(void **)malloc(ly*sizeof(void *))) == NULL ) return NULL ;
for( i=0; i<lly; i++ ) d[i] = (void *)((unsigned char *)base + llx*s*i) ;
return d ;
}
void ***alloc3D( void *data, int sizeOfUnit, int lx, int ly, int lz )
/** 連続したボクセルデータ（１次元）を、lx,ly,lz の３次元配列としてアクセス出来るように初期化
void *data: 3Dデータとしてアクセスしたい連続ボクセルデータ（１次元）の格納場所。
原点からX軸方向のデータが LX個連続して格納されている。更にこの並び方で、
LY個のデータが配置され、1画面(2D)分のデータが格納されている。
この塊が、LZ個並んで全ボクセルデータが記録されている。
int sizeOfUnit: １ボクセルを構成するデータのバイト数
int lx: X軸方向のボクセル数
int ly: Y軸方向のボクセル数
int lz: Z軸方向のボクセル数
returned value: 成功時 配列へのポインタ、失敗時 NULL
使用上の注意：この関数が返すポインターは、不要になったら free() 関数で開放してください。
malloc()や、calloc() 関数の利用（メモリーリークの可能性も同じ）と同じです。
alloca() 関数と同等の使い方は出来ませんので注意してください。
利用例 extern DATA_TYPE *raw_data ;
extern int lx, ly, lz ;
DATA_TYPE v, ***p = alloc3D(raw_data, sizeof(DATA_TYPE), lx, ly, lz) ;
:
v = p[z][y][x] ; // v = *(raw_data + lx*ly*z + lx*y + x ) ;
:
free(p) ;
*/
{
register long long s=sizeOfUnit;
register void ***d ; // 作業用の一時変数
// if ( sizeOfUnit<1 || lx<1 || ly<1 || lz<1 ) return NULL ; // 引数チェック
if( (data==NULL) || (sizeOfUnit<1) || (lx<1) || (ly<1) || (lz<1) ) return NULL ;
if ((d=(void ***)malloc((lz*ly+lz)*sizeof(void *))) == NULL) {// インデックス領域
return NULL ; // インデックス領域の確保に失敗
} else { // 確保したメモリー上に、配列アクセス用のインデックスを初期化
register int i, llx=lx, lly=ly, llz=lz, lyz=lly*llz ;
register void **area=(void **)&d[llz], *base=data ;
for( i=0; i<llz; i++ ) d[i] = &area[lly*i] ;
for( i=0; i<lyz; i++ ) area[i] = (void **)((unsigned char *)base + llx*s*i) ;
}
return d ;
}
////////////////////////////////////////////////////////////////////////////////
#define calloc2Darray alloc2Darray
#define calloc3Darray alloc3Darray
void **alloc2Darray( int sizeOfUnit, int lx, int ly )
/** 連続したピクセルデータ領域を確保し、lx, ly の２次元配列としてアクセス出来るように初期化
データ領域は、０で初期化される
int sizeOfUnit: １ピクセルを構成するデータのバイト数
int lx: X軸方向のピクセル数
int ly: Y軸方向のピクセル数
returned value: 成功時 配列へのポインタ、失敗時 NULL
使用上の注意：この関数が返すポインターは、不要になったら free() 関数で開放してください。
malloc()や、calloc() 関数の利用（メモリーリークの可能性も同じ）と同じです。
alloca() 関数と同等の使い方は出来ませんので注意してください。
利用例 DATA_TYPE v, **p = alloc2Darray(sizeof(DATA_TYPE), lx, ly) ;
:
v = p[y][x] ; // x:(0 ～ lx-1), y:(0 ～ ly-1)
:
free(p) ;
*/
{
register void **d, *base ;
register int i, s=sizeOfUnit, llx=lx, lly=ly ;
if( (sizeOfUnit<1) || (lx<1) || (ly<1) ) return NULL ;
if( (d=(void **)calloc(1,ly*sizeof(void *)+(lx*ly*sizeOfUnit))) == NULL ) return NULL ;
base = (unsigned char *)d + ly*sizeof(void *) ;
for( i=0; i<lly; i++ ) d[i] = (void *)((unsigned char *)base + llx*s*i) ;
return d ;
}
void ***alloc3Darray( int sizeOfUnit, int lx, int ly, int lz )
/** 連続したボクセルデータ領域を確保し、lx,ly,lz の３次元配列としてアクセス出来るように初期化
データ領域は、０で初期化される
int sizeOfUnit: １ボクセルを構成するデータのバイト数
int lx: X軸方向のボクセル数
int ly: Y軸方向のボクセル数
int lz: Z軸方向のボクセル数
returned value: 成功時 配列へのポインタ、失敗時 NULL
使用上の注意：この関数が返すポインターは、不要になったら free() 関数で開放してください。
malloc()や、calloc() 関数の利用（メモリーリークの可能性も同じ）と同じです。
alloca() 関数と同等の使い方は出来ませんので注意してください。
利用例 DATA_TYPE v, ***p = alloc3Darray(sizeof(DATA_TYPE), lx, ly, lz) ;
:
v = p[z][y][x] ; // x:(0 ～ lx-1), y:(0 ～ ly-1), z:(0 ～ lz-1)
:
free(p) ;
*/
{
register long long s=sizeOfUnit;
register void ***d ;
if( (sizeOfUnit<1) || (lx<1) || (ly<1) || (lz<1) ) return NULL ;
if ((d=(void ***)calloc(1,(lz*ly+lz)*sizeof(void *)+(lx*ly*lz*s))) == NULL) {
return NULL ; // データ+インデックス領域の確保に失敗
} else { // 確保したメモリー上に、配列アクセス用のインデックスを初期化
register int i, llx=lx, lly=ly, llz=lz, lyz=lly*llz ;
register void **area=(void **)&d[llz], *base=(char *)d+(lz*ly+lz)*sizeof(void *) ;
for( i=0; i<llz; i++ ) d[i] = &area[lly*i] ;
for( i=0; i<lyz; i++ ) area[i] = (void **)((unsigned char *)base + llx*s*i) ;
}
return d ;
}
void **malloc2Darray( int sizeOfUnit, int lx, int ly )
/** 連続したピクセルデータ領域を確保し、lx, ly の２次元配列としてアクセス出来るように初期化
データ領域は、初期化されないので注意すること事
int sizeOfUnit: １ピクセルを構成するデータのバイト数
int lx: X軸方向のピクセル数
int ly: Y軸方向のピクセル数
returned value: 成功時 配列へのポインタ、失敗時 NULL
使用上の注意：この関数が返すポインターは、不要になったら free() 関数で開放してください。
malloc()や、calloc() 関数の利用（メモリーリークの可能性も同じ）と同じです。
alloca() 関数と同等の使い方は出来ませんので注意してください。
利用例 DATA_TYPE v, **p = malloc2Darray(sizeof(DATA_TYPE), lx, ly) ;
:
v = p[y][x] ; // x:(0 ～ lx-1), y:(0 ～ ly-1)
:
free(p) ;
*/
{
register void **d, *base ;
register int i, s=sizeOfUnit, llx=lx, lly=ly ;
if( (sizeOfUnit<1) || (lx<1) || (ly<1) ) return NULL ;
// データ+インデックス領域の確保に失敗時は、NULL を返す
if( (d=(void **)malloc(ly*sizeof(void *)+(lx*ly*sizeOfUnit))) == NULL ) return NULL ;
base = (unsigned char *)d + ly*sizeof(void *) ;
for( i=0; i<lly; i++ ) d[i] = (void *)((unsigned char *)base + llx*s*i) ;
return d ;
}
void ***malloc3Darray( int sizeOfUnit, int lx, int ly, int lz )
/** 連続したボクセルデータ領域を確保し、lx,ly,lz の３次元配列としてアクセス出来るように初期化
データ領域は、初期化されないので注意すること事
int sizeOfUnit: １ボクセルを構成するデータのバイト数
int lx: X軸方向のボクセル数
int ly: Y軸方向のボクセル数
int lz: Z軸方向のボクセル数
returned value: 成功時 配列へのポインタ、失敗時 NULL
使用上の注意：この関数が返すポインターは、不要になったら free() 関数で開放してください。
malloc()や、calloc() 関数の利用（メモリーリークの可能性も同じ）と同じです。
alloca() 関数と同等の使い方は出来ませんので注意してください。
利用例 DATA_TYPE v, ***p = malloc3Darray(sizeof(DATA_TYPE), lx, ly, lz) ;
:
v = p[z][y][x] ; // x:(0 ～ lx-1), y:(0 ～ ly-1), z:(0 ～ lz-1)
:
free(p) ;
*/
{
register long long s=sizeOfUnit;
register void ***d ;
if( (sizeOfUnit<1) || (lx<1) || (ly<1) || (lz<1) ) return NULL ;
// データ+インデックス領域の確保に失敗時は、NULL を返す
if ((d=(void ***)malloc((lz*ly+lz)*sizeof(void *)+(lx*ly*lz*s))) == NULL) return NULL ;
else { // 確保したメモリー上に、配列アクセス用のインデックスを初期化
register int i, llx=lx, lly=ly, llz=lz, lyz=lly*llz ;
register void **area=(void **)&d[llz], *base=(char *)d+(lz*ly+lz)*sizeof(void *) ;
for( i=0; i<llz; i++ ) d[i] = &area[lly*i] ;
for( i=0; i<lyz; i++ ) area[i] = (void **)((unsigned char *)base + llx*s*i) ;
}
return d ;
}
/** Ｃ言語による動的配列確保（２次元配列及び３次元配列）と要素が構造体の場合の記述方法
ピクセルデータや、ボクセルデータがPIXEL形の構造体で構成されている場合の利用例
typedef struct PIXEL {
unsigned char B, G, R, A;
} PIXEL ;
１、２次元配列
unsigned char r, g, b ;
PIXEL v, **p = alloc2Darray(sizeof(PIXEL), lx, ly) ; // My coding policy （重要な変数は宣言された時点で初期化）
v = p[y][x] ; // 構造体を一括でコピーする場合
r = p[y][x].R ; // 構造体の要素を個別にコピーする場合
g = p[y][x].G ; // 構造体の要素を個別にコピーする場合
b = p[y][x].B ; // 構造体の要素を個別にコピーする場合
free(p) ; // 動的に確保した領域が不要になったら、free() 関数で開放する。
２、３次元配列の場合
unsigned char r, g, b ;
PIXEL v, ***p = alloc3Darray(sizeof(PIXEL), lx, ly, lz) ; // My coding policy （重要な変数は宣言された時点で初期化）
v = p[z][y][x] ; // 構造体を一括でコピーする場合
r = p[z][y][x].R ; // 構造体の要素を個別にコピーする場合
g = p[z][y][x].G ; // 構造体の要素を個別にコピーする場合
b = p[z][y][x].B ; // 構造体の要素を個別にコピーする場合
free(p) ; // 動的に確保した領域が不要になったら、free() 関数で開放する。
３、for good measure
配列（今回の動的に確保された配列も含む）は、単にメモリー上に確保された一律の大きさの領域なので、
大きさが同じであれば、他の型として流用しても問題は生じない。
これは、sizeof(PIXEL)と、sizeof(int)が共に４(バイト)である環境では、PIXEL として確保した配列を
整数(int)の配列と見做して流用する事が可能である事を意味する。
つまり、以下の様に記述し、配列として使用する方法が可能である。
PIXEL v, **p = alloc2Darray(sizeof(PIXEL), lx, ly) ;
int t, **m = NULL;
**m = (int **)p ;
v = p[y][x] ;
t = m[y][x] ;
この処理で注意しなければならないのは、最後に"メモリを開放するのは１度だけ"である。
free(p)、free(m) と同じアドレスを２度開放する事は出来ない（致命的なバグ）。開放の記述はどちらでも
良いが、確保した領域を開放する事が正しい処理なので、free(p) とする事を推奨する。
**/
#endif /* _ALLOCARRAY_H_ */