/*
 * Copyright (c) 1994 MEDICAL RESEARCH COUNCIL
 * All rights reserved
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 *    1 Redistributions of source code must retain the above copyright notice, 
 *      this list of conditions and the following disclaimer.
 * 
 *    2 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.
 * 
 *    3 Neither the name of the MEDICAL RESEARCH COUNCIL, THE LABORATORY OF
 *      MOLECULAR BIOLOGY 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 OWNER 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) Medical Research Council 1994. All rights reserved.
 *
 * Permission to use, copy, modify and distribute this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * this copyright and notice appears in all copies.
 *
 * This file was written by James Bonfield, Simon Dear, Rodger Staden,
 * as part of the Staden Package at the MRC Laboratory of Molecular
 * Biology, Hills Road, Cambridge, CB2 2QH, United Kingdom.
 *
 * MRC disclaims all warranties with regard to this software.
 */

/*
 * File: array.c
 * Version:
 *
 * Description:
 *
 * Created:
 * Updated:
 *
 */

#ifdef HAVE_CONFIG_H
#include "io_lib_config.h"
#endif

#include <stdio.h>
#include <sys/types.h>

#include "io_lib/array.h"
#include "io_lib/xalloc.h"


/*
 * For error reporting
 */
int ArrayError = 0;


char *ArrayErrorString(int err)
{
    switch(err) {
    case ARRAY_NO_ERROR:          return "No error";
    case ARRAY_FULL:     	  return "Array full";
    case ARRAY_INVALID_ARGUMENTS: return "Invalid arguments";
    case ARRAY_OUT_OF_MEMORY:     return "Out of memory";
    default:			  return "Unknown error";
    }
}



Array ArrayCreate(size_t size, size_t dim)
/*
 * create a new array
 */
{
    Array a;
    
    if ( (a = (Array) xmalloc(sizeof(ArrayStruct)) ) == NULL ) {
	ArrayError = ARRAY_OUT_OF_MEMORY;
    } else {
	a->size = size;
	a->dim = dim?dim:1;
	a->max = 0;
	if ( (a->base = (void *)xmalloc(a->size * a->dim)) == NULL ) {
	    ArrayError = ARRAY_OUT_OF_MEMORY;
	    xfree(a);
	    a = NULL;
	}
    }
    
    return a;
    
}



int ArrayExtend(Array a, size_t dim)
/*
 * extend array
 */
{
    void *newbase;
    size_t old_dim;

    if (a == NULL) return ArrayError = ARRAY_INVALID_ARGUMENTS;
    if (dim < a->dim) return ArrayError = ARRAY_NO_ERROR;

    old_dim = a->dim;
    while (dim >= a->dim) {
	a->dim = a->dim * 1.2 + 1;
    }

    if ( (newbase = (void *)xrealloc(a->base, a->size * a->dim)) == NULL ) {
	a->dim = old_dim;
	return ArrayError = ARRAY_OUT_OF_MEMORY;
    } else {
	a->base = newbase;
    }

    return ArrayError = ARRAY_NO_ERROR;
}




void *ArrayRef(Array a, size_t i)
{
    if (a==NULL) {
	ArrayError = ARRAY_INVALID_ARGUMENTS;
	return NULL;
    }

    if (i >= a->max) {
	if (i >= a->dim) {
	    if (ArrayExtend(a,i+1)) {
		/* ArrayExtend sets ArrayError */
		return NULL;
	    }
	}
	a->max = i+1;
    }

    return (void *) arrp(char,a,i*a->size);
}



int ArrayDestroy(Array a)
/*
 * destroy array
 */
{
    if (a==NULL) return ArrayError = ARRAY_INVALID_ARGUMENTS;
    
    if (a->base != NULL) xfree(a->base);
    a->base= NULL;
    xfree(a);

    return ArrayError = ARRAY_NO_ERROR;
    
    
}