column.c

/*
 * column.c
 *
 *  Created on: Jan 9, 2017
 *      Author: fafa
 *
 *  This source file contains all that is related to column management :
 *  	- print_row to print a whole row with a given delimiter
 *		- index_row to add a row in an index corresponding to the given value
 *		- make_columns/make_column to build the GTF column model
 */

#include "libgtftk.h"

/*
 * external functions declaration
 */
extern int compare_row_list(const void *p1, const void *p2);

/*
 * global variables declaration
 */
extern int nb_column;
extern COLUMN **column;

/*
 * prints a column value (a feature, a start ...) with delimiter.
 * Default values are printed as "."
 *
 * Parameters:
 * 		token:	the character string value to print
 * 		output:	where to print (a file or stdout)
 * 		col:	the corresponding column
 * 		delim:	the delimiter character
 */
void print_string(char *token, FILE *output, COLUMN *col, char delim) {
	if (col->default_value != NULL)
		if (!strcmp(token, col->default_value))
			delim != 0 ? fprintf(output, ".%c", delim) : fprintf(output, ".");
		else
			delim != 0 ? fprintf(output, "%s%c", token, delim) : fprintf(output, "%s", token);
	else
		delim != 0 ? fprintf(output, "%s%c", token, delim) : fprintf(output, "%s", token);
}

/*
 * prints an attribute list from a GTF row.
 *
 * Parameters:
 * 		row:	the GTF row from which to print attributes
 * 		output:	where to print (a file or stdout)
 */
void print_attributes(GTF_ROW *row, FILE *output) {
	int k;
	if (row->attributes.nb != -1) {
		fprintf(output, "%s \"%s\";", row->attributes.attr[0]->key, row->attributes.attr[0]->value);
		for (k = 1; k < row->attributes.nb; k++)
			fprintf(output, " %s \"%s\";", row->attributes.attr[k]->key, row->attributes.attr[k]->value);
	}
}

/*
 * prints a whole GTF row in output with the given character delimiter
 *
 * Parameters:
 * 		output:		where to print
 * 		r:			the row to print
 * 		delim:		the delimiter character
 * 		add_chr:	boolean; if true(1), add "chr" at the begining of the row
 */
void print_row(FILE *output, GTF_ROW *r, char delim, int add_chr) {
	int i;

	if (add_chr) fprintf(output, "chr");
	for (i = 0; i < 8; i++) print_string(r->field[i], output, column[i], delim);
	print_attributes(r, output);
	fprintf(output, "\n");
}

/*
 * Creates an empty index and add/link it in the index list of the column
 * in index_id.
 *
 * Parameters:
 * 		index_id:	contains the column to index
 * 		key:		the column name or attribute name to index
 */
void make_index(INDEX_ID *index_id, char *key) {
	column[index_id->column]->nb_index++;
	column[index_id->column]->index = (INDEX **)realloc(column[index_id->column]->index, column[index_id->column]->nb_index * sizeof(INDEX *));
	INDEX *index = (INDEX *)calloc(1, sizeof(INDEX));
	column[index_id->column]->index[column[index_id->column]->nb_index - 1] = index;
	index->data = NULL;
	index->gtf_data = NULL;
	index->key = strdup(key);
	index_id->index_rank = column[index_id->column]->nb_index - 1;
	if (column[index_id->column]->nb_index > 1)
		column[index_id->column]->index[column[index_id->column]->nb_index - 2]->next = index;
}

/*
 * This function indexes a row.
 *
 * Parameters:
 * 		row_nb:		the row number to add
 * 		value:		the value with which to row is associated
 * 		index:		the index of ROW_LIST elements
 */
void index_row(int row_nb, char *value, INDEX *index) {
	ROW_LIST *test_row_list, *row_list, *find_row_list;

	if (index != NULL) {
		/*
		 * build a ROW_LIST to check if value is already indexed
		 */
		test_row_list = calloc(1, sizeof(ROW_LIST));

		test_row_list->token = value;
		find_row_list = tfind(test_row_list, &(index->data), compare_row_list);
		if (find_row_list == NULL) {
			/*
			 * value is not in the index so we reserve a ROW_LIST, initialize it
			 * with one row (row_nb) and put it in the index (tsearch)
			 */

			row_list = (ROW_LIST *)calloc(1, sizeof(ROW_LIST));
			row_list->token = value;
			row_list->nb_row = 1;
			row_list->row = (int *)calloc(1, sizeof(int));
			row_list->row[0] = row_nb;
			tsearch(row_list, &(index->data), compare_row_list);
		}
		else {
			/*
			 * value is already in the index so we just have to add row_nb into
			 * the ROW_LIST element found
			 */
			row_list = *((ROW_LIST **)find_row_list);
			row_list->nb_row++;
			row_list->row = (int *)realloc(row_list->row, row_list->nb_row * sizeof(int));
			row_list->row[row_list->nb_row - 1] = row_nb;
		}
		free(test_row_list);
	}
}

/*
 * Reserve memory for a COLUMN structure and fill it whith parameters.
 * This function doesn't create any index in columns.
 *
 * Parameters:
 * 		i:		the number of the column (0 to 8)
 * 		dv:		the default value
 * 		name:	the column name
 *
 * Returns:		the initialized COLUMN structure
 */
COLUMN *make_column(int i, void *dv, char *name) {
	COLUMN *column = (COLUMN *)calloc(1, sizeof(COLUMN));
	column->num = i;
	column->name = strdup(name);
	column->index = NULL;
	column->nb_index = 0;
	if (dv != NULL) column->default_value = strdup((char *)dv);

	return column;
}

/*
 * Creates and initialize a column model suitable for GTF data.
 */
void make_columns(void) {
	nb_column = 9;
	if (column == NULL) {
		column = (COLUMN **)calloc(nb_column, sizeof(COLUMN *));
		column[0] = make_column(0, ".", "seqid");
		column[1] = make_column(1, ".", "source");
		column[2] = make_column(2, ".", "feature");
		column[3] = make_column(3, ".", "start");
		column[4] = make_column(4, ".", "end");
		column[5] = make_column(5, ".", "score");
		column[6] = make_column(6, ".", "strand");
		column[7] = make_column(7, ".", "phase");
		column[8] = make_column(8, ".", "attributes");
	}
}