obidmscolumn_str.c

/****************************************************************************
 * OBIDMS_column_str functions                                              *
 ****************************************************************************/

/**
 * @file obidsmcolumn_str.c
 * @author Celine Mercier
 * @date October 28th 2015
 * @brief Functions handling OBIColumns containing data in the form of indices referring to character strings.
 */


#include <stdlib.h>
#include <stdio.h>

#include "obidmscolumn.h"
#include "obiview.h"
#include "obitypes.h"
#include "obierrno.h"
#include "obidebug.h"
#include "obiblob_indexer.h"


#define DEBUG_LEVEL 0	// TODO has to be defined somewhere else (cython compil flag?)


/**********************************************************************
 *
 * D E F I N I T I O N   O F   T H E   P U B L I C   F U N C T I O N S
 *
 **********************************************************************/

int obi_column_set_obistr_with_elt_idx(OBIDMS_column_p column, index_t line_nb, index_t element_idx, char* value)
{
	Obi_blob_p 	value_b;
	index_t     idx;

	// Check that the line number is not greater than the maximum allowed
	if (line_nb >= MAXIMUM_LINE_COUNT)
	{
		obi_set_errno(OBICOL_UNKNOWN_ERROR);
		obidebug(1, "\nError trying to set a value at a line number greater than the maximum allowed");
    	return -1;
	}

	// Check if the file needs to be enlarged
	while ((line_nb+1) > (column->header)->line_count)
	{
		// Enlarge the file
		if (obi_enlarge_column(column) < 0)
	    	return -1;
	}

	// Update lines used
	if ((line_nb+1) > (column->header)->lines_used)
		(column->header)->lines_used = line_nb+1;

	// Encode the value on a byte array with a header
	value_b = obi_str_to_blob(value);
	if (value_b == NULL)
		return -1;

	// Add in the indexer
	idx = obi_indexer_add(column->indexer, value_b);
	if (idx == -1)
		return -1;

	// Add the value's index in the column
	*(((index_t*) (column->data)) + (line_nb * ((column->header)->nb_elements_per_line)) + element_idx) = idx;

	free(value_b);

	return 0;
}


int obi_column_set_obistr_with_elt_idx_in_view(Obiview_p view, OBIDMS_column_p column, index_t line_nb, index_t element_idx, char* value)
{
	// Check that the view is not read-only
	if (view->read_only)
	{
		obi_set_errno(OBIVIEW_ERROR);
		obidebug(1, "\nError trying to set a value in a column in a read-only view");
		return -1;
	}

	if ((view->line_selection != NULL) || (!(column->writable)))	// TODO why check here writable?
	{
		// Get the right line number
		if (column->writable)
			line_nb = *(((index_t*) ((view->line_selection)->data)) + line_nb);

		column = obi_view_clone_column(view, (column->header)->name);
		if (column == NULL)
		{
			obidebug(1, "\nError trying to clone a column to modify it");
			return -1;
		}
	}

	if ((line_nb+1) > view->line_count)
	{
		if (obi_view_update_lines(view, (line_nb+1)) < 0)
			return -1;
	}

	if (obi_column_set_obistr_with_elt_idx(column, line_nb, element_idx, value) < 0)
		return -1;

	return 0;
}


const char* obi_column_get_obistr_with_elt_idx(OBIDMS_column_p column, index_t line_nb, index_t element_idx)
{
	index_t          idx;
	Obi_blob_p value_b;

	if ((line_nb+1) > ((column->header)->line_count))
	{
		obi_set_errno(OBICOL_UNKNOWN_ERROR);
		obidebug(1, "\nError trying to get a value that is beyond the current number of lines used in the column");
		return OBIStr_NA;
	}

	idx = *(((index_t*) (column->data)) + (line_nb * ((column->header)->nb_elements_per_line)) + element_idx);

	// Check NA
	if (idx == OBIIdx_NA)
		return OBIStr_NA;

	value_b = obi_indexer_get(column->indexer, idx);

	return obi_blob_to_str(value_b);
}


const char* obi_column_get_obistr_with_elt_idx_in_view(Obiview_p view, OBIDMS_column_p column, index_t line_nb, index_t element_idx)
{
	if ((line_nb+1) > (view->line_count))
	{
		obi_set_errno(OBICOL_UNKNOWN_ERROR);
		obidebug(1, "\nError trying to get a value that is beyond the current line count of the view");
		return OBIStr_NA;
	}

	if (view->line_selection)
		line_nb = *(((index_t*) ((view->line_selection)->data)) + line_nb);

	return obi_column_get_obistr_with_elt_idx(column, line_nb, element_idx);
}


int obi_column_set_obistr_with_elt_name(OBIDMS_column_p column, index_t line_nb, const char* element_name, char* value)
{
	index_t element_idx;
	element_idx = obi_column_get_element_index_from_name(column, element_name);
	if (element_idx == OBIIdx_NA)
		return -1;
	obi_column_set_obistr_with_elt_idx(column, line_nb, element_idx, value);
	return 0;
}


int obi_column_set_obistr_with_elt_name_in_view(Obiview_p view, OBIDMS_column_p column, index_t line_nb, const char* element_name, char* value)
{
	index_t element_idx;
	element_idx = obi_column_get_element_index_from_name(column, element_name);
	if (element_idx == OBIIdx_NA)
		return -1;
	obi_column_set_obistr_with_elt_idx_in_view(view, column, line_nb, element_idx, value);
	return 0;
}


const char* obi_column_get_obistr_with_elt_name(OBIDMS_column_p column, index_t line_nb, const char* element_name)
{
	index_t element_idx;

	element_idx = obi_column_get_element_index_from_name(column, element_name);
	if (element_idx == OBIIdx_NA)
		return OBIStr_NA;
	return obi_column_get_obistr_with_elt_idx(column, line_nb, element_idx);
}


const char* obi_column_get_obistr_with_elt_name_in_view(Obiview_p view, OBIDMS_column_p column, index_t line_nb, const char* element_name)
{
	index_t element_idx;

	element_idx = obi_column_get_element_index_from_name(column, element_name);
	if (element_idx == OBIIdx_NA)
		return OBIStr_NA;
	return obi_column_get_obistr_with_elt_idx_in_view(view, column, line_nb, element_idx);
}